increase 1.340.0 → 1.341.0

data/lib/increase/models/inbound_ach_transfer.rb

@@ -177,41 +177,50 @@ module Increase
       required :type, enum: -> { Increase::InboundACHTransfer::Type }
 
       # @!method initialize(id:, acceptance:, account_id:, account_number_id:, addenda:, amount:, automatically_resolves_at:, created_at:, decline:, direction:, effective_date:, international_addenda:, notification_of_change:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, originator_routing_number:, receiver_id_number:, receiver_name:, settlement:, standard_entry_class_code:, status:, trace_number:, transfer_return:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::InboundACHTransfer} for more details.
-      #
       #   An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your
       #   account.
       #
       #   @param id [String] The inbound ACH transfer's identifier.
       #
-      #   @param acceptance [Increase::Models::InboundACHTransfer::Acceptance, nil] If your transfer is accepted, this will contain details of the acceptance.
+      #   @param acceptance [Increase::Models::InboundACHTransfer::Acceptance, nil]
+      #     If your transfer is accepted, this will contain details of the acceptance.
       #
       #   @param account_id [String] The Account to which the transfer belongs.
       #
       #   @param account_number_id [String] The identifier of the Account Number to which this transfer was sent.
       #
-      #   @param addenda [Increase::Models::InboundACHTransfer::Addenda, nil] Additional information sent from the originator.
+      #   @param addenda [Increase::Models::InboundACHTransfer::Addenda, nil]
+      #     Additional information sent from the originator.
       #
       #   @param amount [Integer] The transfer amount in USD cents.
       #
       #   @param automatically_resolves_at [Time] The time at which the transfer will be automatically resolved.
       #
-      #   @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 inbound ACH transfer was created.
       #
-      #   @param decline [Increase::Models::InboundACHTransfer::Decline, nil] If your transfer is declined, this will contain details of the decline.
+      #   @param decline [Increase::Models::InboundACHTransfer::Decline, nil]
+      #     If your transfer is declined, this will contain details of the decline.
       #
       #   @param direction [Symbol, Increase::Models::InboundACHTransfer::Direction] The direction of the transfer.
       #
-      #   @param effective_date [Date] The effective date of the transfer. This is sent by the sending bank and is a fa
+      #   @param effective_date [Date]
+      #     The effective date of the transfer. This is sent by the sending bank and is a
+      #     factor in determining funds availability.
       #
-      #   @param international_addenda [Increase::Models::InboundACHTransfer::InternationalAddenda, nil] If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will co
+      #   @param international_addenda [Increase::Models::InboundACHTransfer::InternationalAddenda, nil]
+      #     If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will
+      #     contain fields pertaining to the International ACH Transaction.
       #
-      #   @param notification_of_change [Increase::Models::InboundACHTransfer::NotificationOfChange, nil] If you initiate a notification of change in response to the transfer, this will
+      #   @param notification_of_change [Increase::Models::InboundACHTransfer::NotificationOfChange, nil]
+      #     If you initiate a notification of change in response to the transfer, this will
+      #     contain its details.
       #
       #   @param originator_company_descriptive_date [String, nil] The descriptive date of the transfer.
       #
-      #   @param originator_company_discretionary_data [String, nil] The additional information included with the transfer.
+      #   @param originator_company_discretionary_data [String, nil]
+      #     The additional information included with the transfer.
       #
       #   @param originator_company_entry_description [String] The description of the transfer.
       #
@@ -219,23 +228,35 @@ module Increase
       #
       #   @param originator_company_name [String] The name of the company that initiated the transfer.
       #
-      #   @param originator_routing_number [String] The American Banking Association (ABA) routing number of the bank originating th
+      #   @param originator_routing_number [String]
+      #     The American Banking Association (ABA) routing number of the bank originating
+      #     the transfer.
       #
       #   @param receiver_id_number [String, nil] The id of the receiver of the transfer.
       #
       #   @param receiver_name [String, nil] The name of the receiver of the transfer.
       #
-      #   @param settlement [Increase::Models::InboundACHTransfer::Settlement] A subhash containing information about when and how the transfer settled at the
+      #   @param settlement [Increase::Models::InboundACHTransfer::Settlement]
+      #     A subhash containing information about when and how the transfer settled at the
+      #     Federal Reserve.
       #
