@epilot/blueprint-manifest-client 3.0.0-beta.1 → 3.0.0-beta.2

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 ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 epilot GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,n){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=r(n(240));t.default=s.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://blueprint-manifest.sls.epilot.io"}],"paths":{"/v1/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getJob","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest:uploadManifest":{"post":{"operationId":"uploadManifest","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs:createPlan":{"post":{"operationId":"createPlan","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints":{"get":{"operationId":"listBlueprints","responses":{}},"post":{"operationId":"createBlueprint","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}":{"get":{"operationId":"getBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}},"put":{"operationId":"updateBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}:export":{"post":{"operationId":"exportBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources":{"post":{"operationId":"addBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies":{"post":{"operationId":"syncDependencies","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk":{"post":{"operationId":"bulkAddBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"bulkUpdateBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"bulkDeleteBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}":{"put":{"operationId":"updateBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"responses":{}}},"/v2/blueprint-manifest/installations":{"post":{"operationId":"createInstallationJob","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/installations/{job_id}":{"get":{"operationId":"getInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/installations/{job_id}:continue":{"post":{"operationId":"continueInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/installations/{job_id}:cancel":{"operationId":"cancelInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{"200":{"description":"Installation job cancelled","content":{"application/json":{}}}}},"/v2/blueprint-manifest/installations/{job_id}/events":{"get":{"operationId":"getInstallationJobEvents","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')}},t={},n=function n(r){var s=t[r];if(void 0!==s)return s.exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,n),i.exports}(914),r=exports;for(var s in n)r[s]=n[s];n.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://blueprint-manifest.sls.epilot.io"}],"paths":{"/v1/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getJob","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest:uploadManifest":{"post":{"operationId":"uploadManifest","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs:createPlan":{"post":{"operationId":"createPlan","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints":{"get":{"operationId":"listBlueprints","responses":{}},"post":{"operationId":"createBlueprint","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprint:install":{"post":{"operationId":"installBlueprint","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}":{"get":{"operationId":"getBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}},"put":{"operationId":"updateBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}:export":{"post":{"operationId":"exportBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources":{"post":{"operationId":"addBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies":{"post":{"operationId":"syncDependencies","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk":{"post":{"operationId":"bulkAddBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"bulkUpdateBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"bulkDeleteBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}":{"put":{"operationId":"updateBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs":{"get":{"operationId":"listBlueprintJobs","responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:continue":{"post":{"operationId":"continueInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:cancel":{"operationId":"cancelBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{"200":{"description":"Blueprint job cancelled","content":{"application/json":{}}}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')},757:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=n(r(466));t.default=s.default}},t={},r=function r(n){var s=t[n];if(void 0!==s)return s.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,r),i.exports}(757),n=exports;for(var s in r)n[s]=r[s];r.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
@@ -147,6 +147,18 @@
147
147
  "responses": {}
148
148
  }
149
149
  },
150
+ "/v2/blueprint-manifest/blueprint:install": {
151
+ "post": {
152
+ "operationId": "installBlueprint",
153
+ "requestBody": {
154
+ "required": true,
155
+ "content": {
156
+ "application/json": {}
157
+ }
158
+ },
159
+ "responses": {}
160
+ }
161
+ },
150
162
  "/v2/blueprint-manifest/blueprints/{blueprint_id}": {
151
163
  "get": {
152
164
  "operationId": "getBlueprint",
@@ -328,21 +340,15 @@
328
340
  "responses": {}
329
341
  }
330
342
  },
