twilio-ruby 5.41.0 → 5.42.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (81) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +28 -0
  3. data/{LICENSE.md → LICENSE} +0 -0
  4. data/PULL_REQUEST_TEMPLATE.md +3 -3
  5. data/README.md +2 -2
  6. data/lib/twilio-ruby/jwt/access_token.rb +7 -2
  7. data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +5 -22
  8. data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb +25 -40
  9. data/lib/twilio-ruby/rest/insights.rb +8 -0
  10. data/lib/twilio-ruby/rest/insights/v1.rb +15 -0
  11. data/lib/twilio-ruby/rest/insights/v1/room.rb +487 -0
  12. data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +385 -0
  13. data/lib/twilio-ruby/rest/ip_messaging.rb +8 -10
  14. data/lib/twilio-ruby/rest/ip_messaging/v1.rb +6 -8
  15. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +29 -68
  16. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +198 -313
  17. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +32 -59
  18. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +23 -55
  19. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +28 -71
  20. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +31 -59
  21. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +19 -39
  22. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +29 -51
  23. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +12 -18
  24. data/lib/twilio-ruby/rest/ip_messaging/v2.rb +6 -6
  25. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +29 -66
  26. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +116 -205
  27. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +23 -50
  28. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +41 -91
  29. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +23 -50
  30. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +42 -118
  31. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +46 -100
  32. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +36 -89
  33. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +19 -41
  34. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +29 -53
  35. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +23 -53
  36. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +27 -56
  37. data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb +5 -22
  38. data/lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb +21 -39
  39. data/lib/twilio-ruby/rest/verify/v2/form.rb +4 -4
  40. data/lib/twilio-ruby/rest/verify/v2/service/access_token.rb +3 -3
  41. data/lib/twilio-ruby/rest/verify/v2/service/entity.rb +20 -34
  42. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +22 -46
  43. data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +24 -42
  44. data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb +4 -4
  45. data/lib/twilio-ruby/rest/video/v1/room.rb +20 -0
  46. data/lib/twilio-ruby/rest/video/v1/room/room_recording_rule.rb +150 -0
  47. data/lib/twilio-ruby/version.rb +1 -1
  48. data/spec/integration/bulkexports/v1/export/export_custom_job_spec.rb +4 -2
  49. data/spec/integration/events/v1/sink/sink_test_spec.rb +1 -1
  50. data/spec/integration/insights/v1/room/participant_spec.rb +149 -0
  51. data/spec/integration/insights/v1/room_spec.rb +164 -0
  52. data/spec/integration/ip_messaging/v1/credential_spec.rb +13 -13
  53. data/spec/integration/ip_messaging/v1/service/channel/invite_spec.rb +11 -11
  54. data/spec/integration/ip_messaging/v1/service/channel/member_spec.rb +14 -14
  55. data/spec/integration/ip_messaging/v1/service/channel/message_spec.rb +14 -14
  56. data/spec/integration/ip_messaging/v1/service/channel_spec.rb +25 -25
  57. data/spec/integration/ip_messaging/v1/service/role_spec.rb +13 -13
  58. data/spec/integration/ip_messaging/v1/service/user/user_channel_spec.rb +7 -7
  59. data/spec/integration/ip_messaging/v1/service/user_spec.rb +17 -17
  60. data/spec/integration/ip_messaging/v1/service_spec.rb +9 -9
  61. data/spec/integration/ip_messaging/v2/credential_spec.rb +13 -13
  62. data/spec/integration/ip_messaging/v2/service/binding_spec.rb +11 -11
  63. data/spec/integration/ip_messaging/v2/service/channel/invite_spec.rb +11 -11
  64. data/spec/integration/ip_messaging/v2/service/channel/member_spec.rb +13 -13
  65. data/spec/integration/ip_messaging/v2/service/channel/message_spec.rb +17 -17
  66. data/spec/integration/ip_messaging/v2/service/channel/webhook_spec.rb +15 -15
  67. data/spec/integration/ip_messaging/v2/service/channel_spec.rb +29 -29
  68. data/spec/integration/ip_messaging/v2/service/role_spec.rb +13 -13
  69. data/spec/integration/ip_messaging/v2/service/user/user_binding_spec.rb +9 -9
  70. data/spec/integration/ip_messaging/v2/service/user/user_channel_spec.rb +20 -20
  71. data/spec/integration/ip_messaging/v2/service/user_spec.rb +21 -21
  72. data/spec/integration/ip_messaging/v2/service_spec.rb +29 -29
  73. data/spec/integration/preview/bulk_exports/export/export_custom_job_spec.rb +4 -2
  74. data/spec/integration/verify/v2/service/entity/challenge_spec.rb +4 -12
  75. data/spec/integration/verify/v2/service/entity/factor_spec.rb +5 -15
  76. data/spec/integration/verify/v2/service/entity_spec.rb +4 -12
  77. data/spec/integration/video/v1/room/room_recording_rule_spec.rb +89 -0
  78. data/spec/integration/video/v1/room_spec.rb +10 -5
  79. data/spec/jwt/access_token_spec.rb +9 -1
  80. data/twilio-ruby.gemspec +1 -1
  81. metadata +13 -4