-      #   @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode] The Standard Entry Class (SEC) code of the transfer.
+      #   @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode]
+      #     The Standard Entry Class (SEC) code of the transfer.
       #
       #   @param status [Symbol, Increase::Models::InboundACHTransfer::Status] The status of the transfer.
       #
-      #   @param trace_number [String] A 15 digit number set by the sending bank and transmitted to the receiving bank.
+      #   @param trace_number [String]
+      #     A 15 digit number set by the sending bank and transmitted to the receiving bank.
+      #     Along with the amount, date, and originating routing number, this can be used to
+      #     identify the ACH transfer. ACH trace numbers are not unique, but are
+      #     [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
       #
-      #   @param transfer_return [Increase::Models::InboundACHTransfer::TransferReturn, nil] If your transfer is returned, this will contain details of the return.
+      #   @param transfer_return [Increase::Models::InboundACHTransfer::TransferReturn, nil]
+      #     If your transfer is returned, this will contain details of the return.
       #
-      #   @param type [Symbol, Increase::Models::InboundACHTransfer::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::InboundACHTransfer::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `inbound_ach_transfer`.
 
       # @see Increase::Models::InboundACHTransfer#acceptance
       class Acceptance < Increase::Internal::Type::BaseModel
@@ -278,7 +299,8 @@ module Increase
         #
         #   @param category [Symbol, Increase::Models::InboundACHTransfer::Addenda::Category] The type of addendum.
         #
-        #   @param freeform [Increase::Models::InboundACHTransfer::Addenda::Freeform, nil] Unstructured `payment_related_information` passed through by the originator.
+        #   @param freeform [Increase::Models::InboundACHTransfer::Addenda::Freeform, nil]
+        #     Unstructured `payment_related_information` passed through by the originator.
 
         # The type of addendum.
         #
@@ -305,7 +327,8 @@ module Increase
           # @!method initialize(entries:)
           #   Unstructured `payment_related_information` passed through by the originator.
           #
-          #   @param entries [Array<Increase::Models::InboundACHTransfer::Addenda::Freeform::Entry>] Each entry represents an addendum received from the originator.
+          #   @param entries [Array<Increase::Models::InboundACHTransfer::Addenda::Freeform::Entry>]
+          #     Each entry represents an addendum received from the originator.
 
           class Entry < Increase::Internal::Type::BaseModel
             # @!attribute payment_related_information
@@ -347,7 +370,8 @@ module Increase
         #
         #   @param declined_transaction_id [String] The id of the transaction for the declined transfer.
         #
-        #   @param reason [Symbol, Increase::Models::InboundACHTransfer::Decline::Reason] The reason for the transfer decline.
+        #   @param reason [Symbol, Increase::Models::InboundACHTransfer::Decline::Reason]
+        #     The reason for the transfer decline.
 
         # The reason for the transfer decline.
         #
@@ -655,49 +679,75 @@ module Increase
         required :receiving_depository_financial_institution_name, String
 
         # @!method initialize(destination_country_code:, destination_currency_code:, foreign_exchange_indicator:, foreign_exchange_reference:, foreign_exchange_reference_indicator:, foreign_payment_amount:, foreign_trace_number:, international_transaction_type_code:, originating_currency_code:, originating_depository_financial_institution_branch_country:, originating_depository_financial_institution_id:, originating_depository_financial_institution_id_qualifier:, originating_depository_financial_institution_name:, originator_city:, originator_country:, originator_identification:, originator_name:, originator_postal_code:, originator_state_or_province:, originator_street_address:, payment_related_information:, payment_related_information2:, receiver_city:, receiver_country:, receiver_identification_number:, receiver_postal_code:, receiver_state_or_province:, receiver_street_address:, receiving_company_or_individual_name:, receiving_depository_financial_institution_country:, receiving_depository_financial_institution_id:, receiving_depository_financial_institution_id_qualifier:, receiving_depository_financial_institution_name:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::InboundACHTransfer::InternationalAddenda} for more details.
-        #
         #   If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will
         #   contain fields pertaining to the International ACH Transaction.
         #
-        #   @param destination_country_code [String] The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr
+        #   @param destination_country_code [String]
+        #     The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+        #     country code of the destination country.
         #
