twilio-ruby 5.44.0 → 5.47.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (185) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +1 -0
  3. data/CHANGES.md +97 -0
  4. data/LICENSE +1 -1
  5. data/README.md +16 -2
  6. data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +1 -1
  7. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +14 -9
  8. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +13 -13
  9. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +1 -1
  10. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +10 -5
  11. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +17 -12
  12. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +3 -3
  13. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +5 -5
  14. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +6 -3
  15. data/lib/twilio-ruby/rest/api/v2010/account/token.rb +1 -1
  16. data/lib/twilio-ruby/rest/bulkexports.rb +4 -2
  17. data/lib/twilio-ruby/rest/bulkexports/v1.rb +4 -2
  18. data/lib/twilio-ruby/rest/bulkexports/v1/export.rb +7 -4
  19. data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +7 -4
  20. data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb +5 -3
  21. data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb +5 -3
  22. data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb +5 -3
  23. data/lib/twilio-ruby/rest/chat/v1/service.rb +5 -5
  24. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +6 -6
  25. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +3 -3
  26. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +3 -3
  27. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +9 -9
  28. data/lib/twilio-ruby/rest/chat/v2/service.rb +5 -5
  29. data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +7 -7
  30. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +6 -6
  31. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +3 -3
  32. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +3 -3
  33. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +27 -24
  34. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +9 -9
  35. data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +10 -10
  36. data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb +9 -9
  37. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +1 -1
  38. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +32 -2
  39. data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +9 -9
  40. data/lib/twilio-ruby/rest/conversations/v1/role.rb +9 -9
  41. data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +7 -7
  42. data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +17 -2
  43. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +1 -1
  44. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +32 -2
  45. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +9 -9
  46. data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +9 -9
  47. data/lib/twilio-ruby/rest/conversations/v1/service/user.rb +8 -1
  48. data/lib/twilio-ruby/rest/conversations/v1/user.rb +8 -1
  49. data/lib/twilio-ruby/rest/events/v1/sink.rb +4 -2
  50. data/lib/twilio-ruby/rest/events/v1/subscription.rb +3 -2
  51. data/lib/twilio-ruby/rest/flex_api.rb +1 -1
  52. data/lib/twilio-ruby/rest/flex_api/v1.rb +1 -1
  53. data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +5 -5
  54. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +18 -4
  55. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +88 -76
  56. data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +2 -2
  57. data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +8 -9
  58. data/lib/twilio-ruby/rest/insights/v1/room.rb +7 -7
  59. data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +1 -1
  60. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +3 -3
  61. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +3 -3
  62. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +3 -3
  63. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +3 -3
  64. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +4 -4
  65. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +3 -3
  66. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +7 -7
  67. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +3 -3
  68. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +3 -3
  69. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +3 -3
  70. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +6 -6
  71. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +4 -4
  72. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +4 -4
  73. data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +16 -16
  74. data/lib/twilio-ruby/rest/messaging.rb +22 -0
  75. data/lib/twilio-ruby/rest/messaging/v1.rb +37 -0
  76. data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb +328 -0
  77. data/lib/twilio-ruby/rest/messaging/v1/campaign.rb +387 -0
  78. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +1 -1
  79. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +1 -1
  80. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +1 -1
  81. data/lib/twilio-ruby/rest/messaging/v1/use_case.rb +198 -0
  82. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +16 -15
  83. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +18 -18
  84. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb +1 -1
  85. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb +1 -1
  86. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb +1 -1
  87. data/lib/twilio-ruby/rest/preview.rb +4 -23
  88. data/lib/twilio-ruby/rest/preview/bulk_exports.rb +4 -2
  89. data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb +7 -4
  90. data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb +7 -4
  91. data/lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb +5 -3
  92. data/lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb +5 -3
  93. data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb +5 -3
  94. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +13 -13
  95. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +2 -2
  96. data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +8 -8
  97. data/lib/twilio-ruby/rest/preview/sync/service/document.rb +4 -8
  98. data/lib/twilio-ruby/rest/preview/trusted_comms.rb +0 -30
  99. data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +2 -2
  100. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +2 -2
  101. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +1 -1
  102. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +2 -2
  103. data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +2 -2
  104. data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +1 -1
  105. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +1 -1
  106. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb +1 -1
  107. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +17 -7
  108. data/lib/twilio-ruby/rest/studio/v2/flow.rb +6 -14
  109. data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +0 -8
  110. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_context.rb +0 -8
  111. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb +0 -8
  112. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step/execution_step_context.rb +0 -8
  113. data/lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb +2 -10
  114. data/lib/twilio-ruby/rest/studio/v2/flow/test_user.rb +10 -16
  115. data/lib/twilio-ruby/rest/studio/v2/flow_validate.rb +6 -11
  116. data/lib/twilio-ruby/rest/supersim/v1/command.rb +4 -4
  117. data/lib/twilio-ruby/rest/supersim/v1/fleet.rb +33 -12
  118. data/lib/twilio-ruby/rest/supersim/v1/network.rb +5 -5
  119. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb +6 -6
  120. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile/network_access_profile_network.rb +5 -5
  121. data/lib/twilio-ruby/rest/supersim/v1/sim.rb +4 -4
  122. data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +3 -3
  123. data/lib/twilio-ruby/rest/sync/v1/service.rb +0 -8
  124. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +16 -36
  125. data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +0 -8
  126. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +9 -25
  127. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +24 -43
  128. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +0 -8
  129. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +9 -25
  130. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +25 -44
  131. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +1 -9
  132. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +5 -23
  133. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +1 -7
  134. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +17 -17
  135. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +10 -10
  136. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +1 -1
  137. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +10 -10
  138. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +1 -1
  139. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +1 -1
  140. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +1 -1
  141. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +1 -1
  142. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +3 -3
  143. data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +1 -1
  144. data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb +10 -10
  145. data/lib/twilio-ruby/rest/video/v1/composition.rb +16 -15
  146. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +26 -26
  147. data/lib/twilio-ruby/rest/video/v1/composition_settings.rb +6 -6
  148. data/lib/twilio-ruby/rest/video/v1/recording.rb +6 -6
  149. data/lib/twilio-ruby/rest/video/v1/recording_settings.rb +6 -6
  150. data/lib/twilio-ruby/rest/video/v1/room.rb +10 -3
  151. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +1 -1
  152. data/lib/twilio-ruby/rest/video/v1/room/room_recording_rule.rb +1 -1
  153. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +1 -1
  154. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +4 -4
  155. data/lib/twilio-ruby/twiml/voice_response.rb +18 -8
  156. data/lib/twilio-ruby/version.rb +1 -1
  157. data/spec/integration/api/v2010/account/conference_spec.rb +302 -44
  158. data/spec/integration/conversations/v1/conversation/participant_spec.rb +30 -10
  159. data/spec/integration/conversations/v1/service/configuration_spec.rb +2 -0
  160. data/spec/integration/conversations/v1/service/conversation/participant_spec.rb +30 -10
  161. data/spec/integration/conversations/v1/service/user_spec.rb +9 -4
  162. data/spec/integration/conversations/v1/user_spec.rb +9 -4
  163. data/spec/integration/events/v1/sink_spec.rb +14 -0
  164. data/spec/integration/flex_api/v1/configuration_spec.rb +24 -0
  165. data/spec/integration/insights/v1/call/summary_spec.rb +1 -0
  166. data/spec/integration/messaging/v1/brand_registration_spec.rb +143 -0
  167. data/spec/integration/messaging/v1/campaign_spec.rb +194 -0
  168. data/spec/integration/messaging/v1/use_case_spec.rb +55 -0
  169. data/spec/integration/preview/sync/service/document_spec.rb +1 -3
  170. data/spec/integration/serverless/v1/service/build_spec.rb +12 -2
  171. data/spec/integration/supersim/v1/fleet_spec.rb +8 -0
  172. data/spec/integration/sync/v1/service/document_spec.rb +1 -3
  173. data/spec/integration/video/v1/room_spec.rb +5 -0
  174. data/spec/twiml/voice_response_spec.rb +1 -1
  175. metadata +11 -17
  176. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +0 -243
  177. data/lib/twilio-ruby/rest/preview/trusted_comms/business.rb +0 -213
  178. data/lib/twilio-ruby/rest/preview/trusted_comms/business/insights.rb +0 -108
  179. data/lib/twilio-ruby/rest/preview/trusted_comms/business/insights/impressions_rate.rb +0 -260
  180. data/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb +0 -342
  181. data/spec/integration/preview/trusted_comms/branded_call_spec.rb +0 -59
  182. data/spec/integration/preview/trusted_comms/business/insights/impressions_rate_spec.rb +0 -56
  183. data/spec/integration/preview/trusted_comms/business/insights_spec.rb +0 -12
  184. data/spec/integration/preview/trusted_comms/business_spec.rb +0 -45
  185. data/spec/integration/preview/trusted_comms/phone_call_spec.rb +0 -59
