increase 1.340.0 → 1.342.0

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

@@ -4,10 +4,6 @@ module Increase
   module Resources
     class Simulations
       class CardBalanceInquiries
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardBalanceInquiryCreateParams} for more
-        # details.
-        #
         # Simulates a balance inquiry on a [Card](#cards).
         #
         # @overload create(balance: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {})
@@ -16,15 +12,25 @@ module Increase
         #
         # @param card_id [String] The identifier of the Card to be authorized.
         #
-        # @param decline_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::DeclineReason] Forces a card decline with a specific reason. No real time decision will be sent
+        # @param decline_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::DeclineReason]
+        #   Forces a card decline with a specific reason. No real time decision will be
+        #   sent.
         #
         # @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized.
         #
-        # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the
+        # @param event_subscription_id [String]
+        #   The identifier of the Event Subscription to use. If provided, will override the
+        #   default real time event subscription. Because you can only create one real time
+        #   decision event subscription, you can use this field to route events to any
+        #   specified event subscription for testing purposes.
         #
-        # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
+        # @param merchant_acceptor_id [String]
+        #   The merchant identifier (commonly abbreviated as MID) of the merchant the card
+        #   is transacting with.
         #
-        # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
+        # @param merchant_category_code [String]
+        #   The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+        #   card is transacting with.
         #
         # @param merchant_city [String] The city the merchant resides in.
         #
@@ -34,13 +40,18 @@ module Increase
         #
         # @param merchant_state [String] The state the merchant resides in.
         #
-        # @param network_details [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails] Fields specific to a given card network.
+        # @param network_details [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails]
+        #   Fields specific to a given card network.
         #
-        # @param network_risk_score [Integer] The risk score generated by the card network. For Visa this is the Visa Advanced
+        # @param network_risk_score [Integer]
+        #   The risk score generated by the card network. For Visa this is the Visa Advanced
+        #   Authorization risk score, from 0 to 99, where 99 is the riskiest.
         #
         # @param physical_card_id [String] The identifier of the Physical Card to be authorized.
         #
-        # @param terminal_id [String] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
+        # @param terminal_id [String]
+        #   The terminal identifier (commonly abbreviated as TID) of the terminal the card
+        #   is transacting with.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class CardDisputes
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardDisputeActionParams} for more details.
-        #
         # After a [Card Dispute](#card-disputes) is created in production, the dispute
         # will initially be in a `pending_user_submission_reviewing` state. Since no
         # review or further action happens in sandbox, this endpoint simulates moving a
@@ -16,9 +13,13 @@ module Increase
         #
         # @param card_dispute_id [String] The dispute you would like to action.
         #
-        # @param network [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Network] The network of the Card Dispute. Details specific to the network are required un
+        # @param network [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Network]
+        #   The network of the Card Dispute. Details specific to the network are required
+        #   under the sub-object with the same identifier as the network.
         #
-        # @param visa [Increase::Models::Simulations::CardDisputeActionParams::Visa] The Visa-specific parameters for the taking action on the dispute. Required if a
+        # @param visa [Increase::Models::Simulations::CardDisputeActionParams::Visa]
+        #   The Visa-specific parameters for the taking action on the dispute. Required if
+        #   and only if `network` is `visa`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,17 +4,15 @@ module Increase
   module Resources
     class Simulations
       class CardFuelConfirmations
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardFuelConfirmationCreateParams} for more
-        # details.
-        #
         # Simulates the fuel confirmation of an authorization by a card acquirer. This
         # happens asynchronously right after a fuel pump transaction is completed. A fuel
         # confirmation can only happen once per authorization.
         #
         # @overload create(amount:, card_payment_id:, request_options: {})
         #
-        # @param amount [Integer] The amount of the fuel_confirmation in minor units in the card authorization's c
+        # @param amount [Integer]
+        #   The amount of the fuel_confirmation in minor units in the card authorization's
+        #   currency.
         #
         # @param card_payment_id [String] The identifier of the Card Payment to create a fuel_confirmation on.
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class CardIncrements
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardIncrementCreateParams} for more details.
-        #
         # Simulates the increment of an authorization by a card acquirer. An authorization
         # can be incremented multiple times.
         #
@@ -16,7 +13,11 @@ module Increase
         #
         # @param card_payment_id [String] The identifier of the Card Payment to create an increment on.
         #
