twilio-ruby 5.20.1 → 5.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +22 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/accounts/v1/credential.rb +4 -4
  5. data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +21 -20
  6. data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb +21 -19
  7. data/lib/twilio-ruby/rest/api.rb +8 -7
  8. data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +32 -28
  9. data/lib/twilio-ruby/rest/api/v2010/account/call/notification.rb +56 -37
  10. data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +27 -27
  11. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +248 -165
  12. data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +35 -35
  13. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +15 -11
  14. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +104 -114
  15. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +4 -4
  16. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +48 -46
  17. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +29 -22
  18. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +36 -28
  19. data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb +35 -21
  20. data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb +24 -20
  21. data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb +27 -27
  22. data/lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb +7 -0
  23. data/lib/twilio-ruby/rest/authy/v1/service/entity/factor/challenge.rb +7 -0
  24. data/lib/twilio-ruby/rest/client.rb +8 -7
  25. data/lib/twilio-ruby/rest/fax.rb +2 -1
  26. data/lib/twilio-ruby/rest/fax/v1.rb +2 -1
  27. data/lib/twilio-ruby/rest/fax/v1/fax.rb +85 -75
  28. data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb +16 -16
  29. data/lib/twilio-ruby/rest/verify/v1/service.rb +8 -2
  30. data/lib/twilio-ruby/rest/verify/v1/service/verification.rb +120 -3
  31. data/lib/twilio-ruby/rest/video/v1/composition.rb +1 -1
  32. data/lib/twilio-ruby/version.rb +1 -1
  33. data/spec/integration/authy/v1/service/entity/factor/challenge_spec.rb +5 -0
  34. data/spec/integration/authy/v1/service/entity/factor_spec.rb +4 -0
  35. data/spec/integration/verify/v1/service/verification_spec.rb +107 -1
  36. data/spec/integration/video/v1/composition_spec.rb +28 -3
  37. metadata +2 -2
@@ -16,8 +16,12 @@ module Twilio
16
16
  ##
17
17
  # Initialize the TranscriptionList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] account_sid The account_sid
20
- # @param [String] recording_sid The recording_sid
19
+ # @param [String] account_sid The SID of the
20
+ # [Account](https://www.twilio.com/docs/api/rest/account) that created the
21
+ # Transcription resource.
22
+ # @param [String] recording_sid The SID of the
23
+ # [Recording](https://www.twilio.com/docs/voice/api/recording) from which the
24
+ # transcription was created.
21
25
  # @return [TranscriptionList] TranscriptionList
22
26
  def initialize(version, account_sid: nil, recording_sid: nil)
23
27
  super(version)
@@ -154,9 +158,14 @@ module Twilio
154
158
  ##
155
159
  # Initialize the TranscriptionContext
156
160
  # @param [Version] version Version that contains the resource
157
- # @param [String] account_sid The account_sid
158
- # @param [String] recording_sid The recording_sid
159
- # @param [String] sid The sid
161
+ # @param [String] account_sid The SID of the
162
+ # [Account](https://www.twilio.com/docs/api/rest/account) that created the
163
+ # Transcription resource to fetch.
164
+ # @param [String] recording_sid The SID of the
165
+ # [Recording](https://www.twilio.com/docs/voice/api/recording) that created the
166
+ # transcription to fetch.
167
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
168
+ # Transcription resource to fetch.
160
169
  # @return [TranscriptionContext] TranscriptionContext
161
170
  def initialize(version, account_sid, recording_sid, sid)
162
171
  super(version)
@@ -214,9 +223,14 @@ module Twilio
214
223
  # Initialize the TranscriptionInstance
215
224
  # @param [Version] version Version that contains the resource
216
225
  # @param [Hash] payload payload that contains response from Twilio
