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
@@ -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 resource. It can be up to 64 characters long.
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,8 +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 Twilio-provided string that uniquely identifies the
160
- # Service resource to fetch.
158
+ # @param [String] sid The sid
161
159
  # @return [ServiceContext] ServiceContext
162
160
  def initialize(version, sid)
163
161
  super(version)
@@ -190,149 +188,93 @@ module Twilio
190
188
 
191
189
  ##
192
190
  # Update the ServiceInstance
193
- # @param [String] friendly_name A descriptive string that you create to describe
194
- # the resource. It can be up to 64 characters long.
195
- # @param [String] default_service_role_sid The service role assigned to users when
196
- # they are added to the service. See the {Roles
197
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
198
- # @param [String] default_channel_role_sid The channel role assigned to users when
199
- # they are added to a channel. See the {Roles
200
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
201
- # @param [String] default_channel_creator_role_sid The channel role assigned to a
202
- # channel creator when they join a new channel. See the {Roles
203
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
204
- # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
205
- # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
206
- # default is `true`.
207
- # @param [Boolean] reachability_enabled Whether to enable the {Reachability
208
- # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
209
- # Service instance. The default is `false`.
210
- # @param [String] typing_indicator_timeout How long in seconds after a `started
211
- # typing` event until clients should assume that user is no longer typing, even if
212
- # no `ended typing` message was received. The default is 5 seconds.
213
- # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
214
- # between consumption reports submission batches from client endpoints.
215
- # @param [Boolean] notifications_new_message_enabled Whether to send a
216
- # notification when a new message is added to a channel. Can be: `true` or `false`
217
- # and the default is `false`.
218
- # @param [String] notifications_new_message_template The template to use to create
219
- # the notification text displayed when a new message is added to a channel and
220
- # `notifications.new_message.enabled` is `true`.
221
- # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
222
- # notification when a member is added to a channel. Can be: `true` or `false` and
223
- # the default is `false`.
224
- # @param [String] notifications_added_to_channel_template The template to use to
225
- # create the notification text displayed when a member is added to a channel and
226
- # `notifications.added_to_channel.enabled` is `true`.
227
- # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
228
- # notification to a user when they are removed from a channel. Can be: `true` or
229
- # `false` and the default is `false`.
230
- # @param [String] notifications_removed_from_channel_template The template to use
231
- # to create the notification text displayed to a user when they are removed from a
232
- # channel and `notifications.removed_from_channel.enabled` is `true`.
233
- # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
234
- # notification when a user is invited to a channel. Can be: `true` or `false` and
235
- # the default is `false`.
236
- # @param [String] notifications_invited_to_channel_template The template to use to
237
- # create the notification text displayed when a user is invited to a channel and
238
- # `notifications.invited_to_channel.enabled` is `true`.
239
- # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
240
- # by using the `webhook_method`. See {Webhook
241
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
242
- # @param [String] post_webhook_url The URL for post-event webhooks, which are
243
- # called by using the `webhook_method`. See {Webhook
244
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
245
- # @param [String] webhook_method The HTTP method to use for calls to the
246
- # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
247
- # the default is `POST`. See {Webhook
248
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
249
- # @param [String] webhook_filters The list of WebHook events that are enabled for
250
- # this Service instance. See {Webhook
251
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
252
- # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
253
- # response to the `on_message_send` event using the
254
- # `webhooks.on_message_send.method` HTTP method.
255
- # @param [String] webhooks_on_message_send_method The HTTP method to use when
256
- # calling the `webhooks.on_message_send.url`.
257
- # @param [String] webhooks_on_message_update_url The URL of the webhook to call in
258
- # response to the `on_message_update` event using the
259
- # `webhooks.on_message_update.method` HTTP method.
260
- # @param [String] webhooks_on_message_update_method The HTTP method to use when
261
- # calling the `webhooks.on_message_update.url`.
262
- # @param [String] webhooks_on_message_remove_url The URL of the webhook to call in
263
- # response to the `on_message_remove` event using the
264
- # `webhooks.on_message_remove.method` HTTP method.
265
- # @param [String] webhooks_on_message_remove_method The HTTP method to use when
266
- # calling the `webhooks.on_message_remove.url`.
267
- # @param [String] webhooks_on_channel_add_url The URL of the webhook to call in
268
- # response to the `on_channel_add` event using the
269
- # `webhooks.on_channel_add.method` HTTP method.
270
- # @param [String] webhooks_on_channel_add_method The HTTP method to use when
271
- # calling the `webhooks.on_channel_add.url`.
272
- # @param [String] webhooks_on_channel_destroy_url The URL of the webhook to call
273
- # in response to the `on_channel_destroy` event using the
274
- # `webhooks.on_channel_destroy.method` HTTP method.
275
- # @param [String] webhooks_on_channel_destroy_method The HTTP method to use when
276
- # calling the `webhooks.on_channel_destroy.url`.
277
- # @param [String] webhooks_on_channel_update_url The URL of the webhook to call in
278
- # response to the `on_channel_update` event using the
279
- # `webhooks.on_channel_update.method` HTTP method.
280
- # @param [String] webhooks_on_channel_update_method The HTTP method to use when
281
- # calling the `webhooks.on_channel_update.url`.
282
- # @param [String] webhooks_on_member_add_url The URL of the webhook to call in
283
- # response to the `on_member_add` event using the `webhooks.on_member_add.method`
284
- # HTTP method.
285
- # @param [String] webhooks_on_member_add_method The HTTP method to use when
286
- # calling the `webhooks.on_member_add.url`.
287
- # @param [String] webhooks_on_member_remove_url The URL of the webhook to call in
288
- # response to the `on_member_remove` event using the
289
- # `webhooks.on_member_remove.method` HTTP method.
290
- # @param [String] webhooks_on_member_remove_method The HTTP method to use when
291
- # calling the `webhooks.on_member_remove.url`.
292
- # @param [String] webhooks_on_message_sent_url The URL of the webhook to call in
293
- # response to the `on_message_sent` event using the
294
- # `webhooks.on_message_sent.method` HTTP method.
295
- # @param [String] webhooks_on_message_sent_method The URL of the webhook to call
296
- # in response to the `on_message_sent` event`.
297
- # @param [String] webhooks_on_message_updated_url The URL of the webhook to call
298
- # in response to the `on_message_updated` event using the
299
- # `webhooks.on_message_updated.method` HTTP method.
300
- # @param [String] webhooks_on_message_updated_method The HTTP method to use when
301
- # calling the `webhooks.on_message_updated.url`.
302
- # @param [String] webhooks_on_message_removed_url The URL of the webhook to call
303
- # in response to the `on_message_removed` event using the
304
- # `webhooks.on_message_removed.method` HTTP method.
305
- # @param [String] webhooks_on_message_removed_method The HTTP method to use when
306
- # calling the `webhooks.on_message_removed.url`.
307
- # @param [String] webhooks_on_channel_added_url The URL of the webhook to call in
308
- # response to the `on_channel_added` event using the
309
- # `webhooks.on_channel_added.method` HTTP method.
310
- # @param [String] webhooks_on_channel_added_method The URL of the webhook to call
311
- # in response to the `on_channel_added` event`.
312
- # @param [String] webhooks_on_channel_destroyed_url The URL of the webhook to call
313
- # in response to the `on_channel_added` event using the
314
- # `webhooks.on_channel_destroyed.method` HTTP method.
315
- # @param [String] webhooks_on_channel_destroyed_method The HTTP method to use when
316
- # calling the `webhooks.on_channel_destroyed.url`.
317
- # @param [String] webhooks_on_channel_updated_url The URL of the webhook to call
318
- # in response to the `on_channel_updated` event using the
319
- # `webhooks.on_channel_updated.method` HTTP method.
320
- # @param [String] webhooks_on_channel_updated_method The HTTP method to use when
321
- # calling the `webhooks.on_channel_updated.url`.
322
- # @param [String] webhooks_on_member_added_url The URL of the webhook to call in
323
- # response to the `on_channel_updated` event using the
324
- # `webhooks.on_channel_updated.method` HTTP method.
325
- # @param [String] webhooks_on_member_added_method The HTTP method to use when
326
- # calling the `webhooks.on_channel_updated.url`.
327
- # @param [String] webhooks_on_member_removed_url The URL of the webhook to call in
328
- # response to the `on_member_removed` event using the
329
- # `webhooks.on_member_removed.method` HTTP method.
330
- # @param [String] webhooks_on_member_removed_method The HTTP method to use when
331
- # calling the `webhooks.on_member_removed.url`.
332
- # @param [String] limits_channel_members The maximum number of Members that can be
333
- # added to Channels within this Service. Can be up to 1,000.
334
- # @param [String] limits_user_channels The maximum number of Channels Users can be
335
- # a Member of within this Service. Can be up to 1,000.
191
+ # @param [String] friendly_name The friendly_name
192
+ # @param [String] default_service_role_sid The default_service_role_sid
193
+ # @param [String] default_channel_role_sid The default_channel_role_sid
194
+ # @param [String] default_channel_creator_role_sid The
195
+ # default_channel_creator_role_sid
196
+ # @param [Boolean] read_status_enabled The read_status_enabled
197
+ # @param [Boolean] reachability_enabled The reachability_enabled
198
+ # @param [String] typing_indicator_timeout The typing_indicator_timeout
199
+ # @param [String] consumption_report_interval The consumption_report_interval
200
+ # @param [Boolean] notifications_new_message_enabled The
201
+ # notifications.new_message.enabled
202
+ # @param [String] notifications_new_message_template The
203
+ # notifications.new_message.template
204
+ # @param [Boolean] notifications_added_to_channel_enabled The
205
+ # notifications.added_to_channel.enabled
206
+ # @param [String] notifications_added_to_channel_template The
207
+ # notifications.added_to_channel.template
208
+ # @param [Boolean] notifications_removed_from_channel_enabled The
209
+ # notifications.removed_from_channel.enabled
210
+ # @param [String] notifications_removed_from_channel_template The
211
+ # notifications.removed_from_channel.template
212
+ # @param [Boolean] notifications_invited_to_channel_enabled The
213
+ # notifications.invited_to_channel.enabled
214
+ # @param [String] notifications_invited_to_channel_template The
215
+ # notifications.invited_to_channel.template
216
+ # @param [String] pre_webhook_url The pre_webhook_url
217
+ # @param [String] post_webhook_url The post_webhook_url
218
+ # @param [String] webhook_method The webhook_method
219
+ # @param [String] webhook_filters The webhook_filters
220
+ # @param [String] webhooks_on_message_send_url The webhooks.on_message_send.url
221
+ # @param [String] webhooks_on_message_send_method The
222
+ # webhooks.on_message_send.method
223
+ # @param [String] webhooks_on_message_update_url The
224
+ # webhooks.on_message_update.url
225
+ # @param [String] webhooks_on_message_update_method The
226
+ # webhooks.on_message_update.method
227
+ # @param [String] webhooks_on_message_remove_url The
228
+ # webhooks.on_message_remove.url
229
+ # @param [String] webhooks_on_message_remove_method The
230
+ # webhooks.on_message_remove.method
231
+ # @param [String] webhooks_on_channel_add_url The webhooks.on_channel_add.url
232
+ # @param [String] webhooks_on_channel_add_method The
233
+ # webhooks.on_channel_add.method
234
+ # @param [String] webhooks_on_channel_destroy_url The
235
+ # webhooks.on_channel_destroy.url
236
+ # @param [String] webhooks_on_channel_destroy_method The
237
+ # webhooks.on_channel_destroy.method
238
+ # @param [String] webhooks_on_channel_update_url The
239
+ # webhooks.on_channel_update.url
240
+ # @param [String] webhooks_on_channel_update_method The
241
+ # webhooks.on_channel_update.method
242
+ # @param [String] webhooks_on_member_add_url The webhooks.on_member_add.url
243
+ # @param [String] webhooks_on_member_add_method The webhooks.on_member_add.method
244
+ # @param [String] webhooks_on_member_remove_url The webhooks.on_member_remove.url
245
+ # @param [String] webhooks_on_member_remove_method The
246
+ # webhooks.on_member_remove.method
247
+ # @param [String] webhooks_on_message_sent_url The webhooks.on_message_sent.url
248
+ # @param [String] webhooks_on_message_sent_method The
249
+ # webhooks.on_message_sent.method
250
+ # @param [String] webhooks_on_message_updated_url The
251
+ # webhooks.on_message_updated.url
252
+ # @param [String] webhooks_on_message_updated_method The
253
+ # webhooks.on_message_updated.method
254
+ # @param [String] webhooks_on_message_removed_url The
255
+ # webhooks.on_message_removed.url
256
+ # @param [String] webhooks_on_message_removed_method The
257
+ # webhooks.on_message_removed.method
258
+ # @param [String] webhooks_on_channel_added_url The webhooks.on_channel_added.url
259
+ # @param [String] webhooks_on_channel_added_method The
260
+ # webhooks.on_channel_added.method
261
+ # @param [String] webhooks_on_channel_destroyed_url The
262
+ # webhooks.on_channel_destroyed.url
263
+ # @param [String] webhooks_on_channel_destroyed_method The
264
+ # webhooks.on_channel_destroyed.method
265
+ # @param [String] webhooks_on_channel_updated_url The
266
+ # webhooks.on_channel_updated.url
267
+ # @param [String] webhooks_on_channel_updated_method The
268
+ # webhooks.on_channel_updated.method
269
+ # @param [String] webhooks_on_member_added_url The webhooks.on_member_added.url
270
+ # @param [String] webhooks_on_member_added_method The
271
+ # webhooks.on_member_added.method
272
+ # @param [String] webhooks_on_member_removed_url The
273
+ # webhooks.on_member_removed.url
274
+ # @param [String] webhooks_on_member_removed_method The
275
+ # webhooks.on_member_removed.method
276
+ # @param [String] limits_channel_members The limits.channel_members
277
+ # @param [String] limits_user_channels The limits.user_channels
336
278
  # @return [ServiceInstance] Updated ServiceInstance
