From 696019c78d587dc19ff6504f4e44dff601257435 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 29 Jul 2025 14:08:42 +0000 Subject: [PATCH 1/6] Generate SDK with OpenAPI Generator Version --- .openapi-generator/FILES | 48 +- api/multi-channel-api.ts | 4 +- api/toll-free-verification-api.ts | 80 ++ bandwidth.yml | 690 +++++++++++++----- base.ts | 6 + docs/Callback.md | 35 + docs/CreateMultiChannelMessageResponse.md | 2 +- docs/ErrorObject.md | 10 +- docs/ErrorSource.md | 27 + docs/InboundCallback.md | 31 + docs/InboundCallbackMessage.md | 50 ++ docs/InboundCallbackTypeEnum.md | 13 + docs/ListMessageItem.md | 2 +- docs/Message.md | 6 +- docs/MessageRequest.md | 2 +- docs/MessagesApi.md | 1 + docs/MmsMessageContent.md | 2 +- docs/MmsMessageContentFile.md | 20 + docs/MultiChannelAction.md | 4 +- docs/MultiChannelActionCalendarEvent.md | 4 +- docs/MultiChannelApi.md | 1 + docs/MultiChannelChannelListObjectContent.md | 2 +- docs/MultiChannelError.md | 24 + docs/MultiChannelMessageContent.md | 23 + docs/MultiChannelMessageResponseData.md | 35 + ...nnelMessageResponseDataChannelListInner.md | 28 + docs/PriorityEnum.md | 2 +- docs/RbmActionBase.md | 4 +- docs/RbmActionDial.md | 4 +- docs/RbmActionOpenUrl.md | 4 +- docs/RbmActionViewLocation.md | 4 +- docs/RbmLocationResponse.md | 22 + docs/RbmSuggestionResponse.md | 22 + docs/StatusCallback.md | 35 + docs/StatusCallbackMessage.md | 45 ++ docs/StatusCallbackTypeEnum.md | 15 + docs/TollFreeVerificationApi.md | 63 ++ models/callback.ts | 36 + .../create-multi-channel-message-response.ts | 6 +- models/error-object.ts | 17 +- models/error-source.ts | 48 ++ models/inbound-callback-message.ts | 44 ++ models/inbound-callback-type-enum.ts | 32 + models/inbound-callback.ts | 68 ++ models/index.ts | 24 +- models/list-message-item.ts | 2 +- models/message-request.ts | 2 +- models/message.ts | 6 +- models/mms-message-content-file.ts | 30 + models/mms-message-content.ts | 9 +- ...lti-channel-channel-list-object-content.ts | 3 + models/multi-channel-error.ts | 48 ++ models/multi-channel-message-content.ts | 39 + ...essage-response-data-channel-list-inner.ts | 32 + models/multi-channel-message-response-data.ts | 83 +++ models/priority-enum.ts | 2 +- models/rbm-action-base.ts | 2 +- models/rbm-location-response.ts | 36 + models/rbm-suggestion-response.ts | 36 + models/status-callback-message.ts | 113 +++ models/status-callback-type-enum.ts | 33 + models/status-callback.ts | 80 ++ 62 files changed, 1956 insertions(+), 245 deletions(-) create mode 100644 docs/Callback.md create mode 100644 docs/ErrorSource.md create mode 100644 docs/InboundCallback.md create mode 100644 docs/InboundCallbackMessage.md create mode 100644 docs/InboundCallbackTypeEnum.md create mode 100644 docs/MmsMessageContentFile.md create mode 100644 docs/MultiChannelError.md create mode 100644 docs/MultiChannelMessageContent.md create mode 100644 docs/MultiChannelMessageResponseData.md create mode 100644 docs/MultiChannelMessageResponseDataChannelListInner.md create mode 100644 docs/RbmLocationResponse.md create mode 100644 docs/RbmSuggestionResponse.md create mode 100644 docs/StatusCallback.md create mode 100644 docs/StatusCallbackMessage.md create mode 100644 docs/StatusCallbackTypeEnum.md create mode 100644 models/callback.ts create mode 100644 models/error-source.ts create mode 100644 models/inbound-callback-message.ts create mode 100644 models/inbound-callback-type-enum.ts create mode 100644 models/inbound-callback.ts create mode 100644 models/mms-message-content-file.ts create mode 100644 models/multi-channel-error.ts create mode 100644 models/multi-channel-message-content.ts create mode 100644 models/multi-channel-message-response-data-channel-list-inner.ts create mode 100644 models/multi-channel-message-response-data.ts create mode 100644 models/rbm-location-response.ts create mode 100644 models/rbm-suggestion-response.ts create mode 100644 models/status-callback-message.ts create mode 100644 models/status-callback-type-enum.ts create mode 100644 models/status-callback.ts diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 5866ce2..26bb222 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -31,8 +31,8 @@ docs/CallTranscriptionDetectedLanguageEnum.md docs/CallTranscriptionMetadata.md docs/CallTranscriptionResponse.md docs/CallTranscriptionTrackEnum.md +docs/Callback.md docs/CallbackMethodEnum.md -docs/CallbackTypeEnum.md docs/CallsApi.md docs/CardWidthEnum.md docs/CodeRequest.md @@ -53,16 +53,19 @@ docs/CreateCallResponse.md docs/CreateLookupResponse.md docs/CreateMessageRequestError.md docs/CreateMultiChannelMessageResponse.md -docs/DeferredResult.md docs/DisconnectCallback.md docs/Diversion.md docs/DtmfCallback.md docs/Error.md docs/ErrorObject.md +docs/ErrorSource.md docs/FailureWebhook.md docs/FieldError.md docs/FileFormatEnum.md docs/GatherCallback.md +docs/InboundCallback.md +docs/InboundCallbackMessage.md +docs/InboundCallbackTypeEnum.md docs/InitiateCallback.md docs/Link.md docs/LinksObject.md @@ -80,8 +83,6 @@ docs/MachineDetectionResult.md docs/Media.md docs/MediaApi.md docs/Message.md -docs/MessageCallback.md -docs/MessageCallbackMessage.md docs/MessageDirectionEnum.md docs/MessageRequest.md docs/MessageStatusEnum.md @@ -94,18 +95,18 @@ docs/MfaForbiddenRequestError.md docs/MfaRequestError.md docs/MfaUnauthorizedRequestError.md docs/MmsMessageContent.md +docs/MmsMessageContentFile.md docs/MultiChannelAction.md docs/MultiChannelActionCalendarEvent.md docs/MultiChannelApi.md -docs/MultiChannelCallbackData.md docs/MultiChannelChannelListObject.md docs/MultiChannelChannelListObjectContent.md -docs/MultiChannelMessageCallbackData.md +docs/MultiChannelError.md docs/MultiChannelMessageChannelEnum.md -docs/MultiChannelMessageData.md -docs/MultiChannelMessageDirectionEnum.md +docs/MultiChannelMessageContent.md docs/MultiChannelMessageRequest.md -docs/MultiChannelStatusEnum.md +docs/MultiChannelMessageResponseData.md +docs/MultiChannelMessageResponseDataChannelListInner.md docs/OptInWorkflow.md docs/PageInfo.md docs/PhoneNumberLookupApi.md @@ -117,6 +118,7 @@ docs/RbmActionTypeEnum.md docs/RbmActionViewLocation.md docs/RbmCardContent.md docs/RbmCardContentMedia.md +docs/RbmLocationResponse.md docs/RbmMediaHeightEnum.md docs/RbmMessageCarouselCard.md docs/RbmMessageContentFile.md @@ -124,6 +126,7 @@ docs/RbmMessageContentRichCard.md docs/RbmMessageContentText.md docs/RbmMessageMedia.md docs/RbmStandaloneCard.md +docs/RbmSuggestionResponse.md docs/RecordingAvailableCallback.md docs/RecordingCompleteCallback.md docs/RecordingStateEnum.md @@ -135,6 +138,9 @@ docs/RedirectMethodEnum.md docs/SmsMessageContent.md docs/StandaloneCardOrientationEnum.md docs/StatisticsApi.md +docs/StatusCallback.md +docs/StatusCallbackMessage.md +docs/StatusCallbackTypeEnum.md docs/StirShaken.md docs/TelephoneNumber.md docs/TfvBasicAuthentication.md @@ -190,7 +196,7 @@ models/call-transcription-response.ts models/call-transcription-track-enum.ts models/call-transcription.ts models/callback-method-enum.ts -models/callback-type-enum.ts +models/callback.ts models/card-width-enum.ts models/code-request.ts models/conference-completed-callback.ts @@ -209,15 +215,18 @@ models/create-call.ts models/create-lookup-response.ts models/create-message-request-error.ts models/create-multi-channel-message-response.ts -models/deferred-result.ts models/disconnect-callback.ts models/diversion.ts models/dtmf-callback.ts models/error-object.ts +models/error-source.ts models/failure-webhook.ts models/field-error.ts models/file-format-enum.ts models/gather-callback.ts +models/inbound-callback-message.ts +models/inbound-callback-type-enum.ts +models/inbound-callback.ts models/index.ts models/initiate-callback.ts models/link.ts @@ -233,8 +242,6 @@ models/machine-detection-configuration.ts models/machine-detection-mode-enum.ts models/machine-detection-result.ts models/media.ts -models/message-callback-message.ts -models/message-callback.ts models/message-direction-enum.ts models/message-request.ts models/message-status-enum.ts @@ -246,19 +253,19 @@ models/messaging-request-error.ts models/mfa-forbidden-request-error.ts models/mfa-request-error.ts models/mfa-unauthorized-request-error.ts +models/mms-message-content-file.ts models/mms-message-content.ts models/model-error.ts models/multi-channel-action-calendar-event.ts models/multi-channel-action.ts -models/multi-channel-callback-data.ts models/multi-channel-channel-list-object-content.ts models/multi-channel-channel-list-object.ts -models/multi-channel-message-callback-data.ts +models/multi-channel-error.ts models/multi-channel-message-channel-enum.ts -models/multi-channel-message-data.ts -models/multi-channel-message-direction-enum.ts +models/multi-channel-message-content.ts models/multi-channel-message-request.ts -models/multi-channel-status-enum.ts +models/multi-channel-message-response-data-channel-list-inner.ts +models/multi-channel-message-response-data.ts models/opt-in-workflow.ts models/page-info.ts models/priority-enum.ts @@ -269,6 +276,7 @@ models/rbm-action-type-enum.ts models/rbm-action-view-location.ts models/rbm-card-content-media.ts models/rbm-card-content.ts +models/rbm-location-response.ts models/rbm-media-height-enum.ts models/rbm-message-carousel-card.ts models/rbm-message-content-file.ts @@ -276,6 +284,7 @@ models/rbm-message-content-rich-card.ts models/rbm-message-content-text.ts models/rbm-message-media.ts models/rbm-standalone-card.ts +models/rbm-suggestion-response.ts models/recording-available-callback.ts models/recording-complete-callback.ts models/recording-state-enum.ts @@ -285,6 +294,9 @@ models/redirect-callback.ts models/redirect-method-enum.ts models/sms-message-content.ts models/standalone-card-orientation-enum.ts +models/status-callback-message.ts +models/status-callback-type-enum.ts +models/status-callback.ts models/stir-shaken.ts models/telephone-number.ts models/tfv-basic-authentication.ts diff --git a/api/multi-channel-api.ts b/api/multi-channel-api.ts index 58da7bb..c94ebaa 100644 --- a/api/multi-channel-api.ts +++ b/api/multi-channel-api.ts @@ -22,11 +22,9 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore -import type { CreateMessageRequestError } from '../models'; -// @ts-ignore import type { CreateMultiChannelMessageResponse } from '../models'; // @ts-ignore -import type { MessagingRequestError } from '../models'; +import type { MultiChannelError } from '../models'; // @ts-ignore import type { MultiChannelMessageRequest } from '../models'; /** diff --git a/api/toll-free-verification-api.ts b/api/toll-free-verification-api.ts index 3d9e645..6b77001 100644 --- a/api/toll-free-verification-api.ts +++ b/api/toll-free-verification-api.ts @@ -85,6 +85,48 @@ export const TollFreeVerificationApiAxiosParamCreator = function (configuration? options: localVarRequestOptions, }; }, + /** + * Delete a toll-free verification submission for a toll-free number. + * @summary Delete a Toll-Free Verification Submission + * @param {string} accountId Your Bandwidth Account ID. + * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteVerificationRequest: async (accountId: string, phoneNumber: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accountId' is not null or undefined + assertParamExists('deleteVerificationRequest', 'accountId', accountId) + // verify required parameter 'phoneNumber' is not null or undefined + assertParamExists('deleteVerificationRequest', 'phoneNumber', phoneNumber) + const localVarPath = `/accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))) + .replace(`{${"phoneNumber"}}`, encodeURIComponent(String(phoneNumber))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription @@ -405,6 +447,20 @@ export const TollFreeVerificationApiFp = function(configuration?: Configuration) const localVarOperationServerBasePath = operationServerMap['TollFreeVerificationApi.createWebhookSubscription']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Delete a toll-free verification submission for a toll-free number. + * @summary Delete a Toll-Free Verification Submission + * @param {string} accountId Your Bandwidth Account ID. + * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteVerificationRequest(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVerificationRequest(accountId, phoneNumber, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TollFreeVerificationApi.deleteVerificationRequest']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription @@ -523,6 +579,17 @@ export const TollFreeVerificationApiFactory = function (configuration?: Configur createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createWebhookSubscription(accountId, webhookSubscriptionRequestSchema, options).then((request) => request(axios, basePath)); }, + /** + * Delete a toll-free verification submission for a toll-free number. + * @summary Delete a Toll-Free Verification Submission + * @param {string} accountId Your Bandwidth Account ID. + * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteVerificationRequest(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteVerificationRequest(accountId, phoneNumber, options).then((request) => request(axios, basePath)); + }, /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription @@ -622,6 +689,19 @@ export class TollFreeVerificationApi extends BaseAPI { return TollFreeVerificationApiFp(this.configuration).createWebhookSubscription(accountId, webhookSubscriptionRequestSchema, options).then((request) => request(this.axios, this.basePath)); } + /** + * Delete a toll-free verification submission for a toll-free number. + * @summary Delete a Toll-Free Verification Submission + * @param {string} accountId Your Bandwidth Account ID. + * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TollFreeVerificationApi + */ + public deleteVerificationRequest(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig) { + return TollFreeVerificationApiFp(this.configuration).deleteVerificationRequest(accountId, phoneNumber, options).then((request) => request(this.axios, this.basePath)); + } + /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription diff --git a/bandwidth.yml b/bandwidth.yml index 0376964..4b3681c 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -223,6 +223,8 @@ paths: $ref: '#/components/responses/messagingForbiddenError' '404': $ref: '#/components/responses/messagingNotFoundError' + '405': + $ref: '#/components/responses/messagingMethodNotAllowedError' '406': $ref: '#/components/responses/messagingNotAcceptableError' '415': @@ -250,24 +252,26 @@ paths: '202': $ref: '#/components/responses/createMultiChannelMessageResponse' '400': - $ref: '#/components/responses/createMessageBadRequestError' + $ref: '#/components/responses/multiChannelBadRequestError' '401': - $ref: '#/components/responses/messagingUnauthorizedError' + $ref: '#/components/responses/multiChannelUnauthorizedError' '403': - $ref: '#/components/responses/messagingForbiddenError' + $ref: '#/components/responses/multiChannelForbiddenError' '404': - $ref: '#/components/responses/messagingNotFoundError' + $ref: '#/components/responses/multiChannelNotFoundError' + '405': + $ref: '#/components/responses/multiChannelMethodNotAllowedError' '406': - $ref: '#/components/responses/messagingNotAcceptableError' + $ref: '#/components/responses/multiChannelNotAcceptableError' '415': - $ref: '#/components/responses/messagingInvalidMediaTypeError' + $ref: '#/components/responses/multiChannelInvalidMediaTypeError' '429': - $ref: '#/components/responses/messagingTooManyRequestsError' + $ref: '#/components/responses/multiChannelTooManyRequestsError' '500': - $ref: '#/components/responses/messagingInternalServerError' + $ref: '#/components/responses/multiChannelInternalServerError' callbacks: - multiChannelCallback: - $ref: '#/components/callbacks/multiChannelMessageCallback' + statusCallback: + $ref: '#/components/callbacks/statusCallback' x-badges: - name: Beta color: '#076EA8' @@ -1471,6 +1475,34 @@ paths: callbacks: tfVerificationStatus: $ref: '#/components/callbacks/tfVerificationStatus' + delete: + description: Delete a toll-free verification submission for a toll-free number. + operationId: deleteVerificationRequest + parameters: + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/tfPhoneNumberPathParam' + responses: + '204': + $ref: '#/components/responses/noContentResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' + summary: Delete a Toll-Free Verification Submission + tags: + - Toll-Free Verification servers: *ref_4 /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions: get: @@ -1554,7 +1586,7 @@ paths: - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' responses: '204': - description: No Content + $ref: '#/components/responses/noContentResponse' '400': $ref: '#/components/responses/tfvBadRequestResponse' '401': @@ -1639,24 +1671,12 @@ components: The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. example: 93de2206-9669-4e07-948d-329f4b722ee2 - callbackTypeEnum: - type: string - enum: - - message-received - - message-sending - - message-delivered - - message-failed - description: > - Indicates the type of the callback: - - - `message-received` for inbound callbacks. - - - One of `message-sending`, `message-delivered`, `message-failed` for - status callbacks. - example: message-delivered priorityEnum: type: string - description: The priority specified by the user. + description: >- + Specifies the message's sending priority with respect to other messages + in your account. For best results and optimal throughput, reserve the + 'high' priority setting for critical messages only. enum: - default - high @@ -1753,9 +1773,7 @@ components: messageType: $ref: '#/components/schemas/messageTypeEnum' segmentCount: - type: integer - description: The number of segments the message was sent as. - example: 1 + $ref: '#/components/schemas/segmentCount' errorCode: type: integer description: The numeric error code of the message. @@ -1863,6 +1881,12 @@ components: type: integer mediaName: type: string + segmentCount: + type: integer + description: >- + The number of segments the user's message is broken into before sending + over carrier networks. + example: 1 tag: title: Tag type: string @@ -1870,14 +1894,6 @@ components: A custom string that will be included in callback events of the message. Max 1024 characters. example: custom string - deferredResult: - title: DeferredResult - type: object - properties: - result: - type: object - setOrExpired: - type: boolean expiration: type: string format: date-time @@ -1887,6 +1903,16 @@ components: 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. example: '2021-02-01T11:29:18-05:00' + carrierName: + type: string + description: >- + The name of the Authorized Message Provider (AMP) that handled this + message. + + In the US, this is the carrier that the message was sent to. + + This field is present only when this account feature has been enabled. + example: AT&T message: title: Message type: object @@ -1900,20 +1926,14 @@ components: description: The Bandwidth phone number associated with the message. example: '+15554443333' applicationId: - type: string - description: The application ID associated with the message. - example: 93de2206-9669-4e07-948d-329f4b722ee2 + $ref: '#/components/schemas/applicationId' time: type: string format: date-time description: The datetime stamp of the message in ISO 8601 example: 2024-12-02T20:15:57.278Z segmentCount: - type: integer - description: >- - The number of segments the original message from the user is broken - into before sending over to carrier networks. - example: 2 + $ref: '#/components/schemas/segmentCount' direction: $ref: '#/components/schemas/messageDirectionEnum' to: @@ -1945,9 +1965,7 @@ components: description: The contents of the message. example: Hello world tag: - type: string - description: The custom string set by the user. - example: custom tag + $ref: '#/components/schemas/tag' priority: $ref: '#/components/schemas/priorityEnum' expiration: @@ -1961,11 +1979,7 @@ components: - from properties: applicationId: - type: string - description: >- - The ID of the Application your from number is associated with in the - Bandwidth Phone Number Dashboard. - example: 93de2206-9669-4e07-948d-329f4b722ee2 + $ref: '#/components/schemas/applicationId' to: uniqueItems: true type: array @@ -2021,12 +2035,69 @@ components: type: array items: $ref: '#/components/schemas/link' + example: [] + data: + $ref: '#/components/schemas/multiChannelMessageResponseData' + errors: + type: array + items: + $ref: '#/components/schemas/errorObject' + example: [] + multiChannelError: + type: object + properties: + links: + type: array + items: + $ref: '#/components/schemas/link' + example: [] data: - $ref: '#/components/schemas/multiChannelMessageData' + type: object + nullable: true + example: null errors: type: array items: $ref: '#/components/schemas/errorObject' + link: + type: object + properties: + rel: + type: string + href: + type: string + errorObject: + type: object + properties: + type: + description: A concise summary of the error used for categorization. + type: string + description: + description: A detailed explanation of the error. + type: string + source: + $ref: '#/components/schemas/errorSource' + required: + - type + - description + - source + errorSource: + title: Error Source + type: object + description: Specifies relevant sources of the error, if any. + properties: + parameter: + type: string + description: The relevant URI query parameter causing the error + field: + type: string + description: The request body field that led to the error + header: + type: string + description: The header field that contributed to the error + reference: + type: string + description: A resource ID or path linked to the error multiChannelMessageChannelEnum: description: The channel of the multi-channel message. type: string @@ -2035,12 +2106,6 @@ components: - SMS - MMS example: RBM - multiChannelMessageDirectionEnum: - type: string - enum: - - INBOUND - - OUTBOUND - example: OUTBOUND multiChannelSenderId: type: string description: The sender ID of the message. This could be an alphanumeric sender ID. @@ -2049,6 +2114,14 @@ components: type: string description: The phone number the message should be sent to in E164 format. example: '+15552223333' + multiChannelDestinations: + uniqueItems: true + type: array + description: The destination phone number(s) of the message, in E164 format. + example: + - '+15554443333' + items: + type: string rbmMessageContentText: title: RBM Text type: object @@ -2090,6 +2163,26 @@ components: maxLength: 1000 required: - fileUrl + mmsMessageContentFile: + title: MMS Media File + type: object + properties: + fileUrl: + type: string + format: uri + description: >- + The URL of a media attachment. + + + For MMS, the API limits file size to 3.5MB. Specific carriers and + channels may have a smaller limit that could cause a large file to + fail, see + [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) + for more details. + example: https://dev.bandwidth.com/images/bandwidth-logo.png + maxLength: 1000 + required: + - fileUrl rbmMessageMedia: title: RBM Media type: object @@ -2198,7 +2291,9 @@ components: text: $ref: '#/components/schemas/messageText' media: - $ref: '#/components/schemas/messageMedia' + type: array + items: + $ref: '#/components/schemas/mmsMessageContentFile' rbmMessageContentRichCard: title: RBM Rich Card oneOf: @@ -2220,7 +2315,7 @@ components: description: Displayed text for user to click maxLength: 25 example: Hello world - rbmActionPostBackData: + rbmActionPostbackData: title: Post Back Data type: string format: byte @@ -2234,11 +2329,11 @@ components: $ref: '#/components/schemas/rbmActionTypeEnum' text: $ref: '#/components/schemas/rbmActionText' - postBackData: - $ref: '#/components/schemas/rbmActionPostBackData' + postbackData: + $ref: '#/components/schemas/rbmActionPostbackData' required: - text - - postBackData + - postbackData - type rbmActionDial: allOf: @@ -2342,14 +2437,6 @@ components: CREATE_CALENDAR_EVENT: '#/components/schemas/multiChannelActionCalendarEvent' OPEN_URL: '#/components/schemas/rbmActionOpenUrl' REQUEST_LOCATION: '#/components/schemas/rbmActionBase' - multiChannelStatusEnum: - type: string - enum: - - QUEUED - - SENDING - - DELIVERED - - FAILED - example: DELIVERED multiChannelChannelListObject: type: object properties: @@ -2396,141 +2483,250 @@ components: required: - to - channelList - multiChannelMessageCallbackData: - type: object - properties: - messageId: - $ref: '#/components/schemas/messageId' - status: - $ref: '#/components/schemas/multiChannelStatusEnum' - direction: - $ref: '#/components/schemas/multiChannelMessageDirectionEnum' - from: - $ref: '#/components/schemas/multiChannelSenderId' - to: - $ref: '#/components/schemas/multiChannelDestination' - applicationId: - $ref: '#/components/schemas/applicationId' - channel: - $ref: '#/components/schemas/multiChannelMessageChannelEnum' - tag: - $ref: '#/components/schemas/tag' - multiChannelMessageData: + multiChannelMessageResponseData: + description: The data returned in a multichannel message response. type: object properties: messageId: $ref: '#/components/schemas/messageId' - status: - $ref: '#/components/schemas/multiChannelStatusEnum' time: description: The time the message was received by the Bandwidth API. type: string format: date-time example: 2025-01-01T18:20:16.000Z direction: - $ref: '#/components/schemas/multiChannelMessageDirectionEnum' - from: - $ref: '#/components/schemas/multiChannelSenderId' + $ref: '#/components/schemas/messageDirectionEnum' to: - $ref: '#/components/schemas/multiChannelDestination' - applicationId: - $ref: '#/components/schemas/applicationId' - channel: - $ref: '#/components/schemas/multiChannelMessageChannelEnum' + $ref: '#/components/schemas/multiChannelDestinations' + channelList: + type: array + description: >- + A list of message bodies. The messages will be attempted in the + order they are listed. Once a message sends successfully, the others + will be ignored. + items: + allOf: + - $ref: '#/components/schemas/multiChannelChannelListObject' + - type: object + properties: + owner: + type: string + description: >- + The Bandwidth senderId associated with the message. + Identical to 'from'. + required: + - owner + maxItems: 4 tag: $ref: '#/components/schemas/tag' - multiChannelCallbackData: + priority: + $ref: '#/components/schemas/priorityEnum' + expiration: + $ref: '#/components/schemas/expiration' + required: + - messageId + - time + - direction + - to + - channelList + multiChannelMessageContent: + description: The structure of the content field of a multichannel message. type: object properties: - time: - description: The time of the callback event. - type: string - format: date-time - example: 2025-01-01T18:20:16.000Z - type: - $ref: '#/components/schemas/multiChannelStatusEnum' - to: - $ref: '#/components/schemas/multiChannelDestination' - description: + text: type: string - example: Incoming message received - message: - $ref: '#/components/schemas/multiChannelMessageCallbackData' - link: + media: + $ref: '#/components/schemas/rbmMessageContentFile' + rbmSuggestionResponse: type: object properties: - rel: - type: string - href: + text: type: string - errorObject: + description: The text associated with the suggestion response. + example: Yes, I would like to proceed + postbackData: + $ref: '#/components/schemas/rbmActionPostbackData' + rbmLocationResponse: type: object properties: - code: + latitude: type: string - message: + format: double + description: The latitude of the client's location. + example: '37.7749' + longitude: type: string - messageCallback: - description: Message Callback Schema + format: double + description: The longitude of the client's location. + example: '-122.4194' + callback: + description: >- + Callbacks are divided into two types based on direction of the related + message: + + - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM + message. + + - `inboundCallback` indicates an inbound MO message or a multichannel + message client's response to a suggestion or location request. + type: object + oneOf: + - $ref: '#/components/schemas/statusCallback' + - $ref: '#/components/schemas/inboundCallback' + discriminator: + propertyName: type + mapping: + message-sent: '#/components/schemas/statusCallback' + message-delivered: '#/components/schemas/statusCallback' + message-failed: '#/components/schemas/statusCallback' + message-read: '#/components/schemas/statusCallback' + message-received: '#/components/schemas/inboundCallback' + request-location-response: '#/components/schemas/inboundCallback' + suggestion-response: '#/components/schemas/inboundCallback' + statusCallback: type: object + description: >- + Represents a status callback for an outbound MT SMS or MMS or RBM + message. properties: time: type: string format: date-time example: 2024-12-02T20:15:57.278Z + eventTime: + type: string + description: >- + Represents the time at which the message was read, for + `message-read` callbacks. + format: date-time + example: 2024-12-02T20:15:58.278Z type: - $ref: '#/components/schemas/callbackTypeEnum' + $ref: '#/components/schemas/statusCallbackTypeEnum' to: type: string + description: >- + The destination phone number the message was sent to. + + For status callbacks, this the the Bandwidth user's client phone + number. example: '+15552223333' description: type: string description: A detailed description of the event described by the callback. - example: rejected-unallocated-from-number + example: Message delivered to carrier. message: - $ref: '#/components/schemas/messageCallbackMessage' + $ref: '#/components/schemas/statusCallbackMessage' errorCode: type: integer description: Optional error code, applicable only when type is `message-failed`. - nullable: true example: 4405 carrierName: + $ref: '#/components/schemas/carrierName' + required: + - time + - type + - to + - description + - message + inboundCallback: + type: object + description: Represents an inbound callback. + properties: + time: type: string - description: >- - The name of the Authorized Message Provider (AMP) that handled this - message. In the US, this is the carrier that the message was sent - to. - nullable: true - example: AT&T + format: date-time + example: 2024-12-02T20:15:57.278Z + type: + $ref: '#/components/schemas/inboundCallbackTypeEnum' + to: + type: string + description: > + The destination phone number the message was sent to. + + For inbound callbacks, this is the Bandwidth number or alphanumeric + identifier that received the message. + example: '+15552223333' + description: + type: string + description: A detailed description of the event described by the callback. + example: Incoming message received + message: + $ref: '#/components/schemas/inboundCallbackMessage' + carrierName: + $ref: '#/components/schemas/carrierName' required: - time - type - to - description - message - messageCallbackMessage: - description: Message payload schema within a MessageCallback + statusCallbackTypeEnum: + type: string + description: >- + The possible status callbacks when sending an MT SMS or MMS or RBM + message: + + - `message-sending` indicates that Bandwidth is sending the message to + the upstream provider. + + - `message-delivered` indicates that the message was successfully sent. + + - `message-failed` indicates that the message could not be sent to the + intended recipient. + + - `message-read` indicates that the RBM message was read by the + recipient. + enum: + - message-sending + - message-delivered + - message-failed + - message-read + example: message-delivered + inboundCallbackTypeEnum: + type: string + description: >- + The possible inbound callback types originating from MO messages or + multichannel message client responses: + + - `message-received` indicates an MO message from a Bandwidth user's + client to a Bandwidth number. + + - `request-location-response` indicates a response to a location request + sent by the Bandwidth user's client after receiving an RBM message. + + - `suggestion-response` indicates a response to a suggestion sent by the + Bandwidth user's client after receiving an RBM message. + enum: + - message-received + - request-location-response + - suggestion-response + example: message-received + statusCallbackMessage: + description: Message payload schema within a callback type: object properties: id: type: string + description: A unique identifier of the message. example: 1661365814859loidf7mcwd4qacn7 owner: type: string + description: >- + The Bandwidth phone number or alphanumeric identifier associated + with the message. example: '+15553332222' applicationId: - type: string - example: 93de2206-9669-4e07-948d-329f4b722ee2 + $ref: '#/components/schemas/applicationId' time: type: string format: date-time example: 2024-12-02T20:15:57.666Z segmentCount: - type: integer - example: 1 + $ref: '#/components/schemas/segmentCount' direction: $ref: '#/components/schemas/messageDirectionEnum' to: + description: The phone number recipients of the message. uniqueItems: true type: array items: @@ -2539,17 +2735,18 @@ components: - '+15552223333' from: type: string + description: >- + The Bandwidth phone number or alphanumeric identifier the message + was sent from. example: '+15553332222' text: type: string example: Hello world tag: - type: string - example: custom string + $ref: '#/components/schemas/tag' media: type: array - description: Optional media, applicable only for mms - nullable: true + description: Optional media, not applicable for sms items: type: string format: uri @@ -2558,6 +2755,28 @@ components: - https://dev.bandwidth.com/images/github_logo.png priority: $ref: '#/components/schemas/priorityEnum' + channel: + $ref: '#/components/schemas/multiChannelMessageChannelEnum' + required: + - id + - owner + - applicationId + - time + - segmentCount + - direction + - to + - from + inboundCallbackMessage: + allOf: + - $ref: '#/components/schemas/statusCallbackMessage' + - type: object + properties: + content: + $ref: '#/components/schemas/multiChannelMessageContent' + suggestionResponse: + $ref: '#/components/schemas/rbmSuggestionResponse' + locationResponse: + $ref: '#/components/schemas/rbmLocationResponse' required: - id - owner @@ -2567,7 +2786,6 @@ components: - direction - to - from - - text callbackMethodEnum: type: string nullable: true @@ -5954,6 +6172,12 @@ components: application/json: schema: $ref: '#/components/schemas/messagingRequestError' + messagingMethodNotAllowedError: + description: Method Not Allowed + content: + application/json: + schema: + $ref: '#/components/schemas/messagingRequestError' messagingInvalidMediaTypeError: description: Unsupported Media Type content: @@ -5972,6 +6196,120 @@ components: application/json: schema: $ref: '#/components/schemas/messagingRequestError' + multiChannelBadRequestError: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: request-validation + description: >- + The 'channelList[0].from' field must contain exactly one + telephone number + source: + field: channelList[0].from + multiChannelNotAcceptableError: + description: Not Acceptable + multiChannelUnauthorizedError: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: unauthorized + description: Authentication Failed + source: {} + multiChannelForbiddenError: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: forbidden + description: Access Denied + source: {} + multiChannelNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: forbidden + description: Resource not found. + source: {} + multiChannelMethodNotAllowedError: + description: Method Not Allowed + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: method-not-allowed + description: Method 'PUT' not supported for this resource. + source: {} + multiChannelInvalidMediaTypeError: + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: unsupported-content-type + description: >- + Content-Type 'application/xml;charset=UTF-8' is not supported. + Please use 'application/json' + source: + header: Content-Type + multiChannelTooManyRequestsError: + description: Too Many Requests + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: rate-limit-exceeded + description: >- + You have exceeded your rate limit for this endpoint. Please + retry later. + source: {} + multiChannelInternalServerError: + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/multiChannelError' + example: + links: [] + data: null + errors: + - type: internal-server-error + description: Internal server error. No further information available + source: {} createCallResponse: description: Created headers: @@ -6373,6 +6711,8 @@ components: example: description: Cannot process request. type: bad request + noContentResponse: + description: No Content tfvPostBadRequestResponse: description: Bad Request content: @@ -7506,17 +7846,30 @@ components: post: requestBody: required: true - description: > -

