increase 1.340.0 → 1.341.0

data/lib/increase/models/ach_transfer_create_params.rb

@@ -156,46 +156,93 @@ module Increase
       optional :transaction_timing, enum: -> { Increase::ACHTransferCreateParams::TransactionTiming }
 
       # @!method initialize(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, transaction_timing: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::ACHTransferCreateParams} for more details.
-      #
       #   @param account_id [String] The Increase identifier for the account that will send the transfer.
       #
-      #   @param amount [Integer] The transfer amount in USD cents. A positive amount originates a credit transfer
-      #
-      #   @param statement_descriptor [String] A description you choose to give the transfer. This will be saved with the trans
-      #
-      #   @param account_number [String] The receiver's account number. For credit transfers (positive `amount`) this is
-      #
-      #   @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information passed through to the receiving bank with the transfer. M
-      #
-      #   @param company_descriptive_date [String] A description of the transfer date (typically `YYMMDD`), sent in the company bat
-      #
-      #   @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 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, sent in the company batch header. We
-      #
-      #   @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 receiver's bank account.
-      #
-      #   @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
-      #
-      #   @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] Configuration for how the effective date of the transfer will be set. This deter
-      #
-      #   @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) 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
-      #
-      #   @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] The timing of the transaction.
+      #   @param amount [Integer]
+      #     The transfer amount in USD cents. A positive amount originates a credit transfer
+      #     pushing funds to the receiving account. A negative amount originates a debit
+      #     transfer pulling funds from the receiving account.
+      #
+      #   @param statement_descriptor [String]
+      #     A description you choose to give the transfer. This will be saved with the
+      #     transfer details, displayed in the dashboard, and returned by the API. If
+      #     `individual_name` and `company_name` are not explicitly set by this API, the
+      #     `statement_descriptor` will be sent in those fields to the receiving bank to
+      #     help the customer recognize the transfer. You are highly encouraged to pass
+      #     `individual_name` and `company_name` instead of relying on this fallback.
+      #
+      #   @param account_number [String]
+      #     The receiver's account number. For credit transfers (positive `amount`) this is
+      #     the account that funds will be sent to. For debit transfers (negative `amount`)
+      #     this is the account that funds will be pulled from.
+      #
+      #   @param addenda [Increase::Models::ACHTransferCreateParams::Addenda]
+      #     Additional information passed through to the receiving bank with the transfer.
+      #     Most ACH transfers do not need this. Only set this if your recipient has asked
+      #     for addendum data, typically unstructured remittance information. Corporate
+      #     Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
+      #
+      #   @param company_descriptive_date [String]
+      #     A description of the transfer date (typically `YYMMDD`), sent in the company
+      #     batch header. This value is informational and does not affect funds movement,
+      #     settlement timing, or returns. Only set this if your recipient has asked for it.
+      #
+      #   @param company_discretionary_data [String]
+      #     Custom data sent in the company batch header. This value is informational and
+      #     does not affect funds movement, settlement timing, or returns. Most ACH
+      #     transfers do not need this. Only set this if your recipient has asked for it.
+      #
+      #   @param company_entry_description [String]
+      #     A short description sent in the company batch header. Most receivers do not
+      #     surface this. Only set this if your recipient has asked for a specific value or
+      #     if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
+      #     example, Prearranged Payment and Deposit (PPD) payroll credits must use
+      #     `PAYROLL`, and reversals must use `REVERSAL`.
+      #
+      #   @param company_name [String]
+      #     The name by which the recipient knows you, sent in the company batch header. We
+      #     recommend setting this on every transfer; if you do not, we fall back to the ACH
+      #     company name configured on your account.
+      #
+      #   @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
+      #     provided, `account_number`, `routing_number`, and `funding` must be absent.
+      #
+      #   @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding]
+      #     The type of the receiver's bank account.
+      #
+      #   @param individual_id [String]
+      #     Your internal identifier for the transfer recipient. This value is informational
+      #     and not verified by the recipient's bank. Most callers can leave this unset.
+      #
+      #   @param individual_name [String]
+      #     The name of the transfer recipient. This value is informational and not verified
+      #     by the recipient's bank.
+      #
+      #   @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
+      #     Configuration for how the effective date of the transfer will be set. This
+      #     determines same-day vs future-dated settlement timing. If not set, defaults to a
+      #     `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
+      #     must be set.
+      #
+      #   @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) of the
+      #     receiver's bank.
+      #
+      #   @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode]
+      #     The
+      #     [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
+      #     to use for the transfer. If not provided, the default is
+      #     `corporate_credit_or_debit`.
+      #
+      #   @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming]
+      #     The timing of the transaction.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -223,19 +270,22 @@ module Increase
                  -> { Increase::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice }
 
         # @!method initialize(category:, freeform: nil, payment_order_remittance_advice: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::ACHTransferCreateParams::Addenda} for more details.
