@cstar.help/js 0.15.1 → 0.16.0

package/dist/index.d.cts

@@ -582,7 +582,17 @@ declare class ArticlesResource extends BaseResource<Article, ArticleListParams,
 }
 
 /** Every webhook event type cStar can dispatch. */
-type WebhookEventType = 'article.created' | 'article.deleted' | 'article.published' | 'article.updated' | 'boss.damaged' | 'boss.defeated' | 'boss.spawned' | 'community_post.commented' | 'community_post.created' | 'community_post.deleted' | 'community_post.status_changed' | 'community_post.updated' | 'community_post.voted' | 'customer.created' | 'customer.deleted' | 'customer.updated' | 'customer_group.created' | 'customer_group.deleted' | 'customer_group.updated' | 'player.achievement_unlocked' | 'player.level_up' | 'player.quest_completed' | 'player.streak_milestone' | 'player.xp_gained' | 'social.high_five_sent' | 'social.one_up_sent' | 'survey.submitted' | 'ticket.assigned' | 'ticket.closed' | 'ticket.created' | 'ticket.deleted' | 'ticket.message_added' | 'ticket.updated';
+type WebhookEventType = 'agent.preferences_updated' | 'article.created' | 'article.deleted' | 'article.published' | 'article.updated' | 'boss.damaged' | 'boss.defeated' | 'boss.spawned' | 'community_post.commented' | 'community_post.created' | 'community_post.deleted' | 'community_post.status_changed' | 'community_post.updated' | 'community_post.voted' | 'customer.created' | 'customer.deleted' | 'customer.updated' | 'customer_group.created' | 'customer_group.deleted' | 'customer_group.updated' | 'player.achievement_unlocked' | 'player.level_up' | 'player.quest_completed' | 'player.streak_milestone' | 'player.xp_gained' | 'social.high_five_sent' | 'social.one_up_sent' | 'survey.submitted' | 'team.preferences_updated' | 'ticket.assigned' | 'ticket.closed' | 'ticket.created' | 'ticket.deleted' | 'ticket.message_added' | 'ticket.updated';
+/** Payload for `agent.preferences_updated` events. */
+interface AgentPreferencesUpdatedPayload {
+    team_id: string;
+    member_id: string;
+    agent_id: string;
+    changed: Array<string>;
+    preferences: {
+        boringMode: boolean;
+    };
+}
 /** Payload for `article.created` events. */
 interface ArticleCreatedPayload {
     article: {
@@ -857,6 +867,14 @@ interface SurveySubmittedPayload {
         email: string;
     };
 }
+/** Payload for `team.preferences_updated` events. */
+interface TeamPreferencesUpdatedPayload {
+    team_id: string;
+    changed: Array<string>;
+    preferences: {
+        bossBattlesEnabled: boolean;
+    };
+}
 /** Payload for `ticket.assigned` events. */
 interface TicketAssignedPayload {
     ticket: {
@@ -947,6 +965,7 @@ interface TicketUpdatedPayload {
 }
 /** Maps each event type to its payload interface — used internally for the discriminated union. */
 interface WebhookEventDataMap {
+    'agent.preferences_updated': AgentPreferencesUpdatedPayload;
     'article.created': ArticleCreatedPayload;
     'article.deleted': ArticleDeletedPayload;
     'article.published': ArticlePublishedPayload;
@@ -974,6 +993,7 @@ interface WebhookEventDataMap {
     'social.high_five_sent': SocialHighFiveSentPayload;
     'social.one_up_sent': SocialOneUpSentPayload;
     'survey.submitted': SurveySubmittedPayload;
+    'team.preferences_updated': TeamPreferencesUpdatedPayload;
     'ticket.assigned': TicketAssignedPayload;
     'ticket.closed': TicketClosedPayload;
     'ticket.created': TicketCreatedPayload;
@@ -994,6 +1014,20 @@ interface WebhookEvent<T extends WebhookEventType = WebhookEventType> {
     /** Event-specific payload. */
     data: WebhookEventDataMap[T];
 }
+/**
+ * Stable representative payloads for each event type. Useful for testing
+ * your endpoint against realistic shapes without having to trigger a real
+ * event. Mirrors the dashboard's event catalog.
+ */
+declare const WEBHOOK_EVENT_SAMPLES: {
+    [K in WebhookEventType]: WebhookEventDataMap[K];
+};
+/** Static metadata about every event — labels, descriptions, categories. */
+declare const WEBHOOK_EVENT_CATALOG: Record<WebhookEventType, {
+    label: string;
+    description: string;
+    category: string;
+}>;
 
 type WebhookEventData<T extends WebhookEventType> = WebhookEventDataMap[T];
 
@@ -1516,6 +1550,40 @@ interface InviteCreateParams {
     role?: string;
 }
 
+/**
+ * Team and member preferences — UX toggles exposed via the bearer-token API.
+ *
+ * Backed by:
+ *   - `/api/v1/teams/{teamId}/preferences` (TeamPreferences)
+ *   - `/api/v1/teams/{teamId}/members/{memberId}/preferences` (MemberPreferences)
+ *
+ * Kept narrow on purpose: only the toggles a headless dashboard needs to
+ * flip from a server. Add new fields here when the matching column lands
+ * on the handler's ALLOWED map.
+ */
+/** Team-wide UX preferences. */
+interface TeamPreferences {
+    /** When false, hides the team boss feature for every agent. */
+    bossBattlesEnabled: boolean | null;
+}
+/** Patch shape for team preferences. */
+interface TeamPreferencesUpdateParams {
+    bossBattlesEnabled?: boolean;
+}
+/** Per-agent UX preferences. */
+interface MemberPreferences {
+    /**
+     * When true, hides every gamification element for this agent. XP keeps
+     * accumulating in the background — flipping back to false restores the
+     * full game UI without losing progress.
+     */
+    boringMode: boolean | null;
+}
+/** Patch shape for member preferences. */
+interface MemberPreferencesUpdateParams {
+    boringMode?: boolean;
+}
+
 /** Manage team invites as a sub-resource. */
 declare class InvitesResource {
     private readonly client;
@@ -1527,11 +1595,22 @@ declare class InvitesResource {
     /** Revoke a pending invite. */
     del(inviteId: string): Promise<ApiResponse<DeleteResponse>>;
 }
+/** Manage per-agent UX preferences as a sub-resource of members. */
+declare class MemberPreferencesResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** Get an agent's UX preferences (boring mode, etc.). */
+    get(memberId: string): Promise<ApiResponse<MemberPreferences>>;
+    /** Update an agent's UX preferences. Only provided fields are written. */
+    update(memberId: string, params: MemberPreferencesUpdateParams): Promise<ApiResponse<MemberPreferences>>;
+}
 /** Manage team members. */
 declare class MembersResource {
     private readonly client;
     /** Sub-resource for team invites. */
     readonly invites: InvitesResource;
+    /** Sub-resource for per-agent UX preferences. */
+    readonly preferences: MemberPreferencesResource;
     constructor(client: HttpClient);
     /** List all team members. */
     list(params?: MemberListParams): Promise<ListResponse<Member>>;
@@ -2996,6 +3075,21 @@ declare class BillingResource {
     portal(params?: BillingPortalParams): Promise<ApiResponse<BillingPortal>>;
 }
 
+/**
+ * Team-wide preferences. Wraps `/api/v1/teams/{teamId}/preferences`.
+ *
+ * Currently exposes the team-level boss-battles toggle. Read requires
+ * `manage_settings`; write requires the same plus a secret key.
+ */
+declare class PreferencesResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** Get team preferences. */
+    get(): Promise<ApiResponse<TeamPreferences>>;
+    /** Update team preferences. Only provided fields are written. */
+    update(params: TeamPreferencesUpdateParams): Promise<ApiResponse<TeamPreferences>>;
+}
+
 interface QueueItem {
     /** Unique queue item ID. */
     id: string;
@@ -3476,6 +3570,8 @@ declare class CStarClient {
     readonly members: MembersResource;
     /** Manage team settings, statuses, quick replies, business hours, and widget. */
     readonly settings: SettingsResource;
+    /** Team-wide UX preferences (boss-battles toggle, etc.). */
+    readonly preferences: PreferencesResource;
     /** Manage notifications. */
     readonly notifications: NotificationsResource;
     /** Manage @mentions. */
@@ -3565,4 +3661,4 @@ declare class CStarClient {
     get lastMeta(): LastMeta;
 }
 
-export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarConflictError, CStarError, CStarFeatureDisabledError, CStarNotFoundError, CStarPermissionError, CStarRateLimitError, CStarRealtime, CStarServerError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, ErrorType, type EventHandler, type ExportCreateParams, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleStreak, type Quest, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
+export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarConflictError, CStarError, CStarFeatureDisabledError, CStarNotFoundError, CStarPermissionError, CStarRateLimitError, CStarRealtime, CStarServerError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, ErrorType, type EventHandler, type ExportCreateParams, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleStreak, type Quest, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, WEBHOOK_EVENT_CATALOG, WEBHOOK_EVENT_SAMPLES, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };

package/dist/index.d.ts

@@ -582,7 +582,17 @@ declare class ArticlesResource extends BaseResource<Article, ArticleListParams,
 }
 
 /** Every webhook event type cStar can dispatch. */
-type WebhookEventType = 'article.created' | 'article.deleted' | 'article.published' | 'article.updated' | 'boss.damaged' | 'boss.defeated' | 'boss.spawned' | 'community_post.commented' | 'community_post.created' | 'community_post.deleted' | 'community_post.status_changed' | 'community_post.updated' | 'community_post.voted' | 'customer.created' | 'customer.deleted' | 'customer.updated' | 'customer_group.created' | 'customer_group.deleted' | 'customer_group.updated' | 'player.achievement_unlocked' | 'player.level_up' | 'player.quest_completed' | 'player.streak_milestone' | 'player.xp_gained' | 'social.high_five_sent' | 'social.one_up_sent' | 'survey.submitted' | 'ticket.assigned' | 'ticket.closed' | 'ticket.created' | 'ticket.deleted' | 'ticket.message_added' | 'ticket.updated';
+type WebhookEventType = 'agent.preferences_updated' | 'article.created' | 'article.deleted' | 'article.published' | 'article.updated' | 'boss.damaged' | 'boss.defeated' | 'boss.spawned' | 'community_post.commented' | 'community_post.created' | 'community_post.deleted' | 'community_post.status_changed' | 'community_post.updated' | 'community_post.voted' | 'customer.created' | 'customer.deleted' | 'customer.updated' | 'customer_group.created' | 'customer_group.deleted' | 'customer_group.updated' | 'player.achievement_unlocked' | 'player.level_up' | 'player.quest_completed' | 'player.streak_milestone' | 'player.xp_gained' | 'social.high_five_sent' | 'social.one_up_sent' | 'survey.submitted' | 'team.preferences_updated' | 'ticket.assigned' | 'ticket.closed' | 'ticket.created' | 'ticket.deleted' | 'ticket.message_added' | 'ticket.updated';
+/** Payload for `agent.preferences_updated` events. */
+interface AgentPreferencesUpdatedPayload {
+    team_id: string;
+    member_id: string;
+    agent_id: string;
+    changed: Array<string>;
+    preferences: {
+        boringMode: boolean;
+    };
+}
 /** Payload for `article.created` events. */
 interface ArticleCreatedPayload {
     article: {
@@ -857,6 +867,14 @@ interface SurveySubmittedPayload {
         email: string;
     };
 }
+/** Payload for `team.preferences_updated` events. */
+interface TeamPreferencesUpdatedPayload {
+    team_id: string;
+    changed: Array<string>;
+    preferences: {
+        bossBattlesEnabled: boolean;
+    };
+}
 /** Payload for `ticket.assigned` events. */
 interface TicketAssignedPayload {
     ticket: {
@@ -947,6 +965,7 @@ interface TicketUpdatedPayload {
 }
 /** Maps each event type to its payload interface — used internally for the discriminated union. */
 interface WebhookEventDataMap {
+    'agent.preferences_updated': AgentPreferencesUpdatedPayload;
     'article.created': ArticleCreatedPayload;
     'article.deleted': ArticleDeletedPayload;
     'article.published': ArticlePublishedPayload;
@@ -974,6 +993,7 @@ interface WebhookEventDataMap {
     'social.high_five_sent': SocialHighFiveSentPayload;
     'social.one_up_sent': SocialOneUpSentPayload;
     'survey.submitted': SurveySubmittedPayload;
+    'team.preferences_updated': TeamPreferencesUpdatedPayload;
     'ticket.assigned': TicketAssignedPayload;
     'ticket.closed': TicketClosedPayload;
     'ticket.created': TicketCreatedPayload;
@@ -994,6 +1014,20 @@ interface WebhookEvent<T extends WebhookEventType = WebhookEventType> {
     /** Event-specific payload. */
     data: WebhookEventDataMap[T];
 }
+/**
+ * Stable representative payloads for each event type. Useful for testing
+ * your endpoint against realistic shapes without having to trigger a real
+ * event. Mirrors the dashboard's event catalog.
+ */
+declare const WEBHOOK_EVENT_SAMPLES: {
+    [K in WebhookEventType]: WebhookEventDataMap[K];
+};
+/** Static metadata about every event — labels, descriptions, categories. */
+declare const WEBHOOK_EVENT_CATALOG: Record<WebhookEventType, {
+    label: string;
+    description: string;
+    category: string;
+}>;
 
 type WebhookEventData<T extends WebhookEventType> = WebhookEventDataMap[T];
 
@@ -1516,6 +1550,40 @@ interface InviteCreateParams {
     role?: string;
 }
 
+/**
+ * Team and member preferences — UX toggles exposed via the bearer-token API.
+ *
+ * Backed by:
+ *   - `/api/v1/teams/{teamId}/preferences` (TeamPreferences)
+ *   - `/api/v1/teams/{teamId}/members/{memberId}/preferences` (MemberPreferences)
+ *
+ * Kept narrow on purpose: only the toggles a headless dashboard needs to
+ * flip from a server. Add new fields here when the matching column lands
+ * on the handler's ALLOWED map.
+ */
+/** Team-wide UX preferences. */
+interface TeamPreferences {
+    /** When false, hides the team boss feature for every agent. */
+    bossBattlesEnabled: boolean | null;
+}
+/** Patch shape for team preferences. */
+interface TeamPreferencesUpdateParams {
+    bossBattlesEnabled?: boolean;
+}
+/** Per-agent UX preferences. */
+interface MemberPreferences {
+    /**
+     * When true, hides every gamification element for this agent. XP keeps
+     * accumulating in the background — flipping back to false restores the
+     * full game UI without losing progress.
+     */
+    boringMode: boolean | null;
+}
+/** Patch shape for member preferences. */
+interface MemberPreferencesUpdateParams {
+    boringMode?: boolean;
+}
+
 /** Manage team invites as a sub-resource. */
 declare class InvitesResource {
     private readonly client;
@@ -1527,11 +1595,22 @@ declare class InvitesResource {
     /** Revoke a pending invite. */
     del(inviteId: string): Promise<ApiResponse<DeleteResponse>>;
 }
+/** Manage per-agent UX preferences as a sub-resource of members. */
+declare class MemberPreferencesResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** Get an agent's UX preferences (boring mode, etc.). */
+    get(memberId: string): Promise<ApiResponse<MemberPreferences>>;
+    /** Update an agent's UX preferences. Only provided fields are written. */
+    update(memberId: string, params: MemberPreferencesUpdateParams): Promise<ApiResponse<MemberPreferences>>;
+}
 /** Manage team members. */
 declare class MembersResource {
     private readonly client;
     /** Sub-resource for team invites. */
     readonly invites: InvitesResource;
+    /** Sub-resource for per-agent UX preferences. */
+    readonly preferences: MemberPreferencesResource;
     constructor(client: HttpClient);
     /** List all team members. */
     list(params?: MemberListParams): Promise<ListResponse<Member>>;
@@ -2996,6 +3075,21 @@ declare class BillingResource {
     portal(params?: BillingPortalParams): Promise<ApiResponse<BillingPortal>>;
 }
 
+/**
+ * Team-wide preferences. Wraps `/api/v1/teams/{teamId}/preferences`.
+ *
+ * Currently exposes the team-level boss-battles toggle. Read requires
+ * `manage_settings`; write requires the same plus a secret key.
+ */
+declare class PreferencesResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** Get team preferences. */
+    get(): Promise<ApiResponse<TeamPreferences>>;
+    /** Update team preferences. Only provided fields are written. */
+    update(params: TeamPreferencesUpdateParams): Promise<ApiResponse<TeamPreferences>>;
+}
+
 interface QueueItem {
     /** Unique queue item ID. */
     id: string;
@@ -3476,6 +3570,8 @@ declare class CStarClient {
     readonly members: MembersResource;
     /** Manage team settings, statuses, quick replies, business hours, and widget. */
     readonly settings: SettingsResource;
+    /** Team-wide UX preferences (boss-battles toggle, etc.). */
+    readonly preferences: PreferencesResource;
     /** Manage notifications. */
     readonly notifications: NotificationsResource;
     /** Manage @mentions. */
@@ -3565,4 +3661,4 @@ declare class CStarClient {
     get lastMeta(): LastMeta;
 }
 
-export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarConflictError, CStarError, CStarFeatureDisabledError, CStarNotFoundError, CStarPermissionError, CStarRateLimitError, CStarRealtime, CStarServerError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, ErrorType, type EventHandler, type ExportCreateParams, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleStreak, type Quest, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
+export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarConflictError, CStarError, CStarFeatureDisabledError, CStarNotFoundError, CStarPermissionError, CStarRateLimitError, CStarRealtime, CStarServerError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, ErrorType, type EventHandler, type ExportCreateParams, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleStreak, type Quest, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, WEBHOOK_EVENT_CATALOG, WEBHOOK_EVENT_SAMPLES, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };