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.


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 265

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#configurationHash

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


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

def configuration
  @properties['configuration']
end

#contextInstalledAddOnContext

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

Returns:


291
292
293
294
295
296
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 291

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

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the InstalledAddOnInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#descriptionString

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

Returns:

  • (String)

    A short description of the Add-on's functionality


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

def description
  @properties['description']
end

#extensionsextensions

Access the extensions

Returns:


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

def extensions
  context.extensions
end

#fetchInstalledAddOnInstance

Fetch the InstalledAddOnInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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

#unique_nameString

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

Returns:

  • (String)

    An application-defined string that uniquely identifies the resource


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

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:


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

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end