shoal-web-sdk 1.0.105 → 1.0.107

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -42,7 +42,7 @@ export declare const getUsageQueryKey: (options: Options<GetUsageData>) => [Pick
42
42
  tags?: ReadonlyArray<string>;
43
43
  }];
44
44
  /**
45
- * Returns usage information for the current billing period.
45
+ * Returns usage information for the current billing period, or for an explicit past window.
46
46
  */
47
47
  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"> & {
48
48
  _id: string;
@@ -46,7 +46,7 @@ export const getCustomerOptions = (options) => {
46
46
  };
47
47
  export const getUsageQueryKey = (options) => createQueryKey('getUsage', options);
48
48
  /**
49
- * Returns usage information for the current billing period.
49
+ * Returns usage information for the current billing period, or for an explicit past window.
50
50
  */
51
51
  export const getUsageOptions = (options) => {
52
52
  return queryOptions({
@@ -18,7 +18,7 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
18
18
  */
19
19
  export declare const getCustomer: <ThrowOnError extends boolean = false>(options: Options<GetCustomerData, ThrowOnError>) => import("./client").RequestResult<GetCustomerResponses, GetCustomerErrors, ThrowOnError, "fields">;
20
20
  /**
21
- * Returns usage information for the current billing period.
21
+ * Returns usage information for the current billing period, or for an explicit past window.
22
22
  */
23
23
  export declare const getUsage: <ThrowOnError extends boolean = false>(options: Options<GetUsageData, ThrowOnError>) => import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
24
24
  /**
@@ -16,7 +16,7 @@ export const getCustomer = (options) => {
16
16
  });
17
17
  };
18
18
  /**
19
- * Returns usage information for the current billing period.
19
+ * Returns usage information for the current billing period, or for an explicit past window.
20
20
  */
21
21
  export const getUsage = (options) => {
22
22
  return (options.client ?? client).get({
@@ -39,18 +39,20 @@ export type DisabledBooleanPlanFeatureResponse = PlanFeatureResponse & {
39
39
  type: DisabledBooleanPlanFeatureType;
40
40
  };
41
41
  export type Features = {
42
- maximumSeats?: IntegerPlanFeatureResponse;
43
- maximumProjects?: IntegerPlanFeatureResponse;
44
- maximumEnvironments?: IntegerPlanFeatureResponse;
45
- githubOrganizationIntegration?: BooleanPlanFeatureResponse;
46
- shoalAISupport?: BooleanPlanFeatureResponse;
47
- maximumContainerNodes?: IntegerPlanFeatureResponse;
48
- maximumFunctionNodes?: IntegerPlanFeatureResponse;
49
- maximumGatewayNodes?: IntegerPlanFeatureResponse;
50
- maximumCloudSQLNodes?: IntegerPlanFeatureResponse;
51
- maximumSchedulerNodes?: IntegerPlanFeatureResponse;
52
- maximumVMNodes?: IntegerPlanFeatureResponse;
53
- maximumQueueNodes?: IntegerPlanFeatureResponse;
42
+ maximumSeats: IntegerPlanFeatureResponse;
43
+ maximumProjects: IntegerPlanFeatureResponse;
44
+ maximumEnvironments: IntegerPlanFeatureResponse;
45
+ githubOrganizationIntegration: BooleanPlanFeatureResponse;
46
+ shoalAISupport: BooleanPlanFeatureResponse;
47
+ maximumNeonDBNodes: IntegerPlanFeatureResponse;
48
+ maximumMongoDBNodes: IntegerPlanFeatureResponse;
49
+ maximumContainerNodes: IntegerPlanFeatureResponse;
50
+ maximumFunctionNodes: IntegerPlanFeatureResponse;
51
+ maximumGatewayNodes: IntegerPlanFeatureResponse;
52
+ maximumCloudSQLNodes: IntegerPlanFeatureResponse;
53
+ maximumSchedulerNodes: IntegerPlanFeatureResponse;
54
+ maximumVMNodes: IntegerPlanFeatureResponse;
55
+ maximumQueueNodes: IntegerPlanFeatureResponse;
54
56
  };
55
57
  export type PlanResponse = {
56
58
  key: string;
@@ -152,10 +154,14 @@ export type UsageInfoResponse = {
152
154
  from: string;
153
155
  to: string;
154
156
  };
157
+ export type UsagePoint = {
158
+ date: string;
159
+ amount: unknown;
160
+ };
155
161
  export type MeterType = {
156
162
  displayName: string;
157
163
  total: unknown;
158
- values: Array<unknown>;
164
+ points: Array<UsagePoint>;
159
165
  };
160
166
  export type Meters = {
161
167
  computeVms: MeterType;
@@ -198,18 +204,20 @@ export type DisabledBooleanPlanFeatureResponseWritable = {
198
204
  type: DisabledBooleanPlanFeatureType;
199
205
  };
200
206
  export type FeaturesWritable = {
201
- maximumSeats?: IntegerPlanFeatureResponseWritable;
202
- maximumProjects?: IntegerPlanFeatureResponseWritable;
203
- maximumEnvironments?: IntegerPlanFeatureResponseWritable;
204
- githubOrganizationIntegration?: BooleanPlanFeatureResponseWritable;
205
- shoalAISupport?: BooleanPlanFeatureResponseWritable;
206
- maximumContainerNodes?: IntegerPlanFeatureResponseWritable;
207
- maximumFunctionNodes?: IntegerPlanFeatureResponseWritable;
208
- maximumGatewayNodes?: IntegerPlanFeatureResponseWritable;
209
- maximumCloudSQLNodes?: IntegerPlanFeatureResponseWritable;
210
- maximumSchedulerNodes?: IntegerPlanFeatureResponseWritable;
211
- maximumVMNodes?: IntegerPlanFeatureResponseWritable;
212
- maximumQueueNodes?: IntegerPlanFeatureResponseWritable;
207
+ maximumSeats: IntegerPlanFeatureResponseWritable;
208
+ maximumProjects: IntegerPlanFeatureResponseWritable;
209
+ maximumEnvironments: IntegerPlanFeatureResponseWritable;
210
+ githubOrganizationIntegration: BooleanPlanFeatureResponseWritable;
211
+ shoalAISupport: BooleanPlanFeatureResponseWritable;
212
+ maximumNeonDBNodes: IntegerPlanFeatureResponseWritable;
213
+ maximumMongoDBNodes: IntegerPlanFeatureResponseWritable;
214
+ maximumContainerNodes: IntegerPlanFeatureResponseWritable;
215
+ maximumFunctionNodes: IntegerPlanFeatureResponseWritable;
216
+ maximumGatewayNodes: IntegerPlanFeatureResponseWritable;
217
+ maximumCloudSQLNodes: IntegerPlanFeatureResponseWritable;
218
+ maximumSchedulerNodes: IntegerPlanFeatureResponseWritable;
219
+ maximumVMNodes: IntegerPlanFeatureResponseWritable;
220
+ maximumQueueNodes: IntegerPlanFeatureResponseWritable;
213
221
  };
214
222
  export type PlanResponseWritable = {
215
223
  key: string;
@@ -239,6 +247,14 @@ export type OrganisationId = string;
239
247
  * A valid currency.
240
248
  */
241
249
  export type Currency2 = Currency;
250
+ /**
251
+ * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
252
+ */
253
+ export type UsageFrom = string;
254
+ /**
255
+ * End of the usage window. Defaults to now. Must not be in the future.
256
+ */
257
+ export type UsageTo = string;
242
258
  export type GetCustomerData = {
243
259
  body?: never;
244
260
  path: {
@@ -285,12 +301,20 @@ export type GetUsageData = {
285
301
  * A valid currency.
286
302
  */
287
303
  currency: Currency;
304
+ /**
305
+ * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
306
+ */
307
+ from?: string;
308
+ /**
309
+ * End of the usage window. Defaults to now. Must not be in the future.
310
+ */
311
+ to?: string;
288
312
  };
289
313
  url: '/api/v1/usage/{org}';
290
314
  };
291
315
  export type GetUsageErrors = {
292
316
  /**
293
- * Invalid currency
317
+ * Invalid currency or usage window
294
318
  */
295
319
  400: _Error;
296
320
  /**