@epilot/blueprint-manifest-client 2.11.0 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +266 -1
- package/dist/openapi.d.ts +1091 -37
- package/dist/openapi.json +1252 -5
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -21,7 +21,76 @@ declare namespace Components {
|
|
|
21
21
|
JobID?: Parameters.JobID;
|
|
22
22
|
}
|
|
23
23
|
namespace Schemas {
|
|
24
|
+
export interface AppBlueprint {
|
|
25
|
+
id?: /**
|
|
26
|
+
* ID of a blueprint
|
|
27
|
+
* example:
|
|
28
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
29
|
+
*/
|
|
30
|
+
BlueprintID;
|
|
31
|
+
title: string;
|
|
32
|
+
slug?: string;
|
|
33
|
+
description?: {
|
|
34
|
+
/**
|
|
35
|
+
* Markdown content shown before starting to install the blueprint
|
|
36
|
+
* example:
|
|
37
|
+
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
38
|
+
*
|
|
39
|
+
*/
|
|
40
|
+
preinstall?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Markdown content to be displayed when showing the plan to install blueprint
|
|
43
|
+
* example:
|
|
44
|
+
* This is the content of the postinstall.md file
|
|
45
|
+
*
|
|
46
|
+
*/
|
|
47
|
+
postinstall?: string;
|
|
48
|
+
};
|
|
49
|
+
version?: string;
|
|
50
|
+
created_at?: string; // date-time
|
|
51
|
+
updated_at?: string; // date-time
|
|
52
|
+
created_by?: CallerIdentity;
|
|
53
|
+
updated_by?: CallerIdentity;
|
|
54
|
+
/**
|
|
55
|
+
* Whether the blueprint is verified by epilot
|
|
56
|
+
*/
|
|
57
|
+
is_verified?: boolean;
|
|
58
|
+
source_type: "app";
|
|
59
|
+
resources?: InstalledBlueprintResource[];
|
|
60
|
+
}
|
|
61
|
+
export type Blueprint = CustomBlueprint | FileBlueprint | MarketplaceBlueprint | DeployedBlueprint | AppBlueprint;
|
|
62
|
+
/**
|
|
63
|
+
* ID of a blueprint
|
|
64
|
+
* example:
|
|
65
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
66
|
+
*/
|
|
67
|
+
export type BlueprintID = string;
|
|
24
68
|
export type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED";
|
|
69
|
+
export interface BlueprintResource {
|
|
70
|
+
id: /**
|
|
71
|
+
* ID of a blueprint resource
|
|
72
|
+
* example:
|
|
73
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
74
|
+
*/
|
|
75
|
+
BlueprintResourceID;
|
|
76
|
+
name?: string;
|
|
77
|
+
type: /* Type of the resource */ ResourceNodeType;
|
|
78
|
+
address?: string;
|
|
79
|
+
/**
|
|
80
|
+
* When a resource is marked as root, we'll be able to keep track of it's dependencies
|
|
81
|
+
*/
|
|
82
|
+
is_root?: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* on EditableBlueprintResources, this indicates if the resource is ready to be exported and on InstalledBlueprintResources, this indicates if the resource is ready to be used
|
|
85
|
+
*/
|
|
86
|
+
is_ready?: boolean;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* ID of a blueprint resource
|
|
90
|
+
* example:
|
|
91
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
92
|
+
*/
|
|
93
|
+
export type BlueprintResourceID = string;
|
|
25
94
|
export interface CallerIdentity {
|
|
26
95
|
/**
|
|
27
96
|
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
@@ -48,6 +117,37 @@ declare namespace Components {
|
|
|
48
117
|
*/
|
|
49
118
|
token_id?: string;
|
|
50
119
|
}
|
|
120
|
+
export interface CommonBlueprintFields {
|
|
121
|
+
id?: /**
|
|
122
|
+
* ID of a blueprint
|
|
123
|
+
* example:
|
|
124
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
125
|
+
*/
|
|
126
|
+
BlueprintID;
|
|
127
|
+
title: string;
|
|
128
|
+
slug?: string;
|
|
129
|
+
description?: {
|
|
130
|
+
/**
|
|
131
|
+
* Markdown content shown before starting to install the blueprint
|
|
132
|
+
* example:
|
|
133
|
+
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
134
|
+
*
|
|
135
|
+
*/
|
|
136
|
+
preinstall?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Markdown content to be displayed when showing the plan to install blueprint
|
|
139
|
+
* example:
|
|
140
|
+
* This is the content of the postinstall.md file
|
|
141
|
+
*
|
|
142
|
+
*/
|
|
143
|
+
postinstall?: string;
|
|
144
|
+
};
|
|
145
|
+
version?: string;
|
|
146
|
+
created_at?: string; // date-time
|
|
147
|
+
updated_at?: string; // date-time
|
|
148
|
+
created_by?: CallerIdentity;
|
|
149
|
+
updated_by?: CallerIdentity;
|
|
150
|
+
}
|
|
51
151
|
export interface CommonImportFields {
|
|
52
152
|
source_type?: ManifestSource;
|
|
53
153
|
/**
|
|
@@ -213,6 +313,132 @@ declare namespace Components {
|
|
|
213
313
|
*/
|
|
214
314
|
is_virtual?: boolean;
|
|
215
315
|
}
|
|
316
|
+
export interface CustomBlueprint {
|
|
317
|
+
id?: /**
|
|
318
|
+
* ID of a blueprint
|
|
319
|
+
* example:
|
|
320
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
321
|
+
*/
|
|
322
|
+
BlueprintID;
|
|
323
|
+
title: string;
|
|
324
|
+
slug?: string;
|
|
325
|
+
description?: {
|
|
326
|
+
/**
|
|
327
|
+
* Markdown content shown before starting to install the blueprint
|
|
328
|
+
* example:
|
|
329
|
+
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
330
|
+
*
|
|
331
|
+
*/
|
|
332
|
+
preinstall?: string;
|
|
333
|
+
/**
|
|
334
|
+
* Markdown content to be displayed when showing the plan to install blueprint
|
|
335
|
+
* example:
|
|
336
|
+
* This is the content of the postinstall.md file
|
|
337
|
+
*
|
|
338
|
+
*/
|
|
339
|
+
postinstall?: string;
|
|
340
|
+
};
|
|
341
|
+
version?: string;
|
|
342
|
+
created_at?: string; // date-time
|
|
343
|
+
updated_at?: string; // date-time
|
|
344
|
+
created_by?: CallerIdentity;
|
|
345
|
+
updated_by?: CallerIdentity;
|
|
346
|
+
resources?: EditableBlueprintResource[];
|
|
347
|
+
source_type: "custom";
|
|
348
|
+
}
|
|
349
|
+
export interface DeployedBlueprint {
|
|
350
|
+
id?: /**
|
|
351
|
+
* ID of a blueprint
|
|
352
|
+
* example:
|
|
353
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
354
|
+
*/
|
|
355
|
+
BlueprintID;
|
|
356
|
+
title: string;
|
|
357
|
+
slug?: string;
|
|
358
|
+
description?: {
|
|
359
|
+
/**
|
|
360
|
+
* Markdown content shown before starting to install the blueprint
|
|
361
|
+
* example:
|
|
362
|
+
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
363
|
+
*
|
|
364
|
+
*/
|
|
365
|
+
preinstall?: string;
|
|
366
|
+
/**
|
|
367
|
+
* Markdown content to be displayed when showing the plan to install blueprint
|
|
368
|
+
* example:
|
|
369
|
+
* This is the content of the postinstall.md file
|
|
370
|
+
*
|
|
371
|
+
*/
|
|
372
|
+
postinstall?: string;
|
|
373
|
+
};
|
|
374
|
+
version?: string;
|
|
375
|
+
created_at?: string; // date-time
|
|
376
|
+
updated_at?: string; // date-time
|
|
377
|
+
created_by?: CallerIdentity;
|
|
378
|
+
updated_by?: CallerIdentity;
|
|
379
|
+
source_type: "deploy";
|
|
380
|
+
resources?: InstalledBlueprintResource[];
|
|
381
|
+
}
|
|
382
|
+
export interface EditableBlueprintResource {
|
|
383
|
+
id: /**
|
|
384
|
+
* ID of a blueprint resource
|
|
385
|
+
* example:
|
|
386
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
387
|
+
*/
|
|
388
|
+
BlueprintResourceID;
|
|
389
|
+
name?: string;
|
|
390
|
+
type: /* Type of the resource */ ResourceNodeType;
|
|
391
|
+
address?: string;
|
|
392
|
+
/**
|
|
393
|
+
* When a resource is marked as root, we'll be able to keep track of it's dependencies
|
|
394
|
+
*/
|
|
395
|
+
is_root?: boolean;
|
|
396
|
+
/**
|
|
397
|
+
* on EditableBlueprintResources, this indicates if the resource is ready to be exported and on InstalledBlueprintResources, this indicates if the resource is ready to be used
|
|
398
|
+
*/
|
|
399
|
+
is_ready?: boolean;
|
|
400
|
+
/**
|
|
401
|
+
* An internal note to help remember what's missing to export the resource
|
|
402
|
+
*/
|
|
403
|
+
note?: string;
|
|
404
|
+
}
|
|
405
|
+
export interface FileBlueprint {
|
|
406
|
+
id?: /**
|
|
407
|
+
* ID of a blueprint
|
|
408
|
+
* example:
|
|
409
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
410
|
+
*/
|
|
411
|
+
BlueprintID;
|
|
412
|
+
title: string;
|
|
413
|
+
slug?: string;
|
|
414
|
+
description?: {
|
|
415
|
+
/**
|
|
416
|
+
* Markdown content shown before starting to install the blueprint
|
|
417
|
+
* example:
|
|
418
|
+
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
419
|
+
*
|
|
420
|
+
*/
|
|
421
|
+
preinstall?: string;
|
|
422
|
+
/**
|
|
423
|
+
* Markdown content to be displayed when showing the plan to install blueprint
|
|
424
|
+
* example:
|
|
425
|
+
* This is the content of the postinstall.md file
|
|
426
|
+
*
|
|
427
|
+
*/
|
|
428
|
+
postinstall?: string;
|
|
429
|
+
};
|
|
430
|
+
version?: string;
|
|
431
|
+
created_at?: string; // date-time
|
|
432
|
+
updated_at?: string; // date-time
|
|
433
|
+
created_by?: CallerIdentity;
|
|
434
|
+
updated_by?: CallerIdentity;
|
|
435
|
+
/**
|
|
436
|
+
* Whether the blueprint is verified by epilot
|
|
437
|
+
*/
|
|
438
|
+
is_verified?: boolean;
|
|
439
|
+
source_type: "file";
|
|
440
|
+
resources?: InstalledBlueprintResource[];
|
|
441
|
+
}
|
|
216
442
|
export interface FormattedError {
|
|
217
443
|
error?: string | {
|
|
218
444
|
[key: string]: any;
|
|
@@ -228,6 +454,67 @@ declare namespace Components {
|
|
|
228
454
|
type?: string;
|
|
229
455
|
};
|
|
230
456
|
}
|
|
457
|
+
export interface InstallationJob {
|
|
458
|
+
id?: /**
|
|
459
|
+
* ID of an installation job
|
|
460
|
+
* example:
|
|
461
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
462
|
+
*/
|
|
463
|
+
InstallationJobID;
|
|
464
|
+
source_blueprint_id?: /**
|
|
465
|
+
* ID of a blueprint
|
|
466
|
+
* example:
|
|
467
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
468
|
+
*/
|
|
469
|
+
BlueprintID;
|
|
470
|
+
source_blueprint_type?: "file" | "marketplace" | "deploy" | "app";
|
|
471
|
+
source_org_id?: string;
|
|
472
|
+
destination_blueprint_id?: /**
|
|
473
|
+
* ID of a blueprint
|
|
474
|
+
* example:
|
|
475
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
476
|
+
*/
|
|
477
|
+
BlueprintID;
|
|
478
|
+
destination_org_id?: string;
|
|
479
|
+
status?: "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
|
|
480
|
+
triggered_at?: string; // date-time
|
|
481
|
+
created_by?: CallerIdentity;
|
|
482
|
+
updated_by?: CallerIdentity;
|
|
483
|
+
}
|
|
484
|
+
export interface InstallationJobEvent {
|
|
485
|
+
timestamp?: string; // date-time
|
|
486
|
+
message?: string;
|
|
487
|
+
level?: "info" | "warning" | "error";
|
|
488
|
+
data?: {
|
|
489
|
+
[name: string]: any;
|
|
490
|
+
};
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* ID of an installation job
|
|
494
|
+
* example:
|
|
495
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
496
|
+
*/
|
|
497
|
+
export type InstallationJobID = string;
|
|
498
|
+
export interface InstalledBlueprintResource {
|
|
499
|
+
id: /**
|
|
500
|
+
* ID of a blueprint resource
|
|
501
|
+
* example:
|
|
502
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
503
|
+
*/
|
|
504
|
+
BlueprintResourceID;
|
|
505
|
+
name?: string;
|
|
506
|
+
type: /* Type of the resource */ ResourceNodeType;
|
|
507
|
+
address?: string;
|
|
508
|
+
/**
|
|
509
|
+
* When a resource is marked as root, we'll be able to keep track of it's dependencies
|
|
510
|
+
*/
|
|
511
|
+
is_root?: boolean;
|
|
512
|
+
/**
|
|
513
|
+
* on EditableBlueprintResources, this indicates if the resource is ready to be exported and on InstalledBlueprintResources, this indicates if the resource is ready to be used
|
|
514
|
+
*/
|
|
515
|
+
is_ready?: boolean;
|
|
516
|
+
impact_on_install?: "create" | "update" | "no-op" | "delete";
|
|
517
|
+
}
|
|
231
518
|
export interface Job {
|
|
232
519
|
job_id?: /**
|
|
233
520
|
* ID of an import or export job (state machine)
|
|
@@ -704,6 +991,47 @@ declare namespace Components {
|
|
|
704
991
|
*/
|
|
705
992
|
updated_at?: string; // date-time
|
|
706
993
|
}
|
|
994
|
+
export interface MarketplaceBlueprint {
|
|
995
|
+
id?: /**
|
|
996
|
+
* ID of a blueprint
|
|
997
|
+
* example:
|
|
998
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
999
|
+
*/
|
|
1000
|
+
BlueprintID;
|
|
1001
|
+
title: string;
|
|
1002
|
+
slug?: string;
|
|
1003
|
+
description?: {
|
|
1004
|
+
/**
|
|
1005
|
+
* Markdown content shown before starting to install the blueprint
|
|
1006
|
+
* example:
|
|
1007
|
+
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
1008
|
+
*
|
|
1009
|
+
*/
|
|
1010
|
+
preinstall?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* Markdown content to be displayed when showing the plan to install blueprint
|
|
1013
|
+
* example:
|
|
1014
|
+
* This is the content of the postinstall.md file
|
|
1015
|
+
*
|
|
1016
|
+
*/
|
|
1017
|
+
postinstall?: string;
|
|
1018
|
+
};
|
|
1019
|
+
version?: string;
|
|
1020
|
+
created_at?: string; // date-time
|
|
1021
|
+
updated_at?: string; // date-time
|
|
1022
|
+
created_by?: CallerIdentity;
|
|
1023
|
+
updated_by?: CallerIdentity;
|
|
1024
|
+
/**
|
|
1025
|
+
* URL to the blueprint documentation
|
|
1026
|
+
*/
|
|
1027
|
+
docs_url?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* Whether the blueprint is verified by epilot
|
|
1030
|
+
*/
|
|
1031
|
+
is_verified?: boolean;
|
|
1032
|
+
source_type: "marketplace";
|
|
1033
|
+
resources?: InstalledBlueprintResource[];
|
|
1034
|
+
}
|
|
707
1035
|
export type PlanChanges = ("create" | "update" | "no-op" | "delete")[];
|
|
708
1036
|
export interface PutManifestPayload {
|
|
709
1037
|
/**
|
|
@@ -866,6 +1194,32 @@ declare namespace Components {
|
|
|
866
1194
|
}
|
|
867
1195
|
}
|
|
868
1196
|
declare namespace Paths {
|
|
1197
|
+
namespace AddBlueprintResource {
|
|
1198
|
+
namespace Parameters {
|
|
1199
|
+
/**
|
|
1200
|
+
* Whether to add this resource dependencies to the blueprint automatically
|
|
1201
|
+
*/
|
|
1202
|
+
export type AddDependencies = boolean;
|
|
1203
|
+
export type BlueprintId = /**
|
|
1204
|
+
* ID of a blueprint
|
|
1205
|
+
* example:
|
|
1206
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1207
|
+
*/
|
|
1208
|
+
Components.Schemas.BlueprintID;
|
|
1209
|
+
}
|
|
1210
|
+
export interface PathParameters {
|
|
1211
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1212
|
+
}
|
|
1213
|
+
export interface QueryParameters {
|
|
1214
|
+
add_dependencies?: /* Whether to add this resource dependencies to the blueprint automatically */ Parameters.AddDependencies;
|
|
1215
|
+
}
|
|
1216
|
+
export type RequestBody = Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource;
|
|
1217
|
+
namespace Responses {
|
|
1218
|
+
export interface $200 {
|
|
1219
|
+
resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
1220
|
+
}
|
|
1221
|
+
}
|
|
1222
|
+
}
|
|
869
1223
|
namespace ApplyPlan {
|
|
870
1224
|
namespace Parameters {
|
|
871
1225
|
export type JobId = /**
|
|
@@ -899,50 +1253,169 @@ declare namespace Paths {
|
|
|
899
1253
|
}
|
|
900
1254
|
}
|
|
901
1255
|
}
|
|
902
|
-
namespace
|
|
903
|
-
|
|
904
|
-
resources: [
|
|
905
|
-
{
|
|
906
|
-
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
907
|
-
id: string;
|
|
908
|
-
},
|
|
909
|
-
...{
|
|
910
|
-
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
911
|
-
id: string;
|
|
912
|
-
}[]
|
|
913
|
-
];
|
|
914
|
-
jobId?: /**
|
|
915
|
-
* ID of an import or export job (state machine)
|
|
916
|
-
* example:
|
|
917
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
918
|
-
*/
|
|
919
|
-
Components.Schemas.JobID;
|
|
920
|
-
/**
|
|
921
|
-
* Temporary flag to indicate if multiple resources are being exported
|
|
922
|
-
*/
|
|
923
|
-
isExportingMultipleResources?: boolean;
|
|
1256
|
+
namespace BulkAddBlueprintResources {
|
|
1257
|
+
namespace Parameters {
|
|
924
1258
|
/**
|
|
925
|
-
*
|
|
1259
|
+
* Whether to add this resource dependencies to the blueprint automatically
|
|
926
1260
|
*/
|
|
927
|
-
|
|
928
|
-
/**
|
|
929
|
-
* ID of
|
|
1261
|
+
export type AddDependencies = boolean;
|
|
1262
|
+
export type BlueprintId = /**
|
|
1263
|
+
* ID of a blueprint
|
|
1264
|
+
* example:
|
|
1265
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
930
1266
|
*/
|
|
931
|
-
|
|
1267
|
+
Components.Schemas.BlueprintID;
|
|
1268
|
+
}
|
|
1269
|
+
export interface PathParameters {
|
|
1270
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1271
|
+
}
|
|
1272
|
+
export interface QueryParameters {
|
|
1273
|
+
add_dependencies?: /* Whether to add this resource dependencies to the blueprint automatically */ Parameters.AddDependencies;
|
|
932
1274
|
}
|
|
1275
|
+
export type RequestBody = (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
933
1276
|
namespace Responses {
|
|
934
1277
|
export interface $200 {
|
|
935
|
-
|
|
936
|
-
* ID of an import or export job (state machine)
|
|
937
|
-
* example:
|
|
938
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
939
|
-
*/
|
|
940
|
-
Components.Schemas.JobID;
|
|
1278
|
+
resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
941
1279
|
}
|
|
942
1280
|
}
|
|
943
1281
|
}
|
|
944
|
-
namespace
|
|
945
|
-
|
|
1282
|
+
namespace BulkDeleteBlueprintResources {
|
|
1283
|
+
namespace Parameters {
|
|
1284
|
+
export type BlueprintId = /**
|
|
1285
|
+
* ID of a blueprint
|
|
1286
|
+
* example:
|
|
1287
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1288
|
+
*/
|
|
1289
|
+
Components.Schemas.BlueprintID;
|
|
1290
|
+
}
|
|
1291
|
+
export interface PathParameters {
|
|
1292
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1293
|
+
}
|
|
1294
|
+
export type RequestBody = /**
|
|
1295
|
+
* ID of a blueprint resource
|
|
1296
|
+
* example:
|
|
1297
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1298
|
+
*/
|
|
1299
|
+
Components.Schemas.BlueprintResourceID[];
|
|
1300
|
+
namespace Responses {
|
|
1301
|
+
export interface $200 {
|
|
1302
|
+
resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
1303
|
+
}
|
|
1304
|
+
}
|
|
1305
|
+
}
|
|
1306
|
+
namespace BulkUpdateBlueprintResources {
|
|
1307
|
+
namespace Parameters {
|
|
1308
|
+
export type BlueprintId = /**
|
|
1309
|
+
* ID of a blueprint
|
|
1310
|
+
* example:
|
|
1311
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1312
|
+
*/
|
|
1313
|
+
Components.Schemas.BlueprintID;
|
|
1314
|
+
}
|
|
1315
|
+
export interface PathParameters {
|
|
1316
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1317
|
+
}
|
|
1318
|
+
export type RequestBody = (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
1319
|
+
namespace Responses {
|
|
1320
|
+
export interface $200 {
|
|
1321
|
+
resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
1322
|
+
}
|
|
1323
|
+
}
|
|
1324
|
+
}
|
|
1325
|
+
namespace ContinueInstallationJob {
|
|
1326
|
+
namespace Parameters {
|
|
1327
|
+
export type JobId = /**
|
|
1328
|
+
* ID of an installation job
|
|
1329
|
+
* example:
|
|
1330
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1331
|
+
*/
|
|
1332
|
+
Components.Schemas.InstallationJobID;
|
|
1333
|
+
}
|
|
1334
|
+
export interface PathParameters {
|
|
1335
|
+
job_id: Parameters.JobId;
|
|
1336
|
+
}
|
|
1337
|
+
namespace Responses {
|
|
1338
|
+
export type $200 = Components.Schemas.InstallationJob;
|
|
1339
|
+
}
|
|
1340
|
+
}
|
|
1341
|
+
namespace CreateBlueprint {
|
|
1342
|
+
export type RequestBody = Components.Schemas.Blueprint;
|
|
1343
|
+
namespace Responses {
|
|
1344
|
+
export type $200 = Components.Schemas.Blueprint;
|
|
1345
|
+
}
|
|
1346
|
+
}
|
|
1347
|
+
namespace CreateExport {
|
|
1348
|
+
export interface RequestBody {
|
|
1349
|
+
resources: [
|
|
1350
|
+
{
|
|
1351
|
+
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
1352
|
+
id: string;
|
|
1353
|
+
},
|
|
1354
|
+
...{
|
|
1355
|
+
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
1356
|
+
id: string;
|
|
1357
|
+
}[]
|
|
1358
|
+
];
|
|
1359
|
+
jobId?: /**
|
|
1360
|
+
* ID of an import or export job (state machine)
|
|
1361
|
+
* example:
|
|
1362
|
+
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
1363
|
+
*/
|
|
1364
|
+
Components.Schemas.JobID;
|
|
1365
|
+
/**
|
|
1366
|
+
* Temporary flag to indicate if multiple resources are being exported
|
|
1367
|
+
*/
|
|
1368
|
+
isExportingMultipleResources?: boolean;
|
|
1369
|
+
/**
|
|
1370
|
+
* Pipeline ID selected when doing the sandbox sync
|
|
1371
|
+
*/
|
|
1372
|
+
pipelineId?: string;
|
|
1373
|
+
/**
|
|
1374
|
+
* ID of the installed manifest to load the resource addresses from
|
|
1375
|
+
*/
|
|
1376
|
+
manifestId?: string;
|
|
1377
|
+
}
|
|
1378
|
+
namespace Responses {
|
|
1379
|
+
export interface $200 {
|
|
1380
|
+
jobId?: /**
|
|
1381
|
+
* ID of an import or export job (state machine)
|
|
1382
|
+
* example:
|
|
1383
|
+
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
1384
|
+
*/
|
|
1385
|
+
Components.Schemas.JobID;
|
|
1386
|
+
}
|
|
1387
|
+
}
|
|
1388
|
+
}
|
|
1389
|
+
namespace CreateInstallationJob {
|
|
1390
|
+
export interface RequestBody {
|
|
1391
|
+
source_blueprint_id: /**
|
|
1392
|
+
* ID of a blueprint
|
|
1393
|
+
* example:
|
|
1394
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1395
|
+
*/
|
|
1396
|
+
Components.Schemas.BlueprintID;
|
|
1397
|
+
/**
|
|
1398
|
+
* Destination organization ID
|
|
1399
|
+
*/
|
|
1400
|
+
destination_org_id: string;
|
|
1401
|
+
/**
|
|
1402
|
+
* Installation mode
|
|
1403
|
+
*/
|
|
1404
|
+
mode: "simple" | "advanced";
|
|
1405
|
+
}
|
|
1406
|
+
namespace Responses {
|
|
1407
|
+
export interface $202 {
|
|
1408
|
+
job_id?: /**
|
|
1409
|
+
* ID of an installation job
|
|
1410
|
+
* example:
|
|
1411
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1412
|
+
*/
|
|
1413
|
+
Components.Schemas.InstallationJobID;
|
|
1414
|
+
}
|
|
1415
|
+
}
|
|
1416
|
+
}
|
|
1417
|
+
namespace CreatePlan {
|
|
1418
|
+
export type RequestBody = {
|
|
946
1419
|
/**
|
|
947
1420
|
* s3ref of manifest file uploaded via `uploadManifest`
|
|
948
1421
|
*/
|
|
@@ -1032,6 +1505,47 @@ declare namespace Paths {
|
|
|
1032
1505
|
}
|
|
1033
1506
|
}
|
|
1034
1507
|
}
|
|
1508
|
+
namespace DeleteBlueprint {
|
|
1509
|
+
namespace Parameters {
|
|
1510
|
+
export type BlueprintId = /**
|
|
1511
|
+
* ID of a blueprint
|
|
1512
|
+
* example:
|
|
1513
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1514
|
+
*/
|
|
1515
|
+
Components.Schemas.BlueprintID;
|
|
1516
|
+
}
|
|
1517
|
+
export interface PathParameters {
|
|
1518
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1519
|
+
}
|
|
1520
|
+
namespace Responses {
|
|
1521
|
+
export type $200 = Components.Schemas.Blueprint;
|
|
1522
|
+
}
|
|
1523
|
+
}
|
|
1524
|
+
namespace DeleteBlueprintResource {
|
|
1525
|
+
namespace Parameters {
|
|
1526
|
+
export type BlueprintId = /**
|
|
1527
|
+
* ID of a blueprint
|
|
1528
|
+
* example:
|
|
1529
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1530
|
+
*/
|
|
1531
|
+
Components.Schemas.BlueprintID;
|
|
1532
|
+
export type ResourceId = /**
|
|
1533
|
+
* ID of a blueprint resource
|
|
1534
|
+
* example:
|
|
1535
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1536
|
+
*/
|
|
1537
|
+
Components.Schemas.BlueprintResourceID;
|
|
1538
|
+
}
|
|
1539
|
+
export interface PathParameters {
|
|
1540
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1541
|
+
resource_id: Parameters.ResourceId;
|
|
1542
|
+
}
|
|
1543
|
+
namespace Responses {
|
|
1544
|
+
export interface $200 {
|
|
1545
|
+
resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
1546
|
+
}
|
|
1547
|
+
}
|
|
1548
|
+
}
|
|
1035
1549
|
namespace DeleteManifest {
|
|
1036
1550
|
namespace Parameters {
|
|
1037
1551
|
export type ManifestId = /**
|
|
@@ -1048,6 +1562,24 @@ declare namespace Paths {
|
|
|
1048
1562
|
export type $200 = Components.Schemas.Manifest;
|
|
1049
1563
|
}
|
|
1050
1564
|
}
|
|
1565
|
+
namespace ExportBlueprint {
|
|
1566
|
+
namespace Parameters {
|
|
1567
|
+
export type BlueprintId = /**
|
|
1568
|
+
* ID of a blueprint
|
|
1569
|
+
* example:
|
|
1570
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1571
|
+
*/
|
|
1572
|
+
Components.Schemas.BlueprintID;
|
|
1573
|
+
}
|
|
1574
|
+
export interface PathParameters {
|
|
1575
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1576
|
+
}
|
|
1577
|
+
namespace Responses {
|
|
1578
|
+
export interface $200 {
|
|
1579
|
+
url?: string;
|
|
1580
|
+
}
|
|
1581
|
+
}
|
|
1582
|
+
}
|
|
1051
1583
|
namespace ExportManifest {
|
|
1052
1584
|
namespace Parameters {
|
|
1053
1585
|
export type JobId = /**
|
|
@@ -1099,6 +1631,63 @@ declare namespace Paths {
|
|
|
1099
1631
|
}
|
|
1100
1632
|
}
|
|
1101
1633
|
}
|
|
1634
|
+
namespace GetBlueprint {
|
|
1635
|
+
namespace Parameters {
|
|
1636
|
+
export type BlueprintId = /**
|
|
1637
|
+
* ID of a blueprint
|
|
1638
|
+
* example:
|
|
1639
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1640
|
+
*/
|
|
1641
|
+
Components.Schemas.BlueprintID;
|
|
1642
|
+
}
|
|
1643
|
+
export interface PathParameters {
|
|
1644
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1645
|
+
}
|
|
1646
|
+
namespace Responses {
|
|
1647
|
+
export type $200 = Components.Schemas.Blueprint;
|
|
1648
|
+
}
|
|
1649
|
+
}
|
|
1650
|
+
namespace GetInstallationJob {
|
|
1651
|
+
namespace Parameters {
|
|
1652
|
+
export type JobId = /**
|
|
1653
|
+
* ID of an installation job
|
|
1654
|
+
* example:
|
|
1655
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1656
|
+
*/
|
|
1657
|
+
Components.Schemas.InstallationJobID;
|
|
1658
|
+
}
|
|
1659
|
+
export interface PathParameters {
|
|
1660
|
+
job_id: Parameters.JobId;
|
|
1661
|
+
}
|
|
1662
|
+
namespace Responses {
|
|
1663
|
+
export type $200 = Components.Schemas.InstallationJob;
|
|
1664
|
+
}
|
|
1665
|
+
}
|
|
1666
|
+
namespace GetInstallationJobEvents {
|
|
1667
|
+
namespace Parameters {
|
|
1668
|
+
export type JobId = /**
|
|
1669
|
+
* ID of an installation job
|
|
1670
|
+
* example:
|
|
1671
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1672
|
+
*/
|
|
1673
|
+
Components.Schemas.InstallationJobID;
|
|
1674
|
+
}
|
|
1675
|
+
export interface PathParameters {
|
|
1676
|
+
job_id: Parameters.JobId;
|
|
1677
|
+
}
|
|
1678
|
+
namespace Responses {
|
|
1679
|
+
export interface $200 {
|
|
1680
|
+
created_at?: string; // date-time
|
|
1681
|
+
status?: "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
|
|
1682
|
+
errors?: Components.Schemas.FormattedError[];
|
|
1683
|
+
/**
|
|
1684
|
+
* Progress completion (0-100)
|
|
1685
|
+
*/
|
|
1686
|
+
progress?: number; // float
|
|
1687
|
+
events?: Components.Schemas.InstallationJobEvent[];
|
|
1688
|
+
}
|
|
1689
|
+
}
|
|
1690
|
+
}
|
|
1102
1691
|
namespace GetJob {
|
|
1103
1692
|
namespace Parameters {
|
|
1104
1693
|
export type JobId = /**
|
|
@@ -1131,6 +1720,18 @@ declare namespace Paths {
|
|
|
1131
1720
|
export type $200 = Components.Schemas.Manifest;
|
|
1132
1721
|
}
|
|
1133
1722
|
}
|
|
1723
|
+
namespace ListBlueprints {
|
|
1724
|
+
namespace Responses {
|
|
1725
|
+
export interface $200 {
|
|
1726
|
+
/**
|
|
1727
|
+
* example:
|
|
1728
|
+
* 1
|
|
1729
|
+
*/
|
|
1730
|
+
total?: number;
|
|
1731
|
+
results?: Components.Schemas.Blueprint[];
|
|
1732
|
+
}
|
|
1733
|
+
}
|
|
1734
|
+
}
|
|
1134
1735
|
namespace ListInstalledManifests {
|
|
1135
1736
|
namespace Responses {
|
|
1136
1737
|
export interface $200 {
|
|
@@ -1143,6 +1744,67 @@ declare namespace Paths {
|
|
|
1143
1744
|
}
|
|
1144
1745
|
}
|
|
1145
1746
|
}
|
|
1747
|
+
namespace SyncDependencies {
|
|
1748
|
+
namespace Parameters {
|
|
1749
|
+
export type BlueprintId = /**
|
|
1750
|
+
* ID of a blueprint
|
|
1751
|
+
* example:
|
|
1752
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1753
|
+
*/
|
|
1754
|
+
Components.Schemas.BlueprintID;
|
|
1755
|
+
}
|
|
1756
|
+
export interface PathParameters {
|
|
1757
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1758
|
+
}
|
|
1759
|
+
namespace Responses {
|
|
1760
|
+
export interface $200 {
|
|
1761
|
+
resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
1762
|
+
}
|
|
1763
|
+
}
|
|
1764
|
+
}
|
|
1765
|
+
namespace UpdateBlueprint {
|
|
1766
|
+
namespace Parameters {
|
|
1767
|
+
export type BlueprintId = /**
|
|
1768
|
+
* ID of a blueprint
|
|
1769
|
+
* example:
|
|
1770
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1771
|
+
*/
|
|
1772
|
+
Components.Schemas.BlueprintID;
|
|
1773
|
+
}
|
|
1774
|
+
export interface PathParameters {
|
|
1775
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1776
|
+
}
|
|
1777
|
+
export type RequestBody = Components.Schemas.Blueprint;
|
|
1778
|
+
namespace Responses {
|
|
1779
|
+
export type $200 = Components.Schemas.Blueprint;
|
|
1780
|
+
}
|
|
1781
|
+
}
|
|
1782
|
+
namespace UpdateBlueprintResource {
|
|
1783
|
+
namespace Parameters {
|
|
1784
|
+
export type BlueprintId = /**
|
|
1785
|
+
* ID of a blueprint
|
|
1786
|
+
* example:
|
|
1787
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1788
|
+
*/
|
|
1789
|
+
Components.Schemas.BlueprintID;
|
|
1790
|
+
export type ResourceId = /**
|
|
1791
|
+
* ID of a blueprint resource
|
|
1792
|
+
* example:
|
|
1793
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1794
|
+
*/
|
|
1795
|
+
Components.Schemas.BlueprintResourceID;
|
|
1796
|
+
}
|
|
1797
|
+
export interface PathParameters {
|
|
1798
|
+
blueprint_id: Parameters.BlueprintId;
|
|
1799
|
+
resource_id: Parameters.ResourceId;
|
|
1800
|
+
}
|
|
1801
|
+
export type RequestBody = Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource;
|
|
1802
|
+
namespace Responses {
|
|
1803
|
+
export interface $200 {
|
|
1804
|
+
resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
|
|
1805
|
+
}
|
|
1806
|
+
}
|
|
1807
|
+
}
|
|
1146
1808
|
namespace UpdateManifest {
|
|
1147
1809
|
namespace Parameters {
|
|
1148
1810
|
export type ManifestId = /**
|
|
@@ -1173,9 +1835,21 @@ declare namespace Paths {
|
|
|
1173
1835
|
}
|
|
1174
1836
|
}
|
|
1175
1837
|
}
|
|
1838
|
+
namespace V2BlueprintManifestInstallations$JobIdCancel {
|
|
1839
|
+
namespace Parameters {
|
|
1840
|
+
export type JobId = /**
|
|
1841
|
+
* ID of an installation job
|
|
1842
|
+
* example:
|
|
1843
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1844
|
+
*/
|
|
1845
|
+
Components.Schemas.InstallationJobID;
|
|
1846
|
+
}
|
|
1847
|
+
export interface PathParameters {
|
|
1848
|
+
job_id: Parameters.JobId;
|
|
1849
|
+
}
|
|
1850
|
+
}
|
|
1176
1851
|
}
|
|
1177
1852
|
|
|
1178
|
-
|
|
1179
1853
|
export interface OperationMethods {
|
|
1180
1854
|
/**
|
|
1181
1855
|
* getJob - getJob
|
|
@@ -1288,6 +1962,177 @@ export interface OperationMethods {
|
|
|
1288
1962
|
data?: any,
|
|
1289
1963
|
config?: AxiosRequestConfig
|
|
1290
1964
|
): OperationResponse<Paths.DeleteManifest.Responses.$200>
|
|
1965
|
+
/**
|
|
1966
|
+
* listBlueprints - listBlueprints
|
|
1967
|
+
*
|
|
1968
|
+
* List Custom and Installed Blueprints
|
|
1969
|
+
*/
|
|
1970
|
+
'listBlueprints'(
|
|
1971
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1972
|
+
data?: any,
|
|
1973
|
+
config?: AxiosRequestConfig
|
|
1974
|
+
): OperationResponse<Paths.ListBlueprints.Responses.$200>
|
|
1975
|
+
/**
|
|
1976
|
+
* createBlueprint - createBlueprint
|
|
1977
|
+
*
|
|
1978
|
+
* Create a Blueprint
|
|
1979
|
+
*/
|
|
1980
|
+
'createBlueprint'(
|
|
1981
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1982
|
+
data?: Paths.CreateBlueprint.RequestBody,
|
|
1983
|
+
config?: AxiosRequestConfig
|
|
1984
|
+
): OperationResponse<Paths.CreateBlueprint.Responses.$200>
|
|
1985
|
+
/**
|
|
1986
|
+
* getBlueprint - getBlueprint
|
|
1987
|
+
*
|
|
1988
|
+
* Get Blueprint by ID
|
|
1989
|
+
*/
|
|
1990
|
+
'getBlueprint'(
|
|
1991
|
+
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
1992
|
+
data?: any,
|
|
1993
|
+
config?: AxiosRequestConfig
|
|
1994
|
+
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
1995
|
+
/**
|
|
1996
|
+
* updateBlueprint - updateBlueprint
|
|
1997
|
+
*
|
|
1998
|
+
* Update a Blueprint
|
|
1999
|
+
*/
|
|
2000
|
+
'updateBlueprint'(
|
|
2001
|
+
parameters?: Parameters<Paths.UpdateBlueprint.PathParameters> | null,
|
|
2002
|
+
data?: Paths.UpdateBlueprint.RequestBody,
|
|
2003
|
+
config?: AxiosRequestConfig
|
|
2004
|
+
): OperationResponse<Paths.UpdateBlueprint.Responses.$200>
|
|
2005
|
+
/**
|
|
2006
|
+
* deleteBlueprint - deleteBlueprint
|
|
2007
|
+
*
|
|
2008
|
+
* Delete a Blueprint
|
|
2009
|
+
*/
|
|
2010
|
+
'deleteBlueprint'(
|
|
2011
|
+
parameters?: Parameters<Paths.DeleteBlueprint.PathParameters> | null,
|
|
2012
|
+
data?: any,
|
|
2013
|
+
config?: AxiosRequestConfig
|
|
2014
|
+
): OperationResponse<Paths.DeleteBlueprint.Responses.$200>
|
|
2015
|
+
/**
|
|
2016
|
+
* exportBlueprint - exportBlueprint
|
|
2017
|
+
*
|
|
2018
|
+
* Zip the blueprint content and return the url to download it
|
|
2019
|
+
*/
|
|
2020
|
+
'exportBlueprint'(
|
|
2021
|
+
parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
|
|
2022
|
+
data?: any,
|
|
2023
|
+
config?: AxiosRequestConfig
|
|
2024
|
+
): OperationResponse<Paths.ExportBlueprint.Responses.$200>
|
|
2025
|
+
/**
|
|
2026
|
+
* addBlueprintResource - addBlueprintResource
|
|
2027
|
+
*
|
|
2028
|
+
* Add a resource to a Blueprint
|
|
2029
|
+
*/
|
|
2030
|
+
'addBlueprintResource'(
|
|
2031
|
+
parameters?: Parameters<Paths.AddBlueprintResource.QueryParameters & Paths.AddBlueprintResource.PathParameters> | null,
|
|
2032
|
+
data?: Paths.AddBlueprintResource.RequestBody,
|
|
2033
|
+
config?: AxiosRequestConfig
|
|
2034
|
+
): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
|
|
2035
|
+
/**
|
|
2036
|
+
* syncDependencies - syncDependencies
|
|
2037
|
+
*
|
|
2038
|
+
* Sync dependencies of all root resources in a Blueprint
|
|
2039
|
+
*/
|
|
2040
|
+
'syncDependencies'(
|
|
2041
|
+
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
2042
|
+
data?: any,
|
|
2043
|
+
config?: AxiosRequestConfig
|
|
2044
|
+
): OperationResponse<Paths.SyncDependencies.Responses.$200>
|
|
2045
|
+
/**
|
|
2046
|
+
* bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
|
|
2047
|
+
*
|
|
2048
|
+
* Bulk update resources in a Blueprint
|
|
2049
|
+
*/
|
|
2050
|
+
'bulkUpdateBlueprintResources'(
|
|
2051
|
+
parameters?: Parameters<Paths.BulkUpdateBlueprintResources.PathParameters> | null,
|
|
2052
|
+
data?: Paths.BulkUpdateBlueprintResources.RequestBody,
|
|
2053
|
+
config?: AxiosRequestConfig
|
|
2054
|
+
): OperationResponse<Paths.BulkUpdateBlueprintResources.Responses.$200>
|
|
2055
|
+
/**
|
|
2056
|
+
* bulkAddBlueprintResources - bulkAddBlueprintResources
|
|
2057
|
+
*
|
|
2058
|
+
* Bulk Add resources in a Blueprint
|
|
2059
|
+
*/
|
|
2060
|
+
'bulkAddBlueprintResources'(
|
|
2061
|
+
parameters?: Parameters<Paths.BulkAddBlueprintResources.QueryParameters & Paths.BulkAddBlueprintResources.PathParameters> | null,
|
|
2062
|
+
data?: Paths.BulkAddBlueprintResources.RequestBody,
|
|
2063
|
+
config?: AxiosRequestConfig
|
|
2064
|
+
): OperationResponse<Paths.BulkAddBlueprintResources.Responses.$200>
|
|
2065
|
+
/**
|
|
2066
|
+
* bulkDeleteBlueprintResources - bulkDeleteBlueprintResources
|
|
2067
|
+
*
|
|
2068
|
+
* Bulk delete resources in a Blueprint
|
|
2069
|
+
*/
|
|
2070
|
+
'bulkDeleteBlueprintResources'(
|
|
2071
|
+
parameters?: Parameters<Paths.BulkDeleteBlueprintResources.PathParameters> | null,
|
|
2072
|
+
data?: Paths.BulkDeleteBlueprintResources.RequestBody,
|
|
2073
|
+
config?: AxiosRequestConfig
|
|
2074
|
+
): OperationResponse<Paths.BulkDeleteBlueprintResources.Responses.$200>
|
|
2075
|
+
/**
|
|
2076
|
+
* updateBlueprintResource - updateBlueprintResource
|
|
2077
|
+
*
|
|
2078
|
+
* Update a resource in a Blueprint
|
|
2079
|
+
*/
|
|
2080
|
+
'updateBlueprintResource'(
|
|
2081
|
+
parameters?: Parameters<Paths.UpdateBlueprintResource.PathParameters> | null,
|
|
2082
|
+
data?: Paths.UpdateBlueprintResource.RequestBody,
|
|
2083
|
+
config?: AxiosRequestConfig
|
|
2084
|
+
): OperationResponse<Paths.UpdateBlueprintResource.Responses.$200>
|
|
2085
|
+
/**
|
|
2086
|
+
* deleteBlueprintResource - deleteBlueprintResource
|
|
2087
|
+
*
|
|
2088
|
+
* Delete a resource from a Blueprint
|
|
2089
|
+
*/
|
|
2090
|
+
'deleteBlueprintResource'(
|
|
2091
|
+
parameters?: Parameters<Paths.DeleteBlueprintResource.PathParameters> | null,
|
|
2092
|
+
data?: any,
|
|
2093
|
+
config?: AxiosRequestConfig
|
|
2094
|
+
): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
|
|
2095
|
+
/**
|
|
2096
|
+
* createInstallationJob - Create Installation Job
|
|
2097
|
+
*
|
|
2098
|
+
* Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.
|
|
2099
|
+
*
|
|
2100
|
+
*/
|
|
2101
|
+
'createInstallationJob'(
|
|
2102
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2103
|
+
data?: Paths.CreateInstallationJob.RequestBody,
|
|
2104
|
+
config?: AxiosRequestConfig
|
|
2105
|
+
): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
|
|
2106
|
+
/**
|
|
2107
|
+
* getInstallationJob - Get Installation Job
|
|
2108
|
+
*
|
|
2109
|
+
* Poll current state of an installation job.
|
|
2110
|
+
*/
|
|
2111
|
+
'getInstallationJob'(
|
|
2112
|
+
parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
|
|
2113
|
+
data?: any,
|
|
2114
|
+
config?: AxiosRequestConfig
|
|
2115
|
+
): OperationResponse<Paths.GetInstallationJob.Responses.$200>
|
|
2116
|
+
/**
|
|
2117
|
+
* continueInstallationJob - Continue Installation Job
|
|
2118
|
+
*
|
|
2119
|
+
* Continue an installation job if it is waiting for user action.
|
|
2120
|
+
*/
|
|
2121
|
+
'continueInstallationJob'(
|
|
2122
|
+
parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
|
|
2123
|
+
data?: any,
|
|
2124
|
+
config?: AxiosRequestConfig
|
|
2125
|
+
): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
|
|
2126
|
+
/**
|
|
2127
|
+
* getInstallationJobEvents - Get Installation Job Events
|
|
2128
|
+
*
|
|
2129
|
+
* Event log for an installation job.
|
|
2130
|
+
*/
|
|
2131
|
+
'getInstallationJobEvents'(
|
|
2132
|
+
parameters?: Parameters<Paths.GetInstallationJobEvents.PathParameters> | null,
|
|
2133
|
+
data?: any,
|
|
2134
|
+
config?: AxiosRequestConfig
|
|
2135
|
+
): OperationResponse<Paths.GetInstallationJobEvents.Responses.$200>
|
|
1291
2136
|
}
|
|
1292
2137
|
|
|
1293
2138
|
export interface PathsDictionary {
|
|
@@ -1418,20 +2263,228 @@ export interface PathsDictionary {
|
|
|
1418
2263
|
config?: AxiosRequestConfig
|
|
1419
2264
|
): OperationResponse<Paths.DeleteManifest.Responses.$200>
|
|
1420
2265
|
}
|
|
2266
|
+
['/v2/blueprint-manifest/blueprints']: {
|
|
2267
|
+
/**
|
|
2268
|
+
* listBlueprints - listBlueprints
|
|
2269
|
+
*
|
|
2270
|
+
* List Custom and Installed Blueprints
|
|
2271
|
+
*/
|
|
2272
|
+
'get'(
|
|
2273
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2274
|
+
data?: any,
|
|
2275
|
+
config?: AxiosRequestConfig
|
|
2276
|
+
): OperationResponse<Paths.ListBlueprints.Responses.$200>
|
|
2277
|
+
/**
|
|
2278
|
+
* createBlueprint - createBlueprint
|
|
2279
|
+
*
|
|
2280
|
+
* Create a Blueprint
|
|
2281
|
+
*/
|
|
2282
|
+
'post'(
|
|
2283
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2284
|
+
data?: Paths.CreateBlueprint.RequestBody,
|
|
2285
|
+
config?: AxiosRequestConfig
|
|
2286
|
+
): OperationResponse<Paths.CreateBlueprint.Responses.$200>
|
|
2287
|
+
}
|
|
2288
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}']: {
|
|
2289
|
+
/**
|
|
2290
|
+
* getBlueprint - getBlueprint
|
|
2291
|
+
*
|
|
2292
|
+
* Get Blueprint by ID
|
|
2293
|
+
*/
|
|
2294
|
+
'get'(
|
|
2295
|
+
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
2296
|
+
data?: any,
|
|
2297
|
+
config?: AxiosRequestConfig
|
|
2298
|
+
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
2299
|
+
/**
|
|
2300
|
+
* updateBlueprint - updateBlueprint
|
|
2301
|
+
*
|
|
2302
|
+
* Update a Blueprint
|
|
2303
|
+
*/
|
|
2304
|
+
'put'(
|
|
2305
|
+
parameters?: Parameters<Paths.UpdateBlueprint.PathParameters> | null,
|
|
2306
|
+
data?: Paths.UpdateBlueprint.RequestBody,
|
|
2307
|
+
config?: AxiosRequestConfig
|
|
2308
|
+
): OperationResponse<Paths.UpdateBlueprint.Responses.$200>
|
|
2309
|
+
/**
|
|
2310
|
+
* deleteBlueprint - deleteBlueprint
|
|
2311
|
+
*
|
|
2312
|
+
* Delete a Blueprint
|
|
2313
|
+
*/
|
|
2314
|
+
'delete'(
|
|
2315
|
+
parameters?: Parameters<Paths.DeleteBlueprint.PathParameters> | null,
|
|
2316
|
+
data?: any,
|
|
2317
|
+
config?: AxiosRequestConfig
|
|
2318
|
+
): OperationResponse<Paths.DeleteBlueprint.Responses.$200>
|
|
2319
|
+
}
|
|
2320
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}:export']: {
|
|
2321
|
+
/**
|
|
2322
|
+
* exportBlueprint - exportBlueprint
|
|
2323
|
+
*
|
|
2324
|
+
* Zip the blueprint content and return the url to download it
|
|
2325
|
+
*/
|
|
2326
|
+
'post'(
|
|
2327
|
+
parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
|
|
2328
|
+
data?: any,
|
|
2329
|
+
config?: AxiosRequestConfig
|
|
2330
|
+
): OperationResponse<Paths.ExportBlueprint.Responses.$200>
|
|
2331
|
+
}
|
|
2332
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources']: {
|
|
2333
|
+
/**
|
|
2334
|
+
* addBlueprintResource - addBlueprintResource
|
|
2335
|
+
*
|
|
2336
|
+
* Add a resource to a Blueprint
|
|
2337
|
+
*/
|
|
2338
|
+
'post'(
|
|
2339
|
+
parameters?: Parameters<Paths.AddBlueprintResource.QueryParameters & Paths.AddBlueprintResource.PathParameters> | null,
|
|
2340
|
+
data?: Paths.AddBlueprintResource.RequestBody,
|
|
2341
|
+
config?: AxiosRequestConfig
|
|
2342
|
+
): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
|
|
2343
|
+
}
|
|
2344
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies']: {
|
|
2345
|
+
/**
|
|
2346
|
+
* syncDependencies - syncDependencies
|
|
2347
|
+
*
|
|
2348
|
+
* Sync dependencies of all root resources in a Blueprint
|
|
2349
|
+
*/
|
|
2350
|
+
'post'(
|
|
2351
|
+
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
2352
|
+
data?: any,
|
|
2353
|
+
config?: AxiosRequestConfig
|
|
2354
|
+
): OperationResponse<Paths.SyncDependencies.Responses.$200>
|
|
2355
|
+
}
|
|
2356
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk']: {
|
|
2357
|
+
/**
|
|
2358
|
+
* bulkAddBlueprintResources - bulkAddBlueprintResources
|
|
2359
|
+
*
|
|
2360
|
+
* Bulk Add resources in a Blueprint
|
|
2361
|
+
*/
|
|
2362
|
+
'post'(
|
|
2363
|
+
parameters?: Parameters<Paths.BulkAddBlueprintResources.QueryParameters & Paths.BulkAddBlueprintResources.PathParameters> | null,
|
|
2364
|
+
data?: Paths.BulkAddBlueprintResources.RequestBody,
|
|
2365
|
+
config?: AxiosRequestConfig
|
|
2366
|
+
): OperationResponse<Paths.BulkAddBlueprintResources.Responses.$200>
|
|
2367
|
+
/**
|
|
2368
|
+
* bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
|
|
2369
|
+
*
|
|
2370
|
+
* Bulk update resources in a Blueprint
|
|
2371
|
+
*/
|
|
2372
|
+
'put'(
|
|
2373
|
+
parameters?: Parameters<Paths.BulkUpdateBlueprintResources.PathParameters> | null,
|
|
2374
|
+
data?: Paths.BulkUpdateBlueprintResources.RequestBody,
|
|
2375
|
+
config?: AxiosRequestConfig
|
|
2376
|
+
): OperationResponse<Paths.BulkUpdateBlueprintResources.Responses.$200>
|
|
2377
|
+
/**
|
|
2378
|
+
* bulkDeleteBlueprintResources - bulkDeleteBlueprintResources
|
|
2379
|
+
*
|
|
2380
|
+
* Bulk delete resources in a Blueprint
|
|
2381
|
+
*/
|
|
2382
|
+
'delete'(
|
|
2383
|
+
parameters?: Parameters<Paths.BulkDeleteBlueprintResources.PathParameters> | null,
|
|
2384
|
+
data?: Paths.BulkDeleteBlueprintResources.RequestBody,
|
|
2385
|
+
config?: AxiosRequestConfig
|
|
2386
|
+
): OperationResponse<Paths.BulkDeleteBlueprintResources.Responses.$200>
|
|
2387
|
+
}
|
|
2388
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}']: {
|
|
2389
|
+
/**
|
|
2390
|
+
* updateBlueprintResource - updateBlueprintResource
|
|
2391
|
+
*
|
|
2392
|
+
* Update a resource in a Blueprint
|
|
2393
|
+
*/
|
|
2394
|
+
'put'(
|
|
2395
|
+
parameters?: Parameters<Paths.UpdateBlueprintResource.PathParameters> | null,
|
|
2396
|
+
data?: Paths.UpdateBlueprintResource.RequestBody,
|
|
2397
|
+
config?: AxiosRequestConfig
|
|
2398
|
+
): OperationResponse<Paths.UpdateBlueprintResource.Responses.$200>
|
|
2399
|
+
/**
|
|
2400
|
+
* deleteBlueprintResource - deleteBlueprintResource
|
|
2401
|
+
*
|
|
2402
|
+
* Delete a resource from a Blueprint
|
|
2403
|
+
*/
|
|
2404
|
+
'delete'(
|
|
2405
|
+
parameters?: Parameters<Paths.DeleteBlueprintResource.PathParameters> | null,
|
|
2406
|
+
data?: any,
|
|
2407
|
+
config?: AxiosRequestConfig
|
|
2408
|
+
): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
|
|
2409
|
+
}
|
|
2410
|
+
['/v2/blueprint-manifest/installations']: {
|
|
2411
|
+
/**
|
|
2412
|
+
* createInstallationJob - Create Installation Job
|
|
2413
|
+
*
|
|
2414
|
+
* Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.
|
|
2415
|
+
*
|
|
2416
|
+
*/
|
|
2417
|
+
'post'(
|
|
2418
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2419
|
+
data?: Paths.CreateInstallationJob.RequestBody,
|
|
2420
|
+
config?: AxiosRequestConfig
|
|
2421
|
+
): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
|
|
2422
|
+
}
|
|
2423
|
+
['/v2/blueprint-manifest/installations/{job_id}']: {
|
|
2424
|
+
/**
|
|
2425
|
+
* getInstallationJob - Get Installation Job
|
|
2426
|
+
*
|
|
2427
|
+
* Poll current state of an installation job.
|
|
2428
|
+
*/
|
|
2429
|
+
'get'(
|
|
2430
|
+
parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
|
|
2431
|
+
data?: any,
|
|
2432
|
+
config?: AxiosRequestConfig
|
|
2433
|
+
): OperationResponse<Paths.GetInstallationJob.Responses.$200>
|
|
2434
|
+
}
|
|
2435
|
+
['/v2/blueprint-manifest/installations/{job_id}:continue']: {
|
|
2436
|
+
/**
|
|
2437
|
+
* continueInstallationJob - Continue Installation Job
|
|
2438
|
+
*
|
|
2439
|
+
* Continue an installation job if it is waiting for user action.
|
|
2440
|
+
*/
|
|
2441
|
+
'post'(
|
|
2442
|
+
parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
|
|
2443
|
+
data?: any,
|
|
2444
|
+
config?: AxiosRequestConfig
|
|
2445
|
+
): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
|
|
2446
|
+
}
|
|
2447
|
+
['/v2/blueprint-manifest/installations/{job_id}:cancel']: {
|
|
2448
|
+
}
|
|
2449
|
+
['/v2/blueprint-manifest/installations/{job_id}/events']: {
|
|
2450
|
+
/**
|
|
2451
|
+
* getInstallationJobEvents - Get Installation Job Events
|
|
2452
|
+
*
|
|
2453
|
+
* Event log for an installation job.
|
|
2454
|
+
*/
|
|
2455
|
+
'get'(
|
|
2456
|
+
parameters?: Parameters<Paths.GetInstallationJobEvents.PathParameters> | null,
|
|
2457
|
+
data?: any,
|
|
2458
|
+
config?: AxiosRequestConfig
|
|
2459
|
+
): OperationResponse<Paths.GetInstallationJobEvents.Responses.$200>
|
|
2460
|
+
}
|
|
1421
2461
|
}
|
|
1422
2462
|
|
|
1423
2463
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1424
2464
|
|
|
1425
|
-
|
|
2465
|
+
export type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
2466
|
+
export type Blueprint = Components.Schemas.Blueprint;
|
|
2467
|
+
export type BlueprintID = Components.Schemas.BlueprintID;
|
|
1426
2468
|
export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
|
|
2469
|
+
export type BlueprintResource = Components.Schemas.BlueprintResource;
|
|
2470
|
+
export type BlueprintResourceID = Components.Schemas.BlueprintResourceID;
|
|
1427
2471
|
export type CallerIdentity = Components.Schemas.CallerIdentity;
|
|
2472
|
+
export type CommonBlueprintFields = Components.Schemas.CommonBlueprintFields;
|
|
1428
2473
|
export type CommonImportFields = Components.Schemas.CommonImportFields;
|
|
1429
2474
|
export type CommonManifestFields = Components.Schemas.CommonManifestFields;
|
|
1430
2475
|
export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
|
|
1431
2476
|
export type CommonResourceNode = Components.Schemas.CommonResourceNode;
|
|
2477
|
+
export type CustomBlueprint = Components.Schemas.CustomBlueprint;
|
|
2478
|
+
export type DeployedBlueprint = Components.Schemas.DeployedBlueprint;
|
|
2479
|
+
export type EditableBlueprintResource = Components.Schemas.EditableBlueprintResource;
|
|
2480
|
+
export type FileBlueprint = Components.Schemas.FileBlueprint;
|
|
1432
2481
|
export type FormattedError = Components.Schemas.FormattedError;
|
|
1433
2482
|
export type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
|
|
1434
2483
|
export type FormattedErrorData = Components.Schemas.FormattedErrorData;
|
|
2484
|
+
export type InstallationJob = Components.Schemas.InstallationJob;
|
|
2485
|
+
export type InstallationJobEvent = Components.Schemas.InstallationJobEvent;
|
|
2486
|
+
export type InstallationJobID = Components.Schemas.InstallationJobID;
|
|
2487
|
+
export type InstalledBlueprintResource = Components.Schemas.InstalledBlueprintResource;
|
|
1435
2488
|
export type Job = Components.Schemas.Job;
|
|
1436
2489
|
export type JobID = Components.Schemas.JobID;
|
|
1437
2490
|
export type JobStatus = Components.Schemas.JobStatus;
|
|
@@ -1440,6 +2493,7 @@ export type ManifestID = Components.Schemas.ManifestID;
|
|
|
1440
2493
|
export type ManifestItem = Components.Schemas.ManifestItem;
|
|
1441
2494
|
export type ManifestSource = Components.Schemas.ManifestSource;
|
|
1442
2495
|
export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
|
|
2496
|
+
export type MarketplaceBlueprint = Components.Schemas.MarketplaceBlueprint;
|
|
1443
2497
|
export type PlanChanges = Components.Schemas.PlanChanges;
|
|
1444
2498
|
export type PutManifestPayload = Components.Schemas.PutManifestPayload;
|
|
1445
2499
|
export type ResourceNode = Components.Schemas.ResourceNode;
|