@@ -178,7 +178,7 @@ module Twilio
178
178
  end
179
179
 
180
180
  ##
181
- # @return [Hash] The number of current Workers by Activity
181
+ # @return [Array[Hash]] The number of current Workers by Activity
182
182
  def activity_statistics
183
183
  @properties['activity_statistics']
184
184
  end
@@ -246,8 +246,8 @@ module Twilio
246
246
  # `status_callback_method` to send status information to your application.
247
247
  # @param [String] status_callback_method The HTTP method we should use to call
248
248
  # `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
249
- # @param [reservation.CallStatus] status_callback_event The call progress events
250
- # that we will send to `status_callback`. Can be: `initiated`, `ringing`,
249
+ # @param [Array[reservation.CallStatus]] status_callback_event The call progress
250
+ # events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
251
251
  # `answered`, or `completed`.
252
252
  # @param [String] timeout The timeout for a call when executing a Conference
253
253
  # instruction.
@@ -286,7 +286,7 @@ module Twilio
286
286
  # @param [String] conference_status_callback_method The HTTP method we should use
287
287
  # to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
288
288
  # `POST`.
289
- # @param [reservation.ConferenceEvent] conference_status_callback_event The
289
+ # @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
290
290
  # conference status events that we will send to `conference_status_callback`. Can
