Skip to content

Commit dba0c4e

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-8532 Update SDK Based on Recent Spec Changes (#80)
* Generate SDK with OpenAPI Generator Version * unit tests * update smoke test --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: ckoegel <[email protected]>
1 parent 6ee7749 commit dba0c4e

29 files changed

+795
-9
lines changed

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ docs/AnswerCallback.md
2222
docs/BlockedWebhook.md
2323
docs/BridgeCompleteCallback.md
2424
docs/BridgeTargetCompleteCallback.md
25+
docs/BusinessEntityTypeEnum.md
26+
docs/BusinessRegistrationTypeEnum.md
2527
docs/CallDirectionEnum.md
2628
docs/CallRecordingMetadata.md
2729
docs/CallState.md
@@ -111,6 +113,7 @@ docs/OptInWorkflow.md
111113
docs/PageInfo.md
112114
docs/PhoneNumberLookupApi.md
113115
docs/PriorityEnum.md
116+
docs/ProductTypeEnum.md
114117
docs/RbmActionBase.md
115118
docs/RbmActionDial.md
116119
docs/RbmActionOpenUrl.md
@@ -186,6 +189,8 @@ models/answer-callback.ts
186189
models/blocked-webhook.ts
187190
models/bridge-complete-callback.ts
188191
models/bridge-target-complete-callback.ts
192+
models/business-entity-type-enum.ts
193+
models/business-registration-type-enum.ts
189194
models/call-direction-enum.ts
190195
models/call-recording-metadata.ts
191196
models/call-state-enum.ts
@@ -269,6 +274,7 @@ models/multi-channel-message-response-data.ts
269274
models/opt-in-workflow.ts
270275
models/page-info.ts
271276
models/priority-enum.ts
277+
models/product-type-enum.ts
272278
models/rbm-action-base.ts
273279
models/rbm-action-dial.ts
274280
models/rbm-action-open-url.ts

‎api/messages-api.ts‎

Lines changed: 105 additions & 7 deletions
Large diffs are not rendered by default.

‎bandwidth.yml‎

Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,18 @@ paths:
179179
- $ref: '#/components/parameters/fromDateTime'
180180
- $ref: '#/components/parameters/toDateTime'
181181
- $ref: '#/components/parameters/campaignId'
182+
- $ref: '#/components/parameters/fromBwLatency'
183+
- $ref: '#/components/parameters/bwQueued'
184+
- $ref: '#/components/parameters/product'
185+
- $ref: '#/components/parameters/location'
186+
- $ref: '#/components/parameters/carrierQueued'
187+
- $ref: '#/components/parameters/fromCarrierLatency'
188+
- $ref: '#/components/parameters/callingNumberCountryA3'
189+
- $ref: '#/components/parameters/calledNumberCountryA3'
190+
- $ref: '#/components/parameters/fromSegmentCount'
191+
- $ref: '#/components/parameters/toSegmentCount'
192+
- $ref: '#/components/parameters/fromMessageSize'
193+
- $ref: '#/components/parameters/toMessageSize'
182194
- $ref: '#/components/parameters/sort'
183195
- $ref: '#/components/parameters/pageToken'
184196
- $ref: '#/components/parameters/limit'
@@ -1716,7 +1728,22 @@ components:
17161728
enum:
17171729
- sms
17181730
- mms
1731+
- rcs
17191732
example: sms
1733+
productTypeEnum:
1734+
type: string
1735+
description: The type of product associated with the message.
1736+
enum:
1737+
- LOCAL_A2P
1738+
- P2P
1739+
- SHORT_CODE_REACH
1740+
- TOLL_FREE
1741+
- HOSTED_SHORT_CODE
1742+
- ALPHA_NUMERIC
1743+
- RBM_MEDIA
1744+
- RBM_RICH
1745+
- RBM_CONVERSATIONAL
1746+
example: P2P
17201747
fieldError:
17211748
type: object
17221749
properties:
@@ -1819,6 +1846,41 @@ components:
18191846
description: The campaign ID of the message if it has one.
18201847
nullable: true
18211848
example: CJEUMDK
1849+
bwLatency:
1850+
type: integer
1851+
description: >-
1852+
The Bandwidth latency of the message in seconds. Only available for
1853+
accounts with the Advanced Quality Metrics feature enabled.
1854+
nullable: true
1855+
example: 20
1856+
carrierLatency:
1857+
type: integer
1858+
description: >-
1859+
The carrier latency of the message in seconds. Only available for
1860+
OUTBOUND messages from accounts with the Advanced Quality Metrics
1861+
feature enabled.
1862+
nullable: true
1863+
example: 20
1864+
callingNumberCountryA3:
1865+
type: string
1866+
description: The A3 country code of the calling number.
1867+
nullable: true
1868+
example: USA
1869+
calledNumberCountryA3:
1870+
type: string
1871+
description: The A3 country code of the called number.
1872+
nullable: true
1873+
example: USA
1874+
product:
1875+
type: string
1876+
description: The messaging product associated with the message.
1877+
nullable: true
1878+
example: P2P
1879+
location:
1880+
type: string
1881+
description: The location ID associated with this message.
1882+
nullable: true
1883+
example: 123ID
18221884
pageInfo:
18231885
title: PageInfo
18241886
type: object
@@ -5478,6 +5540,50 @@ components:
54785540
description: The company 'Doing Business As'.
54795541
example: Another Company Name Inc.
54805542
type: string
5543+
businessRegistrationNumber:
5544+
type: string
5545+
description: >-
5546+
US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
5547+
until early 2026. If a value is provided for this field, a value must be
5548+
provided for `businessRegistrationType` and `businessEntityType`.
5549+
Available starting October 1st, 2025.
5550+
nullable: true
5551+
maxLength: 500
5552+
example: 12-3456789
5553+
businessRegistrationTypeEnum:
5554+
type: string
5555+
description: >-
5556+
The type of business registration number. Optional until early 2026;
5557+
required if `businessRegistrationNumber` is provided. Available starting
5558+
October 1st, 2025.
5559+
enum:
5560+
- EIN
5561+
- CBN
5562+
nullable: true
5563+
businessEntityTypeEnum:
5564+
type: string
5565+
description: >-
5566+
The type of registered business. If no option is applicable, please
5567+
provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
5568+
required if `businessRegistrationNumber` is provided. Available starting
5569+
October 1st, 2025.
5570+
enum:
5571+
- SOLE_PROPRIETOR
5572+
- PRIVATE_PROFIT
5573+
- PUBLIC_PROFIT
5574+
- NON_PROFIT
5575+
- GOVERNMENT
5576+
nullable: true
5577+
helpMessageResponse:
5578+
type: string
5579+
description: A message that gets sent to users requesting help.
5580+
nullable: true
5581+
maxLength: 500
5582+
example: Please contact support for assistance.
5583+
ageGatedContent:
5584+
type: boolean
5585+
description: Indicates whether the content is age-gated.
5586+
example: false
54815587
additionalDenialReason:
54825588
properties:
54835589
statusCode:
@@ -5564,6 +5670,16 @@ components:
55645670
$ref: '#/components/schemas/termsAndConditionsUrl'
55655671
businessDba:
55665672
$ref: '#/components/schemas/businessDba'
5673+
businessRegistrationNumber:
5674+
$ref: '#/components/schemas/businessRegistrationNumber'
5675+
businessRegistrationType:
5676+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
5677+
businessEntityType:
5678+
$ref: '#/components/schemas/businessEntityTypeEnum'
5679+
helpMessageResponse:
5680+
$ref: '#/components/schemas/helpMessageResponse'
5681+
ageGatedContent:
5682+
$ref: '#/components/schemas/ageGatedContent'
55675683
verificationUpdateRequest:
55685684
type: object
55695685
required:
@@ -5603,6 +5719,16 @@ components:
56035719
$ref: '#/components/schemas/termsAndConditionsUrl'
56045720
businessDba:
56055721
$ref: '#/components/schemas/businessDba'
5722+
businessRegistrationNumber:
5723+
$ref: '#/components/schemas/businessRegistrationNumber'
5724+
businessRegistrationType:
5725+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
5726+
businessEntityType:
5727+
$ref: '#/components/schemas/businessEntityTypeEnum'
5728+
helpMessageResponse:
5729+
$ref: '#/components/schemas/helpMessageResponse'
5730+
ageGatedContent:
5731+
$ref: '#/components/schemas/ageGatedContent'
56065732
tfvBasicAuthentication:
56075733
type: object
56085734
properties:
@@ -5806,6 +5932,12 @@ components:
58065932
example: https://www.example.com/path/to/resource
58075933
pattern: >-
58085934
^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
5935+
confirmationResponse:
5936+
type: string
5937+
minLength: 0
5938+
maxLength: 500
5939+
nullable: true
5940+
example: Thank you for opting in!
58095941
isvReseller:
58105942
type: string
58115943
description: ISV name.
@@ -6079,6 +6211,22 @@ components:
60796211
$ref: '#/components/schemas/termsAndConditionsUrl'
60806212
businessDba:
60816213
$ref: '#/components/schemas/businessDba'
6214+
businessRegistrationNumber:
6215+
$ref: '#/components/schemas/businessRegistrationNumber'
6216+
description: >-
6217+
US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
6218+
Available starting October 1st, 2025.
6219+
businessRegistrationType:
6220+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
6221+
description: >-
6222+
The type of business registration number. Available starting October
6223+
1st, 2025.
6224+
businessEntityType:
6225+
$ref: '#/components/schemas/businessEntityTypeEnum'
6226+
description: >-
6227+
The type of registered business. If no option is applicable, please
6228+
provide "SOLE_PROPRIETOR" as a value. Available starting October
6229+
1st, 2025.
60826230
tfvStatusEnum:
60836231
type: string
60846232
enum:
@@ -6940,6 +7088,112 @@ components:
69407088
example: CJEUMDK
69417089
schema:
69427090
type: string
7091+
fromBwLatency:
7092+
in: query
7093+
name: fromBwLatency
7094+
required: false
7095+
description: >-
7096+
The minimum Bandwidth latency of the message in seconds. Only available
7097+
for accounts with the Advanced Quality Metrics feature enabled.
7098+
example: 5
7099+
schema:
7100+
type: integer
7101+
bwQueued:
7102+
in: query
7103+
name: bwQueued
7104+
required: false
7105+
description: >-
7106+
A boolean value indicating whether the message is queued in the
7107+
Bandwidth network.
7108+
example: true
7109+
schema:
7110+
type: boolean
7111+
product:
7112+
in: query
7113+
name: product
7114+
required: false
7115+
description: Messaging product associated with the message.
7116+
example: P2P
7117+
schema:
7118+
$ref: '#/components/schemas/productTypeEnum'
7119+
location:
7120+
in: query
7121+
name: location
7122+
required: false
7123+
description: Location Id associated with the message.
7124+
example: 123ABC
7125+
schema:
7126+
type: string
7127+
carrierQueued:
7128+
in: query
7129+
name: carrierQueued
7130+
required: false
7131+
description: >-
7132+
A boolean value indicating whether the message is queued in the carrier
7133+
network. Only available for OUTBOUND messages from accounts with the
7134+
Advanced Quality Metrics feature enabled.
7135+
example: true
7136+
schema:
7137+
type: boolean
7138+
fromCarrierLatency:
7139+
in: query
7140+
name: fromCarrierLatency
7141+
required: false
7142+
description: >-
7143+
The minimum carrier latency of the message in seconds. Only available
7144+
for OUTBOUND messages from accounts with the Advanced Quality Metrics
7145+
feature enabled.
7146+
example: 50
7147+
schema:
7148+
type: integer
7149+
callingNumberCountryA3:
7150+
in: query
7151+
name: callingNumberCountryA3
7152+
required: false
7153+
description: Calling number country in A3 format.
7154+
example: USA
7155+
schema:
7156+
type: string
7157+
calledNumberCountryA3:
7158+
in: query
7159+
name: calledNumberCountryA3
7160+
required: false
7161+
description: Called number country in A3 format.
7162+
example: USA
7163+
schema:
7164+
type: string
7165+
fromSegmentCount:
7166+
in: query
7167+
name: fromSegmentCount
7168+
required: false
7169+
description: Segment count (start range).
7170+
example: 1
7171+
schema:
7172+
type: integer
7173+
toSegmentCount:
7174+
in: query
7175+
name: toSegmentCount
7176+
required: false
7177+
description: Segment count (end range).
7178+
example: 3
7179+
schema:
7180+
type: integer
7181+
fromMessageSize:
7182+
in: query
7183+
name: fromMessageSize
7184+
required: false
7185+
description: Message size (start range).
7186+
example: 100
7187+
schema:
7188+
type: integer
7189+
toMessageSize:
7190+
in: query
7191+
name: toMessageSize
7192+
required: false
7193+
description: Message size (end range).
7194+
example: 120
7195+
schema:
7196+
type: integer
69437197
sort:
69447198
in: query
69457199
name: sort

‎docs/BusinessEntityTypeEnum.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# BusinessEntityTypeEnum
2+
3+
The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
4+
5+
## Enum
6+
7+
* `SoleProprietor` (value: `'SOLE_PROPRIETOR'`)
8+
9+
* `PrivateProfit` (value: `'PRIVATE_PROFIT'`)
10+
11+
* `PublicProfit` (value: `'PUBLIC_PROFIT'`)
12+
13+
* `NonProfit` (value: `'NON_PROFIT'`)
14+
15+
* `Government` (value: `'GOVERNMENT'`)
16+
17+
[[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/BusinessRegistrationTypeEnum.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# BusinessRegistrationTypeEnum
2+
3+
The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
4+
5+
## Enum
6+
7+
* `Ein` (value: `'EIN'`)
8+
9+
* `Cbn` (value: `'CBN'`)
10+
11+
[[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)