shoal-web-sdk 1.0.97 → 1.0.98

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

@@ -1,6 +1,6 @@
 import { type UseMutationOptions } from '@tanstack/react-query';
 import { type Options } from '../sdk.gen';
-import type { CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSubscriptionData, CreateSubscriptionError, DeletePaymentMethodData, DeletePaymentMethodError, DeletePaymentMethodResponse, GetCustomerData, GetInvoicesData, GetPlansData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodError, UpdateDefaultPaymentMethodResponse, UpdatePlanData, UpdatePlanError } from '../types.gen';
+import type { CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSubscriptionData, CreateSubscriptionError, DeletePaymentMethodData, DeletePaymentMethodError, DeletePaymentMethodResponse, GetCustomerData, GetInvoicesData, GetPlansData, GetUsageData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodError, UpdateDefaultPaymentMethodResponse, UpdatePlanData, UpdatePlanError } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -36,6 +36,34 @@ export declare const getCustomerOptions: (options: Options<GetCustomerData>) =>
         [dataTagErrorSymbol]: Error;
     };
 };
+export declare const getUsageQueryKey: (options: Options<GetUsageData>) => [Pick<Options<GetUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * Returns usage information for the current billing period.
+ */
+export declare const getUsageOptions: (options: Options<GetUsageData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").UsageInfoResponse, Error, import("../types.gen").UsageInfoResponse, [Pick<Options<GetUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").UsageInfoResponse, [Pick<Options<GetUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<GetUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").UsageInfoResponse;
+        [dataTagErrorSymbol]: Error;
+    };
+};
 export declare const getPlansQueryKey: (options?: Options<GetPlansData>) => [Pick<Options<GetPlansData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;

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

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { queryOptions } from '@tanstack/react-query';
 import { client } from '../client.gen';
-import { createSetupIntent, createSubscription, deletePaymentMethod, getCustomer, getInvoices, getPlans, m2mCreateCustomer, m2mGetCustomer, m2mUpdatePlan, updateDefaultPaymentMethod, updatePlan } from '../sdk.gen';
+import { createSetupIntent, createSubscription, deletePaymentMethod, getCustomer, getInvoices, getPlans, getUsage, m2mCreateCustomer, m2mGetCustomer, m2mUpdatePlan, updateDefaultPaymentMethod, updatePlan } from '../sdk.gen';
 const createQueryKey = (id, options, infinite, tags) => {
     const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
     if (infinite) {
@@ -44,6 +44,24 @@ export const getCustomerOptions = (options) => {
         queryKey: getCustomerQueryKey(options)
     });
 };
+export const getUsageQueryKey = (options) => createQueryKey('getUsage', options);
+/**
+ * Returns usage information for the current billing period.
+ */
+export const getUsageOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await getUsage({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: getUsageQueryKey(options)
+    });
+};
 export const getPlansQueryKey = (options) => createQueryKey('getPlans', options);
 /**
  * Returns a list of available pricing plans.

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

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSubscriptionData, CreateSubscriptionErrors, CreateSubscriptionResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, GetCustomerData, GetCustomerErrors, GetCustomerResponses, GetInvoicesData, GetInvoicesErrors, GetInvoicesResponses, GetPlansData, GetPlansErrors, GetPlansResponses, M2mCreateCustomerData, M2mCreateCustomerErrors, M2mCreateCustomerResponses, M2mGetCustomerData, M2mGetCustomerErrors, M2mGetCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanErrors, M2mUpdatePlanResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodErrors, UpdateDefaultPaymentMethodResponses, UpdatePlanData, UpdatePlanErrors, UpdatePlanResponses } from './types.gen';
+import type { CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSubscriptionData, CreateSubscriptionErrors, CreateSubscriptionResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, GetCustomerData, GetCustomerErrors, GetCustomerResponses, GetInvoicesData, GetInvoicesErrors, GetInvoicesResponses, GetPlansData, GetPlansErrors, GetPlansResponses, GetUsageData, GetUsageErrors, GetUsageResponses, M2mCreateCustomerData, M2mCreateCustomerErrors, M2mCreateCustomerResponses, M2mGetCustomerData, M2mGetCustomerErrors, M2mGetCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanErrors, M2mUpdatePlanResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodErrors, UpdateDefaultPaymentMethodResponses, UpdatePlanData, UpdatePlanErrors, UpdatePlanResponses } 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
@@ -17,6 +17,10 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
  * Fetch all related customer information for a given org.
  */
 export declare const getCustomer: <ThrowOnError extends boolean = false>(options: Options<GetCustomerData, ThrowOnError>) => import("./client").RequestResult<GetCustomerResponses, GetCustomerErrors, ThrowOnError, "fields">;