291
291
  # be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
292
292
  # @param [String] conference_record Whether to record the conference the
@@ -314,8 +314,8 @@ module Twilio
314
314
  # `br1`, `au1`, or `jp1`.
315
315
  # @param [String] sip_auth_username The SIP username used for authentication.
316
316
  # @param [String] sip_auth_password The SIP password for authentication.
317
- # @param [String] dequeue_status_callback_event The call progress events sent via
318
- # webhooks as a result of a Dequeue instruction.
317
+ # @param [Array[String]] dequeue_status_callback_event The call progress events
318
+ # sent via webhooks as a result of a Dequeue instruction.
319
319
  # @param [String] post_work_activity_sid The new worker activity SID after
320
320
  # executing a Conference instruction.
321
321
  # @param [Boolean] end_conference_on_customer_exit Whether to end the conference
@@ -584,8 +584,8 @@ module Twilio
584
584
  # `status_callback_method` to send status information to your application.
585
585
  # @param [String] status_callback_method The HTTP method we should use to call
586
586
  # `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
587
- # @param [reservation.CallStatus] status_callback_event The call progress events
588
- # that we will send to `status_callback`. Can be: `initiated`, `ringing`,
587
+ # @param [Array[reservation.CallStatus]] status_callback_event The call progress
588
+ # events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
589
589
  # `answered`, or `completed`.
590
590
  # @param [String] timeout The timeout for a call when executing a Conference
591
591
  # instruction.
@@ -624,7 +624,7 @@ module Twilio
624
624
  # @param [String] conference_status_callback_method The HTTP method we should use
625
625
  # to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
626
626
  # `POST`.
627
- # @param [reservation.ConferenceEvent] conference_status_callback_event The
627
+ # @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
628
628
  # conference status events that we will send to `conference_status_callback`. Can
629
629
  # be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
630
630
  # @param [String] conference_record Whether to record the conference the
@@ -652,8 +652,8 @@ module Twilio
652
652
  # `br1`, `au1`, or `jp1`.
653
653
  # @param [String] sip_auth_username The SIP username used for authentication.
654
654
  # @param [String] sip_auth_password The SIP password for authentication.
655
- # @param [String] dequeue_status_callback_event The call progress events sent via
656
- # webhooks as a result of a Dequeue instruction.
655
+ # @param [Array[String]] dequeue_status_callback_event The call progress events
656
+ # sent via webhooks as a result of a Dequeue instruction.
657
657
  # @param [String] post_work_activity_sid The new worker activity SID after
