Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ DomainInstance

Initialize the DomainInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Account that created this Domain resource.

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

    The SID of the Call resource to fetch.



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 727

def initialize(version, payload , account_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'api_version' => payload['api_version'],
        'auth_type' => payload['auth_type'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'domain_name' => payload['domain_name'],
        'friendly_name' => payload['friendly_name'],
        'sid' => payload['sid'],
        'uri' => payload['uri'],
        'voice_fallback_method' => payload['voice_fallback_method'],
        'voice_fallback_url' => payload['voice_fallback_url'],
        'voice_method' => payload['voice_method'],
        'voice_status_callback_method' => payload['voice_status_callback_method'],
        'voice_status_callback_url' => payload['voice_status_callback_url'],
        'voice_url' => payload['voice_url'],
        'subresource_uris' => payload['subresource_uris'],
        'sip_registration' => payload['sip_registration'],
        'emergency_calling_enabled' => payload['emergency_calling_enabled'],
        'secure' => payload['secure'],
        'byoc_trunk_sid' => payload['byoc_trunk_sid'],
        'emergency_caller_sid' => payload['emergency_caller_sid'],
    }

    # Context
    @instance_context = nil
    @params = { 'account_sid' =>   ,'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 SipDomain resource.

Returns:



774
775
776
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 774

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to process the call.

Returns:

  • (String) —

    The API version used to process the call.



780
781
782
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 780

def api_version
    @properties['api_version']
end

#auth ⇒ auth

Access the auth

Returns:



966
967
968
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 966

def auth
    context.auth
end

#auth_type ⇒ String

Returns The types of authentication you have mapped to your domain. Can be: IP_ACL and CREDENTIAL_LIST. If you have both defined for your domain, both will be returned in a comma delimited string. If auth_type is not defined, the domain will not be able to receive any traffic.

Returns:

  • (String) —

    The types of authentication you have mapped to your domain. Can be: IP_ACL and CREDENTIAL_LIST. If you have both defined for your domain, both will be returned in a comma delimited string. If auth_type is not defined, the domain will not be able to receive any traffic.



786
787
788
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 786

def auth_type
    @properties['auth_type']
end

#byoc_trunk_sid ⇒ String

Returns The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.

Returns:

  • (String) —

    The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.



888
889
890
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 888

def byoc_trunk_sid
    @properties['byoc_trunk_sid']
end

#context ⇒ DomainContext

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

Returns:



765
766
767
768
769
770
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 765

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

#credential_list_mappings ⇒ credential_list_mappings

Access the credential_list_mappings

Returns:



980
981
982
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 980

def credential_list_mappings
    context.credential_list_mappings
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:



792
793
794
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 792

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:



798
799
800
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 798

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DomainInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



901
902
903
904
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 901

def delete

    context.delete
end

#domain_name ⇒ String

Returns 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 sip.twilio.com.

Returns:

  • (String) —

    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 sip.twilio.com.



804
805
806
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 804

def domain_name
    @properties['domain_name']
end

#emergency_caller_sid ⇒ String

Returns Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.

Returns:

  • (String) —

    Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.



894
895
896
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 894

def emergency_caller_sid
    @properties['emergency_caller_sid']
end

#emergency_calling_enabled ⇒ Boolean

Returns Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.

Returns:

  • (Boolean) —

    Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.



876
877
878
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 876

def emergency_calling_enabled
    @properties['emergency_calling_enabled']
end

#fetch ⇒ DomainInstance

Fetch the DomainInstance

Returns:



909
910
911
912
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 909

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.



810
811
812
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 810

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



993
994
995
996
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 993

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

#ip_access_control_list_mappings ⇒ ip_access_control_list_mappings

Access the ip_access_control_list_mappings

Returns:



973
974
975
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 973

def ip_access_control_list_mappings
    context.ip_access_control_list_mappings
end

#secure ⇒ Boolean

Returns Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.

Returns:

  • (Boolean) —

    Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.



882
883
884
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 882

def secure
    @properties['secure']
end

#sid ⇒ String

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

Returns:

  • (String) —

    The unique string that that we created to identify the SipDomain resource.



816
817
818
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 816

def sid
    @properties['sid']
end

#sip_registration ⇒ Boolean

Returns Whether to allow SIP Endpoints to register with the domain to receive calls.

Returns:

  • (Boolean) —

    Whether to allow SIP Endpoints to register with the domain to receive calls.



870
871
872
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 870

def sip_registration
    @properties['sip_registration']
end

#subresource_uris ⇒ Hash

Returns A list of mapping resources associated with the SIP Domain resource identified by their relative URIs.

Returns:

  • (Hash) —

    A list of mapping resources associated with the SIP Domain resource identified by their relative URIs.



864
865
866
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 864

def subresource_uris
    @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



986
987
988
989
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 986

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

#update(friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset, sip_registration: :unset, domain_name: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset) ⇒ DomainInstance

Update the DomainInstance

Parameters:

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

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

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

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

  • 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_method (String) (defaults to: :unset) —

    The HTTP method we should use to call voice_url

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

    The HTTP method we should use to call voice_status_callback_url. Can be: GET or POST.

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

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

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

    The URL we should call when the domain receives a call.

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

    Whether to allow SIP Endpoints to register with the domain to receive calls. Can be true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.

  • 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 sip.twilio.com.

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

    Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.

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

    Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.

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

    The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.

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

    Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.

Returns:



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 930

def update(
    friendly_name: :unset, 
    voice_fallback_method: :unset, 
    voice_fallback_url: :unset, 
    voice_method: :unset, 
    voice_status_callback_method: :unset, 
    voice_status_callback_url: :unset, 
    voice_url: :unset, 
    sip_registration: :unset, 
    domain_name: :unset, 
    emergency_calling_enabled: :unset, 
    secure: :unset, 
    byoc_trunk_sid: :unset, 
    emergency_caller_sid: :unset
)

    context.update(
        friendly_name: friendly_name, 
        voice_fallback_method: voice_fallback_method, 
        voice_fallback_url: voice_fallback_url, 
        voice_method: voice_method, 
        voice_status_callback_method: voice_status_callback_method, 
        voice_status_callback_url: voice_status_callback_url, 
        voice_url: voice_url, 
        sip_registration: sip_registration, 
        domain_name: domain_name, 
        emergency_calling_enabled: emergency_calling_enabled, 
        secure: secure, 
        byoc_trunk_sid: byoc_trunk_sid, 
        emergency_caller_sid: emergency_caller_sid, 
    )
end

#uri ⇒ String

Returns The URI of the resource, relative to https://api.twilio.com.

Returns:

  • (String) —

    The URI of the resource, relative to https://api.twilio.com.



822
823
824
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 822

def uri
    @properties['uri']
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.



828
829
830
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 828

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.



834
835
836
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 834

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.



840
841
842
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 840

def voice_method
    @properties['voice_method']
end

#voice_status_callback_method ⇒ String

Returns The HTTP method we use to call voice_status_callback_url. Either GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call voice_status_callback_url. Either GET or POST.



846
847
848
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 846

def voice_status_callback_method
    @properties['voice_status_callback_method']
end

#voice_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.



852
853
854
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 852

def voice_status_callback_url
    @properties['voice_status_callback_url']
end

#voice_url ⇒ String

Returns The URL we call using the voice_method when the domain receives a call.

Returns:

  • (String) —

    The URL we call using the voice_method when the domain receives a call.



858
859
860
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 858

def voice_url
    @properties['voice_url']
end