@epilot/blueprint-manifest-client 3.3.1 → 3.5.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 +69 -6
- package/dist/openapi.json +46 -9
- package/package.json +15 -14
- package/LICENSE +0 -21
package/dist/openapi.d.ts
CHANGED
|
@@ -69,10 +69,34 @@ declare namespace Components {
|
|
|
69
69
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
70
70
|
*/
|
|
71
71
|
BlueprintJobID[];
|
|
72
|
+
source_blueprint_id?: /**
|
|
73
|
+
* ID of a blueprint
|
|
74
|
+
* example:
|
|
75
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
76
|
+
*/
|
|
77
|
+
BlueprintID;
|
|
72
78
|
source_type: "app";
|
|
73
79
|
resources?: BlueprintResource[];
|
|
74
80
|
}
|
|
75
81
|
export type Blueprint = CustomBlueprint | FileBlueprint | MarketplaceBlueprint | DeployedBlueprint | AppBlueprint;
|
|
82
|
+
export interface BlueprintDependenciesSyncJob {
|
|
83
|
+
id?: /**
|
|
84
|
+
* ID of a job
|
|
85
|
+
* example:
|
|
86
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
87
|
+
*/
|
|
88
|
+
BlueprintJobID;
|
|
89
|
+
events?: BlueprintJobEvent[];
|
|
90
|
+
triggered_at?: string; // date-time
|
|
91
|
+
created_by?: CallerIdentity;
|
|
92
|
+
blueprint_id?: /**
|
|
93
|
+
* ID of a blueprint
|
|
94
|
+
* example:
|
|
95
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
96
|
+
*/
|
|
97
|
+
BlueprintID;
|
|
98
|
+
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED";
|
|
99
|
+
}
|
|
76
100
|
export interface BlueprintExportJob {
|
|
77
101
|
id?: /**
|
|
78
102
|
* ID of a job
|
|
@@ -133,7 +157,7 @@ declare namespace Components {
|
|
|
133
157
|
*/
|
|
134
158
|
resources_to_ignore?: string[];
|
|
135
159
|
}
|
|
136
|
-
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob;
|
|
160
|
+
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob | BlueprintDependenciesSyncJob;
|
|
137
161
|
export interface BlueprintJobEvent {
|
|
138
162
|
timestamp?: string; // date-time
|
|
139
163
|
message?: string;
|
|
@@ -279,6 +303,15 @@ declare namespace Components {
|
|
|
279
303
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
280
304
|
*/
|
|
281
305
|
BlueprintJobID[];
|
|
306
|
+
/**
|
|
307
|
+
* ID of the blueprint that brought this blueprint to the destination org (deployed or installed)
|
|
308
|
+
*/
|
|
309
|
+
source_blueprint_id?: /**
|
|
310
|
+
* ID of a blueprint
|
|
311
|
+
* example:
|
|
312
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
313
|
+
*/
|
|
314
|
+
BlueprintID;
|
|
282
315
|
}
|
|
283
316
|
export interface CommonBlueprintJobFields {
|
|
284
317
|
id?: /**
|
|
@@ -514,6 +547,12 @@ declare namespace Components {
|
|
|
514
547
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
515
548
|
*/
|
|
516
549
|
BlueprintJobID[];
|
|
550
|
+
source_blueprint_id?: /**
|
|
551
|
+
* ID of a blueprint
|
|
552
|
+
* example:
|
|
553
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
554
|
+
*/
|
|
555
|
+
BlueprintID;
|
|
517
556
|
resources?: BlueprintResource[];
|
|
518
557
|
source_type: "custom";
|
|
519
558
|
}
|
|
@@ -565,6 +604,12 @@ declare namespace Components {
|
|
|
565
604
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
566
605
|
*/
|
|
567
606
|
BlueprintJobID[];
|
|
607
|
+
source_blueprint_id?: /**
|
|
608
|
+
* ID of a blueprint
|
|
609
|
+
* example:
|
|
610
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
611
|
+
*/
|
|
612
|
+
BlueprintID;
|
|
568
613
|
source_type: "deploy";
|
|
569
614
|
resources?: BlueprintResource[];
|
|
570
615
|
}
|
|
@@ -616,6 +661,12 @@ declare namespace Components {
|
|
|
616
661
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
617
662
|
*/
|
|
618
663
|
BlueprintJobID[];
|
|
664
|
+
source_blueprint_id?: /**
|
|
665
|
+
* ID of a blueprint
|
|
666
|
+
* example:
|
|
667
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
668
|
+
*/
|
|
669
|
+
BlueprintID;
|
|
619
670
|
source_type: "file";
|
|
620
671
|
resources?: BlueprintResource[];
|
|
621
672
|
}
|
|
@@ -1188,6 +1239,12 @@ declare namespace Components {
|
|
|
1188
1239
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1189
1240
|
*/
|
|
1190
1241
|
BlueprintJobID[];
|
|
1242
|
+
source_blueprint_id?: /**
|
|
1243
|
+
* ID of a blueprint
|
|
1244
|
+
* example:
|
|
1245
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1246
|
+
*/
|
|
1247
|
+
BlueprintID;
|
|
1191
1248
|
/**
|
|
1192
1249
|
* URL to the blueprint documentation
|
|
1193
1250
|
*/
|
|
@@ -1271,7 +1328,7 @@ declare namespace Components {
|
|
|
1271
1328
|
/**
|
|
1272
1329
|
* Type of the resource
|
|
1273
1330
|
*/
|
|
1274
|
-
export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target";
|
|
1331
|
+
export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban";
|
|
1275
1332
|
export interface ResourceReplacement {
|
|
1276
1333
|
/**
|
|
1277
1334
|
* Original resource ID to be replaced
|
|
@@ -1979,8 +2036,13 @@ declare namespace Paths {
|
|
|
1979
2036
|
blueprint_id: Parameters.BlueprintId;
|
|
1980
2037
|
}
|
|
1981
2038
|
namespace Responses {
|
|
1982
|
-
export interface $
|
|
1983
|
-
|
|
2039
|
+
export interface $202 {
|
|
2040
|
+
job_id?: /**
|
|
2041
|
+
* ID of a job
|
|
2042
|
+
* example:
|
|
2043
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2044
|
+
*/
|
|
2045
|
+
Components.Schemas.BlueprintJobID;
|
|
1984
2046
|
}
|
|
1985
2047
|
}
|
|
1986
2048
|
}
|
|
@@ -2273,7 +2335,7 @@ export interface OperationMethods {
|
|
|
2273
2335
|
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
2274
2336
|
data?: any,
|
|
2275
2337
|
config?: AxiosRequestConfig
|
|
2276
|
-
): OperationResponse<Paths.SyncDependencies.Responses.$
|
|
2338
|
+
): OperationResponse<Paths.SyncDependencies.Responses.$202>
|
|
2277
2339
|
/**
|
|
2278
2340
|
* bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
|
|
2279
2341
|
*
|
|
@@ -2608,7 +2670,7 @@ export interface PathsDictionary {
|
|
|
2608
2670
|
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
2609
2671
|
data?: any,
|
|
2610
2672
|
config?: AxiosRequestConfig
|
|
2611
|
-
): OperationResponse<Paths.SyncDependencies.Responses.$
|
|
2673
|
+
): OperationResponse<Paths.SyncDependencies.Responses.$202>
|
|
2612
2674
|
}
|
|
2613
2675
|
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk']: {
|
|
2614
2676
|
/**
|
|
@@ -2719,6 +2781,7 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
2719
2781
|
|
|
2720
2782
|
export type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
2721
2783
|
export type Blueprint = Components.Schemas.Blueprint;
|
|
2784
|
+
export type BlueprintDependenciesSyncJob = Components.Schemas.BlueprintDependenciesSyncJob;
|
|
2722
2785
|
export type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
|
|
2723
2786
|
export type BlueprintID = Components.Schemas.BlueprintID;
|
|
2724
2787
|
export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
|
package/dist/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Blueprint Manifest API",
|
|
5
|
-
"version": "3.
|
|
5
|
+
"version": "3.3.0",
|
|
6
6
|
"description": "Service to create and install Blueprint Manifest files"
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -1130,18 +1130,23 @@
|
|
|
1130
1130
|
}
|
|
1131
1131
|
],
|
|
1132
1132
|
"responses": {
|
|
1133
|
-
"
|
|
1134
|
-
"description": "
|
|
1133
|
+
"202": {
|
|
1134
|
+
"description": "Dependencies sync job started",
|
|
1135
|
+
"headers": {
|
|
1136
|
+
"Location": {
|
|
1137
|
+
"description": "URL to poll the job",
|
|
1138
|
+
"schema": {
|
|
1139
|
+
"type": "string"
|
|
1140
|
+
}
|
|
1141
|
+
}
|
|
1142
|
+
},
|
|
1135
1143
|
"content": {
|
|
1136
1144
|
"application/json": {
|
|
1137
1145
|
"schema": {
|
|
1138
1146
|
"type": "object",
|
|
1139
1147
|
"properties": {
|
|
1140
|
-
"
|
|
1141
|
-
"
|
|
1142
|
-
"items": {
|
|
1143
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
1144
|
-
}
|
|
1148
|
+
"job_id": {
|
|
1149
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1145
1150
|
}
|
|
1146
1151
|
}
|
|
1147
1152
|
}
|
|
@@ -1655,6 +1660,10 @@
|
|
|
1655
1660
|
"items": {
|
|
1656
1661
|
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1657
1662
|
}
|
|
1663
|
+
},
|
|
1664
|
+
"source_blueprint_id": {
|
|
1665
|
+
"description": "ID of the blueprint that brought this blueprint to the destination org (deployed or installed)",
|
|
1666
|
+
"$ref": "#/components/schemas/BlueprintID"
|
|
1658
1667
|
}
|
|
1659
1668
|
},
|
|
1660
1669
|
"required": [
|
|
@@ -1982,6 +1991,33 @@
|
|
|
1982
1991
|
},
|
|
1983
1992
|
{
|
|
1984
1993
|
"$ref": "#/components/schemas/BlueprintInstallationJob"
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"$ref": "#/components/schemas/BlueprintDependenciesSyncJob"
|
|
1997
|
+
}
|
|
1998
|
+
]
|
|
1999
|
+
},
|
|
2000
|
+
"BlueprintDependenciesSyncJob": {
|
|
2001
|
+
"allOf": [
|
|
2002
|
+
{
|
|
2003
|
+
"$ref": "#/components/schemas/CommonBlueprintJobFields"
|
|
2004
|
+
},
|
|
2005
|
+
{
|
|
2006
|
+
"type": "object",
|
|
2007
|
+
"properties": {
|
|
2008
|
+
"blueprint_id": {
|
|
2009
|
+
"$ref": "#/components/schemas/BlueprintID"
|
|
2010
|
+
},
|
|
2011
|
+
"status": {
|
|
2012
|
+
"type": "string",
|
|
2013
|
+
"enum": [
|
|
2014
|
+
"IN_PROGRESS",
|
|
2015
|
+
"SUCCESS",
|
|
2016
|
+
"FAILED",
|
|
2017
|
+
"CANCELED"
|
|
2018
|
+
]
|
|
2019
|
+
}
|
|
2020
|
+
}
|
|
1985
2021
|
}
|
|
1986
2022
|
]
|
|
1987
2023
|
},
|
|
@@ -2146,7 +2182,8 @@
|
|
|
2146
2182
|
"app",
|
|
2147
2183
|
"role",
|
|
2148
2184
|
"portal_config",
|
|
2149
|
-
"target"
|
|
2185
|
+
"target",
|
|
2186
|
+
"kanban"
|
|
2150
2187
|
]
|
|
2151
2188
|
},
|
|
2152
2189
|
"PlanChanges": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/blueprint-manifest-client",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.0",
|
|
4
4
|
"description": "Client for epilot Terraform Blueprint Manifest API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -21,6 +21,18 @@
|
|
|
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
|
+
},
|
|
24
36
|
"files": [
|
|
25
37
|
"*.js",
|
|
26
38
|
"*.d.ts",
|
|
@@ -60,16 +72,5 @@
|
|
|
60
72
|
"webpack": "^5.18.0",
|
|
61
73
|
"webpack-cli": "^4.4.0"
|
|
62
74
|
},
|
|
63
|
-
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
64
|
-
|
|
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
|
-
}
|
|
75
|
+
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
76
|
+
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
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.
|