bandwidth-sdk 16.2.0 → 16.2.2
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 +15 -15
- data/README.md +3 -3
- data/bandwidth.yml +18 -15
- data/coverage/.resultset.json +5 -1
- data/coverage/index.html +217 -169
- data/docs/CallState.md +2 -2
- data/docs/CallTranscriptionMetadata.md +1 -1
- data/docs/ConferenceMember.md +1 -1
- data/docs/MultiChannelMessageResponseData.md +2 -2
- data/docs/StirShaken.md +2 -2
- data/docs/TranscriptionsApi.md +13 -13
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +4 -0
- data/lib/bandwidth-sdk/api/transcriptions_api.rb +8 -8
- data/lib/bandwidth-sdk/models/call_state.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/conference_member.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb +11 -11
- data/lib/bandwidth-sdk/models/stir_shaken.rb +1 -1
- data/lib/bandwidth-sdk/version.rb +1 -1
- metadata +46 -46
data/docs/CallState.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **from** | **String** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
13
|
| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
|
|
14
14
|
| **state** | **String** | The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
|
|
15
|
-
| **stir_shaken** | **Hash<String, String>** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-
|
|
15
|
+
| **stir_shaken** | **Hash<String, String>** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] |
|
|
16
16
|
| **identity** | **String** | The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. | [optional] |
|
|
17
17
|
| **enqueued_time** | **Time** | The time this call was placed in queue. | [optional] |
|
|
18
18
|
| **start_time** | **Time** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] |
|
|
@@ -37,7 +37,7 @@ instance = Bandwidth::CallState.new(
|
|
|
37
37
|
from: +19195554321,
|
|
38
38
|
direction: null,
|
|
39
39
|
state: disconnected,
|
|
40
|
-
stir_shaken: {"verstat":"TN-
|
|
40
|
+
stir_shaken: {"verstat":"TN-Validation-Passed","attestationIndicator":"A","originatingId":"abc123"},
|
|
41
41
|
identity: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=<https://bw-shaken-cert-pub.s3.amazonaws.com/bandwidth-shaken-cert_20230716.pem>;alg=ES256;ppt=shaken,
|
|
42
42
|
enqueued_time: 2022-06-16T13:15:07.160Z,
|
|
43
43
|
start_time: 2022-06-16T13:15:07.160Z,
|
|
@@ -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/
|
|
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
|
|
data/docs/ConferenceMember.md
CHANGED
|
@@ -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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
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
|
-
|
|
22
|
+
id: 1589228074636lm4k2je7j7jklbn2,
|
|
23
23
|
time: 2025-01-01T18:20:16Z,
|
|
24
24
|
direction: null,
|
|
25
25
|
to: ["+15554443333"],
|
data/docs/StirShaken.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **verstat** | **String** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-
|
|
7
|
+
| **verstat** | **String** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed. | [optional] |
|
|
8
8
|
| **attestation_indicator** | **String** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] |
|
|
9
9
|
| **originating_id** | **String** | (optional) A unique origination identifier. | [optional] |
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
require 'bandwidth-sdk'
|
|
15
15
|
|
|
16
16
|
instance = Bandwidth::StirShaken.new(
|
|
17
|
-
verstat: Tn-
|
|
17
|
+
verstat: Tn-Validation-Passed,
|
|
18
18
|
attestation_indicator: A,
|
|
19
19
|
originating_id: 99759086-1335-11ed-9bcf-5f7d464e91af
|
|
20
20
|
)
|
data/docs/TranscriptionsApi.md
CHANGED
|
@@ -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
|
|
8
|
-
| [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} |
|
|
9
|
-
| [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions |
|
|
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
|
|
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
|
|
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
|
|
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
|
-
|
|
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
|
-
#
|
|
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
|
-
#
|
|
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
|
-
|
|
163
|
+
List Real-time Transcriptions
|
|
164
164
|
|
|
165
|
-
|
|
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
|
-
#
|
|
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
|
-
#
|
|
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 # => { ... }
|
|
@@ -26,6 +26,7 @@ module Bandwidth
|
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [CreateLookupResponse]
|
|
28
28
|
def create_lookup(account_id, lookup_request, opts = {})
|
|
29
|
+
warn '[DEPRECATION NOTICE] `create_lookup` is deprecated.'
|
|
29
30
|
data, _status_code, _headers = create_lookup_with_http_info(account_id, lookup_request, opts)
|
|
30
31
|
data
|
|
31
32
|
end
|
|
@@ -37,6 +38,7 @@ module Bandwidth
|
|
|
37
38
|
# @param [Hash] opts the optional parameters
|
|
38
39
|
# @return [Array<(CreateLookupResponse, Integer, Hash)>] CreateLookupResponse data, response status code and response headers
|
|
39
40
|
def create_lookup_with_http_info(account_id, lookup_request, opts = {})
|
|
41
|
+
warn '[DEPRECATION NOTICE] `create_lookup_with_http_info` is deprecated.'
|
|
40
42
|
if @api_client.config.debugging
|
|
41
43
|
@api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.create_lookup ...'
|
|
42
44
|
end
|
|
@@ -100,6 +102,7 @@ module Bandwidth
|
|
|
100
102
|
# @param [Hash] opts the optional parameters
|
|
101
103
|
# @return [LookupStatus]
|
|
102
104
|
def get_lookup_status(account_id, request_id, opts = {})
|
|
105
|
+
warn '[DEPRECATION NOTICE] `get_lookup_status` is deprecated.'
|
|
103
106
|
data, _status_code, _headers = get_lookup_status_with_http_info(account_id, request_id, opts)
|
|
104
107
|
data
|
|
105
108
|
end
|
|
@@ -111,6 +114,7 @@ module Bandwidth
|
|
|
111
114
|
# @param [Hash] opts the optional parameters
|
|
112
115
|
# @return [Array<(LookupStatus, Integer, Hash)>] LookupStatus data, response status code and response headers
|
|
113
116
|
def get_lookup_status_with_http_info(account_id, request_id, opts = {})
|
|
117
|
+
warn '[DEPRECATION NOTICE] `get_lookup_status_with_http_info` is deprecated.'
|
|
114
118
|
if @api_client.config.debugging
|
|
115
119
|
@api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.get_lookup_status ...'
|
|
116
120
|
end
|
|
@@ -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
|
|
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
|
|
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 `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.
|
|
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
|
-
#
|
|
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
|
-
#
|
|
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
|
-
#
|
|
173
|
-
#
|
|
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
|
-
#
|
|
184
|
-
#
|
|
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
|
|
@@ -38,7 +38,7 @@ module Bandwidth
|
|
|
38
38
|
# The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values.
|
|
39
39
|
attr_accessor :state
|
|
40
40
|
|
|
41
|
-
# For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-
|
|
41
|
+
# For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
|
|
42
42
|
attr_accessor :stir_shaken
|
|
43
43
|
|
|
44
44
|
# The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header.
|
|
@@ -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/
|
|
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.
|
|
@@ -17,7 +17,7 @@ module Bandwidth
|
|
|
17
17
|
# The data returned in a multichannel message response.
|
|
18
18
|
class MultiChannelMessageResponseData
|
|
19
19
|
# The ID of the message.
|
|
20
|
-
attr_accessor :
|
|
20
|
+
attr_accessor :id
|
|
21
21
|
|
|
22
22
|
# The time the message was received by the Bandwidth API.
|
|
23
23
|
attr_accessor :time
|
|
@@ -63,7 +63,7 @@ module Bandwidth
|
|
|
63
63
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
64
64
|
def self.attribute_map
|
|
65
65
|
{
|
|
66
|
-
:'
|
|
66
|
+
:'id' => :'id',
|
|
67
67
|
:'time' => :'time',
|
|
68
68
|
:'direction' => :'direction',
|
|
69
69
|
:'to' => :'to',
|
|
@@ -82,7 +82,7 @@ module Bandwidth
|
|
|
82
82
|
# Attribute type mapping.
|
|
83
83
|
def self.openapi_types
|
|
84
84
|
{
|
|
85
|
-
:'
|
|
85
|
+
:'id' => :'String',
|
|
86
86
|
:'time' => :'Time',
|
|
87
87
|
:'direction' => :'MessageDirectionEnum',
|
|
88
88
|
:'to' => :'Array<String>',
|
|
@@ -114,10 +114,10 @@ module Bandwidth
|
|
|
114
114
|
h[k.to_sym] = v
|
|
115
115
|
}
|
|
116
116
|
|
|
117
|
-
if attributes.key?(:'
|
|
118
|
-
self.
|
|
117
|
+
if attributes.key?(:'id')
|
|
118
|
+
self.id = attributes[:'id']
|
|
119
119
|
else
|
|
120
|
-
self.
|
|
120
|
+
self.id = nil
|
|
121
121
|
end
|
|
122
122
|
|
|
123
123
|
if attributes.key?(:'time')
|
|
@@ -166,8 +166,8 @@ module Bandwidth
|
|
|
166
166
|
def list_invalid_properties
|
|
167
167
|
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
168
168
|
invalid_properties = Array.new
|
|
169
|
-
if @
|
|
170
|
-
invalid_properties.push('invalid value for "
|
|
169
|
+
if @id.nil?
|
|
170
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
171
171
|
end
|
|
172
172
|
|
|
173
173
|
if @time.nil?
|
|
@@ -197,7 +197,7 @@ module Bandwidth
|
|
|
197
197
|
# @return true if the model is valid
|
|
198
198
|
def valid?
|
|
199
199
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
200
|
-
return false if @
|
|
200
|
+
return false if @id.nil?
|
|
201
201
|
return false if @time.nil?
|
|
202
202
|
return false if @direction.nil?
|
|
203
203
|
return false if @to.nil?
|
|
@@ -235,7 +235,7 @@ module Bandwidth
|
|
|
235
235
|
def ==(o)
|
|
236
236
|
return true if self.equal?(o)
|
|
237
237
|
self.class == o.class &&
|
|
238
|
-
|
|
238
|
+
id == o.id &&
|
|
239
239
|
time == o.time &&
|
|
240
240
|
direction == o.direction &&
|
|
241
241
|
to == o.to &&
|
|
@@ -254,7 +254,7 @@ module Bandwidth
|
|
|
254
254
|
# Calculates hash code according to all attributes.
|
|
255
255
|
# @return [Integer] Hash code
|
|
256
256
|
def hash
|
|
257
|
-
[
|
|
257
|
+
[id, time, direction, to, channel_list, tag, priority, expiration].hash
|
|
258
258
|
end
|
|
259
259
|
|
|
260
260
|
# Builds the object from hash
|
|
@@ -15,7 +15,7 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module Bandwidth
|
|
17
17
|
class StirShaken
|
|
18
|
-
# (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-
|
|
18
|
+
# (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.
|
|
19
19
|
attr_accessor :verstat
|
|
20
20
|
|
|
21
21
|
# (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway).
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: bandwidth-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 16.2.
|
|
4
|
+
version: 16.2.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Bandwidth
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-
|
|
11
|
+
date: 2025-10-28 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|
|
@@ -606,67 +606,67 @@ summary: Bandwidth Ruby SDK
|
|
|
606
606
|
test_files:
|
|
607
607
|
- spec/call_utils.rb
|
|
608
608
|
- spec/fixtures/ruby_cat.jpeg
|
|
609
|
-
- spec/smoke/
|
|
610
|
-
- spec/smoke/transcriptions_api_spec.rb
|
|
609
|
+
- spec/smoke/statistics_api_spec.rb
|
|
611
610
|
- spec/smoke/toll_free_verification_api_spec.rb
|
|
612
|
-
- spec/smoke/
|
|
611
|
+
- spec/smoke/media_api_spec.rb
|
|
612
|
+
- spec/smoke/transcriptions_api_spec.rb
|
|
613
|
+
- spec/smoke/mfa_api_spec.rb
|
|
614
|
+
- spec/smoke/phone_number_lookup_api_spec.rb
|
|
613
615
|
- spec/smoke/messages_api_spec.rb
|
|
616
|
+
- spec/smoke/multi_channel_api_spec.rb
|
|
614
617
|
- spec/smoke/conferences_api_spec.rb
|
|
615
618
|
- spec/smoke/recordings_api_spec.rb
|
|
616
|
-
- spec/smoke/mfa_api_spec.rb
|
|
617
|
-
- spec/smoke/statistics_api_spec.rb
|
|
618
619
|
- spec/smoke/calls_api_spec.rb
|
|
619
|
-
- spec/smoke/media_api_spec.rb
|
|
620
620
|
- spec/spec_helper.rb
|
|
621
|
-
- spec/unit/api/
|
|
622
|
-
- spec/unit/api/transcriptions_api_spec.rb
|
|
621
|
+
- spec/unit/api/statistics_api_spec.rb
|
|
623
622
|
- spec/unit/api/toll_free_verification_api_spec.rb
|
|
624
|
-
- spec/unit/api/
|
|
623
|
+
- spec/unit/api/media_api_spec.rb
|
|
624
|
+
- spec/unit/api/transcriptions_api_spec.rb
|
|
625
|
+
- spec/unit/api/mfa_api_spec.rb
|
|
626
|
+
- spec/unit/api/phone_number_lookup_api_spec.rb
|
|
625
627
|
- spec/unit/api/messages_api_spec.rb
|
|
628
|
+
- spec/unit/api/multi_channel_api_spec.rb
|
|
626
629
|
- spec/unit/api/conferences_api_spec.rb
|
|
627
630
|
- spec/unit/api/recordings_api_spec.rb
|
|
628
|
-
- spec/unit/api/mfa_api_spec.rb
|
|
629
|
-
- spec/unit/api/statistics_api_spec.rb
|
|
630
631
|
- spec/unit/api/calls_api_spec.rb
|
|
631
|
-
- spec/unit/
|
|
632
|
-
- spec/unit/
|
|
633
|
-
- spec/unit/
|
|
634
|
-
- spec/unit/
|
|
635
|
-
- spec/unit/models/
|
|
636
|
-
- spec/unit/models/call_state_spec.rb
|
|
637
|
-
- spec/unit/models/tfv_error_spec.rb
|
|
638
|
-
- spec/unit/models/bxml/verbs/gather_spec.rb
|
|
639
|
-
- spec/unit/models/bxml/verbs/stop_recording_spec.rb
|
|
640
|
-
- spec/unit/models/bxml/verbs/stop_transcription_spec.rb
|
|
641
|
-
- spec/unit/models/bxml/verbs/ring_spec.rb
|
|
642
|
-
- spec/unit/models/bxml/verbs/resume_recording_spec.rb
|
|
643
|
-
- spec/unit/models/bxml/verbs/record_spec.rb
|
|
644
|
-
- spec/unit/models/bxml/verbs/start_stream_spec.rb
|
|
645
|
-
- spec/unit/models/bxml/verbs/pause_spec.rb
|
|
632
|
+
- spec/unit/models/message_spec.rb
|
|
633
|
+
- spec/unit/models/bxml/response_spec.rb
|
|
634
|
+
- spec/unit/models/bxml/verb_spec.rb
|
|
635
|
+
- spec/unit/models/bxml/nestable_verb_spec.rb
|
|
636
|
+
- spec/unit/models/bxml/verbs/stream_param_spec.rb
|
|
646
637
|
- spec/unit/models/bxml/verbs/start_gather_spec.rb
|
|
647
|
-
- spec/unit/models/bxml/verbs/hangup_spec.rb
|
|
648
|
-
- spec/unit/models/bxml/verbs/redirect_spec.rb
|
|
649
|
-
- spec/unit/models/bxml/verbs/bridge_spec.rb
|
|
650
|
-
- spec/unit/models/bxml/verbs/start_transcription_spec.rb
|
|
651
|
-
- spec/unit/models/bxml/verbs/custom_param_spec.rb
|
|
652
638
|
- spec/unit/models/bxml/verbs/conference_spec.rb
|
|
653
639
|
- spec/unit/models/bxml/verbs/stop_gather_spec.rb
|
|
654
|
-
- spec/unit/models/bxml/verbs/
|
|
640
|
+
- spec/unit/models/bxml/verbs/start_recording_spec.rb
|
|
641
|
+
- spec/unit/models/bxml/verbs/start_stream_spec.rb
|
|
642
|
+
- spec/unit/models/bxml/verbs/speak_sentence_spec.rb
|
|
643
|
+
- spec/unit/models/bxml/verbs/custom_param_spec.rb
|
|
644
|
+
- spec/unit/models/bxml/verbs/transfer_spec.rb
|
|
645
|
+
- spec/unit/models/bxml/verbs/gather_spec.rb
|
|
646
|
+
- spec/unit/models/bxml/verbs/hangup_spec.rb
|
|
647
|
+
- spec/unit/models/bxml/verbs/resume_recording_spec.rb
|
|
655
648
|
- spec/unit/models/bxml/verbs/sip_uri_spec.rb
|
|
656
|
-
- spec/unit/models/bxml/verbs/
|
|
649
|
+
- spec/unit/models/bxml/verbs/start_transcription_spec.rb
|
|
657
650
|
- spec/unit/models/bxml/verbs/play_audio_spec.rb
|
|
658
|
-
- spec/unit/models/bxml/verbs/stop_stream_spec.rb
|
|
659
|
-
- spec/unit/models/bxml/verbs/transfer_spec.rb
|
|
660
651
|
- spec/unit/models/bxml/verbs/send_dtmf_spec.rb
|
|
661
|
-
- spec/unit/models/bxml/verbs/
|
|
662
|
-
- spec/unit/models/bxml/verbs/
|
|
663
|
-
- spec/unit/models/bxml/verbs/
|
|
664
|
-
- spec/unit/models/bxml/verbs/
|
|
652
|
+
- spec/unit/models/bxml/verbs/forward_spec.rb
|
|
653
|
+
- spec/unit/models/bxml/verbs/stop_recording_spec.rb
|
|
654
|
+
- spec/unit/models/bxml/verbs/ring_spec.rb
|
|
655
|
+
- spec/unit/models/bxml/verbs/stop_stream_spec.rb
|
|
656
|
+
- spec/unit/models/bxml/verbs/bridge_spec.rb
|
|
665
657
|
- spec/unit/models/bxml/verbs/phone_number_spec.rb
|
|
666
|
-
- spec/unit/models/bxml/
|
|
658
|
+
- spec/unit/models/bxml/verbs/pause_spec.rb
|
|
659
|
+
- spec/unit/models/bxml/verbs/pause_recording_spec.rb
|
|
660
|
+
- spec/unit/models/bxml/verbs/record_spec.rb
|
|
661
|
+
- spec/unit/models/bxml/verbs/tag_spec.rb
|
|
662
|
+
- spec/unit/models/bxml/verbs/stop_transcription_spec.rb
|
|
663
|
+
- spec/unit/models/bxml/verbs/redirect_spec.rb
|
|
667
664
|
- spec/unit/models/bxml/bxml_spec.rb
|
|
668
|
-
- spec/unit/models/
|
|
669
|
-
- spec/unit/models/bxml/nestable_verb_spec.rb
|
|
670
|
-
- spec/unit/models/call_state_enum_spec.rb
|
|
665
|
+
- spec/unit/models/verify_code_request_spec.rb
|
|
671
666
|
- spec/unit/models/verify_code_response_spec.rb
|
|
672
|
-
- spec/unit/models/
|
|
667
|
+
- spec/unit/models/call_state_spec.rb
|
|
668
|
+
- spec/unit/models/tfv_error_spec.rb
|
|
669
|
+
- spec/unit/models/call_state_enum_spec.rb
|
|
670
|
+
- spec/unit/client/configuration_spec.rb
|
|
671
|
+
- spec/unit/client/api_error_spec.rb
|
|
672
|
+
- spec/unit/client/api_client_spec.rb
|