twilio-ruby 5.40.0 → 5.41.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (344) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +110 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/framework/version.rb +4 -8
  5. data/lib/twilio-ruby/rest/accounts.rb +12 -0
  6. data/lib/twilio-ruby/rest/accounts/v1.rb +14 -0
  7. data/lib/twilio-ruby/rest/accounts/v1/auth_token_promotion.rb +186 -0
  8. data/lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb +200 -0
  9. data/lib/twilio-ruby/rest/api.rb +1 -1
  10. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +3 -3
  11. data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +2 -2
  12. data/lib/twilio-ruby/rest/api/v2010/account/application.rb +3 -3
  13. data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +3 -3
  14. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +3 -3
  15. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +32 -23
  16. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +32 -23
  17. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +32 -23
  18. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +32 -23
  19. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +32 -23
  20. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +32 -23
  21. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +32 -23
  22. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +21 -20
  23. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +3 -3
  24. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +3 -3
  25. data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +6 -6
  26. data/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb +20 -14
  27. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +8 -8
  28. data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +3 -3
  29. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +29 -22
  30. data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +3 -3
  31. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +3 -3
  32. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +10 -10
  33. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +3 -3
  34. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +3 -3
  35. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +3 -3
  36. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +3 -3
  37. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +3 -3
  38. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +1 -1
  39. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +28 -21
  40. data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +6 -4
  41. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +3 -3
  42. data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +3 -3
  43. data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +3 -3
  44. data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +3 -3
  45. data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +5 -5
  46. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +6 -6
  47. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +3 -3
  48. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +3 -3
  49. data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +6 -6
  50. data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +3 -3
  51. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +1 -1
  52. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb +2 -2
  53. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb +2 -2
  54. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +3 -3
  55. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb +3 -3
  56. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb +2 -2
  57. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb +3 -3
  58. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +1 -1
  59. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +1 -1
  60. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +1 -1
  61. data/lib/twilio-ruby/rest/api/v2010/account/token.rb +2 -2
  62. data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +3 -3
  63. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +6 -6
  64. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +6 -6
  65. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +6 -6
  66. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +6 -6
  67. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +6 -6
  68. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +6 -6
  69. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +6 -6
  70. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +6 -6
  71. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +6 -6
  72. data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +19 -18
  73. data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +3 -3
  74. data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +12 -12
  75. data/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb +3 -3
  76. data/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb +3 -3
  77. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +3 -3
  78. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +15 -11
  79. data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +3 -3
  80. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +33 -26
  81. data/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb +3 -3
  82. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +6 -6
  83. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +9 -9
  84. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +31 -24
  85. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb +8 -8
  86. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +6 -6
  87. data/lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb +3 -3
  88. data/lib/twilio-ruby/rest/chat/v1/service.rb +36 -36
  89. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +3 -3
  90. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +19 -19
  91. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +28 -28
  92. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +7 -7
  93. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +5 -5
  94. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +8 -8
  95. data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +2 -2
  96. data/lib/twilio-ruby/rest/chat/v2/service.rb +36 -36
  97. data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +18 -18
  98. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +15 -15
  99. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +19 -19
  100. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +54 -54
  101. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +25 -25
  102. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +15 -15
  103. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +5 -5
  104. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +8 -8
  105. data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +18 -18
  106. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +20 -20
  107. data/lib/twilio-ruby/rest/client.rb +1 -1
  108. data/lib/twilio-ruby/rest/conversations.rb +39 -3
  109. data/lib/twilio-ruby/rest/conversations/v1.rb +68 -5
  110. data/lib/twilio-ruby/rest/conversations/v1/configuration.rb +260 -0
  111. data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb +254 -0
  112. data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +34 -23
  113. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +15 -20
  114. data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +35 -28
  115. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +42 -44
  116. data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +14 -19
  117. data/lib/twilio-ruby/rest/conversations/v1/credential.rb +419 -0
  118. data/lib/twilio-ruby/rest/conversations/v1/role.rb +366 -0
  119. data/lib/twilio-ruby/rest/conversations/v1/service.rb +434 -0
  120. data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +380 -0
  121. data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +263 -0
  122. data/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb +307 -0
  123. data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +588 -0
  124. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +541 -0
  125. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +386 -0
  126. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +511 -0
  127. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +449 -0
  128. data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +387 -0
  129. data/lib/twilio-ruby/rest/conversations/v1/service/user.rb +430 -0
  130. data/lib/twilio-ruby/rest/conversations/v1/user.rb +409 -0
  131. data/lib/twilio-ruby/rest/events.rb +20 -2
  132. data/lib/twilio-ruby/rest/events/v1.rb +34 -2
  133. data/lib/twilio-ruby/rest/events/v1/event_type.rb +291 -0
  134. data/lib/twilio-ruby/rest/events/v1/schema.rb +226 -0
  135. data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb +290 -0
  136. data/lib/twilio-ruby/rest/events/v1/sink.rb +15 -14
  137. data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb +3 -3
  138. data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb +5 -4
  139. data/lib/twilio-ruby/rest/events/v1/subscription.rb +46 -21
  140. data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +10 -116
  141. data/lib/twilio-ruby/rest/fax/v1/fax.rb +28 -27
  142. data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +7 -0
  143. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +36 -36
  144. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +3 -3
  145. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +19 -19
  146. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +28 -28
  147. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +7 -7
  148. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +5 -5
  149. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +8 -8
  150. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +2 -2
  151. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +36 -36
  152. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +18 -18
  153. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +15 -15
  154. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +19 -19
  155. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +54 -54
  156. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +25 -25
  157. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +15 -15
  158. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +5 -5
  159. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +8 -8
  160. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +18 -18
  161. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +20 -20
  162. data/lib/twilio-ruby/rest/lookups.rb +1 -1
  163. data/lib/twilio-ruby/rest/lookups/v1.rb +1 -1
  164. data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +10 -10
  165. data/lib/twilio-ruby/rest/messaging.rb +6 -0
  166. data/lib/twilio-ruby/rest/messaging/v1.rb +7 -0
  167. data/lib/twilio-ruby/rest/messaging/v1/deactivation.rb +164 -0
  168. data/lib/twilio-ruby/rest/messaging/v1/service.rb +39 -36
  169. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +3 -3
  170. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +3 -3
  171. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +3 -3
  172. data/lib/twilio-ruby/rest/monitor/v1/event.rb +15 -15
  173. data/lib/twilio-ruby/rest/notify/v1/credential.rb +12 -6
  174. data/lib/twilio-ruby/rest/notify/v1/service.rb +24 -24
  175. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +10 -10
  176. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +23 -15
  177. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance.rb +3 -3
  178. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb +16 -2
  179. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb +18 -4
  180. data/lib/twilio-ruby/rest/preview.rb +8 -0
  181. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +15 -10
  182. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +9 -6
  183. data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +1 -1
  184. data/lib/twilio-ruby/rest/preview/trusted_comms.rb +15 -0
  185. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +4 -4
  186. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_channel.rb +225 -0
  187. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_channel/channel.rb +165 -0
  188. data/lib/twilio-ruby/rest/preview/trusted_comms/business.rb +0 -26
  189. data/lib/twilio-ruby/rest/preview/trusted_comms/business/insights.rb +1 -4
  190. data/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb +4 -4
  191. data/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb +52 -52
  192. data/lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb +2 -2
  193. data/lib/twilio-ruby/rest/pricing/v1/messaging.rb +2 -2
  194. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +4 -4
  195. data/lib/twilio-ruby/rest/pricing/v1/phone_number.rb +2 -2
  196. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +4 -4
  197. data/lib/twilio-ruby/rest/pricing/v1/voice.rb +2 -2
  198. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +4 -4
  199. data/lib/twilio-ruby/rest/pricing/v2/voice.rb +3 -3
  200. data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +4 -4
  201. data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +4 -4
  202. data/lib/twilio-ruby/rest/proxy/v1/service.rb +15 -15
  203. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +13 -11
  204. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +33 -30
  205. data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +6 -6
  206. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +18 -17
  207. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb +9 -9
  208. data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb +8 -8
  209. data/lib/twilio-ruby/rest/serverless/v1/service.rb +13 -13
  210. data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +6 -6
  211. data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +5 -5
  212. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +33 -8
  213. data/lib/twilio-ruby/rest/serverless/v1/service/build/build_status.rb +219 -0
  214. data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +6 -8
  215. data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +8 -8
  216. data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +14 -14
  217. data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +4 -4
  218. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +7 -7
  219. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version/function_version_content.rb +1 -1
  220. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +6 -6
  221. data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +6 -6
  222. data/lib/twilio-ruby/rest/supersim/v1/command.rb +7 -7
  223. data/lib/twilio-ruby/rest/supersim/v1/network.rb +6 -6
  224. data/lib/twilio-ruby/rest/supersim/v1/sim.rb +22 -12
  225. data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +6 -6
  226. data/lib/twilio-ruby/rest/sync/v1/service.rb +3 -3
  227. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +6 -6
  228. data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +6 -6
  229. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +6 -6
  230. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +6 -6
  231. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +6 -6
  232. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +6 -6
  233. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +12 -12
  234. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +6 -6
  235. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +6 -6
  236. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +4 -4
  237. data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +4 -4
  238. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +2 -1
  239. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +6 -6
  240. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +16 -12
  241. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +8 -8
  242. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +6 -6
  243. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +6 -6
  244. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +9 -9
  245. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +4 -7
  246. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +16 -12
  247. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +4 -4
  248. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +4 -4
  249. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +6 -6
  250. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +12 -12
  251. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +4 -4
  252. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +6 -6
  253. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +4 -4
  254. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +6 -6
  255. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +62 -47
  256. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +2 -2
  257. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +3 -2
  258. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +3 -2
  259. data/lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb +201 -0
  260. data/lib/twilio-ruby/rest/verify/v2/service.rb +51 -30
  261. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +13 -16
  262. data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +39 -23
  263. data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +12 -12
  264. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +3 -3
  265. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +3 -3
  266. data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +14 -12
  267. data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +5 -5
  268. data/lib/twilio-ruby/rest/video/v1/composition.rb +13 -9
  269. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +33 -24
  270. data/lib/twilio-ruby/rest/video/v1/recording.rb +6 -6
  271. data/lib/twilio-ruby/rest/video/v1/room.rb +7 -9
  272. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +6 -6
  273. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +9 -9
  274. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +2 -2
  275. data/lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb +9 -9
  276. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +3 -6
  277. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +22 -22
  278. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +4 -4
  279. data/lib/twilio-ruby/rest/voice/v1/ip_record.rb +2 -2
  280. data/lib/twilio-ruby/rest/wireless/v1/command.rb +7 -7
  281. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +8 -7
  282. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +22 -22
  283. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +4 -4
  284. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +10 -10
  285. data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb +6 -6
  286. data/lib/twilio-ruby/version.rb +1 -1
  287. data/spec/framework/version_spec.rb +53 -0
  288. data/spec/holodeck/holodeck.rb +3 -3
  289. data/spec/integration/accounts/v1/auth_token_promotion_spec.rb +44 -0
  290. data/spec/integration/accounts/v1/secondary_auth_token_spec.rb +69 -0
  291. data/spec/integration/api/v2010/account/conference/participant_spec.rb +30 -0
  292. data/spec/integration/bulkexports/v1/export/day_spec.rb +5 -5
  293. data/spec/integration/bulkexports/v1/export_configuration_spec.rb +4 -4
  294. data/spec/integration/bulkexports/v1/export_spec.rb +3 -3
  295. data/spec/integration/conversations/v1/{webhook_spec.rb → configuration/webhook_spec.rb} +12 -8
  296. data/spec/integration/conversations/v1/configuration_spec.rb +87 -0
  297. data/spec/integration/conversations/v1/conversation/message/delivery_receipt_spec.rb +4 -0
  298. data/spec/integration/conversations/v1/conversation/participant_spec.rb +6 -6
  299. data/spec/integration/conversations/v1/conversation_spec.rb +5 -0
  300. data/spec/integration/conversations/v1/credential_spec.rb +219 -0
  301. data/spec/integration/conversations/v1/role_spec.rb +249 -0
  302. data/spec/integration/conversations/v1/service/binding_spec.rb +166 -0
  303. data/spec/integration/conversations/v1/service/configuration/notification_spec.rb +115 -0
  304. data/spec/integration/conversations/v1/service/configuration_spec.rb +87 -0
  305. data/spec/integration/conversations/v1/service/conversation/message/delivery_receipt_spec.rb +144 -0
  306. data/spec/integration/conversations/v1/service/conversation/message_spec.rb +429 -0
  307. data/spec/integration/conversations/v1/service/conversation/participant_spec.rb +407 -0
  308. data/spec/integration/conversations/v1/service/conversation/webhook_spec.rb +299 -0
  309. data/spec/integration/conversations/v1/service/conversation_spec.rb +289 -0
  310. data/spec/integration/conversations/v1/service/role_spec.rb +260 -0
  311. data/spec/integration/conversations/v1/service/user_spec.rb +236 -0
  312. data/spec/integration/conversations/v1/service_spec.rb +174 -0
  313. data/spec/integration/conversations/v1/user_spec.rb +226 -0
  314. data/spec/integration/events/v1/event_type_spec.rb +133 -0
  315. data/spec/integration/events/v1/schema/schema_version_spec.rb +126 -0
  316. data/spec/integration/events/v1/schema_spec.rb +46 -0
  317. data/spec/integration/events/v1/sink_spec.rb +3 -3
  318. data/spec/integration/events/v1/subscription/subscribed_event_spec.rb +0 -121
  319. data/spec/integration/events/v1/subscription_spec.rb +41 -3
  320. data/spec/integration/insights/v1/call/summary_spec.rb +1 -0
  321. data/spec/integration/messaging/v1/deactivation_spec.rb +40 -0
  322. data/spec/integration/numbers/v2/regulatory_compliance/end_user_spec.rb +27 -0
  323. data/spec/integration/numbers/v2/regulatory_compliance/supporting_document_spec.rb +27 -0
  324. data/spec/integration/preview/trusted_comms/{business/brand/branded_channel → branded_channel}/channel_spec.rb +4 -8
  325. data/spec/integration/preview/trusted_comms/{business/brand/branded_channel_spec.rb → branded_channel_spec.rb} +5 -9
  326. data/spec/integration/preview/trusted_comms/business_spec.rb +0 -1
  327. data/spec/integration/serverless/v1/service/build/build_status_spec.rb +48 -0
  328. data/spec/integration/serverless/v1/service/build_spec.rb +8 -2
  329. data/spec/integration/studio/v1/flow/execution/execution_step_spec.rb +1 -0
  330. data/spec/integration/studio/v2/flow/execution/execution_step_spec.rb +1 -0
  331. data/spec/integration/supersim/v1/sim_spec.rb +23 -0
  332. data/spec/integration/trunking/v1/trunk/recording_spec.rb +79 -0
  333. data/spec/integration/trunking/v1/trunk_spec.rb +4 -0
  334. data/spec/integration/verify/v2/service/entity/challenge_spec.rb +52 -8
  335. data/spec/integration/verify/v2/service/entity/factor_spec.rb +8 -13
  336. data/spec/integration/verify/v2/service_spec.rb +8 -4
  337. data/spec/integration/video/v1/room_spec.rb +37 -0
  338. data/spec/spec_helper.rb +1 -1
  339. metadata +80 -14
  340. data/lib/twilio-ruby/rest/conversations/v1/webhook.rb +0 -262
  341. data/lib/twilio-ruby/rest/preview/trusted_comms/business/brand.rb +0 -233
  342. data/lib/twilio-ruby/rest/preview/trusted_comms/business/brand/branded_channel.rb +0 -260
  343. data/lib/twilio-ruby/rest/preview/trusted_comms/business/brand/branded_channel/channel.rb +0 -189
  344. data/spec/integration/preview/trusted_comms/business/brand_spec.rb +0 -48
