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.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb', line 224

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_schema ⇒ Hash

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



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

def configuration_schema
  @properties['configuration_schema']
end

#context ⇒ AvailableAddOnContext

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

Returns:



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

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

#description ⇒ String

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

Returns:

  • (String) —

    A short description of the Add-on’s functionality



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

def description
  @properties['description']
end

#extensions ⇒ extensions

Access the extensions

Returns:



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

def extensions
  context.extensions
end

#fetch ⇒ AvailableAddOnInstance

Fetch a AvailableAddOnInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



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

def links
  @properties['links']
end

#pricing_type ⇒ String

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

Returns:

  • (String) —

    How customers are charged for using this Add-on



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

def pricing_type
  @properties['pricing_type']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

def url
  @properties['url']
end