increase 1.249.0 → 1.251.0

data/lib/increase/models/entity.rb

@@ -174,8 +174,9 @@ module Increase
         #   The identifying details of anyone controlling or owning 25% or more of the
         #   corporation.
         #
-        #   @return [Array<Increase::Models::EntityBeneficialOwner>]
-        required :beneficial_owners, -> { Increase::Internal::Type::ArrayOf[Increase::EntityBeneficialOwner] }
+        #   @return [Array<Increase::Models::Entity::Corporation::BeneficialOwner>]
+        required :beneficial_owners,
+                 -> { Increase::Internal::Type::ArrayOf[Increase::Entity::Corporation::BeneficialOwner] }
 
         # @!attribute email
         #   An email address for the business.
@@ -224,7 +225,7 @@ module Increase
         #
         #   @param address [Increase::Models::Entity::Corporation::Address] The corporation's address.
         #
-        #   @param beneficial_owners [Array<Increase::Models::EntityBeneficialOwner>] The identifying details of anyone controlling or owning 25% or more of the corpo
+        #   @param beneficial_owners [Array<Increase::Models::Entity::Corporation::BeneficialOwner>] The identifying details of anyone controlling or owning 25% or more of the corpo
         #
         #   @param email [String, nil] An email address for the business.
         #
@@ -287,6 +288,209 @@ 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

@@ -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,20 @@ module Increase
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute entity_id
+      #   The identifier of the Entity to which this beneficial owner belongs.
+      #
+      #   @return [String]
+      required :entity_id, String
+
+      # @!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 +56,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:, entity_id:, idempotency_key:, individual:, prongs:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::EntityBeneficialOwner} for more details.
       #
@@ -58,6 +72,10 @@ module Increase
       #
       #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Benefic
       #
+      #   @param entity_id [String] The identifier of the Entity to which this beneficial owner belongs.
+      #
+      #   @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
@@ -263,8 +265,6 @@ module Increase
 
   EntityBeneficialOwner = Increase::Models::EntityBeneficialOwner
 
-  EntityCreateBeneficialOwnerParams = Increase::Models::EntityCreateBeneficialOwnerParams
-
   EntityCreateParams = Increase::Models::EntityCreateParams
 
   EntityListParams = Increase::Models::EntityListParams

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/resources/entities.rb

@@ -165,33 +165,6 @@ module Increase
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::EntityCreateBeneficialOwnerParams} for more details.
-      #
-      # Create a beneficial owner for a corporate Entity
-      #
-      # @overload create_beneficial_owner(entity_id, beneficial_owner:, request_options: {})
-      #
-      # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner.
-      #
-      # @param beneficial_owner [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] The identifying details of anyone controlling or owning 25% or more of the corpo
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Entity]
-      #
-      # @see Increase::Models::EntityCreateBeneficialOwnerParams
-      def create_beneficial_owner(entity_id, params)
-        parsed, options = Increase::EntityCreateBeneficialOwnerParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: ["entities/%1$s/create_beneficial_owner", entity_id],
-          body: parsed,
-          model: Increase::Entity,
-          options: options
-        )
-      end
-
       # @api private
       #
       # @param client [Increase::Client]

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.249.0"
+  VERSION = "1.251.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"
@@ -166,7 +167,6 @@ require_relative "increase/models/digital_wallet_token_retrieve_params"
 require_relative "increase/models/entity"
 require_relative "increase/models/entity_archive_params"
 require_relative "increase/models/entity_beneficial_owner"
-require_relative "increase/models/entity_create_beneficial_owner_params"
 require_relative "increase/models/entity_create_params"
 require_relative "increase/models/entity_list_params"
 require_relative "increase/models/entity_retrieve_params"