Class: Increase::Models::BeneficialOwnerCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/beneficial_owner_create_params.rb,
sig/increase/models/beneficial_owner_create_params.rbs

Overview

See Also:

  • Increase::Resources::BeneficialOwners#create

Defined Under Namespace

Modules: Prong Classes: Individual

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(country:, expiration_date:, file_id:) ⇒ Object

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.

Parameters:

  • country (String) —

    The two-character ISO 3166-1 code representing the country that issued the docum

  • expiration_date (Date) —

    The passport's expiration date in YYYY-MM-DD format.

  • file_id (String) —

    The identifier of the File containing the passport.




# File 'lib/increase/models/beneficial_owner_create_params.rb', line 360

Instance Attribute Details

#company_title ⇒ String?

This person's role or title within the entity.

Parameters:

  • (String)

Returns:

  • (String, nil) 


36
 
# File 'lib/increase/models/beneficial_owner_create_params.rb', line 36

optional :company_title, String

#entity_id ⇒ String

The identifier of the Entity to associate with the new Beneficial Owner. Only corporation entities have beneficial owners.

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/increase/models/beneficial_owner_create_params.rb', line 15

required :entity_id, String

#individual ⇒ Increase::Models::BeneficialOwnerCreateParams::Individual

Personal details for the beneficial owner.

Parameters:

  • value (Increase::BeneficialOwnerCreateParams::Individual)

Returns:



21
 
# File 'lib/increase/models/beneficial_owner_create_params.rb', line 21

required :individual, -> { Increase::BeneficialOwnerCreateParams::Individual }

#prongs ⇒ Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>

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.

Parameters:

  • value (::Array[Increase::Models::BeneficialOwnerCreateParams::prong])

Returns:



29
30
 
# File 'lib/increase/models/beneficial_owner_create_params.rb', line 29

required :prongs,
-> { Increase::Internal::Type::ArrayOf[enum: Increase::BeneficialOwnerCreateParams::Prong] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/increase/models/beneficial_owner_create_params.rbs', line 34

def to_hash: -> {