-        # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the
+        # @param event_subscription_id [String]
+        #   The identifier of the Event Subscription to use. If provided, will override the
+        #   default real time event subscription. Because you can only create one real time
+        #   decision event subscription, you can use this field to route events to any
+        #   specified event subscription for testing purposes.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,21 +4,21 @@ module Increase
   module Resources
     class Simulations
       class CardPurchaseSupplements
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardPurchaseSupplementCreateParams} for more
-        # details.
-        #
         # Simulates the creation of a Card Purchase Supplement (Level 3 data) for a card
         # settlement. This happens asynchronously in production when Visa sends enhanced
         # transaction data about a purchase.
         #
         # @overload create(transaction_id:, invoice: nil, line_items: nil, request_options: {})
         #
-        # @param transaction_id [String] The identifier of the Transaction to create a Card Purchase Supplement for. The
+        # @param transaction_id [String]
+        #   The identifier of the Transaction to create a Card Purchase Supplement for. The
+        #   Transaction must have a source of type `card_settlement`.
         #
-        # @param invoice [Increase::Models::Simulations::CardPurchaseSupplementCreateParams::Invoice] Invoice-level information about the payment.
+        # @param invoice [Increase::Models::Simulations::CardPurchaseSupplementCreateParams::Invoice]
+        #   Invoice-level information about the payment.
         #
-        # @param line_items [Array<Increase::Models::Simulations::CardPurchaseSupplementCreateParams::LineItem>] Line item information, such as individual products purchased.
+        # @param line_items [Array<Increase::Models::Simulations::CardPurchaseSupplementCreateParams::LineItem>]
+        #   Line item information, such as individual products purchased.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,19 +4,23 @@ module Increase
   module Resources
     class Simulations
       class CardRefunds
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardRefundCreateParams} for more details.
-        #
         # Simulates refunding a card transaction. The full value of the original sandbox
         # transaction is refunded.
         #
         # @overload create(amount: nil, pending_transaction_id: nil, transaction_id: nil, request_options: {})
         #
-        # @param amount [Integer] The refund amount in cents. Pulled off the `pending_transaction` or the `transac
+        # @param amount [Integer]
+        #   The refund amount in cents. Pulled off the `pending_transaction` or the
+        #   `transaction` if not provided.
         #
-        # @param pending_transaction_id [String] The identifier of the Pending Transaction for the refund authorization. If this
+        # @param pending_transaction_id [String]
+        #   The identifier of the Pending Transaction for the refund authorization. If this
+        #   is provided, `transaction` must not be provided as a refund with a refund
+        #   authorized can not be linked to a regular transaction.
         #
-        # @param transaction_id [String] The identifier for the Transaction to refund. The Transaction's source must have
+        # @param transaction_id [String]
+        #   The identifier for the Transaction to refund. The Transaction's source must have
+        #   a category of card_settlement.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class CardReversals
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardReversalCreateParams} for more details.
-        #
         # Simulates the reversal of an authorization by a card acquirer. An authorization
         # can be partially reversed multiple times, up until the total authorized amount.
         # Marks the pending transaction as complete if the authorization is fully
@@ -16,7 +13,9 @@ module Increase
         #
         # @param card_payment_id [String] The identifier of the Card Payment to create a reversal on.
         #
-        # @param amount [Integer] The amount of the reversal in minor units in the card authorization's currency.
+        # @param amount [Integer]
+        #   The amount of the reversal in minor units in the card authorization's currency.
+        #   This defaults to the authorization amount.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,22 +4,24 @@ module Increase
   module Resources
     class Simulations
       class CardSettlements
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardSettlementCreateParams} for more details.
-        #
         # Simulates the settlement of an authorization by a card acquirer. After a card
         # authorization is created, the merchant will eventually send a settlement. This
         # simulates that event, which may occur many days after the purchase in
         # production. The amount settled can be different from the amount originally
         # authorized, for example, when adding a tip to a restaurant bill.
         #
-        # @overload create(card_id:, pending_transaction_id:, amount: nil, request_options: {})
+        # @overload create(card_id:, amount: nil, pending_transaction_id: nil, request_options: {})
         #
         # @param card_id [String] The identifier of the Card to create a settlement on.
         #
-        # @param pending_transaction_id [String] The identifier of the Pending Transaction for the Card Authorization you wish to
+        # @param amount [Integer]
+        #   The amount to be settled. This defaults to the amount of the Pending Transaction
+        #   being settled, or a random amount if `pending_transaction_id` is not provided.
         #
