Skip to content

Commit e501e65

Browse files
band-swi-release-engineering[bot]DX-Bandwidth
band-swi-release-engineering[bot]
and
DX-Bandwidth
authored
Generate SDK with OpenAPI Generator Version (#182)
Co-authored-by: DX-Bandwidth <[email protected]>
1 parent 049754e commit e501e65

File tree

4 files changed

+77
-53
lines changed

4 files changed

+77
-53
lines changed

‎api/openapi.yaml

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -780,6 +780,7 @@ paths:
780780
- description: "Not intended for explicit use. To use pagination, follow the\
781781
\ links in the `Link` header of the response, as indicated in the endpoint\
782782
\ description."
783+
example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9
783784
explode: true
784785
in: query
785786
name: pageToken
@@ -1434,6 +1435,7 @@ paths:
14341435
- description: "Not intended for explicit use. To use pagination, follow the\
14351436
\ links in the `Link` header of the response, as indicated in the endpoint\
14361437
\ description."
1438+
example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9
14371439
explode: true
14381440
in: query
14391441
name: pageToken
@@ -6309,6 +6311,7 @@ components:
63096311
pageToken1:
63106312
description: "Not intended for explicit use. To use pagination, follow the links\
63116313
\ in the `Link` header of the response, as indicated in the endpoint description."
6314+
example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9
63126315
explode: true
63136316
in: query
63146317
name: pageToken
@@ -7296,12 +7299,14 @@ components:
72967299
enum:
72977300
- INBOUND
72987301
- OUTBOUND
7302+
example: INBOUND
72997303
type: string
73007304
messageDirectionEnum:
73017305
description: The direction of the message. One of in out.
73027306
enum:
73037307
- in
73047308
- out
7309+
example: in
73057310
type: string
73067311
messageTypeEnum:
73077312
description: The type of message. Either SMS or MMS.
@@ -11546,20 +11551,23 @@ components:
1154611551
type: string
1154711552
useCaseSummary:
1154811553
description: A general idea of the use case and customer.
11554+
example: Text summarizing the use case for the toll-free number
1154911555
maxLength: 500
11550-
minLength: 1
11556+
minLength: 0
1155111557
nullable: false
1155211558
type: string
1155311559
productionMessageContent:
1155411560
description: Example of message content.
11561+
example: Production message content
1155511562
maxLength: 500
11556-
minLength: 1
11563+
minLength: 0
1155711564
nullable: false
1155811565
type: string
1155911566
optInWorkflow:
1156011567
$ref: '#/components/schemas/optInWorkflow'
1156111568
additionalInformation:
1156211569
description: Any additional information.
11570+
example: Any additional information
1156311571
maxLength: 500
1156411572
minLength: 0
1156511573
nullable: true
@@ -11601,12 +11609,14 @@ components:
1160111609
type: string
1160211610
useCaseSummary:
1160311611
description: A general idea of the use case and customer.
11612+
example: Text summarizing the use case for the toll-free number
1160411613
maxLength: 500
1160511614
minLength: 0
1160611615
nullable: false
1160711616
type: string
1160811617
productionMessageContent:
1160911618
description: Example of message content.
11619+
example: Production message content
1161011620
maxLength: 500
1161111621
minLength: 0
1161211622
nullable: false
@@ -11638,9 +11648,11 @@ components:
1163811648
tfvBasicAuthentication:
1163911649
properties:
1164011650
username:
11651+
example: username
1164111652
maxLength: 100
1164211653
type: string
1164311654
password:
11655+
example: password
1164411656
maxLength: 200
1164511657
type: string
1164611658
required:
@@ -11798,7 +11810,7 @@ components:
1179811810
address:
1179911811
example:
1180011812
zip: "27606"
11801-
addr2: addr2
11813+
addr2: 2230 Bandmate Way
1180211814
addr1: 2230 Bandmate Way
1180311815
city: Raleigh
1180411816
name: Bandwidth Inc.
@@ -11822,6 +11834,7 @@ components:
1182211834
type: string
1182311835
addr2:
1182411836
description: The address of the business using the toll-free number.
11837+
example: 2230 Bandmate Way
1182511838
maxLength: 500
1182611839
minLength: 0
1182711840
nullable: true
@@ -11862,6 +11875,12 @@ components:
1186211875
- url
1186311876
- zip
1186411877
type: object
11878+
additionalInformation:
11879+
description: Any additional information.
11880+
maxLength: 500
11881+
minLength: 0
11882+
nullable: true
11883+
type: string
1186511884
optInWorkflow:
1186611885
example:
1186711886
imageUrls:
@@ -11981,6 +12000,20 @@ components:
1198112000
maxLength: 500
1198212001
minLength: 0
1198312002
type: string
12003+
useCaseSummary:
12004+
description: A general idea of the use case and customer.
12005+
example: Text summarizing the use case for the toll-free number
12006+
maxLength: 500
12007+
minLength: 0
12008+
nullable: false
12009+
type: string
12010+
productionMessageContent:
12011+
description: Example of message content.
12012+
example: Production message content
12013+
maxLength: 500
12014+
minLength: 0
12015+
nullable: false
12016+
type: string
1198412017
webhookSubscriptionsListBody:
1198512018
description: A list of all webhook subscriptions registered for this account
1198612019
ID for this particular feature (unpaginated).
@@ -12179,7 +12212,7 @@ components:
1217912212
createdDateTime: 2021-06-08T06:45:13Z
1218012213
modifiedDateTime: 2021-06-08T06:45:13Z
1218112214
submission:
12182-
additionalInformation: Any additional information
12215+
additionalInformation: additionalInformation
1218312216
useCase: 2FA
1218412217
isvReseller: Test ISV
1218512218
businessContact:
@@ -12191,7 +12224,7 @@ components:
1219112224
productionMessageContent: Production message content
1219212225
businessAddress:
1219312226
zip: "27606"
12194-
addr2: addr2
12227+
addr2: 2230 Bandmate Way
1219512228
addr1: 2230 Bandmate Way
1219612229
city: Raleigh
1219712230
name: Bandwidth Inc.
@@ -12250,7 +12283,7 @@ components:
1225012283
type: object
1225112284
tfvSubmissionInfo:
1225212285
example:
12253-
additionalInformation: Any additional information
12286+
additionalInformation: additionalInformation
1225412287
useCase: 2FA
1225512288
isvReseller: Test ISV
1225612289
businessContact:
@@ -12262,7 +12295,7 @@ components:
1226212295
productionMessageContent: Production message content
1226312296
businessAddress:
1226412297
zip: "27606"
12265-
addr2: addr2
12298+
addr2: 2230 Bandmate Way
1226612299
addr1: 2230 Bandmate Way
1226712300
city: Raleigh
1226812301
name: Bandwidth Inc.
@@ -12309,7 +12342,6 @@ components:
1230912342
$ref: '#/components/schemas/optInWorkflow'
1231012343
additionalInformation:
1231112344
description: Any additional information.
12312-
example: Any additional information
1231312345
maxLength: 500
1231412346
minLength: 0
1231512347
nullable: true

‎bandwidth.yml

Lines changed: 35 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1641,12 +1641,14 @@ components:
16411641
enum:
16421642
- INBOUND
16431643
- OUTBOUND
1644+
example: INBOUND
16441645
messageDirectionEnum:
16451646
type: string
16461647
description: The direction of the message. One of in out.
16471648
enum:
16481649
- in
16491650
- out
1651+
example: in
16501652
messageTypeEnum:
16511653
type: string
16521654
description: The type of message. Either SMS or MMS.
@@ -4797,17 +4799,9 @@ components:
47974799
useCase:
47984800
$ref: '#/components/schemas/useCase'
47994801
useCaseSummary:
4800-
type: string
4801-
description: A general idea of the use case and customer.
4802-
minLength: 1
4803-
maxLength: 500
4804-
nullable: false
4802+
$ref: '#/components/schemas/useCaseSummary'
48054803
productionMessageContent:
4806-
type: string
4807-
description: Example of message content.
4808-
minLength: 1
4809-
maxLength: 500
4810-
nullable: false
4804+
$ref: '#/components/schemas/productionMessageContent'
48114805
optInWorkflow:
48124806
$ref: '#/components/schemas/optInWorkflow'
48134807
additionalInformation:
@@ -4816,6 +4810,7 @@ components:
48164810
minLength: 0
48174811
maxLength: 500
48184812
nullable: true
4813+
example: Any additional information
48194814
isvReseller:
48204815
$ref: '#/components/schemas/isvReseller'
48214816
verificationUpdateRequest:
@@ -4842,25 +4837,13 @@ components:
48424837
useCase:
48434838
$ref: '#/components/schemas/useCase'
48444839
useCaseSummary:
4845-
type: string
4846-
description: A general idea of the use case and customer.
4847-
minLength: 0
4848-
maxLength: 500
4849-
nullable: false
4840+
$ref: '#/components/schemas/useCaseSummary'
48504841
productionMessageContent:
4851-
type: string
4852-
description: Example of message content.
4853-
minLength: 0
4854-
maxLength: 500
4855-
nullable: false
4842+
$ref: '#/components/schemas/productionMessageContent'
48564843
optInWorkflow:
48574844
$ref: '#/components/schemas/optInWorkflow'
48584845
additionalInformation:
4859-
type: string
4860-
description: Any additional information.
4861-
minLength: 0
4862-
maxLength: 500
4863-
nullable: true
4846+
$ref: '#/components/schemas/additionalInformation'
48644847
isvReseller:
48654848
$ref: '#/components/schemas/isvReseller'
48664849
tfvBasicAuthentication:
@@ -4869,9 +4852,11 @@ components:
48694852
username:
48704853
type: string
48714854
maxLength: 100
4855+
example: username
48724856
password:
48734857
type: string
48744858
maxLength: 200
4859+
example: password
48754860
required:
48764861
- username
48774862
- password
@@ -4986,6 +4971,7 @@ components:
49864971
minLength: 0
49874972
maxLength: 500
49884973
nullable: true
4974+
example: 2230 Bandmate Way
49894975
city:
49904976
type: string
49914977
description: The city of the business using the toll-free number.
@@ -5014,6 +5000,12 @@ components:
50145000
maxLength: 500
50155001
nullable: false
50165002
example: https://www.example.com/path/to/resource
5003+
additionalInformation:
5004+
type: string
5005+
description: Any additional information.
5006+
minLength: 0
5007+
maxLength: 500
5008+
nullable: true
50175009
optInWorkflow:
50185010
type: object
50195011
nullable: false
@@ -5101,6 +5093,20 @@ components:
51015093
minLength: 0
51025094
maxLength: 500
51035095
example: 2FA
5096+
useCaseSummary:
5097+
type: string
5098+
description: A general idea of the use case and customer.
5099+
minLength: 0
5100+
maxLength: 500
5101+
nullable: false
5102+
example: Text summarizing the use case for the toll-free number
5103+
productionMessageContent:
5104+
type: string
5105+
description: Example of message content.
5106+
minLength: 0
5107+
maxLength: 500
5108+
nullable: false
5109+
example: Production message content
51045110
webhookSubscriptionsListBody:
51055111
description: >-
51065112
A list of all webhook subscriptions registered for this account ID for
@@ -5277,28 +5283,13 @@ components:
52775283
useCase:
52785284
$ref: '#/components/schemas/useCase'
52795285
useCaseSummary:
5280-
type: string
5281-
description: A general idea of the use case and customer.
5282-
minLength: 0
5283-
maxLength: 500
5284-
nullable: false
5285-
example: Text summarizing the use case for the toll-free number
5286+
$ref: '#/components/schemas/useCaseSummary'
52865287
productionMessageContent:
5287-
type: string
5288-
description: Example of message content.
5289-
minLength: 0
5290-
maxLength: 500
5291-
nullable: false
5292-
example: Production message content
5288+
$ref: '#/components/schemas/productionMessageContent'
52935289
optInWorkflow:
52945290
$ref: '#/components/schemas/optInWorkflow'
52955291
additionalInformation:
5296-
type: string
5297-
description: Any additional information.
5298-
minLength: 0
5299-
maxLength: 500
5300-
nullable: true
5301-
example: Any additional information
5292+
$ref: '#/components/schemas/additionalInformation'
53025293
isvReseller:
53035294
$ref: '#/components/schemas/isvReseller'
53045295
tfvStatusEnum:
@@ -6235,6 +6226,7 @@ components:
62356226
Not intended for explicit use. To use pagination, follow the links in
62366227
the `Link` header of the response, as indicated in the endpoint
62376228
description.
6229+
example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9
62386230
disconnectCause:
62396231
name: disconnectCause
62406232
in: query

‎docs/CallsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ public class Example {
203203
String maxStartTime = "2022-06-21T19:13:21Z"; // String | Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
204204
String disconnectCause = "hangup"; // String | Filter results to calls with specified call Disconnect Cause.
205205
Integer pageSize = 1000; // Integer | Specifies the max number of calls that will be returned.
206-
String pageToken = "pageToken_example"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
206+
String pageToken = "eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
207207
try {
208208
List<CallState> result = apiInstance.listCalls(accountId, to, from, minStartTime, maxStartTime, disconnectCause, pageSize, pageToken);
209209
System.out.println(result);

‎docs/ConferencesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ public class Example {
445445
String minCreatedTime = "2022-06-21T19:13:21Z"; // String | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format).
446446
String maxCreatedTime = "2022-06-21T19:13:21Z"; // String | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format).
447447
Integer pageSize = 1000; // Integer | Specifies the max number of conferences that will be returned.
448-
String pageToken = "pageToken_example"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
448+
String pageToken = "eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
449449
try {
450450
List<Conference> result = apiInstance.listConferences(accountId, name, minCreatedTime, maxCreatedTime, pageSize, pageToken);
451451
System.out.println(result);

0 commit comments

Comments
 (0)