increase 1.338.0 → 1.339.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2421d28be1ae99adb5ebd0f1d35ec9dc9bde67202bb9a603f87df09aceb1007
-  data.tar.gz: 27edbc064aaac7181030d074f4afe519af357bb0b5b8345bc85529a780f6656f
+  metadata.gz: d066a5655d395f885866d82a947c1f4b2fc96fc340b95e78855ef7e62cde2c65
+  data.tar.gz: 5e37b231a1ff2b1bc4d470fcc28468258d29a65a98214caf53f48109631fb591
 SHA512:
-  metadata.gz: 1a2ad5882a85fa5f919c3042f8b55a16a093fac9200d4c081f49797a43003dfc5a942548d558fa615a82c303a93d3293942ab392bb39490cd6deb27ad5468f64
-  data.tar.gz: 304c56360d05c83059b3905d2883dfea6d0a41e90dc81023f54121e187ac09d11d3dab40926fc438c07341c5d41d3a606fa950ed4e38fa64ff57b8bb403f7b71
+  metadata.gz: 9f3fcdc88cf60376cf49522de5cbcd4ed9a56b350be6e02cb9ab145735b879a03d1ca9f629591d43a2c8be1e25c7174f72d7abc2994a949f19c5603be170738e
+  data.tar.gz: 84abe452d0dc86a40fe772bfe79c3aaf9a0eaf3375ee84c87ddb1e41972aeb89986d567276d5b981fb5f6f746431c738504c826dc3d8ed19f41bf602320ca8e1

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.338.0"
+gem "increase", "~> 1.339.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/account_create_params.rb

@@ -39,8 +39,9 @@ module Increase
       optional :loan, -> { Increase::AccountCreateParams::Loan }
 
       # @!attribute program_id
-      #   The identifier for the Program that this Account falls under. Required if you
-      #   operate more than one Program.
+      #   The identifier for the Program that this Account falls under. Required if your
+      #   Group operates more than one Program. List your [Programs](#programs) to find
+      #   their identifiers.
       #
       #   @return [String, nil]
       optional :program_id, String
@@ -59,7 +60,7 @@ module Increase
       #
       #   @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
       #
-      #   @param program_id [String] The identifier for the Program that this Account falls under. Required if you op
+      #   @param program_id [String] The identifier for the Program that this Account falls under. Required if your G
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/increase/models/ach_transfer.rb

@@ -17,7 +17,7 @@ module Increase
       required :account_id, String
 
       # @!attribute account_number
-      #   The destination account number.
+      #   The receiver's account number.
       #
       #   @return [String]
       required :account_number, String
@@ -109,8 +109,7 @@ module Increase
       required :currency, enum: -> { Increase::ACHTransfer::Currency }
 
       # @!attribute destination_account_holder
-      #   The type of entity that owns the account to which the ACH Transfer is being
-      #   sent.
+      #   The type of entity that owns the receiver's account.
       #
       #   @return [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder]
       required :destination_account_holder, enum: -> { Increase::ACHTransfer::DestinationAccountHolder }
@@ -122,7 +121,7 @@ module Increase
       required :external_account_id, String, nil?: true
 
       # @!attribute funding
-      #   The type of the account to which the transfer will be sent.
+      #   The type of the receiver's bank account.
       #
       #   @return [Symbol, Increase::Models::ACHTransfer::Funding]
       required :funding, enum: -> { Increase::ACHTransfer::Funding }
@@ -143,7 +142,8 @@ module Increase
       required :inbound_funds_hold, -> { Increase::ACHTransfer::InboundFundsHold }, nil?: true
 
       # @!attribute individual_id
-      #   Your identifier for the transfer recipient.
+      #   Your internal identifier for the transfer recipient. This value is informational
+      #   and not verified by the recipient's bank.
       #
       #   @return [String, nil]
       required :individual_id, String, nil?: true
@@ -194,7 +194,8 @@ module Increase
       required :return_, -> { Increase::ACHTransfer::Return }, api_name: :return, nil?: true
 
       # @!attribute routing_number
