VAPI-3162-REFER

Author: atelegu

.openapi-generator/FILES

@@ -388,6 +388,8 @@ lib/bandwidth-sdk/models/recording_transcription_metadata.rb
 lib/bandwidth-sdk/models/recording_transcriptions.rb
 lib/bandwidth-sdk/models/redirect_callback.rb
 lib/bandwidth-sdk/models/redirect_method_enum.rb
+lib/bandwidth-sdk/models/refer_call_status_enum.rb
+lib/bandwidth-sdk/models/refer_complete_callback.rb
 lib/bandwidth-sdk/models/sip_connection_metadata.rb
 lib/bandwidth-sdk/models/sip_credentials.rb
 lib/bandwidth-sdk/models/sms_message_content.rb

bandwidth.yml

@@ -3209,6 +3209,13 @@ components:
         Setting the conference state to `completed` ends the conference and
         ejects all members.
       example: completed
+    referCallStatusEnum:
+      type: string
+      enum:
+        - success
+        - failure
+      description: The status of the SIP REFER request.
+      example: success
     machineDetectionModeEnum:
       type: string
       default: async
@@ -5047,6 +5054,62 @@ components:
           $ref: '#/components/schemas/transferCallerId'
         transferTo:
           $ref: '#/components/schemas/transferTo'
+    referCompleteCallback:
+      type: object
+      description: >-
+        This event is sent to the referCompleteUrl of the <Refer> verb when the
+        SIP REFER request has been resolved — either the remote endpoint has
+        accepted and redirected the call (success) or the REFER was rejected or
+        timed out (failure). On success the original call is terminated.
+      properties:
+        eventType:
+          $ref: '#/components/schemas/eventType'
+        eventTime:
+          $ref: '#/components/schemas/eventTime'
+        accountId:
+          $ref: '#/components/schemas/accountId'
+        applicationId:
+          $ref: '#/components/schemas/applicationId1'
+        from:
+          $ref: '#/components/schemas/from'
+        to:
+          $ref: '#/components/schemas/to'
+        direction:
+          $ref: '#/components/schemas/callDirectionEnum'
+        callId:
+          $ref: '#/components/schemas/callId'
+        callUrl:
+          $ref: '#/components/schemas/callUrl'
+        enqueuedTime:
+          $ref: '#/components/schemas/enqueuedTime'
+        startTime:
+          $ref: '#/components/schemas/startTime'
+        answerTime:
+          $ref: '#/components/schemas/answerTime'
+        tag:
+          $ref: '#/components/schemas/tag1'
+        referTo:
+          type: string
+          description: The SIP URI that the call was referred to.
+          example: sip:alice@atlanta.example.com
+        referCallStatus:
+          $ref: '#/components/schemas/referCallStatusEnum'
+        referSipResponseCode:
+          type: integer
+          description: >-
+            The SIP response code received in response to the REFER request.
+            Present when the status of the REFER is known (e.g. 202 Accepted or
+            405 Method Not Allowed). Absent when the REFER was not attempted.
+          example: 202
+          nullable: true
+        notifySipResponseCode:
+          type: integer
+          description: >-
+            The SIP response code received in a NOTIFY from the remote endpoint
+            after it attempted to reach the transfer target. Present only if a
+            NOTIFY was received before the 30-second timeout.
+          example: 200
+          nullable: true
     transcriptionAvailableCallback:
       type: object
       description: >-

lib/bandwidth-sdk.rb

@@ -174,6 +174,8 @@
 require 'bandwidth-sdk/models/recording_transcriptions'
 require 'bandwidth-sdk/models/redirect_callback'
 require 'bandwidth-sdk/models/redirect_method_enum'
+require 'bandwidth-sdk/models/refer_call_status_enum'
+require 'bandwidth-sdk/models/refer_complete_callback'
 require 'bandwidth-sdk/models/sip_connection_metadata'
 require 'bandwidth-sdk/models/sip_credentials'
 require 'bandwidth-sdk/models/sms_message_content'

lib/bandwidth-sdk/models/refer_call_status_enum.rb

@@ -0,0 +1,37 @@
+=begin
+#Bandwidth
+#Bandwidth's Communication APIs
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class ReferCallStatusEnum
+    SUCCESS = "success".freeze
+    FAILURE = "failure".freeze
+
+    def self.all_vars
+      @all_vars ||= [SUCCESS, FAILURE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ReferCallStatusEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ReferCallStatusEnum"
+    end
+  end
+end