modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/ledger_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerRetrieveParams < 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

data/lib/modern_treasury/models/ledger_transaction.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerTransaction < 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::LedgerEntry>]
+      required :ledger_entries, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerEntry] }
+
+      # @!attribute ledger_id
+      #   The ID of the ledger this ledger transaction belongs to.
+      #
+      #   @return [String]
+      required :ledger_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, paper_item, or
+      #     reversal.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerTransaction::LedgerableType, nil]
+      required :ledgerable_type,
+               enum: -> { ModernTreasury::Models::LedgerTransaction::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
+      #   To post a ledger transaction at creation, use `posted`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerTransaction::Status]
+      required :status, enum: -> { ModernTreasury::Models::LedgerTransaction::Status }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!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::LedgerEntry>]
+      #   # @param ledger_id [String]
+      #   # @param ledgerable_id [String, nil]
+      #   # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransaction::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::LedgerTransaction::Status]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     description:,
+      #     effective_at:,
+      #     effective_date:,
+      #     external_id:,
+      #     ledger_entries:,
+      #     ledger_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:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # 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, paper_item, or
+      #   reversal.
+      module LedgerableType
+        extend 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
+
+      # To post a ledger transaction at creation, use `posted`.
+      module Status
+        extend ModernTreasury::Enum
+
+        ARCHIVED = :archived
+        PENDING = :pending
+        POSTED = :posted
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_transaction_create_params.rb

@@ -0,0 +1,272 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerTransactionCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute ledger_entries
+      #   An array of ledger entry objects.
+      #
+      #   @return [Array<ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry>]
+      required :ledger_entries,
+               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry] }
+
+      # @!attribute description
+      #   An optional description for internal use.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] effective_at
+      #   The timestamp (ISO8601 format) at which the ledger transaction happened for
+      #     reporting purposes.
+      #
+      #   @return [Time, nil]
+      optional :effective_at, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :effective_at
+
+      # @!attribute [r] effective_date
+      #   The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
+      #     purposes.
+      #
+      #   @return [Date, nil]
+      optional :effective_date, Date
+
+      # @!parse
+      #   # @return [Date]
+      #   attr_writer :effective_date
+
+      # @!attribute [r] 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]
+      optional :external_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :external_id
+
+      # @!attribute [r] 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]
+      optional :ledgerable_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledgerable_id
+
+      # @!attribute [r] 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, paper_item, or
+      #     reversal.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType, nil]
+      optional :ledgerable_type,
+               enum: -> { ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType]
+      #   attr_writer :ledgerable_type
+
+      # @!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] status
+      #   To post a ledger transaction at creation, use `posted`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::Status, nil]
+      optional :status, enum: -> { ModernTreasury::Models::LedgerTransactionCreateParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param ledger_entries [Array<ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry>]
+      #   # @param description [String, nil]
+      #   # @param effective_at [Time]
+      #   # @param effective_date [Date]
+      #   # @param external_id [String]
+      #   # @param ledgerable_id [String]
+      #   # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param status [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::Status]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     ledger_entries:,
+      #     description: nil,
+      #     effective_at: nil,
+      #     effective_date: nil,
+      #     external_id: nil,
+      #     ledgerable_id: nil,
+      #     ledgerable_type: nil,
+      #     metadata: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class LedgerEntry < ModernTreasury::BaseModel
+        # @!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 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_id
+        #   The ledger account that this ledger entry is associated with.
+        #
+        #   @return [String]
+        required :ledger_account_id, String
+
+        # @!attribute available_balance_amount
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        #     account’s available balance. If any of these conditions would be false after the
+        #     transaction is created, the entire call will fail with error code 422.
+        #
+        #   @return [Hash{Symbol=>Integer}, nil]
+        optional :available_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
+
+        # @!attribute 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]
+        optional :lock_version, Integer, 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 pending_balance_amount
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        #     account’s pending balance. If any of these conditions would be false after the
+        #     transaction is created, the entire call will fail with error code 422.
+        #
+        #   @return [Hash{Symbol=>Integer}, nil]
+        optional :pending_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
+
+        # @!attribute posted_balance_amount
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        #     account’s posted balance. If any of these conditions would be false after the
+        #     transaction is created, the entire call will fail with error code 422.
+        #
+        #   @return [Hash{Symbol=>Integer}, nil]
+        optional :posted_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
+
+        # @!attribute show_resulting_ledger_account_balances
+        #   If true, response will include the balance of the associated ledger account for
+        #     the entry.
+        #
+        #   @return [Boolean, nil]
+        optional :show_resulting_ledger_account_balances, ModernTreasury::BooleanModel, nil?: true
+
+        # @!parse
+        #   # @param amount [Integer]
+        #   # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+        #   # @param ledger_account_id [String]
+        #   # @param available_balance_amount [Hash{Symbol=>Integer}, nil]
+        #   # @param lock_version [Integer, nil]
+        #   # @param metadata [Hash{Symbol=>String}]
+        #   # @param pending_balance_amount [Hash{Symbol=>Integer}, nil]
+        #   # @param posted_balance_amount [Hash{Symbol=>Integer}, nil]
+        #   # @param show_resulting_ledger_account_balances [Boolean, nil]
+        #   #
+        #   def initialize(
+        #     amount:,
+        #     direction:,
+        #     ledger_account_id:,
+        #     available_balance_amount: nil,
+        #     lock_version: nil,
+        #     metadata: nil,
+        #     pending_balance_amount: nil,
+        #     posted_balance_amount: nil,
+        #     show_resulting_ledger_account_balances: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+
+      # 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, paper_item, or
+      #   reversal.
+      module LedgerableType
+        extend 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
+
+      # To post a ledger transaction at creation, use `posted`.
+      module Status
+        extend ModernTreasury::Enum
+
+        ARCHIVED = :archived
+        PENDING = :pending
+        POSTED = :posted
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerTransactionCreatePartialPostParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute posted_ledger_entries
+      #   An array of ledger entry objects to be set on the posted ledger transaction.
+      #     There must be one entry for each of the existing entries with a lesser amount
+      #     than the existing entry.
+      #
+      #   @return [Array<ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry>]
+      required :posted_ledger_entries,
+               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry] }
+
+      # @!attribute [r] description
+      #   An optional free-form description for the posted ledger transaction. Maximum of
+      #     1000 characters allowed.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :description
+
+      # @!attribute [r] effective_at
+      #   The timestamp (IS08601 format) at which the posted ledger transaction happened
+      #     for reporting purposes.
+      #
+      #   @return [Time, nil]
+      optional :effective_at, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :effective_at
+
+      # @!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 posted_ledger_entries [Array<ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry>]
+      #   # @param description [String]
+      #   # @param effective_at [Time]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(posted_ledger_entries:, description: nil, effective_at: nil, metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class PostedLedgerEntry < ModernTreasury::BaseModel
+        # @!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 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::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry::Direction]
+        required :direction,
+                 enum: -> { ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry::Direction }
+
+        # @!attribute ledger_account_id
+        #   The ledger account that this ledger entry is associated with.
+        #
+        #   @return [String]
+        required :ledger_account_id, String
+
+        # @!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 amount [Integer]
+        #   # @param direction [Symbol, ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry::Direction]
+        #   # @param ledger_account_id [String]
+        #   # @param metadata [Hash{Symbol=>String}]
+        #   #
+        #   def initialize(amount:, direction:, ledger_account_id:, metadata: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        # 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`.
+        module Direction
+          extend ModernTreasury::Enum
+
+          CREDIT = :credit
+          DEBIT = :debit
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end