increase 0.3.2 → 1.0.0

data/lib/increase/models/inbound_check_deposit.rb

@@ -0,0 +1,391 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundCheckDeposits#retrieve
+    class InboundCheckDeposit < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The deposit's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute accepted_at
+      #   If the Inbound Check Deposit was accepted, the
+      #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this
+      #   took place.
+      #
+      #   @return [Time, nil]
+      required :accepted_at, Time, nil?: true
+
+      # @!attribute account_id
+      #   The Account the check is being deposited against.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute account_number_id
+      #   The Account Number the check is being deposited against.
+      #
+      #   @return [String, nil]
+      required :account_number_id, String, nil?: true
+
+      # @!attribute adjustments
+      #   If the deposit or the return was adjusted by the sending institution, this will
+      #   contain details of the adjustments.
+      #
+      #   @return [Array<Increase::Models::InboundCheckDeposit::Adjustment>]
+      required :adjustments,
+               -> {
+                 Increase::Internal::Type::ArrayOf[Increase::InboundCheckDeposit::Adjustment]
+               }
+
+      # @!attribute amount
+      #   The deposited amount in USD cents.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute back_image_file_id
+      #   The ID for the File containing the image of the back of the check.
+      #
+      #   @return [String, nil]
+      required :back_image_file_id, String, nil?: true
+
+      # @!attribute bank_of_first_deposit_routing_number
+      #   The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+      #   bank depositing this check. In some rare cases, this is not transmitted via
+      #   Check21 and the value will be null.
+      #
+      #   @return [String, nil]
+      required :bank_of_first_deposit_routing_number, String, nil?: true
+
+      # @!attribute check_number
+      #   The check number printed on the check being deposited.
+      #
+      #   @return [String, nil]
+      required :check_number, String, nil?: true
+
+      # @!attribute check_transfer_id
+      #   If this deposit is for an existing Check Transfer, the identifier of that Check
+      #   Transfer.
+      #
+      #   @return [String, nil]
+      required :check_transfer_id, String, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the deposit was attempted.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
+      #
+      #   @return [Symbol, Increase::Models::InboundCheckDeposit::Currency]
+      required :currency, enum: -> { Increase::InboundCheckDeposit::Currency }
+
+      # @!attribute declined_at
+      #   If the Inbound Check Deposit was declined, the
+      #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this
+      #   took place.
+      #
+      #   @return [Time, nil]
+      required :declined_at, Time, nil?: true
+
+      # @!attribute declined_transaction_id
+      #   If the deposit attempt has been rejected, the identifier of the Declined
+      #   Transaction object created as a result of the failed deposit.
+      #
+      #   @return [String, nil]
+      required :declined_transaction_id, String, nil?: true
+
+      # @!attribute deposit_return
+      #   If you requested a return of this deposit, this will contain details of the
+      #   return.
+      #
+      #   @return [Increase::Models::InboundCheckDeposit::DepositReturn, nil]
+      required :deposit_return, -> { Increase::InboundCheckDeposit::DepositReturn }, nil?: true
+
+      # @!attribute front_image_file_id
+      #   The ID for the File containing the image of the front of the check.
+      #
+      #   @return [String, nil]
+      required :front_image_file_id, String, nil?: true
+
+      # @!attribute payee_name_analysis
+      #   Whether the details on the check match the recipient name of the check transfer.
+      #   This is an optional feature, contact sales to enable.
+      #
+      #   @return [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis]
+      required :payee_name_analysis, enum: -> { Increase::InboundCheckDeposit::PayeeNameAnalysis }
+
+      # @!attribute status
+      #   The status of the Inbound Check Deposit.
+      #
+      #   @return [Symbol, Increase::Models::InboundCheckDeposit::Status]
+      required :status, enum: -> { Increase::InboundCheckDeposit::Status }
+
+      # @!attribute transaction_id
+      #   If the deposit attempt has been accepted, the identifier of the Transaction
+      #   object created as a result of the successful deposit.
+      #
+      #   @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
+      #   `inbound_check_deposit`.
+      #
+      #   @return [Symbol, Increase::Models::InboundCheckDeposit::Type]
+      required :type, enum: -> { Increase::InboundCheckDeposit::Type }
+
+      # @!method initialize(id:, accepted_at:, account_id:, account_number_id:, adjustments:, amount:, back_image_file_id:, bank_of_first_deposit_routing_number:, check_number:, check_transfer_id:, created_at:, currency:, declined_at:, declined_transaction_id:, deposit_return:, front_image_file_id:, payee_name_analysis:, status:, transaction_id:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundCheckDeposit} for more details.
+      #
+      #   Inbound Check Deposits are records of third-parties attempting to deposit checks
+      #   against your account.
+      #
+      #   @param id [String] The deposit's identifier.
+      #
+      #   @param accepted_at [Time, nil] If the Inbound Check Deposit was accepted, the [ISO 8601](https://en.wikipedia.o
+      #
+      #   @param account_id [String] The Account the check is being deposited against.
+      #
+      #   @param account_number_id [String, nil] The Account Number the check is being deposited against.
+      #
+      #   @param adjustments [Array<Increase::Models::InboundCheckDeposit::Adjustment>] If the deposit or the return was adjusted by the sending institution, this will
+      #
+      #   @param amount [Integer] The deposited amount in USD cents.
+      #
+      #   @param back_image_file_id [String, nil] The ID for the File containing the image of the back of the check.
+      #
+      #   @param bank_of_first_deposit_routing_number [String, nil] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the ban
+      #
+      #   @param check_number [String, nil] The check number printed on the check being deposited.
+      #
+      #   @param check_transfer_id [String, nil] If this deposit is for an existing Check Transfer, the identifier of that Check
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param currency [Symbol, Increase::Models::InboundCheckDeposit::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
+      #
+      #   @param declined_at [Time, nil] If the Inbound Check Deposit was declined, the [ISO 8601](https://en.wikipedia.o
+      #
+      #   @param declined_transaction_id [String, nil] If the deposit attempt has been rejected, the identifier of the Declined Transac
+      #
+      #   @param deposit_return [Increase::Models::InboundCheckDeposit::DepositReturn, nil] If you requested a return of this deposit, this will contain details of the retu
+      #
+      #   @param front_image_file_id [String, nil] The ID for the File containing the image of the front of the check.
+      #
+      #   @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis] Whether the details on the check match the recipient name of the check transfer.
+      #
+      #   @param status [Symbol, Increase::Models::InboundCheckDeposit::Status] The status of the Inbound Check Deposit.
+      #
+      #   @param transaction_id [String, nil] If the deposit attempt has been accepted, the identifier of the Transaction obje
+      #
+      #   @param type [Symbol, Increase::Models::InboundCheckDeposit::Type] A constant representing the object's type. For this resource it will always be `
+
+      class Adjustment < Increase::Internal::Type::BaseModel
+        # @!attribute adjusted_at
+        #   The time at which the return adjustment was received.
+        #
+        #   @return [Time]
+        required :adjusted_at, Time
+
+        # @!attribute amount
+        #   The amount of the adjustment.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute reason
+        #   The reason for the adjustment.
+        #
+        #   @return [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason]
+        required :reason, enum: -> { Increase::InboundCheckDeposit::Adjustment::Reason }
+
+        # @!attribute transaction_id
+        #   The id of the transaction for the adjustment.
+        #
+        #   @return [String]
+        required :transaction_id, String
+
+        # @!method initialize(adjusted_at:, amount:, reason:, transaction_id:)
+        #   @param adjusted_at [Time] The time at which the return adjustment was received.
+        #
+        #   @param amount [Integer] The amount of the adjustment.
+        #
+        #   @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason] The reason for the adjustment.
+        #
+        #   @param transaction_id [String] The id of the transaction for the adjustment.
+
+        # The reason for the adjustment.
+        #
+        # @see Increase::Models::InboundCheckDeposit::Adjustment#reason
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
+          LATE_RETURN = :late_return
+
+          # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
+          WRONG_PAYEE_CREDIT = :wrong_payee_credit
+
+          # The check was deposited with a different amount than what was written on the check.
+          ADJUSTED_AMOUNT = :adjusted_amount
+
+          # The recipient was not able to process the check. This usually happens for e.g., low quality images.
+          NON_CONFORMING_ITEM = :non_conforming_item
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
+      #
+      # @see Increase::Models::InboundCheckDeposit#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
+
+      # @see Increase::Models::InboundCheckDeposit#deposit_return
+      class DepositReturn < Increase::Internal::Type::BaseModel
+        # @!attribute reason
+        #   The reason the deposit was returned.
+        #
+        #   @return [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason]
+        required :reason, enum: -> { Increase::InboundCheckDeposit::DepositReturn::Reason }
+
+        # @!attribute returned_at
+        #   The time at which the deposit was returned.
+        #
+        #   @return [Time]
+        required :returned_at, Time
+
+        # @!attribute transaction_id
+        #   The id of the transaction for the returned deposit.
+        #
+        #   @return [String]
+        required :transaction_id, String
+
+        # @!method initialize(reason:, returned_at:, transaction_id:)
+        #   If you requested a return of this deposit, this will contain details of the
+        #   return.
+        #
+        #   @param reason [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason] The reason the deposit was returned.
+        #
+        #   @param returned_at [Time] The time at which the deposit was returned.
+        #
+        #   @param transaction_id [String] The id of the transaction for the returned deposit.
+
+        # The reason the deposit was returned.
+        #
+        # @see Increase::Models::InboundCheckDeposit::DepositReturn#reason
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The check was altered or fictitious.
+          ALTERED_OR_FICTITIOUS = :altered_or_fictitious
+
+          # The check was not authorized.
+          NOT_AUTHORIZED = :not_authorized
+
+          # The check was a duplicate presentment.
+          DUPLICATE_PRESENTMENT = :duplicate_presentment
+
+          # The check was not endorsed.
+          ENDORSEMENT_MISSING = :endorsement_missing
+
+          # The check was not endorsed by the payee.
+          ENDORSEMENT_IRREGULAR = :endorsement_irregular
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Whether the details on the check match the recipient name of the check transfer.
+      # This is an optional feature, contact sales to enable.
+      #
+      # @see Increase::Models::InboundCheckDeposit#payee_name_analysis
+      module PayeeNameAnalysis
+        extend Increase::Internal::Type::Enum
+
+        # The details on the check match the recipient name of the check transfer.
+        NAME_MATCHES = :name_matches
+
+        # The details on the check do not match the recipient name of the check transfer.
+        DOES_NOT_MATCH = :does_not_match
+
+        # The payee name analysis was not evaluated.
+        NOT_EVALUATED = :not_evaluated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the Inbound Check Deposit.
+      #
+      # @see Increase::Models::InboundCheckDeposit#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The Inbound Check Deposit is pending.
+        PENDING = :pending
+
+        # The Inbound Check Deposit was accepted.
+        ACCEPTED = :accepted
+
+        # The Inbound Check Deposit was rejected.
+        DECLINED = :declined
+
+        # The Inbound Check Deposit was returned.
+        RETURNED = :returned
+
+        # The Inbound Check Deposit requires attention from an Increase operator.
+        REQUIRES_ATTENTION = :requires_attention
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `inbound_check_deposit`.
+      #
+      # @see Increase::Models::InboundCheckDeposit#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        INBOUND_CHECK_DEPOSIT = :inbound_check_deposit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/inbound_check_deposit_decline_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundCheckDeposits#decline
+    class InboundCheckDepositDeclineParams < 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/inbound_check_deposit_list_params.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundCheckDeposits#list
+    class InboundCheckDepositListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Inbound Check Deposits to those belonging to the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute check_transfer_id
+      #   Filter Inbound Check Deposits to those belonging to the specified Check
+      #   Transfer.
+      #
+      #   @return [String, nil]
+      optional :check_transfer_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::InboundCheckDepositListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::InboundCheckDepositListParams::CreatedAt }
+
+      # @!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, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundCheckDepositListParams} for more details.
+      #
+      #   @param account_id [String] Filter Inbound Check Deposits to those belonging to the specified Account.
+      #
+      #   @param check_transfer_id [String] Filter Inbound Check Deposits to those belonging to the specified Check Transfer
+      #
+      #   @param created_at [Increase::Models::InboundCheckDepositListParams::CreatedAt]
+      #
+      #   @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}]
+
+      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::InboundCheckDepositListParams::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
+    end
+  end
+end

