trophy_api_client 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cdaf3a518aec65ea9ac8a42cca90ad82ce2f3883499544dd997a6c7537191b1
-  data.tar.gz: 5ce1d3525b1f2b512aef8d4f6e9978af1a873278e91eec1b01e1cc71a8b76528
+  metadata.gz: 53980f53595d29d00f98c8417ae38f192c42eb899139036238aff75acd9a8b5a
+  data.tar.gz: fd0a8b34d06eea9ea76d68278384a6dff6189543d8288679b8965632ac3f8bde
 SHA512:
-  metadata.gz: dc32ea029c845b7a474ccae57aa445bb92d6878cc676f87fce0dd8909258490cc47eb2fea9d6f3bb0b09703018a8fa9ffb7a4075922ded2d015146008ca38772
-  data.tar.gz: 044214ba0e7b581eecfc9534289e41d594dc445abde62ef3de33290206296f5c667491869a5fec27c86f4d9c5fa2f3c8982038b4cdedb22450989f2cc3ef2a37
+  metadata.gz: a05179e86d3577f0ac681e87434b3c8260bd46de6f0233b69a65afc2802330fe6421c5cdb5f54e7dad967c7528381b9cd66291f9de833f38c2161430e8aba87a
+  data.tar.gz: 8821f372ad08068762223ba56af83134916e901f653988ce816626cbdf5f39c403be07d99f9736bab53a8f8621e531742a3c241219030b453642941ca120cd13

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/streaks/client.rb

@@ -3,8 +3,6 @@
 require_relative "../../requests"
 require_relative "../types/bulk_streak_response"
 require "json"
-require_relative "types/streaks_rankings_request_type"
-require_relative "../types/streak_ranking_user"
 require "async"
 
 module TrophyApiClient
@@ -53,42 +51,6 @@ module TrophyApiClient
         TrophyApiClient::BulkStreakResponseItem.from_json(json_object: item)
       end
     end
-
-    # Get the top users by streak length (active or longest).
-    #
-    # @param limit [Integer] Number of users to return. Must be between 1 and 100.
-    # @param type [TrophyApiClient::Streaks::StreaksRankingsRequestType] Whether to rank users by active streaks or longest streaks ever achieved.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::StreakRankingUser>]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.streaks.rankings(limit: 1, type: ACTIVE)
-    def rankings(limit: nil, type: 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 || {}), "limit": limit, "type": type }.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)}/streaks/rankings"
-      end
-      parsed_json = JSON.parse(response.body)
-      parsed_json&.map do |item|
-        item = item.to_json
-        TrophyApiClient::StreakRankingUser.from_json(json_object: item)
-      end
-    end
   end
 
   class AsyncStreaksClient
@@ -138,43 +100,5 @@ module TrophyApiClient
         end
       end
     end
-
-    # Get the top users by streak length (active or longest).
-    #
-    # @param limit [Integer] Number of users to return. Must be between 1 and 100.
-    # @param type [TrophyApiClient::Streaks::StreaksRankingsRequestType] Whether to rank users by active streaks or longest streaks ever achieved.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::StreakRankingUser>]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.streaks.rankings(limit: 1, type: ACTIVE)
-    def rankings(limit: nil, type: 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 || {}), "limit": limit, "type": type }.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)}/streaks/rankings"
-        end
-        parsed_json = JSON.parse(response.body)
-        parsed_json&.map do |item|
-          item = item.to_json
-          TrophyApiClient::StreakRankingUser.from_json(json_object: item)
-        end
-      end
-    end
   end
 end

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/streak_response.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "date"
 require_relative "streak_response_streak_history_item"
 require_relative "streak_frequency"
 require "ostruct"
@@ -8,12 +9,12 @@ require "json"
 module TrophyApiClient
   # An object representing the user's streak.
   class StreakResponse
+    # @return [DateTime] The timestamp the streak was most recently extended. Null if the streak is not
+    #  active.
+    attr_reader :extended
     # @return [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
     #  period includes the start and end dates and the length of the streak.
     attr_reader :streak_history
-    # @return [Integer] Deprecated. The user's rank across all users. Null if the user has no active
-    #  streak.
-    attr_reader :rank
     # @return [Integer] The length of the user's current streak.
     attr_reader :length
     # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
@@ -46,10 +47,10 @@ module TrophyApiClient
 
     OMIT = Object.new
 
+    # @param extended [DateTime] The timestamp the streak was most recently extended. Null if the streak is not
+    #  active.
     # @param streak_history [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
     #  period includes the start and end dates and the length of the streak.
-    # @param rank [Integer] Deprecated. The user's rank across all users. Null if the user has no active
-    #  streak.
     # @param length [Integer] The length of the user's current streak.
     # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
     # @param started [String] The date the streak started.
@@ -66,10 +67,10 @@ module TrophyApiClient
     #  the organization has enabled streak freeze auto-earn.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::StreakResponse]
