@epilot/blueprint-manifest-client 2.3.1 → 2.3.2

package/dist/openapi.d.ts

@@ -86,6 +86,28 @@ declare namespace Components {
                 postinstall?: string;
             };
         }
+        export interface CommonResourceNode {
+            /**
+             * ID of the resource
+             */
+            id: string;
+            /**
+             * Type of the resource
+             */
+            type: ResourceNodeType;
+            /**
+             * Name of the resource
+             */
+            name?: string;
+            /**
+             * Source ID of the resource
+             */
+            source_id?: string;
+            /**
+             * Whether the resource is virtual
+             */
+            is_virtual?: boolean;
+        }
         export interface Job {
             job_id?: /**
              * ID of an import or export job (state machine)
@@ -301,59 +323,106 @@ declare namespace Components {
              */
             updated_at?: string; // date-time
         }
+        export type PlanChanges = ("create" | "update" | "no-op" | "delete")[];
         export interface ResourceNode {
+            /**
+             * ID of the resource
+             */
             id: string;
             type: ResourceNodeType;
+            /**
+             * Name of the resource
+             */
             name?: string;
+            /**
+             * Original ID of the exported resource
+             */
             source_id?: string;
+            /**
+             * Whether the resource is virtual
+             */
+            is_virtual?: boolean;
+            /**
+             * Terraform address of the resource
+             */
             address?: string;
-            changes?: ("create" | "update" | "no-op" | "delete")[];
+            /**
+             * Dependencies of the resource
+             */
+            dependencies?: ResourceNode[] | null;
             parents?: {
                 id?: string;
                 type?: ResourceNodeType;
             }[];
+            changes?: PlanChanges;
         }
-        export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook";
+        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";
         export interface RootResourceNode {
+            /**
+             * ID of the resource
+             */
             id: string;
             type: ResourceNodeType;
+            /**
+             * Name of the resource
+             */
             name?: string;
+            /**
+             * Source ID of the resource
+             */
             source_id?: string;
+            /**
+             * Whether the resource is virtual
+             */
+            is_virtual?: boolean;
+            /**
+             * Terraform address of the resource
+             */
             address?: string;
-            dependencies?: VirtualResourceNodeGroup[];
-            changes?: ("create" | "update" | "no-op" | "delete")[];
+            /**
+             * Dependencies of the resource
+             */
+            dependencies?: VirtualResourceNodeGroup[] | null;
+            changes?: PlanChanges;
         }
         export interface S3Reference {
             /**
              * example:
              * blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
              */
-            bucket?: string;
+            bucket: string;
             /**
              * example:
              * templates/main.tf
              */
-            key?: string;
+            key: string;
         }
         export interface UploadFilePayload {
             /**
              * example:
-             * main.tf
+             * example.manifest.zip
              */
             filename: string;
-            /**
-             * MIME type of file
-             * example:
-             * application/pdf
-             */
-            mime_type?: string;
         }
         export interface VirtualResourceNodeGroup {
+            /**
+             * ID of the resource
+             */
             id: string;
             type: ResourceNodeType;
+            /**
+             * Name of the resource
+             */
             name?: string;
+            /**
+             * Source ID of the resource
+             */
+            source_id?: string;
+            /**
+             * Whether the resource is virtual
+             */
+            is_virtual?: true;
             dependencies?: ResourceNode[];
-            is_virtual?: boolean;
         }
     }
 }
