Class Stigg

Hierarchy

Stigg

Implements

StiggClient

Accessors

isCustomerLoaded

get isCustomerLoaded(): boolean

Implementation of StiggClient.isCustomerLoaded
- Defined in src/client.ts:189
Returns boolean

isResourceLoaded

get isResourceLoaded(): boolean

Implementation of StiggClient.isResourceLoaded
- Defined in src/client.ts:193
Returns boolean

isWidgetWatermarkEnabled

get isWidgetWatermarkEnabled(): boolean

Implementation of StiggClient.isWidgetWatermarkEnabled
- Defined in src/client.ts:197
Returns boolean

Methods

addListener

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

Implementation of StiggClient.addListener
- Defined in src/client.ts:206
Add a listener to handle updates of entitlements changes

Type parameters
- K: keyof Events
Parameters
- eventName: K
- listener: Events[K]
Returns void

applySubscription

applySubscription(applySubscriptionInput: ApplySubscription): Promise<ApplySubscriptionResults>

Implementation of StiggClient.applySubscription
- Defined in src/client.ts:745
Apply subscription changes for a customer Update\Provision a subscription for a customer according to the given subscription input

Parameters
- applySubscriptionInput: ApplySubscription
Returns Promise<ApplySubscriptionResults>

clearCustomer

clearCustomer(): void

Implementation of StiggClient.clearCustomer
- Defined in src/client.ts:313
Clear the customer ID, usually after the customer signs out

Returns void

clearResource

clearResource(): void

Implementation of StiggClient.clearResource
- Defined in src/client.ts:375
Unset the customer's resource ID, usually after the customer exit a specific resource.

Returns void

estimateSubscription

estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>

Implementation of StiggClient.estimateSubscription
- Defined in src/client.ts:843
Estimate subscription

Parameters
- estimateSubscription: EstimateSubscription
Returns Promise<SubscriptionPreview>
Preview of the subscription.

estimateSubscriptionUpdate

estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>

Implementation of StiggClient.estimateSubscriptionUpdate
- Defined in src/client.ts:865
Estimate subscription update

Parameters
- estimateSubscriptionUpdate: EstimateSubscriptionUpdate
Returns Promise<SubscriptionPreview>
Preview of the subscription.

fetchUsageHistory

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

Implementation of StiggClient.fetchUsageHistory
- Defined in src/client.ts:774
Fetch customer usage history of a feature.

Parameters
- fetchUsageHistory: FetchUsageHistory
Returns Promise<undefined | UsageHistoryPoint[]>
Array of usage history as data points.

getActiveSubscriptions

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

Implementation of StiggClient.getActiveSubscriptions
- Defined in src/client.ts:964
Parameters
- __namedParameters: GetActiveSubscriptions = {}
Returns Promise<Subscription[]>

getActiveSubscriptionsList

getActiveSubscriptionsList(resourceId?: GetActiveSubscriptions): Promise<SlimSubscriptionFragmentV2Fragment[]>

Implementation of StiggClient.getActiveSubscriptionsList
- Defined in src/client.ts:990
description
Get customer's active subscriptions, for extended subscription data use getSubscription

Parameters
- resourceId: GetActiveSubscriptions = {}
  
  optional resource id, if not provided global resources will be fetched.
Returns Promise<SlimSubscriptionFragmentV2Fragment[]>
List of active subscriptions

getBooleanEntitlement

getBooleanEntitlement(__namedParameters: GetBooleanEntitlement): BooleanEntitlement

Implementation of StiggClient.getBooleanEntitlement
- Defined in src/client.ts:409
Get boolean entitlement of feature for a customer

Parameters
- __namedParameters: GetBooleanEntitlement
Returns BooleanEntitlement
boolean entitlement

getCheckoutState

getCheckoutState(parameters: GetCheckoutState): Promise<GetCheckoutStateResults>

Implementation of StiggClient.getCheckoutState
- Defined in src/client.ts:713
Get customer checkout details

Parameters
- parameters: GetCheckoutState
Returns Promise<GetCheckoutStateResults>

getCoupons

getCoupons(): Promise<Coupon[]>

Implementation of StiggClient.getCoupons
- Defined in src/client.ts:646
Get a list of coupons

