trophy_api_client 1.0.23 → 1.0.24

data/lib/trophy_api_client/types/user_leaderboard_response.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require_relative "leaderboard_event"
+require_relative "leaderboard_response_status"
+require_relative "leaderboard_response_rank_by"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user's data for a specific leaderboard including rank, value, and history.
+  class UserLeaderboardResponse
+    # @return [Integer] The user's current rank in this leaderboard. Null if the user is not on the
+    #  leaderboard.
+    attr_reader :rank
+    # @return [Integer] The user's current value in this leaderboard. Null if the user is not on the
+    #  leaderboard.
+    attr_reader :value
+    # @return [Array<TrophyApiClient::LeaderboardEvent>] An array of events showing the user's rank and value changes over time.
+    attr_reader :history
+    # @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::LeaderboardResponseStatus] The status of the leaderboard.
+    attr_reader :status
+    # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+    attr_reader :rank_by
+    # @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 [String] 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.
+    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 rank [Integer] The user's current rank in this leaderboard. Null if the user is not on the
+    #  leaderboard.
+    # @param value [Integer] The user's current value in this leaderboard. Null if the user is not on the
+    #  leaderboard.
+    # @param history [Array<TrophyApiClient::LeaderboardEvent>] An array of events showing the user's rank and value changes over time.
+    # @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 status [TrophyApiClient::LeaderboardResponseStatus] The status of the leaderboard.
+    # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks 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 [String] 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.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UserLeaderboardResponse]
+    def initialize(history:, id:, name:, key:, rank_by:, start:, max_participants:, run_interval:, rank: OMIT, value: OMIT, status: OMIT, metric_key: OMIT,
+                   metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
+      @rank = rank if rank != OMIT
+      @value = value if value != OMIT
+      @history = history
+      @id = id
+      @name = name
+      @key = key
+      @status = status if status != OMIT
+      @rank_by = rank_by
+      @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
+      @run_unit = run_unit if run_unit != OMIT
+      @run_interval = run_interval
+      @additional_properties = additional_properties
+      @_field_set = {
+        "rank": rank,
+        "value": value,
+        "history": history,
+        "id": id,
+        "name": name,
+        "key": key,
+        "status": status,
+        "rankBy": rank_by,
+        "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 UserLeaderboardResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UserLeaderboardResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      rank = parsed_json["rank"]
+      value = parsed_json["value"]
+      history = parsed_json["history"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::LeaderboardEvent.from_json(json_object: item)
+      end
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      key = parsed_json["key"]
+      status = parsed_json["status"]
+      rank_by = parsed_json["rankBy"]
+      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(
+        rank: rank,
+        value: value,
+        history: history,
+        id: id,
+        name: name,
+        key: key,
+        status: status,
+        rank_by: rank_by,
+        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 UserLeaderboardResponse 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.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
+      obj.value&.is_a?(Integer) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      obj.history.is_a?(Array) != false || raise("Passed value for field obj.history 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.status&.is_a?(TrophyApiClient::LeaderboardResponseStatus) != false || raise("Passed value for field obj.status 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.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?(String) != 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

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.23"
+  VERSION = "1.0.24"
 end

data/lib/trophy_api_client.rb

@@ -8,6 +8,7 @@ require_relative "trophy_api_client/metrics/client"
 require_relative "trophy_api_client/users/client"
 require_relative "trophy_api_client/streaks/client"
 require_relative "trophy_api_client/points/client"
+require_relative "trophy_api_client/leaderboards/client"
 
 module TrophyApiClient
   class Client
@@ -21,6 +22,8 @@ module TrophyApiClient
     attr_reader :streaks
     # @return [TrophyApiClient::PointsClient]
     attr_reader :points
+    # @return [TrophyApiClient::LeaderboardsClient]
+    attr_reader :leaderboards
 
     # @param base_url [String]
     # @param environment [TrophyApiClient::Environment]
@@ -42,6 +45,7 @@ module TrophyApiClient
       @users = TrophyApiClient::UsersClient.new(request_client: @request_client)
       @streaks = TrophyApiClient::StreaksClient.new(request_client: @request_client)
       @points = TrophyApiClient::PointsClient.new(request_client: @request_client)
+      @leaderboards = TrophyApiClient::LeaderboardsClient.new(request_client: @request_client)
     end
   end
 
@@ -56,6 +60,8 @@ module TrophyApiClient
     attr_reader :streaks
     # @return [TrophyApiClient::AsyncPointsClient]
     attr_reader :points
+    # @return [TrophyApiClient::AsyncLeaderboardsClient]
+    attr_reader :leaderboards
 
     # @param base_url [String]
     # @param environment [TrophyApiClient::Environment]
@@ -77,6 +83,7 @@ module TrophyApiClient
       @users = TrophyApiClient::AsyncUsersClient.new(request_client: @async_request_client)
       @streaks = TrophyApiClient::AsyncStreaksClient.new(request_client: @async_request_client)
       @points = TrophyApiClient::AsyncPointsClient.new(request_client: @async_request_client)
+      @leaderboards = TrophyApiClient::AsyncLeaderboardsClient.new(request_client: @async_request_client)
     end
   end
 end

data/lib/types_export.rb

@@ -17,7 +17,12 @@ require_relative "trophy_api_client/types/points_trigger_type"
 require_relative "trophy_api_client/types/points_trigger"
 require_relative "trophy_api_client/types/points_award"
 require_relative "trophy_api_client/types/get_user_points_response"
+require_relative "trophy_api_client/types/leaderboard_response_status"
+require_relative "trophy_api_client/types/leaderboard_response_rank_by"
+require_relative "trophy_api_client/types/leaderboard_response"
+require_relative "trophy_api_client/types/leaderboard_response_with_rankings"
 require_relative "trophy_api_client/types/metric_event_points_response"
+require_relative "trophy_api_client/types/metric_event_leaderboard_response"
 require_relative "trophy_api_client/types/achievement_response_trigger"
 require_relative "trophy_api_client/types/achievement_response"
 require_relative "trophy_api_client/types/completed_achievement_response"
@@ -40,3 +45,6 @@ require_relative "trophy_api_client/types/points_trigger_response_event_attribut
 require_relative "trophy_api_client/types/points_trigger_response"
 require_relative "trophy_api_client/types/points_system_response"
 require_relative "trophy_api_client/types/streak_ranking_user"
+require_relative "trophy_api_client/types/leaderboard_ranking"
+require_relative "trophy_api_client/types/leaderboard_event"
+require_relative "trophy_api_client/types/user_leaderboard_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.23
+  version: 1.0.24
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -100,6 +100,7 @@ files:
 - lib/requests.rb
 - lib/trophy_api_client.rb
 - lib/trophy_api_client/achievements/client.rb
+- lib/trophy_api_client/leaderboards/client.rb
 - lib/trophy_api_client/metrics/client.rb
 - lib/trophy_api_client/points/client.rb
 - lib/trophy_api_client/streaks/client.rb
@@ -117,6 +118,13 @@ files:
 - lib/trophy_api_client/types/error_body.rb
 - lib/trophy_api_client/types/event_response.rb
 - lib/trophy_api_client/types/get_user_points_response.rb
+- lib/trophy_api_client/types/leaderboard_event.rb
+- lib/trophy_api_client/types/leaderboard_ranking.rb
+- lib/trophy_api_client/types/leaderboard_response.rb
+- lib/trophy_api_client/types/leaderboard_response_rank_by.rb
+- lib/trophy_api_client/types/leaderboard_response_status.rb
+- lib/trophy_api_client/types/leaderboard_response_with_rankings.rb
+- lib/trophy_api_client/types/metric_event_leaderboard_response.rb
 - lib/trophy_api_client/types/metric_event_points_response.rb
 - lib/trophy_api_client/types/metric_event_streak_response.rb
 - lib/trophy_api_client/types/metric_response.rb
@@ -139,6 +147,7 @@ files:
 - 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/types/user_leaderboard_response.rb
 - lib/trophy_api_client/users/client.rb
 - lib/trophy_api_client/users/types/users_metric_event_summary_request_aggregation.rb
 - lib/trophy_api_client/users/types/users_metric_event_summary_response_item.rb