trophy_api_client 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 781b0353ba46d056e106f841128a86cd104b6052d7fd39956bb42ab20a959d09
-  data.tar.gz: 2272e2e18f75bd8fa4216e34aa4958893f2ee0d58741cc8112c56bc5cd2cc6cc
+  metadata.gz: 0bb50b78377373fe998de76dec582b9849dae850ff8ea926318ae361924833e8
+  data.tar.gz: 035d6798383c8612d08f8c8c3a954e7425d25526dabae8c4e63ac5884cc7096a
 SHA512:
-  metadata.gz: 0471d201882a0db3aa29df13e5d512d49be2a9342aa0a0e0d69d644b31e8282898f7f42c1bff782cd61d12182ef25270aa66a86d8f11682a58eb4258bea079c1
-  data.tar.gz: 0d5b104155ad175b4b8105a3dc3a49e1693508331eabe0d64df48033dbc4c3bf1aed05c2d4a1ce132b0aa4065b86dd8ea8f91ebe2f6c2f1802adb4d0291f2aed
+  metadata.gz: 592ea29e76efc5c383d92263d108698a0b8175077c8ddd6682f2fd7f1fde41f92e4b57811e05ac76e57fd1eadc0711d0aefe4267ef2eb37b9cda732f1dc56cea
+  data.tar.gz: 75899f9e4d97c32499853c25027cd0560dbab159573de0bed2bf7e1e348c1e37b3902528cdb884b01610eea9145c938fa7e19aa079723b7424e7472732007bcf

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/types/achievement_completion_response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "one_off_achievement_response"
+require_relative "api_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::OneOffAchievementResponse]
+    # @return [TrophyApiClient::ApiAchievementResponse]
     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::OneOffAchievementResponse]
+    # @param achievement [TrophyApiClient::ApiAchievementResponse]
     # @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::OneOffAchievementResponse.from_json(json_object: achievement)
+        achievement = TrophyApiClient::ApiAchievementResponse.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::OneOffAchievementResponse.validate_raw(obj: obj.achievement)
+      TrophyApiClient::ApiAchievementResponse.validate_raw(obj: obj.achievement)
     end
   end
 end

data/lib/trophy_api_client/types/achievement_response.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "metric_achievement_response"
+require_relative "streak_achievement_response"
+require_relative "api_achievement_response"
+
+module TrophyApiClient
+  class AchievementResponse
+    # Deserialize a JSON object to an instance of AchievementResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AchievementResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        TrophyApiClient::MetricAchievementResponse.validate_raw(obj: struct)
+        return TrophyApiClient::MetricAchievementResponse.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        TrophyApiClient::StreakAchievementResponse.validate_raw(obj: struct)
+        return TrophyApiClient::StreakAchievementResponse.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        TrophyApiClient::ApiAchievementResponse.validate_raw(obj: struct)
+        return TrophyApiClient::ApiAchievementResponse.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
+    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:)
+      begin
+        return TrophyApiClient::MetricAchievementResponse.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return TrophyApiClient::StreakAchievementResponse.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return TrophyApiClient::ApiAchievementResponse.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/api_achievement_response.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class ApiAchievementResponse
+    # @return [String] The trigger of the achievement, in this case always 'api'.
+    attr_reader :trigger
+    # @return [String] The unique ID of the achievement.
+    attr_reader :id
+    # @return [String] The name of this achievement.
+    attr_reader :name
+    # @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.
+    attr_reader :key
+    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    attr_reader :achieved_at
+    # @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 trigger [String] The trigger of the achievement, in this case always 'api'.
+    # @param id [String] The unique ID of the achievement.
+    # @param name [String] The name 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.
+    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::ApiAchievementResponse]
+    def initialize(trigger:, id:, name:, badge_url: OMIT, key: OMIT, achieved_at: OMIT, additional_properties: nil)
+      @trigger = trigger
+      @id = id
+      @name = name
+      @badge_url = badge_url if badge_url != OMIT
+      @key = key if key != OMIT
+      @achieved_at = achieved_at if achieved_at != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "trigger": trigger,
+        "id": id,
+        "name": name,
+        "badgeUrl": badge_url,
+        "key": key,
+        "achievedAt": achieved_at
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ApiAchievementResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::ApiAchievementResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      trigger = parsed_json["trigger"]
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      badge_url = parsed_json["badgeUrl"]
+      key = parsed_json["key"]
+      achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
+      new(
+        trigger: trigger,
+        id: id,
+        name: name,
+        badge_url: badge_url,
+        key: key,
+        achieved_at: achieved_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ApiAchievementResponse 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.trigger.is_a?(String) != false || raise("Passed value for field obj.trigger 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.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.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/{one_off_achievement_response.rb → base_achievement_response.rb}

@@ -5,7 +5,7 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
-  class OneOffAchievementResponse
+  class BaseAchievementResponse
     # @return [String] The unique ID of the achievement.
     attr_reader :id
     # @return [String] The name of this achievement.
@@ -30,10 +30,10 @@ module TrophyApiClient
     # @param key [String] The key used to reference this achievement in the API.
     # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::OneOffAchievementResponse]
-    def initialize(id:, name: OMIT, badge_url: OMIT, key: OMIT, achieved_at: OMIT, additional_properties: nil)
+    # @return [TrophyApiClient::BaseAchievementResponse]
+    def initialize(id:, name:, badge_url: OMIT, key: OMIT, achieved_at: OMIT, additional_properties: nil)
       @id = id
-      @name = name if name != OMIT
+      @name = name
       @badge_url = badge_url if badge_url != OMIT
       @key = key if key != OMIT
       @achieved_at = achieved_at if achieved_at != OMIT
@@ -49,10 +49,10 @@ module TrophyApiClient
       end
     end
 
-    # Deserialize a JSON object to an instance of OneOffAchievementResponse
+    # Deserialize a JSON object to an instance of BaseAchievementResponse
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::OneOffAchievementResponse]
+    # @return [TrophyApiClient::BaseAchievementResponse]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -71,7 +71,7 @@ module TrophyApiClient
       )
     end
 
