Class: ModernTreasury::Models::WealthAndEmploymentDetails

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/wealth_and_employment_details.rb

Defined Under Namespace

Modules: EmploymentStatus, IncomeSource, Industry, Occupation, SourceOfFunds, WealthSource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(id: , annual_income: , created_at: , discarded_at: , employer_country: , employer_name: , employer_state: , employment_status: , income_country: , income_source: , income_state: , industry: , live_mode: , object: , occupation: , source_of_funds: , updated_at: , wealth_source: ) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::WealthAndEmploymentDetails for more details.

Parameters:




# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 122

Instance Attribute Details

#annual_income ⇒ Integer?

The annual income of the individual.

Returns:

  • (Integer, nil) 


15
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 15

required :annual_income, Integer, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


20
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 20

required :created_at, Time

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


25
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 25

required :discarded_at, Time, nil?: true

#employer_country ⇒ String?

The country in which the employer is located.

Returns:

  • (String, nil) 


31
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 31

required :employer_country, String, nil?: true

#employer_name ⇒ String?

The name of the employer.

Returns:

  • (String, nil) 


37
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 37

required :employer_name, String, nil?: true

#employer_state ⇒ String?

The state in which the employer is located.

Returns:

  • (String, nil) 


43
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 43

required :employer_state, String, nil?: true

#employment_status ⇒ Symbol, ...

The employment status of the individual.

Returns:



49
50
51
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 49

required :employment_status,
enum: -> { ModernTreasury::WealthAndEmploymentDetails::EmploymentStatus },
nil?: true

#id ⇒ String

Returns:

  • (String) 


9
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 9

required :id, String

#income_country ⇒ String?

The country in which the individual’s income is earned.

Returns:

  • (String, nil) 


57
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 57

required :income_country, String, nil?: true

#income_source ⇒ Symbol, ...

The source of the individual’s income.

Returns:



63
64
65
66
67
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 63

required :income_source,
enum: -> {
  ModernTreasury::WealthAndEmploymentDetails::IncomeSource
},
nil?: true

#income_state ⇒ String?

The state in which the individual’s income is earned.

Returns:

  • (String, nil) 


73
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 73

required :income_state, String, nil?: true

#industry ⇒ Symbol, ...

The industry of the individual.

Returns:



79
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 79

required :industry, enum: -> { ModernTreasury::WealthAndEmploymentDetails::Industry }, nil?: true

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean) 


86
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 86

required :live_mode, ModernTreasury::Internal::Type::Boolean

#object ⇒ String

Returns:

  • (String) 


91
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 91

required :object, String

#occupation ⇒ Symbol, ...

The occupation of the individual.

Returns:



97
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 97

required :occupation, enum: -> { ModernTreasury::WealthAndEmploymentDetails::Occupation }, nil?: true

#source_of_funds ⇒ Symbol, ...

The source of the individual’s funds.

Returns:



103
104
105
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 103

required :source_of_funds,
enum: -> { ModernTreasury::WealthAndEmploymentDetails::SourceOfFunds },
nil?: true

#updated_at ⇒ Time

Returns:

  • (Time) 


110
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 110

required :updated_at, Time

#wealth_source ⇒ Symbol, ...

The source of the individual’s wealth.

Returns:



116
117
118
119
120
 
# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 116

required :wealth_source,
enum: -> {
  ModernTreasury::WealthAndEmploymentDetails::WealthSource
},
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/wealth_and_employment_details.rb', line 174