increase 1.340.0 → 1.341.0

data/lib/increase/models/card_validation.rb

@@ -146,15 +146,14 @@ module Increase
       required :type, enum: -> { Increase::CardValidation::Type }
 
       # @!method initialize(id:, acceptance:, account_id:, card_token_id:, cardholder_first_name:, cardholder_last_name:, cardholder_middle_name:, cardholder_postal_code:, cardholder_street_address:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, route:, status:, submission:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::CardValidation} for more details.
-      #
       #   Card Validations are used to validate a card and its cardholder before sending
       #   funds to or pulling funds from a card.
       #
       #   @param id [String] The Card Validation's identifier.
       #
-      #   @param acceptance [Increase::Models::CardValidation::Acceptance, nil] If the validation is accepted by the recipient bank, this will contain supplemen
+      #   @param acceptance [Increase::Models::CardValidation::Acceptance, nil]
+      #     If the validation is accepted by the recipient bank, this will contain
+      #     supplemental details.
       #
       #   @param account_id [String] The identifier of the Account from which to send the validation.
       #
@@ -170,31 +169,49 @@ module Increase
       #
       #   @param cardholder_street_address [String, nil] The cardholder's street address.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the validation was created.
       #
-      #   @param created_by [Increase::Models::CardValidation::CreatedBy, nil] What object created the validation, either via the API or the dashboard.
+      #   @param created_by [Increase::Models::CardValidation::CreatedBy, nil]
+      #     What object created the validation, either via the API or the dashboard.
       #
-      #   @param decline [Increase::Models::CardValidation::Decline, nil] If the validation is rejected by the card network or the destination financial i
+      #   @param decline [Increase::Models::CardValidation::Decline, nil]
+      #     If the validation is rejected by the card network or the destination financial
+      #     institution, this will contain supplemental details.
       #
-      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #   @param idempotency_key [String, nil]
+      #     The idempotency key you chose for this object. This value is unique across
+      #     Increase and is used to ensure that a request is only processed once. Learn more
+      #     about [idempotency](https://increase.com/documentation/idempotency-keys).
       #
-      #   @param merchant_category_code [String] A four-digit code (MCC) identifying the type of business or service provided by
+      #   @param merchant_category_code [String]
+      #     A four-digit code (MCC) identifying the type of business or service provided by
+      #     the merchant.
       #
       #   @param merchant_city_name [String] The city where the merchant (typically your business) is located.
       #
-      #   @param merchant_name [String] The merchant name that will appear in the cardholder’s statement descriptor. Typ
+      #   @param merchant_name [String]
+      #     The merchant name that will appear in the cardholder’s statement descriptor.
+      #     Typically your business name.
       #
-      #   @param merchant_postal_code [String] The postal code for the merchant’s (typically your business’s) location.
+      #   @param merchant_postal_code [String]
+      #     The postal code for the merchant’s (typically your business’s) location.
       #
       #   @param merchant_state [String] The U.S. state where the merchant (typically your business) is located.
       #
-      #   @param route [Symbol, Increase::Models::CardValidation::Route] The card network route used for the validation.
+      #   @param route [Symbol, Increase::Models::CardValidation::Route]
+      #     The card network route used for the validation.
       #
       #   @param status [Symbol, Increase::Models::CardValidation::Status] The lifecycle status of the validation.
       #
-      #   @param submission [Increase::Models::CardValidation::Submission, nil] After the validation is submitted to the card network, this will contain supplem
+      #   @param submission [Increase::Models::CardValidation::Submission, nil]
+      #     After the validation is submitted to the card network, this will contain
+      #     supplemental details.
       #
-      #   @param type [Symbol, Increase::Models::CardValidation::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::CardValidation::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `card_validation`.
 
       # @see Increase::Models::CardValidation#acceptance
       class Acceptance < Increase::Internal::Type::BaseModel
@@ -274,31 +291,39 @@ module Increase
         required :network_transaction_identifier, String, nil?: true
 
         # @!method initialize(accepted_at:, authorization_identification_response:, card_verification_value2_result:, cardholder_first_name_result:, cardholder_full_name_result:, cardholder_last_name_result:, cardholder_middle_name_result:, cardholder_postal_code_result:, cardholder_street_address_result:, network_transaction_identifier:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CardValidation::Acceptance} for more details.
