trophy_api_client 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dead4fcd46492c734d3a068b426764bf73d30241f2540944dacebca2cbeced8
-  data.tar.gz: 0ab5f44fbe7a08bb62667c97a0f8c9487c522fcf4f03b2b4e95ee88e96d85e91
+  metadata.gz: 3a67cfb83b6601c4c488aa3ff95b578d33681982787c38e6448370eabaac987e
+  data.tar.gz: 9bde2c23199a0523fe99c350f155f9f6e79ac9a546663320ab2a2d1c6d62b995
 SHA512:
-  metadata.gz: d910fb09cd06f5f2cf6e206e3e28bb3c51fad500c5324f906131e1eb12fc46051eff7efeccb83ea5a15192ecaf0110aaf6d7b2eb4a88a6c95066e4975d76cdb1
-  data.tar.gz: bfbe3b66eeb09df596c08714495648dfcdb031c3386e0bb944f264bfd603c45887124f04e564da5b48b02f925f09c30efac9edaa54c70f2a92ccbe34a4dc840f
+  metadata.gz: 55cddb862ad713aba47db324c6f71f6b8c0f90a00ba2715f8917aafdef44ee43a0194a799c76717de6c24df518b532fb9c9fb40014ad26d6e430247feb65f02f
+  data.tar.gz: bd5e48a39c140ee9a0ea3dd9c7a9eaebc937a226002776dbe1834290d13389fd42c8140a5fe3eb3a4f8b8d595197b447029ce8dd919711f42d07626778dd3c1b

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/achievements/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "../types/event_request_user"
+require_relative "../types/upserted_user"
 require_relative "../types/achievement_completion_response"
 require "async"
 
@@ -19,11 +19,12 @@ module TrophyApiClient
     # Mark an achievement as completed for a user.
     #
     # @param key [String] Unique reference of the achievement as set when created.
-    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
     #   * :email (String)
     #   * :name (String)
     #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::AchievementCompletionResponse]
     # @example
@@ -32,7 +33,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { id: "user-id" })
     def complete(key:, user:, request_options: nil)
       response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -65,11 +66,12 @@ module TrophyApiClient
     # Mark an achievement as completed for a user.
     #
     # @param key [String] Unique reference of the achievement as set when created.
-    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
     #   * :email (String)
     #   * :name (String)
     #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::AchievementCompletionResponse]
     # @example
@@ -78,7 +80,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { id: "user-id" })
     def complete(key:, user:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|

data/lib/trophy_api_client/metrics/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "../types/event_request_user"
+require_relative "../types/upserted_user"
 require_relative "../types/event_response"
 require "async"
 
@@ -19,11 +19,12 @@ module TrophyApiClient
     # Increment or decrement the value of a metric for a user.
     #
     # @param key [String] Unique reference of the metric as set when created.
-    # @param user [Hash] The user that triggered the event.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    # @param user [Hash] The user that triggered the event.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
     #   * :email (String)
     #   * :name (String)
     #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
     # @param value [Float] The value to add to the user's current total for the given metric.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::EventResponse]
@@ -35,7 +36,7 @@ module TrophyApiClient
     #  )
     #  api.metrics.event(
     #    key: "words-written",
-    #    user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" },
+    #    user: { email: "user@example.com", tz: "Europe/London", id: "18" },
     #    value: 750
     #  )
     def event(key:, user:, value:, request_options: nil)
@@ -70,11 +71,12 @@ module TrophyApiClient
     # Increment or decrement the value of a metric for a user.
     #
     # @param key [String] Unique reference of the metric as set when created.
-    # @param user [Hash] The user that triggered the event.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    # @param user [Hash] The user that triggered the event.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
     #   * :email (String)
     #   * :name (String)
     #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
     # @param value [Float] The value to add to the user's current total for the given metric.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::EventResponse]
@@ -86,7 +88,7 @@ module TrophyApiClient
     #  )
     #  api.metrics.event(
     #    key: "words-written",
-    #    user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" },
+    #    user: { email: "user@example.com", tz: "Europe/London", id: "18" },
     #    value: 750
     #  )
     def event(key:, user:, value:, request_options: nil)

data/lib/trophy_api_client/types/event_response.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "event_response_metrics_item"
+require_relative "streak_response"
 require "ostruct"
 require "json"
 
@@ -14,6 +15,8 @@ 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.
+    attr_reader :current_streak
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -26,19 +29,22 @@ 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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::EventResponse]
-    def initialize(event_id:, metric_id:, total:, achievements: OMIT, additional_properties: nil)
+    def initialize(event_id:, metric_id:, total:, achievements: OMIT, current_streak: OMIT, additional_properties: nil)
       @event_id = event_id
       @metric_id = metric_id
       @total = total
       @achievements = achievements if achievements != OMIT
