twilio-ruby 5.27.0 → 5.27.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 +5 -5
- data/.dockerignore +1 -0
- data/CHANGES.md +13 -0
- data/CONTRIBUTING.md +2 -0
- data/Dockerfile +2 -2
- data/README.md +2 -2
- data/lib/twilio-ruby/http/http_client.rb +1 -1
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +18 -18
- data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +9 -9
- data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +9 -9
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +5 -5
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +10 -1
- data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +1 -1
- data/lib/twilio-ruby/rest/fax/v1/fax.rb +12 -12
- data/lib/twilio-ruby/rest/flex_api.rb +6 -3
- data/lib/twilio-ruby/rest/flex_api/v1.rb +3 -3
- data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +23 -23
- data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +39 -37
- data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +102 -96
- data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +20 -20
- data/lib/twilio-ruby/rest/messaging.rb +3 -2
- data/lib/twilio-ruby/rest/messaging/v1.rb +2 -3
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +124 -91
- data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +22 -18
- data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +22 -16
- data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +18 -20
- data/lib/twilio-ruby/rest/messaging/v1/session.rb +48 -44
- data/lib/twilio-ruby/rest/messaging/v1/session/message.rb +46 -48
- data/lib/twilio-ruby/rest/messaging/v1/session/participant.rb +55 -62
- data/lib/twilio-ruby/rest/messaging/v1/session/webhook.rb +61 -65
- data/lib/twilio-ruby/rest/messaging/v1/webhook.rb +30 -36
- data/lib/twilio-ruby/rest/monitor.rb +4 -2
- data/lib/twilio-ruby/rest/monitor/v1.rb +2 -2
- data/lib/twilio-ruby/rest/monitor/v1/alert.rb +45 -57
- data/lib/twilio-ruby/rest/monitor/v1/event.rb +47 -50
- data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +8 -8
- data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +3 -3
- data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +6 -6
- data/lib/twilio-ruby/rest/preview/trusted_comms/device.rb +1 -1
- data/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb +55 -55
- data/lib/twilio-ruby/rest/pricing/v2/voice.rb +2 -2
- data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +4 -4
- data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +1 -1
- data/lib/twilio-ruby/rest/serverless.rb +2 -1
- data/lib/twilio-ruby/rest/serverless/v1.rb +1 -2
- data/lib/twilio-ruby/rest/serverless/v1/service.rb +27 -28
- data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +22 -22
- data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +22 -22
- data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +25 -24
- data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +26 -24
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +21 -24
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb +31 -31
- data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +35 -35
- data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +22 -22
- data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +22 -22
- data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +12 -12
- data/lib/twilio-ruby/rest/sync/v1/service/document.rb +7 -4
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +6 -3
- data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +15 -9
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +6 -3
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +15 -9
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +9 -6
- data/lib/twilio-ruby/rest/taskrouter.rb +2 -1
- data/lib/twilio-ruby/rest/taskrouter/v1.rb +1 -1
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +102 -95
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +52 -44
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +90 -81
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +152 -136
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +35 -29
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +96 -89
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +61 -61
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +27 -21
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +46 -46
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +57 -64
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +98 -79
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +41 -39
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +39 -33
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +32 -31
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +16 -11
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +42 -42
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +75 -72
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +59 -51
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb +24 -18
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +54 -46
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +48 -46
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +17 -17
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +44 -42
- data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +24 -18
- data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +3 -3
- data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +1 -2
- data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +1 -2
- data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +12 -12
- data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +6 -6
- data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +6 -6
- data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +2 -1
- data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +2 -1
- data/lib/twilio-ruby/rest/video.rb +8 -8
- data/lib/twilio-ruby/rest/video/v1.rb +4 -7
- data/lib/twilio-ruby/rest/video/v1/composition.rb +89 -98
- data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +224 -195
- data/lib/twilio-ruby/rest/video/v1/composition_settings.rb +34 -34
- data/lib/twilio-ruby/rest/video/v1/recording.rb +53 -55
- data/lib/twilio-ruby/rest/video/v1/recording_settings.rb +32 -32
- data/lib/twilio-ruby/rest/video/v1/room.rb +71 -61
- data/lib/twilio-ruby/rest/video/v1/room/recording.rb +45 -33
- data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +56 -57
- data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb +25 -22
- data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +10 -10
- data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb +24 -23
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +1 -1
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +5 -5
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +2 -2
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/integration/conversations/v1/conversation/message_spec.rb +58 -0
- metadata +4 -4
|
@@ -30,11 +30,11 @@ module Twilio
|
|
|
30
30
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
31
31
|
# memory before returning.
|
|
32
32
|
# @param [Time] date_created_from Only show Execution resources starting on or
|
|
33
|
-
# after this [ISO 8601](
|
|
34
|
-
# date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
35
|
-
# @param [Time] date_created_to Only show Execution resources starting before this
|
|
36
|
-
# [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) date-time, given
|
|
33
|
+
# after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
|
|
37
34
|
# as `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
35
|
+
# @param [Time] date_created_to Only show Execution resources starting before this
|
|
36
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
|
|
37
|
+
# `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
38
38
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
39
39
|
# guarantees to never return more than limit. Default is no limit
|
|
40
40
|
# @param [Integer] page_size Number of records to fetch per request, when
|
|
@@ -56,11 +56,11 @@ module Twilio
|
|
|
56
56
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
57
57
|
# is reached.
|
|
58
58
|
# @param [Time] date_created_from Only show Execution resources starting on or
|
|
59
|
-
# after this [ISO 8601](
|
|
60
|
-
# date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
61
|
-
# @param [Time] date_created_to Only show Execution resources starting before this
|
|
62
|
-
# [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) date-time, given
|
|
59
|
+
# after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
|
|
63
60
|
# as `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
61
|
+
# @param [Time] date_created_to Only show Execution resources starting before this
|
|
62
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
|
|
63
|
+
# `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
64
64
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
65
65
|
# guarantees to never return more than limit. Default is no limit.
|
|
66
66
|
# @param [Integer] page_size Number of records to fetch per request, when
|
|
@@ -98,11 +98,11 @@ module Twilio
|
|
|
98
98
|
# Retrieve a single page of ExecutionInstance records from the API.
|
|
99
99
|
# Request is executed immediately.
|
|
100
100
|
# @param [Time] date_created_from Only show Execution resources starting on or
|
|
101
|
-
# after this [ISO 8601](
|
|
102
|
-
# date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
103
|
-
# @param [Time] date_created_to Only show Execution resources starting before this
|
|
104
|
-
# [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) date-time, given
|
|
101
|
+
# after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
|
|
105
102
|
# as `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
103
|
+
# @param [Time] date_created_to Only show Execution resources starting before this
|
|
104
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
|
|
105
|
+
# `YYYY-MM-DDThh:mm:ss-hh:mm`.
|
|
106
106
|
# @param [String] page_token PageToken provided by the API
|
|
107
107
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
108
108
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
|
@@ -39,8 +39,9 @@ module Twilio
|
|
|
39
39
|
# @param [String] ttl How long, in seconds, before the Sync Document expires and
|
|
40
40
|
# is deleted (the Sync Document's time-to-live). Can be an integer from 0 to
|
|
41
41
|
# 31,536,000 (1 year). The default value is `0`, which means the Sync Document
|
|
42
|
-
# does not expire. The Sync Document
|
|
43
|
-
# expires
|
|
42
|
+
# does not expire. The Sync Document will be deleted automatically after it
|
|
43
|
+
# expires, but there can be a delay between the expiration time and the
|
|
44
|
+
# resources's deletion.
|
|
44
45
|
# @return [DocumentInstance] Newly created DocumentInstance
|
|
45
46
|
def create(unique_name: :unset, data: :unset, ttl: :unset)
|
|
46
47
|
data = Twilio::Values.of({
|
|
@@ -229,7 +230,8 @@ module Twilio
|
|
|
229
230
|
# @param [String] ttl How long, in seconds, before the Sync Document expires and
|
|
230
231
|
# is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
|
|
231
232
|
# default value is `0`, which means the Document resource does not expire. The
|
|
232
|
-
# Document resource
|
|
233
|
+
# Document resource will be deleted automatically after it expires, but there can
|
|
234
|
+
# be a delay between the expiration time and the resources's deletion.
|
|
233
235
|
# @return [DocumentInstance] Updated DocumentInstance
|
|
234
236
|
def update(data: :unset, ttl: :unset)
|
|
235
237
|
data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
|
|
@@ -420,7 +422,8 @@ module Twilio
|
|
|
420
422
|
# @param [String] ttl How long, in seconds, before the Sync Document expires and
|
|
421
423
|
# is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
|
|
422
424
|
# default value is `0`, which means the Document resource does not expire. The
|
|
423
|
-
# Document resource
|
|
425
|
+
# Document resource will be deleted automatically after it expires, but there can
|
|
426
|
+
# be a delay between the expiration time and the resources's deletion.
|
|
424
427
|
# @return [DocumentInstance] Updated DocumentInstance
|
|
425
428
|
def update(data: :unset, ttl: :unset)
|
|
426
429
|
context.update(data: data, ttl: ttl, )
|
|
@@ -41,7 +41,8 @@ module Twilio
|
|
|
41
41
|
# @param [String] collection_ttl How long, in seconds, before the Sync List
|
|
42
42
|
# expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000
|
|
43
43
|
# (1 year). The default value is `0`, which means the Sync List does not expire.
|
|
44
|
-
# The Sync List
|
|
44
|
+
# The Sync List will be deleted automatically after it expires, but there can be a
|
|
45
|
+
# delay between the expiration time and the resources's deletion.
|
|
45
46
|
# @return [SyncListInstance] Newly created SyncListInstance
|
|
46
47
|
def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
|
|
47
48
|
data = Twilio::Values.of({
|
|
@@ -231,7 +232,8 @@ module Twilio
|
|
|
231
232
|
# @param [String] collection_ttl How long, in seconds, before the Sync List
|
|
232
233
|
# expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1
|
|
233
234
|
# year). The default value is `0`, which means the Sync List does not expire. The
|
|
234
|
-
# Sync List
|
|
235
|
+
# Sync List will be deleted automatically after it expires, but there can be a
|
|
236
|
+
# delay between the expiration time and the resources's deletion.
|
|
235
237
|
# @return [SyncListInstance] Updated SyncListInstance
|
|
236
238
|
def update(ttl: :unset, collection_ttl: :unset)
|
|
237
239
|
data = Twilio::Values.of({'Ttl' => ttl, 'CollectionTtl' => collection_ttl, })
|
|
@@ -437,7 +439,8 @@ module Twilio
|
|
|
437
439
|
# @param [String] collection_ttl How long, in seconds, before the Sync List
|
|
438
440
|
# expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1
|
|
439
441
|
# year). The default value is `0`, which means the Sync List does not expire. The
|
|
440
|
-
# Sync List
|
|
442
|
+
# Sync List will be deleted automatically after it expires, but there can be a
|
|
443
|
+
# delay between the expiration time and the resources's deletion.
|
|
441
444
|
# @return [SyncListInstance] Updated SyncListInstance
|
|
442
445
|
def update(ttl: :unset, collection_ttl: :unset)
|
|
443
446
|
context.update(ttl: ttl, collection_ttl: collection_ttl, )
|
|
@@ -41,12 +41,14 @@ module Twilio
|
|
|
41
41
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
|
42
42
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
43
43
|
# The default value is `0`, which means the List Item does not expire. The List
|
|
44
|
-
# Item
|
|
44
|
+
# Item will be deleted automatically after it expires, but there can be a delay
|
|
45
|
+
# between the expiration time and the resources's deletion.
|
|
45
46
|
# @param [String] collection_ttl How long, in seconds, before the List Item's
|
|
46
47
|
# parent Sync List expires (time-to-live) and is deleted. Can be an integer from
|
|
47
48
|
# 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
|
|
48
|
-
# List does not expire. The Sync List
|
|
49
|
-
# expires
|
|
49
|
+
# List does not expire. The Sync List will be deleted automatically after it
|
|
50
|
+
# expires, but there can be a delay between the expiration time and the
|
|
51
|
+
# resources's deletion.
|
|
50
52
|
# @return [SyncListItemInstance] Newly created SyncListItemInstance
|
|
51
53
|
def create(data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
|
|
52
54
|
data = Twilio::Values.of({
|
|
@@ -283,12 +285,14 @@ module Twilio
|
|
|
283
285
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
|
284
286
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
285
287
|
# The default value is `0`, which means the List Item does not expire. The List
|
|
286
|
-
# Item
|
|
288
|
+
# Item will be deleted automatically after it expires, but there can be a delay
|
|
289
|
+
# between the expiration time and the resources's deletion.
|
|
287
290
|
# @param [String] collection_ttl How long, in seconds, before the List Item's
|
|
288
291
|
# parent Sync List expires (time-to-live) and is deleted. Can be an integer from
|
|
289
292
|
# 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
|
|
290
|
-
# List does not expire. The Sync List
|
|
291
|
-
# expires
|
|
293
|
+
# List does not expire. The Sync List will be deleted automatically after it
|
|
294
|
+
# expires, but there can be a delay between the expiration time and the
|
|
295
|
+
# resources's deletion.
|
|
292
296
|
# @return [SyncListItemInstance] Updated SyncListItemInstance
|
|
293
297
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
|
|
294
298
|
data = Twilio::Values.of({
|
|
@@ -473,12 +477,14 @@ module Twilio
|
|
|
473
477
|
# @param [String] item_ttl How long, in seconds, before the List Item expires
|
|
474
478
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
475
479
|
# The default value is `0`, which means the List Item does not expire. The List
|
|
476
|
-
# Item
|
|
480
|
+
# Item will be deleted automatically after it expires, but there can be a delay
|
|
481
|
+
# between the expiration time and the resources's deletion.
|
|
477
482
|
# @param [String] collection_ttl How long, in seconds, before the List Item's
|
|
478
483
|
# parent Sync List expires (time-to-live) and is deleted. Can be an integer from
|
|
479
484
|
# 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
|
|
480
|
-
# List does not expire. The Sync List
|
|
481
|
-
# expires
|
|
485
|
+
# List does not expire. The Sync List will be deleted automatically after it
|
|
486
|
+
# expires, but there can be a delay between the expiration time and the
|
|
487
|
+
# resources's deletion.
|
|
482
488
|
# @return [SyncListItemInstance] Updated SyncListItemInstance
|
|
483
489
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
|
|
484
490
|
context.update(data: data, ttl: ttl, item_ttl: item_ttl, collection_ttl: collection_ttl, )
|
|
@@ -40,7 +40,8 @@ module Twilio
|
|
|
40
40
|
# @param [String] collection_ttl How long, in seconds, before the Sync Map expires
|
|
41
41
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
42
42
|
# The default value is `0`, which means the Sync Map does not expire. The Sync Map
|
|
43
|
-
#
|
|
43
|
+
# will be deleted automatically after it expires, but there can be a delay between
|
|
44
|
+
# the expiration time and the resources's deletion.
|
|
44
45
|
# @return [SyncMapInstance] Newly created SyncMapInstance
|
|
45
46
|
def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
|
|
46
47
|
data = Twilio::Values.of({
|
|
@@ -230,7 +231,8 @@ module Twilio
|
|
|
230
231
|
# @param [String] collection_ttl How long, in seconds, before the Sync Map expires
|
|
231
232
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
232
233
|
# The default value is `0`, which means the Sync Map does not expire. The Sync Map
|
|
233
|
-
#
|
|
234
|
+
# will be deleted automatically after it expires, but there can be a delay between
|
|
235
|
+
# the expiration time and the resources's deletion.
|
|
234
236
|
# @return [SyncMapInstance] Updated SyncMapInstance
|
|
235
237
|
def update(ttl: :unset, collection_ttl: :unset)
|
|
236
238
|
data = Twilio::Values.of({'Ttl' => ttl, 'CollectionTtl' => collection_ttl, })
|
|
@@ -436,7 +438,8 @@ module Twilio
|
|
|
436
438
|
# @param [String] collection_ttl How long, in seconds, before the Sync Map expires
|
|
437
439
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
438
440
|
# The default value is `0`, which means the Sync Map does not expire. The Sync Map
|
|
439
|
-
#
|
|
441
|
+
# will be deleted automatically after it expires, but there can be a delay between
|
|
442
|
+
# the expiration time and the resources's deletion.
|
|
440
443
|
# @return [SyncMapInstance] Updated SyncMapInstance
|
|
441
444
|
def update(ttl: :unset, collection_ttl: :unset)
|
|
442
445
|
context.update(ttl: ttl, collection_ttl: collection_ttl, )
|
|
@@ -43,12 +43,14 @@ module Twilio
|
|
|
43
43
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
|
44
44
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
45
45
|
# The default value is `0`, which means the Map Item does not expire. The Map
|
|
46
|
-
# Item
|
|
46
|
+
# Item will be deleted automatically after it expires, but there can be a delay
|
|
47
|
+
# between the expiration time and the resources's deletion.
|
|
47
48
|
# @param [String] collection_ttl How long, in seconds, before the Map Item's
|
|
48
49
|
# parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0
|
|
49
50
|
# to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
|
|
50
|
-
# Map does not expire. The Sync Map
|
|
51
|
-
# expires
|
|
51
|
+
# Map does not expire. The Sync Map will be deleted automatically after it
|
|
52
|
+
# expires, but there can be a delay between the expiration time and the
|
|
53
|
+
# resources's deletion.
|
|
52
54
|
# @return [SyncMapItemInstance] Newly created SyncMapItemInstance
|
|
53
55
|
def create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
|
|
54
56
|
data = Twilio::Values.of({
|
|
@@ -292,13 +294,15 @@ module Twilio
|
|
|
292
294
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
|
293
295
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
294
296
|
# The default value is `0`, which means the Map Item does not expire. The Map Item
|
|
295
|
-
#
|
|
297
|
+
# will be deleted automatically after it expires, but there can be a delay between
|
|
298
|
+
# the expiration time and the resources's deletion.
|
|
296
299
|
# @param [String] collection_ttl How long, in seconds, before the Map Item's
|
|
297
300
|
# parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0
|
|
298
301
|
# to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
|
|
299
302
|
# Map does not expire. This parameter can only be used when the Map Item's `data`
|
|
300
|
-
# or `ttl` is updated in the same request. The Sync Map
|
|
301
|
-
#
|
|
303
|
+
# or `ttl` is updated in the same request. The Sync Map will be deleted
|
|
304
|
+
# automatically after it expires, but there can be a delay between the expiration
|
|
305
|
+
# time and the resources's deletion.
|
|
302
306
|
# @return [SyncMapItemInstance] Updated SyncMapItemInstance
|
|
303
307
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
|
|
304
308
|
data = Twilio::Values.of({
|
|
@@ -479,13 +483,15 @@ module Twilio
|
|
|
479
483
|
# @param [String] item_ttl How long, in seconds, before the Map Item expires
|
|
480
484
|
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
|
|
481
485
|
# The default value is `0`, which means the Map Item does not expire. The Map Item
|
|
482
|
-
#
|
|
486
|
+
# will be deleted automatically after it expires, but there can be a delay between
|
|
487
|
+
# the expiration time and the resources's deletion.
|
|
483
488
|
# @param [String] collection_ttl How long, in seconds, before the Map Item's
|
|
484
489
|
# parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0
|
|
485
490
|
# to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
|
|
486
491
|
# Map does not expire. This parameter can only be used when the Map Item's `data`
|
|
487
|
-
# or `ttl` is updated in the same request. The Sync Map
|
|
488
|
-
#
|
|
492
|
+
# or `ttl` is updated in the same request. The Sync Map will be deleted
|
|
493
|
+
# automatically after it expires, but there can be a delay between the expiration
|
|
494
|
+
# time and the resources's deletion.
|
|
489
495
|
# @return [SyncMapItemInstance] Updated SyncMapItemInstance
|
|
490
496
|
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
|
|
491
497
|
context.update(data: data, ttl: ttl, item_ttl: item_ttl, collection_ttl: collection_ttl, )
|
|
@@ -38,8 +38,9 @@ module Twilio
|
|
|
38
38
|
# alternative to the `sid` in the URL path to address the resource.
|
|
39
39
|
# @param [String] ttl How long, in seconds, before the Stream expires and is
|
|
40
40
|
# deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
|
|
41
|
-
# default value is `0`, which means the Stream does not expire. The Stream
|
|
42
|
-
#
|
|
41
|
+
# default value is `0`, which means the Stream does not expire. The Stream will be
|
|
42
|
+
# deleted automatically after it expires, but there can be a delay between the
|
|
43
|
+
# expiration time and the resources's deletion.
|
|
43
44
|
# @return [SyncStreamInstance] Newly created SyncStreamInstance
|
|
44
45
|
def create(unique_name: :unset, ttl: :unset)
|
|
45
46
|
data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
|
|
@@ -226,8 +227,9 @@ module Twilio
|
|
|
226
227
|
# Update the SyncStreamInstance
|
|
227
228
|
# @param [String] ttl How long, in seconds, before the Stream expires and is
|
|
228
229
|
# deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
|
|
229
|
-
# default value is `0`, which means the Stream does not expire. The
|
|
230
|
-
#
|
|
230
|
+
# default value is `0`, which means the Stream does not expire. The Stream will be
|
|
231
|
+
# deleted automatically after it expires, but there can be a delay between the
|
|
232
|
+
# expiration time and the resources's deletion.
|
|
231
233
|
# @return [SyncStreamInstance] Updated SyncStreamInstance
|
|
232
234
|
def update(ttl: :unset)
|
|
233
235
|
data = Twilio::Values.of({'Ttl' => ttl, })
|
|
@@ -400,8 +402,9 @@ module Twilio
|
|
|
400
402
|
# Update the SyncStreamInstance
|
|
401
403
|
# @param [String] ttl How long, in seconds, before the Stream expires and is
|
|
402
404
|
# deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
|
|
403
|
-
# default value is `0`, which means the Stream does not expire. The
|
|
404
|
-
#
|
|
405
|
+
# default value is `0`, which means the Stream does not expire. The Stream will be
|
|
406
|
+
# deleted automatically after it expires, but there can be a delay between the
|
|
407
|
+
# expiration time and the resources's deletion.
|
|
405
408
|
# @return [SyncStreamInstance] Updated SyncStreamInstance
|
|
406
409
|
def update(ttl: :unset)
|
|
407
410
|
context.update(ttl: ttl, )
|
|
@@ -29,7 +29,8 @@ module Twilio
|
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
##
|
|
32
|
-
# @param [String] sid The unique
|
|
32
|
+
# @param [String] sid The unique string that we created to identify the Workspace
|
|
33
|
+
# resource.
|
|
33
34
|
# @return [Twilio::REST::Taskrouter::V1::WorkspaceInstance] if sid was passed.
|
|
34
35
|
# @return [Twilio::REST::Taskrouter::V1::WorkspaceList]
|
|
35
36
|
def workspaces(sid=:unset)
|
|
@@ -19,7 +19,7 @@ module Twilio
|
|
|
19
19
|
end
|
|
20
20
|
|
|
21
21
|
##
|
|
22
|
-
# @param [String] sid The
|
|
22
|
+
# @param [String] sid The SID of the Workspace resource to fetch.
|
|
23
23
|
# @return [Twilio::REST::Taskrouter::V1::WorkspaceContext] if sid was passed.
|
|
24
24
|
# @return [Twilio::REST::Taskrouter::V1::WorkspaceList]
|
|
25
25
|
def workspaces(sid=:unset)
|
|
@@ -27,9 +27,8 @@ module Twilio
|
|
|
27
27
|
# Lists WorkspaceInstance records from the API as a list.
|
|
28
28
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
|
29
29
|
# memory before returning.
|
|
30
|
-
# @param [String] friendly_name
|
|
31
|
-
#
|
|
32
|
-
# "2014 Election Campaign")
|
|
30
|
+
# @param [String] friendly_name The `friendly_name` of the Workspace resources to
|
|
31
|
+
# read. For example `Customer Support` or `2014 Election Campaign`.
|
|
33
32
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
34
33
|
# guarantees to never return more than limit. Default is no limit
|
|
35
34
|
# @param [Integer] page_size Number of records to fetch per request, when
|
|
@@ -45,9 +44,8 @@ module Twilio
|
|
|
45
44
|
# Streams WorkspaceInstance records from the API as an Enumerable.
|
|
46
45
|
# This operation lazily loads records as efficiently as possible until the limit
|
|
47
46
|
# is reached.
|
|
48
|
-
# @param [String] friendly_name
|
|
49
|
-
#
|
|
50
|
-
# "2014 Election Campaign")
|
|
47
|
+
# @param [String] friendly_name The `friendly_name` of the Workspace resources to
|
|
48
|
+
# read. For example `Customer Support` or `2014 Election Campaign`.
|
|
51
49
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
|
52
50
|
# guarantees to never return more than limit. Default is no limit.
|
|
53
51
|
# @param [Integer] page_size Number of records to fetch per request, when
|
|
@@ -80,9 +78,8 @@ module Twilio
|
|
|
80
78
|
##
|
|
81
79
|
# Retrieve a single page of WorkspaceInstance records from the API.
|
|
82
80
|
# Request is executed immediately.
|
|
83
|
-
# @param [String] friendly_name
|
|
84
|
-
#
|
|
85
|
-
# "2014 Election Campaign")
|
|
81
|
+
# @param [String] friendly_name The `friendly_name` of the Workspace resources to
|
|
82
|
+
# read. For example `Customer Support` or `2014 Election Campaign`.
|
|
86
83
|
# @param [String] page_token PageToken provided by the API
|
|
87
84
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
|
88
85
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
|
@@ -118,33 +115,35 @@ module Twilio
|
|
|
118
115
|
##
|
|
119
116
|
# Retrieve a single page of WorkspaceInstance records from the API.
|
|
120
117
|
# Request is executed immediately.
|
|
121
|
-
# @param [String] friendly_name
|
|
122
|
-
#
|
|
123
|
-
#
|
|
124
|
-
#
|
|
125
|
-
#
|
|
126
|
-
#
|
|
127
|
-
#
|
|
128
|
-
#
|
|
129
|
-
#
|
|
130
|
-
# canceled
|
|
131
|
-
#
|
|
132
|
-
#
|
|
133
|
-
#
|
|
134
|
-
#
|
|
135
|
-
#
|
|
136
|
-
#
|
|
137
|
-
#
|
|
138
|
-
#
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
142
|
-
#
|
|
143
|
-
#
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
147
|
-
#
|
|
118
|
+
# @param [String] friendly_name A descriptive string that you create to describe
|
|
119
|
+
# the Workspace resource. It can be up to 64 characters long. For example:
|
|
120
|
+
# `Customer Support` or `2014 Election Campaign`.
|
|
121
|
+
# @param [String] event_callback_url The URL we should call when an event occurs.
|
|
122
|
+
# If provided, the Workspace will publish events to this URL, for example, to
|
|
123
|
+
# collect data for reporting. See [Workspace
|
|
124
|
+
# Events](https://www.twilio.com/docs/taskrouter/api/event) for more information.
|
|
125
|
+
# @param [String] events_filter The list of Workspace events for which to call
|
|
126
|
+
# event_callback_url. For example if
|
|
127
|
+
# `EventsFilter=task.created,task.canceled,worker.activity.update`, then
|
|
128
|
+
# TaskRouter will call event_callback_url only when a task is created, canceled,
|
|
129
|
+
# or a Worker activity is updated.
|
|
130
|
+
# @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
|
|
131
|
+
# `true` to enable multi-tasking, or `false` to disable it. The default is
|
|
132
|
+
# `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
|
|
133
|
+
# When enabled (`true`), each Worker can receive parallel reservations up to the
|
|
134
|
+
# per-channel maximums defined in the Workers section. Otherwise, each Worker will
|
|
135
|
+
# only receive a new reservation when the previous task is completed. Learn more
|
|
136
|
+
# at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].
|
|
137
|
+
# @param [String] template An available template name. Can be: `NONE` or `FIFO`
|
|
138
|
+
# and the default is `NONE`. Pre-configures the Workspace with the Workflow and
|
|
139
|
+
# Activities specified in the template. `NONE` will create a Workspace with only a
|
|
140
|
+
# set of default activities. `FIFO` will configure TaskRouter with a set of
|
|
141
|
+
# default activities and a single TaskQueue for first-in, first-out distribution,
|
|
142
|
+
# which can be useful when you are getting started with TaskRouter.
|
|
143
|
+
# @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
|
|
144
|
+
# prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
|
|
145
|
+
# be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue
|
|
146
|
+
# Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
|
|
148
147
|
# @return [WorkspaceInstance] Newly created WorkspaceInstance
|
|
149
148
|
def create(friendly_name: nil, event_callback_url: :unset, events_filter: :unset, multi_task_enabled: :unset, template: :unset, prioritize_queue_order: :unset)
|
|
150
149
|
data = Twilio::Values.of({
|
|
@@ -205,7 +204,7 @@ module Twilio
|
|
|
205
204
|
##
|
|
206
205
|
# Initialize the WorkspaceContext
|
|
207
206
|
# @param [Version] version Version that contains the resource
|
|
208
|
-
# @param [String] sid The
|
|
207
|
+
# @param [String] sid The SID of the Workspace resource to fetch.
|
|
209
208
|
# @return [WorkspaceContext] WorkspaceContext
|
|
210
209
|
def initialize(version, sid)
|
|
211
210
|
super(version)
|
|
@@ -244,28 +243,32 @@ module Twilio
|
|
|
244
243
|
|
|
245
244
|
##
|
|
246
245
|
# Update the WorkspaceInstance
|
|
247
|
-
# @param [String] default_activity_sid The
|
|
248
|
-
# when new Workers are created in
|
|
249
|
-
# @param [String] event_callback_url The
|
|
250
|
-
#
|
|
251
|
-
#
|
|
252
|
-
# @param [String] events_filter
|
|
253
|
-
#
|
|
254
|
-
#
|
|
255
|
-
# TaskRouter will
|
|
256
|
-
#
|
|
257
|
-
# @param [String] friendly_name
|
|
258
|
-
# example
|
|
259
|
-
#
|
|
260
|
-
#
|
|
261
|
-
#
|
|
262
|
-
#
|
|
246
|
+
# @param [String] default_activity_sid The SID of the Activity that will be used
|
|
247
|
+
# when new Workers are created in the Workspace.
|
|
248
|
+
# @param [String] event_callback_url The URL we should call when an event occurs.
|
|
249
|
+
# See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for
|
|
250
|
+
# more information.
|
|
251
|
+
# @param [String] events_filter The list of Workspace events for which to call
|
|
252
|
+
# event_callback_url. For example if
|
|
253
|
+
# `EventsFilter=task.created,task.canceled,worker.activity.update`, then
|
|
254
|
+
# TaskRouter will call event_callback_url only when a task is created, canceled,
|
|
255
|
+
# or a Worker activity is updated.
|
|
256
|
+
# @param [String] friendly_name A descriptive string that you create to describe
|
|
257
|
+
# the Workspace resource. For example: `Sales Call Center` or `Customer Support
|
|
258
|
+
# Team`.
|
|
259
|
+
# @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
|
|
260
|
+
# `true` to enable multi-tasking, or `false` to disable it. The default is
|
|
261
|
+
# `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
|
|
262
|
+
# When enabled (`true`), each Worker can receive parallel reservations up to the
|
|
263
|
+
# per-channel maximums defined in the Workers section. Otherwise, each Worker will
|
|
264
|
+
# only receive a new reservation when the previous task is completed. Learn more
|
|
265
|
+
# at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].
|
|
266
|
+
# @param [String] timeout_activity_sid The SID of the Activity that will be
|
|
263
267
|
# assigned to a Worker when a Task reservation times out without a response.
|
|
264
|
-
# @param [workspace.QueueOrder] prioritize_queue_order
|
|
265
|
-
#
|
|
266
|
-
#
|
|
267
|
-
#
|
|
268
|
-
# LIFO and the use of the parameter.
|
|
268
|
+
# @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
|
|
269
|
+
# prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
|
|
270
|
+
# be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue
|
|
271
|
+
# Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
|
|
269
272
|
# @return [WorkspaceInstance] Updated WorkspaceInstance
|
|
270
273
|
def update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset)
|
|
271
274
|
data = Twilio::Values.of({
|
|
@@ -464,7 +467,7 @@ module Twilio
|
|
|
464
467
|
# Initialize the WorkspaceInstance
|
|
465
468
|
# @param [Version] version Version that contains the resource
|
|
466
469
|
# @param [Hash] payload payload that contains response from Twilio
|
|
467
|
-
# @param [String] sid The
|
|
470
|
+
# @param [String] sid The SID of the Workspace resource to fetch.
|
|
468
471
|
# @return [WorkspaceInstance] WorkspaceInstance
|
|
469
472
|
def initialize(version, payload, sid: nil)
|
|
470
473
|
super(version)
|
|
@@ -505,91 +508,91 @@ module Twilio
|
|
|
505
508
|
end
|
|
506
509
|
|
|
507
510
|
##
|
|
508
|
-
# @return [String] The
|
|
511
|
+
# @return [String] The SID of the Account that created the resource
|
|
509
512
|
def account_sid
|
|
510
513
|
@properties['account_sid']
|
|
511
514
|
end
|
|
512
515
|
|
|
513
516
|
##
|
|
514
|
-
# @return [Time] The
|
|
517
|
+
# @return [Time] The ISO 8601 date and time in GMT when the resource was created
|
|
515
518
|
def date_created
|
|
516
519
|
@properties['date_created']
|
|
517
520
|
end
|
|
518
521
|
|
|
519
522
|
##
|
|
520
|
-
# @return [Time] The
|
|
523
|
+
# @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
|
|
521
524
|
def date_updated
|
|
522
525
|
@properties['date_updated']
|
|
523
526
|
end
|
|
524
527
|
|
|
525
528
|
##
|
|
526
|
-
# @return [String] The
|
|
529
|
+
# @return [String] The name of the default activity
|
|
527
530
|
def default_activity_name
|
|
528
531
|
@properties['default_activity_name']
|
|
529
532
|
end
|
|
530
533
|
|
|
531
534
|
##
|
|
532
|
-
# @return [String] The
|
|
535
|
+
# @return [String] The SID of the Activity that will be used when new Workers are created in the Workspace
|
|
533
536
|
def default_activity_sid
|
|
534
537
|
@properties['default_activity_sid']
|
|
535
538
|
end
|
|
536
539
|
|
|
537
540
|
##
|
|
538
|
-
# @return [String]
|
|
541
|
+
# @return [String] The URL we call when an event occurs
|
|
539
542
|
def event_callback_url
|
|
540
543
|
@properties['event_callback_url']
|
|
541
544
|
end
|
|
542
545
|
|
|
543
546
|
##
|
|
544
|
-
# @return [String]
|
|
547
|
+
# @return [String] The list of Workspace events for which to call event_callback_url
|
|
545
548
|
def events_filter
|
|
546
549
|
@properties['events_filter']
|
|
547
550
|
end
|
|
548
551
|
|
|
549
552
|
##
|
|
550
|
-
# @return [String]
|
|
553
|
+
# @return [String] The string that you assigned to describe the Workspace resource
|
|
551
554
|
def friendly_name
|
|
552
555
|
@properties['friendly_name']
|
|
553
556
|
end
|
|
554
557
|
|
|
555
558
|
##
|
|
556
|
-
# @return [Boolean]
|
|
559
|
+
# @return [Boolean] Whether multi-tasking is enabled
|
|
557
560
|
def multi_task_enabled
|
|
558
561
|
@properties['multi_task_enabled']
|
|
559
562
|
end
|
|
560
563
|
|
|
561
564
|
##
|
|
562
|
-
# @return [String] The unique
|
|
565
|
+
# @return [String] The unique string that identifies the resource
|
|
563
566
|
def sid
|
|
564
567
|
@properties['sid']
|
|
565
568
|
end
|
|
566
569
|
|
|
567
570
|
##
|
|
568
|
-
# @return [String] The
|
|
571
|
+
# @return [String] The name of the timeout activity
|
|
569
572
|
def timeout_activity_name
|
|
570
573
|
@properties['timeout_activity_name']
|
|
571
574
|
end
|
|
572
575
|
|
|
573
576
|
##
|
|
574
|
-
# @return [String] The
|
|
577
|
+
# @return [String] The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response
|
|
575
578
|
def timeout_activity_sid
|
|
576
579
|
@properties['timeout_activity_sid']
|
|
577
580
|
end
|
|
578
581
|
|
|
579
582
|
##
|
|
580
|
-
# @return [workspace.QueueOrder]
|
|
583
|
+
# @return [workspace.QueueOrder] The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues
|
|
581
584
|
def prioritize_queue_order
|
|
582
585
|
@properties['prioritize_queue_order']
|
|
583
586
|
end
|
|
584
587
|
|
|
585
588
|
##
|
|
586
|
-
# @return [String] The
|
|
589
|
+
# @return [String] The absolute URL of the Workspace resource
|
|
587
590
|
def url
|
|
588
591
|
@properties['url']
|
|
589
592
|
end
|
|
590
593
|
|
|
591
594
|
##
|
|
592
|
-
# @return [String] The
|
|
595
|
+
# @return [String] The URLs of related resources
|
|
593
596
|
def links
|
|
594
597
|
@properties['links']
|
|
595
598
|
end
|
|
@@ -603,28 +606,32 @@ module Twilio
|
|
|
603
606
|
|
|
604
607
|
##
|
|
605
608
|
# Update the WorkspaceInstance
|
|
606
|
-
# @param [String] default_activity_sid The
|
|
607
|
-
# when new Workers are created in
|
|
608
|
-
# @param [String] event_callback_url The
|
|
609
|
-
#
|
|
610
|
-
#
|
|
611
|
-
# @param [String] events_filter
|
|
612
|
-
#
|
|
613
|
-
#
|
|
614
|
-
# TaskRouter will
|
|
615
|
-
#
|
|
616
|
-
# @param [String] friendly_name
|
|
617
|
-
# example
|
|
618
|
-
#
|
|
619
|
-
#
|
|
620
|
-
#
|
|
621
|
-
#
|
|
609
|
+
# @param [String] default_activity_sid The SID of the Activity that will be used
|
|
610
|
+
# when new Workers are created in the Workspace.
|
|
611
|
+
# @param [String] event_callback_url The URL we should call when an event occurs.
|
|
612
|
+
# See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for
|
|
613
|
+
# more information.
|
|
614
|
+
# @param [String] events_filter The list of Workspace events for which to call
|
|
615
|
+
# event_callback_url. For example if
|
|
616
|
+
# `EventsFilter=task.created,task.canceled,worker.activity.update`, then
|
|
617
|
+
# TaskRouter will call event_callback_url only when a task is created, canceled,
|
|
618
|
+
# or a Worker activity is updated.
|
|
619
|
+
# @param [String] friendly_name A descriptive string that you create to describe
|
|
620
|
+
# the Workspace resource. For example: `Sales Call Center` or `Customer Support
|
|
621
|
+
# Team`.
|
|
622
|
+
# @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
|
|
623
|
+
# `true` to enable multi-tasking, or `false` to disable it. The default is
|
|
624
|
+
# `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
|
|
625
|
+
# When enabled (`true`), each Worker can receive parallel reservations up to the
|
|
626
|
+
# per-channel maximums defined in the Workers section. Otherwise, each Worker will
|
|
627
|
+
# only receive a new reservation when the previous task is completed. Learn more
|
|
628
|
+
# at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].
|
|
629
|
+
# @param [String] timeout_activity_sid The SID of the Activity that will be
|
|
622
630
|
# assigned to a Worker when a Task reservation times out without a response.
|
|
623
|
-
# @param [workspace.QueueOrder] prioritize_queue_order
|
|
624
|
-
#
|
|
625
|
-
#
|
|
626
|
-
#
|
|
627
|
-
# LIFO and the use of the parameter.
|
|
631
|
+
# @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
|
|
632
|
+
# prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
|
|
633
|
+
# be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue
|
|
634
|
+
# Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
|
|
628
635
|
# @return [WorkspaceInstance] Updated WorkspaceInstance
|
|
629
636
|
def update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset)
|
|
630
637
|
context.update(
|