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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 327

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



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

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



375
376
377
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 375

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



381
382
383
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 381

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:



360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 360

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DomainInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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



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

def domain_name
  @properties['domain_name']
end

#fetch ⇒ DomainInstance

Fetch a DomainInstance

Returns:



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

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.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



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

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



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

def sid
  @properties['sid']
end

#sip_registration ⇒ Boolean

Returns If SIP registration is allowed.

Returns:

  • (Boolean) —

    If SIP registration is allowed



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

def sip_registration
  @properties['sip_registration']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 489

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



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

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



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

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



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

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



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

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



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

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



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

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



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

def voice_url
  @properties['voice_url']
end