trophy_api_client 1.27.0 → 1.29.0

data/lib/trophy/types/update_reward_request_item_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdateRewardRequestItemUserAttributesItem < Internal::Types::Model
+      field :attribute_id, -> { String }, optional: false, nullable: false, api_name: "attributeId"
+
+      field :attribute_value, -> { String }, optional: false, nullable: false, api_name: "attributeValue"
+    end
+  end
+end

data/lib/trophy/types/update_reward_triggers_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateRewardTriggersRequest
+      # UpdateRewardTriggersRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/update_reward_triggers_request_item.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdateRewardTriggersRequestItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { Trophy::Types::UpdateRewardTriggersRequestItemType }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::UpdateRewardTriggersRequestItemStatus }, optional: true, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::UpdateRewardTriggersRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+
+      field :metric_id, -> { String }, optional: true, nullable: false, api_name: "metricId"
+
+      field :metric_threshold, -> { Integer }, optional: true, nullable: false, api_name: "metricThreshold"
+
+      field :event_attributes, -> { Internal::Types::Array[Trophy::Types::UpdateRewardTriggersRequestItemEventAttributesItem] }, optional: true, nullable: false, api_name: "eventAttributes"
+
+      field :achievement_id, -> { String }, optional: true, nullable: false, api_name: "achievementId"
+
+      field :streak_length, -> { Integer }, optional: true, nullable: false, api_name: "streakLength"
+
+      field :leaderboard_id, -> { String }, optional: true, nullable: false, api_name: "leaderboardId"
+
+      field :rank, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_reward_triggers_request_item_event_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdateRewardTriggersRequestItemEventAttributesItem < Internal::Types::Model
+      field :attribute_id, -> { String }, optional: false, nullable: false, api_name: "attributeId"
+
+      field :attribute_value, -> { String }, optional: false, nullable: false, api_name: "attributeValue"
+    end
+  end
+end

data/lib/trophy/types/update_reward_triggers_request_item_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateRewardTriggersRequestItemStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      INACTIVE = "inactive"
+    end
+  end
+end

data/lib/trophy/types/update_reward_triggers_request_item_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateRewardTriggersRequestItemType
+      extend Trophy::Internal::Types::Enum
+
+      METRIC = "metric"
+      ACHIEVEMENT = "achievement"
+      STREAK = "streak"
+      LEADERBOARD = "leaderboard"
+    end
+  end
+end

data/lib/trophy/types/update_reward_triggers_request_item_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdateRewardTriggersRequestItemUserAttributesItem < Internal::Types::Model
+      field :attribute_id, -> { String }, optional: false, nullable: false, api_name: "attributeId"
+
+      field :attribute_value, -> { String }, optional: false, nullable: false, api_name: "attributeValue"
+    end
+  end
+end

