@nvisy/sdk 0.22.0 → 0.24.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 CHANGED
@@ -8,6 +8,39 @@ and this project adheres to
8
8
 
9
9
  ## [Unreleased]
10
10
 
11
+ ## [0.24.0] - 2026-08-12
12
+
13
+ ### Added
14
+
15
+ - `NotificationPayload` datatype, a discriminated union (on `notifyType`)
16
+ carrying each event's data, plus its nine named variant types:
17
+ `MemberInvitedParams`, `MemberJoinedParams`, `ConnectionSyncCompletedParams`,
18
+ `ConnectionSyncFailedParams`, `PipelineRunAnalyzedParams`,
19
+ `PipelineRunCompletedParams`, `PipelineRunFailedParams`,
20
+ `SystemAnnouncementParams`, and `SystemReportParams`
21
+
22
+ ### Changed
23
+
24
+ - Regenerated the API schema against the updated platform handlers
25
+ - **Breaking:** the `Notification` datatype now carries a structured `payload`
26
+ (`NotificationPayload`) instead of a flat `notifyType` enum. Read the event
27
+ type from `notification.payload.notifyType`; each variant's data (e.g.
28
+ `workspaceSlug`, `recordsSynced`, `runId`) hangs off the same object
29
+
30
+ ## [0.23.0] - 2026-08-12
31
+
32
+ ### Added
33
+
34
+ - `notifications.markAllRead()` marks every unread notification for the
35
+ authenticated account as read and returns how many were marked
36
+ (`MarkedReadStatus`)
37
+ - `notifications.markRead(notificationId)` marks a single notification as read
38
+ - `MarkedReadStatus` datatype (`{ markedRead }`)
39
+
40
+ ### Changed
41
+
42
+ - Regenerated the API schema against the updated platform handlers
43
+
11
44
  ## [0.22.0] - 2026-08-12
12
45
 
13
46
  ### Added
@@ -483,7 +516,9 @@ and this project adheres to
483
516
  - Network error handling for timeouts, DNS resolution, and connection issues
484
517
  - Configuration validation with detailed error messages
485
518
 
486
- [Unreleased]: https://github.com/nvisycom/sdk-ts/compare/v0.22.0...HEAD
519
+ [Unreleased]: https://github.com/nvisycom/sdk-ts/compare/v0.24.0...HEAD
520
+ [0.24.0]: https://github.com/nvisycom/sdk-ts/compare/v0.23.0...v0.24.0
521
+ [0.23.0]: https://github.com/nvisycom/sdk-ts/compare/v0.22.0...v0.23.0
487
522
  [0.22.0]: https://github.com/nvisycom/sdk-ts/compare/v0.21.0...v0.22.0
488
523
  [0.21.0]: https://github.com/nvisycom/sdk-ts/compare/v0.20.0...v0.21.0
489
524
  [0.20.0]: https://github.com/nvisycom/sdk-ts/compare/v0.19.0...v0.20.0
@@ -1,5 +1,5 @@
1
1
  import { t as ClientConfig } from "../config-BRQp8Cat.js";
2
- import { Mn as AuthToken, Nn as Login, Pn as Signup } from "../index-BTUYsNrz.js";
2
+ import { Gn as Signup, Un as AuthToken, Wn as Login } from "../index-BZcmqZdX.js";
3
3
  //#region src/auth/config.d.ts
4
4
  /**
5
5
  * Configuration options for standalone authentication functions.
@@ -1,5 +1,5 @@
1
1
  import { t as ClientConfig } from "./config-BRQp8Cat.js";
2
- import { $t as FilePage, A as PipelineRun, An as RecognizerCatalog, Ar as ApiToken, At as ListMembers, Br as Account$1, Bt as InvitePage, Ct as CursorPagination, Dt as NotificationSettings, En as SyncStatus, Et as NotificationPage, Ft as CreateInvite, Gt as ListInvites, Hr as PublicAccount, Ht as InviteSent, Ir as UpdateApiToken, It as GenerateInviteCode, Kt as ReplyInvite, Mn as AuthToken, Mt as MemberPage, N as PipelineRunsQuery, Nn as Login, Nr as ApiTokenWithJWT, O as Audit, On as UpdateConnection, Ot as UnreadStatus, P as RunStatusEvent, Pn as Signup, Pr as CreateApiToken, Pt as UpdateMember, Rr as ActivityPage, Rt as InviteCode, St as UpdatePipeline, Ur as UpdateAccount, Vt as InvitePreview, Wr as paths, Yt as Health, Zt as File, _ as WebhookPage, at as PolicySummaryPage, bt as PipelineSummaryPage, c as WorkspacePage, cn as Connection, d as CreateWebhook, dn as ConnectionSync, f as TestWebhook, fn as ConnectionSyncPage, ft as UpdatePolicy, h as WebhookCreated, hn as CreateConnection, ht as Pipeline, j as PipelineRunPage, jr as ApiTokenPage, jt as Member, k as CreatePipelineRun, kn as LabelCatalog, kt as UpdateNotificationSettings, m as Webhook, mt as CreatePipeline, o as UpdateWorkspace, p as UpdateWebhook, pn as ConnectionVerification, rn as UpdateFile, s as Workspace, t as CreateWorkspace, tn as ListFiles, tt as Policy, un as ConnectionPage, v as WebhookResult, vt as PipelineStatus, xn as SyncConnection, z as CreatePolicy } from "./index-BTUYsNrz.js";
2
+ import { $r as PublicAccount, $t as InviteSent, A as PipelineRun, Bn as LabelCatalog, Bt as UpdateNotificationSettings, Cn as ConnectionSyncPage, Ct as CursorPagination, En as CreateConnection, Et as MarkedReadStatus, Gn as Signup, Gr as CreateApiToken, Gt as UpdateMember, Hr as ApiTokenPage, Ht as Member, Kt as CreateInvite, Ln as SyncStatus, Mn as SyncConnection, N as PipelineRunsQuery, Nt as NotificationSettings, O as Audit, P as RunStatusEvent, Qt as InvitePreview, Sn as ConnectionSync, St as UpdatePipeline, Un as AuthToken, Ut as MemberPage, Vn as RecognizerCatalog, Vr as ApiToken, Vt as ListMembers, Wn as Login, Wr as ApiTokenWithJWT, Yr as ActivityPage, Yt as InviteCode, Zr as Account$1, Zt as InvitePage, _ as WebhookPage, at as PolicySummaryPage, bt as PipelineSummaryPage, c as WorkspacePage, cn as File, d as CreateWebhook, ei as UpdateAccount, f as TestWebhook, fn as ListFiles, ft as UpdatePolicy, h as WebhookCreated, ht as Pipeline, j as PipelineRunPage, jt as NotificationPage, k as CreatePipelineRun, m as Webhook, mn as UpdateFile, mt as CreatePipeline, nn as ListInvites, o as UpdateWorkspace, on as Health, p as UpdateWebhook, qr as UpdateApiToken, qt as GenerateInviteCode, rn as ReplyInvite, s as Workspace, t as CreateWorkspace, ti as paths, tt as Policy, un as FilePage, v as WebhookResult, vt as PipelineStatus, wn as ConnectionVerification, xn as ConnectionPage, yn as Connection, z as CreatePolicy, zn as UpdateConnection, zt as UnreadStatus } from "./index-BZcmqZdX.js";
3
3
  import { Client } from "openapi-fetch";
4
4
  //#region src/services/account.d.ts
5
5
  /**
@@ -414,6 +414,18 @@ declare class Notifications {
414
414
  * @throws {ApiError} if the request fails
415
415
  */
416
416
  getUnreadNotificationsStatus(): Promise<UnreadStatus>;
417
+ /**
418
+ * Mark every unread notification for the authenticated account as read
419
+ * @returns Promise that resolves with how many were marked read
420
+ * @throws {ApiError} if the request fails
421
+ */
422
+ markAllRead(): Promise<MarkedReadStatus>;
423
+ /**
424
+ * Mark a single notification as read
425
+ * @param notificationId - Notification ID
426
+ * @throws {ApiError} if the request fails
427
+ */
428
+ markRead(notificationId: string): Promise<void>;
417
429
  }
418
430
  //#endregion
419
431
  //#region src/services/pipelines.d.ts
@@ -975,4 +987,4 @@ declare class Nvisy {
975
987
  }
976
988
  //#endregion
977
989
  export { ApiTokens as _, Syncs as a, Policies as c, Members as d, Invites as f, Auth as g, Catalog as h, Webhooks as i, Pipelines as l, Connections as m, Nvisy as n, Status as o, Files as p, Workspaces as r, Runs as s, ApiClient as t, Notifications as u, Activities as v, Account as y };
