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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 353

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

Returns:

  • (String) —

    The unique id of the account that sent the call



395
396
397
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 395

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The Twilio API version used to process the call.

Returns:

  • (String) —

    The Twilio API version used to process the call



401
402
403
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 401

def api_version
  @properties['api_version']
end

#auth ⇒ auth

Access the auth

Returns:



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

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



407
408
409
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 407

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:



386
387
388
389
390
391
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 386

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:



546
547
548
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 546

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



413
414
415
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 413

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DomainInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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



425
426
427
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 425

def domain_name
  @properties['domain_name']
end

#fetch ⇒ DomainInstance

Fetch a DomainInstance

Returns:



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

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.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



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

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



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

def sid
  @properties['sid']
end

#sip_registration ⇒ Boolean

Returns If SIP registration is allowed.

Returns:

  • (Boolean) —

    If SIP registration is allowed



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

def sip_registration
  @properties['sip_registration']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 515

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



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

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



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

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



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

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



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

def voice_method
  @properties['voice_method']
end

#voice_status_callback_method ⇒ String

Returns The HTTP method Twilio will use to make requests to the StatusCallback URL.

Returns:

  • (String) —

    The HTTP method Twilio will use to make requests to the StatusCallback URL.



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

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



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

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



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

def voice_url
  @properties['voice_url']
end