trophy_api_client 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85edf38a9fc0522a22a62f4e7ad27600c2e1b7376c0fc951d67f2ce590a8fe93
-  data.tar.gz: a5306d1ea30e6ead932faa97c59ca02dca59106e4364c5e715ff45c319913b36
+  metadata.gz: 63cf1c72d377d4e597ede4a41d8114467eb3234e3aa16322447a03ea2a27fc0a
+  data.tar.gz: 17dd217600b02a7ec867e9a2ffed08baafa6761d159638c1ae9058994848920f
 SHA512:
-  metadata.gz: f9aaf222f94a5076cd95a0c58285b989557211d858804472ac0742cb17afccf1ebd94c77b637d9cfd3381915c9f9df758a05787ae17a0de57403bdd8747c0c9e
-  data.tar.gz: 0bc86ae13782e710a68162a51a7be4e56f7f83bdae39083343d9b9e6b60dad9e3ff7ef1a017ff1ec72a39cd5e104ede0358979d78dd48077dc0c5e7f03883ea2
+  metadata.gz: 7e7a475bcefa4b4935e398395e7a0fd365006a170442ca1f86534f28d26a229d46336f967a4877eab8fda1092241e818d50cb32d6c916a8d92f370c153a0f3bb
+  data.tar.gz: 74b391c48f09d09b03f4fa6b7b2da9e47869b831bb4a5842a67eef233a89bf0132975ccf6d4e4e4e5d55aaa64d7ddc643ef59c3291e8fd2a0ce448e3b2910405

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.11.0"
+    VERSION = "1.13.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/streak_evaluation_mode_preference.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # Whether meeting any single metric threshold (`OR`) or all configured metric
+  #  thresholds (`AND`) extends the user's streak. Matches the evaluation mode
+  #  configured in dashboard streak settings.
+  class StreakEvaluationModePreference
+    OR = "OR"
+    AND = "AND"
+  end
+end

data/lib/trophy_api_client/types/streak_metric_preference.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Per-metric streak threshold override for a user.
+  class StreakMetricPreference
+    # @return [String] The metric key.
+    attr_reader :key
+    # @return [Float] Minimum metric change in a streak period to count toward the streak.
+    attr_reader :threshold
+    # @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 key [String] The metric key.
+    # @param threshold [Float] Minimum metric change in a streak period to count toward the streak.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::StreakMetricPreference]
+    def initialize(key:, threshold:, additional_properties: nil)
+      @key = key
+      @threshold = threshold
+      @additional_properties = additional_properties
+      @_field_set = { "key": key, "threshold": threshold }
+    end
+
+    # Deserialize a JSON object to an instance of StreakMetricPreference
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::StreakMetricPreference]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      key = parsed_json["key"]
+      threshold = parsed_json["threshold"]
+      new(
+        key: key,
+        threshold: threshold,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StreakMetricPreference 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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+      obj.threshold.is_a?(Float) != false || raise("Passed value for field obj.threshold is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/streak_preferences.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "streak_evaluation_mode_preference"
+require_relative "streak_metric_preference"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Per-user streak configuration. Requires streak customization to be enabled in
+  #  dashboard settings.
+  class StreakPreferences
+    # @return [TrophyApiClient::StreakEvaluationModePreference]
+    attr_reader :evaluation_mode
+    # @return [Array<TrophyApiClient::StreakMetricPreference>] Metrics and thresholds that count toward this user's streak.
+    attr_reader :metrics
+    # @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 evaluation_mode [TrophyApiClient::StreakEvaluationModePreference]
+    # @param metrics [Array<TrophyApiClient::StreakMetricPreference>] Metrics and thresholds that count toward this user's streak.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::StreakPreferences]
+    def initialize(evaluation_mode: OMIT, metrics: OMIT, additional_properties: nil)
+      @evaluation_mode = evaluation_mode if evaluation_mode != OMIT
+      @metrics = metrics if metrics != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "evaluationMode": evaluation_mode, "metrics": metrics }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of StreakPreferences
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::StreakPreferences]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      evaluation_mode = parsed_json["evaluationMode"]
+      metrics = parsed_json["metrics"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::StreakMetricPreference.from_json(json_object: item)
+      end
+      new(
+        evaluation_mode: evaluation_mode,
+        metrics: metrics,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of StreakPreferences 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.evaluation_mode&.is_a?(TrophyApiClient::StreakEvaluationModePreference) != false || raise("Passed value for field obj.evaluation_mode is not the expected type, validation failed.")
+      obj.metrics&.is_a?(Array) != false || raise("Passed value for field obj.metrics is not the expected type, validation failed.")
+    end
+  end
+end

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_preferences_response.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "notification_preferences"
+require_relative "streak_preferences"
 require "ostruct"
 require "json"
 
@@ -9,6 +10,8 @@ module TrophyApiClient
   class UserPreferencesResponse
     # @return [TrophyApiClient::NotificationPreferences]
     attr_reader :notifications
+    # @return [TrophyApiClient::StreakPreferences]
+    attr_reader :streak
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -18,12 +21,16 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param notifications [TrophyApiClient::NotificationPreferences]
+    # @param streak [TrophyApiClient::StreakPreferences]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::UserPreferencesResponse]
-    def initialize(notifications:, additional_properties: nil)
+    def initialize(notifications:, streak: OMIT, additional_properties: nil)
       @notifications = notifications
+      @streak = streak if streak != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "notifications": notifications }
+      @_field_set = { "notifications": notifications, "streak": streak }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of UserPreferencesResponse
@@ -39,7 +46,17 @@ module TrophyApiClient
         notifications = parsed_json["notifications"].to_json
         notifications = TrophyApiClient::NotificationPreferences.from_json(json_object: notifications)
       end
-      new(notifications: notifications, additional_properties: struct)
+      if parsed_json["streak"].nil?
+        streak = nil
+      else
+        streak = parsed_json["streak"].to_json
+        streak = TrophyApiClient::StreakPreferences.from_json(json_object: streak)
+      end
+      new(
+        notifications: notifications,
+        streak: streak,
+        additional_properties: struct
+      )
     end
 
     # Serialize an instance of UserPreferencesResponse to a JSON object
@@ -57,6 +74,7 @@ module TrophyApiClient
     # @return [Void]
     def self.validate_raw(obj:)
       TrophyApiClient::NotificationPreferences.validate_raw(obj: obj.notifications)
+      obj.streak.nil? || TrophyApiClient::StreakPreferences.validate_raw(obj: obj.streak)
     end
   end
 end

data/lib/trophy_api_client/users/client.rb

@@ -6,6 +6,7 @@ require_relative "../types/user"
 require_relative "../types/updated_user"
 require_relative "../types/user_preferences_response"
 require_relative "../types/notification_preferences"
+require_relative "../types/streak_preferences"
 require_relative "../types/metric_response"
 require "json"
 require_relative "types/users_metric_event_summary_request_aggregation"
@@ -211,7 +212,8 @@ module TrophyApiClient
       TrophyApiClient::UserPreferencesResponse.from_json(json_object: response.body)
     end
 
-    # Update a user's notification preferences.
+    # Update a user's notification and streak preferences. Streak preferences require
+    #  streak customization to be enabled in your Trophy dashboard settings.
     #
     # @param id [String] The user's ID in your database.
     # @param notifications [Hash] Request of type TrophyApiClient::NotificationPreferences, as a Hash
@@ -219,6 +221,9 @@ module TrophyApiClient
     #   * :recap (Array<TrophyApiClient::NotificationChannel>)
     #   * :reactivation (Array<TrophyApiClient::NotificationChannel>)
     #   * :streak_reminder (Array<TrophyApiClient::NotificationChannel>)
+    # @param streak [Hash] Request of type TrophyApiClient::StreakPreferences, as a Hash
+    #   * :evaluation_mode (TrophyApiClient::StreakEvaluationModePreference)
+    #   * :metrics (Array<TrophyApiClient::StreakMetricPreference>)
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::UserPreferencesResponse]
     # @example
