trophy_api_client 1.14.0 → 1.27.0

data/lib/trophy_api_client/leaderboards/client.rb

@@ -1,225 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../requests"
-require_relative "types/leaderboards_all_response_item"
-require "json"
-require_relative "../types/leaderboard_response_with_rankings"
-require "async"
-
-module TrophyApiClient
-  class LeaderboardsClient
-    # @return [TrophyApiClient::RequestClient]
-    attr_reader :request_client
-
-    # @param request_client [TrophyApiClient::RequestClient]
-    # @return [TrophyApiClient::LeaderboardsClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Get all leaderboards for your organization. Finished leaderboards are excluded
-    #  by default.
-    #
-    # @param include_finished [Boolean] When set to 'true', leaderboards with status 'finished' will be included in the
-    #  response. By default, finished leaderboards are excluded.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.leaderboards.all(include_finished: true)
-    def all(include_finished: 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-        req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
-        }.compact
-        req.params = {
-          **(request_options&.additional_query_parameters || {}),
-          "includeFinished": include_finished
-        }.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(environment: api, request_options: request_options)}/leaderboards"
-      end
-      parsed_json = JSON.parse(response.body)
-      parsed_json&.map do |item|
-        item = item.to_json
-        TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem.from_json(json_object: item)
-      end
-    end
-
-    # Get a specific leaderboard by its key.
-    #
-    # @param key [String] Unique key of the leaderboard as set when created.
-    # @param offset [Integer] Number of rankings to skip for pagination.
-    # @param limit [Integer] Maximum number of rankings to return. Cannot be greater than the size of the
-    #  leaderboard.
-    # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
-    #  run.
-    # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
-    #  the user is not found in the leaderboard, returns empty rankings array.
-    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. For
-    #  example, `city:London`. This parameter is required, and only valid for
-    #  leaderboards with a breakdown attribute.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::LeaderboardResponseWithRankings]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.leaderboards.get(
-    #    key: "weekly-words",
-    #    offset: 1,
-    #    limit: 1,
-    #    run: "2025-01-15",
-    #    user_id: "user-123",
-    #    user_attributes: "city:London"
-    #  )
-    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-        req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
-        }.compact
-        req.params = {
-          **(request_options&.additional_query_parameters || {}),
-          "offset": offset,
-          "limit": limit,
-          "run": run,
-          "userId": user_id,
-          "userAttributes": user_attributes
-        }.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(environment: api, request_options: request_options)}/leaderboards/#{key}"
-      end
-      TrophyApiClient::LeaderboardResponseWithRankings.from_json(json_object: response.body)
-    end
-  end
-
-  class AsyncLeaderboardsClient
-    # @return [TrophyApiClient::AsyncRequestClient]
-    attr_reader :request_client
-
-    # @param request_client [TrophyApiClient::AsyncRequestClient]
-    # @return [TrophyApiClient::AsyncLeaderboardsClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Get all leaderboards for your organization. Finished leaderboards are excluded
-    #  by default.
-    #
-    # @param include_finished [Boolean] When set to 'true', leaderboards with status 'finished' will be included in the
-    #  response. By default, finished leaderboards are excluded.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.leaderboards.all(include_finished: true)
-    def all(include_finished: 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-          req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
-          }.compact
-          req.params = {
-            **(request_options&.additional_query_parameters || {}),
-            "includeFinished": include_finished
-          }.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(environment: api, request_options: request_options)}/leaderboards"
-        end
-        parsed_json = JSON.parse(response.body)
-        parsed_json&.map do |item|
-          item = item.to_json
-          TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem.from_json(json_object: item)
-        end
-      end
-    end
-
-    # Get a specific leaderboard by its key.
-    #
-    # @param key [String] Unique key of the leaderboard as set when created.
-    # @param offset [Integer] Number of rankings to skip for pagination.
-    # @param limit [Integer] Maximum number of rankings to return. Cannot be greater than the size of the
-    #  leaderboard.
-    # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
-    #  run.
-    # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
-    #  the user is not found in the leaderboard, returns empty rankings array.
-    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. For
-    #  example, `city:London`. This parameter is required, and only valid for
-    #  leaderboards with a breakdown attribute.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::LeaderboardResponseWithRankings]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.leaderboards.get(
-    #    key: "weekly-words",
-    #    offset: 1,
-    #    limit: 1,
-    #    run: "2025-01-15",
-    #    user_id: "user-123",
-    #    user_attributes: "city:London"
-    #  )
-    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-          req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
-          }.compact
-          req.params = {
-            **(request_options&.additional_query_parameters || {}),
-            "offset": offset,
-            "limit": limit,
-            "run": run,
-            "userId": user_id,
-            "userAttributes": user_attributes
-          }.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(environment: api, request_options: request_options)}/leaderboards/#{key}"
-        end
-        TrophyApiClient::LeaderboardResponseWithRankings.from_json(json_object: response.body)
-      end
-    end
-  end
-end

