modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/ledger_account_settlement.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlement < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The amount of the ledger account settlement.
+      #
+      #   @return [Integer, nil]
+      required :amount, Integer, nil?: true
+
+      # @!attribute contra_ledger_account_id
+      #   The id of the contra ledger account that sends to or receives funds from the
+      #     settled ledger account.
+      #
+      #   @return [String]
+      required :contra_ledger_account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the ledger account settlement.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute currency_exponent
+      #   The currency exponent of the ledger account settlement.
+      #
+      #   @return [Integer, nil]
+      required :currency_exponent, Integer, nil?: true
+
+      # @!attribute description
+      #   The description of the ledger account settlement.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute effective_at_upper_bound
+      #   The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #     be included in the ledger account settlement. The default value is the
+      #     created_at timestamp of the ledger account settlement.
+      #
+      #   @return [Time]
+      required :effective_at_upper_bound, Time
+
+      # @!attribute ledger_id
+      #   The id of the ledger that this ledger account settlement belongs to.
+      #
+      #   @return [String]
+      required :ledger_id, String
+
+      # @!attribute ledger_transaction_id
+      #   The id of the ledger transaction that this settlement is associated with.
+      #
+      #   @return [String, nil]
+      required :ledger_transaction_id, String, 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 settled_ledger_account_id
+      #   The id of the settled ledger account whose ledger entries are queried against,
+      #     and its balance is reduced as a result.
+      #
+      #   @return [String]
+      required :settled_ledger_account_id, String
+
+      # @!attribute settlement_entry_direction
+      #   The direction of the ledger entry with the settlement_ledger_account.
+      #
+      #   @return [String, nil]
+      required :settlement_entry_direction, String, nil?: true
+
+      # @!attribute status
+      #   The status of the ledger account settlement. One of `processing`, `pending`,
+      #     `posted`, `archiving` or `archived`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerAccountSettlement::Status]
+      required :status, enum: -> { ModernTreasury::Models::LedgerAccountSettlement::Status }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param amount [Integer, nil]
+      #   # @param contra_ledger_account_id [String]
+      #   # @param created_at [Time]
+      #   # @param currency [String]
+      #   # @param currency_exponent [Integer, nil]
+      #   # @param description [String, nil]
+      #   # @param effective_at_upper_bound [Time]
+      #   # @param ledger_id [String]
+      #   # @param ledger_transaction_id [String, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param object [String]
+      #   # @param settled_ledger_account_id [String]
+      #   # @param settlement_entry_direction [String, nil]
+      #   # @param status [Symbol, ModernTreasury::Models::LedgerAccountSettlement::Status]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     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:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # The status of the ledger account settlement. One of `processing`, `pending`,
+      #   `posted`, `archiving` or `archived`.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :archived
+      #   # ...
+      # in :archiving
+      #   # ...
+      # in :drafting
+      #   # ...
+      # in :pending
+      #   # ...
+      # in :posted
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        ARCHIVED = :archived
+        ARCHIVING = :archiving
+        DRAFTING = :drafting
+        PENDING = :pending
+        POSTED = :posted
+        PROCESSING = :processing
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_settlement_create_params.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute contra_ledger_account_id
+      #   The id of the contra ledger account that sends to or receives funds from the
+      #     settled ledger account.
+      #
+      #   @return [String]
+      required :contra_ledger_account_id, String
+
+      # @!attribute settled_ledger_account_id
+      #   The id of the settled ledger account whose ledger entries are queried against,
+      #     and its balance is reduced as a result.
+      #
+      #   @return [String]
+      required :settled_ledger_account_id, String
+
+      # @!attribute allow_either_direction
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :allow_either_direction, ModernTreasury::BooleanModel, nil?: true
+
+      # @!attribute description
+      #   The description of the ledger account settlement.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute effective_at_upper_bound
+      #   The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #     be included in the ledger account settlement. The default value is the
+      #     created_at timestamp of the ledger account settlement.
+      #
+      #   @return [Time, nil]
+      optional :effective_at_upper_bound, Time, 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 skip_settlement_ledger_transaction
+      #   It is set to `false` by default. It should be set to `true` when migrating
+      #     existing settlements.
+      #
+      #   @return [Boolean, nil]
+      optional :skip_settlement_ledger_transaction, ModernTreasury::BooleanModel, nil?: true
+
+      # @!attribute status
+      #   The status of the ledger account settlement. It is set to `pending` by default.
+      #     To post a ledger account settlement at creation, use `posted`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status, nil]
+      optional :status,
+               enum: -> { ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status },
+               nil?: true
+
+      # @!parse
+      #   # @param contra_ledger_account_id [String]
+      #   # @param settled_ledger_account_id [String]
+      #   # @param allow_either_direction [Boolean, nil]
+      #   # @param description [String, nil]
+      #   # @param effective_at_upper_bound [Time, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param skip_settlement_ledger_transaction [Boolean, nil]
+      #   # @param status [Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status, nil]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     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: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # The status of the ledger account settlement. It is set to `pending` by default.
+      #   To post a ledger account settlement at creation, use `posted`.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :pending
+      #   # ...
+      # in :posted
+      #   # ...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        PENDING = :pending
+        POSTED = :posted
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_settlement_list_params.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] id
+      #   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`.
+      #
+      #   @return [Array<String>, nil]
+      optional :id, ModernTreasury::ArrayOf[String]
+
+      # @!parse
+      #   # @return [Array<String>]
+      #   attr_writer :id
+
+      # @!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 times 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_id
+      #
+      #   @return [String, nil]
+      optional :ledger_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_id
+
+      # @!attribute [r] ledger_transaction_id
+      #
+      #   @return [String, nil]
+      optional :ledger_transaction_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_transaction_id
+
+      # @!attribute [r] metadata
+      #   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.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] settled_ledger_account_id
+      #
+      #   @return [String, nil]
+      optional :settled_ledger_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :settled_ledger_account_id
+
+      # @!attribute [r] settlement_entry_direction
+      #
+      #   @return [String, nil]
+      optional :settlement_entry_direction, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :settlement_entry_direction
+
+      # @!attribute [r] updated_at
+      #   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.
+      #
+      #   @return [Hash{Symbol=>Time}, nil]
+      optional :updated_at, ModernTreasury::HashOf[Time]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>Time}]
+      #   attr_writer :updated_at
+
+      # @!parse
+      #   # @param id [Array<String>]
+      #   # @param after_cursor [String, nil]
+      #   # @param created_at [Hash{Symbol=>Time}]
+      #   # @param ledger_id [String]
+      #   # @param ledger_transaction_id [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param per_page [Integer]
+      #   # @param settled_ledger_account_id [String]
+      #   # @param settlement_entry_direction [String]
+      #   # @param updated_at [Hash{Symbol=>Time}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     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: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_settlement_retrieve_params.rb

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute description
+      #   The description of the ledger account settlement.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute [r] status
+      #   To post a pending ledger account settlement, use `posted`. To archive a pending
+      #     ledger transaction, use `archived`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status, nil]
+      optional :status, enum: -> { ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param description [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param status [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(description: nil, metadata: nil, status: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # To post a pending ledger account settlement, use `posted`. To archive a pending
+      #   ledger transaction, use `archived`.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :posted
+      #   # ...
+      # in :archived
+      #   # ...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        POSTED = :posted
+        ARCHIVED = :archived
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    module LedgerAccountSettlements
+      class AccountEntryDeleteParams < ModernTreasury::BaseModel
+        # @!parse
+        #   extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        # @!attribute ledger_entry_ids
+        #   The ids of the ledger entries that are to be added or removed from the ledger
+        #     account settlement.
+        #
+        #   @return [Array<Object>, nil]
+        required :ledger_entry_ids, ModernTreasury::ArrayOf[ModernTreasury::Unknown], nil?: true
+
+        # @!parse
+        #   # @param ledger_entry_ids [Array<Object>, nil]
+        #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(ledger_entry_ids:, request_options: {}, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    module LedgerAccountSettlements
+      class AccountEntryUpdateParams < ModernTreasury::BaseModel
+        # @!parse
+        #   extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        # @!attribute ledger_entry_ids
+        #   The ids of the ledger entries that are to be added or removed from the ledger
+        #     account settlement.
+        #
+        #   @return [Array<String>, nil]
+        required :ledger_entry_ids, ModernTreasury::ArrayOf[String], nil?: true
+
+        # @!parse
+        #   # @param ledger_entry_ids [Array<String>, nil]
+        #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(ledger_entry_ids:, request_options: {}, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_statement_create_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountStatementCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute effective_at_lower_bound
+      #   The inclusive lower bound of the effective_at timestamp of the ledger entries to
+      #     be included in the ledger account statement.
+      #
+      #   @return [Time]
+      required :effective_at_lower_bound, Time
+
+      # @!attribute effective_at_upper_bound
+      #   The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #     be included in the ledger account statement.
+      #
+      #   @return [Time]
+      required :effective_at_upper_bound, Time
+
+      # @!attribute ledger_account_id
+      #   The id of the ledger account whose ledger entries are queried against, and its
+      #     balances are computed as a result.
+      #
+      #   @return [String]
+      required :ledger_account_id, String
+
+      # @!attribute description
+      #   The description of the ledger account statement.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!parse
+      #   # @param effective_at_lower_bound [Time]
+      #   # @param effective_at_upper_bound [Time]
+      #   # @param ledger_account_id [String]
+      #   # @param description [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     effective_at_lower_bound:,
+      #     effective_at_upper_bound:,
+      #     ledger_account_id:,
+      #     description: nil,
+      #     metadata: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end