+/**
+ * Returns usage information for the current billing period.
+ */
+export declare const getUsage: <ThrowOnError extends boolean = false>(options: Options<GetUsageData, ThrowOnError>) => import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
 /**
  * Returns a list of available pricing plans.
  */

package/dist/sdk/billing/sdk.gen.js

@@ -15,6 +15,21 @@ export const getCustomer = (options) => {
         ...options
     });
 };
+/**
+ * Returns usage information for the current billing period.
+ */
+export const getUsage = (options) => {
+    return (options.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/api/v1/usage/{org}',
+        ...options
+    });
+};
 /**
  * Returns a list of available pricing plans.
  */

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

@@ -1,6 +1,7 @@
 export type ClientOptions = {
     baseUrl: 'http://localhost:8080/billing-service' | (string & {});
 };
+export type Currency = 'GBP' | 'USD';
 export type _Error = {
     error: string;
 };
@@ -44,7 +45,6 @@ export type PlanResponse = {
         githubOrganizationIntegration?: BooleanPlanFeatureResponse;
     };
     pricing?: PricesResponse;
-    categories?: CategoriesResponse;
     trial?: PlanTrialResponse;
     readonly isSelfServe: boolean;
     readonly isActive: boolean;
@@ -58,20 +58,6 @@ export type PlanPriceResponse = {
     readonly currency: string;
     readonly amount: number;
 };
-export type CategoriesResponse = {
-    default: CategoryResponse;
-};
-export type CategoryAllowanceResponse = {
-    readonly refreshAmount: number;
-    refreshPeriod: CategoryPeriodResponse;
-    readonly isActive: boolean;
-    readonly isCarryOver: boolean;
-};
-export type CategoryResponse = {
-    readonly displayName: string;
-    readonly displayDescription?: string;
-    allowance: CategoryAllowanceResponse;
-};
 export type PlanTrialResponse = {
     readonly lengthInDays: number;
     readonly startingBonusCents: number;
@@ -151,6 +137,28 @@ export type CustomerResponse = {
     readonly paymentMethods: Array<PaymentMethodSummary>;
     readonly upcomingInvoiceTotalCents?: number;
 };
+export type UsageInfoResponse = {
+    meters: Meters;
+    total: unknown;
+    from: string;
+    to: string;
+};
+export type MeterType = {
+    displayName: string;
+    total: unknown;
+    values: Array<unknown>;
+};
+export type Meters = {
+    computeVms: MeterType;
+    appHosting: MeterType;
+    databaseStorage: MeterType;
+    networkingSecurity: MeterType;
+    observability: MeterType;
+    platformServices: MeterType;
+    aiMlApis: MeterType;
+    marketplaceLicences: MeterType;
+    infraOverhead: MeterType;
+};
 export type CatalogResponseWritable = {
     [key: string]: unknown;
 };
@@ -184,20 +192,10 @@ export type PlanResponseWritable = {
         maximumEnvironments?: IntegerPlanFeatureResponseWritable;
         githubOrganizationIntegration?: BooleanPlanFeatureResponseWritable;
     };
-    categories?: CategoriesResponseWritable;
 };
 export type PricesResponseWritable = {
     [key: string]: unknown;
 };
-export type CategoriesResponseWritable = {
-    default: CategoryResponseWritable;
-};
-export type CategoryAllowanceResponseWritable = {
-    [key: string]: unknown;
-};
-export type CategoryResponseWritable = {
-    allowance: CategoryAllowanceResponseWritable;
-};
 export type CustomerPlanResponseWritable = {
     interval?: BillingInterval;
 };
@@ -214,6 +212,10 @@ export type PaymentMethodId = string;
  * Kinde organisation id.
  */
 export type OrganisationId = string;
