shoal-web-sdk 1.0.113 → 1.0.115

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, GetUsageData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodError, UpdateDefaultPaymentMethodResponse, UpdatePlanData, UpdatePlanError } from '../types.gen';
+import type { CancelSubscriptionData, CancelSubscriptionError, 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;
@@ -96,6 +96,13 @@ export declare const getPlansOptions: (options?: Options<GetPlansData>) => impor
  * Returns a list of available pricing plans.
  */
 export declare const updatePlanMutation: (options?: Partial<Options<UpdatePlanData>>) => UseMutationOptions<unknown, UpdatePlanError, Options<UpdatePlanData>>;
+/**
+ * Cancels the account's subscription at the end of the current billing period.
+ *
+ * The subscription is resolved from the organisation's Stripe customer, so no subscription id is required. The customer keeps access until the current period ends, at which point the account is downgraded to the solo plan.
+ *
+ */
+export declare const cancelSubscriptionMutation: (options?: Partial<Options<CancelSubscriptionData>>) => UseMutationOptions<unknown, CancelSubscriptionError, Options<CancelSubscriptionData>>;
 /**
  * Starts a new subscription for a customer who no longer has one.
  *

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, getUsage, m2mCreateCustomer, m2mGetCustomer, m2mUpdatePlan, updateDefaultPaymentMethod, updatePlan } from '../sdk.gen';
+import { cancelSubscription, 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) {
@@ -96,6 +96,25 @@ export const updatePlanMutation = (options) => {
     };
     return mutationOptions;
 };
+/**
+ * Cancels the account's subscription at the end of the current billing period.
+ *
+ * The subscription is resolved from the organisation's Stripe customer, so no subscription id is required. The customer keeps access until the current period ends, at which point the account is downgraded to the solo plan.
+ *
+ */
+export const cancelSubscriptionMutation = (options) => {
+    const mutationOptions = {
+        mutationFn: async (fnOptions) => {
+            const { data } = await cancelSubscription({
+                ...options,
+                ...fnOptions,
+                throwOnError: true
+            });
+            return data;
+        }
+    };
+    return mutationOptions;
+};
 /**
  * Starts a new subscription for a customer who no longer has one.
  *

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, GetUsageData, GetUsageErrors, GetUsageResponses, M2mCreateCustomerData, M2mCreateCustomerErrors, M2mCreateCustomerResponses, M2mGetCustomerData, M2mGetCustomerErrors, M2mGetCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanErrors, M2mUpdatePlanResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodErrors, UpdateDefaultPaymentMethodResponses, UpdatePlanData, UpdatePlanErrors, UpdatePlanResponses } from './types.gen';
+import type { CancelSubscriptionData, CancelSubscriptionErrors, CancelSubscriptionResponses, 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
@@ -29,6 +29,13 @@ export declare const getPlans: <ThrowOnError extends boolean = false>(options?:
  * Returns a list of available pricing plans.
  */
 export declare const updatePlan: <ThrowOnError extends boolean = false>(options: Options<UpdatePlanData, ThrowOnError>) => import("./client").RequestResult<UpdatePlanResponses, UpdatePlanErrors, ThrowOnError, "fields">;
+/**
+ * Cancels the account's subscription at the end of the current billing period.
+ *
+ * The subscription is resolved from the organisation's Stripe customer, so no subscription id is required. The customer keeps access until the current period ends, at which point the account is downgraded to the solo plan.
+ *
+ */
+export declare const cancelSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelSubscriptionResponses, CancelSubscriptionErrors, ThrowOnError, "fields">;
 /**
  * Starts a new subscription for a customer who no longer has one.
  *

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

@@ -64,6 +64,24 @@ export const updatePlan = (options) => {
         }
     });
 };
+/**
+ * Cancels the account's subscription at the end of the current billing period.
+ *
+ * The subscription is resolved from the organisation's Stripe customer, so no subscription id is required. The customer keeps access until the current period ends, at which point the account is downgraded to the solo plan.
+ *
+ */
+export const cancelSubscription = (options) => {
+    return (options.client ?? client).delete({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/api/v1/subscription/{org}',
+        ...options
+    });
+};
 /**
  * Starts a new subscription for a customer who no longer has one.
  *

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

@@ -145,7 +145,7 @@ export type CustomerResponse = {
     readonly scheduledChangeAt?: number;
     readonly seats: number;
     readonly paymentMethods: Array<PaymentMethodSummary>;
-    readonly creditBalanceUSD: number;
+    readonly estimatedCreditBalanceUSD: unknown;
     readonly upcomingInvoiceTotalCents?: number;
 };
 export type UsageInfoResponse = {
@@ -384,6 +384,46 @@ export type UpdatePlanResponses = {
      */
     202: unknown;
 };
