increase 1.340.0 → 1.341.0

data/lib/increase/resources/real_time_payments_transfers.rb

@@ -3,34 +3,46 @@
 module Increase
   module Resources
     class RealTimePaymentsTransfers
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::RealTimePaymentsTransferCreateParams} for more details.
-      #
       # Create a Real-Time Payments Transfer
       #
       # @overload create(amount:, creditor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, debtor_name: nil, external_account_id: nil, require_approval: nil, routing_number: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {})
       #
-      # @param amount [Integer] The transfer amount in USD cents. For Real-Time Payments transfers, must be posi
+      # @param amount [Integer]
+      #   The transfer amount in USD cents. For Real-Time Payments transfers, must be
+      #   positive.
       #
       # @param creditor_name [String] The name of the transfer's recipient.
       #
-      # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer.
+      # @param source_account_number_id [String]
+      #   The identifier of the Account Number from which to send the transfer.
       #
-      # @param unstructured_remittance_information [String] Unstructured information that will show on the recipient's bank statement.
+      # @param unstructured_remittance_information [String]
+      #   Unstructured information that will show on the recipient's bank statement.
       #
       # @param account_number [String] The destination account number.
       #
-      # @param debtor_name [String] The name of the transfer's sender. If not provided, defaults to the name of the
+      # @param debtor_name [String]
+      #   The name of the transfer's sender. If not provided, defaults to the name of the
+      #   account's entity.
       #
-      # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
+      # @param external_account_id [String]
+      #   The ID of an External Account to initiate a transfer to. If this parameter is
+      #   provided, `account_number` and `routing_number` must be absent.
       #
-      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      # @param require_approval [Boolean]
+      #   Whether the transfer requires explicit approval via the dashboard or API.
       #
-      # @param routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN)
+      # @param routing_number [String]
+      #   The destination American Bankers' Association (ABA) Routing Transit Number
+      #   (RTN).
       #
-      # @param ultimate_creditor_name [String] The name of the ultimate recipient of the transfer. Set this if the creditor is
+      # @param ultimate_creditor_name [String]
+      #   The name of the ultimate recipient of the transfer. Set this if the creditor is
+      #   an intermediary receiving the payment for someone else.
       #
-      # @param ultimate_debtor_name [String] The name of the ultimate sender of the transfer. Set this if the funds are being
+      # @param ultimate_debtor_name [String]
+      #   The name of the ultimate sender of the transfer. Set this if the funds are being
+      #   sent on behalf of someone who is not the account holder at Increase.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -68,24 +80,30 @@ module Increase
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::RealTimePaymentsTransferListParams} for more details.
-      #
       # List Real-Time Payments Transfers
       #
       # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
       #
-      # @param account_id [String] Filter Real-Time Payments Transfers to those belonging to the specified Account.
+      # @param account_id [String]
+      #   Filter Real-Time Payments Transfers to those belonging to the specified Account.
       #
       # @param created_at [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt]
       #
       # @param cursor [String] Return the page of entries after this one.
       #
-      # @param external_account_id [String] Filter Real-Time Payments Transfers to those made to the specified External Acco
+      # @param external_account_id [String]
+      #   Filter Real-Time Payments 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::RealTimePaymentsTransferListParams::Status]
       #
@@ -111,7 +129,8 @@ module Increase
       #
       # @overload approve(real_time_payments_transfer_id, request_options: {})
       #
-      # @param real_time_payments_transfer_id [String] The identifier of the Real-Time Payments Transfer to approve.
+      # @param real_time_payments_transfer_id [String]
+      #   The identifier of the Real-Time Payments Transfer to approve.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -131,7 +150,8 @@ module Increase
       #
       # @overload cancel(real_time_payments_transfer_id, request_options: {})
       #
-      # @param real_time_payments_transfer_id [String] The identifier of the pending Real-Time Payments Transfer to cancel.
+      # @param real_time_payments_transfer_id [String]
+      #   The identifier of the pending Real-Time Payments Transfer to cancel.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/increase/resources/routing_numbers.rb

@@ -3,9 +3,6 @@
 module Increase
   module Resources
     class RoutingNumbers
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::RoutingNumberListParams} for more details.
-      #
       # You can use this API to confirm if a routing number is valid, such as when a
       # user is providing you with bank account details. Since routing numbers uniquely
       # identify a bank, this will always return 0 or 1 entry. In Sandbox, only a few
@@ -18,7 +15,9 @@ module Increase
       #
       # @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}, nil]
       #

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

@@ -4,10 +4,6 @@ module Increase
   module Resources
     class Simulations
       class AccountRevenuePayments
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::AccountRevenuePaymentCreateParams} for more
-        # details.
-        #
         # Simulates an account revenue payment to your account. In production, this
         # happens automatically on the first of each month.
         #
@@ -17,11 +13,17 @@ module Increase
         #
         # @param amount [Integer] The account revenue amount in cents. Must be positive.
         #
-        # @param accrued_on_account_id [String] The identifier of the Account the account revenue accrued on. Defaults to `accou
+        # @param accrued_on_account_id [String]
+        #   The identifier of the Account the account revenue accrued on. Defaults to
+        #   `account_id`.
         #
-        # @param period_end [Time] The end of the account revenue period. If not provided, defaults to the current
+        # @param period_end [Time]
+        #   The end of the account revenue period. If not provided, defaults to the current
+        #   time.
         #
