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

Inherits:
InstanceResource
  • Object
show all
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 [email protected].

Instance Method Summary collapse

Constructor Details

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

Initialize the InstalledAddOnInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The Installed Add-on Sid that uniquely identifies this resource



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# 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

Returns The Account id that has installed this Add-on.

Returns:

  • (String) —

    The Account id that has installed this Add-on



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

def 
  @properties['account_sid']
end

#configuration ⇒ Hash

Returns The JSON object representing the current configuration.

Returns:

  • (Hash) —

    The JSON object representing the current configuration



337
338
339
 
# 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

Returns:



304
305
306
307
308
309
 
# 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

Returns The date this Add-on installation was created.

Returns:

  • (Time) —

    The date this Add-on installation was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Add-on installation was last updated.

Returns:

  • (Time) —

    The date this Add-on installation was last updated



355
356
357
 
# 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

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#description ⇒ String

Returns A short description of the Add-on functionality.

Returns:

  • (String) —

    A short description of the Add-on functionality



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

def description
  @properties['description']
end

#extensions ⇒ extensions

Access the extensions

Returns:



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

def extensions
  context.extensions
end

#fetch ⇒ InstalledAddOnInstance

Fetch a InstalledAddOnInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A description of this Add-on installation.

Returns:

  • (String) —

    A description of this Add-on installation



325
326
327
 
# 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



413
414
415
416
 
# 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

Returns A dictionary of URLs for related resource.

Returns:

  • (String) —

    A dictionary of URLs for related resource.



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

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Add-on installation.

Returns:

  • (String) —

    A string that uniquely identifies this Add-on installation



313
314
315
 
# 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



406
407
408
409
 
# 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

Returns The string that uniquely identifies this Add-on installation.

Returns:

  • (String) —

    The string that uniquely identifies this Add-on installation



343
344
345
 
# 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

Parameters:

  • configuration (Hash) (defaults to: :unset) —

    Valid JSON object that conform to the configuration schema exposed by the associated Available Add-on resource. This is only required by Add-ons that need to be configured

  • unique_name (String) (defaults to: :unset) —

    The human-readable string that uniquely identifies this Add-on installation for an Account.

Returns:



393
394
395
 
# 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

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end