Class: Twilio::REST::Voice::V1::ByocTrunkInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ByocTrunkInstance

Initialize the ByocTrunkInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ByocTrunk resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 314

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'voice_url' => payload['voice_url'],
        'voice_method' => payload['voice_method'],
        'voice_fallback_url' => payload['voice_fallback_url'],
        'voice_fallback_method' => payload['voice_fallback_method'],
        'status_callback_url' => payload['status_callback_url'],
        'status_callback_method' => payload['status_callback_method'],
        'cnam_lookup_enabled' => payload['cnam_lookup_enabled'],
        'connection_policy_sid' => payload['connection_policy_sid'],
        'from_domain_sid' => payload['from_domain_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the BYOC Trunk resource.

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 354

def 
    @properties['account_sid']
end

#cnam_lookup_enabled ⇒ Boolean

Returns Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, all inbound calls to the BYOC Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](www.twilio.com/docs/sip-trunking#CNAM) for more information.

Returns:

  • (Boolean) —

    Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, all inbound calls to the BYOC Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](www.twilio.com/docs/sip-trunking#CNAM) for more information.



408
409
410
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 408

def cnam_lookup_enabled
    @properties['cnam_lookup_enabled']
end

#connection_policy_sid ⇒ String

Returns The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.

Returns:

  • (String) —

    The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.



414
415
416
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 414

def connection_policy_sid
    @properties['connection_policy_sid']
end

#context ⇒ ByocTrunkContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



345
346
347
348
349
350
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 345

def context
    unless @instance_context
        @instance_context = ByocTrunkContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



426
427
428
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 426

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



432
433
434
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 432

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ByocTrunkInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



445
446
447
448
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 445

def delete

    context.delete
end

#fetch ⇒ ByocTrunkInstance

Fetch the ByocTrunkInstance

Returns:



453
454
455
456
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 453

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



366
367
368
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 366

def friendly_name
    @properties['friendly_name']
end

#from_domain_sid ⇒ String

Returns The SID of the SIP Domain that should be used in the ‘From` header of originating calls sent to your SIP infrastructure. If your SIP infrastructure allows users to "call back" an incoming call, configure this with a [SIP Domain](www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com".

Returns:

  • (String) —

    The SID of the SIP Domain that should be used in the ‘From` header of originating calls sent to your SIP infrastructure. If your SIP infrastructure allows users to "call back" an incoming call, configure this with a [SIP Domain](www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com".



420
421
422
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 420

def from_domain_sid
    @properties['from_domain_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



507
508
509
510
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 507

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Voice.V1.ByocTrunkInstance #{values}>"
end

#sid ⇒ String

Returns The unique string that that we created to identify the BYOC Trunk resource.

Returns:

  • (String) —

    The unique string that that we created to identify the BYOC Trunk resource.



360
361
362
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 360

def sid
    @properties['sid']
end

#status_callback_method ⇒ String

Returns The HTTP method we use to call ‘status_callback_url`. Either `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call ‘status_callback_url`. Either `GET` or `POST`.



402
403
404
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 402

def status_callback_method
    @properties['status_callback_method']
end

#status_callback_url ⇒ String

Returns The URL that we call to pass status parameters (such as call ended) to your application.

Returns:

  • (String) —

    The URL that we call to pass status parameters (such as call ended) to your application.



396
397
398
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 396

def status_callback_url
    @properties['status_callback_url']
end

#to_s ⇒ Object

Provide a user friendly representation



500
501
502
503
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 500

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Voice.V1.ByocTrunkInstance #{values}>"
end

#update(friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, cnam_lookup_enabled: :unset, connection_policy_sid: :unset, from_domain_sid: :unset) ⇒ ByocTrunkInstance

Update the ByocTrunkInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

  • voice_url (String) (defaults to: :unset) —

    The URL we should call when the BYOC Trunk receives a call.

  • voice_method (String) (defaults to: :unset) —

    The HTTP method we should use to call ‘voice_url`

  • voice_fallback_url (String) (defaults to: :unset) —

    The URL that we should call when an error occurs while retrieving or executing the TwiML requested by ‘voice_url`.

  • voice_fallback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call ‘voice_fallback_url`. Can be: `GET` or `POST`.

  • status_callback_url (String) (defaults to: :unset) —

    The URL that we should call to pass status parameters (such as call ended) to your application.

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call ‘status_callback_url`. Can be: `GET` or `POST`.

  • cnam_lookup_enabled (Boolean) (defaults to: :unset) —

    Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, all inbound calls to the BYOC Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](www.twilio.com/docs/sip-trunking#CNAM) for more information.

  • connection_policy_sid (String) (defaults to: :unset) —

    The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.

  • from_domain_sid (String) (defaults to: :unset) —

    The SID of the SIP Domain that should be used in the ‘From` header of originating calls sent to your SIP infrastructure. If your SIP infrastructure allows users to \"call back\" an incoming call, configure this with a [SIP Domain](www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to \"sip.twilio.com\".

Returns:



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 471

def update(
    friendly_name: :unset, 
    voice_url: :unset, 
    voice_method: :unset, 
    voice_fallback_url: :unset, 
    voice_fallback_method: :unset, 
    status_callback_url: :unset, 
    status_callback_method: :unset, 
    cnam_lookup_enabled: :unset, 
    connection_policy_sid: :unset, 
    from_domain_sid: :unset
)

    context.update(
        friendly_name: friendly_name, 
        voice_url: voice_url, 
        voice_method: voice_method, 
        voice_fallback_url: voice_fallback_url, 
        voice_fallback_method: voice_fallback_method, 
        status_callback_url: status_callback_url, 
        status_callback_method: status_callback_method, 
        cnam_lookup_enabled: cnam_lookup_enabled, 
        connection_policy_sid: connection_policy_sid, 
        from_domain_sid: from_domain_sid, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



438
439
440
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 438

def url
    @properties['url']
end

#voice_fallback_method ⇒ String

Returns The HTTP method we use to call ‘voice_fallback_url`. Can be: `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call ‘voice_fallback_url`. Can be: `GET` or `POST`.



390
391
392
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 390

def voice_fallback_method
    @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The URL that we call when an error occurs while retrieving or executing the TwiML requested from ‘voice_url`.

Returns:

  • (String) —

    The URL that we call when an error occurs while retrieving or executing the TwiML requested from ‘voice_url`.



384
385
386
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 384

def voice_fallback_url
    @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method we use to call ‘voice_url`. Can be: `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call ‘voice_url`. Can be: `GET` or `POST`.



378
379
380
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 378

def voice_method
    @properties['voice_method']
end

#voice_url ⇒ String

Returns The URL we call using the ‘voice_method` when the BYOC Trunk receives a call.

Returns:

  • (String) —

    The URL we call using the ‘voice_method` when the BYOC Trunk receives a call.



372
373
374
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 372

def voice_url
    @properties['voice_url']
end