increase 1.341.0 → 1.342.0

data/rbi/increase/models/entity_create_params.rbi

@@ -477,14 +477,18 @@ module Increase
           sig { returns(String) }
           attr_accessor :city
 
-          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-          sig { returns(String) }
-          attr_accessor :country
-
           # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
           attr_accessor :line1
 
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+          # to `US`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :country
+
+          sig { params(country: String).void }
+          attr_writer :country
+
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
           attr_reader :line2
@@ -512,8 +516,8 @@ module Increase
           sig do
             params(
               city: String,
-              country: String,
               line1: String,
+              country: String,
               line2: String,
               state: String,
               zip: String
@@ -522,10 +526,11 @@ module Increase
           def self.new(
             # The city, district, town, or village of the address.
             city:,
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            country: nil,
             # The second line of the address. This might be the floor or room number.
             line2: nil,
             # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -540,8 +545,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -754,14 +759,18 @@ module Increase
               sig { returns(String) }
               attr_accessor :city
 
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              sig { returns(String) }
-              attr_accessor :country
-
               # The first line of the address. This is usually the street number and street.
               sig { returns(String) }
               attr_accessor :line1
 
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              sig { returns(T.nilable(String)) }
+              attr_reader :country
+
+              sig { params(country: String).void }
+              attr_writer :country
+
               # The second line of the address. This might be the floor or room number.
               sig { returns(T.nilable(String)) }
               attr_reader :line2
@@ -789,8 +798,8 @@ module Increase
               sig do
                 params(
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -799,10 +808,11 @@ module Increase
               def self.new(
                 # The city, district, town, or village of the address.
                 city:,
-                # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-                country:,
                 # The first line of the address. This is usually the street number and street.
                 line1:,
+                # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+                # to `US`.
+                country: nil,
                 # The second line of the address. This might be the floor or room number.
                 line2: nil,
                 # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -817,8 +827,8 @@ module Increase
                 override.returns(
                   {
                     city: String,
-                    country: String,
                     line1: String,
+                    country: String,
                     line2: String,
                     state: String,
                     zip: String
@@ -1844,14 +1854,18 @@ module Increase
             sig { returns(String) }
             attr_accessor :city
 
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            sig { returns(String) }
-            attr_accessor :country
-
             # The first line of the address. This is usually the street number and street.
             sig { returns(String) }
             attr_accessor :line1
 
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            sig { returns(T.nilable(String)) }
+            attr_reader :country
+
+            sig { params(country: String).void }
+            attr_writer :country
+
             # The second line of the address. This might be the floor or room number.
             sig { returns(T.nilable(String)) }
             attr_reader :line2
@@ -1879,8 +1893,8 @@ module Increase
             sig do
               params(
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -1889,10 +1903,11 @@ module Increase
             def self.new(
               # The city, district, town, or village of the address.
               city:,
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              country:,
               # The first line of the address. This is usually the street number and street.
               line1:,
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              country: nil,
               # The second line of the address. This might be the floor or room number.
               line2: nil,
               # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -1907,8 +1922,8 @@ module Increase
               override.returns(
                 {
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -2425,14 +2440,18 @@ module Increase
           sig { returns(String) }
           attr_accessor :city
 
-          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-          sig { returns(String) }
-          attr_accessor :country
-
           # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
           attr_accessor :line1
 
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+          # to `US`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :country
+
+          sig { params(country: String).void }
+          attr_writer :country
+
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
           attr_reader :line2
@@ -2460,8 +2479,8 @@ module Increase
           sig do
             params(
               city: String,
-              country: String,
               line1: String,
+              country: String,
               line2: String,
               state: String,
               zip: String
@@ -2470,10 +2489,11 @@ module Increase
           def self.new(
             # The city, district, town, or village of the address.
             city:,
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            country: nil,
             # The second line of the address. This might be the floor or room number.
             line2: nil,
             # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -2488,8 +2508,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -3618,14 +3638,18 @@ module Increase
               sig { returns(String) }
               attr_accessor :city
 
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              sig { returns(String) }
-              attr_accessor :country
-
               # The first line of the address. This is usually the street number and street.
               sig { returns(String) }
               attr_accessor :line1
 
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              sig { returns(T.nilable(String)) }
+              attr_reader :country
+
+              sig { params(country: String).void }
+              attr_writer :country
+
               # The second line of the address. This might be the floor or room number.
               sig { returns(T.nilable(String)) }
               attr_reader :line2
@@ -3653,8 +3677,8 @@ module Increase
               sig do
                 params(
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -3663,10 +3687,11 @@ module Increase
               def self.new(
                 # The city, district, town, or village of the address.
                 city:,
-                # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-                country:,
                 # The first line of the address. This is usually the street number and street.
                 line1:,
+                # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+                # to `US`.
+                country: nil,
                 # The second line of the address. This might be the floor or room number.
                 line2: nil,
                 # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -3681,8 +3706,8 @@ module Increase
                 override.returns(
                   {
                     city: String,
-                    country: String,
                     line1: String,
+                    country: String,
                     line2: String,
                     state: String,
                     zip: String
@@ -4198,14 +4223,18 @@ module Increase
             sig { returns(String) }
             attr_accessor :city
 
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            sig { returns(String) }
-            attr_accessor :country
-
             # The first line of the address. This is usually the street number and street.
             sig { returns(String) }
             attr_accessor :line1
 
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            sig { returns(T.nilable(String)) }
+            attr_reader :country
+
+            sig { params(country: String).void }
+            attr_writer :country
+
             # The second line of the address. This might be the floor or room number.
             sig { returns(T.nilable(String)) }
             attr_reader :line2
@@ -4233,8 +4262,8 @@ module Increase
             sig do
               params(
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -4243,10 +4272,11 @@ module Increase
             def self.new(
               # The city, district, town, or village of the address.
               city:,
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              country:,
               # The first line of the address. This is usually the street number and street.
               line1:,
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              country: nil,
               # The second line of the address. This might be the floor or room number.
               line2: nil,
               # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -4261,8 +4291,8 @@ module Increase
               override.returns(
                 {
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String

data/rbi/increase/models/entity_update_params.rbi

@@ -341,14 +341,18 @@ module Increase
           sig { returns(String) }
           attr_accessor :city
 
-          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-          sig { returns(String) }
-          attr_accessor :country
-
           # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
           attr_accessor :line1
 
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+          # to `US`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :country
+
+          sig { params(country: String).void }
+          attr_writer :country
+
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
           attr_reader :line2
@@ -376,8 +380,8 @@ module Increase
           sig do
             params(
               city: String,
-              country: String,
               line1: String,
+              country: String,
               line2: String,
               state: String,
               zip: String
@@ -386,10 +390,11 @@ module Increase
           def self.new(
             # The city, district, town, or village of the address.
             city:,
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            country: nil,
             # The second line of the address. This might be the floor or room number.
             line2: nil,
             # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -404,8 +409,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -774,14 +779,18 @@ module Increase
           sig { returns(String) }
           attr_accessor :city
 
-          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-          sig { returns(String) }
-          attr_accessor :country
-
           # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
           attr_accessor :line1
 
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+          # to `US`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :country
+
+          sig { params(country: String).void }
+          attr_writer :country
+
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
           attr_reader :line2
@@ -809,8 +818,8 @@ module Increase
           sig do
             params(
               city: String,
-              country: String,
               line1: String,
+              country: String,
               line2: String,
               state: String,
               zip: String
@@ -819,10 +828,11 @@ module Increase
           def self.new(
             # The city, district, town, or village of the address.
             city:,
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            country: nil,
             # The second line of the address. This might be the floor or room number.
             line2: nil,
             # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -837,8 +847,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String

data/rbi/increase/models/event.rbi

@@ -481,6 +481,20 @@ module Increase
             Increase::Event::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::Event::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::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever an Inbound Real-Time Payments Transfer is created.
         INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED =
           T.let(

data/rbi/increase/models/event_list_params.rbi

@@ -580,6 +580,20 @@ module Increase
               Increase::EventListParams::Category::In::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::EventListParams::Category::In::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::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever an Inbound Real-Time Payments Transfer is created.
           INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED =
             T.let(

data/rbi/increase/models/event_subscription.rbi

@@ -605,6 +605,20 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::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::EventSubscription::SelectedEventCategory::EventCategory::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::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an Inbound Real-Time Payments Transfer is created.
           INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED =
             T.let(

data/rbi/increase/models/event_subscription_create_params.rbi

@@ -603,6 +603,20 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::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::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::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::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an Inbound Real-Time Payments Transfer is created.
           INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED =
             T.let(

data/rbi/increase/models/inbound_wire_transfer.rbi

@@ -57,6 +57,10 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :creditor_name
 
+      # The account number of the sender.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :debtor_account_number
+
       # A free-form address field set by the sender.
       sig { returns(T.nilable(String)) }
       attr_accessor :debtor_address_line1
@@ -73,6 +77,10 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :debtor_name
 
+      # The American Banking Association (ABA) routing number of the sender.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :debtor_routing_number
+
       # An Increase-constructed description of the transfer.
       sig { returns(String) }
       attr_accessor :description
@@ -149,10 +157,12 @@ module Increase
           creditor_address_line2: T.nilable(String),
           creditor_address_line3: T.nilable(String),
           creditor_name: T.nilable(String),
+          debtor_account_number: T.nilable(String),
           debtor_address_line1: T.nilable(String),
           debtor_address_line2: T.nilable(String),
           debtor_address_line3: T.nilable(String),
           debtor_name: T.nilable(String),
+          debtor_routing_number: T.nilable(String),
           description: String,
           end_to_end_identification: T.nilable(String),
           input_message_accountability_data: T.nilable(String),
@@ -189,6 +199,8 @@ module Increase
         creditor_address_line3:,
         # A name set by the sender.
         creditor_name:,
+        # The account number of the sender.
+        debtor_account_number:,
         # A free-form address field set by the sender.
         debtor_address_line1:,
         # A free-form address field set by the sender.
@@ -197,6 +209,8 @@ module Increase
         debtor_address_line3:,
         # A name set by the sender.
         debtor_name:,
+        # The American Banking Association (ABA) routing number of the sender.
+        debtor_routing_number:,
         # An Increase-constructed description of the transfer.
         description:,
         # A free-form reference string set by the sender, to help identify the transfer.
@@ -243,10 +257,12 @@ module Increase
             creditor_address_line2: T.nilable(String),
             creditor_address_line3: T.nilable(String),
             creditor_name: T.nilable(String),
+            debtor_account_number: T.nilable(String),
             debtor_address_line1: T.nilable(String),
             debtor_address_line2: T.nilable(String),
             debtor_address_line3: T.nilable(String),
             debtor_name: T.nilable(String),
+            debtor_routing_number: T.nilable(String),
             description: String,
             end_to_end_identification: T.nilable(String),
             input_message_accountability_data: T.nilable(String),

data/rbi/increase/models/simulations/ach_transfer_return_params.rbi

@@ -19,6 +19,15 @@ module Increase
         sig { returns(String) }
         attr_accessor :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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :addenda_information
+
+        sig { params(addenda_information: String).void }
+        attr_writer :addenda_information
+
         # The reason why the Federal Reserve or destination bank returned this transfer.
         # Defaults to `no_account`.
         sig do
@@ -41,6 +50,7 @@ module Increase
         sig do
           params(
             ach_transfer_id: String,
+            addenda_information: String,
             reason:
               Increase::Simulations::ACHTransferReturnParams::Reason::OrSymbol,
             request_options: Increase::RequestOptions::OrHash
@@ -49,6 +59,10 @@ module Increase
         def self.new(
           # 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,
@@ -60,6 +74,7 @@ module Increase
           override.returns(
             {
               ach_transfer_id: String,
+              addenda_information: String,
               reason:
                 Increase::Simulations::ACHTransferReturnParams::Reason::OrSymbol,
               request_options: Increase::RequestOptions
@@ -195,7 +210,7 @@ module Increase
               Increase::Simulations::ACHTransferReturnParams::Reason::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,