twilio-ruby 5.77.0 → 6.0.0.pre.rc.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (634) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/test-and-deploy.yml +10 -0
  3. data/.gitignore +3 -0
  4. data/CHANGES.md +31 -94
  5. data/CONTRIBUTING.md +7 -1
  6. data/Makefile +3 -0
  7. data/README.md +51 -132
  8. data/UPGRADE.md +7 -0
  9. data/cluster_spec.rb +77 -0
  10. data/lib/twilio-ruby/base/client_base.rb +124 -0
  11. data/lib/twilio-ruby/rest/accounts/v1/auth_token_promotion.rb +198 -178
  12. data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +372 -332
  13. data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +372 -332
  14. data/lib/twilio-ruby/rest/accounts/v1/credential.rb +121 -114
  15. data/lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb +214 -192
  16. data/lib/twilio-ruby/rest/accounts/v1.rb +45 -42
  17. data/lib/twilio-ruby/rest/accounts.rb +4 -34
  18. data/lib/twilio-ruby/rest/accounts_base.rb +38 -0
  19. data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +371 -365
  20. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +560 -530
  21. data/lib/twilio-ruby/rest/api/v2010/account/application.rb +617 -605
  22. data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +328 -320
  23. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb +413 -0
  24. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/machine_to_machine.rb +413 -0
  25. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/mobile.rb +413 -0
  26. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/national.rb +413 -0
  27. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/shared_cost.rb +413 -0
  28. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/toll_free.rb +413 -0
  29. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/voip.rb +413 -0
  30. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country.rb +468 -0
  31. data/lib/twilio-ruby/rest/api/v2010/account/balance.rb +136 -118
  32. data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb +203 -194
  33. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +252 -289
  34. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +317 -303
  35. data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +405 -417
  36. data/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb +291 -342
  37. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +498 -511
  38. data/lib/twilio-ruby/rest/api/v2010/account/call/siprec.rb +839 -641
  39. data/lib/twilio-ruby/rest/api/v2010/account/call/stream.rb +839 -641
  40. data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message.rb +156 -153
  41. data/lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb +228 -240
  42. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +997 -1050
  43. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +650 -756
  44. data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +455 -458
  45. data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +506 -493
  46. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +427 -407
  47. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +322 -351
  48. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +404 -418
  49. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +541 -554
  50. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +541 -553
  51. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +541 -553
  52. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +850 -903
  53. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +336 -302
  54. data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +167 -166
  55. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +344 -350
  56. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +627 -641
  57. data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +157 -138
  58. data/lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb +157 -138
  59. data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +405 -399
  60. data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +371 -358
  61. data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +341 -338
  62. data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +431 -390
  63. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +359 -380
  64. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +374 -385
  65. data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +365 -372
  66. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +522 -513
  67. data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +420 -408
  68. data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb +336 -306
  69. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +376 -368
  70. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +404 -373
  71. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls/auth_calls_credential_list_mapping.rb +347 -0
  72. 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
  73. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls.rb +140 -0
  74. 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
  75. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations.rb +126 -0
  76. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb +94 -103
  77. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +340 -339
  78. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +340 -338
  79. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +663 -645
  80. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +413 -421
  81. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +404 -374
  82. data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +141 -150
  83. data/lib/twilio-ruby/rest/api/v2010/account/token.rb +171 -154
  84. data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +365 -350
  85. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +319 -339
  86. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +319 -339
  87. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +319 -339
  88. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +319 -339
  89. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +319 -339
  90. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +319 -339
  91. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +319 -339
  92. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +319 -339
  93. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +386 -416
  94. data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +489 -484
  95. data/lib/twilio-ruby/rest/api/v2010/account/usage.rb +112 -104
  96. data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +172 -161
  97. data/lib/twilio-ruby/rest/api/v2010/account.rb +1061 -943
  98. data/lib/twilio-ruby/rest/api/v2010.rb +126 -148
  99. data/lib/twilio-ruby/rest/api.rb +25 -34
  100. data/lib/twilio-ruby/rest/api_base.rb +38 -0
  101. data/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb +234 -213
  102. data/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb +210 -207
  103. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +380 -388
  104. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +433 -411
  105. data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +403 -385
  106. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +471 -462
  107. data/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb +234 -211
  108. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +363 -375
  109. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +427 -445
  110. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb +242 -244
  111. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +215 -226
  112. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +527 -500
  113. data/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb +427 -413
  114. data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +692 -640
  115. data/lib/twilio-ruby/rest/autopilot/v1/restore_assistant.rb +201 -188
  116. data/lib/twilio-ruby/rest/autopilot/v1.rb +48 -45
  117. data/lib/twilio-ruby/rest/autopilot.rb +3 -34
  118. data/lib/twilio-ruby/rest/autopilot_base.rb +38 -0
  119. data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +300 -279
  120. data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb +299 -279
  121. data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb +271 -248
  122. data/lib/twilio-ruby/rest/bulkexports/v1/export.rb +253 -235
  123. data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb +245 -218
  124. data/lib/twilio-ruby/rest/bulkexports/v1.rb +57 -55
  125. data/lib/twilio-ruby/rest/bulkexports.rb +3 -34
  126. data/lib/twilio-ruby/rest/bulkexports_base.rb +38 -0
  127. data/lib/twilio-ruby/rest/chat/v1/credential.rb +420 -403
  128. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +375 -391
  129. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +423 -440
  130. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +440 -437
  131. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +547 -515
  132. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +397 -367
  133. data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +245 -239
  134. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +471 -440
  135. data/lib/twilio-ruby/rest/chat/v1/service.rb +871 -894
  136. data/lib/twilio-ruby/rest/chat/v1.rb +57 -55
  137. data/lib/twilio-ruby/rest/chat/v2/credential.rb +420 -401
  138. data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +372 -370
  139. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +375 -386
  140. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +487 -527
  141. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +515 -533
  142. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +441 -467
  143. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +623 -605
  144. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +397 -369
  145. data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +365 -381
  146. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +407 -419
  147. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +518 -491
  148. data/lib/twilio-ruby/rest/chat/v2/service.rb +777 -778
  149. data/lib/twilio-ruby/rest/chat/v2.rb +57 -53
  150. data/lib/twilio-ruby/rest/chat/v3/channel.rb +289 -267
  151. data/lib/twilio-ruby/rest/chat/v3.rb +64 -41
  152. data/lib/twilio-ruby/rest/chat.rb +4 -48
  153. data/lib/twilio-ruby/rest/chat_base.rb +48 -0
  154. data/lib/twilio-ruby/rest/client.rb +314 -574
  155. data/lib/twilio-ruby/rest/content/v1/content/approval_fetch.rb +201 -188
  156. data/lib/twilio-ruby/rest/content/v1/content.rb +354 -336
  157. data/lib/twilio-ruby/rest/content/v1/content_and_approvals.rb +244 -232
  158. data/lib/twilio-ruby/rest/content/v1/legacy_content.rb +258 -246
  159. data/lib/twilio-ruby/rest/content/v1.rb +54 -52
  160. data/lib/twilio-ruby/rest/content.rb +2 -46
  161. data/lib/twilio-ruby/rest/content_base.rb +38 -0
  162. data/lib/twilio-ruby/rest/conversations/v1/address_configuration.rb +464 -444
  163. data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb +254 -227
  164. data/lib/twilio-ruby/rest/conversations/v1/configuration.rb +279 -252
  165. data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +335 -344
  166. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +534 -510
  167. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +499 -495
  168. data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +426 -403
  169. data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +594 -590
  170. data/lib/twilio-ruby/rest/conversations/v1/credential.rb +426 -409
  171. data/lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb +307 -304
  172. data/lib/twilio-ruby/rest/conversations/v1/role.rb +385 -356
  173. data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +365 -373
  174. data/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb +300 -289
  175. data/lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb +246 -235
  176. data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +307 -279
  177. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +342 -371
  178. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +542 -550
  179. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +508 -530
  180. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +435 -438
  181. data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +609 -626
  182. data/lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb +313 -317
  183. data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +397 -380
  184. data/lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb +447 -455
  185. data/lib/twilio-ruby/rest/conversations/v1/service/user.rb +489 -474
  186. data/lib/twilio-ruby/rest/conversations/v1/service.rb +493 -447
  187. data/lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb +446 -435
  188. data/lib/twilio-ruby/rest/conversations/v1/user.rb +476 -441
  189. data/lib/twilio-ruby/rest/conversations/v1.rb +129 -136
  190. data/lib/twilio-ruby/rest/conversations.rb +9 -34
  191. data/lib/twilio-ruby/rest/conversations_base.rb +38 -0
  192. data/lib/twilio-ruby/rest/events/v1/event_type.rb +306 -288
  193. data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb +302 -0
  194. data/lib/twilio-ruby/rest/events/v1/schema.rb +232 -218
  195. data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb +114 -100
  196. data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb +120 -103
  197. data/lib/twilio-ruby/rest/events/v1/sink.rb +447 -408
  198. data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +368 -339
  199. data/lib/twilio-ruby/rest/events/v1/subscription.rb +423 -387
  200. data/lib/twilio-ruby/rest/events/v1.rb +87 -87
  201. data/lib/twilio-ruby/rest/events.rb +5 -34
  202. data/lib/twilio-ruby/rest/events_base.rb +38 -0
  203. data/lib/twilio-ruby/rest/flex_api/v1/assessments.rb +447 -387
  204. data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +366 -330
  205. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +489 -496
  206. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +565 -570
  207. data/lib/twilio-ruby/rest/flex_api/v1/insights_assessments_comment.rb +329 -306
  208. data/lib/twilio-ruby/rest/flex_api/v1/insights_conversations.rb +223 -208
  209. data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb +435 -384
  210. data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_category.rb +350 -303
  211. data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb +435 -380
  212. data/lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb +427 -403
  213. data/lib/twilio-ruby/rest/flex_api/v1/insights_session.rb +209 -190
  214. data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_answer_sets.rb +155 -0
  215. data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_comment.rb +135 -124
  216. data/lib/twilio-ruby/rest/flex_api/v1/insights_user_roles.rb +188 -166
  217. data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb +245 -229
  218. data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb +329 -319
  219. data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb +409 -398
  220. data/lib/twilio-ruby/rest/flex_api/v1/interaction.rb +252 -225
  221. data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +379 -331
  222. data/lib/twilio-ruby/rest/flex_api/v1.rb +205 -215
  223. data/lib/twilio-ruby/rest/flex_api/v2/web_channels.rb +140 -127
  224. data/lib/twilio-ruby/rest/flex_api/v2.rb +33 -28
  225. data/lib/twilio-ruby/rest/flex_api.rb +21 -117
  226. data/lib/twilio-ruby/rest/flex_api_base.rb +43 -0
  227. data/lib/twilio-ruby/rest/frontline_api/v1/user.rb +244 -227
  228. data/lib/twilio-ruby/rest/frontline_api/v1.rb +42 -38
  229. data/lib/twilio-ruby/rest/frontline_api.rb +2 -34
  230. data/lib/twilio-ruby/rest/frontline_api_base.rb +38 -0
  231. data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb +312 -315
  232. data/lib/twilio-ruby/rest/insights/v1/call/call_summary.rb +350 -0
  233. data/lib/twilio-ruby/rest/insights/v1/call/event.rb +271 -255
  234. data/lib/twilio-ruby/rest/insights/v1/call/metric.rb +244 -225
  235. data/lib/twilio-ruby/rest/insights/v1/call.rb +268 -236
  236. data/lib/twilio-ruby/rest/insights/v1/call_summaries.rb +461 -439
  237. data/lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb +485 -467
  238. data/lib/twilio-ruby/rest/insights/v1/conference.rb +509 -502
  239. data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +379 -371
  240. data/lib/twilio-ruby/rest/insights/v1/room.rb +497 -489
  241. data/lib/twilio-ruby/rest/insights/v1/setting.rb +246 -207
  242. data/lib/twilio-ruby/rest/insights/v1.rb +84 -83
  243. data/lib/twilio-ruby/rest/insights.rb +6 -34
  244. data/lib/twilio-ruby/rest/insights_base.rb +38 -0
  245. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +420 -364
  246. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +375 -359
  247. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +423 -397
  248. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +440 -409
  249. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +547 -488
  250. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +397 -347
  251. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +245 -233
  252. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +471 -418
  253. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +871 -779
  254. data/lib/twilio-ruby/rest/ip_messaging/v1.rb +57 -53
  255. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +420 -364
  256. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +372 -343
  257. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +375 -359
  258. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +487 -451
  259. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +515 -479
  260. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +441 -411
  261. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +623 -555
  262. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +397 -347
  263. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +365 -351
  264. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +398 -384
  265. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +518 -467
  266. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +777 -689
  267. data/lib/twilio-ruby/rest/ip_messaging/v2.rb +57 -53
  268. data/lib/twilio-ruby/rest/ip_messaging.rb +3 -41
  269. data/lib/twilio-ruby/rest/ip_messaging_base.rb +43 -0
  270. data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +243 -239
  271. data/lib/twilio-ruby/rest/lookups/v1.rb +42 -39
  272. data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb +349 -335
  273. data/lib/twilio-ruby/rest/lookups/v2.rb +42 -38
  274. data/lib/twilio-ruby/rest/lookups.rb +2 -41
  275. data/lib/twilio-ruby/rest/lookups_base.rb +43 -0
  276. data/lib/twilio-ruby/rest/media/v1/media_processor.rb +413 -387
  277. data/lib/twilio-ruby/rest/media/v1/media_recording.rb +399 -389
  278. data/lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb +245 -214
  279. data/lib/twilio-ruby/rest/media/v1/player_streamer.rb +425 -393
  280. data/lib/twilio-ruby/rest/media/v1.rb +72 -69
  281. data/lib/twilio-ruby/rest/media.rb +4 -34
  282. data/lib/twilio-ruby/rest/media_base.rb +38 -0
  283. data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb +360 -346
  284. data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb +472 -466
  285. data/lib/twilio-ruby/rest/messaging/v1/deactivations.rb +189 -0
  286. data/lib/twilio-ruby/rest/messaging/v1/domain_certs.rb +280 -0
  287. data/lib/twilio-ruby/rest/messaging/v1/domain_config.rb +272 -232
  288. data/lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb +223 -218
  289. data/lib/twilio-ruby/rest/messaging/v1/external_campaign.rb +155 -144
  290. data/lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service.rb +206 -210
  291. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +352 -335
  292. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +359 -341
  293. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +359 -336
  294. data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb +500 -521
  295. data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person_usecase.rb +121 -115
  296. data/lib/twilio-ruby/rest/messaging/v1/service.rb +757 -763
  297. data/lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb +720 -713
  298. data/lib/twilio-ruby/rest/messaging/v1/usecase.rb +106 -94
  299. data/lib/twilio-ruby/rest/messaging/v1.rb +172 -165
  300. data/lib/twilio-ruby/rest/messaging.rb +9 -52
  301. data/lib/twilio-ruby/rest/messaging_base.rb +38 -0
  302. data/lib/twilio-ruby/rest/microvisor/v1/account_config.rb +349 -307
  303. data/lib/twilio-ruby/rest/microvisor/v1/account_secret.rb +342 -300
  304. data/lib/twilio-ruby/rest/microvisor/v1/app/app_manifest.rb +201 -185
  305. data/lib/twilio-ruby/rest/microvisor/v1/app.rb +340 -320
  306. data/lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb +368 -335
  307. data/lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb +361 -328
  308. data/lib/twilio-ruby/rest/microvisor/v1/device.rb +418 -383
  309. data/lib/twilio-ruby/rest/microvisor/v1.rb +87 -85
  310. data/lib/twilio-ruby/rest/microvisor.rb +3 -50
  311. data/lib/twilio-ruby/rest/microvisor_base.rb +38 -0
  312. data/lib/twilio-ruby/rest/monitor/v1/alert.rb +402 -395
  313. data/lib/twilio-ruby/rest/monitor/v1/event.rb +388 -390
  314. data/lib/twilio-ruby/rest/monitor/v1.rb +57 -53
  315. data/lib/twilio-ruby/rest/monitor.rb +3 -34
  316. data/lib/twilio-ruby/rest/monitor_base.rb +38 -0
  317. data/lib/twilio-ruby/rest/notify/v1/credential.rb +422 -408
  318. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +440 -452
  319. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +313 -362
  320. data/lib/twilio-ruby/rest/notify/v1/service.rb +635 -622
  321. data/lib/twilio-ruby/rest/notify/v1.rb +57 -55
  322. data/lib/twilio-ruby/rest/notify.rb +3 -34
  323. data/lib/twilio-ruby/rest/notify_base.rb +38 -0
  324. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb +279 -261
  325. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb +325 -298
  326. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/item_assignment.rb +334 -309
  327. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/replace_items.rb +194 -181
  328. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb +627 -607
  329. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb +392 -351
  330. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb +291 -266
  331. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb +326 -307
  332. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb +413 -371
  333. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb +291 -266
  334. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance.rb +177 -181
  335. data/lib/twilio-ruby/rest/numbers/v2.rb +33 -28
  336. data/lib/twilio-ruby/rest/numbers.rb +2 -47
  337. data/lib/twilio-ruby/rest/numbers_base.rb +38 -0
  338. data/lib/twilio-ruby/rest/oauth/v1/device_code.rb +165 -147
  339. data/lib/twilio-ruby/rest/oauth/v1/oauth.rb +177 -154
  340. data/lib/twilio-ruby/rest/oauth/v1/openid_discovery.rb +254 -234
  341. data/lib/twilio-ruby/rest/oauth/v1/token.rb +173 -151
  342. data/lib/twilio-ruby/rest/oauth/v1/user_info.rb +205 -185
  343. data/lib/twilio-ruby/rest/oauth/v1.rb +57 -56
  344. data/lib/twilio-ruby/rest/oauth.rb +5 -40
  345. data/lib/twilio-ruby/rest/oauth_base.rb +38 -0
  346. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb +412 -375
  347. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb +395 -358
  348. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb +451 -418
  349. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb +409 -369
  350. data/lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb +507 -459
  351. data/lib/twilio-ruby/rest/preview/deployed_devices.rb +42 -38
  352. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +376 -396
  353. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +453 -446
  354. data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +616 -625
  355. data/lib/twilio-ruby/rest/preview/hosted_numbers.rb +57 -55
  356. data/lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb +302 -298
  357. data/lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb +329 -309
  358. data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb +343 -330
  359. data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb +433 -398
  360. data/lib/twilio-ruby/rest/preview/marketplace.rb +57 -53
  361. data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb +379 -374
  362. data/lib/twilio-ruby/rest/preview/sync/service/document.rb +447 -399
  363. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb +438 -407
  364. data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb +379 -374
  365. data/lib/twilio-ruby/rest/preview/sync/service/sync_list.rb +428 -398
  366. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb +441 -404
  367. data/lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb +379 -374
  368. data/lib/twilio-ruby/rest/preview/sync/service/sync_map.rb +428 -398
  369. data/lib/twilio-ruby/rest/preview/sync/service.rb +505 -452
  370. data/lib/twilio-ruby/rest/preview/sync.rb +42 -37
  371. data/lib/twilio-ruby/rest/preview/understand/assistant/assistant_fallback_actions.rb +234 -205
  372. data/lib/twilio-ruby/rest/preview/understand/assistant/assistant_initiation_actions.rb +234 -205
  373. data/lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb +210 -199
  374. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +380 -375
  375. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +433 -400
  376. data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +403 -373
  377. data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +460 -430
  378. data/lib/twilio-ruby/rest/preview/understand/assistant/style_sheet.rb +234 -205
  379. data/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb +363 -362
  380. data/lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb +427 -417
  381. data/lib/twilio-ruby/rest/preview/understand/assistant/task/task_actions.rb +242 -230
  382. data/lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb +215 -214
  383. data/lib/twilio-ruby/rest/preview/understand/assistant/task.rb +527 -488
  384. data/lib/twilio-ruby/rest/preview/understand/assistant.rb +669 -619
  385. data/lib/twilio-ruby/rest/preview/understand.rb +42 -38
  386. data/lib/twilio-ruby/rest/preview/wireless/command.rb +392 -364
  387. data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +449 -398
  388. data/lib/twilio-ruby/rest/preview/wireless/sim/usage.rb +232 -205
  389. data/lib/twilio-ruby/rest/preview/wireless/sim.rb +580 -523
  390. data/lib/twilio-ruby/rest/preview/wireless.rb +72 -69
  391. data/lib/twilio-ruby/rest/preview.rb +11 -69
  392. data/lib/twilio-ruby/rest/preview_base.rb +63 -0
  393. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +298 -275
  394. data/lib/twilio-ruby/rest/pricing/v1/messaging.rb +107 -119
  395. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +291 -268
  396. data/lib/twilio-ruby/rest/pricing/v1/phone_number.rb +107 -119
  397. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +298 -275
  398. data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +220 -197
  399. data/lib/twilio-ruby/rest/pricing/v1/voice.rb +121 -135
  400. data/lib/twilio-ruby/rest/pricing/v1.rb +45 -42
  401. data/lib/twilio-ruby/rest/pricing/v2/country.rb +290 -270
  402. data/lib/twilio-ruby/rest/pricing/v2/number.rb +232 -217
  403. data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +298 -275
  404. data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +238 -220
  405. data/lib/twilio-ruby/rest/pricing/v2/voice.rb +121 -138
  406. data/lib/twilio-ruby/rest/pricing/v2.rb +63 -65
  407. data/lib/twilio-ruby/rest/pricing.rb +6 -41
  408. data/lib/twilio-ruby/rest/pricing_base.rb +43 -0
  409. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +420 -403
  410. data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +409 -418
  411. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb +431 -449
  412. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +427 -442
  413. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +531 -506
  414. data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb +400 -370
  415. data/lib/twilio-ruby/rest/proxy/v1/service.rb +569 -596
  416. data/lib/twilio-ruby/rest/proxy/v1.rb +42 -38
  417. data/lib/twilio-ruby/rest/proxy.rb +2 -34
  418. data/lib/twilio-ruby/rest/proxy_base.rb +38 -0
  419. data/lib/twilio-ruby/rest/routes/v2/phone_number.rb +260 -227
  420. data/lib/twilio-ruby/rest/routes/v2/sip_domain.rb +260 -223
  421. data/lib/twilio-ruby/rest/routes/v2/trunk.rb +260 -227
  422. data/lib/twilio-ruby/rest/routes/v2.rb +72 -69
  423. data/lib/twilio-ruby/rest/routes.rb +4 -34
  424. data/lib/twilio-ruby/rest/routes_base.rb +38 -0
  425. data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +316 -323
  426. data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +417 -380
  427. data/lib/twilio-ruby/rest/serverless/v1/service/build/build_status.rb +208 -208
  428. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +408 -384
  429. data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +337 -338
  430. data/lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb +365 -383
  431. data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +404 -396
  432. data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +469 -447
  433. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version/function_version_content.rb +223 -234
  434. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +343 -353
  435. data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +417 -380
  436. data/lib/twilio-ruby/rest/serverless/v1/service.rb +536 -493
  437. data/lib/twilio-ruby/rest/serverless/v1.rb +42 -37
  438. data/lib/twilio-ruby/rest/serverless.rb +2 -34
  439. data/lib/twilio-ruby/rest/serverless_base.rb +38 -0
  440. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb +206 -199
  441. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb +221 -218
  442. data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb +362 -355
  443. data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb +427 -394
  444. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb +206 -200
  445. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb +221 -221
  446. data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb +362 -361
  447. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +475 -449
  448. data/lib/twilio-ruby/rest/studio/v1/flow.rb +387 -355
  449. data/lib/twilio-ruby/rest/studio/v1.rb +42 -37
  450. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_context.rb +206 -200
  451. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step/execution_step_context.rb +221 -221
  452. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb +362 -361
  453. data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +468 -442
  454. data/lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb +342 -320
  455. data/lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb +232 -0
  456. data/lib/twilio-ruby/rest/studio/v2/flow.rb +526 -472
  457. data/lib/twilio-ruby/rest/studio/v2/flow_validate.rb +121 -99
  458. data/lib/twilio-ruby/rest/studio/v2.rb +48 -44
  459. data/lib/twilio-ruby/rest/studio.rb +3 -41
  460. data/lib/twilio-ruby/rest/studio_base.rb +43 -0
  461. data/lib/twilio-ruby/rest/supersim/v1/esim_profile.rb +397 -382
  462. data/lib/twilio-ruby/rest/supersim/v1/fleet.rb +474 -483
  463. data/lib/twilio-ruby/rest/supersim/v1/ip_command.rb +403 -409
  464. data/lib/twilio-ruby/rest/supersim/v1/network.rb +306 -297
  465. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile/network_access_profile_network.rb +338 -332
  466. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb +384 -351
  467. data/lib/twilio-ruby/rest/supersim/v1/settings_update.rb +249 -237
  468. data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb +243 -224
  469. data/lib/twilio-ruby/rest/supersim/v1/sim/sim_ip_address.rb +201 -188
  470. data/lib/twilio-ruby/rest/supersim/v1/sim.rb +472 -453
  471. data/lib/twilio-ruby/rest/supersim/v1/sms_command.rb +362 -361
  472. data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +314 -344
  473. data/lib/twilio-ruby/rest/supersim/v1.rb +144 -147
  474. data/lib/twilio-ruby/rest/supersim.rb +10 -34
  475. data/lib/twilio-ruby/rest/supersim_base.rb +38 -0
  476. data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +377 -371
  477. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +461 -423
  478. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +470 -490
  479. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +377 -370
  480. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +479 -445
  481. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +473 -495
  482. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +377 -368
  483. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +479 -444
  484. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +139 -132
  485. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +425 -400
  486. data/lib/twilio-ruby/rest/sync/v1/service.rb +588 -567
  487. data/lib/twilio-ruby/rest/sync/v1.rb +42 -37
  488. data/lib/twilio-ruby/rest/sync.rb +2 -34
  489. data/lib/twilio-ruby/rest/sync_base.rb +38 -0
  490. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +408 -395
  491. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +454 -464
  492. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +702 -749
  493. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +620 -661
  494. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +410 -382
  495. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +359 -369
  496. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +279 -275
  497. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +230 -236
  498. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +246 -258
  499. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +571 -572
  500. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +683 -732
  501. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +390 -388
  502. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +235 -239
  503. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +281 -265
  504. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +215 -193
  505. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +251 -234
  506. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +640 -637
  507. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +359 -375
  508. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb +245 -241
  509. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +230 -244
  510. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +525 -510
  511. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +353 -356
  512. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +231 -206
  513. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +241 -234
  514. data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +743 -730
  515. data/lib/twilio-ruby/rest/taskrouter/v1.rb +42 -37
  516. data/lib/twilio-ruby/rest/taskrouter.rb +2 -34
  517. data/lib/twilio-ruby/rest/taskrouter_base.rb +38 -0
  518. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +343 -320
  519. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +343 -317
  520. data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +441 -419
  521. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +476 -451
  522. data/lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb +224 -191
  523. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +636 -630
  524. data/lib/twilio-ruby/rest/trunking/v1.rb +42 -38
  525. data/lib/twilio-ruby/rest/trunking.rb +2 -34
  526. data/lib/twilio-ruby/rest/trunking_base.rb +38 -0
  527. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb +360 -352
  528. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb +336 -323
  529. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_evaluations.rb +334 -321
  530. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb +538 -513
  531. data/lib/twilio-ruby/rest/trusthub/v1/end_user.rb +384 -346
  532. data/lib/twilio-ruby/rest/trusthub/v1/end_user_type.rb +283 -261
  533. data/lib/twilio-ruby/rest/trusthub/v1/policies.rb +276 -252
  534. data/lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb +398 -359
  535. data/lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb +283 -261
  536. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb +360 -352
  537. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_entity_assignments.rb +336 -323
  538. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_evaluations.rb +334 -321
  539. data/lib/twilio-ruby/rest/trusthub/v1/trust_products.rb +538 -513
  540. data/lib/twilio-ruby/rest/trusthub/v1.rb +132 -139
  541. data/lib/twilio-ruby/rest/trusthub.rb +8 -34
  542. data/lib/twilio-ruby/rest/trusthub_base.rb +38 -0
  543. data/lib/twilio-ruby/rest/verify/v2/form.rb +195 -183
  544. data/lib/twilio-ruby/rest/verify/v2/safelist.rb +223 -207
  545. data/lib/twilio-ruby/rest/verify/v2/service/access_token.rb +272 -254
  546. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb +191 -192
  547. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +506 -531
  548. data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +448 -453
  549. data/lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb +249 -283
  550. data/lib/twilio-ruby/rest/verify/v2/service/entity.rb +436 -414
  551. data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +380 -363
  552. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +402 -388
  553. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +425 -384
  554. data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +374 -372
  555. data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +218 -205
  556. data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb +448 -412
  557. data/lib/twilio-ruby/rest/verify/v2/service.rb +789 -780
  558. data/lib/twilio-ruby/rest/verify/v2/template.rb +223 -205
  559. data/lib/twilio-ruby/rest/verify/v2/verification_attempt.rb +381 -387
  560. data/lib/twilio-ruby/rest/verify/v2/verification_attempts_summary.rb +239 -226
  561. data/lib/twilio-ruby/rest/verify/v2.rb +99 -103
  562. data/lib/twilio-ruby/rest/verify.rb +7 -34
  563. data/lib/twilio-ruby/rest/verify_base.rb +38 -0
  564. data/lib/twilio-ruby/rest/video/v1/composition.rb +482 -507
  565. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +530 -647
  566. data/lib/twilio-ruby/rest/video/v1/composition_settings.rb +281 -261
  567. data/lib/twilio-ruby/rest/video/v1/recording.rb +432 -426
  568. data/lib/twilio-ruby/rest/video/v1/recording_settings.rb +281 -261
  569. data/lib/twilio-ruby/rest/video/v1/room/participant/anonymize.rb +259 -0
  570. data/lib/twilio-ruby/rest/video/v1/room/participant/published_track.rb +332 -0
  571. data/lib/twilio-ruby/rest/video/v1/room/participant/subscribe_rules.rb +181 -0
  572. data/lib/twilio-ruby/rest/video/v1/room/participant/subscribed_track.rb +339 -0
  573. data/lib/twilio-ruby/rest/video/v1/room/participant.rb +516 -0
  574. data/lib/twilio-ruby/rest/video/v1/room/recording_rules.rb +170 -0
  575. data/lib/twilio-ruby/rest/video/v1/room/room_recording.rb +428 -0
  576. data/lib/twilio-ruby/rest/video/v1/room.rb +621 -602
  577. data/lib/twilio-ruby/rest/video/v1.rb +99 -99
  578. data/lib/twilio-ruby/rest/video.rb +7 -34
  579. data/lib/twilio-ruby/rest/video_base.rb +38 -0
  580. data/lib/twilio-ruby/rest/voice/v1/archived_call.rb +160 -176
  581. data/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb +502 -486
  582. data/lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb +441 -434
  583. data/lib/twilio-ruby/rest/voice/v1/connection_policy.rb +395 -352
  584. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/bulk_country_update.rb +135 -121
  585. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +196 -183
  586. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +386 -397
  587. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/settings.rb +217 -190
  588. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +122 -121
  589. data/lib/twilio-ruby/rest/voice/v1/ip_record.rb +378 -339
  590. data/lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb +361 -319
  591. data/lib/twilio-ruby/rest/voice/v1.rb +130 -117
  592. data/lib/twilio-ruby/rest/voice.rb +7 -34
  593. data/lib/twilio-ruby/rest/voice_base.rb +38 -0
  594. data/lib/twilio-ruby/rest/wireless/v1/command.rb +413 -406
  595. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +464 -436
  596. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +299 -284
  597. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +243 -243
  598. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +648 -647
  599. data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +230 -221
  600. data/lib/twilio-ruby/rest/wireless/v1.rb +78 -76
  601. data/lib/twilio-ruby/rest/wireless.rb +5 -34
  602. data/lib/twilio-ruby/rest/wireless_base.rb +38 -0
  603. data/lib/twilio-ruby/rest.rb +1 -0
  604. data/lib/twilio-ruby/version.rb +1 -1
  605. data/twilio-ruby.gemspec +1 -1
  606. metadata +71 -38
  607. data/advanced-examples/custom-http-client.md +0 -170
  608. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +0 -500
  609. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +0 -500
  610. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +0 -500
  611. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +0 -500
  612. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +0 -500
  613. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +0 -500
  614. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +0 -500
  615. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +0 -464
  616. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +0 -348
  617. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb +0 -163
  618. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb +0 -137
  619. data/lib/twilio-ruby/rest/events/v1/schema/version.rb +0 -290
  620. data/lib/twilio-ruby/rest/flex_api/v1/insights_settings_answersets.rb +0 -144
  621. data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +0 -321
  622. data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_registration_otp.rb +0 -134
  623. data/lib/twilio-ruby/rest/messaging/v1/deactivation.rb +0 -164
  624. data/lib/twilio-ruby/rest/messaging/v1/domain_cert.rb +0 -257
  625. data/lib/twilio-ruby/rest/numbers/v1/eligibility.rb +0 -111
  626. data/lib/twilio-ruby/rest/numbers/v1.rb +0 -35
  627. data/lib/twilio-ruby/rest/studio/v2/flow/test_user.rb +0 -199
  628. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +0 -413
  629. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_anonymize.rb +0 -240
  630. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb +0 -335
  631. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +0 -175
  632. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb +0 -340
  633. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +0 -499
  634. data/lib/twilio-ruby/rest/video/v1/room/room_recording_rule.rb +0 -144
