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,773 +1,751 @@
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 - Messaging
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 Messaging < Domain
12
- class V1 < Version
13
- ##
14
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
15
- class ServiceList < ListResource
16
- ##
17
- # Initialize the ServiceList
18
- # @param [Version] version Version that contains the resource
19
- # @return [ServiceList] ServiceList
20
- def initialize(version)
21
- super(version)
22
-
23
- # Path Solution
24
- @solution = {}
25
- @uri = "/Services"
26
- end
27
-
28
- ##
29
- # Create the ServiceInstance
30
- # @param [String] friendly_name A descriptive string that you create to describe
31
- # the resource. It can be up to 64 characters long.
32
- # @param [String] inbound_request_url The URL we call using `inbound_method` when
33
- # a message is received by any phone number or short code in the Service. When
34
- # this property is `null`, receiving inbound messages is disabled. All messages
35
- # sent to the Twilio phone number or short code will not be logged and received on
36
- # the Account. If the `use_inbound_webhook_on_number` field is enabled then the
37
- # webhook url defined on the phone number will override the `inbound_request_url`
38
- # defined for the Messaging Service.
39
- # @param [String] inbound_method The HTTP method we should use to call
40
- # `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
41
- # @param [String] fallback_url The URL that we call using `fallback_method` if an
42
- # error occurs while retrieving or executing the TwiML from the Inbound Request
43
- # URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook
44
- # url defined on the phone number will override the `fallback_url` defined for the
45
- # Messaging Service.
46
- # @param [String] fallback_method The HTTP method we should use to call
47
- # `fallback_url`. Can be: `GET` or `POST`.
48
- # @param [String] status_callback The URL we should call to {pass status
49
- # updates}[https://www.twilio.com/docs/sms/api/message-resource#message-status-values]
50
- # about message delivery.
51
- # @param [Boolean] sticky_sender Whether to enable {Sticky
52
- # Sender}[https://www.twilio.com/docs/sms/services#sticky-sender] on the Service
53
- # instance.
54
- # @param [Boolean] mms_converter Whether to enable the {MMS
55
- # Converter}[https://www.twilio.com/docs/sms/services#mms-converter] for messages
56
- # sent through the Service instance.
57
- # @param [Boolean] smart_encoding Whether to enable {Smart
58
- # Encoding}[https://www.twilio.com/docs/sms/services#smart-encoding] for messages
59
- # sent through the Service instance.
60
- # @param [service.ScanMessageContent] scan_message_content Reserved.
61
- # @param [Boolean] fallback_to_long_code Whether to enable {Fallback to Long
62
- # Code}[https://www.twilio.com/docs/sms/services#fallback-to-long-code] for
63
- # messages sent through the Service instance.
64
- # @param [Boolean] area_code_geomatch Whether to enable {Area Code
65
- # Geomatch}[https://www.twilio.com/docs/sms/services#area-code-geomatch] on the
66
- # Service Instance.
67
- # @param [String] validity_period How long, in seconds, messages sent from the
68
- # Service are valid. Can be an integer from `1` to `14,400`.
69
- # @param [Boolean] synchronous_validation Reserved.
70
- # @param [String] usecase A string that describes the scenario in which the
71
- # Messaging Service will be used. Examples: [notification, marketing,
72
- # verification, poll ..].
73
- # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
74
- # either the webhook url configured on the phone number will be used or
75
- # `inbound_request_url`/`fallback_url` url will be called when a message is
76
- # received from the phone number. If this field is enabled then the webhook url
77
- # defined on the phone number will override the
78
- # `inbound_request_url`/`fallback_url` defined for the Messaging Service.
79
- # @return [ServiceInstance] Created ServiceInstance
80
- def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
81
- data = Twilio::Values.of({
82
- 'FriendlyName' => friendly_name,
83
- 'InboundRequestUrl' => inbound_request_url,
84
- 'InboundMethod' => inbound_method,
85
- 'FallbackUrl' => fallback_url,
86
- 'FallbackMethod' => fallback_method,
87
- 'StatusCallback' => status_callback,
88
- 'StickySender' => sticky_sender,
89
- 'MmsConverter' => mms_converter,
90
- 'SmartEncoding' => smart_encoding,
91
- 'ScanMessageContent' => scan_message_content,
92
- 'FallbackToLongCode' => fallback_to_long_code,
93
- 'AreaCodeGeomatch' => area_code_geomatch,
94
- 'ValidityPeriod' => validity_period,
95
- 'SynchronousValidation' => synchronous_validation,
96
- 'Usecase' => usecase,
97
- 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
98
- })
99
-
100
- payload = @version.create('POST', @uri, data: data)
101
-
102
- ServiceInstance.new(@version, payload, )
103
- end
104
-
105
- ##
106
- # Lists ServiceInstance records from the API as a list.
107
- # Unlike stream(), this operation is eager and will load `limit` records into
108
- # memory before returning.
109
- # @param [Integer] limit Upper limit for the number of records to return. stream()
110
- # guarantees to never return more than limit. Default is no limit
111
- # @param [Integer] page_size Number of records to fetch per request, when
112
- # not set will use the default value of 50 records. If no page_size is defined
113
- # but a limit is defined, stream() will attempt to read the limit with the most
114
- # efficient page size, i.e. min(limit, 1000)
115
- # @return [Array] Array of up to limit results
116
- def list(limit: nil, page_size: nil)
117
- self.stream(limit: limit, page_size: page_size).entries
118
- end
119
-
120
- ##
121
- # Streams ServiceInstance records from the API as an Enumerable.
122
- # This operation lazily loads records as efficiently as possible until the limit
123
- # is reached.
124
- # @param [Integer] limit Upper limit for the number of records to return. stream()
125
- # guarantees to never return more than limit. Default is no limit.
126
- # @param [Integer] page_size Number of records to fetch per request, when
127
- # not set will use the default value of 50 records. If no page_size is defined
128
- # but a limit is defined, stream() will attempt to read the limit with the most
129
- # efficient page size, i.e. min(limit, 1000)
130
- # @return [Enumerable] Enumerable that will yield up to limit results
131
- def stream(limit: nil, page_size: nil)
132
- limits = @version.read_limits(limit, page_size)
133
-
134
- page = self.page(page_size: limits[:page_size], )
135
-
136
- @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
137
- end
138
-
139
- ##
140
- # When passed a block, yields ServiceInstance records from the API.
141
- # This operation lazily loads records as efficiently as possible until the limit
142
- # is reached.
143
- def each
144
- limits = @version.read_limits
145
-
146
- page = self.page(page_size: limits[:page_size], )
147
-
148
- @version.stream(page,
17
+ module REST
18
+ class Messaging < MessagingBase
19
+ class V1 < Version
20
+ class ServiceList < ListResource
21
+ ##
22
+ # Initialize the ServiceList
23
+ # @param [Version] version Version that contains the resource
24
+ # @return [ServiceList] ServiceList
25
+ def initialize(version)
26
+ super(version)
27
+ # Path Solution
28
+ @solution = { }
29
+ @uri = "/Services"
30
+
31
+ end
32
+ ##
33
+ # Create the ServiceInstance
34
+ # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
35
+ # @param [String] inbound_request_url The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.
36
+ # @param [String] inbound_method The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
37
+ # @param [String] fallback_url The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
38
+ # @param [String] fallback_method The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
39
+ # @param [String] status_callback The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
40
+ # @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.
41
+ # @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.
42
+ # @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.
43
+ # @param [ScanMessageContent] scan_message_content
44
+ # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.
45
+ # @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.
46
+ # @param [String] validity_period How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
47
+ # @param [Boolean] synchronous_validation Reserved.
48
+ # @param [String] usecase A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..].
49
+ # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.
50
+ # @return [ServiceInstance] Created ServiceInstance
51
+ def create(
52
+ friendly_name: nil,
53
+ inbound_request_url: :unset,
54
+ inbound_method: :unset,
55
+ fallback_url: :unset,
56
+ fallback_method: :unset,
57
+ status_callback: :unset,
58
+ sticky_sender: :unset,
59
+ mms_converter: :unset,
60
+ smart_encoding: :unset,
61
+ scan_message_content: :unset,
62
+ fallback_to_long_code: :unset,
63
+ area_code_geomatch: :unset,
64
+ validity_period: :unset,
65
+ synchronous_validation: :unset,
66
+ usecase: :unset,
67
+ use_inbound_webhook_on_number: :unset
68
+ )
69
+
70
+ data = Twilio::Values.of({
71
+ 'FriendlyName' => friendly_name,
72
+ 'InboundRequestUrl' => inbound_request_url,
73
+ 'InboundMethod' => inbound_method,
74
+ 'FallbackUrl' => fallback_url,
75
+ 'FallbackMethod' => fallback_method,
76
+ 'StatusCallback' => status_callback,
77
+ 'StickySender' => sticky_sender,
78
+ 'MmsConverter' => mms_converter,
79
+ 'SmartEncoding' => smart_encoding,
80
+ 'ScanMessageContent' => scan_message_content,
81
+ 'FallbackToLongCode' => fallback_to_long_code,
82
+ 'AreaCodeGeomatch' => area_code_geomatch,
83
+ 'ValidityPeriod' => validity_period,
84
+ 'SynchronousValidation' => synchronous_validation,
85
+ 'Usecase' => usecase,
86
+ 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
87
+ })
88
+
89
+ payload = @version.create('POST', @uri, data: data)
90
+ ServiceInstance.new(
91
+ @version,
92
+ payload,
93
+ )
94
+ end
95
+
96
+
97
+ ##
98
+ # Lists ServiceInstance records from the API as a list.
99
+ # Unlike stream(), this operation is eager and will load `limit` records into
100
+ # memory before returning.
101
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
102
+ # guarantees to never return more than limit. Default is no limit
103
+ # @param [Integer] page_size Number of records to fetch per request, when
104
+ # not set will use the default value of 50 records. If no page_size is defined
105
+ # but a limit is defined, stream() will attempt to read the limit with the most
106
+ # efficient page size, i.e. min(limit, 1000)
107
+ # @return [Array] Array of up to limit results
108
+ def list(limit: nil, page_size: nil)
109
+ self.stream(
110
+ limit: limit,
111
+ page_size: page_size
112
+ ).entries
113
+ end
114
+
115
+ ##
116
+ # Streams Instance records from the API as an Enumerable.
117
+ # This operation lazily loads records as efficiently as possible until the limit
118
+ # is reached.
119
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
120
+ # guarantees to never return more than limit. Default is no limit
121
+ # @param [Integer] page_size Number of records to fetch per request, when
122
+ # not set will use the default value of 50 records. If no page_size is defined
123
+ # but a limit is defined, stream() will attempt to read the limit with the most
124
+ # efficient page size, i.e. min(limit, 1000)
125
+ # @return [Enumerable] Enumerable that will yield up to limit results
126
+ def stream(limit: nil, page_size: nil)
127
+ limits = @version.read_limits(limit, page_size)
128
+
129
+ page = self.page(
130
+ page_size: limits[:page_size], )
131
+
132
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
133
+ end
134
+
135
+ ##
136
+ # When passed a block, yields ServiceInstance records from the API.
137
+ # This operation lazily loads records as efficiently as possible until the limit
138
+ # is reached.
139
+ def each
140
+ limits = @version.read_limits
141
+
142
+ page = self.page(page_size: limits[:page_size], )
143
+
144
+ @version.stream(page,
149
145
  limit: limits[:limit],
150
146
  page_limit: limits[:page_limit]).each {|x| yield x}
151
- end
152
-
153
- ##
154
- # Retrieve a single page of ServiceInstance records from the API.
155
- # Request is executed immediately.
156
- # @param [String] page_token PageToken provided by the API
157
- # @param [Integer] page_number Page Number, this value is simply for client state
158
- # @param [Integer] page_size Number of records to return, defaults to 50
159
- # @return [Page] Page of ServiceInstance
160
- def page(page_token: :unset, page_number: :unset, page_size: :unset)
161
- params = Twilio::Values.of({
162
- 'PageToken' => page_token,
163
- 'Page' => page_number,
164
- 'PageSize' => page_size,
165
- })
166
-
167
- response = @version.page('GET', @uri, params: params)
168
-
169
- ServicePage.new(@version, response, @solution)
170
- end
171
-
172
- ##
173
- # Retrieve a single page of ServiceInstance records from the API.
174
- # Request is executed immediately.
175
- # @param [String] target_url API-generated URL for the requested results page
176
- # @return [Page] Page of ServiceInstance
177
- def get_page(target_url)
178
- response = @version.domain.request(
179
- 'GET',
180
- target_url
181
- )
182
- ServicePage.new(@version, response, @solution)
183
- end
184
-
185
- ##
186
- # Provide a user friendly representation
187
- def to_s
188
- '#<Twilio.Messaging.V1.ServiceList>'
189
- end
190
- end
191
-
192
- ##
193
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
194
- class ServicePage < Page
195
- ##
196
- # Initialize the ServicePage
197
- # @param [Version] version Version that contains the resource
198
- # @param [Response] response Response from the API
199
- # @param [Hash] solution Path solution for the resource
200
- # @return [ServicePage] ServicePage
201
- def initialize(version, response, solution)
202
- super(version, response)
203
-
204
- # Path Solution
205
- @solution = solution
206
- end
207
-
208
- ##
209
- # Build an instance of ServiceInstance
210
- # @param [Hash] payload Payload response from the API
211
- # @return [ServiceInstance] ServiceInstance
212
- def get_instance(payload)
213
- ServiceInstance.new(@version, payload, )
214
- end
215
-
216
- ##
217
- # Provide a user friendly representation
218
- def to_s
219
- '<Twilio.Messaging.V1.ServicePage>'
220
- end
221
- end
222
-
223
- ##
224
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
225
- class ServiceContext < InstanceContext
226
- ##
227
- # Initialize the ServiceContext
228
- # @param [Version] version Version that contains the resource
229
- # @param [String] sid The SID of the Service resource to fetch.
230
- # @return [ServiceContext] ServiceContext
231
- def initialize(version, sid)
232
- super(version)
233
-
234
- # Path Solution
235
- @solution = {sid: sid, }
236
- @uri = "/Services/#{@solution[:sid]}"
237
-
238
- # Dependents
239
- @phone_numbers = nil
240
- @short_codes = nil
241
- @alpha_senders = nil
242
- @us_app_to_person = nil
243
- @us_app_to_person_usecases = nil
244
- end
245
-
246
- ##
247
- # Update the ServiceInstance
248
- # @param [String] friendly_name A descriptive string that you create to describe
249
- # the resource. It can be up to 64 characters long.
250
- # @param [String] inbound_request_url The URL we call using `inbound_method` when
251
- # a message is received by any phone number or short code in the Service. When
252
- # this property is `null`, receiving inbound messages is disabled. All messages
253
- # sent to the Twilio phone number or short code will not be logged and received on
254
- # the Account. If the `use_inbound_webhook_on_number` field is enabled then the
255
- # webhook url defined on the phone number will override the `inbound_request_url`
256
- # defined for the Messaging Service.
257
- # @param [String] inbound_method The HTTP method we should use to call
258
- # `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
259
- # @param [String] fallback_url The URL that we call using `fallback_method` if an
260
- # error occurs while retrieving or executing the TwiML from the Inbound Request
261
- # URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook
262
- # url defined on the phone number will override the `fallback_url` defined for the
263
- # Messaging Service.
264
- # @param [String] fallback_method The HTTP method we should use to call
265
- # `fallback_url`. Can be: `GET` or `POST`.
266
- # @param [String] status_callback The URL we should call to {pass status
267
- # updates}[https://www.twilio.com/docs/sms/api/message-resource#message-status-values]
268
- # about message delivery.
269
- # @param [Boolean] sticky_sender Whether to enable {Sticky
270
- # Sender}[https://www.twilio.com/docs/sms/services#sticky-sender] on the Service
271
- # instance.
272
- # @param [Boolean] mms_converter Whether to enable the {MMS
273
- # Converter}[https://www.twilio.com/docs/sms/services#mms-converter] for messages
274
- # sent through the Service instance.
275
- # @param [Boolean] smart_encoding Whether to enable {Smart
276
- # Encoding}[https://www.twilio.com/docs/sms/services#smart-encoding] for messages
277
- # sent through the Service instance.
278
- # @param [service.ScanMessageContent] scan_message_content Reserved.
279
- # @param [Boolean] fallback_to_long_code Whether to enable {Fallback to Long
280
- # Code}[https://www.twilio.com/docs/sms/services#fallback-to-long-code] for
281
- # messages sent through the Service instance.
282
- # @param [Boolean] area_code_geomatch Whether to enable {Area Code
283
- # Geomatch}[https://www.twilio.com/docs/sms/services#area-code-geomatch] on the
284
- # Service Instance.
285
- # @param [String] validity_period How long, in seconds, messages sent from the
286
- # Service are valid. Can be an integer from `1` to `14,400`.
287
- # @param [Boolean] synchronous_validation Reserved.
288
- # @param [String] usecase A string that describes the scenario in which the
289
- # Messaging Service will be used. Examples: [notification, marketing,
290
- # verification, poll ..]
291
- # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
292
- # either the webhook url configured on the phone number will be used or
293
- # `inbound_request_url`/`fallback_url` url will be called when a message is
294
- # received from the phone number. If this field is enabled then the webhook url
295
- # defined on the phone number will override the
296
- # `inbound_request_url`/`fallback_url` defined for the Messaging Service.
297
- # @return [ServiceInstance] Updated ServiceInstance
298
- def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
299
- data = Twilio::Values.of({
300
- 'FriendlyName' => friendly_name,
301
- 'InboundRequestUrl' => inbound_request_url,
302
- 'InboundMethod' => inbound_method,
303
- 'FallbackUrl' => fallback_url,
304
- 'FallbackMethod' => fallback_method,
305
- 'StatusCallback' => status_callback,
306
- 'StickySender' => sticky_sender,
307
- 'MmsConverter' => mms_converter,
308
- 'SmartEncoding' => smart_encoding,
309
- 'ScanMessageContent' => scan_message_content,
310
- 'FallbackToLongCode' => fallback_to_long_code,
311
- 'AreaCodeGeomatch' => area_code_geomatch,
312
- 'ValidityPeriod' => validity_period,
313
- 'SynchronousValidation' => synchronous_validation,
314
- 'Usecase' => usecase,
315
- 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
316
- })
317
-
318
- payload = @version.update('POST', @uri, data: data)
319
-
320
- ServiceInstance.new(@version, payload, sid: @solution[:sid], )
321
- end
322
-
323
- ##
324
- # Fetch the ServiceInstance
325
- # @return [ServiceInstance] Fetched ServiceInstance
326
- def fetch
327
- payload = @version.fetch('GET', @uri)
328
-
329
- ServiceInstance.new(@version, payload, sid: @solution[:sid], )
330
- end
331
-
332
- ##
333
- # Delete the ServiceInstance
334
- # @return [Boolean] true if delete succeeds, false otherwise
335
- def delete
336
- @version.delete('DELETE', @uri)
337
- end
338
-
339
- ##
340
- # Access the phone_numbers
341
- # @return [PhoneNumberList]
342
- # @return [PhoneNumberContext] if sid was passed.
343
- def phone_numbers(sid=:unset)
344
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
345
-
346
- if sid != :unset
347
- return PhoneNumberContext.new(@version, @solution[:sid], sid, )
348
- end
349
-
350
- unless @phone_numbers
351
- @phone_numbers = PhoneNumberList.new(@version, service_sid: @solution[:sid], )
352
- end
353
-
354
- @phone_numbers
355
- end
356
-
357
- ##
358
- # Access the short_codes
359
- # @return [ShortCodeList]
360
- # @return [ShortCodeContext] if sid was passed.
361
- def short_codes(sid=:unset)
362
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
363
-
364
- if sid != :unset
365
- return ShortCodeContext.new(@version, @solution[:sid], sid, )
366
- end
367
-
368
- unless @short_codes
369
- @short_codes = ShortCodeList.new(@version, service_sid: @solution[:sid], )
370
- end
371
-
372
- @short_codes
373
- end
374
-
375
- ##
376
- # Access the alpha_senders
377
- # @return [AlphaSenderList]
378
- # @return [AlphaSenderContext] if sid was passed.
379
- def alpha_senders(sid=:unset)
380
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
381
-
382
- if sid != :unset
383
- return AlphaSenderContext.new(@version, @solution[:sid], sid, )
384
- end
385
-
386
- unless @alpha_senders
387
- @alpha_senders = AlphaSenderList.new(@version, service_sid: @solution[:sid], )
388
- end
389
-
390
- @alpha_senders
391
- end
392
-
393
- ##
394
- # Access the us_app_to_person
395
- # @return [UsAppToPersonList]
396
- # @return [UsAppToPersonContext] if sid was passed.
397
- def us_app_to_person(sid=:unset)
398
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
399
-
400
- if sid != :unset
401
- return UsAppToPersonContext.new(@version, @solution[:sid], sid, )
402
- end
403
-
404
- unless @us_app_to_person
405
- @us_app_to_person = UsAppToPersonList.new(@version, messaging_service_sid: @solution[:sid], )
406
- end
407
-
408
- @us_app_to_person
409
- end
410
-
411
- ##
412
- # Access the us_app_to_person_usecases
413
- # @return [UsAppToPersonUsecaseList]
414
- # @return [UsAppToPersonUsecaseContext]
415
- def us_app_to_person_usecases
416
- unless @us_app_to_person_usecases
417
- @us_app_to_person_usecases = UsAppToPersonUsecaseList.new(
418
- @version,
419
- messaging_service_sid: @solution[:sid],
420
- )
421
- end
422
-
423
- @us_app_to_person_usecases
424
- end
425
-
426
- ##
427
- # Provide a user friendly representation
428
- def to_s
429
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
430
- "#<Twilio.Messaging.V1.ServiceContext #{context}>"
431
- end
432
-
433
- ##
434
- # Provide a detailed, user friendly representation
435
- def inspect
436
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
437
- "#<Twilio.Messaging.V1.ServiceContext #{context}>"
438
- end
439
- end
147
+ end
148
+
149
+ ##
150
+ # Retrieve a single page of ServiceInstance records from the API.
151
+ # Request is executed immediately.
152
+ # @param [String] page_token PageToken provided by the API
153
+ # @param [Integer] page_number Page Number, this value is simply for client state
154
+ # @param [Integer] page_size Number of records to return, defaults to 50
155
+ # @return [Page] Page of ServiceInstance
156
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
157
+ params = Twilio::Values.of({
158
+
159
+ 'PageToken' => page_token,
160
+ 'Page' => page_number,
161
+ 'PageSize' => page_size,
162
+ })
163
+
164
+ response = @version.page('GET', @uri, params: params)
165
+
166
+ ServicePage.new(@version, response, @solution)
167
+ end
168
+
169
+ ##
170
+ # Retrieve a single page of ServiceInstance records from the API.
171
+ # Request is executed immediately.
172
+ # @param [String] target_url API-generated URL for the requested results page
173
+ # @return [Page] Page of ServiceInstance
174
+ def get_page(target_url)
175
+ response = @version.domain.request(
176
+ 'GET',
177
+ target_url
178
+ )
179
+ ServicePage.new(@version, response, @solution)
180
+ end
181
+
182
+
183
+
184
+ # Provide a user friendly representation
185
+ def to_s
186
+ '#<Twilio.Messaging.V1.ServiceList>'
187
+ end
188
+ end
189
+
190
+
191
+ ##
192
+ #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
193
+ class ServiceContext < InstanceContext
194
+ ##
195
+ # Initialize the ServiceContext
196
+ # @param [Version] version Version that contains the resource
197
+ # @param [String] sid The SID of the Service resource to update.
198
+ # @return [ServiceContext] ServiceContext
199
+ def initialize(version, sid)
200
+ super(version)
201
+
202
+ # Path Solution
203
+ @solution = { sid: sid, }
204
+ @uri = "/Services/#{@solution[:sid]}"
205
+
206
+ # Dependents
207
+ @us_app_to_person_usecases = nil
208
+ @alpha_senders = nil
209
+ @short_codes = nil
210
+ @us_app_to_person = nil
211
+ @phone_numbers = nil
212
+ end
213
+ ##
214
+ # Delete the ServiceInstance
215
+ # @return [Boolean] True if delete succeeds, false otherwise
216
+ def delete
217
+
218
+ @version.delete('DELETE', @uri)
219
+ end
220
+
221
+ ##
222
+ # Fetch the ServiceInstance
223
+ # @return [ServiceInstance] Fetched ServiceInstance
224
+ def fetch
225
+
226
+ payload = @version.fetch('GET', @uri)
227
+ ServiceInstance.new(
228
+ @version,
229
+ payload,
230
+ sid: @solution[:sid],
231
+ )
232
+ end
233
+
234
+ ##
235
+ # Update the ServiceInstance
236
+ # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
237
+ # @param [String] inbound_request_url The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.
238
+ # @param [String] inbound_method The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
239
+ # @param [String] fallback_url The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
240
+ # @param [String] fallback_method The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
241
+ # @param [String] status_callback The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
242
+ # @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.
243
+ # @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.
244
+ # @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.
245
+ # @param [ScanMessageContent] scan_message_content
246
+ # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.
247
+ # @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.
248
+ # @param [String] validity_period How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
249
+ # @param [Boolean] synchronous_validation Reserved.
250
+ # @param [String] usecase A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]
251
+ # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.
252
+ # @return [ServiceInstance] Updated ServiceInstance
253
+ def update(
254
+ friendly_name: :unset,
255
+ inbound_request_url: :unset,
256
+ inbound_method: :unset,
257
+ fallback_url: :unset,
258
+ fallback_method: :unset,
259
+ status_callback: :unset,
260
+ sticky_sender: :unset,
261
+ mms_converter: :unset,
262
+ smart_encoding: :unset,
263
+ scan_message_content: :unset,
264
+ fallback_to_long_code: :unset,
265
+ area_code_geomatch: :unset,
266
+ validity_period: :unset,
267
+ synchronous_validation: :unset,
268
+ usecase: :unset,
269
+ use_inbound_webhook_on_number: :unset
270
+ )
271
+
272
+ data = Twilio::Values.of({
273
+ 'FriendlyName' => friendly_name,
274
+ 'InboundRequestUrl' => inbound_request_url,
275
+ 'InboundMethod' => inbound_method,
276
+ 'FallbackUrl' => fallback_url,
277
+ 'FallbackMethod' => fallback_method,
278
+ 'StatusCallback' => status_callback,
279
+ 'StickySender' => sticky_sender,
280
+ 'MmsConverter' => mms_converter,
281
+ 'SmartEncoding' => smart_encoding,
282
+ 'ScanMessageContent' => scan_message_content,
283
+ 'FallbackToLongCode' => fallback_to_long_code,
284
+ 'AreaCodeGeomatch' => area_code_geomatch,
285
+ 'ValidityPeriod' => validity_period,
286
+ 'SynchronousValidation' => synchronous_validation,
287
+ 'Usecase' => usecase,
288
+ 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
289
+ })
290
+
291
+ payload = @version.update('POST', @uri, data: data)
292
+ ServiceInstance.new(
293
+ @version,
294
+ payload,
295
+ sid: @solution[:sid],
296
+ )
297
+ end
298
+
299
+ ##
300
+ # Access the us_app_to_person_usecases
301
+ # @return [UsAppToPersonUsecaseList]
302
+ # @return [UsAppToPersonUsecaseContext]
303
+ def us_app_to_person_usecases
304
+ unless @us_app_to_person_usecases
305
+ @us_app_to_person_usecases = UsAppToPersonUsecaseList.new(
306
+ @version, messaging_service_sid: @solution[:sid], )
307
+ end
308
+ @us_app_to_person_usecases
309
+ end
310
+ ##
311
+ # Access the alpha_senders
312
+ # @return [AlphaSenderList]
313
+ # @return [AlphaSenderContext] if sid was passed.
314
+ def alpha_senders(sid=:unset)
315
+
316
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
317
+
318
+ if sid != :unset
319
+ return AlphaSenderContext.new(@version, @solution[:sid],sid )
320
+ end
321
+
322
+ unless @alpha_senders
323
+ @alpha_senders = AlphaSenderList.new(
324
+ @version, service_sid: @solution[:sid], )
325
+ end
326
+
327
+ @alpha_senders
328
+ end
329
+ ##
330
+ # Access the short_codes
331
+ # @return [ShortCodeList]
332
+ # @return [ShortCodeContext] if sid was passed.
333
+ def short_codes(sid=:unset)
334
+
335
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
336
+
337
+ if sid != :unset
338
+ return ShortCodeContext.new(@version, @solution[:sid],sid )
339
+ end
340
+
341
+ unless @short_codes
342
+ @short_codes = ShortCodeList.new(
343
+ @version, service_sid: @solution[:sid], )
344
+ end
345
+
346
+ @short_codes
347
+ end
348
+ ##
349
+ # Access the us_app_to_person
350
+ # @return [UsAppToPersonList]
351
+ # @return [UsAppToPersonContext] if sid was passed.
352
+ def us_app_to_person(sid=:unset)
353
+
354
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
355
+
356
+ if sid != :unset
357
+ return UsAppToPersonContext.new(@version, @solution[:sid],sid )
358
+ end
359
+
360
+ unless @us_app_to_person
361
+ @us_app_to_person = UsAppToPersonList.new(
362
+ @version, messaging_service_sid: @solution[:sid], )
363
+ end
364
+
365
+ @us_app_to_person
366
+ end
367
+ ##
368
+ # Access the phone_numbers
369
+ # @return [PhoneNumberList]
370
+ # @return [PhoneNumberContext] if sid was passed.
371
+ def phone_numbers(sid=:unset)
372
+
373
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
374
+
375
+ if sid != :unset
376
+ return PhoneNumberContext.new(@version, @solution[:sid],sid )
377
+ end
378
+
379
+ unless @phone_numbers
380
+ @phone_numbers = PhoneNumberList.new(
381
+ @version, service_sid: @solution[:sid], )
382
+ end
383
+
384
+ @phone_numbers
385
+ end
386
+
387
+ ##
388
+ # Provide a user friendly representation
389
+ def to_s
390
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
391
+ "#<Twilio.Messaging.V1.ServiceContext #{context}>"
392
+ end
393
+
394
+ ##
395
+ # Provide a detailed, user friendly representation
396
+ def inspect
397
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
398
+ "#<Twilio.Messaging.V1.ServiceContext #{context}>"
399
+ end
400
+ end
401
+
402
+ class ServicePage < Page
403
+ ##
404
+ # Initialize the ServicePage
405
+ # @param [Version] version Version that contains the resource
406
+ # @param [Response] response Response from the API
407
+ # @param [Hash] solution Path solution for the resource
408
+ # @return [ServicePage] ServicePage
409
+ def initialize(version, response, solution)
410
+ super(version, response)
411
+
412
+ # Path Solution
413
+ @solution = solution
414
+ end
415
+
416
+ ##
417
+ # Build an instance of ServiceInstance
418
+ # @param [Hash] payload Payload response from the API
419
+ # @return [ServiceInstance] ServiceInstance
420
+ def get_instance(payload)
421
+ ServiceInstance.new(@version, payload)
422
+ end
423
+
424
+ ##
425
+ # Provide a user friendly representation
426
+ def to_s
427
+ '<Twilio.Messaging.V1.ServicePage>'
428
+ end
429
+ end
430
+ class ServiceInstance < InstanceResource
431
+ ##
432
+ # Initialize the ServiceInstance
433
+ # @param [Version] version Version that contains the resource
434
+ # @param [Hash] payload payload that contains response from Twilio
435
+ # @param [String] account_sid The SID of the
436
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Service
437
+ # resource.
438
+ # @param [String] sid The SID of the Call resource to fetch.
439
+ # @return [ServiceInstance] ServiceInstance
440
+ def initialize(version, payload , sid: nil)
441
+ super(version)
442
+
443
+ # Marshaled Properties
444
+ @properties = {
445
+ 'sid' => payload['sid'],
446
+ 'account_sid' => payload['account_sid'],
447
+ 'friendly_name' => payload['friendly_name'],
448
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
449
+ 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
450
+ 'inbound_request_url' => payload['inbound_request_url'],
451
+ 'inbound_method' => payload['inbound_method'],
452
+ 'fallback_url' => payload['fallback_url'],
453
+ 'fallback_method' => payload['fallback_method'],
454
+ 'status_callback' => payload['status_callback'],
455
+ 'sticky_sender' => payload['sticky_sender'],
456
+ 'mms_converter' => payload['mms_converter'],
457
+ 'smart_encoding' => payload['smart_encoding'],
458
+ 'scan_message_content' => payload['scan_message_content'],
459
+ 'fallback_to_long_code' => payload['fallback_to_long_code'],
460
+ 'area_code_geomatch' => payload['area_code_geomatch'],
461
+ 'synchronous_validation' => payload['synchronous_validation'],
462
+ 'validity_period' => payload['validity_period'] == nil ? payload['validity_period'] : payload['validity_period'].to_i,
463
+ 'url' => payload['url'],
464
+ 'links' => payload['links'],
465
+ 'usecase' => payload['usecase'],
466
+ 'us_app_to_person_registered' => payload['us_app_to_person_registered'],
467
+ 'use_inbound_webhook_on_number' => payload['use_inbound_webhook_on_number'],
468
+ }
469
+
470
+ # Context
471
+ @instance_context = nil
472
+ @params = { 'sid' => sid || @properties['sid'] , }
473
+ end
474
+
475
+ ##
476
+ # Generate an instance context for the instance, the context is capable of
477
+ # performing various actions. All instance actions are proxied to the context
478
+ # @return [ServiceContext] CallContext for this CallInstance
479
+ def context
480
+ unless @instance_context
481
+ @instance_context = ServiceContext.new(@version , @params['sid'])
482
+ end
483
+ @instance_context
484
+ end
485
+
486
+ ##
487
+ # @return [String] The unique string that we created to identify the Service resource.
488
+ def sid
489
+ @properties['sid']
490
+ end
491
+
492
+ ##
493
+ # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource.
494
+ def account_sid
495
+ @properties['account_sid']
496
+ end
497
+
498
+ ##
499
+ # @return [String] The string that you assigned to describe the resource.
500
+ def friendly_name
501
+ @properties['friendly_name']
502
+ end
503
+
504
+ ##
505
+ # @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.
506
+ def date_created
507
+ @properties['date_created']
508
+ end
509
+
510
+ ##
511
+ # @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.
512
+ def date_updated
513
+ @properties['date_updated']
514
+ end
515
+
516
+ ##
517
+ # @return [String] The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.
518
+ def inbound_request_url
519
+ @properties['inbound_request_url']
520
+ end
521
+
522
+ ##
523
+ # @return [String] The HTTP method we use to call `inbound_request_url`. Can be `GET` or `POST`.
524
+ def inbound_method
525
+ @properties['inbound_method']
526
+ end
527
+
528
+ ##
529
+ # @return [String] The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
530
+ def fallback_url
531
+ @properties['fallback_url']
532
+ end
533
+
534
+ ##
535
+ # @return [String] The HTTP method we use to call `fallback_url`. Can be: `GET` or `POST`.
536
+ def fallback_method
537
+ @properties['fallback_method']
538
+ end
539
+
540
+ ##
541
+ # @return [String] The URL we call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
542
+ def status_callback
543
+ @properties['status_callback']
544
+ end
545
+
546
+ ##
547
+ # @return [Boolean] Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.
548
+ def sticky_sender
549
+ @properties['sticky_sender']
550
+ end
551
+
552
+ ##
553
+ # @return [Boolean] Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.
554
+ def mms_converter
555
+ @properties['mms_converter']
556
+ end
557
+
558
+ ##
559
+ # @return [Boolean] Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.
560
+ def smart_encoding
561
+ @properties['smart_encoding']
562
+ end
563
+
564
+ ##
565
+ # @return [ScanMessageContent]
566
+ def scan_message_content
567
+ @properties['scan_message_content']
568
+ end
569
+
570
+ ##
571
+ # @return [Boolean] Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.
572
+ def fallback_to_long_code
573
+ @properties['fallback_to_long_code']
574
+ end
575
+
576
+ ##
577
+ # @return [Boolean] Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.
578
+ def area_code_geomatch
579
+ @properties['area_code_geomatch']
580
+ end
581
+
582
+ ##
583
+ # @return [Boolean] Reserved.
584
+ def synchronous_validation
585
+ @properties['synchronous_validation']
586
+ end
587
+
588
+ ##
589
+ # @return [String] How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
590
+ def validity_period
591
+ @properties['validity_period']
592
+ end
593
+
594
+ ##
595
+ # @return [String] The absolute URL of the Service resource.
596
+ def url
597
+ @properties['url']
598
+ end
599
+
600
+ ##
601
+ # @return [Hash] The absolute URLs of related resources.
602
+ def links
603
+ @properties['links']
604
+ end
605
+
606
+ ##
607
+ # @return [String] A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]
608
+ def usecase
609
+ @properties['usecase']
610
+ end
611
+
612
+ ##
613
+ # @return [Boolean] Whether US A2P campaign is registered for this Service.
614
+ def us_app_to_person_registered
615
+ @properties['us_app_to_person_registered']
616
+ end
617
+
618
+ ##
619
+ # @return [Boolean] A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.
620
+ def use_inbound_webhook_on_number
621
+ @properties['use_inbound_webhook_on_number']
622
+ end
623
+
624
+ ##
625
+ # Delete the ServiceInstance
626
+ # @return [Boolean] True if delete succeeds, false otherwise
627
+ def delete
628
+
629
+ context.delete
630
+ end
631
+
632
+ ##
633
+ # Fetch the ServiceInstance
634
+ # @return [ServiceInstance] Fetched ServiceInstance
635
+ def fetch
636
+
637
+ context.fetch
638
+ end
639
+
640
+ ##
641
+ # Update the ServiceInstance
642
+ # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
643
+ # @param [String] inbound_request_url The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.
644
+ # @param [String] inbound_method The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
645
+ # @param [String] fallback_url The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
646
+ # @param [String] fallback_method The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
647
+ # @param [String] status_callback The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
648
+ # @param [Boolean] sticky_sender Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.
649
+ # @param [Boolean] mms_converter Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.
650
+ # @param [Boolean] smart_encoding Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.
651
+ # @param [ScanMessageContent] scan_message_content
652
+ # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.
653
+ # @param [Boolean] area_code_geomatch Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.
654
+ # @param [String] validity_period How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
655
+ # @param [Boolean] synchronous_validation Reserved.
656
+ # @param [String] usecase A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]
657
+ # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.
658
+ # @return [ServiceInstance] Updated ServiceInstance
659
+ def update(
660
+ friendly_name: :unset,
661
+ inbound_request_url: :unset,
662
+ inbound_method: :unset,
663
+ fallback_url: :unset,
664
+ fallback_method: :unset,
665
+ status_callback: :unset,
666
+ sticky_sender: :unset,
667
+ mms_converter: :unset,
668
+ smart_encoding: :unset,
669
+ scan_message_content: :unset,
670
+ fallback_to_long_code: :unset,
671
+ area_code_geomatch: :unset,
672
+ validity_period: :unset,
673
+ synchronous_validation: :unset,
674
+ usecase: :unset,
675
+ use_inbound_webhook_on_number: :unset
676
+ )
677
+
678
+ context.update(
679
+ friendly_name: friendly_name,
680
+ inbound_request_url: inbound_request_url,
681
+ inbound_method: inbound_method,
682
+ fallback_url: fallback_url,
683
+ fallback_method: fallback_method,
684
+ status_callback: status_callback,
685
+ sticky_sender: sticky_sender,
686
+ mms_converter: mms_converter,
687
+ smart_encoding: smart_encoding,
688
+ scan_message_content: scan_message_content,
689
+ fallback_to_long_code: fallback_to_long_code,
690
+ area_code_geomatch: area_code_geomatch,
691
+ validity_period: validity_period,
692
+ synchronous_validation: synchronous_validation,
693
+ usecase: usecase,
694
+ use_inbound_webhook_on_number: use_inbound_webhook_on_number,
695
+ )
696
+ end
697
+
698
+ ##
699
+ # Access the us_app_to_person_usecases
700
+ # @return [us_app_to_person_usecases] us_app_to_person_usecases
701
+ def us_app_to_person_usecases
702
+ context.us_app_to_person_usecases
703
+ end
704
+
705
+ ##
706
+ # Access the alpha_senders
707
+ # @return [alpha_senders] alpha_senders
708
+ def alpha_senders
709
+ context.alpha_senders
710
+ end
711
+
712
+ ##
713
+ # Access the short_codes
714
+ # @return [short_codes] short_codes
715
+ def short_codes
716
+ context.short_codes
717
+ end
718
+
719
+ ##
720
+ # Access the us_app_to_person
721
+ # @return [us_app_to_person] us_app_to_person
722
+ def us_app_to_person
723
+ context.us_app_to_person
724
+ end
725
+
726
+ ##
727
+ # Access the phone_numbers
728
+ # @return [phone_numbers] phone_numbers
729
+ def phone_numbers
730
+ context.phone_numbers
731
+ end
732
+
733
+ ##
734
+ # Provide a user friendly representation
735
+ def to_s
736
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
737
+ "<Twilio.Messaging.V1.ServiceInstance #{values}>"
738
+ end
739
+
740
+ ##
741
+ # Provide a detailed, user friendly representation
742
+ def inspect
743
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
744
+ "<Twilio.Messaging.V1.ServiceInstance #{values}>"
745
+ end
746
+ end
440
747
 
441
- ##
442
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
443
- class ServiceInstance < InstanceResource
444
- ##
445
- # Initialize the ServiceInstance
446
- # @param [Version] version Version that contains the resource
447
- # @param [Hash] payload payload that contains response from Twilio
448
- # @param [String] sid The SID of the Service resource to fetch.
449
- # @return [ServiceInstance] ServiceInstance
450
- def initialize(version, payload, sid: nil)
451
- super(version)
452
-
453
- # Marshaled Properties
454
- @properties = {
455
- 'sid' => payload['sid'],
456
- 'account_sid' => payload['account_sid'],
457
- 'friendly_name' => payload['friendly_name'],
458
- 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
459
- 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
460
- 'inbound_request_url' => payload['inbound_request_url'],
461
- 'inbound_method' => payload['inbound_method'],
462
- 'fallback_url' => payload['fallback_url'],
463
- 'fallback_method' => payload['fallback_method'],
464
- 'status_callback' => payload['status_callback'],
465
- 'sticky_sender' => payload['sticky_sender'],
466
- 'mms_converter' => payload['mms_converter'],
467
- 'smart_encoding' => payload['smart_encoding'],
468
- 'scan_message_content' => payload['scan_message_content'],
469
- 'fallback_to_long_code' => payload['fallback_to_long_code'],
470
- 'area_code_geomatch' => payload['area_code_geomatch'],
471
- 'synchronous_validation' => payload['synchronous_validation'],
472
- 'validity_period' => payload['validity_period'].to_i,
473
- 'url' => payload['url'],
474
- 'links' => payload['links'],
475
- 'usecase' => payload['usecase'],
476
- 'us_app_to_person_registered' => payload['us_app_to_person_registered'],
477
- 'use_inbound_webhook_on_number' => payload['use_inbound_webhook_on_number'],
478
- }
479
-
480
- # Context
481
- @instance_context = nil
482
- @params = {'sid' => sid || @properties['sid'], }
483
- end
484
-
485
- ##
486
- # Generate an instance context for the instance, the context is capable of
487
- # performing various actions. All instance actions are proxied to the context
488
- # @return [ServiceContext] ServiceContext for this ServiceInstance
489
- def context
490
- unless @instance_context
491
- @instance_context = ServiceContext.new(@version, @params['sid'], )
492
748
  end
493
- @instance_context
494
- end
495
-
496
- ##
497
- # @return [String] The unique string that identifies the resource
498
- def sid
499
- @properties['sid']
500
- end
501
-
502
- ##
503
- # @return [String] The SID of the Account that created the resource
504
- def account_sid
505
- @properties['account_sid']
506
- end
507
-
508
- ##
509
- # @return [String] The string that you assigned to describe the resource
510
- def friendly_name
511
- @properties['friendly_name']
512
- end
513
-
514
- ##
515
- # @return [Time] The ISO 8601 date and time in GMT when the resource was created
516
- def date_created
517
- @properties['date_created']
518
- end
519
-
520
- ##
521
- # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
522
- def date_updated
523
- @properties['date_updated']
524
- end
525
-
526
- ##
527
- # @return [String] The URL we call using inbound_method when a message is received by any phone number or short code in the Service. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled.
528
- def inbound_request_url
529
- @properties['inbound_request_url']
530
- end
531
-
532
- ##
533
- # @return [String] The HTTP method we use to call inbound_request_url
534
- def inbound_method
535
- @properties['inbound_method']
536
- end
537
-
538
- ##
539
- # @return [String] The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled.
540
- def fallback_url
541
- @properties['fallback_url']
542
- end
543
-
544
- ##
545
- # @return [String] The HTTP method we use to call fallback_url
546
- def fallback_method
547
- @properties['fallback_method']
548
- end
549
-
550
- ##
551
- # @return [String] The URL we call to pass status updates about message delivery
552
- def status_callback
553
- @properties['status_callback']
554
- end
555
-
556
- ##
557
- # @return [Boolean] Whether to enable Sticky Sender on the Service instance
558
- def sticky_sender
559
- @properties['sticky_sender']
560
- end
561
-
562
- ##
563
- # @return [Boolean] Whether to enable the MMS Converter for messages sent through the Service instance
564
- def mms_converter
565
- @properties['mms_converter']
566
- end
567
-
568
- ##
569
- # @return [Boolean] Whether to enable Encoding for messages sent through the Service instance
570
- def smart_encoding
571
- @properties['smart_encoding']
572
- end
573
-
574
- ##
575
- # @return [service.ScanMessageContent] Reserved
576
- def scan_message_content
577
- @properties['scan_message_content']
578
- end
579
-
580
- ##
581
- # @return [Boolean] Whether to enable Fallback to Long Code for messages sent through the Service instance
582
- def fallback_to_long_code
583
- @properties['fallback_to_long_code']
584
- end
585
-
586
- ##
587
- # @return [Boolean] Whether to enable Area Code Geomatch on the Service Instance
588
- def area_code_geomatch
589
- @properties['area_code_geomatch']
590
- end
591
-
592
- ##
593
- # @return [Boolean] Reserved
594
- def synchronous_validation
595
- @properties['synchronous_validation']
596
- end
597
-
598
- ##
599
- # @return [String] How long, in seconds, messages sent from the Service are valid
600
- def validity_period
601
- @properties['validity_period']
602
- end
603
-
604
- ##
605
- # @return [String] The absolute URL of the Service resource
606
- def url
607
- @properties['url']
608
- end
609
-
610
- ##
611
- # @return [String] The absolute URLs of related resources
612
- def links
613
- @properties['links']
614
- end
615
-
616
- ##
617
- # @return [String] A string describing the scenario in which the Messaging Service will be used
618
- def usecase
619
- @properties['usecase']
620
- end
621
-
622
- ##
623
- # @return [Boolean] Whether US A2P campaign is registered for this Service.
624
- def us_app_to_person_registered
625
- @properties['us_app_to_person_registered']
626
- end
627
-
628
- ##
629
- # @return [Boolean] If enabled, the webhook url configured on the phone number will be used and will override the `inbound_request_url`/`fallback_url` url called when an inbound message is received.
630
- def use_inbound_webhook_on_number
631
- @properties['use_inbound_webhook_on_number']
632
- end
633
-
634
- ##
635
- # Update the ServiceInstance
636
- # @param [String] friendly_name A descriptive string that you create to describe
637
- # the resource. It can be up to 64 characters long.
638
- # @param [String] inbound_request_url The URL we call using `inbound_method` when
639
- # a message is received by any phone number or short code in the Service. When
640
- # this property is `null`, receiving inbound messages is disabled. All messages
641
- # sent to the Twilio phone number or short code will not be logged and received on
642
- # the Account. If the `use_inbound_webhook_on_number` field is enabled then the
643
- # webhook url defined on the phone number will override the `inbound_request_url`
644
- # defined for the Messaging Service.
645
- # @param [String] inbound_method The HTTP method we should use to call
646
- # `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
647
- # @param [String] fallback_url The URL that we call using `fallback_method` if an
648
- # error occurs while retrieving or executing the TwiML from the Inbound Request
649
- # URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook
650
- # url defined on the phone number will override the `fallback_url` defined for the
651
- # Messaging Service.
652
- # @param [String] fallback_method The HTTP method we should use to call
653
- # `fallback_url`. Can be: `GET` or `POST`.
654
- # @param [String] status_callback The URL we should call to {pass status
655
- # updates}[https://www.twilio.com/docs/sms/api/message-resource#message-status-values]
656
- # about message delivery.
657
- # @param [Boolean] sticky_sender Whether to enable {Sticky
658
- # Sender}[https://www.twilio.com/docs/sms/services#sticky-sender] on the Service
659
- # instance.
660
- # @param [Boolean] mms_converter Whether to enable the {MMS
661
- # Converter}[https://www.twilio.com/docs/sms/services#mms-converter] for messages
662
- # sent through the Service instance.
663
- # @param [Boolean] smart_encoding Whether to enable {Smart
664
- # Encoding}[https://www.twilio.com/docs/sms/services#smart-encoding] for messages
665
- # sent through the Service instance.
666
- # @param [service.ScanMessageContent] scan_message_content Reserved.
667
- # @param [Boolean] fallback_to_long_code Whether to enable {Fallback to Long
668
- # Code}[https://www.twilio.com/docs/sms/services#fallback-to-long-code] for
669
- # messages sent through the Service instance.
670
- # @param [Boolean] area_code_geomatch Whether to enable {Area Code
671
- # Geomatch}[https://www.twilio.com/docs/sms/services#area-code-geomatch] on the
672
- # Service Instance.
673
- # @param [String] validity_period How long, in seconds, messages sent from the
674
- # Service are valid. Can be an integer from `1` to `14,400`.
675
- # @param [Boolean] synchronous_validation Reserved.
676
- # @param [String] usecase A string that describes the scenario in which the
677
- # Messaging Service will be used. Examples: [notification, marketing,
678
- # verification, poll ..]
679
- # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
680
- # either the webhook url configured on the phone number will be used or
681
- # `inbound_request_url`/`fallback_url` url will be called when a message is
682
- # received from the phone number. If this field is enabled then the webhook url
683
- # defined on the phone number will override the
684
- # `inbound_request_url`/`fallback_url` defined for the Messaging Service.
685
- # @return [ServiceInstance] Updated ServiceInstance
686
- def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
687
- context.update(
688
- friendly_name: friendly_name,
689
- inbound_request_url: inbound_request_url,
690
- inbound_method: inbound_method,
691
- fallback_url: fallback_url,
692
- fallback_method: fallback_method,
693
- status_callback: status_callback,
694
- sticky_sender: sticky_sender,
695
- mms_converter: mms_converter,
696
- smart_encoding: smart_encoding,
697
- scan_message_content: scan_message_content,
698
- fallback_to_long_code: fallback_to_long_code,
699
- area_code_geomatch: area_code_geomatch,
700
- validity_period: validity_period,
701
- synchronous_validation: synchronous_validation,
702
- usecase: usecase,
703
- use_inbound_webhook_on_number: use_inbound_webhook_on_number,
704
- )
705
- end
706
-
707
- ##
708
- # Fetch the ServiceInstance
709
- # @return [ServiceInstance] Fetched ServiceInstance
710
- def fetch
711
- context.fetch
712
- end
713
-
714
- ##
715
- # Delete the ServiceInstance
716
- # @return [Boolean] true if delete succeeds, false otherwise
717
- def delete
718
- context.delete
719
- end
720
-
721
- ##
722
- # Access the phone_numbers
723
- # @return [phone_numbers] phone_numbers
724
- def phone_numbers
725
- context.phone_numbers
726
- end
727
-
728
- ##
729
- # Access the short_codes
730
- # @return [short_codes] short_codes
731
- def short_codes
732
- context.short_codes
733
- end
734
-
735
- ##
736
- # Access the alpha_senders
737
- # @return [alpha_senders] alpha_senders
738
- def alpha_senders
739
- context.alpha_senders
740
- end
741
-
742
- ##
743
- # Access the us_app_to_person
744
- # @return [us_app_to_person] us_app_to_person
745
- def us_app_to_person
746
- context.us_app_to_person
747
- end
748
-
749
- ##
750
- # Access the us_app_to_person_usecases
751
- # @return [us_app_to_person_usecases] us_app_to_person_usecases
752
- def us_app_to_person_usecases
753
- context.us_app_to_person_usecases
754
- end
755
-
756
- ##
757
- # Provide a user friendly representation
758
- def to_s
759
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
760
- "<Twilio.Messaging.V1.ServiceInstance #{values}>"
761
- end
762
-
763
- ##
764
- # Provide a detailed, user friendly representation
765
- def inspect
766
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
767
- "<Twilio.Messaging.V1.ServiceInstance #{values}>"
768
- end
769
749
  end
770
- end
771
750
  end
772
- end
773
- end
751
+ end