Class: TrophyApiClient::Admin::Points::TriggersClient

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::TriggersClient

Parameters:



23
24
25
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 23

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ TrophyApiClient::RequestClient (readonly)

Returns:



19
20
21
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 19

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:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 85

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 117

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 182

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 45

def list(system_id:, 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)}/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

#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:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/trophy_api_client/admin/points/triggers/client.rb', line 150

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