@cstar.help/js 0.5.2 → 0.6.1

package/dist/index.d.cts

@@ -29,11 +29,117 @@ declare class HttpClient {
     request<T>(method: string, path: string, options?: FetchOptions): Promise<T>;
     private buildUrl;
     private buildHeaders;
+    /** Get the base URL for building SSE or other endpoints. */
+    getBaseUrl(): string;
+    /** Get authorization headers for non-fetch requests (e.g., SSE). */
+    getAuthHeaders(): Record<string, string>;
     /** Exponential backoff: 500ms, 1s, 2s, 4s... capped at 8s, plus jitter. */
     private getBackoffDelay;
     private sleep;
 }
 
+/** Options for configuring the realtime connection. */
+interface RealtimeOptions {
+    /** Event types to subscribe to (e.g., ['ticket.*', 'boss.*']). Omit for all. */
+    types?: string[];
+    /** Auto-reconnect on disconnect (default: true). */
+    autoReconnect?: boolean;
+    /** Max reconnection attempts before giving up (default: 10). */
+    maxRetries?: number;
+}
+/** A parsed realtime event from the SSE stream. */
+interface RealtimeEvent<T = unknown> {
+    /** Event type (e.g., 'ticket.created'). */
+    type: string;
+    /** Unique event ID for reconnection. */
+    id: string;
+    /** Typed event payload. */
+    data: T;
+    /** ISO-8601 timestamp. */
+    timestamp: string;
+    /** Team ID that owns this event. */
+    teamId: string;
+}
+type EventHandler<T = unknown> = (event: RealtimeEvent<T>) => void;
+type ErrorHandler = (error: Error) => void;
+type ConnectionHandler = (connected: boolean) => void;
+/**
+ * SSE-based realtime client for the cStar API.
+ *
+ * Manages a single EventSource connection to `/events/stream` and dispatches
+ * events to registered handlers. Supports wildcard matching (e.g., `ticket.*`),
+ * auto-reconnection with exponential backoff, and reconnection replay via
+ * `Last-Event-ID`.
+ */
+declare class CStarRealtime {
+    private readonly httpClient;
+    private eventSource;
+    private handlers;
+    private anyHandlers;
+    private errorHandlers;
+    private connectionHandlers;
+    private lastEventId;
+    private retryCount;
+    private retryTimer;
+    private _connected;
+    private destroyed;
+    private connecting;
+    /** Short-lived SSE token (exchanged from secret key). */
+    private sseToken;
+    /** When the current SSE token expires (epoch ms). */
+    private sseTokenExpiresAt;
+    /** Timer that refreshes the SSE token before it expires. */
+    private tokenRefreshTimer;
+    private readonly autoReconnect;
+    private readonly maxRetries;
+    private readonly types;
+    constructor(httpClient: HttpClient, options?: RealtimeOptions);
+    /** Subscribe to a specific event type. Supports wildcards (e.g., 'ticket.*'). Returns an unsubscribe function. */
+    on<T = unknown>(eventType: string, handler: EventHandler<T>): () => void;
+    /** Subscribe to all events. Returns an unsubscribe function. */
+    onAny<T = unknown>(handler: EventHandler<T>): () => void;
+    /** Handle connection errors. */
+    onError(handler: ErrorHandler): this;
+    /** Handle connection state changes. */
+    onConnectionChange(handler: ConnectionHandler): this;
+    /** Remove a connection state handler. */
+    offConnectionChange(handler: ConnectionHandler): this;
+    /** Remove a handler for a specific event type. */
+    off<T = unknown>(eventType: string, handler: EventHandler<T>): this;
+    /** Remove a handler from the "any" subscription. */
+    offAny<T = unknown>(handler: EventHandler<T>): this;
+    /** Start the SSE connection. Called automatically on first handler registration. */
+    connect(): void;
+    /**
+     * Open the EventSource with the given auth token.
+     * Extracted so both the happy path and the fallback path share logic.
+     */
+    private connectWithToken;
+    /** Stop listening and clean up all resources. */
+    disconnect(): void;
+    /** Whether the SSE connection is currently open. */
+    get connected(): boolean;
+    private ensureConnected;
+    private handleMessage;
+    private dispatch;
+    private scheduleReconnect;
+    private setConnected;
+    private emitError;
+    /** Whether we hold a token that won't expire for at least 30 seconds. */
+    private hasFreshSseToken;
+    /**
+     * Exchange the secret API key for a short-lived SSE token via
+     * POST /events/token. Schedules automatic refresh before expiry.
+     */
+    private exchangeToken;
+    /**
+     * Schedule a background token refresh. On success the existing connection
+     * keeps working (tokens are validated at connect time). On the next
+     * reconnect the fresh token will be used automatically.
+     */
+    private scheduleTokenRefresh;
+}
+
 /** Metadata: string key-value pairs. Max 50 keys, 40-char keys, 500-char values. */
 type Metadata = Record<string, string>;
 /** Standard pagination parameters accepted by list endpoints. */
