modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb

@@ -0,0 +1,488 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountStatementRetrieveResponse < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description of the ledger account statement.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute effective_at_lower_bound
+      #   The inclusive lower bound of the effective_at timestamp of the ledger entries to
+      #     be included in the ledger account statement.
+      #
+      #   @return [Time]
+      required :effective_at_lower_bound, Time
+
+      # @!attribute effective_at_upper_bound
+      #   The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #     be included in the ledger account statement.
+      #
+      #   @return [Time]
+      required :effective_at_upper_bound, Time
+
+      # @!attribute ending_balance
+      #   The pending, posted, and available balances for this ledger account at the
+      #     `effective_at_upper_bound`. The posted balance is the sum of all posted entries
+      #     on the account. The pending balance is the sum of all pending and posted entries
+      #     on the account. The available balance is the posted incoming entries minus the
+      #     sum of the pending and posted outgoing amounts.
+      #
+      #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance]
+      required :ending_balance,
+               -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance }
+
+      # @!attribute ledger_account_id
+      #   The id of the ledger account whose ledger entries are queried against, and its
+      #     balances are computed as a result.
+      #
+      #   @return [String]
+      required :ledger_account_id, String
+
+      # @!attribute ledger_account_lock_version
+      #   Lock version of the ledger account at the time of statement generation.
+      #
+      #   @return [Integer]
+      required :ledger_account_lock_version, Integer
+
+      # @!attribute ledger_account_normal_balance
+      #   The normal balance of the ledger account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      required :ledger_account_normal_balance, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+      # @!attribute ledger_id
+      #   The id of the ledger that this ledger account statement belongs to.
+      #
+      #   @return [String]
+      required :ledger_id, String
+
+      # @!attribute live_mode
+      #   This field will be true if this object exists in the live environment or false
+      #     if it exists in the test environment.
+      #
+      #   @return [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, ModernTreasury::HashOf[String]
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute starting_balance
+      #   The pending, posted, and available balances for this ledger account at the
+      #     `effective_at_lower_bound`. The posted balance is the sum of all posted entries
+      #     on the account. The pending balance is the sum of all pending and posted entries
+      #     on the account. The available balance is the posted incoming entries minus the
+      #     sum of the pending and posted outgoing amounts.
+      #
+      #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance]
+      required :starting_balance,
+               -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param description [String, nil]
+      #   # @param effective_at_lower_bound [Time]
+      #   # @param effective_at_upper_bound [Time]
+      #   # @param ending_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance]
+      #   # @param ledger_account_id [String]
+      #   # @param ledger_account_lock_version [Integer]
+      #   # @param ledger_account_normal_balance [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   # @param ledger_id [String]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param object [String]
+      #   # @param starting_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     description:,
+      #     effective_at_lower_bound:,
+      #     effective_at_upper_bound:,
+      #     ending_balance:,
+      #     ledger_account_id:,
+      #     ledger_account_lock_version:,
+      #     ledger_account_normal_balance:,
+      #     ledger_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     object:,
+      #     starting_balance:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class EndingBalance < ModernTreasury::BaseModel
+        # @!attribute available_balance
+        #   The available_balance is the sum of all posted inbound entries and pending
+        #     outbound entries. For credit normal, available_amount = posted_credits -
+        #     pending_debits; for debit normal, available_amount = posted_debits -
+        #     pending_credits.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::AvailableBalance]
+        required :available_balance,
+                 -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::AvailableBalance }
+
+        # @!attribute pending_balance
+        #   The pending_balance is the sum of all pending and posted entries.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::PendingBalance]
+        required :pending_balance,
+                 -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::PendingBalance }
+
+        # @!attribute posted_balance
+        #   The posted_balance is the sum of all posted entries.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::PostedBalance]
+        required :posted_balance,
+                 -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::PostedBalance }
+
+        # @!parse
+        #   # The pending, posted, and available balances for this ledger account at the
+        #   #   `effective_at_upper_bound`. The posted balance is the sum of all posted entries
+        #   #   on the account. The pending balance is the sum of all pending and posted entries
+        #   #   on the account. The available balance is the posted incoming entries minus the
+        #   #   sum of the pending and posted outgoing amounts.
+        #   #
+        #   # @param available_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::AvailableBalance]
+        #   # @param pending_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::PendingBalance]
+        #   # @param posted_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::EndingBalance::PostedBalance]
+        #   #
+        #   def initialize(available_balance:, pending_balance:, posted_balance:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        class AvailableBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The available_balance is the sum of all posted inbound entries and pending
+          #   #   outbound entries. For credit normal, available_amount = posted_credits -
+          #   #   pending_debits; for debit normal, available_amount = posted_debits -
+          #   #   pending_credits.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+
+        class PendingBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The pending_balance is the sum of all pending and posted entries.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+
+        class PostedBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The posted_balance is the sum of all posted entries.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+      end
+
+      class StartingBalance < ModernTreasury::BaseModel
+        # @!attribute available_balance
+        #   The available_balance is the sum of all posted inbound entries and pending
+        #     outbound entries. For credit normal, available_amount = posted_credits -
+        #     pending_debits; for debit normal, available_amount = posted_debits -
+        #     pending_credits.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::AvailableBalance]
+        required :available_balance,
+                 -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::AvailableBalance }
+
+        # @!attribute pending_balance
+        #   The pending_balance is the sum of all pending and posted entries.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::PendingBalance]
+        required :pending_balance,
+                 -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::PendingBalance }
+
+        # @!attribute posted_balance
+        #   The posted_balance is the sum of all posted entries.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::PostedBalance]
+        required :posted_balance,
+                 -> { ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::PostedBalance }
+
+        # @!parse
+        #   # The pending, posted, and available balances for this ledger account at the
+        #   #   `effective_at_lower_bound`. The posted balance is the sum of all posted entries
+        #   #   on the account. The pending balance is the sum of all pending and posted entries
+        #   #   on the account. The available balance is the posted incoming entries minus the
+        #   #   sum of the pending and posted outgoing amounts.
+        #   #
+        #   # @param available_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::AvailableBalance]
+        #   # @param pending_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::PendingBalance]
+        #   # @param posted_balance [ModernTreasury::Models::LedgerAccountStatementRetrieveResponse::StartingBalance::PostedBalance]
+        #   #
+        #   def initialize(available_balance:, pending_balance:, posted_balance:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        class AvailableBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The available_balance is the sum of all posted inbound entries and pending
+          #   #   outbound entries. For credit normal, available_amount = posted_credits -
+          #   #   pending_debits; for debit normal, available_amount = posted_debits -
+          #   #   pending_credits.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+
+        class PendingBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The pending_balance is the sum of all pending and posted entries.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+
+        class PostedBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The posted_balance is the sum of all posted entries.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_update_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute description
+      #   The description of the ledger account.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute [r] name
+      #   The name of the ledger account.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :name
+
+      # @!parse
+      #   # @param description [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(description: nil, metadata: nil, name: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_create_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute name
+      #   The name of the ledger.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute description
+      #   An optional free-form description for internal use.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!parse
+      #   # @param name [String]
+      #   # @param description [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(name:, description: nil, metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_delete_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerDeleteParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!parse
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end