+/**
+ * A valid currency.
+ */
+export type Currency2 = Currency;
 export type GetCustomerData = {
     body?: never;
     path: {
@@ -247,6 +249,44 @@ export type GetCustomerResponses = {
     200: CustomerResponse;
 };
 export type GetCustomerResponse = GetCustomerResponses[keyof GetCustomerResponses];
+export type GetUsageData = {
+    body?: never;
+    path: {
+        /**
+         * Kinde organisation id.
+         */
+        org: string;
+    };
+    query: {
+        /**
+         * A valid currency.
+         */
+        currency: Currency;
+    };
+    url: '/api/v1/usage/{org}';
+};
+export type GetUsageErrors = {
+    /**
+     * Invalid currency
+     */
+    400: _Error;
+    /**
+     * Unauthorised user
+     */
+    401: _Error;
+    /**
+     * Internal error
+     */
+    500: _Error;
+};
+export type GetUsageError = GetUsageErrors[keyof GetUsageErrors];
+export type GetUsageResponses = {
+    /**
+     * Usage
+     */
+    200: UsageInfoResponse;
+};
+export type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];
 export type GetPlansData = {
     body?: never;
     path?: never;

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

@@ -1,4 +1,8 @@
 import { z } from 'zod';
+export declare const zCurrency: z.ZodEnum<{
+    GBP: "GBP";
+    USD: "USD";
+}>;
 export declare const zError: z.ZodObject<{
     error: z.ZodString;
 }, z.core.$strip>;
@@ -103,59 +107,6 @@ export declare const zBooleanPlanFeatureResponse: z.ZodUnion<readonly [z.ZodInte
         disabled: "disabled";
     }>;
 }, z.core.$strip>>>]>;