+      @current_streak = current_streak if current_streak != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "eventId": event_id,
         "metricId": metric_id,
         "total": total,
-        "achievements": achievements
+        "achievements": achievements,
+        "currentStreak": current_streak
       }.reject do |_k, v|
         v == OMIT
       end
@@ -58,11 +64,18 @@ module TrophyApiClient
         item = item.to_json
         TrophyApiClient::EventResponseMetricsItem.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)
+      end
       new(
         event_id: event_id,
         metric_id: metric_id,
         total: total,
         achievements: achievements,
+        current_streak: current_streak,
         additional_properties: struct
       )
     end
@@ -85,6 +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)
     end
   end
 end

data/lib/trophy_api_client/types/metric_response.rb

@@ -26,7 +26,7 @@ module TrophyApiClient
     # @return [Array<TrophyApiClient::AchievementResponse>] 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 :streak
+    attr_reader :current_streak
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -43,10 +43,10 @@ module TrophyApiClient
     # @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 streak [TrophyApiClient::StreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @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]
-    def initialize(id:, key:, name:, emoji:, streak_frequency:, status:, current:, achievements:, streak: OMIT,
+    def initialize(id:, key:, name:, emoji:, streak_frequency:, status:, current:, achievements:, current_streak: OMIT,
                    additional_properties: nil)
       @id = id
       @key = key
@@ -56,7 +56,7 @@ module TrophyApiClient
       @status = status
       @current = current
       @achievements = achievements
-      @streak = streak if streak != OMIT
+      @current_streak = current_streak if current_streak != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
@@ -67,7 +67,7 @@ module TrophyApiClient
         "status": status,
         "current": current,
         "achievements": achievements,
-        "streak": streak
+        "currentStreak": current_streak
       }.reject do |_k, v|
         v == OMIT
       end
@@ -91,11 +91,11 @@ module TrophyApiClient
         item = item.to_json
         TrophyApiClient::AchievementResponse.from_json(json_object: item)
       end
-      if parsed_json["streak"].nil?
-        streak = nil
+      if parsed_json["currentStreak"].nil?
+        current_streak = nil
       else
-        streak = parsed_json["streak"].to_json
-        streak = TrophyApiClient::StreakResponse.from_json(json_object: streak)
+        current_streak = parsed_json["currentStreak"].to_json
+        current_streak = TrophyApiClient::StreakResponse.from_json(json_object: current_streak)
       end
       new(
         id: id,
@@ -106,7 +106,7 @@ module TrophyApiClient
         status: status,
         current: current,
         achievements: achievements,
-        streak: streak,
+        current_streak: current_streak,
         additional_properties: struct
       )
     end
@@ -133,7 +133,7 @@ module TrophyApiClient
       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.streak.nil? || TrophyApiClient::StreakResponse.validate_raw(obj: obj.streak)
+      obj.current_streak.nil? || TrophyApiClient::StreakResponse.validate_raw(obj: obj.current_streak)
     end
   end
 end

