Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnContext::AssignedAddOnExtensionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, resource_sid: nil, assigned_add_on_sid: nil, sid: nil) ⇒ AssignedAddOnExtensionInstance

Initialize the AssignedAddOnExtensionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique id of the Account that has installed this Add-on.

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

    The unique id of the Phone Number to which the Add-on is assigned.

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

    A 34 character string that uniquely identifies the assigned Add-on installation.

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

    The Extension Sid that uniquely identifies this resource



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 241

def initialize(version, payload, account_sid: nil, resource_sid: nil, assigned_add_on_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'resource_sid' => payload['resource_sid'],
      'assigned_add_on_sid' => payload['assigned_add_on_sid'],
      'friendly_name' => payload['friendly_name'],
      'product_name' => payload['product_name'],
      'unique_name' => payload['unique_name'],
      'uri' => payload['uri'],
      'enabled' => payload['enabled'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The Account id that has installed this Add-on.

Returns:

  • (String) —

    The Account id that has installed this Add-on



292
293
294
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 292

def 
  @properties['account_sid']
end

#assigned_add_on_sid ⇒ String

Returns A string that uniquely identifies the assigned Add-on installation.

Returns:

  • (String) —

    A string that uniquely identifies the assigned Add-on installation



304
305
306
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 304

def assigned_add_on_sid
  @properties['assigned_add_on_sid']
end

#context ⇒ AssignedAddOnExtensionContext

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

Returns:



271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 271

def context
  unless @instance_context
    @instance_context = AssignedAddOnExtensionContext.new(
        @version,
        @params['account_sid'],
        @params['resource_sid'],
        @params['assigned_add_on_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#enabled ⇒ Boolean

Returns A Boolean indicating if the Extension will be invoked.

Returns:

  • (Boolean) —

    A Boolean indicating if the Extension will be invoked



334
335
336
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 334

def enabled
  @properties['enabled']
end

#fetch ⇒ AssignedAddOnExtensionInstance

Fetch a AssignedAddOnExtensionInstance

Returns:



341
342
343
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 341

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



310
311
312
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 310

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



354
355
356
357
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 354

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.AssignedAddOnExtensionInstance #{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



316
317
318
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 316

def product_name
  @properties['product_name']
end

#resource_sid ⇒ String

Returns The Phone Number id that has installed this Add-on.

Returns:

  • (String) —

    The Phone Number id that has installed this Add-on



298
299
300
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 298

def resource_sid
  @properties['resource_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Extension.

Returns:

  • (String) —

    A string that uniquely identifies this Extension



286
287
288
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 286

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



347
348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 347

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

#unique_name ⇒ String

Returns The string that uniquely identifies this Extension.

Returns:

  • (String) —

    The string that uniquely identifies this Extension



322
323
324
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 322

def unique_name
  @properties['unique_name']
end

#uri ⇒ String

Returns The uri.

Returns:

  • (String) —

    The uri



328
329
330
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 328

def uri
  @properties['uri']
end