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 SID of the InstalledAddOn resource to fetch.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 282

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#configuration ⇒ Hash

Returns The JSON object that represents the current configuration of installed Add-on.

Returns:

  • (Hash) —

    The JSON object that represents the current configuration of installed Add-on



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

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:



308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 308

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InstalledAddOnInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#description ⇒ String

Returns A short description of the Add-on’s functionality.

Returns:

  • (String) —

    A short description of the Add-on’s functionality



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

def description
  @properties['description']
end

#extensions ⇒ extensions

Access the extensions

Returns:



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

def extensions
  context.extensions
end

#fetch ⇒ InstalledAddOnInstance

Fetch a InstalledAddOnInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



417
418
419
420
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 417

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



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

def links
  @properties['links']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



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

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 AvailableAddOn resource. This is only required by Add-ons that need to be configured

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

    An application-defined string that uniquely identifies the resource. This value must be unique within the Account.

Returns:



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

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

def url
  @properties['url']
end