Class: Twilio::REST::Trunking::V1::TrunkInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the TrunkInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 408

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'domain_name' => payload['domain_name'],
      'disaster_recovery_method' => payload['disaster_recovery_method'],
      'disaster_recovery_url' => payload['disaster_recovery_url'],
      'friendly_name' => payload['friendly_name'],
      'secure' => payload['secure'],
      'recording' => payload['recording'],
      'cnam_lookup_enabled' => payload['cnam_lookup_enabled'],
      'auth_type' => payload['auth_type'],
      'auth_type_set' => payload['auth_type_set'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'sid' => payload['sid'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



448
449
450
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 448

def 
  @properties['account_sid']
end

#auth_type ⇒ String

Returns The types of authentication mapped to the domain.

Returns:

  • (String) —

    The types of authentication mapped to the domain



496
497
498
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 496

def auth_type
  @properties['auth_type']
end

#auth_type_set ⇒ String

Returns Reserved.

Returns:

  • (String) —

    Reserved



502
503
504
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 502

def auth_type_set
  @properties['auth_type_set']
end

#cnam_lookup_enabled ⇒ Boolean

Returns Whether Caller ID Name (CNAM) lookup is enabled for the trunk.

Returns:

  • (Boolean) —

    Whether Caller ID Name (CNAM) lookup is enabled for the trunk



490
491
492
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 490

def cnam_lookup_enabled
  @properties['cnam_lookup_enabled']
end

#context ⇒ TrunkContext

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

Returns:



439
440
441
442
443
444
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 439

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

#credentials_lists ⇒ credentials_lists

Access the credentials_lists

Returns:



604
605
606
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 604

def credentials_lists
  context.credentials_lists
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



508
509
510
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 508

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



514
515
516
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 514

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TrunkInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



546
547
548
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 546

def delete
  context.delete
end

#disaster_recovery_method ⇒ String

Returns The HTTP method we use to call the disaster_recovery_url.

Returns:

  • (String) —

    The HTTP method we use to call the disaster_recovery_url



460
461
462
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 460

def disaster_recovery_method
  @properties['disaster_recovery_method']
end

#disaster_recovery_url ⇒ String

Returns The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL.

Returns:

  • (String) —

    The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL



466
467
468
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 466

def disaster_recovery_url
  @properties['disaster_recovery_url']
end

#domain_name ⇒ String

Returns The unique address you reserve on Twilio to which you route your SIP traffic.

Returns:

  • (String) —

    The unique address you reserve on Twilio to which you route your SIP traffic



454
455
456
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 454

def domain_name
  @properties['domain_name']
end

#fetch ⇒ TrunkInstance

Fetch a TrunkInstance

Returns:



539
540
541
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 539

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



472
473
474
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 472

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



638
639
640
641
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 638

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

#ip_access_control_lists ⇒ ip_access_control_lists

Access the ip_access_control_lists

Returns:



611
612
613
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 611

def ip_access_control_lists
  context.ip_access_control_lists
end

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



532
533
534
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 532

def links
  @properties['links']
end

#origination_urls ⇒ origination_urls

Access the origination_urls

Returns:



597
598
599
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 597

def origination_urls
  context.origination_urls
end

#phone_numbers ⇒ phone_numbers

Access the phone_numbers

Returns:



618
619
620
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 618

def phone_numbers
  context.phone_numbers
end

#recording ⇒ Hash

Returns The recording settings for the trunk.

Returns:

  • (Hash) —

    The recording settings for the trunk



484
485
486
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 484

def recording
  @properties['recording']
end

#secure ⇒ Boolean

Returns Whether Secure Trunking is enabled for the trunk.

Returns:

  • (Boolean) —

    Whether Secure Trunking is enabled for the trunk



478
479
480
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 478

def secure
  @properties['secure']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



520
521
522
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 520

def sid
  @properties['sid']
end

#terminating_sip_domains ⇒ terminating_sip_domains

Access the terminating_sip_domains

Returns:



625
626
627
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 625

def terminating_sip_domains
  context.terminating_sip_domains
end

#to_s ⇒ Object

Provide a user friendly representation



631
632
633
634
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 631

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

#update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset) ⇒ TrunkInstance

Update the TrunkInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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

    The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and ‘-` and must end with `pstn.twilio.com`. See [Termination Settings](www.twilio.com/docs/sip-trunking/getting-started#termination) for more information.

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

    The URL we should call using the ‘disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](www.twilio.com/docs/sip-trunking/getting-started#disaster-recovery) for more information.

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

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

  • recording (trunk.RecordingSetting) (defaults to: :unset) —

    The recording settings for the trunk. Can be: ‘do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. See [Recording](www.twilio.com/docs/sip-trunking/getting-started#recording) for more information.

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

    Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](www.twilio.com/docs/sip-trunking/getting-started#securetrunking) for more information.

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

    Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP 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:



582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 582

def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset)
  context.update(
      friendly_name: friendly_name,
      domain_name: domain_name,
      disaster_recovery_url: disaster_recovery_url,
      disaster_recovery_method: disaster_recovery_method,
      recording: recording,
      secure: secure,
      cnam_lookup_enabled: cnam_lookup_enabled,
  )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



526
527
528
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 526

def url
  @properties['url']
end