Class: MethodRuby::Models::Entities::VerificationSessionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MethodRuby::Models::Entities::VerificationSessionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/method_ruby/models/entities/verification_session_create_params.rb,
sig/method_ruby/models/entities/verification_session_create_params.rbs

Overview

See Also:

• MethodRuby::Resources::Entities::VerificationSessions#create

Defined Under Namespace

Modules: Method, MethodVersion, Type Classes: ByoSMS

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::MethodRuby

Instance Attribute Summary

• #byo_kyc ⇒ Object^?

  BYO KYC-specific options.

• #byo_sms ⇒ MethodRuby::Models::Entities::VerificationSessionCreateParams::ByoSMS^?

  BYO SMS-specific options.

• #entity_id ⇒ String
• #idempotency_key ⇒ String^?
• #kba ⇒ Object^?

  KBA-specific options.

• #method_ ⇒ Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Method

  The verification method to use.

• #method_version ⇒ Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::MethodVersion
• #sms ⇒ Object^?

  SMS-specific options.

• #sna ⇒ Object^?

  SNA-specific options.

• #type ⇒ Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Type

  The type of verification to perform.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(entity_id:, method_:, type:, method_version:, byo_kyc: nil, byo_sms: nil, kba: nil, sms: nil, sna: nil, idempotency_key: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(entity_id:, method_:, type:, method_version:, byo_kyc: nil, byo_sms: nil, kba: nil, sms: nil, sna: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Parameters:

• entity_id (String)
• method_ (Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Method) —

  The verification method to use.

• type (Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Type) —

  The type of verification to perform.

• method_version (Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::MethodVersion)
• byo_kyc (Object) (defaults to: nil) —

  BYO KYC-specific options. Required when method is byo_kyc.

• byo_sms (MethodRuby::Models::Entities::VerificationSessionCreateParams::ByoSMS) (defaults to: nil) —

  BYO SMS-specific options. Required when method is byo_sms.

• kba (Object) (defaults to: nil) —

  KBA-specific options. Required when method is kba.

• sms (Object) (defaults to: nil) —

  SMS-specific options. Required when method is sms.

• sna (Object) (defaults to: nil) —

  SNA-specific options. Required when method is sna.

• idempotency_key (String) (defaults to: nil)
• request_options (MethodRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 71

Instance Attribute Details

#byo_kyc ⇒ Object^?

BYO KYC-specific options. Required when method is byo_kyc.

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 40

optional :byo_kyc, MethodRuby::Internal::Type::Unknown

#byo_sms ⇒ MethodRuby::Models::Entities::VerificationSessionCreateParams::ByoSMS^?

BYO SMS-specific options. Required when method is byo_sms.

Returns:

• (MethodRuby::Models::Entities::VerificationSessionCreateParams::ByoSMS, nil)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 46

optional :byo_sms, -> { MethodRuby::Entities::VerificationSessionCreateParams::ByoSMS }

#entity_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 14

required :entity_id, String

#idempotency_key ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 69

optional :idempotency_key, String

#kba ⇒ Object^?

KBA-specific options. Required when method is kba.

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 52

optional :kba, MethodRuby::Internal::Type::Unknown

#method_ ⇒ Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Method

The verification method to use.

Parameters:

• value (MethodRuby::Models::Entities::VerificationSessionCreateParams::method_)

Returns:

• (Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Method)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 20

required :method_,
enum: -> { MethodRuby::Entities::VerificationSessionCreateParams::Method },
api_name: :method

#method_version ⇒ Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::MethodVersion

Parameters:

• value (MethodRuby::Models::Entities::VerificationSessionCreateParams::method_version)

Returns:

• (Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::MethodVersion)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 33

required :method_version,
enum: -> { MethodRuby::Entities::VerificationSessionCreateParams::MethodVersion }

#sms ⇒ Object^?

SMS-specific options. Required when method is sms.

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 58

optional :sms, MethodRuby::Internal::Type::Unknown

#sna ⇒ Object^?

SNA-specific options. Required when method is sna.

Parameters:

• (top)

Returns:

• (Object, nil)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 64

optional :sna, MethodRuby::Internal::Type::Unknown

#type ⇒ Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Type

The type of verification to perform.

Parameters:

• value (MethodRuby::Models::Entities::VerificationSessionCreateParams::type_)

Returns:

• (Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Type)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 28

required :type, enum: -> { MethodRuby::Entities::VerificationSessionCreateParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/method_ruby/models/entities/verification_session_create_params.rb', line 106

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/method_ruby/models/entities/verification_session_create_params.rbs', line 71

def to_hash: -> {