-    def initialize(length:, frequency:, streak_history: OMIT, rank: OMIT, started: OMIT, period_start: OMIT,
+    def initialize(streak_history:, length:, frequency:, extended: OMIT, started: OMIT, period_start: OMIT,
                    period_end: OMIT, expires: OMIT, freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
-      @streak_history = streak_history if streak_history != OMIT
-      @rank = rank if rank != OMIT
+      @extended = extended if extended != OMIT
+      @streak_history = streak_history
       @length = length
       @frequency = frequency
       @started = started if started != OMIT
@@ -82,8 +83,8 @@ module TrophyApiClient
       @freeze_auto_earn_amount = freeze_auto_earn_amount if freeze_auto_earn_amount != OMIT
       @additional_properties = additional_properties
       @_field_set = {
+        "extended": extended,
         "streakHistory": streak_history,
-        "rank": rank,
         "length": length,
         "frequency": frequency,
         "started": started,
@@ -106,11 +107,11 @@ module TrophyApiClient
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      extended = (DateTime.parse(parsed_json["extended"]) unless parsed_json["extended"].nil?)
       streak_history = parsed_json["streakHistory"]&.map do |item|
         item = item.to_json
         TrophyApiClient::StreakResponseStreakHistoryItem.from_json(json_object: item)
       end
-      rank = parsed_json["rank"]
       length = parsed_json["length"]
       frequency = parsed_json["frequency"]
       started = parsed_json["started"]
@@ -122,8 +123,8 @@ module TrophyApiClient
       freeze_auto_earn_interval = parsed_json["freezeAutoEarnInterval"]
       freeze_auto_earn_amount = parsed_json["freezeAutoEarnAmount"]
       new(
+        extended: extended,
         streak_history: streak_history,
-        rank: rank,
         length: length,
         frequency: frequency,
         started: started,
@@ -152,8 +153,8 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.streak_history&.is_a?(Array) != false || raise("Passed value for field obj.streak_history 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.extended&.is_a?(DateTime) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
+      obj.streak_history.is_a?(Array) != false || raise("Passed value for field obj.streak_history is not the expected type, validation failed.")
       obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
       obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
       obj.started&.is_a?(String) != false || raise("Passed value for field obj.started 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.12.0"
 end

data/lib/types_export.rb

@@ -4,7 +4,6 @@ require_relative "trophy_api_client/users/types/users_metric_event_summary_reque
 require_relative "trophy_api_client/users/types/users_metric_event_summary_response_item"
 require_relative "trophy_api_client/users/types/users_points_event_summary_request_aggregation"
 require_relative "trophy_api_client/users/types/users_points_event_summary_response_item"
-require_relative "trophy_api_client/streaks/types/streaks_rankings_request_type"
 require_relative "trophy_api_client/leaderboards/types/leaderboards_all_response_item_status"
 require_relative "trophy_api_client/leaderboards/types/leaderboards_all_response_item"
 require_relative "trophy_api_client/admin/streaks/types/restore_streaks_request_users_item"
@@ -79,7 +78,6 @@ require_relative "trophy_api_client/types/event_response"
 require_relative "trophy_api_client/types/points_range"
 require_relative "trophy_api_client/types/points_summary_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.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -120,7 +120,6 @@ files:
 - lib/trophy_api_client/metrics/client.rb
 - lib/trophy_api_client/points/client.rb
 - lib/trophy_api_client/streaks/client.rb
-- lib/trophy_api_client/streaks/types/streaks_rankings_request_type.rb
 - lib/trophy_api_client/types/achievement_completion_response.rb
 - lib/trophy_api_client/types/achievement_response.rb
 - lib/trophy_api_client/types/achievement_response_event_attribute.rb
@@ -272,7 +271,6 @@ files:
 - lib/trophy_api_client/types/points_trigger_user_attributes_item.rb
 - lib/trophy_api_client/types/restore_streaks_response.rb
 - lib/trophy_api_client/types/streak_frequency.rb
-- lib/trophy_api_client/types/streak_ranking_user.rb
 - lib/trophy_api_client/types/streak_response.rb
 - lib/trophy_api_client/types/streak_response_streak_history_item.rb
 - lib/trophy_api_client/types/update_attribute_request_item.rb

data/lib/trophy_api_client/streaks/types/streaks_rankings_request_type.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module TrophyApiClient
-  class Streaks
-    class StreaksRankingsRequestType
-      ACTIVE = "active"
-      LONGEST = "longest"
-    end
-  end
-end

data/lib/trophy_api_client/types/streak_ranking_user.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # A user with their streak length in the rankings.
-  class StreakRankingUser
-    # @return [String] The ID of the user.
-    attr_reader :user_id
-    # @return [String] The name of the user. May be null if no name is set.
-    attr_reader :name
-    # @return [Integer] The user's streak length (active or longest depending on query parameter).
-    attr_reader :streak_length
-    # @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 user_id [String] The ID of the user.
-    # @param name [String] The name of the user. May be null if no name is set.
-    # @param streak_length [Integer] The user's streak length (active or longest depending on query parameter).
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::StreakRankingUser]
-    def initialize(user_id:, streak_length:, name: OMIT, additional_properties: nil)
-      @user_id = user_id
-      @name = name if name != OMIT
-      @streak_length = streak_length
-      @additional_properties = additional_properties
-      @_field_set = { "userId": user_id, "name": name, "streakLength": streak_length }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of StreakRankingUser
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::StreakRankingUser]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      user_id = parsed_json["userId"]
-      name = parsed_json["name"]
-      streak_length = parsed_json["streakLength"]
-      new(
-        user_id: user_id,
-        name: name,
-        streak_length: streak_length,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of StreakRankingUser 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.user_id.is_a?(String) != false || raise("Passed value for field obj.user_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.streak_length.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
-    end
-  end
-end