Skip to content

Commit 31dcd41

Browse files
ckoegelckoegel
authored
SWI-8645 Fix Multi-Channel Messaging Schemas (#88)
* SWI-8645 Fix Multi-Channel Messaging Schemas * api unit test * smoke test
1 parent a66791a commit 31dcd41

33 files changed

+832
-97
lines changed

‎.openapi-generator/FILES‎

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,14 +113,22 @@ docs/MmsMessageContentFile.md
113113
docs/MultiChannelAction.md
114114
docs/MultiChannelActionCalendarEvent.md
115115
docs/MultiChannelApi.md
116-
docs/MultiChannelChannelListObject.md
117-
docs/MultiChannelChannelListObjectContent.md
116+
docs/MultiChannelChannelListMMSObject.md
117+
docs/MultiChannelChannelListMMSResponseObject.md
118+
docs/MultiChannelChannelListObjectBase.md
119+
docs/MultiChannelChannelListOwnerObject.md
120+
docs/MultiChannelChannelListRBMObject.md
121+
docs/MultiChannelChannelListRBMObjectAllOfContent.md
122+
docs/MultiChannelChannelListRBMResponseObject.md
123+
docs/MultiChannelChannelListRequestObject.md
124+
docs/MultiChannelChannelListResponseObject.md
125+
docs/MultiChannelChannelListSMSObject.md
126+
docs/MultiChannelChannelListSMSResponseObject.md
118127
docs/MultiChannelError.md
119128
docs/MultiChannelMessageChannelEnum.md
120129
docs/MultiChannelMessageContent.md
121130
docs/MultiChannelMessageRequest.md
122131
docs/MultiChannelMessageResponseData.md
123-
docs/MultiChannelMessageResponseDataChannelListInner.md
124132
docs/OptInWorkflow.md
125133
docs/PageInfo.md
126134
docs/PhoneNumberLookupApi.md
@@ -287,13 +295,21 @@ models/mms-message-content.ts
287295
models/model-error.ts
288296
models/multi-channel-action-calendar-event.ts
289297
models/multi-channel-action.ts
290-
models/multi-channel-channel-list-object-content.ts
291-
models/multi-channel-channel-list-object.ts
298+
models/multi-channel-channel-list-mmsobject.ts
299+
models/multi-channel-channel-list-mmsresponse-object.ts
300+
models/multi-channel-channel-list-object-base.ts
301+
models/multi-channel-channel-list-owner-object.ts
302+
models/multi-channel-channel-list-rbmobject-all-of-content.ts
303+
models/multi-channel-channel-list-rbmobject.ts
304+
models/multi-channel-channel-list-rbmresponse-object.ts
305+
models/multi-channel-channel-list-request-object.ts
306+
models/multi-channel-channel-list-response-object.ts
307+
models/multi-channel-channel-list-smsobject.ts
308+
models/multi-channel-channel-list-smsresponse-object.ts
292309
models/multi-channel-error.ts
293310
models/multi-channel-message-channel-enum.ts
294311
models/multi-channel-message-content.ts
295312
models/multi-channel-message-request.ts
296-
models/multi-channel-message-response-data-channel-list-inner.ts
297313
models/multi-channel-message-response-data.ts
298314
models/opt-in-workflow.ts
299315
models/page-info.ts

‎README.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -252,14 +252,22 @@ Class | Method | HTTP request | Description
252252
- [ModelError](docs/ModelError.md)
253253
- [MultiChannelAction](docs/MultiChannelAction.md)
254254
- [MultiChannelActionCalendarEvent](docs/MultiChannelActionCalendarEvent.md)
255-
- [MultiChannelChannelListObject](docs/MultiChannelChannelListObject.md)
256-
- [MultiChannelChannelListObjectContent](docs/MultiChannelChannelListObjectContent.md)
255+
- [MultiChannelChannelListMMSObject](docs/MultiChannelChannelListMMSObject.md)
256+
- [MultiChannelChannelListMMSResponseObject](docs/MultiChannelChannelListMMSResponseObject.md)
257+
- [MultiChannelChannelListObjectBase](docs/MultiChannelChannelListObjectBase.md)
258+
- [MultiChannelChannelListOwnerObject](docs/MultiChannelChannelListOwnerObject.md)
259+
- [MultiChannelChannelListRBMObject](docs/MultiChannelChannelListRBMObject.md)
260+
- [MultiChannelChannelListRBMObjectAllOfContent](docs/MultiChannelChannelListRBMObjectAllOfContent.md)
261+
- [MultiChannelChannelListRBMResponseObject](docs/MultiChannelChannelListRBMResponseObject.md)
262+
- [MultiChannelChannelListRequestObject](docs/MultiChannelChannelListRequestObject.md)
263+
- [MultiChannelChannelListResponseObject](docs/MultiChannelChannelListResponseObject.md)
264+
- [MultiChannelChannelListSMSObject](docs/MultiChannelChannelListSMSObject.md)
265+
- [MultiChannelChannelListSMSResponseObject](docs/MultiChannelChannelListSMSResponseObject.md)
257266
- [MultiChannelError](docs/MultiChannelError.md)
258267
- [MultiChannelMessageChannelEnum](docs/MultiChannelMessageChannelEnum.md)
259268
- [MultiChannelMessageContent](docs/MultiChannelMessageContent.md)
260269
- [MultiChannelMessageRequest](docs/MultiChannelMessageRequest.md)
261270
- [MultiChannelMessageResponseData](docs/MultiChannelMessageResponseData.md)
262-
- [MultiChannelMessageResponseDataChannelListInner](docs/MultiChannelMessageResponseDataChannelListInner.md)
263271
- [OptInWorkflow](docs/OptInWorkflow.md)
264272
- [PageInfo](docs/PageInfo.md)
265273
- [PriorityEnum](docs/PriorityEnum.md)

‎bandwidth.yml‎

Lines changed: 78 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2490,7 +2490,7 @@ components:
24902490
$ref: '#/components/schemas/multiChannelAction'
24912491
maxItems: 11
24922492
multiChannelAction:
2493-
oneOf:
2493+
anyOf:
24942494
- $ref: '#/components/schemas/rbmActionBase'
24952495
- $ref: '#/components/schemas/rbmActionDial'
24962496
- $ref: '#/components/schemas/rbmActionViewLocation'
@@ -2505,7 +2505,7 @@ components:
25052505
CREATE_CALENDAR_EVENT: '#/components/schemas/multiChannelActionCalendarEvent'
25062506
OPEN_URL: '#/components/schemas/rbmActionOpenUrl'
25072507
REQUEST_LOCATION: '#/components/schemas/rbmActionBase'
2508-
multiChannelChannelListObject:
2508+
multiChannelChannelListObjectBase:
25092509
type: object
25102510
properties:
25112511
from:
@@ -2514,19 +2514,85 @@ components:
25142514
$ref: '#/components/schemas/applicationId'
25152515
channel:
25162516
$ref: '#/components/schemas/multiChannelMessageChannelEnum'
2517-
content:
2518-
description: The content of the message.
2519-
oneOf:
2520-
- $ref: '#/components/schemas/rbmMessageContentText'
2521-
- $ref: '#/components/schemas/rbmMessageMedia'
2522-
- $ref: '#/components/schemas/rbmMessageContentRichCard'
2523-
- $ref: '#/components/schemas/smsMessageContent'
2524-
- $ref: '#/components/schemas/mmsMessageContent'
25252517
required:
25262518
- from
25272519
- applicationId
25282520
- channel
2521+
multiChannelChannelListRBMObject:
2522+
allOf:
2523+
- $ref: '#/components/schemas/multiChannelChannelListObjectBase'
2524+
- type: object
2525+
properties:
2526+
content:
2527+
description: The content of the message.
2528+
oneOf:
2529+
- $ref: '#/components/schemas/rbmMessageContentText'
2530+
- $ref: '#/components/schemas/rbmMessageMedia'
2531+
- $ref: '#/components/schemas/rbmMessageContentRichCard'
2532+
required:
25292533
- content
2534+
multiChannelChannelListSMSObject:
2535+
allOf:
2536+
- $ref: '#/components/schemas/multiChannelChannelListObjectBase'
2537+
- type: object
2538+
properties:
2539+
content:
2540+
$ref: '#/components/schemas/smsMessageContent'
2541+
required:
2542+
- content
2543+
multiChannelChannelListMMSObject:
2544+
allOf:
2545+
- $ref: '#/components/schemas/multiChannelChannelListObjectBase'
2546+
- type: object
2547+
properties:
2548+
content:
2549+
$ref: '#/components/schemas/mmsMessageContent'
2550+
required:
2551+
- content
2552+
multiChannelChannelListRBMResponseObject:
2553+
allOf:
2554+
- $ref: '#/components/schemas/multiChannelChannelListRBMObject'
2555+
- $ref: '#/components/schemas/multiChannelChannelListOwnerObject'
2556+
multiChannelChannelListSMSResponseObject:
2557+
allOf:
2558+
- $ref: '#/components/schemas/multiChannelChannelListSMSObject'
2559+
- $ref: '#/components/schemas/multiChannelChannelListOwnerObject'
2560+
multiChannelChannelListMMSResponseObject:
2561+
allOf:
2562+
- $ref: '#/components/schemas/multiChannelChannelListMMSObject'
2563+
- $ref: '#/components/schemas/multiChannelChannelListOwnerObject'
2564+
multiChannelChannelListRequestObject:
2565+
anyOf:
2566+
- $ref: '#/components/schemas/multiChannelChannelListRBMObject'
2567+
- $ref: '#/components/schemas/multiChannelChannelListSMSObject'
2568+
- $ref: '#/components/schemas/multiChannelChannelListMMSObject'
2569+
discriminator:
2570+
propertyName: channel
2571+
mapping:
2572+
RBM: '#/components/schemas/multiChannelChannelListRBMObject'
2573+
SMS: '#/components/schemas/multiChannelChannelListSMSObject'
2574+
MMS: '#/components/schemas/multiChannelChannelListMMSObject'
2575+
multiChannelChannelListOwnerObject:
2576+
type: object
2577+
properties:
2578+
owner:
2579+
type: string
2580+
description: >-
2581+
The Bandwidth senderId associated with the message. Identical to
2582+
'from'.
2583+
required:
2584+
- owner
2585+
multiChannelChannelListResponseObject:
2586+
anyOf:
2587+
- $ref: '#/components/schemas/multiChannelChannelListRBMResponseObject'
2588+
- $ref: '#/components/schemas/multiChannelChannelListSMSResponseObject'
2589+
- $ref: '#/components/schemas/multiChannelChannelListMMSResponseObject'
2590+
discriminator:
2591+
propertyName: channel
2592+
mapping:
2593+
RBM: '#/components/schemas/multiChannelChannelListRBMResponseObject'
2594+
SMS: '#/components/schemas/multiChannelChannelListSMSResponseObject'
2595+
MMS: '#/components/schemas/multiChannelChannelListMMSResponseObject'
25302596
multiChannelMessageRequest:
25312597
description: Multi-Channel Message Request
25322598
type: object
@@ -2540,7 +2606,7 @@ components:
25402606
order they are listed. Once a message sends successfully, the others
25412607
will be ignored.
25422608
items:
2543-
$ref: '#/components/schemas/multiChannelChannelListObject'
2609+
$ref: '#/components/schemas/multiChannelChannelListRequestObject'
25442610
maxItems: 4
25452611
tag:
25462612
$ref: '#/components/schemas/tag'
@@ -2573,17 +2639,7 @@ components:
25732639
order they are listed. Once a message sends successfully, the others
25742640
will be ignored.
25752641
items:
2576-
allOf:
2577-
- $ref: '#/components/schemas/multiChannelChannelListObject'
2578-
- type: object
2579-
properties:
2580-
owner:
2581-
type: string
2582-
description: >-
2583-
The Bandwidth senderId associated with the message.
2584-
Identical to 'from'.
2585-
required:
2586-
- owner
2642+
$ref: '#/components/schemas/multiChannelChannelListResponseObject'
25872643
maxItems: 4
25882644
tag:
25892645
$ref: '#/components/schemas/tag'

docs/MultiChannelChannelListObject.md renamed to docs/MultiChannelChannelListMMSObject.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MultiChannelChannelListObject
1+
# MultiChannelChannelListMMSObject
22

33

44
## Properties
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
88
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
99
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
1010
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
11-
**content** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) | | [default to undefined]
11+
**content** | [**MmsMessageContent**](MmsMessageContent.md) | | [default to undefined]
1212