-      #   The American Bankers' Association (ABA) Routing Transit Number (RTN).
+      #   The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
+      #   receiver's bank.
       #
       #   @return [String]
       required :routing_number, String
@@ -260,7 +261,7 @@ module Increase
       #
       #   @param account_id [String] The Account to which the transfer belongs.
       #
-      #   @param account_number [String] The destination account number.
+      #   @param account_number [String] The receiver's account number.
       #
       #   @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] After the transfer is acknowledged by FedACH, this will contain supplemental det
       #
@@ -288,17 +289,17 @@ module Increase
       #
       #   @param currency [Symbol, Increase::Models::ACHTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
       #
-      #   @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent
+      #   @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] The type of entity that owns the receiver's account.
       #
       #   @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
       #
-      #   @param funding [Symbol, Increase::Models::ACHTransfer::Funding] The type of the account to which the transfer will be sent.
+      #   @param funding [Symbol, Increase::Models::ACHTransfer::Funding] The type of the receiver's bank account.
       #
       #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
       #
       #   @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] Increase will sometimes hold the funds for ACH debit transfers. If funds are hel
       #
-      #   @param individual_id [String, nil] Your identifier for the transfer recipient.
+      #   @param individual_id [String, nil] Your internal identifier for the transfer recipient. This value is informational
       #
       #   @param individual_name [String, nil] The name of the transfer recipient. This value is informational and not verified
       #
@@ -312,7 +313,7 @@ module Increase
       #
       #   @param return_ [Increase::Models::ACHTransfer::Return, nil] If your transfer is returned, this will contain details of the return.
       #
-      #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
+      #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) of the rece
       #
       #   @param settlement [Increase::Models::ACHTransfer::Settlement, nil] A subhash containing information about when and how the transfer settled at the
       #
@@ -640,8 +641,7 @@ module Increase
         #   @return [Array<Symbol>]
       end
 
-      # The type of entity that owns the account to which the ACH Transfer is being
-      # sent.
+      # The type of entity that owns the receiver's account.
       #
       # @see Increase::Models::ACHTransfer#destination_account_holder
       module DestinationAccountHolder
@@ -660,7 +660,7 @@ module Increase
         #   @return [Array<Symbol>]
       end
 
-      # The type of the account to which the transfer will be sent.
+      # The type of the receiver's bank account.
       #
       # @see Increase::Models::ACHTransfer#funding
       module Funding
@@ -1019,7 +1019,7 @@ module Increase
           # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.
           # This is necessary, but not sufficient for the transfer to be settled same-day:
           # it must also be submitted before the last same-day cutoff
-          # and be less than or equal to $1,000.000.00.
+          # and be less than or equal to $1,000,000.00.
           SAME_DAY = :same_day
 
           # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day.
@@ -1068,7 +1068,8 @@ module Increase
         required :transaction_id, String
 
         # @!attribute transfer_id
-        #   The identifier of the ACH Transfer associated with this return.
+        #   The identifier of the ACH Transfer associated with this return. This matches the
+        #   original Transaction's `source.ach_transfer_intention.transfer_id`.
         #
         #   @return [String]
         required :transfer_id, String
@@ -1089,7 +1090,7 @@ module Increase
         #
         #   @param transaction_id [String] The identifier of the Transaction associated with this return.
         #
-        #   @param transfer_id [String] The identifier of the ACH Transfer associated with this return.
+        #   @param transfer_id [String] The identifier of the ACH Transfer associated with this return. This matches the
 
         # Why the ACH Transfer was returned. This reason code is sent by the receiving
         # bank back to Increase.
@@ -1386,7 +1387,7 @@ module Increase
         # The transfer has been rejected.
         REJECTED = :rejected
 
-        # The transfer is complete.
+        # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
         SUBMITTED = :submitted
 
         # The transfer has been returned.

data/lib/increase/models/ach_transfer_create_params.rb

@@ -33,50 +33,58 @@ module Increase
       required :statement_descriptor, String
 
       # @!attribute account_number
-      #   The account number for the destination account.
+      #   The receiver's account number. For credit transfers (positive `amount`) this is
+      #   the account that funds will be sent to. For debit transfers (negative `amount`)
+      #   this is the account that funds will be pulled from.
       #
       #   @return [String, nil]
       optional :account_number, String
 
       # @!attribute addenda