-        #   @param destination_currency_code [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the des
+        #   @param destination_currency_code [String]
+        #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
+        #     destination bank account.
         #
-        #   @param foreign_exchange_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator] A description of how the foreign exchange rate was calculated.
+        #   @param foreign_exchange_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator]
+        #     A description of how the foreign exchange rate was calculated.
         #
-        #   @param foreign_exchange_reference [String, nil] Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a r
+        #   @param foreign_exchange_reference [String, nil]
+        #     Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
+        #     reference to a well-known rate.
         #
-        #   @param foreign_exchange_reference_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator] An instruction of how to interpret the `foreign_exchange_reference` field for th
+        #   @param foreign_exchange_reference_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator]
+        #     An instruction of how to interpret the `foreign_exchange_reference` field for
+        #     this Transaction.
         #
-        #   @param foreign_payment_amount [Integer] The amount in the minor unit of the foreign payment currency. For dollars, for e
+        #   @param foreign_payment_amount [Integer]
+        #     The amount in the minor unit of the foreign payment currency. For dollars, for
+        #     example, this is cents.
         #
         #   @param foreign_trace_number [String, nil] A reference number in the foreign banking infrastructure.
         #
-        #   @param international_transaction_type_code [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode] The type of transfer. Set by the originator.
+        #   @param international_transaction_type_code [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode]
+        #     The type of transfer. Set by the originator.
         #
-        #   @param originating_currency_code [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the ori
+        #   @param originating_currency_code [String]
+        #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
+        #     originating bank account.
         #
-        #   @param originating_depository_financial_institution_branch_country [String] The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr
+        #   @param originating_depository_financial_institution_branch_country [String]
+        #     The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+        #     country code of the originating branch country.
         #
-        #   @param originating_depository_financial_institution_id [String] An identifier for the originating bank. One of an International Bank Account Num
+        #   @param originating_depository_financial_institution_id [String]
+        #     An identifier for the originating bank. One of an International Bank Account
+        #     Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+        #     domestic identifier like a US Routing Number.
         #
-        #   @param originating_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier] An instruction of how to interpret the `originating_depository_financial_institu
+        #   @param originating_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier]
+        #     An instruction of how to interpret the
+        #     `originating_depository_financial_institution_id` field for this Transaction.
         #
-        #   @param originating_depository_financial_institution_name [String] The name of the originating bank. Sometimes this will refer to an American bank
+        #   @param originating_depository_financial_institution_name [String]
+        #     The name of the originating bank. Sometimes this will refer to an American bank
+        #     and obscure the correspondent foreign bank.
         #
         #   @param originator_city [String] A portion of the originator address. This may be incomplete.
         #
-        #   @param originator_country [String] A portion of the originator address. The [ISO 3166](https://en.wikipedia.org/wik
+        #   @param originator_country [String]
+        #     A portion of the originator address. The
+        #     [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
+        #     code of the originator country.
         #
-        #   @param originator_identification [String] An identifier for the originating company. This is generally stable across multi
+        #   @param originator_identification [String]
+        #     An identifier for the originating company. This is generally stable across
+        #     multiple ACH transfers.
         #
         #   @param originator_name [String] Either the name of the originator or an intermediary money transmitter.
         #
         #   @param originator_postal_code [String, nil] A portion of the originator address. This may be incomplete.
         #
-        #   @param originator_state_or_province [String, nil] A portion of the originator address. This may be incomplete.
+        #   @param originator_state_or_province [String, nil]
+        #     A portion of the originator address. This may be incomplete.
         #
         #   @param originator_street_address [String] A portion of the originator address. This may be incomplete.
         #
@@ -707,9 +757,13 @@ module Increase
         #
         #   @param receiver_city [String] A portion of the receiver address. This may be incomplete.
         #
-        #   @param receiver_country [String] A portion of the receiver address. The [ISO 3166](https://en.wikipedia.org/wiki/
+        #   @param receiver_country [String]
+        #     A portion of the receiver address. The
+        #     [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
+        #     code of the receiver country.
         #
-        #   @param receiver_identification_number [String, nil] An identification number the originator uses for the receiver.
+        #   @param receiver_identification_number [String, nil]
+        #     An identification number the originator uses for the receiver.
         #
         #   @param receiver_postal_code [String, nil] A portion of the receiver address. This may be incomplete.
         #
