twilio-ruby 5.22.1 → 5.22.2

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 (40) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +12 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +7 -0
  5. data/lib/twilio-ruby/rest/autopilot.rb +1 -1
  6. data/lib/twilio-ruby/rest/autopilot/v1.rb +2 -2
  7. data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +55 -61
  8. data/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb +17 -9
  9. data/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb +18 -10
  10. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +37 -28
  11. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +39 -32
  12. data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +37 -27
  13. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +58 -53
  14. data/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb +15 -9
  15. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +53 -43
  16. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +38 -25
  17. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +56 -50
  18. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb +27 -15
  19. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +24 -18
  20. data/lib/twilio-ruby/rest/client.rb +39 -39
  21. data/lib/twilio-ruby/rest/notify.rb +4 -2
  22. data/lib/twilio-ruby/rest/notify/v1.rb +4 -2
  23. data/lib/twilio-ruby/rest/notify/v1/credential.rb +47 -42
  24. data/lib/twilio-ruby/rest/notify/v1/service.rb +118 -103
  25. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +74 -63
  26. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +108 -111
  27. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +7 -0
  28. data/lib/twilio-ruby/rest/trunking.rb +2 -2
  29. data/lib/twilio-ruby/rest/trunking/v1.rb +2 -2
  30. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +82 -82
  31. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +19 -14
  32. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +16 -15
  33. data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +51 -50
  34. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +41 -32
  35. data/lib/twilio-ruby/rest/trunking/v1/trunk/terminating_sip_domain.rb +30 -31
  36. data/lib/twilio-ruby/twiml/voice_response.rb +3 -2
  37. data/lib/twilio-ruby/version.rb +1 -1
  38. data/spec/integration/api/v2010/account/address_spec.rb +4 -0
  39. data/spec/integration/proxy/v1/service/phone_number_spec.rb +8 -4
  40. metadata +2 -2
@@ -15,8 +15,7 @@ module Twilio
15
15
  ##
16
16
  # Initialize the OriginationUrlList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] trunk_sid The unique ID of the Trunk that owns this Origination
19
- # URL.
18
+ # @param [String] trunk_sid The SID of the Trunk that owns the Origination URL.
20
19
  # @return [OriginationUrlList] OriginationUrlList
21
20
  def initialize(version, trunk_sid: nil)
22
21
  super(version)
@@ -29,16 +28,16 @@ module Twilio
29
28
  ##
30
29
  # Retrieve a single page of OriginationUrlInstance records from the API.
31
30
  # Request is executed immediately.
32
- # @param [String] weight Weight is used to determine the share of load when more
33
- # than one URI has the same priority. Its values range from 1 to 65535. The higher
34
- # the value, the more load a URI is given. Defaults to 10.
35
- # @param [String] priority Priority ranks the importance of the URI. Values range
36
- # from 0 to 65535, where the lowest number represents the highest importance.
37
- # Defaults to 10.
38
- # @param [Boolean] enabled A boolean value indicating whether the URL is enabled
39
- # or disabled. Defaults to true.
40
- # @param [String] friendly_name A human readable descriptive text, up to 64
41
- # characters long.
31
+ # @param [String] weight The value that determines the relative share of the load
32
+ # the URI should receive compared to other URIs with the same priority. Can be an
33
+ # integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
34
+ # values receive more load than those with lower ones with the same priority.
35
+ # @param [String] priority The relative importance of the URI. Can be an integer
36
+ # from 0 to 65535, inclusive, and the default is 10. The lowest number represents
37
+ # the most important URI.
38
+ # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
39
+ # @param [String] friendly_name A descriptive string that you create to describe
40
+ # the resource. It can be up to 64 characters long.
42
41
  # @param [String] sip_url The SIP address you want Twilio to route your
43
42
  # Origination calls to. This must be a `sip:` schema.
44
43
  # @return [OriginationUrlInstance] Newly created OriginationUrlInstance
