increase 1.303.0 → 1.304.0

data/lib/increase/models/bookkeeping_balance_lookup.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingAccounts#balance
-    class BookkeepingBalanceLookup < Increase::Internal::Type::BaseModel
-      # @!attribute balance
-      #   The Bookkeeping Account's current balance, representing the sum of all
-      #   Bookkeeping Entries on the Bookkeeping Account.
-      #
-      #   @return [Integer]
-      required :balance, Integer
-
-      # @!attribute bookkeeping_account_id
-      #   The identifier for the account for which the balance was queried.
-      #
-      #   @return [String]
-      required :bookkeeping_account_id, String
-
-      # @!attribute type
-      #   A constant representing the object's type. For this resource it will always be
-      #   `bookkeeping_balance_lookup`.
-      #
-      #   @return [Symbol, Increase::Models::BookkeepingBalanceLookup::Type]
-      required :type, enum: -> { Increase::BookkeepingBalanceLookup::Type }
-
-      # @!method initialize(balance:, bookkeeping_account_id:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BookkeepingBalanceLookup} for more details.
-      #
-      #   Represents a request to lookup the balance of a Bookkeeping Account at a given
-      #   point in time.
-      #
-      #   @param balance [Integer] The Bookkeeping Account's current balance, representing the sum of all Bookkeepi
-      #
-      #   @param bookkeeping_account_id [String] The identifier for the account for which the balance was queried.
-      #
-      #   @param type [Symbol, Increase::Models::BookkeepingBalanceLookup::Type] A constant representing the object's type. For this resource it will always be `
-
-      # A constant representing the object's type. For this resource it will always be
-      # `bookkeeping_balance_lookup`.
-      #
-      # @see Increase::Models::BookkeepingBalanceLookup#type
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        BOOKKEEPING_BALANCE_LOOKUP = :bookkeeping_balance_lookup
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/models/bookkeeping_entry.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingEntries#retrieve
-    class BookkeepingEntry < Increase::Internal::Type::BaseModel
-      # @!attribute id
-      #   The entry identifier.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute account_id
-      #   The identifier for the Account the Entry belongs to.
-      #
-      #   @return [String]
-      required :account_id, String
-
-      # @!attribute amount
-      #   The Entry amount in the minor unit of its currency. For dollars, for example,
-      #   this is cents.
-      #
-      #   @return [Integer]
-      required :amount, Integer
-
-      # @!attribute created_at
-      #   When the entry set was created.
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute entry_set_id
-      #   The identifier for the Entry Set the Entry belongs to.
-      #
-      #   @return [String]
-      required :entry_set_id, String
-
-      # @!attribute type
-      #   A constant representing the object's type. For this resource it will always be
-      #   `bookkeeping_entry`.
-      #
-      #   @return [Symbol, Increase::Models::BookkeepingEntry::Type]
-      required :type, enum: -> { Increase::BookkeepingEntry::Type }
-
-      # @!method initialize(id:, account_id:, amount:, created_at:, entry_set_id:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BookkeepingEntry} for more details.
-      #
-      #   Entries are T-account entries recording debits and credits. Your compliance
-      #   setup might require annotating money movements using this API. Learn more in our
-      #   [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
-      #
-      #   @param id [String] The entry identifier.
-      #
-      #   @param account_id [String] The identifier for the Account the Entry belongs to.
-      #
-      #   @param amount [Integer] The Entry amount in the minor unit of its currency. For dollars, for example, th
-      #
-      #   @param created_at [Time] When the entry set was created.
-      #
-      #   @param entry_set_id [String] The identifier for the Entry Set the Entry belongs to.
-      #
-      #   @param type [Symbol, Increase::Models::BookkeepingEntry::Type] A constant representing the object's type. For this resource it will always be `
-
-      # A constant representing the object's type. For this resource it will always be
-      # `bookkeeping_entry`.
-      #
-      # @see Increase::Models::BookkeepingEntry#type
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        BOOKKEEPING_ENTRY = :bookkeeping_entry
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/models/bookkeeping_entry_list_params.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingEntries#list
-    class BookkeepingEntryListParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute account_id
-      #   The identifier for the Bookkeeping Account to filter by.
-      #
-      #   @return [String, nil]
-      optional :account_id, String
-
-      # @!attribute cursor
-      #   Return the page of entries after this one.
-      #
-      #   @return [String, nil]
-      optional :cursor, String
-
-      # @!attribute limit
-      #   Limit the size of the list that is returned. The default (and maximum) is 100
-      #   objects.
-      #
-      #   @return [Integer, nil]
-      optional :limit, Integer
-
-      # @!method initialize(account_id: nil, cursor: nil, limit: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BookkeepingEntryListParams} for more details.
-      #
-      #   @param account_id [String] The identifier for the Bookkeeping Account to filter by.
-      #
-      #   @param cursor [String] Return the page of entries after this one.
-      #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/increase/models/bookkeeping_entry_retrieve_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingEntries#retrieve
-    class BookkeepingEntryRetrieveParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute bookkeeping_entry_id
-      #   The identifier of the Bookkeeping Entry.
-      #
-      #   @return [String]
-      required :bookkeeping_entry_id, String
-
-      # @!method initialize(bookkeeping_entry_id:, request_options: {})
-      #   @param bookkeeping_entry_id [String] The identifier of the Bookkeeping Entry.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/increase/models/bookkeeping_entry_set.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingEntrySets#create
-    class BookkeepingEntrySet < Increase::Internal::Type::BaseModel
-      # @!attribute id
-      #   The entry set identifier.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute created_at
-      #   When the entry set was created.
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute date
-      #   The timestamp of the entry set.
-      #
-      #   @return [Time]
-      required :date, Time
-
-      # @!attribute entries
-      #   The entries.
-      #
-      #   @return [Array<Increase::Models::BookkeepingEntrySet::Entry>]
-      required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::BookkeepingEntrySet::Entry] }
-
-      # @!attribute idempotency_key
-      #   The idempotency key you chose for this object. This value is unique across
-      #   Increase and is used to ensure that a request is only processed once. Learn more
-      #   about [idempotency](https://increase.com/documentation/idempotency-keys).
-      #
-      #   @return [String, nil]
-      required :idempotency_key, String, nil?: true
-
-      # @!attribute transaction_id
-      #   The transaction identifier, if any.
-      #
-      #   @return [String, nil]
-      required :transaction_id, String, nil?: true
-
-      # @!attribute type
-      #   A constant representing the object's type. For this resource it will always be
-      #   `bookkeeping_entry_set`.
-      #
-      #   @return [Symbol, Increase::Models::BookkeepingEntrySet::Type]
-      required :type, enum: -> { Increase::BookkeepingEntrySet::Type }
-
-      # @!method initialize(id:, created_at:, date:, entries:, idempotency_key:, transaction_id:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BookkeepingEntrySet} for more details.
-      #
-      #   Entry Sets are accounting entries that are transactionally applied. Your
-      #   compliance setup might require annotating money movements using this API. Learn
-      #   more in our
-      #   [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
-      #
-      #   @param id [String] The entry set identifier.
-      #
-      #   @param created_at [Time] When the entry set was created.
-      #
-      #   @param date [Time] The timestamp of the entry set.
-      #
-      #   @param entries [Array<Increase::Models::BookkeepingEntrySet::Entry>] The entries.
-      #
-      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
-      #
-      #   @param transaction_id [String, nil] The transaction identifier, if any.
-      #
-      #   @param type [Symbol, Increase::Models::BookkeepingEntrySet::Type] A constant representing the object's type. For this resource it will always be `
-
-      class Entry < Increase::Internal::Type::BaseModel
-        # @!attribute id
-        #   The entry identifier.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute account_id
-        #   The bookkeeping account impacted by the entry.
-        #
-        #   @return [String]
-        required :account_id, String
-
-        # @!attribute amount
-        #   The amount of the entry in minor units.
-        #
-        #   @return [Integer]
-        required :amount, Integer
-
-        # @!method initialize(id:, account_id:, amount:)
-        #   @param id [String] The entry identifier.
-        #
-        #   @param account_id [String] The bookkeeping account impacted by the entry.
-        #
-        #   @param amount [Integer] The amount of the entry in minor units.
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `bookkeeping_entry_set`.
-      #
-      # @see Increase::Models::BookkeepingEntrySet#type
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        BOOKKEEPING_ENTRY_SET = :bookkeeping_entry_set
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/models/bookkeeping_entry_set_create_params.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingEntrySets#create
-    class BookkeepingEntrySetCreateParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute entries
-      #   The bookkeeping entries.
-      #
-      #   @return [Array<Increase::Models::BookkeepingEntrySetCreateParams::Entry>]
-      required :entries,
-               -> { Increase::Internal::Type::ArrayOf[Increase::BookkeepingEntrySetCreateParams::Entry] }
-
-      # @!attribute date
-      #   The date of the transaction. Optional if `transaction_id` is provided, in which
-      #   case we use the `date` of that transaction. Required otherwise.
-      #
-      #   @return [Time, nil]
-      optional :date, Time
-
-      # @!attribute transaction_id
-      #   The identifier of the Transaction related to this entry set, if any.
-      #
-      #   @return [String, nil]
-      optional :transaction_id, String
-
-      # @!method initialize(entries:, date: nil, transaction_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BookkeepingEntrySetCreateParams} for more details.
-      #
-      #   @param entries [Array<Increase::Models::BookkeepingEntrySetCreateParams::Entry>] The bookkeeping entries.
-      #
-      #   @param date [Time] The date of the transaction. Optional if `transaction_id` is provided, in which
-      #
-      #   @param transaction_id [String] The identifier of the Transaction related to this entry set, if any.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-
-      class Entry < Increase::Internal::Type::BaseModel
-        # @!attribute account_id
-        #   The identifier for the Bookkeeping Account impacted by this entry.
-        #
-        #   @return [String]
-        required :account_id, String
-
-        # @!attribute amount
-        #   The entry amount in the minor unit of the account currency. For dollars, for
-        #   example, this is cents. Debit entries have positive amounts; credit entries have
-        #   negative amounts.
-        #
-        #   @return [Integer]
-        required :amount, Integer
-
-        # @!method initialize(account_id:, amount:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::BookkeepingEntrySetCreateParams::Entry} for more details.
-        #
-        #   @param account_id [String] The identifier for the Bookkeeping Account impacted by this entry.
-        #
-        #   @param amount [Integer] The entry amount in the minor unit of the account currency. For dollars, for exa
-      end
-    end
-  end
-end