-        # @param amount [Integer] The amount to be settled. This defaults to the amount of the Pending Transaction
+        # @param pending_transaction_id [String]
+        #   The identifier of the Pending Transaction for the Card Authorization you wish to
+        #   settle. If not provided, the settlement will be force posted without a Card
+        #   Authorization.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -8,17 +8,20 @@ module Increase
         #
         # @overload create(capabilities: nil, expiration: nil, last4: nil, outcome: nil, prefix: nil, primary_account_number_length: nil, request_options: {})
         #
-        # @param capabilities [Array<Increase::Models::Simulations::CardTokenCreateParams::Capability>] The capabilities of the outbound card token.
+        # @param capabilities [Array<Increase::Models::Simulations::CardTokenCreateParams::Capability>]
+        #   The capabilities of the outbound card token.
         #
         # @param expiration [Date] The expiration date of the card.
         #
         # @param last4 [String] The last 4 digits of the card number.
         #
-        # @param outcome [Increase::Models::Simulations::CardTokenCreateParams::Outcome] The outcome to simulate for card push transfers using this token.
+        # @param outcome [Increase::Models::Simulations::CardTokenCreateParams::Outcome]
+        #   The outcome to simulate for card push transfers using this token.
         #
         # @param prefix [String] The prefix of the card number, usually the first 8 digits.
         #
-        # @param primary_account_number_length [Integer] The total length of the card number, including prefix and last4.
+        # @param primary_account_number_length [Integer]
+        #   The total length of the card number, including prefix and last4.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class CheckDeposits
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
-        #
         # Simulates the creation of a
         # [Check Deposit Adjustment](#check-deposit-adjustments) on a
         # [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
@@ -16,9 +13,15 @@ module Increase
         #
         # @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
         #
-        # @param amount [Integer] The adjustment amount in the minor unit of the Check Deposit's currency (e.g., c
+        # @param amount [Integer]
+        #   The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+        #   cents). A negative amount means that the funds are being clawed back by the
+        #   other bank and is a debit to your account. Defaults to the negative of the Check
+        #   Deposit amount.
         #
-        # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason]
+        #   The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        #   used for a low quality image that the recipient wasn't able to handle.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -79,9 +82,6 @@ module Increase
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CheckDepositSubmitParams} for more details.
-        #
         # Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
         # Reserve. This Check Deposit must first have a `status` of `pending`.
         #
@@ -89,7 +89,9 @@ module Increase
         #
         # @param check_deposit_id [String] The identifier of the Check Deposit you wish to submit.
         #
-        # @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan] If set, the simulation will use these values for the check's scanned MICR data.
+        # @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan]
+        #   If set, the simulation will use these values for the check's scanned MICR data.
+        #   If not set, the simulation will use random values.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class Entities
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::EntityUpdateValidationParams} for more details.
-        #
         # Simulate updates to an
         # [Entity's validation](/documentation/api/entities#entity-object.validation). In
         # production, Know Your Customer validations
@@ -18,7 +15,9 @@ module Increase
         #
         # @param entity_id [String] The identifier of the Entity whose validation status to update.
         #
-        # @param issues [Array<Increase::Models::Simulations::EntityUpdateValidationParams::Issue>] The validation issues to attach. If no issues are provided, the validation statu
+        # @param issues [Array<Increase::Models::Simulations::EntityUpdateValidationParams::Issue>]
+        #   The validation issues to attach. If no issues are provided, the validation
+        #   status will be set to `valid`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -11,7 +11,8 @@ module Increase
         #
         # @overload submit(entity_onboarding_session_id, request_options: {})
         #
-        # @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session you wish to submit.
+        # @param entity_onboarding_session_id [String]
+        #   The identifier of the Entity Onboarding Session you wish to submit.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class Exports
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::ExportCreateParams} for more details.
-        #
         # Many exports are created by you via POST /exports or in the Dashboard. Some
         # exports are created automatically by Increase. For example, tax documents are
         # published once a year. In sandbox, you can trigger the arrival of an export that
@@ -14,9 +11,12 @@ module Increase
         #
         # @overload create(category:, form_1099_int: nil, request_options: {})
         #
-        # @param category [Symbol, Increase::Models::Simulations::ExportCreateParams::Category] The type of Export to create.
+        # @param category [Symbol, Increase::Models::Simulations::ExportCreateParams::Category]
+        #   The type of Export to create.
         #
