increase 1.63.0 → 1.65.0

data/rbi/increase/models/entity_create_params.rbi

@@ -71,6 +71,18 @@ 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
+
       # Additional documentation associated with the entity.
       sig do
         returns(
@@ -121,6 +133,7 @@ module Increase
             Increase::EntityCreateParams::GovernmentAuthority::OrHash,
           joint: Increase::EntityCreateParams::Joint::OrHash,
           natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
+          risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
           supplemental_documents:
             T::Array[
               Increase::EntityCreateParams::SupplementalDocument::OrHash
@@ -150,6 +163,9 @@ 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,
         # Additional documentation associated with the entity.
         supplemental_documents: nil,
         # A reference to data stored in a third-party verification service. Your
@@ -172,6 +188,7 @@ module Increase
               Increase::EntityCreateParams::GovernmentAuthority,
             joint: Increase::EntityCreateParams::Joint,
             natural_person: Increase::EntityCreateParams::NaturalPerson,
+            risk_rating: Increase::EntityCreateParams::RiskRating,
             supplemental_documents:
               T::Array[Increase::EntityCreateParams::SupplementalDocument],
             third_party_verification:
@@ -2630,6 +2647,97 @@ 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) }
+
+          # Low
+          LOW =
+            T.let(
+              :low,
+              Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
+            )
+
+          # Medium
+          MEDIUM =
+            T.let(
+              :medium,
+              Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
+            )
+
+          # High
+          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 SupplementalDocument < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/increase/models/entity_update_params.rbi

