modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb

@@ -0,0 +1,600 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    module LedgerTransactions
+      class LedgerTransactionVersion < ModernTreasury::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute description
+        #   An optional description for internal use.
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute effective_at
+        #   The timestamp (ISO8601 format) at which the ledger transaction happened for
+        #     reporting purposes.
+        #
+        #   @return [Time]
+        required :effective_at, Time
+
+        # @!attribute effective_date
+        #   The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
+        #     purposes.
+        #
+        #   @return [Date]
+        required :effective_date, Date
+
+        # @!attribute external_id
+        #   A unique string to represent the ledger transaction. Only one pending or posted
+        #     ledger transaction may have this ID in the ledger.
+        #
+        #   @return [String, nil]
+        required :external_id, String, nil?: true
+
+        # @!attribute ledger_entries
+        #   An array of ledger entry objects.
+        #
+        #   @return [Array<ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry>]
+        required :ledger_entries,
+                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry] }
+
+        # @!attribute ledger_id
+        #   The ID of the ledger this ledger transaction belongs to.
+        #
+        #   @return [String]
+        required :ledger_id, String
+
+        # @!attribute ledger_transaction_id
+        #   The ID of the ledger transaction
+        #
+        #   @return [String]
+        required :ledger_transaction_id, String
+
+        # @!attribute ledgerable_id
+        #   If the ledger transaction can be reconciled to another object in Modern
+        #     Treasury, the id will be populated here, otherwise null.
+        #
+        #   @return [String, nil]
+        required :ledgerable_id, String, nil?: true
+
+        # @!attribute ledgerable_type
+        #   If the ledger transaction can be reconciled to another object in Modern
+        #     Treasury, the type will be populated here, otherwise null. This can be one of
+        #     payment_order, incoming_payment_detail, expected_payment, return, or reversal.
+        #
+        #   @return [Symbol, ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerableType, nil]
+        required :ledgerable_type,
+                 enum: -> { ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerableType },
+                 nil?: true
+
+        # @!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 partially_posts_ledger_transaction_id
+        #   The ID of the ledger transaction that this ledger transaction partially posts.
+        #
+        #   @return [String, nil]
+        required :partially_posts_ledger_transaction_id, String, nil?: true
+
+        # @!attribute posted_at
+        #   The time on which the ledger transaction posted. This is null if the ledger
+        #     transaction is pending.
+        #
+        #   @return [Time, nil]
+        required :posted_at, Time, nil?: true
+
+        # @!attribute reversed_by_ledger_transaction_id
+        #   The ID of the ledger transaction that reversed this ledger transaction.
+        #
+        #   @return [String, nil]
+        required :reversed_by_ledger_transaction_id, String, nil?: true
+
+        # @!attribute reverses_ledger_transaction_id
+        #   The ID of the original ledger transaction. that this ledger transaction
+        #     reverses.
+        #
+        #   @return [String, nil]
+        required :reverses_ledger_transaction_id, String, nil?: true
+
+        # @!attribute status
+        #   One of `pending`, `posted`, or `archived`.
+        #
+        #   @return [Symbol, ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::Status]
+        required :status,
+                 enum: -> { ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::Status }
+
+        # @!attribute version
+        #   Version number of the ledger transaction.
+        #
+        #   @return [Integer]
+        required :version, Integer
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param created_at [Time]
+        #   # @param description [String, nil]
+        #   # @param effective_at [Time]
+        #   # @param effective_date [Date]
+        #   # @param external_id [String, nil]
+        #   # @param ledger_entries [Array<ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry>]
+        #   # @param ledger_id [String]
+        #   # @param ledger_transaction_id [String]
+        #   # @param ledgerable_id [String, nil]
+        #   # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerableType, nil]
+        #   # @param live_mode [Boolean]
+        #   # @param metadata [Hash{Symbol=>String}]
+        #   # @param object [String]
+        #   # @param partially_posts_ledger_transaction_id [String, nil]
+        #   # @param posted_at [Time, nil]
+        #   # @param reversed_by_ledger_transaction_id [String, nil]
+        #   # @param reverses_ledger_transaction_id [String, nil]
+        #   # @param status [Symbol, ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::Status]
+        #   # @param version [Integer]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     created_at:,
+        #     description:,
+        #     effective_at:,
+        #     effective_date:,
+        #     external_id:,
+        #     ledger_entries:,
+        #     ledger_id:,
+        #     ledger_transaction_id:,
+        #     ledgerable_id:,
+        #     ledgerable_type:,
+        #     live_mode:,
+        #     metadata:,
+        #     object:,
+        #     partially_posts_ledger_transaction_id:,
+        #     posted_at:,
+        #     reversed_by_ledger_transaction_id:,
+        #     reverses_ledger_transaction_id:,
+        #     status:,
+        #     version:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        class LedgerEntry < ModernTreasury::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute amount
+          #   Value in specified currency's smallest unit. e.g. $10 would be represented
+          #     as 1000. Can be any integer up to 36 digits.
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute created_at
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute direction
+          #   One of `credit`, `debit`. Describes the direction money is flowing in the
+          #     transaction. A `credit` moves money from your account to someone else's. A
+          #     `debit` pulls money from someone else's account to your own. Note that wire,
+          #     rtp, and check payments will always be `credit`.
+          #
+          #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+          required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+          # @!attribute ledger_account_currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :ledger_account_currency, String
+
+          # @!attribute ledger_account_currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :ledger_account_currency_exponent, Integer
+
+          # @!attribute ledger_account_id
+          #   The ledger account that this ledger entry is associated with.
+          #
+          #   @return [String]
+          required :ledger_account_id, String
+
+          # @!attribute ledger_account_lock_version
+          #   Lock version of the ledger account. This can be passed when creating a ledger
+          #     transaction to only succeed if no ledger transactions have posted since the
+          #     given version. See our post about Designing the Ledgers API with Optimistic
+          #     Locking for more details.
+          #
+          #   @return [Integer, nil]
+          required :ledger_account_lock_version, Integer, nil?: true
+
+          # @!attribute ledger_transaction_id
+          #   The ledger transaction that this ledger entry is associated with.
+          #
+          #   @return [String]
+          required :ledger_transaction_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 resulting_ledger_account_balances
+          #   The pending, posted, and available balances for this ledger entry's ledger
+          #     account. 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. Please see
+          #     https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
+          #     details.
+          #
+          #   @return [ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances, nil]
+          required :resulting_ledger_account_balances,
+                   -> { ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances },
+                   nil?: true
+
+          # @!attribute status
+          #   Equal to the state of the ledger transaction when the ledger entry was created.
+          #     One of `pending`, `posted`, or `archived`.
+          #
+          #   @return [Symbol, ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status]
+          required :status,
+                   enum: -> { ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status }
+
+          # @!parse
+          #   # @param id [String]
+          #   # @param amount [Integer]
+          #   # @param created_at [Time]
+          #   # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+          #   # @param ledger_account_currency [String]
+          #   # @param ledger_account_currency_exponent [Integer]
+          #   # @param ledger_account_id [String]
+          #   # @param ledger_account_lock_version [Integer, nil]
+          #   # @param ledger_transaction_id [String]
+          #   # @param live_mode [Boolean]
+          #   # @param metadata [Hash{Symbol=>String}]
+          #   # @param object [String]
+          #   # @param resulting_ledger_account_balances [ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances, nil]
+          #   # @param status [Symbol, ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status]
+          #   #
+          #   def initialize(
+          #     id:,
+          #     amount:,
+          #     created_at:,
+          #     direction:,
+          #     ledger_account_currency:,
+          #     ledger_account_currency_exponent:,
+          #     ledger_account_id:,
+          #     ledger_account_lock_version:,
+          #     ledger_transaction_id:,
+          #     live_mode:,
+          #     metadata:,
+          #     object:,
+          #     resulting_ledger_account_balances:,
+          #     status:,
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+          class ResultingLedgerAccountBalances < 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::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance]
+            required :available_balance,
+                     -> { ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance }
+
+            # @!attribute pending_balance
+            #   The pending_balance is the sum of all pending and posted entries.
+            #
+            #   @return [ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance]
+            required :pending_balance,
+                     -> { ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance }
+
+            # @!attribute posted_balance
+            #   The posted_balance is the sum of all posted entries.
+            #
+            #   @return [ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance]
+            required :posted_balance,
+                     -> { ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance }
+
+            # @!parse
+            #   # The pending, posted, and available balances for this ledger entry's ledger
+            #   #   account. 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. Please see
+            #   #   https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
+            #   #   details.
+            #   #
+            #   # @param available_balance [ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance]
+            #   # @param pending_balance [ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance]
+            #   # @param posted_balance [ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::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
+
+          # @abstract
+          #
+          # Equal to the state of the ledger transaction when the ledger entry was created.
+          #   One of `pending`, `posted`, or `archived`.
+          #
+          # @example
+          # ```ruby
+          # case status
+          # in :archived
+          #   # ...
+          # in :pending
+          #   # ...
+          # in :posted
+          #   # ...
+          # end
+          # ```
+          class Status < ModernTreasury::Enum
+            ARCHIVED = :archived
+            PENDING = :pending
+            POSTED = :posted
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        # @abstract
+        #
+        # If the ledger transaction can be reconciled to another object in Modern
+        #   Treasury, the type will be populated here, otherwise null. This can be one of
+        #   payment_order, incoming_payment_detail, expected_payment, return, or reversal.
+        #
+        # @example
+        # ```ruby
+        # case ledgerable_type
+        # in :expected_payment
+        #   # ...
+        # in :incoming_payment_detail
+        #   # ...
+        # in :paper_item
+        #   # ...
+        # in :payment_order
+        #   # ...
+        # in :return
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class LedgerableType < ModernTreasury::Enum
+          EXPECTED_PAYMENT = :expected_payment
+          INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
+          PAPER_ITEM = :paper_item
+          PAYMENT_ORDER = :payment_order
+          RETURN = :return
+          REVERSAL = :reversal
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        # @abstract
+        #
+        # One of `pending`, `posted`, or `archived`.
+        #
+        # @example
+        # ```ruby
+        # case status
+        # in :archived
+        #   # ...
+        # in :pending
+        #   # ...
+        # in :posted
+        #   # ...
+        # end
+        # ```
+        class Status < ModernTreasury::Enum
+          ARCHIVED = :archived
+          PENDING = :pending
+          POSTED = :posted
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+
+    LedgerTransactionVersion = LedgerTransactions::LedgerTransactionVersion
+  end
+end

