shoal-web-sdk 1.0.141 → 1.0.142

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 { ListActorActivityData, ListAuditBreakdownData, ListAuditsData, ListCostBreakdownData, ListDeploymentBreakdownData, ListDeploymentOrganisationsData, ListDeploymentsData, ListSignUpBreakdownData, ListTenantsData, ListUsersData } from '../types.gen';
+import type { GetTenantSummaryData, ListActorActivityData, ListAuditBreakdownData, ListAuditsData, ListCostBreakdownData, ListCostOrganisationsData, ListDeploymentBreakdownData, ListDeploymentOrganisationsData, ListDeploymentsData, ListSignUpBreakdownData, ListTenantsData, ListUsersData } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -70,6 +70,39 @@ export declare const listTenantsInfiniteOptions: (options?: Options<ListTenantsD
         [dataTagErrorSymbol]: import("../types.gen")._Error;
     };
 };
+export declare const getTenantSummaryQueryKey: (options?: Options<GetTenantSummaryData>) => [Pick<Options<GetTenantSummaryData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * Summarise tenants
+ *
+ * Returns counts over every tenant by lifecycle state, plan and scheduled plan change, and
+ * the same for tenants created within the window. Reads billing data only, so it is cheap
+ * compared with listing tenants.
+ *
+ */
+export declare const getTenantSummaryOptions: (options?: Options<GetTenantSummaryData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").TenantSummary, Error, import("../types.gen").TenantSummary, [Pick<Options<GetTenantSummaryData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").TenantSummary, [Pick<Options<GetTenantSummaryData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<GetTenantSummaryData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").TenantSummary;
+        [dataTagErrorSymbol]: Error;
+    };
+};
 export declare const listUsersQueryKey: (options?: Options<ListUsersData>) => [Pick<Options<ListUsersData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;
@@ -580,6 +613,66 @@ export declare const listDeploymentBreakdownInfiniteOptions: (options?: Options<
         [dataTagErrorSymbol]: import("../types.gen")._Error;
     };
 };
