increase 1.249.0 → 1.250.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6d29b041450200bb88388771c55b17f0104bb8aceff767203d3f5bd8191b8d6
-  data.tar.gz: 96f4a1b38b6b9902e3642e1252a03a90a6957a14eca676c8bc9c5e14037cb098
+  metadata.gz: 482e24a49b50e6d1a98949b016d8b3b389f2149eef96fb31f4753e66b7978b59
+  data.tar.gz: 26b3535b4cbe13b5f36f6a4275766fafc8bfcd8aacca33397271abe805bb9da7
 SHA512:
-  metadata.gz: 9e6ba219824d84bd1d84cfb1aa64635e0ad5bcda16e97efd24e65cf96a7509bcb280c97d151af8a35b0ee511711857c3c33bfb8581c20f00fb109ff9bea461a8
-  data.tar.gz: f9e75fa8f63ab1132723c55d22ae0f7b4d561e6fd9998820f96a0156546d507bc741240113b6bb054bf7eda98a935597b38b5b613250670de438b1d5b81edc9c
+  metadata.gz: 96a7a7c649c76a77c84ad2640fe628104d34f37c78758c1ed163ecd8783cfff2b4563944871628cde5ef70d168804e40ccdfdcb8b3f69d8fcd0bda29ca4befa9
+  data.tar.gz: ec7ae0fd1834d2766e50d08a92b782c3fef353b05569337060a3fb0f45ede47a1f1873afb2b8596e415ebad6d304485cb02a0ff028c1ca7bc5d573931213ade8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.250.0 (2026-03-12)
+
+Full Changelog: [v1.249.0...v1.250.0](https://github.com/Increase/increase-ruby/compare/v1.249.0...v1.250.0)
+
+### Features
+
+* **api:** api update ([7ebc531](https://github.com/Increase/increase-ruby/commit/7ebc5310d5083507af85b1550834fd7cf8197c6a))
+
 ## 1.249.0 (2026-03-12)
 
 Full Changelog: [v1.248.0...v1.249.0](https://github.com/Increase/increase-ruby/compare/v1.248.0...v1.249.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.249.0"
+gem "increase", "~> 1.250.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/beneficial_owner_create_params.rb

@@ -0,0 +1,387 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BeneficialOwners#create
+    class BeneficialOwnerCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute entity_id
+      #   The identifier of the Entity to associate with the new Beneficial Owner.
+      #
+      #   @return [String]
+      required :entity_id, String
+
+      # @!attribute individual
+      #   Personal details for the beneficial owner.
+      #
+      #   @return [Increase::Models::BeneficialOwnerCreateParams::Individual]
+      required :individual, -> { Increase::BeneficialOwnerCreateParams::Individual }
+
+      # @!attribute prongs
+      #   Why this person is considered a beneficial owner of the entity. At least one
+      #   option is required, if a person is both a control person and owner, submit an
+      #   array containing both.
+      #
+      #   @return [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>]
+      required :prongs,
+               -> { Increase::Internal::Type::ArrayOf[enum: Increase::BeneficialOwnerCreateParams::Prong] }
+
+      # @!attribute company_title
+      #   This person's role or title within the entity.
+      #
+      #   @return [String, nil]
+      optional :company_title, String
+
+      # @!method initialize(entity_id:, individual:, prongs:, company_title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BeneficialOwnerCreateParams} for more details.
+      #
+      #   @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner.
+      #
+      #   @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual] Personal details for the beneficial owner.
+      #
+      #   @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
+      #
+      #   @param company_title [String] This person's role or title within the entity.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Individual < Increase::Internal::Type::BaseModel
+        # @!attribute address
+        #   The individual's physical address. Mail receiving locations like PO Boxes and
+        #   PMB's are disallowed.
+        #
+        #   @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Address]
+        required :address, -> { Increase::BeneficialOwnerCreateParams::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::BeneficialOwnerCreateParams::Individual::Identification]
+        required :identification, -> { Increase::BeneficialOwnerCreateParams::Individual::Identification }
+
+        # @!attribute name
+        #   The person's legal name.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute confirmed_no_us_tax_id
+        #   The identification method for an individual can only be a passport, driver's
+        #   license, or other document if you've confirmed the individual does not have a US
+        #   tax id (either a Social Security Number or Individual Taxpayer Identification
+        #   Number).
+        #
+        #   @return [Boolean, nil]
+        optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
+
+        # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::BeneficialOwnerCreateParams::Individual} for more details.
+        #
+        #   Personal details for the beneficial owner.
+        #
+        #   @param address [Increase::Models::BeneficialOwnerCreateParams::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
+        #
+        #   @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
+        #
+        #   @param identification [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification] A means of verifying the person's identity.
+        #
+        #   @param name [String] The person's legal name.
+        #
+        #   @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
+
+        # @see Increase::Models::BeneficialOwnerCreateParams::Individual#address
+        class Address < Increase::Internal::Type::BaseModel
+          # @!attribute city
+          #   The city, district, town, or village of the address.
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!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. This is usually the street number and street.
+          #
+          #   @return [String]
+          required :line1, String
+
+          # @!attribute line2
+          #   The second line of the address. This might be the floor or room number.
+          #
+          #   @return [String, nil]
+          optional :line2, String
+
+          # @!attribute state
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address. Required in certain countries.
+          #
+          #   @return [String, nil]
+          optional :state, String
+
+          # @!attribute zip
+          #   The ZIP or postal code of the address. Required in certain countries.
+          #
+          #   @return [String, nil]
+          optional :zip, String
+
+          # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Address} for more
+          #   details.
+          #
+          #   The individual's physical address. Mail receiving locations like PO Boxes and
+          #   PMB's are disallowed.
+          #
+          #   @param city [String] 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. This is usually the street number and street.
+          #
+          #   @param line2 [String] The second line of the address. This might be the floor or room number.
+          #
+          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
+          #
+          #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
+        end
+
+        # @see Increase::Models::BeneficialOwnerCreateParams::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::BeneficialOwnerCreateParams::Individual::Identification::Method]
+          required :method_,
+                   enum: -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::Method },
+                   api_name: :method
+
+          # @!attribute number
+          #   An identification number that can be used to verify the individual's identity,
+          #   such as a social security number.
+          #
+          #   @return [String]
+          required :number, String
+
+          # @!attribute drivers_license
+          #   Information about the United States driver's license used for identification.
+          #   Required if `method` is equal to `drivers_license`.
+          #
+          #   @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense, nil]
+          optional :drivers_license,
+                   -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense }
+
+          # @!attribute other
+          #   Information about the identification document provided. Required if `method` is
+          #   equal to `other`.
+          #
+          #   @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other, nil]
+          optional :other, -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::Other }
+
+          # @!attribute passport
+          #   Information about the passport used for identification. Required if `method` is
+          #   equal to `passport`.
+          #
+          #   @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport, nil]
+          optional :passport, -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport }
+
+          # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification} for
+          #   more details.
+          #
+          #   A means of verifying the person's identity.
+          #
+          #   @param method_ [Symbol, Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Method] A method that can be used to verify the individual's identity.
+          #
+          #   @param number [String] An identification number that can be used to verify the individual's identity, s
+          #
+          #   @param drivers_license [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
+          #
+          #   @param other [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other] Information about the identification document provided. Required if `method` is
+          #
+          #   @param passport [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is
+
+          # A method that can be used to verify the individual's identity.
+          #
+          # @see Increase::Models::BeneficialOwnerCreateParams::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
+
+          # @see Increase::Models::BeneficialOwnerCreateParams::Individual::Identification#drivers_license
+          class DriversLicense < Increase::Internal::Type::BaseModel
+            # @!attribute expiration_date
+            #   The driver's license's expiration date in YYYY-MM-DD format.
+            #
+            #   @return [Date]
+            required :expiration_date, Date
+
+            # @!attribute file_id
+            #   The identifier of the File containing the front of the driver's license.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute state
+            #   The state that issued the provided driver's license.
+            #
+            #   @return [String]
+            required :state, String
+
+            # @!attribute back_file_id
+            #   The identifier of the File containing the back of the driver's license.
+            #
+            #   @return [String, nil]
+            optional :back_file_id, String
+
+            # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
+            #   Information about the United States driver's license used for identification.
+            #   Required if `method` is equal to `drivers_license`.
+            #
+            #   @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
+            #
+            #   @param file_id [String] The identifier of the File containing the front of the driver's license.
+            #
+            #   @param state [String] The state that issued the provided driver's license.
+            #
+            #   @param back_file_id [String] The identifier of the File containing the back of the driver's license.
+          end
+
+          # @see Increase::Models::BeneficialOwnerCreateParams::Individual::Identification#other
+          class Other < Increase::Internal::Type::BaseModel
+            # @!attribute country
+            #   The two-character ISO 3166-1 code representing the country that issued the
+            #   document (e.g., `US`).
+            #
+            #   @return [String]
+            required :country, String
+
+            # @!attribute description
+            #   A description of the document submitted.
+            #
+            #   @return [String]
+            required :description, String
+
+            # @!attribute file_id
+            #   The identifier of the File containing the front of the document.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute back_file_id
+            #   The identifier of the File containing the back of the document. Not every
+            #   document has a reverse side.
+            #
+            #   @return [String, nil]
+            optional :back_file_id, String
+
+            # @!attribute expiration_date
+            #   The document's expiration date in YYYY-MM-DD format.
+            #
+            #   @return [Date, nil]
+            optional :expiration_date, Date
+
+            # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other}
+            #   for more details.
+            #
+            #   Information about the identification document provided. Required if `method` is
+            #   equal to `other`.
+            #
+            #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+            #
+            #   @param description [String] A description of the document submitted.
+            #
+            #   @param file_id [String] The identifier of the File containing the front of the document.
+            #
+            #   @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
+            #
+            #   @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
+          end
+
+          # @see Increase::Models::BeneficialOwnerCreateParams::Individual::Identification#passport
+          class Passport < Increase::Internal::Type::BaseModel
+            # @!attribute country
+            #   The two-character ISO 3166-1 code representing the country that issued the
+            #   document (e.g., `US`).
+            #
+            #   @return [String]
+            required :country, String
+
+            # @!attribute expiration_date
+            #   The passport's expiration date in YYYY-MM-DD format.
+            #
+            #   @return [Date]
+            required :expiration_date, Date
+
+            # @!attribute file_id
+            #   The identifier of the File containing the passport.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!method initialize(country:, expiration_date:, file_id:)
+            #   Some parameter documentations has been truncated, see
+            #   {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport}
+            #   for more details.
+            #
+            #   Information about the passport used for identification. Required if `method` is
+            #   equal to `passport`.
+            #
+            #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+            #
+            #   @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
+            #
+            #   @param file_id [String] The identifier of the File containing the passport.
+          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
+end

