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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 209

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_sidString

Returns The available_add_on_sid.

Returns:

  • (String)

    The available_add_on_sid



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

def available_add_on_sid
  @properties['available_add_on_sid']
end

#contextAvailableAddOnExtensionContext

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

Returns:



231
232
233
234
235
236
237
238
239
240
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 231

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

#fetchAvailableAddOnExtensionInstance

Fetch a AvailableAddOnExtensionInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_nameString

Returns A human-readable description of this Extension.

Returns:

  • (String)

    A human-readable description of this Extension



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, 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 inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Preview.Marketplace.AvailableAddOnExtensionInstance #{values}>"
end

#product_nameString

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

Returns:

  • (String)

    A human-readable description of the Extension’s Product



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

def product_name
  @properties['product_name']
end

#sidString

Returns A string that uniquely identifies this Extension.

Returns:

  • (String)

    A string that uniquely identifies this Extension



244
245
246
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 244

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation



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

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

#unique_nameString

Returns The string that uniquely identifies this Extension.

Returns:

  • (String)

    The string that uniquely identifies this Extension



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

def unique_name
  @properties['unique_name']
end

#urlString

Returns The url.

Returns:

  • (String)

    The url



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

def url
  @properties['url']
end