trophy_api_client 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53980f53595d29d00f98c8417ae38f192c42eb899139036238aff75acd9a8b5a
-  data.tar.gz: fd0a8b34d06eea9ea76d68278384a6dff6189543d8288679b8965632ac3f8bde
+  metadata.gz: 63cf1c72d377d4e597ede4a41d8114467eb3234e3aa16322447a03ea2a27fc0a
+  data.tar.gz: 17dd217600b02a7ec867e9a2ffed08baafa6761d159638c1ae9058994848920f
 SHA512:
-  metadata.gz: a05179e86d3577f0ac681e87434b3c8260bd46de6f0233b69a65afc2802330fe6421c5cdb5f54e7dad967c7528381b9cd66291f9de833f38c2161430e8aba87a
-  data.tar.gz: 8821f372ad08068762223ba56af83134916e901f653988ce816626cbdf5f39c403be07d99f9736bab53a8f8621e531742a3c241219030b453642941ca120cd13
+  metadata.gz: 7e7a475bcefa4b4935e398395e7a0fd365006a170442ca1f86534f28d26a229d46336f967a4877eab8fda1092241e818d50cb32d6c916a8d92f370c153a0f3bb
+  data.tar.gz: 74b391c48f09d09b03f4fa6b7b2da9e47869b831bb4a5842a67eef233a89bf0132975ccf6d4e4e4e5d55aaa64d7ddc643ef59c3291e8fd2a0ce448e3b2910405

data/lib/gemconfig.rb

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

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/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.12.0"
+  VERSION = "1.13.0"
 end

data/lib/types_export.rb

@@ -71,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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -270,7 +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_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