bandwidth-sdk 16.1.0 → 16.2.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.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -5
  3. data/README.md +6 -3
  4. data/bandwidth.yml +266 -11
  5. data/coverage/.last_run.json +1 -1
  6. data/coverage/.resultset.json +501 -1
  7. data/coverage/index.html +6296 -970
  8. data/docs/BusinessEntityTypeEnum.md +15 -0
  9. data/docs/BusinessRegistrationTypeEnum.md +15 -0
  10. data/docs/CallTranscriptionMetadata.md +1 -1
  11. data/docs/ConferenceMember.md +1 -1
  12. data/docs/ListMessageItem.md +13 -1
  13. data/docs/MessagesApi.md +24 -0
  14. data/docs/MultiChannelMessageResponseData.md +2 -2
  15. data/docs/OptInWorkflow.md +3 -1
  16. data/docs/ProductTypeEnum.md +15 -0
  17. data/docs/RbmActionBase.md +1 -1
  18. data/docs/RbmSuggestionResponse.md +1 -1
  19. data/docs/TfvSubmissionInfo.md +7 -1
  20. data/docs/TranscriptionsApi.md +13 -13
  21. data/docs/VerificationRequest.md +11 -1
  22. data/docs/VerificationUpdateRequest.md +11 -1
  23. data/lib/bandwidth-sdk/api/messages_api.rb +36 -0
  24. data/lib/bandwidth-sdk/api/transcriptions_api.rb +8 -8
  25. data/lib/bandwidth-sdk/models/business_entity_type_enum.rb +43 -0
  26. data/lib/bandwidth-sdk/models/business_registration_type_enum.rb +40 -0
  27. data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +2 -1
  28. data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +1 -1
  29. data/lib/bandwidth-sdk/models/conference_member.rb +1 -1
  30. data/lib/bandwidth-sdk/models/list_message_item.rb +71 -5
  31. data/lib/bandwidth-sdk/models/message_type_enum.rb +2 -1
  32. data/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb +11 -11
  33. data/lib/bandwidth-sdk/models/opt_in_workflow.rb +38 -4
  34. data/lib/bandwidth-sdk/models/product_type_enum.rb +47 -0
  35. data/lib/bandwidth-sdk/models/tfv_submission_info.rb +72 -4
  36. data/lib/bandwidth-sdk/models/verification_request.rb +108 -4
  37. data/lib/bandwidth-sdk/models/verification_update_request.rb +108 -4
  38. data/lib/bandwidth-sdk/version.rb +1 -1
  39. data/lib/bandwidth-sdk.rb +3 -0
  40. data/spec/smoke/messages_api_spec.rb +2 -1
  41. data/spec/spec_helper.rb +3 -2
  42. data/spec/unit/api/messages_api_spec.rb +6 -0
  43. data/spec/unit/models/bxml/verbs/stop_stream_spec.rb +6 -4
  44. metadata +44 -38
@@ -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
+
@@ -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
+
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
8
8
  | **transcription_name** | **String** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] |
9
- | **transcription_url** | **String** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] |
9
+ | **transcription_url** | **String** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **call_id** | **String** | The call id associated with the event. | [optional] |
8
8
  | **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
9
- | **member_url** | **String** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] |
9
+ | **member_url** | **String** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. | [optional] |
10
10
  | **mute** | **Boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member's mute status. Has no effect if omitted. | [optional] |
11
11
  | **hold** | **Boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member's hold status. Has no effect if omitted. | [optional] |
12
12
  | **call_ids_to_coach** | **Array<String>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] |
@@ -21,6 +21,12 @@
21
21
  | **recipient_count** | **Integer** | The number of recipients the message has. | [optional] |
22
22
  | **campaign_class** | **String** | The campaign class of the message if it has one. | [optional] |
23
23
  | **campaign_id** | **String** | The campaign ID of the message if it has one. | [optional] |
24
+ | **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] |
26
+ | **calling_number_country_a3** | **String** | The A3 country code of the calling number. | [optional] |
27
+ | **called_number_country_a3** | **String** | The A3 country code of the called number. | [optional] |
28
+ | **product** | **String** | The messaging product associated with the message. | [optional] |
29
+ | **location** | **String** | The location ID associated with this message. | [optional] |
24
30
 
25
31
  ## Example
26
32
 