@@ -16,11 +16,8 @@ module Twilio
16
16
  ##
17
17
  # Initialize the UserChannelList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] service_sid The SID of the
20
- # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
21
- # associated with.
22
- # @param [String] user_sid The unique string that we created to identify the User
23
- # resource.
19
+ # @param [String] service_sid The service_sid
20
+ # @param [String] user_sid The sid
24
21
  # @return [UserChannelList] UserChannelList
25
22
  def initialize(version, service_sid: nil, user_sid: nil)
26
23
  super(version)
@@ -156,11 +153,8 @@ module Twilio
156
153
  # Initialize the UserChannelInstance
157
154
  # @param [Version] version Version that contains the resource
158
155
  # @param [Hash] payload payload that contains response from Twilio
159
- # @param [String] service_sid The SID of the
160
- # {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
161
- # associated with.
162
- # @param [String] user_sid The unique string that we created to identify the User
163
- # resource.
156
+ # @param [String] service_sid The service_sid
157
+ # @param [String] user_sid The sid
164
158
  # @return [UserChannelInstance] UserChannelInstance
165
159
  def initialize(version, payload, service_sid: nil, user_sid: nil)
166
160
  super(version)
@@ -179,49 +173,49 @@ module Twilio
179
173
  end
180
174
 
181
175
  ##
182
- # @return [String] The SID of the Account that created the resource
176
+ # @return [String] The account_sid
183
177
  def account_sid
184
178
  @properties['account_sid']
185
179
  end
186
180
 
187
181
  ##
188
- # @return [String] The SID of the Service that the resource is associated with
182
+ # @return [String] The service_sid
189
183
  def service_sid
190
184
  @properties['service_sid']
191
185
  end
192
186
 
193
187
  ##
194
- # @return [String] The SID of the Channel the resource belongs to
188
+ # @return [String] The channel_sid
195
189
  def channel_sid
196
190
  @properties['channel_sid']
197
191
  end
198
192
 
199
193
  ##
200
- # @return [String] The SID of the User as a Member in the Channel
194
+ # @return [String] The member_sid
201
195
  def member_sid
202
196
  @properties['member_sid']
203
197
  end
204
198
 
205
199
  ##
206
- # @return [user_channel.ChannelStatus] The status of the User on the Channel
200
+ # @return [user_channel.ChannelStatus] The status
207
201
  def status
208
202
  @properties['status']
209
203
  end
210
204
 
211
205
  ##
212
- # @return [String] The index of the last Message in the Channel the Member has read
206
+ # @return [String] The last_consumed_message_index
213
207
  def last_consumed_message_index
214
208
  @properties['last_consumed_message_index']
215
209
  end
216
210
 
217
211
  ##
218
- # @return [String] The number of unread Messages in the Channel for the User
212
+ # @return [String] The unread_messages_count
219
213
  def unread_messages_count
220
214
  @properties['unread_messages_count']
221
215
  end
222
216
 
223
217
  ##
224
- # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
218
+ # @return [String] The links
225
219
  def links
226
220
  @properties['links']
227
221
  end
@@ -20,9 +20,9 @@ module Twilio
20
20
  end
21
21
 
22
22
  ##
23
- # @param [String] sid The SID of the Credential resource to fetch.
24
- # @return [Twilio::REST::Chat::V2::CredentialContext] if sid was passed.
25
- # @return [Twilio::REST::Chat::V2::CredentialList]
23
+ # @param [String] sid The sid
24
+ # @return [Twilio::REST::Ip_messaging::V2::CredentialContext] if sid was passed.
25
+ # @return [Twilio::REST::Ip_messaging::V2::CredentialList]
26
26
  def credentials(sid=:unset)
27
27
  if sid.nil?
28
28
  raise ArgumentError, 'sid cannot be nil'
@@ -34,9 +34,9 @@ module Twilio
34
34
  end
35
35
 
36
36
  ##
37
- # @param [String] sid The SID of the Service resource to fetch.
38
- # @return [Twilio::REST::Chat::V2::ServiceContext] if sid was passed.
39
- # @return [Twilio::REST::Chat::V2::ServiceList]
37
+ # @param [String] sid The sid
38
+ # @return [Twilio::REST::Ip_messaging::V2::ServiceContext] if sid was passed.
39
+ # @return [Twilio::REST::Ip_messaging::V2::ServiceList]
40
40
  def services(sid=:unset)
41
41
  if sid.nil?
42
42
  raise ArgumentError, 'sid cannot be nil'
@@ -105,26 +105,13 @@ module Twilio
105
105
 
