increase 1.352.0 → 1.354.0

data/rbi/increase/models/check_transfer.rbi

@@ -96,8 +96,8 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :idempotency_key
 
-      # If the check has been mailed by Increase, this will contain details of the
-      # shipment.
+      # Once the check has been mailed, this will contain details about the shipment.
+      # Only available when `fulfillment_method` is equal to `physical_check`.
       sig { returns(T.nilable(Increase::CheckTransfer::Mailing)) }
       attr_reader :mailing
 
@@ -154,7 +154,9 @@ module Increase
       end
       attr_writer :stop_payment_request
 
-      # After the transfer is submitted, this will contain supplemental details.
+      # Once the check has been submitted to our printer, this will contain details
+      # about the submission. Only available when `fulfillment_method` is equal to
+      # `physical_check`.
       sig { returns(T.nilable(Increase::CheckTransfer::Submission)) }
       attr_reader :submission
 
@@ -263,8 +265,8 @@ module Increase
         # Increase and is used to ensure that a request is only processed once. Learn more
         # about [idempotency](https://increase.com/documentation/idempotency-keys).
         idempotency_key:,
-        # If the check has been mailed by Increase, this will contain details of the
-        # shipment.
+        # Once the check has been mailed, this will contain details about the shipment.
+        # Only available when `fulfillment_method` is equal to `physical_check`.
         mailing:,
         # The ID for the pending transaction representing the transfer. A pending
         # transaction is created when the transfer
@@ -284,7 +286,9 @@ module Increase
         # After a stop-payment is requested on the check, this will contain supplemental
         # details.
         stop_payment_request:,
-        # After the transfer is submitted, this will contain supplemental details.
+        # Once the check has been submitted to our printer, this will contain details
+        # about the submission. Only available when `fulfillment_method` is equal to
+        # `physical_check`.
         submission:,
         # Details relating to the custom fulfillment you will perform. Will be present if
         # and only if `fulfillment_method` is equal to `third_party`.
@@ -734,8 +738,8 @@ module Increase
         sig { returns(Time) }
         attr_accessor :mailed_at
 
