twilio-ruby 5.10.0 → 5.10.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.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +11 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +4 -2
  5. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +9 -3
  6. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +9 -3
  7. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +9 -3
  8. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +9 -3
  9. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +9 -3
  10. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +9 -3
  11. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +9 -3
  12. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +9 -3
  13. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +69 -29
  14. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +21 -17
  15. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +13 -9
  16. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +69 -29
  17. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +21 -17
  18. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +13 -9
  19. data/lib/twilio-ruby/rest/notify/v1/service/user.rb +21 -9
  20. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +4 -1
  21. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +13 -9
  22. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +28 -12
  23. data/lib/twilio-ruby/rest/video/v1/composition.rb +36 -28
  24. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb +22 -17
  25. data/lib/twilio-ruby/rest/video/v1.rb +2 -1
  26. data/lib/twilio-ruby/rest/video.rb +2 -1
  27. data/lib/twilio-ruby/version.rb +1 -1
  28. data/spec/integration/trunking/v1/trunk/credential_list_spec.rb +9 -9
  29. data/spec/integration/trunking/v1/trunk/ip_access_control_list_spec.rb +15 -15
  30. data/spec/integration/trunking/v1/trunk/origination_url_spec.rb +15 -15
  31. data/spec/integration/trunking/v1/trunk_spec.rb +32 -28
  32. metadata +2 -2
@@ -17,8 +17,8 @@ module Twilio
17
17
  # Initialize the MessageList
18
18
  # @param [Version] version Version that contains the resource
19
19
  # @param [String] service_sid The unique id of the
20
- # [Service](https://www.twilio.com/docs/api/chat/rest/services) this message
21
- # belongs to.
20
+ # [Service](https://www.twilio.com/docs/chat/api/services) this message belongs
21
+ # to.
22
22
  # @param [String] channel_sid The channel_sid
23
23
  # @return [MessageList] MessageList
24
24
  def initialize(version, service_sid: nil, channel_sid: nil)
@@ -34,9 +34,11 @@ module Twilio
34
34
  # Request is executed immediately.
35
35
  # @param [String] from The
36
36
  # [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
37
- # message's author. Defaults to `system` if not specified.
38
- # @param [String] attributes A metadata field you can use to store any data you
39
- # wish. The string value must contain structurally valid JSON if specified.
37
+ # message's author. Defaults to `system`.
38
+ # @param [String] attributes An string metadata field you can use to store any
39
+ # data you wish. The string value must contain structurally valid JSON if
40
+ # specified. **Note** that this will always be null for resources returned via
41
+ # LIST GET operations, but will be present for single GET operations.
40
42
  # @param [Time] date_created The ISO8601 time specifying the datetime the Message
41
43
  # should be set as being created. Will be set to the current time by the Chat
42
44
  # service if not specified. Note that this should only be used in cases where a
@@ -262,9 +264,10 @@ module Twilio
262
264
  # @param [String] body The message body string. You can also send structured data
263
265
  # by serializing it into a string. May be updated to empty string or `null`, will
264
266
  # be set as empty string as a result in this cases.
265
- # @param [String] attributes The attributes metadata field you can use to store
266
- # any data you wish. The string value must contain structurally valid JSON if
267
- # specified.
267
+ # @param [String] attributes A string metadata field you can use to store any data
268
+ # you wish. The string value must contain structurally valid JSON if specified.
269
+ # **Note** that this will always be null for resources returned via LIST GET
270
+ # operations, but will be present for single GET operations.
268
271
  # @param [Time] date_created The ISO8601 time specifying the datetime the Message
269
272
  # should be set as being created.
270
273
  # @param [Time] date_updated The ISO8601 time specifying the datetime the Message
@@ -310,8 +313,8 @@ module Twilio
310
313
  # @param [Version] version Version that contains the resource
311
314
  # @param [Hash] payload payload that contains response from Twilio
312
315
  # @param [String] service_sid The unique id of the
313
- # [Service](https://www.twilio.com/docs/api/chat/rest/services) this message
314
- # belongs to.
316
+ # [Service](https://www.twilio.com/docs/chat/api/services) this message belongs
317
+ # to.
315
318
  # @param [String] channel_sid The channel_sid
316
319
  # @param [String] sid The sid
317
320
  # @return [MessageInstance] MessageInstance
