trophy_api_client 1.0.29 → 1.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 057cf20c78c80caa66eff19b3a3252ba56e92d84645219cc40a996afda1b6a83
-  data.tar.gz: 13b109f1d873161c2328189bfb54aebcf9f83dcc1d00570629a357f71ad34028
+  metadata.gz: c25a821fcf1f05012a279bf8ad031328a32bf4e485600e4b6f1db1484de8daa8
+  data.tar.gz: b2b975f8d431ec31f8ddec8bb2f73803dee6a45ebcbb4b92103ea904b7f5ae6b
 SHA512:
-  metadata.gz: 597eba515aec1cb420d4de9cc034175a52872a494042f15ff6e05a76843ec6c953ef87f8431fae75a80195c55aaa6572982d069afb03b01eec600e4693b4252e
-  data.tar.gz: 6ff81aa42cc68cccf65381bac4eddf79ce6eb7e36b194e3d5b0090126baffa3a311074b33c90575baadbde6030e02ea8eefe9528c30fa9dbe3beaea44d8064ac
+  metadata.gz: 33c5da328d9511d8a1f0231d1697ebf671b9463b426fcf575a9be4037f5963f5a23347e358e38ef12a05fbc9da9a6c27f2ad36b134a07d07887605ae8d44c86a
+  data.tar.gz: 01dbb928522b7d992d4788e3112f058455a143f870215824a2c1336cb165ace1bb5a5469ec4cbfade09c31cc49987931119156b05efb1ad2c9ebeb8b97339a0a

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/achievements/client.rb

@@ -72,7 +72,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
     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?
@@ -159,7 +159,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
     def complete(key:, user:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|

data/lib/trophy_api_client/leaderboards/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "../types/leaderboard_response"
+require_relative "types/leaderboards_all_response_item"
 require "json"
 require_relative "../types/leaderboard_response_with_rankings"
 require "async"
@@ -20,7 +20,7 @@ module TrophyApiClient
     # Get all active leaderboards for your organization.
     #
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::LeaderboardResponse>]
+    # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -48,7 +48,7 @@ module TrophyApiClient
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
         item = item.to_json
-        TrophyApiClient::LeaderboardResponse.from_json(json_object: item)
+        TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem.from_json(json_object: item)
       end
     end
 
@@ -71,6 +71,8 @@ module TrophyApiClient
     #  )
     #  api.leaderboards.get(
     #    key: "weekly-words",
+    #    offset: 1,
+    #    limit: 1,
     #    run: "2025-01-15",
     #    user_id: "user-123"
     #  )
@@ -112,7 +114,7 @@ module TrophyApiClient
     # Get all active leaderboards for your organization.
     #
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::LeaderboardResponse>]
+    # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -141,7 +143,7 @@ module TrophyApiClient
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|
           item = item.to_json
-          TrophyApiClient::LeaderboardResponse.from_json(json_object: item)
+          TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem.from_json(json_object: item)
         end
       end
     end
@@ -165,6 +167,8 @@ module TrophyApiClient
     #  )
     #  api.leaderboards.get(
     #    key: "weekly-words",
+    #    offset: 1,
+    #    limit: 1,
     #    run: "2025-01-15",
     #    user_id: "user-123"
     #  )

