trophy_api_client 1.27.0 → 1.29.0

data/lib/trophy/types/admin_reward_trigger.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A reward trigger as returned from admin endpoints.
+    class AdminRewardTrigger < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { Trophy::Types::AdminRewardTriggerType }, optional: false, nullable: false
+
+      field :status, -> { Trophy::Types::AdminRewardTriggerStatus }, optional: false, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::AdminRewardTriggerUserAttributesItem] }, optional: false, 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::AdminRewardTriggerEventAttributesItem] }, 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/admin_reward_trigger_event_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class AdminRewardTriggerEventAttributesItem < 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/admin_reward_trigger_status.rb

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

data/lib/trophy/types/admin_reward_trigger_type.rb

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

data/lib/trophy/types/admin_reward_trigger_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class AdminRewardTriggerUserAttributesItem < 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/admin_reward_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminRewardType
+      extend Trophy::Internal::Types::Enum
+
+      POINTS = "points"
+      CUSTOM = "custom"
+    end
+  end
+end

data/lib/trophy/types/admin_reward_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class AdminRewardUserAttributesItem < 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/create_reward_request_item.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A reward to create. Optionally include triggers.
+    class CreateRewardRequestItem < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::CreateRewardRequestItemStatus }, optional: true, nullable: false
+
+      field :type, -> { Trophy::Types::CreateRewardRequestItemType }, optional: false, nullable: false
+
+      field :points_system_id, -> { String }, optional: true, nullable: false, api_name: "pointsSystemId"
+
+      field :points, -> { Integer }, optional: true, nullable: false
+
+      field :max_redemptions, -> { Integer }, optional: true, nullable: false, api_name: "maxRedemptions"
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::CreateRewardRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+
+      field :triggers, -> { Internal::Types::Array[Trophy::Types::CreateRewardTriggerRequestItem] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_reward_request_item_status.rb

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

data/lib/trophy/types/create_reward_request_item_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateRewardRequestItemType
+      extend Trophy::Internal::Types::Enum
+
+      POINTS = "points"
+      CUSTOM = "custom"
+    end
+  end
+end

data/lib/trophy/types/create_reward_request_item_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreateRewardRequestItemUserAttributesItem < 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/create_reward_trigger_request_item.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A reward trigger to create.
+    class CreateRewardTriggerRequestItem < Internal::Types::Model
+      field :type, -> { Trophy::Types::CreateRewardTriggerRequestItemType }, optional: false, nullable: false
+
+      field :status, -> { Trophy::Types::CreateRewardTriggerRequestItemStatus }, optional: true, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::CreateRewardTriggerRequestItemUserAttributesItem] }, 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::CreateRewardTriggerRequestItemEventAttributesItem] }, 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/create_reward_trigger_request_item_event_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreateRewardTriggerRequestItemEventAttributesItem < 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/create_reward_trigger_request_item_status.rb

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

data/lib/trophy/types/create_reward_trigger_request_item_type.rb

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

data/lib/trophy/types/create_reward_trigger_request_item_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreateRewardTriggerRequestItemUserAttributesItem < 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/create_reward_triggers_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateRewardTriggersRequest
+      # CreateRewardTriggersRequest 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/create_reward_triggers_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created triggers and any per-item issues.
+    class CreateRewardTriggersResponse < Internal::Types::Model
+      field :created, -> { 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/create_rewards_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateRewardsRequest
+      # CreateRewardsRequest 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/create_rewards_response.rb

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

data/lib/trophy/types/created_admin_reward.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A reward returned from the creation endpoint. Extends AdminReward with the triggers created alongside it, present
+    # when triggers were included in the creation request.
+    class CreatedAdminReward < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::AdminRewardStatus }, optional: false, nullable: false
+
+      field :type, -> { Trophy::Types::AdminRewardType }, optional: false, nullable: false
+
+      field :points_system_id, -> { String }, optional: true, nullable: false, api_name: "pointsSystemId"
+
+      field :points, -> { Integer }, optional: true, nullable: false
+
+      field :max_redemptions, -> { Integer }, optional: true, nullable: false, api_name: "maxRedemptions"
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::AdminRewardUserAttributesItem] }, optional: false, nullable: false, api_name: "userAttributes"
+
+      field :triggers, -> { Internal::Types::Array[Trophy::Types::AdminRewardTrigger] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_reward_triggers_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing the reward triggers that were deleted and any per-item issues.
+    class DeleteRewardTriggersResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_rewards_response.rb

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

data/lib/trophy/types/event_response.rb

@@ -17,6 +17,8 @@ module Trophy
 
       field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::MetricEventLeaderboardResponse] }, optional: false, nullable: false
 
