Class: Twilio::REST::Preview::Marketplace::AvailableAddOnInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/marketplace/available_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) ⇒ AvailableAddOnInstance

Initialize the AvailableAddOnInstance

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 AvailableAddOn resource to fetch.


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 216

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'friendly_name' => payload['friendly_name'],
      'description' => payload['description'],
      'pricing_type' => payload['pricing_type'],
      'configuration_schema' => payload['configuration_schema'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#configuration_schemaHash

Returns The JSON object with the configuration that must be provided when installing a given Add-on.

Returns:

  • (Hash)

    The JSON object with the configuration that must be provided when installing a given Add-on


272
273
274
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 272

def configuration_schema
  @properties['configuration_schema']
end

#contextAvailableAddOnContext

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

Returns:


239
240
241
242
243
244
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 239

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

#descriptionString

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

Returns:

  • (String)

    A short description of the Add-on's functionality


260
261
262
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 260

def description
  @properties['description']
end

#extensionsextensions

Access the extensions

Returns:


298
299
300
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 298

def extensions
  context.extensions
end

#fetchAvailableAddOnInstance

Fetch the AvailableAddOnInstance

Returns:


291
292
293
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 291

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


254
255
256
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 254

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


284
285
286
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 284

def links
  @properties['links']
end

#pricing_typeString

Returns How customers are charged for using this Add-on.

Returns:

  • (String)

    How customers are charged for using this Add-on


266
267
268
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 266

def pricing_type
  @properties['pricing_type']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


248
249
250
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 248

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


304
305
306
307
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 304

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end