@@ -44,7 +50,13 @@ instance = Bandwidth::ListMessageItem.new(
44
50
  attachment_count: 1,
45
51
  recipient_count: 1,
46
52
  campaign_class: T,
47
- campaign_id: CJEUMDK
53
+ campaign_id: CJEUMDK,
54
+ bw_latency: 20,
55
+ carrier_latency: 20,
56
+ calling_number_country_a3: USA,
57
+ called_number_country_a3: USA,
58
+ product: P2P,
59
+ location: 123ID
48
60
  )
49
61
  ```
50
62
 
data/docs/MessagesApi.md CHANGED
@@ -114,6 +114,18 @@ opts = {
114
114
  from_date_time: '2022-09-14T18:20:16.000Z', # String | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
115
115
  to_date_time: '2022-09-14T18:20:16.000Z', # String | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
116
116
  campaign_id: 'CJEUMDK', # String | The campaign ID of the message.
117
+ from_bw_latency: 5, # Integer | The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
118
+ bw_queued: true, # Boolean | A boolean value indicating whether the message is queued in the Bandwidth network.
119
+ product: Bandwidth::ProductTypeEnum::LOCAL_A2_P, # ProductTypeEnum | Messaging product associated with the message.
120
+ 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.
123
+ calling_number_country_a3: 'USA', # String | Calling number country in A3 format.
124
+ called_number_country_a3: 'USA', # String | Called number country in A3 format.
125
+ from_segment_count: 1, # Integer | Segment count (start range).
126
+ to_segment_count: 3, # Integer | Segment count (end range).
127
+ from_message_size: 100, # Integer | Message size (start range).
128
+ to_message_size: 120, # Integer | Message size (end range).
117
129
  sort: 'sourceTn:desc', # String | The field and direction to sort by combined with a colon. Direction is either asc or desc.
118
130
  page_token: 'gdEewhcJLQRB5', # String | A base64 encoded value used for pagination of results.
119
131
  limit: 50, # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
@@ -163,6 +175,18 @@ end
163
175
  | **from_date_time** | **String** | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
164
176
  | **to_date_time** | **String** | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
165
177
  | **campaign_id** | **String** | The campaign ID of the message. | [optional] |
178
+ | **from_bw_latency** | **Integer** | The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. | [optional] |
179
+ | **bw_queued** | **Boolean** | A boolean value indicating whether the message is queued in the Bandwidth network. | [optional] |
180
+ | **product** | [**ProductTypeEnum**](.md) | Messaging product associated with the message. | [optional] |
181
+ | **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] |
184
+ | **calling_number_country_a3** | **String** | Calling number country in A3 format. | [optional] |
185
+ | **called_number_country_a3** | **String** | Called number country in A3 format. | [optional] |
186
+ | **from_segment_count** | **Integer** | Segment count (start range). | [optional] |
187
+ | **to_segment_count** | **Integer** | Segment count (end range). | [optional] |
188
+ | **from_message_size** | **Integer** | Message size (start range). | [optional] |
189
+ | **to_message_size** | **Integer** | Message size (end range). | [optional] |
166
190
  | **sort** | **String** | The field and direction to sort by combined with a colon. Direction is either asc or desc. | [optional] |
167
191
  | **page_token** | **String** | A base64 encoded value used for pagination of results. | [optional] |
168
192
  | **limit** | **Integer** | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. | [optional] |
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **message_id** | **String** | The ID of the message. | |
7
+ | **id** | **String** | The ID of the message. | |
8
8
  | **time** | **Time** | The time the message was received by the Bandwidth API. | |
9
9
  | **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | |
10
10
  | **to** | **Array<String>** | The destination phone number(s) of the message, in E164 format. | |
@@ -19,7 +19,7 @@
19
19
  require 'bandwidth-sdk'
20
20
 
21
21
  instance = Bandwidth::MultiChannelMessageResponseData.new(
22
- message_id: 1589228074636lm4k2je7j7jklbn2,
22
+ id: 1589228074636lm4k2je7j7jklbn2,
23
23
  time: 2025-01-01T18:20:16Z,
24
24
  direction: null,
25
25
  to: ["+15554443333"],
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **description** | **String** | | |
8
8
  | **image_urls** | **Array<String>** | | |
9
+ | **confirmation_response** | **String** | | [optional] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'bandwidth-sdk'
14
15
 
15
16
  instance = Bandwidth::OptInWorkflow.new(
16
17
  description: Opt In Flow,
17
- image_urls: null
18
+ image_urls: null,
19
+ confirmation_response: Thank you for opting in!
18
20
  )
19
21
  ```
20
22
 
