@lumiblue/secrets 0.1.15
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/README.md +50 -0
- package/dist/index.d.ts +2501 -0
- package/dist/index.js +1496 -0
- package/package.json +37 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,2501 @@
|
|
|
1
|
+
// Generated by dts-bundle-generator v9.5.1
|
|
2
|
+
|
|
3
|
+
export type AuthToken = string | undefined;
|
|
4
|
+
export interface Auth {
|
|
5
|
+
/**
|
|
6
|
+
* Which part of the request do we use to send the auth?
|
|
7
|
+
*
|
|
8
|
+
* @default 'header'
|
|
9
|
+
*/
|
|
10
|
+
in?: "header" | "query" | "cookie";
|
|
11
|
+
/**
|
|
12
|
+
* A unique identifier for the security scheme.
|
|
13
|
+
*
|
|
14
|
+
* Defined only when there are multiple security schemes whose `Auth`
|
|
15
|
+
* shape would otherwise be identical.
|
|
16
|
+
*/
|
|
17
|
+
key?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Header or query parameter name.
|
|
20
|
+
*
|
|
21
|
+
* @default 'Authorization'
|
|
22
|
+
*/
|
|
23
|
+
name?: string;
|
|
24
|
+
scheme?: "basic" | "bearer";
|
|
25
|
+
type: "apiKey" | "http";
|
|
26
|
+
}
|
|
27
|
+
export interface SerializerOptions<T> {
|
|
28
|
+
/**
|
|
29
|
+
* @default true
|
|
30
|
+
*/
|
|
31
|
+
explode: boolean;
|
|
32
|
+
style: T;
|
|
33
|
+
}
|
|
34
|
+
export type ArrayStyle = "form" | "spaceDelimited" | "pipeDelimited";
|
|
35
|
+
export type ObjectStyle = "form" | "deepObject";
|
|
36
|
+
export type QuerySerializer = (query: Record<string, unknown>) => string;
|
|
37
|
+
export type BodySerializer = (body: unknown) => unknown;
|
|
38
|
+
export type QuerySerializerOptionsObject = {
|
|
39
|
+
allowReserved?: boolean;
|
|
40
|
+
array?: Partial<SerializerOptions<ArrayStyle>>;
|
|
41
|
+
object?: Partial<SerializerOptions<ObjectStyle>>;
|
|
42
|
+
};
|
|
43
|
+
export type QuerySerializerOptions = QuerySerializerOptionsObject & {
|
|
44
|
+
/**
|
|
45
|
+
* Per-parameter serialization overrides. When provided, these settings
|
|
46
|
+
* override the global array/object settings for specific parameter names.
|
|
47
|
+
*/
|
|
48
|
+
parameters?: Record<string, QuerySerializerOptionsObject>;
|
|
49
|
+
};
|
|
50
|
+
export type HttpMethod = "connect" | "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
51
|
+
export type Client<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
|
|
52
|
+
/**
|
|
53
|
+
* Returns the final request URL.
|
|
54
|
+
*/
|
|
55
|
+
buildUrl: BuildUrlFn;
|
|
56
|
+
getConfig: () => Config;
|
|
57
|
+
request: RequestFn;
|
|
58
|
+
setConfig: (config: Config) => Config;
|
|
59
|
+
} & {
|
|
60
|
+
[K in HttpMethod]: MethodFn;
|
|
61
|
+
} & ([
|
|
62
|
+
SseFn
|
|
63
|
+
] extends [
|
|
64
|
+
never
|
|
65
|
+
] ? {
|
|
66
|
+
sse?: never;
|
|
67
|
+
} : {
|
|
68
|
+
sse: {
|
|
69
|
+
[K in HttpMethod]: SseFn;
|
|
70
|
+
};
|
|
71
|
+
});
|
|
72
|
+
export interface Config {
|
|
73
|
+
/**
|
|
74
|
+
* Auth token or a function returning auth token. The resolved value will be
|
|
75
|
+
* added to the request payload as defined by its `security` array.
|
|
76
|
+
*/
|
|
77
|
+
auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
|
|
78
|
+
/**
|
|
79
|
+
* A function for serializing request body parameter. By default,
|
|
80
|
+
* {@link JSON.stringify()} will be used.
|
|
81
|
+
*/
|
|
82
|
+
bodySerializer?: BodySerializer | null;
|
|
83
|
+
/**
|
|
84
|
+
* An object containing any HTTP headers that you want to pre-populate your
|
|
85
|
+
* `Headers` object with.
|
|
86
|
+
*
|
|
87
|
+
* {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
|
|
88
|
+
*/
|
|
89
|
+
headers?: RequestInit["headers"] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
|
|
90
|
+
/**
|
|
91
|
+
* The request method.
|
|
92
|
+
*
|
|
93
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
|
|
94
|
+
*/
|
|
95
|
+
method?: Uppercase<HttpMethod>;
|
|
96
|
+
/**
|
|
97
|
+
* A function for serializing request query parameters. By default, arrays
|
|
98
|
+
* will be exploded in form style, objects will be exploded in deepObject
|
|
99
|
+
* style, and reserved characters are percent-encoded.
|
|
100
|
+
*
|
|
101
|
+
* This method will have no effect if the native `paramsSerializer()` Axios
|
|
102
|
+
* API function is used.
|
|
103
|
+
*
|
|
104
|
+
* {@link https://swagger.io/docs/specification/serialization/#query View examples}
|
|
105
|
+
*/
|
|
106
|
+
querySerializer?: QuerySerializer | QuerySerializerOptions;
|
|
107
|
+
/**
|
|
108
|
+
* A function validating request data. This is useful if you want to ensure
|
|
109
|
+
* the request conforms to the desired shape, so it can be safely sent to
|
|
110
|
+
* the server.
|
|
111
|
+
*/
|
|
112
|
+
requestValidator?: (data: unknown) => Promise<unknown>;
|
|
113
|
+
/**
|
|
114
|
+
* A function transforming response data before it's returned. This is useful
|
|
115
|
+
* for post-processing data, e.g., converting ISO strings into Date objects.
|
|
116
|
+
*/
|
|
117
|
+
responseTransformer?: (data: unknown) => Promise<unknown>;
|
|
118
|
+
/**
|
|
119
|
+
* A function validating response data. This is useful if you want to ensure
|
|
120
|
+
* the response conforms to the desired shape, so it can be safely passed to
|
|
121
|
+
* the transformers and returned to the user.
|
|
122
|
+
*/
|
|
123
|
+
responseValidator?: (data: unknown) => Promise<unknown>;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Arbitrary metadata passed through the `meta` request option.
|
|
127
|
+
*/
|
|
128
|
+
export interface ClientMeta {
|
|
129
|
+
}
|
|
130
|
+
export type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, "method"> & Pick<Config, "method" | "responseTransformer" | "responseValidator"> & {
|
|
131
|
+
/**
|
|
132
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
133
|
+
* fetch instance.
|
|
134
|
+
*
|
|
135
|
+
* @default globalThis.fetch
|
|
136
|
+
*/
|
|
137
|
+
fetch?: typeof fetch;
|
|
138
|
+
/**
|
|
139
|
+
* Implementing clients can call request interceptors inside this hook.
|
|
140
|
+
*/
|
|
141
|
+
onRequest?: (url: string, init: RequestInit) => Promise<Request>;
|
|
142
|
+
/**
|
|
143
|
+
* Callback invoked when a network or parsing error occurs during streaming.
|
|
144
|
+
*
|
|
145
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
146
|
+
*
|
|
147
|
+
* @param error The error that occurred.
|
|
148
|
+
*/
|
|
149
|
+
onSseError?: (error: unknown) => void;
|
|
150
|
+
/**
|
|
151
|
+
* Callback invoked when an event is streamed from the server.
|
|
152
|
+
*
|
|
153
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
154
|
+
*
|
|
155
|
+
* @param event Event streamed from the server.
|
|
156
|
+
* @returns Nothing (void).
|
|
157
|
+
*/
|
|
158
|
+
onSseEvent?: (event: StreamEvent<TData>) => void;
|
|
159
|
+
serializedBody?: RequestInit["body"];
|
|
160
|
+
/**
|
|
161
|
+
* Default retry delay in milliseconds.
|
|
162
|
+
*
|
|
163
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
164
|
+
*
|
|
165
|
+
* @default 3000
|
|
166
|
+
*/
|
|
167
|
+
sseDefaultRetryDelay?: number;
|
|
168
|
+
/**
|
|
169
|
+
* Maximum number of retry attempts before giving up.
|
|
170
|
+
*/
|
|
171
|
+
sseMaxRetryAttempts?: number;
|
|
172
|
+
/**
|
|
173
|
+
* Maximum retry delay in milliseconds.
|
|
174
|
+
*
|
|
175
|
+
* Applies only when exponential backoff is used.
|
|
176
|
+
*
|
|
177
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
178
|
+
*
|
|
179
|
+
* @default 30000
|
|
180
|
+
*/
|
|
181
|
+
sseMaxRetryDelay?: number;
|
|
182
|
+
/**
|
|
183
|
+
* Optional sleep function for retry backoff.
|
|
184
|
+
*
|
|
185
|
+
* Defaults to using `setTimeout`.
|
|
186
|
+
*/
|
|
187
|
+
sseSleepFn?: (ms: number) => Promise<void>;
|
|
188
|
+
url: string;
|
|
189
|
+
};
|
|
190
|
+
export interface StreamEvent<TData = unknown> {
|
|
191
|
+
data: TData;
|
|
192
|
+
event?: string;
|
|
193
|
+
id?: string;
|
|
194
|
+
retry?: number;
|
|
195
|
+
}
|
|
196
|
+
export type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
|
|
197
|
+
stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
|
|
198
|
+
};
|
|
199
|
+
export type ErrInterceptor<Err, Res, Req, Options> = (error: Err,
|
|
200
|
+
/** response may be undefined due to a network error where no response object is produced */
|
|
201
|
+
response: Res | undefined,
|
|
202
|
+
/** request may be undefined, because error may be from building the request object itself */
|
|
203
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
204
|
+
export type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
205
|
+
export type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
206
|
+
declare class Interceptors<Interceptor> {
|
|
207
|
+
fns: Array<Interceptor | null>;
|
|
208
|
+
clear(): void;
|
|
209
|
+
eject(id: number | Interceptor): void;
|
|
210
|
+
exists(id: number | Interceptor): boolean;
|
|
211
|
+
getInterceptorIndex(id: number | Interceptor): number;
|
|
212
|
+
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
|
|
213
|
+
use(fn: Interceptor): number;
|
|
214
|
+
}
|
|
215
|
+
export interface Middleware<Req, Res, Err, Options> {
|
|
216
|
+
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
|
|
217
|
+
request: Interceptors<ReqInterceptor<Req, Options>>;
|
|
218
|
+
response: Interceptors<ResInterceptor<Res, Req, Options>>;
|
|
219
|
+
}
|
|
220
|
+
export type ResponseStyle = "data" | "fields";
|
|
221
|
+
interface Config$1<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, "body" | "headers" | "method">, Config {
|
|
222
|
+
/**
|
|
223
|
+
* Base URL for all requests made by this client.
|
|
224
|
+
*/
|
|
225
|
+
baseUrl?: T["baseUrl"];
|
|
226
|
+
/**
|
|
227
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
228
|
+
* fetch instance.
|
|
229
|
+
*
|
|
230
|
+
* @default globalThis.fetch
|
|
231
|
+
*/
|
|
232
|
+
fetch?: typeof fetch;
|
|
233
|
+
/**
|
|
234
|
+
* Please don't use the Fetch client for Next.js applications. The `next`
|
|
235
|
+
* options won't have any effect.
|
|
236
|
+
*
|
|
237
|
+
* Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
|
|
238
|
+
*/
|
|
239
|
+
next?: never;
|
|
240
|
+
/**
|
|
241
|
+
* Return the response data parsed in a specified format. By default, `auto`
|
|
242
|
+
* will infer the appropriate method from the `Content-Type` response header.
|
|
243
|
+
* You can override this behavior with any of the {@link Body} methods.
|
|
244
|
+
* Select `stream` if you don't want to parse response data at all.
|
|
245
|
+
*
|
|
246
|
+
* @default 'auto'
|
|
247
|
+
*/
|
|
248
|
+
parseAs?: "arrayBuffer" | "auto" | "blob" | "formData" | "json" | "stream" | "text";
|
|
249
|
+
/**
|
|
250
|
+
* Should we return only data or multiple fields (data, error, response, etc.)?
|
|
251
|
+
*
|
|
252
|
+
* @default 'fields'
|
|
253
|
+
*/
|
|
254
|
+
responseStyle?: ResponseStyle;
|
|
255
|
+
/**
|
|
256
|
+
* Throw an error instead of returning it in the response?
|
|
257
|
+
*
|
|
258
|
+
* @default false
|
|
259
|
+
*/
|
|
260
|
+
throwOnError?: T["throwOnError"];
|
|
261
|
+
}
|
|
262
|
+
export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = "fields", ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$1<{
|
|
263
|
+
responseStyle: TResponseStyle;
|
|
264
|
+
throwOnError: ThrowOnError;
|
|
265
|
+
}>, Pick<ServerSentEventsOptions<TData>, "onRequest" | "onSseError" | "onSseEvent" | "sseDefaultRetryDelay" | "sseMaxRetryAttempts" | "sseMaxRetryDelay"> {
|
|
266
|
+
/**
|
|
267
|
+
* Any body that you want to add to your request.
|
|
268
|
+
*
|
|
269
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
|
270
|
+
*/
|
|
271
|
+
body?: unknown;
|
|
272
|
+
path?: Record<string, unknown>;
|
|
273
|
+
query?: Record<string, unknown>;
|
|
274
|
+
/**
|
|
275
|
+
* Security mechanism(s) to use for the request.
|
|
276
|
+
*/
|
|
277
|
+
security?: ReadonlyArray<Auth>;
|
|
278
|
+
url: Url;
|
|
279
|
+
}
|
|
280
|
+
export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = "fields", ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
|
281
|
+
headers: Headers;
|
|
282
|
+
serializedBody?: string;
|
|
283
|
+
}
|
|
284
|
+
export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = "fields"> = ThrowOnError extends true ? Promise<TResponseStyle extends "data" ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
|
|
285
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
286
|
+
request: Request;
|
|
287
|
+
response: Response;
|
|
288
|
+
}> : Promise<TResponseStyle extends "data" ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
|
|
289
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
290
|
+
error: undefined;
|
|
291
|
+
} | {
|
|
292
|
+
data: undefined;
|
|
293
|
+
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
294
|
+
}) & {
|
|
295
|
+
/** request may be undefined, because error may be from building the request object itself */
|
|
296
|
+
request?: Request;
|
|
297
|
+
/** response may be undefined, because error may be from building the request object itself or from a network error */
|
|
298
|
+
response?: Response;
|
|
299
|
+
}>;
|
|
300
|
+
export interface ClientOptions {
|
|
301
|
+
baseUrl?: string;
|
|
302
|
+
responseStyle?: ResponseStyle;
|
|
303
|
+
throwOnError?: boolean;
|
|
304
|
+
}
|
|
305
|
+
export type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
306
|
+
export type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData>>;
|
|
307
|
+
export type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method"> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
308
|
+
export type BuildUrlFn = <TData extends {
|
|
309
|
+
body?: unknown;
|
|
310
|
+
path?: Record<string, unknown>;
|
|
311
|
+
query?: Record<string, unknown>;
|
|
312
|
+
url: string;
|
|
313
|
+
}>(options: TData & Options<TData>) => string;
|
|
314
|
+
type Client$1 = Client<RequestFn, Config$1, MethodFn, BuildUrlFn, SseFn> & {
|
|
315
|
+
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
316
|
+
};
|
|
317
|
+
export interface TDataShape {
|
|
318
|
+
body?: unknown;
|
|
319
|
+
headers?: unknown;
|
|
320
|
+
path?: unknown;
|
|
321
|
+
query?: unknown;
|
|
322
|
+
url: string;
|
|
323
|
+
}
|
|
324
|
+
export type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
325
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = "fields"> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, "body" | "path" | "query" | "url"> & ([
|
|
326
|
+
TData
|
|
327
|
+
] extends [
|
|
328
|
+
never
|
|
329
|
+
] ? unknown : Omit<TData, "url">);
|
|
330
|
+
export type GetApiHealthData = {
|
|
331
|
+
body?: never;
|
|
332
|
+
path?: never;
|
|
333
|
+
query?: never;
|
|
334
|
+
url: "/api/health";
|
|
335
|
+
};
|
|
336
|
+
export type GetApiHealthResponses = {
|
|
337
|
+
/**
|
|
338
|
+
* Successful response
|
|
339
|
+
*/
|
|
340
|
+
200: {
|
|
341
|
+
status: string;
|
|
342
|
+
environment?: string;
|
|
343
|
+
ts: string;
|
|
344
|
+
};
|
|
345
|
+
};
|
|
346
|
+
export type GetApiHealthMeData = {
|
|
347
|
+
body?: never;
|
|
348
|
+
path?: never;
|
|
349
|
+
query?: never;
|
|
350
|
+
url: "/api/health/me";
|
|
351
|
+
};
|
|
352
|
+
export type GetApiHealthMeErrors = {
|
|
353
|
+
/**
|
|
354
|
+
* Unauthorized
|
|
355
|
+
*/
|
|
356
|
+
401: {
|
|
357
|
+
message: string;
|
|
358
|
+
details?: unknown;
|
|
359
|
+
};
|
|
360
|
+
/**
|
|
361
|
+
* Forbidden — insufficient permissions
|
|
362
|
+
*/
|
|
363
|
+
403: {
|
|
364
|
+
message: string;
|
|
365
|
+
details?: unknown;
|
|
366
|
+
};
|
|
367
|
+
};
|
|
368
|
+
export type GetApiHealthMeResponses = {
|
|
369
|
+
/**
|
|
370
|
+
* Successful response
|
|
371
|
+
*/
|
|
372
|
+
200: {
|
|
373
|
+
status: string;
|
|
374
|
+
environment?: string;
|
|
375
|
+
ts: string;
|
|
376
|
+
sub?: string;
|
|
377
|
+
exp?: number;
|
|
378
|
+
iat?: number;
|
|
379
|
+
org?: string;
|
|
380
|
+
role?: string;
|
|
381
|
+
aud?: Array<string>;
|
|
382
|
+
is_admin?: boolean;
|
|
383
|
+
image?: string | null;
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
export type DeleteApiVaultProjectsData = {
|
|
387
|
+
body: {
|
|
388
|
+
ids: Array<string>;
|
|
389
|
+
};
|
|
390
|
+
path?: never;
|
|
391
|
+
query?: never;
|
|
392
|
+
url: "/api/vault/projects";
|
|
393
|
+
};
|
|
394
|
+
export type DeleteApiVaultProjectsErrors = {
|
|
395
|
+
/**
|
|
396
|
+
* Bad Request
|
|
397
|
+
*/
|
|
398
|
+
400: {
|
|
399
|
+
message: string;
|
|
400
|
+
details?: unknown;
|
|
401
|
+
};
|
|
402
|
+
/**
|
|
403
|
+
* Unauthorized
|
|
404
|
+
*/
|
|
405
|
+
401: {
|
|
406
|
+
message: string;
|
|
407
|
+
details?: unknown;
|
|
408
|
+
};
|
|
409
|
+
/**
|
|
410
|
+
* Forbidden — insufficient permissions
|
|
411
|
+
*/
|
|
412
|
+
403: {
|
|
413
|
+
message: string;
|
|
414
|
+
details?: unknown;
|
|
415
|
+
};
|
|
416
|
+
};
|
|
417
|
+
export type DeleteApiVaultProjectsResponses = {
|
|
418
|
+
/**
|
|
419
|
+
* Projects deleted
|
|
420
|
+
*/
|
|
421
|
+
204: void;
|
|
422
|
+
};
|
|
423
|
+
export type GetApiVaultProjectsData = {
|
|
424
|
+
body?: never;
|
|
425
|
+
path?: never;
|
|
426
|
+
query?: never;
|
|
427
|
+
url: "/api/vault/projects";
|
|
428
|
+
};
|
|
429
|
+
export type GetApiVaultProjectsErrors = {
|
|
430
|
+
/**
|
|
431
|
+
* Unauthorized
|
|
432
|
+
*/
|
|
433
|
+
401: {
|
|
434
|
+
message: string;
|
|
435
|
+
details?: unknown;
|
|
436
|
+
};
|
|
437
|
+
/**
|
|
438
|
+
* Forbidden — insufficient permissions
|
|
439
|
+
*/
|
|
440
|
+
403: {
|
|
441
|
+
message: string;
|
|
442
|
+
details?: unknown;
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
export type GetApiVaultProjectsResponses = {
|
|
446
|
+
/**
|
|
447
|
+
* Successful response
|
|
448
|
+
*/
|
|
449
|
+
200: {
|
|
450
|
+
projects: Array<{
|
|
451
|
+
id: string;
|
|
452
|
+
name: string;
|
|
453
|
+
description: string | null;
|
|
454
|
+
secretCount: number;
|
|
455
|
+
isAdmin: boolean;
|
|
456
|
+
isOwner: boolean;
|
|
457
|
+
}>;
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
export type PatchApiVaultProjectsData = {
|
|
461
|
+
body: Array<{
|
|
462
|
+
id: string;
|
|
463
|
+
name?: string;
|
|
464
|
+
description?: string;
|
|
465
|
+
}>;
|
|
466
|
+
path?: never;
|
|
467
|
+
query?: never;
|
|
468
|
+
url: "/api/vault/projects";
|
|
469
|
+
};
|
|
470
|
+
export type PatchApiVaultProjectsErrors = {
|
|
471
|
+
/**
|
|
472
|
+
* Bad Request
|
|
473
|
+
*/
|
|
474
|
+
400: {
|
|
475
|
+
message: string;
|
|
476
|
+
details?: unknown;
|
|
477
|
+
};
|
|
478
|
+
/**
|
|
479
|
+
* Unauthorized
|
|
480
|
+
*/
|
|
481
|
+
401: {
|
|
482
|
+
message: string;
|
|
483
|
+
details?: unknown;
|
|
484
|
+
};
|
|
485
|
+
/**
|
|
486
|
+
* Forbidden — insufficient permissions
|
|
487
|
+
*/
|
|
488
|
+
403: {
|
|
489
|
+
message: string;
|
|
490
|
+
details?: unknown;
|
|
491
|
+
};
|
|
492
|
+
};
|
|
493
|
+
export type PatchApiVaultProjectsResponses = {
|
|
494
|
+
/**
|
|
495
|
+
* Projects updated
|
|
496
|
+
*/
|
|
497
|
+
200: Array<{
|
|
498
|
+
id: string;
|
|
499
|
+
name: string;
|
|
500
|
+
description: string | null;
|
|
501
|
+
secretCount: number;
|
|
502
|
+
isAdmin: boolean;
|
|
503
|
+
isOwner: boolean;
|
|
504
|
+
}>;
|
|
505
|
+
};
|
|
506
|
+
export type PutApiVaultProjectsData = {
|
|
507
|
+
body: Array<{
|
|
508
|
+
name: string;
|
|
509
|
+
description?: string;
|
|
510
|
+
}>;
|
|
511
|
+
path?: never;
|
|
512
|
+
query?: never;
|
|
513
|
+
url: "/api/vault/projects";
|
|
514
|
+
};
|
|
515
|
+
export type PutApiVaultProjectsErrors = {
|
|
516
|
+
/**
|
|
517
|
+
* Bad Request
|
|
518
|
+
*/
|
|
519
|
+
400: {
|
|
520
|
+
message: string;
|
|
521
|
+
details?: unknown;
|
|
522
|
+
};
|
|
523
|
+
/**
|
|
524
|
+
* Unauthorized
|
|
525
|
+
*/
|
|
526
|
+
401: {
|
|
527
|
+
message: string;
|
|
528
|
+
details?: unknown;
|
|
529
|
+
};
|
|
530
|
+
/**
|
|
531
|
+
* Forbidden — insufficient permissions
|
|
532
|
+
*/
|
|
533
|
+
403: {
|
|
534
|
+
message: string;
|
|
535
|
+
details?: unknown;
|
|
536
|
+
};
|
|
537
|
+
};
|
|
538
|
+
export type PutApiVaultProjectsResponses = {
|
|
539
|
+
/**
|
|
540
|
+
* Projects created
|
|
541
|
+
*/
|
|
542
|
+
201: Array<{
|
|
543
|
+
id: string;
|
|
544
|
+
name: string;
|
|
545
|
+
description: string | null;
|
|
546
|
+
createdAt: number;
|
|
547
|
+
}>;
|
|
548
|
+
};
|
|
549
|
+
export type GetApiVaultProjectsByProjectIdSecretsData = {
|
|
550
|
+
body?: never;
|
|
551
|
+
path: {
|
|
552
|
+
projectId: string;
|
|
553
|
+
};
|
|
554
|
+
query?: never;
|
|
555
|
+
url: "/api/vault/projects/{projectId}/secrets";
|
|
556
|
+
};
|
|
557
|
+
export type GetApiVaultProjectsByProjectIdSecretsErrors = {
|
|
558
|
+
/**
|
|
559
|
+
* Unauthorized
|
|
560
|
+
*/
|
|
561
|
+
401: {
|
|
562
|
+
message: string;
|
|
563
|
+
details?: unknown;
|
|
564
|
+
};
|
|
565
|
+
/**
|
|
566
|
+
* Forbidden — insufficient permissions
|
|
567
|
+
*/
|
|
568
|
+
403: {
|
|
569
|
+
message: string;
|
|
570
|
+
details?: unknown;
|
|
571
|
+
};
|
|
572
|
+
};
|
|
573
|
+
export type GetApiVaultProjectsByProjectIdSecretsResponses = {
|
|
574
|
+
/**
|
|
575
|
+
* Successful response
|
|
576
|
+
*/
|
|
577
|
+
200: {
|
|
578
|
+
projectId: string;
|
|
579
|
+
projectName: string;
|
|
580
|
+
secrets: Array<{
|
|
581
|
+
name: string;
|
|
582
|
+
description: string | null;
|
|
583
|
+
dev: {
|
|
584
|
+
secretId: string;
|
|
585
|
+
updatedAt: number;
|
|
586
|
+
updatedBy: string;
|
|
587
|
+
} | null;
|
|
588
|
+
staging: {
|
|
589
|
+
secretId: string;
|
|
590
|
+
updatedAt: number;
|
|
591
|
+
updatedBy: string;
|
|
592
|
+
} | null;
|
|
593
|
+
production: {
|
|
594
|
+
secretId: string;
|
|
595
|
+
updatedAt: number;
|
|
596
|
+
updatedBy: string;
|
|
597
|
+
} | null;
|
|
598
|
+
}>;
|
|
599
|
+
};
|
|
600
|
+
};
|
|
601
|
+
export type GetApiVaultSecretsBySecretIdData = {
|
|
602
|
+
body?: never;
|
|
603
|
+
path: {
|
|
604
|
+
secretId: string;
|
|
605
|
+
};
|
|
606
|
+
query?: never;
|
|
607
|
+
url: "/api/vault/secrets/{secretId}";
|
|
608
|
+
};
|
|
609
|
+
export type GetApiVaultSecretsBySecretIdErrors = {
|
|
610
|
+
/**
|
|
611
|
+
* Unauthorized
|
|
612
|
+
*/
|
|
613
|
+
401: {
|
|
614
|
+
message: string;
|
|
615
|
+
details?: unknown;
|
|
616
|
+
};
|
|
617
|
+
/**
|
|
618
|
+
* Forbidden — insufficient permissions
|
|
619
|
+
*/
|
|
620
|
+
403: {
|
|
621
|
+
message: string;
|
|
622
|
+
details?: unknown;
|
|
623
|
+
};
|
|
624
|
+
};
|
|
625
|
+
export type GetApiVaultSecretsBySecretIdResponses = {
|
|
626
|
+
/**
|
|
627
|
+
* Successful response
|
|
628
|
+
*/
|
|
629
|
+
200: {
|
|
630
|
+
secretId: string;
|
|
631
|
+
updatedAt: number;
|
|
632
|
+
updatedBy: string;
|
|
633
|
+
value: string;
|
|
634
|
+
};
|
|
635
|
+
};
|
|
636
|
+
export type PatchApiVaultSecretsBySecretIdData = {
|
|
637
|
+
body: {
|
|
638
|
+
value: string;
|
|
639
|
+
};
|
|
640
|
+
path: {
|
|
641
|
+
secretId: string;
|
|
642
|
+
};
|
|
643
|
+
query?: never;
|
|
644
|
+
url: "/api/vault/secrets/{secretId}";
|
|
645
|
+
};
|
|
646
|
+
export type PatchApiVaultSecretsBySecretIdErrors = {
|
|
647
|
+
/**
|
|
648
|
+
* Bad Request
|
|
649
|
+
*/
|
|
650
|
+
400: {
|
|
651
|
+
message: string;
|
|
652
|
+
details?: unknown;
|
|
653
|
+
};
|
|
654
|
+
/**
|
|
655
|
+
* Unauthorized
|
|
656
|
+
*/
|
|
657
|
+
401: {
|
|
658
|
+
message: string;
|
|
659
|
+
details?: unknown;
|
|
660
|
+
};
|
|
661
|
+
/**
|
|
662
|
+
* Forbidden — insufficient permissions
|
|
663
|
+
*/
|
|
664
|
+
403: {
|
|
665
|
+
message: string;
|
|
666
|
+
details?: unknown;
|
|
667
|
+
};
|
|
668
|
+
};
|
|
669
|
+
export type PatchApiVaultSecretsBySecretIdResponses = {
|
|
670
|
+
/**
|
|
671
|
+
* Successful response
|
|
672
|
+
*/
|
|
673
|
+
200: {
|
|
674
|
+
secretId: string;
|
|
675
|
+
updatedAt: number;
|
|
676
|
+
updatedBy: string;
|
|
677
|
+
};
|
|
678
|
+
};
|
|
679
|
+
export type PostApiVaultInjectData = {
|
|
680
|
+
body: {
|
|
681
|
+
machineId: string;
|
|
682
|
+
projectId: string;
|
|
683
|
+
environment: "dev" | "staging" | "production";
|
|
684
|
+
org: string;
|
|
685
|
+
};
|
|
686
|
+
path?: never;
|
|
687
|
+
query?: never;
|
|
688
|
+
url: "/api/vault/inject";
|
|
689
|
+
};
|
|
690
|
+
export type PostApiVaultInjectErrors = {
|
|
691
|
+
/**
|
|
692
|
+
* Bad Request
|
|
693
|
+
*/
|
|
694
|
+
400: {
|
|
695
|
+
message: string;
|
|
696
|
+
details?: unknown;
|
|
697
|
+
};
|
|
698
|
+
/**
|
|
699
|
+
* Unauthorized
|
|
700
|
+
*/
|
|
701
|
+
401: {
|
|
702
|
+
message: string;
|
|
703
|
+
details?: unknown;
|
|
704
|
+
};
|
|
705
|
+
/**
|
|
706
|
+
* Server error
|
|
707
|
+
*/
|
|
708
|
+
500: {
|
|
709
|
+
message: string;
|
|
710
|
+
details?: unknown;
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
export type PostApiVaultInjectResponses = {
|
|
714
|
+
/**
|
|
715
|
+
* Secrets retrieved successfully (may be empty)
|
|
716
|
+
*/
|
|
717
|
+
200: {
|
|
718
|
+
projectId: string;
|
|
719
|
+
environment: "dev" | "staging" | "production";
|
|
720
|
+
secrets: {
|
|
721
|
+
[key: string]: string;
|
|
722
|
+
};
|
|
723
|
+
};
|
|
724
|
+
};
|
|
725
|
+
export type PostApiVaultProjectsQueryData = {
|
|
726
|
+
body: {
|
|
727
|
+
ids: Array<string>;
|
|
728
|
+
};
|
|
729
|
+
path?: never;
|
|
730
|
+
query?: never;
|
|
731
|
+
url: "/api/vault/projects/query";
|
|
732
|
+
};
|
|
733
|
+
export type PostApiVaultProjectsQueryErrors = {
|
|
734
|
+
/**
|
|
735
|
+
* Bad Request
|
|
736
|
+
*/
|
|
737
|
+
400: {
|
|
738
|
+
message: string;
|
|
739
|
+
details?: unknown;
|
|
740
|
+
};
|
|
741
|
+
/**
|
|
742
|
+
* Unauthorized
|
|
743
|
+
*/
|
|
744
|
+
401: {
|
|
745
|
+
message: string;
|
|
746
|
+
details?: unknown;
|
|
747
|
+
};
|
|
748
|
+
/**
|
|
749
|
+
* Forbidden — insufficient permissions
|
|
750
|
+
*/
|
|
751
|
+
403: {
|
|
752
|
+
message: string;
|
|
753
|
+
details?: unknown;
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
export type PostApiVaultProjectsQueryResponses = {
|
|
757
|
+
/**
|
|
758
|
+
* Projects found
|
|
759
|
+
*/
|
|
760
|
+
200: {
|
|
761
|
+
projects: Array<{
|
|
762
|
+
id: string;
|
|
763
|
+
name: string;
|
|
764
|
+
description: string | null;
|
|
765
|
+
secretCount: number;
|
|
766
|
+
isAdmin: boolean;
|
|
767
|
+
isOwner: boolean;
|
|
768
|
+
}>;
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
export type DeleteApiVaultSecretsData = {
|
|
772
|
+
body: {
|
|
773
|
+
ids: Array<string>;
|
|
774
|
+
};
|
|
775
|
+
path?: never;
|
|
776
|
+
query?: never;
|
|
777
|
+
url: "/api/vault/secrets";
|
|
778
|
+
};
|
|
779
|
+
export type DeleteApiVaultSecretsErrors = {
|
|
780
|
+
/**
|
|
781
|
+
* Bad Request
|
|
782
|
+
*/
|
|
783
|
+
400: {
|
|
784
|
+
message: string;
|
|
785
|
+
details?: unknown;
|
|
786
|
+
};
|
|
787
|
+
/**
|
|
788
|
+
* Unauthorized
|
|
789
|
+
*/
|
|
790
|
+
401: {
|
|
791
|
+
message: string;
|
|
792
|
+
details?: unknown;
|
|
793
|
+
};
|
|
794
|
+
/**
|
|
795
|
+
* Forbidden — insufficient permissions
|
|
796
|
+
*/
|
|
797
|
+
403: {
|
|
798
|
+
message: string;
|
|
799
|
+
details?: unknown;
|
|
800
|
+
};
|
|
801
|
+
};
|
|
802
|
+
export type DeleteApiVaultSecretsResponses = {
|
|
803
|
+
/**
|
|
804
|
+
* Secrets deleted
|
|
805
|
+
*/
|
|
806
|
+
204: void;
|
|
807
|
+
};
|
|
808
|
+
export type PatchApiVaultSecretsData = {
|
|
809
|
+
body: Array<{
|
|
810
|
+
id: string;
|
|
811
|
+
name?: string;
|
|
812
|
+
description?: string;
|
|
813
|
+
value?: string;
|
|
814
|
+
}>;
|
|
815
|
+
path?: never;
|
|
816
|
+
query?: never;
|
|
817
|
+
url: "/api/vault/secrets";
|
|
818
|
+
};
|
|
819
|
+
export type PatchApiVaultSecretsErrors = {
|
|
820
|
+
/**
|
|
821
|
+
* Bad Request
|
|
822
|
+
*/
|
|
823
|
+
400: {
|
|
824
|
+
message: string;
|
|
825
|
+
details?: unknown;
|
|
826
|
+
};
|
|
827
|
+
/**
|
|
828
|
+
* Unauthorized
|
|
829
|
+
*/
|
|
830
|
+
401: {
|
|
831
|
+
message: string;
|
|
832
|
+
details?: unknown;
|
|
833
|
+
};
|
|
834
|
+
/**
|
|
835
|
+
* Forbidden — insufficient permissions
|
|
836
|
+
*/
|
|
837
|
+
403: {
|
|
838
|
+
message: string;
|
|
839
|
+
details?: unknown;
|
|
840
|
+
};
|
|
841
|
+
};
|
|
842
|
+
export type PatchApiVaultSecretsResponses = {
|
|
843
|
+
/**
|
|
844
|
+
* Secrets updated
|
|
845
|
+
*/
|
|
846
|
+
200: {
|
|
847
|
+
success: true;
|
|
848
|
+
};
|
|
849
|
+
};
|
|
850
|
+
export type PutApiVaultSecretsData = {
|
|
851
|
+
body: Array<{
|
|
852
|
+
id?: string;
|
|
853
|
+
projectId: string;
|
|
854
|
+
environment: "dev" | "staging" | "production";
|
|
855
|
+
name: string;
|
|
856
|
+
description?: string;
|
|
857
|
+
value: string;
|
|
858
|
+
}>;
|
|
859
|
+
path?: never;
|
|
860
|
+
query?: never;
|
|
861
|
+
url: "/api/vault/secrets";
|
|
862
|
+
};
|
|
863
|
+
export type PutApiVaultSecretsErrors = {
|
|
864
|
+
/**
|
|
865
|
+
* Bad Request
|
|
866
|
+
*/
|
|
867
|
+
400: {
|
|
868
|
+
message: string;
|
|
869
|
+
details?: unknown;
|
|
870
|
+
};
|
|
871
|
+
/**
|
|
872
|
+
* Unauthorized
|
|
873
|
+
*/
|
|
874
|
+
401: {
|
|
875
|
+
message: string;
|
|
876
|
+
details?: unknown;
|
|
877
|
+
};
|
|
878
|
+
/**
|
|
879
|
+
* Forbidden — insufficient permissions
|
|
880
|
+
*/
|
|
881
|
+
403: {
|
|
882
|
+
message: string;
|
|
883
|
+
details?: unknown;
|
|
884
|
+
};
|
|
885
|
+
/**
|
|
886
|
+
* Conflict
|
|
887
|
+
*/
|
|
888
|
+
409: {
|
|
889
|
+
message: string;
|
|
890
|
+
details?: unknown;
|
|
891
|
+
};
|
|
892
|
+
};
|
|
893
|
+
export type PutApiVaultSecretsResponses = {
|
|
894
|
+
/**
|
|
895
|
+
* Secrets created
|
|
896
|
+
*/
|
|
897
|
+
201: {
|
|
898
|
+
secrets: Array<{
|
|
899
|
+
id: string;
|
|
900
|
+
projectId: string;
|
|
901
|
+
environment: string;
|
|
902
|
+
name: string;
|
|
903
|
+
}>;
|
|
904
|
+
};
|
|
905
|
+
};
|
|
906
|
+
export type PostApiVaultSecretsQueryData = {
|
|
907
|
+
body: {
|
|
908
|
+
ids: Array<string>;
|
|
909
|
+
};
|
|
910
|
+
path?: never;
|
|
911
|
+
query?: never;
|
|
912
|
+
url: "/api/vault/secrets/query";
|
|
913
|
+
};
|
|
914
|
+
export type PostApiVaultSecretsQueryErrors = {
|
|
915
|
+
/**
|
|
916
|
+
* Bad Request
|
|
917
|
+
*/
|
|
918
|
+
400: {
|
|
919
|
+
message: string;
|
|
920
|
+
details?: unknown;
|
|
921
|
+
};
|
|
922
|
+
/**
|
|
923
|
+
* Unauthorized
|
|
924
|
+
*/
|
|
925
|
+
401: {
|
|
926
|
+
message: string;
|
|
927
|
+
details?: unknown;
|
|
928
|
+
};
|
|
929
|
+
/**
|
|
930
|
+
* Forbidden — insufficient permissions
|
|
931
|
+
*/
|
|
932
|
+
403: {
|
|
933
|
+
message: string;
|
|
934
|
+
details?: unknown;
|
|
935
|
+
};
|
|
936
|
+
};
|
|
937
|
+
export type PostApiVaultSecretsQueryResponses = {
|
|
938
|
+
/**
|
|
939
|
+
* Secrets found (only IDs the caller may access)
|
|
940
|
+
*/
|
|
941
|
+
200: {
|
|
942
|
+
secrets: Array<{
|
|
943
|
+
secretId: string;
|
|
944
|
+
updatedAt: number;
|
|
945
|
+
updatedBy: string;
|
|
946
|
+
value: string;
|
|
947
|
+
}>;
|
|
948
|
+
};
|
|
949
|
+
};
|
|
950
|
+
export type DeleteApiVaultProjectsByProjectIdDmsData = {
|
|
951
|
+
body?: never;
|
|
952
|
+
path: {
|
|
953
|
+
projectId: string;
|
|
954
|
+
};
|
|
955
|
+
query?: never;
|
|
956
|
+
url: "/api/vault/projects/{projectId}/dms";
|
|
957
|
+
};
|
|
958
|
+
export type DeleteApiVaultProjectsByProjectIdDmsErrors = {
|
|
959
|
+
/**
|
|
960
|
+
* Unauthorized
|
|
961
|
+
*/
|
|
962
|
+
401: {
|
|
963
|
+
message: string;
|
|
964
|
+
details?: unknown;
|
|
965
|
+
};
|
|
966
|
+
/**
|
|
967
|
+
* Forbidden — insufficient permissions
|
|
968
|
+
*/
|
|
969
|
+
403: {
|
|
970
|
+
message: string;
|
|
971
|
+
details?: unknown;
|
|
972
|
+
};
|
|
973
|
+
};
|
|
974
|
+
export type DeleteApiVaultProjectsByProjectIdDmsResponses = {
|
|
975
|
+
/**
|
|
976
|
+
* DMS cancelled
|
|
977
|
+
*/
|
|
978
|
+
204: void;
|
|
979
|
+
};
|
|
980
|
+
export type GetApiVaultProjectsByProjectIdDmsData = {
|
|
981
|
+
body?: never;
|
|
982
|
+
path: {
|
|
983
|
+
projectId: string;
|
|
984
|
+
};
|
|
985
|
+
query?: never;
|
|
986
|
+
url: "/api/vault/projects/{projectId}/dms";
|
|
987
|
+
};
|
|
988
|
+
export type GetApiVaultProjectsByProjectIdDmsErrors = {
|
|
989
|
+
/**
|
|
990
|
+
* Unauthorized
|
|
991
|
+
*/
|
|
992
|
+
401: {
|
|
993
|
+
message: string;
|
|
994
|
+
details?: unknown;
|
|
995
|
+
};
|
|
996
|
+
/**
|
|
997
|
+
* Forbidden — insufficient permissions
|
|
998
|
+
*/
|
|
999
|
+
403: {
|
|
1000
|
+
message: string;
|
|
1001
|
+
details?: unknown;
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
export type GetApiVaultProjectsByProjectIdDmsResponses = {
|
|
1005
|
+
/**
|
|
1006
|
+
* Successful response
|
|
1007
|
+
*/
|
|
1008
|
+
200: {
|
|
1009
|
+
projectId: string;
|
|
1010
|
+
deliveryDate: string | null;
|
|
1011
|
+
emails: Array<string>;
|
|
1012
|
+
deliveredAt: string | null;
|
|
1013
|
+
claimExpiresAt: string | null;
|
|
1014
|
+
projectDescription: string | null;
|
|
1015
|
+
};
|
|
1016
|
+
};
|
|
1017
|
+
export type PatchApiVaultProjectsByProjectIdDmsData = {
|
|
1018
|
+
body: {
|
|
1019
|
+
deliveryDate?: string;
|
|
1020
|
+
emails?: Array<string>;
|
|
1021
|
+
projectDescription?: string | null;
|
|
1022
|
+
};
|
|
1023
|
+
path: {
|
|
1024
|
+
projectId: string;
|
|
1025
|
+
};
|
|
1026
|
+
query?: never;
|
|
1027
|
+
url: "/api/vault/projects/{projectId}/dms";
|
|
1028
|
+
};
|
|
1029
|
+
export type PatchApiVaultProjectsByProjectIdDmsErrors = {
|
|
1030
|
+
/**
|
|
1031
|
+
* Bad Request
|
|
1032
|
+
*/
|
|
1033
|
+
400: {
|
|
1034
|
+
message: string;
|
|
1035
|
+
details?: unknown;
|
|
1036
|
+
};
|
|
1037
|
+
/**
|
|
1038
|
+
* Unauthorized
|
|
1039
|
+
*/
|
|
1040
|
+
401: {
|
|
1041
|
+
message: string;
|
|
1042
|
+
details?: unknown;
|
|
1043
|
+
};
|
|
1044
|
+
/**
|
|
1045
|
+
* Forbidden — insufficient permissions
|
|
1046
|
+
*/
|
|
1047
|
+
403: {
|
|
1048
|
+
message: string;
|
|
1049
|
+
details?: unknown;
|
|
1050
|
+
};
|
|
1051
|
+
/**
|
|
1052
|
+
* Resource not found
|
|
1053
|
+
*/
|
|
1054
|
+
404: {
|
|
1055
|
+
message: string;
|
|
1056
|
+
details?: unknown;
|
|
1057
|
+
};
|
|
1058
|
+
};
|
|
1059
|
+
export type PatchApiVaultProjectsByProjectIdDmsResponses = {
|
|
1060
|
+
/**
|
|
1061
|
+
* Successful response
|
|
1062
|
+
*/
|
|
1063
|
+
200: {
|
|
1064
|
+
projectId: string;
|
|
1065
|
+
deliveryDate: string | null;
|
|
1066
|
+
emails: Array<string>;
|
|
1067
|
+
deliveredAt: string | null;
|
|
1068
|
+
claimExpiresAt: string | null;
|
|
1069
|
+
projectDescription: string | null;
|
|
1070
|
+
};
|
|
1071
|
+
};
|
|
1072
|
+
export type PutApiVaultProjectsByProjectIdDmsData = {
|
|
1073
|
+
body: {
|
|
1074
|
+
deliveryDate: string;
|
|
1075
|
+
emails: Array<string>;
|
|
1076
|
+
projectDescription?: string | null;
|
|
1077
|
+
};
|
|
1078
|
+
path: {
|
|
1079
|
+
projectId: string;
|
|
1080
|
+
};
|
|
1081
|
+
query?: never;
|
|
1082
|
+
url: "/api/vault/projects/{projectId}/dms";
|
|
1083
|
+
};
|
|
1084
|
+
export type PutApiVaultProjectsByProjectIdDmsErrors = {
|
|
1085
|
+
/**
|
|
1086
|
+
* Bad Request
|
|
1087
|
+
*/
|
|
1088
|
+
400: {
|
|
1089
|
+
message: string;
|
|
1090
|
+
details?: unknown;
|
|
1091
|
+
};
|
|
1092
|
+
/**
|
|
1093
|
+
* Unauthorized
|
|
1094
|
+
*/
|
|
1095
|
+
401: {
|
|
1096
|
+
message: string;
|
|
1097
|
+
details?: unknown;
|
|
1098
|
+
};
|
|
1099
|
+
/**
|
|
1100
|
+
* Forbidden — insufficient permissions
|
|
1101
|
+
*/
|
|
1102
|
+
403: {
|
|
1103
|
+
message: string;
|
|
1104
|
+
details?: unknown;
|
|
1105
|
+
};
|
|
1106
|
+
};
|
|
1107
|
+
export type PutApiVaultProjectsByProjectIdDmsResponses = {
|
|
1108
|
+
/**
|
|
1109
|
+
* Successful response
|
|
1110
|
+
*/
|
|
1111
|
+
200: {
|
|
1112
|
+
projectId: string;
|
|
1113
|
+
deliveryDate: string | null;
|
|
1114
|
+
emails: Array<string>;
|
|
1115
|
+
deliveredAt: string | null;
|
|
1116
|
+
claimExpiresAt: string | null;
|
|
1117
|
+
projectDescription: string | null;
|
|
1118
|
+
};
|
|
1119
|
+
};
|
|
1120
|
+
export type GetApiDmsProofByTokenData = {
|
|
1121
|
+
body?: never;
|
|
1122
|
+
path: {
|
|
1123
|
+
token: string;
|
|
1124
|
+
};
|
|
1125
|
+
query?: never;
|
|
1126
|
+
url: "/api/dms/proof/{token}";
|
|
1127
|
+
};
|
|
1128
|
+
export type GetApiDmsProofByTokenErrors = {
|
|
1129
|
+
/**
|
|
1130
|
+
* Invalid or expired proof token (HTML)
|
|
1131
|
+
*/
|
|
1132
|
+
400: string;
|
|
1133
|
+
};
|
|
1134
|
+
export type GetApiDmsProofByTokenResponses = {
|
|
1135
|
+
/**
|
|
1136
|
+
* HTML page
|
|
1137
|
+
*/
|
|
1138
|
+
200: string;
|
|
1139
|
+
};
|
|
1140
|
+
export type PatchApiDmsProofByTokenData = {
|
|
1141
|
+
body?: never;
|
|
1142
|
+
path: {
|
|
1143
|
+
token: string;
|
|
1144
|
+
};
|
|
1145
|
+
query?: never;
|
|
1146
|
+
url: "/api/dms/proof/{token}";
|
|
1147
|
+
};
|
|
1148
|
+
export type PatchApiDmsProofByTokenErrors = {
|
|
1149
|
+
/**
|
|
1150
|
+
* Invalid token or past delivery date (HTML)
|
|
1151
|
+
*/
|
|
1152
|
+
400: string;
|
|
1153
|
+
};
|
|
1154
|
+
export type PatchApiDmsProofByTokenResponses = {
|
|
1155
|
+
/**
|
|
1156
|
+
* HTML page
|
|
1157
|
+
*/
|
|
1158
|
+
200: string;
|
|
1159
|
+
};
|
|
1160
|
+
export type DeleteApiDmsClaimByTokenData = {
|
|
1161
|
+
body?: never;
|
|
1162
|
+
path: {
|
|
1163
|
+
token: string;
|
|
1164
|
+
};
|
|
1165
|
+
query?: never;
|
|
1166
|
+
url: "/api/dms/claim/{token}";
|
|
1167
|
+
};
|
|
1168
|
+
export type DeleteApiDmsClaimByTokenErrors = {
|
|
1169
|
+
/**
|
|
1170
|
+
* Invalid token or wrong confirmation (HTML)
|
|
1171
|
+
*/
|
|
1172
|
+
400: string;
|
|
1173
|
+
};
|
|
1174
|
+
export type DeleteApiDmsClaimByTokenResponses = {
|
|
1175
|
+
/**
|
|
1176
|
+
* HTML page
|
|
1177
|
+
*/
|
|
1178
|
+
200: string;
|
|
1179
|
+
};
|
|
1180
|
+
export type GetApiDmsClaimByTokenData = {
|
|
1181
|
+
body?: never;
|
|
1182
|
+
path: {
|
|
1183
|
+
token: string;
|
|
1184
|
+
};
|
|
1185
|
+
query?: never;
|
|
1186
|
+
url: "/api/dms/claim/{token}";
|
|
1187
|
+
};
|
|
1188
|
+
export type GetApiDmsClaimByTokenErrors = {
|
|
1189
|
+
/**
|
|
1190
|
+
* Invalid or expired claim token (HTML)
|
|
1191
|
+
*/
|
|
1192
|
+
400: string;
|
|
1193
|
+
};
|
|
1194
|
+
export type GetApiDmsClaimByTokenResponses = {
|
|
1195
|
+
/**
|
|
1196
|
+
* HTML page
|
|
1197
|
+
*/
|
|
1198
|
+
200: string;
|
|
1199
|
+
};
|
|
1200
|
+
export type GetApiProjectsByProjectIdAuditLogsData = {
|
|
1201
|
+
body?: never;
|
|
1202
|
+
path: {
|
|
1203
|
+
projectId: string;
|
|
1204
|
+
};
|
|
1205
|
+
query?: {
|
|
1206
|
+
page?: number;
|
|
1207
|
+
pageSize?: number;
|
|
1208
|
+
startDate?: string;
|
|
1209
|
+
endDate?: string;
|
|
1210
|
+
eventType?: string;
|
|
1211
|
+
subjectId?: string;
|
|
1212
|
+
environment?: "dev" | "staging" | "production";
|
|
1213
|
+
success?: boolean;
|
|
1214
|
+
secretNames?: string;
|
|
1215
|
+
};
|
|
1216
|
+
url: "/api/projects/{projectId}/audit-logs";
|
|
1217
|
+
};
|
|
1218
|
+
export type GetApiProjectsByProjectIdAuditLogsErrors = {
|
|
1219
|
+
/**
|
|
1220
|
+
* Bad Request
|
|
1221
|
+
*/
|
|
1222
|
+
400: {
|
|
1223
|
+
message: string;
|
|
1224
|
+
details?: unknown;
|
|
1225
|
+
};
|
|
1226
|
+
/**
|
|
1227
|
+
* Unauthorized
|
|
1228
|
+
*/
|
|
1229
|
+
401: {
|
|
1230
|
+
message: string;
|
|
1231
|
+
details?: unknown;
|
|
1232
|
+
};
|
|
1233
|
+
/**
|
|
1234
|
+
* Forbidden — insufficient permissions
|
|
1235
|
+
*/
|
|
1236
|
+
403: {
|
|
1237
|
+
message: string;
|
|
1238
|
+
details?: unknown;
|
|
1239
|
+
};
|
|
1240
|
+
};
|
|
1241
|
+
export type GetApiProjectsByProjectIdAuditLogsResponses = {
|
|
1242
|
+
/**
|
|
1243
|
+
* Successful response
|
|
1244
|
+
*/
|
|
1245
|
+
200: {
|
|
1246
|
+
logs: Array<{
|
|
1247
|
+
id: string;
|
|
1248
|
+
eventType: string;
|
|
1249
|
+
subjectId: string;
|
|
1250
|
+
subjectName: string | null;
|
|
1251
|
+
projectId: string | null;
|
|
1252
|
+
environment: string | null;
|
|
1253
|
+
secretNames: string | null;
|
|
1254
|
+
success: boolean;
|
|
1255
|
+
details: string | null;
|
|
1256
|
+
createdAt: number;
|
|
1257
|
+
}>;
|
|
1258
|
+
total: number;
|
|
1259
|
+
page: number;
|
|
1260
|
+
pageSize: number;
|
|
1261
|
+
totalPages: number;
|
|
1262
|
+
};
|
|
1263
|
+
};
|
|
1264
|
+
export type GetApiProjectsByProjectIdAdminsData = {
|
|
1265
|
+
body?: never;
|
|
1266
|
+
path: {
|
|
1267
|
+
projectId: string;
|
|
1268
|
+
};
|
|
1269
|
+
query?: never;
|
|
1270
|
+
url: "/api/projects/{projectId}/admins";
|
|
1271
|
+
};
|
|
1272
|
+
export type GetApiProjectsByProjectIdAdminsErrors = {
|
|
1273
|
+
/**
|
|
1274
|
+
* Bad Request
|
|
1275
|
+
*/
|
|
1276
|
+
400: {
|
|
1277
|
+
message: string;
|
|
1278
|
+
details?: unknown;
|
|
1279
|
+
};
|
|
1280
|
+
/**
|
|
1281
|
+
* Unauthorized
|
|
1282
|
+
*/
|
|
1283
|
+
401: {
|
|
1284
|
+
message: string;
|
|
1285
|
+
details?: unknown;
|
|
1286
|
+
};
|
|
1287
|
+
/**
|
|
1288
|
+
* Forbidden — insufficient permissions
|
|
1289
|
+
*/
|
|
1290
|
+
403: {
|
|
1291
|
+
message: string;
|
|
1292
|
+
details?: unknown;
|
|
1293
|
+
};
|
|
1294
|
+
};
|
|
1295
|
+
export type GetApiProjectsByProjectIdAdminsResponses = {
|
|
1296
|
+
/**
|
|
1297
|
+
* Successful response
|
|
1298
|
+
*/
|
|
1299
|
+
200: {
|
|
1300
|
+
admins: Array<{
|
|
1301
|
+
id: string;
|
|
1302
|
+
subjectId: string;
|
|
1303
|
+
email: string | null;
|
|
1304
|
+
name: string;
|
|
1305
|
+
type: "user" | "machine";
|
|
1306
|
+
grantedBy: string;
|
|
1307
|
+
createdAt: number;
|
|
1308
|
+
}>;
|
|
1309
|
+
};
|
|
1310
|
+
};
|
|
1311
|
+
export type PostApiProjectsByProjectIdAdminsData = {
|
|
1312
|
+
body: {
|
|
1313
|
+
email: string;
|
|
1314
|
+
};
|
|
1315
|
+
path: {
|
|
1316
|
+
projectId: string;
|
|
1317
|
+
};
|
|
1318
|
+
query?: never;
|
|
1319
|
+
url: "/api/projects/{projectId}/admins";
|
|
1320
|
+
};
|
|
1321
|
+
export type PostApiProjectsByProjectIdAdminsErrors = {
|
|
1322
|
+
/**
|
|
1323
|
+
* Bad Request
|
|
1324
|
+
*/
|
|
1325
|
+
400: {
|
|
1326
|
+
message: string;
|
|
1327
|
+
details?: unknown;
|
|
1328
|
+
};
|
|
1329
|
+
/**
|
|
1330
|
+
* Unauthorized
|
|
1331
|
+
*/
|
|
1332
|
+
401: {
|
|
1333
|
+
message: string;
|
|
1334
|
+
details?: unknown;
|
|
1335
|
+
};
|
|
1336
|
+
/**
|
|
1337
|
+
* Forbidden — insufficient permissions
|
|
1338
|
+
*/
|
|
1339
|
+
403: {
|
|
1340
|
+
message: string;
|
|
1341
|
+
details?: unknown;
|
|
1342
|
+
};
|
|
1343
|
+
/**
|
|
1344
|
+
* Conflict
|
|
1345
|
+
*/
|
|
1346
|
+
409: {
|
|
1347
|
+
message: string;
|
|
1348
|
+
details?: unknown;
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
export type PostApiProjectsByProjectIdAdminsResponses = {
|
|
1352
|
+
/**
|
|
1353
|
+
* Admin added
|
|
1354
|
+
*/
|
|
1355
|
+
201: {
|
|
1356
|
+
id: string;
|
|
1357
|
+
subjectId: string;
|
|
1358
|
+
projectId: string;
|
|
1359
|
+
grantedBy: string;
|
|
1360
|
+
createdAt: number;
|
|
1361
|
+
};
|
|
1362
|
+
};
|
|
1363
|
+
export type DeleteApiProjectsByProjectIdAdminsBySubjectIdData = {
|
|
1364
|
+
body?: never;
|
|
1365
|
+
path: {
|
|
1366
|
+
projectId: string;
|
|
1367
|
+
subjectId: string;
|
|
1368
|
+
};
|
|
1369
|
+
query?: never;
|
|
1370
|
+
url: "/api/projects/{projectId}/admins/{subjectId}";
|
|
1371
|
+
};
|
|
1372
|
+
export type DeleteApiProjectsByProjectIdAdminsBySubjectIdErrors = {
|
|
1373
|
+
/**
|
|
1374
|
+
* Bad Request
|
|
1375
|
+
*/
|
|
1376
|
+
400: {
|
|
1377
|
+
message: string;
|
|
1378
|
+
details?: unknown;
|
|
1379
|
+
};
|
|
1380
|
+
/**
|
|
1381
|
+
* Unauthorized
|
|
1382
|
+
*/
|
|
1383
|
+
401: {
|
|
1384
|
+
message: string;
|
|
1385
|
+
details?: unknown;
|
|
1386
|
+
};
|
|
1387
|
+
/**
|
|
1388
|
+
* Forbidden — insufficient permissions
|
|
1389
|
+
*/
|
|
1390
|
+
403: {
|
|
1391
|
+
message: string;
|
|
1392
|
+
details?: unknown;
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
export type DeleteApiProjectsByProjectIdAdminsBySubjectIdResponses = {
|
|
1396
|
+
/**
|
|
1397
|
+
* Admin removed
|
|
1398
|
+
*/
|
|
1399
|
+
204: void;
|
|
1400
|
+
};
|
|
1401
|
+
export type GetApiProjectsByProjectIdAccessData = {
|
|
1402
|
+
body?: never;
|
|
1403
|
+
path: {
|
|
1404
|
+
projectId: string;
|
|
1405
|
+
};
|
|
1406
|
+
query?: never;
|
|
1407
|
+
url: "/api/projects/{projectId}/access";
|
|
1408
|
+
};
|
|
1409
|
+
export type GetApiProjectsByProjectIdAccessErrors = {
|
|
1410
|
+
/**
|
|
1411
|
+
* Bad Request
|
|
1412
|
+
*/
|
|
1413
|
+
400: {
|
|
1414
|
+
message: string;
|
|
1415
|
+
details?: unknown;
|
|
1416
|
+
};
|
|
1417
|
+
/**
|
|
1418
|
+
* Unauthorized
|
|
1419
|
+
*/
|
|
1420
|
+
401: {
|
|
1421
|
+
message: string;
|
|
1422
|
+
details?: unknown;
|
|
1423
|
+
};
|
|
1424
|
+
/**
|
|
1425
|
+
* Forbidden — insufficient permissions
|
|
1426
|
+
*/
|
|
1427
|
+
403: {
|
|
1428
|
+
message: string;
|
|
1429
|
+
details?: unknown;
|
|
1430
|
+
};
|
|
1431
|
+
};
|
|
1432
|
+
export type GetApiProjectsByProjectIdAccessResponses = {
|
|
1433
|
+
/**
|
|
1434
|
+
* Successful response
|
|
1435
|
+
*/
|
|
1436
|
+
200: {
|
|
1437
|
+
users: Array<{
|
|
1438
|
+
subjectId: string;
|
|
1439
|
+
name: string;
|
|
1440
|
+
email: string | null;
|
|
1441
|
+
isAdmin: boolean;
|
|
1442
|
+
permissionCount: number;
|
|
1443
|
+
}>;
|
|
1444
|
+
};
|
|
1445
|
+
};
|
|
1446
|
+
export type GetApiSubjectsData = {
|
|
1447
|
+
body?: never;
|
|
1448
|
+
path?: never;
|
|
1449
|
+
query?: {
|
|
1450
|
+
q?: string;
|
|
1451
|
+
type?: "user" | "machine";
|
|
1452
|
+
limit?: number;
|
|
1453
|
+
offset?: number;
|
|
1454
|
+
};
|
|
1455
|
+
url: "/api/subjects";
|
|
1456
|
+
};
|
|
1457
|
+
export type GetApiSubjectsErrors = {
|
|
1458
|
+
/**
|
|
1459
|
+
* Bad Request
|
|
1460
|
+
*/
|
|
1461
|
+
400: {
|
|
1462
|
+
message: string;
|
|
1463
|
+
details?: unknown;
|
|
1464
|
+
};
|
|
1465
|
+
/**
|
|
1466
|
+
* Unauthorized
|
|
1467
|
+
*/
|
|
1468
|
+
401: {
|
|
1469
|
+
message: string;
|
|
1470
|
+
details?: unknown;
|
|
1471
|
+
};
|
|
1472
|
+
/**
|
|
1473
|
+
* Forbidden — insufficient permissions
|
|
1474
|
+
*/
|
|
1475
|
+
403: {
|
|
1476
|
+
message: string;
|
|
1477
|
+
details?: unknown;
|
|
1478
|
+
};
|
|
1479
|
+
};
|
|
1480
|
+
export type GetApiSubjectsResponses = {
|
|
1481
|
+
/**
|
|
1482
|
+
* Successful response
|
|
1483
|
+
*/
|
|
1484
|
+
200: {
|
|
1485
|
+
subjects: Array<{
|
|
1486
|
+
id: string;
|
|
1487
|
+
name: string;
|
|
1488
|
+
email: string | null;
|
|
1489
|
+
type: "user" | "machine";
|
|
1490
|
+
}>;
|
|
1491
|
+
total: number;
|
|
1492
|
+
};
|
|
1493
|
+
};
|
|
1494
|
+
export type GetApiProjectsByProjectIdSubjectsData = {
|
|
1495
|
+
body?: never;
|
|
1496
|
+
path: {
|
|
1497
|
+
projectId: string;
|
|
1498
|
+
};
|
|
1499
|
+
query?: {
|
|
1500
|
+
q?: string;
|
|
1501
|
+
limit?: number;
|
|
1502
|
+
offset?: number;
|
|
1503
|
+
};
|
|
1504
|
+
url: "/api/projects/{projectId}/subjects";
|
|
1505
|
+
};
|
|
1506
|
+
export type GetApiProjectsByProjectIdSubjectsErrors = {
|
|
1507
|
+
/**
|
|
1508
|
+
* Bad Request
|
|
1509
|
+
*/
|
|
1510
|
+
400: {
|
|
1511
|
+
message: string;
|
|
1512
|
+
details?: unknown;
|
|
1513
|
+
};
|
|
1514
|
+
/**
|
|
1515
|
+
* Unauthorized
|
|
1516
|
+
*/
|
|
1517
|
+
401: {
|
|
1518
|
+
message: string;
|
|
1519
|
+
details?: unknown;
|
|
1520
|
+
};
|
|
1521
|
+
/**
|
|
1522
|
+
* Forbidden — insufficient permissions
|
|
1523
|
+
*/
|
|
1524
|
+
403: {
|
|
1525
|
+
message: string;
|
|
1526
|
+
details?: unknown;
|
|
1527
|
+
};
|
|
1528
|
+
};
|
|
1529
|
+
export type GetApiProjectsByProjectIdSubjectsResponses = {
|
|
1530
|
+
/**
|
|
1531
|
+
* Successful response
|
|
1532
|
+
*/
|
|
1533
|
+
200: {
|
|
1534
|
+
subjects: Array<{
|
|
1535
|
+
id: string;
|
|
1536
|
+
name: string;
|
|
1537
|
+
email: string | null;
|
|
1538
|
+
type: "user";
|
|
1539
|
+
isAdmin: boolean;
|
|
1540
|
+
permissionCount: number;
|
|
1541
|
+
}>;
|
|
1542
|
+
total: number;
|
|
1543
|
+
};
|
|
1544
|
+
};
|
|
1545
|
+
export type GetApiProjectsByProjectIdPermissionsMatrixData = {
|
|
1546
|
+
body?: never;
|
|
1547
|
+
path: {
|
|
1548
|
+
projectId: string;
|
|
1549
|
+
};
|
|
1550
|
+
query: {
|
|
1551
|
+
subjectId: string;
|
|
1552
|
+
};
|
|
1553
|
+
url: "/api/projects/{projectId}/permissions/matrix";
|
|
1554
|
+
};
|
|
1555
|
+
export type GetApiProjectsByProjectIdPermissionsMatrixErrors = {
|
|
1556
|
+
/**
|
|
1557
|
+
* Bad Request
|
|
1558
|
+
*/
|
|
1559
|
+
400: {
|
|
1560
|
+
message: string;
|
|
1561
|
+
details?: unknown;
|
|
1562
|
+
};
|
|
1563
|
+
/**
|
|
1564
|
+
* Unauthorized
|
|
1565
|
+
*/
|
|
1566
|
+
401: {
|
|
1567
|
+
message: string;
|
|
1568
|
+
details?: unknown;
|
|
1569
|
+
};
|
|
1570
|
+
/**
|
|
1571
|
+
* Forbidden — insufficient permissions
|
|
1572
|
+
*/
|
|
1573
|
+
403: {
|
|
1574
|
+
message: string;
|
|
1575
|
+
details?: unknown;
|
|
1576
|
+
};
|
|
1577
|
+
};
|
|
1578
|
+
export type GetApiProjectsByProjectIdPermissionsMatrixResponses = {
|
|
1579
|
+
/**
|
|
1580
|
+
* Successful response
|
|
1581
|
+
*/
|
|
1582
|
+
200: {
|
|
1583
|
+
subject: {
|
|
1584
|
+
id: string;
|
|
1585
|
+
name: string;
|
|
1586
|
+
type: "user" | "machine";
|
|
1587
|
+
};
|
|
1588
|
+
secrets: Array<{
|
|
1589
|
+
name: string;
|
|
1590
|
+
description: string | null;
|
|
1591
|
+
environments: Array<"dev" | "staging" | "production">;
|
|
1592
|
+
secretIds: {
|
|
1593
|
+
dev?: string;
|
|
1594
|
+
staging?: string;
|
|
1595
|
+
production?: string;
|
|
1596
|
+
};
|
|
1597
|
+
}>;
|
|
1598
|
+
permissions: Array<{
|
|
1599
|
+
secretId: string;
|
|
1600
|
+
environment: "dev" | "staging" | "production";
|
|
1601
|
+
permissionId: string;
|
|
1602
|
+
}>;
|
|
1603
|
+
};
|
|
1604
|
+
};
|
|
1605
|
+
export type PostApiProjectsByProjectIdPermissionsBatchData = {
|
|
1606
|
+
body: {
|
|
1607
|
+
subjectId: string;
|
|
1608
|
+
add: Array<{
|
|
1609
|
+
secretId: string;
|
|
1610
|
+
environment: "dev" | "staging" | "production";
|
|
1611
|
+
}>;
|
|
1612
|
+
remove: Array<{
|
|
1613
|
+
permissionId: string;
|
|
1614
|
+
}>;
|
|
1615
|
+
};
|
|
1616
|
+
path: {
|
|
1617
|
+
projectId: string;
|
|
1618
|
+
};
|
|
1619
|
+
query?: never;
|
|
1620
|
+
url: "/api/projects/{projectId}/permissions/batch";
|
|
1621
|
+
};
|
|
1622
|
+
export type PostApiProjectsByProjectIdPermissionsBatchErrors = {
|
|
1623
|
+
/**
|
|
1624
|
+
* Bad Request
|
|
1625
|
+
*/
|
|
1626
|
+
400: {
|
|
1627
|
+
message: string;
|
|
1628
|
+
details?: unknown;
|
|
1629
|
+
};
|
|
1630
|
+
/**
|
|
1631
|
+
* Unauthorized
|
|
1632
|
+
*/
|
|
1633
|
+
401: {
|
|
1634
|
+
message: string;
|
|
1635
|
+
details?: unknown;
|
|
1636
|
+
};
|
|
1637
|
+
/**
|
|
1638
|
+
* Forbidden — insufficient permissions
|
|
1639
|
+
*/
|
|
1640
|
+
403: {
|
|
1641
|
+
message: string;
|
|
1642
|
+
details?: unknown;
|
|
1643
|
+
};
|
|
1644
|
+
};
|
|
1645
|
+
export type PostApiProjectsByProjectIdPermissionsBatchResponses = {
|
|
1646
|
+
/**
|
|
1647
|
+
* Successful response
|
|
1648
|
+
*/
|
|
1649
|
+
200: {
|
|
1650
|
+
added: number;
|
|
1651
|
+
removed: number;
|
|
1652
|
+
};
|
|
1653
|
+
};
|
|
1654
|
+
export type GetApiProjectsByProjectIdPermissionsAuditLogsData = {
|
|
1655
|
+
body?: never;
|
|
1656
|
+
path: {
|
|
1657
|
+
projectId: string;
|
|
1658
|
+
};
|
|
1659
|
+
query?: {
|
|
1660
|
+
eventType?: "permission_granted" | "permission_revoked";
|
|
1661
|
+
subjectId?: string;
|
|
1662
|
+
environment?: "dev" | "staging" | "production";
|
|
1663
|
+
limit?: number;
|
|
1664
|
+
offset?: number;
|
|
1665
|
+
};
|
|
1666
|
+
url: "/api/projects/{projectId}/permissions/audit-logs";
|
|
1667
|
+
};
|
|
1668
|
+
export type GetApiProjectsByProjectIdPermissionsAuditLogsErrors = {
|
|
1669
|
+
/**
|
|
1670
|
+
* Bad Request
|
|
1671
|
+
*/
|
|
1672
|
+
400: {
|
|
1673
|
+
message: string;
|
|
1674
|
+
details?: unknown;
|
|
1675
|
+
};
|
|
1676
|
+
/**
|
|
1677
|
+
* Unauthorized
|
|
1678
|
+
*/
|
|
1679
|
+
401: {
|
|
1680
|
+
message: string;
|
|
1681
|
+
details?: unknown;
|
|
1682
|
+
};
|
|
1683
|
+
/**
|
|
1684
|
+
* Forbidden — insufficient permissions
|
|
1685
|
+
*/
|
|
1686
|
+
403: {
|
|
1687
|
+
message: string;
|
|
1688
|
+
details?: unknown;
|
|
1689
|
+
};
|
|
1690
|
+
};
|
|
1691
|
+
export type GetApiProjectsByProjectIdPermissionsAuditLogsResponses = {
|
|
1692
|
+
/**
|
|
1693
|
+
* Successful response
|
|
1694
|
+
*/
|
|
1695
|
+
200: {
|
|
1696
|
+
entries: Array<{
|
|
1697
|
+
id: string;
|
|
1698
|
+
eventType: "permission_granted" | "permission_revoked";
|
|
1699
|
+
subjectId: string;
|
|
1700
|
+
subjectName: string;
|
|
1701
|
+
projectId: string;
|
|
1702
|
+
environment: "dev" | "staging" | "production" | null;
|
|
1703
|
+
secretNames: string | null;
|
|
1704
|
+
success: boolean;
|
|
1705
|
+
details: string | null;
|
|
1706
|
+
createdAt: number;
|
|
1707
|
+
}>;
|
|
1708
|
+
total: number;
|
|
1709
|
+
};
|
|
1710
|
+
};
|
|
1711
|
+
export type GetApiMachinesByIdPermissionsData = {
|
|
1712
|
+
body?: never;
|
|
1713
|
+
path: {
|
|
1714
|
+
id: string;
|
|
1715
|
+
};
|
|
1716
|
+
query?: never;
|
|
1717
|
+
url: "/api/machines/{id}/permissions";
|
|
1718
|
+
};
|
|
1719
|
+
export type GetApiMachinesByIdPermissionsErrors = {
|
|
1720
|
+
/**
|
|
1721
|
+
* Unauthorized
|
|
1722
|
+
*/
|
|
1723
|
+
401: {
|
|
1724
|
+
message: string;
|
|
1725
|
+
details?: unknown;
|
|
1726
|
+
};
|
|
1727
|
+
/**
|
|
1728
|
+
* Forbidden — insufficient permissions
|
|
1729
|
+
*/
|
|
1730
|
+
403: {
|
|
1731
|
+
message: string;
|
|
1732
|
+
details?: unknown;
|
|
1733
|
+
};
|
|
1734
|
+
};
|
|
1735
|
+
export type GetApiMachinesByIdPermissionsResponses = {
|
|
1736
|
+
/**
|
|
1737
|
+
* Successful response
|
|
1738
|
+
*/
|
|
1739
|
+
200: Array<{
|
|
1740
|
+
projectId: string;
|
|
1741
|
+
projectName: string;
|
|
1742
|
+
secretId: string;
|
|
1743
|
+
secretName: string;
|
|
1744
|
+
environment: "dev" | "staging" | "production";
|
|
1745
|
+
}>;
|
|
1746
|
+
};
|
|
1747
|
+
export type GetApiMachinesByIdPermissionsMatrixData = {
|
|
1748
|
+
body?: never;
|
|
1749
|
+
path: {
|
|
1750
|
+
id: string;
|
|
1751
|
+
};
|
|
1752
|
+
query: {
|
|
1753
|
+
projectId: string;
|
|
1754
|
+
};
|
|
1755
|
+
url: "/api/machines/{id}/permissions/matrix";
|
|
1756
|
+
};
|
|
1757
|
+
export type GetApiMachinesByIdPermissionsMatrixErrors = {
|
|
1758
|
+
/**
|
|
1759
|
+
* Bad Request
|
|
1760
|
+
*/
|
|
1761
|
+
400: {
|
|
1762
|
+
message: string;
|
|
1763
|
+
details?: unknown;
|
|
1764
|
+
};
|
|
1765
|
+
/**
|
|
1766
|
+
* Unauthorized
|
|
1767
|
+
*/
|
|
1768
|
+
401: {
|
|
1769
|
+
message: string;
|
|
1770
|
+
details?: unknown;
|
|
1771
|
+
};
|
|
1772
|
+
/**
|
|
1773
|
+
* Forbidden — insufficient permissions
|
|
1774
|
+
*/
|
|
1775
|
+
403: {
|
|
1776
|
+
message: string;
|
|
1777
|
+
details?: unknown;
|
|
1778
|
+
};
|
|
1779
|
+
};
|
|
1780
|
+
export type GetApiMachinesByIdPermissionsMatrixResponses = {
|
|
1781
|
+
/**
|
|
1782
|
+
* Successful response
|
|
1783
|
+
*/
|
|
1784
|
+
200: {
|
|
1785
|
+
machine: {
|
|
1786
|
+
id: string;
|
|
1787
|
+
name: string;
|
|
1788
|
+
};
|
|
1789
|
+
isAdmin: boolean;
|
|
1790
|
+
secrets: Array<{
|
|
1791
|
+
name: string;
|
|
1792
|
+
description: string | null;
|
|
1793
|
+
environments: Array<"dev" | "staging" | "production">;
|
|
1794
|
+
secretIds: {
|
|
1795
|
+
dev?: string;
|
|
1796
|
+
staging?: string;
|
|
1797
|
+
production?: string;
|
|
1798
|
+
};
|
|
1799
|
+
}>;
|
|
1800
|
+
permissions: Array<{
|
|
1801
|
+
secretId: string;
|
|
1802
|
+
environment: "dev" | "staging" | "production";
|
|
1803
|
+
permissionId: string;
|
|
1804
|
+
}>;
|
|
1805
|
+
};
|
|
1806
|
+
};
|
|
1807
|
+
export type PostApiMachinesByIdPermissionsBatchData = {
|
|
1808
|
+
body: {
|
|
1809
|
+
projectId: string;
|
|
1810
|
+
add: Array<{
|
|
1811
|
+
secretId: string;
|
|
1812
|
+
environment: "dev" | "staging" | "production";
|
|
1813
|
+
}>;
|
|
1814
|
+
remove: Array<{
|
|
1815
|
+
permissionId: string;
|
|
1816
|
+
}>;
|
|
1817
|
+
};
|
|
1818
|
+
path: {
|
|
1819
|
+
id: string;
|
|
1820
|
+
};
|
|
1821
|
+
query?: never;
|
|
1822
|
+
url: "/api/machines/{id}/permissions/batch";
|
|
1823
|
+
};
|
|
1824
|
+
export type PostApiMachinesByIdPermissionsBatchErrors = {
|
|
1825
|
+
/**
|
|
1826
|
+
* Bad Request
|
|
1827
|
+
*/
|
|
1828
|
+
400: {
|
|
1829
|
+
message: string;
|
|
1830
|
+
details?: unknown;
|
|
1831
|
+
};
|
|
1832
|
+
/**
|
|
1833
|
+
* Unauthorized
|
|
1834
|
+
*/
|
|
1835
|
+
401: {
|
|
1836
|
+
message: string;
|
|
1837
|
+
details?: unknown;
|
|
1838
|
+
};
|
|
1839
|
+
/**
|
|
1840
|
+
* Forbidden — insufficient permissions
|
|
1841
|
+
*/
|
|
1842
|
+
403: {
|
|
1843
|
+
message: string;
|
|
1844
|
+
details?: unknown;
|
|
1845
|
+
};
|
|
1846
|
+
};
|
|
1847
|
+
export type PostApiMachinesByIdPermissionsBatchResponses = {
|
|
1848
|
+
/**
|
|
1849
|
+
* Successful response
|
|
1850
|
+
*/
|
|
1851
|
+
200: {
|
|
1852
|
+
added: number;
|
|
1853
|
+
removed: number;
|
|
1854
|
+
};
|
|
1855
|
+
};
|
|
1856
|
+
export type PostApiMachinesByIdRegenerateData = {
|
|
1857
|
+
body?: never;
|
|
1858
|
+
path: {
|
|
1859
|
+
id: string;
|
|
1860
|
+
};
|
|
1861
|
+
query?: never;
|
|
1862
|
+
url: "/api/machines/{id}/regenerate";
|
|
1863
|
+
};
|
|
1864
|
+
export type PostApiMachinesByIdRegenerateErrors = {
|
|
1865
|
+
/**
|
|
1866
|
+
* Unauthorized
|
|
1867
|
+
*/
|
|
1868
|
+
401: {
|
|
1869
|
+
message: string;
|
|
1870
|
+
details?: unknown;
|
|
1871
|
+
};
|
|
1872
|
+
/**
|
|
1873
|
+
* Forbidden — insufficient permissions
|
|
1874
|
+
*/
|
|
1875
|
+
403: {
|
|
1876
|
+
message: string;
|
|
1877
|
+
details?: unknown;
|
|
1878
|
+
};
|
|
1879
|
+
};
|
|
1880
|
+
export type PostApiMachinesByIdRegenerateResponses = {
|
|
1881
|
+
/**
|
|
1882
|
+
* Successful response
|
|
1883
|
+
*/
|
|
1884
|
+
200: {
|
|
1885
|
+
id: string;
|
|
1886
|
+
rawId: string;
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
export type DeleteApiMachinesByIdData = {
|
|
1890
|
+
body?: never;
|
|
1891
|
+
path: {
|
|
1892
|
+
id: string;
|
|
1893
|
+
};
|
|
1894
|
+
query?: never;
|
|
1895
|
+
url: "/api/machines/{id}";
|
|
1896
|
+
};
|
|
1897
|
+
export type DeleteApiMachinesByIdErrors = {
|
|
1898
|
+
/**
|
|
1899
|
+
* Bad Request
|
|
1900
|
+
*/
|
|
1901
|
+
400: {
|
|
1902
|
+
message: string;
|
|
1903
|
+
details?: unknown;
|
|
1904
|
+
};
|
|
1905
|
+
/**
|
|
1906
|
+
* Unauthorized
|
|
1907
|
+
*/
|
|
1908
|
+
401: {
|
|
1909
|
+
message: string;
|
|
1910
|
+
details?: unknown;
|
|
1911
|
+
};
|
|
1912
|
+
/**
|
|
1913
|
+
* Forbidden — insufficient permissions
|
|
1914
|
+
*/
|
|
1915
|
+
403: {
|
|
1916
|
+
message: string;
|
|
1917
|
+
details?: unknown;
|
|
1918
|
+
};
|
|
1919
|
+
};
|
|
1920
|
+
export type DeleteApiMachinesByIdResponses = {
|
|
1921
|
+
/**
|
|
1922
|
+
* Machine deleted
|
|
1923
|
+
*/
|
|
1924
|
+
204: void;
|
|
1925
|
+
};
|
|
1926
|
+
export type GetApiMachinesByIdData = {
|
|
1927
|
+
body?: never;
|
|
1928
|
+
path: {
|
|
1929
|
+
id: string;
|
|
1930
|
+
};
|
|
1931
|
+
query?: never;
|
|
1932
|
+
url: "/api/machines/{id}";
|
|
1933
|
+
};
|
|
1934
|
+
export type GetApiMachinesByIdErrors = {
|
|
1935
|
+
/**
|
|
1936
|
+
* Unauthorized
|
|
1937
|
+
*/
|
|
1938
|
+
401: {
|
|
1939
|
+
message: string;
|
|
1940
|
+
details?: unknown;
|
|
1941
|
+
};
|
|
1942
|
+
/**
|
|
1943
|
+
* Forbidden — insufficient permissions
|
|
1944
|
+
*/
|
|
1945
|
+
403: {
|
|
1946
|
+
message: string;
|
|
1947
|
+
details?: unknown;
|
|
1948
|
+
};
|
|
1949
|
+
};
|
|
1950
|
+
export type GetApiMachinesByIdResponses = {
|
|
1951
|
+
/**
|
|
1952
|
+
* Successful response
|
|
1953
|
+
*/
|
|
1954
|
+
200: {
|
|
1955
|
+
id: string;
|
|
1956
|
+
type: "machine";
|
|
1957
|
+
name: string;
|
|
1958
|
+
idMasked: string;
|
|
1959
|
+
createdBy: string;
|
|
1960
|
+
createdAt: number;
|
|
1961
|
+
updatedAt: number;
|
|
1962
|
+
lastUsed: number | null;
|
|
1963
|
+
};
|
|
1964
|
+
};
|
|
1965
|
+
export type PatchApiMachinesByIdData = {
|
|
1966
|
+
body: {
|
|
1967
|
+
name: string;
|
|
1968
|
+
};
|
|
1969
|
+
path: {
|
|
1970
|
+
id: string;
|
|
1971
|
+
};
|
|
1972
|
+
query?: never;
|
|
1973
|
+
url: "/api/machines/{id}";
|
|
1974
|
+
};
|
|
1975
|
+
export type PatchApiMachinesByIdErrors = {
|
|
1976
|
+
/**
|
|
1977
|
+
* Bad Request
|
|
1978
|
+
*/
|
|
1979
|
+
400: {
|
|
1980
|
+
message: string;
|
|
1981
|
+
details?: unknown;
|
|
1982
|
+
};
|
|
1983
|
+
/**
|
|
1984
|
+
* Unauthorized
|
|
1985
|
+
*/
|
|
1986
|
+
401: {
|
|
1987
|
+
message: string;
|
|
1988
|
+
details?: unknown;
|
|
1989
|
+
};
|
|
1990
|
+
/**
|
|
1991
|
+
* Forbidden — insufficient permissions
|
|
1992
|
+
*/
|
|
1993
|
+
403: {
|
|
1994
|
+
message: string;
|
|
1995
|
+
details?: unknown;
|
|
1996
|
+
};
|
|
1997
|
+
};
|
|
1998
|
+
export type PatchApiMachinesByIdResponses = {
|
|
1999
|
+
/**
|
|
2000
|
+
* Successful response
|
|
2001
|
+
*/
|
|
2002
|
+
200: {
|
|
2003
|
+
id: string;
|
|
2004
|
+
type: "machine";
|
|
2005
|
+
name: string;
|
|
2006
|
+
idMasked: string;
|
|
2007
|
+
createdBy: string;
|
|
2008
|
+
createdAt: number;
|
|
2009
|
+
updatedAt: number;
|
|
2010
|
+
lastUsed: number | null;
|
|
2011
|
+
};
|
|
2012
|
+
};
|
|
2013
|
+
export type DeleteApiMachinesData = {
|
|
2014
|
+
body: {
|
|
2015
|
+
ids: Array<string>;
|
|
2016
|
+
};
|
|
2017
|
+
path?: never;
|
|
2018
|
+
query?: never;
|
|
2019
|
+
url: "/api/machines";
|
|
2020
|
+
};
|
|
2021
|
+
export type DeleteApiMachinesErrors = {
|
|
2022
|
+
/**
|
|
2023
|
+
* Bad Request
|
|
2024
|
+
*/
|
|
2025
|
+
400: {
|
|
2026
|
+
message: string;
|
|
2027
|
+
details?: unknown;
|
|
2028
|
+
};
|
|
2029
|
+
/**
|
|
2030
|
+
* Unauthorized
|
|
2031
|
+
*/
|
|
2032
|
+
401: {
|
|
2033
|
+
message: string;
|
|
2034
|
+
details?: unknown;
|
|
2035
|
+
};
|
|
2036
|
+
/**
|
|
2037
|
+
* Forbidden — insufficient permissions
|
|
2038
|
+
*/
|
|
2039
|
+
403: {
|
|
2040
|
+
message: string;
|
|
2041
|
+
details?: unknown;
|
|
2042
|
+
};
|
|
2043
|
+
};
|
|
2044
|
+
export type DeleteApiMachinesResponses = {
|
|
2045
|
+
/**
|
|
2046
|
+
* Machines deleted
|
|
2047
|
+
*/
|
|
2048
|
+
204: void;
|
|
2049
|
+
};
|
|
2050
|
+
export type GetApiMachinesData = {
|
|
2051
|
+
body?: never;
|
|
2052
|
+
path?: never;
|
|
2053
|
+
query?: {
|
|
2054
|
+
limit?: number;
|
|
2055
|
+
offset?: number;
|
|
2056
|
+
search?: string;
|
|
2057
|
+
};
|
|
2058
|
+
url: "/api/machines";
|
|
2059
|
+
};
|
|
2060
|
+
export type GetApiMachinesErrors = {
|
|
2061
|
+
/**
|
|
2062
|
+
* Bad Request
|
|
2063
|
+
*/
|
|
2064
|
+
400: {
|
|
2065
|
+
message: string;
|
|
2066
|
+
details?: unknown;
|
|
2067
|
+
};
|
|
2068
|
+
/**
|
|
2069
|
+
* Unauthorized
|
|
2070
|
+
*/
|
|
2071
|
+
401: {
|
|
2072
|
+
message: string;
|
|
2073
|
+
details?: unknown;
|
|
2074
|
+
};
|
|
2075
|
+
/**
|
|
2076
|
+
* Forbidden — insufficient permissions
|
|
2077
|
+
*/
|
|
2078
|
+
403: {
|
|
2079
|
+
message: string;
|
|
2080
|
+
details?: unknown;
|
|
2081
|
+
};
|
|
2082
|
+
};
|
|
2083
|
+
export type GetApiMachinesResponses = {
|
|
2084
|
+
/**
|
|
2085
|
+
* Successful response
|
|
2086
|
+
*/
|
|
2087
|
+
200: {
|
|
2088
|
+
machines: Array<{
|
|
2089
|
+
id: string;
|
|
2090
|
+
type: "machine";
|
|
2091
|
+
name: string;
|
|
2092
|
+
idMasked: string;
|
|
2093
|
+
createdBy: string;
|
|
2094
|
+
createdAt: number;
|
|
2095
|
+
updatedAt: number;
|
|
2096
|
+
lastUsed: number | null;
|
|
2097
|
+
}>;
|
|
2098
|
+
total: number;
|
|
2099
|
+
};
|
|
2100
|
+
};
|
|
2101
|
+
export type PatchApiMachinesData = {
|
|
2102
|
+
body: Array<{
|
|
2103
|
+
id: string;
|
|
2104
|
+
name: string;
|
|
2105
|
+
}>;
|
|
2106
|
+
path?: never;
|
|
2107
|
+
query?: never;
|
|
2108
|
+
url: "/api/machines";
|
|
2109
|
+
};
|
|
2110
|
+
export type PatchApiMachinesErrors = {
|
|
2111
|
+
/**
|
|
2112
|
+
* Bad Request
|
|
2113
|
+
*/
|
|
2114
|
+
400: {
|
|
2115
|
+
message: string;
|
|
2116
|
+
details?: unknown;
|
|
2117
|
+
};
|
|
2118
|
+
/**
|
|
2119
|
+
* Unauthorized
|
|
2120
|
+
*/
|
|
2121
|
+
401: {
|
|
2122
|
+
message: string;
|
|
2123
|
+
details?: unknown;
|
|
2124
|
+
};
|
|
2125
|
+
/**
|
|
2126
|
+
* Forbidden — insufficient permissions
|
|
2127
|
+
*/
|
|
2128
|
+
403: {
|
|
2129
|
+
message: string;
|
|
2130
|
+
details?: unknown;
|
|
2131
|
+
};
|
|
2132
|
+
};
|
|
2133
|
+
export type PatchApiMachinesResponses = {
|
|
2134
|
+
/**
|
|
2135
|
+
* Successful response
|
|
2136
|
+
*/
|
|
2137
|
+
200: Array<{
|
|
2138
|
+
id: string;
|
|
2139
|
+
type: "machine";
|
|
2140
|
+
name: string;
|
|
2141
|
+
idMasked: string;
|
|
2142
|
+
createdBy: string;
|
|
2143
|
+
createdAt: number;
|
|
2144
|
+
updatedAt: number;
|
|
2145
|
+
lastUsed: number | null;
|
|
2146
|
+
}>;
|
|
2147
|
+
};
|
|
2148
|
+
export type PostApiMachinesData = {
|
|
2149
|
+
body: {
|
|
2150
|
+
name: string;
|
|
2151
|
+
};
|
|
2152
|
+
path?: never;
|
|
2153
|
+
query?: never;
|
|
2154
|
+
url: "/api/machines";
|
|
2155
|
+
};
|
|
2156
|
+
export type PostApiMachinesErrors = {
|
|
2157
|
+
/**
|
|
2158
|
+
* Bad Request
|
|
2159
|
+
*/
|
|
2160
|
+
400: {
|
|
2161
|
+
message: string;
|
|
2162
|
+
details?: unknown;
|
|
2163
|
+
};
|
|
2164
|
+
/**
|
|
2165
|
+
* Unauthorized
|
|
2166
|
+
*/
|
|
2167
|
+
401: {
|
|
2168
|
+
message: string;
|
|
2169
|
+
details?: unknown;
|
|
2170
|
+
};
|
|
2171
|
+
/**
|
|
2172
|
+
* Forbidden — insufficient permissions
|
|
2173
|
+
*/
|
|
2174
|
+
403: {
|
|
2175
|
+
message: string;
|
|
2176
|
+
details?: unknown;
|
|
2177
|
+
};
|
|
2178
|
+
};
|
|
2179
|
+
export type PostApiMachinesResponses = {
|
|
2180
|
+
/**
|
|
2181
|
+
* Machine created
|
|
2182
|
+
*/
|
|
2183
|
+
201: {
|
|
2184
|
+
id: string;
|
|
2185
|
+
type: "machine";
|
|
2186
|
+
name: string;
|
|
2187
|
+
idMasked: string;
|
|
2188
|
+
createdBy: string;
|
|
2189
|
+
createdAt: number;
|
|
2190
|
+
updatedAt: number;
|
|
2191
|
+
lastUsed: number | null;
|
|
2192
|
+
rawId: string;
|
|
2193
|
+
};
|
|
2194
|
+
};
|
|
2195
|
+
export type PostApiMachinesQueryData = {
|
|
2196
|
+
body: {
|
|
2197
|
+
ids: Array<string>;
|
|
2198
|
+
};
|
|
2199
|
+
path?: never;
|
|
2200
|
+
query?: never;
|
|
2201
|
+
url: "/api/machines/query";
|
|
2202
|
+
};
|
|
2203
|
+
export type PostApiMachinesQueryErrors = {
|
|
2204
|
+
/**
|
|
2205
|
+
* Bad Request
|
|
2206
|
+
*/
|
|
2207
|
+
400: {
|
|
2208
|
+
message: string;
|
|
2209
|
+
details?: unknown;
|
|
2210
|
+
};
|
|
2211
|
+
/**
|
|
2212
|
+
* Unauthorized
|
|
2213
|
+
*/
|
|
2214
|
+
401: {
|
|
2215
|
+
message: string;
|
|
2216
|
+
details?: unknown;
|
|
2217
|
+
};
|
|
2218
|
+
/**
|
|
2219
|
+
* Forbidden — insufficient permissions
|
|
2220
|
+
*/
|
|
2221
|
+
403: {
|
|
2222
|
+
message: string;
|
|
2223
|
+
details?: unknown;
|
|
2224
|
+
};
|
|
2225
|
+
};
|
|
2226
|
+
export type PostApiMachinesQueryResponses = {
|
|
2227
|
+
/**
|
|
2228
|
+
* Successful response
|
|
2229
|
+
*/
|
|
2230
|
+
200: {
|
|
2231
|
+
machines: Array<{
|
|
2232
|
+
id: string;
|
|
2233
|
+
type: "machine";
|
|
2234
|
+
name: string;
|
|
2235
|
+
idMasked: string;
|
|
2236
|
+
createdBy: string;
|
|
2237
|
+
createdAt: number;
|
|
2238
|
+
updatedAt: number;
|
|
2239
|
+
lastUsed: number | null;
|
|
2240
|
+
}>;
|
|
2241
|
+
total: number;
|
|
2242
|
+
};
|
|
2243
|
+
};
|
|
2244
|
+
export type DeleteApiLumiblueTokenData = {
|
|
2245
|
+
body?: never;
|
|
2246
|
+
path?: never;
|
|
2247
|
+
query?: never;
|
|
2248
|
+
url: "/api/lumiblue-token";
|
|
2249
|
+
};
|
|
2250
|
+
export type DeleteApiLumiblueTokenResponses = {
|
|
2251
|
+
/**
|
|
2252
|
+
* Cookie cleared; no response body.
|
|
2253
|
+
*/
|
|
2254
|
+
204: void;
|
|
2255
|
+
};
|
|
2256
|
+
type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options<TData, ThrowOnError, TResponse> & {
|
|
2257
|
+
/**
|
|
2258
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
2259
|
+
* individual options. This might be also useful if you want to implement a
|
|
2260
|
+
* custom client.
|
|
2261
|
+
*/
|
|
2262
|
+
client?: Client$1;
|
|
2263
|
+
/**
|
|
2264
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
2265
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
2266
|
+
*/
|
|
2267
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
2268
|
+
};
|
|
2269
|
+
declare class HeyApiClient {
|
|
2270
|
+
protected client: Client$1;
|
|
2271
|
+
constructor(args?: {
|
|
2272
|
+
client?: Client$1;
|
|
2273
|
+
});
|
|
2274
|
+
}
|
|
2275
|
+
declare class HeyApiRegistry<T> {
|
|
2276
|
+
private readonly defaultKey;
|
|
2277
|
+
private readonly instances;
|
|
2278
|
+
get(key?: string): T;
|
|
2279
|
+
set(value: T, key?: string): void;
|
|
2280
|
+
}
|
|
2281
|
+
export declare class Sdk extends HeyApiClient {
|
|
2282
|
+
static readonly __registry: HeyApiRegistry<Sdk>;
|
|
2283
|
+
constructor(args?: {
|
|
2284
|
+
client?: Client$1;
|
|
2285
|
+
key?: string;
|
|
2286
|
+
});
|
|
2287
|
+
/**
|
|
2288
|
+
* Service health check response
|
|
2289
|
+
*/
|
|
2290
|
+
getApiHealth<ThrowOnError extends boolean = false>(options?: Options$1<GetApiHealthData, ThrowOnError>): RequestResult<GetApiHealthResponses, unknown, ThrowOnError>;
|
|
2291
|
+
/**
|
|
2292
|
+
* Bearer Auth - service health check plus JWT payload
|
|
2293
|
+
*/
|
|
2294
|
+
getApiHealthMe<ThrowOnError extends boolean = false>(options?: Options$1<GetApiHealthMeData, ThrowOnError>): RequestResult<GetApiHealthMeResponses, GetApiHealthMeErrors, ThrowOnError>;
|
|
2295
|
+
/**
|
|
2296
|
+
* Bulk delete projects by array of IDs (project-admin only).
|
|
2297
|
+
*/
|
|
2298
|
+
deleteApiVaultProjects<ThrowOnError extends boolean = false>(options: Options$1<DeleteApiVaultProjectsData, ThrowOnError>): RequestResult<DeleteApiVaultProjectsResponses, DeleteApiVaultProjectsErrors, ThrowOnError>;
|
|
2299
|
+
/**
|
|
2300
|
+
* List all projects accessible to the authenticated user, with per-project secret count.
|
|
2301
|
+
*/
|
|
2302
|
+
getApiVaultProjects<ThrowOnError extends boolean = false>(options?: Options$1<GetApiVaultProjectsData, ThrowOnError>): RequestResult<GetApiVaultProjectsResponses, GetApiVaultProjectsErrors, ThrowOnError>;
|
|
2303
|
+
/**
|
|
2304
|
+
* Bulk update projects (project-admin only).
|
|
2305
|
+
*/
|
|
2306
|
+
patchApiVaultProjects<ThrowOnError extends boolean = false>(options: Options$1<PatchApiVaultProjectsData, ThrowOnError>): RequestResult<PatchApiVaultProjectsResponses, PatchApiVaultProjectsErrors, ThrowOnError>;
|
|
2307
|
+
/**
|
|
2308
|
+
* Create one or more projects and auto-assign the creator as admin on each.
|
|
2309
|
+
*/
|
|
2310
|
+
putApiVaultProjects<ThrowOnError extends boolean = false>(options: Options$1<PutApiVaultProjectsData, ThrowOnError>): RequestResult<PutApiVaultProjectsResponses, PutApiVaultProjectsErrors, ThrowOnError>;
|
|
2311
|
+
/**
|
|
2312
|
+
* Get all secrets for a project, pivoted by environment (dev, staging, production).
|
|
2313
|
+
*/
|
|
2314
|
+
getApiVaultProjectsByProjectIdSecrets<ThrowOnError extends boolean = false>(options: Options$1<GetApiVaultProjectsByProjectIdSecretsData, ThrowOnError>): RequestResult<GetApiVaultProjectsByProjectIdSecretsResponses, GetApiVaultProjectsByProjectIdSecretsErrors, ThrowOnError>;
|
|
2315
|
+
/**
|
|
2316
|
+
* Reveal the decrypted plaintext value of a single secret. Call on demand when the user chooses to view it.
|
|
2317
|
+
*/
|
|
2318
|
+
getApiVaultSecretsBySecretId<ThrowOnError extends boolean = false>(options: Options$1<GetApiVaultSecretsBySecretIdData, ThrowOnError>): RequestResult<GetApiVaultSecretsBySecretIdResponses, GetApiVaultSecretsBySecretIdErrors, ThrowOnError>;
|
|
2319
|
+
/**
|
|
2320
|
+
* Update a single secret value. The plaintext value is encrypted before persisting.
|
|
2321
|
+
*/
|
|
2322
|
+
patchApiVaultSecretsBySecretId<ThrowOnError extends boolean = false>(options: Options$1<PatchApiVaultSecretsBySecretIdData, ThrowOnError>): RequestResult<PatchApiVaultSecretsBySecretIdResponses, PatchApiVaultSecretsBySecretIdErrors, ThrowOnError>;
|
|
2323
|
+
/**
|
|
2324
|
+
* Inject secrets for a machine identity. Authenticates via SHA-256 hash of machineId.
|
|
2325
|
+
*/
|
|
2326
|
+
postApiVaultInject<ThrowOnError extends boolean = false>(options: Options$1<PostApiVaultInjectData, ThrowOnError>): RequestResult<PostApiVaultInjectResponses, PostApiVaultInjectErrors, ThrowOnError>;
|
|
2327
|
+
/**
|
|
2328
|
+
* Batch query projects by array of IDs (access-scoped).
|
|
2329
|
+
*/
|
|
2330
|
+
postApiVaultProjectsQuery<ThrowOnError extends boolean = false>(options: Options$1<PostApiVaultProjectsQueryData, ThrowOnError>): RequestResult<PostApiVaultProjectsQueryResponses, PostApiVaultProjectsQueryErrors, ThrowOnError>;
|
|
2331
|
+
/**
|
|
2332
|
+
* Bulk delete secrets by array of IDs (permission-scoped).
|
|
2333
|
+
*/
|
|
2334
|
+
deleteApiVaultSecrets<ThrowOnError extends boolean = false>(options: Options$1<DeleteApiVaultSecretsData, ThrowOnError>): RequestResult<DeleteApiVaultSecretsResponses, DeleteApiVaultSecretsErrors, ThrowOnError>;
|
|
2335
|
+
/**
|
|
2336
|
+
* Bulk update secrets (permission-scoped).
|
|
2337
|
+
*/
|
|
2338
|
+
patchApiVaultSecrets<ThrowOnError extends boolean = false>(options: Options$1<PatchApiVaultSecretsData, ThrowOnError>): RequestResult<PatchApiVaultSecretsResponses, PatchApiVaultSecretsErrors, ThrowOnError>;
|
|
2339
|
+
/**
|
|
2340
|
+
* Bulk create secrets (plaintext values are encrypted before persisting).
|
|
2341
|
+
*/
|
|
2342
|
+
putApiVaultSecrets<ThrowOnError extends boolean = false>(options: Options$1<PutApiVaultSecretsData, ThrowOnError>): RequestResult<PutApiVaultSecretsResponses, PutApiVaultSecretsErrors, ThrowOnError>;
|
|
2343
|
+
/**
|
|
2344
|
+
* Batch query secrets by array of IDs (permission-scoped).
|
|
2345
|
+
*/
|
|
2346
|
+
postApiVaultSecretsQuery<ThrowOnError extends boolean = false>(options: Options$1<PostApiVaultSecretsQueryData, ThrowOnError>): RequestResult<PostApiVaultSecretsQueryResponses, PostApiVaultSecretsQueryErrors, ThrowOnError>;
|
|
2347
|
+
/**
|
|
2348
|
+
* Turn DMS off by hard-deleting the dms row (owner only). Idempotent when already off.
|
|
2349
|
+
*/
|
|
2350
|
+
deleteApiVaultProjectsByProjectIdDms<ThrowOnError extends boolean = false>(options: Options$1<DeleteApiVaultProjectsByProjectIdDmsData, ThrowOnError>): RequestResult<DeleteApiVaultProjectsByProjectIdDmsResponses, DeleteApiVaultProjectsByProjectIdDmsErrors, ThrowOnError>;
|
|
2351
|
+
/**
|
|
2352
|
+
* Read DMS settings for a vault project (owner only). Missing row returns stable off payload.
|
|
2353
|
+
*/
|
|
2354
|
+
getApiVaultProjectsByProjectIdDms<ThrowOnError extends boolean = false>(options: Options$1<GetApiVaultProjectsByProjectIdDmsData, ThrowOnError>): RequestResult<GetApiVaultProjectsByProjectIdDmsResponses, GetApiVaultProjectsByProjectIdDmsErrors, ThrowOnError>;
|
|
2355
|
+
/**
|
|
2356
|
+
* Edit DMS settings (owner only). Emails-only edits preserve delivery/reminder/claim fields.
|
|
2357
|
+
*/
|
|
2358
|
+
patchApiVaultProjectsByProjectIdDms<ThrowOnError extends boolean = false>(options: Options$1<PatchApiVaultProjectsByProjectIdDmsData, ThrowOnError>): RequestResult<PatchApiVaultProjectsByProjectIdDmsResponses, PatchApiVaultProjectsByProjectIdDmsErrors, ThrowOnError>;
|
|
2359
|
+
/**
|
|
2360
|
+
* Arm / create DMS for a project (owner only). Resets reminder, delivery, and claim cursors.
|
|
2361
|
+
*/
|
|
2362
|
+
putApiVaultProjectsByProjectIdDms<ThrowOnError extends boolean = false>(options: Options$1<PutApiVaultProjectsByProjectIdDmsData, ThrowOnError>): RequestResult<PutApiVaultProjectsByProjectIdDmsResponses, PutApiVaultProjectsByProjectIdDmsErrors, ThrowOnError>;
|
|
2363
|
+
/**
|
|
2364
|
+
* Public proof-of-life HTML page (signed magic-link token; no JWT).
|
|
2365
|
+
*/
|
|
2366
|
+
getApiDmsProofByToken<ThrowOnError extends boolean = false>(options: Options$1<GetApiDmsProofByTokenData, ThrowOnError>): RequestResult<GetApiDmsProofByTokenResponses, GetApiDmsProofByTokenErrors, ThrowOnError>;
|
|
2367
|
+
/**
|
|
2368
|
+
* Public proof-of-life update. Omit deliveryDate to extend by DMS_DEFAULT_EXTEND_DAYS.
|
|
2369
|
+
*/
|
|
2370
|
+
patchApiDmsProofByToken<ThrowOnError extends boolean = false>(options: Options$1<PatchApiDmsProofByTokenData, ThrowOnError>): RequestResult<PatchApiDmsProofByTokenResponses, PatchApiDmsProofByTokenErrors, ThrowOnError>;
|
|
2371
|
+
/**
|
|
2372
|
+
* Public project wipe via claim token. Confirmation must equal the project name.
|
|
2373
|
+
*/
|
|
2374
|
+
deleteApiDmsClaimByToken<ThrowOnError extends boolean = false>(options: Options$1<DeleteApiDmsClaimByTokenData, ThrowOnError>): RequestResult<DeleteApiDmsClaimByTokenResponses, DeleteApiDmsClaimByTokenErrors, ThrowOnError>;
|
|
2375
|
+
/**
|
|
2376
|
+
* Public claim HTML page with project notes and decrypted secrets (token credential).
|
|
2377
|
+
*/
|
|
2378
|
+
getApiDmsClaimByToken<ThrowOnError extends boolean = false>(options: Options$1<GetApiDmsClaimByTokenData, ThrowOnError>): RequestResult<GetApiDmsClaimByTokenResponses, GetApiDmsClaimByTokenErrors, ThrowOnError>;
|
|
2379
|
+
/**
|
|
2380
|
+
* List audit logs for a project. Only accessible by project admins. Supports date range filtering, pagination, and optional filters.
|
|
2381
|
+
*/
|
|
2382
|
+
getApiProjectsByProjectIdAuditLogs<ThrowOnError extends boolean = false>(options: Options$1<GetApiProjectsByProjectIdAuditLogsData, ThrowOnError>): RequestResult<GetApiProjectsByProjectIdAuditLogsResponses, GetApiProjectsByProjectIdAuditLogsErrors, ThrowOnError>;
|
|
2383
|
+
/**
|
|
2384
|
+
* List all admins for a project
|
|
2385
|
+
*/
|
|
2386
|
+
getApiProjectsByProjectIdAdmins<ThrowOnError extends boolean = false>(options: Options$1<GetApiProjectsByProjectIdAdminsData, ThrowOnError>): RequestResult<GetApiProjectsByProjectIdAdminsResponses, GetApiProjectsByProjectIdAdminsErrors, ThrowOnError>;
|
|
2387
|
+
/**
|
|
2388
|
+
* Add a new admin to a project
|
|
2389
|
+
*/
|
|
2390
|
+
postApiProjectsByProjectIdAdmins<ThrowOnError extends boolean = false>(options: Options$1<PostApiProjectsByProjectIdAdminsData, ThrowOnError>): RequestResult<PostApiProjectsByProjectIdAdminsResponses, PostApiProjectsByProjectIdAdminsErrors, ThrowOnError>;
|
|
2391
|
+
/**
|
|
2392
|
+
* Remove an admin from a project
|
|
2393
|
+
*/
|
|
2394
|
+
deleteApiProjectsByProjectIdAdminsBySubjectId<ThrowOnError extends boolean = false>(options: Options$1<DeleteApiProjectsByProjectIdAdminsBySubjectIdData, ThrowOnError>): RequestResult<DeleteApiProjectsByProjectIdAdminsBySubjectIdResponses, DeleteApiProjectsByProjectIdAdminsBySubjectIdErrors, ThrowOnError>;
|
|
2395
|
+
/**
|
|
2396
|
+
* List all users with access to a project (admins and/or users with permission grants)
|
|
2397
|
+
*/
|
|
2398
|
+
getApiProjectsByProjectIdAccess<ThrowOnError extends boolean = false>(options: Options$1<GetApiProjectsByProjectIdAccessData, ThrowOnError>): RequestResult<GetApiProjectsByProjectIdAccessResponses, GetApiProjectsByProjectIdAccessErrors, ThrowOnError>;
|
|
2399
|
+
/**
|
|
2400
|
+
* List or search all subjects in the authenticated tenant (users and machines)
|
|
2401
|
+
*/
|
|
2402
|
+
getApiSubjects<ThrowOnError extends boolean = false>(options?: Options$1<GetApiSubjectsData, ThrowOnError>): RequestResult<GetApiSubjectsResponses, GetApiSubjectsErrors, ThrowOnError>;
|
|
2403
|
+
/**
|
|
2404
|
+
* List all tenant users annotated with admin status and permission-grant count for this project
|
|
2405
|
+
*/
|
|
2406
|
+
getApiProjectsByProjectIdSubjects<ThrowOnError extends boolean = false>(options: Options$1<GetApiProjectsByProjectIdSubjectsData, ThrowOnError>): RequestResult<GetApiProjectsByProjectIdSubjectsResponses, GetApiProjectsByProjectIdSubjectsErrors, ThrowOnError>;
|
|
2407
|
+
/**
|
|
2408
|
+
* Get the permission matrix for a user subject within a project
|
|
2409
|
+
*/
|
|
2410
|
+
getApiProjectsByProjectIdPermissionsMatrix<ThrowOnError extends boolean = false>(options: Options$1<GetApiProjectsByProjectIdPermissionsMatrixData, ThrowOnError>): RequestResult<GetApiProjectsByProjectIdPermissionsMatrixResponses, GetApiProjectsByProjectIdPermissionsMatrixErrors, ThrowOnError>;
|
|
2411
|
+
/**
|
|
2412
|
+
* Atomically add and remove permissions for a user subject in a project
|
|
2413
|
+
*/
|
|
2414
|
+
postApiProjectsByProjectIdPermissionsBatch<ThrowOnError extends boolean = false>(options: Options$1<PostApiProjectsByProjectIdPermissionsBatchData, ThrowOnError>): RequestResult<PostApiProjectsByProjectIdPermissionsBatchResponses, PostApiProjectsByProjectIdPermissionsBatchErrors, ThrowOnError>;
|
|
2415
|
+
/**
|
|
2416
|
+
* Get permission change audit logs for a project
|
|
2417
|
+
*/
|
|
2418
|
+
getApiProjectsByProjectIdPermissionsAuditLogs<ThrowOnError extends boolean = false>(options: Options$1<GetApiProjectsByProjectIdPermissionsAuditLogsData, ThrowOnError>): RequestResult<GetApiProjectsByProjectIdPermissionsAuditLogsResponses, GetApiProjectsByProjectIdPermissionsAuditLogsErrors, ThrowOnError>;
|
|
2419
|
+
/**
|
|
2420
|
+
* Get a read-only permission summary for a machine
|
|
2421
|
+
*/
|
|
2422
|
+
getApiMachinesByIdPermissions<ThrowOnError extends boolean = false>(options: Options$1<GetApiMachinesByIdPermissionsData, ThrowOnError>): RequestResult<GetApiMachinesByIdPermissionsResponses, GetApiMachinesByIdPermissionsErrors, ThrowOnError>;
|
|
2423
|
+
/**
|
|
2424
|
+
* Assignable permission matrix for an owned machine (secrets the caller can see)
|
|
2425
|
+
*/
|
|
2426
|
+
getApiMachinesByIdPermissionsMatrix<ThrowOnError extends boolean = false>(options: Options$1<GetApiMachinesByIdPermissionsMatrixData, ThrowOnError>): RequestResult<GetApiMachinesByIdPermissionsMatrixResponses, GetApiMachinesByIdPermissionsMatrixErrors, ThrowOnError>;
|
|
2427
|
+
/**
|
|
2428
|
+
* Add/remove permissions on an owned machine, capped by secrets the caller can see
|
|
2429
|
+
*/
|
|
2430
|
+
postApiMachinesByIdPermissionsBatch<ThrowOnError extends boolean = false>(options: Options$1<PostApiMachinesByIdPermissionsBatchData, ThrowOnError>): RequestResult<PostApiMachinesByIdPermissionsBatchResponses, PostApiMachinesByIdPermissionsBatchErrors, ThrowOnError>;
|
|
2431
|
+
/**
|
|
2432
|
+
* Regenerate a machine ID (old ID invalidated immediately)
|
|
2433
|
+
*/
|
|
2434
|
+
postApiMachinesByIdRegenerate<ThrowOnError extends boolean = false>(options: Options$1<PostApiMachinesByIdRegenerateData, ThrowOnError>): RequestResult<PostApiMachinesByIdRegenerateResponses, PostApiMachinesByIdRegenerateErrors, ThrowOnError>;
|
|
2435
|
+
/**
|
|
2436
|
+
* Delete a machine (cascade permissions)
|
|
2437
|
+
*/
|
|
2438
|
+
deleteApiMachinesById<ThrowOnError extends boolean = false>(options: Options$1<DeleteApiMachinesByIdData, ThrowOnError>): RequestResult<DeleteApiMachinesByIdResponses, DeleteApiMachinesByIdErrors, ThrowOnError>;
|
|
2439
|
+
/**
|
|
2440
|
+
* Get a single machine by ID (masked)
|
|
2441
|
+
*/
|
|
2442
|
+
getApiMachinesById<ThrowOnError extends boolean = false>(options: Options$1<GetApiMachinesByIdData, ThrowOnError>): RequestResult<GetApiMachinesByIdResponses, GetApiMachinesByIdErrors, ThrowOnError>;
|
|
2443
|
+
/**
|
|
2444
|
+
* Rename a machine (name only)
|
|
2445
|
+
*/
|
|
2446
|
+
patchApiMachinesById<ThrowOnError extends boolean = false>(options: Options$1<PatchApiMachinesByIdData, ThrowOnError>): RequestResult<PatchApiMachinesByIdResponses, PatchApiMachinesByIdErrors, ThrowOnError>;
|
|
2447
|
+
/**
|
|
2448
|
+
* Bulk delete machines (cascade permissions)
|
|
2449
|
+
*/
|
|
2450
|
+
deleteApiMachines<ThrowOnError extends boolean = false>(options: Options$1<DeleteApiMachinesData, ThrowOnError>): RequestResult<DeleteApiMachinesResponses, DeleteApiMachinesErrors, ThrowOnError>;
|
|
2451
|
+
/**
|
|
2452
|
+
* List own machines (creator-scoped, masked IDs)
|
|
2453
|
+
*/
|
|
2454
|
+
getApiMachines<ThrowOnError extends boolean = false>(options?: Options$1<GetApiMachinesData, ThrowOnError>): RequestResult<GetApiMachinesResponses, GetApiMachinesErrors, ThrowOnError>;
|
|
2455
|
+
/**
|
|
2456
|
+
* Bulk update machine names
|
|
2457
|
+
*/
|
|
2458
|
+
patchApiMachines<ThrowOnError extends boolean = false>(options: Options$1<PatchApiMachinesData, ThrowOnError>): RequestResult<PatchApiMachinesResponses, PatchApiMachinesErrors, ThrowOnError>;
|
|
2459
|
+
/**
|
|
2460
|
+
* Create a new machine identity (rawId shown once)
|
|
2461
|
+
*/
|
|
2462
|
+
postApiMachines<ThrowOnError extends boolean = false>(options: Options$1<PostApiMachinesData, ThrowOnError>): RequestResult<PostApiMachinesResponses, PostApiMachinesErrors, ThrowOnError>;
|
|
2463
|
+
/**
|
|
2464
|
+
* Batch-get machines by IDs
|
|
2465
|
+
*/
|
|
2466
|
+
postApiMachinesQuery<ThrowOnError extends boolean = false>(options: Options$1<PostApiMachinesQueryData, ThrowOnError>): RequestResult<PostApiMachinesQueryResponses, PostApiMachinesQueryErrors, ThrowOnError>;
|
|
2467
|
+
/**
|
|
2468
|
+
* Clears the lumiblue-token HttpOnly cookie so the browser stops sending it on subsequent requests.
|
|
2469
|
+
*/
|
|
2470
|
+
deleteApiLumiblueToken<ThrowOnError extends boolean = false>(options?: Options$1<DeleteApiLumiblueTokenData, ThrowOnError>): RequestResult<DeleteApiLumiblueTokenResponses, unknown, ThrowOnError>;
|
|
2471
|
+
}
|
|
2472
|
+
/** Hey API client plus Identity helpers (logout, setApiKey, setToken, server list). */
|
|
2473
|
+
export type IdentityClient = Client$1 & {
|
|
2474
|
+
logout: () => Promise<void>;
|
|
2475
|
+
getAvailableServers: () => readonly string[];
|
|
2476
|
+
setApiKey: (key?: string) => void;
|
|
2477
|
+
setToken: (token?: string) => void;
|
|
2478
|
+
};
|
|
2479
|
+
/** Options for {@link createSdkClient}. */
|
|
2480
|
+
export type CreateSdkClientOptions = {
|
|
2481
|
+
/** API base URLs for failover (defaults to OpenAPI servers). */
|
|
2482
|
+
servers?: string[];
|
|
2483
|
+
/** Optional M2M API key applied at construction. */
|
|
2484
|
+
apiKey?: string;
|
|
2485
|
+
};
|
|
2486
|
+
/**
|
|
2487
|
+
* Creates an Identity HTTP client with multi-server failover, JWT refresh,
|
|
2488
|
+
* and optional M2M API-key auth. Each call gets isolated credential state.
|
|
2489
|
+
*
|
|
2490
|
+
* @param options - Optional servers and apiKey overrides.
|
|
2491
|
+
* @returns Augmented client usable with `new Sdk({ client })`.
|
|
2492
|
+
*/
|
|
2493
|
+
export declare function createSdkClient(options?: CreateSdkClientOptions): IdentityClient;
|
|
2494
|
+
/** Default shared client used by `new Sdk()` when no client is passed. */
|
|
2495
|
+
export declare const client: IdentityClient;
|
|
2496
|
+
|
|
2497
|
+
export {
|
|
2498
|
+
Options$1 as Options,
|
|
2499
|
+
};
|
|
2500
|
+
|
|
2501
|
+
export {};
|