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

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. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.

  • sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this Challenge.


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
375
376
377
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 349

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'],
      'metadata' => payload['metadata'],
      'factor_type' => payload['factor_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_sidString

Returns Account Sid.

Returns:

  • (String)

    Account Sid.


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

def 
  @properties['account_sid']
end

#contextChallengeContext

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

Returns:


383
384
385
386
387
388
389
390
391
392
393
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 383

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

#date_createdTime

Returns The date this Challenge was created.

Returns:

  • (Time)

    The date this Challenge was created


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

def date_created
  @properties['date_created']
end

#date_respondedTime

Returns The date this Challenge was responded.

Returns:

  • (Time)

    The date this Challenge was responded


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

def date_responded
  @properties['date_responded']
end

#date_updatedTime

Returns The date this Challenge was updated.

Returns:

  • (Time)

    The date this Challenge was updated


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

def date_updated
  @properties['date_updated']
end

#detailsHash

Returns Details about the Challenge.

Returns:

  • (Hash)

    Details about the Challenge.


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

def details
  @properties['details']
end

#entity_sidString

Returns Entity Sid.

Returns:

  • (String)

    Entity Sid.


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

def entity_sid
  @properties['entity_sid']
end

#expiration_dateTime

Returns The date-time when this Challenge expires.

Returns:

  • (Time)

    The date-time when this Challenge expires


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

def expiration_date
  @properties['expiration_date']
end

#factor_sidString

Returns Factor Sid.

Returns:

  • (String)

    Factor Sid.


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

def factor_sid
  @properties['factor_sid']
end

#factor_typechallenge.FactorTypes

Returns The Factor Type of this Challenge.

Returns:

  • (challenge.FactorTypes)

    The Factor Type of this Challenge


487
488
489
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 487

def factor_type
  @properties['factor_type']
end

#fetchChallengeInstance

Fetch the ChallengeInstance

Returns:


506
507
508
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 506

def fetch
  context.fetch
end

#hidden_detailsHash

Returns Hidden details about the Challenge.

Returns:

  • (Hash)

    Hidden details about the Challenge


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

def hidden_details
  @properties['hidden_details']
end

#identityString

Returns Unique external identifier of the Entity.

Returns:

  • (String)

    Unique external identifier of the Entity


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

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation


541
542
543
544
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 541

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

Returns Nested resource URLs.

Returns:

  • (String)

    Nested resource URLs.


499
500
501
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 499

def links
  @properties['links']
end

#metadataHash

Returns Metadata of the challenge.

Returns:

  • (Hash)

    Metadata of the challenge.


481
482
483
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 481

def 
  @properties['metadata']
end

#notificationsnotifications

Access the notifications

Returns:


528
529
530
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 528

def notifications
  context.notifications
end

#responded_reasonchallenge.ChallengeReasons

Returns The Reason of this Challenge `status`.

Returns:

  • (challenge.ChallengeReasons)

    The Reason of this Challenge `status`


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

def responded_reason
  @properties['responded_reason']
end

#service_sidString

Returns Service Sid.

Returns:

  • (String)

    Service Sid.


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns A string that uniquely identifies this Challenge.

Returns:

  • (String)

    A string that uniquely identifies this Challenge.


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

def sid
  @properties['sid']
end

#statuschallenge.ChallengeStatuses

Returns The Status of this Challenge.

Returns:

  • (challenge.ChallengeStatuses)

    The Status of this Challenge


457
458
459
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 457

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


534
535
536
537
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 534

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

#update(auth_payload: :unset, metadata: :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. For `TOTP` this value must be between 3 and 8 characters long. For `Push` this value can be up to 5456 characters in length

  • metadata (Hash) (defaults to: :unset)

    Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `“Android”`. Can be up to 1024 characters in length.

Returns:


521
522
523
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 521

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

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.


493
494
495
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 493

def url
  @properties['url']
end