trophy_api_client 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a67cfb83b6601c4c488aa3ff95b578d33681982787c38e6448370eabaac987e
-  data.tar.gz: 9bde2c23199a0523fe99c350f155f9f6e79ac9a546663320ab2a2d1c6d62b995
+  metadata.gz: 3f97c407f35241fca730a7bf516b0e1e3d15d910710cd29dc75893d2d7f263ba
+  data.tar.gz: 5479b66a74a2904ceadcf8607833433a0a370dd85ef18c37227e949044d6074f
 SHA512:
-  metadata.gz: 55cddb862ad713aba47db324c6f71f6b8c0f90a00ba2715f8917aafdef44ee43a0194a799c76717de6c24df518b532fb9c9fb40014ad26d6e430247feb65f02f
-  data.tar.gz: bd5e48a39c140ee9a0ea3dd9c7a9eaebc937a226002776dbe1834290d13389fd42c8140a5fe3eb3a4f8b8d595197b447029ce8dd919711f42d07626778dd3c1b
+  metadata.gz: bf4906e28af4867b0eb7ae5582bb8060618a3effcb479d6fff0865d18bd61e3478a6492b6afcf66c06a0bba7cbf55f060909c1a33c6b261d338440c32a3a2990
+  data.tar.gz: df54eaff66af36b4227ff5d8113a444fcac229afb65be84e8848d3defa00a7725d8e68362507dc821c1ac743130916cfedd8cda212865cf1d73da26bb71d63d6

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
     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/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/metric_response.rb

@@ -2,7 +2,7 @@
 
 require_relative "streak_frequency"
 require_relative "metric_status"
-require_relative "achievement_response"
+require_relative "multi_stage_achievement_response"
 require_relative "streak_response"
 require "ostruct"
 require "json"
@@ -23,7 +23,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::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
@@ -42,7 +42,7 @@ module TrophyApiClient
     # @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 achievements [Array<TrophyApiClient::MultiStageAchievementResponse>] 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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricResponse]
@@ -89,7 +89,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::MultiStageAchievementResponse.from_json(json_object: item)
       end
       if parsed_json["currentStreak"].nil?
         current_streak = nil

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/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/achievement_response"
+require_relative "../types/multi_stage_achievement_response"
 require "async"
 
 module TrophyApiClient
@@ -20,7 +20,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 +195,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,7 +223,7 @@ module TrophyApiClient
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
         item = item.to_json
-        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+        TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
       end
     end
   end
@@ -238,7 +238,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 +423,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,7 +452,7 @@ module TrophyApiClient
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|
           item = item.to_json
-          TrophyApiClient::AchievementResponse.from_json(json_object: item)
+          TrophyApiClient::MultiStageAchievementResponse.from_json(json_object: item)
         end
       end
     end

data/lib/trophy_api_client/version.rb

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

data/lib/types_export.rb

@@ -3,7 +3,8 @@
 require_relative "trophy_api_client/types/metric_status"
 require_relative "trophy_api_client/types/streak_frequency"
 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.3
 platform: ruby
 authors:
 - Trophy Labs, Inc
 bindir: exe
 cert_chain: []
-date: 2025-03-30 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -102,12 +102,13 @@ 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/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/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/updated_user.rb