trophy_api_client 1.13.0 → 1.26.1

data/lib/trophy/types/admin_aggregation_period.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminAggregationPeriod
+      extend Trophy::Internal::Types::Enum
+
+      WEEKLY = "weekly"
+      MONTHLY = "monthly"
+    end
+  end
+end

data/lib/trophy/types/admin_attribute.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An attribute returned from the admin attributes endpoints.
+    class AdminAttribute < 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 :type, -> { Trophy::Types::AdminAttributeType }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/admin_attribute_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminAttributeType
+      extend Trophy::Internal::Types::Enum
+
+      USER = "user"
+      EVENT = "event"
+    end
+  end
+end

data/lib/trophy/types/admin_environment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An active environment in the organisation.
+    class AdminEnvironment < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :priority, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/admin_error_body.rb

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

data/lib/trophy/types/admin_font_family.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminFontFamily
+      extend Trophy::Internal::Types::Enum
+
+      MODERN_SANS = "MODERN_SANS"
+      BOOK_SANS = "BOOK_SANS"
+      ORGANIC_SANS = "ORGANIC_SANS"
+      GEOMETRIC_SANS = "GEOMETRIC_SANS"
+      HEAVY_SANS = "HEAVY_SANS"
+      ROUNDED_SANS = "ROUNDED_SANS"
+      MODERN_SERIF = "MODERN_SERIF"
+      BOOK_SERIF = "BOOK_SERIF"
+      MONOSPACE = "MONOSPACE"
+    end
+  end
+end

data/lib/trophy/types/admin_issue.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An issue encountered while processing an item in an admin API request.
+    class AdminIssue < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :user_id, -> { String }, optional: true, nullable: false, api_name: "userId"
+
+      field :boost_id, -> { String }, optional: true, nullable: false, api_name: "boostId"
+
+      field :index, -> { Integer }, optional: true, nullable: false
+
+      field :severity, -> { Trophy::Types::AdminIssueSeverity }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/admin_issue_severity.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminIssueSeverity
+      extend Trophy::Internal::Types::Enum
+
+      ERROR = "error"
+      WARNING = "warning"
+    end
+  end
+end

data/lib/trophy/types/admin_leaderboard.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A leaderboard returned from the admin leaderboards endpoints.
+    class AdminLeaderboard < 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::AdminLeaderboardStatus }, optional: false, nullable: false
+
+      field :rank_by, -> { Trophy::Types::AdminLeaderboardRankBy }, optional: false, 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: 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 :breakdown_attributes, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "breakdownAttributes"
+
+      field :run_unit, -> { Trophy::Types::AdminLeaderboardRunUnit }, 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/admin_leaderboard_rank_by.rb

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

data/lib/trophy/types/admin_leaderboard_run_unit.rb

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

data/lib/trophy/types/admin_leaderboard_status.rb

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

data/lib/trophy/types/admin_points_boost.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points boost as returned from admin endpoints.
+    class AdminPointsBoost < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Trophy::Types::AdminPointsBoostStatus }, optional: false, nullable: false
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :end_, -> { String }, optional: true, nullable: false, api_name: "end"
+
+      field :multiplier, -> { Integer }, optional: false, nullable: false
+
+      field :rounding, -> { Trophy::Types::AdminPointsBoostRounding }, optional: false, nullable: false
+
+      field :user_id, -> { String }, optional: true, nullable: false, api_name: "userId"
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::AdminPointsBoostUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+    end
+  end
+end

data/lib/trophy/types/admin_points_boost_rounding.rb

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

data/lib/{trophy_api_client/leaderboards/types/leaderboards_all_response_item_status.rb → trophy/types/admin_points_boost_status.rb}

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-module TrophyApiClient
-  class Leaderboards
-    # The status of the leaderboard.
-    class LeaderboardsAllResponseItemStatus
+module Trophy
+  module Types
+    module AdminPointsBoostStatus
+      extend Trophy::Internal::Types::Enum
+
       ACTIVE = "active"
       SCHEDULED = "scheduled"
       FINISHED = "finished"

data/lib/trophy/types/admin_points_boost_user_attributes_item.rb

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points level as returned from admin endpoints.
+    class AdminPointsLevel < 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 :points, -> { Integer }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: false, nullable: false
+
+      field :badge, -> { Trophy::Types::AdminPointsLevelBadge }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/admin_points_level_badge.rb

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

data/lib/trophy/types/admin_points_system.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points system returned from the admin points systems endpoints.
+    class AdminPointsSystem < 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: false, nullable: false
+
+      field :status, -> { Trophy::Types::AdminPointsSystemStatus }, optional: false, nullable: false
+
+      field :badge, -> { Trophy::Types::AdminPointsSystemBadge }, optional: true, nullable: false
+
+      field :max_points, -> { Integer }, optional: true, nullable: false, api_name: "maxPoints"
+    end
+  end
+end

data/lib/trophy/types/admin_points_system_badge.rb

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

data/lib/trophy/types/admin_points_system_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminPointsSystemStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      ARCHIVED = "archived"
+    end
+  end
+end

