trophy_api_client 1.6.0 → 1.7.0

data/lib/trophy_api_client/types/update_leaderboard_request_item.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require_relative "update_leaderboard_request_item_status"
+require_relative "update_leaderboard_request_item_rank_by"
+require_relative "update_leaderboard_request_item_run_unit"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A leaderboard update object. `id` is required. Once a leaderboard has been
+  #  activated, the dashboard-imposed restrictions on ranking configuration and
+  #  scheduling changes still apply.
+  class UpdateLeaderboardRequestItem
+    # @return [String] The UUID of the leaderboard to update.
+    attr_reader :id
+    # @return [String] The updated leaderboard name.
+    attr_reader :name
+    # @return [String] The updated leaderboard key. This can only be changed while the leaderboard is
+    #  inactive.
+    attr_reader :key
+    # @return [String] The updated leaderboard description.
+    attr_reader :description
+    # @return [TrophyApiClient::UpdateLeaderboardRequestItemStatus] The target user-facing status. `scheduled` activates a leaderboard whose start
+    #  date is in the future. `finished` behaves like the dashboard finish action.
+    attr_reader :status
+    # @return [TrophyApiClient::UpdateLeaderboardRequestItemRankBy] The updated ranking criterion. This can only be changed while the leaderboard is
+    #  inactive.
+    attr_reader :rank_by
+    # @return [String] The metric ID to use when `rankBy` is `metric`.
+    attr_reader :metric_id
+    # @return [String] The points system ID to use when `rankBy` is `points`.
+    attr_reader :points_system_id
+    # @return [Integer] The updated maximum number of participants.
+    attr_reader :max_participants
+    # @return [String] The updated start date in YYYY-MM-DD format.
+    attr_reader :start
+    # @return [String] The updated end date in YYYY-MM-DD format, or `null` to clear it.
+    attr_reader :end_
+    # @return [Array<String>] The updated breakdown attribute UUIDs.
+    attr_reader :breakdown_attributes
+    # @return [TrophyApiClient::UpdateLeaderboardRequestItemRunUnit] The updated recurrence unit.
+    attr_reader :run_unit
+    # @return [Integer] The updated recurrence interval.
+    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 id [String] The UUID of the leaderboard to update.
+    # @param name [String] The updated leaderboard name.
+    # @param key [String] The updated leaderboard key. This can only be changed while the leaderboard is
+    #  inactive.
+    # @param description [String] The updated leaderboard description.
+    # @param status [TrophyApiClient::UpdateLeaderboardRequestItemStatus] The target user-facing status. `scheduled` activates a leaderboard whose start
+    #  date is in the future. `finished` behaves like the dashboard finish action.
+    # @param rank_by [TrophyApiClient::UpdateLeaderboardRequestItemRankBy] The updated ranking criterion. This can only be changed while the leaderboard is
+    #  inactive.
+    # @param metric_id [String] The metric ID to use when `rankBy` is `metric`.
+    # @param points_system_id [String] The points system ID to use when `rankBy` is `points`.
+    # @param max_participants [Integer] The updated maximum number of participants.
+    # @param start [String] The updated start date in YYYY-MM-DD format.
+    # @param end_ [String] The updated end date in YYYY-MM-DD format, or `null` to clear it.
+    # @param breakdown_attributes [Array<String>] The updated breakdown attribute UUIDs.
+    # @param run_unit [TrophyApiClient::UpdateLeaderboardRequestItemRunUnit] The updated recurrence unit.
+    # @param run_interval [Integer] The updated recurrence interval.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UpdateLeaderboardRequestItem]
+    def initialize(id:, name: OMIT, key: OMIT, description: OMIT, status: OMIT, rank_by: OMIT, metric_id: OMIT,
+                   points_system_id: OMIT, max_participants: OMIT, start: OMIT, end_: OMIT, breakdown_attributes: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
+      @id = id
+      @name = name if name != OMIT
+      @key = key if key != OMIT
+      @description = description if description != OMIT
+      @status = status if status != OMIT
+      @rank_by = rank_by if rank_by != OMIT
+      @metric_id = metric_id if metric_id != OMIT
+      @points_system_id = points_system_id if points_system_id != OMIT
+      @max_participants = max_participants if max_participants != OMIT
+      @start = start if start != OMIT
+      @end_ = end_ if end_ != OMIT
+      @breakdown_attributes = breakdown_attributes if breakdown_attributes != OMIT
+      @run_unit = run_unit if run_unit != OMIT
+      @run_interval = run_interval if run_interval != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "key": key,
+        "description": description,
+        "status": status,
+        "rankBy": rank_by,
+        "metricId": metric_id,
+        "pointsSystemId": points_system_id,
+        "maxParticipants": max_participants,
+        "start": start,
+        "end": end_,
+        "breakdownAttributes": breakdown_attributes,
+        "runUnit": run_unit,
+        "runInterval": run_interval
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateLeaderboardRequestItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UpdateLeaderboardRequestItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      key = parsed_json["key"]
+      description = parsed_json["description"]
+      status = parsed_json["status"]
+      rank_by = parsed_json["rankBy"]
+      metric_id = parsed_json["metricId"]
+      points_system_id = parsed_json["pointsSystemId"]
+      max_participants = parsed_json["maxParticipants"]
+      start = parsed_json["start"]
+      end_ = parsed_json["end"]
+      breakdown_attributes = parsed_json["breakdownAttributes"]
+      run_unit = parsed_json["runUnit"]
+      run_interval = parsed_json["runInterval"]
+      new(
+        id: id,
+        name: name,
+        key: key,
+        description: description,
+        status: status,
+        rank_by: rank_by,
+        metric_id: metric_id,
+        points_system_id: points_system_id,
+        max_participants: max_participants,
+        start: start,
+        end_: end_,
+        breakdown_attributes: breakdown_attributes,
+        run_unit: run_unit,
+        run_interval: run_interval,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateLeaderboardRequestItem to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.key&.is_a?(String) != false || raise("Passed value for field obj.key 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.status&.is_a?(TrophyApiClient::UpdateLeaderboardRequestItemStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.rank_by&.is_a?(TrophyApiClient::UpdateLeaderboardRequestItemRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
+      obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
+      obj.points_system_id&.is_a?(String) != false || raise("Passed value for field obj.points_system_id 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.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.breakdown_attributes&.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attributes is not the expected type, validation failed.")
+      obj.run_unit&.is_a?(TrophyApiClient::UpdateLeaderboardRequestItemRunUnit) != 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/types/update_leaderboard_request_item_rank_by.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The updated ranking criterion. This can only be changed while the leaderboard is
+  #  inactive.
+  class UpdateLeaderboardRequestItemRankBy
+    METRIC = "metric"
+    STREAK = "streak"
+    POINTS = "points"
+  end
+end

data/lib/trophy_api_client/types/update_leaderboard_request_item_run_unit.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class UpdateLeaderboardRequestItemRunUnit
+    DAY = "day"
+    MONTH = "month"
+    YEAR = "year"
+  end
+end

data/lib/trophy_api_client/types/update_leaderboard_request_item_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The target user-facing status. `scheduled` activates a leaderboard whose start
+  #  date is in the future. `finished` behaves like the dashboard finish action.
+  class UpdateLeaderboardRequestItemStatus
+    INACTIVE = "inactive"
+    ACTIVE = "active"
+    SCHEDULED = "scheduled"
+    FINISHED = "finished"
+  end
+end

data/lib/trophy_api_client/types/update_leaderboards_request.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "update_leaderboard_request_item"
+
+module TrophyApiClient
+  UPDATE_LEADERBOARDS_REQUEST = Array
+end

data/lib/trophy_api_client/types/update_leaderboards_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "admin_leaderboard"
+require_relative "admin_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing updated leaderboards and any per-item issues identified by
+  #  leaderboard ID.
+  class UpdateLeaderboardsResponse
+    # @return [Array<TrophyApiClient::AdminLeaderboard>] Array of successfully updated leaderboards.
+    attr_reader :updated
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during leaderboard update.
+    attr_reader :issues
+    # @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 updated [Array<TrophyApiClient::AdminLeaderboard>] Array of successfully updated leaderboards.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during leaderboard update.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UpdateLeaderboardsResponse]
+    def initialize(updated:, issues:, additional_properties: nil)
+      @updated = updated
+      @issues = issues
+      @additional_properties = additional_properties
+      @_field_set = { "updated": updated, "issues": issues }
+    end
+
+    # Deserialize a JSON object to an instance of UpdateLeaderboardsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UpdateLeaderboardsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      updated = parsed_json["updated"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminLeaderboard.from_json(json_object: item)
+      end
+      issues = parsed_json["issues"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminIssue.from_json(json_object: item)
+      end
+      new(
+        updated: updated,
+        issues: issues,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateLeaderboardsResponse 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.updated.is_a?(Array) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
+      obj.issues.is_a?(Array) != false || raise("Passed value for field obj.issues is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/users/client.rb

@@ -33,7 +33,7 @@ module TrophyApiClient
 
     # Create a new user.
     #
-    # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
+    # @param request [Hash] Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
     #   * :email (String)
     #   * :name (String)
@@ -657,7 +657,7 @@ module TrophyApiClient
 
     # Create a new user.
     #
-    # @param request [Hash] The user object.Request of type TrophyApiClient::UpsertedUser, as a Hash
+    # @param request [Hash] Request of type TrophyApiClient::UpsertedUser, as a Hash
     #   * :id (String)
     #   * :email (String)
     #   * :name (String)

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/lib/types_export.rb

@@ -73,7 +73,6 @@ 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/notification_channel"
-require_relative "trophy_api_client/types/notification_type"
 require_relative "trophy_api_client/types/notification_preferences"
 require_relative "trophy_api_client/types/user_preferences_response"
 require_relative "trophy_api_client/types/error_body"
@@ -88,6 +87,17 @@ require_relative "trophy_api_client/types/leaderboard_event"
 require_relative "trophy_api_client/types/user_leaderboard_response"
 require_relative "trophy_api_client/types/user_leaderboard_response_with_history"
 require_relative "trophy_api_client/types/webhook_user_leaderboard_response"
+require_relative "trophy_api_client/types/wrapped_metric_by_attribute_value_value"
+require_relative "trophy_api_client/types/wrapped_metric"
+require_relative "trophy_api_client/types/wrapped_points"
+require_relative "trophy_api_client/types/wrapped_streak"
+require_relative "trophy_api_client/types/wrapped_activity_period"
+require_relative "trophy_api_client/types/wrapped_most_active_day"
+require_relative "trophy_api_client/types/wrapped_most_active_week"
+require_relative "trophy_api_client/types/wrapped_most_active_month"
+require_relative "trophy_api_client/types/wrapped_entire_year"
+require_relative "trophy_api_client/types/wrapped_activity"
+require_relative "trophy_api_client/types/wrapped_response"
 require_relative "trophy_api_client/types/create_streak_freezes_response"
 require_relative "trophy_api_client/types/create_attribute_request_item"
 require_relative "trophy_api_client/types/create_attributes_request"
@@ -100,6 +110,24 @@ require_relative "trophy_api_client/types/update_attributes_request"
 require_relative "trophy_api_client/types/update_attributes_response"
 require_relative "trophy_api_client/types/delete_attributes_response"
 require_relative "trophy_api_client/types/list_attributes_response"
+require_relative "trophy_api_client/types/create_leaderboard_request_item"
+require_relative "trophy_api_client/types/create_leaderboards_request"
+require_relative "trophy_api_client/types/create_leaderboard_request_item_status"
+require_relative "trophy_api_client/types/create_leaderboard_request_item_rank_by"
+require_relative "trophy_api_client/types/create_leaderboard_request_item_run_unit"
+require_relative "trophy_api_client/types/admin_leaderboard_status"
+require_relative "trophy_api_client/types/admin_leaderboard_rank_by"
+require_relative "trophy_api_client/types/admin_leaderboard_run_unit"
+require_relative "trophy_api_client/types/admin_leaderboard"
+require_relative "trophy_api_client/types/create_leaderboards_response"
+require_relative "trophy_api_client/types/update_leaderboard_request_item"
+require_relative "trophy_api_client/types/update_leaderboards_request"
+require_relative "trophy_api_client/types/update_leaderboard_request_item_status"
+require_relative "trophy_api_client/types/update_leaderboard_request_item_rank_by"
+require_relative "trophy_api_client/types/update_leaderboard_request_item_run_unit"
+require_relative "trophy_api_client/types/update_leaderboards_response"
+require_relative "trophy_api_client/types/delete_leaderboards_response"
+require_relative "trophy_api_client/types/list_leaderboards_response"
 require_relative "trophy_api_client/types/create_metric_request_item"
 require_relative "trophy_api_client/types/create_metrics_request"
 require_relative "trophy_api_client/types/create_metric_request_item_unit_type"
@@ -121,14 +149,3 @@ require_relative "trophy_api_client/types/restore_streaks_response"
 require_relative "trophy_api_client/types/admin_issue_severity"
 require_relative "trophy_api_client/types/admin_issue"
 require_relative "trophy_api_client/types/deleted_resource"
-require_relative "trophy_api_client/types/wrapped_metric_by_attribute_value_value"
-require_relative "trophy_api_client/types/wrapped_metric"
-require_relative "trophy_api_client/types/wrapped_points"
-require_relative "trophy_api_client/types/wrapped_streak"
-require_relative "trophy_api_client/types/wrapped_activity_period"
-require_relative "trophy_api_client/types/wrapped_most_active_day"
-require_relative "trophy_api_client/types/wrapped_most_active_week"
-require_relative "trophy_api_client/types/wrapped_most_active_month"
-require_relative "trophy_api_client/types/wrapped_entire_year"
-require_relative "trophy_api_client/types/wrapped_activity"
-require_relative "trophy_api_client/types/wrapped_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -102,6 +102,7 @@ files:
 - lib/trophy_api_client/achievements/client.rb
 - lib/trophy_api_client/admin/attributes/client.rb
 - lib/trophy_api_client/admin/client.rb
+- lib/trophy_api_client/admin/leaderboards/client.rb
 - lib/trophy_api_client/admin/metrics/client.rb
 - lib/trophy_api_client/admin/points/boosts/client.rb
 - lib/trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item.rb
@@ -129,6 +130,10 @@ files:
 - lib/trophy_api_client/types/admin_attribute_type.rb
 - lib/trophy_api_client/types/admin_issue.rb
 - lib/trophy_api_client/types/admin_issue_severity.rb
+- lib/trophy_api_client/types/admin_leaderboard.rb
+- lib/trophy_api_client/types/admin_leaderboard_rank_by.rb
+- lib/trophy_api_client/types/admin_leaderboard_run_unit.rb
+- lib/trophy_api_client/types/admin_leaderboard_status.rb
 - lib/trophy_api_client/types/base_streak_response.rb
 - lib/trophy_api_client/types/bulk_streak_response.rb
 - lib/trophy_api_client/types/bulk_streak_response_item.rb
@@ -136,6 +141,12 @@ files:
 - lib/trophy_api_client/types/create_attribute_request_item_type.rb
 - lib/trophy_api_client/types/create_attributes_request.rb
 - lib/trophy_api_client/types/create_attributes_response.rb
+- lib/trophy_api_client/types/create_leaderboard_request_item.rb
+- lib/trophy_api_client/types/create_leaderboard_request_item_rank_by.rb
+- lib/trophy_api_client/types/create_leaderboard_request_item_run_unit.rb
+- lib/trophy_api_client/types/create_leaderboard_request_item_status.rb
+- lib/trophy_api_client/types/create_leaderboards_request.rb
+- lib/trophy_api_client/types/create_leaderboards_response.rb
 - lib/trophy_api_client/types/create_metric_request_item.rb
 - lib/trophy_api_client/types/create_metric_request_item_unit_type.rb
 - lib/trophy_api_client/types/create_metrics_request.rb
@@ -148,6 +159,7 @@ files:
 - lib/trophy_api_client/types/created_points_boost_rounding.rb
 - lib/trophy_api_client/types/created_points_boost_status.rb
 - lib/trophy_api_client/types/delete_attributes_response.rb
+- lib/trophy_api_client/types/delete_leaderboards_response.rb
 - lib/trophy_api_client/types/delete_metrics_response.rb
 - lib/trophy_api_client/types/delete_points_boosts_response.rb
 - lib/trophy_api_client/types/deleted_resource.rb
@@ -162,6 +174,7 @@ files:
 - lib/trophy_api_client/types/leaderboard_response_with_rankings.rb
 - lib/trophy_api_client/types/leaderboard_response_with_rankings_status.rb
 - lib/trophy_api_client/types/list_attributes_response.rb
+- lib/trophy_api_client/types/list_leaderboards_response.rb
 - lib/trophy_api_client/types/list_metrics_response.rb
 - lib/trophy_api_client/types/metric_event_leaderboard_response.rb
 - lib/trophy_api_client/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb
@@ -170,7 +183,6 @@ files:
 - lib/trophy_api_client/types/metric_response.rb
 - lib/trophy_api_client/types/notification_channel.rb
 - lib/trophy_api_client/types/notification_preferences.rb
-- lib/trophy_api_client/types/notification_type.rb
 - lib/trophy_api_client/types/points_award.rb
 - lib/trophy_api_client/types/points_boost.rb
 - lib/trophy_api_client/types/points_boost_rounding.rb
@@ -200,6 +212,12 @@ files:
 - lib/trophy_api_client/types/update_attribute_request_item.rb
 - lib/trophy_api_client/types/update_attributes_request.rb
 - lib/trophy_api_client/types/update_attributes_response.rb
+- lib/trophy_api_client/types/update_leaderboard_request_item.rb
+- lib/trophy_api_client/types/update_leaderboard_request_item_rank_by.rb
+- lib/trophy_api_client/types/update_leaderboard_request_item_run_unit.rb
+- lib/trophy_api_client/types/update_leaderboard_request_item_status.rb
+- lib/trophy_api_client/types/update_leaderboards_request.rb
+- lib/trophy_api_client/types/update_leaderboards_response.rb
 - lib/trophy_api_client/types/update_metric_request_item.rb
 - lib/trophy_api_client/types/update_metric_request_item_unit_type.rb
 - lib/trophy_api_client/types/update_metrics_request.rb

data/lib/trophy_api_client/types/notification_type.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module TrophyApiClient
-  # A type of notification that can be configured.
-  class NotificationType
-    ACHIEVEMENT_COMPLETED = "achievement_completed"
-    RECAP = "recap"
-    REACTIVATION = "reactivation"
-    STREAK_REMINDER = "streak_reminder"
-  end
-end