twilio-ruby 5.45.1 → 5.49.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (232) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +1 -0
  3. data/CHANGES.md +108 -0
  4. data/LICENSE +1 -1
  5. data/README.md +16 -2
  6. data/lib/twilio-ruby/rest/api.rb +1 -1
  7. data/lib/twilio-ruby/rest/api/v2010.rb +5 -4
  8. data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +1 -1
  9. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +8 -8
  10. data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb +4 -4
  11. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +17 -17
  12. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +1 -1
  13. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +4 -4
  14. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +11 -11
  15. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +3 -3
  16. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +5 -5
  17. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +6 -3
  18. data/lib/twilio-ruby/rest/api/v2010/account/token.rb +1 -1
  19. data/lib/twilio-ruby/rest/autopilot/v1.rb +5 -4
  20. data/lib/twilio-ruby/rest/bulkexports.rb +4 -2
  21. data/lib/twilio-ruby/rest/bulkexports/v1.rb +14 -10
  22. data/lib/twilio-ruby/rest/bulkexports/v1/export.rb +7 -4
  23. data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +7 -4
  24. data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb +5 -3
  25. data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb +5 -3
  26. data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb +5 -3
  27. data/lib/twilio-ruby/rest/chat/v1.rb +10 -8
  28. data/lib/twilio-ruby/rest/chat/v1/service.rb +5 -5
  29. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +6 -6
  30. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +3 -3
  31. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +3 -3
  32. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +9 -9
  33. data/lib/twilio-ruby/rest/chat/v2.rb +10 -8
  34. data/lib/twilio-ruby/rest/chat/v2/service.rb +5 -5
  35. data/lib/twilio-ruby/rest/chat/v2/service/binding.rb +7 -7
  36. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +6 -6
  37. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +3 -3
  38. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +3 -3
  39. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +27 -24
  40. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +9 -9
  41. data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb +10 -10
  42. data/lib/twilio-ruby/rest/client.rb +8 -1
  43. data/lib/twilio-ruby/rest/conversations/v1.rb +25 -20
  44. data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb +9 -9
  45. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +1 -1
  46. data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +9 -9
  47. data/lib/twilio-ruby/rest/conversations/v1/role.rb +9 -9
  48. data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +7 -7
  49. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +1 -1
  50. data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +9 -9
  51. data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +9 -9
  52. data/lib/twilio-ruby/rest/events/v1.rb +20 -16
  53. data/lib/twilio-ruby/rest/events/v1/event_type.rb +4 -4
  54. data/lib/twilio-ruby/rest/events/v1/schema.rb +4 -4
  55. data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb +4 -4
  56. data/lib/twilio-ruby/rest/events/v1/sink.rb +8 -6
  57. data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb +3 -3
  58. data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb +3 -3
  59. data/lib/twilio-ruby/rest/events/v1/subscription.rb +7 -6
  60. data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +3 -3
  61. data/lib/twilio-ruby/rest/fax/v1.rb +5 -4
  62. data/lib/twilio-ruby/rest/flex_api/v1.rb +15 -12
  63. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +18 -4
  64. data/lib/twilio-ruby/rest/insights.rb +1 -1
  65. data/lib/twilio-ruby/rest/insights/v1.rb +11 -9
  66. data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +8 -9
  67. data/lib/twilio-ruby/rest/insights/v1/room.rb +55 -43
  68. data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +22 -22
  69. data/lib/twilio-ruby/rest/ip_messaging/v1.rb +10 -8
  70. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +3 -3
  71. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +3 -3
  72. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +3 -3
  73. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +3 -3
  74. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +4 -4
  75. data/lib/twilio-ruby/rest/ip_messaging/v2.rb +10 -8
  76. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +3 -3
  77. data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb +7 -7
  78. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +3 -3
  79. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +3 -3
  80. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +3 -3
  81. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +6 -6
  82. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +4 -4
  83. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb +4 -4
  84. data/lib/twilio-ruby/rest/lookups/v1.rb +5 -4
  85. data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +16 -16
  86. data/lib/twilio-ruby/rest/messaging.rb +8 -0
  87. data/lib/twilio-ruby/rest/messaging/v1.rb +21 -4
  88. data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb +328 -0
  89. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +1 -1
  90. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +1 -1
  91. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +1 -1
  92. data/lib/twilio-ruby/rest/monitor/v1.rb +10 -8
  93. data/lib/twilio-ruby/rest/notify/v1.rb +10 -8
  94. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +16 -15
  95. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +18 -18
  96. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb +1 -1
  97. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb +1 -1
  98. data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb +1 -1
  99. data/lib/twilio-ruby/rest/preview.rb +4 -2
  100. data/lib/twilio-ruby/rest/preview/bulk_exports.rb +14 -10
  101. data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb +7 -4
  102. data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb +7 -4
  103. data/lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb +5 -3
  104. data/lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb +5 -3
  105. data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb +5 -3
  106. data/lib/twilio-ruby/rest/preview/deployed_devices.rb +5 -4
  107. data/lib/twilio-ruby/rest/preview/hosted_numbers.rb +10 -8
  108. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +13 -13
  109. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +2 -2
  110. data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb +8 -8
  111. data/lib/twilio-ruby/rest/preview/marketplace.rb +10 -8
  112. data/lib/twilio-ruby/rest/preview/sync.rb +5 -4
  113. data/lib/twilio-ruby/rest/preview/sync/service/document.rb +4 -8
  114. data/lib/twilio-ruby/rest/preview/trusted_comms.rb +5 -4
  115. data/lib/twilio-ruby/rest/preview/understand.rb +5 -4
  116. data/lib/twilio-ruby/rest/preview/wireless.rb +15 -12
  117. data/lib/twilio-ruby/rest/preview/wireless/rate_plan.rb +2 -2
  118. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +2 -2
  119. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +1 -1
  120. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +2 -2
  121. data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +2 -2
  122. data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb +1 -1
  123. data/lib/twilio-ruby/rest/proxy/v1.rb +5 -4
  124. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +1 -1
  125. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +1 -1
  126. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb +1 -1
  127. data/lib/twilio-ruby/rest/serverless/v1.rb +5 -4
  128. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +17 -7
  129. data/lib/twilio-ruby/rest/studio/v1.rb +5 -4
  130. data/lib/twilio-ruby/rest/studio/v2.rb +5 -4
  131. data/lib/twilio-ruby/rest/studio/v2/flow.rb +6 -14
  132. data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +0 -8
  133. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_context.rb +0 -8
  134. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb +0 -8
  135. data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step/execution_step_context.rb +0 -8
  136. data/lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb +2 -10
  137. data/lib/twilio-ruby/rest/studio/v2/flow/test_user.rb +10 -16
  138. data/lib/twilio-ruby/rest/studio/v2/flow_validate.rb +6 -11
  139. data/lib/twilio-ruby/rest/supersim/v1.rb +25 -20
  140. data/lib/twilio-ruby/rest/supersim/v1/command.rb +4 -4
  141. data/lib/twilio-ruby/rest/supersim/v1/fleet.rb +33 -12
  142. data/lib/twilio-ruby/rest/supersim/v1/network.rb +5 -5
  143. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb +6 -6
  144. data/lib/twilio-ruby/rest/supersim/v1/network_access_profile/network_access_profile_network.rb +5 -5
  145. data/lib/twilio-ruby/rest/supersim/v1/sim.rb +4 -4
  146. data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb +3 -3
  147. data/lib/twilio-ruby/rest/sync/v1.rb +5 -4
  148. data/lib/twilio-ruby/rest/sync/v1/service.rb +0 -8
  149. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +25 -52
  150. data/lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb +0 -8
  151. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +18 -40
  152. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +46 -76
  153. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb +0 -8
  154. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +18 -40
  155. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +47 -79
  156. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +1 -9
  157. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +14 -38
  158. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +1 -7
  159. data/lib/twilio-ruby/rest/taskrouter/v1.rb +5 -4
  160. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +17 -17
  161. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +10 -10
  162. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +1 -1
  163. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +10 -10
  164. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +1 -1
  165. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +1 -1
  166. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +1 -1
  167. data/lib/twilio-ruby/rest/trunking/v1.rb +5 -4
  168. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +1 -1
  169. data/lib/twilio-ruby/rest/trusthub.rb +100 -0
  170. data/lib/twilio-ruby/rest/trusthub/v1.rb +146 -0
  171. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb +523 -0
  172. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb +359 -0
  173. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb +330 -0
  174. data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_evaluations.rb +328 -0
  175. data/lib/twilio-ruby/rest/trusthub/v1/end_user.rb +356 -0
  176. data/lib/twilio-ruby/rest/trusthub/v1/end_user_type.rb +271 -0
  177. data/lib/twilio-ruby/rest/trusthub/v1/policies.rb +262 -0
  178. data/lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb +369 -0
  179. data/lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb +271 -0
  180. data/lib/twilio-ruby/rest/trusthub/v1/trust_products.rb +523 -0
  181. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb +359 -0
  182. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_entity_assignments.rb +330 -0
  183. data/lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_evaluations.rb +328 -0
  184. data/lib/twilio-ruby/rest/verify.rb +9 -0
  185. data/lib/twilio-ruby/rest/verify/v2.rb +26 -8
  186. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +7 -6
  187. data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +64 -13
  188. data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +1 -1
  189. data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb +10 -10
  190. data/lib/twilio-ruby/rest/verify/v2/verification_attempt.rb +329 -0
  191. data/lib/twilio-ruby/rest/video/v1.rb +20 -16
  192. data/lib/twilio-ruby/rest/video/v1/composition.rb +16 -15
  193. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +26 -26
  194. data/lib/twilio-ruby/rest/video/v1/recording.rb +6 -6
  195. data/lib/twilio-ruby/rest/video/v1/room.rb +10 -3
  196. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +1 -1
  197. data/lib/twilio-ruby/rest/video/v1/room/room_recording_rule.rb +1 -1
  198. data/lib/twilio-ruby/rest/voice/v1.rb +20 -16
  199. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +1 -1
  200. data/lib/twilio-ruby/rest/wireless/v1.rb +15 -12
  201. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +4 -4
  202. data/lib/twilio-ruby/twiml/voice_response.rb +38 -8
  203. data/lib/twilio-ruby/version.rb +1 -1
  204. data/spec/integration/api/v2010/account/conference_spec.rb +302 -44
  205. data/spec/integration/api/v2010/account/incoming_phone_number_spec.rb +4 -16
  206. data/spec/integration/api/v2010/account/message_spec.rb +37 -0
  207. data/spec/integration/events/v1/sink_spec.rb +14 -0
  208. data/spec/integration/flex_api/v1/configuration_spec.rb +24 -0
  209. data/spec/integration/insights/v1/call/summary_spec.rb +1 -0
  210. data/spec/integration/messaging/v1/brand_registration_spec.rb +143 -0
  211. data/spec/integration/preview/sync/service/document_spec.rb +1 -3
  212. data/spec/integration/serverless/v1/service/build_spec.rb +12 -2
  213. data/spec/integration/supersim/v1/fleet_spec.rb +8 -0
  214. data/spec/integration/sync/v1/service/document_spec.rb +1 -3
  215. data/spec/integration/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment_spec.rb +192 -0
  216. data/spec/integration/trusthub/v1/customer_profiles/customer_profiles_entity_assignments_spec.rb +186 -0
  217. data/spec/integration/trusthub/v1/customer_profiles/customer_profiles_evaluations_spec.rb +615 -0
  218. data/spec/integration/trusthub/v1/customer_profiles_spec.rb +255 -0
  219. data/spec/integration/trusthub/v1/end_user_spec.rb +247 -0
  220. data/spec/integration/trusthub/v1/end_user_type_spec.rb +176 -0
  221. data/spec/integration/trusthub/v1/policies_spec.rb +252 -0
  222. data/spec/integration/trusthub/v1/supporting_document_spec.rb +235 -0
  223. data/spec/integration/trusthub/v1/supporting_document_type_spec.rb +159 -0
  224. data/spec/integration/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment_spec.rb +192 -0
  225. data/spec/integration/trusthub/v1/trust_products/trust_products_entity_assignments_spec.rb +186 -0
  226. data/spec/integration/trusthub/v1/trust_products/trust_products_evaluations_spec.rb +615 -0
  227. data/spec/integration/trusthub/v1/trust_products_spec.rb +255 -0
  228. data/spec/integration/verify/v2/service/entity/factor_spec.rb +3 -3
  229. data/spec/integration/verify/v2/verification_attempt_spec.rb +146 -0
  230. data/spec/integration/video/v1/room_spec.rb +5 -0
  231. data/spec/twiml/voice_response_spec.rb +1 -1
  232. metadata +49 -2
