increase 1.303.0 → 1.305.0

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

data/lib/increase/resources/bookkeeping_entry_sets.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class BookkeepingEntrySets
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::BookkeepingEntrySetCreateParams} for more details.
-      #
-      # Create a Bookkeeping Entry Set
-      #
-      # @overload create(entries:, date: nil, transaction_id: nil, request_options: {})
-      #
-      # @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}, nil]
-      #
-      # @return [Increase::Models::BookkeepingEntrySet]
-      #
-      # @see Increase::Models::BookkeepingEntrySetCreateParams
-      def create(params)
-        parsed, options = Increase::BookkeepingEntrySetCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "bookkeeping_entry_sets",
-          body: parsed,
-          model: Increase::BookkeepingEntrySet,
-          options: options
-        )
-      end
-
-      # Retrieve a Bookkeeping Entry Set
-      #
-      # @overload retrieve(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}, nil]
-      #
-      # @return [Increase::Models::BookkeepingEntrySet]
-      #
-      # @see Increase::Models::BookkeepingEntrySetRetrieveParams
-      def retrieve(bookkeeping_entry_set_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["bookkeeping_entry_sets/%1$s", bookkeeping_entry_set_id],
-          model: Increase::BookkeepingEntrySet,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::BookkeepingEntrySetListParams} for more details.
-      #
-      # List Bookkeeping Entry Sets
-      #
-      # @overload list(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: 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 transaction_id [String] Filter to the Bookkeeping Entry Set that maps to this Transaction.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Internal::Page<Increase::Models::BookkeepingEntrySet>]
-      #
-      # @see Increase::Models::BookkeepingEntrySetListParams
-      def list(params = {})
-        parsed, options = Increase::BookkeepingEntrySetListParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "bookkeeping_entry_sets",
-          query: query,
-          page: Increase::Internal::Page,
-          model: Increase::BookkeepingEntrySet,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/increase/resources/lockboxes.rb

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class Lockboxes
-      # Create a Lockbox
-      #
-      # @overload create(account_id:, description: nil, recipient_name: nil, request_options: {})
-      #
-      # @param account_id [String] The Account checks sent to this Lockbox should be deposited into.
-      #
-      # @param description [String] The description you choose for the Lockbox, for display purposes.
-      #
-      # @param recipient_name [String] The name of the recipient that will receive mail at this location.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Lockbox]
-      #
-      # @see Increase::Models::LockboxCreateParams
-      def create(params)
-        parsed, options = Increase::LockboxCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "lockboxes",
-          body: parsed,
-          model: Increase::Lockbox,
-          options: options
-        )
-      end
-
-      # Retrieve a Lockbox
-      #
-      # @overload retrieve(lockbox_id, request_options: {})
-      #
-      # @param lockbox_id [String] The identifier of the Lockbox to retrieve.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Lockbox]
-      #
-      # @see Increase::Models::LockboxRetrieveParams
-      def retrieve(lockbox_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["lockboxes/%1$s", lockbox_id],
-          model: Increase::Lockbox,
-          options: params[:request_options]
-        )
-      end
-
-      # Update a Lockbox
-      #
-      # @overload update(lockbox_id, check_deposit_behavior: nil, description: nil, recipient_name: nil, request_options: {})
-      #
-      # @param lockbox_id [String] The identifier of the Lockbox.
-      #
-      # @param check_deposit_behavior [Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior] This indicates if checks mailed to this lockbox will be deposited.
-      #
-      # @param description [String] The description you choose for the Lockbox.
-      #
-      # @param recipient_name [String] The recipient name you choose for the Lockbox.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Lockbox]
-      #
-      # @see Increase::Models::LockboxUpdateParams
-      def update(lockbox_id, params = {})
-        parsed, options = Increase::LockboxUpdateParams.dump_request(params)
-        @client.request(
-          method: :patch,
-          path: ["lockboxes/%1$s", lockbox_id],
-          body: parsed,
-          model: Increase::Lockbox,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::LockboxListParams} for more details.
-      #
-      # List Lockboxes
-      #
-      # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
-      #
-      # @param account_id [String] Filter Lockboxes to those associated with the provided Account.
-      #
-      # @param created_at [Increase::Models::LockboxListParams::CreatedAt]
-      #
-      # @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::Lockbox>]
-      #
-      # @see Increase::Models::LockboxListParams
-      def list(params = {})
-        parsed, options = Increase::LockboxListParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "lockboxes",
-          query: query,
-          page: Increase::Internal::Page,
-          model: Increase::Lockbox,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/increase/models/bookkeeping_account.rbi

