@cstar.help/js 0.15.0 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -582,7 +582,17 @@ declare class ArticlesResource extends BaseResource<Article, ArticleListParams,
582
582
  }
583
583
 
584
584
  /** Every webhook event type cStar can dispatch. */
585
- 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';
585
+ 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';
586
+ /** Payload for `agent.preferences_updated` events. */
587
+ interface AgentPreferencesUpdatedPayload {
588
+ team_id: string;
589
+ member_id: string;
590
+ agent_id: string;
591
+ changed: Array<string>;
592
+ preferences: {
593
+ boringMode: boolean;
594
+ };
595
+ }
586
596
  /** Payload for `article.created` events. */
587
597
  interface ArticleCreatedPayload {
588
598
  article: {
@@ -857,6 +867,14 @@ interface SurveySubmittedPayload {
857
867
  email: string;
858
868
  };
859
869
  }
870
+ /** Payload for `team.preferences_updated` events. */
871
+ interface TeamPreferencesUpdatedPayload {
872
+ team_id: string;
873
+ changed: Array<string>;
874
+ preferences: {
875
+ bossBattlesEnabled: boolean;
876
+ };
877
+ }
860
878
  /** Payload for `ticket.assigned` events. */
861
879
  interface TicketAssignedPayload {
862
880
  ticket: {
@@ -947,6 +965,7 @@ interface TicketUpdatedPayload {
947
965
  }
948
966
  /** Maps each event type to its payload interface — used internally for the discriminated union. */
949
967
  interface WebhookEventDataMap {
968
+ 'agent.preferences_updated': AgentPreferencesUpdatedPayload;
950
969
  'article.created': ArticleCreatedPayload;
951
970
  'article.deleted': ArticleDeletedPayload;
952
971
  'article.published': ArticlePublishedPayload;
@@ -974,6 +993,7 @@ interface WebhookEventDataMap {
974
993
  'social.high_five_sent': SocialHighFiveSentPayload;
975
994
  'social.one_up_sent': SocialOneUpSentPayload;
976
995
  'survey.submitted': SurveySubmittedPayload;
996
+ 'team.preferences_updated': TeamPreferencesUpdatedPayload;
977
997
  'ticket.assigned': TicketAssignedPayload;
978
998
  'ticket.closed': TicketClosedPayload;
979
999
  'ticket.created': TicketCreatedPayload;
@@ -994,6 +1014,20 @@ interface WebhookEvent<T extends WebhookEventType = WebhookEventType> {
994
1014
  /** Event-specific payload. */
995
1015
  data: WebhookEventDataMap[T];
996
1016
  }
1017
+ /**
1018
+ * Stable representative payloads for each event type. Useful for testing
1019
+ * your endpoint against realistic shapes without having to trigger a real
1020
+ * event. Mirrors the dashboard's event catalog.
1021
+ */
1022
+ declare const WEBHOOK_EVENT_SAMPLES: {
1023
+ [K in WebhookEventType]: WebhookEventDataMap[K];
1024
+ };
1025
+ /** Static metadata about every event — labels, descriptions, categories. */
1026
+ declare const WEBHOOK_EVENT_CATALOG: Record<WebhookEventType, {
1027
+ label: string;
1028
+ description: string;
1029
+ category: string;
1030
+ }>;
997
1031
 
998
1032
  type WebhookEventData<T extends WebhookEventType> = WebhookEventDataMap[T];
999
1033
 
@@ -1516,6 +1550,40 @@ interface InviteCreateParams {
1516
1550
  role?: string;
1517
1551
  }
1518
1552
 
1553
+ /**
1554
+ * Team and member preferences — UX toggles exposed via the bearer-token API.
1555
+ *
1556
+ * Backed by:
1557
+ * - `/api/v1/teams/{teamId}/preferences` (TeamPreferences)
1558
+ * - `/api/v1/teams/{teamId}/members/{memberId}/preferences` (MemberPreferences)
1559
+ *
1560
+ * Kept narrow on purpose: only the toggles a headless dashboard needs to
1561
+ * flip from a server. Add new fields here when the matching column lands
1562
+ * on the handler's ALLOWED map.
1563
+ */
1564
+ /** Team-wide UX preferences. */
1565
+ interface TeamPreferences {
1566
+ /** When false, hides the team boss feature for every agent. */
1567
+ bossBattlesEnabled: boolean | null;
1568
+ }
1569
+ /** Patch shape for team preferences. */
1570
+ interface TeamPreferencesUpdateParams {
1571
+ bossBattlesEnabled?: boolean;
1572
+ }
1573
+ /** Per-agent UX preferences. */
1574
+ interface MemberPreferences {
1575
+ /**
1576
+ * When true, hides every gamification element for this agent. XP keeps
1577
+ * accumulating in the background — flipping back to false restores the
1578
+ * full game UI without losing progress.
1579
+ */
1580
+ boringMode: boolean | null;
1581
+ }
1582
+ /** Patch shape for member preferences. */
1583
+ interface MemberPreferencesUpdateParams {
1584
+ boringMode?: boolean;
1585
+ }
1586
+
1519
1587
  /** Manage team invites as a sub-resource. */
1520
1588
  declare class InvitesResource {
1521
1589
  private readonly client;
@@ -1527,11 +1595,22 @@ declare class InvitesResource {
1527
1595
  /** Revoke a pending invite. */
1528
1596
  del(inviteId: string): Promise<ApiResponse<DeleteResponse>>;
1529
1597
  }
1598
+ /** Manage per-agent UX preferences as a sub-resource of members. */
1599
+ declare class MemberPreferencesResource {
1600
+ private readonly client;
1601
+ constructor(client: HttpClient);
1602
+ /** Get an agent's UX preferences (boring mode, etc.). */
1603
+ get(memberId: string): Promise<ApiResponse<MemberPreferences>>;
1604
+ /** Update an agent's UX preferences. Only provided fields are written. */
1605
+ update(memberId: string, params: MemberPreferencesUpdateParams): Promise<ApiResponse<MemberPreferences>>;
1606
+ }
1530
1607
  /** Manage team members. */
1531
1608
  declare class MembersResource {
1532
1609
  private readonly client;
1533
1610
  /** Sub-resource for team invites. */
1534
1611
  readonly invites: InvitesResource;
1612
+ /** Sub-resource for per-agent UX preferences. */
1613
+ readonly preferences: MemberPreferencesResource;
1535
1614
  constructor(client: HttpClient);
1536
1615
  /** List all team members. */
1537
1616
  list(params?: MemberListParams): Promise<ListResponse<Member>>;
@@ -2996,6 +3075,21 @@ declare class BillingResource {
2996
3075
  portal(params?: BillingPortalParams): Promise<ApiResponse<BillingPortal>>;
2997
3076
  }
2998
3077
 
3078
+ /**
3079
+ * Team-wide preferences. Wraps `/api/v1/teams/{teamId}/preferences`.
3080
+ *
3081
+ * Currently exposes the team-level boss-battles toggle. Read requires
3082
+ * `manage_settings`; write requires the same plus a secret key.
3083
+ */
3084
+ declare class PreferencesResource {
3085
+ private readonly client;
3086
+ constructor(client: HttpClient);
3087
+ /** Get team preferences. */
3088
+ get(): Promise<ApiResponse<TeamPreferences>>;
3089
+ /** Update team preferences. Only provided fields are written. */
3090
+ update(params: TeamPreferencesUpdateParams): Promise<ApiResponse<TeamPreferences>>;
3091
+ }
3092
+
2999
3093
  interface QueueItem {
3000
3094
  /** Unique queue item ID. */
3001
3095
  id: string;
@@ -3110,59 +3204,308 @@ interface ApiErrorBody {
3110
3204
  enable_url?: string;
3111
3205
  }
3112
3206
  /** Base error class for all cStar API errors. */
3113
- declare class CStarErrorImpl extends Error {
3114
- readonly type: string;
3115
- readonly code: string;
3116
- readonly param?: string;
3117
- readonly docUrl: string;
3118
- readonly requestId?: string;
3119
- readonly statusCode: number;
3120
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3121
- }
3122
- declare class CStarAuthenticationErrorImpl extends CStarErrorImpl {
3123
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3124
- }
3125
- declare class CStarRateLimitErrorImpl extends CStarErrorImpl {
3126
- readonly retryAfter: number;
3127
- constructor(messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number);
3128
- }
3129
- declare class CStarNotFoundErrorImpl extends CStarErrorImpl {
3130
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3131
- }
3132
- declare class CStarValidationErrorImpl extends CStarErrorImpl {
3133
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3134
- }
3135
- declare class CStarPermissionErrorImpl extends CStarErrorImpl {
3136
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3137
- }
3138
- declare class CStarConflictErrorImpl extends CStarErrorImpl {
3139
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3140
- }
3141
- declare class CStarServerErrorImpl extends CStarErrorImpl {
3142
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3143
- }
3144
- declare class CStarFeatureDisabledErrorImpl extends CStarErrorImpl {
3145
- readonly feature: string;
3146
- readonly enableUrl: string;
3147
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3148
- }
3149
- declare const CStarError: typeof CStarErrorImpl;
3207
+ declare const CStarErrorImpl: {
3208
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3209
+ readonly type: string;
3210
+ readonly code: string;
3211
+ readonly param?: string;
3212
+ readonly docUrl: string;
3213
+ readonly requestId?: string;
3214
+ readonly statusCode: number;
3215
+ name: string;
3216
+ message: string;
3217
+ stack?: string;
3218
+ };
3219
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3220
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3221
+ stackTraceLimit: number;
3222
+ };
3223
+ declare const CStarAuthenticationErrorImpl: {
3224
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3225
+ readonly type: string;
3226
+ readonly code: string;
3227
+ readonly param?: string;
3228
+ readonly docUrl: string;
3229
+ readonly requestId?: string;
3230
+ readonly statusCode: number;
3231
+ name: string;
3232
+ message: string;
3233
+ stack?: string;
3234
+ };
3235
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3236
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3237
+ stackTraceLimit: number;
3238
+ };
3239
+ declare const CStarRateLimitErrorImpl: {
3240
+ new (messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number): {
3241
+ readonly retryAfter: number;
3242
+ readonly type: string;
3243
+ readonly code: string;
3244
+ readonly param?: string;
3245
+ readonly docUrl: string;
3246
+ readonly requestId?: string;
3247
+ readonly statusCode: number;
3248
+ name: string;
3249
+ message: string;
3250
+ stack?: string;
3251
+ };
3252
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3253
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3254
+ stackTraceLimit: number;
3255
+ };
3256
+ declare const CStarNotFoundErrorImpl: {
3257
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3258
+ readonly type: string;
3259
+ readonly code: string;
3260
+ readonly param?: string;
3261
+ readonly docUrl: string;
3262
+ readonly requestId?: string;
3263
+ readonly statusCode: number;
3264
+ name: string;
3265
+ message: string;
3266
+ stack?: string;
3267
+ };
3268
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3269
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3270
+ stackTraceLimit: number;
3271
+ };
3272
+ declare const CStarValidationErrorImpl: {
3273
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3274
+ readonly type: string;
3275
+ readonly code: string;
3276
+ readonly param?: string;
3277
+ readonly docUrl: string;
3278
+ readonly requestId?: string;
3279
+ readonly statusCode: number;
3280
+ name: string;
3281
+ message: string;
3282
+ stack?: string;
3283
+ };
3284
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3285
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3286
+ stackTraceLimit: number;
3287
+ };
3288
+ declare const CStarPermissionErrorImpl: {
3289
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3290
+ readonly type: string;
3291
+ readonly code: string;
3292
+ readonly param?: string;
3293
+ readonly docUrl: string;
3294
+ readonly requestId?: string;
3295
+ readonly statusCode: number;
3296
+ name: string;
3297
+ message: string;
3298
+ stack?: string;
3299
+ };
3300
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3301
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3302
+ stackTraceLimit: number;
3303
+ };
3304
+ declare const CStarConflictErrorImpl: {
3305
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3306
+ readonly type: string;
3307
+ readonly code: string;
3308
+ readonly param?: string;
3309
+ readonly docUrl: string;
3310
+ readonly requestId?: string;
3311
+ readonly statusCode: number;
3312
+ name: string;
3313
+ message: string;
3314
+ stack?: string;
3315
+ };
3316
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3317
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3318
+ stackTraceLimit: number;
3319
+ };
3320
+ declare const CStarServerErrorImpl: {
3321
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3322
+ readonly type: string;
3323
+ readonly code: string;
3324
+ readonly param?: string;
3325
+ readonly docUrl: string;
3326
+ readonly requestId?: string;
3327
+ readonly statusCode: number;
3328
+ name: string;
3329
+ message: string;
3330
+ stack?: string;
3331
+ };
3332
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3333
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3334
+ stackTraceLimit: number;
3335
+ };
3336
+ declare const CStarFeatureDisabledErrorImpl: {
3337
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3338
+ readonly feature: string;
3339
+ readonly enableUrl: string;
3340
+ readonly type: string;
3341
+ readonly code: string;
3342
+ readonly param?: string;
3343
+ readonly docUrl: string;
3344
+ readonly requestId?: string;
3345
+ readonly statusCode: number;
3346
+ name: string;
3347
+ message: string;
3348
+ stack?: string;
3349
+ };
3350
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3351
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3352
+ stackTraceLimit: number;
3353
+ };
3354
+ declare const CStarError: {
3355
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3356
+ readonly type: string;
3357
+ readonly code: string;
3358
+ readonly param?: string;
3359
+ readonly docUrl: string;
3360
+ readonly requestId?: string;
3361
+ readonly statusCode: number;
3362
+ name: string;
3363
+ message: string;
3364
+ stack?: string;
3365
+ };
3366
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3367
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3368
+ stackTraceLimit: number;
3369
+ };
3150
3370
  type CStarError = InstanceType<typeof CStarErrorImpl>;
