From e6057012b789a78780143a80214e13f416b1339b Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 3 Nov 2026 20:54:19 +0000 Subject: [PATCH 1/2] Generate SDK with OpenAPI Generator Version 7.24.0 --- README.md | 10 -- bandwidth.yml | 157 +++++++----------- docs/CallsApi.md | 30 +--- docs/ConferencesApi.md | 54 +----- docs/EndpointsApi.md | 30 +--- docs/InboundCallback.md | 2 +- docs/MFAApi.md | 18 +- docs/MediaApi.md | 24 +-- docs/Message.md | 2 +- docs/MessagesApi.md | 12 +- docs/MultiChannelApi.md | 6 +- docs/PhoneNumberLookupApi.md | 18 +- docs/RecordingsApi.md | 60 ++----- docs/StatisticsApi.md | 6 +- docs/StatusCallback.md | 4 +- docs/TollFreeVerificationApi.md | 54 +----- docs/TranscriptionsApi.md | 18 +- lib/bandwidth-sdk/api/calls_api.rb | 10 +- lib/bandwidth-sdk/api/conferences_api.rb | 18 +- lib/bandwidth-sdk/api/endpoints_api.rb | 10 +- lib/bandwidth-sdk/api/media_api.rb | 8 +- lib/bandwidth-sdk/api/messages_api.rb | 4 +- lib/bandwidth-sdk/api/mfa_api.rb | 6 +- lib/bandwidth-sdk/api/multi_channel_api.rb | 2 +- .../api/phone_number_lookup_api.rb | 6 +- lib/bandwidth-sdk/api/recordings_api.rb | 20 +-- lib/bandwidth-sdk/api/statistics_api.rb | 2 +- .../api/toll_free_verification_api.rb | 18 +- lib/bandwidth-sdk/api/transcriptions_api.rb | 6 +- lib/bandwidth-sdk/configuration.rb | 7 - 30 files changed, 174 insertions(+), 448 deletions(-) diff --git a/README.md b/README.md index f86216e1..7c9b430e 100644 --- a/README.md +++ b/README.md @@ -80,12 +80,6 @@ require 'bandwidth-sdk' # Setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR_USERNAME' - config.password = 'YOUR_PASSWORD' - # Configure faraday connection - config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' } - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR_ACCESS TOKEN' # Or use your client ID and client secret to obtain an access token @@ -384,10 +378,6 @@ Class | Method | HTTP request | Description Authentication schemes defined for the API: -### Basic - -- **Type**: HTTP basic authentication - ### OAuth2 diff --git a/bandwidth.yml b/bandwidth.yml index 0df9d764..bffc6469 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -8,7 +8,6 @@ info: email: letstalk@bandwidth.com version: 1.0.0 security: - - Basic: [] - OAuth2: [] tags: - name: Messages @@ -2015,7 +2014,7 @@ components: type: string format: date-time description: The ISO 8601 datetime of the message. - example: 2020-04-07T14:03:07.000Z + example: '2020-04-07T14:03:07.000Z' carrierName: type: string nullable: true @@ -2095,13 +2094,11 @@ components: prevPage: type: string description: The link to the previous page for pagination. - example: >- - https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&nextPage=DLAPE902 + example: https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&nextPage=DLAPE902 nextPage: type: string description: The link to the next page for pagination. - example: >- - https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&prevPage=GL83PD3C + example: https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&prevPage=GL83PD3C prevPageToken: type: string description: The isolated pagination token for the previous page. @@ -2202,7 +2199,7 @@ components: type: string format: date-time description: The datetime stamp of the message in ISO 8601 - example: 2024-12-02T20:15:57.278Z + example: '2024-12-02T20:15:57.278201Z' segmentCount: $ref: '#/components/schemas/segmentCount' direction: @@ -2698,14 +2695,14 @@ components: description: >- The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. - example: 2022-09-14T18:20:16.000Z + example: '2022-09-14T18:20:16.000Z' endTime: type: string format: date-time description: >- The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. - example: 2022-09-14T18:20:16.000Z + example: '2022-09-14T18:20:16.000Z' description: type: string description: The description of the event. @@ -2877,7 +2874,7 @@ components: description: The time the message was received by the Bandwidth API. type: string format: date-time - example: 2025-01-01T18:20:16.000Z + example: '2025-01-01T18:20:16.000Z' direction: $ref: '#/components/schemas/messageDirectionEnum' to: @@ -3037,14 +3034,14 @@ components: time: type: string format: date-time - example: 2024-12-02T20:15:57.278Z + example: '2024-12-02T20:15:57.278201Z' eventTime: type: string description: >- Represents the time at which the message was read, for `message-read` callbacks. format: date-time - example: 2024-12-02T20:15:58.278Z + example: '2024-12-02T20:15:58.278205Z' type: $ref: '#/components/schemas/statusCallbackTypeEnum' to: @@ -3080,7 +3077,7 @@ components: time: type: string format: date-time - example: 2024-12-02T20:15:57.278Z + example: '2024-12-02T20:15:57.278201Z' type: $ref: '#/components/schemas/inboundCallbackTypeEnum' to: @@ -3176,7 +3173,7 @@ components: time: type: string format: date-time - example: 2024-12-02T20:15:57.666Z + example: '2024-12-02T20:15:57.666000Z' segmentCount: $ref: '#/components/schemas/segmentCount' direction: @@ -3408,8 +3405,7 @@ components: uui: nullable: true type: string - example: >- - eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64 + example: eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64 description: >- A comma-separated list of 'User-To-User' headers to be sent @@ -3619,8 +3615,7 @@ components: callUrl: type: string format: uri - example: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 + example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 description: The URL to update this call's state. callTimeout: type: number @@ -3791,8 +3786,7 @@ components: configured to forward this header. - example: >- - eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=;alg=ES256;ppt=shaken + example: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=;alg=ES256;ppt=shaken enqueuedTime: nullable: true type: string @@ -4109,8 +4103,7 @@ components: respond. Not allowed if `state` is `completed`. - example: >- - https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect + example: https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect redirectFallbackMethod: $ref: '#/components/schemas/redirectMethodEnum' fallbackUsername: @@ -4149,8 +4142,7 @@ components: Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. - example: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 + example: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 mute: type: boolean description: >- @@ -4387,8 +4379,7 @@ components: to respond maxLength: 2048 - example: >- - https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete + example: https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete fallbackMethod: $ref: '#/components/schemas/callbackMethodEnum' fallbackUsername: @@ -4542,8 +4533,7 @@ components: example: - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b transcriptionName: live_transcription - transcriptionUrl: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b + transcriptionUrl: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b callTranscriptionMetadata: type: object properties: @@ -4566,8 +4556,7 @@ components: [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. - example: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b + example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b callTranscriptionResponse: type: object properties: @@ -4632,8 +4621,7 @@ components: type: string format: uri description: The URL of the [transcription](#operation/getCallTranscription) - example: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/recordings/r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/transcription + example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/recordings/r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/transcription voiceApiError: type: object properties: @@ -5608,8 +5596,7 @@ components: description: >- The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. - example: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media + example: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media callId: type: string description: The call id associated with the event. @@ -5622,8 +5609,7 @@ components: type: string format: uri description: The URL of the call associated with the event. - example: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 + example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 parentCallId: type: string description: >- @@ -6869,8 +6855,7 @@ components: maxLength: 500 nullable: false example: https://www.example.com/path/to/resource - pattern: >- - ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*) + pattern: ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*) confirmationResponse: type: string minLength: 0 @@ -6917,8 +6902,7 @@ components: minLength: 0 maxLength: 500 nullable: false - pattern: >- - ^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$ + pattern: ^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$ example: foo@bar.com useCases: type: array @@ -7070,8 +7054,7 @@ components: maxLength: 2000 nullable: true example: https://www.example.com/path/to/resource - pattern: >- - ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*) + pattern: ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*) tfvError: description: A generic error object. properties: @@ -7210,8 +7193,7 @@ components: minLength: 0 maxLength: 500 nullable: true - example: >- - cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw + example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw endpointId: type: string description: The unique ID of the endpoint. @@ -7416,8 +7398,7 @@ components: href: type: string description: The full URL of the link. - example: >- - https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 + example: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 rel: type: string description: The relationship of the link to the current resource. @@ -8411,8 +8392,7 @@ components: in: header name: Continuation-Token description: Continuation token used to retrieve subsequent media. - example: >- - 1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39 + example: 1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39 schema: type: string messageId: @@ -8501,7 +8481,7 @@ components: description: >- The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. - example: 2022-09-14T18:20:16.000Z + example: '2022-09-14T18:20:16.000Z' schema: type: string toDateTime: @@ -8511,7 +8491,7 @@ components: description: >- The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. - example: 2022-09-14T18:20:16.000Z + example: '2022-09-14T18:20:16.000Z' schema: type: string campaignId: @@ -8979,8 +8959,7 @@ components: from: '+12345678901' text: Hey, check out the MMS! media: - - >- - https://messaging.bandwidth.com/api/v2/users/9900902/media/14762070468292kw2fuqty55yp2b2/0/bw.png + - https://messaging.bandwidth.com/api/v2/users/9900902/media/14762070468292kw2fuqty55yp2b2/0/bw.png rbmMessageReceivedSessionCallbackExample: summary: >- An example of a rbm message-received callback body for a message that is @@ -9209,8 +9188,7 @@ components: to: '+19195551234' from: '+19195554312' enqueuedTime: '2022-06-16T13:15:07.160Z' - callUrl: >- - https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 + callUrl: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 callTimeout: 30 callbackTimeout: 15 tag: My custom tag value @@ -9302,14 +9280,12 @@ components: summary: Numbers Lookup Accepted value: links: - - href: >- - /accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590 + - href: /accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590 rel: createdRequest method: GET data: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: IN_PROGRESS - results: [] errors: [] lookupInProgressExample: summary: Numbers Lookup In Progress @@ -9482,7 +9458,8 @@ components: links: [] data: {} errors: - - type: bad-request + - code: '1234' + type: bad-request description: >- Bad Request. Ensure that you have set the requestId as a URL path parameter. @@ -9495,7 +9472,6 @@ components: - type: Unauthorized description: You are not authorized to access this resource. code: '1' - page: null forbiddenExample: summary: Forbidden Error value: @@ -9505,14 +9481,14 @@ components: - type: Forbidden description: You do not have permission to access this resource. code: '2' - page: null unsupportedMediaTypeExample: summary: Unsupported Media Type Error value: links: [] data: {} errors: - - type: invalid-content-type + - code: '1234' + type: invalid-content-type description: >- Invalid content-type. Ensure that your content-type header is set to application/json. @@ -9522,7 +9498,8 @@ components: links: [] data: {} errors: - - type: not-found + - code: '1234' + type: not-found description: >- RequestId not found. Ensure that the requestId used in the URL path is valid and maps to a previous request that was submitted. @@ -9532,7 +9509,8 @@ components: links: [] data: {} errors: - - type: rate-limiting + - code: '1234' + type: rate-limiting description: >- Rate limit exceeded. Wait for the time specified in the Retry-After header before sending another request. @@ -9552,12 +9530,10 @@ components: summary: List Endpoints Paginated Response value: links: - - href: >- - https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2 + - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2 rel: self method: GET - - href: >- - https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2&afterCursor=TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ== + - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2&afterCursor=TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ== rel: next method: GET page: @@ -9583,8 +9559,7 @@ components: summary: Create Endpoint Response value: links: - - href: >- - https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 + - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 rel: endpoint method: GET data: @@ -9601,8 +9576,7 @@ components: summary: Get Endpoint Response value: links: - - href: >- - https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 + - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 rel: self method: GET data: @@ -10128,24 +10102,6 @@ components: examples: updateEndpointBxmlRequestExample: $ref: '#/components/examples/updateEndpointBxmlRequestExample' - securitySchemes: - Basic: - type: http - scheme: basic - description: >- - Basic authentication is a simple authentication scheme built into the - HTTP protocol. To use it, send your HTTP requests with an - `Authorization` header that contains the word `Basic` followed by a - space and a Base64-encoded string `username:password`. - - - - Example: `Authorization: Basic ZGVtbZpwQDU1dzByZA==` - OAuth2: - type: oauth2 - flows: - clientCredentials: - tokenUrl: https://api.bandwidth.com/api/v1/oauth2/token - scopes: {} callbacks: inboundCallback: '{inboundCallbackUrl}': @@ -10182,8 +10138,7 @@ components: mmsMessageReceivedCallback: $ref: '#/components/examples/mmsMessageReceivedCallbackExample' rbmMessageReceivedSessionCallback: - $ref: >- - #/components/examples/rbmMessageReceivedSessionCallbackExample + $ref: '#/components/examples/rbmMessageReceivedSessionCallbackExample' responses: '200': description: OK @@ -10218,14 +10173,11 @@ components: mmsMessageDeliveredCallback: $ref: '#/components/examples/mmsMessageDeliveredCallbackExample' groupMmsMessageDeliveredCallback: - $ref: >- - #/components/examples/groupMmsMessageDeliveredCallbackExample + $ref: '#/components/examples/groupMmsMessageDeliveredCallbackExample' rbmMessageDeliveredSessionCallback: - $ref: >- - #/components/examples/rbmMessageDeliveredSessionCallbackExample + $ref: '#/components/examples/rbmMessageDeliveredSessionCallbackExample' rbmMessageDeliveredCanInitiateSessionCallback: - $ref: >- - #/components/examples/rbmMessageDeliveredCanInitiateSessionCallbackExample + $ref: '#/components/examples/rbmMessageDeliveredCanInitiateSessionCallbackExample' messageFailedCallback: $ref: '#/components/examples/messageFailedCallbackExample' sessionStartedCallback: @@ -10289,3 +10241,14 @@ components: responses: '204': description: Event was successfully received. + securitySchemes: + OAuth2: + type: oauth2 + description: >- + OAuth2 client credentials. For information on obtaining credentials, see + [Credentials + Management](https://dev.bandwidth.com/docs/account/credentials/management/). + flows: + clientCredentials: + tokenUrl: https://api.bandwidth.com/api/v1/oauth2/token + scopes: {} diff --git a/docs/CallsApi.md b/docs/CallsApi.md index b0f61d3e..d51acaf2 100644 --- a/docs/CallsApi.md +++ b/docs/CallsApi.md @@ -26,10 +26,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -78,7 +74,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -101,10 +97,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -153,7 +145,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -176,10 +168,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -242,7 +230,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -265,10 +253,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -318,7 +302,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -341,10 +325,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -397,7 +377,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/ConferencesApi.md b/docs/ConferencesApi.md index 743ef413..7b313f8d 100644 --- a/docs/ConferencesApi.md +++ b/docs/ConferencesApi.md @@ -30,10 +30,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -84,7 +80,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -107,10 +103,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -159,7 +151,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -182,10 +174,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -236,7 +224,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -259,10 +247,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -313,7 +297,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -336,10 +320,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -388,7 +368,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -411,10 +391,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -473,7 +449,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -496,10 +472,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -549,7 +521,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -572,10 +544,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -628,7 +596,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -651,10 +619,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -706,7 +670,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/EndpointsApi.md b/docs/EndpointsApi.md index bae5ab8b..4fcf579a 100644 --- a/docs/EndpointsApi.md +++ b/docs/EndpointsApi.md @@ -26,10 +26,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -78,7 +74,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -101,10 +97,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -152,7 +144,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -175,10 +167,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -227,7 +215,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -250,10 +238,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -310,7 +294,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -333,10 +317,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -386,7 +366,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/InboundCallback.md b/docs/InboundCallback.md index fa978ac0..c0f4c7c4 100644 --- a/docs/InboundCallback.md +++ b/docs/InboundCallback.md @@ -17,7 +17,7 @@ require 'bandwidth-sdk' instance = Bandwidth::InboundCallback.new( - time: 2024-12-02T20:15:57.278Z, + time: 2024-12-02T20:15:57.278201Z, type: null, to: +15552223333, description: Incoming message received, diff --git a/docs/MFAApi.md b/docs/MFAApi.md index 96b14b48..0d323630 100644 --- a/docs/MFAApi.md +++ b/docs/MFAApi.md @@ -24,10 +24,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -76,7 +72,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -99,10 +95,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -151,7 +143,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -174,10 +166,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -226,7 +214,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/MediaApi.md b/docs/MediaApi.md index 8c800661..950c0efe 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -25,10 +25,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -76,7 +72,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -99,10 +95,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -151,7 +143,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -174,10 +166,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -228,7 +216,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -251,10 +239,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -310,7 +294,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/Message.md b/docs/Message.md index d42f5265..ded857cc 100644 --- a/docs/Message.md +++ b/docs/Message.md @@ -27,7 +27,7 @@ instance = Bandwidth::Message.new( id: 1589228074636lm4k2je7j7jklbn2, owner: +15554443333, application_id: 93de2206-9669-4e07-948d-329f4b722ee2, - time: 2024-12-02T20:15:57.278Z, + time: 2024-12-02T20:15:57.278201Z, segment_count: 1, direction: null, to: ["+15552223333"], diff --git a/docs/MessagesApi.md b/docs/MessagesApi.md index 4aa303ae..35d6d114 100644 --- a/docs/MessagesApi.md +++ b/docs/MessagesApi.md @@ -23,10 +23,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -75,7 +71,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -98,10 +94,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -204,7 +196,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/MultiChannelApi.md b/docs/MultiChannelApi.md index 2bfbe583..185adce0 100644 --- a/docs/MultiChannelApi.md +++ b/docs/MultiChannelApi.md @@ -22,10 +22,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -74,7 +70,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/PhoneNumberLookupApi.md b/docs/PhoneNumberLookupApi.md index b3c38843..cc09933a 100644 --- a/docs/PhoneNumberLookupApi.md +++ b/docs/PhoneNumberLookupApi.md @@ -24,10 +24,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -76,7 +72,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -99,10 +95,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -151,7 +143,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -174,10 +166,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -226,7 +214,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/RecordingsApi.md b/docs/RecordingsApi.md index f95bf9f0..eca620e8 100644 --- a/docs/RecordingsApi.md +++ b/docs/RecordingsApi.md @@ -31,10 +31,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -84,7 +80,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -107,10 +103,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -160,7 +152,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -183,10 +175,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -236,7 +224,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -259,10 +247,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -313,7 +297,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -336,10 +320,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -390,7 +370,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -413,10 +393,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -467,7 +443,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -490,10 +466,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -550,7 +522,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -573,10 +545,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -625,7 +593,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -648,10 +616,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -703,7 +667,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -726,10 +690,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -779,7 +739,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/StatisticsApi.md b/docs/StatisticsApi.md index 15fa3fcb..d649b289 100644 --- a/docs/StatisticsApi.md +++ b/docs/StatisticsApi.md @@ -22,10 +22,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -72,7 +68,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/StatusCallback.md b/docs/StatusCallback.md index 226f159d..d1773072 100644 --- a/docs/StatusCallback.md +++ b/docs/StatusCallback.md @@ -19,8 +19,8 @@ require 'bandwidth-sdk' instance = Bandwidth::StatusCallback.new( - time: 2024-12-02T20:15:57.278Z, - event_time: 2024-12-02T20:15:58.278Z, + time: 2024-12-02T20:15:57.278201Z, + event_time: 2024-12-02T20:15:58.278205Z, type: null, to: +15552223333, description: Message delivered to handset., diff --git a/docs/TollFreeVerificationApi.md b/docs/TollFreeVerificationApi.md index 1646e37b..be38871b 100644 --- a/docs/TollFreeVerificationApi.md +++ b/docs/TollFreeVerificationApi.md @@ -30,10 +30,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -82,7 +78,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -105,10 +101,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -156,7 +148,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -179,10 +171,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -230,7 +218,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -253,10 +241,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -305,7 +289,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -328,10 +312,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -375,7 +355,7 @@ This endpoint does not need any parameter. ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -398,10 +378,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -448,7 +424,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -471,10 +447,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -522,7 +494,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -545,10 +517,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -598,7 +566,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -621,10 +589,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -675,7 +639,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/docs/TranscriptionsApi.md b/docs/TranscriptionsApi.md index ea2a4beb..2503d94a 100644 --- a/docs/TranscriptionsApi.md +++ b/docs/TranscriptionsApi.md @@ -24,10 +24,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -77,7 +73,7 @@ nil (empty response body) ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -100,10 +96,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -154,7 +146,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers @@ -177,10 +169,6 @@ require 'time' require 'bandwidth-sdk' # setup authorization Bandwidth.configure do |config| - # Configure HTTP basic authorization: Basic - config.username = 'YOUR USERNAME' - config.password = 'YOUR PASSWORD' - # Configure OAuth2 access token for authorization: OAuth2 config.access_token = 'YOUR ACCESS TOKEN' end @@ -229,7 +217,7 @@ end ### Authorization -[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2) +[OAuth2](../README.md#OAuth2) ### HTTP request headers diff --git a/lib/bandwidth-sdk/api/calls_api.rb b/lib/bandwidth-sdk/api/calls_api.rb index b41a7c39..9a8ec91c 100644 --- a/lib/bandwidth-sdk/api/calls_api.rb +++ b/lib/bandwidth-sdk/api/calls_api.rb @@ -74,7 +74,7 @@ def create_call_with_http_info(account_id, create_call, opts = {}) return_type = opts[:debug_return_type] || 'CreateCallResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"CallsApi.create_call", @@ -143,7 +143,7 @@ def get_call_state_with_http_info(account_id, call_id, opts = {}) return_type = opts[:debug_return_type] || 'CallState' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"CallsApi.get_call_state", @@ -235,7 +235,7 @@ def list_calls_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"CallsApi.list_calls", @@ -315,7 +315,7 @@ def update_call_with_http_info(account_id, call_id, update_call, opts = {}) return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"CallsApi.update_call", @@ -395,7 +395,7 @@ def update_call_bxml_with_http_info(account_id, call_id, body, opts = {}) return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"CallsApi.update_call_bxml", diff --git a/lib/bandwidth-sdk/api/conferences_api.rb b/lib/bandwidth-sdk/api/conferences_api.rb index 8023df17..28d1e8ba 100644 --- a/lib/bandwidth-sdk/api/conferences_api.rb +++ b/lib/bandwidth-sdk/api/conferences_api.rb @@ -75,7 +75,7 @@ def download_conference_recording_with_http_info(account_id, conference_id, reco return_type = opts[:debug_return_type] || 'File' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.download_conference_recording", @@ -144,7 +144,7 @@ def get_conference_with_http_info(account_id, conference_id, opts = {}) return_type = opts[:debug_return_type] || 'Conference' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.get_conference", @@ -219,7 +219,7 @@ def get_conference_member_with_http_info(account_id, conference_id, member_id, o return_type = opts[:debug_return_type] || 'ConferenceMember' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.get_conference_member", @@ -294,7 +294,7 @@ def get_conference_recording_with_http_info(account_id, conference_id, recording return_type = opts[:debug_return_type] || 'ConferenceRecordingMetadata' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.get_conference_recording", @@ -363,7 +363,7 @@ def list_conference_recordings_with_http_info(account_id, conference_id, opts = return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.list_conference_recordings", @@ -449,7 +449,7 @@ def list_conferences_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.list_conferences", @@ -529,7 +529,7 @@ def update_conference_with_http_info(account_id, conference_id, update_conferenc return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.update_conference", @@ -609,7 +609,7 @@ def update_conference_bxml_with_http_info(account_id, conference_id, body, opts return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.update_conference_bxml", @@ -695,7 +695,7 @@ def update_conference_member_with_http_info(account_id, conference_id, member_id return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"ConferencesApi.update_conference_member", diff --git a/lib/bandwidth-sdk/api/endpoints_api.rb b/lib/bandwidth-sdk/api/endpoints_api.rb index 7b5759c1..68265ac0 100644 --- a/lib/bandwidth-sdk/api/endpoints_api.rb +++ b/lib/bandwidth-sdk/api/endpoints_api.rb @@ -74,7 +74,7 @@ def create_endpoint_with_http_info(account_id, body, opts = {}) return_type = opts[:debug_return_type] || 'CreateEndpointResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"EndpointsApi.create_endpoint", @@ -143,7 +143,7 @@ def delete_endpoint_with_http_info(account_id, endpoint_id, opts = {}) return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"EndpointsApi.delete_endpoint", @@ -212,7 +212,7 @@ def get_endpoint_with_http_info(account_id, endpoint_id, opts = {}) return_type = opts[:debug_return_type] || 'EndpointResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"EndpointsApi.get_endpoint", @@ -295,7 +295,7 @@ def list_endpoints_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'ListEndpointsResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"EndpointsApi.list_endpoints", @@ -375,7 +375,7 @@ def update_endpoint_bxml_with_http_info(account_id, endpoint_id, body, opts = {} return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"EndpointsApi.update_endpoint_bxml", diff --git a/lib/bandwidth-sdk/api/media_api.rb b/lib/bandwidth-sdk/api/media_api.rb index cbe04871..00b7dbea 100644 --- a/lib/bandwidth-sdk/api/media_api.rb +++ b/lib/bandwidth-sdk/api/media_api.rb @@ -69,7 +69,7 @@ def delete_media_with_http_info(account_id, media_id, opts = {}) return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MediaApi.delete_media", @@ -138,7 +138,7 @@ def get_media_with_http_info(account_id, media_id, opts = {}) return_type = opts[:debug_return_type] || 'File' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MediaApi.get_media", @@ -204,7 +204,7 @@ def list_media_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MediaApi.list_media", @@ -290,7 +290,7 @@ def upload_media_with_http_info(account_id, media_id, body, opts = {}) return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MediaApi.upload_media", diff --git a/lib/bandwidth-sdk/api/messages_api.rb b/lib/bandwidth-sdk/api/messages_api.rb index eacc0e94..7a778493 100644 --- a/lib/bandwidth-sdk/api/messages_api.rb +++ b/lib/bandwidth-sdk/api/messages_api.rb @@ -74,7 +74,7 @@ def create_message_with_http_info(account_id, message_request, opts = {}) return_type = opts[:debug_return_type] || 'Message' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MessagesApi.create_message", @@ -218,7 +218,7 @@ def list_messages_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'MessagesList' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MessagesApi.list_messages", diff --git a/lib/bandwidth-sdk/api/mfa_api.rb b/lib/bandwidth-sdk/api/mfa_api.rb index bcd0eebd..1c6f1699 100644 --- a/lib/bandwidth-sdk/api/mfa_api.rb +++ b/lib/bandwidth-sdk/api/mfa_api.rb @@ -74,7 +74,7 @@ def generate_messaging_code_with_http_info(account_id, code_request, opts = {}) return_type = opts[:debug_return_type] || 'MessagingCodeResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MFAApi.generate_messaging_code", @@ -148,7 +148,7 @@ def generate_voice_code_with_http_info(account_id, code_request, opts = {}) return_type = opts[:debug_return_type] || 'VoiceCodeResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MFAApi.generate_voice_code", @@ -222,7 +222,7 @@ def verify_code_with_http_info(account_id, verify_code_request, opts = {}) return_type = opts[:debug_return_type] || 'VerifyCodeResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MFAApi.verify_code", diff --git a/lib/bandwidth-sdk/api/multi_channel_api.rb b/lib/bandwidth-sdk/api/multi_channel_api.rb index cfcdc351..da88b7ab 100644 --- a/lib/bandwidth-sdk/api/multi_channel_api.rb +++ b/lib/bandwidth-sdk/api/multi_channel_api.rb @@ -74,7 +74,7 @@ def create_multi_channel_message_with_http_info(account_id, multi_channel_messag return_type = opts[:debug_return_type] || 'CreateMultiChannelMessageResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"MultiChannelApi.create_multi_channel_message", diff --git a/lib/bandwidth-sdk/api/phone_number_lookup_api.rb b/lib/bandwidth-sdk/api/phone_number_lookup_api.rb index 52fb1cbd..41213033 100644 --- a/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +++ b/lib/bandwidth-sdk/api/phone_number_lookup_api.rb @@ -74,7 +74,7 @@ def create_async_bulk_lookup_with_http_info(account_id, async_lookup_request, op return_type = opts[:debug_return_type] || 'CreateAsyncBulkLookupResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"PhoneNumberLookupApi.create_async_bulk_lookup", @@ -148,7 +148,7 @@ def create_sync_lookup_with_http_info(account_id, sync_lookup_request, opts = {} return_type = opts[:debug_return_type] || 'CreateSyncLookupResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"PhoneNumberLookupApi.create_sync_lookup", @@ -217,7 +217,7 @@ def get_async_bulk_lookup_with_http_info(account_id, request_id, opts = {}) return_type = opts[:debug_return_type] || 'GetAsyncBulkLookupResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"PhoneNumberLookupApi.get_async_bulk_lookup", diff --git a/lib/bandwidth-sdk/api/recordings_api.rb b/lib/bandwidth-sdk/api/recordings_api.rb index 73331162..55b72821 100644 --- a/lib/bandwidth-sdk/api/recordings_api.rb +++ b/lib/bandwidth-sdk/api/recordings_api.rb @@ -75,7 +75,7 @@ def delete_recording_with_http_info(account_id, call_id, recording_id, opts = {} return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.delete_recording", @@ -150,7 +150,7 @@ def delete_recording_media_with_http_info(account_id, call_id, recording_id, opt return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.delete_recording_media", @@ -225,7 +225,7 @@ def delete_recording_transcription_with_http_info(account_id, call_id, recording return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.delete_recording_transcription", @@ -300,7 +300,7 @@ def download_call_recording_with_http_info(account_id, call_id, recording_id, op return_type = opts[:debug_return_type] || 'File' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.download_call_recording", @@ -375,7 +375,7 @@ def get_call_recording_with_http_info(account_id, call_id, recording_id, opts = return_type = opts[:debug_return_type] || 'CallRecordingMetadata' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.get_call_recording", @@ -450,7 +450,7 @@ def get_recording_transcription_with_http_info(account_id, call_id, recording_id return_type = opts[:debug_return_type] || 'RecordingTranscriptions' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.get_recording_transcription", @@ -525,7 +525,7 @@ def list_account_call_recordings_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.list_account_call_recordings", @@ -594,7 +594,7 @@ def list_call_recordings_with_http_info(account_id, call_id, opts = {}) return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.list_call_recordings", @@ -680,7 +680,7 @@ def transcribe_call_recording_with_http_info(account_id, call_id, recording_id, return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.transcribe_call_recording", @@ -760,7 +760,7 @@ def update_call_recording_state_with_http_info(account_id, call_id, update_call_ return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"RecordingsApi.update_call_recording_state", diff --git a/lib/bandwidth-sdk/api/statistics_api.rb b/lib/bandwidth-sdk/api/statistics_api.rb index f841444a..79741c49 100644 --- a/lib/bandwidth-sdk/api/statistics_api.rb +++ b/lib/bandwidth-sdk/api/statistics_api.rb @@ -63,7 +63,7 @@ def get_statistics_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'AccountStatistics' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"StatisticsApi.get_statistics", diff --git a/lib/bandwidth-sdk/api/toll_free_verification_api.rb b/lib/bandwidth-sdk/api/toll_free_verification_api.rb index b62c4929..d00d3461 100644 --- a/lib/bandwidth-sdk/api/toll_free_verification_api.rb +++ b/lib/bandwidth-sdk/api/toll_free_verification_api.rb @@ -74,7 +74,7 @@ def create_webhook_subscription_with_http_info(account_id, webhook_subscription_ return_type = opts[:debug_return_type] || 'WebhookSubscription' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.create_webhook_subscription", @@ -156,7 +156,7 @@ def delete_verification_request_with_http_info(account_id, phone_number, opts = return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.delete_verification_request", @@ -225,7 +225,7 @@ def delete_webhook_subscription_with_http_info(account_id, id, opts = {}) return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.delete_webhook_subscription", @@ -307,7 +307,7 @@ def get_toll_free_verification_status_with_http_info(account_id, phone_number, o return_type = opts[:debug_return_type] || 'TfvStatus' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.get_toll_free_verification_status", @@ -364,7 +364,7 @@ def list_toll_free_use_cases_with_http_info(opts = {}) return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.list_toll_free_use_cases", @@ -427,7 +427,7 @@ def list_webhook_subscriptions_with_http_info(account_id, opts = {}) return_type = opts[:debug_return_type] || 'WebhookSubscriptionsListBody' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.list_webhook_subscriptions", @@ -501,7 +501,7 @@ def request_toll_free_verification_with_http_info(account_id, verification_reque return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.request_toll_free_verification", @@ -594,7 +594,7 @@ def update_toll_free_verification_request_with_http_info(account_id, phone_numbe return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.update_toll_free_verification_request", @@ -674,7 +674,7 @@ def update_webhook_subscription_with_http_info(account_id, id, webhook_subscript return_type = opts[:debug_return_type] || 'WebhookSubscription' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TollFreeVerificationApi.update_webhook_subscription", diff --git a/lib/bandwidth-sdk/api/transcriptions_api.rb b/lib/bandwidth-sdk/api/transcriptions_api.rb index 99c79076..b08e01a5 100644 --- a/lib/bandwidth-sdk/api/transcriptions_api.rb +++ b/lib/bandwidth-sdk/api/transcriptions_api.rb @@ -75,7 +75,7 @@ def delete_real_time_transcription_with_http_info(account_id, call_id, transcrip return_type = opts[:debug_return_type] # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TranscriptionsApi.delete_real_time_transcription", @@ -150,7 +150,7 @@ def get_real_time_transcription_with_http_info(account_id, call_id, transcriptio return_type = opts[:debug_return_type] || 'CallTranscriptionResponse' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TranscriptionsApi.get_real_time_transcription", @@ -219,7 +219,7 @@ def list_real_time_transcriptions_with_http_info(account_id, call_id, opts = {}) return_type = opts[:debug_return_type] || 'Array' # auth_names - auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2'] + auth_names = opts[:debug_auth_names] || ['OAuth2'] new_options = opts.merge( :operation => :"TranscriptionsApi.list_real_time_transcriptions", diff --git a/lib/bandwidth-sdk/configuration.rb b/lib/bandwidth-sdk/configuration.rb index 303f043d..a34945f9 100644 --- a/lib/bandwidth-sdk/configuration.rb +++ b/lib/bandwidth-sdk/configuration.rb @@ -296,13 +296,6 @@ def oauth_bearer_token # Returns Auth Settings hash for api client. def auth_settings { - 'Basic' => - { - type: 'basic', - in: 'header', - key: 'Authorization', - value: basic_auth_token - }, 'OAuth2' => { type: 'oauth2', From c68ec9ae463e5b23fc5926a83c3eb85c40848a74 Mon Sep 17 00:00:00 2001 From: ckoegel Date: Wed, 4 Nov 2026 15:13:05 -0500 Subject: [PATCH 2/2] regenerate spec --- bandwidth.yml | 4487 ++++++++++++++++++++++++------------------------- 1 file changed, 2238 insertions(+), 2249 deletions(-) diff --git a/bandwidth.yml b/bandwidth.yml index 526f187d..bffc6469 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -31,27 +31,27 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/continuationToken" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/continuationToken' responses: - "200": - $ref: "#/components/responses/listMediaResponse" - "400": - $ref: "#/components/responses/messagingBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "406": - $ref: "#/components/responses/messagingNotAcceptableError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/messagingTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '200': + $ref: '#/components/responses/listMediaResponse' + '400': + $ref: '#/components/responses/messagingBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '406': + $ref: '#/components/responses/messagingNotAcceptableError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/messagingTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' servers: &ref_0 - url: https://messaging.bandwidth.com/api/v2 description: Production @@ -63,27 +63,27 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/mediaId" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/mediaId' responses: - "200": - $ref: "#/components/responses/getMediaResponse" - "400": - $ref: "#/components/responses/messagingBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "406": - $ref: "#/components/responses/messagingNotAcceptableError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/messagingTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '200': + $ref: '#/components/responses/getMediaResponse' + '400': + $ref: '#/components/responses/messagingBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '406': + $ref: '#/components/responses/messagingNotAcceptableError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/messagingTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' put: summary: Upload Media description: >- @@ -100,31 +100,31 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/mediaId" - - $ref: "#/components/parameters/contentType" - - $ref: "#/components/parameters/cacheControl" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/mediaId' + - $ref: '#/components/parameters/contentType' + - $ref: '#/components/parameters/cacheControl' requestBody: - $ref: "#/components/requestBodies/uploadMediaRequest" + $ref: '#/components/requestBodies/uploadMediaRequest' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/messagingBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "406": - $ref: "#/components/responses/messagingNotAcceptableError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/messagingTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '400': + $ref: '#/components/responses/messagingBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '406': + $ref: '#/components/responses/messagingNotAcceptableError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/messagingTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' delete: summary: Delete Media description: |- @@ -137,27 +137,27 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/mediaId" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/mediaId' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/messagingBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "406": - $ref: "#/components/responses/messagingNotAcceptableError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/messagingTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '400': + $ref: '#/components/responses/messagingBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '406': + $ref: '#/components/responses/messagingNotAcceptableError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/messagingTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' servers: *ref_0 /users/{accountId}/messages: get: @@ -173,53 +173,53 @@ paths: tags: - Messages parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/messageId" - - $ref: "#/components/parameters/sourceTn" - - $ref: "#/components/parameters/destinationTn" - - $ref: "#/components/parameters/messageStatus" - - $ref: "#/components/parameters/messageDirection" - - $ref: "#/components/parameters/carrierName" - - $ref: "#/components/parameters/messageType" - - $ref: "#/components/parameters/errorCode" - - $ref: "#/components/parameters/fromDateTime" - - $ref: "#/components/parameters/toDateTime" - - $ref: "#/components/parameters/campaignId" - - $ref: "#/components/parameters/fromBwLatency" - - $ref: "#/components/parameters/bwQueued" - - $ref: "#/components/parameters/product" - - $ref: "#/components/parameters/location" - - $ref: "#/components/parameters/carrierQueued" - - $ref: "#/components/parameters/fromCarrierLatency" - - $ref: "#/components/parameters/callingNumberCountryA3" - - $ref: "#/components/parameters/calledNumberCountryA3" - - $ref: "#/components/parameters/fromSegmentCount" - - $ref: "#/components/parameters/toSegmentCount" - - $ref: "#/components/parameters/fromMessageSize" - - $ref: "#/components/parameters/toMessageSize" - - $ref: "#/components/parameters/sort" - - $ref: "#/components/parameters/pageToken" - - $ref: "#/components/parameters/limit" - - $ref: "#/components/parameters/limitTotalCount" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/messageId' + - $ref: '#/components/parameters/sourceTn' + - $ref: '#/components/parameters/destinationTn' + - $ref: '#/components/parameters/messageStatus' + - $ref: '#/components/parameters/messageDirection' + - $ref: '#/components/parameters/carrierName' + - $ref: '#/components/parameters/messageType' + - $ref: '#/components/parameters/errorCode' + - $ref: '#/components/parameters/fromDateTime' + - $ref: '#/components/parameters/toDateTime' + - $ref: '#/components/parameters/campaignId' + - $ref: '#/components/parameters/fromBwLatency' + - $ref: '#/components/parameters/bwQueued' + - $ref: '#/components/parameters/product' + - $ref: '#/components/parameters/location' + - $ref: '#/components/parameters/carrierQueued' + - $ref: '#/components/parameters/fromCarrierLatency' + - $ref: '#/components/parameters/callingNumberCountryA3' + - $ref: '#/components/parameters/calledNumberCountryA3' + - $ref: '#/components/parameters/fromSegmentCount' + - $ref: '#/components/parameters/toSegmentCount' + - $ref: '#/components/parameters/fromMessageSize' + - $ref: '#/components/parameters/toMessageSize' + - $ref: '#/components/parameters/sort' + - $ref: '#/components/parameters/pageToken' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/limitTotalCount' responses: - "200": - $ref: "#/components/responses/listMessagesResponse" - "400": - $ref: "#/components/responses/messagingBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "405": - $ref: "#/components/responses/messagingMethodNotAllowedError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/listMessagesTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '200': + $ref: '#/components/responses/listMessagesResponse' + '400': + $ref: '#/components/responses/messagingBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '405': + $ref: '#/components/responses/messagingMethodNotAllowedError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/listMessagesTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' post: summary: Create Message description: >- @@ -229,33 +229,33 @@ paths: tags: - Messages parameters: - - $ref: "#/components/parameters/accountId" + - $ref: '#/components/parameters/accountId' requestBody: - $ref: "#/components/requestBodies/createMessageRequest" + $ref: '#/components/requestBodies/createMessageRequest' responses: - "202": - $ref: "#/components/responses/createMessageResponse" - "400": - $ref: "#/components/responses/createMessageBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "405": - $ref: "#/components/responses/messagingMethodNotAllowedError" - "406": - $ref: "#/components/responses/messagingNotAcceptableError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/messagingTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '202': + $ref: '#/components/responses/createMessageResponse' + '400': + $ref: '#/components/responses/createMessageBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '405': + $ref: '#/components/responses/messagingMethodNotAllowedError' + '406': + $ref: '#/components/responses/messagingNotAcceptableError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/messagingTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' callbacks: statusCallback: - $ref: "#/components/callbacks/statusCallback" + $ref: '#/components/callbacks/statusCallback' servers: *ref_0 /users/{accountId}/messages/multiChannel: post: @@ -263,38 +263,38 @@ paths: description: Endpoint for sending Multi-Channel messages. operationId: createMultiChannelMessage parameters: - - $ref: "#/components/parameters/accountId" + - $ref: '#/components/parameters/accountId' tags: - Multi-Channel requestBody: - $ref: "#/components/requestBodies/createMultiChannelMessageRequest" + $ref: '#/components/requestBodies/createMultiChannelMessageRequest' responses: - "202": - $ref: "#/components/responses/createMultiChannelMessageResponse" - "400": - $ref: "#/components/responses/multiChannelBadRequestError" - "401": - $ref: "#/components/responses/multiChannelUnauthorizedError" - "403": - $ref: "#/components/responses/multiChannelForbiddenError" - "404": - $ref: "#/components/responses/multiChannelNotFoundError" - "405": - $ref: "#/components/responses/multiChannelMethodNotAllowedError" - "406": - $ref: "#/components/responses/multiChannelNotAcceptableError" - "415": - $ref: "#/components/responses/multiChannelInvalidMediaTypeError" - "429": - $ref: "#/components/responses/multiChannelTooManyRequestsError" - "500": - $ref: "#/components/responses/multiChannelInternalServerError" + '202': + $ref: '#/components/responses/createMultiChannelMessageResponse' + '400': + $ref: '#/components/responses/multiChannelBadRequestError' + '401': + $ref: '#/components/responses/multiChannelUnauthorizedError' + '403': + $ref: '#/components/responses/multiChannelForbiddenError' + '404': + $ref: '#/components/responses/multiChannelNotFoundError' + '405': + $ref: '#/components/responses/multiChannelMethodNotAllowedError' + '406': + $ref: '#/components/responses/multiChannelNotAcceptableError' + '415': + $ref: '#/components/responses/multiChannelInvalidMediaTypeError' + '429': + $ref: '#/components/responses/multiChannelTooManyRequestsError' + '500': + $ref: '#/components/responses/multiChannelInternalServerError' callbacks: statusCallback: - $ref: "#/components/callbacks/statusCallback" + $ref: '#/components/callbacks/statusCallback' x-badges: - name: Beta - color: "#076EA8" + color: '#076EA8' servers: *ref_0 /accounts/{accountId}/calls: post: @@ -315,28 +315,28 @@ paths: approximately in order, but exact ordering is not guaranteed. operationId: createCall parameters: - - $ref: "#/components/parameters/accountId1" + - $ref: '#/components/parameters/accountId1' requestBody: - $ref: "#/components/requestBodies/createCallRequest" + $ref: '#/components/requestBodies/createCallRequest' responses: - "201": - $ref: "#/components/responses/createCallResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '201': + $ref: '#/components/responses/createCallResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' get: tags: - Calls @@ -356,33 +356,33 @@ paths: days, you will get an empty array [] in response. operationId: listCalls parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/to" - - $ref: "#/components/parameters/from" - - $ref: "#/components/parameters/minStartTimeCalls" - - $ref: "#/components/parameters/maxStartTimeCalls" - - $ref: "#/components/parameters/disconnectCause" - - $ref: "#/components/parameters/pageSizeCalls" - - $ref: "#/components/parameters/pageToken1" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/to' + - $ref: '#/components/parameters/from' + - $ref: '#/components/parameters/minStartTimeCalls' + - $ref: '#/components/parameters/maxStartTimeCalls' + - $ref: '#/components/parameters/disconnectCause' + - $ref: '#/components/parameters/pageSizeCalls' + - $ref: '#/components/parameters/pageToken1' responses: - "200": - $ref: "#/components/responses/listCallsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listCallsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: &ref_1 - url: https://voice.bandwidth.com/api/v2 description: Production @@ -402,27 +402,27 @@ paths: 7 days, you will get an HTTP 404 response. operationId: getCallState parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' responses: - "200": - $ref: "#/components/responses/getCallStateResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getCallStateResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' post: tags: - Calls @@ -432,31 +432,31 @@ paths: BXML document. operationId: updateCall parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' requestBody: - $ref: "#/components/requestBodies/updateCallRequest" + $ref: '#/components/requestBodies/updateCallRequest' responses: - "200": - $ref: "#/components/responses/updateCallResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "409": - $ref: "#/components/responses/voiceConflictError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/updateCallResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '409': + $ref: '#/components/responses/voiceConflictError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/bxml: put: @@ -466,31 +466,31 @@ paths: description: Interrupts and replaces an active call's BXML document. operationId: updateCallBxml parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' requestBody: - $ref: "#/components/requestBodies/updateCallBxmlRequest" + $ref: '#/components/requestBodies/updateCallBxmlRequest' responses: - "204": + '204': description: Call BXML was successfully replaced. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "409": - $ref: "#/components/responses/voiceConflictError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '409': + $ref: '#/components/responses/voiceConflictError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences: get: @@ -508,31 +508,31 @@ paths: of conference records. operationId: listConferences parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/name" - - $ref: "#/components/parameters/minCreatedTime" - - $ref: "#/components/parameters/maxCreatedTime" - - $ref: "#/components/parameters/pageSize" - - $ref: "#/components/parameters/pageToken1" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/minCreatedTime' + - $ref: '#/components/parameters/maxCreatedTime' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/pageToken1' responses: - "200": - $ref: "#/components/responses/listConferencesResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listConferencesResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}: get: @@ -542,27 +542,27 @@ paths: description: Returns information about the specified conference. operationId: getConference parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' responses: - "200": - $ref: "#/components/responses/getConferenceResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getConferenceResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' post: tags: - Conferences @@ -570,29 +570,29 @@ paths: description: Update the conference state. operationId: updateConference parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' requestBody: - $ref: "#/components/requestBodies/updateConferenceRequest" + $ref: '#/components/requestBodies/updateConferenceRequest' responses: - "204": + '204': description: Conference was successfully modified. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/bxml: put: @@ -602,29 +602,29 @@ paths: description: Update the conference BXML document. operationId: updateConferenceBxml parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' requestBody: - $ref: "#/components/requestBodies/updateConferenceBxmlRequest" + $ref: '#/components/requestBodies/updateConferenceBxmlRequest' responses: - "204": + '204': description: Conference successfully modified. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/members/{memberId}: get: @@ -634,28 +634,28 @@ paths: description: Returns information about the specified conference member. operationId: getConferenceMember parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/memberId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/memberId' responses: - "200": - $ref: "#/components/responses/getConferenceMemberResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getConferenceMemberResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' put: tags: - Conferences @@ -663,30 +663,30 @@ paths: description: Updates settings for a particular conference member. operationId: updateConferenceMember parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/memberId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/memberId' requestBody: - $ref: "#/components/requestBodies/updateConferenceMemberRequest" + $ref: '#/components/requestBodies/updateConferenceMemberRequest' responses: - "204": + '204': description: Conference member was successfully modified. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/recordings: get: @@ -698,27 +698,27 @@ paths: took place during the specified conference. operationId: listConferenceRecordings parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' responses: - "200": - $ref: "#/components/responses/listConferenceRecordingsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listConferenceRecordingsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}: get: @@ -728,28 +728,28 @@ paths: description: Returns metadata for the specified recording. operationId: getConferenceRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/getConferenceRecordingResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getConferenceRecordingResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media: get: @@ -759,28 +759,28 @@ paths: description: Downloads the specified recording file. operationId: downloadConferenceRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/downloadRecordingMediaResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/downloadRecordingMediaResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/recordings: get: @@ -799,30 +799,30 @@ paths: empty if no recordings match the specified criteria. operationId: listAccountCallRecordings parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/to" - - $ref: "#/components/parameters/from" - - $ref: "#/components/parameters/minStartTime" - - $ref: "#/components/parameters/maxStartTime" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/to' + - $ref: '#/components/parameters/from' + - $ref: '#/components/parameters/minStartTime' + - $ref: '#/components/parameters/maxStartTime' responses: - "200": - $ref: "#/components/responses/listCallRecordingsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listCallRecordingsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recording: put: @@ -832,29 +832,29 @@ paths: description: Pause or resume a recording on an active phone call. operationId: updateCallRecordingState parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' requestBody: - $ref: "#/components/requestBodies/updateCallRecordingRequest" + $ref: '#/components/requestBodies/updateCallRecordingRequest' responses: - "200": - $ref: "#/components/responses/updateRecordingResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/updateRecordingResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings: get: @@ -866,27 +866,27 @@ paths: that took place during the specified call. operationId: listCallRecordings parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' responses: - "200": - $ref: "#/components/responses/listCallRecordingsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listCallRecordingsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings/{recordingId}: get: @@ -896,28 +896,28 @@ paths: description: Returns metadata for the specified recording. operationId: getCallRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/getCallRecordingResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getCallRecordingResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Recordings @@ -933,28 +933,28 @@ paths: irreversible, can take an additional 24 to 48 hours. operationId: deleteRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "204": + '204': description: Recording was deleted. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media: get: @@ -964,28 +964,28 @@ paths: description: Downloads the specified recording. operationId: downloadCallRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/downloadRecordingMediaResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/downloadRecordingMediaResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Recordings @@ -993,28 +993,28 @@ paths: description: Deletes the specified recording's media. operationId: deleteRecordingMedia parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "204": + '204': description: The recording media was successfully deleted. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription: get: @@ -1036,28 +1036,28 @@ paths: item. operationId: getRecordingTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/getRecordingTranscriptionResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getRecordingTranscriptionResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' post: tags: - Recordings @@ -1071,30 +1071,30 @@ paths: less than 4 hours. operationId: transcribeCallRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' requestBody: - $ref: "#/components/requestBodies/transcribeRecordingRequest" + $ref: '#/components/requestBodies/transcribeRecordingRequest' responses: - "204": + '204': description: Transcription was successfully requested. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Recordings @@ -1109,28 +1109,28 @@ paths: can take an additional 24 to 48 hours. operationId: deleteRecordingTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "204": + '204': description: The transcription was successfully deleted. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/statistics: get: @@ -1140,26 +1140,26 @@ paths: description: Returns details about the current state of the account. operationId: getStatistics parameters: - - $ref: "#/components/parameters/accountId1" + - $ref: '#/components/parameters/accountId1' responses: - "200": - $ref: "#/components/responses/getStatisticsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getStatisticsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/transcriptions: get: @@ -1171,27 +1171,27 @@ paths: [startTranscription](/docs/voice/bxml/startTranscription). operationId: listRealTimeTranscriptions parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' responses: - "200": - $ref: "#/components/responses/listTranscriptionsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listTranscriptionsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}: get: @@ -1203,28 +1203,28 @@ paths: [startTranscription](/docs/voice/bxml/startTranscription). operationId: getRealTimeTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/transcriptionId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/transcriptionId' responses: - "200": - $ref: "#/components/responses/getCallTranscriptionResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getCallTranscriptionResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Transcriptions @@ -1240,28 +1240,28 @@ paths: can take an additional 24 to 48 hours. operationId: deleteRealTimeTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/transcriptionId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/transcriptionId' responses: - "200": - $ref: "#/components/responses/deleteCallTranscriptionResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/deleteCallTranscriptionResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/code/voice: post: @@ -1271,20 +1271,20 @@ paths: description: Send an MFA Code via a phone call. operationId: generateVoiceCode parameters: - - $ref: "#/components/parameters/accountId2" + - $ref: '#/components/parameters/accountId2' requestBody: - $ref: "#/components/requestBodies/codeRequest" + $ref: '#/components/requestBodies/codeRequest' responses: - "200": - $ref: "#/components/responses/voiceCodeResponse" - "400": - $ref: "#/components/responses/mfaBadRequestError" - "401": - $ref: "#/components/responses/mfaUnauthorizedError" - "403": - $ref: "#/components/responses/mfaForbiddenError" - "500": - $ref: "#/components/responses/mfaInternalServerError" + '200': + $ref: '#/components/responses/voiceCodeResponse' + '400': + $ref: '#/components/responses/mfaBadRequestError' + '401': + $ref: '#/components/responses/mfaUnauthorizedError' + '403': + $ref: '#/components/responses/mfaForbiddenError' + '500': + $ref: '#/components/responses/mfaInternalServerError' servers: &ref_2 - url: https://mfa.bandwidth.com/api/v1 description: Production @@ -1296,20 +1296,20 @@ paths: description: Send an MFA code via text message (SMS). operationId: generateMessagingCode parameters: - - $ref: "#/components/parameters/accountId2" + - $ref: '#/components/parameters/accountId2' requestBody: - $ref: "#/components/requestBodies/codeRequest" + $ref: '#/components/requestBodies/codeRequest' responses: - "200": - $ref: "#/components/responses/messagingCodeResponse" - "400": - $ref: "#/components/responses/mfaBadRequestError" - "401": - $ref: "#/components/responses/mfaUnauthorizedError" - "403": - $ref: "#/components/responses/mfaForbiddenError" - "500": - $ref: "#/components/responses/mfaInternalServerError" + '200': + $ref: '#/components/responses/messagingCodeResponse' + '400': + $ref: '#/components/responses/mfaBadRequestError' + '401': + $ref: '#/components/responses/mfaUnauthorizedError' + '403': + $ref: '#/components/responses/mfaForbiddenError' + '500': + $ref: '#/components/responses/mfaInternalServerError' servers: *ref_2 /accounts/{accountId}/code/verify: post: @@ -1319,22 +1319,22 @@ paths: description: Verify a previously sent MFA code. operationId: verifyCode parameters: - - $ref: "#/components/parameters/accountId2" + - $ref: '#/components/parameters/accountId2' requestBody: - $ref: "#/components/requestBodies/codeVerify" + $ref: '#/components/requestBodies/codeVerify' responses: - "200": - $ref: "#/components/responses/verifyCodeResponse" - "400": - $ref: "#/components/responses/mfaBadRequestError" - "401": - $ref: "#/components/responses/mfaUnauthorizedError" - "403": - $ref: "#/components/responses/mfaForbiddenError" - "429": - $ref: "#/components/responses/mfaTooManyRequestsError" - "500": - $ref: "#/components/responses/mfaInternalServerError" + '200': + $ref: '#/components/responses/verifyCodeResponse' + '400': + $ref: '#/components/responses/mfaBadRequestError' + '401': + $ref: '#/components/responses/mfaUnauthorizedError' + '403': + $ref: '#/components/responses/mfaForbiddenError' + '429': + $ref: '#/components/responses/mfaTooManyRequestsError' + '500': + $ref: '#/components/responses/mfaInternalServerError' servers: *ref_2 /accounts/{accountId}/phoneNumberLookup: post: @@ -1346,14 +1346,14 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: "#/components/parameters/accountId3" + - $ref: '#/components/parameters/accountId3' requestBody: - $ref: "#/components/requestBodies/createSyncLookupRequest" + $ref: '#/components/requestBodies/createSyncLookupRequest' responses: - "200": - $ref: "#/components/responses/createSyncLookupResponse" + '200': + $ref: '#/components/responses/createSyncLookupResponse' default: - $ref: "#/components/responses/tnLookupDefaultResponse" + $ref: '#/components/responses/tnLookupDefaultResponse' servers: &ref_3 - url: https://api.bandwidth.com/v2 description: Production @@ -1369,14 +1369,14 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: "#/components/parameters/accountId3" + - $ref: '#/components/parameters/accountId3' requestBody: - $ref: "#/components/requestBodies/createAsyncBulkLookupRequest" + $ref: '#/components/requestBodies/createAsyncBulkLookupRequest' responses: - "202": - $ref: "#/components/responses/createAsyncBulkLookupResponse" + '202': + $ref: '#/components/responses/createAsyncBulkLookupResponse' default: - $ref: "#/components/responses/tnLookupDefaultResponse" + $ref: '#/components/responses/tnLookupDefaultResponse' servers: *ref_3 /accounts/{accountId}/phoneNumberLookup/bulk/{requestId}: get: @@ -1389,13 +1389,13 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: "#/components/parameters/accountId3" - - $ref: "#/components/parameters/requestId" + - $ref: '#/components/parameters/accountId3' + - $ref: '#/components/parameters/requestId' responses: - "200": - $ref: "#/components/responses/getAsyncBulkLookupResponse" + '200': + $ref: '#/components/responses/getAsyncBulkLookupResponse' default: - $ref: "#/components/responses/tnLookupDefaultResponse" + $ref: '#/components/responses/tnLookupDefaultResponse' servers: *ref_3 /accounts/{accountId}/tollFreeVerification: post: @@ -1417,31 +1417,31 @@ paths: Today, these requests are accepted with a `202`. operationId: requestTollFreeVerification parameters: - - $ref: "#/components/parameters/accountId4" + - $ref: '#/components/parameters/accountId4' requestBody: - $ref: "#/components/requestBodies/requestTollFreeVerificationRequest" + $ref: '#/components/requestBodies/requestTollFreeVerificationRequest' responses: - "202": + '202': description: Accepted - "400": - $ref: "#/components/responses/tfvPostBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "409": - $ref: "#/components/responses/tfvConflictResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '400': + $ref: '#/components/responses/tfvPostBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '409': + $ref: '#/components/responses/tfvConflictResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' callbacks: tfVerificationStatus: - $ref: "#/components/callbacks/tfVerificationStatus" + $ref: '#/components/callbacks/tfVerificationStatus' servers: &ref_4 - url: https://api.bandwidth.com/api/v2 description: Production @@ -1458,27 +1458,27 @@ paths: available. operationId: getTollFreeVerificationStatus parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/tfPhoneNumberPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/tfPhoneNumberPathParam' responses: - "200": - $ref: "#/components/responses/getTollFreeVerificationStatusResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/getTollFreeVerificationStatusResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' put: tags: - Toll-Free Verification @@ -1499,34 +1499,34 @@ paths: Conflict`. operationId: updateTollFreeVerificationRequest parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/tfPhoneNumberPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/tfPhoneNumberPathParam' requestBody: - $ref: "#/components/requestBodies/updateTollFreeVerificationRequestRequest" + $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest' responses: - "202": - $ref: "#/components/responses/verifyPutResponse" - "400": - $ref: "#/components/responses/tfvPostBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "409": - $ref: "#/components/responses/tfvConflictResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '202': + $ref: '#/components/responses/verifyPutResponse' + '400': + $ref: '#/components/responses/tfvPostBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '409': + $ref: '#/components/responses/tfvConflictResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' callbacks: tfVerificationStatus: - $ref: "#/components/callbacks/tfVerificationStatus" + $ref: '#/components/callbacks/tfVerificationStatus' delete: description: >- Delete a toll-free verification submission for a toll-free number. @@ -1537,27 +1537,27 @@ paths: will then be deleted asynchronously. operationId: deleteVerificationRequest parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/tfPhoneNumberPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/tfPhoneNumberPathParam' responses: - "204": - $ref: "#/components/responses/noContentResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '204': + $ref: '#/components/responses/noContentResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' summary: Delete a Toll-Free Verification Submission tags: - Toll-Free Verification @@ -1576,24 +1576,24 @@ paths: object will be null). operationId: listWebhookSubscriptions parameters: - - $ref: "#/components/parameters/accountId4" + - $ref: '#/components/parameters/accountId4' responses: - "200": - $ref: "#/components/responses/listWebhookSubscriptionsResponse" - "400": - $ref: "#/components/responses/tfvPostBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/listWebhookSubscriptionsResponse' + '400': + $ref: '#/components/responses/tfvPostBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' post: tags: - Toll-Free Verification @@ -1609,28 +1609,28 @@ paths: modify or delete the subscription at a later time. operationId: createWebhookSubscription parameters: - - $ref: "#/components/parameters/accountId4" + - $ref: '#/components/parameters/accountId4' requestBody: - $ref: "#/components/requestBodies/webhookSubscriptionRequest" + $ref: '#/components/requestBodies/webhookSubscriptionRequest' responses: - "201": - $ref: "#/components/responses/createWebhookSubscriptionResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '201': + $ref: '#/components/responses/createWebhookSubscriptionResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' servers: *ref_4 /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}: delete: @@ -1640,27 +1640,27 @@ paths: description: Delete a webhook subscription by ID. operationId: deleteWebhookSubscription parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/webhookSubscriptionIdPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' responses: - "204": - $ref: "#/components/responses/noContentResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '204': + $ref: '#/components/responses/noContentResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' put: tags: - Toll-Free Verification @@ -1670,29 +1670,29 @@ paths: `basicAuthentication` can be updated). operationId: updateWebhookSubscription parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/webhookSubscriptionIdPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' requestBody: - $ref: "#/components/requestBodies/webhookSubscriptionRequest" + $ref: '#/components/requestBodies/webhookSubscriptionRequest' responses: - "200": - $ref: "#/components/responses/updateWebhookSubscriptionResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/updateWebhookSubscriptionResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' servers: *ref_4 /tollFreeVerification/useCases: get: @@ -1702,24 +1702,24 @@ paths: description: Lists valid toll-free use cases. operationId: listTollFreeUseCases responses: - "200": - $ref: "#/components/responses/listTollFreeUseCasesResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/listTollFreeUseCasesResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' servers: *ref_4 /accounts/{accountId}/endpoints: get: @@ -1729,30 +1729,30 @@ paths: description: Returns a list of endpoints associated with the specified account. operationId: listEndpoints parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointType" - - $ref: "#/components/parameters/endpointStatus" - - $ref: "#/components/parameters/afterCursor" - - $ref: "#/components/parameters/limit1" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointType' + - $ref: '#/components/parameters/endpointStatus' + - $ref: '#/components/parameters/afterCursor' + - $ref: '#/components/parameters/limit1' responses: - "200": - $ref: "#/components/responses/listEndpointsResponse" - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '200': + $ref: '#/components/responses/listEndpointsResponse' + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' post: tags: - Endpoints @@ -1760,31 +1760,31 @@ paths: description: Creates a new Endpoint for the specified account. operationId: createEndpoint parameters: - - $ref: "#/components/parameters/accountId5" + - $ref: '#/components/parameters/accountId5' requestBody: - $ref: "#/components/requestBodies/createEndpointRequest" + $ref: '#/components/requestBodies/createEndpointRequest' responses: - "201": - $ref: "#/components/responses/createEndpointResponse" - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '201': + $ref: '#/components/responses/createEndpointResponse' + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' callbacks: endpointEventCallback: - $ref: "#/components/callbacks/endpointEvent" + $ref: '#/components/callbacks/endpointEvent' servers: &ref_5 - url: https://api.bandwidth.com/v2 description: Production @@ -1796,27 +1796,27 @@ paths: description: Returns information about the specified endpoint. operationId: getEndpoint parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointId" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointId' responses: - "200": - $ref: "#/components/responses/getEndpointResponse" - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '200': + $ref: '#/components/responses/getEndpointResponse' + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' delete: tags: - Endpoints @@ -1826,27 +1826,27 @@ paths: media, the media stream will be terminated. operationId: deleteEndpoint parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointId" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointId' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' servers: *ref_5 /accounts/{accountId}/endpoints/{endpointId}/bxml: put: @@ -1856,29 +1856,29 @@ paths: description: Updates the BXML for the specified endpoint. operationId: updateEndpointBxml parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointId" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointId' requestBody: - $ref: "#/components/requestBodies/updateEndpointBxmlRequest" + $ref: '#/components/requestBodies/updateEndpointBxmlRequest' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' servers: *ref_5 components: schemas: @@ -1973,11 +1973,11 @@ components: has limitTotalCount set to true this value is limited to 10,000. example: 100 pageInfo: - $ref: "#/components/schemas/pageInfo" + $ref: '#/components/schemas/pageInfo' messages: type: array items: - $ref: "#/components/schemas/listMessageItem" + $ref: '#/components/schemas/listMessageItem' listMessageItem: title: listMessageItem type: object @@ -1989,23 +1989,23 @@ components: accountId: type: string description: The account id associated with this message. - example: "9900000" + example: '9900000' sourceTn: type: string description: The source phone number of the message. - example: "+15554443333" + example: '+15554443333' destinationTn: type: string description: The recipient phone number of the message. - example: "+15554442222" + example: '+15554442222' messageStatus: - $ref: "#/components/schemas/messageStatusEnum" + $ref: '#/components/schemas/messageStatusEnum' messageDirection: - $ref: "#/components/schemas/listMessageDirectionEnum" + $ref: '#/components/schemas/listMessageDirectionEnum' messageType: - $ref: "#/components/schemas/messageTypeEnum" + $ref: '#/components/schemas/messageTypeEnum' segmentCount: - $ref: "#/components/schemas/segmentCount" + $ref: '#/components/schemas/segmentCount' errorCode: type: integer description: The numeric error code of the message. @@ -2014,7 +2014,7 @@ components: type: string format: date-time description: The ISO 8601 datetime of the message. - example: "2020-04-07T14:03:07.000Z" + example: '2020-04-07T14:03:07.000Z' carrierName: type: string nullable: true @@ -2129,7 +2129,7 @@ components: fieldErrors: type: array items: - $ref: "#/components/schemas/fieldError" + $ref: '#/components/schemas/fieldError' required: - type - description @@ -2170,7 +2170,7 @@ components: expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. - example: "2021-02-01T11:29:18-05:00" + example: '2021-02-01T11:29:18-05:00' carrierName: type: string description: >- @@ -2192,18 +2192,18 @@ components: owner: type: string description: The Bandwidth phone number associated with the message. - example: "+15554443333" + example: '+15554443333' applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' time: type: string format: date-time description: The datetime stamp of the message in ISO 8601 - example: "2024-12-02T20:15:57.278201Z" + example: '2024-12-02T20:15:57.278201Z' segmentCount: - $ref: "#/components/schemas/segmentCount" + $ref: '#/components/schemas/segmentCount' direction: - $ref: "#/components/schemas/messageDirectionEnum" + $ref: '#/components/schemas/messageDirectionEnum' to: uniqueItems: true type: array @@ -2211,11 +2211,11 @@ components: type: string description: The phone number recipients of the message. example: - - "+15552223333" + - '+15552223333' from: type: string description: The phone number the message was sent from. - example: "+15553332222" + example: '+15553332222' media: uniqueItems: true type: array @@ -2233,11 +2233,11 @@ components: description: The contents of the message. example: Hello world tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' messageRequest: title: MessageRequest type: object @@ -2247,14 +2247,14 @@ components: - from properties: applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' to: uniqueItems: true type: array description: The phone number(s) the message should be sent to in E164 format. example: - - "+15554443333" - - "+15552223333" + - '+15554443333' + - '+15552223333' items: type: string from: @@ -2268,17 +2268,17 @@ components: letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. - example: "+15551113333" + example: '+15551113333' text: - $ref: "#/components/schemas/messageText" + $ref: '#/components/schemas/messageText' media: - $ref: "#/components/schemas/messageMedia" + $ref: '#/components/schemas/messageMedia' tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' messageText: type: string description: The contents of the text message. Must be 2048 characters or less. @@ -2302,14 +2302,14 @@ components: links: type: array items: - $ref: "#/components/schemas/link" + $ref: '#/components/schemas/link' example: [] data: - $ref: "#/components/schemas/multiChannelMessageResponseData" + $ref: '#/components/schemas/multiChannelMessageResponseData' errors: type: array items: - $ref: "#/components/schemas/errorObject" + $ref: '#/components/schemas/errorObject' example: [] multiChannelError: type: object @@ -2317,7 +2317,7 @@ components: links: type: array items: - $ref: "#/components/schemas/link" + $ref: '#/components/schemas/link' example: [] data: type: object @@ -2326,7 +2326,7 @@ components: errors: type: array items: - $ref: "#/components/schemas/errorObject" + $ref: '#/components/schemas/errorObject' link: type: object properties: @@ -2344,7 +2344,7 @@ components: description: A detailed explanation of the error. type: string source: - $ref: "#/components/schemas/errorSource" + $ref: '#/components/schemas/errorSource' required: - type - description @@ -2381,13 +2381,13 @@ components: multiChannelDestination: type: string description: The phone number the message should be sent to in E164 format. - example: "+15552223333" + example: '+15552223333' multiChannelDestinations: uniqueItems: true type: array description: The destination phone number(s) of the message, in E164 format. example: - - "+15554443333" + - '+15554443333' items: type: string rbmMessageContentText: @@ -2402,7 +2402,7 @@ components: maxLength: 3270 example: Hello world suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - text rbmMediaHeightEnum: @@ -2458,9 +2458,9 @@ components: media: type: array items: - $ref: "#/components/schemas/rbmMessageContentFile" + $ref: '#/components/schemas/rbmMessageContentFile' suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - media rbmCardContent: @@ -2479,11 +2479,11 @@ components: example: Bandwidth is a communications platform as a service (CPaaS) company. media: allOf: - - $ref: "#/components/schemas/rbmMessageContentFile" + - $ref: '#/components/schemas/rbmMessageContentFile' - type: object properties: height: - $ref: "#/components/schemas/rbmMediaHeightEnum" + $ref: '#/components/schemas/rbmMediaHeightEnum' required: - height suggestions: @@ -2492,20 +2492,20 @@ components: displayed on the rich card. type: array items: - $ref: "#/components/schemas/multiChannelAction" + $ref: '#/components/schemas/multiChannelAction' maxItems: 4 rbmStandaloneCard: title: Standalone Card type: object properties: orientation: - $ref: "#/components/schemas/standaloneCardOrientationEnum" + $ref: '#/components/schemas/standaloneCardOrientationEnum' thumbnailImageAlignment: - $ref: "#/components/schemas/thumbnailAlignmentEnum" + $ref: '#/components/schemas/thumbnailAlignmentEnum' cardContent: - $ref: "#/components/schemas/rbmCardContent" + $ref: '#/components/schemas/rbmCardContent' suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - orientation - cardContent @@ -2529,15 +2529,15 @@ components: type: object properties: cardWidth: - $ref: "#/components/schemas/cardWidthEnum" + $ref: '#/components/schemas/cardWidthEnum' cardContents: type: array items: - $ref: "#/components/schemas/rbmCardContent" + $ref: '#/components/schemas/rbmCardContent' minItems: 2 maxItems: 10 suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - cardContents - cardWidth @@ -2552,7 +2552,7 @@ components: type: object properties: text: - $ref: "#/components/schemas/messageText" + $ref: '#/components/schemas/messageText' required: - text mmsMessageContent: @@ -2560,16 +2560,16 @@ components: type: object properties: text: - $ref: "#/components/schemas/messageText" + $ref: '#/components/schemas/messageText' media: type: array items: - $ref: "#/components/schemas/mmsMessageContentFile" + $ref: '#/components/schemas/mmsMessageContentFile' rbmMessageContentRichCard: title: RBM Rich Card oneOf: - - $ref: "#/components/schemas/rbmStandaloneCard" - - $ref: "#/components/schemas/rbmMessageCarouselCard" + - $ref: '#/components/schemas/rbmStandaloneCard' + - $ref: '#/components/schemas/rbmMessageCarouselCard' rbmActionTypeEnum: type: string enum: @@ -2629,30 +2629,30 @@ components: type: object properties: type: - $ref: "#/components/schemas/rbmActionTypeEnum" + $ref: '#/components/schemas/rbmActionTypeEnum' text: - $ref: "#/components/schemas/rbmActionText" + $ref: '#/components/schemas/rbmActionText' postbackData: - $ref: "#/components/schemas/rbmActionPostbackData" + $ref: '#/components/schemas/rbmActionPostbackData' required: - text - postbackData - type rbmActionDial: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $ref: '#/components/schemas/rbmActionBase' - title: Dial Phone type: object properties: phoneNumber: type: string description: The phone number to dial. Must be E164 format. - example: "+15552223333" + example: '+15552223333' required: - phoneNumber rbmActionViewLocation: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $ref: '#/components/schemas/rbmActionBase' - title: Show Location type: object properties: @@ -2662,14 +2662,14 @@ components: description: >- The latitude of the location. Must be in range [-90.000000, 90.000000]. - example: "37.7749" + example: '37.7749' longitude: type: string format: double description: >- The longitude of the location. Must be in range [-180.000000, 180.000000]. - example: "-122.4194" + example: '-122.4194' label: type: string description: The label of the location. @@ -2680,7 +2680,7 @@ components: - longitude multiChannelActionCalendarEvent: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $ref: '#/components/schemas/rbmActionBase' - title: Calendar Event type: object properties: @@ -2695,14 +2695,14 @@ components: description: >- The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. - example: "2022-09-14T18:20:16.000Z" + example: '2022-09-14T18:20:16.000Z' endTime: type: string format: date-time description: >- The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. - example: "2022-09-14T18:20:16.000Z" + example: '2022-09-14T18:20:16.000Z' description: type: string description: The description of the event. @@ -2714,7 +2714,7 @@ components: - endTime rbmActionOpenUrl: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $ref: '#/components/schemas/rbmActionBase' - title: Open URL type: object properties: @@ -2725,100 +2725,100 @@ components: example: https://dev.bandwidth.com maxLength: 2048 application: - $ref: "#/components/schemas/rbmOpenUrlEnum" + $ref: '#/components/schemas/rbmOpenUrlEnum' webviewViewMode: - $ref: "#/components/schemas/rbmWebViewEnum" + $ref: '#/components/schemas/rbmWebViewEnum' required: - url multiChannelFullActions: type: array description: An array of suggested actions for the recipient. items: - $ref: "#/components/schemas/multiChannelAction" + $ref: '#/components/schemas/multiChannelAction' maxItems: 11 multiChannelAction: anyOf: - - $ref: "#/components/schemas/rbmActionBase" - - $ref: "#/components/schemas/rbmActionDial" - - $ref: "#/components/schemas/rbmActionViewLocation" - - $ref: "#/components/schemas/multiChannelActionCalendarEvent" - - $ref: "#/components/schemas/rbmActionOpenUrl" + - $ref: '#/components/schemas/rbmActionBase' + - $ref: '#/components/schemas/rbmActionDial' + - $ref: '#/components/schemas/rbmActionViewLocation' + - $ref: '#/components/schemas/multiChannelActionCalendarEvent' + - $ref: '#/components/schemas/rbmActionOpenUrl' discriminator: propertyName: type mapping: - REPLY: "#/components/schemas/rbmActionBase" - DIAL_PHONE: "#/components/schemas/rbmActionDial" - SHOW_LOCATION: "#/components/schemas/rbmActionViewLocation" - CREATE_CALENDAR_EVENT: "#/components/schemas/multiChannelActionCalendarEvent" - OPEN_URL: "#/components/schemas/rbmActionOpenUrl" - REQUEST_LOCATION: "#/components/schemas/rbmActionBase" + REPLY: '#/components/schemas/rbmActionBase' + DIAL_PHONE: '#/components/schemas/rbmActionDial' + SHOW_LOCATION: '#/components/schemas/rbmActionViewLocation' + CREATE_CALENDAR_EVENT: '#/components/schemas/multiChannelActionCalendarEvent' + OPEN_URL: '#/components/schemas/rbmActionOpenUrl' + REQUEST_LOCATION: '#/components/schemas/rbmActionBase' multiChannelChannelListObjectBase: type: object properties: from: - $ref: "#/components/schemas/multiChannelSenderId" + $ref: '#/components/schemas/multiChannelSenderId' applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' channel: - $ref: "#/components/schemas/multiChannelMessageChannelEnum" + $ref: '#/components/schemas/multiChannelMessageChannelEnum' required: - from - applicationId - channel multiChannelChannelListRBMObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListObjectBase" + - $ref: '#/components/schemas/multiChannelChannelListObjectBase' - type: object properties: content: description: The content of the message. oneOf: - - $ref: "#/components/schemas/rbmMessageContentText" - - $ref: "#/components/schemas/rbmMessageMedia" - - $ref: "#/components/schemas/rbmMessageContentRichCard" + - $ref: '#/components/schemas/rbmMessageContentText' + - $ref: '#/components/schemas/rbmMessageMedia' + - $ref: '#/components/schemas/rbmMessageContentRichCard' required: - content multiChannelChannelListSMSObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListObjectBase" + - $ref: '#/components/schemas/multiChannelChannelListObjectBase' - type: object properties: content: - $ref: "#/components/schemas/smsMessageContent" + $ref: '#/components/schemas/smsMessageContent' required: - content multiChannelChannelListMMSObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListObjectBase" + - $ref: '#/components/schemas/multiChannelChannelListObjectBase' - type: object properties: content: - $ref: "#/components/schemas/mmsMessageContent" + $ref: '#/components/schemas/mmsMessageContent' required: - content multiChannelChannelListRBMResponseObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListRBMObject" - - $ref: "#/components/schemas/multiChannelChannelListOwnerObject" + - $ref: '#/components/schemas/multiChannelChannelListRBMObject' + - $ref: '#/components/schemas/multiChannelChannelListOwnerObject' multiChannelChannelListSMSResponseObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListSMSObject" - - $ref: "#/components/schemas/multiChannelChannelListOwnerObject" + - $ref: '#/components/schemas/multiChannelChannelListSMSObject' + - $ref: '#/components/schemas/multiChannelChannelListOwnerObject' multiChannelChannelListMMSResponseObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListMMSObject" - - $ref: "#/components/schemas/multiChannelChannelListOwnerObject" + - $ref: '#/components/schemas/multiChannelChannelListMMSObject' + - $ref: '#/components/schemas/multiChannelChannelListOwnerObject' multiChannelChannelListRequestObject: anyOf: - - $ref: "#/components/schemas/multiChannelChannelListRBMObject" - - $ref: "#/components/schemas/multiChannelChannelListSMSObject" - - $ref: "#/components/schemas/multiChannelChannelListMMSObject" + - $ref: '#/components/schemas/multiChannelChannelListRBMObject' + - $ref: '#/components/schemas/multiChannelChannelListSMSObject' + - $ref: '#/components/schemas/multiChannelChannelListMMSObject' discriminator: propertyName: channel mapping: - RBM: "#/components/schemas/multiChannelChannelListRBMObject" - SMS: "#/components/schemas/multiChannelChannelListSMSObject" - MMS: "#/components/schemas/multiChannelChannelListMMSObject" + RBM: '#/components/schemas/multiChannelChannelListRBMObject' + SMS: '#/components/schemas/multiChannelChannelListSMSObject' + MMS: '#/components/schemas/multiChannelChannelListMMSObject' multiChannelChannelListOwnerObject: type: object properties: @@ -2831,21 +2831,21 @@ components: - owner multiChannelChannelListResponseObject: anyOf: - - $ref: "#/components/schemas/multiChannelChannelListRBMResponseObject" - - $ref: "#/components/schemas/multiChannelChannelListSMSResponseObject" - - $ref: "#/components/schemas/multiChannelChannelListMMSResponseObject" + - $ref: '#/components/schemas/multiChannelChannelListRBMResponseObject' + - $ref: '#/components/schemas/multiChannelChannelListSMSResponseObject' + - $ref: '#/components/schemas/multiChannelChannelListMMSResponseObject' discriminator: propertyName: channel mapping: - RBM: "#/components/schemas/multiChannelChannelListRBMResponseObject" - SMS: "#/components/schemas/multiChannelChannelListSMSResponseObject" - MMS: "#/components/schemas/multiChannelChannelListMMSResponseObject" + RBM: '#/components/schemas/multiChannelChannelListRBMResponseObject' + SMS: '#/components/schemas/multiChannelChannelListSMSResponseObject' + MMS: '#/components/schemas/multiChannelChannelListMMSResponseObject' multiChannelMessageRequest: description: Multi-Channel Message Request type: object properties: to: - $ref: "#/components/schemas/multiChannelDestination" + $ref: '#/components/schemas/multiChannelDestination' channelList: type: array description: >- @@ -2853,14 +2853,14 @@ components: order they are listed. Once a message sends successfully, the others will be ignored. items: - $ref: "#/components/schemas/multiChannelChannelListRequestObject" + $ref: '#/components/schemas/multiChannelChannelListRequestObject' maxItems: 4 tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' required: - to - channelList @@ -2869,16 +2869,16 @@ components: type: object properties: id: - $ref: "#/components/schemas/id" + $ref: '#/components/schemas/id' time: description: The time the message was received by the Bandwidth API. type: string format: date-time - example: "2025-01-01T18:20:16.000Z" + example: '2025-01-01T18:20:16.000Z' direction: - $ref: "#/components/schemas/messageDirectionEnum" + $ref: '#/components/schemas/messageDirectionEnum' to: - $ref: "#/components/schemas/multiChannelDestinations" + $ref: '#/components/schemas/multiChannelDestinations' channelList: type: array description: >- @@ -2886,14 +2886,14 @@ components: order they are listed. Once a message sends successfully, the others will be ignored. items: - $ref: "#/components/schemas/multiChannelChannelListResponseObject" + $ref: '#/components/schemas/multiChannelChannelListResponseObject' maxItems: 4 tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' required: - id - time @@ -2907,7 +2907,7 @@ components: text: type: string media: - $ref: "#/components/schemas/rbmMessageContentFile" + $ref: '#/components/schemas/rbmMessageContentFile' rbmSuggestionResponse: type: object properties: @@ -2916,7 +2916,7 @@ components: description: The text of the suggestion the user tapped. example: Track my order postbackData: - $ref: "#/components/schemas/rbmActionPostbackData" + $ref: '#/components/schemas/rbmActionPostbackData' pairedMessageId: type: string nullable: true @@ -2929,12 +2929,12 @@ components: type: string format: double description: The latitude of the client's location. - example: "37.7749" + example: '37.7749' longitude: type: string format: double description: The longitude of the client's location. - example: "-122.4194" + example: '-122.4194' rbmSession: type: object description: >- @@ -2988,7 +2988,7 @@ components: description: >- The time the 24-hour session window opened. Only present on `session-started` callbacks. - example: "2026-08-06T09:59:55Z" + example: '2026-08-06T09:59:55Z' endTime: type: string nullable: true @@ -2996,7 +2996,7 @@ components: description: >- The time the 24-hour session window closes. Only present on `session-started` callbacks. - example: "2026-08-07T09:59:55Z" + example: '2026-08-07T09:59:55Z' required: - canInitiate callback: @@ -3011,20 +3011,20 @@ components: message client's response to a suggestion or location request. type: object oneOf: - - $ref: "#/components/schemas/statusCallback" - - $ref: "#/components/schemas/inboundCallback" + - $ref: '#/components/schemas/statusCallback' + - $ref: '#/components/schemas/inboundCallback' discriminator: propertyName: type mapping: - message-sending: "#/components/schemas/statusCallback" - message-sent: "#/components/schemas/statusCallback" - message-delivered: "#/components/schemas/statusCallback" - message-failed: "#/components/schemas/statusCallback" - message-read: "#/components/schemas/statusCallback" - session-started: "#/components/schemas/statusCallback" - message-received: "#/components/schemas/inboundCallback" - requested-location-response: "#/components/schemas/inboundCallback" - suggestion-response: "#/components/schemas/inboundCallback" + message-sending: '#/components/schemas/statusCallback' + message-sent: '#/components/schemas/statusCallback' + message-delivered: '#/components/schemas/statusCallback' + message-failed: '#/components/schemas/statusCallback' + message-read: '#/components/schemas/statusCallback' + session-started: '#/components/schemas/statusCallback' + message-received: '#/components/schemas/inboundCallback' + requested-location-response: '#/components/schemas/inboundCallback' + suggestion-response: '#/components/schemas/inboundCallback' statusCallback: type: object description: >- @@ -3034,16 +3034,16 @@ components: time: type: string format: date-time - example: "2024-12-02T20:15:57.278201Z" + example: '2024-12-02T20:15:57.278201Z' eventTime: type: string description: >- Represents the time at which the message was read, for `message-read` callbacks. format: date-time - example: "2024-12-02T20:15:58.278205Z" + example: '2024-12-02T20:15:58.278205Z' type: - $ref: "#/components/schemas/statusCallbackTypeEnum" + $ref: '#/components/schemas/statusCallbackTypeEnum' to: type: string description: >- @@ -3051,19 +3051,19 @@ components: For status callbacks, this the the Bandwidth user's client phone number. - example: "+15552223333" + example: '+15552223333' description: type: string description: A detailed description of the event described by the callback. example: Message delivered to handset. message: - $ref: "#/components/schemas/statusCallbackMessage" + $ref: '#/components/schemas/statusCallbackMessage' errorCode: type: integer description: Optional error code, applicable only when type is `message-failed`. example: 4405 carrierName: - $ref: "#/components/schemas/carrierName" + $ref: '#/components/schemas/carrierName' required: - time - type @@ -3077,9 +3077,9 @@ components: time: type: string format: date-time - example: "2024-12-02T20:15:57.278201Z" + example: '2024-12-02T20:15:57.278201Z' type: - $ref: "#/components/schemas/inboundCallbackTypeEnum" + $ref: '#/components/schemas/inboundCallbackTypeEnum' to: type: string description: > @@ -3087,15 +3087,15 @@ components: For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. - example: "+15552223333" + example: '+15552223333' description: type: string description: A detailed description of the event described by the callback. example: Incoming message received message: - $ref: "#/components/schemas/inboundCallbackMessage" + $ref: '#/components/schemas/inboundCallbackMessage' carrierName: - $ref: "#/components/schemas/carrierName" + $ref: '#/components/schemas/carrierName' required: - time - type @@ -3167,17 +3167,17 @@ components: description: >- The Bandwidth phone number or alphanumeric identifier associated with the message. - example: "+15553332222" + example: '+15553332222' applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' time: type: string format: date-time - example: "2024-12-02T20:15:57.666000Z" + example: '2024-12-02T20:15:57.666000Z' segmentCount: - $ref: "#/components/schemas/segmentCount" + $ref: '#/components/schemas/segmentCount' direction: - $ref: "#/components/schemas/messageDirectionEnum" + $ref: '#/components/schemas/messageDirectionEnum' to: description: The phone number recipients of the message. uniqueItems: true @@ -3185,18 +3185,18 @@ components: items: type: string example: - - "+15552223333" + - '+15552223333' from: type: string description: >- The Bandwidth phone number or alphanumeric identifier the message was sent from. - example: "+15553332222" + example: '+15553332222' text: type: string example: Hello world tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' media: type: array description: Optional media, not applicable for sms @@ -3207,11 +3207,11 @@ components: - https://dev.bandwidth.com/images/bandwidth-logo.png - https://dev.bandwidth.com/images/github_logo.png priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' channel: - $ref: "#/components/schemas/multiChannelMessageChannelEnum" + $ref: '#/components/schemas/multiChannelMessageChannelEnum' session: - $ref: "#/components/schemas/rbmSession" + $ref: '#/components/schemas/rbmSession' required: - id - owner @@ -3223,15 +3223,15 @@ components: - from inboundCallbackMessage: allOf: - - $ref: "#/components/schemas/statusCallbackMessage" + - $ref: '#/components/schemas/statusCallbackMessage' - type: object properties: content: - $ref: "#/components/schemas/multiChannelMessageContent" + $ref: '#/components/schemas/multiChannelMessageContent' suggestionResponse: - $ref: "#/components/schemas/rbmSuggestionResponse" + $ref: '#/components/schemas/rbmSuggestionResponse' locationResponse: - $ref: "#/components/schemas/rbmLocationResponse" + $ref: '#/components/schemas/rbmLocationResponse' required: - id - owner @@ -3373,7 +3373,7 @@ components: (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). - example: "+19195551234" + example: '+19195551234' from: type: string description: >- @@ -3381,7 +3381,7 @@ components: from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. - example: "+15555551212" + example: '+15555551212' privacy: nullable: true type: boolean @@ -3443,7 +3443,7 @@ components: maxLength: 2048 example: https://www.myCallbackServer.example/webhooks/answer answerMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' username: type: string nullable: true @@ -3471,7 +3471,7 @@ components: maxLength: 2048 example: https://www.myFallbackServer.example/webhooks/answer answerFallbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' fallbackUsername: type: string nullable: true @@ -3495,7 +3495,7 @@ components: maxLength: 2048 example: https://www.myCallbackServer.example/webhooks/disconnect disconnectMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' callTimeout: nullable: true type: number @@ -3530,7 +3530,7 @@ components: default: 15 example: 15 machineDetection: - $ref: "#/components/schemas/machineDetectionConfiguration" + $ref: '#/components/schemas/machineDetectionConfiguration' priority: nullable: true type: integer @@ -3592,7 +3592,7 @@ components: description: The id of the application associated with the `from` number. accountId: type: string - example: "9900000" + example: '9900000' description: The bandwidth account ID associated with the call. callId: type: string @@ -3600,18 +3600,18 @@ components: description: Programmable Voice API Call ID. to: type: string - example: "+19195551234" + example: '+19195551234' description: Recipient of the outgoing call. from: type: string - example: "+19195554321" + example: '+19195554321' description: Phone number that created the outbound call. enqueuedTime: nullable: true type: string format: date-time description: The time at which the call was accepted into the queue. - example: "2022-06-16T13:15:07.160Z" + example: '2022-06-16T13:15:07.160Z' callUrl: type: string format: uri @@ -3637,14 +3637,14 @@ components: example: My custom tag value description: Custom tag value. answerMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' answerUrl: type: string format: uri example: https://myServer.example/bandwidth/webhooks/answer description: URL to deliver the `answer` event webhook. answerFallbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' answerFallbackUrl: nullable: true type: string @@ -3652,7 +3652,7 @@ components: example: https://myFallbackServer.example/bandwidth/webhooks/answer description: Fallback URL to deliver the `answer` event webhook. disconnectMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' disconnectUrl: nullable: true type: string @@ -3698,7 +3698,7 @@ components: accountId: type: string description: The account id associated with the call. - example: "9900000" + example: '9900000' callId: type: string description: The programmable voice API call ID. @@ -3715,15 +3715,15 @@ components: description: >- The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI. - example: "+19195551234" + example: '+19195551234' from: type: string description: >- The phone number that made the call, in E.164 format (e.g. +15555555555). - example: "+19195554321" + example: '+19195554321' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' state: description: >- The current state of the call. Current possible values are @@ -3792,7 +3792,7 @@ components: type: string format: date-time description: The time this call was placed in queue. - example: "2022-06-16T13:15:07.160Z" + example: '2022-06-16T13:15:07.160Z' startTime: nullable: true type: string @@ -3800,7 +3800,7 @@ components: description: >- The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. - example: "2022-06-16T13:15:07.160Z" + example: '2022-06-16T13:15:07.160Z' answerTime: nullable: true type: string @@ -3808,13 +3808,13 @@ components: description: >- Populated once the call has been answered, with the time in ISO 8601 format. - example: "2022-06-16T13:15:18.126Z" + example: '2022-06-16T13:15:18.126Z' endTime: nullable: true type: string format: date-time description: Populated once the call has ended, with the time in ISO 8601 format. - example: "2022-06-16T13:15:18.314Z" + example: '2022-06-16T13:15:18.314Z' disconnectCause: nullable: true type: string @@ -3877,12 +3877,12 @@ components: type: string format: date-time description: The last time the call had a state update, in ISO 8601 format. - example: "2022-06-16T13:15:18.314Z" + example: '2022-06-16T13:15:18.314Z' updateCall: type: object properties: state: - $ref: "#/components/schemas/callStateEnum" + $ref: '#/components/schemas/callStateEnum' redirectUrl: description: |- The URL to send the [Redirect](/docs/voice/bxml/redirect) event @@ -3896,7 +3896,7 @@ components: format: uri example: https://myServer.example/bandwidth/webhooks/redirect redirectMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' username: type: string nullable: true @@ -3918,7 +3918,7 @@ components: redirect callback delivery in case `redirectUrl` fails to respond. example: https://myFallbackServer.example/bandwidth/webhooks/redirect redirectFallbackMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' fallbackUsername: type: string nullable: true @@ -3958,7 +3958,7 @@ components: - state properties: state: - $ref: "#/components/schemas/recordingStateEnum" + $ref: '#/components/schemas/recordingStateEnum' accountStatistics: type: object properties: @@ -3976,43 +3976,43 @@ components: type: object properties: applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' transcription: - $ref: "#/components/schemas/recordingTranscriptionMetadata" + $ref: '#/components/schemas/recordingTranscriptionMetadata' recordingName: - $ref: "#/components/schemas/recordingName" + $ref: '#/components/schemas/recordingName' conference: type: object properties: @@ -4028,13 +4028,13 @@ components: type: string format: date-time description: The time the conference was initiated, in ISO 8601 format. - example: "2022-06-17T22:19:40.375Z" + example: '2022-06-17T22:19:40.375Z' completedTime: nullable: true type: string format: date-time description: The time the conference was terminated, in ISO 8601 format. - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' conferenceEventUrl: nullable: true type: string @@ -4042,7 +4042,7 @@ components: description: The URL to send the conference-related events. example: https://myServer.example/bandwidth/webhooks/conferenceEvent conferenceEventMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' tag: nullable: true type: string @@ -4054,7 +4054,7 @@ components: type: array nullable: true items: - $ref: "#/components/schemas/conferenceMember" + $ref: '#/components/schemas/conferenceMember' description: >- A list of active members of the conference. Omitted if this @@ -4064,7 +4064,7 @@ components: type: object properties: status: - $ref: "#/components/schemas/conferenceStateEnum" + $ref: '#/components/schemas/conferenceStateEnum' redirectUrl: nullable: true type: string @@ -4079,7 +4079,7 @@ components: but required if `state` is `active`. example: https://myServer.example/bandwidth/webhooks/conferenceRedirect redirectMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' username: type: string nullable: true @@ -4105,7 +4105,7 @@ components: allowed if `state` is `completed`. example: https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect redirectFallbackMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' fallbackUsername: type: string nullable: true @@ -4122,9 +4122,9 @@ components: type: object properties: callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' memberUrl: type: string format: uri @@ -4231,29 +4231,29 @@ components: type: object properties: accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' recordingName: - $ref: "#/components/schemas/recordingName" + $ref: '#/components/schemas/recordingName' machineDetectionConfiguration: type: object description: >- @@ -4265,7 +4265,7 @@ components: information. properties: mode: - $ref: "#/components/schemas/machineDetectionModeEnum" + $ref: '#/components/schemas/machineDetectionModeEnum' detectionTimeout: nullable: true type: number @@ -4354,7 +4354,7 @@ components: maxLength: 2048 example: https://myServer.example/bandwidth/webhooks/machineDetectionComplete callbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' username: type: string nullable: true @@ -4381,7 +4381,7 @@ components: maxLength: 2048 example: https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete fallbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' fallbackUsername: type: string nullable: true @@ -4413,7 +4413,7 @@ components: password fields for authorization. example: https://myServer.example/bandwidth/webhooks/transcriptionAvailable callbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' username: type: string nullable: true @@ -4427,7 +4427,7 @@ components: maxLength: 1024 example: mySecretPassword1! tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' callbackTimeout: nullable: true type: number @@ -4459,14 +4459,14 @@ components: transcripts: type: array items: - $ref: "#/components/schemas/transcription" + $ref: '#/components/schemas/transcription' clips: type: array description: >- A list of individual speech clips with speaker, timing, and confidence information. items: - $ref: "#/components/schemas/recordingTranscriptionClip" + $ref: '#/components/schemas/recordingTranscriptionClip' example: transcripts: - speaker: 0 @@ -4529,7 +4529,7 @@ components: callTranscriptionMetadataList: type: array items: - $ref: "#/components/schemas/callTranscriptionMetadata" + $ref: '#/components/schemas/callTranscriptionMetadata' example: - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b transcriptionName: live_transcription @@ -4563,7 +4563,7 @@ components: accountId: type: string description: The user account associated with the call. - example: "9900000" + example: '9900000' callId: type: string description: The call id associated with the event. @@ -4575,7 +4575,7 @@ components: tracks: type: array items: - $ref: "#/components/schemas/callTranscription" + $ref: '#/components/schemas/callTranscription' example: - detectedLanguage: en-US track: inbound @@ -4585,9 +4585,9 @@ components: type: object properties: detectedLanguage: - $ref: "#/components/schemas/callTranscriptionDetectedLanguageEnum" + $ref: '#/components/schemas/callTranscriptionDetectedLanguageEnum' track: - $ref: "#/components/schemas/callTranscriptionTrackEnum" + $ref: '#/components/schemas/callTranscriptionTrackEnum' transcript: type: string description: The transcription itself. @@ -4611,12 +4611,12 @@ components: description: The unique transcription ID example: t-387bd648-18f3-4823-9d16-746bca0003c9 status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' completedTime: type: string format: date-time description: The time that the transcription was completed - example: "2022-06-13T18:46:29.715Z" + example: '2022-06-13T18:46:29.715Z' url: type: string format: uri @@ -4639,35 +4639,35 @@ components: request when an outbound call is answered. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' machineDetectionResult: - $ref: "#/components/schemas/machineDetectionResult" + $ref: '#/components/schemas/machineDetectionResult' sipCallId: - $ref: "#/components/schemas/sipCallId" + $ref: '#/components/schemas/sipCallId' bridgeCompleteCallback: type: object description: >- @@ -4678,37 +4678,37 @@ components: calls to be bridged. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' bridgeTargetCompleteCallback: type: object description: >- @@ -4718,31 +4718,31 @@ components: is NOT sent. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceCreatedCallback: type: object description: >- @@ -4756,15 +4756,15 @@ components: conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceRedirectCallback: type: object description: >- @@ -4778,15 +4778,15 @@ components: audio verbs that are played into the conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceMemberJoinCallback: type: object description: >- @@ -4800,21 +4800,21 @@ components: into the conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceMemberExitCallback: type: object description: >- @@ -4828,21 +4828,21 @@ components: into the conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceCompletedCallback: type: object description: >- @@ -4850,15 +4850,15 @@ components: conference. The response to this event may not contain BXML. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceRecordingAvailableCallback: type: object description: >- @@ -4867,79 +4867,79 @@ components: available for download. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' disconnectCallback: type: object description: The Disconnect event is fired when a call ends, for any reason. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' sipCallId: - $ref: "#/components/schemas/sipCallId" + $ref: '#/components/schemas/sipCallId' sipResponseCode: - $ref: "#/components/schemas/sipResponseCode" + $ref: '#/components/schemas/sipResponseCode' sipStatusLine: - $ref: "#/components/schemas/sipStatusLine" + $ref: '#/components/schemas/sipStatusLine' sipHeaders: - $ref: "#/components/schemas/sipHeaders" + $ref: '#/components/schemas/sipHeaders' dtmfCallback: type: object description: >- @@ -4947,39 +4947,39 @@ components: verb is executed. You may not respond to this event with BXML. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' digit: - $ref: "#/components/schemas/digit" + $ref: '#/components/schemas/digit' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' gatherCallback: type: object description: >- @@ -4987,41 +4987,41 @@ components: is to report the gathered digits to the calling application. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' digits: - $ref: "#/components/schemas/digits" + $ref: '#/components/schemas/digits' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' terminatingDigit: - $ref: "#/components/schemas/terminatingDigit" + $ref: '#/components/schemas/terminatingDigit' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' initiateCallback: type: object description: >- @@ -5031,35 +5031,35 @@ components: telephone number belongs to. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' diversion: - $ref: "#/components/schemas/diversion" + $ref: '#/components/schemas/diversion' stirShaken: - $ref: "#/components/schemas/stirShaken" + $ref: '#/components/schemas/stirShaken' uui: - $ref: "#/components/schemas/uui" + $ref: '#/components/schemas/uui' sipCallId: - $ref: "#/components/schemas/sipCallId" + $ref: '#/components/schemas/sipCallId' sipHeaders: - $ref: "#/components/schemas/sipHeaders" + $ref: '#/components/schemas/sipHeaders' machineDetectionCompleteCallback: type: object description: >- @@ -5069,33 +5069,33 @@ components: event is not sent when sync answering machine detection mode is chosen. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' machineDetectionResult: - $ref: "#/components/schemas/machineDetectionResult" + $ref: '#/components/schemas/machineDetectionResult' recordingCompleteCallback: type: object description: >- @@ -5105,49 +5105,49 @@ components: Available event will be sent. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' recordingAvailableCallback: type: object description: >- @@ -5155,49 +5155,49 @@ components: processed. It indicates that the recording is available for download. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' redirectCallback: type: object description: >- @@ -5205,37 +5205,37 @@ components: purpose is to get the next set of verbs from the calling application. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' referCompleteCallback: type: object description: >- @@ -5246,35 +5246,35 @@ components: on the call. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' referCallStatus: - $ref: "#/components/schemas/referCallStatusEnum" + $ref: '#/components/schemas/referCallStatusEnum' referSipResponseCode: - $ref: "#/components/schemas/referSipResponseCode" + $ref: '#/components/schemas/referSipResponseCode' notifySipResponseCode: - $ref: "#/components/schemas/notifySipResponseCode" + $ref: '#/components/schemas/notifySipResponseCode' transcriptionAvailableCallback: type: object description: >- @@ -5282,47 +5282,47 @@ components: transcription is available to be downloaded. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transcription: - $ref: "#/components/schemas/transcription" + $ref: '#/components/schemas/transcription' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' transferAnswerCallback: type: object description: >- @@ -5335,35 +5335,35 @@ components: transferAnswer event, but some are not allowed. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' transferCompleteCallback: type: object description: >- @@ -5374,41 +5374,41 @@ components: transferComplete event corresponds to one of the legs. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' transferDisconnectCallback: type: object description: >- @@ -5420,51 +5420,51 @@ components: the transferred leg. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' sipResponseCode: - $ref: "#/components/schemas/sipResponseCode" + $ref: '#/components/schemas/sipResponseCode' sipStatusLine: - $ref: "#/components/schemas/sipStatusLine" + $ref: '#/components/schemas/sipStatusLine' sipHeaders: - $ref: "#/components/schemas/sipHeaders" + $ref: '#/components/schemas/sipHeaders' eventType: type: string description: >- @@ -5483,11 +5483,11 @@ components: 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. - example: "2022-06-17T22:19:40.375Z" + example: '2022-06-17T22:19:40.375Z' accountId: type: string description: The user account associated with the call. - example: "9900000" + example: '9900000' applicationId1: type: string description: The id of the application associated with the call. @@ -5497,13 +5497,13 @@ components: description: >- The phone number that received the call, in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' from: type: string description: >- The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' conferenceId: type: string description: The unique, Bandwidth-generated ID of the conference that was recorded @@ -5530,43 +5530,43 @@ components: digit: type: string description: The digit collected in the call. - example: "2" + example: '2' digits: type: string description: >- (optional) The digits, letters, and/or symbols entered by the user. The string is empty if a timeout occurred before any buttons were pressed. - example: "123" + example: '123' terminatingDigit: type: string description: >- (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. - example: "#" + example: '#' startTime: type: string format: date-time description: Time the call was started, in ISO 8601 format. - example: "2022-06-17T22:19:40.375Z" + example: '2022-06-17T22:19:40.375Z' enqueuedTime: type: string format: date-time description: >- (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' nullable: true answerTime: type: string format: date-time description: Time the call was answered, in ISO 8601 format. - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' nullable: true endTime: type: string format: date-time description: The time that the recording ended in ISO-8601 format - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' status: type: string description: >- @@ -5582,13 +5582,13 @@ components: description: >- The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' transferTo: type: string description: >- The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' mediaUrl: nullable: true type: string @@ -5691,21 +5691,21 @@ components: privacy: type: string description: off or full - example: "off" + example: 'off' screen: type: string description: >- No if the number was provided by the user, yes if the number was provided by the network - example: "no" + example: 'no' counter: type: string description: The number of diversions that have occurred - example: "2" + example: '2' limit: type: string description: The maximum number of diversions allowed for this session - example: "3" + example: '3' unknown: type: string description: >- @@ -5717,7 +5717,7 @@ components: description: >- Always present. Indicates the last telephone number that the call was diverted from. - example: "+15558884444" + example: '+15558884444' transcription: type: object properties: @@ -5823,13 +5823,13 @@ components: type: string description: The phone number to send the mfa code to. pattern: ^\+[1-9]\d{1,14}$ - example: "+19195551234" + example: '+19195551234' from: type: string description: The application phone number, the sender of the mfa code. pattern: ^\+[1-9]\d{1,14}$ maxLength: 32 - example: "+19195554321" + example: '+19195554321' applicationId: type: string description: The application unique ID, obtained from Bandwidth. @@ -5889,7 +5889,7 @@ components: type: string description: The phone number to send the mfa code to. pattern: ^\+[1-9]\d{1,14}$ - example: "+19195551234" + example: '+19195551234' scope: type: string description: >- @@ -5911,7 +5911,7 @@ components: description: The generated mfa code to check if valid. minLength: 4 maxLength: 8 - example: "123456" + example: '123456' required: - to - expirationTimeInMinutes @@ -6053,8 +6053,8 @@ components: type: string description: Phone number experiencing the error. example: - - "+13992077164" - - "+19196104424" + - '+13992077164' + - '+19196104424' message: type: string description: Message describing the error @@ -6108,27 +6108,27 @@ components: links: type: array items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' example: [] data: type: object description: The phone number lookup response data properties: requestId: - $ref: "#/components/schemas/requestId" + $ref: '#/components/schemas/requestId' status: - $ref: "#/components/schemas/completedLookupStatusEnum" + $ref: '#/components/schemas/completedLookupStatusEnum' results: type: array description: >- The carrier information results for the specified telephone numbers. items: - $ref: "#/components/schemas/lookupResult" + $ref: '#/components/schemas/lookupResult' errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' createAsyncBulkLookupResponse: type: object properties: @@ -6136,53 +6136,53 @@ components: type: array description: Links for pagination (if applicable) items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' data: type: object description: The phone number lookup response data properties: requestId: - $ref: "#/components/schemas/requestId" + $ref: '#/components/schemas/requestId' status: - $ref: "#/components/schemas/inProgressLookupStatusEnum" + $ref: '#/components/schemas/inProgressLookupStatusEnum' errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' getAsyncBulkLookupResponse: type: object properties: links: type: array items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' example: [] data: type: object description: The phone number lookup response data properties: requestId: - $ref: "#/components/schemas/requestId" + $ref: '#/components/schemas/requestId' status: - $ref: "#/components/schemas/inProgressLookupStatusEnum" + $ref: '#/components/schemas/inProgressLookupStatusEnum' results: type: array description: >- The carrier information results for the specified telephone number. items: - $ref: "#/components/schemas/lookupResult" + $ref: '#/components/schemas/lookupResult' errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' lookupErrorResponse: type: object properties: links: type: array items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' example: [] data: type: object @@ -6190,7 +6190,7 @@ components: errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' rcsErrorEnum: type: string description: >- @@ -6231,9 +6231,9 @@ components: phoneNumber: type: string description: The telephone number in E.164 format. - example: "+10072904498" + example: '+10072904498' lineType: - $ref: "#/components/schemas/lineTypeEnum" + $ref: '#/components/schemas/lineTypeEnum' messagingProvider: type: string description: The messaging service provider of the telephone number. @@ -6263,9 +6263,9 @@ components: deactivation event. example: 2025-06-20 18:35 deactivationEvent: - $ref: "#/components/schemas/deactivationEventEnum" + $ref: '#/components/schemas/deactivationEventEnum' latestMessageDeliveryStatus: - $ref: "#/components/schemas/latestMessageDeliveryStatusEnum" + $ref: '#/components/schemas/latestMessageDeliveryStatusEnum' initialMessageDeliveryStatusDate: type: string format: date @@ -6276,7 +6276,7 @@ components: Think of this as the "start time" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. - example: "2025-06-20" + example: '2025-06-20' latestMessageDeliveryStatusDate: type: string format: date @@ -6288,7 +6288,7 @@ components: `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. - example: "2025-06-21" + example: '2025-06-21' rcsEnabled: type: boolean description: > @@ -6300,7 +6300,7 @@ components: accountId1: type: string description: User's account ID. - example: "1234567" + example: '1234567' tfPhoneNumber: type: string description: Toll-free telephone number in E.164 format. @@ -6308,13 +6308,13 @@ components: maxLength: 12 nullable: false pattern: ^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$ - example: "+18005555555" + example: '+18005555555' tfvWebhookErrors: type: array description: Details of the errors that were encountered when processing the request. items: type: string - example: "optInWorkflowImageURLs: Entries must be a valid array of objects." + example: 'optInWorkflowImageURLs: Entries must be a valid array of objects.' tfvCallbackStatusEnum: type: string enum: @@ -6351,11 +6351,11 @@ components: type: object properties: statusCode: - $ref: "#/components/schemas/denialStatusCode" + $ref: '#/components/schemas/denialStatusCode' reason: - $ref: "#/components/schemas/declineReasonDescription" + $ref: '#/components/schemas/declineReasonDescription' resubmitAllowed: - $ref: "#/components/schemas/resubmitAllowed" + $ref: '#/components/schemas/resubmitAllowed' required: - statusCode - reason @@ -6533,7 +6533,7 @@ components: minLength: 1 maxLength: 500 nullable: false - example: "+19192654500" + example: '+19192654500' verificationRequest: type: object required: @@ -6548,9 +6548,9 @@ components: - businessEntityType properties: businessAddress: - $ref: "#/components/schemas/address" + $ref: '#/components/schemas/address' businessContact: - $ref: "#/components/schemas/contact" + $ref: '#/components/schemas/contact' messageVolume: type: integer description: Estimated monthly volume of messages from the toll-free number. @@ -6562,15 +6562,15 @@ components: minItems: 1 maxItems: 10 items: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' useCase: - $ref: "#/components/schemas/useCase" + $ref: '#/components/schemas/useCase' useCaseSummary: - $ref: "#/components/schemas/useCaseSummary" + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - $ref: "#/components/schemas/productionMessageContent" + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: - $ref: "#/components/schemas/optInWorkflow" + $ref: '#/components/schemas/optInWorkflow' additionalInformation: type: string description: Any additional information. @@ -6579,27 +6579,27 @@ components: nullable: true example: Any additional information isvReseller: - $ref: "#/components/schemas/isvReseller" + $ref: '#/components/schemas/isvReseller' privacyPolicyUrl: - $ref: "#/components/schemas/privacyPolicyUrl" + $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: - $ref: "#/components/schemas/termsAndConditionsUrl" + $ref: '#/components/schemas/termsAndConditionsUrl' businessDba: - $ref: "#/components/schemas/businessDba" + $ref: '#/components/schemas/businessDba' businessRegistrationNumber: - $ref: "#/components/schemas/businessRegistrationNumber" + $ref: '#/components/schemas/businessRegistrationNumber' businessRegistrationType: - $ref: "#/components/schemas/businessRegistrationTypeEnum" + $ref: '#/components/schemas/businessRegistrationTypeEnum' businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountry" + $ref: '#/components/schemas/businessRegistrationIssuingCountry' businessEntityType: - $ref: "#/components/schemas/businessEntityTypeEnum" + $ref: '#/components/schemas/businessEntityTypeEnum' helpMessageResponse: - $ref: "#/components/schemas/helpMessageResponse" + $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: - $ref: "#/components/schemas/ageGatedContent" + $ref: '#/components/schemas/ageGatedContent' cvToken: - $ref: "#/components/schemas/cvTokenNullable" + $ref: '#/components/schemas/cvTokenNullable' verificationUpdateRequest: type: object required: @@ -6613,9 +6613,9 @@ components: - businessEntityType properties: businessAddress: - $ref: "#/components/schemas/address" + $ref: '#/components/schemas/address' businessContact: - $ref: "#/components/schemas/contact" + $ref: '#/components/schemas/contact' messageVolume: type: integer description: Estimated monthly volume of messages from the toll-free number. @@ -6623,37 +6623,37 @@ components: maximum: 10000000 example: 10000 useCase: - $ref: "#/components/schemas/useCase" + $ref: '#/components/schemas/useCase' useCaseSummary: - $ref: "#/components/schemas/useCaseSummary" + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - $ref: "#/components/schemas/productionMessageContent" + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: - $ref: "#/components/schemas/optInWorkflow" + $ref: '#/components/schemas/optInWorkflow' additionalInformation: - $ref: "#/components/schemas/additionalInformation" + $ref: '#/components/schemas/additionalInformation' isvReseller: - $ref: "#/components/schemas/isvReseller" + $ref: '#/components/schemas/isvReseller' privacyPolicyUrl: - $ref: "#/components/schemas/privacyPolicyUrl" + $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: - $ref: "#/components/schemas/termsAndConditionsUrl" + $ref: '#/components/schemas/termsAndConditionsUrl' businessDba: - $ref: "#/components/schemas/businessDba" + $ref: '#/components/schemas/businessDba' businessRegistrationNumber: - $ref: "#/components/schemas/businessRegistrationNumber" + $ref: '#/components/schemas/businessRegistrationNumber' businessRegistrationType: - $ref: "#/components/schemas/businessRegistrationTypeEnum" + $ref: '#/components/schemas/businessRegistrationTypeEnum' businessEntityType: - $ref: "#/components/schemas/businessEntityTypeEnum" + $ref: '#/components/schemas/businessEntityTypeEnum' businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountry" + $ref: '#/components/schemas/businessRegistrationIssuingCountry' helpMessageResponse: - $ref: "#/components/schemas/helpMessageResponse" + $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: - $ref: "#/components/schemas/ageGatedContent" + $ref: '#/components/schemas/ageGatedContent' cvToken: - $ref: "#/components/schemas/cvTokenNullable" + $ref: '#/components/schemas/cvTokenNullable' tfvBasicAuthentication: type: object properties: @@ -6672,47 +6672,47 @@ components: type: object properties: basicAuthentication: - $ref: "#/components/schemas/tfvBasicAuthentication" + $ref: '#/components/schemas/tfvBasicAuthentication' callbackUrl: - $ref: "#/components/schemas/webhookUrl" + $ref: '#/components/schemas/webhookUrl' sharedSecretKey: - $ref: "#/components/schemas/sharedSecretKey" + $ref: '#/components/schemas/sharedSecretKey' required: - callbackUrl failureWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' errorCode: type: string description: >- An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. - example: "400" + example: '400' errorMessage: type: string description: A description of the error that was encountered. example: cannot process request. errors: - $ref: "#/components/schemas/tfvWebhookErrors" + $ref: '#/components/schemas/tfvWebhookErrors' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' verificationDenialWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' additionalDenialReasons: description: >- An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. type: array items: - $ref: "#/components/schemas/additionalDenialReason" + $ref: '#/components/schemas/additionalDenialReason' example: - statusCode: 512 reason: Reason A @@ -6721,52 +6721,52 @@ components: reason: Reason B resubmitAllowed: true declineReasonDescription: - $ref: "#/components/schemas/declineReasonDescription" + $ref: '#/components/schemas/declineReasonDescription' denialStatusCode: - $ref: "#/components/schemas/denialStatusCode" + $ref: '#/components/schemas/denialStatusCode' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' resubmitAllowed: - $ref: "#/components/schemas/resubmitAllowed" + $ref: '#/components/schemas/resubmitAllowed' status: - $ref: "#/components/schemas/tfvUnverifiedStatus" + $ref: '#/components/schemas/tfvUnverifiedStatus' blocked: - $ref: "#/components/schemas/blocked" + $ref: '#/components/schemas/blocked' blockedReason: - $ref: "#/components/schemas/blockedReason" + $ref: '#/components/schemas/blockedReason' verificationWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' status: - $ref: "#/components/schemas/tfvCallbackStatusEnum" + $ref: '#/components/schemas/tfvCallbackStatusEnum' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' blockedWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' status: - $ref: "#/components/schemas/tfvCallbackStatusEnum" + $ref: '#/components/schemas/tfvCallbackStatusEnum' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' blocked: - $ref: "#/components/schemas/blocked" + $ref: '#/components/schemas/blocked' blockedReason: - $ref: "#/components/schemas/blockedReason" + $ref: '#/components/schemas/blockedReason' tfvSubmissionWrapper: type: object properties: submission: - $ref: "#/components/schemas/verificationUpdateRequest" + $ref: '#/components/schemas/verificationUpdateRequest' address: type: object nullable: false @@ -6817,8 +6817,8 @@ components: type: string description: The zip of the business using the toll-free number. nullable: false - example: "27606" - pattern: "[- A-Za-z0-9]{0,500}" + example: '27606' + pattern: '[- A-Za-z0-9]{0,500}' url: type: string format: url @@ -6893,9 +6893,9 @@ components: nullable: false example: Doe email: - $ref: "#/components/schemas/email" + $ref: '#/components/schemas/email' phoneNumber: - $ref: "#/components/schemas/businessContactPhoneNumber" + $ref: '#/components/schemas/businessContactPhoneNumber' email: type: string format: email @@ -6948,14 +6948,14 @@ components: - data properties: links: - $ref: "#/components/schemas/linksObject" + $ref: '#/components/schemas/linksObject' errors: type: array items: - $ref: "#/components/schemas/webhookSubscriptionError" + $ref: '#/components/schemas/webhookSubscriptionError' data: items: - $ref: "#/components/schemas/webhookSubscription" + $ref: '#/components/schemas/webhookSubscription' type: array linksObject: type: object @@ -6988,7 +6988,7 @@ components: telephoneNumbers: type: array items: - $ref: "#/components/schemas/telephoneNumber" + $ref: '#/components/schemas/telephoneNumber' telephoneNumber: type: object properties: @@ -7014,11 +7014,11 @@ components: example: 7hICGStfAfeGxEq3N0lQwO accountId: type: string - example: "1234567" + example: '1234567' callbackUrl: - $ref: "#/components/schemas/webhookUrl" + $ref: '#/components/schemas/webhookUrl' type: - $ref: "#/components/schemas/webhookSubscriptionTypeEnum" + $ref: '#/components/schemas/webhookSubscriptionTypeEnum' basicAuthentication: description: >- Basic authentication credentials are not required, but if present, @@ -7037,11 +7037,11 @@ components: createdDate: type: string format: date-time - example: "2023-05-15T13:56:39.965Z" + example: '2023-05-15T13:56:39.965Z' modifiedDate: type: string format: date-time - example: "2023-05-15T13:56:39.965Z" + example: '2023-05-15T13:56:39.965Z' webhookUrl: description: >- Callback URL to receive status updates from Bandwidth. When a webhook @@ -7077,15 +7077,15 @@ components: type: object properties: phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' status: - $ref: "#/components/schemas/tfvStatusEnum" + $ref: '#/components/schemas/tfvStatusEnum' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumber" + $ref: '#/components/schemas/internalTicketNumber' declineReasonDescription: - $ref: "#/components/schemas/declineReasonDescription" + $ref: '#/components/schemas/declineReasonDescription' denialStatusCode: - $ref: "#/components/schemas/denialStatusCodeNullable" + $ref: '#/components/schemas/denialStatusCodeNullable' additionalDenialReasons: description: >- An optional list of denial reasons in addition to @@ -7093,7 +7093,7 @@ components: nullable: true type: array items: - $ref: "#/components/schemas/additionalDenialReason" + $ref: '#/components/schemas/additionalDenialReason' example: - statusCode: 512 reason: Reason A @@ -7102,32 +7102,32 @@ components: reason: Reason B resubmitAllowed: true resubmitAllowed: - $ref: "#/components/schemas/resubmitAllowed" + $ref: '#/components/schemas/resubmitAllowed' createdDateTime: type: string description: Date and time the verification request was created. format: date-time - example: "2021-06-08T06:45:13.0Z" + example: '2021-06-08T06:45:13.0Z' modifiedDateTime: type: string description: Date and time the verification request was last modified. format: date-time - example: "2021-06-08T06:45:13.0Z" + example: '2021-06-08T06:45:13.0Z' submission: - $ref: "#/components/schemas/tfvSubmissionInfo" + $ref: '#/components/schemas/tfvSubmissionInfo' blocked: - $ref: "#/components/schemas/blocked" + $ref: '#/components/schemas/blocked' blockedReason: - $ref: "#/components/schemas/blockedReason" + $ref: '#/components/schemas/blockedReason' cvToken: - $ref: "#/components/schemas/cvTokenNullable" + $ref: '#/components/schemas/cvTokenNullable' tfvSubmissionInfo: type: object properties: businessAddress: - $ref: "#/components/schemas/address" + $ref: '#/components/schemas/address' businessContact: - $ref: "#/components/schemas/contact" + $ref: '#/components/schemas/contact' messageVolume: type: integer description: Estimated monthly volume of messages from the toll-free number. @@ -7135,36 +7135,36 @@ components: maximum: 10000000 example: 10000 useCase: - $ref: "#/components/schemas/useCase" + $ref: '#/components/schemas/useCase' useCaseSummary: - $ref: "#/components/schemas/useCaseSummary" + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - $ref: "#/components/schemas/productionMessageContent" + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: - $ref: "#/components/schemas/optInWorkflow" + $ref: '#/components/schemas/optInWorkflow' additionalInformation: - $ref: "#/components/schemas/additionalInformation" + $ref: '#/components/schemas/additionalInformation' isvReseller: - $ref: "#/components/schemas/isvReseller" + $ref: '#/components/schemas/isvReseller' privacyPolicyUrl: - $ref: "#/components/schemas/privacyPolicyUrl" + $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: - $ref: "#/components/schemas/termsAndConditionsUrl" + $ref: '#/components/schemas/termsAndConditionsUrl' businessDba: - $ref: "#/components/schemas/businessDba" + $ref: '#/components/schemas/businessDba' businessRegistrationNumber: - $ref: "#/components/schemas/businessRegistrationNumber" + $ref: '#/components/schemas/businessRegistrationNumber' description: Government-issued business identifying number. businessRegistrationType: - $ref: "#/components/schemas/businessRegistrationTypeEnum" + $ref: '#/components/schemas/businessRegistrationTypeEnum' description: The type of business registration number. businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountry" + $ref: '#/components/schemas/businessRegistrationIssuingCountry' description: >- The country issuing the business registration in ISO-3166-1 alpha-3 format. businessEntityType: - $ref: "#/components/schemas/businessEntityTypeEnum" + $ref: '#/components/schemas/businessEntityTypeEnum' description: The type of registered business. tfvStatusEnum: type: string @@ -7243,7 +7243,7 @@ components: description: The port of the SIP connection. example: 5060 credentials: - $ref: "#/components/schemas/sipCredentials" + $ref: '#/components/schemas/sipCredentials' uuiHeader: type: string description: The User-to-User Information header for the SIP connection. @@ -7275,12 +7275,12 @@ components: maximum: 1024 example: David's iPhone status: - $ref: "#/components/schemas/deviceStatusEnum" + $ref: '#/components/schemas/deviceStatusEnum' creationTimestamp: type: string format: date-time description: The time the device was created. In ISO-8601 format. - example: "2021-01-01T00:00:00Z" + example: '2021-01-01T00:00:00Z' required: - deviceId - status @@ -7289,25 +7289,25 @@ components: type: object properties: endpointId: - $ref: "#/components/schemas/endpointId" + $ref: '#/components/schemas/endpointId' type: - $ref: "#/components/schemas/endpointTypeEnum" + $ref: '#/components/schemas/endpointTypeEnum' status: - $ref: "#/components/schemas/endpointStatusEnum" + $ref: '#/components/schemas/endpointStatusEnum' creationTimestamp: type: string format: date-time description: The time the endpoint was created. In ISO-8601 format. - example: "2021-01-01T00:00:00Z" + example: '2021-01-01T00:00:00Z' expirationTimestamp: type: string format: date-time description: >- The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. - example: "2021-01-02T00:00:00Z" + example: '2021-01-02T00:00:00Z' tag: - $ref: "#/components/schemas/endpointTag" + $ref: '#/components/schemas/endpointTag' required: - endpointId - type @@ -7317,27 +7317,27 @@ components: endpoint: type: object allOf: - - $ref: "#/components/schemas/endpoints" + - $ref: '#/components/schemas/endpoints' - type: object properties: devices: type: array items: - $ref: "#/components/schemas/device" + $ref: '#/components/schemas/device' createWebRtcConnectionRequest: allOf: - - $ref: "#/components/schemas/createEndpointRequestBase" + - $ref: '#/components/schemas/createEndpointRequestBase' - type: object properties: connectionMetadata: - $ref: "#/components/schemas/webRtcConnectionMetadata" + $ref: '#/components/schemas/webRtcConnectionMetadata' createEndpointRequestBase: type: object properties: type: - $ref: "#/components/schemas/endpointTypeEnum" + $ref: '#/components/schemas/endpointTypeEnum' direction: - $ref: "#/components/schemas/endpointDirectionEnum" + $ref: '#/components/schemas/endpointDirectionEnum' eventCallbackUrl: type: string format: uri @@ -7349,24 +7349,24 @@ components: description: The URL to send event fallbacks to. example: https://fallback.myapp.com/callback tag: - $ref: "#/components/schemas/endpointTag" + $ref: '#/components/schemas/endpointTag' required: - type - direction createEndpointRequest: oneOf: - - $ref: "#/components/schemas/createWebRtcConnectionRequest" + - $ref: '#/components/schemas/createWebRtcConnectionRequest' discriminator: propertyName: type mapping: - WEBRTC: "#/components/schemas/createWebRtcConnectionRequest" + WEBRTC: '#/components/schemas/createWebRtcConnectionRequest' createEndpointResponseData: allOf: - - $ref: "#/components/schemas/endpoint" + - $ref: '#/components/schemas/endpoint' - type: object properties: token: - $ref: "#/components/schemas/endpointToken" + $ref: '#/components/schemas/endpointToken' required: - token endpointEventTypeEnum: @@ -7377,18 +7377,18 @@ components: endpointEvent: description: An event that occurred on an endpoint. allOf: - - $ref: "#/components/schemas/endpoints" + - $ref: '#/components/schemas/endpoints' - type: object properties: eventTime: type: string format: date-time description: The time the event occurred. In ISO-8601 format. - example: "2021-01-01T00:00:00Z" + example: '2021-01-01T00:00:00Z' eventType: - $ref: "#/components/schemas/endpointEventTypeEnum" + $ref: '#/components/schemas/endpointEventTypeEnum' device: - $ref: "#/components/schemas/device" + $ref: '#/components/schemas/device' required: - eventType - eventTime @@ -7451,9 +7451,9 @@ components: code: type: string description: A code that uniquely identifies the error. - example: "404" + example: '404' source: - $ref: "#/components/schemas/brtcErrorSource" + $ref: '#/components/schemas/brtcErrorSource' required: - type - description @@ -7484,17 +7484,17 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' page: - $ref: "#/components/schemas/page" + $ref: '#/components/schemas/page' data: type: array items: - $ref: "#/components/schemas/endpoints" + $ref: '#/components/schemas/endpoints' errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7505,13 +7505,13 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' data: - $ref: "#/components/schemas/endpoint" + $ref: '#/components/schemas/endpoint' errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7522,13 +7522,13 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' data: - $ref: "#/components/schemas/createEndpointResponseData" + $ref: '#/components/schemas/createEndpointResponseData' errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7539,7 +7539,7 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' data: type: object nullable: true @@ -7547,7 +7547,7 @@ components: errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7558,19 +7558,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/message" + $ref: '#/components/schemas/message' createMultiChannelMessageResponse: description: Accepted content: application/json: schema: - $ref: "#/components/schemas/createMultiChannelMessageResponse" + $ref: '#/components/schemas/createMultiChannelMessageResponse' listMessagesResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/messagesList" + $ref: '#/components/schemas/messagesList' getMediaResponse: description: OK content: @@ -7591,73 +7591,73 @@ components: schema: type: array items: - $ref: "#/components/schemas/media" + $ref: '#/components/schemas/media' messagingBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingNotAcceptableError: description: Not Acceptable content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' createMessageBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/createMessageRequestError" + $ref: '#/components/schemas/createMessageRequestError' messagingUnauthorizedError: description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingForbiddenError: description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingNotFoundError: description: Not Found content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingMethodNotAllowedError: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingInvalidMediaTypeError: description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingTooManyRequestsError: description: Too Many Requests content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingInternalServerError: description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' multiChannelBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7675,7 +7675,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7688,7 +7688,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7701,7 +7701,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7714,7 +7714,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7727,7 +7727,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7743,7 +7743,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7758,7 +7758,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7777,7 +7777,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' example: type: rate_limit_exceeded description: >- @@ -7793,16 +7793,16 @@ components: content: application/json: schema: - $ref: "#/components/schemas/createCallResponse" + $ref: '#/components/schemas/createCallResponse' examples: createCall Response: - $ref: "#/components/examples/createCallResponseExample" + $ref: '#/components/examples/createCallResponseExample' getCallStateResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callState" + $ref: '#/components/schemas/callState' updateCallResponse: description: OK listCallsResponse: @@ -7812,13 +7812,13 @@ components: schema: type: array items: - $ref: "#/components/schemas/callState" + $ref: '#/components/schemas/callState' getStatisticsResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/accountStatistics" + $ref: '#/components/schemas/accountStatistics' updateRecordingResponse: description: OK listCallRecordingsResponse: @@ -7828,13 +7828,13 @@ components: schema: type: array items: - $ref: "#/components/schemas/callRecordingMetadata" + $ref: '#/components/schemas/callRecordingMetadata' getCallRecordingResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callRecordingMetadata" + $ref: '#/components/schemas/callRecordingMetadata' downloadRecordingMediaResponse: description: OK content: @@ -7851,19 +7851,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/recordingTranscriptions" + $ref: '#/components/schemas/recordingTranscriptions' listTranscriptionsResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callTranscriptionMetadataList" + $ref: '#/components/schemas/callTranscriptionMetadataList' getCallTranscriptionResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callTranscriptionResponse" + $ref: '#/components/schemas/callTranscriptionResponse' deleteCallTranscriptionResponse: description: No Content listConferencesResponse: @@ -7873,22 +7873,22 @@ components: schema: type: array items: - $ref: "#/components/schemas/conference" + $ref: '#/components/schemas/conference' examples: listConferences Response: - $ref: "#/components/examples/listConferencesResponseExample" + $ref: '#/components/examples/listConferencesResponseExample' getConferenceResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/conference" + $ref: '#/components/schemas/conference' getConferenceMemberResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/conferenceMember" + $ref: '#/components/schemas/conferenceMember' listConferenceRecordingsResponse: description: OK content: @@ -7896,76 +7896,76 @@ components: schema: type: array items: - $ref: "#/components/schemas/conferenceRecordingMetadata" + $ref: '#/components/schemas/conferenceRecordingMetadata' getConferenceRecordingResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/conferenceRecordingMetadata" + $ref: '#/components/schemas/conferenceRecordingMetadata' voiceBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: badRequestErrorExample: - $ref: "#/components/examples/voiceBadRequestErrorExample" + $ref: '#/components/examples/voiceBadRequestErrorExample' voiceUnauthorizedError: description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: unauthorizedErrorExample: - $ref: "#/components/examples/voiceUnauthorizedErrorExample" + $ref: '#/components/examples/voiceUnauthorizedErrorExample' voiceForbiddenError: description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: forbiddenErrorExample: - $ref: "#/components/examples/voiceForbiddenErrorExample" + $ref: '#/components/examples/voiceForbiddenErrorExample' voiceNotFoundError: description: Not Found content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: notFoundErrorExample: - $ref: "#/components/examples/voiceNotFoundErrorExample" + $ref: '#/components/examples/voiceNotFoundErrorExample' voiceNotAllowedError: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: notAllowedErrorExample: - $ref: "#/components/examples/voiceNotAllowedErrorExample" + $ref: '#/components/examples/voiceNotAllowedErrorExample' voiceConflictError: description: Conflict content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: conflictErrorExample: - $ref: "#/components/examples/voiceConflictErrorExample" + $ref: '#/components/examples/voiceConflictErrorExample' voiceUnsupportedMediaTypeError: description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: tooManyRequestsErrorExample: - $ref: "#/components/examples/voiceUnsupportedMediaTypeErrorExample" + $ref: '#/components/examples/voiceUnsupportedMediaTypeErrorExample' voiceTooManyRequestsError: description: Too Many Requests headers: @@ -7976,174 +7976,174 @@ components: content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: tooManyRequestsErrorExample: - $ref: "#/components/examples/voiceTooManyRequestsErrorExample" + $ref: '#/components/examples/voiceTooManyRequestsErrorExample' voiceInternalServerError: description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: internalServerErrorExample: - $ref: "#/components/examples/voiceInternalServerErrorExample" + $ref: '#/components/examples/voiceInternalServerErrorExample' voiceCodeResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/voiceCodeResponse" + $ref: '#/components/schemas/voiceCodeResponse' messagingCodeResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/messagingCodeResponse" + $ref: '#/components/schemas/messagingCodeResponse' verifyCodeResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/verifyCodeResponse" + $ref: '#/components/schemas/verifyCodeResponse' mfaBadRequestError: description: Bad Request headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaRequestError" + $ref: '#/components/schemas/mfaRequestError' mfaUnauthorizedError: description: Unauthorized headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaUnauthorizedRequestError" + $ref: '#/components/schemas/mfaUnauthorizedRequestError' mfaForbiddenError: description: Forbidden headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaForbiddenRequestError" + $ref: '#/components/schemas/mfaForbiddenRequestError' mfaTooManyRequestsError: description: Too Many Requests headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaRequestError" + $ref: '#/components/schemas/mfaRequestError' mfaInternalServerError: description: Internal Server Error headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaRequestError" + $ref: '#/components/schemas/mfaRequestError' createSyncLookupResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/createSyncLookupResponse" + $ref: '#/components/schemas/createSyncLookupResponse' examples: lookupCompleteWithDniExample: - $ref: "#/components/examples/lookupCompleteWithDniExample" + $ref: '#/components/examples/lookupCompleteWithDniExample' lookupCompleteExample: - $ref: "#/components/examples/lookupCompleteExample" + $ref: '#/components/examples/lookupCompleteExample' lookupCompleteWithRcsExample: - $ref: "#/components/examples/lookupCompleteWithRcsExample" + $ref: '#/components/examples/lookupCompleteWithRcsExample' lookupCompleteWithRcsErrorExample: - $ref: "#/components/examples/lookupCompleteWithRcsErrorExample" + $ref: '#/components/examples/lookupCompleteWithRcsErrorExample' lookupPartialExample: - $ref: "#/components/examples/lookupPartialExample" + $ref: '#/components/examples/lookupPartialExample' lookupFailedExample: - $ref: "#/components/examples/lookupFailedExample" + $ref: '#/components/examples/lookupFailedExample' createAsyncBulkLookupResponse: description: Accepted content: application/json: schema: - $ref: "#/components/schemas/createAsyncBulkLookupResponse" + $ref: '#/components/schemas/createAsyncBulkLookupResponse' examples: lookupAcceptedExample: - $ref: "#/components/examples/lookupAcceptedExample" + $ref: '#/components/examples/lookupAcceptedExample' getAsyncBulkLookupResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/getAsyncBulkLookupResponse" + $ref: '#/components/schemas/getAsyncBulkLookupResponse' examples: lookupCompleteWithDniExample: - $ref: "#/components/examples/lookupCompleteWithDniExample" + $ref: '#/components/examples/lookupCompleteWithDniExample' lookupCompleteExample: - $ref: "#/components/examples/lookupCompleteExample" + $ref: '#/components/examples/lookupCompleteExample' lookupInProgressExample: - $ref: "#/components/examples/lookupInProgressExample" + $ref: '#/components/examples/lookupInProgressExample' lookupPartialExample: - $ref: "#/components/examples/lookupPartialExample" + $ref: '#/components/examples/lookupPartialExample' lookupFailedExample: - $ref: "#/components/examples/lookupFailedExample" + $ref: '#/components/examples/lookupFailedExample' tnLookupDefaultResponse: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/lookupErrorResponse" + $ref: '#/components/schemas/lookupErrorResponse' examples: badRequest: - $ref: "#/components/examples/badRequestExample" + $ref: '#/components/examples/badRequestExample' unauthorized: - $ref: "#/components/examples/unauthorizedExample" + $ref: '#/components/examples/unauthorizedExample' forbidden: - $ref: "#/components/examples/forbiddenExample" + $ref: '#/components/examples/forbiddenExample' mediaType: - $ref: "#/components/examples/unsupportedMediaTypeExample" + $ref: '#/components/examples/unsupportedMediaTypeExample' notFound: - $ref: "#/components/examples/notFoundExample" + $ref: '#/components/examples/notFoundExample' tooManyRequests: - $ref: "#/components/examples/tooManyRequestsExample" + $ref: '#/components/examples/tooManyRequestsExample' internalServer: - $ref: "#/components/examples/internalServerErrorExample" + $ref: '#/components/examples/internalServerErrorExample' getTollFreeVerificationStatusResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/tfvStatus" + $ref: '#/components/schemas/tfvStatus' listWebhookSubscriptionsResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/webhookSubscriptionsListBody" + $ref: '#/components/schemas/webhookSubscriptionsListBody' createWebhookSubscriptionResponse: description: Created content: application/json: schema: - $ref: "#/components/schemas/webhookSubscription" + $ref: '#/components/schemas/webhookSubscription' updateWebhookSubscriptionResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/webhookSubscription" + $ref: '#/components/schemas/webhookSubscription' listTollFreeUseCasesResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/useCases" + $ref: '#/components/schemas/useCases' tfvBadRequestResponse: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Cannot process request. type: bad request @@ -8154,7 +8154,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: cannot process request. errors: @@ -8166,7 +8166,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Client is providing incorrect or invalid credentials. type: unauthorized @@ -8175,7 +8175,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Client is not authorized for the action. type: forbidden @@ -8184,7 +8184,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Cannot find the requested resource. type: Not Found @@ -8195,16 +8195,16 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: - description: "TFV request already in progress for phone number: +18005551234" + description: 'TFV request already in progress for phone number: +18005551234' type: conflict tfvNotAllowedResponse: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Method is not allowed. type: Method Not Allowed @@ -8213,7 +8213,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Throttling error. Too many requests. type: Too Many Requests @@ -8222,7 +8222,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Internal Server Error. type: Internal Server Error @@ -8231,7 +8231,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Service Unavailable Error. type: Service Unavailable @@ -8242,82 +8242,82 @@ components: content: application/json: schema: - $ref: "#/components/schemas/listEndpointsResponse" + $ref: '#/components/schemas/listEndpointsResponse' examples: listEndpointsResponseExample: - $ref: "#/components/examples/listEndpointsResponseExample" + $ref: '#/components/examples/listEndpointsResponseExample' createEndpointResponse: description: Created content: application/json: schema: - $ref: "#/components/schemas/createEndpointResponse" + $ref: '#/components/schemas/createEndpointResponse' examples: createEndpointResponseExample: - $ref: "#/components/examples/createEndpointResponseExample" + $ref: '#/components/examples/createEndpointResponseExample' getEndpointResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/endpointResponse" + $ref: '#/components/schemas/endpointResponse' examples: getEndpointResponseExample: - $ref: "#/components/examples/getEndpointResponseExample" + $ref: '#/components/examples/getEndpointResponseExample' badRequestErrorResponse: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: badRequestErrorExample: - $ref: "#/components/examples/badRequestErrorExample" + $ref: '#/components/examples/badRequestErrorExample' unauthorizedErrorResponse: description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: unauthorizedErrorExample: - $ref: "#/components/examples/unauthorizedErrorExample" + $ref: '#/components/examples/unauthorizedErrorExample' forbiddenErrorResponse: description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: forbiddenErrorExample: - $ref: "#/components/examples/forbiddenErrorExample" + $ref: '#/components/examples/forbiddenErrorExample' notFoundErrorResponse: description: Not Found content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: notFoundErrorExample: - $ref: "#/components/examples/notFoundErrorExample" + $ref: '#/components/examples/notFoundErrorExample' methodNotAllowedErrorResponse: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: methodNotAllowedErrorExample: - $ref: "#/components/examples/methodNotAllowedErrorExample" + $ref: '#/components/examples/methodNotAllowedErrorExample' unsupportedMediaTypeErrorResponse: description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: unsuppotedMediaTypeErrorExample: - $ref: "#/components/examples/unsupportedMediaTypeErrorExample" + $ref: '#/components/examples/unsupportedMediaTypeErrorExample' tooManyRequestsErrorResponse: description: Too Many Requests headers: @@ -8332,19 +8332,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: tooManyRequestsErrorExample: - $ref: "#/components/examples/tooManyRequestsErrorExample" + $ref: '#/components/examples/tooManyRequestsErrorExample' serviceUnavailableErrorResponse: description: Service Unavailable content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: serviceUnavailableErrorExample: - $ref: "#/components/examples/serviceUnavailableErrorExample" + $ref: '#/components/examples/serviceUnavailableErrorExample' parameters: accountId: in: path @@ -8359,7 +8359,7 @@ components: **When migrating to OAuth authentication, you must use the 7-digit Account ID.** - example: "9900000" + example: '9900000' mediaId: in: path name: mediaId @@ -8417,7 +8417,7 @@ components: full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). - example: "%2B15554443333" + example: '%2B15554443333' schema: type: string destinationTn: @@ -8429,7 +8429,7 @@ components: single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). - example: "%2B15554443333" + example: '%2B15554443333' schema: type: string messageStatus: @@ -8440,14 +8440,14 @@ components: The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. schema: - $ref: "#/components/schemas/messageStatusEnum" + $ref: '#/components/schemas/messageStatusEnum' messageDirection: in: query name: messageDirection required: false description: The direction of the message. One of INBOUND OUTBOUND. schema: - $ref: "#/components/schemas/listMessageDirectionEnum" + $ref: '#/components/schemas/listMessageDirectionEnum' carrierName: in: query name: carrierName @@ -8465,7 +8465,7 @@ components: required: false description: The type of message. Either sms or mms. schema: - $ref: "#/components/schemas/messageTypeEnum" + $ref: '#/components/schemas/messageTypeEnum' errorCode: in: query name: errorCode @@ -8481,7 +8481,7 @@ components: description: >- The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. - example: "2022-09-14T18:20:16.000Z" + example: '2022-09-14T18:20:16.000Z' schema: type: string toDateTime: @@ -8491,7 +8491,7 @@ components: description: >- The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. - example: "2022-09-14T18:20:16.000Z" + example: '2022-09-14T18:20:16.000Z' schema: type: string campaignId: @@ -8529,7 +8529,7 @@ components: description: Messaging product associated with the message. example: P2P schema: - $ref: "#/components/schemas/productTypeEnum" + $ref: '#/components/schemas/productTypeEnum' location: in: query name: location @@ -8656,7 +8656,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' callId: name: callId in: path @@ -8704,7 +8704,7 @@ components: schema: type: string description: Filter results by the `to` field. - example: "%2b19195551234" + example: '%2b19195551234' from: name: from in: query @@ -8712,7 +8712,7 @@ components: schema: type: string description: Filter results by the `from` field. - example: "%2b19195554321" + example: '%2b19195554321' name: name: name in: query @@ -8730,7 +8730,7 @@ components: description: >- Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' maxCreatedTime: name: maxCreatedTime in: query @@ -8740,7 +8740,7 @@ components: description: >- Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' minStartTime: name: minStartTime in: query @@ -8750,7 +8750,7 @@ components: description: >- Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' maxStartTime: name: maxStartTime in: query @@ -8760,7 +8760,7 @@ components: description: >- Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' pageSize: name: pageSize in: query @@ -8782,7 +8782,7 @@ components: description: >- Filter results to calls which have a `startTime` after or including `minStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' maxStartTimeCalls: name: maxStartTime in: query @@ -8792,7 +8792,7 @@ components: description: >- Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' pageSizeCalls: name: pageSize in: query @@ -8831,7 +8831,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' accountId3: in: path name: accountId @@ -8839,7 +8839,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' requestId: in: path name: requestId @@ -8856,15 +8856,15 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' tfPhoneNumberPathParam: in: path name: phoneNumber required: true schema: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' description: Valid Toll-Free telephone number in E.164 format. - example: "+18885555555" + example: '+18885555555' webhookSubscriptionIdPathParam: in: path name: id @@ -8880,7 +8880,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' endpointId: name: endpointId in: path @@ -8893,13 +8893,13 @@ components: name: type in: query schema: - $ref: "#/components/schemas/endpointTypeEnum" + $ref: '#/components/schemas/endpointTypeEnum' description: The type of endpoint. endpointStatus: name: status in: query schema: - $ref: "#/components/schemas/endpointStatusEnum" + $ref: '#/components/schemas/endpointStatusEnum' description: The status of the endpoint. afterCursor: name: afterCursor @@ -8924,39 +8924,39 @@ components: smsMessageReceivedCallbackExample: summary: An example of a sms message-received callback body. value: - time: "2025-01-06T15:43:35.502180Z" + time: '2025-01-06T15:43:35.502180Z' type: message-received - to: "+12345678902" + to: '+12345678902' description: Incoming message received message: id: 14762070468292kw2fuqty55yp2b2 - owner: "+12345678902" + owner: '+12345678902' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - time: "2025-01-06T15:43:34.000000Z" + time: '2025-01-06T15:43:34.000000Z' segmentCount: 1 direction: in to: - - "+12345678902" - from: "+12345678901" + - '+12345678902' + from: '+12345678901' text: Hey, check out this SMS! mmsMessageReceivedCallbackExample: summary: An example of a mms message-received callback body. value: - time: "2024-09-14T18:20:45.160744Z" + time: '2024-09-14T18:20:45.160744Z' type: message-received - to: "+12345678902" + to: '+12345678902' description: Incoming message received message: id: 14762070468292kw2fuqty55yp2b2 - owner: "+12345678902" + owner: '+12345678902' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - time: "2024-09-14T18:20:45.160744Z" + time: '2024-09-14T18:20:45.160744Z' segmentCount: 1 direction: in to: - - "+12345678902" - - "+12345678903" - from: "+12345678901" + - '+12345678902' + - '+12345678903' + from: '+12345678901' text: Hey, check out the MMS! media: - https://messaging.bandwidth.com/api/v2/users/9900902/media/14762070468292kw2fuqty55yp2b2/0/bw.png @@ -8965,7 +8965,7 @@ components: An example of a rbm message-received callback body for a message that is part of an RCS interactive session. value: - time: "2026-08-06T10:00:05.502180Z" + time: '2026-08-06T10:00:05.502180Z' type: message-received to: BandwidthRBM description: Incoming message received @@ -8973,12 +8973,12 @@ components: id: 1786010405502l2ntaoajuqjhqnxu owner: BandwidthRBM applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - time: "2026-08-06T10:00:05.302180Z" + time: '2026-08-06T10:00:05.302180Z' segmentCount: 1 direction: in to: - BandwidthRBM - from: "+12345678902" + from: '+12345678902' channel: RBM content: text: Yes, please book it for tomorrow. @@ -8988,42 +8988,42 @@ components: messageSendingCallbackExample: summary: An example of a message-sending callback body. value: - time: "2024-06-25T18:42:36.979456Z" + time: '2024-06-25T18:42:36.979456Z' type: message-sending - to: "+15554443333" + to: '+15554443333' description: Message is sending to carrier. message: id: 1593110555875xo7watq5px6rbe5d - owner: "+15552221111" + owner: '+15552221111' applicationId: cfd4fb83-7531-4acc-b471-42d0bb76a65c - time: "2024-06-25T18:42:35.876906Z" + time: '2024-06-25T18:42:35.876906Z' segmentCount: 1 direction: out to: - - "+15554443333" - from: "+15552221111" - text: "" + - '+15554443333' + from: '+15552221111' + text: '' media: - https://dev.bandwidth.com/images/bandwidth-logo.png tag: your tag here messageSentCallbackExample: summary: An example of a message-sent callback body. value: - time: "2024-06-25T18:42:36.979456Z" + time: '2024-06-25T18:42:36.979456Z' type: message-sent - to: "+15554443333" + to: '+15554443333' description: Message sent to carrier message: id: 1593110555875xo7watq5px6rbe5d - owner: "+15552221111" + owner: '+15552221111' applicationId: cfd4fb83-7531-4acc-b471-42d0bb76a65c - time: "2024-06-25T18:42:35.876906Z" + time: '2024-06-25T18:42:35.876906Z' segmentCount: 1 direction: out to: - - "+15554443333" - from: "+15552221111" - text: "" + - '+15554443333' + from: '+15552221111' + text: '' media: - https://dev.bandwidth.com/images/bandwidth-logo.png tag: v2 lab @@ -9031,36 +9031,36 @@ components: summary: An example of a sms message-delivered callback body. value: type: message-delivered - time: "2024-09-14T18:20:11.160744Z" + time: '2024-09-14T18:20:11.160744Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-09-14T18:20:11.160744Z" + time: '2024-09-14T18:20:11.160744Z' to: - - "+12345678902" - from: "+12345678901" - text: "" + - '+12345678902' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - owner: "+12345678902" + owner: '+12345678902' direction: out segmentCount: 1 mmsMessageDeliveredCallbackExample: summary: An example of a mms message-delivered callback body. value: type: message-delivered - time: "2024-09-14T18:20:24.160544Z" + time: '2024-09-14T18:20:24.160544Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-09-14T18:20:24.160544Z" + time: '2024-09-14T18:20:24.160544Z' to: - - "+12345678902" - from: "+12345678901" - text: "" + - '+12345678902' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - owner: "+12345678902" + owner: '+12345678902' direction: out segmentCount: 1 media: @@ -9069,19 +9069,19 @@ components: summary: An example of a group mms message-delivered callback body. value: type: message-delivered - time: "2024-09-14T18:20:17.160544Z" + time: '2024-09-14T18:20:17.160544Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-09-14T18:20:17.160544Z" + time: '2024-09-14T18:20:17.160544Z' to: - - "+12345678902" - - "+12345678903" - from: "+12345678901" - text: "" + - '+12345678902' + - '+12345678903' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - owner: "+12345678902" + owner: '+12345678902' direction: out segmentCount: 1 rbmMessageDeliveredSessionCallbackExample: @@ -9090,16 +9090,16 @@ components: is part of an RCS interactive session. value: type: message-delivered - time: "2026-08-06T10:01:11.160744Z" + time: '2026-08-06T10:01:11.160744Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 1786010470868ty55yp2b2kw2fuq - time: "2026-08-06T10:01:10.868292Z" + time: '2026-08-06T10:01:10.868292Z' to: - - "+12345678902" + - '+12345678902' from: BandwidthRBM - text: "" + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 owner: BandwidthRBM direction: out @@ -9114,16 +9114,16 @@ components: is not yet part of an RCS interactive session. value: type: message-delivered - time: "2026-08-06T09:59:56.160744Z" + time: '2026-08-06T09:59:56.160744Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 1786010395000kw2fuqty55yp2b2 - time: "2026-08-06T09:59:55.000000Z" + time: '2026-08-06T09:59:55.000000Z' to: - - "+12345678902" + - '+12345678902' from: BandwidthRBM - text: "" + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 owner: BandwidthRBM direction: out @@ -9135,59 +9135,59 @@ components: summary: An example of a session-started callback body. value: type: session-started - time: "2026-08-06T10:00:00.123000Z" + time: '2026-08-06T10:00:00.123000Z' description: Message is now part of an RCS interactive session. - to: "+12345678902" + to: '+12345678902' message: id: 1786010395000kw2fuqty55yp2b2 owner: BandwidthRBM applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - time: "2026-08-06T10:00:00.120000Z" + time: '2026-08-06T10:00:00.120000Z' segmentCount: 1 direction: out to: - - "+12345678902" + - '+12345678902' from: BandwidthRBM - text: "" - tag: "" + text: '' + tag: '' channel: RBM session: canInitiate: false id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d type: INTERACTIVE_SESSION - startTime: "2026-08-06T09:59:55Z" - endTime: "2026-08-07T09:59:55Z" + startTime: '2026-08-06T09:59:55Z' + endTime: '2026-08-07T09:59:55Z' messageFailedCallbackExample: summary: An example of a message-failed callback body. value: type: message-failed - time: "2024-12-18T16:51:27.704450Z" + time: '2024-12-18T16:51:27.704450Z' description: forbidden to country - to: "+52345678903" + to: '+52345678903' errorCode: 4432 message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-12-18T16:51:27.704450Z" + time: '2024-12-18T16:51:27.704450Z' to: - - "+12345678902" - - "+52345678903" - from: "+12345678901" - text: "" + - '+12345678902' + - '+52345678903' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 media: - https://dev.bandwidth.com/images/bandwidth-logo.png - owner: "+12345678901" + owner: '+12345678901' direction: out segmentCount: 1 createCallResponseExample: summary: Example of a createCall Response value: applicationId: 04e88489-df02-4e34-a0ee-27a91849555f - accountId: "9900000" + accountId: '9900000' callId: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 - to: "+19195551234" - from: "+19195554312" - enqueuedTime: "2022-06-16T13:15:07.160Z" + to: '+19195551234' + from: '+19195554312' + enqueuedTime: '2022-06-16T13:15:07.160Z' callUrl: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 callTimeout: 30 callbackTimeout: 15 @@ -9199,17 +9199,17 @@ components: disconnectMethod: POST disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect username: mySecretUsername - password: "*****" + password: '*****' fallbackUsername: mySecretUsername - fallbackPassword: "*****" + fallbackPassword: '*****' priority: 5 listConferencesResponseExample: summary: Example of a listConferences Response value: - id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9 name: my-conference-name - createdTime: "2022-06-17T22:19:40.375Z" - completedTime: "2022-06-17T22:20:00.000Z" + createdTime: '2022-06-17T22:19:40.375Z' + completedTime: '2022-06-17T22:20:00.000Z' conferenceEventUrl: https://myServer.example/bandwidth/webhooks/conferenceEvent conferenceEventMethod: POST tag: my custom tag @@ -9217,64 +9217,64 @@ components: summary: Example of a Bad Request (400) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceUnauthorizedErrorExample: summary: Example of an Unauthorized (401) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceForbiddenErrorExample: summary: Example of a Forbidden (403) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceNotFoundErrorExample: summary: Example of a Not Found (404) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceNotAllowedErrorExample: summary: Example of a Not Allowed (405) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceConflictErrorExample: summary: Example of a Conflict (409) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceUnsupportedMediaTypeErrorExample: summary: Example of an Unsupported Media Type (415) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceTooManyRequestsErrorExample: summary: Example of a Too Many Requests (429) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceInternalServerErrorExample: summary: Example of an Internal Server (500) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' singleNumberRequestExample: summary: Number Lookup Request value: phoneNumbers: - - "+19196104423" + - '+19196104423' multipleNumberRequestExample: summary: Number Lookup Request for Multiple Numbers value: phoneNumbers: - - "+19196104423" - - "+19196104424" + - '+19196104423' + - '+19196104424' rcsAgentRequestExample: summary: Number Lookup Request with Custom RCS Agent value: phoneNumbers: - - "+19196104423" - - "+19196104424" + - '+19196104423' + - '+19196104424' rcsAgent: MyCustomRcsAgent lookupAcceptedExample: summary: Numbers Lookup Accepted @@ -9309,7 +9309,7 @@ components: description: The following TNs could not be found in the Number Industry data meta: phoneNumbers: - - "+13992077164" + - '+13992077164' message: Invalid TNs code: 1001 type: NumberInventory @@ -9321,12 +9321,12 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: PARTIAL_COMPLETE results: - - phoneNumber: "+19196104423" + - phoneNumber: '+19196104423' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA - - phoneNumber: "+19196104424" + - phoneNumber: '+19196104424' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9336,7 +9336,7 @@ components: description: The following TNs could not be found in the Number Industry data meta: phoneNumbers: - - "+13992077164" + - '+13992077164' message: Invalid TNs code: 1001 type: NumberInventory @@ -9348,12 +9348,12 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA - - phoneNumber: "+10072904498" + - phoneNumber: '+10072904498' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9367,36 +9367,36 @@ components: requestId: 20732adf-bf81-8b17-41b1-004223a05590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' countryCodeA3: USA lineType: MOBILE messagingProvider: T-MOBILE USA INC voiceProvider: T-MOBILE USA INC latestMessageDeliveryStatus: ACTIVE - initialMessageDeliveryStatusDate: "2025-05-14" - latestMessageDeliveryStatusDate: "2025-05-18" - - phoneNumber: "+10072904498" + initialMessageDeliveryStatusDate: '2025-05-14' + latestMessageDeliveryStatusDate: '2025-05-18' + - phoneNumber: '+10072904498' countryCodeA3: USA lineType: MOBILE voiceProvider: VERIZON latestMessageDeliveryStatus: DEACTIVATED - initialMessageDeliveryStatusDate: "2025-09-05" - latestMessageDeliveryStatusDate: "2025-09-05" - - phoneNumber: "+10072904499" + initialMessageDeliveryStatusDate: '2025-09-05' + latestMessageDeliveryStatusDate: '2025-09-05' + - phoneNumber: '+10072904499' lineType: MOBILE countryCodeA3: USA messagingProvider: VERIZON voiceProvider: VERIZON deactivationReporter: Verizon Wireless - deactivationDate: "2025-09-29 01:23:00" + deactivationDate: '2025-09-29 01:23:00' deactivationEvent: DEACTIVATED latestMessageDeliveryStatus: UNKNOWN - - phoneNumber: "+10072904500" + - phoneNumber: '+10072904500' lineType: FIXED countryCodeA3: USA voiceProvider: VERIZON deactivationReporter: Verizon Wireless - deactivationDate: "2025-09-29 01:23:00" + deactivationDate: '2025-09-29 01:23:00' deactivationEvent: DEACTIVATED latestMessageDeliveryStatus: NOT_ENABLED errors: [] @@ -9408,13 +9408,13 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA rcsEnabled: true - - phoneNumber: "+10072904498" + - phoneNumber: '+10072904498' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9429,12 +9429,12 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA - - phoneNumber: "+10072904498" + - phoneNumber: '+10072904498' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9445,20 +9445,20 @@ components: description: An exception was thrown during the async RCS service call. meta: phoneNumbers: - - "+10072904497" + - '+10072904497' - code: MISSING_FROM_RESPONSE type: rcs-error description: The phone number was absent from the RCS service response. meta: phoneNumbers: - - "+10072904498" + - '+10072904498' badRequestExample: summary: Example Bad Request Error value: links: [] data: {} errors: - - code: "1234" + - code: '1234' type: bad-request description: >- Bad Request. Ensure that you have set the requestId as a URL path @@ -9471,7 +9471,7 @@ components: errors: - type: Unauthorized description: You are not authorized to access this resource. - code: "1" + code: '1' forbiddenExample: summary: Forbidden Error value: @@ -9480,14 +9480,14 @@ components: errors: - type: Forbidden description: You do not have permission to access this resource. - code: "2" + code: '2' unsupportedMediaTypeExample: summary: Unsupported Media Type Error value: links: [] data: {} errors: - - code: "1234" + - code: '1234' type: invalid-content-type description: >- Invalid content-type. Ensure that your content-type header is set @@ -9498,7 +9498,7 @@ components: links: [] data: {} errors: - - code: "1234" + - code: '1234' type: not-found description: >- RequestId not found. Ensure that the requestId used in the URL @@ -9509,7 +9509,7 @@ components: links: [] data: {} errors: - - code: "1234" + - code: '1234' type: rate-limiting description: >- Rate limit exceeded. Wait for the time specified in the @@ -9520,7 +9520,7 @@ components: links: [] data: {} errors: - - code: "500" + - code: '500' type: unexpected-error description: >- Unexpected error. Please contact Bandwidth Support if your @@ -9545,14 +9545,14 @@ components: - endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' tag: my-tag - endpointId: e-2cb0-4a07-b215-b22865662d85-15ac29a2-1331029c type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' tag: my-tag errors: [] createEndpointResponseExample: @@ -9567,8 +9567,8 @@ components: token: xxxxx.yyyyy.zzzzz type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' devices: [] tag: my-tag errors: [] @@ -9583,8 +9583,8 @@ components: endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' devices: [] tag: my-tag errors: [] @@ -9597,7 +9597,7 @@ components: port: 3000 credentials: username: username - password: "********" + password: '********' uuiHeader: 123456;encoding=jwt direction: INBOUND eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth @@ -9620,9 +9620,9 @@ components: endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 type: WEBRTC status: DISCONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" - eventTime: "2021-01-01T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' + eventTime: '2021-01-01T00:00:00Z' eventType: DEVICE_DISCONNECTED tag: my-tag badRequestErrorExample: @@ -9634,7 +9634,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: invalid_parameter description: accountId must not contain any characters other than numbers. - code: "400" + code: '400' source: parameter: accountId unauthorizedErrorExample: @@ -9648,7 +9648,7 @@ components: description: >- The provided credentials are not authorized to access this resource. - code: "401" + code: '401' source: header: Authorization forbiddenErrorExample: @@ -9662,7 +9662,7 @@ components: description: >- The provided credentials are not authorized to access this resource. - code: "403" + code: '403' source: header: Authorization notFoundErrorExample: @@ -9674,7 +9674,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: resource_not_found description: The requested resource was not found. - code: "404" + code: '404' source: reference: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 methodNotAllowedErrorExample: @@ -9686,7 +9686,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: method_not_allowed description: The requested method is not allowed on this resource. - code: "405" + code: '405' source: parameter: accountId unsupportedMediaTypeErrorExample: @@ -9698,7 +9698,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: unsupported_media_type description: The provided media type is not supported. - code: "415" + code: '415' source: header: Content-Type tooManyRequestsErrorExample: @@ -9720,19 +9720,19 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: service_unavailable description: The service is currently unavailable. - code: "500" + code: '500' requestBodies: createMessageRequest: content: application/json: schema: - $ref: "#/components/schemas/messageRequest" + $ref: '#/components/schemas/messageRequest' required: true createMultiChannelMessageRequest: content: application/json: schema: - $ref: "#/components/schemas/multiChannelMessageRequest" + $ref: '#/components/schemas/multiChannelMessageRequest' required: true uploadMediaRequest: content: @@ -9935,7 +9935,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/createCall" + $ref: '#/components/schemas/createCall' updateCallRequest: description: >- JSON object containing information to redirect an existing call to a new @@ -9944,7 +9944,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/updateCall" + $ref: '#/components/schemas/updateCall' updateCallBxmlRequest: required: true content: @@ -9972,19 +9972,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/updateCallRecording" + $ref: '#/components/schemas/updateCallRecording' transcribeRecordingRequest: required: true content: application/json: schema: - $ref: "#/components/schemas/transcribeRecording" + $ref: '#/components/schemas/transcribeRecording' updateConferenceRequest: required: true content: application/json: schema: - $ref: "#/components/schemas/updateConference" + $ref: '#/components/schemas/updateConference' updateConferenceBxmlRequest: required: true content: @@ -10005,59 +10005,59 @@ components: content: application/json: schema: - $ref: "#/components/schemas/updateConferenceMember" + $ref: '#/components/schemas/updateConferenceMember' codeRequest: description: MFA code request body. required: true content: application/json: schema: - $ref: "#/components/schemas/codeRequest" + $ref: '#/components/schemas/codeRequest' codeVerify: description: MFA code verify request body. required: true content: application/json: schema: - $ref: "#/components/schemas/verifyCodeRequest" + $ref: '#/components/schemas/verifyCodeRequest' createSyncLookupRequest: description: Synchronous phone number lookup request. required: true content: application/json: schema: - $ref: "#/components/schemas/syncLookupRequest" + $ref: '#/components/schemas/syncLookupRequest' examples: singleNumberRequestExample: - $ref: "#/components/examples/singleNumberRequestExample" + $ref: '#/components/examples/singleNumberRequestExample' multipleNumberRequestExample: - $ref: "#/components/examples/multipleNumberRequestExample" + $ref: '#/components/examples/multipleNumberRequestExample' rcsAgentRequestExample: - $ref: "#/components/examples/rcsAgentRequestExample" + $ref: '#/components/examples/rcsAgentRequestExample' createAsyncBulkLookupRequest: description: Asynchronous bulk phone number lookup request. required: true content: application/json: schema: - $ref: "#/components/schemas/asyncLookupRequest" + $ref: '#/components/schemas/asyncLookupRequest' examples: multipleNumberRequestExample: - $ref: "#/components/examples/multipleNumberRequestExample" + $ref: '#/components/examples/multipleNumberRequestExample' requestTollFreeVerificationRequest: description: Request for verification of a toll-free phone number. required: true content: application/json: schema: - $ref: "#/components/schemas/verificationRequest" + $ref: '#/components/schemas/verificationRequest' updateTollFreeVerificationRequestRequest: description: Update a request for verification of a toll-free phone number. required: true content: application/json: schema: - $ref: "#/components/schemas/tfvSubmissionWrapper" + $ref: '#/components/schemas/tfvSubmissionWrapper' verificationWebhookRequest: description: Verification callback status of a toll-free phone number. required: true @@ -10065,10 +10065,10 @@ components: application/json: schema: oneOf: - - $ref: "#/components/schemas/verificationWebhook" - - $ref: "#/components/schemas/verificationDenialWebhook" - - $ref: "#/components/schemas/failureWebhook" - - $ref: "#/components/schemas/blockedWebhook" + - $ref: '#/components/schemas/verificationWebhook' + - $ref: '#/components/schemas/verificationDenialWebhook' + - $ref: '#/components/schemas/failureWebhook' + - $ref: '#/components/schemas/blockedWebhook' webhookSubscriptionRequest: description: >- Information about a webhook that Bandwidth should send upon the @@ -10077,16 +10077,16 @@ components: content: application/json: schema: - $ref: "#/components/schemas/webhookSubscriptionRequestSchema" + $ref: '#/components/schemas/webhookSubscriptionRequestSchema' createEndpointRequest: required: true content: application/json: schema: - $ref: "#/components/schemas/createEndpointRequest" + $ref: '#/components/schemas/createEndpointRequest' examples: createWebRtcEndpointRequestExample: - $ref: "#/components/examples/createWeRtcEndpointExample" + $ref: '#/components/examples/createWeRtcEndpointExample' updateEndpointBxmlRequest: required: true content: @@ -10101,21 +10101,10 @@ components: documentation](/docs/voice/bxml/). examples: updateEndpointBxmlRequestExample: - $ref: "#/components/examples/updateEndpointBxmlRequestExample" - securitySchemes: - OAuth2: - type: oauth2 - description: >- - OAuth2 client credentials. For information on obtaining credentials, see - [Credentials - Management](https://dev.bandwidth.com/docs/account/credentials/management/). - flows: - clientCredentials: - tokenUrl: https://api.bandwidth.com/api/v1/oauth2/token - scopes: {} + $ref: '#/components/examples/updateEndpointBxmlRequestExample' callbacks: inboundCallback: - "{inboundCallbackUrl}": + '{inboundCallbackUrl}': post: requestBody: required: true @@ -10142,21 +10131,21 @@ components: content: application/json: schema: - $ref: "#/components/schemas/inboundCallback" + $ref: '#/components/schemas/inboundCallback' examples: smsMessageReceivedCallback: - $ref: "#/components/examples/smsMessageReceivedCallbackExample" + $ref: '#/components/examples/smsMessageReceivedCallbackExample' mmsMessageReceivedCallback: - $ref: "#/components/examples/mmsMessageReceivedCallbackExample" + $ref: '#/components/examples/mmsMessageReceivedCallbackExample' rbmMessageReceivedSessionCallback: - $ref: "#/components/examples/rbmMessageReceivedSessionCallbackExample" + $ref: '#/components/examples/rbmMessageReceivedSessionCallbackExample' responses: - "200": + '200': description: OK - "202": + '202': description: Accepted statusCallback: - "{statusCallbackUrl}": + '{statusCallbackUrl}': post: requestBody: required: true @@ -10173,30 +10162,30 @@ components: content: application/json: schema: - $ref: "#/components/schemas/statusCallback" + $ref: '#/components/schemas/statusCallback' examples: messageSendingCallback: - $ref: "#/components/examples/messageSendingCallbackExample" + $ref: '#/components/examples/messageSendingCallbackExample' messageSentCallback: - $ref: "#/components/examples/messageSentCallbackExample" + $ref: '#/components/examples/messageSentCallbackExample' smsMessageDeliveredCallback: - $ref: "#/components/examples/smsMessageDeliveredCallbackExample" + $ref: '#/components/examples/smsMessageDeliveredCallbackExample' mmsMessageDeliveredCallback: - $ref: "#/components/examples/mmsMessageDeliveredCallbackExample" + $ref: '#/components/examples/mmsMessageDeliveredCallbackExample' groupMmsMessageDeliveredCallback: - $ref: "#/components/examples/groupMmsMessageDeliveredCallbackExample" + $ref: '#/components/examples/groupMmsMessageDeliveredCallbackExample' rbmMessageDeliveredSessionCallback: - $ref: "#/components/examples/rbmMessageDeliveredSessionCallbackExample" + $ref: '#/components/examples/rbmMessageDeliveredSessionCallbackExample' rbmMessageDeliveredCanInitiateSessionCallback: - $ref: "#/components/examples/rbmMessageDeliveredCanInitiateSessionCallbackExample" + $ref: '#/components/examples/rbmMessageDeliveredCanInitiateSessionCallbackExample' messageFailedCallback: - $ref: "#/components/examples/messageFailedCallbackExample" + $ref: '#/components/examples/messageFailedCallbackExample' sessionStartedCallback: - $ref: "#/components/examples/sessionStartedCallbackExample" + $ref: '#/components/examples/sessionStartedCallbackExample' responses: - "200": + '200': description: OK - "202": + '202': description: Accepted tfVerificationStatus: your_url.com/webhookService: @@ -10218,39 +10207,39 @@ components: schema: type: string requestBody: - $ref: "#/components/requestBodies/verificationWebhookRequest" + $ref: '#/components/requestBodies/verificationWebhookRequest' responses: - "204": - $ref: "#/components/responses/noContentResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '204': + $ref: '#/components/responses/noContentResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' endpointEvent: - "{request.body#/eventCallbackUrl}": + '{request.body#/eventCallbackUrl}': post: requestBody: content: application/json: schema: - $ref: "#/components/schemas/endpointEvent" + $ref: '#/components/schemas/endpointEvent' examples: endpointDisconnectedEventExample: - $ref: "#/components/examples/endpointDisconnectedEventExample" + $ref: '#/components/examples/endpointDisconnectedEventExample' responses: - "204": + '204': description: Event was successfully received. securitySchemes: OAuth2: