trophy_api_client 1.0.23 → 1.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39897ab7658149ab5f3bf2a97e23eb07e0f2a2e2e5efc65e44b3aa70ca4ca36b
-  data.tar.gz: c202d22246b40b860ea0e201b8f90df0379fbb2c0330913c89b44d969ddafc3c
+  metadata.gz: 3e83bc714888213fee4230e282f81c84167b7a06f299bfb64fa88c6f31fdbccf
+  data.tar.gz: 8a8fd15093b0f52a3e740eda1c09992fafea425a66a3ec699ce4e4bd335f1a63
 SHA512:
-  metadata.gz: b1716545b54c6ba34b2e33306d3ee3a6a2f638597898527c3df0ddeb200bd2a5686801661d41542bd36ebbf4cc005807bdcc81ab8c39f3cfc8de6dfccb423ae5
-  data.tar.gz: 5f6a490904fb8842edc52c718c3e1559d5c3d048a920cfa5e0d4255f8dce0d9c83b4d4ae3d199513f25cee5c52e38c101fc62b5887b8a6ce58f713a950b7e4aa
+  metadata.gz: db6436076a0426b84f0d1db8d6be58d0b37333cc72af12141e0823add83f0688eedb2ae9ab184b43b748daaf34dcc6ca7f35e29fc1aedb8a0caad445f391b038
+  data.tar.gz: e3951f80976187af389151dcadef50b80089d30f9525c0f5abecd382538fa2507045f9221b3bddda585979e00fe12fdef6d9b018f8aa465c78f94e14431f680f

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.0.23"
+    VERSION = "1.0.25"
     AUTHORS = ["Trophy Labs, Inc"].freeze
     EMAIL = ""
     SUMMARY = "Ruby library for the Trophy API."

data/lib/trophy_api_client/leaderboards/client.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/leaderboard_response"
+require "json"
+require_relative "../types/leaderboard_response_with_rankings"
+require "async"
+
+module TrophyApiClient
+  class LeaderboardsClient
+    # @return [TrophyApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::RequestClient]
+    # @return [TrophyApiClient::LeaderboardsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get all active leaderboards for your organization.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::LeaderboardResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.leaderboards.all
+    def all(request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/leaderboards"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::LeaderboardResponse.from_json(json_object: item)
+      end
+    end
+
+    # Get a specific leaderboard by its key.
+    #
+    # @param key [String] Unique key of the leaderboard as set when created.
+    # @param offset [Integer] Number of rankings to skip for pagination.
+    # @param limit [Integer] Maximum number of rankings to return.
+    # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
+    #  run.
+    # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
+    #  the user is not found in the leaderboard, returns empty rankings array.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::LeaderboardResponseWithRankings]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.leaderboards.get(
+    #    key: "weekly-words",
+    #    run: "2025-01-15",
+    #    user_id: "user-123"
+    #  )
+    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "offset": offset,
+          "limit": limit,
+          "run": run,
+          "userId": user_id
+        }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/leaderboards/#{key}"
+      end
+      TrophyApiClient::LeaderboardResponseWithRankings.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncLeaderboardsClient
+    # @return [TrophyApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::AsyncRequestClient]
+    # @return [TrophyApiClient::AsyncLeaderboardsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get all active leaderboards for your organization.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::LeaderboardResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.leaderboards.all
+    def all(request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/leaderboards"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::LeaderboardResponse.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get a specific leaderboard by its key.
+    #
+    # @param key [String] Unique key of the leaderboard as set when created.
+    # @param offset [Integer] Number of rankings to skip for pagination.
+    # @param limit [Integer] Maximum number of rankings to return.
+    # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
+    #  run.
+    # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
+    #  the user is not found in the leaderboard, returns empty rankings array.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::LeaderboardResponseWithRankings]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.leaderboards.get(
+    #    key: "weekly-words",
+    #    run: "2025-01-15",
+    #    user_id: "user-123"
+    #  )
+    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "offset": offset,
+            "limit": limit,
+            "run": run,
+            "userId": user_id
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/leaderboards/#{key}"
+        end
+        TrophyApiClient::LeaderboardResponseWithRankings.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/trophy_api_client/types/event_response.rb

@@ -15,10 +15,12 @@ module TrophyApiClient
     attr_reader :total
     # @return [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed as a result of this event.
     attr_reader :achievements
-    # @return [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @return [TrophyApiClient::MetricEventStreakResponse] The user's current streak.
     attr_reader :current_streak
-    # @return [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this event.
+    # @return [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key.
     attr_reader :points
+    # @return [Hash{String => TrophyApiClient::MetricEventLeaderboardResponse}] A map of leaderboards by key.
+    attr_reader :leaderboards
     # @return [String] The idempotency key used for the event, if one was provided.
     attr_reader :idempotency_key
     # @return [Boolean] Whether the event was replayed due to idempotency.
@@ -35,20 +37,22 @@ module TrophyApiClient
     # @param metric_id [String] The unique ID of the metric that was updated.
     # @param total [Float] The user's new total progress against the metric.
     # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed as a result of this event.
-    # @param current_streak [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
-    # @param points [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this event.
+    # @param current_streak [TrophyApiClient::MetricEventStreakResponse] The user's current streak.
+    # @param points [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key.
+    # @param leaderboards [Hash{String => TrophyApiClient::MetricEventLeaderboardResponse}] A map of leaderboards by key.
     # @param idempotency_key [String] The idempotency key used for the event, if one was provided.
     # @param idempotent_replayed [Boolean] Whether the event was replayed due to idempotency.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::EventResponse]
     def initialize(event_id:, metric_id:, total:, achievements: OMIT, current_streak: OMIT, points: OMIT,
-                   idempotency_key: OMIT, idempotent_replayed: OMIT, additional_properties: nil)
+                   leaderboards: OMIT, idempotency_key: OMIT, idempotent_replayed: OMIT, additional_properties: nil)
       @event_id = event_id
       @metric_id = metric_id
       @total = total
       @achievements = achievements if achievements != OMIT
       @current_streak = current_streak if current_streak != OMIT
       @points = points if points != OMIT
