increase 1.338.0 → 1.340.0

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
@@ -674,8 +676,10 @@ module Increase
         # @see Increase::Models::EntityCreateParams::Corporation#legal_identifier
         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.
+          #   The legal identifier itself. For US Employer Identification Numbers, submit nine
+          #   digits 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,9 +697,10 @@ 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
+          #   @param value [String] The legal identifier itself. For US Employer Identification Numbers, submit nine
           #
           #   @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier. If not provided, the default is `us_employ
 
@@ -1025,7 +1030,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 +1358,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 +2003,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 +2331,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_supplemental_document.rb

@@ -43,7 +43,7 @@ module Increase
       #   {Increase::Models::EntitySupplementalDocument} for more details.
       #
       #   Supplemental Documents are uploaded files connected to an Entity during
-      #   onboarding.
+      #   onboarding. Not all programs require supplemental documents.
       #
       #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplem
       #

data/lib/increase/models/entity_update_params.rb

@@ -230,8 +230,8 @@ module Increase
         # @see Increase::Models::EntityUpdateParams::Corporation#legal_identifier
         class LegalIdentifier < Increase::Internal::Type::BaseModel
           # @!attribute value
-          #   The identifier of the legal identifier. For US Employer Identification Numbers,
-          #   submit nine digits with no dashes or other separators.
+          #   The legal identifier itself. For US Employer Identification Numbers, submit nine
+          #   digits with no dashes or other separators.
           #
           #   @return [String]
           required :value, String
@@ -250,7 +250,7 @@ module Increase
           #   The legal identifier of the corporation. This is usually the Employer
           #   Identification Number (EIN).
           #
-          #   @param value [String] The identifier of the legal identifier. For US Employer Identification Numbers,
+          #   @param value [String] The legal identifier itself. For US Employer Identification Numbers, submit nine
           #
           #   @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier.
 
@@ -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.

data/lib/increase/models/lockbox_address.rb

@@ -56,7 +56,11 @@ module Increase
       #   {Increase::Models::LockboxAddress} for more details.
       #
       #   Lockbox Addresses are physical locations that can receive mail containing paper
-      #   checks.
+      #   checks. A Lockbox Address is not itself linked to an Account; Lockbox Recipients
+      #   determine where checks received at the address are deposited. Lockbox Addresses
+      #   are created with a `pending` status and a null `address`. Increase generates the
+      #   mailing address shortly after creation, at which point the status becomes
+      #   `active`.
       #
       #   @param id [String] The Lockbox Address identifier.
       #

data/lib/increase/models/lockbox_recipient_create_params.rb

@@ -14,7 +14,8 @@ module Increase
       required :account_id, String
 
       # @!attribute lockbox_address_id
-      #   The Lockbox Address where this Lockbox Recipient may receive mail.
+      #   The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
+      #   Address must have a `status` of `active`.
       #
       #   @return [String]
       required :lockbox_address_id, String
@@ -37,7 +38,7 @@ module Increase
       #
       #   @param account_id [String] The Account that checks sent to this Lockbox Recipient should be deposited into.
       #
-      #   @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail.
+      #   @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox A
       #
       #   @param description [String] The description you choose for the Lockbox Recipient.
       #

data/lib/increase/models/pending_transaction.rb

@@ -18,7 +18,10 @@ module Increase
 
       # @!attribute amount
       #   The Pending Transaction amount in the minor unit of its currency. For dollars,
-      #   for example, this is cents.
+      #   for example, this is cents. This amount does not change after the Pending
+      #   Transaction is created. If a card authorization settles for a different amount,
+      #   the settled amount is available on the resulting Transaction and on the Card
+      #   Payment's `state.settled_amount`.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -2638,7 +2641,7 @@ module Increase
         # The Pending Transaction is still awaiting confirmation.
         PENDING = :pending
 
-        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
+        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
         COMPLETE = :complete
 
         # @!method self.values

data/lib/increase/models/pending_transaction_list_params.rb

@@ -209,7 +209,7 @@ module Increase
           # The Pending Transaction is still awaiting confirmation.
           PENDING = :pending
 
-          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
+          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
           COMPLETE = :complete
 
           # @!method self.values

data/lib/increase/models/physical_card.rb

@@ -431,10 +431,13 @@ module Increase
               # The physical card has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single physical card 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 physical card 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 physical card will be rerouted to the return address.
               DELIVERY_ISSUE = :delivery_issue
 
-              # Delivery failed and the physical card was returned to sender.
+              # The physical card has been rerouted to the return address.
+              RETURNING_TO_SENDER = :returning_to_sender
+
+              # The physical card has been delivered to the return address.
               RETURNED_TO_SENDER = :returned_to_sender
 
               # @!method self.values

data/lib/increase/models/real_time_payments_transfer.rb

@@ -538,6 +538,9 @@ module Increase
         # The transfer has been canceled.
         CANCELED = :canceled
 
