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

Inherits:

Object
InstanceResource
Twilio::REST::Verify::V2::ServiceContext::EntityContext::ChallengeInstance

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

#account_sid ⇒ String

Account Sid.
#context ⇒ ChallengeContext

Generate an instance context for the instance, the context is capable of performing various actions.
#date_created ⇒ Time

The date this Challenge was created.
#date_responded ⇒ Time

The date this Challenge was responded.
#date_updated ⇒ Time

The date this Challenge was updated.
#details ⇒ Hash

The details.
#entity_sid ⇒ String

Entity Sid.
#expiration_date ⇒ Time

The date this Challenge is expired.
#factor_sid ⇒ String

Factor Sid.
#factor_type ⇒ challenge.FactorTypes

The Factor Type of this Challenge.
#fetch(twilio_sandbox_mode: :unset) ⇒ ChallengeInstance

Fetch the ChallengeInstance.
#hidden_details ⇒ Hash

Hidden details provided to contextualize the Challenge.
#identity ⇒ String

Unique external identifier of the Entity.
#initialize(version, payload, service_sid: nil, identity: nil, sid: nil) ⇒ ChallengeInstance constructor

Initialize the ChallengeInstance.
#inspect ⇒ Object

Provide a detailed, user friendly representation.
#responded_reason ⇒ challenge.ChallengeReasons

The Reason of this Challenge ‘status`.
#service_sid ⇒ String

Service Sid.
#sid ⇒ String

A string that uniquely identifies this Challenge.
#status ⇒ challenge.ChallengeStatuses

The Status of this Challenge.
#to_s ⇒ Object

Provide a user friendly representation.
#update(auth_payload: :unset, twilio_sandbox_mode: :unset) ⇒ ChallengeInstance

Update the ChallengeInstance.
#url ⇒ String

The URL of this resource.

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.

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

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.



357
358
359

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

def account_sid
  @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:

(ChallengeContext) —

ChallengeContext for this ChallengeInstance

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

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



387
388
389

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

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



399
400
401

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

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



393
394
395

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

def date_updated
  @properties['date_updated']
end

#details ⇒ `Hash`

Returns The details.

Returns:

(Hash) —

The details



423
424
425

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

def details
  @properties['details']
end

#entity_sid ⇒ `String`

Returns Entity Sid.

Returns:

(String) —

Entity Sid.



369
370
371

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

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



405
406
407

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

def expiration_date
  @properties['expiration_date']
end

#factor_sid ⇒ `String`

Returns Factor Sid.

Returns:

(String) —

Factor Sid.



381
382
383

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

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



435
436
437

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

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:

(ChallengeInstance) —

Fetched ChallengeInstance



449
450
451

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

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

#hidden_details ⇒ `Hash`

Returns Hidden details provided to contextualize the Challenge.

Returns:

(Hash) —

Hidden details provided to contextualize the Challenge



429
430
431

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

def hidden_details
  @properties['hidden_details']
end

#identity ⇒ `String`

Returns Unique external identifier of the Entity.

Returns:

(String) —

Unique external identifier of the Entity



375
376
377

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

def identity
  @properties['identity']
end

#inspect ⇒ `Object`

Provide a detailed, user friendly representation

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

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`



417
418
419

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

def responded_reason
  @properties['responded_reason']
end

#service_sid ⇒ `String`

Returns Service Sid.

Returns:

(String) —

Service Sid.



363
364
365

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

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.



351
352
353

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

def sid
  @properties['sid']
end

#status ⇒ `challenge.ChallengeStatuses`

Returns The Status of this Challenge.

Returns:

(challenge.ChallengeStatuses) —

The Status of this Challenge



411
412
413

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

def status
  @properties['status']
end

#to_s ⇒ `Object`

Provide a user friendly representation

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

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:

(ChallengeInstance) —

Updated ChallengeInstance



459
460
461

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

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.



441
442
443

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

def url
  @properties['url']
end

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

Overview

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#account_sid ⇒ String

#context ⇒ ChallengeContext

#date_created ⇒ Time

#date_responded ⇒ Time

#date_updated ⇒ Time

#details ⇒ Hash

#entity_sid ⇒ String

#expiration_date ⇒ Time

#factor_sid ⇒ String

#factor_type ⇒ challenge.FactorTypes

#fetch(twilio_sandbox_mode: :unset) ⇒ ChallengeInstance

#hidden_details ⇒ Hash

#identity ⇒ String

#inspect ⇒ Object

#responded_reason ⇒ challenge.ChallengeReasons

#service_sid ⇒ String

#sid ⇒ String

#status ⇒ challenge.ChallengeStatuses

#to_s ⇒ Object

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

#url ⇒ String

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

#account_sid ⇒ `String`

#context ⇒ `ChallengeContext`

#date_created ⇒ `Time`

#date_responded ⇒ `Time`

#date_updated ⇒ `Time`

#details ⇒ `Hash`

#entity_sid ⇒ `String`

#expiration_date ⇒ `Time`

#factor_sid ⇒ `String`

#factor_type ⇒ `challenge.FactorTypes`

#fetch(twilio_sandbox_mode: :unset) ⇒ `ChallengeInstance`

#hidden_details ⇒ `Hash`

#identity ⇒ `String`

#inspect ⇒ `Object`

#responded_reason ⇒ `challenge.ChallengeReasons`

#service_sid ⇒ `String`

#sid ⇒ `String`

#status ⇒ `challenge.ChallengeStatuses`

#to_s ⇒ `Object`

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

#url ⇒ `String`