bandwidth-sdk 18.2.0 → 18.3.1
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.
- checksums.yaml +4 -4
- data/Gemfile.lock +30 -24
- data/README.md +1 -1
- data/bandwidth.yml +58 -15
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +239 -38
- data/coverage/index.html +5421 -3237
- data/custom_templates/README.mustache +1 -1
- data/custom_templates/gem.mustache +3 -0
- data/docs/MediaApi.md +9 -9
- data/docs/RbmActionBase.md +1 -1
- data/docs/RbmSuggestionResponse.md +1 -1
- data/docs/TfvSubmissionInfo.md +2 -2
- data/docs/TollFreeVerificationApi.md +3 -3
- data/docs/VerificationRequest.md +2 -2
- data/docs/VerificationUpdateRequest.md +3 -3
- data/generate.sh +9 -0
- data/lib/bandwidth-sdk/api/media_api.rb +10 -10
- data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +6 -6
- data/lib/bandwidth-sdk/models/bxml/verbs/connect.rb +23 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/endpoint.rb +11 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/forward.rb +2 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +22 -14
- data/lib/bandwidth-sdk/models/bxml/verbs/record.rb +2 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_recording.rb +2 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +2 -2
- data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +2 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +1 -0
- data/lib/bandwidth-sdk/models/tfv_submission_info.rb +2 -2
- data/lib/bandwidth-sdk/models/verification_request.rb +2 -2
- data/lib/bandwidth-sdk/models/verification_update_request.rb +19 -2
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +2 -0
- data/spec/smoke/media_api_spec.rb +2 -2
- data/spec/smoke/messages_api_spec.rb +2 -2
- data/spec/unit/models/bxml/verbs/connect_spec.rb +62 -0
- data/spec/unit/models/bxml/verbs/endpoint_spec.rb +16 -0
- data/spec/unit/models/bxml/verbs/forward_spec.rb +6 -2
- data/spec/unit/models/bxml/verbs/gather_spec.rb +23 -7
- data/spec/unit/models/bxml/verbs/record_spec.rb +8 -4
- data/spec/unit/models/bxml/verbs/start_recording_spec.rb +8 -4
- data/spec/unit/models/bxml/verbs/start_stream_spec.rb +5 -5
- data/spec/unit/models/bxml/verbs/start_transcription_spec.rb +11 -7
- data/spec/unit/models/bxml/verbs/transfer_spec.rb +7 -5
- data/spec/unit/models/tfv_submission_wrapper_spec.rb +2 -1
- data/spec/unit/models/verification_update_request_spec.rb +4 -2
- metadata +9 -2
|
@@ -43,7 +43,9 @@ require 'bandwidth-sdk/models/bxml/verb'
|
|
|
43
43
|
require 'bandwidth-sdk/models/bxml/nestable_verb'
|
|
44
44
|
require 'bandwidth-sdk/models/bxml/verbs/bridge'
|
|
45
45
|
require 'bandwidth-sdk/models/bxml/verbs/conference'
|
|
46
|
+
require 'bandwidth-sdk/models/bxml/verbs/connect'
|
|
46
47
|
require 'bandwidth-sdk/models/bxml/verbs/custom_param'
|
|
48
|
+
require 'bandwidth-sdk/models/bxml/verbs/endpoint'
|
|
47
49
|
require 'bandwidth-sdk/models/bxml/verbs/forward'
|
|
48
50
|
require 'bandwidth-sdk/models/bxml/verbs/gather'
|
|
49
51
|
require 'bandwidth-sdk/models/bxml/verbs/hangup'
|
|
@@ -53,6 +55,7 @@ require 'bandwidth-sdk/models/bxml/verbs/phone_number'
|
|
|
53
55
|
require 'bandwidth-sdk/models/bxml/verbs/play_audio'
|
|
54
56
|
require 'bandwidth-sdk/models/bxml/verbs/record'
|
|
55
57
|
require 'bandwidth-sdk/models/bxml/verbs/redirect'
|
|
58
|
+
require 'bandwidth-sdk/models/bxml/verbs/refer'
|
|
56
59
|
require 'bandwidth-sdk/models/bxml/verbs/resume_recording'
|
|
57
60
|
require 'bandwidth-sdk/models/bxml/verbs/ring'
|
|
58
61
|
require 'bandwidth-sdk/models/bxml/verbs/send_dtmf'
|
data/docs/MediaApi.md
CHANGED
|
@@ -35,7 +35,7 @@ end
|
|
|
35
35
|
|
|
36
36
|
api_instance = Bandwidth::MediaApi.new
|
|
37
37
|
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
38
|
-
media_id = '
|
|
38
|
+
media_id = 'bw.png' # String | The ID of the media file.
|
|
39
39
|
|
|
40
40
|
begin
|
|
41
41
|
# Delete Media
|
|
@@ -68,7 +68,7 @@ end
|
|
|
68
68
|
| Name | Type | Description | Notes |
|
|
69
69
|
| ---- | ---- | ----------- | ----- |
|
|
70
70
|
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
71
|
-
| **media_id** | **String** |
|
|
71
|
+
| **media_id** | **String** | The ID of the media file. | |
|
|
72
72
|
|
|
73
73
|
### Return type
|
|
74
74
|
|
|
@@ -109,7 +109,7 @@ end
|
|
|
109
109
|
|
|
110
110
|
api_instance = Bandwidth::MediaApi.new
|
|
111
111
|
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
112
|
-
media_id = '
|
|
112
|
+
media_id = 'bw.png' # String | The ID of the media file.
|
|
113
113
|
|
|
114
114
|
begin
|
|
115
115
|
# Get Media
|
|
@@ -143,7 +143,7 @@ end
|
|
|
143
143
|
| Name | Type | Description | Notes |
|
|
144
144
|
| ---- | ---- | ----------- | ----- |
|
|
145
145
|
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
146
|
-
| **media_id** | **String** |
|
|
146
|
+
| **media_id** | **String** | The ID of the media file. | |
|
|
147
147
|
|
|
148
148
|
### Return type
|
|
149
149
|
|
|
@@ -242,7 +242,7 @@ end
|
|
|
242
242
|
|
|
243
243
|
Upload Media
|
|
244
244
|
|
|
245
|
-
Upload a file.
|
|
245
|
+
Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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).
|
|
246
246
|
|
|
247
247
|
### Examples
|
|
248
248
|
|
|
@@ -261,11 +261,11 @@ end
|
|
|
261
261
|
|
|
262
262
|
api_instance = Bandwidth::MediaApi.new
|
|
263
263
|
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
264
|
-
media_id = '
|
|
264
|
+
media_id = 'bw.png' # String | The ID of the media file.
|
|
265
265
|
body = File.new('/path/to/some/file') # File |
|
|
266
266
|
opts = {
|
|
267
267
|
content_type: 'audio/wav', # String | The media type of the entity-body.
|
|
268
|
-
cache_control: 'no-cache' # String |
|
|
268
|
+
cache_control: 'no-cache' # String | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
|
|
269
269
|
}
|
|
270
270
|
|
|
271
271
|
begin
|
|
@@ -299,10 +299,10 @@ end
|
|
|
299
299
|
| Name | Type | Description | Notes |
|
|
300
300
|
| ---- | ---- | ----------- | ----- |
|
|
301
301
|
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
302
|
-
| **media_id** | **String** |
|
|
302
|
+
| **media_id** | **String** | The ID of the media file. | |
|
|
303
303
|
| **body** | **File** | | |
|
|
304
304
|
| **content_type** | **String** | The media type of the entity-body. | [optional] |
|
|
305
|
-
| **cache_control** | **String** |
|
|
305
|
+
| **cache_control** | **String** | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | [optional] |
|
|
306
306
|
|
|
307
307
|
### Return type
|
|
308
308
|
|
data/docs/RbmActionBase.md
CHANGED
data/docs/TfvSubmissionInfo.md
CHANGED
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
|
|
17
17
|
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
|
|
18
18
|
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
|
|
19
|
-
| **business_registration_number** | **String** | Government-issued business identifying number. **
|
|
19
|
+
| **business_registration_number** | **String** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] |
|
|
20
20
|
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
|
|
21
|
-
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
21
|
+
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] |
|
|
22
22
|
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
|
|
23
23
|
|
|
24
24
|
## Example
|
|
@@ -96,7 +96,7 @@ end
|
|
|
96
96
|
|
|
97
97
|
Delete a Toll-Free Verification Submission
|
|
98
98
|
|
|
99
|
-
Delete a toll-free verification submission for a toll-free number.
|
|
99
|
+
Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
100
100
|
|
|
101
101
|
### Examples
|
|
102
102
|
|
|
@@ -462,7 +462,7 @@ end
|
|
|
462
462
|
|
|
463
463
|
Request Toll-Free Verification
|
|
464
464
|
|
|
465
|
-
Submit a request for verification of a toll-free phone number.
|
|
465
|
+
Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
466
466
|
|
|
467
467
|
### Examples
|
|
468
468
|
|
|
@@ -536,7 +536,7 @@ nil (empty response body)
|
|
|
536
536
|
|
|
537
537
|
Update Toll-Free Verification Request
|
|
538
538
|
|
|
539
|
-
Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
539
|
+
Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
540
540
|
|
|
541
541
|
### Examples
|
|
542
542
|
|
data/docs/VerificationRequest.md
CHANGED
|
@@ -17,9 +17,9 @@
|
|
|
17
17
|
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
|
|
18
18
|
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
|
|
19
19
|
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
|
|
20
|
-
| **business_registration_number** | **String** | Government-issued business identifying number. **
|
|
20
|
+
| **business_registration_number** | **String** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] |
|
|
21
21
|
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
|
|
22
|
-
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
22
|
+
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] |
|
|
23
23
|
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
|
|
24
24
|
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
|
|
25
25
|
| **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
|
|
@@ -16,10 +16,10 @@
|
|
|
16
16
|
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
|
|
17
17
|
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
|
|
18
18
|
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
|
|
19
|
-
| **business_registration_number** | **String** | Government-issued business identifying number. **
|
|
19
|
+
| **business_registration_number** | **String** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] |
|
|
20
20
|
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
|
|
21
|
-
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | |
|
|
22
|
-
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
21
|
+
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
|
|
22
|
+
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] |
|
|
23
23
|
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
|
|
24
24
|
| **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
|
|
25
25
|
| **cv_token** | **String** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] |
|
data/generate.sh
ADDED
|
@@ -22,7 +22,7 @@ module Bandwidth
|
|
|
22
22
|
# Delete Media
|
|
23
23
|
# Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
|
|
24
24
|
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
25
|
-
# @param media_id [String]
|
|
25
|
+
# @param media_id [String] The ID of the media file.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [nil]
|
|
28
28
|
def delete_media(account_id, media_id, opts = {})
|
|
@@ -33,7 +33,7 @@ module Bandwidth
|
|
|
33
33
|
# Delete Media
|
|
34
34
|
# Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
|
|
35
35
|
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
36
|
-
# @param media_id [String]
|
|
36
|
+
# @param media_id [String] The ID of the media file.
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
39
39
|
def delete_media_with_http_info(account_id, media_id, opts = {})
|
|
@@ -91,7 +91,7 @@ module Bandwidth
|
|
|
91
91
|
# Get Media
|
|
92
92
|
# Downloads a media file you previously uploaded.
|
|
93
93
|
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
94
|
-
# @param media_id [String]
|
|
94
|
+
# @param media_id [String] The ID of the media file.
|
|
95
95
|
# @param [Hash] opts the optional parameters
|
|
96
96
|
# @return [File]
|
|
97
97
|
def get_media(account_id, media_id, opts = {})
|
|
@@ -102,7 +102,7 @@ module Bandwidth
|
|
|
102
102
|
# Get Media
|
|
103
103
|
# Downloads a media file you previously uploaded.
|
|
104
104
|
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
105
|
-
# @param media_id [String]
|
|
105
|
+
# @param media_id [String] The ID of the media file.
|
|
106
106
|
# @param [Hash] opts the optional parameters
|
|
107
107
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
108
108
|
def get_media_with_http_info(account_id, media_id, opts = {})
|
|
@@ -224,13 +224,13 @@ module Bandwidth
|
|
|
224
224
|
end
|
|
225
225
|
|
|
226
226
|
# Upload Media
|
|
227
|
-
# Upload a file.
|
|
227
|
+
# Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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).
|
|
228
228
|
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
229
|
-
# @param media_id [String]
|
|
229
|
+
# @param media_id [String] The ID of the media file.
|
|
230
230
|
# @param body [File]
|
|
231
231
|
# @param [Hash] opts the optional parameters
|
|
232
232
|
# @option opts [String] :content_type The media type of the entity-body.
|
|
233
|
-
# @option opts [String] :cache_control
|
|
233
|
+
# @option opts [String] :cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
|
|
234
234
|
# @return [nil]
|
|
235
235
|
def upload_media(account_id, media_id, body, opts = {})
|
|
236
236
|
upload_media_with_http_info(account_id, media_id, body, opts)
|
|
@@ -238,13 +238,13 @@ module Bandwidth
|
|
|
238
238
|
end
|
|
239
239
|
|
|
240
240
|
# Upload Media
|
|
241
|
-
# Upload a file.
|
|
241
|
+
# Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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).
|
|
242
242
|
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
243
|
-
# @param media_id [String]
|
|
243
|
+
# @param media_id [String] The ID of the media file.
|
|
244
244
|
# @param body [File]
|
|
245
245
|
# @param [Hash] opts the optional parameters
|
|
246
246
|
# @option opts [String] :content_type The media type of the entity-body.
|
|
247
|
-
# @option opts [String] :cache_control
|
|
247
|
+
# @option opts [String] :cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
|
|
248
248
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
249
249
|
def upload_media_with_http_info(account_id, media_id, body, opts = {})
|
|
250
250
|
if @api_client.config.debugging
|
|
@@ -94,7 +94,7 @@ module Bandwidth
|
|
|
94
94
|
end
|
|
95
95
|
|
|
96
96
|
# Delete a Toll-Free Verification Submission
|
|
97
|
-
# Delete a toll-free verification submission for a toll-free number.
|
|
97
|
+
# Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
98
98
|
# @param account_id [String] Your Bandwidth Account ID.
|
|
99
99
|
# @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
|
|
100
100
|
# @param [Hash] opts the optional parameters
|
|
@@ -105,7 +105,7 @@ module Bandwidth
|
|
|
105
105
|
end
|
|
106
106
|
|
|
107
107
|
# Delete a Toll-Free Verification Submission
|
|
108
|
-
# Delete a toll-free verification submission for a toll-free number.
|
|
108
|
+
# Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
109
109
|
# @param account_id [String] Your Bandwidth Account ID.
|
|
110
110
|
# @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
|
|
111
111
|
# @param [Hash] opts the optional parameters
|
|
@@ -447,7 +447,7 @@ module Bandwidth
|
|
|
447
447
|
end
|
|
448
448
|
|
|
449
449
|
# Request Toll-Free Verification
|
|
450
|
-
# Submit a request for verification of a toll-free phone number.
|
|
450
|
+
# Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
451
451
|
# @param account_id [String] Your Bandwidth Account ID.
|
|
452
452
|
# @param verification_request [VerificationRequest] Request for verification of a toll-free phone number.
|
|
453
453
|
# @param [Hash] opts the optional parameters
|
|
@@ -458,7 +458,7 @@ module Bandwidth
|
|
|
458
458
|
end
|
|
459
459
|
|
|
460
460
|
# Request Toll-Free Verification
|
|
461
|
-
# Submit a request for verification of a toll-free phone number.
|
|
461
|
+
# Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
462
462
|
# @param account_id [String] Your Bandwidth Account ID.
|
|
463
463
|
# @param verification_request [VerificationRequest] Request for verification of a toll-free phone number.
|
|
464
464
|
# @param [Hash] opts the optional parameters
|
|
@@ -521,7 +521,7 @@ module Bandwidth
|
|
|
521
521
|
end
|
|
522
522
|
|
|
523
523
|
# Update Toll-Free Verification Request
|
|
524
|
-
# Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
524
|
+
# Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
525
525
|
# @param account_id [String] Your Bandwidth Account ID.
|
|
526
526
|
# @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
|
|
527
527
|
# @param tfv_submission_wrapper [TfvSubmissionWrapper] Update a request for verification of a toll-free phone number.
|
|
@@ -533,7 +533,7 @@ module Bandwidth
|
|
|
533
533
|
end
|
|
534
534
|
|
|
535
535
|
# Update Toll-Free Verification Request
|
|
536
|
-
# Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
536
|
+
# Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
537
537
|
# @param account_id [String] Your Bandwidth Account ID.
|
|
538
538
|
# @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
|
|
539
539
|
# @param tfv_submission_wrapper [TfvSubmissionWrapper] Update a request for verification of a toll-free phone number.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
module Bandwidth
|
|
2
|
+
module Bxml
|
|
3
|
+
class Connect < Bandwidth::Bxml::NestableVerb
|
|
4
|
+
# Initializer
|
|
5
|
+
# @param endpoints [Verb] or [Array<Verb>] XML element children. Defaults to an empty array. Valid nested connect verbs are: Endpoint.
|
|
6
|
+
# @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
|
|
7
|
+
def initialize(endpoints = [], attributes = {})
|
|
8
|
+
super('Connect', nil, endpoints, attributes)
|
|
9
|
+
|
|
10
|
+
@attribute_map = {
|
|
11
|
+
event_callback_url: 'eventCallbackUrl', # Optional [String]: URL to send events to during the connection lifecycle. May be a relative URL. Defaults to None.
|
|
12
|
+
event_fallback_url: 'eventFallbackUrl', # Optional [String]: Fallback URL used by Bandwidth when delivery to event_callback_url fails. May be a relative URL.
|
|
13
|
+
}
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
# Add endpoint or endpoints to the nested verbs array
|
|
17
|
+
# @param endpoints [Endpoint] or [Array<Endpoint>] Verb or verbs to add to the array.
|
|
18
|
+
def add_endpoints(endpoints)
|
|
19
|
+
@nested_verbs.push(*endpoints)
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -9,6 +9,8 @@ module Bandwidth
|
|
|
9
9
|
@attribute_map = {
|
|
10
10
|
to: 'to', # [String]: The phone number destination of the call.
|
|
11
11
|
from: 'from', # Optional [String]: The phone number that the recipient will receive the call from.
|
|
12
|
+
privacy: 'privacy', # Optional [Boolean]: Hide the calling number. The caller_display_name field can be used to customize the displayed name.
|
|
13
|
+
caller_display_name: 'callerDisplayName', # Optional [String]: The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If privacy is true, only the following values are valid: Restricted, Anonymous, Private, or Unavailable.
|
|
12
14
|
call_timeout: 'callTimeout', # Optional [Number]: The number of seconds to wait before timing out the call.
|
|
13
15
|
diversion_treatment: 'diversionTreatment', # Optional [String]: Can be any of the following: - none: No diversion headers are sent on the outbound leg of the transferred call. - propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg. - stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None.
|
|
14
16
|
diversion_reason: 'diversionReason', # Optional [String]: Can be any of the following values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away. This parameter is considered only when diversionTreatment is set to stack. Defaults to None.
|
|
@@ -8,20 +8,28 @@ module Bandwidth
|
|
|
8
8
|
super('Gather', nil, audio_verbs, attributes)
|
|
9
9
|
|
|
10
10
|
@attribute_map = {
|
|
11
|
-
gather_url: 'gatherUrl',
|
|
12
|
-
gather_method: 'gatherMethod',
|
|
13
|
-
gather_fallback_url: 'gatherFallbackUrl',
|
|
14
|
-
gather_fallback_method: 'gatherFallbackMethod',
|
|
15
|
-
username: 'username',
|
|
16
|
-
password: 'password',
|
|
17
|
-
fallback_username: 'fallbackUsername',
|
|
18
|
-
fallback_password: 'fallbackPassword',
|
|
19
|
-
tag: 'tag',
|
|
20
|
-
terminating_digits: 'terminatingDigits',
|
|
21
|
-
max_digits: 'maxDigits',
|
|
22
|
-
inter_digit_timeout: 'interDigitTimeout',
|
|
23
|
-
first_digit_timeout: 'firstDigitTimeout',
|
|
24
|
-
repeat_count: 'repeatCount',
|
|
11
|
+
gather_url: 'gatherUrl', # Optional [String]: URL to send Gather event to and request new BXML. May be a relative URL.
|
|
12
|
+
gather_method: 'gatherMethod', # Optional [String]: The HTTP method to use for the request to gather_url. GET or POST. Default value is POST.
|
|
13
|
+
gather_fallback_url: 'gatherFallbackUrl', # Optional [String]: A fallback url which, if provided, will be used to retry the Gather event callback delivery in case gather_url fails to respond.
|
|
14
|
+
gather_fallback_method: 'gatherFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Gather event callback to gather_fallback_url. GET or POST. Default value is POST.
|
|
15
|
+
username: 'username', # Optional [String]: The username to send in the HTTP request to gather_url.
|
|
16
|
+
password: 'password', # Optional [String]: The password to send in the HTTP request to gather_url.
|
|
17
|
+
fallback_username: 'fallbackUsername', # Optional [String]: The username to send in the HTTP request to gather_fallback_url.
|
|
18
|
+
fallback_password: 'fallbackPassword', # Optional [String]: The password to send in the HTTP request to gather_fallback_url.
|
|
19
|
+
tag: 'tag', # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters.
|
|
20
|
+
terminating_digits: 'terminatingDigits', # Optional [String]: When any of these digits are pressed, it will terminate the Gather. Default value is "", which disables this feature.
|
|
21
|
+
max_digits: 'maxDigits', # Optional [Number]: Max number of digits to collect. Default value is 50. Range: decimal values between 1 - 50.
|
|
22
|
+
inter_digit_timeout: 'interDigitTimeout', # Optional [Number]: Time (in seconds) allowed between digit presses before automatically terminating the Gather. Default value is 5. Range: decimal values between 1 - 60.
|
|
23
|
+
first_digit_timeout: 'firstDigitTimeout', # Optional [Number]: Time (in seconds) to pause after any audio from nested <SpeakSentence> or <PlayAudio> verb is played (in seconds) before terminating the Gather. Default value is 5. Range: decimal values between 0 - 60.
|
|
24
|
+
repeat_count: 'repeatCount', # Optional [Number]: The number of times the audio prompt should be played if no digits are pressed. For example, if this value is 3, the nested audio clip will be played a maximum of three times. The delay between repetitions will be equal to first_digit_timeout. Default value is 1. repeatCount * number of verbs must not be greater than 20.
|
|
25
|
+
input: 'input', # Optional [String]: Specifies the input mode for the Gather verb. Accepted values are dtmf, speech, or dtmf_speech. Default value is dtmf.
|
|
26
|
+
hints: 'hints', # Optional [String]: Words or phrases that help improve speech recognition, useful for phrases with many words. Possible and effective only if input is speech or dtmf_speech.
|
|
27
|
+
language: 'language', # Optional [String]: Language code for speech recognition. See the BXML documentation for the list of supported locales. Possible and effective only if input is speech or dtmf_speech.
|
|
28
|
+
partial_result_callback: 'partialResultCallback', # Optional [String]: URL to send Partial Result event to. May be a relative URL. Possible and effective only if input is speech or dtmf_speech.
|
|
29
|
+
partial_result_callback_method: 'partialResultCallbackMethod', # Optional [String]: The HTTP method to use for the request to partial_result_callback. GET or POST. Default value is POST.
|
|
30
|
+
profanity_filter: 'profanityFilter', # Optional [Boolean]: Enables or disables filtering of profane words. Default value is true. Possible and effective only if input is speech or dtmf_speech.
|
|
31
|
+
speech_model: 'speechModel', # Optional [String]: Specifies the speech recognition model to use: default, numbers_and_commands, phone_call, experimental_conversations, experimental_utterances, googlev2_long, googlev2_short, googlev2_telephony, or googlev2_telephony_short.
|
|
32
|
+
speech_timeout: 'speechTimeout', # Optional [Number]: Time (in seconds) to wait for speech input before timing out. Accepted values are any positive integer. Default value is 5.
|
|
25
33
|
}
|
|
26
34
|
end
|
|
27
35
|
|
|
@@ -14,6 +14,7 @@ module Bandwidth
|
|
|
14
14
|
recording_available_url: 'recordingAvailableUrl', # Optional [String]: URL to send the Recording Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
|
|
15
15
|
recording_available_method: 'recordingAvailableMethod', # Optional [String]: The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST. Defaults to None.
|
|
16
16
|
transcribe: 'transcribe', # Optional [Boolean]: A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is false. Defaults to None.
|
|
17
|
+
detect_language: 'detectLanguage', # Optional [Boolean]: A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish. Ignored if transcribe is not set to true. Default is false.
|
|
17
18
|
transcription_available_url: 'transcriptionAvailableUrl', # Optional [String]: URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
|
|
18
19
|
transcription_available_method: 'transcriptionAvailableMethod', # Optional [String]: The HTTP method to use for the request to transcriptionAvailableUrl. GET or POST. Default value is POST. Defaults to None.
|
|
19
20
|
username: 'username', # Optional [String]: The username to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
|
|
@@ -25,6 +26,7 @@ module Bandwidth
|
|
|
25
26
|
max_duration: 'maxDuration', # Optional [Number]: Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60. Defaults to None.
|
|
26
27
|
silence_timeout: 'silenceTimeout', # Optional [Number]: Length of silence after which to end the recording (in seconds). Max is equivalent to the maximum maxDuration value. Default value is 0, which means no timeout. Defaults to None.
|
|
27
28
|
file_format: 'fileFormat', # Optional [String]: The audio format that the recording will be saved as: mp3 or wav. Default value is wav. Defaults to None.
|
|
29
|
+
recording_name: 'recordingName', # Optional [String]: A name to identify this recording. It will be returned in the Recording Available or Conference Recording Available event if specified.
|
|
28
30
|
}
|
|
29
31
|
end
|
|
30
32
|
end
|
|
@@ -10,6 +10,7 @@ module Bandwidth
|
|
|
10
10
|
recording_available_url: 'recordingAvailableUrl', # Optional [String]: URL to send the Recording Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
|
|
11
11
|
recording_available_method: 'recordingAvailableMethod', # Optional [String]: The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST.
|
|
12
12
|
transcribe: 'transcribe', # Optional [Boolean]: A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is false. Defaults to None.
|
|
13
|
+
detect_language: 'detectLanguage', # Optional [Boolean]: A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish. Ignored if transcribe is not set to true. Default is false.
|
|
13
14
|
transcription_available_url: 'transcriptionAvailableUrl', # Optional [String]: URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
|
|
14
15
|
transcription_available_method: 'transcriptionAvailableMethod', # Optional [String]: The HTTP method to use for the request to transcriptionAvailableUrl. GET or POST. Default value is POST. Defaults to None.
|
|
15
16
|
username: 'username', # Optional [String]: The username to send in the HTTP request to recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
|
|
@@ -17,6 +18,7 @@ module Bandwidth
|
|
|
17
18
|
tag: 'tag', # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
|
|
18
19
|
file_format: 'fileFormat', # Optional [String]: The audio format that the recording will be saved as: mp3 or wav. Default value is wav.
|
|
19
20
|
multi_channel: 'multiChannel', # Optional [Boolean]: A boolean value indicating whether or not the recording file should separate each side of the call into its own audio channel. Default value is false.
|
|
21
|
+
recording_name: 'recordingName', # Optional [String]: A name to identify this recording. It will be returned in the Recording Available or Conference Recording Available event if specified.
|
|
20
22
|
}
|
|
21
23
|
end
|
|
22
24
|
end
|
|
@@ -12,8 +12,8 @@ module Bandwidth
|
|
|
12
12
|
mode: 'mode', # Optional [String]: The mode to use for the stream. unidirectional or bidirectional. Specifies whether the audio being streamed over the WebSocket is bidirectional (the service can both read and write audio over the WebSocket) or unidirectional (one-way, read-only). Default is unidirectional.
|
|
13
13
|
tracks: 'tracks', # Optional [String]: The part of the call to send a stream from. inbound, outbound or both. Default is inbound.
|
|
14
14
|
destination: 'destination', # Optional [String]: A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio.
|
|
15
|
-
destination_username: '
|
|
16
|
-
destination_password: '
|
|
15
|
+
destination_username: 'destinationUsername', # Optional [String]: The username to send in the `Authorization` header of the initial websocket connection to the `destination` URL.
|
|
16
|
+
destination_password: 'destinationPassword', # Optional [String]: The password to send in the `Authorization` header of the initial websocket connection to the `destination` URL.
|
|
17
17
|
stream_event_url: 'streamEventUrl', # Optional [String]: URL to send the associated Webhook events to during this stream's lifetime. Does not accept BXML. May be a relative URL.
|
|
18
18
|
stream_event_method: 'streamEventMethod', # Optional [String]: The HTTP method to use for the request to streamEventUrl. GET or POST. Default value is POST.
|
|
19
19
|
username: 'username', # Optional [String]: The username to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
|
|
@@ -16,6 +16,8 @@ module Bandwidth
|
|
|
16
16
|
password: 'password', # Optional [String]: The password to send in the HTTP request to transcriptionEventUrl. If specified, the transcriptionEventUrl must be TLS-encrypted (i.e., https).
|
|
17
17
|
destination: 'destination', # Optional [String]: A websocket URI to send the transcription to. A transcription of the specified tracks will be sent via websocket to this URL as a series of JSON messages. See below for more details on the websocket packet format.
|
|
18
18
|
stabilized: 'stabilized', # Optional [Boolean]: Whether to send transcription update events to the specified destination only after they have become stable. Requires destination. Defaults to true.
|
|
19
|
+
detect_language: 'detectLanguage', # Optional [Boolean]: A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. See the BXML documentation for the list of supported locales. Default is false.
|
|
20
|
+
preferred_languages: 'preferredLanguages', # Optional [String]: A comma-separated list of language locales in which the transcription should be performed. Requires detect_language to be false. See the BXML documentation for the list of supported locales. Defaults to en-US.
|
|
19
21
|
}
|
|
20
22
|
end
|
|
21
23
|
|
|
@@ -9,6 +9,7 @@ module Bandwidth
|
|
|
9
9
|
|
|
10
10
|
@attribute_map = {
|
|
11
11
|
transfer_caller_id: 'transferCallerId', # Optional [String]: The caller ID to use when the call is transferred, if different. Must be in E.164 format (e.g. +15555555555) or be one of the following strings Restricted, Anonymous, Private, or Unavailable. Leave as default to pass along the number of the remote party. Defaults to None.
|
|
12
|
+
privacy: 'privacy', # Optional [Boolean]: Hide the calling number. The transfer_caller_display_name field can be used to customize the displayed name.
|
|
12
13
|
transfer_caller_display_name: 'transferCallerDisplayName', # Optional [String]: The caller display name to use when the call is transferred. May not exceed 256 characters nor contain control characters such as new lines. Defaults to None.
|
|
13
14
|
call_timeout: 'callTimeout', # Optional [Number]: The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Range: decimal values between 1 - 300. Default value is 30 seconds. Defaults to None.
|
|
14
15
|
transfer_complete_url: 'transferCompleteUrl', # Optional [String]: URL to send the Transfer Complete event to and request new BXML. Optional but recommended. See below for further details. May be a relative URL. Defaults to None.
|
|
@@ -48,12 +48,12 @@ module Bandwidth
|
|
|
48
48
|
# The company 'Doing Business As'.
|
|
49
49
|
attr_accessor :business_dba
|
|
50
50
|
|
|
51
|
-
# Government-issued business identifying number. **
|
|
51
|
+
# Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
52
52
|
attr_accessor :business_registration_number
|
|
53
53
|
|
|
54
54
|
attr_accessor :business_registration_type
|
|
55
55
|
|
|
56
|
-
# The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
56
|
+
# The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
57
57
|
attr_accessor :business_registration_issuing_country
|
|
58
58
|
|
|
59
59
|
attr_accessor :business_entity_type
|
|
@@ -50,12 +50,12 @@ module Bandwidth
|
|
|
50
50
|
# The company 'Doing Business As'.
|
|
51
51
|
attr_accessor :business_dba
|
|
52
52
|
|
|
53
|
-
# Government-issued business identifying number. **
|
|
53
|
+
# Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
54
54
|
attr_accessor :business_registration_number
|
|
55
55
|
|
|
56
56
|
attr_accessor :business_registration_type
|
|
57
57
|
|
|
58
|
-
# The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
58
|
+
# The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
59
59
|
attr_accessor :business_registration_issuing_country
|
|
60
60
|
|
|
61
61
|
attr_accessor :business_entity_type
|