+        # The transfer is queued to be submitted to Real-Time Payments.
+        PENDING_SUBMISSION = :pending_submission
+
         # The transfer is pending review by Increase.
         PENDING_REVIEWING = :pending_reviewing
 
@@ -547,9 +550,6 @@ module Increase
         # The transfer was rejected by the network or the recipient's bank.
         REJECTED = :rejected
 
-        # The transfer is queued to be submitted to Real-Time Payments.
-        PENDING_SUBMISSION = :pending_submission
-
         # The transfer has been submitted and is pending a response from Real-Time Payments.
         SUBMITTED = :submitted
 

data/lib/increase/models/real_time_payments_transfer_list_params.rb

@@ -142,6 +142,9 @@ module Increase
           # The transfer has been canceled.
           CANCELED = :canceled
 
+          # The transfer is queued to be submitted to Real-Time Payments.
+          PENDING_SUBMISSION = :pending_submission
+
           # The transfer is pending review by Increase.
           PENDING_REVIEWING = :pending_reviewing
 
@@ -151,9 +154,6 @@ module Increase
           # The transfer was rejected by the network or the recipient's bank.
           REJECTED = :rejected
 
-          # The transfer is queued to be submitted to Real-Time Payments.
-          PENDING_SUBMISSION = :pending_submission
-
           # The transfer has been submitted and is pending a response from Real-Time Payments.
           SUBMITTED = :submitted
 

data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb

@@ -53,7 +53,8 @@ module Increase
         optional :company_id, String
 
         # @!attribute company_name
-        #   The name of the sender.
+        #   The name of the sender. This corresponds to the `originator_company_name` field
+        #   on the resulting Inbound ACH Transfer.
         #
         #   @return [String, nil]
         optional :company_name, String
@@ -103,7 +104,7 @@ module Increase
         #
         #   @param company_id [String] The sender's company ID.
         #
-        #   @param company_name [String] The name of the sender.
+        #   @param company_name [String] The name of the sender. This corresponds to the `originator_company_name` field
         #
         #   @param receiver_id_number [String] The ID of the receiver of the transfer.
         #

data/lib/increase/models/simulations/inbound_mail_item_create_params.rb

@@ -22,13 +22,15 @@ module Increase
         optional :contents_file_id, String
 
         # @!attribute lockbox_address_id
-        #   The identifier of the Lockbox Address to simulate inbound mail to.
+        #   The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
+        #   lockbox identifier parameter must be provided.
         #
         #   @return [String, nil]
         optional :lockbox_address_id, String
 
         # @!attribute lockbox_recipient_id
-        #   The identifier of the Lockbox Recipient to simulate inbound mail to.
+        #   The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
+        #   lockbox identifier parameter must be provided.
         #
         #   @return [String, nil]
         optional :lockbox_recipient_id, String
@@ -41,9 +43,9 @@ module Increase
         #
         #   @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
         #
-        #   @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to.
+        #   @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to. Exactly one l
         #
-        #   @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to.
+        #   @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
         #
         #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/increase/models/simulations/physical_card_create_params.rb

@@ -76,10 +76,13 @@ module Increase
           # The physical card has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single physical card 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 physical card 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 physical card will be rerouted to the return address.
           DELIVERY_ISSUE = :delivery_issue
 
-          # Delivery failed and the physical card was returned to sender.
+          # The physical card has been rerouted to the return address.
+          RETURNING_TO_SENDER = :returning_to_sender
+
+          # The physical card has been delivered to the return address.
           RETURNED_TO_SENDER = :returned_to_sender
 
           # @!method self.values

data/lib/increase/models/swift_transfer.rb

@@ -439,15 +439,15 @@ module Increase
         # The transfer has been canceled.
         CANCELED = :canceled
 
+        # The transfer is pending initiation.
+        PENDING_INITIATING = :pending_initiating
+
         # 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 pending initiation.
-        PENDING_INITIATING = :pending_initiating
-
         # The transfer has been initiated.
         INITIATED = :initiated
 

data/lib/increase/models/swift_transfer_list_params.rb

@@ -132,15 +132,15 @@ module Increase
           # The transfer has been canceled.
           CANCELED = :canceled
 
+          # The transfer is pending initiation.
+          PENDING_INITIATING = :pending_initiating
+
           # 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 pending initiation.
-          PENDING_INITIATING = :pending_initiating
-
           # The transfer has been initiated.
           INITIATED = :initiated
 

data/lib/increase/models/transaction.rb

@@ -202,7 +202,8 @@ module Increase
         #   Return is created when an ACH Transfer is returned by the receiving bank. It
         #   offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
         #   the first two business days after the transfer is initiated, but can occur much