3151
- declare const CStarAuthenticationError: typeof CStarAuthenticationErrorImpl;
3371
+ declare const CStarAuthenticationError: {
3372
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3373
+ readonly type: string;
3374
+ readonly code: string;
3375
+ readonly param?: string;
3376
+ readonly docUrl: string;
3377
+ readonly requestId?: string;
3378
+ readonly statusCode: number;
3379
+ name: string;
3380
+ message: string;
3381
+ stack?: string;
3382
+ };
3383
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3384
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3385
+ stackTraceLimit: number;
3386
+ };
3152
3387
  type CStarAuthenticationError = InstanceType<typeof CStarAuthenticationErrorImpl>;
3153
- declare const CStarRateLimitError: typeof CStarRateLimitErrorImpl;
3388
+ declare const CStarRateLimitError: {
3389
+ new (messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number): {
3390
+ readonly retryAfter: number;
3391
+ readonly type: string;
3392
+ readonly code: string;
3393
+ readonly param?: string;
3394
+ readonly docUrl: string;
3395
+ readonly requestId?: string;
3396
+ readonly statusCode: number;
3397
+ name: string;
3398
+ message: string;
3399
+ stack?: string;
3400
+ };
3401
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3402
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3403
+ stackTraceLimit: number;
3404
+ };
3154
3405
  type CStarRateLimitError = InstanceType<typeof CStarRateLimitErrorImpl>;
