diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index a070dc27..9e6c92dd 100644 --- a/.openapi-generator/FILES +++ b/.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 diff --git a/README.md b/README.md index c0eb322f..7c27d4ea 100644 --- a/README.md +++ b/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) diff --git a/bandwidth.yml b/bandwidth.yml index 8764a422..4b88b456 100644 --- a/bandwidth.yml +++ b/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 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: >- diff --git a/bandwidth/__init__.py b/bandwidth/__init__.py index 2356d8c2..49558523 100644 --- a/bandwidth/__init__.py +++ b/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 diff --git a/bandwidth/models/__init__.py b/bandwidth/models/__init__.py index 701d2a00..c82403a3 100644 --- a/bandwidth/models/__init__.py +++ b/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 diff --git a/bandwidth/models/answer_callback.py b/bandwidth/models/answer_callback.py index 892929c0..50eaebf2 100644 --- a/bandwidth/models/answer_callback.py +++ b/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") diff --git a/bandwidth/models/bridge_complete_callback.py b/bandwidth/models/bridge_complete_callback.py index f937a093..e4b0e477 100644 --- a/bandwidth/models/bridge_complete_callback.py +++ b/bandwidth/models/bridge_complete_callback.py @@ -29,7 +29,7 @@ class BridgeCompleteCallback(BaseModel): """ If the target call leaves the , 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") diff --git a/bandwidth/models/bridge_target_complete_callback.py b/bandwidth/models/bridge_target_complete_callback.py index 9a962589..e7c7402e 100644 --- a/bandwidth/models/bridge_target_complete_callback.py +++ b/bandwidth/models/bridge_target_complete_callback.py @@ -29,7 +29,7 @@ class BridgeTargetCompleteCallback(BaseModel): """ If the originating call leaves the , 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") diff --git a/bandwidth/models/conference_completed_callback.py b/bandwidth/models/conference_completed_callback.py index f5d17048..e6fc8603 100644 --- a/bandwidth/models/conference_completed_callback.py +++ b/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") diff --git a/bandwidth/models/conference_created_callback.py b/bandwidth/models/conference_created_callback.py index fe88fc22..88a6327c 100644 --- a/bandwidth/models/conference_created_callback.py +++ b/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") diff --git a/bandwidth/models/conference_member_exit_callback.py b/bandwidth/models/conference_member_exit_callback.py index 61342408..2ff4b3a1 100644 --- a/bandwidth/models/conference_member_exit_callback.py +++ b/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") diff --git a/bandwidth/models/conference_member_join_callback.py b/bandwidth/models/conference_member_join_callback.py index 4daa4715..7f182471 100644 --- a/bandwidth/models/conference_member_join_callback.py +++ b/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") diff --git a/bandwidth/models/conference_recording_available_callback.py b/bandwidth/models/conference_recording_available_callback.py index 4992bc52..4cfc7ee8 100644 --- a/bandwidth/models/conference_recording_available_callback.py +++ b/bandwidth/models/conference_recording_available_callback.py @@ -29,7 +29,7 @@ class ConferenceRecordingAvailableCallback(BaseModel): """ The Conference Recording Available event is sent after a conference recording has been processed. It indicates that the recording is available for download. """ # 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") diff --git a/bandwidth/models/conference_redirect_callback.py b/bandwidth/models/conference_redirect_callback.py index 7cd6cb4f..498b6723 100644 --- a/bandwidth/models/conference_redirect_callback.py +++ b/bandwidth/models/conference_redirect_callback.py @@ -28,7 +28,7 @@ class ConferenceRedirectCallback(BaseModel): """ The Conference Redirect event is fired whenever an existing conference is modified via a POST request made to the /conferences/{conferenceId} endpoint. 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") diff --git a/bandwidth/models/disconnect_callback.py b/bandwidth/models/disconnect_callback.py index 8a7778e6..e9091ff2 100644 --- a/bandwidth/models/disconnect_callback.py +++ b/bandwidth/models/disconnect_callback.py @@ -29,7 +29,7 @@ class DisconnectCallback(BaseModel): """ The Disconnect event is fired when a call ends, for any reason. """ # 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") diff --git a/bandwidth/models/dtmf_callback.py b/bandwidth/models/dtmf_callback.py index 807b0074..e554b1ad 100644 --- a/bandwidth/models/dtmf_callback.py +++ b/bandwidth/models/dtmf_callback.py @@ -29,7 +29,7 @@ class DtmfCallback(BaseModel): """ The DTMF event is sent for every digit detected after a verb is executed. You may not respond to this event with 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") 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") diff --git a/bandwidth/models/gather_callback.py b/bandwidth/models/gather_callback.py index 2512429d..c28cafbc 100644 --- a/bandwidth/models/gather_callback.py +++ b/bandwidth/models/gather_callback.py @@ -29,7 +29,7 @@ class GatherCallback(BaseModel): """ The gather event is sent after a verb is executed. Its purpose is to report the gathered digits to the calling application. """ # 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") diff --git a/bandwidth/models/initiate_callback.py b/bandwidth/models/initiate_callback.py index eed596e4..4116792b 100644 --- a/bandwidth/models/initiate_callback.py +++ b/bandwidth/models/initiate_callback.py @@ -32,7 +32,7 @@ class InitiateCallback(BaseModel): """ The Initiate event is fired when an inbound call is received for a Telephone Number on your Account. It is sent to the URL specified in the application associated with the location (sip-peer) that the called telephone number belongs to. """ # 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") diff --git a/bandwidth/models/machine_detection_complete_callback.py b/bandwidth/models/machine_detection_complete_callback.py index 55e8bfed..36ce366e 100644 --- a/bandwidth/models/machine_detection_complete_callback.py +++ b/bandwidth/models/machine_detection_complete_callback.py @@ -30,7 +30,7 @@ class MachineDetectionCompleteCallback(BaseModel): """ This event is sent to the url informed when requesting a machine detection operation. It contains the machine detection operation result, which can be: human, answering-machine, silence, timeout, error. This event is not sent when sync answering machine detection mode is chosen. """ # 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") diff --git a/bandwidth/models/recording_available_callback.py b/bandwidth/models/recording_available_callback.py index ba57a24f..92bc6938 100644 --- a/bandwidth/models/recording_available_callback.py +++ b/bandwidth/models/recording_available_callback.py @@ -30,7 +30,7 @@ class RecordingAvailableCallback(BaseModel): """ The Recording Available event is sent after a recording has been processed. It indicates that the recording is available for download. """ # 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") diff --git a/bandwidth/models/recording_complete_callback.py b/bandwidth/models/recording_complete_callback.py index 075f3d73..14b73e73 100644 --- a/bandwidth/models/recording_complete_callback.py +++ b/bandwidth/models/recording_complete_callback.py @@ -30,7 +30,7 @@ class RecordingCompleteCallback(BaseModel): """ The Record Complete event is sent after a verb has executed if the call is still active. The BXML returned by this callback is executed next. When the recording is available for download, a Recording Available event will be 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") diff --git a/bandwidth/models/redirect_callback.py b/bandwidth/models/redirect_callback.py index 90f78704..f6bce3ab 100644 --- a/bandwidth/models/redirect_callback.py +++ b/bandwidth/models/redirect_callback.py @@ -29,7 +29,7 @@ class RedirectCallback(BaseModel): """ The Redirect event is fired when a verb is executed. Its purpose is to get the next set of verbs from the calling application. """ # 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") diff --git a/bandwidth/models/refer_call_status_enum.py b/bandwidth/models/refer_call_status_enum.py new file mode 100644 index 00000000..f00d7f5d --- /dev/null +++ b/bandwidth/models/refer_call_status_enum.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Bandwidth + + Bandwidth's Communication APIs + + The version of the OpenAPI document: 1.0.0 + Contact: letstalk@bandwidth.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ReferCallStatusEnum(str, Enum): + """ + The outcome of the REFER operation. + """ + + """ + allowed enum values + """ + SUCCESS = 'success' + FAILURE = 'failure' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ReferCallStatusEnum from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/bandwidth/models/refer_complete_callback.py b/bandwidth/models/refer_complete_callback.py new file mode 100644 index 00000000..55775f35 --- /dev/null +++ b/bandwidth/models/refer_complete_callback.py @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + Bandwidth + + Bandwidth's Communication APIs + + The version of the OpenAPI document: 1.0.0 + Contact: letstalk@bandwidth.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from bandwidth.models.call_direction_enum import CallDirectionEnum +from bandwidth.models.refer_call_status_enum import ReferCallStatusEnum +from typing import Optional, Set +from typing_extensions import Self + +class ReferCompleteCallback(BaseModel): + """ + This event is sent to the referCompleteUrl of a call's 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. + """ # 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, 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") + var_from: Optional[StrictStr] = Field(default=None, description="The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).", alias="from") + to: Optional[StrictStr] = Field(default=None, description="The phone number that received the call, in E.164 format (e.g. +15555555555).") + direction: Optional[CallDirectionEnum] = None + call_id: Optional[StrictStr] = Field(default=None, description="The call id associated with the event.", alias="callId") + call_url: Optional[StrictStr] = Field(default=None, description="The URL of the call associated with the event.", alias="callUrl") + start_time: Optional[datetime] = Field(default=None, description="Time the call was started, in ISO 8601 format.", alias="startTime") + answer_time: Optional[datetime] = Field(default=None, description="Time the call was answered, in ISO 8601 format.", alias="answerTime") + tag: Optional[StrictStr] = Field(default=None, description="(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.") + refer_call_status: Optional[ReferCallStatusEnum] = Field(default=None, alias="referCallStatus") + refer_sip_response_code: Optional[StrictInt] = Field(default=None, 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.", alias="referSipResponseCode") + notify_sip_response_code: Optional[StrictInt] = Field(default=None, 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.", alias="notifySipResponseCode") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["eventType", "eventTime", "accountId", "applicationId", "from", "to", "direction", "callId", "callUrl", "startTime", "answerTime", "tag", "referCallStatus", "referSipResponseCode", "notifySipResponseCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReferCompleteCallback from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if answer_time (nullable) is None + # and model_fields_set contains the field + if self.answer_time is None and "answer_time" in self.model_fields_set: + _dict['answerTime'] = None + + # set to None if tag (nullable) is None + # and model_fields_set contains the field + if self.tag is None and "tag" in self.model_fields_set: + _dict['tag'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReferCompleteCallback from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "eventType": obj.get("eventType"), + "eventTime": obj.get("eventTime"), + "accountId": obj.get("accountId"), + "applicationId": obj.get("applicationId"), + "from": obj.get("from"), + "to": obj.get("to"), + "direction": obj.get("direction"), + "callId": obj.get("callId"), + "callUrl": obj.get("callUrl"), + "startTime": obj.get("startTime"), + "answerTime": obj.get("answerTime"), + "tag": obj.get("tag"), + "referCallStatus": obj.get("referCallStatus"), + "referSipResponseCode": obj.get("referSipResponseCode"), + "notifySipResponseCode": obj.get("notifySipResponseCode") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/bandwidth/models/transcription_available_callback.py b/bandwidth/models/transcription_available_callback.py index 3cf49a95..6035a516 100644 --- a/bandwidth/models/transcription_available_callback.py +++ b/bandwidth/models/transcription_available_callback.py @@ -31,7 +31,7 @@ class TranscriptionAvailableCallback(BaseModel): """ The Transcription Available event is sent when the recording transcription is available to be downloaded. """ # 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") diff --git a/bandwidth/models/transfer_answer_callback.py b/bandwidth/models/transfer_answer_callback.py index 343c677b..4066c005 100644 --- a/bandwidth/models/transfer_answer_callback.py +++ b/bandwidth/models/transfer_answer_callback.py @@ -29,7 +29,7 @@ class TransferAnswerCallback(BaseModel): """ When processing a verb, this event is sent when a called party (B-leg) answers. The event is sent to the endpoint specified in the transferAnswerUrl attribute of the tag that answered. BXML returned by this callback will be executed for the called party only. After all BXML has been executed, the called party will be bridged to the original call. Most BXML verbs are allowed in response to a transferAnswer event, but some are not allowed. """ # 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") diff --git a/bandwidth/models/transfer_complete_callback.py b/bandwidth/models/transfer_complete_callback.py index 8118d8b9..44c4c10e 100644 --- a/bandwidth/models/transfer_complete_callback.py +++ b/bandwidth/models/transfer_complete_callback.py @@ -29,7 +29,7 @@ class TransferCompleteCallback(BaseModel): """ This event is sent to the transferCompleteUrl of the A-leg's 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. """ # 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") diff --git a/bandwidth/models/transfer_disconnect_callback.py b/bandwidth/models/transfer_disconnect_callback.py index 5a215357..60e655df 100644 --- a/bandwidth/models/transfer_disconnect_callback.py +++ b/bandwidth/models/transfer_disconnect_callback.py @@ -29,7 +29,7 @@ class TransferDisconnectCallback(BaseModel): """ This event is sent to the transferDisconnectUrl of each tag when its respective call leg ends for any reason. The event is sent in the normal case, when the transferred leg is answered and later hung up, but is also sent if the new leg was never answered in the first place, if it was rejected, and if the original call leg hung up before the transferred leg. """ # 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") diff --git a/docs/AnswerCallback.md b/docs/AnswerCallback.md index 4d28c160..2146f1ef 100644 --- a/docs/AnswerCallback.md +++ b/docs/AnswerCallback.md @@ -6,7 +6,7 @@ The Answer event is sent to the answerUrl specified in the createCall request wh Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/BridgeCompleteCallback.md b/docs/BridgeCompleteCallback.md index aa5b3fec..fbfc1050 100644 --- a/docs/BridgeCompleteCallback.md +++ b/docs/BridgeCompleteCallback.md @@ -6,7 +6,7 @@ If the target call leaves the , then this callback is sent to the bridge Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/BridgeTargetCompleteCallback.md b/docs/BridgeTargetCompleteCallback.md index 729820c1..bf72b897 100644 --- a/docs/BridgeTargetCompleteCallback.md +++ b/docs/BridgeTargetCompleteCallback.md @@ -6,7 +6,7 @@ If the originating call leaves the , then this callback is sent to the b Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/ConferenceCompletedCallback.md b/docs/ConferenceCompletedCallback.md index eca1873f..b04cfe95 100644 --- a/docs/ConferenceCompletedCallback.md +++ b/docs/ConferenceCompletedCallback.md @@ -6,7 +6,7 @@ The Conference Completed event is fired when the last member leaves the conferen Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **conference_id** | **str** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] **name** | **str** | The user-specified name of the conference that was recorded | [optional] diff --git a/docs/ConferenceCreatedCallback.md b/docs/ConferenceCreatedCallback.md index 54618cfc..b9ccd57a 100644 --- a/docs/ConferenceCreatedCallback.md +++ b/docs/ConferenceCreatedCallback.md @@ -6,7 +6,7 @@ The Conference Created event is fired whenever a new conference that specified a Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **conference_id** | **str** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] **name** | **str** | The user-specified name of the conference that was recorded | [optional] diff --git a/docs/ConferenceMemberExitCallback.md b/docs/ConferenceMemberExitCallback.md index 950ae557..f514a066 100644 --- a/docs/ConferenceMemberExitCallback.md +++ b/docs/ConferenceMemberExitCallback.md @@ -6,7 +6,7 @@ The Conference Member Exit event is fired whenever a caller exits a conference t Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **conference_id** | **str** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] **name** | **str** | The user-specified name of the conference that was recorded | [optional] diff --git a/docs/ConferenceMemberJoinCallback.md b/docs/ConferenceMemberJoinCallback.md index a87924cd..c7c5ff96 100644 --- a/docs/ConferenceMemberJoinCallback.md +++ b/docs/ConferenceMemberJoinCallback.md @@ -6,7 +6,7 @@ The Conference Member Join event is fired whenever a caller joins a conference t Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **conference_id** | **str** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] **name** | **str** | The user-specified name of the conference that was recorded | [optional] diff --git a/docs/ConferenceRecordingAvailableCallback.md b/docs/ConferenceRecordingAvailableCallback.md index 1ffd3a1e..42b98bee 100644 --- a/docs/ConferenceRecordingAvailableCallback.md +++ b/docs/ConferenceRecordingAvailableCallback.md @@ -6,7 +6,7 @@ The Conference Recording Available event is sent after a conference recording ha Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **conference_id** | **str** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] **name** | **str** | The user-specified name of the conference that was recorded | [optional] diff --git a/docs/ConferenceRedirectCallback.md b/docs/ConferenceRedirectCallback.md index 6f92e112..4366b502 100644 --- a/docs/ConferenceRedirectCallback.md +++ b/docs/ConferenceRedirectCallback.md @@ -6,7 +6,7 @@ The Conference Redirect event is fired whenever an existing conference is modifi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **conference_id** | **str** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] **name** | **str** | The user-specified name of the conference that was recorded | [optional] diff --git a/docs/DisconnectCallback.md b/docs/DisconnectCallback.md index 658fed07..dacdfa75 100644 --- a/docs/DisconnectCallback.md +++ b/docs/DisconnectCallback.md @@ -6,7 +6,7 @@ The Disconnect event is fired when a call ends, for any reason. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/DtmfCallback.md b/docs/DtmfCallback.md index 52091bfb..89449dc1 100644 --- a/docs/DtmfCallback.md +++ b/docs/DtmfCallback.md @@ -6,7 +6,7 @@ The DTMF event is sent for every digit detected after a verb is ex Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/GatherCallback.md b/docs/GatherCallback.md index 50d2ac3d..cbc83fae 100644 --- a/docs/GatherCallback.md +++ b/docs/GatherCallback.md @@ -6,7 +6,7 @@ The gather event is sent after a verb is executed. Its purpose is to re Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/InitiateCallback.md b/docs/InitiateCallback.md index ff6aa724..02199ebe 100644 --- a/docs/InitiateCallback.md +++ b/docs/InitiateCallback.md @@ -6,7 +6,7 @@ The Initiate event is fired when an inbound call is received for a Telephone Num Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/MachineDetectionCompleteCallback.md b/docs/MachineDetectionCompleteCallback.md index b3f3f9c4..c2587312 100644 --- a/docs/MachineDetectionCompleteCallback.md +++ b/docs/MachineDetectionCompleteCallback.md @@ -6,7 +6,7 @@ This event is sent to the url informed when requesting a machine detection opera Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/RecordingAvailableCallback.md b/docs/RecordingAvailableCallback.md index 465f44ea..8066921a 100644 --- a/docs/RecordingAvailableCallback.md +++ b/docs/RecordingAvailableCallback.md @@ -6,7 +6,7 @@ The Recording Available event is sent after a recording has been processed. It i Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/RecordingCompleteCallback.md b/docs/RecordingCompleteCallback.md index 50ce4188..387d4507 100644 --- a/docs/RecordingCompleteCallback.md +++ b/docs/RecordingCompleteCallback.md @@ -6,7 +6,7 @@ The Record Complete event is sent after a verb has executed if the call Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/RedirectCallback.md b/docs/RedirectCallback.md index 77f4eb06..285adeaa 100644 --- a/docs/RedirectCallback.md +++ b/docs/RedirectCallback.md @@ -6,7 +6,7 @@ The Redirect event is fired when a verb is executed. Its purpose is t Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/ReferCallStatusEnum.md b/docs/ReferCallStatusEnum.md new file mode 100644 index 00000000..0c044cfa --- /dev/null +++ b/docs/ReferCallStatusEnum.md @@ -0,0 +1,13 @@ +# ReferCallStatusEnum + +The outcome of the REFER operation. + +## Enum + +* `SUCCESS` (value: `'success'`) + +* `FAILURE` (value: `'failure'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ReferCompleteCallback.md b/docs/ReferCompleteCallback.md new file mode 100644 index 00000000..a7da1739 --- /dev/null +++ b/docs/ReferCompleteCallback.md @@ -0,0 +1,44 @@ +# ReferCompleteCallback + +This event is sent to the referCompleteUrl of a call's 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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **str** | 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] +**event_time** | **datetime** | 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] +**account_id** | **str** | The user account associated with the call. | [optional] +**application_id** | **str** | The id of the application associated with the call. | [optional] +**var_from** | **str** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] +**to** | **str** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] +**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] +**call_id** | **str** | The call id associated with the event. | [optional] +**call_url** | **str** | The URL of the call associated with the event. | [optional] +**start_time** | **datetime** | Time the call was started, in ISO 8601 format. | [optional] +**answer_time** | **datetime** | Time the call was answered, in ISO 8601 format. | [optional] +**tag** | **str** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] +**refer_call_status** | [**ReferCallStatusEnum**](ReferCallStatusEnum.md) | | [optional] +**refer_sip_response_code** | **int** | (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. | [optional] +**notify_sip_response_code** | **int** | (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. | [optional] + +## Example + +```python +from bandwidth.models.refer_complete_callback import ReferCompleteCallback + +# TODO update the JSON string below +json = "{}" +# create an instance of ReferCompleteCallback from a JSON string +refer_complete_callback_instance = ReferCompleteCallback.from_json(json) +# print the JSON string representation of the object +print(ReferCompleteCallback.to_json()) + +# convert the object into a dict +refer_complete_callback_dict = refer_complete_callback_instance.to_dict() +# create an instance of ReferCompleteCallback from a dict +refer_complete_callback_from_dict = ReferCompleteCallback.from_dict(refer_complete_callback_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TranscriptionAvailableCallback.md b/docs/TranscriptionAvailableCallback.md index 16a1c93c..6661a0b9 100644 --- a/docs/TranscriptionAvailableCallback.md +++ b/docs/TranscriptionAvailableCallback.md @@ -6,7 +6,7 @@ The Transcription Available event is sent when the recording transcription is av Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/TransferAnswerCallback.md b/docs/TransferAnswerCallback.md index 6e33e551..dcd11b46 100644 --- a/docs/TransferAnswerCallback.md +++ b/docs/TransferAnswerCallback.md @@ -6,7 +6,7 @@ When processing a verb, this event is sent when a called party (B-leg Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/TransferCompleteCallback.md b/docs/TransferCompleteCallback.md index c96e8f5b..8041bf3c 100644 --- a/docs/TransferCompleteCallback.md +++ b/docs/TransferCompleteCallback.md @@ -6,7 +6,7 @@ This event is sent to the transferCompleteUrl of the A-leg's verb whe Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional] diff --git a/docs/TransferDisconnectCallback.md b/docs/TransferDisconnectCallback.md index a6af2474..bf1313c9 100644 --- a/docs/TransferDisconnectCallback.md +++ b/docs/TransferDisconnectCallback.md @@ -6,7 +6,7 @@ This event is sent to the transferDisconnectUrl of each tag when i Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_type** | **str** | 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] +**event_type** | **str** | 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] **event_time** | **datetime** | 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] **account_id** | **str** | The user account associated with the call. | [optional] **application_id** | **str** | The id of the application associated with the call. | [optional]