twilio-ruby 5.25.4 → 5.26.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (220) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -3
  3. data/.travis.yml +3 -0
  4. data/CHANGES.md +24 -0
  5. data/README.md +22 -14
  6. data/lib/twilio-ruby/http/http_client.rb +4 -3
  7. data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +2 -2
  8. data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +2 -2
  9. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +2 -2
  10. data/lib/twilio-ruby/rest/api/v2010/account/application.rb +2 -2
  11. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +10 -4
  12. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +2 -2
  13. data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +2 -2
  14. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +2 -2
  15. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +4 -4
  16. data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +2 -2
  17. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +2 -2
  18. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +2 -2
  19. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +2 -2
  20. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +2 -2
  21. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +2 -2
  22. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +2 -2
  23. data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +2 -2
  24. data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +2 -2
  25. data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +2 -2
  26. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +2 -2
  27. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +2 -2
  28. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +2 -2
  29. data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +2 -2
  30. data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb +2 -2
  31. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +2 -2
  32. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +2 -2
  33. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +2 -2
  34. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +2 -2
  35. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb +2 -2
  36. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb +2 -2
  37. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +2 -2
  38. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +2 -2
  39. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +2 -2
  40. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +2 -2
  41. data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +2 -2
  42. data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +2 -2
  43. data/lib/twilio-ruby/rest/authy/v1/service.rb +2 -2
  44. data/lib/twilio-ruby/rest/authy/v1/service/entity.rb +2 -2
  45. data/lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb +2 -2
  46. data/lib/twilio-ruby/rest/authy/v1/service/entity/factor/challenge.rb +2 -2
  47. data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +2 -2
  48. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +2 -2
  49. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +2 -2
  50. data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +2 -2
  51. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +2 -2
  52. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +2 -2
  53. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +2 -2
  54. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +2 -2
  55. data/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb +2 -2
  56. data/lib/twilio-ruby/rest/chat/v1/credential.rb +2 -2
  57. data/lib/twilio-ruby/rest/chat/v1/service.rb +2 -2
  58. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +2 -2
  59. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +2 -2
  60. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +2 -2
  61. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +2 -2
  62. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +2 -2
  63. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +2 -2
  64. data/lib/twilio-ruby/rest/chat/v2.rb +2 -4
  65. data/lib/twilio-ruby/rest/chat/v2/credential.rb +12 -14
  66. data/lib/twilio-ruby/rest/chat/v2/service.rb +35 -43
  67. data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +17 -19
  68. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +28 -24
  69. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +17 -16
  70. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +43 -44
  71. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +38 -37
  72. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +25 -26
  73. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +19 -17
  74. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +17 -17
  75. data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +25 -27
  76. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +8 -5
  77. data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +32 -6
  78. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +30 -6
  79. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +27 -6
  80. data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +2 -2
  81. data/lib/twilio-ruby/rest/fax/v1/fax.rb +2 -2
  82. data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb +2 -2
  83. data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +2 -2
  84. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +14 -0
  85. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +2 -2
  86. data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +2 -2
  87. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +2 -2
  88. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +2 -2
  89. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +2 -2
  90. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +2 -2
  91. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +2 -2
  92. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +2 -2
  93. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +2 -2
  94. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +2 -2
  95. data/lib/twilio-ruby/rest/ip_messaging/v2.rb +2 -4
  96. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +12 -14
  97. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +35 -43
  98. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +17 -19
  99. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +28 -24
  100. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +17 -16
  101. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +43 -44
  102. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +38 -37
  103. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +25 -26
  104. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +19 -17
  105. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +17 -17
  106. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +25 -27
  107. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +8 -5
  108. data/lib/twilio-ruby/rest/messaging/v1/service.rb +2 -2
  109. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +2 -2
  110. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +2 -2
  111. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +2 -2
  112. data/lib/twilio-ruby/rest/messaging/v1/session.rb +2 -2
  113. data/lib/twilio-ruby/rest/messaging/v1/session/message.rb +2 -2
  114. data/lib/twilio-ruby/rest/messaging/v1/session/participant.rb +2 -2
  115. data/lib/twilio-ruby/rest/messaging/v1/session/webhook.rb +2 -2
  116. data/lib/twilio-ruby/rest/monitor/v1/alert.rb +2 -2
  117. data/lib/twilio-ruby/rest/notify/v1/credential.rb +2 -2
  118. data/lib/twilio-ruby/rest/notify/v1/service.rb +2 -2
  119. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +2 -2
  120. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb +2 -2
  121. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb +2 -2
  122. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb +2 -2
  123. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb +2 -2
  124. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb +2 -2
  125. data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +2 -2
  126. data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb +2 -2
  127. data/lib/twilio-ruby/rest/preview/sync/service.rb +2 -2
  128. data/lib/twilio-ruby/rest/preview/sync/service/document.rb +2 -2
  129. data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb +2 -2
  130. data/lib/twilio-ruby/rest/preview/sync/service/sync_list.rb +2 -2
  131. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +2 -2
  132. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb +2 -2
  133. data/lib/twilio-ruby/rest/preview/sync/service/sync_map.rb +2 -2
  134. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb +2 -2
  135. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb +2 -2
  136. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +10 -2
  137. data/lib/twilio-ruby/rest/preview/understand/assistant.rb +2 -2
  138. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +2 -2
  139. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +2 -2
  140. data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +2 -2
  141. data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +2 -2
  142. data/lib/twilio-ruby/rest/preview/understand/assistant/task.rb +2 -2
  143. data/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb +2 -2
  144. data/lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb +2 -2
  145. data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +2 -2
  146. data/lib/twilio-ruby/rest/proxy/v1/service.rb +2 -2
  147. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +2 -2
  148. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +2 -2
  149. data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +2 -2
  150. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +2 -2
  151. data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb +2 -2
  152. data/lib/twilio-ruby/rest/serverless/v1/service.rb +2 -2
  153. data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +2 -2
  154. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +2 -2
  155. data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +2 -2
  156. data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +2 -2
  157. data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +2 -2
  158. data/lib/twilio-ruby/rest/studio.rb +2 -1
  159. data/lib/twilio-ruby/rest/studio/v1.rb +1 -1
  160. data/lib/twilio-ruby/rest/studio/v1/flow.rb +13 -13
  161. data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb +25 -24
  162. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb +11 -11
  163. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb +20 -20
  164. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb +15 -17
  165. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +44 -38
  166. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb +12 -11
  167. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb +21 -20
  168. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb +18 -17
  169. data/lib/twilio-ruby/rest/sync.rb +2 -1
  170. data/lib/twilio-ruby/rest/sync/v1.rb +1 -1
  171. data/lib/twilio-ruby/rest/sync/v1/service.rb +90 -93
  172. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +46 -33
  173. data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +36 -38
  174. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +44 -31
  175. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +94 -76
  176. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +37 -38
  177. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +45 -33
  178. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +98 -81
  179. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +35 -38
  180. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +39 -28
  181. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +14 -12
  182. data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +2 -2
  183. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +2 -2
  184. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +2 -2
  185. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +2 -2
  186. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +2 -2
  187. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +2 -2
  188. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +2 -2
  189. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +2 -2
  190. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +2 -2
  191. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +2 -2
  192. data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +2 -2
  193. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +2 -2
  194. data/lib/twilio-ruby/rest/trunking/v1/trunk/terminating_sip_domain.rb +2 -2
  195. data/lib/twilio-ruby/rest/verify/v2/service.rb +2 -2
  196. data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +2 -2
  197. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +3 -3
  198. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +2 -2
  199. data/lib/twilio-ruby/rest/video/v1/composition.rb +2 -2
  200. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +2 -2
  201. data/lib/twilio-ruby/rest/video/v1/recording.rb +2 -2
  202. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +2 -2
  203. data/lib/twilio-ruby/rest/wireless.rb +3 -3
  204. data/lib/twilio-ruby/rest/wireless/v1.rb +3 -6
  205. data/lib/twilio-ruby/rest/wireless/v1/command.rb +54 -52
  206. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +64 -65
  207. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +147 -141
  208. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +34 -28
  209. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +32 -32
  210. data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +19 -19
  211. data/lib/twilio-ruby/version.rb +1 -1
  212. data/spec/integration/api/v2010/account/call_spec.rb +45 -0
  213. data/spec/integration/api/v2010/account/message_spec.rb +37 -0
  214. data/spec/integration/conversations/v1/conversation/message_spec.rb +5 -0
  215. data/spec/integration/conversations/v1/conversation/participant_spec.rb +8 -10
  216. data/spec/integration/conversations/v1/conversation_spec.rb +4 -0
  217. data/spec/integration/flex_api/v1/configuration_spec.rb +24 -0
  218. data/spec/integration/preview/trusted_comms/branded_call_spec.rb +1 -0
  219. data/spec/integration/verify/v2/service/verification_spec.rb +1 -1
  220. metadata +2 -2