@@ -1,644 +1,647 @@
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 - Taskrouter
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 Taskrouter < Domain
12
- class V1 < Version
13
- class WorkspaceContext < InstanceContext
14
- class WorkerList < ListResource
15
- ##
16
- # Initialize the WorkerList
17
- # @param [Version] version Version that contains the resource
18
- # @param [String] workspace_sid The SID of the Workspace that contains the Worker.
19
- # @return [WorkerList] WorkerList
20
- def initialize(version, workspace_sid: nil)
21
- super(version)
22
-
23
- # Path Solution
24
- @solution = {workspace_sid: workspace_sid}
25
- @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers"
26
-
27
- # Components
28
- @statistics = nil
29
- end
30
-
31
- ##
32
- # Lists WorkerInstance records from the API as a list.
33
- # Unlike stream(), this operation is eager and will load `limit` records into
34
- # memory before returning.
35
- # @param [String] activity_name The `activity_name` of the Worker resources to
36
- # read.
37
- # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
38
- # @param [String] available Whether to return only Worker resources that are
39
- # available or unavailable. Can be `true`, `1`, or `yes` to return Worker
40
- # resources that are available, and `false`, or any value returns the Worker
41
- # resources that are not available.
42
- # @param [String] friendly_name The `friendly_name` of the Worker resources to
43
- # read.
44
- # @param [String] target_workers_expression Filter by Workers that would match an
45
- # expression on a TaskQueue. This is helpful for debugging which Workers would
46
- # match a potential queue.
47
- # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the
48
- # Workers to read are eligible for.
49
- # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read
50
- # are eligible for.
51
- # @param [String] ordering Sorting parameter for Workers
52
- # @param [Integer] limit Upper limit for the number of records to return. stream()
53
- # guarantees to never return more than limit. Default is no limit
54
- # @param [Integer] page_size Number of records to fetch per request, when
55
- # not set will use the default value of 50 records. If no page_size is defined
56
- # but a limit is defined, stream() will attempt to read the limit with the most
57
- # efficient page size, i.e. min(limit, 1000)
58
- # @return [Array] Array of up to limit results
59
- def list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
60
- self.stream(
61
- activity_name: activity_name,
62
- activity_sid: activity_sid,
63
- available: available,
64
- friendly_name: friendly_name,
65
- target_workers_expression: target_workers_expression,
66
- task_queue_name: task_queue_name,
67
- task_queue_sid: task_queue_sid,
68
- ordering: ordering,
69
- limit: limit,
70
- page_size: page_size
71
- ).entries
72
- end
73
-
74
- ##
75
- # Streams WorkerInstance records from the API as an Enumerable.
76
- # This operation lazily loads records as efficiently as possible until the limit
77
- # is reached.
78
- # @param [String] activity_name The `activity_name` of the Worker resources to
79
- # read.
80
- # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
81
- # @param [String] available Whether to return only Worker resources that are
82
- # available or unavailable. Can be `true`, `1`, or `yes` to return Worker
83
- # resources that are available, and `false`, or any value returns the Worker
84
- # resources that are not available.
85
- # @param [String] friendly_name The `friendly_name` of the Worker resources to
86
- # read.
87
- # @param [String] target_workers_expression Filter by Workers that would match an
88
- # expression on a TaskQueue. This is helpful for debugging which Workers would
89
- # match a potential queue.
90
- # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the
91
- # Workers to read are eligible for.
92
- # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read
93
- # are eligible for.
94
- # @param [String] ordering Sorting parameter for Workers
95
- # @param [Integer] limit Upper limit for the number of records to return. stream()
96
- # guarantees to never return more than limit. Default is no limit.
97
- # @param [Integer] page_size Number of records to fetch per request, when
98
- # not set will use the default value of 50 records. If no page_size is defined
99
- # but a limit is defined, stream() will attempt to read the limit with the most
100
- # efficient page size, i.e. min(limit, 1000)
101
- # @return [Enumerable] Enumerable that will yield up to limit results
102
- def stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
103
- limits = @version.read_limits(limit, page_size)
104
-
105
- page = self.page(
106
- activity_name: activity_name,
107
- activity_sid: activity_sid,
108
- available: available,
109
- friendly_name: friendly_name,
110
- target_workers_expression: target_workers_expression,
111
- task_queue_name: task_queue_name,
112
- task_queue_sid: task_queue_sid,
113
- ordering: ordering,
114
- page_size: limits[:page_size],
115
- )
116
-
117
- @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
118
- end
119
-
120
- ##
121
- # When passed a block, yields WorkerInstance records from the API.
122
- # This operation lazily loads records as efficiently as possible until the limit
123
- # is reached.
124
- def each
125
- limits = @version.read_limits
126
-
127
- page = self.page(page_size: limits[:page_size], )
128
-
129
- @version.stream(page,
130
- limit: limits[:limit],
131
- page_limit: limits[:page_limit]).each {|x| yield x}
132
- end
133
-
134
- ##
135
- # Retrieve a single page of WorkerInstance records from the API.
136
- # Request is executed immediately.
137
- # @param [String] activity_name The `activity_name` of the Worker resources to
138
- # read.
139
- # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
140
- # @param [String] available Whether to return only Worker resources that are
141
- # available or unavailable. Can be `true`, `1`, or `yes` to return Worker
142
- # resources that are available, and `false`, or any value returns the Worker
143
- # resources that are not available.
144
- # @param [String] friendly_name The `friendly_name` of the Worker resources to
145
- # read.
146
- # @param [String] target_workers_expression Filter by Workers that would match an
147
- # expression on a TaskQueue. This is helpful for debugging which Workers would
148
- # match a potential queue.
149
- # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the
150
- # Workers to read are eligible for.
151
- # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read
152
- # are eligible for.
153
- # @param [String] ordering Sorting parameter for Workers
154
- # @param [String] page_token PageToken provided by the API
155
- # @param [Integer] page_number Page Number, this value is simply for client state
156
- # @param [Integer] page_size Number of records to return, defaults to 50
157
- # @return [Page] Page of WorkerInstance
158
- def page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
159
- params = Twilio::Values.of({
160
- 'ActivityName' => activity_name,
161
- 'ActivitySid' => activity_sid,
162
- 'Available' => available,
163
- 'FriendlyName' => friendly_name,
164
- 'TargetWorkersExpression' => target_workers_expression,
165
- 'TaskQueueName' => task_queue_name,
166
- 'TaskQueueSid' => task_queue_sid,
167
- 'Ordering' => ordering,
168
- 'PageToken' => page_token,
169
- 'Page' => page_number,
170
- 'PageSize' => page_size,
171
- })
172
-
173
- response = @version.page('GET', @uri, params: params)
174
-
175
- WorkerPage.new(@version, response, @solution)
176
- end
177
-
178
- ##
179
- # Retrieve a single page of WorkerInstance records from the API.
180
- # Request is executed immediately.
181
- # @param [String] target_url API-generated URL for the requested results page
182
- # @return [Page] Page of WorkerInstance
183
- def get_page(target_url)
184
- response = @version.domain.request(
185
- 'GET',
186
- target_url
187
- )
188
- WorkerPage.new(@version, response, @solution)
189
- end
190
-
191
- ##
192
- # Create the WorkerInstance
193
- # @param [String] friendly_name A descriptive string that you create to describe
194
- # the new Worker. It can be up to 64 characters long.
195
- # @param [String] activity_sid The SID of a valid Activity that will describe the
196
- # new Worker's initial state. See
197
- # {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more
198
- # information. If not provided, the new Worker's initial state is the
199
- # `default_activity_sid` configured on the Workspace.
200
- # @param [String] attributes A valid JSON string that describes the new Worker.
201
- # For example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data
202
- # is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the
203
- # Worker. Defaults to {}.
204
- # @return [WorkerInstance] Created WorkerInstance
205
- def create(friendly_name: nil, activity_sid: :unset, attributes: :unset)
206
- data = Twilio::Values.of({
207
- 'FriendlyName' => friendly_name,
208
- 'ActivitySid' => activity_sid,
209
- 'Attributes' => attributes,
210
- })
211
-
212
- payload = @version.create('POST', @uri, data: data)
213
-
214
- WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
215
- end
216
-
217
- ##
218
- # Access the statistics
219
- # @return [WorkersStatisticsContext] WorkersStatisticsContext
220
- def statistics
221
- return WorkersStatisticsContext.new(@version, @solution[:workspace_sid], )
222
- end
223
-
224
- ##
225
- # Provide a user friendly representation
226
- def to_s
227
- '#<Twilio.Taskrouter.V1.WorkerList>'
228
- end
229
- end
230
-
231
- class WorkerPage < Page
232
- ##
233
- # Initialize the WorkerPage
234
- # @param [Version] version Version that contains the resource
235
- # @param [Response] response Response from the API
236
- # @param [Hash] solution Path solution for the resource
237
- # @return [WorkerPage] WorkerPage
238
- def initialize(version, response, solution)
239
- super(version, response)
240
-
241
- # Path Solution
242
- @solution = solution
243
- end
244
-
245
- ##
246
- # Build an instance of WorkerInstance
247
- # @param [Hash] payload Payload response from the API
248
- # @return [WorkerInstance] WorkerInstance
249
- def get_instance(payload)
250
- WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
251
- end
252
-
253
- ##
254
- # Provide a user friendly representation
255
- def to_s
256
- '<Twilio.Taskrouter.V1.WorkerPage>'
257
- end
258
- end
259
-
260
- class WorkerContext < InstanceContext
261
- ##
262
- # Initialize the WorkerContext
263
- # @param [Version] version Version that contains the resource
264
- # @param [String] workspace_sid The SID of the Workspace with the Worker to fetch.
265
- # @param [String] sid The SID of the Worker resource to fetch.
266
- # @return [WorkerContext] WorkerContext
267
- def initialize(version, workspace_sid, sid)
268
- super(version)
269
-
270
- # Path Solution
271
- @solution = {workspace_sid: workspace_sid, sid: sid, }
272
- @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:sid]}"
273
-
274
- # Dependents
275
- @real_time_statistics = nil
276
- @cumulative_statistics = nil
277
- @statistics = nil
278
- @reservations = nil
279
- @worker_channels = nil
280
- end
281
-
282
- ##
283
- # Fetch the WorkerInstance
284
- # @return [WorkerInstance] Fetched WorkerInstance
285
- def fetch
286
- payload = @version.fetch('GET', @uri)
287
-
288
- WorkerInstance.new(
289
- @version,
290
- payload,
291
- workspace_sid: @solution[:workspace_sid],
292
- sid: @solution[:sid],
293
- )
294
- end
295
-
296
- ##
297
- # Update the WorkerInstance
298
- # @param [String] activity_sid The SID of a valid Activity that will describe the
299
- # Worker's initial state. See
300
- # {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more
301
- # information.
302
- # @param [String] attributes The JSON string that describes the Worker. For
303
- # example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data is
304
- # passed to the `assignment_callback_url` when TaskRouter assigns a Task to the
305
- # Worker. Defaults to {}.
306
- # @param [String] friendly_name A descriptive string that you create to describe
307
- # the Worker. It can be up to 64 characters long.
308
- # @param [Boolean] reject_pending_reservations Whether to reject the Worker's
309
- # pending reservations. This option is only valid if the Worker's new
310
- # {Activity}[https://www.twilio.com/docs/taskrouter/api/activity] resource has its
311
- # `availability` property set to `False`.
312
- # @param [String] if_match The If-Match HTTP request header
313
- # @return [WorkerInstance] Updated WorkerInstance
314
- def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset)
315
- data = Twilio::Values.of({
316
- 'ActivitySid' => activity_sid,
317
- 'Attributes' => attributes,
318
- 'FriendlyName' => friendly_name,
319
- 'RejectPendingReservations' => reject_pending_reservations,
320
- })
321
- headers = Twilio::Values.of({'If-Match' => if_match, })
322
-
323
- payload = @version.update('POST', @uri, data: data, headers: headers)
324
-
325
- WorkerInstance.new(
326
- @version,
327
- payload,
328
- workspace_sid: @solution[:workspace_sid],
329
- sid: @solution[:sid],
330
- )
331
- end
332
-
333
- ##
334
- # Delete the WorkerInstance
335
- # @param [String] if_match The If-Match HTTP request header
336
- # @return [Boolean] true if delete succeeds, false otherwise
337
- def delete(if_match: :unset)
338
- headers = Twilio::Values.of({'If-Match' => if_match, })
339
-
340
- @version.delete('DELETE', @uri, headers: headers)
341
- end
342
-
343
- ##
344
- # Access the real_time_statistics
345
- # @return [WorkersRealTimeStatisticsList]
346
- # @return [WorkersRealTimeStatisticsContext]
347
- def real_time_statistics
348
- WorkersRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], )
349
- end
350
-
351
- ##
352
- # Access the cumulative_statistics
353
- # @return [WorkersCumulativeStatisticsList]
354
- # @return [WorkersCumulativeStatisticsContext]
355
- def cumulative_statistics
356
- WorkersCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], )
357
- end
358
-
359
- ##
360
- # Access the statistics
361
- # @return [WorkerStatisticsList]
362
- # @return [WorkerStatisticsContext]
363
- def statistics
364
- WorkerStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
365
- end
366
-
367
- ##
368
- # Access the reservations
369
- # @return [ReservationList]
370
- # @return [ReservationContext] if sid was passed.
371
- def reservations(sid=:unset)
372
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
373
-
374
- if sid != :unset
375
- return ReservationContext.new(@version, @solution[:workspace_sid], @solution[:sid], sid, )
376
- end
377
-
378
- unless @reservations
379
- @reservations = ReservationList.new(
380
- @version,
381
- workspace_sid: @solution[:workspace_sid],
382
- worker_sid: @solution[:sid],
383
- )
384
- end
385
-
386
- @reservations
387
- end
388
-
389
- ##
390
- # Access the worker_channels
391
- # @return [WorkerChannelList]
392
- # @return [WorkerChannelContext] if sid was passed.
393
- def worker_channels(sid=:unset)
394
- raise ArgumentError, 'sid cannot be nil' if sid.nil?
395
-
396
- if sid != :unset
397
- return WorkerChannelContext.new(@version, @solution[:workspace_sid], @solution[:sid], sid, )
398
- end
399
-
400
- unless @worker_channels
401
- @worker_channels = WorkerChannelList.new(
402
- @version,
403
- workspace_sid: @solution[:workspace_sid],
404
- worker_sid: @solution[:sid],
405
- )
406
- end
407
-
408
- @worker_channels
409
- end
410
-
411
- ##
412
- # Provide a user friendly representation
413
- def to_s
414
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
415
- "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
416
- end
417
-
418
- ##
419
- # Provide a detailed, user friendly representation
420
- def inspect
421
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
422
- "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
423
- end
424
- end
425
-
426
- class WorkerInstance < InstanceResource
427
- ##
428
- # Initialize the WorkerInstance
429
- # @param [Version] version Version that contains the resource
430
- # @param [Hash] payload payload that contains response from Twilio
431
- # @param [String] workspace_sid The SID of the Workspace that contains the Worker.
432
- # @param [String] sid The SID of the Worker resource to fetch.
433
- # @return [WorkerInstance] WorkerInstance
434
- def initialize(version, payload, workspace_sid: nil, sid: nil)
435
- super(version)
436
-
437
- # Marshaled Properties
438
- @properties = {
439
- 'account_sid' => payload['account_sid'],
440
- 'activity_name' => payload['activity_name'],
441
- 'activity_sid' => payload['activity_sid'],
442
- 'attributes' => payload['attributes'],
443
- 'available' => payload['available'],
444
- 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
445
- 'date_status_changed' => Twilio.deserialize_iso8601_datetime(payload['date_status_changed']),
446
- 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
447
- 'friendly_name' => payload['friendly_name'],
448
- 'sid' => payload['sid'],
449
- 'workspace_sid' => payload['workspace_sid'],
450
- 'url' => payload['url'],
451
- 'links' => payload['links'],
452
- }
453
-
454
- # Context
455
- @instance_context = nil
456
- @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid'], }
457
- end
458
-
459
- ##
460
- # Generate an instance context for the instance, the context is capable of
461
- # performing various actions. All instance actions are proxied to the context
462
- # @return [WorkerContext] WorkerContext for this WorkerInstance
463
- def context
464
- unless @instance_context
465
- @instance_context = WorkerContext.new(@version, @params['workspace_sid'], @params['sid'], )
466
- end
467
- @instance_context
468
- end
469
-
470
- ##
471
- # @return [String] The SID of the Account that created the resource
472
- def account_sid
473
- @properties['account_sid']
474
- end
475
-
476
- ##
477
- # @return [String] The friendly_name of the Worker's current Activity
478
- def activity_name
479
- @properties['activity_name']
480
- end
481
-
482
- ##
483
- # @return [String] The SID of the Worker's current Activity
484
- def activity_sid
485
- @properties['activity_sid']
486
- end
487
-
488
- ##
489
- # @return [String] The JSON string that describes the Worker
490
- def attributes
491
- @properties['attributes']
492
- end
493
-
494
- ##
495
- # @return [Boolean] Whether the Worker is available to perform tasks
496
- def available
497
- @properties['available']
498
- end
499
-
500
- ##
501
- # @return [Time] The ISO 8601 date and time in GMT when the resource was created
502
- def date_created
503
- @properties['date_created']
504
- end
505
-
506
- ##
507
- # @return [Time] The date and time in GMT of the last change to the Worker's activity
508
- def date_status_changed
509
- @properties['date_status_changed']
510
- end
511
-
512
- ##
513
- # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
514
- def date_updated
515
- @properties['date_updated']
516
- end
517
-
518
- ##
519
- # @return [String] The string that you assigned to describe the resource
520
- def friendly_name
521
- @properties['friendly_name']
522
- end
523
-
524
- ##
525
- # @return [String] The unique string that identifies the resource
526
- def sid
527
- @properties['sid']
528
- end
529
-
530
- ##
531
- # @return [String] The SID of the Workspace that contains the Worker
532
- def workspace_sid
533
- @properties['workspace_sid']
534
- end
535
-
536
- ##
537
- # @return [String] The absolute URL of the Worker resource
538
- def url
539
- @properties['url']
540
- end
541
-
542
- ##
543
- # @return [String] The URLs of related resources
544
- def links
545
- @properties['links']
546
- end
547
-
548
- ##
549
- # Fetch the WorkerInstance
550
- # @return [WorkerInstance] Fetched WorkerInstance
551
- def fetch
552
- context.fetch
553
- end
554
-
555
- ##
556
- # Update the WorkerInstance
557
- # @param [String] activity_sid The SID of a valid Activity that will describe the
558
- # Worker's initial state. See
559
- # {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more
560
- # information.
561
- # @param [String] attributes The JSON string that describes the Worker. For
562
- # example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data is
563
- # passed to the `assignment_callback_url` when TaskRouter assigns a Task to the
564
- # Worker. Defaults to {}.
565
- # @param [String] friendly_name A descriptive string that you create to describe
566
- # the Worker. It can be up to 64 characters long.
567
- # @param [Boolean] reject_pending_reservations Whether to reject the Worker's
568
- # pending reservations. This option is only valid if the Worker's new
569
- # {Activity}[https://www.twilio.com/docs/taskrouter/api/activity] resource has its
570
- # `availability` property set to `False`.
571
- # @param [String] if_match The If-Match HTTP request header
572
- # @return [WorkerInstance] Updated WorkerInstance
573
- def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset)
574
- context.update(
575
- activity_sid: activity_sid,
576
- attributes: attributes,
577
- friendly_name: friendly_name,
578
- reject_pending_reservations: reject_pending_reservations,
579
- if_match: if_match,
580
- )
581
- end
582
-
583
- ##
584
- # Delete the WorkerInstance
585
- # @param [String] if_match The If-Match HTTP request header
586
- # @return [Boolean] true if delete succeeds, false otherwise
587
- def delete(if_match: :unset)
588
- context.delete(if_match: if_match, )
589
- end
590
-
591
- ##
592
- # Access the real_time_statistics
593
- # @return [real_time_statistics] real_time_statistics
594
- def real_time_statistics
595
- context.real_time_statistics
596
- end
597
-
598
- ##
599
- # Access the cumulative_statistics
600
- # @return [cumulative_statistics] cumulative_statistics
601
- def cumulative_statistics
602
- context.cumulative_statistics
603
- end
604
-
605
- ##
606
- # Access the statistics
607
- # @return [statistics] statistics
608
- def statistics
609
- context.statistics
610
- end
611
-
612
- ##
613
- # Access the reservations
614
- # @return [reservations] reservations
615
- def reservations
616
- context.reservations
617
- end
618
-
619
- ##
620
- # Access the worker_channels
621
- # @return [worker_channels] worker_channels
622
- def worker_channels
623
- context.worker_channels
624
- end
625
14
 
