Class: ModernTreasury::Models::LegalEntityListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::LegalEntityListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/legal_entity_list_params.rb,
sig/modern_treasury/models/legal_entity_list_params.rbs

Overview

See Also:

• ModernTreasury::Resources::LegalEntities#list

Defined Under Namespace

Modules: LegalEntityType, Status

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ModernTreasury

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #legal_entity_type ⇒ Symbol, ...
• #metadata ⇒ Hash{Symbol=>String}^?

  For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan.

• #per_page ⇒ Integer^?
• #show_deleted ⇒ String^?
• #status ⇒ Symbol, ...

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ 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 ⇒ Object

# File 'sig/modern_treasury/models/legal_entity_list_params.rbs', line 49

def initialize: (

Instance Attribute Details

#after_cursor ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_list_params.rb', line 13

optional :after_cursor, String, nil?: true

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_list_params.rb', line 19

optional :external_id, String

#legal_entity_type ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::LegalEntityListParams::LegalEntityType, nil)

# File 'lib/modern_treasury/models/legal_entity_list_params.rb', line 24

optional :legal_entity_type, enum: -> { ModernTreasury::LegalEntityListParams::LegalEntityType }

#metadata ⇒ Hash{Symbol=>String}^?

For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

Parameters:

• (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/modern_treasury/models/legal_entity_list_params.rb', line 32

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#per_page ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :per_page, Integer

#show_deleted ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_list_params.rb', line 42

optional :show_deleted, String

#status ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::LegalEntityListParams::Status, nil)

# File 'lib/modern_treasury/models/legal_entity_list_params.rb', line 47

optional :status, enum: -> { ModernTreasury::LegalEntityListParams::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/legal_entity_list_params.rb', line 75

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/legal_entity_list_params.rbs', line 60

def to_hash: -> {