@stigg/js-client-sdk - v3.93.0

    Interface StiggClient

    interface StiggClient {
        addListener: <K extends keyof Events>(
            eventName: K,
            callback: Events[K],
        ) => void;
        applySubscription: (
            params: ApplySubscription,
        ) => Promise<ApplySubscriptionResults>;
        clearCustomer: () => void;
        clearResource: () => void;
        fetchUsageHistory: (
            params: FetchUsageHistory,
        ) => Promise<UsageHistoryPoint[] | undefined>;
        getActiveSubscriptions: (
            params?: GetActiveSubscriptions,
        ) => Promise<Subscription[]>;
        getBooleanEntitlement: (
            params: GetBooleanEntitlement,
        ) => BooleanEntitlement;
        getCheckoutState: (
            params: GetCheckoutState,
        ) => Promise<GetCheckoutStateResults>;
        getCreditEntitlement: (params: GetCreditEntitlement) => CreditEntitlement;
        getCustomer: () => Promise<Customer>;
        getEntitlements: (resourceId?: string) => Promise<Entitlement[]>;
        getEntitlementsState: (resourceId?: string) => Promise<EntitlementsState>;
        getEnumEntitlement: (params: GetEnumEntitlement) => EnumEntitlement;
        getMeteredEntitlement: (
            params: GetMeteredEntitlement,
        ) => MeteredEntitlement;
        getNumericEntitlement: (
            params: GetNumericEntitlement,
        ) => NumericEntitlement;
        getPaywall: (params?: GetPaywall) => Promise<Paywall>;
        isCustomerLoaded: boolean;
        isResourceLoaded: boolean;
        isWidgetWatermarkEnabled: boolean;
        refresh: () => Promise<void>;
        removeListener: <K extends keyof Events>(
            eventName: K,
            callback: Events[K],
        ) => void;
        setCustomerId: (
            customerId: string,
            customerToken?: string | null,
            resourceId?: string | null,
        ) => Promise<void>;
        setResource: (resourceId: string) => Promise<void>;
        createPaymentSession(
            input: CreatePaymentSessionInput,
        ): Promise<PaymentSessionFragment>;
        estimateSubscription(
            estimateSubscription: EstimateSubscription,
        ): Promise<SubscriptionPreview>;
        estimateSubscriptionUpdate(
            estimateSubscriptionUpdate: EstimateSubscriptionUpdate,
        ): Promise<SubscriptionPreview>;
        getActiveSubscriptionsList(
            params?: GetActiveSubscriptions,
        ): Promise<SlimSubscriptionFragmentV2Fragment[]>;
        getAutomaticRechargeConfiguration(
            input: GetAutoRechargeSettingsInput,
        ): Promise<AutoRechargeSettingsFragment>;
        getCoupons(): Promise<Coupon[]>;
        getCreditBalance(
            input?: GetCreditBalanceInput,
        ): Promise<CreditsBalanceSummaryFragment>;
        getCreditGrants(
            input: GetCreditGrantsInput,
        ): Promise<GetCreditGrantsResult>;
        getCreditLedger(
            input?: GetCreditLedgerInput,
        ): Promise<GetCreditLedgerResult>;
        getCreditUsage(input: GetCreditUsageInput): Promise<CreditUsageFragment>;
        getCustomerPortal(params?: GetCustomerPortal): Promise<CustomerPortal>;
        getShowWatermark(): boolean;
        getSubscription(params: GetSubscription): Promise<Subscription>;
        getSubscriptions(
            params: GetSubscriptionsParams,
        ): Promise<GetSubscriptionsResult>;
        getUsageHistoryV2(
            input: UsageHistoryV2Input,
        ): Promise<UsageHistoryV2Fragment>;
        previewNextInvoice(
            previewNextInvoice: PreviewNextInvoice,
        ): Promise<SubscriptionInvoicePreviewFragment>;
        previewSubscription(
            previewSubscription: PreviewSubscription,
        ): Promise<SubscriptionPreviewV2>;
        saveAutomaticRechargeConfiguration(
            input: SaveAutoRechargeSettingsInput,
        ): Promise<AutoRechargeSettingsFragment>;
        waitForCheckoutCompleted(
            params?: WaitForCheckoutCompleted,
        ): Promise<Subscription | null>;
        waitForInitialization(): Promise<StiggClient>;
    }

    Implemented by

    Index

    Properties

    addListener applySubscription clearCustomer clearResource fetchUsageHistory getActiveSubscriptions getBooleanEntitlement getCheckoutState getCreditEntitlement getCustomer getEntitlements getEntitlementsState getEnumEntitlement getMeteredEntitlement getNumericEntitlement getPaywall isCustomerLoaded isResourceLoaded isWidgetWatermarkEnabled refresh removeListener setCustomerId setResource

    Methods

    createPaymentSession estimateSubscription estimateSubscriptionUpdate getActiveSubscriptionsList getAutomaticRechargeConfiguration getCoupons getCreditBalance getCreditGrants getCreditLedger getCreditUsage getCustomerPortal getShowWatermark getSubscription getSubscriptions getUsageHistoryV2 previewNextInvoice previewSubscription saveAutomaticRechargeConfiguration waitForCheckoutCompleted waitForInitialization

    Properties

    addListener: <K extends keyof Events>(eventName: K, callback: Events[K]) => void
    applySubscription: (
        params: ApplySubscription,
    ) => Promise<ApplySubscriptionResults>
    clearCustomer: () => void
    clearResource: () => void
    fetchUsageHistory: (
        params: FetchUsageHistory,
    ) => Promise<UsageHistoryPoint[] | undefined>
    getActiveSubscriptions: (
        params?: GetActiveSubscriptions,
    ) => Promise<Subscription[]>
    getBooleanEntitlement: (params: GetBooleanEntitlement) => BooleanEntitlement
    getCheckoutState: (params: GetCheckoutState) => Promise<GetCheckoutStateResults>
    getCreditEntitlement: (params: GetCreditEntitlement) => CreditEntitlement
    getCustomer: () => Promise<Customer>
    getEntitlements: (resourceId?: string) => Promise<Entitlement[]>

    Use getEntitlementsState instead

    getEntitlementsState: (resourceId?: string) => Promise<EntitlementsState>
    getEnumEntitlement: (params: GetEnumEntitlement) => EnumEntitlement
    getMeteredEntitlement: (params: GetMeteredEntitlement) => MeteredEntitlement
    getNumericEntitlement: (params: GetNumericEntitlement) => NumericEntitlement
    getPaywall: (params?: GetPaywall) => Promise<Paywall>
    isCustomerLoaded: boolean
    isResourceLoaded: boolean
    isWidgetWatermarkEnabled: boolean

    Use getShowWatermark instead

    refresh: () => Promise<void>
    removeListener: <K extends keyof Events>(
        eventName: K,
        callback: Events[K],
    ) => void
    setCustomerId: (
        customerId: string,
        customerToken?: string | null,
        resourceId?: string | null,
    ) => Promise<void>
    setResource: (resourceId: string) => Promise<void>

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR