autumn-js/dist/libraries/react/hooks/useCustomerBase.d.mts

Autumn JS Library

import { A as AutumnError } from '../error-DHbclCVh.mjs';
import { A as AutumnPromise, a as CheckResult, T as TrackResult, C as CancelResult, S as SetupPaymentResult } from '../response-dnzFyX91.mjs';
import { A as AttachResult, C as CheckoutResult } from '../attachTypes-DoFoPh8g.mjs';
import { c as CustomerExpandOption, b as Customer, B as BillingPortalResult } from '../cusTypes-COIU0NG3.mjs';
import { E as Entity } from '../entTypes-BVPtpycG.mjs';
import { C as CreateReferralCodeResult, R as RedeemReferralCodeResult, A as AutumnClient } from '../ReactAutumnClient-BjRiaYDN.mjs';
import { CreateEntityParams } from '../client/types/clientEntTypes.mjs';
import { CreateReferralCodeParams, RedeemReferralCodeParams } from '../client/types/clientReferralTypes.mjs';
import { SWRConfiguration } from 'swr';
import React__default from 'react';
import { CheckParams, TrackParams, CancelParams, SetupPaymentParams, OpenBillingPortalParams } from '../client/types/clientGenTypes.mjs';
import { AllowedParams } from './handleAllowed.mjs';
import { AttachParams, CheckoutParams } from '../client/types/clientAttachTypes.mjs';
import 'zod';

interface UseCustomerResult {
    customer: Customer | null;
    isLoading: boolean;
    error: AutumnError | null;
    attach: (params: AttachParams) => AutumnPromise<AttachResult>;
    check: (params: CheckParams) => AutumnPromise<CheckResult>;
    track: (params: TrackParams) => AutumnPromise<TrackResult>;
    cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
    setupPayment: (params: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
    openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
    checkout: (params: CheckoutParams) => AutumnPromise<CheckoutResult>;
    refetch: () => Promise<Customer | null>;
    createEntity: (params: CreateEntityParams | CreateEntityParams[]) => AutumnPromise<Entity | Entity[]>;
    createReferralCode: (params: CreateReferralCodeParams) => AutumnPromise<CreateReferralCodeResult>;
    redeemReferralCode: (params: RedeemReferralCodeParams) => AutumnPromise<RedeemReferralCodeResult>;
    allowed: (params: AllowedParams) => boolean;
}
interface UseCustomerParams {
    errorOnNotFound?: boolean;
    expand?: CustomerExpandOption[];
    swrConfig?: SWRConfiguration;
}
declare const useCustomerBase: ({ params, AutumnContext, client, }: {
    params?: UseCustomerParams;
    AutumnContext?: React__default.Context<any>;
    client?: AutumnClient;
}) => UseCustomerResult;

export { type UseCustomerParams, type UseCustomerResult, useCustomerBase };