From 8c80d9d432a5230ef15ca51c6edbbcc244492d55 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 2 Jun 2026 15:26:42 +0000 Subject: [PATCH] Generate SDK with OpenAPI Generator Version --- bandwidth.yml | 81 +++++++++++++------ docs/MultiChannelAction.md | 10 +-- docs/MultiChannelActionCalendarEvent.md | 4 +- ...ChannelChannelListRBMObjectAllOfContent.md | 2 +- docs/RbmActionOpenUrl.md | 2 +- docs/RbmActionViewLocation.md | 4 +- docs/RbmCardContent.md | 1 + docs/RbmMessageContentRichCard.md | 2 +- docs/RbmStandaloneCard.md | 2 +- docs/RbmWebViewEnum.md | 2 +- docs/TfvStatus.md | 4 + docs/ThumbnailAlignmentEnum.md | 2 +- models/multi-channel-action-calendar-event.ts | 4 +- models/multi-channel-action.ts | 10 +-- models/rbm-action-open-url.ts | 2 +- models/rbm-action-view-location.ts | 4 +- models/rbm-card-content.ts | 3 + models/rbm-standalone-card.ts | 2 +- models/rbm-web-view-enum.ts | 2 +- models/tfv-status.ts | 11 +++ models/thumbnail-alignment-enum.ts | 2 +- 21 files changed, 105 insertions(+), 51 deletions(-) diff --git a/bandwidth.yml b/bandwidth.yml index 84e00b3..5e2bc9b 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -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 @@ -2478,7 +2479,6 @@ components: $ref: '#/components/schemas/multiChannelFullActions' required: - orientation - - thumbnailImageAlignment - cardContent standaloneCardOrientationEnum: type: string @@ -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 @@ -2505,6 +2505,7 @@ components: type: array items: $ref: '#/components/schemas/rbmCardContent' + minItems: 2 maxItems: 10 suggestions: $ref: '#/components/schemas/multiChannelFullActions' @@ -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. @@ -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 @@ -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 @@ -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: @@ -6021,12 +6034,30 @@ components: description: Reason code for denial. type: integer example: 511 + denialStatusCodeNullable: + description: Reason code for denial. + nullable: true + type: integer + example: 511 resubmitAllowed: description: >- Whether a Toll-Free Verification request qualifies for resubmission via PUT. example: true type: boolean + additionalDenialReason: + type: object + properties: + statusCode: + $ref: '#/components/schemas/denialStatusCode' + reason: + $ref: '#/components/schemas/declineReasonDescription' + resubmitAllowed: + $ref: '#/components/schemas/resubmitAllowed' + required: + - statusCode + - reason + - resubmitAllowed blocked: description: >- Whether a Toll-Free Verification is blocked. This attribute will only be @@ -6181,19 +6212,6 @@ components: type: boolean description: Indicates whether the content is age-gated. example: false - additionalDenialReason: - properties: - statusCode: - $ref: '#/components/schemas/denialStatusCode' - reason: - $ref: '#/components/schemas/declineReasonDescription' - resubmitAllowed: - $ref: '#/components/schemas/resubmitAllowed' - required: - - statusCode - - reason - - resubmitAllowed - type: object internalTicketNumber: type: string description: >- @@ -6389,6 +6407,7 @@ components: description: >- An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. + type: array items: $ref: '#/components/schemas/additionalDenialReason' example: @@ -6398,7 +6417,6 @@ components: - statusCode: 513 reason: Reason B resubmitAllowed: true - type: array declineReasonDescription: $ref: '#/components/schemas/declineReasonDescription' denialStatusCode: @@ -6766,6 +6784,23 @@ components: $ref: '#/components/schemas/internalTicketNumber' declineReasonDescription: $ref: '#/components/schemas/declineReasonDescription' + denialStatusCode: + $ref: '#/components/schemas/denialStatusCodeNullable' + additionalDenialReasons: + description: >- + An optional list of denial reasons in addition to + declineReasonDescription when multiple reasons apply. + nullable: true + type: array + items: + $ref: '#/components/schemas/additionalDenialReason' + example: + - statusCode: 512 + reason: Reason A + resubmitAllowed: true + - statusCode: 513 + reason: Reason B + resubmitAllowed: true resubmitAllowed: $ref: '#/components/schemas/resubmitAllowed' createdDateTime: diff --git a/docs/MultiChannelAction.md b/docs/MultiChannelAction.md index 2c7e5ad..5d9e4b1 100644 --- a/docs/MultiChannelAction.md +++ b/docs/MultiChannelAction.md @@ -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] diff --git a/docs/MultiChannelActionCalendarEvent.md b/docs/MultiChannelActionCalendarEvent.md index 9252b7c..372c968 100644 --- a/docs/MultiChannelActionCalendarEvent.md +++ b/docs/MultiChannelActionCalendarEvent.md @@ -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 diff --git a/docs/MultiChannelChannelListRBMObjectAllOfContent.md b/docs/MultiChannelChannelListRBMObjectAllOfContent.md index dc887e8..7fa4d9a 100644 --- a/docs/MultiChannelChannelListRBMObjectAllOfContent.md +++ b/docs/MultiChannelChannelListRBMObjectAllOfContent.md @@ -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] diff --git a/docs/RbmActionOpenUrl.md b/docs/RbmActionOpenUrl.md index 0e36fcd..112070a 100644 --- a/docs/RbmActionOpenUrl.md +++ b/docs/RbmActionOpenUrl.md @@ -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] diff --git a/docs/RbmActionViewLocation.md b/docs/RbmActionViewLocation.md index 1f1ed48..e88c044 100644 --- a/docs/RbmActionViewLocation.md +++ b/docs/RbmActionViewLocation.md @@ -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 diff --git a/docs/RbmCardContent.md b/docs/RbmCardContent.md index a83d013..ffafc44 100644 --- a/docs/RbmCardContent.md +++ b/docs/RbmCardContent.md @@ -1,5 +1,6 @@ # RbmCardContent +Must contain at least one of title, description, or media to be valid. ## Properties diff --git a/docs/RbmMessageContentRichCard.md b/docs/RbmMessageContentRichCard.md index 8032c4d..4532874 100644 --- a/docs/RbmMessageContentRichCard.md +++ b/docs/RbmMessageContentRichCard.md @@ -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] diff --git a/docs/RbmStandaloneCard.md b/docs/RbmStandaloneCard.md index 67aabc3..93cb6d0 100644 --- a/docs/RbmStandaloneCard.md +++ b/docs/RbmStandaloneCard.md @@ -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] diff --git a/docs/RbmWebViewEnum.md b/docs/RbmWebViewEnum.md index ee61bc7..441334c 100644 --- a/docs/RbmWebViewEnum.md +++ b/docs/RbmWebViewEnum.md @@ -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 diff --git a/docs/TfvStatus.md b/docs/TfvStatus.md index 6c61c13..a1853ea 100644 --- a/docs/TfvStatus.md +++ b/docs/TfvStatus.md @@ -9,6 +9,8 @@ Name | Type | Description | Notes **status** | [**TfvStatusEnum**](TfvStatusEnum.md) | | [optional] [default to undefined] **internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. | [optional] [default to undefined] **declineReasonDescription** | **string** | Explanation for why a verification request was declined. | [optional] [default to undefined] +**denialStatusCode** | **number** | Reason code for denial. | [optional] [default to undefined] +**additionalDenialReasons** | [**Array<AdditionalDenialReason>**](AdditionalDenialReason.md) | An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. | [optional] [default to undefined] **resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined] **createdDateTime** | **string** | Date and time the verification request was created. | [optional] [default to undefined] **modifiedDateTime** | **string** | Date and time the verification request was last modified. | [optional] [default to undefined] @@ -27,6 +29,8 @@ const instance: TfvStatus = { status, internalTicketNumber, declineReasonDescription, + denialStatusCode, + additionalDenialReasons, resubmitAllowed, createdDateTime, modifiedDateTime, diff --git a/docs/ThumbnailAlignmentEnum.md b/docs/ThumbnailAlignmentEnum.md index b6dcc80..b846800 100644 --- a/docs/ThumbnailAlignmentEnum.md +++ b/docs/ThumbnailAlignmentEnum.md @@ -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 diff --git a/models/multi-channel-action-calendar-event.ts b/models/multi-channel-action-calendar-event.ts index bd86f36..1ca5e90 100644 --- a/models/multi-channel-action-calendar-event.ts +++ b/models/multi-channel-action-calendar-event.ts @@ -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; /** diff --git a/models/multi-channel-action.ts b/models/multi-channel-action.ts index 62c5045..fe7b201 100644 --- a/models/multi-channel-action.ts +++ b/models/multi-channel-action.ts @@ -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; /** @@ -69,11 +69,11 @@ 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; /** @@ -81,7 +81,7 @@ export interface MultiChannelAction { */ 'description'?: string; /** - * The URL to open in browser. + * The URL to open in browser. Must use http:// or https:// scheme. */ 'url': string; 'application'?: RbmOpenUrlEnum; diff --git a/models/rbm-action-open-url.ts b/models/rbm-action-open-url.ts index 6fb3f3b..d28784b 100644 --- a/models/rbm-action-open-url.ts +++ b/models/rbm-action-open-url.ts @@ -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; diff --git a/models/rbm-action-view-location.ts b/models/rbm-action-view-location.ts index 9e0510e..766b681 100644 --- a/models/rbm-action-view-location.ts +++ b/models/rbm-action-view-location.ts @@ -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; /** diff --git a/models/rbm-card-content.ts b/models/rbm-card-content.ts index b11fb43..33ca095 100644 --- a/models/rbm-card-content.ts +++ b/models/rbm-card-content.ts @@ -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. diff --git a/models/rbm-standalone-card.ts b/models/rbm-standalone-card.ts index 5072ce8..758e61b 100644 --- a/models/rbm-standalone-card.ts +++ b/models/rbm-standalone-card.ts @@ -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. diff --git a/models/rbm-web-view-enum.ts b/models/rbm-web-view-enum.ts index 2654665..5418bdf 100644 --- a/models/rbm-web-view-enum.ts +++ b/models/rbm-web-view-enum.ts @@ -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 = { diff --git a/models/tfv-status.ts b/models/tfv-status.ts index 9ce491c..d0a2a2b 100644 --- a/models/tfv-status.ts +++ b/models/tfv-status.ts @@ -13,6 +13,9 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import type { AdditionalDenialReason } from './additional-denial-reason'; // May contain unused imports in some cases // @ts-ignore import type { TfvStatusEnum } from './tfv-status-enum'; @@ -34,6 +37,14 @@ export interface TfvStatus { * Explanation for why a verification request was declined. */ 'declineReasonDescription'?: string; + /** + * Reason code for denial. + */ + 'denialStatusCode'?: number | null; + /** + * An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. + */ + 'additionalDenialReasons'?: Array | null; /** * Whether a Toll-Free Verification request qualifies for resubmission via PUT. */ diff --git a/models/thumbnail-alignment-enum.ts b/models/thumbnail-alignment-enum.ts index c1336eb..f830afc 100644 --- a/models/thumbnail-alignment-enum.ts +++ b/models/thumbnail-alignment-enum.ts @@ -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 = {