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