978
- //# sourceMappingURL=client-DkmDIkhG.d.ts.map
990
+ //# sourceMappingURL=client-F-V1vFos.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client-F-V1vFos.d.ts","names":[],"sources":["../src/services/account.ts","../src/services/activities.ts","../src/services/api-tokens.ts","../src/services/auth.ts","../src/services/catalog.ts","../src/services/connections.ts","../src/services/files.ts","../src/services/invites.ts","../src/services/members.ts","../src/services/notifications.ts","../src/services/pipelines.ts","../src/services/policies.ts","../src/services/runs.ts","../src/services/status.ts","../src/services/syncs.ts","../src/services/webhooks.ts","../src/services/workspaces.ts","../src/client.ts"],"mappings":";;;;;;;cAUa;;EAGA,YAAA,KAAK;;;;;;EASX,cAAc,QAAQ;;;;;;;EAWtB,cAAc,SAAS,gBAAgB,QAAQ;;;;;;EAY/C,iBAAiB;;;;;;;EAUjB,iBAAiB,mBAAmB,QAAQ;;;;;;;;EAc5C,aAAa,kBAAkB,QAAQ,OAAO,QAAQ;;;;;;;EAsBtD,aAAa,mBAAmB;;;;;;;cCrF1B;;EAGA,YAAA,KAAK;;;;;;;;EAWX,eACL,uBACA,QAAQ,mBACN,QAAQ;;;;;;;cCVC;;EAGA,YAAA,KAAK;;;;;;;EAUX,cAAc,QAAQ,mBAAmB,QAAQ;;;;;;;EAajD,YAAY,kBAAkB,QAAQ;;;;;;;EAatC,eAAe,OAAO,iBAAiB,QAAQ;;;;;;;;EAc/C,eACL,iBACA,SAAS,iBACP,QAAQ;;;;;;;EAcL,eAAe,kBAAkB;;;;;;;cC7E3B;;EAGA,YAAA,KAAK;;;;;;;EAUX,aAAa,aAAa,QAAQ,QAAQ;;;;;;;EAa1C,cAAc,aAAa,SAAS,QAAQ;;;;;;EAY5C,iBAAiB;;;;;;;;cCrCX;;EAGA,YAAA,KAAK;;;;;EAQX,cAAc,QAAQ;;;;;EAStB,mBAAmB,QAAQ;;;;;;;cCdrB;;EAGA,YAAA,KAAK;;;;;;;;EAWX,gBACL,uBACA,QAAQ;IAAqB;MAC3B,QAAQ;;;;;;;;EAiBL,iBACL,uBACA,YAAY,mBACV,QAAQ;;;;;;;;EAkBL,cACL,uBACA,uBACE,QAAQ;;;;;;;;;EAkBL,iBACL,uBACA,sBACA,SAAS,mBACP,QAAQ;;;;;;;;EAkBL,iBACL,uBACA,uBACE;;;;;;;;EAgBG,iBACL,uBACA,uBACE,QAAQ;;;;;;;cCzHC;;EAGA,YAAA,KAAK;;;;;;;;EAWX,YACL,uBACA,OAAO,OAAO,SACZ,QAAQ;;;;;;;;EA+BL,UACL,uBACA,QAAQ,YAAY,mBAClB,QAAQ;;;;;;;;EAcL,QAAQ,uBAAuB,iBAAiB,QAAQ;;;;;;;;EAiBxD,aAAa,uBAAuB,iBAAiB,QAAQ;;;;;;;;;EAmB7D,WACL,uBACA,gBACA,SAAS,aACP,QAAQ;;;;;;;;EAkBL,WAAW,uBAAuB,iBAAiB;;;;;;;cCtH7C;;EAGA,YAAA,KAAK;;;;;;;;EAWX,YACL,uBACA,QAAQ,cAAc,mBACpB,QAAQ;;;;;;;;EAiBL,WACL,uBACA,QAAQ,eACN,QAAQ;;;;;;;;EAkBL,aAAa,uBAAuB,mBAAmB;;;;;;;;;EAcvD,cACL,uBACA,kBACA,OAAO,cACL,QAAQ;;;;;;;;EAkBL,mBACL,uBACA,SAAS,qBACP,QAAQ;;;;;;;;EAkBL,kBACL,oBACA,QAAQ,qBACN,QAAQ;;;;;;;EAcL,cAAc,qBAAqB,QAAQ;;;;;;;cCtIrC;;EAGA,YAAA,KAAK;;;;;;;;EAWX,YACL,uBACA,QAAQ,cAAc,mBACpB,QAAQ;;;;;;;;EAiBL,UAAU,uBAAuB,mBAAmB,QAAQ;;;;;;;;;EAoB5D,aACL,uBACA,kBACA,SAAS,eACP,QAAQ;;;;;;;;EAoBL,aAAa,uBAAuB,mBAAmB;;;;;;;EAYvD,eAAe,wBAAwB;;;;;;;cC3FjC;;EAGA,YAAA,KAAK;;;;;;;EAUX,kBAAkB,QAAQ,mBAAmB,QAAQ;;;;;;EAYrD,gCAAgC,QAAQ;;;;;;EAUxC,eAAe,QAAQ;;;;;;EAUvB,SAAS,yBAAyB;;;;;;;cC3C5B;;EAGA,YAAA,KAAK;;;;;;;;EAWX,cACL,uBACA,QAAQ;IAAqB;IAAiB,SAAS;MACrD,QAAQ;;;;;;;;EAiBL,eACL,uBACA,UAAU,iBACR,QAAQ;;;;;;;;EAkBL,YACL,uBACA,uBACE,QAAQ;;;;;;;;;EAkBL,eACL,uBACA,sBACA,SAAS,iBACP,QAAQ;;;;;;;;EAkBL,eACL,uBACA,uBACE;;;;;;;cCtGS;;EAGA,YAAA,KAAK;;;;;;;;EAWX,aACL,uBACA,QAAQ,mBACN,QAAQ;;;;;;;;EAiBL,aACL,uBACA,QAAQ,eACN,QAAQ;;;;;;;;EAkBL,UAAU,uBAAuB,qBAAqB,QAAQ;;;;;;;;;EAkB9D,aACL,uBACA,oBACA,SAAS,eACP,QAAQ;;;;;;;;EAkBL,aAAa,uBAAuB,qBAAqB;;;;;;;cC3FnD;;EAGA,YAAA,KAAK;;;;;;;;;EAYX,SACL,uBACA,QAAQ,mBAAmB;IAAsB;MAC/C,QAAQ;;;;;;;;;;EAmBL,iBACL,uBACA,sBACA,QAAQ,mBAAmB,oBACzB,QAAQ;;;;;;;;;EAkBL,UACL,uBACA,sBACA,KAAK,oBACH,QAAQ;;;;;;;;EAkBL,OAAO,uBAAuB,gBAAgB,QAAQ;;;;;;;;EAiBtD,cAAc,uBAAuB,gBAAgB,QAAQ;;;;;;;;EAiB7D,kBACL,uBACA,gBACE,QAAQ;;;;;;;;;EAmBL,iBACL,uBACA,gBACE,QAAQ;;;;;;;;;;;;;;EAwBL,qBACL,uBACA,gBACE,QAAQ;;;;;;;;;;;;;;;EAyBJ,aACN,uBACA,gBACE,eAAe;;;;;;;;EAqBZ,OAAO,uBAAuB,gBAAgB,QAAQ;;;;;;;cClOhD;;EAGA,YAAA,KAAK;;;;;EAQX,eAAe,QAAQ;;;;;;;cCLjB;;EAGA,YAAA,KAAK;;;;;;;;EAWX,mBACL,uBACA,QAAQ;IAAqB;IAAqB,SAAS;MACzD,QAAQ;;;;;;;;;EAeL,UACL,uBACA,sBACA,MAAM,iBACJ,QAAQ;;;;;;;;;EAmBL,UACL,uBACA,sBACA,QAAQ,mBACN,QAAQ;;;;;;;;;EAkBL,QACL,uBACA,sBACA,iBACE,QAAQ;;;;;;;;;EAkBL,WACL,uBACA,sBACA,iBACE,QAAQ;;;;;;;cCpGC;;EAGA,YAAA,KAAK;;;;;;;;EAWX,aACL,uBACA,QAAQ,mBACN,QAAQ;;;;;;;;EAiBL,cACL,uBACA,SAAS,gBACP,QAAQ;;;;;;;;EAkBL,WAAW,uBAAuB,oBAAoB,QAAQ;;;;;;;;;EAkB9D,cACL,uBACA,mBACA,SAAS,gBACP,QAAQ;;;;;;;;EAkBL,cAAc,uBAAuB,oBAAoB;;;;;;;;;EAiBzD,YACL,uBACA,mBACA,UAAU,cACR,QAAQ;;;;;;;cCrHC;;EAGA,YAAA,KAAK;;;;;;;EAUX,eAAe,QAAQ,mBAAmB,QAAQ;;;;;;;EAalD,aAAa,wBAAwB,QAAQ;;;;;;;EAa7C,gBAAgB,WAAW,kBAAkB,QAAQ;;;;;;;;EAcrD,gBACL,uBACA,SAAS,kBACP,QAAQ;;;;;;;EAcL,gBAAgB,wBAAwB;;;;;;;EAYxC,wBACL,wBACE,QAAQ;;;;;;;;EAiBL,2BACL,uBACA,UAAU,6BACR,QAAQ;;;;;;;;EAkBL,aAAa,uBAAuB,QAAQ,OAAO;;;;;;;EAqBnD,aAAa,wBAAwB;;;;;;;;;;KC5GhC,YAAY,OAAc;;;;;;;;;;;cAmBzB;;;;;;;;;;;;;;;;;EA4BA,YAAA,QAAQ;;;;;;;;;;;;;;;;;;;;;EAsFpB,aAAa,mBAAmB;;;;;;MAS5B;;;;;;;;;MAYA,OAAO;;;;MAOP,QAAQ;;;;MAOR,UAAU;;;;MAOV,WAAW;;;;MAOX,cAAc;;;;MAOd,aAAa;;;;MAOb,eAAe;;;;MAOf,SAAS;;;;MAOT,aAAa;;;;MAOb,YAAY;;;;MAOZ,WAAW;;;;MAOX,WAAW;;;;MAOX,WAAW;;;;MAOX,iBAAiB;;;;MAOjB,QAAQ;;;;MAOR,SAAS;;;;MAOT,YAAY;;;;MAOZ,cAAc"}
@@ -1,2 +1,2 @@
1
- import { $ as PciDssPart, $n as ImageEvent, $t as FilePage, A as PipelineRun, An as RecognizerCatalog, Ar as ApiToken, At as ListMembers, B as DateGranularity, Bn as AudioEventKind, Br as Account, Bt as InvitePage, C as LanguageProvenance, Cn as SyncMode, Cr as TextEntityRecord, Ct as CursorPagination, D as ScopeParams, Dn as SyncTriggerType, Dr as TextLocation, Dt as NotificationSettings, E as ScopeMetadata, En as SyncStatus, Er as TextHint, Et as NotificationPage, F as AudioRedaction, Fn as Attribution, Fr as TokenExpiration, Ft as CreateInvite, G as Label, Gn as BoundingBox, Gt as ListInvites, H as GdprArticle9Treatment, Hn as AudioLocation, Hr as PublicAccount, Ht as InviteSent, I as ClampBucket, In as AudioData, Ir as UpdateApiToken, It as GenerateInviteCode, J as LabelLocale, Jn as EntityCoRef, Jt as ComponentHealth, K as LabelEntry, Kn as Dimensions, Kt as ReplyInvite, L as Color, Ln as AudioEntity, Lr as Activity, Lt as Invite, M as PipelineRunStatus, Mn as AuthToken, Mr as ApiTokenType, Mt as MemberPage, N as PipelineRunsQuery, Nn as Login, Nr as ApiTokenWithJWT, Nt as MemberSortField, O as Audit, On as UpdateConnection, Or as TextProvenance, Ot as UnreadStatus, P as RunStatusEvent, Pn as Signup, Pr as CreateApiToken, Pt as UpdateMember, Q as ModalityRedactions, Qn as ImageEntityRecord, Qt as FileKind, R as ConfidenceThreshold, Rn as AudioEntityRecord, Rr as ActivityPage, Rt as InviteCode, S as Language, Sn as SyncDeletionPolicy, Sr as TextEntity, St as UpdatePipeline, T as Languages, Tn as SyncScheduleInput, Tr as TextEventKind, Tt as NotificationEvent, U as HipaaDeidMethod, Un as AudioProvenance, Ur as UpdateAccount, Ut as InviteSortField, V as DateStyle, Vn as AudioHint, Vr as AccountRef, Vt as InvitePreview, W as ImageRedaction, Wn as AuditContext, Wt as InviteStatus, X as LanguageTag, Xn as ImageData, Xt as HealthStatus, Y as Labels, Yn as EntityGroup, Yt as Health, Z as LocalizedText, Zn as ImageEntity, Zt as File, _ as WebhookPage, _n as LlmConfig, _r as TabularEventKind, _t as PipelineFilter, a as RetentionSettings, an as ValidationErrorDetail, ar as ModelEvent, at as PolicySummaryPage, b as Confidence, bn as StorageConfig, br as TabularProvenance, bt as PipelineSummaryPage, c as WorkspacePage, cn as Connection, cr as PatternEvent, ct as Sha2Algorithm, d as CreateWebhook, dn as ConnectionSync, dr as RangeOfUint, dt as TextRedaction, en as FormatToken, er as ImageEventKind, et as PciPanRender, f as TestWebhook, fn as ConnectionSyncPage, fr as Review, ft as UpdatePolicy, g as WebhookEvent, gn as GcsCredentials, gr as TabularEvent, gt as PipelineDefinition, h as WebhookCreated, hn as CreateConnection, hr as TabularEntityRecord, ht as Pipeline, i as RetentionOverride, in as ErrorResponse, ir as LeakProfile, it as PolicySummary, j as PipelineRunPage, jn as RegisteredRecognizer, jr as ApiTokenPage, jt as Member, k as CreatePipelineRun, kn as LabelCatalog, kr as TimeSpan, kt as UpdateNotificationSettings, l as WorkspaceRole, ln as ConnectionConfig, lr as Point, lt as TabularRedaction, m as Webhook, mn as ConnectionsQuery, mr as TabularEntity, mt as CreatePipeline, n as OcrPolicy, nn as ModalityToken, nr as ImageLocation, nt as PolicyDefinition, o as UpdateWorkspace, on as AnthropicCredentials, or as OcrMode, ot as PolicyTemplate, p as UpdateWebhook, pn as ConnectionVerification, pr as RuleMatch, pt as Waveform, q as LabelGroup, qn as Dpi, qt as SortOrder, r as Retention, rn as UpdateFile, rr as ImageProvenance, rt as PolicyRule, s as Workspace, sn as AzureCredentials, sr as OperatorId, st as Predicate, t as CreateWorkspace, tn as ListFiles, tr as ImageHint, tt as Policy, u as WorkspaceSettings, un as ConnectionPage, ur as Polygon, ut as TerminalFallback, v as WebhookResult, vn as OpenAiCredentials, vr as TabularHint, vt as PipelineStatus, w as LanguageSpan, wn as SyncSchedule, wr as TextEvent, wt as Notification, x as CountryCode, xn as SyncConnection, xr as TextData, xt as PipelineTriggerType, y as WebhookStatus, yn as S3Credentials, yr as TabularLocation, yt as PipelineSummary, z as CreatePolicy, zn as AudioEvent, zr as ActivityType, zt as InviteExpiration } from "../index-BTUYsNrz.js";
2
- export type { Account, AccountRef, Activity, ActivityPage, ActivityType, AnthropicCredentials, ApiToken, ApiTokenPage, ApiTokenType, ApiTokenWithJWT, Attribution, AudioData, AudioEntity, AudioEntityRecord, AudioEvent, AudioEventKind, AudioHint, AudioLocation, AudioProvenance, AudioRedaction, Audit, AuditContext, AuthToken, AzureCredentials, BoundingBox, ClampBucket, Color, ComponentHealth, Confidence, ConfidenceThreshold, Connection, ConnectionConfig, ConnectionPage, ConnectionSync, ConnectionSyncPage, ConnectionVerification, ConnectionsQuery, CountryCode, CreateApiToken, CreateConnection, CreateInvite, CreatePipeline, CreatePipelineRun, CreatePolicy, CreateWebhook, CreateWorkspace, CursorPagination, DateGranularity, DateStyle, Dimensions, Dpi, EntityCoRef, EntityGroup, ErrorResponse, File, FileKind, FilePage, FormatToken, GcsCredentials, GdprArticle9Treatment, GenerateInviteCode, Health, HealthStatus, HipaaDeidMethod, ImageData, ImageEntity, ImageEntityRecord, ImageEvent, ImageEventKind, ImageHint, ImageLocation, ImageProvenance, ImageRedaction, Invite, InviteCode, InviteExpiration, InvitePage, InvitePreview, InviteSent, InviteSortField, InviteStatus, Label, LabelCatalog, LabelEntry, LabelGroup, LabelLocale, Labels, Language, LanguageProvenance, LanguageSpan, LanguageTag, Languages, LeakProfile, ListFiles, ListInvites, ListMembers, LlmConfig, LocalizedText, Login, Member, MemberPage, MemberSortField, ModalityRedactions, ModalityToken, ModelEvent, Notification, NotificationEvent, NotificationPage, NotificationSettings, OcrMode, OcrPolicy, OpenAiCredentials, OperatorId, PatternEvent, PciDssPart, PciPanRender, Pipeline, PipelineDefinition, PipelineFilter, PipelineRun, PipelineRunPage, PipelineRunStatus, PipelineRunsQuery, PipelineStatus, PipelineSummary, PipelineSummaryPage, PipelineTriggerType, Point, Policy, PolicyDefinition, PolicyRule, PolicySummary, PolicySummaryPage, PolicyTemplate, Polygon, Predicate, PublicAccount, RangeOfUint, RecognizerCatalog, RegisteredRecognizer, ReplyInvite, Retention, RetentionOverride, RetentionSettings, Review, RuleMatch, RunStatusEvent, S3Credentials, ScopeMetadata, ScopeParams, Sha2Algorithm, Signup, SortOrder, StorageConfig, SyncConnection, SyncDeletionPolicy, SyncMode, SyncSchedule, SyncScheduleInput, SyncStatus, SyncTriggerType, TabularEntity, TabularEntityRecord, TabularEvent, TabularEventKind, TabularHint, TabularLocation, TabularProvenance, TabularRedaction, TerminalFallback, TestWebhook, TextData, TextEntity, TextEntityRecord, TextEvent, TextEventKind, TextHint, TextLocation, TextProvenance, TextRedaction, TimeSpan, TokenExpiration, UnreadStatus, UpdateAccount, UpdateApiToken, UpdateConnection, UpdateFile, UpdateMember, UpdateNotificationSettings, UpdatePipeline, UpdatePolicy, UpdateWebhook, UpdateWorkspace, ValidationErrorDetail, Waveform, Webhook, WebhookCreated, WebhookEvent, WebhookPage, WebhookResult, WebhookStatus, Workspace, WorkspacePage, WorkspaceRole, WorkspaceSettings };
1
+ import { $ as PciDssPart, $n as AudioLocation, $r as PublicAccount, $t as InviteSent, A as PipelineRun, An as S3Credentials, Ar as TabularLocation, At as NotificationEvent, B as DateGranularity, Bn as LabelCatalog, Br as TimeSpan, Bt as UpdateNotificationSettings, C as LanguageProvenance, Cn as ConnectionSyncPage, Cr as Review, Ct as CursorPagination, D as ScopeParams, Dn as GcsCredentials, Dr as TabularEvent, Dt as MemberInvitedParams, E as ScopeMetadata, En as CreateConnection, Er as TabularEntityRecord, Et as MarkedReadStatus, F as AudioRedaction, Fn as SyncSchedule, Fr as TextEvent, Ft as PipelineRunCompletedParams, G as Label, Gn as Signup, Gr as CreateApiToken, Gt as UpdateMember, H as GdprArticle9Treatment, Hn as RegisteredRecognizer, Hr as ApiTokenPage, Ht as Member, I as ClampBucket, In as SyncScheduleInput, Ir as TextEventKind, It as PipelineRunFailedParams, J as LabelLocale, Jn as AudioEntity, Jr as Activity, Jt as Invite, K as LabelEntry, Kn as Attribution, Kr as TokenExpiration, Kt as CreateInvite, L as Color, Ln as SyncStatus, Lr as TextHint, Lt as SystemAnnouncementParams, M as PipelineRunStatus, Mn as SyncConnection, Mr as TextData, Mt as NotificationPayload, N as PipelineRunsQuery, Nn as SyncDeletionPolicy, Nr as TextEntity, Nt as NotificationSettings, O as Audit, On as LlmConfig, Or as TabularEventKind, Ot as MemberJoinedParams, P as RunStatusEvent, Pn as SyncMode, Pr as TextEntityRecord, Pt as PipelineRunAnalyzedParams, Q as ModalityRedactions, Qn as AudioHint, Qr as AccountRef, Qt as InvitePreview, R as ConfidenceThreshold, Rn as SyncTriggerType, Rr as TextLocation, Rt as SystemReportParams, S as Language, Sn as ConnectionSync, Sr as RangeOfUint, St as UpdatePipeline, T as Languages, Tn as ConnectionsQuery, Tr as TabularEntity, Tt as ConnectionSyncFailedParams, U as HipaaDeidMethod, Un as AuthToken, Ur as ApiTokenType, Ut as MemberPage, V as DateStyle, Vn as RecognizerCatalog, Vr as ApiToken, Vt as ListMembers, W as ImageRedaction, Wn as Login, Wr as ApiTokenWithJWT, Wt as MemberSortField, X as LanguageTag, Xn as AudioEvent, Xr as ActivityType, Xt as InviteExpiration, Y as Labels, Yn as AudioEntityRecord, Yr as ActivityPage, Yt as InviteCode, Z as LocalizedText, Zn as AudioEventKind, Zr as Account, Zt as InvitePage, _ as WebhookPage, _n as AnthropicCredentials, _r as OcrMode, _t as PipelineFilter, a as RetentionSettings, an as ComponentHealth, ar as EntityCoRef, at as PolicySummaryPage, b as Confidence, bn as ConnectionConfig, br as Point, bt as PipelineSummaryPage, c as WorkspacePage, cn as File, cr as ImageEntity, ct as Sha2Algorithm, d as CreateWebhook, dn as FormatToken, dr as ImageEventKind, dt as TextRedaction, ei as UpdateAccount, en as InviteSortField, er as AudioProvenance, et as PciPanRender, f as TestWebhook, fn as ListFiles, fr as ImageHint, ft as UpdatePolicy, g as WebhookEvent, gn as ValidationErrorDetail, gr as ModelEvent, gt as PipelineDefinition, h as WebhookCreated, hn as ErrorResponse, hr as LeakProfile, ht as Pipeline, i as RetentionOverride, in as SortOrder, ir as Dpi, it as PolicySummary, j as PipelineRunPage, jn as StorageConfig, jr as TabularProvenance, jt as NotificationPage, k as CreatePipelineRun, kn as OpenAiCredentials, kr as TabularHint, kt as Notification, l as WorkspaceRole, ln as FileKind, lr as ImageEntityRecord, lt as TabularRedaction, m as Webhook, mn as UpdateFile, mr as ImageProvenance, mt as CreatePipeline, n as OcrPolicy, nn as ListInvites, nr as BoundingBox, nt as PolicyDefinition, o as UpdateWorkspace, on as Health, or as EntityGroup, ot as PolicyTemplate, p as UpdateWebhook, pn as ModalityToken, pr as ImageLocation, pt as Waveform, q as LabelGroup, qn as AudioData, qr as UpdateApiToken, qt as GenerateInviteCode, r as Retention, rn as ReplyInvite, rr as Dimensions, rt as PolicyRule, s as Workspace, sn as HealthStatus, sr as ImageData, st as Predicate, t as CreateWorkspace, tn as InviteStatus, tr as AuditContext, tt as Policy, u as WorkspaceSettings, un as FilePage, ur as ImageEvent, ut as TerminalFallback, v as WebhookResult, vn as AzureCredentials, vr as OperatorId, vt as PipelineStatus, w as LanguageSpan, wn as ConnectionVerification, wr as RuleMatch, wt as ConnectionSyncCompletedParams, x as CountryCode, xn as ConnectionPage, xr as Polygon, xt as PipelineTriggerType, y as WebhookStatus, yn as Connection, yr as PatternEvent, yt as PipelineSummary, z as CreatePolicy, zn as UpdateConnection, zr as TextProvenance, zt as UnreadStatus } from "../index-BZcmqZdX.js";
2
+ export type { Account, AccountRef, Activity, ActivityPage, ActivityType, AnthropicCredentials, ApiToken, ApiTokenPage, ApiTokenType, ApiTokenWithJWT, Attribution, AudioData, AudioEntity, AudioEntityRecord, AudioEvent, AudioEventKind, AudioHint, AudioLocation, AudioProvenance, AudioRedaction, Audit, AuditContext, AuthToken, AzureCredentials, BoundingBox, ClampBucket, Color, ComponentHealth, Confidence, ConfidenceThreshold, Connection, ConnectionConfig, ConnectionPage, ConnectionSync, ConnectionSyncCompletedParams, ConnectionSyncFailedParams, ConnectionSyncPage, ConnectionVerification, ConnectionsQuery, CountryCode, CreateApiToken, CreateConnection, CreateInvite, CreatePipeline, CreatePipelineRun, CreatePolicy, CreateWebhook, CreateWorkspace, CursorPagination, DateGranularity, DateStyle, Dimensions, Dpi, EntityCoRef, EntityGroup, ErrorResponse, File, FileKind, FilePage, FormatToken, GcsCredentials, GdprArticle9Treatment, GenerateInviteCode, Health, HealthStatus, HipaaDeidMethod, ImageData, ImageEntity, ImageEntityRecord, ImageEvent, ImageEventKind, ImageHint, ImageLocation, ImageProvenance, ImageRedaction, Invite, InviteCode, InviteExpiration, InvitePage, InvitePreview, InviteSent, InviteSortField, InviteStatus, Label, LabelCatalog, LabelEntry, LabelGroup, LabelLocale, Labels, Language, LanguageProvenance, LanguageSpan, LanguageTag, Languages, LeakProfile, ListFiles, ListInvites, ListMembers, LlmConfig, LocalizedText, Login, MarkedReadStatus, Member, MemberInvitedParams, MemberJoinedParams, MemberPage, MemberSortField, ModalityRedactions, ModalityToken, ModelEvent, Notification, NotificationEvent, NotificationPage, NotificationPayload, NotificationSettings, OcrMode, OcrPolicy, OpenAiCredentials, OperatorId, PatternEvent, PciDssPart, PciPanRender, Pipeline, PipelineDefinition, PipelineFilter, PipelineRun, PipelineRunAnalyzedParams, PipelineRunCompletedParams, PipelineRunFailedParams, PipelineRunPage, PipelineRunStatus, PipelineRunsQuery, PipelineStatus, PipelineSummary, PipelineSummaryPage, PipelineTriggerType, Point, Policy, PolicyDefinition, PolicyRule, PolicySummary, PolicySummaryPage, PolicyTemplate, Polygon, Predicate, PublicAccount, RangeOfUint, RecognizerCatalog, RegisteredRecognizer, ReplyInvite, Retention, RetentionOverride, RetentionSettings, Review, RuleMatch, RunStatusEvent, S3Credentials, ScopeMetadata, ScopeParams, Sha2Algorithm, Signup, SortOrder, StorageConfig, SyncConnection, SyncDeletionPolicy, SyncMode, SyncSchedule, SyncScheduleInput, SyncStatus, SyncTriggerType, SystemAnnouncementParams, SystemReportParams, TabularEntity, TabularEntityRecord, TabularEvent, TabularEventKind, TabularHint, TabularLocation, TabularProvenance, TabularRedaction, TerminalFallback, TestWebhook, TextData, TextEntity, TextEntityRecord, TextEvent, TextEventKind, TextHint, TextLocation, TextProvenance, TextRedaction, TimeSpan, TokenExpiration, UnreadStatus, UpdateAccount, UpdateApiToken, UpdateConnection, UpdateFile, UpdateMember, UpdateNotificationSettings, UpdatePipeline, UpdatePolicy, UpdateWebhook, UpdateWorkspace, ValidationErrorDetail, Waveform, Webhook, WebhookCreated, WebhookEvent, WebhookPage, WebhookResult, WebhookStatus, Workspace, WorkspacePage, WorkspaceRole, WorkspaceSettings };
@@ -1,4 +1,4 @@
1
- import { in as ErrorResponse } from "./index-BTUYsNrz.js";
1
+ import { hn as ErrorResponse } from "./index-BZcmqZdX.js";
2
2
  //#region src/errors.d.ts