-        #
         #   If the validation is accepted by the recipient bank, this will contain
         #   supplemental details.
         #
-        #   @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+        #   @param accepted_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #     the validation was accepted by the issuing bank.
         #
-        #   @param authorization_identification_response [String] The authorization identification response from the issuing bank.
+        #   @param authorization_identification_response [String]
+        #     The authorization identification response from the issuing bank.
         #
-        #   @param card_verification_value2_result [Symbol, Increase::Models::CardValidation::Acceptance::CardVerificationValue2Result, nil] The result of the Card Verification Value 2 match.
+        #   @param card_verification_value2_result [Symbol, Increase::Models::CardValidation::Acceptance::CardVerificationValue2Result, nil]
+        #     The result of the Card Verification Value 2 match.
         #
-        #   @param cardholder_first_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderFirstNameResult, nil] The result of the cardholder first name match.
+        #   @param cardholder_first_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderFirstNameResult, nil]
+        #     The result of the cardholder first name match.
         #
-        #   @param cardholder_full_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderFullNameResult, nil] The result of the cardholder full name match.
+        #   @param cardholder_full_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderFullNameResult, nil]
+        #     The result of the cardholder full name match.
         #
-        #   @param cardholder_last_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderLastNameResult, nil] The result of the cardholder last name match.
+        #   @param cardholder_last_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderLastNameResult, nil]
+        #     The result of the cardholder last name match.
         #
-        #   @param cardholder_middle_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderMiddleNameResult, nil] The result of the cardholder middle name match.
+        #   @param cardholder_middle_name_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderMiddleNameResult, nil]
+        #     The result of the cardholder middle name match.
         #
-        #   @param cardholder_postal_code_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderPostalCodeResult, nil] The result of the cardholder postal code match.
+        #   @param cardholder_postal_code_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderPostalCodeResult, nil]
+        #     The result of the cardholder postal code match.
         #
-        #   @param cardholder_street_address_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderStreetAddressResult, nil] The result of the cardholder street address match.
+        #   @param cardholder_street_address_result [Symbol, Increase::Models::CardValidation::Acceptance::CardholderStreetAddressResult, nil]
+        #     The result of the cardholder street address match.
         #
-        #   @param network_transaction_identifier [String, nil] A unique identifier for the transaction on the card network.
+        #   @param network_transaction_identifier [String, nil]
+        #     A unique identifier for the transaction on the card network.
 
         # The result of the Card Verification Value 2 match.
         #
@@ -454,13 +479,17 @@ module Increase
         # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
         #   What object created the validation, either via the API or the dashboard.
         #
-        #   @param category [Symbol, Increase::Models::CardValidation::CreatedBy::Category] The type of object that created this transfer.
+        #   @param category [Symbol, Increase::Models::CardValidation::CreatedBy::Category]
+        #     The type of object that created this transfer.
         #
-        #   @param api_key [Increase::Models::CardValidation::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
+        #   @param api_key [Increase::Models::CardValidation::CreatedBy::APIKey, nil]
+        #     If present, details about the API key that created the transfer.
         #
-        #   @param oauth_application [Increase::Models::CardValidation::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
+        #   @param oauth_application [Increase::Models::CardValidation::CreatedBy::OAuthApplication, nil]
+        #     If present, details about the OAuth Application that created the transfer.
         #
-        #   @param user [Increase::Models::CardValidation::CreatedBy::User, nil] If present, details about the User that created the transfer.
+        #   @param user [Increase::Models::CardValidation::CreatedBy::User, nil]
+        #     If present, details about the User that created the transfer.
 
         # The type of object that created this transfer.
         #
@@ -546,17 +575,18 @@ module Increase
         required :reason, enum: -> { Increase::CardValidation::Decline::Reason }
 
         # @!method initialize(declined_at:, network_transaction_identifier:, reason:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CardValidation::Decline} for more details.
-        #
         #   If the validation is rejected by the card network or the destination financial
         #   institution, this will contain supplemental details.
         #
-        #   @param declined_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+        #   @param declined_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #     the validation was declined.
         #
