Class: Twilio::REST::Numbers::V1::PortingPortabilityInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/numbers/v1/porting_portability.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, phone_number: nil) ⇒ PortingPortabilityInstance

Initialize the PortingPortabilityInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this PortingPortability resource.

  • sid (String) —

    The SID of the Call resource to fetch.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 284

def initialize(version, payload , phone_number: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'phone_number' => payload['phone_number'],
        'account_sid' => payload['account_sid'],
        'portable' => payload['portable'],
        'pin_and_account_number_required' => payload['pin_and_account_number_required'],
        'not_portable_reason' => payload['not_portable_reason'],
        'not_portable_reason_code' => payload['not_portable_reason_code'] == nil ? payload['not_portable_reason_code'] : payload['not_portable_reason_code'].to_i,
        'number_type' => payload['number_type'],
        'country' => payload['country'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.

Returns:

  • (String) —

    Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.



325
326
327
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 325

def 
    @properties['account_sid']
end

#context ⇒ PortingPortabilityContext

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

Returns:



310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 310

def context
    unless @instance_context
        @instance_context = PortingPortabilityContext.new(@version , @params['phone_number'])
    end
    @instance_context
end

#country ⇒ String

Returns Country the phone number belongs to.

Returns:

  • (String) —

    Country the phone number belongs to.



361
362
363
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 361

def country
    @properties['country']
end

#fetch(target_account_sid: :unset, address_sid: :unset) ⇒ PortingPortabilityInstance

Fetch the PortingPortabilityInstance

Parameters:

  • target_account_sid (String) (defaults to: :unset) —

    Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.

  • address_sid (String) (defaults to: :unset) —

    Address Sid of customer to which the number will be ported.

Returns:



376
377
378
379
380
381
382
383
384
385
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 376

def fetch(
    target_account_sid: :unset, 
    address_sid: :unset
)

    context.fetch(
        target_account_sid: , 
        address_sid: address_sid, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



396
397
398
399
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 396

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

#not_portable_reason ⇒ String

Returns Reason why the phone number cannot be ported into Twilio, null otherwise.

Returns:

  • (String) —

    Reason why the phone number cannot be ported into Twilio, null otherwise.



343
344
345
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 343

def not_portable_reason
    @properties['not_portable_reason']
end

#not_portable_reason_code ⇒ String

Returns The Portability Reason Code for the phone number if it cannot be ported into Twilio, null otherwise.

Returns:

  • (String) —

    The Portability Reason Code for the phone number if it cannot be ported into Twilio, null otherwise.



349
350
351
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 349

def not_portable_reason_code
    @properties['not_portable_reason_code']
end

#number_type ⇒ NumberType

Returns:

  • (NumberType) 


355
356
357
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 355

def number_type
    @properties['number_type']
end

#phone_number ⇒ String

Returns The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).

Returns:

  • (String) —

    The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).



319
320
321
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 319

def phone_number
    @properties['phone_number']
end

#pin_and_account_number_required ⇒ Boolean

Returns Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.

Returns:

  • (Boolean) —

    Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.



337
338
339
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 337

def 
    @properties['pin_and_account_number_required']
end

#portable ⇒ Boolean

Returns Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.

Returns:

  • (Boolean) —

    Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.



331
332
333
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 331

def portable
    @properties['portable']
end

#to_s ⇒ Object

Provide a user friendly representation



389
390
391
392
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 389

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

#url ⇒ String

Returns This is the url of the request that you’re trying to reach out to locate the resource.

Returns:

  • (String) —

    This is the url of the request that you’re trying to reach out to locate the resource.



367
368
369
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 367

def url
    @properties['url']
end