trophy_api_client 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a67cfb83b6601c4c488aa3ff95b578d33681982787c38e6448370eabaac987e
-  data.tar.gz: 9bde2c23199a0523fe99c350f155f9f6e79ac9a546663320ab2a2d1c6d62b995
+  metadata.gz: b24d28841d30125051d3eb1effdadbbac7ba3b1fb1c912bc37f3975d72c7dac0
+  data.tar.gz: e6dfbc42d4a6df6edbc44b0305139c25cc9f1d66368c5a59aac1ee93a2c8c54d
 SHA512:
-  metadata.gz: 55cddb862ad713aba47db324c6f71f6b8c0f90a00ba2715f8917aafdef44ee43a0194a799c76717de6c24df518b532fb9c9fb40014ad26d6e430247feb65f02f
-  data.tar.gz: bd5e48a39c140ee9a0ea3dd9c7a9eaebc937a226002776dbe1834290d13389fd42c8140a5fe3eb3a4f8b8d595197b447029ce8dd919711f42d07626778dd3c1b
+  metadata.gz: ffef758de2594e6462fa5cbb5af4db9c091d7474e983d780b65edc62f36bc3415849581b4c0274b819250906caabdae1fae8c5f0553c516e03cbb698dca2def3
+  data.tar.gz: 9ecb5035b6d3370d34ca537ec41f60a53bf83e3f2e5dae911bb8d3b8c56f2601008b2e68adc9cbaa632418171144658f944d49c23629961984e8875f7b1755b8

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/types/base_streak_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "streak_frequency"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class BaseStreakResponse
+    # @return [Integer] The length of the user's current streak.
+    attr_reader :length
+    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    attr_reader :frequency
+    # @return [String] The date the streak started.
+    attr_reader :started
+    # @return [String] The start date of the current streak period.
+    attr_reader :period_start
+    # @return [String] The end date of the current streak period.
+    attr_reader :period_end
+    # @return [String] The date the streak will expire if the user does not increment a metric.
+    attr_reader :expires
+    # @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 length [Integer] The length of the user's current streak.
+    # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    # @param started [String] The date the streak started.
+    # @param period_start [String] The start date of the current streak period.
+    # @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::BaseStreakResponse]
+    def initialize(length:, frequency:, started: OMIT, period_start: OMIT, period_end: OMIT, expires: OMIT,
+                   additional_properties: nil)
+      @length = length
+      @frequency = frequency
+      @started = started if started != OMIT
+      @period_start = period_start if period_start != OMIT
+      @period_end = period_end if period_end != OMIT
+      @expires = expires if expires != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "length": length,
+        "frequency": frequency,
+        "started": started,
+        "periodStart": period_start,
+        "periodEnd": period_end,
+        "expires": expires
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of BaseStreakResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::BaseStreakResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      length = parsed_json["length"]
+      frequency = parsed_json["frequency"]
+      started = parsed_json["started"]
+      period_start = parsed_json["periodStart"]
+      period_end = parsed_json["periodEnd"]
+      expires = parsed_json["expires"]
+      new(
+        length: length,
+        frequency: frequency,
+        started: started,
+        period_start: period_start,
+        period_end: period_end,
+        expires: expires,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of BaseStreakResponse 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.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
+      obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
+      obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")
+      obj.period_start&.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
+      obj.period_end&.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
+      obj.expires&.is_a?(String) != false || raise("Passed value for field obj.expires is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/event_response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "event_response_metrics_item"
-require_relative "streak_response"
+require_relative "increment_metric_streak_response"
 require "ostruct"
 require "json"
 
@@ -15,7 +15,7 @@ module TrophyApiClient
     attr_reader :total
     # @return [Array<TrophyApiClient::EventResponseMetricsItem>] Changes to achievements as a result of this event.
     attr_reader :achievements
-    # @return [TrophyApiClient::StreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @return [TrophyApiClient::IncrementMetricStreakResponse] 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
@@ -29,7 +29,7 @@ module TrophyApiClient
     # @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::EventResponseMetricsItem>] Changes to achievements as a result of this event.
-    # @param current_streak [TrophyApiClient::StreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @param current_streak [TrophyApiClient::IncrementMetricStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::EventResponse]
     def initialize(event_id:, metric_id:, total:, achievements: OMIT, current_streak: OMIT, additional_properties: nil)
@@ -68,7 +68,7 @@ module TrophyApiClient
         current_streak = nil
       else
         current_streak = parsed_json["currentStreak"].to_json
-        current_streak = TrophyApiClient::StreakResponse.from_json(json_object: current_streak)
+        current_streak = TrophyApiClient::IncrementMetricStreakResponse.from_json(json_object: current_streak)
       end
       new(
         event_id: event_id,
@@ -98,7 +98,7 @@ 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::StreakResponse.validate_raw(obj: obj.current_streak)
+      obj.current_streak.nil? || TrophyApiClient::IncrementMetricStreakResponse.validate_raw(obj: obj.current_streak)
     end
   end
 end

data/lib/trophy_api_client/types/event_response_metrics_item.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "achievement_response"
+require_relative "multi_stage_achievement_response"
 require "ostruct"
 require "json"
 
@@ -8,7 +8,7 @@ module TrophyApiClient
   class EventResponseMetricsItem
     # @return [String] The ID of the metric.
     attr_reader :metric_id
-    # @return [Array<TrophyApiClient::AchievementResponse>] A list of any new achievements that the user has now completed as a result of
+    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>] 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
@@ -20,7 +20,7 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param metric_id [String] The ID of the metric.
-    # @param completed [Array<TrophyApiClient::AchievementResponse>] A list of any new achievements that the user has now completed as a result of
+    # @param completed [Array<TrophyApiClient::MultiStageAchievementResponse>] 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]
@@ -43,7 +43,7 @@ module TrophyApiClient
       metric_id = parsed_json["metricId"]
       completed = parsed_json["completed"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+        TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
       end
       new(
         metric_id: metric_id,

data/lib/trophy_api_client/types/increment_metric_streak_response.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative "streak_frequency"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An object representing the user's streak after incrementing a metric.
+  class IncrementMetricStreakResponse
+    # @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.
+    attr_reader :length
+    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    attr_reader :frequency
+    # @return [String] The date the streak started.
+    attr_reader :started
+    # @return [String] The start date of the current streak period.
+    attr_reader :period_start
+    # @return [String] The end date of the current streak period.
+    attr_reader :period_end
+    # @return [String] The date the streak will expire if the user does not increment a metric.
+    attr_reader :expires
+    # @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 extended [Boolean] Whether this metric event increased the user's streak length.
+    # @param length [Integer] The length of the user's current streak.
+    # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    # @param started [String] The date the streak started.
+    # @param period_start [String] The start date of the current streak period.
+    # @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]
+    def initialize(length:, frequency:, extended: OMIT, started: OMIT, period_start: OMIT, period_end: OMIT,
+                   expires: OMIT, additional_properties: nil)
+      @extended = extended if extended != OMIT
+      @length = length
+      @frequency = frequency
+      @started = started if started != OMIT
+      @period_start = period_start if period_start != OMIT
+      @period_end = period_end if period_end != OMIT
+      @expires = expires if expires != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "extended": extended,
+        "length": length,
+        "frequency": frequency,
+        "started": started,
+        "periodStart": period_start,
+        "periodEnd": period_end,
+        "expires": expires
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of IncrementMetricStreakResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::IncrementMetricStreakResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      extended = parsed_json["extended"]
+      length = parsed_json["length"]
+      frequency = parsed_json["frequency"]
+      started = parsed_json["started"]
+      period_start = parsed_json["periodStart"]
+      period_end = parsed_json["periodEnd"]
+      expires = parsed_json["expires"]
+      new(
+        extended: extended,
+        length: length,
+        frequency: frequency,
+        started: started,
+        period_start: period_start,
+        period_end: period_end,
+        expires: expires,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of IncrementMetricStreakResponse 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.extended&.is_a?(Boolean) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
+      obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
+      obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
+      obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")
+      obj.period_start&.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
+      obj.period_end&.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
+      obj.expires&.is_a?(String) != false || raise("Passed value for field obj.expires is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/metric_response.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "streak_frequency"
 require_relative "metric_status"
-require_relative "achievement_response"
-require_relative "streak_response"
+require_relative "multi_stage_achievement_response"
 require "ostruct"
 require "json"
 
@@ -17,16 +15,12 @@ module TrophyApiClient
     attr_reader :name
     # @return [String] The emoji to represent the metric.
     attr_reader :emoji
-    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
-    attr_reader :streak_frequency
     # @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::AchievementResponse>] A list of the metric's achievements and the user's progress towards each.
+    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>] A list of the metric's achievements and the user's progress towards each.
     attr_reader :achievements
-    # @return [TrophyApiClient::StreakResponse] 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]
@@ -39,38 +33,29 @@ module TrophyApiClient
     # @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 streak_frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
     # @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 current_streak [TrophyApiClient::StreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @param achievements [Array<TrophyApiClient::MultiStageAchievementResponse>] 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:, streak_frequency:, status:, current:, achievements:, current_streak: OMIT,
-                   additional_properties: nil)
+    def initialize(id:, key:, name:, emoji:, status:, current:, achievements:, additional_properties: nil)
       @id = id
       @key = key
       @name = name
       @emoji = emoji
-      @streak_frequency = streak_frequency
       @status = status
       @current = current
       @achievements = achievements
-      @current_streak = current_streak if current_streak != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
         "key": key,
         "name": name,
         "emoji": emoji,
-        "streakFrequency": streak_frequency,
         "status": status,
         "current": current,
-        "achievements": achievements,
-        "currentStreak": current_streak
-      }.reject do |_k, v|
-        v == OMIT
-      end
+        "achievements": achievements
+      }
     end
 
     # Deserialize a JSON object to an instance of MetricResponse
@@ -84,29 +69,20 @@ module TrophyApiClient
       key = parsed_json["key"]
       name = parsed_json["name"]
       emoji = parsed_json["emoji"]
-      streak_frequency = parsed_json["streakFrequency"]
       status = parsed_json["status"]
       current = parsed_json["current"]
       achievements = parsed_json["achievements"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::AchievementResponse.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::StreakResponse.from_json(json_object: current_streak)
+        TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
       end
       new(
         id: id,
         key: key,
         name: name,
         emoji: emoji,
-        streak_frequency: streak_frequency,
         status: status,
         current: current,
         achievements: achievements,
-        current_streak: current_streak,
         additional_properties: struct
       )
     end
@@ -129,11 +105,9 @@ module TrophyApiClient
       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.streak_frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.streak_frequency 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.")
-      obj.current_streak.nil? || TrophyApiClient::StreakResponse.validate_raw(obj: obj.current_streak)
     end
   end
 end

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

@@ -5,7 +5,7 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
-  class AchievementResponse
+  class MultiStageAchievementResponse
     # @return [String] The unique ID of the achievement.
     attr_reader :id
     # @return [String] The name of this achievement.
@@ -41,7 +41,7 @@ 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::AchievementResponse]
+    # @return [TrophyApiClient::MultiStageAchievementResponse]
     def initialize(id:, name: OMIT, badge_url: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, key: OMIT,
                    achieved_at: OMIT, additional_properties: nil)
       @id = id
@@ -67,10 +67,10 @@ module TrophyApiClient
       end
     end
 
-    # Deserialize a JSON object to an instance of AchievementResponse
+    # Deserialize a JSON object to an instance of MultiStageAchievementResponse
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::AchievementResponse]
+    # @return [TrophyApiClient::MultiStageAchievementResponse]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -95,7 +95,7 @@ module TrophyApiClient
       )
     end
 
