@epilot/blueprint-manifest-client 3.0.6 → 3.0.8

package/dist/openapi.d.ts

@@ -47,7 +47,6 @@ declare namespace Components {
                 postinstall?: string;
             };
             version?: string;
-            latest_download_file?: S3Reference;
             deployments?: {
                 source_org_id?: string;
                 source_blueprint_id?: string;
@@ -59,6 +58,7 @@ declare namespace Components {
              * Whether the blueprint is verified by epilot
              */
             is_verified?: boolean;
+            installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
@@ -251,7 +251,6 @@ declare namespace Components {
                 postinstall?: string;
             };
             version?: string;
-            latest_download_file?: S3Reference;
             deployments?: {
                 source_org_id?: string;
                 source_blueprint_id?: string;
@@ -263,6 +262,7 @@ declare namespace Components {
              * Whether the blueprint is verified by epilot
              */
             is_verified?: boolean;
+            installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
@@ -317,6 +317,16 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            pre_install_requirements?: /**
+             * List of feature settings that must be enabled before installing the blueprint
+             * example:
+             * [
+             *   "journey_automation",
+             *   "ticket-entities",
+             *   "advanced_permissions"
+             * ]
+             */
+            PreInstallRequirements;
             /**
              * A URL to download the source blueprint file used to import the blueprint
              * example:
@@ -470,7 +480,6 @@ declare namespace Components {
                 postinstall?: string;
             };
             version?: string;
-            latest_download_file?: S3Reference;
             deployments?: {
                 source_org_id?: string;
                 source_blueprint_id?: string;
@@ -482,6 +491,7 @@ declare namespace Components {
              * Whether the blueprint is verified by epilot
              */
             is_verified?: boolean;
+            installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
@@ -515,7 +525,6 @@ declare namespace Components {
                 postinstall?: string;
             };
             version?: string;
-            latest_download_file?: S3Reference;
             deployments?: {
                 source_org_id?: string;
                 source_blueprint_id?: string;
@@ -527,6 +536,7 @@ declare namespace Components {
              * Whether the blueprint is verified by epilot
              */
             is_verified?: boolean;
+            installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
@@ -560,7 +570,6 @@ declare namespace Components {
                 postinstall?: string;
             };
             version?: string;
-            latest_download_file?: S3Reference;
             deployments?: {
                 source_org_id?: string;
                 source_blueprint_id?: string;
@@ -572,6 +581,7 @@ declare namespace Components {
              * Whether the blueprint is verified by epilot
              */
             is_verified?: boolean;
+            installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
@@ -694,6 +704,16 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            pre_install_requirements?: /**
+             * List of feature settings that must be enabled before installing the blueprint
+             * example:
+             * [
+             *   "journey_automation",
+             *   "ticket-entities",
+             *   "advanced_permissions"
+             * ]
+             */
+            PreInstallRequirements;
             /**
              * A URL to download the source blueprint file used to import the blueprint
              * example:
@@ -816,6 +836,16 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            pre_install_requirements?: /**
+             * List of feature settings that must be enabled before installing the blueprint
+             * example:
+             * [
+             *   "journey_automation",
+             *   "ticket-entities",
+             *   "advanced_permissions"
+             * ]
+             */
+            PreInstallRequirements;
             /**
              * A URL to download the source blueprint file used to import the blueprint
              * example:
@@ -971,6 +1001,16 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            pre_install_requirements?: /**
+             * List of feature settings that must be enabled before installing the blueprint
+             * example:
+             * [
+             *   "journey_automation",
+             *   "ticket-entities",
+             *   "advanced_permissions"
+             * ]
+             */
+            PreInstallRequirements;
             /**
              * A URL to download the source blueprint file used to import the blueprint
              * example:
@@ -1096,7 +1136,6 @@ declare namespace Components {
                 postinstall?: string;
             };
             version?: string;
-            latest_download_file?: S3Reference;
             deployments?: {
                 source_org_id?: string;
                 source_blueprint_id?: string;
@@ -1108,6 +1147,7 @@ declare namespace Components {
              * Whether the blueprint is verified by epilot
              */
             is_verified?: boolean;
+            installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: CallerIdentity;
@@ -1120,6 +1160,16 @@ declare namespace Components {
             resources?: BlueprintResource[];
         }
         export type PlanChanges = ("create" | "update" | "internal-update" | "no-op" | "delete")[];
+        /**
+         * List of feature settings that must be enabled before installing the blueprint
+         * example:
+         * [
+         *   "journey_automation",
+         *   "ticket-entities",
+         *   "advanced_permissions"
+         * ]
+         */
+        export type PreInstallRequirements = string[];
         export interface PutManifestPayload {
             /**
              * Name of the source blueprint
@@ -1177,6 +1227,10 @@ declare namespace Components {
                 type?: /* Type of the resource */ ResourceNodeType;
             }[];
             changes?: PlanChanges;
+            /**
+             * Fields causing the updates / internal updates on a resource install
+             */
+            changes_reason?: string[];
         }
         /**
          * Type of the resource
@@ -1223,6 +1277,10 @@ declare namespace Components {
              */
             dependencies?: VirtualResourceNodeGroup[] | null;
             changes?: PlanChanges;
+            /**
+             * Fields causing the updates / internal updates on a resource install
+             */
+            changes_reason?: string[];
         }
         export interface S3Reference {
             /**
@@ -2623,6 +2681,7 @@ export type ManifestSource = Components.Schemas.ManifestSource;
 export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
 export type MarketplaceBlueprint = Components.Schemas.MarketplaceBlueprint;
 export type PlanChanges = Components.Schemas.PlanChanges;
+export type PreInstallRequirements = Components.Schemas.PreInstallRequirements;
 export type PutManifestPayload = Components.Schemas.PutManifestPayload;
 export type ResourceNode = Components.Schemas.ResourceNode;
 export type ResourceNodeType = Components.Schemas.ResourceNodeType;

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "Blueprint Manifest API",
-    "version": "2.1.1",
+    "version": "2.1.2",
     "description": "Service to create and install Blueprint Manifest files"
   },
   "tags": [
@@ -1540,9 +1540,6 @@
           "version": {
             "type": "string"
           },
-          "latest_download_file": {
-            "$ref": "#/components/schemas/S3Reference"
-          },
           "deployments": {
             "type": "array",
             "items": {
@@ -1571,6 +1568,16 @@
             "type": "boolean",
             "description": "Whether the blueprint is verified by epilot"
           },
+          "installation_status": {
+            "type": "string",
+            "enum": [
+              "IN_PROGRESS",
+              "CANCELED",
+              "PARTIAL",
+              "SUCCESS",
+              "FAILED"
+            ]
+          },
           "created_at": {
             "type": "string",
             "format": "date-time"
@@ -2139,6 +2146,13 @@
               },
               "changes": {
                 "$ref": "#/components/schemas/PlanChanges"
+              },
+              "changes_reason": {
+                "type": "array",
+                "description": "Fields causing the updates / internal updates on a resource install",
+                "items": {
+                  "type": "string"
+                }
               }
             }
           }
@@ -2208,6 +2222,13 @@
               },
               "changes": {
                 "$ref": "#/components/schemas/PlanChanges"
+              },
+              "changes_reason": {
+                "type": "array",
+                "description": "Fields causing the updates / internal updates on a resource install",
+                "items": {
+                  "type": "string"
+                }
               }
             }
           }
@@ -2356,6 +2377,9 @@
             "description": "Version of the blueprint (semver)",
             "example": "1.0.0"
           },
+          "pre_install_requirements": {
+            "$ref": "#/components/schemas/PreInstallRequirements"
+          },
           "source_blueprint_file": {
             "type": "string",
             "deprecated": true,
@@ -2529,6 +2553,18 @@
           }
         }
       },
+      "PreInstallRequirements": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "description": "List of feature settings that must be enabled before installing the blueprint",
+        "example": [
+          "journey_automation",
+          "ticket-entities",
+          "advanced_permissions"
+        ]
+      },
       "BlueprintInstallStatus": {
         "type": "string",
         "enum": [

package/package.json

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