-        #   @param network_transaction_identifier [String, nil] A unique identifier for the transaction on the card network.
+        #   @param network_transaction_identifier [String, nil]
+        #     A unique identifier for the transaction on the card network.
         #
-        #   @param reason [Symbol, Increase::Models::CardValidation::Decline::Reason] The reason why the validation was declined.
+        #   @param reason [Symbol, Increase::Models::CardValidation::Decline::Reason]
+        #     The reason why the validation was declined.
 
         # The reason why the validation was declined.
         #
@@ -827,17 +857,20 @@ module Increase
         required :trace_number, String
 
         # @!method initialize(retrieval_reference_number:, submitted_at:, trace_number:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CardValidation::Submission} for more details.
-        #
         #   After the validation is submitted to the card network, this will contain
         #   supplemental details.
         #
-        #   @param retrieval_reference_number [String] A 12-digit retrieval reference number that identifies the validation. Usually a
+        #   @param retrieval_reference_number [String]
+        #     A 12-digit retrieval reference number that identifies the validation. Usually a
+        #     combination of a timestamp and the trace number.
         #
-        #   @param submitted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+        #   @param submitted_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #     the validation was submitted to the card network.
         #
-        #   @param trace_number [String] A 6-digit trace number that identifies the validation within a short time window
+        #   @param trace_number [String]
+        #     A 6-digit trace number that identifies the validation within a short time
+        #     window.
       end
 
       # A constant representing the object's type. For this resource it will always be

data/lib/increase/models/card_validation_create_params.rb

@@ -83,20 +83,24 @@ module Increase
       optional :cardholder_street_address, String
 
       # @!method initialize(account_id:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, cardholder_first_name: nil, cardholder_last_name: nil, cardholder_middle_name: nil, cardholder_postal_code: nil, cardholder_street_address: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::CardValidationCreateParams} for more details.
-      #
       #   @param account_id [String] The identifier of the Account from which to send the validation.
       #
-      #   @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
+      #   @param card_token_id [String]
+      #     The Increase identifier for the Card Token that represents the card number
+      #     you're validating.
       #
-      #   @param merchant_category_code [String] A four-digit code (MCC) identifying the type of business or service provided by
+      #   @param merchant_category_code [String]
+      #     A four-digit code (MCC) identifying the type of business or service provided by
+      #     the merchant.
       #
       #   @param merchant_city_name [String] The city where the merchant (typically your business) is located.
       #
-      #   @param merchant_name [String] The merchant name that will appear in the cardholder’s statement descriptor. Typ
+      #   @param merchant_name [String]
+      #     The merchant name that will appear in the cardholder’s statement descriptor.
+      #     Typically your business name.
       #
-      #   @param merchant_postal_code [String] The postal code for the merchant’s (typically your business’s) location.
+      #   @param merchant_postal_code [String]
+      #     The postal code for the merchant’s (typically your business’s) location.
       #
       #   @param merchant_state [String] The U.S. state where the merchant (typically your business) is located.
       #

data/lib/increase/models/card_validation_list_params.rb

@@ -46,18 +46,21 @@ module Increase
       optional :status, -> { Increase::CardValidationListParams::Status }
 
       # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::CardValidationListParams} for more details.
-      #
       #   @param account_id [String] Filter Card Validations to ones belonging to the specified Account.
       #
       #   @param created_at [Increase::Models::CardValidationListParams::CreatedAt]
       #
       #   @param cursor [String] Return the page of entries after this one.
       #
-      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #   @param idempotency_key [String]
+      #     Filter records to the one with the specified `idempotency_key` you chose for
+      #     that object. This value is unique across Increase and is used to ensure that a
+      #     request is only processed once. Learn more about
+      #     [idempotency](https://increase.com/documentation/idempotency-keys).
       #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #   @param limit [Integer]
+      #     Limit the size of the list that is returned. The default (and maximum) is 100
+      #     objects.
       #
       #   @param status [Increase::Models::CardValidationListParams::Status]
       #
@@ -93,16 +96,21 @@ module Increase
         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::CardValidationListParams::CreatedAt} for more details.
