increase 0.3.3 → 1.0.0

data/lib/increase/models/balance_lookup.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Accounts#balance
+    class BalanceLookup < Increase::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The identifier for the account for which the balance was queried.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute available_balance
+      #   The Account's available balance, representing the current balance less any open
+      #   Pending Transactions on the Account.
+      #
+      #   @return [Integer]
+      required :available_balance, Integer
+
+      # @!attribute current_balance
+      #   The Account's current balance, representing the sum of all posted Transactions
+      #   on the Account.
+      #
+      #   @return [Integer]
+      required :current_balance, Integer
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `balance_lookup`.
+      #
+      #   @return [Symbol, Increase::Models::BalanceLookup::Type]
+      required :type, enum: -> { Increase::BalanceLookup::Type }
+
+      # @!method initialize(account_id:, available_balance:, current_balance:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BalanceLookup} for more details.
+      #
+      #   Represents a request to lookup the balance of an Account at a given point in
+      #   time.
+      #
+      #   @param account_id [String] The identifier for the account for which the balance was queried.
+      #
+      #   @param available_balance [Integer] The Account's available balance, representing the current balance less any open
+      #
+      #   @param current_balance [Integer] The Account's current balance, representing the sum of all posted Transactions o
+      #
+      #   @param type [Symbol, Increase::Models::BalanceLookup::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
+      # `balance_lookup`.
+      #
+      # @see Increase::Models::BalanceLookup#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        BALANCE_LOOKUP = :balance_lookup
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/bookkeeping_account.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BookkeepingAccounts#create
+    class BookkeepingAccount < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The account identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The API Account associated with this bookkeeping account.
+      #
+      #   @return [String, nil]
+      required :account_id, String, nil?: true
+
+      # @!attribute compliance_category
+      #   The compliance category of the account.
+      #
+      #   @return [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil]
+      required :compliance_category, enum: -> { Increase::BookkeepingAccount::ComplianceCategory }, nil?: true
+
+      # @!attribute entity_id
+      #   The Entity associated with this bookkeeping account.
+      #
+      #   @return [String, nil]
+      required :entity_id, String, nil?: true
+
+      # @!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 name
+      #   The name you choose for the account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `bookkeeping_account`.
+      #
+      #   @return [Symbol, Increase::Models::BookkeepingAccount::Type]
+      required :type, enum: -> { Increase::BookkeepingAccount::Type }
+
+      # @!method initialize(id:, account_id:, compliance_category:, entity_id:, idempotency_key:, name:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BookkeepingAccount} for more details.
+      #
+      #   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).
+      #
+      #   @param id [String] The account identifier.
+      #
+      #   @param account_id [String, nil] The API Account associated with this bookkeeping account.
+      #
+      #   @param compliance_category [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil] The compliance category of the account.
+      #
+      #   @param entity_id [String, nil] The Entity associated with this bookkeeping account.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param name [String] The name you choose for the account.
+      #
+      #   @param type [Symbol, Increase::Models::BookkeepingAccount::Type] A constant representing the object's type. For this resource it will always be `
+
+      # The compliance category of the account.
+      #
+      # @see Increase::Models::BookkeepingAccount#compliance_category
+      module ComplianceCategory
+        extend Increase::Internal::Type::Enum
+
+        # A cash in an commingled Increase Account.
+        COMMINGLED_CASH = :commingled_cash
+
+        # A customer balance.
+        CUSTOMER_BALANCE = :customer_balance
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `bookkeeping_account`.
+      #
+      # @see Increase::Models::BookkeepingAccount#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        BOOKKEEPING_ACCOUNT = :bookkeeping_account
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/bookkeeping_account_balance_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BookkeepingAccounts#balance
+    class BookkeepingAccountBalanceParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute at_time
+      #   The moment to query the balance at. If not set, returns the current balances.
+      #
+      #   @return [Time, nil]
+      optional :at_time, Time
+
+      # @!method initialize(at_time: nil, request_options: {})
+      #   @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}]
+    end
+  end
+end

data/lib/increase/models/bookkeeping_account_create_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BookkeepingAccounts#create
+    class BookkeepingAccountCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   The name you choose for the account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute account_id
+      #   The entity, if `compliance_category` is `commingled_cash`.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute compliance_category
+      #   The account compliance category.
+      #
+      #   @return [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory, nil]
+      optional :compliance_category, enum: -> { Increase::BookkeepingAccountCreateParams::ComplianceCategory }
+
+      # @!attribute entity_id
+      #   The entity, if `compliance_category` is `customer_balance`.
+      #
+      #   @return [String, nil]
+      optional :entity_id, String
+
+      # @!method initialize(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 entity, 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}]
+
+      # The account compliance category.
+      module ComplianceCategory
+        extend Increase::Internal::Type::Enum
+
+        # A cash in an commingled Increase Account.
+        COMMINGLED_CASH = :commingled_cash
+
+        # A customer balance.
+        CUSTOMER_BALANCE = :customer_balance
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/bookkeeping_account_list_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BookkeepingAccounts#list
+    class BookkeepingAccountListParams < 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
+
+      # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BookkeepingAccountListParams} 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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/bookkeeping_account_update_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BookkeepingAccounts#update
+    class BookkeepingAccountUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   The name you choose for the account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(name:, request_options: {})
+      #   @param name [String] The name you choose for the account.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/bookkeeping_balance_lookup.rb

@@ -0,0 +1,54 @@
+# 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 an 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

@@ -0,0 +1,79 @@
+# 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 Account 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 Account 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

@@ -0,0 +1,42 @@
+# 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

@@ -0,0 +1,14 @@
+# 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
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/bookkeeping_entry_set.rb

@@ -0,0 +1,116 @@
+# 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