twilio-ruby 5.9.0 → 5.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
@@ -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)
@@ -36,7 +36,8 @@ module Twilio
36
36
  end
37
37
 
38
38
  ##
39
- # @param [String] sid The sid
39
+ # @param [String] sid A 34 character string that uniquely identifies this
40
+ # resource.
40
41
  # @return [Twilio::REST::Chat::V2::CredentialInstance] if sid was passed.
41
42
  # @return [Twilio::REST::Chat::V2::CredentialList]
42
43
  def credentials(sid=:unset)
@@ -44,7 +45,8 @@ module Twilio
44
45
  end
45
46
 
46
47
  ##
47
- # @param [String] sid The sid
48
+ # @param [String] sid A 34 character string that uniquely identifies this
49
+ # resource.
48
50
  # @return [Twilio::REST::Chat::V2::ServiceInstance] if sid was passed.
49
51
  # @return [Twilio::REST::Chat::V2::ServiceList]
50
52
  def services(sid=:unset)
@@ -108,12 +108,18 @@ module Twilio
108
108
  ##
109
109
  # Retrieve a single page of CredentialInstance records from the API.
110
110
  # Request is executed immediately.
111
- # @param [credential.PushService] type The type
112
- # @param [String] friendly_name The friendly_name
113
- # @param [String] certificate The certificate
114
- # @param [String] private_key The private_key
115
- # @param [Boolean] sandbox The sandbox
116
- # @param [String] api_key The api_key
111
+ # @param [credential.PushService] type Credential type, one of "gcm" or "apn"
112
+ # @param [String] friendly_name Friendly name for stored credential
113
+ # @param [String] certificate [APN only] URL encoded representation of the
114
+ # certificate, e.g. `-----BEGIN
115
+ # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
116
+ # @param [String] private_key [APN only] URL encoded representation of the private
117
+ # key, e.g. `-----BEGIN RSA PRIVATE
118
+ # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
119
+ # @param [Boolean] sandbox [APN only] use this credential for sending to
120
+ # production or sandbox APNs (string `true` or `false`)
121
+ # @param [String] api_key [GCM only] This is the "API key" for project from Google
122
+ # Developer console for your GCM Service application credential
117
123
  # @param [String] secret The secret
118
124
  # @return [CredentialInstance] Newly created CredentialInstance
119
125
  def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -203,11 +209,17 @@ module Twilio
203
209
 
204
210
  ##
205
211
  # Update the CredentialInstance
206
- # @param [String] friendly_name The friendly_name
207
- # @param [String] certificate The certificate
208
- # @param [String] private_key The private_key
209
- # @param [Boolean] sandbox The sandbox
210
- # @param [String] api_key The api_key
212
+ # @param [String] friendly_name Friendly name for stored credential
213
+ # @param [String] certificate [APN only] URL encoded representation of the
214
+ # certificate, e.g. `-----BEGIN
215
+ # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
216
+ # @param [String] private_key [APN only] URL encoded representation of the private
217
+ # key, e.g. `-----BEGIN RSA PRIVATE
218
+ # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
219
+ # @param [Boolean] sandbox [APN only] use this credential for sending to
220
+ # production or sandbox APNs (string `true` or `false`)
221
+ # @param [String] api_key [GCM only] This is the "API key" for project from Google
222
+ # Developer console for your GCM Service application credential
211
223
  # @param [String] secret The secret
212
224
  # @return [CredentialInstance] Updated CredentialInstance
213
225
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -283,49 +295,49 @@ module Twilio
283
295
  end
284
296
 
285
297
  ##
286
- # @return [String] The sid
298
+ # @return [String] A 34 character string that uniquely identifies this resource.
287
299
  def sid
288
300
  @properties['sid']
289
301
  end
290
302
 
291
303
  ##
292
- # @return [String] The account_sid
304
+ # @return [String] The unique id of the Account[/console] responsible for this resource.
293
305
  def account_sid
294
306
  @properties['account_sid']
