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,910 +1,853 @@
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 - Api
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
8
-
9
- module Twilio
10
- module REST
11
- class Api < Domain
12
- class V2010 < Version
13
- class AccountContext < InstanceContext
14
- class IncomingPhoneNumberList < ListResource
15
- ##
16
- # Initialize the IncomingPhoneNumberList
17
- # @param [Version] version Version that contains the resource
18
- # @param [String] account_sid The SID of the
19
- # {Account}[https://www.twilio.com/docs/iam/api/account] that created this
20
- # IncomingPhoneNumber resource.
21
- # @return [IncomingPhoneNumberList] IncomingPhoneNumberList
22
- def initialize(version, account_sid: nil)
23
- super(version)
24
-
25
- # Path Solution
26
- @solution = {account_sid: account_sid}
27
- @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers.json"
28
-
29
- # Components
30
- @local = nil
31
- @mobile = nil
32
- @toll_free = nil
33
- end
34
-
35
- ##
36
- # Lists IncomingPhoneNumberInstance records from the API as a list.
37
- # Unlike stream(), this operation is eager and will load `limit` records into
38
- # memory before returning.
39
- # @param [Boolean] beta Whether to include phone numbers new to the Twilio
40
- # platform. Can be: `true` or `false` and the default is `true`.
41
- # @param [String] friendly_name A string that identifies the IncomingPhoneNumber
42
- # resources to read.
43
- # @param [String] phone_number The phone numbers of the IncomingPhoneNumber
44
- # resources to read. You can specify partial numbers and use '*' as a wildcard for
45
- # any digit.
46
- # @param [String] origin Whether to include phone numbers based on their origin.
47
- # Can be: `twilio` or `hosted`. By default, phone numbers of all origin are
48
- # included.
49
- # @param [Integer] limit Upper limit for the number of records to return. stream()
50
- # guarantees to never return more than limit. Default is no limit
51
- # @param [Integer] page_size Number of records to fetch per request, when
52
- # not set will use the default value of 50 records. If no page_size is defined
53
- # but a limit is defined, stream() will attempt to read the limit with the most
54
- # efficient page size, i.e. min(limit, 1000)
55
- # @return [Array] Array of up to limit results
56
- def list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
57
- self.stream(
58
- beta: beta,
59
- friendly_name: friendly_name,
60
- phone_number: phone_number,
61
- origin: origin,
62
- limit: limit,
63
- page_size: page_size
64
- ).entries
65
- end
66
-
67
- ##
68
- # Streams IncomingPhoneNumberInstance records from the API as an Enumerable.
69
- # This operation lazily loads records as efficiently as possible until the limit
70
- # is reached.
71
- # @param [Boolean] beta Whether to include phone numbers new to the Twilio
72
- # platform. Can be: `true` or `false` and the default is `true`.
73
- # @param [String] friendly_name A string that identifies the IncomingPhoneNumber
74
- # resources to read.
75
- # @param [String] phone_number The phone numbers of the IncomingPhoneNumber
76
- # resources to read. You can specify partial numbers and use '*' as a wildcard for
77
- # any digit.
78
- # @param [String] origin Whether to include phone numbers based on their origin.
79
- # Can be: `twilio` or `hosted`. By default, phone numbers of all origin are
80
- # included.
81
- # @param [Integer] limit Upper limit for the number of records to return. stream()
82
- # guarantees to never return more than limit. Default is no limit.
83
- # @param [Integer] page_size Number of records to fetch per request, when
84
- # not set will use the default value of 50 records. If no page_size is defined
85
- # but a limit is defined, stream() will attempt to read the limit with the most
86
- # efficient page size, i.e. min(limit, 1000)
87
- # @return [Enumerable] Enumerable that will yield up to limit results
88
- def stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
89
- limits = @version.read_limits(limit, page_size)
90
-
91
- page = self.page(
92
- beta: beta,
93
- friendly_name: friendly_name,
94
- phone_number: phone_number,
95
- origin: origin,
96
- page_size: limits[:page_size],
97
- )
98
-
99
- @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
100
- end
101
-
102
- ##
103
- # When passed a block, yields IncomingPhoneNumberInstance records from the API.
104
- # This operation lazily loads records as efficiently as possible until the limit
105
- # is reached.
106
- def each
107
- limits = @version.read_limits
108
-
109
- page = self.page(page_size: limits[:page_size], )
110
-
111
- @version.stream(page,
112
- limit: limits[:limit],
113
- page_limit: limits[:page_limit]).each {|x| yield x}
114
- end
115
-
116
- ##
117
- # Retrieve a single page of IncomingPhoneNumberInstance records from the API.
118
- # Request is executed immediately.
119
- # @param [Boolean] beta Whether to include phone numbers new to the Twilio
120
- # platform. Can be: `true` or `false` and the default is `true`.
121
- # @param [String] friendly_name A string that identifies the IncomingPhoneNumber
122
- # resources to read.
123
- # @param [String] phone_number The phone numbers of the IncomingPhoneNumber
124
- # resources to read. You can specify partial numbers and use '*' as a wildcard for
125
- # any digit.
126
- # @param [String] origin Whether to include phone numbers based on their origin.
127
- # Can be: `twilio` or `hosted`. By default, phone numbers of all origin are
128
- # included.
129
- # @param [String] page_token PageToken provided by the API
130
- # @param [Integer] page_number Page Number, this value is simply for client state
131
- # @param [Integer] page_size Number of records to return, defaults to 50
132
- # @return [Page] Page of IncomingPhoneNumberInstance
133
- def page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
134
- params = Twilio::Values.of({
135
- 'Beta' => beta,
136
- 'FriendlyName' => friendly_name,
137
- 'PhoneNumber' => phone_number,
138
- 'Origin' => origin,
139
- 'PageToken' => page_token,
140
- 'Page' => page_number,
141
- 'PageSize' => page_size,
142
- })
143
-
144
- response = @version.page('GET', @uri, params: params)
145
-
146
- IncomingPhoneNumberPage.new(@version, response, @solution)
147
- end
148
-
149
- ##
150
- # Retrieve a single page of IncomingPhoneNumberInstance records from the API.
151
- # Request is executed immediately.
152
- # @param [String] target_url API-generated URL for the requested results page
153
- # @return [Page] Page of IncomingPhoneNumberInstance
154
- def get_page(target_url)
155
- response = @version.domain.request(
156
- 'GET',
157
- target_url
158
- )
159
- IncomingPhoneNumberPage.new(@version, response, @solution)
160
- end
161
-
162
- ##
163
- # Create the IncomingPhoneNumberInstance
164
- # @param [String] api_version The API version to use for incoming calls made to
165
- # the new phone number. The default is `2010-04-01`.
166
- # @param [String] friendly_name A descriptive string that you created to describe
167
- # the new phone number. It can be up to 64 characters long. By default, this is a
168
- # formatted version of the new phone number.
169
- # @param [String] sms_application_sid The SID of the application that should
170
- # handle SMS messages sent to the new phone number. If an `sms_application_sid` is
171
- # present, we ignore all of the `sms_*_url` urls and use those set on the
172
- # application.
173
- # @param [String] sms_fallback_method The HTTP method that we should use to call
174
- # `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
175
- # @param [String] sms_fallback_url The URL that we should call when an error
176
- # occurs while requesting or executing the TwiML defined by `sms_url`.
177
- # @param [String] sms_method The HTTP method that we should use to call `sms_url`.
178
- # Can be: `GET` or `POST` and defaults to `POST`.
179
- # @param [String] sms_url The URL we should call when the new phone number
180
- # receives an incoming SMS message.
181
- # @param [String] status_callback The URL we should call using the
182
- # `status_callback_method` to send status information to your application.
183
- # @param [String] status_callback_method The HTTP method we should use to call
184
- # `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
185
- # @param [String] voice_application_sid The SID of the application we should use
186
- # to handle calls to the new phone number. If a `voice_application_sid` is
187
- # present, we ignore all of the voice urls and use only those set on the
188
- # application. Setting a `voice_application_sid` will automatically delete your
189
- # `trunk_sid` and vice versa.
190
- # @param [Boolean] voice_caller_id_lookup Whether to lookup the caller's name from
191
- # the CNAM database and post it to your app. Can be: `true` or `false` and
192
- # defaults to `false`.
193
- # @param [String] voice_fallback_method The HTTP method that we should use to call
194
- # `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
195
- # @param [String] voice_fallback_url The URL that we should call when an error
196
- # occurs retrieving or executing the TwiML requested by `url`.
197
- # @param [String] voice_method The HTTP method that we should use to call
198
- # `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
199
- # @param [String] voice_url The URL that we should call to answer a call to the
200
- # new phone number. The `voice_url` will not be called if a
201
- # `voice_application_sid` or a `trunk_sid` is set.
202
- # @param [incoming_phone_number.EmergencyStatus] emergency_status The parameter
203
- # displays if emergency calling is enabled for this number. Active numbers may
204
- # place emergency calls by dialing valid emergency numbers for the country.
205
- # @param [String] emergency_address_sid The SID of the emergency address
206
- # configuration to use for emergency calling from the new phone number.
207
- # @param [String] trunk_sid The SID of the Trunk we should use to handle calls to
208
- # the new phone number. If a `trunk_sid` is present, we ignore all of the voice
209
- # urls and voice applications and use only those set on the Trunk. Setting a
210
- # `trunk_sid` will automatically delete your `voice_application_sid` and vice
211
- # versa.
212
- # @param [String] identity_sid The SID of the Identity resource that we should
213
- # associate with the new phone number. Some regions require an identity to meet
214
- # local regulations.
215
- # @param [String] address_sid The SID of the Address resource we should associate
216
- # with the new phone number. Some regions require addresses to meet local
217
- # regulations.
218
- # @param [incoming_phone_number.VoiceReceiveMode] voice_receive_mode The
219
- # configuration parameter for the new phone number to receive incoming voice calls
220
- # or faxes. Can be: `fax` or `voice` and defaults to `voice`.
221
- # @param [String] bundle_sid The SID of the Bundle resource that you associate
222
- # with the phone number. Some regions require a Bundle to meet local Regulations.
223
- # @param [String] phone_number The phone number to purchase specified in
224
- # {E.164}[https://www.twilio.com/docs/glossary/what-e164] format. E.164 phone
225
- # numbers consist of a + followed by the country code and subscriber number
226
- # without punctuation characters. For example, +14155551234.
227
- # @param [String] area_code The desired area code for your new incoming phone
228
- # number. Can be any three-digit, US or Canada area code. We will provision an
229
- # available phone number within this area code for you. **You must provide an
230
- # `area_code` or a `phone_number`.** (US and Canada only).
231
- # @return [IncomingPhoneNumberInstance] Created IncomingPhoneNumberInstance
232
- def create(api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, identity_sid: :unset, address_sid: :unset, voice_receive_mode: :unset, bundle_sid: :unset, phone_number: :unset, area_code: :unset)
233
- data = Twilio::Values.of({
234
- 'PhoneNumber' => phone_number,
235
- 'AreaCode' => area_code,
236
- 'ApiVersion' => api_version,
237
- 'FriendlyName' => friendly_name,
238
- 'SmsApplicationSid' => sms_application_sid,
239
- 'SmsFallbackMethod' => sms_fallback_method,
240
- 'SmsFallbackUrl' => sms_fallback_url,
241
- 'SmsMethod' => sms_method,
242
- 'SmsUrl' => sms_url,
243
- 'StatusCallback' => status_callback,
244
- 'StatusCallbackMethod' => status_callback_method,
245
- 'VoiceApplicationSid' => voice_application_sid,
246
- 'VoiceCallerIdLookup' => voice_caller_id_lookup,
247
- 'VoiceFallbackMethod' => voice_fallback_method,
248
- 'VoiceFallbackUrl' => voice_fallback_url,
249
- 'VoiceMethod' => voice_method,
250
- 'VoiceUrl' => voice_url,
251
- 'EmergencyStatus' => emergency_status,
252
- 'EmergencyAddressSid' => emergency_address_sid,
253
- 'TrunkSid' => trunk_sid,
254
- 'IdentitySid' => identity_sid,
255
- 'AddressSid' => address_sid,
256
- 'VoiceReceiveMode' => voice_receive_mode,
257
- 'BundleSid' => bundle_sid,
258
- })
259
-
260
- payload = @version.create('POST', @uri, data: data)
261
-
262
- IncomingPhoneNumberInstance.new(@version, payload, account_sid: @solution[:account_sid], )
263
- end
264
-
265
- ##
266
- # Access the local
267
- # @return [LocalList]
268
- # @return [LocalContext]
269
- def local
270
- @local ||= LocalList.new(@version, account_sid: @solution[:account_sid], )
271
- end
272
-
273
- ##
274
- # Access the mobile
275
- # @return [MobileList]
276
- # @return [MobileContext]
277
- def mobile
278
- @mobile ||= MobileList.new(@version, account_sid: @solution[:account_sid], )
279
- end
280
-
281
- ##
282
- # Access the toll_free
283
- # @return [TollFreeList]
284
- # @return [TollFreeContext]
285
- def toll_free
286
- @toll_free ||= TollFreeList.new(@version, account_sid: @solution[:account_sid], )
287
- end
288
-
289
- ##
290
- # Provide a user friendly representation
291
- def to_s
292
- '#<Twilio.Api.V2010.IncomingPhoneNumberList>'
293
- end
294
- end
295
-
296
- class IncomingPhoneNumberPage < Page
297
- ##
298
- # Initialize the IncomingPhoneNumberPage
299
- # @param [Version] version Version that contains the resource
300
- # @param [Response] response Response from the API
301
- # @param [Hash] solution Path solution for the resource
302
- # @return [IncomingPhoneNumberPage] IncomingPhoneNumberPage
303
- def initialize(version, response, solution)
304
- super(version, response)
305
-
306
- # Path Solution
307
- @solution = solution
308
- end
309
-
310
- ##
311
- # Build an instance of IncomingPhoneNumberInstance
312
- # @param [Hash] payload Payload response from the API
313
- # @return [IncomingPhoneNumberInstance] IncomingPhoneNumberInstance
314
- def get_instance(payload)
315
- IncomingPhoneNumberInstance.new(@version, payload, account_sid: @solution[:account_sid], )
316
- end
317
-
318
- ##
319
- # Provide a user friendly representation
320
- def to_s
321
- '<Twilio.Api.V2010.IncomingPhoneNumberPage>'
322
- end
323
- end
324
-
325
- class IncomingPhoneNumberContext < InstanceContext
326
- ##
327
- # Initialize the IncomingPhoneNumberContext
328
- # @param [Version] version Version that contains the resource
329
- # @param [String] account_sid The SID of the
330
- # {Account}[https://www.twilio.com/docs/iam/api/account] that created the
331
- # IncomingPhoneNumber resource to fetch.
332
- # @param [String] sid The Twilio-provided string that uniquely identifies the
333
- # IncomingPhoneNumber resource to fetch.
334
- # @return [IncomingPhoneNumberContext] IncomingPhoneNumberContext
335
- def initialize(version, account_sid, sid)
336
- super(version)
337
-
338
- # Path Solution
339
- @solution = {account_sid: account_sid, sid: sid, }
340
- @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:sid]}.json"
341
-
342
- # Dependents
343
- @assigned_add_ons = nil
344
- end
345
-
346
- ##
347
- # Update the IncomingPhoneNumberInstance
348
- # @param [String] account_sid The SID of the
349
- # {Account}[https://www.twilio.com/docs/iam/api/account] that created the
350
- # IncomingPhoneNumber resource to update. For more information, see {Exchanging
351
- # Numbers Between
352
- # Subaccounts}[https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers].
353
- # @param [String] api_version The API version to use for incoming calls made to
354
- # the phone number. The default is `2010-04-01`.
355
- # @param [String] friendly_name A descriptive string that you created to describe
356
- # this phone number. It can be up to 64 characters long. By default, this is a
357
- # formatted version of the phone number.
358
- # @param [String] sms_application_sid The SID of the application that should
359
- # handle SMS messages sent to the number. If an `sms_application_sid` is present,
360
- # we ignore all of the `sms_*_url` urls and use those set on the application.
361
- # @param [String] sms_fallback_method The HTTP method that we should use to call
362
- # `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
363
- # @param [String] sms_fallback_url The URL that we should call when an error
364
- # occurs while requesting or executing the TwiML defined by `sms_url`.
365
- # @param [String] sms_method The HTTP method that we should use to call `sms_url`.
366
- # Can be: `GET` or `POST` and defaults to `POST`.
367
- # @param [String] sms_url The URL we should call when the phone number receives an
368
- # incoming SMS message.
369
- # @param [String] status_callback The URL we should call using the
370
- # `status_callback_method` to send status information to your application.
371
- # @param [String] status_callback_method The HTTP method we should use to call
372
- # `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
373
- # @param [String] voice_application_sid The SID of the application we should use
374
- # to handle phone calls to the phone number. If a `voice_application_sid` is
375
- # present, we ignore all of the voice urls and use only those set on the
376
- # application. Setting a `voice_application_sid` will automatically delete your
377
- # `trunk_sid` and vice versa.
378
- # @param [Boolean] voice_caller_id_lookup Whether to lookup the caller's name from
379
- # the CNAM database and post it to your app. Can be: `true` or `false` and
380
- # defaults to `false`.
381
- # @param [String] voice_fallback_method The HTTP method that we should use to call
382
- # `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
383
- # @param [String] voice_fallback_url The URL that we should call when an error
384
- # occurs retrieving or executing the TwiML requested by `url`.
385
- # @param [String] voice_method The HTTP method that we should use to call
386
- # `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
387
- # @param [String] voice_url The URL that we should call to answer a call to the
388
- # phone number. The `voice_url` will not be called if a `voice_application_sid` or
389
- # a `trunk_sid` is set.
390
- # @param [incoming_phone_number.EmergencyStatus] emergency_status The parameter
391
- # displays if emergency calling is enabled for this number. Active numbers may
392
- # place emergency calls by dialing valid emergency numbers for the country.
393
- # @param [String] emergency_address_sid The SID of the emergency address
394
- # configuration to use for emergency calling from this phone number.
395
- # @param [String] trunk_sid The SID of the Trunk we should use to handle phone
396
- # calls to the phone number. If a `trunk_sid` is present, we ignore all of the
397
- # voice urls and voice applications and use only those set on the Trunk. Setting a
398
- # `trunk_sid` will automatically delete your `voice_application_sid` and vice
399
- # versa.
400
- # @param [incoming_phone_number.VoiceReceiveMode] voice_receive_mode The
401
- # configuration parameter for the phone number to receive incoming voice calls or
402
- # faxes. Can be: `fax` or `voice` and defaults to `voice`.
403
- # @param [String] identity_sid The SID of the Identity resource that we should
404
- # associate with the phone number. Some regions require an identity to meet local
405
- # regulations.
406
- # @param [String] address_sid The SID of the Address resource we should associate
407
- # with the phone number. Some regions require addresses to meet local regulations.
408
- # @param [String] bundle_sid The SID of the Bundle resource that you associate
409
- # with the phone number. Some regions require a Bundle to meet local Regulations.
410
- # @return [IncomingPhoneNumberInstance] Updated IncomingPhoneNumberInstance
411
- def update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset)
412
- data = Twilio::Values.of({
413
- 'AccountSid' => account_sid,
414
- 'ApiVersion' => api_version,
415
- 'FriendlyName' => friendly_name,
416
- 'SmsApplicationSid' => sms_application_sid,
417
- 'SmsFallbackMethod' => sms_fallback_method,
418
- 'SmsFallbackUrl' => sms_fallback_url,
419
- 'SmsMethod' => sms_method,
420
- 'SmsUrl' => sms_url,
421
- 'StatusCallback' => status_callback,
422
- 'StatusCallbackMethod' => status_callback_method,
423
- 'VoiceApplicationSid' => voice_application_sid,
424
- 'VoiceCallerIdLookup' => voice_caller_id_lookup,
425
- 'VoiceFallbackMethod' => voice_fallback_method,
426
- 'VoiceFallbackUrl' => voice_fallback_url,
427
- 'VoiceMethod' => voice_method,
428
- 'VoiceUrl' => voice_url,
429
- 'EmergencyStatus' => emergency_status,
430
- 'EmergencyAddressSid' => emergency_address_sid,
431
- 'TrunkSid' => trunk_sid,
432
- 'VoiceReceiveMode' => voice_receive_mode,
433
- 'IdentitySid' => identity_sid,
434
- 'AddressSid' => address_sid,
435
- 'BundleSid' => bundle_sid,
436
- })
437
-
438
- payload = @version.update('POST', @uri, data: data)
439
-
440
- IncomingPhoneNumberInstance.new(
441
- @version,
442
- payload,
443
- account_sid: @solution[:account_sid],
444
- sid: @solution[:sid],
445
- )
446
- end
447
-
448
- ##
449
- # Fetch the IncomingPhoneNumberInstance
450
- # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
451
- def fetch
452
- payload = @version.fetch('GET', @uri)
453
-
454
- IncomingPhoneNumberInstance.new(
455
- @version,
456
- payload,
457
- account_sid: @solution[:account_sid],
458
- sid: @solution[:sid],
459
- )
460
- end
461
-
462
- ##
463
- # Delete the IncomingPhoneNumberInstance
464
- # @return [Boolean] true if delete succeeds, false otherwise
465
- def delete
466
- @version.delete('DELETE', @uri)
467
- end
468
-
469
- ##
470
- # Access the assigned_add_ons
471
- # @return [AssignedAddOnList]
472
- # @return [AssignedAddOnContext] if sid was passed.
473
- def assigned_add_ons(sid=:unset)
474
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
475
-
476
- if sid != :unset
477
- return AssignedAddOnContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
478
- end
479
-
480
- unless @assigned_add_ons
481
- @assigned_add_ons = AssignedAddOnList.new(
482
- @version,
483
- account_sid: @solution[:account_sid],
484
- resource_sid: @solution[:sid],
485
- )
486
- end
487
-
488
- @assigned_add_ons
489
- end
490
-
491
- ##
492
- # Provide a user friendly representation
493
- def to_s
494
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
495
- "#<Twilio.Api.V2010.IncomingPhoneNumberContext #{context}>"
496
- end
497
-
498
- ##
499
- # Provide a detailed, user friendly representation
500
- def inspect
501
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
502
- "#<Twilio.Api.V2010.IncomingPhoneNumberContext #{context}>"
503
- end
504
- end
505
-
506
- class IncomingPhoneNumberInstance < InstanceResource
507
- ##
508
- # Initialize the IncomingPhoneNumberInstance
509
- # @param [Version] version Version that contains the resource
510
- # @param [Hash] payload payload that contains response from Twilio
511
- # @param [String] account_sid The SID of the
512
- # {Account}[https://www.twilio.com/docs/iam/api/account] that created this
513
- # IncomingPhoneNumber resource.
514
- # @param [String] sid The Twilio-provided string that uniquely identifies the
515
- # IncomingPhoneNumber resource to fetch.
516
- # @return [IncomingPhoneNumberInstance] IncomingPhoneNumberInstance
517
- def initialize(version, payload, account_sid: nil, sid: nil)
518
- super(version)
519
-
520
- # Marshaled Properties
521
- @properties = {
522
- 'account_sid' => payload['account_sid'],
523
- 'address_sid' => payload['address_sid'],
524
- 'address_requirements' => payload['address_requirements'],
525
- 'api_version' => payload['api_version'],
526
- 'beta' => payload['beta'],
527
- 'capabilities' => payload['capabilities'],
528
- 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
529
- 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
530
- 'friendly_name' => payload['friendly_name'],
531
- 'identity_sid' => payload['identity_sid'],
532
- 'phone_number' => payload['phone_number'],
533
- 'origin' => payload['origin'],
534
- 'sid' => payload['sid'],
535
- 'sms_application_sid' => payload['sms_application_sid'],
536
- 'sms_fallback_method' => payload['sms_fallback_method'],
537
- 'sms_fallback_url' => payload['sms_fallback_url'],
538
- 'sms_method' => payload['sms_method'],
539
- 'sms_url' => payload['sms_url'],
540
- 'status_callback' => payload['status_callback'],
541
- 'status_callback_method' => payload['status_callback_method'],
542
- 'trunk_sid' => payload['trunk_sid'],
543
- 'uri' => payload['uri'],
544
- 'voice_receive_mode' => payload['voice_receive_mode'],
545
- 'voice_application_sid' => payload['voice_application_sid'],
546
- 'voice_caller_id_lookup' => payload['voice_caller_id_lookup'],
547
- 'voice_fallback_method' => payload['voice_fallback_method'],
548
- 'voice_fallback_url' => payload['voice_fallback_url'],
549
- 'voice_method' => payload['voice_method'],
550
- 'voice_url' => payload['voice_url'],
551
- 'emergency_status' => payload['emergency_status'],
552
- 'emergency_address_sid' => payload['emergency_address_sid'],
553
- 'emergency_address_status' => payload['emergency_address_status'],
554
- 'bundle_sid' => payload['bundle_sid'],
555
- 'status' => payload['status'],
556
- }
557
-
558
- # Context
559
- @instance_context = nil
560
- @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
561
- end
562
-
563
- ##
564
- # Generate an instance context for the instance, the context is capable of
565
- # performing various actions. All instance actions are proxied to the context
566
- # @return [IncomingPhoneNumberContext] IncomingPhoneNumberContext for this IncomingPhoneNumberInstance
567
- def context
568
- unless @instance_context
569
- @instance_context = IncomingPhoneNumberContext.new(@version, @params['account_sid'], @params['sid'], )
570
- end
571
- @instance_context
572
- end
573
-
574
- ##
575
- # @return [String] The SID of the Account that created the resource
576
- def account_sid
577
- @properties['account_sid']
578
- end
579
-
580
- ##
581
- # @return [String] The SID of the Address resource associated with the phone number
582
- def address_sid
583
- @properties['address_sid']
584
- end
585
-
586
- ##
587
- # @return [incoming_phone_number.AddressRequirement] Whether the phone number requires an Address registered with Twilio.
588
- def address_requirements
589
- @properties['address_requirements']
590
- end
591
-
592
- ##
593
- # @return [String] The API version used to start a new TwiML session
594
- def api_version
595
- @properties['api_version']
596
- end
597
-
598
- ##
599
- # @return [Boolean] Whether the phone number is new to the Twilio platform
600
- def beta
601
- @properties['beta']
602
- end
603
-
604
- ##
605
- # @return [String] Indicate if a phone can receive calls or messages
606
- def capabilities
607
- @properties['capabilities']
608
- end
609
-
610
- ##
611
- # @return [Time] The RFC 2822 date and time in GMT that the resource was created
612
- def date_created
613
- @properties['date_created']
614
- end
615
-
616
- ##
617
- # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
618
- def date_updated
619
- @properties['date_updated']
620
- end
621
-
622
- ##
623
- # @return [String] The string that you assigned to describe the resource
624
- def friendly_name
625
- @properties['friendly_name']
626
- end
627
-
628
- ##
629
- # @return [String] The SID of the Identity resource associated with number
630
- def identity_sid
631
- @properties['identity_sid']
632
- end
633
-
634
- ##
635
- # @return [String] The phone number in E.164 format
636
- def phone_number
637
- @properties['phone_number']
638
- end
639
-
640
- ##
641
- # @return [String] The phone number's origin. Can be twilio or hosted.
642
- def origin
643
- @properties['origin']
644
- end
645
-
646
- ##
647
- # @return [String] The unique string that identifies the resource
648
- def sid
649
- @properties['sid']
650
- end
651
-
652
- ##
653
- # @return [String] The SID of the application that handles SMS messages sent to the phone number
654
- def sms_application_sid
655
- @properties['sms_application_sid']
656
- end
657
-
658
- ##
659
- # @return [String] The HTTP method used with sms_fallback_url
660
- def sms_fallback_method
661
- @properties['sms_fallback_method']
662
- end
663
-
664
- ##
665
- # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML
666
- def sms_fallback_url
667
- @properties['sms_fallback_url']
668
- end
669
-
670
- ##
671
- # @return [String] The HTTP method to use with sms_url
672
- def sms_method
673
- @properties['sms_method']
674
- end
675
-
676
- ##
677
- # @return [String] The URL we call when the phone number receives an incoming SMS message
678
- def sms_url
679
- @properties['sms_url']
680
- end
681
-
682
- ##
683
- # @return [String] The URL to send status information to your application
684
- def status_callback
685
- @properties['status_callback']
686
- end
687
-
688
- ##
689
- # @return [String] The HTTP method we use to call status_callback
690
- def status_callback_method
691
- @properties['status_callback_method']
692
- end
693
-
694
- ##
695
- # @return [String] The SID of the Trunk that handles calls to the phone number
696
- def trunk_sid
697
- @properties['trunk_sid']
698
- end
699
-
700
- ##
701
- # @return [String] The URI of the resource, relative to `https://api.twilio.com`
702
- def uri
703
- @properties['uri']
704
- end
705
-
706
- ##
707
- # @return [incoming_phone_number.VoiceReceiveMode] The voice_receive_mode
708
- def voice_receive_mode
709
- @properties['voice_receive_mode']
710
- end
711
-
712
- ##
713
- # @return [String] The SID of the application that handles calls to the phone number
714
- def voice_application_sid
715
- @properties['voice_application_sid']
716
- end
717
-
718
- ##
719
- # @return [Boolean] Whether to lookup the caller's name
720
- def voice_caller_id_lookup
721
- @properties['voice_caller_id_lookup']
722
- end
723
-
724
- ##
725
- # @return [String] The HTTP method used with voice_fallback_url
726
- def voice_fallback_method
727
- @properties['voice_fallback_method']
728
- end
729
-
730
- ##
731
- # @return [String] The URL we call when an error occurs in TwiML
732
- def voice_fallback_url
733
- @properties['voice_fallback_url']
734
- end
735
-
736
- ##
737
- # @return [String] The HTTP method used with the voice_url
738
- def voice_method
739
- @properties['voice_method']
740
- end
741
-
742
- ##
743
- # @return [String] The URL we call when the phone number receives a call
744
- def voice_url
745
- @properties['voice_url']
746
- end
747
-
748
- ##
749
- # @return [incoming_phone_number.EmergencyStatus] Displays if emergency calling is enabled for this number.
750
- def emergency_status
751
- @properties['emergency_status']
752
- end
753
-
754
- ##
755
- # @return [String] The emergency address configuration to use for emergency calling
756
- def emergency_address_sid
757
- @properties['emergency_address_sid']
758
- end
759
-
760
- ##
761
- # @return [incoming_phone_number.EmergencyAddressStatus] State of the emergency address configuration for the phone number
762
- def emergency_address_status
763
- @properties['emergency_address_status']
764
- end
765
-
766
- ##
767
- # @return [String] The SID of the Bundle resource associated with number
768
- def bundle_sid
769
- @properties['bundle_sid']
770
- end
771
-
772
- ##
773
- # @return [String] The status
774
- def status
775
- @properties['status']
776
- end
777
-
778
- ##
779
- # Update the IncomingPhoneNumberInstance
780
- # @param [String] account_sid The SID of the
781
- # {Account}[https://www.twilio.com/docs/iam/api/account] that created the
782
- # IncomingPhoneNumber resource to update. For more information, see {Exchanging
783
- # Numbers Between
784
- # Subaccounts}[https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers].
785
- # @param [String] api_version The API version to use for incoming calls made to
786
- # the phone number. The default is `2010-04-01`.
787
- # @param [String] friendly_name A descriptive string that you created to describe
788
- # this phone number. It can be up to 64 characters long. By default, this is a
789
- # formatted version of the phone number.
790
- # @param [String] sms_application_sid The SID of the application that should
791
- # handle SMS messages sent to the number. If an `sms_application_sid` is present,
792
- # we ignore all of the `sms_*_url` urls and use those set on the application.
793
- # @param [String] sms_fallback_method The HTTP method that we should use to call
794
- # `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
795
- # @param [String] sms_fallback_url The URL that we should call when an error
796
- # occurs while requesting or executing the TwiML defined by `sms_url`.
797
- # @param [String] sms_method The HTTP method that we should use to call `sms_url`.
798
- # Can be: `GET` or `POST` and defaults to `POST`.
799
- # @param [String] sms_url The URL we should call when the phone number receives an
800
- # incoming SMS message.
801
- # @param [String] status_callback The URL we should call using the
802
- # `status_callback_method` to send status information to your application.
803
- # @param [String] status_callback_method The HTTP method we should use to call
804
- # `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
805
- # @param [String] voice_application_sid The SID of the application we should use
806
- # to handle phone calls to the phone number. If a `voice_application_sid` is
807
- # present, we ignore all of the voice urls and use only those set on the
808
- # application. Setting a `voice_application_sid` will automatically delete your
809
- # `trunk_sid` and vice versa.
810
- # @param [Boolean] voice_caller_id_lookup Whether to lookup the caller's name from
811
- # the CNAM database and post it to your app. Can be: `true` or `false` and
812
- # defaults to `false`.
813
- # @param [String] voice_fallback_method The HTTP method that we should use to call
814
- # `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
815
- # @param [String] voice_fallback_url The URL that we should call when an error
816
- # occurs retrieving or executing the TwiML requested by `url`.
817
- # @param [String] voice_method The HTTP method that we should use to call
818
- # `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
819
- # @param [String] voice_url The URL that we should call to answer a call to the
820
- # phone number. The `voice_url` will not be called if a `voice_application_sid` or
821
- # a `trunk_sid` is set.
822
- # @param [incoming_phone_number.EmergencyStatus] emergency_status The parameter
823
- # displays if emergency calling is enabled for this number. Active numbers may
824
- # place emergency calls by dialing valid emergency numbers for the country.
825
- # @param [String] emergency_address_sid The SID of the emergency address
826
- # configuration to use for emergency calling from this phone number.
827
- # @param [String] trunk_sid The SID of the Trunk we should use to handle phone
828
- # calls to the phone number. If a `trunk_sid` is present, we ignore all of the
829
- # voice urls and voice applications and use only those set on the Trunk. Setting a
830
- # `trunk_sid` will automatically delete your `voice_application_sid` and vice
831
- # versa.
832
- # @param [incoming_phone_number.VoiceReceiveMode] voice_receive_mode The
833
- # configuration parameter for the phone number to receive incoming voice calls or
834
- # faxes. Can be: `fax` or `voice` and defaults to `voice`.
835
- # @param [String] identity_sid The SID of the Identity resource that we should
836
- # associate with the phone number. Some regions require an identity to meet local
837
- # regulations.
838
- # @param [String] address_sid The SID of the Address resource we should associate
839
- # with the phone number. Some regions require addresses to meet local regulations.
840
- # @param [String] bundle_sid The SID of the Bundle resource that you associate
841
- # with the phone number. Some regions require a Bundle to meet local Regulations.
842
- # @return [IncomingPhoneNumberInstance] Updated IncomingPhoneNumberInstance
843
- def update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset)
844
- context.update(
845
- account_sid: account_sid,
846
- api_version: api_version,
847
- friendly_name: friendly_name,
848
- sms_application_sid: sms_application_sid,
849
- sms_fallback_method: sms_fallback_method,
850
- sms_fallback_url: sms_fallback_url,
851
- sms_method: sms_method,
852
- sms_url: sms_url,
853
- status_callback: status_callback,
854
- status_callback_method: status_callback_method,
855
- voice_application_sid: voice_application_sid,
856
- voice_caller_id_lookup: voice_caller_id_lookup,
857
- voice_fallback_method: voice_fallback_method,
858
- voice_fallback_url: voice_fallback_url,
859
- voice_method: voice_method,
860
- voice_url: voice_url,
861
- emergency_status: emergency_status,
862
- emergency_address_sid: emergency_address_sid,
863
- trunk_sid: trunk_sid,
864
- voice_receive_mode: voice_receive_mode,
865
- identity_sid: identity_sid,
866
- address_sid: address_sid,
867
- bundle_sid: bundle_sid,
868
- )
869
- end
870
-
871
- ##
872
- # Fetch the IncomingPhoneNumberInstance
873
- # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
874
- def fetch
875
- context.fetch
876
- end
877
-
878
- ##
879
- # Delete the IncomingPhoneNumberInstance
880
- # @return [Boolean] true if delete succeeds, false otherwise
881
- def delete
882
- context.delete
883
- end
884
-
885
- ##
886
- # Access the assigned_add_ons
887
- # @return [assigned_add_ons] assigned_add_ons
888
- def assigned_add_ons
889
- context.assigned_add_ons
890
- end
891
14
 