-        # @param form_1099_int [Increase::Models::Simulations::ExportCreateParams::Form1099Int] Options for the created export. Required if `category` is equal to `form_1099_in
+        # @param form_1099_int [Increase::Models::Simulations::ExportCreateParams::Form1099Int]
+        #   Options for the created export. Required if `category` is equal to
+        #   `form_1099_int`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,10 +4,6 @@ module Increase
   module Resources
     class Simulations
       class InboundACHTransfers
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::InboundACHTransferCreateParams} for more
-        # details.
-        #
         # Simulates an inbound ACH transfer to your account. This imitates initiating a
         # transfer to an Increase account from a different financial institution. The
         # transfer may be either a credit or a debit depending on if the `amount` is
@@ -23,9 +19,13 @@ module Increase
         #
         # @param account_number_id [String] The identifier of the Account Number the inbound ACH Transfer is for.
         #
-        # @param amount [Integer] The transfer amount in cents. A positive amount originates a credit transfer pus
+        # @param amount [Integer]
+        #   The transfer amount in 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 addenda [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda] Additional information to include in the transfer.
+        # @param addenda [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda]
+        #   Additional information to include in the transfer.
         #
         # @param company_descriptive_date [String] The description of the date of the transfer.
         #
@@ -35,15 +35,20 @@ module Increase
         #
         # @param company_id [String] The sender's company ID.
         #
-        # @param company_name [String] The name of the sender. This corresponds to the `originator_company_name` field
+        # @param company_name [String]
+        #   The name of the sender. This corresponds to the `originator_company_name` field
+        #   on the resulting Inbound ACH Transfer.
         #
         # @param receiver_id_number [String] The ID of the receiver of the transfer.
         #
         # @param receiver_name [String] The name of the receiver of the transfer.
         #
-        # @param resolve_at [Time] The time at which the transfer should be resolved. If not provided will resolve
+        # @param resolve_at [Time]
+        #   The time at which the transfer should be resolved. If not provided will resolve
+        #   immediately.
         #
-        # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] The standard entry class code for the transfer.
+        # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode]
+        #   The standard entry class code for the transfer.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,10 +4,6 @@ module Increase
   module Resources
     class Simulations
       class InboundCheckDeposits
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::InboundCheckDepositCreateParams} for more
-        # details.
-        #
         # Simulates an Inbound Check Deposit against your account. This imitates someone
         # depositing a check at their bank that was issued from your account. It may or
         # may not be associated with a Check Transfer. Increase will evaluate the Inbound
@@ -17,13 +13,17 @@ module Increase
         #
         # @overload create(account_number_id:, amount:, check_number:, payee_name_analysis: nil, request_options: {})
         #
-        # @param account_number_id [String] The identifier of the Account Number the Inbound Check Deposit will be against.
+        # @param account_number_id [String]
+        #   The identifier of the Account Number the Inbound Check Deposit will be against.
         #
         # @param amount [Integer] The check amount in cents.
         #
         # @param check_number [String] The check number on the check to be deposited.
         #
-        # @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis] Simulate the outcome of [payee name checking](https://increase.com/documentation
+        # @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis]
+        #   Simulate the outcome of
+        #   [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
+        #   Defaults to `not_evaluated`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -41,10 +41,6 @@ module Increase
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::InboundCheckDepositAdjustmentParams} for more
-        # details.
-        #
         # Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
         # must have a `status` of `accepted`.
         #
@@ -52,9 +48,12 @@ module Increase
         #
         # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
         #
-        # @param amount [Integer] The adjustment amount in cents. Defaults to the amount of the Inbound Check Depo
+        # @param amount [Integer]
+        #   The adjustment amount in cents. Defaults to the amount of the Inbound Check
+        #   Deposit.
         #
-        # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `wrong_payee_credit`.
+        # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
+        #   The reason for the adjustment. Defaults to `wrong_payee_credit`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class InboundMailItems
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
-        #
         # Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox
         # Recipients, as if someone had mailed a physical check. Increase automatically
         # deposits a check mailed to a Lockbox Recipient into the recipient's Account. A
@@ -17,11 +14,17 @@ module Increase
         #
         # @param amount [Integer] The amount of the check to be simulated, in cents.
         #
-        # @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
+        # @param contents_file_id [String]
+        #   The file containing the PDF contents. If not present, a default check image file
+        #   will be used.
         #
