increase 1.346.1 → 1.348.0

data/rbi/increase/models/entity.rbi

@@ -2015,7 +2015,7 @@ module Increase
         attr_accessor :agreed_at
 
         # The IP address the Entity accessed reviewed the terms from.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :ip_address
 
         # The URL of the terms agreement. This link will be provided by your bank partner.
@@ -2025,7 +2025,7 @@ module Increase
         sig do
           params(
             agreed_at: Time,
-            ip_address: String,
+            ip_address: T.nilable(String),
             terms_url: String
           ).returns(T.attached_class)
         end
@@ -2041,7 +2041,11 @@ module Increase
 
         sig do
           override.returns(
-            { agreed_at: Time, ip_address: String, terms_url: String }
+            {
+              agreed_at: Time,
+              ip_address: T.nilable(String),
+              terms_url: String
+            }
           )
         end
         def to_hash
@@ -3137,6 +3141,24 @@ module Increase
           end
           attr_writer :entity_address
 
+          # Details when the issue is with the entity's identity verification.
+          sig do
+            returns(
+              T.nilable(Increase::Entity::Validation::Issue::EntityIdentity)
+            )
+          end
+          attr_reader :entity_identity
+
+          sig do
+            params(
+              entity_identity:
+                T.nilable(
+                  Increase::Entity::Validation::Issue::EntityIdentity::OrHash
+                )
+            ).void
+          end
+          attr_writer :entity_identity
+
           # Details when the issue is with the entity's tax ID.
           sig do
             returns(
@@ -3172,6 +3194,10 @@ module Increase
                 T.nilable(
                   Increase::Entity::Validation::Issue::EntityAddress::OrHash
                 ),
+              entity_identity:
+                T.nilable(
+                  Increase::Entity::Validation::Issue::EntityIdentity::OrHash
+                ),
               entity_tax_identifier:
                 T.nilable(
                   Increase::Entity::Validation::Issue::EntityTaxIdentifier::OrHash
@@ -3188,6 +3214,8 @@ module Increase
             category:,
             # Details when the issue is with the entity's address.
             entity_address:,
+            # Details when the issue is with the entity's identity verification.
+            entity_identity:,
             # Details when the issue is with the entity's tax ID.
             entity_tax_identifier:
           )
@@ -3208,6 +3236,10 @@ module Increase
                   Increase::Entity::Validation::Issue::Category::TaggedSymbol,
                 entity_address:
                   T.nilable(Increase::Entity::Validation::Issue::EntityAddress),
+                entity_identity:
+                  T.nilable(
+                    Increase::Entity::Validation::Issue::EntityIdentity
+                  ),
                 entity_tax_identifier:
                   T.nilable(
                     Increase::Entity::Validation::Issue::EntityTaxIdentifier
@@ -3352,6 +3384,13 @@ module Increase
                 Increase::Entity::Validation::Issue::Category::TaggedSymbol
               )
 
+            # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
+            ENTITY_IDENTITY =
+              T.let(
+                :entity_identity,
+                Increase::Entity::Validation::Issue::Category::TaggedSymbol
+              )
+
             # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
             BENEFICIAL_OWNER_IDENTITY =
               T.let(
@@ -3450,6 +3489,25 @@ module Increase
             end
           end
 
+          class EntityIdentity < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::Entity::Validation::Issue::EntityIdentity,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # Details when the issue is with the entity's identity verification.
+            sig { returns(T.attached_class) }
+            def self.new
+            end
+
+            sig { override.returns({}) }
+            def to_hash
+            end
+          end
+
           class EntityTaxIdentifier < Increase::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/rbi/increase/models/entity_create_params.rbi

@@ -478,6 +478,8 @@ module Increase
           attr_accessor :city
 
           # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          # Defaults to `US`.
           sig { returns(String) }
           attr_accessor :country
 
@@ -523,6 +525,8 @@ module Increase
             # 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:,
@@ -755,6 +759,8 @@ module Increase
               attr_accessor :city
 
               # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+              #
+              # Defaults to `US`.
               sig { returns(String) }
               attr_accessor :country
 
@@ -800,6 +806,8 @@ module Increase
                 # 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:,
@@ -839,6 +847,8 @@ module Increase
                 end
 
               # A method that can be used to verify the individual's identity.
+              #
+              # Defaults to `social_security_number`.
               sig do
                 returns(
                   Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::OrSymbol
@@ -927,6 +937,8 @@ module Increase
               end
               def self.new(
                 # A method that can be used to verify the individual's identity.
+                #
+                # Defaults to `social_security_number`.
                 method_:,
                 # An identification number that can be used to verify the individual's identity,
                 # such as a social security number. For Social Security Numbers and Individual
@@ -965,6 +977,8 @@ module Increase
               end
 
               # A method that can be used to verify the individual's identity.
+              #
+              # Defaults to `social_security_number`.
               module Method
                 extend Increase::Internal::Type::Enum
 
@@ -1273,8 +1287,9 @@ module Increase
           sig { returns(String) }
           attr_accessor :value
 
-          # The category of the legal identifier. If not provided, the default is
-          # `us_employer_identification_number`.
+          # The category of the legal identifier.
+          #
+          # Defaults to `us_employer_identification_number`.
           sig do
             returns(
               T.nilable(
@@ -1308,8 +1323,9 @@ module Increase
             # our
             # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
             value:,
-            # The category of the legal identifier. If not provided, the default is
-            # `us_employer_identification_number`.
+            # The category of the legal identifier.
+            #
+            # Defaults to `us_employer_identification_number`.
             category: nil
           )
           end
@@ -1326,8 +1342,9 @@ module Increase
           def to_hash
           end
 
-          # The category of the legal identifier. If not provided, the default is
-          # `us_employer_identification_number`.
+          # The category of the legal identifier.
+          #
+          # Defaults to `us_employer_identification_number`.
           module Category
             extend Increase::Internal::Type::Enum
 
@@ -1845,6 +1862,8 @@ module Increase
             attr_accessor :city
 
             # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+            #
+            # Defaults to `US`.
             sig { returns(String) }
             attr_accessor :country
 
@@ -1890,6 +1909,8 @@ module Increase
               # 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:,
@@ -1929,6 +1950,8 @@ module Increase
               end
 
             # A method that can be used to verify the individual's identity.
+            #
+            # Defaults to `social_security_number`.
             sig do
               returns(
                 Increase::EntityCreateParams::Joint::Individual::Identification::Method::OrSymbol
@@ -2017,6 +2040,8 @@ module Increase
             end
             def self.new(
               # A method that can be used to verify the individual's identity.
+              #
+              # Defaults to `social_security_number`.
               method_:,
               # An identification number that can be used to verify the individual's identity,
               # such as a social security number. For Social Security Numbers and Individual
@@ -2055,6 +2080,8 @@ module Increase
             end
 
             # A method that can be used to verify the individual's identity.
+            #
+            # Defaults to `social_security_number`.
             module Method
               extend Increase::Internal::Type::Enum
 
@@ -2426,6 +2453,8 @@ module Increase
           attr_accessor :city
 
           # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          # Defaults to `US`.
           sig { returns(String) }
           attr_accessor :country
 
@@ -2471,6 +2500,8 @@ module Increase
             # 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:,
@@ -2510,6 +2541,8 @@ module Increase
             end
 
           # A method that can be used to verify the individual's identity.
+          #
+          # Defaults to `social_security_number`.
           sig do
             returns(
               Increase::EntityCreateParams::NaturalPerson::Identification::Method::OrSymbol
@@ -2598,6 +2631,8 @@ module Increase
           end
           def self.new(
             # A method that can be used to verify the individual's identity.
+            #
+            # Defaults to `social_security_number`.
             method_:,
             # An identification number that can be used to verify the individual's identity,
             # such as a social security number. For Social Security Numbers and Individual
@@ -2636,6 +2671,8 @@ module Increase
           end
 
           # A method that can be used to verify the individual's identity.
+          #
+          # Defaults to `social_security_number`.
           module Method
             extend Increase::Internal::Type::Enum
 
@@ -3619,6 +3656,8 @@ module Increase
               attr_accessor :city
 
               # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+              #
+              # Defaults to `US`.
               sig { returns(String) }
               attr_accessor :country
 
@@ -3664,6 +3703,8 @@ module Increase
                 # 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:,
@@ -3703,6 +3744,8 @@ module Increase
                 end
 
               # A method that can be used to verify the individual's identity.
+              #
+              # Defaults to `social_security_number`.
               sig do
                 returns(
                   Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::OrSymbol
@@ -3791,6 +3834,8 @@ module Increase
               end
               def self.new(
                 # A method that can be used to verify the individual's identity.
+                #
+                # Defaults to `social_security_number`.
                 method_:,
                 # An identification number that can be used to verify the individual's identity,
                 # such as a social security number. For Social Security Numbers and Individual
@@ -3829,6 +3874,8 @@ module Increase
               end
 
               # A method that can be used to verify the individual's identity.
+              #
+              # Defaults to `social_security_number`.
               module Method
                 extend Increase::Internal::Type::Enum
 
@@ -4199,6 +4246,8 @@ module Increase
             attr_accessor :city
 
             # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+            #
+            # Defaults to `US`.
             sig { returns(String) }
             attr_accessor :country
 
@@ -4244,6 +4293,8 @@ module Increase
               # 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:,
@@ -4283,6 +4334,8 @@ module Increase
               end
 
             # A method that can be used to verify the individual's identity.
+            #
+            # Defaults to `social_security_number`.
             sig do
               returns(
                 Increase::EntityCreateParams::Trust::Grantor::Identification::Method::OrSymbol
@@ -4371,6 +4424,8 @@ module Increase
             end
             def self.new(
               # A method that can be used to verify the individual's identity.
+              #
+              # Defaults to `social_security_number`.
               method_:,
               # An identification number that can be used to verify the individual's identity,
               # such as a social security number. For Social Security Numbers and Individual
@@ -4409,6 +4464,8 @@ module Increase
             end
 
             # A method that can be used to verify the individual's identity.
+            #
+            # Defaults to `social_security_number`.
             module Method
               extend Increase::Internal::Type::Enum
 

data/rbi/increase/models/entity_list_params.rbi

@@ -38,6 +38,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -84,6 +86,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         validation_status: nil,

data/rbi/increase/models/entity_onboarding_session_list_params.rbi

@@ -33,6 +33,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -70,6 +72,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         request_options: {}