increase 1.340.0 → 1.342.0

data/rbi/increase/models/transaction.rbi

@@ -1970,6 +1970,15 @@ module Increase
               )
             end
 
+          # Additional free-form information included by the receiving bank in the return's
+          # addenda record. This is raw, uninterpreted text whose presence and format are
+          # not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
+          # bank may set this to `QUESTIONABLE` (optionally followed by more text) to
+          # indicate it believes the transfer was initiated under questionable
+          # circumstances.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :addenda_information
+
           # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
           # the transfer was created.
           sig { returns(Time) }
@@ -2013,6 +2022,7 @@ module Increase
           # created.
           sig do
             params(
+              addenda_information: T.nilable(String),
               created_at: Time,
               raw_return_reason_code: String,
               return_reason_code:
@@ -2023,6 +2033,13 @@ module Increase
             ).returns(T.attached_class)
           end
           def self.new(
+            # Additional free-form information included by the receiving bank in the return's
+            # addenda record. This is raw, uninterpreted text whose presence and format are
+            # not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
+            # bank may set this to `QUESTIONABLE` (optionally followed by more text) to
+            # indicate it believes the transfer was initiated under questionable
+            # circumstances.
+            addenda_information:,
             # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
             # the transfer was created.
             created_at:,
@@ -2047,6 +2064,7 @@ module Increase
           sig do
             override.returns(
               {
+                addenda_information: T.nilable(String),
                 created_at: Time,
                 raw_return_reason_code: String,
                 return_reason_code:
@@ -2186,7 +2204,7 @@ module Increase
                 Increase::Transaction::Source::ACHTransferReturn::ReturnReasonCode::TaggedSymbol
               )
 
-            # Code R17. The receiving bank is unable to process a field in the transfer.
+            # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
             FILE_RECORD_EDIT_CRITERIA =
               T.let(
                 :file_record_edit_criteria,

data/rbi/increase/models/unwrap_webhook_event.rbi

@@ -517,6 +517,20 @@ module Increase
             Increase::UnwrapWebhookEvent::Category::TaggedSymbol
           )
 
+        # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
+        INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
+          T.let(
+            :"inbound_real_time_payments_request_for_payment.created",
+            Increase::UnwrapWebhookEvent::Category::TaggedSymbol
+          )
+
+        # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
+        INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
+          T.let(
+            :"inbound_real_time_payments_request_for_payment.updated",
+            Increase::UnwrapWebhookEvent::Category::TaggedSymbol
+          )
+
         # Occurs whenever an Inbound Real-Time Payments Transfer is created.
         INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED =
           T.let(

data/rbi/increase/resources/entities.rbi

@@ -137,6 +137,8 @@ module Increase
           idempotency_key: String,
           limit: Integer,
           status: Increase::EntityListParams::Status::OrHash,
+          validation_status:
+            Increase::EntityListParams::ValidationStatus::OrHash,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::Internal::Page[Increase::Entity])
       end
@@ -153,6 +155,7 @@ module Increase
         # objects.
         limit: nil,
         status: nil,
+        validation_status: nil,
         request_options: {}
       )
       end

data/rbi/increase/resources/pending_transactions.rbi

@@ -20,8 +20,8 @@ module Increase
         # The Account to place the hold on.
         account_id:,
         # The amount to hold in the minor unit of the account's currency. For dollars, for
-        # example, this is cents. This should be a negative amount - to hold $1.00 from
-        # the account, you would pass -100.
+        # example, this is cents. This should be a negative amount: To hold $1.00 from the
+        # account, pass -100 as `amount`.
         amount:,
         # The description you choose to give the hold.
         description: nil,

data/rbi/increase/resources/simulations/ach_transfers.rbi

@@ -58,6 +58,7 @@ module Increase
         sig do
           params(
             ach_transfer_id: String,
+            addenda_information: String,
             reason:
               Increase::Simulations::ACHTransferReturnParams::Reason::OrSymbol,
             request_options: Increase::RequestOptions::OrHash
@@ -66,6 +67,10 @@ module Increase
         def return_(
           # The identifier of the ACH Transfer you wish to return.
           ach_transfer_id,
+          # Free-form information the returning bank includes in the return addenda. For a
+          # `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
+          # a return the bank believes was initiated under questionable circumstances.
+          addenda_information: nil,
           # The reason why the Federal Reserve or destination bank returned this transfer.
           # Defaults to `no_account`.
           reason: nil,

data/rbi/increase/resources/simulations/card_settlements.rbi

@@ -12,20 +12,21 @@ module Increase
         sig do
           params(
             card_id: String,
-            pending_transaction_id: String,
             amount: Integer,
+            pending_transaction_id: String,
             request_options: Increase::RequestOptions::OrHash
           ).returns(Increase::Transaction)
         end
         def create(
           # The identifier of the Card to create a settlement on.
           card_id:,
-          # The identifier of the Pending Transaction for the Card Authorization you wish to
-          # settle.
-          pending_transaction_id:,
           # The amount to be settled. This defaults to the amount of the Pending Transaction
-          # being settled.
+          # being settled, or a random amount if `pending_transaction_id` is not provided.
           amount: nil,
+          # 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.
+          pending_transaction_id: nil,
           request_options: {}
         )
         end

data/rbi/increase/resources/swift_transfers.rbi

@@ -20,6 +20,7 @@ module Increase
             Increase::SwiftTransferCreateParams::InstructedCurrency::OrSymbol,
           source_account_number_id: String,
           unstructured_remittance_information: String,
+          intermediary_bank_identification_code: String,
           require_approval: T::Boolean,
           routing_number: String,
           request_options: Increase::RequestOptions::OrHash
@@ -51,6 +52,9 @@ module Increase
         source_account_number_id:,
         # Unstructured remittance information to include in the transfer.
         unstructured_remittance_information:,
+        # The bank identification code (BIC) of the intermediary bank, if the transfer
+        # should be routed through one.
+        intermediary_bank_identification_code: nil,
         # Whether the transfer requires explicit approval via the dashboard or API.
         require_approval: nil,
         # The creditor's bank account routing or transit number. Required in certain

data/sig/increase/models/ach_prenotification.rbs

@@ -416,7 +416,7 @@ module Increase
           # Code R13. The routing number is invalid.
           INVALID_ACH_ROUTING_NUMBER: :invalid_ach_routing_number
 
-          # Code R17. The receiving bank is unable to process a field in the transfer.
+          # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
           FILE_RECORD_EDIT_CRITERIA: :file_record_edit_criteria
 
           # Code R45. A rare return reason. The individual name field was invalid.

data/sig/increase/models/ach_transfer.rbs

@@ -743,6 +743,7 @@ module Increase
 
       type return_ =
         {
+          addenda_information: String?,
           created_at: Time,
           raw_return_reason_code: String,
           return_reason_code: Increase::Models::ACHTransfer::Return::return_reason_code,
@@ -752,6 +753,8 @@ module Increase
         }
 
       class Return < Increase::Internal::Type::BaseModel
+        attr_accessor addenda_information: String?
+
         attr_accessor created_at: Time
 
         attr_accessor raw_return_reason_code: String
@@ -765,6 +768,7 @@ module Increase
         attr_accessor transfer_id: String
 
         def initialize: (
+          addenda_information: String?,
           created_at: Time,
           raw_return_reason_code: String,
           return_reason_code: Increase::Models::ACHTransfer::Return::return_reason_code,
@@ -774,6 +778,7 @@ module Increase
         ) -> void
 
         def to_hash: -> {
+          addenda_information: String?,
           created_at: Time,
           raw_return_reason_code: String,
           return_reason_code: Increase::Models::ACHTransfer::Return::return_reason_code,
@@ -905,7 +910,7 @@ module Increase
           # Code R13. The routing number is invalid.
           INVALID_ACH_ROUTING_NUMBER: :invalid_ach_routing_number
 
-          # Code R17. The receiving bank is unable to process a field in the transfer.
+          # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
           FILE_RECORD_EDIT_CRITERIA: :file_record_edit_criteria
 
           # Code R45. A rare return reason. The individual name field was invalid.

data/sig/increase/models/beneficial_owner_create_params.rbs

@@ -80,8 +80,8 @@ module Increase
         type address =
           {
             city: String,
-            country: String,
             :line1 => String,
+            country: String,
             :line2 => String,
             state: String,
             zip: String
@@ -90,10 +90,12 @@ module Increase
         class Address < Increase::Internal::Type::BaseModel
           attr_accessor city: String
 
-          attr_accessor country: String
-
           attr_accessor line1: String
 
+          attr_reader country: String?
+
+          def country=: (String) -> String
+
           attr_reader line2: String?
 
           def line2=: (String) -> String
@@ -108,8 +110,8 @@ module Increase
 
           def initialize: (
             city: String,
-            country: String,
             line1: String,
+            ?country: String,
             ?line2: String,
             ?state: String,
             ?zip: String
@@ -117,8 +119,8 @@ module Increase
 
           def to_hash: -> {
             city: String,
-            country: String,
             :line1 => String,
+            country: String,
             :line2 => String,
             state: String,
             zip: String

data/sig/increase/models/beneficial_owner_update_params.rbs

@@ -66,8 +66,8 @@ module Increase
       type address =
         {
           city: String,
-          country: String,
           :line1 => String,
+          country: String,
           :line2 => String,
           state: String,
           zip: String
@@ -76,10 +76,12 @@ module Increase
       class Address < Increase::Internal::Type::BaseModel
         attr_accessor city: String
 
-        attr_accessor country: String
-
         attr_accessor line1: String
 
+        attr_reader country: String?
+
+        def country=: (String) -> String
+
         attr_reader line2: String?
 
         def line2=: (String) -> String
@@ -94,8 +96,8 @@ module Increase
 
         def initialize: (
           city: String,
-          country: String,
           line1: String,
+          ?country: String,
           ?line2: String,
           ?state: String,
           ?zip: String
@@ -103,8 +105,8 @@ module Increase
 
         def to_hash: -> {
           city: String,
-          country: String,
           :line1 => String,
+          country: String,
           :line2 => String,
           state: String,
           zip: String

data/sig/increase/models/check_transfer.rbs

@@ -298,6 +298,7 @@ module Increase
           payer: ::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
           recipient_name: String,
           return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?,
+          return_address_name: String?,
           shipping_method: Increase::Models::CheckTransfer::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransfer::PhysicalCheck::Signature,
           tracking_updates: ::Array[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
@@ -320,6 +321,8 @@ module Increase
 
         attr_accessor return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?
 
+        attr_accessor return_address_name: String?
+
         attr_accessor shipping_method: Increase::Models::CheckTransfer::PhysicalCheck::shipping_method
 
         attr_accessor signature: Increase::CheckTransfer::PhysicalCheck::Signature
@@ -335,6 +338,7 @@ module Increase
           payer: ::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
           recipient_name: String,
           return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?,
+          return_address_name: String?,
           shipping_method: Increase::Models::CheckTransfer::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransfer::PhysicalCheck::Signature,
           tracking_updates: ::Array[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
@@ -349,6 +353,7 @@ module Increase
           payer: ::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
           recipient_name: String,
           return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?,
+          return_address_name: String?,
           shipping_method: Increase::Models::CheckTransfer::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransfer::PhysicalCheck::Signature,
           tracking_updates: ::Array[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]

data/sig/increase/models/check_transfer_create_params.rbs

@@ -117,12 +117,13 @@ module Increase
         {
           mailing_address: Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress,
           memo: String,
+          payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
           recipient_name: String,
           attachment_file_id: String,
           check_voucher_image_file_id: String,
           note: String,
-          payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
           return_address: Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
+          return_address_name: String,
           shipping_method: Increase::Models::CheckTransferCreateParams::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransferCreateParams::PhysicalCheck::Signature
         }
@@ -132,6 +133,8 @@ module Increase
 
         attr_accessor memo: String
 
+        attr_accessor payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer]
+
         attr_accessor recipient_name: String
 
         attr_reader attachment_file_id: String?
@@ -146,18 +149,16 @@ module Increase
 
         def note=: (String) -> String
 
-        attr_reader payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer]?
-
-        def payer=: (
-          ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer]
-        ) -> ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer]
-
         attr_reader return_address: Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress?
 
         def return_address=: (
           Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress
         ) -> Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress
 
+        attr_reader return_address_name: String?
+
+        def return_address_name=: (String) -> String
+
         attr_reader shipping_method: Increase::Models::CheckTransferCreateParams::PhysicalCheck::shipping_method?
 
         def shipping_method=: (
@@ -173,12 +174,13 @@ module Increase
         def initialize: (
           mailing_address: Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress,
           memo: String,
+          payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
           recipient_name: String,
           ?attachment_file_id: String,
           ?check_voucher_image_file_id: String,
           ?note: String,
-          ?payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
           ?return_address: Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
+          ?return_address_name: String,
           ?shipping_method: Increase::Models::CheckTransferCreateParams::PhysicalCheck::shipping_method,
           ?signature: Increase::CheckTransferCreateParams::PhysicalCheck::Signature
         ) -> void
@@ -186,12 +188,13 @@ module Increase
         def to_hash: -> {
           mailing_address: Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress,
           memo: String,
+          payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
           recipient_name: String,
           attachment_file_id: String,
           check_voucher_image_file_id: String,
           note: String,
-          payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
           return_address: Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
+          return_address_name: String,
           shipping_method: Increase::Models::CheckTransferCreateParams::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransferCreateParams::PhysicalCheck::Signature
         }

data/sig/increase/models/entity_create_params.rbs

@@ -205,8 +205,8 @@ module Increase
         type address =
           {
             city: String,
-            country: String,
             :line1 => String,
+            country: String,
             :line2 => String,
             state: String,
             zip: String
@@ -215,10 +215,12 @@ module Increase
         class Address < Increase::Internal::Type::BaseModel
           attr_accessor city: String
 
-          attr_accessor country: String
-
           attr_accessor line1: String
 
+          attr_reader country: String?
+
+          def country=: (String) -> String
+
           attr_reader line2: String?
 
           def line2=: (String) -> String
@@ -233,8 +235,8 @@ module Increase
 
           def initialize: (
             city: String,
-            country: String,
             line1: String,
+            ?country: String,
             ?line2: String,
             ?state: String,
             ?zip: String
@@ -242,8 +244,8 @@ module Increase
 
           def to_hash: -> {
             city: String,
-            country: String,
             :line1 => String,
+            country: String,
             :line2 => String,
             state: String,
             zip: String
@@ -319,8 +321,8 @@ module Increase
             type address =
               {
                 city: String,
-                country: String,
                 :line1 => String,
+                country: String,
                 :line2 => String,
                 state: String,
                 zip: String
@@ -329,10 +331,12 @@ module Increase
             class Address < Increase::Internal::Type::BaseModel
               attr_accessor city: String
 
-              attr_accessor country: String
-
               attr_accessor line1: String
 
+              attr_reader country: String?
+
+              def country=: (String) -> String
+
               attr_reader line2: String?
 
               def line2=: (String) -> String
@@ -347,8 +351,8 @@ module Increase
 
               def initialize: (
                 city: String,
-                country: String,
                 line1: String,
+                ?country: String,
                 ?line2: String,
                 ?state: String,
                 ?zip: String
@@ -356,8 +360,8 @@ module Increase
 
               def to_hash: -> {
                 city: String,
-                country: String,
                 :line1 => String,
+                country: String,
                 :line2 => String,
                 state: String,
                 zip: String
@@ -791,8 +795,8 @@ module Increase
           type address =
             {
               city: String,
-              country: String,
               :line1 => String,
+              country: String,
               :line2 => String,
               state: String,
               zip: String
@@ -801,10 +805,12 @@ module Increase
           class Address < Increase::Internal::Type::BaseModel
             attr_accessor city: String
 
-            attr_accessor country: String
-
             attr_accessor line1: String
 
+            attr_reader country: String?
+
+            def country=: (String) -> String
+
             attr_reader line2: String?
 
             def line2=: (String) -> String
@@ -819,8 +825,8 @@ module Increase
 
             def initialize: (
               city: String,
-              country: String,
               line1: String,
+              ?country: String,
               ?line2: String,
               ?state: String,
               ?zip: String
@@ -828,8 +834,8 @@ module Increase
 
             def to_hash: -> {
               city: String,
-              country: String,
               :line1 => String,
+              country: String,
               :line2 => String,
               state: String,
               zip: String
@@ -1054,8 +1060,8 @@ module Increase
         type address =
           {
             city: String,
-            country: String,
             :line1 => String,
+            country: String,
             :line2 => String,
             state: String,
             zip: String
@@ -1064,10 +1070,12 @@ module Increase
         class Address < Increase::Internal::Type::BaseModel
           attr_accessor city: String
 
-          attr_accessor country: String
-
           attr_accessor line1: String
 
+          attr_reader country: String?
+
+          def country=: (String) -> String
+
           attr_reader line2: String?
 
           def line2=: (String) -> String
@@ -1082,8 +1090,8 @@ module Increase
 
           def initialize: (
             city: String,
-            country: String,
             line1: String,
+            ?country: String,
             ?line2: String,
             ?state: String,
             ?zip: String
@@ -1091,8 +1099,8 @@ module Increase
 
           def to_hash: -> {
             city: String,
-            country: String,
             :line1 => String,
+            country: String,
             :line2 => String,
             state: String,
             zip: String
@@ -1583,8 +1591,8 @@ module Increase
             type address =
               {
                 city: String,
-                country: String,
                 :line1 => String,
+                country: String,
                 :line2 => String,
                 state: String,
                 zip: String
@@ -1593,10 +1601,12 @@ module Increase
             class Address < Increase::Internal::Type::BaseModel
               attr_accessor city: String
 
-              attr_accessor country: String
-
               attr_accessor line1: String
 
+              attr_reader country: String?
+
+              def country=: (String) -> String
+
               attr_reader line2: String?
 
               def line2=: (String) -> String
@@ -1611,8 +1621,8 @@ module Increase
 
               def initialize: (
                 city: String,
-                country: String,
                 line1: String,
+                ?country: String,
                 ?line2: String,
                 ?state: String,
                 ?zip: String
@@ -1620,8 +1630,8 @@ module Increase
 
               def to_hash: -> {
                 city: String,
-                country: String,
                 :line1 => String,
+                country: String,
                 :line2 => String,
                 state: String,
                 zip: String
@@ -1846,8 +1856,8 @@ module Increase
           type address =
             {
               city: String,
-              country: String,
               :line1 => String,
+              country: String,
               :line2 => String,
               state: String,
               zip: String
@@ -1856,10 +1866,12 @@ module Increase
           class Address < Increase::Internal::Type::BaseModel
             attr_accessor city: String
 
-            attr_accessor country: String
-
             attr_accessor line1: String
 
+            attr_reader country: String?
+
+            def country=: (String) -> String
+
             attr_reader line2: String?
 
             def line2=: (String) -> String
@@ -1874,8 +1886,8 @@ module Increase
 
             def initialize: (
               city: String,
-              country: String,
               line1: String,
+              ?country: String,
               ?line2: String,
               ?state: String,
               ?zip: String
@@ -1883,8 +1895,8 @@ module Increase
 
             def to_hash: -> {
               city: String,
-              country: String,
               :line1 => String,
+              country: String,
               :line2 => String,
               state: String,
               zip: String