-      #   Additional information that will be sent to the recipient. This is included in
-      #   the transfer data sent to the receiving bank.
+      #   Additional information passed through to the receiving bank with the transfer.
+      #   Most ACH transfers do not need this. Only set this if your recipient has asked
+      #   for addendum data, typically unstructured remittance information. Corporate
+      #   Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
       #
       #   @return [Increase::Models::ACHTransferCreateParams::Addenda, nil]
       optional :addenda, -> { Increase::ACHTransferCreateParams::Addenda }
 
       # @!attribute company_descriptive_date
-      #   The description of the date of the transfer, usually in the format `YYMMDD`.
-      #   This is included in the transfer data sent to the receiving bank.
+      #   A description of the transfer date (typically `YYMMDD`), sent in the company
+      #   batch header. This value is informational and does not affect funds movement,
+      #   settlement timing, or returns. Only set this if your recipient has asked for it.
       #
       #   @return [String, nil]
       optional :company_descriptive_date, String
 
       # @!attribute company_discretionary_data
-      #   The data you choose to associate with the transfer. This is included in the
-      #   transfer data sent to the receiving bank.
+      #   Custom data sent in the company batch header. This value is informational and
+      #   does not affect funds movement, settlement timing, or returns. Most ACH
+      #   transfers do not need this. Only set this if your recipient has asked for it.
       #
       #   @return [String, nil]
       optional :company_discretionary_data, String
 
       # @!attribute company_entry_description
-      #   A description of the transfer, included in the transfer data sent to the
-      #   receiving bank. Standardized formatting may be required, for example `PAYROLL`
-      #   for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
+      #   A short description sent in the company batch header. Most receivers do not
+      #   surface this. Only set this if your recipient has asked for a specific value or
+      #   if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
+      #   example, Prearranged Payment and Deposit (PPD) payroll credits must use
+      #   `PAYROLL`, and reversals must use `REVERSAL`.
       #
       #   @return [String, nil]
       optional :company_entry_description, String
 
       # @!attribute company_name
-      #   The name by which the recipient knows you. This is included in the transfer data
-      #   sent to the receiving bank.
+      #   The name by which the recipient knows you, sent in the company batch header. We
+      #   recommend setting this on every transfer; if you do not, we fall back to the ACH
+      #   company name configured on your account.
       #
       #   @return [String, nil]
       optional :company_name, String
 
       # @!attribute destination_account_holder
-      #   The type of entity that owns the account to which the ACH Transfer is being
-      #   sent.
+      #   The type of entity that owns the receiver's account.
       #
       #   @return [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder, nil]
       optional :destination_account_holder,
@@ -90,13 +98,14 @@ module Increase
       optional :external_account_id, String
 
       # @!attribute funding
-      #   The type of the account to which the transfer will be sent.
+      #   The type of the receiver's bank account.
       #
       #   @return [Symbol, Increase::Models::ACHTransferCreateParams::Funding, nil]
       optional :funding, enum: -> { Increase::ACHTransferCreateParams::Funding }
 
       # @!attribute individual_id
-      #   Your identifier for the transfer recipient.
+      #   Your internal identifier for the transfer recipient. This value is informational
+      #   and not verified by the recipient's bank. Most callers can leave this unset.
       #
       #   @return [String, nil]
       optional :individual_id, String
@@ -124,8 +133,8 @@ module Increase
       optional :require_approval, Increase::Internal::Type::Boolean
 
       # @!attribute routing_number
-      #   The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
-      #   destination account.
+      #   The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
+      #   receiver's bank.
       #
       #   @return [String, nil]
       optional :routing_number, String
@@ -133,7 +142,8 @@ module Increase
       # @!attribute standard_entry_class_code
       #   The
       #   [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
-      #   to use for the transfer.
+      #   to use for the transfer. If not provided, the default is
+      #   `corporate_credit_or_debit`.
       #
       #   @return [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode, nil]
       optional :standard_entry_class_code,
