twilio-ruby 5.44.0 → 5.47.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 +97 -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 +10 -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 +4 -2
- data/lib/twilio-ruby/rest/events/v1/subscription.rb +3 -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 +18 -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.rb +22 -0
- data/lib/twilio-ruby/rest/messaging/v1.rb +37 -0
- data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb +328 -0
- data/lib/twilio-ruby/rest/messaging/v1/campaign.rb +387 -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/messaging/v1/use_case.rb +198 -0
- 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/sync/service/document.rb +4 -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 +17 -7
- 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 +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/service.rb +0 -8
- data/lib/twilio-ruby/rest/sync/v1/service/document.rb +16 -36
- 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 +9 -25
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +24 -43
- 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 +9 -25
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +25 -44
- 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 +5 -23
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb +1 -7
- 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/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 +18 -8
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/integration/api/v2010/account/conference_spec.rb +302 -44
- 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/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/messaging/v1/campaign_spec.rb +194 -0
- data/spec/integration/messaging/v1/use_case_spec.rb +55 -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/video/v1/room_spec.rb +5 -0
- data/spec/twiml/voice_response_spec.rb +1 -1
- metadata +11 -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
@@ -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
|
@@ -59,9 +57,6 @@ module Twilio
|
|
59
57
|
# Lists SyncListInstance records from the API as a list.
|
60
58
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
61
59
|
# 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
60
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
66
61
|
# guarantees to never return more than limit. Default is no limit
|
67
62
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -69,17 +64,14 @@ module Twilio
|
|
69
64
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
70
65
|
# efficient page size, i.e. min(limit, 1000)
|
71
66
|
# @return [Array] Array of up to limit results
|
72
|
-
def list(
|
73
|
-
self.stream(
|
67
|
+
def list(limit: nil, page_size: nil)
|
68
|
+
self.stream(limit: limit, page_size: page_size).entries
|
74
69
|
end
|
75
70
|
|
76
71
|
##
|
77
72
|
# Streams SyncListInstance records from the API as an Enumerable.
|
78
73
|
# This operation lazily loads records as efficiently as possible until the limit
|
79
74
|
# 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
75
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
84
76
|
# guarantees to never return more than limit. Default is no limit.
|
85
77
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -87,10 +79,10 @@ module Twilio
|
|
87
79
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
88
80
|
# efficient page size, i.e. min(limit, 1000)
|
89
81
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
90
|
-
def stream(
|
82
|
+
def stream(limit: nil, page_size: nil)
|
91
83
|
limits = @version.read_limits(limit, page_size)
|
92
84
|
|
93
|
-
page = self.page(
|
85
|
+
page = self.page(page_size: limits[:page_size], )
|
94
86
|
|
95
87
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
96
88
|
end
|
@@ -112,16 +104,12 @@ module Twilio
|
|
112
104
|
##
|
113
105
|
# Retrieve a single page of SyncListInstance records from the API.
|
114
106
|
# 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
107
|
# @param [String] page_token PageToken provided by the API
|
119
108
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
120
109
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
121
110
|
# @return [Page] Page of SyncListInstance
|
122
|
-
def page(
|
111
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
123
112
|
params = Twilio::Values.of({
|
124
|
-
'HideExpired' => hide_expired,
|
125
113
|
'PageToken' => page_token,
|
126
114
|
'Page' => page_number,
|
127
115
|
'PageSize' => page_size,
|
@@ -152,8 +140,6 @@ module Twilio
|
|
152
140
|
end
|
153
141
|
end
|
154
142
|
|
155
|
-
##
|
156
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
157
143
|
class SyncListPage < Page
|
158
144
|
##
|
159
145
|
# Initialize the SyncListPage
|
@@ -183,8 +169,6 @@ module Twilio
|
|
183
169
|
end
|
184
170
|
end
|
185
171
|
|
186
|
-
##
|
187
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
188
172
|
class SyncListContext < InstanceContext
|
189
173
|
##
|
190
174
|
# Initialize the SyncListContext
|
@@ -192,7 +176,8 @@ module Twilio
|
|
192
176
|
# @param [String] service_sid The SID of the {Sync
|
193
177
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Sync List
|
194
178
|
# resource to fetch.
|
195
|
-
# @param [String] sid The SID of the Sync List resource to fetch.
|
179
|
+
# @param [String] sid The SID of the Sync List resource to fetch. Can be the Sync
|
180
|
+
# List resource's `sid` or its `unique_name`.
|
196
181
|
# @return [SyncListContext] SyncListContext
|
197
182
|
def initialize(version, service_sid, sid)
|
198
183
|
super(version)
|
@@ -299,8 +284,6 @@ module Twilio
|
|
299
284
|
end
|
300
285
|
end
|
301
286
|
|
302
|
-
##
|
303
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
304
287
|
class SyncListInstance < InstanceResource
|
305
288
|
##
|
306
289
|
# Initialize the SyncListInstance
|
@@ -309,7 +292,8 @@ module Twilio
|
|
309
292
|
# @param [String] service_sid The SID of the {Sync
|
310
293
|
# Service}[https://www.twilio.com/docs/sync/api/service] the resource is
|
311
294
|
# associated with.
|
312
|
-
# @param [String] sid The SID of the Sync List resource to fetch.
|
295
|
+
# @param [String] sid The SID of the Sync List resource to fetch. Can be the Sync
|
296
|
+
# List resource's `sid` or its `unique_name`.
|
313
297
|
# @return [SyncListInstance] SyncListInstance
|
314
298
|
def initialize(version, payload, service_sid: nil, sid: nil)
|
315
299
|
super(version)
|
@@ -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,7 +32,7 @@ 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
38
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
@@ -80,9 +78,6 @@ module Twilio
|
|
80
78
|
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
|
81
79
|
# Item referenced by the `from` parameter or `exclusive` to start with the next
|
82
80
|
# 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
81
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
87
82
|
# guarantees to never return more than limit. Default is no limit
|
88
83
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -90,15 +85,8 @@ module Twilio
|
|
90
85
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
91
86
|
# efficient page size, i.e. min(limit, 1000)
|
92
87
|
# @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
|
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
|
102
90
|
end
|
103
91
|
|
104
92
|
##
|
@@ -114,9 +102,6 @@ module Twilio
|
|
114
102
|
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
|
115
103
|
# Item referenced by the `from` parameter or `exclusive` to start with the next
|
116
104
|
# 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
105
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
121
106
|
# guarantees to never return more than limit. Default is no limit.
|
122
107
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -124,16 +109,10 @@ module Twilio
|
|
124
109
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
125
110
|
# efficient page size, i.e. min(limit, 1000)
|
126
111
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
127
|
-
def stream(order: :unset, from: :unset, bounds: :unset,
|
112
|
+
def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
|
128
113
|
limits = @version.read_limits(limit, page_size)
|
129
114
|
|
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
|
-
)
|
115
|
+
page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
|
137
116
|
|
138
117
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
139
118
|
end
|
@@ -164,19 +143,15 @@ module Twilio
|
|
164
143
|
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
|
165
144
|
# Item referenced by the `from` parameter or `exclusive` to start with the next
|
166
145
|
# 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
146
|
# @param [String] page_token PageToken provided by the API
|
171
147
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
172
148
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
173
149
|
# @return [Page] Page of SyncListItemInstance
|
174
|
-
def page(order: :unset, from: :unset, bounds: :unset,
|
150
|
+
def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
175
151
|
params = Twilio::Values.of({
|
176
152
|
'Order' => order,
|
177
153
|
'From' => from,
|
178
154
|
'Bounds' => bounds,
|
179
|
-
'HideExpired' => hide_expired,
|
180
155
|
'PageToken' => page_token,
|
181
156
|
'Page' => page_number,
|
182
157
|
'PageSize' => page_size,
|
@@ -207,8 +182,6 @@ module Twilio
|
|
207
182
|
end
|
208
183
|
end
|
209
184
|
|
210
|
-
##
|
211
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
212
185
|
class SyncListItemPage < Page
|
213
186
|
##
|
214
187
|
# Initialize the SyncListItemPage
|
@@ -243,8 +216,6 @@ module Twilio
|
|
243
216
|
end
|
244
217
|
end
|
245
218
|
|
246
|
-
##
|
247
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
248
219
|
class SyncListItemContext < InstanceContext
|
249
220
|
##
|
250
221
|
# Initialize the SyncListItemContext
|
@@ -281,7 +252,10 @@ module Twilio
|
|
281
252
|
|
282
253
|
##
|
283
254
|
# Delete the SyncListItemInstance
|
284
|
-
# @param [String] if_match
|
255
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
256
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
257
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
258
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
285
259
|
# @return [Boolean] true if delete succeeds, false otherwise
|
286
260
|
def delete(if_match: :unset)
|
287
261
|
headers = Twilio::Values.of({'If-Match' => if_match, })
|
@@ -292,7 +266,7 @@ module Twilio
|
|
292
266
|
##
|
293
267
|
# Update the SyncListItemInstance
|
294
268
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
295
|
-
# object that the List Item stores. Can be up to
|
269
|
+
# object that the List Item stores. Can be up to 16 KiB in length.
|
296
270
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
297
271
|
# this value is ignored.
|
298
272
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
@@ -306,7 +280,10 @@ module Twilio
|
|
306
280
|
# List does not expire. The Sync List will be deleted automatically after it
|
307
281
|
# expires, but there can be a delay between the expiration time and the
|
308
282
|
# resources's deletion.
|
309
|
-
# @param [String] if_match
|
283
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
284
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
285
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
286
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
310
287
|
# @return [SyncListItemInstance] Updated SyncListItemInstance
|
311
288
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
|
312
289
|
data = Twilio::Values.of({
|
@@ -343,8 +320,6 @@ module Twilio
|
|
343
320
|
end
|
344
321
|
end
|
345
322
|
|
346
|
-
##
|
347
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
348
323
|
class SyncListItemInstance < InstanceResource
|
349
324
|
##
|
350
325
|
# Initialize the SyncListItemInstance
|
@@ -474,7 +449,10 @@ module Twilio
|
|
474
449
|
|
475
450
|
##
|
476
451
|
# Delete the SyncListItemInstance
|
477
|
-
# @param [String] if_match
|
452
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
453
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
454
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
455
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
478
456
|
# @return [Boolean] true if delete succeeds, false otherwise
|
479
457
|
def delete(if_match: :unset)
|
480
458
|
context.delete(if_match: if_match, )
|
@@ -483,7 +461,7 @@ module Twilio
|
|
483
461
|
##
|
484
462
|
# Update the SyncListItemInstance
|
485
463
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
486
|
-
# object that the List Item stores. Can be up to
|
464
|
+
# object that the List Item stores. Can be up to 16 KiB in length.
|
487
465
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
488
466
|
# this value is ignored.
|
489
467
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
@@ -497,7 +475,10 @@ module Twilio
|
|
497
475
|
# List does not expire. The Sync List will be deleted automatically after it
|
498
476
|
# expires, but there can be a delay between the expiration time and the
|
499
477
|
# resources's deletion.
|
500
|
-
# @param [String] if_match
|
478
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
479
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
480
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
481
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
501
482
|
# @return [SyncListItemInstance] Updated SyncListItemInstance
|
502
483
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
|
503
484
|
context.update(
|
@@ -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
|
@@ -58,9 +56,6 @@ module Twilio
|
|
58
56
|
# Lists SyncMapInstance records from the API as a list.
|
59
57
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
60
58
|
# 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
59
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
65
60
|
# guarantees to never return more than limit. Default is no limit
|
66
61
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -68,17 +63,14 @@ module Twilio
|
|
68
63
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
69
64
|
# efficient page size, i.e. min(limit, 1000)
|
70
65
|
# @return [Array] Array of up to limit results
|
71
|
-
def list(
|
72
|
-
self.stream(
|
66
|
+
def list(limit: nil, page_size: nil)
|
67
|
+
self.stream(limit: limit, page_size: page_size).entries
|
73
68
|
end
|
74
69
|
|
75
70
|
##
|
76
71
|
# Streams SyncMapInstance records from the API as an Enumerable.
|
77
72
|
# This operation lazily loads records as efficiently as possible until the limit
|
78
73
|
# 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
74
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
83
75
|
# guarantees to never return more than limit. Default is no limit.
|
84
76
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -86,10 +78,10 @@ module Twilio
|
|
86
78
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
87
79
|
# efficient page size, i.e. min(limit, 1000)
|
88
80
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
89
|
-
def stream(
|
81
|
+
def stream(limit: nil, page_size: nil)
|
90
82
|
limits = @version.read_limits(limit, page_size)
|
91
83
|
|
92
|
-
page = self.page(
|
84
|
+
page = self.page(page_size: limits[:page_size], )
|
93
85
|
|
94
86
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
95
87
|
end
|
@@ -111,16 +103,12 @@ module Twilio
|
|
111
103
|
##
|
112
104
|
# Retrieve a single page of SyncMapInstance records from the API.
|
113
105
|
# 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
106
|
# @param [String] page_token PageToken provided by the API
|
118
107
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
119
108
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
120
109
|
# @return [Page] Page of SyncMapInstance
|
121
|
-
def page(
|
110
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
122
111
|
params = Twilio::Values.of({
|
123
|
-
'HideExpired' => hide_expired,
|
124
112
|
'PageToken' => page_token,
|
125
113
|
'Page' => page_number,
|
126
114
|
'PageSize' => page_size,
|
@@ -151,8 +139,6 @@ module Twilio
|
|
151
139
|
end
|
152
140
|
end
|
153
141
|
|
154
|
-
##
|
155
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
156
142
|
class SyncMapPage < Page
|
157
143
|
##
|
158
144
|
# Initialize the SyncMapPage
|
@@ -182,8 +168,6 @@ module Twilio
|
|
182
168
|
end
|
183
169
|
end
|
184
170
|
|
185
|
-
##
|
186
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
187
171
|
class SyncMapContext < InstanceContext
|
188
172
|
##
|
189
173
|
# Initialize the SyncMapContext
|
@@ -191,7 +175,8 @@ module Twilio
|
|
191
175
|
# @param [String] service_sid The SID of the {Sync
|
192
176
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map
|
193
177
|
# resource to fetch.
|
194
|
-
# @param [String] sid The SID of the Sync Map resource to fetch.
|
178
|
+
# @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
|
179
|
+
# Map's `sid` or its `unique_name`.
|
195
180
|
# @return [SyncMapContext] SyncMapContext
|
196
181
|
def initialize(version, service_sid, sid)
|
197
182
|
super(version)
|
@@ -298,8 +283,6 @@ module Twilio
|
|
298
283
|
end
|
299
284
|
end
|
300
285
|
|
301
|
-
##
|
302
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
303
286
|
class SyncMapInstance < InstanceResource
|
304
287
|
##
|
305
288
|
# Initialize the SyncMapInstance
|
@@ -308,7 +291,8 @@ module Twilio
|
|
308
291
|
# @param [String] service_sid The SID of the {Sync
|
309
292
|
# Service}[https://www.twilio.com/docs/sync/api/service] the resource is
|
310
293
|
# associated with.
|
311
|
-
# @param [String] sid The SID of the Sync Map resource to fetch.
|
294
|
+
# @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
|
295
|
+
# Map's `sid` or its `unique_name`.
|
312
296
|
# @return [SyncMapInstance] SyncMapInstance
|
313
297
|
def initialize(version, payload, service_sid: nil, sid: nil)
|
314
298
|
super(version)
|