295
307
  end
296
308
 
297
309
  ##
298
- # @return [String] The friendly_name
310
+ # @return [String] The human-readable name of this resource.
299
311
  def friendly_name
300
312
  @properties['friendly_name']
301
313
  end
302
314
 
303
315
  ##
304
- # @return [credential.PushService] The type
316
+ # @return [credential.PushService] Indicates which push notifications service this credential is for - either gcm or apn
305
317
  def type
306
318
  @properties['type']
307
319
  end
308
320
 
309
321
  ##
310
- # @return [String] The sandbox
322
+ # @return [String] [APN only] true when this resource should use the sandbox APN service.
311
323
  def sandbox
312
324
  @properties['sandbox']
313
325
  end
314
326
 
315
327
  ##
316
- # @return [Time] The date_created
328
+ # @return [Time] The date that this resource was created.
317
329
  def date_created
318
330
  @properties['date_created']
319
331
  end
320
332
 
321
333
  ##
322
- # @return [Time] The date_updated
334
+ # @return [Time] The date that this resource was last updated.
323
335
  def date_updated
324
336
  @properties['date_updated']
325
337
  end
326
338
 
327
339
  ##
328
- # @return [String] The url
340
+ # @return [String] An absolute URL for this credential resource.
329
341
  def url
330
342
  @properties['url']
331
343
  end
@@ -339,11 +351,17 @@ module Twilio
339
351
 
340
352
  ##
341
353
  # Update the CredentialInstance
342
- # @param [String] friendly_name The friendly_name
343
- # @param [String] certificate The certificate
344
- # @param [String] private_key The private_key
345
- # @param [Boolean] sandbox The sandbox
346
- # @param [String] api_key The api_key
354
+ # @param [String] friendly_name Friendly name for stored credential
355
+ # @param [String] certificate [APN only] URL encoded representation of the
356
+ # certificate, e.g. `-----BEGIN
357
+ # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
358
+ # @param [String] private_key [APN only] URL encoded representation of the private
359
+ # key, e.g. `-----BEGIN RSA PRIVATE
360
+ # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
361
+ # @param [Boolean] sandbox [APN only] use this credential for sending to
362
+ # production or sandbox APNs (string `true` or `false`)
363
+ # @param [String] api_key [GCM only] This is the "API key" for project from Google
364
+ # Developer console for your GCM Service application credential
347
365
  # @param [String] secret The secret
348
366
  # @return [CredentialInstance] Updated CredentialInstance
349
367
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -16,8 +16,11 @@ module Twilio
16
16
  ##
17
17
  # Initialize the InviteList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] service_sid The service_sid
20
- # @param [String] channel_sid The channel_sid
19
+ # @param [String] service_sid The unique id of the
20
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service) this member
21
+ # belongs to.
22
+ # @param [String] channel_sid The unique id of the
23
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channel) for this member.
21
24
  # @return [InviteList] InviteList
22
25
  def initialize(version, service_sid: nil, channel_sid: nil)
23
26
  super(version)
@@ -30,8 +33,13 @@ module Twilio
30
33
  ##
31
34
  # Retrieve a single page of InviteInstance records from the API.
32
35
  # Request is executed immediately.
33
- # @param [String] identity The identity
34
- # @param [String] role_sid The role_sid
36
+ # @param [String] identity A unique string identifier for this
37
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
38
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
39
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
40
+ # @param [String] role_sid The
41
+ # [Role](https://www.twilio.com/docs/api/chat/rest/v1/role) assigned to this
42
+ # member.
35
43
  # @return [InviteInstance] Newly created InviteInstance
36
44
  def create(identity: nil, role_sid: :unset)
37
45
  data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
@@ -54,7 +62,10 @@ module Twilio
54
62
  # Lists InviteInstance records from the API as a list.
55
63
  # Unlike stream(), this operation is eager and will load `limit` records into
56
64
  # memory before returning.
