shoal-web-sdk 1.0.145 → 1.0.146

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, CreateCouponData, CreateCouponError, CreateCouponResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSubscriptionData, CreateSubscriptionError, CreateSubscriptionResponse, DeleteCouponData, DeleteCouponError, DeleteCouponResponse, DeletePaymentMethodData, DeletePaymentMethodError, DeletePaymentMethodResponse, GetCouponData, GetCustomerData, GetInvoicesData, GetPlansData, GetUsageData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, RedeemCouponData, RedeemCouponError, RedeemCouponResponse, UpdateBillingAddressData, UpdateBillingAddressError, UpdateBillingAddressResponse, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodError, UpdateDefaultPaymentMethodResponse, UpdatePlanData, UpdatePlanError } from '../types.gen';
+import type { CancelSubscriptionData, CancelSubscriptionError, CreateCouponData, CreateCouponError, CreateCouponResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSubscriptionData, CreateSubscriptionError, CreateSubscriptionResponse, DeleteCouponData, DeleteCouponError, DeleteCouponResponse, DeletePaymentMethodData, DeletePaymentMethodError, DeletePaymentMethodResponse, EmailCouponData, EmailCouponError, EmailCouponResponse, GetCouponData, GetCustomerData, GetInvoicesData, GetPlansData, GetUsageData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, RedeemCouponData, RedeemCouponError, RedeemCouponResponse, 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;
@@ -171,6 +171,10 @@ export declare const createCouponMutation: (options?: Partial<Options<CreateCoup
  * Deletes an unredeemed coupon. Requires a platform48.com email.
  */
 export declare const deleteCouponMutation: (options?: Partial<Options<DeleteCouponData>>) => UseMutationOptions<DeleteCouponResponse, DeleteCouponError, Options<DeleteCouponData>>;
+/**
+ * Emails an unredeemed coupon to the owners and admins of its organisation. Requires a platform48.com email.
+ */
+export declare const emailCouponMutation: (options?: Partial<Options<EmailCouponData>>) => UseMutationOptions<EmailCouponResponse, EmailCouponError, Options<EmailCouponData>>;
 export declare const getInvoicesQueryKey: (options: Options<GetInvoicesData>) => [Pick<Options<GetInvoicesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;

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, createCoupon, createSetupIntent, createSubscription, deleteCoupon, deletePaymentMethod, getCoupon, getCustomer, getInvoices, getPlans, getUsage, m2mCreateCustomer, m2mGetCustomer, m2mUpdatePlan, redeemCoupon, updateBillingAddress, updateDefaultPaymentMethod, updatePlan } from '../sdk.gen';
+import { cancelSubscription, createCoupon, createSetupIntent, createSubscription, deleteCoupon, deletePaymentMethod, emailCoupon, getCoupon, getCustomer, getInvoices, getPlans, getUsage, m2mCreateCustomer, m2mGetCustomer, m2mUpdatePlan, redeemCoupon, 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) {
@@ -269,6 +269,22 @@ export const deleteCouponMutation = (options) => {
     };
     return mutationOptions;
 };
+/**
+ * Emails an unredeemed coupon to the owners and admins of its organisation. Requires a platform48.com email.
+ */
+export const emailCouponMutation = (options) => {
+    const mutationOptions = {
+        mutationFn: async (fnOptions) => {
+            const { data } = await emailCoupon({
+                ...options,
+                ...fnOptions,
+                throwOnError: true
+            });
+            return data;
+        }
+    };
+    return mutationOptions;
+};
 export const getInvoicesQueryKey = (options) => createQueryKey('getInvoices', options);
 /**
  * Returns a page of the customer's invoices. This response is paginated.

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, CreateCouponData, CreateCouponErrors, CreateCouponResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSubscriptionData, CreateSubscriptionErrors, CreateSubscriptionResponses, DeleteCouponData, DeleteCouponErrors, DeleteCouponResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, GetCouponData, GetCouponErrors, GetCouponResponses, GetCustomerData, GetCustomerErrors, GetCustomerResponses, GetInvoicesData, GetInvoicesErrors, GetInvoicesResponses, GetPlansData, GetPlansErrors, GetPlansResponses, GetUsageData, GetUsageErrors, GetUsageResponses, M2mCreateCustomerData, M2mCreateCustomerErrors, M2mCreateCustomerResponses, M2mGetCustomerData, M2mGetCustomerErrors, M2mGetCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanErrors, M2mUpdatePlanResponses, RedeemCouponData, RedeemCouponErrors, RedeemCouponResponses, UpdateBillingAddressData, UpdateBillingAddressErrors, UpdateBillingAddressResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodErrors, UpdateDefaultPaymentMethodResponses, UpdatePlanData, UpdatePlanErrors, UpdatePlanResponses } from './types.gen';
+import type { CancelSubscriptionData, CancelSubscriptionErrors, CancelSubscriptionResponses, CreateCouponData, CreateCouponErrors, CreateCouponResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSubscriptionData, CreateSubscriptionErrors, CreateSubscriptionResponses, DeleteCouponData, DeleteCouponErrors, DeleteCouponResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, EmailCouponData, EmailCouponErrors, EmailCouponResponses, GetCouponData, GetCouponErrors, GetCouponResponses, GetCustomerData, GetCustomerErrors, GetCustomerResponses, GetInvoicesData, GetInvoicesErrors, GetInvoicesResponses, GetPlansData, GetPlansErrors, GetPlansResponses, GetUsageData, GetUsageErrors, GetUsageResponses, M2mCreateCustomerData, M2mCreateCustomerErrors, M2mCreateCustomerResponses, M2mGetCustomerData, M2mGetCustomerErrors, M2mGetCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanErrors, M2mUpdatePlanResponses, RedeemCouponData, RedeemCouponErrors, RedeemCouponResponses, 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
@@ -80,6 +80,10 @@ export declare const createCoupon: <ThrowOnError extends boolean = false>(option
  * Deletes an unredeemed coupon. Requires a platform48.com email.
  */
 export declare const deleteCoupon: <ThrowOnError extends boolean = false>(options: Options<DeleteCouponData, ThrowOnError>) => import("./client").RequestResult<DeleteCouponResponses, DeleteCouponErrors, ThrowOnError, "fields">;
+/**
+ * Emails an unredeemed coupon to the owners and admins of its organisation. Requires a platform48.com email.
+ */
+export declare const emailCoupon: <ThrowOnError extends boolean = false>(options: Options<EmailCouponData, ThrowOnError>) => import("./client").RequestResult<EmailCouponResponses, EmailCouponErrors, ThrowOnError, "fields">;
 /**
  * Returns a page of the customer's invoices. This response is paginated.
  */

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

@@ -237,6 +237,21 @@ export const deleteCoupon = (options) => {
         ...options
     });
 };