@@ -390,8 +459,8 @@ declare namespace Paths {
     }
     namespace CreateExport {
         export interface RequestBody {
-            resourceType?: Components.Schemas.ResourceNodeType;
-            resourceIds?: [
+            resourceType: Components.Schemas.ResourceNodeType;
+            resourceIds: [
                 string,
                 string?,
                 string?,
@@ -450,12 +519,12 @@ declare namespace Paths {
                  * example:
                  * blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
                  */
-                bucket?: string;
+                bucket: string;
                 /**
                  * example:
                  * templates/main.tf
                  */
-                key?: string;
+                key: string;
             };
             /**
              * ID of an imported / installed manifest
@@ -465,11 +534,15 @@ declare namespace Paths {
             manifest_id?: string;
         } | {
             /**
-             * Manifest file key uploaded via `uploadManifest`
-             * example:
-             * example.tf
+             * Manifest s3 key uploaded via `uploadManifest`
              */
             manifestFilePath: string;
+            /**
+             * ID of an imported / installed manifest
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            manifest_id?: string;
         };
         namespace Responses {
             export interface $200 {
@@ -513,12 +586,12 @@ declare namespace Paths {
             /**
              * An array of resource IDs to export
              */
-            selectedResourceIds?: string[];
+            selectedResourceIds: string[];
             /**
              * example:
              * journey_HouseConnectionJourney
              */
-            resourceName?: string;
+            resourceName: string;
             /**
              * Temporary flag to indicate if multiple resources are being exported
              */
@@ -821,6 +894,7 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 export type CommonImportFields = Components.Schemas.CommonImportFields;
 export type CommonManifestFields = Components.Schemas.CommonManifestFields;
 export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
+export type CommonResourceNode = Components.Schemas.CommonResourceNode;
 export type Job = Components.Schemas.Job;
 export type JobID = Components.Schemas.JobID;
 export type JobStatus = Components.Schemas.JobStatus;
@@ -828,6 +902,7 @@ export type Manifest = Components.Schemas.Manifest;
 export type ManifestID = Components.Schemas.ManifestID;
 export type ManifestItem = Components.Schemas.ManifestItem;
 export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
+export type PlanChanges = Components.Schemas.PlanChanges;
 export type ResourceNode = Components.Schemas.ResourceNode;
 export type ResourceNodeType = Components.Schemas.ResourceNodeType;
 export type RootResourceNode = Components.Schemas.RootResourceNode;

package/dist/openapi.json

@@ -96,7 +96,11 @@
                     "type": "boolean",
                     "description": "Temporary flag to indicate if multiple resources are being exported"
                   }
-                }
+                },
+                "required": [
+                  "resourceType",
+                  "resourceIds"
+                ]
               }
             }
           }
@@ -154,7 +158,11 @@
                     "type": "boolean",
                     "description": "Temporary flag to indicate if multiple resources are being exported"
                   }
-                }
+                },
+                "required": [
+                  "resourceName",
+                  "selectedResourceIds"
+                ]
               }
             }
           }
@@ -262,12 +270,22 @@
                   },
                   {
                     "type": "object",
+                    "deprecated": true,
                     "properties": {
                       "manifestFilePath": {
                         "deprecated": true,
-                        "description": "Manifest file key uploaded via `uploadManifest`",
-                        "type": "string",
-                        "example": "example.tf"
+                        "description": "Manifest s3 key uploaded via `uploadManifest`",
+                        "type": "string"
+                      },
+                      "manifest_id": {
+                        "allOf": [
+                          {
+                            "description": "Update an existing manifest (optional)"
+                          },
+                          {
+                            "$ref": "#/components/schemas/ManifestID"
+                          }
+                        ]
                       }
                     },
                     "required": [
@@ -508,47 +526,47 @@
           "schema_attribute",
           "schema_capability",
           "schema_group",
+          "schema_group_headline",
           "workflow_definition",
           "closing_reason",
           "taxonomy_classification",
           "webhook"
         ]
       },