@@ -0,0 +1,438 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::EntityUpdateParams, Increase::Internal::AnyHash)
+        end
+
+      # Details of the corporation entity to update.
+      sig { returns(T.nilable(Increase::EntityUpdateParams::Corporation)) }
+      attr_reader :corporation
+
+      sig do
+        params(
+          corporation: Increase::EntityUpdateParams::Corporation::OrHash
+        ).void
+      end
+      attr_writer :corporation
+
+      # Details of the government authority entity to update.
+      sig do
+        returns(T.nilable(Increase::EntityUpdateParams::GovernmentAuthority))
+      end
+      attr_reader :government_authority
+
+      sig do
+        params(
+          government_authority:
+            Increase::EntityUpdateParams::GovernmentAuthority::OrHash
+        ).void
+      end
+      attr_writer :government_authority
+
+      # Details of the natural person entity to update.
+      sig { returns(T.nilable(Increase::EntityUpdateParams::NaturalPerson)) }
+      attr_reader :natural_person
+
+      sig do
+        params(
+          natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash
+        ).void
+      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
+
+      # A reference to data stored in a third-party verification service. Your
+      # integration may or may not use this field.
+      sig do
+        returns(T.nilable(Increase::EntityUpdateParams::ThirdPartyVerification))
+      end
+      attr_reader :third_party_verification
+
+      sig do
+        params(
+          third_party_verification:
+            Increase::EntityUpdateParams::ThirdPartyVerification::OrHash
+        ).void
+      end
+      attr_writer :third_party_verification
+
+      # Details of the trust entity to update.
+      sig { returns(T.nilable(Increase::EntityUpdateParams::Trust)) }
+      attr_reader :trust
+
+      sig { params(trust: Increase::EntityUpdateParams::Trust::OrHash).void }
+      attr_writer :trust
+
+      sig do
+        params(
+          corporation: Increase::EntityUpdateParams::Corporation::OrHash,
+          government_authority:
+            Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
+          natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
+          risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
+          third_party_verification:
+            Increase::EntityUpdateParams::ThirdPartyVerification::OrHash,
+          trust: Increase::EntityUpdateParams::Trust::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Details of the corporation entity to update.
+        corporation: nil,
+        # Details of the government authority entity to update.
+        government_authority: nil,
+        # Details of the natural person entity to update.
+        natural_person: nil,
+        # An assessment of the entity’s potential risk of involvement in financial crimes,
+        # such as money laundering.
+        risk_rating: nil,
+        # A reference to data stored in a third-party verification service. Your
+        # integration may or may not use this field.
+        third_party_verification: nil,
+        # Details of the trust entity to update.
+        trust: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            corporation: Increase::EntityUpdateParams::Corporation,
+            government_authority:
+              Increase::EntityUpdateParams::GovernmentAuthority,
+            natural_person: Increase::EntityUpdateParams::NaturalPerson,
+            risk_rating: Increase::EntityUpdateParams::RiskRating,
+            third_party_verification:
+              Increase::EntityUpdateParams::ThirdPartyVerification,
+            trust: Increase::EntityUpdateParams::Trust,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Corporation < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityUpdateParams::Corporation,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The legal name of the corporation.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Details of the corporation entity to update.
+        sig { params(name: String).returns(T.attached_class) }
+        def self.new(
+          # The legal name of the corporation.
+          name: nil
+        )
+        end
+
+        sig { override.returns({ name: String }) }
+        def to_hash
+        end
+      end
+
+      class GovernmentAuthority < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityUpdateParams::GovernmentAuthority,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The legal name of the government authority.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Details of the government authority entity to update.
+        sig { params(name: String).returns(T.attached_class) }
+        def self.new(
+          # The legal name of the government authority.
+          name: nil
+        )
+        end
+
+        sig { override.returns({ name: String }) }
+        def to_hash
+        end
+      end
+
+      class NaturalPerson < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityUpdateParams::NaturalPerson,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The legal name of the natural person.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Details of the natural person entity to update.
+        sig { params(name: String).returns(T.attached_class) }
+        def self.new(
+          # The legal name of the natural person.
+          name: nil
+        )
+        end
+
+        sig { override.returns({ name: String }) }
+        def to_hash
+        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) }
+
+          # Low
+          LOW =
+            T.let(
+              :low,
+              Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
+            )
+
+          # Medium
+          MEDIUM =
+            T.let(
+              :medium,
+              Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
+            )
+
+          # High
+          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 ThirdPartyVerification < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityUpdateParams::ThirdPartyVerification,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The reference identifier for the third party verification.
+        sig { returns(String) }
+        attr_accessor :reference
+
+        # The vendor that was used to perform the verification.
+        sig do
+          returns(
+            Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::OrSymbol
+          )
+        end
+        attr_accessor :vendor
+
+        # A reference to data stored in a third-party verification service. Your
+        # integration may or may not use this field.
+        sig do
+          params(
+            reference: String,
+            vendor:
+              Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The reference identifier for the third party verification.
+          reference:,
+          # The vendor that was used to perform the verification.
+          vendor:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              reference: String,
+              vendor:
+                Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The vendor that was used to perform the verification.
+        module Vendor
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::EntityUpdateParams::ThirdPartyVerification::Vendor
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Alloy. See https://alloy.com for more information.
+          ALLOY =
+            T.let(
+              :alloy,
+              Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
+            )
+
+          # Middesk. See https://middesk.com for more information.
+          MIDDESK =
+            T.let(
+              :middesk,
+              Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
+            )
+
+          # Oscilar. See https://oscilar.com for more information.
+          OSCILAR =
+            T.let(
+              :oscilar,
+              Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class Trust < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityUpdateParams::Trust,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The legal name of the trust.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Details of the trust entity to update.
+        sig { params(name: String).returns(T.attached_class) }
+        def self.new(
+          # The legal name of the trust.
+          name: nil
+        )
+        end
+
+        sig { override.returns({ name: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models.rbi

@@ -265,6 +265,8 @@ module Increase
   EntityUpdateIndustryCodeParams =
     Increase::Models::EntityUpdateIndustryCodeParams
 
+  EntityUpdateParams = Increase::Models::EntityUpdateParams
+
   Event = Increase::Models::Event
 
   EventListParams = Increase::Models::EventListParams

data/rbi/increase/resources/entities.rbi

@@ -13,6 +13,7 @@ module Increase
             Increase::EntityCreateParams::GovernmentAuthority::OrHash,
           joint: Increase::EntityCreateParams::Joint::OrHash,
           natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
+          risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
           supplemental_documents:
             T::Array[
               Increase::EntityCreateParams::SupplementalDocument::OrHash
@@ -42,6 +43,9 @@ 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,
         # Additional documentation associated with the entity.
         supplemental_documents: nil,
         # A reference to data stored in a third-party verification service. Your
@@ -68,6 +72,42 @@ module Increase
       )
       end
 
+      # Update an Entity
+      sig do
+        params(
+          entity_id: String,
+          corporation: Increase::EntityUpdateParams::Corporation::OrHash,
+          government_authority:
+            Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
+          natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
+          risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
+          third_party_verification:
+            Increase::EntityUpdateParams::ThirdPartyVerification::OrHash,
+          trust: Increase::EntityUpdateParams::Trust::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Entity)
+      end
+      def update(
+        # The entity identifier.
+        entity_id,
+        # Details of the corporation entity to update.
+        corporation: nil,
+        # Details of the government authority entity to update.
+        government_authority: nil,
+        # Details of the natural person entity to update.
+        natural_person: nil,
+        # An assessment of the entity’s potential risk of involvement in financial crimes,
+        # such as money laundering.
+        risk_rating: nil,
+        # A reference to data stored in a third-party verification service. Your
+        # integration may or may not use this field.
+        third_party_verification: nil,
+        # Details of the trust entity to update.
+        trust: nil,
+        request_options: {}
+      )
+      end
+
       # List Entities
       sig do
         params(