@@ -182,8 +181,10 @@ module Twilio
182
181
  ##
183
182
  # Initialize the OriginationUrlContext
184
183
  # @param [Version] version Version that contains the resource
185
- # @param [String] trunk_sid The trunk_sid
186
- # @param [String] sid The sid
184
+ # @param [String] trunk_sid The SID of the Trunk from which to fetch the
185
+ # OriginationUrl.
186
+ # @param [String] sid The unique string that we created to identify the
187
+ # OriginationUrl resource to fetch.
187
188
  # @return [OriginationUrlContext] OriginationUrlContext
188
189
  def initialize(version, trunk_sid, sid)
189
190
  super(version)
@@ -222,18 +223,18 @@ module Twilio
222
223
 
223
224
  ##
224
225
  # Update the OriginationUrlInstance
225
- # @param [String] weight Weight is used to determine the share of load when more
226
- # than one URI has the same priority. Its values range from 1 to 65535. The higher
227
- # the value, the more load a URI is given. Defaults to 10.
228
- # @param [String] priority Priority ranks the importance of the URI. Values range
229
- # from 0 to 65535, where the lowest number represents the highest importance.
230
- # Defaults to 10.
231
- # @param [Boolean] enabled A boolean value indicating whether the URL is enabled
232
- # or disabled. Defaults to true.
233
- # @param [String] friendly_name A human readable descriptive text, up to 64
234
- # characters long.
226
+ # @param [String] weight The value that determines the relative share of the load
227
+ # the URI should receive compared to other URIs with the same priority. Can be an
228
+ # integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
229
+ # values receive more load than those with lower ones with the same priority.
230
+ # @param [String] priority The relative importance of the URI. Can be an integer
231
+ # from 0 to 65535, inclusive, and the default is 10. The lowest number represents
232
+ # the most important URI.
233
+ # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
234
+ # @param [String] friendly_name A descriptive string that you create to describe
235
+ # the resource. It can be up to 64 characters long.
235
236
  # @param [String] sip_url The SIP address you want Twilio to route your
236
- # Origination calls to. This must be a `sip:` schema. `sips` is NOT supported
237
+ # Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.
237
238
  # @return [OriginationUrlInstance] Updated OriginationUrlInstance
238
239
  def update(weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset)