658
658
  # executing a Conference instruction.
659
659
  # @param [Boolean] end_conference_on_customer_exit Whether to end the conference
@@ -180,7 +180,7 @@ module Twilio
180
180
  end
181
181
 
182
182
  ##
183
- # @return [Hash] The minimum, average, maximum, and total time that Workers spent in each Activity
183
+ # @return [Array[Hash]] The minimum, average, maximum, and total time that Workers spent in each Activity
184
184
  def activity_durations
185
185
  @properties['activity_durations']
186
186
  end
@@ -149,7 +149,7 @@ module Twilio
149
149
  end
150
150
 
151
151
  ##
152
- # @return [Hash] The number of current Workers by Activity
152
+ # @return [Array[Hash]] The number of current Workers by Activity
153
153
  def activity_statistics
154
154
  @properties['activity_statistics']
155
155
  end
@@ -150,7 +150,7 @@ module Twilio
150
150
  end
151
151
 
152
152
  ##
153
- # @return [Hash] The number of current Workers by Activity
153
+ # @return [Array[Hash]] The number of current Workers by Activity
154
154
  def activity_statistics
155
155
  @properties['activity_statistics']
156
156
  end
@@ -476,7 +476,7 @@ module Twilio
476
476
  end
477
477
 
478
478
  ##
479
- # @return [String] Reserved
479
+ # @return [Array[String]] Reserved
480
480
  def auth_type_set
481
481
  @properties['auth_type_set']
482
482
  end
@@ -39,9 +39,9 @@ module Twilio
39
39
  # minutes after creation.
40
40
  # @param [String] details_message Shown to the user when the push notification
41
41
  # arrives. Required when `factor_type` is `push`
42
- # @param [Hash] details_fields A list of objects that describe the Fields included
43
- # in the Challenge. Each object contains the label and value of the field. Used
44
- # when `factor_type` is `push`.
42
+ # @param [Array[Hash]] details_fields A list of objects that describe the Fields
43
+ # included in the Challenge. Each object contains the label and value of the
44
+ # field. Used when `factor_type` is `push`.
45
45
  # @param [Hash] hidden_details Details provided to give context about the
46
46
  # Challenge. Not shown to the end user. It must be a stringified JSON with only
47
47
  # strings values eg. `{"ip": "172.168.1.234"}`
@@ -296,7 +296,7 @@ module Twilio
296
296
  end
297
297
 
298
298
  ##
299
- # @return [Hash] An array of verification attempt objects.
299
+ # @return [Array[Hash]] An array of verification attempt objects.
300
300
  def send_code_attempts
301
301
  @properties['send_code_attempts']
302
302
  end
@@ -31,9 +31,9 @@ module Twilio
31
31
  # Create the WebhookInstance
32
32
  # @param [String] friendly_name The string that you assigned to describe the
33
33
  # webhook. **This value should not contain PII.**
34
- # @param [String] event_types The array of events that this Webhook is subscribed
35
- # to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
36
- # challenge.approved, challenge.denied`
34
+ # @param [Array[String]] event_types The array of events that this Webhook is
35
+ # subscribed to. Possible event types: `*, factor.deleted, factor.created,
36
+ # factor.verified, challenge.approved, challenge.denied`
37
37
  # @param [String] webhook_url The URL associated with this Webhook.
38
38
  # @param [webhook.Status] status The webhook status. Default value is `enabled`.
39
39
  # One of: `enabled` or `disabled`
@@ -191,9 +191,9 @@ module Twilio
191
191
  # Update the WebhookInstance
192
192
  # @param [String] friendly_name The string that you assigned to describe the
193
193
  # webhook. **This value should not contain PII.**
194
- # @param [String] event_types The array of events that this Webhook is subscribed
195
- # to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
196
- # challenge.approved, challenge.denied`
194
+ # @param [Array[String]] event_types The array of events that this Webhook is
195
+ # subscribed to. Possible event types: `*, factor.deleted, factor.created,
196
+ # factor.verified, challenge.approved, challenge.denied`
197
197
  # @param [String] webhook_url The URL associated with this Webhook.
198
198
  # @param [webhook.Status] status The webhook status. Default value is `enabled`.
199
199
  # One of: `enabled` or `disabled`
@@ -312,7 +312,7 @@ module Twilio
312
312
  end