-        #
-        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #   @param after [Time]
+        #     Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #   @param before [Time]
+        #     Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #   @param on_or_after [Time]
+        #     Return results on or after this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
         #
-        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+        #   @param on_or_before [Time]
+        #     Return results on or before this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
       end
 
       class Status < Increase::Internal::Type::BaseModel
@@ -118,10 +126,9 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CardValidationListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::CardValidationListParams::Status::In>] Filter Card Validations by status. For GET requests, this should be encoded as a
+        #   @param in_ [Array<Symbol, Increase::Models::CardValidationListParams::Status::In>]
+        #     Filter Card Validations by status. For GET requests, this should be encoded as a
+        #     comma-delimited string, such as `?in=one,two,three`.
 
         module In
           extend Increase::Internal::Type::Enum

data/lib/increase/models/check_deposit.rb

@@ -133,9 +133,6 @@ module Increase
       required :type, enum: -> { Increase::CheckDeposit::Type }
 
       # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_adjustments:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_recipient_id:, status:, transaction_id:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::CheckDeposit} for more details.
-      #
       #   Check Deposits allow you to deposit images of paper checks into your account.
       #
       #   @param id [String] The deposit's identifier.
@@ -146,35 +143,59 @@ module Increase
       #
       #   @param back_image_file_id [String, nil] The ID for the File containing the image of the back of the check.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the transfer was created.
       #
-      #   @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil] Once your deposit is successfully parsed and accepted by Increase, this will con
+      #   @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil]
+      #     Once your deposit is successfully parsed and accepted by Increase, this will
+      #     contain details of the parsed check.
       #
-      #   @param deposit_adjustments [Array<Increase::Models::CheckDeposit::DepositAdjustment>] If the deposit or the return was adjusted by the receiving institution, this wil
+      #   @param deposit_adjustments [Array<Increase::Models::CheckDeposit::DepositAdjustment>]
+      #     If the deposit or the return was adjusted by the receiving institution, this
+      #     will contain details of the adjustments.
       #
-      #   @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil] If your deposit is rejected by Increase, this will contain details as to why it
+      #   @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil]
+      #     If your deposit is rejected by Increase, this will contain details as to why it
+      #     was rejected.
       #
-      #   @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil] If your deposit is returned, this will contain details as to why it was returned
+      #   @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil]
+      #     If your deposit is returned, this will contain details as to why it was
+      #     returned.
       #
-      #   @param deposit_submission [Increase::Models::CheckDeposit::DepositSubmission, nil] After the check is parsed, it is submitted to the Check21 network for processing
+      #   @param deposit_submission [Increase::Models::CheckDeposit::DepositSubmission, nil]
+      #     After the check is parsed, it is submitted to the Check21 network for
+      #     processing. This will contain details of the submission.
       #
       #   @param description [String, nil] The description of the Check Deposit, for display purposes only.
       #
       #   @param front_image_file_id [String] The ID for the File containing the image of the front of the check.
       #
-      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #   @param idempotency_key [String, nil]
+      #     The idempotency key you chose for this object. This value is unique across
+      #     Increase and is used to ensure that a request is only processed once. Learn more
+      #     about [idempotency](https://increase.com/documentation/idempotency-keys).
       #
-      #   @param inbound_funds_hold [Increase::Models::CheckDeposit::InboundFundsHold, nil] Increase will sometimes hold the funds for Check Deposits. If funds are held, th
+      #   @param inbound_funds_hold [Increase::Models::CheckDeposit::InboundFundsHold, nil]
+      #     Increase will sometimes hold the funds for Check Deposits. If funds are held,
+      #     this sub-object will contain details of the hold.
       #
-      #   @param inbound_mail_item_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item, this will contain t
+      #   @param inbound_mail_item_id [String, nil]
+      #     If the Check Deposit was the result of an Inbound Mail Item, this will contain
+      #     the identifier of the Inbound Mail Item.
       #
-      #   @param lockbox_recipient_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox
+      #   @param lockbox_recipient_id [String, nil]
+      #     If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox
+      #     Recipient, this will contain the identifier of the Lockbox Recipient that
+      #     received it.
       #
       #   @param status [Symbol, Increase::Models::CheckDeposit::Status] The status of the Check Deposit.
       #
       #   @param transaction_id [String, nil] The ID for the Transaction created by the deposit.
       #
