twilio-ruby 5.43.0 → 5.46.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.travis.yml +1 -0
- data/CHANGES.md +83 -0
- data/LICENSE +1 -1
- data/README.md +16 -2
- data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +14 -9
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +13 -13
- 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 +17 -5
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +17 -12
- 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/bulkexports.rb +4 -2
- data/lib/twilio-ruby/rest/bulkexports/v1.rb +4 -2
- 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/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/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/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/participant.rb +32 -2
- 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/configuration.rb +17 -2
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +1 -1
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +32 -2
- 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/conversations/v1/service/user.rb +8 -1
- data/lib/twilio-ruby/rest/conversations/v1/user.rb +8 -1
- data/lib/twilio-ruby/rest/events/v1/sink.rb +2 -1
- data/lib/twilio-ruby/rest/events/v1/subscription.rb +2 -2
- data/lib/twilio-ruby/rest/flex_api.rb +1 -1
- data/lib/twilio-ruby/rest/flex_api/v1.rb +1 -1
- data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +5 -5
- data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +4 -4
- data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +88 -76
- data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +2 -2
- data/lib/twilio-ruby/rest/insights/v1/call/summary.rb +8 -9
- data/lib/twilio-ruby/rest/insights/v1/room.rb +7 -7
- data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +1 -1
- 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/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/phone_number.rb +16 -16
- 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/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 -23
- data/lib/twilio-ruby/rest/preview/bulk_exports.rb +4 -2
- 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/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/trusted_comms.rb +0 -30
- 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/service/session.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/service/build.rb +6 -6
- 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/command.rb +4 -4
- data/lib/twilio-ruby/rest/supersim/v1/fleet.rb +32 -11
- 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/service/document.rb +12 -20
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +9 -17
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +8 -31
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +9 -17
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +9 -32
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb +1 -1
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +5 -15
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +1 -1
- 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/trunk.rb +1 -1
- data/lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb +21 -24
- data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +3 -3
- 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/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/composition_settings.rb +6 -6
- data/lib/twilio-ruby/rest/video/v1/recording.rb +6 -6
- data/lib/twilio-ruby/rest/video/v1/recording_settings.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/dialing_permissions/country.rb +1 -1
- data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +4 -4
- data/lib/twilio-ruby/twiml/voice_response.rb +20 -10
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/integration/api/v2010/account/call/recording_spec.rb +4 -0
- data/spec/integration/api/v2010/account/conference/participant_spec.rb +30 -0
- data/spec/integration/conversations/v1/conversation/participant_spec.rb +30 -10
- data/spec/integration/conversations/v1/service/configuration_spec.rb +2 -0
- data/spec/integration/conversations/v1/service/conversation/participant_spec.rb +30 -10
- data/spec/integration/conversations/v1/service/user_spec.rb +9 -4
- data/spec/integration/conversations/v1/user_spec.rb +9 -4
- data/spec/integration/events/v1/sink_spec.rb +14 -0
- data/spec/integration/insights/v1/call/summary_spec.rb +1 -0
- data/spec/integration/lookups/v1/phone_number_spec.rb +7 -7
- data/spec/integration/taskrouter/v1/workspace/worker/worker_channel_spec.rb +1 -1
- data/spec/integration/trunking/v1/trunk/recording_spec.rb +2 -6
- data/spec/integration/video/v1/room_spec.rb +5 -0
- data/spec/twiml/voice_response_spec.rb +1 -1
- metadata +2 -17
- data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +0 -243
- data/lib/twilio-ruby/rest/preview/trusted_comms/business.rb +0 -213
- data/lib/twilio-ruby/rest/preview/trusted_comms/business/insights.rb +0 -108
- data/lib/twilio-ruby/rest/preview/trusted_comms/business/insights/impressions_rate.rb +0 -260
- data/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb +0 -342
- data/spec/integration/preview/trusted_comms/branded_call_spec.rb +0 -59
- data/spec/integration/preview/trusted_comms/business/insights/impressions_rate_spec.rb +0 -56
- data/spec/integration/preview/trusted_comms/business/insights_spec.rb +0 -12
- data/spec/integration/preview/trusted_comms/business_spec.rb +0 -45
- data/spec/integration/preview/trusted_comms/phone_call_spec.rb +0 -59
@@ -11,7 +11,7 @@ module Twilio
|
|
11
11
|
class Supersim < Domain
|
12
12
|
class V1 < Version
|
13
13
|
##
|
14
|
-
# PLEASE NOTE that this class contains
|
14
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
15
15
|
class UsageRecordList < ListResource
|
16
16
|
##
|
17
17
|
# Initialize the UsageRecordList
|
@@ -211,7 +211,7 @@ module Twilio
|
|
211
211
|
end
|
212
212
|
|
213
213
|
##
|
214
|
-
# PLEASE NOTE that this class contains
|
214
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
215
215
|
class UsageRecordPage < Page
|
216
216
|
##
|
217
217
|
# Initialize the UsageRecordPage
|
@@ -242,7 +242,7 @@ module Twilio
|
|
242
242
|
end
|
243
243
|
|
244
244
|
##
|
245
|
-
# PLEASE NOTE that this class contains
|
245
|
+
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
246
246
|
class UsageRecordInstance < InstanceResource
|
247
247
|
##
|
248
248
|
# Initialize the UsageRecordInstance
|
@@ -34,7 +34,7 @@ module Twilio
|
|
34
34
|
# @param [String] unique_name An application-defined string that uniquely
|
35
35
|
# identifies the Sync Document
|
36
36
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
37
|
-
# object that the Sync Document stores. Can be up to
|
37
|
+
# object that the Sync Document stores. Can be up to 16 KiB in length.
|
38
38
|
# @param [String] ttl How long, in seconds, before the Sync Document expires and
|
39
39
|
# is deleted (the Sync Document's time-to-live). Can be an integer from 0 to
|
40
40
|
# 31,536,000 (1 year). The default value is `0`, which means the Sync Document
|
@@ -58,9 +58,6 @@ module Twilio
|
|
58
58
|
# Lists DocumentInstance records from the API as a list.
|
59
59
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
60
60
|
# 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
61
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
65
62
|
# guarantees to never return more than limit. Default is no limit
|
66
63
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -68,17 +65,14 @@ module Twilio
|
|
68
65
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
69
66
|
# efficient page size, i.e. min(limit, 1000)
|
70
67
|
# @return [Array] Array of up to limit results
|
71
|
-
def list(
|
72
|
-
self.stream(
|
68
|
+
def list(limit: nil, page_size: nil)
|
69
|
+
self.stream(limit: limit, page_size: page_size).entries
|
73
70
|
end
|
74
71
|
|
75
72
|
##
|
76
73
|
# Streams DocumentInstance records from the API as an Enumerable.
|
77
74
|
# This operation lazily loads records as efficiently as possible until the limit
|
78
75
|
# 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
76
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
83
77
|
# guarantees to never return more than limit. Default is no limit.
|
84
78
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -86,10 +80,10 @@ module Twilio
|
|
86
80
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
87
81
|
# efficient page size, i.e. min(limit, 1000)
|
88
82
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
89
|
-
def stream(
|
83
|
+
def stream(limit: nil, page_size: nil)
|
90
84
|
limits = @version.read_limits(limit, page_size)
|
91
85
|
|
92
|
-
page = self.page(
|
86
|
+
page = self.page(page_size: limits[:page_size], )
|
93
87
|
|
94
88
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
95
89
|
end
|
@@ -111,16 +105,12 @@ module Twilio
|
|
111
105
|
##
|
112
106
|
# Retrieve a single page of DocumentInstance records from the API.
|
113
107
|
# 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
108
|
# @param [String] page_token PageToken provided by the API
|
118
109
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
119
110
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
120
111
|
# @return [Page] Page of DocumentInstance
|
121
|
-
def page(
|
112
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
122
113
|
params = Twilio::Values.of({
|
123
|
-
'HideExpired' => hide_expired,
|
124
114
|
'PageToken' => page_token,
|
125
115
|
'Page' => page_number,
|
126
116
|
'PageSize' => page_size,
|
@@ -191,7 +181,8 @@ module Twilio
|
|
191
181
|
# @param [String] service_sid The SID of the {Sync
|
192
182
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Document
|
193
183
|
# resource to fetch.
|
194
|
-
# @param [String] sid The SID of the Document resource to fetch.
|
184
|
+
# @param [String] sid The SID of the Document resource to fetch. Can be the
|
185
|
+
# Document resource's `sid` or its `unique_name`.
|
195
186
|
# @return [DocumentContext] DocumentContext
|
196
187
|
def initialize(version, service_sid, sid)
|
197
188
|
super(version)
|
@@ -226,7 +217,7 @@ module Twilio
|
|
226
217
|
##
|
227
218
|
# Update the DocumentInstance
|
228
219
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
229
|
-
# object that the Sync Document stores. Can be up to
|
220
|
+
# object that the Sync Document stores. Can be up to 16 KiB in length.
|
230
221
|
# @param [String] ttl How long, in seconds, before the Sync Document expires and
|
231
222
|
# is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
|
232
223
|
# default value is `0`, which means the Document resource does not expire. The
|
@@ -290,7 +281,8 @@ module Twilio
|
|
290
281
|
# @param [String] service_sid The SID of the {Sync
|
291
282
|
# Service}[https://www.twilio.com/docs/sync/api/service] the resource is
|
292
283
|
# associated with.
|
293
|
-
# @param [String] sid The SID of the Document resource to fetch.
|
284
|
+
# @param [String] sid The SID of the Document resource to fetch. Can be the
|
285
|
+
# Document resource's `sid` or its `unique_name`.
|
294
286
|
# @return [DocumentInstance] DocumentInstance
|
295
287
|
def initialize(version, payload, service_sid: nil, sid: nil)
|
296
288
|
super(version)
|
@@ -417,7 +409,7 @@ module Twilio
|
|
417
409
|
##
|
418
410
|
# Update the DocumentInstance
|
419
411
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
420
|
-
# object that the Sync Document stores. Can be up to
|
412
|
+
# object that the Sync Document stores. Can be up to 16 KiB in length.
|
421
413
|
# @param [String] ttl How long, in seconds, before the Sync Document expires and
|
422
414
|
# is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
|
423
415
|
# default value is `0`, which means the Document resource does not expire. The
|
@@ -59,9 +59,6 @@ module Twilio
|
|
59
59
|
# Lists SyncListInstance records from the API as a list.
|
60
60
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
61
61
|
# 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
62
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
66
63
|
# guarantees to never return more than limit. Default is no limit
|
67
64
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -69,17 +66,14 @@ module Twilio
|
|
69
66
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
70
67
|
# efficient page size, i.e. min(limit, 1000)
|
71
68
|
# @return [Array] Array of up to limit results
|
72
|
-
def list(
|
73
|
-
self.stream(
|
69
|
+
def list(limit: nil, page_size: nil)
|
70
|
+
self.stream(limit: limit, page_size: page_size).entries
|
74
71
|
end
|
75
72
|
|
76
73
|
##
|
77
74
|
# Streams SyncListInstance records from the API as an Enumerable.
|
78
75
|
# This operation lazily loads records as efficiently as possible until the limit
|
79
76
|
# 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
77
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
84
78
|
# guarantees to never return more than limit. Default is no limit.
|
85
79
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -87,10 +81,10 @@ module Twilio
|
|
87
81
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
88
82
|
# efficient page size, i.e. min(limit, 1000)
|
89
83
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
90
|
-
def stream(
|
84
|
+
def stream(limit: nil, page_size: nil)
|
91
85
|
limits = @version.read_limits(limit, page_size)
|
92
86
|
|
93
|
-
page = self.page(
|
87
|
+
page = self.page(page_size: limits[:page_size], )
|
94
88
|
|
95
89
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
96
90
|
end
|
@@ -112,16 +106,12 @@ module Twilio
|
|
112
106
|
##
|
113
107
|
# Retrieve a single page of SyncListInstance records from the API.
|
114
108
|
# 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
109
|
# @param [String] page_token PageToken provided by the API
|
119
110
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
120
111
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
121
112
|
# @return [Page] Page of SyncListInstance
|
122
|
-
def page(
|
113
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
123
114
|
params = Twilio::Values.of({
|
124
|
-
'HideExpired' => hide_expired,
|
125
115
|
'PageToken' => page_token,
|
126
116
|
'Page' => page_number,
|
127
117
|
'PageSize' => page_size,
|
@@ -192,7 +182,8 @@ module Twilio
|
|
192
182
|
# @param [String] service_sid The SID of the {Sync
|
193
183
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Sync List
|
194
184
|
# resource to fetch.
|
195
|
-
# @param [String] sid The SID of the Sync List resource to fetch.
|
185
|
+
# @param [String] sid The SID of the Sync List resource to fetch. Can be the Sync
|
186
|
+
# List resource's `sid` or its `unique_name`.
|
196
187
|
# @return [SyncListContext] SyncListContext
|
197
188
|
def initialize(version, service_sid, sid)
|
198
189
|
super(version)
|
@@ -309,7 +300,8 @@ module Twilio
|
|
309
300
|
# @param [String] service_sid The SID of the {Sync
|
310
301
|
# Service}[https://www.twilio.com/docs/sync/api/service] the resource is
|
311
302
|
# associated with.
|
312
|
-
# @param [String] sid The SID of the Sync List resource to fetch.
|
303
|
+
# @param [String] sid The SID of the Sync List resource to fetch. Can be the Sync
|
304
|
+
# List resource's `sid` or its `unique_name`.
|
313
305
|
# @return [SyncListInstance] SyncListInstance
|
314
306
|
def initialize(version, payload, service_sid: nil, sid: nil)
|
315
307
|
super(version)
|
@@ -34,7 +34,7 @@ module Twilio
|
|
34
34
|
##
|
35
35
|
# Create the SyncListItemInstance
|
36
36
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
37
|
-
# object that the List Item stores. Can be up to
|
37
|
+
# object that the List Item stores. Can be up to 16 KiB in length.
|
38
38
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
39
39
|
# this value is ignored.
|
40
40
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
@@ -80,9 +80,6 @@ module Twilio
|
|
80
80
|
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
|
81
81
|
# Item referenced by the `from` parameter or `exclusive` to start with the next
|
82
82
|
# 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
83
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
87
84
|
# guarantees to never return more than limit. Default is no limit
|
88
85
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -90,15 +87,8 @@ module Twilio
|
|
90
87
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
91
88
|
# efficient page size, i.e. min(limit, 1000)
|
92
89
|
# @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
|
90
|
+
def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
|
91
|
+
self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
|
102
92
|
end
|
103
93
|
|
104
94
|
##
|
@@ -114,9 +104,6 @@ module Twilio
|
|
114
104
|
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
|
115
105
|
# Item referenced by the `from` parameter or `exclusive` to start with the next
|
116
106
|
# 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
107
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
121
108
|
# guarantees to never return more than limit. Default is no limit.
|
122
109
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -124,16 +111,10 @@ module Twilio
|
|
124
111
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
125
112
|
# efficient page size, i.e. min(limit, 1000)
|
126
113
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
127
|
-
def stream(order: :unset, from: :unset, bounds: :unset,
|
114
|
+
def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
|
128
115
|
limits = @version.read_limits(limit, page_size)
|
129
116
|
|
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
|
-
)
|
117
|
+
page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
|
137
118
|
|
138
119
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
139
120
|
end
|
@@ -164,19 +145,15 @@ module Twilio
|
|
164
145
|
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
|
165
146
|
# Item referenced by the `from` parameter or `exclusive` to start with the next
|
166
147
|
# 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
148
|
# @param [String] page_token PageToken provided by the API
|
171
149
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
172
150
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
173
151
|
# @return [Page] Page of SyncListItemInstance
|
174
|
-
def page(order: :unset, from: :unset, bounds: :unset,
|
152
|
+
def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
175
153
|
params = Twilio::Values.of({
|
176
154
|
'Order' => order,
|
177
155
|
'From' => from,
|
178
156
|
'Bounds' => bounds,
|
179
|
-
'HideExpired' => hide_expired,
|
180
157
|
'PageToken' => page_token,
|
181
158
|
'Page' => page_number,
|
182
159
|
'PageSize' => page_size,
|
@@ -292,7 +269,7 @@ module Twilio
|
|
292
269
|
##
|
293
270
|
# Update the SyncListItemInstance
|
294
271
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
295
|
-
# object that the List Item stores. Can be up to
|
272
|
+
# object that the List Item stores. Can be up to 16 KiB in length.
|
296
273
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
297
274
|
# this value is ignored.
|
298
275
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
@@ -483,7 +460,7 @@ module Twilio
|
|
483
460
|
##
|
484
461
|
# Update the SyncListItemInstance
|
485
462
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
486
|
-
# object that the List Item stores. Can be up to
|
463
|
+
# object that the List Item stores. Can be up to 16 KiB in length.
|
487
464
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
488
465
|
# this value is ignored.
|
489
466
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
@@ -58,9 +58,6 @@ module Twilio
|
|
58
58
|
# Lists SyncMapInstance records from the API as a list.
|
59
59
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
60
60
|
# 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
61
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
65
62
|
# guarantees to never return more than limit. Default is no limit
|
66
63
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -68,17 +65,14 @@ module Twilio
|
|
68
65
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
69
66
|
# efficient page size, i.e. min(limit, 1000)
|
70
67
|
# @return [Array] Array of up to limit results
|
71
|
-
def list(
|
72
|
-
self.stream(
|
68
|
+
def list(limit: nil, page_size: nil)
|
69
|
+
self.stream(limit: limit, page_size: page_size).entries
|
73
70
|
end
|
74
71
|
|
75
72
|
##
|
76
73
|
# Streams SyncMapInstance records from the API as an Enumerable.
|
77
74
|
# This operation lazily loads records as efficiently as possible until the limit
|
78
75
|
# 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
76
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
83
77
|
# guarantees to never return more than limit. Default is no limit.
|
84
78
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -86,10 +80,10 @@ module Twilio
|
|
86
80
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
87
81
|
# efficient page size, i.e. min(limit, 1000)
|
88
82
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
89
|
-
def stream(
|
83
|
+
def stream(limit: nil, page_size: nil)
|
90
84
|
limits = @version.read_limits(limit, page_size)
|
91
85
|
|
92
|
-
page = self.page(
|
86
|
+
page = self.page(page_size: limits[:page_size], )
|
93
87
|
|
94
88
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
95
89
|
end
|
@@ -111,16 +105,12 @@ module Twilio
|
|
111
105
|
##
|
112
106
|
# Retrieve a single page of SyncMapInstance records from the API.
|
113
107
|
# 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
108
|
# @param [String] page_token PageToken provided by the API
|
118
109
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
119
110
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
120
111
|
# @return [Page] Page of SyncMapInstance
|
121
|
-
def page(
|
112
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
122
113
|
params = Twilio::Values.of({
|
123
|
-
'HideExpired' => hide_expired,
|
124
114
|
'PageToken' => page_token,
|
125
115
|
'Page' => page_number,
|
126
116
|
'PageSize' => page_size,
|
@@ -191,7 +181,8 @@ module Twilio
|
|
191
181
|
# @param [String] service_sid The SID of the {Sync
|
192
182
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map
|
193
183
|
# resource to fetch.
|
194
|
-
# @param [String] sid The SID of the Sync Map resource to fetch.
|
184
|
+
# @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
|
185
|
+
# Map's `sid` or its `unique_name`.
|
195
186
|
# @return [SyncMapContext] SyncMapContext
|
196
187
|
def initialize(version, service_sid, sid)
|
197
188
|
super(version)
|
@@ -308,7 +299,8 @@ module Twilio
|
|
308
299
|
# @param [String] service_sid The SID of the {Sync
|
309
300
|
# Service}[https://www.twilio.com/docs/sync/api/service] the resource is
|
310
301
|
# associated with.
|
311
|
-
# @param [String] sid The SID of the Sync Map resource to fetch.
|
302
|
+
# @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
|
303
|
+
# Map's `sid` or its `unique_name`.
|
312
304
|
# @return [SyncMapInstance] SyncMapInstance
|
313
305
|
def initialize(version, payload, service_sid: nil, sid: nil)
|
314
306
|
super(version)
|
@@ -36,7 +36,7 @@ module Twilio
|
|
36
36
|
# @param [String] key The unique, user-defined key for the Map Item. Can be up to
|
37
37
|
# 320 characters long.
|
38
38
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
39
|
-
# object that the Map Item stores. Can be up to
|
39
|
+
# object that the Map Item stores. Can be up to 16 KiB in length.
|
40
40
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
41
41
|
# this value is ignored.
|
42
42
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
@@ -85,9 +85,6 @@ module Twilio
|
|
85
85
|
# referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
|
86
86
|
# referenced by the `from` parameter or `exclusive` to start with the next Map
|
87
87
|
# 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
88
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
92
89
|
# guarantees to never return more than limit. Default is no limit
|
93
90
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -95,15 +92,8 @@ module Twilio
|
|
95
92
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
96
93
|
# efficient page size, i.e. min(limit, 1000)
|
97
94
|
# @return [Array] Array of up to limit results
|
98
|
-
def list(order: :unset, from: :unset, bounds: :unset,
|
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
|
95
|
+
def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
|
96
|
+
self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
|
107
97
|
end
|
108
98
|
|
109
99
|
##
|
@@ -121,9 +111,6 @@ module Twilio
|
|
121
111
|
# referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
|
122
112
|
# referenced by the `from` parameter or `exclusive` to start with the next Map
|
123
113
|
# 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
114
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
128
115
|
# guarantees to never return more than limit. Default is no limit.
|
129
116
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -131,16 +118,10 @@ module Twilio
|
|
131
118
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
132
119
|
# efficient page size, i.e. min(limit, 1000)
|
133
120
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
134
|
-
def stream(order: :unset, from: :unset, bounds: :unset,
|
121
|
+
def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
|
135
122
|
limits = @version.read_limits(limit, page_size)
|
136
123
|
|
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
|
-
)
|
124
|
+
page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
|
144
125
|
|
145
126
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
146
127
|
end
|
@@ -173,19 +154,15 @@ module Twilio
|
|
173
154
|
# referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
|
174
155
|
# referenced by the `from` parameter or `exclusive` to start with the next Map
|
175
156
|
# 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
157
|
# @param [String] page_token PageToken provided by the API
|
180
158
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
181
159
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
182
160
|
# @return [Page] Page of SyncMapItemInstance
|
183
|
-
def page(order: :unset, from: :unset, bounds: :unset,
|
161
|
+
def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
184
162
|
params = Twilio::Values.of({
|
185
163
|
'Order' => order,
|
186
164
|
'From' => from,
|
187
165
|
'Bounds' => bounds,
|
188
|
-
'HideExpired' => hide_expired,
|
189
166
|
'PageToken' => page_token,
|
190
167
|
'Page' => page_number,
|
191
168
|
'PageSize' => page_size,
|
@@ -262,7 +239,7 @@ module Twilio
|
|
262
239
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map Item
|
263
240
|
# resource to fetch.
|
264
241
|
# @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`.
|
242
|
+
# to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.
|
266
243
|
# @param [String] key The `key` value of the Sync Map Item resource to fetch.
|
267
244
|
# @return [SyncMapItemContext] SyncMapItemContext
|
268
245
|
def initialize(version, service_sid, map_sid, key)
|
@@ -301,7 +278,7 @@ module Twilio
|
|
301
278
|
##
|
302
279
|
# Update the SyncMapItemInstance
|
303
280
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
304
|
-
# object that the Map Item stores. Can be up to
|
281
|
+
# object that the Map Item stores. Can be up to 16 KiB in length.
|
305
282
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
306
283
|
# this value is ignored.
|
307
284
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
@@ -489,7 +466,7 @@ module Twilio
|
|
489
466
|
##
|
490
467
|
# Update the SyncMapItemInstance
|
491
468
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
492
|
-
# object that the Map Item stores. Can be up to
|
469
|
+
# object that the Map Item stores. Can be up to 16 KiB in length.
|
493
470
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
494
471
|
# this value is ignored.
|
495
472
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|