trophy_api_client 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cdaf3a518aec65ea9ac8a42cca90ad82ce2f3883499544dd997a6c7537191b1
-  data.tar.gz: 5ce1d3525b1f2b512aef8d4f6e9978af1a873278e91eec1b01e1cc71a8b76528
+  metadata.gz: 85edf38a9fc0522a22a62f4e7ad27600c2e1b7376c0fc951d67f2ce590a8fe93
+  data.tar.gz: a5306d1ea30e6ead932faa97c59ca02dca59106e4364c5e715ff45c319913b36
 SHA512:
-  metadata.gz: dc32ea029c845b7a474ccae57aa445bb92d6878cc676f87fce0dd8909258490cc47eb2fea9d6f3bb0b09703018a8fa9ffb7a4075922ded2d015146008ca38772
-  data.tar.gz: 044214ba0e7b581eecfc9534289e41d594dc445abde62ef3de33290206296f5c667491869a5fec27c86f4d9c5fa2f3c8982038b4cdedb22450989f2cc3ef2a37
+  metadata.gz: f9aaf222f94a5076cd95a0c58285b989557211d858804472ac0742cb17afccf1ebd94c77b637d9cfd3381915c9f9df758a05787ae17a0de57403bdd8747c0c9e
+  data.tar.gz: 0bc86ae13782e710a68162a51a7be4e56f7f83bdae39083343d9b9e6b60dad9e3ff7ef1a017ff1ec72a39cd5e104ede0358979d78dd48077dc0c5e7f03883ea2

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/types/leaderboard_event.rb

@@ -5,9 +5,12 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
-  # A leaderboard event representing a change in a user's rank or value.
+  # A daily leaderboard snapshot entry representing the user's rank/value state and
+  #  the previous persisted state.
   class LeaderboardEvent
-    # @return [DateTime] The timestamp when the event occurred.
+    # @return [String] The leaderboard snapshot date in YYYY-MM-DD format.
+    attr_reader :date
+    # @return [DateTime] Deprecated ISO timestamp for the snapshot day boundary. Use `date` instead.
     attr_reader :timestamp
     # @return [Integer] The user's rank before this event, or null if they were not on the leaderboard.
     attr_reader :previous_rank
@@ -27,7 +30,8 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param timestamp [DateTime] The timestamp when the event occurred.
+    # @param date [String] The leaderboard snapshot date in YYYY-MM-DD format.
+    # @param timestamp [DateTime] Deprecated ISO timestamp for the snapshot day boundary. Use `date` instead.
     # @param previous_rank [Integer] The user's rank before this event, or null if they were not on the leaderboard.
     # @param rank [Integer] The user's rank after this event, or null if they are no longer on the
     #  leaderboard.
@@ -36,15 +40,17 @@ module TrophyApiClient
     #  leaderboard.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::LeaderboardEvent]
-    def initialize(timestamp: OMIT, previous_rank: OMIT, rank: OMIT, previous_value: OMIT, value: OMIT,
+    def initialize(date:, timestamp:, previous_rank: OMIT, rank: OMIT, previous_value: OMIT, value: OMIT,
                    additional_properties: nil)
-      @timestamp = timestamp if timestamp != OMIT
+      @date = date
+      @timestamp = timestamp
       @previous_rank = previous_rank if previous_rank != OMIT
       @rank = rank if rank != OMIT
       @previous_value = previous_value if previous_value != OMIT
       @value = value if value != OMIT
       @additional_properties = additional_properties
       @_field_set = {
+        "date": date,
         "timestamp": timestamp,
         "previousRank": previous_rank,
         "rank": rank,
@@ -62,12 +68,14 @@ module TrophyApiClient
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      date = parsed_json["date"]
       timestamp = (DateTime.parse(parsed_json["timestamp"]) unless parsed_json["timestamp"].nil?)
       previous_rank = parsed_json["previousRank"]
       rank = parsed_json["rank"]
       previous_value = parsed_json["previousValue"]
       value = parsed_json["value"]
       new(
+        date: date,
         timestamp: timestamp,
         previous_rank: previous_rank,
         rank: rank,
@@ -91,7 +99,8 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+      obj.date.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
+      obj.timestamp.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
       obj.previous_rank&.is_a?(Integer) != false || raise("Passed value for field obj.previous_rank is not the expected type, validation failed.")
       obj.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
       obj.previous_value&.is_a?(Integer) != false || raise("Passed value for field obj.previous_value is not the expected type, validation failed.")

data/lib/trophy_api_client/types/user_leaderboard_response_with_history.rb

@@ -9,7 +9,7 @@ require "json"
 module TrophyApiClient
   # A user's data for a specific leaderboard including rank, value, and history.
   class UserLeaderboardResponseWithHistory
-    # @return [Array<TrophyApiClient::LeaderboardEvent>] An array of events showing the user's rank and value changes over time.
+    # @return [Array<TrophyApiClient::LeaderboardEvent>] An array of daily change events showing the user's rank and value over time.
     attr_reader :history
     # @return [Integer] The user's current rank in this leaderboard. Null if the user is not on the
     #  leaderboard.
@@ -60,7 +60,7 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param history [Array<TrophyApiClient::LeaderboardEvent>] An array of events showing the user's rank and value changes over time.
+    # @param history [Array<TrophyApiClient::LeaderboardEvent>] An array of daily change events showing the user's rank and value over time.
     # @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

data/lib/trophy_api_client/users/client.rb

@@ -582,13 +582,13 @@ module TrophyApiClient
       end
     end
 
-    # Get a user's rank, value, and history for a specific leaderboard.
+    # Get a user's rank, value, and daily ranking history for a specific leaderboard.
     #
     # @param id [String] The user's ID in your database.
     # @param key [String] Unique key of the leaderboard as set when created.
     # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
     #  run.
-    # @param num_events [Integer] The number of events to return in the history array.
+    # @param num_events [Integer] The number of days to return in the leaderboard history for the user.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::UserLeaderboardResponseWithHistory]
     # @example
@@ -1252,13 +1252,13 @@ module TrophyApiClient
       end
     end
 
-    # Get a user's rank, value, and history for a specific leaderboard.
+    # Get a user's rank, value, and daily ranking history for a specific leaderboard.
     #
     # @param id [String] The user's ID in your database.
     # @param key [String] Unique key of the leaderboard as set when created.
     # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
     #  run.
-    # @param num_events [Integer] The number of events to return in the history array.
+    # @param num_events [Integer] The number of days to return in the leaderboard history for the user.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::UserLeaderboardResponseWithHistory]
     # @example

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.10.0"
+  VERSION = "1.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Trophy Labs, Inc