@@ -170,6 +276,51 @@ interface TicketUpdateParams {
     metadata?: Record<string, string | null>;
 }
 
+type ChangeHandler<T> = (data: T[]) => void;
+type ErrorEventHandler = (error: Error) => void;
+declare class Subscription$1<T = unknown> {
+    private readonly realtime;
+    private readonly fetchFn;
+    private readonly resourcePath;
+    private readonly filterFn?;
+    private _data;
+    private _loading;
+    private _error;
+    private changeHandlers;
+    private errorEventHandlers;
+    private boundEventHandler;
+    private destroyed;
+    /** Generation counter to prevent stale refresh() from overwriting SSE updates. */
+    private generation;
+    constructor(realtime: CStarRealtime, fetchFn: () => Promise<ListResponse<T>>, resourcePath: string, filterFn?: ((item: T) => boolean) | undefined);
+    /** Current data array (updated in real-time). */
+    get data(): T[];
+    /** True during initial data fetch. */
+    get loading(): boolean;
+    /** Last error, if any. */
+    get error(): Error | null;
+    /** Register a callback for data changes or errors. */
+    on(event: 'change', handler: ChangeHandler<T>): this;
+    on(event: 'error', handler: ErrorEventHandler): this;
+    /** Manually refresh data from the server. */
+    refresh(): Promise<void>;
+    /**
+     * Apply an optimistic update to the local data.
+     * Returns a rollback function that reverts the change.
+     */
+    optimisticUpdate(id: string, changes: Partial<T>): () => void;
+    /** Stop the subscription and clean up all listeners. */
+    unsubscribe(): void;
+    private init;
+    private handleEvent;
+    private handleCreated;
+    private handleDeleted;
+    private handleUpdated;
+    private extractEntity;
+    private emitChange;
+    private emitError;
+}
+
 /**
  * Base resource class implementing standard CRUD operations.
  * Resource-specific classes extend this with their own type parameters.
@@ -198,6 +349,19 @@ declare abstract class BaseResource<TEntity, TListParams extends PaginationParam
      * ```
      */
     listAutoPaginating(params?: Omit<TListParams, 'page'> & RequestOptions): AsyncIterable<TEntity>;
+    /**
+     * Subscribe to real-time changes for this resource type.
+     *
+     * Fetches initial data, then auto-updates via SSE events.
+     * Requires a `CStarRealtime` instance (available from `CStarClient.realtime`).
+     *
+     * ```typescript
+     * const sub = cstar.tickets.subscribe(cstar.realtime, { status: 'open' });
+     * sub.on('change', (tickets) => console.log(tickets));
+     * // Later: sub.unsubscribe();
+     * ```
+     */
+    subscribe(realtime: CStarRealtime, params?: TListParams & RequestOptions, filterFn?: (item: TEntity) => boolean): Subscription$1<TEntity>;
     /** Convert params to string values for query string serialization. */
     protected serializeQuery(params: Record<string, unknown>): Record<string, string | string[] | undefined>;
 }
@@ -464,7 +628,7 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     /** 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>>;
+    restSubscribe(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). */
@@ -675,6 +839,13 @@ declare class CategoriesResource extends BaseResource<Category, CategoryListPara
     constructor(client: HttpClient);
 }
 
