Class: Twilio::REST::Marketplace::V1::AvailableAddOnInstance

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

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

  • account_sid (String) —

    The SID of the Account that created this AvailableAddOn resource.

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

    The SID of the Call resource to fetch.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 238

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.



294
295
296
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 294

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:



261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 261

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.



282
283
284
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 282

def description
    @properties['description']
end

#extensions ⇒ extensions

Access the extensions

Returns:



321
322
323
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 321

def extensions
    context.extensions
end

#fetch ⇒ AvailableAddOnInstance

Fetch the AvailableAddOnInstance

Returns:



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

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.



276
277
278
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 276

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

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.



288
289
290
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 288

def pricing_type
    @properties['pricing_type']
end

#sid ⇒ String

Returns The unique string that we created to identify the AvailableAddOn resource.

Returns:

  • (String) —

    The unique string that we created to identify the AvailableAddOn resource.



270
271
272
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 270

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



327
328
329
330
 
# File 'lib/twilio-ruby/rest/marketplace/v1/available_add_on.rb', line 327

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end