twilio-ruby 5.18.0 → 5.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.travis.yml +0 -4
- data/CHANGES.md +20 -0
- data/LICENSE.md +1 -1
- data/README.md +2 -2
- data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +21 -13
- data/lib/twilio-ruby/rest/accounts/v1/credential.rb +2 -1
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +4 -4
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +6 -6
- data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +80 -70
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +204 -196
- data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +59 -53
- data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +69 -61
- data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +30 -25
- data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +28 -16
- data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +31 -20
- data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +54 -50
- data/lib/twilio-ruby/rest/api.rb +7 -6
- data/lib/twilio-ruby/rest/authy/v1.rb +15 -15
- data/lib/twilio-ruby/rest/authy.rb +8 -8
- data/lib/twilio-ruby/rest/client.rb +14 -6
- data/lib/twilio-ruby/rest/insights/v1/summary.rb +286 -0
- data/lib/twilio-ruby/rest/insights/v1.rb +43 -0
- data/lib/twilio-ruby/rest/insights.rb +46 -0
- data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +22 -14
- data/lib/twilio-ruby/rest/preview/marketplace.rb +13 -13
- data/lib/twilio-ruby/rest/preview.rb +8 -8
- data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +5 -28
- data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +5 -9
- data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +5 -13
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +1 -1
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +1 -1
- data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +4 -2
- data/lib/twilio-ruby/rest/trunking/v1.rb +2 -1
- data/lib/twilio-ruby/rest/verify/v1/service/verification.rb +7 -0
- data/lib/twilio-ruby/rest/verify/v1/service/verification_check.rb +7 -4
- data/lib/twilio-ruby/rest/video/v1/composition.rb +25 -13
- data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +69 -74
- data/lib/twilio-ruby/rest/video/v1/recording.rb +13 -7
- data/lib/twilio-ruby/rest/video/v1.rb +16 -16
- data/lib/twilio-ruby/rest/video.rb +9 -9
- data/lib/twilio-ruby/rest/voice/v1/voice_permission/bulk_country_update.rb +3 -3
- data/lib/twilio-ruby/rest/voice/v1/voice_permission/country/highrisk_special_prefix.rb +2 -2
- data/lib/twilio-ruby/rest/voice/v1/voice_permission/country.rb +20 -20
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/integration/api/v2010/account/sip/domain_spec.rb +8 -4
- data/spec/integration/insights/v1/summary_spec.rb +60 -0
- data/spec/integration/proxy/v1/service/phone_number_spec.rb +2 -2
- data/spec/integration/proxy/v1/service/session/interaction_spec.rb +1 -1
- data/spec/integration/proxy/v1/service/session/participant/message_interaction_spec.rb +2 -2
- data/spec/integration/proxy/v1/service/session/participant_spec.rb +66 -4
- data/spec/integration/proxy/v1/service/session_spec.rb +8 -8
- data/spec/integration/proxy/v1/service_spec.rb +3 -3
- data/spec/integration/trunking/v1/trunk_spec.rb +80 -0
- data/spec/integration/verify/v1/service/verification_spec.rb +10 -1
- data/twilio-ruby.gemspec +1 -2
- metadata +16 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: fe045a2e772454c9b888039ad8140d8f4645ce87756e12c09024d2f7b65c3cd2
|
4
|
+
data.tar.gz: e74ff7b452249e730a32e5fcc2d419d7157b71db0519e3822d8175509cec6a19
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c9734374ce684115310150d8aa8ee367a3704628cdfeedcb421264f90df53b9330642ad0c8c612ff6eec712aedfba2bd46cc5464cba8d4e9dcde0d93cff1b7ae
|
7
|
+
data.tar.gz: 9e4cea3ca89dbc6634330b1d0797d870b53f92b3bc3c834e08436a5b3cada6e45d541041bd22f6ae70257f69edc0a5df3c2bbc24d14d1c94a8d90c764246b0a5
|
data/.travis.yml
CHANGED
@@ -17,10 +17,6 @@ services:
|
|
17
17
|
matrix:
|
18
18
|
fast_finish: true
|
19
19
|
|
20
|
-
before_install:
|
21
|
-
# Bundler on Travis may be too out of date
|
22
|
-
# Update bundler to a recent version.
|
23
|
-
- gem install bundler
|
24
20
|
deploy:
|
25
21
|
provider: script
|
26
22
|
script: make docker-build && make docker-push
|
data/CHANGES.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
twilio-ruby changelog
|
2
2
|
=====================
|
3
3
|
|
4
|
+
[2019-01-11] Version 5.19.0
|
5
|
+
----------------------------
|
6
|
+
**Library**
|
7
|
+
- PR #436: Remove jruby-openssl requirement. Thanks to @philnash!
|
8
|
+
|
9
|
+
**Chat**
|
10
|
+
- Mark Member attributes as PII
|
11
|
+
|
12
|
+
**Insights**
|
13
|
+
- Initial revision.
|
14
|
+
|
15
|
+
**Proxy**
|
16
|
+
- Remove unsupported query parameters **(breaking change)**
|
17
|
+
- Remove invalid session statuses in doc
|
18
|
+
|
19
|
+
**Verify**
|
20
|
+
- Add `lookup` information in the response when creating a new verification (depends on the LookupEnabled flag being enabled at the service level)
|
21
|
+
- Add `VerificationSid` optional parameter on Verification check.
|
22
|
+
|
23
|
+
|
4
24
|
[2018-12-17] Version 5.18.0
|
5
25
|
----------------------------
|
6
26
|
**Authy**
|
data/LICENSE.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
MIT License
|
2
2
|
|
3
|
-
Copyright (C)
|
3
|
+
Copyright (C) 2019, Twilio, Inc. <help@twilio.com>
|
4
4
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
6
6
|
this software and associated documentation files (the "Software"), to deal in
|
data/README.md
CHANGED
@@ -27,13 +27,13 @@ in-line code documentation here in the library.
|
|
27
27
|
To install using [Bundler][bundler] grab the latest stable version:
|
28
28
|
|
29
29
|
```ruby
|
30
|
-
gem 'twilio-ruby', '~> 5.
|
30
|
+
gem 'twilio-ruby', '~> 5.19.0'
|
31
31
|
```
|
32
32
|
|
33
33
|
To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
|
34
34
|
|
35
35
|
```bash
|
36
|
-
gem install twilio-ruby -v 5.
|
36
|
+
gem install twilio-ruby -v 5.19.0
|
37
37
|
```
|
38
38
|
|
39
39
|
To build and install the development branch yourself from the latest source:
|
@@ -109,9 +109,13 @@ module Twilio
|
|
109
109
|
##
|
110
110
|
# Retrieve a single page of AwsInstance records from the API.
|
111
111
|
# Request is executed immediately.
|
112
|
-
# @param [String] credentials
|
113
|
-
#
|
114
|
-
#
|
112
|
+
# @param [String] credentials String containing AWS access credentials with format
|
113
|
+
# <AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>, e.g.
|
114
|
+
# AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
115
|
+
# @param [String] friendly_name A human readable description of this resource, up
|
116
|
+
# to 64 characters.
|
117
|
+
# @param [String] account_sid The Subaccount this Credential should be associated
|
118
|
+
# with. Needs to be a valid Subaccount of the account issuing the request
|
115
119
|
# @return [AwsInstance] Newly created AwsInstance
|
116
120
|
def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
|
117
121
|
data = Twilio::Values.of({
|
@@ -169,7 +173,8 @@ module Twilio
|
|
169
173
|
##
|
170
174
|
# Initialize the AwsContext
|
171
175
|
# @param [Version] version Version that contains the resource
|
172
|
-
# @param [String] sid The
|
176
|
+
# @param [String] sid The Credential Sid that uniquely identifies the Credential
|
177
|
+
# to fetch
|
173
178
|
# @return [AwsContext] AwsContext
|
174
179
|
def initialize(version, sid)
|
175
180
|
super(version)
|
@@ -196,7 +201,8 @@ module Twilio
|
|
196
201
|
|
197
202
|
##
|
198
203
|
# Update the AwsInstance
|
199
|
-
# @param [String] friendly_name
|
204
|
+
# @param [String] friendly_name A human readable description of this resource, up
|
205
|
+
# to 64 characters.
|
200
206
|
# @return [AwsInstance] Updated AwsInstance
|
201
207
|
def update(friendly_name: :unset)
|
202
208
|
data = Twilio::Values.of({'FriendlyName' => friendly_name, })
|
@@ -230,7 +236,8 @@ module Twilio
|
|
230
236
|
# Initialize the AwsInstance
|
231
237
|
# @param [Version] version Version that contains the resource
|
232
238
|
# @param [Hash] payload payload that contains response from Twilio
|
233
|
-
# @param [String] sid The
|
239
|
+
# @param [String] sid The Credential Sid that uniquely identifies the Credential
|
240
|
+
# to fetch
|
234
241
|
# @return [AwsInstance] AwsInstance
|
235
242
|
def initialize(version, payload, sid: nil)
|
236
243
|
super(version)
|
@@ -262,37 +269,37 @@ module Twilio
|
|
262
269
|
end
|
263
270
|
|
264
271
|
##
|
265
|
-
# @return [String]
|
272
|
+
# @return [String] A 34 character string that uniquely identifies this resource.
|
266
273
|
def sid
|
267
274
|
@properties['sid']
|
268
275
|
end
|
269
276
|
|
270
277
|
##
|
271
|
-
# @return [String]
|
278
|
+
# @return [String] AccountSid the Credential resource belongs to
|
272
279
|
def account_sid
|
273
280
|
@properties['account_sid']
|
274
281
|
end
|
275
282
|
|
276
283
|
##
|
277
|
-
# @return [String]
|
284
|
+
# @return [String] A human readable description of this resource
|
278
285
|
def friendly_name
|
279
286
|
@properties['friendly_name']
|
280
287
|
end
|
281
288
|
|
282
289
|
##
|
283
|
-
# @return [Time] The
|
290
|
+
# @return [Time] The date this resource was created
|
284
291
|
def date_created
|
285
292
|
@properties['date_created']
|
286
293
|
end
|
287
294
|
|
288
295
|
##
|
289
|
-
# @return [Time] The
|
296
|
+
# @return [Time] The date this resource was last updated
|
290
297
|
def date_updated
|
291
298
|
@properties['date_updated']
|
292
299
|
end
|
293
300
|
|
294
301
|
##
|
295
|
-
# @return [String] The
|
302
|
+
# @return [String] The URI for this resource, relative to `https://accounts.twilio.com`
|
296
303
|
def url
|
297
304
|
@properties['url']
|
298
305
|
end
|
@@ -306,7 +313,8 @@ module Twilio
|
|
306
313
|
|
307
314
|
##
|
308
315
|
# Update the AwsInstance
|
309
|
-
# @param [String] friendly_name
|
316
|
+
# @param [String] friendly_name A human readable description of this resource, up
|
317
|
+
# to 64 characters.
|
310
318
|
# @return [AwsInstance] Updated AwsInstance
|
311
319
|
def update(friendly_name: :unset)
|
312
320
|
context.update(friendly_name: friendly_name, )
|
@@ -44,7 +44,8 @@ module Twilio
|
|
44
44
|
|
45
45
|
##
|
46
46
|
# Access the aws
|
47
|
-
# @param [String] sid The
|
47
|
+
# @param [String] sid The Credential Sid that uniquely identifies the Credential
|
48
|
+
# to fetch
|
48
49
|
# @return [AwsList]
|
49
50
|
# @return [AwsContext] if sid was passed.
|
50
51
|
def aws(sid=:unset)
|
@@ -19,8 +19,8 @@ module Twilio
|
|
19
19
|
# @param [String] account_sid The unique id of the
|
20
20
|
# [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
|
21
21
|
# resource.
|
22
|
-
# @param [String] call_sid
|
23
|
-
# resource.
|
22
|
+
# @param [String] call_sid The unique string that that we created to identify this
|
23
|
+
# Call resource.
|
24
24
|
# @return [FeedbackList] FeedbackList
|
25
25
|
def initialize(version, account_sid: nil, call_sid: nil)
|
26
26
|
super(version)
|
@@ -183,8 +183,8 @@ module Twilio
|
|
183
183
|
# @param [String] account_sid The unique id of the
|
184
184
|
# [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
|
185
185
|
# resource.
|
186
|
-
# @param [String] call_sid
|
187
|
-
# resource.
|
186
|
+
# @param [String] call_sid The unique string that that we created to identify this
|
187
|
+
# Call resource.
|
188
188
|
# @return [FeedbackInstance] FeedbackInstance
|
189
189
|
def initialize(version, payload, account_sid: nil, call_sid: nil)
|
190
190
|
super(version)
|
@@ -16,9 +16,9 @@ module Twilio
|
|
16
16
|
##
|
17
17
|
# Initialize the FeedbackSummaryList
|
18
18
|
# @param [Version] version Version that contains the resource
|
19
|
-
# @param [String] account_sid The
|
20
|
-
# [Account](https://www.twilio.com/docs/api/rest/account)
|
21
|
-
#
|
19
|
+
# @param [String] account_sid The SID of the
|
20
|
+
# [Account](https://www.twilio.com/docs/api/rest/account) that created this Call
|
21
|
+
# resource.
|
22
22
|
# @return [FeedbackSummaryList] FeedbackSummaryList
|
23
23
|
def initialize(version, account_sid: nil)
|
24
24
|
super(version)
|
@@ -155,9 +155,9 @@ module Twilio
|
|
155
155
|
# Initialize the FeedbackSummaryInstance
|
156
156
|
# @param [Version] version Version that contains the resource
|
157
157
|
# @param [Hash] payload payload that contains response from Twilio
|
158
|
-
# @param [String] account_sid The
|
159
|
-
# [Account](https://www.twilio.com/docs/api/rest/account)
|
160
|
-
#
|
158
|
+
# @param [String] account_sid The SID of the
|
159
|
+
# [Account](https://www.twilio.com/docs/api/rest/account) that created this Call
|
160
|
+
# resource.
|
161
161
|
# @param [String] sid A 34 character string that uniquely identifies this
|
162
162
|
# resource.
|
163
163
|
# @return [FeedbackSummaryInstance] FeedbackSummaryInstance
|
@@ -16,11 +16,12 @@ module Twilio
|
|
16
16
|
##
|
17
17
|
# Initialize the RecordingList
|
18
18
|
# @param [Version] version Version that contains the resource
|
19
|
-
# @param [String] account_sid The
|
20
|
-
# [Account](https://www.twilio.com/docs/api/rest/account)
|
21
|
-
#
|
22
|
-
# @param [String] call_sid
|
23
|
-
#
|
19
|
+
# @param [String] account_sid The SID of the
|
20
|
+
# [Account](https://www.twilio.com/docs/api/rest/account) that created this
|
21
|
+
# Recording resource.
|
22
|
+
# @param [String] call_sid The SID of the
|
23
|
+
# [Call](https://www.twilio.com/docs/api/voice/call) this Recording resource is
|
24
|
+
# associated with.
|
24
25
|
# @return [RecordingList] RecordingList
|
25
26
|
def initialize(version, account_sid: nil, call_sid: nil)
|
26
27
|
super(version)
|
@@ -33,23 +34,26 @@ module Twilio
|
|
33
34
|
##
|
34
35
|
# Retrieve a single page of RecordingInstance records from the API.
|
35
36
|
# Request is executed immediately.
|
36
|
-
# @param [String] recording_status_callback_event The recording status
|
37
|
-
#
|
38
|
-
#
|
39
|
-
# values
|
40
|
-
# @param [String] recording_status_callback The URL
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
46
|
-
# `GET`, `POST
|
47
|
-
#
|
48
|
-
#
|
49
|
-
# recording.
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
37
|
+
# @param [String] recording_status_callback_event The recording status events on
|
38
|
+
# which we should call the `recording_status_callback` URL. Can be: `in-progress`,
|
39
|
+
# `completed` and `absent` and the default is `completed`. Separate multiple event
|
40
|
+
# values with a space.
|
41
|
+
# @param [String] recording_status_callback The URL we call using the
|
42
|
+
# `recording_status_callback_method` on each recording event specified in
|
43
|
+
# `recording_status_callback_event`. For more information, see
|
44
|
+
# [RecordingStatusCallback
|
45
|
+
# parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback).
|
46
|
+
# @param [String] recording_status_callback_method The HTTP method we should use
|
47
|
+
# when calling the `recording_status_callback` URL. Can be: `GET`, `POST` and the
|
48
|
+
# default is `POST`.
|
49
|
+
# @param [String] trim Whether to trim any leading and trailing silence in the
|
50
|
+
# recording. Can be: `trim-silence` or `do-not-trim` and the default is
|
51
|
+
# `do-not-trim`. `trim-silence` trims the silence from the beginning and end of
|
52
|
+
# the recording and `do-not-trim` does not.
|
53
|
+
# @param [String] recording_channels The number of channels used in the recording.
|
54
|
+
# Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties
|
55
|
+
# of the call into one channel. `dual` records each party of a 2-party call into
|
56
|
+
# separate channels.
|
53
57
|
# @return [RecordingInstance] Newly created RecordingInstance
|
54
58
|
def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset)
|
55
59
|
data = Twilio::Values.of({
|
@@ -78,9 +82,9 @@ module Twilio
|
|
78
82
|
# Lists RecordingInstance records from the API as a list.
|
79
83
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
80
84
|
# memory before returning.
|
81
|
-
# @param [Time] date_created_before
|
82
|
-
# @param [Time] date_created
|
83
|
-
# @param [Time] date_created_after
|
85
|
+
# @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
|
86
|
+
# @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
|
87
|
+
# @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
|
84
88
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
85
89
|
# guarantees to never return more than limit. Default is no limit
|
86
90
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -102,9 +106,9 @@ module Twilio
|
|
102
106
|
# Streams RecordingInstance records from the API as an Enumerable.
|
103
107
|
# This operation lazily loads records as efficiently as possible until the limit
|
104
108
|
# is reached.
|
105
|
-
# @param [Time] date_created_before
|
106
|
-
# @param [Time] date_created
|
107
|
-
# @param [Time] date_created_after
|
109
|
+
# @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
|
110
|
+
# @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
|
111
|
+
# @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
|
108
112
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
109
113
|
# guarantees to never return more than limit. Default is no limit.
|
110
114
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -142,9 +146,9 @@ module Twilio
|
|
142
146
|
##
|
143
147
|
# Retrieve a single page of RecordingInstance records from the API.
|
144
148
|
# Request is executed immediately.
|
145
|
-
# @param [Time] date_created_before
|
146
|
-
# @param [Time] date_created
|
147
|
-
# @param [Time] date_created_after
|
149
|
+
# @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
|
150
|
+
# @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
|
151
|
+
# @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
|
148
152
|
# @param [String] page_token PageToken provided by the API
|
149
153
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
150
154
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
@@ -224,11 +228,13 @@ module Twilio
|
|
224
228
|
##
|
225
229
|
# Initialize the RecordingContext
|
226
230
|
# @param [Version] version Version that contains the resource
|
227
|
-
# @param [String] account_sid The
|
228
|
-
# [Account](https://www.twilio.com/docs/api/rest/account)
|
229
|
-
#
|
230
|
-
# @param [String] call_sid The call
|
231
|
-
#
|
231
|
+
# @param [String] account_sid The SID of the
|
232
|
+
# [Account](https://www.twilio.com/docs/api/rest/account) that created the
|
233
|
+
# Recording resource(s) to fetch.
|
234
|
+
# @param [String] call_sid The [Call](https://www.twilio.com/docs/api/voice/call)
|
235
|
+
# SID of the resource(s) to fetch.
|
236
|
+
# @param [String] sid The Twilio-provided string that uniquely identifies the
|
237
|
+
# Recording resource to fetch
|
232
238
|
# @return [RecordingContext] RecordingContext
|
233
239
|
def initialize(version, account_sid, call_sid, sid)
|
234
240
|
super(version)
|
@@ -240,12 +246,13 @@ module Twilio
|
|
240
246
|
|
241
247
|
##
|
242
248
|
# Update the RecordingInstance
|
243
|
-
# @param [recording.Status] status The status
|
244
|
-
#
|
245
|
-
# @param [String] pause_behavior
|
246
|
-
# `
|
247
|
-
#
|
248
|
-
#
|
249
|
+
# @param [recording.Status] status The new status of the recording. Can be:
|
250
|
+
# `stopped`, `paused`, `in-progress`
|
251
|
+
# @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
|
252
|
+
# or `silence` and the default is `silence`. `skip` does not record during the
|
253
|
+
# pause period, while `silence` will replace the actual audio of the call with
|
254
|
+
# silence during the pause period. This parameter only applies when setting
|
255
|
+
# `status` is set to `paused`.
|
249
256
|
# @return [RecordingInstance] Updated RecordingInstance
|
250
257
|
def update(status: nil, pause_behavior: :unset)
|
251
258
|
data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
|
@@ -306,12 +313,14 @@ module Twilio
|
|
306
313
|
# Initialize the RecordingInstance
|
307
314
|
# @param [Version] version Version that contains the resource
|
308
315
|
# @param [Hash] payload payload that contains response from Twilio
|
309
|
-
# @param [String] account_sid The
|
310
|
-
# [Account](https://www.twilio.com/docs/api/rest/account)
|
311
|
-
#
|
312
|
-
# @param [String] call_sid
|
313
|
-
#
|
314
|
-
#
|
316
|
+
# @param [String] account_sid The SID of the
|
317
|
+
# [Account](https://www.twilio.com/docs/api/rest/account) that created this
|
318
|
+
# Recording resource.
|
319
|
+
# @param [String] call_sid The SID of the
|
320
|
+
# [Call](https://www.twilio.com/docs/api/voice/call) this Recording resource is
|
321
|
+
# associated with.
|
322
|
+
# @param [String] sid The Twilio-provided string that uniquely identifies the
|
323
|
+
# Recording resource to fetch
|
315
324
|
# @return [RecordingInstance] RecordingInstance
|
316
325
|
def initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil)
|
317
326
|
super(version)
|
@@ -359,55 +368,55 @@ module Twilio
|
|
359
368
|
end
|
360
369
|
|
361
370
|
##
|
362
|
-
# @return [String] The
|
371
|
+
# @return [String] The SID of the Account that created this resource
|
363
372
|
def account_sid
|
364
373
|
@properties['account_sid']
|
365
374
|
end
|
366
375
|
|
367
376
|
##
|
368
|
-
# @return [String] The version
|
377
|
+
# @return [String] The API version used to make the recording
|
369
378
|
def api_version
|
370
379
|
@properties['api_version']
|
371
380
|
end
|
372
381
|
|
373
382
|
##
|
374
|
-
# @return [String] The
|
383
|
+
# @return [String] The SID of the Call this resource is associated with
|
375
384
|
def call_sid
|
376
385
|
@properties['call_sid']
|
377
386
|
end
|
378
387
|
|
379
388
|
##
|
380
|
-
# @return [String] The
|
389
|
+
# @return [String] The Conference SID that identifies the conference associated with the recording
|
381
390
|
def conference_sid
|
382
391
|
@properties['conference_sid']
|
383
392
|
end
|
384
393
|
|
385
394
|
##
|
386
|
-
# @return [Time] The date this resource was created
|
395
|
+
# @return [Time] The RFC 2822 date and time in GMT that this resource was created
|
387
396
|
def date_created
|
388
397
|
@properties['date_created']
|
389
398
|
end
|
390
399
|
|
391
400
|
##
|
392
|
-
# @return [Time] The date this resource was last updated
|
401
|
+
# @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
|
393
402
|
def date_updated
|
394
403
|
@properties['date_updated']
|
395
404
|
end
|
396
405
|
|
397
406
|
##
|
398
|
-
# @return [Time] The start time of the recording, given in RFC 2822 format
|
407
|
+
# @return [Time] The start time of the recording, given in RFC 2822 format
|
399
408
|
def start_time
|
400
409
|
@properties['start_time']
|
401
410
|
end
|
402
411
|
|
403
412
|
##
|
404
|
-
# @return [String] The length of the recording
|
413
|
+
# @return [String] The length of the recording in seconds
|
405
414
|
def duration
|
406
415
|
@properties['duration']
|
407
416
|
end
|
408
417
|
|
409
418
|
##
|
410
|
-
# @return [String]
|
419
|
+
# @return [String] The unique string that identifies this resource
|
411
420
|
def sid
|
412
421
|
@properties['sid']
|
413
422
|
end
|
@@ -419,55 +428,56 @@ module Twilio
|
|
419
428
|
end
|
420
429
|
|
421
430
|
##
|
422
|
-
# @return [String] The URI
|
431
|
+
# @return [String] The URI of this resource, relative to `https://api.twilio.com`
|
423
432
|
def uri
|
424
433
|
@properties['uri']
|
425
434
|
end
|
426
435
|
|
427
436
|
##
|
428
|
-
# @return [Hash] Details
|
437
|
+
# @return [Hash] Details about how to decrypt the recording
|
429
438
|
def encryption_details
|
430
439
|
@properties['encryption_details']
|
431
440
|
end
|
432
441
|
|
433
442
|
##
|
434
|
-
# @return [String] The currency used in the Price property
|
443
|
+
# @return [String] The currency used in the Price property
|
435
444
|
def price_unit
|
436
445
|
@properties['price_unit']
|
437
446
|
end
|
438
447
|
|
439
448
|
##
|
440
|
-
# @return [recording.Status] The status of
|
449
|
+
# @return [recording.Status] The status of this recording
|
441
450
|
def status
|
442
451
|
@properties['status']
|
443
452
|
end
|
444
453
|
|
445
454
|
##
|
446
|
-
# @return [String] The number of channels in the final recording file as an integer
|
455
|
+
# @return [String] The number of channels in the final recording file as an integer
|
447
456
|
def channels
|
448
457
|
@properties['channels']
|
449
458
|
end
|
450
459
|
|
451
460
|
##
|
452
|
-
# @return [recording.Source]
|
461
|
+
# @return [recording.Source] How this recording was created
|
453
462
|
def source
|
454
463
|
@properties['source']
|
455
464
|
end
|
456
465
|
|
457
466
|
##
|
458
|
-
# @return [String] More information about why the recording is missing, if
|
467
|
+
# @return [String] More information about why the recording is missing, if status is `absent`
|
459
468
|
def error_code
|
460
469
|
@properties['error_code']
|
461
470
|
end
|
462
471
|
|
463
472
|
##
|
464
473
|
# Update the RecordingInstance
|
465
|
-
# @param [recording.Status] status The status
|
466
|
-
#
|
467
|
-
# @param [String] pause_behavior
|
468
|
-
# `
|
469
|
-
#
|
470
|
-
#
|
474
|
+
# @param [recording.Status] status The new status of the recording. Can be:
|
475
|
+
# `stopped`, `paused`, `in-progress`
|
476
|
+
# @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
|
477
|
+
# or `silence` and the default is `silence`. `skip` does not record during the
|
478
|
+
# pause period, while `silence` will replace the actual audio of the call with
|
479
|
+
# silence during the pause period. This parameter only applies when setting
|
480
|
+
# `status` is set to `paused`.
|
471
481
|
# @return [RecordingInstance] Updated RecordingInstance
|
472
482
|
def update(status: nil, pause_behavior: :unset)
|
473
483
|
context.update(status: status, pause_behavior: pause_behavior, )
|