Class: Twilio::REST::Verify::V2::ServiceContext::EntityContext::FactorInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, identity: nil, sid: nil) ⇒ FactorInstance

Initialize the FactorInstance



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 276

def initialize(version, payload , service_sid: nil, identity: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'entity_sid' => payload['entity_sid'],
        'identity' => payload['identity'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'friendly_name' => payload['friendly_name'],
        'status' => payload['status'],
        'factor_type' => payload['factor_type'],
        'config' => payload['config'],
        'metadata' => payload['metadata'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String 



320
321
322
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 320

def 
    @properties['account_sid']
end

#config ⇒ Hash 



374
375
376
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 374

def config
    @properties['config']
end

#context ⇒ FactorContext

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



305
306
307
308
309
310
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 305

def context
    unless @instance_context
        @instance_context = FactorContext.new(@version , @params['service_sid'], @params['identity'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time 



344
345
346
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 344

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



350
351
352
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 350

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FactorInstance



393
394
395
396
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 393

def delete

    context.delete
end

#entity_sid ⇒ String 



332
333
334
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 332

def entity_sid
    @properties['entity_sid']
end

#factor_type ⇒ FactorTypes 



368
369
370
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 368

def factor_type
    @properties['factor_type']
end

#fetch ⇒ FactorInstance

Fetch the FactorInstance



401
402
403
404
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 401

def fetch

    context.fetch
end

#friendly_name ⇒ String 



356
357
358
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 356

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String 



338
339
340
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 338

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



452
453
454
455
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 452

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

#metadata ⇒ Hash 



380
381
382
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 380

def metadata
    @properties['metadata']
end

#service_sid ⇒ String 



326
327
328
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 326

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



314
315
316
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 314

def sid
    @properties['sid']
end

#status ⇒ FactorStatuses 



362
363
364
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 362

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



445
446
447
448
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 445

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

#update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, config_notification_platform: :unset) ⇒ FactorInstance

Update the FactorInstance



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 418

def update(
    auth_payload: :unset, 
    friendly_name: :unset, 
    config_notification_token: :unset, 
    config_sdk_version: :unset, 
    config_time_step: :unset, 
    config_skew: :unset, 
    config_code_length: :unset, 
    config_alg: :unset, 
    config_notification_platform: :unset
)

    context.update(
        auth_payload: auth_payload, 
        friendly_name: friendly_name, 
        config_notification_token: config_notification_token, 
        config_sdk_version: config_sdk_version, 
        config_time_step: config_time_step, 
        config_skew: config_skew, 
        config_code_length: config_code_length, 
        config_alg: config_alg, 
        config_notification_platform: config_notification_platform, 
    )
end

#url ⇒ String 



386
387
388
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 386

def url
    @properties['url']
end