@@ -717,15 +771,24 @@ module Increase
         #
         #   @param receiver_street_address [String] A portion of the receiver address. This may be incomplete.
         #
-        #   @param receiving_company_or_individual_name [String] The name of the receiver of the transfer. This is not verified by Increase.
+        #   @param receiving_company_or_individual_name [String]
+        #     The name of the receiver of the transfer. This is not verified by Increase.
         #
-        #   @param receiving_depository_financial_institution_country [String] The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr
+        #   @param receiving_depository_financial_institution_country [String]
+        #     The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+        #     country code of the receiving bank country.
         #
-        #   @param receiving_depository_financial_institution_id [String] An identifier for the receiving bank. One of an International Bank Account Numbe
+        #   @param receiving_depository_financial_institution_id [String]
+        #     An identifier for the receiving bank. One of an International Bank Account
+        #     Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+        #     domestic identifier like a US Routing Number.
         #
-        #   @param receiving_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier] An instruction of how to interpret the `receiving_depository_financial_instituti
+        #   @param receiving_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier]
+        #     An instruction of how to interpret the
+        #     `receiving_depository_financial_institution_id` field for this Transaction.
         #
-        #   @param receiving_depository_financial_institution_name [String] The name of the receiving bank, as set by the sending financial institution.
+        #   @param receiving_depository_financial_institution_name [String]
+        #     The name of the receiving bank, as set by the sending financial institution.
 
         # A description of how the foreign exchange rate was calculated.
         #
@@ -916,15 +979,15 @@ module Increase
         required :settlement_schedule, enum: -> { Increase::InboundACHTransfer::Settlement::SettlementSchedule }
 
         # @!method initialize(settled_at:, settlement_schedule:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::InboundACHTransfer::Settlement} for more details.
-        #
         #   A subhash containing information about when and how the transfer settled at the
         #   Federal Reserve.
         #
-        #   @param settled_at [Time] When the funds for this transfer settle at the recipient bank at the Federal Res
+        #   @param settled_at [Time]
+        #     When the funds for this transfer settle at the recipient bank at the Federal
+        #     Reserve.
         #
-        #   @param settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::Settlement::SettlementSchedule] The settlement schedule this transfer follows.
+        #   @param settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::Settlement::SettlementSchedule]
+        #     The settlement schedule this transfer follows.
 
         # The settlement schedule this transfer follows.
         #
@@ -1046,7 +1109,8 @@ module Increase
         # @!method initialize(reason:, returned_at:, transaction_id:)
         #   If your transfer is returned, this will contain details of the return.
         #
-        #   @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason] The reason for the transfer return.
+        #   @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason]
+        #     The reason for the transfer return.
         #
         #   @param returned_at [Time] The time at which the transfer was returned.
         #

data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb

@@ -27,11 +27,9 @@ module Increase
       optional :updated_routing_number, String
 
       # @!method initialize(inbound_ach_transfer_id:, updated_account_number: nil, updated_routing_number: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::InboundACHTransferCreateNotificationOfChangeParams} for more
-      #   details.
-      #
-      #   @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer for which to create a notification of
+      #   @param inbound_ach_transfer_id [String]
+      #     The identifier of the Inbound ACH Transfer for which to create a notification of
+      #     change.
       #
       #   @param updated_account_number [String] The updated account number to send in the notification of change.
       #

data/lib/increase/models/inbound_ach_transfer_decline_params.rb

@@ -22,12 +22,12 @@ module Increase
       optional :reason, enum: -> { Increase::InboundACHTransferDeclineParams::Reason }
 
       # @!method initialize(inbound_ach_transfer_id:, reason: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::InboundACHTransferDeclineParams} for more details.
-      #
       #   @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to decline.
       #
-      #   @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] The reason why this transfer will be returned. If this parameter is unset, the r
+      #   @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason]
+      #     The reason why this transfer will be returned. If this parameter is unset, the
+      #     return codes will be `payment_stopped` for debits and
+      #     `credit_entry_refused_by_receiver` for credits.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/increase/models/inbound_ach_transfer_list_params.rb

@@ -43,18 +43,18 @@ module Increase
       optional :status, -> { Increase::InboundACHTransferListParams::Status }
 
       # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::InboundACHTransferListParams} for more details.