106
106
  ##
107
107
  # Create the CredentialInstance
108
- # @param [credential.PushService] type The type of push-notification service the
109
- # credential is for. Can be: `gcm`, `fcm`, or `apn`.
110
- # @param [String] friendly_name A descriptive string that you create to describe
111
- # the new resource. It can be up to 64 characters long.
112
- # @param [String] certificate [APN only] The URL encoded representation of the
113
- # certificate. For example,
114
- # `-----BEGIN CERTIFICATE-----
115
- # MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==
116
- # -----END CERTIFICATE-----`
117
- # @param [String] private_key [APN only] The URL encoded representation of the
118
- # private key. For example,
119
- # `-----BEGIN RSA PRIVATE KEY-----
120
- # MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...
121
- # -----END RSA PRIVATE KEY-----`
122
- # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
123
- # APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
124
- # @param [String] api_key [GCM only] The API key for the project that was obtained
125
- # from the Google Developer console for your GCM Service application credential.
126
- # @param [String] secret [FCM only] The **Server key** of your project from the
127
- # Firebase console, found under Settings / Cloud messaging.
108
+ # @param [credential.PushService] type The type
109
+ # @param [String] friendly_name The friendly_name
110
+ # @param [String] certificate The certificate
111
+ # @param [String] private_key The private_key
112
+ # @param [Boolean] sandbox The sandbox
113
+ # @param [String] api_key The api_key
114
+ # @param [String] secret The secret
128
115
  # @return [CredentialInstance] Created CredentialInstance
129
116
  def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
