Class: TrophyApiClient::Admin::Points::AsyncTriggersClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ TrophyApiClient::Admin::Points::AsyncTriggersClient

Parameters:



215
216
217
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 215

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ TrophyApiClient::AsyncRequestClient (readonly)

Returns:



211
212
213
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 211

def request_client
  @request_client
end

Instance Method Details

#create(system_id:, request:, request_options: nil) ⇒ TrophyApiClient::CreatePointsTriggersResponse

Create points triggers in bulk. Maximum 100 triggers per request.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.admin.points.triggers.create(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ type: METRIC, points: 10 }])

Parameters:

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 280

def create(system_id:, 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)}/points/#{system_id}/triggers"
    end
    TrophyApiClient::CreatePointsTriggersResponse.from_json(json_object: response.body)
  end
end

#delete(system_id:, ids: nil, request_options: nil) ⇒ TrophyApiClient::DeletePointsTriggersResponse

Delete (archive) points triggers by ID. Maximum 100 trigger IDs per request.

Examples:

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

Parameters:

  • system_id (String) —

    The UUID of the points system.

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

    Trigger IDs to delete. Can be repeated or comma-separated.

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

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 315

def delete(system_id:, 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)}/points/#{system_id}/triggers"
    end
    TrophyApiClient::DeletePointsTriggersResponse.from_json(json_object: response.body)
  end
end

#get(system_id:, id:, request_options: nil) ⇒ TrophyApiClient::AdminPointsTrigger

Get a single points trigger by ID.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.admin.points.triggers.get(system_id: "550e8400-e29b-41d4-a716-446655440000", id: "660f9500-f30c-42e5-b827-557766550001")

Parameters:

  • system_id (String) —

    The UUID of the points system.

  • id (String) —

    The UUID of the points trigger.

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

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 386

def get(system_id:, 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)}/points/#{system_id}/triggers/#{id}"
    end
    TrophyApiClient::AdminPointsTrigger.from_json(json_object: response.body)
  end
end

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

List points triggers for a system.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.admin.points.triggers.list(
  system_id: "550e8400-e29b-41d4-a716-446655440000",
  limit: 1,
  skip: 1
)

Parameters:

  • system_id (String) —

    The UUID of the points system.

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

    Maximum number of results to return (1-100, default 10).

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

    Number of results to skip for pagination (default 0).

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

Returns:



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 237

def list(system_id:, 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)}/points/#{system_id}/triggers"
    end
    parsed_json = JSON.parse(response.body)
    parsed_json&.map do |item|
      item = item.to_json
      TrophyApiClient::AdminPointsTrigger.from_json(json_object: item)
    end
  end
end

#update(system_id:, request:, request_options: nil) ⇒ TrophyApiClient::PatchPointsTriggersResponse

Update points triggers in bulk. Maximum 100 triggers per request. Only provided

fields are updated; omitted fields are preserved.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.admin.points.triggers.update(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ id: "id" }])

Parameters:

Returns:



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 351

def update(system_id:, 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)}/points/#{system_id}/triggers"
    end
    TrophyApiClient::PatchPointsTriggersResponse.from_json(json_object: response.body)
  end
end