data/lib/trophy/types/update_reward_triggers_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing updated triggers and any issues encountered.
+    class UpdateRewardTriggersResponse < Internal::Types::Model
+      field :updated, -> { Internal::Types::Array[Trophy::Types::AdminRewardTrigger] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_rewards_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateRewardsRequest
+      # UpdateRewardsRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/update_rewards_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing updated rewards and any per-item issues.
+    class UpdateRewardsResponse < Internal::Types::Model
+      field :updated, -> { Internal::Types::Array[Trophy::Types::AdminReward] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/user.rb

@@ -22,6 +22,8 @@ module Trophy
 
       field :control, -> { Internal::Types::Boolean }, optional: false, nullable: false
 
+      field :agentic_messaging_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "agenticMessagingEnabled"
+
       field :created, -> { String }, optional: false, nullable: false
 
       field :updated, -> { String }, optional: false, nullable: false

data/lib/trophy/types/user_reward_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UserRewardResponse < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :awarded_at, -> { String }, optional: false, nullable: false, api_name: "awardedAt"
+
+      field :redeemed, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :redeemed_at, -> { String }, optional: true, nullable: false, api_name: "redeemedAt"
+
+      field :reward, -> { Trophy::Types::RewardSummary }, optional: false, nullable: false
+
+      field :trigger, -> { Trophy::Types::UserRewardTrigger }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/user_reward_trigger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The trigger that awarded the reward, as it is configured now. Only the fields for the trigger's current type are
+    # included.
+    class UserRewardTrigger < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { Trophy::Types::UserRewardTriggerType }, optional: false, nullable: false
+
+      field :metric_id, -> { String }, optional: true, nullable: false, api_name: "metricId"
+
+      field :metric_threshold, -> { Integer }, optional: true, nullable: false, api_name: "metricThreshold"
+
+      field :achievement_id, -> { String }, optional: true, nullable: false, api_name: "achievementId"
+
+      field :streak_length_threshold, -> { Integer }, optional: true, nullable: false, api_name: "streakLengthThreshold"
+
+      field :leaderboard_id, -> { String }, optional: true, nullable: false, api_name: "leaderboardId"
+
+      field :rank, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/user_reward_trigger_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UserRewardTriggerType
+      extend Trophy::Internal::Types::Enum
+
+      METRIC = "metric"
+      ACHIEVEMENT = "achievement"
+      STREAK = "streak"
+      LEADERBOARD = "leaderboard"
+    end
+  end
+end

data/lib/trophy/users/client.rb

@@ -372,6 +372,51 @@ module Trophy
         raise error_class.new(response.body, code: code)
       end
 
+      # Get rewards awarded to a user. Filter by redeemed state and the date the reward was awarded.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :id
+      # @option params [Boolean, nil] :redeemed
+      # @option params [String, nil] :start_date
+      # @option params [String, nil] :end_date
+      # @option params [Integer, nil] :skip
+      # @option params [Integer, nil] :limit
+      #
+      # @return [Array[Trophy::Types::UserRewardResponse]]
+      def rewards(request_options: {}, **params)
+        params = Trophy::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["redeemed"] = params[:redeemed] if params.key?(:redeemed)
+        query_params["startDate"] = params[:start_date] if params.key?(:start_date)
+        query_params["endDate"] = params[:end_date] if params.key?(:end_date)
+        query_params["skip"] = params[:skip] if params.key?(:skip)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+
+        request = Trophy::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "GET",
+          path: "users/#{URI.encode_uri_component(params[:id].to_s)}/rewards",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Trophy::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
       # Get a user's streak data.
       #
       # @param request_options [Hash]

data/lib/trophy/users/types/users_rewards_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Users
+    module Types
+      class UsersRewardsRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :redeemed, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :start_date, -> { String }, optional: true, nullable: false, api_name: "startDate"
+
+        field :end_date, -> { String }, optional: true, nullable: false, api_name: "endDate"
+
+        field :skip, -> { Integer }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/trophy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trophy
-  VERSION = "1.27.0"
+  VERSION = "1.29.0"
 end

data/lib/trophy.rb

@@ -124,6 +124,11 @@ require_relative "trophy/types/streak_metric_preference"
 require_relative "trophy/types/streak_preferences"
 require_relative "trophy/types/user_preferences_response"
 require_relative "trophy/types/error_body"
+require_relative "trophy/types/reward_summary_type"
+require_relative "trophy/types/reward_summary"
+require_relative "trophy/types/user_reward_trigger_type"
+require_relative "trophy/types/user_reward_trigger"
+require_relative "trophy/types/user_reward_response"
 require_relative "trophy/types/achievement_completion_response"
 require_relative "trophy/types/event_response"
 require_relative "trophy/types/points_range"
@@ -142,6 +147,11 @@ require_relative "trophy/types/wrapped_most_active_month"
 require_relative "trophy/types/wrapped_entire_year"
 require_relative "trophy/types/wrapped_activity"
 require_relative "trophy/types/wrapped_response"
+require_relative "trophy/types/redeemed_reward"
+require_relative "trophy/types/redeem_reward_response"
+require_relative "trophy/types/reward_webhook_event_type"
+require_relative "trophy/types/reward_webhook_event_redemption"
+require_relative "trophy/types/reward_webhook_event"
 require_relative "trophy/types/admin_error_body"
 require_relative "trophy/types/batch_metric_event_user"
 require_relative "trophy/types/batch_metric_event"
@@ -324,16 +334,59 @@ require_relative "trophy/types/update_tenant_request_item"
 require_relative "trophy/types/update_tenants_request"
 require_relative "trophy/types/update_tenants_response"
 require_relative "trophy/types/delete_tenants_response"
+require_relative "trophy/types/create_reward_trigger_request_item_type"
+require_relative "trophy/types/create_reward_trigger_request_item_status"
+require_relative "trophy/types/create_reward_trigger_request_item_user_attributes_item"
+require_relative "trophy/types/create_reward_trigger_request_item_event_attributes_item"
+require_relative "trophy/types/create_reward_trigger_request_item"
+require_relative "trophy/types/create_reward_triggers_request"
+require_relative "trophy/types/admin_reward_trigger_type"
+require_relative "trophy/types/admin_reward_trigger_status"
+require_relative "trophy/types/admin_reward_trigger_user_attributes_item"
+require_relative "trophy/types/admin_reward_trigger_event_attributes_item"
+require_relative "trophy/types/admin_reward_trigger"
+require_relative "trophy/types/list_reward_triggers_response"
+require_relative "trophy/types/create_reward_triggers_response"
+require_relative "trophy/types/update_reward_triggers_request_item_type"
+require_relative "trophy/types/update_reward_triggers_request_item_status"
+require_relative "trophy/types/update_reward_triggers_request_item_user_attributes_item"
+require_relative "trophy/types/update_reward_triggers_request_item_event_attributes_item"
+require_relative "trophy/types/update_reward_triggers_request_item"
+require_relative "trophy/types/update_reward_triggers_request"
+require_relative "trophy/types/update_reward_triggers_response"
+require_relative "trophy/types/delete_reward_triggers_response"
+require_relative "trophy/types/create_reward_request_item_status"
+require_relative "trophy/types/create_reward_request_item_type"
+require_relative "trophy/types/create_reward_request_item_user_attributes_item"
+require_relative "trophy/types/create_reward_request_item"
+require_relative "trophy/types/create_rewards_request"
+require_relative "trophy/types/admin_reward_status"
+require_relative "trophy/types/admin_reward_type"
+require_relative "trophy/types/admin_reward_user_attributes_item"
+require_relative "trophy/types/admin_reward"
+require_relative "trophy/types/created_admin_reward"
+require_relative "trophy/types/list_rewards_response"
+require_relative "trophy/types/create_rewards_response"
+require_relative "trophy/types/update_reward_request_item_status"
+require_relative "trophy/types/update_reward_request_item_type"
+require_relative "trophy/types/update_reward_request_item_user_attributes_item"
+require_relative "trophy/types/update_reward_request_item"
+require_relative "trophy/types/update_rewards_request"
+require_relative "trophy/types/update_rewards_response"
+require_relative "trophy/types/delete_rewards_response"
 require_relative "trophy/client"
 require_relative "trophy/achievements/client"
 require_relative "trophy/achievements/types/achievements_all_request"
 require_relative "trophy/achievements/types/achievements_complete_request"
+require_relative "trophy/rewards/client"
+require_relative "trophy/rewards/types/rewards_redeem_request"
 require_relative "trophy/metrics/client"
 require_relative "trophy/metrics/types/metrics_event_request"
 require_relative "trophy/users/client"
 require_relative "trophy/users/types/update_user_preferences_request"
 require_relative "trophy/users/types/users_metric_event_summary_request"
 require_relative "trophy/users/types/users_achievements_request"
+require_relative "trophy/users/types/users_rewards_request"
 require_relative "trophy/users/types/users_streak_request"
 require_relative "trophy/users/types/users_points_request"
 require_relative "trophy/users/types/users_points_event_summary_request"
@@ -354,6 +407,9 @@ require_relative "trophy/admin/attributes/types/attributes_delete_request"
 require_relative "trophy/admin/achievements/client"
 require_relative "trophy/admin/achievements/types/achievements_list_request"
 require_relative "trophy/admin/achievements/types/achievements_delete_request"
+require_relative "trophy/admin/rewards/client"
+require_relative "trophy/admin/rewards/types/rewards_list_request"
+require_relative "trophy/admin/rewards/types/rewards_delete_request"
 require_relative "trophy/admin/metrics/client"
 require_relative "trophy/admin/metrics/types/metrics_list_request"
 require_relative "trophy/admin/metrics/types/metrics_delete_request"
@@ -384,6 +440,9 @@ require_relative "trophy/admin/points/levels/types/levels_delete_request"
 require_relative "trophy/admin/points/triggers/client"
 require_relative "trophy/admin/points/triggers/types/triggers_list_request"
 require_relative "trophy/admin/points/triggers/types/triggers_delete_request"
+require_relative "trophy/admin/rewards/triggers/client"
+require_relative "trophy/admin/rewards/triggers/types/triggers_list_request"
+require_relative "trophy/admin/rewards/triggers/types/triggers_delete_request"
 require_relative "trophy/admin/streaks/freezes/client"
 require_relative "trophy/admin/streaks/freezes/types/create_streak_freezes_request"
 require_relative "trophy/admin/streaks/pauses/client"