+export declare const listCostOrganisationsQueryKey: (options?: Options<ListCostOrganisationsData>) => [Pick<Options<ListCostOrganisationsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * List spend per space
+ *
+ * Returns a page of spaces with spend within the window, highest spend first, each broken
+ * down by project and environment.
+ *
+ */
+export declare const listCostOrganisationsOptions: (options?: Options<ListCostOrganisationsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedCostOrganisations, Error, import("../types.gen").PaginatedCostOrganisations, [Pick<Options<ListCostOrganisationsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedCostOrganisations, [Pick<Options<ListCostOrganisationsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<ListCostOrganisationsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").PaginatedCostOrganisations;
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare const listCostOrganisationsInfiniteQueryKey: (options?: Options<ListCostOrganisationsData>) => QueryKey<Options<ListCostOrganisationsData>>;
+/**
+ * List spend per space
+ *
+ * Returns a page of spaces with spend within the window, highest spend first, each broken
+ * down by project and environment.
+ *
+ */
+export declare const listCostOrganisationsInfiniteOptions: (options?: Options<ListCostOrganisationsData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedCostOrganisations, import("../types.gen")._Error, InfiniteData<import("../types.gen").PaginatedCostOrganisations, unknown>, QueryKey<Options<ListCostOrganisationsData>>, number | Pick<Pick<Options<ListCostOrganisationsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}, "query" | "body" | "headers" | "path">> & {
+    initialData: InfiniteData<import("../types.gen").PaginatedCostOrganisations, number | Pick<Pick<Options<ListCostOrganisationsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedCostOrganisations, number | Pick<Pick<Options<ListCostOrganisationsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">>) | undefined;
+} & {
+    queryKey: QueryKey<Options<ListCostOrganisationsData>> & {
+        [dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedCostOrganisations, unknown>;
+        [dataTagErrorSymbol]: import("../types.gen")._Error;
+    };
+};
 export declare const listCostBreakdownQueryKey: (options?: Options<ListCostBreakdownData>) => [Pick<Options<ListCostBreakdownData>, "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 { listActorActivity, listAuditBreakdown, listAudits, listCostBreakdown, listDeploymentBreakdown, listDeploymentOrganisations, listDeployments, listSignUpBreakdown, listTenants, listUsers } from '../sdk.gen';
+import { getTenantSummary, listActorActivity, listAuditBreakdown, listAudits, listCostBreakdown, listCostOrganisations, listDeploymentBreakdown, listDeploymentOrganisations, listDeployments, 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) {
@@ -111,6 +111,29 @@ export const listTenantsInfiniteOptions = (options) => {
         queryKey: listTenantsInfiniteQueryKey(options)
     });
 };
+export const getTenantSummaryQueryKey = (options) => createQueryKey('getTenantSummary', options);
+/**
+ * Summarise tenants
+ *
+ * Returns counts over every tenant by lifecycle state, plan and scheduled plan change, and
+ * the same for tenants created within the window. Reads billing data only, so it is cheap
+ * compared with listing tenants.
+ *
+ */
+export const getTenantSummaryOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await getTenantSummary({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: getTenantSummaryQueryKey(options)
+    });
+};
 export const listUsersQueryKey = (options) => createQueryKey('listUsers', options);
 /**
  * List users
@@ -565,6 +588,59 @@ export const listDeploymentBreakdownInfiniteOptions = (options) => {
         queryKey: listDeploymentBreakdownInfiniteQueryKey(options)
     });
 };
+export const listCostOrganisationsQueryKey = (options) => createQueryKey('listCostOrganisations', options);
+/**
+ * List spend per space
+ *
+ * Returns a page of spaces with spend within the window, highest spend first, each broken
+ * down by project and environment.
+ *
+ */
+export const listCostOrganisationsOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await listCostOrganisations({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: listCostOrganisationsQueryKey(options)
+    });
+};
+export const listCostOrganisationsInfiniteQueryKey = (options) => createQueryKey('listCostOrganisations', options, true);
+/**
+ * List spend per space
+ *
+ * Returns a page of spaces with spend within the window, highest spend first, each broken
+ * down by project and environment.
+ *
+ */
+export const listCostOrganisationsInfiniteOptions = (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 listCostOrganisations({
+                ...options,
+                ...params,
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: listCostOrganisationsInfiniteQueryKey(options)
+    });
+};
 export const listCostBreakdownQueryKey = (options) => createQueryKey('listCostBreakdown', options);
 /**
  * List the daily cost breakdown

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

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { ListActorActivityData, ListActorActivityErrors, ListActorActivityResponses, ListAuditBreakdownData, ListAuditBreakdownErrors, ListAuditBreakdownResponses, ListAuditsData, ListAuditsErrors, ListAuditsResponses, ListCostBreakdownData, ListCostBreakdownErrors, ListCostBreakdownResponses, ListDeploymentBreakdownData, ListDeploymentBreakdownErrors, ListDeploymentBreakdownResponses, ListDeploymentOrganisationsData, ListDeploymentOrganisationsErrors, ListDeploymentOrganisationsResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListSignUpBreakdownData, ListSignUpBreakdownErrors, ListSignUpBreakdownResponses, ListTenantsData, ListTenantsErrors, ListTenantsResponses, ListUsersData, ListUsersErrors, ListUsersResponses } from './types.gen';
+import type { 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';
 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
@@ -22,6 +22,15 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
  *
  */
 export declare const listTenants: <ThrowOnError extends boolean = false>(options?: Options<ListTenantsData, ThrowOnError>) => import("./client").RequestResult<ListTenantsResponses, ListTenantsErrors, ThrowOnError, "fields">;
+/**
+ * Summarise tenants
+ *
+ * Returns counts over every tenant by lifecycle state, plan and scheduled plan change, and
+ * the same for tenants created within the window. Reads billing data only, so it is cheap
+ * compared with listing tenants.
+ *
+ */
+export declare const getTenantSummary: <ThrowOnError extends boolean = false>(options?: Options<GetTenantSummaryData, ThrowOnError>) => import("./client").RequestResult<GetTenantSummaryResponses, GetTenantSummaryErrors, ThrowOnError, "fields">;
 /**
  * List users
  *
@@ -101,6 +110,14 @@ export declare const listDeploymentOrganisations: <ThrowOnError extends boolean
  *
  */
 export declare const listDeploymentBreakdown: <ThrowOnError extends boolean = false>(options?: Options<ListDeploymentBreakdownData, ThrowOnError>) => import("./client").RequestResult<ListDeploymentBreakdownResponses, ListDeploymentBreakdownErrors, ThrowOnError, "fields">;
+/**
+ * List spend per space
+ *
+ * Returns a page of spaces with spend within the window, highest spend first, each broken
+ * down by project and environment.
+ *
+ */
+export declare const listCostOrganisations: <ThrowOnError extends boolean = false>(options?: Options<ListCostOrganisationsData, ThrowOnError>) => import("./client").RequestResult<ListCostOrganisationsResponses, ListCostOrganisationsErrors, ThrowOnError, "fields">;
 /**
  * List the daily cost breakdown
  *

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

@@ -20,6 +20,26 @@ export const listTenants = (options) => {
         ...options
     });
 };
+/**
+ * Summarise tenants
+ *
+ * Returns counts over every tenant by lifecycle state, plan and scheduled plan change, and
+ * the same for tenants created within the window. Reads billing data only, so it is cheap
+ * compared with listing tenants.
+ *
+ */
+export const getTenantSummary = (options) => {
+    return (options?.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/insights-engine/tenants/summary',
+        ...options
+    });
+};
 /**
  * List users
  *
@@ -187,6 +207,25 @@ export const listDeploymentBreakdown = (options) => {
         ...options
     });
 };
+/**
+ * List spend per space
+ *
+ * Returns a page of spaces with spend within the window, highest spend first, each broken
+ * down by project and environment.
+ *
+ */
+export const listCostOrganisations = (options) => {
+    return (options?.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/insights-engine/billing/organisations',
+        ...options
+    });
+};
 /**
  * List the daily cost breakdown
  *

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

@@ -344,6 +344,7 @@ export type OnboardingAnalytics = {
 export type UserSignUpBreakdown = {
     email: string;
     onboardingAnalytics: OnboardingAnalytics;
+    user: User;
 };
 /**
  * A day of sign ups, the users who signed up, and how they answered each onboarding question.
@@ -446,6 +447,82 @@ export type DeploymentOrganisation = {
 export type PaginatedDeploymentOrganisations = PaginatedResponse & {
     data: Array<DeploymentOrganisation>;
 };
+export type CountByKey = {
+    [key: string]: number;
+};
+export type PlanTransition = {
+    from: string;
+    to: string;
+    change: 'upgrade' | 'downgrade';
+    count: number;
+};
+export type TenantCohortDay = {
+    timestamp: string;
+    states: CountByKey;
+};
+/**
+ * Tenants created within the window.
+ */
+export type TenantCohort = {
+    total: number;
+    states: CountByKey;
+    plans: CountByKey;
+    /**
+     * Tenants that have trialed or are trialing.
+     */
+    trialed: number;
+    trialStates: CountByKey;
+    /**
+     * Oldest day first, counting tenants by the day they were created.
+     */
+    daily: Array<TenantCohortDay>;
+};
+/**
+ * Counts over every tenant by lifecycle state, plan and scheduled plan change, plus the same for tenants created within the window. Aggregated server side from billing data.
+ */
+export type TenantSummary = {
+    total: number;
+    states: CountByKey;
+    plans: CountByKey;
+    upgrades: number;
+    downgrades: number;
+    /**
+     * Most common first.
+     */
+    transitions: Array<PlanTransition>;
+    cohort: TenantCohort;
+};
+export type CostEnvironment = {
+    id: string;
+    handle: string;
+    gcpProjectId: string;
+    cost: Cost;
+};
+export type CostProject = {
+    id: string;
+    handle: string;
+    cost: Cost;
+    environments: Array<CostEnvironment>;
+};
+/**
+ * Spend of one space within the window, broken down by project and environment. Spend on GCP projects that no current environment claims is reported separately as unattributed.
+ */
+export type CostOrganisation = {
+    orgId: string;
+    name: string;
+    currentPlan: string;
+    status: string;
+    /**
+     * Every member uses a platform48.com email.
+     */
+    internal: boolean;
+    cost: Cost;
+    unattributed: Cost;
+    projects: Array<CostProject>;
+};
+export type PaginatedCostOrganisations = PaginatedResponse & {
+    data: Array<CostOrganisation>;
+};
 export type PaginatedTenants = PaginatedResponse & {
     data: Array<Tenant>;
 };
@@ -508,9 +585,9 @@ export type Plan = string;
  */
 export type State = 'trialing' | 'converted' | 'paying' | 'trial_to_solo' | 'solo' | 'onboarding' | 'at_risk' | 'churned';
 /**
- * Only tenants whose next billing cycle is on a higher, lower or the same plan.
+ * Only tenants whose next billing cycle is on a higher, lower or the same plan. `changed` matches both upgrades and downgrades.
  */
-export type PlanChange = 'upgrade' | 'downgrade' | 'none';
+export type PlanChange = 'upgrade' | 'downgrade' | 'changed' | 'none';
 /**
  * Leave out internal accounts, those whose members all use a platform48.com email.
  */
@@ -584,9 +661,9 @@ export type ListTenantsData = {
          */
         state?: 'trialing' | 'converted' | 'paying' | 'trial_to_solo' | 'solo' | 'onboarding' | 'at_risk' | 'churned';
         /**
-         * Only tenants whose next billing cycle is on a higher, lower or the same plan.
+         * Only tenants whose next billing cycle is on a higher, lower or the same plan. `changed` matches both upgrades and downgrades.
          */
-        plan_change?: 'upgrade' | 'downgrade' | 'none';
+        plan_change?: 'upgrade' | 'downgrade' | 'changed' | 'none';
         /**
          * Leave out internal accounts, those whose members all use a platform48.com email.
          */
@@ -612,6 +689,43 @@ export type ListTenantsResponses = {
     200: PaginatedTenants;
 };
 export type ListTenantsResponse = ListTenantsResponses[keyof ListTenantsResponses];
+export type GetTenantSummaryData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Start of the reporting window. Unbounded when omitted.
+         */
+        from?: string;
+        /**
+         * End of the reporting window. Unbounded when omitted.
+         */
+        to?: string;
+        /**
+         * Leave out internal accounts, those whose members all use a platform48.com email.
+         */
+        exclude_internal?: boolean;
+    };
+    url: '/insights-engine/tenants/summary';
+};
+export type GetTenantSummaryErrors = {
+    /**
+     * The request was rejected as invalid.
+     */
+    400: _Error;
+    /**
+     * The service is not healthy.
+     */
+    500: _Error;
+};
+export type GetTenantSummaryError = GetTenantSummaryErrors[keyof GetTenantSummaryErrors];
+export type GetTenantSummaryResponses = {
+    /**
+     * The tenant summary.
+     */
+    200: TenantSummary;
+};
+export type GetTenantSummaryResponse = GetTenantSummaryResponses[keyof GetTenantSummaryResponses];
 export type ListUsersData = {
     body?: never;
     path?: never;
@@ -1064,6 +1178,47 @@ export type ListDeploymentBreakdownResponses = {
     200: PaginatedDeploymentBreakdown;
 };
 export type ListDeploymentBreakdownResponse = ListDeploymentBreakdownResponses[keyof ListDeploymentBreakdownResponses];
+export type ListCostOrganisationsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Start of the reporting window. Unbounded when omitted.
+         */
+        from?: string;
+        /**
+         * End of the reporting window. Unbounded when omitted.
+         */
+        to?: string;
+        /**
+         * 1-based page index.
+         */
+        page?: number;
+        /**
+         * Items per page, clamped server side to at most 5000.
+         */
+        limit?: number;
+    };
+    url: '/insights-engine/billing/organisations';
+};
+export type ListCostOrganisationsErrors = {
+    /**
+     * The request was rejected as invalid.
+     */
+    400: _Error;
+    /**
+     * The service is not healthy.
+     */
+    500: _Error;
+};
+export type ListCostOrganisationsError = ListCostOrganisationsErrors[keyof ListCostOrganisationsErrors];
+export type ListCostOrganisationsResponses = {
+    /**
+     * A page of spaces and their spend.
+     */
+    200: PaginatedCostOrganisations;
+};
+export type ListCostOrganisationsResponse = ListCostOrganisationsResponses[keyof ListCostOrganisationsResponses];
 export type ListCostBreakdownData = {
     body?: never;
     path?: never;