@@ -1,165 +0,0 @@
-# typed: strong
-
-module Increase
-  module Models
-    class BookkeepingAccount < Increase::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Increase::BookkeepingAccount, Increase::Internal::AnyHash)
-        end
-
-      # The account identifier.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The API Account associated with this bookkeeping account.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :account_id
-
-      # The compliance category of the account.
-      sig do
-        returns(
-          T.nilable(
-            Increase::BookkeepingAccount::ComplianceCategory::TaggedSymbol
-          )
-        )
-      end
-      attr_accessor :compliance_category
-
-      # The Entity associated with this bookkeeping account.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :entity_id
-
-      # 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).
-      sig { returns(T.nilable(String)) }
-      attr_accessor :idempotency_key
-
-      # The name you choose for the account.
-      sig { returns(String) }
-      attr_accessor :name
-
-      # A constant representing the object's type. For this resource it will always be
-      # `bookkeeping_account`.
-      sig { returns(Increase::BookkeepingAccount::Type::TaggedSymbol) }
-      attr_accessor :type
-
-      # Accounts are T-accounts. They can store accounting entries. Your compliance
-      # setup might require annotating money movements using this API. Learn more in our
-      # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
-      sig do
-        params(
-          id: String,
-          account_id: T.nilable(String),
-          compliance_category:
-            T.nilable(
-              Increase::BookkeepingAccount::ComplianceCategory::OrSymbol
-            ),
-          entity_id: T.nilable(String),
-          idempotency_key: T.nilable(String),
-          name: String,
-          type: Increase::BookkeepingAccount::Type::OrSymbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The account identifier.
-        id:,
-        # The API Account associated with this bookkeeping account.
-        account_id:,
-        # The compliance category of the account.
-        compliance_category:,
-        # The Entity associated with this bookkeeping account.
-        entity_id:,
-        # 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).
-        idempotency_key:,
-        # The name you choose for the account.
-        name:,
-        # A constant representing the object's type. For this resource it will always be
-        # `bookkeeping_account`.
-        type:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            account_id: T.nilable(String),
-            compliance_category:
-              T.nilable(
-                Increase::BookkeepingAccount::ComplianceCategory::TaggedSymbol
-              ),
-            entity_id: T.nilable(String),
-            idempotency_key: T.nilable(String),
-            name: String,
-            type: Increase::BookkeepingAccount::Type::TaggedSymbol
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # The compliance category of the account.
-      module ComplianceCategory
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Increase::BookkeepingAccount::ComplianceCategory)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        # A cash in an commingled Increase Account.
-        COMMINGLED_CASH =
-          T.let(
-            :commingled_cash,
-            Increase::BookkeepingAccount::ComplianceCategory::TaggedSymbol
-          )
-
-        # A customer balance.
-        CUSTOMER_BALANCE =
-          T.let(
-            :customer_balance,
-            Increase::BookkeepingAccount::ComplianceCategory::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Increase::BookkeepingAccount::ComplianceCategory::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `bookkeeping_account`.
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Increase::BookkeepingAccount::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        BOOKKEEPING_ACCOUNT =
-          T.let(
-            :bookkeeping_account,
-            Increase::BookkeepingAccount::Type::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Increase::BookkeepingAccount::Type::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/increase/models/bookkeeping_account_balance_params.rbi

@@ -1,57 +0,0 @@
-# typed: strong
-
-module Increase
-  module Models
-    class BookkeepingAccountBalanceParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            Increase::BookkeepingAccountBalanceParams,
-            Increase::Internal::AnyHash
-          )
-        end
-
-      # The identifier of the Bookkeeping Account to retrieve.
-      sig { returns(String) }
-      attr_accessor :bookkeeping_account_id
-
-      # The moment to query the balance at. If not set, returns the current balances.
-      sig { returns(T.nilable(Time)) }
-      attr_reader :at_time
-
-      sig { params(at_time: Time).void }
-      attr_writer :at_time
-
-      sig do
-        params(
-          bookkeeping_account_id: String,
-          at_time: Time,
-          request_options: Increase::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The identifier of the Bookkeeping Account to retrieve.
-        bookkeeping_account_id:,
-        # The moment to query the balance at. If not set, returns the current balances.
-        at_time: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            bookkeeping_account_id: String,
-            at_time: Time,
-            request_options: Increase::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/increase/models/bookkeeping_account_create_params.rbi

@@ -1,130 +0,0 @@
-# typed: strong
-
-module Increase
-  module Models
-    class BookkeepingAccountCreateParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            Increase::BookkeepingAccountCreateParams,
-            Increase::Internal::AnyHash
-          )
-        end
-
-      # The name you choose for the account.
-      sig { returns(String) }
-      attr_accessor :name
-
-      # The account, if `compliance_category` is `commingled_cash`.
-      sig { returns(T.nilable(String)) }
-      attr_reader :account_id
-
-      sig { params(account_id: String).void }
-      attr_writer :account_id
-
-      # The account compliance category.
-      sig do
-        returns(
-          T.nilable(
-            Increase::BookkeepingAccountCreateParams::ComplianceCategory::OrSymbol
-          )
-        )
-      end
-      attr_reader :compliance_category
-
-      sig do
-        params(
-          compliance_category:
-            Increase::BookkeepingAccountCreateParams::ComplianceCategory::OrSymbol
-        ).void
-      end
-      attr_writer :compliance_category
-
-      # The entity, if `compliance_category` is `customer_balance`.
-      sig { returns(T.nilable(String)) }
-      attr_reader :entity_id
-
-      sig { params(entity_id: String).void }
-      attr_writer :entity_id
-
-      sig do
-        params(
-          name: String,
-          account_id: String,
-          compliance_category:
-            Increase::BookkeepingAccountCreateParams::ComplianceCategory::OrSymbol,
-          entity_id: String,
-          request_options: Increase::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The name you choose for the account.
-        name:,
-        # The account, if `compliance_category` is `commingled_cash`.
-        account_id: nil,
-        # The account compliance category.
-        compliance_category: nil,
-        # The entity, if `compliance_category` is `customer_balance`.
-        entity_id: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            name: String,
-            account_id: String,
-            compliance_category:
-              Increase::BookkeepingAccountCreateParams::ComplianceCategory::OrSymbol,
-            entity_id: String,
-            request_options: Increase::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # The account compliance category.
-      module ComplianceCategory
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Increase::BookkeepingAccountCreateParams::ComplianceCategory
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        # A cash in an commingled Increase Account.
-        COMMINGLED_CASH =
-          T.let(
-            :commingled_cash,
-            Increase::BookkeepingAccountCreateParams::ComplianceCategory::TaggedSymbol
-          )
-
-        # A customer balance.
-        CUSTOMER_BALANCE =
-          T.let(
-            :customer_balance,
-            Increase::BookkeepingAccountCreateParams::ComplianceCategory::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Increase::BookkeepingAccountCreateParams::ComplianceCategory::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end