shoal-web-sdk 0.0.141 → 0.0.143

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

@@ -1,6 +1,6 @@
 import { type InfiniteData, type UseMutationOptions } from '@tanstack/react-query';
 import { type Options } from '../sdk.gen';
-import type { CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVersionsData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, VersionStatusData } from '../types.gen';
+import type { CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVersionsData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, VersionStatusData } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -536,6 +536,34 @@ export declare const getSpaceOrgCodeOptions: (options: Options<GetSpaceOrgCodeDa
         [dataTagErrorSymbol]: Error;
     };
 };
+export declare const getSpaceStatsQueryKey: (options: Options<GetSpaceStatsData>) => [Pick<Options<GetSpaceStatsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * Stats for a space.
+ */
+export declare const getSpaceStatsOptions: (options: Options<GetSpaceStatsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").SpaceStats, Error, import("../types.gen").SpaceStats, [Pick<Options<GetSpaceStatsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").SpaceStats, [Pick<Options<GetSpaceStatsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<GetSpaceStatsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").SpaceStats;
+        [dataTagErrorSymbol]: Error;
+    };
+};
 export declare const fetchKindeOrganisationBillingAgreementsQueryKey: (options: Options<FetchKindeOrganisationBillingAgreementsData>) => [Pick<Options<FetchKindeOrganisationBillingAgreementsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;

package/dist/sdk/@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 { createEnvironment, createEnvironmentVariable, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateUsername, updateUserProfile, versionStatus } from '../sdk.gen';
+import { createEnvironment, createEnvironmentVariable, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateUsername, updateUserProfile, versionStatus } from '../sdk.gen';
 const createQueryKey = (id, options, infinite, tags) => {
     const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
     if (infinite) {
@@ -601,6 +601,24 @@ export const getSpaceOrgCodeOptions = (options) => {
         queryKey: getSpaceOrgCodeQueryKey(options)
     });
 };
+export const getSpaceStatsQueryKey = (options) => createQueryKey('getSpaceStats', options);
+/**
+ * Stats for a space.
+ */
+export const getSpaceStatsOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await getSpaceStats({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: getSpaceStatsQueryKey(options)
+    });
+};
 export const fetchKindeOrganisationBillingAgreementsQueryKey = (options) => createQueryKey('fetchKindeOrganisationBillingAgreements', options);
 /**
  * The space billing agreements.

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

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, JoinSpaceData, JoinSpaceErrors, JoinSpaceResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListBillingInvoicesData, ListBillingInvoicesErrors, ListBillingInvoicesResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RecordCloudUsageData, RecordCloudUsageErrors, RecordCloudUsageResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, VersionStatusData, VersionStatusErrors, VersionStatusResponses } from './types.gen';
+import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetSpaceStatsData, GetSpaceStatsErrors, GetSpaceStatsResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, JoinSpaceData, JoinSpaceErrors, JoinSpaceResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListBillingInvoicesData, ListBillingInvoicesErrors, ListBillingInvoicesResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RecordCloudUsageData, RecordCloudUsageErrors, RecordCloudUsageResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, VersionStatusData, VersionStatusErrors, VersionStatusResponses } 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
@@ -109,6 +109,10 @@ export declare const getSpaceOverview: <ThrowOnError extends boolean = false>(op
  * The space organisation code.
  */
 export declare const getSpaceOrgCode: <ThrowOnError extends boolean = false>(options: Options<GetSpaceOrgCodeData, ThrowOnError>) => import("./client").RequestResult<GetSpaceOrgCodeResponses, GetSpaceOrgCodeErrors, ThrowOnError, "fields">;
+/**
+ * Stats for a space.
+ */
+export declare const getSpaceStats: <ThrowOnError extends boolean = false>(options: Options<GetSpaceStatsData, ThrowOnError>) => import("./client").RequestResult<GetSpaceStatsResponses, GetSpaceStatsErrors, ThrowOnError, "fields">;
 /**
  * The space billing agreements.
  */

package/dist/sdk/sdk.gen.js

@@ -384,6 +384,21 @@ export const getSpaceOrgCode = (options) => {
         ...options
     });
 };
+/**
+ * Stats for a space.
+ */
+export const getSpaceStats = (options) => {
+    return (options.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/{spaceHandle}/stats',
+        ...options
+    });
+};
 /**
  * The space billing agreements.
  */

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

