increase 1.363.0 → 1.364.0

data/rbi/increase/models/checkbook_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CheckbookRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CheckbookRetrieveParams, Increase::Internal::AnyHash)
+        end
+
+      # The identifier of the Checkbook.
+      sig { returns(String) }
+      attr_accessor :checkbook_id
+
+      sig do
+        params(
+          checkbook_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Checkbook.
+        checkbook_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { checkbook_id: String, request_options: Increase::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/checkbook_stop_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CheckbookStopParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CheckbookStopParams, Increase::Internal::AnyHash)
+        end
+
+      # The identifier of the Checkbook to stop.
+      sig { returns(String) }
+      attr_accessor :checkbook_id
+
+      sig do
+        params(
+          checkbook_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Checkbook to stop.
+        checkbook_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { checkbook_id: String, request_options: Increase::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/declined_transaction.rbi

@@ -3962,6 +3962,10 @@ module Increase
           sig { returns(T.nilable(String)) }
           attr_accessor :check_transfer_id
 
+          # The identifier of the Checkbook Check object associated with this decline.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :checkbook_check_id
+
           # The identifier of the API File object containing an image of the front of the
           # declined check.
           sig { returns(T.nilable(String)) }
@@ -3987,6 +3991,7 @@ module Increase
               auxiliary_on_us: T.nilable(String),
               back_image_file_id: T.nilable(String),
               check_transfer_id: T.nilable(String),
+              checkbook_check_id: T.nilable(String),
               front_image_file_id: T.nilable(String),
               inbound_check_deposit_id: T.nilable(String),
               reason:
@@ -4005,6 +4010,8 @@ module Increase
             back_image_file_id:,
             # The identifier of the Check Transfer object associated with this decline.
             check_transfer_id:,
+            # The identifier of the Checkbook Check object associated with this decline.
+            checkbook_check_id:,
             # The identifier of the API File object containing an image of the front of the
             # declined check.
             front_image_file_id:,
@@ -4022,6 +4029,7 @@ module Increase
                 auxiliary_on_us: T.nilable(String),
                 back_image_file_id: T.nilable(String),
                 check_transfer_id: T.nilable(String),
+                checkbook_check_id: T.nilable(String),
                 front_image_file_id: T.nilable(String),
                 inbound_check_deposit_id: T.nilable(String),
                 reason:

data/rbi/increase/models/entity.rbi

@@ -32,10 +32,6 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :creating_entity_onboarding_session_id
 
-      # The entity's description for display purposes.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :description
-
       # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
       # Entity's details were most recently confirmed.
       sig { returns(T.nilable(Time)) }
@@ -79,18 +75,6 @@ module Increase
       end
       attr_writer :natural_person
 
-      # An assessment of the entity’s potential risk of involvement in financial crimes,
-      # such as money laundering.
-      sig { returns(T.nilable(Increase::Entity::RiskRating)) }
-      attr_reader :risk_rating
-
-      sig do
-        params(
-          risk_rating: T.nilable(Increase::Entity::RiskRating::OrHash)
-        ).void
-      end
-      attr_writer :risk_rating
-
       # Details of the sole proprietorship entity. Will be present if `structure` is
       # equal to `sole_proprietorship`.
       sig { returns(T.nilable(Increase::Entity::SoleProprietorship)) }
@@ -168,14 +152,12 @@ module Increase
           corporation: T.nilable(Increase::Entity::Corporation::OrHash),
           created_at: Time,
           creating_entity_onboarding_session_id: T.nilable(String),
-          description: T.nilable(String),
           details_confirmed_at: T.nilable(Time),
           government_authority:
             T.nilable(Increase::Entity::GovernmentAuthority::OrHash),
           idempotency_key: T.nilable(String),
           joint: T.nilable(Increase::Entity::Joint::OrHash),
           natural_person: T.nilable(Increase::Entity::NaturalPerson::OrHash),
-          risk_rating: T.nilable(Increase::Entity::RiskRating::OrHash),
           sole_proprietorship:
             T.nilable(Increase::Entity::SoleProprietorship::OrHash),
           status: Increase::Entity::Status::OrSymbol,
@@ -202,8 +184,6 @@ module Increase
         # The identifier of the Entity Onboarding Session that was used to create this
         # Entity, if any.
         creating_entity_onboarding_session_id:,
-        # The entity's description for display purposes.
-        description:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
         # Entity's details were most recently confirmed.
         details_confirmed_at:,
@@ -219,9 +199,6 @@ module Increase
         # Details of the natural person entity. Will be present if `structure` is equal to
         # `natural_person`.
         natural_person:,
-        # An assessment of the entity’s potential risk of involvement in financial crimes,
-        # such as money laundering.
-        risk_rating:,
         # Details of the sole proprietorship entity. Will be present if `structure` is
         # equal to `sole_proprietorship`.
         sole_proprietorship:,
@@ -258,14 +235,12 @@ module Increase
             corporation: T.nilable(Increase::Entity::Corporation),
             created_at: Time,
             creating_entity_onboarding_session_id: T.nilable(String),
-            description: T.nilable(String),
             details_confirmed_at: T.nilable(Time),
             government_authority:
               T.nilable(Increase::Entity::GovernmentAuthority),
             idempotency_key: T.nilable(String),
             joint: T.nilable(Increase::Entity::Joint),
             natural_person: T.nilable(Increase::Entity::NaturalPerson),
-            risk_rating: T.nilable(Increase::Entity::RiskRating),
             sole_proprietorship:
               T.nilable(Increase::Entity::SoleProprietorship),
             status: Increase::Entity::Status::TaggedSymbol,
@@ -1914,78 +1889,6 @@ module Increase
         end
       end
 
-      class RiskRating < Increase::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Increase::Entity::RiskRating, Increase::Internal::AnyHash)
-          end
-
-        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-        # rating was performed.
-        sig { returns(Time) }
-        attr_accessor :rated_at
-
-        # The rating given to this entity.
-        sig { returns(Increase::Entity::RiskRating::Rating::TaggedSymbol) }
-        attr_accessor :rating
-
-        # An assessment of the entity’s potential risk of involvement in financial crimes,
-        # such as money laundering.
-        sig do
-          params(
-            rated_at: Time,
-            rating: Increase::Entity::RiskRating::Rating::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-          # rating was performed.
-          rated_at:,
-          # The rating given to this entity.
-          rating:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              rated_at: Time,
-              rating: Increase::Entity::RiskRating::Rating::TaggedSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The rating given to this entity.
-        module Rating
-          extend Increase::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias { T.all(Symbol, Increase::Entity::RiskRating::Rating) }
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          # Minimal risk of involvement in financial crime.
-          LOW = T.let(:low, Increase::Entity::RiskRating::Rating::TaggedSymbol)
-
-          # Moderate risk of involvement in financial crime.
-          MEDIUM =
-            T.let(:medium, Increase::Entity::RiskRating::Rating::TaggedSymbol)
-
-          # Elevated risk of involvement in financial crime.
-          HIGH =
-            T.let(:high, Increase::Entity::RiskRating::Rating::TaggedSymbol)
-
-          sig do
-            override.returns(
-              T::Array[Increase::Entity::RiskRating::Rating::TaggedSymbol]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class SoleProprietorship < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/increase/models/entity_create_params.rbi

@@ -27,13 +27,6 @@ module Increase
       end
       attr_writer :corporation
 
-      # The description you choose to give the entity.
-      sig { returns(T.nilable(String)) }
-      attr_reader :description
-
-      sig { params(description: String).void }
-      attr_writer :description
-
       # Details of the Government Authority entity to create. Required if `structure` is
       # equal to `government_authority`.
       sig do
@@ -71,18 +64,6 @@ module Increase
       end
       attr_writer :natural_person
 
-      # An assessment of the entity's potential risk of involvement in financial crimes,
-      # such as money laundering.
-      sig { returns(T.nilable(Increase::EntityCreateParams::RiskRating)) }
-      attr_reader :risk_rating
-
-      sig do
-        params(
-          risk_rating: Increase::EntityCreateParams::RiskRating::OrHash
-        ).void
-      end
-      attr_writer :risk_rating
-
       # Details of the sole proprietorship entity to create. Required if `structure` is
       # equal to `sole_proprietorship`.
       sig do
@@ -161,12 +142,10 @@ module Increase
         params(
           structure: Increase::EntityCreateParams::Structure::OrSymbol,
           corporation: Increase::EntityCreateParams::Corporation::OrHash,
-          description: String,
           government_authority:
             Increase::EntityCreateParams::GovernmentAuthority::OrHash,
           joint: Increase::EntityCreateParams::Joint::OrHash,
           natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
-          risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
           sole_proprietorship:
             Increase::EntityCreateParams::SoleProprietorship::OrHash,
           supplemental_documents:
@@ -187,8 +166,6 @@ module Increase
         # Details of the corporation entity to create. Required if `structure` is equal to
         # `corporation`.
         corporation: nil,
-        # The description you choose to give the entity.
-        description: nil,
         # Details of the Government Authority entity to create. Required if `structure` is
         # equal to `government_authority`.
         government_authority: nil,
@@ -200,9 +177,6 @@ module Increase
         # `social_security_number` or `individual_taxpayer_identification_number`
         # identification methods.
         natural_person: nil,
-        # An assessment of the entity's potential risk of involvement in financial crimes,
-        # such as money laundering.
-        risk_rating: nil,
         # Details of the sole proprietorship entity to create. Required if `structure` is
         # equal to `sole_proprietorship`.
         sole_proprietorship: nil,
@@ -227,12 +201,10 @@ module Increase
           {
             structure: Increase::EntityCreateParams::Structure::OrSymbol,
             corporation: Increase::EntityCreateParams::Corporation,
-            description: String,
             government_authority:
               Increase::EntityCreateParams::GovernmentAuthority,
             joint: Increase::EntityCreateParams::Joint,
             natural_person: Increase::EntityCreateParams::NaturalPerson,
-            risk_rating: Increase::EntityCreateParams::RiskRating,
             sole_proprietorship:
               Increase::EntityCreateParams::SoleProprietorship,
             supplemental_documents:
@@ -2955,97 +2927,6 @@ module Increase
         end
       end
 
-      class RiskRating < Increase::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Increase::EntityCreateParams::RiskRating,
-              Increase::Internal::AnyHash
-            )
-          end
-
-        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-        # rating was performed.
-        sig { returns(Time) }
-        attr_accessor :rated_at
-
-        # The rating given to this entity.
-        sig do
-          returns(Increase::EntityCreateParams::RiskRating::Rating::OrSymbol)
-        end
-        attr_accessor :rating
-
-        # An assessment of the entity's potential risk of involvement in financial crimes,
-        # such as money laundering.
-        sig do
-          params(
-            rated_at: Time,
-            rating: Increase::EntityCreateParams::RiskRating::Rating::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-          # rating was performed.
-          rated_at:,
-          # The rating given to this entity.
-          rating:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              rated_at: Time,
-              rating: Increase::EntityCreateParams::RiskRating::Rating::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The rating given to this entity.
-        module Rating
-          extend Increase::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, Increase::EntityCreateParams::RiskRating::Rating)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          # Minimal risk of involvement in financial crime.
-          LOW =
-            T.let(
-              :low,
-              Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
-            )
-
-          # Moderate risk of involvement in financial crime.
-          MEDIUM =
-            T.let(
-              :medium,
-              Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
-            )
-
-          # Elevated risk of involvement in financial crime.
-          HIGH =
-            T.let(
-              :high,
-              Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class SoleProprietorship < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/increase/models/entity_update_params.rbi

@@ -63,18 +63,6 @@ module Increase
       end
       attr_writer :natural_person
 
-      # An assessment of the entity’s potential risk of involvement in financial crimes,
-      # such as money laundering.
-      sig { returns(T.nilable(Increase::EntityUpdateParams::RiskRating)) }
-      attr_reader :risk_rating
-
-      sig do
-        params(
-          risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash
-        ).void
-      end
-      attr_writer :risk_rating
-
       # Details of the sole proprietorship entity to update. If you specify this
       # parameter and the entity is not a sole proprietorship, the request will fail.
       sig do
@@ -139,7 +127,6 @@ module Increase
           government_authority:
             Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
           natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
-          risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
           sole_proprietorship:
             Increase::EntityUpdateParams::SoleProprietorship::OrHash,
           terms_agreements:
@@ -166,9 +153,6 @@ module Increase
         # Details of the natural person entity to update. If you specify this parameter
         # and the entity is not a natural person, the request will fail.
         natural_person: nil,
-        # An assessment of the entity’s potential risk of involvement in financial crimes,
-        # such as money laundering.
-        risk_rating: nil,
         # Details of the sole proprietorship entity to update. If you specify this
         # parameter and the entity is not a sole proprietorship, the request will fail.
         sole_proprietorship: nil,
@@ -195,7 +179,6 @@ module Increase
             government_authority:
               Increase::EntityUpdateParams::GovernmentAuthority,
             natural_person: Increase::EntityUpdateParams::NaturalPerson,
-            risk_rating: Increase::EntityUpdateParams::RiskRating,
             sole_proprietorship:
               Increase::EntityUpdateParams::SoleProprietorship,
             terms_agreements:
@@ -1281,97 +1264,6 @@ module Increase
         end
       end
 
-      class RiskRating < Increase::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Increase::EntityUpdateParams::RiskRating,
-              Increase::Internal::AnyHash
-            )
-          end
-
-        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-        # rating was performed.
-        sig { returns(Time) }
-        attr_accessor :rated_at
-
-        # The rating given to this entity.
-        sig do
-          returns(Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol)
-        end
-        attr_accessor :rating
-
-        # An assessment of the entity’s potential risk of involvement in financial crimes,
-        # such as money laundering.
-        sig do
-          params(
-            rated_at: Time,
-            rating: Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-          # rating was performed.
-          rated_at:,
-          # The rating given to this entity.
-          rating:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              rated_at: Time,
-              rating: Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The rating given to this entity.
-        module Rating
-          extend Increase::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, Increase::EntityUpdateParams::RiskRating::Rating)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          # Minimal risk of involvement in financial crime.
-          LOW =
-            T.let(
-              :low,
-              Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
-            )
-
-          # Moderate risk of involvement in financial crime.
-          MEDIUM =
-            T.let(
-              :medium,
-              Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
-            )
-
-          # Elevated risk of involvement in financial crime.
-          HIGH =
-            T.let(
-              :high,
-              Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class SoleProprietorship < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/increase/models/inbound_ach_transfer.rbi

@@ -143,8 +143,8 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :receiver_name
 
-      # A subhash containing information about when and how the transfer settled at the
-      # Federal Reserve.
+      # A subhash containing information about when the transfer settled (or will
+      # settle) at the Federal Reserve.
       sig { returns(Increase::InboundACHTransfer::Settlement) }
       attr_reader :settlement
 
@@ -281,8 +281,8 @@ module Increase
         receiver_id_number:,
         # The name of the receiver of the transfer.
         receiver_name:,
-        # A subhash containing information about when and how the transfer settled at the
-        # Federal Reserve.
+        # A subhash containing information about when the transfer settled (or will
+        # settle) at the Federal Reserve.
         settlement:,
         # The Standard Entry Class (SEC) code of the transfer.
         standard_entry_class_code:,
@@ -1539,8 +1539,8 @@ module Increase
         end
         attr_accessor :settlement_schedule
 
-        # A subhash containing information about when and how the transfer settled at the
-        # Federal Reserve.
+        # A subhash containing information about when the transfer settled (or will
+        # settle) at the Federal Reserve.
         sig do
           params(
             settled_at: Time,

data/rbi/increase/models/inbound_check_deposit.rbi

@@ -60,6 +60,11 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :check_transfer_id
 
+      # If this deposit is for an existing Checkbook Check, the identifier of that
+      # Checkbook Check.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :checkbook_check_id
+
       # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
       # the deposit was attempted.
       sig { returns(Time) }
@@ -134,6 +139,7 @@ module Increase
           bank_of_first_deposit_routing_number: T.nilable(String),
           check_number: T.nilable(String),
           check_transfer_id: T.nilable(String),
+          checkbook_check_id: T.nilable(String),
           created_at: Time,
           currency: Increase::InboundCheckDeposit::Currency::OrSymbol,
           declined_at: T.nilable(Time),
@@ -179,6 +185,9 @@ module Increase
         # If this deposit is for an existing Check Transfer, the identifier of that Check
         # Transfer.
         check_transfer_id:,
+        # If this deposit is for an existing Checkbook Check, the identifier of that
+        # Checkbook Check.
+        checkbook_check_id:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         # the deposit was attempted.
         created_at:,
@@ -224,6 +233,7 @@ module Increase
             bank_of_first_deposit_routing_number: T.nilable(String),
             check_number: T.nilable(String),
             check_transfer_id: T.nilable(String),
+            checkbook_check_id: T.nilable(String),
             created_at: Time,
             currency: Increase::InboundCheckDeposit::Currency::TaggedSymbol,
             declined_at: T.nilable(Time),