Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, resource_sid: nil, sid: nil) ⇒ AssignedAddOnInstance

Initialize the AssignedAddOnInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Account that created this AssignedAddOn resource.

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

    The SID of the Call resource to fetch.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 496

def initialize(version, payload , account_sid: nil, resource_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'resource_sid' => payload['resource_sid'],
        'friendly_name' => payload['friendly_name'],
        'description' => payload['description'],
        'configuration' => payload['configuration'],
        'unique_name' => payload['unique_name'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'uri' => payload['uri'],
        'subresource_uris' => payload['subresource_uris'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the resource.

Returns:



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

def 
    @properties['account_sid']
end

#configuration ⇒ Hash

Returns A JSON string that represents the current configuration of this Add-on installation.

Returns:

  • (Hash) —

    A JSON string that represents the current configuration of this Add-on installation.



563
564
565
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 563

def configuration
    @properties['configuration']
end

#context ⇒ AssignedAddOnContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



524
525
526
527
528
529
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 524

def context
    unless @instance_context
        @instance_context = AssignedAddOnContext.new(@version , @params['account_sid'], @params['resource_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



575
576
577
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 575

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



581
582
583
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 581

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AssignedAddOnInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



600
601
602
603
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 600

def delete

    context.delete
end

#description ⇒ String

Returns A short description of the functionality that the Add-on provides.

Returns:

  • (String) —

    A short description of the functionality that the Add-on provides.



557
558
559
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 557

def description
    @properties['description']
end

#extensions ⇒ extensions

Access the extensions

Returns:



616
617
618
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 616

def extensions
    context.extensions
end

#fetch ⇒ AssignedAddOnInstance

Fetch the AssignedAddOnInstance

Returns:



608
609
610
611
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 608

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.



551
552
553
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 551

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



629
630
631
632
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 629

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

#resource_sid ⇒ String

Returns The SID of the Phone Number to which the Add-on is assigned.

Returns:

  • (String) —

    The SID of the Phone Number to which the Add-on is assigned.



545
546
547
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 545

def resource_sid
    @properties['resource_sid']
end

#sid ⇒ String

Returns The unique string that that we created to identify the resource.

Returns:

  • (String) —

    The unique string that that we created to identify the resource.



533
534
535
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 533

def sid
    @properties['sid']
end

#subresource_uris ⇒ Hash

Returns A list of related resources identified by their relative URIs.

Returns:

  • (Hash) —

    A list of related resources identified by their relative URIs.



593
594
595
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 593

def subresource_uris
    @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



622
623
624
625
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 622

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s sid in the URL to address the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s sid in the URL to address the resource.



569
570
571
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 569

def unique_name
    @properties['unique_name']
end

#uri ⇒ String

Returns The URI of the resource, relative to https://api.twilio.com.

Returns:

  • (String) —

    The URI of the resource, relative to https://api.twilio.com.



587
588
589
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 587

def uri
    @properties['uri']
end