Class: TrophyApiClient::UserLeaderboardResponseWithHistory

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

Overview

A user’s data for a specific leaderboard including rank, value, and history.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(history:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, rank: OMIT, value: OMIT, breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil) ⇒ TrophyApiClient::UserLeaderboardResponseWithHistory

Parameters:

  • history (Array<TrophyApiClient::LeaderboardEvent>) —

    An array of events showing the user’s rank and value changes over time.

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

    The user’s current rank in this leaderboard. Null if the user is not on the leaderboard.

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

    The user’s current value in this leaderboard. Null if the user is not on the leaderboard.

  • id (String) —

    The unique ID of the leaderboard.

  • name (String) —

    The user-facing name of the leaderboard.

  • key (String) —

    The unique key used to reference the leaderboard in APIs.

  • rank_by (TrophyApiClient::LeaderboardResponseRankBy) —

    What the leaderboard ranks by.

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

    The key of the attribute to break down this leaderboard by.

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

    The key of the metric to rank by, if rankBy is ‘metric’.

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

    The name of the metric to rank by, if rankBy is ‘metric’.

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

    The key of the points system to rank by, if rankBy is ‘points’.

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

    The name of the points system to rank by, if rankBy is ‘points’.

  • description (String) —

    The user-facing description of the leaderboard.

  • start (String) —

    The start date of the leaderboard in YYYY-MM-DD format.

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

    The end date of the leaderboard in YYYY-MM-DD format, or null if it runs forever.

  • max_participants (Integer) —

    The maximum number of participants in the leaderboard.

  • run_unit (TrophyApiClient::LeaderboardResponseRunUnit) (defaults to: OMIT) —

    The repetition type for recurring leaderboards, or null for one-time leaderboards.

  • run_interval (Integer) —

    The interval between repetitions, relative to the start date and repetition type.

  • 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
126
127
128
129
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 86

