diff --git a/api/openapi.yaml b/api/openapi.yaml index 7bb41d49..64bfb417 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -31,7 +31,10 @@ paths: description: Gets a list of your media files. No query parameters are supported. operationId: listMedia parameters: - - 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" explode: false in: path @@ -131,7 +134,10 @@ paths: file with the same name. operationId: deleteMedia parameters: - - 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" explode: false in: path @@ -209,7 +215,10 @@ paths: description: Downloads a media file you previously uploaded. operationId: getMedia parameters: - - 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" explode: false in: path @@ -299,7 +308,10 @@ paths: 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). operationId: uploadMedia parameters: - - 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" explode: false in: path @@ -406,7 +418,10 @@ paths: **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. operationId: listMessages parameters: - - 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" explode: false in: path @@ -762,7 +777,10 @@ paths: messaging. operationId: createMessage parameters: - - 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" explode: false in: path @@ -851,7 +869,10 @@ paths: description: Endpoint for sending Multi-Channel messages. operationId: createMultiChannelMessage parameters: - - 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" explode: false in: path @@ -7329,7 +7350,10 @@ components: code: "500" parameters: accountId: - 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" explode: false in: path @@ -7672,6 +7696,16 @@ components: schema: type: boolean style: form + accountId1: + description: Your Bandwidth Account ID. + example: "9900000" + explode: false + in: path + name: accountId + required: true + schema: + type: string + style: simple callId: description: Programmable Voice API Call ID. example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 @@ -7867,7 +7901,17 @@ components: schema: type: string style: form - accountId1: + accountId2: + description: Your Bandwidth Account ID. + example: "9900000" + explode: false + in: path + name: accountId + required: true + schema: + type: string + style: simple + accountId3: explode: false in: path name: accountId @@ -7888,6 +7932,16 @@ components: format: uuid type: string style: simple + accountId4: + description: Your Bandwidth Account ID. + example: "9900000" + explode: false + in: path + name: accountId + required: true + schema: + type: string + style: simple tfPhoneNumberPathParam: description: Valid Toll-Free telephone number in E.164 format. example: "+18885555555" @@ -7908,6 +7962,16 @@ components: schema: type: string style: simple + accountId5: + description: Your Bandwidth Account ID. + example: "9900000" + explode: false + in: path + name: accountId + required: true + schema: + type: string + style: simple endpointId: description: BRTC Endpoint ID. explode: false 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 d5cef70d..cebc97b8 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -43,7 +43,7 @@ public class Example { OAuth2.setAccessToken("YOUR ACCESS TOKEN"); MediaApi apiInstance = new MediaApi(defaultClient); - String accountId = "9900000"; // String | Your Bandwidth Account ID. + String accountId = "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.** String mediaId = "14762070468292kw2fuqty55yp2b2/0/bw.png"; // String | Media ID to retrieve. try { apiInstance.deleteMedia(accountId, mediaId); @@ -62,7 +62,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **accountId** | **String**| Your Bandwidth Account ID. | | +| **accountId** | **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.** | | | **mediaId** | **String**| Media ID to retrieve. | | ### Return type @@ -124,7 +124,7 @@ public class Example { OAuth2.setAccessToken("YOUR ACCESS TOKEN"); MediaApi apiInstance = new MediaApi(defaultClient); - String accountId = "9900000"; // String | Your Bandwidth Account ID. + String accountId = "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.** String mediaId = "14762070468292kw2fuqty55yp2b2/0/bw.png"; // String | Media ID to retrieve. try { File result = apiInstance.getMedia(accountId, mediaId); @@ -144,7 +144,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **accountId** | **String**| Your Bandwidth Account ID. | | +| **accountId** | **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.** | | | **mediaId** | **String**| Media ID to retrieve. | | ### Return type @@ -206,7 +206,7 @@ public class Example { OAuth2.setAccessToken("YOUR ACCESS TOKEN"); MediaApi apiInstance = new MediaApi(defaultClient); - String accountId = "9900000"; // String | Your Bandwidth Account ID. + String accountId = "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.** String continuationToken = "1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39"; // String | Continuation token used to retrieve subsequent media. try { List result = apiInstance.listMedia(accountId, continuationToken); @@ -226,7 +226,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **accountId** | **String**| Your Bandwidth Account ID. | | +| **accountId** | **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.** | | | **continuationToken** | **String**| Continuation token used to retrieve subsequent media. | [optional] | ### Return type @@ -288,7 +288,7 @@ public class Example { OAuth2.setAccessToken("YOUR ACCESS TOKEN"); MediaApi apiInstance = new MediaApi(defaultClient); - String accountId = "9900000"; // String | Your Bandwidth Account ID. + String accountId = "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.** String mediaId = "14762070468292kw2fuqty55yp2b2/0/bw.png"; // String | Media ID to retrieve. File body = new File("/path/to/file"); // File | String contentType = "audio/wav"; // String | The media type of the entity-body. @@ -310,7 +310,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **accountId** | **String**| Your Bandwidth Account ID. | | +| **accountId** | **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.** | | | **mediaId** | **String**| Media ID to retrieve. | | | **body** | **File**| | | | **contentType** | **String**| The media type of the entity-body. | [optional] | diff --git a/docs/MessagesApi.md b/docs/MessagesApi.md index df40f8f0..3880d82b 100644 --- a/docs/MessagesApi.md +++ b/docs/MessagesApi.md @@ -41,7 +41,7 @@ public class Example { OAuth2.setAccessToken("YOUR ACCESS TOKEN"); MessagesApi apiInstance = new MessagesApi(defaultClient); - String accountId = "9900000"; // String | Your Bandwidth Account ID. + String accountId = "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.** MessageRequest messageRequest = new MessageRequest(); // MessageRequest | try { Message result = apiInstance.createMessage(accountId, messageRequest); @@ -61,7 +61,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **accountId** | **String**| Your Bandwidth Account ID. | | +| **accountId** | **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.** | | | **messageRequest** | [**MessageRequest**](MessageRequest.md)| | | ### Return type @@ -124,7 +124,7 @@ public class Example { OAuth2.setAccessToken("YOUR ACCESS TOKEN"); MessagesApi apiInstance = new MessagesApi(defaultClient); - String accountId = "9900000"; // String | Your Bandwidth Account ID. + String accountId = "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.** String messageId = "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. String sourceTn = "%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'). String destinationTn = "%2B15554443333"; // 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'). @@ -170,7 +170,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **accountId** | **String**| Your Bandwidth Account ID. | | +| **accountId** | **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.** | | | **messageId** | **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] | | **sourceTn** | **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] | | **destinationTn** | **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 39d4040b..92db7c65 100644 --- a/docs/MultiChannelApi.md +++ b/docs/MultiChannelApi.md @@ -40,7 +40,7 @@ public class Example { OAuth2.setAccessToken("YOUR ACCESS TOKEN"); MultiChannelApi apiInstance = new MultiChannelApi(defaultClient); - String accountId = "9900000"; // String | Your Bandwidth Account ID. + String accountId = "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.** MultiChannelMessageRequest multiChannelMessageRequest = new MultiChannelMessageRequest(); // MultiChannelMessageRequest | try { CreateMultiChannelMessageResponse result = apiInstance.createMultiChannelMessage(accountId, multiChannelMessageRequest); @@ -60,7 +60,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **accountId** | **String**| Your Bandwidth Account ID. | | +| **accountId** | **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.** | | | **multiChannelMessageRequest** | [**MultiChannelMessageRequest**](MultiChannelMessageRequest.md)| | | ### Return type diff --git a/src/main/java/com/bandwidth/sdk/api/MediaApi.java b/src/main/java/com/bandwidth/sdk/api/MediaApi.java index e0737284..a59de0ff 100644 --- a/src/main/java/com/bandwidth/sdk/api/MediaApi.java +++ b/src/main/java/com/bandwidth/sdk/api/MediaApi.java @@ -76,7 +76,7 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for deleteMedia - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -161,7 +161,7 @@ private okhttp3.Call deleteMediaValidateBeforeCall(@javax.annotation.Nonnull Str /** * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -186,7 +186,7 @@ public void deleteMedia(@javax.annotation.Nonnull String accountId, @javax.annot /** * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -213,7 +213,7 @@ public ApiResponse deleteMediaWithHttpInfo(@javax.annotation.Nonnull Strin /** * Delete Media (asynchronously) * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -241,7 +241,7 @@ public okhttp3.Call deleteMediaAsync(@javax.annotation.Nonnull String accountId, } /** * Build call for getMedia - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -327,7 +327,7 @@ private okhttp3.Call getMediaValidateBeforeCall(@javax.annotation.Nonnull String /** * Get Media * Downloads a media file you previously uploaded. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -354,7 +354,7 @@ public File getMedia(@javax.annotation.Nonnull String accountId, @javax.annotati /** * Get Media * Downloads a media file you previously uploaded. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -382,7 +382,7 @@ public ApiResponse getMediaWithHttpInfo(@javax.annotation.Nonnull String a /** * Get Media (asynchronously) * Downloads a media file you previously uploaded. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -411,7 +411,7 @@ public okhttp3.Call getMediaAsync(@javax.annotation.Nonnull String accountId, @j } /** * Build call for listMedia - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param continuationToken Continuation token used to retrieve subsequent media. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -495,7 +495,7 @@ private okhttp3.Call listMediaValidateBeforeCall(@javax.annotation.Nonnull Strin /** * List Media * Gets a list of your media files. No query parameters are supported. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param continuationToken Continuation token used to retrieve subsequent media. (optional) * @return List<Media> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -522,7 +522,7 @@ public List listMedia(@javax.annotation.Nonnull String accountId, @javax. /** * List Media * Gets a list of your media files. No query parameters are supported. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param continuationToken Continuation token used to retrieve subsequent media. (optional) * @return ApiResponse<List<Media>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -550,7 +550,7 @@ public ApiResponse> listMediaWithHttpInfo(@javax.annotation.Nonnull /** * List Media (asynchronously) * Gets a list of your media files. No query parameters are supported. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param continuationToken Continuation token used to retrieve subsequent media. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -579,7 +579,7 @@ public okhttp3.Call listMediaAsync(@javax.annotation.Nonnull String accountId, @ } /** * Build call for uploadMedia - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param body (required) * @param contentType The media type of the entity-body. (optional) @@ -730,7 +730,7 @@ private okhttp3.Call uploadMediaValidateBeforeCall(@javax.annotation.Nonnull Str /** * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param body (required) * @param contentType The media type of the entity-body. (optional) @@ -758,7 +758,7 @@ public void uploadMedia(@javax.annotation.Nonnull String accountId, @javax.annot /** * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param body (required) * @param contentType The media type of the entity-body. (optional) @@ -788,7 +788,7 @@ public ApiResponse uploadMediaWithHttpInfo(@javax.annotation.Nonnull Strin /** * Upload Media (asynchronously) * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param mediaId Media ID to retrieve. (required) * @param body (required) * @param contentType The media type of the entity-body. (optional) diff --git a/src/main/java/com/bandwidth/sdk/api/MessagesApi.java b/src/main/java/com/bandwidth/sdk/api/MessagesApi.java index 052fbc78..3d5ec114 100644 --- a/src/main/java/com/bandwidth/sdk/api/MessagesApi.java +++ b/src/main/java/com/bandwidth/sdk/api/MessagesApi.java @@ -82,7 +82,7 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for createMessage - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageRequest (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -168,7 +168,7 @@ private okhttp3.Call createMessageValidateBeforeCall(@javax.annotation.Nonnull S /** * Create Message * Endpoint for sending text messages and picture messages using V2 messaging. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageRequest (required) * @return Message * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -196,7 +196,7 @@ public Message createMessage(@javax.annotation.Nonnull String accountId, @javax. /** * Create Message * Endpoint for sending text messages and picture messages using V2 messaging. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageRequest (required) * @return ApiResponse<Message> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -225,7 +225,7 @@ public ApiResponse createMessageWithHttpInfo(@javax.annotation.Nonnull /** * Create Message (asynchronously) * Endpoint for sending text messages and picture messages using V2 messaging. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageRequest (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -255,7 +255,7 @@ public okhttp3.Call createMessageAsync(@javax.annotation.Nonnull String accountI } /** * Build call for listMessages - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageId 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) * @param sourceTn 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) * @param destinationTn 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) @@ -468,7 +468,7 @@ private okhttp3.Call listMessagesValidateBeforeCall(@javax.annotation.Nonnull St /** * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageId 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) * @param sourceTn 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) * @param destinationTn 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) @@ -521,7 +521,7 @@ public MessagesList listMessages(@javax.annotation.Nonnull String accountId, @ja /** * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageId 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) * @param sourceTn 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) * @param destinationTn 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) @@ -575,7 +575,7 @@ public ApiResponse listMessagesWithHttpInfo(@javax.annotation.Nonn /** * List Messages (asynchronously) * 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 accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param messageId 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) * @param sourceTn 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) * @param destinationTn 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/src/main/java/com/bandwidth/sdk/api/MultiChannelApi.java b/src/main/java/com/bandwidth/sdk/api/MultiChannelApi.java index 19487ce3..ca4b51ef 100644 --- a/src/main/java/com/bandwidth/sdk/api/MultiChannelApi.java +++ b/src/main/java/com/bandwidth/sdk/api/MultiChannelApi.java @@ -76,7 +76,7 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for createMultiChannelMessage - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param multiChannelMessageRequest (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -162,7 +162,7 @@ private okhttp3.Call createMultiChannelMessageValidateBeforeCall(@javax.annotati /** * Create Multi-Channel Message * Endpoint for sending Multi-Channel messages. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param multiChannelMessageRequest (required) * @return CreateMultiChannelMessageResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -190,7 +190,7 @@ public CreateMultiChannelMessageResponse createMultiChannelMessage(@javax.annota /** * Create Multi-Channel Message * Endpoint for sending Multi-Channel messages. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param multiChannelMessageRequest (required) * @return ApiResponse<CreateMultiChannelMessageResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -219,7 +219,7 @@ public ApiResponse createMultiChannelMessageW /** * Create Multi-Channel Message (asynchronously) * Endpoint for sending Multi-Channel messages. - * @param accountId Your Bandwidth Account ID. (required) + * @param accountId 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.** (required) * @param multiChannelMessageRequest (required) * @param _callback The callback to be executed when the API call finishes * @return The request call