data/lib/trophy_api_client/types/updated_user.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An object with editable user fields.
+  class UpdatedUser
+    # @return [String] The user's email address. Required if subscribeToEmails is true.
+    attr_reader :email
+    # @return [String] The name to refer to the user by in emails.
+    attr_reader :name
+    # @return [String] The user's timezone (used for email scheduling).
+    attr_reader :tz
+    # @return [Boolean] Whether the user should receive Trophy-powered emails. Cannot be false if an
+    #  email is provided.
+    attr_reader :subscribe_to_emails
+    # @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 email [String] The user's email address. Required if subscribeToEmails is true.
+    # @param name [String] The name to refer to the user by in emails.
+    # @param tz [String] The user's timezone (used for email scheduling).
+    # @param subscribe_to_emails [Boolean] Whether the user should receive Trophy-powered emails. Cannot be false if an
+    #  email is provided.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UpdatedUser]
+    def initialize(email: OMIT, name: OMIT, tz: OMIT, subscribe_to_emails: OMIT, additional_properties: nil)
+      @email = email if email != OMIT
+      @name = name if name != OMIT
+      @tz = tz if tz != OMIT
+      @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "email": email,
+        "name": name,
+        "tz": tz,
+        "subscribeToEmails": subscribe_to_emails
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdatedUser
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UpdatedUser]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      email = parsed_json["email"]
+      name = parsed_json["name"]
+      tz = parsed_json["tz"]
+      subscribe_to_emails = parsed_json["subscribeToEmails"]
+      new(
+        email: email,
+        name: name,
+        tz: tz,
+        subscribe_to_emails: subscribe_to_emails,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdatedUser 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.email&.is_a?(String) != false || raise("Passed value for field obj.email 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.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
+      obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/{event_request_user.rb → upserted_user.rb}

@@ -4,16 +4,19 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
-  # The user that triggered the event.
-  class EventRequestUser
+  # An object with editable user fields.
+  class UpsertedUser
     # @return [String] The ID of the user in your database. Must be a string.
     attr_reader :id
-    # @return [String] The user's email address.
+    # @return [String] The user's email address. Required if subscribeToEmails is true.
     attr_reader :email
     # @return [String] The name to refer to the user by in emails.
     attr_reader :name
     # @return [String] The user's timezone (used for email scheduling).
     attr_reader :tz
+    # @return [Boolean] Whether the user should receive Trophy-powered emails. Cannot be false if an
+    #  email is provided.
+    attr_reader :subscribe_to_emails
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -23,26 +26,35 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param id [String] The ID of the user in your database. Must be a string.
-    # @param email [String] The user's email address.
+    # @param email [String] The user's email address. Required if subscribeToEmails is true.
     # @param name [String] The name to refer to the user by in emails.
     # @param tz [String] The user's timezone (used for email scheduling).
+    # @param subscribe_to_emails [Boolean] Whether the user should receive Trophy-powered emails. Cannot be false if an
+    #  email is provided.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::EventRequestUser]
-    def initialize(id:, email: OMIT, name: OMIT, tz: OMIT, additional_properties: nil)
+    # @return [TrophyApiClient::UpsertedUser]
+    def initialize(id:, email: OMIT, name: OMIT, tz: OMIT, subscribe_to_emails: OMIT, additional_properties: nil)
       @id = id
       @email = email if email != OMIT
       @name = name if name != OMIT
       @tz = tz if tz != OMIT
+      @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "id": id, "email": email, "name": name, "tz": tz }.reject do |_k, v|
+      @_field_set = {
+        "id": id,
+        "email": email,
+        "name": name,
+        "tz": tz,
+        "subscribeToEmails": subscribe_to_emails
+      }.reject do |_k, v|
         v == OMIT
       end
     end
 
-    # Deserialize a JSON object to an instance of EventRequestUser
+    # Deserialize a JSON object to an instance of UpsertedUser
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::EventRequestUser]
+    # @return [TrophyApiClient::UpsertedUser]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -50,16 +62,18 @@ module TrophyApiClient
       email = parsed_json["email"]
       name = parsed_json["name"]
       tz = parsed_json["tz"]
+      subscribe_to_emails = parsed_json["subscribeToEmails"]
       new(
         id: id,
         email: email,
         name: name,
         tz: tz,
+        subscribe_to_emails: subscribe_to_emails,
         additional_properties: struct
       )
     end
 
