Class: Increase::Models::EntityBeneficialOwner

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity_beneficial_owner.rb

Overview

See Also:

Defined Under Namespace

Modules: Prong, Type Classes: Individual

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(id:, company_title:, created_at:, entity_id:, idempotency_key:, individual:, prongs:, type:) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EntityBeneficialOwner for more details.

Beneficial owners are the individuals who control or own 25% or more of a ‘corporation` entity. Beneficial owners are always people, and never organizations. Generally, you will need to submit between 1 and 5 beneficial owners for every `corporation` entity. You should update and archive beneficial owners for a corporation entity as their details change.

Parameters:




# File 'lib/increase/models/entity_beneficial_owner.rb', line 59

Instance Attribute Details

#company_title ⇒ String?

This person’s role or title within the entity.

Returns:

  • (String, nil) 


17
 
# File 'lib/increase/models/entity_beneficial_owner.rb', line 17

required :company_title, String, nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Beneficial Owner was created.

Returns:

  • (Time) 


24
 
# File 'lib/increase/models/entity_beneficial_owner.rb', line 24

required :created_at, Time

#entity_id ⇒ String

The identifier of the Entity to which this beneficial owner belongs.

Returns:

  • (String) 


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

required :entity_id, String

#id ⇒ String

The identifier of this beneficial owner.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/entity_beneficial_owner.rb', line 11

required :id, String

#idempotency_key ⇒ String?

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](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


38
 
# File 'lib/increase/models/entity_beneficial_owner.rb', line 38

required :idempotency_key, String, nil?: true

#individual ⇒ Increase::Models::EntityBeneficialOwner::Individual

Personal details for the beneficial owner.

Returns:



44
 
# File 'lib/increase/models/entity_beneficial_owner.rb', line 44

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

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

Why this person is considered a beneficial owner of the entity.

Returns:



50
 
# File 'lib/increase/models/entity_beneficial_owner.rb', line 50

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

#type ⇒ Symbol, Increase::Models::EntityBeneficialOwner::Type

A constant representing the object’s type. For this resource it will always be ‘entity_beneficial_owner`.

Returns:



57
 
# File 'lib/increase/models/entity_beneficial_owner.rb', line 57

required :type, enum: -> { Increase::EntityBeneficialOwner::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/entity_beneficial_owner.rb', line 233