-        #   later.
+        #   later. The return appears as a new posted Transaction; no Pending Transaction is
+        #   created.
         #
         #   @return [Increase::Models::Transaction::Source::ACHTransferReturn, nil]
         optional :ach_transfer_return, -> { Increase::Transaction::Source::ACHTransferReturn }, nil?: true
@@ -977,7 +978,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
@@ -991,7 +993,8 @@ module Increase
           #   Return is created when an ACH Transfer is returned by the receiving bank. It
           #   offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
           #   the first two business days after the transfer is initiated, but can occur much
-          #   later.
+          #   later. The return appears as a new posted Transaction; no Pending Transaction is
+          #   created.
           #
           #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
           #
@@ -1003,7 +1006,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.

data/lib/increase/models/wire_transfer.rb

@@ -777,6 +777,9 @@ module Increase
         # The transfer has been canceled.
         CANCELED = :canceled
 
+        # The transfer is pending creation.
+        PENDING_CREATING = :pending_creating
+
         # The transfer is pending review by Increase.
         PENDING_REVIEWING = :pending_reviewing
 
@@ -786,9 +789,6 @@ module Increase
         # The transfer requires attention from an Increase operator.
         REQUIRES_ATTENTION = :requires_attention
 
-        # The transfer is pending creation.
-        PENDING_CREATING = :pending_creating
-
         # The transfer has been reversed.
         REVERSED = :reversed
 

data/lib/increase/models/wire_transfer_list_params.rb

@@ -138,6 +138,9 @@ module Increase
           # The transfer has been canceled.
           CANCELED = :canceled
 
+          # The transfer is pending creation.
+          PENDING_CREATING = :pending_creating
+
           # The transfer is pending review by Increase.
           PENDING_REVIEWING = :pending_reviewing
 
@@ -147,9 +150,6 @@ module Increase
           # The transfer requires attention from an Increase operator.
           REQUIRES_ATTENTION = :requires_attention
 
-          # The transfer is pending creation.
-          PENDING_CREATING = :pending_creating
-
           # The transfer has been reversed.
           REVERSED = :reversed
 

data/lib/increase/resources/accounts.rb

@@ -20,7 +20,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}, nil]
       #

data/lib/increase/resources/ach_transfers.rb

@@ -16,25 +16,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
       #
@@ -42,7 +42,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
       #

data/lib/increase/resources/beneficial_owners.rb

@@ -10,7 +10,7 @@ module Increase
       #
       # @overload create(entity_id:, individual:, prongs:, company_title: nil, request_options: {})
       #
-      # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner.
+      # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner. Only `c
       #
       # @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual] Personal details for the beneficial owner.
       #

data/lib/increase/resources/inbound_mail_items.rb

@@ -58,7 +58,9 @@ module Increase
         )
       end
 
-      # Action an Inbound Mail Item
+      # Deposits or ignores each check contained in a pending Inbound Mail Item.
+      # Depositing a check creates a [Check Deposit](#check-deposits) into the Account
+      # you specify.
       #
       # @overload action(inbound_mail_item_id, checks:, request_options: {})
       #

data/lib/increase/resources/lockbox_addresses.rb

@@ -3,7 +3,10 @@
 module Increase
   module Resources
     class LockboxAddresses
-      # Create a Lockbox Address
+      # The Lockbox Address starts with a `pending` status and a null `address`. Shortly
+      # after creation, Increase generates the mailing address and the status becomes
+      # `active`. You can only create Lockbox Recipients for an `active` Lockbox
+      # Address.
       #
       # @overload create(description: nil, request_options: {})
       #

data/lib/increase/resources/lockbox_recipients.rb

@@ -12,7 +12,7 @@ module Increase
       #
       # @param account_id [String] The Account that checks sent to this Lockbox Recipient should be deposited into.
       #
-      # @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail.
+      # @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox A
       #
       # @param description [String] The description you choose for the Lockbox Recipient.
       #

data/lib/increase/resources/simulations/card_authorizations.rb

@@ -13,7 +13,10 @@ module Increase
         # `card_authorization` or a [Declined Transaction](#declined-transactions) of type
         # `card_decline`. You can pass either a Card id or a
         # [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
-        # ways purchases can be made.
+        # ways purchases can be made. The response will contain either a
+        # `pending_transaction` or a `declined_transaction`; the other attribute will be
+        # null. If the authorization is declined, the reason is available on the Declined
+        # Transaction at `source.card_decline.reason`.
         #
         # @overload create(amount:, authenticated_card_payment_id: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, processing_category: nil, terminal_id: nil, request_options: {})
         #

data/lib/increase/resources/simulations/inbound_ach_transfers.rb

@@ -35,7 +35,7 @@ module Increase
         #
         # @param company_id [String] The sender's company ID.
         #
-        # @param company_name [String] The name of the sender.
+        # @param company_name [String] The name of the sender. This corresponds to the `originator_company_name` field
         #
         # @param receiver_id_number [String] The ID of the receiver of the transfer.
         #