Class: Twilio::REST::Preview::Marketplace::InstalledAddOnContext::InstalledAddOnExtensionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_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, installed_add_on_sid: nil, sid: nil) ⇒ InstalledAddOnExtensionInstance

Initialize the InstalledAddOnExtensionInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • installed_add_on_sid (String) (defaults to: nil)

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

  • sid (String) (defaults to: nil)

    The SID of the InstalledAddOn Extension resource to fetch.


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 228

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

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

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

Instance Method Details

#contextInstalledAddOnExtensionContext

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

Returns:


251
252
253
254
255
256
257
258
259
260
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 251

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

#enabledBoolean

Returns Whether the Extension will be invoked.

Returns:

  • (Boolean)

    Whether the Extension will be invoked


294
295
296
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 294

def enabled
  @properties['enabled']
end

#fetchInstalledAddOnExtensionInstance

Fetch the InstalledAddOnExtensionInstance

Returns:


307
308
309
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 307

def fetch
  context.fetch
end

#friendly_nameString

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/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 276

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


328
329
330
331
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 328

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

#installed_add_on_sidString

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

Returns:

  • (String)

    The SID of the InstalledAddOn resource to which this extension applies


270
271
272
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 270

def installed_add_on_sid
  @properties['installed_add_on_sid']
end

#product_nameString

Returns The name of the Extension's Product.

Returns:

  • (String)

    The name of the Extension's Product


282
283
284
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 282

def product_name
  @properties['product_name']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


264
265
266
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 264

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


321
322
323
324
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 321

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

#unique_nameString

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String)

    An application-defined string that uniquely identifies the resource


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

def unique_name
  @properties['unique_name']
end

#update(enabled: nil) ⇒ InstalledAddOnExtensionInstance

Update the InstalledAddOnExtensionInstance

Parameters:

  • enabled (Boolean) (defaults to: nil)

    Whether the Extension should be invoked.

Returns:


315
316
317
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 315

def update(enabled: nil)
  context.update(enabled: enabled, )
end

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


300
301
302
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 300

def url
  @properties['url']
end