SWI-12184 Update SDK Based on Recent Spec Changes

.openapi-generator/FILES

@@ -177,6 +177,8 @@ bandwidth/models/recording_transcription_metadata.py
 bandwidth/models/recording_transcriptions.py
 bandwidth/models/redirect_callback.py
 bandwidth/models/redirect_method_enum.py
+bandwidth/models/refer_call_status_enum.py
+bandwidth/models/refer_complete_callback.py
 bandwidth/models/sip_connection_metadata.py
 bandwidth/models/sip_credentials.py
 bandwidth/models/sms_message_content.py
@@ -387,6 +389,8 @@ docs/RecordingTranscriptions.md
 docs/RecordingsApi.md
 docs/RedirectCallback.md
 docs/RedirectMethodEnum.md
+docs/ReferCallStatusEnum.md
+docs/ReferCompleteCallback.md
 docs/SipConnectionMetadata.md
 docs/SipCredentials.md
 docs/SmsMessageContent.md

README.md

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

bandwidth.yml

@@ -3184,6 +3184,13 @@ components:
         - outbound
       description: The direction of the call.
       example: inbound
+    referCallStatusEnum:
+      type: string
+      enum:
+        - success
+        - failure
+      description: The outcome of the REFER operation.
+      example: success
     fileFormatEnum:
       type: string
       enum:
@@ -5134,6 +5141,45 @@ components:
           $ref: '#/components/schemas/transferCallerId'
         transferTo:
           $ref: '#/components/schemas/transferTo'
+    referCompleteCallback:
+      type: object
+      description: >-
+        This event is sent to the referCompleteUrl of a call's <Refer> verb when
+        the SIP REFER flow completes. On success, the call has been torn down
+        and the BXML returned from this callback is ignored. On failure, the
+        call remains active and the BXML returned from this callback is executed
+        on the call.
+      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'
+        startTime:
+          $ref: '#/components/schemas/startTime'
+        answerTime:
+          $ref: '#/components/schemas/answerTime'
+        tag:
+          $ref: '#/components/schemas/tag1'
+        referCallStatus:
+          $ref: '#/components/schemas/referCallStatusEnum'
+        referSipResponseCode:
+          $ref: '#/components/schemas/referSipResponseCode'
+        notifySipResponseCode:
+          $ref: '#/components/schemas/notifySipResponseCode'
     transcriptionAvailableCallback:
       type: object
       description: >-
@@ -5326,8 +5372,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
@@ -5479,6 +5525,21 @@ components:
         or it was previously cleared, this field will not be present.
       example: exampleTag
       nullable: true
+    referSipResponseCode:
+      type: integer
+      description: >-
+        (optional) The SIP response code returned for the REFER request itself
+        (e.g. 202, 405, 603). Present when a SIP response was received for the
+        REFER.
+      example: 202
+    notifySipResponseCode:
+      type: integer
+      description: >-
+        (optional) The final SIP response code reported via NOTIFY
+        (message/sipfrag body). Present only when the caller's endpoint sent a
+        final NOTIFY (e.g. 200, 404, 486, 503). Not present on NOTIFY timeout or
+        when the REFER was rejected before a subscription was established.
+      example: 200
     cause:
       type: string
       description: >-

bandwidth/__init__.py

@@ -197,6 +197,8 @@
     "RecordingTranscriptions",
     "RedirectCallback",
     "RedirectMethodEnum",
+    "ReferCallStatusEnum",
+    "ReferCompleteCallback",
     "SipConnectionMetadata",
     "SipCredentials",
     "SmsMessageContent",
@@ -424,6 +426,8 @@
 from bandwidth.models.recording_transcriptions import RecordingTranscriptions as RecordingTranscriptions
 from bandwidth.models.redirect_callback import RedirectCallback as RedirectCallback
 from bandwidth.models.redirect_method_enum import RedirectMethodEnum as RedirectMethodEnum
+from bandwidth.models.refer_call_status_enum import ReferCallStatusEnum as ReferCallStatusEnum
+from bandwidth.models.refer_complete_callback import ReferCompleteCallback as ReferCompleteCallback
 from bandwidth.models.sip_connection_metadata import SipConnectionMetadata as SipConnectionMetadata
 from bandwidth.models.sip_credentials import SipCredentials as SipCredentials
 from bandwidth.models.sms_message_content import SmsMessageContent as SmsMessageContent

bandwidth/models/__init__.py

@@ -171,6 +171,8 @@
 from bandwidth.models.recording_transcriptions import RecordingTranscriptions
 from bandwidth.models.redirect_callback import RedirectCallback
 from bandwidth.models.redirect_method_enum import RedirectMethodEnum
