@epilot/blueprint-manifest-client 3.2.1-beta → 3.3.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/definition.js +1 -1
- package/dist/openapi-runtime.json +9 -33
- package/dist/openapi.d.ts +37 -97
- package/dist/openapi.json +20 -141
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={914: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(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","deprecated":true,"parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","deprecated":true,"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","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","deprecated":true,"parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","deprecated":true,"responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","deprecated":true,"parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","deprecated":true,"parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","deprecated":true,"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:pre-install":{"post":{"operationId":"preInstallBlueprint","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"}],"requestBody":{"required":false,"content":{"application/json":{}}},"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"}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:cancel":{"post":{"operationId":"cancelBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')}},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}(914),n=exports;for(var s in r)n[s]=r[s];r.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
"/v1/blueprint-manifest/jobs/{job_id}": {
|
|
14
14
|
"get": {
|
|
15
15
|
"operationId": "getJob",
|
|
16
|
+
"deprecated": true,
|
|
16
17
|
"parameters": [
|
|
17
18
|
{
|
|
18
19
|
"$ref": "#/components/parameters/JobID"
|
|
@@ -24,6 +25,7 @@
|
|
|
24
25
|
"/v1/blueprint-manifest/jobs:createExport": {
|
|
25
26
|
"post": {
|
|
26
27
|
"operationId": "createExport",
|
|
28
|
+
"deprecated": true,
|
|
27
29
|
"requestBody": {
|
|
28
30
|
"content": {
|
|
29
31
|
"application/json": {}
|
|
@@ -35,6 +37,7 @@
|
|
|
35
37
|
"/v1/blueprint-manifest/jobs/{job_id}:exportManifest": {
|
|
36
38
|
"post": {
|
|
37
39
|
"operationId": "exportManifest",
|
|
40
|
+
"deprecated": true,
|
|
38
41
|
"parameters": [
|
|
39
42
|
{
|
|
40
43
|
"$ref": "#/components/parameters/JobID"
|
|
@@ -62,6 +65,7 @@
|
|
|
62
65
|
"/v1/blueprint-manifest/jobs:createPlan": {
|
|
63
66
|
"post": {
|
|
64
67
|
"operationId": "createPlan",
|
|
68
|
+
"deprecated": true,
|
|
65
69
|
"requestBody": {
|
|
66
70
|
"content": {
|
|
67
71
|
"application/json": {}
|
|
@@ -73,6 +77,7 @@
|
|
|
73
77
|
"/v1/blueprint-manifest/jobs/{job_id}:applyPlan": {
|
|
74
78
|
"post": {
|
|
75
79
|
"operationId": "applyPlan",
|
|
80
|
+
"deprecated": true,
|
|
76
81
|
"parameters": [
|
|
77
82
|
{
|
|
78
83
|
"$ref": "#/components/parameters/JobID"
|
|
@@ -89,12 +94,14 @@
|
|
|
89
94
|
"/v1/blueprint-manifest/manifests": {
|
|
90
95
|
"get": {
|
|
91
96
|
"operationId": "listInstalledManifests",
|
|
97
|
+
"deprecated": true,
|
|
92
98
|
"responses": {}
|
|
93
99
|
}
|
|
94
100
|
},
|
|
95
101
|
"/v1/blueprint-manifest/manifests/{manifest_id}": {
|
|
96
102
|
"get": {
|
|
97
103
|
"operationId": "getManifest",
|
|
104
|
+
"deprecated": true,
|
|
98
105
|
"parameters": [
|
|
99
106
|
{
|
|
100
107
|
"in": "path",
|
|
@@ -106,6 +113,7 @@
|
|
|
106
113
|
},
|
|
107
114
|
"put": {
|
|
108
115
|
"operationId": "updateManifest",
|
|
116
|
+
"deprecated": true,
|
|
109
117
|
"parameters": [
|
|
110
118
|
{
|
|
111
119
|
"in": "path",
|
|
@@ -122,6 +130,7 @@
|
|
|
122
130
|
},
|
|
123
131
|
"delete": {
|
|
124
132
|
"operationId": "deleteManifest",
|
|
133
|
+
"deprecated": true,
|
|
125
134
|
"parameters": [
|
|
126
135
|
{
|
|
127
136
|
"in": "path",
|
|
@@ -158,26 +167,6 @@
|
|
|
158
167
|
"responses": {}
|
|
159
168
|
}
|
|
160
169
|
},
|
|
161
|
-
"/v2/blueprint-manifest/blueprint/{blueprint_id}/diff": {
|
|
162
|
-
"get": {
|
|
163
|
-
"operationId": "getBlueprintDiff",
|
|
164
|
-
"parameters": [
|
|
165
|
-
{
|
|
166
|
-
"in": "path",
|
|
167
|
-
"required": true,
|
|
168
|
-
"name": "blueprint_id"
|
|
169
|
-
}
|
|
170
|
-
]
|
|
171
|
-
},
|
|
172
|
-
"responses": {
|
|
173
|
-
"200": {
|
|
174
|
-
"description": "The diff for the given blueprint",
|
|
175
|
-
"content": {
|
|
176
|
-
"application/json": {}
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
},
|
|
181
170
|
"/v2/blueprint-manifest/blueprint:install": {
|
|
182
171
|
"post": {
|
|
183
172
|
"operationId": "installBlueprint",
|
|
@@ -249,19 +238,6 @@
|
|
|
249
238
|
"responses": {}
|
|
250
239
|
}
|
|
251
240
|
},
|
|
252
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}:create-plan": {
|
|
253
|
-
"post": {
|
|
254
|
-
"operationId": "createBlueprintPlan",
|
|
255
|
-
"parameters": [
|
|
256
|
-
{
|
|
257
|
-
"in": "path",
|
|
258
|
-
"required": true,
|
|
259
|
-
"name": "blueprint_id"
|
|
260
|
-
}
|
|
261
|
-
],
|
|
262
|
-
"responses": {}
|
|
263
|
-
}
|
|
264
|
-
},
|
|
265
241
|
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources": {
|
|
266
242
|
"post": {
|
|
267
243
|
"operationId": "addBlueprintResource",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -63,6 +63,12 @@ declare namespace Components {
|
|
|
63
63
|
updated_at?: string; // date-time
|
|
64
64
|
created_by?: CallerIdentity;
|
|
65
65
|
updated_by?: CallerIdentity;
|
|
66
|
+
installation_job_ids?: /**
|
|
67
|
+
* ID of a job
|
|
68
|
+
* example:
|
|
69
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
70
|
+
*/
|
|
71
|
+
BlueprintJobID[];
|
|
66
72
|
source_type: "app";
|
|
67
73
|
resources?: BlueprintResource[];
|
|
68
74
|
}
|
|
@@ -267,6 +273,12 @@ declare namespace Components {
|
|
|
267
273
|
updated_at?: string; // date-time
|
|
268
274
|
created_by?: CallerIdentity;
|
|
269
275
|
updated_by?: CallerIdentity;
|
|
276
|
+
installation_job_ids?: /**
|
|
277
|
+
* ID of a job
|
|
278
|
+
* example:
|
|
279
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
280
|
+
*/
|
|
281
|
+
BlueprintJobID[];
|
|
270
282
|
}
|
|
271
283
|
export interface CommonBlueprintJobFields {
|
|
272
284
|
id?: /**
|
|
@@ -496,6 +508,12 @@ declare namespace Components {
|
|
|
496
508
|
updated_at?: string; // date-time
|
|
497
509
|
created_by?: CallerIdentity;
|
|
498
510
|
updated_by?: CallerIdentity;
|
|
511
|
+
installation_job_ids?: /**
|
|
512
|
+
* ID of a job
|
|
513
|
+
* example:
|
|
514
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
515
|
+
*/
|
|
516
|
+
BlueprintJobID[];
|
|
499
517
|
resources?: BlueprintResource[];
|
|
500
518
|
source_type: "custom";
|
|
501
519
|
}
|
|
@@ -541,17 +559,15 @@ declare namespace Components {
|
|
|
541
559
|
updated_at?: string; // date-time
|
|
542
560
|
created_by?: CallerIdentity;
|
|
543
561
|
updated_by?: CallerIdentity;
|
|
562
|
+
installation_job_ids?: /**
|
|
563
|
+
* ID of a job
|
|
564
|
+
* example:
|
|
565
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
566
|
+
*/
|
|
567
|
+
BlueprintJobID[];
|
|
544
568
|
source_type: "deploy";
|
|
545
569
|
resources?: BlueprintResource[];
|
|
546
570
|
}
|
|
547
|
-
export interface DiffRow {
|
|
548
|
-
type: "added" | "removed" | "changed" | "no-op";
|
|
549
|
-
key: string;
|
|
550
|
-
before: string | null;
|
|
551
|
-
after: string | null;
|
|
552
|
-
resource: string;
|
|
553
|
-
}
|
|
554
|
-
export type DiffRowArray = DiffRow[];
|
|
555
571
|
export interface FileBlueprint {
|
|
556
572
|
id?: /**
|
|
557
573
|
* ID of a blueprint
|
|
@@ -594,6 +610,12 @@ declare namespace Components {
|
|
|
594
610
|
updated_at?: string; // date-time
|
|
595
611
|
created_by?: CallerIdentity;
|
|
596
612
|
updated_by?: CallerIdentity;
|
|
613
|
+
installation_job_ids?: /**
|
|
614
|
+
* ID of a job
|
|
615
|
+
* example:
|
|
616
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
617
|
+
*/
|
|
618
|
+
BlueprintJobID[];
|
|
597
619
|
source_type: "file";
|
|
598
620
|
resources?: BlueprintResource[];
|
|
599
621
|
}
|
|
@@ -1160,6 +1182,12 @@ declare namespace Components {
|
|
|
1160
1182
|
updated_at?: string; // date-time
|
|
1161
1183
|
created_by?: CallerIdentity;
|
|
1162
1184
|
updated_by?: CallerIdentity;
|
|
1185
|
+
installation_job_ids?: /**
|
|
1186
|
+
* ID of a job
|
|
1187
|
+
* example:
|
|
1188
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1189
|
+
*/
|
|
1190
|
+
BlueprintJobID[];
|
|
1163
1191
|
/**
|
|
1164
1192
|
* URL to the blueprint documentation
|
|
1165
1193
|
*/
|
|
@@ -1243,7 +1271,7 @@ declare namespace Components {
|
|
|
1243
1271
|
/**
|
|
1244
1272
|
* Type of the resource
|
|
1245
1273
|
*/
|
|
1246
|
-
export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "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" | "
|
|
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";
|
|
1247
1275
|
export interface ResourceReplacement {
|
|
1248
1276
|
/**
|
|
1249
1277
|
* Original resource ID to be replaced
|
|
@@ -1514,29 +1542,6 @@ declare namespace Paths {
|
|
|
1514
1542
|
export type $200 = Components.Schemas.Blueprint;
|
|
1515
1543
|
}
|
|
1516
1544
|
}
|
|
1517
|
-
namespace CreateBlueprintPlan {
|
|
1518
|
-
namespace Parameters {
|
|
1519
|
-
export type BlueprintId = /**
|
|
1520
|
-
* ID of a blueprint
|
|
1521
|
-
* example:
|
|
1522
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1523
|
-
*/
|
|
1524
|
-
Components.Schemas.BlueprintID;
|
|
1525
|
-
}
|
|
1526
|
-
export interface PathParameters {
|
|
1527
|
-
blueprint_id: Parameters.BlueprintId;
|
|
1528
|
-
}
|
|
1529
|
-
namespace Responses {
|
|
1530
|
-
export interface $202 {
|
|
1531
|
-
job_id?: /**
|
|
1532
|
-
* ID of a job
|
|
1533
|
-
* example:
|
|
1534
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1535
|
-
*/
|
|
1536
|
-
Components.Schemas.BlueprintJobID;
|
|
1537
|
-
}
|
|
1538
|
-
}
|
|
1539
|
-
}
|
|
1540
1545
|
namespace CreateExport {
|
|
1541
1546
|
export interface RequestBody {
|
|
1542
1547
|
resources: [
|
|
@@ -1821,19 +1826,6 @@ declare namespace Paths {
|
|
|
1821
1826
|
export type $200 = Components.Schemas.Blueprint;
|
|
1822
1827
|
}
|
|
1823
1828
|
}
|
|
1824
|
-
namespace GetBlueprintDiff {
|
|
1825
|
-
namespace Parameters {
|
|
1826
|
-
export type BlueprintId = /**
|
|
1827
|
-
* ID of a blueprint
|
|
1828
|
-
* example:
|
|
1829
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1830
|
-
*/
|
|
1831
|
-
Components.Schemas.BlueprintID;
|
|
1832
|
-
}
|
|
1833
|
-
export interface PathParameters {
|
|
1834
|
-
blueprint_id: Parameters.BlueprintId;
|
|
1835
|
-
}
|
|
1836
|
-
}
|
|
1837
1829
|
namespace GetBlueprintJob {
|
|
1838
1830
|
namespace Parameters {
|
|
1839
1831
|
export type JobId = /**
|
|
@@ -2067,7 +2059,6 @@ declare namespace Paths {
|
|
|
2067
2059
|
}
|
|
2068
2060
|
}
|
|
2069
2061
|
|
|
2070
|
-
|
|
2071
2062
|
export interface OperationMethods {
|
|
2072
2063
|
/**
|
|
2073
2064
|
* getJob - getJob
|
|
@@ -2210,17 +2201,6 @@ export interface OperationMethods {
|
|
|
2210
2201
|
data?: Paths.PreInstallBlueprint.RequestBody,
|
|
2211
2202
|
config?: AxiosRequestConfig
|
|
2212
2203
|
): OperationResponse<Paths.PreInstallBlueprint.Responses.$200>
|
|
2213
|
-
/**
|
|
2214
|
-
* getBlueprintDiff - getBlueprintDiff
|
|
2215
|
-
*
|
|
2216
|
-
* Makes the diff of a blueprint vs the current state of its resources
|
|
2217
|
-
*
|
|
2218
|
-
*/
|
|
2219
|
-
'getBlueprintDiff'(
|
|
2220
|
-
parameters?: Parameters<Paths.GetBlueprintDiff.PathParameters> | null,
|
|
2221
|
-
data?: any,
|
|
2222
|
-
config?: AxiosRequestConfig
|
|
2223
|
-
): OperationResponse<any>
|
|
2224
2204
|
/**
|
|
2225
2205
|
* installBlueprint - installBlueprint
|
|
2226
2206
|
*
|
|
@@ -2273,17 +2253,6 @@ export interface OperationMethods {
|
|
|
2273
2253
|
data?: Paths.ExportBlueprint.RequestBody,
|
|
2274
2254
|
config?: AxiosRequestConfig
|
|
2275
2255
|
): OperationResponse<Paths.ExportBlueprint.Responses.$202>
|
|
2276
|
-
/**
|
|
2277
|
-
* createBlueprintPlan - createBlueprintPlan
|
|
2278
|
-
*
|
|
2279
|
-
* Kick off a new blueprint plan creation job. Returns 202 Accepted with Location header pointing to the job resource.
|
|
2280
|
-
*
|
|
2281
|
-
*/
|
|
2282
|
-
'createBlueprintPlan'(
|
|
2283
|
-
parameters?: Parameters<Paths.CreateBlueprintPlan.PathParameters> | null,
|
|
2284
|
-
data?: any,
|
|
2285
|
-
config?: AxiosRequestConfig
|
|
2286
|
-
): OperationResponse<Paths.CreateBlueprintPlan.Responses.$202>
|
|
2287
2256
|
/**
|
|
2288
2257
|
* addBlueprintResource - addBlueprintResource
|
|
2289
2258
|
*
|
|
@@ -2558,19 +2527,6 @@ export interface PathsDictionary {
|
|
|
2558
2527
|
config?: AxiosRequestConfig
|
|
2559
2528
|
): OperationResponse<Paths.PreInstallBlueprint.Responses.$200>
|
|
2560
2529
|
}
|
|
2561
|
-
['/v2/blueprint-manifest/blueprint/{blueprint_id}/diff']: {
|
|
2562
|
-
/**
|
|
2563
|
-
* getBlueprintDiff - getBlueprintDiff
|
|
2564
|
-
*
|
|
2565
|
-
* Makes the diff of a blueprint vs the current state of its resources
|
|
2566
|
-
*
|
|
2567
|
-
*/
|
|
2568
|
-
'get'(
|
|
2569
|
-
parameters?: Parameters<Paths.GetBlueprintDiff.PathParameters> | null,
|
|
2570
|
-
data?: any,
|
|
2571
|
-
config?: AxiosRequestConfig
|
|
2572
|
-
): OperationResponse<any>
|
|
2573
|
-
}
|
|
2574
2530
|
['/v2/blueprint-manifest/blueprint:install']: {
|
|
2575
2531
|
/**
|
|
2576
2532
|
* installBlueprint - installBlueprint
|
|
@@ -2629,19 +2585,6 @@ export interface PathsDictionary {
|
|
|
2629
2585
|
config?: AxiosRequestConfig
|
|
2630
2586
|
): OperationResponse<Paths.ExportBlueprint.Responses.$202>
|
|
2631
2587
|
}
|
|
2632
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}:create-plan']: {
|
|
2633
|
-
/**
|
|
2634
|
-
* createBlueprintPlan - createBlueprintPlan
|
|
2635
|
-
*
|
|
2636
|
-
* Kick off a new blueprint plan creation job. Returns 202 Accepted with Location header pointing to the job resource.
|
|
2637
|
-
*
|
|
2638
|
-
*/
|
|
2639
|
-
'post'(
|
|
2640
|
-
parameters?: Parameters<Paths.CreateBlueprintPlan.PathParameters> | null,
|
|
2641
|
-
data?: any,
|
|
2642
|
-
config?: AxiosRequestConfig
|
|
2643
|
-
): OperationResponse<Paths.CreateBlueprintPlan.Responses.$202>
|
|
2644
|
-
}
|
|
2645
2588
|
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources']: {
|
|
2646
2589
|
/**
|
|
2647
2590
|
* addBlueprintResource - addBlueprintResource
|
|
@@ -2772,7 +2715,6 @@ export interface PathsDictionary {
|
|
|
2772
2715
|
|
|
2773
2716
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2774
2717
|
|
|
2775
|
-
|
|
2776
2718
|
export type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
2777
2719
|
export type Blueprint = Components.Schemas.Blueprint;
|
|
2778
2720
|
export type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
|
|
@@ -2794,8 +2736,6 @@ export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
|
|
|
2794
2736
|
export type CommonResourceNode = Components.Schemas.CommonResourceNode;
|
|
2795
2737
|
export type CustomBlueprint = Components.Schemas.CustomBlueprint;
|
|
2796
2738
|
export type DeployedBlueprint = Components.Schemas.DeployedBlueprint;
|
|
2797
|
-
export type DiffRow = Components.Schemas.DiffRow;
|
|
2798
|
-
export type DiffRowArray = Components.Schemas.DiffRowArray;
|
|
2799
2739
|
export type FileBlueprint = Components.Schemas.FileBlueprint;
|
|
2800
2740
|
export type FormattedError = Components.Schemas.FormattedError;
|
|
2801
2741
|
export type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
|
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.2.2",
|
|
6
6
|
"description": "Service to create and install Blueprint Manifest files"
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -50,6 +50,7 @@
|
|
|
50
50
|
"operationId": "getJob",
|
|
51
51
|
"summary": "getJob",
|
|
52
52
|
"description": "Get the current status of a blueprint (export or import)",
|
|
53
|
+
"deprecated": true,
|
|
53
54
|
"tags": [
|
|
54
55
|
"Jobs"
|
|
55
56
|
],
|
|
@@ -77,6 +78,7 @@
|
|
|
77
78
|
"operationId": "createExport",
|
|
78
79
|
"summary": "createExport",
|
|
79
80
|
"description": "Creates a new Export Job with a list of available resources to export from the passed root resource.\n\nMultiple root resources can be added by calling this multiple times with the same jobId\n",
|
|
81
|
+
"deprecated": true,
|
|
80
82
|
"tags": [
|
|
81
83
|
"Export"
|
|
82
84
|
],
|
|
@@ -152,6 +154,7 @@
|
|
|
152
154
|
"operationId": "exportManifest",
|
|
153
155
|
"summary": "exportManifest",
|
|
154
156
|
"description": "Triggers exporting a manifest file using selected resoruce ids for a job created with `createExportJob`",
|
|
157
|
+
"deprecated": true,
|
|
155
158
|
"tags": [
|
|
156
159
|
"Export"
|
|
157
160
|
],
|
|
@@ -297,6 +300,7 @@
|
|
|
297
300
|
"operationId": "createPlan",
|
|
298
301
|
"summary": "createPlan",
|
|
299
302
|
"description": "Creates a new import job from an uploaded manifest file and returns the plan.\n\nCreates an updated plan for an installed manifest when `manifest_id` is passed\n",
|
|
303
|
+
"deprecated": true,
|
|
300
304
|
"tags": [
|
|
301
305
|
"Import"
|
|
302
306
|
],
|
|
@@ -501,6 +505,7 @@
|
|
|
501
505
|
"operationId": "applyPlan",
|
|
502
506
|
"summary": "applyPlan",
|
|
503
507
|
"description": "Apply a plan returned by `createPlan`.",
|
|
508
|
+
"deprecated": true,
|
|
504
509
|
"tags": [
|
|
505
510
|
"Import"
|
|
506
511
|
],
|
|
@@ -558,6 +563,7 @@
|
|
|
558
563
|
"operationId": "listInstalledManifests",
|
|
559
564
|
"summary": "listInstalledManifests",
|
|
560
565
|
"description": "List Blueprint Manifests installed to the organization",
|
|
566
|
+
"deprecated": true,
|
|
561
567
|
"tags": [
|
|
562
568
|
"Manifests"
|
|
563
569
|
],
|
|
@@ -592,6 +598,7 @@
|
|
|
592
598
|
"operationId": "getManifest",
|
|
593
599
|
"summary": "getManifest",
|
|
594
600
|
"description": "Get installed Manifest by ID",
|
|
601
|
+
"deprecated": true,
|
|
595
602
|
"tags": [
|
|
596
603
|
"Manifests"
|
|
597
604
|
],
|
|
@@ -622,6 +629,7 @@
|
|
|
622
629
|
"operationId": "updateManifest",
|
|
623
630
|
"summary": "updateManifest",
|
|
624
631
|
"description": "Update an installed manifest\n",
|
|
632
|
+
"deprecated": true,
|
|
625
633
|
"tags": [
|
|
626
634
|
"Manifests"
|
|
627
635
|
],
|
|
@@ -661,6 +669,7 @@
|
|
|
661
669
|
"operationId": "deleteManifest",
|
|
662
670
|
"summary": "deleteManifest",
|
|
663
671
|
"description": "Remove installed manifest from the org\n\nNote that this does not delete the installed resources of the Manifest!\n",
|
|
672
|
+
"deprecated": true,
|
|
664
673
|
"tags": [
|
|
665
674
|
"Manifests"
|
|
666
675
|
],
|
|
@@ -794,46 +803,6 @@
|
|
|
794
803
|
}
|
|
795
804
|
}
|
|
796
805
|
},
|
|
797
|
-
"/v2/blueprint-manifest/blueprint/{blueprint_id}/diff": {
|
|
798
|
-
"get": {
|
|
799
|
-
"operationId": "getBlueprintDiff",
|
|
800
|
-
"summary": "getBlueprintDiff",
|
|
801
|
-
"description": "Makes the diff of a blueprint vs the current state of its resources\n",
|
|
802
|
-
"tags": [
|
|
803
|
-
"Blueprints"
|
|
804
|
-
],
|
|
805
|
-
"parameters": [
|
|
806
|
-
{
|
|
807
|
-
"in": "path",
|
|
808
|
-
"required": true,
|
|
809
|
-
"name": "blueprint_id",
|
|
810
|
-
"schema": {
|
|
811
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
812
|
-
}
|
|
813
|
-
}
|
|
814
|
-
]
|
|
815
|
-
},
|
|
816
|
-
"responses": {
|
|
817
|
-
"200": {
|
|
818
|
-
"description": "The diff for the given blueprint",
|
|
819
|
-
"content": {
|
|
820
|
-
"application/json": {
|
|
821
|
-
"schema": {
|
|
822
|
-
"type": "object",
|
|
823
|
-
"properties": {
|
|
824
|
-
"diffRows": {
|
|
825
|
-
"$ref": "#/components/schemas/DiffRowArray"
|
|
826
|
-
}
|
|
827
|
-
},
|
|
828
|
-
"required": [
|
|
829
|
-
"diffRows"
|
|
830
|
-
]
|
|
831
|
-
}
|
|
832
|
-
}
|
|
833
|
-
}
|
|
834
|
-
}
|
|
835
|
-
}
|
|
836
|
-
},
|
|
837
806
|
"/v2/blueprint-manifest/blueprint:install": {
|
|
838
807
|
"post": {
|
|
839
808
|
"operationId": "installBlueprint",
|
|
@@ -1084,51 +1053,6 @@
|
|
|
1084
1053
|
}
|
|
1085
1054
|
}
|
|
1086
1055
|
},
|
|
1087
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}:create-plan": {
|
|
1088
|
-
"post": {
|
|
1089
|
-
"operationId": "createBlueprintPlan",
|
|
1090
|
-
"summary": "createBlueprintPlan",
|
|
1091
|
-
"description": "Kick off a new blueprint plan creation job. Returns 202 Accepted with Location header pointing to the job resource.\n",
|
|
1092
|
-
"tags": [
|
|
1093
|
-
"Blueprints"
|
|
1094
|
-
],
|
|
1095
|
-
"parameters": [
|
|
1096
|
-
{
|
|
1097
|
-
"in": "path",
|
|
1098
|
-
"required": true,
|
|
1099
|
-
"name": "blueprint_id",
|
|
1100
|
-
"schema": {
|
|
1101
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
1102
|
-
}
|
|
1103
|
-
}
|
|
1104
|
-
],
|
|
1105
|
-
"responses": {
|
|
1106
|
-
"202": {
|
|
1107
|
-
"description": "Blueprint export plan job started",
|
|
1108
|
-
"headers": {
|
|
1109
|
-
"Location": {
|
|
1110
|
-
"description": "URL to poll the job",
|
|
1111
|
-
"schema": {
|
|
1112
|
-
"type": "string"
|
|
1113
|
-
}
|
|
1114
|
-
}
|
|
1115
|
-
},
|
|
1116
|
-
"content": {
|
|
1117
|
-
"application/json": {
|
|
1118
|
-
"schema": {
|
|
1119
|
-
"type": "object",
|
|
1120
|
-
"properties": {
|
|
1121
|
-
"job_id": {
|
|
1122
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1123
|
-
}
|
|
1124
|
-
}
|
|
1125
|
-
}
|
|
1126
|
-
}
|
|
1127
|
-
}
|
|
1128
|
-
}
|
|
1129
|
-
}
|
|
1130
|
-
}
|
|
1131
|
-
},
|
|
1132
1056
|
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources": {
|
|
1133
1057
|
"post": {
|
|
1134
1058
|
"operationId": "addBlueprintResource",
|
|
@@ -1634,59 +1558,6 @@
|
|
|
1634
1558
|
},
|
|
1635
1559
|
"components": {
|
|
1636
1560
|
"schemas": {
|
|
1637
|
-
"DiffRow": {
|
|
1638
|
-
"type": "object",
|
|
1639
|
-
"required": [
|
|
1640
|
-
"type",
|
|
1641
|
-
"key",
|
|
1642
|
-
"before",
|
|
1643
|
-
"after",
|
|
1644
|
-
"resource"
|
|
1645
|
-
],
|
|
1646
|
-
"properties": {
|
|
1647
|
-
"type": {
|
|
1648
|
-
"type": "string",
|
|
1649
|
-
"enum": [
|
|
1650
|
-
"added",
|
|
1651
|
-
"removed",
|
|
1652
|
-
"changed",
|
|
1653
|
-
"no-op"
|
|
1654
|
-
]
|
|
1655
|
-
},
|
|
1656
|
-
"key": {
|
|
1657
|
-
"type": "string"
|
|
1658
|
-
},
|
|
1659
|
-
"before": {
|
|
1660
|
-
"oneOf": [
|
|
1661
|
-
{
|
|
1662
|
-
"type": "string"
|
|
1663
|
-
},
|
|
1664
|
-
{
|
|
1665
|
-
"type": "null"
|
|
1666
|
-
}
|
|
1667
|
-
]
|
|
1668
|
-
},
|
|
1669
|
-
"after": {
|
|
1670
|
-
"oneOf": [
|
|
1671
|
-
{
|
|
1672
|
-
"type": "string"
|
|
1673
|
-
},
|
|
1674
|
-
{
|
|
1675
|
-
"type": "null"
|
|
1676
|
-
}
|
|
1677
|
-
]
|
|
1678
|
-
},
|
|
1679
|
-
"resource": {
|
|
1680
|
-
"type": "string"
|
|
1681
|
-
}
|
|
1682
|
-
}
|
|
1683
|
-
},
|
|
1684
|
-
"DiffRowArray": {
|
|
1685
|
-
"type": "array",
|
|
1686
|
-
"items": {
|
|
1687
|
-
"$ref": "#/components/schemas/DiffRow"
|
|
1688
|
-
}
|
|
1689
|
-
},
|
|
1690
1561
|
"BlueprintID": {
|
|
1691
1562
|
"type": "string",
|
|
1692
1563
|
"description": "ID of a blueprint",
|
|
@@ -1778,6 +1649,12 @@
|
|
|
1778
1649
|
},
|
|
1779
1650
|
"updated_by": {
|
|
1780
1651
|
"$ref": "#/components/schemas/CallerIdentity"
|
|
1652
|
+
},
|
|
1653
|
+
"installation_job_ids": {
|
|
1654
|
+
"type": "array",
|
|
1655
|
+
"items": {
|
|
1656
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1657
|
+
}
|
|
1781
1658
|
}
|
|
1782
1659
|
},
|
|
1783
1660
|
"required": [
|
|
@@ -2246,6 +2123,8 @@
|
|
|
2246
2123
|
"journey",
|
|
2247
2124
|
"product",
|
|
2248
2125
|
"price",
|
|
2126
|
+
"product_recommendation",
|
|
2127
|
+
"coupon",
|
|
2249
2128
|
"tax",
|
|
2250
2129
|
"automation_flow",
|
|
2251
2130
|
"entity_mapping",
|
|
@@ -2262,12 +2141,12 @@
|
|
|
2262
2141
|
"webhook",
|
|
2263
2142
|
"dashboard",
|
|
2264
2143
|
"custom_variable",
|
|
2265
|
-
"coupon",
|
|
2266
2144
|
"usergroup",
|
|
2267
2145
|
"saved_view",
|
|
2268
2146
|
"app",
|
|
2269
2147
|
"role",
|
|
2270
|
-
"portal_config"
|
|
2148
|
+
"portal_config",
|
|
2149
|
+
"target"
|
|
2271
2150
|
]
|
|
2272
2151
|
},
|
|
2273
2152
|
"PlanChanges": {
|