@cstar.help/js 0.5.0 → 0.5.1

package/dist/index.d.cts

@@ -419,6 +419,38 @@ interface WebhookTestResult {
     responseTimeMs: number;
     error: string | null;
 }
+/** Parameters for subscribing (REST Hooks / Zapier protocol). */
+interface WebhookSubscribeParams {
+    targetUrl: string;
+    event: string;
+}
+/** A REST Hooks subscription. */
+interface WebhookSubscription {
+    id: string;
+    object: 'webhook';
+    [key: string]: unknown;
+}
+/** Parameters for registering a CLI listener. */
+interface WebhookListenerParams {
+    forwardUrl: string;
+    events?: string[];
+}
+/** A registered CLI listener. */
+interface WebhookListener {
+    listenerId: string;
+    secret: string;
+}
+/** Parameters for triggering a test webhook event. */
+interface WebhookTriggerTestParams {
+    event: string;
+    data?: Record<string, unknown>;
+}
+/** Result of triggering a test webhook event. */
+interface WebhookTriggerTestResult {
+    event: string;
+    deliveredTo: number;
+    [key: string]: unknown;
+}
 
 /** Manage webhook endpoints. */
 declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams, WebhookCreateParams, WebhookUpdateParams> {
@@ -427,6 +459,21 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     test(webhookId: string, params?: {
         event?: WebhookEventType;
     }): Promise<ApiResponse<WebhookTestResult>>;
+    /** Fire a test webhook event to all active webhooks and CLI listeners. */
+    triggerTest(params: WebhookTriggerTestParams, options?: RequestOptions): Promise<ApiResponse<WebhookTriggerTestResult>>;
+    /** Get a sample webhook payload for an event type (used by Zapier). */
+    sample(event: string): Promise<ApiResponse<unknown[]>>;
+    /** Subscribe to an event (REST Hooks / Zapier protocol). */
+    subscribe(params: WebhookSubscribeParams, options?: RequestOptions): Promise<ApiResponse<WebhookSubscription>>;
+    /** Unsubscribe from an event (REST Hooks / Zapier protocol). Returns void (204 No Content). */
+    unsubscribe(subscriptionId: string): Promise<void>;
+    /** Register a CLI listener (returns listenerId and signing secret). */
+    listen(params: WebhookListenerParams, options?: RequestOptions): Promise<ApiResponse<WebhookListener>>;
+    /** Deregister a CLI listener. */
+    unlisten(listenerId: string): Promise<ApiResponse<{
+        deleted: true;
+        listenerId: string;
+    }>>;
 }
 
 /** A condition in an automation rule. */
