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 available_add_on_sid

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

    The Extension Sid that uniquely identifies this resource



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

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 available_add_on_sid.

Returns:

  • (String) —

    The available_add_on_sid



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

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:



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

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:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human-readable description of this Extension.

Returns:

  • (String) —

    A human-readable description of this Extension



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



301
302
303
304
 
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 301

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

#product_name ⇒ String

Returns A human-readable description of the Extension’s Product.

Returns:

  • (String) —

    A human-readable description of the Extension’s Product



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

def product_name
  @properties['product_name']
end

#sid ⇒ String

Returns A string that uniquely identifies this Extension.

Returns:

  • (String) —

    A string that uniquely identifies this Extension



251
252
253
 
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 251

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns The string that uniquely identifies this Extension.

Returns:

  • (String) —

    The string that uniquely identifies this Extension



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

def unique_name
  @properties['unique_name']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end