increase 1.340.0 → 1.342.0

data/lib/increase/models/transaction_list_params.rb

@@ -44,9 +44,6 @@ module Increase
       optional :route_id, String
 
       # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::TransactionListParams} for more details.
-      #
       #   @param account_id [String] Filter Transactions for those belonging to the specified Account.
       #
       #   @param category [Increase::Models::TransactionListParams::Category]
@@ -55,9 +52,13 @@ 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 route_id [String] Filter Transactions for those belonging to the specified route. This could be a
+      #   @param route_id [String]
+      #     Filter Transactions for those belonging to the specified route. This could be a
+      #     Card ID or an Account Number ID.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -74,10 +75,9 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::TransactionListParams::Category} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::TransactionListParams::Category::In>] Return results whose value is in the provided list. For GET requests, this shoul
+        #   @param in_ [Array<Symbol, Increase::Models::TransactionListParams::Category::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
@@ -231,16 +231,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::TransactionListParams::CreatedAt} for more details.
-        #
-        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #   @param after [Time]
+        #     Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #   @param before [Time]
+        #     Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #   @param on_or_after [Time]
+        #     Return results on or after this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
         #
-        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+        #   @param on_or_before [Time]
+        #     Return results on or before this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
       end
     end
   end

data/lib/increase/models/unwrap_webhook_event.rb

@@ -42,9 +42,6 @@ module Increase
       required :type, enum: -> { Increase::UnwrapWebhookEvent::Type }
 
       # @!method initialize(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::UnwrapWebhookEvent} for more details.
-      #
       #   Events are records of things that happened to objects at Increase. Events are
       #   accessible via the List Events endpoint and can be delivered to your application
       #   via webhooks. For more information, see our
@@ -56,11 +53,15 @@ module Increase
       #
       #   @param associated_object_type [String] The type of the object that generated this Event.
       #
-      #   @param category [Symbol, Increase::Models::UnwrapWebhookEvent::Category] The category of the Event. We may add additional possible values for this enum o
+      #   @param category [Symbol, Increase::Models::UnwrapWebhookEvent::Category]
+      #     The category of the Event. We may add additional possible values for this enum
+      #     over time; your application should be able to handle such additions gracefully.
       #
       #   @param created_at [Time] The time the Event was created.
       #
-      #   @param type [Symbol, Increase::Models::UnwrapWebhookEvent::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::UnwrapWebhookEvent::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `event`.
 
       # The category of the Event. We may add additional possible values for this enum
       # over time; your application should be able to handle such additions gracefully.
@@ -252,6 +253,14 @@ module Increase
         # Occurs whenever an Inbound Mail Item is updated.
         INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
 
+        # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
+        INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
+          :"inbound_real_time_payments_request_for_payment.created"
+
+        # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
+        INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
+          :"inbound_real_time_payments_request_for_payment.updated"
+
         # Occurs whenever an Inbound Real-Time Payments Transfer is created.
         INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
 

data/lib/increase/models/wire_drawdown_request.rb

@@ -136,9 +136,6 @@ module Increase
       required :unstructured_remittance_information, String
 
       # @!method initialize(id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::WireDrawdownRequest} for more details.
-      #
       #   Wire drawdown requests enable you to request that someone else send you a wire.
       #   Because there is nuance to making sure your counterparty's bank processes these
       #   correctly, we ask that you reach out to
@@ -148,17 +145,23 @@ module Increase
       #
       #   @param id [String] The Wire drawdown request identifier.
       #
-      #   @param account_number_id [String] The Account Number to which the debtor—the recipient of this request—is being re
+      #   @param account_number_id [String]
+      #     The Account Number to which the debtor—the recipient of this request—is being
+      #     requested to send funds.
       #
       #   @param amount [Integer] The amount being requested in cents.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the wire drawdown request was created.
       #
       #   @param creditor_address [Increase::Models::WireDrawdownRequest::CreditorAddress] The creditor's address.
       #
       #   @param creditor_name [String] The creditor's name.
       #
-      #   @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 debtor_account_number [String] The debtor's account number.
       #
