modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountBalanceMonitorCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute alert_condition
+      #   Describes the condition that must be satisfied for the monitor to be triggered.
+      #
+      #   @return [ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition]
+      required :alert_condition,
+               -> { ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition }
+
+      # @!attribute ledger_account_id
+      #   The ledger account associated with this balance monitor.
+      #
+      #   @return [String]
+      required :ledger_account_id, String
+
+      # @!attribute [r] description
+      #   An optional, free-form description for internal use.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :description
+
+      # @!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 alert_condition [ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition]
+      #   # @param ledger_account_id [String]
+      #   # @param description [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(alert_condition:, ledger_account_id:, description: nil, metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class AlertCondition < ModernTreasury::BaseModel
+        # @!attribute field
+        #   One of `available_balance_amount`, `pending_balance_amount`,
+        #     `posted_balance_amount`, `ledger_account_lock_version`.
+        #
+        #   @return [String]
+        required :field, String
+
+        # @!attribute operator
+        #   A logical operator to compare the `field` against the `value`. One of
+        #     `less_than`, `less_than_or_equals`, `equals`, `greater_than_or_equals`,
+        #     `greater_than`.
+        #
+        #   @return [String]
+        required :operator, String
+
+        # @!attribute value
+        #   The monitor's `current_ledger_account_balance_state.triggered` will be `true`
+        #     when comparing the `field` to this integer value using the `operator` is
+        #     logically true.
+        #
+        #   @return [Integer]
+        required :value, Integer
+
+        # @!parse
+        #   # Describes the condition that must be satisfied for the monitor to be triggered.
+        #   #
+        #   # @param field [String]
+        #   # @param operator [String]
+        #   # @param value [Integer]
+        #   #
+        #   def initialize(field:, operator:, value:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_balance_monitor_delete_params.rb

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountBalanceMonitorListParams < 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] ledger_account_id
+      #   Query the balance monitors for a single ledger account.
+      #
+      #   @return [String, nil]
+      optional :ledger_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_account_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
+
+      # @!parse
+      #   # @param id [Array<String>]
+      #   # @param after_cursor [String, nil]
+      #   # @param ledger_account_id [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param per_page [Integer]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(id: nil, after_cursor: nil, ledger_account_id: nil, metadata: nil, per_page: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rb

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountBalanceMonitorUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] description
+      #   An optional, free-form description for internal use.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :description
+
+      # @!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 description [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(description: nil, metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_category.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategory < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute balances
+      #   The pending, posted, and available balances for this ledger account category.
+      #     The posted balance is the sum of all posted entries on the account. The pending
+      #     balance is the sum of all pending and posted entries on the account. The
+      #     available balance is the posted incoming entries minus the sum of the pending
+      #     and posted outgoing amounts.
+      #
+      #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances]
+      required :balances, -> { ModernTreasury::Models::LedgerAccountCategory::Balances }
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description of the ledger account category.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, nil?: true
+
+      # @!attribute ledger_id
+      #   The id of the ledger that this account category belongs to.
+      #
+      #   @return [String]
+      required :ledger_id, String
+
+      # @!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 name
+      #   The name of the ledger account category.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute normal_balance
+      #   The normal balance of the ledger account category.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      required :normal_balance, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param balances [ModernTreasury::Models::LedgerAccountCategory::Balances]
+      #   # @param created_at [Time]
+      #   # @param description [String, nil]
+      #   # @param discarded_at [Time, nil]
+      #   # @param ledger_id [String]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String]
+      #   # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   # @param object [String]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     balances:,
+      #     created_at:,
+      #     description:,
+      #     discarded_at:,
+      #     ledger_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     name:,
+      #     normal_balance:,
+      #     object:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class Balances < ModernTreasury::BaseModel
+        # @!attribute available_balance
+        #   The available_balance is the sum of all posted inbound entries and pending
+        #     outbound entries. For credit normal, available_amount = posted_credits -
+        #     pending_debits; for debit normal, available_amount = posted_debits -
+        #     pending_credits.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance]
+        required :available_balance,
+                 -> { ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance }
+
+        # @!attribute pending_balance
+        #   The pending_balance is the sum of all pending and posted entries.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance]
+        required :pending_balance, -> { ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance }
+
+        # @!attribute posted_balance
+        #   The posted_balance is the sum of all posted entries.
+        #
+        #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance]
+        required :posted_balance, -> { ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance }
+
+        # @!parse
+        #   # The pending, posted, and available balances for this ledger account category.
+        #   #   The posted balance is the sum of all posted entries on the account. The pending
+        #   #   balance is the sum of all pending and posted entries on the account. The
+        #   #   available balance is the posted incoming entries minus the sum of the pending
+        #   #   and posted outgoing amounts.
+        #   #
+        #   # @param available_balance [ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance]
+        #   # @param pending_balance [ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance]
+        #   # @param posted_balance [ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance]
+        #   #
+        #   def initialize(available_balance:, pending_balance:, posted_balance:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        class AvailableBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The available_balance is the sum of all posted inbound entries and pending
+          #   #   outbound entries. For credit normal, available_amount = posted_credits -
+          #   #   pending_debits; for debit normal, available_amount = posted_debits -
+          #   #   pending_credits.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+
+        class PendingBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The pending_balance is the sum of all pending and posted entries.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+
+        class PostedBalance < ModernTreasury::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute credits
+          #
+          #   @return [Integer]
+          required :credits, Integer
+
+          # @!attribute currency
+          #   The currency of the ledger account.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute currency_exponent
+          #   The currency exponent of the ledger account.
+          #
+          #   @return [Integer]
+          required :currency_exponent, Integer
+
+          # @!attribute debits
+          #
+          #   @return [Integer]
+          required :debits, Integer
+
+          # @!parse
+          #   # The posted_balance is the sum of all posted entries.
+          #   #
+          #   # @param amount [Integer]
+          #   # @param credits [Integer]
+          #   # @param currency [String]
+          #   # @param currency_exponent [Integer]
+          #   # @param debits [Integer]
+          #   #
+          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_category_add_ledger_account_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryAddLedgerAccountParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(id:, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_category_add_nested_category_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryAddNestedCategoryParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(id:, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_category_create_params.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute currency
+      #   The currency of the ledger account category.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute ledger_id
+      #   The id of the ledger that this account category belongs to.
+      #
+      #   @return [String]
+      required :ledger_id, String
+
+      # @!attribute name
+      #   The name of the ledger account category.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute normal_balance
+      #   The normal balance of the ledger account category.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      required :normal_balance, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+      # @!attribute currency_exponent
+      #   The currency exponent of the ledger account category.
+      #
+      #   @return [Integer, nil]
+      optional :currency_exponent, Integer, nil?: true
+
+      # @!attribute description
+      #   The description of the ledger account category.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] ledger_account_category_ids
+      #   The array of ledger account category ids that this ledger account category
+      #     should be a child of.
+      #
+      #   @return [Array<String>, nil]
+      optional :ledger_account_category_ids, ModernTreasury::ArrayOf[String]
+
+      # @!parse
+      #   # @return [Array<String>]
+      #   attr_writer :ledger_account_category_ids
+
+      # @!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 currency [String]
+      #   # @param ledger_id [String]
+      #   # @param name [String]
+      #   # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   # @param currency_exponent [Integer, nil]
+      #   # @param description [String, nil]
+      #   # @param ledger_account_category_ids [Array<String>]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     currency:,
+      #     ledger_id:,
+      #     name:,
+      #     normal_balance:,
+      #     currency_exponent: nil,
+      #     description: nil,
+      #     ledger_account_category_ids: nil,
+      #     metadata: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_category_delete_params.rb

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