trophy_api_client 1.14.0 → 1.26.1

data/lib/trophy/types/streak_metric_preference.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Per-metric streak threshold override for a user.
+    class StreakMetricPreference < Internal::Types::Model
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :threshold, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/streak_preferences.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Per-user streak configuration. Metric, evaluation mode, and days off overrides require streak customization to be
+    # enabled in dashboard settings.
+    class StreakPreferences < Internal::Types::Model
+      field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :evaluation_mode, -> { Trophy::Types::StreakEvaluationModePreference }, optional: true, nullable: false, api_name: "evaluationMode"
+
+      field :metrics, -> { Internal::Types::Array[Trophy::Types::StreakMetricPreference] }, optional: true, nullable: false
+
+      field :days_off, -> { Internal::Types::Array[Integer] }, optional: true, nullable: false, api_name: "daysOff"
+    end
+  end
+end

data/lib/trophy/types/streak_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An object representing the user's streak.
+    class StreakResponse < 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, -> { String }, optional: true, nullable: false
+
+      field :streak_history, -> { Internal::Types::Array[Trophy::Types::StreakResponseStreakHistoryItem] }, optional: false, nullable: false, api_name: "streakHistory"
+
+      field :pauses, -> { Internal::Types::Array[Trophy::Types::StreakResponsePausesItem] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/streak_response_pauses_item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An object representing a streak pause.
+    class StreakResponsePausesItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :end_, -> { String }, optional: false, nullable: false, api_name: "end"
+    end
+  end
+end

data/lib/trophy/types/streak_response_streak_history_item.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An object representing a past streak period.
+    class StreakResponseStreakHistoryItem < Internal::Types::Model
+      field :period_start, -> { String }, optional: false, nullable: false, api_name: "periodStart"
+
+      field :period_end, -> { String }, optional: false, nullable: false, api_name: "periodEnd"
+
+      field :length, -> { Integer }, optional: false, nullable: false
+
+      field :used_freeze, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "usedFreeze"
+
+      field :used_pause, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "usedPause"
+
+      field :reset_at, -> { String }, optional: true, nullable: false, api_name: "resetAt"
+    end
+  end
+end

data/lib/trophy/types/streak_settings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The organization's streak configuration.
+    class StreakSettings < Internal::Types::Model
+      field :frequency, -> { Trophy::Types::AdminStreakFrequency }, optional: false, nullable: false
+
+      field :evaluation_mode, -> { Trophy::Types::AdminStreakEvaluationMode }, optional: false, nullable: false, api_name: "evaluationMode"
+
+      field :customization_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "customizationEnabled"
+
+      field :days_off, -> { Internal::Types::Array[Integer] }, optional: false, nullable: false, api_name: "daysOff"
+
+      field :metrics, -> { Internal::Types::Array[Trophy::Types::StreakSettingsMetric] }, optional: false, nullable: false
+
+      field :freezes, -> { Trophy::Types::StreakSettingsFreezes }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/streak_settings_freezes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Organization streak freeze configuration. `null` on the parent object means freezes are disabled.
+    class StreakSettingsFreezes < Internal::Types::Model
+      field :start_count, -> { Integer }, optional: false, nullable: false, api_name: "startCount"
+
+      field :max_count, -> { Integer }, optional: false, nullable: false, api_name: "maxCount"
+
+      field :auto_earn_interval, -> { Integer }, optional: true, nullable: false, api_name: "autoEarnInterval"
+
+      field :auto_earn_amount, -> { Integer }, optional: true, nullable: false, api_name: "autoEarnAmount"
+    end
+  end
+end

data/lib/trophy/types/streak_settings_metric.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A metric that counts toward the organization streak.
+    class StreakSettingsMetric < Internal::Types::Model
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :threshold, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_achievement_request_item.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An achievement update object. `id` is required; all other fields are optional. Omitted fields are preserved. Send
+    # `null` for `description`, `badge`, or `userAttributes` to clear them.
+    class UpdateAchievementRequestItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :trigger, -> { Trophy::Types::UpdateAchievementRequestItemTrigger }, optional: true, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::UpdateAchievementRequestItemStatus }, optional: true, nullable: false
+
+      field :badge, -> { Trophy::Types::UpdateAchievementRequestItemBadge }, optional: true, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::UpdateAchievementRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+
+      field :key, -> { String }, optional: true, nullable: false
+
+      field :metric_id, -> { String }, optional: true, nullable: false, api_name: "metricId"
+
+      field :metric_value, -> { Integer }, optional: true, nullable: false, api_name: "metricValue"
+
+      field :event_attributes, -> { Internal::Types::Array[Trophy::Types::UpdateAchievementRequestItemEventAttributesItem] }, optional: true, nullable: false, api_name: "eventAttributes"
+
+      field :streak_length, -> { Integer }, optional: true, nullable: false, api_name: "streakLength"
+
+      field :anniversary_years, -> { Integer }, optional: true, nullable: false, api_name: "anniversaryYears"
+
+      field :achievement_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "achievementIds"
+    end
+  end
+end

data/lib/trophy/types/update_achievement_request_item_badge.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdateAchievementRequestItemBadge < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_achievement_request_item_event_attributes_item.rb

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateAchievementRequestItemStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      INACTIVE = "inactive"
+      LOCKED = "locked"
+    end
+  end
+end

