Class: Straddle::Models::AccountSimulateOnboardingParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/straddle/models/account_simulate_onboarding_params.rb,
sig/straddle/models/account_simulate_onboarding_params.rbs

Overview

See Also:

  • Straddle::Resources::Accounts#simulate_onboarding

Defined Under Namespace

Modules: FinalStatus

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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 ⇒ Object 



37
 
# File 'sig/straddle/models/account_simulate_onboarding_params.rbs', line 37

def initialize: (

Instance Attribute Details

#account_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/straddle/models/account_simulate_onboarding_params.rb', line 13

required :account_id, String

#correlation_id ⇒ String?

Optional client-generated identifier for tracing a series of related requests.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/straddle/models/account_simulate_onboarding_params.rb', line 25

optional :correlation_id, String

#final_status ⇒ Symbol, ...

Final account status to produce in the sandbox simulation.

Returns:



19
 
# File 'lib/straddle/models/account_simulate_onboarding_params.rb', line 19

optional :final_status, enum: -> { Straddle::AccountSimulateOnboardingParams::FinalStatus }

#idempotency_key ⇒ String?

Optional client-generated key for an idempotent request.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/straddle/models/account_simulate_onboarding_params.rb', line 31

optional :idempotency_key, String

#request_id ⇒ String?

Optional client-generated identifier for tracing one request.

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/straddle/models/account_simulate_onboarding_params.rb', line 37

optional :request_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/straddle/models/account_simulate_onboarding_params.rbs', line 46

def to_hash: -> {