trophy_api_client 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c1c32e3a98727d1752b80b4d07849c4a41714660879d8c453d6d72885ebf8b9
-  data.tar.gz: f05cc73b2ba4bfd387dcde4fc95e3782da25aec7ba34cac8d6dd543a6b9c1e03
+  metadata.gz: d240a20a2e41b128afca2d98893f8c2442aeced7d0c565c9458efdb8f6ff0efa
+  data.tar.gz: 0e6698405fbc5e02e29b59cc97322237a7291c03a472430ddb45d25b6689c403
 SHA512:
-  metadata.gz: d900ec0aa57b4dd88305bd101dc4454f76f39b21be653f2ced8d38dbe8960116b8b856f100712b026b9fdc8aaa4fe6de1d6ae78b969ae10c4ee06daaf048ef05
-  data.tar.gz: 2dbfcfc043fc01d82950b5858b22ee2ce2786aedc595a5d793a1487f69383fb9b89b4834df18927cb75b451ee5658e05270a1edde93752eccdd8de5501de85cf
+  metadata.gz: 160583d898a66ec511045b0a89441016a527ff0d45e586e6b26f23d17a046765589333c22d21811ba98bb32a6e45fa7ac36fbae07f9724b29a6b36ea29be7e74
+  data.tar.gz: 7cfd1a899f7182d554377516f23a2641ab30ed5a35c891da819f9b02ee8f05ba207f84ff66d36b02ceda728e0e099110082072257c0b99b0688f78a0201898d7

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/admin/attributes/client.rb

@@ -58,7 +58,7 @@ module TrophyApiClient
         end
       end
 
-      # Create attributes in bulk.
+      # Create attributes.
       #
       # @param request [TrophyApiClient::CREATE_ATTRIBUTES_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -88,7 +88,7 @@ module TrophyApiClient
         TrophyApiClient::CreateAttributesResponse.from_json(json_object: response.body)
       end
 
-      # Delete attributes in bulk by ID.
+      # Delete attributes by ID.
       #
       # @param ids [String] Attribute IDs to delete. Repeat the query param or provide a comma-separated
       #  list.
@@ -119,7 +119,7 @@ module TrophyApiClient
         TrophyApiClient::DeleteAttributesResponse.from_json(json_object: response.body)
       end
 
-      # Update attributes in bulk by ID.
+      # Update attributes by ID.
       #
       # @param request [TrophyApiClient::UPDATE_ATTRIBUTES_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -233,7 +233,7 @@ module TrophyApiClient
         end
       end
 
-      # Create attributes in bulk.
+      # Create attributes.
       #
       # @param request [TrophyApiClient::CREATE_ATTRIBUTES_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -265,7 +265,7 @@ module TrophyApiClient
         end
       end
 
-      # Delete attributes in bulk by ID.
+      # Delete attributes by ID.
       #
       # @param ids [String] Attribute IDs to delete. Repeat the query param or provide a comma-separated
       #  list.
@@ -298,7 +298,7 @@ module TrophyApiClient
         end
       end
 
-      # Update attributes in bulk by ID.
+      # Update attributes by ID.
       #
       # @param request [TrophyApiClient::UPDATE_ATTRIBUTES_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]

data/lib/trophy_api_client/admin/client.rb

@@ -1,49 +1,56 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "streaks/client"
 require_relative "attributes/client"
 require_relative "metrics/client"
+require_relative "leaderboards/client"
+require_relative "streaks/client"
 require_relative "points/client"
 
 module TrophyApiClient
   module Admin
     class Client
-      # @return [TrophyApiClient::Admin::StreaksClient]
-      attr_reader :streaks
       # @return [TrophyApiClient::Admin::AttributesClient]
       attr_reader :attributes
       # @return [TrophyApiClient::Admin::MetricsClient]
       attr_reader :metrics
+      # @return [TrophyApiClient::Admin::LeaderboardsClient]
+      attr_reader :leaderboards
+      # @return [TrophyApiClient::Admin::StreaksClient]
+      attr_reader :streaks
       # @return [TrophyApiClient::Admin::Points::Client]
       attr_reader :admin
 
       # @param request_client [TrophyApiClient::RequestClient]
       # @return [TrophyApiClient::Admin::Client]
       def initialize(request_client:)
-        @streaks = TrophyApiClient::Admin::StreaksClient.new(request_client: request_client)
         @attributes = TrophyApiClient::Admin::AttributesClient.new(request_client: request_client)
         @metrics = TrophyApiClient::Admin::MetricsClient.new(request_client: request_client)
+        @leaderboards = TrophyApiClient::Admin::LeaderboardsClient.new(request_client: request_client)
+        @streaks = TrophyApiClient::Admin::StreaksClient.new(request_client: request_client)
         @admin = TrophyApiClient::Admin::Points::Client.new(request_client: request_client)
       end
     end
 
     class AsyncClient