-        # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to. Exactly one l
+        # @param lockbox_address_id [String]
+        #   The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
+        #   lockbox identifier parameter must be provided.
         #
-        # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
+        # @param lockbox_recipient_id [String]
+        #   The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
+        #   lockbox identifier parameter must be provided.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,17 +4,15 @@ module Increase
   module Resources
     class Simulations
       class InboundRealTimePaymentsTransfers
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::InboundRealTimePaymentsTransferCreateParams} for
-        # more details.
-        #
         # Simulates an
         # [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to
         # your account. Real-Time Payments are a beta feature.
         #
         # @overload create(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, request_for_payment_id: nil, unstructured_remittance_information: nil, request_options: {})
         #
-        # @param account_number_id [String] The identifier of the Account Number the inbound Real-Time Payments Transfer is
+        # @param account_number_id [String]
+        #   The identifier of the Account Number the inbound Real-Time Payments Transfer is
+        #   for.
         #
         # @param amount [Integer] The transfer amount in USD cents. Must be positive.
         #
@@ -24,7 +22,8 @@ module Increase
         #
         # @param debtor_routing_number [String] The routing number of the account that sent the transfer.
         #
-        # @param request_for_payment_id [String] The identifier of a pending Request for Payment that this transfer will fulfill.
+        # @param request_for_payment_id [String]
+        #   The identifier of a pending Request for Payment that this transfer will fulfill.
         #
         # @param unstructured_remittance_information [String] Additional information included with the transfer.
         #

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

@@ -4,10 +4,6 @@ module Increase
   module Resources
     class Simulations
       class InboundWireDrawdownRequests
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::InboundWireDrawdownRequestCreateParams} for more
-        # details.
-        #
         # Simulates receiving an
         # [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
         #
@@ -19,23 +15,37 @@ module Increase
         #
         # @param creditor_routing_number [String] The creditor's routing number.
         #
-        # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+        # @param currency [String]
+        #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+        #   requested. Will always be "USD".
         #
-        # @param recipient_account_number_id [String] The Account Number to which the recipient of this request is being requested to
+        # @param recipient_account_number_id [String]
+        #   The Account Number to which the recipient of this request is being requested to
+        #   send funds from.
         #
-        # @param creditor_address_line1 [String] A free-form address field set by the sender representing the first line of the c
+        # @param creditor_address_line1 [String]
+        #   A free-form address field set by the sender representing the first line of the
+        #   creditor's address.
         #
-        # @param creditor_address_line2 [String] A free-form address field set by the sender representing the second line of the
+        # @param creditor_address_line2 [String]
+        #   A free-form address field set by the sender representing the second line of the
+        #   creditor's address.
         #
-        # @param creditor_address_line3 [String] A free-form address field set by the sender representing the third line of the c
+        # @param creditor_address_line3 [String]
+        #   A free-form address field set by the sender representing the third line of the
+        #   creditor's address.
         #
         # @param creditor_name [String] A free-form name field set by the sender representing the creditor's name.
         #
         # @param debtor_account_number [String] The debtor's account number.
         #
-        # @param debtor_address_line1 [String] A free-form address field set by the sender representing the first line of the d
+        # @param debtor_address_line1 [String]
+        #   A free-form address field set by the sender representing the first line of the
+        #   debtor's address.
         #
-        # @param debtor_address_line2 [String] A free-form address field set by the sender representing the second line of the
+        # @param debtor_address_line2 [String]
+        #   A free-form address field set by the sender representing the second line of the
+        #   debtor's address.
         #
         # @param debtor_address_line3 [String] A free-form address field set by the sender.
         #
@@ -43,11 +53,15 @@ module Increase
         #
         # @param debtor_routing_number [String] The debtor's routing number.
         #
-        # @param end_to_end_identification [String] A free-form reference string set by the sender, to help identify the transfer.
+        # @param end_to_end_identification [String]
+        #   A free-form reference string set by the sender, to help identify the transfer.
         #
         # @param instruction_identification [String] The sending bank's identifier for the wire transfer.
         #
-        # @param unique_end_to_end_transaction_reference [String] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
+        # @param unique_end_to_end_transaction_reference [String]
+        #   The Unique End-to-end Transaction Reference
+        #   ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
+        #   of the transfer.
         #
         # @param unstructured_remittance_information [String] A free-form message set by the sender.
         #