+      field :rewards, -> { Internal::Types::Array[Trophy::Types::UserRewardResponse] }, optional: false, nullable: false
+
       field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
 
       field :idempotent_replayed, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "idempotentReplayed"

data/lib/trophy/types/list_reward_triggers_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module ListRewardTriggersResponse
+      # ListRewardTriggersResponse 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/list_rewards_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module ListRewardsResponse
+      # ListRewardsResponse 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/points_trigger.rb

@@ -23,6 +23,10 @@ module Trophy
 
       field :achievement_name, -> { String }, optional: true, nullable: false, api_name: "achievementName"
 
+      field :reward_key, -> { String }, optional: true, nullable: false, api_name: "rewardKey"
+
+      field :reward_name, -> { String }, optional: true, nullable: false, api_name: "rewardName"
+
       field :time_unit, -> { Trophy::Types::PointsTriggerTimeUnit }, optional: true, nullable: false, api_name: "timeUnit"
 
       field :time_interval, -> { Integer }, optional: true, nullable: false, api_name: "timeInterval"

data/lib/trophy/types/points_trigger_type.rb

@@ -10,6 +10,7 @@ module Trophy
       STREAK = "streak"
       TIME = "time"
       USER_CREATION = "user_creation"
+      REWARD = "reward"
     end
   end
 end

data/lib/trophy/types/redeem_reward_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class RedeemRewardResponse < Internal::Types::Model
+      field :reward, -> { Trophy::Types::RewardSummary }, optional: false, nullable: false
+
+      field :redemptions, -> { Internal::Types::Array[Trophy::Types::RedeemedReward] }, optional: false, nullable: false
+
+      field :points, -> { Internal::Types::Hash[String, Trophy::Types::MetricEventPointsResponse] }, optional: true, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::MetricEventLeaderboardResponse] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/redeemed_reward.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class RedeemedReward < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :awarded_at, -> { String }, optional: false, nullable: false, api_name: "awardedAt"
+
+      field :redeemed_at, -> { String }, optional: false, nullable: false, api_name: "redeemedAt"
+    end
+  end
+end

data/lib/trophy/types/reward_summary.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class RewardSummary < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :type, -> { Trophy::Types::RewardSummaryType }, optional: false, nullable: false
+
+      field :points, -> { Integer }, optional: true, nullable: false
+
+      field :points_system_id, -> { String }, optional: true, nullable: false, api_name: "pointsSystemId"
+
+      field :points_system_key, -> { String }, optional: true, nullable: false, api_name: "pointsSystemKey"
+    end
+  end
+end

data/lib/trophy/types/reward_summary_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module RewardSummaryType
+      extend Trophy::Internal::Types::Enum
+
+      POINTS = "points"
+      CUSTOM = "custom"
+    end
+  end
+end

data/lib/trophy/types/reward_webhook_event.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class RewardWebhookEvent < Internal::Types::Model
+      field :type, -> { Trophy::Types::RewardWebhookEventType }, optional: false, nullable: false
+
+      field :timestamp, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :reward, -> { Trophy::Types::RewardSummary }, optional: false, nullable: false
+
+      field :redemption, -> { Trophy::Types::RewardWebhookEventRedemption }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/reward_webhook_event_redemption.rb

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

data/lib/trophy/types/reward_webhook_event_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module RewardWebhookEventType
+      extend Trophy::Internal::Types::Enum
+
+      REWARD_AWARDED = "reward.awarded"
+      REWARD_REDEEMED = "reward.redeemed"
+    end
+  end
+end

data/lib/trophy/types/update_reward_request_item.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A reward update object. Only id is required; all other fields are optional. Triggers are updated through the
+    # reward triggers endpoints.
+    class UpdateRewardRequestItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::UpdateRewardRequestItemStatus }, optional: true, nullable: false
+
+      field :type, -> { Trophy::Types::UpdateRewardRequestItemType }, optional: true, nullable: false
+
+      field :points_system_id, -> { String }, optional: true, nullable: false, api_name: "pointsSystemId"
+
+      field :points, -> { Integer }, optional: true, nullable: false
+
+      field :max_redemptions, -> { Integer }, optional: true, nullable: false, api_name: "maxRedemptions"
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::UpdateRewardRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+    end
+  end
+end

data/lib/trophy/types/update_reward_request_item_status.rb

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

data/lib/trophy/types/update_reward_request_item_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateRewardRequestItemType
+      extend Trophy::Internal::Types::Enum
+
+      POINTS = "points"
+      CUSTOM = "custom"
+    end
+  end
+end