@@ -170,21 +173,37 @@ module Increase
       #
       #   @param debtor_routing_number [String] The debtor's routing number.
       #
-      #   @param end_to_end_identification [String, nil] A free-form reference string set by the sender, to be mirrored back in the subse
+      #   @param end_to_end_identification [String, nil]
+      #     A free-form reference string set by the sender, to be mirrored back in the
+      #     subsequent wire transfer.
       #
-      #   @param fulfillment_inbound_wire_transfer_id [String, nil] If the recipient fulfills the drawdown request by sending funds, then this will
+      #   @param fulfillment_inbound_wire_transfer_id [String, nil]
+      #     If the recipient fulfills the drawdown request by sending funds, then this will
+      #     be the identifier of the corresponding Transaction.
       #
-      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #   @param idempotency_key [String, nil]
+      #     The idempotency key you chose for this object. This value is unique across
+      #     Increase and is used to ensure that a request is only processed once. Learn more
+      #     about [idempotency](https://increase.com/documentation/idempotency-keys).
       #
-      #   @param status [Symbol, Increase::Models::WireDrawdownRequest::Status] The lifecycle status of the drawdown request.
+      #   @param status [Symbol, Increase::Models::WireDrawdownRequest::Status]
+      #     The lifecycle status of the drawdown request.
       #
-      #   @param submission [Increase::Models::WireDrawdownRequest::Submission, nil] After the drawdown request is submitted to Fedwire, this will contain supplement
+      #   @param submission [Increase::Models::WireDrawdownRequest::Submission, nil]
+      #     After the drawdown request is submitted to Fedwire, this will contain
+      #     supplemental details.
       #
-      #   @param type [Symbol, Increase::Models::WireDrawdownRequest::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::WireDrawdownRequest::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `wire_drawdown_request`.
       #
-      #   @param unique_end_to_end_transaction_reference [String, nil] The unique end-to-end transaction reference ([UETR](https://www.swift.com/paymen
+      #   @param unique_end_to_end_transaction_reference [String, nil]
+      #     The unique end-to-end transaction reference
+      #     ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
+      #     of the drawdown request.
       #
-      #   @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the drawdown request.
+      #   @param unstructured_remittance_information [String]
+      #     Remittance information the debtor will see as part of the drawdown request.
 
       # @see Increase::Models::WireDrawdownRequest#creditor_address
       class CreditorAddress < Increase::Internal::Type::BaseModel
@@ -227,14 +246,14 @@ module Increase
         required :state, String, nil?: true
 
         # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::WireDrawdownRequest::CreditorAddress} for more details.
-        #
         #   The creditor's address.
         #
         #   @param city [String] The city, district, town, or village of the address.
         #
-        #   @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
+        #   @param country [String]
+        #     The two-letter
+        #     [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
+        #     the country of the address.
         #
         #   @param line1 [String] The first line of the address.
         #
@@ -286,14 +305,14 @@ module Increase
         required :state, String, nil?: true
 
         # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::WireDrawdownRequest::DebtorAddress} for more details.
-        #
         #   The debtor's address.
         #
         #   @param city [String] The city, district, town, or village of the address.
         #
-        #   @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
+        #   @param country [String]
+        #     The two-letter
+        #     [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
+        #     the country of the address.
         #
         #   @param line1 [String] The first line of the address.
         #
@@ -336,13 +355,12 @@ module Increase
         required :input_message_accountability_data, String
 
         # @!method initialize(input_message_accountability_data:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::WireDrawdownRequest::Submission} for more details.
-        #
         #   After the drawdown request is submitted to Fedwire, this will contain
         #   supplemental details.
         #
-        #   @param input_message_accountability_data [String] The input message accountability data (IMAD) uniquely identifying the submission
+        #   @param input_message_accountability_data [String]
+        #     The input message accountability data (IMAD) uniquely identifying the submission
+        #     with Fedwire.
       end
 
       # A constant representing the object's type. For this resource it will always be

data/lib/increase/models/wire_drawdown_request_create_params.rb

