increase 1.351.0 → 1.353.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/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.
+                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.
+              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.
+            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.
+              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.
+              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.
+                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(

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.
+            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.
+                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(
@@ -3859,22 +3866,19 @@ module Increase
               )
             end
 
-          # The city of the address.
+          # The city, district, town, or village of the address.
           sig { returns(String) }
           attr_accessor :city
 
-          # The first line of the address. This is usually the street number and street.
-          sig { returns(String) }
-          attr_accessor :line1
-
-          # The two-letter United States Postal Service (USPS) abbreviation for the state of
-          # the address.
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          # Defaults to `US`.
           sig { returns(String) }
-          attr_accessor :state
+          attr_accessor :country
 
-          # The ZIP code of the address.
+          # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
-          attr_accessor :zip
+          attr_accessor :line1
 
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
@@ -3883,29 +3887,49 @@ module Increase
           sig { params(line2: String).void }
           attr_writer :line2
 
+          # The two-letter United States Postal Service (USPS) abbreviation for the US
+          # state, province, or region of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :state
+
+          sig { params(state: String).void }
+          attr_writer :state
+
+          # The ZIP or postal code of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :zip
+
+          sig { params(zip: String).void }
+          attr_writer :zip
+
           # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
           # are disallowed.
           sig do
             params(
               city: String,
+              country: String,
               line1: String,
+              line2: String,
               state: String,
-              zip: String,
-              line2: String
+              zip: String
             ).returns(T.attached_class)
           end
           def self.new(
-            # The city of the address.
+            # 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.
+            #
+            # Defaults to `US`.
+            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
-            # The two-letter United States Postal Service (USPS) abbreviation for the state of
-            # the address.
-            state:,
-            # The ZIP code of the address.
-            zip:,
             # The second line of the address. This might be the floor or room number.
-            line2: nil
+            line2: nil,
+            # The two-letter United States Postal Service (USPS) abbreviation for the US
+            # state, province, or region of the address. Required in certain countries.
+            state: nil,
+            # The ZIP or postal code of the address. Required in certain countries.
+            zip: nil
           )
           end
 
@@ -3913,10 +3937,11 @@ module Increase
             override.returns(
               {
                 city: String,
+                country: String,
                 line1: String,
+                line2: String,
                 state: String,
-                zip: String,
-                line2: String
+                zip: String
               }
             )
           end

data/rbi/increase/models/entity_update_params.rbi

@@ -2417,22 +2417,19 @@ module Increase
               )
             end
 
-          # The city of the address.
+          # The city, district, town, or village of the address.
           sig { returns(String) }
           attr_accessor :city
 
-          # The first line of the address. This is usually the street number and street.
-          sig { returns(String) }
-          attr_accessor :line1
-
-          # The two-letter United States Postal Service (USPS) abbreviation for the state of
-          # the address.
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          # Defaults to `US`.
           sig { returns(String) }
-          attr_accessor :state
+          attr_accessor :country
 
-          # The ZIP code of the address.
+          # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
-          attr_accessor :zip
+          attr_accessor :line1
 
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
@@ -2441,29 +2438,49 @@ module Increase
           sig { params(line2: String).void }
           attr_writer :line2
 
+          # The two-letter United States Postal Service (USPS) abbreviation for the US
+          # state, province, or region of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :state
+
+          sig { params(state: String).void }
+          attr_writer :state
+
+          # The ZIP or postal code of the address. Required in certain countries.
+          sig { returns(T.nilable(String)) }
+          attr_reader :zip
+
+          sig { params(zip: String).void }
+          attr_writer :zip
+
           # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           # are disallowed.
           sig do
             params(
               city: String,
+              country: String,
               line1: String,
+              line2: String,
               state: String,
-              zip: String,
-              line2: String
+              zip: String
             ).returns(T.attached_class)
           end
           def self.new(
-            # The city of the address.
+            # 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.
+            #
+            # Defaults to `US`.
+            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
-            # The two-letter United States Postal Service (USPS) abbreviation for the state of
-            # the address.
-            state:,
-            # The ZIP code of the address.
-            zip:,
             # The second line of the address. This might be the floor or room number.
-            line2: nil
+            line2: nil,
+            # The two-letter United States Postal Service (USPS) abbreviation for the US
+            # state, province, or region of the address. Required in certain countries.
+            state: nil,
+            # The ZIP or postal code of the address. Required in certain countries.
+            zip: nil
           )
           end
 
@@ -2471,10 +2488,11 @@ module Increase
             override.returns(
               {
                 city: String,
+                country: String,
                 line1: String,
+                line2: String,
                 state: String,
-                zip: String,
-                line2: String
+                zip: String
               }
             )
           end

data/rbi/increase/models/event.rbi

@@ -842,6 +842,20 @@ module Increase
             Increase::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever a SEPA Instant Transfer is created.
