modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/models/ledger_account_settlement.rbi

@@ -0,0 +1,169 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlement < ModernTreasury::BaseModel
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The amount of the ledger account settlement.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :amount
+
+      # The id of the contra ledger account that sends to or receives funds from the
+      #   settled ledger account.
+      sig { returns(String) }
+      attr_accessor :contra_ledger_account_id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The currency of the ledger account settlement.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # The currency exponent of the ledger account settlement.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :currency_exponent
+
+      # The description of the ledger account settlement.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #   be included in the ledger account settlement. The default value is the
+      #   created_at timestamp of the ledger account settlement.
+      sig { returns(Time) }
+      attr_accessor :effective_at_upper_bound
+
+      # The id of the ledger that this ledger account settlement belongs to.
+      sig { returns(String) }
+      attr_accessor :ledger_id
+
+      # The id of the ledger transaction that this settlement is associated with.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ledger_transaction_id
+
+      # This field will be true if this object exists in the live environment or false
+      #   if it exists in the test environment.
+      sig { returns(T::Boolean) }
+      attr_accessor :live_mode
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      #   strings.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
+      sig { returns(String) }
+      attr_accessor :object
+
+      # The id of the settled ledger account whose ledger entries are queried against,
+      #   and its balance is reduced as a result.
+      sig { returns(String) }
+      attr_accessor :settled_ledger_account_id
+
+      # The direction of the ledger entry with the settlement_ledger_account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :settlement_entry_direction
+
+      # The status of the ledger account settlement. One of `processing`, `pending`,
+      #   `posted`, `archiving` or `archived`.
+      sig { returns(ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      sig do
+        params(
+          id: String,
+          amount: T.nilable(Integer),
+          contra_ledger_account_id: String,
+          created_at: Time,
+          currency: String,
+          currency_exponent: T.nilable(Integer),
+          description: T.nilable(String),
+          effective_at_upper_bound: Time,
+          ledger_id: String,
+          ledger_transaction_id: T.nilable(String),
+          live_mode: T::Boolean,
+          metadata: T::Hash[Symbol, String],
+          object: String,
+          settled_ledger_account_id: String,
+          settlement_entry_direction: T.nilable(String),
+          status: ModernTreasury::Models::LedgerAccountSettlement::Status::OrSymbol,
+          updated_at: Time
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        amount:,
+        contra_ledger_account_id:,
+        created_at:,
+        currency:,
+        currency_exponent:,
+        description:,
+        effective_at_upper_bound:,
+        ledger_id:,
+        ledger_transaction_id:,
+        live_mode:,
+        metadata:,
+        object:,
+        settled_ledger_account_id:,
+        settlement_entry_direction:,
+        status:,
+        updated_at:
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              amount: T.nilable(Integer),
+              contra_ledger_account_id: String,
+              created_at: Time,
+              currency: String,
+              currency_exponent: T.nilable(Integer),
+              description: T.nilable(String),
+              effective_at_upper_bound: Time,
+              ledger_id: String,
+              ledger_transaction_id: T.nilable(String),
+              live_mode: T::Boolean,
+              metadata: T::Hash[Symbol, String],
+              object: String,
+              settled_ledger_account_id: String,
+              settlement_entry_direction: T.nilable(String),
+              status: ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol,
+              updated_at: Time
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # The status of the ledger account settlement. One of `processing`, `pending`,
+      #   `posted`, `archiving` or `archived`.
+      module Status
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccountSettlement::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol) }
+
+        ARCHIVED = T.let(:archived, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
+        ARCHIVING = T.let(:archiving, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
+        DRAFTING = T.let(:drafting, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
+        PENDING = T.let(:pending, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
+        POSTED = T.let(:posted, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
+        PROCESSING = T.let(:processing, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_account_settlement_create_params.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementCreateParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # The id of the contra ledger account that sends to or receives funds from the
+      #   settled ledger account.
+      sig { returns(String) }
+      attr_accessor :contra_ledger_account_id
+
+      # The id of the settled ledger account whose ledger entries are queried against,
+      #   and its balance is reduced as a result.
+      sig { returns(String) }
+      attr_accessor :settled_ledger_account_id
+
+      # If true, the settlement amount and settlement_entry_direction will bring the
+      #   settlement ledger account's balance closer to zero, even if the balance is
+      #   negative.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :allow_either_direction
+
+      # The description of the ledger account settlement.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #   be included in the ledger account settlement. The default value is the
+      #   created_at timestamp of the ledger account settlement.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :effective_at_upper_bound
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      #   strings.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # It is set to `false` by default. It should be set to `true` when migrating
+      #   existing settlements.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :skip_settlement_ledger_transaction
+
+      # The status of the ledger account settlement. It is set to `pending` by default.
+      #   To post a ledger account settlement at creation, use `posted`.
+      sig { returns(T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol)) }
+      attr_accessor :status
+
+      sig do
+        params(
+          contra_ledger_account_id: String,
+          settled_ledger_account_id: String,
+          allow_either_direction: T.nilable(T::Boolean),
+          description: T.nilable(String),
+          effective_at_upper_bound: T.nilable(Time),
+          metadata: T::Hash[Symbol, String],
+          skip_settlement_ledger_transaction: T.nilable(T::Boolean),
+          status: T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol),
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        contra_ledger_account_id:,
+        settled_ledger_account_id:,
+        allow_either_direction: nil,
+        description: nil,
+        effective_at_upper_bound: nil,
+        metadata: nil,
+        skip_settlement_ledger_transaction: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              contra_ledger_account_id: String,
+              settled_ledger_account_id: String,
+              allow_either_direction: T.nilable(T::Boolean),
+              description: T.nilable(String),
+              effective_at_upper_bound: T.nilable(Time),
+              metadata: T::Hash[Symbol, String],
+              skip_settlement_ledger_transaction: T.nilable(T::Boolean),
+              status: T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol),
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # The status of the ledger account settlement. It is set to `pending` by default.
+      #   To post a ledger account settlement at creation, use `posted`.
+      module Status
+        extend ModernTreasury::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol) }
+
+        PENDING =
+          T.let(:pending, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol)
+        POSTED =
+          T.let(:posted, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol)
+
+        sig do
+          override
+            .returns(T::Array[ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_account_settlement_list_params.rbi

@@ -0,0 +1,130 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementListParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # If you have specific IDs to retrieve in bulk, you can pass them as query
+      #   parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :id
+
+      sig { params(id: T::Array[String]).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after_cursor
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #   created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+      #   created_at%5Bgt%5D=2000-01-01T12:00:00Z.
+      sig { returns(T.nilable(T::Hash[Symbol, Time])) }
+      attr_reader :created_at
+
+      sig { params(created_at: T::Hash[Symbol, Time]).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :ledger_id
+
+      sig { params(ledger_id: String).void }
+      attr_writer :ledger_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :ledger_transaction_id
+
+      sig { params(ledger_transaction_id: String).void }
+      attr_writer :ledger_transaction_id
+
+      # For example, if you want to query for records with metadata key `Type` and value
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :settled_ledger_account_id
+
+      sig { params(settled_ledger_account_id: String).void }
+      attr_writer :settled_ledger_account_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :settlement_entry_direction
+
+      sig { params(settlement_entry_direction: String).void }
+      attr_writer :settlement_entry_direction
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #   updated at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+      #   updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
+      sig { returns(T.nilable(T::Hash[Symbol, Time])) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: T::Hash[Symbol, Time]).void }
+      attr_writer :updated_at
+
+      sig do
+        params(
+          id: T::Array[String],
+          after_cursor: T.nilable(String),
+          created_at: T::Hash[Symbol, Time],
+          ledger_id: String,
+          ledger_transaction_id: String,
+          metadata: T::Hash[Symbol, String],
+          per_page: Integer,
+          settled_ledger_account_id: String,
+          settlement_entry_direction: String,
+          updated_at: T::Hash[Symbol, Time],
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        id: nil,
+        after_cursor: nil,
+        created_at: nil,
+        ledger_id: nil,
+        ledger_transaction_id: nil,
+        metadata: nil,
+        per_page: nil,
+        settled_ledger_account_id: nil,
+        settlement_entry_direction: nil,
+        updated_at: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              id: T::Array[String],
+              after_cursor: T.nilable(String),
+              created_at: T::Hash[Symbol, Time],
+              ledger_id: String,
+              ledger_transaction_id: String,
+              metadata: T::Hash[Symbol, String],
+              per_page: Integer,
+              settled_ledger_account_id: String,
+              settlement_entry_direction: String,
+              updated_at: T::Hash[Symbol, Time],
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_account_settlement_retrieve_params.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementRetrieveParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      sig do
+        params(request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({request_options: ModernTreasury::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_account_settlement_update_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementUpdateParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # The description of the ledger account settlement.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      #   strings.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # To post a pending ledger account settlement, use `posted`. To archive a pending
+      #   ledger transaction, use `archived`.
+      sig { returns(T.nilable(ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig { params(status: ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::OrSymbol).void }
+      attr_writer :status
+
+      sig do
+        params(
+          description: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          status: ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::OrSymbol,
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(description: nil, metadata: nil, status: nil, request_options: {})
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              description: T.nilable(String),
+              metadata: T::Hash[Symbol, String],
+              status: ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::OrSymbol,
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # To post a pending ledger account settlement, use `posted`. To archive a pending
+      #   ledger transaction, use `archived`.
+      module Status
+        extend ModernTreasury::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::TaggedSymbol) }
+
+        POSTED =
+          T.let(:posted, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::TaggedSymbol)
+        ARCHIVED =
+          T.let(:archived, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::TaggedSymbol)
+
+        sig do
+          override
+            .returns(T::Array[ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_account_settlements/account_entry_delete_params.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module LedgerAccountSettlements
+      class AccountEntryDeleteParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        # The ids of the ledger entries that are to be added or removed from the ledger
+        #   account settlement.
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_accessor :ledger_entry_ids
+
+        sig do
+          params(
+            ledger_entry_ids: T.nilable(T::Array[T.anything]),
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(ledger_entry_ids:, request_options: {})
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                ledger_entry_ids: T.nilable(T::Array[T.anything]),
+                request_options: ModernTreasury::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module LedgerAccountSettlements
+      class AccountEntryUpdateParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        # The ids of the ledger entries that are to be added or removed from the ledger
+        #   account settlement.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :ledger_entry_ids
+
+        sig do
+          params(
+            ledger_entry_ids: T.nilable(T::Array[String]),
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(ledger_entry_ids:, request_options: {})
+        end
+
+        sig do
+          override
+            .returns({
+                       ledger_entry_ids: T.nilable(T::Array[String]),
+                       request_options: ModernTreasury::RequestOptions
+                     })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_account_statement_create_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountStatementCreateParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # The inclusive lower bound of the effective_at timestamp of the ledger entries to
+      #   be included in the ledger account statement.
+      sig { returns(Time) }
+      attr_accessor :effective_at_lower_bound
+
+      # The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #   be included in the ledger account statement.
+      sig { returns(Time) }
+      attr_accessor :effective_at_upper_bound
+
+      # The id of the ledger account whose ledger entries are queried against, and its
+      #   balances are computed as a result.
+      sig { returns(String) }
+      attr_accessor :ledger_account_id
+
+      # The description of the ledger account statement.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      #   strings.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig do
+        params(
+          effective_at_lower_bound: Time,
+          effective_at_upper_bound: Time,
+          ledger_account_id: String,
+          description: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        effective_at_lower_bound:,
+        effective_at_upper_bound:,
+        ledger_account_id:,
+        description: nil,
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              effective_at_lower_bound: Time,
+              effective_at_upper_bound: Time,
+              ledger_account_id: String,
+              description: T.nilable(String),
+              metadata: T::Hash[Symbol, String],
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end