modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/resources/ledger_accounts.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class LedgerAccounts
+      # Create a ledger account.
+      #
+      # @param params [ModernTreasury::Models::LedgerAccountCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :currency The currency of the ledger account.
+      #
+      #   @option params [String] :ledger_id The id of the ledger that this account belongs to.
+      #
+      #   @option params [String] :name The name of the ledger account.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :normal_balance The normal balance of the ledger account.
+      #
+      #   @option params [Integer, nil] :currency_exponent The currency exponent of the ledger account.
+      #
+      #   @option params [String, nil] :description The description of the ledger account.
+      #
+      #   @option params [Array<String>] :ledger_account_category_ids The array of ledger account category ids that this ledger account should be a
+      #     child of.
+      #
+      #   @option params [String] :ledgerable_id If the ledger account links to another object in Modern Treasury, the id will be
+      #     populated here, otherwise null.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType] :ledgerable_type If the ledger account links to another object in Modern Treasury, the type will
+      #     be populated here, otherwise null. The value is one of internal_account or
+      #     external_account.
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerAccount]
+      #
+      def create(params)
+        parsed, options = ModernTreasury::Models::LedgerAccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/ledger_accounts",
+          body: parsed,
+          model: ModernTreasury::Models::LedgerAccount,
+          options: options
+        )
+      end
+
+      # Get details on a single ledger account.
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::LedgerAccountRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::Models::LedgerAccountRetrieveParams::Balances] :balances Use `balances[effective_at_lower_bound]` and
+      #     `balances[effective_at_upper_bound]` to get the balances change between the two
+      #     timestamps. The lower bound is inclusive while the upper bound is exclusive of
+      #     the provided timestamps. If no value is supplied the balances will be retrieved
+      #     not including that bound. Use `balances[as_of_lock_version]` to retrieve a
+      #     balance as of a specific Ledger Account `lock_version`.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerAccount]
+      #
+      def retrieve(id, params = {})
+        parsed, options = ModernTreasury::Models::LedgerAccountRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/ledger_accounts/%0s", id],
+          query: parsed,
+          model: ModernTreasury::Models::LedgerAccount,
+          options: options
+        )
+      end
+
+      # Update the details of a ledger account.
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::LedgerAccountUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :description The description of the ledger account.
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [String] :name The name of the ledger account.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerAccount]
+      #
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::LedgerAccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/ledger_accounts/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::LedgerAccount,
+          options: options
+        )
+      end
+
+      # Get a list of ledger accounts.
+      #
+      # @param params [ModernTreasury::Models::LedgerAccountListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Array<String>] :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`.
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [ModernTreasury::Models::LedgerAccountListParams::AvailableBalanceAmount] :available_balance_amount Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to
+      #     filter by balance amount.
+      #
+      #   @option params [ModernTreasury::Models::LedgerAccountListParams::Balances] :balances Use `balances[effective_at_lower_bound]` and
+      #     `balances[effective_at_upper_bound]` to get the balances change between the two
+      #     timestamps. The lower bound is inclusive while the upper bound is exclusive of
+      #     the provided timestamps. If no value is supplied the balances will be retrieved
+      #     not including that bound.
+      #
+      #   @option params [Hash{Symbol=>Time}] :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.
+      #
+      #   @option params [String] :currency
+      #
+      #   @option params [String] :ledger_account_category_id
+      #
+      #   @option params [String] :ledger_id
+      #
+      #   @option params [Hash{Symbol=>String}] :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.
+      #
+      #   @option params [Array<String>] :name If you have specific names to retrieve in bulk, you can pass them as query
+      #     parameters delimited with `name[]=`, for example `?name[]=123&name[]=abc`.
+      #
+      #   @option params [ModernTreasury::Models::LedgerAccountListParams::PendingBalanceAmount] :pending_balance_amount Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to
+      #     filter by balance amount.
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [ModernTreasury::Models::LedgerAccountListParams::PostedBalanceAmount] :posted_balance_amount Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to
+      #     filter by balance amount.
+      #
+      #   @option params [Hash{Symbol=>Time}] :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.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerAccount>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::LedgerAccountListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/ledger_accounts",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::LedgerAccount,
+          options: options
+        )
+      end
+
+      # Delete a ledger account.
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::LedgerAccountDeleteParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerAccount]
+      #
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["api/ledger_accounts/%0s", id],
+          model: ModernTreasury::Models::LedgerAccount,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/ledger_entries.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class LedgerEntries
+      # Get details on a single ledger entry.
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::LedgerEntryRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Boolean] :show_balances If true, response will include the balances attached to the ledger entry. If
+      #     there is no balance available, null will be returned instead.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerEntry]
+      #
+      def retrieve(id, params = {})
+        parsed, options = ModernTreasury::Models::LedgerEntryRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/ledger_entries/%0s", id],
+          query: parsed,
+          model: ModernTreasury::Models::LedgerEntry,
+          options: options
+        )
+      end
+
+      # Update the details of a ledger entry.
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::LedgerEntryUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerEntry]
+      #
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::LedgerEntryUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/ledger_entries/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::LedgerEntry,
+          options: options
+        )
+      end
+
+      # Get a list of all ledger entries.
+      #
+      # @param params [ModernTreasury::Models::LedgerEntryListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Array<String>] :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`.
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [Integer] :as_of_lock_version Shows all ledger entries that were present on a ledger account at a particular
+      #     `lock_version`. You must also specify `ledger_account_id`.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :direction 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.
+      #
+      #   @option params [Hash{Symbol=>Time}] :effective_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #     transaction's effective time. Format ISO8601
+      #
+      #   @option params [Hash{Symbol=>Date}] :effective_date Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #     transaction's effective date. Format YYYY-MM-DD
+      #
+      #   @option params [String] :ledger_account_category_id Get all ledger entries that match the direction specified. One of `credit`,
+      #     `debit`.
+      #
+      #   @option params [String] :ledger_account_id
+      #
+      #   @option params [Hash{Symbol=>Integer}] :ledger_account_lock_version 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`.
+      #
+      #   @option params [String] :ledger_account_payout_id
+      #
+      #   @option params [String] :ledger_account_settlement_id
+      #
+      #   @option params [String] :ledger_account_statement_id Get all ledger entries that are included in the ledger account statement.
+      #
+      #   @option params [String] :ledger_transaction_id
+      #
+      #   @option params [Hash{Symbol=>String}] :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.
+      #
+      #   @option params [ModernTreasury::Models::LedgerEntryListParams::OrderBy] :order_by 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.
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [Boolean] :show_balances If true, response will include the balances attached to the ledger entry. If
+      #     there is no balance available, null will be returned instead.
+      #
+      #   @option params [Boolean] :show_deleted 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.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status] :status Get all ledger entries that match the status specified. One of `pending`,
+      #     `posted`, or `archived`.
+      #
+      #   @option params [Hash{Symbol=>Time}] :updated_at 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.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerEntry>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::LedgerEntryListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/ledger_entries",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::LedgerEntry,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/ledger_event_handlers.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class LedgerEventHandlers
+      # create ledger_event_handler
+      #
+      # @param params [ModernTreasury::Models::LedgerEventHandlerCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::Models::LedgerEventHandlerCreateParams::LedgerTransactionTemplate] :ledger_transaction_template
+      #
+      #   @option params [String] :name Name of the ledger event handler.
+      #
+      #   @option params [ModernTreasury::Models::LedgerEventHandlerCreateParams::Conditions, nil] :conditions
+      #
+      #   @option params [String, nil] :description An optional description.
+      #
+      #   @option params [String] :ledger_id The id of the ledger that this account belongs to.
+      #
+      #   @option params [Hash{Symbol=>String}, nil] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [Hash{Symbol=>ModernTreasury::Models::LedgerEventHandlerVariable}, nil] :variables
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerEventHandler]
+      #
+      def create(params)
+        parsed, options = ModernTreasury::Models::LedgerEventHandlerCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/ledger_event_handlers",
+          body: parsed,
+          model: ModernTreasury::Models::LedgerEventHandler,
+          options: options
+        )
+      end
+
+      # Get details on a single ledger event handler.
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::LedgerEventHandlerRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerEventHandler]
+      #
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/ledger_event_handlers/%0s", id],
+          model: ModernTreasury::Models::LedgerEventHandler,
+          options: params[:request_options]
+        )
+      end
+
+      # Get a list of ledger event handlers.
+      #
+      # @param params [ModernTreasury::Models::LedgerEventHandlerListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [Hash{Symbol=>Time}] :created_at 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
+      #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
+      #
+      #   @option params [Hash{Symbol=>String}] :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.
+      #
+      #   @option params [String] :name
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerEventHandler>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::LedgerEventHandlerListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/ledger_event_handlers",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::LedgerEventHandler,
+          options: options
+        )
+      end
+
+      # Archive a ledger event handler.
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::LedgerEventHandlerDeleteParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::LedgerEventHandler]
+      #
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["api/ledger_event_handlers/%0s", id],
+          model: ModernTreasury::Models::LedgerEventHandler,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/ledger_transactions/versions.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class LedgerTransactions
+      class Versions
+        # Get a list of ledger transaction versions.
+        #
+        # @param params [ModernTreasury::Models::LedgerTransactions::VersionListParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [String, nil] :after_cursor
+        #
+        #   @option params [Hash{Symbol=>Time}] :created_at Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        #     created_at timestamp. For example, for all dates after Jan 1 2000 12:00 UTC, use
+        #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
+        #
+        #   @option params [String] :ledger_account_statement_id Get all ledger transaction versions that are included in the ledger account
+        #     statement.
+        #
+        #   @option params [String] :ledger_transaction_id Get all the ledger transaction versions corresponding to the ID of a ledger
+        #     transaction.
+        #
+        #   @option params [Integer] :per_page
+        #
+        #   @option params [Hash{Symbol=>Integer}] :version Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        #     version. For example, for all versions after 2, use version%5Bgt%5D=2.
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [ModernTreasury::Page<ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion>]
+        #
+        def list(params = {})
+          parsed, options = ModernTreasury::Models::LedgerTransactions::VersionListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "api/ledger_transaction_versions",
+            query: parsed,
+            page: ModernTreasury::Page,
+            model: ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion,
+            options: options
+          )
+        end
+
+        # @param client [ModernTreasury::Client]
+        #
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end