trophy_api_client 1.13.0 → 1.26.1

data/lib/trophy/types/leaderboard_ranking.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A user's ranking in a leaderboard.
+    class LeaderboardRanking < Internal::Types::Model
+      field :user_id, -> { String }, optional: false, nullable: false, api_name: "userId"
+
+      field :user_name, -> { String }, optional: true, nullable: false, api_name: "userName"
+
+      field :rank, -> { Integer }, optional: false, nullable: false
+
+      field :value, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/leaderboard_response.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A leaderboard with its configuration details.
+    class LeaderboardResponse < 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 :rank_by, -> { Trophy::Types::LeaderboardResponseRankBy }, optional: false, nullable: false, api_name: "rankBy"
+
+      field :breakdown_attribute, -> { String }, optional: true, nullable: false, api_name: "breakdownAttribute"
+
+      field :breakdown_attributes, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "breakdownAttributes"
+
+      field :metric_key, -> { String }, optional: true, nullable: false, api_name: "metricKey"
+
+      field :metric_name, -> { String }, optional: true, nullable: false, api_name: "metricName"
+
+      field :points_system_key, -> { String }, optional: true, nullable: false, api_name: "pointsSystemKey"
+
+      field :points_system_name, -> { String }, optional: true, nullable: false, api_name: "pointsSystemName"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :end_, -> { String }, optional: true, nullable: false, api_name: "end"
+
+      field :start_time, -> { String }, optional: true, nullable: false, api_name: "startTime"
+
+      field :end_time, -> { String }, optional: true, nullable: false, api_name: "endTime"
+
+      field :max_participants, -> { Integer }, optional: true, nullable: false, api_name: "maxParticipants"
+
+      field :run_unit, -> { Trophy::Types::LeaderboardResponseRunUnit }, optional: true, nullable: false, api_name: "runUnit"
+
+      field :run_interval, -> { Integer }, optional: true, nullable: false, api_name: "runInterval"
+    end
+  end
+end

data/lib/trophy/types/leaderboard_response_rank_by.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module LeaderboardResponseRankBy
+      extend Trophy::Internal::Types::Enum
+
+      POINTS = "points"
+      STREAK = "streak"
+      METRIC = "metric"
+    end
+  end
+end

data/lib/trophy/types/leaderboard_response_run_unit.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module LeaderboardResponseRunUnit
+      extend Trophy::Internal::Types::Enum
+
+      DAY = "day"
+      MONTH = "month"
+      YEAR = "year"
+    end
+  end
+end

