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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 336

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



378
379
380
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 378

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



384
385
386
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 384

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



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

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:



369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 369

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DomainInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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



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

def domain_name
  @properties['domain_name']
end

#fetch ⇒ DomainInstance

Fetch a DomainInstance

Returns:



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

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.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



522
523
524
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 522

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



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

def sid
  @properties['sid']
end

#sip_registration ⇒ Boolean

Returns If SIP registration is allowed.

Returns:

  • (Boolean) —

    If SIP registration is allowed



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

def sip_registration
  @properties['sip_registration']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 498

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



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

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



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

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



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

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



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

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.



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

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



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

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



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

def voice_url
  @properties['voice_url']
end