Returns Promise<Coupon[]>

getCustomer

getCustomer(): Promise<Customer>

Implementation of StiggClient.getCustomer
- Defined in src/client.ts:666
Get a customer

Returns Promise<Customer>

getCustomerPortal

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

Implementation of StiggClient.getCustomerPortal
- Defined in src/client.ts:692
Get a customer portal

Parameters
- __namedParameters: GetCustomerPortal = {}
Returns Promise<CustomerPortal>

getEntitlements

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

Implementation of StiggClient.getEntitlements
- Defined in src/client.ts:795
Get a list of entitlements

Parameters
- Optional resourceId: string
Returns Promise<Entitlement[]>

getMeteredEntitlement

getMeteredEntitlement(__namedParameters: GetMeteredEntitlement): MeteredEntitlement

Implementation of StiggClient.getMeteredEntitlement
- Defined in src/client.ts:541
Get metered entitlement of feature for a customer

Parameters
- __namedParameters: GetMeteredEntitlement
Returns MeteredEntitlement
metered entitlement

getNumericEntitlement

getNumericEntitlement(__namedParameters: GetNumericEntitlement): NumericEntitlement

Implementation of StiggClient.getNumericEntitlement
- Defined in src/client.ts:475
Get numeric entitlement of feature for a customer

Parameters
- __namedParameters: GetNumericEntitlement
Returns NumericEntitlement
numeric entitlement

getPaywall

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

Implementation of StiggClient.getPaywall
- Defined in src/client.ts:605
Get paywall data for rendering the paywall

deprecated
Optional productId is now deprecated and will be changed to a required field soon.

Parameters
- __namedParameters: GetPaywall = {}
Returns Promise<Paywall>

getSubscription

getSubscription(subscriptionId: GetSubscription): Promise<Subscription>

Implementation of StiggClient.getSubscription
- Defined in src/client.ts:1013
Get subscription

Parameters
- subscriptionId: GetSubscription
  
  subscription id
Returns Promise<Subscription>
the subscription data

previewSubscription

previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>

Implementation of StiggClient.previewSubscription
- Defined in src/client.ts:892
Preview subscription provisioning\updates

Parameters
- previewSubscription: PreviewSubscription
Returns Promise<SubscriptionPreviewV2>
Preview of the subscription.

refresh

refresh(): Promise<void>

Implementation of StiggClient.refresh
- Defined in src/client.ts:387
Reload entitlements

Returns Promise<void>

removeListener

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

Implementation of StiggClient.removeListener
- Defined in src/client.ts:215
Remove a listener to stop handle updates of entitlements changes

Type parameters
- K: keyof Events
Parameters
- eventName: K
- listener: Events[K]
Returns void

setCustomerId

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

Implementation of StiggClient.setCustomerId
- Defined in src/client.ts:222
Set the customer ID, usually after the customer signs in or restores a session

Parameters
- customerId: string
- customerToken: null | string = null
- resourceId: null | string = null
Returns Promise<void>

setResource

setResource(resourceId: string): Promise<void>

Implementation of StiggClient.setResource
- Defined in src/client.ts:324
Set the customer's resource ID, usually after the customer select a specific resource.

Parameters
- resourceId: string
Returns Promise<void>

waitForCheckoutCompleted

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

Implementation of StiggClient.waitForCheckoutCompleted
- Defined in src/client.ts:918
Waits for a subscription to be activated after a completed checkout. This method should be called on page load after the customer is redirected to the success URL. Returns the new subscription.

Parameters
- __namedParameters: WaitForCheckoutCompleted = {}
Returns Promise<null | Subscription>

waitForInitialization

waitForInitialization(): Promise<StiggClient>

Implementation of StiggClient.waitForInitialization
- Defined in src/client.ts:160
Returns a Promise that tracks the client's initialization state.

The Promise will be resolved if the client successfully initializes, or rejected if client initialization has irrevocably failed.

Returns Promise<StiggClient>
Stigg client instance.

Static initialize

initialize(configuration: ClientConfiguration): StiggClient

- Defined in src/client.ts:122
Creates an instance of Stigg client.

Parameters
- configuration: ClientConfiguration
  
  configuration settings.
Returns StiggClient
The new client instance.

Generated using TypeDoc