+        SEPA_INSTANT_TRANSFER_CREATED =
+          T.let(
+            :"sepa_instant_transfer.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever a SEPA Instant Transfer is updated.
+        SEPA_INSTANT_TRANSFER_UPDATED =
+          T.let(
+            :"sepa_instant_transfer.updated",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever a Swift Transfer is created.
         SWIFT_TRANSFER_CREATED =
           T.let(
@@ -860,6 +874,20 @@ module Increase
         TRANSACTION_CREATED =
           T.let(:"transaction.created", Increase::Event::Category::TaggedSymbol)
 
+        # Occurs whenever a UK Faster Payment System Transfer is created.
+        UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
+          T.let(
+            :"uk_faster_payment_system_transfer.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever a UK Faster Payment System Transfer is updated.
+        UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
+          T.let(
+            :"uk_faster_payment_system_transfer.updated",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever a Wire Drawdown Request is created.
         WIRE_DRAWDOWN_REQUEST_CREATED =
           T.let(

data/rbi/increase/models/event_list_params.rbi

@@ -969,6 +969,20 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a SEPA Instant Transfer is created.
+          SEPA_INSTANT_TRANSFER_CREATED =
+            T.let(
+              :"sepa_instant_transfer.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever a SEPA Instant Transfer is updated.
+          SEPA_INSTANT_TRANSFER_UPDATED =
+            T.let(
+              :"sepa_instant_transfer.updated",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever a Swift Transfer is created.
           SWIFT_TRANSFER_CREATED =
             T.let(
@@ -990,6 +1004,20 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a UK Faster Payment System Transfer is created.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
+            T.let(
+              :"uk_faster_payment_system_transfer.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever a UK Faster Payment System Transfer is updated.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
+            T.let(
+              :"uk_faster_payment_system_transfer.updated",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever a Wire Drawdown Request is created.
           WIRE_DRAWDOWN_REQUEST_CREATED =
             T.let(

data/rbi/increase/models/event_subscription.rbi

@@ -990,6 +990,20 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a SEPA Instant Transfer is created.
+          SEPA_INSTANT_TRANSFER_CREATED =
+            T.let(
+              :"sepa_instant_transfer.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever a SEPA Instant Transfer is updated.
+          SEPA_INSTANT_TRANSFER_UPDATED =
+            T.let(
+              :"sepa_instant_transfer.updated",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Swift Transfer is created.
           SWIFT_TRANSFER_CREATED =
             T.let(
@@ -1011,6 +1025,20 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a UK Faster Payment System Transfer is created.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
+            T.let(
+              :"uk_faster_payment_system_transfer.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever a UK Faster Payment System Transfer is updated.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
+            T.let(
+              :"uk_faster_payment_system_transfer.updated",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Wire Drawdown Request is created.
           WIRE_DRAWDOWN_REQUEST_CREATED =
             T.let(

data/rbi/increase/models/event_subscription_create_params.rbi

@@ -988,6 +988,20 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a SEPA Instant Transfer is created.
+          SEPA_INSTANT_TRANSFER_CREATED =
+            T.let(
+              :"sepa_instant_transfer.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever a SEPA Instant Transfer is updated.
+          SEPA_INSTANT_TRANSFER_UPDATED =
+            T.let(
+              :"sepa_instant_transfer.updated",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Swift Transfer is created.
           SWIFT_TRANSFER_CREATED =
             T.let(
@@ -1009,6 +1023,20 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a UK Faster Payment System Transfer is created.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
+            T.let(
+              :"uk_faster_payment_system_transfer.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever a UK Faster Payment System Transfer is updated.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
+            T.let(
+              :"uk_faster_payment_system_transfer.updated",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Wire Drawdown Request is created.
           WIRE_DRAWDOWN_REQUEST_CREATED =
             T.let(

data/rbi/increase/models/inbound_ach_transfer.rbi

@@ -1783,6 +1783,10 @@ module Increase
             )
           end
 
+        # The three character ACH return code, in the range R01 to R85.
+        sig { returns(String) }
+        attr_accessor :raw_reason_code
+
         # The reason for the transfer return.
         sig do
           returns(
@@ -1802,6 +1806,7 @@ module Increase
         # If your transfer is returned, this will contain details of the return.
         sig do
           params(
+            raw_reason_code: String,
             reason:
               Increase::InboundACHTransfer::TransferReturn::Reason::OrSymbol,
             returned_at: Time,
@@ -1809,6 +1814,8 @@ module Increase
           ).returns(T.attached_class)
         end
         def self.new(
+          # The three character ACH return code, in the range R01 to R85.
+          raw_reason_code:,
           # The reason for the transfer return.
           reason:,
           # The time at which the transfer was returned.
@@ -1821,6 +1828,7 @@ module Increase
         sig do
           override.returns(
             {
+              raw_reason_code: String,
               reason:
                 Increase::InboundACHTransfer::TransferReturn::Reason::TaggedSymbol,
               returned_at: Time,