shoal-web-sdk 1.0.12 → 1.0.13

package/dist/sdk/types.gen.d.ts

@@ -9,23 +9,28 @@ export type EnvironmentVariable = {
     key: string;
     value: string;
 };
-export type UpdateTemplate = {
+export type UpdateBlueprint = {
     name?: string;
+    shortDescription?: string;
     description?: string;
     exported?: Array<string>;
 };
-export type CreateTemplate = {
+export type CreateBlueprint = {
     name: string;
+    shortDescription?: string;
     description: string;
     exported: Array<string>;
 };
-export type Template = {
+export type Blueprint = {
     id: string;
     environment: string;
     ref: string;
     updatedAt: string;
     createdAt: string;
+    author: string;
+    updatedBy: string;
     name: string;
+    shortDescription: string;
     description: string;
     exported: Array<EnvironmentVariable>;
 };
@@ -60,8 +65,8 @@ export type Pagination = {
     limit: number;
     total: number;
 };
-export type PaginatedTemplates = Pagination & {
-    templates: Array<Template>;
+export type PaginatedBlueprints = Pagination & {
+    blueprints: Array<Blueprint>;
 };
 export type PaginatedInvites = Pagination & {
     invites: Array<Invite>;
@@ -710,9 +715,13 @@ export type RepoOwner = string;
  */
 export type RepoName = string;
 /**
- * Template UUID.
+ * Blueprint UUID.
  */
-export type TemplateId = string;
+export type BlueprintIdQuery = string;
+/**
+ * Blueprint UUID.
+ */
+export type BlueprintId = string;
 /**
  * Search value for a searchable field on an endpoint.
  */
@@ -1578,30 +1587,18 @@ export type RecordOnboardingAnalyticsResponses = {
      */
     202: unknown;
 };
-export type ViewTemplatesData = {
+export type PreviewBlueprintData = {
     body?: never;
-    path?: never;
-    query?: {
-        /**
-         * Page size (max 100).
-         */
-        limit?: number;
-        /**
-         * Page number (1-based).
-         */
-        page?: number;
-        /**
-         * Search value for a searchable field on an endpoint.
-         */
-        search?: string;
+    path: {
         /**
-         * The order results will appear in.
+         * Blueprint UUID.
          */
-        order?: 'asc' | 'desc';
+        blueprint: string;
     };
-    url: '/templates/view';
+    query?: never;
+    url: '/blueprints/preview/{blueprint}';
 };
-export type ViewTemplatesErrors = {
+export type PreviewBlueprintErrors = {
     /**
      * Bad request.
      */
@@ -1619,26 +1616,38 @@ export type ViewTemplatesErrors = {
      */
     500: ErrorResponse;
 };
-export type ViewTemplatesError = ViewTemplatesErrors[keyof ViewTemplatesErrors];
-export type ViewTemplatesResponses = {
+export type PreviewBlueprintError = PreviewBlueprintErrors[keyof PreviewBlueprintErrors];
+export type PreviewBlueprintResponses = {
     /**
-     * Paginated templates
+     * The blueprint nodes.
      */
-    200: PaginatedTemplates;
+    200: Nodes;
 };
-export type ViewTemplatesResponse = ViewTemplatesResponses[keyof ViewTemplatesResponses];
-export type GetTemplateData = {
+export type PreviewBlueprintResponse = PreviewBlueprintResponses[keyof PreviewBlueprintResponses];
+export type ViewBlueprintsData = {
     body?: never;
-    path: {
+    path?: never;
+    query?: {
         /**
-         * Template UUID.
+         * Page size (max 100).
          */
-        template: string;
+        limit?: number;
+        /**
+         * Page number (1-based).
+         */
+        page?: number;
+        /**
+         * Search value for a searchable field on an endpoint.
+         */
+        search?: string;
+        /**
+         * The order results will appear in.
+         */
+        order?: 'asc' | 'desc';
     };
-    query?: never;
-    url: '/templates/{template}';
+    url: '/blueprints/view';
 };
-export type GetTemplateErrors = {
+export type ViewBlueprintsErrors = {
     /**
      * Bad request.
      */
@@ -1656,26 +1665,26 @@ export type GetTemplateErrors = {
      */
     500: ErrorResponse;
 };
-export type GetTemplateError = GetTemplateErrors[keyof GetTemplateErrors];
-export type GetTemplateResponses = {
+export type ViewBlueprintsError = ViewBlueprintsErrors[keyof ViewBlueprintsErrors];
+export type ViewBlueprintsResponses = {
     /**
-     * The template.
+     * Paginated blueprints
      */
-    200: Template;
+    200: PaginatedBlueprints;
 };
-export type GetTemplateResponse = GetTemplateResponses[keyof GetTemplateResponses];
-export type UpdateTemplateData = {
-    body: UpdateTemplate;
+export type ViewBlueprintsResponse = ViewBlueprintsResponses[keyof ViewBlueprintsResponses];
+export type GetBlueprintData = {
+    body?: never;
     path: {
         /**
-         * Template UUID.
+         * Blueprint UUID.
          */
-        template: string;
+        blueprint: string;
     };
     query?: never;
-    url: '/templates/{template}';
+    url: '/blueprints/{blueprint}';
 };
-export type UpdateTemplateErrors = {
+export type GetBlueprintErrors = {
     /**
      * Bad request.
      */
@@ -1693,14 +1702,14 @@ export type UpdateTemplateErrors = {
      */
     500: ErrorResponse;
 };
-export type UpdateTemplateError = UpdateTemplateErrors[keyof UpdateTemplateErrors];
-export type UpdateTemplateResponses = {
+export type GetBlueprintError = GetBlueprintErrors[keyof GetBlueprintErrors];
+export type GetBlueprintResponses = {
     /**
-     * Updated Template.
+     * The blueprint.
      */
-    200: Template;
+    200: Blueprint;
 };
-export type UpdateTemplateResponse = UpdateTemplateResponses[keyof UpdateTemplateResponses];
+export type GetBlueprintResponse = GetBlueprintResponses[keyof GetBlueprintResponses];
 export type CreateSpaceData = {
     body: CreateSpace;
     path?: never;
@@ -2704,13 +2713,13 @@ export type CreateEnvironmentVariableResponses = {
      */
     201: unknown;
 };
-export type DeleteTemplateData = {
+export type DeleteBlueprintData = {
     body?: never;
     path: {
         /**
-         * Template UUID.
+         * Blueprint UUID.
          */
-        template: string;
+        blueprint: string;
         /**
          * The space handle. This must be globally unique.
          */
@@ -2725,9 +2734,9 @@ export type DeleteTemplateData = {
         environmentHandle: string;
     };
     query?: never;
-    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{template}';
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{blueprint}';
 };
-export type DeleteTemplateErrors = {
+export type DeleteBlueprintErrors = {
     /**
      * Bad request.
      */
@@ -2745,16 +2754,65 @@ export type DeleteTemplateErrors = {
      */
     500: ErrorResponse;
 };
-export type DeleteTemplateError = DeleteTemplateErrors[keyof DeleteTemplateErrors];
-export type DeleteTemplateResponses = {
+export type DeleteBlueprintError = DeleteBlueprintErrors[keyof DeleteBlueprintErrors];
+export type DeleteBlueprintResponses = {
     /**
-     * Template deleted.
+     * Blueprint deleted.
      */
     204: void;
 };
-export type DeleteTemplateResponse = DeleteTemplateResponses[keyof DeleteTemplateResponses];
-export type CreateTemplateData = {
-    body: CreateTemplate;
+export type DeleteBlueprintResponse = DeleteBlueprintResponses[keyof DeleteBlueprintResponses];
+export type UpdateBlueprintData = {
+    body: UpdateBlueprint;
+    path: {
+        /**
+         * Blueprint UUID.
+         */
+        blueprint: string;
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+        /**
+         * A project name. This must be unique to a space.
+         */
+        projectHandle: string;
+        /**
+         * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
+         */
+        environmentHandle: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{blueprint}';
+};
+export type UpdateBlueprintErrors = {
+    /**
+     * Bad request.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type UpdateBlueprintError = UpdateBlueprintErrors[keyof UpdateBlueprintErrors];
+export type UpdateBlueprintResponses = {
+    /**
+     * Updated Blueprint.
+     */
+    200: Blueprint;
+};
+export type UpdateBlueprintResponse = UpdateBlueprintResponses[keyof UpdateBlueprintResponses];
+export type CreateBlueprintData = {
+    body: CreateBlueprint;
     path: {
         /**
          * The space handle. This must be globally unique.
@@ -2770,9 +2828,9 @@ export type CreateTemplateData = {
         environmentHandle: string;
     };
     query?: never;
-    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/templates/create';
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/blueprints/create';
 };
-export type CreateTemplateErrors = {
+export type CreateBlueprintErrors = {
     /**
      * Bad request.
      */
@@ -2790,14 +2848,14 @@ export type CreateTemplateErrors = {
      */
     500: ErrorResponse;
 };
-export type CreateTemplateError = CreateTemplateErrors[keyof CreateTemplateErrors];
-export type CreateTemplateResponses = {
+export type CreateBlueprintError = CreateBlueprintErrors[keyof CreateBlueprintErrors];
+export type CreateBlueprintResponses = {
     /**
-     * Template created
+     * Blueprint created
      */
-    201: Template;
+    201: Blueprint;
 };
-export type CreateTemplateResponse = CreateTemplateResponses[keyof CreateTemplateResponses];
+export type CreateBlueprintResponse = CreateBlueprintResponses[keyof CreateBlueprintResponses];
 export type GetVersionData = {
     body?: never;
     path: {
@@ -2851,6 +2909,59 @@ export type GetVersionResponses = {
     200: Version;
 };
 export type GetVersionResponse = GetVersionResponses[keyof GetVersionResponses];
+export type ImportBlueprintData = {
+    body?: never;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+        /**
+         * A project name. This must be unique to a space.
+         */
+        projectHandle: string;
+        /**
+         * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
+         */
+        environmentHandle: string;
+        /**
+         * A version number with in an environment.
+         */
+        version: string;
+    };
+    query: {
+        /**
+         * Blueprint UUID.
+         */
+        blueprint: string;
+    };
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/import';
+};
+export type ImportBlueprintErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type ImportBlueprintError = ImportBlueprintErrors[keyof ImportBlueprintErrors];
+export type ImportBlueprintResponses = {
+    /**
+     * The blueprint contents was successfully imported. This does not overwrite existing graph content.
+     */
+    202: unknown;
+};
 export type GetGraphOverviewData = {
     body?: never;
     path: {