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.



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 629

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:



670
671
672
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 670

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.



724
725
726
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 724

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.



730
731
732
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 730

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:



661
662
663
664
665
666
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 661

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:



742
743
744
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 742

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:



748
749
750
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 748

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ByocTrunkInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



761
762
763
764
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 761

def delete

    context.delete
end

#fetch ⇒ ByocTrunkInstance

Fetch the ByocTrunkInstance

Returns:



769
770
771
772
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 769

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.



682
683
684
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 682

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".



736
737
738
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 736

def from_domain_sid
    @properties['from_domain_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



823
824
825
826
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 823

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.



676
677
678
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 676

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.



718
719
720
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 718

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.



712
713
714
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 712

def status_callback_url
    @properties['status_callback_url']
end

#to_s ⇒ Object

Provide a user friendly representation



816
817
818
819
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 816

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:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 787

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.



754
755
756
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 754

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.



706
707
708
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 706

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.



700
701
702
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 700

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.



694
695
696
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 694

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.



688
689
690
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 688

def voice_url
    @properties['voice_url']
end