Class: Increase::Models::Entity::Corporation

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

Overview

See Also:

Defined Under Namespace

Classes: Address

Instance Attribute 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(address:, beneficial_owners:, email:, incorporation_state:, industry_code:, name:, tax_identifier:, website:) ⇒ Object

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

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

Parameters:

  • address (Increase::Models::Entity::Corporation::Address) —

    The corporation’s address.

  • beneficial_owners (Array<Increase::Models::EntityBeneficialOwner>) —

    The identifying details of anyone controlling or owning 25% or more of the corpo

  • email (String, nil) —

    An email address for the business.

  • incorporation_state (String, nil) —

    The two-letter United States Postal Service (USPS) abbreviation for the corporat

  • industry_code (String, nil) —

    The numeric North American Industry Classification System (NAICS) code submitted

  • name (String) —

    The legal name of the corporation.

  • tax_identifier (String, nil) —

    The Employer Identification Number (EIN) for the corporation.

  • website (String, nil) —

    The website of the corporation.




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

Instance Attribute Details

#address ⇒ Increase::Models::Entity::Corporation::Address

The corporation’s address.

Returns:



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

required :address, -> { Increase::Entity::Corporation::Address }

#beneficial_owners ⇒ Array<Increase::Models::EntityBeneficialOwner>

The identifying details of anyone controlling or owning 25% or more of the corporation.

Returns:



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

required :beneficial_owners, -> { Increase::Internal::Type::ArrayOf[Increase::EntityBeneficialOwner] }

#email ⇒ String?

An email address for the business.

Returns:

  • (String, nil) 


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

required :email, String, nil?: true

#incorporation_state ⇒ String?

The two-letter United States Postal Service (USPS) abbreviation for the corporation’s state of incorporation.

Returns:

  • (String, nil) 


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

required :incorporation_state, String, nil?: true

#industry_code ⇒ String?

The numeric North American Industry Classification System (NAICS) code submitted for the corporation.

Returns:

  • (String, nil) 


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

required :industry_code, String, nil?: true

#name ⇒ String

The legal name of the corporation.

Returns:

  • (String) 


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

required :name, String

#tax_identifier ⇒ String?

The Employer Identification Number (EIN) for the corporation.

Returns:

  • (String, nil) 


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

required :tax_identifier, String, nil?: true

#website ⇒ String?

The website of the corporation.

Returns:

  • (String, nil) 


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

required :website, String, nil?: true