twilio-ruby 6.3.1 → 6.4.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 +19 -0
- data/README.md +2 -2
- data/lib/twilio-ruby/base/client_base.rb +2 -5
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +2 -2
- data/lib/twilio-ruby/rest/chat/v3/channel.rb +3 -3
- data/lib/twilio-ruby/rest/conversations/v1/configuration.rb +3 -3
- data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +4 -4
- data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +12 -12
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +4 -4
- data/lib/twilio-ruby/rest/insights/v1/call_summaries.rb +33 -27
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +20 -20
- data/lib/twilio-ruby/rest/numbers/v1/porting_portability.rb +22 -4
- data/lib/twilio-ruby/rest/supersim/v1/esim_profile.rb +4 -4
- data/lib/twilio-ruby/rest/supersim/v1/ip_command.rb +3 -3
- data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +4 -4
- data/lib/twilio-ruby/rest/wireless/v1/command.rb +5 -5
- data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +7 -7
- data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +3 -3
- data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +3 -3
- data/lib/twilio-ruby/rest/wireless/v1/sim.rb +13 -13
- data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +2 -2
- data/lib/twilio-ruby/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: afa829c42847e0d138f99d520cfe66dadcbf830e
|
4
|
+
data.tar.gz: c37d1272bb38efcd807647e945cf506139eadf09
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e268582e526eaee8cf5e629960c6d410404594385aab32cfb029a6053709d1e498f1b1dfccb8326f295cb29d58eac750db2c40abecd4225033a217b789258930
|
7
|
+
data.tar.gz: 2aeda710a8367dbb7e21ff47c446eaa08e82a883400e3c73a5b843e9bc231ec2419dbaef5ac828f102d6963f6f288a654274571c62dca5c32d75118e4f4e0e7b
|
data/CHANGES.md
CHANGED
@@ -1,6 +1,25 @@
|
|
1
1
|
twilio-ruby changelog
|
2
2
|
=====================
|
3
3
|
|
4
|
+
[2023-08-10] Version 6.4.0
|
5
|
+
--------------------------
|
6
|
+
**Library - Fix**
|
7
|
+
- [PR #673](https://github.com/twilio/twilio-ruby/pull/673): remove ruby version. Thanks to [@kridai](https://github.com/kridai)!
|
8
|
+
- [PR #672](https://github.com/twilio/twilio-ruby/pull/672): revert setting ruby version. Thanks to [@kridai](https://github.com/kridai)!
|
9
|
+
- [PR #671](https://github.com/twilio/twilio-ruby/pull/671): fix the headers issue. Thanks to [@kridai](https://github.com/kridai)!
|
10
|
+
|
11
|
+
**Insights**
|
12
|
+
- Normalize annotations parameters in list summary api to be prefixed
|
13
|
+
|
14
|
+
**Numbers**
|
15
|
+
- Change Bulk_hosted_sid from BHR to BH prefix in HNO and dependent under version `/v2` API's. **(breaking change)**
|
16
|
+
- Added parameter target_account_sid to portability and account_sid to response body
|
17
|
+
|
18
|
+
**Verify**
|
19
|
+
- Remove beta feature flag to list attempts API.
|
20
|
+
- Remove beta feature flag to verifications summary attempts API.
|
21
|
+
|
22
|
+
|
4
23
|
[2023-07-27] Version 6.3.1
|
5
24
|
--------------------------
|
6
25
|
**Api**
|
data/README.md
CHANGED
@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
|
|
39
39
|
To install using [Bundler][bundler] grab the latest stable version:
|
40
40
|
|
41
41
|
```ruby
|
42
|
-
gem 'twilio-ruby', '~> 6.
|
42
|
+
gem 'twilio-ruby', '~> 6.4.0'
|
43
43
|
```
|
44
44
|
|
45
45
|
To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
|
46
46
|
|
47
47
|
```bash
|
48
|
-
gem install twilio-ruby -v 6.
|
48
|
+
gem install twilio-ruby -v 6.4.0
|
49
49
|
```
|
50
50
|
|
51
51
|
To build and install the development branch yourself from the latest source:
|
@@ -27,10 +27,9 @@ module Twilio
|
|
27
27
|
##
|
28
28
|
# Makes a request to the Twilio API using the configured http client
|
29
29
|
# Authentication information is automatically added if none is provided
|
30
|
-
# rubocop:disable Lint/ShadowedArgument
|
31
30
|
def request(host, port, method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil) # rubocop:disable Metrics/MethodLength
|
32
31
|
auth ||= @auth
|
33
|
-
headers = generate_headers(method)
|
32
|
+
headers = generate_headers(method, headers)
|
34
33
|
uri = build_uri(uri)
|
35
34
|
|
36
35
|
if @logger
|
@@ -68,7 +67,6 @@ module Twilio
|
|
68
67
|
|
69
68
|
response
|
70
69
|
end
|
71
|
-
# rubocop:enable Lint/ShadowedArgument
|
72
70
|
|
73
71
|
##
|
74
72
|
# Build the final request uri
|
@@ -105,9 +103,8 @@ module Twilio
|
|
105
103
|
raise RestError.new 'Unexpected response from certificate endpoint', response
|
106
104
|
end
|
107
105
|
|
108
|
-
def generate_headers(method)
|
106
|
+
def generate_headers(method, headers)
|
109
107
|
ruby_config = RbConfig::CONFIG
|
110
|
-
headers = {}
|
111
108
|
headers['User-Agent'] =
|
112
109
|
"twilio-ruby/#{Twilio::VERSION} (#{ruby_config['host_os']} #{ruby_config['host_cpu']}) Ruby/#{RUBY_VERSION}"
|
113
110
|
headers['Accept-Charset'] = 'utf-8'
|
@@ -73,7 +73,7 @@ module Twilio
|
|
73
73
|
# @param [String] call_reason The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)
|
74
74
|
# @param [String] recording_track The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio.
|
75
75
|
# @param [String] time_limit The maximum duration of the call in seconds. Constraints depend on account and configuration.
|
76
|
-
# @param [String] machine_detection Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine.
|
76
|
+
# @param [String] machine_detection Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).
|
77
77
|
# @param [String] machine_detection_timeout The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.
|
78
78
|
# @param [String] machine_detection_speech_threshold The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.
|
79
79
|
# @param [String] machine_detection_speech_end_threshold The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.
|
@@ -34,7 +34,7 @@ module Twilio
|
|
34
34
|
##
|
35
35
|
# Create the MessageInstance
|
36
36
|
# @param [String] to The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/sms/channels#channel-addresses), e.g. `whatsapp:+15552229999`.
|
37
|
-
# @param [String] status_callback The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/
|
37
|
+
# @param [String] status_callback The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api).
|
38
38
|
# @param [String] application_sid The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). If this parameter is provided, the `status_callback` parameter of this request is ignored; [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL.
|
39
39
|
# @param [Float] max_price The maximum price in US dollars that you are willing to pay for this Message's delivery. The value can have up to four decimal places. When the `max_price` parameter is provided, the cost of a message is checked before it is sent. If the cost exceeds `max_price`, the message is not sent and the Message `status` is `failed`.
|
40
40
|
# @param [Boolean] provide_feedback Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the [Message Feedback subresource](https://www.twilio.com/docs/sms/api/message-feedback-resource)). Default value is `false`.
|
@@ -502,7 +502,7 @@ module Twilio
|
|
502
502
|
end
|
503
503
|
|
504
504
|
##
|
505
|
-
# @return [String] The SID of the [Messaging Service](https://www.twilio.com/docs/
|
505
|
+
# @return [String] The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) associated with the Message resource. The value is `null` if a Messaging Service was not used.
|
506
506
|
def messaging_service_sid
|
507
507
|
@properties['messaging_service_sid']
|
508
508
|
end
|
@@ -58,7 +58,7 @@ module Twilio
|
|
58
58
|
##
|
59
59
|
# Update the ChannelInstance
|
60
60
|
# @param [ChannelType] type
|
61
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
61
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this channel belongs to.
|
62
62
|
# @param [ChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
|
63
63
|
# @return [ChannelInstance] Updated ChannelInstance
|
64
64
|
def update(
|
@@ -246,7 +246,7 @@ module Twilio
|
|
246
246
|
end
|
247
247
|
|
248
248
|
##
|
249
|
-
# @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
249
|
+
# @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this channel belongs to.
|
250
250
|
def messaging_service_sid
|
251
251
|
@properties['messaging_service_sid']
|
252
252
|
end
|
@@ -260,7 +260,7 @@ module Twilio
|
|
260
260
|
##
|
261
261
|
# Update the ChannelInstance
|
262
262
|
# @param [ChannelType] type
|
263
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
263
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this channel belongs to.
|
264
264
|
# @param [ChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
|
265
265
|
# @return [ChannelInstance] Updated ChannelInstance
|
266
266
|
def update(
|
@@ -69,7 +69,7 @@ module Twilio
|
|
69
69
|
##
|
70
70
|
# Update the ConfigurationInstance
|
71
71
|
# @param [String] default_chat_service_sid The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
|
72
|
-
# @param [String] default_messaging_service_sid The SID of the default [Messaging Service](https://www.twilio.com/docs/
|
72
|
+
# @param [String] default_messaging_service_sid The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to use when creating a conversation.
|
73
73
|
# @param [String] default_inactive_timer Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
|
74
74
|
# @param [String] default_closed_timer Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
|
75
75
|
# @return [ConfigurationInstance] Updated ConfigurationInstance
|
@@ -200,7 +200,7 @@ module Twilio
|
|
200
200
|
end
|
201
201
|
|
202
202
|
##
|
203
|
-
# @return [String] The SID of the default [Messaging Service](https://www.twilio.com/docs/
|
203
|
+
# @return [String] The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/services/api) used when creating a conversation.
|
204
204
|
def default_messaging_service_sid
|
205
205
|
@properties['default_messaging_service_sid']
|
206
206
|
end
|
@@ -240,7 +240,7 @@ module Twilio
|
|
240
240
|
##
|
241
241
|
# Update the ConfigurationInstance
|
242
242
|
# @param [String] default_chat_service_sid The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
|
243
|
-
# @param [String] default_messaging_service_sid The SID of the default [Messaging Service](https://www.twilio.com/docs/
|
243
|
+
# @param [String] default_messaging_service_sid The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to use when creating a conversation.
|
244
244
|
# @param [String] default_inactive_timer Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
|
245
245
|
# @param [String] default_closed_timer Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
|
246
246
|
# @return [ConfigurationInstance] Updated ConfigurationInstance
|
@@ -35,7 +35,7 @@ module Twilio
|
|
35
35
|
# @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
|
36
36
|
# @param [Time] date_created The date that this resource was created.
|
37
37
|
# @param [Time] date_updated The date that this resource was last updated.
|
38
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
38
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
39
39
|
# @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned.
|
40
40
|
# @param [State] state
|
41
41
|
# @param [String] timers_inactive ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
|
@@ -236,7 +236,7 @@ module Twilio
|
|
236
236
|
# @param [Time] date_created The date that this resource was created.
|
237
237
|
# @param [Time] date_updated The date that this resource was last updated.
|
238
238
|
# @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned.
|
239
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
239
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
240
240
|
# @param [State] state
|
241
241
|
# @param [String] timers_inactive ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
|
242
242
|
# @param [String] timers_closed ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
|
@@ -438,7 +438,7 @@ module Twilio
|
|
438
438
|
end
|
439
439
|
|
440
440
|
##
|
441
|
-
# @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
441
|
+
# @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
442
442
|
def messaging_service_sid
|
443
443
|
@properties['messaging_service_sid']
|
444
444
|
end
|
@@ -536,7 +536,7 @@ module Twilio
|
|
536
536
|
# @param [Time] date_created The date that this resource was created.
|
537
537
|
# @param [Time] date_updated The date that this resource was last updated.
|
538
538
|
# @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned.
|
539
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
539
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
540
540
|
# @param [State] state
|
541
541
|
# @param [String] timers_inactive ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
|
542
542
|
# @param [String] timers_closed ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
|
@@ -73,10 +73,10 @@ module Twilio
|
|
73
73
|
|
74
74
|
##
|
75
75
|
# Update the ConfigurationInstance
|
76
|
-
# @param [String] default_conversation_creator_role_sid The conversation-level role assigned to a conversation creator when they join a new conversation. See
|
77
|
-
# @param [String] default_conversation_role_sid The conversation-level role assigned to users when they are added to a conversation. See
|
78
|
-
# @param [String] default_chat_service_role_sid The service-level role assigned to users when they are added to the service. See
|
79
|
-
# @param [Boolean] reachability_enabled Whether the [Reachability Indicator](https://www.twilio.com/docs/
|
76
|
+
# @param [String] default_conversation_creator_role_sid The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
77
|
+
# @param [String] default_conversation_role_sid The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
78
|
+
# @param [String] default_chat_service_role_sid The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
79
|
+
# @param [Boolean] reachability_enabled Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`.
|
80
80
|
# @return [ConfigurationInstance] Updated ConfigurationInstance
|
81
81
|
def update(
|
82
82
|
default_conversation_creator_role_sid: :unset,
|
@@ -211,19 +211,19 @@ module Twilio
|
|
211
211
|
end
|
212
212
|
|
213
213
|
##
|
214
|
-
# @return [String] The conversation-level role assigned to a conversation creator
|
214
|
+
# @return [String] The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
215
215
|
def default_conversation_creator_role_sid
|
216
216
|
@properties['default_conversation_creator_role_sid']
|
217
217
|
end
|
218
218
|
|
219
219
|
##
|
220
|
-
# @return [String] The conversation-level role assigned to users when they are added to a conversation. See
|
220
|
+
# @return [String] The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
221
221
|
def default_conversation_role_sid
|
222
222
|
@properties['default_conversation_role_sid']
|
223
223
|
end
|
224
224
|
|
225
225
|
##
|
226
|
-
# @return [String] The service-level role assigned to users when they are added to the service. See
|
226
|
+
# @return [String] The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
227
227
|
def default_chat_service_role_sid
|
228
228
|
@properties['default_chat_service_role_sid']
|
229
229
|
end
|
@@ -241,7 +241,7 @@ module Twilio
|
|
241
241
|
end
|
242
242
|
|
243
243
|
##
|
244
|
-
# @return [Boolean] Whether the [Reachability Indicator](https://www.twilio.com/docs/
|
244
|
+
# @return [Boolean] Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`.
|
245
245
|
def reachability_enabled
|
246
246
|
@properties['reachability_enabled']
|
247
247
|
end
|
@@ -256,10 +256,10 @@ module Twilio
|
|
256
256
|
|
257
257
|
##
|
258
258
|
# Update the ConfigurationInstance
|
259
|
-
# @param [String] default_conversation_creator_role_sid The conversation-level role assigned to a conversation creator when they join a new conversation. See
|
260
|
-
# @param [String] default_conversation_role_sid The conversation-level role assigned to users when they are added to a conversation. See
|
261
|
-
# @param [String] default_chat_service_role_sid The service-level role assigned to users when they are added to the service. See
|
262
|
-
# @param [Boolean] reachability_enabled Whether the [Reachability Indicator](https://www.twilio.com/docs/
|
259
|
+
# @param [String] default_conversation_creator_role_sid The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
260
|
+
# @param [String] default_conversation_role_sid The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
261
|
+
# @param [String] default_chat_service_role_sid The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.
|
262
|
+
# @param [Boolean] reachability_enabled Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`.
|
263
263
|
# @return [ConfigurationInstance] Updated ConfigurationInstance
|
264
264
|
def update(
|
265
265
|
default_conversation_creator_role_sid: :unset,
|
@@ -36,7 +36,7 @@ module Twilio
|
|
36
36
|
# @param [String] friendly_name The human-readable name of this conversation, limited to 256 characters. Optional.
|
37
37
|
# @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
|
38
38
|
# @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned.
|
39
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
39
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
40
40
|
# @param [Time] date_created The date that this resource was created.
|
41
41
|
# @param [Time] date_updated The date that this resource was last updated.
|
42
42
|
# @param [State] state
|
@@ -241,7 +241,7 @@ module Twilio
|
|
241
241
|
# @param [Time] date_created The date that this resource was created.
|
242
242
|
# @param [Time] date_updated The date that this resource was last updated.
|
243
243
|
# @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned.
|
244
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
244
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
245
245
|
# @param [State] state
|
246
246
|
# @param [String] timers_inactive ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
|
247
247
|
# @param [String] timers_closed ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
|
@@ -444,7 +444,7 @@ module Twilio
|
|
444
444
|
end
|
445
445
|
|
446
446
|
##
|
447
|
-
# @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
447
|
+
# @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
448
448
|
def messaging_service_sid
|
449
449
|
@properties['messaging_service_sid']
|
450
450
|
end
|
@@ -542,7 +542,7 @@ module Twilio
|
|
542
542
|
# @param [Time] date_created The date that this resource was created.
|
543
543
|
# @param [Time] date_updated The date that this resource was last updated.
|
544
544
|
# @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned.
|
545
|
-
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/
|
545
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) this conversation belongs to.
|
546
546
|
# @param [State] state
|
547
547
|
# @param [String] timers_inactive ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
|
548
548
|
# @param [String] timers_closed ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
|
@@ -53,10 +53,11 @@ module Twilio
|
|
53
53
|
# @param [String] subaccount A unique SID identifier of a Subaccount.
|
54
54
|
# @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
|
55
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]
|
57
|
-
# @param [String]
|
58
|
-
# @param [
|
59
|
-
# @param [
|
56
|
+
# @param [String] answered_by_annotation Either machine or human.
|
57
|
+
# @param [String] connectivity_issue_annotation A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
|
58
|
+
# @param [String] quality_issue_annotation A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
|
59
|
+
# @param [Boolean] spam_annotation A boolean flag indicating spam calls.
|
60
|
+
# @param [String] call_score_annotation 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
61
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
61
62
|
# guarantees to never return more than limit. Default is no limit
|
62
63
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -64,7 +65,7 @@ module Twilio
|
|
64
65
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
65
66
|
# efficient page size, i.e. min(limit, 1000)
|
66
67
|
# @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,
|
68
|
+
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, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, limit: nil, page_size: nil)
|
68
69
|
self.stream(
|
69
70
|
from: from,
|
70
71
|
to: to,
|
@@ -85,10 +86,11 @@ module Twilio
|
|
85
86
|
subaccount: subaccount,
|
86
87
|
abnormal_session: abnormal_session,
|
87
88
|
answered_by: answered_by,
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
89
|
+
answered_by_annotation: answered_by_annotation,
|
90
|
+
connectivity_issue_annotation: connectivity_issue_annotation,
|
91
|
+
quality_issue_annotation: quality_issue_annotation,
|
92
|
+
spam_annotation: spam_annotation,
|
93
|
+
call_score_annotation: call_score_annotation,
|
92
94
|
limit: limit,
|
93
95
|
page_size: page_size
|
94
96
|
).entries
|
@@ -117,10 +119,11 @@ module Twilio
|
|
117
119
|
# @param [String] subaccount A unique SID identifier of a Subaccount.
|
118
120
|
# @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
|
119
121
|
# @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]
|
121
|
-
# @param [String]
|
122
|
-
# @param [
|
123
|
-
# @param [
|
122
|
+
# @param [String] answered_by_annotation Either machine or human.
|
123
|
+
# @param [String] connectivity_issue_annotation A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
|
124
|
+
# @param [String] quality_issue_annotation A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
|
125
|
+
# @param [Boolean] spam_annotation A boolean flag indicating spam calls.
|
126
|
+
# @param [String] call_score_annotation 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
127
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
125
128
|
# guarantees to never return more than limit. Default is no limit
|
126
129
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -128,7 +131,7 @@ module Twilio
|
|
128
131
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
129
132
|
# efficient page size, i.e. min(limit, 1000)
|
130
133
|
# @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,
|
134
|
+
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, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, limit: nil, page_size: nil)
|
132
135
|
limits = @version.read_limits(limit, page_size)
|
133
136
|
|
134
137
|
page = self.page(
|
@@ -151,10 +154,11 @@ module Twilio
|
|
151
154
|
subaccount: subaccount,
|
152
155
|
abnormal_session: abnormal_session,
|
153
156
|
answered_by: answered_by,
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
157
|
+
answered_by_annotation: answered_by_annotation,
|
158
|
+
connectivity_issue_annotation: connectivity_issue_annotation,
|
159
|
+
quality_issue_annotation: quality_issue_annotation,
|
160
|
+
spam_annotation: spam_annotation,
|
161
|
+
call_score_annotation: call_score_annotation,
|
158
162
|
page_size: limits[:page_size], )
|
159
163
|
|
160
164
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
@@ -196,15 +200,16 @@ module Twilio
|
|
196
200
|
# @param [String] subaccount A unique SID identifier of a Subaccount.
|
197
201
|
# @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
|
198
202
|
# @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]
|
200
|
-
# @param [String]
|
201
|
-
# @param [
|
202
|
-
# @param [
|
203
|
+
# @param [String] answered_by_annotation Either machine or human.
|
204
|
+
# @param [String] connectivity_issue_annotation A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
|
205
|
+
# @param [String] quality_issue_annotation A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
|
206
|
+
# @param [Boolean] spam_annotation A boolean flag indicating spam calls.
|
207
|
+
# @param [String] call_score_annotation 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
208
|
# @param [String] page_token PageToken provided by the API
|
204
209
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
205
210
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
206
211
|
# @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,
|
212
|
+
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, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
208
213
|
params = Twilio::Values.of({
|
209
214
|
'From' => from,
|
210
215
|
'To' => to,
|
@@ -225,10 +230,11 @@ module Twilio
|
|
225
230
|
'Subaccount' => subaccount,
|
226
231
|
'AbnormalSession' => abnormal_session,
|
227
232
|
'AnsweredBy' => answered_by,
|
228
|
-
'
|
229
|
-
'
|
230
|
-
'
|
231
|
-
'
|
233
|
+
'AnsweredByAnnotation' => answered_by_annotation,
|
234
|
+
'ConnectivityIssueAnnotation' => connectivity_issue_annotation,
|
235
|
+
'QualityIssueAnnotation' => quality_issue_annotation,
|
236
|
+
'SpamAnnotation' => spam_annotation,
|
237
|
+
'CallScoreAnnotation' => call_score_annotation,
|
232
238
|
'PageToken' => page_token,
|
233
239
|
'Page' => page_number,
|
234
240
|
'PageSize' => page_size,
|
@@ -37,12 +37,12 @@ module Twilio
|
|
37
37
|
# @param [String] fallback_url The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
|
38
38
|
# @param [String] fallback_method The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
|
39
39
|
# @param [String] status_callback The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
|
40
|
-
# @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/
|
41
|
-
# @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/
|
42
|
-
# @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/
|
40
|
+
# @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance.
|
41
|
+
# @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance.
|
42
|
+
# @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance.
|
43
43
|
# @param [ScanMessageContent] scan_message_content
|
44
|
-
# @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/
|
45
|
-
# @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/
|
44
|
+
# @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/messaging/services#fallback-to-long-code) for messages sent through the Service instance.
|
45
|
+
# @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance.
|
46
46
|
# @param [String] validity_period How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
|
47
47
|
# @param [Boolean] synchronous_validation Reserved.
|
48
48
|
# @param [String] usecase A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..].
|
@@ -238,12 +238,12 @@ module Twilio
|
|
238
238
|
# @param [String] fallback_url The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
|
239
239
|
# @param [String] fallback_method The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
|
240
240
|
# @param [String] status_callback The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
|
241
|
-
# @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/
|
242
|
-
# @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/
|
243
|
-
# @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/
|
241
|
+
# @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance.
|
242
|
+
# @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance.
|
243
|
+
# @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance.
|
244
244
|
# @param [ScanMessageContent] scan_message_content
|
245
|
-
# @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/
|
246
|
-
# @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/
|
245
|
+
# @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/messaging/services#fallback-to-long-code) for messages sent through the Service instance.
|
246
|
+
# @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance.
|
247
247
|
# @param [String] validity_period How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
|
248
248
|
# @param [Boolean] synchronous_validation Reserved.
|
249
249
|
# @param [String] usecase A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]
|
@@ -543,19 +543,19 @@ module Twilio
|
|
543
543
|
end
|
544
544
|
|
545
545
|
##
|
546
|
-
# @return [Boolean] Whether to enable [Sticky Sender](https://www.twilio.com/docs/
|
546
|
+
# @return [Boolean] Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance.
|
547
547
|
def sticky_sender
|
548
548
|
@properties['sticky_sender']
|
549
549
|
end
|
550
550
|
|
551
551
|
##
|
552
|
-
# @return [Boolean] Whether to enable the [MMS Converter](https://www.twilio.com/docs/
|
552
|
+
# @return [Boolean] Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance.
|
553
553
|
def mms_converter
|
554
554
|
@properties['mms_converter']
|
555
555
|
end
|
556
556
|
|
557
557
|
##
|
558
|
-
# @return [Boolean] Whether to enable [Smart Encoding](https://www.twilio.com/docs/
|
558
|
+
# @return [Boolean] Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance.
|
559
559
|
def smart_encoding
|
560
560
|
@properties['smart_encoding']
|
561
561
|
end
|
@@ -567,13 +567,13 @@ module Twilio
|
|
567
567
|
end
|
568
568
|
|
569
569
|
##
|
570
|
-
# @return [Boolean] Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/
|
570
|
+
# @return [Boolean] Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/messaging/services#fallback-to-long-code) for messages sent through the Service instance.
|
571
571
|
def fallback_to_long_code
|
572
572
|
@properties['fallback_to_long_code']
|
573
573
|
end
|
574
574
|
|
575
575
|
##
|
576
|
-
# @return [Boolean] Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/
|
576
|
+
# @return [Boolean] Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance.
|
577
577
|
def area_code_geomatch
|
578
578
|
@properties['area_code_geomatch']
|
579
579
|
end
|
@@ -644,12 +644,12 @@ module Twilio
|
|
644
644
|
# @param [String] fallback_url The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
|
645
645
|
# @param [String] fallback_method The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
|
646
646
|
# @param [String] status_callback The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
|
647
|
-
# @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/
|
648
|
-
# @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/
|
649
|
-
# @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/
|
647
|
+
# @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance.
|
648
|
+
# @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance.
|
649
|
+
# @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance.
|
650
650
|
# @param [ScanMessageContent] scan_message_content
|
651
|
-
# @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/
|
652
|
-
# @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/
|
651
|
+
# @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/messaging/services#fallback-to-long-code) for messages sent through the Service instance.
|
652
|
+
# @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance.
|
653
653
|
# @param [String] validity_period How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
|
654
654
|
# @param [Boolean] synchronous_validation Reserved.
|
655
655
|
# @param [String] usecase A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]
|
@@ -58,10 +58,16 @@ module Twilio
|
|
58
58
|
end
|
59
59
|
##
|
60
60
|
# Fetch the PortingPortabilityInstance
|
61
|
+
# @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
|
61
62
|
# @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
|
62
|
-
def fetch
|
63
|
+
def fetch(
|
64
|
+
target_account_sid: :unset
|
65
|
+
)
|
63
66
|
|
64
|
-
|
67
|
+
params = Twilio::Values.of({
|
68
|
+
'TargetAccountSid' => target_account_sid,
|
69
|
+
})
|
70
|
+
payload = @version.fetch('GET', @uri, params: params)
|
65
71
|
PortingPortabilityInstance.new(
|
66
72
|
@version,
|
67
73
|
payload,
|
@@ -129,6 +135,7 @@ module Twilio
|
|
129
135
|
# Marshaled Properties
|
130
136
|
@properties = {
|
131
137
|
'phone_number' => payload['phone_number'],
|
138
|
+
'account_sid' => payload['account_sid'],
|
132
139
|
'portable' => payload['portable'],
|
133
140
|
'pin_and_account_number_required' => payload['pin_and_account_number_required'],
|
134
141
|
'not_portable_reason' => payload['not_portable_reason'],
|
@@ -162,6 +169,12 @@ module Twilio
|
|
162
169
|
@properties['phone_number']
|
163
170
|
end
|
164
171
|
|
172
|
+
##
|
173
|
+
# @return [String] The target account sid to which the number will be ported
|
174
|
+
def account_sid
|
175
|
+
@properties['account_sid']
|
176
|
+
end
|
177
|
+
|
165
178
|
##
|
166
179
|
# @return [Boolean] Boolean flag specifying if phone number is portable or not.
|
167
180
|
def portable
|
@@ -218,10 +231,15 @@ module Twilio
|
|
218
231
|
|
219
232
|
##
|
220
233
|
# Fetch the PortingPortabilityInstance
|
234
|
+
# @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
|
221
235
|
# @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
|
222
|
-
def fetch
|
236
|
+
def fetch(
|
237
|
+
target_account_sid: :unset
|
238
|
+
)
|
223
239
|
|
224
|
-
context.fetch
|
240
|
+
context.fetch(
|
241
|
+
target_account_sid: target_account_sid,
|
242
|
+
)
|
225
243
|
end
|
226
244
|
|
227
245
|
##
|
@@ -63,7 +63,7 @@ module Twilio
|
|
63
63
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
64
64
|
# memory before returning.
|
65
65
|
# @param [String] eid List the eSIM Profiles that have been associated with an EId.
|
66
|
-
# @param [String] sim_sid Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
|
66
|
+
# @param [String] sim_sid Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
|
67
67
|
# @param [Status] status List the eSIM Profiles that are in a given status.
|
68
68
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
69
69
|
# guarantees to never return more than limit. Default is no limit
|
@@ -87,7 +87,7 @@ module Twilio
|
|
87
87
|
# This operation lazily loads records as efficiently as possible until the limit
|
88
88
|
# is reached.
|
89
89
|
# @param [String] eid List the eSIM Profiles that have been associated with an EId.
|
90
|
-
# @param [String] sim_sid Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
|
90
|
+
# @param [String] sim_sid Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
|
91
91
|
# @param [Status] status List the eSIM Profiles that are in a given status.
|
92
92
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
93
93
|
# guarantees to never return more than limit. Default is no limit
|
@@ -126,7 +126,7 @@ module Twilio
|
|
126
126
|
# Retrieve a single page of EsimProfileInstance records from the API.
|
127
127
|
# Request is executed immediately.
|
128
128
|
# @param [String] eid List the eSIM Profiles that have been associated with an EId.
|
129
|
-
# @param [String] sim_sid Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
|
129
|
+
# @param [String] sim_sid Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
|
130
130
|
# @param [Status] status List the eSIM Profiles that are in a given status.
|
131
131
|
# @param [String] page_token PageToken provided by the API
|
132
132
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
@@ -309,7 +309,7 @@ module Twilio
|
|
309
309
|
end
|
310
310
|
|
311
311
|
##
|
312
|
-
# @return [String] The SID of the [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) resource that this eSIM Profile controls.
|
312
|
+
# @return [String] The SID of the [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource that this eSIM Profile controls.
|
313
313
|
def sim_sid
|
314
314
|
@properties['sim_sid']
|
315
315
|
end
|
@@ -70,7 +70,7 @@ module Twilio
|
|
70
70
|
# memory before returning.
|
71
71
|
# @param [String] sim The SID or unique name of the Sim resource that IP Command was sent to or from.
|
72
72
|
# @param [String] sim_iccid The ICCID of the Sim resource that IP Command was sent to or from.
|
73
|
-
# @param [Status] status The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/
|
73
|
+
# @param [Status] status The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.
|
74
74
|
# @param [Direction] direction The direction of the IP Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
|
75
75
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
76
76
|
# guarantees to never return more than limit. Default is no limit
|
@@ -96,7 +96,7 @@ module Twilio
|
|
96
96
|
# is reached.
|
97
97
|
# @param [String] sim The SID or unique name of the Sim resource that IP Command was sent to or from.
|
98
98
|
# @param [String] sim_iccid The ICCID of the Sim resource that IP Command was sent to or from.
|
99
|
-
# @param [Status] status The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/
|
99
|
+
# @param [Status] status The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.
|
100
100
|
# @param [Direction] direction The direction of the IP Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
|
101
101
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
102
102
|
# guarantees to never return more than limit. Default is no limit
|
@@ -137,7 +137,7 @@ module Twilio
|
|
137
137
|
# Request is executed immediately.
|
138
138
|
# @param [String] sim The SID or unique name of the Sim resource that IP Command was sent to or from.
|
139
139
|
# @param [String] sim_iccid The ICCID of the Sim resource that IP Command was sent to or from.
|
140
|
-
# @param [Status] status The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/
|
140
|
+
# @param [Status] status The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.
|
141
141
|
# @param [Direction] direction The direction of the IP Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
|
142
142
|
# @param [String] page_token PageToken provided by the API
|
143
143
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
@@ -34,7 +34,7 @@ module Twilio
|
|
34
34
|
##
|
35
35
|
# Create the MessagingConfigurationInstance
|
36
36
|
# @param [String] country The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
|
37
|
-
# @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/
|
37
|
+
# @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to be used to send SMS to the country of this configuration.
|
38
38
|
# @return [MessagingConfigurationInstance] Created MessagingConfigurationInstance
|
39
39
|
def create(
|
40
40
|
country: nil,
|
@@ -188,7 +188,7 @@ module Twilio
|
|
188
188
|
|
189
189
|
##
|
190
190
|
# Update the MessagingConfigurationInstance
|
191
|
-
# @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/
|
191
|
+
# @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to be used to send SMS to the country of this configuration.
|
192
192
|
# @return [MessagingConfigurationInstance] Updated MessagingConfigurationInstance
|
193
193
|
def update(
|
194
194
|
messaging_service_sid: nil
|
@@ -310,7 +310,7 @@ module Twilio
|
|
310
310
|
end
|
311
311
|
|
312
312
|
##
|
313
|
-
# @return [String] The SID of the [Messaging Service](https://www.twilio.com/docs/
|
313
|
+
# @return [String] The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to be used to send SMS to the country of this configuration.
|
314
314
|
def messaging_service_sid
|
315
315
|
@properties['messaging_service_sid']
|
316
316
|
end
|
@@ -351,7 +351,7 @@ module Twilio
|
|
351
351
|
|
352
352
|
##
|
353
353
|
# Update the MessagingConfigurationInstance
|
354
|
-
# @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/
|
354
|
+
# @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to be used to send SMS to the country of this configuration.
|
355
355
|
# @return [MessagingConfigurationInstance] Updated MessagingConfigurationInstance
|
356
356
|
def update(
|
357
357
|
messaging_service_sid: nil
|
@@ -32,7 +32,7 @@ module Twilio
|
|
32
32
|
##
|
33
33
|
# Create the CommandInstance
|
34
34
|
# @param [String] command The message body of the Command. Can be plain text in text mode or a Base64 encoded byte string in binary mode.
|
35
|
-
# @param [String] sim The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command to.
|
35
|
+
# @param [String] sim The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to send the Command to.
|
36
36
|
# @param [String] callback_method The HTTP method we use to call `callback_url`. Can be: `POST` or `GET`, and the default is `POST`.
|
37
37
|
# @param [String] callback_url The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed.
|
38
38
|
# @param [CommandMode] command_mode
|
@@ -71,7 +71,7 @@ module Twilio
|
|
71
71
|
# Lists CommandInstance records from the API as a list.
|
72
72
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
73
73
|
# memory before returning.
|
74
|
-
# @param [String] sim The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.
|
74
|
+
# @param [String] sim The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read.
|
75
75
|
# @param [Status] status The status of the resources to read. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`.
|
76
76
|
# @param [Direction] direction Only return Commands with this direction value.
|
77
77
|
# @param [Transport] transport Only return Commands with this transport value. Can be: `sms` or `ip`.
|
@@ -97,7 +97,7 @@ module Twilio
|
|
97
97
|
# Streams Instance records from the API as an Enumerable.
|
98
98
|
# This operation lazily loads records as efficiently as possible until the limit
|
99
99
|
# is reached.
|
100
|
-
# @param [String] sim The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.
|
100
|
+
# @param [String] sim The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read.
|
101
101
|
# @param [Status] status The status of the resources to read. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`.
|
102
102
|
# @param [Direction] direction Only return Commands with this direction value.
|
103
103
|
# @param [Transport] transport Only return Commands with this transport value. Can be: `sms` or `ip`.
|
@@ -138,7 +138,7 @@ module Twilio
|
|
138
138
|
##
|
139
139
|
# Retrieve a single page of CommandInstance records from the API.
|
140
140
|
# Request is executed immediately.
|
141
|
-
# @param [String] sim The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.
|
141
|
+
# @param [String] sim The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read.
|
142
142
|
# @param [Status] status The status of the resources to read. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`.
|
143
143
|
# @param [Direction] direction Only return Commands with this direction value.
|
144
144
|
# @param [Transport] transport Only return Commands with this transport value. Can be: `sms` or `ip`.
|
@@ -322,7 +322,7 @@ module Twilio
|
|
322
322
|
end
|
323
323
|
|
324
324
|
##
|
325
|
-
# @return [String] The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Command was sent to or from.
|
325
|
+
# @return [String] The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Command was sent to or from.
|
326
326
|
def sim_sid
|
327
327
|
@properties['sim_sid']
|
328
328
|
end
|
@@ -35,12 +35,12 @@ module Twilio
|
|
35
35
|
# @param [String] friendly_name A descriptive string that you create to describe the resource. It does not have to be unique.
|
36
36
|
# @param [Boolean] data_enabled Whether SIMs can use GPRS/3G/4G/LTE data connectivity.
|
37
37
|
# @param [String] data_limit The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB and the default value is `1000`.
|
38
|
-
# @param [String] data_metering The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).
|
39
|
-
# @param [Boolean] messaging_enabled Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource).
|
38
|
+
# @param [String] data_metering The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).
|
39
|
+
# @param [Boolean] messaging_enabled Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource).
|
40
40
|
# @param [Boolean] voice_enabled Deprecated.
|
41
|
-
# @param [Boolean] national_roaming_enabled Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming).
|
41
|
+
# @param [Boolean] national_roaming_enabled Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming).
|
42
42
|
# @param [Array[String]] international_roaming The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: `data` and `messaging`.
|
43
|
-
# @param [String] national_roaming_data_limit The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming) for more info.
|
43
|
+
# @param [String] national_roaming_data_limit The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming) for more info.
|
44
44
|
# @param [String] international_roaming_data_limit The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB.
|
45
45
|
# @return [RatePlanInstance] Created RatePlanInstance
|
46
46
|
def create(
|
@@ -355,7 +355,7 @@ module Twilio
|
|
355
355
|
end
|
356
356
|
|
357
357
|
##
|
358
|
-
# @return [String] The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).
|
358
|
+
# @return [String] The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).
|
359
359
|
def data_metering
|
360
360
|
@properties['data_metering']
|
361
361
|
end
|
@@ -367,7 +367,7 @@ module Twilio
|
|
367
367
|
end
|
368
368
|
|
369
369
|
##
|
370
|
-
# @return [Boolean] Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource).
|
370
|
+
# @return [Boolean] Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource).
|
371
371
|
def messaging_enabled
|
372
372
|
@properties['messaging_enabled']
|
373
373
|
end
|
@@ -379,7 +379,7 @@ module Twilio
|
|
379
379
|
end
|
380
380
|
|
381
381
|
##
|
382
|
-
# @return [Boolean] Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming).
|
382
|
+
# @return [Boolean] Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming).
|
383
383
|
def national_roaming_enabled
|
384
384
|
@properties['national_roaming_enabled']
|
385
385
|
end
|
@@ -194,7 +194,7 @@ module Twilio
|
|
194
194
|
end
|
195
195
|
|
196
196
|
##
|
197
|
-
# @return [String] The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data Session is for.
|
197
|
+
# @return [String] The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Data Session is for.
|
198
198
|
def sim_sid
|
199
199
|
@properties['sim_sid']
|
200
200
|
end
|
@@ -230,7 +230,7 @@ module Twilio
|
|
230
230
|
end
|
231
231
|
|
232
232
|
##
|
233
|
-
# @return [String] The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the `operator_mnc`.
|
233
|
+
# @return [String] The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the `operator_mnc`.
|
234
234
|
def operator_name
|
235
235
|
@properties['operator_name']
|
236
236
|
end
|
@@ -242,7 +242,7 @@ module Twilio
|
|
242
242
|
end
|
243
243
|
|
244
244
|
##
|
245
|
-
# @return [Hash] An object that describes the estimated location in latitude and longitude where the device's Data Session took place. The location is derived from the `cell_id` when the Data Session was last updated. See [Cell Location Estimate Object](https://www.twilio.com/docs/wireless/api/datasession-resource#cell-location-estimate-object).
|
245
|
+
# @return [Hash] An object that describes the estimated location in latitude and longitude where the device's Data Session took place. The location is derived from the `cell_id` when the Data Session was last updated. See [Cell Location Estimate Object](https://www.twilio.com/docs/iot/wireless/api/datasession-resource#cell-location-estimate-object).
|
246
246
|
def cell_location_estimate
|
247
247
|
@properties['cell_location_estimate']
|
248
248
|
end
|
@@ -195,7 +195,7 @@ module Twilio
|
|
195
195
|
|
196
196
|
|
197
197
|
##
|
198
|
-
# @return [String] The SID of the [Sim resource](https://www.twilio.com/docs/wireless/api/sim-resource) that this Usage Record is for.
|
198
|
+
# @return [String] The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that this Usage Record is for.
|
199
199
|
def sim_sid
|
200
200
|
@properties['sim_sid']
|
201
201
|
end
|
@@ -213,13 +213,13 @@ module Twilio
|
|
213
213
|
end
|
214
214
|
|
215
215
|
##
|
216
|
-
# @return [Hash] An object that describes the SIM's usage of Commands during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#commands-usage-object).
|
216
|
+
# @return [Hash] An object that describes the SIM's usage of Commands during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#commands-usage-object).
|
217
217
|
def commands
|
218
218
|
@properties['commands']
|
219
219
|
end
|
220
220
|
|
221
221
|
##
|
222
|
-
# @return [Hash] An object that describes the SIM's data usage during the specified period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/sim-usagerecord-resource#data-usage-object).
|
222
|
+
# @return [Hash] An object that describes the SIM's data usage during the specified period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#data-usage-object).
|
223
223
|
def data
|
224
224
|
@properties['data']
|
225
225
|
end
|
@@ -36,7 +36,7 @@ module Twilio
|
|
36
36
|
# memory before returning.
|
37
37
|
# @param [Status] status Only return Sim resources with this status.
|
38
38
|
# @param [String] iccid Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.
|
39
|
-
# @param [String] rate_plan The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
|
39
|
+
# @param [String] rate_plan The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
|
40
40
|
# @param [String] e_id Deprecated.
|
41
41
|
# @param [String] sim_registration_code Only return Sim resources with this registration code. This will return a list with a maximum size of 1.
|
42
42
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
@@ -64,7 +64,7 @@ module Twilio
|
|
64
64
|
# is reached.
|
65
65
|
# @param [Status] status Only return Sim resources with this status.
|
66
66
|
# @param [String] iccid Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.
|
67
|
-
# @param [String] rate_plan The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
|
67
|
+
# @param [String] rate_plan The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
|
68
68
|
# @param [String] e_id Deprecated.
|
69
69
|
# @param [String] sim_registration_code Only return Sim resources with this registration code. This will return a list with a maximum size of 1.
|
70
70
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
@@ -107,7 +107,7 @@ module Twilio
|
|
107
107
|
# Request is executed immediately.
|
108
108
|
# @param [Status] status Only return Sim resources with this status.
|
109
109
|
# @param [String] iccid Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.
|
110
|
-
# @param [String] rate_plan The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
|
110
|
+
# @param [String] rate_plan The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.
|
111
111
|
# @param [String] e_id Deprecated.
|
112
112
|
# @param [String] sim_registration_code Only return Sim resources with this registration code. This will return a list with a maximum size of 1.
|
113
113
|
# @param [String] page_token PageToken provided by the API
|
@@ -197,20 +197,20 @@ module Twilio
|
|
197
197
|
# @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `POST` or `GET`. The default is `POST`.
|
198
198
|
# @param [String] callback_url The URL we should call using the `callback_url` when the SIM has finished updating. When the SIM transitions from `new` to `ready` or from any status to `deactivated`, we call this URL when the status changes to an intermediate status (`ready` or `deactivated`) and again when the status changes to its final status (`active` or `canceled`).
|
199
199
|
# @param [String] friendly_name A descriptive string that you create to describe the Sim resource. It does not need to be unique.
|
200
|
-
# @param [String] rate_plan The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which the Sim resource should be assigned.
|
200
|
+
# @param [String] rate_plan The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource should be assigned.
|
201
201
|
# @param [Status] status
|
202
202
|
# @param [String] commands_callback_method The HTTP method we should use to call `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.
|
203
|
-
# @param [String] commands_callback_url The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.
|
203
|
+
# @param [String] commands_callback_url The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.
|
204
204
|
# @param [String] sms_fallback_method The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.
|
205
205
|
# @param [String] sms_fallback_url The URL we should call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `sms_url`.
|
206
206
|
# @param [String] sms_method The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. Default is `POST`.
|
207
|
-
# @param [String] sms_url The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/wireless/api/command-resource).
|
207
|
+
# @param [String] sms_url The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource).
|
208
208
|
# @param [String] voice_fallback_method Deprecated.
|
209
209
|
# @param [String] voice_fallback_url Deprecated.
|
210
210
|
# @param [String] voice_method Deprecated.
|
211
211
|
# @param [String] voice_url Deprecated.
|
212
212
|
# @param [ResetStatus] reset_status
|
213
|
-
# @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts).
|
213
|
+
# @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/iot/wireless/api/sim-resource#move-sims-between-subaccounts).
|
214
214
|
# @return [SimInstance] Updated SimInstance
|
215
215
|
def update(
|
216
216
|
unique_name: :unset,
|
@@ -404,7 +404,7 @@ module Twilio
|
|
404
404
|
end
|
405
405
|
|
406
406
|
##
|
407
|
-
# @return [String] The SID of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which the Sim resource is assigned.
|
407
|
+
# @return [String] The SID of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource is assigned.
|
408
408
|
def rate_plan_sid
|
409
409
|
@properties['rate_plan_sid']
|
410
410
|
end
|
@@ -440,7 +440,7 @@ module Twilio
|
|
440
440
|
end
|
441
441
|
|
442
442
|
##
|
443
|
-
# @return [String] The URL we call using the `commands_callback_method` when the SIM originates a machine-to-machine [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
|
443
|
+
# @return [String] The URL we call using the `commands_callback_method` when the SIM originates a machine-to-machine [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
|
444
444
|
def commands_callback_url
|
445
445
|
@properties['commands_callback_url']
|
446
446
|
end
|
@@ -551,20 +551,20 @@ module Twilio
|
|
551
551
|
# @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `POST` or `GET`. The default is `POST`.
|
552
552
|
# @param [String] callback_url The URL we should call using the `callback_url` when the SIM has finished updating. When the SIM transitions from `new` to `ready` or from any status to `deactivated`, we call this URL when the status changes to an intermediate status (`ready` or `deactivated`) and again when the status changes to its final status (`active` or `canceled`).
|
553
553
|
# @param [String] friendly_name A descriptive string that you create to describe the Sim resource. It does not need to be unique.
|
554
|
-
# @param [String] rate_plan The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which the Sim resource should be assigned.
|
554
|
+
# @param [String] rate_plan The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource should be assigned.
|
555
555
|
# @param [Status] status
|
556
556
|
# @param [String] commands_callback_method The HTTP method we should use to call `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.
|
557
|
-
# @param [String] commands_callback_url The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.
|
557
|
+
# @param [String] commands_callback_url The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.
|
558
558
|
# @param [String] sms_fallback_method The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.
|
559
559
|
# @param [String] sms_fallback_url The URL we should call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `sms_url`.
|
560
560
|
# @param [String] sms_method The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. Default is `POST`.
|
561
|
-
# @param [String] sms_url The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/wireless/api/command-resource).
|
561
|
+
# @param [String] sms_url The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource).
|
562
562
|
# @param [String] voice_fallback_method Deprecated.
|
563
563
|
# @param [String] voice_fallback_url Deprecated.
|
564
564
|
# @param [String] voice_method Deprecated.
|
565
565
|
# @param [String] voice_url Deprecated.
|
566
566
|
# @param [ResetStatus] reset_status
|
567
|
-
# @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts).
|
567
|
+
# @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/iot/wireless/api/sim-resource#move-sims-between-subaccounts).
|
568
568
|
# @return [SimInstance] Updated SimInstance
|
569
569
|
def update(
|
570
570
|
unique_name: :unset,
|
@@ -204,13 +204,13 @@ module Twilio
|
|
204
204
|
end
|
205
205
|
|
206
206
|
##
|
207
|
-
# @return [Hash] An object that describes the aggregated Commands usage for all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/wireless/api/account-usagerecord-resource#commands-usage-object).
|
207
|
+
# @return [Hash] An object that describes the aggregated Commands usage for all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#commands-usage-object).
|
208
208
|
def commands
|
209
209
|
@properties['commands']
|
210
210
|
end
|
211
211
|
|
212
212
|
##
|
213
|
-
# @return [Hash] An object that describes the aggregated Data usage for all SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/wireless/api/account-usagerecord-resource#data-usage-object).
|
213
|
+
# @return [Hash] An object that describes the aggregated Data usage for all SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#data-usage-object).
|
214
214
|
def data
|
215
215
|
@properties['data']
|
216
216
|
end
|
data/lib/twilio-ruby/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: twilio-ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 6.
|
4
|
+
version: 6.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Twilio API Team
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-08-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jwt
|