Skip to content

Commit 106bb52

Browse files
Generate SDK with OpenAPI Generator Version (#252)
Co-authored-by: DX-Bandwidth <dx@bandwidth.com>
1 parent 24da4e0 commit 106bb52

8 files changed

Lines changed: 202 additions & 100 deletions

File tree

api/openapi.yaml

Lines changed: 73 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ paths:
3131
description: Gets a list of your media files. No query parameters are supported.
3232
operationId: listMedia
3333
parameters:
34-
- description: Your Bandwidth Account ID.
34+
- description: |
35+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
36+
37+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
3538
example: "9900000"
3639
explode: false
3740
in: path
@@ -131,7 +134,10 @@ paths:
131134
file with the same name.
132135
operationId: deleteMedia
133136
parameters:
134-
- description: Your Bandwidth Account ID.
137+
- description: |
138+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
139+
140+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
135141
example: "9900000"
136142
explode: false
137143
in: path
@@ -209,7 +215,10 @@ paths:
209215
description: Downloads a media file you previously uploaded.
210216
operationId: getMedia
211217
parameters:
212-
- description: Your Bandwidth Account ID.
218+
- description: |
219+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
220+
221+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
213222
example: "9900000"
214223
explode: false
215224
in: path
@@ -299,7 +308,10 @@ paths:
299308
A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
300309
operationId: uploadMedia
301310
parameters:
302-
- description: Your Bandwidth Account ID.
311+
- description: |
312+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
313+
314+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
303315
example: "9900000"
304316
explode: false
305317
in: path
@@ -406,7 +418,10 @@ paths:
406418
**Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
407419
operationId: listMessages
408420
parameters:
409-
- description: Your Bandwidth Account ID.
421+
- description: |
422+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
423+
424+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
410425
example: "9900000"
411426
explode: false
412427
in: path
@@ -762,7 +777,10 @@ paths:
762777
messaging.
763778
operationId: createMessage
764779
parameters:
765-
- description: Your Bandwidth Account ID.
780+
- description: |
781+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
782+
783+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
766784
example: "9900000"
767785
explode: false
768786
in: path
@@ -851,7 +869,10 @@ paths:
851869
description: Endpoint for sending Multi-Channel messages.
852870
operationId: createMultiChannelMessage
853871
parameters:
854-
- description: Your Bandwidth Account ID.
872+
- description: |
873+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
874+
875+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
855876
example: "9900000"
856877
explode: false
857878
in: path
@@ -7329,7 +7350,10 @@ components:
73297350
code: "500"
73307351
parameters:
73317352
accountId:
7332-
description: Your Bandwidth Account ID.
7353+
description: |
7354+
This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated.
7355+
7356+
**When migrating to OAuth authentication, you must use the 7-digit Account ID.**
73337357
example: "9900000"
73347358
explode: false
73357359
in: path
@@ -7672,6 +7696,16 @@ components:
76727696
schema:
76737697
type: boolean
76747698
style: form
7699+
accountId1:
7700+
description: Your Bandwidth Account ID.
7701+
example: "9900000"
7702+
explode: false
7703+
in: path
7704+
name: accountId
7705+
required: true
7706+
schema:
7707+
type: string
7708+
style: simple
76757709
callId:
76767710
description: Programmable Voice API Call ID.
76777711
example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
@@ -7867,7 +7901,17 @@ components:
78677901
schema:
78687902
type: string
78697903
style: form
7870-
accountId1:
7904+
accountId2:
7905+
description: Your Bandwidth Account ID.
7906+
example: "9900000"
7907+
explode: false
7908+
in: path
7909+
name: accountId
7910+
required: true
7911+
schema:
7912+
type: string
7913+
style: simple
7914+
accountId3:
78717915
explode: false
78727916
in: path
78737917
name: accountId
@@ -7888,6 +7932,16 @@ components:
78887932
format: uuid
78897933
type: string
78907934
style: simple
7935+
accountId4:
7936+
description: Your Bandwidth Account ID.
7937+
example: "9900000"
7938+
explode: false
7939+
in: path
7940+
name: accountId
7941+
required: true
7942+
schema:
7943+
type: string
7944+
style: simple
78917945
tfPhoneNumberPathParam:
78927946
description: Valid Toll-Free telephone number in E.164 format.
78937947
example: "+18885555555"
@@ -7908,6 +7962,16 @@ components:
79087962
schema:
79097963
type: string
79107964
style: simple
7965+
accountId5:
7966+
description: Your Bandwidth Account ID.
7967+
example: "9900000"
7968+
explode: false
7969+
in: path
7970+
name: accountId
7971+
required: true
7972+
schema:
7973+
type: string
7974+
style: simple
79117975
endpointId:
79127976
description: BRTC Endpoint ID.
79137977
explode: false

0 commit comments

Comments
 (0)