trophy_api_client 1.0.9 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd1f21fb885126c744e5215156a445e512086ac384c30b39adef593bade903bd
-  data.tar.gz: 6ced4aae93a37ff04460dda3d18dc6af3391db60bb0e2fd694e36d6704bc86e9
+  metadata.gz: bc623851107ae5d8fee5d6ab4676fa4bdbeb45b832a54666422db99ffc88667e
+  data.tar.gz: 53ca591d79257162bed574589d45bff4441c9073a093d2484b8c9c18a8bcc4ce
 SHA512:
-  metadata.gz: edc8d8554b3ab6f401b01d822c3f894bf98c9b8a0423c8dcb56c664ee26b0a37ddc9f05d6924883fafca2433faeecc4bc5f3b23208e7a832d8dbcdf3633fe8a3
-  data.tar.gz: edd1fad45de3bcd29696f1e74eecd13e4c9ee7585c176ab4b0cb60f156927061e2a01bb77a4953d4eb6c43a5fcdac397cd85ed1d3b0b4bbf8ff23ae56543f6c7
+  metadata.gz: 96f1ba1f2ea0df15e83671b68c55f686e0343e00c072c6b966e4def6092ae45d69d7de95e1e67242e464be372e6bae8b7b37c814e48366b6ae96ca280296ccb9
+  data.tar.gz: 1b4f6735adaf1f1c9d3611da33531fb24a5decde550bb83672f820ff25496d28e27d13b79e1a327995575dd5f4ccf9127adce55d2433bb46ea7f5537c7638c3c

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/achievements/client.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "../types/upserted_user"
+require_relative "../types/achievement_with_stats_response"
+require "json"
+require_relative "../types/updated_user"
 require_relative "../types/achievement_completion_response"
 require "async"
 
@@ -16,11 +18,45 @@ module TrophyApiClient
       @request_client = request_client
     end
 