@@ -376,7 +379,7 @@ module Twilio
376
379
  end
377
380
 
378
381
  ##
379
- # @return [String] An optional string metadata field you can use to store any data you wish.
382
+ # @return [String] A string metadata field you can use to store any data you wish.
380
383
  def attributes
381
384
  @properties['attributes']
382
385
  end
@@ -412,7 +415,7 @@ module Twilio
412
415
  end
413
416
 
414
417
  ##
415
- # @return [String] Optional field to specify the Identity of the User that last updated the Message
418
+ # @return [String] Field to specify the Identity of the User that last updated the Message
416
419
  def last_updated_by
417
420
  @properties['last_updated_by']
418
421
  end
@@ -430,7 +433,7 @@ module Twilio
430
433
  end
431
434
 
432
435
  ##
433
- # @return [String] Optional — the contents of the message.
436
+ # @return [String] The contents of the message.
434
437
  def body
435
438
  @properties['body']
436
439
  end
@@ -448,7 +451,7 @@ module Twilio
448
451
  end
449
452
 
450
453
  ##
451
- # @return [Hash] Optional — if a Media resource instance is attached to the Message, this will contain the Media object for the attached Media.
454
+ # @return [Hash] If a Media resource instance is attached to the Message, this will contain the Media object for the attached Media.
452
455
  def media
453
456
  @properties['media']
454
457
  end
@@ -478,9 +481,10 @@ module Twilio
478
481
  # @param [String] body The message body string. You can also send structured data
479
482
  # by serializing it into a string. May be updated to empty string or `null`, will
480
483
  # be set as empty string as a result in this cases.
481
- # @param [String] attributes The attributes metadata field you can use to store
482
- # any data you wish. The string value must contain structurally valid JSON if
483
- # specified.
484
+ # @param [String] attributes A string metadata field you can use to store any data
485
+ # you wish. The string value must contain structurally valid JSON if specified.
486
+ # **Note** that this will always be null for resources returned via LIST GET
487
+ # operations, but will be present for single GET operations.
484
488
  # @param [Time] date_created The ISO8601 time specifying the datetime the Message
485
489
  # should be set as being created.
486
490
  # @param [Time] date_updated The ISO8601 time specifying the datetime the Message
@@ -16,7 +16,9 @@ module Twilio
16
16
  ##
17
17
  # Initialize the UserChannelList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] service_sid The service_sid
19
+ # @param [String] service_sid The unique id of the
20
+ # [Service](https://www.twilio.com/docs/api/chat/rest/services) this channel
21
+ # belongs to.
20
22
  # @param [String] user_sid A 34 character string that uniquely identifies this
21
23
  # resource.
22
24
  # @return [UserChannelList] UserChannelList
@@ -156,7 +158,9 @@ module Twilio
156
158
  # Initialize the UserChannelInstance
157
159
  # @param [Version] version Version that contains the resource
158
160
  # @param [Hash] payload payload that contains response from Twilio
159
- # @param [String] service_sid The service_sid
161
+ # @param [String] service_sid The unique id of the
162
+ # [Service](https://www.twilio.com/docs/api/chat/rest/services) this channel
163
+ # belongs to.
160
164
  # @param [String] user_sid A 34 character string that uniquely identifies this
161
165
  # resource.
162
166
  # @return [UserChannelInstance] UserChannelInstance
@@ -177,43 +181,43 @@ module Twilio
177
181
  end
178
182
 
179
183
  ##
180
- # @return [String] The account_sid
184
+ # @return [String] The unique id of the Account responsible for this channel.
181
185
  def account_sid
182
186
  @properties['account_sid']
183
187
  end
184
188
 
185
189
  ##
186
- # @return [String] The service_sid
190
+ # @return [String] The unique id of the Service this channel belongs to.
187
191
  def service_sid
188
192
  @properties['service_sid']
189
193
  end
190
194
 
191
195
  ##
192
- # @return [String] The channel_sid
196
+ # @return [String] The unique id of a Channel.
193
197
  def channel_sid
194
198
  @properties['channel_sid']
195
199
  end
196
200
 
197
201
  ##
198
- # @return [String] The member_sid
202
+ # @return [String] The unique id of this User as a Member in this Channel.
199
203
  def member_sid
200
204
  @properties['member_sid']
201
205
  end
202
206
 
203
207
  ##