+from bandwidth.models.refer_call_status_enum import ReferCallStatusEnum
+from bandwidth.models.refer_complete_callback import ReferCompleteCallback
 from bandwidth.models.sip_connection_metadata import SipConnectionMetadata
 from bandwidth.models.sip_credentials import SipCredentials
 from bandwidth.models.sms_message_content import SmsMessageContent

bandwidth/models/answer_callback.py

@@ -30,7 +30,7 @@ class AnswerCallback(BaseModel):
     """
     The Answer event is sent to the answerUrl specified in the createCall request when an outbound call is answered.
     """ # noqa: E501
-    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
+    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
     event_time: Optional[datetime] = Field(default=None, description="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.", alias="eventTime")
     account_id: Optional[StrictStr] = Field(default=None, description="The user account associated with the call.", alias="accountId")
     application_id: Optional[StrictStr] = Field(default=None, description="The id of the application associated with the call.", alias="applicationId")

bandwidth/models/bridge_complete_callback.py

@@ -29,7 +29,7 @@ class BridgeCompleteCallback(BaseModel):
     """
     If the target call leaves the <Bridge>, then this callback is sent to the bridgeCompleteUrl, and the BXML returned in it is executed on the call. If this webhook is sent, the Bridge Target Complete webhook is NOT sent. This callback is also sent if any problem occurs that prevents the calls to be bridged.
     """ # noqa: E501
-    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
+    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
     event_time: Optional[datetime] = Field(default=None, description="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.", alias="eventTime")
     account_id: Optional[StrictStr] = Field(default=None, description="The user account associated with the call.", alias="accountId")
     application_id: Optional[StrictStr] = Field(default=None, description="The id of the application associated with the call.", alias="applicationId")

bandwidth/models/bridge_target_complete_callback.py

@@ -29,7 +29,7 @@ class BridgeTargetCompleteCallback(BaseModel):
     """
     If the originating call leaves the <Bridge>, then this callback is sent to the bridgeTargetCompleteUrl, and the BXML returned in it is executed on the target call. If this webhook is sent, the Bridge Complete webhook is NOT sent.
     """ # noqa: E501
-    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
+    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
     event_time: Optional[datetime] = Field(default=None, description="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.", alias="eventTime")
     account_id: Optional[StrictStr] = Field(default=None, description="The user account associated with the call.", alias="accountId")
     application_id: Optional[StrictStr] = Field(default=None, description="The id of the application associated with the call.", alias="applicationId")

bandwidth/models/conference_completed_callback.py

@@ -28,7 +28,7 @@ class ConferenceCompletedCallback(BaseModel):
     """
     The Conference Completed event is fired when the last member leaves the conference. The response to this event may not contain BXML.
     """ # noqa: E501
-    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
+    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
     event_time: Optional[datetime] = Field(default=None, description="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.", alias="eventTime")
     conference_id: Optional[StrictStr] = Field(default=None, description="The unique, Bandwidth-generated ID of the conference that was recorded", alias="conferenceId")
     name: Optional[StrictStr] = Field(default=None, description="The user-specified name of the conference that was recorded")

bandwidth/models/conference_created_callback.py

@@ -28,7 +28,7 @@ class ConferenceCreatedCallback(BaseModel):
     """
     The Conference Created event is fired whenever a new conference that specified a callbackUrl is created. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.
     """ # noqa: E501
-    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
+    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
     event_time: Optional[datetime] = Field(default=None, description="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.", alias="eventTime")
     conference_id: Optional[StrictStr] = Field(default=None, description="The unique, Bandwidth-generated ID of the conference that was recorded", alias="conferenceId")
     name: Optional[StrictStr] = Field(default=None, description="The user-specified name of the conference that was recorded")

bandwidth/models/conference_member_exit_callback.py

@@ -28,7 +28,7 @@ class ConferenceMemberExitCallback(BaseModel):
     """
     The Conference Member Exit event is fired whenever a caller exits a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.
     """ # noqa: E501
-    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
+    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
     event_time: Optional[datetime] = Field(default=None, description="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.", alias="eventTime")
     conference_id: Optional[StrictStr] = Field(default=None, description="The unique, Bandwidth-generated ID of the conference that was recorded", alias="conferenceId")
     name: Optional[StrictStr] = Field(default=None, description="The user-specified name of the conference that was recorded")

bandwidth/models/conference_member_join_callback.py

@@ -28,7 +28,7 @@ class ConferenceMemberJoinCallback(BaseModel):
     """
     The Conference Member Join event is fired whenever a caller joins a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.
     """ # noqa: E501
-    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
+    event_type: Optional[StrictStr] = Field(default=None, description="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.", alias="eventType")
     event_time: Optional[datetime] = Field(default=None, description="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.", alias="eventTime")
     conference_id: Optional[StrictStr] = Field(default=None, description="The unique, Bandwidth-generated ID of the conference that was recorded", alias="conferenceId")
     name: Optional[StrictStr] = Field(default=None, description="The user-specified name of the conference that was recorded")