shoal-web-sdk 1.0.11 → 1.0.13

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

@@ -9,6 +9,31 @@ export type EnvironmentVariable = {
     key: string;
     value: string;
 };
+export type UpdateBlueprint = {
+    name?: string;
+    shortDescription?: string;
+    description?: string;
+    exported?: Array<string>;
+};
+export type CreateBlueprint = {
+    name: string;
+    shortDescription?: string;
+    description: string;
+    exported: Array<string>;
+};
+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>;
+};
 export type PlatformTier = 'free' | 'pro' | 'enterprise';
 export type BillingInterval = 'monthly' | 'annual';
 export type BillingPlanLookupKey = 'free-monthly' | 'pro-monthly' | 'pro-annual';
@@ -40,6 +65,9 @@ export type Pagination = {
     limit: number;
     total: number;
 };
+export type PaginatedBlueprints = Pagination & {
+    blueprints: Array<Blueprint>;
+};
 export type PaginatedInvites = Pagination & {
     invites: Array<Invite>;
 };
@@ -361,6 +389,8 @@ export type Node = {
     } & DatabaseNodeProps) | ({
         typ: 'function';
     } & FunctionNodeProps) | ({
+        typ: 'neondb';
+    } & NeonDbNodeProps) | ({
         typ: 'queue';
     } & QueueNodeProps) | ({
         typ: 'proxy';
@@ -371,7 +401,7 @@ export type Node = {
     } & SchedulerNodeProps);
 };
 export type EdgeType = 'network' | 'route';
