Class: TrophyApiClient::UserLeaderboardResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/types/user_leaderboard_response.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(id:, name:, key:, rank_by:, start:, max_participants:, rank: OMIT, value: OMIT, breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil) ⇒ TrophyApiClient::UserLeaderboardResponse

Parameters:

  • (defaults to: OMIT)

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

  • (defaults to: OMIT)

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

  • The unique ID of the leaderboard.

  • The user-facing name of the leaderboard.

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

  • What the leaderboard ranks by.

  • (defaults to: OMIT)

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

  • (defaults to: OMIT)

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

  • (defaults to: OMIT)

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

  • (defaults to: OMIT)

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

  • (defaults to: OMIT)

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

  • (defaults to: OMIT)

    The user-facing description of the leaderboard.

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

  • (defaults to: OMIT)

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

  • The maximum number of participants in the leaderboard.

  • (defaults to: OMIT)

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

  • (defaults to: OMIT)

    The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.

  • (defaults to: nil)

    Additional properties unmapped to the current class definition



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
115
116
117
118
119
120
121
122
123
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 82

def initialize(id:, name:, key:, rank_by:, start:, max_participants:, rank: OMIT, value: OMIT, breakdown_attribute: OMIT, metric_key: OMIT,
               metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
  @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 if description != OMIT
  @start = start
  @end_ = end_ if end_ != OMIT
  @max_participants = max_participants
  @run_unit = run_unit if run_unit != OMIT
  @run_interval = run_interval if run_interval != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "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:

  • Additional properties unmapped to the current class definition



51
52
53
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 51

def additional_properties
  @additional_properties
end

#breakdown_attribute ⇒ String (readonly)

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

Returns:

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



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

def breakdown_attribute
  @breakdown_attribute
end

#description ⇒ String (readonly)

Returns The user-facing description of the leaderboard.

Returns:

  • The user-facing description of the leaderboard.



36
37
38
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 36

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:

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



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

def end_
  @end_
end

#id ⇒ String (readonly)

Returns The unique ID of the leaderboard.

Returns:

  • The unique ID of the leaderboard.



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

def id
  @id
end

#key ⇒ String (readonly)

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

Returns:

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



22
23
24
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 22

def key
  @key
end

#max_participants ⇒ Integer (readonly)

Returns The maximum number of participants in the leaderboard.

Returns:

  • The maximum number of participants in the leaderboard.



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

def max_participants
  @max_participants
end

#metric_key ⇒ String (readonly)

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

Returns:

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



28
29
30
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 28

def metric_key
  @metric_key
end

#metric_name ⇒ String (readonly)

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

Returns:

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



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

def metric_name
  @metric_name
end

#name ⇒ String (readonly)

Returns The user-facing name of the leaderboard.

Returns:

  • The user-facing name of the leaderboard.



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

def name
  @name
end

#points_system_key ⇒ String (readonly)

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

Returns:

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



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

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:

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



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

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:

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



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

def rank
  @rank
end

#rank_by ⇒ TrophyApiClient::LeaderboardResponseRankBy (readonly)

Returns What the leaderboard ranks by.

Returns:

  • What the leaderboard ranks by.



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

def rank_by
  @rank_by
end

#run_interval ⇒ Integer (readonly)

Returns The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.

Returns:

  • The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.



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

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:

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



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

def run_unit
  @run_unit
end

#start ⇒ String (readonly)

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

Returns:

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



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

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:

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



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

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::UserLeaderboardResponse

Deserialize a JSON object to an instance of UserLeaderboardResponse

Parameters:

Returns:



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
163
164
165
166
167
168
169
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 129

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  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(
    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:

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 184

def self.validate_raw(obj:)
  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 UserLeaderboardResponse to a JSON object

Returns:



174
175
176
 
# File 'lib/trophy_api_client/types/user_leaderboard_response.rb', line 174

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