shoal-web-sdk 1.0.93 → 1.0.94

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

@@ -44,7 +44,7 @@ export type PlanResponse = {
         githubOrganizationIntegration?: BooleanPlanFeatureResponse;
     };
     pricing?: PricesResponse;
-    allowances: AllowancesResponse;
+    categories?: CategoriesResponse;
     trial?: PlanTrialResponse;
     readonly isSelfServe: boolean;
     readonly isActive: boolean;
@@ -58,17 +58,20 @@ export type PlanPriceResponse = {
     readonly currency: string;
     readonly amount: number;
 };
-export type AllowancesResponse = {
-    default: AllowanceResponse;
+export type CategoriesResponse = {
+    default: CategoryResponse;
 };
-export type AllowanceResponse = {
-    readonly displayName: string;
-    readonly displayDescription?: string;
+export type CategoryAllowanceResponse = {
     readonly refreshAmount: number;
-    refreshPeriod: AllowancePeriodResponse;
+    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;
@@ -78,7 +81,7 @@ export type PlanFeatureResponse = {
     readonly displayDescription?: string;
     readonly displayName: string;
 };
-export type AllowancePeriodResponse = 'day' | 'week' | 'month' | 'year' | 'onetime';
+export type CategoryPeriodResponse = 'day' | 'week' | 'month' | 'year' | 'onetime';
 export type BillingInterval = 'monthly' | 'annual';
 export type UpdatePlan = {
     plan: string;
@@ -112,6 +115,7 @@ export type InvoiceListResponse = {
 export type CustomerPlanResponse = {
     readonly key: string;
     readonly displayName: string;
+    readonly displayDescription?: string;
     readonly rank: number;
     interval?: BillingInterval;
     readonly currency?: string;
@@ -176,17 +180,20 @@ export type PlanResponseWritable = {
         maximumEnvironments?: IntegerPlanFeatureResponseWritable;
         githubOrganizationIntegration?: BooleanPlanFeatureResponseWritable;
     };
-    allowances: AllowancesResponseWritable;
+    categories?: CategoriesResponseWritable;
 };
 export type PricesResponseWritable = {
     [key: string]: unknown;
 };
-export type AllowancesResponseWritable = {
-    default: AllowanceResponseWritable;
+export type CategoriesResponseWritable = {
+    default: CategoryResponseWritable;
 };
-export type AllowanceResponseWritable = {
+export type CategoryAllowanceResponseWritable = {
     [key: string]: unknown;
 };
+export type CategoryResponseWritable = {
+    allowance: CategoryAllowanceResponseWritable;
+};
 export type CustomerPlanResponseWritable = {
     interval?: BillingInterval;
 };

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

@@ -103,16 +103,14 @@ export declare const zBooleanPlanFeatureResponse: z.ZodUnion<readonly [z.ZodInte
         disabled: "disabled";
     }>;
 }, z.core.$strip>>>]>;
-export declare const zAllowancePeriodResponse: z.ZodEnum<{
+export declare const zCategoryPeriodResponse: z.ZodEnum<{
     day: "day";
     week: "week";
     month: "month";
     year: "year";
     onetime: "onetime";
 }>;
-export declare const zAllowanceResponse: z.ZodObject<{
-    displayName: z.ZodReadonly<z.ZodString>;
-    displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
+export declare const zCategoryAllowanceResponse: z.ZodObject<{
     refreshAmount: z.ZodReadonly<z.ZodInt>;
     refreshPeriod: z.ZodEnum<{
         day: "day";
@@ -124,10 +122,10 @@ export declare const zAllowanceResponse: z.ZodObject<{
     isActive: z.ZodReadonly<z.ZodBoolean>;
     isCarryOver: z.ZodReadonly<z.ZodBoolean>;
 }, z.core.$strip>;
-export declare const zAllowancesResponse: z.ZodObject<{
-    default: z.ZodObject<{
-        displayName: z.ZodReadonly<z.ZodString>;
-        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
+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";
@@ -140,6 +138,24 @@ export declare const zAllowancesResponse: z.ZodObject<{
         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>;
@@ -236,22 +252,24 @@ export declare const zPlanResponse: z.ZodObject<{
             amount: z.ZodReadonly<z.ZodInt>;
         }, z.core.$strip>;
     }, z.core.$strip>>;
-    allowances: z.ZodObject<{
+    categories: z.ZodOptional<z.ZodObject<{
         default: z.ZodObject<{
             displayName: z.ZodReadonly<z.ZodString>;
             displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-            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>;
+            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>;
+    }, z.core.$strip>>;
     trial: z.ZodOptional<z.ZodObject<{
         lengthInDays: z.ZodReadonly<z.ZodInt>;
         startingBonusCents: z.ZodReadonly<z.ZodInt>;
@@ -358,22 +376,24 @@ export declare const zCatalogResponse: z.ZodObject<{
                 amount: z.ZodReadonly<z.ZodInt>;
             }, z.core.$strip>;
         }, z.core.$strip>>;
-        allowances: z.ZodObject<{
+        categories: z.ZodOptional<z.ZodObject<{
             default: z.ZodObject<{
                 displayName: z.ZodReadonly<z.ZodString>;
                 displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-                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>;
+                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>;
+        }, z.core.$strip>>;
         trial: z.ZodOptional<z.ZodObject<{
             lengthInDays: z.ZodReadonly<z.ZodInt>;
             startingBonusCents: z.ZodReadonly<z.ZodInt>;
@@ -439,6 +459,7 @@ export declare const zInvoiceListResponse: z.ZodObject<{
 export declare const zCustomerPlanResponse: z.ZodObject<{
     key: z.ZodReadonly<z.ZodString>;
     displayName: z.ZodReadonly<z.ZodString>;
+    displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
     rank: z.ZodReadonly<z.ZodInt>;
     interval: z.ZodOptional<z.ZodEnum<{
         monthly: "monthly";
@@ -563,6 +584,7 @@ export declare const zCustomerResponse: z.ZodObject<{
     currentPlan: z.ZodObject<{
         key: z.ZodReadonly<z.ZodString>;
         displayName: z.ZodReadonly<z.ZodString>;
+        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
         rank: z.ZodReadonly<z.ZodInt>;
         interval: z.ZodOptional<z.ZodEnum<{
             monthly: "monthly";
@@ -655,6 +677,7 @@ export declare const zCustomerResponse: z.ZodObject<{
     pendingPlan: z.ZodOptional<z.ZodObject<{
         key: z.ZodReadonly<z.ZodString>;
         displayName: z.ZodReadonly<z.ZodString>;
+        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
         rank: z.ZodReadonly<z.ZodInt>;
         interval: z.ZodOptional<z.ZodEnum<{
             monthly: "monthly";
@@ -807,9 +830,14 @@ export declare const zBooleanPlanFeatureResponseWritable: z.ZodUnion<readonly [z
     }>;
 }, z.core.$strip>>]>;
 export declare const zPricesResponseWritable: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-export declare const zAllowanceResponseWritable: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-export declare const zAllowancesResponseWritable: z.ZodObject<{
-    default: 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<{
@@ -869,9 +897,11 @@ export declare const zPlanResponseWritable: z.ZodObject<{
             }>;
         }, z.core.$strip>>]>>;
     }, z.core.$strip>;
-    allowances: z.ZodObject<{
-        default: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-    }, 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 zCustomerPlanResponseWritable: z.ZodObject<{
     interval: z.ZodOptional<z.ZodEnum<{
@@ -933,6 +963,7 @@ export declare const zGetCustomerResponse: z.ZodObject<{
     currentPlan: z.ZodObject<{
         key: z.ZodReadonly<z.ZodString>;
         displayName: z.ZodReadonly<z.ZodString>;
+        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
         rank: z.ZodReadonly<z.ZodInt>;
         interval: z.ZodOptional<z.ZodEnum<{
             monthly: "monthly";
@@ -1025,6 +1056,7 @@ export declare const zGetCustomerResponse: z.ZodObject<{
     pendingPlan: z.ZodOptional<z.ZodObject<{
         key: z.ZodReadonly<z.ZodString>;
         displayName: z.ZodReadonly<z.ZodString>;
+        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
         rank: z.ZodReadonly<z.ZodInt>;
         interval: z.ZodOptional<z.ZodEnum<{
             monthly: "monthly";
@@ -1232,22 +1264,24 @@ export declare const zGetPlansResponse: z.ZodObject<{
                 amount: z.ZodReadonly<z.ZodInt>;
             }, z.core.$strip>;
         }, z.core.$strip>>;
-        allowances: z.ZodObject<{
+        categories: z.ZodOptional<z.ZodObject<{
             default: z.ZodObject<{
                 displayName: z.ZodReadonly<z.ZodString>;
                 displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
-                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>;
+                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>;
+        }, z.core.$strip>>;
         trial: z.ZodOptional<z.ZodObject<{
             lengthInDays: z.ZodReadonly<z.ZodInt>;
             startingBonusCents: z.ZodReadonly<z.ZodInt>;
@@ -1364,6 +1398,7 @@ export declare const zM2mGetCustomerResponse: z.ZodObject<{
     currentPlan: z.ZodObject<{
         key: z.ZodReadonly<z.ZodString>;
         displayName: z.ZodReadonly<z.ZodString>;
+        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
         rank: z.ZodReadonly<z.ZodInt>;
         interval: z.ZodOptional<z.ZodEnum<{
             monthly: "monthly";
@@ -1456,6 +1491,7 @@ export declare const zM2mGetCustomerResponse: z.ZodObject<{
     pendingPlan: z.ZodOptional<z.ZodObject<{
         key: z.ZodReadonly<z.ZodString>;
         displayName: z.ZodReadonly<z.ZodString>;
+        displayDescription: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
         rank: z.ZodReadonly<z.ZodInt>;
         interval: z.ZodOptional<z.ZodEnum<{
             monthly: "monthly";

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

@@ -59,23 +59,26 @@ export const zBooleanPlanFeatureResponse = z.union([
         type: z.literal('disabled')
     }).and(zDisabledBooleanPlanFeatureResponse)
 ]);
-export const zAllowancePeriodResponse = z.enum([
+export const zCategoryPeriodResponse = z.enum([
     'day',
     'week',
     'month',
     'year',
     'onetime'
 ]);
-export const zAllowanceResponse = z.object({
-    displayName: z.string().readonly(),
-    displayDescription: z.optional(z.string().readonly()),
+export const zCategoryAllowanceResponse = z.object({
     refreshAmount: z.int().readonly(),
-    refreshPeriod: zAllowancePeriodResponse,
+    refreshPeriod: zCategoryPeriodResponse,
     isActive: z.boolean().readonly(),
     isCarryOver: z.boolean().readonly()
 });
-export const zAllowancesResponse = z.object({
-    default: zAllowanceResponse
+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(),
@@ -89,7 +92,7 @@ export const zPlanResponse = z.object({
         githubOrganizationIntegration: z.optional(zBooleanPlanFeatureResponse)
     }),
     pricing: z.optional(zPricesResponse),
-    allowances: zAllowancesResponse,
+    categories: z.optional(zCategoriesResponse),
     trial: z.optional(zPlanTrialResponse),
     isSelfServe: z.boolean().readonly(),
     isActive: z.boolean().readonly(),
@@ -134,6 +137,7 @@ export const zInvoiceListResponse = z.object({
 export const zCustomerPlanResponse = z.object({
     key: z.string().readonly(),
     displayName: z.string().readonly(),
+    displayDescription: z.optional(z.string().readonly()),
     rank: z.int().readonly(),
     interval: z.optional(zBillingInterval),
     currency: z.optional(z.string().readonly()),
@@ -210,9 +214,12 @@ export const zBooleanPlanFeatureResponseWritable = z.union([
     }).and(zDisabledBooleanPlanFeatureResponseWritable)
 ]);
 export const zPricesResponseWritable = z.record(z.string(), z.unknown());
-export const zAllowanceResponseWritable = z.record(z.string(), z.unknown());
-export const zAllowancesResponseWritable = z.object({
-    default: zAllowanceResponseWritable
+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({
@@ -221,7 +228,7 @@ export const zPlanResponseWritable = z.object({
         maximumEnvironments: z.optional(zIntegerPlanFeatureResponseWritable),
         githubOrganizationIntegration: z.optional(zBooleanPlanFeatureResponseWritable)
     }),
-    allowances: zAllowancesResponseWritable
+    categories: z.optional(zCategoriesResponseWritable)
 });
 export const zCustomerPlanResponseWritable = z.object({
     interval: z.optional(zBillingInterval)

package/package.json

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