increase 1.238.0 → 1.239.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cd452b5f692eb289cabcbf215f22fbf75d71debe34aae6cb3c66d6638354e20
-  data.tar.gz: 78b3d39e88f1062a7e8124f27d0aa430f81486c28bd69b463a1e65a9abaca851
+  metadata.gz: 68b25ad092849f14357d0e14badb9dc474f02a8e5c4ec6f7e7e5994d19d3e062
+  data.tar.gz: 13a6c13e98500137399c5674e8978ae72c1b558fec0abcbb325dc40db8739c51
 SHA512:
-  metadata.gz: 632012f4711e028e15acf41c224dd6ccef2502093f2182df7d95b86990fed70819515679f2e25b1fc7e2e4074c723b804856b20ae76ac1466f468364ad7781a5
-  data.tar.gz: 53b5abc0a2762b7ed248208ebb5ea0b686a24a8a9e141cc27c1172071803333573f687305b6fd5f28c510aa378ae6de7512f7bfc81e00a9c386770c7256eba90
+  metadata.gz: bcdc889c8b54f700658571d76fb216122e474d9d16efe586f3d15273841ec13951105075cc2840d44df325d6d570a3c11ddfdea36863da63717c3b74b6a7a770
+  data.tar.gz: 72053d1b2aa394adce52cac31af22e4504eee78b00765d98ff960b58e898841203ba7b5376370fb48222b004bbbaa6bacac138f059f8621770066abee8919650

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.239.0 (2026-03-10)
+
+Full Changelog: [v1.238.0...v1.239.0](https://github.com/Increase/increase-ruby/compare/v1.238.0...v1.239.0)
+
+### Features
+
+* **api:** api update ([1431693](https://github.com/Increase/increase-ruby/commit/14316937bb3c4a431a0beae5bb85a37b6d6910a0))
+
 ## 1.238.0 (2026-03-09)
 
 Full Changelog: [v1.237.0...v1.238.0](https://github.com/Increase/increase-ruby/compare/v1.237.0...v1.238.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.238.0"
+gem "increase", "~> 1.239.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/client.rb

@@ -125,6 +125,9 @@ module Increase
     # @return [Increase::Resources::Entities]
     attr_reader :entities
 
+    # @return [Increase::Resources::BeneficialOwners]
+    attr_reader :beneficial_owners
+
     # @return [Increase::Resources::SupplementalDocuments]
     attr_reader :supplemental_documents
 
@@ -291,6 +294,7 @@ module Increase
       @routing_numbers = Increase::Resources::RoutingNumbers.new(client: self)
       @external_accounts = Increase::Resources::ExternalAccounts.new(client: self)
       @entities = Increase::Resources::Entities.new(client: self)
+      @beneficial_owners = Increase::Resources::BeneficialOwners.new(client: self)
       @supplemental_documents = Increase::Resources::SupplementalDocuments.new(client: self)
       @programs = Increase::Resources::Programs.new(client: self)
       @account_statements = Increase::Resources::AccountStatements.new(client: self)

data/lib/increase/models/beneficial_owner_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BeneficialOwners#list
+    class BeneficialOwnerListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute entity_id
+      #   The identifier of the Entity to list beneficial owners for. Only `corporation`
+      #   entities have beneficial owners.
+      #
+      #   @return [String]
+      required :entity_id, String
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute idempotency_key
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that object. This value is unique across Increase and is used to ensure that a
+      #   request is only processed once. Learn more about
+      #   [idempotency](https://increase.com/documentation/idempotency-keys).
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BeneficialOwnerListParams} for more details.
+      #
+      #   @param entity_id [String] The identifier of the Entity to list beneficial owners for. Only `corporation` e
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/beneficial_owner_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BeneficialOwners#retrieve
+    class BeneficialOwnerRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute entity_beneficial_owner_id
+      #   The identifier of the Beneficial Owner to retrieve.
+      #
+      #   @return [String]
+      required :entity_beneficial_owner_id, String
+
+      # @!method initialize(entity_beneficial_owner_id:, request_options: {})
+      #   @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to retrieve.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/entity.rb

@@ -174,9 +174,8 @@ module Increase
         #   The identifying details of anyone controlling or owning 25% or more of the
         #   corporation.
         #
-        #   @return [Array<Increase::Models::Entity::Corporation::BeneficialOwner>]
-        required :beneficial_owners,
-                 -> { Increase::Internal::Type::ArrayOf[Increase::Entity::Corporation::BeneficialOwner] }
+        #   @return [Array<Increase::Models::EntityBeneficialOwner>]
+        required :beneficial_owners, -> { Increase::Internal::Type::ArrayOf[Increase::EntityBeneficialOwner] }
 
         # @!attribute email
         #   An email address for the business.
@@ -225,7 +224,7 @@ module Increase
         #
         #   @param address [Increase::Models::Entity::Corporation::Address] The corporation's address.
         #
-        #   @param beneficial_owners [Array<Increase::Models::Entity::Corporation::BeneficialOwner>] The identifying details of anyone controlling or owning 25% or more of the corpo
+        #   @param beneficial_owners [Array<Increase::Models::EntityBeneficialOwner>] The identifying details of anyone controlling or owning 25% or more of the corpo
         #
         #   @param email [String, nil] An email address for the business.
         #
@@ -288,209 +287,6 @@ module Increase
           #
           #   @param zip [String] The ZIP code of the address.
         end
-
-        class BeneficialOwner < Increase::Internal::Type::BaseModel
-          # @!attribute id
-          #   The identifier of this beneficial owner.
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute company_title
-          #   This person's role or title within the entity.
-          #
-          #   @return [String, nil]
-          required :company_title, String, nil?: true
-
-          # @!attribute individual
-          #   Personal details for the beneficial owner.
-          #
-          #   @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual]
-          required :individual, -> { Increase::Entity::Corporation::BeneficialOwner::Individual }
-
-          # @!attribute prongs
-          #   Why this person is considered a beneficial owner of the entity.
-          #
-          #   @return [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>]
-          required :prongs,
-                   -> { Increase::Internal::Type::ArrayOf[enum: Increase::Entity::Corporation::BeneficialOwner::Prong] }
-
-          # @!method initialize(id:, company_title:, individual:, prongs:)
-          #   @param id [String] The identifier of this beneficial owner.
-          #
-          #   @param company_title [String, nil] This person's role or title within the entity.
-          #
-          #   @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] Personal details for the beneficial owner.
-          #
-          #   @param prongs [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>] Why this person is considered a beneficial owner of the entity.
-
-          # @see Increase::Models::Entity::Corporation::BeneficialOwner#individual
-          class Individual < Increase::Internal::Type::BaseModel
-            # @!attribute address
-            #   The person's address.
-            #
-            #   @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address]
-            required :address, -> { Increase::Entity::Corporation::BeneficialOwner::Individual::Address }
-
-            # @!attribute date_of_birth
-            #   The person's date of birth in YYYY-MM-DD format.
-            #
-            #   @return [Date]
-            required :date_of_birth, Date
-
-            # @!attribute identification
-            #   A means of verifying the person's identity.
-            #
-            #   @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification]
-            required :identification,
-                     -> { Increase::Entity::Corporation::BeneficialOwner::Individual::Identification }
-
-            # @!attribute name
-            #   The person's legal name.
-            #
-            #   @return [String]
-            required :name, String
-
-            # @!method initialize(address:, date_of_birth:, identification:, name:)
-            #   Personal details for the beneficial owner.
-            #
-            #   @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] The person's address.
-            #
-            #   @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
-            #
-            #   @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification] A means of verifying the person's identity.
-            #
-            #   @param name [String] The person's legal name.
-
-            # @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#address
-            class Address < Increase::Internal::Type::BaseModel
-              # @!attribute city
-              #   The city, district, town, or village of the address.
-              #
-              #   @return [String, nil]
-              required :city, String, nil?: true
-
-              # @!attribute country
-              #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              #
-              #   @return [String]
-              required :country, String
-
-              # @!attribute line1
-              #   The first line of the address.
-              #
-              #   @return [String]
-              required :line1, String
-
-              # @!attribute line2
-              #   The second line of the address.
-              #
-              #   @return [String, nil]
-              required :line2, String, nil?: true
-
-              # @!attribute state
-              #   The two-letter United States Postal Service (USPS) abbreviation for the US
-              #   state, province, or region of the address.
-              #
-              #   @return [String, nil]
-              required :state, String, nil?: true
-
-              # @!attribute zip
-              #   The ZIP or postal code of the address.
-              #
-              #   @return [String, nil]
-              required :zip, String, nil?: true
-
-              # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
-              #   Some parameter documentations has been truncated, see
-              #   {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address}
-              #   for more details.
-              #
-              #   The person's address.
-              #
-              #   @param city [String, nil] The city, district, town, or village of the address.
-              #
-              #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              #
-              #   @param line1 [String] The first line of the address.
-              #
-              #   @param line2 [String, nil] The second line of the address.
-              #
-              #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
-              #
-              #   @param zip [String, nil] The ZIP or postal code of the address.
-            end
-
-            # @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#identification
-            class Identification < Increase::Internal::Type::BaseModel
-              # @!attribute method_
-              #   A method that can be used to verify the individual's identity.
-              #
-              #   @return [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method]
-              required :method_,
-                       enum: -> {
-                         Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method
-                       },
-                       api_name: :method
-
-              # @!attribute number_last4
-              #   The last 4 digits of the identification number that can be used to verify the
-              #   individual's identity.
-              #
-              #   @return [String]
-              required :number_last4, String
-
-              # @!method initialize(method_:, number_last4:)
-              #   Some parameter documentations has been truncated, see
-              #   {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification}
-              #   for more details.
-              #
-              #   A means of verifying the person's identity.
-              #
-              #   @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity.
-              #
-              #   @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
-
-              # A method that can be used to verify the individual's identity.
-              #
-              # @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification#method_
-              module Method
-                extend Increase::Internal::Type::Enum
-
-                # A social security number.
-                SOCIAL_SECURITY_NUMBER = :social_security_number
-
-                # An individual taxpayer identification number (ITIN).
-                INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
-
-                # A passport number.
-                PASSPORT = :passport
-
-                # A driver's license number.
-                DRIVERS_LICENSE = :drivers_license
-
-                # Another identifying document.
-                OTHER = :other
-
-                # @!method self.values
-                #   @return [Array<Symbol>]
-              end
-            end
-          end
-
-          module Prong
-            extend Increase::Internal::Type::Enum
-
-            # A person with 25% or greater direct or indirect ownership of the entity.
-            OWNERSHIP = :ownership
-
-            # A person who manages, directs, or has significant control of the entity.
-            CONTROL = :control
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
       end
 
       # @see Increase::Models::Entity#government_authority

data/lib/increase/models/entity_beneficial_owner.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BeneficialOwners#retrieve
+    class EntityBeneficialOwner < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The identifier of this beneficial owner.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute company_title
+      #   This person's role or title within the entity.
+      #
+      #   @return [String, nil]
+      required :company_title, String, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+      #   Beneficial Owner was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute individual
+      #   Personal details for the beneficial owner.
+      #
+      #   @return [Increase::Models::EntityBeneficialOwner::Individual]
+      required :individual, -> { Increase::EntityBeneficialOwner::Individual }
+
+      # @!attribute prongs
+      #   Why this person is considered a beneficial owner of the entity.
+      #
+      #   @return [Array<Symbol, Increase::Models::EntityBeneficialOwner::Prong>]
+      required :prongs, -> { Increase::Internal::Type::ArrayOf[enum: Increase::EntityBeneficialOwner::Prong] }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `entity_beneficial_owner`.
+      #
+      #   @return [Symbol, Increase::Models::EntityBeneficialOwner::Type]
+      required :type, enum: -> { Increase::EntityBeneficialOwner::Type }
+
+      # @!method initialize(id:, company_title:, created_at:, individual:, prongs:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::EntityBeneficialOwner} for more details.
+      #
+      #   @param id [String] The identifier of this beneficial owner.
+      #
+      #   @param company_title [String, nil] This person's role or title within the entity.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Benefic
+      #
+      #   @param individual [Increase::Models::EntityBeneficialOwner::Individual] Personal details for the beneficial owner.
+      #
+      #   @param prongs [Array<Symbol, Increase::Models::EntityBeneficialOwner::Prong>] Why this person is considered a beneficial owner of the entity.
+      #
+      #   @param type [Symbol, Increase::Models::EntityBeneficialOwner::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::EntityBeneficialOwner#individual
+      class Individual < Increase::Internal::Type::BaseModel
+        # @!attribute address
+        #   The person's address.
+        #
+        #   @return [Increase::Models::EntityBeneficialOwner::Individual::Address]
+        required :address, -> { Increase::EntityBeneficialOwner::Individual::Address }
+
+        # @!attribute date_of_birth
+        #   The person's date of birth in YYYY-MM-DD format.
+        #
+        #   @return [Date]
+        required :date_of_birth, Date
+
+        # @!attribute identification
+        #   A means of verifying the person's identity.
+        #
+        #   @return [Increase::Models::EntityBeneficialOwner::Individual::Identification]
+        required :identification, -> { Increase::EntityBeneficialOwner::Individual::Identification }
+
+        # @!attribute name
+        #   The person's legal name.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(address:, date_of_birth:, identification:, name:)
+        #   Personal details for the beneficial owner.
+        #
+        #   @param address [Increase::Models::EntityBeneficialOwner::Individual::Address] The person's address.
+        #
+        #   @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
+        #
+        #   @param identification [Increase::Models::EntityBeneficialOwner::Individual::Identification] A means of verifying the person's identity.
+        #
+        #   @param name [String] The person's legal name.
+
+        # @see Increase::Models::EntityBeneficialOwner::Individual#address
+        class Address < Increase::Internal::Type::BaseModel
+          # @!attribute city
+          #   The city, district, town, or village of the address.
+          #
+          #   @return [String, nil]
+          required :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          #   @return [String]
+          required :country, String
+
+          # @!attribute line1
+          #   The first line of the address.
+          #
+          #   @return [String]
+          required :line1, String
+
+          # @!attribute line2
+          #   The second line of the address.
+          #
+          #   @return [String, nil]
+          required :line2, String, nil?: true
+
+          # @!attribute state
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address.
+          #
+          #   @return [String, nil]
+          required :state, String, nil?: true
+
+          # @!attribute zip
+          #   The ZIP or postal code of the address.
+          #
+          #   @return [String, nil]
+          required :zip, String, nil?: true
+
+          # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::EntityBeneficialOwner::Individual::Address} for more details.
+          #
+          #   The person's address.
+          #
+          #   @param city [String, nil] The city, district, town, or village of the address.
+          #
+          #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          #   @param line1 [String] The first line of the address.
+          #
+          #   @param line2 [String, nil] The second line of the address.
+          #
+          #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
+          #
+          #   @param zip [String, nil] The ZIP or postal code of the address.
+        end
+
+        # @see Increase::Models::EntityBeneficialOwner::Individual#identification
+        class Identification < Increase::Internal::Type::BaseModel
+          # @!attribute method_
+          #   A method that can be used to verify the individual's identity.
+          #
+          #   @return [Symbol, Increase::Models::EntityBeneficialOwner::Individual::Identification::Method]
+          required :method_,
+                   enum: -> { Increase::EntityBeneficialOwner::Individual::Identification::Method },
+                   api_name: :method
+
+          # @!attribute number_last4
+          #   The last 4 digits of the identification number that can be used to verify the
+          #   individual's identity.
+          #
+          #   @return [String]
+          required :number_last4, String
+
+          # @!method initialize(method_:, number_last4:)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::EntityBeneficialOwner::Individual::Identification} for more
+          #   details.
+          #
+          #   A means of verifying the person's identity.
+          #
+          #   @param method_ [Symbol, Increase::Models::EntityBeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity.
+          #
+          #   @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
+
+          # A method that can be used to verify the individual's identity.
+          #
+          # @see Increase::Models::EntityBeneficialOwner::Individual::Identification#method_
+          module Method
+            extend Increase::Internal::Type::Enum
+
+            # A social security number.
+            SOCIAL_SECURITY_NUMBER = :social_security_number
+
+            # An individual taxpayer identification number (ITIN).
+            INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
+
+            # A passport number.
+            PASSPORT = :passport
+
+            # A driver's license number.
+            DRIVERS_LICENSE = :drivers_license
+
+            # Another identifying document.
+            OTHER = :other
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      module Prong
+        extend Increase::Internal::Type::Enum
+
+        # A person with 25% or greater direct or indirect ownership of the entity.
+        OWNERSHIP = :ownership
+
+        # A person who manages, directs, or has significant control of the entity.
+        CONTROL = :control
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `entity_beneficial_owner`.
+      #
+      # @see Increase::Models::EntityBeneficialOwner#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        ENTITY_BENEFICIAL_OWNER = :entity_beneficial_owner
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models.rb

@@ -103,6 +103,10 @@ module Increase
 
   BalanceLookup = Increase::Models::BalanceLookup
 
+  BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
+
+  BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams
+
   BookkeepingAccount = Increase::Models::BookkeepingAccount
 
   BookkeepingAccountBalanceParams = Increase::Models::BookkeepingAccountBalanceParams
@@ -255,6 +259,8 @@ module Increase
 
   EntityArchiveParams = Increase::Models::EntityArchiveParams
 
+  EntityBeneficialOwner = Increase::Models::EntityBeneficialOwner
+
   EntityCreateBeneficialOwnerParams = Increase::Models::EntityCreateBeneficialOwnerParams
 
   EntityCreateParams = Increase::Models::EntityCreateParams