@stackfactor/client-api 1.1.252 → 1.1.253
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/dist/cjs/lib/constants.d.ts +61 -0
- package/dist/cjs/lib/constants.d.ts.map +1 -1
- package/dist/cjs/lib/constants.js +69 -1
- package/dist/cjs/lib/constants.js.map +1 -1
- package/dist/cjs/lib/index.d.ts +1 -0
- package/dist/cjs/lib/index.d.ts.map +1 -1
- package/dist/cjs/lib/index.js +3 -2
- package/dist/cjs/lib/index.js.map +1 -1
- package/dist/cjs/lib/knowledgeBase.d.ts +400 -0
- package/dist/cjs/lib/knowledgeBase.d.ts.map +1 -0
- package/dist/cjs/lib/knowledgeBase.js +898 -0
- package/dist/cjs/lib/knowledgeBase.js.map +1 -0
- package/dist/esm/lib/constants.d.ts +61 -0
- package/dist/esm/lib/constants.d.ts.map +1 -1
- package/dist/esm/lib/constants.js +68 -0
- package/dist/esm/lib/constants.js.map +1 -1
- package/dist/esm/lib/index.d.ts +1 -0
- package/dist/esm/lib/index.d.ts.map +1 -1
- package/dist/esm/lib/index.js +1 -0
- package/dist/esm/lib/index.js.map +1 -1
- package/dist/esm/lib/knowledgeBase.d.ts +400 -0
- package/dist/esm/lib/knowledgeBase.d.ts.map +1 -0
- package/dist/esm/lib/knowledgeBase.js +855 -0
- package/dist/esm/lib/knowledgeBase.js.map +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,400 @@
|
|
|
1
|
+
/** Create / update payload for a KB's metadata (§14 CRUD). */
|
|
2
|
+
export interface KnowledgeBaseInput {
|
|
3
|
+
name?: string;
|
|
4
|
+
description?: string | null;
|
|
5
|
+
category?: string | null;
|
|
6
|
+
/** One of `KNOWLEDGE_BASE.VISIBILITY` — "private" | "team" | "public". */
|
|
7
|
+
visibility?: string;
|
|
8
|
+
embeddingProvider?: string;
|
|
9
|
+
embeddingModel?: string;
|
|
10
|
+
embeddingDimensions?: number;
|
|
11
|
+
redactionPolicy?: object;
|
|
12
|
+
status?: number;
|
|
13
|
+
}
|
|
14
|
+
/** An access grant (§14 KB Access Management). */
|
|
15
|
+
export interface AccessEntryInput {
|
|
16
|
+
/** One of `KNOWLEDGE_BASE.SUBJECT_TYPE` — "user" | "group" | "team". */
|
|
17
|
+
subjectType: string;
|
|
18
|
+
subjectId: string;
|
|
19
|
+
/** One of `KNOWLEDGE_BASE.ACCESS_ROLE` — "owner" | "editor" | "contributor" | "viewer". */
|
|
20
|
+
role: string;
|
|
21
|
+
}
|
|
22
|
+
/** Optional filters for the paginated document list (§14 Document Management). */
|
|
23
|
+
export interface DocumentListParams {
|
|
24
|
+
page?: number;
|
|
25
|
+
limit?: number;
|
|
26
|
+
/** One of `KNOWLEDGE_BASE.DOCUMENT_STATUS`. */
|
|
27
|
+
status?: number;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* List the knowledge bases the caller can see.
|
|
31
|
+
* GET /api/v1/knowledge-base
|
|
32
|
+
* @param {String} authToken Authentication token
|
|
33
|
+
* @returns {Promise<object>}
|
|
34
|
+
*/
|
|
35
|
+
export declare const listKnowledgeBases: (authToken: string) => Promise<object>;
|
|
36
|
+
/**
|
|
37
|
+
* Create a knowledge base (the creator becomes owner automatically). Requires the
|
|
38
|
+
* global CREATE_KNOWLEDGE_BASE capability.
|
|
39
|
+
* POST /api/v1/knowledge-base
|
|
40
|
+
* @param {KnowledgeBaseInput} data KB metadata (at minimum `name`)
|
|
41
|
+
* @param {String} authToken Authentication token
|
|
42
|
+
* @returns {Promise<object>}
|
|
43
|
+
*/
|
|
44
|
+
export declare const createKnowledgeBase: (data: KnowledgeBaseInput, authToken: string) => Promise<object>;
|
|
45
|
+
/**
|
|
46
|
+
* Get a single knowledge base (plus stats).
|
|
47
|
+
* GET /api/v1/knowledge-base/:id
|
|
48
|
+
* @param {String} id The knowledge base id
|
|
49
|
+
* @param {String} authToken Authentication token
|
|
50
|
+
* @returns {Promise<object>}
|
|
51
|
+
*/
|
|
52
|
+
export declare const getKnowledgeBase: (id: string, authToken: string) => Promise<object>;
|
|
53
|
+
/**
|
|
54
|
+
* Update a knowledge base's metadata. Owner or editor only. Does not touch
|
|
55
|
+
* `access[]`, `sources`, or `createdBy` — those have their own gated flows.
|
|
56
|
+
* PUT /api/v1/knowledge-base/:id
|
|
57
|
+
* @param {String} id The knowledge base id
|
|
58
|
+
* @param {KnowledgeBaseInput} data The fields to update
|
|
59
|
+
* @param {String} authToken Authentication token
|
|
60
|
+
* @returns {Promise<object>}
|
|
61
|
+
*/
|
|
62
|
+
export declare const updateKnowledgeBase: (id: string, data: KnowledgeBaseInput, authToken: string) => Promise<object>;
|
|
63
|
+
/**
|
|
64
|
+
* Delete a knowledge base (cascades to its chunks). Owner only.
|
|
65
|
+
* DELETE /api/v1/knowledge-base/:id
|
|
66
|
+
* @param {String} id The knowledge base id
|
|
67
|
+
* @param {String} authToken Authentication token
|
|
68
|
+
* @returns {Promise<object>}
|
|
69
|
+
*/
|
|
70
|
+
export declare const deleteKnowledgeBase: (id: string, authToken: string) => Promise<object>;
|
|
71
|
+
/**
|
|
72
|
+
* List the available KB_SOURCE_CONNECTOR integrations (enabled integrations +
|
|
73
|
+
* capability manifests for the source-creation form).
|
|
74
|
+
* GET /api/v1/knowledge-base/source-connectors
|
|
75
|
+
* @param {String} authToken Authentication token
|
|
76
|
+
* @returns {Promise<object>}
|
|
77
|
+
*/
|
|
78
|
+
export declare const listSourceConnectors: (authToken: string) => Promise<object>;
|
|
79
|
+
/**
|
|
80
|
+
* Add a source to a knowledge base (`integrationId` + credentials +
|
|
81
|
+
* `syncFrequencyDays`, default 7). Publishes a kb-source-event (changeType="add").
|
|
82
|
+
* POST /api/v1/knowledge-base/:id/sources
|
|
83
|
+
* @param {String} id The knowledge base id
|
|
84
|
+
* @param {object} source The source configuration
|
|
85
|
+
* @param {String} authToken Authentication token
|
|
86
|
+
* @returns {Promise<object>}
|
|
87
|
+
*/
|
|
88
|
+
export declare const addSource: (id: string, source: object, authToken: string) => Promise<object>;
|
|
89
|
+
/**
|
|
90
|
+
* Update a knowledge base source. Publishes a kb-source-event per changed source.
|
|
91
|
+
* PUT /api/v1/knowledge-base/:id/sources/:sourceId
|
|
92
|
+
* @param {String} id The knowledge base id
|
|
93
|
+
* @param {String} sourceId The source id
|
|
94
|
+
* @param {object} source The updated source configuration
|
|
95
|
+
* @param {String} authToken Authentication token
|
|
96
|
+
* @returns {Promise<object>}
|
|
97
|
+
*/
|
|
98
|
+
export declare const updateSource: (id: string, sourceId: string, source: object, authToken: string) => Promise<object>;
|
|
99
|
+
/**
|
|
100
|
+
* Remove a source from a knowledge base. Publishes a kb-source-event
|
|
101
|
+
* (changeType="delete").
|
|
102
|
+
* DELETE /api/v1/knowledge-base/:id/sources/:sourceId
|
|
103
|
+
* @param {String} id The knowledge base id
|
|
104
|
+
* @param {String} sourceId The source id
|
|
105
|
+
* @param {String} authToken Authentication token
|
|
106
|
+
* @returns {Promise<object>}
|
|
107
|
+
*/
|
|
108
|
+
export declare const deleteSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
|
|
109
|
+
/**
|
|
110
|
+
* Trigger a manual re-sync of a source. Publishes a kb-source-event
|
|
111
|
+
* (changeType="update", trigger="manual_sync").
|
|
112
|
+
* POST /api/v1/knowledge-base/:id/sources/:sourceId/sync
|
|
113
|
+
* @param {String} id The knowledge base id
|
|
114
|
+
* @param {String} sourceId The source id
|
|
115
|
+
* @param {String} authToken Authentication token
|
|
116
|
+
* @returns {Promise<object>}
|
|
117
|
+
*/
|
|
118
|
+
export declare const syncSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
|
|
119
|
+
/**
|
|
120
|
+
* Test a source's connector credentials (dispatches TEST_CONNECTION).
|
|
121
|
+
* POST /api/v1/knowledge-base/:id/sources/:sourceId/test
|
|
122
|
+
* @param {String} id The knowledge base id
|
|
123
|
+
* @param {String} sourceId The source id
|
|
124
|
+
* @param {String} authToken Authentication token
|
|
125
|
+
* @returns {Promise<object>}
|
|
126
|
+
*/
|
|
127
|
+
export declare const testSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
|
|
128
|
+
/**
|
|
129
|
+
* List a knowledge base's documents (paginated, with status + lastSync). There is
|
|
130
|
+
* no upload endpoint — documents are only ingested via configured sources.
|
|
131
|
+
* GET /api/v1/knowledge-base/:id/documents
|
|
132
|
+
* @param {String} id The knowledge base id
|
|
133
|
+
* @param {DocumentListParams} params Optional pagination / status filters
|
|
134
|
+
* @param {String} authToken Authentication token
|
|
135
|
+
* @returns {Promise<object>}
|
|
136
|
+
*/
|
|
137
|
+
export declare const listDocuments: (id: string, params: DocumentListParams, authToken: string) => Promise<object>;
|
|
138
|
+
/**
|
|
139
|
+
* Delete a single document (cascades to chunks + S3 images + dependent entity
|
|
140
|
+
* flags).
|
|
141
|
+
* DELETE /api/v1/knowledge-base/:id/documents/:docId
|
|
142
|
+
* @param {String} id The knowledge base id
|
|
143
|
+
* @param {String} docId The document id
|
|
144
|
+
* @param {String} authToken Authentication token
|
|
145
|
+
* @returns {Promise<object>}
|
|
146
|
+
*/
|
|
147
|
+
export declare const deleteDocument: (id: string, docId: string, authToken: string) => Promise<object>;
|
|
148
|
+
/**
|
|
149
|
+
* List a knowledge base's access entries.
|
|
150
|
+
* GET /api/v1/knowledge-base/:id/access
|
|
151
|
+
* @param {String} id The knowledge base id
|
|
152
|
+
* @param {String} authToken Authentication token
|
|
153
|
+
* @returns {Promise<object>}
|
|
154
|
+
*/
|
|
155
|
+
export declare const listAccess: (id: string, authToken: string) => Promise<object>;
|
|
156
|
+
/**
|
|
157
|
+
* Grant (upsert) an access entry. Owner only. Access is keyed by
|
|
158
|
+
* `(subjectType, subjectId)`, so re-granting a subject that already has an entry
|
|
159
|
+
* updates its role — there is no separate "update role" endpoint.
|
|
160
|
+
* POST /api/v1/knowledge-base/:id/access
|
|
161
|
+
* @param {String} id The knowledge base id
|
|
162
|
+
* @param {AccessEntryInput} entry The `{ subjectType, subjectId, role }` grant
|
|
163
|
+
* @param {String} authToken Authentication token
|
|
164
|
+
* @returns {Promise<object>}
|
|
165
|
+
*/
|
|
166
|
+
export declare const grantAccess: (id: string, entry: AccessEntryInput, authToken: string) => Promise<object>;
|
|
167
|
+
/**
|
|
168
|
+
* Revoke a subject's access. Owner only. Keyed by `(subjectType, subjectId)` — the
|
|
169
|
+
* same composite key `grantAccess` upserts on. The backend refuses to remove the
|
|
170
|
+
* last owner.
|
|
171
|
+
* DELETE /api/v1/knowledge-base/:id/access
|
|
172
|
+
* @param {String} id The knowledge base id
|
|
173
|
+
* @param {String} subjectType One of `KNOWLEDGE_BASE.SUBJECT_TYPE`
|
|
174
|
+
* @param {String} subjectId The subject whose access is revoked
|
|
175
|
+
* @param {String} authToken Authentication token
|
|
176
|
+
* @returns {Promise<object>}
|
|
177
|
+
*/
|
|
178
|
+
export declare const revokeAccess: (id: string, subjectType: string, subjectId: string, authToken: string) => Promise<object>;
|
|
179
|
+
/**
|
|
180
|
+
* Read a knowledge base's redaction policy.
|
|
181
|
+
* GET /api/v1/knowledge-base/:id/redaction-policy
|
|
182
|
+
* @param {String} id The knowledge base id
|
|
183
|
+
* @param {String} authToken Authentication token
|
|
184
|
+
* @returns {Promise<object>}
|
|
185
|
+
*/
|
|
186
|
+
export declare const getRedactionPolicy: (id: string, authToken: string) => Promise<object>;
|
|
187
|
+
/**
|
|
188
|
+
* Set a knowledge base's per-KB redaction behavior + DLP provider.
|
|
189
|
+
* PUT /api/v1/knowledge-base/:id/redaction-policy
|
|
190
|
+
* @param {String} id The knowledge base id
|
|
191
|
+
* @param {object} policy The redaction policy
|
|
192
|
+
* @param {String} authToken Authentication token
|
|
193
|
+
* @returns {Promise<object>}
|
|
194
|
+
*/
|
|
195
|
+
export declare const updateRedactionPolicy: (id: string, policy: object, authToken: string) => Promise<object>;
|
|
196
|
+
/**
|
|
197
|
+
* Read the tenant's compliance profile (admin only). Governs which RAG processors
|
|
198
|
+
* a KB may route to (e.g. HIPAA tenants → BAA-eligible processors only).
|
|
199
|
+
* GET /api/v1/tenant/compliance-profile
|
|
200
|
+
* @param {String} authToken Authentication token
|
|
201
|
+
* @returns {Promise<object>}
|
|
202
|
+
*/
|
|
203
|
+
export declare const getComplianceProfile: (authToken: string) => Promise<object>;
|
|
204
|
+
/**
|
|
205
|
+
* Update the tenant's compliance profile (admin only; not exposed via the KB UI).
|
|
206
|
+
* PUT /api/v1/tenant/compliance-profile
|
|
207
|
+
* @param {object} profile The compliance profile
|
|
208
|
+
* @param {String} authToken Authentication token
|
|
209
|
+
* @returns {Promise<object>}
|
|
210
|
+
*/
|
|
211
|
+
export declare const updateComplianceProfile: (profile: object, authToken: string) => Promise<object>;
|
|
212
|
+
/**
|
|
213
|
+
* Trigger a GDPR subject-purge ("right to be forgotten"; admin only).
|
|
214
|
+
* POST /api/v1/compliance/right-to-be-forgotten
|
|
215
|
+
* @param {object} data The subject-purge request
|
|
216
|
+
* @param {String} authToken Authentication token
|
|
217
|
+
* @returns {Promise<object>}
|
|
218
|
+
*/
|
|
219
|
+
export declare const rightToBeForgotten: (data: object, authToken: string) => Promise<object>;
|
|
220
|
+
/**
|
|
221
|
+
* Overview of all Review Center streams + counts for a knowledge base.
|
|
222
|
+
* GET /api/v1/knowledge-base/:id/review
|
|
223
|
+
* @param {String} id The knowledge base id
|
|
224
|
+
* @param {String} authToken Authentication token
|
|
225
|
+
* @returns {Promise<object>}
|
|
226
|
+
*/
|
|
227
|
+
export declare const getReviewOverview: (id: string, authToken: string) => Promise<object>;
|
|
228
|
+
/**
|
|
229
|
+
* List QUARANTINED documents (Review Center stream 1).
|
|
230
|
+
* GET /api/v1/knowledge-base/:id/review/quarantine
|
|
231
|
+
* @param {String} id The knowledge base id
|
|
232
|
+
* @param {String} authToken Authentication token
|
|
233
|
+
* @returns {Promise<object>}
|
|
234
|
+
*/
|
|
235
|
+
export declare const listQuarantine: (id: string, authToken: string) => Promise<object>;
|
|
236
|
+
/**
|
|
237
|
+
* Release a quarantined document. Requires RELEASE_QUARANTINE + owner|editor.
|
|
238
|
+
* POST /api/v1/knowledge-base/:id/review/quarantine/:docId/release
|
|
239
|
+
* @param {String} id The knowledge base id
|
|
240
|
+
* @param {String} docId The document id
|
|
241
|
+
* @param {String} authToken Authentication token
|
|
242
|
+
* @returns {Promise<object>}
|
|
243
|
+
*/
|
|
244
|
+
export declare const releaseQuarantine: (id: string, docId: string, authToken: string) => Promise<object>;
|
|
245
|
+
/**
|
|
246
|
+
* Re-ingest a quarantined document (optionally with an updated redaction policy).
|
|
247
|
+
* Publishes a kb-source-event (trigger="quarantine_re_ingest"). Requires
|
|
248
|
+
* RELEASE_QUARANTINE + owner.
|
|
249
|
+
* POST /api/v1/knowledge-base/:id/review/quarantine/:docId/re-ingest
|
|
250
|
+
* @param {String} id The knowledge base id
|
|
251
|
+
* @param {String} docId The document id
|
|
252
|
+
* @param {object} data Optional body, e.g. `{ updatedRedactionPolicy }`
|
|
253
|
+
* @param {String} authToken Authentication token
|
|
254
|
+
* @returns {Promise<object>}
|
|
255
|
+
*/
|
|
256
|
+
export declare const reingestQuarantine: (id: string, docId: string, data: object, authToken: string) => Promise<object>;
|
|
257
|
+
/**
|
|
258
|
+
* Delete a quarantined document. Requires RELEASE_QUARANTINE + owner.
|
|
259
|
+
* POST /api/v1/knowledge-base/:id/review/quarantine/:docId/delete
|
|
260
|
+
* @param {String} id The knowledge base id
|
|
261
|
+
* @param {String} docId The document id
|
|
262
|
+
* @param {String} authToken Authentication token
|
|
263
|
+
* @returns {Promise<object>}
|
|
264
|
+
*/
|
|
265
|
+
export declare const deleteQuarantine: (id: string, docId: string, authToken: string) => Promise<object>;
|
|
266
|
+
/**
|
|
267
|
+
* List generated artifacts awaiting review (needsReview=true).
|
|
268
|
+
* Requires GENERATE_FROM_KB + owner|editor.
|
|
269
|
+
* GET /api/v1/knowledge-base/:id/review/generated
|
|
270
|
+
* @param {String} id The knowledge base id
|
|
271
|
+
* @param {String} authToken Authentication token
|
|
272
|
+
* @returns {Promise<object>}
|
|
273
|
+
*/
|
|
274
|
+
export declare const listGeneratedReview: (id: string, authToken: string) => Promise<object>;
|
|
275
|
+
/**
|
|
276
|
+
* Approve a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
|
|
277
|
+
* POST /api/v1/knowledge-base/:id/review/generated/:entityId/approve
|
|
278
|
+
* @param {String} id The knowledge base id
|
|
279
|
+
* @param {String} entityId The artifact/entity id
|
|
280
|
+
* @param {object} data Body `{ entityType, notes? }`
|
|
281
|
+
* @param {String} authToken Authentication token
|
|
282
|
+
* @returns {Promise<object>}
|
|
283
|
+
*/
|
|
284
|
+
export declare const approveGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
|
|
285
|
+
/**
|
|
286
|
+
* Approve a generated artifact with edits.
|
|
287
|
+
* Requires GENERATE_FROM_KB + owner|editor.
|
|
288
|
+
* POST /api/v1/knowledge-base/:id/review/generated/:entityId/edit-approve
|
|
289
|
+
* @param {String} id The knowledge base id
|
|
290
|
+
* @param {String} entityId The artifact/entity id
|
|
291
|
+
* @param {object} data Body `{ entityType, edits, notes? }`
|
|
292
|
+
* @param {String} authToken Authentication token
|
|
293
|
+
* @returns {Promise<object>}
|
|
294
|
+
*/
|
|
295
|
+
export declare const editApproveGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
|
|
296
|
+
/**
|
|
297
|
+
* Reject a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
|
|
298
|
+
* POST /api/v1/knowledge-base/:id/review/generated/:entityId/reject
|
|
299
|
+
* @param {String} id The knowledge base id
|
|
300
|
+
* @param {String} entityId The artifact/entity id
|
|
301
|
+
* @param {object} data Body `{ entityType, reason }`
|
|
302
|
+
* @param {String} authToken Authentication token
|
|
303
|
+
* @returns {Promise<object>}
|
|
304
|
+
*/
|
|
305
|
+
export declare const rejectGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
|
|
306
|
+
/**
|
|
307
|
+
* Regenerate a generated artifact using current chunks.
|
|
308
|
+
* Requires GENERATE_FROM_KB + owner|editor.
|
|
309
|
+
* POST /api/v1/knowledge-base/:id/review/generated/:entityId/regenerate
|
|
310
|
+
* @param {String} id The knowledge base id
|
|
311
|
+
* @param {String} entityId The artifact/entity id
|
|
312
|
+
* @param {object} data Body `{ entityType, regenerationHints? }`
|
|
313
|
+
* @param {String} authToken Authentication token
|
|
314
|
+
* @returns {Promise<object>}
|
|
315
|
+
*/
|
|
316
|
+
export declare const regenerateGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
|
|
317
|
+
/**
|
|
318
|
+
* List chunks with non-empty contradictionFlags[].
|
|
319
|
+
* Requires GENERATE_FROM_KB + owner|editor.
|
|
320
|
+
* GET /api/v1/knowledge-base/:id/review/contradictions
|
|
321
|
+
* @param {String} id The knowledge base id
|
|
322
|
+
* @param {String} authToken Authentication token
|
|
323
|
+
* @returns {Promise<object>}
|
|
324
|
+
*/
|
|
325
|
+
export declare const listContradictions: (id: string, authToken: string) => Promise<object>;
|
|
326
|
+
/**
|
|
327
|
+
* Decide a contradiction between two chunks.
|
|
328
|
+
* Requires GENERATE_FROM_KB + owner|editor.
|
|
329
|
+
* POST /api/v1/knowledge-base/:id/review/contradictions/:chunkId/decide
|
|
330
|
+
* @param {String} id The knowledge base id
|
|
331
|
+
* @param {String} chunkId The chunk id carrying the contradiction flag
|
|
332
|
+
* @param {object} data Body `{ decision, otherChunkId, notes }` — `decision` is one
|
|
333
|
+
* of `KNOWLEDGE_BASE.CONTRADICTION_DECISION`
|
|
334
|
+
* @param {String} authToken Authentication token
|
|
335
|
+
* @returns {Promise<object>}
|
|
336
|
+
*/
|
|
337
|
+
export declare const decideContradiction: (id: string, chunkId: string, data: object, authToken: string) => Promise<object>;
|
|
338
|
+
/**
|
|
339
|
+
* Regenerate a stale artifact from a notification using current chunks.
|
|
340
|
+
* POST /api/v1/notifications/:notificationId/artifacts/:artifactId/regenerate
|
|
341
|
+
* @param {String} notificationId The notification id
|
|
342
|
+
* @param {String} artifactId The artifact id
|
|
343
|
+
* @param {object} data Body `{ entityType }`
|
|
344
|
+
* @param {String} authToken Authentication token
|
|
345
|
+
* @returns {Promise<object>}
|
|
346
|
+
*/
|
|
347
|
+
export declare const regenerateArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
|
|
348
|
+
/**
|
|
349
|
+
* Retire (soft-delete) a stale artifact from a notification.
|
|
350
|
+
* POST /api/v1/notifications/:notificationId/artifacts/:artifactId/retire
|
|
351
|
+
* @param {String} notificationId The notification id
|
|
352
|
+
* @param {String} artifactId The artifact id
|
|
353
|
+
* @param {object} data Body `{ entityType }`
|
|
354
|
+
* @param {String} authToken Authentication token
|
|
355
|
+
* @returns {Promise<object>}
|
|
356
|
+
*/
|
|
357
|
+
export declare const retireArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
|
|
358
|
+
/**
|
|
359
|
+
* Dismiss a stale-artifact flag (mark the staleness acceptable).
|
|
360
|
+
* POST /api/v1/notifications/:notificationId/artifacts/:artifactId/dismiss
|
|
361
|
+
* @param {String} notificationId The notification id
|
|
362
|
+
* @param {String} artifactId The artifact id
|
|
363
|
+
* @param {object} data Body `{ entityType, reason? }`
|
|
364
|
+
* @param {String} authToken Authentication token
|
|
365
|
+
* @returns {Promise<object>}
|
|
366
|
+
*/
|
|
367
|
+
export declare const dismissArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
|
|
368
|
+
/**
|
|
369
|
+
* Dismiss an entire out-of-sync notification (all artifacts).
|
|
370
|
+
* POST /api/v1/notifications/:notificationId/dismiss-all
|
|
371
|
+
* @param {String} notificationId The notification id
|
|
372
|
+
* @param {String} authToken Authentication token
|
|
373
|
+
* @returns {Promise<object>}
|
|
374
|
+
*/
|
|
375
|
+
export declare const dismissAllArtifacts: (notificationId: string, authToken: string) => Promise<object>;
|
|
376
|
+
/**
|
|
377
|
+
* List the current user's source-side identities.
|
|
378
|
+
* GET /api/v1/identity/source-mappings
|
|
379
|
+
* @param {String} authToken Authentication token
|
|
380
|
+
* @returns {Promise<object>}
|
|
381
|
+
*/
|
|
382
|
+
export declare const listSourceMappings: (authToken: string) => Promise<object>;
|
|
383
|
+
/**
|
|
384
|
+
* Tenant-admin override for a user's source identity mapping.
|
|
385
|
+
* PUT /api/v1/identity/source-mappings/:sourceType
|
|
386
|
+
* @param {String} sourceType The source type key
|
|
387
|
+
* @param {object} data The mapping override
|
|
388
|
+
* @param {String} authToken Authentication token
|
|
389
|
+
* @returns {Promise<object>}
|
|
390
|
+
*/
|
|
391
|
+
export declare const updateSourceMapping: (sourceType: string, data: object, authToken: string) => Promise<object>;
|
|
392
|
+
/**
|
|
393
|
+
* Bulk-resolve source principal IDs → tenant users (internal / service-to-service).
|
|
394
|
+
* POST /api/v1/identity/source-mappings/resolve
|
|
395
|
+
* @param {object} data Body carrying the principal IDs to resolve
|
|
396
|
+
* @param {String} authToken Authentication token
|
|
397
|
+
* @returns {Promise<object>}
|
|
398
|
+
*/
|
|
399
|
+
export declare const resolveSourceMappings: (data: object, authToken: string) => Promise<object>;
|
|
400
|
+
//# sourceMappingURL=knowledgeBase.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"knowledgeBase.d.ts","sourceRoot":"","sources":["../../../src/lib/knowledgeBase.ts"],"names":[],"mappings":"AAgBA,8DAA8D;AAC9D,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,kDAAkD;AAClD,MAAM,WAAW,gBAAgB;IAC/B,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,2FAA2F;IAC3F,IAAI,EAAE,MAAM,CAAC;CACd;AAED,kFAAkF;AAClF,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAapE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,MAAM,kBAAkB,EACxB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,MAAM,kBAAkB,EACxB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAatE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,GACpB,IAAI,MAAM,EACV,QAAQ,MAAM,EACd,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACrB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GACrB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAIF;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,GACxB,IAAI,MAAM,EACV,QAAQ,kBAAkB,EAC1B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,IAAI,MAAM,EACV,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,IAAI,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAaxE,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,GACtB,IAAI,MAAM,EACV,OAAO,gBAAgB,EACvB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,aAAa,MAAM,EACnB,WAAW,MAAM,EACjB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,QAAQ,MAAM,EACd,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAatE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,GAClC,SAAS,MAAM,EACf,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GACzB,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,GAC5B,IAAI,MAAM,EACV,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAIF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAIF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,SAAS,MAAM,EACf,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAMF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAC7B,gBAAgB,MAAM,EACtB,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,gBAAgB,MAAM,EACtB,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,gBAAgB,MAAM,EACtB,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,gBAAgB,MAAM,EACtB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAKF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAapE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC"}
|