@@ -155,25 +165,25 @@ module Increase
       #
       #   @param statement_descriptor [String] A description you choose to give the transfer. This will be saved with the trans
       #
-      #   @param account_number [String] The account number for the destination account.
+      #   @param account_number [String] The receiver's account number. For credit transfers (positive `amount`) this is
       #
-      #   @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information that will be sent to the recipient. This is included in t
+      #   @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information passed through to the receiving bank with the transfer. M
       #
-      #   @param company_descriptive_date [String] The description of the date of the transfer, usually in the format `YYMMDD`. Thi
+      #   @param company_descriptive_date [String] A description of the transfer date (typically `YYMMDD`), sent in the company bat
       #
-      #   @param company_discretionary_data [String] The data you choose to associate with the transfer. This is included in the tran
+      #   @param company_discretionary_data [String] Custom data sent in the company batch header. This value is informational and do
       #
-      #   @param company_entry_description [String] A description of the transfer, included in the transfer data sent to the receivi
+      #   @param company_entry_description [String] A short description sent in the company batch header. Most receivers do not surf
       #
-      #   @param company_name [String] The name by which the recipient knows you. This is included in the transfer data
+      #   @param company_name [String] The name by which the recipient knows you, sent in the company batch header. We
       #
-      #   @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent
+      #   @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the receiver's account.
       #
       #   @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
       #
-      #   @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the account to which the transfer will be sent.
+      #   @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the receiver's bank account.
       #
-      #   @param individual_id [String] Your identifier for the transfer recipient.
+      #   @param individual_id [String] Your internal identifier for the transfer recipient. This value is informational
       #
       #   @param individual_name [String] The name of the transfer recipient. This value is informational and not verified
       #
@@ -181,7 +191,7 @@ module Increase
       #
       #   @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
       #
-      #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
+      #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) of the rece
       #
       #   @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-co
       #
@@ -216,8 +226,10 @@ module Increase
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::ACHTransferCreateParams::Addenda} for more details.
         #
-        #   Additional information that will be sent to the recipient. This is included in
-        #   the transfer data sent to the receiving bank.
+        #   Additional information passed through to the receiving bank with the transfer.
+        #   Most ACH transfers do not need this. Only set this if your recipient has asked
+        #   for addendum data, typically unstructured remittance information. Corporate
+        #   Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
         #
         #   @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] The type of addenda to pass with the transfer.
         #
@@ -315,8 +327,7 @@ module Increase
         end
       end
 
-      # The type of entity that owns the account to which the ACH Transfer is being
-      # sent.
+      # The type of entity that owns the receiver's account.
       module DestinationAccountHolder
         extend Increase::Internal::Type::Enum
 
@@ -333,7 +344,7 @@ module Increase
         #   @return [Array<Symbol>]
       end
 
-      # The type of the account to which the transfer will be sent.
+      # The type of the receiver's bank account.
       module Funding
         extend Increase::Internal::Type::Enum
 
@@ -388,7 +399,7 @@ module Increase
         module SettlementSchedule
           extend Increase::Internal::Type::Enum
 
-          # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000.000.00.
+          # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000,000.00.
           SAME_DAY = :same_day
 
           # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day.
@@ -401,7 +412,8 @@ module Increase
 
       # The
       # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
-      # to use for the transfer.
+      # to use for the transfer. If not provided, the default is
+      # `corporate_credit_or_debit`.
       module StandardEntryClassCode
         extend Increase::Internal::Type::Enum
 

data/lib/increase/models/ach_transfer_list_params.rb

@@ -153,7 +153,7 @@ module Increase
           # The transfer has been rejected.
           REJECTED = :rejected
 
-          # The transfer is complete.
+          # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
           SUBMITTED = :submitted
 
           # The transfer has been returned.

data/lib/increase/models/beneficial_owner_create_params.rb

@@ -173,7 +173,8 @@ module Increase
           #   An identification number that can be used to verify the individual's identity,
           #   such as a social security number. For Social Security Numbers and Individual
           #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-          #   separators.
+          #   separators. When testing in sandbox, use one of our
+          #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
           #
           #   @return [String]
           required :number, String

data/lib/increase/models/beneficial_owner_update_params.rb