+/**
+ * Emails an unredeemed coupon to the owners and admins of its organisation. Requires a platform48.com email.
+ */
+export const emailCoupon = (options) => {
+    return (options.client ?? client).post({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/api/v1/admin/coupon/{code}/email',
+        ...options
+    });
+};
 /**
  * Returns a page of the customer's invoices. This response is paginated.
  */

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

@@ -108,6 +108,12 @@ export type AdminCoupon = Coupon & {
      */
     org: string;
 };
+export type CouponEmailResult = {
+    /**
+     * Email addresses the coupon was sent to.
+     */
+    recipients: Array<string>;
+};
 export type CreateCoupon = {
     /**
      * Kinde organisation id.
@@ -889,6 +895,51 @@ export type DeleteCouponResponses = {
     204: void;
 };
 export type DeleteCouponResponse = DeleteCouponResponses[keyof DeleteCouponResponses];
+export type EmailCouponData = {
+    body?: never;
+    path: {
+        /**
+         * A coupon code.
+         */
+        code: string;
+    };
+    query?: never;
+    url: '/api/v1/admin/coupon/{code}/email';
+};
+export type EmailCouponErrors = {
+    /**
+     * Unauthorised user
+     */
+    401: _Error;
+    /**
+     * Requires a platform48.com email
+     */
+    403: _Error;
+    /**
+     * Coupon not found
+     */
+    404: _Error;
+    /**
+     * Coupon already redeemed, or the organisation has no owners or admins to email
+     */
+    409: _Error;
+    /**
+     * Coupon has expired
+     */
+    422: _Error;
+    /**
+     * Unexpected error.
+     */
+    500: _Error;
+};
+export type EmailCouponError = EmailCouponErrors[keyof EmailCouponErrors];
+export type EmailCouponResponses = {
+    /**
+     * The coupon was emailed
+     */
+    200: CouponEmailResult;
+};
+export type EmailCouponResponse = EmailCouponResponses[keyof EmailCouponResponses];
 export type GetInvoicesData = {
     body?: never;
     path: {

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

@@ -2096,6 +2096,9 @@ export declare const zAdminCoupon: z.ZodIntersection<z.ZodObject<{
 }, z.core.$strip>, z.ZodObject<{
     org: z.ZodString;
 }, z.core.$strip>>;
+export declare const zCouponEmailResult: z.ZodObject<{
+    recipients: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
 export declare const zCreateCoupon: z.ZodObject<{
     org: z.ZodString;
     plan: z.ZodOptional<z.ZodEnum<{
@@ -8369,6 +8372,19 @@ export declare const zDeleteCouponData: z.ZodObject<{
  * Coupon deleted
  */
 export declare const zDeleteCouponResponse: z.ZodVoid;
+export declare const zEmailCouponData: z.ZodObject<{
+    body: z.ZodOptional<z.ZodNever>;
+    path: z.ZodObject<{
+        code: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+/**
+ * The coupon was emailed
+ */
+export declare const zEmailCouponResponse: z.ZodObject<{
+    recipients: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
 export declare const zGetInvoicesData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{

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

@@ -129,6 +129,9 @@ export const zCoupon = z.object({
 export const zAdminCoupon = zCoupon.and(z.object({
     org: z.string()
 }));
+export const zCouponEmailResult = z.object({
+    recipients: z.array(z.string())
+});
 export const zCreateCoupon = z.object({
     org: z.string(),
     plan: z.optional(zCouponPlan),
@@ -491,6 +494,17 @@ export const zDeleteCouponData = z.object({
  * Coupon deleted
  */
 export const zDeleteCouponResponse = z.void();
+export const zEmailCouponData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        code: z.string()
+    }),
+    query: z.optional(z.never())
+});
+/**
+ * The coupon was emailed
+ */
+export const zEmailCouponResponse = zCouponEmailResult;
 export const zGetInvoicesData = 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, UpdateBillingAddressData, UpdateBillingAddressResponses, CreateSetupIntentData, CreateSetupIntentResponses, DeletePaymentMethodData, DeletePaymentMethodResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodResponses, GetCouponData, RedeemCouponData, RedeemCouponResponses, CreateCouponData, CreateCouponResponses, DeleteCouponData, DeleteCouponResponses, 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, GetCouponData, RedeemCouponData, RedeemCouponResponses, CreateCouponData, CreateCouponResponses, DeleteCouponData, DeleteCouponResponses, EmailCouponData, EmailCouponResponses, GetInvoicesData, M2mGetCustomerData, M2mCreateCustomerData, M2mCreateCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanResponses } from "../../sdk/billing/types.gen";
 export declare const useGetCustomer: (options: Omit<GetCustomerData, "url"> & {
     enabled?: boolean;
 }) => {
@@ -909,6 +909,14 @@ export declare const useDeleteCoupon: (config?: {
     data: void | undefined;
     headers: Record<string, string>;
 }, unknown, Omit<DeleteCouponData, "url">, unknown>;
+export declare const useEmailCoupon: (config?: {
+    onSuccess?: (data: GetSuccessResponse<EmailCouponResponses>, headers: Record<string, string>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<{
+    data: import("../../sdk/billing/types.gen").CouponEmailResult | undefined;
+    headers: Record<string, string>;
+}, unknown, Omit<EmailCouponData, "url">, unknown>;
 export declare const useGetInvoices: (options: Omit<GetInvoicesData, "url"> & {
     enabled?: boolean;
 }) => {

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, updateBillingAddress, createSetupIntent, deletePaymentMethod, updateDefaultPaymentMethod, getCoupon, redeemCoupon, createCoupon, deleteCoupon, getInvoices, m2mGetCustomer, m2mCreateCustomer, m2mUpdatePlan } from "../../sdk/billing/sdk.gen";
+import { getCustomer, getUsage, getPlans, updatePlan, cancelSubscription, createSubscription, updateBillingAddress, createSetupIntent, deletePaymentMethod, updateDefaultPaymentMethod, getCoupon, redeemCoupon, createCoupon, deleteCoupon, emailCoupon, getInvoices, m2mGetCustomer, m2mCreateCustomer, m2mUpdatePlan } from "../../sdk/billing/sdk.gen";
 export const useGetCustomer = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -281,6 +281,25 @@ export const useDeleteCoupon = (config) => {
         retry: config?.retry
     });
 };
+export const useEmailCoupon = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/api/v1/admin/coupon/{code}/email" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await emailCoupon({ ...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", "admin", "coupon", options?.path?.code, "email"] });
+            config?.onSuccess && config.onSuccess(res.data, res.headers);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
 export const useGetInvoices = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };

package/package.json

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