twilio-ruby 5.9.0 → 5.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (112) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +12 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +36 -24
  5. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +34 -25
  6. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +30 -21
  7. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +1 -1
  8. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +10 -4
  9. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +2 -2
  10. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +2 -4
  11. data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +1 -1
  12. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +6 -4
  13. data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +6 -7
  14. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +1 -1
  15. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +1 -1
  16. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +12 -4
  17. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +11 -6
  18. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +10 -8
  19. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +10 -8
  20. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +11 -9
  21. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +0 -1
  22. data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +2 -1
  23. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +9 -6
  24. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +9 -3
  25. data/lib/twilio-ruby/rest/api/v2010/account.rb +13 -9
  26. data/lib/twilio-ruby/rest/chat/v1/credential.rb +42 -24
  27. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +38 -18
  28. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +60 -24
  29. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +28 -18
  30. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +33 -24
  31. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +26 -16
  32. data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +4 -2
  33. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +43 -24
  34. data/lib/twilio-ruby/rest/chat/v1/service.rb +74 -44
  35. data/lib/twilio-ruby/rest/chat/v2/credential.rb +61 -27
  36. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +41 -18
  37. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +43 -25
  38. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +76 -37
  39. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +432 -0
  40. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +90 -35
  41. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +23 -16
  42. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +4 -2
  43. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +43 -25
  44. data/lib/twilio-ruby/rest/chat/v2/service.rb +93 -53
  45. data/lib/twilio-ruby/rest/chat.rb +4 -2
  46. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +42 -24
  47. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +38 -18
  48. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +60 -24
  49. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +28 -18
  50. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +33 -24
  51. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +26 -16
  52. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +4 -2
  53. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +43 -24
  54. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +74 -44
  55. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +61 -27
  56. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +41 -18
  57. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +43 -25
  58. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +76 -37
  59. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +432 -0
  60. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +90 -35
  61. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +23 -16
  62. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +4 -2
  63. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +43 -25
  64. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +93 -53
  65. data/lib/twilio-ruby/rest/ip_messaging.rb +4 -2
  66. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +12 -11
  67. data/lib/twilio-ruby/rest/monitor/v1/event.rb +11 -11
  68. data/lib/twilio-ruby/rest/monitor.rb +1 -1
  69. data/lib/twilio-ruby/rest/notify/v1/credential.rb +47 -22
  70. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +59 -26
  71. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +104 -29
  72. data/lib/twilio-ruby/rest/notify/v1/service.rb +86 -48
  73. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +2 -2
  74. data/lib/twilio-ruby/rest/preview/marketplace.rb +13 -13
  75. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +22 -16
  76. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +21 -15
  77. data/lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb +17 -14
  78. data/lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb +36 -25
  79. data/lib/twilio-ruby/rest/preview/understand/assistant/intent.rb +21 -15
  80. data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +19 -13
  81. data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +42 -28
  82. data/lib/twilio-ruby/rest/preview/understand/assistant.rb +39 -21
  83. data/lib/twilio-ruby/rest/preview.rb +10 -9
  84. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +5 -5
  85. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +4 -4
  86. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +3 -3
  87. data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +5 -5
  88. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +12 -13
  89. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +28 -22
  90. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +7 -5
  91. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +31 -14
  92. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +3 -3
  93. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +2 -2
  94. data/lib/twilio-ruby/rest/sync/v1/service.rb +24 -27
  95. data/lib/twilio-ruby/rest/video/v1/composition.rb +1 -1
  96. data/lib/twilio-ruby/rest/video/v1/recording.rb +45 -31
  97. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +1 -1
  98. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +18 -6
  99. data/lib/twilio-ruby/rest/video/v1.rb +13 -12
  100. data/lib/twilio-ruby/rest/video.rb +9 -8
  101. data/lib/twilio-ruby/rest/wireless/v1/command.rb +43 -33
  102. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +48 -35
  103. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +21 -23
  104. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +32 -22
  105. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +121 -70
  106. data/lib/twilio-ruby/rest/wireless.rb +6 -3
  107. data/lib/twilio-ruby/version.rb +1 -1
  108. data/spec/integration/chat/v2/service/channel/webhook_spec.rb +307 -0
  109. data/spec/integration/chat/v2/service/channel_spec.rb +4 -0
  110. data/spec/integration/ip_messaging/v2/service/channel/webhook_spec.rb +307 -0
  111. data/spec/integration/ip_messaging/v2/service/channel_spec.rb +4 -0
  112. metadata +9 -3
