Class: Dataleon::Models::CompanyRegistration::Member

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

Defined Under Namespace

Modules: Source, Type

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: nil, address: nil, birthday: nil, birthplace: nil, country: nil, documents: nil, email: nil, first_name: nil, is_beneficial_owner: nil, is_delegator: nil, last_name: nil, liveness_verification: nil, name: nil, ownership_percentage: nil, phone_number: nil, postal_code: nil, registration_id: nil, relation: nil, roles: nil, source: nil, state: nil, status: nil, type: nil, workspace_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Dataleon::Models::CompanyRegistration::Member for more details.

Represents a member or actor of a company, including personal and ownership information.

Parameters:

  • id (String) (defaults to: nil)
  • address (String) (defaults to: nil) —

    Address of the member, which may include street, city, postal code, and country.

  • birthday (Time) (defaults to: nil) —

    Birthday (available only if type = person)

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

    Birthplace (available only if type = person)

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

    ISO 3166-1 alpha-2 country code of the member’s address (e.g., “FR” for France).

  • documents (Array<Dataleon::Models::Individuals::GenericDocument>) (defaults to: nil) —

    List of documents associated with the member, including their metadata and proce

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

    Email address of the member, which may be used for communication or verification

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

    First name (available only if type = person)

  • is_beneficial_owner (Boolean) (defaults to: nil) —

    Indicates whether the member is a beneficial owner of the company, meaning they

  • is_delegator (Boolean) (defaults to: nil) —

    Indicates whether the member is a delegator, meaning they have authority to act

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

    Last name (available only if type = person)

  • liveness_verification (Boolean) (defaults to: nil) —

    Indicates whether liveness verification was performed for the member, typically

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

    Company name (available only if type = company)

  • ownership_percentage (Integer) (defaults to: nil) —

    Percentage of ownership the member has in the company, expressed as an integer b

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

    Contact phone number of the member, including country code and area code.

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

    Postal code of the member’s address, typically a numeric or alphanumeric code.

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

    Official registration identifier of the member, such as a national ID or company

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

    Type of relationship the member has with the company, such as “shareholder”, “di

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

    Role of the member within the company, such as “legal_representative”, “director

  • source (Symbol, Dataleon::Models::CompanyRegistration::Member::Source) (defaults to: nil) —

    Source of the data (e.g., government, user, company)

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

    Current state of the member in the workflow, such as “WAITING”, “STARTED”, “RUNN

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

    Status of the member in the system, indicating whether they are approved, pendin

  • type (Symbol, Dataleon::Models::CompanyRegistration::Member::Type) (defaults to: nil) —

    Member type (person or company)

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

    Identifier of the workspace to which the member belongs, used for organizational




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

Instance Attribute Details

#address ⇒ String?

Address of the member, which may include street, city, postal code, and country.

Returns:

  • (String, nil) 


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

optional :address, String

#birthday ⇒ Time?

Birthday (available only if type = person)

Returns:

  • (Time, nil) 


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

optional :birthday, Time

#birthplace ⇒ String?

Birthplace (available only if type = person)

Returns:

  • (String, nil) 


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

optional :birthplace, String

#country ⇒ String?

ISO 3166-1 alpha-2 country code of the member’s address (e.g., “FR” for France).

Returns:

  • (String, nil) 


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

optional :country, String

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

List of documents associated with the member, including their metadata and processing status.

Returns:



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

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

#email ⇒ String?

Email address of the member, which may be used for communication or verification purposes.

Returns:

  • (String, nil) 


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

optional :email, String

#first_name ⇒ String?

First name (available only if type = person)

Returns:

  • (String, nil) 


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

optional :first_name, String

#id ⇒ String?

Returns:

  • (String, nil) 


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

optional :id, String

#is_beneficial_owner ⇒ Boolean?

Indicates whether the member is a beneficial owner of the company, meaning they have significant control or ownership.

Returns:

  • (Boolean, nil) 


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

optional :is_beneficial_owner, Dataleon::Internal::Type::Boolean

#is_delegator ⇒ Boolean?

Indicates whether the member is a delegator, meaning they have authority to act on behalf of the company.

Returns:

  • (Boolean, nil) 


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

optional :is_delegator, Dataleon::Internal::Type::Boolean

#last_name ⇒ String?

Last name (available only if type = person)

Returns:

  • (String, nil) 


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

optional :last_name, String

#liveness_verification ⇒ Boolean?

Indicates whether liveness verification was performed for the member, typically in the context of identity checks.

Returns:

  • (Boolean, nil) 


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

optional :liveness_verification, Dataleon::Internal::Type::Boolean

#name ⇒ String?

Company name (available only if type = company)

Returns:

  • (String, nil) 


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

optional :name, String

#ownership_percentage ⇒ Integer?

Percentage of ownership the member has in the company, expressed as an integer between 0 and 100.

Returns:

  • (Integer, nil) 


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

optional :ownership_percentage, Integer

#phone_number ⇒ String?

Contact phone number of the member, including country code and area code.

Returns:

  • (String, nil) 


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

optional :phone_number, String

#postal_code ⇒ String?

Postal code of the member’s address, typically a numeric or alphanumeric code.

Returns:

  • (String, nil) 


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

optional :postal_code, String

#registration_id ⇒ String?

Official registration identifier of the member, such as a national ID or company registration number.

Returns:

  • (String, nil) 


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

optional :registration_id, String

#relation ⇒ String?

Type of relationship the member has with the company, such as “shareholder”, “director”, or “beneficial_owner”.

Returns:

  • (String, nil) 


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

optional :relation, String

#roles ⇒ String?

Role of the member within the company, such as “legal_representative”, “director”, or “manager”.

Returns:

  • (String, nil) 


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

optional :roles, String

#source ⇒ Symbol, ...

Source of the data (e.g., government, user, company)

Returns:



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

optional :source, enum: -> { Dataleon::CompanyRegistration::Member::Source }

#state ⇒ String?

Current state of the member in the workflow, such as “WAITING”, “STARTED”, “RUNNING”, or “PROCESSED”.

Returns:

  • (String, nil) 


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

optional :state, String

#status ⇒ String?

Status of the member in the system, indicating whether they are approved, pending, or rejected. Possible values include “approved”, “need_review”, “rejected”.

Returns:

  • (String, nil) 


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

optional :status, String

#type ⇒ Symbol, ...

Member type (person or company)

Returns:



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

optional :type, enum: -> { Dataleon::CompanyRegistration::Member::Type }

#workspace_id ⇒ String?

Identifier of the workspace to which the member belongs, used for organizational purposes.

Returns:

  • (String, nil) 


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

optional :workspace_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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