increase 1.69.0 → 1.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f95f2e0df86506965d6b864cb017e5bb21b21a5090193d20299fa5fbb1398f
-  data.tar.gz: 1156d84ed5ed98615c210cc8c75856468dd46ccac281bab298fc28b64d346bd2
+  metadata.gz: 911e86722b1b2a98503e220a71ed20f0638b58b42a6a4e3a0134d64980e4bf90
+  data.tar.gz: a198a4b9ac9220e5770171e87b1db368e17bbcc0c890a85f6df71417a928f8d6
 SHA512:
-  metadata.gz: 933efa417990cbdbeea6963256403823d35e5af9ca22fe7d847cf727813a05d045e685e23d4ba29ed67719a3a21e9505acab131b1e5ec88ec969a29ff27a65c4
-  data.tar.gz: ba95682b31e3dcbbccba0fee60e65221181b61a45898aa431c1ba5445b7f1665959e71a9abe757e504c3884a50cc875c694c879b3061ad914c34235914b8e7cb
+  metadata.gz: bcfe718ba7d8f08197b4e3ae0a57f2f531abb90a527563ea0e5f3d36f4ba422178b155fea1b70734869a7c9f4761f8c35c53f1d59a72ee6c44e52d56dda2df72
+  data.tar.gz: c3244899cd08066d9776b5bfae0d3281d9109239cb663a1bae4bd2b55b334a0c0362b72c0a1d0b6fa831745591cb695825cb625fcb109527e240154b9c3b5575

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # 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)
+
+### Features
+
+* **api:** api update ([2bcd14c](https://github.com/Increase/increase-ruby/commit/2bcd14c3c9056a995fdc7dc4e96d48bb2c2f06f0))
+
 ## 1.69.0 (2025-09-08)
 
 Full Changelog: [v1.68.0...v1.69.0](https://github.com/Increase/increase-ruby/compare/v1.68.0...v1.69.0)

data/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.69.0"
+gem "increase", "~> 1.71.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/entity.rb

@@ -94,8 +94,9 @@ module Increase
                -> { 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 @@ module Increase
       #
       #   @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 @@ module Increase
         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 @@ module Increase
         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.
         #

data/lib/increase/models/entity_create_params.rb

@@ -64,8 +64,9 @@ module Increase
                -> { 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 @@ module Increase
       #
       #   @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 @@ module Increase
         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 @@ module Increase
         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.
         #

data/lib/increase/models/entity_update_params.rb

@@ -36,8 +36,9 @@ module Increase
       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 @@ module Increase
       #
       #   @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
       #
@@ -75,13 +76,22 @@ module Increase
         #   @return [Increase::Models::EntityUpdateParams::Corporation::Address, nil]
         optional :address, -> { Increase::EntityUpdateParams::Corporation::Address }
 
+        # @!attribute industry_code
+        #   The North American Industry Classification System (NAICS) code for the
+        #   corporation's primary line of business. This is a number, like `5132` for
+        #   `Software Publishers`. A full list of classification codes is available
+        #   [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
+        #
+        #   @return [String, nil]
+        optional :industry_code, String
+
         # @!attribute name
         #   The legal name of the corporation.
         #
         #   @return [String, nil]
         optional :name, String
 
-        # @!method initialize(address: nil, name: nil)
+        # @!method initialize(address: nil, industry_code: nil, name: nil)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::EntityUpdateParams::Corporation} for more details.
         #
@@ -90,6 +100,8 @@ module Increase
         #
         #   @param address [Increase::Models::EntityUpdateParams::Corporation::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
         #
+        #   @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati
+        #
         #   @param name [String] The legal name of the corporation.
 
         # @see Increase::Models::EntityUpdateParams::Corporation#address
@@ -330,13 +342,13 @@ module Increase
         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
@@ -358,8 +370,9 @@ module Increase
         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.
         #

data/lib/increase/resources/entities.rb

@@ -26,7 +26,7 @@ module Increase
       #
       # @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 @@ module Increase
       #
       # @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
       #

data/lib/increase/version.rb

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

data/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,

data/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,

data/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.
@@ -162,6 +164,16 @@ module Increase
         end
         attr_writer :address
 
+        # The North American Industry Classification System (NAICS) code for the
+        # corporation's primary line of business. This is a number, like `5132` for
+        # `Software Publishers`. A full list of classification codes is available
+        # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
+        sig { returns(T.nilable(String)) }
+        attr_reader :industry_code
+
+        sig { params(industry_code: String).void }
+        attr_writer :industry_code
+
         # The legal name of the corporation.
         sig { returns(T.nilable(String)) }
         attr_reader :name
@@ -174,6 +186,7 @@ module Increase
         sig do
           params(
             address: Increase::EntityUpdateParams::Corporation::Address::OrHash,
+            industry_code: String,
             name: String
           ).returns(T.attached_class)
         end
@@ -181,6 +194,11 @@ module Increase
           # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           # are disallowed.
           address: nil,
+          # The North American Industry Classification System (NAICS) code for the
+          # corporation's primary line of business. This is a number, like `5132` for
+          # `Software Publishers`. A full list of classification codes is available
+          # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
+          industry_code: nil,
           # The legal name of the corporation.
           name: nil
         )
@@ -190,6 +208,7 @@ module Increase
           override.returns(
             {
               address: Increase::EntityUpdateParams::Corporation::Address,
+              industry_code: String,
               name: String
             }
           )
@@ -607,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,
@@ -661,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,

data/rbi/increase/resources/entities.rbi

@@ -48,8 +48,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`.
@@ -102,8 +103,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.

data/sig/increase/models/entity.rbs

@@ -740,13 +740,13 @@ module Increase
         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
 
           def self?.values: -> ::Array[Increase::Models::Entity::RiskRating::rating]

data/sig/increase/models/entity_create_params.rbs

@@ -1214,13 +1214,13 @@ module Increase
         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
 
           def self?.values: -> ::Array[Increase::Models::EntityCreateParams::RiskRating::rating]

data/sig/increase/models/entity_update_params.rbs

@@ -74,6 +74,7 @@ module Increase
       type corporation =
         {
           address: Increase::EntityUpdateParams::Corporation::Address,
+          industry_code: String,
           name: String
         }
 
@@ -84,17 +85,23 @@ module Increase
           Increase::EntityUpdateParams::Corporation::Address
         ) -> Increase::EntityUpdateParams::Corporation::Address
 
+        attr_reader industry_code: String?
+
+        def industry_code=: (String) -> String
+
         attr_reader name: String?
 
         def name=: (String) -> String
 
         def initialize: (
           ?address: Increase::EntityUpdateParams::Corporation::Address,
+          ?industry_code: String,
           ?name: String
         ) -> void
 
         def to_hash: -> {
           address: Increase::EntityUpdateParams::Corporation::Address,
+          industry_code: String,
           name: String
         }
 
@@ -298,13 +305,13 @@ module Increase
         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
 
           def self?.values: -> ::Array[Increase::Models::EntityUpdateParams::RiskRating::rating]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.69.0
+  version: 1.71.0
 platform: ruby
 authors:
 - Increase