Class: SurgeAPI::Models::VerificationCheck

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SurgeAPI::Models::VerificationCheck

Defined in:

lib/surge_api/models/verification_check.rb

Overview

See Also:

• Resources::Verifications#check

Defined Under Namespace

Modules: Result

Instance Attribute Summary

• #result ⇒ Symbol, ...

  The result of the code check.

• #verification ⇒ SurgeAPI::Models::Verification^?

  A phone number verification.

Instance Method Summary

• #initialize(result: nil, verification: nil) ⇒ Object constructor

  The result of checking a Verification code.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(result: nil, verification: nil) ⇒ Object

The result of checking a Verification code

Parameters:

• result (Symbol, SurgeAPI::Models::VerificationCheck::Result) (defaults to: nil) —

  The result of the code check.

• verification (SurgeAPI::Models::Verification) (defaults to: nil) —

  A phone number verification

# File 'lib/surge_api/models/verification_check.rb', line 19

Instance Attribute Details

#result ⇒ Symbol, ...

The result of the code check.

Returns:

• (Symbol, SurgeAPI::Models::VerificationCheck::Result, nil)

# File 'lib/surge_api/models/verification_check.rb', line 11

optional :result, enum: -> { SurgeAPI::VerificationCheck::Result }

#verification ⇒ SurgeAPI::Models::Verification^?

A phone number verification

Returns:

• (SurgeAPI::Models::Verification, nil)

# File 'lib/surge_api/models/verification_check.rb', line 17

optional :verification, -> { SurgeAPI::Verification }