increase 1.346.0 → 1.347.0

data/rbi/increase/models/digital_card_profile_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
 
@@ -68,6 +70,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: {}

data/rbi/increase/models/digital_wallet_token_list_params.rbi

@@ -42,6 +42,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
 
@@ -65,6 +67,8 @@ module Increase
         cursor: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

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: {}

data/rbi/increase/models/entity_update_params.rbi

@@ -342,6 +342,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
 
@@ -387,6 +389,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:,
@@ -431,6 +435,8 @@ module Increase
           attr_accessor :value
 
           # The category of the legal identifier.
+          #
+          # Defaults to `us_employer_identification_number`.
           sig do
             returns(
               T.nilable(
@@ -462,6 +468,8 @@ module Increase
             # digits with no dashes or other separators.
             value:,
             # The category of the legal identifier.
+            #
+            # Defaults to `us_employer_identification_number`.
             category: nil
           )
           end
@@ -479,6 +487,8 @@ module Increase
           end
 
           # The category of the legal identifier.
+          #
+          # Defaults to `us_employer_identification_number`.
           module Category
             extend Increase::Internal::Type::Enum
 
@@ -775,6 +785,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
 
@@ -820,6 +832,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:,
@@ -859,6 +873,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::EntityUpdateParams::NaturalPerson::Identification::Method::OrSymbol
@@ -947,6 +963,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
@@ -985,6 +1003,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/event.rbi

@@ -530,6 +530,20 @@ module Increase
             Increase::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever an Interest Rate Plan is created.
+        INTEREST_RATE_PLAN_CREATED =
+          T.let(
+            :"interest_rate_plan.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever an Interest Rate Plan is updated.
+        INTEREST_RATE_PLAN_UPDATED =
+          T.let(
+            :"interest_rate_plan.updated",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever an IntraFi Account Enrollment is created.
         INTRAFI_ACCOUNT_ENROLLMENT_CREATED =
           T.let(

data/rbi/increase/models/event_list_params.rbi

@@ -41,6 +41,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
 
@@ -73,6 +75,8 @@ module Increase
         cursor: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         order_by: nil,
         request_options: {}
@@ -629,6 +633,20 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever an Interest Rate Plan is created.
+          INTEREST_RATE_PLAN_CREATED =
+            T.let(
+              :"interest_rate_plan.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever an Interest Rate Plan is updated.
+          INTEREST_RATE_PLAN_UPDATED =
+            T.let(
+              :"interest_rate_plan.updated",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever an IntraFi Account Enrollment is created.
           INTRAFI_ACCOUNT_ENROLLMENT_CREATED =
             T.let(
@@ -1066,6 +1084,8 @@ module Increase
           end
 
         # The direction to order in.
+        #
+        # Defaults to `ascending`.
         sig do
           returns(
             T.nilable(Increase::EventListParams::OrderBy::Direction::OrSymbol)
@@ -1103,6 +1123,8 @@ module Increase
         end
         def self.new(
           # The direction to order in.
+          #
+          # Defaults to `ascending`.
           direction: nil,
           # The field to order by.
           field: nil
@@ -1122,6 +1144,8 @@ module Increase
         end
 
         # The direction to order in.
+        #
+        # Defaults to `ascending`.
         module Direction
           extend Increase::Internal::Type::Enum
 

data/rbi/increase/models/event_subscription.rbi

@@ -654,6 +654,20 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever an Interest Rate Plan is created.
+          INTEREST_RATE_PLAN_CREATED =
+            T.let(
+              :"interest_rate_plan.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever an Interest Rate Plan is updated.
+          INTEREST_RATE_PLAN_UPDATED =
+            T.let(
+              :"interest_rate_plan.updated",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an IntraFi Account Enrollment is created.
           INTRAFI_ACCOUNT_ENROLLMENT_CREATED =
             T.let(

data/rbi/increase/models/event_subscription_create_params.rbi

@@ -652,6 +652,20 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever an Interest Rate Plan is created.
+          INTEREST_RATE_PLAN_CREATED =
+            T.let(
+              :"interest_rate_plan.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
+          # Occurs whenever an Interest Rate Plan is updated.
+          INTEREST_RATE_PLAN_UPDATED =
+            T.let(
+              :"interest_rate_plan.updated",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an IntraFi Account Enrollment is created.
           INTRAFI_ACCOUNT_ENROLLMENT_CREATED =
             T.let(

data/rbi/increase/models/event_subscription_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
 
@@ -57,6 +59,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,
         request_options: {}
       )

data/rbi/increase/models/export_list_params.rbi

@@ -67,6 +67,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
 
@@ -107,6 +109,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: {}

data/rbi/increase/models/external_account_create_params.rbi

@@ -45,7 +45,9 @@ module Increase
       end
       attr_writer :account_holder
 
-      # The type of the destination account. Defaults to `checking`.
+      # The type of the destination account.
+      #
+      # Defaults to `checking`.
       sig do
         returns(
           T.nilable(Increase::ExternalAccountCreateParams::Funding::OrSymbol)
@@ -81,7 +83,9 @@ module Increase
         routing_number:,
         # The type of entity that owns the External Account.
         account_holder: nil,
-        # The type of the destination account. Defaults to `checking`.
+        # The type of the destination account.
+        #
+        # Defaults to `checking`.
         funding: nil,
         request_options: {}
       )
@@ -145,7 +149,9 @@ module Increase
         end
       end
 
-      # The type of the destination account. Defaults to `checking`.
+      # The type of the destination account.
+      #
+      # Defaults to `checking`.
       module Funding
         extend Increase::Internal::Type::Enum
 

data/rbi/increase/models/external_account_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
 
@@ -74,6 +76,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,
         # Filter External Accounts to those with the specified Routing Number.
         routing_number: nil,

data/rbi/increase/models/fednow_transfer_list_params.rbi

@@ -54,6 +54,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
 
@@ -95,6 +97,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: {}

data/rbi/increase/models/file.rbi

@@ -232,7 +232,7 @@ module Increase
         DIGITAL_WALLET_APP_ICON =
           T.let(:digital_wallet_app_icon, Increase::File::Purpose::TaggedSymbol)
 
-        # A card image to be printed on the front of a physical card. This must be a 2100x1344 pixel PNG with no other color but black.
+        # A card image to be printed on the front of a physical card. This must be a 2100x1344 pixel PNG with a density of 600 dots per inch (DPI) and no other color but black.
         PHYSICAL_CARD_FRONT =
           T.let(:physical_card_front, Increase::File::Purpose::TaggedSymbol)
 
@@ -240,7 +240,7 @@ module Increase
         PHYSICAL_CARD_BACK =
           T.let(:physical_card_back, Increase::File::Purpose::TaggedSymbol)
 
-        # An image representing the entirety of the carrier used for a physical card. This must be a 2550x3300 pixel PNG with no other color but black.
+        # An image representing the entirety of the carrier used for a physical card. This must be a 2550x3300 pixel PNG with a density of 300 dots per inch (DPI) and no other color but black.
         PHYSICAL_CARD_CARRIER =
           T.let(:physical_card_carrier, Increase::File::Purpose::TaggedSymbol)