-    # Serialize an instance of EventRequestUser to a JSON object
+    # Serialize an instance of UpsertedUser to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -77,6 +91,7 @@ module TrophyApiClient
       obj.email&.is_a?(String) != false || raise("Passed value for field obj.email 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.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
+      obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
     end
   end
 end

data/lib/trophy_api_client/types/user.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user of your application.
+  class User
+    # @return [Boolean] Whether the user is in the control group, meaning they do not receive emails or
+    #  other communications from Trophy.
+    attr_reader :control
+    # @return [DateTime] The date and time the user was created, in ISO 8601 format.
+    attr_reader :created
+    # @return [DateTime] The date and time the user was last updated, in ISO 8601 format.
+    attr_reader :updated
+    # @return [String] The ID of the user in your database. Must be a string.
+    attr_reader :id
+    # @return [String] The user's email address. Required if subscribeToEmails is true.
+    attr_reader :email
+    # @return [String] The name to refer to the user by in emails.
+    attr_reader :name
+    # @return [String] The user's timezone (used for email scheduling).
+    attr_reader :tz
+    # @return [Boolean] Whether the user should receive Trophy-powered emails. Cannot be false if an
+    #  email is provided.
+    attr_reader :subscribe_to_emails
+    # @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 control [Boolean] Whether the user is in the control group, meaning they do not receive emails or
+    #  other communications from Trophy.
+    # @param created [DateTime] The date and time the user was created, in ISO 8601 format.
+    # @param updated [DateTime] The date and time the user was last updated, in ISO 8601 format.
+    # @param id [String] The ID of the user in your database. Must be a string.
+    # @param email [String] The user's email address. Required if subscribeToEmails is true.
+    # @param name [String] The name to refer to the user by in emails.
+    # @param tz [String] The user's timezone (used for email scheduling).
+    # @param subscribe_to_emails [Boolean] Whether the user should receive Trophy-powered emails. Cannot be false if an
+    #  email is provided.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::User]
+    def initialize(id:, control: OMIT, created: OMIT, updated: OMIT, email: OMIT, name: OMIT, tz: OMIT,
+                   subscribe_to_emails: OMIT, additional_properties: nil)
+      @control = control if control != OMIT
+      @created = created if created != OMIT
+      @updated = updated if updated != OMIT
+      @id = id
+      @email = email if email != OMIT
+      @name = name if name != OMIT
+      @tz = tz if tz != OMIT
+      @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "control": control,
+        "created": created,
+        "updated": updated,
+        "id": id,
+        "email": email,
+        "name": name,
+        "tz": tz,
+        "subscribeToEmails": subscribe_to_emails
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of User
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::User]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      control = parsed_json["control"]
+      created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
+      updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
+      id = parsed_json["id"]
+      email = parsed_json["email"]
+      name = parsed_json["name"]
+      tz = parsed_json["tz"]
+      subscribe_to_emails = parsed_json["subscribeToEmails"]
+      new(
+        control: control,
+        created: created,
+        updated: updated,
+        id: id,
+        email: email,
+        name: name,
+        tz: tz,
+        subscribe_to_emails: subscribe_to_emails,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of User 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.control&.is_a?(Boolean) != false || raise("Passed value for field obj.control is not the expected type, validation failed.")
+      obj.created&.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.updated&.is_a?(DateTime) != false || raise("Passed value for field obj.updated 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.email&.is_a?(String) != false || raise("Passed value for field obj.email 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.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
+      obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/users/client.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
+require_relative "../types/upserted_user"
+require_relative "../types/user"
+require_relative "../types/updated_user"
 require_relative "../types/metric_response"
 require "json"
 require_relative "../types/achievement_response"
@@ -17,9 +20,111 @@ module TrophyApiClient
       @request_client = request_client
     end
 
+    # Create a new user.
+    #
+    # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
+    #   * :id (String)
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::User]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.create(request: { id: "user-id" })
+    def create(request:, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/users"
+      end
+      TrophyApiClient::User.from_json(json_object: response.body)
+    end
+
+    # Get a single user.
+    #
+    # @param id [String] ID of the user to get.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::User]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.get(id: "userId")
+    def get(id:, 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        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}"
+      end
+      TrophyApiClient::User.from_json(json_object: response.body)
+    end
+
+    # Update a user.
+    #
+    # @param id [String] ID of the user to update.
+    # @param request [Hash] The user object.Request of type TrophyApiClient::UpdatedUser, as a Hash
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::User]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.update(id: "id", request: { email: "user@example.com", tz: "Europe/London" })
+    def update(id:, request:, request_options: nil)
+      response = @request_client.conn.patch 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}"
+      end
+      TrophyApiClient::User.from_json(json_object: response.body)
+    end
+
     # Get a single user's progress against all active metrics.
     #
-    # @param user_id [String] ID of the user
+    # @param id [String] ID of the user
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::MetricResponse>]
     # @example
