@nvisy/sdk 0.24.0 → 0.25.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 +30 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/{client-F-V1vFos.d.ts → client-JKhRcvSu.d.ts} +28 -4
- package/dist/client-JKhRcvSu.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{errors-CW5VZYIT.d.ts → errors-BXs-KAXs.d.ts} +2 -2
- package/dist/{errors-CW5VZYIT.d.ts.map → errors-BXs-KAXs.d.ts.map} +1 -1
- package/dist/{index-BZcmqZdX.d.ts → index-Cijg5CMy.d.ts} +306 -59
- package/dist/{index-BZcmqZdX.d.ts.map → index-Cijg5CMy.d.ts.map} +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/services/index.d.ts +1 -1
- package/dist/services/index.js +1 -1
- package/dist/{services-CcLCLGws.js → services-CcdXk5hx.js} +89 -58
- package/dist/services-CcdXk5hx.js.map +1 -0
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +1 -1
- package/dist/client-F-V1vFos.d.ts.map +0 -1
- package/dist/services-CcLCLGws.js.map +0 -1
|
@@ -5958,6 +5958,60 @@ interface paths {
|
|
|
5958
5958
|
patch?: never;
|
|
5959
5959
|
trace?: never;
|
|
5960
5960
|
};
|
|
5961
|
+
"/notifications/unread/events/": {
|
|
5962
|
+
parameters: {
|
|
5963
|
+
query?: never;
|
|
5964
|
+
header?: never;
|
|
5965
|
+
path?: never;
|
|
5966
|
+
cookie?: never;
|
|
5967
|
+
};
|
|
5968
|
+
/**
|
|
5969
|
+
* Stream unread notifications count
|
|
5970
|
+
* @description Opens a Server-Sent Events stream of the account's unread notification count. Emits the current count immediately, then each change as notifications arrive or are marked read, until the client disconnects. Each event's `data` is an `UnreadCountEvent` (see the response schema). Authenticate with a Bearer token via a `fetch`-based client; the native `EventSource` cannot send an `Authorization` header.
|
|
5971
|
+
*/
|
|
5972
|
+
get: {
|
|
5973
|
+
parameters: {
|
|
5974
|
+
query?: never;
|
|
5975
|
+
header?: never;
|
|
5976
|
+
path?: never;
|
|
5977
|
+
cookie?: never;
|
|
5978
|
+
};
|
|
5979
|
+
requestBody?: never;
|
|
5980
|
+
responses: {
|
|
5981
|
+
/** @description Server-sent event stream; each event's `data` is the payload below. */
|
|
5982
|
+
200: {
|
|
5983
|
+
headers: {
|
|
5984
|
+
[name: string]: unknown;
|
|
5985
|
+
};
|
|
5986
|
+
content: {
|
|
5987
|
+
"text/event-stream": components["schemas"]["UnreadCountEvent"];
|
|
5988
|
+
};
|
|
5989
|
+
};
|
|
5990
|
+
/**
|
|
5991
|
+
* @description HTTP error response representation with security-conscious design.
|
|
5992
|
+
*
|
|
5993
|
+
* This struct contains all the information needed to serialize an error
|
|
5994
|
+
* response, including the error name, message, HTTP status code, resource
|
|
5995
|
+
* information, and user-friendly messages.
|
|
5996
|
+
*/
|
|
5997
|
+
401: {
|
|
5998
|
+
headers: {
|
|
5999
|
+
[name: string]: unknown;
|
|
6000
|
+
};
|
|
6001
|
+
content: {
|
|
6002
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6003
|
+
};
|
|
6004
|
+
};
|
|
6005
|
+
};
|
|
6006
|
+
};
|
|
6007
|
+
put?: never;
|
|
6008
|
+
post?: never;
|
|
6009
|
+
delete?: never;
|
|
6010
|
+
options?: never;
|
|
6011
|
+
head?: never;
|
|
6012
|
+
patch?: never;
|
|
6013
|
+
trace?: never;
|
|
6014
|
+
};
|
|
5961
6015
|
"/notifications/read/": {
|
|
5962
6016
|
parameters: {
|
|
5963
6017
|
query?: never;
|
|
@@ -7688,13 +7742,6 @@ interface paths {
|
|
|
7688
7742
|
};
|
|
7689
7743
|
requestBody?: never;
|
|
7690
7744
|
responses: {
|
|
7691
|
-
/** @description no content */
|
|
7692
|
-
200: {
|
|
7693
|
-
headers: {
|
|
7694
|
-
[name: string]: unknown;
|
|
7695
|
-
};
|
|
7696
|
-
content?: never;
|
|
7697
|
-
};
|
|
7698
7745
|
/**
|
|
7699
7746
|
* @description HTTP error response representation with security-conscious design.
|
|
7700
7747
|
*
|
|
@@ -7745,13 +7792,6 @@ interface paths {
|
|
|
7745
7792
|
};
|
|
7746
7793
|
requestBody?: never;
|
|
7747
7794
|
responses: {
|
|
7748
|
-
/** @description no content */
|
|
7749
|
-
200: {
|
|
7750
|
-
headers: {
|
|
7751
|
-
[name: string]: unknown;
|
|
7752
|
-
};
|
|
7753
|
-
content?: never;
|
|
7754
|
-
};
|
|
7755
7795
|
/**
|
|
7756
7796
|
* @description HTTP error response representation with security-conscious design.
|
|
7757
7797
|
*
|
|
@@ -7832,22 +7872,28 @@ interface components {
|
|
|
7832
7872
|
/** @description Handle of the account. */
|
|
7833
7873
|
username: components["schemas"]["Handle"];
|
|
7834
7874
|
};
|
|
7835
|
-
/**
|
|
7875
|
+
/**
|
|
7876
|
+
* @description Response type for a workspace activity.
|
|
7877
|
+
*
|
|
7878
|
+
* The typed payload is nested under `payload`, so an activity is
|
|
7879
|
+
* `{ id, workspaceSlug, performedBy, payload: { activityType, <params...> }, createdAt }`.
|
|
7880
|
+
*/
|
|
7836
7881
|
Activity: {
|
|
7837
|
-
/** @description Type of activity. */
|
|
7838
|
-
activityType: components["schemas"]["ActivityType"];
|
|
7839
7882
|
/**
|
|
7840
7883
|
* Format: date-time
|
|
7841
7884
|
* @description When the activity occurred.
|
|
7842
7885
|
*/
|
|
7843
7886
|
createdAt: string;
|
|
7844
|
-
/** @description Human-readable description. */
|
|
7845
|
-
description: string;
|
|
7846
7887
|
/**
|
|
7847
7888
|
* Format: uuid
|
|
7848
7889
|
* @description Unique activity identifier.
|
|
7849
7890
|
*/
|
|
7850
7891
|
id: string;
|
|
7892
|
+
/**
|
|
7893
|
+
* @description The activity type and its typed params, absent when the stored params do
|
|
7894
|
+
* not decode into their `activityType`.
|
|
7895
|
+
*/
|
|
7896
|
+
payload?: components["schemas"]["ActivityPayload"];
|
|
7851
7897
|
/** @description Account that performed the activity. */
|
|
7852
7898
|
performedBy: components["schemas"]["AccountRef"];
|
|
7853
7899
|
/** @description Handle of the workspace this activity belongs to. */
|
|
@@ -7872,13 +7918,112 @@ interface components {
|
|
|
7872
7918
|
total?: number;
|
|
7873
7919
|
};
|
|
7874
7920
|
/**
|
|
7875
|
-
* @description
|
|
7921
|
+
* @description The typed payload of an audit-log activity, tagged by `activityType`.
|
|
7876
7922
|
*
|
|
7877
|
-
*
|
|
7878
|
-
*
|
|
7879
|
-
*
|
|
7923
|
+
* Each variant is one activity type carrying its own params. No rendered text is
|
|
7924
|
+
* included — the client localizes the copy from `activityType` and the params.
|
|
7925
|
+
* The `activityType` values match the `ACTIVITY_TYPE` enum.
|
|
7880
7926
|
*/
|
|
7881
|
-
|
|
7927
|
+
ActivityPayload: ({
|
|
7928
|
+
/** @constant */
|
|
7929
|
+
activityType: "workspace.created";
|
|
7930
|
+
} & components["schemas"]["WorkspaceActivityParams"]) | ({
|
|
7931
|
+
/** @constant */
|
|
7932
|
+
activityType: "workspace.updated";
|
|
7933
|
+
} & components["schemas"]["WorkspaceActivityParams"]) | ({
|
|
7934
|
+
/** @constant */
|
|
7935
|
+
activityType: "workspace.deleted";
|
|
7936
|
+
} & components["schemas"]["WorkspaceActivityParams"]) | ({
|
|
7937
|
+
/** @constant */
|
|
7938
|
+
activityType: "member.added";
|
|
7939
|
+
} & components["schemas"]["MemberActivityParams"]) | ({
|
|
7940
|
+
/** @constant */
|
|
7941
|
+
activityType: "member.updated";
|
|
7942
|
+
} & components["schemas"]["MemberActivityParams"]) | ({
|
|
7943
|
+
/** @constant */
|
|
7944
|
+
activityType: "member.deleted";
|
|
7945
|
+
} & components["schemas"]["MemberActivityParams"]) | ({
|
|
7946
|
+
/** @constant */
|
|
7947
|
+
activityType: "invite.created";
|
|
7948
|
+
} & components["schemas"]["InviteActivityParams"]) | ({
|
|
7949
|
+
/** @constant */
|
|
7950
|
+
activityType: "invite.accepted";
|
|
7951
|
+
} & components["schemas"]["InviteActivityParams"]) | ({
|
|
7952
|
+
/** @constant */
|
|
7953
|
+
activityType: "invite.declined";
|
|
7954
|
+
} & components["schemas"]["InviteActivityParams"]) | ({
|
|
7955
|
+
/** @constant */
|
|
7956
|
+
activityType: "invite.canceled";
|
|
7957
|
+
} & components["schemas"]["InviteActivityParams"]) | ({
|
|
7958
|
+
/** @constant */
|
|
7959
|
+
activityType: "connection.created";
|
|
7960
|
+
} & components["schemas"]["ConnectionActivityParams"]) | ({
|
|
7961
|
+
/** @constant */
|
|
7962
|
+
activityType: "connection.updated";
|
|
7963
|
+
} & components["schemas"]["ConnectionActivityParams"]) | ({
|
|
7964
|
+
/** @constant */
|
|
7965
|
+
activityType: "connection.deleted";
|
|
7966
|
+
} & components["schemas"]["ConnectionActivityParams"]) | ({
|
|
7967
|
+
/** @constant */
|
|
7968
|
+
activityType: "connection.sync.completed";
|
|
7969
|
+
} & components["schemas"]["ConnectionActivityParams"]) | ({
|
|
7970
|
+
/** @constant */
|
|
7971
|
+
activityType: "connection.sync.failed";
|
|
7972
|
+
} & components["schemas"]["ConnectionActivityParams"]) | ({
|
|
7973
|
+
/** @constant */
|
|
7974
|
+
activityType: "webhook.created";
|
|
7975
|
+
} & components["schemas"]["WebhookActivityParams"]) | ({
|
|
7976
|
+
/** @constant */
|
|
7977
|
+
activityType: "webhook.updated";
|
|
7978
|
+
} & components["schemas"]["WebhookActivityParams"]) | ({
|
|
7979
|
+
/** @constant */
|
|
7980
|
+
activityType: "webhook.deleted";
|
|
7981
|
+
} & components["schemas"]["WebhookActivityParams"]) | ({
|
|
7982
|
+
/** @constant */
|
|
7983
|
+
activityType: "webhook.triggered";
|
|
7984
|
+
} & components["schemas"]["WebhookActivityParams"]) | ({
|
|
7985
|
+
/** @constant */
|
|
7986
|
+
activityType: "file.created";
|
|
7987
|
+
} & components["schemas"]["FileActivityParams"]) | ({
|
|
7988
|
+
/** @constant */
|
|
7989
|
+
activityType: "file.updated";
|
|
7990
|
+
} & components["schemas"]["FileActivityParams"]) | ({
|
|
7991
|
+
/** @constant */
|
|
7992
|
+
activityType: "file.deleted";
|
|
7993
|
+
} & components["schemas"]["FileActivityParams"]) | ({
|
|
7994
|
+
/** @constant */
|
|
7995
|
+
activityType: "file.verified";
|
|
7996
|
+
} & components["schemas"]["FileActivityParams"]) | ({
|
|
7997
|
+
/** @constant */
|
|
7998
|
+
activityType: "pipeline.created";
|
|
7999
|
+
} & components["schemas"]["PipelineActivityParams"]) | ({
|
|
8000
|
+
/** @constant */
|
|
8001
|
+
activityType: "pipeline.updated";
|
|
8002
|
+
} & components["schemas"]["PipelineActivityParams"]) | ({
|
|
8003
|
+
/** @constant */
|
|
8004
|
+
activityType: "pipeline.deleted";
|
|
8005
|
+
} & components["schemas"]["PipelineActivityParams"]) | ({
|
|
8006
|
+
/** @constant */
|
|
8007
|
+
activityType: "pipeline.run.started";
|
|
8008
|
+
} & components["schemas"]["PipelineRunActivityParams"]) | ({
|
|
8009
|
+
/** @constant */
|
|
8010
|
+
activityType: "pipeline.run.analyzed";
|
|
8011
|
+
} & components["schemas"]["PipelineRunActivityParams"]) | ({
|
|
8012
|
+
/** @constant */
|
|
8013
|
+
activityType: "pipeline.run.completed";
|
|
8014
|
+
} & components["schemas"]["PipelineRunActivityParams"]) | ({
|
|
8015
|
+
/** @constant */
|
|
8016
|
+
activityType: "pipeline.run.failed";
|
|
8017
|
+
} & components["schemas"]["PipelineRunActivityParams"]) | ({
|
|
8018
|
+
/** @constant */
|
|
8019
|
+
activityType: "policy.created";
|
|
8020
|
+
} & components["schemas"]["PolicyActivityParams"]) | ({
|
|
8021
|
+
/** @constant */
|
|
8022
|
+
activityType: "policy.updated";
|
|
8023
|
+
} & components["schemas"]["PolicyActivityParams"]) | ({
|
|
8024
|
+
/** @constant */
|
|
8025
|
+
activityType: "policy.deleted";
|
|
8026
|
+
} & components["schemas"]["PolicyActivityParams"]);
|
|
7882
8027
|
/** @description Anthropic API credentials. */
|
|
7883
8028
|
AnthropicCredentials: {
|
|
7884
8029
|
/** @description Anthropic API key. */
|
|
@@ -8662,6 +8807,14 @@ interface components {
|
|
|
8662
8807
|
/** @description Handle of the workspace this connection belongs to. */
|
|
8663
8808
|
workspaceSlug: components["schemas"]["Handle"];
|
|
8664
8809
|
};
|
|
8810
|
+
/** @description Params of a connection activity (`connection.*`). */
|
|
8811
|
+
ConnectionActivityParams: {
|
|
8812
|
+
/**
|
|
8813
|
+
* Format: uuid
|
|
8814
|
+
* @description Id of the connection.
|
|
8815
|
+
*/
|
|
8816
|
+
connectionId: string;
|
|
8817
|
+
};
|
|
8665
8818
|
/**
|
|
8666
8819
|
* @description A fully-typed connection configuration for any capability.
|
|
8667
8820
|
*
|
|
@@ -8739,7 +8892,7 @@ interface components {
|
|
|
8739
8892
|
/** @description Account that triggered the sync. */
|
|
8740
8893
|
triggeredBy: components["schemas"]["AccountRef"];
|
|
8741
8894
|
};
|
|
8742
|
-
/** @description Params of a `connection
|
|
8895
|
+
/** @description Params of a `connection.sync.completed` notification. */
|
|
8743
8896
|
ConnectionSyncCompletedParams: {
|
|
8744
8897
|
/**
|
|
8745
8898
|
* Format: uuid
|
|
@@ -8752,7 +8905,7 @@ interface components {
|
|
|
8752
8905
|
*/
|
|
8753
8906
|
recordsSynced?: number;
|
|
8754
8907
|
};
|
|
8755
|
-
/** @description Params of a `connection
|
|
8908
|
+
/** @description Params of a `connection.sync.failed` notification. */
|
|
8756
8909
|
ConnectionSyncFailedParams: {
|
|
8757
8910
|
/**
|
|
8758
8911
|
* Format: uuid
|
|
@@ -9163,6 +9316,16 @@ interface components {
|
|
|
9163
9316
|
/** @description Handle of the workspace this file belongs to. */
|
|
9164
9317
|
workspaceSlug: components["schemas"]["Handle"];
|
|
9165
9318
|
};
|
|
9319
|
+
/** @description Params of a file activity (`file.*`). */
|
|
9320
|
+
FileActivityParams: {
|
|
9321
|
+
/**
|
|
9322
|
+
* Format: uuid
|
|
9323
|
+
* @description Id of the file.
|
|
9324
|
+
*/
|
|
9325
|
+
fileId: string;
|
|
9326
|
+
/** @description Display name of the file. */
|
|
9327
|
+
fileName: string;
|
|
9328
|
+
};
|
|
9166
9329
|
/**
|
|
9167
9330
|
* @description The role a file plays, which drives its data-retention scope and whether it
|
|
9168
9331
|
* is a user-facing document.
|
|
@@ -9679,6 +9842,16 @@ interface components {
|
|
|
9679
9842
|
/** @description Handle of the workspace the invitation is for. */
|
|
9680
9843
|
workspaceSlug: components["schemas"]["Handle"];
|
|
9681
9844
|
};
|
|
9845
|
+
/** @description Params of an invite activity (`invite.*`). */
|
|
9846
|
+
InviteActivityParams: {
|
|
9847
|
+
/** @description Email the invite was addressed to. */
|
|
9848
|
+
email: string;
|
|
9849
|
+
/**
|
|
9850
|
+
* Format: uuid
|
|
9851
|
+
* @description Id of the invite.
|
|
9852
|
+
*/
|
|
9853
|
+
inviteId: string;
|
|
9854
|
+
};
|
|
9682
9855
|
/** @description Response containing a generated shareable invite code. */
|
|
9683
9856
|
InviteCode: {
|
|
9684
9857
|
/**
|
|
@@ -10158,14 +10331,19 @@ interface components {
|
|
|
10158
10331
|
/** @description Handle of the member's account. */
|
|
10159
10332
|
username: components["schemas"]["Handle"];
|
|
10160
10333
|
};
|
|
10161
|
-
/** @description Params of a `member
|
|
10334
|
+
/** @description Params of a member activity (`member.*`). */
|
|
10335
|
+
MemberActivityParams: {
|
|
10336
|
+
/** @description Username of the member acted on. */
|
|
10337
|
+
memberUsername: components["schemas"]["Handle"];
|
|
10338
|
+
};
|
|
10339
|
+
/** @description Params of a `member.invited` notification. */
|
|
10162
10340
|
MemberInvitedParams: {
|
|
10163
10341
|
/** @description Username of the account that sent the invite, if known. */
|
|
10164
10342
|
invitedBy?: string;
|
|
10165
10343
|
/** @description Slug of the workspace the account was invited to. */
|
|
10166
10344
|
workspaceSlug: string;
|
|
10167
10345
|
};
|
|
10168
|
-
/** @description Params of a `member
|
|
10346
|
+
/** @description Params of a `member.joined` notification. */
|
|
10169
10347
|
MemberJoinedParams: {
|
|
10170
10348
|
/** @description Username of the member that joined. */
|
|
10171
10349
|
memberUsername: string;
|
|
@@ -10235,8 +10413,8 @@ interface components {
|
|
|
10235
10413
|
/**
|
|
10236
10414
|
* @description Response type for an account notification.
|
|
10237
10415
|
*
|
|
10238
|
-
* The typed
|
|
10239
|
-
*
|
|
10416
|
+
* The typed payload is nested under `payload`, so a notification is
|
|
10417
|
+
* `{ id, payload: { notifyType, <params...> }, readAt, ... }`.
|
|
10240
10418
|
*/
|
|
10241
10419
|
Notification: {
|
|
10242
10420
|
/**
|
|
@@ -10254,13 +10432,14 @@ interface components {
|
|
|
10254
10432
|
* @description Unique notification identifier.
|
|
10255
10433
|
*/
|
|
10256
10434
|
id: string;
|
|
10257
|
-
/**
|
|
10258
|
-
|
|
10259
|
-
|
|
10260
|
-
|
|
10435
|
+
/**
|
|
10436
|
+
* @description The notification type and its typed params, absent when the stored params
|
|
10437
|
+
* do not decode into their `notifyType`.
|
|
10438
|
+
*/
|
|
10439
|
+
payload?: components["schemas"]["NotificationPayload"];
|
|
10261
10440
|
/**
|
|
10262
10441
|
* Format: date-time
|
|
10263
|
-
* @description When the notification was read.
|
|
10442
|
+
* @description When the notification was read; absent means unread.
|
|
10264
10443
|
*/
|
|
10265
10444
|
readAt?: string;
|
|
10266
10445
|
};
|
|
@@ -10272,7 +10451,7 @@ interface components {
|
|
|
10272
10451
|
* The values mirror the [`WebhookEvent`](super::WebhookEvent) naming for the
|
|
10273
10452
|
* events the two channels share.
|
|
10274
10453
|
*/
|
|
10275
|
-
NotificationEvent: "member
|
|
10454
|
+
NotificationEvent: "member.invited" | "member.joined" | "connection.sync.completed" | "connection.sync.failed" | "pipeline.run.analyzed" | "pipeline.run.completed" | "pipeline.run.failed" | "system.announcement" | "system.report";
|
|
10276
10455
|
/**
|
|
10277
10456
|
* @description Generic paginated response wrapper.
|
|
10278
10457
|
*
|
|
@@ -10307,38 +10486,37 @@ interface components {
|
|
|
10307
10486
|
/**
|
|
10308
10487
|
* @description The typed payload of a notification, tagged by `notifyType`.
|
|
10309
10488
|
*
|
|
10310
|
-
* Each variant is one notification type carrying its own params struct.
|
|
10311
|
-
*
|
|
10312
|
-
*
|
|
10313
|
-
* so the same key drives the member's per-event preferences.
|
|
10489
|
+
* Each variant is one notification type carrying its own params struct. The
|
|
10490
|
+
* `notifyType` values match [`NotificationEvent`], so the same key drives the
|
|
10491
|
+
* member's per-event preferences.
|
|
10314
10492
|
*/
|
|
10315
10493
|
NotificationPayload: ({
|
|
10316
10494
|
/** @constant */
|
|
10317
|
-
notifyType: "member
|
|
10495
|
+
notifyType: "member.invited";
|
|
10318
10496
|
} & components["schemas"]["MemberInvitedParams"]) | ({
|
|
10319
10497
|
/** @constant */
|
|
10320
|
-
notifyType: "member
|
|
10498
|
+
notifyType: "member.joined";
|
|
10321
10499
|
} & components["schemas"]["MemberJoinedParams"]) | ({
|
|
10322
10500
|
/** @constant */
|
|
10323
|
-
notifyType: "connection
|
|
10501
|
+
notifyType: "connection.sync.completed";
|
|
10324
10502
|
} & components["schemas"]["ConnectionSyncCompletedParams"]) | ({
|
|
10325
10503
|
/** @constant */
|
|
10326
|
-
notifyType: "connection
|
|
10504
|
+
notifyType: "connection.sync.failed";
|
|
10327
10505
|
} & components["schemas"]["ConnectionSyncFailedParams"]) | ({
|
|
10328
10506
|
/** @constant */
|
|
10329
|
-
notifyType: "pipeline
|
|
10507
|
+
notifyType: "pipeline.run.analyzed";
|
|
10330
10508
|
} & components["schemas"]["PipelineRunAnalyzedParams"]) | ({
|
|
10331
10509
|
/** @constant */
|
|
10332
|
-
notifyType: "pipeline
|
|
10510
|
+
notifyType: "pipeline.run.completed";
|
|
10333
10511
|
} & components["schemas"]["PipelineRunCompletedParams"]) | ({
|
|
10334
10512
|
/** @constant */
|
|
10335
|
-
notifyType: "pipeline
|
|
10513
|
+
notifyType: "pipeline.run.failed";
|
|
10336
10514
|
} & components["schemas"]["PipelineRunFailedParams"]) | ({
|
|
10337
10515
|
/** @constant */
|
|
10338
|
-
notifyType: "system
|
|
10516
|
+
notifyType: "system.announcement";
|
|
10339
10517
|
} & components["schemas"]["SystemAnnouncementParams"]) | ({
|
|
10340
10518
|
/** @constant */
|
|
10341
|
-
notifyType: "system
|
|
10519
|
+
notifyType: "system.report";
|
|
10342
10520
|
} & components["schemas"]["SystemReportParams"]);
|
|
10343
10521
|
/** @description Response for notification settings within a workspace. */
|
|
10344
10522
|
NotificationSettings: {
|
|
@@ -10497,6 +10675,11 @@ interface components {
|
|
|
10497
10675
|
/** @description Handle of the workspace this pipeline belongs to. */
|
|
10498
10676
|
workspaceSlug: components["schemas"]["Handle"];
|
|
10499
10677
|
};
|
|
10678
|
+
/** @description Params of a pipeline activity (`pipeline.*`, non-run). */
|
|
10679
|
+
PipelineActivityParams: {
|
|
10680
|
+
/** @description Slug of the pipeline. */
|
|
10681
|
+
pipelineSlug: components["schemas"]["Handle"];
|
|
10682
|
+
};
|
|
10500
10683
|
/**
|
|
10501
10684
|
* @description A pipeline's detection + governance intent.
|
|
10502
10685
|
*
|
|
@@ -10570,7 +10753,7 @@ interface components {
|
|
|
10570
10753
|
*/
|
|
10571
10754
|
inputFileName?: string;
|
|
10572
10755
|
/** @description Non-encrypted metadata for filtering/display. */
|
|
10573
|
-
metadata:
|
|
10756
|
+
metadata: components["schemas"]["RunMetadata"];
|
|
10574
10757
|
/**
|
|
10575
10758
|
* Format: uuid
|
|
10576
10759
|
* @description Redacted document produced by the run, once it completes.
|
|
@@ -10599,7 +10782,17 @@ interface components {
|
|
|
10599
10782
|
/** @description Handle of the workspace this run belongs to. */
|
|
10600
10783
|
workspaceSlug: components["schemas"]["Handle"];
|
|
10601
10784
|
};
|
|
10602
|
-
/** @description Params of a `pipeline
|
|
10785
|
+
/** @description Params of a pipeline-run activity (`pipeline.run.*`). */
|
|
10786
|
+
PipelineRunActivityParams: {
|
|
10787
|
+
/** @description Slug of the owning pipeline. */
|
|
10788
|
+
pipelineSlug: components["schemas"]["Handle"];
|
|
10789
|
+
/**
|
|
10790
|
+
* Format: uuid
|
|
10791
|
+
* @description Id of the run.
|
|
10792
|
+
*/
|
|
10793
|
+
runId: string;
|
|
10794
|
+
};
|
|
10795
|
+
/** @description Params of a `pipeline.run.analyzed` notification. */
|
|
10603
10796
|
PipelineRunAnalyzedParams: {
|
|
10604
10797
|
/** @description Display name of the analyzed file, if known. */
|
|
10605
10798
|
inputFileName?: string;
|
|
@@ -10611,7 +10804,7 @@ interface components {
|
|
|
10611
10804
|
*/
|
|
10612
10805
|
runId: string;
|
|
10613
10806
|
};
|
|
10614
|
-
/** @description Params of a `pipeline
|
|
10807
|
+
/** @description Params of a `pipeline.run.completed` notification. */
|
|
10615
10808
|
PipelineRunCompletedParams: {
|
|
10616
10809
|
/** @description Display name of the analyzed file, if known. */
|
|
10617
10810
|
inputFileName?: string;
|
|
@@ -10623,7 +10816,7 @@ interface components {
|
|
|
10623
10816
|
*/
|
|
10624
10817
|
runId: string;
|
|
10625
10818
|
};
|
|
10626
|
-
/** @description Params of a `pipeline
|
|
10819
|
+
/** @description Params of a `pipeline.run.failed` notification. */
|
|
10627
10820
|
PipelineRunFailedParams: {
|
|
10628
10821
|
/** @description Failure reason, if available. */
|
|
10629
10822
|
error?: string;
|
|
@@ -10796,6 +10989,14 @@ interface components {
|
|
|
10796
10989
|
/** @description Handle of the workspace this policy belongs to. */
|
|
10797
10990
|
workspaceSlug: components["schemas"]["Handle"];
|
|
10798
10991
|
};
|
|
10992
|
+
/** @description Params of a policy activity (`policy.*`). */
|
|
10993
|
+
PolicyActivityParams: {
|
|
10994
|
+
/**
|
|
10995
|
+
* Format: uuid
|
|
10996
|
+
* @description Id of the policy.
|
|
10997
|
+
*/
|
|
10998
|
+
policyId: string;
|
|
10999
|
+
};
|
|
10799
11000
|
/**
|
|
10800
11001
|
* @description A named governance policy.
|
|
10801
11002
|
*
|
|
@@ -11248,6 +11449,13 @@ interface components {
|
|
|
11248
11449
|
} | "predicate" | "fallback";
|
|
11249
11450
|
/** @description Opaque run identifier (run_<uuid>). */
|
|
11250
11451
|
RunId: string;
|
|
11452
|
+
/** @description Structured metadata for a pipeline run. */
|
|
11453
|
+
RunMetadata: {
|
|
11454
|
+
/** @description Failure reason recorded when the run failed. */
|
|
11455
|
+
error?: string;
|
|
11456
|
+
/** @description Free-form labels attached to the run. */
|
|
11457
|
+
tags?: string[];
|
|
11458
|
+
};
|
|
11251
11459
|
/**
|
|
11252
11460
|
* @description A run's status change, broadcast on the core-NATS subject [`run_subject`].
|
|
11253
11461
|
*
|
|
@@ -11559,12 +11767,12 @@ interface components {
|
|
|
11559
11767
|
* to track whether a run was manually triggered, scheduled, or triggered by a webhook.
|
|
11560
11768
|
*/
|
|
11561
11769
|
SyncTriggerType: "manual" | "scheduled" | "webhook";
|
|
11562
|
-
/** @description Params of a `system
|
|
11770
|
+
/** @description Params of a `system.announcement` notification. */
|
|
11563
11771
|
SystemAnnouncementParams: {
|
|
11564
11772
|
/** @description Announcement message key or body. */
|
|
11565
11773
|
message: string;
|
|
11566
11774
|
};
|
|
11567
|
-
/** @description Params of a `system
|
|
11775
|
+
/** @description Params of a `system.report` notification. */
|
|
11568
11776
|
SystemReportParams: {
|
|
11569
11777
|
/**
|
|
11570
11778
|
* Format: uuid
|
|
@@ -12489,6 +12697,21 @@ interface components {
|
|
|
12489
12697
|
*/
|
|
12490
12698
|
tokenId: string;
|
|
12491
12699
|
};
|
|
12700
|
+
/**
|
|
12701
|
+
* @description An account's current unread-notification count, broadcast on the account's
|
|
12702
|
+
* core-NATS unread subject.
|
|
12703
|
+
*
|
|
12704
|
+
* Fan-out to any watching SSE connections so a badge updates live; the stored
|
|
12705
|
+
* rows in Postgres remain the source of truth, so a missed broadcast is
|
|
12706
|
+
* recoverable by re-reading the count.
|
|
12707
|
+
*/
|
|
12708
|
+
UnreadCountEvent: {
|
|
12709
|
+
/**
|
|
12710
|
+
* Format: int64
|
|
12711
|
+
* @description The account's current number of unread notifications.
|
|
12712
|
+
*/
|
|
12713
|
+
unreadCount: number;
|
|
12714
|
+
};
|
|
12492
12715
|
/** @description Response type for unread notifications status. */
|
|
12493
12716
|
UnreadStatus: {
|
|
12494
12717
|
/**
|
|
@@ -12699,6 +12922,14 @@ interface components {
|
|
|
12699
12922
|
/** @description Handle of the workspace this webhook belongs to. */
|
|
12700
12923
|
workspaceSlug: components["schemas"]["Handle"];
|
|
12701
12924
|
};
|
|
12925
|
+
/** @description Params of a webhook activity (`webhook.*`). */
|
|
12926
|
+
WebhookActivityParams: {
|
|
12927
|
+
/**
|
|
12928
|
+
* Format: uuid
|
|
12929
|
+
* @description Id of the webhook.
|
|
12930
|
+
*/
|
|
12931
|
+
webhookId: string;
|
|
12932
|
+
};
|
|
12702
12933
|
/**
|
|
12703
12934
|
* @description Webhook creation response that includes the secret (visible only once).
|
|
12704
12935
|
*
|
|
@@ -12766,7 +12997,7 @@ interface components {
|
|
|
12766
12997
|
* This enumeration corresponds to the `WEBHOOK_EVENT` PostgreSQL enum and is used
|
|
12767
12998
|
* to configure which events a webhook should receive notifications for.
|
|
12768
12999
|
*/
|
|
12769
|
-
WebhookEvent: "file
|
|
13000
|
+
WebhookEvent: "file.created" | "file.updated" | "file.deleted" | "member.added" | "member.deleted" | "member.updated" | "connection.created" | "connection.updated" | "connection.deleted" | "connection.sync.started" | "connection.sync.completed" | "connection.sync.failed" | "pipeline.created" | "pipeline.updated" | "pipeline.deleted" | "pipeline.run.started" | "pipeline.run.analyzed" | "pipeline.run.completed" | "pipeline.run.failed" | "policy.created" | "policy.updated" | "policy.deleted";
|
|
12770
13001
|
/** @description Opaque whk identifier (whk_<uuid>). */
|
|
12771
13002
|
WebhookId: string;
|
|
12772
13003
|
/**
|
|
@@ -12840,6 +13071,11 @@ interface components {
|
|
|
12840
13071
|
*/
|
|
12841
13072
|
updatedAt: string;
|
|
12842
13073
|
};
|
|
13074
|
+
/** @description Params of a workspace-scoped activity (`workspace.*`). */
|
|
13075
|
+
WorkspaceActivityParams: {
|
|
13076
|
+
/** @description Slug of the workspace acted on. */
|
|
13077
|
+
workspaceSlug: components["schemas"]["Handle"];
|
|
13078
|
+
};
|
|
12843
13079
|
/** @description Path parameters for file operations within a workspace context. */
|
|
12844
13080
|
WorkspaceFilePathParams: {
|
|
12845
13081
|
/**
|
|
@@ -12957,8 +13193,17 @@ type AccountRef = Schemas$19["AccountRef"];
|
|
|
12957
13193
|
//#region src/datatypes/activity.d.ts
|
|
12958
13194
|
type Schemas$18 = components["schemas"];
|
|
12959
13195
|
type Activity = Schemas$18["Activity"];
|
|
12960
|
-
type ActivityType = Schemas$18["ActivityType"];
|
|
12961
13196
|
type ActivityPage = Schemas$18["ActivityPage"];
|
|
13197
|
+
type ActivityPayload = Schemas$18["ActivityPayload"];
|
|
13198
|
+
type WorkspaceActivityParams = Schemas$18["WorkspaceActivityParams"];
|
|
13199
|
+
type MemberActivityParams = Schemas$18["MemberActivityParams"];
|
|
13200
|
+
type InviteActivityParams = Schemas$18["InviteActivityParams"];
|
|
13201
|
+
type ConnectionActivityParams = Schemas$18["ConnectionActivityParams"];
|
|
13202
|
+
type PipelineActivityParams = Schemas$18["PipelineActivityParams"];
|
|
13203
|
+
type PipelineRunActivityParams = Schemas$18["PipelineRunActivityParams"];
|
|
13204
|
+
type PolicyActivityParams = Schemas$18["PolicyActivityParams"];
|
|
13205
|
+
type FileActivityParams = Schemas$18["FileActivityParams"];
|
|
13206
|
+
type WebhookActivityParams = Schemas$18["WebhookActivityParams"];
|
|
12962
13207
|
//#endregion
|
|
12963
13208
|
//#region src/datatypes/api-token.d.ts
|
|
12964
13209
|
type Schemas$17 = components["schemas"];
|
|
@@ -13117,6 +13362,7 @@ type UpdateNotificationSettings = Schemas$7["UpdateNotificationSettings"];
|
|
|
13117
13362
|
type UnreadStatus = Schemas$7["UnreadStatus"];
|
|
13118
13363
|
type NotificationPage = Schemas$7["NotificationPage"];
|
|
13119
13364
|
type MarkedReadStatus = Schemas$7["MarkedReadStatus"];
|
|
13365
|
+
type UnreadCountEvent = Schemas$7["UnreadCountEvent"];
|
|
13120
13366
|
type NotificationPayload = Schemas$7["NotificationPayload"];
|
|
13121
13367
|
type MemberInvitedParams = Schemas$7["MemberInvitedParams"];
|
|
13122
13368
|
type MemberJoinedParams = Schemas$7["MemberJoinedParams"];
|
|
@@ -13183,6 +13429,7 @@ type TerminalFallback = Schemas$4["TerminalFallback"];
|
|
|
13183
13429
|
//#region src/datatypes/run.d.ts
|
|
13184
13430
|
type Schemas$3 = components["schemas"];
|
|
13185
13431
|
type PipelineRun = Schemas$3["PipelineRun"];
|
|
13432
|
+
type RunMetadata = Schemas$3["RunMetadata"];
|
|
13186
13433
|
type CreatePipelineRun = Schemas$3["CreatePipelineRun"];
|
|
13187
13434
|
type PipelineRunStatus = Schemas$3["PipelineRunStatus"];
|
|
13188
13435
|
type PipelineRunPage = Schemas$3["PipelineRunPage"];
|
|
@@ -13226,5 +13473,5 @@ type Retention = Schemas["Retention"];
|
|
|
13226
13473
|
type RetentionSettings = Schemas["RetentionSettings"];
|
|
13227
13474
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
13228
13475
|
//#endregion
|
|
13229
|
-
export {
|
|
13230
|
-
//# sourceMappingURL=index-
|
|
13476
|
+
export { ModalityRedactions as $, AudioEventKind as $n, ConnectionActivityParams as $r, InvitePage as $t, PipelineRun as A, LlmConfig as An, TabularEventKind as Ar, Notification as At, CreatePolicy as B, SyncTriggerType as Bn, TextLocation as Br, UnreadCountEvent as Bt, LanguageProvenance as C, ConnectionPage as Cn, Polygon as Cr, UpdatePipeline as Ct, ScopeParams as D, ConnectionsQuery as Dn, TabularEntity as Dr, MarkedReadStatus as Dt, ScopeMetadata as E, ConnectionVerification as En, RuleMatch as Er, ConnectionSyncFailedParams as Et, RunStatusEvent as F, SyncDeletionPolicy as Fn, TextEntity as Fr, PipelineRunAnalyzedParams as Ft, ImageRedaction as G, AuthToken as Gn, ApiTokenType as Gr, MemberPage as Gt, DateStyle as H, LabelCatalog as Hn, TimeSpan as Hr, UpdateNotificationSettings as Ht, AudioRedaction as I, SyncMode as In, TextEntityRecord as Ir, PipelineRunCompletedParams as It, LabelGroup as J, Attribution as Jn, TokenExpiration as Jr, CreateInvite as Jt, Label as K, Login as Kn, ApiTokenWithJWT as Kr, MemberSortField as Kt, ClampBucket as L, SyncSchedule as Ln, TextEvent as Lr, PipelineRunFailedParams as Lt, PipelineRunStatus as M, S3Credentials as Mn, TabularLocation as Mr, NotificationPage as Mt, PipelineRunsQuery as N, StorageConfig as Nn, TabularProvenance as Nr, NotificationPayload as Nt, Audit as O, CreateConnection as On, TabularEntityRecord as Or, MemberInvitedParams as Ot, RunMetadata as P, SyncConnection as Pn, TextData as Pr, NotificationSettings as Pt, LocalizedText as Q, AudioEvent as Qn, ActivityPayload as Qr, InviteExpiration as Qt, Color as R, SyncScheduleInput as Rn, TextEventKind as Rr, SystemAnnouncementParams as Rt, Language as S, ConnectionConfig as Sn, Point as Sr, PipelineTriggerType as St, Languages as T, ConnectionSyncPage as Tn, Review as Tr, ConnectionSyncCompletedParams as Tt, GdprArticle9Treatment as U, RecognizerCatalog as Un, ApiToken as Ur, ListMembers as Ut, DateGranularity as V, UpdateConnection as Vn, TextProvenance as Vr, UnreadStatus as Vt, HipaaDeidMethod as W, RegisteredRecognizer as Wn, ApiTokenPage as Wr, Member as Wt, Labels as X, AudioEntity as Xn, Activity as Xr, Invite as Xt, LabelLocale as Y, AudioData as Yn, UpdateApiToken as Yr, GenerateInviteCode as Yt, LanguageTag as Z, AudioEntityRecord as Zn, ActivityPage as Zr, InviteCode as Zt, WebhookPage as _, ErrorResponse as _n, LeakProfile as _r, PipelineDefinition as _t, RetentionSettings as a, PolicyActivityParams as ai, ReplyInvite as an, Dimensions as ar, PolicySummary as at, Confidence as b, AzureCredentials as bn, OperatorId as br, PipelineSummary as bt, WorkspacePage as c, Account as ci, Health as cn, EntityGroup as cr, Predicate as ct, CreateWebhook as d, UpdateAccount as di, FileKind as dn, ImageEntityRecord as dr, TerminalFallback as dt, FileActivityParams as ei, InvitePreview as en, AudioHint as er, PciDssPart as et, TestWebhook as f, paths as fi, FilePage as fn, ImageEvent as fr, TextRedaction as ft, WebhookEvent as g, UpdateFile as gn, ImageProvenance as gr, Pipeline as gt, WebhookCreated as h, ModalityToken as hn, ImageLocation as hr, CreatePipeline as ht, RetentionOverride as i, PipelineRunActivityParams as ii, ListInvites as in, BoundingBox as ir, PolicyRule as it, PipelineRunPage as j, OpenAiCredentials as jn, TabularHint as jr, NotificationEvent as jt, CreatePipelineRun as k, GcsCredentials as kn, TabularEvent as kr, MemberJoinedParams as kt, WorkspaceRole as l, AccountRef as li, HealthStatus as ln, ImageData as lr, Sha2Algorithm as lt, Webhook as m, ListFiles as mn, ImageHint as mr, Waveform as mt, OcrPolicy as n, MemberActivityParams as ni, InviteSortField as nn, AudioProvenance as nr, Policy as nt, UpdateWorkspace as o, WebhookActivityParams as oi, SortOrder as on, Dpi as or, PolicySummaryPage as ot, UpdateWebhook as p, FormatToken as pn, ImageEventKind as pr, UpdatePolicy as pt, LabelEntry as q, Signup as qn, CreateApiToken as qr, UpdateMember as qt, Retention as r, PipelineActivityParams as ri, InviteStatus as rn, AuditContext as rr, PolicyDefinition as rt, Workspace as s, WorkspaceActivityParams as si, ComponentHealth as sn, EntityCoRef as sr, PolicyTemplate as st, CreateWorkspace as t, InviteActivityParams as ti, InviteSent as tn, AudioLocation as tr, PciPanRender as tt, WorkspaceSettings as u, PublicAccount as ui, File as un, ImageEntity as ur, TabularRedaction as ut, WebhookResult as v, ValidationErrorDetail as vn, ModelEvent as vr, PipelineFilter as vt, LanguageSpan as w, ConnectionSync as wn, RangeOfUint as wr, CursorPagination as wt, CountryCode as x, Connection as xn, PatternEvent as xr, PipelineSummaryPage as xt, WebhookStatus as y, AnthropicCredentials as yn, OcrMode as yr, PipelineStatus as yt, ConfidenceThreshold as z, SyncStatus as zn, TextHint as zr, SystemReportParams as zt };
|
|
13477
|
+
//# sourceMappingURL=index-Cijg5CMy.d.ts.map
|