data/lib/trophy/types/leaderboard_response_with_rankings.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class LeaderboardResponseWithRankings < 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 :rank_by, -> { Trophy::Types::LeaderboardResponseRankBy }, optional: false, nullable: false, api_name: "rankBy"
+
+      field :breakdown_attribute, -> { String }, optional: true, nullable: false, api_name: "breakdownAttribute"
+
+      field :breakdown_attributes, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "breakdownAttributes"
+
+      field :metric_key, -> { String }, optional: true, nullable: false, api_name: "metricKey"
+
+      field :metric_name, -> { String }, optional: true, nullable: false, api_name: "metricName"
+
+      field :points_system_key, -> { String }, optional: true, nullable: false, api_name: "pointsSystemKey"
+
+      field :points_system_name, -> { String }, optional: true, nullable: false, api_name: "pointsSystemName"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :end_, -> { String }, optional: true, nullable: false, api_name: "end"
+
+      field :start_time, -> { String }, optional: true, nullable: false, api_name: "startTime"
+
+      field :end_time, -> { String }, optional: true, nullable: false, api_name: "endTime"
+
+      field :max_participants, -> { Integer }, optional: true, nullable: false, api_name: "maxParticipants"
+
+      field :run_unit, -> { Trophy::Types::LeaderboardResponseRunUnit }, optional: true, nullable: false, api_name: "runUnit"
+
+      field :run_interval, -> { Integer }, optional: true, nullable: false, api_name: "runInterval"
+
+      field :status, -> { Trophy::Types::LeaderboardResponseWithRankingsStatus }, optional: false, nullable: false
+
+      field :rankings, -> { Internal::Types::Array[Trophy::Types::LeaderboardRanking] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/leaderboard_response_with_rankings_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module LeaderboardResponseWithRankingsStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      SCHEDULED = "scheduled"
+      FINISHED = "finished"
+    end
+  end
+end

data/lib/trophy/types/list_achievements_response.rb

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class MetricEventLeaderboardResponse < Internal::Types::Model
+      field :end_, -> { String }, optional: true, nullable: false, api_name: "end"
+
+      field :rank, -> { Integer }, optional: true, nullable: false
+
+      field :previous_rank, -> { Integer }, optional: true, nullable: false, api_name: "previousRank"
+
+      field :threshold, -> { Integer }, optional: false, nullable: false
+
+      field :breakdown_attribute_value, -> { String }, optional: true, nullable: false, api_name: "breakdownAttributeValue"
+
+      field :breakdown_attribute_values, -> { Internal::Types::Array[Trophy::Types::MetricEventLeaderboardResponseBreakdownAttributeValuesItem] }, optional: true, nullable: false, api_name: "breakdownAttributeValues"
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :rank_by, -> { Trophy::Types::LeaderboardResponseRankBy }, optional: false, nullable: false, api_name: "rankBy"
+
+      field :breakdown_attribute, -> { String }, optional: true, nullable: false, api_name: "breakdownAttribute"
+
+      field :breakdown_attributes, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "breakdownAttributes"
+
+      field :metric_key, -> { String }, optional: true, nullable: false, api_name: "metricKey"
+
+      field :metric_name, -> { String }, optional: true, nullable: false, api_name: "metricName"
+
+      field :points_system_key, -> { String }, optional: true, nullable: false, api_name: "pointsSystemKey"
+
+      field :points_system_name, -> { String }, optional: true, nullable: false, api_name: "pointsSystemName"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :start_time, -> { String }, optional: true, nullable: false, api_name: "startTime"
+
+      field :end_time, -> { String }, optional: true, nullable: false, api_name: "endTime"
+
+      field :max_participants, -> { Integer }, optional: true, nullable: false, api_name: "maxParticipants"
+
+      field :run_unit, -> { Trophy::Types::LeaderboardResponseRunUnit }, optional: true, nullable: false, api_name: "runUnit"
+
+      field :run_interval, -> { Integer }, optional: true, nullable: false, api_name: "runInterval"
+    end
+  end
+end

data/lib/trophy/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class MetricEventLeaderboardResponseBreakdownAttributeValuesItem < Internal::Types::Model
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :value, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/metric_event_points_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Points system response for metric events and achievement completions.
+    class MetricEventPointsResponse < 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 :badge_url, -> { String }, optional: true, nullable: false, api_name: "badgeUrl"
+
+      field :max_points, -> { Integer }, optional: true, nullable: false, api_name: "maxPoints"
+
+      field :total, -> { Integer }, optional: false, nullable: false
+
+      field :level, -> { Trophy::Types::PointsLevel }, optional: true, nullable: false
+
+      field :added, -> { Integer }, optional: false, nullable: false
+
+      field :awards, -> { Internal::Types::Array[Trophy::Types::PointsAward] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/metric_event_streak_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An object representing the user's streak after sending a metric event.
+    class MetricEventStreakResponse < Internal::Types::Model
+      field :length, -> { Integer }, optional: false, nullable: false
+
+      field :frequency, -> { Trophy::Types::StreakFrequency }, optional: false, nullable: false
+
+      field :started, -> { String }, optional: true, nullable: false
+
+      field :period_start, -> { String }, optional: true, nullable: false, api_name: "periodStart"
+
+      field :period_end, -> { String }, optional: true, nullable: false, api_name: "periodEnd"
+
+      field :expires, -> { String }, optional: true, nullable: false
+
+      field :freezes, -> { Integer }, optional: true, nullable: false
+
+      field :max_freezes, -> { Integer }, optional: true, nullable: false, api_name: "maxFreezes"
+
+      field :freeze_auto_earn_interval, -> { Integer }, optional: true, nullable: false, api_name: "freezeAutoEarnInterval"
+
+      field :freeze_auto_earn_amount, -> { Integer }, optional: true, nullable: false, api_name: "freezeAutoEarnAmount"
+
+      field :extended, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/metric_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class MetricResponse < 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 :current, -> { Integer }, optional: false, nullable: false
+
+      field :achievements, -> { Internal::Types::Array[Trophy::Types::UserAchievementResponse] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/notification_channel.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module NotificationChannel
+      extend Trophy::Internal::Types::Enum
+
+      EMAIL = "email"
+      PUSH = "push"
+    end
+  end
+end

data/lib/trophy/types/notification_preferences.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Notification preferences for each notification type.
+    class NotificationPreferences < Internal::Types::Model
+      field :achievement_completed, -> { Internal::Types::Array[Trophy::Types::NotificationChannel] }, optional: true, nullable: false
+
+      field :recap, -> { Internal::Types::Array[Trophy::Types::NotificationChannel] }, optional: true, nullable: false
+
+      field :reactivation, -> { Internal::Types::Array[Trophy::Types::NotificationChannel] }, optional: true, nullable: false
+
+      field :streak_reminder, -> { Internal::Types::Array[Trophy::Types::NotificationChannel] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/patch_points_boosts_request.rb

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class PatchPointsBoostsRequestItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :start, -> { String }, optional: true, nullable: false
+
+      field :end_, -> { String }, optional: true, nullable: false, api_name: "end"
+
+      field :multiplier, -> { Integer }, optional: true, nullable: false
+
+      field :rounding, -> { Trophy::Types::PatchPointsBoostsRequestItemRounding }, optional: true, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::PatchPointsBoostsRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+    end
+  end
+end

data/lib/trophy/types/patch_points_boosts_request_item_rounding.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module PatchPointsBoostsRequestItemRounding
+      extend Trophy::Internal::Types::Enum
+
+      DOWN = "down"
+      UP = "up"
+      NEAREST = "nearest"
+    end
+  end
+end

data/lib/trophy/types/patch_points_boosts_request_item_user_attributes_item.rb

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

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