Class: Dataleon::Models::CompanyRegistration

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dataleon/models/company_registration.rb

Overview

See Also:

Defined Under Namespace

Classes: AmlSuspicion, Certificat, Company, Member, Property, Risk, TechnicalData

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(code: nil, reason: nil, score: nil) ⇒ Object

Risk assessment associated with the company, including a risk code, reason, and confidence score.

Parameters:

  • code (String) (defaults to: nil) —

    Risk category or code identifier.

  • reason (String) (defaults to: nil) —

    Explanation or justification for the assigned risk.

  • score (Float) (defaults to: nil) —

    Numeric risk score between 0.0 and 1.0 indicating severity or confidence.




# File 'lib/dataleon/models/company_registration.rb', line 257

Instance Attribute Details

#aml_suspicions ⇒ Array<Dataleon::Models::CompanyRegistration::AmlSuspicion>?

List of AML (Anti-Money Laundering) suspicion entries linked to the company, including their details.

Returns:



12
13
 
# File 'lib/dataleon/models/company_registration.rb', line 12

optional :aml_suspicions,
-> { Dataleon::Internal::Type::ArrayOf[Dataleon::CompanyRegistration::AmlSuspicion] }

#certificat ⇒ Dataleon::Models::CompanyRegistration::Certificat?

Digital certificate associated with the company, if any, including its creation timestamp and filename.

Returns:



20
 
# File 'lib/dataleon/models/company_registration.rb', line 20

optional :certificat, -> { Dataleon::CompanyRegistration::Certificat }

#checks ⇒ Array<Dataleon::Models::Check>?

List of verification or validation checks applied to the company, including their results and messages.

Returns:



27
 
# File 'lib/dataleon/models/company_registration.rb', line 27

optional :checks, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Check] }

#company ⇒ Dataleon::Models::CompanyRegistration::Company?

Main information about the company being registered, including legal name, registration ID, and address.

Returns:



34
 
# File 'lib/dataleon/models/company_registration.rb', line 34

optional :company, -> { Dataleon::CompanyRegistration::Company }

#documents ⇒ Array<Dataleon::Models::Individuals::GenericDocument>?

All documents submitted or associated with the company, including their metadata and processing status.

Returns:



41
 
# File 'lib/dataleon/models/company_registration.rb', line 41

optional :documents, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::GenericDocument] }

#members ⇒ Array<Dataleon::Models::CompanyRegistration::Member>?

List of members or actors associated with the company, including personal and ownership information.

Returns:



48
 
# File 'lib/dataleon/models/company_registration.rb', line 48

optional :members, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::CompanyRegistration::Member] }

#portal_url ⇒ String?

Admin or internal portal URL for viewing the company’s details, typically used by internal users.

Returns:

  • (String, nil) 


55
 
# File 'lib/dataleon/models/company_registration.rb', line 55

optional :portal_url, String

#properties ⇒ Array<Dataleon::Models::CompanyRegistration::Property>?

Custom key-value metadata fields associated with the company, allowing for flexible data storage.

Returns:



62
 
# File 'lib/dataleon/models/company_registration.rb', line 62

optional :properties, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::CompanyRegistration::Property] }

#risk ⇒ Dataleon::Models::CompanyRegistration::Risk?

Risk assessment associated with the company, including a risk code, reason, and confidence score.

Returns:



69
 
# File 'lib/dataleon/models/company_registration.rb', line 69

optional :risk, -> { Dataleon::CompanyRegistration::Risk }

#source_id ⇒ String?

Optional identifier indicating the source of the company record, useful for tracking or integration purposes.

Returns:

  • (String, nil) 


76
 
# File 'lib/dataleon/models/company_registration.rb', line 76

optional :source_id, String

#technical_data ⇒ Dataleon::Models::CompanyRegistration::TechnicalData?

Technical metadata related to the request, such as IP address, QR code settings, and callback URLs.

Returns:



83
 
# File 'lib/dataleon/models/company_registration.rb', line 83

optional :technical_data, -> { Dataleon::CompanyRegistration::TechnicalData }

#webview_url ⇒ String?

Public-facing webview URL for the company’s identification process, allowing external access to the company data.

Returns:

  • (String, nil) 


90
 
# File 'lib/dataleon/models/company_registration.rb', line 90

optional :webview_url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/dataleon/models/company_registration.rb', line 232