trophy_api_client 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd1f21fb885126c744e5215156a445e512086ac384c30b39adef593bade903bd
-  data.tar.gz: 6ced4aae93a37ff04460dda3d18dc6af3391db60bb0e2fd694e36d6704bc86e9
+  metadata.gz: df830b1cd9f510c3ceea2cecb04f72e8ba30bbd051bc2ea461afb732ef8fc9fa
+  data.tar.gz: ac3d49eddd8de38fb751382004c2cb61f531680d71c84b57ecc76c159037a055
 SHA512:
-  metadata.gz: edc8d8554b3ab6f401b01d822c3f894bf98c9b8a0423c8dcb56c664ee26b0a37ddc9f05d6924883fafca2433faeecc4bc5f3b23208e7a832d8dbcdf3633fe8a3
-  data.tar.gz: edd1fad45de3bcd29696f1e74eecd13e4c9ee7585c176ab4b0cb60f156927061e2a01bb77a4953d4eb6c43a5fcdac397cd85ed1d3b0b4bbf8ff23ae56543f6c7
+  metadata.gz: e37e143621c9865d90ec6d0795bcf9326f917f11d158cb935ab987c40343cdebc6b2bbe624655900af61c920e2237c3ebaff25aaed3496ed1dec8f8b1a6c30d4
+  data.tar.gz: ca9628341f670ba78710751172cea75eab3d975df35c171be3dd361903322d191e8bbf71ce168bd26851f0b76a3a8d6c98268a1411fa2088970a8ef5ee4c4db0

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.0.9"
+    VERSION = "1.0.10"
     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/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,5 @@
 # frozen_string_literal: true
 
-require "date"
 require "ostruct"
 require "json"
 
@@ -12,10 +11,10 @@ module TrophyApiClient
     attr_reader :name
     # @return [String] The trigger of the achievement, either 'metric', 'streak', or 'api'.
     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
@@ -42,8 +41,8 @@ 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 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
@@ -56,13 +55,13 @@ module TrophyApiClient
     #  trigger = 'metric')
     # @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,