204
- # @return [user_channel.ChannelStatus] The status
208
+ # @return [user_channel.ChannelStatus] The status of the User on this Channel.
205
209
  def status
206
210
  @properties['status']
207
211
  end
208
212
 
209
213
  ##
210
- # @return [String] The last_consumed_message_index
214
+ # @return [String] The index of the last read Message in this Channel for this User.
211
215
  def last_consumed_message_index
212
216
  @properties['last_consumed_message_index']
213
217
  end
214
218
 
215
219
  ##
216
- # @return [String] The unread_messages_count
220
+ # @return [String] The count of unread Messages in this Channel for this User.
217
221
  def unread_messages_count
218
222
  @properties['unread_messages_count']
219
223
  end
@@ -30,8 +30,11 @@ module Twilio
30
30
  ##
31
31
  # Retrieve a single page of UserInstance records from the API.
32
32
  # Request is executed immediately.
33
- # @param [String] identity The identity
34
- # @param [String] segment The segment
33
+ # @param [String] identity The identifier of the User, defined by your
34
+ # application.
35
+ # @param [String] segment The list of segments this User belongs to. Segments can
36
+ # be used to select recipients of a notification. Maximum 20 Segments per User
37
+ # allowed.
35
38
  # @return [UserInstance] Newly created UserInstance
36
39
  def create(identity: nil, segment: :unset)
