shoal-web-sdk 0.0.110 → 0.0.112

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, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeployVersionData, DeployVersionError, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError } from '../types.gen';
+import type { CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -800,6 +800,10 @@ export declare const requestSignedUploadUrlOptions: (options: Options<RequestSig
         [dataTagErrorSymbol]: Error;
     };
 };
+/**
+ * Record a cloud usage event for a space (M2M only).
+ */
+export declare const recordCloudUsageMutation: (options?: Partial<Options<RecordCloudUsageData>>) => UseMutationOptions<unknown, RecordCloudUsageError, Options<RecordCloudUsageData>>;
 export declare const getBillingPlanQueryKey: (options: Options<GetBillingPlanData>) => [Pick<Options<GetBillingPlanData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;
@@ -900,3 +904,31 @@ export declare const getBillingUsageOptions: (options: Options<GetBillingUsageDa
         [dataTagErrorSymbol]: Error;
     };
 };
+export declare const fetchBillingPricesQueryKey: (options: Options<FetchBillingPricesData>) => [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * Fetch live unit prices for all paid plans from Stripe.
+ */
+export declare const fetchBillingPricesOptions: (options: Options<FetchBillingPricesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PlanPriceResponse[], Error, import("../types.gen").PlanPriceResponse[], [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PlanPriceResponse[], [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").PlanPriceResponse[];
+        [dataTagErrorSymbol]: Error;
+    };
+};

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, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deployVersion, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateGraphState, updateUsername, updateUserProfile } from '../sdk.gen';
+import { createEnvironment, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateGraphState, updateUsername, updateUserProfile } from '../sdk.gen';
 const createQueryKey = (id, options, infinite, tags) => {
     const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
     if (infinite) {
@@ -861,6 +861,22 @@ export const requestSignedUploadUrlOptions = (options) => {
         queryKey: requestSignedUploadUrlQueryKey(options)
     });
 };
+/**
+ * Record a cloud usage event for a space (M2M only).
+ */
+export const recordCloudUsageMutation = (options) => {
+    const mutationOptions = {
+        mutationFn: async (fnOptions) => {
+            const { data } = await recordCloudUsage({
+                ...options,
+                ...fnOptions,
+                throwOnError: true
+            });
+            return data;
+        }
+    };
+    return mutationOptions;
+};
 export const getBillingPlanQueryKey = (options) => createQueryKey('getBillingPlan', options);
 /**
  * Get the current billing plan for a space.
@@ -979,3 +995,21 @@ export const getBillingUsageOptions = (options) => {
         queryKey: getBillingUsageQueryKey(options)
     });
 };
+export const fetchBillingPricesQueryKey = (options) => createQueryKey('fetchBillingPrices', options);
+/**
+ * Fetch live unit prices for all paid plans from Stripe.
+ */
+export const fetchBillingPricesOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await fetchBillingPrices({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: fetchBillingPricesQueryKey(options)
+    });
+};

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, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, 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, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses } from './types.gen';
+import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, 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, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RecordCloudUsageData, RecordCloudUsageErrors, RecordCloudUsageResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses } 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
@@ -157,6 +157,10 @@ export declare const deployVersion: <ThrowOnError extends boolean = false>(optio
  * Request a signed upload URL to upload source code zip files.
  */
 export declare const requestSignedUploadUrl: <ThrowOnError extends boolean = false>(options: Options<RequestSignedUploadUrlData, ThrowOnError>) => import("./client").RequestResult<RequestSignedUploadUrlResponses, RequestSignedUploadUrlErrors, ThrowOnError, "fields">;
+/**
+ * Record a cloud usage event for a space (M2M only).
+ */
+export declare const recordCloudUsage: <ThrowOnError extends boolean = false>(options: Options<RecordCloudUsageData, ThrowOnError>) => import("./client").RequestResult<RecordCloudUsageResponses, RecordCloudUsageErrors, ThrowOnError, "fields">;
 /**
  * Get the current billing plan for a space.
  */
@@ -185,3 +189,7 @@ export declare const setDefaultPaymentMethod: <ThrowOnError extends boolean = fa
  * Get metered cloud usage for the current billing period.
  */
 export declare const getBillingUsage: <ThrowOnError extends boolean = false>(options: Options<GetBillingUsageData, ThrowOnError>) => import("./client").RequestResult<GetBillingUsageResponses, GetBillingUsageErrors, ThrowOnError, "fields">;
+/**
+ * Fetch live unit prices for all paid plans from Stripe.
+ */
+export declare const fetchBillingPrices: <ThrowOnError extends boolean = false>(options: Options<FetchBillingPricesData, ThrowOnError>) => import("./client").RequestResult<FetchBillingPricesResponses, FetchBillingPricesErrors, ThrowOnError, "fields">;

package/dist/sdk/sdk.gen.js

@@ -572,6 +572,25 @@ export const requestSignedUploadUrl = (options) => {
         ...options
     });
 };