3
3
  /**
4
4
  * Base error class for all Nvisy SDK errors.
@@ -124,4 +124,4 @@ declare class NvisyApiError extends NvisyError implements ErrorResponse {
124
124
  }
125
125
  //#endregion
126
126
  export { NvisyError as n, NvisyApiError as t };
127
- //# sourceMappingURL=errors-CdauDqKP.d.ts.map
127
+ //# sourceMappingURL=errors-CW5VZYIT.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"errors-CdauDqKP.d.ts","names":[],"sources":["../src/errors.ts"],"mappings":";;;;;;;;;;;;;;;;;;;cAgCa,mBAAmB;;;;WAIf;;;;;;EAOJ,YAAA;;;;;;;;;;;;;;;;;;;;;;;;cA4BA,sBAAsB,sBAAsB;;;;WAIxC;;;;WAKA;;;;;WAMA;;;;;WAMA;;;;;WAMA,aAAa;;;;WAKb;;;;;;;EAQJ,YAAA,UAAU,eAAe;;;;;;;;;EAkBrC;;;;;;;;;EAYA;;;;;;;;;EAYA;;;;;;;;EAeA,UAAU"}
1
+ {"version":3,"file":"errors-CW5VZYIT.d.ts","names":[],"sources":["../src/errors.ts"],"mappings":";;;;;;;;;;;;;;;;;;;cAgCa,mBAAmB;;;;WAIf;;;;;;EAOJ,YAAA;;;;;;;;;;;;;;;;;;;;;;;;cA4BA,sBAAsB,sBAAsB;;;;WAIxC;;;;WAKA;;;;;WAMA;;;;;WAMA;;;;;WAMA,aAAa;;;;WAKb;;;;;;;EAQJ,YAAA,UAAU,eAAe;;;;;;;;;EAkBrC;;;;;;;;;EAYA;;;;;;;;;EAYA;;;;;;;;EAeA,UAAU"}
@@ -5845,7 +5845,7 @@ interface paths {
5845
5845
  };
5846
5846
  /**
5847
5847
  * List notifications
5848
- * @description Returns all notifications for the authenticated account and marks them as read.
5848
+ * @description Returns the authenticated account's notifications, most recent first. Read-only use POST /notifications/read/ or POST /notifications/{notificationId}/read/ to mark them read.
5849
5849
  */