-    # Serialize an instance of AchievementResponse to a JSON object
+    # Serialize an instance of MultiStageAchievementResponse to a JSON object
     #
     # @return [String]
     def to_json(*_args)

data/lib/trophy_api_client/types/one_off_achievement_response.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class OneOffAchievementResponse
+    # @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 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::OneOffAchievementResponse]
+    def initialize(id:, name: OMIT, badge_url: OMIT, key: OMIT, achieved_at: OMIT, additional_properties: nil)
+      @id = id
+      @name = name if name != OMIT
+      @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 = {
+        "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 OneOffAchievementResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::OneOffAchievementResponse]
+    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"]
+      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,
+        key: key,
+        achieved_at: achieved_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of OneOffAchievementResponse 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.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/streak_response.rb

@@ -1,15 +1,28 @@
 # frozen_string_literal: true
 
+require_relative "streak_response_streak_history_item"
 require_relative "streak_frequency"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
+  # An object representing the user's streak.
   class StreakResponse
+    # @return [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
+    #  period includes the start and end dates and the length of the streak.
+    attr_reader :streak_history
     # @return [Integer] The length of the user's current streak.
     attr_reader :length
     # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
     attr_reader :frequency
+    # @return [String] The date the streak started.
+    attr_reader :started
+    # @return [String] The start date of the current streak period.
+    attr_reader :period_start
+    # @return [String] The end date of the current streak period.
+    attr_reader :period_end
+    # @return [String] The date the streak will expire if the user does not increment a metric.
+    attr_reader :expires
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -18,15 +31,37 @@ module TrophyApiClient
 
     OMIT = Object.new
 
+    # @param streak_history [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
+    #  period includes the start and end dates and the length of the streak.
     # @param length [Integer] The length of the user's current streak.
     # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    # @param started [String] The date the streak started.
+    # @param period_start [String] The start date of the current streak period.
+    # @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::StreakResponse]
-    def initialize(length:, frequency:, additional_properties: nil)
+    def initialize(length:, frequency:, streak_history: OMIT, started: OMIT, period_start: OMIT, period_end: OMIT,
+                   expires: OMIT, additional_properties: nil)
+      @streak_history = streak_history if streak_history != OMIT
       @length = length
       @frequency = frequency
+      @started = started if started != OMIT
+      @period_start = period_start if period_start != OMIT
+      @period_end = period_end if period_end != OMIT
+      @expires = expires if expires != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "length": length, "frequency": frequency }
+      @_field_set = {
+        "streakHistory": streak_history,
+        "length": length,
+        "frequency": frequency,
+        "started": started,
+        "periodStart": period_start,
+        "periodEnd": period_end,
+        "expires": expires
+      }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of StreakResponse
@@ -36,11 +71,24 @@ module TrophyApiClient
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      streak_history = parsed_json["streakHistory"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::StreakResponseStreakHistoryItem.from_json(json_object: item)
+      end
       length = parsed_json["length"]
       frequency = parsed_json["frequency"]
+      started = parsed_json["started"]
+      period_start = parsed_json["periodStart"]
+      period_end = parsed_json["periodEnd"]
+      expires = parsed_json["expires"]
       new(
+        streak_history: streak_history,
         length: length,
         frequency: frequency,
+        started: started,
+        period_start: period_start,
+        period_end: period_end,
+        expires: expires,
         additional_properties: struct
       )
     end
@@ -59,8 +107,13 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.streak_history&.is_a?(Array) != false || raise("Passed value for field obj.streak_history is not the expected type, validation failed.")
       obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
       obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
+      obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")
+      obj.period_start&.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
+      obj.period_end&.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
+      obj.expires&.is_a?(String) != false || raise("Passed value for field obj.expires is not the expected type, validation failed.")
     end
   end
 end

data/lib/trophy_api_client/types/streak_response_streak_history_item.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An object representing a past streak period.
+  class StreakResponseStreakHistoryItem
+    # @return [String] The date this streak period started.
+    attr_reader :period_start
+    # @return [String] The date this streak period ended.
+    attr_reader :period_end
+    # @return [Integer] The length of the user's streak during this period.
+    attr_reader :length
+    # @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 period_start [String] The date this streak period started.
+    # @param period_end [String] The date this streak period ended.
+    # @param length [Integer] The length of the user's streak during this period.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::StreakResponseStreakHistoryItem]
+    def initialize(period_start:, period_end:, length:, additional_properties: nil)
+      @period_start = period_start
+      @period_end = period_end
+      @length = length
+      @additional_properties = additional_properties
+      @_field_set = { "periodStart": period_start, "periodEnd": period_end, "length": length }
+    end
+
+    # Deserialize a JSON object to an instance of StreakResponseStreakHistoryItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::StreakResponseStreakHistoryItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      period_start = parsed_json["periodStart"]
+      period_end = parsed_json["periodEnd"]
+      length = parsed_json["length"]
+      new(
+        period_start: period_start,
+        period_end: period_end,
+        length: length,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StreakResponseStreakHistoryItem 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.period_start.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
+      obj.period_end.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
+      obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/users/client.rb

@@ -6,7 +6,8 @@ require_relative "../types/user"
 require_relative "../types/updated_user"
 require_relative "../types/metric_response"
 require "json"
-require_relative "../types/achievement_response"
+require_relative "../types/multi_stage_achievement_response"
+require_relative "../types/streak_response"
 require "async"
 
 module TrophyApiClient
@@ -20,7 +21,7 @@ module TrophyApiClient
       @request_client = request_client
     end
 
-    # Create a new user.
+    # Identify a new user.
     #
     # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
@@ -195,7 +196,7 @@ module TrophyApiClient
     #
     # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::AchievementResponse>]
+    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -223,9 +224,44 @@ module TrophyApiClient
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
         item = item.to_json
-        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+        TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
       end
     end
+
+    # Get a user's streak data.
+    #
+    # @param id [String] ID of the user.
+    # @param history_periods [Integer] The number of past streak periods to include in the streakHistory field of the
+    #  response.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::StreakResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.streak(id: "userId")
+    def streak(id:, history_periods: 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?
+        req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "historyPeriods": history_periods
+        }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/streak"
+      end
+      TrophyApiClient::StreakResponse.from_json(json_object: response.body)
+    end
   end
 
   class AsyncUsersClient
@@ -238,7 +274,7 @@ module TrophyApiClient
       @request_client = request_client
     end
 
-    # Create a new user.
+    # Identify a new user.
     #
     # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
@@ -423,7 +459,7 @@ module TrophyApiClient
     #
     # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::AchievementResponse>]
+    # @return [Array<TrophyApiClient::MultiStageAchievementResponse>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -452,8 +488,45 @@ module TrophyApiClient
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|
           item = item.to_json
-          TrophyApiClient::AchievementResponse.from_json(json_object: item)
+          TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get a user's streak data.
+    #
+    # @param id [String] ID of the user.
+    # @param history_periods [Integer] The number of past streak periods to include in the streakHistory field of the
+    #  response.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::StreakResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.streak(id: "userId")
+    def streak(id:, history_periods: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "historyPeriods": history_periods
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/streak"
         end
+        TrophyApiClient::StreakResponse.from_json(json_object: response.body)
       end
     end
   end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/types_export.rb

@@ -2,8 +2,12 @@
 
 require_relative "trophy_api_client/types/metric_status"
 require_relative "trophy_api_client/types/streak_frequency"
+require_relative "trophy_api_client/types/base_streak_response"
+require_relative "trophy_api_client/types/increment_metric_streak_response"
+require_relative "trophy_api_client/types/streak_response_streak_history_item"
 require_relative "trophy_api_client/types/streak_response"
-require_relative "trophy_api_client/types/achievement_response"
+require_relative "trophy_api_client/types/multi_stage_achievement_response"
+require_relative "trophy_api_client/types/one_off_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"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Trophy Labs, Inc
 bindir: exe
 cert_chain: []
-date: 2025-03-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -102,14 +102,18 @@ 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/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/increment_metric_streak_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_frequency.rb
 - lib/trophy_api_client/types/streak_response.rb
+- lib/trophy_api_client/types/streak_response_streak_history_item.rb
 - lib/trophy_api_client/types/updated_user.rb
 - lib/trophy_api_client/types/upserted_user.rb
 - lib/trophy_api_client/types/user.rb
@@ -136,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Ruby library for the Trophy API.
 test_files: []