+    # Get all achievements and their completion stats.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.achievements.all
+    def all(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(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
+
     # Mark an achievement as completed for a user.
     #
     # @param key [String] Unique reference of the achievement as set when created.
-    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpsertedUser, as a Hash
-    #   * :id (String)
+    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpdatedUser, as a Hash
     #   * :email (String)
     #   * :name (String)
     #   * :tz (String)
@@ -33,7 +69,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London" })
     def complete(key:, user:, 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?
@@ -63,11 +99,47 @@ module TrophyApiClient
       @request_client = request_client
     end
 
+    # Get all achievements and their completion stats.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.achievements.all
+    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
+
     # Mark an achievement as completed for a user.
     #
     # @param key [String] Unique reference of the achievement as set when created.
-    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpsertedUser, as a Hash
-    #   * :id (String)
+    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpdatedUser, as a Hash
     #   * :email (String)
     #   * :name (String)
     #   * :tz (String)
@@ -80,7 +152,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London" })
     def complete(key:, user:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|

data/lib/trophy_api_client/points/client.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/points_summary_response"
+require "json"
+require_relative "../types/points_trigger_response"
+require "async"
+
+module TrophyApiClient
+  class PointsClient
+    # @return [TrophyApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::RequestClient]
+    # @return [TrophyApiClient::PointsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get a breakdown of the number of users with points in each range.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::POINTS_SUMMARY_RESPONSE]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.summary
+    def summary(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(request_options: request_options)}/points/summary"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsRange.from_json(json_object: item)
+      end
+    end
+
+    # Get all points triggers.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::PointsTriggerResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.triggers
+    def triggers(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(request_options: request_options)}/points/triggers"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsTriggerResponse.from_json(json_object: item)
+      end
+    end
+  end
+
+  class AsyncPointsClient
+    # @return [TrophyApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::AsyncRequestClient]
+    # @return [TrophyApiClient::AsyncPointsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get a breakdown of the number of users with points in each range.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::POINTS_SUMMARY_RESPONSE]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.summary
+    def summary(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)}/points/summary"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::PointsRange.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get all points triggers.
+    #
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::PointsTriggerResponse>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.triggers
+    def triggers(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)}/points/triggers"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::PointsTriggerResponse.from_json(json_object: item)
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/types/achievement_completion_response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "achievement_response"
+require_relative "completed_achievement_response"
 require "ostruct"
 require "json"
 
@@ -8,7 +8,7 @@ module TrophyApiClient
   class AchievementCompletionResponse
     # @return [String] The unique ID of the completion.
     attr_reader :completion_id
-    # @return [TrophyApiClient::AchievementResponse]
+    # @return [TrophyApiClient::CompletedAchievementResponse]
     attr_reader :achievement
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -19,7 +19,7 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param completion_id [String] The unique ID of the completion.
-    # @param achievement [TrophyApiClient::AchievementResponse]
+    # @param achievement [TrophyApiClient::CompletedAchievementResponse]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementCompletionResponse]
     def initialize(completion_id:, achievement:, additional_properties: nil)
@@ -41,7 +41,7 @@ module TrophyApiClient
         achievement = nil
       else
         achievement = parsed_json["achievement"].to_json
-        achievement = TrophyApiClient::AchievementResponse.from_json(json_object: achievement)
+        achievement = TrophyApiClient::CompletedAchievementResponse.from_json(json_object: achievement)
       end
       new(
         completion_id: completion_id,
@@ -65,7 +65,7 @@ module TrophyApiClient
     # @return [Void]
     def self.validate_raw(obj:)
       obj.completion_id.is_a?(String) != false || raise("Passed value for field obj.completion_id is not the expected type, validation failed.")
-      TrophyApiClient::AchievementResponse.validate_raw(obj: obj.achievement)
+      TrophyApiClient::CompletedAchievementResponse.validate_raw(obj: obj.achievement)
     end
   end
 end

data/lib/trophy_api_client/types/achievement_response.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "date"
+require_relative "achievement_response_trigger"
+require_relative "metric_event_streak_response"
 require "ostruct"
 require "json"
 
@@ -10,12 +11,12 @@ module TrophyApiClient
     attr_reader :id
     # @return [String] The name of this achievement.
     attr_reader :name
-    # @return [String] The trigger of the achievement, either 'metric', 'streak', or 'api'.
+    # @return [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
     attr_reader :trigger
+    # @return [String] The description of this achievement.
+    attr_reader :description
     # @return [String] The URL of the badge image for the achievement, if one has been uploaded.
     attr_reader :badge_url
-    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
-    attr_reader :achieved_at
     # @return [String] The key used to reference this achievement in the API (only applicable if
     #  trigger = 'api')
     attr_reader :key
@@ -31,6 +32,8 @@ module TrophyApiClient
     # @return [String] The name of the metric associated with this achievement (only applicable if
     #  trigger = 'metric')
     attr_reader :metric_name
+    # @return [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    attr_reader :current_streak
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -41,9 +44,9 @@ module TrophyApiClient
 
     # @param id [String] The unique ID of the achievement.
     # @param name [String] The name of this achievement.
-    # @param trigger [String] The trigger of the achievement, either 'metric', 'streak', or 'api'.
+    # @param trigger [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
+    # @param description [String] The description of this achievement.
     # @param badge_url [String] The URL of the badge image for the achievement, if one has been uploaded.
-    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
     # @param key [String] The key used to reference this achievement in the API (only applicable if
     #  trigger = 'api')
     # @param streak_length [Integer] The length of the streak required to complete the achievement (only applicable
@@ -54,32 +57,35 @@ module TrophyApiClient
     #  trigger = 'metric')
     # @param metric_name [String] The name of the metric associated with this achievement (only applicable if
     #  trigger = 'metric')
+    # @param current_streak [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementResponse]
-    def initialize(id:, name:, trigger:, badge_url: OMIT, achieved_at: OMIT, key: OMIT, streak_length: OMIT,
-                   metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
+    def initialize(id:, name:, trigger:, description: OMIT, badge_url: OMIT, key: OMIT, streak_length: OMIT,
+                   metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, current_streak: OMIT, additional_properties: nil)
       @id = id
       @name = name
       @trigger = trigger
+      @description = description if description != OMIT
       @badge_url = badge_url if badge_url != OMIT
-      @achieved_at = achieved_at if achieved_at != OMIT
       @key = key if key != OMIT
       @streak_length = streak_length if streak_length != OMIT
       @metric_id = metric_id if metric_id != OMIT
       @metric_value = metric_value if metric_value != OMIT
       @metric_name = metric_name if metric_name != OMIT
+      @current_streak = current_streak if current_streak != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
         "name": name,
         "trigger": trigger,
+        "description": description,
         "badgeUrl": badge_url,
-        "achievedAt": achieved_at,
         "key": key,
         "streakLength": streak_length,
         "metricId": metric_id,
         "metricValue": metric_value,
-        "metricName": metric_name
+        "metricName": metric_name,
+        "currentStreak": current_streak
       }.reject do |_k, v|
         v == OMIT
       end
@@ -95,24 +101,31 @@ module TrophyApiClient
       id = parsed_json["id"]
       name = parsed_json["name"]
       trigger = parsed_json["trigger"]
+      description = parsed_json["description"]
       badge_url = parsed_json["badgeUrl"]
-      achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
       key = parsed_json["key"]
       streak_length = parsed_json["streakLength"]
       metric_id = parsed_json["metricId"]
       metric_value = parsed_json["metricValue"]
       metric_name = parsed_json["metricName"]
+      if parsed_json["currentStreak"].nil?
+        current_streak = nil
+      else
+        current_streak = parsed_json["currentStreak"].to_json
+        current_streak = TrophyApiClient::MetricEventStreakResponse.from_json(json_object: current_streak)
+      end
       new(
         id: id,
         name: name,
         trigger: trigger,
+        description: description,
         badge_url: badge_url,
-        achieved_at: achieved_at,
         key: key,
         streak_length: streak_length,
         metric_id: metric_id,
         metric_value: metric_value,
         metric_name: metric_name,
+        current_streak: current_streak,
         additional_properties: struct
       )
     end
@@ -133,14 +146,15 @@ module TrophyApiClient
     def self.validate_raw(obj:)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.trigger.is_a?(String) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")
+      obj.trigger.is_a?(TrophyApiClient::AchievementResponseTrigger) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
       obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url is not the expected type, validation failed.")
-      obj.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
       obj.key&.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
       obj.streak_length&.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
       obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
       obj.metric_value&.is_a?(Float) != false || raise("Passed value for field obj.metric_value is not the expected type, validation failed.")
       obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
+      obj.current_streak.nil? || TrophyApiClient::MetricEventStreakResponse.validate_raw(obj: obj.current_streak)
     end
   end
 end

data/lib/trophy_api_client/types/achievement_response_trigger.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The trigger of the achievement.
+  class AchievementResponseTrigger
+    METRIC = "metric"
+    STREAK = "streak"
+    API = "api"
+  end
+end