-      # @return [TrophyApiClient::Admin::AsyncStreaksClient]
-      attr_reader :streaks
       # @return [TrophyApiClient::Admin::AsyncAttributesClient]
       attr_reader :attributes
       # @return [TrophyApiClient::Admin::AsyncMetricsClient]
       attr_reader :metrics
+      # @return [TrophyApiClient::Admin::AsyncLeaderboardsClient]
+      attr_reader :leaderboards
+      # @return [TrophyApiClient::Admin::AsyncStreaksClient]
+      attr_reader :streaks
       # @return [TrophyApiClient::Admin::Points::AsyncClient]
       attr_reader :admin
 
       # @param request_client [TrophyApiClient::AsyncRequestClient]
       # @return [TrophyApiClient::Admin::AsyncClient]
       def initialize(request_client:)
-        @streaks = TrophyApiClient::Admin::AsyncStreaksClient.new(request_client: request_client)
         @attributes = TrophyApiClient::Admin::AsyncAttributesClient.new(request_client: request_client)
         @metrics = TrophyApiClient::Admin::AsyncMetricsClient.new(request_client: request_client)
+        @leaderboards = TrophyApiClient::Admin::AsyncLeaderboardsClient.new(request_client: request_client)
+        @streaks = TrophyApiClient::Admin::AsyncStreaksClient.new(request_client: request_client)
         @admin = TrophyApiClient::Admin::Points::AsyncClient.new(request_client: request_client)
       end
     end

data/lib/trophy_api_client/admin/leaderboards/client.rb

@@ -0,0 +1,371 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/list_leaderboards_response"
+require "json"
+require_relative "../../types/create_leaderboards_request"
+require_relative "../../types/create_leaderboards_response"
+require_relative "../../types/delete_leaderboards_response"
+require_relative "../../types/update_leaderboards_request"
+require_relative "../../types/update_leaderboards_response"
+require_relative "../../types/admin_leaderboard"
+require "async"
+
+module TrophyApiClient
+  module Admin
+    class LeaderboardsClient
+      # @return [TrophyApiClient::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [TrophyApiClient::RequestClient]
+      # @return [TrophyApiClient::Admin::LeaderboardsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # List leaderboards.
+      #
+      # @param limit [Integer] Number of records to return.
+      # @param skip [Integer] Number of records to skip from the start of the list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::LIST_LEADERBOARDS_RESPONSE]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.list(limit: 1, skip: 1)
+      def list(limit: nil, skip: 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 || {}), "limit": limit, "skip": skip }.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(environment: admin, request_options: request_options)}/leaderboards"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::AdminLeaderboard.from_json(json_object: item)
+        end
+      end
+
+      # Create leaderboards. Maximum 100 leaderboards per request.
+      #
+      # @param request [TrophyApiClient::CREATE_LEADERBOARDS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreateLeaderboardsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.create(request: [{ name: "Revenue Champions", key: "revenue-champions", status: INACTIVE, rank_by: METRIC, metric_id: "550e8400-e29b-41d4-a716-446655440000", max_participants: 100, start: "2026-04-20", breakdown_attributes: ["550e8400-e29b-41d4-a716-446655440010"], run_unit: MONTH, run_interval: 1 }, { name: "Streak Legends", key: "streak-legends", status: SCHEDULED, rank_by: STREAK, start: "2026-04-27" }])
+      def create(request:, request_options: nil)
+        response = @request_client.conn.post 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
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/leaderboards"
+        end
+        TrophyApiClient::CreateLeaderboardsResponse.from_json(json_object: response.body)
+      end
+
+      # Delete leaderboards by ID.
+      #
+      # @param ids [String] Leaderboard IDs to delete. Repeat the query param or provide a comma-separated
+      #  list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::DeleteLeaderboardsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.delete
+      def delete(ids: nil, request_options: nil)
+        response = @request_client.conn.delete 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 || {}), "ids": ids }.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(environment: admin, request_options: request_options)}/leaderboards"
+        end
+        TrophyApiClient::DeleteLeaderboardsResponse.from_json(json_object: response.body)
+      end
+
+      # Update leaderboards by ID. Updating `status` behaves the same as activating,
+      #  scheduling, deactivating, or finishing a leaderboard in the dashboard.
+      #
+      # @param request [TrophyApiClient::UPDATE_LEADERBOARDS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::UpdateLeaderboardsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.update(request: [{ id: "550e8400-e29b-41d4-a716-446655440100", name: "Monthly Revenue Champions", description: "Ranked by monthly revenue", status: ACTIVE }, { id: "550e8400-e29b-41d4-a716-446655440101", status: FINISHED }])
+      def update(request:, request_options: nil)
+        response = @request_client.conn.patch 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
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/leaderboards"
+        end
+        TrophyApiClient::UpdateLeaderboardsResponse.from_json(json_object: response.body)
+      end
+
+      # Get a leaderboard by ID.
+      #
+      # @param id [String] The UUID of the leaderboard to retrieve.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::AdminLeaderboard]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.get(id: "550e8400-e29b-41d4-a716-446655440100")
+      def get(id:, 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(environment: admin, request_options: request_options)}/leaderboards/#{id}"
+        end
+        TrophyApiClient::AdminLeaderboard.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncLeaderboardsClient
+      # @return [TrophyApiClient::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [TrophyApiClient::AsyncRequestClient]
+      # @return [TrophyApiClient::Admin::AsyncLeaderboardsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # List leaderboards.
+      #
+      # @param limit [Integer] Number of records to return.
+      # @param skip [Integer] Number of records to skip from the start of the list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::LIST_LEADERBOARDS_RESPONSE]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.list(limit: 1, skip: 1)
+      def list(limit: nil, skip: 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 || {}),
+              "limit": limit,
+              "skip": skip
+            }.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(environment: admin, request_options: request_options)}/leaderboards"
+          end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do |item|
+            item = item.to_json
+            TrophyApiClient::AdminLeaderboard.from_json(json_object: item)
+          end
+        end
+      end
+
+      # Create leaderboards. Maximum 100 leaderboards per request.
+      #
+      # @param request [TrophyApiClient::CREATE_LEADERBOARDS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreateLeaderboardsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.create(request: [{ name: "Revenue Champions", key: "revenue-champions", status: INACTIVE, rank_by: METRIC, metric_id: "550e8400-e29b-41d4-a716-446655440000", max_participants: 100, start: "2026-04-20", breakdown_attributes: ["550e8400-e29b-41d4-a716-446655440010"], run_unit: MONTH, run_interval: 1 }, { name: "Streak Legends", key: "streak-legends", status: SCHEDULED, rank_by: STREAK, start: "2026-04-27" }])
+      def create(request:, request_options: nil)
+        Async do
+          response = @request_client.conn.post 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
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/leaderboards"
+          end
+          TrophyApiClient::CreateLeaderboardsResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Delete leaderboards by ID.
+      #
+      # @param ids [String] Leaderboard IDs to delete. Repeat the query param or provide a comma-separated
+      #  list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::DeleteLeaderboardsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.delete
+      def delete(ids: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.delete 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 || {}), "ids": ids }.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(environment: admin, request_options: request_options)}/leaderboards"
+          end
+          TrophyApiClient::DeleteLeaderboardsResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Update leaderboards by ID. Updating `status` behaves the same as activating,
+      #  scheduling, deactivating, or finishing a leaderboard in the dashboard.
+      #
+      # @param request [TrophyApiClient::UPDATE_LEADERBOARDS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::UpdateLeaderboardsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.update(request: [{ id: "550e8400-e29b-41d4-a716-446655440100", name: "Monthly Revenue Champions", description: "Ranked by monthly revenue", status: ACTIVE }, { id: "550e8400-e29b-41d4-a716-446655440101", status: FINISHED }])
+      def update(request:, request_options: nil)
+        Async do
+          response = @request_client.conn.patch 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
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/leaderboards"
+          end
+          TrophyApiClient::UpdateLeaderboardsResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Get a leaderboard by ID.
+      #
+      # @param id [String] The UUID of the leaderboard to retrieve.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::AdminLeaderboard]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.leaderboards.get(id: "550e8400-e29b-41d4-a716-446655440100")
+      def get(id:, 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(environment: admin,
+                                               request_options: request_options)}/leaderboards/#{id}"
+          end
+          TrophyApiClient::AdminLeaderboard.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/admin/metrics/client.rb

