@epilot/blueprint-manifest-client 2.11.0 → 3.0.0-beta.0

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/openapi.d.ts CHANGED
@@ -21,7 +21,68 @@ 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
+ /**
51
+ * Whether the blueprint is verified by epilot
52
+ */
53
+ is_verified?: boolean;
54
+ source_type?: "app";
55
+ resources?: InstalledBlueprintResource[];
56
+ }
57
+ export type Blueprint = CustomBlueprint | FileBlueprint | MarketplaceBlueprint | DeployedBlueprint | AppBlueprint;
58
+ /**
59
+ * ID of a blueprint
60
+ * example:
61
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
62
+ */
63
+ export type BlueprintID = string;
24
64
  export type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED";
65
+ export interface BlueprintResource {
66
+ id: /**
67
+ * ID of a blueprint resource
68
+ * example:
69
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
70
+ */
71
+ BlueprintResourceID;
72
+ name?: string;
73
+ type: /* Type of the resource */ ResourceNodeType;
74
+ address?: string;
75
+ /**
76
+ * 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
77
+ */
78
+ is_ready?: boolean;
79
+ }
80
+ /**
81
+ * ID of a blueprint resource
82
+ * example:
83
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
84
+ */
85
+ export type BlueprintResourceID = string;
25
86
  export interface CallerIdentity {
26
87
  /**
27
88
  * a human readable name of the caller (e.g. user name, token name or email address)
@@ -48,6 +109,33 @@ declare namespace Components {
48
109
  */
49
110
  token_id?: string;
50
111
  }
112
+ export interface CommonBlueprintFields {
113
+ id?: /**
114
+ * ID of a blueprint
115
+ * example:
116
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
117
+ */
118
+ BlueprintID;
119
+ title: string;
120
+ slug?: string;
121
+ description?: {
122
+ /**
123
+ * Markdown content shown before starting to install the blueprint
124
+ * example:
125
+ * This is the content of the preinstall.md file which contains the blueprint description.
126
+ *
127
+ */
128
+ preinstall?: string;
129
+ /**
130
+ * Markdown content to be displayed when showing the plan to install blueprint
131
+ * example:
132
+ * This is the content of the postinstall.md file
133
+ *
134
+ */
135
+ postinstall?: string;
136
+ };
137
+ version?: string;
138
+ }
51
139
  export interface CommonImportFields {
52
140
  source_type?: ManifestSource;
53
141
  /**
@@ -213,6 +301,115 @@ declare namespace Components {
213
301
  */
214
302
  is_virtual?: boolean;
215
303
  }
