Class: SurgeAPI::Models::Organization

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/surge_api/models/organization.rb,
sig/surge_api/models/organization.rbs

Defined Under Namespace

Modules: IdentifierType, Industry, RegionsOfOperation, StockExchange, Type Classes: Address, Contact

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(country:, line1:, line2:, locality:, name:, postal_code:, region:) ⇒ Object

Some parameter documentations has been truncated, see Address for more details.

The address of the organization's headquarters.

Parameters:

  • country (String, nil) —

    The two character ISO 3166 country code. If none is provided, the organization's

  • line1 (String, nil) —

    The first line of the address, typically the number and street name

  • line2 (String, nil) —

    The second line of the address if needed, typically an apartment or suite number

  • locality (String, nil) —

    The city or locality

  • name (String, nil) —

    The name to which any mail should be addressed. If none is provided, this will d

  • postal_code (String, nil) —

    The postal code

  • region (String, nil) —

    The state or region




# File 'lib/surge_api/models/organization.rb', line 109

Instance Attribute Details

#address ⇒ SurgeAPI::Models::Organization::Address

The address of the organization's headquarters.

Parameters:

  • value (SurgeAPI::Organization::Address)

Returns:



10
 
# File 'lib/surge_api/models/organization.rb', line 10

required :address, -> { SurgeAPI::Organization::Address }

#contact ⇒ SurgeAPI::Models::Organization::Contact

An object representing an individual who can be contacted if the carriers have any questions about the business.

Parameters:

  • value (SurgeAPI::Organization::Contact)

Returns:



17
 
# File 'lib/surge_api/models/organization.rb', line 17

required :contact, -> { SurgeAPI::Organization::Contact }

#country ⇒ String?

The two character ISO 3166 country code for the country in which the organization is headquartered.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


24
 
# File 'lib/surge_api/models/organization.rb', line 24

required :country, String, nil?: true

#email ⇒ String?

For publicly traded companies, an email for a representative of the company to whom a verification email will be sent. This must be an email on the same domain as the company's website (e.g. with a website domain of https://dtprecisionauto.com, the email must use the same @dtprecisionauto.com)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


34
 
# File 'lib/surge_api/models/organization.rb', line 34

required :email, String, nil?: true

#identifier ⇒ String?

The value of the identifier whose type is specified in the identifier_type field. For EIN, can be formatted with or without the hyphen. For CBN, must be exactly 9 digits. For VAT, provide only the numeric portion, between 2 and 20 digits.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


43
 
# File 'lib/surge_api/models/organization.rb', line 43

required :identifier, String, nil?: true

#identifier_type ⇒ Symbol, ...

The type of identifier being provided for the organization. Use "ein" for US organizations, "cbn" for Canadian organizations, or "vat" for supported international organizations.

Parameters:

  • value (SurgeAPI::Models::Organization::identifier_type, nil)

Returns:



51
 
# File 'lib/surge_api/models/organization.rb', line 51

required :identifier_type, enum: -> { SurgeAPI::Organization::IdentifierType }, nil?: true

#industry ⇒ Symbol, ...

The industry in which the organization operates.

Parameters:

  • value (SurgeAPI::Models::Organization::industry, nil)

Returns:



57
 
# File 'lib/surge_api/models/organization.rb', line 57

required :industry, enum: -> { SurgeAPI::Organization::Industry }, nil?: true

#mobile_number ⇒ String?

For sole proprietors, this must be a valid US or Canadian mobile phone number to which a verification text message will be sent. (E.164 format)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


64
 
# File 'lib/surge_api/models/organization.rb', line 64

required :mobile_number, String, nil?: true

#regions_of_operation ⇒ Array<Symbol, SurgeAPI::Models::Organization::RegionsOfOperation>?

An array of regions in which the organization operates.

Parameters:

  • value (::Array[SurgeAPI::Models::Organization::regions_of_operation], nil)

Returns:



70
71
72
 
# File 'lib/surge_api/models/organization.rb', line 70

required :regions_of_operation,
-> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::Organization::RegionsOfOperation] },
nil?: true

#registered_name ⇒ String?

The legal name of the organization as registered with the IRS or other relevant authorities. For some applications, this will be matched against government records and should include all punctuation and everything else as well.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


80
 
# File 'lib/surge_api/models/organization.rb', line 80

required :registered_name, String, nil?: true

#stock_exchange ⇒ Symbol, ...

For publicly traded companies, this is the exchange on which the company's stock is traded.

Parameters:

  • value (SurgeAPI::Models::Organization::stock_exchange, nil)

Returns:



87
 
# File 'lib/surge_api/models/organization.rb', line 87

required :stock_exchange, enum: -> { SurgeAPI::Organization::StockExchange }, nil?: true

#stock_symbol ⇒ String?

For publicly traded companies, the ticker symbol for the company's stock

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


93
 
# File 'lib/surge_api/models/organization.rb', line 93

required :stock_symbol, String, nil?: true

#type ⇒ Symbol, ...

The type of organization

Parameters:

  • value (SurgeAPI::Models::Organization::type_, nil)

Returns:



99
 
# File 'lib/surge_api/models/organization.rb', line 99

required :type, enum: -> { SurgeAPI::Organization::Type }, nil?: true

#website ⇒ String?

The URL of the website for this organization. The website should be publicly available, clearly reflect the organization's purpose, and the URL should start with https://

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


107
 
# File 'lib/surge_api/models/organization.rb', line 107

required :website, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/surge_api/models/organization.rb', line 286

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


67
 
# File 'sig/surge_api/models/organization.rbs', line 67

def to_hash: -> {