313
313
 
314
314
  ##
315
- # @return [String] The array of events that this Webhook is subscribed to.
315
+ # @return [Array[String]] The array of events that this Webhook is subscribed to.
316
316
  def event_types
317
317
  @properties['event_types']
318
318
  end
@@ -357,9 +357,9 @@ module Twilio
357
357
  # Update the WebhookInstance
358
358
  # @param [String] friendly_name The string that you assigned to describe the
359
359
  # webhook. **This value should not contain PII.**
360
- # @param [String] event_types The array of events that this Webhook is subscribed
361
- # to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
362
- # challenge.approved, challenge.denied`
360
+ # @param [Array[String]] event_types The array of events that this Webhook is
361
+ # subscribed to. Possible event types: `*, factor.deleted, factor.created,
362
+ # factor.verified, challenge.approved, challenge.denied`
363
363
  # @param [String] webhook_url The URL associated with this Webhook.
364
364
  # @param [webhook.Status] status The webhook status. Default value is `enabled`.
365
365
  # One of: `enabled` or `disabled`
@@ -155,20 +155,21 @@ module Twilio
155
155
  # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
156
156
  # for more info. Please, be aware that either video_layout or audio_sources have
157
157
  # to be provided to get a valid creation request
158
- # @param [String] audio_sources An array of track names from the same group room
159
- # to merge into the new composition. Can include zero or more track names. The new
160
- # composition includes all audio sources specified in `audio_sources` except for
161
- # those specified in `audio_sources_excluded`. The track names in this parameter
162
- # can include an asterisk as a wild card character, which will match zero or more
163
- # characters in a track name. For example, `student*` includes `student` as well
164
- # as `studentTeam`. Please, be aware that either video_layout or audio_sources
165
- # have to be provided to get a valid creation request
166
- # @param [String] audio_sources_excluded An array of track names to exclude. The
167
- # new composition includes all audio sources specified in `audio_sources` except
168
- # for those specified in `audio_sources_excluded`. The track names in this
158
+ # @param [Array[String]] audio_sources An array of track names from the same group
159
+ # room to merge into the new composition. Can include zero or more track names.
160
+ # The new composition includes all audio sources specified in `audio_sources`
161
+ # except for those specified in `audio_sources_excluded`. The track names in this
169
162
  # parameter can include an asterisk as a wild card character, which will match
170
- # zero or more characters in a track name. For example, `student*` excludes
171
- # `student` as well as `studentTeam`. This parameter can also be empty.
163
+ # zero or more characters in a track name. For example, `student*` includes
164
+ # `student` as well as `studentTeam`. Please, be aware that either video_layout or
165
+ # audio_sources have to be provided to get a valid creation request
166
+ # @param [Array[String]] audio_sources_excluded An array of track names to
167
+ # exclude. The new composition includes all audio sources specified in
168
+ # `audio_sources` except for those specified in `audio_sources_excluded`. The
169
+ # track names in this parameter can include an asterisk as a wild card character,
170
+ # which will match zero or more characters in a track name. For example,
171
+ # `student*` excludes `student` as well as `studentTeam`. This parameter can also
172
+ # be empty.
172
173
  # @param [String] resolution A string that describes the columns (width) and rows
173
174
  # (height) of the generated composed video in pixels. Defaults to `640x480`.
174
175
  # The string's format is `{width}x{height}` where:
@@ -404,13 +405,13 @@ module Twilio
404
405
  end
405
406
 
406
407
  ##
407
- # @return [String] The array of track names to include in the composition
408
+ # @return [Array[String]] The array of track names to include in the composition
408
409
  def audio_sources
409
410
  @properties['audio_sources']
410
411
  end
411
412
 
412
413
  ##
413
- # @return [String] The array of track names to exclude from the composition
414
+ # @return [Array[String]] The array of track names to exclude from the composition
414
415
  def audio_sources_excluded
415
416
  @properties['audio_sources_excluded']
416
417
  end
@@ -167,17 +167,17 @@ module Twilio
167
167
  # composition hook in terms of regions. See {Specifying Video
168
168
  # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
169
169
  # for more info.