@@ -83,32 +83,38 @@ module Increase
       optional :end_to_end_identification, String
 
       # @!method initialize(account_number_id:, amount:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, unstructured_remittance_information:, charge_bearer: nil, debtor_account_number: nil, debtor_external_account_id: nil, debtor_routing_number: nil, end_to_end_identification: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::WireDrawdownRequestCreateParams} for more details.
-      #
       #   @param account_number_id [String] The Account Number to which the debtor should send funds.
       #
       #   @param amount [Integer] The amount requested from the debtor, in USD cents.
       #
-      #   @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress] The creditor's address.
+      #   @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress]
+      #     The creditor's address.
       #
       #   @param creditor_name [String] The creditor's name.
       #
-      #   @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress] The debtor's address.
+      #   @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress]
+      #     The debtor's address.
       #
       #   @param debtor_name [String] The debtor's name.
       #
-      #   @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the request.
+      #   @param unstructured_remittance_information [String]
+      #     Remittance information the debtor will see as part of the request.
       #
-      #   @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer] Determines who bears the cost of the drawdown request. Defaults to `shared` if n
+      #   @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer]
+      #     Determines who bears the cost of the drawdown request. Defaults to `shared` if
+      #     not specified.
       #
       #   @param debtor_account_number [String] The debtor's account number.
       #
-      #   @param debtor_external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
+      #   @param debtor_external_account_id [String]
+      #     The ID of an External Account to initiate a transfer to. If this parameter is
+      #     provided, `debtor_account_number` and `debtor_routing_number` must be absent.
       #
       #   @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 mirrored back in the subsequent w
+      #   @param end_to_end_identification [String]
+      #     A free-form reference string set by the sender mirrored back in the subsequent
+      #     wire transfer.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -152,15 +158,14 @@ module Increase
         optional :state, String
 
         # @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress} for more
-        #   details.
-        #
         #   The creditor's address.
         #
         #   @param city [String] The city, district, town, or village of the address.
         #
-        #   @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
+        #   @param country [String]
+        #     The two-letter
+        #     [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
+        #     the country of the address.
         #
         #   @param line1 [String] The first line of the address. This is usually the street number and street.
         #
@@ -211,15 +216,14 @@ module Increase
         optional :state, String
 
         # @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress} for more
-        #   details.
-        #
         #   The debtor's address.
         #
         #   @param city [String] The city, district, town, or village of the address.
         #
-        #   @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
+        #   @param country [String]
+        #     The two-letter
+        #     [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
+        #     the country of the address.
         #
         #   @param line1 [String] The first line of the address. This is usually the street number and street.
         #

data/lib/increase/models/wire_drawdown_request_list_params.rb

@@ -35,14 +35,17 @@ module Increase
       optional :status, -> { Increase::WireDrawdownRequestListParams::Status }
 
       # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::WireDrawdownRequestListParams} for more details.
-      #
       #   @param cursor [String] Return the page of entries after this one.
       #
-      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #   @param idempotency_key [String]
+      #     Filter records to the one with the specified `idempotency_key` you chose for
+      #     that object. This value is unique across Increase and is used to ensure that a
+      #     request is only processed once. Learn more about
+      #     [idempotency](https://increase.com/documentation/idempotency-keys).
       #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #   @param limit [Integer]
+      #     Limit the size of the list that is returned. The default (and maximum) is 100
+      #     objects.
       #
       #   @param status [Increase::Models::WireDrawdownRequestListParams::Status]
       #
@@ -62,10 +65,10 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::WireDrawdownRequestListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::WireDrawdownRequestListParams::Status::In>] Filter Wire Drawdown Requests for those with the specified status. For GET reque
+        #   @param in_ [Array<Symbol, Increase::Models::WireDrawdownRequestListParams::Status::In>]
+        #     Filter Wire Drawdown Requests for those with the specified status. For GET
+        #     requests, this should be encoded as a comma-delimited string, such as
+        #     `?in=one,two,three`.
 
         module In
           extend Increase::Internal::Type::Enum