data/lib/modern_treasury/models/ledger_transactions/version_list_params.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    module LedgerTransactions
+      class VersionListParams < ModernTreasury::BaseModel
+        # @!parse
+        #   extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        # @!attribute after_cursor
+        #
+        #   @return [String, nil]
+        optional :after_cursor, String, nil?: true
+
+        # @!attribute [r] created_at
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        #     created_at timestamp. For example, for all dates after Jan 1 2000 12:00 UTC, use
+        #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
+        #
+        #   @return [Hash{Symbol=>Time}, nil]
+        optional :created_at, ModernTreasury::HashOf[Time]
+
+        # @!parse
+        #   # @return [Hash{Symbol=>Time}]
+        #   attr_writer :created_at
+
+        # @!attribute [r] ledger_account_statement_id
+        #   Get all ledger transaction versions that are included in the ledger account
+        #     statement.
+        #
+        #   @return [String, nil]
+        optional :ledger_account_statement_id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :ledger_account_statement_id
+
+        # @!attribute [r] ledger_transaction_id
+        #   Get all the ledger transaction versions corresponding to the ID of a ledger
+        #     transaction.
+        #
+        #   @return [String, nil]
+        optional :ledger_transaction_id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :ledger_transaction_id
+
+        # @!attribute [r] per_page
+        #
+        #   @return [Integer, nil]
+        optional :per_page, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :per_page
+
+        # @!attribute [r] version
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        #     version. For example, for all versions after 2, use version%5Bgt%5D=2.
+        #
+        #   @return [Hash{Symbol=>Integer}, nil]
+        optional :version, ModernTreasury::HashOf[Integer]
+
+        # @!parse
+        #   # @return [Hash{Symbol=>Integer}]
+        #   attr_writer :version
+
+        # @!parse
+        #   # @param after_cursor [String, nil]
+        #   # @param created_at [Hash{Symbol=>Time}]
+        #   # @param ledger_account_statement_id [String]
+        #   # @param ledger_transaction_id [String]
+        #   # @param per_page [Integer]
+        #   # @param version [Hash{Symbol=>Integer}]
+        #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(
+        #     after_cursor: nil,
+        #     created_at: nil,
+        #     ledger_account_statement_id: nil,
+        #     ledger_transaction_id: nil,
+        #     per_page: nil,
+        #     version: nil,
+        #     request_options: {},
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end