@@ -140,7 +140,8 @@ module Increase
         #   An identification number that can be used to verify the individual's identity,
         #   such as a social security number. For Social Security Numbers and Individual
         #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-        #   separators.
+        #   separators. When testing in sandbox, use one of our
+        #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
         #
         #   @return [String]
         required :number, String

data/lib/increase/models/card_push_transfer.rb

@@ -1380,15 +1380,15 @@ module Increase
         # The transfer has been canceled.
         CANCELED = :canceled
 
+        # The transfer is queued to be submitted to the card network.
+        PENDING_SUBMISSION = :pending_submission
+
         # The transfer is pending review by Increase.
         PENDING_REVIEWING = :pending_reviewing
 
         # The transfer requires attention from an Increase operator.
         REQUIRES_ATTENTION = :requires_attention
 
-        # The transfer is queued to be submitted to the card network.
-        PENDING_SUBMISSION = :pending_submission
-
         # The transfer has been submitted and is pending a response from the card network.
         SUBMITTED = :submitted
 

data/lib/increase/models/card_push_transfer_list_params.rb

@@ -132,15 +132,15 @@ module Increase
           # The transfer has been canceled.
           CANCELED = :canceled
 
+          # The transfer is queued to be submitted to the card network.
+          PENDING_SUBMISSION = :pending_submission
+
           # The transfer is pending review by Increase.
           PENDING_REVIEWING = :pending_reviewing
 
           # The transfer requires attention from an Increase operator.
           REQUIRES_ATTENTION = :requires_attention
 
-          # The transfer is queued to be submitted to the card network.
-          PENDING_SUBMISSION = :pending_submission
-
           # The transfer has been submitted and is pending a response from the card network.
           SUBMITTED = :submitted
 

data/lib/increase/models/check_transfer.rb

@@ -788,10 +788,13 @@ module Increase
             # The check has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single check may have more than one delivered event.
             DELIVERED = :delivered
 
-            # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be returned to sender.
+            # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be rerouted to the return address.
             DELIVERY_ISSUE = :delivery_issue
 
-            # Delivery failed and the check was returned to sender.
+            # The check has been rerouted to the return address.
+            RETURNING_TO_SENDER = :returning_to_sender
+
+            # The check has been delivered to the return address.
             RETURNED_TO_SENDER = :returned_to_sender
 
             # @!method self.values

data/lib/increase/models/entity_create_params.rb

@@ -159,7 +159,8 @@ module Increase
 
         # @!attribute legal_identifier
         #   The legal identifier of the corporation. This is usually the Employer
-        #   Identification Number (EIN).
+        #   Identification Number (EIN). This replaces the deprecated `tax_identifier`
+        #   field.
         #
         #   @return [Increase::Models::EntityCreateParams::Corporation::LegalIdentifier]
         required :legal_identifier, -> { Increase::EntityCreateParams::Corporation::LegalIdentifier }
@@ -456,7 +457,8 @@ module Increase
               #   An identification number that can be used to verify the individual's identity,
               #   such as a social security number. For Social Security Numbers and Individual
               #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-              #   separators.
+              #   separators. When testing in sandbox, use one of our
+              #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
               #
               #   @return [String]
               required :number, String
@@ -675,7 +677,8 @@ module Increase
         class LegalIdentifier < Increase::Internal::Type::BaseModel
           # @!attribute value
           #   The legal identifier. For US Employer Identification Numbers, submit nine digits
-          #   with no dashes or other separators.
+          #   with no dashes or other separators. When testing in sandbox, use one of our
+          #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
           #
           #   @return [String]
           required :value, String
@@ -693,7 +696,8 @@ module Increase
           #   details.
           #
           #   The legal identifier of the corporation. This is usually the Employer
-          #   Identification Number (EIN).
+          #   Identification Number (EIN). This replaces the deprecated `tax_identifier`
+          #   field.
           #
           #   @param value [String] The legal identifier. For US Employer Identification Numbers, submit nine digits
           #
@@ -1025,7 +1029,8 @@ module Increase
             #   An identification number that can be used to verify the individual's identity,
             #   such as a social security number. For Social Security Numbers and Individual
             #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-            #   separators.