data/lib/increase/models/entity_beneficial_owner.rb

@@ -2,7 +2,7 @@
 
 module Increase
   module Models
-    # @see Increase::Resources::BeneficialOwners#retrieve
+    # @see Increase::Resources::BeneficialOwners#create
     class EntityBeneficialOwner < Increase::Internal::Type::BaseModel
       # @!attribute id
       #   The identifier of this beneficial owner.
@@ -23,6 +23,14 @@ module Increase
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute idempotency_key
+      #   The idempotency key you chose for this 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]
+      required :idempotency_key, String, nil?: true
+
       # @!attribute individual
       #   Personal details for the beneficial owner.
       #
@@ -42,7 +50,7 @@ module Increase
       #   @return [Symbol, Increase::Models::EntityBeneficialOwner::Type]
       required :type, enum: -> { Increase::EntityBeneficialOwner::Type }
 
-      # @!method initialize(id:, company_title:, created_at:, individual:, prongs:, type:)
+      # @!method initialize(id:, company_title:, created_at:, idempotency_key:, individual:, prongs:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::EntityBeneficialOwner} for more details.
       #
@@ -58,6 +66,8 @@ module Increase
       #
       #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Benefic
       #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
       #   @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.

data/lib/increase/models.rb

@@ -105,6 +105,8 @@ module Increase
 
   BeneficialOwnerArchiveParams = Increase::Models::BeneficialOwnerArchiveParams
 
