shoal-web-sdk 1.0.143 → 1.0.144

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

@@ -1,6 +1,6 @@
 import { type InfiniteData } from '@tanstack/react-query';
 import { type Options } from '../sdk.gen';
-import type { GetOverviewData, GetTenantSummaryData, ListActorActivityData, ListAuditBreakdownData, ListAuditsData, ListCostBreakdownData, ListCostOrganisationsData, ListDeploymentBreakdownData, ListDeploymentOrganisationsData, ListDeploymentsData, ListSignUpBreakdownData, ListTenantsData, ListUsersData } from '../types.gen';
+import type { GetOverviewData, GetTenantSummaryData, ListActorActivityData, ListAuditBreakdownData, ListAuditsData, ListCostBreakdownData, ListCostOrganisationsData, ListDeploymentBreakdownData, ListDeploymentOrganisationsData, ListDeploymentsData, ListLiveRoutesData, ListSignUpBreakdownData, ListTenantsData, ListUsersData } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -103,6 +103,70 @@ export declare const getOverviewOptions: (options?: Options<GetOverviewData>) =>
         [dataTagErrorSymbol]: Error;
     };
 };
+export declare const listLiveRoutesQueryKey: (options?: Options<ListLiveRoutesData>) => [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export declare const listLiveRoutesOptions: (options?: Options<ListLiveRoutesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedLiveEnvironments, Error, import("../types.gen").PaginatedLiveEnvironments, [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedLiveEnvironments, [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").PaginatedLiveEnvironments;
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare const listLiveRoutesInfiniteQueryKey: (options?: Options<ListLiveRoutesData>) => QueryKey<Options<ListLiveRoutesData>>;
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export declare const listLiveRoutesInfiniteOptions: (options?: Options<ListLiveRoutesData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedLiveEnvironments, import("../types.gen")._Error, InfiniteData<import("../types.gen").PaginatedLiveEnvironments, unknown>, QueryKey<Options<ListLiveRoutesData>>, number | Pick<Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}, "query" | "body" | "headers" | "path">> & {
+    initialData: InfiniteData<import("../types.gen").PaginatedLiveEnvironments, number | Pick<Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedLiveEnvironments, number | Pick<Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">>) | undefined;
+} & {
+    queryKey: QueryKey<Options<ListLiveRoutesData>> & {
+        [dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedLiveEnvironments, unknown>;
+        [dataTagErrorSymbol]: import("../types.gen")._Error;
+    };
+};
 export declare const getTenantSummaryQueryKey: (options?: Options<GetTenantSummaryData>) => [Pick<Options<GetTenantSummaryData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;

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

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { infiniteQueryOptions, queryOptions } from '@tanstack/react-query';
 import { client } from '../client.gen';
-import { getOverview, getTenantSummary, listActorActivity, listAuditBreakdown, listAudits, listCostBreakdown, listCostOrganisations, listDeploymentBreakdown, listDeploymentOrganisations, listDeployments, listSignUpBreakdown, listTenants, listUsers } from '../sdk.gen';
+import { getOverview, getTenantSummary, listActorActivity, listAuditBreakdown, listAudits, listCostBreakdown, listCostOrganisations, listDeploymentBreakdown, listDeploymentOrganisations, listDeployments, listLiveRoutes, listSignUpBreakdown, listTenants, listUsers } from '../sdk.gen';
 const createQueryKey = (id, options, infinite, tags) => {
     const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
     if (infinite) {
@@ -134,6 +134,63 @@ export const getOverviewOptions = (options) => {
         queryKey: getOverviewQueryKey(options)
     });
 };
+export const listLiveRoutesQueryKey = (options) => createQueryKey('listLiveRoutes', options);
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export const listLiveRoutesOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await listLiveRoutes({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: listLiveRoutesQueryKey(options)
+    });
+};
+export const listLiveRoutesInfiniteQueryKey = (options) => createQueryKey('listLiveRoutes', options, true);
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export const listLiveRoutesInfiniteOptions = (options) => {
+    return infiniteQueryOptions(
+    // @ts-ignore
+    {
+        queryFn: async ({ pageParam, queryKey, signal }) => {
+            // @ts-ignore
+            const page = typeof pageParam === 'object' ? pageParam : {
+                query: {
+                    page: pageParam
+                }
+            };
+            const params = createInfiniteParams(queryKey, page);
+            const { data } = await listLiveRoutes({
+                ...options,
+                ...params,
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: listLiveRoutesInfiniteQueryKey(options)
+    });
+};
 export const getTenantSummaryQueryKey = (options) => createQueryKey('getTenantSummary', options);
 /**
  * Summarise tenants

package/dist/sdk/insights-engine/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { GetOverviewData, GetOverviewErrors, GetOverviewResponses, GetTenantSummaryData, GetTenantSummaryErrors, GetTenantSummaryResponses, ListActorActivityData, ListActorActivityErrors, ListActorActivityResponses, ListAuditBreakdownData, ListAuditBreakdownErrors, ListAuditBreakdownResponses, ListAuditsData, ListAuditsErrors, ListAuditsResponses, ListCostBreakdownData, ListCostBreakdownErrors, ListCostBreakdownResponses, ListCostOrganisationsData, ListCostOrganisationsErrors, ListCostOrganisationsResponses, ListDeploymentBreakdownData, ListDeploymentBreakdownErrors, ListDeploymentBreakdownResponses, ListDeploymentOrganisationsData, ListDeploymentOrganisationsErrors, ListDeploymentOrganisationsResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListSignUpBreakdownData, ListSignUpBreakdownErrors, ListSignUpBreakdownResponses, ListTenantsData, ListTenantsErrors, ListTenantsResponses, ListUsersData, ListUsersErrors, ListUsersResponses } from './types.gen';
+import type { GetOverviewData, GetOverviewErrors, GetOverviewResponses, GetTenantSummaryData, GetTenantSummaryErrors, GetTenantSummaryResponses, ListActorActivityData, ListActorActivityErrors, ListActorActivityResponses, ListAuditBreakdownData, ListAuditBreakdownErrors, ListAuditBreakdownResponses, ListAuditsData, ListAuditsErrors, ListAuditsResponses, ListCostBreakdownData, ListCostBreakdownErrors, ListCostBreakdownResponses, ListCostOrganisationsData, ListCostOrganisationsErrors, ListCostOrganisationsResponses, ListDeploymentBreakdownData, ListDeploymentBreakdownErrors, ListDeploymentBreakdownResponses, ListDeploymentOrganisationsData, ListDeploymentOrganisationsErrors, ListDeploymentOrganisationsResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListLiveRoutesData, ListLiveRoutesErrors, ListLiveRoutesResponses, ListSignUpBreakdownData, ListSignUpBreakdownErrors, ListSignUpBreakdownResponses, ListTenantsData, ListTenantsErrors, ListTenantsResponses, ListUsersData, ListUsersErrors, ListUsersResponses } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -31,6 +31,16 @@ export declare const listTenants: <ThrowOnError extends boolean = false>(options
  *
  */
 export declare const getOverview: <ThrowOnError extends boolean = false>(options?: Options<GetOverviewData, ThrowOnError>) => import("./client").RequestResult<GetOverviewResponses, GetOverviewErrors, ThrowOnError, "fields">;
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export declare const listLiveRoutes: <ThrowOnError extends boolean = false>(options?: Options<ListLiveRoutesData, ThrowOnError>) => import("./client").RequestResult<ListLiveRoutesResponses, ListLiveRoutesErrors, ThrowOnError, "fields">;
 /**
  * Summarise tenants
  *

package/dist/sdk/insights-engine/sdk.gen.js

@@ -40,6 +40,27 @@ export const getOverview = (options) => {
         ...options
     });
 };
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export const listLiveRoutes = (options) => {
+    return (options?.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/insights-engine/routes',
+        ...options
+    });
+};
 /**
  * Summarise tenants
  *

package/dist/sdk/insights-engine/types.gen.d.ts

@@ -515,6 +515,50 @@ export type Overview = {
     daily: Array<OverviewDay>;
     tenants: TenantSummary;
 };
+export type LivePath = {
+    path: string;
+    /**
+     * The path the target receives instead, empty when not rewritten.
+     */
+    rewrite: string;
+    targetName: string;
+    targetType: string;
+};
+/**
+ * A proxy or VM node in the live version and the subdomain it serves. The frontend builds the hostname from the label and the proxy or VM domain of the environment it runs in.
+ */
+export type LiveSubdomain = {
+    nodeName: string;
+    nodeType: 'proxy' | 'vm';
+    /**
+     * The subdomain label, empty when none is claimed.
+     */
+    label: string;
+    /**
+     * The active customer domain fronting the subdomain, empty when there is none.
+     */
+    customDomain: string;
+    paths: Array<LivePath>;
+};
+/**
+ * The subdomains and paths served by an environment's latest succeeded deployment.
+ */
+export type LiveEnvironment = {
+    orgId: string;
+    spaceName: string;
+    environmentId: string;
+    environmentHandle: string;
+    projectHandle: string;
+    /**
+     * The environment's latest succeeded deployment.
+     */
+    deploymentId: string;
+    deployedAt: string;
+    subdomains: Array<LiveSubdomain>;
+};
+export type PaginatedLiveEnvironments = PaginatedResponse & {
+    data: Array<LiveEnvironment>;
+};
 export type CostEnvironment = {
     id: string;
     handle: string;
@@ -745,6 +789,43 @@ export type GetOverviewResponses = {
     200: Overview;
 };
 export type GetOverviewResponse = GetOverviewResponses[keyof GetOverviewResponses];
+export type ListLiveRoutesData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * An organisation id.
+         */
+        org?: string;
+        /**
+         * 1-based page index.
+         */
+        page?: number;
+        /**
+         * Items per page, clamped server side to at most 5000.
+         */
+        limit?: number;
+    };
+    url: '/insights-engine/routes';
+};
+export type ListLiveRoutesErrors = {
+    /**
+     * The request was rejected as invalid.
+     */
+    400: _Error;
+    /**
+     * The service is not healthy.
+     */
+    500: _Error;
+};
+export type ListLiveRoutesError = ListLiveRoutesErrors[keyof ListLiveRoutesErrors];
+export type ListLiveRoutesResponses = {
+    /**
+     * A page of environments and their live routes.
+     */
+    200: PaginatedLiveEnvironments;
+};
+export type ListLiveRoutesResponse = ListLiveRoutesResponses[keyof ListLiveRoutesResponses];
 export type GetTenantSummaryData = {
     body?: never;
     path?: never;

package/dist/sdk/insights-engine/zod.gen.d.ts

@@ -1381,6 +1381,89 @@ export declare const zOverview: z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+export declare const zLivePath: z.ZodObject<{
+    path: z.ZodString;
+    rewrite: z.ZodString;
+    targetName: z.ZodString;
+    targetType: z.ZodString;
+}, z.core.$strip>;
+/**
+ * A proxy or VM node in the live version and the subdomain it serves. The frontend builds the hostname from the label and the proxy or VM domain of the environment it runs in.
+ */
+export declare const zLiveSubdomain: z.ZodObject<{
+    nodeName: z.ZodString;
+    nodeType: z.ZodEnum<{
+        proxy: "proxy";
+        vm: "vm";
+    }>;
+    label: z.ZodString;
+    customDomain: z.ZodString;
+    paths: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        rewrite: z.ZodString;
+        targetName: z.ZodString;
+        targetType: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * The subdomains and paths served by an environment's latest succeeded deployment.
+ */
+export declare const zLiveEnvironment: z.ZodObject<{
+    orgId: z.ZodString;
+    spaceName: z.ZodString;
+    environmentId: z.ZodString;
+    environmentHandle: z.ZodString;
+    projectHandle: z.ZodString;
+    deploymentId: z.ZodString;
+    deployedAt: z.ZodISODateTime;
+    subdomains: z.ZodArray<z.ZodObject<{
+        nodeName: z.ZodString;
+        nodeType: z.ZodEnum<{
+            proxy: "proxy";
+            vm: "vm";
+        }>;
+        label: z.ZodString;
+        customDomain: z.ZodString;
+        paths: z.ZodArray<z.ZodObject<{
+            path: z.ZodString;
+            rewrite: z.ZodString;
+            targetName: z.ZodString;
+            targetType: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const zPaginatedLiveEnvironments: z.ZodIntersection<z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodCoercedBigInt<unknown>;
+    pages: z.ZodInt;
+    data: z.ZodArray<z.ZodUnknown>;
+}, z.core.$strip>, z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        orgId: z.ZodString;
+        spaceName: z.ZodString;
+        environmentId: z.ZodString;
+        environmentHandle: z.ZodString;
+        projectHandle: z.ZodString;
+        deploymentId: z.ZodString;
+        deployedAt: z.ZodISODateTime;
+        subdomains: z.ZodArray<z.ZodObject<{
+            nodeName: z.ZodString;
+            nodeType: z.ZodEnum<{
+                proxy: "proxy";
+                vm: "vm";
+            }>;
+            label: z.ZodString;
+            customDomain: z.ZodString;
+            paths: z.ZodArray<z.ZodObject<{
+                path: z.ZodString;
+                rewrite: z.ZodString;
+                targetName: z.ZodString;
+                targetType: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>>;
 export declare const zCostEnvironment: z.ZodObject<{
     id: z.ZodUUID;
     handle: z.ZodString;
@@ -2199,6 +2282,50 @@ export declare const zGetOverviewResponse: z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+export declare const zListLiveRoutesData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodOptional<z.ZodNever>;
+    query: z.ZodOptional<z.ZodObject<{
+        org: z.ZodOptional<z.ZodString>;
+        page: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
+        limit: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * A page of environments and their live routes.
+ */
+export declare const zListLiveRoutesResponse: z.ZodIntersection<z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodCoercedBigInt<unknown>;
+    pages: z.ZodInt;
+    data: z.ZodArray<z.ZodUnknown>;
+}, z.core.$strip>, z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        orgId: z.ZodString;
+        spaceName: z.ZodString;
+        environmentId: z.ZodString;
+        environmentHandle: z.ZodString;
+        projectHandle: z.ZodString;
+        deploymentId: z.ZodString;
+        deployedAt: z.ZodISODateTime;
+        subdomains: z.ZodArray<z.ZodObject<{
+            nodeName: z.ZodString;
+            nodeType: z.ZodEnum<{
+                proxy: "proxy";
+                vm: "vm";
+            }>;
+            label: z.ZodString;
+            customDomain: z.ZodString;
+            paths: z.ZodArray<z.ZodObject<{
+                path: z.ZodString;
+                rewrite: z.ZodString;
+                targetName: z.ZodString;
+                targetType: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>>;
 export declare const zGetTenantSummaryData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodOptional<z.ZodNever>;

package/dist/sdk/insights-engine/zod.gen.js

@@ -412,6 +412,41 @@ export const zOverview = z.object({
     daily: z.array(zOverviewDay),
     tenants: zTenantSummary
 });
+export const zLivePath = z.object({
+    path: z.string(),
+    rewrite: z.string(),
+    targetName: z.string(),
+    targetType: z.string()
+});
+/**
+ * A proxy or VM node in the live version and the subdomain it serves. The frontend builds the hostname from the label and the proxy or VM domain of the environment it runs in.
+ */
+export const zLiveSubdomain = z.object({
+    nodeName: z.string(),
+    nodeType: z.enum([
+        'proxy',
+        'vm'
+    ]),
+    label: z.string(),
+    customDomain: z.string(),
+    paths: z.array(zLivePath)
+});
+/**
+ * The subdomains and paths served by an environment's latest succeeded deployment.
+ */
+export const zLiveEnvironment = z.object({
+    orgId: z.string(),
+    spaceName: z.string(),
+    environmentId: z.string(),
+    environmentHandle: z.string(),
+    projectHandle: z.string(),
+    deploymentId: z.string(),
+    deployedAt: z.iso.datetime(),
+    subdomains: z.array(zLiveSubdomain)
+});
+export const zPaginatedLiveEnvironments = zPaginatedResponse.and(z.object({
+    data: z.array(zLiveEnvironment)
+}));
 export const zCostEnvironment = z.object({
     id: z.uuid(),
     handle: z.string(),
@@ -611,6 +646,19 @@ export const zGetOverviewData = z.object({
  * The overview.
  */
 export const zGetOverviewResponse = zOverview;
+export const zListLiveRoutesData = z.object({
+    body: z.optional(z.never()),
+    path: z.optional(z.never()),
+    query: z.optional(z.object({
+        org: z.optional(z.string()),
+        page: z.optional(z.int()).default(1),
+        limit: z.optional(z.int()).default(25)
+    }))
+});
+/**
+ * A page of environments and their live routes.
+ */
+export const zListLiveRoutesResponse = zPaginatedLiveEnvironments;
 export const zGetTenantSummaryData = z.object({
     body: z.optional(z.never()),
     path: z.optional(z.never()),

package/dist/tanstack-codegen/generated/insights-engine.d.ts

@@ -1,4 +1,4 @@
-import { ListTenantsData, GetOverviewData, GetTenantSummaryData, ListUsersData, ListDeploymentsData, ListAuditsData, ListSignUpBreakdownData, ListActorActivityData, ListAuditBreakdownData, ListDeploymentOrganisationsData, ListDeploymentBreakdownData, ListCostOrganisationsData, ListCostBreakdownData } from "../../sdk/insights-engine/types.gen";
+import { ListTenantsData, GetOverviewData, ListLiveRoutesData, GetTenantSummaryData, ListUsersData, ListDeploymentsData, ListAuditsData, ListSignUpBreakdownData, ListActorActivityData, ListAuditBreakdownData, ListDeploymentOrganisationsData, ListDeploymentBreakdownData, ListCostOrganisationsData, ListCostBreakdownData } from "../../sdk/insights-engine/types.gen";
 export declare const useListTenants: (options?: Omit<ListTenantsData, "url"> & {
     enabled?: boolean;
 }) => {
@@ -413,6 +413,213 @@ export declare const useGetOverview: (options?: Omit<GetOverviewData, "url"> & {
         headers: Record<string, string>;
     } | undefined>;
 };
+export declare const useListLiveRoutes: (options?: Omit<ListLiveRoutesData, "url"> & {
+    enabled?: boolean;
+}) => {
+    data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+    headers: Record<string, string> | undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+    headers: Record<string, string> | undefined;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+    headers: Record<string, string> | undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+    headers: Record<string, string> | undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+    headers: Record<string, string> | undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+    headers: Record<string, string> | undefined;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/insights-engine/types.gen").PaginatedLiveEnvironments | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+};
 export declare const useGetTenantSummary: (options?: Omit<GetTenantSummaryData, "url"> & {
     enabled?: boolean;
 }) => {

package/dist/tanstack-codegen/generated/insights-engine.js

@@ -2,7 +2,7 @@
 import { useQuery } from "@tanstack/react-query";
 import { isPromise, headersToObject } from "../util";
 import { useToken } from "../../provider/token-provider";
-import { listTenants, getOverview, getTenantSummary, listUsers, listDeployments, listAudits, listSignUpBreakdown, listActorActivity, listAuditBreakdown, listDeploymentOrganisations, listDeploymentBreakdown, listCostOrganisations, listCostBreakdown } from "../../sdk/insights-engine/sdk.gen";
+import { listTenants, getOverview, listLiveRoutes, getTenantSummary, listUsers, listDeployments, listAudits, listSignUpBreakdown, listActorActivity, listAuditBreakdown, listDeploymentOrganisations, listDeploymentBreakdown, listCostOrganisations, listCostBreakdown } from "../../sdk/insights-engine/sdk.gen";
 export const useListTenants = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -47,6 +47,28 @@ export const useGetOverview = (options) => {
     });
     return { ...query, data: query.data?.data, headers: query.data?.headers };
 };
+export const useListLiveRoutes = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/insights-engine/routes" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await listLiveRoutes({ ...opts, ...rest, auth });
+        return { data: res.data, headers: headersToObject(res.response.headers) };
+    };
+    if (!token)
+        enabled = false;
+    const query = useQuery({
+        queryKey: ["insights-engine", "routes", options?.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false,
+        staleTime: 600000
+    });
+    return { ...query, data: query.data?.data, headers: query.data?.headers };
+};
 export const useGetTenantSummary = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };

package/package.json

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