Class: Userplex::Models::UserIdentifyParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/userplex/models/user_identify_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(user_id:, email: nil, name: nil, properties: nil, request_options: {}) ⇒ Object

Parameters:

  • user_id (String) —

    Unique identifier for the user

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

    User email address

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

    User full name

  • properties (Hash{Symbol=>Object, nil}) (defaults to: nil) —

    Additional user properties

  • request_options (Userplex::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/userplex/models/user_identify_params.rb', line 34

Instance Attribute Details

#email ⇒ String?

User email address

Returns:

  • (String, nil) 


20
 
# File 'lib/userplex/models/user_identify_params.rb', line 20

optional :email, String

#name ⇒ String?

User full name

Returns:

  • (String, nil) 


26
 
# File 'lib/userplex/models/user_identify_params.rb', line 26

optional :name, String

#properties ⇒ Hash{Symbol=>Object, nil}?

Additional user properties

Returns:

  • (Hash{Symbol=>Object, nil}, nil) 


32
 
# File 'lib/userplex/models/user_identify_params.rb', line 32

optional :properties, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown, nil?: true]

#user_id ⇒ String

Unique identifier for the user

Returns:

  • (String) 


14
 
# File 'lib/userplex/models/user_identify_params.rb', line 14

required :user_id, String