VAPI-3164 Add <Refer> BXML verb support

.openapi-generator/FILES

@@ -168,6 +168,7 @@ docs/RecordingTranscriptions.md
 docs/RecordingsApi.md
 docs/RedirectCallback.md
 docs/RedirectMethodEnum.md
+docs/ReferCompleteCallback.md
 docs/SipConnectionMetadata.md
 docs/SipCredentials.md
 docs/SmsMessageContent.md
@@ -411,6 +412,7 @@ src/main/java/com/bandwidth/sdk/model/RecordingTranscriptionMetadata.java
 src/main/java/com/bandwidth/sdk/model/RecordingTranscriptions.java
 src/main/java/com/bandwidth/sdk/model/RedirectCallback.java
 src/main/java/com/bandwidth/sdk/model/RedirectMethodEnum.java
+src/main/java/com/bandwidth/sdk/model/ReferCompleteCallback.java
 src/main/java/com/bandwidth/sdk/model/SipConnectionMetadata.java
 src/main/java/com/bandwidth/sdk/model/SipCredentials.java
 src/main/java/com/bandwidth/sdk/model/SmsMessageContent.java

README.md

@@ -344,6 +344,7 @@ Class | Method | HTTP request | Description
  - [RecordingTranscriptions](docs/RecordingTranscriptions.md)
  - [RedirectCallback](docs/RedirectCallback.md)
  - [RedirectMethodEnum](docs/RedirectMethodEnum.md)
+ - [ReferCompleteCallback](docs/ReferCompleteCallback.md)
  - [SipConnectionMetadata](docs/SipConnectionMetadata.md)
  - [SipCredentials](docs/SipCredentials.md)
  - [SmsMessageContent](docs/SmsMessageContent.md)

bandwidth.yml

@@ -5139,11 +5139,9 @@ components:
     transferCompleteCallback:
       type: object
       description: >-
-        This event is sent to the transferCompleteUrl of the A-leg's <Transfer>
-        verb when the transferred call (B-leg) completes. In a simultaneous
-        ringing scenario, only one B-leg succeeds and this event corresponds to
-        that successful leg. If none of the calls were answered, the
-        transferComplete event corresponds to one of the legs.
+        The Refer Complete event is fired when the <Refer> verb finishes
+        executing. This is sent to the referCompleteUrl specified on the
+        <Refer> verb, and the BXML returned in it is executed on the call.
       properties:
         eventType:
           $ref: '#/components/schemas/eventType'
@@ -5181,6 +5179,68 @@ components:
           $ref: '#/components/schemas/errorMessage'
         errorId:
           $ref: '#/components/schemas/errorId'
+    referCompleteCallback:
+      type: object
+      description: >-
+        The Refer Complete event is sent to the referCompleteUrl of the <Refer>
+        verb when the SIP REFER operation completes. Note the success-semantics
+        asymmetry: unlike Transfer where success means the call continues, a
+        successful Refer means the remote endpoint has been redirected away and
+        the call is terminated. The BXML returned by this callback is executed
+        on the call only for failure recovery.
+      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'
+        referCallStatus:
+          type: string
+          description: >-
+            The outcome of the SIP REFER attempt. Possible values include
+            'success' and 'failure'. On success the call is terminated; on
+            failure the BXML returned by this callback is executed for recovery.
+          example: failure
+        referSipResponseCode:
+          type: integer
+          description: >-
+            The SIP response code received from the remote endpoint in response
+            to the REFER request itself (e.g., 202 Accepted, 603 Declined).
+          example: 202
+        notifySipResponseCode:
+          type: integer
+          description: >-
+            The SIP response code received in the NOTIFY message that reports
+            the final status of the referred call (e.g., 200 OK if the refer
+            target answered, 486 Busy Here if it did not).
+          example: 200
+        cause:
+          $ref: '#/components/schemas/cause'
+        errorMessage:
+          $ref: '#/components/schemas/errorMessage'
+        errorId:
+          $ref: '#/components/schemas/errorId'
     transferDisconnectCallback:
       type: object
       description: >-
@@ -5239,8 +5299,8 @@ components:
         conferenceRedirect, conferenceMemberJoin, conferenceMemberExit,
         conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf,
         gather, initiate, machineDetectionComplete, recordingComplete,
-        recordingAvailable, redirect, transcriptionAvailable, transferAnswer,
-        transferComplete, transferDisconnect.
+        recordingAvailable, redirect, referComplete, transcriptionAvailable,
+        transferAnswer, transferComplete, transferDisconnect.
       example: bridgeComplete
     eventTime:
       type: string

docs/AnswerCallback.md

@@ -8,7 +8,7 @@ The Answer event is sent to the answerUrl specified in the createCall request wh
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**accountId** | **String** | The user account associated with the call. |  [optional] |
 |**applicationId** | **String** | The id of the application associated with the call. |  [optional] |

docs/BridgeCompleteCallback.md

@@ -8,7 +8,7 @@ If the target call leaves the <Bridge>, then this callback is sent to the bridge
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**accountId** | **String** | The user account associated with the call. |  [optional] |
 |**applicationId** | **String** | The id of the application associated with the call. |  [optional] |

docs/BridgeTargetCompleteCallback.md

@@ -8,7 +8,7 @@ If the originating call leaves the <Bridge>, then this callback is sent to the b
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**accountId** | **String** | The user account associated with the call. |  [optional] |
 |**applicationId** | **String** | The id of the application associated with the call. |  [optional] |

docs/ConferenceCompletedCallback.md

@@ -8,7 +8,7 @@ The Conference Completed event is fired when the last member leaves the conferen
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded |  [optional] |
 |**name** | **String** | The user-specified name of the conference that was recorded |  [optional] |

docs/ConferenceCreatedCallback.md

@@ -8,7 +8,7 @@ The Conference Created event is fired whenever a new conference that specified a
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded |  [optional] |
 |**name** | **String** | The user-specified name of the conference that was recorded |  [optional] |

docs/ConferenceMemberExitCallback.md

@@ -8,7 +8,7 @@ The Conference Member Exit event is fired whenever a caller exits a conference t
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded |  [optional] |
 |**name** | **String** | The user-specified name of the conference that was recorded |  [optional] |

docs/ConferenceMemberJoinCallback.md

@@ -8,7 +8,7 @@ The Conference Member Join event is fired whenever a caller joins a conference t
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded |  [optional] |
 |**name** | **String** | The user-specified name of the conference that was recorded |  [optional] |

docs/ConferenceRecordingAvailableCallback.md

@@ -8,7 +8,7 @@ The Conference Recording Available event is sent after a conference recording ha
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded |  [optional] |
 |**name** | **String** | The user-specified name of the conference that was recorded |  [optional] |

docs/ConferenceRedirectCallback.md

@@ -8,7 +8,7 @@ The Conference Redirect event is fired whenever an existing conference is modifi
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
+|**eventType** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. |  [optional] |
 |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. |  [optional] |
 |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded |  [optional] |
 |**name** | **String** | The user-specified name of the conference that was recorded |  [optional] |