From 33753ba7b4726570ae1143792e12affb111602b0 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 18 Jun 2026 18:56:15 +0000 Subject: [PATCH] Generate SDK with OpenAPI Generator Version --- .openapi-generator/FILES | 8 +++---- README.md | 4 ++-- bandwidth.yml | 28 +++++++++++++++---------- docs/InboundCallbackMessage.md | 4 ++-- docs/InboundCallbackTypeEnum.md | 4 ++-- docs/LocationResponse.md | 22 ++++++++++++++++++++ docs/SuggestionResponse.md | 24 +++++++++++++++++++++ models/callback.ts | 2 +- models/inbound-callback-message.ts | 14 ++++++------- models/inbound-callback-type-enum.ts | 4 ++-- models/index.ts | 4 ++-- models/location-response.ts | 27 ++++++++++++++++++++++++ models/suggestion-response.ts | 31 ++++++++++++++++++++++++++++ 13 files changed, 143 insertions(+), 33 deletions(-) create mode 100644 docs/LocationResponse.md create mode 100644 docs/SuggestionResponse.md create mode 100644 models/location-response.ts create mode 100644 models/suggestion-response.ts diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 7fd34a1..a834e61 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -105,6 +105,7 @@ docs/LinksObject.md docs/ListEndpointsResponse.md docs/ListMessageDirectionEnum.md docs/ListMessageItem.md +docs/LocationResponse.md docs/LookupErrorResponse.md docs/LookupErrorSchema.md docs/LookupErrorSchemaMeta.md @@ -162,7 +163,6 @@ docs/RbmActionTypeEnum.md docs/RbmActionViewLocation.md docs/RbmCardContent.md docs/RbmCardContentMedia.md -docs/RbmLocationResponse.md docs/RbmMediaHeightEnum.md docs/RbmMessageCarouselCard.md docs/RbmMessageContentFile.md @@ -171,7 +171,6 @@ docs/RbmMessageContentText.md docs/RbmMessageMedia.md docs/RbmOpenUrlEnum.md docs/RbmStandaloneCard.md -docs/RbmSuggestionResponse.md docs/RbmWebViewEnum.md docs/RecordingAvailableCallback.md docs/RecordingCompleteCallback.md @@ -190,6 +189,7 @@ docs/StatusCallback.md docs/StatusCallbackMessage.md docs/StatusCallbackTypeEnum.md docs/StirShaken.md +docs/SuggestionResponse.md docs/SyncLookupRequest.md docs/TelephoneNumber.md docs/TfvBasicAuthentication.md @@ -315,6 +315,7 @@ models/links-object.ts models/list-endpoints-response.ts models/list-message-direction-enum.ts models/list-message-item.ts +models/location-response.ts models/lookup-error-response.ts models/lookup-error-schema-meta.ts models/lookup-error-schema.ts @@ -367,7 +368,6 @@ 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 @@ -376,7 +376,6 @@ models/rbm-message-content-text.ts models/rbm-message-media.ts models/rbm-open-url-enum.ts models/rbm-standalone-card.ts -models/rbm-suggestion-response.ts models/rbm-web-view-enum.ts models/recording-available-callback.ts models/recording-complete-callback.ts @@ -393,6 +392,7 @@ models/status-callback-message.ts models/status-callback-type-enum.ts models/status-callback.ts models/stir-shaken.ts +models/suggestion-response.ts models/sync-lookup-request.ts models/telephone-number.ts models/tfv-basic-authentication.ts diff --git a/README.md b/README.md index 4eb50e1..2899c42 100644 --- a/README.md +++ b/README.md @@ -251,6 +251,7 @@ Class | Method | HTTP request | Description - [ListEndpointsResponse](docs/ListEndpointsResponse.md) - [ListMessageDirectionEnum](docs/ListMessageDirectionEnum.md) - [ListMessageItem](docs/ListMessageItem.md) + - [LocationResponse](docs/LocationResponse.md) - [LookupErrorResponse](docs/LookupErrorResponse.md) - [LookupErrorSchema](docs/LookupErrorSchema.md) - [LookupErrorSchemaMeta](docs/LookupErrorSchemaMeta.md) @@ -303,7 +304,6 @@ Class | Method | HTTP request | Description - [RbmActionViewLocation](docs/RbmActionViewLocation.md) - [RbmCardContent](docs/RbmCardContent.md) - [RbmCardContentMedia](docs/RbmCardContentMedia.md) - - [RbmLocationResponse](docs/RbmLocationResponse.md) - [RbmMediaHeightEnum](docs/RbmMediaHeightEnum.md) - [RbmMessageCarouselCard](docs/RbmMessageCarouselCard.md) - [RbmMessageContentFile](docs/RbmMessageContentFile.md) @@ -312,7 +312,6 @@ Class | Method | HTTP request | Description - [RbmMessageMedia](docs/RbmMessageMedia.md) - [RbmOpenUrlEnum](docs/RbmOpenUrlEnum.md) - [RbmStandaloneCard](docs/RbmStandaloneCard.md) - - [RbmSuggestionResponse](docs/RbmSuggestionResponse.md) - [RbmWebViewEnum](docs/RbmWebViewEnum.md) - [RecordingAvailableCallback](docs/RecordingAvailableCallback.md) - [RecordingCompleteCallback](docs/RecordingCompleteCallback.md) @@ -329,6 +328,7 @@ Class | Method | HTTP request | Description - [StatusCallbackMessage](docs/StatusCallbackMessage.md) - [StatusCallbackTypeEnum](docs/StatusCallbackTypeEnum.md) - [StirShaken](docs/StirShaken.md) + - [SuggestionResponse](docs/SuggestionResponse.md) - [SyncLookupRequest](docs/SyncLookupRequest.md) - [TelephoneNumber](docs/TelephoneNumber.md) - [TfvBasicAuthentication](docs/TfvBasicAuthentication.md) diff --git a/bandwidth.yml b/bandwidth.yml index 5e2bc9b..92f7b76 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -2880,7 +2880,7 @@ components: type: string media: $ref: '#/components/schemas/rbmMessageContentFile' - rbmSuggestionResponse: + suggestionResponse: type: object properties: text: @@ -2889,7 +2889,12 @@ components: example: Yes, I would like to proceed postbackData: $ref: '#/components/schemas/rbmActionPostbackData' - rbmLocationResponse: + pairedMessageId: + type: string + nullable: true + description: Corresponding parent message ID (MT). + example: 1752697342534u24xerqdukke523x + locationResponse: type: object properties: latitude: @@ -2925,7 +2930,7 @@ components: message-failed: '#/components/schemas/statusCallback' message-read: '#/components/schemas/statusCallback' message-received: '#/components/schemas/inboundCallback' - request-location-response: '#/components/schemas/inboundCallback' + requested-location-response: '#/components/schemas/inboundCallback' suggestion-response: '#/components/schemas/inboundCallback' statusCallback: type: object @@ -3035,14 +3040,15 @@ components: - `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. + - `requested-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 + - requested-location-response - suggestion-response example: message-received statusCallbackMessage: @@ -3118,9 +3124,9 @@ components: content: $ref: '#/components/schemas/multiChannelMessageContent' suggestionResponse: - $ref: '#/components/schemas/rbmSuggestionResponse' + $ref: '#/components/schemas/suggestionResponse' locationResponse: - $ref: '#/components/schemas/rbmLocationResponse' + $ref: '#/components/schemas/locationResponse' required: - id - owner @@ -9154,7 +9160,7 @@ components: tag: '{"myTag": "myTagValue"}' updateEndpointBxmlRequestExample: summary: Update Endpoint BXML Request Example - value: + value: endpointDisconnectedEventExample: summary: Endpoint Disconnected Event value: @@ -9678,10 +9684,10 @@ components:

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