@@ -228,7 +233,7 @@ module TrophyApiClient
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.users.update_preferences(id: "user-123", notifications: { streak_reminder: [EMAIL] })
-    def update_preferences(id:, notifications: nil, request_options: nil)
+    def update_preferences(id:, notifications: nil, streak: nil, request_options: nil)
       response = @request_client.conn.patch 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?
@@ -241,7 +246,11 @@ module TrophyApiClient
         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 || {}), notifications: notifications }.compact
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          notifications: notifications,
+          streak: streak
+        }.compact
         req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/users/#{id}/preferences"
       end
       TrophyApiClient::UserPreferencesResponse.from_json(json_object: response.body)
@@ -862,7 +871,8 @@ module TrophyApiClient
       end
     end
 
-    # Update a user's notification preferences.
+    # Update a user's notification and streak preferences. Streak preferences require
+    #  streak customization to be enabled in your Trophy dashboard settings.
     #
     # @param id [String] The user's ID in your database.
     # @param notifications [Hash] Request of type TrophyApiClient::NotificationPreferences, as a Hash
@@ -870,6 +880,9 @@ module TrophyApiClient
     #   * :recap (Array<TrophyApiClient::NotificationChannel>)
     #   * :reactivation (Array<TrophyApiClient::NotificationChannel>)
     #   * :streak_reminder (Array<TrophyApiClient::NotificationChannel>)
+    # @param streak [Hash] Request of type TrophyApiClient::StreakPreferences, as a Hash
+    #   * :evaluation_mode (TrophyApiClient::StreakEvaluationModePreference)
+    #   * :metrics (Array<TrophyApiClient::StreakMetricPreference>)
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::UserPreferencesResponse]
     # @example
@@ -879,7 +892,7 @@ module TrophyApiClient
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.users.update_preferences(id: "user-123", notifications: { streak_reminder: [EMAIL] })
-    def update_preferences(id:, notifications: nil, request_options: nil)
+    def update_preferences(id:, notifications: nil, streak: nil, request_options: nil)
       Async do
         response = @request_client.conn.patch do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -893,7 +906,11 @@ module TrophyApiClient
           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 || {}), notifications: notifications }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            notifications: notifications,
+            streak: streak
+          }.compact
           req.url "#{@request_client.get_url(environment: api,
                                              request_options: request_options)}/users/#{id}/preferences"
         end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.11.0"
+  VERSION = "1.13.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"
@@ -72,6 +71,9 @@ 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_preferences"
+require_relative "trophy_api_client/types/streak_evaluation_mode_preference"
+require_relative "trophy_api_client/types/streak_metric_preference"
+require_relative "trophy_api_client/types/streak_preferences"
 require_relative "trophy_api_client/types/user_preferences_response"
 require_relative "trophy_api_client/types/error_body"
 require_relative "trophy_api_client/types/achievement_completion_response"
@@ -79,7 +81,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.11.0
+  version: 1.13.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
@@ -271,8 +270,10 @@ files:
 - lib/trophy_api_client/types/points_trigger_type.rb
 - 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_evaluation_mode_preference.rb
 - lib/trophy_api_client/types/streak_frequency.rb
-- lib/trophy_api_client/types/streak_ranking_user.rb
+- lib/trophy_api_client/types/streak_metric_preference.rb
+- lib/trophy_api_client/types/streak_preferences.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