37
40
  data = Twilio::Values.of({
@@ -52,8 +55,11 @@ module Twilio
52
55
  # Lists UserInstance records from the API as a list.
53
56
  # Unlike stream(), this operation is eager and will load `limit` records into
54
57
  # memory before returning.
55
- # @param [String] identity The identity
56
- # @param [String] segment The segment
58
+ # @param [String] identity The identifier of the User, defined by your
59
+ # application.
60
+ # @param [String] segment The list of segments this User belongs to. Segments can
61
+ # be used to select recipients of a notification. Maximum 20 Segments per User
62
+ # allowed.
57
63
  # @param [Integer] limit Upper limit for the number of records to return. stream()
58
64
  # guarantees to never return more than limit. Default is no limit
59
65
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -69,8 +75,11 @@ module Twilio
69
75
  # Streams UserInstance records from the API as an Enumerable.
70
76
  # This operation lazily loads records as efficiently as possible until the limit
71
77
  # is reached.
72
- # @param [String] identity The identity
73
- # @param [String] segment The segment
78
+ # @param [String] identity The identifier of the User, defined by your
79
+ # application.
80
+ # @param [String] segment The list of segments this User belongs to. Segments can
81
+ # be used to select recipients of a notification. Maximum 20 Segments per User
82
+ # allowed.
74
83
  # @param [Integer] limit Upper limit for the number of records to return. stream()
75
84
  # guarantees to never return more than limit. Default is no limit.
76
85
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -103,8 +112,11 @@ module Twilio
103
112
  ##
104
113
  # Retrieve a single page of UserInstance records from the API.
105
114
  # Request is executed immediately.
106
- # @param [String] identity The identity
107
- # @param [String] segment The segment
115
+ # @param [String] identity The identifier of the User, defined by your
116
+ # application.
117
+ # @param [String] segment The list of segments this User belongs to. Segments can
118
+ # be used to select recipients of a notification. Maximum 20 Segments per User
119
+ # allowed.
108
120
  # @param [String] page_token PageToken provided by the API
109
121
  # @param [Integer] page_number Page Number, this value is simply for client state
110
122
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -342,7 +354,7 @@ module Twilio
342
354
  end
343
355
 
344
356
  ##
345
- # @return [String] The identity
357
+ # @return [String] The identifier of the User, defined by your application.
346
358
  def identity
347
359
  @properties['identity']
348
360
  end
@@ -28,7 +28,10 @@ module Twilio
28
28
  ##
29
29
  # Retrieve a single page of CredentialListInstance records from the API.
30
30
  # Request is executed immediately.
31
- # @param [String] credential_list_sid The credential_list_sid
31
+ # @param [String] credential_list_sid The SID of the [Credential
32
+ # List](https://www.twilio.com/docs/api/rest/credential-list) that you want to
33
+ # associate with this trunk. Once associated, Twilio will start authenticating
34
+ # access to the trunk against this list.
32
35
  # @return [CredentialListInstance] Newly created CredentialListInstance
33
36
  def create(credential_list_sid: nil)
34
37
  data = Twilio::Values.of({'CredentialListSid' => credential_list_sid, })
@@ -15,7 +15,8 @@ module Twilio
15
15
  ##
16
16
  # Initialize the IpAccessControlListList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] trunk_sid The trunk_sid
18
+ # @param [String] trunk_sid A 34 character string that identifies the Trunk this
19
+ # resrouce is associated with.
19
20
  # @return [IpAccessControlListList] IpAccessControlListList
20
21
  def initialize(version, trunk_sid: nil)
21
22
  super(version)
@@ -28,7 +29,9 @@ module Twilio
28
29
  ##
29
30
  # Retrieve a single page of IpAccessControlListInstance records from the API.
30
31
  # Request is executed immediately.
31
- # @param [String] ip_access_control_list_sid The ip_access_control_list_sid
32
+ # @param [String] ip_access_control_list_sid The SID of the [IP Access Control
33
+ # List](https://www.twilio.com/docs/api/rest/ip-access-control-list) that you want
34
+ # to associate with this trunk.
32
35
  # @return [IpAccessControlListInstance] Newly created IpAccessControlListInstance
33
36
  def create(ip_access_control_list_sid: nil)
34
37
  data = Twilio::Values.of({'IpAccessControlListSid' => ip_access_control_list_sid, })
@@ -215,7 +218,8 @@ module Twilio
215
218
  # Initialize the IpAccessControlListInstance
216
219
  # @param [Version] version Version that contains the resource
217
220
  # @param [Hash] payload payload that contains response from Twilio
218
- # @param [String] trunk_sid The trunk_sid
221
+ # @param [String] trunk_sid A 34 character string that identifies the Trunk this
222
+ # resrouce is associated with.
219
223
  # @param [String] sid The sid
220
224
  # @return [IpAccessControlListInstance] IpAccessControlListInstance
221
225
  def initialize(version, payload, trunk_sid: nil, sid: nil)
@@ -249,37 +253,37 @@ module Twilio
249
253
  end
250
254
 
251
255
  ##
252
- # @return [String] The account_sid
256
+ # @return [String] The unique sid that identifies this account
253
257
  def account_sid
254
258
  @properties['account_sid']
255
259
  end
256
260
 
257
261
  ##
258
- # @return [String] The sid
262
+ # @return [String] A string that uniquely identifies this resource
259
263
  def sid
260
264
  @properties['sid']
261
265
  end
262
266
 
263
267
  ##
264
- # @return [String] The trunk_sid
268
+ # @return [String] The unique sid that identifies the associated Trunk
265
269
  def trunk_sid
266
270
  @properties['trunk_sid']
267
271
  end
268
272
 
269
273
  ##
270
- # @return [String] The friendly_name
274
+ # @return [String] A human readable description of this resource
271
275
  def friendly_name
272
276
  @properties['friendly_name']
273
277
  end
274
278
 
275
279
  ##
276
- # @return [Time] The date_created
280
+ # @return [Time] The date this resource was created
277
281
  def date_created
278
282
  @properties['date_created']
279
283
  end
280
284
 
281
285
  ##
282
- # @return [Time] The date_updated
286
+ # @return [Time] The date this resource was last updated
283
287
  def date_updated
284
288
  @properties['date_updated']
285
289
  end
@@ -39,17 +39,19 @@ module Twilio
39
39
  # Recovery](https://www.twilio.com/docs/sip-trunking/getting-started#disaster-recovery) for more information.
40
40
  # @param [String] disaster_recovery_method The HTTP method Twilio will use when
41
41
  # requesting the `DisasterRecoveryUrl`. Either `GET` or `POST`.
42
- # @param [String] recording The recording settings for this trunk. If turned on,
43
- # all calls going through this trunk will be recorded and the recording can either
44
- # start when the call is ringing or when the call is answered. See
42
+ # @param [trunk.RecordingSetting] recording The recording settings for this trunk.
43
+ # If turned on, all calls going through this trunk will be recorded and the
44
+ # recording can either start when the call is ringing or when the call is
45
+ # answered. See
45
46
  # [Recording](https://www.twilio.com/docs/sip-trunking/getting-started#recording)
46
47
  # for more information.
47
48
  # @param [Boolean] secure The Secure Trunking settings for this trunk. If turned
48
49
  # on, all calls going through this trunk will be secure using SRTP for media and
49
50
  # TLS for signalling. If turned off, then RTP will be used for media. See [Secure
50
51
  # Trunking](https://www.twilio.com/docs/sip-trunking/getting-started#securetrunking) for more information.
52
+ # @param [Boolean] cnam_lookup_enabled The cnam_lookup_enabled
51
53
  # @return [TrunkInstance] Newly created TrunkInstance
52
- def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
54
+ def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset)
53
55
  data = Twilio::Values.of({
54
56
  'FriendlyName' => friendly_name,
55
57
  'DomainName' => domain_name,
@@ -57,6 +59,7 @@ module Twilio
57
59
  'DisasterRecoveryMethod' => disaster_recovery_method,
58
60
  'Recording' => recording,
59
61
  'Secure' => secure,
62
+ 'CnamLookupEnabled' => cnam_lookup_enabled,
60
63
  })
61
64
 
62
65
  payload = @version.create(
@@ -243,17 +246,19 @@ module Twilio
243
246
  # Recovery](https://www.twilio.com/docs/sip-trunking/getting-started#disaster-recovery) for more information.
244
247
  # @param [String] disaster_recovery_method The HTTP method Twilio will use when
245
248
  # requesting the `DisasterRecoveryUrl`. Either `GET` or `POST`.
246
- # @param [String] recording The recording settings for this trunk. If turned on,
247
- # all calls going through this trunk will be recorded and the recording can either
248
- # start when the call is ringing or when the call is answered. See
249
+ # @param [trunk.RecordingSetting] recording The recording settings for this trunk.
250
+ # If turned on, all calls going through this trunk will be recorded and the
251
+ # recording can either start when the call is ringing or when the call is
252
+ # answered. See
249
253
  # [Recording](https://www.twilio.com/docs/sip-trunking/getting-started#recording)
250
254
  # for more information.
251
255
  # @param [Boolean] secure The Secure Trunking settings for this trunk. If turned
252
256
  # on, all calls going through this trunk will be secure using SRTP for media and
253
257
  # TLS for signalling. If turned off, then RTP will be used for media. See [Secure
254
258
  # Trunking](https://www.twilio.com/docs/sip-trunking/getting-started#securetrunking) for more information.
259
+ # @param [Boolean] cnam_lookup_enabled The cnam_lookup_enabled
255
260
  # @return [TrunkInstance] Updated TrunkInstance
256
- def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
261
+ def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset)
257
262
  data = Twilio::Values.of({
258
263
  'FriendlyName' => friendly_name,
259
264
  'DomainName' => domain_name,
@@ -261,6 +266,7 @@ module Twilio
261
266
  'DisasterRecoveryMethod' => disaster_recovery_method,
262
267
  'Recording' => recording,
263
268
  'Secure' => secure,
269
+ 'CnamLookupEnabled' => cnam_lookup_enabled,
264
270
  })
265
271
 
266
272
  payload = @version.update(
@@ -371,6 +377,7 @@ module Twilio
371
377
  'friendly_name' => payload['friendly_name'],
372
378
  'secure' => payload['secure'],
373
379
  'recording' => payload['recording'],
380
+ 'cnam_lookup_enabled' => payload['cnam_lookup_enabled'],
374
381
  'auth_type' => payload['auth_type'],
375
382
  'auth_type_set' => payload['auth_type_set'],
376
383
  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
@@ -438,6 +445,12 @@ module Twilio
438
445
  @properties['recording']
439
446
  end
440
447
 
448
+ ##
449
+ # @return [Boolean] The cnam_lookup_enabled
450
+ def cnam_lookup_enabled
451
+ @properties['cnam_lookup_enabled']
452
+ end
453
+
441
454
  ##
442
455
  # @return [String] The types of authentication you have mapped to your domain.
443
456
  def auth_type
@@ -509,17 +522,19 @@ module Twilio
509
522
  # Recovery](https://www.twilio.com/docs/sip-trunking/getting-started#disaster-recovery) for more information.
510
523
  # @param [String] disaster_recovery_method The HTTP method Twilio will use when
511
524
  # requesting the `DisasterRecoveryUrl`. Either `GET` or `POST`.
512
- # @param [String] recording The recording settings for this trunk. If turned on,
513
- # all calls going through this trunk will be recorded and the recording can either
514
- # start when the call is ringing or when the call is answered. See
525
+ # @param [trunk.RecordingSetting] recording The recording settings for this trunk.
526
+ # If turned on, all calls going through this trunk will be recorded and the
527
+ # recording can either start when the call is ringing or when the call is
528
+ # answered. See
515
529
  # [Recording](https://www.twilio.com/docs/sip-trunking/getting-started#recording)
516
530
  # for more information.
517
531
  # @param [Boolean] secure The Secure Trunking settings for this trunk. If turned
518
532
  # on, all calls going through this trunk will be secure using SRTP for media and
519
533
  # TLS for signalling. If turned off, then RTP will be used for media. See [Secure
520
534
  # Trunking](https://www.twilio.com/docs/sip-trunking/getting-started#securetrunking) for more information.
535
+ # @param [Boolean] cnam_lookup_enabled The cnam_lookup_enabled
521
536
  # @return [TrunkInstance] Updated TrunkInstance
522
- def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
537
+ def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset)
523
538
  context.update(
524
539
  friendly_name: friendly_name,
525
540
  domain_name: domain_name,
@@ -527,6 +542,7 @@ module Twilio
527
542
  disaster_recovery_method: disaster_recovery_method,
528
543
  recording: recording,
529
544
  secure: secure,
545
+ cnam_lookup_enabled: cnam_lookup_enabled,
530
546
  )
531
547
  end
532
548
 
@@ -29,9 +29,11 @@ module Twilio
29
29
  # Lists CompositionInstance records from the API as a list.
30
30
  # Unlike stream(), this operation is eager and will load `limit` records into
31
31
  # memory before returning.
32
- # @param [composition.Status] status The status
33
- # @param [Time] date_created_after The date_created_after
34
- # @param [Time] date_created_before The date_created_before
32
+ # @param [composition.Status] status Only show Compositions with the given status.
33
+ # @param [Time] date_created_after Only show Compositions that started on or after
34
+ # this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
35
+ # @param [Time] date_created_before Only show Compositions that started before
36
+ # this this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
35
37
  # @param [String] room_sid The room_sid
36
38
  # @param [Integer] limit Upper limit for the number of records to return. stream()
37
39
  # guarantees to never return more than limit. Default is no limit
@@ -55,9 +57,11 @@ module Twilio
55
57
  # Streams CompositionInstance records from the API as an Enumerable.
56
58
  # This operation lazily loads records as efficiently as possible until the limit
57
59
  # is reached.
58
- # @param [composition.Status] status The status
59
- # @param [Time] date_created_after The date_created_after
60
- # @param [Time] date_created_before The date_created_before
60
+ # @param [composition.Status] status Only show Compositions with the given status.
61
+ # @param [Time] date_created_after Only show Compositions that started on or after
62
+ # this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
63
+ # @param [Time] date_created_before Only show Compositions that started before
64
+ # this this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
61
65
  # @param [String] room_sid The room_sid
62
66
  # @param [Integer] limit Upper limit for the number of records to return. stream()
63
67
  # guarantees to never return more than limit. Default is no limit.
@@ -97,9 +101,11 @@ module Twilio
97
101
  ##
98
102
  # Retrieve a single page of CompositionInstance records from the API.
99
103
  # Request is executed immediately.
100
- # @param [composition.Status] status The status
101
- # @param [Time] date_created_after The date_created_after
102
- # @param [Time] date_created_before The date_created_before
104
+ # @param [composition.Status] status Only show Compositions with the given status.
105
+ # @param [Time] date_created_after Only show Compositions that started on or after
106
+ # this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
107
+ # @param [Time] date_created_before Only show Compositions that started before
108
+ # this this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
103
109
  # @param [String] room_sid The room_sid
104
110
  # @param [String] page_token PageToken provided by the API
105
111
  # @param [Integer] page_number Page Number, this value is simply for client state
@@ -215,7 +221,8 @@ module Twilio
215
221
  ##
216
222
  # Initialize the CompositionContext
217
223
  # @param [Version] version Version that contains the resource
218
- # @param [String] sid The sid
224
+ # @param [String] sid The Composition Sid that uniquely identifies the Composition
225
+ # to fetch.
219
226
  # @return [CompositionContext] CompositionContext
220
227
  def initialize(version, sid)
221
228
  super(version)
@@ -262,7 +269,8 @@ module Twilio
262
269
  # Initialize the CompositionInstance
263
270
  # @param [Version] version Version that contains the resource
264
271
  # @param [Hash] payload payload that contains response from Twilio
265
- # @param [String] sid The sid
272
+ # @param [String] sid The Composition Sid that uniquely identifies the Composition
273
+ # to fetch.
266
274
  # @return [CompositionInstance] CompositionInstance
267
275
  def initialize(version, payload, sid: nil)
268
276
  super(version)
@@ -306,79 +314,79 @@ module Twilio
306
314
  end
307
315
 
308
316
  ##
309
- # @return [String] The account_sid
317
+ # @return [String] Twilio Account SID.
310
318
  def account_sid
311
319
  @properties['account_sid']
312
320
  end
313
321
 
314
322
  ##
315
- # @return [composition.Status] The status
323
+ # @return [composition.Status] The status of the Composition.
316
324
  def status
317
325
  @properties['status']
318
326
  end
319
327
 
320
328
  ##
321
- # @return [Time] The date_created
329
+ # @return [Time] Date when the Composition Resource was created.
322
330
  def date_created
323
331
  @properties['date_created']
324
332
  end
325
333
 
326
334
  ##
327
- # @return [String] The date_completed
335
+ # @return [String] Date when the media processing task finished.
328
336
  def date_completed
329
337
  @properties['date_completed']
330
338
  end
331
339
 
332
340
  ##
333
- # @return [String] The date_deleted
341
+ # @return [String] Date when the Composition Resource generated media was deleted.
334
342
  def date_deleted
335
343
  @properties['date_deleted']
336
344
  end
337
345
 
338
346
  ##
339
- # @return [String] The sid
347
+ # @return [String] A 34-character string that uniquely identifies this Composition.
340
348
  def sid
341
349
  @properties['sid']
342
350
  end
343
351
 
344
352
  ##
345
- # @return [String] The room_sid
353
+ # @return [String] A 34-character string that uniquely identifies the source of this Composition.
346
354
  def room_sid
347
355
  @properties['room_sid']
348
356
  end
349
357
 
350
358
  ##
351
- # @return [String] The audio_sources
359
+ # @return [String] A list of audio sources related to this Composition.
352
360
  def audio_sources
353
361
  @properties['audio_sources']
354
362
  end
355
363
 
356
364
  ##
357
- # @return [String] The audio_sources_excluded
365
+ # @return [String] A list of audio sources excluded related to this Composition.
358
366
  def audio_sources_excluded
359
367
  @properties['audio_sources_excluded']
360
368
  end
361
369
 
362
370
  ##
363
- # @return [Hash] The video_layout
371
+ # @return [Hash] The JSON video layout description.
364
372
  def video_layout
365
373
  @properties['video_layout']
366
374
  end
367
375
 
368
376
  ##
369
- # @return [String] The resolution
377
+ # @return [String] Pixel resolution of the composed video.
370
378
  def resolution
371
379
  @properties['resolution']
372
380
  end
373
381
 
374
382
  ##
375
- # @return [Boolean] The trim
383
+ # @return [Boolean] Boolean flag for clipping intervals that have no media.
376
384
  def trim
377
385
  @properties['trim']
378
386
  end
379
387
 
380
388
  ##
381
- # @return [composition.Format] The format
389
+ # @return [composition.Format] The file format for this Composition.
382
390
  def format
383
391
  @properties['format']
384
392
  end
@@ -390,25 +398,25 @@ module Twilio
390
398
  end
391
399
 
392
400
  ##
393
- # @return [String] The size
401
+ # @return [String] Size of the Composed media file expressed in bytes.
394
402
  def size
395
403
  @properties['size']
396
404
  end
397
405
 
398
406
  ##
399
- # @return [String] The duration
407
+ # @return [String] Duration of the Composed media in seconds.
400
408
  def duration
401
409
  @properties['duration']
402
410
  end
403
411
 
404
412
  ##
405
- # @return [String] The url
413
+ # @return [String] The absolute URL for this resource.
406
414
  def url
407
415
  @properties['url']
408
416
  end
409
417
 
410
418
  ##
411
- # @return [String] The links
419
+ # @return [String] JSON object with the URL where the media file can be fetched.
412
420
  def links
413
421
  @properties['links']
414
422
  end