337
279
  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_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset)
338
280
  data = Twilio::Values.of({
@@ -471,8 +413,7 @@ module Twilio
471
413
  # Initialize the ServiceInstance
472
414
  # @param [Version] version Version that contains the resource
473
415
  # @param [Hash] payload payload that contains response from Twilio
474
- # @param [String] sid The Twilio-provided string that uniquely identifies the
475
- # Service resource to fetch.
416
+ # @param [String] sid The sid
476
417
  # @return [ServiceInstance] ServiceInstance
477
418
  def initialize(version, payload, sid: nil)
478
419
  super(version)
@@ -519,127 +460,127 @@ module Twilio
519
460
  end
520
461
 
521
462
  ##
522
- # @return [String] The unique string that identifies the resource
463
+ # @return [String] The sid
523
464
  def sid
524
465
  @properties['sid']
525
466
  end
526
467
 
527
468
  ##
528
- # @return [String] The SID of the Account that created the resource
469
+ # @return [String] The account_sid
529
470
  def account_sid
530
471
  @properties['account_sid']
531
472
  end
532
473
 
533
474
  ##
534
- # @return [String] The string that you assigned to describe the resource
475
+ # @return [String] The friendly_name
535
476
  def friendly_name
536
477
  @properties['friendly_name']
537
478
  end
538
479
 
539
480
  ##
540
- # @return [Time] The RFC 2822 date and time in GMT when the resource was created
481
+ # @return [Time] The date_created
541
482
  def date_created
542
483
  @properties['date_created']
543
484
  end
544
485
 
545
486
  ##
546
- # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
487
+ # @return [Time] The date_updated
547
488
  def date_updated
548
489
  @properties['date_updated']
549
490
  end
550
491
 
551
492
  ##
552
- # @return [String] The service role assigned to users when they are added to the service
493
+ # @return [String] The default_service_role_sid
553
494
  def default_service_role_sid
554
495
  @properties['default_service_role_sid']
555
496
  end
556
497
 
557
498
  ##
558
- # @return [String] The channel role assigned to users when they are added to a channel
499
+ # @return [String] The default_channel_role_sid
559
500
  def default_channel_role_sid
560
501
  @properties['default_channel_role_sid']
561
502
  end
562
503
 
563
504
  ##
564
- # @return [String] The channel role assigned to a channel creator when they join a new channel
505
+ # @return [String] The default_channel_creator_role_sid
565
506
  def default_channel_creator_role_sid
566
507
  @properties['default_channel_creator_role_sid']
567
508
  end
568
509
 
569
510
  ##
570
- # @return [Boolean] Whether the Message Consumption Horizon feature is enabled
511
+ # @return [Boolean] The read_status_enabled
571
512
  def read_status_enabled
572
513
  @properties['read_status_enabled']
573
514
  end
574
515
 
575
516
  ##
576
- # @return [Boolean] Whether the Reachability Indicator feature is enabled for this Service instance
517
+ # @return [Boolean] The reachability_enabled
577
518
  def reachability_enabled
578
519
  @properties['reachability_enabled']
579
520
  end
580
521
 
581
522
  ##
582
- # @return [String] How long in seconds to wait before assuming the user is no longer typing
523
+ # @return [String] The typing_indicator_timeout
583
524
  def typing_indicator_timeout
584
525
  @properties['typing_indicator_timeout']
585
526
  end
586
527
 
587
528
  ##
588
- # @return [String] DEPRECATED
529
+ # @return [String] The consumption_report_interval
589
530
  def consumption_report_interval
590
531
  @properties['consumption_report_interval']
591
532
  end
592
533
 
593
534
  ##
594
- # @return [Hash] An object that describes the limits of the service instance
535
+ # @return [Hash] The limits
595
536
  def limits
596
537
  @properties['limits']
597
538
  end
598
539
 
599
540
  ##
600
- # @return [Hash] An object that contains information about the webhooks configured for this service
541
+ # @return [Hash] The webhooks
601
542
  def webhooks
602
543
  @properties['webhooks']
603
544
  end
604
545
 
605
546
  ##
606
- # @return [String] The webhook URL for pre-event webhooks
547
+ # @return [String] The pre_webhook_url
607
548
  def pre_webhook_url
608
549
  @properties['pre_webhook_url']
609
550
  end
610
551
 
611
552
  ##
612
- # @return [String] The URL for post-event webhooks
553
+ # @return [String] The post_webhook_url
613
554
  def post_webhook_url
614
555
  @properties['post_webhook_url']
615
556
  end
616
557
 
617
558
  ##
618
- # @return [String] The HTTP method to use for both PRE and POST webhooks
559
+ # @return [String] The webhook_method
619
560
  def webhook_method
620
561
  @properties['webhook_method']
621
562
  end
622
563
 
623
564
  ##
624
- # @return [String] The list of WebHook events that are enabled for this Service instance
565
+ # @return [String] The webhook_filters
625
566
  def webhook_filters
626
567
  @properties['webhook_filters']
627
568
  end
628
569
 
629
570
  ##
630
- # @return [Hash] The notification configuration for the Service instance
571
+ # @return [Hash] The notifications
631
572
  def notifications
632
573
  @properties['notifications']
633
574
  end
634
575
 
635
576
  ##
636
- # @return [String] The absolute URL of the Service resource
577
+ # @return [String] The url
637
578
  def url
638
579
  @properties['url']
639
580
  end
640
581
 
641
582
  ##
642
- # @return [String] The absolute URLs of the Service's Channels, Roles, and Users
583
+ # @return [String] The links
643
584
  def links
644
585
  @properties['links']
645
586
  end
@@ -660,149 +601,93 @@ module Twilio
660
601
 
661
602
  ##
662
603
  # Update the ServiceInstance
663
- # @param [String] friendly_name A descriptive string that you create to describe
664
- # the resource. It can be up to 64 characters long.
665
- # @param [String] default_service_role_sid The service role assigned to users when
666
- # they are added to the service. See the {Roles
667
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
668
- # @param [String] default_channel_role_sid The channel role assigned to users when
669
- # they are added to a channel. See the {Roles
670
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
671
- # @param [String] default_channel_creator_role_sid The channel role assigned to a
672
- # channel creator when they join a new channel. See the {Roles
673
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
674
- # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
675
- # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
676
- # default is `true`.
677
- # @param [Boolean] reachability_enabled Whether to enable the {Reachability
678
- # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
679
- # Service instance. The default is `false`.
680
- # @param [String] typing_indicator_timeout How long in seconds after a `started
681
- # typing` event until clients should assume that user is no longer typing, even if
682
- # no `ended typing` message was received. The default is 5 seconds.
683
- # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
684
- # between consumption reports submission batches from client endpoints.
685
- # @param [Boolean] notifications_new_message_enabled Whether to send a
686
- # notification when a new message is added to a channel. Can be: `true` or `false`
687
- # and the default is `false`.
688
- # @param [String] notifications_new_message_template The template to use to create
689
- # the notification text displayed when a new message is added to a channel and
690
- # `notifications.new_message.enabled` is `true`.
691
- # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
692
- # notification when a member is added to a channel. Can be: `true` or `false` and
693
- # the default is `false`.
694
- # @param [String] notifications_added_to_channel_template The template to use to
695
- # create the notification text displayed when a member is added to a channel and
696
- # `notifications.added_to_channel.enabled` is `true`.
697
- # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
698
- # notification to a user when they are removed from a channel. Can be: `true` or
699
- # `false` and the default is `false`.
700
- # @param [String] notifications_removed_from_channel_template The template to use
701
- # to create the notification text displayed to a user when they are removed from a
702
- # channel and `notifications.removed_from_channel.enabled` is `true`.
703
- # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
704
- # notification when a user is invited to a channel. Can be: `true` or `false` and
705
- # the default is `false`.
706
- # @param [String] notifications_invited_to_channel_template The template to use to
707
- # create the notification text displayed when a user is invited to a channel and
708
- # `notifications.invited_to_channel.enabled` is `true`.
709
- # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
710
- # by using the `webhook_method`. See {Webhook
711
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
712
- # @param [String] post_webhook_url The URL for post-event webhooks, which are
713
- # called by using the `webhook_method`. See {Webhook
714
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
715
- # @param [String] webhook_method The HTTP method to use for calls to the
716
- # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
717
- # the default is `POST`. See {Webhook
718
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
719
- # @param [String] webhook_filters The list of WebHook events that are enabled for
720
- # this Service instance. See {Webhook
721
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
722
- # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
723
- # response to the `on_message_send` event using the
724
- # `webhooks.on_message_send.method` HTTP method.
725
- # @param [String] webhooks_on_message_send_method The HTTP method to use when
726
- # calling the `webhooks.on_message_send.url`.
727
- # @param [String] webhooks_on_message_update_url The URL of the webhook to call in
728
- # response to the `on_message_update` event using the
729
- # `webhooks.on_message_update.method` HTTP method.
730
- # @param [String] webhooks_on_message_update_method The HTTP method to use when
731
- # calling the `webhooks.on_message_update.url`.
732
- # @param [String] webhooks_on_message_remove_url The URL of the webhook to call in
733
- # response to the `on_message_remove` event using the
734
- # `webhooks.on_message_remove.method` HTTP method.
735
- # @param [String] webhooks_on_message_remove_method The HTTP method to use when
736
- # calling the `webhooks.on_message_remove.url`.
737
- # @param [String] webhooks_on_channel_add_url The URL of the webhook to call in
738
- # response to the `on_channel_add` event using the
739
- # `webhooks.on_channel_add.method` HTTP method.
740
- # @param [String] webhooks_on_channel_add_method The HTTP method to use when
741
- # calling the `webhooks.on_channel_add.url`.
742
- # @param [String] webhooks_on_channel_destroy_url The URL of the webhook to call
743
- # in response to the `on_channel_destroy` event using the
744
- # `webhooks.on_channel_destroy.method` HTTP method.
745
- # @param [String] webhooks_on_channel_destroy_method The HTTP method to use when
746
- # calling the `webhooks.on_channel_destroy.url`.
747
- # @param [String] webhooks_on_channel_update_url The URL of the webhook to call in
748
- # response to the `on_channel_update` event using the
749
- # `webhooks.on_channel_update.method` HTTP method.
750
- # @param [String] webhooks_on_channel_update_method The HTTP method to use when
751
- # calling the `webhooks.on_channel_update.url`.
752
- # @param [String] webhooks_on_member_add_url The URL of the webhook to call in
753
- # response to the `on_member_add` event using the `webhooks.on_member_add.method`
754
- # HTTP method.
755
- # @param [String] webhooks_on_member_add_method The HTTP method to use when
756
- # calling the `webhooks.on_member_add.url`.
757
- # @param [String] webhooks_on_member_remove_url The URL of the webhook to call in
758
- # response to the `on_member_remove` event using the
759
- # `webhooks.on_member_remove.method` HTTP method.
760
- # @param [String] webhooks_on_member_remove_method The HTTP method to use when
761
- # calling the `webhooks.on_member_remove.url`.
762
- # @param [String] webhooks_on_message_sent_url The URL of the webhook to call in
763
- # response to the `on_message_sent` event using the
764
- # `webhooks.on_message_sent.method` HTTP method.
765
- # @param [String] webhooks_on_message_sent_method The URL of the webhook to call
766
- # in response to the `on_message_sent` event`.
767
- # @param [String] webhooks_on_message_updated_url The URL of the webhook to call
768
- # in response to the `on_message_updated` event using the
769
- # `webhooks.on_message_updated.method` HTTP method.
770
- # @param [String] webhooks_on_message_updated_method The HTTP method to use when
771
- # calling the `webhooks.on_message_updated.url`.
772
- # @param [String] webhooks_on_message_removed_url The URL of the webhook to call
773
- # in response to the `on_message_removed` event using the
774
- # `webhooks.on_message_removed.method` HTTP method.
775
- # @param [String] webhooks_on_message_removed_method The HTTP method to use when
776
- # calling the `webhooks.on_message_removed.url`.
777
- # @param [String] webhooks_on_channel_added_url The URL of the webhook to call in
778
- # response to the `on_channel_added` event using the
779
- # `webhooks.on_channel_added.method` HTTP method.
780
- # @param [String] webhooks_on_channel_added_method The URL of the webhook to call
781
- # in response to the `on_channel_added` event`.
782
- # @param [String] webhooks_on_channel_destroyed_url The URL of the webhook to call
783
- # in response to the `on_channel_added` event using the
784
- # `webhooks.on_channel_destroyed.method` HTTP method.
785
- # @param [String] webhooks_on_channel_destroyed_method The HTTP method to use when
786
- # calling the `webhooks.on_channel_destroyed.url`.
787
- # @param [String] webhooks_on_channel_updated_url The URL of the webhook to call
788
- # in response to the `on_channel_updated` event using the
789
- # `webhooks.on_channel_updated.method` HTTP method.
790
- # @param [String] webhooks_on_channel_updated_method The HTTP method to use when
791
- # calling the `webhooks.on_channel_updated.url`.
792
- # @param [String] webhooks_on_member_added_url The URL of the webhook to call in
793
- # response to the `on_channel_updated` event using the
794
- # `webhooks.on_channel_updated.method` HTTP method.
795
- # @param [String] webhooks_on_member_added_method The HTTP method to use when
796
- # calling the `webhooks.on_channel_updated.url`.
797
- # @param [String] webhooks_on_member_removed_url The URL of the webhook to call in
798
- # response to the `on_member_removed` event using the
799
- # `webhooks.on_member_removed.method` HTTP method.
800
- # @param [String] webhooks_on_member_removed_method The HTTP method to use when
801
- # calling the `webhooks.on_member_removed.url`.
802
- # @param [String] limits_channel_members The maximum number of Members that can be
803
- # added to Channels within this Service. Can be up to 1,000.
804
- # @param [String] limits_user_channels The maximum number of Channels Users can be
805
- # a Member of within this Service. Can be up to 1,000.
604
+ # @param [String] friendly_name The friendly_name
605
+ # @param [String] default_service_role_sid The default_service_role_sid
606
+ # @param [String] default_channel_role_sid The default_channel_role_sid
607
+ # @param [String] default_channel_creator_role_sid The
608
+ # default_channel_creator_role_sid
609
+ # @param [Boolean] read_status_enabled The read_status_enabled
610
+ # @param [Boolean] reachability_enabled The reachability_enabled
611
+ # @param [String] typing_indicator_timeout The typing_indicator_timeout
612
+ # @param [String] consumption_report_interval The consumption_report_interval
613
+ # @param [Boolean] notifications_new_message_enabled The
614
+ # notifications.new_message.enabled
615
+ # @param [String] notifications_new_message_template The
616
+ # notifications.new_message.template
617
+ # @param [Boolean] notifications_added_to_channel_enabled The
618
+ # notifications.added_to_channel.enabled
619
+ # @param [String] notifications_added_to_channel_template The
620
+ # notifications.added_to_channel.template
621
+ # @param [Boolean] notifications_removed_from_channel_enabled The
622
+ # notifications.removed_from_channel.enabled
623
+ # @param [String] notifications_removed_from_channel_template The
624
+ # notifications.removed_from_channel.template
625
+ # @param [Boolean] notifications_invited_to_channel_enabled The
626
+ # notifications.invited_to_channel.enabled
627
+ # @param [String] notifications_invited_to_channel_template The
628
+ # notifications.invited_to_channel.template
629
+ # @param [String] pre_webhook_url The pre_webhook_url
630
+ # @param [String] post_webhook_url The post_webhook_url
631
+ # @param [String] webhook_method The webhook_method
632
+ # @param [String] webhook_filters The webhook_filters
633
+ # @param [String] webhooks_on_message_send_url The webhooks.on_message_send.url
634
+ # @param [String] webhooks_on_message_send_method The
635
+ # webhooks.on_message_send.method
636
+ # @param [String] webhooks_on_message_update_url The
637
+ # webhooks.on_message_update.url
638
+ # @param [String] webhooks_on_message_update_method The
639
+ # webhooks.on_message_update.method
640
+ # @param [String] webhooks_on_message_remove_url The
641
+ # webhooks.on_message_remove.url
642
+ # @param [String] webhooks_on_message_remove_method The
643
+ # webhooks.on_message_remove.method
644
+ # @param [String] webhooks_on_channel_add_url The webhooks.on_channel_add.url
645
+ # @param [String] webhooks_on_channel_add_method The
646
+ # webhooks.on_channel_add.method
647
+ # @param [String] webhooks_on_channel_destroy_url The
648
+ # webhooks.on_channel_destroy.url
649
+ # @param [String] webhooks_on_channel_destroy_method The
650
+ # webhooks.on_channel_destroy.method
651
+ # @param [String] webhooks_on_channel_update_url The
652
+ # webhooks.on_channel_update.url
653
+ # @param [String] webhooks_on_channel_update_method The
654
+ # webhooks.on_channel_update.method
655
+ # @param [String] webhooks_on_member_add_url The webhooks.on_member_add.url
656
+ # @param [String] webhooks_on_member_add_method The webhooks.on_member_add.method
657
+ # @param [String] webhooks_on_member_remove_url The webhooks.on_member_remove.url
658
+ # @param [String] webhooks_on_member_remove_method The
659
+ # webhooks.on_member_remove.method
660
+ # @param [String] webhooks_on_message_sent_url The webhooks.on_message_sent.url
661
+ # @param [String] webhooks_on_message_sent_method The
662
+ # webhooks.on_message_sent.method
663
+ # @param [String] webhooks_on_message_updated_url The
664
+ # webhooks.on_message_updated.url
665
+ # @param [String] webhooks_on_message_updated_method The
666
+ # webhooks.on_message_updated.method
667
+ # @param [String] webhooks_on_message_removed_url The
668
+ # webhooks.on_message_removed.url
669
+ # @param [String] webhooks_on_message_removed_method The
670
+ # webhooks.on_message_removed.method
671
+ # @param [String] webhooks_on_channel_added_url The webhooks.on_channel_added.url
672
+ # @param [String] webhooks_on_channel_added_method The
673
+ # webhooks.on_channel_added.method
674
+ # @param [String] webhooks_on_channel_destroyed_url The
675
+ # webhooks.on_channel_destroyed.url
676
+ # @param [String] webhooks_on_channel_destroyed_method The
677
+ # webhooks.on_channel_destroyed.method
678
+ # @param [String] webhooks_on_channel_updated_url The
679
+ # webhooks.on_channel_updated.url
680
+ # @param [String] webhooks_on_channel_updated_method The
681
+ # webhooks.on_channel_updated.method
682
+ # @param [String] webhooks_on_member_added_url The webhooks.on_member_added.url
683
+ # @param [String] webhooks_on_member_added_method The
684
+ # webhooks.on_member_added.method
685
+ # @param [String] webhooks_on_member_removed_url The
686
+ # webhooks.on_member_removed.url
687
+ # @param [String] webhooks_on_member_removed_method The
688
+ # webhooks.on_member_removed.method
689
+ # @param [String] limits_channel_members The limits.channel_members
690
+ # @param [String] limits_user_channels The limits.user_channels
806
691
  # @return [ServiceInstance] Updated ServiceInstance
807
692
  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_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset)
808
693
  context.update(