twilio-ruby 5.61.2 → 6.9.1

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 (677) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/pr-lint.yml +21 -0
  3. data/.github/workflows/test-and-deploy.yml +139 -0
  4. data/.gitignore +3 -0
  5. data/.rubocop.yml +1 -1
  6. data/.rubocop_todo.yml +84 -21
  7. data/CHANGES.md +893 -1
  8. data/CONTRIBUTING.md +11 -9
  9. data/LICENSE +1 -1
  10. data/Makefile +13 -8
  11. data/PULL_REQUEST_TEMPLATE.md +1 -1
  12. data/README.md +136 -44
  13. data/UPGRADE.md +10 -0
  14. data/advanced-examples/custom-http-client.md +170 -0
  15. data/cluster_spec.rb +77 -0
  16. data/lib/rack/twilio_webhook_authentication.rb +25 -1
  17. data/lib/twilio-ruby/base/client_base.rb +121 -0
  18. data/lib/twilio-ruby/framework/rest/error.rb +0 -12
  19. data/lib/twilio-ruby/http/http_client.rb +11 -6
  20. data/lib/twilio-ruby/jwt/access_token.rb +0 -59
  21. data/lib/twilio-ruby/rest/accounts/v1/auth_token_promotion.rb +198 -178
  22. data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +371 -332
  23. data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +371 -332
  24. data/lib/twilio-ruby/rest/accounts/v1/credential.rb +121 -114
  25. data/lib/twilio-ruby/rest/accounts/v1/safelist.rb +169 -0
  26. data/lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb +214 -192
  27. data/lib/twilio-ruby/rest/accounts/v1.rb +51 -42
  28. data/lib/twilio-ruby/rest/accounts.rb +4 -34
  29. data/lib/twilio-ruby/rest/accounts_base.rb +38 -0
  30. data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +370 -365
  31. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +551 -514
  32. data/lib/twilio-ruby/rest/api/v2010/account/application.rb +615 -586
  33. data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +313 -320
  34. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb +394 -0
  35. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/machine_to_machine.rb +394 -0
  36. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/mobile.rb +394 -0
  37. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/national.rb +394 -0
  38. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/shared_cost.rb +394 -0
  39. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/toll_free.rb +394 -0
  40. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/voip.rb +394 -0
  41. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country.rb +432 -0
  42. data/lib/twilio-ruby/rest/api/v2010/account/balance.rb +136 -118
  43. data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb +202 -194
  44. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +252 -289
  45. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +317 -303
  46. data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +400 -417
  47. data/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb +291 -342
  48. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +494 -511
  49. data/lib/twilio-ruby/rest/api/v2010/account/call/siprec.rb +839 -634
  50. data/lib/twilio-ruby/rest/api/v2010/account/call/stream.rb +872 -0
  51. data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message.rb +163 -0
  52. data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb +239 -0
  53. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +952 -972
  54. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +652 -717
  55. data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +451 -458
  56. data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +489 -493
  57. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +426 -407
  58. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +321 -351
  59. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +398 -418
  60. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +536 -554
  61. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +536 -553
  62. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +536 -553
  63. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +841 -903
  64. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +335 -302
  65. data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +167 -166
  66. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +340 -350
  67. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +615 -612
  68. data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +157 -138
  69. data/lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb +157 -138
  70. data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +400 -399
  71. data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +368 -358
  72. data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +340 -338
  73. data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +426 -390
  74. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +358 -380
  75. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +368 -385
  76. data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +364 -372
  77. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +507 -486
  78. data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +417 -408
  79. data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb +335 -306
  80. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +375 -368
  81. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +399 -373
  82. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls/auth_calls_credential_list_mapping.rb +346 -0
  83. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/{auth_calls_mapping → auth_type_calls}/auth_calls_ip_access_control_list_mapping.rb +193 -195
  84. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls.rb +140 -0
  85. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/{auth_registrations_mapping → auth_type_registrations}/auth_registrations_credential_list_mapping.rb +193 -195
  86. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations.rb +126 -0
  87. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb +94 -103
  88. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +339 -339
  89. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +339 -338
  90. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +649 -645
  91. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +412 -421
  92. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +399 -374
  93. data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +141 -150
  94. data/lib/twilio-ruby/rest/api/v2010/account/token.rb +171 -154
  95. data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +364 -350
  96. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +314 -339
  97. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +314 -339
  98. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +314 -339
  99. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +314 -339
  100. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +314 -339
  101. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +314 -339
  102. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +314 -339
  103. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +314 -339
  104. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +381 -416
  105. data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +485 -484
  106. data/lib/twilio-ruby/rest/api/v2010/account/usage.rb +112 -104
  107. data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +172 -161
  108. data/lib/twilio-ruby/rest/api/v2010/account.rb +979 -943
  109. data/lib/twilio-ruby/rest/api/v2010.rb +126 -148
  110. data/lib/twilio-ruby/rest/api.rb +25 -34
  111. data/lib/twilio-ruby/rest/api_base.rb +38 -0
  112. data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +299 -279
  113. data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb +298 -279
  114. data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb +271 -248
  115. data/lib/twilio-ruby/rest/bulkexports/v1/export.rb +246 -235
  116. data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb +245 -218
  117. data/lib/twilio-ruby/rest/bulkexports/v1.rb +57 -55
  118. data/lib/twilio-ruby/rest/bulkexports.rb +3 -34
  119. data/lib/twilio-ruby/rest/bulkexports_base.rb +38 -0
  120. data/lib/twilio-ruby/rest/chat/v1/credential.rb +419 -403
  121. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +374 -391
  122. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +422 -440
  123. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +438 -437
  124. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +534 -515
  125. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +396 -367
  126. data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +244 -239
  127. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +465 -440
  128. data/lib/twilio-ruby/rest/chat/v1/service.rb +861 -894
  129. data/lib/twilio-ruby/rest/chat/v1.rb +57 -55
  130. data/lib/twilio-ruby/rest/chat/v2/credential.rb +419 -401
  131. data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +371 -370
  132. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +374 -386
  133. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +486 -527
  134. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +513 -533
  135. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +440 -467
  136. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +606 -605
  137. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +396 -369
  138. data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +364 -381
  139. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +406 -413
  140. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +509 -491
  141. data/lib/twilio-ruby/rest/chat/v2/service.rb +764 -778
  142. data/lib/twilio-ruby/rest/chat/v2.rb +57 -53
  143. data/lib/twilio-ruby/rest/chat/v3/channel.rb +297 -0
  144. data/lib/twilio-ruby/rest/chat/v3.rb +71 -0
  145. data/lib/twilio-ruby/rest/chat.rb +10 -38
  146. data/lib/twilio-ruby/rest/chat_base.rb +48 -0
  147. data/lib/twilio-ruby/rest/client.rb +318 -561
  148. data/lib/twilio-ruby/rest/content/v1/content/approval_fetch.rb +208 -0
  149. data/lib/twilio-ruby/rest/content/v1/content.rb +363 -0
  150. data/lib/twilio-ruby/rest/content/v1/content_and_approvals.rb +251 -0
  151. data/lib/twilio-ruby/rest/content/v1/legacy_content.rb +265 -0
  152. data/lib/twilio-ruby/rest/content/v1.rb +61 -0
  153. data/lib/twilio-ruby/rest/content.rb +15 -0
  154. data/lib/twilio-ruby/rest/content_base.rb +38 -0
  155. data/lib/twilio-ruby/rest/conversations/v1/address_configuration.rb +482 -0
  156. data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb +254 -227
  157. data/lib/twilio-ruby/rest/conversations/v1/configuration.rb +279 -252
  158. data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +334 -344
  159. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +537 -495
  160. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +498 -495
  161. data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +425 -403
  162. data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +620 -552
  163. data/lib/twilio-ruby/rest/conversations/v1/credential.rb +425 -409
  164. data/lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb +304 -304
  165. data/lib/twilio-ruby/rest/conversations/v1/role.rb +384 -356
  166. data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +364 -373
  167. data/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb +300 -289
  168. data/lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb +246 -235
  169. data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +307 -279
  170. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +341 -371
  171. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +544 -535
  172. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +507 -530
  173. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +434 -438
  174. data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +632 -588
  175. data/lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb +310 -317
  176. data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +396 -380
  177. data/lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb +446 -455
  178. data/lib/twilio-ruby/rest/conversations/v1/service/user.rb +484 -474
  179. data/lib/twilio-ruby/rest/conversations/v1/service.rb +476 -447
  180. data/lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb +445 -435
  181. data/lib/twilio-ruby/rest/conversations/v1/user.rb +472 -441
  182. data/lib/twilio-ruby/rest/conversations/v1.rb +129 -119
  183. data/lib/twilio-ruby/rest/conversations.rb +18 -34
  184. data/lib/twilio-ruby/rest/conversations_base.rb +38 -0
  185. data/lib/twilio-ruby/rest/events/v1/event_type.rb +302 -288
  186. data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb +299 -0
  187. data/lib/twilio-ruby/rest/events/v1/schema.rb +227 -218
  188. data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb +114 -100
  189. data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb +120 -103
  190. data/lib/twilio-ruby/rest/events/v1/sink.rb +434 -408
  191. data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +365 -339
  192. data/lib/twilio-ruby/rest/events/v1/subscription.rb +416 -387
  193. data/lib/twilio-ruby/rest/events/v1.rb +87 -87
  194. data/lib/twilio-ruby/rest/events.rb +5 -34
  195. data/lib/twilio-ruby/rest/events_base.rb +38 -0
  196. data/lib/twilio-ruby/rest/flex_api/v1/assessments.rb +448 -0
  197. data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +365 -330
  198. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +510 -475
  199. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +563 -555
  200. data/lib/twilio-ruby/rest/flex_api/v1/insights_assessments_comment.rb +327 -0
  201. data/lib/twilio-ruby/rest/flex_api/v1/insights_conversations.rb +228 -0
  202. data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb +442 -0
  203. data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_category.rb +358 -0
  204. data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb +443 -0
  205. data/lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb +361 -0
  206. data/lib/twilio-ruby/rest/flex_api/v1/insights_session.rb +217 -0
  207. data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_answer_sets.rb +155 -0
  208. data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_comment.rb +141 -0
  209. data/lib/twilio-ruby/rest/flex_api/v1/insights_user_roles.rb +196 -0
  210. data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb +251 -0
  211. data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb +339 -0
  212. data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb +406 -0
  213. data/lib/twilio-ruby/rest/flex_api/v1/interaction.rb +267 -0
  214. data/lib/twilio-ruby/rest/flex_api/v1/provisioning_status.rb +187 -0
  215. data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +378 -331
  216. data/lib/twilio-ruby/rest/flex_api/v1.rb +201 -76
  217. data/lib/twilio-ruby/rest/flex_api/v2/web_channels.rb +146 -0
  218. data/lib/twilio-ruby/rest/flex_api/v2.rb +40 -0
  219. data/lib/twilio-ruby/rest/flex_api.rb +33 -31
  220. data/lib/twilio-ruby/rest/flex_api_base.rb +43 -0
  221. data/lib/twilio-ruby/rest/frontline_api/v1/user.rb +244 -227
  222. data/lib/twilio-ruby/rest/frontline_api/v1.rb +42 -38
  223. data/lib/twilio-ruby/rest/frontline_api.rb +2 -34
  224. data/lib/twilio-ruby/rest/frontline_api_base.rb +38 -0
  225. data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb +319 -0
  226. data/lib/twilio-ruby/rest/insights/v1/call/call_summary.rb +350 -0
  227. data/lib/twilio-ruby/rest/insights/v1/call/event.rb +269 -255
  228. data/lib/twilio-ruby/rest/insights/v1/call/metric.rb +241 -225
  229. data/lib/twilio-ruby/rest/insights/v1/call.rb +260 -228
  230. data/lib/twilio-ruby/rest/insights/v1/call_summaries.rb +485 -426
  231. data/lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb +488 -0
  232. data/lib/twilio-ruby/rest/insights/v1/conference.rb +505 -0
  233. data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +378 -371
  234. data/lib/twilio-ruby/rest/insights/v1/room.rb +490 -489
  235. data/lib/twilio-ruby/rest/insights/v1/setting.rb +254 -0
  236. data/lib/twilio-ruby/rest/insights/v1.rb +84 -60
  237. data/lib/twilio-ruby/rest/insights.rb +17 -31
  238. data/lib/twilio-ruby/rest/insights_base.rb +38 -0
  239. data/lib/twilio-ruby/rest/intelligence/v2/service.rb +510 -0
  240. data/lib/twilio-ruby/rest/intelligence/v2/transcript/media.rb +226 -0
  241. data/lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb +388 -0
  242. data/lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb +248 -0
  243. data/lib/twilio-ruby/rest/intelligence/v2/transcript.rb +520 -0
  244. data/lib/twilio-ruby/rest/intelligence/v2.rb +64 -0
  245. data/lib/twilio-ruby/rest/intelligence.rb +6 -0
  246. data/lib/twilio-ruby/rest/intelligence_base.rb +38 -0
  247. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +419 -364
  248. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +374 -359
  249. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +422 -397
  250. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +438 -409
  251. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +534 -488
  252. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +396 -347
  253. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +244 -233
  254. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +465 -418
  255. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +861 -779
  256. data/lib/twilio-ruby/rest/ip_messaging/v1.rb +57 -53
  257. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +419 -364
  258. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +371 -343
  259. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +374 -359
  260. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +486 -451
  261. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +513 -479
  262. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +440 -411
  263. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +606 -555
  264. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +396 -347
  265. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +364 -351
  266. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +397 -384
  267. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +509 -467
  268. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +764 -689
  269. data/lib/twilio-ruby/rest/ip_messaging/v2.rb +57 -53
  270. data/lib/twilio-ruby/rest/ip_messaging.rb +3 -41
  271. data/lib/twilio-ruby/rest/ip_messaging_base.rb +43 -0
  272. data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +243 -239
  273. data/lib/twilio-ruby/rest/lookups/v1.rb +42 -39
  274. data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb +370 -0
  275. data/lib/twilio-ruby/rest/lookups/v2.rb +49 -0
  276. data/lib/twilio-ruby/rest/lookups.rb +2 -34
  277. data/lib/twilio-ruby/rest/lookups_base.rb +43 -0
  278. data/lib/twilio-ruby/rest/media/v1/media_processor.rb +410 -374
  279. data/lib/twilio-ruby/rest/media/v1/media_recording.rb +404 -0
  280. data/lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb +245 -214
  281. data/lib/twilio-ruby/rest/media/v1/player_streamer.rb +422 -380
  282. data/lib/twilio-ruby/rest/media/v1.rb +72 -53
  283. data/lib/twilio-ruby/rest/media.rb +13 -34
  284. data/lib/twilio-ruby/rest/media_base.rb +38 -0
  285. data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_registration_otp.rb +136 -0
  286. data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb +358 -346
  287. data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb +487 -420
  288. data/lib/twilio-ruby/rest/messaging/v1/deactivations.rb +189 -0
  289. data/lib/twilio-ruby/rest/messaging/v1/domain_certs.rb +280 -0
  290. data/lib/twilio-ruby/rest/messaging/v1/domain_config.rb +289 -0
  291. data/lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb +238 -0
  292. data/lib/twilio-ruby/rest/messaging/v1/external_campaign.rb +155 -144
  293. data/lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service.rb +214 -0
  294. data/lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service_domain_association.rb +196 -0
  295. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +351 -335
  296. data/lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb +329 -0
  297. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +358 -341
  298. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +358 -336
  299. data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb +506 -426
  300. data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person_usecase.rb +121 -115
  301. data/lib/twilio-ruby/rest/messaging/v1/service.rb +767 -763
  302. data/lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb +777 -0
  303. data/lib/twilio-ruby/rest/messaging/v1/usecase.rb +106 -94
  304. data/lib/twilio-ruby/rest/messaging/v1.rb +187 -74
  305. data/lib/twilio-ruby/rest/messaging.rb +36 -35
  306. data/lib/twilio-ruby/rest/messaging_base.rb +38 -0
  307. data/lib/twilio-ruby/rest/microvisor/v1/account_config.rb +358 -0
  308. data/lib/twilio-ruby/rest/microvisor/v1/account_secret.rb +351 -0
  309. data/lib/twilio-ruby/rest/microvisor/v1/app/app_manifest.rb +208 -0
  310. data/lib/twilio-ruby/rest/microvisor/v1/app.rb +349 -0
  311. data/lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb +374 -0
  312. data/lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb +367 -0
  313. data/lib/twilio-ruby/rest/microvisor/v1/device.rb +427 -0
  314. data/lib/twilio-ruby/rest/microvisor/v1.rb +94 -0
  315. data/lib/twilio-ruby/rest/microvisor.rb +24 -0
  316. data/lib/twilio-ruby/rest/microvisor_base.rb +38 -0
  317. data/lib/twilio-ruby/rest/monitor/v1/alert.rb +398 -395
  318. data/lib/twilio-ruby/rest/monitor/v1/event.rb +381 -390
  319. data/lib/twilio-ruby/rest/monitor/v1.rb +57 -53
  320. data/lib/twilio-ruby/rest/monitor.rb +3 -34
  321. data/lib/twilio-ruby/rest/monitor_base.rb +38 -0
  322. data/lib/twilio-ruby/rest/notify/v1/credential.rb +421 -408
  323. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +437 -452
  324. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +313 -362
  325. data/lib/twilio-ruby/rest/notify/v1/service.rb +626 -622
  326. data/lib/twilio-ruby/rest/notify/v1.rb +57 -55
  327. data/lib/twilio-ruby/rest/notify.rb +3 -34
  328. data/lib/twilio-ruby/rest/notify_base.rb +38 -0
  329. data/lib/twilio-ruby/rest/numbers/v1/bulk_eligibility.rb +224 -0
  330. data/lib/twilio-ruby/rest/numbers/v1/porting_bulk_portability.rb +229 -0
  331. data/lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb +245 -0
  332. data/lib/twilio-ruby/rest/numbers/v1/porting_portability.rb +263 -0
  333. data/lib/twilio-ruby/rest/numbers/v1.rb +94 -0
  334. data/lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb +343 -0
  335. data/lib/twilio-ruby/rest/numbers/v2/authorization_document.rb +403 -0
  336. data/lib/twilio-ruby/rest/numbers/v2/bulk_hosted_number_order.rb +249 -0
  337. data/lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb +502 -0
  338. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb +276 -179
  339. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb +324 -298
  340. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/item_assignment.rb +333 -309
  341. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/replace_items.rb +194 -181
  342. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb +601 -550
  343. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb +391 -351
  344. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb +290 -266
  345. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb +322 -307
  346. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb +412 -364
  347. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb +290 -266
  348. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance.rb +177 -181
  349. data/lib/twilio-ruby/rest/numbers/v2.rb +78 -28
  350. data/lib/twilio-ruby/rest/numbers.rb +2 -34
  351. data/lib/twilio-ruby/rest/numbers_base.rb +43 -0
  352. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb +410 -375
  353. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb +394 -358
  354. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb +449 -418
  355. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb +407 -369
  356. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb +494 -459
  357. data/lib/twilio-ruby/rest/preview/deployed_devices.rb +42 -38
  358. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +370 -396
  359. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +446 -446
  360. data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +610 -625
  361. data/lib/twilio-ruby/rest/preview/hosted_numbers.rb +57 -55
  362. data/lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb +301 -298
  363. data/lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb +325 -309
  364. data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb +342 -330
  365. data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb +429 -398
  366. data/lib/twilio-ruby/rest/preview/marketplace.rb +57 -53
  367. data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb +378 -374
  368. data/lib/twilio-ruby/rest/preview/sync/service/document.rb +442 -399
  369. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +434 -407
  370. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb +378 -374
  371. data/lib/twilio-ruby/rest/preview/sync/service/sync_list.rb +419 -398
  372. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb +437 -404
  373. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb +378 -374
  374. data/lib/twilio-ruby/rest/preview/sync/service/sync_map.rb +419 -398
  375. data/lib/twilio-ruby/rest/preview/sync/service.rb +495 -452
  376. data/lib/twilio-ruby/rest/preview/sync.rb +42 -37
  377. data/lib/twilio-ruby/rest/preview/wireless/command.rb +387 -364
  378. data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +448 -398
  379. data/lib/twilio-ruby/rest/preview/wireless/sim/usage.rb +232 -205
  380. data/lib/twilio-ruby/rest/preview/wireless/sim.rb +574 -523
  381. data/lib/twilio-ruby/rest/preview/wireless.rb +72 -69
  382. data/lib/twilio-ruby/rest/preview.rb +11 -137
  383. data/lib/twilio-ruby/rest/preview_base.rb +58 -0
  384. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +297 -275
  385. data/lib/twilio-ruby/rest/pricing/v1/messaging.rb +107 -119
  386. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +290 -268
  387. data/lib/twilio-ruby/rest/pricing/v1/phone_number.rb +107 -119
  388. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +297 -275
  389. data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +220 -197
  390. data/lib/twilio-ruby/rest/pricing/v1/voice.rb +121 -135
  391. data/lib/twilio-ruby/rest/pricing/v1.rb +45 -42
  392. data/lib/twilio-ruby/rest/pricing/v2/country.rb +289 -270
  393. data/lib/twilio-ruby/rest/pricing/v2/number.rb +232 -217
  394. data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +297 -275
  395. data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +238 -220
  396. data/lib/twilio-ruby/rest/pricing/v2/voice.rb +121 -138
  397. data/lib/twilio-ruby/rest/pricing/v2.rb +63 -65
  398. data/lib/twilio-ruby/rest/pricing.rb +6 -41
  399. data/lib/twilio-ruby/rest/pricing_base.rb +43 -0
  400. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +419 -403
  401. data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +408 -418
  402. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb +430 -449
  403. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +421 -455
  404. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +522 -547
  405. data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb +399 -370
  406. data/lib/twilio-ruby/rest/proxy/v1/service.rb +559 -596
  407. data/lib/twilio-ruby/rest/proxy/v1.rb +42 -38
  408. data/lib/twilio-ruby/rest/proxy.rb +2 -34
  409. data/lib/twilio-ruby/rest/proxy_base.rb +38 -0
  410. data/lib/twilio-ruby/rest/routes/v2/phone_number.rb +268 -0
  411. data/lib/twilio-ruby/rest/routes/v2/sip_domain.rb +268 -0
  412. data/lib/twilio-ruby/rest/routes/v2/trunk.rb +268 -0
  413. data/lib/twilio-ruby/rest/routes/v2.rb +79 -0
  414. data/lib/twilio-ruby/rest/routes.rb +32 -0
  415. data/lib/twilio-ruby/rest/routes_base.rb +38 -0
  416. data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +315 -323
  417. data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +412 -380
  418. data/lib/twilio-ruby/rest/serverless/v1/service/build/build_status.rb +208 -208
  419. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +407 -384
  420. data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +336 -338
  421. data/lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb +361 -383
  422. data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +403 -396
  423. data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +456 -447
  424. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version/function_version_content.rb +223 -234
  425. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +342 -353
  426. data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +412 -380
  427. data/lib/twilio-ruby/rest/serverless/v1/service.rb +523 -493
  428. data/lib/twilio-ruby/rest/serverless/v1.rb +42 -37
  429. data/lib/twilio-ruby/rest/serverless.rb +2 -34
  430. data/lib/twilio-ruby/rest/serverless_base.rb +38 -0
  431. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb +206 -199
  432. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb +221 -218
  433. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb +361 -355
  434. data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb +422 -394
  435. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb +206 -200
  436. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb +221 -221
  437. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb +361 -361
  438. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +468 -449
  439. data/lib/twilio-ruby/rest/studio/v1/flow.rb +380 -355
  440. data/lib/twilio-ruby/rest/studio/v1.rb +42 -37
  441. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_context.rb +206 -200
  442. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step/execution_step_context.rb +221 -221
  443. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb +361 -361
  444. data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +461 -442
  445. data/lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb +341 -320
  446. data/lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb +232 -0
  447. data/lib/twilio-ruby/rest/studio/v2/flow.rb +519 -472
  448. data/lib/twilio-ruby/rest/studio/v2/flow_validate.rb +121 -99
  449. data/lib/twilio-ruby/rest/studio/v2.rb +48 -44
  450. data/lib/twilio-ruby/rest/studio.rb +3 -41
  451. data/lib/twilio-ruby/rest/studio_base.rb +43 -0
  452. data/lib/twilio-ruby/rest/supersim/v1/esim_profile.rb +403 -0
  453. data/lib/twilio-ruby/rest/supersim/v1/fleet.rb +472 -484
  454. data/lib/twilio-ruby/rest/supersim/v1/ip_command.rb +398 -406
  455. data/lib/twilio-ruby/rest/supersim/v1/network.rb +302 -297
  456. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile/network_access_profile_network.rb +337 -332
  457. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb +380 -351
  458. data/lib/twilio-ruby/rest/supersim/v1/settings_update.rb +256 -0
  459. data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb +242 -224
  460. data/lib/twilio-ruby/rest/supersim/v1/sim/sim_ip_address.rb +207 -0
  461. data/lib/twilio-ruby/rest/supersim/v1/sim.rb +460 -433
  462. data/lib/twilio-ruby/rest/supersim/v1/sms_command.rb +358 -361
  463. data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +286 -311
  464. data/lib/twilio-ruby/rest/supersim/v1.rb +144 -140
  465. data/lib/twilio-ruby/rest/supersim.rb +22 -40
  466. data/lib/twilio-ruby/rest/supersim_base.rb +38 -0
  467. data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +376 -371
  468. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +456 -423
  469. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +466 -490
  470. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +376 -370
  471. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +470 -445
  472. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +469 -495
  473. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +376 -368
  474. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +470 -444
  475. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +139 -132
  476. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +419 -400
  477. data/lib/twilio-ruby/rest/sync/v1/service.rb +575 -567
  478. data/lib/twilio-ruby/rest/sync/v1.rb +42 -37
  479. data/lib/twilio-ruby/rest/sync.rb +2 -34
  480. data/lib/twilio-ruby/rest/sync_base.rb +38 -0
  481. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +405 -395
  482. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +442 -464
  483. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +705 -736
  484. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +623 -661
  485. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +409 -382
  486. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +359 -365
  487. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +279 -275
  488. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +230 -236
  489. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +239 -258
  490. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +574 -566
  491. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +687 -732
  492. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +389 -388
  493. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +235 -239
  494. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +281 -265
  495. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +215 -193
  496. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +251 -234
  497. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +623 -631
  498. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +359 -373
  499. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb +245 -241
  500. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +230 -244
  501. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +523 -510
  502. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +353 -354
  503. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +231 -206
  504. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +241 -234
  505. data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +720 -730
  506. data/lib/twilio-ruby/rest/taskrouter/v1.rb +42 -37
  507. data/lib/twilio-ruby/rest/taskrouter.rb +2 -34
  508. data/lib/twilio-ruby/rest/taskrouter_base.rb +38 -0
  509. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +342 -320
  510. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +342 -317
  511. data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +440 -419
  512. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +475 -451
  513. data/lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb +224 -191
  514. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +623 -630
  515. data/lib/twilio-ruby/rest/trunking/v1.rb +42 -38
  516. data/lib/twilio-ruby/rest/trunking.rb +2 -34
  517. data/lib/twilio-ruby/rest/trunking_base.rb +38 -0
  518. data/lib/twilio-ruby/rest/trusthub/v1/compliance_inquiries.rb +232 -0
  519. data/lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb +211 -0
  520. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb +357 -352
  521. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb +335 -323
  522. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_evaluations.rb +333 -321
  523. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb +525 -513
  524. data/lib/twilio-ruby/rest/trusthub/v1/end_user.rb +383 -346
  525. data/lib/twilio-ruby/rest/trusthub/v1/end_user_type.rb +282 -261
  526. data/lib/twilio-ruby/rest/trusthub/v1/policies.rb +275 -252
  527. data/lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb +397 -359
  528. data/lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb +282 -261
  529. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb +357 -352
  530. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_entity_assignments.rb +335 -323
  531. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_evaluations.rb +333 -321
  532. data/lib/twilio-ruby/rest/trusthub/v1/trust_products.rb +525 -513
  533. data/lib/twilio-ruby/rest/trusthub/v1.rb +153 -139
  534. data/lib/twilio-ruby/rest/trusthub.rb +8 -34
  535. data/lib/twilio-ruby/rest/trusthub_base.rb +38 -0
  536. data/lib/twilio-ruby/rest/verify/v2/form.rb +195 -183
  537. data/lib/twilio-ruby/rest/verify/v2/safelist.rb +231 -0
  538. data/lib/twilio-ruby/rest/verify/v2/service/access_token.rb +265 -116
  539. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb +191 -198
  540. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +496 -521
  541. data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +447 -454
  542. data/lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb +249 -279
  543. data/lib/twilio-ruby/rest/verify/v2/service/entity.rb +422 -422
  544. data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +379 -363
  545. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +401 -388
  546. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +420 -384
  547. data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +380 -359
  548. data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +218 -198
  549. data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb +447 -420
  550. data/lib/twilio-ruby/rest/verify/v2/service.rb +782 -770
  551. data/lib/twilio-ruby/rest/verify/v2/template.rb +221 -198
  552. data/lib/twilio-ruby/rest/verify/v2/verification_attempt.rb +372 -319
  553. data/lib/twilio-ruby/rest/verify/v2/verification_attempts_summary.rb +247 -0
  554. data/lib/twilio-ruby/rest/verify/v2.rb +99 -78
  555. data/lib/twilio-ruby/rest/verify.rb +23 -36
  556. data/lib/twilio-ruby/rest/verify_base.rb +38 -0
  557. data/lib/twilio-ruby/rest/video/v1/composition.rb +477 -486
  558. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +525 -647
  559. data/lib/twilio-ruby/rest/video/v1/composition_settings.rb +281 -261
  560. data/lib/twilio-ruby/rest/video/v1/recording.rb +426 -405
  561. data/lib/twilio-ruby/rest/video/v1/recording_settings.rb +281 -261
  562. data/lib/twilio-ruby/rest/video/v1/room/participant/anonymize.rb +259 -0
  563. data/lib/twilio-ruby/rest/video/v1/room/participant/published_track.rb +331 -0
  564. data/lib/twilio-ruby/rest/video/v1/room/participant/subscribe_rules.rb +181 -0
  565. data/lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb +338 -0
  566. data/lib/twilio-ruby/rest/video/v1/room/participant.rb +498 -0
  567. data/lib/twilio-ruby/rest/video/v1/room/recording_rules.rb +170 -0
  568. data/lib/twilio-ruby/rest/video/v1/room/room_recording.rb +423 -0
  569. data/lib/twilio-ruby/rest/video/v1/room.rb +606 -567
  570. data/lib/twilio-ruby/rest/video/v1.rb +99 -99
  571. data/lib/twilio-ruby/rest/video.rb +7 -34
  572. data/lib/twilio-ruby/rest/video_base.rb +38 -0
  573. data/lib/twilio-ruby/rest/voice/v1/archived_call.rb +168 -0
  574. data/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb +501 -486
  575. data/lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb +440 -434
  576. data/lib/twilio-ruby/rest/voice/v1/connection_policy.rb +391 -352
  577. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/bulk_country_update.rb +135 -121
  578. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +195 -183
  579. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +375 -397
  580. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/settings.rb +217 -190
  581. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +122 -121
  582. data/lib/twilio-ruby/rest/voice/v1/ip_record.rb +377 -339
  583. data/lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb +360 -319
  584. data/lib/twilio-ruby/rest/voice/v1.rb +130 -96
  585. data/lib/twilio-ruby/rest/voice.rb +12 -31
  586. data/lib/twilio-ruby/rest/voice_base.rb +38 -0
  587. data/lib/twilio-ruby/rest/wireless/v1/command.rb +408 -406
  588. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +463 -436
  589. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +298 -284
  590. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +239 -243
  591. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +634 -647
  592. data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +226 -221
  593. data/lib/twilio-ruby/rest/wireless/v1.rb +78 -76
  594. data/lib/twilio-ruby/rest/wireless.rb +5 -34
  595. data/lib/twilio-ruby/rest/wireless_base.rb +38 -0
  596. data/lib/twilio-ruby/rest.rb +1 -0
  597. data/lib/twilio-ruby/security/request_validator.rb +1 -1
  598. data/lib/twilio-ruby/twiml/voice_response.rb +209 -42
  599. data/lib/twilio-ruby/version.rb +1 -1
  600. data/lib/twilio-ruby.rb +1 -1
  601. data/sonar-project.properties +2 -2
  602. data/twilio-ruby.gemspec +2 -3
  603. metadata +155 -98
  604. data/.github/workflows/deploy.yml +0 -65
  605. data/.github/workflows/test.yml +0 -52
  606. data/conf/cacert.pem +0 -3376
  607. data/lib/twilio-ruby/framework/twilio_response.rb +0 -19
  608. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +0 -500
  609. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +0 -500
  610. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +0 -500
  611. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +0 -500
  612. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +0 -500
  613. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +0 -500
  614. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +0 -500
  615. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +0 -464
  616. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +0 -348
  617. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb +0 -163
  618. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb +0 -137
  619. data/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb +0 -220
  620. data/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb +0 -214
  621. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +0 -399
  622. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +0 -418
  623. data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +0 -392
  624. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +0 -469
  625. data/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb +0 -218
  626. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +0 -386
  627. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +0 -456
  628. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb +0 -255
  629. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +0 -237
  630. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +0 -507
  631. data/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb +0 -420
  632. data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +0 -650
  633. data/lib/twilio-ruby/rest/autopilot/v1/restore_assistant.rb +0 -194
  634. data/lib/twilio-ruby/rest/autopilot/v1.rb +0 -52
  635. data/lib/twilio-ruby/rest/autopilot.rb +0 -53
  636. data/lib/twilio-ruby/rest/events/v1/schema/version.rb +0 -290
  637. data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb +0 -314
  638. data/lib/twilio-ruby/rest/fax/v1/fax.rb +0 -536
  639. data/lib/twilio-ruby/rest/fax/v1.rb +0 -45
  640. data/lib/twilio-ruby/rest/fax.rb +0 -47
  641. data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +0 -307
  642. data/lib/twilio-ruby/rest/messaging/v1/deactivation.rb +0 -164
  643. data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb +0 -294
  644. data/lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb +0 -275
  645. data/lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb +0 -249
  646. data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb +0 -251
  647. data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb +0 -234
  648. data/lib/twilio-ruby/rest/preview/bulk_exports.rb +0 -62
  649. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_channel/channel.rb +0 -165
  650. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_channel.rb +0 -225
  651. data/lib/twilio-ruby/rest/preview/trusted_comms/brands_information.rb +0 -195
  652. data/lib/twilio-ruby/rest/preview/trusted_comms/cps.rb +0 -186
  653. data/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb +0 -277
  654. data/lib/twilio-ruby/rest/preview/trusted_comms.rb +0 -65
  655. data/lib/twilio-ruby/rest/preview/understand/assistant/assistant_fallback_actions.rb +0 -212
  656. data/lib/twilio-ruby/rest/preview/understand/assistant/assistant_initiation_actions.rb +0 -212
  657. data/lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb +0 -206
  658. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +0 -386
  659. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +0 -407
  660. data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +0 -380
  661. data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +0 -437
  662. data/lib/twilio-ruby/rest/preview/understand/assistant/style_sheet.rb +0 -212
  663. data/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb +0 -373
  664. data/lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb +0 -428
  665. data/lib/twilio-ruby/rest/preview/understand/assistant/task/task_actions.rb +0 -241
  666. data/lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb +0 -225
  667. data/lib/twilio-ruby/rest/preview/understand/assistant/task.rb +0 -495
  668. data/lib/twilio-ruby/rest/preview/understand/assistant.rb +0 -629
  669. data/lib/twilio-ruby/rest/preview/understand.rb +0 -45
  670. data/lib/twilio-ruby/rest/studio/v2/flow/test_user.rb +0 -199
  671. data/lib/twilio-ruby/rest/supersim/v1/command.rb +0 -368
  672. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +0 -406
  673. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb +0 -335
  674. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +0 -175
  675. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb +0 -340
  676. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +0 -483
  677. data/lib/twilio-ruby/rest/video/v1/room/room_recording_rule.rb +0 -144
