Class: ModernTreasury::Models::LedgerUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/ledger_update_params.rb

Overview

See Also:

• Resources::Ledgers#update

Instance Attribute Summary

• #description ⇒ String^?

  An optional free-form description for internal use.

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

  Additional data represented as key-value pairs.

• #name ⇒ String^?

  The name of the ledger.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(description: nil, metadata: nil, name: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see LedgerUpdateParams for more details.

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, name: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  An optional free-form description for internal use.

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

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

• name (String) (defaults to: nil) —

  The name of the ledger.

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

# File 'lib/modern_treasury/models/ledger_update_params.rb', line 29

Instance Attribute Details

#description ⇒ String^?

An optional free-form description for internal use.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_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)

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

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

#name ⇒ String^?

The name of the ledger.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_update_params.rb', line 27

optional :name, String