@@ -12,8 +12,6 @@ module Twilio
12
12
  class V1 < Version
13
13
  class ServiceContext < InstanceContext
14
14
  class SyncListContext < InstanceContext
15
- ##
16
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
17
15
  class SyncListPermissionList < ListResource
18
16
  ##
19
17
  # Initialize the SyncListPermissionList
@@ -119,8 +117,6 @@ module Twilio
119
117
  end
120
118
  end
121
119
 
122
- ##
123
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
124
120
  class SyncListPermissionPage < Page
125
121
  ##
126
122
  # Initialize the SyncListPermissionPage
@@ -155,8 +151,6 @@ module Twilio
155
151
  end
156
152
  end
157
153
 
158
- ##
159
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
160
154
  class SyncListPermissionContext < InstanceContext
161
155
  ##
162
156
  # Initialize the SyncListPermissionContext
@@ -237,8 +231,6 @@ module Twilio
237
231
  end
238
232
  end
239
233
 
240
- ##
241
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
242
234
  class SyncListPermissionInstance < InstanceResource
243
235
  ##
244
236
  # Initialize the SyncListPermissionInstance
@@ -11,8 +11,6 @@ module Twilio
11
11
  class Sync < Domain
12
12
  class V1 < Version
13
13
  class ServiceContext < InstanceContext
