@nvisy/sdk 0.49.0 → 0.51.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 +88 -1
- package/dist/{client-BEpBVGGP.d.ts → client-SotZfT6b.d.ts} +354 -299
- package/dist/client-SotZfT6b.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{error-DNeyT0Z7.js → error-DTQ8nnQc.js} +3 -3
- package/dist/{error-DNeyT0Z7.js.map → error-DTQ8nnQc.js.map} +1 -1
- package/dist/{errors-DzQz1HIR.d.ts → errors-ClHc4LMK.d.ts} +2 -12
- package/dist/errors-ClHc4LMK.d.ts.map +1 -0
- package/dist/{errors-BOLD8iC1.js → errors-D2J3LbE-.js} +2 -16
- package/dist/errors-D2J3LbE-.js.map +1 -0
- package/dist/{index-CNUnM9QG.d.ts → index-BxYFvgTy.d.ts} +12471 -9723
- package/dist/index-BxYFvgTy.d.ts.map +1 -0
- package/dist/index.d.ts +3 -3
- package/dist/index.js +16 -15
- 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-COhgjbsy.js → services-CFFmQDgA.js} +657 -547
- package/dist/services-CFFmQDgA.js.map +1 -0
- package/dist/standalone/index.d.ts +1 -1
- package/dist/standalone/index.js +1 -1
- package/dist/webhooks/index.d.ts +2 -2
- package/dist/webhooks/index.js +1 -1
- package/package.json +1 -1
- package/dist/client-BEpBVGGP.d.ts.map +0 -1
- package/dist/errors-BOLD8iC1.js.map +0 -1
- package/dist/errors-DzQz1HIR.d.ts.map +0 -1
- package/dist/index-CNUnM9QG.d.ts.map +0 -1
- package/dist/services-COhgjbsy.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-BxYFvgTy.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
|
|
@@ -279,15 +279,16 @@ declare class Auth {
|
|
|
279
279
|
* @returns Promise that resolves with the minted token and redirect URI
|
|
280
280
|
* @throws {ApiError} if the request fails
|
|
281
281
|
*/
|
|
282
|
-
mintDesktopToken(request: DesktopTokenRequest): Promise<
|
|
282
|
+
mintDesktopToken(request: DesktopTokenRequest): Promise<AccountDesktopToken>;
|
|
283
283
|
}
|
|
284
284
|
//#endregion
|
|
285
|
-
//#region src/services/
|
|
285
|
+
//#region src/services/capabilities.d.ts
|
|
286
286
|
/**
|
|
287
|
-
* Service for reading the deployment's
|
|
288
|
-
*
|
|
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.
|
|
289
290
|
*/
|
|
290
|
-
declare class
|
|
291
|
+
declare class Capabilities {
|
|
291
292
|
#private;
|
|
292
293
|
constructor(api: ApiClient);
|
|
293
294
|
/**
|
|
@@ -308,79 +309,14 @@ declare class Catalog {
|
|
|
308
309
|
* credentials and are always available. Use it to render the connect UI
|
|
309
310
|
* without probing.
|
|
310
311
|
*
|
|
311
|
-
* @returns Promise that resolves with the connector
|
|
312
|
+
* @returns Promise that resolves with the connector capabilities.
|
|
312
313
|
*/
|
|
313
|
-
listConnectors(): Promise<
|
|
314
|
-
}
|
|
315
|
-
//#endregion
|
|
316
|
-
//#region src/services/chat.d.ts
|
|
317
|
-
/**
|
|
318
|
-
* Service for the workspace assistant chat: sessions and streamed messages.
|
|
319
|
-
*/
|
|
320
|
-
declare class Chat {
|
|
321
|
-
#private;
|
|
322
|
-
constructor(api: ApiClient);
|
|
323
|
-
/**
|
|
324
|
-
* List the workspace's chat sessions, most recently active first.
|
|
325
|
-
* @param workspaceSlug - Workspace slug
|
|
326
|
-
* @param query - Optional pagination (limit, after)
|
|
327
|
-
* @returns Promise that resolves with a paginated list of chat sessions
|
|
328
|
-
* @throws {ApiError} if the request fails
|
|
329
|
-
*/
|
|
330
|
-
listSessions(workspaceSlug: string, query?: CursorPagination): Promise<ChatSessionPage>;
|
|
331
|
-
/**
|
|
332
|
-
* Open a new assistant chat session in the workspace.
|
|
333
|
-
* @param workspaceSlug - Workspace slug
|
|
334
|
-
* @param session - Session creation request
|
|
335
|
-
* @returns Promise that resolves with the created chat session
|
|
336
|
-
* @throws {ApiError} if the request fails
|
|
337
|
-
*/
|
|
338
|
-
createSession(workspaceSlug: string, session: CreateChatSession): Promise<ChatSession>;
|
|
339
|
-
/**
|
|
340
|
-
* Soft-delete a chat session.
|
|
341
|
-
* @param workspaceSlug - Workspace slug
|
|
342
|
-
* @param sessionId - Session ID
|
|
343
|
-
* @throws {ApiError} if the request fails
|
|
344
|
-
*/
|
|
345
|
-
deleteSession(workspaceSlug: string, sessionId: string): Promise<void>;
|
|
346
|
-
/**
|
|
347
|
-
* List a session's messages in chronological order.
|
|
348
|
-
* @param workspaceSlug - Workspace slug
|
|
349
|
-
* @param sessionId - Session ID
|
|
350
|
-
* @returns Promise that resolves with the session's messages
|
|
351
|
-
* @throws {ApiError} if the request fails
|
|
352
|
-
*/
|
|
353
|
-
listMessages(workspaceSlug: string, sessionId: string): Promise<ChatMessage[]>;
|
|
354
|
-
/**
|
|
355
|
-
* Open the raw Server-Sent Events stream of the assistant's reply.
|
|
356
|
-
*
|
|
357
|
-
* Returns the underlying `Response` so callers can handle the
|
|
358
|
-
* `text/event-stream` body themselves. Most callers want
|
|
359
|
-
* {@link streamMessage}, which parses each frame into a typed
|
|
360
|
-
* {@link ChatToken}.
|
|
361
|
-
*
|
|
362
|
-
* @param workspaceSlug - Workspace slug
|
|
363
|
-
* @param sessionId - Session ID
|
|
364
|
-
* @param message - The message to send
|
|
365
|
-
* @returns Promise that resolves with the event-stream response
|
|
366
|
-
* @throws {ApiError} if the request fails
|
|
367
|
-
*/
|
|
368
|
-
sendMessage(workspaceSlug: string, sessionId: string, message: SendChatMessage): Promise<Response>;
|
|
314
|
+
listConnectors(): Promise<ConnectorCapabilities>;
|
|
369
315
|
/**
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
* Yields each {@link ChatToken} delta as it arrives, until the reply ends.
|
|
373
|
-
* Break out of the loop to stop reading. For the raw response, use
|
|
374
|
-
* {@link sendMessage}.
|
|
375
|
-
*
|
|
376
|
-
* @param workspaceSlug - Workspace slug
|
|
377
|
-
* @param sessionId - Session ID
|
|
378
|
-
* @param message - The message to send
|
|
379
|
-
* @yields each {@link ChatToken} delta as it arrives
|
|
380
|
-
* @throws {ApiError} if the request fails to open
|
|
381
|
-
* @throws {NvisyError} if the response has no readable body
|
|
316
|
+
* List which authentication methods this deployment offers.
|
|
317
|
+
* @returns Promise that resolves with the auth capabilities.
|
|
382
318
|
*/
|
|
383
|
-
|
|
319
|
+
getAuthCapabilities(): Promise<AuthCapabilities>;
|
|
384
320
|
}
|
|
385
321
|
//#endregion
|
|
386
322
|
//#region src/services/connections.d.ts
|
|
@@ -392,55 +328,55 @@ declare class Connections {
|
|
|
392
328
|
constructor(api: ApiClient);
|
|
393
329
|
/**
|
|
394
330
|
* List connections in a workspace
|
|
395
|
-
* @param
|
|
331
|
+
* @param workspaceId - Workspace id
|
|
396
332
|
* @param query - Optional query parameters (provider, limit, after)
|
|
397
333
|
* @returns Promise that resolves with a paginated list of connections
|
|
398
334
|
* @throws {ApiError} if the request fails
|
|
399
335
|
*/
|
|
400
|
-
listConnections(
|
|
336
|
+
listConnections(workspaceId: string, query?: CursorPagination & {
|
|
401
337
|
provider?: string[];
|
|
402
|
-
}): Promise<
|
|
338
|
+
}): Promise<WorkspaceConnectionPage>;
|
|
403
339
|
/**
|
|
404
340
|
* Create a connection in a workspace
|
|
405
|
-
* @param
|
|
341
|
+
* @param workspaceId - Workspace id
|
|
406
342
|
* @param connection - Connection creation request
|
|
407
343
|
* @returns Promise that resolves with the created connection
|
|
408
344
|
* @throws {ApiError} if the request fails
|
|
409
345
|
*/
|
|
410
|
-
createConnection(
|
|
346
|
+
createConnection(workspaceId: string, connection: CreateWorkspaceConnection): Promise<WorkspaceConnection>;
|
|
411
347
|
/**
|
|
412
348
|
* Get connection details by ID
|
|
413
|
-
* @param
|
|
349
|
+
* @param workspaceId - Workspace id
|
|
414
350
|
* @param connectionId - Connection ID
|
|
415
351
|
* @returns Promise that resolves with the connection details
|
|
416
352
|
* @throws {ApiError} if the request fails
|
|
417
353
|
*/
|
|
418
|
-
getConnection(
|
|
354
|
+
getConnection(workspaceId: string, connectionId: string): Promise<WorkspaceConnection>;
|
|
419
355
|
/**
|
|
420
356
|
* Update a connection
|
|
421
|
-
* @param
|
|
357
|
+
* @param workspaceId - Workspace id
|
|
422
358
|
* @param connectionId - Connection ID
|
|
423
359
|
* @param updates - Connection update request
|
|
424
360
|
* @returns Promise that resolves with the updated connection
|
|
425
361
|
* @throws {ApiError} if the request fails
|
|
426
362
|
*/
|
|
427
|
-
updateConnection(
|
|
363
|
+
updateConnection(workspaceId: string, connectionId: string, updates: UpdateWorkspaceConnection): Promise<WorkspaceConnection>;
|
|
428
364
|
/**
|
|
429
365
|
* Delete a connection
|
|
430
|
-
* @param
|
|
366
|
+
* @param workspaceId - Workspace id
|
|
431
367
|
* @param connectionId - Connection ID
|
|
432
368
|
* @returns Promise that resolves when the connection is deleted
|
|
433
369
|
* @throws {ApiError} if the request fails
|
|
434
370
|
*/
|
|
435
|
-
deleteConnection(
|
|
371
|
+
deleteConnection(workspaceId: string, connectionId: string): Promise<void>;
|
|
436
372
|
/**
|
|
437
373
|
* Verify a connection's configuration and credentials
|
|
438
|
-
* @param
|
|
374
|
+
* @param workspaceId - Workspace id
|
|
439
375
|
* @param connectionId - Connection ID
|
|
440
376
|
* @returns Promise that resolves with the verification result
|
|
441
377
|
* @throws {ApiError} if the request fails
|
|
442
378
|
*/
|
|
443
|
-
verifyConnection(
|
|
379
|
+
verifyConnection(workspaceId: string, connectionId: string): Promise<WorkspaceConnectionVerification>;
|
|
444
380
|
/**
|
|
445
381
|
* Start the OAuth flow to connect a file-service provider.
|
|
446
382
|
*
|
|
@@ -448,13 +384,13 @@ declare class Connections {
|
|
|
448
384
|
* provider redirects back and the connection is created. Navigate the
|
|
449
385
|
* browser to the URL (a full-page redirect, not a fetch) to continue.
|
|
450
386
|
*
|
|
451
|
-
* @param
|
|
387
|
+
* @param workspaceId - Workspace id
|
|
452
388
|
* @param provider - The file-service provider to connect
|
|
453
389
|
* @param request - Display name for the connection and optional sync root
|
|
454
390
|
* @returns Promise that resolves with the provider authorize URL
|
|
455
391
|
* @throws {ApiError} if the request fails
|
|
456
392
|
*/
|
|
457
|
-
startFileServiceOAuth(
|
|
393
|
+
startFileServiceOAuth(workspaceId: string, provider: FileServiceProvider, request: StartFileServiceOAuth): Promise<OAuthStartResponse>;
|
|
458
394
|
/**
|
|
459
395
|
* Import picker-selected files from a file-service connection.
|
|
460
396
|
*
|
|
@@ -462,13 +398,13 @@ declare class Connections {
|
|
|
462
398
|
* already-imported files are skipped. Returns the created sync — poll it for
|
|
463
399
|
* completion.
|
|
464
400
|
*
|
|
465
|
-
* @param
|
|
401
|
+
* @param workspaceId - Workspace id
|
|
466
402
|
* @param connectionId - Connection ID
|
|
467
403
|
* @param request - The picker-selected files to import
|
|
468
404
|
* @returns Promise that resolves with the created connection sync
|
|
469
405
|
* @throws {ApiError} if the request fails
|
|
470
406
|
*/
|
|
471
|
-
importFiles(
|
|
407
|
+
importFiles(workspaceId: string, connectionId: string, request: ImportWorkspaceFiles): Promise<WorkspaceConnectionSync>;
|
|
472
408
|
/**
|
|
473
409
|
* Export workspace files to a file-service connection.
|
|
474
410
|
*
|
|
@@ -476,13 +412,13 @@ declare class Connections {
|
|
|
476
412
|
* file, never overwriting the source. Returns the created sync — poll it for
|
|
477
413
|
* completion.
|
|
478
414
|
*
|
|
479
|
-
* @param
|
|
415
|
+
* @param workspaceId - Workspace id
|
|
480
416
|
* @param connectionId - Connection ID
|
|
481
417
|
* @param request - The workspace file ids to export
|
|
482
418
|
* @returns Promise that resolves with the created connection sync
|
|
483
419
|
* @throws {ApiError} if the request fails
|
|
484
420
|
*/
|
|
485
|
-
exportFiles(
|
|
421
|
+
exportFiles(workspaceId: string, connectionId: string, request: ExportWorkspaceFiles): Promise<WorkspaceConnectionSync>;
|
|
486
422
|
/**
|
|
487
423
|
* Mint a short-lived provider access token for a browser file picker.
|
|
488
424
|
*
|
|
@@ -490,13 +426,13 @@ declare class Connections {
|
|
|
490
426
|
* minted from the connection's stored credentials and is short-lived; the
|
|
491
427
|
* refresh token is never returned.
|
|
492
428
|
*
|
|
493
|
-
* @param
|
|
429
|
+
* @param workspaceId - Workspace id
|
|
494
430
|
* @param connectionId - Connection ID
|
|
495
431
|
* @param request - Optional picker resource (defaults to the connection's)
|
|
496
432
|
* @returns Promise that resolves with the short-lived picker token
|
|
497
433
|
* @throws {ApiError} if the request fails
|
|
498
434
|
*/
|
|
499
|
-
getPickerToken(
|
|
435
|
+
getPickerToken(workspaceId: string, connectionId: string, request?: WorkspacePickerTokenRequest): Promise<WorkspacePickerToken>;
|
|
500
436
|
}
|
|
501
437
|
//#endregion
|
|
502
438
|
//#region src/services/detections.d.ts
|
|
@@ -509,48 +445,56 @@ declare class Detections {
|
|
|
509
445
|
constructor(api: ApiClient);
|
|
510
446
|
/**
|
|
511
447
|
* List all detections in a workspace
|
|
512
|
-
* @param
|
|
448
|
+
* @param workspaceId - Workspace id
|
|
513
449
|
* @param query - Optional pagination and filters (status, fileId,
|
|
514
450
|
* pipelineId, triggerType, triggeredBy, limit, after)
|
|
515
451
|
* @returns Promise that resolves with a paginated list of detections
|
|
516
452
|
* @throws {ApiError} if the request fails
|
|
517
453
|
*/
|
|
518
|
-
listDetections(
|
|
454
|
+
listDetections(workspaceId: string, query?: CursorPagination & WorkspaceDetectionsQuery): Promise<WorkspaceDetectionPage>;
|
|
519
455
|
/**
|
|
520
456
|
* List detections for a specific pipeline
|
|
521
|
-
* @param
|
|
522
|
-
* @param
|
|
457
|
+
* @param workspaceId - Workspace id
|
|
458
|
+
* @param pipelineId - Pipeline id
|
|
523
459
|
* @param query - Optional pagination and filters (status, fileId,
|
|
524
460
|
* triggerType, triggeredBy, limit, after)
|
|
525
461
|
* @returns Promise that resolves with a paginated list of detections
|
|
526
462
|
* @throws {ApiError} if the request fails
|
|
527
463
|
*/
|
|
528
|
-
listPipelineDetections(
|
|
464
|
+
listPipelineDetections(workspaceId: string, pipelineId: string, query?: CursorPagination & WorkspacePipelineDetectionsQuery): Promise<WorkspaceDetectionPage>;
|
|
529
465
|
/**
|
|
530
466
|
* Start a new detection over a file for a pipeline
|
|
531
|
-
* @param
|
|
532
|
-
* @param
|
|
467
|
+
* @param workspaceId - Workspace id
|
|
468
|
+
* @param pipelineId - Pipeline id
|
|
533
469
|
* @param detection - Detection creation request
|
|
534
470
|
* @returns Promise that resolves with the created detection
|
|
535
471
|
* @throws {ApiError} if the request fails
|
|
536
472
|
*/
|
|
537
|
-
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>;
|
|
538
482
|
/**
|
|
539
483
|
* Get detection details by ID
|
|
540
|
-
* @param
|
|
484
|
+
* @param workspaceId - Workspace id
|
|
541
485
|
* @param detectionId - Detection ID
|
|
542
486
|
* @returns Promise that resolves with the detection details
|
|
543
487
|
* @throws {ApiError} if the request fails
|
|
544
488
|
*/
|
|
545
|
-
getDetection(
|
|
489
|
+
getDetection(workspaceId: string, detectionId: string): Promise<WorkspaceDetection>;
|
|
546
490
|
/**
|
|
547
491
|
* Get a detection's analysis (audit)
|
|
548
|
-
* @param
|
|
492
|
+
* @param workspaceId - Workspace id
|
|
549
493
|
* @param detectionId - Detection ID
|
|
550
494
|
* @returns Promise that resolves with the audit
|
|
551
495
|
* @throws {ApiError} if the request fails
|
|
552
496
|
*/
|
|
553
|
-
getAnalysis(
|
|
497
|
+
getAnalysis(workspaceId: string, detectionId: string): Promise<Audit>;
|
|
554
498
|
/**
|
|
555
499
|
* Get a detection's enrichment intermediates.
|
|
556
500
|
*
|
|
@@ -559,25 +503,25 @@ declare class Detections {
|
|
|
559
503
|
* can search the extracted content and add entities the analysis missed. A
|
|
560
504
|
* detection whose analysis ran no enricher has no intermediates and 404s.
|
|
561
505
|
*
|
|
562
|
-
* @param
|
|
506
|
+
* @param workspaceId - Workspace id
|
|
563
507
|
* @param detectionId - Detection ID
|
|
564
508
|
* @returns Promise that resolves with the artifact set
|
|
565
509
|
* @throws {ApiError} if the request fails (404 when there are none)
|
|
566
510
|
*/
|
|
567
|
-
getIntermediates(
|
|
511
|
+
getIntermediates(workspaceId: string, detectionId: string): Promise<ArtifactSet>;
|
|
568
512
|
/**
|
|
569
513
|
* Download a detection's audit as a file.
|
|
570
514
|
*
|
|
571
515
|
* `format` is `csv` (default) — a zip of entities.csv, provenance.csv, and
|
|
572
516
|
* reviews.csv — or `json`, a pretty-printed JSON file.
|
|
573
517
|
*
|
|
574
|
-
* @param
|
|
518
|
+
* @param workspaceId - Workspace id
|
|
575
519
|
* @param detectionId - Detection ID
|
|
576
520
|
* @param query - Optional output format (`csv` default, or `json`)
|
|
577
521
|
* @returns Promise that resolves with the file response
|
|
578
522
|
* @throws {ApiError} if the request fails
|
|
579
523
|
*/
|
|
580
|
-
downloadAudit(
|
|
524
|
+
downloadAudit(workspaceId: string, detectionId: string, query?: ExportQuery): Promise<Response>;
|
|
581
525
|
/**
|
|
582
526
|
* Open the raw Server-Sent Events stream of a detection's status changes.
|
|
583
527
|
*
|
|
@@ -586,12 +530,12 @@ declare class Detections {
|
|
|
586
530
|
* {@link streamEvents}, which parses each frame into a typed
|
|
587
531
|
* {@link DetectionStatusEvent}.
|
|
588
532
|
*
|
|
589
|
-
* @param
|
|
533
|
+
* @param workspaceId - Workspace id
|
|
590
534
|
* @param detectionId - Detection ID
|
|
591
535
|
* @returns Promise that resolves with the event-stream response
|
|
592
536
|
* @throws {ApiError} if the request fails
|
|
593
537
|
*/
|
|
594
|
-
events(
|
|
538
|
+
events(workspaceId: string, detectionId: string): Promise<Response>;
|
|
595
539
|
/**
|
|
596
540
|
* Stream a detection's status changes as Server-Sent Events.
|
|
597
541
|
*
|
|
@@ -599,103 +543,120 @@ declare class Detections {
|
|
|
599
543
|
* once the detection settles. Break out of the loop to close the stream
|
|
600
544
|
* early. For the raw response, use {@link events}.
|
|
601
545
|
*
|
|
602
|
-
* @param
|
|
546
|
+
* @param workspaceId - Workspace id
|
|
603
547
|
* @param detectionId - Detection ID
|
|
604
548
|
* @yields each {@link DetectionStatusEvent} as it arrives
|
|
605
549
|
* @throws {ApiError} if the request fails to open
|
|
606
550
|
* @throws {NvisyError} if the response has no readable body
|
|
607
551
|
*/
|
|
608
|
-
streamEvents(
|
|
552
|
+
streamEvents(workspaceId: string, detectionId: string): AsyncGenerator<DetectionStatusEvent>;
|
|
609
553
|
/**
|
|
610
554
|
* List the redactions produced from a detection
|
|
611
|
-
* @param
|
|
555
|
+
* @param workspaceId - Workspace id
|
|
612
556
|
* @param detectionId - Detection ID
|
|
613
557
|
* @param query - Optional pagination (limit, after)
|
|
614
558
|
* @returns Promise that resolves with a paginated list of redactions
|
|
615
559
|
* @throws {ApiError} if the request fails
|
|
616
560
|
*/
|
|
617
|
-
listRedactions(
|
|
561
|
+
listRedactions(workspaceId: string, detectionId: string, query?: CursorPagination): Promise<WorkspaceRedactionResultPage>;
|
|
618
562
|
/**
|
|
619
563
|
* Redact a detection, producing a redaction result
|
|
620
|
-
* @param
|
|
564
|
+
* @param workspaceId - Workspace id
|
|
621
565
|
* @param detectionId - Detection ID
|
|
622
566
|
* @param redaction - Redaction request (optional reviewer edits)
|
|
623
567
|
* @returns Promise that resolves with the created redaction result
|
|
624
568
|
* @throws {ApiError} if the request fails
|
|
625
569
|
*/
|
|
626
|
-
createRedaction(
|
|
570
|
+
createRedaction(workspaceId: string, detectionId: string, redaction: RedactWorkspaceDetection): Promise<WorkspaceRedactionResult>;
|
|
627
571
|
}
|
|
628
572
|
//#endregion
|
|
629
|
-
//#region src/services/
|
|
573
|
+
//#region src/services/documents.d.ts
|
|
630
574
|
/**
|
|
631
|
-
* Service for handling
|
|
575
|
+
* Service for handling document operations, including review assignment.
|
|
632
576
|
*/
|
|
633
|
-
declare class
|
|
577
|
+
declare class Documents {
|
|
634
578
|
#private;
|
|
635
579
|
constructor(api: ApiClient);
|
|
636
580
|
/**
|
|
637
|
-
* Upload one or more
|
|
638
|
-
* @param
|
|
639
|
-
* @param
|
|
640
|
-
* @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
|
|
641
585
|
* @throws {ApiError} if the request fails
|
|
642
586
|
*/
|
|
643
|
-
|
|
587
|
+
uploadDocuments(workspaceId: string, documents: Blob | Blob[]): Promise<WorkspaceDocument[]>;
|
|
644
588
|
/**
|
|
645
|
-
* List
|
|
646
|
-
* @param
|
|
589
|
+
* List documents in a workspace
|
|
590
|
+
* @param workspaceId - Workspace id
|
|
647
591
|
* @param query - Optional query parameters (formats, modality, hash, search,
|
|
648
592
|
* limit, after)
|
|
649
|
-
* @returns Promise that resolves with a paginated list of
|
|
593
|
+
* @returns Promise that resolves with a paginated list of documents
|
|
650
594
|
* @throws {ApiError} if the request fails
|
|
651
595
|
*/
|
|
652
|
-
|
|
596
|
+
listDocuments(workspaceId: string, query?: ListWorkspaceDocuments & CursorPagination): Promise<WorkspaceDocumentPage>;
|
|
653
597
|
/**
|
|
654
|
-
* Get
|
|
655
|
-
* @param
|
|
656
|
-
* @param
|
|
657
|
-
* @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
|
|
658
602
|
* @throws {ApiError} if the request fails
|
|
659
603
|
*/
|
|
660
|
-
|
|
604
|
+
getDocument(workspaceId: string, documentId: string): Promise<WorkspaceDocument>;
|
|
661
605
|
/**
|
|
662
|
-
* Download a
|
|
663
|
-
* @param
|
|
664
|
-
* @param
|
|
665
|
-
* @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
|
|
666
610
|
* @throws {ApiError} if the request fails
|
|
667
611
|
*/
|
|
668
|
-
|
|
612
|
+
downloadDocument(workspaceId: string, documentId: string): Promise<Response>;
|
|
669
613
|
/**
|
|
670
|
-
* Update a
|
|
671
|
-
* @param
|
|
672
|
-
* @param
|
|
673
|
-
* @param updates -
|
|
674
|
-
* @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
|
|
675
619
|
* @throws {ApiError} if the request fails
|
|
676
620
|
*/
|
|
677
|
-
|
|
621
|
+
updateDocument(workspaceId: string, documentId: string, updates: UpdateWorkspaceDocument): Promise<WorkspaceDocument>;
|
|
678
622
|
/**
|
|
679
|
-
* Delete a
|
|
680
|
-
* @param
|
|
681
|
-
* @param
|
|
682
|
-
* @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
|
|
683
627
|
* @throws {ApiError} if the request fails
|
|
684
628
|
*/
|
|
685
|
-
|
|
629
|
+
deleteDocument(workspaceId: string, documentId: string): Promise<void>;
|
|
686
630
|
/**
|
|
687
|
-
* Delete several
|
|
631
|
+
* Delete several documents in one call.
|
|
688
632
|
*
|
|
689
|
-
* Idempotent: ids resolving to live
|
|
690
|
-
* returned in `deleted`; unknown, already-deleted, or out-of-workspace
|
|
691
|
-
* 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.
|
|
692
636
|
*
|
|
693
|
-
* @param
|
|
694
|
-
* @param
|
|
637
|
+
* @param workspaceId - Workspace id
|
|
638
|
+
* @param documentIds - The document IDs to delete
|
|
695
639
|
* @returns Promise that resolves with the deleted and skipped ids
|
|
696
640
|
* @throws {ApiError} if the request fails
|
|
697
641
|
*/
|
|
698
|
-
|
|
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>;
|
|
699
660
|
}
|
|
700
661
|
//#endregion
|
|
701
662
|
//#region src/services/invites.d.ts
|
|
@@ -712,48 +673,48 @@ declare class Invites {
|
|
|
712
673
|
* @returns Promise that resolves with a paginated list of invitations
|
|
713
674
|
* @throws {ApiError} if the request fails
|
|
714
675
|
*/
|
|
715
|
-
listInvites(
|
|
676
|
+
listInvites(workspaceId: string, query?: ListWorkspaceInvites & CursorPagination): Promise<WorkspaceInvitePage>;
|
|
716
677
|
/**
|
|
717
678
|
* Send an invitation to join a workspace
|
|
718
|
-
* @param
|
|
679
|
+
* @param workspaceId - Workspace id
|
|
719
680
|
* @param invite - Invitation request
|
|
720
681
|
* @returns Promise that resolves with the sent invitation
|
|
721
682
|
* @throws {ApiError} if the request fails
|
|
722
683
|
*/
|
|
723
|
-
sendInvite(
|
|
684
|
+
sendInvite(workspaceId: string, invite: CreateWorkspaceInvite): Promise<WorkspaceInviteSent>;
|
|
724
685
|
/**
|
|
725
686
|
* Cancel a pending invitation
|
|
726
|
-
* @param
|
|
687
|
+
* @param workspaceId - Workspace id
|
|
727
688
|
* @param inviteId - Invite ID
|
|
728
689
|
* @returns Promise that resolves when the invitation is canceled
|
|
729
690
|
* @throws {ApiError} if the request fails
|
|
730
691
|
*/
|
|
731
|
-
cancelInvite(
|
|
692
|
+
cancelInvite(workspaceId: string, inviteId: string): Promise<void>;
|
|
732
693
|
/**
|
|
733
694
|
* Reply to an invitation (accept or decline)
|
|
734
|
-
* @param
|
|
695
|
+
* @param workspaceId - Workspace id
|
|
735
696
|
* @param inviteId - Invite ID
|
|
736
697
|
* @param reply - Reply request
|
|
737
698
|
* @returns Promise that resolves with the updated invitation
|
|
738
699
|
* @throws {ApiError} if the request fails
|
|
739
700
|
*/
|
|
740
|
-
replyToInvite(
|
|
701
|
+
replyToInvite(workspaceId: string, inviteId: string, reply: ReplyWorkspaceInvite): Promise<WorkspaceMember>;
|
|
741
702
|
/**
|
|
742
703
|
* Generate a shareable invite code for a workspace
|
|
743
|
-
* @param
|
|
704
|
+
* @param workspaceId - Workspace id
|
|
744
705
|
* @param options - Invite code generation options
|
|
745
706
|
* @returns Promise that resolves with the generated invite code
|
|
746
707
|
* @throws {ApiError} if the request fails
|
|
747
708
|
*/
|
|
748
|
-
generateInviteCode(
|
|
709
|
+
generateInviteCode(workspaceId: string, options: GenerateWorkspaceInviteCode): Promise<WorkspaceInviteCode>;
|
|
749
710
|
/**
|
|
750
711
|
* Reply to an invite code (accept or decline)
|
|
751
712
|
* @param inviteCode - The invite code
|
|
752
|
-
* @param reply -
|
|
713
|
+
* @param reply - Reply request (accept or decline the invitation)
|
|
753
714
|
* @returns Promise that resolves with the member details if accepted, null if declined
|
|
754
715
|
* @throws {ApiError} if the request fails
|
|
755
716
|
*/
|
|
756
|
-
replyToInviteCode(inviteCode: string, reply
|
|
717
|
+
replyToInviteCode(inviteCode: string, reply: ReplyWorkspaceInvite): Promise<WorkspaceMember | null>;
|
|
757
718
|
/**
|
|
758
719
|
* Preview an invite code without joining
|
|
759
720
|
* @param inviteCode - The invite code
|
|
@@ -772,44 +733,44 @@ declare class Members {
|
|
|
772
733
|
constructor(api: ApiClient);
|
|
773
734
|
/**
|
|
774
735
|
* List members of a workspace
|
|
775
|
-
* @param
|
|
736
|
+
* @param workspaceId - Workspace id
|
|
776
737
|
* @param query - Optional query parameters (role, has2fa, sortBy, order, limit, after)
|
|
777
738
|
* @returns Promise that resolves with a paginated list of members
|
|
778
739
|
* @throws {ApiError} if the request fails
|
|
779
740
|
*/
|
|
780
|
-
listMembers(
|
|
741
|
+
listMembers(workspaceId: string, query?: ListWorkspaceMembers & CursorPagination): Promise<WorkspaceMemberPage>;
|
|
781
742
|
/**
|
|
782
|
-
* Get member details by
|
|
783
|
-
* @param
|
|
784
|
-
* @param
|
|
743
|
+
* Get member details by account id
|
|
744
|
+
* @param workspaceId - Workspace id
|
|
745
|
+
* @param accountId - Member account id
|
|
785
746
|
* @returns Promise that resolves with the member details
|
|
786
747
|
* @throws {ApiError} if the request fails
|
|
787
748
|
*/
|
|
788
|
-
getMember(
|
|
749
|
+
getMember(workspaceId: string, accountId: string): Promise<WorkspaceMember>;
|
|
789
750
|
/**
|
|
790
751
|
* Update a member's role
|
|
791
|
-
* @param
|
|
792
|
-
* @param
|
|
752
|
+
* @param workspaceId - Workspace id
|
|
753
|
+
* @param accountId - Member account id
|
|
793
754
|
* @param updates - New role for the member
|
|
794
755
|
* @returns Promise that resolves with the updated member
|
|
795
756
|
* @throws {ApiError} if the request fails
|
|
796
757
|
*/
|
|
797
|
-
updateMember(
|
|
758
|
+
updateMember(workspaceId: string, accountId: string, updates: UpdateWorkspaceMember): Promise<WorkspaceMember>;
|
|
798
759
|
/**
|
|
799
760
|
* Remove a member from a workspace
|
|
800
|
-
* @param
|
|
801
|
-
* @param
|
|
761
|
+
* @param workspaceId - Workspace id
|
|
762
|
+
* @param accountId - Member account id
|
|
802
763
|
* @returns Promise that resolves when the member is removed
|
|
803
764
|
* @throws {ApiError} if the request fails
|
|
804
765
|
*/
|
|
805
|
-
removeMember(
|
|
766
|
+
removeMember(workspaceId: string, accountId: string): Promise<void>;
|
|
806
767
|
/**
|
|
807
768
|
* Leave a workspace
|
|
808
|
-
* @param
|
|
769
|
+
* @param workspaceId - Workspace id
|
|
809
770
|
* @returns Promise that resolves when the member has left
|
|
810
771
|
* @throws {ApiError} if the request fails
|
|
811
772
|
*/
|
|
812
|
-
leaveWorkspace(
|
|
773
|
+
leaveWorkspace(workspaceId: string): Promise<void>;
|
|
813
774
|
}
|
|
814
775
|
//#endregion
|
|
815
776
|
//#region src/services/notifications.d.ts
|
|
@@ -825,19 +786,19 @@ declare class Notifications {
|
|
|
825
786
|
* @returns Promise that resolves with a paginated list of notifications
|
|
826
787
|
* @throws {ApiError} if the request fails
|
|
827
788
|
*/
|
|
828
|
-
listNotifications(query?: CursorPagination): Promise<
|
|
789
|
+
listNotifications(query?: CursorPagination): Promise<AccountNotificationPage>;
|
|
829
790
|
/**
|
|
830
791
|
* Get the unread notifications count for the authenticated account
|
|
831
792
|
* @returns Promise that resolves with the unread status
|
|
832
793
|
* @throws {ApiError} if the request fails
|
|
833
794
|
*/
|
|
834
|
-
getUnreadNotificationsStatus(): Promise<
|
|
795
|
+
getUnreadNotificationsStatus(): Promise<AccountUnreadStatus>;
|
|
835
796
|
/**
|
|
836
797
|
* Mark every unread notification for the authenticated account as read
|
|
837
798
|
* @returns Promise that resolves with how many were marked read
|
|
838
799
|
* @throws {ApiError} if the request fails
|
|
839
800
|
*/
|
|
840
|
-
markAllRead(): Promise<
|
|
801
|
+
markAllRead(): Promise<AccountMarkedReadStatus>;
|
|
841
802
|
/**
|
|
842
803
|
* Mark a single notification as read
|
|
843
804
|
* @param notificationId - Notification ID
|
|
@@ -879,48 +840,48 @@ declare class Pipelines {
|
|
|
879
840
|
constructor(api: ApiClient);
|
|
880
841
|
/**
|
|
881
842
|
* List pipelines in a workspace
|
|
882
|
-
* @param
|
|
843
|
+
* @param workspaceId - Workspace id
|
|
883
844
|
* @param query - Optional query parameters (search, status, limit, after)
|
|
884
845
|
* @returns Promise that resolves with a paginated list of pipeline summaries
|
|
885
846
|
* @throws {ApiError} if the request fails
|
|
886
847
|
*/
|
|
887
|
-
listPipelines(
|
|
848
|
+
listPipelines(workspaceId: string, query?: CursorPagination & {
|
|
888
849
|
search?: string;
|
|
889
850
|
status?: PipelineStatus;
|
|
890
|
-
}): Promise<
|
|
851
|
+
}): Promise<WorkspacePipelineSummaryPage>;
|
|
891
852
|
/**
|
|
892
853
|
* Create a pipeline in a workspace
|
|
893
|
-
* @param
|
|
854
|
+
* @param workspaceId - Workspace id
|
|
894
855
|
* @param pipeline - Pipeline creation request
|
|
895
856
|
* @returns Promise that resolves with the created pipeline
|
|
896
857
|
* @throws {ApiError} if the request fails
|
|
897
858
|
*/
|
|
898
|
-
createPipeline(
|
|
859
|
+
createPipeline(workspaceId: string, pipeline: CreateWorkspacePipeline): Promise<WorkspacePipeline>;
|
|
899
860
|
/**
|
|
900
|
-
* Get pipeline details by
|
|
901
|
-
* @param
|
|
902
|
-
* @param
|
|
861
|
+
* Get pipeline details by id
|
|
862
|
+
* @param workspaceId - Workspace id
|
|
863
|
+
* @param pipelineId - Pipeline id
|
|
903
864
|
* @returns Promise that resolves with the pipeline details
|
|
904
865
|
* @throws {ApiError} if the request fails
|
|
905
866
|
*/
|
|
906
|
-
getPipeline(
|
|
867
|
+
getPipeline(workspaceId: string, pipelineId: string): Promise<WorkspacePipeline>;
|
|
907
868
|
/**
|
|
908
869
|
* Update a pipeline
|
|
909
|
-
* @param
|
|
910
|
-
* @param
|
|
870
|
+
* @param workspaceId - Workspace id
|
|
871
|
+
* @param pipelineId - Pipeline id
|
|
911
872
|
* @param updates - Pipeline update request
|
|
912
873
|
* @returns Promise that resolves with the updated pipeline
|
|
913
874
|
* @throws {ApiError} if the request fails
|
|
914
875
|
*/
|
|
915
|
-
updatePipeline(
|
|
876
|
+
updatePipeline(workspaceId: string, pipelineId: string, updates: UpdateWorkspacePipeline): Promise<WorkspacePipeline>;
|
|
916
877
|
/**
|
|
917
878
|
* Delete a pipeline
|
|
918
|
-
* @param
|
|
919
|
-
* @param
|
|
879
|
+
* @param workspaceId - Workspace id
|
|
880
|
+
* @param pipelineId - Pipeline id
|
|
920
881
|
* @returns Promise that resolves when the pipeline is deleted
|
|
921
882
|
* @throws {ApiError} if the request fails
|
|
922
883
|
*/
|
|
923
|
-
deletePipeline(
|
|
884
|
+
deletePipeline(workspaceId: string, pipelineId: string): Promise<void>;
|
|
924
885
|
}
|
|
925
886
|
//#endregion
|
|
926
887
|
//#region src/services/policies.d.ts
|
|
@@ -932,45 +893,45 @@ declare class Policies {
|
|
|
932
893
|
constructor(api: ApiClient);
|
|
933
894
|
/**
|
|
934
895
|
* List policies in a workspace
|
|
935
|
-
* @param
|
|
896
|
+
* @param workspaceId - Workspace id
|
|
936
897
|
* @param query - Optional pagination parameters (limit, after)
|
|
937
898
|
* @returns Promise that resolves with a paginated list of policies
|
|
938
899
|
* @throws {ApiError} if the request fails
|
|
939
900
|
*/
|
|
940
|
-
listPolicies(
|
|
901
|
+
listPolicies(workspaceId: string, query?: CursorPagination & WorkspacePoliciesQuery): Promise<WorkspacePolicySummaryPage>;
|
|
941
902
|
/**
|
|
942
903
|
* Create a policy in a workspace
|
|
943
|
-
* @param
|
|
904
|
+
* @param workspaceId - Workspace id
|
|
944
905
|
* @param policy - Policy creation request
|
|
945
906
|
* @returns Promise that resolves with the created policy
|
|
946
907
|
* @throws {ApiError} if the request fails
|
|
947
908
|
*/
|
|
948
|
-
createPolicy(
|
|
909
|
+
createPolicy(workspaceId: string, policy: CreateWorkspacePolicy): Promise<WorkspacePolicy>;
|
|
949
910
|
/**
|
|
950
|
-
* Get policy details by
|
|
951
|
-
* @param
|
|
952
|
-
* @param
|
|
911
|
+
* Get policy details by id
|
|
912
|
+
* @param workspaceId - Workspace id
|
|
913
|
+
* @param policyId - Policy id
|
|
953
914
|
* @returns Promise that resolves with the policy details
|
|
954
915
|
* @throws {ApiError} if the request fails
|
|
955
916
|
*/
|
|
956
|
-
getPolicy(
|
|
917
|
+
getPolicy(workspaceId: string, policyId: string): Promise<WorkspacePolicy>;
|
|
957
918
|
/**
|
|
958
919
|
* Update a policy
|
|
959
|
-
* @param
|
|
960
|
-
* @param
|
|
920
|
+
* @param workspaceId - Workspace id
|
|
921
|
+
* @param policyId - Policy id
|
|
961
922
|
* @param updates - Policy update request
|
|
962
923
|
* @returns Promise that resolves with the updated policy
|
|
963
924
|
* @throws {ApiError} if the request fails
|
|
964
925
|
*/
|
|
965
|
-
updatePolicy(
|
|
926
|
+
updatePolicy(workspaceId: string, policyId: string, updates: UpdateWorkspacePolicy): Promise<WorkspacePolicy>;
|
|
966
927
|
/**
|
|
967
928
|
* Delete a policy
|
|
968
|
-
* @param
|
|
969
|
-
* @param
|
|
929
|
+
* @param workspaceId - Workspace id
|
|
930
|
+
* @param policyId - Policy id
|
|
970
931
|
* @returns Promise that resolves when the policy is deleted
|
|
971
932
|
* @throws {ApiError} if the request fails
|
|
972
933
|
*/
|
|
973
|
-
deletePolicy(
|
|
934
|
+
deletePolicy(workspaceId: string, policyId: string): Promise<void>;
|
|
974
935
|
}
|
|
975
936
|
//#endregion
|
|
976
937
|
//#region src/services/providers.d.ts
|
|
@@ -984,53 +945,53 @@ declare class Providers {
|
|
|
984
945
|
constructor(api: ApiClient);
|
|
985
946
|
/**
|
|
986
947
|
* List a workspace's inference providers
|
|
987
|
-
* @param
|
|
948
|
+
* @param workspaceId - Workspace id
|
|
988
949
|
* @param query - Optional pagination and filters (provider, limit, after)
|
|
989
950
|
* @returns Promise that resolves with a paginated list of providers
|
|
990
951
|
* @throws {ApiError} if the request fails
|
|
991
952
|
*/
|
|
992
|
-
listProviders(
|
|
953
|
+
listProviders(workspaceId: string, query?: CursorPagination & WorkspaceProvidersQuery): Promise<WorkspaceProviderPage>;
|
|
993
954
|
/**
|
|
994
955
|
* Create an inference provider in a workspace
|
|
995
|
-
* @param
|
|
956
|
+
* @param workspaceId - Workspace id
|
|
996
957
|
* @param provider - Provider creation request
|
|
997
958
|
* @returns Promise that resolves with the created provider
|
|
998
959
|
* @throws {ApiError} if the request fails
|
|
999
960
|
*/
|
|
1000
|
-
createProvider(
|
|
961
|
+
createProvider(workspaceId: string, provider: CreateWorkspaceProvider): Promise<WorkspaceProvider>;
|
|
1001
962
|
/**
|
|
1002
963
|
* Get provider details by ID
|
|
1003
|
-
* @param
|
|
964
|
+
* @param workspaceId - Workspace id
|
|
1004
965
|
* @param providerId - Provider ID
|
|
1005
966
|
* @returns Promise that resolves with the provider details
|
|
1006
967
|
* @throws {ApiError} if the request fails
|
|
1007
968
|
*/
|
|
1008
|
-
getProvider(
|
|
969
|
+
getProvider(workspaceId: string, providerId: string): Promise<WorkspaceProvider>;
|
|
1009
970
|
/**
|
|
1010
971
|
* Update an inference provider
|
|
1011
|
-
* @param
|
|
972
|
+
* @param workspaceId - Workspace id
|
|
1012
973
|
* @param providerId - Provider ID
|
|
1013
974
|
* @param updates - Provider update request
|
|
1014
975
|
* @returns Promise that resolves with the updated provider
|
|
1015
976
|
* @throws {ApiError} if the request fails
|
|
1016
977
|
*/
|
|
1017
|
-
updateProvider(
|
|
978
|
+
updateProvider(workspaceId: string, providerId: string, updates: UpdateWorkspaceProvider): Promise<WorkspaceProvider>;
|
|
1018
979
|
/**
|
|
1019
980
|
* Delete an inference provider
|
|
1020
|
-
* @param
|
|
981
|
+
* @param workspaceId - Workspace id
|
|
1021
982
|
* @param providerId - Provider ID
|
|
1022
983
|
* @returns Promise that resolves when the provider is deleted
|
|
1023
984
|
* @throws {ApiError} if the request fails
|
|
1024
985
|
*/
|
|
1025
|
-
deleteProvider(
|
|
986
|
+
deleteProvider(workspaceId: string, providerId: string): Promise<void>;
|
|
1026
987
|
/**
|
|
1027
988
|
* Verify an inference provider's configuration and credentials
|
|
1028
|
-
* @param
|
|
989
|
+
* @param workspaceId - Workspace id
|
|
1029
990
|
* @param providerId - Provider ID
|
|
1030
991
|
* @returns Promise that resolves with the verification result
|
|
1031
992
|
* @throws {ApiError} if the request fails
|
|
1032
993
|
*/
|
|
1033
|
-
verifyProvider(
|
|
994
|
+
verifyProvider(workspaceId: string, providerId: string): Promise<WorkspaceConnectionVerification>;
|
|
1034
995
|
}
|
|
1035
996
|
//#endregion
|
|
1036
997
|
//#region src/services/redactions.d.ts
|
|
@@ -1043,12 +1004,12 @@ declare class Redactions {
|
|
|
1043
1004
|
constructor(api: ApiClient);
|
|
1044
1005
|
/**
|
|
1045
1006
|
* Get a redaction's review audit
|
|
1046
|
-
* @param
|
|
1007
|
+
* @param workspaceId - Workspace id
|
|
1047
1008
|
* @param redactionId - Redaction ID
|
|
1048
1009
|
* @returns Promise that resolves with the audit
|
|
1049
1010
|
* @throws {ApiError} if the request fails
|
|
1050
1011
|
*/
|
|
1051
|
-
getReview(
|
|
1012
|
+
getReview(workspaceId: string, redactionId: string): Promise<Audit>;
|
|
1052
1013
|
}
|
|
1053
1014
|
//#endregion
|
|
1054
1015
|
//#region src/services/status.d.ts
|
|
@@ -1074,15 +1035,15 @@ declare class Syncs {
|
|
|
1074
1035
|
constructor(api: ApiClient);
|
|
1075
1036
|
/**
|
|
1076
1037
|
* List all syncs across a workspace's connections
|
|
1077
|
-
* @param
|
|
1038
|
+
* @param workspaceId - Workspace id
|
|
1078
1039
|
* @param query - Optional query parameters (provider, status, limit, after)
|
|
1079
1040
|
* @returns Promise that resolves with a paginated list of connection syncs
|
|
1080
1041
|
* @throws {ApiError} if the request fails
|
|
1081
1042
|
*/
|
|
1082
|
-
listWorkspaceSyncs(
|
|
1043
|
+
listWorkspaceSyncs(workspaceId: string, query?: CursorPagination & {
|
|
1083
1044
|
provider?: string[];
|
|
1084
1045
|
status?: SyncStatus;
|
|
1085
|
-
}): Promise<
|
|
1046
|
+
}): Promise<WorkspaceConnectionSyncPage>;
|
|
1086
1047
|
/**
|
|
1087
1048
|
* Start a sync for an object-store connection.
|
|
1088
1049
|
*
|
|
@@ -1091,39 +1052,132 @@ declare class Syncs {
|
|
|
1091
1052
|
* use {@link Connections.importFiles} and {@link Connections.exportFiles}
|
|
1092
1053
|
* instead. Returns the created sync — poll it for completion.
|
|
1093
1054
|
*
|
|
1094
|
-
* @param
|
|
1055
|
+
* @param workspaceId - Workspace id
|
|
1095
1056
|
* @param connectionId - Connection ID
|
|
1096
1057
|
* @returns Promise that resolves with the started connection sync
|
|
1097
1058
|
* @throws {ApiError} if the request fails
|
|
1098
1059
|
*/
|
|
1099
|
-
startSync(
|
|
1060
|
+
startSync(workspaceId: string, connectionId: string): Promise<WorkspaceConnectionSync>;
|
|
1100
1061
|
/**
|
|
1101
1062
|
* List syncs for a connection
|
|
1102
|
-
* @param
|
|
1063
|
+
* @param workspaceId - Workspace id
|
|
1103
1064
|
* @param connectionId - Connection ID
|
|
1104
1065
|
* @param query - Optional pagination parameters (limit, after)
|
|
1105
1066
|
* @returns Promise that resolves with a paginated list of connection syncs
|
|
1106
1067
|
* @throws {ApiError} if the request fails
|
|
1107
1068
|
*/
|
|
1108
|
-
listSyncs(
|
|
1069
|
+
listSyncs(workspaceId: string, connectionId: string, query?: CursorPagination): Promise<WorkspaceConnectionSyncPage>;
|
|
1109
1070
|
/**
|
|
1110
1071
|
* Get a connection sync by ID
|
|
1111
|
-
* @param
|
|
1072
|
+
* @param workspaceId - Workspace id
|
|
1112
1073
|
* @param connectionId - Connection ID
|
|
1113
1074
|
* @param syncId - Sync ID
|
|
1114
1075
|
* @returns Promise that resolves with the connection sync details
|
|
1115
1076
|
* @throws {ApiError} if the request fails
|
|
1116
1077
|
*/
|
|
1117
|
-
getSync(
|
|
1078
|
+
getSync(workspaceId: string, connectionId: string, syncId: string): Promise<WorkspaceConnectionSync>;
|
|
1118
1079
|
/**
|
|
1119
1080
|
* Cancel a running connection sync
|
|
1120
|
-
* @param
|
|
1081
|
+
* @param workspaceId - Workspace id
|
|
1121
1082
|
* @param connectionId - Connection ID
|
|
1122
1083
|
* @param syncId - Sync ID
|
|
1123
1084
|
* @returns Promise that resolves with the canceled connection sync
|
|
1124
1085
|
* @throws {ApiError} if the request fails
|
|
1125
1086
|
*/
|
|
1126
|
-
cancelSync(
|
|
1087
|
+
cancelSync(workspaceId: string, connectionId: string, syncId: string): Promise<WorkspaceConnectionSync>;
|
|
1088
|
+
}
|
|
1089
|
+
//#endregion
|
|
1090
|
+
//#region src/services/threads.d.ts
|
|
1091
|
+
/**
|
|
1092
|
+
* Service for discussion threads and the comments within them.
|
|
1093
|
+
*/
|
|
1094
|
+
declare class Threads {
|
|
1095
|
+
#private;
|
|
1096
|
+
constructor(api: ApiClient);
|
|
1097
|
+
/**
|
|
1098
|
+
* List a workspace's threads
|
|
1099
|
+
* @param workspaceId - Workspace id
|
|
1100
|
+
* @param query - Optional pagination and filters (status, limit, after)
|
|
1101
|
+
* @returns Promise that resolves with a paginated list of threads
|
|
1102
|
+
* @throws {ApiError} if the request fails
|
|
1103
|
+
*/
|
|
1104
|
+
listThreads(workspaceId: string, query?: CursorPagination & WorkspaceThreadsQuery): Promise<WorkspaceThreadPage>;
|
|
1105
|
+
/**
|
|
1106
|
+
* Open a new thread in a workspace
|
|
1107
|
+
* @param workspaceId - Workspace id
|
|
1108
|
+
* @param thread - Thread creation request
|
|
1109
|
+
* @returns Promise that resolves with the created thread
|
|
1110
|
+
* @throws {ApiError} if the request fails
|
|
1111
|
+
*/
|
|
1112
|
+
openThread(workspaceId: string, thread: OpenWorkspaceThread): Promise<WorkspaceThread>;
|
|
1113
|
+
/**
|
|
1114
|
+
* Rename a thread
|
|
1115
|
+
* @param workspaceId - Workspace id
|
|
1116
|
+
* @param threadId - Thread ID
|
|
1117
|
+
* @param updates - Thread rename request
|
|
1118
|
+
* @returns Promise that resolves with the updated thread
|
|
1119
|
+
* @throws {ApiError} if the request fails
|
|
1120
|
+
*/
|
|
1121
|
+
renameThread(workspaceId: string, threadId: string, updates: RenameWorkspaceThread): Promise<WorkspaceThread>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Delete a thread
|
|
1124
|
+
* @param workspaceId - Workspace id
|
|
1125
|
+
* @param threadId - Thread ID
|
|
1126
|
+
* @returns Promise that resolves when the thread is deleted
|
|
1127
|
+
* @throws {ApiError} if the request fails
|
|
1128
|
+
*/
|
|
1129
|
+
deleteThread(workspaceId: string, threadId: string): Promise<void>;
|
|
1130
|
+
/**
|
|
1131
|
+
* Close a thread, ending the discussion.
|
|
1132
|
+
* @param workspaceId - Workspace id
|
|
1133
|
+
* @param threadId - Thread ID
|
|
1134
|
+
* @returns Promise that resolves with the closed thread
|
|
1135
|
+
* @throws {ApiError} if the request fails
|
|
1136
|
+
*/
|
|
1137
|
+
closeThread(workspaceId: string, threadId: string): Promise<WorkspaceThread>;
|
|
1138
|
+
/**
|
|
1139
|
+
* Reopen a closed thread.
|
|
1140
|
+
* @param workspaceId - Workspace id
|
|
1141
|
+
* @param threadId - Thread ID
|
|
1142
|
+
* @returns Promise that resolves with the reopened thread
|
|
1143
|
+
* @throws {ApiError} if the request fails
|
|
1144
|
+
*/
|
|
1145
|
+
reopenThread(workspaceId: string, threadId: string): Promise<WorkspaceThread>;
|
|
1146
|
+
/**
|
|
1147
|
+
* List a thread's timeline: comments interleaved with lifecycle events.
|
|
1148
|
+
* @param workspaceId - Workspace id
|
|
1149
|
+
* @param threadId - Thread ID
|
|
1150
|
+
* @param query - Optional pagination parameters (limit, after)
|
|
1151
|
+
* @returns Promise that resolves with a paginated timeline
|
|
1152
|
+
* @throws {ApiError} if the request fails
|
|
1153
|
+
*/
|
|
1154
|
+
listTimeline(workspaceId: string, threadId: string, query?: CursorPagination): Promise<WorkspaceThreadEntryPage>;
|
|
1155
|
+
/**
|
|
1156
|
+
* Post a comment to a thread
|
|
1157
|
+
* @param workspaceId - Workspace id
|
|
1158
|
+
* @param threadId - Thread ID
|
|
1159
|
+
* @param comment - Comment creation request
|
|
1160
|
+
* @returns Promise that resolves with the created comment
|
|
1161
|
+
* @throws {ApiError} if the request fails
|
|
1162
|
+
*/
|
|
1163
|
+
createComment(workspaceId: string, threadId: string, comment: CreateWorkspaceComment): Promise<WorkspaceComment>;
|
|
1164
|
+
/**
|
|
1165
|
+
* Edit a comment
|
|
1166
|
+
* @param workspaceId - Workspace id
|
|
1167
|
+
* @param commentId - Comment ID
|
|
1168
|
+
* @param updates - Comment update request
|
|
1169
|
+
* @returns Promise that resolves with the updated comment
|
|
1170
|
+
* @throws {ApiError} if the request fails
|
|
1171
|
+
*/
|
|
1172
|
+
updateComment(workspaceId: string, commentId: string, updates: UpdateWorkspaceComment): Promise<WorkspaceComment>;
|
|
1173
|
+
/**
|
|
1174
|
+
* Delete a comment
|
|
1175
|
+
* @param workspaceId - Workspace id
|
|
1176
|
+
* @param commentId - Comment ID
|
|
1177
|
+
* @returns Promise that resolves when the comment is deleted
|
|
1178
|
+
* @throws {ApiError} if the request fails
|
|
1179
|
+
*/
|
|
1180
|
+
deleteComment(workspaceId: string, commentId: string): Promise<void>;
|
|
1127
1181
|
}
|
|
1128
1182
|
//#endregion
|
|
1129
1183
|
//#region src/services/webhooks.d.ts
|
|
@@ -1135,54 +1189,54 @@ declare class Webhooks {
|
|
|
1135
1189
|
constructor(api: ApiClient);
|
|
1136
1190
|
/**
|
|
1137
1191
|
* List all webhooks in a workspace
|
|
1138
|
-
* @param
|
|
1192
|
+
* @param workspaceId - Workspace id
|
|
1139
1193
|
* @param query - Optional pagination parameters (limit, after)
|
|
1140
1194
|
* @returns Promise that resolves with a paginated list of webhooks
|
|
1141
1195
|
* @throws {ApiError} if the request fails
|
|
1142
1196
|
*/
|
|
1143
|
-
listWebhooks(
|
|
1197
|
+
listWebhooks(workspaceId: string, query?: CursorPagination): Promise<WorkspaceWebhookPage>;
|
|
1144
1198
|
/**
|
|
1145
1199
|
* Create a new webhook
|
|
1146
|
-
* @param
|
|
1200
|
+
* @param workspaceId - Workspace id
|
|
1147
1201
|
* @param webhook - Webhook creation request
|
|
1148
1202
|
* @returns Promise that resolves with the created webhook (including secret)
|
|
1149
1203
|
* @throws {ApiError} if the request fails
|
|
1150
1204
|
*/
|
|
1151
|
-
createWebhook(
|
|
1205
|
+
createWebhook(workspaceId: string, webhook: CreateWorkspaceWebhook): Promise<WorkspaceWebhookCreated>;
|
|
1152
1206
|
/**
|
|
1153
|
-
* Get a specific webhook by
|
|
1154
|
-
* @param
|
|
1207
|
+
* Get a specific webhook by id
|
|
1208
|
+
* @param workspaceId - Workspace id
|
|
1155
1209
|
* @param webhookId - Webhook ID
|
|
1156
1210
|
* @returns Promise that resolves with the webhook details
|
|
1157
1211
|
* @throws {ApiError} if the request fails
|
|
1158
1212
|
*/
|
|
1159
|
-
getWebhook(
|
|
1213
|
+
getWebhook(workspaceId: string, webhookId: string): Promise<WorkspaceWebhook>;
|
|
1160
1214
|
/**
|
|
1161
1215
|
* Update an existing webhook
|
|
1162
|
-
* @param
|
|
1216
|
+
* @param workspaceId - Workspace id
|
|
1163
1217
|
* @param webhookId - Webhook ID
|
|
1164
1218
|
* @param updates - Webhook update request
|
|
1165
1219
|
* @returns Promise that resolves with the updated webhook
|
|
1166
1220
|
* @throws {ApiError} if the request fails
|
|
1167
1221
|
*/
|
|
1168
|
-
updateWebhook(
|
|
1222
|
+
updateWebhook(workspaceId: string, webhookId: string, updates: UpdateWorkspaceWebhook): Promise<WorkspaceWebhook>;
|
|
1169
1223
|
/**
|
|
1170
1224
|
* Delete a webhook
|
|
1171
|
-
* @param
|
|
1225
|
+
* @param workspaceId - Workspace id
|
|
1172
1226
|
* @param webhookId - Webhook ID
|
|
1173
1227
|
* @returns Promise that resolves when the webhook is deleted
|
|
1174
1228
|
* @throws {ApiError} if the request fails
|
|
1175
1229
|
*/
|
|
1176
|
-
deleteWebhook(
|
|
1230
|
+
deleteWebhook(workspaceId: string, webhookId: string): Promise<void>;
|
|
1177
1231
|
/**
|
|
1178
1232
|
* Test a webhook by sending a test payload
|
|
1179
|
-
* @param
|
|
1233
|
+
* @param workspaceId - Workspace id
|
|
1180
1234
|
* @param webhookId - Webhook ID
|
|
1181
1235
|
* @param options - Test webhook options
|
|
1182
1236
|
* @returns Promise that resolves with the test result
|
|
1183
1237
|
* @throws {ApiError} if the request fails
|
|
1184
1238
|
*/
|
|
1185
|
-
testWebhook(
|
|
1239
|
+
testWebhook(workspaceId: string, webhookId: string, options?: TestWorkspaceWebhook): Promise<WorkspaceWebhookResult>;
|
|
1186
1240
|
}
|
|
1187
1241
|
//#endregion
|
|
1188
1242
|
//#region src/services/workspaces.d.ts
|
|
@@ -1201,11 +1255,11 @@ declare class Workspaces {
|
|
|
1201
1255
|
listWorkspaces(query?: CursorPagination): Promise<WorkspacePage>;
|
|
1202
1256
|
/**
|
|
1203
1257
|
* Get workspace details by ID
|
|
1204
|
-
* @param
|
|
1258
|
+
* @param workspaceId - Workspace id
|
|
1205
1259
|
* @returns Promise that resolves with the workspace details
|
|
1206
1260
|
* @throws {ApiError} if the request fails
|
|
1207
1261
|
*/
|
|
1208
|
-
getWorkspace(
|
|
1262
|
+
getWorkspace(workspaceId: string): Promise<Workspace>;
|
|
1209
1263
|
/**
|
|
1210
1264
|
* Create a new workspace
|
|
1211
1265
|
* @param workspace - Workspace creation request
|
|
@@ -1215,49 +1269,49 @@ declare class Workspaces {
|
|
|
1215
1269
|
createWorkspace(workspace: CreateWorkspace): Promise<Workspace>;
|
|
1216
1270
|
/**
|
|
1217
1271
|
* Update an existing workspace
|
|
1218
|
-
* @param
|
|
1272
|
+
* @param workspaceId - Workspace id
|
|
1219
1273
|
* @param updates - Workspace update request
|
|
1220
1274
|
* @returns Promise that resolves with the updated workspace
|
|
1221
1275
|
* @throws {ApiError} if the request fails
|
|
1222
1276
|
*/
|
|
1223
|
-
updateWorkspace(
|
|
1277
|
+
updateWorkspace(workspaceId: string, updates: UpdateWorkspace): Promise<Workspace>;
|
|
1224
1278
|
/**
|
|
1225
1279
|
* Delete a workspace
|
|
1226
|
-
* @param
|
|
1280
|
+
* @param workspaceId - Workspace id
|
|
1227
1281
|
* @returns Promise that resolves when the workspace is deleted
|
|
1228
1282
|
* @throws {ApiError} if the request fails
|
|
1229
1283
|
*/
|
|
1230
|
-
deleteWorkspace(
|
|
1284
|
+
deleteWorkspace(workspaceId: string): Promise<void>;
|
|
1231
1285
|
/**
|
|
1232
1286
|
* Get notification settings for the authenticated user in a workspace
|
|
1233
|
-
* @param
|
|
1287
|
+
* @param workspaceId - Workspace id
|
|
1234
1288
|
* @returns Promise that resolves with the notification settings
|
|
1235
1289
|
* @throws {ApiError} if the request fails
|
|
1236
1290
|
*/
|
|
1237
|
-
getNotificationSettings(
|
|
1291
|
+
getNotificationSettings(workspaceId: string): Promise<WorkspaceNotificationSettings>;
|
|
1238
1292
|
/**
|
|
1239
1293
|
* Update notification settings for the authenticated user in a workspace
|
|
1240
|
-
* @param
|
|
1294
|
+
* @param workspaceId - Workspace id
|
|
1241
1295
|
* @param settings - Notification settings update request
|
|
1242
1296
|
* @returns Promise that resolves with the updated notification settings
|
|
1243
1297
|
* @throws {ApiError} if the request fails
|
|
1244
1298
|
*/
|
|
1245
|
-
updateNotificationSettings(
|
|
1299
|
+
updateNotificationSettings(workspaceId: string, settings: UpdateWorkspaceNotificationSettings): Promise<WorkspaceNotificationSettings>;
|
|
1246
1300
|
/**
|
|
1247
1301
|
* Upload a workspace's avatar image
|
|
1248
|
-
* @param
|
|
1302
|
+
* @param workspaceId - Workspace id
|
|
1249
1303
|
* @param avatar - Avatar image to upload
|
|
1250
1304
|
* @returns Promise that resolves when the avatar is uploaded
|
|
1251
1305
|
* @throws {ApiError} if the request fails
|
|
1252
1306
|
*/
|
|
1253
|
-
uploadAvatar(
|
|
1307
|
+
uploadAvatar(workspaceId: string, avatar: Blob): Promise<void>;
|
|
1254
1308
|
/**
|
|
1255
1309
|
* Delete a workspace's avatar image
|
|
1256
|
-
* @param
|
|
1310
|
+
* @param workspaceId - Workspace id
|
|
1257
1311
|
* @returns Promise that resolves when the avatar is deleted
|
|
1258
1312
|
* @throws {ApiError} if the request fails
|
|
1259
1313
|
*/
|
|
1260
|
-
deleteAvatar(
|
|
1314
|
+
deleteAvatar(workspaceId: string): Promise<void>;
|
|
1261
1315
|
}
|
|
1262
1316
|
//#endregion
|
|
1263
1317
|
//#region src/client.d.ts
|
|
@@ -1358,10 +1412,6 @@ declare class Nvisy {
|
|
|
1358
1412
|
* Service for workspace analytics.
|
|
1359
1413
|
*/
|
|
1360
1414
|
get analytics(): Analytics;
|
|
1361
|
-
/**
|
|
1362
|
-
* Service for the workspace assistant chat.
|
|
1363
|
-
*/
|
|
1364
|
-
get chat(): Chat;
|
|
1365
1415
|
/**
|
|
1366
1416
|
* Service for managing API tokens.
|
|
1367
1417
|
*/
|
|
@@ -1371,9 +1421,13 @@ declare class Nvisy {
|
|
|
1371
1421
|
*/
|
|
1372
1422
|
get connections(): Connections;
|
|
1373
1423
|
/**
|
|
1374
|
-
* Service for
|
|
1424
|
+
* Service for document operations (upload, download, delete, review).
|
|
1425
|
+
*/
|
|
1426
|
+
get documents(): Documents;
|
|
1427
|
+
/**
|
|
1428
|
+
* Service for discussion threads and comments.
|
|
1375
1429
|
*/
|
|
1376
|
-
get
|
|
1430
|
+
get threads(): Threads;
|
|
1377
1431
|
/**
|
|
1378
1432
|
* Service for managing pipelines.
|
|
1379
1433
|
*/
|
|
@@ -1387,9 +1441,10 @@ declare class Nvisy {
|
|
|
1387
1441
|
*/
|
|
1388
1442
|
get providers(): Providers;
|
|
1389
1443
|
/**
|
|
1390
|
-
* Service for reading the deployment's
|
|
1444
|
+
* Service for reading the deployment's capabilities (labels, recognizers,
|
|
1445
|
+
* connectors, auth methods).
|
|
1391
1446
|
*/
|
|
1392
|
-
get
|
|
1447
|
+
get capabilities(): Capabilities;
|
|
1393
1448
|
/**
|
|
1394
1449
|
* Service for managing workspace invitations.
|
|
1395
1450
|
*/
|
|
@@ -1424,5 +1479,5 @@ declare class Nvisy {
|
|
|
1424
1479
|
get workspaces(): Workspaces;
|
|
1425
1480
|
}
|
|
1426
1481
|
//#endregion
|
|
1427
|
-
export { Account as C, Activities as S,
|
|
1428
|
-
//# sourceMappingURL=client-
|
|
1482
|
+
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 };
|
|
1483
|
+
//# sourceMappingURL=client-SotZfT6b.d.ts.map
|