Class: Twilio::REST::Marketplace::V1::InstalledAddOnInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb

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

  • account_sid (String) —

    The SID of the Account that created this InstalledAddOn resource.

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

    The SID of the Call resource to fetch.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 308

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](www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource.

Returns:



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

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.



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

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:



334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 334

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the InstalledAddOnInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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.



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

def description
    @properties['description']
end

#extensions ⇒ extensions

Access the extensions

Returns:



443
444
445
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 443

def extensions
    context.extensions
end

#fetch ⇒ InstalledAddOnInstance

Fetch the InstalledAddOnInstance

Returns:



412
413
414
415
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 412

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



456
457
458
459
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 456

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the ‘Available Add-on Sid’.

Returns:

  • (String) —

    The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the ‘Available Add-on Sid’.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



449
450
451
452
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 449

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Marketplace.V1.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.



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

def unique_name
    @properties['unique_name']
end

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

Update the InstalledAddOnInstance

Parameters:

  • configuration (Object) (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:



422
423
424
425
426
427
428
429
430
431
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 422

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.



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

def url
    @properties['url']
end

#usage ⇒ usage

Access the usage

Returns:



436
437
438
 
# File 'lib/twilio-ruby/rest/marketplace/v1/installed_add_on.rb', line 436

def usage
    context.usage
end