Skip to content

Commit 152fa1a

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-10306 Update SDK Based on Recent Spec Changes (#236)
* Generate SDK with OpenAPI Generator Version * update tests * remove unused file --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent 1aeb6ea commit 152fa1a

9 files changed

Lines changed: 309 additions & 84 deletions

File tree

api/openapi.yaml

Lines changed: 120 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4740,6 +4740,10 @@ paths:
47404740
$ref: "#/components/examples/lookupCompleteWithDniExample"
47414741
lookupCompleteExample:
47424742
$ref: "#/components/examples/lookupCompleteExample"
4743+
lookupCompleteWithRcsExample:
4744+
$ref: "#/components/examples/lookupCompleteWithRcsExample"
4745+
lookupCompleteWithRcsErrorExample:
4746+
$ref: "#/components/examples/lookupCompleteWithRcsErrorExample"
47434747
lookupPartialExample:
47444748
$ref: "#/components/examples/lookupPartialExample"
47454749
lookupFailedExample:
@@ -4801,8 +4805,8 @@ paths:
48014805
content:
48024806
application/json:
48034807
examples:
4804-
lookupInProgressExample:
4805-
$ref: "#/components/examples/lookupInProgressExample"
4808+
lookupAcceptedExample:
4809+
$ref: "#/components/examples/lookupAcceptedExample"
48064810
schema:
48074811
$ref: "#/components/schemas/createAsyncBulkLookupResponse"
48084812
description: Accepted
@@ -6220,25 +6224,31 @@ components:
62206224
phoneNumbers:
62216225
- "+19196104423"
62226226
- "+19196104424"
6223-
lookupInProgressExample:
6224-
summary: Numbers Lookup In Progress
6227+
lookupAcceptedExample:
6228+
summary: Numbers Lookup Accepted
62256229
value:
62266230
links:
6227-
- href: href
6228-
rel: rel
6231+
- href: /accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590
6232+
rel: createdRequest
62296233
method: GET
62306234
data:
62316235
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
62326236
status: IN_PROGRESS
62336237
results: []
62346238
errors: []
6239+
lookupInProgressExample:
6240+
summary: Numbers Lookup In Progress
6241+
value:
6242+
links: []
6243+
data:
6244+
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
6245+
status: IN_PROGRESS
6246+
results: []
6247+
errors: []
62356248
lookupFailedExample:
62366249
summary: Numbers Lookup Failed
62376250
value:
6238-
links:
6239-
- href: href
6240-
rel: rel
6241-
method: GET
6251+
links: []
62426252
data:
62436253
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
62446254
status: FAILED
@@ -6256,10 +6266,7 @@ components:
62566266
lookupPartialExample:
62576267
summary: Numbers Lookup Partial Complete
62586268
value:
6259-
links:
6260-
- href: href
6261-
rel: rel
6262-
method: GET
6269+
links: []
62636270
data:
62646271
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
62656272
status: PARTIAL_COMPLETE
@@ -6287,10 +6294,7 @@ components:
62876294
lookupCompleteExample:
62886295
summary: Numbers Lookup Complete (without DNI)
62896296
value:
6290-
links:
6291-
- href: href
6292-
rel: rel
6293-
method: GET
6297+
links: []
62946298
data:
62956299
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
62966300
status: COMPLETE
@@ -6309,10 +6313,7 @@ components:
63096313
lookupCompleteWithDniExample:
63106314
summary: Numbers Lookup Complete (with DNI)
63116315
value:
6312-
links:
6313-
- href: href
6314-
rel: rel
6315-
method: GET
6316+
links: []
63166317
data:
63176318
requestId: 20732adf-bf81-8b17-41b1-004223a05590
63186319
status: COMPLETE
@@ -6350,6 +6351,58 @@ components:
63506351
deactivationEvent: DEACTIVATED
63516352
latestMessageDeliveryStatus: NOT_ENABLED
63526353
errors: []
6354+
lookupCompleteWithRcsExample:
6355+
summary: Numbers Lookup Complete (with RCS)
6356+
value:
6357+
links: []
6358+
data:
6359+
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
6360+
status: COMPLETE
6361+
results:
6362+
- phoneNumber: "+10072904497"
6363+
lineType: MOBILE
6364+
messagingProvider: Verizon Wireless
6365+
voiceProvider: Verizon Wireless
6366+
countryCodeA3: USA
6367+
rcsEnabled: true
6368+
- phoneNumber: "+10072904498"
6369+
lineType: MOBILE
6370+
messagingProvider: T-Mobile USA
6371+
voiceProvider: T-Mobile USA
6372+
countryCodeA3: USA
6373+
rcsEnabled: false
6374+
errors: []
6375+
lookupCompleteWithRcsErrorExample:
6376+
summary: Numbers Lookup Complete (with RCS error)
6377+
value:
6378+
links: []
6379+
data:
6380+
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
6381+
status: COMPLETE
6382+
results:
6383+
- phoneNumber: "+10072904497"
6384+
lineType: MOBILE
6385+
messagingProvider: Verizon Wireless
6386+
voiceProvider: Verizon Wireless
6387+
countryCodeA3: USA
6388+
- phoneNumber: "+10072904498"
6389+
lineType: MOBILE
6390+
messagingProvider: T-Mobile USA
6391+
voiceProvider: T-Mobile USA
6392+
countryCodeA3: USA
6393+
errors:
6394+
- code: RCS_SERVICE_UNAVAILABLE
6395+
type: rcs-error
6396+
description: An exception was thrown during the async RCS service call.
6397+
meta:
6398+
phoneNumbers:
6399+
- "+10072904497"
6400+
- code: MISSING_FROM_RESPONSE
6401+
type: rcs-error
6402+
description: The phone number was absent from the RCS service response.
6403+
meta:
6404+
phoneNumbers:
6405+
- "+10072904498"
63536406
badRequestExample:
63546407
summary: Example Bad Request Error
63556408
value:
@@ -7847,6 +7900,10 @@ components:
78477900
$ref: "#/components/examples/lookupCompleteWithDniExample"
78487901
lookupCompleteExample:
78497902
$ref: "#/components/examples/lookupCompleteExample"
7903+
lookupCompleteWithRcsExample:
7904+
$ref: "#/components/examples/lookupCompleteWithRcsExample"
7905+
lookupCompleteWithRcsErrorExample:
7906+
$ref: "#/components/examples/lookupCompleteWithRcsErrorExample"
78507907
lookupPartialExample:
78517908
$ref: "#/components/examples/lookupPartialExample"
78527909
lookupFailedExample:
@@ -7858,8 +7915,8 @@ components:
78587915
content:
78597916
application/json:
78607917
examples:
7861-
lookupInProgressExample:
7862-
$ref: "#/components/examples/lookupInProgressExample"
7918+
lookupAcceptedExample:
7919+
$ref: "#/components/examples/lookupAcceptedExample"
78637920
schema:
78647921
$ref: "#/components/schemas/createAsyncBulkLookupResponse"
78657922
description: Accepted
@@ -13374,6 +13431,10 @@ components:
1337413431
type: string
1337513432
meta:
1337613433
$ref: "#/components/schemas/lookupErrorSchema_meta"
13434+
required:
13435+
- code
13436+
- description
13437+
- type
1337713438
type: object
1337813439
syncLookupRequest:
1337913440
properties:
@@ -13413,6 +13474,7 @@ components:
1341313474
phoneNumber: "+10072904498"
1341413475
countryCodeA3: USA
1341513476
initialMessageDeliveryStatusDate: 2025-06-20
13477+
rcsEnabled: true
1341613478
lineType: MOBILE
1341713479
deactivationReporter: deactivationReporter
1341813480
voiceProvider: Verizon Wireless
@@ -13424,6 +13486,7 @@ components:
1342413486
phoneNumber: "+10072904498"
1342513487
countryCodeA3: USA
1342613488
initialMessageDeliveryStatusDate: 2025-06-20
13489+
rcsEnabled: true
1342713490
lineType: MOBILE
1342813491
deactivationReporter: deactivationReporter
1342913492
voiceProvider: Verizon Wireless
@@ -13518,6 +13581,7 @@ components:
1351813581
phoneNumber: "+10072904498"
1351913582
countryCodeA3: USA
1352013583
initialMessageDeliveryStatusDate: 2025-06-20
13584+
rcsEnabled: true
1352113585
lineType: MOBILE
1352213586
deactivationReporter: deactivationReporter
1352313587
voiceProvider: Verizon Wireless
@@ -13529,6 +13593,7 @@ components:
1352913593
phoneNumber: "+10072904498"
1353013594
countryCodeA3: USA
1353113595
initialMessageDeliveryStatusDate: 2025-06-20
13596+
rcsEnabled: true
1353213597
lineType: MOBILE
1353313598
deactivationReporter: deactivationReporter
1353413599
voiceProvider: Verizon Wireless
@@ -13604,6 +13669,23 @@ components:
1360413669
$ref: "#/components/schemas/lookupErrorSchema"
1360513670
type: array
1360613671
type: object
13672+
rcsErrorEnum:
13673+
description: |-
13674+
[RCS-Only](#section/RCS-Only). Error encountered during RCS capability lookup. Appears as the `code` field in the top-level `errors` array.
13675+
13676+
**RCS service pass-through codes:**
13677+
- `REQUEST_FAILED`: The RCS service returned this error code.
13678+
- `UNKNOWN_CODE`: The RCS service returned this error code.
13679+
- `INVALID_DESTINATION_ADDRESS`: The RCS service returned this error code.
13680+
- `UNKNOWN_STATUS: <code>`: The RCS service returned an unrecognized status code, where `<code>` is the raw value.
13681+
13682+
**Service-level errors:**
13683+
- `MISSING_FROM_RESPONSE`: The phone number was absent from the RCS service response.
13684+
- `RCS_SERVICE_UNAVAILABLE`: An exception was thrown during the async RCS service call.
13685+
- `RCS_SERVICE_DISABLED`: RCS lookup is disabled in configuration.
13686+
- `EMPTY_RESPONSE`: The RCS service returned a null or empty response body.
13687+
example: RCS_SERVICE_UNAVAILABLE
13688+
type: string
1360713689
lookupResult:
1360813690
description: Carrier information results for the specified telephone number.
1360913691
example:
@@ -13614,6 +13696,7 @@ components:
1361413696
phoneNumber: "+10072904498"
1361513697
countryCodeA3: USA
1361613698
initialMessageDeliveryStatusDate: 2025-06-20
13699+
rcsEnabled: true
1361713700
lineType: MOBILE
1361813701
deactivationReporter: deactivationReporter
1361913702
voiceProvider: Verizon Wireless
@@ -13662,13 +13745,18 @@ components:
1366213745
format: date
1366313746
type: string
1366413747
latestMessageDeliveryStatusDate:
13665-
description: "[DNI-Only](#section/DNI-Only). The date bandwidth last received\
13666-
\ delivery status information for this phone number. \nUse this field\
13667-
\ to understand how up-to-date the `latestMessageDeliveryStatus` is.\n\
13668-
Value resets every time the `latestMessageDeliveryStatus` changes."
13748+
description: |-
13749+
[DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number.
13750+
Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is.
13751+
Value resets every time the `latestMessageDeliveryStatus` changes.
1366913752
example: 2025-06-21
1367013753
format: date
1367113754
type: string
13755+
rcsEnabled:
13756+
description: |
13757+
[RCS-Only](#section/RCS-Only). Indicates whether the phone number is capable of receiving RCS messages. Value will be null if account has RCS, but no value was returned. Absent when account does not have RCS.
13758+
example: true
13759+
type: boolean
1367213760
type: object
1367313761
accountId1:
1367413762
description: User's account ID.
@@ -15010,6 +15098,7 @@ components:
1501015098
phoneNumber: "+10072904498"
1501115099
countryCodeA3: USA
1501215100
initialMessageDeliveryStatusDate: 2025-06-20
15101+
rcsEnabled: true
1501315102
lineType: MOBILE
1501415103
deactivationReporter: deactivationReporter
1501515104
voiceProvider: Verizon Wireless
@@ -15021,6 +15110,7 @@ components:
1502115110
phoneNumber: "+10072904498"
1502215111
countryCodeA3: USA
1502315112
initialMessageDeliveryStatusDate: 2025-06-20
15113+
rcsEnabled: true
1502415114
lineType: MOBILE
1502515115
deactivationReporter: deactivationReporter
1502615116
voiceProvider: Verizon Wireless
@@ -15067,6 +15157,7 @@ components:
1506715157
phoneNumber: "+10072904498"
1506815158
countryCodeA3: USA
1506915159
initialMessageDeliveryStatusDate: 2025-06-20
15160+
rcsEnabled: true
1507015161
lineType: MOBILE
1507115162
deactivationReporter: deactivationReporter
1507215163
voiceProvider: Verizon Wireless
@@ -15078,6 +15169,7 @@ components:
1507815169
phoneNumber: "+10072904498"
1507915170
countryCodeA3: USA
1508015171
initialMessageDeliveryStatusDate: 2025-06-20
15172+
rcsEnabled: true
1508115173
lineType: MOBILE
1508215174
deactivationReporter: deactivationReporter
1508315175
voiceProvider: Verizon Wireless

0 commit comments

Comments
 (0)