bandwidth-sdk 16.1.0 → 16.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +4 -4
  3. data/README.md +3 -0
  4. data/bandwidth.yml +254 -0
  5. data/coverage/.last_run.json +1 -1
  6. data/coverage/.resultset.json +501 -1
  7. data/coverage/index.html +6288 -962
  8. data/docs/BusinessEntityTypeEnum.md +15 -0
  9. data/docs/BusinessRegistrationTypeEnum.md +15 -0
  10. data/docs/ListMessageItem.md +13 -1
  11. data/docs/MessagesApi.md +24 -0
  12. data/docs/OptInWorkflow.md +3 -1
  13. data/docs/ProductTypeEnum.md +15 -0
  14. data/docs/RbmActionBase.md +1 -1
  15. data/docs/RbmSuggestionResponse.md +1 -1
  16. data/docs/TfvSubmissionInfo.md +7 -1
  17. data/docs/VerificationRequest.md +11 -1
  18. data/docs/VerificationUpdateRequest.md +11 -1
  19. data/lib/bandwidth-sdk/api/messages_api.rb +36 -0
  20. data/lib/bandwidth-sdk/models/business_entity_type_enum.rb +43 -0
  21. data/lib/bandwidth-sdk/models/business_registration_type_enum.rb +40 -0
  22. data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +2 -1
  23. data/lib/bandwidth-sdk/models/list_message_item.rb +71 -5
  24. data/lib/bandwidth-sdk/models/message_type_enum.rb +2 -1
  25. data/lib/bandwidth-sdk/models/opt_in_workflow.rb +38 -4
  26. data/lib/bandwidth-sdk/models/product_type_enum.rb +47 -0
  27. data/lib/bandwidth-sdk/models/tfv_submission_info.rb +72 -4
  28. data/lib/bandwidth-sdk/models/verification_request.rb +108 -4
  29. data/lib/bandwidth-sdk/models/verification_update_request.rb +108 -4
  30. data/lib/bandwidth-sdk/version.rb +1 -1
  31. data/lib/bandwidth-sdk.rb +3 -0
  32. data/spec/smoke/messages_api_spec.rb +2 -1
  33. data/spec/spec_helper.rb +3 -2
  34. data/spec/unit/api/messages_api_spec.rb +6 -0
  35. data/spec/unit/models/bxml/verbs/stop_stream_spec.rb +6 -4
  36. metadata +44 -38
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 865d2c83a5e4dd44cf7f0086976a24ab3c2f33693042dde0e09469a3605ad216
4
- data.tar.gz: f720b43ace5ea60647611ef23d7d06e0e9d629757cf6703c21fd232443168113
3
+ metadata.gz: e6b6d4b485e01b0c1168f93538f7e417f3ffa31a1aa25e984576386a76008a17
4
+ data.tar.gz: 4d93c3d0feddcdfc22ab1e246d799f5b4f7e25a65a235ff84c04d462af121523
5
5
  SHA512:
6
- metadata.gz: 6acae1ae29043bba2998cb6ecf904edd86ad71c6f7654bb5d4348ab06a320805b964966d617e469bf512aee7905c0acd9d5510643279b8000fea268ba496c741
7
- data.tar.gz: ba08d08a84ab3b1ce6c3395218cf09e5c22a0d76102605db9db01fab56836a5e3f492b7799447e73fffd92c49ca6a9549d93e6349a04df658c975f7da107c5d9
6
+ metadata.gz: 470cf7c861d8da30855325ac6314f66d78c48eeeeb2cc334180d11495de3a02e60a340df8c9b5648b3fb8bfb81002ebe1a8a57b585462af9df0008bf6ff2252f
7
+ data.tar.gz: 3fe5d3366cf4110ef95c041b32ec637e2731f742618fc4d6d4ac0cfd4d10b9ab5f11c9a0812ecff6628428d9e61f8fc94b98fa5cfa9b34eff2619a73a278c343
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- bandwidth-sdk (16.1.0)
4
+ bandwidth-sdk (16.2.0)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart
7
7
  marcel
@@ -47,8 +47,8 @@ GEM
47
47
  racc (1.8.1)
48
48
  rainbow (3.1.1)
49
49
  rake (13.2.1)
50
- regexp_parser (2.11.1)
51
- rexml (3.4.1)
50
+ regexp_parser (2.11.2)
51
+ rexml (3.4.2)
52
52
  rspec (3.13.1)