+export type CancelSubscriptionData = {
+    body?: never;
+    path: {
+        /**
+         * Kinde organisation id.
+         */
+        org: string;
+    };
+    query?: never;
+    url: '/api/v1/subscription/{org}';
+};
+export type CancelSubscriptionErrors = {
+    /**
+     * Unauthorised user
+     */
+    401: _Error;
+    /**
+     * Account not found, or the account has no in-force subscription
+     */
+    404: _Error;
+    /**
+     * The subscription is already scheduled to cancel, or the account has no Stripe customer yet
+     */
+    409: _Error;
+    /**
+     * The subscription cannot be cancelled
+     */
+    422: _Error;
+    /**
+     * Internal error
+     */
+    500: _Error;
+};
+export type CancelSubscriptionError = CancelSubscriptionErrors[keyof CancelSubscriptionErrors];
+export type CancelSubscriptionResponses = {
+    /**
+     * The subscription is scheduled to cancel at the end of the period
+     */
+    202: unknown;
+};
 export type CreateSubscriptionData = {
     body: CreateSubscriptionRequest;
     path: {

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

@@ -2912,7 +2912,7 @@ export declare const zCustomerResponse: z.ZodObject<{
         expYear: z.ZodReadonly<z.ZodInt>;
         isDefault: z.ZodReadonly<z.ZodBoolean>;
     }, z.core.$strip>>>;
-    creditBalanceUSD: z.ZodReadonly<z.ZodInt>;
+    estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
 }, z.core.$strip>;
 export declare const zUsagePoint: z.ZodObject<{
@@ -5242,7 +5242,7 @@ export declare const zGetCustomerResponse: z.ZodObject<{
         expYear: z.ZodReadonly<z.ZodInt>;
         isDefault: z.ZodReadonly<z.ZodBoolean>;
     }, z.core.$strip>>>;
-    creditBalanceUSD: z.ZodReadonly<z.ZodInt>;
+    estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
 }, z.core.$strip>;
 export declare const zGetUsageData: z.ZodObject<{
@@ -6522,6 +6522,13 @@ export declare const zUpdatePlanData: z.ZodObject<{
     }, z.core.$strip>;
     query: z.ZodOptional<z.ZodNever>;
 }, z.core.$strip>;
+export declare const zCancelSubscriptionData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodObject<{
+        org: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
 export declare const zCreateSubscriptionData: z.ZodObject<{
     body: z.ZodObject<{
         plan: z.ZodString;
@@ -7220,7 +7227,7 @@ export declare const zM2mGetCustomerResponse: z.ZodObject<{
         expYear: z.ZodReadonly<z.ZodInt>;
         isDefault: z.ZodReadonly<z.ZodBoolean>;
     }, z.core.$strip>>>;
-    creditBalanceUSD: z.ZodReadonly<z.ZodInt>;
+    estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
 }, z.core.$strip>;
 export declare const zM2mCreateCustomerData: z.ZodObject<{

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

@@ -180,7 +180,7 @@ export const zCustomerResponse = z.object({
     scheduledChangeAt: z.optional(z.int().readonly()),
     seats: z.int().readonly(),
     paymentMethods: z.array(zPaymentMethodSummary).readonly(),
-    creditBalanceUSD: z.int().readonly(),
+    estimatedCreditBalanceUSD: z.unknown().readonly(),
     upcomingInvoiceTotalCents: z.optional(z.int().readonly())
 });
 export const zUsagePoint = z.object({
@@ -326,6 +326,13 @@ export const zUpdatePlanData = z.object({
     }),
     query: z.optional(z.never())
 });
+export const zCancelSubscriptionData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        org: z.string()
+    }),
+    query: z.optional(z.never())
+});
 export const zCreateSubscriptionData = z.object({
     body: zCreateSubscriptionRequest,
     path: z.object({

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

@@ -1,6 +1,6 @@
 import { useMutation } from "@tanstack/react-query";
 import { GetSuccessResponse } from "../util";
-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";
+import { GetCustomerData, GetUsageData, GetPlansData, UpdatePlanData, UpdatePlanResponses, CancelSubscriptionData, CancelSubscriptionResponses, 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;
 }) => {
@@ -630,6 +630,14 @@ export declare const useUpdatePlan: (config?: {
     data: unknown;
     headers: Record<string, string>;
 }, unknown, Omit<UpdatePlanData, "url">, unknown>;
+export declare const useCancelSubscription: (config?: {
+    onSuccess?: (data: GetSuccessResponse<CancelSubscriptionResponses>, headers: Record<string, string>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<{
+    data: unknown;
+    headers: Record<string, string>;
+}, unknown, Omit<CancelSubscriptionData, "url">, unknown>;
 export declare const useCreateSubscription: (config?: {
     onSuccess?: (data: GetSuccessResponse<CreateSubscriptionResponses>, headers: Record<string, string>) => void;
     onError?: Parameters<typeof useMutation>["0"]["onError"];

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, getUsage, getPlans, updatePlan, createSubscription, createSetupIntent, deletePaymentMethod, updateDefaultPaymentMethod, getInvoices, m2mGetCustomer, m2mCreateCustomer, m2mUpdatePlan } from "../../sdk/billing/sdk.gen";
+import { getCustomer, getUsage, getPlans, updatePlan, cancelSubscription, 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 };
@@ -88,6 +88,25 @@ export const useUpdatePlan = (config) => {
         retry: config?.retry
     });
 };
+export const useCancelSubscription = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/api/v1/subscription/{org}" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await cancelSubscription({ ...opts, ...options, auth });
+        return { data: res.data, headers: headersToObject(res.response.headers) };
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: ["api", "v1", "subscription", options?.path?.org] });
+            config?.onSuccess && config.onSuccess(res.data, res.headers);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
 export const useCreateSubscription = (config) => {
     const token = useToken();
     const queryClient = useQueryClient();

package/package.json

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