@@ -163,8 +163,7 @@ module Twilio
163
163
  ##
164
164
  # Initialize the ServiceContext
165
165
  # @param [Version] version Version that contains the resource
166
- # @param [String] sid The Twilio-provided string that uniquely identifies the
167
- # Service resource to fetch.
166
+ # @param [String] sid The SID of the Service resource to fetch.
168
167
  # @return [ServiceContext] ServiceContext
169
168
  def initialize(version, sid)
170
169
  super(version)
@@ -197,7 +196,7 @@ module Twilio
197
196
 
198
197
  ##
199
198
  # Deletes the ServiceInstance
200
- # @return [Boolean] true if delete succeeds, true otherwise
199
+ # @return [Boolean] true if delete succeeds, false otherwise
201
200
  def delete
202
201
  @version.delete('delete', @uri)
203
202
  end
@@ -207,14 +206,14 @@ module Twilio
207
206
  # @param [String] friendly_name A descriptive string that you create to describe
208
207
  # the resource.
209
208
  # @param [String] default_service_role_sid The service role assigned to users when
210
- # they are added to the service. See the [Roles
211
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
209
+ # they are added to the service. See the [Role
210
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
212
211
  # @param [String] default_channel_role_sid The channel role assigned to users when
213
- # they are added to a channel. See the [Roles
214
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
212
+ # they are added to a channel. See the [Role
213
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
215
214
  # @param [String] default_channel_creator_role_sid The channel role assigned to a
