increase 1.250.0 → 1.252.0

data/lib/increase/models/entity_create_beneficial_owner_params.rb

@@ -1,414 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Entities#create_beneficial_owner
-    class EntityCreateBeneficialOwnerParams < 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 beneficial_owner
-      #   The identifying details of anyone controlling or owning 25% or more of the
-      #   corporation.
-      #
-      #   @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner]
-      required :beneficial_owner, -> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner }
-
-      # @!method initialize(entity_id:, beneficial_owner:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EntityCreateBeneficialOwnerParams} for more details.
-      #
-      #   @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}]
-
-      class BeneficialOwner < Increase::Internal::Type::BaseModel
-        # @!attribute individual
-        #   Personal details for the beneficial owner.
-        #
-        #   @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual]
-        required :individual, -> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::Prong>]
-        required :prongs,
-                 -> { Increase::Internal::Type::ArrayOf[enum: Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Prong] }
-
-        # @!attribute company_title
-        #   This person's role or title within the entity.
-        #
-        #   @return [String, nil]
-        optional :company_title, String
-
-        # @!method initialize(individual:, prongs:, company_title: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner} for more
-        #   details.
-        #
-        #   The identifying details of anyone controlling or owning 25% or more of the
-        #   corporation.
-        #
-        #   @param individual [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual] Personal details for the beneficial owner.
-        #
-        #   @param prongs [Array<Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::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.
-
-        # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner#individual
-        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::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Address]
-          required :address,
-                   -> { Increase::EntityCreateBeneficialOwnerParams::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification]
-          required :identification,
-                   -> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual}
-          #   for more details.
-          #
-          #   Personal details for the beneficial owner.
-          #
-          #   @param address [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method]
-            required :method_,
-                     enum: -> {
-                       Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense, nil]
-            optional :drivers_license,
-                     -> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense }
-
-            # @!attribute other
-            #   Information about the identification document provided. Required if `method` is
-            #   equal to `other`.
-            #
-            #   @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other, nil]
-            optional :other,
-                     -> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other }
-
-            # @!attribute passport
-            #   Information about the passport used for identification. Required if `method` is
-            #   equal to `passport`.
-            #
-            #   @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport, nil]
-            optional :passport,
-                     -> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport }
-
-            # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification}
-            #   for more details.
-            #
-            #   A means of verifying the person's identity.
-            #
-            #   @param method_ [Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
-            #
-            #   @param other [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other] Information about the identification document provided. Required if `method` is
-            #
-            #   @param passport [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::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
-
-            # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::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::EntityCreateBeneficialOwnerParams::BeneficialOwner::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
-end