Class: Increase::Models::Entity

Inherits:
BaseModel show all
Defined in:
lib/increase/models/entity.rb

Defined Under Namespace

Classes: Corporation, GovernmentAuthority, Joint, NaturalPerson, Trust

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#corporation ⇒ Increase::Models::Entity::Corporation

Details of the corporation entity. Will be present if structure is equal to corporation.

Returns:



14
 
# File 'lib/increase/models/entity.rb', line 14

required :corporation, -> { Increase::Models::Entity::Corporation }

#created_at ⇒ String

The ISO 8601 time at which the Entity was created.

Returns:

  • (String) 


19
 
# File 'lib/increase/models/entity.rb', line 19

required :created_at, String

#description ⇒ String

The entity's description for display purposes.

Returns:

  • (String) 


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

required :description, String

#details_confirmed_at ⇒ String

The ISO 8601 time at which the Entity's details were most recently confirmed.

Returns:

  • (String) 


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

required :details_confirmed_at, String

#government_authority ⇒ Increase::Models::Entity::GovernmentAuthority

Details of the government authority entity. Will be present if structure is equal to government_authority.

Returns:



34
 
# File 'lib/increase/models/entity.rb', line 34

required :government_authority, -> { Increase::Models::Entity::GovernmentAuthority }

#id ⇒ String

The entity's identifier.

Returns:

  • (String) 


9
 
# File 'lib/increase/models/entity.rb', line 9

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.

Returns:

  • (String) 


39
 
# File 'lib/increase/models/entity.rb', line 39

required :idempotency_key, String

#joint ⇒ Increase::Models::Entity::Joint

Details of the joint entity. Will be present if structure is equal to joint.

Returns:



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

required :joint, -> { Increase::Models::Entity::Joint }

#natural_person ⇒ Increase::Models::Entity::NaturalPerson

Details of the natural person entity. Will be present if structure is equal to natural_person.

Returns:



49
 
# File 'lib/increase/models/entity.rb', line 49

required :natural_person, -> { Increase::Models::Entity::NaturalPerson }

#status ⇒ Symbol

The status of the entity.

Returns:

  • (Symbol) 


54
 
# File 'lib/increase/models/entity.rb', line 54

required :status, Increase::Enum.new(:active, :archived, :disabled)

#structure ⇒ Symbol

The entity's legal structure.

Returns:

  • (Symbol) 


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

required :structure,
Increase::Enum.new(:corporation, :natural_person, :joint, :trust, :government_authority)

#supplemental_documents ⇒ Array<Increase::Models::EntitySupplementalDocument>

Additional documentation associated with the entity. This is limited to the first 10 documents for an entity. If an entity has more than 10 documents, use the GET /entity_supplemental_documents list endpoint to retrieve them.

Returns:



65
66
 
# File 'lib/increase/models/entity.rb', line 65

required :supplemental_documents,
Increase::ArrayOf.new(-> { Increase::Models::EntitySupplementalDocument })

#trust_ ⇒ Increase::Models::Entity::Trust

Details of the trust entity. Will be present if structure is equal to trust.

Returns:



71
 
# File 'lib/increase/models/entity.rb', line 71

required :trust_, -> { Increase::Models::Entity::Trust }

#type ⇒ Symbol

A constant representing the object's type. For this resource it will always be entity.

Returns:

  • (Symbol) 


76
 
# File 'lib/increase/models/entity.rb', line 76

required :type, Increase::Enum.new(:entity)