@envsync-cloud/envsync-management-ts-sdk 0.8.5
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 +21 -0
- package/README.md +98 -0
- package/dist/index.d.mts +747 -0
- package/dist/index.d.ts +747 -0
- package/dist/index.js +1210 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +1163 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +59 -0
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,747 @@
|
|
|
1
|
+
type ApiRequestOptions = {
|
|
2
|
+
readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
|
|
3
|
+
readonly url: string;
|
|
4
|
+
readonly path?: Record<string, any>;
|
|
5
|
+
readonly cookies?: Record<string, any>;
|
|
6
|
+
readonly headers?: Record<string, any>;
|
|
7
|
+
readonly query?: Record<string, any>;
|
|
8
|
+
readonly formData?: Record<string, any>;
|
|
9
|
+
readonly body?: any;
|
|
10
|
+
readonly mediaType?: string;
|
|
11
|
+
readonly responseHeader?: string;
|
|
12
|
+
readonly errors?: Record<number, string>;
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
declare class CancelError extends Error {
|
|
16
|
+
constructor(message: string);
|
|
17
|
+
get isCancelled(): boolean;
|
|
18
|
+
}
|
|
19
|
+
interface OnCancel {
|
|
20
|
+
readonly isResolved: boolean;
|
|
21
|
+
readonly isRejected: boolean;
|
|
22
|
+
readonly isCancelled: boolean;
|
|
23
|
+
(cancelHandler: () => void): void;
|
|
24
|
+
}
|
|
25
|
+
declare class CancelablePromise<T> implements Promise<T> {
|
|
26
|
+
#private;
|
|
27
|
+
constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
|
|
28
|
+
get [Symbol.toStringTag](): string;
|
|
29
|
+
then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
|
|
30
|
+
catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
|
|
31
|
+
finally(onFinally?: (() => void) | null): Promise<T>;
|
|
32
|
+
cancel(): void;
|
|
33
|
+
get isCancelled(): boolean;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
|
|
37
|
+
type Headers = Record<string, string>;
|
|
38
|
+
type OpenAPIConfig = {
|
|
39
|
+
BASE: string;
|
|
40
|
+
VERSION: string;
|
|
41
|
+
WITH_CREDENTIALS: boolean;
|
|
42
|
+
CREDENTIALS: 'include' | 'omit' | 'same-origin';
|
|
43
|
+
TOKEN?: string | Resolver<string> | undefined;
|
|
44
|
+
USERNAME?: string | Resolver<string> | undefined;
|
|
45
|
+
PASSWORD?: string | Resolver<string> | undefined;
|
|
46
|
+
HEADERS?: Headers | Resolver<Headers> | undefined;
|
|
47
|
+
ENCODE_PATH?: ((path: string) => string) | undefined;
|
|
48
|
+
};
|
|
49
|
+
declare const OpenAPI: OpenAPIConfig;
|
|
50
|
+
|
|
51
|
+
declare abstract class BaseHttpRequest {
|
|
52
|
+
readonly config: OpenAPIConfig;
|
|
53
|
+
constructor(config: OpenAPIConfig);
|
|
54
|
+
abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
type CreateEnvTypeMappingRequest = {
|
|
58
|
+
env_type_id: string;
|
|
59
|
+
integration_binding_id: string;
|
|
60
|
+
target_identifier: string;
|
|
61
|
+
branch_ref?: string | null;
|
|
62
|
+
path_prefix?: string | null;
|
|
63
|
+
metadata?: Record<string, any>;
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
type CreateIntegrationBindingRequest = {
|
|
67
|
+
provider_connection_id: string;
|
|
68
|
+
provider_type: CreateIntegrationBindingRequest.provider_type;
|
|
69
|
+
is_enabled?: boolean;
|
|
70
|
+
metadata?: Record<string, any>;
|
|
71
|
+
};
|
|
72
|
+
declare namespace CreateIntegrationBindingRequest {
|
|
73
|
+
enum provider_type {
|
|
74
|
+
GITHUB = "github",
|
|
75
|
+
GITLAB = "gitlab",
|
|
76
|
+
AWS_SSM = "aws-ssm",
|
|
77
|
+
VERCEL = "vercel",
|
|
78
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
type CreateManualSyncRunRequest = {
|
|
83
|
+
app_id?: string | null;
|
|
84
|
+
provider_type: CreateManualSyncRunRequest.provider_type;
|
|
85
|
+
metadata?: Record<string, any>;
|
|
86
|
+
};
|
|
87
|
+
declare namespace CreateManualSyncRunRequest {
|
|
88
|
+
enum provider_type {
|
|
89
|
+
GITHUB = "github",
|
|
90
|
+
GITLAB = "gitlab",
|
|
91
|
+
AWS_SSM = "aws-ssm",
|
|
92
|
+
VERCEL = "vercel",
|
|
93
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
type CreateOrgSecretRequest = {
|
|
98
|
+
key: string;
|
|
99
|
+
value: string;
|
|
100
|
+
description?: string | null;
|
|
101
|
+
metadata?: Record<string, any>;
|
|
102
|
+
};
|
|
103
|
+
|
|
104
|
+
type CreateProviderConnectionRequest = {
|
|
105
|
+
provider_type: CreateProviderConnectionRequest.provider_type;
|
|
106
|
+
name: string;
|
|
107
|
+
status?: CreateProviderConnectionRequest.status;
|
|
108
|
+
auth_config?: Record<string, any>;
|
|
109
|
+
metadata?: Record<string, any>;
|
|
110
|
+
};
|
|
111
|
+
declare namespace CreateProviderConnectionRequest {
|
|
112
|
+
enum provider_type {
|
|
113
|
+
GITHUB = "github",
|
|
114
|
+
GITLAB = "gitlab",
|
|
115
|
+
AWS_SSM = "aws-ssm",
|
|
116
|
+
VERCEL = "vercel",
|
|
117
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
118
|
+
}
|
|
119
|
+
enum status {
|
|
120
|
+
ACTIVE = "active",
|
|
121
|
+
INACTIVE = "inactive",
|
|
122
|
+
ERROR = "error"
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
type EnterpriseProviderProfile = {
|
|
127
|
+
id: EnterpriseProviderProfile.id;
|
|
128
|
+
name: string;
|
|
129
|
+
scope: string;
|
|
130
|
+
description: string;
|
|
131
|
+
connection_requirements: Array<string>;
|
|
132
|
+
binding_metadata_fields: Array<string>;
|
|
133
|
+
mapping_requirements: Array<string>;
|
|
134
|
+
};
|
|
135
|
+
declare namespace EnterpriseProviderProfile {
|
|
136
|
+
enum id {
|
|
137
|
+
GITHUB = "github",
|
|
138
|
+
GITLAB = "gitlab",
|
|
139
|
+
AWS_SSM = "aws-ssm",
|
|
140
|
+
VERCEL = "vercel",
|
|
141
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
type EnterpriseProvidersResponse = {
|
|
146
|
+
providers: Array<EnterpriseProviderProfile>;
|
|
147
|
+
};
|
|
148
|
+
|
|
149
|
+
type EnvTypeMapping = {
|
|
150
|
+
id: string;
|
|
151
|
+
org_id: string;
|
|
152
|
+
app_id: string;
|
|
153
|
+
env_type_id: string;
|
|
154
|
+
integration_binding_id: string;
|
|
155
|
+
target_identifier: string;
|
|
156
|
+
branch_ref?: string | null;
|
|
157
|
+
path_prefix?: string | null;
|
|
158
|
+
metadata: Record<string, any>;
|
|
159
|
+
created_at: string;
|
|
160
|
+
updated_at: string;
|
|
161
|
+
};
|
|
162
|
+
|
|
163
|
+
type EnvTypeMappingsResponse = Array<EnvTypeMapping>;
|
|
164
|
+
|
|
165
|
+
type IntegrationBinding = {
|
|
166
|
+
id: string;
|
|
167
|
+
org_id: string;
|
|
168
|
+
app_id: string;
|
|
169
|
+
provider_connection_id: string;
|
|
170
|
+
provider_type: IntegrationBinding.provider_type;
|
|
171
|
+
is_enabled: boolean;
|
|
172
|
+
metadata: Record<string, any>;
|
|
173
|
+
created_at: string;
|
|
174
|
+
updated_at: string;
|
|
175
|
+
};
|
|
176
|
+
declare namespace IntegrationBinding {
|
|
177
|
+
enum provider_type {
|
|
178
|
+
GITHUB = "github",
|
|
179
|
+
GITLAB = "gitlab",
|
|
180
|
+
AWS_SSM = "aws-ssm",
|
|
181
|
+
VERCEL = "vercel",
|
|
182
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
type IntegrationBindingsResponse = Array<IntegrationBinding>;
|
|
187
|
+
|
|
188
|
+
type OrgSecret = {
|
|
189
|
+
id: string;
|
|
190
|
+
org_id: string;
|
|
191
|
+
key: string;
|
|
192
|
+
value: string;
|
|
193
|
+
description?: string | null;
|
|
194
|
+
metadata: Record<string, any>;
|
|
195
|
+
created_at: string;
|
|
196
|
+
updated_at: string;
|
|
197
|
+
};
|
|
198
|
+
|
|
199
|
+
type OrgSecretModelResponse = {
|
|
200
|
+
resource: string;
|
|
201
|
+
description: string;
|
|
202
|
+
fields: Array<string>;
|
|
203
|
+
};
|
|
204
|
+
|
|
205
|
+
type OrgSecretsResponse = Array<OrgSecret>;
|
|
206
|
+
|
|
207
|
+
type ProviderConnection = {
|
|
208
|
+
id: string;
|
|
209
|
+
org_id: string;
|
|
210
|
+
provider_type: ProviderConnection.provider_type;
|
|
211
|
+
name: string;
|
|
212
|
+
status: ProviderConnection.status;
|
|
213
|
+
auth_config: Record<string, any>;
|
|
214
|
+
metadata: Record<string, any>;
|
|
215
|
+
created_at: string;
|
|
216
|
+
updated_at: string;
|
|
217
|
+
};
|
|
218
|
+
declare namespace ProviderConnection {
|
|
219
|
+
enum provider_type {
|
|
220
|
+
GITHUB = "github",
|
|
221
|
+
GITLAB = "gitlab",
|
|
222
|
+
AWS_SSM = "aws-ssm",
|
|
223
|
+
VERCEL = "vercel",
|
|
224
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
225
|
+
}
|
|
226
|
+
enum status {
|
|
227
|
+
ACTIVE = "active",
|
|
228
|
+
INACTIVE = "inactive",
|
|
229
|
+
ERROR = "error"
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
type ProviderConnectionsResponse = Array<ProviderConnection>;
|
|
234
|
+
|
|
235
|
+
type SyncAuditEvent = {
|
|
236
|
+
id: string;
|
|
237
|
+
org_id: string;
|
|
238
|
+
sync_run_id?: string | null;
|
|
239
|
+
app_id?: string | null;
|
|
240
|
+
env_type_id?: string | null;
|
|
241
|
+
provider_type: SyncAuditEvent.provider_type;
|
|
242
|
+
action: string;
|
|
243
|
+
result: SyncAuditEvent.result;
|
|
244
|
+
actor_user_id?: string | null;
|
|
245
|
+
details: Record<string, any>;
|
|
246
|
+
created_at: string;
|
|
247
|
+
updated_at: string;
|
|
248
|
+
};
|
|
249
|
+
declare namespace SyncAuditEvent {
|
|
250
|
+
enum provider_type {
|
|
251
|
+
GITHUB = "github",
|
|
252
|
+
GITLAB = "gitlab",
|
|
253
|
+
AWS_SSM = "aws-ssm",
|
|
254
|
+
VERCEL = "vercel",
|
|
255
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
256
|
+
}
|
|
257
|
+
enum result {
|
|
258
|
+
INFO = "info",
|
|
259
|
+
SUCCESS = "success",
|
|
260
|
+
ERROR = "error"
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
type SyncAuditEventsResponse = Array<SyncAuditEvent>;
|
|
265
|
+
|
|
266
|
+
type SyncRun = {
|
|
267
|
+
id: string;
|
|
268
|
+
org_id: string;
|
|
269
|
+
app_id?: string | null;
|
|
270
|
+
provider_type: SyncRun.provider_type;
|
|
271
|
+
status: SyncRun.status;
|
|
272
|
+
actor_user_id?: string | null;
|
|
273
|
+
started_at: string;
|
|
274
|
+
completed_at?: string | null;
|
|
275
|
+
error_message?: string | null;
|
|
276
|
+
metadata: Record<string, any>;
|
|
277
|
+
created_at: string;
|
|
278
|
+
updated_at: string;
|
|
279
|
+
};
|
|
280
|
+
declare namespace SyncRun {
|
|
281
|
+
enum provider_type {
|
|
282
|
+
GITHUB = "github",
|
|
283
|
+
GITLAB = "gitlab",
|
|
284
|
+
AWS_SSM = "aws-ssm",
|
|
285
|
+
VERCEL = "vercel",
|
|
286
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
287
|
+
}
|
|
288
|
+
enum status {
|
|
289
|
+
PENDING = "pending",
|
|
290
|
+
RUNNING = "running",
|
|
291
|
+
SUCCEEDED = "succeeded",
|
|
292
|
+
FAILED = "failed"
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
type SyncRunsResponse = Array<SyncRun>;
|
|
297
|
+
|
|
298
|
+
type UpdateEnvTypeMappingRequest = {
|
|
299
|
+
target_identifier?: string;
|
|
300
|
+
branch_ref?: string | null;
|
|
301
|
+
path_prefix?: string | null;
|
|
302
|
+
metadata?: Record<string, any>;
|
|
303
|
+
};
|
|
304
|
+
|
|
305
|
+
type UpdateIntegrationBindingRequest = {
|
|
306
|
+
is_enabled?: boolean;
|
|
307
|
+
metadata?: Record<string, any>;
|
|
308
|
+
};
|
|
309
|
+
|
|
310
|
+
type UpdateOrgSecretRequest = {
|
|
311
|
+
value?: string;
|
|
312
|
+
description?: string | null;
|
|
313
|
+
metadata?: Record<string, any>;
|
|
314
|
+
};
|
|
315
|
+
|
|
316
|
+
type UpdateProviderConnectionRequest = {
|
|
317
|
+
name?: string;
|
|
318
|
+
status?: UpdateProviderConnectionRequest.status;
|
|
319
|
+
auth_config?: Record<string, any>;
|
|
320
|
+
metadata?: Record<string, any>;
|
|
321
|
+
};
|
|
322
|
+
declare namespace UpdateProviderConnectionRequest {
|
|
323
|
+
enum status {
|
|
324
|
+
ACTIVE = "active",
|
|
325
|
+
INACTIVE = "inactive",
|
|
326
|
+
ERROR = "error"
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
declare class EnterpriseService {
|
|
331
|
+
readonly httpRequest: BaseHttpRequest;
|
|
332
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
333
|
+
/**
|
|
334
|
+
* List Enterprise Providers
|
|
335
|
+
* @returns EnterpriseProvidersResponse Enterprise provider catalog
|
|
336
|
+
* @throws ApiError
|
|
337
|
+
*/
|
|
338
|
+
listEnterpriseProviders(): CancelablePromise<EnterpriseProvidersResponse>;
|
|
339
|
+
/**
|
|
340
|
+
* Get Enterprise Org Secret Model
|
|
341
|
+
* @returns OrgSecretModelResponse Org secret model
|
|
342
|
+
* @throws ApiError
|
|
343
|
+
*/
|
|
344
|
+
getEnterpriseOrgSecretModel(): CancelablePromise<OrgSecretModelResponse>;
|
|
345
|
+
/**
|
|
346
|
+
* List Enterprise Provider Connections
|
|
347
|
+
* @returns ProviderConnectionsResponse Provider connections
|
|
348
|
+
* @throws ApiError
|
|
349
|
+
*/
|
|
350
|
+
listEnterpriseProviderConnections(): CancelablePromise<ProviderConnectionsResponse>;
|
|
351
|
+
/**
|
|
352
|
+
* Create Enterprise Provider Connection
|
|
353
|
+
* @param requestBody
|
|
354
|
+
* @returns ProviderConnection Provider connection created
|
|
355
|
+
* @throws ApiError
|
|
356
|
+
*/
|
|
357
|
+
createEnterpriseProviderConnection(requestBody?: CreateProviderConnectionRequest): CancelablePromise<ProviderConnection>;
|
|
358
|
+
/**
|
|
359
|
+
* Update Enterprise Provider Connection
|
|
360
|
+
* @param id
|
|
361
|
+
* @param requestBody
|
|
362
|
+
* @returns ProviderConnection Provider connection updated
|
|
363
|
+
* @throws ApiError
|
|
364
|
+
*/
|
|
365
|
+
updateEnterpriseProviderConnection(id: string, requestBody?: UpdateProviderConnectionRequest): CancelablePromise<ProviderConnection>;
|
|
366
|
+
/**
|
|
367
|
+
* List Enterprise Org Secrets
|
|
368
|
+
* @returns OrgSecretsResponse Org secrets
|
|
369
|
+
* @throws ApiError
|
|
370
|
+
*/
|
|
371
|
+
listEnterpriseOrgSecrets(): CancelablePromise<OrgSecretsResponse>;
|
|
372
|
+
/**
|
|
373
|
+
* Create Enterprise Org Secret
|
|
374
|
+
* @param requestBody
|
|
375
|
+
* @returns OrgSecret Org secret created
|
|
376
|
+
* @throws ApiError
|
|
377
|
+
*/
|
|
378
|
+
createEnterpriseOrgSecret(requestBody?: CreateOrgSecretRequest): CancelablePromise<OrgSecret>;
|
|
379
|
+
/**
|
|
380
|
+
* Update Enterprise Org Secret
|
|
381
|
+
* @param id
|
|
382
|
+
* @param requestBody
|
|
383
|
+
* @returns OrgSecret Org secret updated
|
|
384
|
+
* @throws ApiError
|
|
385
|
+
*/
|
|
386
|
+
updateEnterpriseOrgSecret(id: string, requestBody?: UpdateOrgSecretRequest): CancelablePromise<OrgSecret>;
|
|
387
|
+
/**
|
|
388
|
+
* List Enterprise Integration Bindings
|
|
389
|
+
* @param appId
|
|
390
|
+
* @returns IntegrationBindingsResponse Integration bindings
|
|
391
|
+
* @throws ApiError
|
|
392
|
+
*/
|
|
393
|
+
listEnterpriseIntegrationBindings(appId: string): CancelablePromise<IntegrationBindingsResponse>;
|
|
394
|
+
/**
|
|
395
|
+
* Create Enterprise Integration Binding
|
|
396
|
+
* @param appId
|
|
397
|
+
* @param requestBody
|
|
398
|
+
* @returns IntegrationBinding Integration binding created
|
|
399
|
+
* @throws ApiError
|
|
400
|
+
*/
|
|
401
|
+
createEnterpriseIntegrationBinding(appId: string, requestBody?: CreateIntegrationBindingRequest): CancelablePromise<IntegrationBinding>;
|
|
402
|
+
/**
|
|
403
|
+
* Update Enterprise Integration Binding
|
|
404
|
+
* @param appId
|
|
405
|
+
* @param id
|
|
406
|
+
* @param requestBody
|
|
407
|
+
* @returns IntegrationBinding Integration binding updated
|
|
408
|
+
* @throws ApiError
|
|
409
|
+
*/
|
|
410
|
+
updateEnterpriseIntegrationBinding(appId: string, id: string, requestBody?: UpdateIntegrationBindingRequest): CancelablePromise<IntegrationBinding>;
|
|
411
|
+
/**
|
|
412
|
+
* List Enterprise Env-Type Mappings
|
|
413
|
+
* @param appId
|
|
414
|
+
* @returns EnvTypeMappingsResponse Env-type mappings
|
|
415
|
+
* @throws ApiError
|
|
416
|
+
*/
|
|
417
|
+
listEnterpriseEnvTypeMappings(appId: string): CancelablePromise<EnvTypeMappingsResponse>;
|
|
418
|
+
/**
|
|
419
|
+
* Create Enterprise Env-Type Mapping
|
|
420
|
+
* @param appId
|
|
421
|
+
* @param requestBody
|
|
422
|
+
* @returns EnvTypeMapping Env-type mapping created
|
|
423
|
+
* @throws ApiError
|
|
424
|
+
*/
|
|
425
|
+
createEnterpriseEnvTypeMapping(appId: string, requestBody?: CreateEnvTypeMappingRequest): CancelablePromise<EnvTypeMapping>;
|
|
426
|
+
/**
|
|
427
|
+
* Update Enterprise Env-Type Mapping
|
|
428
|
+
* @param appId
|
|
429
|
+
* @param id
|
|
430
|
+
* @param requestBody
|
|
431
|
+
* @returns EnvTypeMapping Env-type mapping updated
|
|
432
|
+
* @throws ApiError
|
|
433
|
+
*/
|
|
434
|
+
updateEnterpriseEnvTypeMapping(appId: string, id: string, requestBody?: UpdateEnvTypeMappingRequest): CancelablePromise<EnvTypeMapping>;
|
|
435
|
+
/**
|
|
436
|
+
* List Enterprise Sync Runs
|
|
437
|
+
* @returns SyncRunsResponse Sync runs
|
|
438
|
+
* @throws ApiError
|
|
439
|
+
*/
|
|
440
|
+
listEnterpriseSyncRuns(): CancelablePromise<SyncRunsResponse>;
|
|
441
|
+
/**
|
|
442
|
+
* Create Enterprise Manual Sync Run
|
|
443
|
+
* @param requestBody
|
|
444
|
+
* @returns SyncRun Sync run created
|
|
445
|
+
* @throws ApiError
|
|
446
|
+
*/
|
|
447
|
+
createEnterpriseManualSyncRun(requestBody?: CreateManualSyncRunRequest): CancelablePromise<SyncRun>;
|
|
448
|
+
/**
|
|
449
|
+
* List Enterprise Sync Audit Events
|
|
450
|
+
* @param syncRunId
|
|
451
|
+
* @returns SyncAuditEventsResponse Sync audit events
|
|
452
|
+
* @throws ApiError
|
|
453
|
+
*/
|
|
454
|
+
listEnterpriseSyncAuditEvents(syncRunId: string): CancelablePromise<SyncAuditEventsResponse>;
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
type LicenseState = {
|
|
458
|
+
status: LicenseState.status;
|
|
459
|
+
lease_expires_at?: string | null;
|
|
460
|
+
last_verified_at?: string | null;
|
|
461
|
+
last_error_code?: string | null;
|
|
462
|
+
last_error_message?: string | null;
|
|
463
|
+
};
|
|
464
|
+
declare namespace LicenseState {
|
|
465
|
+
enum status {
|
|
466
|
+
UNKNOWN = "unknown",
|
|
467
|
+
ACTIVE = "active",
|
|
468
|
+
INACTIVE = "inactive",
|
|
469
|
+
EXPIRED = "expired",
|
|
470
|
+
ERROR = "error",
|
|
471
|
+
LOCKED = "locked"
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
type LicenseActionResponse = {
|
|
476
|
+
message: string;
|
|
477
|
+
state: LicenseState;
|
|
478
|
+
};
|
|
479
|
+
|
|
480
|
+
type LicenseStatusResponse = {
|
|
481
|
+
required: boolean;
|
|
482
|
+
locked: boolean;
|
|
483
|
+
reason?: string | null;
|
|
484
|
+
state: LicenseState;
|
|
485
|
+
};
|
|
486
|
+
|
|
487
|
+
declare class LicenseService {
|
|
488
|
+
readonly httpRequest: BaseHttpRequest;
|
|
489
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
490
|
+
/**
|
|
491
|
+
* Get Management License Status
|
|
492
|
+
* @returns LicenseStatusResponse Current license status
|
|
493
|
+
* @throws ApiError
|
|
494
|
+
*/
|
|
495
|
+
getManagementLicenseStatus(): CancelablePromise<LicenseStatusResponse>;
|
|
496
|
+
/**
|
|
497
|
+
* Activate Management License
|
|
498
|
+
* @returns LicenseActionResponse License activated
|
|
499
|
+
* @throws ApiError
|
|
500
|
+
*/
|
|
501
|
+
activateManagementLicense(): CancelablePromise<LicenseActionResponse>;
|
|
502
|
+
/**
|
|
503
|
+
* Verify Management License
|
|
504
|
+
* @returns LicenseActionResponse License verified
|
|
505
|
+
* @throws ApiError
|
|
506
|
+
*/
|
|
507
|
+
verifyManagementLicense(): CancelablePromise<LicenseActionResponse>;
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
type AcceptOrgInviteRequest = {
|
|
511
|
+
org_data: {
|
|
512
|
+
name: string;
|
|
513
|
+
size: string;
|
|
514
|
+
website: string;
|
|
515
|
+
};
|
|
516
|
+
user_data: {
|
|
517
|
+
full_name: string;
|
|
518
|
+
password: string;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
|
|
522
|
+
type AcceptOrgInviteResponse = {
|
|
523
|
+
message: string;
|
|
524
|
+
generated_certificate_bundle: {
|
|
525
|
+
root_ca_pem: string;
|
|
526
|
+
member_cert_pem: string;
|
|
527
|
+
member_key_pem: string;
|
|
528
|
+
member_certificate_id: string;
|
|
529
|
+
member_serial_hex: string;
|
|
530
|
+
is_system_generated: boolean;
|
|
531
|
+
};
|
|
532
|
+
};
|
|
533
|
+
|
|
534
|
+
type AcceptUserInviteRequest = {
|
|
535
|
+
full_name: string;
|
|
536
|
+
password: string;
|
|
537
|
+
};
|
|
538
|
+
|
|
539
|
+
type AcceptUserInviteResponse = {
|
|
540
|
+
message: string;
|
|
541
|
+
generated_certificate_bundle: {
|
|
542
|
+
root_ca_pem: string;
|
|
543
|
+
member_cert_pem: string;
|
|
544
|
+
member_key_pem: string;
|
|
545
|
+
member_certificate_id: string;
|
|
546
|
+
member_serial_hex: string;
|
|
547
|
+
is_system_generated: boolean;
|
|
548
|
+
};
|
|
549
|
+
};
|
|
550
|
+
|
|
551
|
+
type CreateOrgInviteRequest = {
|
|
552
|
+
email: string;
|
|
553
|
+
};
|
|
554
|
+
|
|
555
|
+
type CreateOrgInviteResponse = {
|
|
556
|
+
message: string;
|
|
557
|
+
};
|
|
558
|
+
|
|
559
|
+
type CreateUserInviteRequest = {
|
|
560
|
+
email: string;
|
|
561
|
+
role_id: string;
|
|
562
|
+
};
|
|
563
|
+
|
|
564
|
+
type CreateUserInviteResponse = {
|
|
565
|
+
message: string;
|
|
566
|
+
};
|
|
567
|
+
|
|
568
|
+
type DeleteUserInviteResponse = {
|
|
569
|
+
message: string;
|
|
570
|
+
};
|
|
571
|
+
|
|
572
|
+
type GetOrgInviteByCodeResponse = {
|
|
573
|
+
invite: {
|
|
574
|
+
id: string;
|
|
575
|
+
email: string;
|
|
576
|
+
invite_token: string;
|
|
577
|
+
is_accepted: boolean;
|
|
578
|
+
created_at: string;
|
|
579
|
+
updated_at: string;
|
|
580
|
+
};
|
|
581
|
+
};
|
|
582
|
+
|
|
583
|
+
type GetUserInviteByTokenResponse = {
|
|
584
|
+
invite: {
|
|
585
|
+
id: string;
|
|
586
|
+
email: string;
|
|
587
|
+
invite_token: string;
|
|
588
|
+
role_id: string;
|
|
589
|
+
org_id: string;
|
|
590
|
+
is_accepted: boolean;
|
|
591
|
+
created_at: string;
|
|
592
|
+
updated_at: string;
|
|
593
|
+
};
|
|
594
|
+
};
|
|
595
|
+
|
|
596
|
+
type UpdateUserInviteRequest = {
|
|
597
|
+
role_id: string;
|
|
598
|
+
};
|
|
599
|
+
|
|
600
|
+
type UpdateUserInviteResponse = {
|
|
601
|
+
message: string;
|
|
602
|
+
};
|
|
603
|
+
|
|
604
|
+
declare class OnboardingService {
|
|
605
|
+
readonly httpRequest: BaseHttpRequest;
|
|
606
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
607
|
+
/**
|
|
608
|
+
* Create Organization Invite
|
|
609
|
+
* Create an organization invite
|
|
610
|
+
* @param requestBody
|
|
611
|
+
* @returns CreateOrgInviteResponse Successful greeting response
|
|
612
|
+
* @throws ApiError
|
|
613
|
+
*/
|
|
614
|
+
createOrgInvite(requestBody?: CreateOrgInviteRequest): CancelablePromise<CreateOrgInviteResponse>;
|
|
615
|
+
/**
|
|
616
|
+
* Get Organization Invite by Code
|
|
617
|
+
* Get organization invite by code
|
|
618
|
+
* @param inviteCode
|
|
619
|
+
* @returns GetOrgInviteByCodeResponse Organization invite retrieved successfully
|
|
620
|
+
* @throws ApiError
|
|
621
|
+
*/
|
|
622
|
+
getOrgInviteByCode(inviteCode: string): CancelablePromise<GetOrgInviteByCodeResponse>;
|
|
623
|
+
/**
|
|
624
|
+
* Accept Organization Invite
|
|
625
|
+
* Accept organization invite
|
|
626
|
+
* @param inviteCode
|
|
627
|
+
* @param requestBody
|
|
628
|
+
* @returns AcceptOrgInviteResponse Organization invite accepted successfully
|
|
629
|
+
* @throws ApiError
|
|
630
|
+
*/
|
|
631
|
+
acceptOrgInvite(inviteCode: string, requestBody?: AcceptOrgInviteRequest): CancelablePromise<AcceptOrgInviteResponse>;
|
|
632
|
+
/**
|
|
633
|
+
* Get User Invite by Code
|
|
634
|
+
* Get user invite by code
|
|
635
|
+
* @param inviteCode
|
|
636
|
+
* @returns GetUserInviteByTokenResponse User invite retrieved successfully
|
|
637
|
+
* @throws ApiError
|
|
638
|
+
*/
|
|
639
|
+
getUserInviteByCode(inviteCode: string): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
640
|
+
/**
|
|
641
|
+
* Update User Invite
|
|
642
|
+
* Update user invite
|
|
643
|
+
* @param inviteCode
|
|
644
|
+
* @param requestBody
|
|
645
|
+
* @returns UpdateUserInviteResponse User invite updated successfully
|
|
646
|
+
* @throws ApiError
|
|
647
|
+
*/
|
|
648
|
+
updateUserInvite(inviteCode: string, requestBody?: UpdateUserInviteRequest): CancelablePromise<UpdateUserInviteResponse>;
|
|
649
|
+
/**
|
|
650
|
+
* Accept User Invite
|
|
651
|
+
* Accept user invite
|
|
652
|
+
* @param inviteCode
|
|
653
|
+
* @param requestBody
|
|
654
|
+
* @returns AcceptUserInviteResponse User invite accepted successfully
|
|
655
|
+
* @throws ApiError
|
|
656
|
+
*/
|
|
657
|
+
acceptUserInvite(inviteCode: string, requestBody?: AcceptUserInviteRequest): CancelablePromise<AcceptUserInviteResponse>;
|
|
658
|
+
/**
|
|
659
|
+
* Create User Invite
|
|
660
|
+
* Create a user invite
|
|
661
|
+
* @param requestBody
|
|
662
|
+
* @returns CreateUserInviteResponse User invite created successfully
|
|
663
|
+
* @throws ApiError
|
|
664
|
+
*/
|
|
665
|
+
createUserInvite(requestBody?: CreateUserInviteRequest): CancelablePromise<CreateUserInviteResponse>;
|
|
666
|
+
/**
|
|
667
|
+
* Get All User Invites
|
|
668
|
+
* Get all user invites
|
|
669
|
+
* @returns GetUserInviteByTokenResponse User invites retrieved successfully
|
|
670
|
+
* @throws ApiError
|
|
671
|
+
*/
|
|
672
|
+
getAllUserInvites(): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
673
|
+
/**
|
|
674
|
+
* Delete User Invite
|
|
675
|
+
* Delete user invite
|
|
676
|
+
* @param inviteId
|
|
677
|
+
* @returns DeleteUserInviteResponse User invite deleted successfully
|
|
678
|
+
* @throws ApiError
|
|
679
|
+
*/
|
|
680
|
+
deleteUserInvite(inviteId: string): CancelablePromise<DeleteUserInviteResponse>;
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
type SystemStatusState = {
|
|
684
|
+
edition: SystemStatusState.edition;
|
|
685
|
+
single_org_mode: boolean;
|
|
686
|
+
management_enabled: boolean;
|
|
687
|
+
observability_enabled: boolean;
|
|
688
|
+
management_web_enabled: boolean;
|
|
689
|
+
landing_enabled: boolean;
|
|
690
|
+
first_bootstrap_completed_at?: string | null;
|
|
691
|
+
org_count: number;
|
|
692
|
+
};
|
|
693
|
+
declare namespace SystemStatusState {
|
|
694
|
+
enum edition {
|
|
695
|
+
OSS = "oss",
|
|
696
|
+
ENTERPRISE = "enterprise"
|
|
697
|
+
}
|
|
698
|
+
}
|
|
699
|
+
|
|
700
|
+
type SystemStatusResponse = {
|
|
701
|
+
system: SystemStatusState;
|
|
702
|
+
license: LicenseStatusResponse;
|
|
703
|
+
};
|
|
704
|
+
|
|
705
|
+
declare class SystemService {
|
|
706
|
+
readonly httpRequest: BaseHttpRequest;
|
|
707
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
708
|
+
/**
|
|
709
|
+
* Get Management System Status
|
|
710
|
+
* @returns SystemStatusResponse Management system status
|
|
711
|
+
* @throws ApiError
|
|
712
|
+
*/
|
|
713
|
+
getManagementSystemStatus(): CancelablePromise<SystemStatusResponse>;
|
|
714
|
+
}
|
|
715
|
+
|
|
716
|
+
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
717
|
+
declare class EnvSyncManagementAPISDK {
|
|
718
|
+
readonly enterprise: EnterpriseService;
|
|
719
|
+
readonly license: LicenseService;
|
|
720
|
+
readonly onboarding: OnboardingService;
|
|
721
|
+
readonly system: SystemService;
|
|
722
|
+
readonly request: BaseHttpRequest;
|
|
723
|
+
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
724
|
+
}
|
|
725
|
+
|
|
726
|
+
type ApiResult = {
|
|
727
|
+
readonly url: string;
|
|
728
|
+
readonly ok: boolean;
|
|
729
|
+
readonly status: number;
|
|
730
|
+
readonly statusText: string;
|
|
731
|
+
readonly body: any;
|
|
732
|
+
};
|
|
733
|
+
|
|
734
|
+
declare class ApiError extends Error {
|
|
735
|
+
readonly url: string;
|
|
736
|
+
readonly status: number;
|
|
737
|
+
readonly statusText: string;
|
|
738
|
+
readonly body: any;
|
|
739
|
+
readonly request: ApiRequestOptions;
|
|
740
|
+
constructor(request: ApiRequestOptions, response: ApiResult, message: string);
|
|
741
|
+
}
|
|
742
|
+
|
|
743
|
+
type ErrorResponse = {
|
|
744
|
+
error: string;
|
|
745
|
+
};
|
|
746
|
+
|
|
747
|
+
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, ApiError, BaseHttpRequest, CancelError, CancelablePromise, type CreateEnvTypeMappingRequest, CreateIntegrationBindingRequest, CreateManualSyncRunRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateOrgSecretRequest, CreateProviderConnectionRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteUserInviteResponse, EnterpriseProviderProfile, type EnterpriseProvidersResponse, EnterpriseService, EnvSyncManagementAPISDK, type EnvTypeMapping, type EnvTypeMappingsResponse, type ErrorResponse, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, IntegrationBinding, type IntegrationBindingsResponse, type LicenseActionResponse, LicenseService, LicenseState, type LicenseStatusResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgSecret, type OrgSecretModelResponse, type OrgSecretsResponse, ProviderConnection, type ProviderConnectionsResponse, SyncAuditEvent, type SyncAuditEventsResponse, SyncRun, type SyncRunsResponse, SystemService, type SystemStatusResponse, SystemStatusState, type UpdateEnvTypeMappingRequest, type UpdateIntegrationBindingRequest, type UpdateOrgSecretRequest, UpdateProviderConnectionRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse };
|