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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 236

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



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

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



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

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:



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 266

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



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

def enabled
  @properties['enabled']
end

#fetch ⇒ AssignedAddOnExtensionInstance

Fetch a AssignedAddOnExtensionInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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



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

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



281
282
283
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 281

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def unique_name
  @properties['unique_name']
end

#uri ⇒ String

Returns The uri.

Returns:

  • (String) —

    The uri



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

def uri
  @properties['uri']
end