data/lib/trophy/types/admin_points_trigger.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points trigger as returned from admin endpoints.
+    class AdminPointsTrigger < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { Trophy::Types::AdminPointsTriggerType }, optional: false, nullable: false
+
+      field :points, -> { Integer }, optional: false, nullable: false
+
+      field :status, -> { Trophy::Types::AdminPointsTriggerStatus }, optional: false, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::AdminPointsTriggerUserAttributesItem] }, 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::AdminPointsTriggerEventAttributesItem] }, 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 :time_unit, -> { Trophy::Types::AdminPointsTriggerTimeUnit }, optional: true, nullable: false, api_name: "timeUnit"
+
+      field :time_interval, -> { Integer }, optional: true, nullable: false, api_name: "timeInterval"
+
+      field :block_if_out_of_points, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "blockIfOutOfPoints"
+    end
+  end
+end

data/lib/trophy/types/admin_points_trigger_event_attributes_item.rb

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

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

data/lib/trophy/types/admin_points_trigger_time_unit.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminPointsTriggerTimeUnit
+      extend Trophy::Internal::Types::Enum
+
+      HOURS = "hours"
+      DAYS = "days"
+    end
+  end
+end

data/lib/trophy/types/admin_points_trigger_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminPointsTriggerType
+      extend Trophy::Internal::Types::Enum
+
+      METRIC = "metric"
+      ACHIEVEMENT = "achievement"
+      STREAK = "streak"
+      TIME = "time"
+      USER_CREATION = "user_creation"
+    end
+  end
+end

data/lib/trophy/types/admin_points_trigger_user_attributes_item.rb

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The organization's branding, experimentation, and aggregation settings.
+    class AdminSettings < Internal::Types::Model
+      field :branding, -> { Trophy::Types::AdminSettingsBranding }, optional: false, nullable: false
+
+      field :experimentation, -> { Trophy::Types::AdminSettingsExperimentation }, optional: false, nullable: false
+
+      field :aggregation_period, -> { Trophy::Types::AdminAggregationPeriod }, optional: false, nullable: false, api_name: "aggregationPeriod"
+    end
+  end
+end

data/lib/trophy/types/admin_settings_branding.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Organization branding settings.
+    class AdminSettingsBranding < Internal::Types::Model
+      field :app_name, -> { String }, optional: false, nullable: false, api_name: "appName"
+
+      field :app_url, -> { String }, optional: false, nullable: false, api_name: "appUrl"
+
+      field :brand_color, -> { String }, optional: false, nullable: false, api_name: "brandColor"
+
+      field :font, -> { Trophy::Types::AdminFontFamily }, optional: false, nullable: false
+
+      field :logo, -> { Trophy::Types::AdminSettingsBrandingLogo }, optional: true, nullable: false
+
+      field :app_icon, -> { Trophy::Types::AdminSettingsBrandingAppIcon }, optional: true, nullable: false, api_name: "appIcon"
+    end
+  end
+end

data/lib/trophy/types/admin_settings_branding_app_icon.rb

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

data/lib/trophy/types/admin_settings_branding_logo.rb

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

data/lib/trophy/types/admin_settings_experimentation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Experimentation settings.
+    class AdminSettingsExperimentation < Internal::Types::Model
+      field :control_ratio, -> { Integer }, optional: false, nullable: false, api_name: "controlRatio"
+
+      field :user_activation_window, -> { Integer }, optional: false, nullable: false, api_name: "userActivationWindow"
+    end
+  end
+end

data/lib/trophy/types/admin_streak_evaluation_mode.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminStreakEvaluationMode
+      extend Trophy::Internal::Types::Enum
+
+      OR = "OR"
+      AND = "AND"
+    end
+  end
+end

data/lib/{trophy_api_client/users/types/users_points_event_summary_request_aggregation.rb → trophy/types/admin_streak_frequency.rb}

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-module TrophyApiClient
-  class Users
-    class UsersPointsEventSummaryRequestAggregation
+module Trophy
+  module Types
+    module AdminStreakFrequency
+      extend Trophy::Internal::Types::Enum
+
       DAILY = "daily"
       WEEKLY = "weekly"
       MONTHLY = "monthly"

data/lib/trophy/types/admin_streak_pause.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A streak pause returned from the admin pauses endpoints.
+    class AdminStreakPause < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :user_id, -> { String }, optional: false, nullable: false, api_name: "userId"
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :end_, -> { String }, optional: false, nullable: false, api_name: "end"
+
+      field :status, -> { Trophy::Types::AdminStreakPauseStatus }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/admin_streak_pause_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminStreakPauseStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      ARCHIVED = "archived"
+    end
+  end
+end

data/lib/trophy/types/admin_tenant.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A tenant in a multi-tenant environment.
+    class AdminTenant < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :customer_id, -> { String }, optional: false, nullable: false, api_name: "customerId"
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Trophy::Types::AdminTenantStatus }, optional: false, nullable: false
+
+      field :created, -> { String }, optional: false, nullable: false
+
+      field :updated, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/admin_tenant_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminTenantStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      ARCHIVED = "archived"
+    end
+  end
+end

data/lib/trophy/types/base_streak_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class BaseStreakResponse < 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"
+    end
+  end
+end