@@ -0,0 +1,386 @@
1
+ ##
2
+ # This code was generated by
3
+ # \ / _ _ _| _ _
4
+ # | (_)\/(_)(_|\/| |(/_ v1.0.0
5
+ # / /
6
+ #
7
+ # frozen_string_literal: true
8
+
9
+ module Twilio
10
+ module REST
11
+ class Conversations < Domain
12
+ class V1 < Version
13
+ class ServiceContext < InstanceContext
14
+ class ConversationContext < InstanceContext
15
+ class MessageContext < InstanceContext
16
+ class DeliveryReceiptList < ListResource
17
+ ##
18
+ # Initialize the DeliveryReceiptList
19
+ # @param [Version] version Version that contains the resource
20
+ # @param [String] chat_service_sid The SID of the {Conversation
21
+ # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
22
+ # Message resource is associated with.
23
+ # @param [String] conversation_sid The unique ID of the
24
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
25
+ # for this message.
26
+ # @param [String] message_sid The SID of the message within a
27
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
28
+ # the delivery receipt belongs to
29
+ # @return [DeliveryReceiptList] DeliveryReceiptList
30
+ def initialize(version, chat_service_sid: nil, conversation_sid: nil, message_sid: nil)
31
+ super(version)
32
+
33
+ # Path Solution
34
+ @solution = {
35
+ chat_service_sid: chat_service_sid,
36
+ conversation_sid: conversation_sid,
37
+ message_sid: message_sid
38
+ }
39
+ @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Messages/#{@solution[:message_sid]}/Receipts"
40
+ end
41
+
42
+ ##
43
+ # Lists DeliveryReceiptInstance records from the API as a list.
44
+ # Unlike stream(), this operation is eager and will load `limit` records into
45
+ # memory before returning.
46
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
47
+ # guarantees to never return more than limit. Default is no limit
48
+ # @param [Integer] page_size Number of records to fetch per request, when
49
+ # not set will use the default value of 50 records. If no page_size is defined
50
+ # but a limit is defined, stream() will attempt to read the limit with the most
51
+ # efficient page size, i.e. min(limit, 1000)
52
+ # @return [Array] Array of up to limit results
53
+ def list(limit: nil, page_size: nil)
54
+ self.stream(limit: limit, page_size: page_size).entries
55
+ end
56
+
57
+ ##
58
+ # Streams DeliveryReceiptInstance records from the API as an Enumerable.
59
+ # This operation lazily loads records as efficiently as possible until the limit
60
+ # is reached.
61
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
62
+ # guarantees to never return more than limit. Default is no limit.
63
+ # @param [Integer] page_size Number of records to fetch per request, when
64
+ # not set will use the default value of 50 records. If no page_size is defined
65
+ # but a limit is defined, stream() will attempt to read the limit with the most
66
+ # efficient page size, i.e. min(limit, 1000)
67
+ # @return [Enumerable] Enumerable that will yield up to limit results
68
+ def stream(limit: nil, page_size: nil)
69
+ limits = @version.read_limits(limit, page_size)
70
+
71
+ page = self.page(page_size: limits[:page_size], )
72
+
73
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
74
+ end
75
+
76
+ ##
77
+ # When passed a block, yields DeliveryReceiptInstance records from the API.
78
+ # This operation lazily loads records as efficiently as possible until the limit
79
+ # is reached.
80
+ def each
81
+ limits = @version.read_limits
82
+
83
+ page = self.page(page_size: limits[:page_size], )
84
+
85
+ @version.stream(page,
86
+ limit: limits[:limit],
87
+ page_limit: limits[:page_limit]).each {|x| yield x}
88
+ end
89
+
90
+ ##
91
+ # Retrieve a single page of DeliveryReceiptInstance records from the API.
92
+ # Request is executed immediately.
93
+ # @param [String] page_token PageToken provided by the API
94
+ # @param [Integer] page_number Page Number, this value is simply for client state
95
+ # @param [Integer] page_size Number of records to return, defaults to 50
96
+ # @return [Page] Page of DeliveryReceiptInstance
97
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
98
+ params = Twilio::Values.of({
99
+ 'PageToken' => page_token,
100
+ 'Page' => page_number,
101
+ 'PageSize' => page_size,
102
+ })
103
+
104
+ response = @version.page('GET', @uri, params: params)
105
+
106
+ DeliveryReceiptPage.new(@version, response, @solution)
107
+ end
108
+
109
+ ##
110
+ # Retrieve a single page of DeliveryReceiptInstance records from the API.
111
+ # Request is executed immediately.
112
+ # @param [String] target_url API-generated URL for the requested results page
113
+ # @return [Page] Page of DeliveryReceiptInstance
114
+ def get_page(target_url)
115
+ response = @version.domain.request(
116
+ 'GET',
117
+ target_url
118
+ )
119
+ DeliveryReceiptPage.new(@version, response, @solution)
120
+ end
121
+
122
+ ##
123
+ # Provide a user friendly representation
124
+ def to_s
125
+ '#<Twilio.Conversations.V1.DeliveryReceiptList>'
126
+ end
127
+ end
128
+
129
+ class DeliveryReceiptPage < Page
130
+ ##
131
+ # Initialize the DeliveryReceiptPage
132
+ # @param [Version] version Version that contains the resource
133
+ # @param [Response] response Response from the API
134
+ # @param [Hash] solution Path solution for the resource
135
+ # @return [DeliveryReceiptPage] DeliveryReceiptPage
136
+ def initialize(version, response, solution)
137
+ super(version, response)
138
+
139
+ # Path Solution
140
+ @solution = solution
141
+ end
142
+
143
+ ##
144
+ # Build an instance of DeliveryReceiptInstance
145
+ # @param [Hash] payload Payload response from the API
146
+ # @return [DeliveryReceiptInstance] DeliveryReceiptInstance
147
+ def get_instance(payload)
148
+ DeliveryReceiptInstance.new(
149
+ @version,
150
+ payload,
151
+ chat_service_sid: @solution[:chat_service_sid],
152
+ conversation_sid: @solution[:conversation_sid],
153
+ message_sid: @solution[:message_sid],
154
+ )
155
+ end
156
+
157
+ ##
158
+ # Provide a user friendly representation
159
+ def to_s
160
+ '<Twilio.Conversations.V1.DeliveryReceiptPage>'
161
+ end
162
+ end
163
+
164
+ class DeliveryReceiptContext < InstanceContext
165
+ ##
166
+ # Initialize the DeliveryReceiptContext
167
+ # @param [Version] version Version that contains the resource
168
+ # @param [String] chat_service_sid The SID of the {Conversation
169
+ # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
170
+ # Message resource is associated with.
171
+ # @param [String] conversation_sid The unique ID of the
172
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
173
+ # for this message.
174
+ # @param [String] message_sid The SID of the message within a
175
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
176
+ # the delivery receipt belongs to.
177
+ # @param [String] sid A 34 character string that uniquely identifies this
178
+ # resource.
179
+ # @return [DeliveryReceiptContext] DeliveryReceiptContext
180
+ def initialize(version, chat_service_sid, conversation_sid, message_sid, sid)
181
+ super(version)
182
+
183
+ # Path Solution
184
+ @solution = {
185
+ chat_service_sid: chat_service_sid,
186
+ conversation_sid: conversation_sid,
187
+ message_sid: message_sid,
188
+ sid: sid,
189
+ }
190
+ @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Messages/#{@solution[:message_sid]}/Receipts/#{@solution[:sid]}"
191
+ end
192
+
193
+ ##
194
+ # Fetch the DeliveryReceiptInstance
195
+ # @return [DeliveryReceiptInstance] Fetched DeliveryReceiptInstance
196
+ def fetch
197
+ payload = @version.fetch('GET', @uri)
198
+
199
+ DeliveryReceiptInstance.new(
200
+ @version,
201
+ payload,
202
+ chat_service_sid: @solution[:chat_service_sid],
203
+ conversation_sid: @solution[:conversation_sid],
204
+ message_sid: @solution[:message_sid],
205
+ sid: @solution[:sid],
206
+ )
207
+ end
208
+
209
+ ##
210
+ # Provide a user friendly representation
211
+ def to_s
212
+ context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
213
+ "#<Twilio.Conversations.V1.DeliveryReceiptContext #{context}>"
214
+ end
215
+
216
+ ##
217
+ # Provide a detailed, user friendly representation
218
+ def inspect
219
+ context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
220
+ "#<Twilio.Conversations.V1.DeliveryReceiptContext #{context}>"
221
+ end
222
+ end
223
+
224
+ class DeliveryReceiptInstance < InstanceResource
225
+ ##
226
+ # Initialize the DeliveryReceiptInstance
227
+ # @param [Version] version Version that contains the resource
228
+ # @param [Hash] payload payload that contains response from Twilio
229
+ # @param [String] chat_service_sid The SID of the {Conversation
230
+ # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
231
+ # Message resource is associated with.
232
+ # @param [String] conversation_sid The unique ID of the
233
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
234
+ # for this message.
235
+ # @param [String] message_sid The SID of the message within a
236
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
237
+ # the delivery receipt belongs to
238
+ # @param [String] sid A 34 character string that uniquely identifies this
239
+ # resource.
240
+ # @return [DeliveryReceiptInstance] DeliveryReceiptInstance
241
+ def initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, message_sid: nil, sid: nil)
242
+ super(version)
243
+
244
+ # Marshaled Properties
245
+ @properties = {
246
+ 'account_sid' => payload['account_sid'],
247
+ 'chat_service_sid' => payload['chat_service_sid'],
248
+ 'conversation_sid' => payload['conversation_sid'],
249
+ 'message_sid' => payload['message_sid'],
250
+ 'sid' => payload['sid'],
251
+ 'channel_message_sid' => payload['channel_message_sid'],
252
+ 'participant_sid' => payload['participant_sid'],
253
+ 'status' => payload['status'],
254
+ 'error_code' => payload['error_code'].to_i,
255
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
256
+ 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
257
+ 'url' => payload['url'],
258
+ }
259
+
260
+ # Context
261
+ @instance_context = nil
262
+ @params = {
263
+ 'chat_service_sid' => chat_service_sid,
264
+ 'conversation_sid' => conversation_sid,
265
+ 'message_sid' => message_sid,
266
+ 'sid' => sid || @properties['sid'],
267
+ }
268
+ end
269
+
270
+ ##
271
+ # Generate an instance context for the instance, the context is capable of
272
+ # performing various actions. All instance actions are proxied to the context
273
+ # @return [DeliveryReceiptContext] DeliveryReceiptContext for this DeliveryReceiptInstance
274
+ def context
275
+ unless @instance_context
276
+ @instance_context = DeliveryReceiptContext.new(
277
+ @version,
278
+ @params['chat_service_sid'],
279
+ @params['conversation_sid'],
280
+ @params['message_sid'],
281
+ @params['sid'],
282
+ )
283
+ end
284
+ @instance_context
285
+ end
286
+
287
+ ##
288
+ # @return [String] The unique ID of the Account responsible for this participant.
289
+ def account_sid
290
+ @properties['account_sid']
291
+ end
292
+
293
+ ##
294
+ # @return [String] The SID of the Conversation Service that the resource is associated with.
295
+ def chat_service_sid
296
+ @properties['chat_service_sid']
297
+ end
298
+
299
+ ##
300
+ # @return [String] The unique ID of the Conversation for this message.
301
+ def conversation_sid
302
+ @properties['conversation_sid']
303
+ end
304
+
305
+ ##
306
+ # @return [String] The SID of the message the delivery receipt belongs to
307
+ def message_sid
308
+ @properties['message_sid']
309
+ end
310
+
311
+ ##
312
+ # @return [String] A 34 character string that uniquely identifies this resource.
313
+ def sid
314
+ @properties['sid']
315
+ end
316
+
317
+ ##
318
+ # @return [String] A messaging channel-specific identifier for the message delivered to participant
319
+ def channel_message_sid
320
+ @properties['channel_message_sid']
321
+ end
322
+
323
+ ##
324
+ # @return [String] The unique ID of the participant the delivery receipt belongs to.
325
+ def participant_sid
326
+ @properties['participant_sid']
327
+ end
328
+
329
+ ##
330
+ # @return [delivery_receipt.DeliveryStatus] The message delivery status
331
+ def status
332
+ @properties['status']
333
+ end
334
+
335
+ ##
336
+ # @return [String] The message {delivery error code}[https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors] for a `failed` status
337
+ def error_code
338
+ @properties['error_code']
339
+ end
340
+
341
+ ##
342
+ # @return [Time] The date that this resource was created.
343
+ def date_created
344
+ @properties['date_created']
345
+ end
346
+
347
+ ##
348
+ # @return [Time] The date that this resource was last updated.
349
+ def date_updated
350
+ @properties['date_updated']
351
+ end
352
+
353
+ ##
354
+ # @return [String] An absolute URL for this delivery receipt.
355
+ def url
356
+ @properties['url']
357
+ end
358
+
359
+ ##
360
+ # Fetch the DeliveryReceiptInstance
361
+ # @return [DeliveryReceiptInstance] Fetched DeliveryReceiptInstance
362
+ def fetch
363
+ context.fetch
364
+ end
365
+
366
+ ##
367
+ # Provide a user friendly representation
368
+ def to_s
369
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
370
+ "<Twilio.Conversations.V1.DeliveryReceiptInstance #{values}>"
371
+ end
372
+
373
+ ##
374
+ # Provide a detailed, user friendly representation
375
+ def inspect
376
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
377
+ "<Twilio.Conversations.V1.DeliveryReceiptInstance #{values}>"
378
+ end
379
+ end
380
+ end
381
+ end
382
+ end
383
+ end
384
+ end
385
+ end
386
+ end
@@ -0,0 +1,511 @@
1
+ ##
2
+ # This code was generated by
3
+ # \ / _ _ _| _ _
4
+ # | (_)\/(_)(_|\/| |(/_ v1.0.0
5
+ # / /
6
+ #
7
+ # frozen_string_literal: true
8
+
9
+ module Twilio
10
+ module REST
11
+ class Conversations < Domain
12
+ class V1 < Version
13
+ class ServiceContext < InstanceContext
14
+ class ConversationContext < InstanceContext
15
+ class ParticipantList < ListResource
16
+ ##
17
+ # Initialize the ParticipantList
18
+ # @param [Version] version Version that contains the resource
19
+ # @param [String] chat_service_sid The SID of the {Conversation
20
+ # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
21
+ # Participant resource is associated with.
22
+ # @param [String] conversation_sid The unique ID of the
23
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
24
+ # for this participant.
25
+ # @return [ParticipantList] ParticipantList
26
+ def initialize(version, chat_service_sid: nil, conversation_sid: nil)
27
+ super(version)
28
+
29
+ # Path Solution
30
+ @solution = {chat_service_sid: chat_service_sid, conversation_sid: conversation_sid}
31
+ @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Participants"
32
+ end
33
+
34
+ ##
35
+ # Create the ParticipantInstance
36
+ # @param [String] identity A unique string identifier for the conversation
37
+ # participant as {Conversation
38
+ # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
39
+ # parameter is non-null if (and only if) the participant is using the Conversation
40
+ # SDK to communicate. Limited to 256 characters.
41
+ # @param [String] messaging_binding_address The address of the participant's
42
+ # device, e.g. a phone or WhatsApp number. Together with the Proxy address, this
43
+ # determines a participant uniquely. This field (with proxy_address) is only null
44
+ # when the participant is interacting from an SDK endpoint (see the 'identity'
45
+ # field).
46
+ # @param [String] messaging_binding_proxy_address The address of the Twilio phone
47
+ # number (or WhatsApp number) that the participant is in contact with. This field,
48
+ # together with participant address, is only null when the participant is
49
+ # interacting from an SDK endpoint (see the 'identity' field).
50
+ # @param [Time] date_created The date that this resource was created.
51
+ # @param [Time] date_updated The date that this resource was last updated.
52
+ # @param [String] attributes An optional string metadata field you can use to
53
+ # store any data you wish. The string value must contain structurally valid JSON
54
+ # if specified. **Note** that if the attributes are not set "{}" will be
55
+ # returned.
56
+ # @param [String] messaging_binding_projected_address The address of the Twilio
57
+ # phone number that is used in Group MMS. Communication mask for the Conversation
58
+ # participant with Identity.
59
+ # @param [String] role_sid The SID of a conversation-level
60
+ # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to
61
+ # the participant.
62
+ # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
63
+ # X-Twilio-Webhook-Enabled HTTP request header
64
+ # @return [ParticipantInstance] Created ParticipantInstance
65
+ def create(identity: :unset, messaging_binding_address: :unset, messaging_binding_proxy_address: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_binding_projected_address: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset)
66
+ data = Twilio::Values.of({
67
+ 'Identity' => identity,
68
+ 'MessagingBinding.Address' => messaging_binding_address,
69
+ 'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
70
+ 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
71
+ 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
72
+ 'Attributes' => attributes,
73
+ 'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
74
+ 'RoleSid' => role_sid,
75
+ })
76
+ headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
77
+
78
+ payload = @version.create('POST', @uri, data: data, headers: headers)
79
+
80
+ ParticipantInstance.new(
81
+ @version,
82
+ payload,
83
+ chat_service_sid: @solution[:chat_service_sid],
84
+ conversation_sid: @solution[:conversation_sid],
85
+ )
86
+ end
87
+
88
+ ##
89
+ # Lists ParticipantInstance records from the API as a list.
90
+ # Unlike stream(), this operation is eager and will load `limit` records into
91
+ # memory before returning.
92
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
93
+ # guarantees to never return more than limit. Default is no limit
94
+ # @param [Integer] page_size Number of records to fetch per request, when
95
+ # not set will use the default value of 50 records. If no page_size is defined
96
+ # but a limit is defined, stream() will attempt to read the limit with the most
97
+ # efficient page size, i.e. min(limit, 1000)
98
+ # @return [Array] Array of up to limit results
99
+ def list(limit: nil, page_size: nil)
100
+ self.stream(limit: limit, page_size: page_size).entries
101
+ end
102
+
103
+ ##
104
+ # Streams ParticipantInstance records from the API as an Enumerable.
105
+ # This operation lazily loads records as efficiently as possible until the limit
106
+ # is reached.
107
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
108
+ # guarantees to never return more than limit. Default is no limit.
109
+ # @param [Integer] page_size Number of records to fetch per request, when
110
+ # not set will use the default value of 50 records. If no page_size is defined
111
+ # but a limit is defined, stream() will attempt to read the limit with the most
112
+ # efficient page size, i.e. min(limit, 1000)
113
+ # @return [Enumerable] Enumerable that will yield up to limit results
114
+ def stream(limit: nil, page_size: nil)
115
+ limits = @version.read_limits(limit, page_size)
116
+
117
+ page = self.page(page_size: limits[:page_size], )
118
+
119
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
120
+ end
121
+
122
+ ##
123
+ # When passed a block, yields ParticipantInstance records from the API.
124
+ # This operation lazily loads records as efficiently as possible until the limit
125
+ # is reached.
126
+ def each
127
+ limits = @version.read_limits
128
+
129
+ page = self.page(page_size: limits[:page_size], )
130
+
131
+ @version.stream(page,
132
+ limit: limits[:limit],
133
+ page_limit: limits[:page_limit]).each {|x| yield x}
134
+ end
135
+
136
+ ##
137
+ # Retrieve a single page of ParticipantInstance records from the API.
138
+ # Request is executed immediately.
139
+ # @param [String] page_token PageToken provided by the API
140
+ # @param [Integer] page_number Page Number, this value is simply for client state
141
+ # @param [Integer] page_size Number of records to return, defaults to 50
142
+ # @return [Page] Page of ParticipantInstance
143
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
144
+ params = Twilio::Values.of({
145
+ 'PageToken' => page_token,
146
+ 'Page' => page_number,
147
+ 'PageSize' => page_size,
148
+ })
149
+
150
+ response = @version.page('GET', @uri, params: params)
151
+
152
+ ParticipantPage.new(@version, response, @solution)
153
+ end
154
+
155
+ ##
156
+ # Retrieve a single page of ParticipantInstance records from the API.
157
+ # Request is executed immediately.
158
+ # @param [String] target_url API-generated URL for the requested results page
159
+ # @return [Page] Page of ParticipantInstance
160
+ def get_page(target_url)
161
+ response = @version.domain.request(
162
+ 'GET',
163
+ target_url
164
+ )
165
+ ParticipantPage.new(@version, response, @solution)
166
+ end
167
+
168
+ ##
169
+ # Provide a user friendly representation
170
+ def to_s
171
+ '#<Twilio.Conversations.V1.ParticipantList>'
172
+ end
173
+ end
174
+
175
+ class ParticipantPage < Page
176
+ ##
177
+ # Initialize the ParticipantPage
178
+ # @param [Version] version Version that contains the resource
179
+ # @param [Response] response Response from the API
180
+ # @param [Hash] solution Path solution for the resource
181
+ # @return [ParticipantPage] ParticipantPage
182
+ def initialize(version, response, solution)
183
+ super(version, response)
184
+
185
+ # Path Solution
186
+ @solution = solution
187
+ end
188
+
189
+ ##
190
+ # Build an instance of ParticipantInstance
191
+ # @param [Hash] payload Payload response from the API
192
+ # @return [ParticipantInstance] ParticipantInstance
193
+ def get_instance(payload)
194
+ ParticipantInstance.new(
195
+ @version,
196
+ payload,
197
+ chat_service_sid: @solution[:chat_service_sid],
198
+ conversation_sid: @solution[:conversation_sid],
199
+ )
200
+ end
201
+
202
+ ##
203
+ # Provide a user friendly representation
204
+ def to_s
205
+ '<Twilio.Conversations.V1.ParticipantPage>'
206
+ end
207
+ end
208
+
209
+ class ParticipantContext < InstanceContext
210
+ ##
211
+ # Initialize the ParticipantContext
212
+ # @param [Version] version Version that contains the resource
213
+ # @param [String] chat_service_sid The SID of the {Conversation
214
+ # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
215
+ # Participant resource is associated with.
216
+ # @param [String] conversation_sid The unique ID of the
217
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
218
+ # for this participant.
219
+ # @param [String] sid A 34 character string that uniquely identifies this
220
+ # resource.
221
+ # @return [ParticipantContext] ParticipantContext
222
+ def initialize(version, chat_service_sid, conversation_sid, sid)
223
+ super(version)
224
+
225
+ # Path Solution
226
+ @solution = {chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, sid: sid, }
227
+ @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Participants/#{@solution[:sid]}"
228
+ end
229
+
230
+ ##
231
+ # Update the ParticipantInstance
232
+ # @param [Time] date_created The date that this resource was created.
233
+ # @param [Time] date_updated The date that this resource was last updated.
234
+ # @param [String] identity A unique string identifier for the conversation
235
+ # participant as {Conversation
236
+ # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
237
+ # parameter is non-null if (and only if) the participant is using the Conversation
238
+ # SDK to communicate. Limited to 256 characters.
239
+ # @param [String] attributes An optional string metadata field you can use to
240
+ # store any data you wish. The string value must contain structurally valid JSON
241
+ # if specified. **Note** that if the attributes are not set "{}" will be
242
+ # returned.
243
+ # @param [String] role_sid The SID of a conversation-level
244
+ # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to
245
+ # the participant.
246
+ # @param [String] messaging_binding_proxy_address The address of the Twilio phone
247
+ # number that the participant is in contact with. 'null' value will remove it.
248
+ # @param [String] messaging_binding_projected_address The address of the Twilio
249
+ # phone number that is used in Group MMS. 'null' value will remove it.
250
+ # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
251
+ # X-Twilio-Webhook-Enabled HTTP request header
252
+ # @return [ParticipantInstance] Updated ParticipantInstance
253
+ def update(date_created: :unset, date_updated: :unset, identity: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, x_twilio_webhook_enabled: :unset)
254
+ data = Twilio::Values.of({
255
+ 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
256
+ 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
257
+ 'Identity' => identity,
258
+ 'Attributes' => attributes,
259
+ 'RoleSid' => role_sid,
260
+ 'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
261
+ 'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
262
+ })
263
+ headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
264
+
265
+ payload = @version.update('POST', @uri, data: data, headers: headers)
266
+
267
+ ParticipantInstance.new(
268
+ @version,
269
+ payload,
270
+ chat_service_sid: @solution[:chat_service_sid],
271
+ conversation_sid: @solution[:conversation_sid],
272
+ sid: @solution[:sid],
273
+ )
274
+ end
275
+
276
+ ##
277
+ # Delete the ParticipantInstance
278
+ # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
279
+ # X-Twilio-Webhook-Enabled HTTP request header
280
+ # @return [Boolean] true if delete succeeds, false otherwise
281
+ def delete(x_twilio_webhook_enabled: :unset)
282
+ headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
283
+
284
+ @version.delete('DELETE', @uri, headers: headers)
285
+ end
286
+
287
+ ##
288
+ # Fetch the ParticipantInstance
289
+ # @return [ParticipantInstance] Fetched ParticipantInstance
290
+ def fetch
291
+ payload = @version.fetch('GET', @uri)
292
+
293
+ ParticipantInstance.new(
294
+ @version,
295
+ payload,
296
+ chat_service_sid: @solution[:chat_service_sid],
297
+ conversation_sid: @solution[:conversation_sid],
298
+ sid: @solution[:sid],
299
+ )
300
+ end
301
+
302
+ ##
303
+ # Provide a user friendly representation
304
+ def to_s
305
+ context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
306
+ "#<Twilio.Conversations.V1.ParticipantContext #{context}>"
307
+ end
308
+
309
+ ##
310
+ # Provide a detailed, user friendly representation
311
+ def inspect
312
+ context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
313
+ "#<Twilio.Conversations.V1.ParticipantContext #{context}>"
314
+ end
315
+ end
316
+
317
+ class ParticipantInstance < InstanceResource
318
+ ##
319
+ # Initialize the ParticipantInstance
320
+ # @param [Version] version Version that contains the resource
321
+ # @param [Hash] payload payload that contains response from Twilio
322
+ # @param [String] chat_service_sid The SID of the {Conversation
323
+ # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
324
+ # Participant resource is associated with.
325
+ # @param [String] conversation_sid The unique ID of the
326
+ # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
327
+ # for this participant.
328
+ # @param [String] sid A 34 character string that uniquely identifies this
329
+ # resource.
330
+ # @return [ParticipantInstance] ParticipantInstance
331
+ def initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, sid: nil)
332
+ super(version)
333
+
334
+ # Marshaled Properties
335
+ @properties = {
336
+ 'account_sid' => payload['account_sid'],
337
+ 'chat_service_sid' => payload['chat_service_sid'],
338
+ 'conversation_sid' => payload['conversation_sid'],
339
+ 'sid' => payload['sid'],
340
+ 'identity' => payload['identity'],
341
+ 'attributes' => payload['attributes'],
342
+ 'messaging_binding' => payload['messaging_binding'],
343
+ 'role_sid' => payload['role_sid'],
344
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
345
+ 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
346
+ 'url' => payload['url'],
347
+ }
348
+
349
+ # Context
350
+ @instance_context = nil
351
+ @params = {
352
+ 'chat_service_sid' => chat_service_sid,
353
+ 'conversation_sid' => conversation_sid,
354
+ 'sid' => sid || @properties['sid'],
355
+ }
356
+ end
357
+
358
+ ##
359
+ # Generate an instance context for the instance, the context is capable of
360
+ # performing various actions. All instance actions are proxied to the context
361
+ # @return [ParticipantContext] ParticipantContext for this ParticipantInstance
362
+ def context
363
+ unless @instance_context
364
+ @instance_context = ParticipantContext.new(
365
+ @version,
366
+ @params['chat_service_sid'],
367
+ @params['conversation_sid'],
368
+ @params['sid'],
369
+ )
370
+ end
371
+ @instance_context
372
+ end
373
+
374
+ ##
375
+ # @return [String] The unique ID of the Account responsible for this participant.
376
+ def account_sid
377
+ @properties['account_sid']
378
+ end
379
+
380
+ ##
381
+ # @return [String] The SID of the Conversation Service that the resource is associated with.
382
+ def chat_service_sid
383
+ @properties['chat_service_sid']
384
+ end
385
+
386
+ ##
387
+ # @return [String] The unique ID of the Conversation for this participant.
388
+ def conversation_sid
389
+ @properties['conversation_sid']
390
+ end
391
+
392
+ ##
393
+ # @return [String] A 34 character string that uniquely identifies this resource.
394
+ def sid
395
+ @properties['sid']
396
+ end
397
+
398
+ ##
399
+ # @return [String] A unique string identifier for the conversation participant as Conversation User.
400
+ def identity
401
+ @properties['identity']
402
+ end
403
+
404
+ ##
405
+ # @return [String] An optional string metadata field you can use to store any data you wish.
406
+ def attributes
407
+ @properties['attributes']
408
+ end
409
+
410
+ ##
411
+ # @return [Hash] Information about how this participant exchanges messages with the conversation.
412
+ def messaging_binding
413
+ @properties['messaging_binding']
414
+ end
415
+
416
+ ##
417
+ # @return [String] The SID of a conversation-level Role to assign to the participant
418
+ def role_sid
419
+ @properties['role_sid']
420
+ end
421
+
422
+ ##
423
+ # @return [Time] The date that this resource was created.
424
+ def date_created
425
+ @properties['date_created']
426
+ end
427
+
428
+ ##
429
+ # @return [Time] The date that this resource was last updated.
430
+ def date_updated
431
+ @properties['date_updated']
432
+ end
433
+
434
+ ##
435
+ # @return [String] An absolute URL for this participant.
436
+ def url
437
+ @properties['url']
438
+ end
439
+
440
+ ##
441
+ # Update the ParticipantInstance
442
+ # @param [Time] date_created The date that this resource was created.
443
+ # @param [Time] date_updated The date that this resource was last updated.
444
+ # @param [String] identity A unique string identifier for the conversation
445
+ # participant as {Conversation
446
+ # User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
447
+ # parameter is non-null if (and only if) the participant is using the Conversation
448
+ # SDK to communicate. Limited to 256 characters.
449
+ # @param [String] attributes An optional string metadata field you can use to
450
+ # store any data you wish. The string value must contain structurally valid JSON
451
+ # if specified. **Note** that if the attributes are not set "{}" will be
452
+ # returned.
453
+ # @param [String] role_sid The SID of a conversation-level
454
+ # {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to
455
+ # the participant.
456
+ # @param [String] messaging_binding_proxy_address The address of the Twilio phone
457
+ # number that the participant is in contact with. 'null' value will remove it.
458
+ # @param [String] messaging_binding_projected_address The address of the Twilio
459
+ # phone number that is used in Group MMS. 'null' value will remove it.
460
+ # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
461
+ # X-Twilio-Webhook-Enabled HTTP request header
462
+ # @return [ParticipantInstance] Updated ParticipantInstance
463
+ def update(date_created: :unset, date_updated: :unset, identity: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, x_twilio_webhook_enabled: :unset)
464
+ context.update(
465
+ date_created: date_created,
466
+ date_updated: date_updated,
467
+ identity: identity,
468
+ attributes: attributes,
469
+ role_sid: role_sid,
470
+ messaging_binding_proxy_address: messaging_binding_proxy_address,
471
+ messaging_binding_projected_address: messaging_binding_projected_address,
472
+ x_twilio_webhook_enabled: x_twilio_webhook_enabled,
473
+ )
474
+ end
475
+
476
+ ##
477
+ # Delete the ParticipantInstance
478
+ # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
479
+ # X-Twilio-Webhook-Enabled HTTP request header
480
+ # @return [Boolean] true if delete succeeds, false otherwise
481
+ def delete(x_twilio_webhook_enabled: :unset)
482
+ context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
483
+ end
484
+
485
+ ##
486
+ # Fetch the ParticipantInstance
487
+ # @return [ParticipantInstance] Fetched ParticipantInstance
488
+ def fetch
489
+ context.fetch
490
+ end
491
+
492
+ ##
493
+ # Provide a user friendly representation
494
+ def to_s
495
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
496
+ "<Twilio.Conversations.V1.ParticipantInstance #{values}>"
497
+ end
498
+
499
+ ##
500
+ # Provide a detailed, user friendly representation
501
+ def inspect
502
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
503
+ "<Twilio.Conversations.V1.ParticipantInstance #{values}>"
504
+ end
505
+ end
506
+ end
507
+ end
508
+ end
509
+ end
510
+ end
511
+ end