twilio-ruby 6.7.1 → 6.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +34 -0
- data/README.md +2 -2
- data/lib/twilio-ruby/base/client_base.rb +2 -2
- data/lib/twilio-ruby/rest/{api/v2010 → accounts/v1}/safelist.rb +8 -8
- data/lib/twilio-ruby/rest/accounts/v1.rb +6 -0
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +4 -1
- data/lib/twilio-ruby/rest/api/v2010.rb +0 -6
- data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +7 -0
- data/lib/twilio-ruby/rest/intelligence/v2/transcript/media.rb +2 -2
- data/lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb +5 -5
- data/lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb +3 -3
- data/lib/twilio-ruby/rest/intelligence/v2/transcript.rb +4 -15
- data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb +4 -4
- data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb +2 -2
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +20 -4
- data/lib/twilio-ruby/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 82c2bcdb93cad6d5bc90e2883ad05277f43b5f0b
|
4
|
+
data.tar.gz: d990c513639de4b750de151fc9a9c0c69b31fc7a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fec5d354d99ba5d54fc03c144156df521e81ac6c23cdb51c099e8e343fb7bd85bd4b3b1c0607d22f7b21c341b94cca9d28d266f5294d83ce275747369fcb64c9
|
7
|
+
data.tar.gz: '09b109c1d3df8e5548cfd0a0006d111933f51ba8164e13fa6a3f960e8541c34c62f7a9b6eadef1237871ac87af14490da9e883b5a3d84332cb3cb4e435f17503'
|
data/CHANGES.md
CHANGED
@@ -1,6 +1,40 @@
|
|
1
1
|
twilio-ruby changelog
|
2
2
|
=====================
|
3
3
|
|
4
|
+
[2023-10-19] Version 6.8.0
|
5
|
+
--------------------------
|
6
|
+
**Library - Chore**
|
7
|
+
- [PR #682](https://github.com/twilio/twilio-ruby/pull/682): Removing Test Related To Deprecated Endpoint - OAuth. Thanks to [@KobeBrooks](https://github.com/KobeBrooks)!
|
8
|
+
|
9
|
+
**Library - Fix**
|
10
|
+
- [PR #680](https://github.com/twilio/twilio-ruby/pull/680): update validate ssl method with new endpoint. Thanks to [@AsabuHere](https://github.com/AsabuHere)!
|
11
|
+
|
12
|
+
**Accounts**
|
13
|
+
- Updated Safelist metadata to correct the docs.
|
14
|
+
- Add Global SafeList API changes
|
15
|
+
|
16
|
+
**Api**
|
17
|
+
- Added optional parameter `CallToken` for create participant api
|
18
|
+
|
19
|
+
**Flex**
|
20
|
+
- Adding `offline_config` to Flex Configuration
|
21
|
+
|
22
|
+
**Intelligence**
|
23
|
+
- Deleted `redacted` parameter from fetching transcript in v2 **(breaking change)**
|
24
|
+
|
25
|
+
**Lookups**
|
26
|
+
- Add new `phone_number_quality_score` package to the lookup response
|
27
|
+
- Remove `disposable_phone_number_risk` package **(breaking change)**
|
28
|
+
|
29
|
+
**Messaging**
|
30
|
+
- Update US App To Person documentation with current `message_samples` requirements
|
31
|
+
|
32
|
+
**Taskrouter**
|
33
|
+
- Remove beta_feature check on task_queue_bulk_real_time_statistics endpoint
|
34
|
+
- Add `virtual_start_time` property to tasks
|
35
|
+
- Updating `task_queue_data` format from `map` to `array` in the response of bulk get endpoint of TaskQueue Real Time Statistics API **(breaking change)**
|
36
|
+
|
37
|
+
|
4
38
|
[2023-10-05] Version 6.7.1
|
5
39
|
--------------------------
|
6
40
|
**Library - Chore**
|
data/README.md
CHANGED
@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
|
|
39
39
|
To install using [Bundler][bundler] grab the latest stable version:
|
40
40
|
|
41
41
|
```ruby
|
42
|
-
gem 'twilio-ruby', '~> 6.
|
42
|
+
gem 'twilio-ruby', '~> 6.8.0'
|
43
43
|
```
|
44
44
|
|
45
45
|
To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
|
46
46
|
|
47
47
|
```bash
|
48
|
-
gem install twilio-ruby -v 6.
|
48
|
+
gem install twilio-ruby -v 6.8.0
|
49
49
|
```
|
50
50
|
|
51
51
|
To build and install the development branch yourself from the latest source:
|
@@ -95,9 +95,9 @@ module Twilio
|
|
95
95
|
end
|
96
96
|
|
97
97
|
##
|
98
|
-
# Validate the
|
98
|
+
# Validate the SSL certificates for the Twilio API
|
99
99
|
def validate_ssl_certificate
|
100
|
-
response = request('
|
100
|
+
response = request('tls-test.twilio.com', '443', 'GET', 'https://tls-test.twilio.com')
|
101
101
|
return unless response.status_code < 200 || response.status_code >= 300
|
102
102
|
|
103
103
|
raise RestError.new 'Unexpected response from certificate endpoint', response
|
@@ -4,7 +4,7 @@
|
|
4
4
|
# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
5
5
|
# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
6
6
|
#
|
7
|
-
# Twilio -
|
7
|
+
# Twilio - Accounts
|
8
8
|
# This is the public Twilio REST API.
|
9
9
|
#
|
10
10
|
# NOTE: This class is auto generated by OpenAPI Generator.
|
@@ -15,8 +15,8 @@
|
|
15
15
|
|
16
16
|
module Twilio
|
17
17
|
module REST
|
18
|
-
class
|
19
|
-
class
|
18
|
+
class Accounts < AccountsBase
|
19
|
+
class V1 < Version
|
20
20
|
class SafelistList < ListResource
|
21
21
|
##
|
22
22
|
# Initialize the SafelistList
|
@@ -26,7 +26,7 @@ module Twilio
|
|
26
26
|
super(version)
|
27
27
|
# Path Solution
|
28
28
|
@solution = { }
|
29
|
-
@uri = "/SafeList/Numbers
|
29
|
+
@uri = "/SafeList/Numbers"
|
30
30
|
|
31
31
|
end
|
32
32
|
##
|
@@ -85,7 +85,7 @@ module Twilio
|
|
85
85
|
|
86
86
|
# Provide a user friendly representation
|
87
87
|
def to_s
|
88
|
-
'#<Twilio.
|
88
|
+
'#<Twilio.Accounts.V1.SafelistList>'
|
89
89
|
end
|
90
90
|
end
|
91
91
|
|
@@ -114,7 +114,7 @@ module Twilio
|
|
114
114
|
##
|
115
115
|
# Provide a user friendly representation
|
116
116
|
def to_s
|
117
|
-
'<Twilio.
|
117
|
+
'<Twilio.Accounts.V1.SafelistPage>'
|
118
118
|
end
|
119
119
|
end
|
120
120
|
class SafelistInstance < InstanceResource
|
@@ -153,13 +153,13 @@ module Twilio
|
|
153
153
|
##
|
154
154
|
# Provide a user friendly representation
|
155
155
|
def to_s
|
156
|
-
"<Twilio.
|
156
|
+
"<Twilio.Accounts.V1.SafelistInstance>"
|
157
157
|
end
|
158
158
|
|
159
159
|
##
|
160
160
|
# Provide a detailed, user friendly representation
|
161
161
|
def inspect
|
162
|
-
"<Twilio.
|
162
|
+
"<Twilio.Accounts.V1.SafelistInstance>"
|
163
163
|
end
|
164
164
|
end
|
165
165
|
|
@@ -23,6 +23,7 @@ module Twilio
|
|
23
23
|
@version = 'v1'
|
24
24
|
@auth_token_promotion = nil
|
25
25
|
@credentials = nil
|
26
|
+
@safelist = nil
|
26
27
|
@secondary_auth_token = nil
|
27
28
|
end
|
28
29
|
|
@@ -37,6 +38,11 @@ module Twilio
|
|
37
38
|
@credentials ||= CredentialList.new self
|
38
39
|
end
|
39
40
|
##
|
41
|
+
# @return [Twilio::REST::Accounts::V1::SafelistList]
|
42
|
+
def safelist
|
43
|
+
@safelist ||= SafelistList.new self
|
44
|
+
end
|
45
|
+
##
|
40
46
|
# @return [Twilio::REST::Accounts::V1::secondaryAuthTokenContext]
|
41
47
|
def secondary_auth_token
|
42
48
|
@secondary_auth_token ||= SecondaryAuthTokenContext.new self
|
@@ -81,6 +81,7 @@ module Twilio
|
|
81
81
|
# @param [String] amd_status_callback The URL that we should call using the `amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax.
|
82
82
|
# @param [String] amd_status_callback_method The HTTP method we should use when calling the `amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.
|
83
83
|
# @param [String] trim Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.
|
84
|
+
# @param [String] call_token A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call.
|
84
85
|
# @return [ParticipantInstance] Created ParticipantInstance
|
85
86
|
def create(
|
86
87
|
from: nil,
|
@@ -129,7 +130,8 @@ module Twilio
|
|
129
130
|
machine_detection_silence_timeout: :unset,
|
130
131
|
amd_status_callback: :unset,
|
131
132
|
amd_status_callback_method: :unset,
|
132
|
-
trim: :unset
|
133
|
+
trim: :unset,
|
134
|
+
call_token: :unset
|
133
135
|
)
|
134
136
|
|
135
137
|
data = Twilio::Values.of({
|
@@ -180,6 +182,7 @@ module Twilio
|
|
180
182
|
'AmdStatusCallback' => amd_status_callback,
|
181
183
|
'AmdStatusCallbackMethod' => amd_status_callback_method,
|
182
184
|
'Trim' => trim,
|
185
|
+
'CallToken' => call_token,
|
183
186
|
})
|
184
187
|
|
185
188
|
payload = @version.create('POST', @uri, data: data)
|
@@ -22,7 +22,6 @@ module Twilio
|
|
22
22
|
super
|
23
23
|
@version = '2010-04-01'
|
24
24
|
@accounts = nil
|
25
|
-
@safelist = nil
|
26
25
|
end
|
27
26
|
|
28
27
|
##
|
@@ -123,11 +122,6 @@ module Twilio
|
|
123
122
|
end
|
124
123
|
end
|
125
124
|
##
|
126
|
-
# @return [Twilio::REST::Api::V2010::SafelistList]
|
127
|
-
def safelist
|
128
|
-
@safelist ||= SafelistList.new self
|
129
|
-
end
|
130
|
-
##
|
131
125
|
# Provide a user friendly representation
|
132
126
|
def to_s
|
133
127
|
'<Twilio::REST::Api::V2010>';
|
@@ -177,6 +177,7 @@ module Twilio
|
|
177
177
|
'flex_ui_status_report' => payload['flex_ui_status_report'],
|
178
178
|
'agent_conv_end_methods' => payload['agent_conv_end_methods'],
|
179
179
|
'citrix_voice_vdi' => payload['citrix_voice_vdi'],
|
180
|
+
'offline_config' => payload['offline_config'],
|
180
181
|
}
|
181
182
|
|
182
183
|
# Context
|
@@ -477,6 +478,12 @@ module Twilio
|
|
477
478
|
@properties['citrix_voice_vdi']
|
478
479
|
end
|
479
480
|
|
481
|
+
##
|
482
|
+
# @return [Hash] Presence and presence ttl configuration
|
483
|
+
def offline_config
|
484
|
+
@properties['offline_config']
|
485
|
+
end
|
486
|
+
|
480
487
|
##
|
481
488
|
# Fetch the ConfigurationInstance
|
482
489
|
# @param [String] ui_version The Pinned UI version of the Configuration resource to fetch.
|
@@ -60,7 +60,7 @@ module Twilio
|
|
60
60
|
end
|
61
61
|
##
|
62
62
|
# Fetch the MediaInstance
|
63
|
-
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Media.
|
63
|
+
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
|
64
64
|
# @return [MediaInstance] Fetched MediaInstance
|
65
65
|
def fetch(
|
66
66
|
redacted: :unset
|
@@ -191,7 +191,7 @@ module Twilio
|
|
191
191
|
|
192
192
|
##
|
193
193
|
# Fetch the MediaInstance
|
194
|
-
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Media.
|
194
|
+
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
|
195
195
|
# @return [MediaInstance] Fetched MediaInstance
|
196
196
|
def fetch(
|
197
197
|
redacted: :unset
|
@@ -36,7 +36,7 @@ module Twilio
|
|
36
36
|
# Lists OperatorResultInstance records from the API as a list.
|
37
37
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
38
38
|
# memory before returning.
|
39
|
-
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator.
|
39
|
+
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
40
40
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
41
41
|
# guarantees to never return more than limit. Default is no limit
|
42
42
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -56,7 +56,7 @@ module Twilio
|
|
56
56
|
# Streams Instance records from the API as an Enumerable.
|
57
57
|
# This operation lazily loads records as efficiently as possible until the limit
|
58
58
|
# is reached.
|
59
|
-
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator.
|
59
|
+
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
60
60
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
61
61
|
# guarantees to never return more than limit. Default is no limit
|
62
62
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -91,7 +91,7 @@ module Twilio
|
|
91
91
|
##
|
92
92
|
# Retrieve a single page of OperatorResultInstance records from the API.
|
93
93
|
# Request is executed immediately.
|
94
|
-
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator.
|
94
|
+
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
95
95
|
# @param [String] page_token PageToken provided by the API
|
96
96
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
97
97
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
@@ -151,7 +151,7 @@ module Twilio
|
|
151
151
|
end
|
152
152
|
##
|
153
153
|
# Fetch the OperatorResultInstance
|
154
|
-
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator.
|
154
|
+
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
155
155
|
# @return [OperatorResultInstance] Fetched OperatorResultInstance
|
156
156
|
def fetch(
|
157
157
|
redacted: :unset
|
@@ -346,7 +346,7 @@ module Twilio
|
|
346
346
|
|
347
347
|
##
|
348
348
|
# Fetch the OperatorResultInstance
|
349
|
-
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator.
|
349
|
+
# @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
350
350
|
# @return [OperatorResultInstance] Fetched OperatorResultInstance
|
351
351
|
def fetch(
|
352
352
|
redacted: :unset
|
@@ -36,7 +36,7 @@ module Twilio
|
|
36
36
|
# Lists SentenceInstance records from the API as a list.
|
37
37
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
38
38
|
# memory before returning.
|
39
|
-
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences.
|
39
|
+
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
40
40
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
41
41
|
# guarantees to never return more than limit. Default is no limit
|
42
42
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -56,7 +56,7 @@ module Twilio
|
|
56
56
|
# Streams Instance records from the API as an Enumerable.
|
57
57
|
# This operation lazily loads records as efficiently as possible until the limit
|
58
58
|
# is reached.
|
59
|
-
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences.
|
59
|
+
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
60
60
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
61
61
|
# guarantees to never return more than limit. Default is no limit
|
62
62
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -91,7 +91,7 @@ module Twilio
|
|
91
91
|
##
|
92
92
|
# Retrieve a single page of SentenceInstance records from the API.
|
93
93
|
# Request is executed immediately.
|
94
|
-
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences.
|
94
|
+
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
95
95
|
# @param [String] page_token PageToken provided by the API
|
96
96
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
97
97
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
@@ -229,16 +229,10 @@ module Twilio
|
|
229
229
|
|
230
230
|
##
|
231
231
|
# Fetch the TranscriptInstance
|
232
|
-
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Transcript. The default is `true` to access redacted Transcript.
|
233
232
|
# @return [TranscriptInstance] Fetched TranscriptInstance
|
234
|
-
def fetch
|
235
|
-
redacted: :unset
|
236
|
-
)
|
233
|
+
def fetch
|
237
234
|
|
238
|
-
|
239
|
-
'Redacted' => redacted,
|
240
|
-
})
|
241
|
-
payload = @version.fetch('GET', @uri, params: params)
|
235
|
+
payload = @version.fetch('GET', @uri)
|
242
236
|
TranscriptInstance.new(
|
243
237
|
@version,
|
244
238
|
payload,
|
@@ -478,15 +472,10 @@ module Twilio
|
|
478
472
|
|
479
473
|
##
|
480
474
|
# Fetch the TranscriptInstance
|
481
|
-
# @param [Boolean] redacted Grant access to PII Redacted/Unredacted Transcript. The default is `true` to access redacted Transcript.
|
482
475
|
# @return [TranscriptInstance] Fetched TranscriptInstance
|
483
|
-
def fetch
|
484
|
-
redacted: :unset
|
485
|
-
)
|
476
|
+
def fetch
|
486
477
|
|
487
|
-
context.fetch
|
488
|
-
redacted: redacted,
|
489
|
-
)
|
478
|
+
context.fetch
|
490
479
|
end
|
491
480
|
|
492
481
|
##
|
@@ -184,7 +184,7 @@ module Twilio
|
|
184
184
|
'identity_match' => payload['identity_match'],
|
185
185
|
'reassigned_number' => payload['reassigned_number'],
|
186
186
|
'sms_pumping_risk' => payload['sms_pumping_risk'],
|
187
|
-
'
|
187
|
+
'phone_number_quality_score' => payload['phone_number_quality_score'],
|
188
188
|
'url' => payload['url'],
|
189
189
|
}
|
190
190
|
|
@@ -289,9 +289,9 @@ module Twilio
|
|
289
289
|
end
|
290
290
|
|
291
291
|
##
|
292
|
-
# @return [Hash] An object that contains information
|
293
|
-
def
|
294
|
-
@properties['
|
292
|
+
# @return [Hash] An object that contains information of a mobile phone number quality score. Quality score will return a risk score about the phone number.
|
293
|
+
def phone_number_quality_score
|
294
|
+
@properties['phone_number_quality_score']
|
295
295
|
end
|
296
296
|
|
297
297
|
##
|
@@ -36,7 +36,7 @@ module Twilio
|
|
36
36
|
# @param [String] brand_registration_sid A2P Brand Registration SID
|
37
37
|
# @param [String] description A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
|
38
38
|
# @param [String] message_flow Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.
|
39
|
-
# @param [Array[String]] message_samples
|
39
|
+
# @param [Array[String]] message_samples An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.
|
40
40
|
# @param [String] us_app_to_person_usecase A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]
|
41
41
|
# @param [Boolean] has_embedded_links Indicates that this SMS campaign will send messages that contain links.
|
42
42
|
# @param [Boolean] has_embedded_phone Indicates that this SMS campaign will send messages that contain phone numbers.
|
@@ -354,7 +354,7 @@ module Twilio
|
|
354
354
|
end
|
355
355
|
|
356
356
|
##
|
357
|
-
# @return [Array<String>]
|
357
|
+
# @return [Array<String>] An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.
|
358
358
|
def message_samples
|
359
359
|
@properties['message_samples']
|
360
360
|
end
|
@@ -38,13 +38,15 @@ module Twilio
|
|
38
38
|
# @param [String] task_channel When MultiTasking is enabled, specify the TaskChannel by passing either its `unique_name` or `sid`. Default value is `default`.
|
39
39
|
# @param [String] workflow_sid The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.
|
40
40
|
# @param [String] attributes A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \\\"task_type\\\": \\\"call\\\", \\\"twilio_call_sid\\\": \\\"CAxxx\\\", \\\"customer_ticket_number\\\": \\\"12345\\\" }`.
|
41
|
+
# @param [Time] virtual_start_time The virtual start time to assign the new task and override the default. When supplied, the new task will have this virtual start time. When not supplied, the new task will have the virtual start time equal to `date_created`. Value can't be in the future.
|
41
42
|
# @return [TaskInstance] Created TaskInstance
|
42
43
|
def create(
|
43
44
|
timeout: :unset,
|
44
45
|
priority: :unset,
|
45
46
|
task_channel: :unset,
|
46
47
|
workflow_sid: :unset,
|
47
|
-
attributes: :unset
|
48
|
+
attributes: :unset,
|
49
|
+
virtual_start_time: :unset
|
48
50
|
)
|
49
51
|
|
50
52
|
data = Twilio::Values.of({
|
@@ -53,6 +55,7 @@ module Twilio
|
|
53
55
|
'TaskChannel' => task_channel,
|
54
56
|
'WorkflowSid' => workflow_sid,
|
55
57
|
'Attributes' => attributes,
|
58
|
+
'VirtualStartTime' => Twilio.serialize_iso8601_datetime(virtual_start_time),
|
56
59
|
})
|
57
60
|
|
58
61
|
payload = @version.create('POST', @uri, data: data)
|
@@ -75,7 +78,7 @@ module Twilio
|
|
75
78
|
# @param [String] task_queue_sid The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
|
76
79
|
# @param [String] task_queue_name The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
|
77
80
|
# @param [String] evaluate_task_attributes The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
|
78
|
-
# @param [String] ordering How to order the returned Task resources.
|
81
|
+
# @param [String] ordering How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
|
79
82
|
# @param [Boolean] has_addons Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.
|
80
83
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
81
84
|
# guarantees to never return more than limit. Default is no limit
|
@@ -111,7 +114,7 @@ module Twilio
|
|
111
114
|
# @param [String] task_queue_sid The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
|
112
115
|
# @param [String] task_queue_name The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
|
113
116
|
# @param [String] evaluate_task_attributes The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
|
114
|
-
# @param [String] ordering How to order the returned Task resources.
|
117
|
+
# @param [String] ordering How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
|
115
118
|
# @param [Boolean] has_addons Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.
|
116
119
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
117
120
|
# guarantees to never return more than limit. Default is no limit
|
@@ -162,7 +165,7 @@ module Twilio
|
|
162
165
|
# @param [String] task_queue_sid The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
|
163
166
|
# @param [String] task_queue_name The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
|
164
167
|
# @param [String] evaluate_task_attributes The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
|
165
|
-
# @param [String] ordering How to order the returned Task resources.
|
168
|
+
# @param [String] ordering How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Pairings of sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order. The only ordering pairing not allowed is DateCreated and VirtualStartTime.
|
166
169
|
# @param [Boolean] has_addons Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.
|
167
170
|
# @param [String] page_token PageToken provided by the API
|
168
171
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
@@ -262,6 +265,7 @@ module Twilio
|
|
262
265
|
# @param [String] reason The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
|
263
266
|
# @param [String] priority The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).
|
264
267
|
# @param [String] task_channel When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
|
268
|
+
# @param [Time] virtual_start_time The task's new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can't be in the future.
|
265
269
|
# @param [String] if_match If provided, applies this mutation if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
|
266
270
|
# @return [TaskInstance] Updated TaskInstance
|
267
271
|
def update(
|
@@ -270,6 +274,7 @@ module Twilio
|
|
270
274
|
reason: :unset,
|
271
275
|
priority: :unset,
|
272
276
|
task_channel: :unset,
|
277
|
+
virtual_start_time: :unset,
|
273
278
|
if_match: :unset
|
274
279
|
)
|
275
280
|
|
@@ -279,6 +284,7 @@ module Twilio
|
|
279
284
|
'Reason' => reason,
|
280
285
|
'Priority' => priority,
|
281
286
|
'TaskChannel' => task_channel,
|
287
|
+
'VirtualStartTime' => Twilio.serialize_iso8601_datetime(virtual_start_time),
|
282
288
|
})
|
283
289
|
|
284
290
|
headers = Twilio::Values.of({ 'If-Match' => if_match, })
|
@@ -390,6 +396,7 @@ module Twilio
|
|
390
396
|
'workspace_sid' => payload['workspace_sid'],
|
391
397
|
'url' => payload['url'],
|
392
398
|
'links' => payload['links'],
|
399
|
+
'virtual_start_time' => Twilio.deserialize_iso8601_datetime(payload['virtual_start_time']),
|
393
400
|
}
|
394
401
|
|
395
402
|
# Context
|
@@ -534,6 +541,12 @@ module Twilio
|
|
534
541
|
@properties['links']
|
535
542
|
end
|
536
543
|
|
544
|
+
##
|
545
|
+
# @return [Time] The date and time in GMT indicating the ordering for routing of the Task specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
546
|
+
def virtual_start_time
|
547
|
+
@properties['virtual_start_time']
|
548
|
+
end
|
549
|
+
|
537
550
|
##
|
538
551
|
# Delete the TaskInstance
|
539
552
|
# @param [String] if_match If provided, deletes this Task if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
|
@@ -562,6 +575,7 @@ module Twilio
|
|
562
575
|
# @param [String] reason The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
|
563
576
|
# @param [String] priority The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).
|
564
577
|
# @param [String] task_channel When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
|
578
|
+
# @param [Time] virtual_start_time The task's new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can't be in the future.
|
565
579
|
# @param [String] if_match If provided, applies this mutation if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
|
566
580
|
# @return [TaskInstance] Updated TaskInstance
|
567
581
|
def update(
|
@@ -570,6 +584,7 @@ module Twilio
|
|
570
584
|
reason: :unset,
|
571
585
|
priority: :unset,
|
572
586
|
task_channel: :unset,
|
587
|
+
virtual_start_time: :unset,
|
573
588
|
if_match: :unset
|
574
589
|
)
|
575
590
|
|
@@ -579,6 +594,7 @@ module Twilio
|
|
579
594
|
reason: reason,
|
580
595
|
priority: priority,
|
581
596
|
task_channel: task_channel,
|
597
|
+
virtual_start_time: virtual_start_time,
|
582
598
|
if_match: if_match,
|
583
599
|
)
|
584
600
|
end
|
data/lib/twilio-ruby/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: twilio-ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 6.
|
4
|
+
version: 6.8.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Twilio API Team
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-10-
|
11
|
+
date: 2023-10-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jwt
|
@@ -249,6 +249,7 @@ files:
|
|
249
249
|
- lib/twilio-ruby/rest/accounts/v1/credential.rb
|
250
250
|
- lib/twilio-ruby/rest/accounts/v1/credential/aws.rb
|
251
251
|
- lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb
|
252
|
+
- lib/twilio-ruby/rest/accounts/v1/safelist.rb
|
252
253
|
- lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb
|
253
254
|
- lib/twilio-ruby/rest/accounts_base.rb
|
254
255
|
- lib/twilio-ruby/rest/api.rb
|
@@ -332,7 +333,6 @@ files:
|
|
332
333
|
- lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb
|
333
334
|
- lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb
|
334
335
|
- lib/twilio-ruby/rest/api/v2010/account/validation_request.rb
|
335
|
-
- lib/twilio-ruby/rest/api/v2010/safelist.rb
|
336
336
|
- lib/twilio-ruby/rest/api_base.rb
|
337
337
|
- lib/twilio-ruby/rest/autopilot.rb
|
338
338
|
- lib/twilio-ruby/rest/autopilot/v1.rb
|