data/lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb

@@ -1,202 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "leaderboards_all_response_item_status"
-require_relative "../../types/leaderboard_response_rank_by"
-require_relative "../../types/leaderboard_response_run_unit"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  class Leaderboards
-    class LeaderboardsAllResponseItem
-      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus] The status of the leaderboard.
-      attr_reader :status
-      # @return [String] The unique ID of the leaderboard.
-      attr_reader :id
-      # @return [String] The user-facing name of the leaderboard.
-      attr_reader :name
-      # @return [String] The unique key used to reference the leaderboard in APIs.
-      attr_reader :key
-      # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
-      attr_reader :rank_by
-      # @return [String] Deprecated. The key of the attribute to break down this leaderboard by.
-      attr_reader :breakdown_attribute
-      # @return [Array<String>] The user attribute keys that this leaderboard is broken down by.
-      attr_reader :breakdown_attributes
-      # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
-      attr_reader :metric_key
-      # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
-      attr_reader :metric_name
-      # @return [String] The key of the points system to rank by, if rankBy is 'points'.
-      attr_reader :points_system_key
-      # @return [String] The name of the points system to rank by, if rankBy is 'points'.
-      attr_reader :points_system_name
-      # @return [String] The user-facing description of the leaderboard.
-      attr_reader :description
-      # @return [String] The start date of the leaderboard in YYYY-MM-DD format.
-      attr_reader :start
-      # @return [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
-      #  forever.
-      attr_reader :end_
-      # @return [Integer] The maximum number of participants in the leaderboard.
-      attr_reader :max_participants
-      # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
-      #  leaderboards.
-      attr_reader :run_unit
-      # @return [Integer] The interval between repetitions, relative to the start date and repetition
-      #  type. Null for one-time leaderboards.
-      attr_reader :run_interval
-      # @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 status [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus] The status of the leaderboard.
-      # @param id [String] The unique ID of the leaderboard.
-      # @param name [String] The user-facing name of the leaderboard.
-      # @param key [String] The unique key used to reference the leaderboard in APIs.
-      # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
-      # @param breakdown_attribute [String] Deprecated. The key of the attribute to break down this leaderboard by.
-      # @param breakdown_attributes [Array<String>] The user attribute keys that this leaderboard is broken down by.
-      # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
-      # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
-      # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
-      # @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
-      # @param description [String] The user-facing description of the leaderboard.
-      # @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
-      # @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
-      #  forever.
-      # @param max_participants [Integer] The maximum number of participants in the leaderboard.
-      # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
-      #  leaderboards.
-      # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
-      #  type. Null for one-time leaderboards.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
-      def initialize(status:, id:, name:, key:, rank_by:, breakdown_attributes:, start:, breakdown_attribute: OMIT,
-                     metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, max_participants: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
-        @status = status
-        @id = id
-        @name = name
-        @key = key
-        @rank_by = rank_by
-        @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
-        @breakdown_attributes = breakdown_attributes
-        @metric_key = metric_key if metric_key != OMIT
-        @metric_name = metric_name if metric_name != OMIT
-        @points_system_key = points_system_key if points_system_key != OMIT
-        @points_system_name = points_system_name if points_system_name != OMIT
-        @description = description if description != OMIT
-        @start = start
-        @end_ = end_ if end_ != OMIT
-        @max_participants = max_participants if max_participants != OMIT
-        @run_unit = run_unit if run_unit != OMIT
-        @run_interval = run_interval if run_interval != OMIT
-        @additional_properties = additional_properties
-        @_field_set = {
-          "status": status,
-          "id": id,
-          "name": name,
-          "key": key,
-          "rankBy": rank_by,
-          "breakdownAttribute": breakdown_attribute,
-          "breakdownAttributes": breakdown_attributes,
-          "metricKey": metric_key,
-          "metricName": metric_name,
-          "pointsSystemKey": points_system_key,
-          "pointsSystemName": points_system_name,
-          "description": description,
-          "start": start,
-          "end": end_,
-          "maxParticipants": max_participants,
-          "runUnit": run_unit,
-          "runInterval": run_interval
-        }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of LeaderboardsAllResponseItem
-      #
-      # @param json_object [String]
-      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        status = parsed_json["status"]
-        id = parsed_json["id"]
-        name = parsed_json["name"]
-        key = parsed_json["key"]
-        rank_by = parsed_json["rankBy"]
-        breakdown_attribute = parsed_json["breakdownAttribute"]
-        breakdown_attributes = parsed_json["breakdownAttributes"]
-        metric_key = parsed_json["metricKey"]
-        metric_name = parsed_json["metricName"]
-        points_system_key = parsed_json["pointsSystemKey"]
-        points_system_name = parsed_json["pointsSystemName"]
-        description = parsed_json["description"]
-        start = parsed_json["start"]
-        end_ = parsed_json["end"]
-        max_participants = parsed_json["maxParticipants"]
-        run_unit = parsed_json["runUnit"]
-        run_interval = parsed_json["runInterval"]
-        new(
-          status: status,
-          id: id,
-          name: name,
-          key: key,
-          rank_by: rank_by,
-          breakdown_attribute: breakdown_attribute,
-          breakdown_attributes: breakdown_attributes,
-          metric_key: metric_key,
-          metric_name: metric_name,
-          points_system_key: points_system_key,
-          points_system_name: points_system_name,
-          description: description,
-          start: start,
-          end_: end_,
-          max_participants: max_participants,
-          run_unit: run_unit,
-          run_interval: run_interval,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of LeaderboardsAllResponseItem 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.status.is_a?(TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
-        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-        obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
-        obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
-        obj.breakdown_attribute&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute is not the expected type, validation failed.")
-        obj.breakdown_attributes.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attributes is not the expected type, validation failed.")
-        obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key is not the expected type, validation failed.")
-        obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
-        obj.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")
-        obj.points_system_name&.is_a?(String) != false || raise("Passed value for field obj.points_system_name is not the expected type, validation failed.")
-        obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-        obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
-        obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
-        obj.max_participants&.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
-        obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
-        obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/trophy_api_client/metrics/client.rb

@@ -1,142 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../requests"
-require_relative "../types/upserted_user"
-require_relative "../types/event_response"
-require "async"
-
-module TrophyApiClient
-  class MetricsClient
-    # @return [TrophyApiClient::RequestClient]
-    attr_reader :request_client
-
-    # @param request_client [TrophyApiClient::RequestClient]
-    # @return [TrophyApiClient::MetricsClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Increment or decrement the value of a metric for a user.
-    #
-    # @param idempotency_key [String]
-    # @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::UpsertedUser, as a Hash
-    #   * :id (String)
-    #   * :email (String)
-    #   * :name (String)
-    #   * :tz (String)
-    #   * :device_tokens (Array<String>)
-    #   * :subscribe_to_emails (Boolean)
-    #   * :attributes (Hash{String => String})
-    # @param value [Float] The value to add to the user's current total for the given metric.
-    # @param attributes [Hash{String => String}] Event attributes as key-value pairs. Keys must match existing event attributes
-    #  set up in the Trophy dashboard.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::EventResponse]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.metrics.event(
-    #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
-    #    key: "words-written",
-    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
-    #    value: 750,
-    #    attributes: { "category": "writing", "source": "mobile-app" }
-    #  )
-    def event(key:, user:, value:, idempotency_key: nil, attributes: nil, 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-        req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {}),
-          "Idempotency-Key": idempotency_key
-        }.compact
-        unless request_options.nil? || request_options&.additional_query_parameters.nil?
-          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-        end
-        req.body = {
-          **(request_options&.additional_body_parameters || {}),
-          user: user,
-          value: value,
-          attributes: attributes
-        }.compact
-        req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/metrics/#{key}/event"
-      end
-      TrophyApiClient::EventResponse.from_json(json_object: response.body)
-    end
-  end
-
-  class AsyncMetricsClient
-    # @return [TrophyApiClient::AsyncRequestClient]
-    attr_reader :request_client
-
-    # @param request_client [TrophyApiClient::AsyncRequestClient]
-    # @return [TrophyApiClient::AsyncMetricsClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Increment or decrement the value of a metric for a user.
-    #
-    # @param idempotency_key [String]
-    # @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::UpsertedUser, as a Hash
-    #   * :id (String)
-    #   * :email (String)
-    #   * :name (String)
-    #   * :tz (String)
-    #   * :device_tokens (Array<String>)
-    #   * :subscribe_to_emails (Boolean)
-    #   * :attributes (Hash{String => String})
-    # @param value [Float] The value to add to the user's current total for the given metric.
-    # @param attributes [Hash{String => String}] Event attributes as key-value pairs. Keys must match existing event attributes
-    #  set up in the Trophy dashboard.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::EventResponse]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.metrics.event(
-    #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
-    #    key: "words-written",
-    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
-    #    value: 750,
-    #    attributes: { "category": "writing", "source": "mobile-app" }
-    #  )
-    def event(key:, user:, value:, idempotency_key: nil, attributes: nil, 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-          req.headers = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {}),
-            "Idempotency-Key": idempotency_key
-          }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
-          req.body = {
-            **(request_options&.additional_body_parameters || {}),
-            user: user,
-            value: value,
-            attributes: attributes
-          }.compact
-          req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/metrics/#{key}/event"
-        end
-        TrophyApiClient::EventResponse.from_json(json_object: response.body)
-      end
-    end
-  end
-end