-      #   @param type [Symbol, Increase::Models::CheckDeposit::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::CheckDeposit::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `check_deposit`.
 
       # @see Increase::Models::CheckDeposit#deposit_acceptance
       class DepositAcceptance < Increase::Internal::Type::BaseModel
@@ -227,25 +248,34 @@ module Increase
         required :serial_number, String, nil?: true
 
         # @!method initialize(account_number:, amount:, auxiliary_on_us:, check_deposit_id:, currency:, routing_number:, serial_number:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CheckDeposit::DepositAcceptance} for more details.
-        #
         #   Once your deposit is successfully parsed and accepted by Increase, this will
         #   contain details of the parsed check.
         #
-        #   @param account_number [String] The account number printed on the check. This is an account at the bank that iss
+        #   @param account_number [String]
+        #     The account number printed on the check. This is an account at the bank that
+        #     issued the check.
         #
-        #   @param amount [Integer] The amount to be deposited in the minor unit of the transaction's currency. For
+        #   @param amount [Integer]
+        #     The amount to be deposited in the minor unit of the transaction's currency. For
+        #     dollars, for example, this is cents.
         #
-        #   @param auxiliary_on_us [String, nil] An additional line of metadata printed on the check. This typically includes the
+        #   @param auxiliary_on_us [String, nil]
+        #     An additional line of metadata printed on the check. This typically includes the
+        #     check number for business checks.
         #
         #   @param check_deposit_id [String] The ID of the Check Deposit that was accepted.
         #
-        #   @param currency [Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
+        #   @param currency [Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency]
+        #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+        #     transaction's currency.
         #
-        #   @param routing_number [String] The routing number printed on the check. This is a routing number for the bank t
+        #   @param routing_number [String]
+        #     The routing number printed on the check. This is a routing number for the bank
+        #     that issued the check.
         #
-        #   @param serial_number [String, nil] The check serial number, if present, for consumer checks. For business checks, t
+        #   @param serial_number [String, nil]
+        #     The check serial number, if present, for consumer checks. For business checks,
+        #     the serial number is usually in the `auxiliary_on_us` field.
 
         # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
         # transaction's currency.
@@ -292,7 +322,8 @@ module Increase
         #
         #   @param amount [Integer] The amount of the adjustment.
         #
-        #   @param reason [Symbol, Increase::Models::CheckDeposit::DepositAdjustment::Reason] The reason for the adjustment.
+        #   @param reason [Symbol, Increase::Models::CheckDeposit::DepositAdjustment::Reason]
+        #     The reason for the adjustment.
         #
         #   @param transaction_id [String] The id of the transaction for the adjustment.
 
@@ -358,23 +389,27 @@ module Increase
         required :rejected_at, Time
 
         # @!method initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CheckDeposit::DepositRejection} for more details.
-        #
         #   If your deposit is rejected by Increase, this will contain details as to why it
         #   was rejected.
         #
-        #   @param amount [Integer] The rejected amount in the minor unit of check's currency. For dollars, for exam
+        #   @param amount [Integer]
+        #     The rejected amount in the minor unit of check's currency. For dollars, for
+        #     example, this is cents.
         #
         #   @param check_deposit_id [String] The identifier of the Check Deposit that was rejected.
         #
-        #   @param currency [Symbol, Increase::Models::CheckDeposit::DepositRejection::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr
+        #   @param currency [Symbol, Increase::Models::CheckDeposit::DepositRejection::Currency]
+        #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
+        #     currency.
         #
         #   @param declined_transaction_id [String] The identifier of the associated declined transaction.
         #
-        #   @param reason [Symbol, Increase::Models::CheckDeposit::DepositRejection::Reason] Why the check deposit was rejected.
+        #   @param reason [Symbol, Increase::Models::CheckDeposit::DepositRejection::Reason]
+        #     Why the check deposit was rejected.
         #
-        #   @param rejected_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+        #   @param rejected_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #     the check deposit was rejected.
 
         # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
         # currency.
@@ -480,9 +515,6 @@ module Increase
         required :transaction_id, String
 
         # @!method initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CheckDeposit::DepositReturn} for more details.