def initialize(history:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, rank: OMIT, value: OMIT, breakdown_attribute: OMIT,
               metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
  @history = history
  @rank = rank if rank != OMIT
  @value = value if value != OMIT
  @id = id
  @name = name
  @key = key
  @rank_by = rank_by
  @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
  @metric_key = metric_key if metric_key != OMIT
  @metric_name = metric_name if metric_name != OMIT
  @points_system_key = points_system_key if points_system_key != OMIT
  @points_system_name = points_system_name if points_system_name != OMIT
  @description = description
  @start = start
  @end_ = end_ if end_ != OMIT
  @max_participants = max_participants
  @run_unit = run_unit if run_unit != OMIT
  @run_interval = run_interval
  @additional_properties = additional_properties
  @_field_set = {
    "history": history,
    "rank": rank,
    "value": value,
    "id": id,
    "name": name,
    "key": key,
    "rankBy": rank_by,
    "breakdownAttribute": breakdown_attribute,
    "metricKey": metric_key,
    "metricName": metric_name,
    "pointsSystemKey": points_system_key,
    "pointsSystemName": points_system_name,
    "description": description,
    "start": start,
    "end": end_,
    "maxParticipants": max_participants,
    "runUnit": run_unit,
    "runInterval": run_interval
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#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/user_leaderboard_response_with_history.rb', line 54

def additional_properties
  @additional_properties
end

#breakdown_attribute ⇒ String (readonly)

Returns The key of the attribute to break down this leaderboard by.

Returns:

  • (String) —

    The key of the attribute to break down this leaderboard by.



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

def breakdown_attribute
  @breakdown_attribute
end

#description ⇒ String (readonly)

Returns The user-facing description of the leaderboard.

Returns:

  • (String) —

    The user-facing description of the leaderboard.



39
40
41
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 39

def description
  @description
end

#end_ ⇒ String (readonly)

Returns The end date of the leaderboard in YYYY-MM-DD format, or null if it runs forever.

Returns:

  • (String) —

    The end date of the leaderboard in YYYY-MM-DD format, or null if it runs forever.



44
45
46
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 44

def end_
  @end_
end

#history ⇒ Array<TrophyApiClient::LeaderboardEvent> (readonly)

Returns An array of events showing the user’s rank and value changes over time.

Returns:



13
14
15
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 13

def history
  @history
end

#id ⇒ String (readonly)

Returns The unique ID of the leaderboard.

Returns:

  • (String) —

    The unique ID of the leaderboard.



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

def id
  @id
end

#key ⇒ String (readonly)

Returns The unique key used to reference the leaderboard in APIs.

Returns:

  • (String) —

    The unique key used to reference the leaderboard in APIs.



25
26
27
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 25

def key
  @key
end

#max_participants ⇒ Integer (readonly)

Returns The maximum number of participants in the leaderboard.

Returns:

  • (Integer) —

    The maximum number of participants in the leaderboard.



46
47
48
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 46

def max_participants
  @max_participants
end

#metric_key ⇒ String (readonly)

Returns The key of the metric to rank by, if rankBy is ‘metric’.

Returns:

  • (String) —

    The key of the metric to rank by, if rankBy is ‘metric’.



31
32
33
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 31

def metric_key
  @metric_key
end

#metric_name ⇒ String (readonly)

Returns The name of the metric to rank by, if rankBy is ‘metric’.

Returns:

  • (String) —

    The name of the metric to rank by, if rankBy is ‘metric’.



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

def metric_name
  @metric_name
end

#name ⇒ String (readonly)

Returns The user-facing name of the leaderboard.

Returns:

  • (String) —

    The user-facing name of the leaderboard.



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

def name
  @name
end

#points_system_key ⇒ String (readonly)

Returns The key of the points system to rank by, if rankBy is ‘points’.

Returns:

  • (String) —

    The key of the points system to rank by, if rankBy is ‘points’.



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

def points_system_key
  @points_system_key
end

#points_system_name ⇒ String (readonly)

Returns The name of the points system to rank by, if rankBy is ‘points’.

Returns:

  • (String) —

    The name of the points system to rank by, if rankBy is ‘points’.



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

def points_system_name
  @points_system_name
end

#rank ⇒ Integer (readonly)

Returns The user’s current rank in this leaderboard. Null if the user is not on the leaderboard.

Returns:

  • (Integer) —

    The user’s current rank in this leaderboard. Null if the user is not on the leaderboard.



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

def rank
  @rank
end

#rank_by ⇒ TrophyApiClient::LeaderboardResponseRankBy (readonly)

Returns What the leaderboard ranks by.

Returns:



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

def rank_by
  @rank_by
end

#run_interval ⇒ Integer (readonly)

Returns The interval between repetitions, relative to the start date and repetition type.

Returns:

  • (Integer) —

    The interval between repetitions, relative to the start date and repetition type.



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

def run_interval
  @run_interval
end

#run_unit ⇒ TrophyApiClient::LeaderboardResponseRunUnit (readonly)

Returns The repetition type for recurring leaderboards, or null for one-time leaderboards.

Returns:



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

def run_unit
  @run_unit
end

#start ⇒ String (readonly)

Returns The start date of the leaderboard in YYYY-MM-DD format.

Returns:

  • (String) —

    The start date of the leaderboard in YYYY-MM-DD format.



41
42
43
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 41

def start
  @start
end

#value ⇒ Integer (readonly)

Returns The user’s current value in this leaderboard. Null if the user is not on the leaderboard.

Returns:

  • (Integer) —

    The user’s current value in this leaderboard. Null if the user is not on the leaderboard.



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

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::UserLeaderboardResponseWithHistory

Deserialize a JSON object to an instance of UserLeaderboardResponseWithHistory

Parameters:

  • json_object (String)

Returns:



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
178
179
180
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 135

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  history = parsed_json["history"]&.map do |item|
    item = item.to_json
    TrophyApiClient::LeaderboardEvent.from_json(json_object: item)
  end
  rank = parsed_json["rank"]
  value = parsed_json["value"]
  id = parsed_json["id"]
  name = parsed_json["name"]
  key = parsed_json["key"]
  rank_by = parsed_json["rankBy"]
  breakdown_attribute = parsed_json["breakdownAttribute"]
  metric_key = parsed_json["metricKey"]
  metric_name = parsed_json["metricName"]
  points_system_key = parsed_json["pointsSystemKey"]
  points_system_name = parsed_json["pointsSystemName"]
  description = parsed_json["description"]
  start = parsed_json["start"]
  end_ = parsed_json["end"]
  max_participants = parsed_json["maxParticipants"]
  run_unit = parsed_json["runUnit"]
  run_interval = parsed_json["runInterval"]
  new(
    history: history,
    rank: rank,
    value: value,
    id: id,
    name: name,
    key: key,
    rank_by: rank_by,
    breakdown_attribute: breakdown_attribute,
    metric_key: metric_key,
    metric_name: metric_name,
    points_system_key: points_system_key,
    points_system_name: points_system_name,
    description: description,
    start: start,
    end_: end_,
    max_participants: max_participants,
    run_unit: run_unit,
    run_interval: run_interval,
    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) 


195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 195

def self.validate_raw(obj:)
  obj.history.is_a?(Array) != false || raise("Passed value for field obj.history is not the expected type, validation failed.")
  obj.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
  obj.value&.is_a?(Integer) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
  obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
  obj.breakdown_attribute&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute is not the expected type, validation failed.")
  obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key 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.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")
  obj.points_system_name&.is_a?(String) != false || raise("Passed value for field obj.points_system_name is not the expected type, validation failed.")
  obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
  obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
  obj.max_participants.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
  obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
  obj.run_interval.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of UserLeaderboardResponseWithHistory to a JSON object

Returns:

  • (String) 


185
186
187
 
# File 'lib/trophy_api_client/types/user_leaderboard_response_with_history.rb', line 185

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