-        #
         #   Additional information passed through to the receiving bank with the transfer.
         #   Most ACH transfers do not need this. Only set this if your recipient has asked
         #   for addendum data, typically unstructured remittance information. Corporate
         #   Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
         #
-        #   @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] The type of addenda to pass with the transfer.
+        #   @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category]
+        #     The type of addenda to pass with the transfer.
         #
-        #   @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] Unstructured `payment_related_information` passed through with the transfer. Req
+        #   @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform]
+        #     Unstructured `payment_related_information` passed through with the transfer.
+        #     Required if and only if `category` is `freeform`.
         #
-        #   @param payment_order_remittance_advice [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice] Structured ASC X12 820 remittance advice records. Please reach out to [support@i
+        #   @param payment_order_remittance_advice [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice]
+        #     Structured ASC X12 820 remittance advice records. Please reach out to
+        #     [support@increase.com](mailto:support@increase.com) for more information.
+        #     Required if and only if `category` is `payment_order_remittance_advice`.
 
         # The type of addenda to pass with the transfer.
         #
@@ -265,13 +315,13 @@ module Increase
                    -> { Increase::Internal::Type::ArrayOf[Increase::ACHTransferCreateParams::Addenda::Freeform::Entry] }
 
           # @!method initialize(entries:)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::ACHTransferCreateParams::Addenda::Freeform} for more details.
-          #
           #   Unstructured `payment_related_information` passed through with the transfer.
           #   Required if and only if `category` is `freeform`.
           #
-          #   @param entries [Array<Increase::Models::ACHTransferCreateParams::Addenda::Freeform::Entry>] Each entry represents an addendum sent with the transfer. Sending more than one
+          #   @param entries [Array<Increase::Models::ACHTransferCreateParams::Addenda::Freeform::Entry>]
+          #     Each entry represents an addendum sent with the transfer. Sending more than one
+          #     addendum is only supported for transfers with `standard_entry_class_code` of
+          #     `corporate_trade_exchange` (CTX).
 
           class Entry < Increase::Internal::Type::BaseModel
             # @!attribute payment_related_information
@@ -299,7 +349,8 @@ module Increase
           #   [support@increase.com](mailto:support@increase.com) for more information.
           #   Required if and only if `category` is `payment_order_remittance_advice`.
           #
-          #   @param invoices [Array<Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice::Invoice>] ASC X12 RMR records for this specific transfer.
+          #   @param invoices [Array<Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice::Invoice>]
+          #     ASC X12 RMR records for this specific transfer.
 
           class Invoice < Increase::Internal::Type::BaseModel
             # @!attribute invoice_number
@@ -316,13 +367,12 @@ module Increase
             required :paid_amount, Integer
 
             # @!method initialize(invoice_number:, paid_amount:)
-            #   Some parameter documentations has been truncated, see
-            #   {Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice::Invoice}
-            #   for more details.
+            #   @param invoice_number [String]
+            #     The invoice number for this reference, determined in advance with the receiver.
             #
-            #   @param invoice_number [String] The invoice number for this reference, determined in advance with the receiver.
-            #
-            #   @param paid_amount [Integer] The amount that was paid for this invoice in the minor unit of its currency. For
+            #   @param paid_amount [Integer]
+            #     The amount that was paid for this invoice in the minor unit of its currency. For
+            #     dollars, for example, this is cents.
           end
         end
       end
@@ -380,18 +430,17 @@ module Increase
                  enum: -> { Increase::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule }
 
         # @!method initialize(date: nil, settlement_schedule: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate} for more
-        #   details.
-        #
         #   Configuration for how the effective date of the transfer will be set. This
         #   determines same-day vs future-dated settlement timing. If not set, defaults to a
         #   `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
         #   must be set.
         #
-        #   @param date [Date] A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
+        #   @param date [Date]
+        #     A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
+        #     use as the effective date when submitting this transfer.
         #
