Class: ModernTreasury::Models::LedgerAccountSettlementUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/ledger_account_settlement_update_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Status

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(description: nil, metadata: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

  • description (String, nil) (defaults to: nil) —

    The description of the ledger account settlement.

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Additional data represented as key-value pairs. Both the key and value must be s

  • status (Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status) (defaults to: nil) —

    To post a pending ledger account settlement, use ‘posted`. To archive a pending

  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/modern_treasury/models/ledger_account_settlement_update_params.rb', line 30

Instance Attribute Details

#description ⇒ String?

The description of the ledger account settlement.

Returns:

  • (String, nil) 


14
 
# File 'lib/modern_treasury/models/ledger_account_settlement_update_params.rb', line 14

optional :description, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

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


21
 
# File 'lib/modern_treasury/models/ledger_account_settlement_update_params.rb', line 21

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

#status ⇒ Symbol, ...

To post a pending ledger account settlement, use ‘posted`. To archive a pending ledger transaction, use `archived`.

Returns:



28
 
# File 'lib/modern_treasury/models/ledger_account_settlement_update_params.rb', line 28

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