331
- "/v2/blueprint-manifest/installations": {
332
- "post": {
333
- "operationId": "createInstallationJob",
334
- "requestBody": {
335
- "required": true,
336
- "content": {
337
- "application/json": {}
338
- }
339
- },
343
+ "/v2/blueprint-manifest/jobs": {
344
+ "get": {
345
+ "operationId": "listBlueprintJobs",
340
346
  "responses": {}
341
347
  }
342
348
  },
343
- "/v2/blueprint-manifest/installations/{job_id}": {
349
+ "/v2/blueprint-manifest/jobs/{job_id}": {
344
350
  "get": {
345
- "operationId": "getInstallationJob",
351
+ "operationId": "getBlueprintJob",
346
352
  "parameters": [
347
353
  {
348
354
  "in": "path",
@@ -353,7 +359,7 @@
353
359
  "responses": {}
354
360
  }
355
361
  },
356
- "/v2/blueprint-manifest/installations/{job_id}:continue": {
362
+ "/v2/blueprint-manifest/jobs/{job_id}:continue": {
357
363
  "post": {
358
364
  "operationId": "continueInstallationJob",
359
365
  "parameters": [
@@ -366,8 +372,8 @@
366
372
  "responses": {}
367
373
  }
368
374
  },
369
- "/v2/blueprint-manifest/installations/{job_id}:cancel": {
370
- "operationId": "cancelInstallationJob",
375
+ "/v2/blueprint-manifest/jobs/{job_id}:cancel": {
376
+ "operationId": "cancelBlueprintJob",
371
377
  "parameters": [
372
378
  {
373
379
  "in": "path",
@@ -377,25 +383,12 @@
377
383
  ],
378
384
  "responses": {
379
385
  "200": {
380
- "description": "Installation job cancelled",
386
+ "description": "Blueprint job cancelled",
381
387
  "content": {
382
388
  "application/json": {}
383
389
  }
384
390
  }
385
391
  }
386
- },
387
- "/v2/blueprint-manifest/installations/{job_id}/events": {
388
- "get": {
389
- "operationId": "getInstallationJobEvents",
390
- "parameters": [
391
- {
392
- "in": "path",
393
- "required": true,
394
- "name": "job_id"
395
- }
396
- ],
397
- "responses": {}
398
- }
399
392
  }
400
393
  },
401
394
  "components": {
package/dist/openapi.d.ts CHANGED
@@ -47,6 +47,7 @@ declare namespace Components {
47
47
  postinstall?: string;
48
48
  };
49
49
  version?: string;
50
+ latest_download_file?: S3Reference;
50
51
  created_at?: string; // date-time
51
52
  updated_at?: string; // date-time
52
53
  created_by?: CallerIdentity;
@@ -59,6 +60,25 @@ declare namespace Components {
59
60
  resources?: InstalledBlueprintResource[];
60
61
  }
61
62
  export type Blueprint = CustomBlueprint | FileBlueprint | MarketplaceBlueprint | DeployedBlueprint | AppBlueprint;
63
+ export interface BlueprintExportJob {
64
+ id?: /**
65
+ * ID of a job
66
+ * example:
67
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
68
+ */
69
+ BlueprintJobID;
70
+ events?: BlueprintJobEvent[];
71
+ triggered_at?: string; // date-time
72
+ created_by?: CallerIdentity;
73
+ blueprint_id?: /**
74
+ * ID of a blueprint
75
+ * example:
76
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
77
+ */
78
+ BlueprintID;
79
+ status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED";
80
+ download_file?: S3Reference;
81
+ }
62
82
  /**
63
83
  * ID of a blueprint
64
84
  * example:
@@ -66,6 +86,49 @@ declare namespace Components {
66
86
  */
67
87
  export type BlueprintID = string;
68
88
  export type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED";
89
+ export interface BlueprintInstallationJob {
90
+ id?: /**
91
+ * ID of a job
92
+ * example:
93
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
94
+ */
95
+ BlueprintJobID;
96
+ events?: BlueprintJobEvent[];
97
+ triggered_at?: string; // date-time
98
+ created_by?: CallerIdentity;
99
+ source_blueprint_id?: /**
100
+ * ID of a blueprint
101
+ * example:
102
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
103
+ */
104
+ BlueprintID;
105
+ source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app";
106
+ source_org_id?: string;
107
+ destination_blueprint_id?: /**
108
+ * ID of a blueprint
109
+ * example:
110
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
111
+ */
112
+ BlueprintID;
113
+ destination_org_id?: string;
114
+ status?: "IN_PROGRESS" | "WAITING_USER_ACTION" | "CANCELED" | "SUCCESS" | "FAILED";
115
+ }
116
+ export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob;
117
+ export interface BlueprintJobEvent {
118
+ timestamp?: string; // date-time
119
+ message?: string;
120
+ errors?: FormattedError[];
121
+ level?: "info" | "warning" | "error";
122
+ data?: {
123
+ [name: string]: any;
124
+ };
125
+ }
126
+ /**
127
+ * ID of a job
128
+ * example:
129
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
130
+ */
131
+ export type BlueprintJobID = string;
69
132
  export interface BlueprintResource {
70
133
  id: /**
71
134
  * ID of a blueprint resource
@@ -143,11 +206,23 @@ declare namespace Components {
143
206
  postinstall?: string;
144
207
  };
145
208
  version?: string;
209
+ latest_download_file?: S3Reference;
146
210
  created_at?: string; // date-time
147
211
  updated_at?: string; // date-time
148
212
  created_by?: CallerIdentity;
149
213
  updated_by?: CallerIdentity;
150
214
  }
215
+ export interface CommonBlueprintJobFields {
216
+ id?: /**
217
+ * ID of a job
218
+ * example:
219
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
220
+ */
221
+ BlueprintJobID;
222
+ events?: BlueprintJobEvent[];
223
+ triggered_at?: string; // date-time
224
+ created_by?: CallerIdentity;
225
+ }
151
226
  export interface CommonImportFields {
152
227
  source_type?: ManifestSource;
153
228
  /**
@@ -339,6 +414,7 @@ declare namespace Components {
339
414
  postinstall?: string;
340
415
  };
341
416
  version?: string;
417
+ latest_download_file?: S3Reference;
342
418
  created_at?: string; // date-time
343
419
  updated_at?: string; // date-time
344
420
  created_by?: CallerIdentity;
@@ -372,6 +448,7 @@ declare namespace Components {
372
448
  postinstall?: string;
373
449
  };
374
450
  version?: string;
451
+ latest_download_file?: S3Reference;
375
452
  created_at?: string; // date-time
376
453
  updated_at?: string; // date-time
377
454
  created_by?: CallerIdentity;
@@ -428,6 +505,7 @@ declare namespace Components {
428
505
  postinstall?: string;
429
506
  };
430
507
  version?: string;
508
+ latest_download_file?: S3Reference;
431
509
  created_at?: string; // date-time
432
510
  updated_at?: string; // date-time
433
511
  created_by?: CallerIdentity;
@@ -454,47 +532,6 @@ declare namespace Components {
454
532
  type?: string;
455
533
  };
456
534
  }
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
535
  export interface InstalledBlueprintResource {
499
536
  id: /**
500
537
  * ID of a blueprint resource
@@ -1017,6 +1054,7 @@ declare namespace Components {
1017
1054
  postinstall?: string;
1018
1055
  };
1019
1056
  version?: string;
1057
+ latest_download_file?: S3Reference;
1020
1058
  created_at?: string; // date-time
1021
1059
  updated_at?: string; // date-time
1022
1060
  created_by?: CallerIdentity;
@@ -1325,17 +1363,17 @@ declare namespace Paths {
1325
1363
  namespace ContinueInstallationJob {
1326
1364
  namespace Parameters {
1327
1365
  export type JobId = /**
1328
- * ID of an installation job
1366
+ * ID of a job
1329
1367
  * example:
1330
1368
  * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1331
1369
  */
1332
- Components.Schemas.InstallationJobID;
1370
+ Components.Schemas.BlueprintJobID;
1333
1371
  }
1334
1372
  export interface PathParameters {
1335
1373
  job_id: Parameters.JobId;
1336
1374
  }
1337
1375
  namespace Responses {
1338
- export type $200 = Components.Schemas.InstallationJob;
1376
+ export type $200 = Components.Schemas.BlueprintInstallationJob;
1339
1377
  }
1340
1378
  }
1341
1379
  namespace CreateBlueprint {
@@ -1386,34 +1424,6 @@ declare namespace Paths {
1386
1424
  }
1387
1425
  }
1388
1426
  }
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
1427
  namespace CreatePlan {
1418
1428
  export type RequestBody = {
1419
1429
  /**
@@ -1575,8 +1585,13 @@ declare namespace Paths {
1575
1585
  blueprint_id: Parameters.BlueprintId;
1576
1586
  }
1577
1587
  namespace Responses {
1578
- export interface $200 {
1579
- url?: string;
1588
+ export interface $202 {
1589
+ job_id?: /**
1590
+ * ID of a job
1591
+ * example:
1592
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1593
+ */
1594
+ Components.Schemas.BlueprintJobID;
1580
1595
  }
1581
1596
  }
1582
1597
  }
@@ -1647,45 +1662,20 @@ declare namespace Paths {
1647
1662
  export type $200 = Components.Schemas.Blueprint;
1648
1663
  }
1649
1664
  }
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 {
1665
+ namespace GetBlueprintJob {
1667
1666
  namespace Parameters {
1668
1667
  export type JobId = /**
1669
- * ID of an installation job
1668
+ * ID of a job
1670
1669
  * example:
1671
1670
  * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1672
1671
  */
1673
- Components.Schemas.InstallationJobID;
1672
+ Components.Schemas.BlueprintJobID;
1674
1673
  }
1675
1674
  export interface PathParameters {
1676
1675
  job_id: Parameters.JobId;
1677
1676
  }
1678
1677
  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
- }
1678
+ export type $200 = Components.Schemas.BlueprintJob;
1689
1679
  }
1690
1680
  }
1691
1681
  namespace GetJob {
@@ -1720,6 +1710,39 @@ declare namespace Paths {
1720
1710
  export type $200 = Components.Schemas.Manifest;
1721
1711
  }
1722
1712
  }
1713
+ namespace InstallBlueprint {
1714
+ export interface RequestBody {
1715
+ source_blueprint_id?: /**
1716
+ * ID of a blueprint
1717
+ * example:
1718
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1719
+ */
1720
+ Components.Schemas.BlueprintID;
1721
+ /**
1722
+ * URL to the blueprint zip file
1723
+ */
1724
+ source_blueprint_file_url?: string;
1725
+ /**
1726
+ * Installation mode
1727
+ */
1728
+ mode: "simple" | "advanced";
1729
+ }
1730
+ namespace Responses {
1731
+ export interface $202 {
1732
+ job_id?: /**
1733
+ * ID of a job
1734
+ * example:
1735
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1736
+ */
1737
+ Components.Schemas.BlueprintJobID;
1738
+ }
1739
+ }
1740
+ }
1741
+ namespace ListBlueprintJobs {
1742
+ namespace Responses {
1743
+ export type $200 = Components.Schemas.BlueprintJob[];
1744
+ }
1745
+ }
1723
1746
  namespace ListBlueprints {
1724
1747
  namespace Responses {
1725
1748
  export interface $200 {
@@ -1835,14 +1858,14 @@ declare namespace Paths {
1835
1858
  }
1836
1859
  }
1837
1860
  }
1838
- namespace V2BlueprintManifestInstallations$JobIdCancel {
1861
+ namespace V2BlueprintManifestJobs$JobIdCancel {
1839
1862
  namespace Parameters {
1840
1863
  export type JobId = /**
1841
- * ID of an installation job
1864
+ * ID of a job
1842
1865
  * example:
1843
1866
  * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1844
1867
  */
1845
- Components.Schemas.InstallationJobID;
1868
+ Components.Schemas.BlueprintJobID;
1846
1869
  }
1847
1870
  export interface PathParameters {
1848
1871
  job_id: Parameters.JobId;
@@ -1850,6 +1873,7 @@ declare namespace Paths {
1850
1873
  }
1851
1874
  }
1852
1875
 
1876
+
1853
1877
  export interface OperationMethods {
1854
1878
  /**
1855
1879
  * getJob - getJob
@@ -1982,6 +2006,17 @@ export interface OperationMethods {
1982
2006
  data?: Paths.CreateBlueprint.RequestBody,
1983
2007
  config?: AxiosRequestConfig
1984
2008
  ): OperationResponse<Paths.CreateBlueprint.Responses.$200>
2009
+ /**
2010
+ * installBlueprint - installBlueprint
2011
+ *
2012
+ * Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
2013
+ *
2014
+ */
2015
+ 'installBlueprint'(
2016
+ parameters?: Parameters<UnknownParamsObject> | null,
2017
+ data?: Paths.InstallBlueprint.RequestBody,
2018
+ config?: AxiosRequestConfig
2019
+ ): OperationResponse<Paths.InstallBlueprint.Responses.$202>
1985
2020
  /**
1986
2021
  * getBlueprint - getBlueprint
1987
2022
  *
@@ -2015,13 +2050,14 @@ export interface OperationMethods {
2015
2050
  /**
2016
2051
  * exportBlueprint - exportBlueprint
2017
2052
  *
2018
- * Zip the blueprint content and return the url to download it
2053
+ * Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
2054
+ *
2019
2055
  */
2020
2056
  'exportBlueprint'(
2021
2057
  parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
2022
2058
  data?: any,
2023
2059
  config?: AxiosRequestConfig
2024
- ): OperationResponse<Paths.ExportBlueprint.Responses.$200>
2060
+ ): OperationResponse<Paths.ExportBlueprint.Responses.$202>
2025
2061
  /**
2026
2062
  * addBlueprintResource - addBlueprintResource
2027
2063
  *
@@ -2093,26 +2129,25 @@ export interface OperationMethods {
2093
2129
  config?: AxiosRequestConfig
2094
2130
  ): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
2095
2131
  /**
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.
2132
+ * listBlueprintJobs - List Blueprint Jobs
2099
2133
  *
2134
+ * List all blueprint jobs
2100
2135
  */
2101
- 'createInstallationJob'(
2136
+ 'listBlueprintJobs'(
2102
2137
  parameters?: Parameters<UnknownParamsObject> | null,
2103
- data?: Paths.CreateInstallationJob.RequestBody,
2138
+ data?: any,
2104
2139
  config?: AxiosRequestConfig
2105
- ): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
2140
+ ): OperationResponse<Paths.ListBlueprintJobs.Responses.$200>
2106
2141
  /**
2107
- * getInstallationJob - Get Installation Job
2142
+ * getBlueprintJob - Get Job
2108
2143
  *
2109
- * Poll current state of an installation job.
2144
+ * Poll current state of a job.
2110
2145
  */
2111
- 'getInstallationJob'(
2112
- parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
2146
+ 'getBlueprintJob'(
2147
+ parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
2113
2148
  data?: any,
2114
2149
  config?: AxiosRequestConfig
2115
- ): OperationResponse<Paths.GetInstallationJob.Responses.$200>
2150
+ ): OperationResponse<Paths.GetBlueprintJob.Responses.$200>
2116
2151
  /**
2117
2152
  * continueInstallationJob - Continue Installation Job
2118
2153
  *
@@ -2123,16 +2158,6 @@ export interface OperationMethods {
2123
2158
  data?: any,
2124
2159
  config?: AxiosRequestConfig
2125
2160
  ): 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>
2136
2161
  }
2137
2162
 
2138
2163
  export interface PathsDictionary {
@@ -2285,6 +2310,19 @@ export interface PathsDictionary {
2285
2310
  config?: AxiosRequestConfig
2286
2311
  ): OperationResponse<Paths.CreateBlueprint.Responses.$200>
2287
2312
  }
2313
+ ['/v2/blueprint-manifest/blueprint:install']: {
2314
+ /**
2315
+ * installBlueprint - installBlueprint
2316
+ *
2317
+ * Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
2318
+ *
2319
+ */
2320
+ 'post'(
2321
+ parameters?: Parameters<UnknownParamsObject> | null,
2322
+ data?: Paths.InstallBlueprint.RequestBody,
2323
+ config?: AxiosRequestConfig
2324
+ ): OperationResponse<Paths.InstallBlueprint.Responses.$202>
2325
+ }
2288
2326
  ['/v2/blueprint-manifest/blueprints/{blueprint_id}']: {
2289
2327
  /**
2290
2328
  * getBlueprint - getBlueprint
@@ -2321,13 +2359,14 @@ export interface PathsDictionary {
2321
2359
  /**
2322
2360
  * exportBlueprint - exportBlueprint
2323
2361
  *
2324
- * Zip the blueprint content and return the url to download it
2362
+ * Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
2363
+ *
2325
2364
  */
2326
2365
  'post'(
2327
2366
  parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
2328
2367
  data?: any,
2329
2368
  config?: AxiosRequestConfig
2330
- ): OperationResponse<Paths.ExportBlueprint.Responses.$200>
2369
+ ): OperationResponse<Paths.ExportBlueprint.Responses.$202>
2331
2370
  }
2332
2371
  ['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources']: {
2333
2372
  /**
@@ -2407,32 +2446,31 @@ export interface PathsDictionary {
2407
2446
  config?: AxiosRequestConfig
2408
2447
  ): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
2409
2448
  }
2410
- ['/v2/blueprint-manifest/installations']: {
2449
+ ['/v2/blueprint-manifest/jobs']: {
2411
2450
  /**
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.
2451
+ * listBlueprintJobs - List Blueprint Jobs
2415
2452
  *
2453
+ * List all blueprint jobs
2416
2454
  */
2417
- 'post'(
2455
+ 'get'(
2418
2456
  parameters?: Parameters<UnknownParamsObject> | null,
2419
- data?: Paths.CreateInstallationJob.RequestBody,
2457
+ data?: any,
2420
2458
  config?: AxiosRequestConfig
2421
- ): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
2459
+ ): OperationResponse<Paths.ListBlueprintJobs.Responses.$200>
2422
2460
  }
2423
- ['/v2/blueprint-manifest/installations/{job_id}']: {
2461
+ ['/v2/blueprint-manifest/jobs/{job_id}']: {
2424
2462
  /**
2425
- * getInstallationJob - Get Installation Job
2463
+ * getBlueprintJob - Get Job
2426
2464
  *
2427
- * Poll current state of an installation job.
2465
+ * Poll current state of a job.
2428
2466
  */
2429
2467
  'get'(
2430
- parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
2468
+ parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
2431
2469
  data?: any,
2432
2470
  config?: AxiosRequestConfig
2433
- ): OperationResponse<Paths.GetInstallationJob.Responses.$200>
2471
+ ): OperationResponse<Paths.GetBlueprintJob.Responses.$200>
2434
2472
  }
2435
- ['/v2/blueprint-manifest/installations/{job_id}:continue']: {
2473
+ ['/v2/blueprint-manifest/jobs/{job_id}:continue']: {
2436
2474
  /**
2437
2475
  * continueInstallationJob - Continue Installation Job
2438
2476
  *
@@ -2444,32 +2482,27 @@ export interface PathsDictionary {
2444
2482
  config?: AxiosRequestConfig
2445
2483
  ): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
2446
2484
  }
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>
2485
+ ['/v2/blueprint-manifest/jobs/{job_id}:cancel']: {
2460
2486
  }
2461
2487
  }
2462
2488
 
2463
2489
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
2464
2490
 
2491
+
2465
2492
  export type AppBlueprint = Components.Schemas.AppBlueprint;
2466
2493
  export type Blueprint = Components.Schemas.Blueprint;
2494
+ export type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
2467
2495
  export type BlueprintID = Components.Schemas.BlueprintID;
2468
2496
  export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
2497
+ export type BlueprintInstallationJob = Components.Schemas.BlueprintInstallationJob;
2498
+ export type BlueprintJob = Components.Schemas.BlueprintJob;
2499
+ export type BlueprintJobEvent = Components.Schemas.BlueprintJobEvent;
2500
+ export type BlueprintJobID = Components.Schemas.BlueprintJobID;
2469
2501
  export type BlueprintResource = Components.Schemas.BlueprintResource;
2470
2502
  export type BlueprintResourceID = Components.Schemas.BlueprintResourceID;
2471
2503
  export type CallerIdentity = Components.Schemas.CallerIdentity;
2472
2504
  export type CommonBlueprintFields = Components.Schemas.CommonBlueprintFields;
2505
+ export type CommonBlueprintJobFields = Components.Schemas.CommonBlueprintJobFields;
2473
2506
  export type CommonImportFields = Components.Schemas.CommonImportFields;
2474
2507
  export type CommonManifestFields = Components.Schemas.CommonManifestFields;
2475
2508
  export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
@@ -2481,9 +2514,6 @@ export type FileBlueprint = Components.Schemas.FileBlueprint;
2481
2514
  export type FormattedError = Components.Schemas.FormattedError;
2482
2515
  export type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
2483
2516
  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
2517
  export type InstalledBlueprintResource = Components.Schemas.InstalledBlueprintResource;
2488
2518
  export type Job = Components.Schemas.Job;
2489
2519
  export type JobID = Components.Schemas.JobID;
package/dist/openapi.json CHANGED
@@ -751,6 +751,68 @@
751
751
  }
752
752
  }
753
753
  },
754
+ "/v2/blueprint-manifest/blueprint:install": {
755
+ "post": {
756
+ "operationId": "installBlueprint",
757
+ "summary": "installBlueprint",
758
+ "description": "Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource\n",
759
+ "requestBody": {
760
+ "required": true,
761
+ "content": {
762
+ "application/json": {
763
+ "schema": {
764
+ "type": "object",
765
+ "properties": {
766
+ "source_blueprint_id": {
767
+ "$ref": "#/components/schemas/BlueprintID"
768
+ },
769
+ "source_blueprint_file_url": {
770
+ "type": "string",
771
+ "description": "URL to the blueprint zip file"
772
+ },
773
+ "mode": {
774
+ "type": "string",
775
+ "enum": [
776
+ "simple",
777
+ "advanced"
778
+ ],
779
+ "description": "Installation mode"
780
+ }
781
+ },
782
+ "required": [
783
+ "mode"
784
+ ]
785
+ }
786
+ }
787
+ }
788
+ },
789
+ "responses": {
790
+ "202": {
791
+ "description": "Blueprint installation job started",
792
+ "headers": {
793
+ "Location": {
794
+ "description": "URL to poll the job",
795
+ "schema": {
796
+ "type": "string"
797
+ }
798
+ }
799
+ },
800
+ "content": {
801
+ "application/json": {
802
+ "schema": {
803
+ "type": "object",
804
+ "properties": {
805
+ "job_id": {
806
+ "$ref": "#/components/schemas/BlueprintJobID"
807
+ }
808
+ }
809
+ }
810
+ }
811
+ }
812
+ }
813
+ }
814
+ }
815
+ },
754
816
  "/v2/blueprint-manifest/blueprints/{blueprint_id}": {
755
817
  "get": {
756
818
  "operationId": "getBlueprint",
@@ -856,7 +918,7 @@
856
918
  "post": {
857
919
  "operationId": "exportBlueprint",
858
920
  "summary": "exportBlueprint",
859
- "description": "Zip the blueprint content and return the url to download it",
921
+ "description": "Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.\n",
860
922
  "tags": [
861
923
  "Blueprints"
862
924
  ],
@@ -871,15 +933,23 @@
871
933
  }
872
934
  ],
873
935
  "responses": {
874
- "200": {
875
- "description": "Exported Blueprint",
936
+ "202": {
937
+ "description": "Blueprint export job started",
938
+ "headers": {
939
+ "Location": {
940
+ "description": "URL to poll the job",
941
+ "schema": {
942
+ "type": "string"
943
+ }
944
+ }
945
+ },
876
946
  "content": {
877
947
  "application/json": {
878
948
  "schema": {
879
949
  "type": "object",
880
950
  "properties": {
881
- "url": {
882
- "type": "string"
951
+ "job_id": {
952
+ "$ref": "#/components/schemas/BlueprintJobID"
883
953
  }
884
954
  }
885
955
  }
@@ -1328,71 +1398,23 @@
1328
1398
  }
1329
1399
  }
1330
1400
  },
1331
- "/v2/blueprint-manifest/installations": {
1332
- "post": {
1333
- "operationId": "createInstallationJob",
1334
- "summary": "Create Installation Job",
1335
- "description": "Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.\n",
1401
+ "/v2/blueprint-manifest/jobs": {
1402
+ "get": {
1403
+ "operationId": "listBlueprintJobs",
1404
+ "summary": "List Blueprint Jobs",
1405
+ "description": "List all blueprint jobs",
1336
1406
  "tags": [
1337
- "Installations"
1407
+ "Jobs"
1338
1408
  ],
1339
- "requestBody": {
1340
- "required": true,
1341
- "content": {
1342
- "application/json": {
1343
- "schema": {
1344
- "type": "object",
1345
- "properties": {
1346
- "source_blueprint_id": {
1347
- "$ref": "#/components/schemas/BlueprintID"
1348
- },
1349
- "destination_org_id": {
1350
- "type": "string",
1351
- "description": "Destination organization ID"
1352
- },
1353
- "mode": {
1354
- "type": "string",
1355
- "enum": [
1356
- "simple",
1357
- "advanced"
1358
- ],
1359
- "description": "Installation mode"
1360
- }
1361
- },
1362
- "required": [
1363
- "source_blueprint_id",
1364
- "destination_org_id",
1365
- "mode"
1366
- ]
1367
- }
1368
- }
1369
- }
1370
- },
1371
1409
  "responses": {
1372
- "202": {
1373
- "description": "Installation job started",
1374
- "headers": {
1375
- "Location": {
1376
- "description": "URL to poll the job",
1377
- "schema": {
1378
- "type": "string"
1379
- }
1380
- },
1381
- "Idempotency-Key": {
1382
- "description": "Strict idempotency key",
1383
- "schema": {
1384
- "type": "string"
1385
- }
1386
- }
1387
- },
1410
+ "200": {
1411
+ "description": "Blueprint jobs",
1388
1412
  "content": {
1389
1413
  "application/json": {
1390
1414
  "schema": {
1391
- "type": "object",
1392
- "properties": {
1393
- "job_id": {
1394
- "$ref": "#/components/schemas/InstallationJobID"
1395
- }
1415
+ "type": "array",
1416
+ "items": {
1417
+ "$ref": "#/components/schemas/BlueprintJob"
1396
1418
  }
1397
1419
  }
1398
1420
  }
@@ -1401,31 +1423,28 @@
1401
1423
  }
1402
1424
  }
1403
1425
  },
1404
- "/v2/blueprint-manifest/installations/{job_id}": {
1426
+ "/v2/blueprint-manifest/jobs/{job_id}": {
1405
1427
  "get": {
1406
- "operationId": "getInstallationJob",
1407
- "summary": "Get Installation Job",
1408
- "description": "Poll current state of an installation job.",
1409
- "tags": [
1410
- "Installations"
1411
- ],
1428
+ "operationId": "getBlueprintJob",
1429
+ "summary": "Get Job",
1430
+ "description": "Poll current state of a job.",
1412
1431
  "parameters": [
1413
1432
  {
1414
1433
  "in": "path",
1415
1434
  "required": true,
1416
1435
  "name": "job_id",
1417
1436
  "schema": {
1418
- "$ref": "#/components/schemas/InstallationJobID"
1437
+ "$ref": "#/components/schemas/BlueprintJobID"
1419
1438
  }
1420
1439
  }
1421
1440
  ],
1422
1441
  "responses": {
1423
1442
  "200": {
1424
- "description": "Installation job status",
1443
+ "description": "Job status",
1425
1444
  "content": {
1426
1445
  "application/json": {
1427
1446
  "schema": {
1428
- "$ref": "#/components/schemas/InstallationJob"
1447
+ "$ref": "#/components/schemas/BlueprintJob"
1429
1448
  }
1430
1449
  }
1431
1450
  }
@@ -1433,7 +1452,7 @@
1433
1452
  }
1434
1453
  }
1435
1454
  },
1436
- "/v2/blueprint-manifest/installations/{job_id}:continue": {
1455
+ "/v2/blueprint-manifest/jobs/{job_id}:continue": {
1437
1456
  "post": {
1438
1457
  "operationId": "continueInstallationJob",
1439
1458
  "summary": "Continue Installation Job",
@@ -1447,17 +1466,17 @@
1447
1466
  "required": true,
1448
1467
  "name": "job_id",
1449
1468
  "schema": {
1450
- "$ref": "#/components/schemas/InstallationJobID"
1469
+ "$ref": "#/components/schemas/BlueprintJobID"
1451
1470
  }
1452
1471
  }
1453
1472
  ],
1454
1473
  "responses": {
1455
1474
  "200": {
1456
- "description": "Installation job continued",
1475
+ "description": "Blueprint installation job continued",
1457
1476
  "content": {
1458
1477
  "application/json": {
1459
1478
  "schema": {
1460
- "$ref": "#/components/schemas/InstallationJob"
1479
+ "$ref": "#/components/schemas/BlueprintInstallationJob"
1461
1480
  }
1462
1481
  }
1463
1482
  }
@@ -1465,12 +1484,12 @@
1465
1484
  }
1466
1485
  }
1467
1486
  },
1468
- "/v2/blueprint-manifest/installations/{job_id}:cancel": {
1469
- "operationId": "cancelInstallationJob",
1470
- "summary": "Cancel Installation Job",
1471
- "description": "Cancel an installation job if it is still running.",
1487
+ "/v2/blueprint-manifest/jobs/{job_id}:cancel": {
1488
+ "operationId": "cancelBlueprintJob",
1489
+ "summary": "Cancel Blueprint Job",
1490
+ "description": "Cancel a blueprint job if it is still running.",
1472
1491
  "tags": [
1473
- "Installations"
1492
+ "Jobs"
1474
1493
  ],
1475
1494
  "parameters": [
1476
1495
  {
@@ -1478,85 +1497,17 @@
1478
1497
  "required": true,
1479
1498
  "name": "job_id",
1480
1499
  "schema": {
1481
- "$ref": "#/components/schemas/InstallationJobID"
1500
+ "$ref": "#/components/schemas/BlueprintJobID"
1482
1501
  }
1483
1502
  }
1484
1503
  ],
1485
1504
  "responses": {
1486
1505
  "200": {
1487
- "description": "Installation job cancelled",
1506
+ "description": "Blueprint job cancelled",
1488
1507
  "content": {
1489
1508
  "application/json": {
1490
1509
  "schema": {
1491
- "$ref": "#/components/schemas/InstallationJob"
1492
- }
1493
- }
1494
- }
1495
- }
1496
- }
1497
- },
1498
- "/v2/blueprint-manifest/installations/{job_id}/events": {
1499
- "get": {
1500
- "operationId": "getInstallationJobEvents",
1501
- "summary": "Get Installation Job Events",
1502
- "description": "Event log for an installation job.",
1503
- "tags": [
1504
- "Installations"
1505
- ],
1506
- "parameters": [
1507
- {
1508
- "in": "path",
1509
- "required": true,
1510
- "name": "job_id",
1511
- "schema": {
1512
- "$ref": "#/components/schemas/InstallationJobID"
1513
- }
1514
- }
1515
- ],
1516
- "responses": {
1517
- "200": {
1518
- "description": "Event logs",
1519
- "content": {
1520
- "application/json": {
1521
- "schema": {
1522
- "type": "object",
1523
- "properties": {
1524
- "created_at": {
1525
- "type": "string",
1526
- "format": "date-time"
1527
- },
1528
- "status": {
1529
- "type": "string",
1530
- "enum": [
1531
- "STARTED",
1532
- "WAITING_USER_ACTION",
1533
- "CANCELED",
1534
- "IN_PROGRESS",
1535
- "SUCCESS",
1536
- "FAILED"
1537
- ]
1538
- },
1539
- "errors": {
1540
- "type": "array",
1541
- "items": {
1542
- "$ref": "#/components/schemas/FormattedError"
1543
- }
1544
- },
1545
- "progress": {
1546
- "type": "number",
1547
- "format": "float",
1548
- "minimum": 0,
1549
- "maximum": 100,
1550
- "description": "Progress completion (0-100)"
1551
- },
1552
- "events": {
1553
- "type": "array",
1554
- "items": {
1555
- "$ref": "#/components/schemas/InstallationJobEvent"
1556
- }
1557
- }
1558
- }
1559
- }
1510
+ "$ref": "#/components/schemas/BlueprintJob"
1560
1511
  }
1561
1512
  }
1562
1513
  }
@@ -1606,6 +1557,9 @@
1606
1557
  "version": {
1607
1558
  "type": "string"
1608
1559
  },
1560
+ "latest_download_file": {
1561
+ "$ref": "#/components/schemas/S3Reference"
1562
+ },
1609
1563
  "created_at": {
1610
1564
  "type": "string",
1611
1565
  "format": "date-time"
@@ -1851,48 +1805,22 @@
1851
1805
  }
1852
1806
  ]
1853
1807
  },
1854
- "InstallationJobID": {
1808
+ "BlueprintJobID": {
1855
1809
  "type": "string",
1856
- "description": "ID of an installation job",
1810
+ "description": "ID of a job",
1857
1811
  "example": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"
1858
1812
  },
1859
- "InstallationJob": {
1813
+ "CommonBlueprintJobFields": {
1860
1814
  "type": "object",
1861
1815
  "properties": {
1862
1816
  "id": {
1863
- "$ref": "#/components/schemas/InstallationJobID"
1817
+ "$ref": "#/components/schemas/BlueprintJobID"
1864
1818
  },
1865
- "source_blueprint_id": {
1866
- "$ref": "#/components/schemas/BlueprintID"
1867
- },
1868
- "source_blueprint_type": {
1869
- "type": "string",
1870
- "enum": [
1871
- "file",
1872
- "marketplace",
1873
- "deploy",
1874
- "app"
1875
- ]
1876
- },
1877
- "source_org_id": {
1878
- "type": "string"
1879
- },
1880
- "destination_blueprint_id": {
1881
- "$ref": "#/components/schemas/BlueprintID"
1882
- },
1883
- "destination_org_id": {
1884
- "type": "string"
1885
- },
1886
- "status": {
1887
- "type": "string",
1888
- "enum": [
1889
- "STARTED",
1890
- "WAITING_USER_ACTION",
1891
- "CANCELED",
1892
- "IN_PROGRESS",
1893
- "SUCCESS",
1894
- "FAILED"
1895
- ]
1819
+ "events": {
1820
+ "type": "array",
1821
+ "items": {
1822
+ "$ref": "#/components/schemas/BlueprintJobEvent"
1823
+ }
1896
1824
  },
1897
1825
  "triggered_at": {
1898
1826
  "type": "string",
@@ -1900,13 +1828,91 @@
1900
1828
  },
1901
1829
  "created_by": {
1902
1830
  "$ref": "#/components/schemas/CallerIdentity"
1903
- },
1904
- "updated_by": {
1905
- "$ref": "#/components/schemas/CallerIdentity"
1906
1831
  }
1907
1832
  }
1908
1833
  },
1909
- "InstallationJobEvent": {
1834
+ "BlueprintExportJob": {
1835
+ "allOf": [
1836
+ {
1837
+ "$ref": "#/components/schemas/CommonBlueprintJobFields"
1838
+ },
1839
+ {
1840
+ "type": "object",
1841
+ "properties": {
1842
+ "blueprint_id": {
1843
+ "$ref": "#/components/schemas/BlueprintID"
1844
+ },
1845
+ "status": {
1846
+ "type": "string",
1847
+ "enum": [
1848
+ "IN_PROGRESS",
1849
+ "SUCCESS",
1850
+ "FAILED",
1851
+ "CANCELED"
1852
+ ]
1853
+ },
1854
+ "download_file": {
1855
+ "$ref": "#/components/schemas/S3Reference"
1856
+ }
1857
+ }
1858
+ }
1859
+ ]
1860
+ },
1861
+ "BlueprintInstallationJob": {
1862
+ "allOf": [
1863
+ {
1864
+ "$ref": "#/components/schemas/CommonBlueprintJobFields"
1865
+ },
1866
+ {
1867
+ "type": "object",
1868
+ "properties": {
1869
+ "source_blueprint_id": {
1870
+ "$ref": "#/components/schemas/BlueprintID"
1871
+ },
1872
+ "source_blueprint_type": {
1873
+ "type": "string",
1874
+ "enum": [
1875
+ "custom",
1876
+ "file",
1877
+ "marketplace",
1878
+ "deploy",
1879
+ "app"
1880
+ ]
1881
+ },
1882
+ "source_org_id": {
1883
+ "type": "string"
1884
+ },
1885
+ "destination_blueprint_id": {
1886
+ "$ref": "#/components/schemas/BlueprintID"
1887
+ },
1888
+ "destination_org_id": {
1889
+ "type": "string"
1890
+ },
1891
+ "status": {
1892
+ "type": "string",
1893
+ "enum": [
1894
+ "IN_PROGRESS",
1895
+ "WAITING_USER_ACTION",
1896
+ "CANCELED",
1897
+ "SUCCESS",
1898
+ "FAILED"
1899
+ ]
1900
+ }
1901
+ }
1902
+ }
1903
+ ]
1904
+ },
1905
+ "BlueprintJob": {
1906
+ "oneOf": [
1907
+ {
1908
+ "$ref": "#/components/schemas/BlueprintExportJob"
1909
+ },
1910
+ {
1911
+ "$ref": "#/components/schemas/BlueprintInstallationJob"
1912
+ }
1913
+ ]
1914
+ },
1915
+ "BlueprintJobEvent": {
1910
1916
  "type": "object",
1911
1917
  "properties": {
1912
1918
  "timestamp": {
@@ -1916,6 +1922,12 @@
1916
1922
  "message": {
1917
1923
  "type": "string"
1918
1924
  },
1925
+ "errors": {
1926
+ "type": "array",
1927
+ "items": {
1928
+ "$ref": "#/components/schemas/FormattedError"
1929
+ }
1930
+ },
1919
1931
  "level": {
1920
1932
  "type": "string",
1921
1933
  "enum": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/blueprint-manifest-client",
3
- "version": "3.0.0-beta.1",
3
+ "version": "3.0.0-beta.2",
4
4
  "description": "Client for epilot Terraform Blueprint Manifest API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -21,18 +21,6 @@
21
21
  "manifest",
22
22
  "terraform"
23
23
  ],
24
- "scripts": {
25
- "test": "jest",
26
- "bundle-definition": "webpack",
27
- "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
28
- "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
29
- "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
30
- "build": "tsc && npm run build:patch && npm run bundle-definition",
31
- "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
32
- "build:watch": "npm run build && tsc -w",
33
- "prepublishOnly": "npm run typegen && npm run build",
34
- "lint": "pnpm exec eslint src"
35
- },
36
24
  "files": [
37
25
  "*.js",
38
26
  "*.d.ts",
@@ -72,5 +60,16 @@
72
60
  "webpack": "^5.18.0",
73
61
  "webpack-cli": "^4.4.0"
74
62
  },
75
- "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
76
- }
63
+ "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7",
64
+ "scripts": {
65
+ "test": "jest",
66
+ "bundle-definition": "webpack",
67
+ "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
68
+ "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
69
+ "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
70
+ "build": "tsc && npm run build:patch && npm run bundle-definition",
71
+ "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
72
+ "build:watch": "npm run build && tsc -w",
73
+ "lint": "pnpm exec eslint src"
74
+ }
75
+ }