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 domain sid that uniquely identifies the resource



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 367

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'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the account that sent the message.

Returns:

  • (String) —

    The unique id of the account that sent the message



416
417
418
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 416

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The Twilio API version used to process the message.

Returns:

  • (String) —

    The Twilio API version used to process the message



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

def api_version
  @properties['api_version']
end

#auth_type ⇒ String

Returns The types of authentication mapped to the domain.

Returns:

  • (String) —

    The types of authentication mapped to the domain



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

def auth_type
  @properties['auth_type']
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:



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 403

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:



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

def credential_list_mappings
  context.credential_list_mappings
end

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DomainInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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



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

def domain_name
  @properties['domain_name']
end

#fetch ⇒ DomainInstance

Fetch a DomainInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A user-specified, human-readable name for the trigger.

Returns:

  • (String) —

    A user-specified, human-readable name for the trigger.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



580
581
582
583
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 580

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:



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

def ip_access_control_list_mappings
  context.ip_access_control_list_mappings
end

#sid ⇒ String

Returns A string that uniquely identifies the SIP Domain.

Returns:

  • (String) —

    A string that uniquely identifies the SIP Domain



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

def sid
  @properties['sid']
end

#sip_registration ⇒ Boolean

Returns If SIP registration is allowed.

Returns:

  • (Boolean) —

    If SIP registration is allowed



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

def sip_registration
  @properties['sip_registration']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



573
574
575
576
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 573

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

#update(auth_type: :unset, 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) ⇒ DomainInstance

Update the DomainInstance

Parameters:

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

    The auth_type

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

    A user-specified, human-readable name for the trigger.

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

    The voice_fallback_method

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

    The voice_fallback_url

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

    The HTTP method to use with the voice_url

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

    The voice_status_callback_method

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

    The voice_status_callback_url

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

    The voice_url

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

    The sip_registration

Returns:



536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 536

def update(auth_type: :unset, 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)
  context.update(
      auth_type: auth_type,
      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,
  )
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end

#voice_fallback_method ⇒ String

Returns HTTP method used with voice_fallback_url.

Returns:

  • (String) —

    HTTP method used with voice_fallback_url



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

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns URL Twilio will request if an error occurs in executing TwiML.

Returns:

  • (String) —

    URL Twilio will request if an error occurs in executing TwiML



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

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns HTTP method to use with voice_url.

Returns:

  • (String) —

    HTTP method to use with voice_url



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

def voice_method
  @properties['voice_method']
end

#voice_status_callback_method ⇒ String

Returns The voice_status_callback_method.

Returns:

  • (String) —

    The voice_status_callback_method



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

def voice_status_callback_method
  @properties['voice_status_callback_method']
end

#voice_status_callback_url ⇒ String

Returns URL that Twilio will request with status updates.

Returns:

  • (String) —

    URL that Twilio will request with status updates



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

def voice_status_callback_url
  @properties['voice_status_callback_url']
end

#voice_url ⇒ String

Returns URL Twilio will request when receiving a call.

Returns:

  • (String) —

    URL Twilio will request when receiving a call



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

def voice_url
  @properties['voice_url']
end