release: 1.71.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.70.0"
+  ".": "1.71.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 217
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-438f2a4d4f35670ae5692a6a9a36711af7944ac975bf309a6d50c02a28b13a70.yml
-openapi_spec_hash: e4930cc26be238707449872070607e64
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-5d85239e5d724254ab22d922c6cad05e1c361c791ef4a578e1165158bd967753.yml
+openapi_spec_hash: b2c90485c02d643ad09954f4d88dbc25
 config_hash: e1885b38eded054b77308a024c5d80cc

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.71.0 (2025-09-08)
+
+Full Changelog: [v1.70.0...v1.71.0](https://github.com/Increase/increase-ruby/compare/v1.70.0...v1.71.0)
+
+### Features
+
+* **api:** api update ([7c069c1](https://github.com/Increase/increase-ruby/commit/7c069c1f6567eb6eb38eafbc9baafe454d621dea))
+
 ## 1.70.0 (2025-09-08)
 
 Full Changelog: [v1.69.0...v1.70.0](https://github.com/Increase/increase-ruby/compare/v1.69.0...v1.70.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    increase (1.70.0)
+    increase (1.71.0)
       connection_pool
 
 GEM

README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.70.0"
+gem "increase", "~> 1.71.0"
 ```
 
 <!-- x-release-please-end -->

lib/increase/models/entity.rb

@@ -94,8 +94,9 @@ class Entity < Increase::Internal::Type::BaseModel
                -> { Increase::Internal::Type::ArrayOf[Increase::EntitySupplementalDocument] }
 
       # @!attribute third_party_verification
-      #   A reference to data stored in a third-party verification service. Your
-      #   integration may or may not use this field.
+      #   If you are using a third-party service for identity verification, you can use
+      #   this field to associate this Entity with the identifier that represents them in
+      #   that service.
       #
       #   @return [Increase::Models::Entity::ThirdPartyVerification, nil]
       required :third_party_verification, -> { Increase::Entity::ThirdPartyVerification }, nil?: true
@@ -146,7 +147,7 @@ class Entity < Increase::Internal::Type::BaseModel
       #
       #   @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>] Additional documentation associated with the entity. This is limited to the firs
       #
-      #   @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] A reference to data stored in a third-party verification service. Your integrati
+      #   @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] If you are using a third-party service for identity verification, you can use th
       #
       #   @param trust [Increase::Models::Entity::Trust, nil] Details of the trust entity. Will be present if `structure` is equal to `trust`.
       #
@@ -960,13 +961,13 @@ class RiskRating < Increase::Internal::Type::BaseModel
         module Rating
           extend Increase::Internal::Type::Enum
 
-          # Low
+          # Minimal risk of involvement in financial crime.
           LOW = :low
 
-          # Medium
+          # Moderate risk of involvement in financial crime.
           MEDIUM = :medium
 
-          # High
+          # Elevated risk of involvement in financial crime.
           HIGH = :high
 
           # @!method self.values
@@ -1033,8 +1034,9 @@ class ThirdPartyVerification < Increase::Internal::Type::BaseModel
         required :vendor, enum: -> { Increase::Entity::ThirdPartyVerification::Vendor }
 
         # @!method initialize(reference:, vendor:)
-        #   A reference to data stored in a third-party verification service. Your
-        #   integration may or may not use this field.
+        #   If you are using a third-party service for identity verification, you can use
+        #   this field to associate this Entity with the identifier that represents them in
+        #   that service.
         #
         #   @param reference [String] The reference identifier for the third party verification.
         #

lib/increase/models/entity_create_params.rb

@@ -64,8 +64,9 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel
                -> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::SupplementalDocument] }
 
       # @!attribute third_party_verification
-      #   A reference to data stored in a third-party verification service. Your
-      #   integration may or may not use this field.
+      #   If you are using a third-party service for identity verification, you can use
+      #   this field to associate this Entity with the identifier that represents them in
+      #   that service.
       #
       #   @return [Increase::Models::EntityCreateParams::ThirdPartyVerification, nil]
       optional :third_party_verification, -> { Increase::EntityCreateParams::ThirdPartyVerification }
@@ -97,7 +98,7 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel
       #
       #   @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
       #
-      #   @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
+      #   @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
       #
       #   @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
       #
@@ -1476,13 +1477,13 @@ class RiskRating < Increase::Internal::Type::BaseModel
         module Rating
           extend Increase::Internal::Type::Enum
 
-          # Low
+          # Minimal risk of involvement in financial crime.
           LOW = :low
 
-          # Medium
+          # Moderate risk of involvement in financial crime.
           MEDIUM = :medium
 
-          # High
+          # Elevated risk of involvement in financial crime.
           HIGH = :high
 
           # @!method self.values
@@ -1515,8 +1516,9 @@ class ThirdPartyVerification < Increase::Internal::Type::BaseModel
         required :vendor, enum: -> { Increase::EntityCreateParams::ThirdPartyVerification::Vendor }
 
         # @!method initialize(reference:, vendor:)
-        #   A reference to data stored in a third-party verification service. Your
-        #   integration may or may not use this field.
+        #   If you are using a third-party service for identity verification, you can use
+        #   this field to associate this Entity with the identifier that represents them in
+        #   that service.
         #
         #   @param reference [String] The reference identifier for the third party verification.
         #

lib/increase/models/entity_update_params.rb

@@ -36,8 +36,9 @@ class EntityUpdateParams < Increase::Internal::Type::BaseModel
       optional :risk_rating, -> { Increase::EntityUpdateParams::RiskRating }
 
       # @!attribute third_party_verification
-      #   A reference to data stored in a third-party verification service. Your
-      #   integration may or may not use this field.
+      #   If you are using a third-party service for identity verification, you can use
+      #   this field to associate this Entity with the identifier that represents them in
+      #   that service.
       #
       #   @return [Increase::Models::EntityUpdateParams::ThirdPartyVerification, nil]
       optional :third_party_verification, -> { Increase::EntityUpdateParams::ThirdPartyVerification }
@@ -61,7 +62,7 @@ class EntityUpdateParams < Increase::Internal::Type::BaseModel
       #
       #   @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
       #
-      #   @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
+      #   @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
       #
       #   @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update. If you specify this parameter and the ent
       #
@@ -341,13 +342,13 @@ class RiskRating < Increase::Internal::Type::BaseModel
         module Rating
           extend Increase::Internal::Type::Enum
 
-          # Low
+          # Minimal risk of involvement in financial crime.
           LOW = :low
 
-          # Medium
+          # Moderate risk of involvement in financial crime.
           MEDIUM = :medium
 
-          # High
+          # Elevated risk of involvement in financial crime.
           HIGH = :high
 
           # @!method self.values
@@ -369,8 +370,9 @@ class ThirdPartyVerification < Increase::Internal::Type::BaseModel
         required :vendor, enum: -> { Increase::EntityUpdateParams::ThirdPartyVerification::Vendor }
 
         # @!method initialize(reference:, vendor:)
-        #   A reference to data stored in a third-party verification service. Your
-        #   integration may or may not use this field.
+        #   If you are using a third-party service for identity verification, you can use
+        #   this field to associate this Entity with the identifier that represents them in
+        #   that service.
         #
         #   @param reference [String] The reference identifier for the third party verification.
         #

lib/increase/resources/entities.rb

@@ -26,7 +26,7 @@ class Entities
       #
       # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
       #
-      # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
+      # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
       #
       # @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
       #
@@ -83,7 +83,7 @@ def retrieve(entity_id, params = {})
       #
       # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
       #
-      # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
+      # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
       #
       # @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update. If you specify this parameter and the ent
       #

lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.70.0"
+  VERSION = "1.71.0"
 end

rbi/increase/models/entity.rbi

@@ -100,8 +100,9 @@ module Increase
       sig { returns(T::Array[Increase::EntitySupplementalDocument]) }
       attr_accessor :supplemental_documents
 
-      # A reference to data stored in a third-party verification service. Your
-      # integration may or may not use this field.
+      # If you are using a third-party service for identity verification, you can use
+      # this field to associate this Entity with the identifier that represents them in
+      # that service.
       sig { returns(T.nilable(Increase::Entity::ThirdPartyVerification)) }
       attr_reader :third_party_verification
 
@@ -187,8 +188,9 @@ module Increase
         # first 10 documents for an entity. If an entity has more than 10 documents, use
         # the GET /entity_supplemental_documents list endpoint to retrieve them.
         supplemental_documents:,
-        # A reference to data stored in a third-party verification service. Your
-        # integration may or may not use this field.
+        # If you are using a third-party service for identity verification, you can use
+        # this field to associate this Entity with the identifier that represents them in
+        # that service.
         third_party_verification:,
         # Details of the trust entity. Will be present if `structure` is equal to `trust`.
         trust:,
@@ -1640,14 +1642,14 @@ module Increase
             T.type_alias { T.all(Symbol, Increase::Entity::RiskRating::Rating) }
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          # Low
+          # Minimal risk of involvement in financial crime.
           LOW = T.let(:low, Increase::Entity::RiskRating::Rating::TaggedSymbol)
 
-          # Medium
+          # Moderate risk of involvement in financial crime.
           MEDIUM =
             T.let(:medium, Increase::Entity::RiskRating::Rating::TaggedSymbol)
 
-          # High
+          # Elevated risk of involvement in financial crime.
           HIGH =
             T.let(:high, Increase::Entity::RiskRating::Rating::TaggedSymbol)
 
@@ -1741,8 +1743,9 @@ module Increase
         end
         attr_accessor :vendor
 
-        # A reference to data stored in a third-party verification service. Your
-        # integration may or may not use this field.
+        # If you are using a third-party service for identity verification, you can use
+        # this field to associate this Entity with the identifier that represents them in
+        # that service.
         sig do
           params(
             reference: String,

rbi/increase/models/entity_create_params.rbi

@@ -101,8 +101,9 @@ module Increase
       end
       attr_writer :supplemental_documents
 
-      # A reference to data stored in a third-party verification service. Your
-      # integration may or may not use this field.
+      # If you are using a third-party service for identity verification, you can use
+      # this field to associate this Entity with the identifier that represents them in
+      # that service.
       sig do
         returns(T.nilable(Increase::EntityCreateParams::ThirdPartyVerification))
       end
@@ -168,8 +169,9 @@ module Increase
         risk_rating: nil,
         # Additional documentation associated with the entity.
         supplemental_documents: nil,
-        # A reference to data stored in a third-party verification service. Your
-        # integration may or may not use this field.
+        # If you are using a third-party service for identity verification, you can use
+        # this field to associate this Entity with the identifier that represents them in
+        # that service.
         third_party_verification: nil,
         # Details of the trust entity to create. Required if `structure` is equal to
         # `trust`.
@@ -2705,21 +2707,21 @@ module Increase
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          # Low
+          # Minimal risk of involvement in financial crime.
           LOW =
             T.let(
               :low,
               Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
             )
 
-          # Medium
+          # Moderate risk of involvement in financial crime.
           MEDIUM =
             T.let(
               :medium,
               Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
             )
 
-          # High
+          # Elevated risk of involvement in financial crime.
           HIGH =
             T.let(
               :high,
@@ -2784,8 +2786,9 @@ module Increase
         end
         attr_accessor :vendor
 
-        # A reference to data stored in a third-party verification service. Your
-        # integration may or may not use this field.
+        # If you are using a third-party service for identity verification, you can use
+        # this field to associate this Entity with the identifier that represents them in
+        # that service.
         sig do
           params(
             reference: String,

rbi/increase/models/entity_update_params.rbi

@@ -62,8 +62,9 @@ module Increase
       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.
+      # If you are using a third-party service for identity verification, you can use
+      # this field to associate this Entity with the identifier that represents them in
+      # that service.
       sig do
         returns(T.nilable(Increase::EntityUpdateParams::ThirdPartyVerification))
       end
@@ -111,8 +112,9 @@ module Increase
         # 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.
+        # If you are using a third-party service for identity verification, you can use
+        # this field to associate this Entity with the identifier that represents them in
+        # that service.
         third_party_verification: nil,
         # Details of the trust entity to update. If you specify this parameter and the
         # entity is not a trust, the request will fail.
@@ -624,21 +626,21 @@ module Increase
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          # Low
+          # Minimal risk of involvement in financial crime.
           LOW =
             T.let(
               :low,
               Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
             )
 
-          # Medium
+          # Moderate risk of involvement in financial crime.
           MEDIUM =
             T.let(
               :medium,
               Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
             )
 
-          # High
+          # Elevated risk of involvement in financial crime.
           HIGH =
             T.let(
               :high,
@@ -678,8 +680,9 @@ module Increase
         end
         attr_accessor :vendor
 
-        # A reference to data stored in a third-party verification service. Your
-        # integration may or may not use this field.
+        # If you are using a third-party service for identity verification, you can use
+        # this field to associate this Entity with the identifier that represents them in
+        # that service.
         sig do
           params(
             reference: String,