modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/ledger_account_category_list_params.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryListParams < 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] balances
+      #   For example, if you want the balances as of a particular time (ISO8601), the
+      #     encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+      #     The balances as of a time are inclusive of entries with that exact time.
+      #
+      #   @return [ModernTreasury::Models::LedgerAccountCategoryListParams::Balances, nil]
+      optional :balances, -> { ModernTreasury::Models::LedgerAccountCategoryListParams::Balances }
+
+      # @!parse
+      #   # @return [ModernTreasury::Models::LedgerAccountCategoryListParams::Balances]
+      #   attr_writer :balances
+
+      # @!attribute [r] currency
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :currency
+
+      # @!attribute [r] ledger_account_id
+      #   Query categories which contain a ledger account directly or through child
+      #     categories.
+      #
+      #   @return [String, nil]
+      optional :ledger_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_account_id
+
+      # @!attribute [r] ledger_id
+      #
+      #   @return [String, nil]
+      optional :ledger_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledger_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] name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :name
+
+      # @!attribute [r] parent_ledger_account_category_id
+      #   Query categories that are nested underneath a parent category
+      #
+      #   @return [String, nil]
+      optional :parent_ledger_account_category_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :parent_ledger_account_category_id
+
+      # @!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 balances [ModernTreasury::Models::LedgerAccountCategoryListParams::Balances]
+      #   # @param currency [String]
+      #   # @param ledger_account_id [String]
+      #   # @param ledger_id [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String]
+      #   # @param parent_ledger_account_category_id [String]
+      #   # @param per_page [Integer]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     id: nil,
+      #     after_cursor: nil,
+      #     balances: nil,
+      #     currency: nil,
+      #     ledger_account_id: nil,
+      #     ledger_id: nil,
+      #     metadata: nil,
+      #     name: nil,
+      #     parent_ledger_account_category_id: nil,
+      #     per_page: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class Balances < ModernTreasury::BaseModel
+        # @!attribute [r] effective_at
+        #
+        #   @return [Time, nil]
+        optional :effective_at, Time
+
+        # @!parse
+        #   # @return [Time]
+        #   attr_writer :effective_at
+
+        # @!parse
+        #   # For example, if you want the balances as of a particular time (ISO8601), the
+        #   #   encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+        #   #   The balances as of a time are inclusive of entries with that exact time.
+        #   #
+        #   # @param effective_at [Time]
+        #   #
+        #   def initialize(effective_at: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_category_remove_ledger_account_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryRemoveLedgerAccountParams < 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_remove_nested_category_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryRemoveNestedCategoryParams < 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_retrieve_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] balances
+      #   For example, if you want the balances as of a particular time (ISO8601), the
+      #     encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+      #     The balances as of a time are inclusive of entries with that exact time.
+      #
+      #   @return [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances, nil]
+      optional :balances, -> { ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances }
+
+      # @!parse
+      #   # @return [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances]
+      #   attr_writer :balances
+
+      # @!parse
+      #   # @param balances [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(balances: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class Balances < ModernTreasury::BaseModel
+        # @!attribute [r] as_of_date
+        #
+        #   @return [Date, nil]
+        optional :as_of_date, Date
+
+        # @!parse
+        #   # @return [Date]
+        #   attr_writer :as_of_date
+
+        # @!attribute [r] effective_at
+        #
+        #   @return [Time, nil]
+        optional :effective_at, Time
+
+        # @!parse
+        #   # @return [Time]
+        #   attr_writer :effective_at
+
+        # @!parse
+        #   # For example, if you want the balances as of a particular time (ISO8601), the
+        #   #   encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+        #   #   The balances as of a time are inclusive of entries with that exact time.
+        #   #
+        #   # @param as_of_date [Date]
+        #   # @param effective_at [Time]
+        #   #
+        #   def initialize(as_of_date: nil, effective_at: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_category_update_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute description
+      #   The description of the ledger account category.
+      #
+      #   @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] name
+      #   The name of the ledger account category.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :name
+
+      # @!parse
+      #   # @param description [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(description: nil, metadata: nil, name: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_create_params.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute currency
+      #   The currency of the ledger account.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute ledger_id
+      #   The id of the ledger that this account belongs to.
+      #
+      #   @return [String]
+      required :ledger_id, String
+
+      # @!attribute name
+      #   The name of the ledger account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute normal_balance
+      #   The normal balance of the ledger account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      required :normal_balance, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+      # @!attribute currency_exponent
+      #   The currency exponent of the ledger account.
+      #
+      #   @return [Integer, nil]
+      optional :currency_exponent, Integer, nil?: true
+
+      # @!attribute description
+      #   The description of the ledger account.
+      #
+      #   @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 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] ledgerable_id
+      #   If the ledger account links to another object in Modern Treasury, the id will be
+      #     populated here, otherwise null.
+      #
+      #   @return [String, nil]
+      optional :ledgerable_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ledgerable_id
+
+      # @!attribute [r] 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.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType, nil]
+      optional :ledgerable_type, enum: -> { ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType]
+      #   attr_writer :ledgerable_type
+
+      # @!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 ledgerable_id [String]
+      #   # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType]
+      #   # @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,
+      #     ledgerable_id: nil,
+      #     ledgerable_type: nil,
+      #     metadata: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # 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.
+      #
+      # @example
+      # ```ruby
+      # case ledgerable_type
+      # in :counterparty
+      #   # ...
+      # in :external_account
+      #   # ...
+      # in :internal_account
+      #   # ...
+      # in :virtual_account
+      #   # ...
+      # end
+      # ```
+      class LedgerableType < ModernTreasury::Enum
+        COUNTERPARTY = :counterparty
+        EXTERNAL_ACCOUNT = :external_account
+        INTERNAL_ACCOUNT = :internal_account
+        VIRTUAL_ACCOUNT = :virtual_account
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_delete_params.rb

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