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: OMIT, type: OMIT, points: OMIT, status: OMIT, achievement_id: OMIT, metric_id: OMIT, metric_threshold: OMIT, streak_length_threshold: OMIT, metric_name: OMIT, achievement_name: OMIT, user_attributes: OMIT, event_attribute: OMIT, created: OMIT, updated: OMIT, additional_properties: nil) ⇒ TrophyApiClient::PointsTriggerResponse

Parameters:

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

    The unique ID of the trigger.

  • type (TrophyApiClient::PointsTriggerResponseType) (defaults to: OMIT) —

    The type of trigger.

  • points (Float) (defaults to: OMIT) —

    The points awarded by this trigger.

  • status (TrophyApiClient::PointsTriggerResponseStatus) (defaults to: OMIT) —

    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 (Float) (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 (Float) (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.

  • 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) (defaults to: OMIT) —

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

  • updated (DateTime) (defaults to: OMIT) —

    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



79
80
81
82
83
84
85
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
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 79

def initialize(id: OMIT, type: OMIT, points: OMIT, status: OMIT, achievement_id: OMIT, metric_id: OMIT,
               metric_threshold: OMIT, streak_length_threshold: OMIT, metric_name: OMIT, achievement_name: OMIT, user_attributes: OMIT, event_attribute: OMIT, created: OMIT, updated: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @type = type if type != OMIT
  @points = points if points != OMIT
  @status = status if status != OMIT
  @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
  @user_attributes = user_attributes if user_attributes != OMIT
  @event_attribute = event_attribute if event_attribute != OMIT
  @created = created if created != OMIT
  @updated = updated if updated != OMIT
  @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,
    "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.



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

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.



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

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



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

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.



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

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:



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

def event_attribute
  @event_attribute
end

#id ⇒ String (readonly)

Returns The unique ID of the trigger.

Returns:

  • (String) —

    The unique ID of the trigger.



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

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.



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

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.



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

def metric_name
  @metric_name
end

#metric_threshold ⇒ Float (readonly)

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

Returns:

  • (Float) —

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



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

def metric_threshold
  @metric_threshold
end

#points ⇒ Float (readonly)

Returns The points awarded by this trigger.

Returns:

  • (Float) —

    The points awarded by this trigger.



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

def points
  @points
end

#status ⇒ TrophyApiClient::PointsTriggerResponseStatus (readonly)

Returns The status of the trigger.

Returns:



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

def status
  @status
end

#streak_length_threshold ⇒ Float (readonly)

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

Returns:

  • (Float) —

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



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

def streak_length_threshold
  @streak_length_threshold
end

#type ⇒ TrophyApiClient::PointsTriggerResponseType (readonly)

Returns The type of trigger.

Returns:



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

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.



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

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:



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

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:



120
121
122
123
124
125
126
127
128
129
130
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
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 120

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"]
  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,
    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) 


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 177

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?(Float) != 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?(Float) != false || raise("Passed value for field obj.metric_threshold is not the expected type, validation failed.")
  obj.streak_length_threshold&.is_a?(Float) != 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.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) 


167
168
169
 
# File 'lib/trophy_api_client/types/points_trigger_response.rb', line 167

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