@epilot/blueprint-manifest-client 2.3.0 → 2.3.2

package/dist/openapi.d.ts

@@ -11,7 +11,7 @@ import type {
 declare namespace Components {
     namespace Parameters {
         export type JobID = /**
-         * ID of an import or export job
+         * ID of an import or export job (state machine)
          * example:
          * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
          */
@@ -21,14 +21,101 @@ declare namespace Components {
         JobID?: Parameters.JobID;
     }
     namespace Schemas {
+        export interface CommonImportFields {
+            /**
+             * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
+             */
+            imported_resources?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
+            /**
+             * An URL to download the imported resources when the resources are too large to be included in the response
+             * example:
+             * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
+             */
+            large_imported_resources_url?: string; // uri
+        }
+        export interface CommonManifestFields {
+            manifest_id?: /**
+             * ID of an imported / installed manifest
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            ManifestID;
+            /**
+             * example:
+             * Solar B2B
+             */
+            source_blueprint_name?: string;
+            /**
+             * URL slug of a blueprint from the epilot marketplace
+             * example:
+             * solar-b2b
+             */
+            source_blueprint_slug?: string;
+            /**
+             * Version of the blueprint (semver)
+             * example:
+             * 1.0.0
+             */
+            source_blueprint_version?: string;
+        }
+        export interface CommonMarkdownFields {
+            /**
+             * Markdown content part of a manifest file
+             */
+            markdown?: {
+                /**
+                 * Markdown content shown before installing the manifest
+                 * example:
+                 * This is the content of the manifest.md file which contains the manifest descripton.
+                 *
+                 */
+                manifest?: string;
+                /**
+                 * Markdown content to be displayed when showing the plan to install blueprint
+                 * example:
+                 * This is the content of the preinstall.md file
+                 *
+                 */
+                preinstall?: string;
+                /**
+                 * Markdown content to be displayed when showing the plan to install blueprint
+                 * example:
+                 * This is the content of the postinstall.md file
+                 *
+                 */
+                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_status?: JobStatus;
             job_id?: /**
-             * ID of an import or export job
+             * ID of an import or export job (state machine)
              * example:
              * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
              */
             JobID;
+            job_status?: JobStatus;
             message?: string;
             timestamp?: string; // date-time
             /**
@@ -57,9 +144,21 @@ declare namespace Components {
             imported_resources?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
             /**
              * An URL to download the imported resources when the resources are too large to be included in the response
+             * example:
+             * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
+             */
+            large_imported_resources_url?: string; // uri
+            /**
+             * Markdown content part of a manifest file
              */
-            large_imported_resources_url?: string;
             markdown?: {
+                /**
+                 * Markdown content shown before installing the manifest
+                 * example:
+                 * This is the content of the manifest.md file which contains the manifest descripton.
+                 *
+                 */
+                manifest?: string;
                 /**
                  * Markdown content to be displayed when showing the plan to install blueprint
                  * example:
@@ -75,67 +174,255 @@ declare namespace Components {
                  */
                 postinstall?: string;
             };
+            manifest_id?: /**
+             * ID of an imported / installed manifest
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            ManifestID;
+            /**
+             * example:
+             * Solar B2B
+             */
+            source_blueprint_name?: string;
+            /**
+             * URL slug of a blueprint from the epilot marketplace
+             * example:
+             * solar-b2b
+             */
+            source_blueprint_slug?: string;
+            /**
+             * Version of the blueprint (semver)
+             * example:
+             * 1.0.0
+             */
+            source_blueprint_version?: string;
         }
         /**
-         * ID of an import or export job
+         * ID of an import or export job (state machine)
          * example:
          * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
          */
         export type JobID = string;
         export type JobStatus = "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
+        export interface Manifest {
+            manifest_id?: /**
+             * ID of an imported / installed manifest
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            ManifestID;
+            /**
+             * example:
+             * Solar B2B
+             */
+            source_blueprint_name?: string;
+            /**
+             * URL slug of a blueprint from the epilot marketplace
+             * example:
+             * solar-b2b
+             */
+            source_blueprint_slug?: string;
+            /**
+             * Version of the blueprint (semver)
+             * example:
+             * 1.0.0
+             */
+            source_blueprint_version?: string;
+            /**
+             * Markdown content part of a manifest file
+             */
+            markdown?: {
+                /**
+                 * Markdown content shown before installing the manifest
+                 * example:
+                 * This is the content of the manifest.md file which contains the manifest descripton.
+                 *
+                 */
+                manifest?: string;
+                /**
+                 * Markdown content to be displayed when showing the plan to install blueprint
+                 * example:
+                 * This is the content of the preinstall.md file
+                 *
+                 */
+                preinstall?: string;
+                /**
+                 * Markdown content to be displayed when showing the plan to install blueprint
+                 * example:
+                 * This is the content of the postinstall.md file
+                 *
+                 */
+                postinstall?: string;
+            };
+            /**
+             * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
+             */
+            imported_resources?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
+            /**
+             * An URL to download the imported resources when the resources are too large to be included in the response
+             * example:
+             * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
+             */
+            large_imported_resources_url?: string; // uri
+            /**
+             * When the manifest was first installed (applied)
+             */
+            created_at?: string; // date-time
+            /**
+             * When the manifest was last updated (applied)
+             */
+            updated_at?: string; // date-time
+        }
+        /**
+         * ID of an imported / installed manifest
+         * example:
+         * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+         */
+        export type ManifestID = string;
+        export interface ManifestItem {
+            manifest_id?: /**
+             * ID of an imported / installed manifest
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            ManifestID;
+            /**
+             * example:
+             * Solar B2B
+             */
+            source_blueprint_name?: string;
+            /**
+             * URL slug of a blueprint from the epilot marketplace
+             * example:
+             * solar-b2b
+             */
+            source_blueprint_slug?: string;
+            /**
+             * Version of the blueprint (semver)
+             * example:
+             * 1.0.0
+             */
+            source_blueprint_version?: string;
+            /**
+             * When the manifest was first installed (applied)
+             */
+            created_at?: string; // date-time
+            /**
+             * When the manifest was last updated (applied)
+             */
+            updated_at?: string; // date-time
+        }
+        export interface ManifestTimestampFields {
+            /**
+             * When the manifest was first installed (applied)
+             */
+            created_at?: string; // date-time
+            /**
+             * When the manifest was last updated (applied)
+             */
+            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";
+        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:
-             * epilot-dev-blueprints
+             * 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;
         }
     }
 }
@@ -143,7 +430,7 @@ declare namespace Paths {
     namespace ApplyPlan {
         namespace Parameters {
             export type JobId = /**
-             * ID of an import or export job
+             * ID of an import or export job (state machine)
              * example:
              * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
              */
@@ -160,13 +447,20 @@ declare namespace Paths {
             manifestFilePath?: string;
         }
         namespace Responses {
-            export type $200 = string;
+            export interface $200 {
+                jobId?: /**
+                 * ID of an import or export job (state machine)
+                 * example:
+                 * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+                 */
+                Components.Schemas.JobID;
+            }
         }
     }
     namespace CreateExport {
         export interface RequestBody {
-            resourceType?: "journey" | "product" | "price" | "tax" | "automation_flow" | "designbuilder" | "file" | "emailtemplate" | "entity" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "workflow_definition" | "closing_reason" | "taxonomy_classification";
-            resourceIds?: [
+            resourceType: Components.Schemas.ResourceNodeType;
+            resourceIds: [
                 string,
                 string?,
                 string?,
@@ -193,16 +487,21 @@ declare namespace Paths {
                 string?,
                 string?
             ];
+            jobId?: /**
+             * ID of an import or export job (state machine)
+             * example:
+             * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+             */
+            Components.Schemas.JobID;
             /**
              * Temporary flag to indicate if multiple resources are being exported
              */
             isExportingMultipleResources?: boolean;
-            jobId?: string;
         }
         namespace Responses {
             export interface $200 {
                 jobId?: /**
-                 * ID of an import or export job
+                 * ID of an import or export job (state machine)
                  * example:
                  * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
                  */
@@ -211,14 +510,40 @@ declare namespace Paths {
         }
     }
     namespace CreatePlan {
-        export interface RequestBody {
+        export type RequestBody = {
+            /**
+             * s3ref of manifest file uploaded via `uploadManifest`
+             */
+            s3ref: {
+                /**
+                 * example:
+                 * blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
+                 */
+                bucket: string;
+                /**
+                 * example:
+                 * templates/main.tf
+                 */
+                key: string;
+            };
             /**
-             * Path to the manifest file uploaded via `uploadManifest`
+             * ID of an imported / installed manifest
              * example:
-             * example.tf
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
              */
-            manifestFilePath?: string;
-        }
+            manifest_id?: string;
+        } | {
+            /**
+             * 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 {
                 /**
@@ -229,10 +554,26 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteManifest {
+        namespace Parameters {
+            export type ManifestId = /**
+             * ID of an imported / installed manifest
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            Components.Schemas.ManifestID;
+        }
+        export interface PathParameters {
+            manifest_id: Parameters.ManifestId;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Manifest;
+        }
+    }
     namespace ExportManifest {
         namespace Parameters {
             export type JobId = /**
-             * ID of an import or export job
+             * ID of an import or export job (state machine)
              * example:
              * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
              */
@@ -245,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
              */
@@ -259,7 +600,7 @@ declare namespace Paths {
         namespace Responses {
             export interface $200 {
                 jobId?: /**
-                 * ID of an import or export job
+                 * ID of an import or export job (state machine)
                  * example:
                  * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
                  */
@@ -270,7 +611,7 @@ declare namespace Paths {
     namespace GetJob {
         namespace Parameters {
             export type JobId = /**
-             * ID of an import or export job
+             * ID of an import or export job (state machine)
              * example:
              * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
              */
@@ -283,6 +624,34 @@ declare namespace Paths {
             export type $200 = Components.Schemas.Job;
         }
     }
+    namespace GetManifest {
+        namespace Parameters {
+            export type ManifestId = /**
+             * ID of an imported / installed manifest
+             * example:
+             * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
+             */
+            Components.Schemas.ManifestID;
+        }
+        export interface PathParameters {
+            manifest_id: Parameters.ManifestId;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Manifest;
+        }
+    }
+    namespace ListInstalledManifests {
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * example:
+                 * 1
+                 */
+                total?: number;
+                results?: Components.Schemas.ManifestItem[];
+            }
+        }
+    }
     namespace UploadManifest {
         export type RequestBody = Components.Schemas.UploadFilePayload;
         namespace Responses {
@@ -314,6 +683,8 @@ export interface OperationMethods {
    * 
    * Creates a new Export Job with a list of available resources to export from the passed root resource.
    * 
+   * Multiple root resources can be added by calling this multiple times with the same jobId
+   * 
    */
   'createExport'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -344,7 +715,10 @@ export interface OperationMethods {
   /**
    * createPlan - createPlan
    * 
-   * Creates a new import job from an uploaded manifest file and returns the plan
+   * Creates a new import job from an uploaded manifest file and returns the plan.
+   * 
+   * Creates an updated plan for an installed manifest when `manifest_id` is passed
+   * 
    */
   'createPlan'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -354,13 +728,46 @@ export interface OperationMethods {
   /**
    * applyPlan - applyPlan
    * 
-   * Apply a plan returned by `createPlan`
+   * Apply a plan returned by `createPlan`.
    */
   'applyPlan'(
     parameters?: Parameters<Paths.ApplyPlan.PathParameters> | null,
     data?: Paths.ApplyPlan.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ApplyPlan.Responses.$200>
+  /**
+   * listInstalledManifests - listInstalledManifests
+   * 
+   * List Blueprint Manifests installed to the organization
+   */
+  'listInstalledManifests'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListInstalledManifests.Responses.$200>
+  /**
+   * getManifest - getManifest
+   * 
+   * Get installed Manifest by ID
+   */
+  'getManifest'(
+    parameters?: Parameters<Paths.GetManifest.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetManifest.Responses.$200>
+  /**
+   * deleteManifest - deleteManifest
+   * 
+   * Remove installed manifest from the org
+   * 
+   * Note that this does not delete the installed resources of the Manifest!
+   * 
+   */
+  'deleteManifest'(
+    parameters?: Parameters<Paths.DeleteManifest.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteManifest.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -382,6 +789,8 @@ export interface PathsDictionary {
      * 
      * Creates a new Export Job with a list of available resources to export from the passed root resource.
      * 
+     * Multiple root resources can be added by calling this multiple times with the same jobId
+     * 
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -418,7 +827,10 @@ export interface PathsDictionary {
     /**
      * createPlan - createPlan
      * 
-     * Creates a new import job from an uploaded manifest file and returns the plan
+     * Creates a new import job from an uploaded manifest file and returns the plan.
+     * 
+     * Creates an updated plan for an installed manifest when `manifest_id` is passed
+     * 
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -430,7 +842,7 @@ export interface PathsDictionary {
     /**
      * applyPlan - applyPlan
      * 
-     * Apply a plan returned by `createPlan`
+     * Apply a plan returned by `createPlan`.
      */
     'post'(
       parameters?: Parameters<Paths.ApplyPlan.PathParameters> | null,
@@ -438,13 +850,59 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ApplyPlan.Responses.$200>
   }
+  ['/v1/blueprint-manifest/manifests']: {
+    /**
+     * listInstalledManifests - listInstalledManifests
+     * 
+     * List Blueprint Manifests installed to the organization
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListInstalledManifests.Responses.$200>
+  }
+  ['/v1/blueprint-manifest/manifests/{manifest_id}']: {
+    /**
+     * getManifest - getManifest
+     * 
+     * Get installed Manifest by ID
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetManifest.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetManifest.Responses.$200>
+    /**
+     * deleteManifest - deleteManifest
+     * 
+     * Remove installed manifest from the org
+     * 
+     * Note that this does not delete the installed resources of the Manifest!
+     * 
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteManifest.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteManifest.Responses.$200>
+  }
 }
 
 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;
+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;