shoal-web-sdk 1.0.106 → 1.0.107

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

@@ -42,7 +42,7 @@ export declare const getUsageQueryKey: (options: Options<GetUsageData>) => [Pick
     tags?: ReadonlyArray<string>;
 }];
 /**
- * Returns usage information for the current billing period.
+ * Returns usage information for the current billing period, or for an explicit past window.
  */
 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;

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

@@ -46,7 +46,7 @@ export const getCustomerOptions = (options) => {
 };
 export const getUsageQueryKey = (options) => createQueryKey('getUsage', options);
 /**
- * Returns usage information for the current billing period.
+ * Returns usage information for the current billing period, or for an explicit past window.
  */
 export const getUsageOptions = (options) => {
     return queryOptions({

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

@@ -18,7 +18,7 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
  */
 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.
+ * Returns usage information for the current billing period, or for an explicit past window.
  */
 export declare const getUsage: <ThrowOnError extends boolean = false>(options: Options<GetUsageData, ThrowOnError>) => import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
 /**

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

@@ -16,7 +16,7 @@ export const getCustomer = (options) => {
     });
 };
 /**
- * Returns usage information for the current billing period.
+ * Returns usage information for the current billing period, or for an explicit past window.
  */
 export const getUsage = (options) => {
     return (options.client ?? client).get({

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

@@ -154,10 +154,14 @@ export type UsageInfoResponse = {
     from: string;
     to: string;
 };
+export type UsagePoint = {
+    date: string;
+    amount: unknown;
+};
 export type MeterType = {
     displayName: string;
     total: unknown;
-    values: Array<unknown>;
+    points: Array<UsagePoint>;
 };
 export type Meters = {
     computeVms: MeterType;
@@ -243,6 +247,14 @@ export type OrganisationId = string;
  * A valid currency.
  */
 export type Currency2 = Currency;
+/**
+ * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
+ */
+export type UsageFrom = string;
+/**
+ * End of the usage window. Defaults to now. Must not be in the future.
+ */
+export type UsageTo = string;
 export type GetCustomerData = {
     body?: never;
     path: {
@@ -289,12 +301,20 @@ export type GetUsageData = {
          * A valid currency.
          */
         currency: Currency;
+        /**
+         * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
+         */
+        from?: string;
+        /**
+         * End of the usage window. Defaults to now. Must not be in the future.
+         */
+        to?: string;
     };
     url: '/api/v1/usage/{org}';
 };
 export type GetUsageErrors = {
     /**
-     * Invalid currency
+     * Invalid currency or usage window
      */
     400: _Error;
     /**

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

@@ -2902,56 +2902,90 @@ export declare const zCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
 }, z.core.$strip>;
+export declare const zUsagePoint: z.ZodObject<{
+    date: z.ZodISODateTime;
+    amount: z.ZodUnknown;
+}, z.core.$strip>;
 export declare const zMeterType: z.ZodObject<{
     displayName: z.ZodString;
     total: z.ZodUnknown;
-    values: z.ZodArray<z.ZodUnknown>;
+    points: z.ZodArray<z.ZodObject<{
+        date: z.ZodISODateTime;
+        amount: z.ZodUnknown;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const zMeters: z.ZodObject<{
     computeVms: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     appHosting: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     databaseStorage: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     networkingSecurity: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     observability: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     platformServices: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     aiMlApis: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     marketplaceLicences: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     infraOverhead: z.ZodObject<{
         displayName: z.ZodString;
         total: z.ZodUnknown;
-        values: z.ZodArray<z.ZodUnknown>;
+        points: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODateTime;
+            amount: z.ZodUnknown;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const zUsageInfoResponse: z.ZodObject<{
@@ -2959,47 +2993,74 @@ export declare const zUsageInfoResponse: z.ZodObject<{
         computeVms: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         appHosting: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         databaseStorage: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         networkingSecurity: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         observability: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         platformServices: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         aiMlApis: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         marketplaceLicences: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         infraOverhead: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
     }, z.core.$strip>;
     total: z.ZodUnknown;
@@ -4681,6 +4742,14 @@ export declare const zCurrency2: z.ZodEnum<{
     GBP: "GBP";
     USD: "USD";
 }>;
+/**
+ * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
+ */
+export declare const zUsageFrom: z.ZodISODateTime;
+/**
+ * End of the usage window. Defaults to now. Must not be in the future.
+ */
+export declare const zUsageTo: z.ZodISODateTime;
 export declare const zGetCustomerData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{
@@ -5311,6 +5380,8 @@ export declare const zGetUsageData: z.ZodObject<{
             GBP: "GBP";
             USD: "USD";
         }>;
+        from: z.ZodOptional<z.ZodISODateTime>;
+        to: z.ZodOptional<z.ZodISODateTime>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 /**
@@ -5321,47 +5392,74 @@ export declare const zGetUsageResponse: z.ZodObject<{
         computeVms: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         appHosting: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         databaseStorage: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         networkingSecurity: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         observability: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         platformServices: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         aiMlApis: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         marketplaceLicences: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         infraOverhead: z.ZodObject<{
             displayName: z.ZodString;
             total: z.ZodUnknown;
-            values: z.ZodArray<z.ZodUnknown>;
+            points: z.ZodArray<z.ZodObject<{
+                date: z.ZodISODateTime;
+                amount: z.ZodUnknown;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
     }, z.core.$strip>;
     total: z.ZodUnknown;

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

@@ -183,10 +183,14 @@ export const zCustomerResponse = z.object({
     paymentMethods: z.array(zPaymentMethodSummary).readonly(),
     upcomingInvoiceTotalCents: z.optional(z.int().readonly())
 });
+export const zUsagePoint = z.object({
+    date: z.iso.datetime(),
+    amount: z.unknown()
+});
 export const zMeterType = z.object({
     displayName: z.string(),
     total: z.unknown(),
-    values: z.array(z.unknown())
+    points: z.array(zUsagePoint)
 });
 export const zMeters = z.object({
     computeVms: zMeterType,
@@ -282,6 +286,14 @@ export const zOrganisationId = z.string();
  * A valid currency.
  */
 export const zCurrency2 = zCurrency;
+/**
+ * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
+ */
+export const zUsageFrom = z.iso.datetime();
+/**
+ * End of the usage window. Defaults to now. Must not be in the future.
+ */
+export const zUsageTo = z.iso.datetime();
 export const zGetCustomerData = z.object({
     body: z.optional(z.never()),
     path: z.object({
@@ -299,7 +311,9 @@ export const zGetUsageData = z.object({
         org: z.string()
     }),
     query: z.object({
-        currency: zCurrency
+        currency: zCurrency,
+        from: z.optional(z.iso.datetime()),
+        to: z.optional(z.iso.datetime())
     })
 });
 /**

package/package.json

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