@@ -0,0 +1,15 @@
1
+ # Bandwidth::ProductTypeEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::ProductTypeEnum.new()
14
+ ```
15
+
@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
16
16
  instance = Bandwidth::RbmActionBase.new(
17
17
  type: null,
18
18
  text: Hello world,
19
- postback_data: [B@2c6aa46c
19
+ postback_data: [B@a93c798
20
20
  )
21
21
  ```
22
22
 
@@ -14,7 +14,7 @@ require 'bandwidth-sdk'
14
14
 
15
15
  instance = Bandwidth::RbmSuggestionResponse.new(
16
16
  text: Yes, I would like to proceed,
17
- postback_data: [B@2c6aa46c
17
+ postback_data: [B@a93c798
18
18
  )
19
19
  ```
20
20
 
@@ -16,6 +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** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] |
20
+ | **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
21
+ | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
19
22
 
20
23
  ## Example
21
24
 
@@ -34,7 +37,10 @@ instance = Bandwidth::TfvSubmissionInfo.new(
34
37
  isv_reseller: Test ISV,
35
38
  privacy_policy_url: http://your-company.com/privacyPolicy,
36
39
  terms_and_conditions_url: http://your-company.com/termsAndConditions,
37
- business_dba: Another Company Name Inc.
40
+ business_dba: Another Company Name Inc.,
41
+ business_registration_number: 12-3456789,
42
+ business_registration_type: null,
43
+ business_entity_type: null
38
44
  )
39
45
  ```
40
46
 
@@ -4,16 +4,16 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**delete_real_time_transcription**](TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription |
8
- | [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription |
9
- | [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription |
7
+ | [**delete_real_time_transcription**](TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription |
8
+ | [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription |
9
+ | [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions |
10
10
 
11
11
 
12
12
  ## delete_real_time_transcription
13
13
 
14
14
  > delete_real_time_transcription(account_id, call_id, transcription_id)
15
15
 
16
- Delete a specific transcription
16
+ Delete Real-time Transcription
17
17
 
18
18
  Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
19
19
 
@@ -35,7 +35,7 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
35
35
  transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
36
36
 
37
37
  begin
38
- # Delete a specific transcription
38
+ # Delete Real-time Transcription
39
39
  api_instance.delete_real_time_transcription(account_id, call_id, transcription_id)
40
40
  rescue Bandwidth::ApiError => e
41
41
  puts "Error when calling TranscriptionsApi->delete_real_time_transcription: #{e}"
@@ -50,7 +50,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
50
50
 
51
51
  ```ruby
52
52
  begin
53
- # Delete a specific transcription
53
+ # Delete Real-time Transcription
54
54
  data, status_code, headers = api_instance.delete_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
55
55
  p status_code # => 2xx
56
56
  p headers # => { ... }
@@ -86,7 +86,7 @@ nil (empty response body)
86
86
 
87
87
  > <CallTranscriptionResponse> get_real_time_transcription(account_id, call_id, transcription_id)
88
88
 
89
- Retrieve a specific transcription
89
+ Get Real-time Transcription
90
90
 
91
91
  Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
92
92
 
@@ -108,7 +108,7 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
108
108
  transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
109
109
 
110
110
  begin
111
- # Retrieve a specific transcription
111
+ # Get Real-time Transcription
112
112
  result = api_instance.get_real_time_transcription(account_id, call_id, transcription_id)
113
113
  p result
114
114
  rescue Bandwidth::ApiError => e
@@ -124,7 +124,7 @@ This returns an Array which contains the response data, status code and headers.
124
124
 
125
125
  ```ruby
126
126
  begin
127
- # Retrieve a specific transcription
127
+ # Get Real-time Transcription
128
128
  data, status_code, headers = api_instance.get_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
129
129
  p status_code # => 2xx
130
130
  p headers # => { ... }
@@ -160,9 +160,9 @@ end
160
160
 
161
161
  > <Array<CallTranscriptionMetadata>> list_real_time_transcriptions(account_id, call_id)
162
162
 
163
- Enumerate transcriptions made with StartTranscription
163
+ List Real-time Transcriptions
164
164
 
165
- Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
165
+ List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
166
166
 
167
167
  ### Examples
168
168
 
@@ -181,7 +181,7 @@ account_id = '9900000' # String | Your Bandwidth Account ID.
181
181
  call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
182
182
 
183
183
  begin
184
- # Enumerate transcriptions made with StartTranscription
184
+ # List Real-time Transcriptions
185
185
  result = api_instance.list_real_time_transcriptions(account_id, call_id)
186
186
  p result
187
187
  rescue Bandwidth::ApiError => e
@@ -197,7 +197,7 @@ This returns an Array which contains the response data, status code and headers.
197
197
 
198
198
  ```ruby
199
199
  begin
200
- # Enumerate transcriptions made with StartTranscription
200
+ # List Real-time Transcriptions
201
201
  data, status_code, headers = api_instance.list_real_time_transcriptions_with_http_info(account_id, call_id)
202
202
  p status_code # => 2xx
203
203
  p headers # => { ... }
@@ -17,6 +17,11 @@
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 &#39;Doing Business As&#39;. | [optional] |
20
+ | **business_registration_number** | **String** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for &#x60;businessRegistrationType&#x60; and &#x60;businessEntityType&#x60;. Available starting October 1st, 2025. | [optional] |
21
+ | **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
22
+ | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
23
+ | **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
24
+ | **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
20
25
 
21
26
  ## Example
22
27
 
@@ -36,7 +41,12 @@ instance = Bandwidth::VerificationRequest.new(
36
41
  isv_reseller: Test ISV,
37
42
  privacy_policy_url: http://your-company.com/privacyPolicy,
38
43
  terms_and_conditions_url: http://your-company.com/termsAndConditions,
39
- business_dba: Another Company Name Inc.
44
+ business_dba: Another Company Name Inc.,
45
+ business_registration_number: 12-3456789,
46
+ business_registration_type: null,
47
+ business_entity_type: null,
48
+ help_message_response: Please contact support for assistance.,
49
+ age_gated_content: false
40
50
  )
41
51
  ```
42
52
 
@@ -16,6 +16,11 @@
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 &#39;Doing Business As&#39;. | [optional] |
19
+ | **business_registration_number** | **String** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for &#x60;businessRegistrationType&#x60; and &#x60;businessEntityType&#x60;. Available starting October 1st, 2025. | [optional] |
20
+ | **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
21
+ | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
22
+ | **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
23
+ | **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
19
24
 
20
25
  ## Example
21
26
 
@@ -34,7 +39,12 @@ instance = Bandwidth::VerificationUpdateRequest.new(
34
39
  isv_reseller: Test ISV,
35
40
  privacy_policy_url: http://your-company.com/privacyPolicy,
36
41
  terms_and_conditions_url: http://your-company.com/termsAndConditions,
37
- business_dba: Another Company Name Inc.
42
+ business_dba: Another Company Name Inc.,
43
+ business_registration_number: 12-3456789,
44
+ business_registration_type: null,
45
+ business_entity_type: null,
46
+ help_message_response: Please contact support for assistance.,
47
+ age_gated_content: false
38
48
  )
39
49
  ```
40
50
 
@@ -108,6 +108,18 @@ module Bandwidth
108
108
  # @option opts [String] :from_date_time The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
109
109
  # @option opts [String] :to_date_time The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
110
110
  # @option opts [String] :campaign_id The campaign ID of the message.
111
+ # @option opts [Integer] :from_bw_latency The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
112
+ # @option opts [Boolean] :bw_queued A boolean value indicating whether the message is queued in the Bandwidth network.
113
+ # @option opts [ProductTypeEnum] :product Messaging product associated with the message.
114
+ # @option opts [String] :location Location Id associated with the message.
115
+ # @option opts [Boolean] :carrier_queued 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.
116
+ # @option opts [Integer] :from_carrier_latency The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
117
+ # @option opts [String] :calling_number_country_a3 Calling number country in A3 format.
118
+ # @option opts [String] :called_number_country_a3 Called number country in A3 format.
119
+ # @option opts [Integer] :from_segment_count Segment count (start range).
120
+ # @option opts [Integer] :to_segment_count Segment count (end range).
121
+ # @option opts [Integer] :from_message_size Message size (start range).
122
+ # @option opts [Integer] :to_message_size Message size (end range).
111
123
  # @option opts [String] :sort The field and direction to sort by combined with a colon. Direction is either asc or desc.
112
124
  # @option opts [String] :page_token A base64 encoded value used for pagination of results.
113
125
  # @option opts [Integer] :limit The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
@@ -133,6 +145,18 @@ module Bandwidth
133
145
  # @option opts [String] :from_date_time The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
134
146
  # @option opts [String] :to_date_time The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
135
147
  # @option opts [String] :campaign_id The campaign ID of the message.
148
+ # @option opts [Integer] :from_bw_latency The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
149
+ # @option opts [Boolean] :bw_queued A boolean value indicating whether the message is queued in the Bandwidth network.
150
+ # @option opts [ProductTypeEnum] :product Messaging product associated with the message.
151
+ # @option opts [String] :location Location Id associated with the message.
152
+ # @option opts [Boolean] :carrier_queued 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.
153
+ # @option opts [Integer] :from_carrier_latency The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
154
+ # @option opts [String] :calling_number_country_a3 Calling number country in A3 format.
155
+ # @option opts [String] :called_number_country_a3 Called number country in A3 format.
156
+ # @option opts [Integer] :from_segment_count Segment count (start range).
157
+ # @option opts [Integer] :to_segment_count Segment count (end range).
158
+ # @option opts [Integer] :from_message_size Message size (start range).
159
+ # @option opts [Integer] :to_message_size Message size (end range).
136
160
  # @option opts [String] :sort The field and direction to sort by combined with a colon. Direction is either asc or desc.
137
161
  # @option opts [String] :page_token A base64 encoded value used for pagination of results.
138
162
  # @option opts [Integer] :limit The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
@@ -162,6 +186,18 @@ module Bandwidth
162
186
  query_params[:'fromDateTime'] = opts[:'from_date_time'] if !opts[:'from_date_time'].nil?
163
187
  query_params[:'toDateTime'] = opts[:'to_date_time'] if !opts[:'to_date_time'].nil?
164
188
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
189
+ query_params[:'fromBwLatency'] = opts[:'from_bw_latency'] if !opts[:'from_bw_latency'].nil?
190
+ query_params[:'bwQueued'] = opts[:'bw_queued'] if !opts[:'bw_queued'].nil?
191
+ query_params[:'product'] = opts[:'product'] if !opts[:'product'].nil?
192
+ query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
193
+ query_params[:'carrierQueued'] = opts[:'carrier_queued'] if !opts[:'carrier_queued'].nil?
194
+ query_params[:'fromCarrierLatency'] = opts[:'from_carrier_latency'] if !opts[:'from_carrier_latency'].nil?
195
+ query_params[:'callingNumberCountryA3'] = opts[:'calling_number_country_a3'] if !opts[:'calling_number_country_a3'].nil?
196
+ query_params[:'calledNumberCountryA3'] = opts[:'called_number_country_a3'] if !opts[:'called_number_country_a3'].nil?
197
+ query_params[:'fromSegmentCount'] = opts[:'from_segment_count'] if !opts[:'from_segment_count'].nil?
198
+ query_params[:'toSegmentCount'] = opts[:'to_segment_count'] if !opts[:'to_segment_count'].nil?
199
+ query_params[:'fromMessageSize'] = opts[:'from_message_size'] if !opts[:'from_message_size'].nil?
200
+ query_params[:'toMessageSize'] = opts[:'to_message_size'] if !opts[:'to_message_size'].nil?
165
201
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
166
202
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?
167
203
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
@@ -19,7 +19,7 @@ module Bandwidth
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a specific transcription
22
+ # Delete Real-time Transcription
23
23
  # Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
24
24
  # @param account_id [String] Your Bandwidth Account ID.
25
25
  # @param call_id [String] Programmable Voice API Call ID.
@@ -31,7 +31,7 @@ module Bandwidth
31
31
  nil
32
32
  end
33
33
 
34
- # Delete a specific transcription
34
+ # Delete Real-time Transcription
35
35
  # Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a &#x60;200&#x60; is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
36
36
  # @param account_id [String] Your Bandwidth Account ID.
37
37
  # @param call_id [String] Programmable Voice API Call ID.
@@ -94,7 +94,7 @@ module Bandwidth
94
94
  return data, status_code, headers
95
95
  end
96
96
 
97
- # Retrieve a specific transcription
97
+ # Get Real-time Transcription
98
98
  # Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
99
99
  # @param account_id [String] Your Bandwidth Account ID.
100
100
  # @param call_id [String] Programmable Voice API Call ID.
@@ -106,7 +106,7 @@ module Bandwidth
106
106
  data
107
107
  end
108
108
 
109
- # Retrieve a specific transcription
109
+ # Get Real-time Transcription
110
110
  # Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
111
111
  # @param account_id [String] Your Bandwidth Account ID.
112
112
  # @param call_id [String] Programmable Voice API Call ID.
@@ -169,8 +169,8 @@ module Bandwidth
169
169
  return data, status_code, headers
170
170
  end
171
171
 
172
- # Enumerate transcriptions made with StartTranscription
173
- # Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
172
+ # List Real-time Transcriptions
173
+ # List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
174
174
  # @param account_id [String] Your Bandwidth Account ID.
175
175
  # @param call_id [String] Programmable Voice API Call ID.
176
176
  # @param [Hash] opts the optional parameters
@@ -180,8 +180,8 @@ module Bandwidth
180
180
  data
181
181
  end
182
182
 
183
- # Enumerate transcriptions made with StartTranscription
184
- # Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
183
+ # List Real-time Transcriptions
184
+ # List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
185
185
  # @param account_id [String] Your Bandwidth Account ID.
186
186
  # @param call_id [String] Programmable Voice API Call ID.
187
187
  # @param [Hash] opts the optional parameters
@@ -0,0 +1,43 @@
1
+ =begin
2
+ #Bandwidth
3
+
4
+ #Bandwidth's Communication APIs
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: letstalk@bandwidth.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.8.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Bandwidth
17
+ class BusinessEntityTypeEnum
18
+ SOLE_PROPRIETOR = 'SOLE_PROPRIETOR'.freeze
19
+ PRIVATE_PROFIT = 'PRIVATE_PROFIT'.freeze
20
+ PUBLIC_PROFIT = 'PUBLIC_PROFIT'.freeze
21
+ NON_PROFIT = 'NON_PROFIT'.freeze
22
+ GOVERNMENT = 'GOVERNMENT'.freeze
23
+
24
+ def self.all_vars
25
+ @all_vars ||= [SOLE_PROPRIETOR, PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT].freeze
26
+ end
27
+
28
+ # Builds the enum from string
29
+ # @param [String] The enum value in the form of the string
30
+ # @return [String] The enum value
31
+ def self.build_from_hash(value)
32
+ new.build_from_hash(value)
33
+ end
34
+
35
+ # Builds the enum from string
36
+ # @param [String] The enum value in the form of the string
37
+ # @return [String] The enum value
38
+ def build_from_hash(value)
39
+ return value if BusinessEntityTypeEnum.all_vars.include?(value)
40
+ raise "Invalid ENUM value #{value} for class #BusinessEntityTypeEnum"
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,40 @@
1
+ =begin
2
+ #Bandwidth
3
+
4
+ #Bandwidth's Communication APIs
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: letstalk@bandwidth.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.8.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Bandwidth
17
+ class BusinessRegistrationTypeEnum
18
+ EIN = 'EIN'.freeze
19
+ CBN = 'CBN'.freeze
20
+
21
+ def self.all_vars
22
+ @all_vars ||= [EIN, CBN].freeze
23
+ end
24
+
25
+ # Builds the enum from string
26
+ # @param [String] The enum value in the form of the string
27
+ # @return [String] The enum value
28
+ def self.build_from_hash(value)
29
+ new.build_from_hash(value)
30
+ end
31
+
32
+ # Builds the enum from string
33
+ # @param [String] The enum value in the form of the string
34
+ # @return [String] The enum value
35
+ def build_from_hash(value)
36
+ return value if BusinessRegistrationTypeEnum.all_vars.include?(value)
37
+ raise "Invalid ENUM value #{value} for class #BusinessRegistrationTypeEnum"
38
+ end
39
+ end
40
+ end
@@ -7,7 +7,8 @@ module Bandwidth
7
7
  super('StopStream', nil, attributes)
8
8
 
9
9
  @attribute_map = {
10
- name: 'name' # [String]: The name of the stream to stop. This is either the user selected name when sending the <StartStream> verb, or the system generated name returned in the Media Stream Started webhook if <StartStream> was sent with no name attribute.
10
+ name: 'name', # [String]: The name of the stream to stop. This is either the user selected name when sending the <StartStream> verb, or the system generated name returned in the Media Stream Started webhook if <StartStream> was sent with no name attribute.
11
+ wait: 'wait' # Optional [Boolean]: If true, the BXML interpreter will wait for the stream to stop before processing the next verb.
11
12
  }
12
13
  end
13
14
  end
@@ -21,7 +21,7 @@ module Bandwidth
21
21
  # The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
22
22
  attr_accessor :transcription_name
23
23
 
24
- # A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
24
+ # A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
25
25
  attr_accessor :transcription_url
26
26
 
27
27
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -21,7 +21,7 @@ module Bandwidth
21
21
  # The unique, Bandwidth-generated ID of the conference that was recorded
22
22
  attr_accessor :conference_id
23
23
 
24
- # A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.
24
+ # A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint.
25
25
  attr_accessor :member_url
26
26
 
27
27
  # Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member's mute status. Has no effect if omitted.