170
- # @param [String] audio_sources An array of track names from the same group room
171
- # to merge into the compositions created by the composition hook. Can include zero
172
- # or more track names. A composition triggered by the composition hook includes
173
- # all audio sources specified in `audio_sources` except those specified in
174
- # `audio_sources_excluded`. The track names in this parameter can include an
170
+ # @param [Array[String]] audio_sources An array of track names from the same group
171
+ # room to merge into the compositions created by the composition hook. Can include
172
+ # zero or more track names. A composition triggered by the composition hook
173
+ # includes all audio sources specified in `audio_sources` except those specified
174
+ # in `audio_sources_excluded`. The track names in this parameter can include an
175
175
  # asterisk as a wild card character, which matches zero or more characters in a
176
176
  # track name. For example, `student*` includes tracks named `student` as well as
177
177
  # `studentTeam`.
178
- # @param [String] audio_sources_excluded An array of track names to exclude. A
179
- # composition triggered by the composition hook includes all audio sources
180
- # specified in `audio_sources` except for those specified in
178
+ # @param [Array[String]] audio_sources_excluded An array of track names to
179
+ # exclude. A composition triggered by the composition hook includes all audio
180
+ # sources specified in `audio_sources` except for those specified in
181
181
  # `audio_sources_excluded`. The track names in this parameter can include an
182
182
  # asterisk as a wild card character, which matches zero or more characters in a
183
183
  # track name. For example, `student*` excludes `student` as well as `studentTeam`.
@@ -323,17 +323,17 @@ module Twilio
323
323
  # composition hook in terms of regions. See {Specifying Video
324
324
  # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
325
325
  # for more info.
326
- # @param [String] audio_sources An array of track names from the same group room
327
- # to merge into the compositions created by the composition hook. Can include zero
328
- # or more track names. A composition triggered by the composition hook includes
329
- # all audio sources specified in `audio_sources` except those specified in
330
- # `audio_sources_excluded`. The track names in this parameter can include an
326
+ # @param [Array[String]] audio_sources An array of track names from the same group
327
+ # room to merge into the compositions created by the composition hook. Can include
328
+ # zero or more track names. A composition triggered by the composition hook
329
+ # includes all audio sources specified in `audio_sources` except those specified
330
+ # in `audio_sources_excluded`. The track names in this parameter can include an
331
331
  # asterisk as a wild card character, which matches zero or more characters in a
332
332
  # track name. For example, `student*` includes tracks named `student` as well as
333
333
  # `studentTeam`.
334
- # @param [String] audio_sources_excluded An array of track names to exclude. A
335
- # composition triggered by the composition hook includes all audio sources
336
- # specified in `audio_sources` except for those specified in
334
+ # @param [Array[String]] audio_sources_excluded An array of track names to
335
+ # exclude. A composition triggered by the composition hook includes all audio
336
+ # sources specified in `audio_sources` except for those specified in
337
337
  # `audio_sources_excluded`. The track names in this parameter can include an
338
338
  # asterisk as a wild card character, which matches zero or more characters in a
339
339
  # track name. For example, `student*` excludes `student` as well as `studentTeam`.
@@ -496,13 +496,13 @@ module Twilio
496
496
  end
497
497
 
498
498
  ##
499
- # @return [String] The array of track names to include in the compositions created by the composition hook
499
+ # @return [Array[String]] The array of track names to include in the compositions created by the composition hook
500
500
  def audio_sources
501
501
  @properties['audio_sources']
502
502
  end
503
503
 
504
504
  ##
505
- # @return [String] The array of track names to exclude from the compositions created by the composition hook
505
+ # @return [Array[String]] The array of track names to exclude from the compositions created by the composition hook
506
506
  def audio_sources_excluded
507
507
  @properties['audio_sources_excluded']
508
508
  end
@@ -575,17 +575,17 @@ module Twilio
575
575
  # composition hook in terms of regions. See {Specifying Video
576
576
  # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
577
577
  # for more info.
578
- # @param [String] audio_sources An array of track names from the same group room
579
- # to merge into the compositions created by the composition hook. Can include zero
580
- # or more track names. A composition triggered by the composition hook includes
581
- # all audio sources specified in `audio_sources` except those specified in
582
- # `audio_sources_excluded`. The track names in this parameter can include an
578
+ # @param [Array[String]] audio_sources An array of track names from the same group
579
+ # room to merge into the compositions created by the composition hook. Can include
580
+ # zero or more track names. A composition triggered by the composition hook
581
+ # includes all audio sources specified in `audio_sources` except those specified
582
+ # in `audio_sources_excluded`. The track names in this parameter can include an
583
583
  # asterisk as a wild card character, which matches zero or more characters in a