892
- ##
893
- # Provide a user friendly representation
894
- def to_s
895
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
896
- "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
897
- end
898
15
 
899
- ##
900
- # Provide a detailed, user friendly representation
901
- def inspect
902
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
903
- "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
16
+ module Twilio
17
+ module REST
18
+ class Api < ApiBase
19
+ class V2010 < Version
20
+ class AccountContext < InstanceContext
21
+
22
+ class IncomingPhoneNumberList < ListResource
23
+ ##
24
+ # Initialize the IncomingPhoneNumberList
25
+ # @param [Version] version Version that contains the resource
26
+ # @return [IncomingPhoneNumberList] IncomingPhoneNumberList
27
+ def initialize(version, account_sid: nil)
28
+ super(version)
29
+ # Path Solution
30
+ @solution = { account_sid: account_sid }
31
+ @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers.json"
32
+ # Components
33
+ @toll_free = nil
34
+ @local = nil
35
+ @mobile = nil
36
+ end
37
+ ##
38
+ # Create the IncomingPhoneNumberInstance
39
+ # @param [String] api_version The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.
40
+ # @param [String] friendly_name A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.
41
+ # @param [String] sms_application_sid The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.
42
+ # @param [String] sms_fallback_method The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
43
+ # @param [String] sms_fallback_url The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
44
+ # @param [String] sms_method The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
45
+ # @param [String] sms_url The URL we should call when the new phone number receives an incoming SMS message.
46
+ # @param [String] status_callback The URL we should call using the `status_callback_method` to send status information to your application.
47
+ # @param [String] status_callback_method The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
48
+ # @param [String] voice_application_sid The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
49
+ # @param [Boolean] voice_caller_id_lookup Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
50
+ # @param [String] voice_fallback_method The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
51
+ # @param [String] voice_fallback_url The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
52
+ # @param [String] voice_method The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
53
+ # @param [String] voice_url The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
54
+ # @param [EmergencyStatus] emergency_status
55
+ # @param [String] emergency_address_sid The SID of the emergency address configuration to use for emergency calling from the new phone number.
56
+ # @param [String] trunk_sid The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
57
+ # @param [String] identity_sid The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
58
+ # @param [String] address_sid The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
59
+ # @param [VoiceReceiveMode] voice_receive_mode
60
+ # @param [String] bundle_sid The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
61
+ # @param [String] phone_number The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
62
+ # @param [String] area_code The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only).
63
+ # @return [IncomingPhoneNumberInstance] Created IncomingPhoneNumberInstance
64
+ def create(
65
+ api_version: :unset,
66
+ friendly_name: :unset,
67
+ sms_application_sid: :unset,
68
+ sms_fallback_method: :unset,
69
+ sms_fallback_url: :unset,
70
+ sms_method: :unset,
71
+ sms_url: :unset,
72
+ status_callback: :unset,
73
+ status_callback_method: :unset,
74
+ voice_application_sid: :unset,
75
+ voice_caller_id_lookup: :unset,
76
+ voice_fallback_method: :unset,
77
+ voice_fallback_url: :unset,
78
+ voice_method: :unset,
79
+ voice_url: :unset,
80
+ emergency_status: :unset,
81
+ emergency_address_sid: :unset,
82
+ trunk_sid: :unset,
83
+ identity_sid: :unset,
84
+ address_sid: :unset,
85
+ voice_receive_mode: :unset,
86
+ bundle_sid: :unset,
87
+ phone_number: :unset,
88
+ area_code: :unset
89
+ )
90
+
91
+ data = Twilio::Values.of({
92
+ 'ApiVersion' => api_version,
93
+ 'FriendlyName' => friendly_name,
94
+ 'SmsApplicationSid' => sms_application_sid,
95
+ 'SmsFallbackMethod' => sms_fallback_method,
96
+ 'SmsFallbackUrl' => sms_fallback_url,
97
+ 'SmsMethod' => sms_method,
98
+ 'SmsUrl' => sms_url,
99
+ 'StatusCallback' => status_callback,
100
+ 'StatusCallbackMethod' => status_callback_method,
101
+ 'VoiceApplicationSid' => voice_application_sid,
102
+ 'VoiceCallerIdLookup' => voice_caller_id_lookup,
103
+ 'VoiceFallbackMethod' => voice_fallback_method,
104
+ 'VoiceFallbackUrl' => voice_fallback_url,
105
+ 'VoiceMethod' => voice_method,
106
+ 'VoiceUrl' => voice_url,
107
+ 'EmergencyStatus' => emergency_status,
108
+ 'EmergencyAddressSid' => emergency_address_sid,
109
+ 'TrunkSid' => trunk_sid,
110
+ 'IdentitySid' => identity_sid,
111
+ 'AddressSid' => address_sid,
112
+ 'VoiceReceiveMode' => voice_receive_mode,
113
+ 'BundleSid' => bundle_sid,
114
+ 'PhoneNumber' => phone_number,
115
+ 'AreaCode' => area_code,
116
+ })
117
+
118
+ payload = @version.create('POST', @uri, data: data)
119
+ IncomingPhoneNumberInstance.new(
120
+ @version,
121
+ payload,
122
+ account_sid: @solution[:account_sid],
123
+ )
124
+ end
125
+
126
+
127
+ ##
128
+ # Lists IncomingPhoneNumberInstance records from the API as a list.
129
+ # Unlike stream(), this operation is eager and will load `limit` records into
130
+ # memory before returning.
131
+ # @param [Boolean] beta Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
132
+ # @param [String] friendly_name A string that identifies the IncomingPhoneNumber resources to read.
133
+ # @param [String] phone_number The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
134
+ # @param [String] origin Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
135
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
136
+ # guarantees to never return more than limit. Default is no limit
137
+ # @param [Integer] page_size Number of records to fetch per request, when
138
+ # not set will use the default value of 50 records. If no page_size is defined
139
+ # but a limit is defined, stream() will attempt to read the limit with the most
140
+ # efficient page size, i.e. min(limit, 1000)
141
+ # @return [Array] Array of up to limit results
142
+ def list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
143
+ self.stream(
144
+ beta: beta,
145
+ friendly_name: friendly_name,
146
+ phone_number: phone_number,
147
+ origin: origin,
148
+ limit: limit,
149
+ page_size: page_size
150
+ ).entries
151
+ end
152
+
153
+ ##
154
+ # Streams Instance records from the API as an Enumerable.
155
+ # This operation lazily loads records as efficiently as possible until the limit
156
+ # is reached.
157
+ # @param [Boolean] beta Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
158
+ # @param [String] friendly_name A string that identifies the IncomingPhoneNumber resources to read.
159
+ # @param [String] phone_number The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
160
+ # @param [String] origin Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
161
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
162
+ # guarantees to never return more than limit. Default is no limit
163
+ # @param [Integer] page_size Number of records to fetch per request, when
164
+ # not set will use the default value of 50 records. If no page_size is defined
165
+ # but a limit is defined, stream() will attempt to read the limit with the most
166
+ # efficient page size, i.e. min(limit, 1000)
167
+ # @return [Enumerable] Enumerable that will yield up to limit results
168
+ def stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
169
+ limits = @version.read_limits(limit, page_size)
170
+
171
+ page = self.page(
172
+ beta: beta,
173
+ friendly_name: friendly_name,
174
+ phone_number: phone_number,
175
+ origin: origin,
176
+ page_size: limits[:page_size], )
177
+
178
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
179
+ end
180
+
181
+ ##
182
+ # When passed a block, yields IncomingPhoneNumberInstance records from the API.
183
+ # This operation lazily loads records as efficiently as possible until the limit
184
+ # is reached.
185
+ def each
186
+ limits = @version.read_limits
187
+
188
+ page = self.page(page_size: limits[:page_size], )
189
+
190
+ @version.stream(page,
191
+ limit: limits[:limit],
192
+ page_limit: limits[:page_limit]).each {|x| yield x}
193
+ end
194
+
195
+ ##
196
+ # Retrieve a single page of IncomingPhoneNumberInstance records from the API.
197
+ # Request is executed immediately.
198
+ # @param [Boolean] beta Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
199
+ # @param [String] friendly_name A string that identifies the IncomingPhoneNumber resources to read.
200
+ # @param [String] phone_number The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
201
+ # @param [String] origin Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
202
+ # @param [String] page_token PageToken provided by the API
203
+ # @param [Integer] page_number Page Number, this value is simply for client state
204
+ # @param [Integer] page_size Number of records to return, defaults to 50
205
+ # @return [Page] Page of IncomingPhoneNumberInstance
206
+ def page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
207
+ params = Twilio::Values.of({
208
+
209
+ 'Beta' => beta,
210
+
211
+ 'FriendlyName' => friendly_name,
212
+
213
+ 'PhoneNumber' => phone_number,
214
+
215
+ 'Origin' => origin,
216
+
217
+ 'PageToken' => page_token,
218
+ 'Page' => page_number,
219
+ 'PageSize' => page_size,
220
+ })
221
+
222
+ response = @version.page('GET', @uri, params: params)
223
+
224
+ IncomingPhoneNumberPage.new(@version, response, @solution)
225
+ end
226
+
227
+ ##
228
+ # Retrieve a single page of IncomingPhoneNumberInstance records from the API.
229
+ # Request is executed immediately.
230
+ # @param [String] target_url API-generated URL for the requested results page
231
+ # @return [Page] Page of IncomingPhoneNumberInstance
232
+ def get_page(target_url)
233
+ response = @version.domain.request(
234
+ 'GET',
235
+ target_url
236
+ )
237
+ IncomingPhoneNumberPage.new(@version, response, @solution)
238
+ end
239
+
240
+
241
+ ##
242
+ # Access the toll_free
243
+ # @return [TollFreeList]
244
+ # @return [TollFreeContext]
245
+ def toll_free
246
+ @toll_free ||= TollFreeList.new(@version, account_sid: @solution[:account_sid] )
247
+ end
248
+ ##
249
+ # Access the local
250
+ # @return [LocalList]
251
+ # @return [LocalContext]
252
+ def local
253
+ @local ||= LocalList.new(@version, account_sid: @solution[:account_sid] )
254
+ end
255
+ ##
256
+ # Access the mobile
257
+ # @return [MobileList]
258
+ # @return [MobileContext]
259
+ def mobile
260
+ @mobile ||= MobileList.new(@version, account_sid: @solution[:account_sid] )
261
+ end
262
+
263
+ # Provide a user friendly representation
264
+ def to_s
265
+ '#<Twilio.Api.V2010.IncomingPhoneNumberList>'
266
+ end
267
+ end
268
+
269
+
270
+ class IncomingPhoneNumberContext < InstanceContext
271
+ ##
272
+ # Initialize the IncomingPhoneNumberContext
273
+ # @param [Version] version Version that contains the resource
274
+ # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).
275
+ # @param [String] sid The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to update.
276
+ # @return [IncomingPhoneNumberContext] IncomingPhoneNumberContext
277
+ def initialize(version, account_sid, sid)
278
+ super(version)
279
+
280
+ # Path Solution
281
+ @solution = { account_sid: account_sid, sid: sid, }
282
+ @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:sid]}.json"
283
+
284
+ # Dependents
285
+ @assigned_add_ons = nil
286
+ end
287
+ ##
288
+ # Delete the IncomingPhoneNumberInstance
289
+ # @return [Boolean] True if delete succeeds, false otherwise
290
+ def delete
291
+
292
+ @version.delete('DELETE', @uri)
293
+ end
294
+
295
+ ##
296
+ # Fetch the IncomingPhoneNumberInstance
297
+ # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
298
+ def fetch
299
+
300
+ payload = @version.fetch('GET', @uri)
301
+ IncomingPhoneNumberInstance.new(
302
+ @version,
303
+ payload,
304
+ account_sid: @solution[:account_sid],
305
+ sid: @solution[:sid],
306
+ )
307
+ end
308
+
309
+ ##
310
+ # Update the IncomingPhoneNumberInstance
311
+ # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).
312
+ # @param [String] api_version The API version to use for incoming calls made to the phone number. The default is `2010-04-01`.
313
+ # @param [String] friendly_name A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
314
+ # @param [String] sms_application_sid The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.
315
+ # @param [String] sms_fallback_method The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
316
+ # @param [String] sms_fallback_url The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
317
+ # @param [String] sms_method The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
318
+ # @param [String] sms_url The URL we should call when the phone number receives an incoming SMS message.
319
+ # @param [String] status_callback The URL we should call using the `status_callback_method` to send status information to your application.
320
+ # @param [String] status_callback_method The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
321
+ # @param [String] voice_application_sid The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
322
+ # @param [Boolean] voice_caller_id_lookup Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
323
+ # @param [String] voice_fallback_method The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
324
+ # @param [String] voice_fallback_url The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
325
+ # @param [String] voice_method The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
326
+ # @param [String] voice_url The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
327
+ # @param [EmergencyStatus] emergency_status
328
+ # @param [String] emergency_address_sid The SID of the emergency address configuration to use for emergency calling from this phone number.
329
+ # @param [String] trunk_sid The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
330
+ # @param [VoiceReceiveMode] voice_receive_mode
331
+ # @param [String] identity_sid The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.
332
+ # @param [String] address_sid The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.
333
+ # @param [String] bundle_sid The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
334
+ # @return [IncomingPhoneNumberInstance] Updated IncomingPhoneNumberInstance
335
+ def update(
336
+ account_sid: :unset,
337
+ api_version: :unset,
338
+ friendly_name: :unset,
339
+ sms_application_sid: :unset,
340
+ sms_fallback_method: :unset,
341
+ sms_fallback_url: :unset,
342
+ sms_method: :unset,
343
+ sms_url: :unset,
344
+ status_callback: :unset,
345
+ status_callback_method: :unset,
346
+ voice_application_sid: :unset,
347
+ voice_caller_id_lookup: :unset,
348
+ voice_fallback_method: :unset,
349
+ voice_fallback_url: :unset,
350
+ voice_method: :unset,
351
+ voice_url: :unset,
352
+ emergency_status: :unset,
353
+ emergency_address_sid: :unset,
354
+ trunk_sid: :unset,
355
+ voice_receive_mode: :unset,
356
+ identity_sid: :unset,
357
+ address_sid: :unset,
358
+ bundle_sid: :unset
359
+ )
360
+
361
+ data = Twilio::Values.of({
362
+ 'AccountSid' => account_sid,
363
+ 'ApiVersion' => api_version,
364
+ 'FriendlyName' => friendly_name,
365
+ 'SmsApplicationSid' => sms_application_sid,
366
+ 'SmsFallbackMethod' => sms_fallback_method,
367
+ 'SmsFallbackUrl' => sms_fallback_url,
368
+ 'SmsMethod' => sms_method,
369
+ 'SmsUrl' => sms_url,
370
+ 'StatusCallback' => status_callback,
371
+ 'StatusCallbackMethod' => status_callback_method,
372
+ 'VoiceApplicationSid' => voice_application_sid,
373
+ 'VoiceCallerIdLookup' => voice_caller_id_lookup,
374
+ 'VoiceFallbackMethod' => voice_fallback_method,
375
+ 'VoiceFallbackUrl' => voice_fallback_url,
376
+ 'VoiceMethod' => voice_method,
377
+ 'VoiceUrl' => voice_url,
378
+ 'EmergencyStatus' => emergency_status,
379
+ 'EmergencyAddressSid' => emergency_address_sid,
380
+ 'TrunkSid' => trunk_sid,
381
+ 'VoiceReceiveMode' => voice_receive_mode,
382
+ 'IdentitySid' => identity_sid,
383
+ 'AddressSid' => address_sid,
384
+ 'BundleSid' => bundle_sid,
385
+ })
386
+
387
+ payload = @version.update('POST', @uri, data: data)
388
+ IncomingPhoneNumberInstance.new(
389
+ @version,
390
+ payload,
391
+ account_sid: @solution[:account_sid],
392
+ sid: @solution[:sid],
393
+ )
394
+ end
395
+
396
+ ##
397
+ # Access the assigned_add_ons
398
+ # @return [AssignedAddOnList]
399
+ # @return [AssignedAddOnContext] if sid was passed.
400
+ def assigned_add_ons(sid=:unset)
401
+
402
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
403
+
404
+ if sid != :unset
405
+ return AssignedAddOnContext.new(@version, @solution[:account_sid], @solution[:sid],sid )
406
+ end
407
+
408
+ unless @assigned_add_ons
409
+ @assigned_add_ons = AssignedAddOnList.new(
410
+ @version, account_sid: @solution[:account_sid], resource_sid: @solution[:sid], )
411
+ end
412
+
413
+ @assigned_add_ons
414
+ end
415
+
416
+ ##
417
+ # Provide a user friendly representation
418
+ def to_s
419
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
420
+ "#<Twilio.Api.V2010.IncomingPhoneNumberContext #{context}>"
421
+ end
422
+
423
+ ##
424
+ # Provide a detailed, user friendly representation
425
+ def inspect
426
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
427
+ "#<Twilio.Api.V2010.IncomingPhoneNumberContext #{context}>"
428
+ end
429
+ end
430
+
431
+ class IncomingPhoneNumberPage < Page
432
+ ##
433
+ # Initialize the IncomingPhoneNumberPage
434
+ # @param [Version] version Version that contains the resource
435
+ # @param [Response] response Response from the API
436
+ # @param [Hash] solution Path solution for the resource
437
+ # @return [IncomingPhoneNumberPage] IncomingPhoneNumberPage
438
+ def initialize(version, response, solution)
439
+ super(version, response)
440
+
441
+ # Path Solution
442
+ @solution = solution
443
+ end
444
+
445
+ ##
446
+ # Build an instance of IncomingPhoneNumberInstance
447
+ # @param [Hash] payload Payload response from the API
448
+ # @return [IncomingPhoneNumberInstance] IncomingPhoneNumberInstance
449
+ def get_instance(payload)
450
+ IncomingPhoneNumberInstance.new(@version, payload, account_sid: @solution[:account_sid])
451
+ end
452
+
453
+ ##
454
+ # Provide a user friendly representation
455
+ def to_s
456
+ '<Twilio.Api.V2010.IncomingPhoneNumberPage>'
457
+ end
458
+ end
459
+ class IncomingPhoneNumberInstance < InstanceResource
460
+ ##
461
+ # Initialize the IncomingPhoneNumberInstance
462
+ # @param [Version] version Version that contains the resource
463
+ # @param [Hash] payload payload that contains response from Twilio
464
+ # @param [String] account_sid The SID of the
465
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this IncomingPhoneNumber
466
+ # resource.
467
+ # @param [String] sid The SID of the Call resource to fetch.
468
+ # @return [IncomingPhoneNumberInstance] IncomingPhoneNumberInstance
469
+ def initialize(version, payload , account_sid: nil, sid: nil)
470
+ super(version)
471
+
472
+ # Marshaled Properties
473
+ @properties = {
474
+ 'account_sid' => payload['account_sid'],
475
+ 'address_sid' => payload['address_sid'],
476
+ 'address_requirements' => payload['address_requirements'],
477
+ 'api_version' => payload['api_version'],
478
+ 'beta' => payload['beta'],
479
+ 'capabilities' => payload['capabilities'],
480
+ 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
481
+ 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
482
+ 'friendly_name' => payload['friendly_name'],
483
+ 'identity_sid' => payload['identity_sid'],
484
+ 'phone_number' => payload['phone_number'],
485
+ 'origin' => payload['origin'],
486
+ 'sid' => payload['sid'],
487
+ 'sms_application_sid' => payload['sms_application_sid'],
488
+ 'sms_fallback_method' => payload['sms_fallback_method'],
489
+ 'sms_fallback_url' => payload['sms_fallback_url'],
490
+ 'sms_method' => payload['sms_method'],
491
+ 'sms_url' => payload['sms_url'],
492
+ 'status_callback' => payload['status_callback'],
493
+ 'status_callback_method' => payload['status_callback_method'],
494
+ 'trunk_sid' => payload['trunk_sid'],
495
+ 'uri' => payload['uri'],
496
+ 'voice_receive_mode' => payload['voice_receive_mode'],
497
+ 'voice_application_sid' => payload['voice_application_sid'],
498
+ 'voice_caller_id_lookup' => payload['voice_caller_id_lookup'],
499
+ 'voice_fallback_method' => payload['voice_fallback_method'],
500
+ 'voice_fallback_url' => payload['voice_fallback_url'],
501
+ 'voice_method' => payload['voice_method'],
502
+ 'voice_url' => payload['voice_url'],
503
+ 'emergency_status' => payload['emergency_status'],
504
+ 'emergency_address_sid' => payload['emergency_address_sid'],
505
+ 'emergency_address_status' => payload['emergency_address_status'],
506
+ 'bundle_sid' => payload['bundle_sid'],
507
+ 'status' => payload['status'],
508
+ }
509
+
510
+ # Context
511
+ @instance_context = nil
512
+ @params = { 'account_sid' => account_sid ,'sid' => sid || @properties['sid'] , }
513
+ end
514
+
515
+ ##
516
+ # Generate an instance context for the instance, the context is capable of
517
+ # performing various actions. All instance actions are proxied to the context
518
+ # @return [IncomingPhoneNumberContext] CallContext for this CallInstance
519
+ def context
520
+ unless @instance_context
521
+ @instance_context = IncomingPhoneNumberContext.new(@version , @params['account_sid'], @params['sid'])
522
+ end
523
+ @instance_context
524
+ end
525
+
526
+ ##
527
+ # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this IncomingPhoneNumber resource.
528
+ def account_sid
529
+ @properties['account_sid']
530
+ end
531
+
532
+ ##
533
+ # @return [String] The SID of the Address resource associated with the phone number.
534
+ def address_sid
535
+ @properties['address_sid']
536
+ end
537
+
538
+ ##
539
+ # @return [AddressRequirement]
540
+ def address_requirements
541
+ @properties['address_requirements']
542
+ end
543
+
544
+ ##
545
+ # @return [String] The API version used to start a new TwiML session.
546
+ def api_version
547
+ @properties['api_version']
548
+ end
549
+
550
+ ##
551
+ # @return [Boolean] Whether the phone number is new to the Twilio platform. Can be: `true` or `false`.
552
+ def beta
553
+ @properties['beta']
554
+ end
555
+
556
+ ##
557
+ # @return [ApiV2010AccountIncomingPhoneNumberCapabilities]
558
+ def capabilities
559
+ @properties['capabilities']
560
+ end
561
+
562
+ ##
563
+ # @return [Time] The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
564
+ def date_created
565
+ @properties['date_created']
566
+ end
567
+
568
+ ##
569
+ # @return [Time] The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
570
+ def date_updated
571
+ @properties['date_updated']
572
+ end
573
+
574
+ ##
575
+ # @return [String] The string that you assigned to describe the resource.
576
+ def friendly_name
577
+ @properties['friendly_name']
578
+ end
579
+
580
+ ##
581
+ # @return [String] The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.
582
+ def identity_sid
583
+ @properties['identity_sid']
584
+ end
585
+
586
+ ##
587
+ # @return [String] The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
588
+ def phone_number
589
+ @properties['phone_number']
590
+ end
591
+
592
+ ##
593
+ # @return [String] The phone number's origin. `twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers.
594
+ def origin
595
+ @properties['origin']
596
+ end
597
+
598
+ ##
599
+ # @return [String] The unique string that that we created to identify this IncomingPhoneNumber resource.
600
+ def sid
601
+ @properties['sid']
602
+ end
603
+
604
+ ##
605
+ # @return [String] The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.
606
+ def sms_application_sid
607
+ @properties['sms_application_sid']
608
+ end
609
+
610
+ ##
611
+ # @return [String] The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`.
612
+ def sms_fallback_method
613
+ @properties['sms_fallback_method']
614
+ end
615
+
616
+ ##
617
+ # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`.
618
+ def sms_fallback_url
619
+ @properties['sms_fallback_url']
620
+ end
621
+
622
+ ##
623
+ # @return [String] The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`.
624
+ def sms_method
625
+ @properties['sms_method']
626
+ end
627
+
628
+ ##
629
+ # @return [String] The URL we call when the phone number receives an incoming SMS message.
630
+ def sms_url
631
+ @properties['sms_url']
632
+ end
633
+
634
+ ##
635
+ # @return [String] The URL we call using the `status_callback_method` to send status information to your application.
636
+ def status_callback
637
+ @properties['status_callback']
638
+ end
639
+
640
+ ##
641
+ # @return [String] The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`.
642
+ def status_callback_method
643
+ @properties['status_callback_method']
644
+ end
645
+
646
+ ##
647
+ # @return [String] The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
648
+ def trunk_sid
649
+ @properties['trunk_sid']
650
+ end
651
+
652
+ ##
653
+ # @return [String] The URI of the resource, relative to `https://api.twilio.com`.
654
+ def uri
655
+ @properties['uri']
656
+ end
657
+
658
+ ##
659
+ # @return [VoiceReceiveMode]
660
+ def voice_receive_mode
661
+ @properties['voice_receive_mode']
662
+ end
663
+
664
+ ##
665
+ # @return [String] The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
666
+ def voice_application_sid
667
+ @properties['voice_application_sid']
668
+ end
669
+
670
+ ##
671
+ # @return [Boolean] Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`.
672
+ def voice_caller_id_lookup
673
+ @properties['voice_caller_id_lookup']
674
+ end
675
+
676
+ ##
677
+ # @return [String] The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
678
+ def voice_fallback_method
679
+ @properties['voice_fallback_method']
680
+ end
681
+
682
+ ##
683
+ # @return [String] The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`.
684
+ def voice_fallback_url
685
+ @properties['voice_fallback_url']
686
+ end
687
+
688
+ ##
689
+ # @return [String] The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
690
+ def voice_method
691
+ @properties['voice_method']
692
+ end
693
+
694
+ ##
695
+ # @return [String] The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set.
696
+ def voice_url
697
+ @properties['voice_url']
698
+ end
699
+
700
+ ##
701
+ # @return [EmergencyStatus]
702
+ def emergency_status
703
+ @properties['emergency_status']
704
+ end
705
+
706
+ ##
707
+ # @return [String] The SID of the emergency address configuration that we use for emergency calling from this phone number.
708
+ def emergency_address_sid
709
+ @properties['emergency_address_sid']
710
+ end
711
+
712
+ ##
713
+ # @return [EmergencyAddressStatus]
714
+ def emergency_address_status
715
+ @properties['emergency_address_status']
716
+ end
717
+
718
+ ##
719
+ # @return [String] The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
720
+ def bundle_sid
721
+ @properties['bundle_sid']
722
+ end
723
+
724
+ ##
725
+ # @return [String]
726
+ def status
727
+ @properties['status']
728
+ end
729
+
730
+ ##
731
+ # Delete the IncomingPhoneNumberInstance
732
+ # @return [Boolean] True if delete succeeds, false otherwise
733
+ def delete
734
+
735
+ context.delete
736
+ end
737
+
738
+ ##
739
+ # Fetch the IncomingPhoneNumberInstance
740
+ # @return [IncomingPhoneNumberInstance] Fetched IncomingPhoneNumberInstance
741
+ def fetch
742
+
743
+ context.fetch
744
+ end
745
+
746
+ ##
747
+ # Update the IncomingPhoneNumberInstance
748
+ # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).
749
+ # @param [String] api_version The API version to use for incoming calls made to the phone number. The default is `2010-04-01`.
750
+ # @param [String] friendly_name A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
751
+ # @param [String] sms_application_sid The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.
752
+ # @param [String] sms_fallback_method The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
753
+ # @param [String] sms_fallback_url The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
754
+ # @param [String] sms_method The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
755
+ # @param [String] sms_url The URL we should call when the phone number receives an incoming SMS message.
756
+ # @param [String] status_callback The URL we should call using the `status_callback_method` to send status information to your application.
757
+ # @param [String] status_callback_method The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
758
+ # @param [String] voice_application_sid The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
759
+ # @param [Boolean] voice_caller_id_lookup Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
760
+ # @param [String] voice_fallback_method The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
761
+ # @param [String] voice_fallback_url The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
762
+ # @param [String] voice_method The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
763
+ # @param [String] voice_url The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
764
+ # @param [EmergencyStatus] emergency_status
765
+ # @param [String] emergency_address_sid The SID of the emergency address configuration to use for emergency calling from this phone number.
766
+ # @param [String] trunk_sid The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
767
+ # @param [VoiceReceiveMode] voice_receive_mode
768
+ # @param [String] identity_sid The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.
769
+ # @param [String] address_sid The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.
770
+ # @param [String] bundle_sid The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
771
+ # @return [IncomingPhoneNumberInstance] Updated IncomingPhoneNumberInstance
772
+ def update(
773
+ account_sid: :unset,
774
+ api_version: :unset,
775
+ friendly_name: :unset,
776
+ sms_application_sid: :unset,
777
+ sms_fallback_method: :unset,
778
+ sms_fallback_url: :unset,
779
+ sms_method: :unset,
780
+ sms_url: :unset,
781
+ status_callback: :unset,
782
+ status_callback_method: :unset,
783
+ voice_application_sid: :unset,
784
+ voice_caller_id_lookup: :unset,
785
+ voice_fallback_method: :unset,
786
+ voice_fallback_url: :unset,
787
+ voice_method: :unset,
788
+ voice_url: :unset,
789
+ emergency_status: :unset,
790
+ emergency_address_sid: :unset,
791
+ trunk_sid: :unset,
792
+ voice_receive_mode: :unset,
793
+ identity_sid: :unset,
794
+ address_sid: :unset,
795
+ bundle_sid: :unset
796
+ )
797
+
798
+ context.update(
799
+ account_sid: account_sid,
800
+ api_version: api_version,
801
+ friendly_name: friendly_name,
802
+ sms_application_sid: sms_application_sid,
803
+ sms_fallback_method: sms_fallback_method,
804
+ sms_fallback_url: sms_fallback_url,
805
+ sms_method: sms_method,
806
+ sms_url: sms_url,
807
+ status_callback: status_callback,
808
+ status_callback_method: status_callback_method,
809
+ voice_application_sid: voice_application_sid,
810
+ voice_caller_id_lookup: voice_caller_id_lookup,
811
+ voice_fallback_method: voice_fallback_method,
812
+ voice_fallback_url: voice_fallback_url,
813
+ voice_method: voice_method,
814
+ voice_url: voice_url,
815
+ emergency_status: emergency_status,
816
+ emergency_address_sid: emergency_address_sid,
817
+ trunk_sid: trunk_sid,
818
+ voice_receive_mode: voice_receive_mode,
819
+ identity_sid: identity_sid,
820
+ address_sid: address_sid,
821
+ bundle_sid: bundle_sid,
822
+ )
823
+ end
824
+
825
+ ##
826
+ # Access the assigned_add_ons
827
+ # @return [assigned_add_ons] assigned_add_ons
828
+ def assigned_add_ons
829
+ context.assigned_add_ons
830
+ end
831
+
832
+ ##
833
+ # Provide a user friendly representation
834
+ def to_s
835
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
836
+ "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
837
+ end
838
+
839
+ ##
840
+ # Provide a detailed, user friendly representation
841
+ def inspect
842
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
843
+ "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
844
+ end
845
+ end
846
+
847
+ end
904
848
  end
905
- end
906
849
  end
907
- end
908
850
  end
909
- end
910
- end
851
+ end
852
+
853
+