+            #   separators. When testing in sandbox, use one of our
+            #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
             #
             #   @return [String]
             required :number, String
@@ -1352,7 +1357,8 @@ module Increase
           #   An identification number that can be used to verify the individual's identity,
           #   such as a social security number. For Social Security Numbers and Individual
           #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-          #   separators.
+          #   separators. When testing in sandbox, use one of our
+          #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
           #
           #   @return [String]
           required :number, String
@@ -1996,7 +2002,8 @@ module Increase
               #   An identification number that can be used to verify the individual's identity,
               #   such as a social security number. For Social Security Numbers and Individual
               #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-              #   separators.
+              #   separators. When testing in sandbox, use one of our
+              #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
               #
               #   @return [String]
               required :number, String
@@ -2323,7 +2330,8 @@ module Increase
             #   An identification number that can be used to verify the individual's identity,
             #   such as a social security number. For Social Security Numbers and Individual
             #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-            #   separators.
+            #   separators. When testing in sandbox, use one of our
+            #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
             #
             #   @return [String]
             required :number, String

data/lib/increase/models/entity_update_params.rb

@@ -467,7 +467,8 @@ module Increase
           #   An identification number that can be used to verify the individual's identity,
           #   such as a social security number. For Social Security Numbers and Individual
           #   Taxpayer Identification Numbers, submit nine digits with no dashes or other
-          #   separators.
+          #   separators. When testing in sandbox, use one of our
+          #   [sandbox test values](https://increase.com/documentation/sandbox-test-values).
           #
           #   @return [String]
           required :number, String

data/lib/increase/models/fednow_transfer.rb

@@ -518,6 +518,9 @@ module Increase
       module Status
         extend Increase::Internal::Type::Enum
 
+        # The transfer is queued to be submitted to FedNow.
+        PENDING_SUBMITTING = :pending_submitting
+
         # The transfer is pending review by Increase.
         PENDING_REVIEWING = :pending_reviewing
 
@@ -533,9 +536,6 @@ module Increase
         # The transfer is pending approval.
         PENDING_APPROVAL = :pending_approval
 
-        # The transfer is queued to be submitted to FedNow.
-        PENDING_SUBMITTING = :pending_submitting
-
         # The transfer has been submitted and is pending a response from FedNow.
         PENDING_RESPONSE = :pending_response
 

data/lib/increase/models/fednow_transfer_list_params.rb

@@ -134,6 +134,9 @@ module Increase
         module In
           extend Increase::Internal::Type::Enum
 
+          # The transfer is queued to be submitted to FedNow.
+          PENDING_SUBMITTING = :pending_submitting
+
           # The transfer is pending review by Increase.
           PENDING_REVIEWING = :pending_reviewing
 
@@ -149,9 +152,6 @@ module Increase
           # The transfer is pending approval.
           PENDING_APPROVAL = :pending_approval
 
-          # The transfer is queued to be submitted to FedNow.
-          PENDING_SUBMITTING = :pending_submitting
-
           # The transfer has been submitted and is pending a response from FedNow.
           PENDING_RESPONSE = :pending_response
 

data/lib/increase/models/inbound_mail_item.rb

@@ -72,7 +72,9 @@ module Increase
       #   {Increase::Models::InboundMailItem} for more details.
       #
       #   Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
-      #   Address.
+      #   Address. Increase automatically deposits checks mailed to a Lockbox Recipient
+      #   into the recipient's Account. Checks that are not matched to a Lockbox Recipient
+      #   must be deposited or ignored using the Action an Inbound Mail Item endpoint.
       #
       #   @param id [String] The Inbound Mail Item identifier.
       #

data/lib/increase/models/inbound_real_time_payments_transfer.rb

@@ -245,7 +245,7 @@ module Increase
         # The transfer is pending confirmation.
         PENDING_CONFIRMING = :pending_confirming
 
-        # The transfer was not responded to in time.
+        # The transfer was not responded to in time. This is rare and represents an error at Increase.
         TIMED_OUT = :timed_out
 
         # The transfer has been received successfully and is confirmed.