Class: Userplex::Models::LogNewParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/userplex/models/log_new_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(name:, user_id:, data: nil, properties: nil, timestamp: nil, request_options: {}) ⇒ Object

Parameters:

  • name (String)
  • user_id (String) —

    External user ID

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

    Additional log data

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

    Alias for data, for compatibility

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

    Log timestamp (ISO 8601)

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



# File 'lib/userplex/models/log_new_params.rb', line 39

Instance Attribute Details

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

Additional log data

Returns:

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


25
 
# File 'lib/userplex/models/log_new_params.rb', line 25

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

#name ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/userplex/models/log_new_params.rb', line 13

required :name, String

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

Alias for data, for compatibility

Returns:

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


31
 
# File 'lib/userplex/models/log_new_params.rb', line 31

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

#timestamp ⇒ Time?

Log timestamp (ISO 8601)

Returns:

  • (Time, nil) 


37
 
# File 'lib/userplex/models/log_new_params.rb', line 37

optional :timestamp, Time

#user_id ⇒ String

External user ID

Returns:

  • (String) 


19
 
# File 'lib/userplex/models/log_new_params.rb', line 19

required :user_id, String