data/lib/increase/models/bookkeeping_entry_set_list_params.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingEntrySets#list
-    class BookkeepingEntrySetListParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute cursor
-      #   Return the page of entries after this one.
-      #
-      #   @return [String, nil]
-      optional :cursor, String
-
-      # @!attribute idempotency_key
-      #   Filter records to the one with the specified `idempotency_key` you chose for
-      #   that object. This value is unique across Increase and is used to ensure that a
-      #   request is only processed once. Learn more about
-      #   [idempotency](https://increase.com/documentation/idempotency-keys).
-      #
-      #   @return [String, nil]
-      optional :idempotency_key, String
-
-      # @!attribute limit
-      #   Limit the size of the list that is returned. The default (and maximum) is 100
-      #   objects.
-      #
-      #   @return [Integer, nil]
-      optional :limit, Integer
-
-      # @!attribute transaction_id
-      #   Filter to the Bookkeeping Entry Set that maps to this Transaction.
-      #
-      #   @return [String, nil]
-      optional :transaction_id, String
-
-      # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BookkeepingEntrySetListParams} for more details.
-      #
-      #   @param cursor [String] Return the page of entries after this one.
-      #
-      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
-      #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
-      #
-      #   @param transaction_id [String] Filter to the Bookkeeping Entry Set that maps to this Transaction.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::BookkeepingEntrySets#retrieve
-    class BookkeepingEntrySetRetrieveParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute bookkeeping_entry_set_id
-      #   The identifier of the Bookkeeping Entry Set.
-      #
-      #   @return [String]
-      required :bookkeeping_entry_set_id, String
-
-      # @!method initialize(bookkeeping_entry_set_id:, request_options: {})
-      #   @param bookkeeping_entry_set_id [String] The identifier of the Bookkeeping Entry Set.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/increase/resources/bookkeeping_accounts.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class BookkeepingAccounts
-      # Create a Bookkeeping Account
-      #
-      # @overload create(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {})
-      #
-      # @param name [String] The name you choose for the account.
-      #
-      # @param account_id [String] The account, if `compliance_category` is `commingled_cash`.
-      #
-      # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] The account compliance category.
-      #
-      # @param entity_id [String] The entity, if `compliance_category` is `customer_balance`.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::BookkeepingAccount]
-      #
-      # @see Increase::Models::BookkeepingAccountCreateParams
-      def create(params)
-        parsed, options = Increase::BookkeepingAccountCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "bookkeeping_accounts",
-          body: parsed,
-          model: Increase::BookkeepingAccount,
-          options: options
-        )
-      end
-
-      # Update a Bookkeeping Account
-      #
-      # @overload update(bookkeeping_account_id, name:, request_options: {})
-      #
-      # @param bookkeeping_account_id [String] The bookkeeping account you would like to update.
-      #
-      # @param name [String] The name you choose for the account.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::BookkeepingAccount]
-      #
-      # @see Increase::Models::BookkeepingAccountUpdateParams
-      def update(bookkeeping_account_id, params)
-        parsed, options = Increase::BookkeepingAccountUpdateParams.dump_request(params)
-        @client.request(
-          method: :patch,
-          path: ["bookkeeping_accounts/%1$s", bookkeeping_account_id],
-          body: parsed,
-          model: Increase::BookkeepingAccount,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::BookkeepingAccountListParams} for more details.
-      #
-      # List Bookkeeping Accounts
-      #
-      # @overload list(cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
-      #
-      # @param cursor [String] Return the page of entries after this one.
-      #
-      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
-      #
-      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Internal::Page<Increase::Models::BookkeepingAccount>]
-      #
-      # @see Increase::Models::BookkeepingAccountListParams
-      def list(params = {})
-        parsed, options = Increase::BookkeepingAccountListParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "bookkeeping_accounts",
-          query: query,
-          page: Increase::Internal::Page,
-          model: Increase::BookkeepingAccount,
-          options: options
-        )
-      end
-
-      # Retrieve a Bookkeeping Account Balance
-      #
-      # @overload balance(bookkeeping_account_id, at_time: nil, request_options: {})
-      #
-      # @param bookkeeping_account_id [String] The identifier of the Bookkeeping Account to retrieve.
-      #
-      # @param at_time [Time] The moment to query the balance at. If not set, returns the current balances.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::BookkeepingBalanceLookup]
-      #
-      # @see Increase::Models::BookkeepingAccountBalanceParams
-      def balance(bookkeeping_account_id, params = {})
-        parsed, options = Increase::BookkeepingAccountBalanceParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: ["bookkeeping_accounts/%1$s/balance", bookkeeping_account_id],
-          query: query,
-          model: Increase::BookkeepingBalanceLookup,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/increase/resources/bookkeeping_entries.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class BookkeepingEntries
-      # Retrieve a Bookkeeping Entry
-      #
-      # @overload retrieve(bookkeeping_entry_id, request_options: {})
-      #
-      # @param bookkeeping_entry_id [String] The identifier of the Bookkeeping Entry.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::BookkeepingEntry]
-      #
-      # @see Increase::Models::BookkeepingEntryRetrieveParams
-      def retrieve(bookkeeping_entry_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["bookkeeping_entries/%1$s", bookkeeping_entry_id],
-          model: Increase::BookkeepingEntry,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::BookkeepingEntryListParams} for more details.
-      #
-      # List Bookkeeping Entries
-      #
-      # @overload list(account_id: nil, cursor: nil, limit: nil, request_options: {})
-      #
-      # @param account_id [String] The identifier for the Bookkeeping Account to filter by.
-      #
-      # @param cursor [String] Return the page of entries after this one.
-      #
-      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Internal::Page<Increase::Models::BookkeepingEntry>]
-      #
-      # @see Increase::Models::BookkeepingEntryListParams
-      def list(params = {})
-        parsed, options = Increase::BookkeepingEntryListParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "bookkeeping_entries",
-          query: query,
-          page: Increase::Internal::Page,
-          model: Increase::BookkeepingEntry,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end