@nvisy/sdk 0.50.0 → 0.52.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/CHANGELOG.md +90 -1
- package/dist/{client-ClO429Iv.d.ts → client-CSxuXX5e.d.ts} +377 -357
- package/dist/client-CSxuXX5e.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{error-DRb1GHg6.js → error-Bc6Sg_y-.js} +3 -3
- package/dist/{error-DRb1GHg6.js.map → error-Bc6Sg_y-.js.map} +1 -1
- package/dist/{errors-BoBDbzst.d.ts → errors-CcTfWeEE.d.ts} +2 -7
- package/dist/errors-CcTfWeEE.d.ts.map +1 -0
- package/dist/{errors-D2J3LbE-.js → errors-ChRSBkhj.js} +2 -9
- package/dist/errors-ChRSBkhj.js.map +1 -0
- package/dist/{index-QQU6h-4Y.d.ts → index-DmLbi0Gi.d.ts} +6656 -5203
- package/dist/index-DmLbi0Gi.d.ts.map +1 -0
- package/dist/index.d.ts +3 -3
- package/dist/index.js +16 -21
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +2 -2
- package/dist/services/index.js +2 -2
- package/dist/{services-DUixyxF2.js → services-Bt15MerP.js} +715 -668
- package/dist/services-Bt15MerP.js.map +1 -0
- package/dist/standalone/index.d.ts +4 -13
- package/dist/standalone/index.d.ts.map +1 -1
- package/dist/standalone/index.js +6 -7
- package/dist/standalone/index.js.map +1 -1
- package/dist/webhooks/index.d.ts +2 -2
- package/dist/webhooks/index.js +1 -1
- package/package.json +3 -3
- package/dist/client-ClO429Iv.d.ts.map +0 -1
- package/dist/errors-BoBDbzst.d.ts.map +0 -1
- package/dist/errors-D2J3LbE-.js.map +0 -1
- package/dist/index-QQU6h-4Y.d.ts.map +0 -1
- package/dist/services-DUixyxF2.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { $
|
|
1
|
+
import { $ as CreateWorkspacePolicy, $a as UpdateAccountApiToken, $n as WorkspaceDetection, Ao as WorkspaceActivityExportOptions, Ar as WorkspaceConnection, B as CreateWorkspaceProvider, Bo as OidcStartResponse, Br as ConnectorCapabilities, Bt as WorkspacePipeline, C as RenameWorkspaceThread, Cn as WorkspaceInviteCode, D as WorkspaceThread, Dn as Health, E as WorkspaceComment, Er as SyncStatus, Fo as AccountIdentities, Ft as CreateWorkspacePipeline, G as UpdateWorkspaceProvider, Gn as CreateAdhocWorkspaceDetection, Gr as AccountDesktopToken, Gt as AccountMarkedReadStatus, Hn as WorkspaceDeletedDocuments, Ho as SetPassword, Hr as LabelCatalog, Ir as WorkspacePickerToken, J as WorkspaceProvidersQuery, Ja as AccountApiTokenPage, Jr as Signup, Jt as AccountUnreadStatus, K as WorkspaceProvider, Kn as CreateWorkspaceDetection, Kr as DesktopTokenRequest, Lr as WorkspacePickerTokenRequest, Lt as PipelineStatus, M as WorkspaceThreadsQuery, Mo as WorkspaceActivityPage, Mr as WorkspaceConnectionSync, Mt as WorkspacePolicy, Nn as AssignWorkspaceReview, Nr as WorkspaceConnectionSyncPage, Po as Account$1, Pr as WorkspaceConnectionVerification, Pt as WorkspacePolicySummaryPage, Ra as ArtifactSet, Rn as ListWorkspaceDocuments, S as OpenWorkspaceThread, T as UpdateWorkspaceComment, Tn as WorkspaceInviteSent, Un as WorkspaceDocument, Uo as UpdateAccount, Ur as RecognizerCatalog, Ut as WorkspacePipelineSummaryPage, Vn as UpdateWorkspaceDocument, Vo as PublicAccount, Wn as WorkspaceDocumentPage, Wo as paths, Wt as CursorPagination, Xn as DetectionStatusEvent, Ya as AccountApiTokenWithJwt, Za as CreateAccountApiToken, Zn as RedactWorkspaceDetection, _ as WorkspaceWebhook, _n as InvitePreview, _r as OAuthStartResponse, an as UnreadCountEvent, ao as WorkspaceAnalytics, b as WorkspaceWebhookResult, bn as ListWorkspaceInvites, c as WorkspacePage, cn as ListWorkspaceMembers, d as CreateWorkspaceWebhook, di as Audit, dn as WorkspaceMember, dr as ExportWorkspaceFiles, er as WorkspaceDetectionPage, f as TestWorkspaceWebhook, fn as WorkspaceMemberPage, hn as GenerateWorkspaceInviteCode, hr as ImportWorkspaceFiles, ir as WorkspaceRedactionResultPage, j as WorkspaceThreadPage, jn as ExportQuery, jo as WorkspaceActivityFilterQuery, jr as WorkspaceConnectionPage, jt as WorkspacePoliciesQuery, k as WorkspaceThreadEntryPage, kn as DateWindow, kr as UpdateWorkspaceConnection, kt as UpdateWorkspacePolicy, lo as WorkspaceDetectionTimeSeries, nr as WorkspacePipelineDetectionsQuery, o as UpdateWorkspace, on as UpdateWorkspaceNotificationSettings, p as UpdateWorkspaceWebhook, pn as CreateWorkspaceInvite, pr as FileServiceProvider, q as WorkspaceProviderPage, qa as AccountApiToken, qr as Login, qt as AccountNotificationPage, rr as WorkspaceRedactionResult, s as Workspace, sn as WorkspaceNotificationSettings, t as CreateWorkspace, tr as WorkspaceDetectionsQuery, un as UpdateWorkspaceMember, ur as CreateWorkspaceConnection, v as WorkspaceWebhookCreated, wn as WorkspaceInvitePage, x as CreateWorkspaceComment, xn as ReplyWorkspaceInvite, xr as StartFileServiceOAuth, y as WorkspaceWebhookPage, zo as IdentityProvider, zr as AuthCapabilities, zt as UpdateWorkspacePipeline } from "./index-DmLbi0Gi.js";
|
|
2
2
|
import { t as ClientConfig } from "./config-BdAgnJlh.js";
|
|
3
3
|
import { Client } from "openapi-fetch";
|
|
4
4
|
//#region src/services/account.d.ts
|
|
@@ -28,27 +28,27 @@ declare class Account {
|
|
|
28
28
|
*/
|
|
29
29
|
deleteAccount(): Promise<void>;
|
|
30
30
|
/**
|
|
31
|
-
* Get a public account profile by
|
|
32
|
-
* @param
|
|
31
|
+
* Get a public account profile by account id
|
|
32
|
+
* @param accountId - Account id
|
|
33
33
|
* @returns Promise that resolves with the public account details
|
|
34
34
|
* @throws {ApiError} if the request fails
|
|
35
35
|
*/
|
|
36
|
-
getPublicAccount(
|
|
36
|
+
getPublicAccount(accountId: string): Promise<PublicAccount>;
|
|
37
37
|
/**
|
|
38
38
|
* Upload an account's avatar image
|
|
39
|
-
* @param
|
|
39
|
+
* @param accountId - Account id
|
|
40
40
|
* @param avatar - Avatar image to upload
|
|
41
41
|
* @returns Promise that resolves with the updated account
|
|
42
42
|
* @throws {ApiError} if the request fails
|
|
43
43
|
*/
|
|
44
|
-
uploadAvatar(
|
|
44
|
+
uploadAvatar(accountId: string, avatar: Blob): Promise<Account$1>;
|
|
45
45
|
/**
|
|
46
46
|
* Delete an account's avatar image
|
|
47
|
-
* @param
|
|
47
|
+
* @param accountId - Account id
|
|
48
48
|
* @returns Promise that resolves when the avatar is deleted
|
|
49
49
|
* @throws {ApiError} if the request fails
|
|
50
50
|
*/
|
|
51
|
-
deleteAvatar(
|
|
51
|
+
deleteAvatar(accountId: string): Promise<void>;
|
|
52
52
|
/**
|
|
53
53
|
* List the account's sign-in methods: its password and linked providers.
|
|
54
54
|
* @returns Promise that resolves with the account's identities
|
|
@@ -128,22 +128,22 @@ declare class Activities {
|
|
|
128
128
|
constructor(api: ApiClient);
|
|
129
129
|
/**
|
|
130
130
|
* List activities for a workspace
|
|
131
|
-
* @param
|
|
131
|
+
* @param workspaceId - Workspace id
|
|
132
132
|
* @param query - Optional filters and pagination (type, actor, from, to,
|
|
133
133
|
* limit, after, includeCount)
|
|
134
134
|
* @returns Promise that resolves with a paginated list of activities
|
|
135
135
|
* @throws {ApiError} if the request fails
|
|
136
136
|
*/
|
|
137
|
-
listActivities(
|
|
137
|
+
listActivities(workspaceId: string, query?: WorkspaceActivityFilterQuery & DateWindow & CursorPagination): Promise<WorkspaceActivityPage>;
|
|
138
138
|
/**
|
|
139
139
|
* Export the workspace's activity log as a file.
|
|
140
|
-
* @param
|
|
140
|
+
* @param workspaceId - Workspace id
|
|
141
141
|
* @param query - Optional filters (type, actor), date window (from, to), and
|
|
142
142
|
* output format (`csv` default, or `json`)
|
|
143
143
|
* @returns Promise that resolves with the file response
|
|
144
144
|
* @throws {ApiError} if the request fails
|
|
145
145
|
*/
|
|
146
|
-
exportActivities(
|
|
146
|
+
exportActivities(workspaceId: string, query?: WorkspaceActivityFilterQuery & DateWindow & WorkspaceActivityExportOptions): Promise<Response>;
|
|
147
147
|
}
|
|
148
148
|
//#endregion
|
|
149
149
|
//#region src/services/analytics.d.ts
|
|
@@ -155,19 +155,19 @@ declare class Analytics {
|
|
|
155
155
|
constructor(api: ApiClient);
|
|
156
156
|
/**
|
|
157
157
|
* Get aggregate analytics for a workspace: storage, detection health, usage.
|
|
158
|
-
* @param
|
|
158
|
+
* @param workspaceId - Workspace id
|
|
159
159
|
* @returns Promise that resolves with the workspace analytics
|
|
160
160
|
* @throws {ApiError} if the request fails
|
|
161
161
|
*/
|
|
162
|
-
getAnalytics(
|
|
162
|
+
getAnalytics(workspaceId: string): Promise<WorkspaceAnalytics>;
|
|
163
163
|
/**
|
|
164
164
|
* Get a workspace's daily detection activity over a date window.
|
|
165
|
-
* @param
|
|
165
|
+
* @param workspaceId - Workspace id
|
|
166
166
|
* @param query - Optional date window (`from` / `to`, YYYY-MM-DD)
|
|
167
167
|
* @returns Promise that resolves with the detection time series
|
|
168
168
|
* @throws {ApiError} if the request fails
|
|
169
169
|
*/
|
|
170
|
-
getDetectionTimeSeries(
|
|
170
|
+
getDetectionTimeSeries(workspaceId: string, query?: DateWindow): Promise<WorkspaceDetectionTimeSeries>;
|
|
171
171
|
}
|
|
172
172
|
//#endregion
|
|
173
173
|
//#region src/services/api-tokens.d.ts
|
|
@@ -183,21 +183,21 @@ declare class ApiTokens {
|
|
|
183
183
|
* @returns Promise that resolves with a paginated list of API tokens
|
|
184
184
|
* @throws {ApiError} if the request fails
|
|
185
185
|
*/
|
|
186
|
-
listApiTokens(query?: CursorPagination): Promise<
|
|
186
|
+
listApiTokens(query?: CursorPagination): Promise<AccountApiTokenPage>;
|
|
187
187
|
/**
|
|
188
188
|
* Get a specific API token by token ID
|
|
189
189
|
* @param tokenId - The token identifier
|
|
190
190
|
* @returns Promise that resolves with the API token details
|
|
191
191
|
* @throws {ApiError} if the request fails
|
|
192
192
|
*/
|
|
193
|
-
getApiToken(tokenId: string): Promise<
|
|
193
|
+
getApiToken(tokenId: string): Promise<AccountApiToken>;
|
|
194
194
|
/**
|
|
195
195
|
* Create a new API token
|
|
196
196
|
* @param token - Token creation request
|
|
197
197
|
* @returns Promise that resolves with the created token (includes JWT, shown only once)
|
|
198
198
|
* @throws {ApiError} if the request fails
|
|
199
199
|
*/
|
|
200
|
-
createApiToken(token:
|
|
200
|
+
createApiToken(token: CreateAccountApiToken): Promise<AccountApiTokenWithJwt>;
|
|
201
201
|
/**
|
|
202
202
|
* Update an existing API token
|
|
203
203
|
* @param tokenId - The token identifier
|
|
@@ -205,7 +205,7 @@ declare class ApiTokens {
|
|
|
205
205
|
* @returns Promise that resolves with the updated token
|
|
206
206
|
* @throws {ApiError} if the request fails
|
|
207
207
|
*/
|
|
208
|
-
updateApiToken(tokenId: string, updates:
|
|
208
|
+
updateApiToken(tokenId: string, updates: UpdateAccountApiToken): Promise<AccountApiToken>;
|
|
209
209
|
/**
|
|
210
210
|
* Revoke an API token
|
|
211
211
|
* @param tokenId - The token identifier
|
|
@@ -215,59 +215,6 @@ declare class ApiTokens {
|
|
|
215
215
|
revokeApiToken(tokenId: string): Promise<void>;
|
|
216
216
|
}
|
|
217
217
|
//#endregion
|
|
218
|
-
//#region src/services/assignments.d.ts
|
|
219
|
-
/**
|
|
220
|
-
* Service for file assignments: assigning a file to a reviewer and tracking its
|
|
221
|
-
* review status (`assigned` → `in_review` → `done`).
|
|
222
|
-
*/
|
|
223
|
-
declare class Assignments {
|
|
224
|
-
#private;
|
|
225
|
-
constructor(api: ApiClient);
|
|
226
|
-
/**
|
|
227
|
-
* List the assignments on a file, most recent first.
|
|
228
|
-
* @param workspaceSlug - Workspace slug
|
|
229
|
-
* @param fileId - File ID
|
|
230
|
-
* @returns Promise that resolves with the file's assignments
|
|
231
|
-
* @throws {ApiError} if the request fails
|
|
232
|
-
*/
|
|
233
|
-
listFileAssignments(workspaceSlug: string, fileId: string): Promise<Assignment[]>;
|
|
234
|
-
/**
|
|
235
|
-
* Assign a file to a reviewer.
|
|
236
|
-
* @param workspaceSlug - Workspace slug
|
|
237
|
-
* @param fileId - File ID
|
|
238
|
-
* @param assignment - Assignment creation request
|
|
239
|
-
* @returns Promise that resolves with the created assignment
|
|
240
|
-
* @throws {ApiError} if the request fails
|
|
241
|
-
*/
|
|
242
|
-
createAssignment(workspaceSlug: string, fileId: string, assignment: CreateAssignment): Promise<Assignment>;
|
|
243
|
-
/**
|
|
244
|
-
* List a workspace's assignments, most recent first.
|
|
245
|
-
* @param workspaceSlug - Workspace slug
|
|
246
|
-
* @param query - Optional pagination and filters (assignee, status, fileId,
|
|
247
|
-
* limit, after)
|
|
248
|
-
* @returns Promise that resolves with a paginated list of assignments
|
|
249
|
-
* @throws {ApiError} if the request fails
|
|
250
|
-
*/
|
|
251
|
-
listAssignments(workspaceSlug: string, query?: CursorPagination & WorkspaceAssignmentsQuery): Promise<AssignmentPage>;
|
|
252
|
-
/**
|
|
253
|
-
* Update an assignment (e.g. change its review status).
|
|
254
|
-
* @param workspaceSlug - Workspace slug
|
|
255
|
-
* @param assignmentId - Assignment ID
|
|
256
|
-
* @param updates - Assignment update request
|
|
257
|
-
* @returns Promise that resolves with the updated assignment
|
|
258
|
-
* @throws {ApiError} if the request fails
|
|
259
|
-
*/
|
|
260
|
-
updateAssignment(workspaceSlug: string, assignmentId: string, updates: UpdateAssignment): Promise<Assignment>;
|
|
261
|
-
/**
|
|
262
|
-
* Delete an assignment.
|
|
263
|
-
* @param workspaceSlug - Workspace slug
|
|
264
|
-
* @param assignmentId - Assignment ID
|
|
265
|
-
* @returns Promise that resolves when the assignment is deleted
|
|
266
|
-
* @throws {ApiError} if the request fails
|
|
267
|
-
*/
|
|
268
|
-
deleteAssignment(workspaceSlug: string, assignmentId: string): Promise<void>;
|
|
269
|
-
}
|
|
270
|
-
//#endregion
|
|
271
218
|
//#region src/services/auth.d.ts
|
|
272
219
|
/**
|
|
273
220
|
* Service for handling authentication operations
|
|
@@ -332,15 +279,16 @@ declare class Auth {
|
|
|
332
279
|
* @returns Promise that resolves with the minted token and redirect URI
|
|
333
280
|
* @throws {ApiError} if the request fails
|
|
334
281
|
*/
|
|
335
|
-
mintDesktopToken(request: DesktopTokenRequest): Promise<
|
|
282
|
+
mintDesktopToken(request: DesktopTokenRequest): Promise<AccountDesktopToken>;
|
|
336
283
|
}
|
|
337
284
|
//#endregion
|
|
338
|
-
//#region src/services/
|
|
285
|
+
//#region src/services/capabilities.d.ts
|
|
339
286
|
/**
|
|
340
|
-
* Service for reading the deployment's
|
|
341
|
-
*
|
|
287
|
+
* Service for reading the deployment's capabilities: the label taxonomy, the
|
|
288
|
+
* registered recognizers, the connectors it can create, and the auth methods
|
|
289
|
+
* it offers. Read-only; served by the `/capabilities/*` endpoints.
|
|
342
290
|
*/
|
|
343
|
-
declare class
|
|
291
|
+
declare class Capabilities {
|
|
344
292
|
#private;
|
|
345
293
|
constructor(api: ApiClient);
|
|
346
294
|
/**
|
|
@@ -361,79 +309,14 @@ declare class Catalog {
|
|
|
361
309
|
* credentials and are always available. Use it to render the connect UI
|
|
362
310
|
* without probing.
|
|
363
311
|
*
|
|
364
|
-
* @returns Promise that resolves with the connector
|
|
312
|
+
* @returns Promise that resolves with the connector capabilities.
|
|
365
313
|
*/
|
|
366
|
-
listConnectors(): Promise<
|
|
367
|
-
}
|
|
368
|
-
//#endregion
|
|
369
|
-
//#region src/services/chat.d.ts
|
|
370
|
-
/**
|
|
371
|
-
* Service for the workspace assistant chat: sessions and streamed messages.
|
|
372
|
-
*/
|
|
373
|
-
declare class Chat {
|
|
374
|
-
#private;
|
|
375
|
-
constructor(api: ApiClient);
|
|
314
|
+
listConnectors(): Promise<ConnectorCapabilities>;
|
|
376
315
|
/**
|
|
377
|
-
* List
|
|
378
|
-
* @
|
|
379
|
-
* @param query - Optional pagination (limit, after)
|
|
380
|
-
* @returns Promise that resolves with a paginated list of chat sessions
|
|
381
|
-
* @throws {ApiError} if the request fails
|
|
316
|
+
* List which authentication methods this deployment offers.
|
|
317
|
+
* @returns Promise that resolves with the auth capabilities.
|
|
382
318
|
*/
|
|
383
|
-
|
|
384
|
-
/**
|
|
385
|
-
* Open a new assistant chat session in the workspace.
|
|
386
|
-
* @param workspaceSlug - Workspace slug
|
|
387
|
-
* @param session - Session creation request
|
|
388
|
-
* @returns Promise that resolves with the created chat session
|
|
389
|
-
* @throws {ApiError} if the request fails
|
|
390
|
-
*/
|
|
391
|
-
createSession(workspaceSlug: string, session: CreateChatSession): Promise<ChatSession>;
|
|
392
|
-
/**
|
|
393
|
-
* Soft-delete a chat session.
|
|
394
|
-
* @param workspaceSlug - Workspace slug
|
|
395
|
-
* @param sessionId - Session ID
|
|
396
|
-
* @throws {ApiError} if the request fails
|
|
397
|
-
*/
|
|
398
|
-
deleteSession(workspaceSlug: string, sessionId: string): Promise<void>;
|
|
399
|
-
/**
|
|
400
|
-
* List a session's messages in chronological order.
|
|
401
|
-
* @param workspaceSlug - Workspace slug
|
|
402
|
-
* @param sessionId - Session ID
|
|
403
|
-
* @returns Promise that resolves with the session's messages
|
|
404
|
-
* @throws {ApiError} if the request fails
|
|
405
|
-
*/
|
|
406
|
-
listMessages(workspaceSlug: string, sessionId: string): Promise<ChatMessage[]>;
|
|
407
|
-
/**
|
|
408
|
-
* Open the raw Server-Sent Events stream of the assistant's reply.
|
|
409
|
-
*
|
|
410
|
-
* Returns the underlying `Response` so callers can handle the
|
|
411
|
-
* `text/event-stream` body themselves. Most callers want
|
|
412
|
-
* {@link streamMessage}, which parses each frame into a typed
|
|
413
|
-
* {@link ChatToken}.
|
|
414
|
-
*
|
|
415
|
-
* @param workspaceSlug - Workspace slug
|
|
416
|
-
* @param sessionId - Session ID
|
|
417
|
-
* @param message - The message to send
|
|
418
|
-
* @returns Promise that resolves with the event-stream response
|
|
419
|
-
* @throws {ApiError} if the request fails
|
|
420
|
-
*/
|
|
421
|
-
sendMessage(workspaceSlug: string, sessionId: string, message: SendChatMessage): Promise<Response>;
|
|
422
|
-
/**
|
|
423
|
-
* Send a message and stream the assistant's reply as Server-Sent Events.
|
|
424
|
-
*
|
|
425
|
-
* Yields each {@link ChatToken} delta as it arrives, until the reply ends.
|
|
426
|
-
* Break out of the loop to stop reading. For the raw response, use
|
|
427
|
-
* {@link sendMessage}.
|
|
428
|
-
*
|
|
429
|
-
* @param workspaceSlug - Workspace slug
|
|
430
|
-
* @param sessionId - Session ID
|
|
431
|
-
* @param message - The message to send
|
|
432
|
-
* @yields each {@link ChatToken} delta as it arrives
|
|
433
|
-
* @throws {ApiError} if the request fails to open
|
|
434
|
-
* @throws {NvisyError} if the response has no readable body
|
|
435
|
-
*/
|
|
436
|
-
streamMessage(workspaceSlug: string, sessionId: string, message: SendChatMessage): AsyncGenerator<ChatToken>;
|
|
319
|
+
getAuthCapabilities(): Promise<AuthCapabilities>;
|
|
437
320
|
}
|
|
438
321
|
//#endregion
|
|
439
322
|
//#region src/services/connections.d.ts
|
|
@@ -445,55 +328,55 @@ declare class Connections {
|
|
|
445
328
|
constructor(api: ApiClient);
|
|
446
329
|
/**
|
|
447
330
|
* List connections in a workspace
|
|
448
|
-
* @param
|
|
331
|
+
* @param workspaceId - Workspace id
|
|
449
332
|
* @param query - Optional query parameters (provider, limit, after)
|
|
450
333
|
* @returns Promise that resolves with a paginated list of connections
|
|
451
334
|
* @throws {ApiError} if the request fails
|
|
452
335
|
*/
|
|
453
|
-
listConnections(
|
|
336
|
+
listConnections(workspaceId: string, query?: CursorPagination & {
|
|
454
337
|
provider?: string[];
|
|
455
|
-
}): Promise<
|
|
338
|
+
}): Promise<WorkspaceConnectionPage>;
|
|
456
339
|
/**
|
|
457
340
|
* Create a connection in a workspace
|
|
458
|
-
* @param
|
|
341
|
+
* @param workspaceId - Workspace id
|
|
459
342
|
* @param connection - Connection creation request
|
|
460
343
|
* @returns Promise that resolves with the created connection
|
|
461
344
|
* @throws {ApiError} if the request fails
|
|
462
345
|
*/
|
|
463
|
-
createConnection(
|
|
346
|
+
createConnection(workspaceId: string, connection: CreateWorkspaceConnection): Promise<WorkspaceConnection>;
|
|
464
347
|
/**
|
|
465
348
|
* Get connection details by ID
|
|
466
|
-
* @param
|
|
349
|
+
* @param workspaceId - Workspace id
|
|
467
350
|
* @param connectionId - Connection ID
|
|
468
351
|
* @returns Promise that resolves with the connection details
|
|
469
352
|
* @throws {ApiError} if the request fails
|
|
470
353
|
*/
|
|
471
|
-
getConnection(
|
|
354
|
+
getConnection(workspaceId: string, connectionId: string): Promise<WorkspaceConnection>;
|
|
472
355
|
/**
|
|
473
356
|
* Update a connection
|
|
474
|
-
* @param
|
|
357
|
+
* @param workspaceId - Workspace id
|
|
475
358
|
* @param connectionId - Connection ID
|
|
476
359
|
* @param updates - Connection update request
|
|
477
360
|
* @returns Promise that resolves with the updated connection
|
|
478
361
|
* @throws {ApiError} if the request fails
|
|
479
362
|
*/
|
|
480
|
-
updateConnection(
|
|
363
|
+
updateConnection(workspaceId: string, connectionId: string, updates: UpdateWorkspaceConnection): Promise<WorkspaceConnection>;
|
|
481
364
|
/**
|
|
482
365
|
* Delete a connection
|
|
483
|
-
* @param
|
|
366
|
+
* @param workspaceId - Workspace id
|
|
484
367
|
* @param connectionId - Connection ID
|
|
485
368
|
* @returns Promise that resolves when the connection is deleted
|
|
486
369
|
* @throws {ApiError} if the request fails
|
|
487
370
|
*/
|
|
488
|
-
deleteConnection(
|
|
371
|
+
deleteConnection(workspaceId: string, connectionId: string): Promise<void>;
|
|
489
372
|
/**
|
|
490
373
|
* Verify a connection's configuration and credentials
|
|
491
|
-
* @param
|
|
374
|
+
* @param workspaceId - Workspace id
|
|
492
375
|
* @param connectionId - Connection ID
|
|
493
376
|
* @returns Promise that resolves with the verification result
|
|
494
377
|
* @throws {ApiError} if the request fails
|
|
495
378
|
*/
|
|
496
|
-
verifyConnection(
|
|
379
|
+
verifyConnection(workspaceId: string, connectionId: string): Promise<WorkspaceConnectionVerification>;
|
|
497
380
|
/**
|
|
498
381
|
* Start the OAuth flow to connect a file-service provider.
|
|
499
382
|
*
|
|
@@ -501,13 +384,13 @@ declare class Connections {
|
|
|
501
384
|
* provider redirects back and the connection is created. Navigate the
|
|
502
385
|
* browser to the URL (a full-page redirect, not a fetch) to continue.
|
|
503
386
|
*
|
|
504
|
-
* @param
|
|
387
|
+
* @param workspaceId - Workspace id
|
|
505
388
|
* @param provider - The file-service provider to connect
|
|
506
389
|
* @param request - Display name for the connection and optional sync root
|
|
507
390
|
* @returns Promise that resolves with the provider authorize URL
|
|
508
391
|
* @throws {ApiError} if the request fails
|
|
509
392
|
*/
|
|
510
|
-
startFileServiceOAuth(
|
|
393
|
+
startFileServiceOAuth(workspaceId: string, provider: FileServiceProvider, request: StartFileServiceOAuth): Promise<OAuthStartResponse>;
|
|
511
394
|
/**
|
|
512
395
|
* Import picker-selected files from a file-service connection.
|
|
513
396
|
*
|
|
@@ -515,13 +398,13 @@ declare class Connections {
|
|
|
515
398
|
* already-imported files are skipped. Returns the created sync — poll it for
|
|
516
399
|
* completion.
|
|
517
400
|
*
|
|
518
|
-
* @param
|
|
401
|
+
* @param workspaceId - Workspace id
|
|
519
402
|
* @param connectionId - Connection ID
|
|
520
403
|
* @param request - The picker-selected files to import
|
|
521
404
|
* @returns Promise that resolves with the created connection sync
|
|
522
405
|
* @throws {ApiError} if the request fails
|
|
523
406
|
*/
|
|
524
|
-
importFiles(
|
|
407
|
+
importFiles(workspaceId: string, connectionId: string, request: ImportWorkspaceFiles): Promise<WorkspaceConnectionSync>;
|
|
525
408
|
/**
|
|
526
409
|
* Export workspace files to a file-service connection.
|
|
527
410
|
*
|
|
@@ -529,13 +412,13 @@ declare class Connections {
|
|
|
529
412
|
* file, never overwriting the source. Returns the created sync — poll it for
|
|
530
413
|
* completion.
|
|
531
414
|
*
|
|
532
|
-
* @param
|
|
415
|
+
* @param workspaceId - Workspace id
|
|
533
416
|
* @param connectionId - Connection ID
|
|
534
417
|
* @param request - The workspace file ids to export
|
|
535
418
|
* @returns Promise that resolves with the created connection sync
|
|
536
419
|
* @throws {ApiError} if the request fails
|
|
537
420
|
*/
|
|
538
|
-
exportFiles(
|
|
421
|
+
exportFiles(workspaceId: string, connectionId: string, request: ExportWorkspaceFiles): Promise<WorkspaceConnectionSync>;
|
|
539
422
|
/**
|
|
540
423
|
* Mint a short-lived provider access token for a browser file picker.
|
|
541
424
|
*
|
|
@@ -543,13 +426,13 @@ declare class Connections {
|
|
|
543
426
|
* minted from the connection's stored credentials and is short-lived; the
|
|
544
427
|
* refresh token is never returned.
|
|
545
428
|
*
|
|
546
|
-
* @param
|
|
429
|
+
* @param workspaceId - Workspace id
|
|
547
430
|
* @param connectionId - Connection ID
|
|
548
431
|
* @param request - Optional picker resource (defaults to the connection's)
|
|
549
432
|
* @returns Promise that resolves with the short-lived picker token
|
|
550
433
|
* @throws {ApiError} if the request fails
|
|
551
434
|
*/
|
|
552
|
-
getPickerToken(
|
|
435
|
+
getPickerToken(workspaceId: string, connectionId: string, request?: WorkspacePickerTokenRequest): Promise<WorkspacePickerToken>;
|
|
553
436
|
}
|
|
554
437
|
//#endregion
|
|
555
438
|
//#region src/services/detections.d.ts
|
|
@@ -562,48 +445,56 @@ declare class Detections {
|
|
|
562
445
|
constructor(api: ApiClient);
|
|
563
446
|
/**
|
|
564
447
|
* List all detections in a workspace
|
|
565
|
-
* @param
|
|
448
|
+
* @param workspaceId - Workspace id
|
|
566
449
|
* @param query - Optional pagination and filters (status, fileId,
|
|
567
450
|
* pipelineId, triggerType, triggeredBy, limit, after)
|
|
568
451
|
* @returns Promise that resolves with a paginated list of detections
|
|
569
452
|
* @throws {ApiError} if the request fails
|
|
570
453
|
*/
|
|
571
|
-
listDetections(
|
|
454
|
+
listDetections(workspaceId: string, query?: CursorPagination & WorkspaceDetectionsQuery): Promise<WorkspaceDetectionPage>;
|
|
572
455
|
/**
|
|
573
456
|
* List detections for a specific pipeline
|
|
574
|
-
* @param
|
|
575
|
-
* @param
|
|
457
|
+
* @param workspaceId - Workspace id
|
|
458
|
+
* @param pipelineId - Pipeline id
|
|
576
459
|
* @param query - Optional pagination and filters (status, fileId,
|
|
577
460
|
* triggerType, triggeredBy, limit, after)
|
|
578
461
|
* @returns Promise that resolves with a paginated list of detections
|
|
579
462
|
* @throws {ApiError} if the request fails
|
|
580
463
|
*/
|
|
581
|
-
listPipelineDetections(
|
|
464
|
+
listPipelineDetections(workspaceId: string, pipelineId: string, query?: CursorPagination & WorkspacePipelineDetectionsQuery): Promise<WorkspaceDetectionPage>;
|
|
582
465
|
/**
|
|
583
466
|
* Start a new detection over a file for a pipeline
|
|
584
|
-
* @param
|
|
585
|
-
* @param
|
|
467
|
+
* @param workspaceId - Workspace id
|
|
468
|
+
* @param pipelineId - Pipeline id
|
|
586
469
|
* @param detection - Detection creation request
|
|
587
470
|
* @returns Promise that resolves with the created detection
|
|
588
471
|
* @throws {ApiError} if the request fails
|
|
589
472
|
*/
|
|
590
|
-
createDetection(
|
|
473
|
+
createDetection(workspaceId: string, pipelineId: string, detection: CreateWorkspaceDetection): Promise<WorkspaceDetection>;
|
|
474
|
+
/**
|
|
475
|
+
* Start an ad-hoc detection over a document without a saved pipeline.
|
|
476
|
+
* @param workspaceId - Workspace id
|
|
477
|
+
* @param detection - Ad-hoc detection creation request
|
|
478
|
+
* @returns Promise that resolves with the created detection
|
|
479
|
+
* @throws {ApiError} if the request fails
|
|
480
|
+
*/
|
|
481
|
+
createAdhocDetection(workspaceId: string, detection: CreateAdhocWorkspaceDetection): Promise<WorkspaceDetection>;
|
|
591
482
|
/**
|
|
592
483
|
* Get detection details by ID
|
|
593
|
-
* @param
|
|
484
|
+
* @param workspaceId - Workspace id
|
|
594
485
|
* @param detectionId - Detection ID
|
|
595
486
|
* @returns Promise that resolves with the detection details
|
|
596
487
|
* @throws {ApiError} if the request fails
|
|
597
488
|
*/
|
|
598
|
-
getDetection(
|
|
489
|
+
getDetection(workspaceId: string, detectionId: string): Promise<WorkspaceDetection>;
|
|
599
490
|
/**
|
|
600
491
|
* Get a detection's analysis (audit)
|
|
601
|
-
* @param
|
|
492
|
+
* @param workspaceId - Workspace id
|
|
602
493
|
* @param detectionId - Detection ID
|
|
603
494
|
* @returns Promise that resolves with the audit
|
|
604
495
|
* @throws {ApiError} if the request fails
|
|
605
496
|
*/
|
|
606
|
-
getAnalysis(
|
|
497
|
+
getAnalysis(workspaceId: string, detectionId: string): Promise<Audit>;
|
|
607
498
|
/**
|
|
608
499
|
* Get a detection's enrichment intermediates.
|
|
609
500
|
*
|
|
@@ -612,25 +503,25 @@ declare class Detections {
|
|
|
612
503
|
* can search the extracted content and add entities the analysis missed. A
|
|
613
504
|
* detection whose analysis ran no enricher has no intermediates and 404s.
|
|
614
505
|
*
|
|
615
|
-
* @param
|
|
506
|
+
* @param workspaceId - Workspace id
|
|
616
507
|
* @param detectionId - Detection ID
|
|
617
508
|
* @returns Promise that resolves with the artifact set
|
|
618
509
|
* @throws {ApiError} if the request fails (404 when there are none)
|
|
619
510
|
*/
|
|
620
|
-
getIntermediates(
|
|
511
|
+
getIntermediates(workspaceId: string, detectionId: string): Promise<ArtifactSet>;
|
|
621
512
|
/**
|
|
622
513
|
* Download a detection's audit as a file.
|
|
623
514
|
*
|
|
624
515
|
* `format` is `csv` (default) — a zip of entities.csv, provenance.csv, and
|
|
625
516
|
* reviews.csv — or `json`, a pretty-printed JSON file.
|
|
626
517
|
*
|
|
627
|
-
* @param
|
|
518
|
+
* @param workspaceId - Workspace id
|
|
628
519
|
* @param detectionId - Detection ID
|
|
629
520
|
* @param query - Optional output format (`csv` default, or `json`)
|
|
630
521
|
* @returns Promise that resolves with the file response
|
|
631
522
|
* @throws {ApiError} if the request fails
|
|
632
523
|
*/
|
|
633
|
-
downloadAudit(
|
|
524
|
+
downloadAudit(workspaceId: string, detectionId: string, query?: ExportQuery): Promise<Response>;
|
|
634
525
|
/**
|
|
635
526
|
* Open the raw Server-Sent Events stream of a detection's status changes.
|
|
636
527
|
*
|
|
@@ -639,12 +530,12 @@ declare class Detections {
|
|
|
639
530
|
* {@link streamEvents}, which parses each frame into a typed
|
|
640
531
|
* {@link DetectionStatusEvent}.
|
|
641
532
|
*
|
|
642
|
-
* @param
|
|
533
|
+
* @param workspaceId - Workspace id
|
|
643
534
|
* @param detectionId - Detection ID
|
|
644
535
|
* @returns Promise that resolves with the event-stream response
|
|
645
536
|
* @throws {ApiError} if the request fails
|
|
646
537
|
*/
|
|
647
|
-
events(
|
|
538
|
+
events(workspaceId: string, detectionId: string): Promise<Response>;
|
|
648
539
|
/**
|
|
649
540
|
* Stream a detection's status changes as Server-Sent Events.
|
|
650
541
|
*
|
|
@@ -652,103 +543,120 @@ declare class Detections {
|
|
|
652
543
|
* once the detection settles. Break out of the loop to close the stream
|
|
653
544
|
* early. For the raw response, use {@link events}.
|
|
654
545
|
*
|
|
655
|
-
* @param
|
|
546
|
+
* @param workspaceId - Workspace id
|
|
656
547
|
* @param detectionId - Detection ID
|
|
657
548
|
* @yields each {@link DetectionStatusEvent} as it arrives
|
|
658
549
|
* @throws {ApiError} if the request fails to open
|
|
659
550
|
* @throws {NvisyError} if the response has no readable body
|
|
660
551
|
*/
|
|
661
|
-
streamEvents(
|
|
552
|
+
streamEvents(workspaceId: string, detectionId: string): AsyncGenerator<DetectionStatusEvent>;
|
|
662
553
|
/**
|
|
663
554
|
* List the redactions produced from a detection
|
|
664
|
-
* @param
|
|
555
|
+
* @param workspaceId - Workspace id
|
|
665
556
|
* @param detectionId - Detection ID
|
|
666
557
|
* @param query - Optional pagination (limit, after)
|
|
667
558
|
* @returns Promise that resolves with a paginated list of redactions
|
|
668
559
|
* @throws {ApiError} if the request fails
|
|
669
560
|
*/
|
|
670
|
-
listRedactions(
|
|
561
|
+
listRedactions(workspaceId: string, detectionId: string, query?: CursorPagination): Promise<WorkspaceRedactionResultPage>;
|
|
671
562
|
/**
|
|
672
563
|
* Redact a detection, producing a redaction result
|
|
673
|
-
* @param
|
|
564
|
+
* @param workspaceId - Workspace id
|
|
674
565
|
* @param detectionId - Detection ID
|
|
675
566
|
* @param redaction - Redaction request (optional reviewer edits)
|
|
676
567
|
* @returns Promise that resolves with the created redaction result
|
|
677
568
|
* @throws {ApiError} if the request fails
|
|
678
569
|
*/
|
|
679
|
-
createRedaction(
|
|
570
|
+
createRedaction(workspaceId: string, detectionId: string, redaction: RedactWorkspaceDetection): Promise<WorkspaceRedactionResult>;
|
|
680
571
|
}
|
|
681
572
|
//#endregion
|
|
682
|
-
//#region src/services/
|
|
573
|
+
//#region src/services/documents.d.ts
|
|
683
574
|
/**
|
|
684
|
-
* Service for handling
|
|
575
|
+
* Service for handling document operations, including review assignment.
|
|
685
576
|
*/
|
|
686
|
-
declare class
|
|
577
|
+
declare class Documents {
|
|
687
578
|
#private;
|
|
688
579
|
constructor(api: ApiClient);
|
|
689
580
|
/**
|
|
690
|
-
* Upload one or more
|
|
691
|
-
* @param
|
|
692
|
-
* @param
|
|
693
|
-
* @returns Promise that resolves with the uploaded
|
|
581
|
+
* Upload one or more documents to a workspace
|
|
582
|
+
* @param workspaceId - Workspace id
|
|
583
|
+
* @param documents - Document or array of documents to upload
|
|
584
|
+
* @returns Promise that resolves with the uploaded document metadata
|
|
694
585
|
* @throws {ApiError} if the request fails
|
|
695
586
|
*/
|
|
696
|
-
|
|
587
|
+
uploadDocuments(workspaceId: string, documents: Blob | Blob[]): Promise<WorkspaceDocument[]>;
|
|
697
588
|
/**
|
|
698
|
-
* List
|
|
699
|
-
* @param
|
|
589
|
+
* List documents in a workspace
|
|
590
|
+
* @param workspaceId - Workspace id
|
|
700
591
|
* @param query - Optional query parameters (formats, modality, hash, search,
|
|
701
592
|
* limit, after)
|
|
702
|
-
* @returns Promise that resolves with a paginated list of
|
|
593
|
+
* @returns Promise that resolves with a paginated list of documents
|
|
703
594
|
* @throws {ApiError} if the request fails
|
|
704
595
|
*/
|
|
705
|
-
|
|
596
|
+
listDocuments(workspaceId: string, query?: ListWorkspaceDocuments & CursorPagination): Promise<WorkspaceDocumentPage>;
|
|
706
597
|
/**
|
|
707
|
-
* Get
|
|
708
|
-
* @param
|
|
709
|
-
* @param
|
|
710
|
-
* @returns Promise that resolves with the
|
|
598
|
+
* Get document metadata by ID
|
|
599
|
+
* @param workspaceId - Workspace id
|
|
600
|
+
* @param documentId - Document ID
|
|
601
|
+
* @returns Promise that resolves with the document metadata
|
|
711
602
|
* @throws {ApiError} if the request fails
|
|
712
603
|
*/
|
|
713
|
-
|
|
604
|
+
getDocument(workspaceId: string, documentId: string): Promise<WorkspaceDocument>;
|
|
714
605
|
/**
|
|
715
|
-
* Download a
|
|
716
|
-
* @param
|
|
717
|
-
* @param
|
|
718
|
-
* @returns Promise that resolves with the
|
|
606
|
+
* Download a document by ID
|
|
607
|
+
* @param workspaceId - Workspace id
|
|
608
|
+
* @param documentId - Document ID
|
|
609
|
+
* @returns Promise that resolves with the document response
|
|
719
610
|
* @throws {ApiError} if the request fails
|
|
720
611
|
*/
|
|
721
|
-
|
|
612
|
+
downloadDocument(workspaceId: string, documentId: string): Promise<Response>;
|
|
722
613
|
/**
|
|
723
|
-
* Update a
|
|
724
|
-
* @param
|
|
725
|
-
* @param
|
|
726
|
-
* @param updates -
|
|
727
|
-
* @returns Promise that resolves with the updated
|
|
614
|
+
* Update a document's metadata
|
|
615
|
+
* @param workspaceId - Workspace id
|
|
616
|
+
* @param documentId - Document ID
|
|
617
|
+
* @param updates - Document update request
|
|
618
|
+
* @returns Promise that resolves with the updated document
|
|
728
619
|
* @throws {ApiError} if the request fails
|
|
729
620
|
*/
|
|
730
|
-
|
|
621
|
+
updateDocument(workspaceId: string, documentId: string, updates: UpdateWorkspaceDocument): Promise<WorkspaceDocument>;
|
|
731
622
|
/**
|
|
732
|
-
* Delete a
|
|
733
|
-
* @param
|
|
734
|
-
* @param
|
|
735
|
-
* @returns Promise that resolves when the
|
|
623
|
+
* Delete a document
|
|
624
|
+
* @param workspaceId - Workspace id
|
|
625
|
+
* @param documentId - Document ID
|
|
626
|
+
* @returns Promise that resolves when the document is deleted
|
|
736
627
|
* @throws {ApiError} if the request fails
|
|
737
628
|
*/
|
|
738
|
-
|
|
629
|
+
deleteDocument(workspaceId: string, documentId: string): Promise<void>;
|
|
739
630
|
/**
|
|
740
|
-
* Delete several
|
|
631
|
+
* Delete several documents in one call.
|
|
741
632
|
*
|
|
742
|
-
* Idempotent: ids resolving to live
|
|
743
|
-
* returned in `deleted`; unknown, already-deleted, or out-of-workspace
|
|
744
|
-
* are returned in `skipped`. Deletion is permanent.
|
|
633
|
+
* Idempotent: ids resolving to live documents in the workspace are removed
|
|
634
|
+
* and returned in `deleted`; unknown, already-deleted, or out-of-workspace
|
|
635
|
+
* ids are returned in `skipped`. Deletion is permanent.
|
|
745
636
|
*
|
|
746
|
-
* @param
|
|
747
|
-
* @param
|
|
637
|
+
* @param workspaceId - Workspace id
|
|
638
|
+
* @param documentIds - The document IDs to delete
|
|
748
639
|
* @returns Promise that resolves with the deleted and skipped ids
|
|
749
640
|
* @throws {ApiError} if the request fails
|
|
750
641
|
*/
|
|
751
|
-
|
|
642
|
+
deleteDocuments(workspaceId: string, documentIds: string[]): Promise<WorkspaceDeletedDocuments>;
|
|
643
|
+
/**
|
|
644
|
+
* Assign a document for review, opening a review thread.
|
|
645
|
+
* @param workspaceId - Workspace id
|
|
646
|
+
* @param documentId - Document ID
|
|
647
|
+
* @param assignment - Review assignment request
|
|
648
|
+
* @returns Promise that resolves with the review thread
|
|
649
|
+
* @throws {ApiError} if the request fails
|
|
650
|
+
*/
|
|
651
|
+
assignReview(workspaceId: string, documentId: string, assignment: AssignWorkspaceReview): Promise<WorkspaceThread>;
|
|
652
|
+
/**
|
|
653
|
+
* Mark a document's review as verified (resolved).
|
|
654
|
+
* @param workspaceId - Workspace id
|
|
655
|
+
* @param documentId - Document ID
|
|
656
|
+
* @returns Promise that resolves with the review thread
|
|
657
|
+
* @throws {ApiError} if the request fails
|
|
658
|
+
*/
|
|
659
|
+
verifyReview(workspaceId: string, documentId: string): Promise<WorkspaceThread>;
|
|
752
660
|
}
|
|
753
661
|
//#endregion
|
|
754
662
|
//#region src/services/invites.d.ts
|
|
@@ -765,48 +673,48 @@ declare class Invites {
|
|
|
765
673
|
* @returns Promise that resolves with a paginated list of invitations
|
|
766
674
|
* @throws {ApiError} if the request fails
|
|
767
675
|
*/
|
|
768
|
-
listInvites(
|
|
676
|
+
listInvites(workspaceId: string, query?: ListWorkspaceInvites & CursorPagination): Promise<WorkspaceInvitePage>;
|
|
769
677
|
/**
|
|
770
678
|
* Send an invitation to join a workspace
|
|
771
|
-
* @param
|
|
679
|
+
* @param workspaceId - Workspace id
|
|
772
680
|
* @param invite - Invitation request
|
|
773
681
|
* @returns Promise that resolves with the sent invitation
|
|
774
682
|
* @throws {ApiError} if the request fails
|
|
775
683
|
*/
|
|
776
|
-
sendInvite(
|
|
684
|
+
sendInvite(workspaceId: string, invite: CreateWorkspaceInvite): Promise<WorkspaceInviteSent>;
|
|
777
685
|
/**
|
|
778
686
|
* Cancel a pending invitation
|
|
779
|
-
* @param
|
|
687
|
+
* @param workspaceId - Workspace id
|
|
780
688
|
* @param inviteId - Invite ID
|
|
781
689
|
* @returns Promise that resolves when the invitation is canceled
|
|
782
690
|
* @throws {ApiError} if the request fails
|
|
783
691
|
*/
|
|
784
|
-
cancelInvite(
|
|
692
|
+
cancelInvite(workspaceId: string, inviteId: string): Promise<void>;
|
|
785
693
|
/**
|
|
786
694
|
* Reply to an invitation (accept or decline)
|
|
787
|
-
* @param
|
|
695
|
+
* @param workspaceId - Workspace id
|
|
788
696
|
* @param inviteId - Invite ID
|
|
789
697
|
* @param reply - Reply request
|
|
790
698
|
* @returns Promise that resolves with the updated invitation
|
|
791
699
|
* @throws {ApiError} if the request fails
|
|
792
700
|
*/
|
|
793
|
-
replyToInvite(
|
|
701
|
+
replyToInvite(workspaceId: string, inviteId: string, reply: ReplyWorkspaceInvite): Promise<WorkspaceMember>;
|
|
794
702
|
/**
|
|
795
703
|
* Generate a shareable invite code for a workspace
|
|
796
|
-
* @param
|
|
704
|
+
* @param workspaceId - Workspace id
|
|
797
705
|
* @param options - Invite code generation options
|
|
798
706
|
* @returns Promise that resolves with the generated invite code
|
|
799
707
|
* @throws {ApiError} if the request fails
|
|
800
708
|
*/
|
|
801
|
-
generateInviteCode(
|
|
709
|
+
generateInviteCode(workspaceId: string, options: GenerateWorkspaceInviteCode): Promise<WorkspaceInviteCode>;
|
|
802
710
|
/**
|
|
803
711
|
* Reply to an invite code (accept or decline)
|
|
804
712
|
* @param inviteCode - The invite code
|
|
805
|
-
* @param reply -
|
|
713
|
+
* @param reply - Reply request (accept or decline the invitation)
|
|
806
714
|
* @returns Promise that resolves with the member details if accepted, null if declined
|
|
807
715
|
* @throws {ApiError} if the request fails
|
|
808
716
|
*/
|
|
809
|
-
replyToInviteCode(inviteCode: string, reply
|
|
717
|
+
replyToInviteCode(inviteCode: string, reply: ReplyWorkspaceInvite): Promise<WorkspaceMember | null>;
|
|
810
718
|
/**
|
|
811
719
|
* Preview an invite code without joining
|
|
812
720
|
* @param inviteCode - The invite code
|
|
@@ -825,44 +733,44 @@ declare class Members {
|
|
|
825
733
|
constructor(api: ApiClient);
|
|
826
734
|
/**
|
|
827
735
|
* List members of a workspace
|
|
828
|
-
* @param
|
|
736
|
+
* @param workspaceId - Workspace id
|
|
829
737
|
* @param query - Optional query parameters (role, has2fa, sortBy, order, limit, after)
|
|
830
738
|
* @returns Promise that resolves with a paginated list of members
|
|
831
739
|
* @throws {ApiError} if the request fails
|
|
832
740
|
*/
|
|
833
|
-
listMembers(
|
|
741
|
+
listMembers(workspaceId: string, query?: ListWorkspaceMembers & CursorPagination): Promise<WorkspaceMemberPage>;
|
|
834
742
|
/**
|
|
835
|
-
* Get member details by
|
|
836
|
-
* @param
|
|
837
|
-
* @param
|
|
743
|
+
* Get member details by account id
|
|
744
|
+
* @param workspaceId - Workspace id
|
|
745
|
+
* @param accountId - Member account id
|
|
838
746
|
* @returns Promise that resolves with the member details
|
|
839
747
|
* @throws {ApiError} if the request fails
|
|
840
748
|
*/
|
|
841
|
-
getMember(
|
|
749
|
+
getMember(workspaceId: string, accountId: string): Promise<WorkspaceMember>;
|
|
842
750
|
/**
|
|
843
751
|
* Update a member's role
|
|
844
|
-
* @param
|
|
845
|
-
* @param
|
|
752
|
+
* @param workspaceId - Workspace id
|
|
753
|
+
* @param accountId - Member account id
|
|
846
754
|
* @param updates - New role for the member
|
|
847
755
|
* @returns Promise that resolves with the updated member
|
|
848
756
|
* @throws {ApiError} if the request fails
|
|
849
757
|
*/
|
|
850
|
-
updateMember(
|
|
758
|
+
updateMember(workspaceId: string, accountId: string, updates: UpdateWorkspaceMember): Promise<WorkspaceMember>;
|
|
851
759
|
/**
|
|
852
760
|
* Remove a member from a workspace
|
|
853
|
-
* @param
|
|
854
|
-
* @param
|
|
761
|
+
* @param workspaceId - Workspace id
|
|
762
|
+
* @param accountId - Member account id
|
|
855
763
|
* @returns Promise that resolves when the member is removed
|
|
856
764
|
* @throws {ApiError} if the request fails
|
|
857
765
|
*/
|
|
858
|
-
removeMember(
|
|
766
|
+
removeMember(workspaceId: string, accountId: string): Promise<void>;
|
|
859
767
|
/**
|
|
860
768
|
* Leave a workspace
|
|
861
|
-
* @param
|
|
769
|
+
* @param workspaceId - Workspace id
|
|
862
770
|
* @returns Promise that resolves when the member has left
|
|
863
771
|
* @throws {ApiError} if the request fails
|
|
864
772
|
*/
|
|
865
|
-
leaveWorkspace(
|
|
773
|
+
leaveWorkspace(workspaceId: string): Promise<void>;
|
|
866
774
|
}
|
|
867
775
|
//#endregion
|
|
868
776
|
//#region src/services/notifications.d.ts
|
|
@@ -878,19 +786,19 @@ declare class Notifications {
|
|
|
878
786
|
* @returns Promise that resolves with a paginated list of notifications
|
|
879
787
|
* @throws {ApiError} if the request fails
|
|
880
788
|
*/
|
|
881
|
-
listNotifications(query?: CursorPagination): Promise<
|
|
789
|
+
listNotifications(query?: CursorPagination): Promise<AccountNotificationPage>;
|
|
882
790
|
/**
|
|
883
791
|
* Get the unread notifications count for the authenticated account
|
|
884
792
|
* @returns Promise that resolves with the unread status
|
|
885
793
|
* @throws {ApiError} if the request fails
|
|
886
794
|
*/
|
|
887
|
-
getUnreadNotificationsStatus(): Promise<
|
|
795
|
+
getUnreadNotificationsStatus(): Promise<AccountUnreadStatus>;
|
|
888
796
|
/**
|
|
889
797
|
* Mark every unread notification for the authenticated account as read
|
|
890
798
|
* @returns Promise that resolves with how many were marked read
|
|
891
799
|
* @throws {ApiError} if the request fails
|
|
892
800
|
*/
|
|
893
|
-
markAllRead(): Promise<
|
|
801
|
+
markAllRead(): Promise<AccountMarkedReadStatus>;
|
|
894
802
|
/**
|
|
895
803
|
* Mark a single notification as read
|
|
896
804
|
* @param notificationId - Notification ID
|
|
@@ -932,48 +840,48 @@ declare class Pipelines {
|
|
|
932
840
|
constructor(api: ApiClient);
|
|
933
841
|
/**
|
|
934
842
|
* List pipelines in a workspace
|
|
935
|
-
* @param
|
|
843
|
+
* @param workspaceId - Workspace id
|
|
936
844
|
* @param query - Optional query parameters (search, status, limit, after)
|
|
937
845
|
* @returns Promise that resolves with a paginated list of pipeline summaries
|
|
938
846
|
* @throws {ApiError} if the request fails
|
|
939
847
|
*/
|
|
940
|
-
listPipelines(
|
|
848
|
+
listPipelines(workspaceId: string, query?: CursorPagination & {
|
|
941
849
|
search?: string;
|
|
942
850
|
status?: PipelineStatus;
|
|
943
|
-
}): Promise<
|
|
851
|
+
}): Promise<WorkspacePipelineSummaryPage>;
|
|
944
852
|
/**
|
|
945
853
|
* Create a pipeline in a workspace
|
|
946
|
-
* @param
|
|
854
|
+
* @param workspaceId - Workspace id
|
|
947
855
|
* @param pipeline - Pipeline creation request
|
|
948
856
|
* @returns Promise that resolves with the created pipeline
|
|
949
857
|
* @throws {ApiError} if the request fails
|
|
950
858
|
*/
|
|
951
|
-
createPipeline(
|
|
859
|
+
createPipeline(workspaceId: string, pipeline: CreateWorkspacePipeline): Promise<WorkspacePipeline>;
|
|
952
860
|
/**
|
|
953
|
-
* Get pipeline details by
|
|
954
|
-
* @param
|
|
955
|
-
* @param
|
|
861
|
+
* Get pipeline details by id
|
|
862
|
+
* @param workspaceId - Workspace id
|
|
863
|
+
* @param pipelineId - Pipeline id
|
|
956
864
|
* @returns Promise that resolves with the pipeline details
|
|
957
865
|
* @throws {ApiError} if the request fails
|
|
958
866
|
*/
|
|
959
|
-
getPipeline(
|
|
867
|
+
getPipeline(workspaceId: string, pipelineId: string): Promise<WorkspacePipeline>;
|
|
960
868
|
/**
|
|
961
869
|
* Update a pipeline
|
|
962
|
-
* @param
|
|
963
|
-
* @param
|
|
870
|
+
* @param workspaceId - Workspace id
|
|
871
|
+
* @param pipelineId - Pipeline id
|
|
964
872
|
* @param updates - Pipeline update request
|
|
965
873
|
* @returns Promise that resolves with the updated pipeline
|
|
966
874
|
* @throws {ApiError} if the request fails
|
|
967
875
|
*/
|
|
968
|
-
updatePipeline(
|
|
876
|
+
updatePipeline(workspaceId: string, pipelineId: string, updates: UpdateWorkspacePipeline): Promise<WorkspacePipeline>;
|
|
969
877
|
/**
|
|
970
878
|
* Delete a pipeline
|
|
971
|
-
* @param
|
|
972
|
-
* @param
|
|
879
|
+
* @param workspaceId - Workspace id
|
|
880
|
+
* @param pipelineId - Pipeline id
|
|
973
881
|
* @returns Promise that resolves when the pipeline is deleted
|
|
974
882
|
* @throws {ApiError} if the request fails
|
|
975
883
|
*/
|
|
976
|
-
deletePipeline(
|
|
884
|
+
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
977
885
|
}
|
|
978
886
|
//#endregion
|
|
979
887
|
//#region src/services/policies.d.ts
|
|
@@ -985,45 +893,45 @@ declare class Policies {
|
|
|
985
893
|
constructor(api: ApiClient);
|
|
986
894
|
/**
|
|
987
895
|
* List policies in a workspace
|
|
988
|
-
* @param
|
|
896
|
+
* @param workspaceId - Workspace id
|
|
989
897
|
* @param query - Optional pagination parameters (limit, after)
|
|
990
898
|
* @returns Promise that resolves with a paginated list of policies
|
|
991
899
|
* @throws {ApiError} if the request fails
|
|
992
900
|
*/
|
|
993
|
-
listPolicies(
|
|
901
|
+
listPolicies(workspaceId: string, query?: CursorPagination & WorkspacePoliciesQuery): Promise<WorkspacePolicySummaryPage>;
|
|
994
902
|
/**
|
|
995
903
|
* Create a policy in a workspace
|
|
996
|
-
* @param
|
|
904
|
+
* @param workspaceId - Workspace id
|
|
997
905
|
* @param policy - Policy creation request
|
|
998
906
|
* @returns Promise that resolves with the created policy
|
|
999
907
|
* @throws {ApiError} if the request fails
|
|
1000
908
|
*/
|
|
1001
|
-
createPolicy(
|
|
909
|
+
createPolicy(workspaceId: string, policy: CreateWorkspacePolicy): Promise<WorkspacePolicy>;
|
|
1002
910
|
/**
|
|
1003
|
-
* Get policy details by
|
|
1004
|
-
* @param
|
|
1005
|
-
* @param
|
|
911
|
+
* Get policy details by id
|
|
912
|
+
* @param workspaceId - Workspace id
|
|
913
|
+
* @param policyId - Policy id
|
|
1006
914
|
* @returns Promise that resolves with the policy details
|
|
1007
915
|
* @throws {ApiError} if the request fails
|
|
1008
916
|
*/
|
|
1009
|
-
getPolicy(
|
|
917
|
+
getPolicy(workspaceId: string, policyId: string): Promise<WorkspacePolicy>;
|
|
1010
918
|
/**
|
|
1011
919
|
* Update a policy
|
|
1012
|
-
* @param
|
|
1013
|
-
* @param
|
|
920
|
+
* @param workspaceId - Workspace id
|
|
921
|
+
* @param policyId - Policy id
|
|
1014
922
|
* @param updates - Policy update request
|
|
1015
923
|
* @returns Promise that resolves with the updated policy
|
|
1016
924
|
* @throws {ApiError} if the request fails
|
|
1017
925
|
*/
|
|
1018
|
-
updatePolicy(
|
|
926
|
+
updatePolicy(workspaceId: string, policyId: string, updates: UpdateWorkspacePolicy): Promise<WorkspacePolicy>;
|
|
1019
927
|
/**
|
|
1020
928
|
* Delete a policy
|
|
1021
|
-
* @param
|
|
1022
|
-
* @param
|
|
929
|
+
* @param workspaceId - Workspace id
|
|
930
|
+
* @param policyId - Policy id
|
|
1023
931
|
* @returns Promise that resolves when the policy is deleted
|
|
1024
932
|
* @throws {ApiError} if the request fails
|
|
1025
933
|
*/
|
|
1026
|
-
deletePolicy(
|
|
934
|
+
deletePolicy(workspaceId: string, policyId: string): Promise<void>;
|
|
1027
935
|
}
|
|
1028
936
|
//#endregion
|
|
1029
937
|
//#region src/services/providers.d.ts
|
|
@@ -1037,53 +945,53 @@ declare class Providers {
|
|
|
1037
945
|
constructor(api: ApiClient);
|
|
1038
946
|
/**
|
|
1039
947
|
* List a workspace's inference providers
|
|
1040
|
-
* @param
|
|
948
|
+
* @param workspaceId - Workspace id
|
|
1041
949
|
* @param query - Optional pagination and filters (provider, limit, after)
|
|
1042
950
|
* @returns Promise that resolves with a paginated list of providers
|
|
1043
951
|
* @throws {ApiError} if the request fails
|
|
1044
952
|
*/
|
|
1045
|
-
listProviders(
|
|
953
|
+
listProviders(workspaceId: string, query?: CursorPagination & WorkspaceProvidersQuery): Promise<WorkspaceProviderPage>;
|
|
1046
954
|
/**
|
|
1047
955
|
* Create an inference provider in a workspace
|
|
1048
|
-
* @param
|
|
956
|
+
* @param workspaceId - Workspace id
|
|
1049
957
|
* @param provider - Provider creation request
|
|
1050
958
|
* @returns Promise that resolves with the created provider
|
|
1051
959
|
* @throws {ApiError} if the request fails
|
|
1052
960
|
*/
|
|
1053
|
-
createProvider(
|
|
961
|
+
createProvider(workspaceId: string, provider: CreateWorkspaceProvider): Promise<WorkspaceProvider>;
|
|
1054
962
|
/**
|
|
1055
963
|
* Get provider details by ID
|
|
1056
|
-
* @param
|
|
964
|
+
* @param workspaceId - Workspace id
|
|
1057
965
|
* @param providerId - Provider ID
|
|
1058
966
|
* @returns Promise that resolves with the provider details
|
|
1059
967
|
* @throws {ApiError} if the request fails
|
|
1060
968
|
*/
|
|
1061
|
-
getProvider(
|
|
969
|
+
getProvider(workspaceId: string, providerId: string): Promise<WorkspaceProvider>;
|
|
1062
970
|
/**
|
|
1063
971
|
* Update an inference provider
|
|
1064
|
-
* @param
|
|
972
|
+
* @param workspaceId - Workspace id
|
|
1065
973
|
* @param providerId - Provider ID
|
|
1066
974
|
* @param updates - Provider update request
|
|
1067
975
|
* @returns Promise that resolves with the updated provider
|
|
1068
976
|
* @throws {ApiError} if the request fails
|
|
1069
977
|
*/
|
|
1070
|
-
updateProvider(
|
|
978
|
+
updateProvider(workspaceId: string, providerId: string, updates: UpdateWorkspaceProvider): Promise<WorkspaceProvider>;
|
|
1071
979
|
/**
|
|
1072
980
|
* Delete an inference provider
|
|
1073
|
-
* @param
|
|
981
|
+
* @param workspaceId - Workspace id
|
|
1074
982
|
* @param providerId - Provider ID
|
|
1075
983
|
* @returns Promise that resolves when the provider is deleted
|
|
1076
984
|
* @throws {ApiError} if the request fails
|
|
1077
985
|
*/
|
|
1078
|
-
deleteProvider(
|
|
986
|
+
deleteProvider(workspaceId: string, providerId: string): Promise<void>;
|
|
1079
987
|
/**
|
|
1080
988
|
* Verify an inference provider's configuration and credentials
|
|
1081
|
-
* @param
|
|
989
|
+
* @param workspaceId - Workspace id
|
|
1082
990
|
* @param providerId - Provider ID
|
|
1083
991
|
* @returns Promise that resolves with the verification result
|
|
1084
992
|
* @throws {ApiError} if the request fails
|
|
1085
993
|
*/
|
|
1086
|
-
verifyProvider(
|
|
994
|
+
verifyProvider(workspaceId: string, providerId: string): Promise<WorkspaceConnectionVerification>;
|
|
1087
995
|
}
|
|
1088
996
|
//#endregion
|
|
1089
997
|
//#region src/services/redactions.d.ts
|
|
@@ -1096,12 +1004,12 @@ declare class Redactions {
|
|
|
1096
1004
|
constructor(api: ApiClient);
|
|
1097
1005
|
/**
|
|
1098
1006
|
* Get a redaction's review audit
|
|
1099
|
-
* @param
|
|
1007
|
+
* @param workspaceId - Workspace id
|
|
1100
1008
|
* @param redactionId - Redaction ID
|
|
1101
1009
|
* @returns Promise that resolves with the audit
|
|
1102
1010
|
* @throws {ApiError} if the request fails
|
|
1103
1011
|
*/
|
|
1104
|
-
getReview(
|
|
1012
|
+
getReview(workspaceId: string, redactionId: string): Promise<Audit>;
|
|
1105
1013
|
}
|
|
1106
1014
|
//#endregion
|
|
1107
1015
|
//#region src/services/status.d.ts
|
|
@@ -1112,10 +1020,32 @@ declare class Status {
|
|
|
1112
1020
|
#private;
|
|
1113
1021
|
constructor(api: ApiClient);
|
|
1114
1022
|
/**
|
|
1115
|
-
* Check the health status of the API
|
|
1023
|
+
* Check the health status of the API.
|
|
1024
|
+
*
|
|
1025
|
+
* Reports the server's health and that of its dependencies. Returns `Health`
|
|
1026
|
+
* for both the healthy/degraded (200) and unhealthy (503) cases.
|
|
1027
|
+
*
|
|
1116
1028
|
* @returns Promise that resolves with the API health status
|
|
1117
1029
|
*/
|
|
1118
1030
|
checkHealth(): Promise<Health>;
|
|
1031
|
+
/**
|
|
1032
|
+
* Liveness probe: resolves if the process is running. Probes no dependencies.
|
|
1033
|
+
*
|
|
1034
|
+
* Returns the raw `Response` (the endpoint has no body); a non-2xx status
|
|
1035
|
+
* throws via the error middleware.
|
|
1036
|
+
*
|
|
1037
|
+
* @returns Promise that resolves with the probe response
|
|
1038
|
+
* @throws {ApiError} if the process is not live
|
|
1039
|
+
*/
|
|
1040
|
+
checkLiveness(): Promise<Response>;
|
|
1041
|
+
/**
|
|
1042
|
+
* Readiness probe: reports the server's health and that of its dependencies,
|
|
1043
|
+
* served from a short-lived cache. Returns `Health` for both the
|
|
1044
|
+
* healthy/degraded (200) and unhealthy (503) cases. Safe to poll frequently.
|
|
1045
|
+
*
|
|
1046
|
+
* @returns Promise that resolves with the API health status
|
|
1047
|
+
*/
|
|
1048
|
+
checkReadiness(): Promise<Health>;
|
|
1119
1049
|
}
|
|
1120
1050
|
//#endregion
|
|
1121
1051
|
//#region src/services/syncs.d.ts
|
|
@@ -1127,15 +1057,15 @@ declare class Syncs {
|
|
|
1127
1057
|
constructor(api: ApiClient);
|
|
1128
1058
|
/**
|
|
1129
1059
|
* List all syncs across a workspace's connections
|
|
1130
|
-
* @param
|
|
1060
|
+
* @param workspaceId - Workspace id
|
|
1131
1061
|
* @param query - Optional query parameters (provider, status, limit, after)
|
|
1132
1062
|
* @returns Promise that resolves with a paginated list of connection syncs
|
|
1133
1063
|
* @throws {ApiError} if the request fails
|
|
1134
1064
|
*/
|
|
1135
|
-
listWorkspaceSyncs(
|
|
1065
|
+
listWorkspaceSyncs(workspaceId: string, query?: CursorPagination & {
|
|
1136
1066
|
provider?: string[];
|
|
1137
1067
|
status?: SyncStatus;
|
|
1138
|
-
}): Promise<
|
|
1068
|
+
}): Promise<WorkspaceConnectionSyncPage>;
|
|
1139
1069
|
/**
|
|
1140
1070
|
* Start a sync for an object-store connection.
|
|
1141
1071
|
*
|
|
@@ -1144,39 +1074,132 @@ declare class Syncs {
|
|
|
1144
1074
|
* use {@link Connections.importFiles} and {@link Connections.exportFiles}
|
|
1145
1075
|
* instead. Returns the created sync — poll it for completion.
|
|
1146
1076
|
*
|
|
1147
|
-
* @param
|
|
1077
|
+
* @param workspaceId - Workspace id
|
|
1148
1078
|
* @param connectionId - Connection ID
|
|
1149
1079
|
* @returns Promise that resolves with the started connection sync
|
|
1150
1080
|
* @throws {ApiError} if the request fails
|
|
1151
1081
|
*/
|
|
1152
|
-
startSync(
|
|
1082
|
+
startSync(workspaceId: string, connectionId: string): Promise<WorkspaceConnectionSync>;
|
|
1153
1083
|
/**
|
|
1154
1084
|
* List syncs for a connection
|
|
1155
|
-
* @param
|
|
1085
|
+
* @param workspaceId - Workspace id
|
|
1156
1086
|
* @param connectionId - Connection ID
|
|
1157
1087
|
* @param query - Optional pagination parameters (limit, after)
|
|
1158
1088
|
* @returns Promise that resolves with a paginated list of connection syncs
|
|
1159
1089
|
* @throws {ApiError} if the request fails
|
|
1160
1090
|
*/
|
|
1161
|
-
listSyncs(
|
|
1091
|
+
listSyncs(workspaceId: string, connectionId: string, query?: CursorPagination): Promise<WorkspaceConnectionSyncPage>;
|
|
1162
1092
|
/**
|
|
1163
1093
|
* Get a connection sync by ID
|
|
1164
|
-
* @param
|
|
1094
|
+
* @param workspaceId - Workspace id
|
|
1165
1095
|
* @param connectionId - Connection ID
|
|
1166
1096
|
* @param syncId - Sync ID
|
|
1167
1097
|
* @returns Promise that resolves with the connection sync details
|
|
1168
1098
|
* @throws {ApiError} if the request fails
|
|
1169
1099
|
*/
|
|
1170
|
-
getSync(
|
|
1100
|
+
getSync(workspaceId: string, connectionId: string, syncId: string): Promise<WorkspaceConnectionSync>;
|
|
1171
1101
|
/**
|
|
1172
1102
|
* Cancel a running connection sync
|
|
1173
|
-
* @param
|
|
1103
|
+
* @param workspaceId - Workspace id
|
|
1174
1104
|
* @param connectionId - Connection ID
|
|
1175
1105
|
* @param syncId - Sync ID
|
|
1176
1106
|
* @returns Promise that resolves with the canceled connection sync
|
|
1177
1107
|
* @throws {ApiError} if the request fails
|
|
1178
1108
|
*/
|
|
1179
|
-
cancelSync(
|
|
1109
|
+
cancelSync(workspaceId: string, connectionId: string, syncId: string): Promise<WorkspaceConnectionSync>;
|
|
1110
|
+
}
|
|
1111
|
+
//#endregion
|
|
1112
|
+
//#region src/services/threads.d.ts
|
|
1113
|
+
/**
|
|
1114
|
+
* Service for discussion threads and the comments within them.
|
|
1115
|
+
*/
|
|
1116
|
+
declare class Threads {
|
|
1117
|
+
#private;
|
|
1118
|
+
constructor(api: ApiClient);
|
|
1119
|
+
/**
|
|
1120
|
+
* List a workspace's threads
|
|
1121
|
+
* @param workspaceId - Workspace id
|
|
1122
|
+
* @param query - Optional pagination and filters (status, limit, after)
|
|
1123
|
+
* @returns Promise that resolves with a paginated list of threads
|
|
1124
|
+
* @throws {ApiError} if the request fails
|
|
1125
|
+
*/
|
|
1126
|
+
listThreads(workspaceId: string, query?: CursorPagination & WorkspaceThreadsQuery): Promise<WorkspaceThreadPage>;
|
|
1127
|
+
/**
|
|
1128
|
+
* Open a new thread in a workspace
|
|
1129
|
+
* @param workspaceId - Workspace id
|
|
1130
|
+
* @param thread - Thread creation request
|
|
1131
|
+
* @returns Promise that resolves with the created thread
|
|
1132
|
+
* @throws {ApiError} if the request fails
|
|
1133
|
+
*/
|
|
1134
|
+
openThread(workspaceId: string, thread: OpenWorkspaceThread): Promise<WorkspaceThread>;
|
|
1135
|
+
/**
|
|
1136
|
+
* Rename a thread
|
|
1137
|
+
* @param workspaceId - Workspace id
|
|
1138
|
+
* @param threadId - Thread ID
|
|
1139
|
+
* @param updates - Thread rename request
|
|
1140
|
+
* @returns Promise that resolves with the updated thread
|
|
1141
|
+
* @throws {ApiError} if the request fails
|
|
1142
|
+
*/
|
|
1143
|
+
renameThread(workspaceId: string, threadId: string, updates: RenameWorkspaceThread): Promise<WorkspaceThread>;
|
|
1144
|
+
/**
|
|
1145
|
+
* Delete a thread
|
|
1146
|
+
* @param workspaceId - Workspace id
|
|
1147
|
+
* @param threadId - Thread ID
|
|
1148
|
+
* @returns Promise that resolves when the thread is deleted
|
|
1149
|
+
* @throws {ApiError} if the request fails
|
|
1150
|
+
*/
|
|
1151
|
+
deleteThread(workspaceId: string, threadId: string): Promise<void>;
|
|
1152
|
+
/**
|
|
1153
|
+
* Close a thread, ending the discussion.
|
|
1154
|
+
* @param workspaceId - Workspace id
|
|
1155
|
+
* @param threadId - Thread ID
|
|
1156
|
+
* @returns Promise that resolves with the closed thread
|
|
1157
|
+
* @throws {ApiError} if the request fails
|
|
1158
|
+
*/
|
|
1159
|
+
closeThread(workspaceId: string, threadId: string): Promise<WorkspaceThread>;
|
|
1160
|
+
/**
|
|
1161
|
+
* Reopen a closed thread.
|
|
1162
|
+
* @param workspaceId - Workspace id
|
|
1163
|
+
* @param threadId - Thread ID
|
|
1164
|
+
* @returns Promise that resolves with the reopened thread
|
|
1165
|
+
* @throws {ApiError} if the request fails
|
|
1166
|
+
*/
|
|
1167
|
+
reopenThread(workspaceId: string, threadId: string): Promise<WorkspaceThread>;
|
|
1168
|
+
/**
|
|
1169
|
+
* List a thread's timeline: comments interleaved with lifecycle events.
|
|
1170
|
+
* @param workspaceId - Workspace id
|
|
1171
|
+
* @param threadId - Thread ID
|
|
1172
|
+
* @param query - Optional pagination parameters (limit, after)
|
|
1173
|
+
* @returns Promise that resolves with a paginated timeline
|
|
1174
|
+
* @throws {ApiError} if the request fails
|
|
1175
|
+
*/
|
|
1176
|
+
listTimeline(workspaceId: string, threadId: string, query?: CursorPagination): Promise<WorkspaceThreadEntryPage>;
|
|
1177
|
+
/**
|
|
1178
|
+
* Post a comment to a thread
|
|
1179
|
+
* @param workspaceId - Workspace id
|
|
1180
|
+
* @param threadId - Thread ID
|
|
1181
|
+
* @param comment - Comment creation request
|
|
1182
|
+
* @returns Promise that resolves with the created comment
|
|
1183
|
+
* @throws {ApiError} if the request fails
|
|
1184
|
+
*/
|
|
1185
|
+
createComment(workspaceId: string, threadId: string, comment: CreateWorkspaceComment): Promise<WorkspaceComment>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Edit a comment
|
|
1188
|
+
* @param workspaceId - Workspace id
|
|
1189
|
+
* @param commentId - Comment ID
|
|
1190
|
+
* @param updates - Comment update request
|
|
1191
|
+
* @returns Promise that resolves with the updated comment
|
|
1192
|
+
* @throws {ApiError} if the request fails
|
|
1193
|
+
*/
|
|
1194
|
+
updateComment(workspaceId: string, commentId: string, updates: UpdateWorkspaceComment): Promise<WorkspaceComment>;
|
|
1195
|
+
/**
|
|
1196
|
+
* Delete a comment
|
|
1197
|
+
* @param workspaceId - Workspace id
|
|
1198
|
+
* @param commentId - Comment ID
|
|
1199
|
+
* @returns Promise that resolves when the comment is deleted
|
|
1200
|
+
* @throws {ApiError} if the request fails
|
|
1201
|
+
*/
|
|
1202
|
+
deleteComment(workspaceId: string, commentId: string): Promise<void>;
|
|
1180
1203
|
}
|
|
1181
1204
|
//#endregion
|
|
1182
1205
|
//#region src/services/webhooks.d.ts
|
|
@@ -1188,54 +1211,54 @@ declare class Webhooks {
|
|
|
1188
1211
|
constructor(api: ApiClient);
|
|
1189
1212
|
/**
|
|
1190
1213
|
* List all webhooks in a workspace
|
|
1191
|
-
* @param
|
|
1214
|
+
* @param workspaceId - Workspace id
|
|
1192
1215
|
* @param query - Optional pagination parameters (limit, after)
|
|
1193
1216
|
* @returns Promise that resolves with a paginated list of webhooks
|
|
1194
1217
|
* @throws {ApiError} if the request fails
|
|
1195
1218
|
*/
|
|
1196
|
-
listWebhooks(
|
|
1219
|
+
listWebhooks(workspaceId: string, query?: CursorPagination): Promise<WorkspaceWebhookPage>;
|
|
1197
1220
|
/**
|
|
1198
1221
|
* Create a new webhook
|
|
1199
|
-
* @param
|
|
1222
|
+
* @param workspaceId - Workspace id
|
|
1200
1223
|
* @param webhook - Webhook creation request
|
|
1201
1224
|
* @returns Promise that resolves with the created webhook (including secret)
|
|
1202
1225
|
* @throws {ApiError} if the request fails
|
|
1203
1226
|
*/
|
|
1204
|
-
createWebhook(
|
|
1227
|
+
createWebhook(workspaceId: string, webhook: CreateWorkspaceWebhook): Promise<WorkspaceWebhookCreated>;
|
|
1205
1228
|
/**
|
|
1206
|
-
* Get a specific webhook by
|
|
1207
|
-
* @param
|
|
1229
|
+
* Get a specific webhook by id
|
|
1230
|
+
* @param workspaceId - Workspace id
|
|
1208
1231
|
* @param webhookId - Webhook ID
|
|
1209
1232
|
* @returns Promise that resolves with the webhook details
|
|
1210
1233
|
* @throws {ApiError} if the request fails
|
|
1211
1234
|
*/
|
|
1212
|
-
getWebhook(
|
|
1235
|
+
getWebhook(workspaceId: string, webhookId: string): Promise<WorkspaceWebhook>;
|
|
1213
1236
|
/**
|
|
1214
1237
|
* Update an existing webhook
|
|
1215
|
-
* @param
|
|
1238
|
+
* @param workspaceId - Workspace id
|
|
1216
1239
|
* @param webhookId - Webhook ID
|
|
1217
1240
|
* @param updates - Webhook update request
|
|
1218
1241
|
* @returns Promise that resolves with the updated webhook
|
|
1219
1242
|
* @throws {ApiError} if the request fails
|
|
1220
1243
|
*/
|
|
1221
|
-
updateWebhook(
|
|
1244
|
+
updateWebhook(workspaceId: string, webhookId: string, updates: UpdateWorkspaceWebhook): Promise<WorkspaceWebhook>;
|
|
1222
1245
|
/**
|
|
1223
1246
|
* Delete a webhook
|
|
1224
|
-
* @param
|
|
1247
|
+
* @param workspaceId - Workspace id
|
|
1225
1248
|
* @param webhookId - Webhook ID
|
|
1226
1249
|
* @returns Promise that resolves when the webhook is deleted
|
|
1227
1250
|
* @throws {ApiError} if the request fails
|
|
1228
1251
|
*/
|
|
1229
|
-
deleteWebhook(
|
|
1252
|
+
deleteWebhook(workspaceId: string, webhookId: string): Promise<void>;
|
|
1230
1253
|
/**
|
|
1231
1254
|
* Test a webhook by sending a test payload
|
|
1232
|
-
* @param
|
|
1255
|
+
* @param workspaceId - Workspace id
|
|
1233
1256
|
* @param webhookId - Webhook ID
|
|
1234
1257
|
* @param options - Test webhook options
|
|
1235
1258
|
* @returns Promise that resolves with the test result
|
|
1236
1259
|
* @throws {ApiError} if the request fails
|
|
1237
1260
|
*/
|
|
1238
|
-
testWebhook(
|
|
1261
|
+
testWebhook(workspaceId: string, webhookId: string, options?: TestWorkspaceWebhook): Promise<WorkspaceWebhookResult>;
|
|
1239
1262
|
}
|
|
1240
1263
|
//#endregion
|
|
1241
1264
|
//#region src/services/workspaces.d.ts
|
|
@@ -1254,11 +1277,11 @@ declare class Workspaces {
|
|
|
1254
1277
|
listWorkspaces(query?: CursorPagination): Promise<WorkspacePage>;
|
|
1255
1278
|
/**
|
|
1256
1279
|
* Get workspace details by ID
|
|
1257
|
-
* @param
|
|
1280
|
+
* @param workspaceId - Workspace id
|
|
1258
1281
|
* @returns Promise that resolves with the workspace details
|
|
1259
1282
|
* @throws {ApiError} if the request fails
|
|
1260
1283
|
*/
|
|
1261
|
-
getWorkspace(
|
|
1284
|
+
getWorkspace(workspaceId: string): Promise<Workspace>;
|
|
1262
1285
|
/**
|
|
1263
1286
|
* Create a new workspace
|
|
1264
1287
|
* @param workspace - Workspace creation request
|
|
@@ -1268,49 +1291,49 @@ declare class Workspaces {
|
|
|
1268
1291
|
createWorkspace(workspace: CreateWorkspace): Promise<Workspace>;
|
|
1269
1292
|
/**
|
|
1270
1293
|
* Update an existing workspace
|
|
1271
|
-
* @param
|
|
1294
|
+
* @param workspaceId - Workspace id
|
|
1272
1295
|
* @param updates - Workspace update request
|
|
1273
1296
|
* @returns Promise that resolves with the updated workspace
|
|
1274
1297
|
* @throws {ApiError} if the request fails
|
|
1275
1298
|
*/
|
|
1276
|
-
updateWorkspace(
|
|
1299
|
+
updateWorkspace(workspaceId: string, updates: UpdateWorkspace): Promise<Workspace>;
|
|
1277
1300
|
/**
|
|
1278
1301
|
* Delete a workspace
|
|
1279
|
-
* @param
|
|
1302
|
+
* @param workspaceId - Workspace id
|
|
1280
1303
|
* @returns Promise that resolves when the workspace is deleted
|
|
1281
1304
|
* @throws {ApiError} if the request fails
|
|
1282
1305
|
*/
|
|
1283
|
-
deleteWorkspace(
|
|
1306
|
+
deleteWorkspace(workspaceId: string): Promise<void>;
|
|
1284
1307
|
/**
|
|
1285
1308
|
* Get notification settings for the authenticated user in a workspace
|
|
1286
|
-
* @param
|
|
1309
|
+
* @param workspaceId - Workspace id
|
|
1287
1310
|
* @returns Promise that resolves with the notification settings
|
|
1288
1311
|
* @throws {ApiError} if the request fails
|
|
1289
1312
|
*/
|
|
1290
|
-
getNotificationSettings(
|
|
1313
|
+
getNotificationSettings(workspaceId: string): Promise<WorkspaceNotificationSettings>;
|
|
1291
1314
|
/**
|
|
1292
1315
|
* Update notification settings for the authenticated user in a workspace
|
|
1293
|
-
* @param
|
|
1316
|
+
* @param workspaceId - Workspace id
|
|
1294
1317
|
* @param settings - Notification settings update request
|
|
1295
1318
|
* @returns Promise that resolves with the updated notification settings
|
|
1296
1319
|
* @throws {ApiError} if the request fails
|
|
1297
1320
|
*/
|
|
1298
|
-
updateNotificationSettings(
|
|
1321
|
+
updateNotificationSettings(workspaceId: string, settings: UpdateWorkspaceNotificationSettings): Promise<WorkspaceNotificationSettings>;
|
|
1299
1322
|
/**
|
|
1300
1323
|
* Upload a workspace's avatar image
|
|
1301
|
-
* @param
|
|
1324
|
+
* @param workspaceId - Workspace id
|
|
1302
1325
|
* @param avatar - Avatar image to upload
|
|
1303
1326
|
* @returns Promise that resolves when the avatar is uploaded
|
|
1304
1327
|
* @throws {ApiError} if the request fails
|
|
1305
1328
|
*/
|
|
1306
|
-
uploadAvatar(
|
|
1329
|
+
uploadAvatar(workspaceId: string, avatar: Blob): Promise<void>;
|
|
1307
1330
|
/**
|
|
1308
1331
|
* Delete a workspace's avatar image
|
|
1309
|
-
* @param
|
|
1332
|
+
* @param workspaceId - Workspace id
|
|
1310
1333
|
* @returns Promise that resolves when the avatar is deleted
|
|
1311
1334
|
* @throws {ApiError} if the request fails
|
|
1312
1335
|
*/
|
|
1313
|
-
deleteAvatar(
|
|
1336
|
+
deleteAvatar(workspaceId: string): Promise<void>;
|
|
1314
1337
|
}
|
|
1315
1338
|
//#endregion
|
|
1316
1339
|
//#region src/client.d.ts
|
|
@@ -1411,26 +1434,22 @@ declare class Nvisy {
|
|
|
1411
1434
|
* Service for workspace analytics.
|
|
1412
1435
|
*/
|
|
1413
1436
|
get analytics(): Analytics;
|
|
1414
|
-
/**
|
|
1415
|
-
* Service for the workspace assistant chat.
|
|
1416
|
-
*/
|
|
1417
|
-
get chat(): Chat;
|
|
1418
1437
|
/**
|
|
1419
1438
|
* Service for managing API tokens.
|
|
1420
1439
|
*/
|
|
1421
1440
|
get apiTokens(): ApiTokens;
|
|
1422
|
-
/**
|
|
1423
|
-
* Service for file assignments (assigning files to reviewers).
|
|
1424
|
-
*/
|
|
1425
|
-
get assignments(): Assignments;
|
|
1426
1441
|
/**
|
|
1427
1442
|
* Service for managing connections.
|
|
1428
1443
|
*/
|
|
1429
1444
|
get connections(): Connections;
|
|
1430
1445
|
/**
|
|
1431
|
-
* Service for
|
|
1446
|
+
* Service for document operations (upload, download, delete, review).
|
|
1447
|
+
*/
|
|
1448
|
+
get documents(): Documents;
|
|
1449
|
+
/**
|
|
1450
|
+
* Service for discussion threads and comments.
|
|
1432
1451
|
*/
|
|
1433
|
-
get
|
|
1452
|
+
get threads(): Threads;
|
|
1434
1453
|
/**
|
|
1435
1454
|
* Service for managing pipelines.
|
|
1436
1455
|
*/
|
|
@@ -1444,9 +1463,10 @@ declare class Nvisy {
|
|
|
1444
1463
|
*/
|
|
1445
1464
|
get providers(): Providers;
|
|
1446
1465
|
/**
|
|
1447
|
-
* Service for reading the deployment's
|
|
1466
|
+
* Service for reading the deployment's capabilities (labels, recognizers,
|
|
1467
|
+
* connectors, auth methods).
|
|
1448
1468
|
*/
|
|
1449
|
-
get
|
|
1469
|
+
get capabilities(): Capabilities;
|
|
1450
1470
|
/**
|
|
1451
1471
|
* Service for managing workspace invitations.
|
|
1452
1472
|
*/
|
|
@@ -1481,5 +1501,5 @@ declare class Nvisy {
|
|
|
1481
1501
|
get workspaces(): Workspaces;
|
|
1482
1502
|
}
|
|
1483
1503
|
//#endregion
|
|
1484
|
-
export {
|
|
1485
|
-
//# sourceMappingURL=client-
|
|
1504
|
+
export { Account as C, Activities as S, Connections as _, Threads as a, ApiTokens as b, Redactions as c, Pipelines as d, Notifications as f, Detections as g, Documents as h, Webhooks as i, Providers as l, Invites as m, Nvisy as n, Syncs as o, Members as p, Workspaces as r, Status as s, ApiClient as t, Policies as u, Capabilities as v, Analytics as x, Auth as y };
|
|
1505
|
+
//# sourceMappingURL=client-CSxuXX5e.d.ts.map
|