-      "RootResourceNode": {
+      "PlanChanges": {
+        "type": "array",
+        "items": {
+          "type": "string",
+          "enum": [
+            "create",
+            "update",
+            "no-op",
+            "delete"
+          ]
+        }
+      },
+      "CommonResourceNode": {
         "type": "object",
         "properties": {
           "id": {
-            "type": "string"
+            "type": "string",
+            "description": "ID of the resource"
           },
           "type": {
-            "$ref": "#/components/schemas/ResourceNodeType"
+            "$ref": "#/components/schemas/ResourceNodeType",
+            "description": "Type of the resource"
           },
           "name": {
-            "type": "string"
+            "type": "string",
+            "description": "Name of the resource"
           },
           "source_id": {
-            "type": "string"
-          },
-          "address": {
-            "type": "string"
-          },
-          "dependencies": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/VirtualResourceNodeGroup"
-            }
+            "type": "string",
+            "description": "Source ID of the resource"
           },
-          "changes": {
-            "type": "array",
-            "items": {
-              "type": "string",
-              "enum": [
-                "create",
-                "update",
-                "no-op",
-                "delete"
-              ]
-            }
+          "is_virtual": {
+            "type": "boolean",
+            "description": "Whether the resource is virtual"
           }
         },
         "required": [
@@ -556,81 +574,100 @@
           "type"
         ]
       },
-      "VirtualResourceNodeGroup": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string"
-          },
-          "type": {
-            "$ref": "#/components/schemas/ResourceNodeType"
-          },
-          "name": {
-            "type": "string"
+      "RootResourceNode": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CommonResourceNode"
           },
-          "dependencies": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/ResourceNode"
+          {
+            "type": "object",
+            "properties": {
+              "address": {
+                "type": "string",
+                "description": "Terraform address of the resource"
+              },
+              "dependencies": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/VirtualResourceNodeGroup"
+                },
+                "description": "Dependencies of the resource",
+                "nullable": true
+              },
+              "changes": {
+                "$ref": "#/components/schemas/PlanChanges"
+              }
             }
-          },
-          "is_virtual": {
-            "type": "boolean"
           }
-        },
-        "required": [
-          "id",
-          "type"
         ]
       },
-      "ResourceNode": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string"
-          },
-          "type": {
-            "$ref": "#/components/schemas/ResourceNodeType"
-          },
-          "name": {
-            "type": "string"
-          },
-          "source_id": {
-            "type": "string"
-          },
-          "address": {
-            "type": "string"
+      "VirtualResourceNodeGroup": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CommonResourceNode"
           },
-          "changes": {
-            "type": "array",
-            "items": {
-              "type": "string",
-              "enum": [
-                "create",
-                "update",
-                "no-op",
-                "delete"
-              ]
+          {
+            "type": "object",
+            "properties": {
+              "dependencies": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ResourceNode"
+                }
+              },
+              "is_virtual": {
+                "type": "boolean",
+                "enum": [
+                  true
+                ]
+              }
             }
+          }
+        ]
+      },
+      "ResourceNode": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CommonResourceNode"
           },
-          "parents": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "properties": {
-                "id": {
-                  "type": "string"
+          {
+            "type": "object",
+            "properties": {
+              "address": {
+                "type": "string",
+                "description": "Terraform address of the resource"
+              },
+              "dependencies": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ResourceNode"
                 },
-                "type": {
-                  "$ref": "#/components/schemas/ResourceNodeType"
+                "description": "Dependencies of the resource",
+                "nullable": true
+              },
+              "parents": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "$ref": "#/components/schemas/ResourceNodeType"
+                    }
+                  }
                 }
+              },
+              "source_id": {
+                "description": "Original ID of the exported resource",
+                "type": "string"
+              },
+              "changes": {
+                "$ref": "#/components/schemas/PlanChanges"
               }
             }
           }
-        },
-        "required": [
-          "id",
-          "type"
         ]
       },
       "Job": {
@@ -709,13 +746,7 @@
         "properties": {
           "filename": {
             "type": "string",
-            "example": "main.tf"
-          },
-          "mime_type": {
-            "description": "MIME type of file",
-            "type": "string",
-            "example": "application/pdf",
-            "default": "application/octet-stream"
+            "example": "example.manifest.zip"
           }
         },
         "required": [
@@ -733,7 +764,11 @@
             "type": "string",
             "example": "templates/main.tf"
           }
-        }
+        },
+        "required": [
+          "bucket",
+          "key"
+        ]
       },
       "CommonManifestFields": {
         "type": "object",

package/package.json

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