584
584
  # track name. For example, `student*` includes tracks named `student` as well as
585
585
  # `studentTeam`.
586
- # @param [String] audio_sources_excluded An array of track names to exclude. A
587
- # composition triggered by the composition hook includes all audio sources
588
- # specified in `audio_sources` except for those specified in
586
+ # @param [Array[String]] audio_sources_excluded An array of track names to
587
+ # exclude. A composition triggered by the composition hook includes all audio
588
+ # sources specified in `audio_sources` except for those specified in
589
589
  # `audio_sources_excluded`. The track names in this parameter can include an
590
590
  # asterisk as a wild card character, which matches zero or more characters in a
591
591
  # track name. For example, `student*` excludes `student` as well as `studentTeam`.
@@ -89,9 +89,9 @@ module Twilio
89
89
  # encryption.
90
90
  # @param [String] aws_s3_url The URL of the AWS S3 bucket where the compositions
91
91
  # should be stored. We only support DNS-compliant URLs like
92
- # `https://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`, where
93
- # `compositions` is the path in which you want the compositions to be stored. This
94
- # URL accepts only URI-valid characters, as described in the <a
92
+ # `https://documentation-example-twilio-bucket/compositions`, where `compositions`
93
+ # is the path in which you want the compositions to be stored. This URL accepts
94
+ # only URI-valid characters, as described in the <a
95
95
  # href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
96
96
  # @param [Boolean] aws_storage_enabled Whether all compositions should be written
97
97
  # to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
@@ -229,9 +229,9 @@ module Twilio
229
229
  # encryption.
230
230
  # @param [String] aws_s3_url The URL of the AWS S3 bucket where the compositions
231
231
  # should be stored. We only support DNS-compliant URLs like
232
- # `https://<my-bucket>.s3-<aws-region>.amazonaws.com/compositions`, where
233
- # `compositions` is the path in which you want the compositions to be stored. This
234
- # URL accepts only URI-valid characters, as described in the <a
232
+ # `https://documentation-example-twilio-bucket/compositions`, where `compositions`
233
+ # is the path in which you want the compositions to be stored. This URL accepts
234
+ # only URI-valid characters, as described in the <a
235
235
  # href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
236
236
  # @param [Boolean] aws_storage_enabled Whether all compositions should be written
237
237
  # to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
@@ -30,8 +30,8 @@ module Twilio
30
30
  # @param [recording.Status] status Read only the recordings that have this status.
31
31
  # Can be: `processing`, `completed`, or `deleted`.
32
32
  # @param [String] source_sid Read only the recordings that have this `source_sid`.
33
- # @param [String] grouping_sid Read only recordings with this `grouping_sid`,
34
- # which may include a `participant_sid` and/or a `room_sid`.
33
+ # @param [Array[String]] grouping_sid Read only recordings with this
34
+ # `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
35
35
  # @param [Time] date_created_after Read only recordings that started on or after
36
36
  # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
37
37
  # zone.
@@ -67,8 +67,8 @@ module Twilio
67
67
  # @param [recording.Status] status Read only the recordings that have this status.
68
68
  # Can be: `processing`, `completed`, or `deleted`.
69
69
  # @param [String] source_sid Read only the recordings that have this `source_sid`.
70
- # @param [String] grouping_sid Read only recordings with this `grouping_sid`,
71
- # which may include a `participant_sid` and/or a `room_sid`.
70
+ # @param [Array[String]] grouping_sid Read only recordings with this
71
+ # `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
72
72
  # @param [Time] date_created_after Read only recordings that started on or after
73
73
  # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
74
74
  # zone.
@@ -120,8 +120,8 @@ module Twilio
120
120
  # @param [recording.Status] status Read only the recordings that have this status.
121
121
  # Can be: `processing`, `completed`, or `deleted`.
122
122
  # @param [String] source_sid Read only the recordings that have this `source_sid`.
123
- # @param [String] grouping_sid Read only recordings with this `grouping_sid`,
124
- # which may include a `participant_sid` and/or a `room_sid`.
123
+ # @param [Array[String]] grouping_sid Read only recordings with this
124
+ # `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
125
125
  # @param [Time] date_created_after Read only recordings that started on or after
