increase 1.340.0 → 1.342.0

data/rbi/increase/models/entity_list_params.rbi

@@ -50,6 +50,17 @@ module Increase
       sig { params(status: Increase::EntityListParams::Status::OrHash).void }
       attr_writer :status
 
+      sig { returns(T.nilable(Increase::EntityListParams::ValidationStatus)) }
+      attr_reader :validation_status
+
+      sig do
+        params(
+          validation_status:
+            Increase::EntityListParams::ValidationStatus::OrHash
+        ).void
+      end
+      attr_writer :validation_status
+
       sig do
         params(
           created_at: Increase::EntityListParams::CreatedAt::OrHash,
@@ -57,6 +68,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(T.attached_class)
       end
@@ -73,6 +86,7 @@ module Increase
         # objects.
         limit: nil,
         status: nil,
+        validation_status: nil,
         request_options: {}
       )
       end
@@ -85,6 +99,7 @@ module Increase
             idempotency_key: String,
             limit: Integer,
             status: Increase::EntityListParams::Status,
+            validation_status: Increase::EntityListParams::ValidationStatus,
             request_options: Increase::RequestOptions
           }
         )
@@ -251,6 +266,110 @@ module Increase
           end
         end
       end
+
+      class ValidationStatus < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityListParams::ValidationStatus,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter Entities for those with the specified validation status. For GET
+        # requests, this should be encoded as a comma-delimited string, such as
+        # `?in=one,two,three`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Increase::EntityListParams::ValidationStatus::In::OrSymbol
+              ]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::EntityListParams::ValidationStatus::In::OrSymbol
+              ]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::EntityListParams::ValidationStatus::In::OrSymbol
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter Entities for those with the specified validation status. For GET
+          # requests, this should be encoded as a comma-delimited string, such as
+          # `?in=one,two,three`.
+          in_: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              in_:
+                T::Array[
+                  Increase::EntityListParams::ValidationStatus::In::OrSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::EntityListParams::ValidationStatus::In)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The submitted data is being validated.
+          PENDING =
+            T.let(
+              :pending,
+              Increase::EntityListParams::ValidationStatus::In::TaggedSymbol
+            )
+
+          # The submitted data is valid.
+          VALID =
+            T.let(
+              :valid,
+              Increase::EntityListParams::ValidationStatus::In::TaggedSymbol
+            )
+
+          # Additional information is required to validate the data.
+          INVALID =
+            T.let(
+              :invalid,
+              Increase::EntityListParams::ValidationStatus::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::EntityListParams::ValidationStatus::In::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

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/pending_transaction_create_params.rbi

@@ -19,8 +19,8 @@ module Increase
       attr_accessor :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`.
       sig { returns(Integer) }
       attr_accessor :amount
 
@@ -43,8 +43,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/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,

data/rbi/increase/models/simulations/card_settlement_create_params.rbi

@@ -19,36 +19,41 @@ module Increase
         sig { returns(String) }
         attr_accessor :card_id
 
-        # The identifier of the Pending Transaction for the Card Authorization you wish to
-        # settle.
-        sig { returns(String) }
-        attr_accessor :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.
         sig { returns(T.nilable(Integer)) }
         attr_reader :amount
 
         sig { params(amount: Integer).void }
         attr_writer :amount
 
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :pending_transaction_id
+
+        sig { params(pending_transaction_id: String).void }
+        attr_writer :pending_transaction_id
+
         sig do
           params(
             card_id: String,
-            pending_transaction_id: String,
             amount: Integer,
+            pending_transaction_id: String,
             request_options: Increase::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           # 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
@@ -57,8 +62,8 @@ module Increase
           override.returns(
             {
               card_id: String,
-              pending_transaction_id: String,
               amount: Integer,
+              pending_transaction_id: String,
               request_options: Increase::RequestOptions
             }
           )

data/rbi/increase/models/simulations/program_create_params.rbi

@@ -117,13 +117,6 @@ module Increase
               Increase::Simulations::ProgramCreateParams::Bank::TaggedSymbol
             )
 
-          # Twin City Bank
-          TWIN_CITY_BANK =
-            T.let(
-              :twin_city_bank,
-              Increase::Simulations::ProgramCreateParams::Bank::TaggedSymbol
-            )
-
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/swift_transfer.rbi

@@ -88,6 +88,11 @@ module Increase
       sig { returns(Increase::SwiftTransfer::InstructedCurrency::TaggedSymbol) }
       attr_accessor :instructed_currency
 
+      # The bank identification code (BIC) of the intermediary bank, if the transfer is
+      # routed through one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :intermediary_bank_identification_code
+
       # The ID for the pending transaction representing the transfer.
       sig { returns(T.nilable(String)) }
       attr_accessor :pending_transaction_id
@@ -143,6 +148,7 @@ module Increase
           instructed_amount: Integer,
           instructed_currency:
             Increase::SwiftTransfer::InstructedCurrency::OrSymbol,
+          intermediary_bank_identification_code: T.nilable(String),
           pending_transaction_id: T.nilable(String),
           routing_number: T.nilable(String),
           source_account_number_id: String,
@@ -187,6 +193,9 @@ module Increase
         # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
         # instructed amount.
         instructed_currency:,
+        # The bank identification code (BIC) of the intermediary bank, if the transfer is
+        # routed through one.
+        intermediary_bank_identification_code:,
         # The ID for the pending transaction representing the transfer.
         pending_transaction_id:,
         # The creditor's bank account routing or transit number. Required in certain
@@ -229,6 +238,7 @@ module Increase
             instructed_amount: Integer,
             instructed_currency:
               Increase::SwiftTransfer::InstructedCurrency::TaggedSymbol,
+            intermediary_bank_identification_code: T.nilable(String),
             pending_transaction_id: T.nilable(String),
             routing_number: T.nilable(String),
             source_account_number_id: String,

data/rbi/increase/models/swift_transfer_create_params.rbi

@@ -81,6 +81,14 @@ module Increase
       sig { returns(String) }
       attr_accessor :unstructured_remittance_information
 
+      # The bank identification code (BIC) of the intermediary bank, if the transfer
+      # should be routed through one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :intermediary_bank_identification_code
+
+      sig { params(intermediary_bank_identification_code: String).void }
+      attr_writer :intermediary_bank_identification_code
+
       # Whether the transfer requires explicit approval via the dashboard or API.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :require_approval
@@ -112,6 +120,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
@@ -143,6 +152,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
@@ -168,6 +180,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