data/lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require_relative "leaderboards_all_response_item_status"
+require_relative "../../types/leaderboard_response_rank_by"
+require_relative "../../types/leaderboard_response_run_unit"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class Leaderboards
+    class LeaderboardsAllResponseItem
+      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus] The status of the leaderboard.
+      attr_reader :status
+      # @return [String] The unique ID of the leaderboard.
+      attr_reader :id
+      # @return [String] The user-facing name of the leaderboard.
+      attr_reader :name
+      # @return [String] The unique key used to reference the leaderboard in APIs.
+      attr_reader :key
+      # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+      attr_reader :rank_by
+      # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
+      attr_reader :metric_key
+      # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
+      attr_reader :metric_name
+      # @return [String] The key of the points system to rank by, if rankBy is 'points'.
+      attr_reader :points_system_key
+      # @return [String] The name of the points system to rank by, if rankBy is 'points'.
+      attr_reader :points_system_name
+      # @return [String] The user-facing description of the leaderboard.
+      attr_reader :description
+      # @return [String] The start date of the leaderboard in YYYY-MM-DD format.
+      attr_reader :start
+      # @return [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
+      #  forever.
+      attr_reader :end_
+      # @return [Integer] The maximum number of participants in the leaderboard.
+      attr_reader :max_participants
+      # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
+      #  leaderboards.
+      attr_reader :run_unit
+      # @return [Integer] The interval between repetitions, relative to the start date and repetition
+      #  type.
+      attr_reader :run_interval
+      # @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 status [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus] The status of the leaderboard.
+      # @param id [String] The unique ID of the leaderboard.
+      # @param name [String] The user-facing name of the leaderboard.
+      # @param key [String] The unique key used to reference the leaderboard in APIs.
+      # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+      # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
+      # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
+      # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
+      # @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
+      # @param description [String] The user-facing description of the leaderboard.
+      # @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
+      # @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
+      #  forever.
+      # @param max_participants [Integer] The maximum number of participants in the leaderboard.
+      # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
+      #  leaderboards.
+      # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
+      #  type.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
+      def initialize(status:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT,
+                     points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
+        @status = status
+        @id = id
+        @name = name
+        @key = key
+        @rank_by = rank_by
+        @metric_key = metric_key if metric_key != OMIT
+        @metric_name = metric_name if metric_name != OMIT
+        @points_system_key = points_system_key if points_system_key != OMIT
+        @points_system_name = points_system_name if points_system_name != OMIT
+        @description = description
+        @start = start
+        @end_ = end_ if end_ != OMIT
+        @max_participants = max_participants
+        @run_unit = run_unit if run_unit != OMIT
+        @run_interval = run_interval
+        @additional_properties = additional_properties
+        @_field_set = {
+          "status": status,
+          "id": id,
+          "name": name,
+          "key": key,
+          "rankBy": rank_by,
+          "metricKey": metric_key,
+          "metricName": metric_name,
+          "pointsSystemKey": points_system_key,
+          "pointsSystemName": points_system_name,
+          "description": description,
+          "start": start,
+          "end": end_,
+          "maxParticipants": max_participants,
+          "runUnit": run_unit,
+          "runInterval": run_interval
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of LeaderboardsAllResponseItem
+      #
+      # @param json_object [String]
+      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        status = parsed_json["status"]
+        id = parsed_json["id"]
+        name = parsed_json["name"]
+        key = parsed_json["key"]
+        rank_by = parsed_json["rankBy"]
+        metric_key = parsed_json["metricKey"]
+        metric_name = parsed_json["metricName"]
+        points_system_key = parsed_json["pointsSystemKey"]
+        points_system_name = parsed_json["pointsSystemName"]
+        description = parsed_json["description"]
+        start = parsed_json["start"]
+        end_ = parsed_json["end"]
+        max_participants = parsed_json["maxParticipants"]
+        run_unit = parsed_json["runUnit"]
+        run_interval = parsed_json["runInterval"]
+        new(
+          status: status,
+          id: id,
+          name: name,
+          key: key,
+          rank_by: rank_by,
+          metric_key: metric_key,
+          metric_name: metric_name,
+          points_system_key: points_system_key,
+          points_system_name: points_system_name,
+          description: description,
+          start: start,
+          end_: end_,
+          max_participants: max_participants,
+          run_unit: run_unit,
+          run_interval: run_interval,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of LeaderboardsAllResponseItem 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.status.is_a?(TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus) != false || raise("Passed value for field obj.status 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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+        obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
+        obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key 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.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")
+        obj.points_system_name&.is_a?(String) != false || raise("Passed value for field obj.points_system_name 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.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
+        obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
+        obj.max_participants.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
+        obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
+        obj.run_interval.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class Leaderboards
+    # The status of the leaderboard.
+    class LeaderboardsAllResponseItemStatus
+      ACTIVE = "active"
+      SCHEDULED = "scheduled"
+      FINISHED = "finished"
+    end
+  end
+end

data/lib/trophy_api_client/metrics/client.rb

@@ -42,7 +42,7 @@ module TrophyApiClient
     #  api.metrics.event(
     #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
     #    key: "words-written",
-    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
+    #    user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "18" },
     #    value: 750,
     #    attributes: { "category": "writing", "source": "mobile-app" }
     #  )
@@ -107,7 +107,7 @@ module TrophyApiClient
     #  api.metrics.event(
     #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
     #    key: "words-written",
-    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
+    #    user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "18" },
     #    value: 750,
     #    attributes: { "category": "writing", "source": "mobile-app" }
     #  )

data/lib/trophy_api_client/streaks/client.rb

@@ -65,7 +65,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.streaks.rankings
+    #  api.streaks.rankings(limit: 1, type: ACTIVE)
     def rankings(limit: nil, type: 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?
@@ -148,7 +148,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.streaks.rankings
+    #  api.streaks.rankings(limit: 1, type: ACTIVE)
     def rankings(limit: nil, type: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|

data/lib/trophy_api_client/types/achievement_completion_response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "completed_achievement_response"
+require_relative "achievement_completion_response_achievement"
 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::CompletedAchievementResponse]
+    # @return [TrophyApiClient::AchievementCompletionResponseAchievement]
     attr_reader :achievement
     # @return [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this achievement
     #  completion.
@@ -22,19 +22,17 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param completion_id [String] The unique ID of the completion.
-    # @param achievement [TrophyApiClient::CompletedAchievementResponse]
+    # @param achievement [TrophyApiClient::AchievementCompletionResponseAchievement]
     # @param points [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this achievement
     #  completion.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementCompletionResponse]
-    def initialize(completion_id:, achievement:, points: OMIT, additional_properties: nil)
+    def initialize(completion_id:, achievement:, points:, additional_properties: nil)
       @completion_id = completion_id
       @achievement = achievement
-      @points = points if points != OMIT
+      @points = points
       @additional_properties = additional_properties
-      @_field_set = { "completionId": completion_id, "achievement": achievement, "points": points }.reject do |_k, v|
-        v == OMIT
-      end
+      @_field_set = { "completionId": completion_id, "achievement": achievement, "points": points }
     end
 
     # Deserialize a JSON object to an instance of AchievementCompletionResponse
@@ -49,7 +47,7 @@ module TrophyApiClient
         achievement = nil
       else
         achievement = parsed_json["achievement"].to_json
-        achievement = TrophyApiClient::CompletedAchievementResponse.from_json(json_object: achievement)
+        achievement = TrophyApiClient::AchievementCompletionResponseAchievement.from_json(json_object: achievement)
       end
       points = parsed_json["points"]&.transform_values do |value|
         value = value.to_json
@@ -78,8 +76,8 @@ 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::CompletedAchievementResponse.validate_raw(obj: obj.achievement)
-      obj.points&.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      TrophyApiClient::AchievementCompletionResponseAchievement.validate_raw(obj: obj.achievement)
+      obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
     end
   end
 end

data/lib/trophy_api_client/types/achievement_completion_response_achievement.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require_relative "metric_event_streak_response"
+require "date"
+require_relative "achievement_response_trigger"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AchievementCompletionResponseAchievement
+    # @return [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    attr_reader :current_streak
+    # @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 [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 [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 current_streak [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @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 [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 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::AchievementCompletionResponseAchievement]
+    def initialize(achieved_at:, id:, name:, trigger:, key:, current_streak: OMIT, description: OMIT, badge_url: OMIT,
+                   streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
+      @current_streak = current_streak if current_streak != OMIT
+      @achieved_at = achieved_at
+      @id = id
+      @name = name
+      @trigger = trigger
+      @description = description if description != OMIT
+      @badge_url = badge_url if badge_url != OMIT
+      @key = key
+      @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 = {
+        "currentStreak": current_streak,
+        "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
+    #  AchievementCompletionResponseAchievement
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AchievementCompletionResponseAchievement]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      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
+      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(
+        current_streak: current_streak,
+        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 AchievementCompletionResponseAchievement 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.current_streak.nil? || TrophyApiClient::MetricEventStreakResponse.validate_raw(obj: obj.current_streak)
+      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?(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.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/achievement_response.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "achievement_response_trigger"
-require_relative "metric_event_streak_response"
 require "ostruct"
 require "json"
 
@@ -32,8 +31,6 @@ 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]
@@ -57,22 +54,20 @@ 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:, 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)
+    def initialize(id:, name:, trigger:, key:, description: OMIT, badge_url: 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
-      @key = key if key != OMIT
+      @key = key
       @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,
@@ -84,8 +79,7 @@ module TrophyApiClient
         "streakLength": streak_length,
         "metricId": metric_id,
         "metricValue": metric_value,
-        "metricName": metric_name,
-        "currentStreak": current_streak
+        "metricName": metric_name
       }.reject do |_k, v|
         v == OMIT
       end
@@ -108,12 +102,6 @@ module TrophyApiClient
       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,
@@ -125,7 +113,6 @@ module TrophyApiClient
         metric_id: metric_id,
         metric_value: metric_value,
         metric_name: metric_name,
-        current_streak: current_streak,
         additional_properties: struct
       )
     end
@@ -149,12 +136,11 @@ module TrophyApiClient
       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.key&.is_a?(String) != false || raise("Passed value for field obj.key 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