53
53
  rspec-core (~> 3.13.0)
54
54
  rspec-expectations (~> 3.13.0)
@@ -61,7 +61,7 @@ GEM
61
61
  rspec-mocks (3.13.5)
62
62
  diff-lcs (>= 1.2.0, < 2.0)
63
63
  rspec-support (~> 3.13.0)
64
- rspec-support (3.13.4)
64
+ rspec-support (3.13.5)
65
65
  rubocop (1.52.1)
66
66
  json (~> 2.3)
67
67
  parallel (~> 1.10)
data/README.md CHANGED
@@ -167,6 +167,8 @@ Class | Method | HTTP request | Description
167
167
  - [Bandwidth::BlockedWebhook](docs/BlockedWebhook.md)
168
168
  - [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
169
169
  - [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
170
+ - [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
171
+ - [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
170
172
  - [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
171
173
  - [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)
172
174
  - [Bandwidth::CallState](docs/CallState.md)
@@ -249,6 +251,7 @@ Class | Method | HTTP request | Description
249
251
  - [Bandwidth::OptInWorkflow](docs/OptInWorkflow.md)
250
252
  - [Bandwidth::PageInfo](docs/PageInfo.md)
251
253
  - [Bandwidth::PriorityEnum](docs/PriorityEnum.md)
254
+ - [Bandwidth::ProductTypeEnum](docs/ProductTypeEnum.md)
252
255
  - [Bandwidth::RbmActionBase](docs/RbmActionBase.md)
253
256
  - [Bandwidth::RbmActionDial](docs/RbmActionDial.md)
254
257
  - [Bandwidth::RbmActionOpenUrl](docs/RbmActionOpenUrl.md)
data/bandwidth.yml CHANGED
@@ -179,6 +179,18 @@ paths:
179
179
  - $ref: '#/components/parameters/fromDateTime'
180
180
  - $ref: '#/components/parameters/toDateTime'
181
181
  - $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'
182
194
  - $ref: '#/components/parameters/sort'
183
195
  - $ref: '#/components/parameters/pageToken'
184
196
  - $ref: '#/components/parameters/limit'
@@ -1716,7 +1728,22 @@ components:
1716
1728
  enum:
1717
1729
  - sms
1718
1730
  - mms
1731
+ - rcs
1719
1732
  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
1720
1747
  fieldError:
1721
1748
  type: object
1722
1749
  properties:
@@ -1819,6 +1846,41 @@ components:
1819
1846
  description: The campaign ID of the message if it has one.
1820
1847
  nullable: true
1821
1848
  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
1822
1884
  pageInfo:
1823
1885
  title: PageInfo
1824
1886
  type: object
@@ -5478,6 +5540,50 @@ components:
5478
5540
  description: The company 'Doing Business As'.
5479
5541
  example: Another Company Name Inc.
5480
5542
  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
5481
5587
  additionalDenialReason:
5482
5588
  properties:
5483
5589
  statusCode:
@@ -5564,6 +5670,16 @@ components:
5564
5670
  $ref: '#/components/schemas/termsAndConditionsUrl'
5565
5671
  businessDba:
5566
5672
  $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'
5567
5683
  verificationUpdateRequest:
5568
5684
  type: object
5569
5685
  required:
@@ -5603,6 +5719,16 @@ components:
5603
5719
  $ref: '#/components/schemas/termsAndConditionsUrl'
5604
5720
  businessDba:
5605
5721
  $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'
5606
5732
  tfvBasicAuthentication:
5607
5733
  type: object
5608
5734
  properties:
@@ -5806,6 +5932,12 @@ components:
5806
5932
  example: https://www.example.com/path/to/resource
5807
5933
  pattern: >-
5808
5934
  ^$|(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!
5809
5941
  isvReseller:
5810
5942
  type: string
5811
5943
  description: ISV name.
@@ -6079,6 +6211,22 @@ components:
6079
6211
  $ref: '#/components/schemas/termsAndConditionsUrl'
6080
6212
  businessDba:
6081
6213
  $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.
6082
6230
  tfvStatusEnum:
6083
6231
  type: string
6084
6232
  enum:
@@ -6940,6 +7088,112 @@ components:
6940
7088
  example: CJEUMDK
6941
7089
  schema:
6942
7090
  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
6943
7197
  sort:
6944
7198
  in: query
6945
7199
  name: sort
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "result": {
3
- "line": 95.26
3
+ "line": 94.2
4
4
  }
5
5
  }