Skip to content
Open
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
31 changes: 22 additions & 9 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2436,6 +2436,7 @@ components:
- media
rbmCardContent:
type: object
description: Must contain at least one of title, description, or media to be valid.
properties:
title:
type: string
Expand Down Expand Up @@ -2478,7 +2479,6 @@ components:
$ref: '#/components/schemas/multiChannelFullActions'
required:
- orientation
- thumbnailImageAlignment
- cardContent
standaloneCardOrientationEnum:
type: string
Expand All @@ -2489,8 +2489,8 @@ components:
thumbnailAlignmentEnum:
type: string
description: >-
The alignment of the thumbnail image in the card. Only applicable if the
card using horizontal orientation.
The alignment of the thumbnail image in the card. Required when
orientation is HORIZONTAL.
enum:
- LEFT
- RIGHT
Expand All @@ -2505,6 +2505,7 @@ components:
type: array
items:
$ref: '#/components/schemas/rbmCardContent'
minItems: 2
maxItems: 10
suggestions:
$ref: '#/components/schemas/multiChannelFullActions'
Expand Down Expand Up @@ -2568,7 +2569,11 @@ components:
type: string
description: >-
Defines the layout of the WebView on a mobile device. It must be defined
when application is set to `WEBVIEW`

when application is set to `WEBVIEW` and must not be set when
application

is set to `BROWSER`.

- `FULL` WebView takes the full screen.

Expand Down Expand Up @@ -2626,12 +2631,16 @@ components:
latitude:
type: string
format: double
description: The latitude of the location.
description: >-
The latitude of the location. Must be in range [-90.000000,
90.000000].
example: '37.7749'
longitude:
type: string
format: double
description: The longitude of the location.
description: >-
The longitude of the location. Must be in range [-180.000000,
180.000000].
example: '-122.4194'
label:
type: string
Expand All @@ -2655,12 +2664,16 @@ components:
startTime:
type: string
format: date-time
description: The start time of the event.
description: >-
The start time of the event. Must be a valid RFC-3339 value,
e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
example: 2022-09-14T18:20:16.000Z
endTime:
type: string
format: date-time
description: The end time of the event.
description: >-
The end time of the event. Must be a valid RFC-3339 value, e.g.,
2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
example: 2022-09-14T18:20:16.000Z
description:
type: string
Expand All @@ -2680,7 +2693,7 @@ components:
url:
type: string
format: uri
description: The URL to open in browser.
description: The URL to open in browser. Must use http:// or https:// scheme.
example: https://dev.bandwidth.com
maxLength: 2048
application:
Expand Down
10 changes: 5 additions & 5 deletions docs/MultiChannelAction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Name | Type | Description | Notes
**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]
**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]
**latitude** | **number** | The latitude of the location. Must be in range [-90.000000, 90.000000]. | [default to undefined]
**longitude** | **number** | The longitude of the location. Must be in range [-180.000000, 180.000000]. | [default to undefined]
**label** | **string** | The label of the location. | [optional] [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]
**startTime** | **string** | The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | [default to undefined]
**endTime** | **string** | The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | [default to undefined]
**description** | **string** | The description of the event. | [optional] [default to undefined]
**url** | **string** | The URL to open in browser. | [default to undefined]
**url** | **string** | The URL to open in browser. Must use http:// or https:// scheme. | [default to undefined]
**application** | [**RbmOpenUrlEnum**](RbmOpenUrlEnum.md) | | [optional] [default to undefined]
**webviewViewMode** | [**RbmWebViewEnum**](RbmWebViewEnum.md) | | [optional] [default to undefined]

Expand Down
4 changes: 2 additions & 2 deletions docs/MultiChannelActionCalendarEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Name | Type | Description | Notes
**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]
**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]
**startTime** | **string** | The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | [default to undefined]
**endTime** | **string** | The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | [default to undefined]
**description** | **string** | The description of the event. | [optional] [default to undefined]

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/MultiChannelChannelListRBMObjectAllOfContent.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]
**media** | [**Array<RbmMessageContentFile>**](RbmMessageContentFile.md) | | [default to undefined]
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined]
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined]
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [optional] [default to undefined]
**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined]
**cardWidth** | [**CardWidthEnum**](CardWidthEnum.md) | | [default to undefined]
**cardContents** | [**Array<RbmCardContent>**](RbmCardContent.md) | | [default to undefined]
Expand Down
2 changes: 1 addition & 1 deletion docs/RbmActionOpenUrl.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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]
**url** | **string** | The URL to open in browser. | [default to undefined]
**url** | **string** | The URL to open in browser. Must use http:// or https:// scheme. | [default to undefined]
**application** | [**RbmOpenUrlEnum**](RbmOpenUrlEnum.md) | | [optional] [default to undefined]
**webviewViewMode** | [**RbmWebViewEnum**](RbmWebViewEnum.md) | | [optional] [default to undefined]

