Class: TrophyApiClient::PointsTriggerResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/types/points_trigger_response.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, type:, points:, status:, created:, updated:, achievement_id: OMIT, metric_id: OMIT, metric_threshold: OMIT, streak_length_threshold: OMIT, metric_name: OMIT, achievement_name: OMIT, time_unit: OMIT, time_interval: OMIT, user_attributes: OMIT, event_attribute: OMIT, additional_properties: nil) ⇒ TrophyApiClient::PointsTriggerResponse

Parameters:

  • id (String) —

    The unique ID of the trigger.

  • type (TrophyApiClient::PointsTriggerResponseType) —

    The type of trigger.

  • points (Integer) —

    The points awarded by this trigger.

  • status (TrophyApiClient::PointsTriggerResponseStatus) —

    The status of the trigger.

  • achievement_id (String) (defaults to: OMIT) —

    The unique ID of the achievement associated with this trigger, if the trigger is an achievement.

  • metric_id (String) (defaults to: OMIT) —

    The unique ID of the metric associated with this trigger, if the trigger is a metric.

  • metric_threshold (Integer) (defaults to: OMIT) —

    The amount that a user must increase the metric to earn the points, if the trigger is a metric.

  • streak_length_threshold (Integer) (defaults to: OMIT) —

    The number of consecutive streak periods that a user must complete to earn the points, if the trigger is a streak.

  • metric_name (String) (defaults to: OMIT) —

    The name of the metric associated with this trigger, if the trigger is a metric.

  • achievement_name (String) (defaults to: OMIT) —

    The name of the achievement associated with this trigger, if the trigger is an achievement.

  • time_unit (TrophyApiClient::PointsTriggerResponseTimeUnit) (defaults to: OMIT) —

    The time unit of the trigger, if the trigger is a time interval.

  • time_interval (Integer) (defaults to: OMIT) —

    The interval of the trigger in the time unit, if the trigger is a time interval.

  • user_attributes (Array<TrophyApiClient::PointsTriggerResponseUserAttributesItem>) (defaults to: OMIT) —

    User attribute filters that must be met for this trigger to activate. Only present if the trigger has user attribute filters configured.

  • event_attribute (TrophyApiClient::PointsTriggerResponseEventAttribute) (defaults to: OMIT) —

    Event attribute filter that must be met for this trigger to activate. Only present if the trigger has an event filter configured.

  • created (DateTime) —

    The date and time the trigger was created, in ISO 8601 format.

  • updated (DateTime) —

    The date and time the trigger was last updated, in ISO 8601 format.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 86

def initialize(id:, type:, points:, status:, created:, updated:, achievement_id: OMIT, metric_id: OMIT, metric_threshold: OMIT,
               streak_length_threshold: OMIT, metric_name: OMIT, achievement_name: OMIT, time_unit: OMIT, time_interval: OMIT, user_attributes: OMIT, event_attribute: OMIT, additional_properties: nil)
  @id = id
  @type = type
  @points = points
  @status = status
  @achievement_id = achievement_id if achievement_id != OMIT
  @metric_id = metric_id if metric_id != OMIT
  @metric_threshold = metric_threshold if metric_threshold != OMIT
  @streak_length_threshold = streak_length_threshold if streak_length_threshold != OMIT
  @metric_name = metric_name if metric_name != OMIT
  @achievement_name = achievement_name if achievement_name != OMIT
  @time_unit = time_unit if time_unit != OMIT
  @time_interval = time_interval if time_interval != OMIT
  @user_attributes = user_attributes if user_attributes != OMIT
  @event_attribute = event_attribute if event_attribute != OMIT
  @created = created
  @updated = updated
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "type": type,
    "points": points,
    "status": status,
    "achievementId": achievement_id,
    "metricId": metric_id,
    "metricThreshold": metric_threshold,
    "streakLengthThreshold": streak_length_threshold,
    "metricName": metric_name,
    "achievementName": achievement_name,
    "timeUnit": time_unit,
    "timeInterval": time_interval,
    "userAttributes": user_attributes,
    "eventAttribute": event_attribute,
    "created": created,
    "updated": updated
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#achievement_id ⇒ String (readonly)

Returns The unique ID of the achievement associated with this trigger, if the trigger is an achievement.

Returns:

  • (String) —

    The unique ID of the achievement associated with this trigger, if the trigger is an achievement.



24
25
26
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 24

def achievement_id
  @achievement_id
end

#achievement_name ⇒ String (readonly)

Returns The name of the achievement associated with this trigger, if the trigger is an achievement.

Returns:

  • (String) —

    The name of the achievement associated with this trigger, if the trigger is an achievement.



38
39
40
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 38

def achievement_name
  @achievement_name
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



54
55
56
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 54

def additional_properties
  @additional_properties
end

#created ⇒ DateTime (readonly)

Returns The date and time the trigger was created, in ISO 8601 format.

Returns:

  • (DateTime) —

    The date and time the trigger was created, in ISO 8601 format.



50
51
52
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 50

def created
  @created
end

#event_attribute ⇒ TrophyApiClient::PointsTriggerResponseEventAttribute (readonly)

Returns Event attribute filter that must be met for this trigger to activate. Only present if the trigger has an event filter configured.

Returns:



48
49
50
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 48

def event_attribute
  @event_attribute
end

#id ⇒ String (readonly)

Returns The unique ID of the trigger.

Returns:

  • (String) —

    The unique ID of the trigger.



15
16
17
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 15

def id
  @id
end

#metric_id ⇒ String (readonly)

Returns The unique ID of the metric associated with this trigger, if the trigger is a metric.

Returns:

  • (String) —

    The unique ID of the metric associated with this trigger, if the trigger is a metric.