-export type NodeType = 'cache' | 'comment' | 'container' | 'cronjob' | 'database' | 'function' | 'queue' | 'proxy' | 'vm' | 'scheduler';
+export type NodeType = 'cache' | 'comment' | 'container' | 'cronjob' | 'database' | 'function' | 'neondb' | 'queue' | 'proxy' | 'vm' | 'scheduler';
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
 export type CommentNodeProps = {
     comment?: string;
@@ -420,6 +450,21 @@ export type CronJobNodeProps = {
 export type DatabaseNodeProps = {
     space?: number;
 };
+export type NeonDbNodeProps = {
+    orgId: string;
+    orgName: string;
+    projectId?: string;
+    projectName?: string;
+    branchId?: string;
+    branchName?: string;
+    dbName: string;
+    roleName: string;
+    regionId: string;
+    pgVersion: number;
+    autoscalingLimitMinCu?: number;
+    autoscalingLimitMaxCu?: number;
+    suspendTimeoutSeconds: number;
+};
 export type FunctionNodeProps = {
     region: Region;
     language: string;
@@ -578,6 +623,17 @@ export type DeploymentStatusInformation = {
     status?: DeploymentStatus;
     message?: string;
 };
+export type SetSpacePropertyRequest = {
+    key: string;
+    value: string;
+};
+export type SpaceProperty = {
+    key: string;
+    value: string;
+};
+export type SpacePropertiesResponse = {
+    properties: Array<SpaceProperty>;
+};
 /**
  * Clients known etag of the version.
  */
@@ -658,6 +714,22 @@ export type RepoOwner = string;
  * Repository name.
  */
 export type RepoName = string;
+/**
+ * Blueprint UUID.
+ */
+export type BlueprintIdQuery = string;
+/**
+ * Blueprint UUID.
+ */
+export type BlueprintId = string;
+/**
+ * Search value for a searchable field on an endpoint.
+ */
+export type Search = string;
+/**
+ * The order results will appear in.
+ */
+export type Order = 'asc' | 'desc';
 /**
  * Page number (1-based).
  */
@@ -1515,6 +1587,129 @@ export type RecordOnboardingAnalyticsResponses = {
      */
     202: unknown;
 };
+export type PreviewBlueprintData = {
+    body?: never;
+    path: {
+        /**
+         * Blueprint UUID.
+         */
+        blueprint: string;
+    };
+    query?: never;
+    url: '/blueprints/preview/{blueprint}';
+};
+export type PreviewBlueprintErrors = {
+    /**
+     * Bad request.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type PreviewBlueprintError = PreviewBlueprintErrors[keyof PreviewBlueprintErrors];
+export type PreviewBlueprintResponses = {
+    /**
+     * The blueprint nodes.
+     */
+    200: Nodes;
+};
+export type PreviewBlueprintResponse = PreviewBlueprintResponses[keyof PreviewBlueprintResponses];
+export type ViewBlueprintsData = {
+    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;
+        /**
+         * The order results will appear in.
+         */
+        order?: 'asc' | 'desc';
+    };
+    url: '/blueprints/view';
+};
+export type ViewBlueprintsErrors = {
+    /**
+     * Bad request.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type ViewBlueprintsError = ViewBlueprintsErrors[keyof ViewBlueprintsErrors];
+export type ViewBlueprintsResponses = {
+    /**
+     * Paginated blueprints
+     */
+    200: PaginatedBlueprints;
+};
+export type ViewBlueprintsResponse = ViewBlueprintsResponses[keyof ViewBlueprintsResponses];
+export type GetBlueprintData = {
+    body?: never;
+    path: {
+        /**
+         * Blueprint UUID.
+         */
+        blueprint: string;
+    };
+    query?: never;
+    url: '/blueprints/{blueprint}';
+};
+export type GetBlueprintErrors = {
+    /**
+     * Bad request.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type GetBlueprintError = GetBlueprintErrors[keyof GetBlueprintErrors];
+export type GetBlueprintResponses = {
+    /**
+     * The blueprint.
+     */
+    200: Blueprint;
+};
+export type GetBlueprintResponse = GetBlueprintResponses[keyof GetBlueprintResponses];
 export type CreateSpaceData = {
     body: CreateSpace;
     path?: never;
@@ -2518,6 +2713,149 @@ export type CreateEnvironmentVariableResponses = {
      */
     201: unknown;
 };
+export type DeleteBlueprintData = {
+    body?: never;
+    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 DeleteBlueprintErrors = {
+    /**
+     * Bad request.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type DeleteBlueprintError = DeleteBlueprintErrors[keyof DeleteBlueprintErrors];
+export type DeleteBlueprintResponses = {
+    /**
+     * Blueprint deleted.
+     */
+    204: void;
+};
+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.
+         */
+        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}/blueprints/create';
+};
+export type CreateBlueprintErrors = {
+    /**
+     * Bad request.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type CreateBlueprintError = CreateBlueprintErrors[keyof CreateBlueprintErrors];
+export type CreateBlueprintResponses = {
+    /**
+     * Blueprint created
+     */
+    201: Blueprint;
+};
+export type CreateBlueprintResponse = CreateBlueprintResponses[keyof CreateBlueprintResponses];
 export type GetVersionData = {
     body?: never;
     path: {
@@ -2571,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: {
@@ -3243,3 +3634,72 @@ export type ListBillingInvoicesResponses = {
     200: InvoicesResponse;
 };
 export type ListBillingInvoicesResponse = ListBillingInvoicesResponses[keyof ListBillingInvoicesResponses];
+export type GetSpacePropertiesData = {
+    body?: never;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/properties';
+};
+export type GetSpacePropertiesErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type GetSpacePropertiesError = GetSpacePropertiesErrors[keyof GetSpacePropertiesErrors];
+export type GetSpacePropertiesResponses = {
+    /**
+     * The space properties.
+     */
+    200: SpacePropertiesResponse;
+};
+export type GetSpacePropertiesResponse = GetSpacePropertiesResponses[keyof GetSpacePropertiesResponses];
+export type SetSpacePropertyData = {
+    body: SetSpacePropertyRequest;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/properties';
+};
+export type SetSpacePropertyErrors = {
+    /**
+     * Invalid request body.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type SetSpacePropertyError = SetSpacePropertyErrors[keyof SetSpacePropertyErrors];
+export type SetSpacePropertyResponses = {
+    /**
+     * Property set successfully.
+     */
+    202: unknown;
+};