217
- # @param [String] account_sid The account_sid
218
- # @param [String] recording_sid The recording_sid
219
- # @param [String] sid The sid
226
+ # @param [String] account_sid The SID of the
227
+ # [Account](https://www.twilio.com/docs/api/rest/account) that created the
228
+ # Transcription resource.
229
+ # @param [String] recording_sid The SID of the
230
+ # [Recording](https://www.twilio.com/docs/voice/api/recording) from which the
231
+ # transcription was created.
232
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
233
+ # Transcription resource to fetch.
220
234
  # @return [TranscriptionInstance] TranscriptionInstance
221
235
  def initialize(version, payload, account_sid: nil, recording_sid: nil, sid: nil)
222
236
  super(version)
@@ -264,79 +278,79 @@ module Twilio
264
278
  end
265
279
 
266
280
  ##
267
- # @return [String] The account_sid
281
+ # @return [String] The SID of the Account that created the resource
268
282
  def account_sid
269
283
  @properties['account_sid']
270
284
  end
271
285
 
272
286
  ##
273
- # @return [String] The api_version
287
+ # @return [String] The API version used to create the transcription
274
288
  def api_version
275
289
  @properties['api_version']
276
290
  end
277
291
 
278
292
  ##
279
- # @return [Time] The date_created
293
+ # @return [Time] The RFC 2822 date and time in GMT that the resource was created
280
294
  def date_created
281
295
  @properties['date_created']
282
296
  end
283
297
 
284
298
  ##
285
- # @return [Time] The date_updated
299
+ # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
286
300
  def date_updated
287
301
  @properties['date_updated']
288
302
  end
289
303
 
290
304
  ##
291
- # @return [String] The duration
305
+ # @return [String] The duration of the transcribed audio in seconds.
292
306
  def duration
293
307
  @properties['duration']
294
308
  end
295
309
 
296
310
  ##
297
- # @return [String] The price
311
+ # @return [String] The charge for the transcription
298
312
  def price
299
313
  @properties['price']
300
314
  end
301
315
 
302
316
  ##
303
- # @return [String] The price_unit
317
+ # @return [String] The currency in which price is measured
304
318
  def price_unit
305
319
  @properties['price_unit']
306
320
  end
307
321
 
308
322
  ##
309
- # @return [String] The recording_sid
323
+ # @return [String] The SID that identifies the transcription's recording
310
324
  def recording_sid
311
325
  @properties['recording_sid']
312
326
  end
313
327
 
314
328
  ##
315
- # @return [String] The sid
329
+ # @return [String] The unique string that identifies the resource
316
330
  def sid
317
331
  @properties['sid']
318
332
  end
319
333
 
320
334
  ##
321
- # @return [transcription.Status] The status
335
+ # @return [transcription.Status] The status of the transcription
322
336
  def status
323
337
  @properties['status']
324
338
  end
325
339
 
326
340
  ##
327
- # @return [String] The transcription_text
341
+ # @return [String] The text content of the transcription.
328
342
  def transcription_text
329
343
  @properties['transcription_text']
330
344
  end
331
345
 
332
346
  ##
333
- # @return [String] The type
347
+ # @return [String] The transcription type
334
348
  def type
335
349
  @properties['type']
336
350
  end
337
351
 
338
352
  ##
339
- # @return [String] The uri
353
+ # @return [String] The URI of the resource, relative to `https://api.twilio.com`
340
354
  def uri
341
355
  @properties['uri']
342
356
  end
@@ -15,9 +15,9 @@ module Twilio
15
15
  ##
16
16
  # Initialize the TranscriptionList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] account_sid The unique id of the
19
- # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
20
- # transcription.
18
+ # @param [String] account_sid The SID of the
19
+ # [Account](https://www.twilio.com/docs/api/rest/account) that created the
20
+ # Transcription resource.
21
21
  # @return [TranscriptionList] TranscriptionList
22
22
  def initialize(version, account_sid: nil)
23
23
  super(version)
@@ -149,8 +149,11 @@ module Twilio
149
149
  ##
150
150
  # Initialize the TranscriptionContext
151
151
  # @param [Version] version Version that contains the resource