5850
5850
  get: {
5851
5851
  parameters: {
@@ -5958,6 +5958,130 @@ interface paths {
5958
5958
  patch?: never;
5959
5959
  trace?: never;
5960
5960
  };
5961
+ "/notifications/read/": {
5962
+ parameters: {
5963
+ query?: never;
5964
+ header?: never;
5965
+ path?: never;
5966
+ cookie?: never;
5967
+ };
5968
+ get?: never;
5969
+ put?: never;
5970
+ /**
5971
+ * Mark all notifications as read
5972
+ * @description Marks every unread notification for the authenticated account as read and returns how many it marked.
5973
+ */
5974
+ post: {
5975
+ parameters: {
5976
+ query?: never;
5977
+ header?: never;
5978
+ path?: never;
5979
+ cookie?: never;
5980
+ };
5981
+ requestBody?: never;
5982
+ responses: {
5983
+ /** @description Response type for a mark-all-read action. */
5984
+ 200: {
5985
+ headers: {
5986
+ [name: string]: unknown;
5987
+ };
5988
+ content: {
5989
+ "application/json": components["schemas"]["MarkedReadStatus"];
5990
+ };
5991
+ };
5992
+ /**
5993
+ * @description HTTP error response representation with security-conscious design.
5994
+ *
5995
+ * This struct contains all the information needed to serialize an error
5996
+ * response, including the error name, message, HTTP status code, resource
5997
+ * information, and user-friendly messages.
5998
+ */
5999
+ 401: {
6000
+ headers: {
6001
+ [name: string]: unknown;
6002
+ };
6003
+ content: {
6004
+ "application/json": components["schemas"]["ErrorResponse"];
6005
+ };
6006
+ };
6007
+ };
6008
+ };
6009
+ delete?: never;
6010
+ options?: never;
6011
+ head?: never;
6012
+ patch?: never;
6013
+ trace?: never;
6014
+ };
6015
+ "/notifications/{notificationId}/read/": {
6016
+ parameters: {
6017
+ query?: never;
6018
+ header?: never;
6019
+ path?: never;
6020
+ cookie?: never;
6021
+ };
6022
+ get?: never;
6023
+ put?: never;
6024
+ /**
6025
+ * Mark notification as read
6026
+ * @description Marks a single notification of the authenticated account as read.
6027
+ */
6028
+ post: {
6029
+ parameters: {
6030
+ query?: never;
6031
+ header?: never;
6032
+ path: {
6033
+ /** @description Unique identifier of the notification. */
6034
+ notificationId: string;
6035
+ };
6036
+ cookie?: never;
6037
+ };
6038
+ requestBody?: never;
6039
+ responses: {
6040
+ /** @description no content */
6041
+ 204: {
6042
+ headers: {
6043
+ [name: string]: unknown;
6044
+ };
6045
+ content?: never;
6046
+ };
6047
+ /**
6048
+ * @description HTTP error response representation with security-conscious design.
6049
+ *
6050
+ * This struct contains all the information needed to serialize an error
6051
+ * response, including the error name, message, HTTP status code, resource
6052
+ * information, and user-friendly messages.
6053
+ */
6054
+ 401: {
6055
+ headers: {
6056
+ [name: string]: unknown;
6057
+ };
6058
+ content: {
6059
+ "application/json": components["schemas"]["ErrorResponse"];
6060
+ };
6061
+ };
6062
+ /**
6063
+ * @description HTTP error response representation with security-conscious design.
6064
+ *
6065
+ * This struct contains all the information needed to serialize an error
6066
+ * response, including the error name, message, HTTP status code, resource
6067
+ * information, and user-friendly messages.
6068
+ */
6069
+ 404: {
6070
+ headers: {
6071
+ [name: string]: unknown;
6072
+ };
6073
+ content: {
6074
+ "application/json": components["schemas"]["ErrorResponse"];
6075
+ };
6076
+ };
6077
+ };
6078
+ };
6079
+ delete?: never;
6080
+ options?: never;
6081
+ head?: never;
6082
+ patch?: never;
6083
+ trace?: never;
6084
+ };
5961
6085
  "/workspaces/{workspaceSlug}/invites/": {
5962
6086
  parameters: {
5963
6087
  query?: never;
@@ -8615,6 +8739,29 @@ interface components {
8615
8739
  /** @description Account that triggered the sync. */
8616
8740
  triggeredBy: components["schemas"]["AccountRef"];
8617
8741
  };
8742
+ /** @description Params of a `connection:sync.completed` notification. */
8743
+ ConnectionSyncCompletedParams: {
8744
+ /**
8745
+ * Format: uuid
8746
+ * @description Id of the connection that synced.
8747
+ */
8748
+ connectionId: string;
8749
+ /**
8750
+ * Format: int64
8751
+ * @description Number of records synced, if known.
8752
+ */
8753
+ recordsSynced?: number;
8754
+ };
8755
+ /** @description Params of a `connection:sync.failed` notification. */
8756
+ ConnectionSyncFailedParams: {
8757
+ /**
8758
+ * Format: uuid
8759
+ * @description Id of the connection that failed to sync.
8760
+ */
8761
+ connectionId: string;
8762
+ /** @description Failure reason, if available. */
8763
+ error?: string;
8764
+ };
8618
8765
  /**
8619
8766
  * @description Generic paginated response wrapper.
8620
8767
  *
@@ -9983,6 +10130,14 @@ interface components {
9983
10130
  */
9984
10131
  rememberMe: boolean;
9985
10132
  };
10133
+ /** @description Response type for a mark-all-read action. */
10134
+ MarkedReadStatus: {
10135
+ /**
10136
+ * Format: int64
10137
+ * @description Number of notifications the request marked as read.
10138
+ */
10139
+ markedRead: number;
10140
+ };
9986
10141
  /** @description Represents a workspace member. */
9987
10142
  Member: {
9988
10143
  /** @description Serve path of the member's avatar, when set. */
@@ -10003,6 +10158,20 @@ interface components {
10003
10158
  /** @description Handle of the member's account. */
10004
10159
  username: components["schemas"]["Handle"];
10005
10160
  };
10161
+ /** @description Params of a `member:invited` notification. */
10162
+ MemberInvitedParams: {
10163
+ /** @description Username of the account that sent the invite, if known. */
10164
+ invitedBy?: string;
10165
+ /** @description Slug of the workspace the account was invited to. */
10166
+ workspaceSlug: string;
10167
+ };
10168
+ /** @description Params of a `member:joined` notification. */
10169
+ MemberJoinedParams: {
10170
+ /** @description Username of the member that joined. */
10171
+ memberUsername: string;
10172
+ /** @description Slug of the workspace the member joined. */
10173
+ workspaceSlug: string;
10174
+ };
10006
10175
  /**
10007
10176
  * @description Generic paginated response wrapper.
10008
10177
  *
@@ -10063,7 +10232,12 @@ interface components {
10063
10232
  /** @description Model version string, when known. */
10064
10233
  version?: string;
10065
10234
  };
10066
- /** @description Response type for an account notification. */
10235
+ /**
10236
+ * @description Response type for an account notification.
10237
+ *
10238
+ * The typed [`NotificationPayload`] is nested under `payload`, so a notification
10239
+ * is `{ id, payload: { notifyType, <params...> }, isRead, ... }`.
10240
+ */
10067
10241
  Notification: {
10068
10242
  /**
10069
10243
  * Format: date-time
@@ -10082,32 +10256,23 @@ interface components {
10082
10256
  id: string;
10083
10257
  /** @description Whether the notification has been read. */
10084
10258
  isRead: boolean;
10085
- /** @description Notification message. */
10086
- message: string;
10087
- /** @description Notification type. */
10088
- notifyType: components["schemas"]["NotificationEvent"];
10259
+ /** @description The notification type and its typed params. */
10260
+ payload: components["schemas"]["NotificationPayload"];
10089
10261
  /**
10090
10262
  * Format: date-time
10091
10263
  * @description When the notification was read.
10092
10264
  */
10093
10265
  readAt?: string;
10094
- /**
10095
- * Format: uuid
10096
- * @description Related entity ID.
10097
- */
10098
- relatedId?: string;
10099
- /** @description Related entity type. */
10100
- relatedType?: string;
10101
- /** @description Notification title. */
10102
- title: string;
10103
10266
  };
10104
10267
  /**
10105
10268
  * @description Defines the type of notification event sent to a user.
10106
10269
  *
10107
- * This enumeration corresponds to the `NOTIFICATION_EVENT` PostgreSQL enum and is used
10108
- * for various user notifications including file, member, connection, and system events.
10270
+ * This enumeration corresponds to the `NOTIFICATION_EVENT` PostgreSQL enum and
10271
+ * is used for member, connection-sync, pipeline-run, and system notifications.
10272
+ * The values mirror the [`WebhookEvent`](super::WebhookEvent) naming for the
10273
+ * events the two channels share.
10109
10274
  */
10110
- NotificationEvent: "file:uploaded" | "file:downloaded" | "file:verified" | "member:invited" | "member:joined" | "connection:synced" | "connection:desynced" | "system:announcement" | "system:report";
10275
+ NotificationEvent: "member:invited" | "member:joined" | "connection:sync.completed" | "connection:sync.failed" | "pipeline:run.analyzed" | "pipeline:run.completed" | "pipeline:run.failed" | "system:announcement" | "system:report";
10111
10276
  /**
10112
10277
  * @description Generic paginated response wrapper.
10113
10278
  *
@@ -10126,6 +10291,55 @@ interface components {
10126
10291
  */
10127
10292
  total?: number;
10128
10293
  };
10294
+ /**
10295
+ * @description Path parameters for notification operations.
10296
+ *
10297
+ * The notification id is globally unique; account ownership is enforced in the
10298
+ * query, so a notification of another account resolves to a not-found result.
10299
+ */
10300
+ NotificationPathParams: {
10301
+ /**
10302
+ * Format: uuid
10303
+ * @description Unique identifier of the notification.
10304
+ */
10305
+ notificationId: string;
10306
+ };
10307
+ /**
10308
+ * @description The typed payload of a notification, tagged by `notifyType`.
10309
+ *
10310
+ * Each variant is one notification type carrying its own params struct. No
10311
+ * rendered text is included — the client localizes the copy from `notifyType`
10312
+ * and the params. The `notifyType` values match the `NOTIFICATION_EVENT` enum,
10313
+ * so the same key drives the member's per-event preferences.
10314
+ */
10315
+ NotificationPayload: ({
10316
+ /** @constant */
10317
+ notifyType: "member:invited";
10318
+ } & components["schemas"]["MemberInvitedParams"]) | ({
10319
+ /** @constant */
10320
+ notifyType: "member:joined";
10321
+ } & components["schemas"]["MemberJoinedParams"]) | ({
10322
+ /** @constant */
10323
+ notifyType: "connection:sync.completed";
10324
+ } & components["schemas"]["ConnectionSyncCompletedParams"]) | ({
10325
+ /** @constant */
10326
+ notifyType: "connection:sync.failed";
10327
+ } & components["schemas"]["ConnectionSyncFailedParams"]) | ({
10328
+ /** @constant */
10329
+ notifyType: "pipeline:run.analyzed";
10330
+ } & components["schemas"]["PipelineRunAnalyzedParams"]) | ({
10331
+ /** @constant */
10332
+ notifyType: "pipeline:run.completed";
10333
+ } & components["schemas"]["PipelineRunCompletedParams"]) | ({
10334
+ /** @constant */
10335
+ notifyType: "pipeline:run.failed";
10336
+ } & components["schemas"]["PipelineRunFailedParams"]) | ({
10337
+ /** @constant */
10338
+ notifyType: "system:announcement";
10339
+ } & components["schemas"]["SystemAnnouncementParams"]) | ({
10340
+ /** @constant */
10341
+ notifyType: "system:report";
10342
+ } & components["schemas"]["SystemReportParams"]);
10129
10343
  /** @description Response for notification settings within a workspace. */
10130
10344
  NotificationSettings: {
10131
10345
  /** @description Notification events to receive in-app. */
@@ -10350,6 +10564,11 @@ interface components {
10350
10564
  * @description Source document this run analyzes / redacts.
10351
10565
  */
10352
10566
  inputFileId: string;
10567
+ /**
10568
+ * @description Display name of the source document, for showing the run without a
10569
+ * separate file lookup. `None` if the file was removed (e.g. by retention).
10570
+ */
10571
+ inputFileName?: string;
10353
10572
  /** @description Non-encrypted metadata for filtering/display. */
10354
10573
  metadata: unknown;
10355
10574
  /**
@@ -10357,6 +10576,8 @@ interface components {
10357
10576
  * @description Redacted document produced by the run, once it completes.
10358
10577
  */
10359
10578
  outputFileId?: string;
10579
+ /** @description Display name of the redacted output, once the run completes. */
10580
+ outputFileName?: string;
10360
10581
  /** @description Handle of the pipeline this run belongs to. */
10361
10582
  pipelineSlug: components["schemas"]["Handle"];
10362
10583
  /**
@@ -10378,6 +10599,44 @@ interface components {
10378
10599
  /** @description Handle of the workspace this run belongs to. */
10379
10600
  workspaceSlug: components["schemas"]["Handle"];
10380
10601
  };
10602
+ /** @description Params of a `pipeline:run.analyzed` notification. */
10603
+ PipelineRunAnalyzedParams: {
10604
+ /** @description Display name of the analyzed file, if known. */
10605
+ inputFileName?: string;
10606
+ /** @description Slug of the owning pipeline. */
10607
+ pipelineSlug: string;
10608
+ /**
10609
+ * Format: uuid
10610
+ * @description Id of the run.
10611
+ */
10612
+ runId: string;
10613
+ };
10614
+ /** @description Params of a `pipeline:run.completed` notification. */
10615
+ PipelineRunCompletedParams: {
10616
+ /** @description Display name of the analyzed file, if known. */
10617
+ inputFileName?: string;
10618
+ /** @description Slug of the owning pipeline. */
10619
+ pipelineSlug: string;
10620
+ /**
10621
+ * Format: uuid
10622
+ * @description Id of the run.
10623
+ */
10624
+ runId: string;
10625
+ };
10626
+ /** @description Params of a `pipeline:run.failed` notification. */
10627
+ PipelineRunFailedParams: {
10628
+ /** @description Failure reason, if available. */
10629
+ error?: string;
10630
+ /** @description Display name of the analyzed file, if known. */
10631
+ inputFileName?: string;
10632
+ /** @description Slug of the owning pipeline. */
10633
+ pipelineSlug: string;
10634
+ /**
10635
+ * Format: uuid
10636
+ * @description Id of the run.
10637
+ */
10638
+ runId: string;
10639
+ };
10381
10640
  /**
10382
10641
  * @description Generic paginated response wrapper.
10383
10642
  *
@@ -11300,6 +11559,19 @@ interface components {
11300
11559
  * to track whether a run was manually triggered, scheduled, or triggered by a webhook.
11301
11560
  */
11302
11561
  SyncTriggerType: "manual" | "scheduled" | "webhook";
11562
+ /** @description Params of a `system:announcement` notification. */
11563
+ SystemAnnouncementParams: {
11564
+ /** @description Announcement message key or body. */
11565
+ message: string;
11566
+ };
11567
+ /** @description Params of a `system:report` notification. */
11568
+ SystemReportParams: {
11569
+ /**
11570
+ * Format: uuid
11571
+ * @description Id of the generated report, if any.
11572
+ */
11573
+ reportId?: string;
11574
+ };
11303
11575
  /**
11304
11576
  * @description Detected piece of sensitive information within some medium.
11305
11577
  *
@@ -12844,6 +13116,17 @@ type NotificationSettings = Schemas$7["NotificationSettings"];
12844
13116
  type UpdateNotificationSettings = Schemas$7["UpdateNotificationSettings"];
12845
13117
  type UnreadStatus = Schemas$7["UnreadStatus"];
12846
13118
  type NotificationPage = Schemas$7["NotificationPage"];
13119
+ type MarkedReadStatus = Schemas$7["MarkedReadStatus"];
13120
+ type NotificationPayload = Schemas$7["NotificationPayload"];
13121
+ type MemberInvitedParams = Schemas$7["MemberInvitedParams"];
13122
+ type MemberJoinedParams = Schemas$7["MemberJoinedParams"];
13123
+ type ConnectionSyncCompletedParams = Schemas$7["ConnectionSyncCompletedParams"];
13124
+ type ConnectionSyncFailedParams = Schemas$7["ConnectionSyncFailedParams"];
13125
+ type PipelineRunAnalyzedParams = Schemas$7["PipelineRunAnalyzedParams"];
13126
+ type PipelineRunCompletedParams = Schemas$7["PipelineRunCompletedParams"];
13127
+ type PipelineRunFailedParams = Schemas$7["PipelineRunFailedParams"];
13128
+ type SystemAnnouncementParams = Schemas$7["SystemAnnouncementParams"];
13129
+ type SystemReportParams = Schemas$7["SystemReportParams"];
12847
13130
  //#endregion
12848
13131
  //#region src/datatypes/pagination.d.ts
12849
13132
  type Schemas$6 = components["schemas"];
@@ -12943,5 +13226,5 @@ type Retention = Schemas["Retention"];
12943
13226
  type RetentionSettings = Schemas["RetentionSettings"];
12944
13227
  type RetentionOverride = Schemas["RetentionOverride"];
12945
13228
  //#endregion
12946
- export { PciDssPart as $, ImageEvent as $n, FilePage as $t, PipelineRun as A, RecognizerCatalog as An, ApiToken as Ar, ListMembers as At, DateGranularity as B, AudioEventKind as Bn, Account as Br, InvitePage as Bt, LanguageProvenance as C, SyncMode as Cn, TextEntityRecord as Cr, CursorPagination as Ct, ScopeParams as D, SyncTriggerType as Dn, TextLocation as Dr, NotificationSettings as Dt, ScopeMetadata as E, SyncStatus as En, TextHint as Er, NotificationPage as Et, AudioRedaction as F, Attribution as Fn, TokenExpiration as Fr, CreateInvite as Ft, Label as G, BoundingBox as Gn, ListInvites as Gt, GdprArticle9Treatment as H, AudioLocation as Hn, PublicAccount as Hr, InviteSent as Ht, ClampBucket as I, AudioData as In, UpdateApiToken as Ir, GenerateInviteCode as It, LabelLocale as J, EntityCoRef as Jn, ComponentHealth as Jt, LabelEntry as K, Dimensions as Kn, ReplyInvite as Kt, Color as L, AudioEntity as Ln, Activity as Lr, Invite as Lt, PipelineRunStatus as M, AuthToken as Mn, ApiTokenType as Mr, MemberPage as Mt, PipelineRunsQuery as N, Login as Nn, ApiTokenWithJWT as Nr, MemberSortField as Nt, Audit as O, UpdateConnection as On, TextProvenance as Or, UnreadStatus as Ot, RunStatusEvent as P, Signup as Pn, CreateApiToken as Pr, UpdateMember as Pt, ModalityRedactions as Q, ImageEntityRecord as Qn, FileKind as Qt, ConfidenceThreshold as R, AudioEntityRecord as Rn, ActivityPage as Rr, InviteCode as Rt, Language as S, SyncDeletionPolicy as Sn, TextEntity as Sr, UpdatePipeline as St, Languages as T, SyncScheduleInput as Tn, TextEventKind as Tr, NotificationEvent as Tt, HipaaDeidMethod as U, AudioProvenance as Un, UpdateAccount as Ur, InviteSortField as Ut, DateStyle as V, AudioHint as Vn, AccountRef as Vr, InvitePreview as Vt, ImageRedaction as W, AuditContext as Wn, paths as Wr, InviteStatus as Wt, LanguageTag as X, ImageData as Xn, HealthStatus as Xt, Labels as Y, EntityGroup as Yn, Health as Yt, LocalizedText as Z, ImageEntity as Zn, File as Zt, WebhookPage as _, LlmConfig as _n, TabularEventKind as _r, PipelineFilter as _t, RetentionSettings as a, ValidationErrorDetail as an, ModelEvent as ar, PolicySummaryPage as at, Confidence as b, StorageConfig as bn, TabularProvenance as br, PipelineSummaryPage as bt, WorkspacePage as c, Connection as cn, PatternEvent as cr, Sha2Algorithm as ct, CreateWebhook as d, ConnectionSync as dn, RangeOfUint as dr, TextRedaction as dt, FormatToken as en, ImageEventKind as er, PciPanRender as et, TestWebhook as f, ConnectionSyncPage as fn, Review as fr, UpdatePolicy as ft, WebhookEvent as g, GcsCredentials as gn, TabularEvent as gr, PipelineDefinition as gt, WebhookCreated as h, CreateConnection as hn, TabularEntityRecord as hr, Pipeline as ht, RetentionOverride as i, ErrorResponse as in, LeakProfile as ir, PolicySummary as it, PipelineRunPage as j, RegisteredRecognizer as jn, ApiTokenPage as jr, Member as jt, CreatePipelineRun as k, LabelCatalog as kn, TimeSpan as kr, UpdateNotificationSettings as kt, WorkspaceRole as l, ConnectionConfig as ln, Point as lr, TabularRedaction as lt, Webhook as m, ConnectionsQuery as mn, TabularEntity as mr, CreatePipeline as mt, OcrPolicy as n, ModalityToken as nn, ImageLocation as nr, PolicyDefinition as nt, UpdateWorkspace as o, AnthropicCredentials as on, OcrMode as or, PolicyTemplate as ot, UpdateWebhook as p, ConnectionVerification as pn, RuleMatch as pr, Waveform as pt, LabelGroup as q, Dpi as qn, SortOrder as qt, Retention as r, UpdateFile as rn, ImageProvenance as rr, PolicyRule as rt, Workspace as s, AzureCredentials as sn, OperatorId as sr, Predicate as st, CreateWorkspace as t, ListFiles as tn, ImageHint as tr, Policy as tt, WorkspaceSettings as u, ConnectionPage as un, Polygon as ur, TerminalFallback as ut, WebhookResult as v, OpenAiCredentials as vn, TabularHint as vr, PipelineStatus as vt, LanguageSpan as w, SyncSchedule as wn, TextEvent as wr, Notification as wt, CountryCode as x, SyncConnection as xn, TextData as xr, PipelineTriggerType as xt, WebhookStatus as y, S3Credentials as yn, TabularLocation as yr, PipelineSummary as yt, CreatePolicy as z, AudioEvent as zn, ActivityType as zr, InviteExpiration as zt };
12947
- //# sourceMappingURL=index-BTUYsNrz.d.ts.map
13229
+ export { PciDssPart as $, AudioLocation as $n, PublicAccount as $r, InviteSent as $t, PipelineRun as A, S3Credentials as An, TabularLocation as Ar, NotificationEvent as At, DateGranularity as B, LabelCatalog as Bn, TimeSpan as Br, UpdateNotificationSettings as Bt, LanguageProvenance as C, ConnectionSyncPage as Cn, Review as Cr, CursorPagination as Ct, ScopeParams as D, GcsCredentials as Dn, TabularEvent as Dr, MemberInvitedParams as Dt, ScopeMetadata as E, CreateConnection as En, TabularEntityRecord as Er, MarkedReadStatus as Et, AudioRedaction as F, SyncSchedule as Fn, TextEvent as Fr, PipelineRunCompletedParams as Ft, Label as G, Signup as Gn, CreateApiToken as Gr, UpdateMember as Gt, GdprArticle9Treatment as H, RegisteredRecognizer as Hn, ApiTokenPage as Hr, Member as Ht, ClampBucket as I, SyncScheduleInput as In, TextEventKind as Ir, PipelineRunFailedParams as It, LabelLocale as J, AudioEntity as Jn, Activity as Jr, Invite as Jt, LabelEntry as K, Attribution as Kn, TokenExpiration as Kr, CreateInvite as Kt, Color as L, SyncStatus as Ln, TextHint as Lr, SystemAnnouncementParams as Lt, PipelineRunStatus as M, SyncConnection as Mn, TextData as Mr, NotificationPayload as Mt, PipelineRunsQuery as N, SyncDeletionPolicy as Nn, TextEntity as Nr, NotificationSettings as Nt, Audit as O, LlmConfig as On, TabularEventKind as Or, MemberJoinedParams as Ot, RunStatusEvent as P, SyncMode as Pn, TextEntityRecord as Pr, PipelineRunAnalyzedParams as Pt, ModalityRedactions as Q, AudioHint as Qn, AccountRef as Qr, InvitePreview as Qt, ConfidenceThreshold as R, SyncTriggerType as Rn, TextLocation as Rr, SystemReportParams as Rt, Language as S, ConnectionSync as Sn, RangeOfUint as Sr, UpdatePipeline as St, Languages as T, ConnectionsQuery as Tn, TabularEntity as Tr, ConnectionSyncFailedParams as Tt, HipaaDeidMethod as U, AuthToken as Un, ApiTokenType as Ur, MemberPage as Ut, DateStyle as V, RecognizerCatalog as Vn, ApiToken as Vr, ListMembers as Vt, ImageRedaction as W, Login as Wn, ApiTokenWithJWT as Wr, MemberSortField as Wt, LanguageTag as X, AudioEvent as Xn, ActivityType as Xr, InviteExpiration as Xt, Labels as Y, AudioEntityRecord as Yn, ActivityPage as Yr, InviteCode as Yt, LocalizedText as Z, AudioEventKind as Zn, Account as Zr, InvitePage as Zt, WebhookPage as _, AnthropicCredentials as _n, OcrMode as _r, PipelineFilter as _t, RetentionSettings as a, ComponentHealth as an, EntityCoRef as ar, PolicySummaryPage as at, Confidence as b, ConnectionConfig as bn, Point as br, PipelineSummaryPage as bt, WorkspacePage as c, File as cn, ImageEntity as cr, Sha2Algorithm as ct, CreateWebhook as d, FormatToken as dn, ImageEventKind as dr, TextRedaction as dt, UpdateAccount as ei, InviteSortField as en, AudioProvenance as er, PciPanRender as et, TestWebhook as f, ListFiles as fn, ImageHint as fr, UpdatePolicy as ft, WebhookEvent as g, ValidationErrorDetail as gn, ModelEvent as gr, PipelineDefinition as gt, WebhookCreated as h, ErrorResponse as hn, LeakProfile as hr, Pipeline as ht, RetentionOverride as i, SortOrder as in, Dpi as ir, PolicySummary as it, PipelineRunPage as j, StorageConfig as jn, TabularProvenance as jr, NotificationPage as jt, CreatePipelineRun as k, OpenAiCredentials as kn, TabularHint as kr, Notification as kt, WorkspaceRole as l, FileKind as ln, ImageEntityRecord as lr, TabularRedaction as lt, Webhook as m, UpdateFile as mn, ImageProvenance as mr, CreatePipeline as mt, OcrPolicy as n, ListInvites as nn, BoundingBox as nr, PolicyDefinition as nt, UpdateWorkspace as o, Health as on, EntityGroup as or, PolicyTemplate as ot, UpdateWebhook as p, ModalityToken as pn, ImageLocation as pr, Waveform as pt, LabelGroup as q, AudioData as qn, UpdateApiToken as qr, GenerateInviteCode as qt, Retention as r, ReplyInvite as rn, Dimensions as rr, PolicyRule as rt, Workspace as s, HealthStatus as sn, ImageData as sr, Predicate as st, CreateWorkspace as t, paths as ti, InviteStatus as tn, AuditContext as tr, Policy as tt, WorkspaceSettings as u, FilePage as un, ImageEvent as ur, TerminalFallback as ut, WebhookResult as v, AzureCredentials as vn, OperatorId as vr, PipelineStatus as vt, LanguageSpan as w, ConnectionVerification as wn, RuleMatch as wr, ConnectionSyncCompletedParams as wt, CountryCode as x, ConnectionPage as xn, Polygon as xr, PipelineTriggerType as xt, WebhookStatus as y, Connection as yn, PatternEvent as yr, PipelineSummary as yt, CreatePolicy as z, UpdateConnection as zn, TextProvenance as zr, UnreadStatus as zt };
13230
+ //# sourceMappingURL=index-BZcmqZdX.d.ts.map