+/** Attachment metadata for community posts and comments. */
+interface CommunityAttachment {
+    filename: string;
+    content_type: string;
+    size_bytes: number;
+    storage_path: string;
+}
 /** A community discussion topic (category/board). */
 interface CommunityTopic {
     id: string;
@@ -703,6 +874,7 @@ interface CommunityPost {
     isFeatured: boolean;
     isLocked: boolean;
     commentsEnabled: boolean;
+    attachments: CommunityAttachment[];
     authorName: string;
     lastActivityAt: string;
     createdAt: string;
@@ -715,6 +887,7 @@ interface CommunityComment {
     body: string;
     isOfficial: boolean;
     voteScore: number;
+    attachments: CommunityAttachment[];
     authorName: string;
     parentCommentId: string | null;
     createdAt: string;
@@ -733,6 +906,7 @@ interface CommunityPostCreateParams {
     body?: string;
     topicId: string;
     visibility?: 'public' | 'members_only';
+    attachments?: CommunityAttachment[];
 }
 /** Parameters for updating a community post. */
 interface CommunityPostUpdateParams {
@@ -745,12 +919,14 @@ interface CommunityPostUpdateParams {
     isLocked?: boolean;
     isHidden?: boolean;
     commentsEnabled?: boolean;
+    attachments?: CommunityAttachment[];
 }
 /** Parameters for creating a comment on a community post. */
 interface CommunityCommentCreateParams {
     body: string;
     parentCommentId?: string;
     isOfficial?: boolean;
+    attachments?: CommunityAttachment[];
 }
 
 /** Manage community discussion posts. */
@@ -2158,6 +2334,26 @@ declare class GameResource {
     }): Promise<ApiResponse<LeaderboardEntry>>;
     /** Get game balance configuration (read-only constants). */
     config(): Promise<ApiResponse<GameConfig>>;
+    /**
+     * Subscribe to live boss battle state.
+     * Updates on boss.spawned, boss.damaged, boss.defeated events.
+     */
+    subscribeBoss(realtime: CStarRealtime): Subscription$1<Boss>;
+    /**
+     * Subscribe to player stats (XP, gold, level, streaks).
+     * Updates on achievement.unlocked, quest.completed, level.up events.
+     */
+    subscribePlayer(realtime: CStarRealtime, userId?: string): Subscription$1<Player>;
+    /**
+     * Subscribe to the team leaderboard.
+     * Updates when scores change.
+     */
+    subscribeLeaderboard(realtime: CStarRealtime, params?: LeaderboardParams): Subscription$1<LeaderboardEntry>;
+    /**
+     * Subscribe to team activity feed (achievements, boss defeats, level ups).
+     * Rolling feed of recent game events.
+     */
+    subscribeActivity(realtime: CStarRealtime): Subscription$1<Record<string, unknown>>;
 }
 
 /** AI action types. */
@@ -2272,13 +2468,84 @@ declare class BillingResource {
     portal(params?: BillingPortalParams): Promise<ApiResponse<BillingPortal>>;
 }
 
+interface QueueItem {
+    /** Unique queue item ID. */
+    id: string;
+    /** HTTP method. */
+    method: string;
+    /** API path. */
+    path: string;
+    /** Request body. */
+    body: Record<string, unknown>;
+    /** When the item was queued. */
+    queuedAt: string;
+}
+interface QueueResult {
+    id: string;
+    success: boolean;
+    data?: unknown;
+    error?: string;
+}
+interface OfflineQueueOptions {
+    /** Storage backend: 'memory' (default) or 'localStorage' for browser persistence. */
+    storage?: 'memory' | 'localStorage';
+}
+/**
+ * Offline mutation queue that stores failed requests and replays them when online.
+ *
+ * When `CStarClient` is used with network issues, mutations can be enqueued
+ * instead of failing. The queue persists to localStorage (in browsers) and
+ * auto-flushes when the network comes back.
+ *
+ * ```typescript
+ * const queue = new OfflineQueue(httpClient, { storage: 'localStorage' });
+ * queue.enqueue('POST', '/tickets', { title: 'Bug report' });
+ * // Later, when online:
+ * const results = await queue.flush();
+ * ```
+ */
+declare class OfflineQueue {
+    private readonly httpClient;
+    private items;
+    private autoFlushEnabled;
+    private onlineHandler;
+    private readonly useLocalStorage;
+    constructor(httpClient: HttpClient, options?: OfflineQueueOptions);
+    /** Queue a mutation for later execution. Returns a queue item ID. */
+    enqueue(method: string, path: string, body: Record<string, unknown>): string;
+    /**
+     * Process all queued mutations in order. Returns results for each item.
+     * Failed items are re-queued at the front to preserve ordering.
+     * Items enqueued during flush are appended after re-queued failures.
+     */
+    flush(): Promise<QueueResult[]>;
+    /** Get pending queue items. */
+    get pending(): QueueItem[];
+    /** Number of items in the queue. */
+    get size(): number;
+    /** Clear all pending items. */
+    clear(): void;
+    /**
+     * Enable auto-flush when the browser goes online.
+     * Only works in browser environments with the `online` event.
+     */
+    enableAutoFlush(): void;
+    /** Disable auto-flush and clean up event listeners. */
+    disableAutoFlush(): void;
+    private saveToStorage;
+    private loadFromStorage;
+}
+
 /** Error type constants matching the cStar API. */
 declare const ErrorType: {
     readonly AUTHENTICATION_ERROR: "authentication_error";
+    readonly PERMISSION_ERROR: "permission_error";
     readonly INVALID_REQUEST_ERROR: "invalid_request_error";
     readonly NOT_FOUND_ERROR: "not_found_error";
+    readonly CONFLICT_ERROR: "conflict_error";
     readonly RATE_LIMIT_ERROR: "rate_limit_error";
     readonly API_ERROR: "api_error";
+    readonly SERVER_ERROR: "server_error";
 };
 /** Shape of the error object returned by the cStar API. */
 interface ApiErrorBody {
@@ -2316,6 +2583,18 @@ declare class CStarNotFoundError extends CStarError {
 declare class CStarValidationError extends CStarError {
     constructor(statusCode: number, body: ApiErrorBody);
 }
+/** Thrown when authenticated but lacking permission (403). */
+declare class CStarPermissionError extends CStarError {
+    constructor(statusCode: number, body: ApiErrorBody);
+}
+/** Thrown on resource conflicts (409). */
+declare class CStarConflictError extends CStarError {
+    constructor(statusCode: number, body: ApiErrorBody);
+}
+/** Thrown on internal server errors (500+). */
+declare class CStarServerError extends CStarError {
+    constructor(statusCode: number, body: ApiErrorBody);
+}
 
 /** Configuration for the CStarClient. */
 interface CStarClientConfig {
@@ -2331,6 +2610,8 @@ interface CStarClientConfig {
     maxRetries?: number;
     /** Request timeout in ms (defaults to 30000). */
     timeout?: number;
+    /** Enable offline queue — queues mutations when network fails, auto-flushes on reconnect. */
+    offline?: boolean | OfflineQueueOptions;
 }
 /**
  * The cStar admin API client. **Server-side only.**
@@ -2413,10 +2694,23 @@ declare class CStarClient {
     readonly views: ViewsResource;
     /** Access billing and subscription data. */
     readonly billing: BillingResource;
-    private readonly client;
+    /** Real-time event stream via SSE. */
+    readonly realtime: CStarRealtime;
+    /**
+     * Offline mutation queue. Only available when `offline: true` is passed to the constructor.
+     * Queues failed mutations and replays them when the network returns.
+     */
+    readonly offlineQueue: OfflineQueue | null;
+    /**
+     * @internal The underlying HTTP client — used by realtime and subscription layers.
+     * Not part of the public API. May change without notice between versions.
+     */
+    private readonly _httpClient;
     constructor(config: CStarClientConfig);
+    /** Disconnect the realtime stream and clean up. */
+    destroy(): void;
     /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
     get isTestMode(): boolean;
 }
 
-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 };
+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, 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 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 };