This Inbound Message Webhook is an envelope containing a - received (MO) message to your message-enabled Bandwidth telephone - number. The payload type will always indicate "message-received". + description: >- +

This Inbound Message Webhook is an envelope containing either a + received (MO) message to your + + message-enabled Bandwidth telephone number or a multichannel + client's response to a suggestion response + + or location request. + +

The payload type will be one of message-received, + suggestion-response, or + location-request-response. + +

Note that suggestion-response and + location-request-response callback types are + pertinent only for RBM messages sent from the + /messages/multiChannel endpoint.

Please visit Webhooks

content: application/json: schema: - $ref: '#/components/schemas/messageCallback' + $ref: '#/components/schemas/inboundCallback' examples: smsMessageReceivedCallback: $ref: '#/components/examples/smsMessageReceivedCallbackExample' @@ -7525,24 +7878,26 @@ components: responses: '200': description: OK + '202': + description: Accepted statusCallback: '{statusCallbackUrl}': post: requestBody: required: true - description: > + description: >-

This Outbound Message Webhook is an envelope containing status - information regarding a message sent (MT) from your - message-enabled Bandwidth telephone number. The payload type will - be one of "message-sending", "message-delivered", or - "message-failed". + information regarding a message sent (MT) + from your message-enabled Bandwidth telephone number. +

