trophy_api_client 1.0.29 → 1.0.31

data/lib/trophy_api_client/types/leaderboard_response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "leaderboard_response_status"
 require_relative "leaderboard_response_rank_by"
+require_relative "leaderboard_response_run_unit"
 require "ostruct"
 require "json"
 
@@ -14,10 +14,10 @@ module TrophyApiClient
     attr_reader :name
     # @return [String] The unique key used to reference the leaderboard in APIs.
     attr_reader :key
-    # @return [TrophyApiClient::LeaderboardResponseStatus] The status of the leaderboard.
-    attr_reader :status
     # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
     attr_reader :rank_by
+    # @return [String] The key of the attribute to break down this leaderboard by.
+    attr_reader :breakdown_attribute
     # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
     attr_reader :metric_key
     # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
@@ -35,7 +35,7 @@ module TrophyApiClient
     attr_reader :end_
     # @return [Integer] The maximum number of participants in the leaderboard.
     attr_reader :max_participants
-    # @return [String] The repetition type for recurring leaderboards, or null for one-time
+    # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
     #  leaderboards.
     attr_reader :run_unit
     # @return [Integer] The interval between repetitions, relative to the start date and repetition
@@ -52,8 +52,8 @@ module TrophyApiClient
     # @param id [String] The unique ID of the leaderboard.
     # @param name [String] The user-facing name of the leaderboard.
     # @param key [String] The unique key used to reference the leaderboard in APIs.
-    # @param status [TrophyApiClient::LeaderboardResponseStatus] The status of the leaderboard.
     # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+    # @param breakdown_attribute [String] The key of the attribute to break down this leaderboard by.
     # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
     # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
     # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
@@ -63,24 +63,24 @@ module TrophyApiClient
     # @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
     #  forever.
     # @param max_participants [Integer] The maximum number of participants in the leaderboard.
-    # @param run_unit [String] The repetition type for recurring leaderboards, or null for one-time
+    # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
     #  leaderboards.
     # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
     #  type.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::LeaderboardResponse]
