Class: Dodopayments::Models::Event

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/event.rb

Overview

See Also:

Defined Under Namespace

Modules: Metadata

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(business_id: , customer_id: , event_id: , event_name: , timestamp: , metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::Event for more details.

Parameters:

  • business_id (String) (defaults to: )
  • customer_id (String) (defaults to: )
  • event_id (String) (defaults to: )
  • event_name (String) (defaults to: )
  • timestamp (Time) (defaults to: )
  • metadata (Hash{Symbol=>String, Float, Boolean}, nil) (defaults to: nil) —

    Arbitrary key-value metadata. Values can be string, integer, number, or boolean.




# File 'lib/dodopayments/models/event.rb', line 40

Instance Attribute Details

#business_id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/dodopayments/models/event.rb', line 10

required :business_id, String

#customer_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/dodopayments/models/event.rb', line 15

required :customer_id, String

#event_id ⇒ String

Returns:

  • (String) 


20
 
# File 'lib/dodopayments/models/event.rb', line 20

required :event_id, String

#event_name ⇒ String

Returns:

  • (String) 


25
 
# File 'lib/dodopayments/models/event.rb', line 25

required :event_name, String

#metadata ⇒ Hash{Symbol=>String, Float, Boolean}?

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

Returns:

  • (Hash{Symbol=>String, Float, Boolean}, nil) 


36
37
38
 
# File 'lib/dodopayments/models/event.rb', line 36

optional :metadata,
-> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::Event::Metadata] },
nil?: true

#timestamp ⇒ Time

Returns:

  • (Time) 


30
 
# File 'lib/dodopayments/models/event.rb', line 30

required :timestamp, Time