@@ -58,7 +58,7 @@ module TrophyApiClient
         end
       end
 
-      # Create metrics in bulk.
+      # Create metrics.
       #
       # @param request [TrophyApiClient::CREATE_METRICS_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -88,7 +88,7 @@ module TrophyApiClient
         TrophyApiClient::CreateMetricsResponse.from_json(json_object: response.body)
       end
 
-      # Delete metrics in bulk by ID.
+      # Delete metrics by ID.
       #
       # @param ids [String] Metric IDs to delete. Repeat the query param or provide a comma-separated list.
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -118,7 +118,7 @@ module TrophyApiClient
         TrophyApiClient::DeleteMetricsResponse.from_json(json_object: response.body)
       end
 
-      # Update metrics in bulk by ID.
+      # Update metrics by ID.
       #
       # @param request [TrophyApiClient::UPDATE_METRICS_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -232,7 +232,7 @@ module TrophyApiClient
         end
       end
 
-      # Create metrics in bulk.
+      # Create metrics.
       #
       # @param request [TrophyApiClient::CREATE_METRICS_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -264,7 +264,7 @@ module TrophyApiClient
         end
       end
 
-      # Delete metrics in bulk by ID.
+      # Delete metrics by ID.
       #
       # @param ids [String] Metric IDs to delete. Repeat the query param or provide a comma-separated list.
       # @param request_options [TrophyApiClient::RequestOptions]
@@ -296,7 +296,7 @@ module TrophyApiClient
         end
       end
 
-      # Update metrics in bulk by ID.
+      # Update metrics by ID.
       #
       # @param request [TrophyApiClient::UPDATE_METRICS_REQUEST]
       # @param request_options [TrophyApiClient::RequestOptions]