@@ -968,15 +1015,64 @@ interface UnreadCount {
 declare class NotificationsResource {
     private readonly client;
     constructor(client: HttpClient);
-    /** List notifications. */
-    list(params?: NotificationListParams): Promise<ListResponse<Notification>>;
-    /** Get unread notification count. */
-    unreadCount(): Promise<ApiResponse<UnreadCount>>;
+    /** List notifications for a user. */
+    list(params: NotificationListParams & {
+        userId: string;
+    }): Promise<ListResponse<Notification>>;
+    /** Get unread notification count for a user. */
+    unreadCount(userId: string): Promise<ApiResponse<UnreadCount>>;
     /** Mark a single notification as read. */
-    markRead(notificationId: string): Promise<ApiResponse<Notification>>;
+    markRead(notificationId: string, userId: string): Promise<ApiResponse<Notification>>;
     /** Mark all notifications as read. */
-    markAllRead(): Promise<ApiResponse<{
-        updated: number;
+    markAllRead(userId: string): Promise<ApiResponse<{
+        markedRead: number;
+    }>>;
+    /** Delete (dismiss) a notification. For broadcast notifications, pass userId as a query param. */
+    del(notificationId: string, params?: {
+        userId?: string;
+    }): Promise<ApiResponse<DeleteResponse>>;
+}
+
+/** A mention. */
+interface Mention {
+    id: string;
+    object: 'mention';
+    senderId: string;
+    senderName: string | null;
+    recipientId: string;
+    recipientName: string | null;
+    ticketId: string | null;
+    ticketTitle: string | null;
+    isRead: boolean;
+    createdAt: string;
+}
+/** Parameters for listing mentions. */
+interface MentionListParams extends PaginationParams {
+    isRead?: string;
+}
+/** Unread mention count. */
+interface MentionUnreadCount {
+    unreadCount: number;
+}
+
+/** Manage @mentions. */
+declare class MentionsResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** List mentions for a user. */
+    list(params: MentionListParams & {
+        userId: string;
+    }): Promise<ListResponse<Mention>>;
+    /** Get unread mention count for a user. */
+    unreadCount(userId: string): Promise<ApiResponse<MentionUnreadCount>>;
+    /** Mark a single mention as read. */
+    markRead(mentionId: string): Promise<ApiResponse<{
+        id: string;
+        isRead: true;
+    }>>;
+    /** Mark all mentions as read for a user. */
+    markAllRead(userId: string): Promise<ApiResponse<{
+        markedRead: number;
     }>>;
 }
 
@@ -1103,100 +1199,171 @@ interface SlaRuleUpdateParams {
     businessHoursOnly?: boolean;
     enabled?: boolean;
 }
+/** Parameters for SLA metrics query. */
+interface SlaMetricsParams {
+    period?: 'day' | 'week' | 'month' | 'quarter';
+    startDate?: string;
+    endDate?: string;
+    agentId?: string;
+}
+/** SLA compliance metrics response. */
+interface SlaMetrics {
+    object: 'sla_metrics';
+    period: string;
+    [key: string]: unknown;
+}
 
-/** Manage SLA rules. */
+/** Manage SLA rules and metrics. */
 declare class SlaResource {
     private readonly client;
     constructor(client: HttpClient);
     /** List SLA rules. */
     list(params?: SlaRuleListParams): Promise<ListResponse<SlaRule>>;
-    /** Get a single SLA rule. */
-    get(ruleId: string): Promise<ApiResponse<SlaRule>>;
     /** Create an SLA rule. */
     create(params: SlaRuleCreateParams, options?: RequestOptions): Promise<ApiResponse<SlaRule>>;
     /** Update an SLA rule. */
     update(ruleId: string, params: SlaRuleUpdateParams): Promise<ApiResponse<SlaRule>>;
     /** Delete an SLA rule. */
     del(ruleId: string): Promise<ApiResponse<DeleteResponse>>;
+    /** Reorder SLA rules by providing an ordered array of IDs. */
+    reorder(orderedIds: string[]): Promise<ApiResponse<SlaRule[]>>;
+    /** Get SLA compliance metrics. */
+    metrics(params?: SlaMetricsParams): Promise<ApiResponse<SlaMetrics>>;
 }
 
-/** Analytics overview response. */
+/**
+ * Analytics response. Shape varies by `type` parameter:
+ * - overview/tickets: tickets, priorities, statusBreakdown, responseTime, resolutionTime
+ * - performance: agents array
+ * - library: totalArticles, publishedArticles, draftArticles
+ */
 interface AnalyticsOverview {
-    object: 'analytics_overview';
+    object: 'analytics';
+    type: string;
     period: string;
-    tickets: {
+    /** Present for type=overview and type=tickets */
+    tickets?: {
         total: number;
+        new: number;
+        closed: number;
         open: number;
-        resolved: number;
-        avgResponseTime: number | null;
-        avgResolutionTime: number | null;
     };
-    customers: {
-        total: number;
-        active: number;
-        new: number;
+    priorities?: Record<string, number>;
+    statusBreakdown?: Record<string, number>;
+    responseTime?: {
+        avgSeconds: number | null;
+        samplesCount: number;
     };
-    csat: {
-        average: number | null;
-        totalResponses: number;
+    resolutionTime?: {
+        avgSeconds: number | null;
+        samplesCount: number;
     };
+    /** Present for type=performance */
+    agents?: Array<{
+        agentId: string;
+        ticketsClosed: number;
+        avgResponseSeconds: number | null;
+        goldTier: number;
+        missedSla: number;
+    }>;
+    /** Present for type=library */
+    totalArticles?: number;
+    publishedArticles?: number;
+    draftArticles?: number;
     [key: string]: unknown;
 }
 /** Analytics query parameters. */
 interface AnalyticsParams {
-    period?: 'day' | 'week' | 'month' | 'quarter' | 'year';
-    startDate?: string;
-    endDate?: string;
-}
-/** Agent performance stats. */
-interface AgentStats {
-    object: 'agent_stats';
-    userId: string;
-    name: string;
-    ticketsResolved: number;
-    avgResponseTime: number | null;
-    avgResolutionTime: number | null;
-    csatAverage: number | null;
-    [key: string]: unknown;
+    type?: 'overview' | 'tickets' | 'performance' | 'library';
+    period?: 'day' | 'week' | 'month' | 'quarter';
+    agentId?: string;
 }
-/** CSAT statistics. */
+/** CSAT statistics (from /csat/stats). */
 interface CsatStats {
     object: 'csat_stats';
-    average: number | null;
-    totalResponses: number;
+    period: string;
+    totalSent: number;
+    totalCompleted: number;
+    responseRate: number;
+    averageRating: number | null;
     distribution: Record<string, number>;
-    trend: Array<{
-        date: string;
-        average: number;
-        count: number;
-    }>;
+    positiveRate: number;
 }
-/** A CSAT response. */
-interface CsatResponse {
+/** A CSAT survey (from /csat/surveys). */
+interface CsatSurvey {
     id: string;
-    object: 'csat_response';
+    object: 'csat_survey';
     ticketId: string;
     customerId: string | null;
-    rating: number;
+    agentId: string | null;
+    rating: number | null;
     comment: string | null;
+    sentAt: string | null;
+    completedAt: string | null;
+    expiresAt: string | null;
     createdAt: string;
 }
+/** Parameters for listing CSAT surveys. */
+interface CsatSurveyListParams extends PaginationParams {
+    completed?: string;
+    agentId?: string;
+}
+/** Parameters for creating a CSAT survey. */
+interface CsatSurveyCreateParams {
+    ticketId: string;
+    customerId?: string;
+    agentId?: string;
+}
+/** CSAT settings. */
+interface CsatSettings {
+    object: 'csat_settings';
+    enabled: boolean;
+    delayMinutes: number;
+    expirationDays: number;
+}
+/** Parameters for updating CSAT settings. */
+interface CsatSettingsUpdateParams {
+    enabled?: boolean;
+    delayMinutes?: number;
+    expirationDays?: number;
+}
 
+/** Manage CSAT surveys. */
+declare class CsatSurveysResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** List CSAT surveys. */
+    list(params?: CsatSurveyListParams): Promise<ListResponse<CsatSurvey>>;
+    /** Get a single CSAT survey. */
+    get(surveyId: string): Promise<ApiResponse<CsatSurvey>>;
+    /** Create and send a CSAT survey. */
+    create(params: CsatSurveyCreateParams): Promise<ApiResponse<CsatSurvey>>;
+}
 /** Access analytics and CSAT data. */
 declare class AnalyticsResource {
     private readonly client;
+    /** CSAT surveys sub-resource. */
+    readonly csatSurveys: CsatSurveysResource;
     constructor(client: HttpClient);
-    /** Get analytics overview. */
-    overview(params?: AnalyticsParams): Promise<ApiResponse<AnalyticsOverview>>;
-    /** Get per-agent performance stats. */
-    agents(params?: AnalyticsParams): Promise<ApiResponse<AgentStats[]>>;
+    /** Get analytics data. Specify type to control the response shape. */
+    get(params?: AnalyticsParams): Promise<ApiResponse<AnalyticsOverview>>;
+    /** Get analytics overview (shortcut for type=overview). */
+    overview(params?: Omit<AnalyticsParams, 'type'>): Promise<ApiResponse<AnalyticsOverview>>;
+    /** Get agent performance stats (shortcut for type=performance). */
+    performance(params?: Omit<AnalyticsParams, 'type'> & {
+        agentId?: string;
+    }): Promise<ApiResponse<AnalyticsOverview>>;
+    /** Get library analytics (shortcut for type=library). */
+    library(params?: Omit<AnalyticsParams, 'type'>): Promise<ApiResponse<AnalyticsOverview>>;
     /** Get CSAT statistics. */
-    csatStats(params?: AnalyticsParams): Promise<ApiResponse<CsatStats>>;
-    /** List individual CSAT responses. */
-    csatResponses(params?: AnalyticsParams & {
-        page?: number;
-        pageSize?: number;
-    }): Promise<ListResponse<CsatResponse>>;
+    csatStats(params?: {
+        period?: string;
+        agentId?: string;
+    }): Promise<ApiResponse<CsatStats>>;
+    /** Get CSAT settings. */
+    csatSettings(): Promise<ApiResponse<CsatSettings>>;
+    /** Update CSAT settings. */
+    updateCsatSettings(params: CsatSettingsUpdateParams): Promise<ApiResponse<CsatSettings>>;
 }
 
 /** Bulk operation result. */
@@ -1338,14 +1505,16 @@ declare class AuditLogResource {
     list(params?: AuditLogListParams): Promise<ListResponse<AuditLogEntry>>;
 }
 
-/** Search result item. */
+/** Search result item. Shape varies by type. */
 interface SearchResult {
-    object: 'search_result';
     type: 'ticket' | 'customer' | 'article';
     id: string;
-    title: string;
-    snippet: string | null;
-    score: number;
+    /** Title (tickets, articles) or name (customers). */
+    title?: string;
+    name?: string;
+    email?: string;
+    status?: string;
+    priority?: string;
     [key: string]: unknown;
 }
 /** Search parameters. */
@@ -1441,9 +1610,60 @@ interface CustomerGroupUpdateParams {
     description?: string;
     filters?: Record<string, unknown>;
 }
+/** Parameters for listing group members. */
+interface CustomerGroupMemberListParams extends PaginationParams {
+}
+/** Parameters for adding members to a group. */
+interface CustomerGroupAddMembersParams {
+    customerId?: string;
+    customerIds?: string[];
+}
+/** Group members list result. */
+interface CustomerGroupMembersResult {
+    data: Array<{
+        id: string;
+        object: 'customer';
+        name: string | null;
+        email: string | null;
+        sentiment: string;
+        tags: string[];
+        joinedGroupAt: string;
+    }>;
+    pagination: {
+        total: number;
+        page: number;
+        pageSize: number;
+        hasMore: boolean;
+    };
+}
+/** Result of adding members to a group. */
+interface CustomerGroupAddResult {
+    added: number;
+    total: number;
+    skipped: number;
+}
+/** Result of removing a member from a group. */
+interface CustomerGroupRemoveResult {
+    removed: true;
+    customerId: string;
+    groupId: string;
+}
 
+/** Manage group memberships as a sub-resource. */
+declare class CustomerGroupMembersResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** List members in a group. */
+    list(groupId: string, params?: CustomerGroupMemberListParams): Promise<ApiResponse<CustomerGroupMembersResult>>;
+    /** Add member(s) to a group. */
+    add(groupId: string, params: CustomerGroupAddMembersParams, options?: RequestOptions): Promise<ApiResponse<CustomerGroupAddResult>>;
+    /** Remove a member from a group. */
+    remove(groupId: string, customerId: string): Promise<ApiResponse<CustomerGroupRemoveResult>>;
+}
 /** Manage customer groups/segments. */
 declare class CustomerGroupsResource extends BaseResource<CustomerGroup, CustomerGroupListParams, CustomerGroupCreateParams, CustomerGroupUpdateParams> {
+    /** Sub-resource for group memberships. */
+    readonly members: CustomerGroupMembersResource;
     constructor(client: HttpClient);
 }
 
@@ -1714,6 +1934,17 @@ interface SkillAllocateResult {
     newLevel: number;
     remainingPoints: number;
 }
+/** Game balance configuration (read-only constants from /game/config). */
+interface GameConfig {
+    object: 'game_config';
+    rewards: Record<string, unknown>;
+    streaks: Record<string, unknown>;
+    combo: Record<string, unknown>;
+    boss: Record<string, unknown>;
+    scoring: Record<string, unknown>;
+    leveling: Record<string, unknown>;
+    social: Record<string, unknown>;
+}
 
 declare class BossResource {
     private readonly client;
@@ -1738,9 +1969,22 @@ declare class AchievementsResource {
     constructor(client: HttpClient);
     /** List all achievements with progress. */
     list(params?: AchievementListParams): Promise<ApiResponse<{
-        achievements: Achievement[];
-        totalUnlocked: number;
-        total: number;
+        object: 'achievement_list';
+        data: Achievement[];
+        summary: {
+            total: number;
+            unlocked: number;
+            totalXpEarned: number;
+            totalGoldEarned: number;
+            byCategory: Record<string, {
+                total: number;
+                unlocked: number;
+            }>;
+            byRarity: Record<string, {
+                total: number;
+                unlocked: number;
+            }>;
+        };
     }>>;
     /** List unlocked achievements only. */
     unlocked(params?: {
@@ -1750,6 +1994,33 @@ declare class AchievementsResource {
     get(achievementId: string, params?: {
         userId?: string;
     }): Promise<ApiResponse<Achievement>>;
+    /** Get recently unlocked achievements across the team. */
+    recent(params?: {
+        limit?: number;
+    }): Promise<ApiResponse<{
+        object: 'list';
+        data: Achievement[];
+    }>>;
+}
+declare class GameActivityResource {
+    private readonly client;
+    constructor(client: HttpClient);
+    /** Get the team activity feed. */
+    list(params?: {
+        limit?: number;
+        before?: string;
+    }): Promise<ApiResponse<{
+        object: 'list';
+        data: unknown[];
+        cursor: string | null;
+    }>>;
+    /** Get activity for a specific member. */
+    forMember(memberId: string, params?: {
+        limit?: number;
+    }): Promise<ApiResponse<{
+        object: 'list';
+        data: unknown[];
+    }>>;
 }
 declare class QuestsResource {
     private readonly client;
@@ -1869,6 +2140,8 @@ declare class GameResource {
     readonly seasons: SeasonsResource;
     /** Skill tree. */
     readonly skills: SkillsResource;
+    /** Game activity feed. */
+    readonly activity: GameActivityResource;
     constructor(client: HttpClient);
     /** Get current player stats. */
     player(params?: {
@@ -1883,6 +2156,8 @@ declare class GameResource {
         userId?: string;
         period?: string;
     }): Promise<ApiResponse<LeaderboardEntry>>;
+    /** Get game balance configuration (read-only constants). */
+    config(): Promise<ApiResponse<GameConfig>>;
 }
 
 /** AI action types. */
@@ -1962,7 +2237,7 @@ interface ViewExecuteParams extends PaginationParams {
 /** Manage saved views (saved filters). */
 declare class ViewsResource extends BaseResource<SavedView, ViewListParams, ViewCreateParams, ViewUpdateParams> {
     constructor(client: HttpClient);
-    /** Execute a view — returns the filtered results. */
+    /** Execute a view — returns the filtered results. The server uses the view's entity_type to determine which table to query. */
     execute(viewId: string, params?: ViewExecuteParams): Promise<ListResponse<unknown>>;
 }
 
@@ -2058,12 +2333,23 @@ interface CStarClientConfig {
     timeout?: number;
 }
 /**
- * The cStar API client.
+ * The cStar admin API client. **Server-side only.**
+ *
+ * Requires a secret API key (`sk_live_*` or `sk_test_*`). Never use this in
+ * client-side / browser code — your secret key would be exposed to anyone
+ * viewing your site.
+ *
+ * For client-side integrations, use:
+ * - `@cstar.help/js/chat` — Customer chat widget (publishable key)
+ * - `@cstar.help/js/library` — Public knowledge base (no auth)
+ * - `@cstar.help/js/community` — Public community forum (no auth)
  *
  * ```typescript
+ * import { CStarClient } from '@cstar.help/js';
+ *
  * const cstar = new CStarClient({
- *   apiKey: 'sk_test_abc123...',
- *   teamId: 'your-team-id',
+ *   apiKey: process.env.CSTAR_SECRET_KEY, // sk_live_... or sk_test_...
+ *   teamId: process.env.CSTAR_TEAM_ID,
  * });
  *
  * const { data } = await cstar.tickets.list({ status: 'open' });
@@ -2093,6 +2379,8 @@ declare class CStarClient {
     readonly settings: SettingsResource;
     /** Manage notifications. */
     readonly notifications: NotificationsResource;
+    /** Manage @mentions. */
+    readonly mentions: MentionsResource;
     /** Manage file attachments. */
     readonly attachments: AttachmentsResource;
     /** Manage custom field definitions. */
@@ -2131,4 +2419,4 @@ declare class CStarClient {
     get isTestMode(): boolean;
 }
 
-export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AgentStats, 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, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type Cosmetic, type CosmeticPreferences, type CsatResponse, type CsatStats, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ExportCreateParams, type ExportResult, 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 Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, 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 QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RequestOptions, type SavedView, type SearchParams, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, type Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, 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, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, 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, ErrorType, 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, 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 QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, 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, type Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, 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 };