-      #
       #   @param account_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account.
       #
-      #   @param account_number_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account Number.
+      #   @param account_number_id [String]
+      #     Filter Inbound ACH Transfers to ones belonging to the specified Account Number.
       #
       #   @param created_at [Increase::Models::InboundACHTransferListParams::CreatedAt]
       #
       #   @param cursor [String] Return the page of entries after this one.
       #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #   @param limit [Integer]
+      #     Limit the size of the list that is returned. The default (and maximum) is 100
+      #     objects.
       #
       #   @param status [Increase::Models::InboundACHTransferListParams::Status]
       #
@@ -90,16 +90,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::InboundACHTransferListParams::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
@@ -116,10 +121,10 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::InboundACHTransferListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::InboundACHTransferListParams::Status::In>] Filter Inbound ACH Transfers to those with the specified status. For GET request
+        #   @param in_ [Array<Symbol, Increase::Models::InboundACHTransferListParams::Status::In>]
+        #     Filter Inbound ACH Transfers to those with the specified 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/inbound_ach_transfer_transfer_return_params.rb

@@ -22,12 +22,13 @@ module Increase
       required :reason, enum: -> { Increase::InboundACHTransferTransferReturnParams::Reason }
 
       # @!method initialize(inbound_ach_transfer_id:, reason:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::InboundACHTransferTransferReturnParams} for more details.
+      #   @param inbound_ach_transfer_id [String]
+      #     The identifier of the Inbound ACH Transfer to return to the originating
+      #     financial institution.
       #
-      #   @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to return to the originating financia
-      #
-      #   @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] The reason why this transfer will be returned. The most usual return codes are `
+      #   @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason]
+      #     The reason why this transfer will be returned. The most usual return codes are
+      #     `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/increase/models/inbound_check_deposit.rb

@@ -139,51 +139,76 @@ module Increase
       required :type, enum: -> { Increase::InboundCheckDeposit::Type }
 
       # @!method initialize(id:, accepted_at:, account_id:, account_number_id:, adjustments:, amount:, back_image_file_id:, bank_of_first_deposit_routing_number:, check_number:, check_transfer_id:, created_at:, currency:, declined_at:, declined_transaction_id:, deposit_return:, front_image_file_id:, payee_name_analysis:, status:, transaction_id:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::InboundCheckDeposit} for more details.
-      #
       #   Inbound Check Deposits are records of third-parties attempting to deposit checks
       #   against your account.
       #
       #   @param id [String] The deposit's identifier.
       #
-      #   @param accepted_at [Time, nil] If the Inbound Check Deposit was accepted, the [ISO 8601](https://en.wikipedia.o
+      #   @param accepted_at [Time, nil]
+      #     If the Inbound Check Deposit was accepted, the
+      #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this
+      #     took place.
       #
       #   @param account_id [String] The Account the check is being deposited against.
       #
       #   @param account_number_id [String, nil] The Account Number the check is being deposited against.
       #
-      #   @param adjustments [Array<Increase::Models::InboundCheckDeposit::Adjustment>] If the deposit or the return was adjusted by the sending institution, this will
+      #   @param adjustments [Array<Increase::Models::InboundCheckDeposit::Adjustment>]
+      #     If the deposit or the return was adjusted by the sending institution, this will
+      #     contain details of the adjustments.
       #
       #   @param amount [Integer] The deposited amount in USD cents.
       #
       #   @param back_image_file_id [String, nil] The ID for the File containing the image of the back of the check.
       #
-      #   @param bank_of_first_deposit_routing_number [String, nil] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the ban
+      #   @param bank_of_first_deposit_routing_number [String, nil]
+      #     The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+      #     bank depositing this check. In some rare cases, this is not transmitted via
+      #     Check21 and the value will be null.
       #
       #   @param check_number [String, nil] The check number printed on the check being deposited.
       #
-      #   @param check_transfer_id [String, nil] If this deposit is for an existing Check Transfer, the identifier of that Check
+      #   @param check_transfer_id [String, nil]
+      #     If this deposit is for an existing Check Transfer, the identifier of that Check
+      #     Transfer.
       #
-      #   @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 deposit was attempted.
       #
-      #   @param currency [Symbol, Increase::Models::InboundCheckDeposit::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
+      #   @param currency [Symbol, Increase::Models::InboundCheckDeposit::Currency]
+      #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
       #