-    def initialize(id:, name:, key:, rank_by:, start:, max_participants:, run_interval:, status: OMIT, metric_key: OMIT, metric_name: OMIT,
-                   points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
+    def initialize(id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, 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)
       @id = id
       @name = name
       @key = key
-      @status = status if status != OMIT
       @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
+      @description = description
       @start = start
       @end_ = end_ if end_ != OMIT
       @max_participants = max_participants
@@ -91,8 +91,8 @@ module TrophyApiClient
         "id": id,
         "name": name,
         "key": key,
-        "status": status,
         "rankBy": rank_by,
+        "breakdownAttribute": breakdown_attribute,
         "metricKey": metric_key,
         "metricName": metric_name,
         "pointsSystemKey": points_system_key,
@@ -118,8 +118,8 @@ module TrophyApiClient
       id = parsed_json["id"]
       name = parsed_json["name"]
       key = parsed_json["key"]
-      status = parsed_json["status"]
       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"]
@@ -134,8 +134,8 @@ module TrophyApiClient
         id: id,
         name: name,
         key: key,
-        status: status,
         rank_by: rank_by,
+        breakdown_attribute: breakdown_attribute,
         metric_key: metric_key,
         metric_name: metric_name,
         points_system_key: points_system_key,
@@ -167,17 +167,17 @@ module TrophyApiClient
       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.status&.is_a?(TrophyApiClient::LeaderboardResponseStatus) != false || raise("Passed value for field obj.status 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.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?(String) != false || raise("Passed value for field obj.run_unit 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
   end

data/lib/trophy_api_client/types/leaderboard_response_run_unit.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The repetition type for recurring leaderboards, or null for one-time
+  #  leaderboards.
+  class LeaderboardResponseRunUnit
+    DAY = "day"
+    MONTH = "month"
+    YEAR = "year"
+  end
+end

data/lib/trophy_api_client/types/leaderboard_response_with_rankings.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+require_relative "leaderboard_response_with_rankings_status"
 require_relative "leaderboard_ranking"
-require_relative "leaderboard_response_status"
 require_relative "leaderboard_response_rank_by"
+require_relative "leaderboard_response_run_unit"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
   class LeaderboardResponseWithRankings
+    # @return [TrophyApiClient::LeaderboardResponseWithRankingsStatus] The status of the leaderboard.
+    attr_reader :status
     # @return [Array<TrophyApiClient::LeaderboardRanking>] Array of user rankings for the leaderboard.
     attr_reader :rankings
     # @return [String] The unique ID of the leaderboard.
@@ -16,10 +19,10 @@ module TrophyApiClient
     attr_reader :name
     # @return [String] The unique key used to reference the leaderboard in APIs.
     attr_reader :key
-    # @return [TrophyApiClient::LeaderboardResponseStatus] The status of the leaderboard.
-    attr_reader :status
     # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
     attr_reader :rank_by
+    # @return [String] The key of the attribute to break down this leaderboard by.
+    attr_reader :breakdown_attribute
     # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
     attr_reader :metric_key
     # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
@@ -37,7 +40,7 @@ module TrophyApiClient
     attr_reader :end_
     # @return [Integer] The maximum number of participants in the leaderboard.
     attr_reader :max_participants
-    # @return [String] The repetition type for recurring leaderboards, or null for one-time
+    # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
     #  leaderboards.
     attr_reader :run_unit
     # @return [Integer] The interval between repetitions, relative to the start date and repetition
@@ -51,12 +54,13 @@ module TrophyApiClient
 
     OMIT = Object.new
 
+    # @param status [TrophyApiClient::LeaderboardResponseWithRankingsStatus] The status of the leaderboard.
     # @param rankings [Array<TrophyApiClient::LeaderboardRanking>] Array of user rankings for the leaderboard.
     # @param id [String] The unique ID of the leaderboard.
     # @param name [String] The user-facing name of the leaderboard.
     # @param key [String] The unique key used to reference the leaderboard in APIs.
-    # @param status [TrophyApiClient::LeaderboardResponseStatus] The status of the leaderboard.
     # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+    # @param breakdown_attribute [String] The key of the attribute to break down this leaderboard by.
     # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
     # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
     # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
@@ -66,25 +70,26 @@ module TrophyApiClient
     # @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
     #  forever.
     # @param max_participants [Integer] The maximum number of participants in the leaderboard.
-    # @param run_unit [String] The repetition type for recurring leaderboards, or null for one-time
+    # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
     #  leaderboards.
     # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
     #  type.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::LeaderboardResponseWithRankings]
-    def initialize(rankings:, id:, name:, key:, rank_by:, start:, max_participants:, run_interval:, status: OMIT, metric_key: OMIT, metric_name: OMIT,
-                   points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
+    def initialize(status:, rankings:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, 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)
+      @status = status
       @rankings = rankings
       @id = id
       @name = name
       @key = key
-      @status = status if status != OMIT
       @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
+      @description = description
       @start = start
       @end_ = end_ if end_ != OMIT
       @max_participants = max_participants
@@ -92,12 +97,13 @@ module TrophyApiClient
       @run_interval = run_interval
       @additional_properties = additional_properties
       @_field_set = {
+        "status": status,
         "rankings": rankings,
         "id": id,
         "name": name,
         "key": key,
-        "status": status,
         "rankBy": rank_by,
+        "breakdownAttribute": breakdown_attribute,
         "metricKey": metric_key,
         "metricName": metric_name,
         "pointsSystemKey": points_system_key,
@@ -120,6 +126,7 @@ module TrophyApiClient
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      status = parsed_json["status"]
       rankings = parsed_json["rankings"]&.map do |item|
         item = item.to_json
         TrophyApiClient::LeaderboardRanking.from_json(json_object: item)
@@ -127,8 +134,8 @@ module TrophyApiClient
       id = parsed_json["id"]
       name = parsed_json["name"]
       key = parsed_json["key"]
-      status = parsed_json["status"]
       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"]
@@ -140,12 +147,13 @@ module TrophyApiClient
       run_unit = parsed_json["runUnit"]
       run_interval = parsed_json["runInterval"]
       new(
+        status: status,
         rankings: rankings,
         id: id,
         name: name,
         key: key,
-        status: status,
         rank_by: rank_by,
+        breakdown_attribute: breakdown_attribute,
         metric_key: metric_key,
         metric_name: metric_name,
         points_system_key: points_system_key,
@@ -174,21 +182,22 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.status.is_a?(TrophyApiClient::LeaderboardResponseWithRankingsStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
       obj.rankings.is_a?(Array) != false || raise("Passed value for field obj.rankings 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.status&.is_a?(TrophyApiClient::LeaderboardResponseStatus) != false || raise("Passed value for field obj.status 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.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?(String) != false || raise("Passed value for field obj.run_unit 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
   end

data/lib/trophy_api_client/types/{leaderboard_response_status.rb → leaderboard_response_with_rankings_status.rb}

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   # The status of the leaderboard.
-  class LeaderboardResponseStatus
+  class LeaderboardResponseWithRankingsStatus
     ACTIVE = "active"
     SCHEDULED = "scheduled"
     FINISHED = "finished"

data/lib/trophy_api_client/types/metric_event_leaderboard_response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "leaderboard_response_status"
 require_relative "leaderboard_response_rank_by"
+require_relative "leaderboard_response_run_unit"
 require "ostruct"
 require "json"
 
@@ -16,19 +16,22 @@ module TrophyApiClient
     # @return [Integer] The user's rank in the leaderboard before the event, or null if the user was not
     #  on the leaderboard before the event.
     attr_reader :previous_rank
-    # @return [Float] The minimum value required to enter the leaderboard according to its current
+    # @return [Integer] The minimum value required to enter the leaderboard according to its current
     #  rankings.
     attr_reader :threshold
+    # @return [String] For leaderboards with a breakdown attribute, the value of the attribute for the
+    #  user.
+    attr_reader :breakdown_attribute_value
     # @return [String] The unique ID of the leaderboard.
     attr_reader :id
     # @return [String] The user-facing name of the leaderboard.
     attr_reader :name
     # @return [String] The unique key used to reference the leaderboard in APIs.
     attr_reader :key
-    # @return [TrophyApiClient::LeaderboardResponseStatus] The status of the leaderboard.
-    attr_reader :status
     # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
     attr_reader :rank_by
+    # @return [String] The key of the attribute to break down this leaderboard by.
+    attr_reader :breakdown_attribute
     # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
     attr_reader :metric_key
     # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
@@ -43,7 +46,7 @@ module TrophyApiClient
     attr_reader :start
     # @return [Integer] The maximum number of participants in the leaderboard.
     attr_reader :max_participants
-    # @return [String] The repetition type for recurring leaderboards, or null for one-time
+    # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
     #  leaderboards.
     attr_reader :run_unit
     # @return [Integer] The interval between repetitions, relative to the start date and repetition
@@ -63,13 +66,15 @@ module TrophyApiClient
     #  leaderboard.
     # @param previous_rank [Integer] The user's rank in the leaderboard before the event, or null if the user was not
     #  on the leaderboard before the event.
-    # @param threshold [Float] The minimum value required to enter the leaderboard according to its current
+    # @param threshold [Integer] The minimum value required to enter the leaderboard according to its current
     #  rankings.
+    # @param breakdown_attribute_value [String] For leaderboards with a breakdown attribute, the value of the attribute for the
+    #  user.
     # @param id [String] The unique ID of the leaderboard.
     # @param name [String] The user-facing name of the leaderboard.
     # @param key [String] The unique key used to reference the leaderboard in APIs.
-    # @param status [TrophyApiClient::LeaderboardResponseStatus] The status of the leaderboard.
     # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+    # @param breakdown_attribute [String] The key of the attribute to break down this leaderboard by.
     # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
     # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
     # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
@@ -77,28 +82,29 @@ module TrophyApiClient
     # @param description [String] The user-facing description of the leaderboard.
     # @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
     # @param max_participants [Integer] The maximum number of participants in the leaderboard.
-    # @param run_unit [String] The repetition type for recurring leaderboards, or null for one-time
+    # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
     #  leaderboards.
     # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
     #  type.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricEventLeaderboardResponse]
-    def initialize(threshold:, id:, name:, key:, rank_by:, start:, max_participants:, run_interval:, end_: OMIT, rank: OMIT, previous_rank: OMIT, status: OMIT,
-                   metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, run_unit: OMIT, additional_properties: nil)
+    def initialize(threshold:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:,
+                   end_: OMIT, rank: OMIT, previous_rank: OMIT, breakdown_attribute_value: OMIT, breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, run_unit: OMIT, additional_properties: nil)
       @end_ = end_ if end_ != OMIT
       @rank = rank if rank != OMIT
       @previous_rank = previous_rank if previous_rank != OMIT
       @threshold = threshold
+      @breakdown_attribute_value = breakdown_attribute_value if breakdown_attribute_value != OMIT
       @id = id
       @name = name
       @key = key
-      @status = status if status != OMIT
       @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
+      @description = description
       @start = start
       @max_participants = max_participants
       @run_unit = run_unit if run_unit != OMIT
@@ -109,11 +115,12 @@ module TrophyApiClient
         "rank": rank,
         "previousRank": previous_rank,
         "threshold": threshold,
+        "breakdownAttributeValue": breakdown_attribute_value,
         "id": id,
         "name": name,
         "key": key,
-        "status": status,
         "rankBy": rank_by,
+        "breakdownAttribute": breakdown_attribute,
         "metricKey": metric_key,
         "metricName": metric_name,
         "pointsSystemKey": points_system_key,
@@ -139,11 +146,12 @@ module TrophyApiClient
       rank = parsed_json["rank"]
       previous_rank = parsed_json["previousRank"]
       threshold = parsed_json["threshold"]
+      breakdown_attribute_value = parsed_json["breakdownAttributeValue"]
       id = parsed_json["id"]
       name = parsed_json["name"]
       key = parsed_json["key"]
-      status = parsed_json["status"]
       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"]
@@ -158,11 +166,12 @@ module TrophyApiClient
         rank: rank,
         previous_rank: previous_rank,
         threshold: threshold,
+        breakdown_attribute_value: breakdown_attribute_value,
         id: id,
         name: name,
         key: key,
-        status: status,
         rank_by: rank_by,
+        breakdown_attribute: breakdown_attribute,
         metric_key: metric_key,
         metric_name: metric_name,
         points_system_key: points_system_key,
@@ -193,20 +202,21 @@ module TrophyApiClient
       obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ 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.previous_rank&.is_a?(Integer) != false || raise("Passed value for field obj.previous_rank is not the expected type, validation failed.")
-      obj.threshold.is_a?(Float) != false || raise("Passed value for field obj.threshold is not the expected type, validation failed.")
+      obj.threshold.is_a?(Integer) != false || raise("Passed value for field obj.threshold is not the expected type, validation failed.")
+      obj.breakdown_attribute_value&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute_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.status&.is_a?(TrophyApiClient::LeaderboardResponseStatus) != false || raise("Passed value for field obj.status 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.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.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?(String) != false || raise("Passed value for field obj.run_unit 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
   end

data/lib/trophy_api_client/types/metric_event_points_response.rb

@@ -6,17 +6,21 @@ require "json"
 
 module TrophyApiClient
   class MetricEventPointsResponse
-    # @return [Float] The points added by this event.
+    # @return [Integer] The points added by this event.
     attr_reader :added
     # @return [String] The ID of the points system
     attr_reader :id
+    # @return [String] The key of the points system
+    attr_reader :key
     # @return [String] The name of the points system
     attr_reader :name
     # @return [String] The description of the points system
     attr_reader :description
     # @return [String] The URL of the badge image for the points system
     attr_reader :badge_url
-    # @return [Float] The user's total points
+    # @return [Float] The maximum number of points a user can be awarded in this points system
+    attr_reader :max_points
+    # @return [Integer] The user's total points
     attr_reader :total
     # @return [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
     attr_reader :awards
@@ -28,31 +32,37 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param added [Float] The points added by this event.
+    # @param added [Integer] The points added by this event.
     # @param id [String] The ID of the points system
+    # @param key [String] The key of the points system
     # @param name [String] The name of the points system
     # @param description [String] The description of the points system
     # @param badge_url [String] The URL of the badge image for the points system
-    # @param total [Float] The user's total points
+    # @param max_points [Float] The maximum number of points a user can be awarded in this points system
+    # @param total [Integer] The user's total points
     # @param awards [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricEventPointsResponse]
-    def initialize(id:, name:, total:, awards:, added: OMIT, description: OMIT, badge_url: OMIT,
+    def initialize(added:, id:, key:, name:, total:, awards:, description: OMIT, badge_url: OMIT, max_points: OMIT,
                    additional_properties: nil)
-      @added = added if added != OMIT
+      @added = added
       @id = id
+      @key = key
       @name = name
       @description = description if description != OMIT
       @badge_url = badge_url if badge_url != OMIT
+      @max_points = max_points if max_points != OMIT
       @total = total
       @awards = awards
       @additional_properties = additional_properties
       @_field_set = {
         "added": added,
         "id": id,
+        "key": key,
         "name": name,
         "description": description,
         "badgeUrl": badge_url,
+        "maxPoints": max_points,
         "total": total,
         "awards": awards
       }.reject do |_k, v|
@@ -69,9 +79,11 @@ module TrophyApiClient
       parsed_json = JSON.parse(json_object)
       added = parsed_json["added"]
       id = parsed_json["id"]
+      key = parsed_json["key"]
       name = parsed_json["name"]
       description = parsed_json["description"]
       badge_url = parsed_json["badgeUrl"]
+      max_points = parsed_json["maxPoints"]
       total = parsed_json["total"]
       awards = parsed_json["awards"]&.map do |item|
         item = item.to_json
@@ -80,9 +92,11 @@ module TrophyApiClient
       new(
         added: added,
         id: id,
+        key: key,
         name: name,
         description: description,
         badge_url: badge_url,
+        max_points: max_points,
         total: total,
         awards: awards,
         additional_properties: struct
@@ -103,12 +117,14 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.added&.is_a?(Float) != false || raise("Passed value for field obj.added is not the expected type, validation failed.")
+      obj.added.is_a?(Integer) != false || raise("Passed value for field obj.added 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.key.is_a?(String) != false || raise("Passed value for field obj.key 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.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
       obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url is not the expected type, validation failed.")
-      obj.total.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+      obj.max_points&.is_a?(Float) != false || raise("Passed value for field obj.max_points is not the expected type, validation failed.")
+      obj.total.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
       obj.awards.is_a?(Array) != false || raise("Passed value for field obj.awards is not the expected type, validation failed.")
     end
   end

data/lib/trophy_api_client/types/metric_event_streak_response.rb

@@ -58,9 +58,9 @@ module TrophyApiClient
     #  the organization has enabled streak freeze auto-earn.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricEventStreakResponse]
-    def initialize(length:, frequency:, extended: OMIT, started: OMIT, period_start: OMIT, period_end: OMIT,
-                   expires: OMIT, freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
-      @extended = extended if extended != OMIT
+    def initialize(extended:, length:, frequency:, started: OMIT, period_start: OMIT, period_end: OMIT, expires: OMIT,
+                   freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
+      @extended = extended
       @length = length
       @frequency = frequency
       @started = started if started != OMIT
@@ -137,7 +137,7 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.extended&.is_a?(Boolean) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
+      obj.extended.is_a?(Boolean) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
       obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
       obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
       obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")

data/lib/trophy_api_client/types/points_award.rb

@@ -8,11 +8,11 @@ module TrophyApiClient
   class PointsAward
     # @return [String] The ID of the trigger award
     attr_reader :id
-    # @return [Float] The points awarded by this trigger
+    # @return [Integer] The points awarded by this trigger
     attr_reader :awarded
     # @return [String] The date these points were awarded, in ISO 8601 format.
     attr_reader :date
-    # @return [Float] The user's total points after this award occurred.
+    # @return [Integer] The user's total points after this award occurred.
     attr_reader :total
     # @return [TrophyApiClient::PointsTrigger]
     attr_reader :trigger
@@ -25,9 +25,9 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param id [String] The ID of the trigger award
-    # @param awarded [Float] The points awarded by this trigger
+    # @param awarded [Integer] The points awarded by this trigger
     # @param date [String] The date these points were awarded, in ISO 8601 format.
-    # @param total [Float] The user's total points after this award occurred.
+    # @param total [Integer] The user's total points after this award occurred.
     # @param trigger [TrophyApiClient::PointsTrigger]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::PointsAward]
@@ -91,9 +91,9 @@ module TrophyApiClient
     # @return [Void]
     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.awarded&.is_a?(Float) != false || raise("Passed value for field obj.awarded is not the expected type, validation failed.")
+      obj.awarded&.is_a?(Integer) != false || raise("Passed value for field obj.awarded is not the expected type, validation failed.")
       obj.date&.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
-      obj.total&.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+      obj.total&.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
       obj.trigger.nil? || TrophyApiClient::PointsTrigger.validate_raw(obj: obj.trigger)
     end
   end