Class: Twilio::REST::Lookups::V2::PhoneNumberInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/lookups/v2/phone_number.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the PhoneNumberInstance



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 179

def initialize(version, payload , phone_number: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'calling_country_code' => payload['calling_country_code'],
        'country_code' => payload['country_code'],
        'phone_number' => payload['phone_number'],
        'national_format' => payload['national_format'],
        'valid' => payload['valid'],
        'validation_errors' => payload['validation_errors'],
        'caller_name' => payload['caller_name'],
        'sim_swap' => payload['sim_swap'],
        'call_forwarding' => payload['call_forwarding'],
        'line_type_intelligence' => payload['line_type_intelligence'],
        'line_status' => payload['line_status'],
        'identity_match' => payload['identity_match'],
        'reassigned_number' => payload['reassigned_number'],
        'sms_pumping_risk' => payload['sms_pumping_risk'],
        'phone_number_quality_score' => payload['phone_number_quality_score'],
        'pre_fill' => payload['pre_fill'],
        'url' => payload['url'],
    }

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

Instance Method Details

#call_forwarding ⇒ CallForwardingInfo 



269
270
271
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 269

def call_forwarding
    @properties['call_forwarding']
end

#caller_name ⇒ CallerNameInfo 



257
258
259
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 257

def caller_name
    @properties['caller_name']
end

#calling_country_code ⇒ String 



221
222
223
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 221

def calling_country_code
    @properties['calling_country_code']
end

#context ⇒ PhoneNumberContext

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



212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 212

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

#country_code ⇒ String 



227
228
229
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 227

def country_code
    @properties['country_code']
end

#fetch(fields: :unset, country_code: :unset, first_name: :unset, last_name: :unset, address_line1: :unset, address_line2: :unset, city: :unset, state: :unset, postal_code: :unset, address_country_code: :unset, national_id: :unset, date_of_birth: :unset, last_verified_date: :unset, verification_sid: :unset, partner_sub_id: :unset) ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 339

def fetch(
    fields: :unset, 
    country_code: :unset, 
    first_name: :unset, 
    last_name: :unset, 
    address_line1: :unset, 
    address_line2: :unset, 
    city: :unset, 
    state: :unset, 
    postal_code: :unset, 
    address_country_code: :unset, 
    national_id: :unset, 
    date_of_birth: :unset, 
    last_verified_date: :unset, 
    verification_sid: :unset, 
    partner_sub_id: :unset
)

    context.fetch(
        fields: fields, 
        country_code: country_code, 
        first_name: first_name, 
        last_name: last_name, 
        address_line1: address_line1, 
        address_line2: address_line2, 
        city: city, 
        state: state, 
        postal_code: postal_code, 
        address_country_code: address_country_code, 
        national_id: national_id, 
        date_of_birth: date_of_birth, 
        last_verified_date: last_verified_date, 
        verification_sid: verification_sid, 
        partner_sub_id: partner_sub_id, 
    )
end

#identity_match ⇒ IdentityMatchInfo 



287
288
289
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 287

def identity_match
    @properties['identity_match']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



385
386
387
388
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 385

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

#line_status ⇒ LineStatusInfo 



281
282
283
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 281

def line_status
    @properties['line_status']
end

#line_type_intelligence ⇒ LineTypeIntelligenceInfo 



275
276
277
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 275

def line_type_intelligence
    @properties['line_type_intelligence']
end

#national_format ⇒ String 



239
240
241
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 239

def national_format
    @properties['national_format']
end

#phone_number ⇒ String 



233
234
235
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 233

def phone_number
    @properties['phone_number']
end

#phone_number_quality_score ⇒ Hash 



305
306
307
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 305

def phone_number_quality_score
    @properties['phone_number_quality_score']
end

#pre_fill ⇒ Hash 



311
312
313
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 311

def pre_fill
    @properties['pre_fill']
end

#reassigned_number ⇒ ReassignedNumberInfo 



293
294
295
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 293

def reassigned_number
    @properties['reassigned_number']
end

#sim_swap ⇒ SimSwapInfo 



263
264
265
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 263

def sim_swap
    @properties['sim_swap']
end

#sms_pumping_risk ⇒ SmsPumpingRiskInfo 



299
300
301
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 299

def sms_pumping_risk
    @properties['sms_pumping_risk']
end

#to_s ⇒ Object

Provide a user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 378

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

#url ⇒ String 



317
318
319
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 317

def url
    @properties['url']
end

#valid ⇒ Boolean 



245
246
247
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 245

def valid
    @properties['valid']
end

#validation_errors ⇒ Array<ValidationError> 



251
252
253
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 251

def validation_errors
    @properties['validation_errors']
end