modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/models/ledger_entry_list_params.rbi

@@ -0,0 +1,342 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerEntryListParams < 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
+
+      # Shows all ledger entries that were present on a ledger account at a particular
+      #   `lock_version`. You must also specify `ledger_account_id`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :as_of_lock_version
+
+      sig { params(as_of_lock_version: Integer).void }
+      attr_writer :as_of_lock_version
+
+      # If true, response will include ledger entries that were deleted. When you update
+      #   a ledger transaction to specify a new set of entries, the previous entries are
+      #   deleted.
+      sig { returns(T.nilable(ModernTreasury::Models::TransactionDirection::OrSymbol)) }
+      attr_reader :direction
+
+      sig { params(direction: ModernTreasury::Models::TransactionDirection::OrSymbol).void }
+      attr_writer :direction
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #   transaction's effective time. Format ISO8601
+      sig { returns(T.nilable(T::Hash[Symbol, Time])) }
+      attr_reader :effective_at
+
+      sig { params(effective_at: T::Hash[Symbol, Time]).void }
+      attr_writer :effective_at
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #   transaction's effective date. Format YYYY-MM-DD
+      sig { returns(T.nilable(T::Hash[Symbol, Date])) }
+      attr_reader :effective_date
+
+      sig { params(effective_date: T::Hash[Symbol, Date]).void }
+      attr_writer :effective_date
+
+      # Get all ledger entries that match the direction specified. One of `credit`,
+      #   `debit`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :ledger_account_category_id
+
+      sig { params(ledger_account_category_id: String).void }
+      attr_writer :ledger_account_category_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :ledger_account_id
+
+      sig { params(ledger_account_id: String).void }
+      attr_writer :ledger_account_id
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #   lock_version of a ledger account. For example, for all entries created at or
+      #   before before lock_version 1000 of a ledger account, use
+      #   `ledger_account_lock_version%5Blte%5D=1000`.
+      sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
+      attr_reader :ledger_account_lock_version
+
+      sig { params(ledger_account_lock_version: T::Hash[Symbol, Integer]).void }
+      attr_writer :ledger_account_lock_version
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :ledger_account_payout_id
+
+      sig { params(ledger_account_payout_id: String).void }
+      attr_writer :ledger_account_payout_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :ledger_account_settlement_id
+
+      sig { params(ledger_account_settlement_id: String).void }
+      attr_writer :ledger_account_settlement_id
+
+      # Get all ledger entries that are included in the ledger account statement.
+      sig { returns(T.nilable(String)) }
+      attr_reader :ledger_account_statement_id
+
+      sig { params(ledger_account_statement_id: String).void }
+      attr_writer :ledger_account_statement_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
+
+      # Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
+      #   to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+      #   by only one field at a time is supported.
+      sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::OrderBy)) }
+      attr_reader :order_by
+
+      sig do
+        params(
+          order_by: T.any(ModernTreasury::Models::LedgerEntryListParams::OrderBy, ModernTreasury::Util::AnyHash)
+        )
+          .void
+      end
+      attr_writer :order_by
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # If true, response will include the balances attached to the ledger entry. If
+      #   there is no balance available, null will be returned instead.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :show_balances
+
+      sig { params(show_balances: T::Boolean).void }
+      attr_writer :show_balances
+
+      # If true, response will include ledger entries that were deleted. When you update
+      #   a ledger transaction to specify a new set of entries, the previous entries are
+      #   deleted.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :show_deleted
+
+      sig { params(show_deleted: T::Boolean).void }
+      attr_writer :show_deleted
+
+      # Get all ledger entries that match the status specified. One of `pending`,
+      #   `posted`, or `archived`.
+      sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig { params(status: ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol).void }
+      attr_writer :status
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #   posted 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),
+          as_of_lock_version: Integer,
+          direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
+          effective_at: T::Hash[Symbol, Time],
+          effective_date: T::Hash[Symbol, Date],
+          ledger_account_category_id: String,
+          ledger_account_id: String,
+          ledger_account_lock_version: T::Hash[Symbol, Integer],
+          ledger_account_payout_id: String,
+          ledger_account_settlement_id: String,
+          ledger_account_statement_id: String,
+          ledger_transaction_id: String,
+          metadata: T::Hash[Symbol, String],
+          order_by: T.any(ModernTreasury::Models::LedgerEntryListParams::OrderBy, ModernTreasury::Util::AnyHash),
+          per_page: Integer,
+          show_balances: T::Boolean,
+          show_deleted: T::Boolean,
+          status: ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol,
+          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,
+        as_of_lock_version: nil,
+        direction: nil,
+        effective_at: nil,
+        effective_date: nil,
+        ledger_account_category_id: nil,
+        ledger_account_id: nil,
+        ledger_account_lock_version: nil,
+        ledger_account_payout_id: nil,
+        ledger_account_settlement_id: nil,
+        ledger_account_statement_id: nil,
+        ledger_transaction_id: nil,
+        metadata: nil,
+        order_by: nil,
+        per_page: nil,
+        show_balances: nil,
+        show_deleted: nil,
+        status: nil,
+        updated_at: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              id: T::Array[String],
+              after_cursor: T.nilable(String),
+              as_of_lock_version: Integer,
+              direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
+              effective_at: T::Hash[Symbol, Time],
+              effective_date: T::Hash[Symbol, Date],
+              ledger_account_category_id: String,
+              ledger_account_id: String,
+              ledger_account_lock_version: T::Hash[Symbol, Integer],
+              ledger_account_payout_id: String,
+              ledger_account_settlement_id: String,
+              ledger_account_statement_id: String,
+              ledger_transaction_id: String,
+              metadata: T::Hash[Symbol, String],
+              order_by: ModernTreasury::Models::LedgerEntryListParams::OrderBy,
+              per_page: Integer,
+              show_balances: T::Boolean,
+              show_deleted: T::Boolean,
+              status: ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol,
+              updated_at: T::Hash[Symbol, Time],
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class OrderBy < ModernTreasury::BaseModel
+        sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol)) }
+        attr_reader :created_at
+
+        sig { params(created_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol)) }
+        attr_reader :effective_at
+
+        sig { params(effective_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol).void }
+        attr_writer :effective_at
+
+        # Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
+        #   to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+        #   by only one field at a time is supported.
+        sig do
+          params(
+            created_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol,
+            effective_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(created_at: nil, effective_at: nil)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                created_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol,
+                effective_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module CreatedAt
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol) }
+
+          ASC = T.let(:asc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol)
+          DESC = T.let(:desc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol)
+
+          sig do
+            override.returns(T::Array[ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol])
+          end
+          def self.values
+          end
+        end
+
+        module EffectiveAt
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol) }
+
+          ASC = T.let(:asc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol)
+          DESC = T.let(:desc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol)
+
+          sig do
+            override
+              .returns(T::Array[ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol])
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Get all ledger entries that match the status specified. One of `pending`,
+      #   `posted`, or `archived`.
+      module Status
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntryListParams::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol) }
+
+        PENDING = T.let(:pending, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol)
+        POSTED = T.let(:posted, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol)
+        ARCHIVED = T.let(:archived, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_entry_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerEntryRetrieveParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # If true, response will include the balances attached to the ledger entry. If
+      #   there is no balance available, null will be returned instead.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :show_balances
+
+      sig { params(show_balances: T::Boolean).void }
+      attr_writer :show_balances
+
+      sig do
+        params(
+          show_balances: T::Boolean,
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(show_balances: nil, request_options: {})
+      end
+
+      sig { override.returns({show_balances: T::Boolean, request_options: ModernTreasury::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_entry_update_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerEntryUpdateParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # 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(
+          metadata: T::Hash[Symbol, String],
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(metadata: nil, request_options: {})
+      end
+
+      sig do
+        override.returns({metadata: T::Hash[Symbol, String], request_options: ModernTreasury::RequestOptions})
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/ledger_event_handler.rbi

@@ -0,0 +1,231 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerEventHandler < ModernTreasury::BaseModel
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T.nilable(ModernTreasury::Models::LedgerEventHandler::Conditions)) }
+      attr_reader :conditions
+
+      sig do
+        params(
+          conditions: T.nilable(T.any(ModernTreasury::Models::LedgerEventHandler::Conditions, ModernTreasury::Util::AnyHash))
+        )
+          .void
+      end
+      attr_writer :conditions
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # An optional description.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :discarded_at
+
+      # The id of the ledger that this event handler belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ledger_id
+
+      sig { returns(ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate) }
+      attr_reader :ledger_transaction_template
+
+      sig do
+        params(
+          ledger_transaction_template: T.any(
+            ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate,
+            ModernTreasury::Util::AnyHash
+          )
+        )
+          .void
+      end
+      attr_writer :ledger_transaction_template
+
+      # 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.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # Name of the ledger event handler.
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(String) }
+      attr_accessor :object
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      sig { returns(T.nilable(T::Hash[Symbol, ModernTreasury::Models::LedgerEventHandlerVariable])) }
+      attr_accessor :variables
+
+      sig do
+        params(
+          id: String,
+          conditions: T.nilable(T.any(ModernTreasury::Models::LedgerEventHandler::Conditions, ModernTreasury::Util::AnyHash)),
+          created_at: Time,
+          description: T.nilable(String),
+          discarded_at: T.nilable(Time),
+          ledger_id: T.nilable(String),
+          ledger_transaction_template: T.any(
+            ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate,
+            ModernTreasury::Util::AnyHash
+          ),
+          live_mode: T::Boolean,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          name: String,
+          object: String,
+          updated_at: Time,
+          variables: T.nilable(
+            T::Hash[Symbol, T.any(ModernTreasury::Models::LedgerEventHandlerVariable, ModernTreasury::Util::AnyHash)]
+          )
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        conditions:,
+        created_at:,
+        description:,
+        discarded_at:,
+        ledger_id:,
+        ledger_transaction_template:,
+        live_mode:,
+        metadata:,
+        name:,
+        object:,
+        updated_at:,
+        variables:
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              conditions: T.nilable(ModernTreasury::Models::LedgerEventHandler::Conditions),
+              created_at: Time,
+              description: T.nilable(String),
+              discarded_at: T.nilable(Time),
+              ledger_id: T.nilable(String),
+              ledger_transaction_template: ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate,
+              live_mode: T::Boolean,
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              name: String,
+              object: String,
+              updated_at: Time,
+              variables: T.nilable(T::Hash[Symbol, ModernTreasury::Models::LedgerEventHandlerVariable])
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class Conditions < ModernTreasury::BaseModel
+        # The LHS of the conditional.
+        sig { returns(String) }
+        attr_accessor :field
+
+        # What the operator between the `field` and `value` is.
+        sig { returns(String) }
+        attr_accessor :operator
+
+        # The RHS of the conditional.
+        sig { returns(String) }
+        attr_accessor :value
+
+        sig { params(field: String, operator: String, value: String).returns(T.attached_class) }
+        def self.new(field:, operator:, value:)
+        end
+
+        sig { override.returns({field: String, operator: String, value: String}) }
+        def to_hash
+        end
+      end
+
+      class LedgerTransactionTemplate < ModernTreasury::BaseModel
+        # An optional description for internal use.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The timestamp (ISO8601 format) at which the ledger transaction happened for
+        #   reporting purposes.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :effective_at
+
+        # An array of ledger entry objects.
+        sig { returns(T::Array[ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry]) }
+        attr_accessor :ledger_entries
+
+        # To post a ledger transaction at creation, use `posted`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :status
+
+        sig do
+          params(
+            description: T.nilable(String),
+            effective_at: T.nilable(String),
+            ledger_entries: T::Array[
+            T.any(
+              ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry,
+              ModernTreasury::Util::AnyHash
+            )
+            ],
+            status: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(description:, effective_at:, ledger_entries:, status:)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                description: T.nilable(String),
+                effective_at: T.nilable(String),
+                ledger_entries: T::Array[ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry],
+                status: T.nilable(String)
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class LedgerEntry < ModernTreasury::BaseModel
+          # The LHS of the conditional.
+          sig { returns(String) }
+          attr_accessor :amount
+
+          # What the operator between the `field` and `value` is.
+          sig { returns(String) }
+          attr_accessor :direction
+
+          # The RHS of the conditional.
+          sig { returns(String) }
+          attr_accessor :ledger_account_id
+
+          sig do
+            params(amount: String, direction: String, ledger_account_id: String).returns(T.attached_class)
+          end
+          def self.new(amount:, direction:, ledger_account_id:)
+          end
+
+          sig { override.returns({amount: String, direction: String, ledger_account_id: String}) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end