-        #
         #   If your deposit is returned, this will contain details as to why it was
         #   returned.
         #
@@ -490,13 +522,21 @@ module Increase
         #
         #   @param check_deposit_id [String] The identifier of the Check Deposit that was returned.
         #
-        #   @param currency [Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
+        #   @param currency [Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency]
+        #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+        #     transaction's currency.
         #
-        #   @param return_reason [Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason] Why this check was returned by the bank holding the account it was drawn against
+        #   @param return_reason [Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason]
+        #     Why this check was returned by the bank holding the account it was drawn
+        #     against.
         #
-        #   @param returned_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+        #   @param returned_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #     the check deposit was returned.
         #
-        #   @param transaction_id [String] The identifier of the transaction that reversed the original check deposit trans
+        #   @param transaction_id [String]
+        #     The identifier of the transaction that reversed the original check deposit
+        #     transaction.
 
         # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
         # transaction's currency.
@@ -627,17 +667,21 @@ module Increase
         required :submitted_at, Time
 
         # @!method initialize(back_file_id:, front_file_id:, submitted_at:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CheckDeposit::DepositSubmission} for more details.
-        #
         #   After the check is parsed, it is submitted to the Check21 network for
         #   processing. This will contain details of the submission.
         #
-        #   @param back_file_id [String] The ID for the File containing the check back image that was submitted to the Ch
+        #   @param back_file_id [String]
+        #     The ID for the File containing the check back image that was submitted to the
+        #     Check21 network.
         #
-        #   @param front_file_id [String] The ID for the File containing the check front image that was submitted to the C
+        #   @param front_file_id [String]
+        #     The ID for the File containing the check front image that was submitted to the
+        #     Check21 network.
         #
-        #   @param submitted_at [Time] When the check deposit was submitted to the Check21 network for processing. Duri
+        #   @param submitted_at [Time]
+        #     When the check deposit was submitted to the Check21 network for processing.
+        #     During business days, this happens within a few hours of the check being
+        #     accepted by Increase.
       end
 
       # @see Increase::Models::CheckDeposit#inbound_funds_hold
@@ -702,19 +746,24 @@ module Increase
         required :type, enum: -> { Increase::CheckDeposit::InboundFundsHold::Type }
 
         # @!method initialize(amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::CheckDeposit::InboundFundsHold} for more details.
-        #
         #   Increase will sometimes hold the funds for Check Deposits. If funds are held,
         #   this sub-object will contain details of the hold.
         #
-        #   @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex
+        #   @param amount [Integer]
+        #     The held amount in the minor unit of the account's currency. For dollars, for
+        #     example, this is cents.
         #
-        #   @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to
+        #   @param automatically_releases_at [Time]
+        #     When the hold will be released automatically. Certain conditions may cause it to
+        #     be released before this time.
         #
-        #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa
+        #   @param created_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
+        #     was created.
         #
-        #   @param currency [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre
+        #   @param currency [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency]
+        #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
+        #     currency.
         #
         #   @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held.
         #
@@ -724,7 +773,9 @@ module Increase
         #
         #   @param status [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status] The status of the hold.
         #
-        #   @param type [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type] A constant representing the object's type. For this resource it will always be `
+        #   @param type [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type]
+        #     A constant representing the object's type. For this resource it will always be
+        #     `inbound_funds_hold`.
 
         # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
         # currency.

data/lib/increase/models/check_deposit_create_params.rb

@@ -38,9 +38,6 @@ module Increase
       optional :description, String
 
       # @!method initialize(account_id:, amount:, back_image_file_id:, front_image_file_id:, description: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::CheckDepositCreateParams} for more details.
-      #
       #   @param account_id [String] The identifier for the Account to deposit the check in.
       #
       #   @param amount [Integer] The deposit amount in USD cents.
@@ -49,7 +46,8 @@ module Increase
       #
       #   @param front_image_file_id [String] The File containing the check's front image.
       #
-      #   @param description [String] The description you choose to give the Check Deposit, for display purposes only.
+      #   @param description [String]
+      #     The description you choose to give the Check Deposit, for display purposes only.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
     end