14
- ##
15
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
14
  class SyncMapList < ListResource
17
15
  ##
18
16
  # Initialize the SyncMapList
@@ -36,11 +34,9 @@ module Twilio
36
34
  # URL path to address the resource.
37
35
  # @param [String] ttl An alias for `collection_ttl`. If both parameters are
38
36
  # provided, this value is ignored.
39
- # @param [String] collection_ttl How long, in seconds, before the Sync Map expires
40
- # (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
41
- # The default value is `0`, which means the Sync Map does not expire. The Sync Map
42
- # will be deleted automatically after it expires, but there can be a delay between
43
- # the expiration time and the resources's deletion.
37
+ # @param [String] collection_ttl How long, {in
38
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
39
+ # the Sync Map expires (time-to-live) and is deleted.
44
40
  # @return [SyncMapInstance] Created SyncMapInstance
45
41
  def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
46
42
  data = Twilio::Values.of({
@@ -58,9 +54,6 @@ module Twilio
58
54
  # Lists SyncMapInstance records from the API as a list.
59
55
  # Unlike stream(), this operation is eager and will load `limit` records into
60
56
  # memory before returning.
61
- # @param [sync_map.HideExpiredType] hide_expired The default list of Sync Maps
62
- # will show both active and expired items. It is possible to filter only the
63
- # active ones by hiding the expired ones.
64
57
  # @param [Integer] limit Upper limit for the number of records to return. stream()
65
58
  # guarantees to never return more than limit. Default is no limit
66
59
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -68,17 +61,14 @@ module Twilio
68
61
  # but a limit is defined, stream() will attempt to read the limit with the most
69
62
  # efficient page size, i.e. min(limit, 1000)
70
63
  # @return [Array] Array of up to limit results
71
- def list(hide_expired: :unset, limit: nil, page_size: nil)
72
- self.stream(hide_expired: hide_expired, limit: limit, page_size: page_size).entries
64
+ def list(limit: nil, page_size: nil)
65
+ self.stream(limit: limit, page_size: page_size).entries
73
66
  end
74
67
 
75
68
  ##
76
69
  # Streams SyncMapInstance records from the API as an Enumerable.
77
70
  # This operation lazily loads records as efficiently as possible until the limit
78
71
  # is reached.
79
- # @param [sync_map.HideExpiredType] hide_expired The default list of Sync Maps
80
- # will show both active and expired items. It is possible to filter only the
81
- # active ones by hiding the expired ones.
82
72
  # @param [Integer] limit Upper limit for the number of records to return. stream()
83
73
  # guarantees to never return more than limit. Default is no limit.
84
74
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -86,10 +76,10 @@ module Twilio
86
76
  # but a limit is defined, stream() will attempt to read the limit with the most
87
77
  # efficient page size, i.e. min(limit, 1000)
88
78
  # @return [Enumerable] Enumerable that will yield up to limit results
89
- def stream(hide_expired: :unset, limit: nil, page_size: nil)
79
+ def stream(limit: nil, page_size: nil)
90
80
  limits = @version.read_limits(limit, page_size)
91
81
 
92
- page = self.page(hide_expired: hide_expired, page_size: limits[:page_size], )
82
+ page = self.page(page_size: limits[:page_size], )
93
83
 
94
84
  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
95
85
  end
@@ -111,16 +101,12 @@ module Twilio
111
101
  ##
112
102
  # Retrieve a single page of SyncMapInstance records from the API.
113
103
  # Request is executed immediately.
114
- # @param [sync_map.HideExpiredType] hide_expired The default list of Sync Maps
115
- # will show both active and expired items. It is possible to filter only the
116
- # active ones by hiding the expired ones.
117
104
  # @param [String] page_token PageToken provided by the API
118
105
  # @param [Integer] page_number Page Number, this value is simply for client state
119
106
  # @param [Integer] page_size Number of records to return, defaults to 50
120
107
  # @return [Page] Page of SyncMapInstance
121
- def page(hide_expired: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
108
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
122
109
  params = Twilio::Values.of({
123
- 'HideExpired' => hide_expired,
124
110
  'PageToken' => page_token,
125
111
  'Page' => page_number,
126
112
  'PageSize' => page_size,
@@ -151,8 +137,6 @@ module Twilio
151
137
  end
152
138
  end
153
139
 
154
- ##
155
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
156
140
  class SyncMapPage < Page
157
141
  ##
158
142
  # Initialize the SyncMapPage
@@ -182,8 +166,6 @@ module Twilio
182
166
  end
183
167
  end
184
168
 
185
- ##
186
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
187
169
  class SyncMapContext < InstanceContext
188
170
  ##
189
171
  # Initialize the SyncMapContext
@@ -191,7 +173,8 @@ module Twilio
191
173
  # @param [String] service_sid The SID of the {Sync
192
174
  # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map
193
175
  # resource to fetch.
194
- # @param [String] sid The SID of the Sync Map resource to fetch.
176
+ # @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
177
+ # Map's `sid` or its `unique_name`.
195
178
  # @return [SyncMapContext] SyncMapContext
196
179
  def initialize(version, service_sid, sid)
197
180
  super(version)
@@ -225,11 +208,9 @@ module Twilio
225
208
  # Update the SyncMapInstance
226
209
  # @param [String] ttl An alias for `collection_ttl`. If both parameters are
227
210
  # provided, this value is ignored.
228
- # @param [String] collection_ttl How long, in seconds, before the Sync Map expires
229
- # (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
230
- # The default value is `0`, which means the Sync Map does not expire. The Sync Map
231
- # will be deleted automatically after it expires, but there can be a delay between
232
- # the expiration time and the resources's deletion.
211
+ # @param [String] collection_ttl How long, {in
212
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
213
+ # the Sync Map expires (time-to-live) and is deleted.
233
214
  # @return [SyncMapInstance] Updated SyncMapInstance
234
215
  def update(ttl: :unset, collection_ttl: :unset)
235
216
  data = Twilio::Values.of({'Ttl' => ttl, 'CollectionTtl' => collection_ttl, })
@@ -298,8 +279,6 @@ module Twilio
298
279
  end
299
280
  end
300
281
 
301
- ##
302
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
303
282
  class SyncMapInstance < InstanceResource
304
283
  ##
305
284
  # Initialize the SyncMapInstance
@@ -308,7 +287,8 @@ module Twilio
308
287
  # @param [String] service_sid The SID of the {Sync
309
288
  # Service}[https://www.twilio.com/docs/sync/api/service] the resource is
310
289
  # associated with.
311
- # @param [String] sid The SID of the Sync Map resource to fetch.
290
+ # @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
291
+ # Map's `sid` or its `unique_name`.
312
292
  # @return [SyncMapInstance] SyncMapInstance
313
293
  def initialize(version, payload, service_sid: nil, sid: nil)
314
294
  super(version)
@@ -428,11 +408,9 @@ module Twilio
428
408
  # Update the SyncMapInstance
429
409
  # @param [String] ttl An alias for `collection_ttl`. If both parameters are
430
410
  # provided, this value is ignored.
431
- # @param [String] collection_ttl How long, in seconds, before the Sync Map expires
432
- # (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
433
- # The default value is `0`, which means the Sync Map does not expire. The Sync Map
434
- # will be deleted automatically after it expires, but there can be a delay between
435
- # the expiration time and the resources's deletion.
411
+ # @param [String] collection_ttl How long, {in
412
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
413
+ # the Sync Map expires (time-to-live) and is deleted.
436
414
  # @return [SyncMapInstance] Updated SyncMapInstance
437
415
  def update(ttl: :unset, collection_ttl: :unset)
438
416
  context.update(ttl: ttl, collection_ttl: collection_ttl, )
@@ -12,8 +12,6 @@ module Twilio
12
12
  class V1 < Version
13
13
  class ServiceContext < InstanceContext
14
14
  class SyncMapContext < InstanceContext
15
- ##
16
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
17
15
  class SyncMapItemList < ListResource
18
16
  ##
19
17
  # Initialize the SyncMapItemList
@@ -36,20 +34,15 @@ module Twilio
36
34
  # @param [String] key The unique, user-defined key for the Map Item. Can be up to
37
35
  # 320 characters long.
38
36
  # @param [Hash] data A JSON string that represents an arbitrary, schema-less
39
- # object that the Map Item stores. Can be up to 16KB in length.
37
+ # object that the Map Item stores. Can be up to 16 KiB in length.
40
38
  # @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
41
39
  # this value is ignored.
42
- # @param [String] item_ttl How long, in seconds, before the Map Item expires
43
- # (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
44
- # The default value is `0`, which means the Map Item does not expire. The Map
45
- # Item will be deleted automatically after it expires, but there can be a delay
46
- # between the expiration time and the resources's deletion.
47
- # @param [String] collection_ttl How long, in seconds, before the Map Item's
48
- # parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0
49
- # to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
50
- # Map does not expire. The Sync Map will be deleted automatically after it
51
- # expires, but there can be a delay between the expiration time and the
52
- # resources's deletion.
40
+ # @param [String] item_ttl How long, {in
41
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
42
+ # the Map Item expires (time-to-live) and is deleted.
43
+ # @param [String] collection_ttl How long, {in
44
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
45
+ # the Map Item's parent Sync Map expires (time-to-live) and is deleted.
53
46
  # @return [SyncMapItemInstance] Created SyncMapItemInstance
54
47
  def create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
55
48
  data = Twilio::Values.of({
@@ -85,9 +78,6 @@ module Twilio
85
78
  # referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
86
79
  # referenced by the `from` parameter or `exclusive` to start with the next Map
87
80
  # Item. The default value is `inclusive`.
88
- # @param [sync_map_item.HideExpiredType] hide_expired The default list of Sync Map
89
- # items will show both active and expired items. It is possible to filter only the
90
- # active ones by hiding the expired ones.
91
81
  # @param [Integer] limit Upper limit for the number of records to return. stream()
92
82
  # guarantees to never return more than limit. Default is no limit
93
83
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -95,15 +85,8 @@ module Twilio
95
85
  # but a limit is defined, stream() will attempt to read the limit with the most
96
86
  # efficient page size, i.e. min(limit, 1000)
97
87
  # @return [Array] Array of up to limit results
98
- def list(order: :unset, from: :unset, bounds: :unset, hide_expired: :unset, limit: nil, page_size: nil)
99
- self.stream(
100
- order: order,
101
- from: from,
102
- bounds: bounds,
103
- hide_expired: hide_expired,
104
- limit: limit,
105
- page_size: page_size
106
- ).entries
88
+ def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
89
+ self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
107
90
  end
108
91
 
109
92
  ##
@@ -121,9 +104,6 @@ module Twilio
121
104
  # referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
122
105
  # referenced by the `from` parameter or `exclusive` to start with the next Map
123
106
  # Item. The default value is `inclusive`.
124
- # @param [sync_map_item.HideExpiredType] hide_expired The default list of Sync Map
125
- # items will show both active and expired items. It is possible to filter only the
126
- # active ones by hiding the expired ones.
127
107
  # @param [Integer] limit Upper limit for the number of records to return. stream()
128
108
  # guarantees to never return more than limit. Default is no limit.
129
109
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -131,16 +111,10 @@ module Twilio
131
111
  # but a limit is defined, stream() will attempt to read the limit with the most
132
112
  # efficient page size, i.e. min(limit, 1000)
133
113
  # @return [Enumerable] Enumerable that will yield up to limit results
134
- def stream(order: :unset, from: :unset, bounds: :unset, hide_expired: :unset, limit: nil, page_size: nil)
114
+ def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
135
115
  limits = @version.read_limits(limit, page_size)
136
116
 
137
- page = self.page(
138
- order: order,
139
- from: from,
140
- bounds: bounds,
141
- hide_expired: hide_expired,
142
- page_size: limits[:page_size],
143
- )
117
+ page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
144
118
 
145
119
  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
146
120
  end
@@ -173,19 +147,15 @@ module Twilio
173
147
  # referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
174
148
  # referenced by the `from` parameter or `exclusive` to start with the next Map
175
149
  # Item. The default value is `inclusive`.
176
- # @param [sync_map_item.HideExpiredType] hide_expired The default list of Sync Map
177
- # items will show both active and expired items. It is possible to filter only the
178
- # active ones by hiding the expired ones.
179
150
  # @param [String] page_token PageToken provided by the API
180
151
  # @param [Integer] page_number Page Number, this value is simply for client state
181
152
  # @param [Integer] page_size Number of records to return, defaults to 50
182
153
  # @return [Page] Page of SyncMapItemInstance
183
- def page(order: :unset, from: :unset, bounds: :unset, hide_expired: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
154
+ def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
184
155
  params = Twilio::Values.of({
185
156
  'Order' => order,
186
157
  'From' => from,
187
158
  'Bounds' => bounds,
188
- 'HideExpired' => hide_expired,
189
159
  'PageToken' => page_token,
190
160
  'Page' => page_number,
191
161
  'PageSize' => page_size,
@@ -216,8 +186,6 @@ module Twilio
216
186
  end
217
187
  end
218
188
 
219
- ##
220
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
221
189
  class SyncMapItemPage < Page
222
190
  ##
223
191
  # Initialize the SyncMapItemPage
@@ -252,8 +220,6 @@ module Twilio
252
220
  end
253
221
  end
254
222
 
255
- ##
256
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
257
223
  class SyncMapItemContext < InstanceContext
258
224
  ##
259
225
  # Initialize the SyncMapItemContext
@@ -262,7 +228,7 @@ module Twilio
262
228
  # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map Item
263
229
  # resource to fetch.
264
230
  # @param [String] map_sid The SID of the Sync Map with the Sync Map Item resource
265
- # to fetch. Can be the Sync Map's `sid` or its `unique_name`.
231
+ # to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.
266
232
  # @param [String] key The `key` value of the Sync Map Item resource to fetch.
267
233
  # @return [SyncMapItemContext] SyncMapItemContext
268
234
  def initialize(version, service_sid, map_sid, key)
@@ -290,7 +256,10 @@ module Twilio
290
256
 
291
257
  ##
292
258
  # Delete the SyncMapItemInstance
293
- # @param [String] if_match The If-Match HTTP request header
259
+ # @param [String] if_match If provided, applies this mutation if (and only if) the
260
+ # “revision” field of this {map item] matches the provided value. This matches the
261
+ # semantics of (and is implemented with) the HTTP [If-Match
262
+ # header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
294
263
  # @return [Boolean] true if delete succeeds, false otherwise
295
264
  def delete(if_match: :unset)
296
265
  headers = Twilio::Values.of({'If-Match' => if_match, })
@@ -301,22 +270,21 @@ module Twilio
301
270
  ##
302
271
  # Update the SyncMapItemInstance
303
272
  # @param [Hash] data A JSON string that represents an arbitrary, schema-less
304
- # object that the Map Item stores. Can be up to 16KB in length.
273
+ # object that the Map Item stores. Can be up to 16 KiB in length.
305
274
  # @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
306
275
  # this value is ignored.
307
- # @param [String] item_ttl How long, in seconds, before the Map Item expires
308
- # (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
309
- # The default value is `0`, which means the Map Item does not expire. The Map Item
310
- # will be deleted automatically after it expires, but there can be a delay between
311
- # the expiration time and the resources's deletion.
312
- # @param [String] collection_ttl How long, in seconds, before the Map Item's
313
- # parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0
314
- # to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
315
- # Map does not expire. This parameter can only be used when the Map Item's `data`
316
- # or `ttl` is updated in the same request. The Sync Map will be deleted
317
- # automatically after it expires, but there can be a delay between the expiration
318
- # time and the resources's deletion.
319
- # @param [String] if_match The If-Match HTTP request header
276
+ # @param [String] item_ttl How long, {in
277
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
278
+ # the Map Item expires (time-to-live) and is deleted.
279
+ # @param [String] collection_ttl How long, {in
280
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
281
+ # the Map Item's parent Sync Map expires (time-to-live) and is deleted. This
282
+ # parameter can only be used when the Map Item's `data` or `ttl` is updated in the
283
+ # same request.
284
+ # @param [String] if_match If provided, applies this mutation if (and only if) the
285
+ # “revision” field of this {map item] matches the provided value. This matches the
286
+ # semantics of (and is implemented with) the HTTP [If-Match
287
+ # header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
320
288
  # @return [SyncMapItemInstance] Updated SyncMapItemInstance
321
289
  def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
322
290
  data = Twilio::Values.of({
@@ -353,8 +321,6 @@ module Twilio
353
321
  end
354
322
  end
355
323
 
356
- ##
357
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
358
324
  class SyncMapItemInstance < InstanceResource
359
325
  ##
360
326
  # Initialize the SyncMapItemInstance
@@ -480,7 +446,10 @@ module Twilio
480
446
 
481
447
  ##
482
448
  # Delete the SyncMapItemInstance
483
- # @param [String] if_match The If-Match HTTP request header
449
+ # @param [String] if_match If provided, applies this mutation if (and only if) the
450
+ # “revision” field of this {map item] matches the provided value. This matches the
451
+ # semantics of (and is implemented with) the HTTP [If-Match
452
+ # header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
484
453
  # @return [Boolean] true if delete succeeds, false otherwise
485
454
  def delete(if_match: :unset)
486
455
  context.delete(if_match: if_match, )
@@ -489,22 +458,21 @@ module Twilio
489
458
  ##
490
459
  # Update the SyncMapItemInstance
491
460
  # @param [Hash] data A JSON string that represents an arbitrary, schema-less
492
- # object that the Map Item stores. Can be up to 16KB in length.
461
+ # object that the Map Item stores. Can be up to 16 KiB in length.
493
462
  # @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
494
463
  # this value is ignored.
495
- # @param [String] item_ttl How long, in seconds, before the Map Item expires
496
- # (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
497
- # The default value is `0`, which means the Map Item does not expire. The Map Item
498
- # will be deleted automatically after it expires, but there can be a delay between
499
- # the expiration time and the resources's deletion.
500
- # @param [String] collection_ttl How long, in seconds, before the Map Item's
501
- # parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0
502
- # to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
503
- # Map does not expire. This parameter can only be used when the Map Item's `data`
504
- # or `ttl` is updated in the same request. The Sync Map will be deleted
505
- # automatically after it expires, but there can be a delay between the expiration
506
- # time and the resources's deletion.
507
- # @param [String] if_match The If-Match HTTP request header
464
+ # @param [String] item_ttl How long, {in
465
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
466
+ # the Map Item expires (time-to-live) and is deleted.
467
+ # @param [String] collection_ttl How long, {in
468
+ # seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
469
+ # the Map Item's parent Sync Map expires (time-to-live) and is deleted. This
470
+ # parameter can only be used when the Map Item's `data` or `ttl` is updated in the
471
+ # same request.
472
+ # @param [String] if_match If provided, applies this mutation if (and only if) the
473
+ # “revision” field of this {map item] matches the provided value. This matches the
474
+ # semantics of (and is implemented with) the HTTP [If-Match
475
+ # header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
508
476
  # @return [SyncMapItemInstance] Updated SyncMapItemInstance
509
477
  def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
510
478
  context.update(
@@ -12,8 +12,6 @@ module Twilio
12
12
  class V1 < Version
13
13
  class ServiceContext < InstanceContext
14
14
  class SyncMapContext < InstanceContext
15
- ##
16
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
17
15
  class SyncMapPermissionList < ListResource
18
16
  ##
19
17
  # Initialize the SyncMapPermissionList
@@ -118,8 +116,6 @@ module Twilio
118
116
  end
119
117
  end
120
118
 
121
- ##
122
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
123
119
  class SyncMapPermissionPage < Page
124
120
  ##
125
121
  # Initialize the SyncMapPermissionPage
@@ -154,8 +150,6 @@ module Twilio
154
150
  end
155
151
  end
156
152
 
157
- ##
158
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
159
153
  class SyncMapPermissionContext < InstanceContext
160
154
  ##
161
155
  # Initialize the SyncMapPermissionContext
@@ -164,7 +158,7 @@ module Twilio
164
158
  # Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map
165
159
  # Permission resource to fetch. Can be the Service's `sid` value or `default`.
166
160
  # @param [String] map_sid The SID of the Sync Map with the Sync Map Permission
167
- # resource to fetch. Can be the Sync Map's `sid` or its `unique_name`.
161
+ # resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.
168
162
  # @param [String] identity The application-defined string that uniquely identifies
169
163
  # the User's Sync Map Permission resource to fetch.
170
164
  # @return [SyncMapPermissionContext] SyncMapPermissionContext
@@ -236,8 +230,6 @@ module Twilio
236
230
  end
237
231
  end
238
232
 
239
- ##
240
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
241
233
  class SyncMapPermissionInstance < InstanceResource
242
234
  ##
243
235
  # Initialize the SyncMapPermissionInstance