@@ -98,6 +98,16 @@ export type SpaceOverview = {
 export type SpaceOrgCodeResponse = {
     orgCode: string;
 };
+export type SpaceStats = {
+    /**
+     * Total node count across the latest version of every environment in the space.
+     */
+    active_services: number;
+    /**
+     * Count of all deployment attempts across all projects and environments in the current calendar month.
+     */
+    deployments_this_month: number;
+};
 export type EnvironmentOverview = {
     id: string;
     name: string;
@@ -301,9 +311,9 @@ export type Edge = {
     dst: string;
     typ: EdgeType;
     props?: ({
-        typ: 'comment';
+        typ: 'network';
     } & NetworkEdgeProps) | ({
-        typ: 'cache';
+        typ: 'route';
     } & RouteEdgeProps);
 };
 export type NetworkEdgeProps = {
@@ -1512,6 +1522,39 @@ export type GetSpaceOrgCodeResponses = {
     200: SpaceOrgCodeResponse;
 };
 export type GetSpaceOrgCodeResponse = GetSpaceOrgCodeResponses[keyof GetSpaceOrgCodeResponses];
+export type GetSpaceStatsData = {
+    body?: never;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/stats';
+};
+export type GetSpaceStatsErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type GetSpaceStatsError = GetSpaceStatsErrors[keyof GetSpaceStatsErrors];
+export type GetSpaceStatsResponses = {
+    /**
+     * Active service count and deployment count for the current month.
+     */
+    200: SpaceStats;
+};
+export type GetSpaceStatsResponse = GetSpaceStatsResponses[keyof GetSpaceStatsResponses];
 export type FetchKindeOrganisationBillingAgreementsData = {
     body?: never;
     path: {

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

@@ -139,6 +139,10 @@ export declare const zOnboardingAnalytics: z.ZodObject<{
 export declare const zSpaceOrgCodeResponse: z.ZodObject<{
     orgCode: z.ZodString;
 }, z.core.$strip>;
+export declare const zSpaceStats: z.ZodObject<{
+    active_services: z.ZodInt;
+    deployments_this_month: z.ZodInt;
+}, z.core.$strip>;
 export declare const zEnvironmentOverview: z.ZodObject<{
     id: z.ZodUUID;
     name: z.ZodString;
@@ -500,11 +504,11 @@ export declare const zEdge: z.ZodObject<{
         route: "route";
     }>;
     props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-        typ: z.ZodLiteral<"comment">;
+        typ: z.ZodLiteral<"network">;
     }, z.core.$strip>, z.ZodObject<{
         a: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-        typ: z.ZodLiteral<"cache">;
+        typ: z.ZodLiteral<"route">;
     }, z.core.$strip>, z.ZodObject<{
         path: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>]>>;
@@ -632,11 +636,11 @@ export declare const zNode: z.ZodObject<{
             route: "route";
         }>;
         props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-            typ: z.ZodLiteral<"comment">;
+            typ: z.ZodLiteral<"network">;
         }, z.core.$strip>, z.ZodObject<{
             a: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-            typ: z.ZodLiteral<"cache">;
+            typ: z.ZodLiteral<"route">;
         }, z.core.$strip>, z.ZodObject<{
             path: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>]>>;
@@ -751,11 +755,11 @@ export declare const zNodes: z.ZodObject<{
                 route: "route";
             }>;
             props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"comment">;
+                typ: z.ZodLiteral<"network">;
             }, z.core.$strip>, z.ZodObject<{
                 a: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"cache">;
+                typ: z.ZodLiteral<"route">;
             }, z.core.$strip>, z.ZodObject<{
                 path: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>]>>;
@@ -872,11 +876,11 @@ export declare const zGraph: z.ZodObject<{
                 route: "route";
             }>;
             props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"comment">;
+                typ: z.ZodLiteral<"network">;
             }, z.core.$strip>, z.ZodObject<{
                 a: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"cache">;
+                typ: z.ZodLiteral<"route">;
             }, z.core.$strip>, z.ZodObject<{
                 path: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>]>>;
@@ -1206,11 +1210,11 @@ export declare const zFetchGraphM2mResponse: z.ZodObject<{
                 route: "route";
             }>;
             props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"comment">;
+                typ: z.ZodLiteral<"network">;
             }, z.core.$strip>, z.ZodObject<{
                 a: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"cache">;
+                typ: z.ZodLiteral<"route">;
             }, z.core.$strip>, z.ZodObject<{
                 path: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>]>>;
@@ -1327,11 +1331,11 @@ export declare const zUpdateGraphM2mData: z.ZodObject<{
                     route: "route";
                 }>;
                 props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-                    typ: z.ZodLiteral<"comment">;
+                    typ: z.ZodLiteral<"network">;
                 }, z.core.$strip>, z.ZodObject<{
                     a: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-                    typ: z.ZodLiteral<"cache">;
+                    typ: z.ZodLiteral<"route">;
                 }, z.core.$strip>, z.ZodObject<{
                     path: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>]>>;
@@ -1462,11 +1466,11 @@ export declare const zFetchNodeM2mResponse: z.ZodObject<{
             route: "route";
         }>;
         props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-            typ: z.ZodLiteral<"comment">;
+            typ: z.ZodLiteral<"network">;
         }, z.core.$strip>, z.ZodObject<{
             a: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-            typ: z.ZodLiteral<"cache">;
+            typ: z.ZodLiteral<"route">;
         }, z.core.$strip>, z.ZodObject<{
             path: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>]>>;
