Class: Twilio::REST::Authy::V1::ServiceContext::EntityContext::FactorInstance

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

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

Initialize the FactorInstance



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 313

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

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

Instance Method Details

#account_sid ⇒ String 



361
362
363
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 361

def 
  @properties['account_sid']
end

#challenges ⇒ challenges

Access the challenges



451
452
453
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 451

def challenges
  context.challenges
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



341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 341

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

#date_created ⇒ Time 



385
386
387
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 385

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



391
392
393
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 391

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the FactorInstance



428
429
430
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 428

def delete
  context.delete
end

#entity_sid ⇒ String 



373
374
375
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 373

def entity_sid
  @properties['entity_sid']
end

#fetch ⇒ FactorInstance

Fetch a FactorInstance



435
436
437
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 435

def fetch
  context.fetch
end

#friendly_name ⇒ String 



397
398
399
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 397

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String 



379
380
381
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 379

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



464
465
466
467
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 464

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

#links ⇒ String 



421
422
423
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 421

def links
  @properties['links']
end

#service_sid ⇒ String 



367
368
369
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 367

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



355
356
357
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 355

def sid
  @properties['sid']
end

#status ⇒ factor.FactorStatus 



403
404
405
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 403

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



457
458
459
460
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 457

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

#type ⇒ String 



409
410
411
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 409

def type
  @properties['type']
end

#update(auth_payload: :unset) ⇒ FactorInstance

Update the FactorInstance



444
445
446
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 444

def update(auth_payload: :unset)
  context.update(auth_payload: auth_payload, )
end

#url ⇒ String 



415
416
417
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 415

def url
  @properties['url']
end