3155
- declare const CStarNotFoundError: typeof CStarNotFoundErrorImpl;
3406
+ declare const CStarNotFoundError: {
3407
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3408
+ readonly type: string;
3409
+ readonly code: string;
3410
+ readonly param?: string;
3411
+ readonly docUrl: string;
3412
+ readonly requestId?: string;
3413
+ readonly statusCode: number;
3414
+ name: string;
3415
+ message: string;
3416
+ stack?: string;
3417
+ };
3418
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3419
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3420
+ stackTraceLimit: number;
3421
+ };
3156
3422
  type CStarNotFoundError = InstanceType<typeof CStarNotFoundErrorImpl>;
3157
- declare const CStarValidationError: typeof CStarValidationErrorImpl;
3423
+ declare const CStarValidationError: {
3424
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3425
+ readonly type: string;
3426
+ readonly code: string;
3427
+ readonly param?: string;
3428
+ readonly docUrl: string;
3429
+ readonly requestId?: string;
3430
+ readonly statusCode: number;
3431
+ name: string;
3432
+ message: string;
3433
+ stack?: string;
3434
+ };
3435
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3436
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3437
+ stackTraceLimit: number;
3438
+ };
3158
3439
  type CStarValidationError = InstanceType<typeof CStarValidationErrorImpl>;