@@ -1920,6 +1924,20 @@ export declare const zGetSpaceOrgCodeData: z.ZodObject<{
 export declare const zGetSpaceOrgCodeResponse: z.ZodObject<{
     orgCode: z.ZodString;
 }, z.core.$strip>;
+export declare const zGetSpaceStatsData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodObject<{
+        spaceHandle: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+/**
+ * Active service count and deployment count for the current month.
+ */
+export declare const zGetSpaceStatsResponse: z.ZodObject<{
+    active_services: z.ZodInt;
+    deployments_this_month: z.ZodInt;
+}, z.core.$strip>;
 export declare const zFetchKindeOrganisationBillingAgreementsData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{
@@ -2293,11 +2311,11 @@ export declare const zGetGraphOverviewResponse: z.ZodObject<{
                 route: "route";
             }>;
             props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"comment">;
+                typ: z.ZodLiteral<"network">;
             }, z.core.$strip>, z.ZodObject<{
                 a: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-                typ: z.ZodLiteral<"cache">;
+                typ: z.ZodLiteral<"route">;
             }, z.core.$strip>, z.ZodObject<{
                 path: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>]>>;
@@ -2414,11 +2432,11 @@ export declare const zUpdateGraphStateData: z.ZodObject<{
                     route: "route";
                 }>;
                 props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
-                    typ: z.ZodLiteral<"comment">;
+                    typ: z.ZodLiteral<"network">;
                 }, z.core.$strip>, z.ZodObject<{
                     a: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
-                    typ: z.ZodLiteral<"cache">;
+                    typ: z.ZodLiteral<"route">;
                 }, z.core.$strip>, z.ZodObject<{
                     path: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>]>>;

package/dist/sdk/zod.gen.js

@@ -102,6 +102,10 @@ export const zOnboardingAnalytics = z.object({
 export const zSpaceOrgCodeResponse = z.object({
     orgCode: z.string()
 });
+export const zSpaceStats = z.object({
+    active_services: z.int(),
+    deployments_this_month: z.int()
+});
 export const zEnvironmentOverview = z.object({
     id: z.uuid(),
     name: z.string(),
@@ -320,10 +324,10 @@ export const zEdge = z.object({
     typ: zEdgeType,
     props: z.optional(z.union([
         z.object({
-            typ: z.literal('comment')
+            typ: z.literal('network')
         }).and(zNetworkEdgeProps),
         z.object({
-            typ: z.literal('cache')
+            typ: z.literal('route')
         }).and(zRouteEdgeProps)
     ]))
 });
@@ -854,6 +858,17 @@ export const zGetSpaceOrgCodeData = z.object({
  * The organisation code for this space.
  */
 export const zGetSpaceOrgCodeResponse = zSpaceOrgCodeResponse;
+export const zGetSpaceStatsData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        spaceHandle: z.string()
+    }),
+    query: z.optional(z.never())
+});
+/**
+ * Active service count and deployment count for the current month.
+ */
+export const zGetSpaceStatsResponse = zSpaceStats;
 export const zFetchKindeOrganisationBillingAgreementsData = z.object({
     body: z.optional(z.never()),
     path: z.object({

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

@@ -1,6 +1,6 @@
 import { useMutation } from "@tanstack/react-query";
 import { GetSuccessResponse } from "../util";
-import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, VersionStatusData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData } from "../../sdk/types.gen";
+import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, VersionStatusData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData } from "../../sdk/types.gen";
 export declare const useGetServiceHealth: (options?: Omit<GetServiceHealthData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").HealthResponse | undefined, Error>;
@@ -95,6 +95,9 @@ export declare const useGetSpaceOverview: (options: Omit<GetSpaceOverviewData, "
 export declare const useGetSpaceOrgCode: (options: Omit<GetSpaceOrgCodeData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").SpaceOrgCodeResponse | undefined, Error>;
+export declare const useGetSpaceStats: (options: Omit<GetSpaceStatsData, "url"> & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").SpaceStats | undefined, Error>;
 export declare const useFetchKindeOrganisationBillingAgreements: (options: Omit<FetchKindeOrganisationBillingAgreementsData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<unknown, Error>;

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

@@ -2,7 +2,7 @@
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import { isPromise } from "../util";
 import { useToken } from "../../provider/token-provider";
-import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices } from "../../sdk/sdk.gen";
+import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices } from "../../sdk/sdk.gen";
 export const useGetServiceHealth = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -485,6 +485,27 @@ export const useGetSpaceOrgCode = (options) => {
         staleTime: 600000
     });
 };
+export const useGetSpaceStats = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/stats" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await getSpaceStats({ ...opts, ...rest, auth });
+        return res.data;
+    };
+    if (!token)
+        enabled = false;
+    return useQuery({
+        queryKey: [options?.path?.spaceHandle, "stats", options.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false,
+        staleTime: 600000
+    });
+};
 export const useFetchKindeOrganisationBillingAgreements = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };

package/package.json

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