-    # Serialize an instance of OneOffAchievementResponse to a JSON object
+    # Serialize an instance of BaseAchievementResponse to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -86,7 +86,7 @@ module TrophyApiClient
     # @return [Void]
     def self.validate_raw(obj:)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name 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.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")

data/lib/trophy_api_client/types/event_response_metrics_item.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
-require_relative "multi_stage_achievement_response"
+require_relative "event_response_metrics_item_completed_item"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
   class EventResponseMetricsItem
-    # @return [String] The ID of the metric.
+    # @return [String] The trigger of the achievement, in this case either 'metric' or 'streak'.
+    attr_reader :trigger
+    # @return [String] The ID of the metric that these achievements are associated with, if any.
     attr_reader :metric_id
-    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>] A list of any new achievements that the user has now completed as a result of
+    # @return [Array<TrophyApiClient::EventResponseMetricsItemCompletedItem>] A list of any new achievements that the user has now completed as a result of
     #  this event being submitted.
     attr_reader :completed
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -19,16 +21,18 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param metric_id [String] The ID of the metric.
-    # @param completed [Array<TrophyApiClient::MultiStageAchievementResponse>] A list of any new achievements that the user has now completed as a result of
+    # @param trigger [String] The trigger of the achievement, in this case either 'metric' or 'streak'.
+    # @param metric_id [String] The ID of the metric that these achievements are associated with, if any.
+    # @param completed [Array<TrophyApiClient::EventResponseMetricsItemCompletedItem>] A list of any new achievements that the user has now completed as a result of
     #  this event being submitted.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::EventResponseMetricsItem]
-    def initialize(metric_id: OMIT, completed: OMIT, additional_properties: nil)
+    def initialize(completed:, trigger: OMIT, metric_id: OMIT, additional_properties: nil)
+      @trigger = trigger if trigger != OMIT
       @metric_id = metric_id if metric_id != OMIT
-      @completed = completed if completed != OMIT
+      @completed = completed
       @additional_properties = additional_properties