216
- # channel creator when they join a new channel. See the [Roles
217
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
215
+ # channel creator when they join a new channel. See the [Role
216
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
218
217
  # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
219
218
  # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
220
219
  # default is `true`.
@@ -227,8 +226,7 @@ module Twilio
227
226
  # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
228
227
  # between consumption reports submission batches from client endpoints.
229
228
  # @param [Boolean] notifications_new_message_enabled Whether to send a
230
- # notification when a new message is added to a channel. Can be: `true` or `false`
231
- # and the default is `false`.
229
+ # notification when a new message is added to a channel. The default is `false`.
232
230
  # @param [String] notifications_new_message_template The template to use to create
233
231
  # the notification text displayed when a new message is added to a channel and
234
232
  # `notifications.new_message.enabled` is `true`.
@@ -236,10 +234,9 @@ module Twilio
236
234
  # when a new message is added to a channel and `notifications.new_message.enabled`
237
235
  # is `true`.
238
236
  # @param [Boolean] notifications_new_message_badge_count_enabled Whether the new
239
- # message badge is enabled. Can be: `true` or `false` and the default is `false`.
237
+ # message badge is enabled. The default is `false`.
240
238
  # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
241
- # notification when a member is added to a channel. Can be: `true` or `false` and
242
- # the default is `false`.
239
+ # notification when a member is added to a channel. The default is `false`.
243
240
  # @param [String] notifications_added_to_channel_template The template to use to
244
241
  # create the notification text displayed when a member is added to a channel and
245
242
  # `notifications.added_to_channel.enabled` is `true`.
@@ -247,8 +244,8 @@ module Twilio
247
244
  # play when a member is added to a channel and
248
245
  # `notifications.added_to_channel.enabled` is `true`.
249
246
  # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
250
- # notification to a user when they are removed from a channel. Can be: `true` or
251
- # `false` and the default is `false`.
247
+ # notification to a user when they are removed from a channel. The default is
248
+ # `false`.
252
249
  # @param [String] notifications_removed_from_channel_template The template to use
253
250
  # to create the notification text displayed to a user when they are removed from a
254
251
  # channel and `notifications.removed_from_channel.enabled` is `true`.
@@ -256,8 +253,7 @@ module Twilio
256
253
  # to play to a user when they are removed from a channel and
257
254
  # `notifications.removed_from_channel.enabled` is `true`.
258
255
  # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
259
- # notification when a user is invited to a channel. Can be: `true` or `false` and
260
- # the default is `false`.
256
+ # notification when a user is invited to a channel. The default is `false`.
261
257
  # @param [String] notifications_invited_to_channel_template The template to use to
262
258
  # create the notification text displayed when a user is invited to a channel and
