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 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) ⇒ ChallengeInstance

Initialize the ChallengeInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil) —

    The unique SID identifier of the Service.

  • identity (String) (defaults to: nil) —

    Customer unique identity for the Entity owner of the Challenge

  • sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies this Challenge.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 308

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

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



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

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

Returns:



340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 340

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

#date_created ⇒ Time

Returns The date this Challenge was created.

Returns:

  • (Time) —

    The date this Challenge was created



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

def date_created
  @properties['date_created']
end

#date_responded ⇒ Time

Returns The date this Challenge was responded.

Returns:

  • (Time) —

    The date this Challenge was responded



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

def date_responded
  @properties['date_responded']
end

#date_updated ⇒ Time

Returns The date this Challenge was updated.

Returns:

  • (Time) —

    The date this Challenge was updated



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

def date_updated
  @properties['date_updated']
end

#details ⇒ String

Returns Public details provided to contextualize the Challenge.

Returns:

  • (String) —

    Public details provided to contextualize the Challenge



426
427
428
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 426

def details
  @properties['details']
end

#entity_sid ⇒ String

Returns Entity Sid.

Returns:

  • (String) —

    Entity Sid.



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

def entity_sid
  @properties['entity_sid']
end

#expiration_date ⇒ Time

Returns The date this Challenge is expired.

Returns:

  • (Time) —

    The date this Challenge is expired



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

def expiration_date
  @properties['expiration_date']
end

#factor_sid ⇒ String

Returns Factor Sid.

Returns:

  • (String) —

    Factor Sid.



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

def factor_sid
  @properties['factor_sid']
end

#factor_type ⇒ challenge.FactorTypes

Returns The Factor Type of this Challenge.

Returns:

  • (challenge.FactorTypes) —

    The Factor Type of this Challenge



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

def factor_type
  @properties['factor_type']
end

#fetch(twilio_sandbox_mode: :unset) ⇒ ChallengeInstance

Fetch the ChallengeInstance

Parameters:

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

    The Twilio-Sandbox-Mode HTTP request header

Returns:



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

def fetch(twilio_sandbox_mode: :unset)
  context.fetch(twilio_sandbox_mode: twilio_sandbox_mode, )
end

#hidden_details ⇒ String

Returns Hidden details provided to contextualize the Challenge.

Returns:

  • (String) —

    Hidden details provided to contextualize the Challenge



432
433
434
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 432

def hidden_details
  @properties['hidden_details']
end

#identity ⇒ String

Returns Unique external identifier of the Entity.

Returns:

  • (String) —

    Unique external identifier of the Entity



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



475
476
477
478
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 475

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

#responded_reason ⇒ challenge.ChallengeReasons

Returns The Reason of this Challenge ‘status`.

Returns:

  • (challenge.ChallengeReasons) —

    The Reason of this Challenge ‘status`



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

def responded_reason
  @properties['responded_reason']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Challenge.

Returns:

  • (String) —

    A string that uniquely identifies this Challenge.



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

def sid
  @properties['sid']
end

#status ⇒ challenge.ChallengeStatuses

Returns The Status of this Challenge.

Returns:

  • (challenge.ChallengeStatuses) —

    The Status of this Challenge



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



468
469
470
471
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 468

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

#update(auth_payload: :unset, twilio_sandbox_mode: :unset) ⇒ ChallengeInstance

Update the ChallengeInstance

Parameters:

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

    The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code.

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

    The Twilio-Sandbox-Mode HTTP request header

Returns:



462
463
464
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 462

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end