-      @_field_set = { "metricId": metric_id, "completed": completed }.reject do |_k, v|
+      @_field_set = { "trigger": trigger, "metricId": metric_id, "completed": completed }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -40,12 +44,14 @@ module TrophyApiClient
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      trigger = parsed_json["trigger"]
       metric_id = parsed_json["metricId"]
       completed = parsed_json["completed"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
+        TrophyApiClient::EventResponseMetricsItemCompletedItem.from_json(json_object: item)
       end
       new(
+        trigger: trigger,
         metric_id: metric_id,
         completed: completed,
         additional_properties: struct
@@ -66,8 +72,9 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.trigger&.is_a?(String) != false || raise("Passed value for field obj.trigger 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.completed&.is_a?(Array) != false || raise("Passed value for field obj.completed is not the expected type, validation failed.")
+      obj.completed.is_a?(Array) != false || raise("Passed value for field obj.completed is not the expected type, validation failed.")
     end
   end
 end

data/lib/trophy_api_client/types/event_response_metrics_item_completed_item.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "metric_achievement_response"
+require_relative "streak_achievement_response"
+
+module TrophyApiClient
+  class EventResponseMetricsItemCompletedItem
+    # Deserialize a JSON object to an instance of
+    #  EventResponseMetricsItemCompletedItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::EventResponseMetricsItemCompletedItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        TrophyApiClient::MetricAchievementResponse.validate_raw(obj: struct)
+        return TrophyApiClient::MetricAchievementResponse.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        TrophyApiClient::StreakAchievementResponse.validate_raw(obj: struct)
+        return TrophyApiClient::StreakAchievementResponse.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
+    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:)
+      begin
+        return TrophyApiClient::MetricAchievementResponse.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return TrophyApiClient::StreakAchievementResponse.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/{multi_stage_achievement_response.rb → metric_achievement_response.rb}

@@ -5,13 +5,9 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
-  class MultiStageAchievementResponse
-    # @return [String] The unique ID of the achievement.
-    attr_reader :id
-    # @return [String] The name of this achievement.
-    attr_reader :name
-    # @return [String] The URL of the badge image for the achievement, if one has been uploaded.
-    attr_reader :badge_url
+  class MetricAchievementResponse
+    # @return [String] The trigger of the achievement, in this case always 'metric'.
+    attr_reader :trigger
     # @return [String] The ID of the metric associated with this achievement, if any.
     attr_reader :metric_id
     # @return [Float] The value of the metric required to complete the achievement, if this
@@ -19,6 +15,12 @@ module TrophyApiClient
     attr_reader :metric_value
     # @return [String] The name of the metric associated with this achievement, if any.
     attr_reader :metric_name
+    # @return [String] The unique ID of the achievement.
+    attr_reader :id
+    # @return [String] The name of this achievement.
+    attr_reader :name
+    # @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.
     attr_reader :key
     # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
@@ -31,35 +33,38 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param id [String] The unique ID of the achievement.
-    # @param name [String] The name of this achievement.
-    # @param badge_url [String] The URL of the badge image for the achievement, if one has been uploaded.
+    # @param trigger [String] The trigger of the achievement, in this case always 'metric'.
     # @param metric_id [String] The ID of the metric associated with this achievement, if any.
     # @param metric_value [Float] The value of the metric required to complete the achievement, if this
     #  achievement is associated with a metric.
     # @param metric_name [String] The name of the metric associated with this achievement, if any.
+    # @param id [String] The unique ID of the achievement.
+    # @param name [String] The name 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.
     # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::MultiStageAchievementResponse]
-    def initialize(id:, name: OMIT, badge_url: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, key: OMIT,
+    # @return [TrophyApiClient::MetricAchievementResponse]
+    def initialize(trigger:, metric_id:, metric_value:, metric_name:, id:, name:, badge_url: OMIT, key: OMIT,
                    achieved_at: OMIT, additional_properties: nil)
+      @trigger = trigger
+      @metric_id = metric_id
+      @metric_value = metric_value
+      @metric_name = metric_name
       @id = id
-      @name = name if name != OMIT
+      @name = name
       @badge_url = badge_url if badge_url != 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
       @key = key if key != OMIT
       @achieved_at = achieved_at if achieved_at != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "id": id,
-        "name": name,
-        "badgeUrl": badge_url,
+        "trigger": trigger,
         "metricId": metric_id,
         "metricValue": metric_value,
         "metricName": metric_name,
+        "id": id,
+        "name": name,
+        "badgeUrl": badge_url,
         "key": key,
         "achievedAt": achieved_at
       }.reject do |_k, v|
@@ -67,35 +72,37 @@ module TrophyApiClient
       end
     end
 
-    # Deserialize a JSON object to an instance of MultiStageAchievementResponse
+    # Deserialize a JSON object to an instance of MetricAchievementResponse
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::MultiStageAchievementResponse]
+    # @return [TrophyApiClient::MetricAchievementResponse]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      id = parsed_json["id"]
-      name = parsed_json["name"]
-      badge_url = parsed_json["badgeUrl"]
+      trigger = parsed_json["trigger"]
       metric_id = parsed_json["metricId"]
       metric_value = parsed_json["metricValue"]
       metric_name = parsed_json["metricName"]
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      badge_url = parsed_json["badgeUrl"]
       key = parsed_json["key"]
       achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
       new(
-        id: id,
-        name: name,
-        badge_url: badge_url,
+        trigger: trigger,
         metric_id: metric_id,
         metric_value: metric_value,
         metric_name: metric_name,
+        id: id,
+        name: name,
+        badge_url: badge_url,
         key: key,
         achieved_at: achieved_at,
         additional_properties: struct
       )
     end
 
-    # Serialize an instance of MultiStageAchievementResponse to a JSON object
+    # Serialize an instance of MetricAchievementResponse to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -109,12 +116,13 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.trigger.is_a?(String) != false || raise("Passed value for field obj.trigger 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.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.name.is_a?(String) != false || raise("Passed value for field obj.name 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.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.key&.is_a?(String) != false || raise("Passed value for field obj.key 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.")
     end

data/lib/trophy_api_client/types/metric_response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "metric_status"
-require_relative "multi_stage_achievement_response"
+require_relative "metric_achievement_response"
 require "ostruct"
 require "json"
 
@@ -13,13 +13,11 @@ module TrophyApiClient
     attr_reader :key
     # @return [String] The name of the metric.
     attr_reader :name
-    # @return [String] The emoji to represent the metric.
-    attr_reader :emoji
     # @return [TrophyApiClient::MetricStatus] The status of the metric.
     attr_reader :status
     # @return [Float] The user's current total for the metric.
     attr_reader :current
-    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>] A list of the metric's achievements and the user's progress towards each.
+    # @return [Array<TrophyApiClient::MetricAchievementResponse>] 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,17 +30,15 @@ module TrophyApiClient
     # @param id [String] The unique ID of the metric.
     # @param key [String] The unique key of the metric.
     # @param name [String] The name of the metric.
