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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

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

Initialize the ChallengeInstance



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 286

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'],
      'factor_sid' => payload['factor_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'date_responded' => Twilio.deserialize_iso8601_datetime(payload['date_responded']),
      'expiration_date' => Twilio.deserialize_iso8601_datetime(payload['expiration_date']),
      'status' => payload['status'],
      'responded_reason' => payload['responded_reason'],
      'details' => payload['details'],
      'hidden_details' => payload['hidden_details'],
      'factor_type' => payload['factor_type'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String 



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

def 
  @properties['account_sid']
end

#context ⇒ ChallengeContext

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



318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 318

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_responded ⇒ Time 



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

def date_responded
  @properties['date_responded']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#details ⇒ Hash 



404
405
406
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 404

def details
  @properties['details']
end

#entity_sid ⇒ String 



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

def entity_sid
  @properties['entity_sid']
end

#expiration_date ⇒ Time 



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

def expiration_date
  @properties['expiration_date']
end

#factor_sid ⇒ String 



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

def factor_sid
  @properties['factor_sid']
end

#factor_type ⇒ challenge.FactorTypes 



416
417
418
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 416

def factor_type
  @properties['factor_type']
end

#fetch ⇒ ChallengeInstance

Fetch the ChallengeInstance



429
430
431
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 429

def fetch
  context.fetch
end

#hidden_details ⇒ Hash 



410
411
412
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 410

def hidden_details
  @properties['hidden_details']
end

#identity ⇒ String 



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#responded_reason ⇒ challenge.ChallengeReasons 



398
399
400
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 398

def responded_reason
  @properties['responded_reason']
end

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#status ⇒ challenge.ChallengeStatuses 



392
393
394
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 392

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(auth_payload: :unset) ⇒ ChallengeInstance

Update the ChallengeInstance



438
439
440
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 438

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

#url ⇒ String 



422
423
424
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 422

def url
  @properties['url']
end