Expand Down
4 changes: 2 additions & 2 deletions docs/RbmActionViewLocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ 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]
**latitude** | **number** | The latitude of the location. | [default to undefined]
**longitude** | **number** | The longitude of the location. | [default to undefined]
**latitude** | **number** | The latitude of the location. Must be in range [-90.000000, 90.000000]. | [default to undefined]
**longitude** | **number** | The longitude of the location. Must be in range [-180.000000, 180.000000]. | [default to undefined]
**label** | **string** | The label of the location. | [optional] [default to undefined]

## Example
Expand Down
1 change: 1 addition & 0 deletions docs/RbmCardContent.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# RbmCardContent

Must contain at least one of title, description, or media to be valid.

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/RbmMessageContentRichCard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined]
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined]
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [optional] [default to undefined]
**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined]
**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]
**cardWidth** | [**CardWidthEnum**](CardWidthEnum.md) | | [default to undefined]
Expand Down
2 changes: 1 addition & 1 deletion docs/RbmStandaloneCard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined]
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined]
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [optional] [default to undefined]
**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined]
**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]

Expand Down
2 changes: 1 addition & 1 deletion docs/RbmWebViewEnum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RbmWebViewEnum

Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` and must not be set when application is set to `BROWSER`. - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.

## Enum

Expand Down
2 changes: 1 addition & 1 deletion docs/ThumbnailAlignmentEnum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ThumbnailAlignmentEnum

The alignment of the thumbnail image in the card. Only applicable if the card using horizontal orientation.
The alignment of the thumbnail image in the card. Required when orientation is HORIZONTAL.

## Enum

Expand Down
4 changes: 2 additions & 2 deletions models/multi-channel-action-calendar-event.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ export interface MultiChannelActionCalendarEvent {
*/
'title': string;
/**
* The start time of the event.
* The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
*/
'startTime': string;
/**
* The end time of the event.
* The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
*/
'endTime': string;
/**
Expand Down
10 changes: 5 additions & 5 deletions models/multi-channel-action.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ export interface MultiChannelAction {
*/
'phoneNumber': string;
/**
* The latitude of the location.
* The latitude of the location. Must be in range [-90.000000, 90.000000].
*/
'latitude': number;
/**
* The longitude of the location.
* The longitude of the location. Must be in range [-180.000000, 180.000000].
*/
'longitude': number;
/**
Expand All @@ -69,19 +69,19 @@ export interface MultiChannelAction {
*/
'title': string;
/**
* The start time of the event.
* The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
*/
'startTime': string;
/**
* The end time of the event.
* The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
*/
'endTime': string;
/**
* The description of the event.
*/
'description'?: string;
/**
* The URL to open in browser.
* The URL to open in browser. Must use http:// or https:// scheme.
*/
'url': string;
'application'?: RbmOpenUrlEnum;
Expand Down
2 changes: 1 addition & 1 deletion models/rbm-action-open-url.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export interface RbmActionOpenUrl {
*/
'postbackData': string;
/**
* The URL to open in browser.
* The URL to open in browser. Must use http:// or https:// scheme.
*/
'url': string;
'application'?: RbmOpenUrlEnum;
Expand Down
4 changes: 2 additions & 2 deletions models/rbm-action-view-location.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ export interface RbmActionViewLocation {
*/
'postbackData': string;
/**
* The latitude of the location.
* The latitude of the location. Must be in range [-90.000000, 90.000000].
*/
'latitude': number;
/**
* The longitude of the location.
* The longitude of the location. Must be in range [-180.000000, 180.000000].
*/
'longitude': number;
/**
Expand Down
3 changes: 3 additions & 0 deletions models/rbm-card-content.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import type { MultiChannelAction } from './multi-channel-action';
// @ts-ignore
import type { RbmCardContentMedia } from './rbm-card-content-media';

/**
* Must contain at least one of title, description, or media to be valid.
*/
export interface RbmCardContent {
/**
* The title of the card. Must be 200 characters or less.
Expand Down
2 changes: 1 addition & 1 deletion models/rbm-standalone-card.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import type { ThumbnailAlignmentEnum } from './thumbnail-alignment-enum';

export interface RbmStandaloneCard {
'orientation': StandaloneCardOrientationEnum;
'thumbnailImageAlignment': ThumbnailAlignmentEnum;
'thumbnailImageAlignment'?: ThumbnailAlignmentEnum;
'cardContent': RbmCardContent;
/**
* An array of suggested actions for the recipient.
Expand Down
2 changes: 1 addition & 1 deletion models/rbm-web-view-enum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


/**
* Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
* Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` and must not be set when application is set to `BROWSER`. - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
*/

export const RbmWebViewEnum = {
Expand Down
2 changes: 1 addition & 1 deletion models/thumbnail-alignment-enum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


/**
* The alignment of the thumbnail image in the card. Only applicable if the card using horizontal orientation.
* The alignment of the thumbnail image in the card. Required when orientation is HORIZONTAL.
*/

export const ThumbnailAlignmentEnum = {
Expand Down
Loading