3159
- declare const CStarPermissionError: typeof CStarPermissionErrorImpl;
3440
+ declare const CStarPermissionError: {
3441
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3442
+ readonly type: string;
3443
+ readonly code: string;
3444
+ readonly param?: string;
3445
+ readonly docUrl: string;
3446
+ readonly requestId?: string;
3447
+ readonly statusCode: number;
3448
+ name: string;
3449
+ message: string;
3450
+ stack?: string;
3451
+ };
3452
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3453
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3454
+ stackTraceLimit: number;
3455
+ };
3160
3456
  type CStarPermissionError = InstanceType<typeof CStarPermissionErrorImpl>;
3161
- declare const CStarConflictError: typeof CStarConflictErrorImpl;
3457
+ declare const CStarConflictError: {
3458
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3459
+ readonly type: string;
3460
+ readonly code: string;
3461
+ readonly param?: string;
3462
+ readonly docUrl: string;
3463
+ readonly requestId?: string;
3464
+ readonly statusCode: number;
3465
+ name: string;
3466
+ message: string;
3467
+ stack?: string;
3468
+ };
3469
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3470
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3471
+ stackTraceLimit: number;
3472
+ };
3162
3473
  type CStarConflictError = InstanceType<typeof CStarConflictErrorImpl>;
3163
- declare const CStarServerError: typeof CStarServerErrorImpl;
3474
+ declare const CStarServerError: {
3475
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3476
+ readonly type: string;
3477
+ readonly code: string;
3478
+ readonly param?: string;
3479
+ readonly docUrl: string;
3480
+ readonly requestId?: string;
3481
+ readonly statusCode: number;
3482
+ name: string;
3483
+ message: string;
3484
+ stack?: string;
3485
+ };
3486
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3487
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3488
+ stackTraceLimit: number;
3489
+ };
3164
3490
  type CStarServerError = InstanceType<typeof CStarServerErrorImpl>;