152
- # @param [String] account_sid The account_sid
153
- # @param [String] sid The unique SID that identifies this Transcription
152
+ # @param [String] account_sid The SID of the
153
+ # [Account](https://www.twilio.com/docs/api/rest/account) that created the
154
+ # Transcription resource to fetch.
155
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
156
+ # Transcription resource to fetch.
154
157
  # @return [TranscriptionContext] TranscriptionContext
155
158
  def initialize(version, account_sid, sid)
156
159
  super(version)
@@ -207,10 +210,11 @@ module Twilio
207
210
  # Initialize the TranscriptionInstance
208
211
  # @param [Version] version Version that contains the resource
209
212
  # @param [Hash] payload payload that contains response from Twilio
210
- # @param [String] account_sid The unique id of the
211
- # [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
212
- # transcription.
213
- # @param [String] sid The unique SID that identifies this Transcription
213
+ # @param [String] account_sid The SID of the
214
+ # [Account](https://www.twilio.com/docs/api/rest/account) that created the
215
+ # Transcription resource.
216
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
217
+ # Transcription resource to fetch.
214
218
  # @return [TranscriptionInstance] TranscriptionInstance
215
219
  def initialize(version, payload, account_sid: nil, sid: nil)
216
220
  super(version)
@@ -249,55 +253,55 @@ module Twilio
249
253
  end
250
254
 
251
255
  ##
252
- # @return [String] The unique sid that identifies this account
256
+ # @return [String] The SID of the Account that created the resource
253
257
  def account_sid
254
258
  @properties['account_sid']
255
259
  end
256
260
 
257
261
  ##
258
- # @return [String] The api_version
262
+ # @return [String] The API version used to create the transcription
259
263
  def api_version
260
264
  @properties['api_version']
261
265
  end
262
266
 
263
267
  ##
264
- # @return [Time] The date this resource was created
268
+ # @return [Time] The RFC 2822 date and time in GMT that the resource was created
265
269
  def date_created
266
270
  @properties['date_created']
267
271
  end
268
272
 
269
273
  ##
270
- # @return [Time] The date this resource was last updated
274
+ # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
271
275
  def date_updated
272
276
  @properties['date_updated']
273
277
  end
274
278
 
275
279
  ##
276
- # @return [String] The duration of the transcribed audio, in seconds.
280
+ # @return [String] The duration of the transcribed audio in seconds.
277
281
  def duration
278
282
  @properties['duration']
279
283
  end
280
284
 
281
285
  ##
282
- # @return [String] The charge for this transcription
286
+ # @return [String] The charge for the transcription
283
287
  def price
284
288
  @properties['price']
285
289
  end
286
290
 
287
291
  ##
288
- # @return [String] The currency in which Price is measured
292
+ # @return [String] The currency in which price is measured
289
293
  def price_unit
290
294
  @properties['price_unit']
291
295
  end
292
296
 
293
297
  ##
294
- # @return [String] The string that uniquely identifies the recording
298
+ # @return [String] The SID that identifies the transcription's recording
295
299
  def recording_sid
296
300
  @properties['recording_sid']
297
301
  end
298
302
 
299
303
  ##
300
- # @return [String] A string that uniquely identifies this transcription
304
+ # @return [String] The unique string that identifies the resource
301
305
  def sid
302
306
  @properties['sid']
303
307
  end
@@ -315,13 +319,13 @@ module Twilio
315
319
  end
316
320
 
317
321
  ##
318
- # @return [String] The type
322
+ # @return [String] The transcription type
319
323
  def type
320
324
  @properties['type']
321
325
  end
322
326
 
323
327
  ##
324
- # @return [String] The URI for this resource
328
+ # @return [String] The URI of the resource, relative to `https://api.twilio.com`
325
329
  def uri
326
330
  @properties['uri']
327
331
  end
@@ -15,9 +15,9 @@ module Twilio
15
15
  ##
16
16
  # Initialize the ValidationRequestList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] account_sid The unique ID of the