+/**
+ * Record a cloud usage event for a space (M2M only).
+ */
+export const recordCloudUsage = (options) => {
+    return (options.client ?? client).post({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/m2m/billing/usage/record',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
 /**
  * Get the current billing plan for a space.
  */
@@ -681,3 +700,18 @@ export const getBillingUsage = (options) => {
         ...options
     });
 };
+/**
+ * Fetch live unit prices for all paid plans from Stripe.
+ */
+export const fetchBillingPrices = (options) => {
+    return (options.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/{spaceHandle}/billing/prices',
+        ...options
+    });
+};

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

@@ -1,7 +1,9 @@
 export type ClientOptions = {
     baseUrl: 'http://localhost:8080/core-service' | 'https://api-dev.shoalstack.com/core-service' | (string & {});
 };
-export type BillingPlanLookupKey = 'free_monthly' | 'free_annual' | 'hobby_monthly' | 'hobby_annual' | 'pro_monthly' | 'pro_annual';
+export type PlatformTier = 'free' | 'hobby' | 'pro';
+export type BillingInterval = 'monthly' | 'annual';
+export type BillingPlanLookupKey = 'free-monthly' | 'hobby-monthly' | 'hobby-annual' | 'pro-monthly' | 'pro-annual';
 export type HealthResponse = {
     status: string;
 };