data/lib/trophy/types/update_achievement_request_item_trigger.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateAchievementRequestItemTrigger
+      extend Trophy::Internal::Types::Enum
+
+      METRIC = "metric"
+      STREAK = "streak"
+      API = "api"
+      ACHIEVEMENT = "achievement"
+      ANNIVERSARY = "anniversary"
+    end
+  end
+end

data/lib/trophy/types/update_achievement_request_item_user_attributes_item.rb

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

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing updated achievements and any per-item issues identified by achievement ID.
+    class UpdateAchievementsResponse < Internal::Types::Model
+      field :updated, -> { Internal::Types::Array[Trophy::Types::AdminAchievement] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_admin_settings_branding.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Branding fields to update. Omitted fields stay as-is.
+    class UpdateAdminSettingsBranding < Internal::Types::Model
+      field :app_name, -> { String }, optional: true, nullable: false, api_name: "appName"
+
+      field :app_url, -> { String }, optional: true, nullable: false, api_name: "appUrl"
+
+      field :brand_color, -> { String }, optional: true, nullable: false, api_name: "brandColor"
+
+      field :font, -> { Trophy::Types::AdminFontFamily }, optional: true, nullable: false
+
+      field :logo, -> { Trophy::Types::UpdateAdminSettingsBrandingLogo }, optional: true, nullable: false
+
+      field :app_icon, -> { Trophy::Types::UpdateAdminSettingsBrandingAppIcon }, optional: true, nullable: false, api_name: "appIcon"
+    end
+  end
+end

data/lib/trophy/types/update_admin_settings_branding_app_icon.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdateAdminSettingsBrandingAppIcon < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_admin_settings_branding_logo.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdateAdminSettingsBrandingLogo < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_admin_settings_experimentation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Experimentation fields to update. Omitted fields stay as-is.
+    class UpdateAdminSettingsExperimentation < Internal::Types::Model
+      field :control_ratio, -> { Integer }, optional: true, nullable: false, api_name: "controlRatio"
+
+      field :user_activation_window, -> { Integer }, optional: true, nullable: false, api_name: "userActivationWindow"
+    end
+  end
+end

data/lib/trophy/types/update_attribute_request_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An attribute update object. `id` is required and `name` is optional. `key` and `type` cannot be changed through
+    # this endpoint.
+    class UpdateAttributeRequestItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_attributes_request.rb

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing updated attributes and any per-item issues identified by attribute ID.
+    class UpdateAttributesResponse < Internal::Types::Model
+      field :updated, -> { Internal::Types::Array[Trophy::Types::AdminAttribute] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_leaderboard_request_item.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A leaderboard update object. `id` is required. Once a leaderboard has been activated, the dashboard-imposed
+    # restrictions on ranking configuration and scheduling changes still apply.
+    class UpdateLeaderboardRequestItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :key, -> { String }, optional: true, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::UpdateLeaderboardRequestItemStatus }, optional: true, nullable: false
+
+      field :rank_by, -> { Trophy::Types::UpdateLeaderboardRequestItemRankBy }, optional: true, nullable: false, api_name: "rankBy"
+
+      field :metric_id, -> { String }, optional: true, nullable: false, api_name: "metricId"
+
+      field :points_system_id, -> { String }, optional: true, nullable: false, api_name: "pointsSystemId"
+
+      field :max_participants, -> { Integer }, optional: true, nullable: false, api_name: "maxParticipants"
+
+      field :start, -> { String }, optional: true, 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 :breakdown_attributes, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "breakdownAttributes"
+
+      field :run_unit, -> { Trophy::Types::UpdateLeaderboardRequestItemRunUnit }, 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/update_leaderboard_request_item_rank_by.rb

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

data/lib/trophy/types/update_leaderboard_request_item_run_unit.rb

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

data/lib/trophy/types/update_leaderboard_request_item_status.rb

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

data/lib/trophy/types/update_leaderboards_request.rb

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing updated leaderboards and any per-item issues identified by leaderboard ID.
+    class UpdateLeaderboardsResponse < Internal::Types::Model
+      field :updated, -> { Internal::Types::Array[Trophy::Types::AdminLeaderboard] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_metric_request_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A metric update object. `id` is required; `name`, `unitType`, and `units` are optional. `key` cannot be changed
+    # through this endpoint.
+    class UpdateMetricRequestItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :unit_type, -> { Trophy::Types::UpdateMetricRequestItemUnitType }, optional: true, nullable: false, api_name: "unitType"
+
+      field :units, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_metric_request_item_unit_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module UpdateMetricRequestItemUnitType
+      extend Trophy::Internal::Types::Enum
+
+      NUMBER = "number"
+      CURRENCY = "currency"
+    end
+  end
+end

data/lib/trophy/types/update_metrics_request.rb

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing updated metrics and any per-item issues identified by metric ID.
+    class UpdateMetricsResponse < Internal::Types::Model
+      field :updated, -> { Internal::Types::Array[Trophy::Types::CreatedMetric] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_points_system_request_item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points system update object. Only id is required; all other fields are optional.
+    class UpdatePointsSystemRequestItem < 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 :badge, -> { Trophy::Types::UpdatePointsSystemRequestItemBadge }, optional: true, nullable: false
+
+      field :max_points, -> { Integer }, optional: true, nullable: false, api_name: "maxPoints"
+    end
+  end
+end

data/lib/trophy/types/update_points_system_request_item_badge.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class UpdatePointsSystemRequestItemBadge < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/update_points_systems_request.rb

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