27
28
29
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 27

def metric_id
  @metric_id
end

#metric_name ⇒ String (readonly)

Returns The name of the metric associated with this trigger, if the trigger is a metric.

Returns:

  • (String) —

    The name of the metric associated with this trigger, if the trigger is a metric.



35
36
37
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 35

def metric_name
  @metric_name
end

#metric_threshold ⇒ Integer (readonly)

Returns The amount that a user must increase the metric to earn the points, if the trigger is a metric.

Returns:

  • (Integer) —

    The amount that a user must increase the metric to earn the points, if the trigger is a metric.



30
31
32
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 30

def metric_threshold
  @metric_threshold
end

#points ⇒ Integer (readonly)

Returns The points awarded by this trigger.

Returns:

  • (Integer) —

    The points awarded by this trigger.



19
20
21
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 19

def points
  @points
end

#status ⇒ TrophyApiClient::PointsTriggerResponseStatus (readonly)

Returns The status of the trigger.

Returns:



21
22
23
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 21

def status
  @status
end

#streak_length_threshold ⇒ Integer (readonly)

Returns The number of consecutive streak periods that a user must complete to earn the points, if the trigger is a streak.

Returns:

  • (Integer) —

    The number of consecutive streak periods that a user must complete to earn the points, if the trigger is a streak.



33
34
35
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 33

def streak_length_threshold
  @streak_length_threshold
end

#time_interval ⇒ Integer (readonly)

Returns The interval of the trigger in the time unit, if the trigger is a time interval.

Returns:

  • (Integer) —

    The interval of the trigger in the time unit, if the trigger is a time interval.



42
43
44
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 42

def time_interval
  @time_interval
end

#time_unit ⇒ TrophyApiClient::PointsTriggerResponseTimeUnit (readonly)

Returns The time unit of the trigger, if the trigger is a time interval.

Returns:



40
41
42
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 40

def time_unit
  @time_unit
end

#type ⇒ TrophyApiClient::PointsTriggerResponseType (readonly)

Returns The type of trigger.

Returns:



17
18
19
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 17

def type
  @type
end

#updated ⇒ DateTime (readonly)

Returns The date and time the trigger was last updated, in ISO 8601 format.

Returns:

  • (DateTime) —

    The date and time the trigger was last updated, in ISO 8601 format.



52
53
54
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 52

def updated
  @updated
end

#user_attributes ⇒ Array<TrophyApiClient::PointsTriggerResponseUserAttributesItem> (readonly)

Returns User attribute filters that must be met for this trigger to activate. Only present if the trigger has user attribute filters configured.

Returns:



45
46
47
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 45

def user_attributes
  @user_attributes
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::PointsTriggerResponse

Deserialize a JSON object to an instance of PointsTriggerResponse

Parameters:

  • json_object (String)

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 131

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  type = parsed_json["type"]
  points = parsed_json["points"]
  status = parsed_json["status"]
  achievement_id = parsed_json["achievementId"]
  metric_id = parsed_json["metricId"]
  metric_threshold = parsed_json["metricThreshold"]
  streak_length_threshold = parsed_json["streakLengthThreshold"]
  metric_name = parsed_json["metricName"]
  achievement_name = parsed_json["achievementName"]
  time_unit = parsed_json["timeUnit"]
  time_interval = parsed_json["timeInterval"]
  user_attributes = parsed_json["userAttributes"]&.map do |item|
    item = item.to_json
    TrophyApiClient::PointsTriggerResponseUserAttributesItem.from_json(json_object: item)
  end
  if parsed_json["eventAttribute"].nil?
    event_attribute = nil
  else
    event_attribute = parsed_json["eventAttribute"].to_json
    event_attribute = TrophyApiClient::PointsTriggerResponseEventAttribute.from_json(json_object: event_attribute)
  end
  created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
  updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
  new(
    id: id,
    type: type,
    points: points,
    status: status,
    achievement_id: achievement_id,
    metric_id: metric_id,
    metric_threshold: metric_threshold,
    streak_length_threshold: streak_length_threshold,
    metric_name: metric_name,
    achievement_name: achievement_name,
    time_unit: time_unit,
    time_interval: time_interval,
    user_attributes: user_attributes,
    event_attribute: event_attribute,
    created: created,
    updated: updated,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 192

def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.type.is_a?(TrophyApiClient::PointsTriggerResponseType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  obj.points.is_a?(Integer) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
  obj.status.is_a?(TrophyApiClient::PointsTriggerResponseStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.achievement_id&.is_a?(String) != false || raise("Passed value for field obj.achievement_id is not the expected type, validation failed.")
  obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
  obj.metric_threshold&.is_a?(Integer) != false || raise("Passed value for field obj.metric_threshold is not the expected type, validation failed.")
  obj.streak_length_threshold&.is_a?(Integer) != false || raise("Passed value for field obj.streak_length_threshold is not the expected type, validation failed.")
  obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
  obj.achievement_name&.is_a?(String) != false || raise("Passed value for field obj.achievement_name is not the expected type, validation failed.")
  obj.time_unit&.is_a?(TrophyApiClient::PointsTriggerResponseTimeUnit) != false || raise("Passed value for field obj.time_unit is not the expected type, validation failed.")
  obj.time_interval&.is_a?(Integer) != false || raise("Passed value for field obj.time_interval is not the expected type, validation failed.")
  obj.user_attributes&.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
  obj.event_attribute.nil? || TrophyApiClient::PointsTriggerResponseEventAttribute.validate_raw(obj: obj.event_attribute)
  obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
  obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of PointsTriggerResponse to a JSON object

Returns:

  • (String) 


182
183
184
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 182

def to_json(*_args)
  @_field_set&.to_json
end