@@ -1,904 +1,871 @@
1
1
  ##
2
- # This code was generated by
3
- # \ / _ _ _| _ _
4
- # | (_)\/(_)(_|\/| |(/_ v1.0.0
5
- # / /
2
+ # This code was generated by
3
+ # ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
4
+ # | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
5
+ # | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
6
6
  #
7
- # frozen_string_literal: true
7
+ # Twilio - Chat
8
+ # This is the public Twilio REST API.
9
+ #
10
+ # NOTE: This class is auto generated by OpenAPI Generator.
11
+ # https://openapi-generator.tech
12
+ # Do not edit the class manually.
13
+ #
14
+
8
15
 
9
16
  module Twilio
10
- module REST
11
- class Chat < Domain
12
- class V1 < Version
13
- class ServiceList < ListResource
14
- ##
15
- # Initialize the ServiceList
16
- # @param [Version] version Version that contains the resource
17
- # @return [ServiceList] ServiceList
18
- def initialize(version)
19
- super(version)
20
-
21
- # Path Solution
22
- @solution = {}
23
- @uri = "/Services"
24
- end
25
-
26
- ##
27
- # Create the ServiceInstance
28
- # @param [String] friendly_name A descriptive string that you create to describe
29
- # the resource. It can be up to 64 characters long.
30
- # @return [ServiceInstance] Created ServiceInstance
31
- def create(friendly_name: nil)
32
- data = Twilio::Values.of({'FriendlyName' => friendly_name, })
33
-
34
- payload = @version.create('POST', @uri, data: data)
35
-
36
- ServiceInstance.new(@version, payload, )
37
- end
38
-
39
- ##
40
- # Lists ServiceInstance records from the API as a list.
41
- # Unlike stream(), this operation is eager and will load `limit` records into
42
- # memory before returning.
43
- # @param [Integer] limit Upper limit for the number of records to return. stream()
44
- # guarantees to never return more than limit. Default is no limit
45
- # @param [Integer] page_size Number of records to fetch per request, when
46
- # not set will use the default value of 50 records. If no page_size is defined
47
- # but a limit is defined, stream() will attempt to read the limit with the most
48
- # efficient page size, i.e. min(limit, 1000)
49
- # @return [Array] Array of up to limit results
50
- def list(limit: nil, page_size: nil)
51
- self.stream(limit: limit, page_size: page_size).entries
52
- end
53
-
54
- ##
55
- # Streams ServiceInstance records from the API as an Enumerable.
56
- # This operation lazily loads records as efficiently as possible until the limit
57
- # is reached.
58
- # @param [Integer] limit Upper limit for the number of records to return. stream()
59
- # guarantees to never return more than limit. Default is no limit.
60
- # @param [Integer] page_size Number of records to fetch per request, when
61
- # not set will use the default value of 50 records. If no page_size is defined
62
- # but a limit is defined, stream() will attempt to read the limit with the most
63
- # efficient page size, i.e. min(limit, 1000)
64
- # @return [Enumerable] Enumerable that will yield up to limit results
65
- def stream(limit: nil, page_size: nil)
66
- limits = @version.read_limits(limit, page_size)
67
-
68
- page = self.page(page_size: limits[:page_size], )
69
-
70
- @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
71
- end
72
-
73
- ##
74
- # When passed a block, yields ServiceInstance records from the API.
75
- # This operation lazily loads records as efficiently as possible until the limit
76
- # is reached.
77
- def each
78
- limits = @version.read_limits
79
-
80
- page = self.page(page_size: limits[:page_size], )
81
-
82
- @version.stream(page,
17
+ module REST
18
+ class Chat < ChatBase
19
+ class V1 < Version
20
+ class ServiceList < ListResource
21
+ ##
22
+ # Initialize the ServiceList
23
+ # @param [Version] version Version that contains the resource
24
+ # @return [ServiceList] ServiceList
25
+ def initialize(version)
26
+ super(version)
27
+ # Path Solution
28
+ @solution = { }
29
+ @uri = "/Services"
30
+
31
+ end
32
+ ##
33
+ # Create the ServiceInstance
34
+ # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
35
+ # @return [ServiceInstance] Created ServiceInstance
36
+ def create(
37
+ friendly_name: nil
38
+ )
39
+
40
+ data = Twilio::Values.of({
41
+ 'FriendlyName' => friendly_name,
42
+ })
43
+
44
+ payload = @version.create('POST', @uri, data: data)
45
+ ServiceInstance.new(
46
+ @version,
47
+ payload,
48
+ )
49
+ end
50
+
51
+
52
+ ##
53
+ # Lists ServiceInstance records from the API as a list.
54
+ # Unlike stream(), this operation is eager and will load `limit` records into
55
+ # memory before returning.
56
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
57
+ # guarantees to never return more than limit. Default is no limit
58
+ # @param [Integer] page_size Number of records to fetch per request, when
59
+ # not set will use the default value of 50 records. If no page_size is defined
60
+ # but a limit is defined, stream() will attempt to read the limit with the most
61
+ # efficient page size, i.e. min(limit, 1000)
62
+ # @return [Array] Array of up to limit results
63
+ def list(limit: nil, page_size: nil)
64
+ self.stream(
65
+ limit: limit,
66
+ page_size: page_size
67
+ ).entries
68
+ end
69
+
70
+ ##
71
+ # Streams Instance records from the API as an Enumerable.
72
+ # This operation lazily loads records as efficiently as possible until the limit
73
+ # is reached.
74
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
75
+ # guarantees to never return more than limit. Default is no limit
76
+ # @param [Integer] page_size Number of records to fetch per request, when
77
+ # not set will use the default value of 50 records. If no page_size is defined
78
+ # but a limit is defined, stream() will attempt to read the limit with the most
79
+ # efficient page size, i.e. min(limit, 1000)
80
+ # @return [Enumerable] Enumerable that will yield up to limit results
81
+ def stream(limit: nil, page_size: nil)
82
+ limits = @version.read_limits(limit, page_size)
83
+
84
+ page = self.page(
85
+ page_size: limits[:page_size], )
86
+
87
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
88
+ end
89
+
90
+ ##
91
+ # When passed a block, yields ServiceInstance records from the API.
92
+ # This operation lazily loads records as efficiently as possible until the limit
93
+ # is reached.
94
+ def each
95
+ limits = @version.read_limits
96
+
97
+ page = self.page(page_size: limits[:page_size], )
98
+
99
+ @version.stream(page,
83
100
  limit: limits[:limit],
84
101
  page_limit: limits[:page_limit]).each {|x| yield x}
85
- end
86
-
87
- ##
88
- # Retrieve a single page of ServiceInstance records from the API.
89
- # Request is executed immediately.
90
- # @param [String] page_token PageToken provided by the API
91
- # @param [Integer] page_number Page Number, this value is simply for client state
92
- # @param [Integer] page_size Number of records to return, defaults to 50
93
- # @return [Page] Page of ServiceInstance
94
- def page(page_token: :unset, page_number: :unset, page_size: :unset)
95
- params = Twilio::Values.of({
96
- 'PageToken' => page_token,
97
- 'Page' => page_number,
98
- 'PageSize' => page_size,
99
- })
100
-
101
- response = @version.page('GET', @uri, params: params)
102
-
103
- ServicePage.new(@version, response, @solution)
104
- end
105
-
106
- ##
107
- # Retrieve a single page of ServiceInstance records from the API.
108
- # Request is executed immediately.
109
- # @param [String] target_url API-generated URL for the requested results page
110
- # @return [Page] Page of ServiceInstance
111
- def get_page(target_url)
112
- response = @version.domain.request(
113
- 'GET',
114
- target_url
115
- )
116
- ServicePage.new(@version, response, @solution)
117
- end
118
-
119
- ##
120
- # Provide a user friendly representation
121
- def to_s
122
- '#<Twilio.Chat.V1.ServiceList>'
123
- end
124
- end
125
-
126
- class ServicePage < Page
127
- ##
128
- # Initialize the ServicePage
129
- # @param [Version] version Version that contains the resource
130
- # @param [Response] response Response from the API
131
- # @param [Hash] solution Path solution for the resource
132
- # @return [ServicePage] ServicePage
133
- def initialize(version, response, solution)
134
- super(version, response)
135
-
136
- # Path Solution
137
- @solution = solution
138
- end
139
-
140
- ##
141
- # Build an instance of ServiceInstance
142
- # @param [Hash] payload Payload response from the API
143
- # @return [ServiceInstance] ServiceInstance
144
- def get_instance(payload)
145
- ServiceInstance.new(@version, payload, )
146
- end
147
-
148
- ##
149
- # Provide a user friendly representation
150
- def to_s
151
- '<Twilio.Chat.V1.ServicePage>'
152
- end
153
- end
154
-
155
- class ServiceContext < InstanceContext
156
- ##
157
- # Initialize the ServiceContext
158
- # @param [Version] version Version that contains the resource
159
- # @param [String] sid The Twilio-provided string that uniquely identifies the
160
- # Service resource to fetch.
161
- # @return [ServiceContext] ServiceContext
162
- def initialize(version, sid)
163
- super(version)
164
-
165
- # Path Solution
166
- @solution = {sid: sid, }
167
- @uri = "/Services/#{@solution[:sid]}"
168
-
169
- # Dependents
170
- @channels = nil
171
- @roles = nil
172
- @users = nil
173
- end
174
-
175
- ##
176
- # Fetch the ServiceInstance
177
- # @return [ServiceInstance] Fetched ServiceInstance
178
- def fetch
179
- payload = @version.fetch('GET', @uri)
180
-
181
- ServiceInstance.new(@version, payload, sid: @solution[:sid], )
182
- end
183
-
184
- ##
185
- # Delete the ServiceInstance
186
- # @return [Boolean] true if delete succeeds, false otherwise
187
- def delete
188
- @version.delete('DELETE', @uri)
189
- end
190
-
191
- ##
192
- # Update the ServiceInstance
193
- # @param [String] friendly_name A descriptive string that you create to describe
194
- # the resource. It can be up to 64 characters long.
195
- # @param [String] default_service_role_sid The service role assigned to users when
196
- # they are added to the service. See the {Roles
197
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
198
- # @param [String] default_channel_role_sid The channel role assigned to users when
199
- # they are added to a channel. See the {Roles
200
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
201
- # @param [String] default_channel_creator_role_sid The channel role assigned to a
202
- # channel creator when they join a new channel. See the {Roles
203
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
204
- # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
205
- # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
206
- # default is `true`.
207
- # @param [Boolean] reachability_enabled Whether to enable the {Reachability
208
- # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
209
- # Service instance. The default is `false`.
210
- # @param [String] typing_indicator_timeout How long in seconds after a `started
211
- # typing` event until clients should assume that user is no longer typing, even if
212
- # no `ended typing` message was received. The default is 5 seconds.
213
- # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
214
- # between consumption reports submission batches from client endpoints.
215
- # @param [Boolean] notifications_new_message_enabled Whether to send a
216
- # notification when a new message is added to a channel. Can be: `true` or `false`
217
- # and the default is `false`.
218
- # @param [String] notifications_new_message_template The template to use to create
219
- # the notification text displayed when a new message is added to a channel and
220
- # `notifications.new_message.enabled` is `true`.
221
- # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
222
- # notification when a member is added to a channel. Can be: `true` or `false` and
223
- # the default is `false`.
224
- # @param [String] notifications_added_to_channel_template The template to use to
225
- # create the notification text displayed when a member is added to a channel and
226
- # `notifications.added_to_channel.enabled` is `true`.
227
- # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
228
- # notification to a user when they are removed from a channel. Can be: `true` or
229
- # `false` and the default is `false`.
230
- # @param [String] notifications_removed_from_channel_template The template to use
231
- # to create the notification text displayed to a user when they are removed from a
232
- # channel and `notifications.removed_from_channel.enabled` is `true`.
233
- # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
234
- # notification when a user is invited to a channel. Can be: `true` or `false` and
235
- # the default is `false`.
236
- # @param [String] notifications_invited_to_channel_template The template to use to
237
- # create the notification text displayed when a user is invited to a channel and
238
- # `notifications.invited_to_channel.enabled` is `true`.
239
- # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
240
- # by using the `webhook_method`. See {Webhook
241
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
242
- # @param [String] post_webhook_url The URL for post-event webhooks, which are
243
- # called by using the `webhook_method`. See {Webhook
244
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
245
- # @param [String] webhook_method The HTTP method to use for calls to the
246
- # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
247
- # the default is `POST`. See {Webhook
248
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
249
- # @param [Array[String]] webhook_filters The list of WebHook events that are
250
- # enabled for this Service instance. See {Webhook
251
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
252
- # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
253
- # response to the `on_message_send` event using the
254
- # `webhooks.on_message_send.method` HTTP method.
255
- # @param [String] webhooks_on_message_send_method The HTTP method to use when
256
- # calling the `webhooks.on_message_send.url`.
257
- # @param [String] webhooks_on_message_update_url The URL of the webhook to call in
258
- # response to the `on_message_update` event using the
259
- # `webhooks.on_message_update.method` HTTP method.
260
- # @param [String] webhooks_on_message_update_method The HTTP method to use when
261
- # calling the `webhooks.on_message_update.url`.
262
- # @param [String] webhooks_on_message_remove_url The URL of the webhook to call in
263
- # response to the `on_message_remove` event using the
264
- # `webhooks.on_message_remove.method` HTTP method.
265
- # @param [String] webhooks_on_message_remove_method The HTTP method to use when
266
- # calling the `webhooks.on_message_remove.url`.
267
- # @param [String] webhooks_on_channel_add_url The URL of the webhook to call in
268
- # response to the `on_channel_add` event using the
269
- # `webhooks.on_channel_add.method` HTTP method.
270
- # @param [String] webhooks_on_channel_add_method The HTTP method to use when
271
- # calling the `webhooks.on_channel_add.url`.
272
- # @param [String] webhooks_on_channel_destroy_url The URL of the webhook to call
273
- # in response to the `on_channel_destroy` event using the
274
- # `webhooks.on_channel_destroy.method` HTTP method.
275
- # @param [String] webhooks_on_channel_destroy_method The HTTP method to use when
276
- # calling the `webhooks.on_channel_destroy.url`.
277
- # @param [String] webhooks_on_channel_update_url The URL of the webhook to call in
278
- # response to the `on_channel_update` event using the
279
- # `webhooks.on_channel_update.method` HTTP method.
280
- # @param [String] webhooks_on_channel_update_method The HTTP method to use when
281
- # calling the `webhooks.on_channel_update.url`.
282
- # @param [String] webhooks_on_member_add_url The URL of the webhook to call in
283
- # response to the `on_member_add` event using the `webhooks.on_member_add.method`
284
- # HTTP method.
285
- # @param [String] webhooks_on_member_add_method The HTTP method to use when
286
- # calling the `webhooks.on_member_add.url`.
287
- # @param [String] webhooks_on_member_remove_url The URL of the webhook to call in
288
- # response to the `on_member_remove` event using the
289
- # `webhooks.on_member_remove.method` HTTP method.
290
- # @param [String] webhooks_on_member_remove_method The HTTP method to use when
291
- # calling the `webhooks.on_member_remove.url`.
292
- # @param [String] webhooks_on_message_sent_url The URL of the webhook to call in
293
- # response to the `on_message_sent` event using the
294
- # `webhooks.on_message_sent.method` HTTP method.
295
- # @param [String] webhooks_on_message_sent_method The URL of the webhook to call
296
- # in response to the `on_message_sent` event`.
297
- # @param [String] webhooks_on_message_updated_url The URL of the webhook to call
298
- # in response to the `on_message_updated` event using the
299
- # `webhooks.on_message_updated.method` HTTP method.
300
- # @param [String] webhooks_on_message_updated_method The HTTP method to use when
301
- # calling the `webhooks.on_message_updated.url`.
302
- # @param [String] webhooks_on_message_removed_url The URL of the webhook to call
303
- # in response to the `on_message_removed` event using the
304
- # `webhooks.on_message_removed.method` HTTP method.
305
- # @param [String] webhooks_on_message_removed_method The HTTP method to use when
306
- # calling the `webhooks.on_message_removed.url`.
307
- # @param [String] webhooks_on_channel_added_url The URL of the webhook to call in
308
- # response to the `on_channel_added` event using the
309
- # `webhooks.on_channel_added.method` HTTP method.
310
- # @param [String] webhooks_on_channel_added_method The URL of the webhook to call
311
- # in response to the `on_channel_added` event`.
312
- # @param [String] webhooks_on_channel_destroyed_url The URL of the webhook to call
313
- # in response to the `on_channel_added` event using the
314
- # `webhooks.on_channel_destroyed.method` HTTP method.
315
- # @param [String] webhooks_on_channel_destroyed_method The HTTP method to use when
316
- # calling the `webhooks.on_channel_destroyed.url`.
317
- # @param [String] webhooks_on_channel_updated_url The URL of the webhook to call
318
- # in response to the `on_channel_updated` event using the
319
- # `webhooks.on_channel_updated.method` HTTP method.
320
- # @param [String] webhooks_on_channel_updated_method The HTTP method to use when
321
- # calling the `webhooks.on_channel_updated.url`.
322
- # @param [String] webhooks_on_member_added_url The URL of the webhook to call in
323
- # response to the `on_channel_updated` event using the
324
- # `webhooks.on_channel_updated.method` HTTP method.
325
- # @param [String] webhooks_on_member_added_method The HTTP method to use when
326
- # calling the `webhooks.on_channel_updated.url`.
327
- # @param [String] webhooks_on_member_removed_url The URL of the webhook to call in
328
- # response to the `on_member_removed` event using the
329
- # `webhooks.on_member_removed.method` HTTP method.
330
- # @param [String] webhooks_on_member_removed_method The HTTP method to use when
331
- # calling the `webhooks.on_member_removed.url`.
332
- # @param [String] limits_channel_members The maximum number of Members that can be
333
- # added to Channels within this Service. Can be up to 1,000.
334
- # @param [String] limits_user_channels The maximum number of Channels Users can be
335
- # a Member of within this Service. Can be up to 1,000.
336
- # @return [ServiceInstance] Updated ServiceInstance
337
- def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset)
338
- data = Twilio::Values.of({
339
- 'FriendlyName' => friendly_name,
340
- 'DefaultServiceRoleSid' => default_service_role_sid,
341
- 'DefaultChannelRoleSid' => default_channel_role_sid,
342
- 'DefaultChannelCreatorRoleSid' => default_channel_creator_role_sid,
343
- 'ReadStatusEnabled' => read_status_enabled,
344
- 'ReachabilityEnabled' => reachability_enabled,
345
- 'TypingIndicatorTimeout' => typing_indicator_timeout,
346
- 'ConsumptionReportInterval' => consumption_report_interval,
347
- 'Notifications.NewMessage.Enabled' => notifications_new_message_enabled,
348
- 'Notifications.NewMessage.Template' => notifications_new_message_template,
349
- 'Notifications.AddedToChannel.Enabled' => notifications_added_to_channel_enabled,
350
- 'Notifications.AddedToChannel.Template' => notifications_added_to_channel_template,
351
- 'Notifications.RemovedFromChannel.Enabled' => notifications_removed_from_channel_enabled,
352
- 'Notifications.RemovedFromChannel.Template' => notifications_removed_from_channel_template,
353
- 'Notifications.InvitedToChannel.Enabled' => notifications_invited_to_channel_enabled,
354
- 'Notifications.InvitedToChannel.Template' => notifications_invited_to_channel_template,
355
- 'PreWebhookUrl' => pre_webhook_url,
356
- 'PostWebhookUrl' => post_webhook_url,
357
- 'WebhookMethod' => webhook_method,
358
- 'WebhookFilters' => Twilio.serialize_list(webhook_filters) { |e| e },
359
- 'Webhooks.OnMessageSend.Url' => webhooks_on_message_send_url,
360
- 'Webhooks.OnMessageSend.Method' => webhooks_on_message_send_method,
361
- 'Webhooks.OnMessageUpdate.Url' => webhooks_on_message_update_url,
362
- 'Webhooks.OnMessageUpdate.Method' => webhooks_on_message_update_method,
363
- 'Webhooks.OnMessageRemove.Url' => webhooks_on_message_remove_url,
364
- 'Webhooks.OnMessageRemove.Method' => webhooks_on_message_remove_method,
365
- 'Webhooks.OnChannelAdd.Url' => webhooks_on_channel_add_url,
366
- 'Webhooks.OnChannelAdd.Method' => webhooks_on_channel_add_method,
367
- 'Webhooks.OnChannelDestroy.Url' => webhooks_on_channel_destroy_url,
368
- 'Webhooks.OnChannelDestroy.Method' => webhooks_on_channel_destroy_method,
369
- 'Webhooks.OnChannelUpdate.Url' => webhooks_on_channel_update_url,
370
- 'Webhooks.OnChannelUpdate.Method' => webhooks_on_channel_update_method,
371
- 'Webhooks.OnMemberAdd.Url' => webhooks_on_member_add_url,
372
- 'Webhooks.OnMemberAdd.Method' => webhooks_on_member_add_method,
373
- 'Webhooks.OnMemberRemove.Url' => webhooks_on_member_remove_url,
374
- 'Webhooks.OnMemberRemove.Method' => webhooks_on_member_remove_method,
375
- 'Webhooks.OnMessageSent.Url' => webhooks_on_message_sent_url,
376
- 'Webhooks.OnMessageSent.Method' => webhooks_on_message_sent_method,
377
- 'Webhooks.OnMessageUpdated.Url' => webhooks_on_message_updated_url,
378
- 'Webhooks.OnMessageUpdated.Method' => webhooks_on_message_updated_method,
379
- 'Webhooks.OnMessageRemoved.Url' => webhooks_on_message_removed_url,
380
- 'Webhooks.OnMessageRemoved.Method' => webhooks_on_message_removed_method,
381
- 'Webhooks.OnChannelAdded.Url' => webhooks_on_channel_added_url,
382
- 'Webhooks.OnChannelAdded.Method' => webhooks_on_channel_added_method,
383
- 'Webhooks.OnChannelDestroyed.Url' => webhooks_on_channel_destroyed_url,
384
- 'Webhooks.OnChannelDestroyed.Method' => webhooks_on_channel_destroyed_method,
385
- 'Webhooks.OnChannelUpdated.Url' => webhooks_on_channel_updated_url,
386
- 'Webhooks.OnChannelUpdated.Method' => webhooks_on_channel_updated_method,
387
- 'Webhooks.OnMemberAdded.Url' => webhooks_on_member_added_url,
388
- 'Webhooks.OnMemberAdded.Method' => webhooks_on_member_added_method,
389
- 'Webhooks.OnMemberRemoved.Url' => webhooks_on_member_removed_url,
390
- 'Webhooks.OnMemberRemoved.Method' => webhooks_on_member_removed_method,
391
- 'Limits.ChannelMembers' => limits_channel_members,
392
- 'Limits.UserChannels' => limits_user_channels,
393
- })
394
-
395
- payload = @version.update('POST', @uri, data: data)
396
-
397
- ServiceInstance.new(@version, payload, sid: @solution[:sid], )
398
- end
399
-
400
- ##
401
- # Access the channels
402
- # @return [ChannelList]
403
- # @return [ChannelContext] if sid was passed.
404
- def channels(sid=:unset)
405
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
406
-
407
- if sid != :unset
408
- return ChannelContext.new(@version, @solution[:sid], sid, )
409
- end
410
-
411
- unless @channels
412
- @channels = ChannelList.new(@version, service_sid: @solution[:sid], )
413
- end
414
-
415
- @channels
416
- end
417
-
418
- ##
419
- # Access the roles
420
- # @return [RoleList]
421
- # @return [RoleContext] if sid was passed.
422
- def roles(sid=:unset)
423
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
424
-
425
- if sid != :unset
426
- return RoleContext.new(@version, @solution[:sid], sid, )
427
- end
428
-
429
- unless @roles
430
- @roles = RoleList.new(@version, service_sid: @solution[:sid], )
431
- end
432
-
433
- @roles
434
- end
435
-
436
- ##
437
- # Access the users
438
- # @return [UserList]
439
- # @return [UserContext] if sid was passed.
440
- def users(sid=:unset)
441
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
442
-
443
- if sid != :unset
444
- return UserContext.new(@version, @solution[:sid], sid, )
445
- end
446
-
447
- unless @users
448
- @users = UserList.new(@version, service_sid: @solution[:sid], )
449
- end
450
-
451
- @users
452
- end
453
-
454
- ##
455
- # Provide a user friendly representation
456
- def to_s
457
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
458
- "#<Twilio.Chat.V1.ServiceContext #{context}>"
459
- end
460
-
461
- ##
462
- # Provide a detailed, user friendly representation
463
- def inspect
464
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
465
- "#<Twilio.Chat.V1.ServiceContext #{context}>"
466
- end
467
- end
102
+ end
103
+
104
+ ##
105
+ # Retrieve a single page of ServiceInstance records from the API.
106
+ # Request is executed immediately.
107
+ # @param [String] page_token PageToken provided by the API
108
+ # @param [Integer] page_number Page Number, this value is simply for client state
109
+ # @param [Integer] page_size Number of records to return, defaults to 50
110
+ # @return [Page] Page of ServiceInstance
111
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
112
+ params = Twilio::Values.of({
113
+ 'PageToken' => page_token,
114
+ 'Page' => page_number,
115
+ 'PageSize' => page_size,
116
+ })
117
+
118
+ response = @version.page('GET', @uri, params: params)
119
+
120
+ ServicePage.new(@version, response, @solution)
121
+ end
122
+
123
+ ##
124
+ # Retrieve a single page of ServiceInstance records from the API.
125
+ # Request is executed immediately.
126
+ # @param [String] target_url API-generated URL for the requested results page
127
+ # @return [Page] Page of ServiceInstance
128
+ def get_page(target_url)
129
+ response = @version.domain.request(
130
+ 'GET',
131
+ target_url
132
+ )
133
+ ServicePage.new(@version, response, @solution)
134
+ end
135
+
136
+
137
+
138
+ # Provide a user friendly representation
139
+ def to_s
140
+ '#<Twilio.Chat.V1.ServiceList>'
141
+ end
142
+ end
143
+
144
+
145
+ class ServiceContext < InstanceContext
146
+ ##
147
+ # Initialize the ServiceContext
148
+ # @param [Version] version Version that contains the resource
149
+ # @param [String] sid The Twilio-provided string that uniquely identifies the Service resource to update.
150
+ # @return [ServiceContext] ServiceContext
151
+ def initialize(version, sid)
152
+ super(version)
153
+
154
+ # Path Solution
155
+ @solution = { sid: sid, }
156
+ @uri = "/Services/#{@solution[:sid]}"
157
+
158
+ # Dependents
159
+ @channels = nil
160
+ @roles = nil
161
+ @users = nil
162
+ end
163
+ ##
164
+ # Delete the ServiceInstance
165
+ # @return [Boolean] True if delete succeeds, false otherwise
166
+ def delete
167
+
168
+ @version.delete('DELETE', @uri)
169
+ end
170
+
171
+ ##
172
+ # Fetch the ServiceInstance
173
+ # @return [ServiceInstance] Fetched ServiceInstance
174
+ def fetch
175
+
176
+ payload = @version.fetch('GET', @uri)
177
+ ServiceInstance.new(
178
+ @version,
179
+ payload,
180
+ sid: @solution[:sid],
181
+ )
182
+ end
183
+
184
+ ##
185
+ # Update the ServiceInstance
186
+ # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
187
+ # @param [String] default_service_role_sid The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
188
+ # @param [String] default_channel_role_sid The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
189
+ # @param [String] default_channel_creator_role_sid The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
190
+ # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.
191
+ # @param [Boolean] reachability_enabled Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.
192
+ # @param [String] typing_indicator_timeout How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.
193
+ # @param [String] consumption_report_interval DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
194
+ # @param [Boolean] notifications_new_message_enabled Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.
195
+ # @param [String] notifications_new_message_template The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.
196
+ # @param [Boolean] notifications_added_to_channel_enabled Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.
197
+ # @param [String] notifications_added_to_channel_template The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.
198
+ # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.
199
+ # @param [String] notifications_removed_from_channel_template The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.
200
+ # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.
201
+ # @param [String] notifications_invited_to_channel_template The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.
202
+ # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
203
+ # @param [String] post_webhook_url The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
204
+ # @param [String] webhook_method The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
205
+ # @param [Array[String]] webhook_filters The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
206
+ # @param [String] webhooks_on_message_send_url The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.
207
+ # @param [String] webhooks_on_message_send_method The HTTP method to use when calling the `webhooks.on_message_send.url`.
208
+ # @param [String] webhooks_on_message_update_url The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.
209
+ # @param [String] webhooks_on_message_update_method The HTTP method to use when calling the `webhooks.on_message_update.url`.
210
+ # @param [String] webhooks_on_message_remove_url The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.
211
+ # @param [String] webhooks_on_message_remove_method The HTTP method to use when calling the `webhooks.on_message_remove.url`.
212
+ # @param [String] webhooks_on_channel_add_url The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.
213
+ # @param [String] webhooks_on_channel_add_method The HTTP method to use when calling the `webhooks.on_channel_add.url`.
214
+ # @param [String] webhooks_on_channel_destroy_url The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.
215
+ # @param [String] webhooks_on_channel_destroy_method The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.
216
+ # @param [String] webhooks_on_channel_update_url The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.
217
+ # @param [String] webhooks_on_channel_update_method The HTTP method to use when calling the `webhooks.on_channel_update.url`.
218
+ # @param [String] webhooks_on_member_add_url The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.
219
+ # @param [String] webhooks_on_member_add_method The HTTP method to use when calling the `webhooks.on_member_add.url`.
220
+ # @param [String] webhooks_on_member_remove_url The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.
221
+ # @param [String] webhooks_on_member_remove_method The HTTP method to use when calling the `webhooks.on_member_remove.url`.
222
+ # @param [String] webhooks_on_message_sent_url The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.
223
+ # @param [String] webhooks_on_message_sent_method The URL of the webhook to call in response to the `on_message_sent` event`.
224
+ # @param [String] webhooks_on_message_updated_url The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.
225
+ # @param [String] webhooks_on_message_updated_method The HTTP method to use when calling the `webhooks.on_message_updated.url`.
226
+ # @param [String] webhooks_on_message_removed_url The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.
227
+ # @param [String] webhooks_on_message_removed_method The HTTP method to use when calling the `webhooks.on_message_removed.url`.
228
+ # @param [String] webhooks_on_channel_added_url The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.
229
+ # @param [String] webhooks_on_channel_added_method The URL of the webhook to call in response to the `on_channel_added` event`.
230
+ # @param [String] webhooks_on_channel_destroyed_url The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.
231
+ # @param [String] webhooks_on_channel_destroyed_method The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.
232
+ # @param [String] webhooks_on_channel_updated_url The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
233
+ # @param [String] webhooks_on_channel_updated_method The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
234
+ # @param [String] webhooks_on_member_added_url The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
235
+ # @param [String] webhooks_on_member_added_method The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
236
+ # @param [String] webhooks_on_member_removed_url The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.
237
+ # @param [String] webhooks_on_member_removed_method The HTTP method to use when calling the `webhooks.on_member_removed.url`.
238
+ # @param [String] limits_channel_members The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.
239
+ # @param [String] limits_user_channels The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.
240
+ # @return [ServiceInstance] Updated ServiceInstance
241
+ def update(
242
+ friendly_name: :unset,
243
+ default_service_role_sid: :unset,
244
+ default_channel_role_sid: :unset,
245
+ default_channel_creator_role_sid: :unset,
246
+ read_status_enabled: :unset,
247
+ reachability_enabled: :unset,
248
+ typing_indicator_timeout: :unset,
249
+ consumption_report_interval: :unset,
250
+ notifications_new_message_enabled: :unset,
251
+ notifications_new_message_template: :unset,
252
+ notifications_added_to_channel_enabled: :unset,
253
+ notifications_added_to_channel_template: :unset,
254
+ notifications_removed_from_channel_enabled: :unset,
255
+ notifications_removed_from_channel_template: :unset,
256
+ notifications_invited_to_channel_enabled: :unset,
257
+ notifications_invited_to_channel_template: :unset,
258
+ pre_webhook_url: :unset,
259
+ post_webhook_url: :unset,
260
+ webhook_method: :unset,
261
+ webhook_filters: :unset,
262
+ webhooks_on_message_send_url: :unset,
263
+ webhooks_on_message_send_method: :unset,
264
+ webhooks_on_message_update_url: :unset,
265
+ webhooks_on_message_update_method: :unset,
266
+ webhooks_on_message_remove_url: :unset,
267
+ webhooks_on_message_remove_method: :unset,
268
+ webhooks_on_channel_add_url: :unset,
269
+ webhooks_on_channel_add_method: :unset,
270
+ webhooks_on_channel_destroy_url: :unset,
271
+ webhooks_on_channel_destroy_method: :unset,
272
+ webhooks_on_channel_update_url: :unset,
273
+ webhooks_on_channel_update_method: :unset,
274
+ webhooks_on_member_add_url: :unset,
275
+ webhooks_on_member_add_method: :unset,
276
+ webhooks_on_member_remove_url: :unset,
277
+ webhooks_on_member_remove_method: :unset,
278
+ webhooks_on_message_sent_url: :unset,
279
+ webhooks_on_message_sent_method: :unset,
280
+ webhooks_on_message_updated_url: :unset,
281
+ webhooks_on_message_updated_method: :unset,
282
+ webhooks_on_message_removed_url: :unset,
283
+ webhooks_on_message_removed_method: :unset,
284
+ webhooks_on_channel_added_url: :unset,
285
+ webhooks_on_channel_added_method: :unset,
286
+ webhooks_on_channel_destroyed_url: :unset,
287
+ webhooks_on_channel_destroyed_method: :unset,
288
+ webhooks_on_channel_updated_url: :unset,
289
+ webhooks_on_channel_updated_method: :unset,
290
+ webhooks_on_member_added_url: :unset,
291
+ webhooks_on_member_added_method: :unset,
292
+ webhooks_on_member_removed_url: :unset,
293
+ webhooks_on_member_removed_method: :unset,
294
+ limits_channel_members: :unset,
295
+ limits_user_channels: :unset
296
+ )
297
+
298
+ data = Twilio::Values.of({
299
+ 'FriendlyName' => friendly_name,
300
+ 'DefaultServiceRoleSid' => default_service_role_sid,
301
+ 'DefaultChannelRoleSid' => default_channel_role_sid,
302
+ 'DefaultChannelCreatorRoleSid' => default_channel_creator_role_sid,
303
+ 'ReadStatusEnabled' => read_status_enabled,
304
+ 'ReachabilityEnabled' => reachability_enabled,
305
+ 'TypingIndicatorTimeout' => typing_indicator_timeout,
306
+ 'ConsumptionReportInterval' => consumption_report_interval,
307
+ 'Notifications.NewMessage.Enabled' => notifications_new_message_enabled,
308
+ 'Notifications.NewMessage.Template' => notifications_new_message_template,
309
+ 'Notifications.AddedToChannel.Enabled' => notifications_added_to_channel_enabled,
310
+ 'Notifications.AddedToChannel.Template' => notifications_added_to_channel_template,
311
+ 'Notifications.RemovedFromChannel.Enabled' => notifications_removed_from_channel_enabled,
312
+ 'Notifications.RemovedFromChannel.Template' => notifications_removed_from_channel_template,
313
+ 'Notifications.InvitedToChannel.Enabled' => notifications_invited_to_channel_enabled,
314
+ 'Notifications.InvitedToChannel.Template' => notifications_invited_to_channel_template,
315
+ 'PreWebhookUrl' => pre_webhook_url,
316
+ 'PostWebhookUrl' => post_webhook_url,
317
+ 'WebhookMethod' => webhook_method,
318
+ 'WebhookFilters' => Twilio.serialize_list(webhook_filters) { |e| e },
319
+ 'Webhooks.OnMessageSend.Url' => webhooks_on_message_send_url,
320
+ 'Webhooks.OnMessageSend.Method' => webhooks_on_message_send_method,
321
+ 'Webhooks.OnMessageUpdate.Url' => webhooks_on_message_update_url,
322
+ 'Webhooks.OnMessageUpdate.Method' => webhooks_on_message_update_method,
323
+ 'Webhooks.OnMessageRemove.Url' => webhooks_on_message_remove_url,
324
+ 'Webhooks.OnMessageRemove.Method' => webhooks_on_message_remove_method,
325
+ 'Webhooks.OnChannelAdd.Url' => webhooks_on_channel_add_url,
326
+ 'Webhooks.OnChannelAdd.Method' => webhooks_on_channel_add_method,
327
+ 'Webhooks.OnChannelDestroy.Url' => webhooks_on_channel_destroy_url,
328
+ 'Webhooks.OnChannelDestroy.Method' => webhooks_on_channel_destroy_method,
329
+ 'Webhooks.OnChannelUpdate.Url' => webhooks_on_channel_update_url,
330
+ 'Webhooks.OnChannelUpdate.Method' => webhooks_on_channel_update_method,
331
+ 'Webhooks.OnMemberAdd.Url' => webhooks_on_member_add_url,
332
+ 'Webhooks.OnMemberAdd.Method' => webhooks_on_member_add_method,
333
+ 'Webhooks.OnMemberRemove.Url' => webhooks_on_member_remove_url,
334
+ 'Webhooks.OnMemberRemove.Method' => webhooks_on_member_remove_method,
335
+ 'Webhooks.OnMessageSent.Url' => webhooks_on_message_sent_url,
336
+ 'Webhooks.OnMessageSent.Method' => webhooks_on_message_sent_method,
337
+ 'Webhooks.OnMessageUpdated.Url' => webhooks_on_message_updated_url,
338
+ 'Webhooks.OnMessageUpdated.Method' => webhooks_on_message_updated_method,
339
+ 'Webhooks.OnMessageRemoved.Url' => webhooks_on_message_removed_url,
340
+ 'Webhooks.OnMessageRemoved.Method' => webhooks_on_message_removed_method,
341
+ 'Webhooks.OnChannelAdded.Url' => webhooks_on_channel_added_url,
342
+ 'Webhooks.OnChannelAdded.Method' => webhooks_on_channel_added_method,
343
+ 'Webhooks.OnChannelDestroyed.Url' => webhooks_on_channel_destroyed_url,
344
+ 'Webhooks.OnChannelDestroyed.Method' => webhooks_on_channel_destroyed_method,
345
+ 'Webhooks.OnChannelUpdated.Url' => webhooks_on_channel_updated_url,
346
+ 'Webhooks.OnChannelUpdated.Method' => webhooks_on_channel_updated_method,
347
+ 'Webhooks.OnMemberAdded.Url' => webhooks_on_member_added_url,
348
+ 'Webhooks.OnMemberAdded.Method' => webhooks_on_member_added_method,
349
+ 'Webhooks.OnMemberRemoved.Url' => webhooks_on_member_removed_url,
350
+ 'Webhooks.OnMemberRemoved.Method' => webhooks_on_member_removed_method,
351
+ 'Limits.ChannelMembers' => limits_channel_members,
352
+ 'Limits.UserChannels' => limits_user_channels,
353
+ })
354
+
355
+ payload = @version.update('POST', @uri, data: data)
356
+ ServiceInstance.new(
357
+ @version,
358
+ payload,
359
+ sid: @solution[:sid],
360
+ )
361
+ end
362
+
363
+ ##
364
+ # Access the channels
365
+ # @return [ChannelList]
366
+ # @return [ChannelContext] if sid was passed.
367
+ def channels(sid=:unset)
368
+
369
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
370
+
371
+ if sid != :unset
372
+ return ChannelContext.new(@version, @solution[:sid],sid )
373
+ end
374
+
375
+ unless @channels
376
+ @channels = ChannelList.new(
377
+ @version, service_sid: @solution[:sid], )
378
+ end
379
+
380
+ @channels
381
+ end
382
+ ##
383
+ # Access the roles
384
+ # @return [RoleList]
385
+ # @return [RoleContext] if sid was passed.
386
+ def roles(sid=:unset)
387
+
388
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
389
+
390
+ if sid != :unset
391
+ return RoleContext.new(@version, @solution[:sid],sid )
392
+ end
393
+
394
+ unless @roles
395
+ @roles = RoleList.new(
396
+ @version, service_sid: @solution[:sid], )
397
+ end
398
+
399
+ @roles
400
+ end
401
+ ##
402
+ # Access the users
403
+ # @return [UserList]
404
+ # @return [UserContext] if sid was passed.
405
+ def users(sid=:unset)
406
+
407
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
408
+
409
+ if sid != :unset
410
+ return UserContext.new(@version, @solution[:sid],sid )
411
+ end
412
+
413
+ unless @users
414
+ @users = UserList.new(
415
+ @version, service_sid: @solution[:sid], )
416
+ end
417
+
418
+ @users
419
+ end
420
+
421
+ ##
422
+ # Provide a user friendly representation
423
+ def to_s
424
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
425
+ "#<Twilio.Chat.V1.ServiceContext #{context}>"
426
+ end
427
+
428
+ ##
429
+ # Provide a detailed, user friendly representation
430
+ def inspect
431
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
432
+ "#<Twilio.Chat.V1.ServiceContext #{context}>"
433
+ end
434
+ end
435
+
436
+ class ServicePage < Page
437
+ ##
438
+ # Initialize the ServicePage
439
+ # @param [Version] version Version that contains the resource
440
+ # @param [Response] response Response from the API
441
+ # @param [Hash] solution Path solution for the resource
442
+ # @return [ServicePage] ServicePage
443
+ def initialize(version, response, solution)
444
+ super(version, response)
445
+
446
+ # Path Solution
447
+ @solution = solution
448
+ end
449
+
450
+ ##
451
+ # Build an instance of ServiceInstance
452
+ # @param [Hash] payload Payload response from the API
453
+ # @return [ServiceInstance] ServiceInstance
454
+ def get_instance(payload)
455
+ ServiceInstance.new(@version, payload)
456
+ end
457
+
458
+ ##
459
+ # Provide a user friendly representation
460
+ def to_s
461
+ '<Twilio.Chat.V1.ServicePage>'
462
+ end
463
+ end
464
+ class ServiceInstance < InstanceResource
465
+ ##
466
+ # Initialize the ServiceInstance
467
+ # @param [Version] version Version that contains the resource
468
+ # @param [Hash] payload payload that contains response from Twilio
469
+ # @param [String] account_sid The SID of the
470
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Service
471
+ # resource.
472
+ # @param [String] sid The SID of the Call resource to fetch.
473
+ # @return [ServiceInstance] ServiceInstance
474
+ def initialize(version, payload , sid: nil)
475
+ super(version)
476
+
477
+ # Marshaled Properties
478
+ @properties = {
479
+ 'sid' => payload['sid'],
480
+ 'account_sid' => payload['account_sid'],
481
+ 'friendly_name' => payload['friendly_name'],
482
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
483
+ 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
484
+ 'default_service_role_sid' => payload['default_service_role_sid'],
485
+ 'default_channel_role_sid' => payload['default_channel_role_sid'],
486
+ 'default_channel_creator_role_sid' => payload['default_channel_creator_role_sid'],
487
+ 'read_status_enabled' => payload['read_status_enabled'],
488
+ 'reachability_enabled' => payload['reachability_enabled'],
489
+ 'typing_indicator_timeout' => payload['typing_indicator_timeout'] == nil ? payload['typing_indicator_timeout'] : payload['typing_indicator_timeout'].to_i,
490
+ 'consumption_report_interval' => payload['consumption_report_interval'] == nil ? payload['consumption_report_interval'] : payload['consumption_report_interval'].to_i,
491
+ 'limits' => payload['limits'],
492
+ 'webhooks' => payload['webhooks'],
493
+ 'pre_webhook_url' => payload['pre_webhook_url'],
494
+ 'post_webhook_url' => payload['post_webhook_url'],
495
+ 'webhook_method' => payload['webhook_method'],
496
+ 'webhook_filters' => payload['webhook_filters'],
497
+ 'notifications' => payload['notifications'],
498
+ 'url' => payload['url'],
499
+ 'links' => payload['links'],
500
+ }
501
+
502
+ # Context
503
+ @instance_context = nil
504
+ @params = { 'sid' => sid || @properties['sid'] , }
505
+ end
506
+
507
+ ##
508
+ # Generate an instance context for the instance, the context is capable of
509
+ # performing various actions. All instance actions are proxied to the context
510
+ # @return [ServiceContext] CallContext for this CallInstance
511
+ def context
512
+ unless @instance_context
513
+ @instance_context = ServiceContext.new(@version , @params['sid'])
514
+ end
515
+ @instance_context
516
+ end
517
+
518
+ ##
519
+ # @return [String] The unique string that we created to identify the Service resource.
520
+ def sid
521
+ @properties['sid']
522
+ end
523
+
524
+ ##
525
+ # @return [String] The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Service resource.
526
+ def account_sid
527
+ @properties['account_sid']
528
+ end
529
+
530
+ ##
531
+ # @return [String] The string that you assigned to describe the resource.
532
+ def friendly_name
533
+ @properties['friendly_name']
534
+ end
535
+
536
+ ##
537
+ # @return [Time] The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
538
+ def date_created
539
+ @properties['date_created']
540
+ end
541
+
542
+ ##
543
+ # @return [Time] The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
544
+ def date_updated
545
+ @properties['date_updated']
546
+ end
547
+
548
+ ##
549
+ # @return [String] The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
550
+ def default_service_role_sid
551
+ @properties['default_service_role_sid']
552
+ end
553
+
554
+ ##
555
+ # @return [String] The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
556
+ def default_channel_role_sid
557
+ @properties['default_channel_role_sid']
558
+ end
559
+
560
+ ##
561
+ # @return [String] The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
562
+ def default_channel_creator_role_sid
563
+ @properties['default_channel_creator_role_sid']
564
+ end
565
+
566
+ ##
567
+ # @return [Boolean] Whether the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature is enabled. The default is `true`.
568
+ def read_status_enabled
569
+ @properties['read_status_enabled']
570
+ end
571
+
572
+ ##
573
+ # @return [Boolean] Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Service instance. The default is `false`.
574
+ def reachability_enabled
575
+ @properties['reachability_enabled']
576
+ end
577
+
578
+ ##
579
+ # @return [String] How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.
580
+ def typing_indicator_timeout
581
+ @properties['typing_indicator_timeout']
582
+ end
583
+
584
+ ##
585
+ # @return [String] DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
586
+ def consumption_report_interval
587
+ @properties['consumption_report_interval']
588
+ end
589
+
590
+ ##
591
+ # @return [Hash] An object that describes the limits of the service instance. The `limits` object contains `channel_members` to describe the members/channel limit and `user_channels` to describe the channels/user limit. `channel_members` can be 1,000 or less, with a default of 250. `user_channels` can be 1,000 or less, with a default value of 100.
592
+ def limits
593
+ @properties['limits']
594
+ end
595
+
596
+ ##
597
+ # @return [Hash] An object that contains information about the webhooks configured for this service.
598
+ def webhooks
599
+ @properties['webhooks']
600
+ end
601
+
602
+ ##
603
+ # @return [String] The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
604
+ def pre_webhook_url
605
+ @properties['pre_webhook_url']
606
+ end
607
+
608
+ ##
609
+ # @return [String] The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
610
+ def post_webhook_url
611
+ @properties['post_webhook_url']
612
+ end
613
+
614
+ ##
615
+ # @return [String] The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
616
+ def webhook_method
617
+ @properties['webhook_method']
618
+ end
619
+
620
+ ##
621
+ # @return [Array<String>] The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
622
+ def webhook_filters
623
+ @properties['webhook_filters']
624
+ end
625
+
626
+ ##
627
+ # @return [Hash] The notification configuration for the Service instance. See [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more information.
628
+ def notifications
629
+ @properties['notifications']
630
+ end
631
+
632
+ ##
633
+ # @return [String] The absolute URL of the Service resource.
634
+ def url
635
+ @properties['url']
636
+ end
637
+
638
+ ##
639
+ # @return [Hash] The absolute URLs of the Service's [Channels](https://www.twilio.com/docs/chat/api/channels), [Roles](https://www.twilio.com/docs/chat/api/roles), and [Users](https://www.twilio.com/docs/chat/api/users).
640
+ def links
641
+ @properties['links']
642
+ end
643
+
644
+ ##
645
+ # Delete the ServiceInstance
646
+ # @return [Boolean] True if delete succeeds, false otherwise
647
+ def delete
648
+
649
+ context.delete
650
+ end
651
+
652
+ ##
653
+ # Fetch the ServiceInstance
654
+ # @return [ServiceInstance] Fetched ServiceInstance
655
+ def fetch
656
+
657
+ context.fetch
658
+ end
659
+
660
+ ##
661
+ # Update the ServiceInstance
662
+ # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
663
+ # @param [String] default_service_role_sid The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
664
+ # @param [String] default_channel_role_sid The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
665
+ # @param [String] default_channel_creator_role_sid The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
666
+ # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.
667
+ # @param [Boolean] reachability_enabled Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.
668
+ # @param [String] typing_indicator_timeout How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.
669
+ # @param [String] consumption_report_interval DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
670
+ # @param [Boolean] notifications_new_message_enabled Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.
671
+ # @param [String] notifications_new_message_template The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.
672
+ # @param [Boolean] notifications_added_to_channel_enabled Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.
673
+ # @param [String] notifications_added_to_channel_template The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.
674
+ # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.
675
+ # @param [String] notifications_removed_from_channel_template The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.
676
+ # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.
677
+ # @param [String] notifications_invited_to_channel_template The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.
678
+ # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
679
+ # @param [String] post_webhook_url The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
680
+ # @param [String] webhook_method The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
681
+ # @param [Array[String]] webhook_filters The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
682
+ # @param [String] webhooks_on_message_send_url The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.
683
+ # @param [String] webhooks_on_message_send_method The HTTP method to use when calling the `webhooks.on_message_send.url`.
684
+ # @param [String] webhooks_on_message_update_url The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.
685
+ # @param [String] webhooks_on_message_update_method The HTTP method to use when calling the `webhooks.on_message_update.url`.
686
+ # @param [String] webhooks_on_message_remove_url The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.
687
+ # @param [String] webhooks_on_message_remove_method The HTTP method to use when calling the `webhooks.on_message_remove.url`.
688
+ # @param [String] webhooks_on_channel_add_url The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.
689
+ # @param [String] webhooks_on_channel_add_method The HTTP method to use when calling the `webhooks.on_channel_add.url`.
690
+ # @param [String] webhooks_on_channel_destroy_url The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.
691
+ # @param [String] webhooks_on_channel_destroy_method The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.
692
+ # @param [String] webhooks_on_channel_update_url The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.
693
+ # @param [String] webhooks_on_channel_update_method The HTTP method to use when calling the `webhooks.on_channel_update.url`.
694
+ # @param [String] webhooks_on_member_add_url The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.
695
+ # @param [String] webhooks_on_member_add_method The HTTP method to use when calling the `webhooks.on_member_add.url`.
696
+ # @param [String] webhooks_on_member_remove_url The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.
697
+ # @param [String] webhooks_on_member_remove_method The HTTP method to use when calling the `webhooks.on_member_remove.url`.
698
+ # @param [String] webhooks_on_message_sent_url The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.
699
+ # @param [String] webhooks_on_message_sent_method The URL of the webhook to call in response to the `on_message_sent` event`.
700
+ # @param [String] webhooks_on_message_updated_url The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.
701
+ # @param [String] webhooks_on_message_updated_method The HTTP method to use when calling the `webhooks.on_message_updated.url`.
702
+ # @param [String] webhooks_on_message_removed_url The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.
703
+ # @param [String] webhooks_on_message_removed_method The HTTP method to use when calling the `webhooks.on_message_removed.url`.
704
+ # @param [String] webhooks_on_channel_added_url The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.
705
+ # @param [String] webhooks_on_channel_added_method The URL of the webhook to call in response to the `on_channel_added` event`.
706
+ # @param [String] webhooks_on_channel_destroyed_url The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.
707
+ # @param [String] webhooks_on_channel_destroyed_method The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.
708
+ # @param [String] webhooks_on_channel_updated_url The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
709
+ # @param [String] webhooks_on_channel_updated_method The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
710
+ # @param [String] webhooks_on_member_added_url The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
711
+ # @param [String] webhooks_on_member_added_method The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
712
+ # @param [String] webhooks_on_member_removed_url The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.
713
+ # @param [String] webhooks_on_member_removed_method The HTTP method to use when calling the `webhooks.on_member_removed.url`.
714
+ # @param [String] limits_channel_members The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.
715
+ # @param [String] limits_user_channels The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.
716
+ # @return [ServiceInstance] Updated ServiceInstance
717
+ def update(
718
+ friendly_name: :unset,
719
+ default_service_role_sid: :unset,
720
+ default_channel_role_sid: :unset,
721
+ default_channel_creator_role_sid: :unset,
722
+ read_status_enabled: :unset,
723
+ reachability_enabled: :unset,
724
+ typing_indicator_timeout: :unset,
725
+ consumption_report_interval: :unset,
726
+ notifications_new_message_enabled: :unset,
727
+ notifications_new_message_template: :unset,
728
+ notifications_added_to_channel_enabled: :unset,
729
+ notifications_added_to_channel_template: :unset,
730
+ notifications_removed_from_channel_enabled: :unset,
731
+ notifications_removed_from_channel_template: :unset,
732
+ notifications_invited_to_channel_enabled: :unset,
733
+ notifications_invited_to_channel_template: :unset,
734
+ pre_webhook_url: :unset,
735
+ post_webhook_url: :unset,
736
+ webhook_method: :unset,
737
+ webhook_filters: :unset,
738
+ webhooks_on_message_send_url: :unset,
739
+ webhooks_on_message_send_method: :unset,
740
+ webhooks_on_message_update_url: :unset,
741
+ webhooks_on_message_update_method: :unset,
742
+ webhooks_on_message_remove_url: :unset,
743
+ webhooks_on_message_remove_method: :unset,
744
+ webhooks_on_channel_add_url: :unset,
745
+ webhooks_on_channel_add_method: :unset,
746
+ webhooks_on_channel_destroy_url: :unset,
747
+ webhooks_on_channel_destroy_method: :unset,
748
+ webhooks_on_channel_update_url: :unset,
749
+ webhooks_on_channel_update_method: :unset,
750
+ webhooks_on_member_add_url: :unset,
751
+ webhooks_on_member_add_method: :unset,
752
+ webhooks_on_member_remove_url: :unset,
753
+ webhooks_on_member_remove_method: :unset,
754
+ webhooks_on_message_sent_url: :unset,
755
+ webhooks_on_message_sent_method: :unset,
756
+ webhooks_on_message_updated_url: :unset,
757
+ webhooks_on_message_updated_method: :unset,
758
+ webhooks_on_message_removed_url: :unset,
759
+ webhooks_on_message_removed_method: :unset,
760
+ webhooks_on_channel_added_url: :unset,
761
+ webhooks_on_channel_added_method: :unset,
762
+ webhooks_on_channel_destroyed_url: :unset,
763
+ webhooks_on_channel_destroyed_method: :unset,
764
+ webhooks_on_channel_updated_url: :unset,
765
+ webhooks_on_channel_updated_method: :unset,
766
+ webhooks_on_member_added_url: :unset,
767
+ webhooks_on_member_added_method: :unset,
768
+ webhooks_on_member_removed_url: :unset,
769
+ webhooks_on_member_removed_method: :unset,
770
+ limits_channel_members: :unset,
771
+ limits_user_channels: :unset
772
+ )
773
+
774
+ context.update(
775
+ friendly_name: friendly_name,
776
+ default_service_role_sid: default_service_role_sid,
777
+ default_channel_role_sid: default_channel_role_sid,
778
+ default_channel_creator_role_sid: default_channel_creator_role_sid,
779
+ read_status_enabled: read_status_enabled,
780
+ reachability_enabled: reachability_enabled,
781
+ typing_indicator_timeout: typing_indicator_timeout,
782
+ consumption_report_interval: consumption_report_interval,
783
+ notifications_new_message_enabled: notifications_new_message_enabled,
784
+ notifications_new_message_template: notifications_new_message_template,
785
+ notifications_added_to_channel_enabled: notifications_added_to_channel_enabled,
786
+ notifications_added_to_channel_template: notifications_added_to_channel_template,
787
+ notifications_removed_from_channel_enabled: notifications_removed_from_channel_enabled,
788
+ notifications_removed_from_channel_template: notifications_removed_from_channel_template,
789
+ notifications_invited_to_channel_enabled: notifications_invited_to_channel_enabled,
790
+ notifications_invited_to_channel_template: notifications_invited_to_channel_template,
791
+ pre_webhook_url: pre_webhook_url,
792
+ post_webhook_url: post_webhook_url,
793
+ webhook_method: webhook_method,
794
+ webhook_filters: webhook_filters,
795
+ webhooks_on_message_send_url: webhooks_on_message_send_url,
796
+ webhooks_on_message_send_method: webhooks_on_message_send_method,
797
+ webhooks_on_message_update_url: webhooks_on_message_update_url,
798
+ webhooks_on_message_update_method: webhooks_on_message_update_method,
799
+ webhooks_on_message_remove_url: webhooks_on_message_remove_url,
800
+ webhooks_on_message_remove_method: webhooks_on_message_remove_method,
801
+ webhooks_on_channel_add_url: webhooks_on_channel_add_url,
802
+ webhooks_on_channel_add_method: webhooks_on_channel_add_method,
803
+ webhooks_on_channel_destroy_url: webhooks_on_channel_destroy_url,
804
+ webhooks_on_channel_destroy_method: webhooks_on_channel_destroy_method,
805
+ webhooks_on_channel_update_url: webhooks_on_channel_update_url,
806
+ webhooks_on_channel_update_method: webhooks_on_channel_update_method,
807
+ webhooks_on_member_add_url: webhooks_on_member_add_url,
808
+ webhooks_on_member_add_method: webhooks_on_member_add_method,
809
+ webhooks_on_member_remove_url: webhooks_on_member_remove_url,
810
+ webhooks_on_member_remove_method: webhooks_on_member_remove_method,
811
+ webhooks_on_message_sent_url: webhooks_on_message_sent_url,
812
+ webhooks_on_message_sent_method: webhooks_on_message_sent_method,
813
+ webhooks_on_message_updated_url: webhooks_on_message_updated_url,
814
+ webhooks_on_message_updated_method: webhooks_on_message_updated_method,
815
+ webhooks_on_message_removed_url: webhooks_on_message_removed_url,
816
+ webhooks_on_message_removed_method: webhooks_on_message_removed_method,
817
+ webhooks_on_channel_added_url: webhooks_on_channel_added_url,
818
+ webhooks_on_channel_added_method: webhooks_on_channel_added_method,
819
+ webhooks_on_channel_destroyed_url: webhooks_on_channel_destroyed_url,
820
+ webhooks_on_channel_destroyed_method: webhooks_on_channel_destroyed_method,
821
+ webhooks_on_channel_updated_url: webhooks_on_channel_updated_url,
822
+ webhooks_on_channel_updated_method: webhooks_on_channel_updated_method,
823
+ webhooks_on_member_added_url: webhooks_on_member_added_url,
824
+ webhooks_on_member_added_method: webhooks_on_member_added_method,
825
+ webhooks_on_member_removed_url: webhooks_on_member_removed_url,
826
+ webhooks_on_member_removed_method: webhooks_on_member_removed_method,
827
+ limits_channel_members: limits_channel_members,
828
+ limits_user_channels: limits_user_channels,
829
+ )
830
+ end
831
+
832
+ ##
833
+ # Access the channels
834
+ # @return [channels] channels
835
+ def channels
836
+ context.channels
837
+ end
838
+
839
+ ##
840
+ # Access the roles
841
+ # @return [roles] roles
842
+ def roles
843
+ context.roles
844
+ end
845
+
846
+ ##
847
+ # Access the users
848
+ # @return [users] users
849
+ def users
850
+ context.users
851
+ end
852
+
853
+ ##
854
+ # Provide a user friendly representation
855
+ def to_s
856
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
857
+ "<Twilio.Chat.V1.ServiceInstance #{values}>"
858
+ end
859
+
860
+ ##
861
+ # Provide a detailed, user friendly representation
862
+ def inspect
863
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
864
+ "<Twilio.Chat.V1.ServiceInstance #{values}>"
865
+ end
866
+ end
468
867
 
