@cstar.help/js 0.18.2 → 0.18.4
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/README.md +9 -3
- package/dist/auth/index.cjs +16 -13
- package/dist/auth/index.d.cts +1 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/auth/index.js +16 -13
- package/dist/chat/index.d.cts +1 -1
- package/dist/chat/index.d.ts +1 -1
- package/dist/community/index.cjs +16 -13
- package/dist/community/index.d.cts +1 -1
- package/dist/community/index.d.ts +1 -1
- package/dist/community/index.js +16 -13
- package/dist/{errors-bW8CwTn4.d.cts → errors-BnUUTVlT.d.cts} +2 -1
- package/dist/{errors-bW8CwTn4.d.ts → errors-BnUUTVlT.d.ts} +2 -1
- package/dist/index.cjs +266 -117
- package/dist/index.d.cts +161 -60
- package/dist/index.d.ts +161 -60
- package/dist/index.js +266 -117
- package/dist/library/index.cjs +16 -13
- package/dist/library/index.d.cts +1 -1
- package/dist/library/index.d.ts +1 -1
- package/dist/library/index.js +16 -13
- package/dist/quickhelp/index.cjs +20 -15
- package/dist/quickhelp/index.d.cts +26 -2
- package/dist/quickhelp/index.d.ts +26 -2
- package/dist/quickhelp/index.js +20 -15
- package/dist/webhook/index.d.cts +1 -1
- package/dist/webhook/index.d.ts +1 -1
- package/dist/webhook/node.d.cts +1 -1
- package/dist/webhook/node.d.ts +1 -1
- package/dist/{webhookEvents-Lqpsj935.d.cts → webhookEvents-YQer37My.d.cts} +208 -83
- package/dist/{webhookEvents-Lqpsj935.d.ts → webhookEvents-YQer37My.d.ts} +208 -83
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { W as WebhookEventType, a as WebhookEventDataMap } from './webhookEvents-
|
|
2
|
-
export { b as WEBHOOK_EVENT_CATALOG, c as WEBHOOK_EVENT_SAMPLES, d as WebhookEvent } from './webhookEvents-
|
|
3
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, h as CStarServerError, i as CStarValidationError, E as ErrorType } from './errors-
|
|
1
|
+
import { W as WebhookEventType, a as WebhookEventDataMap } from './webhookEvents-YQer37My.js';
|
|
2
|
+
export { b as WEBHOOK_EVENT_CATALOG, c as WEBHOOK_EVENT_SAMPLES, d as WebhookEvent } from './webhookEvents-YQer37My.js';
|
|
3
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, h as CStarServerError, i as CStarValidationError, E as ErrorType } from './errors-BnUUTVlT.js';
|
|
4
4
|
|
|
5
5
|
/** Metadata: string key-value pairs. Max 50 keys, 40-char keys, 500-char values. */
|
|
6
6
|
type Metadata = Record<string, string>;
|
|
@@ -151,7 +151,7 @@ declare class HttpClient {
|
|
|
151
151
|
type EventSourceConstructor = new (url: string) => EventSource;
|
|
152
152
|
/** Options for configuring the realtime connection. */
|
|
153
153
|
interface RealtimeOptions {
|
|
154
|
-
/** Event types to subscribe to (e.g., ['ticket
|
|
154
|
+
/** Event types to subscribe to, by exact name (e.g., ['ticket.created', 'message.created']). Omit for all. */
|
|
155
155
|
types?: string[];
|
|
156
156
|
/** Auto-reconnect on disconnect (default: true). */
|
|
157
157
|
autoReconnect?: boolean;
|
|
@@ -671,13 +671,18 @@ declare class ArticlesResource extends BaseResource<Article, ArticleListParams,
|
|
|
671
671
|
|
|
672
672
|
type WebhookEventData<T extends WebhookEventType> = WebhookEventDataMap[T];
|
|
673
673
|
|
|
674
|
+
/**
|
|
675
|
+
* What a webhook subscription can list: an event type, a resource wildcard
|
|
676
|
+
* such as `'ticket.*'` (every ticket event), or `'*'` (every event).
|
|
677
|
+
*/
|
|
678
|
+
type WebhookEventPattern = WebhookEventType | `${string}.*` | '*';
|
|
674
679
|
/** A cStar webhook endpoint. */
|
|
675
680
|
interface Webhook {
|
|
676
681
|
id: string;
|
|
677
682
|
object: 'webhook';
|
|
678
683
|
name: string;
|
|
679
684
|
url: string;
|
|
680
|
-
events:
|
|
685
|
+
events: WebhookEventPattern[];
|
|
681
686
|
isActive: boolean;
|
|
682
687
|
isRestHooks: boolean;
|
|
683
688
|
includeFullObjects: boolean;
|
|
@@ -710,7 +715,7 @@ interface WebhookListParams extends PaginationParams {
|
|
|
710
715
|
interface WebhookCreateParams {
|
|
711
716
|
name: string;
|
|
712
717
|
url: string;
|
|
713
|
-
events:
|
|
718
|
+
events: WebhookEventPattern[];
|
|
714
719
|
isRestHooks?: boolean;
|
|
715
720
|
includeFullObjects?: boolean;
|
|
716
721
|
flatPayload?: boolean;
|
|
@@ -720,7 +725,7 @@ interface WebhookCreateParams {
|
|
|
720
725
|
interface WebhookUpdateParams {
|
|
721
726
|
name?: string;
|
|
722
727
|
url?: string;
|
|
723
|
-
events?:
|
|
728
|
+
events?: WebhookEventPattern[];
|
|
724
729
|
isActive?: boolean;
|
|
725
730
|
includeFullObjects?: boolean;
|
|
726
731
|
flatPayload?: boolean;
|
|
@@ -1086,7 +1091,14 @@ interface CommunityComment {
|
|
|
1086
1091
|
/** Query parameters for listing community posts. */
|
|
1087
1092
|
interface CommunityPostListParams {
|
|
1088
1093
|
topicId?: string;
|
|
1089
|
-
|
|
1094
|
+
/** Topic slug, as `communityTopics.list()` returns it. */
|
|
1095
|
+
topic?: string;
|
|
1096
|
+
status?: CommunityPost['status'];
|
|
1097
|
+
pinned?: boolean;
|
|
1098
|
+
/** true for posts locked to new comments. */
|
|
1099
|
+
locked?: boolean;
|
|
1100
|
+
/** Text in the title or body (any case). */
|
|
1101
|
+
search?: string;
|
|
1090
1102
|
sort?: 'recent' | 'votes' | 'comments';
|
|
1091
1103
|
page?: number;
|
|
1092
1104
|
pageSize?: number;
|
|
@@ -1273,16 +1285,44 @@ declare class MembersResource {
|
|
|
1273
1285
|
del(memberId: string): Promise<ApiResponse<DeleteResponse>>;
|
|
1274
1286
|
}
|
|
1275
1287
|
|
|
1276
|
-
/**
|
|
1288
|
+
/** One option in a settings list (a status, priority, sentiment or category). */
|
|
1289
|
+
interface SettingsOption {
|
|
1290
|
+
key: string;
|
|
1291
|
+
label: string;
|
|
1292
|
+
color?: string;
|
|
1293
|
+
icon?: string;
|
|
1294
|
+
[key: string]: unknown;
|
|
1295
|
+
}
|
|
1296
|
+
/** Team settings: the option lists the dashboard uses. */
|
|
1277
1297
|
interface TeamSettings {
|
|
1278
1298
|
object: 'settings';
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1299
|
+
ticketStatuses: SettingsOption[];
|
|
1300
|
+
customerStatuses: SettingsOption[];
|
|
1301
|
+
articleStatuses: SettingsOption[];
|
|
1302
|
+
priorities: SettingsOption[];
|
|
1303
|
+
sentiments: SettingsOption[];
|
|
1304
|
+
articleCategories: SettingsOption[];
|
|
1305
|
+
ticketTags: unknown[];
|
|
1306
|
+
customerTags: unknown[];
|
|
1307
|
+
articleTags: unknown[];
|
|
1308
|
+
quickReplies: QuickReply[];
|
|
1309
|
+
updatedAt: string;
|
|
1282
1310
|
}
|
|
1283
|
-
/**
|
|
1311
|
+
/**
|
|
1312
|
+
* Parameters for updating team settings. Each list sent replaces the saved
|
|
1313
|
+
* one, so include every option you keep.
|
|
1314
|
+
*/
|
|
1284
1315
|
interface TeamSettingsUpdateParams {
|
|
1285
|
-
[
|
|
1316
|
+
ticketStatuses?: SettingsOption[];
|
|
1317
|
+
customerStatuses?: SettingsOption[];
|
|
1318
|
+
articleStatuses?: SettingsOption[];
|
|
1319
|
+
priorities?: SettingsOption[];
|
|
1320
|
+
sentiments?: SettingsOption[];
|
|
1321
|
+
articleCategories?: SettingsOption[];
|
|
1322
|
+
ticketTags?: unknown[];
|
|
1323
|
+
customerTags?: unknown[];
|
|
1324
|
+
articleTags?: unknown[];
|
|
1325
|
+
quickReplies?: QuickReply[];
|
|
1286
1326
|
}
|
|
1287
1327
|
/** A ticket status configuration. */
|
|
1288
1328
|
interface TicketStatus {
|
|
@@ -1299,11 +1339,17 @@ interface StatusCreateParams {
|
|
|
1299
1339
|
key: string;
|
|
1300
1340
|
label: string;
|
|
1301
1341
|
color?: string;
|
|
1342
|
+
/** A known icon name. */
|
|
1343
|
+
icon?: string;
|
|
1344
|
+
/** Whether tickets in this status pause SLA timers. */
|
|
1345
|
+
pausesSLA?: boolean;
|
|
1302
1346
|
}
|
|
1303
1347
|
/** Parameters for updating a status. */
|
|
1304
1348
|
interface StatusUpdateParams {
|
|
1305
1349
|
label?: string;
|
|
1306
1350
|
color?: string;
|
|
1351
|
+
icon?: string;
|
|
1352
|
+
pausesSLA?: boolean;
|
|
1307
1353
|
}
|
|
1308
1354
|
/** A quick reply template. */
|
|
1309
1355
|
interface QuickReply {
|
|
@@ -1660,6 +1706,11 @@ interface AttachmentGetParams {
|
|
|
1660
1706
|
/** Defaults to `email-attachments` on the server. */
|
|
1661
1707
|
bucket?: AttachmentBucket;
|
|
1662
1708
|
}
|
|
1709
|
+
/** Parameters for deleting a file. Chat widget uploads (`attachments`) can't be deleted here. */
|
|
1710
|
+
interface AttachmentDeleteParams {
|
|
1711
|
+
/** Defaults to `email-attachments` on the server. */
|
|
1712
|
+
bucket?: Exclude<AttachmentBucket, 'attachments'>;
|
|
1713
|
+
}
|
|
1663
1714
|
/** A signed download URL from `attachments.get()`. A bearer link until it expires. */
|
|
1664
1715
|
interface AttachmentDownloadUrl {
|
|
1665
1716
|
url: string;
|
|
@@ -1678,8 +1729,11 @@ declare class AttachmentsResource {
|
|
|
1678
1729
|
* file. Pass `storagePath` and `bucket` from `list()`.
|
|
1679
1730
|
*/
|
|
1680
1731
|
get(storagePath: string, params?: AttachmentGetParams): Promise<AttachmentDownloadUrl>;
|
|
1681
|
-
/**
|
|
1682
|
-
|
|
1732
|
+
/**
|
|
1733
|
+
* Delete a stored file. Pass `storagePath` and `bucket` from `list()`, as
|
|
1734
|
+
* for `get()`. A path with no file in that bucket is a 404.
|
|
1735
|
+
*/
|
|
1736
|
+
del(storagePath: string, params?: AttachmentDeleteParams): Promise<ApiResponse<DeleteResponse>>;
|
|
1683
1737
|
}
|
|
1684
1738
|
|
|
1685
1739
|
/** Record type a custom field belongs to. */
|
|
@@ -2045,8 +2099,21 @@ interface ImportCreateParams {
|
|
|
2045
2099
|
* Records to import. Flat objects with the per-entity fields you want
|
|
2046
2100
|
* to set, e.g. `[{ name: 'Jane', email: 'jane@example.com' }]` for
|
|
2047
2101
|
* `resource: 'customers'`. Each record is treated as a create. Server
|
|
2048
|
-
* also accepts the wrapped internal shape `{ data, action, existingId? }`
|
|
2049
|
-
* if you need to drive updates from the SDK.
|
|
2102
|
+
* also accepts the wrapped internal shape `{ data, action, existingId?, importKey? }`
|
|
2103
|
+
* if you need to drive updates from the SDK. A created ticket or article
|
|
2104
|
+
* with an `importKey` is created once per team and mode: sending the same
|
|
2105
|
+
* key again is skipped and counted in `alreadyImported`. Make a key unique
|
|
2106
|
+
* to one record in one source system and account, for example zendesk:acme:1001
|
|
2107
|
+
* (a bare id like 1001 is in every account). A key that already names
|
|
2108
|
+
* another record fails that row instead of writing onto the record. Anyone
|
|
2109
|
+
* who can read a record can read its key, so put nothing private in a key.
|
|
2110
|
+
* A key made only from a row's content would make the same row in a later
|
|
2111
|
+
* file look already imported, so a key for a row with no id should also
|
|
2112
|
+
* name its file (a hash of the whole file). An edited file is a new file then: send
|
|
2113
|
+
* the records it already imported as updates (`action: 'update'` with
|
|
2114
|
+
* `existingId`). A record that names `action`
|
|
2115
|
+
* or `existingId` is read as wrapped, so its fields must be in `data`
|
|
2116
|
+
* (otherwise HTTP 400 naming the record).
|
|
2050
2117
|
*
|
|
2051
2118
|
* Ticket imports include details only, without conversation messages,
|
|
2052
2119
|
* private notes or attachments. Ticket create/update records with nonempty
|
|
@@ -2094,6 +2161,13 @@ interface ImportResult {
|
|
|
2094
2161
|
rowIndex: number;
|
|
2095
2162
|
id: string;
|
|
2096
2163
|
}>;
|
|
2164
|
+
/** Rows whose `importKey` was already used (an earlier import): skipped, not created twice. */
|
|
2165
|
+
alreadyImported: number;
|
|
2166
|
+
/** Those rows: the 1-based row number and the prefixed id of the record they already made. */
|
|
2167
|
+
existingIds: Array<{
|
|
2168
|
+
rowIndex: number;
|
|
2169
|
+
id: string;
|
|
2170
|
+
}>;
|
|
2097
2171
|
}
|
|
2098
2172
|
/** Import log entry. */
|
|
2099
2173
|
interface ImportLog {
|
|
@@ -2150,28 +2224,32 @@ declare class ImportResource {
|
|
|
2150
2224
|
getLog(logId: string): Promise<ApiResponse<ImportLog>>;
|
|
2151
2225
|
}
|
|
2152
2226
|
|
|
2153
|
-
/**
|
|
2227
|
+
/** One API request made with the team's keys, in the key's mode. */
|
|
2154
2228
|
interface AuditLogEntry {
|
|
2155
2229
|
id: string;
|
|
2156
|
-
object: '
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2230
|
+
object: 'audit_entry';
|
|
2231
|
+
method: string;
|
|
2232
|
+
endpoint: string;
|
|
2233
|
+
statusCode: number;
|
|
2234
|
+
responseTimeMs: number;
|
|
2235
|
+
requestId: string | null;
|
|
2236
|
+
/** The key that made the request; null when it never resolved (a 401). */
|
|
2237
|
+
apiKeyId: string | null;
|
|
2164
2238
|
ipAddress: string | null;
|
|
2165
|
-
|
|
2239
|
+
userAgent: string | null;
|
|
2240
|
+
isTest: boolean;
|
|
2241
|
+
timestamp: string;
|
|
2166
2242
|
}
|
|
2167
|
-
/** Parameters for listing audit log entries. */
|
|
2243
|
+
/** Parameters for listing audit log entries. Any other filter is a 400. */
|
|
2168
2244
|
interface AuditLogListParams extends PaginationParams {
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2245
|
+
/** GET, HEAD, POST, PATCH, PUT or DELETE. */
|
|
2246
|
+
method?: string;
|
|
2247
|
+
/** A status code like `404` or a class like `4xx`. */
|
|
2248
|
+
status?: string;
|
|
2249
|
+
/** Time window back from now, like `30m`, `24h` (the default) or `7d`. */
|
|
2250
|
+
since?: string;
|
|
2251
|
+
/** Only requests made with this key. */
|
|
2252
|
+
apiKeyId?: string;
|
|
2175
2253
|
}
|
|
2176
2254
|
|
|
2177
2255
|
/** Access the audit log. */
|
|
@@ -2328,7 +2406,8 @@ interface CustomerGroupCreateParams {
|
|
|
2328
2406
|
/** Parameters for updating a customer group. */
|
|
2329
2407
|
interface CustomerGroupUpdateParams {
|
|
2330
2408
|
name?: string;
|
|
2331
|
-
|
|
2409
|
+
/** An empty string or null clears it. */
|
|
2410
|
+
description?: string | null;
|
|
2332
2411
|
filters?: Record<string, unknown>;
|
|
2333
2412
|
}
|
|
2334
2413
|
/** Parameters for listing group members. */
|
|
@@ -2339,24 +2418,18 @@ interface CustomerGroupAddMembersParams {
|
|
|
2339
2418
|
customerId?: string;
|
|
2340
2419
|
customerIds?: string[];
|
|
2341
2420
|
}
|
|
2342
|
-
/**
|
|
2343
|
-
interface
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
joinedGroupAt: string;
|
|
2352
|
-
}>;
|
|
2353
|
-
pagination: {
|
|
2354
|
-
total: number;
|
|
2355
|
-
page: number;
|
|
2356
|
-
pageSize: number;
|
|
2357
|
-
hasMore: boolean;
|
|
2358
|
-
};
|
|
2421
|
+
/** A customer in a group, as the members list returns it. */
|
|
2422
|
+
interface CustomerGroupMember {
|
|
2423
|
+
id: string;
|
|
2424
|
+
object: 'customer';
|
|
2425
|
+
name: string | null;
|
|
2426
|
+
email: string | null;
|
|
2427
|
+
sentiment: string;
|
|
2428
|
+
tags: string[];
|
|
2429
|
+
joinedGroupAt: string;
|
|
2359
2430
|
}
|
|
2431
|
+
/** Group members list result: the standard list (`data`, `pagination`, `hasMore`). */
|
|
2432
|
+
type CustomerGroupMembersResult = ListResponse<CustomerGroupMember>;
|
|
2360
2433
|
/** Result of adding members to a group. */
|
|
2361
2434
|
interface CustomerGroupAddResult {
|
|
2362
2435
|
added: number;
|
|
@@ -2467,10 +2540,11 @@ interface BossSpawnParams {
|
|
|
2467
2540
|
}
|
|
2468
2541
|
/** Parameters for dealing boss damage. */
|
|
2469
2542
|
interface BossDamageParams {
|
|
2470
|
-
/** A closed customer ticket (widget, email or API). Each ticket hits once. */
|
|
2543
|
+
/** A closed customer ticket (widget, email or API): its `tkt_` id or uuid. Each ticket hits once. */
|
|
2471
2544
|
ticketId: string;
|
|
2472
|
-
/** Defaults to the API key's
|
|
2545
|
+
/** Defaults to the API key's user. If sent, it must be that user (403 otherwise). */
|
|
2473
2546
|
userId?: string;
|
|
2547
|
+
/** @deprecated Ignored: the battle log shows the member's own name. */
|
|
2474
2548
|
userName?: string;
|
|
2475
2549
|
}
|
|
2476
2550
|
/** Leaderboard entry. */
|
|
@@ -2566,7 +2640,8 @@ interface PuzzleCompleteParams {
|
|
|
2566
2640
|
puzzleId: string;
|
|
2567
2641
|
timeSeconds: number;
|
|
2568
2642
|
mistakes?: number;
|
|
2569
|
-
|
|
2643
|
+
/** Whether the puzzle was solved. Required: a loss (false) pays no XP and isn't ranked. */
|
|
2644
|
+
isWon: boolean;
|
|
2570
2645
|
}
|
|
2571
2646
|
/** Puzzle completion result. */
|
|
2572
2647
|
interface PuzzleCompleteResult {
|
|
@@ -2876,7 +2951,10 @@ declare class GameActivityResource {
|
|
|
2876
2951
|
data: unknown[];
|
|
2877
2952
|
cursor: string | null;
|
|
2878
2953
|
}>>;
|
|
2879
|
-
/**
|
|
2954
|
+
/**
|
|
2955
|
+
* Get activity for a specific member. `memberId` is the player's user id:
|
|
2956
|
+
* the `memberId` game responses return, and `userId` on `members.list()`.
|
|
2957
|
+
*/
|
|
2880
2958
|
forMember(memberId: string, params?: {
|
|
2881
2959
|
limit?: number;
|
|
2882
2960
|
}): Promise<ApiResponse<{
|
|
@@ -2980,7 +3058,14 @@ declare class SkillsResource {
|
|
|
2980
3058
|
userId: string;
|
|
2981
3059
|
}, options?: RequestOptions): Promise<ApiResponse<SkillTree>>;
|
|
2982
3060
|
}
|
|
2983
|
-
/**
|
|
3061
|
+
/**
|
|
3062
|
+
* Access all gamification features.
|
|
3063
|
+
*
|
|
3064
|
+
* Game state is live only: every write (boss damage and spawn, 1-Ups, high
|
|
3065
|
+
* fives, skills, cosmetics, puzzle completions) refuses a test key with
|
|
3066
|
+
* `400 parameter_invalid`, thrown as `CStarValidationError`. Reads work with
|
|
3067
|
+
* either key.
|
|
3068
|
+
*/
|
|
2984
3069
|
declare class GameResource {
|
|
2985
3070
|
private readonly client;
|
|
2986
3071
|
/** Boss battles. */
|
|
@@ -3008,7 +3093,10 @@ declare class GameResource {
|
|
|
3008
3093
|
player(params?: {
|
|
3009
3094
|
userId?: string;
|
|
3010
3095
|
}): Promise<ApiResponse<Player>>;
|
|
3011
|
-
/**
|
|
3096
|
+
/**
|
|
3097
|
+
* Get a specific player's stats. `memberId` is the player's user id: the
|
|
3098
|
+
* `memberId` game responses return, and `userId` on `members.list()`.
|
|
3099
|
+
*/
|
|
3012
3100
|
getPlayer(memberId: string): Promise<ApiResponse<Player>>;
|
|
3013
3101
|
/**
|
|
3014
3102
|
* Get the team leaderboard. Returns the unwrapped envelope from the
|
|
@@ -3147,6 +3235,12 @@ interface Subscription {
|
|
|
3147
3235
|
pausedReason: 'trial_ended' | 'no_trial' | 'payment_failed' | 'canceled' | 'payment_required' | null;
|
|
3148
3236
|
/** When the team and its data are deleted (the whole named UTC day is safe), or null. */
|
|
3149
3237
|
scheduledDeletionAt: string | null;
|
|
3238
|
+
/**
|
|
3239
|
+
* When the subscription ends because the owner canceled it in the billing
|
|
3240
|
+
* portal (it runs until then, and won't renew); null when it renews or
|
|
3241
|
+
* isn't running.
|
|
3242
|
+
*/
|
|
3243
|
+
subscriptionCancelAt: string | null;
|
|
3150
3244
|
/** Paid seats: every member, with up to 3 spectators free (minimum 1). */
|
|
3151
3245
|
seatCount: number;
|
|
3152
3246
|
/** Human members on the team (AI agents are free and not counted). */
|
|
@@ -3279,6 +3373,13 @@ interface CStarClientConfig {
|
|
|
3279
3373
|
timeout?: number;
|
|
3280
3374
|
/** Enable offline queue — queues mutations when network fails, auto-flushes on reconnect. */
|
|
3281
3375
|
offline?: boolean | OfflineQueueOptions;
|
|
3376
|
+
/**
|
|
3377
|
+
* Options for `cstar.realtime`: `types` scopes the stream at the server
|
|
3378
|
+
* (exact names such as `['ticket.created', 'message.created']`), `eventSource` passes a polyfill for runtimes
|
|
3379
|
+
* without a global `EventSource`, plus `autoReconnect` and `maxRetries`
|
|
3380
|
+
* for reconnects (separate from the HTTP `maxRetries` above).
|
|
3381
|
+
*/
|
|
3382
|
+
realtime?: RealtimeOptions;
|
|
3282
3383
|
}
|
|
3283
3384
|
/**
|
|
3284
3385
|
* The cStar admin API client. **Server-side only.**
|
|
@@ -3421,4 +3522,4 @@ declare class CStarClient {
|
|
|
3421
3522
|
get lastMeta(): LastMeta;
|
|
3422
3523
|
}
|
|
3423
3524
|
|
|
3424
|
-
export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentBucket, type AttachmentDownloadUrl, type AttachmentGetParams, 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, CStarClient, type CStarClientConfig, CStarRealtime, 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 CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldContentType, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, 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, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, 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 MessageListParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagEntity, type TagListParams, type TagMergeParams, type TagMergeResult, type TagRemoveResult, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomFieldValues, type TicketCustomerSummary, type TicketListParams, type TicketPriorityKey, type TicketSeedMessage, type TicketStatus, type TicketStatusKey, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetEntrance, type WidgetEntranceCustom, type WidgetEntranceEffect, type WidgetEntranceKeyframe, type WidgetEntranceParticles, type WidgetSettings, type WidgetSettingsUpdateParams };
|
|
3525
|
+
export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentBucket, type AttachmentDeleteParams, type AttachmentDownloadUrl, type AttachmentGetParams, 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, CStarClient, type CStarClientConfig, CStarRealtime, 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 CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldContentType, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMember, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, 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 MessageListParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SettingsOption, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagEntity, type TagListParams, type TagMergeParams, type TagMergeResult, type TagRemoveResult, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomFieldValues, type TicketCustomerSummary, type TicketListParams, type TicketPriorityKey, type TicketSeedMessage, type TicketStatus, type TicketStatusKey, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, type WebhookEventPattern, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetEntrance, type WidgetEntranceCustom, type WidgetEntranceEffect, type WidgetEntranceKeyframe, type WidgetEntranceParticles, type WidgetSettings, type WidgetSettingsUpdateParams };
|