From 4f8fdb58ddd4229d8af8ca8b2989bc1d012d8db3 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 28 Jul 2026 14:53:07 +0000 Subject: [PATCH] Generate SDK with OpenAPI Generator Version --- bandwidth.yml | 136 +++++++++++++-------- docs/MediaApi.md | 16 +-- docs/MessagesApi.md | 8 +- docs/MultiChannelApi.md | 4 +- docs/RbmActionBase.md | 2 +- docs/RbmSuggestionResponse.md | 2 +- lib/bandwidth-sdk/api/media_api.rb | 16 +-- lib/bandwidth-sdk/api/messages_api.rb | 8 +- lib/bandwidth-sdk/api/multi_channel_api.rb | 4 +- 9 files changed, 117 insertions(+), 79 deletions(-) diff --git a/bandwidth.yml b/bandwidth.yml index 305a40b7..8764a422 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -317,7 +317,7 @@ paths: approximately in order, but exact ordering is not guaranteed. operationId: createCall parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' requestBody: $ref: '#/components/requestBodies/createCallRequest' responses: @@ -358,7 +358,7 @@ paths: days, you will get an empty array [] in response. operationId: listCalls parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/to' - $ref: '#/components/parameters/from' - $ref: '#/components/parameters/minStartTimeCalls' @@ -404,7 +404,7 @@ paths: 7 days, you will get an HTTP 404 response. operationId: getCallState parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' responses: '200': @@ -434,7 +434,7 @@ paths: BXML document. operationId: updateCall parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' requestBody: $ref: '#/components/requestBodies/updateCallRequest' @@ -468,7 +468,7 @@ paths: description: Interrupts and replaces an active call's BXML document. operationId: updateCallBxml parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' requestBody: $ref: '#/components/requestBodies/updateCallBxmlRequest' @@ -510,7 +510,7 @@ paths: of conference records. operationId: listConferences parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/minCreatedTime' - $ref: '#/components/parameters/maxCreatedTime' @@ -544,7 +544,7 @@ paths: description: Returns information about the specified conference. operationId: getConference parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' responses: '200': @@ -572,7 +572,7 @@ paths: description: Update the conference state. operationId: updateConference parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' requestBody: $ref: '#/components/requestBodies/updateConferenceRequest' @@ -604,7 +604,7 @@ paths: description: Update the conference BXML document. operationId: updateConferenceBxml parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' requestBody: $ref: '#/components/requestBodies/updateConferenceBxmlRequest' @@ -636,7 +636,7 @@ paths: description: Returns information about the specified conference member. operationId: getConferenceMember parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' - $ref: '#/components/parameters/memberId' responses: @@ -665,7 +665,7 @@ paths: description: Updates settings for a particular conference member. operationId: updateConferenceMember parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' - $ref: '#/components/parameters/memberId' requestBody: @@ -700,7 +700,7 @@ paths: took place during the specified conference. operationId: listConferenceRecordings parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' responses: '200': @@ -730,7 +730,7 @@ paths: description: Returns metadata for the specified recording. operationId: getConferenceRecording parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' - $ref: '#/components/parameters/recordingId' responses: @@ -761,7 +761,7 @@ paths: description: Downloads the specified recording file. operationId: downloadConferenceRecording parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/conferenceId' - $ref: '#/components/parameters/recordingId' responses: @@ -801,7 +801,7 @@ paths: empty if no recordings match the specified criteria. operationId: listAccountCallRecordings parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/to' - $ref: '#/components/parameters/from' - $ref: '#/components/parameters/minStartTime' @@ -834,7 +834,7 @@ paths: description: Pause or resume a recording on an active phone call. operationId: updateCallRecordingState parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' requestBody: $ref: '#/components/requestBodies/updateCallRecordingRequest' @@ -868,7 +868,7 @@ paths: that took place during the specified call. operationId: listCallRecordings parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' responses: '200': @@ -898,7 +898,7 @@ paths: description: Returns metadata for the specified recording. operationId: getCallRecording parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/recordingId' responses: @@ -935,7 +935,7 @@ paths: irreversible, can take an additional 24 to 48 hours. operationId: deleteRecording parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/recordingId' responses: @@ -966,7 +966,7 @@ paths: description: Downloads the specified recording. operationId: downloadCallRecording parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/recordingId' responses: @@ -995,7 +995,7 @@ paths: description: Deletes the specified recording's media. operationId: deleteRecordingMedia parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/recordingId' responses: @@ -1038,7 +1038,7 @@ paths: item. operationId: getRecordingTranscription parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/recordingId' responses: @@ -1073,7 +1073,7 @@ paths: less than 4 hours. operationId: transcribeCallRecording parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/recordingId' requestBody: @@ -1111,7 +1111,7 @@ paths: can take an additional 24 to 48 hours. operationId: deleteRecordingTranscription parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/recordingId' responses: @@ -1142,7 +1142,7 @@ paths: description: Returns details about the current state of the account. operationId: getStatistics parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' responses: '200': $ref: '#/components/responses/getStatisticsResponse' @@ -1173,7 +1173,7 @@ paths: [startTranscription](/docs/voice/bxml/startTranscription). operationId: listRealTimeTranscriptions parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' responses: '200': @@ -1205,7 +1205,7 @@ paths: [startTranscription](/docs/voice/bxml/startTranscription). operationId: getRealTimeTranscription parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/transcriptionId' responses: @@ -1242,7 +1242,7 @@ paths: can take an additional 24 to 48 hours. operationId: deleteRealTimeTranscription parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/transcriptionId' responses: @@ -1273,7 +1273,7 @@ paths: description: Send an MFA Code via a phone call. operationId: generateVoiceCode parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId2' requestBody: $ref: '#/components/requestBodies/codeRequest' responses: @@ -1298,7 +1298,7 @@ paths: description: Send an MFA code via text message (SMS). operationId: generateMessagingCode parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId2' requestBody: $ref: '#/components/requestBodies/codeRequest' responses: @@ -1321,7 +1321,7 @@ paths: description: Verify a previously sent MFA code. operationId: verifyCode parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId2' requestBody: $ref: '#/components/requestBodies/codeVerify' responses: @@ -1348,7 +1348,7 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/accountId3' requestBody: $ref: '#/components/requestBodies/createSyncLookupRequest' responses: @@ -1371,7 +1371,7 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/accountId3' requestBody: $ref: '#/components/requestBodies/createAsyncBulkLookupRequest' responses: @@ -1391,7 +1391,7 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/accountId3' - $ref: '#/components/parameters/requestId' responses: '200': @@ -1407,7 +1407,7 @@ paths: description: Submit a request for verification of a toll-free phone number. operationId: requestTollFreeVerification parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' requestBody: $ref: '#/components/requestBodies/requestTollFreeVerificationRequest' responses: @@ -1446,7 +1446,7 @@ paths: available. operationId: getTollFreeVerificationStatus parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' - $ref: '#/components/parameters/tfPhoneNumberPathParam' responses: '200': @@ -1479,7 +1479,7 @@ paths: true). operationId: updateTollFreeVerificationRequest parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' - $ref: '#/components/parameters/tfPhoneNumberPathParam' requestBody: $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest' @@ -1507,7 +1507,7 @@ paths: description: Delete a toll-free verification submission for a toll-free number. operationId: deleteVerificationRequest parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' - $ref: '#/components/parameters/tfPhoneNumberPathParam' responses: '204': @@ -1546,7 +1546,7 @@ paths: object will be null). operationId: listWebhookSubscriptions parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' responses: '200': $ref: '#/components/responses/listWebhookSubscriptionsResponse' @@ -1579,7 +1579,7 @@ paths: modify or delete the subscription at a later time. operationId: createWebhookSubscription parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' requestBody: $ref: '#/components/requestBodies/webhookSubscriptionRequest' responses: @@ -1610,7 +1610,7 @@ paths: description: Delete a webhook subscription by ID. operationId: deleteWebhookSubscription parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' responses: '204': @@ -1640,7 +1640,7 @@ paths: `basicAuthentication` can be updated). operationId: updateWebhookSubscription parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId4' - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' requestBody: $ref: '#/components/requestBodies/webhookSubscriptionRequest' @@ -1699,7 +1699,7 @@ paths: description: Returns a list of endpoints associated with the specified account. operationId: listEndpoints parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId5' - $ref: '#/components/parameters/endpointType' - $ref: '#/components/parameters/endpointStatus' - $ref: '#/components/parameters/afterCursor' @@ -1730,7 +1730,7 @@ paths: description: Creates a new Endpoint for the specified account. operationId: createEndpoint parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId5' requestBody: $ref: '#/components/requestBodies/createEndpointRequest' responses: @@ -1766,7 +1766,7 @@ paths: description: Returns information about the specified endpoint. operationId: getEndpoint parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId5' - $ref: '#/components/parameters/endpointId' responses: '200': @@ -1796,7 +1796,7 @@ paths: media, the media stream will be terminated. operationId: deleteEndpoint parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId5' - $ref: '#/components/parameters/endpointId' responses: '204': @@ -1826,7 +1826,7 @@ paths: description: Updates the BXML for the specified endpoint. operationId: updateEndpointBxml parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId5' - $ref: '#/components/parameters/endpointId' requestBody: $ref: '#/components/requestBodies/updateEndpointBxmlRequest' @@ -8164,7 +8164,13 @@ components: required: true schema: type: string - description: Your Bandwidth Account ID. + description: > + This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth + App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. + + + **When migrating to OAuth authentication, you must use the 7-digit + Account ID.** example: '9900000' mediaId: in: path @@ -8456,6 +8462,14 @@ components: example: true schema: type: boolean + accountId1: + name: accountId + in: path + required: true + schema: + type: string + description: Your Bandwidth Account ID. + example: '9900000' callId: name: callId in: path @@ -8623,7 +8637,15 @@ components: type: string description: Filter results to calls with specified call Disconnect Cause. example: hangup - accountId1: + accountId2: + in: path + name: accountId + required: true + schema: + type: string + description: Your Bandwidth Account ID. + example: '9900000' + accountId3: in: path name: accountId required: true @@ -8640,6 +8662,14 @@ components: format: uuid description: The phone number lookup request ID from Bandwidth. example: 004223a0-8b17-41b1-bf81-20732adf5590 + accountId4: + in: path + name: accountId + required: true + schema: + type: string + description: Your Bandwidth Account ID. + example: '9900000' tfPhoneNumberPathParam: in: path name: phoneNumber @@ -8656,6 +8686,14 @@ components: type: string description: Webhook subscription ID example: 7bt57JcsVYJrN9K1OcV1Nu + accountId5: + in: path + name: accountId + required: true + schema: + type: string + description: Your Bandwidth Account ID. + example: '9900000' endpointId: name: endpointId in: path diff --git a/docs/MediaApi.md b/docs/MediaApi.md index 7cc81308..8cad64bb 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -34,7 +34,7 @@ Bandwidth.configure do |config| end api_instance = Bandwidth::MediaApi.new -account_id = '9900000' # String | Your Bandwidth Account ID. +account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve. begin @@ -67,7 +67,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your Bandwidth Account ID. | | +| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | | | **media_id** | **String** | Media ID to retrieve. | | ### Return type @@ -108,7 +108,7 @@ Bandwidth.configure do |config| end api_instance = Bandwidth::MediaApi.new -account_id = '9900000' # String | Your Bandwidth Account ID. +account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve. begin @@ -142,7 +142,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your Bandwidth Account ID. | | +| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | | | **media_id** | **String** | Media ID to retrieve. | | ### Return type @@ -183,7 +183,7 @@ Bandwidth.configure do |config| end api_instance = Bandwidth::MediaApi.new -account_id = '9900000' # String | Your Bandwidth Account ID. +account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** opts = { continuation_token: '1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39' # String | Continuation token used to retrieve subsequent media. } @@ -219,7 +219,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your Bandwidth Account ID. | | +| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | | | **continuation_token** | **String** | Continuation token used to retrieve subsequent media. | [optional] | ### Return type @@ -260,7 +260,7 @@ Bandwidth.configure do |config| end api_instance = Bandwidth::MediaApi.new -account_id = '9900000' # String | Your Bandwidth Account ID. +account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve. body = File.new('/path/to/some/file') # File | opts = { @@ -298,7 +298,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your Bandwidth Account ID. | | +| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | | | **media_id** | **String** | Media ID to retrieve. | | | **body** | **File** | | | | **content_type** | **String** | The media type of the entity-body. | [optional] | diff --git a/docs/MessagesApi.md b/docs/MessagesApi.md index 3ab595ee..4aa303ae 100644 --- a/docs/MessagesApi.md +++ b/docs/MessagesApi.md @@ -32,7 +32,7 @@ Bandwidth.configure do |config| end api_instance = Bandwidth::MessagesApi.new -account_id = '9900000' # String | Your Bandwidth Account ID. +account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** message_request = Bandwidth::MessageRequest.new({application_id: '93de2206-9669-4e07-948d-329f4b722ee2', to: ["+15554443333", "+15552223333"], from: '+15551113333'}) # MessageRequest | begin @@ -66,7 +66,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your Bandwidth Account ID. | | +| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | | | **message_request** | [**MessageRequest**](MessageRequest.md) | | | ### Return type @@ -107,7 +107,7 @@ Bandwidth.configure do |config| end api_instance = Bandwidth::MessagesApi.new -account_id = '9900000' # String | Your Bandwidth Account ID. +account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** opts = { message_id: '9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6', # String | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. source_tn: '%2B15554443333', # String | The phone number that sent the message. Accepted values are: a 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'). @@ -169,7 +169,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your Bandwidth Account ID. | | +| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | | | **message_id** | **String** | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. | [optional] | | **source_tn** | **String** | The phone number that sent the message. Accepted values are: a 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'). | [optional] | | **destination_tn** | **String** | The phone number that received the message. Accepted values are: a 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'). | [optional] | diff --git a/docs/MultiChannelApi.md b/docs/MultiChannelApi.md index 0d45bf96..2bfbe583 100644 --- a/docs/MultiChannelApi.md +++ b/docs/MultiChannelApi.md @@ -31,7 +31,7 @@ Bandwidth.configure do |config| end api_instance = Bandwidth::MultiChannelApi.new -account_id = '9900000' # String | Your Bandwidth Account ID. +account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** multi_channel_message_request = Bandwidth::MultiChannelMessageRequest.new({to: '+15552223333', channel_list: [Bandwidth::MultiChannelChannelListRequestObject.new({from: 'BandwidthRBM', application_id: '93de2206-9669-4e07-948d-329f4b722ee2', channel: Bandwidth::MultiChannelMessageChannelEnum::RBM, content: Bandwidth::MmsMessageContent.new})]}) # MultiChannelMessageRequest | begin @@ -65,7 +65,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your Bandwidth Account ID. | | +| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | | | **multi_channel_message_request** | [**MultiChannelMessageRequest**](MultiChannelMessageRequest.md) | | | ### Return type diff --git a/docs/RbmActionBase.md b/docs/RbmActionBase.md index a2a7d78c..a1b3d9ae 100644 --- a/docs/RbmActionBase.md +++ b/docs/RbmActionBase.md @@ -16,7 +16,7 @@ require 'bandwidth-sdk' instance = Bandwidth::RbmActionBase.new( type: null, text: Hello world, - postback_data: [B@3dabdd11 + postback_data: [B@1ecf784f ) ``` diff --git a/docs/RbmSuggestionResponse.md b/docs/RbmSuggestionResponse.md index 6494287e..27f74e68 100644 --- a/docs/RbmSuggestionResponse.md +++ b/docs/RbmSuggestionResponse.md @@ -15,7 +15,7 @@ require 'bandwidth-sdk' instance = Bandwidth::RbmSuggestionResponse.new( text: Yes, I would like to proceed, - postback_data: [B@3dabdd11, + postback_data: [B@1ecf784f, paired_message_id: 1752697342534u24xerqdukke523x ) ``` diff --git a/lib/bandwidth-sdk/api/media_api.rb b/lib/bandwidth-sdk/api/media_api.rb index c6c8cdfa..89c5de8f 100644 --- a/lib/bandwidth-sdk/api/media_api.rb +++ b/lib/bandwidth-sdk/api/media_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Delete Media # Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [nil] @@ -32,7 +32,7 @@ def delete_media(account_id, media_id, opts = {}) # Delete Media # Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -90,7 +90,7 @@ def delete_media_with_http_info(account_id, media_id, opts = {}) # Get Media # Downloads a media file you previously uploaded. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [File] @@ -101,7 +101,7 @@ def get_media(account_id, media_id, opts = {}) # Get Media # Downloads a media file you previously uploaded. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param media_id [String] Media ID to retrieve. # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers @@ -159,7 +159,7 @@ def get_media_with_http_info(account_id, media_id, opts = {}) # List Media # Gets a list of your media files. No query parameters are supported. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param [Hash] opts the optional parameters # @option opts [String] :continuation_token Continuation token used to retrieve subsequent media. # @return [Array] @@ -170,7 +170,7 @@ def list_media(account_id, opts = {}) # List Media # Gets a list of your media files. No query parameters are supported. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param [Hash] opts the optional parameters # @option opts [String] :continuation_token Continuation token used to retrieve subsequent media. # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers @@ -225,7 +225,7 @@ def list_media_with_http_info(account_id, opts = {}) # Upload Media # Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param media_id [String] Media ID to retrieve. # @param body [File] # @param [Hash] opts the optional parameters @@ -239,7 +239,7 @@ def upload_media(account_id, media_id, body, opts = {}) # Upload Media # Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param media_id [String] Media ID to retrieve. # @param body [File] # @param [Hash] opts the optional parameters diff --git a/lib/bandwidth-sdk/api/messages_api.rb b/lib/bandwidth-sdk/api/messages_api.rb index 6d18f4c4..7bbaa670 100644 --- a/lib/bandwidth-sdk/api/messages_api.rb +++ b/lib/bandwidth-sdk/api/messages_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Create Message # Endpoint for sending text messages and picture messages using V2 messaging. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param message_request [MessageRequest] # @param [Hash] opts the optional parameters # @return [Message] @@ -32,7 +32,7 @@ def create_message(account_id, message_request, opts = {}) # Create Message # Endpoint for sending text messages and picture messages using V2 messaging. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param message_request [MessageRequest] # @param [Hash] opts the optional parameters # @return [Array<(Message, Integer, Hash)>] Message data, response status code and response headers @@ -95,7 +95,7 @@ def create_message_with_http_info(account_id, message_request, opts = {}) # List Messages # Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param [Hash] opts the optional parameters # @option opts [String] :message_id The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. # @option opts [String] :source_tn The phone number that sent the message. Accepted values are: a 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'). @@ -132,7 +132,7 @@ def list_messages(account_id, opts = {}) # List Messages # Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param [Hash] opts the optional parameters # @option opts [String] :message_id The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. # @option opts [String] :source_tn The phone number that sent the message. Accepted values are: a 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'). diff --git a/lib/bandwidth-sdk/api/multi_channel_api.rb b/lib/bandwidth-sdk/api/multi_channel_api.rb index 04b771e2..18a0d28d 100644 --- a/lib/bandwidth-sdk/api/multi_channel_api.rb +++ b/lib/bandwidth-sdk/api/multi_channel_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Create Multi-Channel Message # Endpoint for sending Multi-Channel messages. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param multi_channel_message_request [MultiChannelMessageRequest] # @param [Hash] opts the optional parameters # @return [CreateMultiChannelMessageResponse] @@ -32,7 +32,7 @@ def create_multi_channel_message(account_id, multi_channel_message_request, opts # Create Multi-Channel Message # Endpoint for sending Multi-Channel messages. - # @param account_id [String] Your Bandwidth Account ID. + # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** # @param multi_channel_message_request [MultiChannelMessageRequest] # @param [Hash] opts the optional parameters # @return [Array<(CreateMultiChannelMessageResponse, Integer, Hash)>] CreateMultiChannelMessageResponse data, response status code and response headers