Note that suggestion-response and - location-request-response callback types are + requested-location-response callback types are pertinent only for RBM messages sent from the /messages/multiChannel endpoint. diff --git a/docs/InboundCallbackMessage.md b/docs/InboundCallbackMessage.md index 8f4c90f..bfcce89 100644 --- a/docs/InboundCallbackMessage.md +++ b/docs/InboundCallbackMessage.md @@ -19,8 +19,8 @@ Name | Type | Description | Notes **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] +**suggestionResponse** | [**SuggestionResponse**](SuggestionResponse.md) | | [optional] [default to undefined] +**locationResponse** | [**LocationResponse**](LocationResponse.md) | | [optional] [default to undefined] ## Example diff --git a/docs/InboundCallbackTypeEnum.md b/docs/InboundCallbackTypeEnum.md index 714e436..31a6fe7 100644 --- a/docs/InboundCallbackTypeEnum.md +++ b/docs/InboundCallbackTypeEnum.md @@ -1,12 +1,12 @@ # 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. +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. - `requested-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'`) +* `RequestedLocationResponse` (value: `'requested-location-response'`) * `SuggestionResponse` (value: `'suggestion-response'`) diff --git a/docs/LocationResponse.md b/docs/LocationResponse.md new file mode 100644 index 0000000..14bda67 --- /dev/null +++ b/docs/LocationResponse.md @@ -0,0 +1,22 @@ +# LocationResponse + + +## 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 { LocationResponse } from 'bandwidth-sdk'; + +const instance: LocationResponse = { + 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/SuggestionResponse.md b/docs/SuggestionResponse.md new file mode 100644 index 0000000..e0fb9c5 --- /dev/null +++ b/docs/SuggestionResponse.md @@ -0,0 +1,24 @@ +# SuggestionResponse + + +## 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] +**pairedMessageId** | **string** | Corresponding parent message ID (MT). | [optional] [default to undefined] + +## Example + +```typescript +import { SuggestionResponse } from 'bandwidth-sdk'; + +const instance: SuggestionResponse = { + text, + postbackData, + pairedMessageId, +}; +``` + +[[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/models/callback.ts b/models/callback.ts index ddea47b..eda1a69 100644 --- a/models/callback.ts +++ b/models/callback.ts @@ -30,6 +30,6 @@ 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 type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback; +export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'requested-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback; diff --git a/models/inbound-callback-message.ts b/models/inbound-callback-message.ts index b56b57b..8aa8c18 100644 --- a/models/inbound-callback-message.ts +++ b/models/inbound-callback-message.ts @@ -13,6 +13,9 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import type { LocationResponse } from './location-response'; // May contain unused imports in some cases // @ts-ignore import type { MessageDirectionEnum } from './message-direction-enum'; @@ -27,13 +30,10 @@ import type { MultiChannelMessageContent } from './multi-channel-message-content 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'; +import type { StatusCallbackMessage } from './status-callback-message'; // May contain unused imports in some cases // @ts-ignore -import type { StatusCallbackMessage } from './status-callback-message'; +import type { SuggestionResponse } from './suggestion-response'; /** * @type InboundCallbackMessage @@ -77,8 +77,8 @@ export interface InboundCallbackMessage { 'priority'?: PriorityEnum; 'channel'?: MultiChannelMessageChannelEnum; 'content'?: MultiChannelMessageContent; - 'suggestionResponse'?: RbmSuggestionResponse; - 'locationResponse'?: RbmLocationResponse; + 'suggestionResponse'?: SuggestionResponse; + 'locationResponse'?: LocationResponse; } diff --git a/models/inbound-callback-type-enum.ts b/models/inbound-callback-type-enum.ts index 7c4a076..0a092c9 100644 --- a/models/inbound-callback-type-enum.ts +++ b/models/inbound-callback-type-enum.ts @@ -15,12 +15,12 @@ /** - * 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. + * 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. - `requested-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 const InboundCallbackTypeEnum = { MessageReceived: 'message-received', - RequestLocationResponse: 'request-location-response', + RequestedLocationResponse: 'requested-location-response', SuggestionResponse: 'suggestion-response' } as const; diff --git a/models/index.ts b/models/index.ts index bb6e465..4c9fdff 100644 --- a/models/index.ts +++ b/models/index.ts @@ -84,6 +84,7 @@ export * from './links-object'; export * from './list-endpoints-response'; export * from './list-message-direction-enum'; export * from './list-message-item'; +export * from './location-response'; export * from './lookup-error-response'; export * from './lookup-error-schema'; export * from './lookup-error-schema-meta'; @@ -136,7 +137,6 @@ 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'; @@ -145,7 +145,6 @@ export * from './rbm-message-content-text'; export * from './rbm-message-media'; export * from './rbm-open-url-enum'; export * from './rbm-standalone-card'; -export * from './rbm-suggestion-response'; export * from './rbm-web-view-enum'; export * from './recording-available-callback'; export * from './recording-complete-callback'; @@ -162,6 +161,7 @@ export * from './status-callback'; export * from './status-callback-message'; export * from './status-callback-type-enum'; export * from './stir-shaken'; +export * from './suggestion-response'; export * from './sync-lookup-request'; export * from './telephone-number'; export * from './tfv-basic-authentication'; diff --git a/models/location-response.ts b/models/location-response.ts new file mode 100644 index 0000000..8aaaadd --- /dev/null +++ b/models/location-response.ts @@ -0,0 +1,27 @@ +/* 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 LocationResponse { + /** + * The latitude of the client\'s location. + */ + 'latitude'?: number; + /** + * The longitude of the client\'s location. + */ + 'longitude'?: number; +} + diff --git a/models/suggestion-response.ts b/models/suggestion-response.ts new file mode 100644 index 0000000..ff2282e --- /dev/null +++ b/models/suggestion-response.ts @@ -0,0 +1,31 @@ +/* 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 SuggestionResponse { + /** + * The text associated with the suggestion response. + */ + 'text'?: string; + /** + * Base64 payload the customer receives when the reply is clicked. + */ + 'postbackData'?: string; + /** + * Corresponding parent message ID (MT). + */ + 'pairedMessageId'?: string | null; +} +