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 SyncMapContext < InstanceContext
|
15
|
-
##
|
16
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
17
15
|
class SyncMapItemList < ListResource
|
18
16
|
##
|
19
17
|
# Initialize the SyncMapItemList
|
@@ -36,7 +34,7 @@ module Twilio
|
|
36
34
|
# @param [String] key The unique, user-defined key for the Map Item. Can be up to
|
37
35
|
# 320 characters long.
|
38
36
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
39
|
-
# object that the Map Item stores. Can be up to
|
37
|
+
# object that the Map Item stores. Can be up to 16 KiB in length.
|
40
38
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
41
39
|
# this value is ignored.
|
42
40
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
@@ -85,9 +83,6 @@ module Twilio
|
|
85
83
|
# referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
|
86
84
|
# referenced by the `from` parameter or `exclusive` to start with the next Map
|
87
85
|
# 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
86
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
92
87
|
# guarantees to never return more than limit. Default is no limit
|
93
88
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -95,15 +90,8 @@ module Twilio
|
|
95
90
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
96
91
|
# efficient page size, i.e. min(limit, 1000)
|
97
92
|
# @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
|
93
|
+
def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
|
94
|
+
self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
|
107
95
|
end
|
108
96
|
|
109
97
|
##
|
@@ -121,9 +109,6 @@ module Twilio
|
|
121
109
|
# referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
|
122
110
|
# referenced by the `from` parameter or `exclusive` to start with the next Map
|
123
111
|
# 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
112
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
128
113
|
# guarantees to never return more than limit. Default is no limit.
|
129
114
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -131,16 +116,10 @@ module Twilio
|
|
131
116
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
132
117
|
# efficient page size, i.e. min(limit, 1000)
|
133
118
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
134
|
-
def stream(order: :unset, from: :unset, bounds: :unset,
|
119
|
+
def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
|
135
120
|
limits = @version.read_limits(limit, page_size)
|
136
121
|
|
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
|
-
)
|
122
|
+
page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
|
144
123
|
|
145
124
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
146
125
|
end
|
@@ -173,19 +152,15 @@ module Twilio
|
|
173
152
|
# referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
|
174
153
|
# referenced by the `from` parameter or `exclusive` to start with the next Map
|
175
154
|
# 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
155
|
# @param [String] page_token PageToken provided by the API
|
180
156
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
181
157
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
182
158
|
# @return [Page] Page of SyncMapItemInstance
|
183
|
-
def page(order: :unset, from: :unset, bounds: :unset,
|
159
|
+
def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
|
184
160
|
params = Twilio::Values.of({
|
185
161
|
'Order' => order,
|
186
162
|
'From' => from,
|
187
163
|
'Bounds' => bounds,
|
188
|
-
'HideExpired' => hide_expired,
|
189
164
|
'PageToken' => page_token,
|
190
165
|
'Page' => page_number,
|
191
166
|
'PageSize' => page_size,
|
@@ -216,8 +191,6 @@ module Twilio
|
|
216
191
|
end
|
217
192
|
end
|
218
193
|
|
219
|
-
##
|
220
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
221
194
|
class SyncMapItemPage < Page
|
222
195
|
##
|
223
196
|
# Initialize the SyncMapItemPage
|
@@ -252,8 +225,6 @@ module Twilio
|
|
252
225
|
end
|
253
226
|
end
|
254
227
|
|
255
|
-
##
|
256
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
257
228
|
class SyncMapItemContext < InstanceContext
|
258
229
|
##
|
259
230
|
# Initialize the SyncMapItemContext
|
@@ -262,7 +233,7 @@ module Twilio
|
|
262
233
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map Item
|
263
234
|
# resource to fetch.
|
264
235
|
# @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`.
|
236
|
+
# to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.
|
266
237
|
# @param [String] key The `key` value of the Sync Map Item resource to fetch.
|
267
238
|
# @return [SyncMapItemContext] SyncMapItemContext
|
268
239
|
def initialize(version, service_sid, map_sid, key)
|
@@ -290,7 +261,10 @@ module Twilio
|
|
290
261
|
|
291
262
|
##
|
292
263
|
# Delete the SyncMapItemInstance
|
293
|
-
# @param [String] if_match
|
264
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
265
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
266
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
267
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
294
268
|
# @return [Boolean] true if delete succeeds, false otherwise
|
295
269
|
def delete(if_match: :unset)
|
296
270
|
headers = Twilio::Values.of({'If-Match' => if_match, })
|
@@ -301,7 +275,7 @@ module Twilio
|
|
301
275
|
##
|
302
276
|
# Update the SyncMapItemInstance
|
303
277
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
304
|
-
# object that the Map Item stores. Can be up to
|
278
|
+
# object that the Map Item stores. Can be up to 16 KiB in length.
|
305
279
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
306
280
|
# this value is ignored.
|
307
281
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
@@ -316,7 +290,10 @@ module Twilio
|
|
316
290
|
# or `ttl` is updated in the same request. The Sync Map will be deleted
|
317
291
|
# automatically after it expires, but there can be a delay between the expiration
|
318
292
|
# time and the resources's deletion.
|
319
|
-
# @param [String] if_match
|
293
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
294
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
295
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
296
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
320
297
|
# @return [SyncMapItemInstance] Updated SyncMapItemInstance
|
321
298
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
|
322
299
|
data = Twilio::Values.of({
|
@@ -353,8 +330,6 @@ module Twilio
|
|
353
330
|
end
|
354
331
|
end
|
355
332
|
|
356
|
-
##
|
357
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
358
333
|
class SyncMapItemInstance < InstanceResource
|
359
334
|
##
|
360
335
|
# Initialize the SyncMapItemInstance
|
@@ -480,7 +455,10 @@ module Twilio
|
|
480
455
|
|
481
456
|
##
|
482
457
|
# Delete the SyncMapItemInstance
|
483
|
-
# @param [String] if_match
|
458
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
459
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
460
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
461
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
484
462
|
# @return [Boolean] true if delete succeeds, false otherwise
|
485
463
|
def delete(if_match: :unset)
|
486
464
|
context.delete(if_match: if_match, )
|
@@ -489,7 +467,7 @@ module Twilio
|
|
489
467
|
##
|
490
468
|
# Update the SyncMapItemInstance
|
491
469
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
492
|
-
# object that the Map Item stores. Can be up to
|
470
|
+
# object that the Map Item stores. Can be up to 16 KiB in length.
|
493
471
|
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
|
494
472
|
# this value is ignored.
|
495
473
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
@@ -504,7 +482,10 @@ module Twilio
|
|
504
482
|
# or `ttl` is updated in the same request. The Sync Map will be deleted
|
505
483
|
# automatically after it expires, but there can be a delay between the expiration
|
506
484
|
# time and the resources's deletion.
|
507
|
-
# @param [String] if_match
|
485
|
+
# @param [String] if_match If provided, applies this mutation if (and only if) the
|
486
|
+
# “revision” field of this {map item] matches the provided value. This matches the
|
487
|
+
# semantics of (and is implemented with) the HTTP [If-Match
|
488
|
+
# header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
|
508
489
|
# @return [SyncMapItemInstance] Updated SyncMapItemInstance
|
509
490
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
|
510
491
|
context.update(
|
@@ -12,8 +12,6 @@ module Twilio
|
|
12
12
|
class V1 < Version
|
13
13
|
class ServiceContext < InstanceContext
|
14
14
|
class SyncMapContext < InstanceContext
|
15
|
-
##
|
16
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
17
15
|
class SyncMapPermissionList < ListResource
|
18
16
|
##
|
19
17
|
# Initialize the SyncMapPermissionList
|
@@ -118,8 +116,6 @@ module Twilio
|
|
118
116
|
end
|
119
117
|
end
|
120
118
|
|
121
|
-
##
|
122
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
123
119
|
class SyncMapPermissionPage < Page
|
124
120
|
##
|
125
121
|
# Initialize the SyncMapPermissionPage
|
@@ -154,8 +150,6 @@ module Twilio
|
|
154
150
|
end
|
155
151
|
end
|
156
152
|
|
157
|
-
##
|
158
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
159
153
|
class SyncMapPermissionContext < InstanceContext
|
160
154
|
##
|
161
155
|
# Initialize the SyncMapPermissionContext
|
@@ -164,7 +158,7 @@ module Twilio
|
|
164
158
|
# Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map
|
165
159
|
# Permission resource to fetch. Can be the Service's `sid` value or `default`.
|
166
160
|
# @param [String] map_sid The SID of the Sync Map with the Sync Map Permission
|
167
|
-
# resource to fetch. Can be the Sync Map's `sid` or its `unique_name`.
|
161
|
+
# resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.
|
168
162
|
# @param [String] identity The application-defined string that uniquely identifies
|
169
163
|
# the User's Sync Map Permission resource to fetch.
|
170
164
|
# @return [SyncMapPermissionContext] SyncMapPermissionContext
|
@@ -236,8 +230,6 @@ module Twilio
|
|
236
230
|
end
|
237
231
|
end
|
238
232
|
|
239
|
-
##
|
240
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
241
233
|
class SyncMapPermissionInstance < InstanceResource
|
242
234
|
##
|
243
235
|
# Initialize the SyncMapPermissionInstance
|
@@ -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 SyncStreamList < ListResource
|
17
15
|
##
|
18
16
|
# Initialize the SyncStreamList
|
@@ -53,9 +51,6 @@ module Twilio
|
|
53
51
|
# Lists SyncStreamInstance records from the API as a list.
|
54
52
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
55
53
|
# memory before returning.
|
56
|
-
# @param [sync_stream.HideExpiredType] hide_expired The default list of Sync
|
57
|
-
# Streams will show both active and expired items. It is possible to filter only
|
58
|
-
# the active ones by hiding the expired ones.
|
59
54
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
60
55
|
# guarantees to never return more than limit. Default is no limit
|
61
56
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -63,17 +58,14 @@ module Twilio
|
|
63
58
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
64
59
|
# efficient page size, i.e. min(limit, 1000)
|
65
60
|
# @return [Array] Array of up to limit results
|
66
|
-
def list(
|
67
|
-
self.stream(
|
61
|
+
def list(limit: nil, page_size: nil)
|
62
|
+
self.stream(limit: limit, page_size: page_size).entries
|
68
63
|
end
|
69
64
|
|
70
65
|
##
|
71
66
|
# Streams SyncStreamInstance records from the API as an Enumerable.
|
72
67
|
# This operation lazily loads records as efficiently as possible until the limit
|
73
68
|
# is reached.
|
74
|
-
# @param [sync_stream.HideExpiredType] hide_expired The default list of Sync
|
75
|
-
# Streams will show both active and expired items. It is possible to filter only
|
76
|
-
# the active ones by hiding the expired ones.
|
77
69
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
78
70
|
# guarantees to never return more than limit. Default is no limit.
|
79
71
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -81,10 +73,10 @@ module Twilio
|
|
81
73
|
# but a limit is defined, stream() will attempt to read the limit with the most
|
82
74
|
# efficient page size, i.e. min(limit, 1000)
|
83
75
|
# @return [Enumerable] Enumerable that will yield up to limit results
|
84
|
-
def stream(
|
76
|
+
def stream(limit: nil, page_size: nil)
|
85
77
|
limits = @version.read_limits(limit, page_size)
|
86
78
|
|
87
|
-
page = self.page(
|
79
|
+
page = self.page(page_size: limits[:page_size], )
|
88
80
|
|
89
81
|
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
|
90
82
|
end
|
@@ -106,16 +98,12 @@ module Twilio
|
|
106
98
|
##
|
107
99
|
# Retrieve a single page of SyncStreamInstance records from the API.
|
108
100
|
# Request is executed immediately.
|
109
|
-
# @param [sync_stream.HideExpiredType] hide_expired The default list of Sync
|
110
|
-
# Streams will show both active and expired items. It is possible to filter only
|
111
|
-
# the active ones by hiding the expired ones.
|
112
101
|
# @param [String] page_token PageToken provided by the API
|
113
102
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
114
103
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
115
104
|
# @return [Page] Page of SyncStreamInstance
|
116
|
-
def page(
|
105
|
+
def page(page_token: :unset, page_number: :unset, page_size: :unset)
|
117
106
|
params = Twilio::Values.of({
|
118
|
-
'HideExpired' => hide_expired,
|
119
107
|
'PageToken' => page_token,
|
120
108
|
'Page' => page_number,
|
121
109
|
'PageSize' => page_size,
|
@@ -146,8 +134,6 @@ module Twilio
|
|
146
134
|
end
|
147
135
|
end
|
148
136
|
|
149
|
-
##
|
150
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
151
137
|
class SyncStreamPage < Page
|
152
138
|
##
|
153
139
|
# Initialize the SyncStreamPage
|
@@ -177,8 +163,6 @@ module Twilio
|
|
177
163
|
end
|
178
164
|
end
|
179
165
|
|
180
|
-
##
|
181
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
182
166
|
class SyncStreamContext < InstanceContext
|
183
167
|
##
|
184
168
|
# Initialize the SyncStreamContext
|
@@ -272,8 +256,6 @@ module Twilio
|
|
272
256
|
end
|
273
257
|
end
|
274
258
|
|
275
|
-
##
|
276
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
277
259
|
class SyncStreamInstance < InstanceResource
|
278
260
|
##
|
279
261
|
# Initialize the SyncStreamInstance
|
@@ -12,8 +12,6 @@ module Twilio
|
|
12
12
|
class V1 < Version
|
13
13
|
class ServiceContext < InstanceContext
|
14
14
|
class SyncStreamContext < InstanceContext
|
15
|
-
##
|
16
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
17
15
|
class StreamMessageList < ListResource
|
18
16
|
##
|
19
17
|
# Initialize the StreamMessageList
|
@@ -35,7 +33,7 @@ module Twilio
|
|
35
33
|
##
|
36
34
|
# Create the StreamMessageInstance
|
37
35
|
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
|
38
|
-
# object that makes up the Stream Message body. Can be up to
|
36
|
+
# object that makes up the Stream Message body. Can be up to 4 KiB in length.
|
39
37
|
# @return [StreamMessageInstance] Created StreamMessageInstance
|
40
38
|
def create(data: nil)
|
41
39
|
data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
|
@@ -57,8 +55,6 @@ module Twilio
|
|
57
55
|
end
|
58
56
|
end
|
59
57
|
|
60
|
-
##
|
61
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
62
58
|
class StreamMessagePage < Page
|
63
59
|
##
|
64
60
|
# Initialize the StreamMessagePage
|
@@ -93,8 +89,6 @@ module Twilio
|
|
93
89
|
end
|
94
90
|
end
|
95
91
|
|
96
|
-
##
|
97
|
-
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
|
98
92
|
class StreamMessageInstance < InstanceResource
|
99
93
|
##
|
100
94
|
# Initialize the StreamMessageInstance
|
@@ -31,10 +31,10 @@ module Twilio
|
|
31
31
|
# memory before returning.
|
32
32
|
# @param [String] priority The priority value of the Tasks to read. Returns the
|
33
33
|
# list of all Tasks in the Workspace with the specified priority.
|
34
|
-
# @param [String] assignment_status The `assignment_status` of the Tasks
|
35
|
-
# to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
|
36
|
-
# `completed`. Returns all Tasks in the Workspace with the
|
37
|
-
# `assignment_status`.
|
34
|
+
# @param [Array[String]] assignment_status The `assignment_status` of the Tasks
|
35
|
+
# you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
|
36
|
+
# `wrapping`, or `completed`. Returns all Tasks in the Workspace with the
|
37
|
+
# specified `assignment_status`.
|
38
38
|
# @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
|
39
39
|
# Returns the Tasks controlled by the Workflow identified by this SID.
|
40
40
|
# @param [String] workflow_name The friendly name of the Workflow with the Tasks
|
@@ -86,10 +86,10 @@ module Twilio
|
|
86
86
|
# is reached.
|
87
87
|
# @param [String] priority The priority value of the Tasks to read. Returns the
|
88
88
|
# list of all Tasks in the Workspace with the specified priority.
|
89
|
-
# @param [String] assignment_status The `assignment_status` of the Tasks
|
90
|
-
# to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
|
91
|
-
# `completed`. Returns all Tasks in the Workspace with the
|
92
|
-
# `assignment_status`.
|
89
|
+
# @param [Array[String]] assignment_status The `assignment_status` of the Tasks
|
90
|
+
# you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
|
91
|
+
# `wrapping`, or `completed`. Returns all Tasks in the Workspace with the
|
92
|
+
# specified `assignment_status`.
|
93
93
|
# @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
|
94
94
|
# Returns the Tasks controlled by the Workflow identified by this SID.
|
95
95
|
# @param [String] workflow_name The friendly name of the Workflow with the Tasks
|
@@ -157,10 +157,10 @@ module Twilio
|
|
157
157
|
# Request is executed immediately.
|
158
158
|
# @param [String] priority The priority value of the Tasks to read. Returns the
|
159
159
|
# list of all Tasks in the Workspace with the specified priority.
|
160
|
-
# @param [String] assignment_status The `assignment_status` of the Tasks
|
161
|
-
# to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
|
162
|
-
# `completed`. Returns all Tasks in the Workspace with the
|
163
|
-
# `assignment_status`.
|
160
|
+
# @param [Array[String]] assignment_status The `assignment_status` of the Tasks
|
161
|
+
# you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
|
162
|
+
# `wrapping`, or `completed`. Returns all Tasks in the Workspace with the
|
163
|
+
# specified `assignment_status`.
|
164
164
|
# @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
|
165
165
|
# Returns the Tasks controlled by the Workflow identified by this SID.
|
166
166
|
# @param [String] workflow_name The friendly name of the Workflow with the Tasks
|
@@ -223,10 +223,10 @@ module Twilio
|
|
223
223
|
|
224
224
|
##
|
225
225
|
# Create the TaskInstance
|
226
|
-
# @param [String] timeout The amount of time in seconds the new task
|
227
|
-
#
|
228
|
-
# is 24 hours (86,400 seconds). On timeout, the `task.canceled`
|
229
|
-
# with description `Task TTL Exceeded`.
|
226
|
+
# @param [String] timeout The amount of time in seconds the new task can live
|
227
|
+
# before being assigned. Can be up to a maximum of 2 weeks (1,209,600 seconds).
|
228
|
+
# The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled`
|
229
|
+
# event will fire with description `Task TTL Exceeded`.
|
230
230
|
# @param [String] priority The priority to assign the new task and override the
|
231
231
|
# default. When supplied, the new Task will have this priority unless it matches a
|
232
232
|
# Workflow Target with a Priority set. When not supplied, the new Task will have
|
@@ -539,7 +539,7 @@ module Twilio
|
|
539
539
|
end
|
540
540
|
|
541
541
|
##
|
542
|
-
# @return [String] The amount of time in seconds that the Task
|
542
|
+
# @return [String] The amount of time in seconds that the Task can live before being assigned
|
543
543
|
def timeout
|
544
544
|
@properties['timeout']
|
545
545
|
end
|
@@ -244,8 +244,8 @@ module Twilio
|
|
244
244
|
# `status_callback_method` to send status information to your application.
|
245
245
|
# @param [String] status_callback_method The HTTP method we should use to call
|
246
246
|
# `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
|
247
|
-
# @param [reservation.CallStatus] status_callback_event The call progress
|
248
|
-
# that we will send to `status_callback`. Can be: `initiated`, `ringing`,
|
247
|
+
# @param [Array[reservation.CallStatus]] status_callback_event The call progress
|
248
|
+
# events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
|
249
249
|
# `answered`, or `completed`.
|
250
250
|
# @param [String] timeout Timeout for call when executing a Conference
|
251
251
|
# instruction.
|
@@ -282,7 +282,7 @@ module Twilio
|
|
282
282
|
# @param [String] conference_status_callback_method The HTTP method we should use
|
283
283
|
# to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
|
284
284
|
# `POST`.
|
285
|
-
# @param [reservation.ConferenceEvent] conference_status_callback_event The
|
285
|
+
# @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
|
286
286
|
# conference status events that we will send to `conference_status_callback`. Can
|
287
287
|
# be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
|
288
288
|
# @param [String] conference_record Whether to record the conference the
|
@@ -310,8 +310,8 @@ module Twilio
|
|
310
310
|
# `br1`, `au1`, or `jp1`.
|
311
311
|
# @param [String] sip_auth_username The SIP username used for authentication.
|
312
312
|
# @param [String] sip_auth_password The SIP password for authentication.
|
313
|
-
# @param [String] dequeue_status_callback_event The Call progress events
|
314
|
-
# webhooks as a result of a Dequeue instruction.
|
313
|
+
# @param [Array[String]] dequeue_status_callback_event The Call progress events
|
314
|
+
# sent via webhooks as a result of a Dequeue instruction.
|
315
315
|
# @param [String] post_work_activity_sid The new worker activity SID after
|
316
316
|
# executing a Conference instruction.
|
317
317
|
# @param [reservation.SupervisorMode] supervisor_mode The Supervisor mode when
|
@@ -584,8 +584,8 @@ module Twilio
|
|
584
584
|
# `status_callback_method` to send status information to your application.
|
585
585
|
# @param [String] status_callback_method The HTTP method we should use to call
|
586
586
|
# `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
|
587
|
-
# @param [reservation.CallStatus] status_callback_event The call progress
|
588
|
-
# that we will send to `status_callback`. Can be: `initiated`, `ringing`,
|
587
|
+
# @param [Array[reservation.CallStatus]] status_callback_event The call progress
|
588
|
+
# events that we will send to `status_callback`. Can be: `initiated`, `ringing`,
|
589
589
|
# `answered`, or `completed`.
|
590
590
|
# @param [String] timeout Timeout for call when executing a Conference
|
591
591
|
# instruction.
|
@@ -622,7 +622,7 @@ module Twilio
|
|
622
622
|
# @param [String] conference_status_callback_method The HTTP method we should use
|
623
623
|
# to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
|
624
624
|
# `POST`.
|
625
|
-
# @param [reservation.ConferenceEvent] conference_status_callback_event The
|
625
|
+
# @param [Array[reservation.ConferenceEvent]] conference_status_callback_event The
|
626
626
|
# conference status events that we will send to `conference_status_callback`. Can
|
627
627
|
# be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
|
628
628
|
# @param [String] conference_record Whether to record the conference the
|
@@ -650,8 +650,8 @@ module Twilio
|
|
650
650
|
# `br1`, `au1`, or `jp1`.
|
651
651
|
# @param [String] sip_auth_username The SIP username used for authentication.
|
652
652
|
# @param [String] sip_auth_password The SIP password for authentication.
|
653
|
-
# @param [String] dequeue_status_callback_event The Call progress events
|
654
|
-
# webhooks as a result of a Dequeue instruction.
|
653
|
+
# @param [Array[String]] dequeue_status_callback_event The Call progress events
|
654
|
+
# sent via webhooks as a result of a Dequeue instruction.
|
655
655
|
# @param [String] post_work_activity_sid The new worker activity SID after
|
656
656
|
# executing a Conference instruction.
|
657
657
|
# @param [reservation.SupervisorMode] supervisor_mode The Supervisor mode when
|