263
259
  # `notifications.invited_to_channel.enabled` is `true`.
@@ -274,7 +270,7 @@ module Twilio
274
270
  # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
275
271
  # the default is `POST`. See [Webhook
276
272
  # Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
277
- # @param [String] webhook_filters The list of WebHook events that are enabled for
273
+ # @param [String] webhook_filters The list of webhook events that are enabled for
278
274
  # this Service instance. See [Webhook
279
275
  # Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
280
276
  # @param [String] limits_channel_members The maximum number of Members that can be
@@ -291,8 +287,8 @@ module Twilio
291
287
  # the `post_webhook_url` if the request times out (after 5 seconds) or it receives
292
288
  # a 429, 503, or 504 HTTP response. The default is 0, which means the call won't
293
289
  # be retried.
294
- # @param [Boolean] notifications_log_enabled Whether to log notifications. Can be:
295
- # `true` or `false` and the default is `false`.
290
+ # @param [Boolean] notifications_log_enabled Whether to log notifications. The
291
+ # default is `false`.
296
292
  # @return [ServiceInstance] Updated ServiceInstance
297
293
  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)
298
294
  data = Twilio::Values.of({
@@ -430,8 +426,7 @@ module Twilio
430
426
  # Initialize the ServiceInstance
431
427
  # @param [Version] version Version that contains the resource
432
428
  # @param [Hash] payload payload that contains response from Twilio
433
- # @param [String] sid The Twilio-provided string that uniquely identifies the
434
- # Service resource to fetch.
429
+ # @param [String] sid The SID of the Service resource to fetch.
435
430
  # @return [ServiceInstance] ServiceInstance
436
431
  def initialize(version, payload, sid: nil)
437
432
  super(version)
@@ -576,7 +571,7 @@ module Twilio
576
571
  end
577
572
 
578
573
  ##
579
- # @return [String] The list of WebHook events that are enabled for this Service instance
574
+ # @return [String] The list of webhook events that are enabled for this Service instance
580
575
  def webhook_filters
581
576
  @properties['webhook_filters']
582
577
  end
@@ -626,7 +621,7 @@ module Twilio
626
621
 
627
622
  ##
628
623
  # Deletes the ServiceInstance
629
- # @return [Boolean] true if delete succeeds, true otherwise
624
+ # @return [Boolean] true if delete succeeds, false otherwise
630
625
  def delete
631
626
  context.delete
632
627
  end
@@ -636,14 +631,14 @@ module Twilio
636
631
  # @param [String] friendly_name A descriptive string that you create to describe
637
632
  # the resource.
638
633
  # @param [String] default_service_role_sid The service role assigned to users when
639
- # they are added to the service. See the [Roles
640
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
634
+ # they are added to the service. See the [Role
635
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
641
636
  # @param [String] default_channel_role_sid The channel role assigned to users when
642
- # they are added to a channel. See the [Roles
643
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
637
+ # they are added to a channel. See the [Role
638
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
644
639
  # @param [String] default_channel_creator_role_sid The channel role assigned to a
645
- # channel creator when they join a new channel. See the [Roles
646
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
640
+ # channel creator when they join a new channel. See the [Role
641
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
647
642
  # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
648
643
  # Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
649
644
  # default is `true`.
@@ -656,8 +651,7 @@ module Twilio
656
651
  # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
657
652
  # between consumption reports submission batches from client endpoints.
658
653
  # @param [Boolean] notifications_new_message_enabled Whether to send a
659
- # notification when a new message is added to a channel. Can be: `true` or `false`
660
- # and the default is `false`.
654
+ # notification when a new message is added to a channel. The default is `false`.
661
655
  # @param [String] notifications_new_message_template The template to use to create
662
656
  # the notification text displayed when a new message is added to a channel and
663
657
  # `notifications.new_message.enabled` is `true`.
@@ -665,10 +659,9 @@ module Twilio
665
659
  # when a new message is added to a channel and `notifications.new_message.enabled`
666
660
  # is `true`.
667
661
  # @param [Boolean] notifications_new_message_badge_count_enabled Whether the new
668
- # message badge is enabled. Can be: `true` or `false` and the default is `false`.
662
+ # message badge is enabled. The default is `false`.
669
663
  # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
670
- # notification when a member is added to a channel. Can be: `true` or `false` and
671
- # the default is `false`.
664
+ # notification when a member is added to a channel. The default is `false`.
672
665
  # @param [String] notifications_added_to_channel_template The template to use to
673
666
  # create the notification text displayed when a member is added to a channel and
674
667
  # `notifications.added_to_channel.enabled` is `true`.
@@ -676,8 +669,8 @@ module Twilio
676
669
  # play when a member is added to a channel and
677
670
  # `notifications.added_to_channel.enabled` is `true`.
678
671
  # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
679
- # notification to a user when they are removed from a channel. Can be: `true` or
680
- # `false` and the default is `false`.
672
+ # notification to a user when they are removed from a channel. The default is
673
+ # `false`.
681
674
  # @param [String] notifications_removed_from_channel_template The template to use
682
675
  # to create the notification text displayed to a user when they are removed from a
683
676
  # channel and `notifications.removed_from_channel.enabled` is `true`.
@@ -685,8 +678,7 @@ module Twilio
685
678
  # to play to a user when they are removed from a channel and
686
679
  # `notifications.removed_from_channel.enabled` is `true`.
687
680
  # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
688
- # notification when a user is invited to a channel. Can be: `true` or `false` and
689
- # the default is `false`.
681
+ # notification when a user is invited to a channel. The default is `false`.
690
682
  # @param [String] notifications_invited_to_channel_template The template to use to
691
683
  # create the notification text displayed when a user is invited to a channel and
692
684
  # `notifications.invited_to_channel.enabled` is `true`.
@@ -703,7 +695,7 @@ module Twilio
703
695
  # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
704
696
  # the default is `POST`. See [Webhook
705
697
  # Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
706
- # @param [String] webhook_filters The list of WebHook events that are enabled for
698
+ # @param [String] webhook_filters The list of webhook events that are enabled for
707
699
  # this Service instance. See [Webhook
708
700
  # Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
709
701
  # @param [String] limits_channel_members The maximum number of Members that can be
@@ -720,8 +712,8 @@ module Twilio
720
712
  # the `post_webhook_url` if the request times out (after 5 seconds) or it receives
721
713
  # a 429, 503, or 504 HTTP response. The default is 0, which means the call won't
722
714
  # be retried.
723
- # @param [Boolean] notifications_log_enabled Whether to log notifications. Can be:
724
- # `true` or `false` and the default is `false`.
715
+ # @param [Boolean] notifications_log_enabled Whether to log notifications. The
716
+ # default is `false`.
725
717
  # @return [ServiceInstance] Updated ServiceInstance
726
718
  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)
727
719
  context.update(
@@ -16,8 +16,8 @@ module Twilio
16
16
  # Initialize the BindingList
17
17
  # @param [Version] version Version that contains the resource
18
18
  # @param [String] service_sid The SID of the
19
- # [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
20
- # associated with.
19
+ # [Service](https://www.twilio.com/docs/chat/rest/services) the Binding resource
20
+ # is associated with.
21
21
  # @return [BindingList] BindingList
22
22
  def initialize(version, service_sid: nil)
23
23
  super(version)
@@ -35,7 +35,7 @@ module Twilio
35
35
  # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push
36
36
  # notification
37
37
  # configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
38
- # for more information.
38
+ # for more info.
39
39
  # @param [String] identity The
40
40
  # [User](https://www.twilio.com/docs/chat/rest/users)'s `identity` value of the
41
41
  # resources to read. See [access
@@ -64,7 +64,7 @@ module Twilio
64
64
  # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push
65
65
  # notification
66
66
  # configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
67
- # for more information.
67
+ # for more info.
68
68
  # @param [String] identity The
69
69
  # [User](https://www.twilio.com/docs/chat/rest/users)'s `identity` value of the
70
70
  # resources to read. See [access
@@ -105,7 +105,7 @@ module Twilio
105
105
  # Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push
106
106
  # notification
107
107
  # configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
108
- # for more information.
108
+ # for more info.
109
109
  # @param [String] identity The
110
110
  # [User](https://www.twilio.com/docs/chat/rest/users)'s `identity` value of the
111
111
  # resources to read. See [access
@@ -184,10 +184,9 @@ module Twilio
184
184
  # Initialize the BindingContext
185
185
  # @param [Version] version Version that contains the resource
186
186
  # @param [String] service_sid The SID of the
187
- # [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the resource
188
- # from.
189
- # @param [String] sid The Twilio-provided string that uniquely identifies the
190
- # Binding resource to fetch.
187
+ # [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the Binding
188
+ # resource from.
189
+ # @param [String] sid The SID of the Binding resource to fetch.
191
190
  # @return [BindingContext] BindingContext
192
191
  def initialize(version, service_sid, sid)
193
192
  super(version)
@@ -214,7 +213,7 @@ module Twilio
214
213
 
215
214
  ##
216
215
  # Deletes the BindingInstance
217
- # @return [Boolean] true if delete succeeds, true otherwise
216
+ # @return [Boolean] true if delete succeeds, false otherwise
218
217
  def delete
219
218
  @version.delete('delete', @uri)
220
219
  end
@@ -240,10 +239,9 @@ module Twilio
240
239
  # @param [Version] version Version that contains the resource
241
240
  # @param [Hash] payload payload that contains response from Twilio
242
241
  # @param [String] service_sid The SID of the
243
- # [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
244
- # associated with.
245
- # @param [String] sid The Twilio-provided string that uniquely identifies the
246
- # Binding resource to fetch.
242
+ # [Service](https://www.twilio.com/docs/chat/rest/services) the Binding resource
243
+ # is associated with.
244
+ # @param [String] sid The SID of the Binding resource to fetch.
247
245
  # @return [BindingInstance] BindingInstance
248
246
  def initialize(version, payload, service_sid: nil, sid: nil)
249
247
  super(version)
@@ -293,19 +291,19 @@ module Twilio
293
291
  end
294
292
 
295
293
  ##
296
- # @return [String] The SID of the Service that the resource is associated with
294
+ # @return [String] The SID of the Service that the Binding resource is associated with
297
295
  def service_sid
298
296
  @properties['service_sid']
299
297
  end
300
298
 
301
299
  ##
302
- # @return [Time] The RFC 2822 date and time in GMT when the resource was created
300
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
303
301
  def date_created
304
302
  @properties['date_created']
305
303
  end
306
304
 
307
305
  ##
308
- # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
306
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
309
307
  def date_updated
310
308
  @properties['date_updated']
311
309
  end
@@ -347,7 +345,7 @@ module Twilio
347
345
  end
348
346
 
349
347
  ##
350
- # @return [String] The absolute URLs of the Users for the Binding
348
+ # @return [String] The absolute URLs of the Binding's User
351
349
  def links
352
350
  @properties['links']
353
351
  end
@@ -361,7 +359,7 @@ module Twilio
361
359
 
362
360
  ##
363
361
  # Deletes the BindingInstance
364
- # @return [Boolean] true if delete succeeds, true otherwise
362
+ # @return [Boolean] true if delete succeeds, false otherwise
365
363
  def delete
366
364
  context.delete
367
365
  end
@@ -16,8 +16,8 @@ module Twilio
16
16
  # Initialize the ChannelList
17
17
  # @param [Version] version Version that contains the resource
18
18
  # @param [String] service_sid The SID of the
19
- # [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
20
- # associated with.
19
+ # [Service](https://www.twilio.com/docs/chat/rest/services) the Channel resource
20
+ # is associated with.
21
21
  # @return [ChannelList] ChannelList
22
22
  def initialize(version, service_sid: nil)
23
23
  super(version)
@@ -34,21 +34,21 @@ module Twilio
34
34
  # the new resource. It can be up to 64 characters long.
35
35
  # @param [String] unique_name An application-defined string that uniquely
36
36
  # identifies the resource. It can be used to address the resource in place of the
37
- # resource's `sid` in the URL. This value must be 64 characters or less in length
38
- # and be unique within the Service.
37
+ # Channel resource's `sid` in the URL. This value must be 64 characters or less in
38
+ # length and be unique within the Service.
39
39
  # @param [String] attributes A valid JSON string that contains
40
40
  # application-specific data.
41
41
  # @param [channel.ChannelType] type The visibility of the channel. Can be:
42
42
  # `public` or `private` and defaults to `public`.
43
43
  # @param [Time] date_created The date, specified in [ISO
44
44
  # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
45
- # as the date it was created. The default is the current time set by the Chat
46
- # service. Note that this should only be used in cases where a Channel is being
47
- # recreated from a backup/separate source.
45
+ # as the date it was created. The default value is the current time set by the
46
+ # Chat service. Note that this should only be used in cases where a Channel is
47
+ # being recreated from a backup/separate source.
48
48
  # @param [Time] date_updated The date, specified in [ISO
49
49
  # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
50
- # as the date it was last updated. The default value is `null`. Note that this
51
- # should only be used in cases where a Channel is being recreated from a
50
+ # as the date it was last updated. The default value is `null`. Note that this
51
+ # parameter should only be used in cases where a Channel is being recreated from a
52
52
  # backup/separate source and where a Message was previously updated.
53
53
  # @param [String] created_by The `identity` of the User that created the channel.
54
54
  # Default is: `system`.
@@ -203,10 +203,10 @@ module Twilio
203
203
  # Initialize the ChannelContext
204
204
  # @param [Version] version Version that contains the resource
205
205
  # @param [String] service_sid The SID of the
206
- # [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the resource
207
- # from.
208
- # @param [String] sid The Twilio-provided string that uniquely identifies the
209
- # Channel resource to fetch.
206
+ # [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the Channel
207
+ # resource from.
208
+ # @param [String] sid The SID of the Channel resource to fetch. This value can be
209
+ # either the `sid` or the `unique_name` of the Channel resource to fetch.
210
210
  # @return [ChannelContext] ChannelContext
211
211
  def initialize(version, service_sid, sid)
212
212
  super(version)
@@ -239,7 +239,7 @@ module Twilio
239
239
 
240
240
  ##
241
241
  # Deletes the ChannelInstance
242
- # @return [Boolean] true if delete succeeds, true otherwise
242
+ # @return [Boolean] true if delete succeeds, false otherwise
243
243
  def delete
244
244
  @version.delete('delete', @uri)
245
245
  end
@@ -256,7 +256,9 @@ module Twilio
256
256
  # application-specific data.
257
257
  # @param [Time] date_created The date, specified in [ISO
258
258
  # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
259
- # as the date it was created.
259
+ # as the date it was created. The default value is the current time set by the
260
+ # Chat service. Note that this should only be used in cases where a Channel is
261
+ # being recreated from a backup/separate source.
260
262
  # @param [Time] date_updated The date, specified in [ISO
261
263
  # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
262
264
  # as the date it was last updated.
@@ -391,10 +393,10 @@ module Twilio
391
393
  # @param [Version] version Version that contains the resource
392
394
  # @param [Hash] payload payload that contains response from Twilio
393
395
  # @param [String] service_sid The SID of the
394
- # [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
395
- # associated with.
396
- # @param [String] sid The Twilio-provided string that uniquely identifies the
397
- # Channel resource to fetch.
396
+ # [Service](https://www.twilio.com/docs/chat/rest/services) the Channel resource
397
+ # is associated with.
398
+ # @param [String] sid The SID of the Channel resource to fetch. This value can be
399
+ # either the `sid` or the `unique_name` of the Channel resource to fetch.
398
400
  # @return [ChannelInstance] ChannelInstance
399
401
  def initialize(version, payload, service_sid: nil, sid: nil)
400
402
  super(version)
@@ -476,13 +478,13 @@ module Twilio
476
478
  end
477
479
 
478
480
  ##
479
- # @return [Time] The RFC 2822 date and time in GMT when the resource was created
481
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
480
482
  def date_created
481
483
  @properties['date_created']
482
484
  end
483
485
 
484
486
  ##
485
- # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
487
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
486
488
  def date_updated
487
489
  @properties['date_updated']
488
490
  end
@@ -500,7 +502,7 @@ module Twilio
500
502
  end
501
503
 
502
504
  ##
503
- # @return [String] The number of Messages in the Channel
505
+ # @return [String] The number of Messages that have been passed in the Channel
504
506
  def messages_count
505
507
  @properties['messages_count']
506
508
  end
@@ -526,7 +528,7 @@ module Twilio
526
528
 
527
529
  ##
528
530
  # Deletes the ChannelInstance
529
- # @return [Boolean] true if delete succeeds, true otherwise
531
+ # @return [Boolean] true if delete succeeds, false otherwise
530
532
  def delete
531
533
  context.delete
532
534
  end
@@ -543,7 +545,9 @@ module Twilio
543
545
  # application-specific data.
544
546
  # @param [Time] date_created The date, specified in [ISO
545
547
  # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
546
- # as the date it was created.
548
+ # as the date it was created. The default value is the current time set by the
549
+ # Chat service. Note that this should only be used in cases where a Channel is
550
+ # being recreated from a backup/separate source.
547
551
  # @param [Time] date_updated The date, specified in [ISO
548
552
  # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
549
553
  # as the date it was last updated.