trophy_api_client 1.0.23 → 1.0.25

data/lib/trophy_api_client/users/client.rb

@@ -13,6 +13,7 @@ require_relative "../types/streak_response"
 require_relative "../types/get_user_points_response"
 require_relative "types/users_points_event_summary_request_aggregation"
 require_relative "types/users_points_event_summary_response_item"
+require_relative "../types/user_leaderboard_response"
 require "async"
 
 module TrophyApiClient
@@ -447,6 +448,43 @@ module TrophyApiClient
         TrophyApiClient::Users::UsersPointsEventSummaryResponseItem.from_json(json_object: item)
       end
     end
+
+    # Get a user's rank, value, and history for a specific leaderboard.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param key [String] Unique key of the leaderboard as set when created.
+    # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
+    #  run.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::UserLeaderboardResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.leaderboards(
+    #    id: "user-123",
+    #    key: "weekly-words",
+    #    run: "2025-01-15"
+    #  )
+    def leaderboards(id:, key:, run: 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 || {}), "run": run }.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)}/users/#{id}/leaderboards/#{key}"
+      end
+      TrophyApiClient::UserLeaderboardResponse.from_json(json_object: response.body)
+    end
   end
 
   class AsyncUsersClient
@@ -902,5 +940,44 @@ module TrophyApiClient
         end
       end
     end
+
+    # Get a user's rank, value, and history for a specific leaderboard.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param key [String] Unique key of the leaderboard as set when created.
+    # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
+    #  run.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::UserLeaderboardResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.leaderboards(
+    #    id: "user-123",
+    #    key: "weekly-words",
+    #    run: "2025-01-15"
+    #  )
+    def leaderboards(id:, key:, run: 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 || {}), "run": run }.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)}/users/#{id}/leaderboards/#{key}"
+        end
+        TrophyApiClient::UserLeaderboardResponse.from_json(json_object: response.body)
+      end
+    end
   end
 end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.23"
+  VERSION = "1.0.25"
 end

data/lib/trophy_api_client.rb

@@ -8,6 +8,7 @@ require_relative "trophy_api_client/metrics/client"
 require_relative "trophy_api_client/users/client"
 require_relative "trophy_api_client/streaks/client"
 require_relative "trophy_api_client/points/client"
+require_relative "trophy_api_client/leaderboards/client"
 
 module TrophyApiClient
   class Client
@@ -21,6 +22,8 @@ module TrophyApiClient
     attr_reader :streaks
     # @return [TrophyApiClient::PointsClient]
     attr_reader :points
+    # @return [TrophyApiClient::LeaderboardsClient]
+    attr_reader :leaderboards
 
     # @param base_url [String]
     # @param environment [TrophyApiClient::Environment]
@@ -42,6 +45,7 @@ module TrophyApiClient
       @users = TrophyApiClient::UsersClient.new(request_client: @request_client)
       @streaks = TrophyApiClient::StreaksClient.new(request_client: @request_client)
       @points = TrophyApiClient::PointsClient.new(request_client: @request_client)
+      @leaderboards = TrophyApiClient::LeaderboardsClient.new(request_client: @request_client)
     end
   end
 
@@ -56,6 +60,8 @@ module TrophyApiClient
     attr_reader :streaks
     # @return [TrophyApiClient::AsyncPointsClient]
     attr_reader :points
+    # @return [TrophyApiClient::AsyncLeaderboardsClient]
+    attr_reader :leaderboards
 
     # @param base_url [String]
     # @param environment [TrophyApiClient::Environment]
@@ -77,6 +83,7 @@ module TrophyApiClient
       @users = TrophyApiClient::AsyncUsersClient.new(request_client: @async_request_client)
       @streaks = TrophyApiClient::AsyncStreaksClient.new(request_client: @async_request_client)
       @points = TrophyApiClient::AsyncPointsClient.new(request_client: @async_request_client)
+      @leaderboards = TrophyApiClient::AsyncLeaderboardsClient.new(request_client: @async_request_client)
     end
   end
 end

data/lib/types_export.rb

@@ -17,7 +17,12 @@ require_relative "trophy_api_client/types/points_trigger_type"
 require_relative "trophy_api_client/types/points_trigger"
 require_relative "trophy_api_client/types/points_award"
 require_relative "trophy_api_client/types/get_user_points_response"
+require_relative "trophy_api_client/types/leaderboard_response_status"
+require_relative "trophy_api_client/types/leaderboard_response_rank_by"
+require_relative "trophy_api_client/types/leaderboard_response"
+require_relative "trophy_api_client/types/leaderboard_response_with_rankings"
 require_relative "trophy_api_client/types/metric_event_points_response"
+require_relative "trophy_api_client/types/metric_event_leaderboard_response"
 require_relative "trophy_api_client/types/achievement_response_trigger"
 require_relative "trophy_api_client/types/achievement_response"
 require_relative "trophy_api_client/types/completed_achievement_response"
@@ -40,3 +45,6 @@ require_relative "trophy_api_client/types/points_trigger_response_event_attribut
 require_relative "trophy_api_client/types/points_trigger_response"
 require_relative "trophy_api_client/types/points_system_response"
 require_relative "trophy_api_client/types/streak_ranking_user"
+require_relative "trophy_api_client/types/leaderboard_ranking"
+require_relative "trophy_api_client/types/leaderboard_event"
+require_relative "trophy_api_client/types/user_leaderboard_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.23
+  version: 1.0.25
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -100,6 +100,7 @@ files:
 - lib/requests.rb
 - lib/trophy_api_client.rb
 - lib/trophy_api_client/achievements/client.rb
+- lib/trophy_api_client/leaderboards/client.rb
 - lib/trophy_api_client/metrics/client.rb
 - lib/trophy_api_client/points/client.rb
 - lib/trophy_api_client/streaks/client.rb
@@ -117,6 +118,13 @@ files:
 - lib/trophy_api_client/types/error_body.rb
 - lib/trophy_api_client/types/event_response.rb
 - lib/trophy_api_client/types/get_user_points_response.rb
+- lib/trophy_api_client/types/leaderboard_event.rb
+- lib/trophy_api_client/types/leaderboard_ranking.rb
+- lib/trophy_api_client/types/leaderboard_response.rb
+- lib/trophy_api_client/types/leaderboard_response_rank_by.rb
+- lib/trophy_api_client/types/leaderboard_response_status.rb
+- lib/trophy_api_client/types/leaderboard_response_with_rankings.rb
+- lib/trophy_api_client/types/metric_event_leaderboard_response.rb
 - lib/trophy_api_client/types/metric_event_points_response.rb
 - lib/trophy_api_client/types/metric_event_streak_response.rb
 - lib/trophy_api_client/types/metric_response.rb
@@ -139,6 +147,7 @@ files:
 - lib/trophy_api_client/types/updated_user.rb
 - lib/trophy_api_client/types/upserted_user.rb
 - lib/trophy_api_client/types/user.rb
+- lib/trophy_api_client/types/user_leaderboard_response.rb
 - lib/trophy_api_client/users/client.rb
 - lib/trophy_api_client/users/types/users_metric_event_summary_request_aggregation.rb
 - lib/trophy_api_client/users/types/users_metric_event_summary_response_item.rb