19
- # [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
20
- # Caller Id.
18
+ # @param [String] account_sid The SID of the
19
+ # [Account](https://www.twilio.com/docs/api/rest/account) responsible for the
20
+ # Caller ID.
21
21
  # @return [ValidationRequestList] ValidationRequestList
22
22
  def initialize(version, account_sid: nil)
23
23
  super(version)
@@ -30,22 +30,22 @@ module Twilio
30
30
  ##
31
31
  # Retrieve a single page of ValidationRequestInstance records from the API.
32
32
  # Request is executed immediately.
33
- # @param [String] phone_number The phone number to verify. Should be formatted
34
- # with a '+' and country code e.g., +16175551212
35
- # ([E.164](http://en.wikipedia.org/wiki/E.164) format). Twilio will also accept
36
- # unformatted US numbers e.g., (415) 555-1212, 415-555-1212.
37
- # @param [String] friendly_name A human readable description for the new caller ID
38
- # with maximum length 64 characters. Defaults to a nicely formatted version of the
39
- # number.
40
- # @param [String] call_delay The number of seconds, between 0 and 60, to delay
41
- # before initiating the verification call. Defaults to 0.
42
- # @param [String] extension Digits to dial after connecting the verification call.
43
- # @param [String] status_callback A URL that Twilio will request when the
44
- # verification call ends to notify your app if the verification process was
45
- # successful or not. See [StatusCallback
46
- # parameter](https://www.twilio.com/docs/api/voice/outgoing-caller-ids#statuscallback-parameter) below.
47
- # @param [String] status_callback_method The HTTP method Twilio should use when
48
- # requesting the above URL. Defaults to POST.
33
+ # @param [String] phone_number The phone number to verify in
34
+ # [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
35
+ # of a + followed by the country code and subscriber number.
36
+ # @param [String] friendly_name A descriptive string that you create to describe
37
+ # the new caller ID resource. It can be up to 64 characters long. The default
38
+ # value is a formatted version of the phone number.
39
+ # @param [String] call_delay The number of seconds to delay before initiating the
40
+ # verification call. Can be an integer between `0` and `60`, inclusive. The
41
+ # default is `0`.
42
+ # @param [String] extension The digits to dial after connecting the verification
43
+ # call.
44
+ # @param [String] status_callback The URL we should call using the
45
+ # `status_callback_method` to send status information about the verification
46
+ # process to your application.
47
+ # @param [String] status_callback_method The HTTP method we should use to call
48
+ # `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.
49
49
  # @return [ValidationRequestInstance] Newly created ValidationRequestInstance
50
50
  def create(phone_number: nil, friendly_name: :unset, call_delay: :unset, extension: :unset, status_callback: :unset, status_callback_method: :unset)
