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) —

    A 34 character string that uniquely identifies this resource.

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

    The Twilio-provided string that uniquely identifies the SipDomain resource to fetch.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 383

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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



429
430
431
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 429

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



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

def api_version
  @properties['api_version']
end

#auth ⇒ auth

Access the auth

Returns:



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

def auth
  context.auth
end

#auth_type ⇒ String

Returns The types of authentication mapped to the domain.

Returns:

  • (String) —

    The types of authentication mapped to the domain



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

def auth_type
  @properties['auth_type']
end

#byoc_trunk_sid ⇒ String

Returns The SID of the BYOC Trunk resource.

Returns:

  • (String) —

    The SID of the BYOC Trunk resource.



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

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:



420
421
422
423
424
425
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 420

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:



627
628
629
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 627

def credential_list_mappings
  context.credential_list_mappings
end

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DomainInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



613
614
615
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 613

def delete
  context.delete
end

#domain_name ⇒ String

Returns The unique address on Twilio to route SIP traffic.

Returns:

  • (String) —

    The unique address on Twilio to route SIP traffic



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

def domain_name
  @properties['domain_name']
end

#emergency_caller_sid ⇒ String

Returns Whether an emergency caller sid is configured for the domain.

Returns:

  • (String) —

    Whether an emergency caller sid is configured for the domain.



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

def emergency_caller_sid
  @properties['emergency_caller_sid']
end

#emergency_calling_enabled ⇒ Boolean

Returns Whether emergency calling is enabled for the domain.

Returns:

  • (Boolean) —

    Whether emergency calling is enabled for the domain.



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

def emergency_calling_enabled
  @properties['emergency_calling_enabled']
end

#fetch ⇒ DomainInstance

Fetch the DomainInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



620
621
622
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 620

def ip_access_control_list_mappings
  context.ip_access_control_list_mappings
end

#secure ⇒ Boolean

Returns Whether secure SIP is enabled for the domain.

Returns:

  • (Boolean) —

    Whether secure SIP is enabled for the domain



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

def secure
  @properties['secure']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#sip_registration ⇒ Boolean

Returns Whether SIP registration is allowed.

Returns:

  • (Boolean) —

    Whether SIP registration is allowed



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

def sip_registration
  @properties['sip_registration']
end

#subresource_uris ⇒ String

Returns A list mapping resources associated with the SIP Domain resource.

Returns:

  • (String) —

    A list mapping resources associated with the SIP Domain resource



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 “-”.

  • 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:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 592

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`



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

def uri
  @properties['uri']
end

#voice_fallback_method ⇒ String

Returns The HTTP method used with voice_fallback_url.

Returns:

  • (String) —

    The HTTP method used with voice_fallback_url



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

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The URL we call when an error occurs while executing TwiML.

Returns:

  • (String) —

    The URL we call when an error occurs while executing TwiML



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

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method to use with voice_url.

Returns:

  • (String) —

    The HTTP method to use with voice_url



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

def voice_method
  @properties['voice_method']
end

#voice_status_callback_method ⇒ String

Returns The HTTP method we use to call voice_status_callback_url.

Returns:

  • (String) —

    The HTTP method we use to call voice_status_callback_url



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

def voice_status_callback_method
  @properties['voice_status_callback_method']
end

#voice_status_callback_url ⇒ String

Returns The URL that we call with status updates.

Returns:

  • (String) —

    The URL that we call with status updates



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

def voice_status_callback_url
  @properties['voice_status_callback_url']
end

#voice_url ⇒ String

Returns The URL we call when receiving a call.

Returns:

  • (String) —

    The URL we call when receiving a call



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

def voice_url
  @properties['voice_url']
end