304
+ export interface CustomBlueprint {
305
+ id?: /**
306
+ * ID of a blueprint
307
+ * example:
308
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
309
+ */
310
+ BlueprintID;
311
+ title: string;
312
+ slug?: string;
313
+ description?: {
314
+ /**
315
+ * Markdown content shown before starting to install the blueprint
316
+ * example:
317
+ * This is the content of the preinstall.md file which contains the blueprint description.
318
+ *
319
+ */
320
+ preinstall?: string;
321
+ /**
322
+ * Markdown content to be displayed when showing the plan to install blueprint
323
+ * example:
324
+ * This is the content of the postinstall.md file
325
+ *
326
+ */
327
+ postinstall?: string;
328
+ };
329
+ version?: string;
330
+ resources?: EditableBlueprintResource[];
331
+ }
332
+ export interface DeployedBlueprint {
333
+ id?: /**
334
+ * ID of a blueprint
335
+ * example:
336
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
337
+ */
338
+ BlueprintID;
339
+ title: string;
340
+ slug?: string;
341
+ description?: {
342
+ /**
343
+ * Markdown content shown before starting to install the blueprint
344
+ * example:
345
+ * This is the content of the preinstall.md file which contains the blueprint description.
346
+ *
347
+ */
348
+ preinstall?: string;
349
+ /**
350
+ * Markdown content to be displayed when showing the plan to install blueprint
351
+ * example:
352
+ * This is the content of the postinstall.md file
353
+ *
354
+ */
355
+ postinstall?: string;
356
+ };
357
+ version?: string;
358
+ source_type?: "deploy";
359
+ resources?: InstalledBlueprintResource[];
360
+ }
361
+ export interface EditableBlueprintResource {
362
+ id: /**
363
+ * ID of a blueprint resource
364
+ * example:
365
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
366
+ */
367
+ BlueprintResourceID;
368
+ name?: string;
369
+ type: /* Type of the resource */ ResourceNodeType;
370
+ address?: string;
371
+ /**
372
+ * 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
373
+ */
374
+ is_ready?: boolean;
375
+ /**
376
+ * An internal note to help remember what's missing to export the resource
377
+ */
378
+ note?: string;
379
+ }
380
+ export interface FileBlueprint {
381
+ id?: /**
382
+ * ID of a blueprint
383
+ * example:
384
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
385
+ */
386
+ BlueprintID;
387
+ title: string;
388
+ slug?: string;
389
+ description?: {
390
+ /**
391
+ * Markdown content shown before starting to install the blueprint
392
+ * example:
393
+ * This is the content of the preinstall.md file which contains the blueprint description.
394
+ *
395
+ */
396
+ preinstall?: string;
397
+ /**
398
+ * Markdown content to be displayed when showing the plan to install blueprint
399
+ * example:
400
+ * This is the content of the postinstall.md file
401
+ *
402
+ */
403
+ postinstall?: string;
404
+ };
405
+ version?: string;
406
+ /**
407
+ * Whether the blueprint is verified by epilot
408
+ */
409
+ is_verified?: boolean;
410
+ source_type?: "file";
411
+ resources?: InstalledBlueprintResource[];
412
+ }
216
413
  export interface FormattedError {
217
414
  error?: string | {
218
415
  [key: string]: any;
@@ -228,6 +425,63 @@ declare namespace Components {
228
425
  type?: string;
229
426
  };
230
427
  }
428
+ export interface InstallationJob {
429
+ id?: /**
430
+ * ID of an installation job
431
+ * example:
432
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
433
+ */
434
+ InstallationJobID;
435
+ source_blueprint_id?: /**
436
+ * ID of a blueprint
437
+ * example:
438
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
439
+ */
440
+ BlueprintID;
441
+ source_blueprint_type?: "file" | "marketplace" | "deploy" | "app";
442
+ source_org_id?: string;
443
+ destination_blueprint_id?: /**
444
+ * ID of a blueprint
445
+ * example:
446
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
447
+ */
448
+ BlueprintID;
449
+ destination_org_id?: string;
450
+ status?: "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
451
+ triggered_at?: string; // date-time
452
+ created_by?: CallerIdentity;
453
+ updated_by?: CallerIdentity;
454
+ }
455
+ export interface InstallationJobEvent {
456
+ timestamp?: string; // date-time
457
+ message?: string;
458
+ level?: "info" | "warning" | "error";
459
+ data?: {
460
+ [name: string]: any;
461
+ };
462
+ }
463
+ /**
464
+ * ID of an installation job
465
+ * example:
466
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
467
+ */
468
+ export type InstallationJobID = string;
469
+ export interface InstalledBlueprintResource {
470
+ id: /**
471
+ * ID of a blueprint resource
472
+ * example:
473
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
474
+ */
475
+ BlueprintResourceID;
476
+ name?: string;
477
+ type: /* Type of the resource */ ResourceNodeType;
478
+ address?: string;
479
+ /**
480
+ * 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
481
+ */
482
+ is_ready?: boolean;
483
+ impact_on_install?: "create" | "update" | "no-op" | "delete";
484
+ }
231
485
  export interface Job {
232
486
  job_id?: /**
233
487
  * ID of an import or export job (state machine)
@@ -704,6 +958,43 @@ declare namespace Components {
704
958
  */
705
959
  updated_at?: string; // date-time
706
960
  }
961
+ export interface MarketplaceBlueprint {
962
+ id?: /**
963
+ * ID of a blueprint
964
+ * example:
965
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
966
+ */
967
+ BlueprintID;
968
+ title: string;
969
+ slug?: string;
970
+ description?: {
971
+ /**
972
+ * Markdown content shown before starting to install the blueprint
973
+ * example:
974
+ * This is the content of the preinstall.md file which contains the blueprint description.
975
+ *
976
+ */
977
+ preinstall?: string;
978
+ /**
979
+ * Markdown content to be displayed when showing the plan to install blueprint
980
+ * example:
981
+ * This is the content of the postinstall.md file
982
+ *
983
+ */
984
+ postinstall?: string;
985
+ };
986
+ version?: string;
987
+ /**
988
+ * URL to the blueprint documentation
989
+ */
990
+ docs_url?: string;
991
+ /**
992
+ * Whether the blueprint is verified by epilot
993
+ */
994
+ is_verified?: boolean;
995
+ source_type?: "marketplace";
996
+ resources?: InstalledBlueprintResource[];
997
+ }
707
998
  export type PlanChanges = ("create" | "update" | "no-op" | "delete")[];
708
999
  export interface PutManifestPayload {
709
1000
  /**
@@ -866,6 +1157,32 @@ declare namespace Components {
866
1157
  }
867
1158
  }
868
1159
  declare namespace Paths {
1160
+ namespace AddBlueprintResource {
1161
+ namespace Parameters {
1162
+ /**
1163
+ * Whether to add this resource dependencies to the blueprint automatically
1164
+ */
1165
+ export type AddDependencies = boolean;
1166
+ export type BlueprintId = /**
1167
+ * ID of a blueprint
1168
+ * example:
1169
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1170
+ */
1171
+ Components.Schemas.BlueprintID;
1172
+ }
1173
+ export interface PathParameters {
1174
+ blueprint_id: Parameters.BlueprintId;
1175
+ }
1176
+ export interface QueryParameters {
1177
+ add_dependencies?: /* Whether to add this resource dependencies to the blueprint automatically */ Parameters.AddDependencies;
1178
+ }
1179
+ export type RequestBody = Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource;
1180
+ namespace Responses {
1181
+ export interface $200 {
1182
+ resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1183
+ }
1184
+ }
1185
+ }
869
1186
  namespace ApplyPlan {
870
1187
  namespace Parameters {
871
1188
  export type JobId = /**
@@ -899,6 +1216,97 @@ declare namespace Paths {
899
1216
  }
900
1217
  }
901
1218
  }
1219
+ namespace BulkAddBlueprintResources {
1220
+ namespace Parameters {
1221
+ /**
1222
+ * Whether to add this resource dependencies to the blueprint automatically
1223
+ */
1224
+ export type AddDependencies = boolean;
1225
+ export type BlueprintId = /**
1226
+ * ID of a blueprint
1227
+ * example:
1228
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1229
+ */
1230
+ Components.Schemas.BlueprintID;
1231
+ }
1232
+ export interface PathParameters {
1233
+ blueprint_id: Parameters.BlueprintId;
1234
+ }
1235
+ export interface QueryParameters {
1236
+ add_dependencies?: /* Whether to add this resource dependencies to the blueprint automatically */ Parameters.AddDependencies;
1237
+ }
1238
+ export type RequestBody = (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1239
+ namespace Responses {
1240
+ export interface $200 {
1241
+ resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1242
+ }
1243
+ }
1244
+ }
1245
+ namespace BulkDeleteBlueprintResources {
1246
+ namespace Parameters {
1247
+ export type BlueprintId = /**
1248
+ * ID of a blueprint
1249
+ * example:
1250
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1251
+ */
1252
+ Components.Schemas.BlueprintID;
1253
+ }
1254
+ export interface PathParameters {
1255
+ blueprint_id: Parameters.BlueprintId;
1256
+ }
1257
+ export type RequestBody = /**
1258
+ * ID of a blueprint resource
1259
+ * example:
1260
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1261
+ */
1262
+ Components.Schemas.BlueprintResourceID[];
1263
+ namespace Responses {
1264
+ export interface $200 {
1265
+ resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1266
+ }
1267
+ }
1268
+ }
1269
+ namespace BulkUpdateBlueprintResources {
1270
+ namespace Parameters {
1271
+ export type BlueprintId = /**
1272
+ * ID of a blueprint
1273
+ * example:
1274
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1275
+ */
1276
+ Components.Schemas.BlueprintID;
1277
+ }
1278
+ export interface PathParameters {
1279
+ blueprint_id: Parameters.BlueprintId;
1280
+ }
1281
+ export type RequestBody = (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1282
+ namespace Responses {
1283
+ export interface $200 {
1284
+ resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1285
+ }
1286
+ }
1287
+ }
1288
+ namespace ContinueInstallationJob {
1289
+ namespace Parameters {
1290
+ export type JobId = /**
1291
+ * ID of an installation job
1292
+ * example:
1293
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1294
+ */
1295
+ Components.Schemas.InstallationJobID;
1296
+ }
1297
+ export interface PathParameters {
1298
+ job_id: Parameters.JobId;
1299
+ }
1300
+ namespace Responses {
1301
+ export type $200 = Components.Schemas.InstallationJob;
1302
+ }
1303
+ }
1304
+ namespace CreateBlueprint {
1305
+ export type RequestBody = Components.Schemas.CommonBlueprintFields;
1306
+ namespace Responses {
1307
+ export type $200 = Components.Schemas.CustomBlueprint;
1308
+ }
1309
+ }
902
1310
  namespace CreateExport {
903
1311
  export interface RequestBody {
904
1312
  resources: [
@@ -941,15 +1349,43 @@ declare namespace Paths {
941
1349
  }
942
1350
  }
943
1351
  }
944
- namespace CreatePlan {
945
- export type RequestBody = {
1352
+ namespace CreateInstallationJob {
1353
+ export interface RequestBody {
1354
+ source_blueprint_id: /**
1355
+ * ID of a blueprint
1356
+ * example:
1357
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1358
+ */
1359
+ Components.Schemas.BlueprintID;
946
1360
  /**
947
- * s3ref of manifest file uploaded via `uploadManifest`
1361
+ * Destination organization ID
948
1362
  */
949
- s3ref: {
950
- /**
1363
+ destination_org_id: string;
1364
+ /**
1365
+ * Installation mode
1366
+ */
1367
+ mode: "simple" | "advanced";
1368
+ }
1369
+ namespace Responses {
1370
+ export interface $202 {
1371
+ job_id?: /**
1372
+ * ID of an installation job
951
1373
  * example:
952
- * blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
1374
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1375
+ */
1376
+ Components.Schemas.InstallationJobID;
1377
+ }
1378
+ }
1379
+ }
1380
+ namespace CreatePlan {
1381
+ export type RequestBody = {
1382
+ /**
1383
+ * s3ref of manifest file uploaded via `uploadManifest`
1384
+ */
1385
+ s3ref: {
1386
+ /**
1387
+ * example:
1388
+ * blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
953
1389
  */
954
1390
  bucket: string;
955
1391
  /**
@@ -1032,6 +1468,31 @@ declare namespace Paths {
1032
1468
  }
1033
1469
  }
1034
1470
  }
1471
+ namespace DeleteBlueprintResource {
1472
+ namespace Parameters {
1473
+ export type BlueprintId = /**
1474
+ * ID of a blueprint
1475
+ * example:
1476
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1477
+ */
1478
+ Components.Schemas.BlueprintID;
1479
+ export type ResourceId = /**
1480
+ * ID of a blueprint resource
1481
+ * example:
1482
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1483
+ */
1484
+ Components.Schemas.BlueprintResourceID;
1485
+ }
1486
+ export interface PathParameters {
1487
+ blueprint_id: Parameters.BlueprintId;
1488
+ resource_id: Parameters.ResourceId;
1489
+ }
1490
+ namespace Responses {
1491
+ export interface $200 {
1492
+ resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1493
+ }
1494
+ }
1495
+ }
1035
1496
  namespace DeleteManifest {
1036
1497
  namespace Parameters {
1037
1498
  export type ManifestId = /**
@@ -1048,6 +1509,24 @@ declare namespace Paths {
1048
1509
  export type $200 = Components.Schemas.Manifest;
1049
1510
  }
1050
1511
  }
1512
+ namespace ExportBlueprint {
1513
+ namespace Parameters {
1514
+ export type BlueprintId = /**
1515
+ * ID of a blueprint
1516
+ * example:
1517
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1518
+ */
1519
+ Components.Schemas.BlueprintID;
1520
+ }
1521
+ export interface PathParameters {
1522
+ blueprint_id: Parameters.BlueprintId;
1523
+ }
1524
+ namespace Responses {
1525
+ export interface $200 {
1526
+ url?: string;
1527
+ }
1528
+ }
1529
+ }
1051
1530
  namespace ExportManifest {
1052
1531
  namespace Parameters {
1053
1532
  export type JobId = /**
@@ -1099,6 +1578,63 @@ declare namespace Paths {
1099
1578
  }
1100
1579
  }
1101
1580
  }
1581
+ namespace GetBlueprint {
1582
+ namespace Parameters {
1583
+ export type BlueprintId = /**
1584
+ * ID of a blueprint
1585
+ * example:
1586
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1587
+ */
1588
+ Components.Schemas.BlueprintID;
1589
+ }
1590
+ export interface PathParameters {
1591
+ blueprint_id: Parameters.BlueprintId;
1592
+ }
1593
+ namespace Responses {
1594
+ export type $200 = Components.Schemas.Blueprint;
1595
+ }
1596
+ }
1597
+ namespace GetInstallationJob {
1598
+ namespace Parameters {
1599
+ export type JobId = /**
1600
+ * ID of an installation job
1601
+ * example:
1602
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1603
+ */
1604
+ Components.Schemas.InstallationJobID;
1605
+ }
1606
+ export interface PathParameters {
1607
+ job_id: Parameters.JobId;
1608
+ }
1609
+ namespace Responses {
1610
+ export type $200 = Components.Schemas.InstallationJob;
1611
+ }
1612
+ }
1613
+ namespace GetInstallationJobEvents {
1614
+ namespace Parameters {
1615
+ export type JobId = /**
1616
+ * ID of an installation job
1617
+ * example:
1618
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1619
+ */
1620
+ Components.Schemas.InstallationJobID;
1621
+ }
1622
+ export interface PathParameters {
1623
+ job_id: Parameters.JobId;
1624
+ }
1625
+ namespace Responses {
1626
+ export interface $200 {
1627
+ created_at?: string; // date-time
1628
+ status?: "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
1629
+ errors?: Components.Schemas.FormattedError[];
1630
+ /**
1631
+ * Progress completion (0-100)
1632
+ */
1633
+ progress?: number; // float
1634
+ events?: Components.Schemas.InstallationJobEvent[];
1635
+ }
1636
+ }
1637
+ }
1102
1638
  namespace GetJob {
1103
1639
  namespace Parameters {
1104
1640
  export type JobId = /**
@@ -1131,6 +1667,11 @@ declare namespace Paths {
1131
1667
  export type $200 = Components.Schemas.Manifest;
1132
1668
  }
1133
1669
  }
1670
+ namespace ListBlueprints {
1671
+ namespace Responses {
1672
+ export type $200 = Components.Schemas.Blueprint[];
1673
+ }
1674
+ }
1134
1675
  namespace ListInstalledManifests {
1135
1676
  namespace Responses {
1136
1677
  export interface $200 {
@@ -1143,6 +1684,74 @@ declare namespace Paths {
1143
1684
  }
1144
1685
  }
1145
1686
  }
1687
+ namespace SyncDependencies {
1688
+ namespace Parameters {
1689
+ export type BlueprintId = /**
1690
+ * ID of a blueprint
1691
+ * example:
1692
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1693
+ */
1694
+ Components.Schemas.BlueprintID;
1695
+ export type ResourceId = /**
1696
+ * ID of a blueprint resource
1697
+ * example:
1698
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1699
+ */
1700
+ Components.Schemas.BlueprintResourceID;
1701
+ }
1702
+ export interface PathParameters {
1703
+ blueprint_id: Parameters.BlueprintId;
1704
+ resource_id: Parameters.ResourceId;
1705
+ }
1706
+ namespace Responses {
1707
+ export interface $200 {
1708
+ resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1709
+ }
1710
+ }
1711
+ }
1712
+ namespace UpdateBlueprint {
1713
+ namespace Parameters {
1714
+ export type BlueprintId = /**
1715
+ * ID of a blueprint
1716
+ * example:
1717
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1718
+ */
1719
+ Components.Schemas.BlueprintID;
1720
+ }
1721
+ export interface PathParameters {
1722
+ blueprint_id: Parameters.BlueprintId;
1723
+ }
1724
+ export type RequestBody = Components.Schemas.CommonBlueprintFields;
1725
+ namespace Responses {
1726
+ export type $200 = Components.Schemas.Blueprint;
1727
+ }
1728
+ }
1729
+ namespace UpdateBlueprintResource {
1730
+ namespace Parameters {
1731
+ export type BlueprintId = /**
1732
+ * ID of a blueprint
1733
+ * example:
1734
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1735
+ */
1736
+ Components.Schemas.BlueprintID;
1737
+ export type ResourceId = /**
1738
+ * ID of a blueprint resource
1739
+ * example:
1740
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1741
+ */
1742
+ Components.Schemas.BlueprintResourceID;
1743
+ }
1744
+ export interface PathParameters {
1745
+ blueprint_id: Parameters.BlueprintId;
1746
+ resource_id: Parameters.ResourceId;
1747
+ }
1748
+ export type RequestBody = Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource;
1749
+ namespace Responses {
1750
+ export interface $200 {
1751
+ resources?: (Components.Schemas.EditableBlueprintResource | Components.Schemas.InstalledBlueprintResource)[];
1752
+ }
1753
+ }
1754
+ }
1146
1755
  namespace UpdateManifest {
1147
1756
  namespace Parameters {
1148
1757
  export type ManifestId = /**
@@ -1173,9 +1782,21 @@ declare namespace Paths {
1173
1782
  }
1174
1783
  }
1175
1784
  }
1785
+ namespace V2BlueprintManifestInstallations$JobIdCancel {
1786
+ namespace Parameters {
1787
+ export type JobId = /**
1788
+ * ID of an installation job
1789
+ * example:
1790
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1791
+ */
1792
+ Components.Schemas.InstallationJobID;
1793
+ }
1794
+ export interface PathParameters {
1795
+ job_id: Parameters.JobId;
1796
+ }
1797
+ }
1176
1798
  }
1177
1799
 
1178
-
1179
1800
  export interface OperationMethods {
1180
1801
  /**
1181
1802
  * getJob - getJob
@@ -1288,6 +1909,167 @@ export interface OperationMethods {
1288
1909
  data?: any,
1289
1910
  config?: AxiosRequestConfig
1290
1911
  ): OperationResponse<Paths.DeleteManifest.Responses.$200>
1912
+ /**
1913
+ * listBlueprints - listBlueprints
1914
+ *
1915
+ * List Custom and Installed Blueprints
1916
+ */
1917
+ 'listBlueprints'(
1918
+ parameters?: Parameters<UnknownParamsObject> | null,
1919
+ data?: any,
1920
+ config?: AxiosRequestConfig
1921
+ ): OperationResponse<Paths.ListBlueprints.Responses.$200>
1922
+ /**
1923
+ * createBlueprint - createBlueprint
1924
+ *
1925
+ * Create a Blueprint
1926
+ */
1927
+ 'createBlueprint'(
1928
+ parameters?: Parameters<UnknownParamsObject> | null,
1929
+ data?: Paths.CreateBlueprint.RequestBody,
1930
+ config?: AxiosRequestConfig
1931
+ ): OperationResponse<Paths.CreateBlueprint.Responses.$200>
1932
+ /**
1933
+ * getBlueprint - getBlueprint
1934
+ *
1935
+ * Get Blueprint by ID
1936
+ */
1937
+ 'getBlueprint'(
1938
+ parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
1939
+ data?: any,
1940
+ config?: AxiosRequestConfig
1941
+ ): OperationResponse<Paths.GetBlueprint.Responses.$200>
1942
+ /**
1943
+ * updateBlueprint - updateBlueprint
1944
+ *
1945
+ * Update a Blueprint
1946
+ */
1947
+ 'updateBlueprint'(
1948
+ parameters?: Parameters<Paths.UpdateBlueprint.PathParameters> | null,
1949
+ data?: Paths.UpdateBlueprint.RequestBody,
1950
+ config?: AxiosRequestConfig
1951
+ ): OperationResponse<Paths.UpdateBlueprint.Responses.$200>
1952
+ /**
1953
+ * exportBlueprint - exportBlueprint
1954
+ *
1955
+ * Zip the blueprint content and return the url to download it
1956
+ */
1957
+ 'exportBlueprint'(
1958
+ parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
1959
+ data?: any,
1960
+ config?: AxiosRequestConfig
1961
+ ): OperationResponse<Paths.ExportBlueprint.Responses.$200>
1962
+ /**
1963
+ * addBlueprintResource - addBlueprintResource
1964
+ *
1965
+ * Add a resource to a Blueprint
1966
+ */
1967
+ 'addBlueprintResource'(
1968
+ parameters?: Parameters<Paths.AddBlueprintResource.QueryParameters & Paths.AddBlueprintResource.PathParameters> | null,
1969
+ data?: Paths.AddBlueprintResource.RequestBody,
1970
+ config?: AxiosRequestConfig
1971
+ ): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
1972
+ /**
1973
+ * bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
1974
+ *
1975
+ * Bulk update resources in a Blueprint
1976
+ */
1977
+ 'bulkUpdateBlueprintResources'(
1978
+ parameters?: Parameters<Paths.BulkUpdateBlueprintResources.PathParameters> | null,
1979
+ data?: Paths.BulkUpdateBlueprintResources.RequestBody,
1980
+ config?: AxiosRequestConfig
1981
+ ): OperationResponse<Paths.BulkUpdateBlueprintResources.Responses.$200>
1982
+ /**
1983
+ * bulkAddBlueprintResources - bulkAddBlueprintResources
1984
+ *
1985
+ * Bulk Add resources in a Blueprint
1986
+ */
1987
+ 'bulkAddBlueprintResources'(
1988
+ parameters?: Parameters<Paths.BulkAddBlueprintResources.QueryParameters & Paths.BulkAddBlueprintResources.PathParameters> | null,
1989
+ data?: Paths.BulkAddBlueprintResources.RequestBody,
1990
+ config?: AxiosRequestConfig
1991
+ ): OperationResponse<Paths.BulkAddBlueprintResources.Responses.$200>
1992
+ /**
1993
+ * bulkDeleteBlueprintResources - bulkDeleteBlueprintResources
1994
+ *
1995
+ * Bulk delete resources in a Blueprint
1996
+ */
1997
+ 'bulkDeleteBlueprintResources'(
1998
+ parameters?: Parameters<Paths.BulkDeleteBlueprintResources.PathParameters> | null,
1999
+ data?: Paths.BulkDeleteBlueprintResources.RequestBody,
2000
+ config?: AxiosRequestConfig
2001
+ ): OperationResponse<Paths.BulkDeleteBlueprintResources.Responses.$200>
2002
+ /**
2003
+ * updateBlueprintResource - updateBlueprintResource
2004
+ *
2005
+ * Update a resource in a Blueprint
2006
+ */
2007
+ 'updateBlueprintResource'(
2008
+ parameters?: Parameters<Paths.UpdateBlueprintResource.PathParameters> | null,
2009
+ data?: Paths.UpdateBlueprintResource.RequestBody,
2010
+ config?: AxiosRequestConfig
2011
+ ): OperationResponse<Paths.UpdateBlueprintResource.Responses.$200>
2012
+ /**
2013
+ * deleteBlueprintResource - deleteBlueprintResource
2014
+ *
2015
+ * Delete a resource from a Blueprint
2016
+ */
2017
+ 'deleteBlueprintResource'(
2018
+ parameters?: Parameters<Paths.DeleteBlueprintResource.PathParameters> | null,
2019
+ data?: any,
2020
+ config?: AxiosRequestConfig
2021
+ ): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
2022
+ /**
2023
+ * syncDependencies - syncDependencies
2024
+ *
2025
+ * Sync dependencies of a resource in a Blueprint
2026
+ */
2027
+ 'syncDependencies'(
2028
+ parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
2029
+ data?: any,
2030
+ config?: AxiosRequestConfig
2031
+ ): OperationResponse<Paths.SyncDependencies.Responses.$200>
2032
+ /**
2033
+ * createInstallationJob - Create Installation Job
2034
+ *
2035
+ * Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.
2036
+ *
2037
+ */
2038
+ 'createInstallationJob'(
2039
+ parameters?: Parameters<UnknownParamsObject> | null,
2040
+ data?: Paths.CreateInstallationJob.RequestBody,
2041
+ config?: AxiosRequestConfig
2042
+ ): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
2043
+ /**
2044
+ * getInstallationJob - Get Installation Job
2045
+ *
2046
+ * Poll current state of an installation job.
2047
+ */
2048
+ 'getInstallationJob'(
2049
+ parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
2050
+ data?: any,
2051
+ config?: AxiosRequestConfig
2052
+ ): OperationResponse<Paths.GetInstallationJob.Responses.$200>
2053
+ /**
2054
+ * continueInstallationJob - Continue Installation Job
2055
+ *
2056
+ * Continue an installation job if it is waiting for user action.
2057
+ */
2058
+ 'continueInstallationJob'(
2059
+ parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
2060
+ data?: any,
2061
+ config?: AxiosRequestConfig
2062
+ ): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
2063
+ /**
2064
+ * getInstallationJobEvents - Get Installation Job Events
2065
+ *
2066
+ * Event log for an installation job.
2067
+ */
2068
+ 'getInstallationJobEvents'(
2069
+ parameters?: Parameters<Paths.GetInstallationJobEvents.PathParameters> | null,
2070
+ data?: any,
2071
+ config?: AxiosRequestConfig
2072
+ ): OperationResponse<Paths.GetInstallationJobEvents.Responses.$200>
1291
2073
  }
1292
2074
 
1293
2075
  export interface PathsDictionary {
@@ -1418,20 +2200,218 @@ export interface PathsDictionary {
1418
2200
  config?: AxiosRequestConfig
1419
2201
  ): OperationResponse<Paths.DeleteManifest.Responses.$200>
1420
2202
  }
2203
+ ['/v2/blueprint-manifest/blueprints']: {
2204
+ /**
2205
+ * listBlueprints - listBlueprints
2206
+ *
2207
+ * List Custom and Installed Blueprints
2208
+ */
2209
+ 'get'(
2210
+ parameters?: Parameters<UnknownParamsObject> | null,
2211
+ data?: any,
2212
+ config?: AxiosRequestConfig
2213
+ ): OperationResponse<Paths.ListBlueprints.Responses.$200>
2214
+ /**
2215
+ * createBlueprint - createBlueprint
2216
+ *
2217
+ * Create a Blueprint
2218
+ */
2219
+ 'post'(
2220
+ parameters?: Parameters<UnknownParamsObject> | null,
2221
+ data?: Paths.CreateBlueprint.RequestBody,
2222
+ config?: AxiosRequestConfig
2223
+ ): OperationResponse<Paths.CreateBlueprint.Responses.$200>
2224
+ }
2225
+ ['/v2/blueprint-manifest/blueprints/{blueprint_id}']: {
2226
+ /**
2227
+ * getBlueprint - getBlueprint
2228
+ *
2229
+ * Get Blueprint by ID
2230
+ */
2231
+ 'get'(
2232
+ parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
2233
+ data?: any,
2234
+ config?: AxiosRequestConfig
2235
+ ): OperationResponse<Paths.GetBlueprint.Responses.$200>
2236
+ /**
2237
+ * updateBlueprint - updateBlueprint
2238
+ *
2239
+ * Update a Blueprint
2240
+ */
2241
+ 'put'(
2242
+ parameters?: Parameters<Paths.UpdateBlueprint.PathParameters> | null,
2243
+ data?: Paths.UpdateBlueprint.RequestBody,
2244
+ config?: AxiosRequestConfig
2245
+ ): OperationResponse<Paths.UpdateBlueprint.Responses.$200>
2246
+ }
2247
+ ['/v2/blueprint-manifest/blueprints/{blueprint_id}:export']: {
2248
+ /**
2249
+ * exportBlueprint - exportBlueprint
2250
+ *
2251
+ * Zip the blueprint content and return the url to download it
2252
+ */
2253
+ 'post'(
2254
+ parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
2255
+ data?: any,
2256
+ config?: AxiosRequestConfig
2257
+ ): OperationResponse<Paths.ExportBlueprint.Responses.$200>
2258
+ }
2259
+ ['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources']: {
2260
+ /**
2261
+ * addBlueprintResource - addBlueprintResource
2262
+ *
2263
+ * Add a resource to a Blueprint
2264
+ */
2265
+ 'post'(
2266
+ parameters?: Parameters<Paths.AddBlueprintResource.QueryParameters & Paths.AddBlueprintResource.PathParameters> | null,
2267
+ data?: Paths.AddBlueprintResource.RequestBody,
2268
+ config?: AxiosRequestConfig
2269
+ ): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
2270
+ }
2271
+ ['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk']: {
2272
+ /**
2273
+ * bulkAddBlueprintResources - bulkAddBlueprintResources
2274
+ *
2275
+ * Bulk Add resources in a Blueprint
2276
+ */
2277
+ 'post'(
2278
+ parameters?: Parameters<Paths.BulkAddBlueprintResources.QueryParameters & Paths.BulkAddBlueprintResources.PathParameters> | null,
2279
+ data?: Paths.BulkAddBlueprintResources.RequestBody,
2280
+ config?: AxiosRequestConfig
2281
+ ): OperationResponse<Paths.BulkAddBlueprintResources.Responses.$200>
2282
+ /**
2283
+ * bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
2284
+ *
2285
+ * Bulk update resources in a Blueprint
2286
+ */
2287
+ 'put'(
2288
+ parameters?: Parameters<Paths.BulkUpdateBlueprintResources.PathParameters> | null,
2289
+ data?: Paths.BulkUpdateBlueprintResources.RequestBody,
2290
+ config?: AxiosRequestConfig
2291
+ ): OperationResponse<Paths.BulkUpdateBlueprintResources.Responses.$200>
2292
+ /**
2293
+ * bulkDeleteBlueprintResources - bulkDeleteBlueprintResources
2294
+ *
2295
+ * Bulk delete resources in a Blueprint
2296
+ */
2297
+ 'delete'(
2298
+ parameters?: Parameters<Paths.BulkDeleteBlueprintResources.PathParameters> | null,
2299
+ data?: Paths.BulkDeleteBlueprintResources.RequestBody,
2300
+ config?: AxiosRequestConfig
2301
+ ): OperationResponse<Paths.BulkDeleteBlueprintResources.Responses.$200>
2302
+ }
2303
+ ['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}']: {
2304
+ /**
2305
+ * updateBlueprintResource - updateBlueprintResource
2306
+ *
2307
+ * Update a resource in a Blueprint
2308
+ */
2309
+ 'put'(
2310
+ parameters?: Parameters<Paths.UpdateBlueprintResource.PathParameters> | null,
2311
+ data?: Paths.UpdateBlueprintResource.RequestBody,
2312
+ config?: AxiosRequestConfig
2313
+ ): OperationResponse<Paths.UpdateBlueprintResource.Responses.$200>
2314
+ /**
2315
+ * deleteBlueprintResource - deleteBlueprintResource
2316
+ *
2317
+ * Delete a resource from a Blueprint
2318
+ */
2319
+ 'delete'(
2320
+ parameters?: Parameters<Paths.DeleteBlueprintResource.PathParameters> | null,
2321
+ data?: any,
2322
+ config?: AxiosRequestConfig
2323
+ ): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
2324
+ }
2325
+ ['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}:syncDependencies']: {
2326
+ /**
2327
+ * syncDependencies - syncDependencies
2328
+ *
2329
+ * Sync dependencies of a resource in a Blueprint
2330
+ */
2331
+ 'post'(
2332
+ parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
2333
+ data?: any,
2334
+ config?: AxiosRequestConfig
2335
+ ): OperationResponse<Paths.SyncDependencies.Responses.$200>
2336
+ }
2337
+ ['/v2/blueprint-manifest/installations']: {
2338
+ /**
2339
+ * createInstallationJob - Create Installation Job
2340
+ *
2341
+ * Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.
2342
+ *
2343
+ */
2344
+ 'post'(
2345
+ parameters?: Parameters<UnknownParamsObject> | null,
2346
+ data?: Paths.CreateInstallationJob.RequestBody,
2347
+ config?: AxiosRequestConfig
2348
+ ): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
2349
+ }
2350
+ ['/v2/blueprint-manifest/installations/{job_id}']: {
2351
+ /**
2352
+ * getInstallationJob - Get Installation Job
2353
+ *
2354
+ * Poll current state of an installation job.
2355
+ */
2356
+ 'get'(
2357
+ parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
2358
+ data?: any,
2359
+ config?: AxiosRequestConfig
2360
+ ): OperationResponse<Paths.GetInstallationJob.Responses.$200>
2361
+ }
2362
+ ['/v2/blueprint-manifest/installations/{job_id}:continue']: {
2363
+ /**
2364
+ * continueInstallationJob - Continue Installation Job
2365
+ *
2366
+ * Continue an installation job if it is waiting for user action.
2367
+ */
2368
+ 'post'(
2369
+ parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
2370
+ data?: any,
2371
+ config?: AxiosRequestConfig
2372
+ ): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
2373
+ }
2374
+ ['/v2/blueprint-manifest/installations/{job_id}:cancel']: {
2375
+ }
2376
+ ['/v2/blueprint-manifest/installations/{job_id}/events']: {
2377
+ /**
2378
+ * getInstallationJobEvents - Get Installation Job Events
2379
+ *
2380
+ * Event log for an installation job.
2381
+ */
2382
+ 'get'(
2383
+ parameters?: Parameters<Paths.GetInstallationJobEvents.PathParameters> | null,
2384
+ data?: any,
2385
+ config?: AxiosRequestConfig
2386
+ ): OperationResponse<Paths.GetInstallationJobEvents.Responses.$200>
2387
+ }
1421
2388
  }
1422
2389
 
1423
2390
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1424
2391
 
1425
-
2392
+ export type AppBlueprint = Components.Schemas.AppBlueprint;
2393
+ export type Blueprint = Components.Schemas.Blueprint;
2394
+ export type BlueprintID = Components.Schemas.BlueprintID;
1426
2395
  export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
2396
+ export type BlueprintResource = Components.Schemas.BlueprintResource;
2397
+ export type BlueprintResourceID = Components.Schemas.BlueprintResourceID;
1427
2398
  export type CallerIdentity = Components.Schemas.CallerIdentity;
2399
+ export type CommonBlueprintFields = Components.Schemas.CommonBlueprintFields;
1428
2400
  export type CommonImportFields = Components.Schemas.CommonImportFields;
1429
2401
  export type CommonManifestFields = Components.Schemas.CommonManifestFields;
1430
2402
  export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
1431
2403
  export type CommonResourceNode = Components.Schemas.CommonResourceNode;
2404
+ export type CustomBlueprint = Components.Schemas.CustomBlueprint;
2405
+ export type DeployedBlueprint = Components.Schemas.DeployedBlueprint;
2406
+ export type EditableBlueprintResource = Components.Schemas.EditableBlueprintResource;
2407
+ export type FileBlueprint = Components.Schemas.FileBlueprint;
1432
2408
  export type FormattedError = Components.Schemas.FormattedError;
1433
2409
  export type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
1434
2410
  export type FormattedErrorData = Components.Schemas.FormattedErrorData;
2411
+ export type InstallationJob = Components.Schemas.InstallationJob;
2412
+ export type InstallationJobEvent = Components.Schemas.InstallationJobEvent;
2413
+ export type InstallationJobID = Components.Schemas.InstallationJobID;
2414
+ export type InstalledBlueprintResource = Components.Schemas.InstalledBlueprintResource;
1435
2415
  export type Job = Components.Schemas.Job;
1436
2416
  export type JobID = Components.Schemas.JobID;
1437
2417
  export type JobStatus = Components.Schemas.JobStatus;
@@ -1440,6 +2420,7 @@ export type ManifestID = Components.Schemas.ManifestID;
1440
2420
  export type ManifestItem = Components.Schemas.ManifestItem;
1441
2421
  export type ManifestSource = Components.Schemas.ManifestSource;
1442
2422
  export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
2423
+ export type MarketplaceBlueprint = Components.Schemas.MarketplaceBlueprint;
1443
2424
  export type PlanChanges = Components.Schemas.PlanChanges;
1444
2425
  export type PutManifestPayload = Components.Schemas.PutManifestPayload;
1445
2426
  export type ResourceNode = Components.Schemas.ResourceNode;