data/lib/increase/models/inbound_check_deposit_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundCheckDeposits#retrieve
+    class InboundCheckDepositRetrieveParams < 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/inbound_check_deposit_return_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundCheckDeposits#return_
+    class InboundCheckDepositReturnParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute reason
+      #   The reason to return the Inbound Check Deposit.
+      #
+      #   @return [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason]
+      required :reason, enum: -> { Increase::InboundCheckDepositReturnParams::Reason }
+
+      # @!method initialize(reason:, request_options: {})
+      #   @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] The reason to return the Inbound Check Deposit.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The reason to return the Inbound Check Deposit.
+      module Reason
+        extend Increase::Internal::Type::Enum
+
+        # The check was altered or fictitious.
+        ALTERED_OR_FICTITIOUS = :altered_or_fictitious
+
+        # The check was not authorized.
+        NOT_AUTHORIZED = :not_authorized
+
+        # The check was a duplicate presentment.
+        DUPLICATE_PRESENTMENT = :duplicate_presentment
+
+        # The check was not endorsed.
+        ENDORSEMENT_MISSING = :endorsement_missing
+
+        # The check was not endorsed by the payee.
+        ENDORSEMENT_IRREGULAR = :endorsement_irregular
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/inbound_mail_item.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundMailItems#retrieve
+    class InboundMailItem < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Inbound Mail Item identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
+      #   Mail Item was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute file_id
+      #   The identifier for the File containing the scanned contents of the mail item.
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!attribute lockbox_id
+      #   The identifier for the Lockbox that received this mail item. For mail items that
+      #   could not be processed due to an invalid address, this will be null.
+      #
+      #   @return [String, nil]
+      required :lockbox_id, String, nil?: true
+
+      # @!attribute recipient_name
+      #   The recipient name as written on the mail item.
+      #
+      #   @return [String, nil]
+      required :recipient_name, String, nil?: true
+
+      # @!attribute rejection_reason
+      #   If the mail item has been rejected, why it was rejected.
+      #
+      #   @return [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil]
+      required :rejection_reason, enum: -> { Increase::InboundMailItem::RejectionReason }, nil?: true
+
+      # @!attribute status
+      #   If the mail item has been processed.
+      #
+      #   @return [Symbol, Increase::Models::InboundMailItem::Status]
+      required :status, enum: -> { Increase::InboundMailItem::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `inbound_mail_item`.
+      #
+      #   @return [Symbol, Increase::Models::InboundMailItem::Type]
+      required :type, enum: -> { Increase::InboundMailItem::Type }
+
+      # @!method initialize(id:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundMailItem} for more details.
+      #
+      #   Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.
+      #
+      #   @param id [String] The Inbound Mail Item identifier.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
+      #
+      #   @param file_id [String] The identifier for the File containing the scanned contents of the mail item.
+      #
+      #   @param lockbox_id [String, nil] The identifier for the Lockbox that received this mail item. For mail items that
+      #
+      #   @param recipient_name [String, nil] The recipient name as written on the mail item.
+      #
+      #   @param rejection_reason [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil] If the mail item has been rejected, why it was rejected.
+      #
+      #   @param status [Symbol, Increase::Models::InboundMailItem::Status] If the mail item has been processed.
+      #
+      #   @param type [Symbol, Increase::Models::InboundMailItem::Type] A constant representing the object's type. For this resource it will always be `
+
+      # If the mail item has been rejected, why it was rejected.
+      #
+      # @see Increase::Models::InboundMailItem#rejection_reason
+      module RejectionReason
+        extend Increase::Internal::Type::Enum
+
+        # The mail item does not match any lockbox.
+        NO_MATCHING_LOCKBOX = :no_matching_lockbox
+
+        # The mail item does not contain a check.
+        NO_CHECK = :no_check
+
+        # The Lockbox or its associated Account is not active.
+        LOCKBOX_NOT_ACTIVE = :lockbox_not_active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # If the mail item has been processed.
+      #
+      # @see Increase::Models::InboundMailItem#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The mail item is pending processing.
+        PENDING = :pending
+
+        # The mail item has been processed.
+        PROCESSED = :processed
+
+        # The mail item has been rejected.
+        REJECTED = :rejected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `inbound_mail_item`.
+      #
+      # @see Increase::Models::InboundMailItem#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        INBOUND_MAIL_ITEM = :inbound_mail_item
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end