57
- # @param [String] identity The identity
65
+ # @param [String] identity A unique string identifier for this
66
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
67
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
68
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
58
69
  # @param [Integer] limit Upper limit for the number of records to return. stream()
59
70
  # guarantees to never return more than limit. Default is no limit
60
71
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -70,7 +81,10 @@ module Twilio
70
81
  # Streams InviteInstance records from the API as an Enumerable.
71
82
  # This operation lazily loads records as efficiently as possible until the limit
72
83
  # is reached.
73
- # @param [String] identity The identity
84
+ # @param [String] identity A unique string identifier for this
85
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
86
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
87
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
74
88
  # @param [Integer] limit Upper limit for the number of records to return. stream()
75
89
  # guarantees to never return more than limit. Default is no limit.
76
90
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -103,7 +117,10 @@ module Twilio
103
117
  ##
104
118
  # Retrieve a single page of InviteInstance records from the API.
105
119
  # Request is executed immediately.
106
- # @param [String] identity The identity
120
+ # @param [String] identity A unique string identifier for this
121
+ # [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
122
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
123
+ # tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
107
124
  # @param [String] page_token PageToken provided by the API
108
125
  # @param [Integer] page_number Page Number, this value is simply for client state
109
126
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -234,8 +251,11 @@ module Twilio
234
251
  # Initialize the InviteInstance
235
252
  # @param [Version] version Version that contains the resource
236
253
  # @param [Hash] payload payload that contains response from Twilio
237
- # @param [String] service_sid The service_sid
238
- # @param [String] channel_sid The channel_sid
254
+ # @param [String] service_sid The unique id of the
255
+ # [Service](https://www.twilio.com/docs/api/chat/rest/v1/service) this member
256
+ # belongs to.
257
+ # @param [String] channel_sid The unique id of the
258
+ # [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channel) for this member.
239
259
  # @param [String] sid The sid
240
260
  # @return [InviteInstance] InviteInstance
241
261
  def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
@@ -281,49 +301,49 @@ module Twilio
281
301
  end
282
302
 
283
303
  ##
284
- # @return [String] The sid
304
+ # @return [String] A 34 character string that uniquely identifies this resource.
285
305
  def sid
286
306
  @properties['sid']
287
307
  end
288
308
 
289
309
  ##
290
- # @return [String] The account_sid
310
+ # @return [String] The unique id of the Account[/console] responsible for this member.
291
311
  def account_sid
292
312
  @properties['account_sid']
293
313
  end
294
314
 
295
315
  ##
296
- # @return [String] The channel_sid
316
+ # @return [String] The unique id of the Channel for this member.
297
317
  def channel_sid
298
318
  @properties['channel_sid']
299
319
  end
300
320
 
301
321
  ##
302
- # @return [String] The service_sid
322
+ # @return [String] The unique id of the Service this member belongs to.
303
323
  def service_sid
304
324
  @properties['service_sid']
305
325
  end
306
326
 
307
327
  ##
308
- # @return [String] The identity
328
+ # @return [String] A unique string identifier for this User in this Service.
309
329
  def identity
310
330
  @properties['identity']
311
331
  end
312
332
 
313
333
  ##
314
- # @return [Time] The date_created
334
+ # @return [Time] The date that this resource was created.
315
335
  def date_created
316
336
  @properties['date_created']
317
337
  end
318
338
 
319
339
  ##
320
- # @return [Time] The date_updated
340
+ # @return [Time] The date that this resource was last updated.
321
341
  def date_updated
322
342
  @properties['date_updated']
323
343
  end
324
344
 
325
345
  ##
326
- # @return [String] The role_sid
346
+ # @return [String] The Role assigned to this member.
327
347
  def role_sid
328
348
  @properties['role_sid']
329
349
  end
@@ -335,7 +355,7 @@ module Twilio
335
355
  end
336
356
 
337
357
  ##
338
- # @return [String] The url
358
+ # @return [String] An absolute URL for this member.
339
359
  def url
340
360
  @properties['url']
341
361
  end