Class: Revox::Models::UserRetrieveResponse::User

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

Overview

See Also:

  • Revox::Models::UserRetrieveResponse#user

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(id:, created_at:, email:, first_name:, has_completed_onboarding:, last_name:, organization_id:, updated_at:, organization_country: nil) ⇒ Object

Some parameter documentations has been truncated, see Revox::Models::UserRetrieveResponse::User for more details.

The current authenticated user.

Parameters:

  • id (String) —

    The unique identifier of the user.

  • created_at (Object) —

    The time the user was created.

  • email (String) —

    The email address of the user.

  • first_name (String, nil) —

    The first name of the user.

  • has_completed_onboarding (Boolean) —

    Whether the user has completed the onboarding tutorial.

  • last_name (String, nil) —

    The last name of the user.

  • organization_id (String) —

    The ID of the organization the user belongs to.

  • updated_at (Object) —

    The time the user was last updated.

  • organization_country (String, nil) (defaults to: nil) —

    ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the defau




# File 'lib/revox/models/user_retrieve_response.rb', line 73

Instance Attribute Details

#created_at ⇒ Object

The time the user was created.

Parameters:

  • value (top)

Returns:

  • (Object) 


28
 
# File 'lib/revox/models/user_retrieve_response.rb', line 28

required :created_at, Revox::Internal::Type::Unknown

#email ⇒ String

The email address of the user.

Parameters:

  • value (String)

Returns:

  • (String) 


34
 
# File 'lib/revox/models/user_retrieve_response.rb', line 34

required :email, String

#first_name ⇒ String?

The first name of the user.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


40
 
# File 'lib/revox/models/user_retrieve_response.rb', line 40

required :first_name, String, nil?: true

#has_completed_onboarding ⇒ Boolean

Whether the user has completed the onboarding tutorial.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


46
 
# File 'lib/revox/models/user_retrieve_response.rb', line 46

required :has_completed_onboarding, Revox::Internal::Type::Boolean

#id ⇒ String

The unique identifier of the user.

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/revox/models/user_retrieve_response.rb', line 22

required :id, String

#last_name ⇒ String?

The last name of the user.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


52
 
# File 'lib/revox/models/user_retrieve_response.rb', line 52

required :last_name, String, nil?: true

#organization_country ⇒ String?

ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the default region when normalizing national-format phone numbers.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


71
 
# File 'lib/revox/models/user_retrieve_response.rb', line 71

optional :organization_country, String, nil?: true

#organization_id ⇒ String

The ID of the organization the user belongs to.

Parameters:

  • value (String)

Returns:

  • (String) 


58
 
# File 'lib/revox/models/user_retrieve_response.rb', line 58

required :organization_id, String

#updated_at ⇒ Object

The time the user was last updated.

Parameters:

  • value (top)

Returns:

  • (Object) 


64
 
# File 'lib/revox/models/user_retrieve_response.rb', line 64

required :updated_at, Revox::Internal::Type::Unknown

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


57
 
# File 'sig/revox/models/user_retrieve_response.rbs', line 57

def to_hash: -> {