-        #   @param settlement_schedule [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule] A schedule by which Increase will choose an effective date for the transfer.
+        #   @param settlement_schedule [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule]
+        #     A schedule by which Increase will choose an effective date for the transfer.
 
         # A schedule by which Increase will choose an effective date for the transfer.
         #

data/lib/increase/models/ach_transfer_list_params.rb

@@ -52,9 +52,6 @@ module Increase
       optional :status, -> { Increase::ACHTransferListParams::Status }
 
       # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::ACHTransferListParams} for more details.
-      #
       #   @param account_id [String] Filter ACH Transfers to those that originated from the specified Account.
       #
       #   @param created_at [Increase::Models::ACHTransferListParams::CreatedAt]
@@ -63,9 +60,15 @@ module Increase
       #
       #   @param external_account_id [String] Filter ACH Transfers to those made to the specified External Account.
       #
-      #   @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::ACHTransferListParams::Status]
       #
@@ -101,16 +104,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::ACHTransferListParams::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
@@ -124,10 +132,9 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::ACHTransferListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::ACHTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
+        #   @param in_ [Array<Symbol, Increase::Models::ACHTransferListParams::Status::In>]
+        #     Return results whose value is in the provided list. 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/balance_lookup.rb

@@ -38,21 +38,24 @@ module Increase
       required :type, enum: -> { Increase::BalanceLookup::Type }
 
       # @!method initialize(account_id:, available_balance:, current_balance:, loan:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BalanceLookup} for more details.
-      #
       #   Represents a request to lookup the balance of an Account at a given point in
       #   time.
       #
       #   @param account_id [String] The identifier for the account for which the balance was queried.
       #
-      #   @param available_balance [Integer] The Account's available balance, representing the current balance less any open
+      #   @param available_balance [Integer]
+      #     The Account's available balance, representing the current balance less any open
+      #     Pending Transactions on the Account.
       #
-      #   @param current_balance [Integer] The Account's current balance, representing the sum of all posted Transactions o
+      #   @param current_balance [Integer]
+      #     The Account's current balance, representing the sum of all posted Transactions
+      #     on the Account.
       #
       #   @param loan [Increase::Models::BalanceLookup::Loan, nil] The loan balances for the Account.
       #
-      #   @param type [Symbol, Increase::Models::BalanceLookup::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::BalanceLookup::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `balance_lookup`.
 
       # @see Increase::Models::BalanceLookup#loan
       class Loan < Increase::Internal::Type::BaseModel
@@ -82,18 +85,18 @@ module Increase
         required :receivables, -> { Increase::BalanceLookup::Loan::Receivables }, nil?: true
 
         # @!method initialize(due_at:, due_balance:, past_due_balance:, receivables:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::BalanceLookup::Loan} for more details.
-        #
         #   The loan balances for the Account.
         #
-        #   @param due_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan pa
+        #   @param due_at [Time, nil]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
+        #     payment is due.
         #
         #   @param due_balance [Integer] The total amount due on the loan.
         #
         #   @param past_due_balance [Integer] The amount past due on the loan.
         #
-        #   @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil] The receivables balances for the loan.
+        #   @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil]
+        #     The receivables balances for the loan.
 
         # @see Increase::Models::BalanceLookup::Loan#receivables
         class Receivables < Increase::Internal::Type::BaseModel

data/lib/increase/models/beneficial_owner_create_params.rb

@@ -36,14 +36,17 @@ module Increase
       optional :company_title, String
 
       # @!method initialize(entity_id:, individual:, prongs:, company_title: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BeneficialOwnerCreateParams} for more details.
+      #   @param entity_id [String]
+      #     The identifier of the Entity to associate with the new Beneficial Owner. Only
+      #     `corporation` entities have beneficial owners.
       #
-      #   @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.
       #
-      #   @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual] Personal details for the beneficial owner.
-      #
-      #   @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
+      #   @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>]
+      #     Why this person is considered a beneficial owner of the entity. At least one
+      #     option is required, if a person is both a control person and owner, submit an
+      #     array containing both.
       #
       #   @param company_title [String] This person's role or title within the entity.
       #
@@ -85,20 +88,24 @@ module Increase
         optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
 
         # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::BeneficialOwnerCreateParams::Individual} for more details.
-        #
         #   Personal details for the beneficial owner.
         #
