Interface StiggClient

Hierarchy

StiggClient

Implemented by

Stigg

Properties

isCustomerLoaded

isCustomerLoaded: boolean

isResourceLoaded

isResourceLoaded: boolean

isWidgetWatermarkEnabled

isWidgetWatermarkEnabled: boolean

Methods

addListener

addListener<K>(eventName: K, callback: Events[K]): void

- Defined in src/client.ts:78
Type parameters
- K: keyof Events
Parameters
- eventName: K
- callback: Events[K]
Returns void

applySubscription

applySubscription(params: ApplySubscription): Promise<ApplySubscriptionResults>

- Defined in src/client.ts:71
Parameters
- params: ApplySubscription
Returns Promise<ApplySubscriptionResults>

clearCustomer

clearCustomer(): void

- Defined in src/client.ts:65
Returns void

clearResource

clearResource(): void

- Defined in src/client.ts:67
Returns void

estimateSubscription

estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>

- Defined in src/client.ts:81
Parameters
- estimateSubscription: EstimateSubscription
Returns Promise<SubscriptionPreview>

estimateSubscriptionUpdate

estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>

- Defined in src/client.ts:82
Parameters
- estimateSubscriptionUpdate: EstimateSubscriptionUpdate
Returns Promise<SubscriptionPreview>

fetchUsageHistory

fetchUsageHistory(params: FetchUsageHistory): Promise<undefined | UsageHistoryPoint[]>

- Defined in src/client.ts:63
Parameters
- params: FetchUsageHistory
Returns Promise<undefined | UsageHistoryPoint[]>

getActiveSubscriptions

getActiveSubscriptions(params?: GetActiveSubscriptions): Promise<Subscription[]>

- Defined in src/client.ts:72
Parameters
- Optional params: GetActiveSubscriptions
Returns Promise<Subscription[]>

getBooleanEntitlement

getBooleanEntitlement(params: GetBooleanEntitlement): BooleanEntitlement

- Defined in src/client.ts:60
Parameters
- params: GetBooleanEntitlement
Returns BooleanEntitlement

getCheckoutState

getCheckoutState(params: GetCheckoutState): Promise<GetCheckoutStateResults>

- Defined in src/client.ts:70
Parameters
- params: GetCheckoutState
Returns Promise<GetCheckoutStateResults>

getCoupons

getCoupons(): Promise<Coupon[]>

- Defined in src/client.ts:73
Returns Promise<Coupon[]>

getCustomer

getCustomer(): Promise<Customer>

- Defined in src/client.ts:69
Returns Promise<Customer>

getCustomerPortal

getCustomerPortal(params?: GetCustomerPortal): Promise<CustomerPortal>

- Defined in src/client.ts:80
Parameters
- Optional params: GetCustomerPortal
Returns Promise<CustomerPortal>

getEntitlements

getEntitlements(resourceId?: string): Promise<Entitlement[]>

- Defined in src/client.ts:74
Parameters
- Optional resourceId: string
Returns Promise<Entitlement[]>

getMeteredEntitlement

getMeteredEntitlement(params: GetMeteredEntitlement): MeteredEntitlement

- Defined in src/client.ts:62
Parameters
- params: GetMeteredEntitlement
Returns MeteredEntitlement

getNumericEntitlement

getNumericEntitlement(params: GetNumericEntitlement): NumericEntitlement

- Defined in src/client.ts:61
Parameters
- params: GetNumericEntitlement
Returns NumericEntitlement

getPaywall

getPaywall(params?: GetPaywall): Promise<Paywall>

- Defined in src/client.ts:68
Parameters
- Optional params: GetPaywall
Returns Promise<Paywall>

previewSubscription

previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>

- Defined in src/client.ts:83
Parameters
- previewSubscription: PreviewSubscription
Returns Promise<SubscriptionPreviewV2>

refresh

refresh(): Promise<void>

- Defined in src/client.ts:75
Returns Promise<void>

removeListener

removeListener<K>(eventName: K, callback: Events[K]): void

- Defined in src/client.ts:79
Type parameters
- K: keyof Events
Parameters
- eventName: K
- callback: Events[K]
Returns void

setCustomerId

setCustomerId(customerId: string, customerToken?: null | string, resourceId?: null | string): Promise<void>

- Defined in src/client.ts:64
Parameters
- customerId: string
- Optional customerToken: null | string
- Optional resourceId: null | string
Returns Promise<void>

setResource

setResource(resourceId: string): Promise<void>

- Defined in src/client.ts:66
Parameters
- resourceId: string
Returns Promise<void>

waitForCheckoutCompleted

waitForCheckoutCompleted(params?: WaitForCheckoutCompleted): Promise<null | Subscription>

- Defined in src/client.ts:76
Parameters
- Optional params: WaitForCheckoutCompleted
Returns Promise<null | Subscription>

waitForInitialization

waitForInitialization(): Promise<StiggClient>

- Defined in src/client.ts:77
Returns Promise<StiggClient>

Generated using TypeDoc