@epilot/blueprint-manifest-client 3.2.1 → 3.3.0

package/dist/definition.js

@@ -1 +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","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: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})})();
+(()=>{"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})})();

package/dist/openapi-runtime.json

@@ -13,6 +13,7 @@
     "/v1/blueprint-manifest/jobs/{job_id}": {
       "get": {
         "operationId": "getJob",
+        "deprecated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/JobID"
@@ -24,6 +25,7 @@
     "/v1/blueprint-manifest/jobs:createExport": {
       "post": {
         "operationId": "createExport",
+        "deprecated": true,
         "requestBody": {
           "content": {
             "application/json": {}
@@ -35,6 +37,7 @@
     "/v1/blueprint-manifest/jobs/{job_id}:exportManifest": {
       "post": {
         "operationId": "exportManifest",
+        "deprecated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/JobID"
@@ -62,6 +65,7 @@
     "/v1/blueprint-manifest/jobs:createPlan": {
       "post": {
         "operationId": "createPlan",
+        "deprecated": true,
         "requestBody": {
           "content": {
             "application/json": {}
@@ -73,6 +77,7 @@
     "/v1/blueprint-manifest/jobs/{job_id}:applyPlan": {
       "post": {
         "operationId": "applyPlan",
+        "deprecated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/JobID"
@@ -89,12 +94,14 @@
     "/v1/blueprint-manifest/manifests": {
       "get": {
         "operationId": "listInstalledManifests",
+        "deprecated": true,
         "responses": {}
       }
     },
     "/v1/blueprint-manifest/manifests/{manifest_id}": {
       "get": {
         "operationId": "getManifest",
+        "deprecated": true,
         "parameters": [
           {
             "in": "path",
@@ -106,6 +113,7 @@
       },
       "put": {
         "operationId": "updateManifest",
+        "deprecated": true,
         "parameters": [
           {
             "in": "path",
@@ -122,6 +130,7 @@
       },
       "delete": {
         "operationId": "deleteManifest",
+        "deprecated": true,
         "parameters": [
           {
             "in": "path",

package/dist/openapi.d.ts

@@ -63,6 +63,12 @@ declare namespace Components {
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            installation_job_ids?: /**
+             * ID of a job
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            BlueprintJobID[];
             source_type: "app";
             resources?: BlueprintResource[];
         }
@@ -267,6 +273,12 @@ declare namespace Components {
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            installation_job_ids?: /**
+             * ID of a job
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            BlueprintJobID[];
         }
         export interface CommonBlueprintJobFields {
             id?: /**
@@ -496,6 +508,12 @@ declare namespace Components {
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            installation_job_ids?: /**
+             * ID of a job
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            BlueprintJobID[];
             resources?: BlueprintResource[];
             source_type: "custom";
         }
@@ -541,6 +559,12 @@ declare namespace Components {
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            installation_job_ids?: /**
+             * ID of a job
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            BlueprintJobID[];
             source_type: "deploy";
             resources?: BlueprintResource[];
         }
@@ -586,6 +610,12 @@ declare namespace Components {
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            installation_job_ids?: /**
+             * ID of a job
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            BlueprintJobID[];
             source_type: "file";
             resources?: BlueprintResource[];
         }
@@ -1152,6 +1182,12 @@ declare namespace Components {
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            installation_job_ids?: /**
+             * ID of a job
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            BlueprintJobID[];
             /**
              * URL to the blueprint documentation
              */
@@ -1235,7 +1271,7 @@ declare namespace Components {
         /**
          * Type of the resource
          */
-        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" | "coupon" | "product_recommendation" | "usergroup" | "saved_view" | "app" | "role" | "portal_config";
+        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";
         export interface ResourceReplacement {
             /**
              * Original resource ID to be replaced

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "Blueprint Manifest API",
-    "version": "3.2.1",
+    "version": "3.2.2",
     "description": "Service to create and install Blueprint Manifest files"
   },
   "tags": [
@@ -50,6 +50,7 @@
         "operationId": "getJob",
         "summary": "getJob",
         "description": "Get the current status of a blueprint (export or import)",
+        "deprecated": true,
         "tags": [
           "Jobs"
         ],
@@ -77,6 +78,7 @@
         "operationId": "createExport",
         "summary": "createExport",
         "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",
+        "deprecated": true,
         "tags": [
           "Export"
         ],
@@ -152,6 +154,7 @@
         "operationId": "exportManifest",
         "summary": "exportManifest",
         "description": "Triggers exporting a manifest file using selected resoruce ids for a job created with `createExportJob`",
+        "deprecated": true,
         "tags": [
           "Export"
         ],
@@ -297,6 +300,7 @@
         "operationId": "createPlan",
         "summary": "createPlan",
         "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",
+        "deprecated": true,
         "tags": [
           "Import"
         ],
@@ -501,6 +505,7 @@
         "operationId": "applyPlan",
         "summary": "applyPlan",
         "description": "Apply a plan returned by `createPlan`.",
+        "deprecated": true,
         "tags": [
           "Import"
         ],
@@ -558,6 +563,7 @@
         "operationId": "listInstalledManifests",
         "summary": "listInstalledManifests",
         "description": "List Blueprint Manifests installed to the organization",
+        "deprecated": true,
         "tags": [
           "Manifests"
         ],
@@ -592,6 +598,7 @@
         "operationId": "getManifest",
         "summary": "getManifest",
         "description": "Get installed Manifest by ID",
+        "deprecated": true,
         "tags": [
           "Manifests"
         ],
@@ -622,6 +629,7 @@
         "operationId": "updateManifest",
         "summary": "updateManifest",
         "description": "Update an installed manifest\n",
+        "deprecated": true,
         "tags": [
           "Manifests"
         ],
@@ -661,6 +669,7 @@
         "operationId": "deleteManifest",
         "summary": "deleteManifest",
         "description": "Remove installed manifest from the org\n\nNote that this does not delete the installed resources of the Manifest!\n",
+        "deprecated": true,
         "tags": [
           "Manifests"
         ],
@@ -1640,6 +1649,12 @@
           },
           "updated_by": {
             "$ref": "#/components/schemas/CallerIdentity"
+          },
+          "installation_job_ids": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/BlueprintJobID"
+            }
           }
         },
         "required": [
@@ -2108,6 +2123,8 @@
           "journey",
           "product",
           "price",
+          "product_recommendation",
+          "coupon",
           "tax",
           "automation_flow",
           "entity_mapping",
@@ -2124,13 +2141,12 @@
           "webhook",
           "dashboard",
           "custom_variable",
-          "coupon",
-          "product_recommendation",
           "usergroup",
           "saved_view",
           "app",
           "role",
-          "portal_config"
+          "portal_config",
+          "target"
         ]
       },
       "PlanChanges": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/blueprint-manifest-client",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "Client for epilot Terraform Blueprint Manifest API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",