Skip to content

Commit 4e5a3f9

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-8531 Update SDK Based on Recent Spec Changes (#181)
* Generate SDK with OpenAPI Generator Version * revert test changes --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: ckoegel <[email protected]>
1 parent 673aacd commit 4e5a3f9

22 files changed

+623
-23
lines changed

.openapi-generator/FILES

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ docs/AnswerCallback.md
1111
docs/BlockedWebhook.md
1212
docs/BridgeCompleteCallback.md
1313
docs/BridgeTargetCompleteCallback.md
14+
docs/BusinessEntityTypeEnum.md
15+
docs/BusinessRegistrationTypeEnum.md
1416
docs/CallDirectionEnum.md
1517
docs/CallRecordingMetadata.md
1618
docs/CallState.md
@@ -190,6 +192,8 @@ lib/bandwidth-sdk/models/answer_callback.rb
190192
lib/bandwidth-sdk/models/blocked_webhook.rb
191193
lib/bandwidth-sdk/models/bridge_complete_callback.rb
192194
lib/bandwidth-sdk/models/bridge_target_complete_callback.rb
195+
lib/bandwidth-sdk/models/business_entity_type_enum.rb
196+
lib/bandwidth-sdk/models/business_registration_type_enum.rb
193197
lib/bandwidth-sdk/models/call_direction_enum.rb
194198
lib/bandwidth-sdk/models/call_recording_metadata.rb
195199
lib/bandwidth-sdk/models/call_state.rb

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,8 @@ Class | Method | HTTP request | Description
167167
- [Bandwidth::BlockedWebhook](docs/BlockedWebhook.md)
168168
- [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
169169
- [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
170+
- [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
171+
- [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
170172
- [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
171173
- [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)
172174
- [Bandwidth::CallState](docs/CallState.md)

bandwidth.yml

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,8 @@ paths:
183183
- $ref: '#/components/parameters/bwQueued'
184184
- $ref: '#/components/parameters/product'
185185
- $ref: '#/components/parameters/location'
186+
- $ref: '#/components/parameters/carrierQueued'
187+
- $ref: '#/components/parameters/fromCarrierLatency'
186188
- $ref: '#/components/parameters/callingNumberCountryA3'
187189
- $ref: '#/components/parameters/calledNumberCountryA3'
188190
- $ref: '#/components/parameters/fromSegmentCount'
@@ -1851,6 +1853,14 @@ components:
18511853
accounts with the Advanced Quality Metrics feature enabled.
18521854
nullable: true
18531855
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
18541864
callingNumberCountryA3:
18551865
type: string
18561866
description: The A3 country code of the calling number.
@@ -5530,6 +5540,50 @@ components:
55305540
description: The company 'Doing Business As'.
55315541
example: Another Company Name Inc.
55325542
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
55335587
additionalDenialReason:
55345588
properties:
55355589
statusCode:
@@ -5616,6 +5670,16 @@ components:
56165670
$ref: '#/components/schemas/termsAndConditionsUrl'
56175671
businessDba:
56185672
$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'
56195683
verificationUpdateRequest:
56205684
type: object
56215685
required:
@@ -5655,6 +5719,16 @@ components:
56555719
$ref: '#/components/schemas/termsAndConditionsUrl'
56565720
businessDba:
56575721
$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'
56585732
tfvBasicAuthentication:
56595733
type: object
56605734
properties:
@@ -5858,6 +5932,12 @@ components:
58585932
example: https://www.example.com/path/to/resource
58595933
pattern: >-
58605934
^$|(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!
58615941
isvReseller:
58625942
type: string
58635943
description: ISV name.
@@ -6131,6 +6211,22 @@ components:
61316211
$ref: '#/components/schemas/termsAndConditionsUrl'
61326212
businessDba:
61336213
$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.
61346230
tfvStatusEnum:
61356231
type: string
61366232
enum:
@@ -7028,6 +7124,28 @@ components:
70287124
example: 123ABC
70297125
schema:
70307126
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
70317149
callingNumberCountryA3:
70327150
in: query
70337151
name: callingNumberCountryA3

docs/BusinessEntityTypeEnum.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Bandwidth::BusinessEntityTypeEnum
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
8+
## Example
9+
10+
```ruby
11+
require 'bandwidth-sdk'
12+
13+
instance = Bandwidth::BusinessEntityTypeEnum.new()
14+
```
15+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Bandwidth::BusinessRegistrationTypeEnum
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
8+
## Example
9+
10+
```ruby
11+
require 'bandwidth-sdk'
12+
13+
instance = Bandwidth::BusinessRegistrationTypeEnum.new()
14+
```
15+

docs/ListMessageItem.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
| **campaign_class** | **String** | The campaign class of the message if it has one. | [optional] |
2323
| **campaign_id** | **String** | The campaign ID of the message if it has one. | [optional] |
2424
| **bw_latency** | **Integer** | The Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. | [optional] |
25+
| **carrier_latency** | **Integer** | The carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | [optional] |
2526
| **calling_number_country_a3** | **String** | The A3 country code of the calling number. | [optional] |
2627
| **called_number_country_a3** | **String** | The A3 country code of the called number. | [optional] |
2728
| **product** | **String** | The messaging product associated with the message. | [optional] |
@@ -51,6 +52,7 @@ instance = Bandwidth::ListMessageItem.new(
5152
campaign_class: T,
5253
campaign_id: CJEUMDK,
5354
bw_latency: 20,
55+
carrier_latency: 20,
5456
calling_number_country_a3: USA,
5557
called_number_country_a3: USA,
5658
product: P2P,

docs/MessagesApi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ opts = {
118118
bw_queued: true, # Boolean | A boolean value indicating whether the message is queued in the Bandwidth network.
119119
product: Bandwidth::ProductTypeEnum::LOCAL_A2_P, # ProductTypeEnum | Messaging product associated with the message.
120120
location: '123ABC', # String | Location Id associated with the message.
121+
carrier_queued: true, # Boolean | A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
122+
from_carrier_latency: 50, # Integer | The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
121123
calling_number_country_a3: 'USA', # String | Calling number country in A3 format.
122124
called_number_country_a3: 'USA', # String | Called number country in A3 format.
123125
from_segment_count: 1, # Integer | Segment count (start range).
@@ -177,6 +179,8 @@ end
177179
| **bw_queued** | **Boolean** | A boolean value indicating whether the message is queued in the Bandwidth network. | [optional] |
178180
| **product** | [**ProductTypeEnum**](.md) | Messaging product associated with the message. | [optional] |
179181
| **location** | **String** | Location Id associated with the message. | [optional] |
182+
| **carrier_queued** | **Boolean** | A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | [optional] |
183+
| **from_carrier_latency** | **Integer** | The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | [optional] |
180184
| **calling_number_country_a3** | **String** | Calling number country in A3 format. | [optional] |
181185
| **called_number_country_a3** | **String** | Called number country in A3 format. | [optional] |
182186
| **from_segment_count** | **Integer** | Segment count (start range). | [optional] |

docs/OptInWorkflow.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
| ---- | ---- | ----------- | ----- |
77
| **description** | **String** | | |
88
| **image_urls** | **Array&lt;String&gt;** | | |
9+
| **confirmation_response** | **String** | | [optional] |
910

1011
## Example
1112

@@ -14,7 +15,8 @@ require 'bandwidth-sdk'
1415

1516
instance = Bandwidth::OptInWorkflow.new(
1617
description: Opt In Flow,
17-
image_urls: null
18+
image_urls: null,
19+
confirmation_response: Thank you for opting in!
1820
)
1921
```
2022

docs/RbmActionBase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
1616
instance = Bandwidth::RbmActionBase.new(
1717
type: null,
1818
text: Hello world,
19-
postback_data: [B@12ebfb2d
19+
postback_data: [B@a93c798
2020
)
2121
```
2222

docs/RbmSuggestionResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ require 'bandwidth-sdk'
1414

1515
instance = Bandwidth::RbmSuggestionResponse.new(
1616
text: Yes, I would like to proceed,
17-
postback_data: [B@12ebfb2d
17+
postback_data: [B@a93c798
1818
)
1919
```
2020

0 commit comments

Comments
 (0)