trophy_api_client 1.0.12 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1552058b8e26bb11794e4add9f690522878779c123c84343f0a5091954596202
-  data.tar.gz: fe75b53fd1ddf0dc6f1479ca75060ac6d36665a07380fd7cb6575269cb0f9d74
+  metadata.gz: 8366072c3be65aa0e4fa350f5d0b0313f9d38e1d907cb59f63982b3da33f7700
+  data.tar.gz: ec64eee7eb6cd567cdbc765933a6ca983cdbdb82179b53390cde72627988e91d
 SHA512:
-  metadata.gz: c911e99071d6e1b6bcb4d30e9fd72d1a2385f0731137d96eb00fd357d64f93374b4fd77a5942f2c97cb23f2d7e12777ac0b30e422919861fcbbaa31d25d7e7a3
-  data.tar.gz: b96e3770f2d53ae133fcb651656db80a7a6b9e099255ccd1db064aec5dd862979a99c0ab83fea0d0aca8bfa64361ce2ca5e389f0d6922752223fac3fb1ef4054
+  metadata.gz: f7049e227b0c5609be15587e82dd7c76ea4e4b3075eb6a94ba70b24eeb640a4ae0e1210d00bc58cc251f82334d8c2e8cbc7a31f03375b7f1195daf303c0007f2
+  data.tar.gz: '036865ebf9e563fb0feb20af8b457a732a9667a22521b6d0f757cf16a7f929b307f336b74c458a97f28a65b83b035e5ced77a00230b69fe76a97eef2b1d47b75'

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/users/client.rb

@@ -26,7 +26,7 @@ module TrophyApiClient
       @request_client = request_client
     end
 
-    # Identify a new user.
+    # Create a new user.
     #
     # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
@@ -93,6 +93,41 @@ module TrophyApiClient
       TrophyApiClient::User.from_json(json_object: response.body)
     end
 
+    # Identify a user.
+    #
+    # @param id [String] ID of the user to identify.
+    # @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.identify(id: "id", request: { email: "user@example.com", tz: "Europe/London" })
+    def identify(id:, request:, request_options: nil)
+      response = @request_client.conn.put 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
+
     # Update a user.
     #
     # @param id [String] ID of the user to update.
@@ -410,7 +445,7 @@ module TrophyApiClient
       @request_client = request_client
     end
 
-    # Identify a new user.
+    # Create a new user.
     #
     # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
@@ -481,6 +516,43 @@ module TrophyApiClient
       end
     end
 
+    # Identify a user.
+    #
+    # @param id [String] ID of the user to identify.
+    # @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.identify(id: "id", request: { email: "user@example.com", tz: "Europe/London" })
+    def identify(id:, request:, request_options: nil)
+      Async do
+        response = @request_client.conn.put 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
+
     # Update a user.
     #
     # @param id [String] ID of the user to update.

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.12"
+  VERSION = "1.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.14
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby library for the Trophy API.
 test_files: []