1313
## Example
1414

1515
```typescript
16-
import { MultiChannelChannelListObject } from 'bandwidth-sdk';
16+
import { MultiChannelChannelListMMSObject } from 'bandwidth-sdk';
1717

18-
const instance: MultiChannelChannelListObject = {
18+
const instance: MultiChannelChannelListMMSObject = {
1919
from,
2020
applicationId,
2121
channel,

docs/MultiChannelMessageResponseDataChannelListInner.md renamed to docs/MultiChannelChannelListMMSResponseObject.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MultiChannelMessageResponseDataChannelListInner
1+
# MultiChannelChannelListMMSResponseObject
22

33

44
## Properties
@@ -8,15 +8,15 @@ Name | Type | Description | Notes
88
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
99
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
1010
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
11-
**content** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) | | [default to undefined]
11+
**content** | [**MmsMessageContent**](MmsMessageContent.md) | | [default to undefined]
1212
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
1313

1414
## Example
1515

1616
```typescript
17-
import { MultiChannelMessageResponseDataChannelListInner } from 'bandwidth-sdk';
17+
import { MultiChannelChannelListMMSResponseObject } from 'bandwidth-sdk';
1818

19-
const instance: MultiChannelMessageResponseDataChannelListInner = {
19+
const instance: MultiChannelChannelListMMSResponseObject = {
2020
from,
2121
applicationId,
2222
channel,

‎docs/MultiChannelChannelListObjectBase.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# MultiChannelChannelListObjectBase
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
9+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
10+
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
11+
12+
## Example
13+
14+
```typescript
15+
import { MultiChannelChannelListObjectBase } from 'bandwidth-sdk';
16+
17+
const instance: MultiChannelChannelListObjectBase = {
18+
from,
19+
applicationId,
20+
channel,
21+
};
22+
```
23+
24+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/MultiChannelChannelListOwnerObject.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# MultiChannelChannelListOwnerObject
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
9+
10+
## Example
11+
12+
```typescript
13+
import { MultiChannelChannelListOwnerObject } from 'bandwidth-sdk';
14+
15+
const instance: MultiChannelChannelListOwnerObject = {
16+
owner,
17+
};
18+
```
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/MultiChannelChannelListRBMObject.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# MultiChannelChannelListRBMObject
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
9+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
10+
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
11+
**content** | [**MultiChannelChannelListRBMObjectAllOfContent**](MultiChannelChannelListRBMObjectAllOfContent.md) | | [default to undefined]
12+
13+
## Example
14+
15+
```typescript
16+
import { MultiChannelChannelListRBMObject } from 'bandwidth-sdk';
17+
18+
const instance: MultiChannelChannelListRBMObject = {
19+
from,
20+
applicationId,
21+
channel,
22+
content,
23+
};
24+
```
25+
26+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/MultiChannelChannelListObjectContent.md renamed to docs/MultiChannelChannelListRBMObjectAllOfContent.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# MultiChannelChannelListObjectContent
1+
# MultiChannelChannelListRBMObjectAllOfContent
22

33
The content of the message.
44

55
## Properties
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [default to undefined]
9+
**text** | **string** | The text associated with the message. Must be 3270 characters or less | [default to undefined]
1010
**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]
11-
**media** | [**Array<MmsMessageContentFile>**](MmsMessageContentFile.md) | | [default to undefined]
11+
**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [default to undefined]
1212
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined]
1313
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined]
1414
**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined]
@@ -18,9 +18,9 @@ Name | Type | Description | Notes
1818
## Example
1919

2020
```typescript
21-
import { MultiChannelChannelListObjectContent } from 'bandwidth-sdk';
21+
import { MultiChannelChannelListRBMObjectAllOfContent } from 'bandwidth-sdk';
2222

23-
const instance: MultiChannelChannelListObjectContent = {
23+
const instance: MultiChannelChannelListRBMObjectAllOfContent = {
2424
text,
2525
suggestions,
2626
media,

‎docs/MultiChannelChannelListRBMResponseObject.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# MultiChannelChannelListRBMResponseObject
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
9+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
10+
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
11+
**content** | [**MultiChannelChannelListRBMObjectAllOfContent**](MultiChannelChannelListRBMObjectAllOfContent.md) | | [default to undefined]
12+
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
13+
14+
## Example
15+
16+
```typescript
17+
import { MultiChannelChannelListRBMResponseObject } from 'bandwidth-sdk';
18+
19+
const instance: MultiChannelChannelListRBMResponseObject = {
20+
from,
21+
applicationId,
22+
channel,
23+
content,
24+
owner,
25+
};
26+
```
27+
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)