Class: TrophyApiClient::AsyncAchievementsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ TrophyApiClient::AsyncAchievementsClient

Parameters:



98
99
100
 
# File 'lib/trophy_api_client/achievements/client.rb', line 98

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ TrophyApiClient::AsyncRequestClient (readonly)

Returns:



94
95
96
 
# File 'lib/trophy_api_client/achievements/client.rb', line 94

def request_client
  @request_client
end

Instance Method Details

#all(request_options: nil) ⇒ Array<TrophyApiClient::AchievementWithStatsResponse>

Get all achievements and their completion stats.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::DEFAULT,
  api_key: "YOUR_API_KEY"
)
api.achievements.all

Parameters:

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/trophy_api_client/achievements/client.rb', line 113

def all(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(request_options: request_options)}/achievements"
    end
    parsed_json = JSON.parse(response.body)
    parsed_json&.map do |item|
      item = item.to_json
      TrophyApiClient::AchievementWithStatsResponse.from_json(json_object: item)
    end
  end
end

#complete(key:, user:, request_options: nil) ⇒ TrophyApiClient::AchievementCompletionResponse

Mark an achievement as completed for a user.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::DEFAULT,
  api_key: "YOUR_API_KEY"
)
api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London" })

Parameters:

  • key (String) —

    Unique reference of the achievement as set when created.

  • user (Hash) —

    The user that completed the achievement.Request of type TrophyApiClient::UpdatedUser, as a Hash

    • :email (String)

    • :name (String)

    • :tz (String)

    • :subscribe_to_emails (Boolean)

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

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/trophy_api_client/achievements/client.rb', line 156

def complete(key:, user:, 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_options&.additional_body_parameters || {}), user: user }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/achievements/#{key}/complete"
    end
    TrophyApiClient::AchievementCompletionResponse.from_json(json_object: response.body)
  end
end