shoal-web-sdk 1.0.69 → 1.0.71

package/dist/sdk/@tanstack/react-query.gen.d.ts

@@ -1527,7 +1527,7 @@ export declare const getProjectEnvironmentsQueryKey: (options: Options<GetProjec
     tags?: ReadonlyArray<string>;
 }];
 /**
- * Get paginated environments for a project, ordered with active environments first and soft deleted environments last.
+ * Get paginated environments for a project, optionally filtered by status and searched by name or handle, ordered with active environments first and soft deleted environments last.
  */
 export declare const getProjectEnvironmentsOptions: (options: Options<GetProjectEnvironmentsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedEnvironments, Error, import("../types.gen").PaginatedEnvironments, [Pick<Options<GetProjectEnvironmentsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
@@ -1551,7 +1551,7 @@ export declare const getProjectEnvironmentsOptions: (options: Options<GetProject
 };
 export declare const getProjectEnvironmentsInfiniteQueryKey: (options: Options<GetProjectEnvironmentsData>) => QueryKey<Options<GetProjectEnvironmentsData>>;
 /**
- * Get paginated environments for a project, ordered with active environments first and soft deleted environments last.
+ * Get paginated environments for a project, optionally filtered by status and searched by name or handle, ordered with active environments first and soft deleted environments last.
  */
 export declare const getProjectEnvironmentsInfiniteOptions: (options: Options<GetProjectEnvironmentsData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedEnvironments, import("../types.gen").ErrorResponse, InfiniteData<import("../types.gen").PaginatedEnvironments, unknown>, QueryKey<Options<GetProjectEnvironmentsData>>, number | Pick<Pick<Options<GetProjectEnvironmentsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;

package/dist/sdk/@tanstack/react-query.gen.js

@@ -1517,7 +1517,7 @@ export const getProjectOverviewOptions = (options) => {
 };
 export const getProjectEnvironmentsQueryKey = (options) => createQueryKey('getProjectEnvironments', options);
 /**
- * Get paginated environments for a project, ordered with active environments first and soft deleted environments last.
+ * Get paginated environments for a project, optionally filtered by status and searched by name or handle, ordered with active environments first and soft deleted environments last.
  */
 export const getProjectEnvironmentsOptions = (options) => {
     return queryOptions({
@@ -1535,7 +1535,7 @@ export const getProjectEnvironmentsOptions = (options) => {
 };
 export const getProjectEnvironmentsInfiniteQueryKey = (options) => createQueryKey('getProjectEnvironments', options, true);
 /**
- * Get paginated environments for a project, ordered with active environments first and soft deleted environments last.
+ * Get paginated environments for a project, optionally filtered by status and searched by name or handle, ordered with active environments first and soft deleted environments last.
  */
 export const getProjectEnvironmentsInfiniteOptions = (options) => {
     return infiniteQueryOptions(

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

@@ -279,7 +279,7 @@ export declare const createProject: <ThrowOnError extends boolean = false>(optio
  */
 export declare const getProjectOverview: <ThrowOnError extends boolean = false>(options: Options<GetProjectOverviewData, ThrowOnError>) => import("./client").RequestResult<GetProjectOverviewResponses, GetProjectOverviewErrors, ThrowOnError, "fields">;
 /**
- * Get paginated environments for a project, ordered with active environments first and soft deleted environments last.
+ * Get paginated environments for a project, optionally filtered by status and searched by name or handle, ordered with active environments first and soft deleted environments last.
  */
 export declare const getProjectEnvironments: <ThrowOnError extends boolean = false>(options: Options<GetProjectEnvironmentsData, ThrowOnError>) => import("./client").RequestResult<GetProjectEnvironmentsResponses, GetProjectEnvironmentsErrors, ThrowOnError, "fields">;
 /**

package/dist/sdk/sdk.gen.js

@@ -1354,7 +1354,7 @@ export const getProjectOverview = (options) => {
     });
 };
 /**
- * Get paginated environments for a project, ordered with active environments first and soft deleted environments last.
+ * Get paginated environments for a project, optionally filtered by status and searched by name or handle, ordered with active environments first and soft deleted environments last.
  */
 export const getProjectEnvironments = (options) => {
     return (options.client ?? client).get({

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

@@ -340,6 +340,10 @@ export type EnvironmentOverview = {
      * True when this environment has been deleted and is pending purge. It keeps its handle while in this state, so creating or cloning onto the handle must either restore it or destroy it first.
      */
     softDelete?: boolean;
+    /**
+     * When this environment is due to be purged. Only present while softDelete is true.
+     */
+    scheduleDeleteAt?: string;
 };
 export type AccountIdentity = {
     id: string;
@@ -914,6 +918,10 @@ export type PlanPriceResponse = {
      */
     interval: string;
 };
+/**
+ * The lifecycle state of an environment. `active` covers environments that are not soft deleted, `inactive` covers soft deleted environments pending purge, and `all` covers both.
+ */
+export type EnvironmentStatus = 'active' | 'inactive' | 'all';
 export type DeploymentStatus = 'pending' | 'prebuilding' | 'building' | 'deploying' | 'configuring' | 'succeeded' | 'failed';
 export type DeploymentStatusInformation = {
     status?: DeploymentStatus;
@@ -1151,6 +1159,10 @@ export type Search = string;
  * The order results will appear in.
  */
 export type Order = 'asc' | 'desc';
+/**
+ * Filter environments by lifecycle state.
+ */
+export type EnvironmentStatusQuery = EnvironmentStatus;
 /**
  * Page number (1-based).
  */
@@ -3983,6 +3995,14 @@ export type GetProjectEnvironmentsData = {
         projectHandle: string;
     };
     query?: {
+        /**
+         * Filter environments by lifecycle state.
+         */
+        status?: EnvironmentStatus;
+        /**
+         * Search value for a searchable field on an endpoint.
+         */
+        search?: string;
         /**
          * Page number (1-based).
          */

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

@@ -384,6 +384,7 @@ export declare const zEnvironmentOverview: z.ZodObject<{
     versions: z.ZodInt;
     blueprintId: z.ZodOptional<z.ZodUUID>;
     softDelete: z.ZodOptional<z.ZodBoolean>;
+    scheduleDeleteAt: z.ZodOptional<z.ZodISODateTime>;
 }, z.core.$strip>;
 export declare const zPaginatedEnvironments: z.ZodIntersection<z.ZodObject<{
     page: z.ZodInt;
@@ -400,6 +401,7 @@ export declare const zPaginatedEnvironments: z.ZodIntersection<z.ZodObject<{
         versions: z.ZodInt;
         blueprintId: z.ZodOptional<z.ZodUUID>;
         softDelete: z.ZodOptional<z.ZodBoolean>;
+        scheduleDeleteAt: z.ZodOptional<z.ZodISODateTime>;
     }, z.core.$strip>>;
 }, z.core.$strip>>;
 export declare const zAccountIdentity: z.ZodObject<{
@@ -2025,6 +2027,14 @@ export declare const zPlanPriceResponse: z.ZodObject<{
     currency: z.ZodString;
     interval: z.ZodString;
 }, z.core.$strip>;
+/**
+ * The lifecycle state of an environment. `active` covers environments that are not soft deleted, `inactive` covers soft deleted environments pending purge, and `all` covers both.
+ */
+export declare const zEnvironmentStatus: z.ZodEnum<{
+    active: "active";
+    inactive: "inactive";
+    all: "all";
+}>;
 export declare const zDeploymentStatus: z.ZodEnum<{
     pending: "pending";
     prebuilding: "prebuilding";
@@ -2400,6 +2410,14 @@ export declare const zOrder: z.ZodEnum<{
     asc: "asc";
     desc: "desc";
 }>;
+/**
+ * Filter environments by lifecycle state.
+ */
+export declare const zEnvironmentStatusQuery: z.ZodEnum<{
+    active: "active";
+    inactive: "inactive";
+    all: "all";
+}>;
 /**
  * Page number (1-based).
  */
@@ -5158,6 +5176,12 @@ export declare const zGetProjectEnvironmentsData: z.ZodObject<{
         projectHandle: z.ZodString;
     }, z.core.$strip>;
     query: z.ZodOptional<z.ZodObject<{
+        status: z.ZodOptional<z.ZodEnum<{
+            active: "active";
+            inactive: "inactive";
+            all: "all";
+        }>>;
+        search: z.ZodOptional<z.ZodString>;
         page: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
         limit: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
     }, z.core.$strip>>;
@@ -5180,6 +5204,7 @@ export declare const zGetProjectEnvironmentsResponse: z.ZodIntersection<z.ZodObj
         versions: z.ZodInt;
         blueprintId: z.ZodOptional<z.ZodUUID>;
         softDelete: z.ZodOptional<z.ZodBoolean>;
+        scheduleDeleteAt: z.ZodOptional<z.ZodISODateTime>;
     }, z.core.$strip>>;
 }, z.core.$strip>>;
 export declare const zCreateEnvironmentData: z.ZodObject<{
@@ -5208,6 +5233,7 @@ export declare const zCreateEnvironmentResponse: z.ZodObject<{
     versions: z.ZodInt;
     blueprintId: z.ZodOptional<z.ZodUUID>;
     softDelete: z.ZodOptional<z.ZodBoolean>;
+    scheduleDeleteAt: z.ZodOptional<z.ZodISODateTime>;
 }, z.core.$strip>;
 export declare const zCreateSecretData: z.ZodObject<{
     body: z.ZodObject<{
@@ -5282,6 +5308,7 @@ export declare const zGetEnvironmentOverviewResponse: z.ZodObject<{
     versions: z.ZodInt;
     blueprintId: z.ZodOptional<z.ZodUUID>;
     softDelete: z.ZodOptional<z.ZodBoolean>;
+    scheduleDeleteAt: z.ZodOptional<z.ZodISODateTime>;
 }, z.core.$strip>;
 export declare const zGetEnvironmentVersionsData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
@@ -5578,6 +5605,7 @@ export declare const zCloneEnvironmentResponse: z.ZodObject<{
     versions: z.ZodInt;
     blueprintId: z.ZodOptional<z.ZodUUID>;
     softDelete: z.ZodOptional<z.ZodBoolean>;
+    scheduleDeleteAt: z.ZodOptional<z.ZodISODateTime>;
 }, z.core.$strip>;
 export declare const zGetGraphOverviewData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;

package/dist/sdk/zod.gen.js

@@ -285,7 +285,8 @@ export const zEnvironmentOverview = z.object({
     updatedAt: z.iso.datetime(),
     versions: z.int(),
     blueprintId: z.optional(z.uuid()),
-    softDelete: z.optional(z.boolean())
+    softDelete: z.optional(z.boolean()),
+    scheduleDeleteAt: z.optional(z.iso.datetime())
 });
 export const zPaginatedEnvironments = zPagination.and(z.object({
     environments: z.array(zEnvironmentOverview)
@@ -830,6 +831,14 @@ export const zPlanPriceResponse = z.object({
     currency: z.string(),
     interval: z.string()
 });
+/**
+ * The lifecycle state of an environment. `active` covers environments that are not soft deleted, `inactive` covers soft deleted environments pending purge, and `all` covers both.
+ */
+export const zEnvironmentStatus = z.enum([
+    'active',
+    'inactive',
+    'all'
+]);
 export const zDeploymentStatus = z.enum([
     'pending',
     'prebuilding',
@@ -1101,6 +1110,10 @@ export const zOrder = z.enum([
     'asc',
     'desc'
 ]);
+/**
+ * Filter environments by lifecycle state.
+ */
+export const zEnvironmentStatusQuery = zEnvironmentStatus;
 /**
  * Page number (1-based).
  */
@@ -1962,6 +1975,8 @@ export const zGetProjectEnvironmentsData = z.object({
         projectHandle: z.string()
     }),
     query: z.optional(z.object({
+        status: z.optional(zEnvironmentStatus),
+        search: z.optional(z.string()),
         page: z.optional(z.int().gte(1)).default(1),
         limit: z.optional(z.int().gte(1).lte(100)).default(10)
     }))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shoal-web-sdk",
-  "version": "1.0.69",
+  "version": "1.0.71",
   "main": "index.js",
   "scripts": {
     "build-hooks": "npx tsx tanstack-codegen/generator.ts",