-        #   @param address [Increase::Models::BeneficialOwnerCreateParams::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
+        #   @param address [Increase::Models::BeneficialOwnerCreateParams::Individual::Address]
+        #     The individual's physical address. Mail receiving locations like PO Boxes and
+        #     PMB's are disallowed.
         #
         #   @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
         #
-        #   @param identification [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification] A means of verifying the person's identity.
+        #   @param identification [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification]
+        #     A means of verifying the person's identity.
         #
         #   @param name [String] The person's legal name.
         #
-        #   @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
+        #   @param confirmed_no_us_tax_id [Boolean]
+        #     The identification method for an individual can only be a passport, driver's
+        #     license, or other document if you've confirmed the individual does not have a US
+        #     tax id (either a Social Security Number or Individual Taxpayer Identification
+        #     Number).
 
         # @see Increase::Models::BeneficialOwnerCreateParams::Individual#address
         class Address < Increase::Internal::Type::BaseModel
@@ -140,10 +147,6 @@ module Increase
           optional :zip, String
 
           # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Address} for more
-          #   details.
-          #
           #   The individual's physical address. Mail receiving locations like PO Boxes and
           #   PMB's are disallowed.
           #
@@ -155,7 +158,9 @@ module Increase
           #
           #   @param line2 [String] The second line of the address. This might be the floor or room number.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
+          #   @param state [String]
+          #     The two-letter United States Postal Service (USPS) abbreviation for the US
+          #     state, province, or region of the address. Required in certain countries.
           #
           #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
         end
@@ -203,21 +208,29 @@ module Increase
           optional :passport, -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport }
 
           # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification} for
-          #   more details.
-          #
           #   A means of verifying the person's identity.
           #
-          #   @param method_ [Symbol, Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Method] A method that can be used to verify the individual's identity.
+          #   @param method_ [Symbol, Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Method]
+          #     A method that can be used to verify the individual's identity.
           #
-          #   @param number [String] An identification number that can be used to verify the individual's identity, s
+          #   @param number [String]
+          #     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. When testing in sandbox, use one of our
+          #     [sandbox test values](https://increase.com/documentation/sandbox-test-values).
           #
-          #   @param drivers_license [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
+          #   @param drivers_license [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense]
+          #     Information about the United States driver's license used for identification.
+          #     Required if `method` is equal to `drivers_license`.
           #
-          #   @param other [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other] Information about the identification document provided. Required if `method` is
+          #   @param other [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other]
+          #     Information about the identification document provided. Required if `method` is
+          #     equal to `other`.
           #
-          #   @param passport [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is
+          #   @param passport [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport]
+          #     Information about the passport used for identification. Required if `method` is
+          #     equal to `passport`.
 
           # A method that can be used to verify the individual's identity.
           #
@@ -318,20 +331,20 @@ module Increase
             optional :expiration_date, Date
 
             # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other}
-            #   for more details.
-            #
             #   Information about the identification document provided. Required if `method` is
             #   equal to `other`.
             #
-            #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+            #   @param country [String]
+            #     The two-character ISO 3166-1 code representing the country that issued the
+            #     document (e.g., `US`).
             #
             #   @param description [String] A description of the document submitted.
             #
             #   @param file_id [String] The identifier of the File containing the front of the document.
             #
-            #   @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
+            #   @param back_file_id [String]
+            #     The identifier of the File containing the back of the document. Not every
+            #     document has a reverse side.
             #
             #   @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
           end
@@ -358,14 +371,12 @@ module Increase
             required :file_id, String
 
             # @!method initialize(country:, expiration_date:, file_id:)
-            #   Some parameter documentations has been truncated, see
-            #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport}
-            #   for more details.
-            #
             #   Information about the passport used for identification. Required if `method` is
             #   equal to `passport`.
             #
-            #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+            #   @param country [String]
+            #     The two-character ISO 3166-1 code representing the country that issued the
+            #     document (e.g., `US`).
             #
             #   @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
             #

data/lib/increase/models/beneficial_owner_list_params.rb

@@ -37,16 +37,21 @@ module Increase
       optional :limit, Integer
 
       # @!method initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BeneficialOwnerListParams} for more details.
-      #
-      #   @param entity_id [String] The identifier of the Entity to list beneficial owners for. Only `corporation` e
+      #   @param entity_id [String]
+      #     The identifier of the Entity to list beneficial owners for. Only `corporation`
+      #     entities have beneficial owners.
       #
       #   @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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
     end