469
- class ServiceInstance < InstanceResource
470
- ##
471
- # Initialize the ServiceInstance
472
- # @param [Version] version Version that contains the resource
473
- # @param [Hash] payload payload that contains response from Twilio
474
- # @param [String] sid The Twilio-provided string that uniquely identifies the
475
- # Service resource to fetch.
476
- # @return [ServiceInstance] ServiceInstance
477
- def initialize(version, payload, sid: nil)
478
- super(version)
479
-
480
- # Marshaled Properties
481
- @properties = {
482
- 'sid' => payload['sid'],
483
- 'account_sid' => payload['account_sid'],
484
- 'friendly_name' => payload['friendly_name'],
485
- 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
486
- 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
487
- 'default_service_role_sid' => payload['default_service_role_sid'],
488
- 'default_channel_role_sid' => payload['default_channel_role_sid'],
489
- 'default_channel_creator_role_sid' => payload['default_channel_creator_role_sid'],
490
- 'read_status_enabled' => payload['read_status_enabled'],
491
- 'reachability_enabled' => payload['reachability_enabled'],
492
- 'typing_indicator_timeout' => payload['typing_indicator_timeout'].to_i,
493
- 'consumption_report_interval' => payload['consumption_report_interval'].to_i,
494
- 'limits' => payload['limits'],
495
- 'webhooks' => payload['webhooks'],
496
- 'pre_webhook_url' => payload['pre_webhook_url'],
497
- 'post_webhook_url' => payload['post_webhook_url'],
498
- 'webhook_method' => payload['webhook_method'],
499
- 'webhook_filters' => payload['webhook_filters'],
500
- 'notifications' => payload['notifications'],
501
- 'url' => payload['url'],
502
- 'links' => payload['links'],
503
- }
504
-
505
- # Context
506
- @instance_context = nil
507
- @params = {'sid' => sid || @properties['sid'], }
508
- end
509
-
510
- ##
511
- # Generate an instance context for the instance, the context is capable of
512
- # performing various actions. All instance actions are proxied to the context
513
- # @return [ServiceContext] ServiceContext for this ServiceInstance
514
- def context
515
- unless @instance_context
516
- @instance_context = ServiceContext.new(@version, @params['sid'], )
517
868
  end
