Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down
28 changes: 17 additions & 11 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2880,7 +2880,7 @@ components:
type: string
media:
$ref: '#/components/schemas/rbmMessageContentFile'
rbmSuggestionResponse:
suggestionResponse:
type: object
properties:
text:
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -9154,7 +9160,7 @@ components:
tag: '{"myTag": "myTagValue"}'
updateEndpointBxmlRequestExample:
summary: Update Endpoint BXML Request Example
value: <Bxml><StartRecording /></Bxml>
value: <Response><StartRecording /></Response>
endpointDisconnectedEventExample:
summary: Endpoint Disconnected Event
value:
Expand Down Expand Up @@ -9678,10 +9684,10 @@ components:

<p>The payload type will be one of <code>message-received</code>,
<code>suggestion-response</code>, or
<code>location-request-response</code>.
<code>requested-location-response</code>.

<p>Note that <code>suggestion-response</code> and
<code>location-request-response</code> callback types are
<code>requested-location-response</code> callback types are
pertinent only for RBM messages sent from the
<code>/messages/multiChannel</code> endpoint.

Expand Down
4 changes: 2 additions & 2 deletions docs/InboundCallbackMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/InboundCallbackTypeEnum.md
Original file line number Diff line number Diff line change
@@ -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'`)

Expand Down
22 changes: 22 additions & 0 deletions docs/LocationResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# LocationResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**latitude** | **number** | The latitude of the client\&#39;s location. | [optional] [default to undefined]
**longitude** | **number** | The longitude of the client\&#39;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)
24 changes: 24 additions & 0 deletions docs/SuggestionResponse.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion models/callback.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;


14 changes: 7 additions & 7 deletions models/inbound-callback-message.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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
Expand Down Expand Up @@ -77,8 +77,8 @@ export interface InboundCallbackMessage {
'priority'?: PriorityEnum;
'channel'?: MultiChannelMessageChannelEnum;
'content'?: MultiChannelMessageContent;
'suggestionResponse'?: RbmSuggestionResponse;
'locationResponse'?: RbmLocationResponse;
'suggestionResponse'?: SuggestionResponse;
'locationResponse'?: LocationResponse;
}


4 changes: 2 additions & 2 deletions models/inbound-callback-type-enum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
4 changes: 2 additions & 2 deletions models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand All @@ -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';
Expand All @@ -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';
Expand Down
27 changes: 27 additions & 0 deletions models/location-response.ts
Original file line number Diff line number Diff line change
@@ -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;
}

Loading
Loading