239
240
  data = Twilio::Values.of({
@@ -278,9 +279,9 @@ module Twilio
278
279
  # Initialize the OriginationUrlInstance
279
280
  # @param [Version] version Version that contains the resource
280
281
  # @param [Hash] payload payload that contains response from Twilio
281
- # @param [String] trunk_sid The unique ID of the Trunk that owns this Origination
282
- # URL.
283
- # @param [String] sid The sid
282
+ # @param [String] trunk_sid The SID of the Trunk that owns the Origination URL.
283
+ # @param [String] sid The unique string that we created to identify the
284
+ # OriginationUrl resource to fetch.
284
285
  # @return [OriginationUrlInstance] OriginationUrlInstance
285
286
  def initialize(version, payload, trunk_sid: nil, sid: nil)
286
287
  super(version)
@@ -317,67 +318,67 @@ module Twilio
317
318
  end
318
319
 
319
320
  ##
320
- # @return [String] The unique ID of the Account that owns this Origination URL.
321
+ # @return [String] The SID of the Account that created the resource
321
322
  def account_sid
322
323
  @properties['account_sid']
323
324
  end
324
325
 
325
326
  ##
326
- # @return [String] A 34 character string that uniquely identifies the Origination URL in this Twilio Trunk.
327
+ # @return [String] The unique string that identifies the resource
327
328
  def sid
328
329
  @properties['sid']
329
330
  end
330
331
 
331
332
  ##
332
- # @return [String] The unique ID of the Trunk that owns this Origination URL.
333
+ # @return [String] The SID of the Trunk that owns the Origination URL
333
334
  def trunk_sid
334
335
  @properties['trunk_sid']
335
336
  end
336
337
 
337
338
  ##
338
- # @return [String] Weight is used to determine the share of load when more than one URI has the same priority.
339
+ # @return [String] The value that determines the relative load the URI should receive compared to others with the same priority
339
340
  def weight
340
341
  @properties['weight']
341
342
  end
342
343
 
343
344
  ##
344
- # @return [Boolean] A boolean value indicating whether the URL is enabled or disabled.
345
+ # @return [Boolean] Whether the URL is enabled
345
346
  def enabled
346
347
  @properties['enabled']
347
348
  end
348
349
 
349
350
  ##
350
- # @return [String] The SIP address you want Twilio to route your Origination calls to.
351
+ # @return [String] The SIP address you want Twilio to route your Origination calls to
351
352
  def sip_url
352
353
  @properties['sip_url']
353
354
  end
354
355
 
355
356
  ##
356
- # @return [String] A human readable descriptive text, up to 64 characters long.
357
+ # @return [String] The string that you assigned to describe the resource
357
358
  def friendly_name
358
359
  @properties['friendly_name']
359
360
  end
360
361
 
361
362
  ##
362
- # @return [String] Priority ranks the importance of the URI.
363
+ # @return [String] The relative importance of the URI
363
364
  def priority
364
365
  @properties['priority']
365
366
  end
366
367
 
367
368
  ##
368
- # @return [Time] The date this Activity was created.
369
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was created
369
370
  def date_created
370
371
  @properties['date_created']
371
372
  end
372
373
 
373
374
  ##
374
- # @return [Time] The date this Activity was updated.
375
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
375
376
  def date_updated
376
377
  @properties['date_updated']
377
378
  end
378
379
 
379
380
  ##
380
- # @return [String] The URL for this resource, relative to https://trunking.
381
+ # @return [String] The absolute URL of the resource
381
382
  def url
382
383
  @properties['url']
383
384
  end
@@ -398,18 +399,18 @@ module Twilio
398
399
 
399
400
  ##
400
401
  # Update the OriginationUrlInstance
401
- # @param [String] weight Weight is used to determine the share of load when more
402
- # than one URI has the same priority. Its values range from 1 to 65535. The higher
403
- # the value, the more load a URI is given. Defaults to 10.
404
- # @param [String] priority Priority ranks the importance of the URI. Values range
405
- # from 0 to 65535, where the lowest number represents the highest importance.
406
- # Defaults to 10.
407
- # @param [Boolean] enabled A boolean value indicating whether the URL is enabled
408
- # or disabled. Defaults to true.
409
- # @param [String] friendly_name A human readable descriptive text, up to 64
410
- # characters long.
402
+ # @param [String] weight The value that determines the relative share of the load
403
+ # the URI should receive compared to other URIs with the same priority. Can be an
404
+ # integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
405
+ # values receive more load than those with lower ones with the same priority.
406
+ # @param [String] priority The relative importance of the URI. Can be an integer
407
+ # from 0 to 65535, inclusive, and the default is 10. The lowest number represents
408
+ # the most important URI.
409
+ # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
410
+ # @param [String] friendly_name A descriptive string that you create to describe
411
+ # the resource. It can be up to 64 characters long.
411
412
  # @param [String] sip_url The SIP address you want Twilio to route your
412
- # Origination calls to. This must be a `sip:` schema. `sips` is NOT supported
413
+ # Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.
413
414
  # @return [OriginationUrlInstance] Updated OriginationUrlInstance
414
415
  def update(weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset)
415
416
  context.update(
@@ -15,7 +15,10 @@ module Twilio
15
15
  ##
16
16
  # Initialize the PhoneNumberList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] trunk_sid The trunk_sid
18
+ # @param [String] trunk_sid The SID of the Trunk that handles calls to the phone
19
+ # number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice
20
+ # applications and use those set on the Trunk. Setting a `trunk_sid` will
21
+ # automatically delete your `voice_application_sid` and vice versa.
19
22
  # @return [PhoneNumberList] PhoneNumberList
20
23
  def initialize(version, trunk_sid: nil)
21
24
  super(version)
@@ -30,7 +33,7 @@ module Twilio
30
33
  # Request is executed immediately.
31
34
  # @param [String] phone_number_sid The SID of the [Incoming Phone
32
35
  # Number](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) that you
33
- # want to associate with this trunk.
36
+ # want to associate with the trunk.
34
37
  # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
35
38
  def create(phone_number_sid: nil)
36
39
  data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, })
@@ -166,8 +169,10 @@ module Twilio
166
169
  ##
167
170
  # Initialize the PhoneNumberContext
168
171
  # @param [Version] version Version that contains the resource
169
- # @param [String] trunk_sid The trunk_sid
170
- # @param [String] sid The sid
172
+ # @param [String] trunk_sid The SID of the Trunk from which to fetch the
173
+ # PhoneNumber resource.
174
+ # @param [String] sid The unique string that we created to identify the
175
+ # PhoneNumber resource to fetch.
171
176
  # @return [PhoneNumberContext] PhoneNumberContext
172
177
  def initialize(version, trunk_sid, sid)
173
178
  super(version)
@@ -219,8 +224,12 @@ module Twilio
219
224
  # Initialize the PhoneNumberInstance
220
225
  # @param [Version] version Version that contains the resource
221
226
  # @param [Hash] payload payload that contains response from Twilio
222
- # @param [String] trunk_sid The trunk_sid
223
- # @param [String] sid The sid
227
+ # @param [String] trunk_sid The SID of the Trunk that handles calls to the phone
228
+ # number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice
229
+ # applications and use those set on the Trunk. Setting a `trunk_sid` will
230
+ # automatically delete your `voice_application_sid` and vice versa.
231
+ # @param [String] sid The unique string that we created to identify the
232
+ # PhoneNumber resource to fetch.
224
233
  # @return [PhoneNumberInstance] PhoneNumberInstance
225
234
  def initialize(version, payload, trunk_sid: nil, sid: nil)
226
235
  super(version)
@@ -272,157 +281,157 @@ module Twilio
272
281
  end
273
282
 
274
283
  ##
275
- # @return [String] The account_sid
284
+ # @return [String] The SID of the Account that created the resource
276
285
  def account_sid
277
286
  @properties['account_sid']
278
287
  end
279
288
 
280
289
  ##
281
- # @return [phone_number.AddressRequirement] The address_requirements
290
+ # @return [phone_number.AddressRequirement] Whether the phone number requires an Address registered with Twilio
282
291
  def address_requirements
283
292
  @properties['address_requirements']
284
293
  end
285
294
 
286
295
  ##
287
- # @return [String] The api_version
296
+ # @return [String] The API version used to start a new TwiML session
288
297
  def api_version
289
298
  @properties['api_version']
290
299
  end
291
300
 
292
301
  ##
293
- # @return [Boolean] The beta
302
+ # @return [Boolean] Whether the phone number is new to the Twilio platform
294
303
  def beta
295
304
  @properties['beta']
296
305
  end
297
306
 
298
307
  ##
299
- # @return [String] The capabilities
308
+ # @return [String] Indicate if a phone can receive calls or messages
300
309
  def capabilities
301
310
  @properties['capabilities']
302
311
  end
303
312
 
304
313
  ##
305
- # @return [Time] The date_created
314
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was created
306
315
  def date_created
307
316
  @properties['date_created']
308
317
  end
309
318
 
310
319
  ##
311
- # @return [Time] The date_updated
320
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
312
321
  def date_updated
313
322
  @properties['date_updated']
314
323
  end
315
324
 
316
325
  ##
317
- # @return [String] The friendly_name
326
+ # @return [String] The string that you assigned to describe the resource
318
327
  def friendly_name
319
328
  @properties['friendly_name']
320
329
  end
321
330
 
322
331
  ##
323
- # @return [String] The links
332
+ # @return [String] The URLs of related resources
324
333
  def links
325
334
  @properties['links']
326
335
  end
327
336
 
328
337
  ##
329
- # @return [String] The phone_number
338
+ # @return [String] The phone number in E.164 format
330
339
  def phone_number
331
340
  @properties['phone_number']
332
341
  end
333
342
 
334
343
  ##
335
- # @return [String] The sid
344
+ # @return [String] The unique string that identifies the resource
336
345
  def sid
337
346
  @properties['sid']
338
347
  end
339
348
 
340
349
  ##
341
- # @return [String] The sms_application_sid
350
+ # @return [String] The SID of the application that handles SMS messages sent to the phone number
342
351
  def sms_application_sid
343
352
  @properties['sms_application_sid']
344
353
  end
345
354
 
346
355
  ##
347
- # @return [String] The sms_fallback_method
356
+ # @return [String] The HTTP method used with sms_fallback_url
348
357
  def sms_fallback_method
349
358
  @properties['sms_fallback_method']
350
359
  end
351
360
 
352
361
  ##
353
- # @return [String] The sms_fallback_url
362
+ # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML
354
363
  def sms_fallback_url
355
364
  @properties['sms_fallback_url']
356
365
  end
357
366
 
358
367
  ##
359
- # @return [String] The sms_method
368
+ # @return [String] The HTTP method to use with sms_url
360
369
  def sms_method
361
370
  @properties['sms_method']
362
371
  end
363
372
 
364
373
  ##
365
- # @return [String] The sms_url
374
+ # @return [String] The URL we call when the phone number receives an incoming SMS message
366
375
  def sms_url
367
376
  @properties['sms_url']
368
377
  end
369
378
 
370
379
  ##
371
- # @return [String] The status_callback
380
+ # @return [String] The URL to send status information to your application
372
381
  def status_callback
373
382
  @properties['status_callback']
374
383
  end
375
384
 
376
385
  ##
377
- # @return [String] The status_callback_method
386
+ # @return [String] The HTTP method we use to call status_callback
378
387
  def status_callback_method
379
388
  @properties['status_callback_method']
380
389
  end
381
390
 
382
391
  ##
383
- # @return [String] The trunk_sid
392
+ # @return [String] The SID of the Trunk that handles calls to the phone number
384
393
  def trunk_sid
385
394
  @properties['trunk_sid']
386
395
  end
387
396
 
388
397
  ##
389
- # @return [String] The url
398
+ # @return [String] The absolute URL of the resource
390
399
  def url
391
400
  @properties['url']
392
401
  end
393
402
 
394
403
  ##
395
- # @return [String] The voice_application_sid
404
+ # @return [String] The SID of the application that handles calls to the phone number
396
405
  def voice_application_sid
397
406
  @properties['voice_application_sid']
398
407
  end
399
408
 
400
409
  ##
401
- # @return [Boolean] The voice_caller_id_lookup
410
+ # @return [Boolean] Whether to lookup the caller's name
402
411
  def voice_caller_id_lookup
403
412
  @properties['voice_caller_id_lookup']
404
413
  end
405
414
 
406
415
  ##
407
- # @return [String] The voice_fallback_method
416
+ # @return [String] The HTTP method that we use to call voice_fallback_url
408
417
  def voice_fallback_method
409
418
  @properties['voice_fallback_method']
410
419
  end
411
420
 
412
421
  ##
413
- # @return [String] The voice_fallback_url
422
+ # @return [String] The URL we call when an error occurs in TwiML
414
423
  def voice_fallback_url
415
424
  @properties['voice_fallback_url']
416
425
  end
417
426
 
418
427
  ##
419
- # @return [String] The voice_method
428
+ # @return [String] The HTTP method used with the voice_url
420
429
  def voice_method
421
430
  @properties['voice_method']
422
431
  end
423
432
 
424
433
  ##
425
- # @return [String] The voice_url
434
+ # @return [String] The URL we call when the phone number receives a call
426
435
  def voice_url
427
436
  @properties['voice_url']
428
437
  end
@@ -15,10 +15,9 @@ module Twilio
15
15
  ##
16
16
  # Initialize the TerminatingSipDomainList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] trunk_sid The 34 character sid of the Trunk Twilio should route
19
- # calls arriving at this domain. If a `TrunkSid` is present, Twilio will ignore
20
- # all of the voice urls present and calls will be terminated through the specified
21
- # trunk.
18
+ # @param [String] trunk_sid The SID of the Trunk to which we should route calls
19
+ # that arrive at the domain. If a `trunk_sid` is present, we ignore all of the
20
+ # voice URLs present and terminate calls through the specified trunk.
22
21
  # @return [TerminatingSipDomainList] TerminatingSipDomainList
23
22
  def initialize(version, trunk_sid: nil)
24
23
  super(version)
@@ -33,7 +32,7 @@ module Twilio
33
32
  # Request is executed immediately.
34
33
  # @param [String] sip_domain_sid The SID of the [SIP
35
34
  # Domain](https://www.twilio.com/docs/voice/sip/api/sip-domain-resource) that you
36
- # want to associate with this trunk.
35
+ # want to associate with the trunk.
37
36
  # @return [TerminatingSipDomainInstance] Newly created TerminatingSipDomainInstance
38
37
  def create(sip_domain_sid: nil)
39
38
  data = Twilio::Values.of({'SipDomainSid' => sip_domain_sid, })
@@ -169,9 +168,10 @@ module Twilio
169
168
  ##
170
169
  # Initialize the TerminatingSipDomainContext
171
170
  # @param [Version] version Version that contains the resource
172
- # @param [String] trunk_sid A unique string that identifies the trunk.
173
- # @param [String] sid A unique string that identifies the associated domain to
174
- # fetch.
171
+ # @param [String] trunk_sid The SID of the Trunk with the TerminatingSipDomain
172
+ # resource to fetch.
173
+ # @param [String] sid The unique string that we created to identify the
174
+ # TerminatingSipDomain resource to fetch.
175
175
  # @return [TerminatingSipDomainContext] TerminatingSipDomainContext
176
176
  def initialize(version, trunk_sid, sid)
177
177
  super(version)
@@ -228,12 +228,11 @@ module Twilio
228
228
  # Initialize the TerminatingSipDomainInstance
229
229
  # @param [Version] version Version that contains the resource
230
230
  # @param [Hash] payload payload that contains response from Twilio
231
- # @param [String] trunk_sid The 34 character sid of the Trunk Twilio should route
232
- # calls arriving at this domain. If a `TrunkSid` is present, Twilio will ignore
233
- # all of the voice urls present and calls will be terminated through the specified
234
- # trunk.
235
- # @param [String] sid A unique string that identifies the associated domain to
236
- # fetch.
231
+ # @param [String] trunk_sid The SID of the Trunk to which we should route calls
232
+ # that arrive at the domain. If a `trunk_sid` is present, we ignore all of the
233
+ # voice URLs present and terminate calls through the specified trunk.
234
+ # @param [String] sid The unique string that we created to identify the
235
+ # TerminatingSipDomain resource to fetch.
237
236
  # @return [TerminatingSipDomainInstance] TerminatingSipDomainInstance
238
237
  def initialize(version, payload, trunk_sid: nil, sid: nil)
239
238
  super(version)
@@ -277,13 +276,13 @@ module Twilio
277
276
  end
278
277
 
279
278
  ##
280
- # @return [String] The unique id of the account responsible for this domain
279
+ # @return [String] The SID of the Account that created the resource
281
280
  def account_sid
282
281
  @properties['account_sid']
283
282
  end
284
283
 
285
284
  ##
286
- # @return [String] The Twilio API version used to process the call
285
+ # @return [String] The API version used to process the call
287
286
  def api_version
288
287
  @properties['api_version']
289
288
  end
@@ -295,91 +294,91 @@ module Twilio
295
294
  end
296
295
 
297
296
  ##
298
- # @return [Time] The date this resource was created
297
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was created
299
298
  def date_created
300
299
  @properties['date_created']
301
300
  end
302
301
 
303
302
  ##
304
- # @return [Time] The date this resource was last updated
303
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
305
304
  def date_updated
306
305
  @properties['date_updated']
307
306
  end
308
307
 
309
308
  ##
310
- # @return [String] The unique address on Twilio to route SIP traffic
309
+ # @return [String] The unique address you reserve on Twilio to which you route your SIP traffic
311
310
  def domain_name
312
311
  @properties['domain_name']
313
312
  end
314
313
 
315
314
  ##
316
- # @return [String] A user-specified, human-readable name for the domain.
315
+ # @return [String] The string that you assigned to describe the resource
317
316
  def friendly_name
318
317
  @properties['friendly_name']
319
318
  end
320
319
 
321
320
  ##
322
- # @return [String] A string that uniquely identifies the SIP Domain
321
+ # @return [String] The unique string that identifies the resource
323
322
  def sid
324
323
  @properties['sid']
325
324
  end
326
325
 
327
326
  ##
328
- # @return [String] The url
327
+ # @return [String] The absolute URL of the resource
329
328
  def url
330
329
  @properties['url']
331
330
  end
332
331
 
333
332
  ##
334
- # @return [String] HTTP method used with voice_fallback_url
333
+ # @return [String] The HTTP method used with voice_fallback_url
335
334
  def voice_fallback_method
336
335
  @properties['voice_fallback_method']
337
336
  end
338
337
 
339
338
  ##
340
- # @return [String] URL Twilio will request if an error occurs in executing TwiML
339
+ # @return [String] The URL that we call when an error occurs in executing TwiML
341
340
  def voice_fallback_url
342
341
  @properties['voice_fallback_url']
343
342
  end
344
343
 
345
344
  ##
346
- # @return [String] HTTP method to use with voice_url
345
+ # @return [String] The HTTP method used with voice_url
347
346
  def voice_method
348
347
  @properties['voice_method']
349
348
  end
350
349
 
351
350
  ##
352
- # @return [String] The HTTP method Twilio will use to make requests to the StatusCallback URL.
351
+ # @return [String] The HTTP method that we use to call the voice_status_callback_url
353
352
  def voice_status_callback_method
354
353
  @properties['voice_status_callback_method']
355
354
  end
356
355
 
357
356
  ##
358
- # @return [String] URL that Twilio will request with status updates
357
+ # @return [String] The URL that we call to pass status parameters to your application
359
358
  def voice_status_callback_url
360
359
  @properties['voice_status_callback_url']
361
360
  end
362
361
 
363
362
  ##
364
- # @return [String] URL Twilio will request when receiving a call
363
+ # @return [String] The URL we call when the domain receives a call
365
364
  def voice_url
366
365
  @properties['voice_url']
367
366
  end
368
367
 
369
368
  ##
370
- # @return [Boolean] If SIP registration is allowed
369
+ # @return [Boolean] Whether SIP Endpoints can register with the domain to receive calls
371
370
  def sip_registration
372
371
  @properties['sip_registration']
373
372
  end
374
373
 
375
374
  ##
376
- # @return [String] Unique string to identify an associated trunk
375
+ # @return [String] The SID of the Trunk to which we should route calls
377
376
  def trunk_sid
378
377
  @properties['trunk_sid']
379
378
  end
380
379
 
381
380
  ##
382
- # @return [String] The links
381
+ # @return [String] The URLs of related resources
383
382
  def links
384
383
  @properties['links']
385
384
  end