Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.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, sid: nil) ⇒ AssignedAddOnInstance

Initialize the AssignedAddOnInstance

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.

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

    The Installed Add-on Sid that uniquely identifies the assignment



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 281

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'resource_sid' => payload['resource_sid'],
      'friendly_name' => payload['friendly_name'],
      'description' => payload['description'],
      'configuration' => payload['configuration'],
      'unique_name' => payload['unique_name'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'uri' => payload['uri'],
      'subresource_uris' => payload['subresource_uris'],
  }

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'resource_sid' => resource_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



332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 332

def 
  @properties['account_sid']
end

#configuration ⇒ Hash

Returns The JSON object representing the current configuration.

Returns:

  • (Hash) —

    The JSON object representing the current configuration



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

def configuration
  @properties['configuration']
end

#context ⇒ AssignedAddOnContext

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

Returns:



312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 312

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

#date_created ⇒ Time

Returns The date this Add-on was installed.

Returns:

  • (Time) —

    The date this Add-on was installed



368
369
370
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 368

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Add-on installation was last updated.

Returns:

  • (Time) —

    The date this Add-on installation was last updated



374
375
376
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 374

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AssignedAddOnInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



400
401
402
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 400

def delete
  context.delete
end

#description ⇒ String

Returns A short description of the Add-on functionality.

Returns:

  • (String) —

    A short description of the Add-on functionality



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

def description
  @properties['description']
end

#extensions ⇒ extensions

Access the extensions

Returns:



407
408
409
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 407

def extensions
  context.extensions
end

#fetch ⇒ AssignedAddOnInstance

Fetch a AssignedAddOnInstance

Returns:



393
394
395
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 393

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A description of this Add-on installation.

Returns:

  • (String) —

    A description of this Add-on installation



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



420
421
422
423
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 420

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



338
339
340
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 338

def resource_sid
  @properties['resource_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

    A string that uniquely identifies this assigned Add-on installation



326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 326

def sid
  @properties['sid']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



386
387
388
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 386

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



413
414
415
416
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 413

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

#unique_name ⇒ String

Returns The string that uniquely identifies this Add-on installation.

Returns:

  • (String) —

    The string that uniquely identifies this Add-on installation



362
363
364
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 362

def unique_name
  @properties['unique_name']
end

#uri ⇒ String

Returns The uri.

Returns:

  • (String) —

    The uri



380
381
382
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 380

def uri
  @properties['uri']
end