51
51
  data = Twilio::Values.of({
@@ -107,9 +107,9 @@ module Twilio
107
107
  # Initialize the ValidationRequestInstance
108
108
  # @param [Version] version Version that contains the resource
109
109
  # @param [Hash] payload payload that contains response from Twilio
110
- # @param [String] account_sid The unique ID of the
111
- # [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
112
- # Caller Id.
110
+ # @param [String] account_sid The SID of the
111
+ # [Account](https://www.twilio.com/docs/api/rest/account) responsible for the
112
+ # Caller ID.
113
113
  # @return [ValidationRequestInstance] ValidationRequestInstance
114
114
  def initialize(version, payload, account_sid: nil)
115
115
  super(version)
@@ -125,31 +125,31 @@ module Twilio
125
125
  end
126
126
 
127
127
  ##
128
- # @return [String] The unique ID of the Account responsible for this Caller Id.
128
+ # @return [String] The SID of the Account that created the resource
129
129
  def account_sid
130
130
  @properties['account_sid']
131
131
  end
132
132
 
133
133
  ##
134
- # @return [String] The incoming phone number.
134
+ # @return [String] The phone number to verify in E.164 format
135
135
  def phone_number
136
136
  @properties['phone_number']
137
137
  end
138
138
 
139
139
  ##
140
- # @return [String] A human readable descriptive text for this resource, up to 64 characters long.
140
+ # @return [String] The string that you assigned to describe the resource
141
141
  def friendly_name
142
142
  @properties['friendly_name']
143
143
  end
144
144
 
145
145
  ##
146
- # @return [String] The 6 digit validation code that must be entered via the phone to validate this phone number for Caller ID.
146
+ # @return [String] The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called
147
147
  def validation_code
148
148
  @properties['validation_code']
149
149
  end
150
150
 
151
151
  ##
152
- # @return [String] The unique id of the Call created for this validation attempt.
152
+ # @return [String] The SID of the Call the resource is associated with
153
153
  def call_sid
154
154
  @properties['call_sid']
155
155
  end
@@ -330,6 +330,7 @@ module Twilio
330
330
  'friendly_name' => payload['friendly_name'],
331
331
  'status' => payload['status'],
332
332
  'factor_type' => payload['factor_type'],
333
+ 'factor_strength' => payload['factor_strength'],
333
334
  'url' => payload['url'],
334
335
  'links' => payload['links'],
335
336
  }
@@ -415,6 +416,12 @@ module Twilio
415
416
  @properties['factor_type']
416
417
  end
417
418
 
419
+ ##
420
+ # @return [factor.FactorStrengths] The Strength of this Factor
421
+ def factor_strength
422
+ @properties['factor_strength']
423
+ end
424
+
418
425
  ##
419
426
  # @return [String] The URL of this resource.
420
427
  def url
@@ -233,6 +233,7 @@ module Twilio
233
233
  'details' => payload['details'],
234
234
  'hidden_details' => payload['hidden_details'],
235
235
  'factor_type' => payload['factor_type'],
236
+ 'factor_strength' => payload['factor_strength'],
236
237
  'url' => payload['url'],
237
238
  }
238
239
 
@@ -353,6 +354,12 @@ module Twilio
353
354
  @properties['factor_type']
354
355
  end
355
356
 
357
+ ##
358
+ # @return [challenge.FactorStrengths] The Factor Strength of this Challenge
359
+ def factor_strength
360
+ @properties['factor_strength']
361
+ end
362
+
356
363
  ##
357
364
  # @return [String] The URL of this resource.
358
365
  def url
@@ -322,8 +322,8 @@ module Twilio
322
322
  end
323
323
 
324
324
  ##
325
- # @param [String] sid A 34 character string that uniquely identifies this API Key.
326
- # You will use this as the basic-auth `user` when authenticating to the API.
325
+ # @param [String] sid The unique string that that we created to identify the Key
326
+ # resource.
327
327
  # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
328
328
  # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
329
329
  def keys(sid=:unset)
@@ -331,8 +331,8 @@ module Twilio
331
331
  end
332
332
 
333
333
  ##
334
- # @param [String] sid A 34 character string that uniquely identifies this
335
- # resource.
334
+ # @param [String] sid The unique string that that we created to identify the
335
+ # Message resource.
336
336
  # @return [Twilio::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
337
337
  # @return [Twilio::REST::Api::V2010::AccountContext::MessageList]
338
338
  def messages(sid=:unset)
@@ -379,8 +379,8 @@ module Twilio
379
379
  end
380
380
 
381
381
  ##
382
- # @param [String] sid A 34 character string that uniquely identifies this
383
- # resource.
382
+ # @param [String] sid The unique string that that we created to identify the
383
+ # Recording resource.
384
384
  # @return [Twilio::REST::Api::V2010::AccountContext::RecordingInstance] if sid was passed.
385
385
  # @return [Twilio::REST::Api::V2010::AccountContext::RecordingList]
386
386
  def recordings(sid=:unset)
@@ -417,7 +417,8 @@ module Twilio
417
417
  end
418
418
 
419
419
  ##
420
- # @param [String] sid A unique 34-character string that identifies this resource.
420
+ # @param [String] sid The unique string that that we created to identify the
421
+ # Transcription resource.
421
422
  # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
422
423
  # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionList]
423
424
  def transcriptions(sid=:unset)