Class: GetStream::Generated::Models::TrackActivityMetricsEvent

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/track_activity_metrics_event.rb

Overview

A single metric event to track for an activity

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ TrackActivityMetricsEvent

Initialize with attributes



23
24
25
26
27
28
 
# File 'lib/getstream_ruby/generated/models/track_activity_metrics_event.rb', line 23

def initialize(attributes = {})
  super(attributes)
  @activity_id = attributes[:activity_id] || attributes['activity_id']
  @metric = attributes[:metric] || attributes['metric']
  @delta = attributes[:delta] || attributes['delta'] || nil
end

Instance Attribute Details

#activity_id ⇒ String

Returns The ID of the activity to track the metric for.

Returns:

  • (String) —

    The ID of the activity to track the metric for



14
15
16
 
# File 'lib/getstream_ruby/generated/models/track_activity_metrics_event.rb', line 14

def activity_id
  @activity_id
end

#delta ⇒ Integer

Returns The amount to increment (positive) or decrement (negative). Defaults to 1. The absolute value counts against rate limits.

Returns:

  • (Integer) —

    The amount to increment (positive) or decrement (negative). Defaults to 1. The absolute value counts against rate limits.



20
21
22
 
# File 'lib/getstream_ruby/generated/models/track_activity_metrics_event.rb', line 20

def delta
  @delta
end

#metric ⇒ String

Returns The metric name (e.g. views, clicks, impressions). Alphanumeric and underscores only.

Returns:

  • (String) —

    The metric name (e.g. views, clicks, impressions). Alphanumeric and underscores only.



17
18
19
 
# File 'lib/getstream_ruby/generated/models/track_activity_metrics_event.rb', line 17

def metric
  @metric
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



31
32
33
34
35
36
37
 
# File 'lib/getstream_ruby/generated/models/track_activity_metrics_event.rb', line 31

def self.json_field_mappings
  {
    activity_id: 'activity_id',
    metric: 'metric',
    delta: 'delta'
  }
end