126
126
  # this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with time
127
127
  # zone.
@@ -89,9 +89,9 @@ module Twilio
89
89
  # encryption.
90
90
  # @param [String] aws_s3_url The URL of the AWS S3 bucket where the recordings
91
91
  # should be stored. We only support DNS-compliant URLs like
92
- # `https://<my-bucket>.s3-<aws-region>.amazonaws.com/recordings`, where
93
- # `recordings` is the path in which you want the recordings to be stored. This URL
94
- # accepts only URI-valid characters, as described in the <a
92
+ # `https://documentation-example-twilio-bucket/recordings`, where `recordings` is
93
+ # the path in which you want the recordings to be stored. This URL accepts only
94
+ # URI-valid characters, as described in the <a
95
95
  # href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
96
96
  # @param [Boolean] aws_storage_enabled Whether all recordings should be written to
97
97
  # the `aws_s3_url`. When `false`, all recordings are stored in our cloud.
@@ -229,9 +229,9 @@ module Twilio
229
229
  # encryption.
230
230
  # @param [String] aws_s3_url The URL of the AWS S3 bucket where the recordings
231
231
  # should be stored. We only support DNS-compliant URLs like
232
- # `https://<my-bucket>.s3-<aws-region>.amazonaws.com/recordings`, where
233
- # `recordings` is the path in which you want the recordings to be stored. This URL
234
- # accepts only URI-valid characters, as described in the <a
232
+ # `https://documentation-example-twilio-bucket/recordings`, where `recordings` is
233
+ # the path in which you want the recordings to be stored. This URL accepts only
234
+ # URI-valid characters, as described in the <a
235
235
  # href='https://tools.ietf.org/html/rfc3986#section-2'>RFC 3986</a>.
236
236
  # @param [Boolean] aws_storage_enabled Whether all recordings should be written to
237
237
  # the `aws_s3_url`. When `false`, all recordings are stored in our cloud.
@@ -48,8 +48,8 @@ module Twilio
48
48
  # @param [Boolean] record_participants_on_connect Whether to start recording when
49
49
  # Participants connect. ***This feature is not available in `peer-to-peer`
50
50
  # rooms.***
51
- # @param [room.VideoCodec] video_codecs An array of the video codecs that are
52
- # supported when publishing a track in the room. Can be: `VP8` and `H264`.
51
+ # @param [Array[room.VideoCodec]] video_codecs An array of the video codecs that
52
+ # are supported when publishing a track in the room. Can be: `VP8` and `H264`.
53
53
  # ***This feature is not available in `peer-to-peer` rooms***
54
54
  # @param [String] media_region The region for the media server in Group Rooms.
55
55
  # Can be: one of the {available Media
@@ -357,6 +357,7 @@ module Twilio
357
357
  'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
358
358
  'type' => payload['type'],
359
359
  'max_participants' => payload['max_participants'].to_i,
360
+ 'max_concurrent_published_tracks' => payload['max_concurrent_published_tracks'] == nil ? payload['max_concurrent_published_tracks'] : payload['max_concurrent_published_tracks'].to_i,
360
361
  'record_participants_on_connect' => payload['record_participants_on_connect'],
361
362
  'video_codecs' => payload['video_codecs'],
362
363
  'media_region' => payload['media_region'],
@@ -458,6 +459,12 @@ module Twilio
458
459
  @properties['max_participants']
459
460
  end
460
461
 
462
+ ##
463
+ # @return [String] The maximum number of published tracks allowed in the room at the same time
464
+ def max_concurrent_published_tracks
465
+ @properties['max_concurrent_published_tracks']
466
+ end
467
+
461
468
  ##
462
469
  # @return [Boolean] Whether to start recording when Participants connect
463
470
  def record_participants_on_connect
@@ -465,7 +472,7 @@ module Twilio
465
472
  end
466
473
 
467
474
  ##
468
- # @return [room.VideoCodec] An array of the video codecs that are supported when publishing a track in the room
475
+ # @return [Array[room.VideoCodec]] An array of the video codecs that are supported when publishing a track in the room
469
476
  def video_codecs
470
477
  @properties['video_codecs']
471
478
  end