3165
- declare const CStarFeatureDisabledError: typeof CStarFeatureDisabledErrorImpl;
3491
+ declare const CStarFeatureDisabledError: {
3492
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3493
+ readonly feature: string;
3494
+ readonly enableUrl: string;
3495
+ readonly type: string;
3496
+ readonly code: string;
3497
+ readonly param?: string;
3498
+ readonly docUrl: string;
3499
+ readonly requestId?: string;
3500
+ readonly statusCode: number;
3501
+ name: string;
3502
+ message: string;
3503
+ stack?: string;
3504
+ };
3505
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3506
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3507
+ stackTraceLimit: number;
3508
+ };
3166
3509
  type CStarFeatureDisabledError = InstanceType<typeof CStarFeatureDisabledErrorImpl>;
3167
3510
 
3168
3511
  /** Configuration for the CStarClient. */
@@ -3227,6 +3570,8 @@ declare class CStarClient {
3227
3570
  readonly members: MembersResource;
3228
3571
  /** Manage team settings, statuses, quick replies, business hours, and widget. */
3229
3572
  readonly settings: SettingsResource;
3573
+ /** Team-wide UX preferences (boss-battles toggle, etc.). */
3574
+ readonly preferences: PreferencesResource;
3230
3575
  /** Manage notifications. */
3231
3576
  readonly notifications: NotificationsResource;
3232
3577
  /** Manage @mentions. */
@@ -3316,4 +3661,4 @@ declare class CStarClient {
3316
3661
  get lastMeta(): LastMeta;
3317
3662
  }
3318
3663
 
3319
- 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 };
3664
+ 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 };