The payload type will be one of message-sending, message-delivered, message-failed or message-read. +

Note that message-read callbacks are pertinent only for RBM messages sent from the /messages/multiChannel endpoint.

Please visit Webhooks

content: application/json: schema: - $ref: '#/components/schemas/messageCallback' + $ref: '#/components/schemas/statusCallback' examples: messageSendingCallback: $ref: '#/components/examples/messageSendingCallbackExample' @@ -7558,19 +7913,8 @@ components: responses: '200': description: OK - multiChannelMessageCallback: - '{multiChannelMessageCallbackUrl}': - post: - requestBody: - required: true - description: Status Callback Payload - content: - application/json: - schema: - $ref: '#/components/schemas/multiChannelCallbackData' - responses: - '204': - description: No Content + '202': + description: Accepted tfVerificationStatus: your_url.com/webhookService: post: @@ -7594,7 +7938,7 @@ components: $ref: '#/components/requestBodies/verificationWebhookRequest' responses: '204': - description: No Content + $ref: '#/components/responses/noContentResponse' '400': $ref: '#/components/responses/tfvBadRequestResponse' '401': diff --git a/base.ts b/base.ts index fa73643..42301da 100644 --- a/base.ts +++ b/base.ts @@ -311,6 +311,12 @@ export const operationServerMap: ServerMap = { description: "Production", } ], + "TollFreeVerificationApi.deleteVerificationRequest": [ + { + url: "https://api.bandwidth.com/api/v2", + description: "Production", + } + ], "TollFreeVerificationApi.deleteWebhookSubscription": [ { url: "https://api.bandwidth.com/api/v2", diff --git a/docs/Callback.md b/docs/Callback.md new file mode 100644 index 0000000..6cbe3b8 --- /dev/null +++ b/docs/Callback.md @@ -0,0 +1,35 @@ +# Callback + +Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **string** | | [default to undefined] +**eventTime** | **string** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] [default to undefined] +**type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined] +**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined] +**description** | **string** | A detailed description of the event described by the callback. | [default to undefined] +**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined] +**errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined] +**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined] + +## Example + +```typescript +import { Callback } from 'bandwidth-sdk'; + +const instance: Callback = { + time, + eventTime, + type, + to, + description, + message, + errorCode, + carrierName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateMultiChannelMessageResponse.md b/docs/CreateMultiChannelMessageResponse.md index 90c8af9..b87b2d5 100644 --- a/docs/CreateMultiChannelMessageResponse.md +++ b/docs/CreateMultiChannelMessageResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**Array<Link>**](Link.md) | | [optional] [default to undefined] -**data** | [**MultiChannelMessageData**](MultiChannelMessageData.md) | | [optional] [default to undefined] +**data** | [**MultiChannelMessageResponseData**](MultiChannelMessageResponseData.md) | | [optional] [default to undefined] **errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] [default to undefined] ## Example diff --git a/docs/ErrorObject.md b/docs/ErrorObject.md index 5bbdd48..23d8865 100644 --- a/docs/ErrorObject.md +++ b/docs/ErrorObject.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **string** | | [optional] [default to undefined] -**message** | **string** | | [optional] [default to undefined] +**type** | **string** | A concise summary of the error used for categorization. | [default to undefined] +**description** | **string** | A detailed explanation of the error. | [default to undefined] +**source** | [**ErrorSource**](ErrorSource.md) | | [default to undefined] ## Example @@ -14,8 +15,9 @@ Name | Type | Description | Notes import { ErrorObject } from 'bandwidth-sdk'; const instance: ErrorObject = { - code, - message, + type, + description, + source, }; ``` diff --git a/docs/ErrorSource.md b/docs/ErrorSource.md new file mode 100644 index 0000000..ef59bad --- /dev/null +++ b/docs/ErrorSource.md @@ -0,0 +1,27 @@ +# ErrorSource + +Specifies relevant sources of the error, if any. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parameter** | **string** | The relevant URI query parameter causing the error | [optional] [default to undefined] +**field** | **string** | The request body field that led to the error | [optional] [default to undefined] +**header** | **string** | The header field that contributed to the error | [optional] [default to undefined] +**reference** | **string** | A resource ID or path linked to the error | [optional] [default to undefined] + +## Example + +```typescript +import { ErrorSource } from 'bandwidth-sdk'; + +const instance: ErrorSource = { + parameter, + field, + header, + reference, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InboundCallback.md b/docs/InboundCallback.md new file mode 100644 index 0000000..c174271 --- /dev/null +++ b/docs/InboundCallback.md @@ -0,0 +1,31 @@ +# InboundCallback + +Represents an inbound callback. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **string** | | [default to undefined] +**type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined] +**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined] +**description** | **string** | A detailed description of the event described by the callback. | [default to undefined] +**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined] +**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined] + +## Example + +```typescript +import { InboundCallback } from 'bandwidth-sdk'; + +const instance: InboundCallback = { + time, + type, + to, + description, + message, + carrierName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InboundCallbackMessage.md b/docs/InboundCallbackMessage.md new file mode 100644 index 0000000..2811afc --- /dev/null +++ b/docs/InboundCallbackMessage.md @@ -0,0 +1,50 @@ +# InboundCallbackMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | A unique identifier of the message. | [default to undefined] +**owner** | **string** | The Bandwidth phone number or alphanumeric identifier associated with the message. | [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined] +**time** | **string** | | [default to undefined] +**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [default to undefined] +**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined] +**to** | **Set<string>** | The phone number recipients of the message. | [default to undefined] +**from** | **string** | The Bandwidth phone number or alphanumeric identifier the message was sent from. | [default to undefined] +**text** | **string** | | [optional] [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] +**media** | **Array<string>** | Optional media, not applicable for sms | [optional] [default to undefined] +**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] +**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined] +**content** | [**MultiChannelMessageContent**](MultiChannelMessageContent.md) | | [optional] [default to undefined] +**suggestionResponse** | [**RbmSuggestionResponse**](RbmSuggestionResponse.md) | | [optional] [default to undefined] +**locationResponse** | [**RbmLocationResponse**](RbmLocationResponse.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { InboundCallbackMessage } from 'bandwidth-sdk'; + +const instance: InboundCallbackMessage = { + id, + owner, + applicationId, + time, + segmentCount, + direction, + to, + from, + text, + tag, + media, + priority, + channel, + content, + suggestionResponse, + locationResponse, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InboundCallbackTypeEnum.md b/docs/InboundCallbackTypeEnum.md new file mode 100644 index 0000000..5e38723 --- /dev/null +++ b/docs/InboundCallbackTypeEnum.md @@ -0,0 +1,13 @@ +# InboundCallbackTypeEnum + +The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message. + +## Enum + +* `MessageReceived` (value: `'message-received'`) + +* `RequestLocationResponse` (value: `'request-location-response'`) + +* `SuggestionResponse` (value: `'suggestion-response'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListMessageItem.md b/docs/ListMessageItem.md index 3fbfc91..f1ef376 100644 --- a/docs/ListMessageItem.md +++ b/docs/ListMessageItem.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **messageStatus** | [**MessageStatusEnum**](MessageStatusEnum.md) | | [optional] [default to undefined] **messageDirection** | [**ListMessageDirectionEnum**](ListMessageDirectionEnum.md) | | [optional] [default to undefined] **messageType** | [**MessageTypeEnum**](MessageTypeEnum.md) | | [optional] [default to undefined] -**segmentCount** | **number** | The number of segments the message was sent as. | [optional] [default to undefined] +**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [optional] [default to undefined] **errorCode** | **number** | The numeric error code of the message. | [optional] [default to undefined] **receiveTime** | **string** | The ISO 8601 datetime of the message. | [optional] [default to undefined] **carrierName** | **string** | The name of the carrier. Not currently supported for MMS coming soon. | [optional] [default to undefined] diff --git a/docs/Message.md b/docs/Message.md index 474e946..7d12a98 100644 --- a/docs/Message.md +++ b/docs/Message.md @@ -7,15 +7,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | The id of the message. | [optional] [default to undefined] **owner** | **string** | The Bandwidth phone number associated with the message. | [optional] [default to undefined] -**applicationId** | **string** | The application ID associated with the message. | [optional] [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined] **time** | **string** | The datetime stamp of the message in ISO 8601 | [optional] [default to undefined] -**segmentCount** | **number** | The number of segments the original message from the user is broken into before sending over to carrier networks. | [optional] [default to undefined] +**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [optional] [default to undefined] **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [optional] [default to undefined] **to** | **Set<string>** | The phone number recipients of the message. | [optional] [default to undefined] **from** | **string** | The phone number the message was sent from. | [optional] [default to undefined] **media** | **Set<string>** | The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. | [optional] [default to undefined] **text** | **string** | The contents of the message. | [optional] [default to undefined] -**tag** | **string** | The custom string set by the user. | [optional] [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] **expiration** | **string** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] [default to undefined] diff --git a/docs/MessageRequest.md b/docs/MessageRequest.md index 4734b8c..02e7e50 100644 --- a/docs/MessageRequest.md +++ b/docs/MessageRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applicationId** | **string** | The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined] **to** | **Set<string>** | The phone number(s) the message should be sent to in E164 format. | [default to undefined] **from** | **string** | Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. | [default to undefined] **text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined] diff --git a/docs/MessagesApi.md b/docs/MessagesApi.md index 22163df..8b8afb1 100644 --- a/docs/MessagesApi.md +++ b/docs/MessagesApi.md @@ -63,6 +63,7 @@ const { status, data } = await apiInstance.createMessage( |**401** | Unauthorized | - | |**403** | Forbidden | - | |**404** | Not Found | - | +|**405** | Method Not Allowed | - | |**406** | Not Acceptable | - | |**415** | Unsupported Media Type | - | |**429** | Too Many Requests | - | diff --git a/docs/MmsMessageContent.md b/docs/MmsMessageContent.md index 1a4e740..9c5e59a 100644 --- a/docs/MmsMessageContent.md +++ b/docs/MmsMessageContent.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined] -**media** | **Array<string>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] [default to undefined] +**media** | [**Array<MmsMessageContentFile>**](MmsMessageContentFile.md) | | [optional] [default to undefined] ## Example diff --git a/docs/MmsMessageContentFile.md b/docs/MmsMessageContentFile.md new file mode 100644 index 0000000..7941f42 --- /dev/null +++ b/docs/MmsMessageContentFile.md @@ -0,0 +1,20 @@ +# MmsMessageContentFile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fileUrl** | **string** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. | [default to undefined] + +## Example + +```typescript +import { MmsMessageContentFile } from 'bandwidth-sdk'; + +const instance: MmsMessageContentFile = { + fileUrl, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelAction.md b/docs/MultiChannelAction.md index dfbd0b6..605d4a7 100644 --- a/docs/MultiChannelAction.md +++ b/docs/MultiChannelAction.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] **text** | **string** | Displayed text for user to click | [default to undefined] -**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] **phoneNumber** | **string** | The phone number to dial. Must be E164 format. | [default to undefined] **latitude** | **number** | The latitude of the location. | [default to undefined] **longitude** | **number** | The longitude of the location. | [default to undefined] @@ -26,7 +26,7 @@ import { MultiChannelAction } from 'bandwidth-sdk'; const instance: MultiChannelAction = { type, text, - postBackData, + postbackData, phoneNumber, latitude, longitude, diff --git a/docs/MultiChannelActionCalendarEvent.md b/docs/MultiChannelActionCalendarEvent.md index fa422da..9252b7c 100644 --- a/docs/MultiChannelActionCalendarEvent.md +++ b/docs/MultiChannelActionCalendarEvent.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] **text** | **string** | Displayed text for user to click | [default to undefined] -**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] **title** | **string** | The title of the event. | [default to undefined] **startTime** | **string** | The start time of the event. | [default to undefined] **endTime** | **string** | The end time of the event. | [default to undefined] @@ -21,7 +21,7 @@ import { MultiChannelActionCalendarEvent } from 'bandwidth-sdk'; const instance: MultiChannelActionCalendarEvent = { type, text, - postBackData, + postbackData, title, startTime, endTime, diff --git a/docs/MultiChannelApi.md b/docs/MultiChannelApi.md index 55ea3a0..8c9fce9 100644 --- a/docs/MultiChannelApi.md +++ b/docs/MultiChannelApi.md @@ -62,6 +62,7 @@ const { status, data } = await apiInstance.createMultiChannelMessage( |**401** | Unauthorized | - | |**403** | Forbidden | - | |**404** | Not Found | - | +|**405** | Method Not Allowed | - | |**406** | Not Acceptable | - | |**415** | Unsupported Media Type | - | |**429** | Too Many Requests | - | diff --git a/docs/MultiChannelChannelListObjectContent.md b/docs/MultiChannelChannelListObjectContent.md index 08539ce..c0e471f 100644 --- a/docs/MultiChannelChannelListObjectContent.md +++ b/docs/MultiChannelChannelListObjectContent.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **text** | **string** | The contents of the text message. Must be 2048 characters or less. | [default to undefined] **suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined] -**media** | **Array<string>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [default to undefined] +**media** | [**Array<MmsMessageContentFile>**](MmsMessageContentFile.md) | | [default to undefined] **orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined] **thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined] **cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined] diff --git a/docs/MultiChannelError.md b/docs/MultiChannelError.md new file mode 100644 index 0000000..abc246c --- /dev/null +++ b/docs/MultiChannelError.md @@ -0,0 +1,24 @@ +# MultiChannelError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Array<Link>**](Link.md) | | [optional] [default to undefined] +**data** | **object** | | [optional] [default to undefined] +**errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelError } from 'bandwidth-sdk'; + +const instance: MultiChannelError = { + links, + data, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageContent.md b/docs/MultiChannelMessageContent.md new file mode 100644 index 0000000..fc96172 --- /dev/null +++ b/docs/MultiChannelMessageContent.md @@ -0,0 +1,23 @@ +# MultiChannelMessageContent + +The structure of the content field of a multichannel message. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **string** | | [optional] [default to undefined] +**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelMessageContent } from 'bandwidth-sdk'; + +const instance: MultiChannelMessageContent = { + text, + media, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageResponseData.md b/docs/MultiChannelMessageResponseData.md new file mode 100644 index 0000000..3588894 --- /dev/null +++ b/docs/MultiChannelMessageResponseData.md @@ -0,0 +1,35 @@ +# MultiChannelMessageResponseData + +The data returned in a multichannel message response. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messageId** | **string** | The ID of the message. | [default to undefined] +**time** | **string** | The time the message was received by the Bandwidth API. | [default to undefined] +**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined] +**to** | **Set<string>** | The destination phone number(s) of the message, in E164 format. | [default to undefined] +**channelList** | [**Array<MultiChannelMessageResponseDataChannelListInner>**](MultiChannelMessageResponseDataChannelListInner.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. | [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] +**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] +**expiration** | **string** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] [default to undefined] + +## Example + +```typescript +import { MultiChannelMessageResponseData } from 'bandwidth-sdk'; + +const instance: MultiChannelMessageResponseData = { + messageId, + time, + direction, + to, + channelList, + tag, + priority, + expiration, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageResponseDataChannelListInner.md b/docs/MultiChannelMessageResponseDataChannelListInner.md new file mode 100644 index 0000000..341ccf1 --- /dev/null +++ b/docs/MultiChannelMessageResponseDataChannelListInner.md @@ -0,0 +1,28 @@ +# MultiChannelMessageResponseDataChannelListInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined] +**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined] +**content** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) | | [default to undefined] +**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined] + +## Example + +```typescript +import { MultiChannelMessageResponseDataChannelListInner } from 'bandwidth-sdk'; + +const instance: MultiChannelMessageResponseDataChannelListInner = { + from, + applicationId, + channel, + content, + owner, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PriorityEnum.md b/docs/PriorityEnum.md index 5d38ab6..c2be7f3 100644 --- a/docs/PriorityEnum.md +++ b/docs/PriorityEnum.md @@ -1,6 +1,6 @@ # PriorityEnum -The priority specified by the user. +Specifies the message\'s sending priority with respect to other messages in your account. For best results and optimal throughput, reserve the \'high\' priority setting for critical messages only. ## Enum diff --git a/docs/RbmActionBase.md b/docs/RbmActionBase.md index d1884a3..7a5d8f8 100644 --- a/docs/RbmActionBase.md +++ b/docs/RbmActionBase.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] **text** | **string** | Displayed text for user to click | [default to undefined] -**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] ## Example @@ -17,7 +17,7 @@ import { RbmActionBase } from 'bandwidth-sdk'; const instance: RbmActionBase = { type, text, - postBackData, + postbackData, }; ``` diff --git a/docs/RbmActionDial.md b/docs/RbmActionDial.md index 35f56e8..334cbc7 100644 --- a/docs/RbmActionDial.md +++ b/docs/RbmActionDial.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] **text** | **string** | Displayed text for user to click | [default to undefined] -**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] **phoneNumber** | **string** | The phone number to dial. Must be E164 format. | [default to undefined] ## Example @@ -18,7 +18,7 @@ import { RbmActionDial } from 'bandwidth-sdk'; const instance: RbmActionDial = { type, text, - postBackData, + postbackData, phoneNumber, }; ``` diff --git a/docs/RbmActionOpenUrl.md b/docs/RbmActionOpenUrl.md index fcb2a01..cfa71d9 100644 --- a/docs/RbmActionOpenUrl.md +++ b/docs/RbmActionOpenUrl.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] **text** | **string** | Displayed text for user to click | [default to undefined] -**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] **url** | **string** | The URL to open in browser. | [default to undefined] ## Example @@ -18,7 +18,7 @@ import { RbmActionOpenUrl } from 'bandwidth-sdk'; const instance: RbmActionOpenUrl = { type, text, - postBackData, + postbackData, url, }; ``` diff --git a/docs/RbmActionViewLocation.md b/docs/RbmActionViewLocation.md index 864e901..1f1ed48 100644 --- a/docs/RbmActionViewLocation.md +++ b/docs/RbmActionViewLocation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined] **text** | **string** | Displayed text for user to click | [default to undefined] -**postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] +**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined] **latitude** | **number** | The latitude of the location. | [default to undefined] **longitude** | **number** | The longitude of the location. | [default to undefined] **label** | **string** | The label of the location. | [optional] [default to undefined] @@ -20,7 +20,7 @@ import { RbmActionViewLocation } from 'bandwidth-sdk'; const instance: RbmActionViewLocation = { type, text, - postBackData, + postbackData, latitude, longitude, label, diff --git a/docs/RbmLocationResponse.md b/docs/RbmLocationResponse.md new file mode 100644 index 0000000..ecb9f24 --- /dev/null +++ b/docs/RbmLocationResponse.md @@ -0,0 +1,22 @@ +# RbmLocationResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**latitude** | **number** | The latitude of the client\'s location. | [optional] [default to undefined] +**longitude** | **number** | The longitude of the client\'s location. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmLocationResponse } from 'bandwidth-sdk'; + +const instance: RbmLocationResponse = { + latitude, + longitude, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RbmSuggestionResponse.md b/docs/RbmSuggestionResponse.md new file mode 100644 index 0000000..9902757 --- /dev/null +++ b/docs/RbmSuggestionResponse.md @@ -0,0 +1,22 @@ +# RbmSuggestionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **string** | The text associated with the suggestion response. | [optional] [default to undefined] +**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [optional] [default to undefined] + +## Example + +```typescript +import { RbmSuggestionResponse } from 'bandwidth-sdk'; + +const instance: RbmSuggestionResponse = { + text, + postbackData, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/StatusCallback.md b/docs/StatusCallback.md new file mode 100644 index 0000000..f428e28 --- /dev/null +++ b/docs/StatusCallback.md @@ -0,0 +1,35 @@ +# StatusCallback + +Represents a status callback for an outbound MT SMS or MMS or RBM message. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **string** | | [default to undefined] +**eventTime** | **string** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] [default to undefined] +**type** | [**StatusCallbackTypeEnum**](StatusCallbackTypeEnum.md) | | [default to undefined] +**to** | **string** | The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user\'s client phone number. | [default to undefined] +**description** | **string** | A detailed description of the event described by the callback. | [default to undefined] +**message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) | | [default to undefined] +**errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined] +**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined] + +## Example + +```typescript +import { StatusCallback } from 'bandwidth-sdk'; + +const instance: StatusCallback = { + time, + eventTime, + type, + to, + description, + message, + errorCode, + carrierName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/StatusCallbackMessage.md b/docs/StatusCallbackMessage.md new file mode 100644 index 0000000..817e62e --- /dev/null +++ b/docs/StatusCallbackMessage.md @@ -0,0 +1,45 @@ +# StatusCallbackMessage + +Message payload schema within a callback + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | A unique identifier of the message. | [default to undefined] +**owner** | **string** | The Bandwidth phone number or alphanumeric identifier associated with the message. | [default to undefined] +**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined] +**time** | **string** | | [default to undefined] +**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [default to undefined] +**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined] +**to** | **Set<string>** | The phone number recipients of the message. | [default to undefined] +**from** | **string** | The Bandwidth phone number or alphanumeric identifier the message was sent from. | [default to undefined] +**text** | **string** | | [optional] [default to undefined] +**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] +**media** | **Array<string>** | Optional media, not applicable for sms | [optional] [default to undefined] +**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] +**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { StatusCallbackMessage } from 'bandwidth-sdk'; + +const instance: StatusCallbackMessage = { + id, + owner, + applicationId, + time, + segmentCount, + direction, + to, + from, + text, + tag, + media, + priority, + channel, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/StatusCallbackTypeEnum.md b/docs/StatusCallbackTypeEnum.md new file mode 100644 index 0000000..eef4f90 --- /dev/null +++ b/docs/StatusCallbackTypeEnum.md @@ -0,0 +1,15 @@ +# StatusCallbackTypeEnum + +The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient. + +## Enum + +* `MessageSending` (value: `'message-sending'`) + +* `MessageDelivered` (value: `'message-delivered'`) + +* `MessageFailed` (value: `'message-failed'`) + +* `MessageRead` (value: `'message-read'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TollFreeVerificationApi.md b/docs/TollFreeVerificationApi.md index 4460458..c4f0e6a 100644 --- a/docs/TollFreeVerificationApi.md +++ b/docs/TollFreeVerificationApi.md @@ -5,6 +5,7 @@ All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**createWebhookSubscription**](#createwebhooksubscription) | **POST** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription| +|[**deleteVerificationRequest**](#deleteverificationrequest) | **DELETE** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Delete a Toll-Free Verification Submission| |[**deleteWebhookSubscription**](#deletewebhooksubscription) | **DELETE** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription| |[**getTollFreeVerificationStatus**](#gettollfreeverificationstatus) | **GET** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status| |[**listTollFreeUseCases**](#listtollfreeusecases) | **GET** /tollFreeVerification/useCases | List Toll-Free Use Cases| @@ -76,6 +77,68 @@ const { status, data } = await apiInstance.createWebhookSubscription( [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **deleteVerificationRequest** +> deleteVerificationRequest() + +Delete a toll-free verification submission for a toll-free number. + +### Example + +```typescript +import { + TollFreeVerificationApi, + Configuration +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new TollFreeVerificationApi(configuration); + +let accountId: string; //Your Bandwidth Account ID. (default to undefined) +let phoneNumber: string; //Valid Toll-Free telephone number in E.164 format. (default to undefined) + +const { status, data } = await apiInstance.deleteVerificationRequest( + accountId, + phoneNumber +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **phoneNumber** | [**string**] | Valid Toll-Free telephone number in E.164 format. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | No Content | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**403** | Forbidden | - | +|**404** | Cannot find the requested resource. | - | +|**405** | Method Not Allowed | - | +|**429** | Too Many Requests | - | +|**500** | Internal Server Error | - | +|**503** | Service Unavailable | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **deleteWebhookSubscription** > deleteWebhookSubscription() diff --git a/models/callback.ts b/models/callback.ts new file mode 100644 index 0000000..683a7c1 --- /dev/null +++ b/models/callback.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { InboundCallback } from './inbound-callback'; +// May contain unused imports in some cases +// @ts-ignore +import type { InboundCallbackMessage } from './inbound-callback-message'; +// May contain unused imports in some cases +// @ts-ignore +import type { InboundCallbackTypeEnum } from './inbound-callback-type-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { StatusCallback } from './status-callback'; + +/** + * @type Callback + * Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request. + * @export + */ +export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback; + + diff --git a/models/create-multi-channel-message-response.ts b/models/create-multi-channel-message-response.ts index 3789b22..f4f0d3e 100644 --- a/models/create-multi-channel-message-response.ts +++ b/models/create-multi-channel-message-response.ts @@ -21,7 +21,7 @@ import type { ErrorObject } from './error-object'; import type { Link } from './link'; // May contain unused imports in some cases // @ts-ignore -import type { MultiChannelMessageData } from './multi-channel-message-data'; +import type { MultiChannelMessageResponseData } from './multi-channel-message-response-data'; /** * @@ -37,10 +37,10 @@ export interface CreateMultiChannelMessageResponse { 'links'?: Array; /** * - * @type {MultiChannelMessageData} + * @type {MultiChannelMessageResponseData} * @memberof CreateMultiChannelMessageResponse */ - 'data'?: MultiChannelMessageData; + 'data'?: MultiChannelMessageResponseData; /** * * @type {Array} diff --git a/models/error-object.ts b/models/error-object.ts index 6a89f07..1868b36 100644 --- a/models/error-object.ts +++ b/models/error-object.ts @@ -13,6 +13,9 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import type { ErrorSource } from './error-source'; /** * @@ -21,16 +24,22 @@ */ export interface ErrorObject { /** - * + * A concise summary of the error used for categorization. * @type {string} * @memberof ErrorObject */ - 'code'?: string; + 'type': string; /** - * + * A detailed explanation of the error. * @type {string} * @memberof ErrorObject */ - 'message'?: string; + 'description': string; + /** + * + * @type {ErrorSource} + * @memberof ErrorObject + */ + 'source': ErrorSource; } diff --git a/models/error-source.ts b/models/error-source.ts new file mode 100644 index 0000000..4c61468 --- /dev/null +++ b/models/error-source.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * Specifies relevant sources of the error, if any. + * @export + * @interface ErrorSource + */ +export interface ErrorSource { + /** + * The relevant URI query parameter causing the error + * @type {string} + * @memberof ErrorSource + */ + 'parameter'?: string; + /** + * The request body field that led to the error + * @type {string} + * @memberof ErrorSource + */ + 'field'?: string; + /** + * The header field that contributed to the error + * @type {string} + * @memberof ErrorSource + */ + 'header'?: string; + /** + * A resource ID or path linked to the error + * @type {string} + * @memberof ErrorSource + */ + 'reference'?: string; +} + diff --git a/models/inbound-callback-message.ts b/models/inbound-callback-message.ts new file mode 100644 index 0000000..47c59f6 --- /dev/null +++ b/models/inbound-callback-message.ts @@ -0,0 +1,44 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { MessageDirectionEnum } from './message-direction-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { MultiChannelMessageContent } from './multi-channel-message-content'; +// May contain unused imports in some cases +// @ts-ignore +import type { PriorityEnum } from './priority-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { RbmLocationResponse } from './rbm-location-response'; +// May contain unused imports in some cases +// @ts-ignore +import type { RbmSuggestionResponse } from './rbm-suggestion-response'; +// May contain unused imports in some cases +// @ts-ignore +import type { StatusCallbackMessage } from './status-callback-message'; + +/** + * @type InboundCallbackMessage + * @export + */ +export type InboundCallbackMessage = StatusCallbackMessage; + + diff --git a/models/inbound-callback-type-enum.ts b/models/inbound-callback-type-enum.ts new file mode 100644 index 0000000..c60b809 --- /dev/null +++ b/models/inbound-callback-type-enum.ts @@ -0,0 +1,32 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message. + * @export + * @enum {string} + */ + +export const InboundCallbackTypeEnum = { + MessageReceived: 'message-received', + RequestLocationResponse: 'request-location-response', + SuggestionResponse: 'suggestion-response' +} as const; + +export type InboundCallbackTypeEnum = typeof InboundCallbackTypeEnum[keyof typeof InboundCallbackTypeEnum]; + + + diff --git a/models/inbound-callback.ts b/models/inbound-callback.ts new file mode 100644 index 0000000..546695e --- /dev/null +++ b/models/inbound-callback.ts @@ -0,0 +1,68 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { InboundCallbackMessage } from './inbound-callback-message'; +// May contain unused imports in some cases +// @ts-ignore +import type { InboundCallbackTypeEnum } from './inbound-callback-type-enum'; + +/** + * Represents an inbound callback. + * @export + * @interface InboundCallback + */ +export interface InboundCallback { + /** + * + * @type {string} + * @memberof InboundCallback + */ + 'time': string; + /** + * + * @type {InboundCallbackTypeEnum} + * @memberof InboundCallback + */ + 'type': InboundCallbackTypeEnum; + /** + * The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. + * @type {string} + * @memberof InboundCallback + */ + 'to': string; + /** + * A detailed description of the event described by the callback. + * @type {string} + * @memberof InboundCallback + */ + 'description': string; + /** + * + * @type {InboundCallbackMessage} + * @memberof InboundCallback + */ + 'message': InboundCallbackMessage; + /** + * The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. + * @type {string} + * @memberof InboundCallback + */ + 'carrierName'?: string; +} + + + diff --git a/models/index.ts b/models/index.ts index d953e9d..5b09d32 100644 --- a/models/index.ts +++ b/models/index.ts @@ -14,8 +14,8 @@ export * from './call-transcription-detected-language-enum'; export * from './call-transcription-metadata'; export * from './call-transcription-response'; export * from './call-transcription-track-enum'; +export * from './callback'; export * from './callback-method-enum'; -export * from './callback-type-enum'; export * from './card-width-enum'; export * from './code-request'; export * from './conference'; @@ -34,15 +34,18 @@ export * from './create-call-response'; export * from './create-lookup-response'; export * from './create-message-request-error'; export * from './create-multi-channel-message-response'; -export * from './deferred-result'; export * from './disconnect-callback'; export * from './diversion'; export * from './dtmf-callback'; export * from './error-object'; +export * from './error-source'; export * from './failure-webhook'; export * from './field-error'; export * from './file-format-enum'; export * from './gather-callback'; +export * from './inbound-callback'; +export * from './inbound-callback-message'; +export * from './inbound-callback-type-enum'; export * from './initiate-callback'; export * from './link'; export * from './links-object'; @@ -58,8 +61,6 @@ export * from './machine-detection-mode-enum'; export * from './machine-detection-result'; export * from './media'; export * from './message'; -export * from './message-callback'; -export * from './message-callback-message'; export * from './message-direction-enum'; export * from './message-request'; export * from './message-status-enum'; @@ -71,18 +72,18 @@ export * from './mfa-forbidden-request-error'; export * from './mfa-request-error'; export * from './mfa-unauthorized-request-error'; export * from './mms-message-content'; +export * from './mms-message-content-file'; export * from './model-error'; export * from './multi-channel-action'; export * from './multi-channel-action-calendar-event'; -export * from './multi-channel-callback-data'; export * from './multi-channel-channel-list-object'; export * from './multi-channel-channel-list-object-content'; -export * from './multi-channel-message-callback-data'; +export * from './multi-channel-error'; export * from './multi-channel-message-channel-enum'; -export * from './multi-channel-message-data'; -export * from './multi-channel-message-direction-enum'; +export * from './multi-channel-message-content'; export * from './multi-channel-message-request'; -export * from './multi-channel-status-enum'; +export * from './multi-channel-message-response-data'; +export * from './multi-channel-message-response-data-channel-list-inner'; export * from './opt-in-workflow'; export * from './page-info'; export * from './priority-enum'; @@ -93,6 +94,7 @@ export * from './rbm-action-type-enum'; export * from './rbm-action-view-location'; export * from './rbm-card-content'; export * from './rbm-card-content-media'; +export * from './rbm-location-response'; export * from './rbm-media-height-enum'; export * from './rbm-message-carousel-card'; export * from './rbm-message-content-file'; @@ -100,6 +102,7 @@ export * from './rbm-message-content-rich-card'; export * from './rbm-message-content-text'; export * from './rbm-message-media'; export * from './rbm-standalone-card'; +export * from './rbm-suggestion-response'; export * from './recording-available-callback'; export * from './recording-complete-callback'; export * from './recording-state-enum'; @@ -109,6 +112,9 @@ export * from './redirect-callback'; export * from './redirect-method-enum'; export * from './sms-message-content'; export * from './standalone-card-orientation-enum'; +export * from './status-callback'; +export * from './status-callback-message'; +export * from './status-callback-type-enum'; export * from './stir-shaken'; export * from './telephone-number'; export * from './tfv-basic-authentication'; diff --git a/models/list-message-item.ts b/models/list-message-item.ts index be264df..9a20646 100644 --- a/models/list-message-item.ts +++ b/models/list-message-item.ts @@ -72,7 +72,7 @@ export interface ListMessageItem { */ 'messageType'?: MessageTypeEnum; /** - * The number of segments the message was sent as. + * The number of segments the user\'s message is broken into before sending over carrier networks. * @type {number} * @memberof ListMessageItem */ diff --git a/models/message-request.ts b/models/message-request.ts index 3cd4115..d3e5d7d 100644 --- a/models/message-request.ts +++ b/models/message-request.ts @@ -24,7 +24,7 @@ import type { PriorityEnum } from './priority-enum'; */ export interface MessageRequest { /** - * The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. + * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. * @type {string} * @memberof MessageRequest */ diff --git a/models/message.ts b/models/message.ts index 0c746d8..288279e 100644 --- a/models/message.ts +++ b/models/message.ts @@ -39,7 +39,7 @@ export interface Message { */ 'owner'?: string; /** - * The application ID associated with the message. + * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. * @type {string} * @memberof Message */ @@ -51,7 +51,7 @@ export interface Message { */ 'time'?: string; /** - * The number of segments the original message from the user is broken into before sending over to carrier networks. + * The number of segments the user\'s message is broken into before sending over carrier networks. * @type {number} * @memberof Message */ @@ -87,7 +87,7 @@ export interface Message { */ 'text'?: string; /** - * The custom string set by the user. + * A custom string that will be included in callback events of the message. Max 1024 characters. * @type {string} * @memberof Message */ diff --git a/models/mms-message-content-file.ts b/models/mms-message-content-file.ts new file mode 100644 index 0000000..a095c29 --- /dev/null +++ b/models/mms-message-content-file.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface MmsMessageContentFile + */ +export interface MmsMessageContentFile { + /** + * The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. + * @type {string} + * @memberof MmsMessageContentFile + */ + 'fileUrl': string; +} + diff --git a/models/mms-message-content.ts b/models/mms-message-content.ts index 7a758c4..b18e555 100644 --- a/models/mms-message-content.ts +++ b/models/mms-message-content.ts @@ -13,6 +13,9 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import type { MmsMessageContentFile } from './mms-message-content-file'; /** * @@ -27,10 +30,10 @@ export interface MmsMessageContent { */ 'text'?: string; /** - * A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. - * @type {Array} + * + * @type {Array} * @memberof MmsMessageContent */ - 'media'?: Array; + 'media'?: Array; } diff --git a/models/multi-channel-channel-list-object-content.ts b/models/multi-channel-channel-list-object-content.ts index 2447c2b..f543524 100644 --- a/models/multi-channel-channel-list-object-content.ts +++ b/models/multi-channel-channel-list-object-content.ts @@ -21,6 +21,9 @@ import type { CardWidthEnum } from './card-width-enum'; import type { MmsMessageContent } from './mms-message-content'; // May contain unused imports in some cases // @ts-ignore +import type { MmsMessageContentFile } from './mms-message-content-file'; +// May contain unused imports in some cases +// @ts-ignore import type { MultiChannelAction } from './multi-channel-action'; // May contain unused imports in some cases // @ts-ignore diff --git a/models/multi-channel-error.ts b/models/multi-channel-error.ts new file mode 100644 index 0000000..dd1b508 --- /dev/null +++ b/models/multi-channel-error.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { ErrorObject } from './error-object'; +// May contain unused imports in some cases +// @ts-ignore +import type { Link } from './link'; + +/** + * + * @export + * @interface MultiChannelError + */ +export interface MultiChannelError { + /** + * + * @type {Array} + * @memberof MultiChannelError + */ + 'links'?: Array; + /** + * + * @type {object} + * @memberof MultiChannelError + */ + 'data'?: object | null; + /** + * + * @type {Array} + * @memberof MultiChannelError + */ + 'errors'?: Array; +} + diff --git a/models/multi-channel-message-content.ts b/models/multi-channel-message-content.ts new file mode 100644 index 0000000..e26cc24 --- /dev/null +++ b/models/multi-channel-message-content.ts @@ -0,0 +1,39 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { RbmMessageContentFile } from './rbm-message-content-file'; + +/** + * The structure of the content field of a multichannel message. + * @export + * @interface MultiChannelMessageContent + */ +export interface MultiChannelMessageContent { + /** + * + * @type {string} + * @memberof MultiChannelMessageContent + */ + 'text'?: string; + /** + * + * @type {RbmMessageContentFile} + * @memberof MultiChannelMessageContent + */ + 'media'?: RbmMessageContentFile; +} + diff --git a/models/multi-channel-message-response-data-channel-list-inner.ts b/models/multi-channel-message-response-data-channel-list-inner.ts new file mode 100644 index 0000000..4d1ec76 --- /dev/null +++ b/models/multi-channel-message-response-data-channel-list-inner.ts @@ -0,0 +1,32 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { MultiChannelChannelListObject } from './multi-channel-channel-list-object'; +// May contain unused imports in some cases +// @ts-ignore +import type { MultiChannelChannelListObjectContent } from './multi-channel-channel-list-object-content'; +// May contain unused imports in some cases +// @ts-ignore +import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum'; + +/** + * @type MultiChannelMessageResponseDataChannelListInner + * @export + */ +export type MultiChannelMessageResponseDataChannelListInner = MultiChannelChannelListObject; + + diff --git a/models/multi-channel-message-response-data.ts b/models/multi-channel-message-response-data.ts new file mode 100644 index 0000000..0826361 --- /dev/null +++ b/models/multi-channel-message-response-data.ts @@ -0,0 +1,83 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { MessageDirectionEnum } from './message-direction-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { MultiChannelMessageResponseDataChannelListInner } from './multi-channel-message-response-data-channel-list-inner'; +// May contain unused imports in some cases +// @ts-ignore +import type { PriorityEnum } from './priority-enum'; + +/** + * The data returned in a multichannel message response. + * @export + * @interface MultiChannelMessageResponseData + */ +export interface MultiChannelMessageResponseData { + /** + * The ID of the message. + * @type {string} + * @memberof MultiChannelMessageResponseData + */ + 'messageId': string; + /** + * The time the message was received by the Bandwidth API. + * @type {string} + * @memberof MultiChannelMessageResponseData + */ + 'time': string; + /** + * + * @type {MessageDirectionEnum} + * @memberof MultiChannelMessageResponseData + */ + 'direction': MessageDirectionEnum; + /** + * The destination phone number(s) of the message, in E164 format. + * @type {Set} + * @memberof MultiChannelMessageResponseData + */ + 'to': Set; + /** + * A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. + * @type {Array} + * @memberof MultiChannelMessageResponseData + */ + 'channelList': Array; + /** + * A custom string that will be included in callback events of the message. Max 1024 characters. + * @type {string} + * @memberof MultiChannelMessageResponseData + */ + 'tag'?: string; + /** + * + * @type {PriorityEnum} + * @memberof MultiChannelMessageResponseData + */ + 'priority'?: PriorityEnum; + /** + * A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. + * @type {string} + * @memberof MultiChannelMessageResponseData + */ + 'expiration'?: string; +} + + + diff --git a/models/priority-enum.ts b/models/priority-enum.ts index c478608..f824d20 100644 --- a/models/priority-enum.ts +++ b/models/priority-enum.ts @@ -15,7 +15,7 @@ /** - * The priority specified by the user. + * Specifies the message\'s sending priority with respect to other messages in your account. For best results and optimal throughput, reserve the \'high\' priority setting for critical messages only. * @export * @enum {string} */ diff --git a/models/rbm-action-base.ts b/models/rbm-action-base.ts index 61585de..389d48d 100644 --- a/models/rbm-action-base.ts +++ b/models/rbm-action-base.ts @@ -40,7 +40,7 @@ export interface RbmActionBase { * @type {string} * @memberof RbmActionBase */ - 'postBackData': string; + 'postbackData': string; } diff --git a/models/rbm-location-response.ts b/models/rbm-location-response.ts new file mode 100644 index 0000000..35c3fec --- /dev/null +++ b/models/rbm-location-response.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface RbmLocationResponse + */ +export interface RbmLocationResponse { + /** + * The latitude of the client\'s location. + * @type {number} + * @memberof RbmLocationResponse + */ + 'latitude'?: number; + /** + * The longitude of the client\'s location. + * @type {number} + * @memberof RbmLocationResponse + */ + 'longitude'?: number; +} + diff --git a/models/rbm-suggestion-response.ts b/models/rbm-suggestion-response.ts new file mode 100644 index 0000000..1434f03 --- /dev/null +++ b/models/rbm-suggestion-response.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface RbmSuggestionResponse + */ +export interface RbmSuggestionResponse { + /** + * The text associated with the suggestion response. + * @type {string} + * @memberof RbmSuggestionResponse + */ + 'text'?: string; + /** + * Base64 payload the customer receives when the reply is clicked. + * @type {string} + * @memberof RbmSuggestionResponse + */ + 'postbackData'?: string; +} + diff --git a/models/status-callback-message.ts b/models/status-callback-message.ts new file mode 100644 index 0000000..8e6c1ae --- /dev/null +++ b/models/status-callback-message.ts @@ -0,0 +1,113 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { MessageDirectionEnum } from './message-direction-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { PriorityEnum } from './priority-enum'; + +/** + * Message payload schema within a callback + * @export + * @interface StatusCallbackMessage + */ +export interface StatusCallbackMessage { + /** + * A unique identifier of the message. + * @type {string} + * @memberof StatusCallbackMessage + */ + 'id': string; + /** + * The Bandwidth phone number or alphanumeric identifier associated with the message. + * @type {string} + * @memberof StatusCallbackMessage + */ + 'owner': string; + /** + * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. + * @type {string} + * @memberof StatusCallbackMessage + */ + 'applicationId': string; + /** + * + * @type {string} + * @memberof StatusCallbackMessage + */ + 'time': string; + /** + * The number of segments the user\'s message is broken into before sending over carrier networks. + * @type {number} + * @memberof StatusCallbackMessage + */ + 'segmentCount': number; + /** + * + * @type {MessageDirectionEnum} + * @memberof StatusCallbackMessage + */ + 'direction': MessageDirectionEnum; + /** + * The phone number recipients of the message. + * @type {Set} + * @memberof StatusCallbackMessage + */ + 'to': Set; + /** + * The Bandwidth phone number or alphanumeric identifier the message was sent from. + * @type {string} + * @memberof StatusCallbackMessage + */ + 'from': string; + /** + * + * @type {string} + * @memberof StatusCallbackMessage + */ + 'text'?: string; + /** + * A custom string that will be included in callback events of the message. Max 1024 characters. + * @type {string} + * @memberof StatusCallbackMessage + */ + 'tag'?: string; + /** + * Optional media, not applicable for sms + * @type {Array} + * @memberof StatusCallbackMessage + */ + 'media'?: Array; + /** + * + * @type {PriorityEnum} + * @memberof StatusCallbackMessage + */ + 'priority'?: PriorityEnum; + /** + * + * @type {MultiChannelMessageChannelEnum} + * @memberof StatusCallbackMessage + */ + 'channel'?: MultiChannelMessageChannelEnum; +} + + + diff --git a/models/status-callback-type-enum.ts b/models/status-callback-type-enum.ts new file mode 100644 index 0000000..cecc6d6 --- /dev/null +++ b/models/status-callback-type-enum.ts @@ -0,0 +1,33 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient. + * @export + * @enum {string} + */ + +export const StatusCallbackTypeEnum = { + MessageSending: 'message-sending', + MessageDelivered: 'message-delivered', + MessageFailed: 'message-failed', + MessageRead: 'message-read' +} as const; + +export type StatusCallbackTypeEnum = typeof StatusCallbackTypeEnum[keyof typeof StatusCallbackTypeEnum]; + + + diff --git a/models/status-callback.ts b/models/status-callback.ts new file mode 100644 index 0000000..5de44c7 --- /dev/null +++ b/models/status-callback.ts @@ -0,0 +1,80 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { StatusCallbackMessage } from './status-callback-message'; +// May contain unused imports in some cases +// @ts-ignore +import type { StatusCallbackTypeEnum } from './status-callback-type-enum'; + +/** + * Represents a status callback for an outbound MT SMS or MMS or RBM message. + * @export + * @interface StatusCallback + */ +export interface StatusCallback { + /** + * + * @type {string} + * @memberof StatusCallback + */ + 'time': string; + /** + * Represents the time at which the message was read, for `message-read` callbacks. + * @type {string} + * @memberof StatusCallback + */ + 'eventTime'?: string; + /** + * + * @type {StatusCallbackTypeEnum} + * @memberof StatusCallback + */ + 'type': StatusCallbackTypeEnum; + /** + * The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user\'s client phone number. + * @type {string} + * @memberof StatusCallback + */ + 'to': string; + /** + * A detailed description of the event described by the callback. + * @type {string} + * @memberof StatusCallback + */ + 'description': string; + /** + * + * @type {StatusCallbackMessage} + * @memberof StatusCallback + */ + 'message': StatusCallbackMessage; + /** + * Optional error code, applicable only when type is `message-failed`. + * @type {number} + * @memberof StatusCallback + */ + 'errorCode'?: number; + /** + * The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. + * @type {string} + * @memberof StatusCallback + */ + 'carrierName'?: string; +} + + + From f7288e94192648feacada06bd78f00ae3174580a Mon Sep 17 00:00:00 2001 From: ckoegel Date: Thu, 31 Jul 2025 16:33:02 -0400 Subject: [PATCH 2/6] add enum unit tests --- tests/unit/models/inbound-callback-type-enum.test.ts | 9 +++++++++ tests/unit/models/status-callback-type-enum.test.ts | 10 ++++++++++ 2 files changed, 19 insertions(+) create mode 100644 tests/unit/models/inbound-callback-type-enum.test.ts create mode 100644 tests/unit/models/status-callback-type-enum.test.ts diff --git a/tests/unit/models/inbound-callback-type-enum.test.ts b/tests/unit/models/inbound-callback-type-enum.test.ts new file mode 100644 index 0000000..54da6bd --- /dev/null +++ b/tests/unit/models/inbound-callback-type-enum.test.ts @@ -0,0 +1,9 @@ +import { InboundCallbackTypeEnum } from '../../../models/inbound-callback-type-enum'; + +describe('InboundCallbackTypeEnum', () => { + test('should define the expected values', () => { + expect(InboundCallbackTypeEnum.MessageReceived).toBe('message-received'); + expect(InboundCallbackTypeEnum.RequestLocationResponse).toBe('request-location-response'); + expect(InboundCallbackTypeEnum.SuggestionResponse).toBe('suggestion-response'); + }); +}); diff --git a/tests/unit/models/status-callback-type-enum.test.ts b/tests/unit/models/status-callback-type-enum.test.ts new file mode 100644 index 0000000..590c95b --- /dev/null +++ b/tests/unit/models/status-callback-type-enum.test.ts @@ -0,0 +1,10 @@ +import { StatusCallbackTypeEnum } from '../../../models/status-callback-type-enum'; + +describe('StatusCallbackTypeEnum', () => { + test('should define the expected values', () => { + expect(StatusCallbackTypeEnum.MessageSending).toBe('message-sending'); + expect(StatusCallbackTypeEnum.MessageDelivered).toBe('message-delivered'); + expect(StatusCallbackTypeEnum.MessageFailed).toBe('message-failed'); + expect(StatusCallbackTypeEnum.MessageRead).toBe('message-read'); + }); +}); From 23c6dc444b5751282f24c7090e27875d4ea49e11 Mon Sep 17 00:00:00 2001 From: ckoegel Date: Thu, 31 Jul 2025 16:34:09 -0400 Subject: [PATCH 3/6] remove old models --- models/callback-type-enum.ts | 33 ------ models/deferred-result.ts | 36 ------ models/message-callback-message.ts | 104 ------------------ models/message-callback.ts | 74 ------------- models/multi-channel-callback-data.ts | 62 ----------- models/multi-channel-message-callback-data.ts | 83 -------------- models/multi-channel-message-data.ts | 89 --------------- .../multi-channel-message-direction-enum.ts | 31 ------ models/multi-channel-status-enum.ts | 33 ------ models/tag.ts | 36 ------ tests/unit/models/callback-type-enum.test.ts | 10 -- .../models/multi-channel-status-enum.test.ts | 10 -- 12 files changed, 601 deletions(-) delete mode 100644 models/callback-type-enum.ts delete mode 100644 models/deferred-result.ts delete mode 100644 models/message-callback-message.ts delete mode 100644 models/message-callback.ts delete mode 100644 models/multi-channel-callback-data.ts delete mode 100644 models/multi-channel-message-callback-data.ts delete mode 100644 models/multi-channel-message-data.ts delete mode 100644 models/multi-channel-message-direction-enum.ts delete mode 100644 models/multi-channel-status-enum.ts delete mode 100644 models/tag.ts delete mode 100644 tests/unit/models/callback-type-enum.test.ts delete mode 100644 tests/unit/models/multi-channel-status-enum.test.ts diff --git a/models/callback-type-enum.ts b/models/callback-type-enum.ts deleted file mode 100644 index 86f1d48..0000000 --- a/models/callback-type-enum.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - - -/** - * Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks. - * @export - * @enum {string} - */ - -export const CallbackTypeEnum = { - MessageReceived: 'message-received', - MessageSending: 'message-sending', - MessageDelivered: 'message-delivered', - MessageFailed: 'message-failed' -} as const; - -export type CallbackTypeEnum = typeof CallbackTypeEnum[keyof typeof CallbackTypeEnum]; - - - diff --git a/models/deferred-result.ts b/models/deferred-result.ts deleted file mode 100644 index d6e8e76..0000000 --- a/models/deferred-result.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - - -/** - * - * @export - * @interface DeferredResult - */ -export interface DeferredResult { - /** - * - * @type {object} - * @memberof DeferredResult - */ - 'result'?: object; - /** - * - * @type {boolean} - * @memberof DeferredResult - */ - 'setOrExpired'?: boolean; -} - diff --git a/models/message-callback-message.ts b/models/message-callback-message.ts deleted file mode 100644 index 9f8b37b..0000000 --- a/models/message-callback-message.ts +++ /dev/null @@ -1,104 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { MessageDirectionEnum } from './message-direction-enum'; -// May contain unused imports in some cases -// @ts-ignore -import type { PriorityEnum } from './priority-enum'; - -/** - * Message payload schema within a MessageCallback - * @export - * @interface MessageCallbackMessage - */ -export interface MessageCallbackMessage { - /** - * - * @type {string} - * @memberof MessageCallbackMessage - */ - 'id': string; - /** - * - * @type {string} - * @memberof MessageCallbackMessage - */ - 'owner': string; - /** - * - * @type {string} - * @memberof MessageCallbackMessage - */ - 'applicationId': string; - /** - * - * @type {string} - * @memberof MessageCallbackMessage - */ - 'time': string; - /** - * - * @type {number} - * @memberof MessageCallbackMessage - */ - 'segmentCount': number; - /** - * - * @type {MessageDirectionEnum} - * @memberof MessageCallbackMessage - */ - 'direction': MessageDirectionEnum; - /** - * - * @type {Set} - * @memberof MessageCallbackMessage - */ - 'to': Set; - /** - * - * @type {string} - * @memberof MessageCallbackMessage - */ - 'from': string; - /** - * - * @type {string} - * @memberof MessageCallbackMessage - */ - 'text': string; - /** - * - * @type {string} - * @memberof MessageCallbackMessage - */ - 'tag'?: string; - /** - * Optional media, applicable only for mms - * @type {Array} - * @memberof MessageCallbackMessage - */ - 'media'?: Array | null; - /** - * - * @type {PriorityEnum} - * @memberof MessageCallbackMessage - */ - 'priority'?: PriorityEnum; -} - - - diff --git a/models/message-callback.ts b/models/message-callback.ts deleted file mode 100644 index 1d03e13..0000000 --- a/models/message-callback.ts +++ /dev/null @@ -1,74 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { CallbackTypeEnum } from './callback-type-enum'; -// May contain unused imports in some cases -// @ts-ignore -import type { MessageCallbackMessage } from './message-callback-message'; - -/** - * Message Callback Schema - * @export - * @interface MessageCallback - */ -export interface MessageCallback { - /** - * - * @type {string} - * @memberof MessageCallback - */ - 'time': string; - /** - * - * @type {CallbackTypeEnum} - * @memberof MessageCallback - */ - 'type': CallbackTypeEnum; - /** - * - * @type {string} - * @memberof MessageCallback - */ - 'to': string; - /** - * A detailed description of the event described by the callback. - * @type {string} - * @memberof MessageCallback - */ - 'description': string; - /** - * - * @type {MessageCallbackMessage} - * @memberof MessageCallback - */ - 'message': MessageCallbackMessage; - /** - * Optional error code, applicable only when type is `message-failed`. - * @type {number} - * @memberof MessageCallback - */ - 'errorCode'?: number | null; - /** - * The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. - * @type {string} - * @memberof MessageCallback - */ - 'carrierName'?: string | null; -} - - - diff --git a/models/multi-channel-callback-data.ts b/models/multi-channel-callback-data.ts deleted file mode 100644 index 70c63df..0000000 --- a/models/multi-channel-callback-data.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelMessageCallbackData } from './multi-channel-message-callback-data'; -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelStatusEnum } from './multi-channel-status-enum'; - -/** - * - * @export - * @interface MultiChannelCallbackData - */ -export interface MultiChannelCallbackData { - /** - * The time of the callback event. - * @type {string} - * @memberof MultiChannelCallbackData - */ - 'time'?: string; - /** - * - * @type {MultiChannelStatusEnum} - * @memberof MultiChannelCallbackData - */ - 'type'?: MultiChannelStatusEnum; - /** - * The phone number the message should be sent to in E164 format. - * @type {string} - * @memberof MultiChannelCallbackData - */ - 'to'?: string; - /** - * - * @type {string} - * @memberof MultiChannelCallbackData - */ - 'description'?: string; - /** - * - * @type {MultiChannelMessageCallbackData} - * @memberof MultiChannelCallbackData - */ - 'message'?: MultiChannelMessageCallbackData; -} - - - diff --git a/models/multi-channel-message-callback-data.ts b/models/multi-channel-message-callback-data.ts deleted file mode 100644 index a58e657..0000000 --- a/models/multi-channel-message-callback-data.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum'; -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelMessageDirectionEnum } from './multi-channel-message-direction-enum'; -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelStatusEnum } from './multi-channel-status-enum'; - -/** - * - * @export - * @interface MultiChannelMessageCallbackData - */ -export interface MultiChannelMessageCallbackData { - /** - * The ID of the message. - * @type {string} - * @memberof MultiChannelMessageCallbackData - */ - 'messageId'?: string; - /** - * - * @type {MultiChannelStatusEnum} - * @memberof MultiChannelMessageCallbackData - */ - 'status'?: MultiChannelStatusEnum; - /** - * - * @type {MultiChannelMessageDirectionEnum} - * @memberof MultiChannelMessageCallbackData - */ - 'direction'?: MultiChannelMessageDirectionEnum; - /** - * The sender ID of the message. This could be an alphanumeric sender ID. - * @type {string} - * @memberof MultiChannelMessageCallbackData - */ - 'from'?: string; - /** - * The phone number the message should be sent to in E164 format. - * @type {string} - * @memberof MultiChannelMessageCallbackData - */ - 'to'?: string; - /** - * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. - * @type {string} - * @memberof MultiChannelMessageCallbackData - */ - 'applicationId'?: string; - /** - * - * @type {MultiChannelMessageChannelEnum} - * @memberof MultiChannelMessageCallbackData - */ - 'channel'?: MultiChannelMessageChannelEnum; - /** - * A custom string that will be included in callback events of the message. Max 1024 characters. - * @type {string} - * @memberof MultiChannelMessageCallbackData - */ - 'tag'?: string; -} - - - diff --git a/models/multi-channel-message-data.ts b/models/multi-channel-message-data.ts deleted file mode 100644 index 6469295..0000000 --- a/models/multi-channel-message-data.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum'; -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelMessageDirectionEnum } from './multi-channel-message-direction-enum'; -// May contain unused imports in some cases -// @ts-ignore -import type { MultiChannelStatusEnum } from './multi-channel-status-enum'; - -/** - * - * @export - * @interface MultiChannelMessageData - */ -export interface MultiChannelMessageData { - /** - * The ID of the message. - * @type {string} - * @memberof MultiChannelMessageData - */ - 'messageId'?: string; - /** - * - * @type {MultiChannelStatusEnum} - * @memberof MultiChannelMessageData - */ - 'status'?: MultiChannelStatusEnum; - /** - * The time the message was received by the Bandwidth API. - * @type {string} - * @memberof MultiChannelMessageData - */ - 'time'?: string; - /** - * - * @type {MultiChannelMessageDirectionEnum} - * @memberof MultiChannelMessageData - */ - 'direction'?: MultiChannelMessageDirectionEnum; - /** - * The sender ID of the message. This could be an alphanumeric sender ID. - * @type {string} - * @memberof MultiChannelMessageData - */ - 'from'?: string; - /** - * The phone number the message should be sent to in E164 format. - * @type {string} - * @memberof MultiChannelMessageData - */ - 'to'?: string; - /** - * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. - * @type {string} - * @memberof MultiChannelMessageData - */ - 'applicationId'?: string; - /** - * - * @type {MultiChannelMessageChannelEnum} - * @memberof MultiChannelMessageData - */ - 'channel'?: MultiChannelMessageChannelEnum; - /** - * A custom string that will be included in callback events of the message. Max 1024 characters. - * @type {string} - * @memberof MultiChannelMessageData - */ - 'tag'?: string; -} - - - diff --git a/models/multi-channel-message-direction-enum.ts b/models/multi-channel-message-direction-enum.ts deleted file mode 100644 index c79b828..0000000 --- a/models/multi-channel-message-direction-enum.ts +++ /dev/null @@ -1,31 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - - -/** - * - * @export - * @enum {string} - */ - -export const MultiChannelMessageDirectionEnum = { - Inbound: 'INBOUND', - Outbound: 'OUTBOUND' -} as const; - -export type MultiChannelMessageDirectionEnum = typeof MultiChannelMessageDirectionEnum[keyof typeof MultiChannelMessageDirectionEnum]; - - - diff --git a/models/multi-channel-status-enum.ts b/models/multi-channel-status-enum.ts deleted file mode 100644 index 79b581d..0000000 --- a/models/multi-channel-status-enum.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - - -/** - * - * @export - * @enum {string} - */ - -export const MultiChannelStatusEnum = { - Queued: 'QUEUED', - Sending: 'SENDING', - Delivered: 'DELIVERED', - Failed: 'FAILED' -} as const; - -export type MultiChannelStatusEnum = typeof MultiChannelStatusEnum[keyof typeof MultiChannelStatusEnum]; - - - diff --git a/models/tag.ts b/models/tag.ts deleted file mode 100644 index 4b5c31f..0000000 --- a/models/tag.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - - -/** - * - * @export - * @interface Tag - */ -export interface Tag { - /** - * - * @type {string} - * @memberof Tag - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof Tag - */ - 'value'?: string; -} - diff --git a/tests/unit/models/callback-type-enum.test.ts b/tests/unit/models/callback-type-enum.test.ts deleted file mode 100644 index f81e99d..0000000 --- a/tests/unit/models/callback-type-enum.test.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { CallbackTypeEnum } from '../../../models/callback-type-enum'; - -describe('CallbackTypeEnum', () => { - test('should define the expected values', () => { - expect(CallbackTypeEnum.MessageReceived).toBe('message-received'); - expect(CallbackTypeEnum.MessageDelivered).toBe('message-delivered'); - expect(CallbackTypeEnum.MessageFailed).toBe('message-failed'); - expect(CallbackTypeEnum.MessageSending).toBe('message-sending'); - }); -}); diff --git a/tests/unit/models/multi-channel-status-enum.test.ts b/tests/unit/models/multi-channel-status-enum.test.ts deleted file mode 100644 index 23d70df..0000000 --- a/tests/unit/models/multi-channel-status-enum.test.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { MultiChannelStatusEnum } from '../../../models/multi-channel-status-enum'; - -describe('MultiChannelStatusEnum', () => { - test('should define the expected values', () => { - expect(MultiChannelStatusEnum.Queued).toBe('QUEUED'); - expect(MultiChannelStatusEnum.Sending).toBe('SENDING'); - expect(MultiChannelStatusEnum.Delivered).toBe('DELIVERED'); - expect(MultiChannelStatusEnum.Failed).toBe('FAILED'); - }); -}); From b5aab9fb59308088c33ab36e075d31f55dbe1242 Mon Sep 17 00:00:00 2001 From: ckoegel Date: Thu, 31 Jul 2025 16:36:56 -0400 Subject: [PATCH 4/6] tfv unit test --- tests/unit/api/toll-free-verification-api.test.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tests/unit/api/toll-free-verification-api.test.ts b/tests/unit/api/toll-free-verification-api.test.ts index 9396876..60c58c6 100644 --- a/tests/unit/api/toll-free-verification-api.test.ts +++ b/tests/unit/api/toll-free-verification-api.test.ts @@ -59,6 +59,13 @@ describe('TollFreeVerificationApi', () => { }); }); + describe('deleteVerificationRequest', () => { + test('should delete toll-free verification request', async () => { + const { status } = await tfvApi.deleteVerificationRequest(BW_ACCOUNT_ID, '+18005551234'); + expect(status).toEqual(204); + }); + }); + describe('listTollFreeUseCases', () => { test('should list toll-free use cases', async () => { const { status, data } = await tfvApi.listTollFreeUseCases(); From 72bad1b5e8ee5a82cf34051667a7555b8095bf71 Mon Sep 17 00:00:00 2001 From: ckoegel Date: Thu, 31 Jul 2025 16:37:00 -0400 Subject: [PATCH 5/6] remove old file --- .../models/multi-channel-message-direction-enum.test.ts | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 tests/unit/models/multi-channel-message-direction-enum.test.ts diff --git a/tests/unit/models/multi-channel-message-direction-enum.test.ts b/tests/unit/models/multi-channel-message-direction-enum.test.ts deleted file mode 100644 index 3c758df..0000000 --- a/tests/unit/models/multi-channel-message-direction-enum.test.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { MultiChannelMessageDirectionEnum } from '../../../models/multi-channel-message-direction-enum'; - -describe('MultiChannelMessageDirectionEnum', () => { - test('should define the expected values', () => { - expect(MultiChannelMessageDirectionEnum.Inbound).toBe('INBOUND'); - expect(MultiChannelMessageDirectionEnum.Outbound).toBe('OUTBOUND'); - }); -}); From 5e0246c680cce70a5518a0bd80ee4c2ba5caf224 Mon Sep 17 00:00:00 2001 From: ckoegel Date: Mon, 4 Aug 2025 13:32:34 -0400 Subject: [PATCH 6/6] remove old docs --- docs/CallbackTypeEnum.md | 15 --------- docs/DeferredResult.md | 22 ------------ docs/MessageCallback.md | 33 ------------------ docs/MessageCallbackMessage.md | 43 ------------------------ docs/MultiChannelCallbackData.md | 28 --------------- docs/MultiChannelMessageCallbackData.md | 34 ------------------- docs/MultiChannelMessageData.md | 36 -------------------- docs/MultiChannelMessageDirectionEnum.md | 10 ------ docs/MultiChannelStatusEnum.md | 14 -------- 9 files changed, 235 deletions(-) delete mode 100644 docs/CallbackTypeEnum.md delete mode 100644 docs/DeferredResult.md delete mode 100644 docs/MessageCallback.md delete mode 100644 docs/MessageCallbackMessage.md delete mode 100644 docs/MultiChannelCallbackData.md delete mode 100644 docs/MultiChannelMessageCallbackData.md delete mode 100644 docs/MultiChannelMessageData.md delete mode 100644 docs/MultiChannelMessageDirectionEnum.md delete mode 100644 docs/MultiChannelStatusEnum.md diff --git a/docs/CallbackTypeEnum.md b/docs/CallbackTypeEnum.md deleted file mode 100644 index d467cc5..0000000 --- a/docs/CallbackTypeEnum.md +++ /dev/null @@ -1,15 +0,0 @@ -# CallbackTypeEnum - -Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks. - -## Enum - -* `MessageReceived` (value: `'message-received'`) - -* `MessageSending` (value: `'message-sending'`) - -* `MessageDelivered` (value: `'message-delivered'`) - -* `MessageFailed` (value: `'message-failed'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DeferredResult.md b/docs/DeferredResult.md deleted file mode 100644 index 843e45b..0000000 --- a/docs/DeferredResult.md +++ /dev/null @@ -1,22 +0,0 @@ -# DeferredResult - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**result** | **object** | | [optional] [default to undefined] -**setOrExpired** | **boolean** | | [optional] [default to undefined] - -## Example - -```typescript -import { DeferredResult } from 'bandwidth-sdk'; - -const instance: DeferredResult = { - result, - setOrExpired, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageCallback.md b/docs/MessageCallback.md deleted file mode 100644 index d479bd5..0000000 --- a/docs/MessageCallback.md +++ /dev/null @@ -1,33 +0,0 @@ -# MessageCallback - -Message Callback Schema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**time** | **string** | | [default to undefined] -**type** | [**CallbackTypeEnum**](CallbackTypeEnum.md) | | [default to undefined] -**to** | **string** | | [default to undefined] -**description** | **string** | A detailed description of the event described by the callback. | [default to undefined] -**message** | [**MessageCallbackMessage**](MessageCallbackMessage.md) | | [default to undefined] -**errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined] -**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. | [optional] [default to undefined] - -## Example - -```typescript -import { MessageCallback } from 'bandwidth-sdk'; - -const instance: MessageCallback = { - time, - type, - to, - description, - message, - errorCode, - carrierName, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MessageCallbackMessage.md b/docs/MessageCallbackMessage.md deleted file mode 100644 index 9d286f4..0000000 --- a/docs/MessageCallbackMessage.md +++ /dev/null @@ -1,43 +0,0 @@ -# MessageCallbackMessage - -Message payload schema within a MessageCallback - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **string** | | [default to undefined] -**owner** | **string** | | [default to undefined] -**applicationId** | **string** | | [default to undefined] -**time** | **string** | | [default to undefined] -**segmentCount** | **number** | | [default to undefined] -**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined] -**to** | **Set<string>** | | [default to undefined] -**from** | **string** | | [default to undefined] -**text** | **string** | | [default to undefined] -**tag** | **string** | | [optional] [default to undefined] -**media** | **Array<string>** | Optional media, applicable only for mms | [optional] [default to undefined] -**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined] - -## Example - -```typescript -import { MessageCallbackMessage } from 'bandwidth-sdk'; - -const instance: MessageCallbackMessage = { - id, - owner, - applicationId, - time, - segmentCount, - direction, - to, - from, - text, - tag, - media, - priority, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelCallbackData.md b/docs/MultiChannelCallbackData.md deleted file mode 100644 index 61db1e9..0000000 --- a/docs/MultiChannelCallbackData.md +++ /dev/null @@ -1,28 +0,0 @@ -# MultiChannelCallbackData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**time** | **string** | The time of the callback event. | [optional] [default to undefined] -**type** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined] -**to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined] -**description** | **string** | | [optional] [default to undefined] -**message** | [**MultiChannelMessageCallbackData**](MultiChannelMessageCallbackData.md) | | [optional] [default to undefined] - -## Example - -```typescript -import { MultiChannelCallbackData } from 'bandwidth-sdk'; - -const instance: MultiChannelCallbackData = { - time, - type, - to, - description, - message, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageCallbackData.md b/docs/MultiChannelMessageCallbackData.md deleted file mode 100644 index 5b05f0b..0000000 --- a/docs/MultiChannelMessageCallbackData.md +++ /dev/null @@ -1,34 +0,0 @@ -# MultiChannelMessageCallbackData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**messageId** | **string** | The ID of the message. | [optional] [default to undefined] -**status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined] -**direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined] -**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined] -**to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined] -**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined] -**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined] -**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] - -## Example - -```typescript -import { MultiChannelMessageCallbackData } from 'bandwidth-sdk'; - -const instance: MultiChannelMessageCallbackData = { - messageId, - status, - direction, - from, - to, - applicationId, - channel, - tag, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageData.md b/docs/MultiChannelMessageData.md deleted file mode 100644 index abe1339..0000000 --- a/docs/MultiChannelMessageData.md +++ /dev/null @@ -1,36 +0,0 @@ -# MultiChannelMessageData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**messageId** | **string** | The ID of the message. | [optional] [default to undefined] -**status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined] -**time** | **string** | The time the message was received by the Bandwidth API. | [optional] [default to undefined] -**direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined] -**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined] -**to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined] -**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined] -**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined] -**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined] - -## Example - -```typescript -import { MultiChannelMessageData } from 'bandwidth-sdk'; - -const instance: MultiChannelMessageData = { - messageId, - status, - time, - direction, - from, - to, - applicationId, - channel, - tag, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelMessageDirectionEnum.md b/docs/MultiChannelMessageDirectionEnum.md deleted file mode 100644 index a5e3b5f..0000000 --- a/docs/MultiChannelMessageDirectionEnum.md +++ /dev/null @@ -1,10 +0,0 @@ -# MultiChannelMessageDirectionEnum - - -## Enum - -* `Inbound` (value: `'INBOUND'`) - -* `Outbound` (value: `'OUTBOUND'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MultiChannelStatusEnum.md b/docs/MultiChannelStatusEnum.md deleted file mode 100644 index 9de6b25..0000000 --- a/docs/MultiChannelStatusEnum.md +++ /dev/null @@ -1,14 +0,0 @@ -# MultiChannelStatusEnum - - -## Enum - -* `Queued` (value: `'QUEUED'`) - -* `Sending` (value: `'SENDING'`) - -* `Delivered` (value: `'DELIVERED'`) - -* `Failed` (value: `'FAILED'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)