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.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 132

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'],
        'messaging_carrier' => payload['messaging_carrier'],
        'voice_carrier' => payload['voice_carrier'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The target account sid to which the number will be ported.

Returns:

  • (String) —

    The target account sid to which the number will be ported



174
175
176
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 174

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:



159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 159

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.



210
211
212
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 210

def country
    @properties['country']
end

#fetch(target_account_sid: :unset) ⇒ PortingPortabilityInstance

Fetch the PortingPortabilityInstance

Parameters:

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

    The SID of the account where the phone number(s) will be ported.

Returns:



236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 236

def fetch(
    target_account_sid: :unset
)

    context.fetch(
        target_account_sid: , 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



254
255
256
257
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 254

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

#messaging_carrier ⇒ String

Returns Current messaging carrier of the phone number.

Returns:

  • (String) —

    Current messaging carrier of the phone number



216
217
218
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 216

def messaging_carrier
    @properties['messaging_carrier']
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.



192
193
194
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 192

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. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`.

Returns:

  • (String) —

    The Portability Reason Code for the phone number if it cannot be ported into Twilio, ‘null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`.



198
199
200
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 198

def not_portable_reason_code
    @properties['not_portable_reason_code']
end

#number_type ⇒ NumberType

Returns:

  • (NumberType) 


204
205
206
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 204

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).



168
169
170
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 168

def phone_number
    @properties['phone_number']
end

#pin_and_account_number_required ⇒ Boolean

Returns Boolean flag specifying if PIN and account number is required for the phone number.

Returns:

  • (Boolean) —

    Boolean flag specifying if PIN and account number is required for the phone number.



186
187
188
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 186

def 
    @properties['pin_and_account_number_required']
end

#portable ⇒ Boolean

Returns Boolean flag specifying if phone number is portable or not.

Returns:

  • (Boolean) —

    Boolean flag specifying if phone number is portable or not.



180
181
182
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 180

def portable
    @properties['portable']
end

#to_s ⇒ Object

Provide a user friendly representation



247
248
249
250
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 247

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.



228
229
230
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 228

def url
    @properties['url']
end

#voice_carrier ⇒ String

Returns Current voice carrier of the phone number.

Returns:

  • (String) —

    Current voice carrier of the phone number



222
223
224
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_portability.rb', line 222

def voice_carrier
    @properties['voice_carrier']
end