@@ -28,8 +133,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.allmetrics(user_id: "userId")
-    def allmetrics(user_id:, request_options: nil)
+    #  api.users.allmetrics(id: "userId")
+    def allmetrics(id:, 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?
@@ -44,7 +149,7 @@ module TrophyApiClient
         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/#{user_id}/metrics"
+        req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/metrics"
       end
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
@@ -55,7 +160,7 @@ module TrophyApiClient
 
     # Get a user's progress against a single active metric.
     #
-    # @param user_id [String] ID of the user.
+    # @param id [String] ID of the user.
     # @param key [String] Unique key of the metric.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::MetricResponse]
@@ -65,8 +170,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.singlemetric(user_id: "userId", key: "key")
-    def singlemetric(user_id:, key:, request_options: nil)
+    #  api.users.singlemetric(id: "userId", key: "key")
+    def singlemetric(id:, key:, 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?
@@ -81,14 +186,14 @@ module TrophyApiClient
         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/#{user_id}/metrics/#{key}"
+        req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/metrics/#{key}"
       end
       TrophyApiClient::MetricResponse.from_json(json_object: response.body)
     end
 
     # Get all of a user's completed achievements.
     #
-    # @param user_id [String] ID of the user.
+    # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::AchievementResponse>]
     # @example
@@ -97,8 +202,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.allachievements(user_id: "userId")
-    def allachievements(user_id:, request_options: nil)
+    #  api.users.allachievements(id: "userId")
+    def allachievements(id:, 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?
@@ -113,7 +218,7 @@ module TrophyApiClient
         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/#{user_id}/achievements"
+        req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/achievements"
       end
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
@@ -133,9 +238,117 @@ module TrophyApiClient
       @request_client = request_client
     end
 
+    # Create a new user.
+    #
+    # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
+    #   * :id (String)
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::User]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.create(request: { id: "user-id" })
+    def create(request:, request_options: nil)
+      Async do
+        response = @request_client.conn.post 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/users"
+        end
+        TrophyApiClient::User.from_json(json_object: response.body)
+      end
+    end
+
+    # Get a single user.
+    #
+    # @param id [String] ID of the user to get.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::User]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.get(id: "userId")
+    def get(id:, 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          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}"
+        end
+        TrophyApiClient::User.from_json(json_object: response.body)
+      end
+    end
+
+    # Update a user.
+    #
+    # @param id [String] ID of the user to update.
+    # @param request [Hash] The user object.Request of type TrophyApiClient::UpdatedUser, as a Hash
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    #   * :subscribe_to_emails (Boolean)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::User]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.update(id: "id", request: { email: "user@example.com", tz: "Europe/London" })
+    def update(id:, request:, request_options: nil)
+      Async do
+        response = @request_client.conn.patch 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}"
+        end
+        TrophyApiClient::User.from_json(json_object: response.body)
+      end
+    end
+
     # Get a single user's progress against all active metrics.
     #
-    # @param user_id [String] ID of the user
+    # @param id [String] ID of the user
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::MetricResponse>]
     # @example
@@ -144,8 +357,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.allmetrics(user_id: "userId")
-    def allmetrics(user_id:, request_options: nil)
+    #  api.users.allmetrics(id: "userId")
+    def allmetrics(id:, 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?
@@ -161,7 +374,7 @@ module TrophyApiClient
           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/#{user_id}/metrics"
+          req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/metrics"
         end
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|
@@ -173,7 +386,7 @@ module TrophyApiClient
 
     # Get a user's progress against a single active metric.
     #
-    # @param user_id [String] ID of the user.
+    # @param id [String] ID of the user.
     # @param key [String] Unique key of the metric.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::MetricResponse]
@@ -183,8 +396,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.singlemetric(user_id: "userId", key: "key")
-    def singlemetric(user_id:, key:, request_options: nil)
+    #  api.users.singlemetric(id: "userId", key: "key")
+    def singlemetric(id:, key:, 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?
@@ -200,7 +413,7 @@ module TrophyApiClient
           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/#{user_id}/metrics/#{key}"
+          req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/metrics/#{key}"
         end
         TrophyApiClient::MetricResponse.from_json(json_object: response.body)
       end
@@ -208,7 +421,7 @@ module TrophyApiClient
 
     # Get all of a user's completed achievements.
     #
-    # @param user_id [String] ID of the user.
+    # @param id [String] ID of the user.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::AchievementResponse>]
     # @example
@@ -217,8 +430,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.allachievements(user_id: "userId")
-    def allachievements(user_id:, request_options: nil)
+    #  api.users.allachievements(id: "userId")
+    def allachievements(id:, 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?
@@ -234,7 +447,7 @@ module TrophyApiClient
           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/#{user_id}/achievements"
+          req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}/achievements"
         end
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|

data/lib/trophy_api_client/version.rb

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

data/lib/types_export.rb

@@ -5,7 +5,9 @@ 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/metric_response"
-require_relative "trophy_api_client/types/event_request_user"
+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"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Trophy Labs, Inc
 bindir: exe
 cert_chain: []
-date: 2025-02-13 00:00:00.000000000 Z
+date: 2025-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -104,13 +104,15 @@ files:
 - 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_request_user.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/streak_frequency.rb
 - lib/trophy_api_client/types/streak_response.rb
+- lib/trophy_api_client/types/updated_user.rb
+- lib/trophy_api_client/types/upserted_user.rb
+- lib/trophy_api_client/types/user.rb
 - lib/trophy_api_client/users/client.rb
 - lib/trophy_api_client/version.rb
 - lib/types_export.rb