trophy_api_client 1.0.9 → 1.0.11

data/lib/trophy_api_client/types/achievement_with_stats_response.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require_relative "achievement_response_trigger"
+require_relative "metric_event_streak_response"
+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 [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 [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]
+    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 [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 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::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, current_streak: 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
+      @current_streak = current_streak if current_streak != 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,
+        "currentStreak": current_streak
+      }.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"]
+      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(
+        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,
+        current_streak: current_streak,
+        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?(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.")
+      obj.current_streak.nil? || TrophyApiClient::MetricEventStreakResponse.validate_raw(obj: obj.current_streak)
+    end
+  end
+end

data/lib/trophy_api_client/types/completed_achievement_response.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "achievement_response_trigger"
+require_relative "metric_event_streak_response"
+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 [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 [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]
+    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 [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 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::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, current_streak: 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
+      @current_streak = current_streak if current_streak != 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,
+        "currentStreak": current_streak
+      }.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"]
+      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(
+        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,
+        current_streak: current_streak,
+        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?(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.")
+      obj.current_streak.nil? || TrophyApiClient::MetricEventStreakResponse.validate_raw(obj: obj.current_streak)
+    end
+  end
+end

data/lib/trophy_api_client/types/event_response.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "achievement_response"
-require_relative "increment_metric_streak_response"
+require_relative "completed_achievement_response"
+require_relative "metric_event_streak_response"
+require_relative "points_award"
 require "ostruct"
 require "json"
 
@@ -13,10 +14,13 @@ 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.
+    # @return [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
     attr_reader :current_streak
+    # @return [TrophyApiClient::PointsAward] The points added by this event, and a breakdown of the points awards that added
+    #  points.
+    attr_reader :points
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -28,23 +32,28 @@ 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 current_streak [TrophyApiClient::IncrementMetricStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed as a result of this event.
+    # @param current_streak [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @param points [TrophyApiClient::PointsAward] The points added by this event, and a breakdown of the points awards that added
+    #  points.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::EventResponse]
-    def initialize(event_id:, metric_id:, total:, achievements: OMIT, current_streak: OMIT, additional_properties: nil)
+    def initialize(event_id:, metric_id:, total:, achievements: OMIT, current_streak: OMIT, points: OMIT,
+                   additional_properties: nil)
       @event_id = event_id
       @metric_id = metric_id
       @total = total
       @achievements = achievements if achievements != OMIT
       @current_streak = current_streak if current_streak != OMIT
+      @points = points if points != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "eventId": event_id,
         "metricId": metric_id,
         "total": total,
         "achievements": achievements,
-        "currentStreak": current_streak
+        "currentStreak": current_streak,
+        "points": points
       }.reject do |_k, v|
         v == OMIT
       end
@@ -62,13 +71,19 @@ 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
       else
         current_streak = parsed_json["currentStreak"].to_json
-        current_streak = TrophyApiClient::IncrementMetricStreakResponse.from_json(json_object: current_streak)
+        current_streak = TrophyApiClient::MetricEventStreakResponse.from_json(json_object: current_streak)
+      end
+      if parsed_json["points"].nil?
+        points = nil
+      else
+        points = parsed_json["points"].to_json
+        points = TrophyApiClient::PointsAward.from_json(json_object: points)
       end
       new(
         event_id: event_id,
@@ -76,6 +91,7 @@ module TrophyApiClient
         total: total,
         achievements: achievements,
         current_streak: current_streak,
+        points: points,
         additional_properties: struct
       )
     end
@@ -98,7 +114,8 @@ module TrophyApiClient
       obj.metric_id.is_a?(String) != false || raise("Passed value for field obj.metric_id 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.achievements&.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
-      obj.current_streak.nil? || TrophyApiClient::IncrementMetricStreakResponse.validate_raw(obj: obj.current_streak)
+      obj.current_streak.nil? || TrophyApiClient::MetricEventStreakResponse.validate_raw(obj: obj.current_streak)
+      obj.points.nil? || TrophyApiClient::PointsAward.validate_raw(obj: obj.points)
     end
   end
 end

data/lib/trophy_api_client/types/get_user_points_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "points_award"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class GetUserPointsResponse
+    # @return [Float] The user's total points
+    attr_reader :total
+    # @return [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
+    attr_reader :awards
+    # @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 total [Float] The user's total points
+    # @param awards [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::GetUserPointsResponse]
+    def initialize(total: OMIT, awards: OMIT, additional_properties: nil)
+      @total = total if total != OMIT
+      @awards = awards if awards != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "total": total, "awards": awards }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of GetUserPointsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::GetUserPointsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      total = parsed_json["total"]
+      awards = parsed_json["awards"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsAward.from_json(json_object: item)
+      end
+      new(
+        total: total,
+        awards: awards,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of GetUserPointsResponse 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.total&.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+      obj.awards&.is_a?(Array) != false || raise("Passed value for field obj.awards is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/metric_event_points_response.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "points_award"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class MetricEventPointsResponse
+    # @return [Float] The points added by this event.
+    attr_reader :added
+    # @return [Float] The user's total points
+    attr_reader :total
+    # @return [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
+    attr_reader :awards
+    # @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 added [Float] The points added by this event.
+    # @param total [Float] The user's total points
+    # @param awards [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::MetricEventPointsResponse]
+    def initialize(added: OMIT, total: OMIT, awards: OMIT, additional_properties: nil)
+      @added = added if added != OMIT
+      @total = total if total != OMIT
+      @awards = awards if awards != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "added": added, "total": total, "awards": awards }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of MetricEventPointsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::MetricEventPointsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      added = parsed_json["added"]
+      total = parsed_json["total"]
+      awards = parsed_json["awards"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsAward.from_json(json_object: item)
+      end
+      new(
+        added: added,
+        total: total,
+        awards: awards,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of MetricEventPointsResponse 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.added&.is_a?(Float) != false || raise("Passed value for field obj.added 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.awards&.is_a?(Array) != false || raise("Passed value for field obj.awards is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/{increment_metric_streak_response.rb → metric_event_streak_response.rb}

@@ -5,8 +5,8 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
-  # An object representing the user's streak after incrementing a metric.
-  class IncrementMetricStreakResponse
+  # An object representing the user's streak after sending a metric event.
+  class MetricEventStreakResponse
     # @return [Boolean] Whether this metric event increased the user's streak length.
     attr_reader :extended
     # @return [Integer] The length of the user's current streak.
@@ -37,7 +37,7 @@ module TrophyApiClient
     # @param period_end [String] The end date of the current streak period.
     # @param expires [String] The date the streak will expire if the user does not increment a metric.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::IncrementMetricStreakResponse]
+    # @return [TrophyApiClient::MetricEventStreakResponse]
     def initialize(length:, frequency:, extended: OMIT, started: OMIT, period_start: OMIT, period_end: OMIT,
                    expires: OMIT, additional_properties: nil)
       @extended = extended if extended != OMIT
@@ -61,10 +61,10 @@ module TrophyApiClient
       end
     end
 
-    # Deserialize a JSON object to an instance of IncrementMetricStreakResponse
+    # Deserialize a JSON object to an instance of MetricEventStreakResponse
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::IncrementMetricStreakResponse]
+    # @return [TrophyApiClient::MetricEventStreakResponse]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -87,7 +87,7 @@ module TrophyApiClient
       )
     end
 
-    # Serialize an instance of IncrementMetricStreakResponse to a JSON object
+    # Serialize an instance of MetricEventStreakResponse to a JSON object
     #
     # @return [String]
     def to_json(*_args)

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,