Class: Twilio::REST::Preview::Marketplace::AvailableAddOnContext::AvailableAddOnExtensionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.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, available_add_on_sid: nil, sid: nil) ⇒ AvailableAddOnExtensionInstance

Initialize the AvailableAddOnExtensionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the AvailableAddOn resource to which this extension applies.

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

    The SID of the AvailableAddOn Extension resource to fetch.



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

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'available_add_on_sid' => payload['available_add_on_sid'],
      'friendly_name' => payload['friendly_name'],
      'product_name' => payload['product_name'],
      'unique_name' => payload['unique_name'],
      'url' => payload['url'],
  }

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

Instance Method Details

#available_add_on_sid ⇒ String

Returns The SID of the AvailableAddOn resource to which this extension applies.

Returns:

  • (String) —

    The SID of the AvailableAddOn resource to which this extension applies



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

def available_add_on_sid
  @properties['available_add_on_sid']
end

#context ⇒ AvailableAddOnExtensionContext

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

Returns:



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 241

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

#fetch ⇒ AvailableAddOnExtensionInstance

Fetch a AvailableAddOnExtensionInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#product_name ⇒ String

Returns The name of the Extension’s Product.

Returns:

  • (String) —

    The name of the Extension’s Product



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

def product_name
  @properties['product_name']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def unique_name
  @properties['unique_name']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

def url
  @properties['url']
end