Class: MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/customer_preview_events_params.rb

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(customer_id: , events: , mode: nil, skip_zero_qty_line_items: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::CustomerPreviewEventsParams for more details.

Parameters:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/metronome_sdk/models/v1/customer_preview_events_params.rb', line 53

class Event < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute event_type
  #
  #   @return [String]
  required :event_type, String

  # @!attribute properties
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :properties, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]

  # @!attribute timestamp
  #   RFC 3339 formatted. If not provided, the current time will be used.
  #
  #   @return [String, nil]
  optional :timestamp, String

  # @!attribute transaction_id
  #   Optional unique identifier for event deduplication. When provided, preview
  #   events are automatically deduplicated against historical events from the past 34
  #   days. Duplicate transaction IDs within the same request will return an error.
  #
  #   @return [String, nil]
  optional :transaction_id, String

  # @!method initialize(event_type:, properties: nil, timestamp: nil, transaction_id: nil)
  #   Some parameter documentations has been truncated, see
  #   {MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event} for more details.
  #
  #   @param event_type [String]
  #
  #   @param properties [Hash{Symbol=>Object}]
  #
  #   @param timestamp [String] RFC 3339 formatted. If not provided, the current time will be used.
  #
  #   @param transaction_id [String] Optional unique identifier for event deduplication. When provided, preview event
end

Instance Attribute Details

#event_type ⇒ String

Returns:

  • (String) 


57
 
# File 'lib/metronome_sdk/models/v1/customer_preview_events_params.rb', line 57

required :event_type, String

#properties ⇒ Hash{Symbol=>Object}?

Returns:

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


62
 
# File 'lib/metronome_sdk/models/v1/customer_preview_events_params.rb', line 62

optional :properties, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]

#timestamp ⇒ String?

RFC 3339 formatted. If not provided, the current time will be used.

Returns:

  • (String, nil) 


68
 
# File 'lib/metronome_sdk/models/v1/customer_preview_events_params.rb', line 68

optional :timestamp, String

#transaction_id ⇒ String?

Optional unique identifier for event deduplication. When provided, preview events are automatically deduplicated against historical events from the past 34 days. Duplicate transaction IDs within the same request will return an error.

Returns:

  • (String, nil) 


76
 
# File 'lib/metronome_sdk/models/v1/customer_preview_events_params.rb', line 76

optional :transaction_id, String