+    def initialize(id:, name:, trigger:, description: OMIT, badge_url: OMIT, key: OMIT, streak_length: OMIT,
                    metric_id: OMIT, metric_value: OMIT, metric_name: 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
@@ -73,8 +72,8 @@ module TrophyApiClient
         "id": id,
         "name": name,
         "trigger": trigger,
+        "description": description,
         "badgeUrl": badge_url,
-        "achievedAt": achieved_at,
         "key": key,
         "streakLength": streak_length,
         "metricId": metric_id,
@@ -95,8 +94,8 @@ 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"]
@@ -106,8 +105,8 @@ module TrophyApiClient
         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,
@@ -134,8 +133,8 @@ module TrophyApiClient
       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.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.")

data/lib/trophy_api_client/types/achievement_with_stats_response.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AchievementWithStatsResponse
+    # @return [Integer] The number of users who have completed this achievement.
+    attr_reader :completions
+    # @return [Float] The percentage of all users who have completed this achievement.
+    attr_reader :completed_percentage
+    # @return [String] The unique ID of the achievement.
+    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'.
+    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 [String] The key used to reference this achievement in the API (only applicable if
+    #  trigger = 'api')
+    attr_reader :key
+    # @return [Integer] The length of the streak required to complete the achievement (only applicable
+    #  if trigger = 'streak')
+    attr_reader :streak_length
+    # @return [String] The ID of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    attr_reader :metric_id
+    # @return [Float] The value of the metric required to complete the achievement (only applicable if
+    #  trigger = 'metric')
+    attr_reader :metric_value
+    # @return [String] The name of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    attr_reader :metric_name
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param completions [Integer] The number of users who have completed this achievement.
+    # @param completed_percentage [Float] The percentage of all users who have completed this achievement.
+    # @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 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 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
+    #  if trigger = 'streak')
+    # @param metric_id [String] The ID of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    # @param metric_value [Float] The value of the metric required to complete the achievement (only applicable if
+    #  trigger = 'metric')
+    # @param metric_name [String] The name of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AchievementWithStatsResponse]
+    def initialize(id:, name:, trigger:, completions: OMIT, completed_percentage: OMIT, description: OMIT,
+                   badge_url: OMIT, key: OMIT, streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
+      @completions = completions if completions != OMIT
+      @completed_percentage = completed_percentage if completed_percentage != OMIT
+      @id = id
+      @name = name
+      @trigger = trigger
+      @description = description if description != OMIT
+      @badge_url = badge_url if badge_url != 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
+      @additional_properties = additional_properties
+      @_field_set = {
+        "completions": completions,
+        "completedPercentage": completed_percentage,
+        "id": id,
+        "name": name,
+        "trigger": trigger,
+        "description": description,
+        "badgeUrl": badge_url,
+        "key": key,
+        "streakLength": streak_length,
+        "metricId": metric_id,
+        "metricValue": metric_value,
+        "metricName": metric_name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of AchievementWithStatsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AchievementWithStatsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      completions = parsed_json["completions"]
+      completed_percentage = parsed_json["completedPercentage"]
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      trigger = parsed_json["trigger"]
+      description = parsed_json["description"]
+      badge_url = parsed_json["badgeUrl"]
+      key = parsed_json["key"]
+      streak_length = parsed_json["streakLength"]
+      metric_id = parsed_json["metricId"]
+      metric_value = parsed_json["metricValue"]
+      metric_name = parsed_json["metricName"]
+      new(
+        completions: completions,
+        completed_percentage: completed_percentage,
+        id: id,
+        name: name,
+        trigger: trigger,
+        description: description,
+        badge_url: badge_url,
+        key: key,
+        streak_length: streak_length,
+        metric_id: metric_id,
+        metric_value: metric_value,
+        metric_name: metric_name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AchievementWithStatsResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.completions&.is_a?(Integer) != false || raise("Passed value for field obj.completions is not the expected type, validation failed.")
+      obj.completed_percentage&.is_a?(Float) != false || raise("Passed value for field obj.completed_percentage is not the expected type, validation failed.")
+      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.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.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.")
+    end
+  end
+end

data/lib/trophy_api_client/types/completed_achievement_response.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class CompletedAchievementResponse
+    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    attr_reader :achieved_at
+    # @return [String] The unique ID of the achievement.
+    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'.
+    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 [String] The key used to reference this achievement in the API (only applicable if
+    #  trigger = 'api')
+    attr_reader :key
+    # @return [Integer] The length of the streak required to complete the achievement (only applicable
+    #  if trigger = 'streak')
+    attr_reader :streak_length
+    # @return [String] The ID of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    attr_reader :metric_id
+    # @return [Float] The value of the metric required to complete the achievement (only applicable if
+    #  trigger = 'metric')
+    attr_reader :metric_value
+    # @return [String] The name of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    attr_reader :metric_name
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @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 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 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
+    #  if trigger = 'streak')
+    # @param metric_id [String] The ID of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    # @param metric_value [Float] The value of the metric required to complete the achievement (only applicable if
+    #  trigger = 'metric')
+    # @param metric_name [String] The name of the metric associated with this achievement (only applicable if
+    #  trigger = 'metric')
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CompletedAchievementResponse]
+    def initialize(id:, name:, trigger:, achieved_at: OMIT, description: OMIT, badge_url: OMIT, key: OMIT,
+                   streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
+      @achieved_at = achieved_at if achieved_at != OMIT
+      @id = id
+      @name = name
+      @trigger = trigger
+      @description = description if description != OMIT
+      @badge_url = badge_url if badge_url != 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
+      @additional_properties = additional_properties
+      @_field_set = {
+        "achievedAt": achieved_at,
+        "id": id,
+        "name": name,
+        "trigger": trigger,
+        "description": description,
+        "badgeUrl": badge_url,
+        "key": key,
+        "streakLength": streak_length,
+        "metricId": metric_id,
+        "metricValue": metric_value,
+        "metricName": metric_name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CompletedAchievementResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CompletedAchievementResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      trigger = parsed_json["trigger"]
+      description = parsed_json["description"]
+      badge_url = parsed_json["badgeUrl"]
+      key = parsed_json["key"]
+      streak_length = parsed_json["streakLength"]
+      metric_id = parsed_json["metricId"]
+      metric_value = parsed_json["metricValue"]
+      metric_name = parsed_json["metricName"]
+      new(
+        achieved_at: achieved_at,
+        id: id,
+        name: name,
+        trigger: trigger,
+        description: description,
+        badge_url: badge_url,
+        key: key,
+        streak_length: streak_length,
+        metric_id: metric_id,
+        metric_value: metric_value,
+        metric_name: metric_name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CompletedAchievementResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+      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.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.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.")
+    end
+  end
+end

data/lib/trophy_api_client/types/event_response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "achievement_response"
+require_relative "completed_achievement_response"
 require_relative "increment_metric_streak_response"
 require "ostruct"
 require "json"
@@ -13,7 +13,7 @@ module TrophyApiClient
     attr_reader :metric_id
     # @return [Float] The user's new total progress against the metric.
     attr_reader :total
-    # @return [Array<TrophyApiClient::AchievementResponse>] Achievements completed as a result of this event.
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed as a result of this event.
     attr_reader :achievements
     # @return [TrophyApiClient::IncrementMetricStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
     attr_reader :current_streak
@@ -28,7 +28,7 @@ module TrophyApiClient
     # @param event_id [String] The unique ID of the event.
     # @param metric_id [String] The unique ID of the metric that was updated.
     # @param total [Float] The user's new total progress against the metric.
-    # @param achievements [Array<TrophyApiClient::AchievementResponse>] Achievements completed as a result of this event.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed as a result of this event.
     # @param current_streak [TrophyApiClient::IncrementMetricStreakResponse] 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::EventResponse]
@@ -62,7 +62,7 @@ module TrophyApiClient
       total = parsed_json["total"]
       achievements = parsed_json["achievements"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
       end
       if parsed_json["currentStreak"].nil?
         current_streak = nil

data/lib/trophy_api_client/types/metric_response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "metric_status"
-require_relative "achievement_response"
+require_relative "completed_achievement_response"
 require "ostruct"
 require "json"
 
@@ -17,7 +17,7 @@ module TrophyApiClient
     attr_reader :status
     # @return [Float] The user's current total for the metric.
     attr_reader :current
-    # @return [Array<TrophyApiClient::AchievementResponse>] A list of the metric's achievements and the user's progress towards each.
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>] A list of the metric's achievements and the user's progress towards each.
     attr_reader :achievements
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -32,7 +32,7 @@ module TrophyApiClient
     # @param name [String] The name of the metric.
     # @param status [TrophyApiClient::MetricStatus] The status of the metric.
     # @param current [Float] The user's current total for the metric.
-    # @param achievements [Array<TrophyApiClient::AchievementResponse>] A list of the metric's achievements and the user's progress towards each.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] A list of the metric's achievements and the user's progress towards each.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricResponse]
     def initialize(id:, key:, name:, status:, current:, achievements:, additional_properties: nil)
@@ -67,7 +67,7 @@ module TrophyApiClient
       current = parsed_json["current"]
       achievements = parsed_json["achievements"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
       end
       new(
         id: id,

data/lib/trophy_api_client/users/client.rb

@@ -6,7 +6,9 @@ require_relative "../types/user"
 require_relative "../types/updated_user"
 require_relative "../types/metric_response"
 require "json"
-require_relative "../types/achievement_response"
+require_relative "types/users_metric_event_summary_request_aggregation"
+require_relative "types/users_metric_event_summary_response_item"
+require_relative "../types/completed_achievement_response"
 require_relative "../types/streak_response"
 require "async"
 
@@ -192,11 +194,62 @@ module TrophyApiClient
       TrophyApiClient::MetricResponse.from_json(json_object: response.body)
     end
 
+    # Get a summary of metric events over time for a user.
+    #
+    # @param id [String] ID of the user.
+    # @param key [String] Unique key of the metric.
+    # @param aggregation [TrophyApiClient::Users::UsersMetricEventSummaryRequestAggregation] The time period over which to aggregate the event data.
+    # @param start_date [String] The start date for the data range in YYYY-MM-DD format. The startDate must be
+    #  before the endDate, and the date range must not exceed 400 days.
+    # @param end_date [String] The end date for the data range in YYYY-MM-DD format. The endDate must be after
+    #  the startDate, and the date range must not exceed 400 days.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::Users::UsersMetricEventSummaryResponseItem>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.metric_event_summary(
+    #    id: "userId",
+    #    key: "words-written",
+    #    aggregation: DAILY,
+    #    start_date: "2024-01-01",
+    #    end_date: "2024-01-31"
+    #  )
+    def metric_event_summary(id:, key:, aggregation:, start_date:, end_date:, 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 || {}),
+          "aggregation": aggregation,
+          "startDate": start_date,
+          "endDate": end_date
+        }.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(request_options: request_options)}/users/#{id}/metrics/#{key}/event-summary"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::Users::UsersMetricEventSummaryResponseItem.from_json(json_object: item)
+      end
+    end
+
     # Get all of a user's completed achievements.
     #
     # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::AchievementResponse>]
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -224,7 +277,7 @@ module TrophyApiClient
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
         item = item.to_json
-        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
       end
     end
 
@@ -455,11 +508,64 @@ module TrophyApiClient
       end
     end
 
+    # Get a summary of metric events over time for a user.
+    #
+    # @param id [String] ID of the user.
+    # @param key [String] Unique key of the metric.
+    # @param aggregation [TrophyApiClient::Users::UsersMetricEventSummaryRequestAggregation] The time period over which to aggregate the event data.
+    # @param start_date [String] The start date for the data range in YYYY-MM-DD format. The startDate must be
+    #  before the endDate, and the date range must not exceed 400 days.
+    # @param end_date [String] The end date for the data range in YYYY-MM-DD format. The endDate must be after
+    #  the startDate, and the date range must not exceed 400 days.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::Users::UsersMetricEventSummaryResponseItem>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.metric_event_summary(
+    #    id: "userId",
+    #    key: "words-written",
+    #    aggregation: DAILY,
+    #    start_date: "2024-01-01",
+    #    end_date: "2024-01-31"
+    #  )
+    def metric_event_summary(id:, key:, aggregation:, start_date:, end_date:, 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
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "aggregation": aggregation,
+            "startDate": start_date,
+            "endDate": end_date
+          }.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(request_options: request_options)}/users/#{id}/metrics/#{key}/event-summary"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::Users::UsersMetricEventSummaryResponseItem.from_json(json_object: item)
+        end
+      end
+    end
+
     # Get all of a user's completed achievements.
     #
     # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::AchievementResponse>]
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -488,7 +594,7 @@ module TrophyApiClient
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|
           item = item.to_json
-          TrophyApiClient::AchievementResponse.from_json(json_object: item)
+          TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
         end
       end
     end

data/lib/trophy_api_client/users/types/users_metric_event_summary_request_aggregation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class Users
+    class UsersMetricEventSummaryRequestAggregation
+      DAILY = "daily"
+      WEEKLY = "weekly"
+      MONTHLY = "monthly"
+    end
+  end
+end

data/lib/trophy_api_client/users/types/users_metric_event_summary_response_item.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class Users
+    class UsersMetricEventSummaryResponseItem
+      # @return [String] The date of the data point. For weekly or monthly aggregations, this is the
+      #  first date of the period.
+      attr_reader :date
+      # @return [Float] The user's total for this metric at the end of this date.
+      attr_reader :total
+      # @return [Float] The change in the user's total for this metric during this period.
+      attr_reader :change
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param date [String] The date of the data point. For weekly or monthly aggregations, this is the
+      #  first date of the period.
+      # @param total [Float] The user's total for this metric at the end of this date.
+      # @param change [Float] The change in the user's total for this metric during this period.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [TrophyApiClient::Users::UsersMetricEventSummaryResponseItem]
+      def initialize(date:, total:, change:, additional_properties: nil)
+        @date = date
+        @total = total
+        @change = change
+        @additional_properties = additional_properties
+        @_field_set = { "date": date, "total": total, "change": change }
+      end
+
+      # Deserialize a JSON object to an instance of UsersMetricEventSummaryResponseItem
+      #
+      # @param json_object [String]
+      # @return [TrophyApiClient::Users::UsersMetricEventSummaryResponseItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        date = parsed_json["date"]
+        total = parsed_json["total"]
+        change = parsed_json["change"]
+        new(
+          date: date,
+          total: total,
+          change: change,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of UsersMetricEventSummaryResponseItem to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.date.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
+        obj.total.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+        obj.change.is_a?(Float) != false || raise("Passed value for field obj.change is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.9"
+  VERSION = "1.0.10"
 end

data/lib/types_export.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "trophy_api_client/users/types/users_metric_event_summary_request_aggregation"
+require_relative "trophy_api_client/users/types/users_metric_event_summary_response_item"
 require_relative "trophy_api_client/types/metric_status"
 require_relative "trophy_api_client/types/streak_frequency"
 require_relative "trophy_api_client/types/base_streak_response"
@@ -7,6 +9,8 @@ require_relative "trophy_api_client/types/increment_metric_streak_response"
 require_relative "trophy_api_client/types/streak_response_streak_history_item"
 require_relative "trophy_api_client/types/streak_response"
 require_relative "trophy_api_client/types/achievement_response"
+require_relative "trophy_api_client/types/completed_achievement_response"
+require_relative "trophy_api_client/types/achievement_with_stats_response"
 require_relative "trophy_api_client/types/metric_response"
 require_relative "trophy_api_client/types/updated_user"
 require_relative "trophy_api_client/types/upserted_user"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -103,7 +103,9 @@ files:
 - lib/trophy_api_client/metrics/client.rb
 - lib/trophy_api_client/types/achievement_completion_response.rb
 - lib/trophy_api_client/types/achievement_response.rb
+- lib/trophy_api_client/types/achievement_with_stats_response.rb
 - lib/trophy_api_client/types/base_streak_response.rb
+- lib/trophy_api_client/types/completed_achievement_response.rb
 - lib/trophy_api_client/types/error_body.rb
 - lib/trophy_api_client/types/event_response.rb
 - lib/trophy_api_client/types/increment_metric_streak_response.rb
@@ -116,6 +118,8 @@ files:
 - lib/trophy_api_client/types/upserted_user.rb
 - lib/trophy_api_client/types/user.rb
 - lib/trophy_api_client/users/client.rb
+- lib/trophy_api_client/users/types/users_metric_event_summary_request_aggregation.rb
+- lib/trophy_api_client/users/types/users_metric_event_summary_response_item.rb
 - lib/trophy_api_client/version.rb
 - lib/types_export.rb
 homepage: https://github.com/trophyso/trophy-ruby