@veltrosecurity/sdk 0.0.0 → 0.15.7
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/LICENSE +202 -0
- package/README.md +115 -1
- package/dist/index.cjs +3674 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +1981 -0
- package/dist/index.d.ts +1981 -0
- package/dist/index.js +3624 -0
- package/dist/index.js.map +1 -0
- package/package.json +47 -4
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,1981 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* HTTP transport for `@veltrosecurity/sdk`: dependency-free, fail-closed, capped.
|
|
3
|
+
*
|
|
4
|
+
* The same four constraints as the Python SDK:
|
|
5
|
+
*
|
|
6
|
+
* - **No dependencies.** `fetch` is in every runtime the SDK supports
|
|
7
|
+
* (Node >= 22, Bun, Deno, browsers), so nothing is bundled.
|
|
8
|
+
* - **Never log a credential.** Credentials live behind `Auth` implementations
|
|
9
|
+
* whose `toString()` masks the value; the transport never puts headers into
|
|
10
|
+
* an error message.
|
|
11
|
+
* - **Cap the response.** `maxResponseBytes` is enforced while streaming, so a
|
|
12
|
+
* hostile or broken deployment cannot exhaust the caller's memory.
|
|
13
|
+
* - **Typed refusals.** Every non-2xx becomes a `VeltroApiError` carrying the
|
|
14
|
+
* status, the product's own refusal code when it sends one, and the request
|
|
15
|
+
* line.
|
|
16
|
+
*/
|
|
17
|
+
declare const DEFAULT_TIMEOUT_MS = 30000;
|
|
18
|
+
declare const DEFAULT_MAX_RESPONSE_BYTES: number;
|
|
19
|
+
declare const DEFAULT_RETRIES = 2;
|
|
20
|
+
/** Applies one credential to an outgoing request. */
|
|
21
|
+
interface Auth {
|
|
22
|
+
apply(method: string, url: string, headers: Headers): Promise<void> | void;
|
|
23
|
+
}
|
|
24
|
+
declare class VeltroError extends Error {
|
|
25
|
+
constructor(message: string);
|
|
26
|
+
}
|
|
27
|
+
declare class VeltroTransportError extends VeltroError {
|
|
28
|
+
constructor(message: string);
|
|
29
|
+
}
|
|
30
|
+
declare class VeltroResponseTooLargeError extends VeltroError {
|
|
31
|
+
constructor(message: string);
|
|
32
|
+
}
|
|
33
|
+
declare class VeltroApiError extends VeltroError {
|
|
34
|
+
readonly status: number;
|
|
35
|
+
readonly method: string;
|
|
36
|
+
readonly url: string;
|
|
37
|
+
readonly code: string | null;
|
|
38
|
+
readonly detail: string;
|
|
39
|
+
readonly body: unknown;
|
|
40
|
+
constructor(args: {
|
|
41
|
+
status: number;
|
|
42
|
+
method: string;
|
|
43
|
+
url: string;
|
|
44
|
+
code?: string | null;
|
|
45
|
+
detail?: string;
|
|
46
|
+
body?: unknown;
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Percent-encode one path segment. Path parameters are interpolated into a
|
|
51
|
+
* URL, so an unencoded `/` or `?` in an identifier would silently retarget the
|
|
52
|
+
* request at another endpoint.
|
|
53
|
+
*/
|
|
54
|
+
declare function quoteSegment(value: string | number): string;
|
|
55
|
+
type QueryValue = string | number | boolean | null | undefined | Array<string | number | boolean>;
|
|
56
|
+
interface RequestOptions {
|
|
57
|
+
/** Query parameters. `null`/`undefined` values are dropped. */
|
|
58
|
+
params?: Record<string, QueryValue>;
|
|
59
|
+
/** JSON request body. */
|
|
60
|
+
json?: unknown;
|
|
61
|
+
/** Raw request body, when `json` is not appropriate. */
|
|
62
|
+
body?: BodyInit;
|
|
63
|
+
/** Extra headers, applied after the credential. */
|
|
64
|
+
headers?: Record<string, string>;
|
|
65
|
+
/** Per-request timeout override, milliseconds. */
|
|
66
|
+
timeoutMs?: number;
|
|
67
|
+
/** Return the raw text instead of parsed JSON. */
|
|
68
|
+
raw?: boolean;
|
|
69
|
+
/** Caller-supplied abort signal, honoured alongside the timeout. */
|
|
70
|
+
signal?: AbortSignal;
|
|
71
|
+
}
|
|
72
|
+
interface TransportOptions {
|
|
73
|
+
auth?: Auth;
|
|
74
|
+
timeoutMs?: number;
|
|
75
|
+
retries?: number;
|
|
76
|
+
maxResponseBytes?: number;
|
|
77
|
+
headers?: Record<string, string>;
|
|
78
|
+
/** Injected for tests; defaults to the runtime `fetch`. */
|
|
79
|
+
fetchImpl?: typeof fetch;
|
|
80
|
+
/** Injected for tests; defaults to a real timer. */
|
|
81
|
+
sleep?: (ms: number) => Promise<void>;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* One product's HTTP surface: base URL, credential, retries, and caps.
|
|
85
|
+
*
|
|
86
|
+
* `baseUrl` includes any suite gateway prefix
|
|
87
|
+
* (`https://soc.example.com/chad`); operation paths from the generated
|
|
88
|
+
* bindings are appended verbatim.
|
|
89
|
+
*/
|
|
90
|
+
declare class Transport {
|
|
91
|
+
readonly baseUrl: string;
|
|
92
|
+
readonly auth?: Auth;
|
|
93
|
+
readonly timeoutMs: number;
|
|
94
|
+
readonly retries: number;
|
|
95
|
+
readonly maxResponseBytes: number;
|
|
96
|
+
private readonly extraHeaders;
|
|
97
|
+
private readonly fetchImpl;
|
|
98
|
+
private readonly sleep;
|
|
99
|
+
constructor(baseUrl: string, options?: TransportOptions);
|
|
100
|
+
urlFor(path: string, params?: Record<string, QueryValue>): string;
|
|
101
|
+
request<T = unknown>(method: string, path: string, options?: RequestOptions): Promise<T>;
|
|
102
|
+
}
|
|
103
|
+
/** Base class for the generated resource bindings. */
|
|
104
|
+
declare class Resource {
|
|
105
|
+
protected readonly transport: Transport;
|
|
106
|
+
constructor(transport: Transport);
|
|
107
|
+
protected request<T = unknown>(method: string, path: string, options?: RequestOptions): Promise<T>;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Credentials the Veltro suite actually accepts, and nothing else.
|
|
112
|
+
*
|
|
113
|
+
* The three shapes are not interchangeable, so the SDK models them separately
|
|
114
|
+
* rather than guessing:
|
|
115
|
+
*
|
|
116
|
+
* - `BearerToken` — `Authorization: Bearer …`: a Veltro personal access token
|
|
117
|
+
* (`vmcp_…`) for any product through the suite gateway (`/chad/api/*`,
|
|
118
|
+
* `/warden/api/*`, `/vectorflow/api/*`), where identity turns it into the
|
|
119
|
+
* request assertion the product verifies; VectorFlow's environment-scoped
|
|
120
|
+
* service-account key (`vf_live_…`, for `/api/v1`); CHAD's SCIM deployment
|
|
121
|
+
* token; Warden's session token.
|
|
122
|
+
* - `SuiteSession` — a suite deployment's own session, minted at the identity
|
|
123
|
+
* origin (`GET /api/auth/csrf` + `POST /api/auth/login`) and carried as the
|
|
124
|
+
* session cookie. The gateway exchanges that cookie for a short-lived
|
|
125
|
+
* request assertion toward each product, which is why one suite login
|
|
126
|
+
* reaches all three.
|
|
127
|
+
* - `NoAuth` — explicit anonymity, for unauthenticated probes.
|
|
128
|
+
*/
|
|
129
|
+
|
|
130
|
+
declare const SESSION_COOKIE_PREFIX = "authjs.session-token";
|
|
131
|
+
declare class NoAuth implements Auth {
|
|
132
|
+
apply(): void;
|
|
133
|
+
toString(): string;
|
|
134
|
+
}
|
|
135
|
+
declare class BearerToken implements Auth {
|
|
136
|
+
private readonly token;
|
|
137
|
+
constructor(token: string);
|
|
138
|
+
apply(_method: string, _url: string, headers: Headers): void;
|
|
139
|
+
toString(): string;
|
|
140
|
+
}
|
|
141
|
+
interface SuiteSessionOptions {
|
|
142
|
+
timeoutMs?: number;
|
|
143
|
+
/** Required to send credentials over plain HTTP (loopback deployments). */
|
|
144
|
+
allowInsecureTransport?: boolean;
|
|
145
|
+
fetchImpl?: typeof fetch;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* A suite session held as the identity-minted cookie.
|
|
149
|
+
*
|
|
150
|
+
* `identityUrl` is the suite origin — the identity authority owns the origin
|
|
151
|
+
* root. Login happens once, lazily; call `refresh()` to re-authenticate.
|
|
152
|
+
*/
|
|
153
|
+
declare class SuiteSession implements Auth {
|
|
154
|
+
readonly identityUrl: string;
|
|
155
|
+
private readonly email;
|
|
156
|
+
private readonly password;
|
|
157
|
+
private readonly timeoutMs;
|
|
158
|
+
private readonly fetchImpl;
|
|
159
|
+
private readonly cookies;
|
|
160
|
+
private loggedIn;
|
|
161
|
+
private inFlight;
|
|
162
|
+
constructor(identityUrl: string, email: string, password: string, options?: SuiteSessionOptions);
|
|
163
|
+
/**
|
|
164
|
+
* Attach the session cookie only where RFC 6265 says it belongs.
|
|
165
|
+
*
|
|
166
|
+
* The suite gateway serves CHAD, Warden and VectorFlow under the identity
|
|
167
|
+
* origin's own path prefixes, so a correctly scoped cookie still reaches all
|
|
168
|
+
* three. A product client pointed at some other origin gets no credential
|
|
169
|
+
* instead of the suite session — the same guarantee `redirect: "manual"`
|
|
170
|
+
* gives on the login leg, applied to the steady state.
|
|
171
|
+
*/
|
|
172
|
+
apply(_method: string, url: string, headers: Headers): Promise<void>;
|
|
173
|
+
/** Mint a suite session. Concurrent callers share one login. */
|
|
174
|
+
login(): Promise<void>;
|
|
175
|
+
/** Drop the current session and log in again. */
|
|
176
|
+
refresh(): Promise<void>;
|
|
177
|
+
private performLogin;
|
|
178
|
+
private csrfToken;
|
|
179
|
+
private call;
|
|
180
|
+
/** Longest cookie path first, as `http.cookiejar` orders a request's jar. */
|
|
181
|
+
private cookieHeaderFor;
|
|
182
|
+
private absorbCookies;
|
|
183
|
+
toString(): string;
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/** `chad` resource `ai_copilot`. */
|
|
187
|
+
declare class ChadAiCopilot extends Resource {
|
|
188
|
+
/** POST /api/ai/copilot/explain-alert — Explain Alert. */
|
|
189
|
+
explainAlert<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
190
|
+
/** POST /api/ai/copilot/explain-rule — Explain Rule. */
|
|
191
|
+
explainRule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
192
|
+
/** POST /api/ai/copilot/generate-rule — Generate Rule. */
|
|
193
|
+
generateRule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
194
|
+
/** POST /api/ai/copilot/suggest-exceptions — Suggest Exceptions. */
|
|
195
|
+
suggestExceptions<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
196
|
+
/** POST /api/ai/copilot/suggest-field-mappings — Suggest Rule Field Mappings. */
|
|
197
|
+
suggestRuleFieldMappings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
198
|
+
/** POST /api/ai/copilot/summarize-alert — Summarize Alert. */
|
|
199
|
+
summarizeAlert<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
200
|
+
}
|
|
201
|
+
/** `chad` resource `alerts`. */
|
|
202
|
+
declare class ChadAlerts extends Resource {
|
|
203
|
+
/** POST /api/alerts/{alert_id}/assign — Assign Alert. */
|
|
204
|
+
assign<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
205
|
+
/** POST /api/alerts/bulk/delete — Bulk Delete Alerts. */
|
|
206
|
+
bulkDelete<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
207
|
+
/** POST /api/alerts/bulk/status — Bulk Update Alert Status. */
|
|
208
|
+
bulkUpdateAlertStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
209
|
+
/** POST /api/alerts/bulk/status-by-query — Bulk Update Alert Status By Query. */
|
|
210
|
+
bulkUpdateAlertStatusByQuery<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
211
|
+
/** POST /api/alerts/{alert_id}/comments — Create Alert Comment. */
|
|
212
|
+
createAlertComment<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
213
|
+
/** DELETE /api/alerts/{alert_id} — Delete Alert. */
|
|
214
|
+
delete<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
215
|
+
/** DELETE /api/alerts/{alert_id}/comments/{comment_id} — Delete Alert Comment. */
|
|
216
|
+
deleteAlertComment<T = unknown>(alertId: string, commentId: string, options?: RequestOptions): Promise<T>;
|
|
217
|
+
/** POST /api/alerts/{alert_id}/escalate-to-warden — Escalate Alert To Warden. */
|
|
218
|
+
escalateAlertToWarden<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
219
|
+
/** GET /api/alerts/{alert_id} — Get Alert. */
|
|
220
|
+
get<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
221
|
+
/** GET /api/alerts/counts — Get Alert Counts. */
|
|
222
|
+
getAlertCounts<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
223
|
+
/** GET /api/alerts/{alert_id}/disposition — Get Alert Disposition. */
|
|
224
|
+
getAlertDisposition<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
225
|
+
/** GET /api/alerts/{alert_id}/related — Get Related Alerts. */
|
|
226
|
+
getRelated<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
227
|
+
/** GET /api/alerts — List Alerts. */
|
|
228
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
229
|
+
/** GET /api/alerts/{alert_id}/comments — List Alert Comments. */
|
|
230
|
+
listAlertComments<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
231
|
+
/** GET /api/alerts/assignable-users — List Assignable Users. */
|
|
232
|
+
listAssignableUsers<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
233
|
+
/** PUT /api/alerts/{alert_id}/disposition — Record Alert Disposition. */
|
|
234
|
+
recordAlertDisposition<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
235
|
+
/** POST /api/alerts/{alert_id}/unassign — Unassign Alert. */
|
|
236
|
+
unassign<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
237
|
+
/** PATCH /api/alerts/{alert_id}/comments/{comment_id} — Update Alert Comment. */
|
|
238
|
+
updateAlertComment<T = unknown>(alertId: string, commentId: string, options?: RequestOptions): Promise<T>;
|
|
239
|
+
/** PATCH /api/alerts/{alert_id}/status — Update Alert Status. */
|
|
240
|
+
updateAlertStatus<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
241
|
+
}
|
|
242
|
+
/** `chad` resource `api_keys`. */
|
|
243
|
+
declare class ChadApiKeys extends Resource {
|
|
244
|
+
/** POST /api/api-keys — Create Api Key. */
|
|
245
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
246
|
+
/** DELETE /api/api-keys/{key_id} — Delete Api Key. */
|
|
247
|
+
delete<T = unknown>(keyId: string, options?: RequestOptions): Promise<T>;
|
|
248
|
+
/** GET /api/api-keys/{key_id} — Get Api Key. */
|
|
249
|
+
get<T = unknown>(keyId: string, options?: RequestOptions): Promise<T>;
|
|
250
|
+
/** GET /api/api-keys — List Api Keys. */
|
|
251
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
252
|
+
/** PATCH /api/api-keys/{key_id} — Update Api Key. */
|
|
253
|
+
update<T = unknown>(keyId: string, options?: RequestOptions): Promise<T>;
|
|
254
|
+
}
|
|
255
|
+
/** `chad` resource `attack`. */
|
|
256
|
+
declare class ChadAttack extends Resource {
|
|
257
|
+
/** GET /api/attack/coverage — Get Coverage. */
|
|
258
|
+
getCoverage<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
259
|
+
/** GET /api/attack/coverage/simulated — Get Simulated Coverage. */
|
|
260
|
+
getSimulatedCoverage<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
261
|
+
/** GET /api/attack/sync/status — Get Sync Status. */
|
|
262
|
+
getSyncStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
263
|
+
/** GET /api/attack/techniques/{technique_id} — Get Technique. */
|
|
264
|
+
getTechnique<T = unknown>(techniqueId: string, options?: RequestOptions): Promise<T>;
|
|
265
|
+
/** GET /api/attack/techniques — Get Techniques. */
|
|
266
|
+
getTechniques<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
267
|
+
/** POST /api/attack/coverage/simulate — Simulate Pack Coverage. */
|
|
268
|
+
simulatePackCoverage<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
269
|
+
/** POST /api/attack/sync — Sync Attack Data. */
|
|
270
|
+
syncAttackData<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
271
|
+
}
|
|
272
|
+
/** `chad` resource `attack_narratives`. */
|
|
273
|
+
declare class ChadAttackNarratives extends Resource {
|
|
274
|
+
/** POST /api/attack-narratives/{narrative_id}/dismiss — Dismiss Narrative. */
|
|
275
|
+
dismissNarrative<T = unknown>(narrativeId: string, options?: RequestOptions): Promise<T>;
|
|
276
|
+
/** GET /api/attack-narratives/{narrative_id} — Get Narrative. */
|
|
277
|
+
getNarrative<T = unknown>(narrativeId: string, options?: RequestOptions): Promise<T>;
|
|
278
|
+
/** GET /api/attack-narratives — List Narratives. */
|
|
279
|
+
listNarratives<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
280
|
+
/** POST /api/attack-narratives/{narrative_id}/promote — Promote Narrative. */
|
|
281
|
+
promoteNarrative<T = unknown>(narrativeId: string, options?: RequestOptions): Promise<T>;
|
|
282
|
+
/** POST /api/attack-narratives/discover — Run Discovery. */
|
|
283
|
+
runDiscovery<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
284
|
+
}
|
|
285
|
+
/** `chad` resource `audit`. */
|
|
286
|
+
declare class ChadAudit extends Resource {
|
|
287
|
+
/** GET /api/audit/export/chain — Export Audit Chain. */
|
|
288
|
+
exportAuditChain<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
289
|
+
/** GET /api/audit/export — Export Audit Logs. */
|
|
290
|
+
exportAuditLogs<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
291
|
+
/** GET /api/audit/actions — List Audit Actions. */
|
|
292
|
+
listAuditActions<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
293
|
+
/** GET /api/audit — List Audit Logs. */
|
|
294
|
+
listAuditLogs<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
295
|
+
/** GET /api/audit/resource-types — List Resource Types. */
|
|
296
|
+
listResourceTypes<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
297
|
+
/** POST /api/audit/log — Log Access Denied. */
|
|
298
|
+
logAccessDenied<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
299
|
+
/** GET /api/audit/suite-feed — Suite Audit Feed. */
|
|
300
|
+
suiteAuditFeed<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
301
|
+
}
|
|
302
|
+
/** `chad` resource `audit_settings`. */
|
|
303
|
+
declare class ChadAuditSettings extends Resource {
|
|
304
|
+
/** GET /api/audit-settings — Read Audit Settings. */
|
|
305
|
+
read<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
306
|
+
/** POST /api/audit-settings/test-forward — Test Forward. */
|
|
307
|
+
testForward<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
308
|
+
/** PUT /api/audit-settings — Update Audit Settings. */
|
|
309
|
+
update<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
310
|
+
}
|
|
311
|
+
/** `chad` resource `authority_revisions`. */
|
|
312
|
+
declare class ChadAuthorityRevisions extends Resource {
|
|
313
|
+
/** POST /api/authority/revisions — Ingest Authority Revisions. */
|
|
314
|
+
ingest<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
315
|
+
}
|
|
316
|
+
/** `chad` resource `circuit_breakers`. */
|
|
317
|
+
declare class ChadCircuitBreakers extends Resource {
|
|
318
|
+
/** GET /api/circuit-breakers — List Circuit Breakers. */
|
|
319
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
320
|
+
/** POST /api/circuit-breakers/{service_name}/reset — Reset Circuit Breaker. */
|
|
321
|
+
reset<T = unknown>(serviceName: string, options?: RequestOptions): Promise<T>;
|
|
322
|
+
}
|
|
323
|
+
/** `chad` resource `compliance`. */
|
|
324
|
+
declare class ChadCompliance extends Resource {
|
|
325
|
+
/** GET /api/compliance/frameworks/{framework}/coverage.csv — Export Coverage Csv. */
|
|
326
|
+
exportCoverageCsv<T = unknown>(framework: string, options?: RequestOptions): Promise<T>;
|
|
327
|
+
/** GET /api/compliance/frameworks/{framework}/coverage — Get Coverage. */
|
|
328
|
+
getCoverage<T = unknown>(framework: string, options?: RequestOptions): Promise<T>;
|
|
329
|
+
/** GET /api/compliance/coverage — Get Coverage Overview. */
|
|
330
|
+
getCoverageOverview<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
331
|
+
/** GET /api/compliance/frameworks/{framework}/report — Get Coverage Report. */
|
|
332
|
+
getCoverageReport<T = unknown>(framework: string, options?: RequestOptions): Promise<T>;
|
|
333
|
+
/** GET /api/compliance/rules/{rule_id}/mappings — Get Rule Mappings. */
|
|
334
|
+
getRuleMappings<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
335
|
+
/** GET /api/compliance/frameworks/{framework}/controls — List Controls. */
|
|
336
|
+
listControls<T = unknown>(framework: string, options?: RequestOptions): Promise<T>;
|
|
337
|
+
/** GET /api/compliance/frameworks — List Frameworks. */
|
|
338
|
+
listFrameworks<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
339
|
+
/** POST /api/compliance/frameworks/{framework}/controls/{control_id}/rules — Map Rule To Control. */
|
|
340
|
+
mapRuleToControl<T = unknown>(framework: string, controlId: string, options?: RequestOptions): Promise<T>;
|
|
341
|
+
/** PUT /api/compliance/rules/{rule_id}/mappings — Put Rule Mappings. */
|
|
342
|
+
putRuleMappings<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
343
|
+
/** DELETE /api/compliance/frameworks/{framework}/controls/{control_id}/rules/{rule_id} — Unmap Rule From Control. */
|
|
344
|
+
unmapRuleFromControl<T = unknown>(framework: string, controlId: string, ruleId: string, options?: RequestOptions): Promise<T>;
|
|
345
|
+
}
|
|
346
|
+
/** `chad` resource `content_updates`. */
|
|
347
|
+
declare class ChadContentUpdates extends Resource {
|
|
348
|
+
/** POST /api/content-updates/subscriptions/{subscription_id}/accept-upstream — Accept Upstream. */
|
|
349
|
+
acceptUpstream<T = unknown>(subscriptionId: string, options?: RequestOptions): Promise<T>;
|
|
350
|
+
/** POST /api/content-updates/subscriptions — Create Subscription. */
|
|
351
|
+
createSubscription<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
352
|
+
/** POST /api/content-updates/subscriptions/{subscription_id}/keep-local — Keep Local. */
|
|
353
|
+
keepLocal<T = unknown>(subscriptionId: string, options?: RequestOptions): Promise<T>;
|
|
354
|
+
/** GET /api/content-updates/subscriptions/{subscription_id}/rules — List Subscription Rules. */
|
|
355
|
+
listSubscriptionRules<T = unknown>(subscriptionId: string, options?: RequestOptions): Promise<T>;
|
|
356
|
+
/** GET /api/content-updates/subscriptions — List Subscriptions. */
|
|
357
|
+
listSubscriptions<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
358
|
+
/** POST /api/content-updates/subscriptions/{subscription_id}/merge — Merge Update. */
|
|
359
|
+
mergeUpdate<T = unknown>(subscriptionId: string, options?: RequestOptions): Promise<T>;
|
|
360
|
+
/** POST /api/content-updates/subscriptions/{subscription_id}/sync — Sync Subscription. */
|
|
361
|
+
syncSubscription<T = unknown>(subscriptionId: string, options?: RequestOptions): Promise<T>;
|
|
362
|
+
/** PATCH /api/content-updates/subscriptions/{subscription_id} — Update Subscription. */
|
|
363
|
+
updateSubscription<T = unknown>(subscriptionId: string, options?: RequestOptions): Promise<T>;
|
|
364
|
+
}
|
|
365
|
+
/** `chad` resource `correlation`. */
|
|
366
|
+
declare class ChadCorrelation extends Resource {
|
|
367
|
+
/** POST /api/correlation-rules/bulk/snooze — Bulk Snooze Correlation Rules. */
|
|
368
|
+
bulkSnoozeCorrelationRules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
369
|
+
/** POST /api/correlation-rules/bulk/unsnooze — Bulk Unsnooze Correlation Rules. */
|
|
370
|
+
bulkUnsnoozeCorrelationRules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
371
|
+
/** POST /api/correlation-rules — Create Correlation Rule. */
|
|
372
|
+
createCorrelationRule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
373
|
+
/** POST /api/correlation-rules/{rule_id}/comments — Create Correlation Rule Comment. */
|
|
374
|
+
createCorrelationRuleComment<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
375
|
+
/** DELETE /api/correlation-rules/{rule_id} — Delete Correlation Rule. */
|
|
376
|
+
deleteCorrelationRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
377
|
+
/** POST /api/correlation-rules/{rule_id}/deploy — Deploy Correlation Rule. */
|
|
378
|
+
deployCorrelationRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
379
|
+
/** GET /api/correlation-rules/common-log-fields — Get Common Log Fields. */
|
|
380
|
+
getCommonLogFields<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
381
|
+
/** GET /api/correlation-rules/common-sigma-fields — Get Common Sigma Fields. */
|
|
382
|
+
getCommonSigmaFields<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
383
|
+
/** GET /api/correlation-rules/{rule_id} — Get Correlation Rule. */
|
|
384
|
+
getCorrelationRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
385
|
+
/** GET /api/correlation-rules/{rule_id}/activity — Get Correlation Rule Activity. */
|
|
386
|
+
getCorrelationRuleActivity<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
387
|
+
/** GET /api/correlation-rules/{rule_id}/comments — List Correlation Rule Comments. */
|
|
388
|
+
listCorrelationRuleComments<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
389
|
+
/** GET /api/correlation-rules/{rule_id}/versions — List Correlation Rule Versions. */
|
|
390
|
+
listCorrelationRuleVersions<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
391
|
+
/** GET /api/correlation-rules — List Correlation Rules. */
|
|
392
|
+
listCorrelationRules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
393
|
+
/** POST /api/correlation-rules/{correlation_id}/rollback/{version_number} — Rollback Correlation Rule. */
|
|
394
|
+
rollbackCorrelationRule<T = unknown>(correlationId: string, versionNumber: string, options?: RequestOptions): Promise<T>;
|
|
395
|
+
/** POST /api/correlation-rules/{rule_id}/snooze — Snooze Correlation Rule. */
|
|
396
|
+
snoozeCorrelationRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
397
|
+
/** POST /api/correlation-rules/{rule_id}/test-historical — Test Correlation Historical. */
|
|
398
|
+
testCorrelationHistorical<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
399
|
+
/** POST /api/correlation-rules/{rule_id}/undeploy — Undeploy Correlation Rule. */
|
|
400
|
+
undeployCorrelationRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
401
|
+
/** POST /api/correlation-rules/{rule_id}/unsnooze — Unsnooze Correlation Rule. */
|
|
402
|
+
unsnoozeCorrelationRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
403
|
+
/** PATCH /api/correlation-rules/{rule_id} — Update Correlation Rule. */
|
|
404
|
+
updateCorrelationRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
405
|
+
}
|
|
406
|
+
/** `chad` resource `dashboards`. */
|
|
407
|
+
declare class ChadDashboards extends Resource {
|
|
408
|
+
/** POST /api/dashboards/{dashboard_id}/clone — Clone Dashboard. */
|
|
409
|
+
clone<T = unknown>(dashboardId: string, options?: RequestOptions): Promise<T>;
|
|
410
|
+
/** POST /api/dashboards — Create Dashboard. */
|
|
411
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
412
|
+
/** DELETE /api/dashboards/{dashboard_id} — Delete Dashboard. */
|
|
413
|
+
delete<T = unknown>(dashboardId: string, options?: RequestOptions): Promise<T>;
|
|
414
|
+
/** GET /api/dashboards/{dashboard_id} — Get Dashboard. */
|
|
415
|
+
get<T = unknown>(dashboardId: string, options?: RequestOptions): Promise<T>;
|
|
416
|
+
/** GET /api/dashboards/{dashboard_id}/data — Get Dashboard Data. */
|
|
417
|
+
getDashboardData<T = unknown>(dashboardId: string, options?: RequestOptions): Promise<T>;
|
|
418
|
+
/** GET /api/dashboards — List Dashboards. */
|
|
419
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
420
|
+
/** GET /api/dashboards/widget-kinds — List Widget Kinds. */
|
|
421
|
+
listWidgetKinds<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
422
|
+
/** PUT /api/dashboards/{dashboard_id} — Update Dashboard. */
|
|
423
|
+
update<T = unknown>(dashboardId: string, options?: RequestOptions): Promise<T>;
|
|
424
|
+
}
|
|
425
|
+
/** `chad` resource `data_sources`. */
|
|
426
|
+
declare class ChadDataSources extends Resource {
|
|
427
|
+
/** POST /api/data-sources/{data_source_id}/purge/requests/{request_id}/approve — Approve Data Source Purge Request. */
|
|
428
|
+
approveDataSourcePurgeRequest<T = unknown>(dataSourceId: string, requestId: string, options?: RequestOptions): Promise<T>;
|
|
429
|
+
/** POST /api/data-sources/{data_source_id}/purge/requests/{request_id}/cancel — Cancel Data Source Purge Request. */
|
|
430
|
+
cancelDataSourcePurgeRequest<T = unknown>(dataSourceId: string, requestId: string, options?: RequestOptions): Promise<T>;
|
|
431
|
+
/** POST /api/data-sources — Create Data Source. */
|
|
432
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
433
|
+
/** DELETE /api/data-sources/{data_source_id} — Delete Data Source. */
|
|
434
|
+
delete<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
435
|
+
/** POST /api/data-sources/{data_source_id}/disable — Disable Data Source. */
|
|
436
|
+
disable<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
437
|
+
/** POST /api/data-sources/{data_source_id}/purge/requests — File Data Source Purge Request. */
|
|
438
|
+
fileDataSourcePurgeRequest<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
439
|
+
/** GET /api/data-sources/{data_source_id} — Get Data Source. */
|
|
440
|
+
get<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
441
|
+
/** GET /api/data-sources/{data_source_id}/enrichments — Get Data Source Enrichments. */
|
|
442
|
+
getDataSourceEnrichments<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
443
|
+
/** GET /api/data-sources/{data_source_id}/fields — Get Data Source Fields. */
|
|
444
|
+
getDataSourceFields<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
445
|
+
/** GET /api/data-sources/{data_source_id}/time-fields — Get Data Source Time Fields. */
|
|
446
|
+
getDataSourceTimeFields<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
447
|
+
/** GET /api/data-sources/{data_source_id}/trace — Get Data Source Trace. */
|
|
448
|
+
getDataSourceTrace<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
449
|
+
/** POST /api/data-sources/{data_source_id}/trace/test-event — Inject Data Source Test Event. */
|
|
450
|
+
injectDataSourceTestEvent<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
451
|
+
/** GET /api/data-sources — List Data Sources. */
|
|
452
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
453
|
+
/** GET /api/data-sources/{data_source_id}/purge/requests — List Data Source Purge Requests. */
|
|
454
|
+
listDataSourcePurgeRequests<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
455
|
+
/** POST /api/data-sources/{data_source_id}/purge/preview — Preview Data Source Purge. */
|
|
456
|
+
previewDataSourcePurge<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
457
|
+
/** POST /api/data-sources/{data_source_id}/regenerate-token — Regenerate Auth Token. */
|
|
458
|
+
regenerateAuthToken<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
459
|
+
/** PATCH /api/data-sources/{data_source_id} — Update Data Source. */
|
|
460
|
+
update<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
461
|
+
/** PUT /api/data-sources/{data_source_id}/enrichments — Update Data Source Enrichments. */
|
|
462
|
+
updateDataSourceEnrichments<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
463
|
+
/** POST /api/data-sources/validate — Validate Pattern. */
|
|
464
|
+
validatePattern<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
465
|
+
/** POST /api/data-sources/validate-ti-selection — Validate Ti Selection Endpoint. */
|
|
466
|
+
validateTiSelectionEndpoint<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
467
|
+
}
|
|
468
|
+
/** `chad` resource `deployment_requests`. */
|
|
469
|
+
declare class ChadDeploymentRequests extends Resource {
|
|
470
|
+
/** POST /api/deployment-requests/{request_id}/approve — Approve Deployment Request. */
|
|
471
|
+
approve<T = unknown>(requestId: string, options?: RequestOptions): Promise<T>;
|
|
472
|
+
/** POST /api/deployment-requests/{request_id}/cancel — Cancel Deployment Request. */
|
|
473
|
+
cancel<T = unknown>(requestId: string, options?: RequestOptions): Promise<T>;
|
|
474
|
+
/** GET /api/deployment-requests/stats — Deployment Request Stats. */
|
|
475
|
+
deploymentRequestStats<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
476
|
+
/** POST /api/deployment-requests — File Deployment Request. */
|
|
477
|
+
file<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
478
|
+
/** GET /api/deployment-requests/{request_id} — Get Deployment Request. */
|
|
479
|
+
get<T = unknown>(requestId: string, options?: RequestOptions): Promise<T>;
|
|
480
|
+
/** GET /api/deployment-requests — List Deployment Requests. */
|
|
481
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
482
|
+
/** POST /api/deployment-requests/{request_id}/reject — Reject Deployment Request. */
|
|
483
|
+
reject<T = unknown>(requestId: string, options?: RequestOptions): Promise<T>;
|
|
484
|
+
/** POST /api/deployment-requests/{request_id}/resubmit — Resubmit Deployment Request. */
|
|
485
|
+
resubmit<T = unknown>(requestId: string, options?: RequestOptions): Promise<T>;
|
|
486
|
+
}
|
|
487
|
+
/** `chad` resource `detection_packs`. */
|
|
488
|
+
declare class ChadDetectionPacks extends Resource {
|
|
489
|
+
/** GET /api/detection-packs/{name} — Get Installed Pack. */
|
|
490
|
+
getInstalledPack<T = unknown>(name: string, options?: RequestOptions): Promise<T>;
|
|
491
|
+
/** POST /api/detection-packs/import — Import Detection Pack. */
|
|
492
|
+
import<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
493
|
+
/** POST /api/detection-packs/import/preview — Preview Detection Pack Import. */
|
|
494
|
+
previewDetectionPackImport<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
495
|
+
/** POST /api/detection-packs/upgrade/preview — Preview Detection Pack Upgrade. */
|
|
496
|
+
previewDetectionPackUpgrade<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
497
|
+
/** POST /api/detection-packs/upgrade — Upgrade Detection Pack. */
|
|
498
|
+
upgrade<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
499
|
+
}
|
|
500
|
+
/** `chad` resource `diagnostics`. */
|
|
501
|
+
declare class ChadDiagnostics extends Resource {
|
|
502
|
+
/** GET /api/diagnostics — Get Diagnostics. */
|
|
503
|
+
get<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
504
|
+
}
|
|
505
|
+
/** `chad` resource `enrichment_webhooks`. */
|
|
506
|
+
declare class ChadEnrichmentWebhooks extends Resource {
|
|
507
|
+
/** POST /api/enrichment-webhooks — Create Enrichment Webhook. */
|
|
508
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
509
|
+
/** DELETE /api/enrichment-webhooks/{webhook_id} — Delete Enrichment Webhook. */
|
|
510
|
+
delete<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
511
|
+
/** GET /api/enrichment-webhooks/{webhook_id} — Get Enrichment Webhook. */
|
|
512
|
+
get<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
513
|
+
/** GET /api/enrichment-webhooks — List Enrichment Webhooks. */
|
|
514
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
515
|
+
/** POST /api/enrichment-webhooks/{webhook_id}/test — Test Enrichment Webhook. */
|
|
516
|
+
test<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
517
|
+
/** POST /api/enrichment-webhooks/test — Test Webhook Url. */
|
|
518
|
+
testWebhookUrl<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
519
|
+
/** PATCH /api/enrichment-webhooks/{webhook_id} — Update Enrichment Webhook. */
|
|
520
|
+
update<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
521
|
+
}
|
|
522
|
+
/** `chad` resource `entities`. */
|
|
523
|
+
declare class ChadEntities extends Resource {
|
|
524
|
+
/** GET /api/entities/{entity_type}/{value} — Get Entity. */
|
|
525
|
+
get<T = unknown>(entityType: string, value: string, options?: RequestOptions): Promise<T>;
|
|
526
|
+
}
|
|
527
|
+
/** `chad` resource `environments`. */
|
|
528
|
+
declare class ChadEnvironments extends Resource {
|
|
529
|
+
/** POST /api/environments — Create Environment. */
|
|
530
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
531
|
+
/** DELETE /api/environments/{environment_id} — Delete Environment. */
|
|
532
|
+
delete<T = unknown>(environmentId: string, options?: RequestOptions): Promise<T>;
|
|
533
|
+
/** DELETE /api/environments/{environment_id}/git — Disconnect Env Git. */
|
|
534
|
+
disconnectEnvGit<T = unknown>(environmentId: string, options?: RequestOptions): Promise<T>;
|
|
535
|
+
/** GET /api/environments/{environment_id} — Get Environment. */
|
|
536
|
+
get<T = unknown>(environmentId: string, options?: RequestOptions): Promise<T>;
|
|
537
|
+
/** GET /api/environments/{environment_id}/git — Get Env Git Config. */
|
|
538
|
+
getEnvGitConfig<T = unknown>(environmentId: string, options?: RequestOptions): Promise<T>;
|
|
539
|
+
/** GET /api/environments — List Environments. */
|
|
540
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
541
|
+
/** POST /api/environments/{target_id}/promote — Promote Rules. */
|
|
542
|
+
promoteRules<T = unknown>(targetId: string, options?: RequestOptions): Promise<T>;
|
|
543
|
+
/** PUT /api/environments/{environment_id}/git — Set Env Git Config. */
|
|
544
|
+
setEnvGitConfig<T = unknown>(environmentId: string, options?: RequestOptions): Promise<T>;
|
|
545
|
+
/** POST /api/environments/{environment_id}/git/test — Test Env Git Config. */
|
|
546
|
+
testEnvGitConfig<T = unknown>(environmentId: string, options?: RequestOptions): Promise<T>;
|
|
547
|
+
/** PATCH /api/environments/{environment_id} — Update Environment. */
|
|
548
|
+
update<T = unknown>(environmentId: string, options?: RequestOptions): Promise<T>;
|
|
549
|
+
}
|
|
550
|
+
/** `chad` resource `explore`. */
|
|
551
|
+
declare class ChadExplore extends Resource {
|
|
552
|
+
/** GET /api/explore/capabilities — Explore Capabilities. */
|
|
553
|
+
exploreCapabilities<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
554
|
+
/** POST /api/explore/export — Explore Export. */
|
|
555
|
+
exploreExport<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
556
|
+
/** POST /api/explore/query — Explore Query. */
|
|
557
|
+
exploreQuery<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
558
|
+
/** GET /api/explore/data-sources — List Explore Data Sources. */
|
|
559
|
+
listExploreDataSources<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
560
|
+
/** POST /api/explore/sigma-from-filters — Sigma From Filters. */
|
|
561
|
+
sigmaFromFilters<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
562
|
+
}
|
|
563
|
+
/** `chad` resource `export`. */
|
|
564
|
+
declare class ChadExport extends Resource {
|
|
565
|
+
/** GET /api/export/rules — Export All Rules. */
|
|
566
|
+
exportAllRules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
567
|
+
/** POST /api/export/rules/bulk — Export Bulk Rules. */
|
|
568
|
+
exportBulkRules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
569
|
+
/** GET /api/export/config — Export Config. */
|
|
570
|
+
exportConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
571
|
+
/** GET /api/export/rules/{rule_id} — Export Single Rule. */
|
|
572
|
+
exportSingleRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
573
|
+
/** POST /api/export/config/import — Import Config. */
|
|
574
|
+
importConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
575
|
+
}
|
|
576
|
+
/** `chad` resource `field_mappings`. */
|
|
577
|
+
declare class ChadFieldMappings extends Resource {
|
|
578
|
+
/** POST /api/field-mappings/auto-map — Auto Map Field Mappings. */
|
|
579
|
+
autoMap<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
580
|
+
/** POST /api/field-mappings — Create Field Mapping. */
|
|
581
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
582
|
+
/** DELETE /api/field-mappings/{mapping_id} — Delete Field Mapping. */
|
|
583
|
+
delete<T = unknown>(mappingId: string, options?: RequestOptions): Promise<T>;
|
|
584
|
+
/** GET /api/field-mappings/onboarding — Field Mapping Onboarding Context. */
|
|
585
|
+
fieldMappingOnboardingContext<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
586
|
+
/** POST /api/field-mappings/scorecard — Field Mapping Scorecard. */
|
|
587
|
+
fieldMappingScorecard<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
588
|
+
/** GET /api/field-mappings/{mapping_id} — Get Field Mapping. */
|
|
589
|
+
get<T = unknown>(mappingId: string, options?: RequestOptions): Promise<T>;
|
|
590
|
+
/** POST /api/field-mappings/import — Import Field Mappings. */
|
|
591
|
+
import<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
592
|
+
/** GET /api/field-mappings/families — List Mapping Families. */
|
|
593
|
+
listMappingFamilies<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
594
|
+
/** GET /api/field-mappings — List Mappings. */
|
|
595
|
+
listMappings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
596
|
+
/** POST /api/field-mappings/suggest — Suggest Field Mappings. */
|
|
597
|
+
suggest<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
598
|
+
/** PUT /api/field-mappings/{mapping_id} — Update Field Mapping. */
|
|
599
|
+
update<T = unknown>(mappingId: string, options?: RequestOptions): Promise<T>;
|
|
600
|
+
}
|
|
601
|
+
/** `chad` resource `gitops`. */
|
|
602
|
+
declare class ChadGitops extends Resource {
|
|
603
|
+
/** GET /api/gitops/inbound — Get Inbound Flag. */
|
|
604
|
+
getInboundFlag<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
605
|
+
/** POST /api/gitops/webhook — Gitops Webhook. */
|
|
606
|
+
gitopsWebhook<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
607
|
+
/** POST /api/gitops/environments/{env_id}/import — Import Apply. */
|
|
608
|
+
importApply<T = unknown>(envId: string, options?: RequestOptions): Promise<T>;
|
|
609
|
+
/** POST /api/gitops/environments/{env_id}/import-preview — Import Preview. */
|
|
610
|
+
importPreview<T = unknown>(envId: string, options?: RequestOptions): Promise<T>;
|
|
611
|
+
/** PUT /api/gitops/inbound — Set Inbound Flag. */
|
|
612
|
+
setInboundFlag<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
613
|
+
}
|
|
614
|
+
/** `chad` resource `health`. */
|
|
615
|
+
declare class ChadHealth extends Resource {
|
|
616
|
+
/** POST /api/health/cluster/clear-cache — Cluster Clear Cache. */
|
|
617
|
+
clusterClearCache<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
618
|
+
/** POST /api/health/cluster/reindex — Cluster Reindex. */
|
|
619
|
+
clusterReindex<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
620
|
+
/** POST /api/health/cluster/retry-failed-shards — Cluster Retry Failed Shards. */
|
|
621
|
+
clusterRetryFailedShards<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
622
|
+
/** GET /api/health/authority-revision — Get Authority Revision Health. */
|
|
623
|
+
getAuthorityRevision<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
624
|
+
/** GET /api/health/cluster — Get Cluster Health. */
|
|
625
|
+
getCluster<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
626
|
+
/** GET /api/health/indices/{data_source_id} — Get Data Source Health. */
|
|
627
|
+
getDataSource<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
628
|
+
/** GET /api/health/intervals — Get Health Intervals. */
|
|
629
|
+
getHealthIntervals<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
630
|
+
/** GET /api/health/settings — Get Health Settings. */
|
|
631
|
+
getHealthSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
632
|
+
/** GET /api/health/status — Get Health Status. */
|
|
633
|
+
getHealthStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
634
|
+
/** GET /api/health/indices/{data_source_id}/history — Get Index Health History. */
|
|
635
|
+
getIndexHealthHistory<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
636
|
+
/** GET /api/health/opensearch — Get Opensearch Health. */
|
|
637
|
+
getOpensearch<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
638
|
+
/** GET /api/health/pull-mode — Get Pull Mode Health. */
|
|
639
|
+
getPullMode<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
640
|
+
/** GET /api/health/pull-mode/settings — Get Pull Mode Settings. */
|
|
641
|
+
getPullModeSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
642
|
+
/** GET /api/health/secrets-backend — Get Secrets Backend Health. */
|
|
643
|
+
getSecretsBackend<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
644
|
+
/** GET /api/health/indices — List Index Health. */
|
|
645
|
+
listIndex<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
646
|
+
/** POST /api/health/test/{service_type} — Test Service Health. */
|
|
647
|
+
testService<T = unknown>(serviceType: string, options?: RequestOptions): Promise<T>;
|
|
648
|
+
/** PUT /api/health/intervals — Update Health Intervals. */
|
|
649
|
+
updateHealthIntervals<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
650
|
+
/** PUT /api/health/settings — Update Health Settings. */
|
|
651
|
+
updateHealthSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
652
|
+
/** PUT /api/health/pull-mode/settings — Update Pull Mode Settings. */
|
|
653
|
+
updatePullModeSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
654
|
+
}
|
|
655
|
+
/** `chad` resource `holds`. */
|
|
656
|
+
declare class ChadHolds extends Resource {
|
|
657
|
+
/** POST /api/holds — Create Hold Endpoint. */
|
|
658
|
+
createHoldEndpoint<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
659
|
+
/** GET /api/holds/{hold_id} — Get Hold. */
|
|
660
|
+
get<T = unknown>(holdId: string, options?: RequestOptions): Promise<T>;
|
|
661
|
+
/** GET /api/holds — List Holds. */
|
|
662
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
663
|
+
/** POST /api/holds/{hold_id}/release — Release Hold Endpoint. */
|
|
664
|
+
releaseHoldEndpoint<T = unknown>(holdId: string, options?: RequestOptions): Promise<T>;
|
|
665
|
+
}
|
|
666
|
+
/** `chad` resource `hunts`. */
|
|
667
|
+
declare class ChadHunts extends Resource {
|
|
668
|
+
/** POST /api/hunts — Create Hunt. */
|
|
669
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
670
|
+
/** DELETE /api/hunts/{hunt_id} — Delete Hunt. */
|
|
671
|
+
delete<T = unknown>(huntId: string, options?: RequestOptions): Promise<T>;
|
|
672
|
+
/** GET /api/hunts/{hunt_id} — Get Hunt. */
|
|
673
|
+
get<T = unknown>(huntId: string, options?: RequestOptions): Promise<T>;
|
|
674
|
+
/** GET /api/hunts — List Hunts. */
|
|
675
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
676
|
+
/** POST /api/hunts/{hunt_id}/run — Run Hunt Now. */
|
|
677
|
+
runHuntNow<T = unknown>(huntId: string, options?: RequestOptions): Promise<T>;
|
|
678
|
+
/** PUT /api/hunts/{hunt_id} — Update Hunt. */
|
|
679
|
+
update<T = unknown>(huntId: string, options?: RequestOptions): Promise<T>;
|
|
680
|
+
}
|
|
681
|
+
/** `chad` resource `indicators`. */
|
|
682
|
+
declare class ChadIndicators extends Resource {
|
|
683
|
+
/** POST /api/indicators/bulk-expire — Bulk Expire Indicators. */
|
|
684
|
+
bulkExpire<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
685
|
+
/** POST /api/indicators — Create Indicator. */
|
|
686
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
687
|
+
/** DELETE /api/indicators/{indicator_id} — Delete Indicator. */
|
|
688
|
+
delete<T = unknown>(indicatorId: string, options?: RequestOptions): Promise<T>;
|
|
689
|
+
/** GET /api/indicators/export — Export Indicators. */
|
|
690
|
+
export<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
691
|
+
/** GET /api/indicators/{indicator_id} — Get Indicator. */
|
|
692
|
+
get<T = unknown>(indicatorId: string, options?: RequestOptions): Promise<T>;
|
|
693
|
+
/** POST /api/indicators/import — Import Indicators. */
|
|
694
|
+
import<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
695
|
+
/** GET /api/indicators — List Indicators. */
|
|
696
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
697
|
+
}
|
|
698
|
+
/** `chad` resource `jira`. */
|
|
699
|
+
declare class ChadJira extends Resource {
|
|
700
|
+
/** DELETE /api/jira — Delete Jira Config. */
|
|
701
|
+
deleteJiraConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
702
|
+
/** GET /api/jira — Get Jira Config. */
|
|
703
|
+
getJiraConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
704
|
+
/** GET /api/jira/issue-types/{project_key} — Get Jira Issue Types. */
|
|
705
|
+
getJiraIssueTypes<T = unknown>(projectKey: string, options?: RequestOptions): Promise<T>;
|
|
706
|
+
/** GET /api/jira/projects — Get Jira Projects. */
|
|
707
|
+
getJiraProjects<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
708
|
+
/** POST /api/jira/test — Test Jira Connection. */
|
|
709
|
+
testJiraConnection<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
710
|
+
/** POST /api/jira/test-saved — Test Saved Jira Connection. */
|
|
711
|
+
testSavedJiraConnection<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
712
|
+
/** PUT /api/jira — Update Jira Config. */
|
|
713
|
+
updateJiraConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
714
|
+
}
|
|
715
|
+
/** `chad` resource `metrics`. */
|
|
716
|
+
declare class ChadMetrics extends Resource {
|
|
717
|
+
/** GET /api/metrics — Metrics. */
|
|
718
|
+
metrics<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
719
|
+
}
|
|
720
|
+
/** `chad` resource `misp`. */
|
|
721
|
+
declare class ChadMisp extends Resource {
|
|
722
|
+
/** GET /api/misp/events/{event_id}/iocs — Get Event Iocs. */
|
|
723
|
+
getEventIocs<T = unknown>(eventId: string, options?: RequestOptions): Promise<T>;
|
|
724
|
+
/** GET /api/misp/events/{event_id}/iocs/{ioc_type} — Get Event Iocs By Type. */
|
|
725
|
+
getEventIocsByType<T = unknown>(eventId: string, iocType: string, options?: RequestOptions): Promise<T>;
|
|
726
|
+
/** GET /api/misp/status — Get Misp Status. */
|
|
727
|
+
getMispStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
728
|
+
/** GET /api/misp/rules/{rule_id}/misp-info — Get Rule Misp Info. */
|
|
729
|
+
getRuleMispInfo<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
730
|
+
/** GET /api/misp/supported-types — Get Supported Ioc Types. */
|
|
731
|
+
getSupportedIocTypes<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
732
|
+
/** POST /api/misp/import-rule — Import Rule. */
|
|
733
|
+
importRule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
734
|
+
/** GET /api/misp/events — Search Events. */
|
|
735
|
+
searchEvents<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
736
|
+
}
|
|
737
|
+
/** `chad` resource `misp_feedback`. */
|
|
738
|
+
declare class ChadMispFeedback extends Resource {
|
|
739
|
+
/** POST /api/misp/feedback/event — Create Event. */
|
|
740
|
+
createEvent<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
741
|
+
/** GET /api/misp/feedback/promotions/{promotion_id} — Get Promotion. */
|
|
742
|
+
getPromotion<T = unknown>(promotionId: string, options?: RequestOptions): Promise<T>;
|
|
743
|
+
/** GET /api/misp/feedback/promotions — List Promotions. */
|
|
744
|
+
listPromotions<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
745
|
+
/** POST /api/misp/feedback/sighting — Record Sighting. */
|
|
746
|
+
recordSighting<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
747
|
+
/** POST /api/misp/feedback/promotions/{promotion_id}/retry — Retry Promotion. */
|
|
748
|
+
retryPromotion<T = unknown>(promotionId: string, options?: RequestOptions): Promise<T>;
|
|
749
|
+
}
|
|
750
|
+
/** `chad` resource `misp_sync`. */
|
|
751
|
+
declare class ChadMispSync extends Resource {
|
|
752
|
+
/** GET /api/misp/sync/config — Get Sync Config. */
|
|
753
|
+
getSyncConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
754
|
+
/** GET /api/misp/sync/status — Get Sync Status. */
|
|
755
|
+
getSyncStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
756
|
+
/** POST /api/misp/sync/trigger — Trigger Sync. */
|
|
757
|
+
triggerSync<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
758
|
+
/** PUT /api/misp/sync/config — Update Sync Config. */
|
|
759
|
+
updateSyncConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
760
|
+
}
|
|
761
|
+
/** `chad` resource `mode`. */
|
|
762
|
+
declare class ChadMode extends Resource {
|
|
763
|
+
/** GET /api/mode — Get Mode. */
|
|
764
|
+
get<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
765
|
+
}
|
|
766
|
+
/** `chad` resource `notifications`. */
|
|
767
|
+
declare class ChadNotifications extends Resource {
|
|
768
|
+
/** GET /api/notifications/settings — Get Mandatory Comments Settings. */
|
|
769
|
+
getMandatoryCommentsSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
770
|
+
/** GET /api/notifications/settings/public — Get Mandatory Comments Settings Public. */
|
|
771
|
+
getMandatoryCommentsSettingsPublic<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
772
|
+
/** GET /api/notifications — Get Notification Settings. */
|
|
773
|
+
getNotificationSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
774
|
+
/** GET /api/notifications/recent — Get Recent Notifications. */
|
|
775
|
+
getRecent<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
776
|
+
/** PUT /api/notifications/alerts — Update Alert Notification. */
|
|
777
|
+
updateAlert<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
778
|
+
/** PUT /api/notifications/settings — Update Mandatory Comments Settings. */
|
|
779
|
+
updateMandatoryCommentsSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
780
|
+
/** PUT /api/notifications/system — Update System Notification. */
|
|
781
|
+
updateSystem<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
782
|
+
}
|
|
783
|
+
/** `chad` resource `overlays`. */
|
|
784
|
+
declare class ChadOverlays extends Resource {
|
|
785
|
+
/** POST /api/overlays/{overlay_id}/versions — Add Overlay Version. */
|
|
786
|
+
addOverlayVersion<T = unknown>(overlayId: string, options?: RequestOptions): Promise<T>;
|
|
787
|
+
/** POST /api/overlays/bind — Bind Overlays. */
|
|
788
|
+
bind<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
789
|
+
/** GET /api/overlays/rules/{rule_id}/bound — Bound Overlays. */
|
|
790
|
+
bound<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
791
|
+
/** POST /api/overlays — Create Overlay. */
|
|
792
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
793
|
+
/** GET /api/overlays/rules/{rule_id}/effective — Effective Overlays. */
|
|
794
|
+
effective<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
795
|
+
/** GET /api/overlays/{overlay_id} — Get Overlay. */
|
|
796
|
+
get<T = unknown>(overlayId: string, options?: RequestOptions): Promise<T>;
|
|
797
|
+
/** GET /api/overlays — List Overlays. */
|
|
798
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
799
|
+
}
|
|
800
|
+
/** `chad` resource `permissions`. */
|
|
801
|
+
declare class ChadPermissions extends Resource {
|
|
802
|
+
/** GET /api/permissions — Get Permissions. */
|
|
803
|
+
get<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
804
|
+
/** PUT /api/permissions — Update Permission. */
|
|
805
|
+
update<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
806
|
+
}
|
|
807
|
+
/** `chad` resource `queue`. */
|
|
808
|
+
declare class ChadQueue extends Resource {
|
|
809
|
+
/** DELETE /api/queue/dead-letter — Clear Dead Letter. */
|
|
810
|
+
clearDeadLetter<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
811
|
+
/** DELETE /api/queue/dead-letter/{message_id} — Delete Dead Letter Message. */
|
|
812
|
+
deleteDeadLetterMessage<T = unknown>(messageId: string, options?: RequestOptions): Promise<T>;
|
|
813
|
+
/** GET /api/queue/dead-letter — Get Dead Letter Messages. */
|
|
814
|
+
getDeadLetterMessages<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
815
|
+
/** GET /api/queue/stats — Get Queue Stats. */
|
|
816
|
+
getQueueStats<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
817
|
+
/** GET /api/queue/settings — Get Settings. */
|
|
818
|
+
getSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
819
|
+
/** POST /api/queue/dead-letter/retry — Retry Dead Letter. */
|
|
820
|
+
retryDeadLetter<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
821
|
+
/** POST /api/queue/dead-letter/{message_id}/retry — Retry Dead Letter Message. */
|
|
822
|
+
retryDeadLetterMessage<T = unknown>(messageId: string, options?: RequestOptions): Promise<T>;
|
|
823
|
+
/** PUT /api/queue/settings — Update Settings. */
|
|
824
|
+
updateSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
825
|
+
}
|
|
826
|
+
/** `chad` resource `report_schedules`. */
|
|
827
|
+
declare class ChadReportSchedules extends Resource {
|
|
828
|
+
/** POST /api/report-schedules — Create Schedule. */
|
|
829
|
+
createSchedule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
830
|
+
/** DELETE /api/report-schedules/{schedule_id} — Delete Schedule. */
|
|
831
|
+
deleteSchedule<T = unknown>(scheduleId: string, options?: RequestOptions): Promise<T>;
|
|
832
|
+
/** GET /api/report-schedules — List Schedules. */
|
|
833
|
+
listSchedules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
834
|
+
/** GET /api/report-schedules/preview — Preview Report. */
|
|
835
|
+
previewReport<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
836
|
+
/** POST /api/report-schedules/{schedule_id}/run — Run Schedule Now. */
|
|
837
|
+
runScheduleNow<T = unknown>(scheduleId: string, options?: RequestOptions): Promise<T>;
|
|
838
|
+
/** PUT /api/report-schedules/{schedule_id} — Update Schedule. */
|
|
839
|
+
updateSchedule<T = unknown>(scheduleId: string, options?: RequestOptions): Promise<T>;
|
|
840
|
+
}
|
|
841
|
+
/** `chad` resource `reports`. */
|
|
842
|
+
declare class ChadReports extends Resource {
|
|
843
|
+
/** POST /api/reports/attack-coverage — Export Attack Coverage. */
|
|
844
|
+
exportAttackCoverage<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
845
|
+
/** POST /api/reports/attack-coverage/navigator — Export Attack Navigator. */
|
|
846
|
+
exportAttackNavigator<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
847
|
+
/** POST /api/reports/alerts/summary — Generate Alert Summary Report. */
|
|
848
|
+
generateAlertSummary<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
849
|
+
/** POST /api/reports/rules/coverage — Generate Rule Coverage Report. */
|
|
850
|
+
generateRuleCoverage<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
851
|
+
}
|
|
852
|
+
/** `chad` resource `retention_policy`. */
|
|
853
|
+
declare class ChadRetentionPolicy extends Resource {
|
|
854
|
+
/** DELETE /api/retention-policy/{environment_id}/{retention_class} — Clear Retention Override. */
|
|
855
|
+
clearRetentionOverride<T = unknown>(environmentId: string, retentionClass: string, options?: RequestOptions): Promise<T>;
|
|
856
|
+
/** GET /api/retention-policy/detection/preview — Detection Retention Preview. */
|
|
857
|
+
detectionRetentionPreview<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
858
|
+
/** POST /api/retention-policy/detection/purge — Detection Retention Purge. */
|
|
859
|
+
detectionRetentionPurge<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
860
|
+
/** GET /api/retention-policy — List Retention Matrix. */
|
|
861
|
+
listRetentionMatrix<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
862
|
+
/** PUT /api/retention-policy/{environment_id}/{retention_class} — Set Retention Override. */
|
|
863
|
+
setRetentionOverride<T = unknown>(environmentId: string, retentionClass: string, options?: RequestOptions): Promise<T>;
|
|
864
|
+
}
|
|
865
|
+
/** `chad` resource `rule_ci`. */
|
|
866
|
+
declare class ChadRuleCi extends Resource {
|
|
867
|
+
/** POST /api/rule-ci/check — Check Rule Yaml. */
|
|
868
|
+
checkRuleYaml<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
869
|
+
/** POST /api/rule-ci/{rule_id}/check — Check Stored Rule. */
|
|
870
|
+
checkStoredRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
871
|
+
}
|
|
872
|
+
/** `chad` resource `rule_pack_conflicts`. */
|
|
873
|
+
declare class ChadRulePackConflicts extends Resource {
|
|
874
|
+
/** GET /api/rule-pack-conflicts — List Rule Pack Conflicts. */
|
|
875
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
876
|
+
/** POST /api/rule-pack-conflicts/{conflict_id}/resolve — Resolve Rule Pack Conflict. */
|
|
877
|
+
resolve<T = unknown>(conflictId: string, options?: RequestOptions): Promise<T>;
|
|
878
|
+
}
|
|
879
|
+
/** `chad` resource `rules`. */
|
|
880
|
+
declare class ChadRules extends Resource {
|
|
881
|
+
/** POST /api/rules/bulk/delete — Bulk Delete Rules. */
|
|
882
|
+
bulkDelete<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
883
|
+
/** POST /api/rules/bulk/deploy — Bulk Deploy Rules. */
|
|
884
|
+
bulkDeploy<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
885
|
+
/** POST /api/rules/bulk/snooze — Bulk Snooze Rules. */
|
|
886
|
+
bulkSnooze<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
887
|
+
/** POST /api/rules/bulk/undeploy — Bulk Undeploy Rules. */
|
|
888
|
+
bulkUndeploy<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
889
|
+
/** POST /api/rules/bulk/unsnooze — Bulk Unsnooze Rules. */
|
|
890
|
+
bulkUnsnooze<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
891
|
+
/** POST /api/rules/check-deployment-eligibility — Check Deployment Eligibility. */
|
|
892
|
+
checkDeploymentEligibility<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
893
|
+
/** POST /api/rules/check-title — Check Title Availability. */
|
|
894
|
+
checkTitleAvailability<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
895
|
+
/** POST /api/rules — Create Rule. */
|
|
896
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
897
|
+
/** POST /api/rules/{rule_id}/comments — Create Rule Comment. */
|
|
898
|
+
createRuleComment<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
899
|
+
/** POST /api/rules/{rule_id}/exceptions — Create Rule Exception. */
|
|
900
|
+
createRuleException<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
901
|
+
/** DELETE /api/rules/{rule_id} — Delete Rule. */
|
|
902
|
+
delete<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
903
|
+
/** DELETE /api/rules/{rule_id}/exceptions/{exception_id} — Delete Rule Exception. */
|
|
904
|
+
deleteRuleException<T = unknown>(ruleId: string, exceptionId: string, options?: RequestOptions): Promise<T>;
|
|
905
|
+
/** POST /api/rules/{rule_id}/canary/demote — Demote Canary Endpoint. */
|
|
906
|
+
demoteCanaryEndpoint<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
907
|
+
/** POST /api/rules/{rule_id}/deploy — Deploy Rule. */
|
|
908
|
+
deploy<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
909
|
+
/** GET /api/rules/{rule_id}/deploy-preview — Deploy Preview. */
|
|
910
|
+
deployPreview<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
911
|
+
/** GET /api/rules/{rule_id}/export — Export Rule. */
|
|
912
|
+
export<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
913
|
+
/** GET /api/rules/{rule_id} — Get Rule. */
|
|
914
|
+
get<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
915
|
+
/** GET /api/rules/{rule_id}/canary — Get Canary Status. */
|
|
916
|
+
getCanaryStatus<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
917
|
+
/** GET /api/rules/index-fields/{data_source_id} — Get Data Source Fields. */
|
|
918
|
+
getDataSourceFields<T = unknown>(dataSourceId: string, options?: RequestOptions): Promise<T>;
|
|
919
|
+
/** GET /api/rules/{rule_id}/linked-correlations — Get Linked Correlations. */
|
|
920
|
+
getLinkedCorrelations<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
921
|
+
/** GET /api/rules/{rule_id}/activity — Get Rule Activity. */
|
|
922
|
+
getRuleActivity<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
923
|
+
/** GET /api/rules/{rule_id}/fields — Get Rule Fields. */
|
|
924
|
+
getRuleFields<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
925
|
+
/** GET /api/rules/settings — Get Rule Settings. */
|
|
926
|
+
getRuleSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
927
|
+
/** GET /api/rules/{rule_id}/versions/{version_number} — Get Rule Version. */
|
|
928
|
+
getRuleVersion<T = unknown>(ruleId: string, versionNumber: string, options?: RequestOptions): Promise<T>;
|
|
929
|
+
/** GET /api/rules/{rule_id}/shadow — Get Shadow Results Endpoint. */
|
|
930
|
+
getShadowResultsEndpoint<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
931
|
+
/** GET /api/rules — List Rules. */
|
|
932
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
933
|
+
/** GET /api/rules/{rule_id}/comments — List Rule Comments. */
|
|
934
|
+
listRuleComments<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
935
|
+
/** GET /api/rules/{rule_id}/exceptions — List Rule Exceptions. */
|
|
936
|
+
listRuleExceptions<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
937
|
+
/** GET /api/rules/{rule_id}/transitions — List Rule Transitions. */
|
|
938
|
+
listRuleTransitions<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
939
|
+
/** POST /api/rules/{rule_id}/canary — Place Rule In Canary. */
|
|
940
|
+
placeRuleInCanary<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
941
|
+
/** POST /api/rules/{rule_id}/exceptions/preview — Preview Rule Exception. */
|
|
942
|
+
previewRuleException<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
943
|
+
/** POST /api/rules/{rule_id}/canary/promote — Promote Canary Endpoint. */
|
|
944
|
+
promoteCanaryEndpoint<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
945
|
+
/** POST /api/rules/{rule_id}/replace — Replace Rule. */
|
|
946
|
+
replace<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
947
|
+
/** POST /api/rules/{rule_id}/rollback/{version_number} — Rollback Rule. */
|
|
948
|
+
rollback<T = unknown>(ruleId: string, versionNumber: string, options?: RequestOptions): Promise<T>;
|
|
949
|
+
/** POST /api/rules/{rule_id}/rollback-redeploy/{version_number} — Rollback Redeploy Rule. */
|
|
950
|
+
rollbackRedeploy<T = unknown>(ruleId: string, versionNumber: string, options?: RequestOptions): Promise<T>;
|
|
951
|
+
/** POST /api/rules/{rule_id}/shadow — Shadow Deploy Rule. */
|
|
952
|
+
shadowDeploy<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
953
|
+
/** POST /api/rules/{rule_id}/snooze — Snooze Rule. */
|
|
954
|
+
snooze<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
955
|
+
/** POST /api/rules/{rule_id}/stage — Stage Rule. */
|
|
956
|
+
stage<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
957
|
+
/** POST /api/rules/test — Test Rule. */
|
|
958
|
+
test<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
959
|
+
/** POST /api/rules/{rule_id}/test-historical — Test Rule Historical. */
|
|
960
|
+
testRuleHistorical<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
961
|
+
/** POST /api/rules/{rule_id}/undeploy — Undeploy Rule. */
|
|
962
|
+
undeploy<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
963
|
+
/** POST /api/rules/{rule_id}/unsnooze — Unsnooze Rule. */
|
|
964
|
+
unsnooze<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
965
|
+
/** PATCH /api/rules/{rule_id} — Update Rule. */
|
|
966
|
+
update<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
967
|
+
/** PATCH /api/rules/{rule_id}/exceptions/{exception_id} — Update Rule Exception. */
|
|
968
|
+
updateRuleException<T = unknown>(ruleId: string, exceptionId: string, options?: RequestOptions): Promise<T>;
|
|
969
|
+
/** PATCH /api/rules/{rule_id}/noise-breaker — Update Rule Noise Breaker. */
|
|
970
|
+
updateRuleNoiseBreaker<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
971
|
+
/** PUT /api/rules/settings — Update Rule Settings. */
|
|
972
|
+
updateRuleSettings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
973
|
+
/** PATCH /api/rules/{rule_id}/threshold — Update Rule Threshold. */
|
|
974
|
+
updateRuleThreshold<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
975
|
+
/** POST /api/rules/validate — Validate Rule. */
|
|
976
|
+
validate<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
977
|
+
}
|
|
978
|
+
/** `chad` resource `runtime_contracts`. */
|
|
979
|
+
declare class ChadRuntimeContracts extends Resource {
|
|
980
|
+
/** GET /api/contracts — Get Runtime Contracts. */
|
|
981
|
+
get<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
982
|
+
}
|
|
983
|
+
/** `chad` resource `saved_views`. */
|
|
984
|
+
declare class ChadSavedViews extends Resource {
|
|
985
|
+
/** POST /api/saved-views — Create Saved View. */
|
|
986
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
987
|
+
/** DELETE /api/saved-views/{view_id} — Delete Saved View. */
|
|
988
|
+
delete<T = unknown>(viewId: string, options?: RequestOptions): Promise<T>;
|
|
989
|
+
/** GET /api/saved-views — List Saved Views. */
|
|
990
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
991
|
+
/** PUT /api/saved-views/{view_id} — Update Saved View. */
|
|
992
|
+
update<T = unknown>(viewId: string, options?: RequestOptions): Promise<T>;
|
|
993
|
+
}
|
|
994
|
+
/** `chad` resource `settings`. */
|
|
995
|
+
declare class ChadSettings extends Resource {
|
|
996
|
+
/** GET /api/settings/version/check — Check For Updates. */
|
|
997
|
+
checkForUpdates<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
998
|
+
/** POST /api/settings/version/check-now — Check For Updates Now. */
|
|
999
|
+
checkForUpdatesNow<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1000
|
+
/** POST /api/settings/geoip/download — Download Geoip Database. */
|
|
1001
|
+
downloadGeoipDatabase<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1002
|
+
/** GET /api/settings/ai/status — Get Ai Status. */
|
|
1003
|
+
getAiStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1004
|
+
/** GET /api/settings/alert-clustering — Get Alert Clustering Settings. */
|
|
1005
|
+
getAlertClustering<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1006
|
+
/** GET /api/settings/explore — Get Explore Settings. */
|
|
1007
|
+
getExplore<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1008
|
+
/** GET /api/settings/geoip — Get Geoip Settings. */
|
|
1009
|
+
getGeoip<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1010
|
+
/** GET /api/settings/opensearch/status — Get Opensearch Status. */
|
|
1011
|
+
getOpensearchStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1012
|
+
/** GET /api/settings/security — Get Security Settings. */
|
|
1013
|
+
getSecurity<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1014
|
+
/** GET /api/settings/version — Get Version. */
|
|
1015
|
+
getVersion<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1016
|
+
/** GET /api/settings/version-cleanup — Get Version Cleanup Settings. */
|
|
1017
|
+
getVersionCleanup<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1018
|
+
/** GET /api/settings — List Settings. */
|
|
1019
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1020
|
+
/** POST /api/settings/opensearch — Save Opensearch Config. */
|
|
1021
|
+
saveOpensearchConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1022
|
+
/** POST /api/settings/ai/test — Test Ai Connection. */
|
|
1023
|
+
testAiConnection<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1024
|
+
/** POST /api/settings/geoip/test — Test Geoip Lookup. */
|
|
1025
|
+
testGeoipLookup<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1026
|
+
/** POST /api/settings/test-index-pattern — Test Index Pattern. */
|
|
1027
|
+
testIndexPattern<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1028
|
+
/** POST /api/settings/opensearch/test — Test Opensearch Connection. */
|
|
1029
|
+
testOpensearchConnection<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1030
|
+
/** POST /api/settings/webhooks/test — Test Webhook. */
|
|
1031
|
+
testWebhook<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1032
|
+
/** PUT /api/settings/{key} — Update Setting. */
|
|
1033
|
+
update<T = unknown>(key: string, options?: RequestOptions): Promise<T>;
|
|
1034
|
+
/** PUT /api/settings/alert-clustering — Update Alert Clustering Settings. */
|
|
1035
|
+
updateAlertClustering<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1036
|
+
/** PUT /api/settings/explore — Update Explore Settings. */
|
|
1037
|
+
updateExplore<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1038
|
+
/** PUT /api/settings/geoip — Update Geoip Settings. */
|
|
1039
|
+
updateGeoip<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1040
|
+
/** PUT /api/settings/security — Update Security Settings. */
|
|
1041
|
+
updateSecurity<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1042
|
+
/** PUT /api/settings/version-cleanup — Update Version Cleanup Settings. */
|
|
1043
|
+
updateVersionCleanup<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1044
|
+
}
|
|
1045
|
+
/** `chad` resource `sla`. */
|
|
1046
|
+
declare class ChadSla extends Resource {
|
|
1047
|
+
/** GET /api/sla-policy — Read Sla Policy. */
|
|
1048
|
+
readSlaPolicy<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1049
|
+
/** PUT /api/sla-policy — Update Sla Policy. */
|
|
1050
|
+
updateSlaPolicy<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1051
|
+
}
|
|
1052
|
+
/** `chad` resource `stats`. */
|
|
1053
|
+
declare class ChadStats extends Resource {
|
|
1054
|
+
/** GET /api/stats/alerts-timeseries — Get Alert Timeseries. */
|
|
1055
|
+
getAlertTimeseries<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1056
|
+
/** GET /api/stats/dashboard — Get Dashboard Stats. */
|
|
1057
|
+
getDashboard<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1058
|
+
/** GET /api/stats/ioc-matches — Get Ioc Match Stats. */
|
|
1059
|
+
getIocMatch<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1060
|
+
/** GET /api/stats/rule-precision — Get Rule Precision Stats. */
|
|
1061
|
+
getRulePrecision<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1062
|
+
/** GET /api/stats/health — Get System Health. */
|
|
1063
|
+
getSystemHealth<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1064
|
+
}
|
|
1065
|
+
/** `chad` resource `storage`. */
|
|
1066
|
+
declare class ChadStorage extends Resource {
|
|
1067
|
+
/** GET /api/storage/snapshot-repository — Get Snapshot Repository. */
|
|
1068
|
+
getSnapshotRepository<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1069
|
+
/** GET /api/storage/lifecycle — Get Storage Lifecycle. */
|
|
1070
|
+
getStorageLifecycle<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1071
|
+
/** PUT /api/storage/snapshot-repository — Put Snapshot Repository. */
|
|
1072
|
+
putSnapshotRepository<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1073
|
+
/** PUT /api/storage/lifecycle — Put Storage Lifecycle. */
|
|
1074
|
+
putStorageLifecycle<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1075
|
+
}
|
|
1076
|
+
/** `chad` resource `suite`. */
|
|
1077
|
+
declare class ChadSuite extends Resource {
|
|
1078
|
+
/** GET /api/suite/status — Suite Status. */
|
|
1079
|
+
suiteStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1080
|
+
}
|
|
1081
|
+
/** `chad` resource `system_logs`. */
|
|
1082
|
+
declare class ChadSystemLogs extends Resource {
|
|
1083
|
+
/** GET /api/system-logs/stats — Get System Log Stats. */
|
|
1084
|
+
getSystemLogStats<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1085
|
+
/** GET /api/system-logs — List System Logs. */
|
|
1086
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1087
|
+
/** DELETE /api/system-logs — Purge System Logs. */
|
|
1088
|
+
purge<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1089
|
+
}
|
|
1090
|
+
/** `chad` resource `teams`. */
|
|
1091
|
+
declare class ChadTeams extends Resource {
|
|
1092
|
+
/** GET /api/teams — List Teams. */
|
|
1093
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1094
|
+
/** GET /api/teams/{team_id}/members — List Team Members. */
|
|
1095
|
+
listTeamMembers<T = unknown>(teamId: string, options?: RequestOptions): Promise<T>;
|
|
1096
|
+
}
|
|
1097
|
+
/** `chad` resource `threat_intelligence`. */
|
|
1098
|
+
declare class ChadThreatIntelligence extends Resource {
|
|
1099
|
+
/** DELETE /api/ti/{source_type} — Delete Ti Source. */
|
|
1100
|
+
deleteTiSource<T = unknown>(sourceType: string, options?: RequestOptions): Promise<T>;
|
|
1101
|
+
/** GET /api/ti/automation/config — Get Ti Automation. */
|
|
1102
|
+
getTiAutomation<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1103
|
+
/** GET /api/ti/{source_type} — Get Ti Source. */
|
|
1104
|
+
getTiSource<T = unknown>(sourceType: string, options?: RequestOptions): Promise<T>;
|
|
1105
|
+
/** GET /api/ti — List Ti Sources. */
|
|
1106
|
+
listTiSources<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1107
|
+
/** POST /api/ti/{source_type}/test-saved — Test Saved Ti Source. */
|
|
1108
|
+
testSavedTiSource<T = unknown>(sourceType: string, options?: RequestOptions): Promise<T>;
|
|
1109
|
+
/** POST /api/ti/{source_type}/test — Test Ti Source. */
|
|
1110
|
+
testTiSource<T = unknown>(sourceType: string, options?: RequestOptions): Promise<T>;
|
|
1111
|
+
/** PUT /api/ti/automation/config — Update Ti Automation. */
|
|
1112
|
+
updateTiAutomation<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1113
|
+
/** PUT /api/ti/{source_type} — Update Ti Source. */
|
|
1114
|
+
updateTiSource<T = unknown>(sourceType: string, options?: RequestOptions): Promise<T>;
|
|
1115
|
+
}
|
|
1116
|
+
/** `chad` resource `timelines`. */
|
|
1117
|
+
declare class ChadTimelines extends Resource {
|
|
1118
|
+
/** POST /api/timelines/{timeline_id}/items — Add Item. */
|
|
1119
|
+
addItem<T = unknown>(timelineId: string, options?: RequestOptions): Promise<T>;
|
|
1120
|
+
/** POST /api/timelines/{timeline_id}/members — Add Member. */
|
|
1121
|
+
addMember<T = unknown>(timelineId: string, options?: RequestOptions): Promise<T>;
|
|
1122
|
+
/** POST /api/timelines — Create Timeline. */
|
|
1123
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1124
|
+
/** DELETE /api/timelines/{timeline_id} — Delete Timeline. */
|
|
1125
|
+
delete<T = unknown>(timelineId: string, options?: RequestOptions): Promise<T>;
|
|
1126
|
+
/** DELETE /api/timelines/{timeline_id}/items/{item_id} — Delete Item. */
|
|
1127
|
+
deleteItem<T = unknown>(timelineId: string, itemId: string, options?: RequestOptions): Promise<T>;
|
|
1128
|
+
/** POST /api/timelines/{timeline_id}/escalate — Escalate Timeline. */
|
|
1129
|
+
escalate<T = unknown>(timelineId: string, options?: RequestOptions): Promise<T>;
|
|
1130
|
+
/** GET /api/timelines/{timeline_id} — Get Timeline. */
|
|
1131
|
+
get<T = unknown>(timelineId: string, options?: RequestOptions): Promise<T>;
|
|
1132
|
+
/** GET /api/timelines — List Timelines. */
|
|
1133
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1134
|
+
/** GET /api/timelines/collaborator-candidates — List Collaborator Candidates. */
|
|
1135
|
+
listCollaboratorCandidates<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1136
|
+
/** GET /api/timelines/{timeline_id}/members — List Members. */
|
|
1137
|
+
listMembers<T = unknown>(timelineId: string, options?: RequestOptions): Promise<T>;
|
|
1138
|
+
/** DELETE /api/timelines/{timeline_id}/members/{user_id} — Remove Member. */
|
|
1139
|
+
removeMember<T = unknown>(timelineId: string, userId: string, options?: RequestOptions): Promise<T>;
|
|
1140
|
+
/** PUT /api/timelines/{timeline_id} — Update Timeline. */
|
|
1141
|
+
update<T = unknown>(timelineId: string, options?: RequestOptions): Promise<T>;
|
|
1142
|
+
/** PATCH /api/timelines/{timeline_id}/items/{item_id} — Update Item. */
|
|
1143
|
+
updateItem<T = unknown>(timelineId: string, itemId: string, options?: RequestOptions): Promise<T>;
|
|
1144
|
+
}
|
|
1145
|
+
/** `chad` resource `tuning`. */
|
|
1146
|
+
declare class ChadTuning extends Resource {
|
|
1147
|
+
/** POST /api/tuning/proposals/{proposal_id}/accept — Accept Tuning Proposal. */
|
|
1148
|
+
acceptTuningProposal<T = unknown>(proposalId: string, options?: RequestOptions): Promise<T>;
|
|
1149
|
+
/** POST /api/tuning/proposals — Create Tuning Proposal. */
|
|
1150
|
+
createTuningProposal<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1151
|
+
/** GET /api/tuning/proposals/{proposal_id} — Get Tuning Proposal. */
|
|
1152
|
+
getTuningProposal<T = unknown>(proposalId: string, options?: RequestOptions): Promise<T>;
|
|
1153
|
+
/** GET /api/tuning/proposals — List Tuning Proposals. */
|
|
1154
|
+
listTuningProposals<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1155
|
+
/** POST /api/tuning/proposals/{proposal_id}/reject — Reject Tuning Proposal. */
|
|
1156
|
+
rejectTuningProposal<T = unknown>(proposalId: string, options?: RequestOptions): Promise<T>;
|
|
1157
|
+
/** GET /api/tuning/metrics — Rule Quality Metrics. */
|
|
1158
|
+
ruleQualityMetrics<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1159
|
+
/** PATCH /api/tuning/proposals/{proposal_id} — Update Tuning Proposal. */
|
|
1160
|
+
updateTuningProposal<T = unknown>(proposalId: string, options?: RequestOptions): Promise<T>;
|
|
1161
|
+
}
|
|
1162
|
+
/** `chad` resource `users`. */
|
|
1163
|
+
declare class ChadUsers extends Resource {
|
|
1164
|
+
/** GET /api/users — List Users. */
|
|
1165
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1166
|
+
}
|
|
1167
|
+
/** `chad` resource `warden`. */
|
|
1168
|
+
declare class ChadWarden extends Resource {
|
|
1169
|
+
/** POST /api/warden/bindings — Create Warden Binding. */
|
|
1170
|
+
createWardenBinding<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1171
|
+
/** DELETE /api/warden/bindings/{binding_id} — Delete Warden Binding. */
|
|
1172
|
+
deleteWardenBinding<T = unknown>(bindingId: string, options?: RequestOptions): Promise<T>;
|
|
1173
|
+
/** GET /api/warden/alert/{alert_id}/linked-case — Get Alert Linked Case. */
|
|
1174
|
+
getAlertLinkedCase<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
1175
|
+
/** GET /api/warden/config — Get Warden Config. */
|
|
1176
|
+
getWardenConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1177
|
+
/** GET /api/warden/related-cases — List Related Cases. */
|
|
1178
|
+
listRelatedCases<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1179
|
+
/** GET /api/warden/bindings — List Warden Bindings. */
|
|
1180
|
+
listWardenBindings<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1181
|
+
/** POST /api/warden/test — Test Warden Connection. */
|
|
1182
|
+
testWardenConnection<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1183
|
+
/** PATCH /api/warden/bindings/{binding_id} — Update Warden Binding. */
|
|
1184
|
+
updateWardenBinding<T = unknown>(bindingId: string, options?: RequestOptions): Promise<T>;
|
|
1185
|
+
/** PUT /api/warden/config — Update Warden Config. */
|
|
1186
|
+
updateWardenConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1187
|
+
}
|
|
1188
|
+
/** `chad` resource `webhooks`. */
|
|
1189
|
+
declare class ChadWebhooks extends Resource {
|
|
1190
|
+
/** POST /api/webhooks — Create Webhook. */
|
|
1191
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1192
|
+
/** DELETE /api/webhooks/{webhook_id} — Delete Webhook. */
|
|
1193
|
+
delete<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
1194
|
+
/** GET /api/webhooks/{webhook_id} — Get Webhook. */
|
|
1195
|
+
get<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
1196
|
+
/** GET /api/webhooks — List Webhooks. */
|
|
1197
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1198
|
+
/** POST /api/webhooks/{webhook_id}/test — Test Webhook. */
|
|
1199
|
+
test<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
1200
|
+
/** PATCH /api/webhooks/{webhook_id} — Update Webhook. */
|
|
1201
|
+
update<T = unknown>(webhookId: string, options?: RequestOptions): Promise<T>;
|
|
1202
|
+
}
|
|
1203
|
+
/** `vectorflow` resource `alerts`. */
|
|
1204
|
+
declare class VectorflowAlerts extends Resource {
|
|
1205
|
+
/** POST /api/v1/alerts/rules — Create alert rule. */
|
|
1206
|
+
createAlertRule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1207
|
+
/** GET /api/v1/alerts/rules — List alert rules. */
|
|
1208
|
+
listAlertRules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1209
|
+
}
|
|
1210
|
+
/** `vectorflow` resource `audit`. */
|
|
1211
|
+
declare class VectorflowAudit extends Resource {
|
|
1212
|
+
/** GET /api/v1/audit — List audit events. */
|
|
1213
|
+
listAuditEvents<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1214
|
+
}
|
|
1215
|
+
/** `vectorflow` resource `deploy_requests`. */
|
|
1216
|
+
declare class VectorflowDeployRequests extends Resource {
|
|
1217
|
+
/** POST /api/v1/deploy-requests/{id}/approve — Approve deploy request. */
|
|
1218
|
+
approve<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1219
|
+
/** GET /api/v1/deploy-requests — List deploy requests. */
|
|
1220
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1221
|
+
/** POST /api/v1/deploy-requests/{id}/reject — Reject deploy request. */
|
|
1222
|
+
reject<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1223
|
+
}
|
|
1224
|
+
/** `vectorflow` resource `environments`. */
|
|
1225
|
+
declare class VectorflowEnvironments extends Resource {
|
|
1226
|
+
/** GET /api/v1/environments — List environments. */
|
|
1227
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1228
|
+
}
|
|
1229
|
+
/** `vectorflow` resource `fleet`. */
|
|
1230
|
+
declare class VectorflowFleet extends Resource {
|
|
1231
|
+
/** GET /api/v1/fleet/overview — Fleet overview. */
|
|
1232
|
+
getFleetOverview<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1233
|
+
}
|
|
1234
|
+
/** `vectorflow` resource `node_groups`. */
|
|
1235
|
+
declare class VectorflowNodeGroups extends Resource {
|
|
1236
|
+
/** POST /api/v1/node-groups — Create node group. */
|
|
1237
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1238
|
+
/** GET /api/v1/node-groups — List node groups. */
|
|
1239
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1240
|
+
}
|
|
1241
|
+
/** `vectorflow` resource `nodes`. */
|
|
1242
|
+
declare class VectorflowNodes extends Resource {
|
|
1243
|
+
/** POST /api/v1/nodes — Register node. */
|
|
1244
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1245
|
+
/** DELETE /api/v1/nodes/{id} — Remove node. */
|
|
1246
|
+
delete<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1247
|
+
/** GET /api/v1/nodes/{id} — Get node. */
|
|
1248
|
+
get<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1249
|
+
/** GET /api/v1/nodes/{id}/metrics — Get node metrics. */
|
|
1250
|
+
getNodeMetrics<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1251
|
+
/** GET /api/v1/nodes — List nodes. */
|
|
1252
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1253
|
+
/** POST /api/v1/nodes/{id}/maintenance — Toggle maintenance mode. */
|
|
1254
|
+
toggleMaintenance<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1255
|
+
/** PUT /api/v1/nodes/{id}/labels — Update node labels. */
|
|
1256
|
+
updateNodeLabels<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1257
|
+
}
|
|
1258
|
+
/** `vectorflow` resource `pipelines`. */
|
|
1259
|
+
declare class VectorflowPipelines extends Resource {
|
|
1260
|
+
/** POST /api/v1/pipelines/{id}/edges — Add edge to pipeline. */
|
|
1261
|
+
addPipelineEdge<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1262
|
+
/** POST /api/v1/pipelines/{id}/nodes — Add node to pipeline. */
|
|
1263
|
+
addPipelineNode<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1264
|
+
/** POST /api/v1/pipelines — Create pipeline. */
|
|
1265
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1266
|
+
/** DELETE /api/v1/pipelines/{id} — Delete pipeline. */
|
|
1267
|
+
delete<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1268
|
+
/** DELETE /api/v1/pipelines/{id}/edges/{edgeId} — Remove edge from pipeline. */
|
|
1269
|
+
deletePipelineEdge<T = unknown>(id: string, edgeId: string, options?: RequestOptions): Promise<T>;
|
|
1270
|
+
/** DELETE /api/v1/pipelines/{id}/nodes/{nodeId} — Remove node from pipeline. */
|
|
1271
|
+
deletePipelineNode<T = unknown>(id: string, nodeId: string, options?: RequestOptions): Promise<T>;
|
|
1272
|
+
/** POST /api/v1/pipelines/{id}/deploy — Deploy pipeline. */
|
|
1273
|
+
deploy<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1274
|
+
/** GET /api/v1/pipelines/{id} — Get pipeline. */
|
|
1275
|
+
get<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1276
|
+
/** GET /api/v1/pipelines/{id}/config — Get generated YAML config. */
|
|
1277
|
+
getPipelineConfig<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1278
|
+
/** GET /api/v1/pipelines/{id}/health — Get pipeline health. */
|
|
1279
|
+
getPipelineHealth<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1280
|
+
/** GET /api/v1/pipelines/{id}/logs — Get pipeline logs. */
|
|
1281
|
+
getPipelineLogs<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1282
|
+
/** GET /api/v1/pipelines/{id}/metrics — Get pipeline metrics. */
|
|
1283
|
+
getPipelineMetrics<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1284
|
+
/** POST /api/v1/pipelines/import — Import pipeline from YAML. */
|
|
1285
|
+
import<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1286
|
+
/** GET /api/v1/pipelines — List pipelines. */
|
|
1287
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1288
|
+
/** GET /api/v1/pipelines/{id}/versions — List pipeline versions. */
|
|
1289
|
+
listPipelineVersions<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1290
|
+
/** POST /api/v1/pipelines/{id}/promote — Promote pipeline. */
|
|
1291
|
+
promote<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1292
|
+
/** POST /api/v1/pipelines/{id}/rollback — Rollback pipeline. */
|
|
1293
|
+
rollback<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1294
|
+
/** POST /api/v1/pipelines/{id}/undeploy — Undeploy pipeline. */
|
|
1295
|
+
undeploy<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1296
|
+
/** PUT /api/v1/pipelines/{id} — Update pipeline metadata. */
|
|
1297
|
+
update<T = unknown>(id: string, options?: RequestOptions): Promise<T>;
|
|
1298
|
+
/** PUT /api/v1/pipelines/{id}/nodes/{nodeId} — Update node config. */
|
|
1299
|
+
updatePipelineNode<T = unknown>(id: string, nodeId: string, options?: RequestOptions): Promise<T>;
|
|
1300
|
+
}
|
|
1301
|
+
/** `vectorflow` resource `secrets`. */
|
|
1302
|
+
declare class VectorflowSecrets extends Resource {
|
|
1303
|
+
/** POST /api/v1/secrets — Create secret. */
|
|
1304
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1305
|
+
/** DELETE /api/v1/secrets — Delete secret. */
|
|
1306
|
+
delete<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1307
|
+
/** GET /api/v1/secrets — List secrets. */
|
|
1308
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1309
|
+
/** PUT /api/v1/secrets — Update secret. */
|
|
1310
|
+
update<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1311
|
+
}
|
|
1312
|
+
/** `warden` resource `actions`. */
|
|
1313
|
+
declare class WardenActions extends Resource {
|
|
1314
|
+
/** GET /api/actions — Get Actions. */
|
|
1315
|
+
get<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1316
|
+
}
|
|
1317
|
+
/** `warden` resource `ai_authoring`. */
|
|
1318
|
+
declare class WardenAiAuthoring extends Resource {
|
|
1319
|
+
/** POST /api/ai/runbook-drafts — Draft Runbook. */
|
|
1320
|
+
draftRunbook<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1321
|
+
/** POST /api/ai/runs/{run_id}/explanation — Explain Run. */
|
|
1322
|
+
explainRun<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1323
|
+
}
|
|
1324
|
+
/** `warden` resource `ai_settings`. */
|
|
1325
|
+
declare class WardenAiSettings extends Resource {
|
|
1326
|
+
/** GET /api/settings/ai — Get Ai Config. */
|
|
1327
|
+
getAiConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1328
|
+
/** GET /api/settings/ai/status — Get Ai Status. */
|
|
1329
|
+
getAiStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1330
|
+
/** PUT /api/settings/ai — Put Ai Config. */
|
|
1331
|
+
putAiConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1332
|
+
/** POST /api/settings/ai/test — Test Ai Config. */
|
|
1333
|
+
testAiConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1334
|
+
}
|
|
1335
|
+
/** `warden` resource `ai_triage`. */
|
|
1336
|
+
declare class WardenAiTriage extends Resource {
|
|
1337
|
+
/** GET /api/cases/{case_id}/ai-triage — Get Ai Triage. */
|
|
1338
|
+
get<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1339
|
+
/** POST /api/cases/{case_id}/ai-triage — Run Ai Triage. */
|
|
1340
|
+
run<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1341
|
+
/** POST /api/cases/{case_id}/ai-triage/feedback — Submit Ai Triage Feedback. */
|
|
1342
|
+
submitAiTriageFeedback<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1343
|
+
}
|
|
1344
|
+
/** `warden` resource `alerts`. */
|
|
1345
|
+
declare class WardenAlerts extends Resource {
|
|
1346
|
+
/** POST /api/alerts/backfill — Backfill Alerts. */
|
|
1347
|
+
backfill<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1348
|
+
/** POST /api/alerts — Create Alert. */
|
|
1349
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1350
|
+
/** POST /api/alerts/{alert_id}/dismiss — Dismiss Alert. */
|
|
1351
|
+
dismiss<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
1352
|
+
/** POST /api/alerts/{alert_id}/escalate — Escalate Alert. */
|
|
1353
|
+
escalate<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
1354
|
+
/** POST /api/alerts/{alert_id}/link — Link Alert. */
|
|
1355
|
+
link<T = unknown>(alertId: string, options?: RequestOptions): Promise<T>;
|
|
1356
|
+
/** GET /api/alerts — List Alerts. */
|
|
1357
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1358
|
+
}
|
|
1359
|
+
/** `warden` resource `approval_policy`. */
|
|
1360
|
+
declare class WardenApprovalPolicy extends Resource {
|
|
1361
|
+
/** POST /api/approval-policy/exceptions — Create Exception. */
|
|
1362
|
+
createException<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1363
|
+
/** GET /api/approval-policy/exceptions — List Exceptions. */
|
|
1364
|
+
listExceptions<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1365
|
+
/** POST /api/approval-policy/exceptions/{exception_id}/revoke — Revoke Exception. */
|
|
1366
|
+
revokeException<T = unknown>(exceptionId: string, options?: RequestOptions): Promise<T>;
|
|
1367
|
+
}
|
|
1368
|
+
/** `warden` resource `approvals`. */
|
|
1369
|
+
declare class WardenApprovals extends Resource {
|
|
1370
|
+
/** GET /api/approvals — List Approvals. */
|
|
1371
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1372
|
+
}
|
|
1373
|
+
/** `warden` resource `audit`. */
|
|
1374
|
+
declare class WardenAudit extends Resource {
|
|
1375
|
+
/** GET /api/audit — List Audit. */
|
|
1376
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1377
|
+
/** GET /api/audit/actors — List Audit Actors. */
|
|
1378
|
+
listAuditActors<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1379
|
+
/** GET /api/audit/verify — Verify Audit Chain. */
|
|
1380
|
+
verifyAuditChain<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1381
|
+
}
|
|
1382
|
+
/** `warden` resource `authority_revisions`. */
|
|
1383
|
+
declare class WardenAuthorityRevisions extends Resource {
|
|
1384
|
+
/** POST /api/authority/revisions — Ingest Authority Revisions. */
|
|
1385
|
+
ingest<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1386
|
+
}
|
|
1387
|
+
/** `warden` resource `bindings`. */
|
|
1388
|
+
declare class WardenBindings extends Resource {
|
|
1389
|
+
/** POST /api/bindings — Create Binding. */
|
|
1390
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1391
|
+
/** DELETE /api/bindings/{binding_id} — Delete Binding. */
|
|
1392
|
+
delete<T = unknown>(bindingId: string, options?: RequestOptions): Promise<T>;
|
|
1393
|
+
/** GET /api/bindings — List Bindings. */
|
|
1394
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1395
|
+
/** PATCH /api/bindings/{binding_id} — Update Binding. */
|
|
1396
|
+
update<T = unknown>(bindingId: string, options?: RequestOptions): Promise<T>;
|
|
1397
|
+
}
|
|
1398
|
+
/** `warden` resource `capacity`. */
|
|
1399
|
+
declare class WardenCapacity extends Resource {
|
|
1400
|
+
/** GET /api/capacity — Capacity Status. */
|
|
1401
|
+
capacityStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1402
|
+
}
|
|
1403
|
+
/** `warden` resource `case_policies`. */
|
|
1404
|
+
declare class WardenCasePolicies extends Resource {
|
|
1405
|
+
/** POST /api/case-policies — Create Policy. */
|
|
1406
|
+
createPolicy<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1407
|
+
/** DELETE /api/case-policies/{policy_id} — Delete Policy. */
|
|
1408
|
+
deletePolicy<T = unknown>(policyId: string, options?: RequestOptions): Promise<T>;
|
|
1409
|
+
/** GET /api/case-policies — List Policies. */
|
|
1410
|
+
listPolicies<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1411
|
+
/** POST /api/case-policies/migrate — Migrate Case Policies. */
|
|
1412
|
+
migrate<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1413
|
+
/** PATCH /api/case-policies/{policy_id} — Update Policy. */
|
|
1414
|
+
updatePolicy<T = unknown>(policyId: string, options?: RequestOptions): Promise<T>;
|
|
1415
|
+
}
|
|
1416
|
+
/** `warden` resource `case_templates`. */
|
|
1417
|
+
declare class WardenCaseTemplates extends Resource {
|
|
1418
|
+
/** POST /api/case-templates — Create Template. */
|
|
1419
|
+
createTemplate<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1420
|
+
/** DELETE /api/case-templates/{template_id} — Delete Template. */
|
|
1421
|
+
deleteTemplate<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1422
|
+
/** GET /api/case-templates/{template_id} — Get Template. */
|
|
1423
|
+
getTemplate<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1424
|
+
/** GET /api/case-templates — List Templates. */
|
|
1425
|
+
listTemplates<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1426
|
+
/** PUT /api/case-templates/{template_id} — Update Template. */
|
|
1427
|
+
updateTemplate<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1428
|
+
}
|
|
1429
|
+
/** `warden` resource `cases`. */
|
|
1430
|
+
declare class WardenCases extends Resource {
|
|
1431
|
+
/** POST /api/cases/{case_id}/acknowledge — Acknowledge Case. */
|
|
1432
|
+
acknowledge<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1433
|
+
/** POST /api/cases/{case_id}/evidence — Add Case Evidence. */
|
|
1434
|
+
addCaseEvidence<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1435
|
+
/** POST /api/cases/{case_id}/members — Add Case Member. */
|
|
1436
|
+
addCaseMember<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1437
|
+
/** POST /api/cases/{case_id}/observables — Add Case Observable. */
|
|
1438
|
+
addCaseObservable<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1439
|
+
/** POST /api/cases/{case_id}/tasks — Add Case Task. */
|
|
1440
|
+
addCaseTask<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1441
|
+
/** POST /api/cases/{case_id}/comments — Add Comment. */
|
|
1442
|
+
addComment<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1443
|
+
/** POST /api/cases/{case_id}/tasks/{task_id}/comments — Add Task Comment. */
|
|
1444
|
+
addTaskComment<T = unknown>(caseId: string, taskId: string, options?: RequestOptions): Promise<T>;
|
|
1445
|
+
/** POST /api/cases/{case_id}/apply-template — Apply Case Template. */
|
|
1446
|
+
applyCaseTemplate<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1447
|
+
/** POST /api/cases/{case_id}/assign — Assign Case. */
|
|
1448
|
+
assign<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1449
|
+
/** GET /api/cases/assignable-users — Assignable Users. */
|
|
1450
|
+
assignableUsers<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1451
|
+
/** GET /api/cases/{case_id}/links — Case Link Graph. */
|
|
1452
|
+
caseLinkGraph<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1453
|
+
/** GET /api/cases/{case_id}/presence — Case Presence. */
|
|
1454
|
+
casePresence<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1455
|
+
/** GET /api/cases/{case_id}/timeline — Case Timeline. */
|
|
1456
|
+
caseTimeline<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1457
|
+
/** GET /api/cases/{case_id}/war-room — Case War Room. */
|
|
1458
|
+
caseWarRoom<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1459
|
+
/** POST /api/cases/{case_id}/status — Change Case Status. */
|
|
1460
|
+
changeCaseStatus<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1461
|
+
/** POST /api/cases — Create Case. */
|
|
1462
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1463
|
+
/** POST /api/cases/{case_id}/links — Create Case Link. */
|
|
1464
|
+
createCaseLink<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1465
|
+
/** POST /api/cases/{case_id}/portal-shares — Create Portal Share. */
|
|
1466
|
+
createPortalShare<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1467
|
+
/** DELETE /api/cases/{case_id}/observables/{observable_id} — Delete Case Observable. */
|
|
1468
|
+
deleteCaseObservable<T = unknown>(caseId: string, observableId: string, options?: RequestOptions): Promise<T>;
|
|
1469
|
+
/** DELETE /api/cases/{case_id}/comments/{comment_id} — Delete Comment. */
|
|
1470
|
+
deleteComment<T = unknown>(caseId: string, commentId: string, options?: RequestOptions): Promise<T>;
|
|
1471
|
+
/** DELETE /api/cases/{case_id}/tasks/{task_id}/comments/{comment_id} — Delete Task Comment. */
|
|
1472
|
+
deleteTaskComment<T = unknown>(caseId: string, taskId: string, commentId: string, options?: RequestOptions): Promise<T>;
|
|
1473
|
+
/** GET /api/cases/{case_id}/attachments/{attachment_id}/download — Download Attachment. */
|
|
1474
|
+
downloadAttachment<T = unknown>(caseId: string, attachmentId: string, options?: RequestOptions): Promise<T>;
|
|
1475
|
+
/** GET /api/cases/{case_id}/evidence-package — Export Evidence Package. */
|
|
1476
|
+
exportEvidencePackage<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1477
|
+
/** GET /api/cases/{case_id} — Get Case. */
|
|
1478
|
+
get<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1479
|
+
/** POST /api/cases/{case_id}/alerts/{alert_id} — Link Case Alert. */
|
|
1480
|
+
linkCaseAlert<T = unknown>(caseId: string, alertId: string, options?: RequestOptions): Promise<T>;
|
|
1481
|
+
/** GET /api/cases — List Cases. */
|
|
1482
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1483
|
+
/** GET /api/cases/{case_id}/attachments — List Attachments. */
|
|
1484
|
+
listAttachments<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1485
|
+
/** GET /api/cases/{case_id}/alerts — List Case Alerts. */
|
|
1486
|
+
listCaseAlerts<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1487
|
+
/** GET /api/cases/{case_id}/members — List Case Members. */
|
|
1488
|
+
listCaseMembers<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1489
|
+
/** GET /api/cases/{case_id}/runs — List Case Runs. */
|
|
1490
|
+
listCaseRuns<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1491
|
+
/** GET /api/cases/{case_id}/evidence — List Evidence. */
|
|
1492
|
+
listEvidence<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1493
|
+
/** GET /api/cases/{case_id}/observables — List Observables. */
|
|
1494
|
+
listObservables<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1495
|
+
/** GET /api/cases/{case_id}/portal-shares — List Portal Shares. */
|
|
1496
|
+
listPortalShares<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1497
|
+
/** GET /api/cases/{case_id}/tasks/{task_id}/comments — List Task Comments. */
|
|
1498
|
+
listTaskComments<T = unknown>(caseId: string, taskId: string, options?: RequestOptions): Promise<T>;
|
|
1499
|
+
/** GET /api/cases/{case_id}/tasks — List Tasks. */
|
|
1500
|
+
listTasks<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1501
|
+
/** POST /api/cases/{case_id}/merge — Merge Cases. */
|
|
1502
|
+
merge<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1503
|
+
/** PATCH /api/cases/{case_id}/tasks/{task_id} — Patch Case Task. */
|
|
1504
|
+
patchCaseTask<T = unknown>(caseId: string, taskId: string, options?: RequestOptions): Promise<T>;
|
|
1505
|
+
/** DELETE /api/cases/{case_id}/members/{member_user_id} — Remove Case Member. */
|
|
1506
|
+
removeCaseMember<T = unknown>(caseId: string, memberUserId: string, options?: RequestOptions): Promise<T>;
|
|
1507
|
+
/** POST /api/cases/{case_id}/feedback-stages/{stage_id}/retry — Retry Feedback Stage. */
|
|
1508
|
+
retryFeedbackStage<T = unknown>(caseId: string, stageId: string, options?: RequestOptions): Promise<T>;
|
|
1509
|
+
/** DELETE /api/cases/{case_id}/portal-shares/{share_id} — Revoke Portal Share. */
|
|
1510
|
+
revokePortalShare<T = unknown>(caseId: string, shareId: string, options?: RequestOptions): Promise<T>;
|
|
1511
|
+
/** POST /api/cases/{case_id}/runbooks/{slug}/run — Run Case Runbook. */
|
|
1512
|
+
runCaseRunbook<T = unknown>(caseId: string, slug: string, options?: RequestOptions): Promise<T>;
|
|
1513
|
+
/** DELETE /api/cases/{case_id}/alerts/{alert_id} — Unlink Case Alert. */
|
|
1514
|
+
unlinkCaseAlert<T = unknown>(caseId: string, alertId: string, options?: RequestOptions): Promise<T>;
|
|
1515
|
+
/** PUT /api/cases/{case_id} — Update Case. */
|
|
1516
|
+
update<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1517
|
+
/** POST /api/cases/{case_id}/attachments — Upload Attachment. */
|
|
1518
|
+
uploadAttachment<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1519
|
+
}
|
|
1520
|
+
/** `warden` resource `connections`. */
|
|
1521
|
+
declare class WardenConnections extends Resource {
|
|
1522
|
+
/** POST /api/connections — Create Connection. */
|
|
1523
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1524
|
+
/** DELETE /api/connections/{connection_id} — Delete Connection. */
|
|
1525
|
+
delete<T = unknown>(connectionId: string, options?: RequestOptions): Promise<T>;
|
|
1526
|
+
/** DELETE /api/connections/{connection_id}/fixtures/{action_name} — Delete Connection Fixture. */
|
|
1527
|
+
deleteConnectionFixture<T = unknown>(connectionId: string, actionName: string, options?: RequestOptions): Promise<T>;
|
|
1528
|
+
/** GET /api/connections/{connection_id} — Get Connection. */
|
|
1529
|
+
get<T = unknown>(connectionId: string, options?: RequestOptions): Promise<T>;
|
|
1530
|
+
/** GET /api/connections — List Connections. */
|
|
1531
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1532
|
+
/** GET /api/connections/{connection_id}/fixtures — List Connection Fixtures. */
|
|
1533
|
+
listConnectionFixtures<T = unknown>(connectionId: string, options?: RequestOptions): Promise<T>;
|
|
1534
|
+
/** POST /api/connections/{connection_id}/rotate — Rotate Connection Secret. */
|
|
1535
|
+
rotateConnectionSecret<T = unknown>(connectionId: string, options?: RequestOptions): Promise<T>;
|
|
1536
|
+
/** POST /api/connections/{connection_id}/test — Test Connection. */
|
|
1537
|
+
test<T = unknown>(connectionId: string, options?: RequestOptions): Promise<T>;
|
|
1538
|
+
/** PUT /api/connections/{connection_id} — Update Connection. */
|
|
1539
|
+
update<T = unknown>(connectionId: string, options?: RequestOptions): Promise<T>;
|
|
1540
|
+
/** PUT /api/connections/{connection_id}/fixtures/{action_name} — Upsert Connection Fixture. */
|
|
1541
|
+
upsertConnectionFixture<T = unknown>(connectionId: string, actionName: string, options?: RequestOptions): Promise<T>;
|
|
1542
|
+
}
|
|
1543
|
+
/** `warden` resource `custom_actions`. */
|
|
1544
|
+
declare class WardenCustomActions extends Resource {
|
|
1545
|
+
/** POST /api/custom-actions — Create Custom Action. */
|
|
1546
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1547
|
+
/** DELETE /api/custom-actions/{definition_id} — Delete Custom Action. */
|
|
1548
|
+
delete<T = unknown>(definitionId: string, options?: RequestOptions): Promise<T>;
|
|
1549
|
+
/** GET /api/custom-actions/{definition_id} — Get Custom Action. */
|
|
1550
|
+
get<T = unknown>(definitionId: string, options?: RequestOptions): Promise<T>;
|
|
1551
|
+
/** POST /api/custom-actions/import/openapi — Import Openapi Document. */
|
|
1552
|
+
importOpenapiDocument<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1553
|
+
/** GET /api/custom-actions — List Custom Actions. */
|
|
1554
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1555
|
+
/** POST /api/custom-actions/preview — Preview Custom Action. */
|
|
1556
|
+
preview<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1557
|
+
/** POST /api/custom-actions/test — Test Custom Action Connection. */
|
|
1558
|
+
testCustomActionConnection<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1559
|
+
/** PUT /api/custom-actions/{definition_id} — Update Custom Action. */
|
|
1560
|
+
update<T = unknown>(definitionId: string, options?: RequestOptions): Promise<T>;
|
|
1561
|
+
}
|
|
1562
|
+
/** `warden` resource `diagnostics`. */
|
|
1563
|
+
declare class WardenDiagnostics extends Resource {
|
|
1564
|
+
/** GET /api/diagnostics — Diagnostics. */
|
|
1565
|
+
diagnostics<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1566
|
+
}
|
|
1567
|
+
/** `warden` resource `events`. */
|
|
1568
|
+
declare class WardenEvents extends Resource {
|
|
1569
|
+
/** POST /api/events/chad — Accept one CHAD alert-delivery envelope. */
|
|
1570
|
+
chad<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1571
|
+
}
|
|
1572
|
+
/** `warden` resource `intake_rules`. */
|
|
1573
|
+
declare class WardenIntakeRules extends Resource {
|
|
1574
|
+
/** POST /api/intake-rules — Create Rule. */
|
|
1575
|
+
createRule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1576
|
+
/** DELETE /api/intake-rules/{rule_id} — Delete Rule. */
|
|
1577
|
+
deleteRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
1578
|
+
/** GET /api/intake-rules — List Rules. */
|
|
1579
|
+
listRules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1580
|
+
/** POST /api/intake-rules/test-recent — Test Recent Intakes. */
|
|
1581
|
+
testRecentIntakes<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1582
|
+
/** POST /api/intake-rules/test — Test Rule Set. */
|
|
1583
|
+
testRuleSet<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1584
|
+
/** PATCH /api/intake-rules/{rule_id} — Update Rule. */
|
|
1585
|
+
updateRule<T = unknown>(ruleId: string, options?: RequestOptions): Promise<T>;
|
|
1586
|
+
}
|
|
1587
|
+
/** `warden` resource `integration_packs`. */
|
|
1588
|
+
declare class WardenIntegrationPacks extends Resource {
|
|
1589
|
+
/** GET /api/integration-packs/export — Export Integration Pack. */
|
|
1590
|
+
export<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1591
|
+
/** POST /api/integration-packs/import — Import Integration Pack. */
|
|
1592
|
+
import<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1593
|
+
/** POST /api/integration-packs/registry/{pack_id}/install — Install Registry Pack. */
|
|
1594
|
+
installRegistryPack<T = unknown>(packId: string, options?: RequestOptions): Promise<T>;
|
|
1595
|
+
/** GET /api/integration-packs/registry — List Registry Packs. */
|
|
1596
|
+
listRegistryPacks<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1597
|
+
/** POST /api/integration-packs/import/preview — Preview Integration Pack Import. */
|
|
1598
|
+
previewIntegrationPackImport<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1599
|
+
/** POST /api/integration-packs/upgrade/preview — Preview Integration Pack Upgrade. */
|
|
1600
|
+
previewIntegrationPackUpgrade<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1601
|
+
/** POST /api/integration-packs/registry/{pack_id}/preview — Preview Registry Pack. */
|
|
1602
|
+
previewRegistryPack<T = unknown>(packId: string, options?: RequestOptions): Promise<T>;
|
|
1603
|
+
/** POST /api/integration-packs/registry/{pack_id}/test — Test Registry Pack. */
|
|
1604
|
+
testRegistryPack<T = unknown>(packId: string, options?: RequestOptions): Promise<T>;
|
|
1605
|
+
/** POST /api/integration-packs/upgrade — Upgrade Integration Pack. */
|
|
1606
|
+
upgrade<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1607
|
+
/** POST /api/integration-packs/registry/{pack_id}/upgrade — Upgrade Registry Pack. */
|
|
1608
|
+
upgradeRegistryPack<T = unknown>(packId: string, options?: RequestOptions): Promise<T>;
|
|
1609
|
+
}
|
|
1610
|
+
/** `warden` resource `metrics`. */
|
|
1611
|
+
declare class WardenMetrics extends Resource {
|
|
1612
|
+
/** GET /api/metrics/gate — Gate. */
|
|
1613
|
+
gate<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1614
|
+
/** GET /api/metrics/overview — Overview. */
|
|
1615
|
+
overview<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1616
|
+
/** GET /api/metrics/soc — Soc Metrics. */
|
|
1617
|
+
soc<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1618
|
+
}
|
|
1619
|
+
/** `warden` resource `notifications`. */
|
|
1620
|
+
declare class WardenNotifications extends Resource {
|
|
1621
|
+
/** GET /api/settings/notifications — Get Notification Config. */
|
|
1622
|
+
getNotificationConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1623
|
+
/** GET /api/notifications — List My Notifications. */
|
|
1624
|
+
listMy<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1625
|
+
/** POST /api/notifications/read — Mark Notifications Read. */
|
|
1626
|
+
markNotificationsRead<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1627
|
+
/** PUT /api/settings/notifications — Update Notification Config. */
|
|
1628
|
+
updateNotificationConfig<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1629
|
+
}
|
|
1630
|
+
/** `warden` resource `permissions`. */
|
|
1631
|
+
declare class WardenPermissions extends Resource {
|
|
1632
|
+
/** GET /api/permissions — Get Permissions. */
|
|
1633
|
+
get<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1634
|
+
/** PUT /api/permissions — Update Permission. */
|
|
1635
|
+
update<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1636
|
+
}
|
|
1637
|
+
/** `warden` resource `related_cases`. */
|
|
1638
|
+
declare class WardenRelatedCases extends Resource {
|
|
1639
|
+
/** GET /api/related-cases — Related Cases. */
|
|
1640
|
+
relatedCases<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1641
|
+
}
|
|
1642
|
+
/** `warden` resource `reports`. */
|
|
1643
|
+
declare class WardenReports extends Resource {
|
|
1644
|
+
/** POST /api/reports/schedules — Create Schedule. */
|
|
1645
|
+
createSchedule<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1646
|
+
/** POST /api/reports/templates — Create Template. */
|
|
1647
|
+
createTemplate<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1648
|
+
/** DELETE /api/reports/schedules/{schedule_id} — Delete Schedule. */
|
|
1649
|
+
deleteSchedule<T = unknown>(scheduleId: string, options?: RequestOptions): Promise<T>;
|
|
1650
|
+
/** DELETE /api/reports/templates/{template_id} — Delete Template. */
|
|
1651
|
+
deleteTemplate<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1652
|
+
/** GET /api/reports/runs/{run_id}/download — Download Run. */
|
|
1653
|
+
downloadRun<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1654
|
+
/** POST /api/reports/templates/{template_id}/generate — Generate. */
|
|
1655
|
+
generate<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1656
|
+
/** GET /api/reports/templates/{template_id} — Get Template. */
|
|
1657
|
+
getTemplate<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1658
|
+
/** GET /api/reports/runs — List Runs. */
|
|
1659
|
+
listRuns<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1660
|
+
/** GET /api/reports/schedules — List Schedules. */
|
|
1661
|
+
listSchedules<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1662
|
+
/** GET /api/reports/templates — List Templates. */
|
|
1663
|
+
listTemplates<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1664
|
+
/** GET /api/reports/preview/{template_id} — Preview Markdown. */
|
|
1665
|
+
previewMarkdown<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1666
|
+
/** PUT /api/reports/schedules/{schedule_id} — Update Schedule. */
|
|
1667
|
+
updateSchedule<T = unknown>(scheduleId: string, options?: RequestOptions): Promise<T>;
|
|
1668
|
+
/** PUT /api/reports/templates/{template_id} — Update Template. */
|
|
1669
|
+
updateTemplate<T = unknown>(templateId: string, options?: RequestOptions): Promise<T>;
|
|
1670
|
+
}
|
|
1671
|
+
/** `warden` resource `response_policy`. */
|
|
1672
|
+
declare class WardenResponsePolicy extends Resource {
|
|
1673
|
+
/** GET /api/response-policy — Get Response Policy. */
|
|
1674
|
+
get<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1675
|
+
/** PUT /api/response-policy — Put Response Policy. */
|
|
1676
|
+
put<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1677
|
+
}
|
|
1678
|
+
/** `warden` resource `retention`. */
|
|
1679
|
+
declare class WardenRetention extends Resource {
|
|
1680
|
+
/** GET /api/retention — Retention Status. */
|
|
1681
|
+
retentionStatus<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1682
|
+
}
|
|
1683
|
+
/** `warden` resource `runbooks`. */
|
|
1684
|
+
declare class WardenRunbooks extends Resource {
|
|
1685
|
+
/** POST /api/runbooks/{slug}/debug — Debug Runbook. */
|
|
1686
|
+
debug<T = unknown>(slug: string, options?: RequestOptions): Promise<T>;
|
|
1687
|
+
/** POST /api/runbooks/{slug}/disable — Disable Runbook. */
|
|
1688
|
+
disable<T = unknown>(slug: string, options?: RequestOptions): Promise<T>;
|
|
1689
|
+
/** POST /api/runbooks/{slug}/enable — Enable Runbook. */
|
|
1690
|
+
enable<T = unknown>(slug: string, options?: RequestOptions): Promise<T>;
|
|
1691
|
+
/** GET /api/runbooks/{slug} — Get Runbook. */
|
|
1692
|
+
get<T = unknown>(slug: string, options?: RequestOptions): Promise<T>;
|
|
1693
|
+
/** GET /api/runbooks — List Runbooks. */
|
|
1694
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1695
|
+
/** POST /api/runbooks/{slug}/versions/{version}/review — Review Runbook Version. */
|
|
1696
|
+
reviewRunbookVersion<T = unknown>(slug: string, version: string, options?: RequestOptions): Promise<T>;
|
|
1697
|
+
/** POST /api/runbooks/{slug} — Save Runbook. */
|
|
1698
|
+
save<T = unknown>(slug: string, options?: RequestOptions): Promise<T>;
|
|
1699
|
+
/** POST /api/runbooks/sync — Sync Runbooks. */
|
|
1700
|
+
sync<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1701
|
+
/** GET /api/runbooks/trigger-options — Trigger Options. */
|
|
1702
|
+
triggerOptions<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1703
|
+
/** POST /api/runbooks/trigger-preview — Trigger Preview. */
|
|
1704
|
+
triggerPreview<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1705
|
+
/** POST /api/runbooks/validate — Validate Runbook. */
|
|
1706
|
+
validate<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1707
|
+
}
|
|
1708
|
+
/** `warden` resource `runs`. */
|
|
1709
|
+
declare class WardenRuns extends Resource {
|
|
1710
|
+
/** POST /api/runs/{run_id}/approve — Approve Run. */
|
|
1711
|
+
approve<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1712
|
+
/** POST /api/runs/{run_id}/cancel — Cancel Run. */
|
|
1713
|
+
cancel<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1714
|
+
/** POST /api/runs/{run_id}/debug/continue — Debug Continue. */
|
|
1715
|
+
debugContinue<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1716
|
+
/** POST /api/runs/{run_id}/deny — Deny Run. */
|
|
1717
|
+
deny<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1718
|
+
/** GET /api/runs/{run_id} — Get Run. */
|
|
1719
|
+
get<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1720
|
+
/** GET /api/runs/{run_id}/log — Get Run Log. */
|
|
1721
|
+
getRunLog<T = unknown>(runId: string, options?: RequestOptions): Promise<T>;
|
|
1722
|
+
/** GET /api/runs — List Runs. */
|
|
1723
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1724
|
+
/** POST /api/runs/{run_id}/response-effects/{effect_id}/override — Override Response Effect. */
|
|
1725
|
+
overrideResponseEffect<T = unknown>(runId: string, effectId: string, options?: RequestOptions): Promise<T>;
|
|
1726
|
+
/** POST /api/runs/{run_id}/response-effects/{effect_id}/reverse — Reverse Response Effect. */
|
|
1727
|
+
reverseResponseEffect<T = unknown>(runId: string, effectId: string, options?: RequestOptions): Promise<T>;
|
|
1728
|
+
/** GET /api/runs/chain/verify — Verify Chain Endpoint. */
|
|
1729
|
+
verifyChainEndpoint<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1730
|
+
}
|
|
1731
|
+
/** `warden` resource `sla`. */
|
|
1732
|
+
declare class WardenSla extends Resource {
|
|
1733
|
+
/** POST /api/sla-policies — Create Policy. */
|
|
1734
|
+
createPolicy<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1735
|
+
/** DELETE /api/sla-policies/{policy_id} — Delete Policy. */
|
|
1736
|
+
deletePolicy<T = unknown>(policyId: string, options?: RequestOptions): Promise<T>;
|
|
1737
|
+
/** GET /api/sla-policies/{policy_id} — Get Policy. */
|
|
1738
|
+
getPolicy<T = unknown>(policyId: string, options?: RequestOptions): Promise<T>;
|
|
1739
|
+
/** GET /api/sla-policies — List Policies. */
|
|
1740
|
+
listPolicies<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1741
|
+
/** PUT /api/sla-policies/{policy_id} — Update Policy. */
|
|
1742
|
+
updatePolicy<T = unknown>(policyId: string, options?: RequestOptions): Promise<T>;
|
|
1743
|
+
}
|
|
1744
|
+
/** `warden` resource `teams`. */
|
|
1745
|
+
declare class WardenTeams extends Resource {
|
|
1746
|
+
/** GET /api/teams — My Teams. */
|
|
1747
|
+
my<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1748
|
+
}
|
|
1749
|
+
/** `warden` resource `tickets`. */
|
|
1750
|
+
declare class WardenTickets extends Resource {
|
|
1751
|
+
/** GET /api/tickets/{link_id} — Get Ticket Link. */
|
|
1752
|
+
getTicketLink<T = unknown>(linkId: string, options?: RequestOptions): Promise<T>;
|
|
1753
|
+
/** GET /api/cases/{case_id}/tickets — List Case Tickets. */
|
|
1754
|
+
listCase<T = unknown>(caseId: string, options?: RequestOptions): Promise<T>;
|
|
1755
|
+
}
|
|
1756
|
+
/** `warden` resource `webhook_sources`. */
|
|
1757
|
+
declare class WardenWebhookSources extends Resource {
|
|
1758
|
+
/** POST /api/webhook-sources — Create Webhook Source. */
|
|
1759
|
+
create<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1760
|
+
/** DELETE /api/webhook-sources/{source_id} — Delete Webhook Source. */
|
|
1761
|
+
delete<T = unknown>(sourceId: string, options?: RequestOptions): Promise<T>;
|
|
1762
|
+
/** GET /api/webhook-sources — List Webhook Sources. */
|
|
1763
|
+
list<T = unknown>(options?: RequestOptions): Promise<T>;
|
|
1764
|
+
/** POST /api/webhook-sources/{source_id}/rotate — Rotate Webhook Source Token. */
|
|
1765
|
+
rotateWebhookSourceToken<T = unknown>(sourceId: string, options?: RequestOptions): Promise<T>;
|
|
1766
|
+
/** PATCH /api/webhook-sources/{source_id} — Update Webhook Source. */
|
|
1767
|
+
update<T = unknown>(sourceId: string, options?: RequestOptions): Promise<T>;
|
|
1768
|
+
}
|
|
1769
|
+
/** Every `chad` resource, bound to one transport. */
|
|
1770
|
+
declare class ChadResources {
|
|
1771
|
+
readonly aiCopilot: ChadAiCopilot;
|
|
1772
|
+
readonly alerts: ChadAlerts;
|
|
1773
|
+
readonly apiKeys: ChadApiKeys;
|
|
1774
|
+
readonly attack: ChadAttack;
|
|
1775
|
+
readonly attackNarratives: ChadAttackNarratives;
|
|
1776
|
+
readonly audit: ChadAudit;
|
|
1777
|
+
readonly auditSettings: ChadAuditSettings;
|
|
1778
|
+
readonly authorityRevisions: ChadAuthorityRevisions;
|
|
1779
|
+
readonly circuitBreakers: ChadCircuitBreakers;
|
|
1780
|
+
readonly compliance: ChadCompliance;
|
|
1781
|
+
readonly contentUpdates: ChadContentUpdates;
|
|
1782
|
+
readonly correlation: ChadCorrelation;
|
|
1783
|
+
readonly dashboards: ChadDashboards;
|
|
1784
|
+
readonly dataSources: ChadDataSources;
|
|
1785
|
+
readonly deploymentRequests: ChadDeploymentRequests;
|
|
1786
|
+
readonly detectionPacks: ChadDetectionPacks;
|
|
1787
|
+
readonly diagnostics: ChadDiagnostics;
|
|
1788
|
+
readonly enrichmentWebhooks: ChadEnrichmentWebhooks;
|
|
1789
|
+
readonly entities: ChadEntities;
|
|
1790
|
+
readonly environments: ChadEnvironments;
|
|
1791
|
+
readonly explore: ChadExplore;
|
|
1792
|
+
readonly export: ChadExport;
|
|
1793
|
+
readonly fieldMappings: ChadFieldMappings;
|
|
1794
|
+
readonly gitops: ChadGitops;
|
|
1795
|
+
readonly health: ChadHealth;
|
|
1796
|
+
readonly holds: ChadHolds;
|
|
1797
|
+
readonly hunts: ChadHunts;
|
|
1798
|
+
readonly indicators: ChadIndicators;
|
|
1799
|
+
readonly jira: ChadJira;
|
|
1800
|
+
readonly metrics: ChadMetrics;
|
|
1801
|
+
readonly misp: ChadMisp;
|
|
1802
|
+
readonly mispFeedback: ChadMispFeedback;
|
|
1803
|
+
readonly mispSync: ChadMispSync;
|
|
1804
|
+
readonly mode: ChadMode;
|
|
1805
|
+
readonly notifications: ChadNotifications;
|
|
1806
|
+
readonly overlays: ChadOverlays;
|
|
1807
|
+
readonly permissions: ChadPermissions;
|
|
1808
|
+
readonly queue: ChadQueue;
|
|
1809
|
+
readonly reportSchedules: ChadReportSchedules;
|
|
1810
|
+
readonly reports: ChadReports;
|
|
1811
|
+
readonly retentionPolicy: ChadRetentionPolicy;
|
|
1812
|
+
readonly ruleCi: ChadRuleCi;
|
|
1813
|
+
readonly rulePackConflicts: ChadRulePackConflicts;
|
|
1814
|
+
readonly rules: ChadRules;
|
|
1815
|
+
readonly runtimeContracts: ChadRuntimeContracts;
|
|
1816
|
+
readonly savedViews: ChadSavedViews;
|
|
1817
|
+
readonly settings: ChadSettings;
|
|
1818
|
+
readonly sla: ChadSla;
|
|
1819
|
+
readonly stats: ChadStats;
|
|
1820
|
+
readonly storage: ChadStorage;
|
|
1821
|
+
readonly suite: ChadSuite;
|
|
1822
|
+
readonly systemLogs: ChadSystemLogs;
|
|
1823
|
+
readonly teams: ChadTeams;
|
|
1824
|
+
readonly threatIntelligence: ChadThreatIntelligence;
|
|
1825
|
+
readonly timelines: ChadTimelines;
|
|
1826
|
+
readonly tuning: ChadTuning;
|
|
1827
|
+
readonly users: ChadUsers;
|
|
1828
|
+
readonly warden: ChadWarden;
|
|
1829
|
+
readonly webhooks: ChadWebhooks;
|
|
1830
|
+
constructor(transport: Transport);
|
|
1831
|
+
}
|
|
1832
|
+
/** Every `vectorflow` resource, bound to one transport. */
|
|
1833
|
+
declare class VectorflowResources {
|
|
1834
|
+
readonly alerts: VectorflowAlerts;
|
|
1835
|
+
readonly audit: VectorflowAudit;
|
|
1836
|
+
readonly deployRequests: VectorflowDeployRequests;
|
|
1837
|
+
readonly environments: VectorflowEnvironments;
|
|
1838
|
+
readonly fleet: VectorflowFleet;
|
|
1839
|
+
readonly nodeGroups: VectorflowNodeGroups;
|
|
1840
|
+
readonly nodes: VectorflowNodes;
|
|
1841
|
+
readonly pipelines: VectorflowPipelines;
|
|
1842
|
+
readonly secrets: VectorflowSecrets;
|
|
1843
|
+
constructor(transport: Transport);
|
|
1844
|
+
}
|
|
1845
|
+
/** Every `warden` resource, bound to one transport. */
|
|
1846
|
+
declare class WardenResources {
|
|
1847
|
+
readonly actions: WardenActions;
|
|
1848
|
+
readonly aiAuthoring: WardenAiAuthoring;
|
|
1849
|
+
readonly aiSettings: WardenAiSettings;
|
|
1850
|
+
readonly aiTriage: WardenAiTriage;
|
|
1851
|
+
readonly alerts: WardenAlerts;
|
|
1852
|
+
readonly approvalPolicy: WardenApprovalPolicy;
|
|
1853
|
+
readonly approvals: WardenApprovals;
|
|
1854
|
+
readonly audit: WardenAudit;
|
|
1855
|
+
readonly authorityRevisions: WardenAuthorityRevisions;
|
|
1856
|
+
readonly bindings: WardenBindings;
|
|
1857
|
+
readonly capacity: WardenCapacity;
|
|
1858
|
+
readonly casePolicies: WardenCasePolicies;
|
|
1859
|
+
readonly caseTemplates: WardenCaseTemplates;
|
|
1860
|
+
readonly cases: WardenCases;
|
|
1861
|
+
readonly connections: WardenConnections;
|
|
1862
|
+
readonly customActions: WardenCustomActions;
|
|
1863
|
+
readonly diagnostics: WardenDiagnostics;
|
|
1864
|
+
readonly events: WardenEvents;
|
|
1865
|
+
readonly intakeRules: WardenIntakeRules;
|
|
1866
|
+
readonly integrationPacks: WardenIntegrationPacks;
|
|
1867
|
+
readonly metrics: WardenMetrics;
|
|
1868
|
+
readonly notifications: WardenNotifications;
|
|
1869
|
+
readonly permissions: WardenPermissions;
|
|
1870
|
+
readonly relatedCases: WardenRelatedCases;
|
|
1871
|
+
readonly reports: WardenReports;
|
|
1872
|
+
readonly responsePolicy: WardenResponsePolicy;
|
|
1873
|
+
readonly retention: WardenRetention;
|
|
1874
|
+
readonly runbooks: WardenRunbooks;
|
|
1875
|
+
readonly runs: WardenRuns;
|
|
1876
|
+
readonly sla: WardenSla;
|
|
1877
|
+
readonly teams: WardenTeams;
|
|
1878
|
+
readonly tickets: WardenTickets;
|
|
1879
|
+
readonly webhookSources: WardenWebhookSources;
|
|
1880
|
+
constructor(transport: Transport);
|
|
1881
|
+
}
|
|
1882
|
+
|
|
1883
|
+
/**
|
|
1884
|
+
* Product clients and the suite client.
|
|
1885
|
+
*
|
|
1886
|
+
* One product — a product client at its gateway prefix, authorised by a Veltro
|
|
1887
|
+
* personal access token (`vmcp_…`):
|
|
1888
|
+
*
|
|
1889
|
+
* ```ts
|
|
1890
|
+
* const chad = new ChadClient("https://soc.example.com/chad", { auth: new BearerToken(pat) });
|
|
1891
|
+
* await chad.dataSources.list();
|
|
1892
|
+
* ```
|
|
1893
|
+
*
|
|
1894
|
+
* Suite — one origin served by the gateway, one identity session reaching all
|
|
1895
|
+
* three products under their documented prefixes:
|
|
1896
|
+
*
|
|
1897
|
+
* ```ts
|
|
1898
|
+
* const suite = await VeltroClient.login("https://soc.example.com", email, password, {
|
|
1899
|
+
* vectorflowKey: "vf_live_…",
|
|
1900
|
+
* });
|
|
1901
|
+
* await suite.chad.dataSources.list();
|
|
1902
|
+
* await suite.warden.cases.list();
|
|
1903
|
+
* await suite.vectorflow.pipelines.list();
|
|
1904
|
+
* ```
|
|
1905
|
+
*
|
|
1906
|
+
* The prefixes are the gateway's: `/chad` and `/warden` are stripped toward
|
|
1907
|
+
* their backends, and VectorFlow bakes `/vectorflow` as its basePath.
|
|
1908
|
+
*
|
|
1909
|
+
* VectorFlow's REST v1 accepts **only** an environment-scoped service-account
|
|
1910
|
+
* key — a browser session authenticates the UI and tRPC, not `/api/v1`. A
|
|
1911
|
+
* suite client built without a VectorFlow key therefore refuses on first use
|
|
1912
|
+
* with a named error instead of sending a credential VectorFlow will not
|
|
1913
|
+
* accept.
|
|
1914
|
+
*/
|
|
1915
|
+
|
|
1916
|
+
declare const SUITE_PREFIXES: Record<"chad" | "warden" | "vectorflow", string>;
|
|
1917
|
+
interface ProductClientOptions {
|
|
1918
|
+
auth?: Auth;
|
|
1919
|
+
timeoutMs?: number;
|
|
1920
|
+
retries?: number;
|
|
1921
|
+
maxResponseBytes?: number;
|
|
1922
|
+
fetchImpl?: typeof fetch;
|
|
1923
|
+
}
|
|
1924
|
+
/** A product was addressed without a credential it accepts. */
|
|
1925
|
+
declare class MissingCredentialError extends VeltroError {
|
|
1926
|
+
constructor(product: string, reason: string, member: string);
|
|
1927
|
+
}
|
|
1928
|
+
/** CHAD: detection, alerts, data sources, threat intelligence. */
|
|
1929
|
+
declare class ChadClient extends ChadResources {
|
|
1930
|
+
readonly baseUrl: string;
|
|
1931
|
+
constructor(baseUrl: string, options?: ProductClientOptions);
|
|
1932
|
+
}
|
|
1933
|
+
/** Warden: cases, runbooks, runs, approvals, connections. */
|
|
1934
|
+
declare class WardenClient extends WardenResources {
|
|
1935
|
+
readonly baseUrl: string;
|
|
1936
|
+
constructor(baseUrl: string, options?: ProductClientOptions);
|
|
1937
|
+
}
|
|
1938
|
+
/** VectorFlow REST v1: pipelines, fleet, nodes, secrets, alerts. */
|
|
1939
|
+
declare class VectorFlowClient extends VectorflowResources {
|
|
1940
|
+
readonly baseUrl: string;
|
|
1941
|
+
constructor(baseUrl: string, options?: ProductClientOptions);
|
|
1942
|
+
}
|
|
1943
|
+
interface VeltroClientOptions {
|
|
1944
|
+
session?: SuiteSession;
|
|
1945
|
+
chadAuth?: Auth;
|
|
1946
|
+
wardenAuth?: Auth;
|
|
1947
|
+
vectorflowKey?: string;
|
|
1948
|
+
vectorflowAuth?: Auth;
|
|
1949
|
+
timeoutMs?: number;
|
|
1950
|
+
retries?: number;
|
|
1951
|
+
fetchImpl?: typeof fetch;
|
|
1952
|
+
}
|
|
1953
|
+
interface VeltroLoginOptions extends Omit<VeltroClientOptions, "session"> {
|
|
1954
|
+
allowInsecureTransport?: boolean;
|
|
1955
|
+
}
|
|
1956
|
+
/** One suite origin, one identity session, three products. */
|
|
1957
|
+
declare class VeltroClient {
|
|
1958
|
+
readonly baseUrl: string;
|
|
1959
|
+
readonly session?: SuiteSession;
|
|
1960
|
+
readonly chad: ChadResources;
|
|
1961
|
+
readonly warden: WardenResources;
|
|
1962
|
+
readonly vectorflow: VectorflowResources;
|
|
1963
|
+
constructor(baseUrl: string, options?: VeltroClientOptions);
|
|
1964
|
+
/** Mint a suite session at `baseUrl` and bind all three products. */
|
|
1965
|
+
static login(baseUrl: string, email: string, password: string, options?: VeltroLoginOptions): Promise<VeltroClient>;
|
|
1966
|
+
}
|
|
1967
|
+
|
|
1968
|
+
/**
|
|
1969
|
+
* `@veltrosecurity/sdk` — the TypeScript client for the Veltro security
|
|
1970
|
+
* operations suite.
|
|
1971
|
+
*
|
|
1972
|
+
* Generated from the products' own OpenAPI documents (CHAD, Warden) and
|
|
1973
|
+
* VectorFlow's REST v1 specification; see `scripts/generate_sdk.py` and
|
|
1974
|
+
* `sdk/specs/*-operations.json` in the `veltrosecurity/veltro` repository.
|
|
1975
|
+
*
|
|
1976
|
+
* No runtime dependencies: the transport is `fetch`.
|
|
1977
|
+
*/
|
|
1978
|
+
|
|
1979
|
+
declare const VERSION = "0.15.7";
|
|
1980
|
+
|
|
1981
|
+
export { type Auth, BearerToken, ChadClient, ChadResources, DEFAULT_MAX_RESPONSE_BYTES, DEFAULT_RETRIES, DEFAULT_TIMEOUT_MS, MissingCredentialError, NoAuth, type ProductClientOptions, type QueryValue, type RequestOptions, Resource, SESSION_COOKIE_PREFIX, SUITE_PREFIXES, SuiteSession, type SuiteSessionOptions, Transport, type TransportOptions, VERSION, VectorFlowClient, VectorflowResources, VeltroApiError, VeltroClient, type VeltroClientOptions, VeltroError, type VeltroLoginOptions, VeltroResponseTooLargeError, VeltroTransportError, WardenClient, WardenResources, quoteSegment };
|