-        # @param period_start [Time] The start of the account revenue period. If not provided, defaults to the curren
+        # @param period_start [Time]
+        #   The start of the account revenue period. If not provided, defaults to the
+        #   current time.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -29,18 +29,17 @@ module Increase
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams} for
-        # more details.
-        #
         # Simulates receiving a Notification of Change for an
         # [ACH Transfer](#ach-transfers).
         #
         # @overload create_notification_of_change(ach_transfer_id, corrected_account_funding: nil, corrected_account_number: nil, corrected_individual_id: nil, corrected_routing_number: nil, request_options: {})
         #
-        # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to create a notification of change f
+        # @param ach_transfer_id [String]
+        #   The identifier of the ACH Transfer you wish to create a notification of change
+        #   for.
         #
-        # @param corrected_account_funding [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding] The corrected account funding type.
+        # @param corrected_account_funding [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding]
+        #   The corrected account funding type.
         #
         # @param corrected_account_number [String] The corrected account number.
         #
@@ -64,9 +63,6 @@ module Increase
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::ACHTransferReturnParams} for more details.
-        #
         # Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve
         # due to an error condition. This will also create a Transaction to account for
         # the returned funds. This transfer must first have a `status` of `submitted`.
@@ -75,7 +71,9 @@ module Increase
         #
         # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to return.
         #
-        # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] The reason why the Federal Reserve or destination bank returned this transfer. D
+        # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
+        #   The reason why the Federal Reserve or destination bank returned this transfer.
+        #   Defaults to `no_account`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -93,9 +91,6 @@ module Increase
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::ACHTransferSettleParams} for more details.
-        #
         # Simulates the settlement of an [ACH Transfer](#ach-transfers) by the Federal
         # Reserve. This transfer must first have a `status` of `pending_submission` or
         # `submitted`. For convenience, if the transfer is in `status`:
@@ -110,7 +105,10 @@ module Increase
         #
         # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to become settled.
         #
-        # @param inbound_funds_hold_behavior [Symbol, Increase::Models::Simulations::ACHTransferSettleParams::InboundFundsHoldBehavior] The behavior of the inbound funds hold that is created when the ACH Transfer is
+        # @param inbound_funds_hold_behavior [Symbol, Increase::Models::Simulations::ACHTransferSettleParams::InboundFundsHoldBehavior]
+        #   The behavior of the inbound funds hold that is created when the ACH Transfer is
+        #   settled. If no behavior is specified, the inbound funds hold will be released
+        #   immediately in order for the funds to be available for use.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,10 +4,6 @@ module Increase
   module Resources
     class Simulations
       class CardAuthentications
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardAuthenticationCreateParams} for more
-        # details.
-        #
         # Simulates a Card Authentication attempt on a [Card](#cards). The attempt always
         # results in a [Card Payment](#card_payments) being created, either with a status
         # that allows further action or a terminal failed status.
@@ -16,13 +12,19 @@ module Increase
         #
         # @param card_id [String] The identifier of the Card to be authorized.
         #
-        # @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category] The category of the card authentication attempt.
+        # @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category]
+        #   The category of the card authentication attempt.
         #
-        # @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel] The device channel of the card authentication attempt.
+        # @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel]
+        #   The device channel of the card authentication attempt.
         #
-        # @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_country [String] The country the merchant resides in.
         #

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

@@ -4,9 +4,6 @@ module Increase
   module Resources
     class Simulations
       class CardAuthorizations
-        # Some parameter documentations has been truncated, see
-        # {Increase::Models::Simulations::CardAuthorizationCreateParams} for more details.
-        #
         # Simulates a purchase authorization on a [Card](#cards). Depending on the balance
         # available to the card and the `amount` submitted, the authorization activity
         # will result in a [Pending Transaction](#pending-transactions) of type
@@ -22,19 +19,31 @@ module Increase
         #
         # @param amount [Integer] The authorization amount in cents.
         #
-        # @param authenticated_card_payment_id [String] The identifier of a Card Payment with a `card_authentication` if you want to sim
+        # @param authenticated_card_payment_id [String]
+        #   The identifier of a Card Payment with a `card_authentication` if you want to
+        #   simulate an authenticated authorization.
         #
         # @param card_id [String] The identifier of the Card to be authorized.
         #
-        # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] Forces a card decline with a specific reason. No real time decision will be sent
+        # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::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.
         #
@@ -44,15 +53,22 @@ module Increase
         #
         # @param merchant_state [String] The state the merchant resides in.
         #
-        # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] Fields specific to a given card network.
+        # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::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 processing_category [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory] Fields specific to a specific type of authorization, such as Automatic Fuel Disp
+        # @param processing_category [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory]
+        #   Fields specific to a specific type of authorization, such as Automatic Fuel
+        #   Dispensers, Refund Authorizations, or Cash Disbursements.
         #
-        # @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_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,9 +4,6 @@ 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
@@ -17,9 +14,13 @@ module Increase
         #
         # @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 pending_transaction_id [String]
+        #   The identifier of the Pending Transaction for the Card Authorization you wish to
+        #   settle.
         #
-        # @param amount [Integer] The amount to be settled. This defaults to the amount of the Pending Transaction
+        # @param amount [Integer]
+        #   The amount to be settled. This defaults to the amount of the Pending Transaction
+        #   being settled.
         #
         # @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]
         #