Class: TrophyApiClient::LeaderboardResponse

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

Overview

A leaderboard with its configuration details.

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:, 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::LeaderboardResponse

Parameters:

  • 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



72
73
74
75
76
77
78
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
 
# File 'lib/trophy_api_client/types/leaderboard_response.rb', line 72

def initialize(id:, name:, key:, rank_by:, start:, max_participants:, 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)
  @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 = {
    "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



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

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.



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

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.



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

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.



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

def end_
  @end_
end

#id ⇒ String (readonly)

Returns The unique ID of the leaderboard.

Returns:

  • The unique ID of the leaderboard.



12
13
14
 
# File 'lib/trophy_api_client/types/leaderboard_response.rb', line 12

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.



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

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.



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

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’.



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

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’.



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

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.



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

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’.



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

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’.



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

def points_system_name
  @points_system_name
end

#rank_by ⇒ TrophyApiClient::LeaderboardResponseRankBy (readonly)

Returns What the leaderboard ranks by.

Returns:

  • What the leaderboard ranks by.



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

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.



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

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.



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

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.



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

def start
  @start
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::LeaderboardResponse

Deserialize a JSON object to an instance of LeaderboardResponse

Parameters:

Returns:



115
116
117
118
119
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
 
# File 'lib/trophy_api_client/types/leaderboard_response.rb', line 115

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/trophy_api_client/types/leaderboard_response.rb', line 166

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.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 LeaderboardResponse to a JSON object

Returns:



156
157
158
 
# File 'lib/trophy_api_client/types/leaderboard_response.rb', line 156

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