modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/ledger_entry_list_params.rb

@@ -0,0 +1,380 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerEntryListParams < 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] 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`.
+      #
+      #   @return [Integer, nil]
+      optional :as_of_lock_version, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :as_of_lock_version
+
+      # @!attribute [r] 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.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection, nil]
+      optional :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   attr_writer :direction
+
+      # @!attribute [r] effective_at
+      #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #     transaction's effective time. Format ISO8601
+      #
+      #   @return [Hash{Symbol=>Time}, nil]
+      optional :effective_at, ModernTreasury::HashOf[Time]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>Time}]
+      #   attr_writer :effective_at
+
+      # @!attribute [r] effective_date
+      #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      #     transaction's effective date. Format YYYY-MM-DD
+      #
+      #   @return [Hash{Symbol=>Date}, nil]
+      optional :effective_date, ModernTreasury::HashOf[Date]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>Date}]
+      #   attr_writer :effective_date
+
+      # @!attribute [r] ledger_account_category_id
+      #   Get all ledger entries that match the direction specified. One of `credit`,
+      #     `debit`.
+      #
+      #   @return [String, nil]
+      optional :ledger_account_category_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_account_category_id
+
+      # @!attribute [r] ledger_account_id
+      #
+      #   @return [String, nil]
+      optional :ledger_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_account_id
+
+      # @!attribute [r] 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`.
+      #
+      #   @return [Hash{Symbol=>Integer}, nil]
+      optional :ledger_account_lock_version, ModernTreasury::HashOf[Integer]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>Integer}]
+      #   attr_writer :ledger_account_lock_version
+
+      # @!attribute [r] ledger_account_payout_id
+      #
+      #   @return [String, nil]
+      optional :ledger_account_payout_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_account_payout_id
+
+      # @!attribute [r] ledger_account_settlement_id
+      #
+      #   @return [String, nil]
+      optional :ledger_account_settlement_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_account_settlement_id
+
+      # @!attribute [r] ledger_account_statement_id
+      #   Get all ledger entries that are included in the ledger account statement.
+      #
+      #   @return [String, nil]
+      optional :ledger_account_statement_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_account_statement_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] 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.
+      #
+      #   @return [ModernTreasury::Models::LedgerEntryListParams::OrderBy, nil]
+      optional :order_by, -> { ModernTreasury::Models::LedgerEntryListParams::OrderBy }
+
+      # @!parse
+      #   # @return [ModernTreasury::Models::LedgerEntryListParams::OrderBy]
+      #   attr_writer :order_by
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] 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.
+      #
+      #   @return [Boolean, nil]
+      optional :show_balances, ModernTreasury::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :show_balances
+
+      # @!attribute [r] 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.
+      #
+      #   @return [Boolean, nil]
+      optional :show_deleted, ModernTreasury::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :show_deleted
+
+      # @!attribute [r] status
+      #   Get all ledger entries that match the status specified. One of `pending`,
+      #     `posted`, or `archived`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status, nil]
+      optional :status, enum: -> { ModernTreasury::Models::LedgerEntryListParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status]
+      #   attr_writer :status
+
+      # @!attribute [r] 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.
+      #
+      #   @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 as_of_lock_version [Integer]
+      #   # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   # @param effective_at [Hash{Symbol=>Time}]
+      #   # @param effective_date [Hash{Symbol=>Date}]
+      #   # @param ledger_account_category_id [String]
+      #   # @param ledger_account_id [String]
+      #   # @param ledger_account_lock_version [Hash{Symbol=>Integer}]
+      #   # @param ledger_account_payout_id [String]
+      #   # @param ledger_account_settlement_id [String]
+      #   # @param ledger_account_statement_id [String]
+      #   # @param ledger_transaction_id [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param order_by [ModernTreasury::Models::LedgerEntryListParams::OrderBy]
+      #   # @param per_page [Integer]
+      #   # @param show_balances [Boolean]
+      #   # @param show_deleted [Boolean]
+      #   # @param status [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status]
+      #   # @param updated_at [Hash{Symbol=>Time}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     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: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class OrderBy < ModernTreasury::BaseModel
+        # @!attribute [r] created_at
+        #
+        #   @return [Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt, nil]
+        optional :created_at, enum: -> { ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt }
+
+        # @!parse
+        #   # @return [Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt]
+        #   attr_writer :created_at
+
+        # @!attribute [r] effective_at
+        #
+        #   @return [Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt, nil]
+        optional :effective_at, enum: -> { ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt }
+
+        # @!parse
+        #   # @return [Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt]
+        #   attr_writer :effective_at
+
+        # @!parse
+        #   # 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.
+        #   #
+        #   # @param created_at [Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt]
+        #   # @param effective_at [Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt]
+        #   #
+        #   def initialize(created_at: nil, effective_at: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case created_at
+        # in :asc
+        #   # ...
+        # in :desc
+        #   # ...
+        # end
+        # ```
+        class CreatedAt < ModernTreasury::Enum
+          ASC = :asc
+          DESC = :desc
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case effective_at
+        # in :asc
+        #   # ...
+        # in :desc
+        #   # ...
+        # end
+        # ```
+        class EffectiveAt < ModernTreasury::Enum
+          ASC = :asc
+          DESC = :desc
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+
+      # @abstract
+      #
+      # Get all ledger entries that match the status specified. One of `pending`,
+      #   `posted`, or `archived`.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :pending
+      #   # ...
+      # in :posted
+      #   # ...
+      # in :archived
+      #   # ...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        PENDING = :pending
+        POSTED = :posted
+        ARCHIVED = :archived
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_entry_retrieve_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerEntryRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] 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.
+      #
+      #   @return [Boolean, nil]
+      optional :show_balances, ModernTreasury::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :show_balances
+
+      # @!parse
+      #   # @param show_balances [Boolean]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(show_balances: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_entry_update_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerEntryUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!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 metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_event_handler.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerEventHandler < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute conditions
+      #
+      #   @return [ModernTreasury::Models::LedgerEventHandler::Conditions, nil]
+      required :conditions, -> { ModernTreasury::Models::LedgerEventHandler::Conditions }, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   An optional description.
+      #
+      #   @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 event handler belongs to.
+      #
+      #   @return [String, nil]
+      required :ledger_id, String, nil?: true
+
+      # @!attribute ledger_transaction_template
+      #
+      #   @return [ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate]
+      required :ledger_transaction_template,
+               -> { ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate }
+
+      # @!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}, nil]
+      required :metadata, ModernTreasury::HashOf[String], nil?: true
+
+      # @!attribute name
+      #   Name of the ledger event handler.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute variables
+      #
+      #   @return [Hash{Symbol=>ModernTreasury::Models::LedgerEventHandlerVariable}, nil]
+      required :variables,
+               -> { ModernTreasury::HashOf[ModernTreasury::Models::LedgerEventHandlerVariable] },
+               nil?: true
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param conditions [ModernTreasury::Models::LedgerEventHandler::Conditions, nil]
+      #   # @param created_at [Time]
+      #   # @param description [String, nil]
+      #   # @param discarded_at [Time, nil]
+      #   # @param ledger_id [String, nil]
+      #   # @param ledger_transaction_template [ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}, nil]
+      #   # @param name [String]
+      #   # @param object [String]
+      #   # @param updated_at [Time]
+      #   # @param variables [Hash{Symbol=>ModernTreasury::Models::LedgerEventHandlerVariable}, nil]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     conditions:,
+      #     created_at:,
+      #     description:,
+      #     discarded_at:,
+      #     ledger_id:,
+      #     ledger_transaction_template:,
+      #     live_mode:,
+      #     metadata:,
+      #     name:,
+      #     object:,
+      #     updated_at:,
+      #     variables:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class Conditions < ModernTreasury::BaseModel
+        # @!attribute field
+        #   The LHS of the conditional.
+        #
+        #   @return [String]
+        required :field, String
+
+        # @!attribute operator
+        #   What the operator between the `field` and `value` is.
+        #
+        #   @return [String]
+        required :operator, String
+
+        # @!attribute value
+        #   The RHS of the conditional.
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!parse
+        #   # @param field [String]
+        #   # @param operator [String]
+        #   # @param value [String]
+        #   #
+        #   def initialize(field:, operator:, value:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+
+      class LedgerTransactionTemplate < ModernTreasury::BaseModel
+        # @!attribute description
+        #   An optional description for internal use.
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute effective_at
+        #   The timestamp (ISO8601 format) at which the ledger transaction happened for
+        #     reporting purposes.
+        #
+        #   @return [String, nil]
+        required :effective_at, String, nil?: true
+
+        # @!attribute ledger_entries
+        #   An array of ledger entry objects.
+        #
+        #   @return [Array<ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry>]
+        required :ledger_entries,
+                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry] }
+
+        # @!attribute status
+        #   To post a ledger transaction at creation, use `posted`.
+        #
+        #   @return [String, nil]
+        required :status, String, nil?: true
+
+        # @!parse
+        #   # @param description [String, nil]
+        #   # @param effective_at [String, nil]
+        #   # @param ledger_entries [Array<ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry>]
+        #   # @param status [String, nil]
+        #   #
+        #   def initialize(description:, effective_at:, ledger_entries:, status:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        class LedgerEntry < ModernTreasury::BaseModel
+          # @!attribute amount
+          #   The LHS of the conditional.
+          #
+          #   @return [String]
+          required :amount, String
+
+          # @!attribute direction
+          #   What the operator between the `field` and `value` is.
+          #
+          #   @return [String]
+          required :direction, String
+
+          # @!attribute ledger_account_id
+          #   The RHS of the conditional.
+          #
+          #   @return [String]
+          required :ledger_account_id, String
+
+          # @!parse
+          #   # @param amount [String]
+          #   # @param direction [String]
+          #   # @param ledger_account_id [String]
+          #   #
+          #   def initialize(amount:, direction:, ledger_account_id:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        end
+      end
+    end
+  end
+end