increase 0.3.3 → 1.1.0

data/lib/increase/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Increase
+  module Internal
+    extend Increase::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Increase::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Increase::FilePart) }
+    end
+  end
+end

data/lib/increase/models/account.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Accounts#create
+    class Account < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Account identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute bank
+      #   The bank the Account is with.
+      #
+      #   @return [Symbol, Increase::Models::Account::Bank]
+      required :bank, enum: -> { Increase::Account::Bank }
+
+      # @!attribute closed_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+      #   was closed.
+      #
+      #   @return [Time, nil]
+      required :closed_at, Time, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+      #   was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
+      #   currency.
+      #
+      #   @return [Symbol, Increase::Models::Account::Currency]
+      required :currency, enum: -> { Increase::Account::Currency }
+
+      # @!attribute entity_id
+      #   The identifier for the Entity the Account belongs to.
+      #
+      #   @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 informational_entity_id
+      #   The identifier of an Entity that, while not owning the Account, is associated
+      #   with its activity.
+      #
+      #   @return [String, nil]
+      required :informational_entity_id, String, nil?: true
+
+      # @!attribute interest_accrued
+      #   The interest accrued but not yet paid, expressed as a string containing a
+      #   floating-point value.
+      #
+      #   @return [String]
+      required :interest_accrued, String
+
+      # @!attribute interest_accrued_at
+      #   The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which
+      #   interest was accrued.
+      #
+      #   @return [Date, nil]
+      required :interest_accrued_at, Date, nil?: true
+
+      # @!attribute interest_rate
+      #   The Interest Rate currently being earned on the account, as a string containing
+      #   a decimal number. For example, a 1% interest rate would be represented as
+      #   "0.01".
+      #
+      #   @return [String]
+      required :interest_rate, String
+
+      # @!attribute name
+      #   The name you choose for the Account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute program_id
+      #   The identifier of the Program determining the compliance and commercial terms of
+      #   this Account.
+      #
+      #   @return [String]
+      required :program_id, String
+
+      # @!attribute status
+      #   The status of the Account.
+      #
+      #   @return [Symbol, Increase::Models::Account::Status]
+      required :status, enum: -> { Increase::Account::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `account`.
+      #
+      #   @return [Symbol, Increase::Models::Account::Type]
+      required :type, enum: -> { Increase::Account::Type }
+
+      # @!method initialize(id:, bank:, closed_at:, created_at:, currency:, entity_id:, idempotency_key:, informational_entity_id:, interest_accrued:, interest_accrued_at:, interest_rate:, name:, program_id:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::Account} for more details.
+      #
+      #   Accounts are your bank accounts with Increase. They store money, receive
+      #   transfers, and send payments. They earn interest and have depository insurance.
+      #
+      #   @param id [String] The Account identifier.
+      #
+      #   @param bank [Symbol, Increase::Models::Account::Bank] The bank the Account is with.
+      #
+      #   @param closed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+      #
+      #   @param currency [Symbol, Increase::Models::Account::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account curr
+      #
+      #   @param entity_id [String, nil] The identifier for the Entity the Account belongs to.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param informational_entity_id [String, nil] The identifier of an Entity that, while not owning the Account, is associated wi
+      #
+      #   @param interest_accrued [String] The interest accrued but not yet paid, expressed as a string containing a floati
+      #
+      #   @param interest_accrued_at [Date, nil] The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which inte
+      #
+      #   @param interest_rate [String] The Interest Rate currently being earned on the account, as a string containing
+      #
+      #   @param name [String] The name you choose for the Account.
+      #
+      #   @param program_id [String] The identifier of the Program determining the compliance and commercial terms of
+      #
+      #   @param status [Symbol, Increase::Models::Account::Status] The status of the Account.
+      #
+      #   @param type [Symbol, Increase::Models::Account::Type] A constant representing the object's type. For this resource it will always be `
+
+      # The bank the Account is with.
+      #
+      # @see Increase::Models::Account#bank
+      module Bank
+        extend Increase::Internal::Type::Enum
+
+        # Core Bank
+        CORE_BANK = :core_bank
+
+        # First Internet Bank of Indiana
+        FIRST_INTERNET_BANK = :first_internet_bank
+
+        # Grasshopper Bank
+        GRASSHOPPER_BANK = :grasshopper_bank
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
+      # currency.
+      #
+      # @see Increase::Models::Account#currency
+      module Currency
+        extend Increase::Internal::Type::Enum
+
+        # Canadian Dollar (CAD)
+        CAD = :CAD
+
+        # Swiss Franc (CHF)
+        CHF = :CHF
+
+        # Euro (EUR)
+        EUR = :EUR
+
+        # British Pound (GBP)
+        GBP = :GBP
+
+        # Japanese Yen (JPY)
+        JPY = :JPY
+
+        # US Dollar (USD)
+        USD = :USD
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the Account.
+      #
+      # @see Increase::Models::Account#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # Closed Accounts on which no new activity can occur.
+        CLOSED = :closed
+
+        # Open Accounts that are ready to use.
+        OPEN = :open
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `account`.
+      #
+      # @see Increase::Models::Account#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        ACCOUNT = :account
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/account_balance_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Accounts#balance
+    class AccountBalanceParams < 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/account_close_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Accounts#close
+    class AccountCloseParams < 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/account_create_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Accounts#create
+    class AccountCreateParams < 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 entity_id
+      #   The identifier for the Entity that will own the Account.
+      #
+      #   @return [String, nil]
+      optional :entity_id, String
+
+      # @!attribute informational_entity_id
+      #   The identifier of an Entity that, while not owning the Account, is associated
+      #   with its activity. Its relationship to your group must be `informational`.
+      #
+      #   @return [String, nil]
+      optional :informational_entity_id, String
+
+      # @!attribute program_id
+      #   The identifier for the Program that this Account falls under. Required if you
+      #   operate more than one Program.
+      #
+      #   @return [String, nil]
+      optional :program_id, String
+
+      # @!method initialize(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::AccountCreateParams} for more details.
+      #
+      #   @param name [String] The name you choose for the Account.
+      #
+      #   @param entity_id [String] The identifier for the Entity that will own the Account.
+      #
+      #   @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi
+      #
+      #   @param program_id [String] The identifier for the Program that this Account falls under. Required if you op
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/account_list_params.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Accounts#list
+    class AccountListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::AccountListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::AccountListParams::CreatedAt }
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute entity_id
+      #   Filter Accounts for those belonging to the specified Entity.
+      #
+      #   @return [String, nil]
+      optional :entity_id, 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 informational_entity_id
+      #   Filter Accounts for those belonging to the specified Entity as informational.
+      #
+      #   @return [String, nil]
+      optional :informational_entity_id, 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 program_id
+      #   Filter Accounts for those in a specific Program.
+      #
+      #   @return [String, nil]
+      optional :program_id, String
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::AccountListParams::Status, nil]
+      optional :status, -> { Increase::AccountListParams::Status }
+
+      # @!method initialize(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::AccountListParams} for more details.
+      #
+      #   @param created_at [Increase::Models::AccountListParams::CreatedAt]
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param entity_id [String] Filter Accounts for those belonging to the specified Entity.
+      #
+      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      #   @param informational_entity_id [String] Filter Accounts for those belonging to the specified Entity as informational.
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param program_id [String] Filter Accounts for those in a specific Program.
+      #
+      #   @param status [Increase::Models::AccountListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Accounts for those with the specified status. For GET requests, this
+        #   should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::AccountListParams::Status::In>, nil]
+        optional :in_,
+                 -> { Increase::Internal::Type::ArrayOf[enum: Increase::AccountListParams::Status::In] },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::AccountListParams::Status::In>] Filter Accounts for those with the specified status. For GET requests, this shou
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # Closed Accounts on which no new activity can occur.
+          CLOSED = :closed
+
+          # Open Accounts that are ready to use.
+          OPEN = :open
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end