130
117
  data = Twilio::Values.of({
@@ -182,7 +169,7 @@ module Twilio
182
169
  ##
183
170
  # Initialize the CredentialContext
184
171
  # @param [Version] version Version that contains the resource
185
- # @param [String] sid The SID of the Credential resource to fetch.
172
+ # @param [String] sid The sid
186
173
  # @return [CredentialContext] CredentialContext
187
174
  def initialize(version, sid)
188
175
  super(version)
@@ -203,24 +190,12 @@ module Twilio
203
190
 
204
191
  ##
205
192
  # Update the CredentialInstance
206
- # @param [String] friendly_name A descriptive string that you create to describe
207
- # the resource. It can be up to 64 characters long.
208
- # @param [String] certificate [APN only] The URL encoded representation of the
209
- # certificate. For example,
210
- # `-----BEGIN CERTIFICATE-----
211
- # MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==
212
- # -----END CERTIFICATE-----`
213
- # @param [String] private_key [APN only] The URL encoded representation of the
214
- # private key. For example,
215
- # `-----BEGIN RSA PRIVATE KEY-----
216
- # MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...
217
- # -----END RSA PRIVATE KEY-----`
218
- # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
219
- # APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
220
- # @param [String] api_key [GCM only] The API key for the project that was obtained
221
- # from the Google Developer console for your GCM Service application credential.
222
- # @param [String] secret [FCM only] The **Server key** of your project from the
223
- # Firebase console, found under Settings / Cloud messaging.
193
+ # @param [String] friendly_name The friendly_name
194
+ # @param [String] certificate The certificate
195
+ # @param [String] private_key The private_key
196
+ # @param [Boolean] sandbox The sandbox
197
+ # @param [String] api_key The api_key
198
+ # @param [String] secret The secret
224
199
  # @return [CredentialInstance] Updated CredentialInstance
225
200
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
226
201
  data = Twilio::Values.of({
@@ -264,7 +239,7 @@ module Twilio
264
239
  # Initialize the CredentialInstance
265
240
  # @param [Version] version Version that contains the resource
266
241
  # @param [Hash] payload payload that contains response from Twilio
267
- # @param [String] sid The SID of the Credential resource to fetch.
242
+ # @param [String] sid The sid
268
243
  # @return [CredentialInstance] CredentialInstance
269
244
  def initialize(version, payload, sid: nil)
270
245
  super(version)
@@ -298,49 +273,49 @@ module Twilio
298
273
  end
299
274
 
300
275
  ##
301
- # @return [String] The unique string that identifies the resource
276
+ # @return [String] The sid
302
277
  def sid
303
278
  @properties['sid']
304
279
  end
305
280
 
306
281
  ##
307
- # @return [String] The SID of the Account that created the resource
282
+ # @return [String] The account_sid
308
283
  def account_sid
309
284
  @properties['account_sid']
310
285
  end
311
286
 
312
287
  ##
313
- # @return [String] The string that you assigned to describe the resource
288
+ # @return [String] The friendly_name
314
289
  def friendly_name
315
290
  @properties['friendly_name']
316
291
  end
317
292
 
318
293
  ##
319
- # @return [credential.PushService] The type of push-notification service the credential is for
294
+ # @return [credential.PushService] The type
320
295
  def type
321
296
  @properties['type']
322
297
  end
323
298
 
324
299
  ##
325
- # @return [String] [APN only] Whether to send the credential to sandbox APNs
300
+ # @return [String] The sandbox
326
301
  def sandbox
327
302
  @properties['sandbox']
328
303
  end
329
304
 
330
305
  ##
331
- # @return [Time] The ISO 8601 date and time in GMT when the resource was created
306
+ # @return [Time] The date_created
332
307
  def date_created
333
308
  @properties['date_created']
334
309
  end
335
310
 
336
311
  ##
337
- # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
312
+ # @return [Time] The date_updated
338
313
  def date_updated
339
314
  @properties['date_updated']
340
315
  end
341
316
 
342
317
  ##
343
- # @return [String] The absolute URL of the Credential resource
318
+ # @return [String] The url
344
319
  def url
345
320
  @properties['url']
346
321
  end
@@ -354,24 +329,12 @@ module Twilio
354
329
 
355
330
  ##
356
331
  # Update the CredentialInstance
357
- # @param [String] friendly_name A descriptive string that you create to describe
358
- # the resource. It can be up to 64 characters long.
359
- # @param [String] certificate [APN only] The URL encoded representation of the
360
- # certificate. For example,
361
- # `-----BEGIN CERTIFICATE-----
362
- # MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==
363
- # -----END CERTIFICATE-----`
364
- # @param [String] private_key [APN only] The URL encoded representation of the
365
- # private key. For example,
366
- # `-----BEGIN RSA PRIVATE KEY-----
367
- # MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...
368
- # -----END RSA PRIVATE KEY-----`
369
- # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
370
- # APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
371
- # @param [String] api_key [GCM only] The API key for the project that was obtained
372
- # from the Google Developer console for your GCM Service application credential.
373
- # @param [String] secret [FCM only] The **Server key** of your project from the
374
- # Firebase console, found under Settings / Cloud messaging.
332
+ # @param [String] friendly_name The friendly_name
333
+ # @param [String] certificate The certificate
334
+ # @param [String] private_key The private_key
335
+ # @param [Boolean] sandbox The sandbox
336
+ # @param [String] api_key The api_key
337
+ # @param [String] secret The secret
375
338
  # @return [CredentialInstance] Updated CredentialInstance
376
339
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
377
340
  context.update(
@@ -25,8 +25,7 @@ module Twilio
25
25
 
26
26
  ##
27
27
  # Create the ServiceInstance
28
- # @param [String] friendly_name A descriptive string that you create to describe
29
- # the new resource.
28
+ # @param [String] friendly_name The friendly_name
30
29
  # @return [ServiceInstance] Created ServiceInstance
31
30
  def create(friendly_name: nil)
32
31
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -156,7 +155,7 @@ module Twilio
156
155
  ##
157
156
  # Initialize the ServiceContext
158
157
  # @param [Version] version Version that contains the resource
159
- # @param [String] sid The SID of the Service resource to fetch.
158
+ # @param [String] sid The sid
160
159
  # @return [ServiceContext] ServiceContext
161
160
  def initialize(version, sid)
162
161
  super(version)
@@ -190,95 +189,51 @@ module Twilio
190
189
 
191
190
  ##
192
191
  # Update the ServiceInstance
193
- # @param [String] friendly_name A descriptive string that you create to describe
194
- # the resource.
195
- # @param [String] default_service_role_sid The service role assigned to users when
196
- # they are added to the service. See the {Role
197
- # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
198
- # about roles.
199
- # @param [String] default_channel_role_sid The channel role assigned to users when
200
- # they are added to a channel. See the {Role
201
- # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
202
- # about roles.
203
- # @param [String] default_channel_creator_role_sid The channel role assigned to a
204
- # channel creator when they join a new channel. See the {Role
205
- # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
206
- # about roles.
207
- # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
208
- # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
209
- # default is `true`.
210
- # @param [Boolean] reachability_enabled Whether to enable the {Reachability
211
- # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
212
- # Service instance. The default is `false`.
213
- # @param [String] typing_indicator_timeout How long in seconds after a `started
214
- # typing` event until clients should assume that user is no longer typing, even if
215
- # no `ended typing` message was received. The default is 5 seconds.
216
- # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
217
- # between consumption reports submission batches from client endpoints.
218
- # @param [Boolean] notifications_new_message_enabled Whether to send a
219
- # notification when a new message is added to a channel. The default is `false`.
220
- # @param [String] notifications_new_message_template The template to use to create
221
- # the notification text displayed when a new message is added to a channel and
222
- # `notifications.new_message.enabled` is `true`.
223
- # @param [String] notifications_new_message_sound The name of the sound to play
224
- # when a new message is added to a channel and `notifications.new_message.enabled`
225
- # is `true`.
226
- # @param [Boolean] notifications_new_message_badge_count_enabled Whether the new
227
- # message badge is enabled. The default is `false`.
228
- # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
229
- # notification when a member is added to a channel. The default is `false`.
230
- # @param [String] notifications_added_to_channel_template The template to use to
231
- # create the notification text displayed when a member is added to a channel and
232
- # `notifications.added_to_channel.enabled` is `true`.
233
- # @param [String] notifications_added_to_channel_sound The name of the sound to
234
- # play when a member is added to a channel and
235
- # `notifications.added_to_channel.enabled` is `true`.
236
- # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
237
- # notification to a user when they are removed from a channel. The default is
238
- # `false`.
239
- # @param [String] notifications_removed_from_channel_template The template to use
240
- # to create the notification text displayed to a user when they are removed from a
241
- # channel and `notifications.removed_from_channel.enabled` is `true`.
242
- # @param [String] notifications_removed_from_channel_sound The name of the sound
243
- # to play to a user when they are removed from a channel and
244
- # `notifications.removed_from_channel.enabled` is `true`.
245
- # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
246
- # notification when a user is invited to a channel. The default is `false`.
247
- # @param [String] notifications_invited_to_channel_template The template to use to
248
- # create the notification text displayed when a user is invited to a channel and
249
- # `notifications.invited_to_channel.enabled` is `true`.
250
- # @param [String] notifications_invited_to_channel_sound The name of the sound to
251
- # play when a user is invited to a channel and
252
- # `notifications.invited_to_channel.enabled` is `true`.
253
- # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
254
- # by using the `webhook_method`. See {Webhook
255
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
256
- # @param [String] post_webhook_url The URL for post-event webhooks, which are
257
- # called by using the `webhook_method`. See {Webhook
258
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
259
- # @param [String] webhook_method The HTTP method to use for calls to the
260
- # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
261
- # the default is `POST`. See {Webhook
262
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
263
- # @param [String] webhook_filters The list of webhook events that are enabled for
264
- # this Service instance. See {Webhook
265
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
266
- # @param [String] limits_channel_members The maximum number of Members that can be
267
- # added to Channels within this Service. Can be up to 1,000.
268
- # @param [String] limits_user_channels The maximum number of Channels Users can be
269
- # a Member of within this Service. Can be up to 1,000.
270
- # @param [String] media_compatibility_message The message to send when a media
271
- # message has no text. Can be used as placeholder message.
272
- # @param [String] pre_webhook_retry_count The number of times to retry a call to
273
- # the `pre_webhook_url` if the request times out (after 5 seconds) or it receives
274
- # a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means
275
- # the call won't be retried.
276
- # @param [String] post_webhook_retry_count The number of times to retry a call to
277
- # the `post_webhook_url` if the request times out (after 5 seconds) or it receives
278
- # a 429, 503, or 504 HTTP response. The default is 0, which means the call won't
279
- # be retried.
280
- # @param [Boolean] notifications_log_enabled Whether to log notifications. The
281
- # default is `false`.
192
+ # @param [String] friendly_name The friendly_name
193
+ # @param [String] default_service_role_sid The default_service_role_sid
194
+ # @param [String] default_channel_role_sid The default_channel_role_sid
195
+ # @param [String] default_channel_creator_role_sid The
196
+ # default_channel_creator_role_sid
197
+ # @param [Boolean] read_status_enabled The read_status_enabled
198
+ # @param [Boolean] reachability_enabled The reachability_enabled
199
+ # @param [String] typing_indicator_timeout The typing_indicator_timeout
200
+ # @param [String] consumption_report_interval The consumption_report_interval
201
+ # @param [Boolean] notifications_new_message_enabled The
202
+ # notifications.new_message.enabled
203
+ # @param [String] notifications_new_message_template The
204
+ # notifications.new_message.template
205
+ # @param [String] notifications_new_message_sound The
206
+ # notifications.new_message.sound
207
+ # @param [Boolean] notifications_new_message_badge_count_enabled The
208
+ # notifications.new_message.badge_count_enabled
209
+ # @param [Boolean] notifications_added_to_channel_enabled The
210
+ # notifications.added_to_channel.enabled
211
+ # @param [String] notifications_added_to_channel_template The
212
+ # notifications.added_to_channel.template
213
+ # @param [String] notifications_added_to_channel_sound The
214
+ # notifications.added_to_channel.sound
215
+ # @param [Boolean] notifications_removed_from_channel_enabled The
216
+ # notifications.removed_from_channel.enabled
217
+ # @param [String] notifications_removed_from_channel_template The
218
+ # notifications.removed_from_channel.template
219
+ # @param [String] notifications_removed_from_channel_sound The
220
+ # notifications.removed_from_channel.sound
221
+ # @param [Boolean] notifications_invited_to_channel_enabled The
222
+ # notifications.invited_to_channel.enabled
223
+ # @param [String] notifications_invited_to_channel_template The
224
+ # notifications.invited_to_channel.template
225
+ # @param [String] notifications_invited_to_channel_sound The
226
+ # notifications.invited_to_channel.sound
227
+ # @param [String] pre_webhook_url The pre_webhook_url
228
+ # @param [String] post_webhook_url The post_webhook_url
229
+ # @param [String] webhook_method The webhook_method
230
+ # @param [String] webhook_filters The webhook_filters
231
+ # @param [String] limits_channel_members The limits.channel_members
232
+ # @param [String] limits_user_channels The limits.user_channels
233
+ # @param [String] media_compatibility_message The media.compatibility_message
234
+ # @param [String] pre_webhook_retry_count The pre_webhook_retry_count
235
+ # @param [String] post_webhook_retry_count The post_webhook_retry_count
236
+ # @param [Boolean] notifications_log_enabled The notifications.log_enabled
282
237
  # @return [ServiceInstance] Updated ServiceInstance
283
238
  def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset)
284
239
  data = Twilio::Values.of({
@@ -412,7 +367,7 @@ module Twilio
412
367
  # Initialize the ServiceInstance
413
368
  # @param [Version] version Version that contains the resource
414
369
  # @param [Hash] payload payload that contains response from Twilio
415
- # @param [String] sid The SID of the Service resource to fetch.
370
+ # @param [String] sid The sid
416
371
  # @return [ServiceInstance] ServiceInstance
417
372
  def initialize(version, payload, sid: nil)
418
373
  super(version)
@@ -461,139 +416,139 @@ module Twilio
461
416
  end
462
417
 
463
418
  ##
464
- # @return [String] The unique string that identifies the resource
419
+ # @return [String] The sid
465
420
  def sid
466
421
  @properties['sid']
467
422
  end
468
423
 
469
424
  ##
470
- # @return [String] The SID of the Account that created the resource
425
+ # @return [String] The account_sid
471
426
  def account_sid
472
427
  @properties['account_sid']
473
428
  end
474
429
 
475
430
  ##
476
- # @return [String] The string that you assigned to describe the resource
431
+ # @return [String] The friendly_name
477
432
  def friendly_name
478
433
  @properties['friendly_name']
479
434
  end
480
435
 
481
436
  ##
482
- # @return [Time] The RFC 2822 date and time in GMT when the resource was created
437
+ # @return [Time] The date_created
483
438
  def date_created
484
439
  @properties['date_created']
485
440
  end
486
441
 
487
442
  ##
488
- # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
443
+ # @return [Time] The date_updated
489
444
  def date_updated
490
445
  @properties['date_updated']
491
446
  end
492
447
 
493
448
  ##
494
- # @return [String] The service role assigned to users when they are added to the service
449
+ # @return [String] The default_service_role_sid
495
450
  def default_service_role_sid
496
451
  @properties['default_service_role_sid']
497
452
  end
498
453
 
499
454
  ##
500
- # @return [String] The channel role assigned to users when they are added to a channel
455
+ # @return [String] The default_channel_role_sid
501
456
  def default_channel_role_sid
502
457
  @properties['default_channel_role_sid']
503
458
  end
504
459
 
505
460
  ##
506
- # @return [String] The channel role assigned to a channel creator when they join a new channel
461
+ # @return [String] The default_channel_creator_role_sid
507
462
  def default_channel_creator_role_sid
508
463
  @properties['default_channel_creator_role_sid']
509
464
  end
510
465
 
511
466
  ##
512
- # @return [Boolean] Whether the Message Consumption Horizon feature is enabled
467
+ # @return [Boolean] The read_status_enabled
513
468
  def read_status_enabled
514
469
  @properties['read_status_enabled']
515
470
  end
516
471
 
517
472
  ##
518
- # @return [Boolean] Whether the Reachability Indicator feature is enabled for this Service instance
473
+ # @return [Boolean] The reachability_enabled
519
474
  def reachability_enabled
520
475
  @properties['reachability_enabled']
521
476
  end
522
477
 
523
478
  ##
524
- # @return [String] How long in seconds to wait before assuming the user is no longer typing
479
+ # @return [String] The typing_indicator_timeout
525
480
  def typing_indicator_timeout
526
481
  @properties['typing_indicator_timeout']
527
482
  end
528
483
 
529
484
  ##
530
- # @return [String] DEPRECATED
485
+ # @return [String] The consumption_report_interval
531
486
  def consumption_report_interval
532
487
  @properties['consumption_report_interval']
533
488
  end
534
489
 
535
490
  ##
536
- # @return [Hash] An object that describes the limits of the service instance
491
+ # @return [Hash] The limits
537
492
  def limits
538
493
  @properties['limits']
539
494
  end
540
495
 
541
496
  ##
542
- # @return [String] The webhook URL for pre-event webhooks
497
+ # @return [String] The pre_webhook_url
543
498
  def pre_webhook_url
544
499
  @properties['pre_webhook_url']
545
500
  end
546
501
 
547
502
  ##
548
- # @return [String] The URL for post-event webhooks
503
+ # @return [String] The post_webhook_url
549
504
  def post_webhook_url
550
505
  @properties['post_webhook_url']
551
506
  end
552
507
 
553
508
  ##
554
- # @return [String] The HTTP method to use for both PRE and POST webhooks
509
+ # @return [String] The webhook_method
555
510
  def webhook_method
556
511
  @properties['webhook_method']
557
512
  end
558
513
 
559
514
  ##
560
- # @return [String] The list of webhook events that are enabled for this Service instance
515
+ # @return [String] The webhook_filters
561
516
  def webhook_filters
562
517
  @properties['webhook_filters']
563
518
  end
564
519
 
565
520
  ##
566
- # @return [String] Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses
521
+ # @return [String] The pre_webhook_retry_count
567
522
  def pre_webhook_retry_count
568
523
  @properties['pre_webhook_retry_count']
569
524
  end
570
525
 
571
526
  ##
572
- # @return [String] The number of times calls to the `post_webhook_url` will be retried
527
+ # @return [String] The post_webhook_retry_count
573
528
  def post_webhook_retry_count
574
529
  @properties['post_webhook_retry_count']
575
530
  end
576
531
 
577
532
  ##
578
- # @return [Hash] The notification configuration for the Service instance
533
+ # @return [Hash] The notifications
579
534
  def notifications
580
535
  @properties['notifications']
581
536
  end
582
537
 
583
538
  ##
584
- # @return [Hash] The properties of the media that the service supports
539
+ # @return [Hash] The media
585
540
  def media
586
541
  @properties['media']
587
542
  end
588
543
 
589
544
  ##
590
- # @return [String] The absolute URL of the Service resource
545
+ # @return [String] The url
591
546
  def url
592
547
  @properties['url']
593
548
  end
594
549
 
595
550
  ##
596
- # @return [String] The absolute URLs of the Service's Channels, Roles, and Users
551
+ # @return [String] The links
597
552
  def links
598
553
  @properties['links']
599
554
  end
@@ -614,95 +569,51 @@ module Twilio
614
569
 
615
570
  ##
616
571
  # Update the ServiceInstance
617
- # @param [String] friendly_name A descriptive string that you create to describe
618
- # the resource.
619
- # @param [String] default_service_role_sid The service role assigned to users when
620
- # they are added to the service. See the {Role
621
- # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
622
- # about roles.
623
- # @param [String] default_channel_role_sid The channel role assigned to users when
624
- # they are added to a channel. See the {Role
625
- # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
626
- # about roles.
627
- # @param [String] default_channel_creator_role_sid The channel role assigned to a
628
- # channel creator when they join a new channel. See the {Role
629
- # resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
630
- # about roles.
631
- # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
632
- # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
633
- # default is `true`.
634
- # @param [Boolean] reachability_enabled Whether to enable the {Reachability
635
- # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
636
- # Service instance. The default is `false`.
637
- # @param [String] typing_indicator_timeout How long in seconds after a `started
638
- # typing` event until clients should assume that user is no longer typing, even if
639
- # no `ended typing` message was received. The default is 5 seconds.
640
- # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
641
- # between consumption reports submission batches from client endpoints.
642
- # @param [Boolean] notifications_new_message_enabled Whether to send a
643
- # notification when a new message is added to a channel. The default is `false`.
644
- # @param [String] notifications_new_message_template The template to use to create
645
- # the notification text displayed when a new message is added to a channel and
646
- # `notifications.new_message.enabled` is `true`.
647
- # @param [String] notifications_new_message_sound The name of the sound to play
648
- # when a new message is added to a channel and `notifications.new_message.enabled`
649
- # is `true`.
650
- # @param [Boolean] notifications_new_message_badge_count_enabled Whether the new
651
- # message badge is enabled. The default is `false`.
652
- # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
653
- # notification when a member is added to a channel. The default is `false`.
654
- # @param [String] notifications_added_to_channel_template The template to use to
655
- # create the notification text displayed when a member is added to a channel and
656
- # `notifications.added_to_channel.enabled` is `true`.
657
- # @param [String] notifications_added_to_channel_sound The name of the sound to
658
- # play when a member is added to a channel and
659
- # `notifications.added_to_channel.enabled` is `true`.
660
- # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
661
- # notification to a user when they are removed from a channel. The default is
662
- # `false`.
663
- # @param [String] notifications_removed_from_channel_template The template to use
664
- # to create the notification text displayed to a user when they are removed from a
665
- # channel and `notifications.removed_from_channel.enabled` is `true`.
666
- # @param [String] notifications_removed_from_channel_sound The name of the sound
667
- # to play to a user when they are removed from a channel and
668
- # `notifications.removed_from_channel.enabled` is `true`.
669
- # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
670
- # notification when a user is invited to a channel. The default is `false`.
671
- # @param [String] notifications_invited_to_channel_template The template to use to
672
- # create the notification text displayed when a user is invited to a channel and
673
- # `notifications.invited_to_channel.enabled` is `true`.
674
- # @param [String] notifications_invited_to_channel_sound The name of the sound to
675
- # play when a user is invited to a channel and
676
- # `notifications.invited_to_channel.enabled` is `true`.
677
- # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
678
- # by using the `webhook_method`. See {Webhook
679
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
680
- # @param [String] post_webhook_url The URL for post-event webhooks, which are
681
- # called by using the `webhook_method`. See {Webhook
682
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
683
- # @param [String] webhook_method The HTTP method to use for calls to the
684
- # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
685
- # the default is `POST`. See {Webhook
686
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
687
- # @param [String] webhook_filters The list of webhook events that are enabled for
688
- # this Service instance. See {Webhook
689
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
690
- # @param [String] limits_channel_members The maximum number of Members that can be
691
- # added to Channels within this Service. Can be up to 1,000.
692
- # @param [String] limits_user_channels The maximum number of Channels Users can be
693
- # a Member of within this Service. Can be up to 1,000.
694
- # @param [String] media_compatibility_message The message to send when a media
695
- # message has no text. Can be used as placeholder message.
696
- # @param [String] pre_webhook_retry_count The number of times to retry a call to
697
- # the `pre_webhook_url` if the request times out (after 5 seconds) or it receives
698
- # a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means
699
- # the call won't be retried.
700
- # @param [String] post_webhook_retry_count The number of times to retry a call to
701
- # the `post_webhook_url` if the request times out (after 5 seconds) or it receives
702
- # a 429, 503, or 504 HTTP response. The default is 0, which means the call won't
703
- # be retried.
704
- # @param [Boolean] notifications_log_enabled Whether to log notifications. The
705
- # default is `false`.
572
+ # @param [String] friendly_name The friendly_name
573
+ # @param [String] default_service_role_sid The default_service_role_sid
574
+ # @param [String] default_channel_role_sid The default_channel_role_sid
575
+ # @param [String] default_channel_creator_role_sid The
576
+ # default_channel_creator_role_sid
577
+ # @param [Boolean] read_status_enabled The read_status_enabled
578
+ # @param [Boolean] reachability_enabled The reachability_enabled
579
+ # @param [String] typing_indicator_timeout The typing_indicator_timeout
580
+ # @param [String] consumption_report_interval The consumption_report_interval
581
+ # @param [Boolean] notifications_new_message_enabled The
582
+ # notifications.new_message.enabled
583
+ # @param [String] notifications_new_message_template The
584
+ # notifications.new_message.template
585
+ # @param [String] notifications_new_message_sound The
586
+ # notifications.new_message.sound
587
+ # @param [Boolean] notifications_new_message_badge_count_enabled The
588
+ # notifications.new_message.badge_count_enabled
589
+ # @param [Boolean] notifications_added_to_channel_enabled The
590
+ # notifications.added_to_channel.enabled
591
+ # @param [String] notifications_added_to_channel_template The
592
+ # notifications.added_to_channel.template
593
+ # @param [String] notifications_added_to_channel_sound The
594
+ # notifications.added_to_channel.sound
595
+ # @param [Boolean] notifications_removed_from_channel_enabled The
596
+ # notifications.removed_from_channel.enabled
597
+ # @param [String] notifications_removed_from_channel_template The
598
+ # notifications.removed_from_channel.template
599
+ # @param [String] notifications_removed_from_channel_sound The
600
+ # notifications.removed_from_channel.sound
601
+ # @param [Boolean] notifications_invited_to_channel_enabled The
602
+ # notifications.invited_to_channel.enabled
603
+ # @param [String] notifications_invited_to_channel_template The
604
+ # notifications.invited_to_channel.template
605
+ # @param [String] notifications_invited_to_channel_sound The
606
+ # notifications.invited_to_channel.sound
607
+ # @param [String] pre_webhook_url The pre_webhook_url
608
+ # @param [String] post_webhook_url The post_webhook_url
609
+ # @param [String] webhook_method The webhook_method
610
+ # @param [String] webhook_filters The webhook_filters
611
+ # @param [String] limits_channel_members The limits.channel_members
612
+ # @param [String] limits_user_channels The limits.user_channels
613
+ # @param [String] media_compatibility_message The media.compatibility_message
614
+ # @param [String] pre_webhook_retry_count The pre_webhook_retry_count
615
+ # @param [String] post_webhook_retry_count The post_webhook_retry_count
616
+ # @param [Boolean] notifications_log_enabled The notifications.log_enabled
706
617
  # @return [ServiceInstance] Updated ServiceInstance
707
618
  def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset)
708
619
  context.update(