shoal-web-sdk 1.0.126 → 1.0.127

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 { CancelSubscriptionData, CancelSubscriptionError, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSubscriptionData, CreateSubscriptionError, CreateSubscriptionResponse, 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, CreateSubscriptionResponse, DeletePaymentMethodData, DeletePaymentMethodError, DeletePaymentMethodResponse, GetCustomerData, GetInvoicesData, GetPlansData, GetUsageData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, UpdateBillingAddressData, UpdateBillingAddressError, UpdateBillingAddressResponse, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodError, UpdateDefaultPaymentMethodResponse, UpdatePlanData, UpdatePlanError } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -110,6 +110,13 @@ export declare const cancelSubscriptionMutation: (options?: Partial<Options<Canc
  *
  */
 export declare const createSubscriptionMutation: (options?: Partial<Options<CreateSubscriptionData>>) => UseMutationOptions<CreateSubscriptionResponse, CreateSubscriptionError, Options<CreateSubscriptionData>>;
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export declare const updateBillingAddressMutation: (options?: Partial<Options<UpdateBillingAddressData>>) => UseMutationOptions<UpdateBillingAddressResponse, UpdateBillingAddressError, Options<UpdateBillingAddressData>>;
 /**
  * Creates a Stripe SetupIntent.
  *

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 { cancelSubscription, 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, updateBillingAddress, 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) {
@@ -134,6 +134,25 @@ export const createSubscriptionMutation = (options) => {
     };
     return mutationOptions;
 };
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export const updateBillingAddressMutation = (options) => {
+    const mutationOptions = {
+        mutationFn: async (fnOptions) => {
+            const { data } = await updateBillingAddress({
+                ...options,
+                ...fnOptions,
+                throwOnError: true
+            });
+            return data;
+        }
+    };
+    return mutationOptions;
+};
 /**
  * Creates a Stripe SetupIntent.
  *

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

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-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';
+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, UpdateBillingAddressData, UpdateBillingAddressErrors, UpdateBillingAddressResponses, 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
@@ -43,6 +43,13 @@ export declare const cancelSubscription: <ThrowOnError extends boolean = false>(
  *
  */
 export declare const createSubscription: <ThrowOnError extends boolean = false>(options: Options<CreateSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CreateSubscriptionResponses, CreateSubscriptionErrors, ThrowOnError, "fields">;
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export declare const updateBillingAddress: <ThrowOnError extends boolean = false>(options: Options<UpdateBillingAddressData, ThrowOnError>) => import("./client").RequestResult<UpdateBillingAddressResponses, UpdateBillingAddressErrors, ThrowOnError, "fields">;
 /**
  * Creates a Stripe SetupIntent.
  *

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

@@ -104,6 +104,28 @@ export const createSubscription = (options) => {
         }
     });
 };
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export const updateBillingAddress = (options) => {
+    return (options.client ?? client).put({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/api/v1/billing-address/{org}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
 /**
  * Creates a Stripe SetupIntent.
  *

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

@@ -96,6 +96,18 @@ export type CreateSubscriptionRequest = {
     plan: string;
     billingInterval: BillingInterval;
 };
+export type BillingAddress = {
+    name: string;
+    line1: string;
+    line2?: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    /**
+     * Two-letter ISO 3166-1 country code.
+     */
+    country: string;
+};
 export type SetupIntentResponse = {
     readonly clientSecret: string;
 };
@@ -156,6 +168,10 @@ export type CustomerResponse = {
     readonly paymentMethods: Array<PaymentMethodSummary>;
     readonly estimatedCreditBalanceUSD: unknown;
     readonly upcomingInvoiceTotalCents?: number;
+    /**
+     * The address Stripe Tax uses for the customer's tax location. Null when none is set.
+     */
+    billingAddress?: BillingAddress;
 };
 export type UsageInfoResponse = {
     meters: {
@@ -478,6 +494,43 @@ export type CreateSubscriptionResponses = {
     201: SubscriptionResponse;
 };
 export type CreateSubscriptionResponse = CreateSubscriptionResponses[keyof CreateSubscriptionResponses];
+export type UpdateBillingAddressData = {
+    body: BillingAddress;
+    path: {
+        /**
+         * Kinde organisation id.
+         */
+        org: string;
+    };
+    query?: never;
+    url: '/api/v1/billing-address/{org}';
+};
+export type UpdateBillingAddressErrors = {
+    /**
+     * Invalid request body, or Stripe could not use the address as a tax location
+     */
+    400: _Error;
+    /**
+     * Unauthorised user
+     */
+    401: _Error;
+    /**
+     * Account not found
+     */
+    404: _Error;
+    /**
+     * Internal error
+     */
+    500: _Error;
+};
+export type UpdateBillingAddressError = UpdateBillingAddressErrors[keyof UpdateBillingAddressErrors];
+export type UpdateBillingAddressResponses = {
+    /**
+     * The billing address was updated
+     */
+    204: void;
+};
+export type UpdateBillingAddressResponse = UpdateBillingAddressResponses[keyof UpdateBillingAddressResponses];
 export type CreateSetupIntentData = {
     body?: never;
     path: {

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

@@ -1959,6 +1959,15 @@ export declare const zCreateSubscriptionRequest: z.ZodObject<{
         annual: "annual";
     }>;
 }, z.core.$strip>;
+export declare const zBillingAddress: z.ZodObject<{
+    name: z.ZodString;
+    line1: z.ZodString;
+    line2: z.ZodOptional<z.ZodString>;
+    city: z.ZodString;
+    state: z.ZodString;
+    postalCode: z.ZodString;
+    country: z.ZodString;
+}, z.core.$strip>;
 export declare const zSetupIntentResponse: z.ZodObject<{
     clientSecret: z.ZodReadonly<z.ZodString>;
 }, z.core.$strip>;
@@ -2919,6 +2928,15 @@ export declare const zCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
+    billingAddress: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const zUsagePoint: z.ZodObject<{
     date: z.ZodISODateTime;
@@ -5249,6 +5267,15 @@ export declare const zGetCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
+    billingAddress: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const zGetUsageData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
@@ -6555,6 +6582,25 @@ export declare const zCreateSubscriptionResponse: z.ZodObject<{
     status: z.ZodReadonly<z.ZodString>;
     clientSecret: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
 }, z.core.$strip>;
+export declare const zUpdateBillingAddressData: z.ZodObject<{
+    body: z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>;
+    path: z.ZodObject<{
+        org: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+/**
+ * The billing address was updated
+ */
+export declare const zUpdateBillingAddressResponse: z.ZodVoid;
 export declare const zCreateSetupIntentData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{
@@ -7242,6 +7288,15 @@ export declare const zM2mGetCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
+    billingAddress: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const zM2mCreateCustomerData: z.ZodObject<{
     body: z.ZodObject<{

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

@@ -121,6 +121,15 @@ export const zCreateSubscriptionRequest = z.object({
     plan: z.string(),
     billingInterval: zBillingInterval
 });
+export const zBillingAddress = z.object({
+    name: z.string(),
+    line1: z.string(),
+    line2: z.optional(z.string()),
+    city: z.string(),
+    state: z.string(),
+    postalCode: z.string(),
+    country: z.string()
+});
 export const zSetupIntentResponse = z.object({
     clientSecret: z.string().readonly()
 });
@@ -186,7 +195,8 @@ export const zCustomerResponse = z.object({
     seats: z.int().readonly(),
     paymentMethods: z.array(zPaymentMethodSummary).readonly(),
     estimatedCreditBalanceUSD: z.unknown().readonly(),
-    upcomingInvoiceTotalCents: z.optional(z.int().readonly())
+    upcomingInvoiceTotalCents: z.optional(z.int().readonly()),
+    billingAddress: z.optional(zBillingAddress)
 });
 export const zUsagePoint = z.object({
     date: z.iso.datetime(),
@@ -349,6 +359,17 @@ export const zCreateSubscriptionData = z.object({
  * The subscription was created
  */
 export const zCreateSubscriptionResponse = zSubscriptionResponse;
+export const zUpdateBillingAddressData = z.object({
+    body: zBillingAddress,
+    path: z.object({
+        org: z.string()
+    }),
+    query: z.optional(z.never())
+});
+/**
+ * The billing address was updated
+ */
+export const zUpdateBillingAddressResponse = z.void();
 export const zCreateSetupIntentData = z.object({
     body: z.optional(z.never()),
     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, CancelSubscriptionData, CancelSubscriptionResponses, 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, UpdateBillingAddressData, UpdateBillingAddressResponses, 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;
 }) => {
@@ -646,6 +646,14 @@ export declare const useCreateSubscription: (config?: {
     data: import("../../sdk/billing/types.gen").SubscriptionResponse | undefined;
     headers: Record<string, string>;
 }, unknown, Omit<CreateSubscriptionData, "url">, unknown>;
+export declare const useUpdateBillingAddress: (config?: {
+    onSuccess?: (data: GetSuccessResponse<UpdateBillingAddressResponses>, headers: Record<string, string>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<{
+    data: void | undefined;
+    headers: Record<string, string>;
+}, unknown, Omit<UpdateBillingAddressData, "url">, unknown>;
 export declare const useCreateSetupIntent: (config?: {
     onSuccess?: (data: GetSuccessResponse<CreateSetupIntentResponses>, 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, cancelSubscription, createSubscription, createSetupIntent, deletePaymentMethod, updateDefaultPaymentMethod, getInvoices, m2mGetCustomer, m2mCreateCustomer, m2mUpdatePlan } from "../../sdk/billing/sdk.gen";
+import { getCustomer, getUsage, getPlans, updatePlan, cancelSubscription, createSubscription, updateBillingAddress, 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 };
@@ -126,6 +126,25 @@ export const useCreateSubscription = (config) => {
         retry: config?.retry
     });
 };
+export const useUpdateBillingAddress = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/api/v1/billing-address/{org}" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await updateBillingAddress({ ...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", "billing-address", options?.path?.org] });
+            config?.onSuccess && config.onSuccess(res.data, res.headers);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
 export const useCreateSetupIntent = (config) => {
     const token = useToken();
     const queryClient = useQueryClient();

package/package.json

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