Skip to content

SWI-12187 Update SDK Based on Recent Spec Changes #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
band-swi-release-engineering wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SWI-12187 Update SDK Based on Recent Spec Changes #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,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
Expand Down Expand Up @@ -390,6 +392,8 @@ lib/bandwidth-sdk/models/recording_transcription_metadata.rb
lib/bandwidth-sdk/models/recording_transcriptions.rb
lib/bandwidth-sdk/models/redirect_callback.rb
lib/bandwidth-sdk/models/redirect_method_enum.rb
lib/bandwidth-sdk/models/refer_call_status_enum.rb
lib/bandwidth-sdk/models/refer_complete_callback.rb
lib/bandwidth-sdk/models/sip_connection_metadata.rb
lib/bandwidth-sdk/models/sip_credentials.rb
lib/bandwidth-sdk/models/sms_message_content.rb
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,8 @@ Class | Method | HTTP request | Description
- [Bandwidth::RecordingTranscriptions](docs/RecordingTranscriptions.md)
- [Bandwidth::RedirectCallback](docs/RedirectCallback.md)
- [Bandwidth::RedirectMethodEnum](docs/RedirectMethodEnum.md)
- [Bandwidth::ReferCallStatusEnum](docs/ReferCallStatusEnum.md)
- [Bandwidth::ReferCompleteCallback](docs/ReferCompleteCallback.md)
- [Bandwidth::SipConnectionMetadata](docs/SipConnectionMetadata.md)
- [Bandwidth::SipCredentials](docs/SipCredentials.md)
- [Bandwidth::SmsMessageContent](docs/SmsMessageContent.md)
Expand Down
65 changes: 63 additions & 2 deletions bandwidth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -5134,6 +5141,45 @@ components:
$ref: '#/components/schemas/transferCallerId'
transferTo:
$ref: '#/components/schemas/transferTo'
referCompleteCallback:
type: object
description: >-
This event is sent to the referCompleteUrl of a call's <Refer> verb when
the SIP REFER flow completes. On success, the call has been torn down
and the BXML returned from this callback is ignored. On failure, the
call remains active and the BXML returned from this callback is executed
on the call.
properties:
eventType:
$ref: '#/components/schemas/eventType'
eventTime:
$ref: '#/components/schemas/eventTime'
accountId:
$ref: '#/components/schemas/accountId'
applicationId:
$ref: '#/components/schemas/applicationId1'
from:
$ref: '#/components/schemas/from'
to:
$ref: '#/components/schemas/to'
direction:
$ref: '#/components/schemas/callDirectionEnum'
callId:
$ref: '#/components/schemas/callId'
callUrl:
$ref: '#/components/schemas/callUrl'
startTime:
$ref: '#/components/schemas/startTime'
answerTime:
$ref: '#/components/schemas/answerTime'
tag:
$ref: '#/components/schemas/tag1'
referCallStatus:
$ref: '#/components/schemas/referCallStatusEnum'
referSipResponseCode:
$ref: '#/components/schemas/referSipResponseCode'
notifySipResponseCode:
$ref: '#/components/schemas/notifySipResponseCode'
transcriptionAvailableCallback:
type: object
description: >-
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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: >-
Expand Down
2 changes: 1 addition & 1 deletion docs/AnswerCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The user account associated with the call. | [optional] |
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/BridgeCompleteCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The user account associated with the call. | [optional] |
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/BridgeTargetCompleteCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The user account associated with the call. | [optional] |
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceCompletedCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceCreatedCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceMemberExitCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceMemberJoinCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceRecordingAvailableCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceRedirectCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/DisconnectCallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
| **event_time** | **Time** | 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** | **String** | The user account associated with the call. | [optional] |
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
Expand Down
Loading