+  BeneficialOwnerCreateParams = Increase::Models::BeneficialOwnerCreateParams
+
   BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
 
   BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams

data/lib/increase/resources/beneficial_owners.rb

@@ -3,6 +3,37 @@
 module Increase
   module Resources
     class BeneficialOwners
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::BeneficialOwnerCreateParams} for more details.
+      #
+      # Create a beneficial owner
+      #
+      # @overload create(entity_id:, individual:, prongs:, company_title: nil, request_options: {})
+      #
+      # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner.
+      #
+      # @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual] Personal details for the beneficial owner.
+      #
+      # @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
+      #
+      # @param company_title [String] This person's role or title within the entity.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::EntityBeneficialOwner]
+      #
+      # @see Increase::Models::BeneficialOwnerCreateParams
+      def create(params)
+        parsed, options = Increase::BeneficialOwnerCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "entity_beneficial_owners",
+          body: parsed,
+          model: Increase::EntityBeneficialOwner,
+          options: options
+        )
+      end
+
       # Retrieve a Beneficial Owner
       #
       # @overload retrieve(entity_beneficial_owner_id, request_options: {})

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -87,6 +87,7 @@ require_relative "increase/models/ach_transfer_list_params"
 require_relative "increase/models/ach_transfer_retrieve_params"
 require_relative "increase/models/balance_lookup"
 require_relative "increase/models/beneficial_owner_archive_params"
+require_relative "increase/models/beneficial_owner_create_params"
 require_relative "increase/models/beneficial_owner_list_params"
 require_relative "increase/models/beneficial_owner_retrieve_params"
 require_relative "increase/models/beneficial_owner_update_params"