518
- @instance_context
519
- end
520
-
521
- ##
522
- # @return [String] The unique string that identifies the resource
523
- def sid
524
- @properties['sid']
525
- end
526
-
527
- ##
528
- # @return [String] The SID of the Account that created the resource
529
- def account_sid
530
- @properties['account_sid']
531
- end
532
-
533
- ##
534
- # @return [String] The string that you assigned to describe the resource
535
- def friendly_name
536
- @properties['friendly_name']
537
- end
538
-
539
- ##
540
- # @return [Time] The RFC 2822 date and time in GMT when the resource was created
541
- def date_created
542
- @properties['date_created']
543
- end
544
-
545
- ##
546
- # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
547
- def date_updated
548
- @properties['date_updated']
549
- end
550
-
551
- ##
552
- # @return [String] The service role assigned to users when they are added to the service
553
- def default_service_role_sid
554
- @properties['default_service_role_sid']
555
- end
556
-
557
- ##
558
- # @return [String] The channel role assigned to users when they are added to a channel
559
- def default_channel_role_sid
560
- @properties['default_channel_role_sid']
561
- end
562
-
563
- ##
564
- # @return [String] The channel role assigned to a channel creator when they join a new channel
565
- def default_channel_creator_role_sid
566
- @properties['default_channel_creator_role_sid']
567
- end
568
-
569
- ##
570
- # @return [Boolean] Whether the Message Consumption Horizon feature is enabled
571
- def read_status_enabled
572
- @properties['read_status_enabled']
573
- end
574
-
575
- ##
576
- # @return [Boolean] Whether the Reachability Indicator feature is enabled for this Service instance
577
- def reachability_enabled
578
- @properties['reachability_enabled']
579
- end
580
-
581
- ##
582
- # @return [String] How long in seconds to wait before assuming the user is no longer typing
583
- def typing_indicator_timeout
584
- @properties['typing_indicator_timeout']
585
- end
586
-
587
- ##
588
- # @return [String] DEPRECATED
589
- def consumption_report_interval
590
- @properties['consumption_report_interval']
591
- end
592
-
593
- ##
594
- # @return [Hash] An object that describes the limits of the service instance
595
- def limits
596
- @properties['limits']
597
- end
598
-
599
- ##
600
- # @return [Hash] An object that contains information about the webhooks configured for this service
601
- def webhooks
602
- @properties['webhooks']
603
- end
604
-
605
- ##
606
- # @return [String] The webhook URL for pre-event webhooks
607
- def pre_webhook_url
608
- @properties['pre_webhook_url']
609
- end
610
-
611
- ##
612
- # @return [String] The URL for post-event webhooks
613
- def post_webhook_url
614
- @properties['post_webhook_url']
615
- end
616
-
617
- ##
618
- # @return [String] The HTTP method to use for both PRE and POST webhooks
619
- def webhook_method
620
- @properties['webhook_method']
621
- end
622
-
623
- ##
624
- # @return [Array[String]] The list of WebHook events that are enabled for this Service instance
625
- def webhook_filters
626
- @properties['webhook_filters']
627
- end
628
-
629
- ##
630
- # @return [Hash] The notification configuration for the Service instance
631
- def notifications
632
- @properties['notifications']
633
- end
634
-
635
- ##
636
- # @return [String] The absolute URL of the Service resource
637
- def url
638
- @properties['url']
639
- end
640
-
641
- ##
642
- # @return [String] The absolute URLs of the Service's Channels, Roles, and Users
643
- def links
644
- @properties['links']
645
- end
646
-
647
- ##
648
- # Fetch the ServiceInstance
649
- # @return [ServiceInstance] Fetched ServiceInstance
650
- def fetch
651
- context.fetch
652
- end
653
-
654
- ##
655
- # Delete the ServiceInstance
656
- # @return [Boolean] true if delete succeeds, false otherwise
657
- def delete
658
- context.delete
659
- end
660
-
661
- ##
662
- # Update the ServiceInstance
663
- # @param [String] friendly_name A descriptive string that you create to describe
664
- # the resource. It can be up to 64 characters long.
665
- # @param [String] default_service_role_sid The service role assigned to users when
666
- # they are added to the service. See the {Roles
667
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
668
- # @param [String] default_channel_role_sid The channel role assigned to users when
669
- # they are added to a channel. See the {Roles
670
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
671
- # @param [String] default_channel_creator_role_sid The channel role assigned to a
672
- # channel creator when they join a new channel. See the {Roles
673
- # endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
674
- # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
675
- # Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
676
- # default is `true`.
677
- # @param [Boolean] reachability_enabled Whether to enable the {Reachability
678
- # Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
679
- # Service instance. The default is `false`.
680
- # @param [String] typing_indicator_timeout How long in seconds after a `started
681
- # typing` event until clients should assume that user is no longer typing, even if
682
- # no `ended typing` message was received. The default is 5 seconds.
683
- # @param [String] consumption_report_interval DEPRECATED. The interval in seconds
684
- # between consumption reports submission batches from client endpoints.
685
- # @param [Boolean] notifications_new_message_enabled Whether to send a
686
- # notification when a new message is added to a channel. Can be: `true` or `false`
687
- # and the default is `false`.
688
- # @param [String] notifications_new_message_template The template to use to create
689
- # the notification text displayed when a new message is added to a channel and
690
- # `notifications.new_message.enabled` is `true`.
691
- # @param [Boolean] notifications_added_to_channel_enabled Whether to send a
692
- # notification when a member is added to a channel. Can be: `true` or `false` and
693
- # the default is `false`.
694
- # @param [String] notifications_added_to_channel_template The template to use to
695
- # create the notification text displayed when a member is added to a channel and
696
- # `notifications.added_to_channel.enabled` is `true`.
697
- # @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
698
- # notification to a user when they are removed from a channel. Can be: `true` or
699
- # `false` and the default is `false`.
700
- # @param [String] notifications_removed_from_channel_template The template to use
701
- # to create the notification text displayed to a user when they are removed from a
702
- # channel and `notifications.removed_from_channel.enabled` is `true`.
703
- # @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
704
- # notification when a user is invited to a channel. Can be: `true` or `false` and
705
- # the default is `false`.
706
- # @param [String] notifications_invited_to_channel_template The template to use to
707
- # create the notification text displayed when a user is invited to a channel and
708
- # `notifications.invited_to_channel.enabled` is `true`.
709
- # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
710
- # by using the `webhook_method`. See {Webhook
711
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
712
- # @param [String] post_webhook_url The URL for post-event webhooks, which are
713
- # called by using the `webhook_method`. See {Webhook
714
- # Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
715
- # @param [String] webhook_method The HTTP method to use for calls to the
716
- # `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
717
- # the default is `POST`. See {Webhook
718
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
719
- # @param [Array[String]] webhook_filters The list of WebHook events that are
720
- # enabled for this Service instance. See {Webhook
721
- # Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
722
- # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
723
- # response to the `on_message_send` event using the
724
- # `webhooks.on_message_send.method` HTTP method.
725
- # @param [String] webhooks_on_message_send_method The HTTP method to use when
726
- # calling the `webhooks.on_message_send.url`.
727
- # @param [String] webhooks_on_message_update_url The URL of the webhook to call in
728
- # response to the `on_message_update` event using the
729
- # `webhooks.on_message_update.method` HTTP method.
730
- # @param [String] webhooks_on_message_update_method The HTTP method to use when
731
- # calling the `webhooks.on_message_update.url`.
732
- # @param [String] webhooks_on_message_remove_url The URL of the webhook to call in
733
- # response to the `on_message_remove` event using the
734
- # `webhooks.on_message_remove.method` HTTP method.
735
- # @param [String] webhooks_on_message_remove_method The HTTP method to use when
736
- # calling the `webhooks.on_message_remove.url`.
737
- # @param [String] webhooks_on_channel_add_url The URL of the webhook to call in
738
- # response to the `on_channel_add` event using the
739
- # `webhooks.on_channel_add.method` HTTP method.
740
- # @param [String] webhooks_on_channel_add_method The HTTP method to use when
741
- # calling the `webhooks.on_channel_add.url`.
742
- # @param [String] webhooks_on_channel_destroy_url The URL of the webhook to call
743
- # in response to the `on_channel_destroy` event using the
744
- # `webhooks.on_channel_destroy.method` HTTP method.
745
- # @param [String] webhooks_on_channel_destroy_method The HTTP method to use when
746
- # calling the `webhooks.on_channel_destroy.url`.
747
- # @param [String] webhooks_on_channel_update_url The URL of the webhook to call in
748
- # response to the `on_channel_update` event using the
749
- # `webhooks.on_channel_update.method` HTTP method.
750
- # @param [String] webhooks_on_channel_update_method The HTTP method to use when
751
- # calling the `webhooks.on_channel_update.url`.
752
- # @param [String] webhooks_on_member_add_url The URL of the webhook to call in
753
- # response to the `on_member_add` event using the `webhooks.on_member_add.method`
754
- # HTTP method.
755
- # @param [String] webhooks_on_member_add_method The HTTP method to use when
756
- # calling the `webhooks.on_member_add.url`.
757
- # @param [String] webhooks_on_member_remove_url The URL of the webhook to call in
758
- # response to the `on_member_remove` event using the
759
- # `webhooks.on_member_remove.method` HTTP method.
760
- # @param [String] webhooks_on_member_remove_method The HTTP method to use when
761
- # calling the `webhooks.on_member_remove.url`.
762
- # @param [String] webhooks_on_message_sent_url The URL of the webhook to call in
763
- # response to the `on_message_sent` event using the
764
- # `webhooks.on_message_sent.method` HTTP method.
765
- # @param [String] webhooks_on_message_sent_method The URL of the webhook to call
766
- # in response to the `on_message_sent` event`.
767
- # @param [String] webhooks_on_message_updated_url The URL of the webhook to call
768
- # in response to the `on_message_updated` event using the
769
- # `webhooks.on_message_updated.method` HTTP method.
770
- # @param [String] webhooks_on_message_updated_method The HTTP method to use when
771
- # calling the `webhooks.on_message_updated.url`.
772
- # @param [String] webhooks_on_message_removed_url The URL of the webhook to call
773
- # in response to the `on_message_removed` event using the
774
- # `webhooks.on_message_removed.method` HTTP method.
775
- # @param [String] webhooks_on_message_removed_method The HTTP method to use when
776
- # calling the `webhooks.on_message_removed.url`.
777
- # @param [String] webhooks_on_channel_added_url The URL of the webhook to call in
778
- # response to the `on_channel_added` event using the
779
- # `webhooks.on_channel_added.method` HTTP method.
780
- # @param [String] webhooks_on_channel_added_method The URL of the webhook to call
781
- # in response to the `on_channel_added` event`.
782
- # @param [String] webhooks_on_channel_destroyed_url The URL of the webhook to call
783
- # in response to the `on_channel_added` event using the
784
- # `webhooks.on_channel_destroyed.method` HTTP method.
785
- # @param [String] webhooks_on_channel_destroyed_method The HTTP method to use when
786
- # calling the `webhooks.on_channel_destroyed.url`.
787
- # @param [String] webhooks_on_channel_updated_url The URL of the webhook to call
788
- # in response to the `on_channel_updated` event using the
789
- # `webhooks.on_channel_updated.method` HTTP method.
790
- # @param [String] webhooks_on_channel_updated_method The HTTP method to use when
791
- # calling the `webhooks.on_channel_updated.url`.
792
- # @param [String] webhooks_on_member_added_url The URL of the webhook to call in
793
- # response to the `on_channel_updated` event using the
794
- # `webhooks.on_channel_updated.method` HTTP method.
795
- # @param [String] webhooks_on_member_added_method The HTTP method to use when
796
- # calling the `webhooks.on_channel_updated.url`.
797
- # @param [String] webhooks_on_member_removed_url The URL of the webhook to call in
798
- # response to the `on_member_removed` event using the
799
- # `webhooks.on_member_removed.method` HTTP method.
800
- # @param [String] webhooks_on_member_removed_method The HTTP method to use when
801
- # calling the `webhooks.on_member_removed.url`.
802
- # @param [String] limits_channel_members The maximum number of Members that can be
803
- # added to Channels within this Service. Can be up to 1,000.
804
- # @param [String] limits_user_channels The maximum number of Channels Users can be
805
- # a Member of within this Service. Can be up to 1,000.
806
- # @return [ServiceInstance] Updated ServiceInstance
807
- def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset)
808
- context.update(
809
- friendly_name: friendly_name,
810
- default_service_role_sid: default_service_role_sid,
811
- default_channel_role_sid: default_channel_role_sid,
812
- default_channel_creator_role_sid: default_channel_creator_role_sid,
813
- read_status_enabled: read_status_enabled,
814
- reachability_enabled: reachability_enabled,
815
- typing_indicator_timeout: typing_indicator_timeout,
816
- consumption_report_interval: consumption_report_interval,
817
- notifications_new_message_enabled: notifications_new_message_enabled,
818
- notifications_new_message_template: notifications_new_message_template,
819
- notifications_added_to_channel_enabled: notifications_added_to_channel_enabled,
820
- notifications_added_to_channel_template: notifications_added_to_channel_template,
821
- notifications_removed_from_channel_enabled: notifications_removed_from_channel_enabled,
822
- notifications_removed_from_channel_template: notifications_removed_from_channel_template,
823
- notifications_invited_to_channel_enabled: notifications_invited_to_channel_enabled,
824
- notifications_invited_to_channel_template: notifications_invited_to_channel_template,
825
- pre_webhook_url: pre_webhook_url,
826
- post_webhook_url: post_webhook_url,
827
- webhook_method: webhook_method,
828
- webhook_filters: webhook_filters,
829
- webhooks_on_message_send_url: webhooks_on_message_send_url,
830
- webhooks_on_message_send_method: webhooks_on_message_send_method,
831
- webhooks_on_message_update_url: webhooks_on_message_update_url,
832
- webhooks_on_message_update_method: webhooks_on_message_update_method,
833
- webhooks_on_message_remove_url: webhooks_on_message_remove_url,
834
- webhooks_on_message_remove_method: webhooks_on_message_remove_method,
835
- webhooks_on_channel_add_url: webhooks_on_channel_add_url,
836
- webhooks_on_channel_add_method: webhooks_on_channel_add_method,
837
- webhooks_on_channel_destroy_url: webhooks_on_channel_destroy_url,
838
- webhooks_on_channel_destroy_method: webhooks_on_channel_destroy_method,
839
- webhooks_on_channel_update_url: webhooks_on_channel_update_url,
840
- webhooks_on_channel_update_method: webhooks_on_channel_update_method,
841
- webhooks_on_member_add_url: webhooks_on_member_add_url,
842
- webhooks_on_member_add_method: webhooks_on_member_add_method,
843
- webhooks_on_member_remove_url: webhooks_on_member_remove_url,
844
- webhooks_on_member_remove_method: webhooks_on_member_remove_method,
845
- webhooks_on_message_sent_url: webhooks_on_message_sent_url,
846
- webhooks_on_message_sent_method: webhooks_on_message_sent_method,
847
- webhooks_on_message_updated_url: webhooks_on_message_updated_url,
848
- webhooks_on_message_updated_method: webhooks_on_message_updated_method,
849
- webhooks_on_message_removed_url: webhooks_on_message_removed_url,
850
- webhooks_on_message_removed_method: webhooks_on_message_removed_method,
851
- webhooks_on_channel_added_url: webhooks_on_channel_added_url,
852
- webhooks_on_channel_added_method: webhooks_on_channel_added_method,
853
- webhooks_on_channel_destroyed_url: webhooks_on_channel_destroyed_url,
854
- webhooks_on_channel_destroyed_method: webhooks_on_channel_destroyed_method,
855
- webhooks_on_channel_updated_url: webhooks_on_channel_updated_url,
856
- webhooks_on_channel_updated_method: webhooks_on_channel_updated_method,
857
- webhooks_on_member_added_url: webhooks_on_member_added_url,
858
- webhooks_on_member_added_method: webhooks_on_member_added_method,
859
- webhooks_on_member_removed_url: webhooks_on_member_removed_url,
860
- webhooks_on_member_removed_method: webhooks_on_member_removed_method,
861
- limits_channel_members: limits_channel_members,
862
- limits_user_channels: limits_user_channels,
863
- )
864
- end
865
-
866
- ##
867
- # Access the channels
868
- # @return [channels] channels
869
- def channels
870
- context.channels
871
- end
872
-
873
- ##
874
- # Access the roles
875
- # @return [roles] roles
876
- def roles
877
- context.roles
878
- end
879
-
880
- ##
881
- # Access the users
882
- # @return [users] users
883
- def users
884
- context.users
885
- end
886
-
887
- ##
888
- # Provide a user friendly representation
889
- def to_s
890
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
891
- "<Twilio.Chat.V1.ServiceInstance #{values}>"
892
- end
893
-
894
- ##
895
- # Provide a detailed, user friendly representation
896
- def inspect
897
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
898
- "<Twilio.Chat.V1.ServiceInstance #{values}>"
899
- end
900
869
  end
901
- end
902
870
  end
903
- end
904
- end
871
+ end