-    # @param emoji [String] The emoji to represent 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::MultiStageAchievementResponse>] A list of the metric's achievements and the user's progress towards each.
+    # @param achievements [Array<TrophyApiClient::MetricAchievementResponse>] 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:, emoji:, status:, current:, achievements:, additional_properties: nil)
+    def initialize(id:, key:, name:, status:, current:, achievements:, additional_properties: nil)
       @id = id
       @key = key
       @name = name
-      @emoji = emoji
       @status = status
       @current = current
       @achievements = achievements
@@ -51,7 +47,6 @@ module TrophyApiClient
         "id": id,
         "key": key,
         "name": name,
-        "emoji": emoji,
         "status": status,
         "current": current,
         "achievements": achievements
@@ -68,18 +63,16 @@ module TrophyApiClient
       id = parsed_json["id"]
       key = parsed_json["key"]
       name = parsed_json["name"]
-      emoji = parsed_json["emoji"]
       status = parsed_json["status"]
       current = parsed_json["current"]
       achievements = parsed_json["achievements"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
+        TrophyApiClient::MetricAchievementResponse.from_json(json_object: item)
       end
       new(
         id: id,
         key: key,
         name: name,
-        emoji: emoji,
         status: status,
         current: current,
         achievements: achievements,
@@ -104,7 +97,6 @@ module TrophyApiClient
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.emoji.is_a?(String) != false || raise("Passed value for field obj.emoji is not the expected type, validation failed.")
       obj.status.is_a?(TrophyApiClient::MetricStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
       obj.current.is_a?(Float) != false || raise("Passed value for field obj.current 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.")

data/lib/trophy_api_client/types/streak_achievement_response.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class StreakAchievementResponse
+    # @return [String] The trigger of the achievement, in this case always 'streak'.
+    attr_reader :trigger
+    # @return [Integer] The length of the streak required to complete the achievement.
+    attr_reader :streak_length
+    # @return [String] The unique ID of the achievement.
+    attr_reader :id
+    # @return [String] The name of this achievement.
+    attr_reader :name
+    # @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.
+    attr_reader :key
+    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    attr_reader :achieved_at
+    # @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 trigger [String] The trigger of the achievement, in this case always 'streak'.
+    # @param streak_length [Integer] The length of the streak required to complete the achievement.
+    # @param id [String] The unique ID of the achievement.
+    # @param name [String] The name 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.
+    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::StreakAchievementResponse]
+    def initialize(trigger:, streak_length:, id:, name:, badge_url: OMIT, key: OMIT, achieved_at: OMIT,
+                   additional_properties: nil)
+      @trigger = trigger
+      @streak_length = streak_length
+      @id = id
+      @name = name
+      @badge_url = badge_url if badge_url != OMIT
+      @key = key if key != OMIT
+      @achieved_at = achieved_at if achieved_at != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "trigger": trigger,
+        "streakLength": streak_length,
+        "id": id,
+        "name": name,
+        "badgeUrl": badge_url,
+        "key": key,
+        "achievedAt": achieved_at
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of StreakAchievementResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::StreakAchievementResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      trigger = parsed_json["trigger"]
+      streak_length = parsed_json["streakLength"]
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      badge_url = parsed_json["badgeUrl"]
+      key = parsed_json["key"]
+      achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
+      new(
+        trigger: trigger,
+        streak_length: streak_length,
+        id: id,
+        name: name,
+        badge_url: badge_url,
+        key: key,
+        achieved_at: achieved_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StreakAchievementResponse 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.trigger.is_a?(String) != false || raise("Passed value for field obj.trigger 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.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.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.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/users/client.rb

@@ -6,7 +6,7 @@ require_relative "../types/user"
 require_relative "../types/updated_user"
 require_relative "../types/metric_response"
 require "json"
-require_relative "../types/multi_stage_achievement_response"
+require_relative "../types/achievement_response"
 require_relative "../types/streak_response"
 require "async"
 
@@ -196,7 +196,7 @@ module TrophyApiClient
     #
     # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>]
+    # @return [Array<TrophyApiClient::AchievementResponse>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -224,7 +224,7 @@ module TrophyApiClient
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
         item = item.to_json
-        TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
+        TrophyApiClient::AchievementResponse.from_json(json_object: item)
       end
     end
 
@@ -459,7 +459,7 @@ module TrophyApiClient
     #
     # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>]
+    # @return [Array<TrophyApiClient::AchievementResponse>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -488,7 +488,7 @@ module TrophyApiClient
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|
           item = item.to_json
-          TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
+          TrophyApiClient::AchievementResponse.from_json(json_object: item)
         end
       end
     end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/lib/types_export.rb

@@ -6,13 +6,17 @@ require_relative "trophy_api_client/types/base_streak_response"
 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/multi_stage_achievement_response"
-require_relative "trophy_api_client/types/one_off_achievement_response"
+require_relative "trophy_api_client/types/base_achievement_response"
+require_relative "trophy_api_client/types/metric_achievement_response"
+require_relative "trophy_api_client/types/api_achievement_response"
+require_relative "trophy_api_client/types/streak_achievement_response"
+require_relative "trophy_api_client/types/achievement_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"
 require_relative "trophy_api_client/types/user"
 require_relative "trophy_api_client/types/error_body"
 require_relative "trophy_api_client/types/achievement_completion_response"
+require_relative "trophy_api_client/types/event_response_metrics_item_completed_item"
 require_relative "trophy_api_client/types/event_response_metrics_item"
 require_relative "trophy_api_client/types/event_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -102,15 +102,19 @@ files:
 - lib/trophy_api_client/achievements/client.rb
 - 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/api_achievement_response.rb
+- lib/trophy_api_client/types/base_achievement_response.rb
 - lib/trophy_api_client/types/base_streak_response.rb
 - lib/trophy_api_client/types/error_body.rb
 - lib/trophy_api_client/types/event_response.rb
 - lib/trophy_api_client/types/event_response_metrics_item.rb
+- lib/trophy_api_client/types/event_response_metrics_item_completed_item.rb
 - lib/trophy_api_client/types/increment_metric_streak_response.rb
+- lib/trophy_api_client/types/metric_achievement_response.rb
 - lib/trophy_api_client/types/metric_response.rb
 - lib/trophy_api_client/types/metric_status.rb
-- lib/trophy_api_client/types/multi_stage_achievement_response.rb
-- lib/trophy_api_client/types/one_off_achievement_response.rb
+- lib/trophy_api_client/types/streak_achievement_response.rb
 - lib/trophy_api_client/types/streak_frequency.rb
 - lib/trophy_api_client/types/streak_response.rb
 - lib/trophy_api_client/types/streak_response_streak_history_item.rb