@@ -15,7 +15,8 @@ module Twilio
15
15
  ##
16
16
  # Initialize the RoleList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] service_sid The service_sid
18
+ # @param [String] service_sid The unique id of the
19
+ # [Service](https://www.twilio.com/docs/chat/api/services) this role belongs to.
19
20
  # @return [RoleList] RoleList
20
21
  def initialize(version, service_sid: nil)
21
22
  super(version)
@@ -28,9 +29,12 @@ module Twilio
28
29
  ##
29
30
  # Retrieve a single page of RoleInstance records from the API.
30
31
  # Request is executed immediately.
31
- # @param [String] friendly_name The friendly_name
32
- # @param [role.RoleType] type The type
33
- # @param [String] permission The permission
32
+ # @param [String] friendly_name The human-readable name of this role.
33
+ # @param [role.RoleType] type What kind of role this is. Either `channel` for
34
+ # [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment`
35
+ # for [Service](https://www.twilio.com/docs/api/chat/rest/services) roles.
36
+ # @param [String] permission (multiple) A permission this role should have.
37
+ # Consult the table above for the list of possible permissions.
34
38
  # @return [RoleInstance] Newly created RoleInstance
35
39
  def create(friendly_name: nil, type: nil, permission: nil)
36
40
  data = Twilio::Values.of({
@@ -205,7 +209,8 @@ module Twilio
205
209
 
206
210
  ##
207
211
  # Update the RoleInstance
208
- # @param [String] permission The permission
212
+ # @param [String] permission (multiple) A permission this role should have.
213
+ # Consult the table above for the list of possible permissions.
209
214
  # @return [RoleInstance] Updated RoleInstance
210
215
  def update(permission: nil)
211
216
  data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
@@ -232,7 +237,8 @@ module Twilio
232
237
  # Initialize the RoleInstance
233
238
  # @param [Version] version Version that contains the resource
234
239
  # @param [Hash] payload payload that contains response from Twilio
235
- # @param [String] service_sid The service_sid
240
+ # @param [String] service_sid The unique id of the
241
+ # [Service](https://www.twilio.com/docs/chat/api/services) this role belongs to.
236
242
  # @param [String] sid The sid
237
243
  # @return [RoleInstance] RoleInstance
238
244
  def initialize(version, payload, service_sid: nil, sid: nil)
@@ -268,55 +274,55 @@ module Twilio
268
274
  end
269
275
 
270
276
  ##
271
- # @return [String] The sid
277
+ # @return [String] A 34 character string that uniquely identifies this resource.
272
278
  def sid
273
279
  @properties['sid']
274
280
  end
275
281
 
276
282
  ##
277
- # @return [String] The account_sid
283
+ # @return [String] The unique id of the Account responsible for this role.
278
284
  def account_sid
279
285
  @properties['account_sid']
280
286
  end
281
287
 
282
288
  ##
283
- # @return [String] The service_sid
289
+ # @return [String] The unique id of the Service this role belongs to.
284
290
  def service_sid
285
291
  @properties['service_sid']
286
292
  end
287
293
 
288
294
  ##
289
- # @return [String] The friendly_name
295
+ # @return [String] The human-readable name of this role.
290
296
  def friendly_name
291
297
  @properties['friendly_name']
292
298
  end
293
299
 
294
300
  ##
295
- # @return [role.RoleType] The type
301
+ # @return [role.RoleType] What kind of role this is.
296
302
  def type
297
303
  @properties['type']
298
304
  end
299
305
 
300
306
  ##
301
- # @return [String] The permissions
307
+ # @return [String] A JSON array of the permissions this role has.
302
308
  def permissions
303
309
  @properties['permissions']
304
310
  end
305
311
 
306
312
  ##
307
- # @return [Time] The date_created
313
+ # @return [Time] The date that this resource was created in ISO 8601 format.
308
314
  def date_created
309
315
  @properties['date_created']
310
316
  end
311
317
 
312
318
  ##
313
- # @return [Time] The date_updated
319
+ # @return [Time] The date that this resource was last updated in ISO 8601 format.
314
320
  def date_updated
315
321
  @properties['date_updated']
316
322
  end
317
323
 
318
324
  ##
319
- # @return [String] The url
325
+ # @return [String] An absolute URL for this role.
320
326
  def url
321
327
  @properties['url']
322
328
  end
@@ -337,7 +343,8 @@ module Twilio
337
343
 
338
344
  ##
339
345
  # Update the RoleInstance
340
- # @param [String] permission The permission
346
+ # @param [String] permission (multiple) A permission this role should have.
347
+ # Consult the table above for the list of possible permissions.
341
348
  # @return [RoleInstance] Updated RoleInstance
342
349
  def update(permission: nil)
343
350
  context.update(permission: permission, )
@@ -17,7 +17,8 @@ module Twilio
17
17
  # Initialize the UserChannelList
18
18
  # @param [Version] version Version that contains the resource
19
19
  # @param [String] service_sid The service_sid
20
- # @param [String] user_sid The sid
20
+ # @param [String] user_sid A 34 character string that uniquely identifies this
21
+ # resource.
21
22
  # @return [UserChannelList] UserChannelList
22
23
  def initialize(version, service_sid: nil, user_sid: nil)
23
24
  super(version)
@@ -156,7 +157,8 @@ module Twilio
156
157
  # @param [Version] version Version that contains the resource
157
158
  # @param [Hash] payload payload that contains response from Twilio
158
159
  # @param [String] service_sid The service_sid
159
- # @param [String] user_sid The sid
160
+ # @param [String] user_sid A 34 character string that uniquely identifies this
161
+ # resource.
160
162
  # @return [UserChannelInstance] UserChannelInstance
161
163
  def initialize(version, payload, service_sid: nil, user_sid: nil)
162
164
  super(version)
@@ -15,7 +15,9 @@ module Twilio
15
15
  ##
16
16
  # Initialize the UserList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] service_sid The service_sid
18
+ # @param [String] service_sid The unique id of the
19
+ # [Service](https://www.twilio.com/docs/api/chat/rest/services) this user belongs
20
+ # to.
19
21
  # @return [UserList] UserList
20
22
  def initialize(version, service_sid: nil)
21
23
  super(version)
@@ -28,10 +30,16 @@ module Twilio
28
30
  ##
29
31
  # Retrieve a single page of UserInstance records from the API.
30
32
  # Request is executed immediately.
31
- # @param [String] identity The identity
32
- # @param [String] role_sid The role_sid
33
- # @param [String] attributes The attributes
34
- # @param [String] friendly_name The friendly_name
33
+ # @param [String] identity A unique string that identifies the user within this
34
+ # service - often a username or email address. See the [identity][identity] docs
35
+ # for more details.
36
+ # @param [String] role_sid The unique id of the
37
+ # [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
38
+ # @param [String] attributes An optional string used to contain any metadata or
39
+ # other information for the User. The string must contain structurally valid JSON
40
+ # if specified.
41
+ # @param [String] friendly_name An optional human readable string representing the
42
+ # user. Often used for display purposes.
35
43
  # @return [UserInstance] Newly created UserInstance
36
44
  def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
37
45
  data = Twilio::Values.of({
@@ -211,9 +219,13 @@ module Twilio
211
219
 
212
220
  ##
213
221
  # Update the UserInstance
214
- # @param [String] role_sid The role_sid
215
- # @param [String] attributes The attributes
216
- # @param [String] friendly_name The friendly_name
222
+ # @param [String] role_sid The unique id of the [Role][role] assigned to this
223
+ # user.
224
+ # @param [String] attributes An optional string used to contain any metadata or
225
+ # other information for the User. The string must contain structurally valid JSON
226
+ # if specified.
227
+ # @param [String] friendly_name An optional human readable string representing the
228
+ # user. Often used for display purposes.
217
229
  # @return [UserInstance] Updated UserInstance
218
230
  def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
219
231
  data = Twilio::Values.of({
@@ -282,7 +294,9 @@ module Twilio
282
294
  # Initialize the UserInstance
283
295
  # @param [Version] version Version that contains the resource
284
296
  # @param [Hash] payload payload that contains response from Twilio
285
- # @param [String] service_sid The service_sid
297
+ # @param [String] service_sid The unique id of the
298
+ # [Service](https://www.twilio.com/docs/api/chat/rest/services) this user belongs
299
+ # to.
286
300
  # @param [String] sid The sid
287
301
  # @return [UserInstance] UserInstance
288
302
  def initialize(version, payload, service_sid: nil, sid: nil)
@@ -323,73 +337,73 @@ module Twilio
323
337
  end
324
338
 
325
339
  ##
326
- # @return [String] The sid
340
+ # @return [String] A 34 character string that uniquely identifies this resource.
327
341
  def sid
328
342
  @properties['sid']
329
343
  end
330
344
 
331
345
  ##
332
- # @return [String] The account_sid
346
+ # @return [String] The unique id of the Account responsible for this user.
333
347
  def account_sid
334
348
  @properties['account_sid']
335
349
  end
336
350
 
337
351
  ##
338
- # @return [String] The service_sid
352
+ # @return [String] The unique id of the Service this user belongs to.
339
353
  def service_sid
340
354
  @properties['service_sid']
341
355
  end
342
356
 
343
357
  ##
344
- # @return [String] The attributes
358
+ # @return [String] An optional string metadata field you can use to store any data you wish.
345
359
  def attributes
346
360
  @properties['attributes']
347
361
  end
348
362
 
349
363
  ##
350
- # @return [String] The friendly_name
364
+ # @return [String] The human-readable name of this user.
351
365
  def friendly_name
352
366
  @properties['friendly_name']
353
367
  end
354
368
 
355
369
  ##
356
- # @return [String] The role_sid
370
+ # @return [String] The unique id of the [Role][role] assigned to this user.
357
371
  def role_sid
358
372
  @properties['role_sid']
359
373
  end
360
374
 
361
375
  ##
362
- # @return [String] The identity
376
+ # @return [String] A unique string that identifies the user within this service - often a username or email address.
363
377
  def identity
364
378
  @properties['identity']
365
379
  end
366
380
 
367
381
  ##
368
- # @return [Boolean] The is_online
382
+ # @return [Boolean] Indicates whether the User is actively connected to the Service instance and online.
369
383
  def is_online
370
384
  @properties['is_online']
371
385
  end
372
386
 
373
387
  ##
374
- # @return [Boolean] The is_notifiable
388
+ # @return [Boolean] Indicates whether the User has a potentially valid Push Notification registration for the Service instance.
375
389
  def is_notifiable
376
390
  @properties['is_notifiable']
377
391
  end
378
392
 
379
393
  ##
380
- # @return [Time] The date_created
394
+ # @return [Time] The date that this resource was created in ISO 8601 format.
381
395
  def date_created
382
396
  @properties['date_created']
383
397
  end
384
398
 
385
399
  ##
386
- # @return [Time] The date_updated
400
+ # @return [Time] The date that this resource was last updated in ISO 8601 format.
387
401
  def date_updated
388
402
  @properties['date_updated']
389
403
  end
390
404
 
391
405
  ##
392
- # @return [String] The joined_channels_count
406
+ # @return [String] The number of Channels this User is a Member of.
393
407
  def joined_channels_count
394
408
  @properties['joined_channels_count']
395
409
  end
@@ -401,7 +415,7 @@ module Twilio
401
415
  end
402
416
 
403
417
  ##
404
- # @return [String] The url
418
+ # @return [String] An absolute URL for this user.
405
419
  def url
406
420
  @properties['url']
407
421
  end
@@ -422,9 +436,13 @@ module Twilio
422
436
 
423
437
  ##
424
438
  # Update the UserInstance
425
- # @param [String] role_sid The role_sid
426
- # @param [String] attributes The attributes
427
- # @param [String] friendly_name The friendly_name
439
+ # @param [String] role_sid The unique id of the [Role][role] assigned to this
440
+ # user.
441
+ # @param [String] attributes An optional string used to contain any metadata or
442
+ # other information for the User. The string must contain structurally valid JSON
443
+ # if specified.
444
+ # @param [String] friendly_name An optional human readable string representing the
445
+ # user. Often used for display purposes.
428
446
  # @return [UserInstance] Updated UserInstance
429
447
  def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
430
448
  context.update(role_sid: role_sid, attributes: attributes, friendly_name: friendly_name, )
@@ -26,7 +26,7 @@ module Twilio
26
26
  ##
27
27
  # Retrieve a single page of ServiceInstance records from the API.
28
28
  # Request is executed immediately.
29
- # @param [String] friendly_name The friendly_name
29
+ # @param [String] friendly_name Human-readable name for this service instance
30
30
  # @return [ServiceInstance] Newly created ServiceInstance
31
31
  def create(friendly_name: nil)
32
32
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -202,14 +202,20 @@ module Twilio
202
202
 
203
203
  ##
204
204
  # Update the ServiceInstance
205
- # @param [String] friendly_name The friendly_name
205
+ # @param [String] friendly_name Human-readable name for this service instance
206
206
  # @param [String] default_service_role_sid The default_service_role_sid
207
- # @param [String] default_channel_role_sid The default_channel_role_sid
208
- # @param [String] default_channel_creator_role_sid The
209
- # default_channel_creator_role_sid
210
- # @param [Boolean] read_status_enabled The read_status_enabled
211
- # @param [Boolean] reachability_enabled The reachability_enabled
212
- # @param [String] typing_indicator_timeout The typing_indicator_timeout
207
+ # @param [String] default_channel_role_sid Channel role assigned on channel join
208
+ # (see [Roles](https://www.twilio.com/docs/chat/api/roles) data model for the
209
+ # details)
210
+ # @param [String] default_channel_creator_role_sid Channel role assigned to
211
+ # creator of channel when joining for first time
212
+ # @param [Boolean] read_status_enabled `true` if the member read status feature is
213
+ # enabled, `false` if not. Defaults to `true`.
214
+ # @param [Boolean] reachability_enabled `true` if the reachability feature should
215
+ # be enabled. Defaults to `false`
216
+ # @param [String] typing_indicator_timeout The duration in seconds indicating the
217
+ # timeout after "started typing" event when client should assume that user is not
218
+ # typing anymore even if no "ended typing" message received
213
219
  # @param [String] consumption_report_interval The consumption_report_interval
214
220
  # @param [Boolean] notifications_new_message_enabled The
215
221
  # notifications.new_message.enabled
@@ -237,15 +243,29 @@ module Twilio
237
243
  # notifications.invited_to_channel.template
238
244
  # @param [String] notifications_invited_to_channel_sound The
239
245
  # notifications.invited_to_channel.sound
240
- # @param [String] pre_webhook_url The pre_webhook_url
241
- # @param [String] post_webhook_url The post_webhook_url
242
- # @param [String] webhook_method The webhook_method
243
- # @param [String] webhook_filters The webhook_filters
244
- # @param [String] limits_channel_members The limits.channel_members
245
- # @param [String] limits_user_channels The limits.user_channels
246
+ # @param [String] pre_webhook_url The webhook URL for PRE-Event webhooks. See
247
+ # [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
248
+ # details.
249
+ # @param [String] post_webhook_url The webhook URL for POST-Event webhooks. See
250
+ # [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
251
+ # details.
252
+ # @param [String] webhook_method The webhook request format to use. Must be POST
253
+ # or GET. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events)
254
+ # for more details.
255
+ # @param [String] webhook_filters The list of WebHook events that are enabled for
256
+ # this Service instance. See [Webhook
257
+ # Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
258
+ # @param [String] limits_channel_members The maximum number of Members that can be
259
+ # added to Channels within this Service. The maximum allowed value is 1,000
260
+ # @param [String] limits_user_channels The maximum number of Channels Users can be
261
+ # a Member of within this Service. The maximum value allowed is 1,000
246
262
  # @param [String] media_compatibility_message The media.compatibility_message
247
- # @param [String] pre_webhook_retry_count The pre_webhook_retry_count
248
- # @param [String] post_webhook_retry_count The post_webhook_retry_count
263
+ # @param [String] pre_webhook_retry_count Count of times webhook will be retried
264
+ # in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
265
+ # count is 0 times.
266
+ # @param [String] post_webhook_retry_count Count of times webhook will be retried
267
+ # in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
268
+ # count is 0 times.
249
269
  # @param [Boolean] notifications_log_enabled The notifications.log_enabled
250
270
  # @return [ServiceInstance] Updated ServiceInstance
251
271
  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)
@@ -426,121 +446,121 @@ module Twilio
426
446
  end
427
447
 
428
448
  ##
429
- # @return [String] The sid
449
+ # @return [String] A 34 character string that uniquely identifies this resource.
430
450
  def sid
431
451
  @properties['sid']
432
452
  end
433
453
 
434
454
  ##
435
- # @return [String] The account_sid
455
+ # @return [String] The unique id of the Account responsible for this service.
436
456
  def account_sid
437
457
  @properties['account_sid']
438
458
  end
439
459
 
440
460
  ##
441
- # @return [String] The friendly_name
461
+ # @return [String] The human-readable name of this service.
442
462
  def friendly_name
443
463
  @properties['friendly_name']
444
464
  end
445
465
 
446
466
  ##
447
- # @return [Time] The date_created
467
+ # @return [Time] The date that this resource was created
448
468
  def date_created
449
469
  @properties['date_created']
450
470
  end
451
471
 
452
472
  ##
453
- # @return [Time] The date_updated
473
+ # @return [Time] The date that this resource was last updated
454
474
  def date_updated
455
475
  @properties['date_updated']
456
476
  end
457
477
 
458
478
  ##
459
- # @return [String] The default_service_role_sid
479
+ # @return [String] The service role assigned to users when they are added to the service.
460
480
  def default_service_role_sid
461
481
  @properties['default_service_role_sid']
462
482
  end
463
483
 
464
484
  ##
465
- # @return [String] The default_channel_role_sid
485
+ # @return [String] The channel role assigned to users when they are added to a channel.
466
486
  def default_channel_role_sid
467
487
  @properties['default_channel_role_sid']
468
488
  end
469
489
 
470
490
  ##
471
- # @return [String] The default_channel_creator_role_sid
491
+ # @return [String] The channel role assigned to a channel creator when joining a new channel.
472
492
  def default_channel_creator_role_sid
473
493
  @properties['default_channel_creator_role_sid']
474
494
  end
475
495
 
476
496
  ##
477
- # @return [Boolean] The read_status_enabled
497
+ # @return [Boolean] Enable the Message Constumption Horizon feature.
478
498
  def read_status_enabled
479
499
  @properties['read_status_enabled']
480
500
  end
481
501
 
482
502
  ##
483
- # @return [Boolean] The reachability_enabled
503
+ # @return [Boolean] Indicates whether the the Reachability feature is enabled for this Service instance.
484
504
  def reachability_enabled
485
505
  @properties['reachability_enabled']
486
506
  end
487
507
 
488
508
  ##
489
- # @return [String] The typing_indicator_timeout
509
+ # @return [String] The amount of time in seconds after a "started typing" event when clients should assume that user is no longer typing, even if no "ended typing" message was received.
490
510
  def typing_indicator_timeout
491
511
  @properties['typing_indicator_timeout']
492
512
  end
493
513
 
494
514
  ##
495
- # @return [String] The consumption_report_interval
515
+ # @return [String] DEPRECATED.
496
516
  def consumption_report_interval
497
517
  @properties['consumption_report_interval']
498
518
  end
499
519
 
500
520
  ##
501
- # @return [Hash] The limits
521
+ # @return [Hash] Configuration for service instance level limits.
502
522
  def limits
503
523
  @properties['limits']
504
524
  end
505
525
 
506
526
  ##
507
- # @return [String] The pre_webhook_url
527
+ # @return [String] The webhook URL for PRE-Event webhooks.
508
528
  def pre_webhook_url
509
529
  @properties['pre_webhook_url']
510
530
  end
511
531
 
512
532
  ##
513
- # @return [String] The post_webhook_url
533
+ # @return [String] The webhook URL for POST-Event webhooks.
514
534
  def post_webhook_url
515
535
  @properties['post_webhook_url']
516
536
  end
517
537
 
518
538
  ##
519
- # @return [String] The webhook_method
539
+ # @return [String] The webhook request format to use for both PRE and POST webhooks.
520
540
  def webhook_method
521
541
  @properties['webhook_method']
522
542
  end
523
543
 
524
544
  ##
525
- # @return [String] The webhook_filters
545
+ # @return [String] The list of WebHook events that are enabled for this Service instance.
526
546
  def webhook_filters
527
547
  @properties['webhook_filters']
528
548
  end
529
549
 
530
550
  ##
531
- # @return [String] The pre_webhook_retry_count
551
+ # @return [String] Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.
532
552
  def pre_webhook_retry_count
533
553
  @properties['pre_webhook_retry_count']
534
554
  end
535
555
 
536
556
  ##
537
- # @return [String] The post_webhook_retry_count
557
+ # @return [String] Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.
538
558
  def post_webhook_retry_count
539
559
  @properties['post_webhook_retry_count']
540
560
  end
541
561
 
542
562
  ##
543
- # @return [Hash] The notifications
563
+ # @return [Hash] Notification configuration for the Service instance.
544
564
  def notifications
545
565
  @properties['notifications']
546
566
  end
@@ -552,13 +572,13 @@ module Twilio
552
572
  end
553
573
 
554
574
  ##
555
- # @return [String] The url
575
+ # @return [String] An absolute URL for this service.
556
576
  def url
557
577
  @properties['url']
558
578
  end
559
579
 
560
580
  ##
561
- # @return [String] The links
581
+ # @return [String] URLs to access the Channels, Roles, and Users for this service.
562
582
  def links
563
583
  @properties['links']
564
584
  end
@@ -579,14 +599,20 @@ module Twilio
579
599
 
580
600
  ##
581
601
  # Update the ServiceInstance
582
- # @param [String] friendly_name The friendly_name
602
+ # @param [String] friendly_name Human-readable name for this service instance
583
603
  # @param [String] default_service_role_sid The default_service_role_sid
584
- # @param [String] default_channel_role_sid The default_channel_role_sid
585
- # @param [String] default_channel_creator_role_sid The
586
- # default_channel_creator_role_sid
587
- # @param [Boolean] read_status_enabled The read_status_enabled
588
- # @param [Boolean] reachability_enabled The reachability_enabled
589
- # @param [String] typing_indicator_timeout The typing_indicator_timeout
604
+ # @param [String] default_channel_role_sid Channel role assigned on channel join
605
+ # (see [Roles](https://www.twilio.com/docs/chat/api/roles) data model for the
606
+ # details)
607
+ # @param [String] default_channel_creator_role_sid Channel role assigned to
608
+ # creator of channel when joining for first time
609
+ # @param [Boolean] read_status_enabled `true` if the member read status feature is
610
+ # enabled, `false` if not. Defaults to `true`.
611
+ # @param [Boolean] reachability_enabled `true` if the reachability feature should
612
+ # be enabled. Defaults to `false`
613
+ # @param [String] typing_indicator_timeout The duration in seconds indicating the
614
+ # timeout after "started typing" event when client should assume that user is not
615
+ # typing anymore even if no "ended typing" message received
590
616
  # @param [String] consumption_report_interval The consumption_report_interval
591
617
  # @param [Boolean] notifications_new_message_enabled The
592
618
  # notifications.new_message.enabled
@@ -614,15 +640,29 @@ module Twilio
614
640
  # notifications.invited_to_channel.template
615
641
  # @param [String] notifications_invited_to_channel_sound The
616
642
  # notifications.invited_to_channel.sound
617
- # @param [String] pre_webhook_url The pre_webhook_url
618
- # @param [String] post_webhook_url The post_webhook_url
619
- # @param [String] webhook_method The webhook_method
620
- # @param [String] webhook_filters The webhook_filters
621
- # @param [String] limits_channel_members The limits.channel_members
622
- # @param [String] limits_user_channels The limits.user_channels
643
+ # @param [String] pre_webhook_url The webhook URL for PRE-Event webhooks. See
644
+ # [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
645
+ # details.
646
+ # @param [String] post_webhook_url The webhook URL for POST-Event webhooks. See
647
+ # [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
648
+ # details.
649
+ # @param [String] webhook_method The webhook request format to use. Must be POST
650
+ # or GET. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events)
651
+ # for more details.
652
+ # @param [String] webhook_filters The list of WebHook events that are enabled for
653
+ # this Service instance. See [Webhook
654
+ # Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
655
+ # @param [String] limits_channel_members The maximum number of Members that can be
656
+ # added to Channels within this Service. The maximum allowed value is 1,000
657
+ # @param [String] limits_user_channels The maximum number of Channels Users can be
658
+ # a Member of within this Service. The maximum value allowed is 1,000
623
659
  # @param [String] media_compatibility_message The media.compatibility_message
624
- # @param [String] pre_webhook_retry_count The pre_webhook_retry_count
625
- # @param [String] post_webhook_retry_count The post_webhook_retry_count
660
+ # @param [String] pre_webhook_retry_count Count of times webhook will be retried
661
+ # in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
662
+ # count is 0 times.
663
+ # @param [String] post_webhook_retry_count Count of times webhook will be retried
664
+ # in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
665
+ # count is 0 times.
626
666
  # @param [Boolean] notifications_log_enabled The notifications.log_enabled
627
667
  # @return [ServiceInstance] Updated ServiceInstance
628
668
  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)