-export declare const zCategoryPeriodResponse: z.ZodEnum<{
-    day: "day";
-    week: "week";
-    month: "month";
-    year: "year";
-    onetime: "onetime";
-}>;
-export declare const zCategoryAllowanceResponse: z.ZodObject<{
-    refreshAmount: z.ZodReadonly<z.ZodInt>;
-    refreshPeriod: z.ZodEnum<{
-        day: "day";
-        week: "week";
-        month: "month";
-        year: "year";
-        onetime: "onetime";
-    }>;
-    isActive: z.ZodReadonly<z.ZodBoolean>;
-    isCarryOver: z.ZodReadonly<z.ZodBoolean>;
-}, z.core.$strip>;
-export declare const zCategoryResponse: z.ZodObject<{
-    displayName: z.ZodReadonly<z.ZodString>;
-    displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-    allowance: z.ZodObject<{
-        refreshAmount: z.ZodReadonly<z.ZodInt>;
-        refreshPeriod: z.ZodEnum<{
-            day: "day";
-            week: "week";
-            month: "month";
-            year: "year";
-            onetime: "onetime";
-        }>;
-        isActive: z.ZodReadonly<z.ZodBoolean>;
-        isCarryOver: z.ZodReadonly<z.ZodBoolean>;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-export declare const zCategoriesResponse: z.ZodObject<{
-    default: z.ZodObject<{
-        displayName: z.ZodReadonly<z.ZodString>;
-        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-        allowance: z.ZodObject<{
-            refreshAmount: z.ZodReadonly<z.ZodInt>;
-            refreshPeriod: z.ZodEnum<{
-                day: "day";
-                week: "week";
-                month: "month";
-                year: "year";
-                onetime: "onetime";
-            }>;
-            isActive: z.ZodReadonly<z.ZodBoolean>;
-            isCarryOver: z.ZodReadonly<z.ZodBoolean>;
-        }, z.core.$strip>;
-    }, z.core.$strip>;
-}, z.core.$strip>;
 export declare const zPlanResponse: z.ZodObject<{
     key: z.ZodReadonly<z.ZodString>;
     rank: z.ZodReadonly<z.ZodInt>;
@@ -252,24 +203,6 @@ export declare const zPlanResponse: z.ZodObject<{
             amount: z.ZodReadonly<z.ZodInt>;
         }, z.core.$strip>;
     }, z.core.$strip>>;
-    categories: z.ZodOptional<z.ZodObject<{
-        default: z.ZodObject<{
-            displayName: z.ZodReadonly<z.ZodString>;
-            displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-            allowance: z.ZodObject<{
-                refreshAmount: z.ZodReadonly<z.ZodInt>;
-                refreshPeriod: z.ZodEnum<{
-                    day: "day";
-                    week: "week";
-                    month: "month";
-                    year: "year";
-                    onetime: "onetime";
-                }>;
-                isActive: z.ZodReadonly<z.ZodBoolean>;
-                isCarryOver: z.ZodReadonly<z.ZodBoolean>;
-            }, z.core.$strip>;
-        }, z.core.$strip>;
-    }, z.core.$strip>>;
     trial: z.ZodOptional<z.ZodObject<{
         lengthInDays: z.ZodReadonly<z.ZodInt>;
         startingBonusCents: z.ZodReadonly<z.ZodInt>;
@@ -376,24 +309,6 @@ export declare const zCatalogResponse: z.ZodObject<{
                 amount: z.ZodReadonly<z.ZodInt>;
             }, z.core.$strip>;
         }, z.core.$strip>>;
-        categories: z.ZodOptional<z.ZodObject<{
-            default: z.ZodObject<{
-                displayName: z.ZodReadonly<z.ZodString>;
-                displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-                allowance: z.ZodObject<{
-                    refreshAmount: z.ZodReadonly<z.ZodInt>;
-                    refreshPeriod: z.ZodEnum<{
-                        day: "day";
-                        week: "week";
-                        month: "month";
-                        year: "year";
-                        onetime: "onetime";
-                    }>;
-                    isActive: z.ZodReadonly<z.ZodBoolean>;
-                    isCarryOver: z.ZodReadonly<z.ZodBoolean>;
-                }, z.core.$strip>;
-            }, z.core.$strip>;
-        }, z.core.$strip>>;
         trial: z.ZodOptional<z.ZodObject<{
             lengthInDays: z.ZodReadonly<z.ZodInt>;
             startingBonusCents: z.ZodReadonly<z.ZodInt>;
@@ -404,6 +319,13 @@ export declare const zCatalogResponse: z.ZodObject<{
         isVisible: z.ZodReadonly<z.ZodBoolean>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
+export declare const zCategoryPeriodResponse: z.ZodEnum<{
+    day: "day";
+    week: "week";
+    month: "month";
+    year: "year";
+    onetime: "onetime";
+}>;
 export declare const zBillingInterval: z.ZodEnum<{
     monthly: "monthly";
     annual: "annual";
@@ -787,6 +709,110 @@ export declare const zCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
 }, z.core.$strip>;
+export declare const zMeterType: z.ZodObject<{
+    displayName: z.ZodString;
+    total: z.ZodUnknown;
+    values: z.ZodArray<z.ZodUnknown>;
+}, z.core.$strip>;
+export declare const zMeters: z.ZodObject<{
+    computeVms: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    appHosting: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    databaseStorage: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    networkingSecurity: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    observability: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    platformServices: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    aiMlApis: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    marketplaceLicences: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+    infraOverhead: z.ZodObject<{
+        displayName: z.ZodString;
+        total: z.ZodUnknown;
+        values: z.ZodArray<z.ZodUnknown>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const zUsageInfoResponse: z.ZodObject<{
+    meters: z.ZodObject<{
+        computeVms: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        appHosting: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        databaseStorage: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        networkingSecurity: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        observability: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        platformServices: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        aiMlApis: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        marketplaceLicences: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        infraOverhead: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    total: z.ZodUnknown;
+    from: z.ZodISODateTime;
+    to: z.ZodISODateTime;
+}, z.core.$strip>;
 export declare const zCatalogResponseWritable: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 export declare const zLimitedIntegerPlanFeatureResponseWritable: z.ZodObject<{
     type: z.ZodEnum<{
@@ -836,16 +862,6 @@ export declare const zBooleanPlanFeatureResponseWritable: z.ZodUnion<readonly [z
         disabled: "disabled";
     }>;
 }, z.core.$strip>>]>;
-export declare const zPricesResponseWritable: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-export declare const zCategoryAllowanceResponseWritable: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-export declare const zCategoryResponseWritable: z.ZodObject<{
-    allowance: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, z.core.$strip>;
-export declare const zCategoriesResponseWritable: z.ZodObject<{
-    default: z.ZodObject<{
-        allowance: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-    }, z.core.$strip>;
-}, z.core.$strip>;
 export declare const zPlanResponseWritable: z.ZodObject<{
     features: z.ZodObject<{
         maximumSeats: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
@@ -904,12 +920,8 @@ export declare const zPlanResponseWritable: z.ZodObject<{
             }>;
         }, z.core.$strip>>]>>;
     }, z.core.$strip>;
-    categories: z.ZodOptional<z.ZodObject<{
-        default: z.ZodObject<{
-            allowance: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-        }, z.core.$strip>;
-    }, z.core.$strip>>;
 }, z.core.$strip>;
+export declare const zPricesResponseWritable: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 export declare const zCustomerPlanResponseWritable: z.ZodObject<{
     interval: z.ZodOptional<z.ZodEnum<{
         monthly: "monthly";
@@ -944,6 +956,13 @@ export declare const zPaymentMethodId: z.ZodString;
  * Kinde organisation id.
  */
 export declare const zOrganisationId: z.ZodString;
+/**
+ * A valid currency.
+ */
+export declare const zCurrency2: z.ZodEnum<{
+    GBP: "GBP";
+    USD: "USD";
+}>;
 export declare const zGetCustomerData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{
@@ -1166,6 +1185,73 @@ export declare const zGetCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
 }, z.core.$strip>;
+export declare const zGetUsageData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodObject<{
+        org: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodObject<{
+        currency: z.ZodEnum<{
+            GBP: "GBP";
+            USD: "USD";
+        }>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Usage
+ */
+export declare const zGetUsageResponse: z.ZodObject<{
+    meters: z.ZodObject<{
+        computeVms: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        appHosting: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        databaseStorage: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        networkingSecurity: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        observability: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        platformServices: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        aiMlApis: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        marketplaceLicences: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+        infraOverhead: z.ZodObject<{
+            displayName: z.ZodString;
+            total: z.ZodUnknown;
+            values: z.ZodArray<z.ZodUnknown>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    total: z.ZodUnknown;
+    from: z.ZodISODateTime;
+    to: z.ZodISODateTime;
+}, z.core.$strip>;
 export declare const zGetPlansData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodOptional<z.ZodNever>;
@@ -1271,24 +1357,6 @@ export declare const zGetPlansResponse: z.ZodObject<{
                 amount: z.ZodReadonly<z.ZodInt>;
             }, z.core.$strip>;
         }, z.core.$strip>>;
-        categories: z.ZodOptional<z.ZodObject<{
-            default: z.ZodObject<{
-                displayName: z.ZodReadonly<z.ZodString>;
-                displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-                allowance: z.ZodObject<{
-                    refreshAmount: z.ZodReadonly<z.ZodInt>;
-                    refreshPeriod: z.ZodEnum<{
-                        day: "day";
-                        week: "week";
-                        month: "month";
-                        year: "year";
-                        onetime: "onetime";
-                    }>;
-                    isActive: z.ZodReadonly<z.ZodBoolean>;
-                    isCarryOver: z.ZodReadonly<z.ZodBoolean>;
-                }, z.core.$strip>;
-            }, z.core.$strip>;
-        }, z.core.$strip>>;
         trial: z.ZodOptional<z.ZodObject<{
             lengthInDays: z.ZodReadonly<z.ZodInt>;
             startingBonusCents: z.ZodReadonly<z.ZodInt>;

package/dist/sdk/billing/zod.gen.js

@@ -1,5 +1,9 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { z } from 'zod';
+export const zCurrency = z.enum([
+    'GBP',
+    'USD'
+]);
 export const zError = z.object({
     error: z.string()
 });
@@ -59,27 +63,6 @@ export const zBooleanPlanFeatureResponse = z.union([
         type: z.literal('disabled')
     }).and(zDisabledBooleanPlanFeatureResponse)
 ]);
-export const zCategoryPeriodResponse = z.enum([
-    'day',
-    'week',
-    'month',
-    'year',
-    'onetime'
-]);
-export const zCategoryAllowanceResponse = z.object({
-    refreshAmount: z.int().readonly(),
-    refreshPeriod: zCategoryPeriodResponse,
-    isActive: z.boolean().readonly(),
-    isCarryOver: z.boolean().readonly()
-});
-export const zCategoryResponse = z.object({
-    displayName: z.string().readonly(),
-    displayDescription: z.optional(z.string().readonly()),
-    allowance: zCategoryAllowanceResponse
-});
-export const zCategoriesResponse = z.object({
-    default: zCategoryResponse
-});
 export const zPlanResponse = z.object({
     key: z.string().readonly(),
     rank: z.int().readonly(),
@@ -92,7 +75,6 @@ export const zPlanResponse = z.object({
         githubOrganizationIntegration: z.optional(zBooleanPlanFeatureResponse)
     }),
     pricing: z.optional(zPricesResponse),
-    categories: z.optional(zCategoriesResponse),
     trial: z.optional(zPlanTrialResponse),
     isSelfServe: z.boolean().readonly(),
     isActive: z.boolean().readonly(),
@@ -101,6 +83,13 @@ export const zPlanResponse = z.object({
 export const zCatalogResponse = z.object({
     plans: z.array(zPlanResponse).readonly()
 });
+export const zCategoryPeriodResponse = z.enum([
+    'day',
+    'week',
+    'month',
+    'year',
+    'onetime'
+]);
 export const zBillingInterval = z.enum([
     'monthly',
     'annual'
@@ -183,6 +172,28 @@ export const zCustomerResponse = z.object({
     paymentMethods: z.array(zPaymentMethodSummary).readonly(),
     upcomingInvoiceTotalCents: z.optional(z.int().readonly())
 });
+export const zMeterType = z.object({
+    displayName: z.string(),
+    total: z.unknown(),
+    values: z.array(z.unknown())
+});
+export const zMeters = z.object({
+    computeVms: zMeterType,
+    appHosting: zMeterType,
+    databaseStorage: zMeterType,
+    networkingSecurity: zMeterType,
+    observability: zMeterType,
+    platformServices: zMeterType,
+    aiMlApis: zMeterType,
+    marketplaceLicences: zMeterType,
+    infraOverhead: zMeterType
+});
+export const zUsageInfoResponse = z.object({
+    meters: zMeters,
+    total: z.unknown(),
+    from: z.iso.datetime(),
+    to: z.iso.datetime()
+});
 export const zCatalogResponseWritable = z.record(z.string(), z.unknown());
 export const zLimitedIntegerPlanFeatureResponseWritable = z.object({
     type: z.enum([
@@ -217,23 +228,15 @@ export const zBooleanPlanFeatureResponseWritable = z.union([
         type: z.literal('DisabledBooleanPlanFeatureResponseWritable')
     }).and(zDisabledBooleanPlanFeatureResponseWritable)
 ]);
-export const zPricesResponseWritable = z.record(z.string(), z.unknown());
-export const zCategoryAllowanceResponseWritable = z.record(z.string(), z.unknown());
-export const zCategoryResponseWritable = z.object({
-    allowance: zCategoryAllowanceResponseWritable
-});
-export const zCategoriesResponseWritable = z.object({
-    default: zCategoryResponseWritable
-});
 export const zPlanResponseWritable = z.object({
     features: z.object({
         maximumSeats: z.optional(zIntegerPlanFeatureResponseWritable),
         maximumProjects: z.optional(zIntegerPlanFeatureResponseWritable),
         maximumEnvironments: z.optional(zIntegerPlanFeatureResponseWritable),
         githubOrganizationIntegration: z.optional(zBooleanPlanFeatureResponseWritable)
-    }),
-    categories: z.optional(zCategoriesResponseWritable)
+    })
 });
+export const zPricesResponseWritable = z.record(z.string(), z.unknown());
 export const zCustomerPlanResponseWritable = z.object({
     interval: z.optional(zBillingInterval)
 });
@@ -250,6 +253,10 @@ export const zPaymentMethodId = z.string();
  * Kinde organisation id.
  */
 export const zOrganisationId = z.string();
+/**
+ * A valid currency.
+ */
+export const zCurrency2 = zCurrency;
 export const zGetCustomerData = z.object({
     body: z.optional(z.never()),
     path: z.object({
@@ -261,6 +268,19 @@ export const zGetCustomerData = z.object({
  * Customer billing state
  */
 export const zGetCustomerResponse = zCustomerResponse;
+export const zGetUsageData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        org: z.string()
+    }),
+    query: z.object({
+        currency: zCurrency
+    })
+});
+/**
+ * Usage
+ */
+export const zGetUsageResponse = zUsageInfoResponse;
 export const zGetPlansData = z.object({
     body: z.optional(z.never()),
     path: z.optional(z.never()),

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

@@ -1,6 +1,6 @@
 import { useMutation } from "@tanstack/react-query";
 import { GetSuccessResponse } from "../util";
-import { GetCustomerData, GetPlansData, UpdatePlanData, UpdatePlanResponses, CreateSubscriptionData, CreateSubscriptionResponses, CreateSetupIntentData, CreateSetupIntentResponses, DeletePaymentMethodData, DeletePaymentMethodResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodResponses, GetInvoicesData, M2mGetCustomerData, M2mCreateCustomerData, M2mCreateCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanResponses } from "../../sdk/billing/types.gen";
+import { GetCustomerData, GetUsageData, GetPlansData, UpdatePlanData, UpdatePlanResponses, CreateSubscriptionData, CreateSubscriptionResponses, CreateSetupIntentData, CreateSetupIntentResponses, DeletePaymentMethodData, DeletePaymentMethodResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodResponses, GetInvoicesData, M2mGetCustomerData, M2mCreateCustomerData, M2mCreateCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanResponses } from "../../sdk/billing/types.gen";
 export declare const useGetCustomer: (options: Omit<GetCustomerData, "url"> & {
     enabled?: boolean;
 }) => {
@@ -208,6 +208,213 @@ export declare const useGetCustomer: (options: Omit<GetCustomerData, "url"> & {
         headers: Record<string, string>;
     } | undefined>;
 };
+export declare const useGetUsage: (options: Omit<GetUsageData, "url"> & {
+    enabled?: boolean;
+}) => {
+    data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+    headers: Record<string, string> | undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+    headers: Record<string, string> | undefined;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+    headers: Record<string, string> | undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+    headers: Record<string, string> | undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+    headers: Record<string, string> | undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+} | {
+    data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+    headers: Record<string, string> | undefined;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    promise: Promise<{
+        data: import("../../sdk/billing/types.gen").UsageInfoResponse | undefined;
+        headers: Record<string, string>;
+    } | undefined>;
+};
 export declare const useGetPlans: (options?: Omit<GetPlansData, "url"> & {
     enabled?: boolean;
 }) => {

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

@@ -2,7 +2,7 @@
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import { isPromise, headersToObject } from "../util";
 import { useToken } from "../../provider/token-provider";
-import { getCustomer, getPlans, updatePlan, createSubscription, createSetupIntent, deletePaymentMethod, updateDefaultPaymentMethod, getInvoices, m2mGetCustomer, m2mCreateCustomer, m2mUpdatePlan } from "../../sdk/billing/sdk.gen";
+import { getCustomer, getUsage, getPlans, updatePlan, createSubscription, createSetupIntent, deletePaymentMethod, updateDefaultPaymentMethod, getInvoices, m2mGetCustomer, m2mCreateCustomer, m2mUpdatePlan } from "../../sdk/billing/sdk.gen";
 export const useGetCustomer = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -25,6 +25,28 @@ export const useGetCustomer = (options) => {
     });
     return { ...query, data: query.data?.data, headers: query.data?.headers };
 };
+export const useGetUsage = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/api/v1/usage/{org}" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await getUsage({ ...opts, ...rest, auth });
+        return { data: res.data, headers: headersToObject(res.response.headers) };
+    };
+    if (!token)
+        enabled = false;
+    const query = useQuery({
+        queryKey: ["api", "v1", "usage", options?.path?.org, options.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false,
+        staleTime: 600000
+    });
+    return { ...query, data: query.data?.data, headers: query.data?.headers };
+};
 export const useGetPlans = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };

package/package.json

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