Class: Twilio::REST::Preview::Marketplace::InstalledAddOnInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Preview::Marketplace::InstalledAddOnInstance

Defined in:

lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

Instance Method Summary

• #account_sid ⇒ String

  The Account id that has installed this Add-on.

• #configuration ⇒ Hash

  The JSON object representing the current configuration.

• #context ⇒ InstalledAddOnContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The date this Add-on installation was created.

• #date_updated ⇒ Time

  The date this Add-on installation was last updated.

• #delete ⇒ Boolean

  Deletes the InstalledAddOnInstance.

• #description ⇒ String

  A short description of the Add-on functionality.

• #extensions ⇒ extensions

  Access the extensions.

• #fetch ⇒ InstalledAddOnInstance

  Fetch a InstalledAddOnInstance.

• #friendly_name ⇒ String

  A description of this Add-on installation.

• #initialize(version, payload, sid: nil) ⇒ InstalledAddOnInstance constructor

  Initialize the InstalledAddOnInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  A dictionary of URLs for related resource.

• #sid ⇒ String

  A string that uniquely identifies this Add-on installation.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #unique_name ⇒ String

  The string that uniquely identifies this Add-on installation.

• #update(configuration: :unset, unique_name: :unset) ⇒ InstalledAddOnInstance

  Update the InstalledAddOnInstance.

• #url ⇒ String

  The url.

Constructor Details

#initialize(version, payload, sid: nil) ⇒ InstalledAddOnInstance

Initialize the InstalledAddOnInstance

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 278

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'description' => payload['description'],
      'configuration' => payload['configuration'],
      'unique_name' => payload['unique_name'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 319

def account_sid
  @properties['account_sid']
end

#configuration ⇒ Hash

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 337

def configuration
  @properties['configuration']
end

#context ⇒ InstalledAddOnContext

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

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 304

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 349

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 355

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InstalledAddOnInstance

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 374

def delete
  context.delete
end

#description ⇒ String

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 331

def description
  @properties['description']
end

#extensions ⇒ extensions

Access the extensions

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 400

def extensions
  context.extensions
end

#fetch ⇒ InstalledAddOnInstance

Fetch a InstalledAddOnInstance

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 381

def fetch
  context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 325

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 413

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

#links ⇒ String

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 367

def links
  @properties['links']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 313

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 406

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

#unique_name ⇒ String

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 343

def unique_name
  @properties['unique_name']
end

#update(configuration: :unset, unique_name: :unset) ⇒ InstalledAddOnInstance

Update the InstalledAddOnInstance

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 393

def update(configuration: :unset, unique_name: :unset)
  context.update(configuration: configuration, unique_name: unique_name, )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 361

def url
  @properties['url']
end