twilio-ruby 6.0.2 → 6.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +25 -0
- data/README.md +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +4 -4
- data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb +13 -13
- data/lib/twilio-ruby/rest/insights/v1/call/call_summary.rb +22 -22
- data/lib/twilio-ruby/rest/insights/v1/call/event.rb +12 -12
- data/lib/twilio-ruby/rest/insights/v1/call/metric.rb +13 -13
- data/lib/twilio-ruby/rest/insights/v1/call_summaries.rb +106 -99
- data/lib/twilio-ruby/rest/insights/v1/setting.rb +12 -12
- data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb +17 -4
- data/lib/twilio-ruby/rest/numbers/v1/porting_bulk_portability.rb +229 -0
- data/lib/twilio-ruby/rest/numbers/v1/porting_portability.rb +245 -0
- data/lib/twilio-ruby/rest/numbers/v1.rb +30 -0
- data/lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb +348 -0
- data/lib/twilio-ruby/rest/numbers/v2/authorization_document.rb +403 -0
- data/lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb +515 -0
- data/lib/twilio-ruby/rest/numbers/v2.rb +30 -0
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +3 -3
- data/lib/twilio-ruby/version.rb +1 -1
- metadata +7 -2
@@ -34,29 +34,29 @@ module Twilio
|
|
34
34
|
# Lists CallSummariesInstance records from the API as a list.
|
35
35
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
36
36
|
# memory before returning.
|
37
|
-
# @param [String] from
|
38
|
-
# @param [String] to
|
39
|
-
# @param [String] from_carrier
|
40
|
-
# @param [String] to_carrier
|
41
|
-
# @param [String] from_country_code
|
42
|
-
# @param [String] to_country_code
|
43
|
-
# @param [Boolean] branded
|
44
|
-
# @param [Boolean] verified_caller
|
45
|
-
# @param [Boolean] has_tag
|
46
|
-
# @param [String] start_time
|
47
|
-
# @param [String] end_time
|
48
|
-
# @param [String] call_type
|
49
|
-
# @param [String] call_state
|
50
|
-
# @param [String] direction
|
51
|
-
# @param [ProcessingStateRequest] processing_state
|
52
|
-
# @param [SortBy] sort_by
|
53
|
-
# @param [String] subaccount
|
54
|
-
# @param [Boolean] abnormal_session
|
55
|
-
# @param [AnsweredBy] answered_by
|
56
|
-
# @param [String]
|
57
|
-
# @param [String]
|
58
|
-
# @param [Boolean] spam
|
59
|
-
# @param [String]
|
37
|
+
# @param [String] from A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
|
38
|
+
# @param [String] to A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
|
39
|
+
# @param [String] from_carrier An origination carrier.
|
40
|
+
# @param [String] to_carrier A destination carrier.
|
41
|
+
# @param [String] from_country_code A source country code based on phone number in From.
|
42
|
+
# @param [String] to_country_code A destination country code. Based on phone number in To.
|
43
|
+
# @param [Boolean] branded A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
|
44
|
+
# @param [Boolean] verified_caller A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
|
45
|
+
# @param [Boolean] has_tag A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
|
46
|
+
# @param [String] start_time A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
|
47
|
+
# @param [String] end_time An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
|
48
|
+
# @param [String] call_type A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
|
49
|
+
# @param [String] call_state A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
|
50
|
+
# @param [String] direction A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
|
51
|
+
# @param [ProcessingStateRequest] processing_state A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
|
52
|
+
# @param [SortBy] sort_by A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
|
53
|
+
# @param [String] subaccount A unique SID identifier of a Subaccount.
|
54
|
+
# @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
|
55
|
+
# @param [AnsweredBy] answered_by An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
|
56
|
+
# @param [String] connectivity_issue A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
|
57
|
+
# @param [String] quality_issue A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
|
58
|
+
# @param [Boolean] spam A boolean flag indicating spam calls.
|
59
|
+
# @param [String] call_score A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
|
60
60
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
61
61
|
# guarantees to never return more than limit. Default is no limit
|
62
62
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -64,7 +64,7 @@ module Twilio
|
|
64
64
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
65
65
|
# efficient page size, i.e. min(limit, 1000)
|
66
66
|
# @return [Array] Array of up to limit results
|
67
|
-
def list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset,
|
67
|
+
def list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, connectivity_issue: :unset, quality_issue: :unset, spam: :unset, call_score: :unset, limit: nil, page_size: nil)
|
68
68
|
self.stream(
|
69
69
|
from: from,
|
70
70
|
to: to,
|
@@ -85,10 +85,10 @@ module Twilio
|
|
85
85
|
subaccount: subaccount,
|
86
86
|
abnormal_session: abnormal_session,
|
87
87
|
answered_by: answered_by,
|
88
|
-
|
89
|
-
|
88
|
+
connectivity_issue: connectivity_issue,
|
89
|
+
quality_issue: quality_issue,
|
90
90
|
spam: spam,
|
91
|
-
|
91
|
+
call_score: call_score,
|
92
92
|
limit: limit,
|
93
93
|
page_size: page_size
|
94
94
|
).entries
|
@@ -98,29 +98,29 @@ module Twilio
|
|
98
98
|
# Streams Instance records from the API as an Enumerable.
|
99
99
|
# This operation lazily loads records as efficiently as possible until the limit
|
100
100
|
# is reached.
|
101
|
-
# @param [String] from
|
102
|
-
# @param [String] to
|
103
|
-
# @param [String] from_carrier
|
104
|
-
# @param [String] to_carrier
|
105
|
-
# @param [String] from_country_code
|
106
|
-
# @param [String] to_country_code
|
107
|
-
# @param [Boolean] branded
|
108
|
-
# @param [Boolean] verified_caller
|
109
|
-
# @param [Boolean] has_tag
|
110
|
-
# @param [String] start_time
|
111
|
-
# @param [String] end_time
|
112
|
-
# @param [String] call_type
|
113
|
-
# @param [String] call_state
|
114
|
-
# @param [String] direction
|
115
|
-
# @param [ProcessingStateRequest] processing_state
|
116
|
-
# @param [SortBy] sort_by
|
117
|
-
# @param [String] subaccount
|
118
|
-
# @param [Boolean] abnormal_session
|
119
|
-
# @param [AnsweredBy] answered_by
|
120
|
-
# @param [String]
|
121
|
-
# @param [String]
|
122
|
-
# @param [Boolean] spam
|
123
|
-
# @param [String]
|
101
|
+
# @param [String] from A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
|
102
|
+
# @param [String] to A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
|
103
|
+
# @param [String] from_carrier An origination carrier.
|
104
|
+
# @param [String] to_carrier A destination carrier.
|
105
|
+
# @param [String] from_country_code A source country code based on phone number in From.
|
106
|
+
# @param [String] to_country_code A destination country code. Based on phone number in To.
|
107
|
+
# @param [Boolean] branded A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
|
108
|
+
# @param [Boolean] verified_caller A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
|
109
|
+
# @param [Boolean] has_tag A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
|
110
|
+
# @param [String] start_time A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
|
111
|
+
# @param [String] end_time An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
|
112
|
+
# @param [String] call_type A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
|
113
|
+
# @param [String] call_state A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
|
114
|
+
# @param [String] direction A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
|
115
|
+
# @param [ProcessingStateRequest] processing_state A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
|
116
|
+
# @param [SortBy] sort_by A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
|
117
|
+
# @param [String] subaccount A unique SID identifier of a Subaccount.
|
118
|
+
# @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
|
119
|
+
# @param [AnsweredBy] answered_by An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
|
120
|
+
# @param [String] connectivity_issue A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
|
121
|
+
# @param [String] quality_issue A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
|
122
|
+
# @param [Boolean] spam A boolean flag indicating spam calls.
|
123
|
+
# @param [String] call_score A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
|
124
124
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
125
125
|
# guarantees to never return more than limit. Default is no limit
|
126
126
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -128,7 +128,7 @@ module Twilio
|
|
128
128
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
129
129
|
# efficient page size, i.e. min(limit, 1000)
|
130
130
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
131
|
-
def stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset,
|
131
|
+
def stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, connectivity_issue: :unset, quality_issue: :unset, spam: :unset, call_score: :unset, limit: nil, page_size: nil)
|
132
132
|
limits = @version.read_limits(limit, page_size)
|
133
133
|
|
134
134
|
page = self.page(
|
@@ -151,10 +151,10 @@ module Twilio
|
|
151
151
|
subaccount: subaccount,
|
152
152
|
abnormal_session: abnormal_session,
|
153
153
|
answered_by: answered_by,
|
154
|
-
|
155
|
-
|
154
|
+
connectivity_issue: connectivity_issue,
|
155
|
+
quality_issue: quality_issue,
|
156
156
|
spam: spam,
|
157
|
-
|
157
|
+
call_score: call_score,
|
158
158
|
page_size: limits[:page_size], )
|
159
159
|
|
160
160
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
@@ -177,34 +177,34 @@ module Twilio
|
|
177
177
|
##
|
178
178
|
# Retrieve a single page of CallSummariesInstance records from the API.
|
179
179
|
# Request is executed immediately.
|
180
|
-
# @param [String] from
|
181
|
-
# @param [String] to
|
182
|
-
# @param [String] from_carrier
|
183
|
-
# @param [String] to_carrier
|
184
|
-
# @param [String] from_country_code
|
185
|
-
# @param [String] to_country_code
|
186
|
-
# @param [Boolean] branded
|
187
|
-
# @param [Boolean] verified_caller
|
188
|
-
# @param [Boolean] has_tag
|
189
|
-
# @param [String] start_time
|
190
|
-
# @param [String] end_time
|
191
|
-
# @param [String] call_type
|
192
|
-
# @param [String] call_state
|
193
|
-
# @param [String] direction
|
194
|
-
# @param [ProcessingStateRequest] processing_state
|
195
|
-
# @param [SortBy] sort_by
|
196
|
-
# @param [String] subaccount
|
197
|
-
# @param [Boolean] abnormal_session
|
198
|
-
# @param [AnsweredBy] answered_by
|
199
|
-
# @param [String]
|
200
|
-
# @param [String]
|
201
|
-
# @param [Boolean] spam
|
202
|
-
# @param [String]
|
180
|
+
# @param [String] from A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
|
181
|
+
# @param [String] to A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
|
182
|
+
# @param [String] from_carrier An origination carrier.
|
183
|
+
# @param [String] to_carrier A destination carrier.
|
184
|
+
# @param [String] from_country_code A source country code based on phone number in From.
|
185
|
+
# @param [String] to_country_code A destination country code. Based on phone number in To.
|
186
|
+
# @param [Boolean] branded A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
|
187
|
+
# @param [Boolean] verified_caller A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
|
188
|
+
# @param [Boolean] has_tag A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
|
189
|
+
# @param [String] start_time A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
|
190
|
+
# @param [String] end_time An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
|
191
|
+
# @param [String] call_type A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
|
192
|
+
# @param [String] call_state A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
|
193
|
+
# @param [String] direction A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
|
194
|
+
# @param [ProcessingStateRequest] processing_state A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
|
195
|
+
# @param [SortBy] sort_by A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
|
196
|
+
# @param [String] subaccount A unique SID identifier of a Subaccount.
|
197
|
+
# @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
|
198
|
+
# @param [AnsweredBy] answered_by An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
|
199
|
+
# @param [String] connectivity_issue A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
|
200
|
+
# @param [String] quality_issue A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
|
201
|
+
# @param [Boolean] spam A boolean flag indicating spam calls.
|
202
|
+
# @param [String] call_score A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
|
203
203
|
# @param [String] page_token PageToken provided by the API
|
204
204
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
205
205
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
206
206
|
# @return [Page] Page of CallSummariesInstance
|
207
|
-
def page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset,
|
207
|
+
def page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, connectivity_issue: :unset, quality_issue: :unset, spam: :unset, call_score: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
208
208
|
params = Twilio::Values.of({
|
209
209
|
|
210
210
|
'From' => from,
|
@@ -245,13 +245,13 @@ module Twilio
|
|
245
245
|
|
246
246
|
'AnsweredBy' => answered_by,
|
247
247
|
|
248
|
-
'
|
248
|
+
'ConnectivityIssue' => connectivity_issue,
|
249
249
|
|
250
|
-
'
|
250
|
+
'QualityIssue' => quality_issue,
|
251
251
|
|
252
252
|
'Spam' => spam,
|
253
253
|
|
254
|
-
'
|
254
|
+
'CallScore' => call_score,
|
255
255
|
|
256
256
|
'PageToken' => page_token,
|
257
257
|
'Page' => page_number,
|
@@ -349,18 +349,19 @@ module Twilio
|
|
349
349
|
'attributes' => payload['attributes'],
|
350
350
|
'properties' => payload['properties'],
|
351
351
|
'trust' => payload['trust'],
|
352
|
+
'annotation' => payload['annotation'],
|
352
353
|
}
|
353
354
|
end
|
354
355
|
|
355
356
|
|
356
357
|
##
|
357
|
-
# @return [String]
|
358
|
+
# @return [String] The unique SID identifier of the Account.
|
358
359
|
def account_sid
|
359
360
|
@properties['account_sid']
|
360
361
|
end
|
361
362
|
|
362
363
|
##
|
363
|
-
# @return [String]
|
364
|
+
# @return [String] The unique SID identifier of the Call.
|
364
365
|
def call_sid
|
365
366
|
@properties['call_sid']
|
366
367
|
end
|
@@ -390,101 +391,107 @@ module Twilio
|
|
390
391
|
end
|
391
392
|
|
392
393
|
##
|
393
|
-
# @return [Time]
|
394
|
+
# @return [Time] The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS
|
394
395
|
def created_time
|
395
396
|
@properties['created_time']
|
396
397
|
end
|
397
398
|
|
398
399
|
##
|
399
|
-
# @return [Time]
|
400
|
+
# @return [Time] The time at which the Call was started, given in ISO 8601 format.
|
400
401
|
def start_time
|
401
402
|
@properties['start_time']
|
402
403
|
end
|
403
404
|
|
404
405
|
##
|
405
|
-
# @return [Time]
|
406
|
+
# @return [Time] The time at which the Call was ended, given in ISO 8601 format.
|
406
407
|
def end_time
|
407
408
|
@properties['end_time']
|
408
409
|
end
|
409
410
|
|
410
411
|
##
|
411
|
-
# @return [String]
|
412
|
+
# @return [String] Duration between when the call was initiated and the call was ended
|
412
413
|
def duration
|
413
414
|
@properties['duration']
|
414
415
|
end
|
415
416
|
|
416
417
|
##
|
417
|
-
# @return [String]
|
418
|
+
# @return [String] Duration between when the call was answered and when it ended
|
418
419
|
def connect_duration
|
419
420
|
@properties['connect_duration']
|
420
421
|
end
|
421
422
|
|
422
423
|
##
|
423
|
-
# @return [Hash]
|
424
|
+
# @return [Hash] The calling party.
|
424
425
|
def from
|
425
426
|
@properties['from']
|
426
427
|
end
|
427
428
|
|
428
429
|
##
|
429
|
-
# @return [Hash]
|
430
|
+
# @return [Hash] The called party.
|
430
431
|
def to
|
431
432
|
@properties['to']
|
432
433
|
end
|
433
434
|
|
434
435
|
##
|
435
|
-
# @return [Hash]
|
436
|
+
# @return [Hash] Contains metrics and properties for the Twilio media gateway of a PSTN call.
|
436
437
|
def carrier_edge
|
437
438
|
@properties['carrier_edge']
|
438
439
|
end
|
439
440
|
|
440
441
|
##
|
441
|
-
# @return [Hash]
|
442
|
+
# @return [Hash] Contains metrics and properties for the Twilio media gateway of a Client call.
|
442
443
|
def client_edge
|
443
444
|
@properties['client_edge']
|
444
445
|
end
|
445
446
|
|
446
447
|
##
|
447
|
-
# @return [Hash]
|
448
|
+
# @return [Hash] Contains metrics and properties for the SDK sensor library for Client calls.
|
448
449
|
def sdk_edge
|
449
450
|
@properties['sdk_edge']
|
450
451
|
end
|
451
452
|
|
452
453
|
##
|
453
|
-
# @return [Hash]
|
454
|
+
# @return [Hash] Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
|
454
455
|
def sip_edge
|
455
456
|
@properties['sip_edge']
|
456
457
|
end
|
457
458
|
|
458
459
|
##
|
459
|
-
# @return [Array<String>]
|
460
|
+
# @return [Array<String>] Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
|
460
461
|
def tags
|
461
462
|
@properties['tags']
|
462
463
|
end
|
463
464
|
|
464
465
|
##
|
465
|
-
# @return [String]
|
466
|
+
# @return [String] The URL of this resource.
|
466
467
|
def url
|
467
468
|
@properties['url']
|
468
469
|
end
|
469
470
|
|
470
471
|
##
|
471
|
-
# @return [Hash]
|
472
|
+
# @return [Hash] Attributes capturing call-flow-specific details.
|
472
473
|
def attributes
|
473
474
|
@properties['attributes']
|
474
475
|
end
|
475
476
|
|
476
477
|
##
|
477
|
-
# @return [Hash]
|
478
|
+
# @return [Hash] Contains edge-agnostic call-level details.
|
478
479
|
def properties
|
479
480
|
@properties['properties']
|
480
481
|
end
|
481
482
|
|
482
483
|
##
|
483
|
-
# @return [Hash]
|
484
|
+
# @return [Hash] Contains trusted communications details including Branded Call and verified caller ID.
|
484
485
|
def trust
|
485
486
|
@properties['trust']
|
486
487
|
end
|
487
488
|
|
489
|
+
##
|
490
|
+
# @return [Hash]
|
491
|
+
def annotation
|
492
|
+
@properties['annotation']
|
493
|
+
end
|
494
|
+
|
488
495
|
##
|
489
496
|
# Provide a user friendly representation
|
490
497
|
def to_s
|
@@ -55,7 +55,7 @@ module Twilio
|
|
55
55
|
end
|
56
56
|
##
|
57
57
|
# Fetch the SettingInstance
|
58
|
-
# @param [String] subaccount_sid
|
58
|
+
# @param [String] subaccount_sid The unique SID identifier of the Subaccount.
|
59
59
|
# @return [SettingInstance] Fetched SettingInstance
|
60
60
|
def fetch(
|
61
61
|
subaccount_sid: :unset
|
@@ -73,9 +73,9 @@ module Twilio
|
|
73
73
|
|
74
74
|
##
|
75
75
|
# Update the SettingInstance
|
76
|
-
# @param [Boolean] advanced_features
|
77
|
-
# @param [Boolean] voice_trace
|
78
|
-
# @param [String] subaccount_sid
|
76
|
+
# @param [Boolean] advanced_features A boolean flag to enable Advanced Features for Voice Insights.
|
77
|
+
# @param [Boolean] voice_trace A boolean flag to enable Voice Trace.
|
78
|
+
# @param [String] subaccount_sid The unique SID identifier of the Subaccount.
|
79
79
|
# @return [SettingInstance] Updated SettingInstance
|
80
80
|
def update(
|
81
81
|
advanced_features: :unset,
|
@@ -178,32 +178,32 @@ module Twilio
|
|
178
178
|
end
|
179
179
|
|
180
180
|
##
|
181
|
-
# @return [String]
|
181
|
+
# @return [String] The unique SID identifier of the Account.
|
182
182
|
def account_sid
|
183
183
|
@properties['account_sid']
|
184
184
|
end
|
185
185
|
|
186
186
|
##
|
187
|
-
# @return [Boolean]
|
187
|
+
# @return [Boolean] A boolean flag indicating whether Advanced Features for Voice Insights are enabled.
|
188
188
|
def advanced_features
|
189
189
|
@properties['advanced_features']
|
190
190
|
end
|
191
191
|
|
192
192
|
##
|
193
|
-
# @return [Boolean]
|
193
|
+
# @return [Boolean] A boolean flag indicating whether Voice Trace is enabled.
|
194
194
|
def voice_trace
|
195
195
|
@properties['voice_trace']
|
196
196
|
end
|
197
197
|
|
198
198
|
##
|
199
|
-
# @return [String]
|
199
|
+
# @return [String] The URL of this resource.
|
200
200
|
def url
|
201
201
|
@properties['url']
|
202
202
|
end
|
203
203
|
|
204
204
|
##
|
205
205
|
# Fetch the SettingInstance
|
206
|
-
# @param [String] subaccount_sid
|
206
|
+
# @param [String] subaccount_sid The unique SID identifier of the Subaccount.
|
207
207
|
# @return [SettingInstance] Fetched SettingInstance
|
208
208
|
def fetch(
|
209
209
|
subaccount_sid: :unset
|
@@ -216,9 +216,9 @@ module Twilio
|
|
216
216
|
|
217
217
|
##
|
218
218
|
# Update the SettingInstance
|
219
|
-
# @param [Boolean] advanced_features
|
220
|
-
# @param [Boolean] voice_trace
|
221
|
-
# @param [String] subaccount_sid
|
219
|
+
# @param [Boolean] advanced_features A boolean flag to enable Advanced Features for Voice Insights.
|
220
|
+
# @param [Boolean] voice_trace A boolean flag to enable Voice Trace.
|
221
|
+
# @param [String] subaccount_sid The unique SID identifier of the Subaccount.
|
222
222
|
# @return [SettingInstance] Updated SettingInstance
|
223
223
|
def update(
|
224
224
|
advanced_features: :unset,
|
@@ -58,7 +58,7 @@ module Twilio
|
|
58
58
|
end
|
59
59
|
##
|
60
60
|
# Fetch the PhoneNumberInstance
|
61
|
-
# @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match.
|
61
|
+
# @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match, reassigned_number.
|
62
62
|
# @param [String] country_code The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.
|
63
63
|
# @param [String] first_name User’s first name. This query parameter is only used (optionally) for identity_match package requests.
|
64
64
|
# @param [String] last_name User’s last name. This query parameter is only used (optionally) for identity_match package requests.
|
@@ -70,6 +70,7 @@ module Twilio
|
|
70
70
|
# @param [String] address_country_code User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests.
|
71
71
|
# @param [String] national_id User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.
|
72
72
|
# @param [String] date_of_birth User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.
|
73
|
+
# @param [String] last_verified_date The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.
|
73
74
|
# @return [PhoneNumberInstance] Fetched PhoneNumberInstance
|
74
75
|
def fetch(
|
75
76
|
fields: :unset,
|
@@ -83,7 +84,8 @@ module Twilio
|
|
83
84
|
postal_code: :unset,
|
84
85
|
address_country_code: :unset,
|
85
86
|
national_id: :unset,
|
86
|
-
date_of_birth: :unset
|
87
|
+
date_of_birth: :unset,
|
88
|
+
last_verified_date: :unset
|
87
89
|
)
|
88
90
|
|
89
91
|
params = Twilio::Values.of({
|
@@ -99,6 +101,7 @@ module Twilio
|
|
99
101
|
'AddressCountryCode' => address_country_code,
|
100
102
|
'NationalId' => national_id,
|
101
103
|
'DateOfBirth' => date_of_birth,
|
104
|
+
'LastVerifiedDate' => last_verified_date,
|
102
105
|
})
|
103
106
|
payload = @version.fetch('GET', @uri, params: params)
|
104
107
|
PhoneNumberInstance.new(
|
@@ -179,6 +182,7 @@ module Twilio
|
|
179
182
|
'live_activity' => payload['live_activity'],
|
180
183
|
'line_type_intelligence' => payload['line_type_intelligence'],
|
181
184
|
'identity_match' => payload['identity_match'],
|
185
|
+
'reassigned_number' => payload['reassigned_number'],
|
182
186
|
'sms_pumping_risk' => payload['sms_pumping_risk'],
|
183
187
|
'url' => payload['url'],
|
184
188
|
}
|
@@ -271,6 +275,12 @@ module Twilio
|
|
271
275
|
@properties['identity_match']
|
272
276
|
end
|
273
277
|
|
278
|
+
##
|
279
|
+
# @return [Hash] An object that contains reassigned number information. Reassigned Numbers will return a phone number's reassignment status given a phone number and date
|
280
|
+
def reassigned_number
|
281
|
+
@properties['reassigned_number']
|
282
|
+
end
|
283
|
+
|
274
284
|
##
|
275
285
|
# @return [Hash] An object that contains information on if a phone number has been currently or previously blocked by Verify Fraud Guard for receiving malicious SMS pumping traffic as well as other signals associated with risky carriers and low conversion rates.
|
276
286
|
def sms_pumping_risk
|
@@ -285,7 +295,7 @@ module Twilio
|
|
285
295
|
|
286
296
|
##
|
287
297
|
# Fetch the PhoneNumberInstance
|
288
|
-
# @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match.
|
298
|
+
# @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match, reassigned_number.
|
289
299
|
# @param [String] country_code The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.
|
290
300
|
# @param [String] first_name User’s first name. This query parameter is only used (optionally) for identity_match package requests.
|
291
301
|
# @param [String] last_name User’s last name. This query parameter is only used (optionally) for identity_match package requests.
|
@@ -297,6 +307,7 @@ module Twilio
|
|
297
307
|
# @param [String] address_country_code User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests.
|
298
308
|
# @param [String] national_id User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.
|
299
309
|
# @param [String] date_of_birth User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.
|
310
|
+
# @param [String] last_verified_date The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.
|
300
311
|
# @return [PhoneNumberInstance] Fetched PhoneNumberInstance
|
301
312
|
def fetch(
|
302
313
|
fields: :unset,
|
@@ -310,7 +321,8 @@ module Twilio
|
|
310
321
|
postal_code: :unset,
|
311
322
|
address_country_code: :unset,
|
312
323
|
national_id: :unset,
|
313
|
-
date_of_birth: :unset
|
324
|
+
date_of_birth: :unset,
|
325
|
+
last_verified_date: :unset
|
314
326
|
)
|
315
327
|
|
316
328
|
context.fetch(
|
@@ -326,6 +338,7 @@ module Twilio
|
|
326
338
|
address_country_code: address_country_code,
|
327
339
|
national_id: national_id,
|
328
340
|
date_of_birth: date_of_birth,
|
341
|
+
last_verified_date: last_verified_date,
|
329
342
|
)
|
330
343
|
end
|
331
344
|
|