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.



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 395

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:



441
442
443
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 441

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.



447
448
449
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 447

def api_version
    @properties['api_version']
end

#auth ⇒ auth

Access the auth

Returns:



633
634
635
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 633

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.



453
454
455
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 453

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.



555
556
557
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 555

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:



432
433
434
435
436
437
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 432

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:



647
648
649
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 647

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:



459
460
461
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 459

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:



465
466
467
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 465

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DomainInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



568
569
570
571
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 568

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



471
472
473
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 471

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.



561
562
563
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 561

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.



543
544
545
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 543

def emergency_calling_enabled
    @properties['emergency_calling_enabled']
end

#fetch ⇒ DomainInstance

Fetch the DomainInstance

Returns:



576
577
578
579
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 576

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.



477
478
479
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 477

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



660
661
662
663
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 660

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:



640
641
642
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 640

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.



549
550
551
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 549

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.



483
484
485
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 483

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.



537
538
539
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 537

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.



531
532
533
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 531

def subresource_uris
    @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



653
654
655
656
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 653

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:



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 597

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 ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`.



489
490
491
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 489

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



495
496
497
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 495

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



501
502
503
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 501

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



507
508
509
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 507

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



513
514
515
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 513

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.



519
520
521
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 519

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.



525
526
527
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 525

def voice_url
    @properties['voice_url']
end