+      @leaderboards = leaderboards if leaderboards != OMIT
       @idempotency_key = idempotency_key if idempotency_key != OMIT
       @idempotent_replayed = idempotent_replayed if idempotent_replayed != OMIT
       @additional_properties = additional_properties
@@ -59,6 +63,7 @@ module TrophyApiClient
         "achievements": achievements,
         "currentStreak": current_streak,
         "points": points,
+        "leaderboards": leaderboards,
         "idempotencyKey": idempotency_key,
         "idempotentReplayed": idempotent_replayed
       }.reject do |_k, v|
@@ -90,6 +95,10 @@ module TrophyApiClient
         value = value.to_json
         TrophyApiClient::MetricEventPointsResponse.from_json(json_object: value)
       end
+      leaderboards = parsed_json["leaderboards"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::MetricEventLeaderboardResponse.from_json(json_object: value)
+      end
       idempotency_key = parsed_json["idempotencyKey"]
       idempotent_replayed = parsed_json["idempotentReplayed"]
       new(
@@ -99,6 +108,7 @@ module TrophyApiClient
         achievements: achievements,
         current_streak: current_streak,
         points: points,
+        leaderboards: leaderboards,
         idempotency_key: idempotency_key,
         idempotent_replayed: idempotent_replayed,
         additional_properties: struct
@@ -125,6 +135,7 @@ module TrophyApiClient
       obj.achievements&.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
       obj.current_streak.nil? || TrophyApiClient::MetricEventStreakResponse.validate_raw(obj: obj.current_streak)
       obj.points&.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.leaderboards&.is_a?(Hash) != false || raise("Passed value for field obj.leaderboards is not the expected type, validation failed.")
       obj.idempotency_key&.is_a?(String) != false || raise("Passed value for field obj.idempotency_key is not the expected type, validation failed.")
       obj.idempotent_replayed&.is_a?(Boolean) != false || raise("Passed value for field obj.idempotent_replayed is not the expected type, validation failed.")
     end

data/lib/trophy_api_client/types/leaderboard_event.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A leaderboard event representing a change in a user's rank or value.
+  class LeaderboardEvent
+    # @return [DateTime] The timestamp when the event occurred.
+    attr_reader :time
+    # @return [Integer] The user's rank before this event, or null if they were not on the leaderboard.
+    attr_reader :previous_rank
+    # @return [Integer] The user's rank after this event, or null if they are no longer on the
+    #  leaderboard.
+    attr_reader :rank
+    # @return [Integer] The user's value before this event, or null if they were not on the leaderboard.
+    attr_reader :previous_value
+    # @return [Integer] The user's value after this event, or null if they are no longer on the
+    #  leaderboard.
+    attr_reader :value
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param time [DateTime] The timestamp when the event occurred.
+    # @param previous_rank [Integer] The user's rank before this event, or null if they were not on the leaderboard.
+    # @param rank [Integer] The user's rank after this event, or null if they are no longer on the
+    #  leaderboard.
+    # @param previous_value [Integer] The user's value before this event, or null if they were not on the leaderboard.
+    # @param value [Integer] The user's value after this event, or null if they are no longer on the
+    #  leaderboard.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::LeaderboardEvent]
+    def initialize(time:, previous_rank: OMIT, rank: OMIT, previous_value: OMIT, value: OMIT,
+                   additional_properties: nil)
+      @time = time
+      @previous_rank = previous_rank if previous_rank != OMIT
+      @rank = rank if rank != OMIT
+      @previous_value = previous_value if previous_value != OMIT
+      @value = value if value != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "time": time,
+        "previousRank": previous_rank,
+        "rank": rank,
+        "previousValue": previous_value,
+        "value": value
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of LeaderboardEvent
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::LeaderboardEvent]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      time = (DateTime.parse(parsed_json["time"]) unless parsed_json["time"].nil?)
+      previous_rank = parsed_json["previousRank"]
+      rank = parsed_json["rank"]
+      previous_value = parsed_json["previousValue"]
+      value = parsed_json["value"]
+      new(
+        time: time,
+        previous_rank: previous_rank,
+        rank: rank,
+        previous_value: previous_value,
+        value: value,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of LeaderboardEvent to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.time.is_a?(DateTime) != false || raise("Passed value for field obj.time 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.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
+      obj.previous_value&.is_a?(Integer) != false || raise("Passed value for field obj.previous_value 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.")
+    end
+  end
+end

data/lib/trophy_api_client/types/leaderboard_ranking.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user's ranking in a leaderboard.
+  class LeaderboardRanking
+    # @return [String] The ID of the user.
+    attr_reader :user_id
+    # @return [String] The name of the user. May be null if no name is set.
+    attr_reader :user_name
+    # @return [Integer] The user's rank in the leaderboard.
+    attr_reader :rank
+    # @return [Integer] The user's value for this leaderboard (points, metric value, etc.).
+    attr_reader :value
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param user_id [String] The ID of the user.
+    # @param user_name [String] The name of the user. May be null if no name is set.
+    # @param rank [Integer] The user's rank in the leaderboard.
+    # @param value [Integer] The user's value for this leaderboard (points, metric value, etc.).
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::LeaderboardRanking]
+    def initialize(user_id:, rank:, value:, user_name: OMIT, additional_properties: nil)
+      @user_id = user_id
+      @user_name = user_name if user_name != OMIT
+      @rank = rank
+      @value = value
+      @additional_properties = additional_properties
+      @_field_set = { "userId": user_id, "userName": user_name, "rank": rank, "value": value }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of LeaderboardRanking
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::LeaderboardRanking]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      user_id = parsed_json["userId"]
+      user_name = parsed_json["userName"]
+      rank = parsed_json["rank"]
+      value = parsed_json["value"]
+      new(
+        user_id: user_id,
+        user_name: user_name,
+        rank: rank,
+        value: value,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of LeaderboardRanking to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.user_name&.is_a?(String) != false || raise("Passed value for field obj.user_name 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.")
+    end
+  end
+end

data/lib/trophy_api_client/types/leaderboard_response.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative "leaderboard_response_status"
+require_relative "leaderboard_response_rank_by"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A leaderboard with its configuration details.
+  class LeaderboardResponse
+    # @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 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'.
+    attr_reader :metric_name
+    # @return [String] The key of the points system to rank by, if rankBy is 'points'.
+    attr_reader :points_system_key
+    # @return [String] The name of the points system to rank by, if rankBy is 'points'.
+    attr_reader :points_system_name
+    # @return [String] The user-facing description of the leaderboard.
+    attr_reader :description
+    # @return [String] The start date of the leaderboard in YYYY-MM-DD format.
+    attr_reader :start
+    # @return [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
+    #  forever.
+    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
+    #  leaderboards.
+    attr_reader :run_unit
+    # @return [Integer] The interval between repetitions, relative to the start date and repetition
+    #  type.
+    attr_reader :run_interval
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @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 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'.
+    # @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
+    # @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 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
+    #  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)
+      @id = id
+      @name = name
+      @key = key
+      @status = status if status != OMIT
+      @rank_by = rank_by
+      @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
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "key": key,
+        "status": status,
+        "rankBy": rank_by,
+        "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
+
+    # Deserialize a JSON object to an instance of LeaderboardResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::LeaderboardResponse]
+    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"]
+      status = parsed_json["status"]
+      rank_by = parsed_json["rankBy"]
+      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,
+        status: status,
+        rank_by: rank_by,
+        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
+
+    # Serialize an instance of LeaderboardResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @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.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.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?(String) != 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
+end

data/lib/trophy_api_client/types/leaderboard_response_rank_by.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # What the leaderboard ranks by.
+  class LeaderboardResponseRankBy
+    POINTS = "points"
+    STREAK = "streak"
+    METRIC = "metric"
+  end
+end