@@ -352,15 +354,18 @@ export type SignedUrlUploadResponse = {
     expiration: string;
 };
 export type BillingPlan = {
-    tier: 'free' | 'hobby' | 'pro';
-    interval?: 'monthly' | 'annual';
+    tier: PlatformTier;
+    interval?: BillingInterval;
     seatCount: number;
     currentPeriodEnd?: string;
-    pendingDowngrade?: 'free' | 'hobby' | 'pro';
+    pendingDowngrade?: PlatformTier;
     entitlements: Array<string>;
 };
 export type UpdatePlanRequest = {
-    priceId: string;
+    /**
+     * Stripe price lookup key (e.g. "hobby-monthly"). Empty string = Free tier.
+     */
+    lookup_key: string;
 };
 export type PaymentMethod = {
     id: string;
@@ -376,6 +381,38 @@ export type SetupIntentResponse = {
 export type BillingUsage = {
     totalUnits: number;
 };
+export type RecordUsageRequest = {
+    /**
+     * The Kinde organisation code for the space.
+     */
+    orgCode: string;
+    /**
+     * Usage quantity to record.
+     */
+    quantity: number;
+    /**
+     * Unix timestamp (seconds) at which the usage occurred. Defaults to now if omitted.
+     */
+    timestamp?: number;
+};
+export type PlanPriceResponse = {
+    /**
+     * Plan code (e.g. "hobby-monthly", "pro-annual").
+     */
+    code: string;
+    /**
+     * Price per seat in the smallest currency unit (e.g. cents).
+     */
+    unit_amount_cents: number;
+    /**
+     * ISO 4217 currency code (e.g. "usd").
+     */
+    currency: string;
+    /**
+     * Billing interval ("month" or "year").
+     */
+    interval: string;
+};
 /**
  * Expiry query.
  */
@@ -1892,6 +1929,37 @@ export type RequestSignedUploadUrlResponses = {
     200: SignedUrlUploadResponse;
 };
 export type RequestSignedUploadUrlResponse = RequestSignedUploadUrlResponses[keyof RequestSignedUploadUrlResponses];
+export type RecordCloudUsageData = {
+    body: RecordUsageRequest;
+    path?: never;
+    query?: never;
+    url: '/m2m/billing/usage/record';
+};
+export type RecordCloudUsageErrors = {
+    /**
+     * Bad request.
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorised.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type RecordCloudUsageError = RecordCloudUsageErrors[keyof RecordCloudUsageErrors];
+export type RecordCloudUsageResponses = {
+    /**
+     * Usage recorded successfully.
+     */
+    202: unknown;
+};
 export type GetBillingPlanData = {
     body?: never;
     path: {
@@ -2134,3 +2202,36 @@ export type GetBillingUsageResponses = {
     200: BillingUsage;
 };
 export type GetBillingUsageResponse = GetBillingUsageResponses[keyof GetBillingUsageResponses];
+export type FetchBillingPricesData = {
+    body?: never;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/billing/prices';
+};
+export type FetchBillingPricesErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type FetchBillingPricesError = FetchBillingPricesErrors[keyof FetchBillingPricesErrors];
+export type FetchBillingPricesResponses = {
+    /**
+     * A list of plan prices.
+     */
+    200: Array<PlanPriceResponse>;
+};
+export type FetchBillingPricesResponse = FetchBillingPricesResponses[keyof FetchBillingPricesResponses];

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

@@ -1,11 +1,19 @@
 import { z } from 'zod';
+export declare const zPlatformTier: z.ZodEnum<{
+    free: "free";
+    hobby: "hobby";
+    pro: "pro";
+}>;
+export declare const zBillingInterval: z.ZodEnum<{
+    monthly: "monthly";
+    annual: "annual";
+}>;
 export declare const zBillingPlanLookupKey: z.ZodEnum<{
-    free_monthly: "free_monthly";
-    free_annual: "free_annual";
-    hobby_monthly: "hobby_monthly";
-    hobby_annual: "hobby_annual";
-    pro_monthly: "pro_monthly";
-    pro_annual: "pro_annual";
+    "free-monthly": "free-monthly";
+    "hobby-monthly": "hobby-monthly";
+    "hobby-annual": "hobby-annual";
+    "pro-monthly": "pro-monthly";
+    "pro-annual": "pro-annual";
 }>;
 export declare const zHealthResponse: z.ZodObject<{
     status: z.ZodString;
@@ -1039,7 +1047,7 @@ export declare const zBillingPlan: z.ZodObject<{
     entitlements: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
 export declare const zUpdatePlanRequest: z.ZodObject<{
-    priceId: z.ZodString;
+    lookup_key: z.ZodString;
 }, z.core.$strip>;
 export declare const zPaymentMethod: z.ZodObject<{
     id: z.ZodString;
@@ -1055,6 +1063,17 @@ export declare const zSetupIntentResponse: z.ZodObject<{
 export declare const zBillingUsage: z.ZodObject<{
     totalUnits: z.ZodCoercedBigInt<unknown>;
 }, z.core.$strip>;
+export declare const zRecordUsageRequest: z.ZodObject<{
+    orgCode: z.ZodString;
+    quantity: z.ZodCoercedBigInt<unknown>;
+    timestamp: z.ZodOptional<z.ZodCoercedBigInt<unknown>>;
+}, z.core.$strip>;
+export declare const zPlanPriceResponse: z.ZodObject<{
+    code: z.ZodString;
+    unit_amount_cents: z.ZodCoercedBigInt<unknown>;
+    currency: z.ZodString;
+    interval: z.ZodString;
+}, z.core.$strip>;
 /**
  * Expiry query.
  */
@@ -2214,6 +2233,15 @@ export declare const zRequestSignedUploadUrlResponse: z.ZodObject<{
     signedUrl: z.ZodString;
     expiration: z.ZodISODateTime;
 }, z.core.$strip>;
+export declare const zRecordCloudUsageData: z.ZodObject<{
+    body: z.ZodObject<{
+        orgCode: z.ZodString;
+        quantity: z.ZodCoercedBigInt<unknown>;
+        timestamp: z.ZodOptional<z.ZodCoercedBigInt<unknown>>;
+    }, z.core.$strip>;
+    path: z.ZodOptional<z.ZodNever>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
 export declare const zGetBillingPlanData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{
@@ -2245,7 +2273,7 @@ export declare const zGetBillingPlanResponse: z.ZodObject<{
 }, z.core.$strip>;
 export declare const zUpdateBillingPlanData: z.ZodObject<{
     body: z.ZodObject<{
-        priceId: z.ZodString;
+        lookup_key: z.ZodString;
     }, z.core.$strip>;
     path: z.ZodObject<{
         spaceHandle: z.ZodString;
@@ -2320,3 +2348,19 @@ export declare const zGetBillingUsageData: z.ZodObject<{
 export declare const zGetBillingUsageResponse: z.ZodObject<{
     totalUnits: z.ZodCoercedBigInt<unknown>;
 }, z.core.$strip>;
+export declare const zFetchBillingPricesData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodObject<{
+        spaceHandle: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+/**
+ * A list of plan prices.
+ */
+export declare const zFetchBillingPricesResponse: z.ZodArray<z.ZodObject<{
+    code: z.ZodString;
+    unit_amount_cents: z.ZodCoercedBigInt<unknown>;
+    currency: z.ZodString;
+    interval: z.ZodString;
+}, z.core.$strip>>;

package/dist/sdk/zod.gen.js

@@ -1,12 +1,20 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { z } from 'zod';
+export const zPlatformTier = z.enum([
+    'free',
+    'hobby',
+    'pro'
+]);
+export const zBillingInterval = z.enum([
+    'monthly',
+    'annual'
+]);
 export const zBillingPlanLookupKey = z.enum([
-    'free_monthly',
-    'free_annual',
-    'hobby_monthly',
-    'hobby_annual',
-    'pro_monthly',
-    'pro_annual'
+    'free-monthly',
+    'hobby-monthly',
+    'hobby-annual',
+    'pro-monthly',
+    'pro-annual'
 ]);
 export const zHealthResponse = z.object({
     status: z.string()
@@ -439,26 +447,15 @@ export const zSignedUrlUploadResponse = z.object({
     expiration: z.iso.datetime()
 });
 export const zBillingPlan = z.object({
-    tier: z.enum([
-        'free',
-        'hobby',
-        'pro'
-    ]),
-    interval: z.optional(z.enum([
-        'monthly',
-        'annual'
-    ])),
+    tier: zPlatformTier,
+    interval: z.optional(zBillingInterval),
     seatCount: z.coerce.bigint(),
     currentPeriodEnd: z.optional(z.iso.datetime()),
-    pendingDowngrade: z.optional(z.enum([
-        'free',
-        'hobby',
-        'pro'
-    ])),
+    pendingDowngrade: z.optional(zPlatformTier),
     entitlements: z.array(z.string())
 });
 export const zUpdatePlanRequest = z.object({
-    priceId: z.string()
+    lookup_key: z.string()
 });
 export const zPaymentMethod = z.object({
     id: z.string(),
@@ -474,6 +471,17 @@ export const zSetupIntentResponse = z.object({
 export const zBillingUsage = z.object({
     totalUnits: z.coerce.bigint()
 });
+export const zRecordUsageRequest = z.object({
+    orgCode: z.string(),
+    quantity: z.coerce.bigint(),
+    timestamp: z.optional(z.coerce.bigint())
+});
+export const zPlanPriceResponse = z.object({
+    code: z.string(),
+    unit_amount_cents: z.coerce.bigint(),
+    currency: z.string(),
+    interval: z.string()
+});
 /**
  * Expiry query.
  */
@@ -934,6 +942,11 @@ export const zRequestSignedUploadUrlData = z.object({
  * A successfully generated signed url.
  */
 export const zRequestSignedUploadUrlResponse = zSignedUrlUploadResponse;
+export const zRecordCloudUsageData = z.object({
+    body: zRecordUsageRequest,
+    path: z.optional(z.never()),
+    query: z.optional(z.never())
+});
 export const zGetBillingPlanData = z.object({
     body: z.optional(z.never()),
     path: z.object({
@@ -1009,3 +1022,14 @@ export const zGetBillingUsageData = z.object({
  * Current billing period usage.
  */
 export const zGetBillingUsageResponse = zBillingUsage;
+export const zFetchBillingPricesData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        spaceHandle: z.string()
+    }),
+    query: z.optional(z.never())
+});
+/**
+ * A list of plan prices.
+ */
+export const zFetchBillingPricesResponse = z.array(zPlanPriceResponse);

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, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, 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, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedUploadUrlData, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData } from "../../sdk/types.gen";
+import { GetServiceHealthData, FetchGraphM2mData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, 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, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedUploadUrlData, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData } 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>;
@@ -141,6 +141,11 @@ export declare const useDeployVersion: (config?: {
 export declare const useRequestSignedUploadUrl: (options: Omit<RequestSignedUploadUrlData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").SignedUrlUploadResponse | undefined, Error>;
+export declare const useRecordCloudUsage: (config?: {
+    onSuccess?: (data: GetSuccessResponse<RecordCloudUsageResponses>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<unknown, unknown, Omit<RecordCloudUsageData, "url">, unknown>;
 export declare const useGetBillingPlan: (options: Omit<GetBillingPlanData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").BillingPlan | undefined, Error>;
@@ -170,3 +175,6 @@ export declare const useSetDefaultPaymentMethod: (config?: {
 export declare const useGetBillingUsage: (options: Omit<GetBillingUsageData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").BillingUsage | undefined, Error>;
+export declare const useFetchBillingPrices: (options: Omit<FetchBillingPricesData, "url"> & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").PlanPriceResponse[] | undefined, 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, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, updateGraphState, deployVersion, requestSignedUploadUrl, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage } from "../../sdk/sdk.gen";
+import { getServiceHealth, fetchGraphM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, updateGraphState, deployVersion, requestSignedUploadUrl, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices } from "../../sdk/sdk.gen";
 export const useGetServiceHealth = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -727,6 +727,25 @@ export const useRequestSignedUploadUrl = (options) => {
         staleTime: 600000
     });
 };
+export const useRecordCloudUsage = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/m2m/billing/usage/record" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await recordCloudUsage({ ...opts, ...options, auth });
+        return res?.data;
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: ["m2m", "billing", "usage", "record"] });
+            config?.onSuccess && config.onSuccess(res);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
 export const useGetBillingPlan = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -866,3 +885,24 @@ export const useGetBillingUsage = (options) => {
         staleTime: 600000
     });
 };
+export const useFetchBillingPrices = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/billing/prices" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await fetchBillingPrices({ ...opts, ...rest, auth });
+        return res.data;
+    };
+    if (!token)
+        enabled = false;
+    return useQuery({
+        queryKey: [options?.path?.spaceHandle, "billing", "prices", options.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false,
+        staleTime: 600000
+    });
+};

package/package.json

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