-        # If the check has been mailed by Increase, this will contain details of the
-        # shipment.
+        # Once the check has been mailed, this will contain details about the shipment.
+        # Only available when `fulfillment_method` is equal to `physical_check`.
         sig { params(mailed_at: Time).returns(T.attached_class) }
         def self.new(
           # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -1629,7 +1633,9 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :tracking_number
 
-        # After the transfer is submitted, this will contain supplemental details.
+        # Once the check has been submitted to our printer, this will contain details
+        # about the submission. Only available when `fulfillment_method` is equal to
+        # `physical_check`.
         sig do
           params(
             preview_file_id: T.nilable(String),

data/rbi/increase/models/declined_transaction.rbi

@@ -2987,6 +2987,13 @@ module Increase
                 Increase::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason::TaggedSymbol
               )
 
+            # Additional customer authentication is required to complete the transaction, such as 3DS.
+            ADDITIONAL_CUSTOMER_AUTHENTICATION_REQUIRED =
+              T.let(
+                :additional_customer_authentication_required,
+                Increase::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason::TaggedSymbol
+              )
+
             # The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly.
             OTHER =
               T.let(

data/rbi/increase/models/digital_wallet_token.rbi

@@ -304,6 +304,27 @@ module Increase
               Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
             )
 
+          # The group was locked.
+          GROUP_LOCKED =
+            T.let(
+              :group_locked,
+              Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
+            )
+
+          # The account has been closed.
+          ACCOUNT_CLOSED =
+            T.let(
+              :account_closed,
+              Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
+            )
+
+          # The account's entity was not active.
+          ENTITY_NOT_ACTIVE =
+            T.let(
+              :entity_not_active,
+              Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[
@@ -535,6 +556,13 @@ module Increase
         DECLINED =
           T.let(:declined, Increase::DigitalWalletToken::Status::TaggedSymbol)
 
+        # The digital wallet token is transitioning to a new status and is awaiting confirmation from the card network.
+        PENDING_TRANSITIONING =
+          T.let(
+            :pending_transitioning,
+            Increase::DigitalWalletToken::Status::TaggedSymbol
+          )
+
         sig do
           override.returns(
             T::Array[Increase::DigitalWalletToken::Status::TaggedSymbol]
@@ -707,6 +735,13 @@ module Increase
               Increase::DigitalWalletToken::Update::Status::TaggedSymbol
             )
 
+          # The digital wallet token is transitioning to a new status and is awaiting confirmation from the card network.
+          PENDING_TRANSITIONING =
+            T.let(
+              :pending_transitioning,
+              Increase::DigitalWalletToken::Update::Status::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/entity.rbi

@@ -828,6 +828,13 @@ module Increase
                     Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
                   )
 
+                # The last four digits of a social security number. Not all programs can use this method.
+                SOCIAL_SECURITY_NUMBER_LAST4 =
+                  T.let(
+                    :social_security_number_last4,
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                  )
+
                 # An individual taxpayer identification number (ITIN).
                 INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
                   T.let(
@@ -1585,6 +1592,13 @@ module Increase
                   Increase::Entity::Joint::Individual::Identification::Method::TaggedSymbol
                 )
 
+              # The last four digits of a social security number. Not all programs can use this method.
+              SOCIAL_SECURITY_NUMBER_LAST4 =
+                T.let(
+                  :social_security_number_last4,
+                  Increase::Entity::Joint::Individual::Identification::Method::TaggedSymbol
+                )
+
               # An individual taxpayer identification number (ITIN).
               INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
                 T.let(
@@ -1852,6 +1866,13 @@ module Increase
                 Increase::Entity::NaturalPerson::Identification::Method::TaggedSymbol
               )
 
+            # The last four digits of a social security number. Not all programs can use this method.
+            SOCIAL_SECURITY_NUMBER_LAST4 =
+              T.let(
+                :social_security_number_last4,
+                Increase::Entity::NaturalPerson::Identification::Method::TaggedSymbol
+              )
+
             # An individual taxpayer identification number (ITIN).
             INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
               T.let(
@@ -2390,6 +2411,13 @@ module Increase
                   Increase::Entity::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
                 )
 
+              # The last four digits of a social security number. Not all programs can use this method.
+              SOCIAL_SECURITY_NUMBER_LAST4 =
+                T.let(
+                  :social_security_number_last4,
+                  Increase::Entity::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
+                )
+
               # An individual taxpayer identification number (ITIN).
               INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
                 T.let(
@@ -3086,6 +3114,13 @@ module Increase
                   Increase::Entity::Trust::Grantor::Identification::Method::TaggedSymbol
                 )
 
+              # The last four digits of a social security number. Not all programs can use this method.
+              SOCIAL_SECURITY_NUMBER_LAST4 =
+                T.let(
+                  :social_security_number_last4,
+                  Increase::Entity::Trust::Grantor::Identification::Method::TaggedSymbol
+                )
+
               # An individual taxpayer identification number (ITIN).
               INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
                 T.let(
@@ -3429,6 +3464,13 @@ module Increase
                     Increase::Entity::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
                   )
 
+                # The last four digits of a social security number. Not all programs can use this method.
+                SOCIAL_SECURITY_NUMBER_LAST4 =
+                  T.let(
+                    :social_security_number_last4,
+                    Increase::Entity::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
+                  )
+
                 # An individual taxpayer identification number (ITIN).
                 INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
                   T.let(
@@ -3607,6 +3649,26 @@ module Increase
           end
           attr_writer :beneficial_owner_identity
 
+          # Details when the issue is with a beneficial owner's tax identifier.
+          sig do
+            returns(
+              T.nilable(
+                Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier
+              )
+            )
+          end
+          attr_reader :beneficial_owner_tax_identifier
+
+          sig do
+            params(
+              beneficial_owner_tax_identifier:
+                T.nilable(
+                  Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier::OrHash
+                )
+            ).void
+          end
+          attr_writer :beneficial_owner_tax_identifier
+
           # The type of issue. We may add additional possible values for this enum over
           # time; your application should be able to handle such additions gracefully.
           sig do
@@ -3680,6 +3742,10 @@ module Increase
                 T.nilable(
                   Increase::Entity::Validation::Issue::BeneficialOwnerIdentity::OrHash
                 ),
+              beneficial_owner_tax_identifier:
+                T.nilable(
+                  Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier::OrHash
+                ),
               category: Increase::Entity::Validation::Issue::Category::OrSymbol,
               entity_address:
                 T.nilable(
@@ -3700,6 +3766,8 @@ module Increase
             beneficial_owner_address:,
             # Details when the issue is with a beneficial owner's identity verification.
             beneficial_owner_identity:,
+            # Details when the issue is with a beneficial owner's tax identifier.
+            beneficial_owner_tax_identifier:,
             # The type of issue. We may add additional possible values for this enum over
             # time; your application should be able to handle such additions gracefully.
             category:,
@@ -3723,6 +3791,10 @@ module Increase
                   T.nilable(
                     Increase::Entity::Validation::Issue::BeneficialOwnerIdentity
                   ),
+                beneficial_owner_tax_identifier:
+                  T.nilable(
+                    Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier
+                  ),
                 category:
                   Increase::Entity::Validation::Issue::Category::TaggedSymbol,
                 entity_address:
@@ -3850,6 +3922,34 @@ module Increase
             end
           end
 
+          class BeneficialOwnerTaxIdentifier < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # The ID of the beneficial owner.
+            sig { returns(String) }
+            attr_accessor :beneficial_owner_id
+
+            # Details when the issue is with a beneficial owner's tax identifier.
+            sig do
+              params(beneficial_owner_id: String).returns(T.attached_class)
+            end
+            def self.new(
+              # The ID of the beneficial owner.
+              beneficial_owner_id:
+            )
+            end
+
+            sig { override.returns({ beneficial_owner_id: String }) }
+            def to_hash
+            end
+          end
+
           # The type of issue. We may add additional possible values for this enum over
           # time; your application should be able to handle such additions gracefully.
           module Category
@@ -3896,6 +3996,13 @@ module Increase
                 Increase::Entity::Validation::Issue::Category::TaggedSymbol
               )
 
+            # A beneficial owner's full tax identifier is required. A non-US person can submit a passport or driver's license. Make changes via the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
+            BENEFICIAL_OWNER_TAX_IDENTIFIER =
+              T.let(
+                :beneficial_owner_tax_identifier,
+                Increase::Entity::Validation::Issue::Category::TaggedSymbol
+              )
+
             sig do
               override.returns(
                 T::Array[

data/rbi/increase/models/entity_beneficial_owner.rbi

@@ -351,6 +351,13 @@ module Increase
                 Increase::EntityBeneficialOwner::Individual::Identification::Method::TaggedSymbol
               )
 
+            # The last four digits of a social security number. Not all programs can use this method.
+            SOCIAL_SECURITY_NUMBER_LAST4 =
+              T.let(
+                :social_security_number_last4,
+                Increase::EntityBeneficialOwner::Individual::Identification::Method::TaggedSymbol
+              )
+
             # An individual taxpayer identification number (ITIN).
             INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
               T.let(

data/rbi/increase/models/entity_create_params.rbi

@@ -1025,6 +1025,13 @@ module Increase
                     Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
                   )
 
+                # The last four digits of a social security number. Not all programs can use this method.
+                SOCIAL_SECURITY_NUMBER_LAST4 =
+                  T.let(
+                    :social_security_number_last4,
+                    Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                  )
+
                 # An individual taxpayer identification number (ITIN).
                 INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
                   T.let(

data/rbi/increase/models/export.rbi

@@ -714,6 +714,13 @@ module Increase
           T.type_alias { T.all(Symbol, Increase::Export::Category) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        # Export a BAI2 file of transactions and balances for a given date and optional Account.
+        ACCOUNT_STATEMENT_BAI2 =
+          T.let(
+            :account_statement_bai2,
+            Increase::Export::Category::TaggedSymbol
+          )
+
         # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
         ACCOUNT_STATEMENT_OFX =
           T.let(
@@ -721,17 +728,13 @@ module Increase
             Increase::Export::Category::TaggedSymbol
           )
 
-        # Export a BAI2 file of transactions and balances for a given date and optional Account.
-        ACCOUNT_STATEMENT_BAI2 =
+        # A PDF of an account verification letter.
+        ACCOUNT_VERIFICATION_LETTER =
           T.let(
-            :account_statement_bai2,
+            :account_verification_letter,
             Increase::Export::Category::TaggedSymbol
           )
 
-        # Export a CSV of all transactions for a given time range.
-        TRANSACTION_CSV =
-          T.let(:transaction_csv, Increase::Export::Category::TaggedSymbol)
-
         # Export a CSV of account balances for the dates in a given range. (deprecated, use `daily_account_balance_csv` instead)
         BALANCE_CSV =
           T.let(:balance_csv, Increase::Export::Category::TaggedSymbol)
@@ -743,28 +746,23 @@ module Increase
             Increase::Export::Category::TaggedSymbol
           )
 
-        # Export a CSV of entities with a given status.
-        ENTITY_CSV =
-          T.let(:entity_csv, Increase::Export::Category::TaggedSymbol)
-
-        # Export a CSV of vendors added to the third-party risk management dashboard.
-        VENDOR_CSV =
-          T.let(:vendor_csv, Increase::Export::Category::TaggedSymbol)
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV =
+          T.let(
+            :daily_account_balance_csv,
+            Increase::Export::Category::TaggedSymbol
+          )
 
         # Certain dashboard tables are available as CSV exports. This export cannot be created via the API.
         DASHBOARD_TABLE_CSV =
           T.let(:dashboard_table_csv, Increase::Export::Category::TaggedSymbol)
 
-        # A PDF of an account verification letter.
-        ACCOUNT_VERIFICATION_LETTER =
-          T.let(
-            :account_verification_letter,
-            Increase::Export::Category::TaggedSymbol
-          )
+        # Export a CSV of entities with a given status.
+        ENTITY_CSV =
+          T.let(:entity_csv, Increase::Export::Category::TaggedSymbol)
 
-        # A PDF of funding instructions.
-        FUNDING_INSTRUCTIONS =
-          T.let(:funding_instructions, Increase::Export::Category::TaggedSymbol)
+        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
+        FEE_CSV = T.let(:fee_csv, Increase::Export::Category::TaggedSymbol)
 
         # A PDF of an Internal Revenue Service Form 1099-INT.
         FORM_1099_INT =
@@ -774,20 +772,22 @@ module Increase
         FORM_1099_MISC =
           T.let(:form_1099_misc, Increase::Export::Category::TaggedSymbol)
 
-        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
-        FEE_CSV = T.let(:fee_csv, Increase::Export::Category::TaggedSymbol)
+        # A PDF of funding instructions.
+        FUNDING_INSTRUCTIONS =
+          T.let(:funding_instructions, Increase::Export::Category::TaggedSymbol)
+
+        # Export a CSV of all transactions for a given time range.
+        TRANSACTION_CSV =
+          T.let(:transaction_csv, Increase::Export::Category::TaggedSymbol)
+
+        # Export a CSV of vendors added to the third-party risk management dashboard.
+        VENDOR_CSV =
+          T.let(:vendor_csv, Increase::Export::Category::TaggedSymbol)
 
         # A PDF of a voided check.
         VOIDED_CHECK =
           T.let(:voided_check, Increase::Export::Category::TaggedSymbol)
 
-        # Export a CSV of daily account balances with starting and ending balances for a given date range.
-        DAILY_ACCOUNT_BALANCE_CSV =
-          T.let(
-            :daily_account_balance_csv,
-            Increase::Export::Category::TaggedSymbol
-          )
-
         sig do
           override.returns(T::Array[Increase::Export::Category::TaggedSymbol])
         end

data/rbi/increase/models/export_create_params.rbi

@@ -254,24 +254,24 @@ module Increase
           T.type_alias { T.all(Symbol, Increase::ExportCreateParams::Category) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
-        ACCOUNT_STATEMENT_OFX =
+        # Export a BAI2 file of transactions and balances for a given date and optional Account.
+        ACCOUNT_STATEMENT_BAI2 =
           T.let(
-            :account_statement_ofx,
+            :account_statement_bai2,
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
-        # Export a BAI2 file of transactions and balances for a given date and optional Account.
-        ACCOUNT_STATEMENT_BAI2 =
+        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
+        ACCOUNT_STATEMENT_OFX =
           T.let(
-            :account_statement_bai2,
+            :account_statement_ofx,
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
-        # Export a CSV of all transactions for a given time range.
-        TRANSACTION_CSV =
+        # A PDF of an account verification letter.
+        ACCOUNT_VERIFICATION_LETTER =
           T.let(
-            :transaction_csv,
+            :account_verification_letter,
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
@@ -289,6 +289,13 @@ module Increase
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV =
+          T.let(
+            :daily_account_balance_csv,
+            Increase::ExportCreateParams::Category::TaggedSymbol
+          )
+
         # Export a CSV of entities with a given status.
         ENTITY_CSV =
           T.let(
@@ -296,31 +303,31 @@ module Increase
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
-        # Export a CSV of vendors added to the third-party risk management dashboard.
-        VENDOR_CSV =
+        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
+        FEE_CSV =
+          T.let(:fee_csv, Increase::ExportCreateParams::Category::TaggedSymbol)
+
+        # A PDF of funding instructions.
+        FUNDING_INSTRUCTIONS =
           T.let(
-            :vendor_csv,
+            :funding_instructions,
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
-        # A PDF of an account verification letter.
-        ACCOUNT_VERIFICATION_LETTER =
+        # Export a CSV of all transactions for a given time range.
+        TRANSACTION_CSV =
           T.let(
-            :account_verification_letter,
+            :transaction_csv,
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
-        # A PDF of funding instructions.
-        FUNDING_INSTRUCTIONS =
+        # Export a CSV of vendors added to the third-party risk management dashboard.
+        VENDOR_CSV =
           T.let(
-            :funding_instructions,
+            :vendor_csv,
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
-        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
-        FEE_CSV =
-          T.let(:fee_csv, Increase::ExportCreateParams::Category::TaggedSymbol)
-
         # A PDF of a voided check.
         VOIDED_CHECK =
           T.let(
@@ -328,13 +335,6 @@ module Increase
             Increase::ExportCreateParams::Category::TaggedSymbol
           )
 
-        # Export a CSV of daily account balances with starting and ending balances for a given date range.
-        DAILY_ACCOUNT_BALANCE_CSV =
-          T.let(
-            :daily_account_balance_csv,
-            Increase::ExportCreateParams::Category::TaggedSymbol
-          )
-
         sig do
           override.returns(
             T::Array[Increase::ExportCreateParams::Category::TaggedSymbol]