626
- ##
627
- # Provide a user friendly representation
628
- def to_s
629
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
630
- "<Twilio.Taskrouter.V1.WorkerInstance #{values}>"
631
- end
632
15
 
633
- ##
634
- # Provide a detailed, user friendly representation
635
- def inspect
636
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
637
- "<Twilio.Taskrouter.V1.WorkerInstance #{values}>"
16
+ module Twilio
17
+ module REST
18
+ class Taskrouter < TaskrouterBase
19
+ class V1 < Version
20
+ class WorkspaceContext < InstanceContext
21
+
22
+ class WorkerList < ListResource
23
+ ##
24
+ # Initialize the WorkerList
25
+ # @param [Version] version Version that contains the resource
26
+ # @return [WorkerList] WorkerList
27
+ def initialize(version, workspace_sid: nil)
28
+ super(version)
29
+ # Path Solution
30
+ @solution = { workspace_sid: workspace_sid }
31
+ @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers"
32
+ # Components
33
+ @statistics = nil
34
+ end
35
+ ##
36
+ # Create the WorkerInstance
37
+ # @param [String] friendly_name A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.
38
+ # @param [String] activity_sid The SID of a valid Activity that will describe the new Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information. If not provided, the new Worker's initial state is the `default_activity_sid` configured on the Workspace.
39
+ # @param [String] attributes A valid JSON string that describes the new Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
40
+ # @return [WorkerInstance] Created WorkerInstance
41
+ def create(
42
+ friendly_name: nil,
43
+ activity_sid: :unset,
44
+ attributes: :unset
45
+ )
46
+
47
+ data = Twilio::Values.of({
48
+ 'FriendlyName' => friendly_name,
49
+ 'ActivitySid' => activity_sid,
50
+ 'Attributes' => attributes,
51
+ })
52
+
53
+ payload = @version.create('POST', @uri, data: data)
54
+ WorkerInstance.new(
55
+ @version,
56
+ payload,
57
+ workspace_sid: @solution[:workspace_sid],
58
+ )
59
+ end
60
+
61
+
62
+ ##
63
+ # Lists WorkerInstance records from the API as a list.
64
+ # Unlike stream(), this operation is eager and will load `limit` records into
65
+ # memory before returning.
66
+ # @param [String] activity_name The `activity_name` of the Worker resources to read.
67
+ # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
68
+ # @param [String] available Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
69
+ # @param [String] friendly_name The `friendly_name` of the Worker resources to read.
70
+ # @param [String] target_workers_expression Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.
71
+ # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
72
+ # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read are eligible for.
73
+ # @param [String] ordering Sorting parameter for Workers
74
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
75
+ # guarantees to never return more than limit. Default is no limit
76
+ # @param [Integer] page_size Number of records to fetch per request, when
77
+ # not set will use the default value of 50 records. If no page_size is defined
78
+ # but a limit is defined, stream() will attempt to read the limit with the most
79
+ # efficient page size, i.e. min(limit, 1000)
80
+ # @return [Array] Array of up to limit results
81
+ def list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
82
+ self.stream(
83
+ activity_name: activity_name,
84
+ activity_sid: activity_sid,
85
+ available: available,
86
+ friendly_name: friendly_name,
87
+ target_workers_expression: target_workers_expression,
88
+ task_queue_name: task_queue_name,
89
+ task_queue_sid: task_queue_sid,
90
+ ordering: ordering,
91
+ limit: limit,
92
+ page_size: page_size
93
+ ).entries
94
+ end
95
+
96
+ ##
97
+ # Streams Instance records from the API as an Enumerable.
98
+ # This operation lazily loads records as efficiently as possible until the limit
99
+ # is reached.
100
+ # @param [String] activity_name The `activity_name` of the Worker resources to read.
101
+ # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
102
+ # @param [String] available Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
103
+ # @param [String] friendly_name The `friendly_name` of the Worker resources to read.
104
+ # @param [String] target_workers_expression Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.
105
+ # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
106
+ # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read are eligible for.
107
+ # @param [String] ordering Sorting parameter for Workers
108
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
109
+ # guarantees to never return more than limit. Default is no limit
110
+ # @param [Integer] page_size Number of records to fetch per request, when
111
+ # not set will use the default value of 50 records. If no page_size is defined
112
+ # but a limit is defined, stream() will attempt to read the limit with the most
113
+ # efficient page size, i.e. min(limit, 1000)
114
+ # @return [Enumerable] Enumerable that will yield up to limit results
115
+ def stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
116
+ limits = @version.read_limits(limit, page_size)
117
+
118
+ page = self.page(
119
+ activity_name: activity_name,
120
+ activity_sid: activity_sid,
121
+ available: available,
122
+ friendly_name: friendly_name,
123
+ target_workers_expression: target_workers_expression,
124
+ task_queue_name: task_queue_name,
125
+ task_queue_sid: task_queue_sid,
126
+ ordering: ordering,
127
+ page_size: limits[:page_size], )
128
+
129
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
130
+ end
131
+
132
+ ##
133
+ # When passed a block, yields WorkerInstance records from the API.
134
+ # This operation lazily loads records as efficiently as possible until the limit
135
+ # is reached.
136
+ def each
137
+ limits = @version.read_limits
138
+
139
+ page = self.page(page_size: limits[:page_size], )
140
+
141
+ @version.stream(page,
142
+ limit: limits[:limit],
143
+ page_limit: limits[:page_limit]).each {|x| yield x}
144
+ end
145
+
146
+ ##
147
+ # Retrieve a single page of WorkerInstance records from the API.
148
+ # Request is executed immediately.
149
+ # @param [String] activity_name The `activity_name` of the Worker resources to read.
150
+ # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
151
+ # @param [String] available Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
152
+ # @param [String] friendly_name The `friendly_name` of the Worker resources to read.
153
+ # @param [String] target_workers_expression Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.
154
+ # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
155
+ # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read are eligible for.
156
+ # @param [String] ordering Sorting parameter for Workers
157
+ # @param [String] page_token PageToken provided by the API
158
+ # @param [Integer] page_number Page Number, this value is simply for client state
159
+ # @param [Integer] page_size Number of records to return, defaults to 50
160
+ # @return [Page] Page of WorkerInstance
161
+ def page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
162
+ params = Twilio::Values.of({
163
+
164
+ 'ActivityName' => activity_name,
165
+
166
+ 'ActivitySid' => activity_sid,
167
+
168
+ 'Available' => available,
169
+
170
+ 'FriendlyName' => friendly_name,
171
+
172
+ 'TargetWorkersExpression' => target_workers_expression,
173
+
174
+ 'TaskQueueName' => task_queue_name,
175
+
176
+ 'TaskQueueSid' => task_queue_sid,
177
+
178
+ 'Ordering' => ordering,
179
+
180
+ 'PageToken' => page_token,
181
+ 'Page' => page_number,
182
+ 'PageSize' => page_size,
183
+ })
184
+
185
+ response = @version.page('GET', @uri, params: params)
186
+
187
+ WorkerPage.new(@version, response, @solution)
188
+ end
189
+
190
+ ##
191
+ # Retrieve a single page of WorkerInstance records from the API.
192
+ # Request is executed immediately.
193
+ # @param [String] target_url API-generated URL for the requested results page
194
+ # @return [Page] Page of WorkerInstance
195
+ def get_page(target_url)
196
+ response = @version.domain.request(
197
+ 'GET',
198
+ target_url
199
+ )
200
+ WorkerPage.new(@version, response, @solution)
201
+ end
202
+
203
+
204
+ ##
205
+ # Access the statistics
206
+ # @return [WorkersStatisticsContext]
207
+ def statistics
208
+ return WorkersStatisticsContext.new(@version, @solution[:workspace_sid])
209
+ end
210
+
211
+ # Provide a user friendly representation
212
+ def to_s
213
+ '#<Twilio.Taskrouter.V1.WorkerList>'
214
+ end
215
+ end
216
+
217
+
218
+ class WorkerContext < InstanceContext
219
+ ##
220
+ # Initialize the WorkerContext
221
+ # @param [Version] version Version that contains the resource
222
+ # @param [String] workspace_sid The SID of the Workspace with the Worker to update.
223
+ # @param [String] sid The SID of the Worker resource to update.
224
+ # @return [WorkerContext] WorkerContext
225
+ def initialize(version, workspace_sid, sid)
226
+ super(version)
227
+
228
+ # Path Solution
229
+ @solution = { workspace_sid: workspace_sid, sid: sid, }
230
+ @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:sid]}"
231
+
232
+ # Dependents
233
+ @reservations = nil
234
+ @real_time_statistics = nil
235
+ @statistics = nil
236
+ @cumulative_statistics = nil
237
+ @worker_channels = nil
238
+ end
239
+ ##
240
+ # Delete the WorkerInstance
241
+ # @param [String] if_match The If-Match HTTP request header
242
+ # @return [Boolean] True if delete succeeds, false otherwise
243
+ def delete(
244
+ if_match: :unset
245
+ )
246
+
247
+ headers = Twilio::Values.of({ 'If-Match' => if_match, })
248
+ @version.delete('DELETE', @uri, headers: headers)
249
+ end
250
+
251
+ ##
252
+ # Fetch the WorkerInstance
253
+ # @return [WorkerInstance] Fetched WorkerInstance
254
+ def fetch
255
+
256
+ payload = @version.fetch('GET', @uri)
257
+ WorkerInstance.new(
258
+ @version,
259
+ payload,
260
+ workspace_sid: @solution[:workspace_sid],
261
+ sid: @solution[:sid],
262
+ )
263
+ end
264
+
265
+ ##
266
+ # Update the WorkerInstance
267
+ # @param [String] activity_sid The SID of a valid Activity that will describe the Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information.
268
+ # @param [String] attributes The JSON string that describes the Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
269
+ # @param [String] friendly_name A descriptive string that you create to describe the Worker. It can be up to 64 characters long.
270
+ # @param [Boolean] reject_pending_reservations Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`.
271
+ # @param [String] if_match The If-Match HTTP request header
272
+ # @return [WorkerInstance] Updated WorkerInstance
273
+ def update(
274
+ activity_sid: :unset,
275
+ attributes: :unset,
276
+ friendly_name: :unset,
277
+ reject_pending_reservations: :unset,
278
+ if_match: :unset
279
+ )
280
+
281
+ data = Twilio::Values.of({
282
+ 'ActivitySid' => activity_sid,
283
+ 'Attributes' => attributes,
284
+ 'FriendlyName' => friendly_name,
285
+ 'RejectPendingReservations' => reject_pending_reservations,
286
+ })
287
+
288
+ headers = Twilio::Values.of({ 'If-Match' => if_match, })
289
+ payload = @version.update('POST', @uri, data: data, headers: headers)
290
+ WorkerInstance.new(
291
+ @version,
292
+ payload,
293
+ workspace_sid: @solution[:workspace_sid],
294
+ sid: @solution[:sid],
295
+ )
296
+ end
297
+
298
+ ##
299
+ # Access the reservations
300
+ # @return [ReservationList]
301
+ # @return [ReservationContext] if sid was passed.
302
+ def reservations(sid=:unset)
303
+
304
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
305
+
306
+ if sid != :unset
307
+ return ReservationContext.new(@version, @solution[:workspace_sid], @solution[:sid],sid )
308
+ end
309
+
310
+ unless @reservations
311
+ @reservations = ReservationList.new(
312
+ @version,
313
+ workspace_sid: @solution[:workspace_sid],
314
+ worker_sid: @solution[:sid]
315
+
316
+ )
317
+ end
318
+
319
+ @reservations
320
+ end
321
+ ##
322
+ # Access the real_time_statistics
323
+ # @return [WorkersRealTimeStatisticsList]
324
+ # @return [WorkersRealTimeStatisticsContext]
325
+ def real_time_statistics
326
+ WorkersRealTimeStatisticsContext.new(
327
+ @version,
328
+ @solution[:workspace_sid],
329
+ @solution[:sid]
330
+ )
331
+ end
332
+ ##
333
+ # Access the statistics
334
+ # @return [WorkerStatisticsList]
335
+ # @return [WorkerStatisticsContext]
336
+ def statistics
337
+ WorkerStatisticsContext.new(
338
+ @version,
339
+ @solution[:workspace_sid],
340
+ @solution[:sid]
341
+ )
342
+ end
343
+ ##
344
+ # Access the cumulative_statistics
345
+ # @return [WorkersCumulativeStatisticsList]
346
+ # @return [WorkersCumulativeStatisticsContext]
347
+ def cumulative_statistics
348
+ WorkersCumulativeStatisticsContext.new(
349
+ @version,
350
+ @solution[:workspace_sid],
351
+ @solution[:sid]
352
+ )
353
+ end
354
+ ##
355
+ # Access the worker_channels
356
+ # @return [WorkerChannelList]
357
+ # @return [WorkerChannelContext] if sid was passed.
358
+ def worker_channels(sid=:unset)
359
+
360
+ raise ArgumentError, 'sid cannot be nil' if sid.nil?
361
+
362
+ if sid != :unset
363
+ return WorkerChannelContext.new(@version, @solution[:workspace_sid], @solution[:sid],sid )
364
+ end
365
+
366
+ unless @worker_channels
367
+ @worker_channels = WorkerChannelList.new(
368
+ @version,
369
+ workspace_sid: @solution[:workspace_sid],
370
+ worker_sid: @solution[:sid]
371
+
372
+ )
373
+ end
374
+
375
+ @worker_channels
376
+ end
377
+
378
+ ##
379
+ # Provide a user friendly representation
380
+ def to_s
381
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
382
+ "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
383
+ end
384
+
385
+ ##
386
+ # Provide a detailed, user friendly representation
387
+ def inspect
388
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
389
+ "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
390
+ end
391
+ end
392
+
393
+ class WorkerPage < Page
394
+ ##
395
+ # Initialize the WorkerPage
396
+ # @param [Version] version Version that contains the resource
397
+ # @param [Response] response Response from the API
398
+ # @param [Hash] solution Path solution for the resource
399
+ # @return [WorkerPage] WorkerPage
400
+ def initialize(version, response, solution)
401
+ super(version, response)
402
+
403
+ # Path Solution
404
+ @solution = solution
405
+ end
406
+
407
+ ##
408
+ # Build an instance of WorkerInstance
409
+ # @param [Hash] payload Payload response from the API
410
+ # @return [WorkerInstance] WorkerInstance
411
+ def get_instance(payload)
412
+ WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
413
+ end
414
+
415
+ ##
416
+ # Provide a user friendly representation
417
+ def to_s
418
+ '<Twilio.Taskrouter.V1.WorkerPage>'
419
+ end
420
+ end
421
+ class WorkerInstance < InstanceResource
422
+ ##
423
+ # Initialize the WorkerInstance
424
+ # @param [Version] version Version that contains the resource
425
+ # @param [Hash] payload payload that contains response from Twilio
426
+ # @param [String] account_sid The SID of the
427
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Worker
428
+ # resource.
429
+ # @param [String] sid The SID of the Call resource to fetch.
430
+ # @return [WorkerInstance] WorkerInstance
431
+ def initialize(version, payload , workspace_sid: nil, sid: nil)
432
+ super(version)
433
+
434
+ # Marshaled Properties
435
+ @properties = {
436
+ 'account_sid' => payload['account_sid'],
437
+ 'activity_name' => payload['activity_name'],
438
+ 'activity_sid' => payload['activity_sid'],
439
+ 'attributes' => payload['attributes'],
440
+ 'available' => payload['available'],
441
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
442
+ 'date_status_changed' => Twilio.deserialize_iso8601_datetime(payload['date_status_changed']),
443
+ 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
444
+ 'friendly_name' => payload['friendly_name'],
445
+ 'sid' => payload['sid'],
446
+ 'workspace_sid' => payload['workspace_sid'],
447
+ 'url' => payload['url'],
448
+ 'links' => payload['links'],
449
+ }
450
+
451
+ # Context
452
+ @instance_context = nil
453
+ @params = { 'workspace_sid' => workspace_sid || @properties['workspace_sid'] ,'sid' => sid || @properties['sid'] , }
454
+ end
455
+
456
+ ##
457
+ # Generate an instance context for the instance, the context is capable of
458
+ # performing various actions. All instance actions are proxied to the context
459
+ # @return [WorkerContext] CallContext for this CallInstance
460
+ def context
461
+ unless @instance_context
462
+ @instance_context = WorkerContext.new(@version , @params['workspace_sid'], @params['sid'])
463
+ end
464
+ @instance_context
465
+ end
466
+
467
+ ##
468
+ # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource.
469
+ def account_sid
470
+ @properties['account_sid']
471
+ end
472
+
473
+ ##
474
+ # @return [String] The `friendly_name` of the Worker's current Activity.
475
+ def activity_name
476
+ @properties['activity_name']
477
+ end
478
+
479
+ ##
480
+ # @return [String] The SID of the Worker's current Activity.
481
+ def activity_sid
482
+ @properties['activity_sid']
483
+ end
484
+
485
+ ##
486
+ # @return [String] The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. **Note** If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.
487
+ def attributes
488
+ @properties['attributes']
489
+ end
490
+
491
+ ##
492
+ # @return [Boolean] Whether the Worker is available to perform tasks.
493
+ def available
494
+ @properties['available']
495
+ end
496
+
497
+ ##
498
+ # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
499
+ def date_created
500
+ @properties['date_created']
501
+ end
502
+
503
+ ##
504
+ # @return [Time] The date and time in GMT of the last change to the Worker's activity specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Used to calculate Workflow statistics.
505
+ def date_status_changed
506
+ @properties['date_status_changed']
507
+ end
508
+
509
+ ##
510
+ # @return [Time] The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
511
+ def date_updated
512
+ @properties['date_updated']
513
+ end
514
+
515
+ ##
516
+ # @return [String] The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.
517
+ def friendly_name
518
+ @properties['friendly_name']
519
+ end
520
+
521
+ ##
522
+ # @return [String] The unique string that we created to identify the Worker resource.
523
+ def sid
524
+ @properties['sid']
525
+ end
526
+
527
+ ##
528
+ # @return [String] The SID of the Workspace that contains the Worker.
529
+ def workspace_sid
530
+ @properties['workspace_sid']
531
+ end
532
+
533
+ ##
534
+ # @return [String] The absolute URL of the Worker resource.
535
+ def url
536
+ @properties['url']
537
+ end
538
+
539
+ ##
540
+ # @return [Hash] The URLs of related resources.
541
+ def links
542
+ @properties['links']
543
+ end
544
+
545
+ ##
546
+ # Delete the WorkerInstance
547
+ # @param [String] if_match The If-Match HTTP request header
548
+ # @return [Boolean] True if delete succeeds, false otherwise
549
+ def delete(
550
+ if_match: :unset
551
+ )
552
+
553
+ context.delete(
554
+ if_match: if_match,
555
+ )
556
+ end
557
+
558
+ ##
559
+ # Fetch the WorkerInstance
560
+ # @return [WorkerInstance] Fetched WorkerInstance
561
+ def fetch
562
+
563
+ context.fetch
564
+ end
565
+
566
+ ##
567
+ # Update the WorkerInstance
568
+ # @param [String] activity_sid The SID of a valid Activity that will describe the Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information.
569
+ # @param [String] attributes The JSON string that describes the Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
570
+ # @param [String] friendly_name A descriptive string that you create to describe the Worker. It can be up to 64 characters long.
571
+ # @param [Boolean] reject_pending_reservations Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`.
572
+ # @param [String] if_match The If-Match HTTP request header
573
+ # @return [WorkerInstance] Updated WorkerInstance
574
+ def update(
575
+ activity_sid: :unset,
576
+ attributes: :unset,
577
+ friendly_name: :unset,
578
+ reject_pending_reservations: :unset,
579
+ if_match: :unset
580
+ )
581
+
582
+ context.update(
583
+ activity_sid: activity_sid,
584
+ attributes: attributes,
585
+ friendly_name: friendly_name,
586
+ reject_pending_reservations: reject_pending_reservations,
587
+ if_match: if_match,
588
+ )
589
+ end
590
+
591
+ ##
592
+ # Access the reservations
593
+ # @return [reservations] reservations
594
+ def reservations
595
+ context.reservations
596
+ end
597
+
598
+ ##
599
+ # Access the real_time_statistics
600
+ # @return [real_time_statistics] real_time_statistics
601
+ def real_time_statistics
602
+ context.real_time_statistics
603
+ end
604
+
605
+ ##
606
+ # Access the statistics
607
+ # @return [statistics] statistics
608
+ def statistics
609
+ context.statistics
610
+ end
611
+
612
+ ##
613
+ # Access the cumulative_statistics
614
+ # @return [cumulative_statistics] cumulative_statistics
615
+ def cumulative_statistics
616
+ context.cumulative_statistics
617
+ end
618
+
619
+ ##
620
+ # Access the worker_channels
621
+ # @return [worker_channels] worker_channels
622
+ def worker_channels
623
+ context.worker_channels
624
+ end
625
+
626
+ ##
627
+ # Provide a user friendly representation
628
+ def to_s
629
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
630
+ "<Twilio.Taskrouter.V1.WorkerInstance #{values}>"
631
+ end
632
+
633
+ ##
634
+ # Provide a detailed, user friendly representation
635
+ def inspect
636
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
637
+ "<Twilio.Taskrouter.V1.WorkerInstance #{values}>"
638
+ end
639
+ end
640
+
641
+ end
638
642
  end
639
- end
640
643
  end
641
- end
642
644
  end
643
- end
644
- end
645
+ end
646
+
647
+