Class: TrophyApiClient::Admin::AsyncLeaderboardsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/admin/leaderboards/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ TrophyApiClient::Admin::AsyncLeaderboardsClient

Parameters:



197
198
199
 
# File 'lib/trophy_api_client/admin/leaderboards/client.rb', line 197

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ TrophyApiClient::AsyncRequestClient (readonly)

Returns:



193
194
195
 
# File 'lib/trophy_api_client/admin/leaderboards/client.rb', line 193

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ TrophyApiClient::CreateLeaderboardsResponse

Create leaderboards. Maximum 100 leaderboards per request.

Examples:

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" }])

Parameters:

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/trophy_api_client/admin/leaderboards/client.rb', line 255

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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.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(ids: nil, request_options: nil) ⇒ TrophyApiClient::DeleteLeaderboardsResponse

Delete leaderboards by ID.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.admin.leaderboards.delete

Parameters:

  • ids (String) (defaults to: nil) —

    Leaderboard IDs to delete. Repeat the query param or provide a comma-separated list.

  • request_options (TrophyApiClient::RequestOptions) (defaults to: nil)

Returns:



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/trophy_api_client/admin/leaderboards/client.rb', line 289

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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.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

#get(id:, request_options: nil) ⇒ TrophyApiClient::AdminLeaderboard

Get a leaderboard by ID.

Examples:

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")

Parameters:

Returns:



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/trophy_api_client/admin/leaderboards/client.rb', line 356

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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.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

#list(limit: nil, skip: nil, request_options: nil) ⇒ TrophyApiClient::LIST_LEADERBOARDS_RESPONSE

List leaderboards.

Examples:

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)

Parameters:

  • limit (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip from the start of the list.

  • request_options (TrophyApiClient::RequestOptions) (defaults to: nil)

Returns:



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/trophy_api_client/admin/leaderboards/client.rb', line 214

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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.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

#update(request:, request_options: nil) ⇒ TrophyApiClient::UpdateLeaderboardsResponse

Update leaderboards by ID. Updating ‘status` behaves the same as activating,

scheduling, deactivating, or finishing a leaderboard in the dashboard.

Examples:

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 }])

Parameters:

Returns:



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/trophy_api_client/admin/leaderboards/client.rb', line 323

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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.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