-      #   @param declined_at [Time, nil] If the Inbound Check Deposit was declined, the [ISO 8601](https://en.wikipedia.o
+      #   @param declined_at [Time, nil]
+      #     If the Inbound Check Deposit was declined, the
+      #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this
+      #     took place.
       #
-      #   @param declined_transaction_id [String, nil] If the deposit attempt has been rejected, the identifier of the Declined Transac
+      #   @param declined_transaction_id [String, nil]
+      #     If the deposit attempt has been rejected, the identifier of the Declined
+      #     Transaction object created as a result of the failed deposit.
       #
-      #   @param deposit_return [Increase::Models::InboundCheckDeposit::DepositReturn, nil] If you requested a return of this deposit, this will contain details of the retu
+      #   @param deposit_return [Increase::Models::InboundCheckDeposit::DepositReturn, nil]
+      #     If you requested a return of this deposit, this will contain details of the
+      #     return.
       #
-      #   @param front_image_file_id [String, nil] The ID for the File containing the image of the front of the check.
+      #   @param front_image_file_id [String, nil]
+      #     The ID for the File containing the image of the front of the check.
       #
-      #   @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis] Whether the details on the check match the recipient name of the check transfer.
+      #   @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis]
+      #     Whether the details on the check match the recipient name of the check transfer.
+      #     This is an optional feature, contact sales to enable.
       #
-      #   @param status [Symbol, Increase::Models::InboundCheckDeposit::Status] The status of the Inbound Check Deposit.
+      #   @param status [Symbol, Increase::Models::InboundCheckDeposit::Status]
+      #     The status of the Inbound Check Deposit.
       #
-      #   @param transaction_id [String, nil] If the deposit attempt has been accepted, the identifier of the Transaction obje
+      #   @param transaction_id [String, nil]
+      #     If the deposit attempt has been accepted, the identifier of the Transaction
+      #     object created as a result of the successful deposit.
       #
-      #   @param type [Symbol, Increase::Models::InboundCheckDeposit::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::InboundCheckDeposit::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `inbound_check_deposit`.
 
       class Adjustment < Increase::Internal::Type::BaseModel
         # @!attribute adjusted_at
@@ -215,7 +240,8 @@ module Increase
         #
         #   @param amount [Integer] The amount of the adjustment.
         #
-        #   @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason] The reason for the adjustment.
+        #   @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason]
+        #     The reason for the adjustment.
         #
         #   @param transaction_id [String] The id of the transaction for the adjustment.
 
@@ -273,7 +299,8 @@ module Increase
         #   If you requested a return of this deposit, this will contain details of the
         #   return.
         #
-        #   @param reason [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason] The reason the deposit was returned.
+        #   @param reason [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason]
+        #     The reason the deposit was returned.
         #
         #   @param returned_at [Time] The time at which the deposit was returned.
         #

data/lib/increase/models/inbound_check_deposit_list_params.rb

@@ -39,18 +39,19 @@ module Increase
       optional :limit, Integer
 
       # @!method initialize(account_id: nil, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::InboundCheckDepositListParams} for more details.
-      #
       #   @param account_id [String] Filter Inbound Check Deposits to those belonging to the specified Account.
       #
-      #   @param check_transfer_id [String] Filter Inbound Check Deposits to those belonging to the specified Check Transfer
+      #   @param check_transfer_id [String]
+      #     Filter Inbound Check Deposits to those belonging to the specified Check
+      #     Transfer.
       #
       #   @param created_at [Increase::Models::InboundCheckDepositListParams::CreatedAt]
       #
       #   @param cursor [String] Return the page of entries after this one.
       #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #   @param limit [Integer]
+      #     Limit the size of the list that is returned. The default (and maximum) is 100
+      #     objects.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -84,16 +85,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::InboundCheckDepositListParams::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
     end
   end

data/lib/increase/models/inbound_check_deposit_return_params.rb

@@ -22,7 +22,8 @@ module Increase
       # @!method initialize(inbound_check_deposit_id:, reason:, request_options: {})
       #   @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to return.
       #
-      #   @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] The reason to return the Inbound Check Deposit.
+      #   @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason]
+      #     The reason to return the Inbound Check Deposit.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]