increase 0.3.3 → 1.0.0

data/lib/increase/models/account_number.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::AccountNumbers#create
+    class AccountNumber < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Account Number identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The identifier for the account this Account Number belongs to.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute account_number
+      #   The account number.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+      #   Number was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!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 inbound_ach
+      #   Properties related to how this Account Number handles inbound ACH transfers.
+      #
+      #   @return [Increase::Models::AccountNumber::InboundACH]
+      required :inbound_ach, -> { Increase::AccountNumber::InboundACH }
+
+      # @!attribute inbound_checks
+      #   Properties related to how this Account Number should handle inbound check
+      #   withdrawals.
+      #
+      #   @return [Increase::Models::AccountNumber::InboundChecks]
+      required :inbound_checks, -> { Increase::AccountNumber::InboundChecks }
+
+      # @!attribute name
+      #   The name you choose for the Account Number.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute routing_number
+      #   The American Bankers' Association (ABA) Routing Transit Number (RTN).
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute status
+      #   This indicates if payments can be made to the Account Number.
+      #
+      #   @return [Symbol, Increase::Models::AccountNumber::Status]
+      required :status, enum: -> { Increase::AccountNumber::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `account_number`.
+      #
+      #   @return [Symbol, Increase::Models::AccountNumber::Type]
+      required :type, enum: -> { Increase::AccountNumber::Type }
+
+      # @!method initialize(id:, account_id:, account_number:, created_at:, idempotency_key:, inbound_ach:, inbound_checks:, name:, routing_number:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::AccountNumber} for more details.
+      #
+      #   Each account can have multiple account and routing numbers. We recommend that
+      #   you use a set per vendor. This is similar to how you use different passwords for
+      #   different websites. Account numbers can also be used to seamlessly reconcile
+      #   inbound payments. Generating a unique account number per vendor ensures you
+      #   always know the originator of an incoming payment.
+      #
+      #   @param id [String] The Account Number identifier.
+      #
+      #   @param account_id [String] The identifier for the account this Account Number belongs to.
+      #
+      #   @param account_number [String] The account number.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param inbound_ach [Increase::Models::AccountNumber::InboundACH] Properties related to how this Account Number handles inbound ACH transfers.
+      #
+      #   @param inbound_checks [Increase::Models::AccountNumber::InboundChecks] Properties related to how this Account Number should handle inbound check withdr
+      #
+      #   @param name [String] The name you choose for the Account Number.
+      #
+      #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
+      #
+      #   @param status [Symbol, Increase::Models::AccountNumber::Status] This indicates if payments can be made to the Account Number.
+      #
+      #   @param type [Symbol, Increase::Models::AccountNumber::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::AccountNumber#inbound_ach
+      class InboundACH < Increase::Internal::Type::BaseModel
+        # @!attribute debit_status
+        #   Whether ACH debits are allowed against this Account Number. Note that they will
+        #   still be declined if this is `allowed` if the Account Number is not active.
+        #
+        #   @return [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus]
+        required :debit_status, enum: -> { Increase::AccountNumber::InboundACH::DebitStatus }
+
+        # @!method initialize(debit_status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountNumber::InboundACH} for more details.
+        #
+        #   Properties related to how this Account Number handles inbound ACH transfers.
+        #
+        #   @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that they will
+
+        # Whether ACH debits are allowed against this Account Number. Note that they will
+        # still be declined if this is `allowed` if the Account Number is not active.
+        #
+        # @see Increase::Models::AccountNumber::InboundACH#debit_status
+        module DebitStatus
+          extend Increase::Internal::Type::Enum
+
+          # ACH Debits are allowed.
+          ALLOWED = :allowed
+
+          # ACH Debits are blocked.
+          BLOCKED = :blocked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Increase::Models::AccountNumber#inbound_checks
+      class InboundChecks < Increase::Internal::Type::BaseModel
+        # @!attribute status
+        #   How Increase should process checks with this account number printed on them.
+        #
+        #   @return [Symbol, Increase::Models::AccountNumber::InboundChecks::Status]
+        required :status, enum: -> { Increase::AccountNumber::InboundChecks::Status }
+
+        # @!method initialize(status:)
+        #   Properties related to how this Account Number should handle inbound check
+        #   withdrawals.
+        #
+        #   @param status [Symbol, Increase::Models::AccountNumber::InboundChecks::Status] How Increase should process checks with this account number printed on them.
+
+        # How Increase should process checks with this account number printed on them.
+        #
+        # @see Increase::Models::AccountNumber::InboundChecks#status
+        module Status
+          extend Increase::Internal::Type::Enum
+
+          # Checks with this Account Number will be processed even if they are not associated with a Check Transfer.
+          ALLOWED = :allowed
+
+          # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer.
+          CHECK_TRANSFERS_ONLY = :check_transfers_only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # This indicates if payments can be made to the Account Number.
+      #
+      # @see Increase::Models::AccountNumber#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The account number is active.
+        ACTIVE = :active
+
+        # The account number is temporarily disabled.
+        DISABLED = :disabled
+
+        # The account number is permanently disabled.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `account_number`.
+      #
+      # @see Increase::Models::AccountNumber#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        ACCOUNT_NUMBER = :account_number
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/account_number_create_params.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::AccountNumbers#create
+    class AccountNumberCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The Account the Account Number should belong to.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute name
+      #   The name you choose for the Account Number.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute inbound_ach
+      #   Options related to how this Account Number should handle inbound ACH transfers.
+      #
+      #   @return [Increase::Models::AccountNumberCreateParams::InboundACH, nil]
+      optional :inbound_ach, -> { Increase::AccountNumberCreateParams::InboundACH }
+
+      # @!attribute inbound_checks
+      #   Options related to how this Account Number should handle inbound check
+      #   withdrawals.
+      #
+      #   @return [Increase::Models::AccountNumberCreateParams::InboundChecks, nil]
+      optional :inbound_checks, -> { Increase::AccountNumberCreateParams::InboundChecks }
+
+      # @!method initialize(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::AccountNumberCreateParams} for more details.
+      #
+      #   @param account_id [String] The Account the Account Number should belong to.
+      #
+      #   @param name [String] The name you choose for the Account Number.
+      #
+      #   @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] Options related to how this Account Number should handle inbound ACH transfers.
+      #
+      #   @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class InboundACH < Increase::Internal::Type::BaseModel
+        # @!attribute debit_status
+        #   Whether ACH debits are allowed against this Account Number. Note that ACH debits
+        #   will be declined if this is `allowed` but the Account Number is not active. If
+        #   you do not specify this field, the default is `allowed`.
+        #
+        #   @return [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus]
+        required :debit_status, enum: -> { Increase::AccountNumberCreateParams::InboundACH::DebitStatus }
+
+        # @!method initialize(debit_status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountNumberCreateParams::InboundACH} for more details.
+        #
+        #   Options related to how this Account Number should handle inbound ACH transfers.
+        #
+        #   @param debit_status [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that ACH debits
+
+        # Whether ACH debits are allowed against this Account Number. Note that ACH debits
+        # will be declined if this is `allowed` but the Account Number is not active. If
+        # you do not specify this field, the default is `allowed`.
+        #
+        # @see Increase::Models::AccountNumberCreateParams::InboundACH#debit_status
+        module DebitStatus
+          extend Increase::Internal::Type::Enum
+
+          # ACH Debits are allowed.
+          ALLOWED = :allowed
+
+          # ACH Debits are blocked.
+          BLOCKED = :blocked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class InboundChecks < Increase::Internal::Type::BaseModel
+        # @!attribute status
+        #   How Increase should process checks with this account number printed on them. If
+        #   you do not specify this field, the default is `check_transfers_only`.
+        #
+        #   @return [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status]
+        required :status, enum: -> { Increase::AccountNumberCreateParams::InboundChecks::Status }
+
+        # @!method initialize(status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountNumberCreateParams::InboundChecks} for more details.
+        #
+        #   Options related to how this Account Number should handle inbound check
+        #   withdrawals.
+        #
+        #   @param status [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status] How Increase should process checks with this account number printed on them. If
+
+        # How Increase should process checks with this account number printed on them. If
+        # you do not specify this field, the default is `check_transfers_only`.
+        #
+        # @see Increase::Models::AccountNumberCreateParams::InboundChecks#status
+        module Status
+          extend Increase::Internal::Type::Enum
+
+          # Checks with this Account Number will be processed even if they are not associated with a Check Transfer.
+          ALLOWED = :allowed
+
+          # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer.
+          CHECK_TRANSFERS_ONLY = :check_transfers_only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/account_number_list_params.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::AccountNumbers#list
+    class AccountNumberListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Account Numbers to those belonging to the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute ach_debit_status
+      #
+      #   @return [Increase::Models::AccountNumberListParams::ACHDebitStatus, nil]
+      optional :ach_debit_status, -> { Increase::AccountNumberListParams::ACHDebitStatus }
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::AccountNumberListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::AccountNumberListParams::CreatedAt }
+
+      # @!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 status
+      #
+      #   @return [Increase::Models::AccountNumberListParams::Status, nil]
+      optional :status, -> { Increase::AccountNumberListParams::Status }
+
+      # @!method initialize(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::AccountNumberListParams} for more details.
+      #
+      #   @param account_id [String] Filter Account Numbers to those belonging to the specified Account.
+      #
+      #   @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus]
+      #
+      #   @param created_at [Increase::Models::AccountNumberListParams::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 status [Increase::Models::AccountNumberListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class ACHDebitStatus < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   The ACH Debit status to retrieve Account Numbers for. For GET requests, this
+        #   should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::AccountNumberListParams::ACHDebitStatus::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::AccountNumberListParams::ACHDebitStatus::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountNumberListParams::ACHDebitStatus} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::AccountNumberListParams::ACHDebitStatus::In>] The ACH Debit status to retrieve Account Numbers for. For GET requests, this sho
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # ACH Debits are allowed.
+          ALLOWED = :allowed
+
+          # ACH Debits are blocked.
+          BLOCKED = :blocked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      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::AccountNumberListParams::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_
+        #   The status to retrieve Account Numbers for. For GET requests, this should be
+        #   encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::AccountNumberListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::AccountNumberListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountNumberListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::AccountNumberListParams::Status::In>] The status to retrieve Account Numbers for. For GET requests, this should be enc
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The account number is active.
+          ACTIVE = :active
+
+          # The account number is temporarily disabled.
+          DISABLED = :disabled
+
+          # The account number is permanently disabled.
+          CANCELED = :canceled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/account_number_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::AccountNumbers#retrieve
+    class AccountNumberRetrieveParams < 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_number_update_params.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::AccountNumbers#update
+    class AccountNumberUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute inbound_ach
+      #   Options related to how this Account Number handles inbound ACH transfers.
+      #
+      #   @return [Increase::Models::AccountNumberUpdateParams::InboundACH, nil]
+      optional :inbound_ach, -> { Increase::AccountNumberUpdateParams::InboundACH }
+
+      # @!attribute inbound_checks
+      #   Options related to how this Account Number should handle inbound check
+      #   withdrawals.
+      #
+      #   @return [Increase::Models::AccountNumberUpdateParams::InboundChecks, nil]
+      optional :inbound_checks, -> { Increase::AccountNumberUpdateParams::InboundChecks }
+
+      # @!attribute name
+      #   The name you choose for the Account Number.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute status
+      #   This indicates if transfers can be made to the Account Number.
+      #
+      #   @return [Symbol, Increase::Models::AccountNumberUpdateParams::Status, nil]
+      optional :status, enum: -> { Increase::AccountNumberUpdateParams::Status }
+
+      # @!method initialize(inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::AccountNumberUpdateParams} for more details.
+      #
+      #   @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] Options related to how this Account Number handles inbound ACH transfers.
+      #
+      #   @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa
+      #
+      #   @param name [String] The name you choose for the Account Number.
+      #
+      #   @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] This indicates if transfers can be made to the Account Number.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class InboundACH < Increase::Internal::Type::BaseModel
+        # @!attribute debit_status
+        #   Whether ACH debits are allowed against this Account Number. Note that ACH debits
+        #   will be declined if this is `allowed` but the Account Number is not active.
+        #
+        #   @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus, nil]
+        optional :debit_status, enum: -> { Increase::AccountNumberUpdateParams::InboundACH::DebitStatus }
+
+        # @!method initialize(debit_status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::AccountNumberUpdateParams::InboundACH} for more details.
+        #
+        #   Options related to how this Account Number handles inbound ACH transfers.
+        #
+        #   @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that ACH debits
+
+        # Whether ACH debits are allowed against this Account Number. Note that ACH debits
+        # will be declined if this is `allowed` but the Account Number is not active.
+        #
+        # @see Increase::Models::AccountNumberUpdateParams::InboundACH#debit_status
+        module DebitStatus
+          extend Increase::Internal::Type::Enum
+
+          # ACH Debits are allowed.
+          ALLOWED = :allowed
+
+          # ACH Debits are blocked.
+          BLOCKED = :blocked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class InboundChecks < Increase::Internal::Type::BaseModel
+        # @!attribute status
+        #   How Increase should process checks with this account number printed on them.
+        #
+        #   @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status]
+        required :status, enum: -> { Increase::AccountNumberUpdateParams::InboundChecks::Status }
+
+        # @!method initialize(status:)
+        #   Options related to how this Account Number should handle inbound check
+        #   withdrawals.
+        #
+        #   @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status] How Increase should process checks with this account number printed on them.
+
+        # How Increase should process checks with this account number printed on them.
+        #
+        # @see Increase::Models::AccountNumberUpdateParams::InboundChecks#status
+        module Status
+          extend Increase::Internal::Type::Enum
+
+          # Checks with this Account Number will be processed even if they are not associated with a Check Transfer.
+          ALLOWED = :allowed
+
+          # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer.
+          CHECK_TRANSFERS_ONLY = :check_transfers_only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # This indicates if transfers can be made to the Account Number.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The account number is active.
+        ACTIVE = :active
+
+        # The account number is temporarily disabled.
+        DISABLED = :disabled
+
+        # The account number is permanently disabled.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/account_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Accounts#retrieve
+    class AccountRetrieveParams < 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