twilio-ruby 5.26.0 → 5.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/.travis.yml +5 -6
- data/CHANGES.md +21 -0
- data/README.md +28 -19
- data/VERSIONS.md +9 -10
- data/lib/twilio-ruby.rb +4 -2
- data/lib/twilio-ruby/framework/domain.rb +1 -1
- data/lib/twilio-ruby/http/http_client.rb +9 -3
- data/lib/twilio-ruby/rest/api/v2010/account/address.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/application.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +6 -6
- data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +6 -6
- data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +5 -5
- data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +5 -5
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +4 -4
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +4 -4
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/key.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +6 -6
- data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +3 -5
- data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +5 -5
- data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +6 -6
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/token.rb +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +3 -3
- data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +10 -10
- data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +2 -2
- data/lib/twilio-ruby/rest/authy/v1/service/entity/factor/challenge.rb +1 -1
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +1 -1
- data/lib/twilio-ruby/rest/chat/v2/service.rb +12 -6
- data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +12 -12
- data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +6 -6
- data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +17 -16
- data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +35 -35
- data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +6 -6
- data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +6 -6
- data/lib/twilio-ruby/rest/chat/v2/service/role.rb +8 -8
- data/lib/twilio-ruby/rest/chat/v2/service/user.rb +16 -12
- data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +12 -12
- data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +13 -11
- data/lib/twilio-ruby/rest/client.rb +2 -2
- data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +4 -4
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +4 -4
- data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +4 -4
- data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +4 -4
- data/lib/twilio-ruby/rest/conversations/v1/webhook.rb +4 -4
- data/lib/twilio-ruby/rest/fax/v1/fax.rb +11 -5
- data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +12 -6
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +12 -12
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +6 -6
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +17 -16
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +35 -35
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +6 -6
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +6 -6
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +8 -8
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +16 -12
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +12 -12
- data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +13 -11
- data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +5 -5
- data/lib/twilio-ruby/rest/monitor/v1.rb +1 -1
- data/lib/twilio-ruby/rest/monitor/v1/alert.rb +16 -16
- data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +1 -1
- data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +1 -1
- data/lib/twilio-ruby/security/request_validator.rb +1 -1
- data/lib/twilio-ruby/util/configuration.rb +10 -5
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/http/http_client_spec.rb +2 -2
- data/spec/integration/lookups/v1/phone_number_spec.rb +1 -1
- data/spec/integration/monitor/v1/alert_spec.rb +5 -28
- data/spec/integration/pricing/v1/voice/number_spec.rb +1 -1
- data/spec/integration/pricing/v2/voice/number_spec.rb +1 -1
- data/spec/rest/client_spec.rb +22 -0
- data/spec/twilio_spec.rb +3 -1
- data/spec/util/configuration_spec.rb +6 -0
- metadata +4 -3
|
@@ -161,13 +161,15 @@ module Twilio
|
|
|
161
161
|
# [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the
|
|
162
162
|
# recipient's SIP URI.
|
|
163
163
|
# @param [String] media_url The Twilio-hosted URL of the PDF that contains the
|
|
164
|
-
# fax. See our [security](https://www.twilio.com/docs/security) page for
|
|
164
|
+
# fax. See our [security](https://www.twilio.com/docs/usage/security) page for
|
|
165
165
|
# information on how to ensure the request for your media comes from Twilio.
|
|
166
166
|
# @param [fax.Quality] quality The [Fax Quality
|
|
167
|
-
# value](https://www.twilio.com/docs/
|
|
167
|
+
# value](https://www.twilio.com/docs/fax/api/faxes-resource#fax-quality-values)
|
|
168
|
+
# that describes the fax quality. Can be: `standard`, `fine`, or `superfine` and
|
|
169
|
+
# defaults to `fine`.
|
|
168
170
|
# @param [String] status_callback The URL we should call using the `POST` method
|
|
169
171
|
# to send [status
|
|
170
|
-
# information](https://www.twilio.com/docs/
|
|
172
|
+
# information](https://www.twilio.com/docs/fax/api/faxes-resource#fax-status-callback) to your application when the status of the fax changes.
|
|
171
173
|
# @param [String] from The number the fax was sent from. Can be the phone number
|
|
172
174
|
# in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the SIP
|
|
173
175
|
# `from` value. The caller ID displayed to the recipient uses this value. If this
|
|
@@ -283,7 +285,9 @@ module Twilio
|
|
|
283
285
|
##
|
|
284
286
|
# Update the FaxInstance
|
|
285
287
|
# @param [fax.UpdateStatus] status The new
|
|
286
|
-
# [status](https://www.twilio.com/docs/
|
|
288
|
+
# [status](https://www.twilio.com/docs/fax/api/faxes-resource#fax-status-values)
|
|
289
|
+
# of the resource. Can be only `canceled`. This may fail if transmission has
|
|
290
|
+
# already started.
|
|
287
291
|
# @return [FaxInstance] Updated FaxInstance
|
|
288
292
|
def update(status: :unset)
|
|
289
293
|
data = Twilio::Values.of({'Status' => status, })
|
|
@@ -506,7 +510,9 @@ module Twilio
|
|
|
506
510
|
##
|
|
507
511
|
# Update the FaxInstance
|
|
508
512
|
# @param [fax.UpdateStatus] status The new
|
|
509
|
-
# [status](https://www.twilio.com/docs/
|
|
513
|
+
# [status](https://www.twilio.com/docs/fax/api/faxes-resource#fax-status-values)
|
|
514
|
+
# of the resource. Can be only `canceled`. This may fail if transmission has
|
|
515
|
+
# already started.
|
|
510
516
|
# @return [FaxInstance] Updated FaxInstance
|
|
511
517
|
def update(status: :unset)
|
|
512
518
|
context.update(status: status, )
|
|
@@ -207,13 +207,16 @@ module Twilio
|
|
|
207
207
|
# the resource.
|
|
208
208
|
# @param [String] default_service_role_sid The service role assigned to users when
|
|
209
209
|
# they are added to the service. See the [Role
|
|
210
|
-
# resource](https://www.twilio.com/docs/chat/
|
|
210
|
+
# resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
|
|
211
|
+
# about roles.
|
|
211
212
|
# @param [String] default_channel_role_sid The channel role assigned to users when
|
|
212
213
|
# they are added to a channel. See the [Role
|
|
213
|
-
# resource](https://www.twilio.com/docs/chat/
|
|
214
|
+
# resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
|
|
215
|
+
# about roles.
|
|
214
216
|
# @param [String] default_channel_creator_role_sid The channel role assigned to a
|
|
215
217
|
# channel creator when they join a new channel. See the [Role
|
|
216
|
-
# resource](https://www.twilio.com/docs/chat/
|
|
218
|
+
# resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
|
|
219
|
+
# about roles.
|
|
217
220
|
# @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
|
|
218
221
|
# Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
|
|
219
222
|
# default is `true`.
|
|
@@ -632,13 +635,16 @@ module Twilio
|
|
|
632
635
|
# the resource.
|
|
633
636
|
# @param [String] default_service_role_sid The service role assigned to users when
|
|
634
637
|
# they are added to the service. See the [Role
|
|
635
|
-
# resource](https://www.twilio.com/docs/chat/
|
|
638
|
+
# resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
|
|
639
|
+
# about roles.
|
|
636
640
|
# @param [String] default_channel_role_sid The channel role assigned to users when
|
|
637
641
|
# they are added to a channel. See the [Role
|
|
638
|
-
# resource](https://www.twilio.com/docs/chat/
|
|
642
|
+
# resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
|
|
643
|
+
# about roles.
|
|
639
644
|
# @param [String] default_channel_creator_role_sid The channel role assigned to a
|
|
640
645
|
# channel creator when they join a new channel. See the [Role
|
|
641
|
-
# resource](https://www.twilio.com/docs/chat/
|
|
646
|
+
# resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
|
|
647
|
+
# about roles.
|
|
642
648
|
# @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
|
|
643
649
|
# Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
|
|
644
650
|
# default is `true`.
|
|
@@ -16,8 +16,8 @@ module Twilio
|
|
|
16
16
|
# Initialize the BindingList
|
|
17
17
|
# @param [Version] version Version that contains the resource
|
|
18
18
|
# @param [String] service_sid The SID of the
|
|
19
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
20
|
-
# is associated with.
|
|
19
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding
|
|
20
|
+
# resource is associated with.
|
|
21
21
|
# @return [BindingList] BindingList
|
|
22
22
|
def initialize(version, service_sid: nil)
|
|
23
23
|
super(version)
|
|
@@ -37,8 +37,8 @@ module Twilio
|
|
|
37
37
|
# configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
|
|
38
38
|
# for more info.
|
|
39
39
|
# @param [String] identity The
|
|
40
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
41
|
-
# resources to read. See [access
|
|
40
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
41
|
+
# of the resources to read. See [access
|
|
42
42
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
43
43
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
44
44
|
# guarantees to never return more than limit. Default is no limit
|
|
@@ -66,8 +66,8 @@ module Twilio
|
|
|
66
66
|
# configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
|
|
67
67
|
# for more info.
|
|
68
68
|
# @param [String] identity The
|
|
69
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
70
|
-
# resources to read. See [access
|
|
69
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
70
|
+
# of the resources to read. See [access
|
|
71
71
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
72
72
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
73
73
|
# guarantees to never return more than limit. Default is no limit.
|
|
@@ -107,8 +107,8 @@ module Twilio
|
|
|
107
107
|
# configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
|
|
108
108
|
# for more info.
|
|
109
109
|
# @param [String] identity The
|
|
110
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
111
|
-
# resources to read. See [access
|
|
110
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
111
|
+
# of the resources to read. See [access
|
|
112
112
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
113
113
|
# @param [String] page_token PageToken provided by the API
|
|
114
114
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
@@ -184,8 +184,8 @@ module Twilio
|
|
|
184
184
|
# Initialize the BindingContext
|
|
185
185
|
# @param [Version] version Version that contains the resource
|
|
186
186
|
# @param [String] service_sid The SID of the
|
|
187
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
188
|
-
# resource from.
|
|
187
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
|
|
188
|
+
# Binding resource from.
|
|
189
189
|
# @param [String] sid The SID of the Binding resource to fetch.
|
|
190
190
|
# @return [BindingContext] BindingContext
|
|
191
191
|
def initialize(version, service_sid, sid)
|
|
@@ -239,8 +239,8 @@ module Twilio
|
|
|
239
239
|
# @param [Version] version Version that contains the resource
|
|
240
240
|
# @param [Hash] payload payload that contains response from Twilio
|
|
241
241
|
# @param [String] service_sid The SID of the
|
|
242
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
243
|
-
# is associated with.
|
|
242
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding
|
|
243
|
+
# resource is associated with.
|
|
244
244
|
# @param [String] sid The SID of the Binding resource to fetch.
|
|
245
245
|
# @return [BindingInstance] BindingInstance
|
|
246
246
|
def initialize(version, payload, service_sid: nil, sid: nil)
|
|
@@ -16,8 +16,8 @@ module Twilio
|
|
|
16
16
|
# Initialize the ChannelList
|
|
17
17
|
# @param [Version] version Version that contains the resource
|
|
18
18
|
# @param [String] service_sid The SID of the
|
|
19
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
20
|
-
# is associated with.
|
|
19
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel
|
|
20
|
+
# resource is associated with.
|
|
21
21
|
# @return [ChannelList] ChannelList
|
|
22
22
|
def initialize(version, service_sid: nil)
|
|
23
23
|
super(version)
|
|
@@ -203,8 +203,8 @@ module Twilio
|
|
|
203
203
|
# Initialize the ChannelContext
|
|
204
204
|
# @param [Version] version Version that contains the resource
|
|
205
205
|
# @param [String] service_sid The SID of the
|
|
206
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
207
|
-
# resource from.
|
|
206
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
|
|
207
|
+
# Channel resource from.
|
|
208
208
|
# @param [String] sid The SID of the Channel resource to fetch. This value can be
|
|
209
209
|
# either the `sid` or the `unique_name` of the Channel resource to fetch.
|
|
210
210
|
# @return [ChannelContext] ChannelContext
|
|
@@ -393,8 +393,8 @@ module Twilio
|
|
|
393
393
|
# @param [Version] version Version that contains the resource
|
|
394
394
|
# @param [Hash] payload payload that contains response from Twilio
|
|
395
395
|
# @param [String] service_sid The SID of the
|
|
396
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
397
|
-
# is associated with.
|
|
396
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel
|
|
397
|
+
# resource is associated with.
|
|
398
398
|
# @param [String] sid The SID of the Channel resource to fetch. This value can be
|
|
399
399
|
# either the `sid` or the `unique_name` of the Channel resource to fetch.
|
|
400
400
|
# @return [ChannelInstance] ChannelInstance
|
|
@@ -17,8 +17,8 @@ module Twilio
|
|
|
17
17
|
# Initialize the InviteList
|
|
18
18
|
# @param [Version] version Version that contains the resource
|
|
19
19
|
# @param [String] service_sid The SID of the
|
|
20
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
21
|
-
# associated with.
|
|
20
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite
|
|
21
|
+
# resource is associated with.
|
|
22
22
|
# @param [String] channel_sid The SID of the
|
|
23
23
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs
|
|
24
24
|
# to.
|
|
@@ -35,11 +35,12 @@ module Twilio
|
|
|
35
35
|
# Retrieve a single page of InviteInstance records from the API.
|
|
36
36
|
# Request is executed immediately.
|
|
37
37
|
# @param [String] identity The `identity` value that uniquely identifies the new
|
|
38
|
-
# resource's [User](https://www.twilio.com/docs/chat/rest/
|
|
39
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
40
|
-
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
|
|
38
|
+
# resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within
|
|
39
|
+
# the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See
|
|
40
|
+
# [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
|
|
41
41
|
# @param [String] role_sid The SID of the
|
|
42
|
-
# [Role](https://www.twilio.com/docs/chat/rest/
|
|
42
|
+
# [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the new
|
|
43
|
+
# member.
|
|
43
44
|
# @return [InviteInstance] Newly created InviteInstance
|
|
44
45
|
def create(identity: nil, role_sid: :unset)
|
|
45
46
|
data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
|
|
@@ -63,8 +64,8 @@ module Twilio
|
|
|
63
64
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
64
65
|
# memory before returning.
|
|
65
66
|
# @param [String] identity The
|
|
66
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
67
|
-
# resources to read. See [access
|
|
67
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
68
|
+
# of the resources to read. See [access
|
|
68
69
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
69
70
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
70
71
|
# guarantees to never return more than limit. Default is no limit
|
|
@@ -82,8 +83,8 @@ module Twilio
|
|
|
82
83
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
83
84
|
# is reached.
|
|
84
85
|
# @param [String] identity The
|
|
85
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
86
|
-
# resources to read. See [access
|
|
86
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
87
|
+
# of the resources to read. See [access
|
|
87
88
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
88
89
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
89
90
|
# guarantees to never return more than limit. Default is no limit.
|
|
@@ -118,8 +119,8 @@ module Twilio
|
|
|
118
119
|
# Retrieve a single page of InviteInstance records from the API.
|
|
119
120
|
# Request is executed immediately.
|
|
120
121
|
# @param [String] identity The
|
|
121
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
122
|
-
# resources to read. See [access
|
|
122
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
123
|
+
# of the resources to read. See [access
|
|
123
124
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
124
125
|
# @param [String] page_token PageToken provided by the API
|
|
125
126
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
@@ -199,8 +200,8 @@ module Twilio
|
|
|
199
200
|
# Initialize the InviteContext
|
|
200
201
|
# @param [Version] version Version that contains the resource
|
|
201
202
|
# @param [String] service_sid The SID of the
|
|
202
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
203
|
-
# resource from.
|
|
203
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
|
|
204
|
+
# Invite resource from.
|
|
204
205
|
# @param [String] channel_sid The SID of the
|
|
205
206
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to
|
|
206
207
|
# fetch belongs to. This value can be the Channel resource's `sid` or
|
|
@@ -264,8 +265,8 @@ module Twilio
|
|
|
264
265
|
# @param [Version] version Version that contains the resource
|
|
265
266
|
# @param [Hash] payload payload that contains response from Twilio
|
|
266
267
|
# @param [String] service_sid The SID of the
|
|
267
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
268
|
-
# associated with.
|
|
268
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite
|
|
269
|
+
# resource is associated with.
|
|
269
270
|
# @param [String] channel_sid The SID of the
|
|
270
271
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs
|
|
271
272
|
# to.
|
|
@@ -17,8 +17,8 @@ module Twilio
|
|
|
17
17
|
# Initialize the MemberList
|
|
18
18
|
# @param [Version] version Version that contains the resource
|
|
19
19
|
# @param [String] service_sid The SID of the
|
|
20
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
21
|
-
# associated with.
|
|
20
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member
|
|
21
|
+
# resource is associated with.
|
|
22
22
|
# @param [String] channel_sid The SID of the
|
|
23
23
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs
|
|
24
24
|
# to.
|
|
@@ -35,22 +35,22 @@ module Twilio
|
|
|
35
35
|
# Retrieve a single page of MemberInstance records from the API.
|
|
36
36
|
# Request is executed immediately.
|
|
37
37
|
# @param [String] identity The `identity` value that uniquely identifies the new
|
|
38
|
-
# resource's [User](https://www.twilio.com/docs/chat/rest/
|
|
39
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
40
|
-
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
|
|
38
|
+
# resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within
|
|
39
|
+
# the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See
|
|
40
|
+
# [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
|
|
41
41
|
# @param [String] role_sid The SID of the
|
|
42
|
-
# [Role](https://www.twilio.com/docs/chat/rest/
|
|
43
|
-
# default roles are those specified on the
|
|
44
|
-
# [Service](https://www.twilio.com/docs/chat/
|
|
42
|
+
# [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
|
|
43
|
+
# member. The default roles are those specified on the
|
|
44
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource).
|
|
45
45
|
# @param [String] last_consumed_message_index The index of the last
|
|
46
|
-
# [Message](https://www.twilio.com/docs/chat/rest/
|
|
46
|
+
# [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the
|
|
47
47
|
# [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
|
|
48
48
|
# This parameter should only be used when recreating a Member from a
|
|
49
49
|
# backup/separate source.
|
|
50
50
|
# @param [Time] last_consumption_timestamp The [ISO
|
|
51
51
|
# 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last
|
|
52
|
-
# [Message](https://www.twilio.com/docs/chat/rest/
|
|
53
|
-
# Member within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
52
|
+
# [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for
|
|
53
|
+
# the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
54
54
|
# @param [Time] date_created The date, specified in [ISO
|
|
55
55
|
# 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
|
|
56
56
|
# as the date it was created. The default value is the current time set by the
|
|
@@ -94,8 +94,8 @@ module Twilio
|
|
|
94
94
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
95
95
|
# memory before returning.
|
|
96
96
|
# @param [String] identity The
|
|
97
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
98
|
-
# Member resources to read. See [access
|
|
97
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
98
|
+
# of the Member resources to read. See [access
|
|
99
99
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
100
100
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
101
101
|
# guarantees to never return more than limit. Default is no limit
|
|
@@ -113,8 +113,8 @@ module Twilio
|
|
|
113
113
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
114
114
|
# is reached.
|
|
115
115
|
# @param [String] identity The
|
|
116
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
117
|
-
# Member resources to read. See [access
|
|
116
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
117
|
+
# of the Member resources to read. See [access
|
|
118
118
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
119
119
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
120
120
|
# guarantees to never return more than limit. Default is no limit.
|
|
@@ -149,8 +149,8 @@ module Twilio
|
|
|
149
149
|
# Retrieve a single page of MemberInstance records from the API.
|
|
150
150
|
# Request is executed immediately.
|
|
151
151
|
# @param [String] identity The
|
|
152
|
-
# [User](https://www.twilio.com/docs/chat/rest/
|
|
153
|
-
# Member resources to read. See [access
|
|
152
|
+
# [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
|
|
153
|
+
# of the Member resources to read. See [access
|
|
154
154
|
# tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
|
|
155
155
|
# @param [String] page_token PageToken provided by the API
|
|
156
156
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
@@ -230,8 +230,8 @@ module Twilio
|
|
|
230
230
|
# Initialize the MemberContext
|
|
231
231
|
# @param [Version] version Version that contains the resource
|
|
232
232
|
# @param [String] service_sid The SID of the
|
|
233
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
234
|
-
# resource from.
|
|
233
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
|
|
234
|
+
# Member resource from.
|
|
235
235
|
# @param [String] channel_sid The SID of the
|
|
236
236
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to
|
|
237
237
|
# fetch belongs to. This value can be the Channel resource's `sid` or
|
|
@@ -278,16 +278,16 @@ module Twilio
|
|
|
278
278
|
##
|
|
279
279
|
# Update the MemberInstance
|
|
280
280
|
# @param [String] role_sid The SID of the
|
|
281
|
-
# [Role](https://www.twilio.com/docs/chat/rest/
|
|
282
|
-
# default roles are those specified on the
|
|
283
|
-
# [Service](https://www.twilio.com/docs/chat/
|
|
281
|
+
# [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
|
|
282
|
+
# member. The default roles are those specified on the
|
|
283
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource).
|
|
284
284
|
# @param [String] last_consumed_message_index The index of the last
|
|
285
|
-
# [Message](https://www.twilio.com/docs/chat/rest/
|
|
286
|
-
# read within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
285
|
+
# [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the
|
|
286
|
+
# Member has read within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
287
287
|
# @param [Time] last_consumption_timestamp The [ISO
|
|
288
288
|
# 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last
|
|
289
|
-
# [Message](https://www.twilio.com/docs/chat/rest/
|
|
290
|
-
# Member within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
289
|
+
# [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for
|
|
290
|
+
# the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
291
291
|
# @param [Time] date_created The date, specified in [ISO
|
|
292
292
|
# 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
|
|
293
293
|
# as the date it was created. The default value is the current time set by the
|
|
@@ -345,8 +345,8 @@ module Twilio
|
|
|
345
345
|
# @param [Version] version Version that contains the resource
|
|
346
346
|
# @param [Hash] payload payload that contains response from Twilio
|
|
347
347
|
# @param [String] service_sid The SID of the
|
|
348
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
349
|
-
# associated with.
|
|
348
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member
|
|
349
|
+
# resource is associated with.
|
|
350
350
|
# @param [String] channel_sid The SID of the
|
|
351
351
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs
|
|
352
352
|
# to.
|
|
@@ -486,16 +486,16 @@ module Twilio
|
|
|
486
486
|
##
|
|
487
487
|
# Update the MemberInstance
|
|
488
488
|
# @param [String] role_sid The SID of the
|
|
489
|
-
# [Role](https://www.twilio.com/docs/chat/rest/
|
|
490
|
-
# default roles are those specified on the
|
|
491
|
-
# [Service](https://www.twilio.com/docs/chat/
|
|
489
|
+
# [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
|
|
490
|
+
# member. The default roles are those specified on the
|
|
491
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource).
|
|
492
492
|
# @param [String] last_consumed_message_index The index of the last
|
|
493
|
-
# [Message](https://www.twilio.com/docs/chat/rest/
|
|
494
|
-
# read within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
493
|
+
# [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the
|
|
494
|
+
# Member has read within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
495
495
|
# @param [Time] last_consumption_timestamp The [ISO
|
|
496
496
|
# 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last
|
|
497
|
-
# [Message](https://www.twilio.com/docs/chat/rest/
|
|
498
|
-
# Member within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
497
|
+
# [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for
|
|
498
|
+
# the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
|
|
499
499
|
# @param [Time] date_created The date, specified in [ISO
|
|
500
500
|
# 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
|
|
501
501
|
# as the date it was created. The default value is the current time set by the
|
|
@@ -17,8 +17,8 @@ module Twilio
|
|
|
17
17
|
# Initialize the MessageList
|
|
18
18
|
# @param [Version] version Version that contains the resource
|
|
19
19
|
# @param [String] service_sid The SID of the
|
|
20
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
21
|
-
# is associated with.
|
|
20
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message
|
|
21
|
+
# resource is associated with.
|
|
22
22
|
# @param [String] channel_sid The SID of the
|
|
23
23
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
|
|
24
24
|
# belongs to.
|
|
@@ -216,8 +216,8 @@ module Twilio
|
|
|
216
216
|
# Initialize the MessageContext
|
|
217
217
|
# @param [Version] version Version that contains the resource
|
|
218
218
|
# @param [String] service_sid The SID of the
|
|
219
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
220
|
-
# resource from.
|
|
219
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
|
|
220
|
+
# Message resource from.
|
|
221
221
|
# @param [String] channel_sid The SID of the
|
|
222
222
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to
|
|
223
223
|
# fetch belongs to. This value can be the Channel resource's `sid` or
|
|
@@ -327,8 +327,8 @@ module Twilio
|
|
|
327
327
|
# @param [Version] version Version that contains the resource
|
|
328
328
|
# @param [Hash] payload payload that contains response from Twilio
|
|
329
329
|
# @param [String] service_sid The SID of the
|
|
330
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
331
|
-
# is associated with.
|
|
330
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message
|
|
331
|
+
# resource is associated with.
|
|
332
332
|
# @param [String] channel_sid The SID of the
|
|
333
333
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
|
|
334
334
|
# belongs to.
|
|
@@ -17,8 +17,8 @@ module Twilio
|
|
|
17
17
|
# Initialize the WebhookList
|
|
18
18
|
# @param [Version] version Version that contains the resource
|
|
19
19
|
# @param [String] service_sid The SID of the
|
|
20
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
21
|
-
# resource is associated with.
|
|
20
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel
|
|
21
|
+
# Webhook resource is associated with.
|
|
22
22
|
# @param [String] channel_sid The SID of the
|
|
23
23
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
|
|
24
24
|
# resource belongs to.
|
|
@@ -209,8 +209,8 @@ module Twilio
|
|
|
209
209
|
# Initialize the WebhookContext
|
|
210
210
|
# @param [Version] version Version that contains the resource
|
|
211
211
|
# @param [String] service_sid The SID of the
|
|
212
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
213
|
-
# fetch the Webhook resource from.
|
|
212
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the
|
|
213
|
+
# Channel to fetch the Webhook resource from.
|
|
214
214
|
# @param [String] channel_sid The SID of the
|
|
215
215
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
|
|
216
216
|
# resource to fetch belongs to. This value can be the Channel resource's `sid` or
|
|
@@ -321,8 +321,8 @@ module Twilio
|
|
|
321
321
|
# @param [Version] version Version that contains the resource
|
|
322
322
|
# @param [Hash] payload payload that contains response from Twilio
|
|
323
323
|
# @param [String] service_sid The SID of the
|
|
324
|
-
# [Service](https://www.twilio.com/docs/chat/rest/
|
|
325
|
-
# resource is associated with.
|
|
324
|
+
# [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel
|
|
325
|
+
# Webhook resource is associated with.
|
|
326
326
|
# @param [String] channel_sid The SID of the
|
|
327
327
|
# [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
|
|
328
328
|
# resource belongs to.
|