twilio-ruby 5.72.0 → 6.0.2

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