Class Stigg

isWidgetWatermarkEnabled

isCustomerLoaded

• get isCustomerLoaded(): boolean

  Returns boolean

isResourceLoaded

• get isResourceLoaded(): boolean

  Returns boolean

addListener

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

  Add a listener to handle updates of entitlements changes

  Type Parameters

  • K extends keyof Events

  Parameters

  • eventName: K
  • listener: Events[K]

  Returns void

applySubscription

• applySubscription(
      applySubscriptionInput: ApplySubscription,
  ): Promise<ApplySubscriptionResults>

  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

  Clear the customer ID, usually after the customer signs out

  Returns void

clearResource

• clearResource(): void

  Unset the customer's resource ID, usually after the customer exit a specific resource.

  Returns void

createPaymentSession

• createPaymentSession(
      input: CreatePaymentSessionInput,
  ): Promise<PaymentSessionFragment>

  Create payment session

  Parameters

  • input: CreatePaymentSessionInput

    the input for the payment session

  Returns Promise<PaymentSessionFragment>

  the payment session data

estimateSubscription

• estimateSubscription(
      estimateSubscription: EstimateSubscription,
  ): Promise<SubscriptionPreview>

  Estimate subscription

  Parameters

  • estimateSubscription: EstimateSubscription

  Returns Promise<SubscriptionPreview>

  Preview of the subscription.

estimateSubscriptionUpdate

• estimateSubscriptionUpdate(
      estimateSubscriptionUpdate: EstimateSubscriptionUpdate,
  ): Promise<SubscriptionPreview>

  Estimate subscription update

  Parameters

  • estimateSubscriptionUpdate: EstimateSubscriptionUpdate

  Returns Promise<SubscriptionPreview>

  Preview of the subscription.

fetchUsageHistory

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

  Fetch customer usage history of a feature.

  Parameters

  • fetchUsageHistory: FetchUsageHistory

  Returns Promise<UsageHistoryPoint[] | undefined>

  Array of usage history as data points.

getActiveSubscriptions

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

  Parameters

  • __namedParameters: GetActiveSubscriptions = {}

  Returns Promise<Subscription[]>

getActiveSubscriptionsList

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

  Parameters

  • resourceId: GetActiveSubscriptions = {}

    optional resource id, if not provided global resources will be fetched.

  Returns Promise<SlimSubscriptionFragmentV2Fragment[]>

  List of active subscriptions

  Description

  Get customer's active subscriptions, for extended subscription data use getSubscription

getAutomaticRechargeConfiguration

• getAutomaticRechargeConfiguration(
      input: GetAutoRechargeSettingsInput,
  ): Promise<AutoRechargeSettingsFragment>

  Get automatic recharge configuration

  Parameters

  • input: GetAutoRechargeSettingsInput

    the input for getting automatic recharge configuration

  Returns Promise<AutoRechargeSettingsFragment>

  the automatic recharge configuration

getBooleanEntitlement

• getBooleanEntitlement(featureId: GetBooleanEntitlement): BooleanEntitlement

  Get boolean entitlement of feature for a customer

  Parameters

  • featureId: GetBooleanEntitlement

  Returns BooleanEntitlement

  boolean entitlement

getCheckoutState

• getCheckoutState(parameters: GetCheckoutState): Promise<GetCheckoutStateResults>

  Get customer checkout details

  Parameters

  • parameters: GetCheckoutState

  Returns Promise<GetCheckoutStateResults>

getCoupons

• getCoupons(): Promise<Coupon[]>

  Get a list of coupons

  Returns Promise<Coupon[]>

getCreditBalance

• getCreditBalance(
      input?: GetCreditBalanceInput,
  ): Promise<CreditsBalanceSummaryFragment>

  Get credit balance

  Parameters

  • input: GetCreditBalanceInput = {}

    the input for the credit balance

  Returns Promise<CreditsBalanceSummaryFragment>

  the credit balance data

  Deprecated

  Use getCreditEntitlement instead.

getCreditEntitlement

• getCreditEntitlement(currencyId: GetCreditEntitlement): CreditEntitlement

  Get credit entitlement for a customer by currency ID

  Parameters

  • currencyId: GetCreditEntitlement

  Returns CreditEntitlement

  credit entitlement

getCreditGrants

• getCreditGrants(input: GetCreditGrantsInput): Promise<GetCreditGrantsResult>

  Get credit grants

  Parameters

  • input: GetCreditGrantsInput

    the input for the credit grants

  Returns Promise<GetCreditGrantsResult>

  paginated result of the credit grants data

getCreditLedger

• getCreditLedger(input?: GetCreditLedgerInput): Promise<GetCreditLedgerResult>

  Get credit ledger

  Parameters

  • input: GetCreditLedgerInput = {}

    the input for the credit ledger

  Returns Promise<GetCreditLedgerResult>

  paginated result of the credit ledger data

getCreditUsage

• getCreditUsage(input: GetCreditUsageInput): Promise<CreditUsageFragment>

  Parameters

  • input: GetCreditUsageInput

  Returns Promise<CreditUsageFragment>

getCustomer

• getCustomer(): Promise<Customer>

  Get a customer

  Returns Promise<Customer>

getCustomerPortal

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

  Get a customer portal

  Parameters

  • __namedParameters: GetCustomerPortal = {}

  Returns Promise<CustomerPortal>

getEntitlements

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

  Get a list of entitlements

  Parameters

  • OptionalresourceId: string

  Returns Promise<Entitlement[]>

  Deprecated

  Use getEntitlementsState instead.

getEntitlementsState

• getEntitlementsState(resourceId?: string): Promise<EntitlementsState>

  Get a list of entitlements alongside an access denied reason if applicable.

  Parameters

  • OptionalresourceId: string

  Returns Promise<EntitlementsState>

getEnumEntitlement

• getEnumEntitlement(featureId: GetEnumEntitlement): EnumEntitlement

  Get enum entitlement of feature for a customer

  Parameters

  • featureId: GetEnumEntitlement

  Returns EnumEntitlement

  enum entitlement

getMeteredEntitlement

• getMeteredEntitlement(featureId: GetMeteredEntitlement): MeteredEntitlement

  Get metered entitlement of feature for a customer

  Parameters

  • featureId: GetMeteredEntitlement

  Returns MeteredEntitlement

  metered entitlement

getNumericEntitlement

• getNumericEntitlement(featureId: GetNumericEntitlement): NumericEntitlement

  Get numeric entitlement of feature for a customer

  Parameters

  • featureId: GetNumericEntitlement

  Returns NumericEntitlement

  numeric entitlement

getPaywall

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

  Get paywall data for rendering the paywall

  Parameters

  • __namedParameters: GetPaywall = {}

  Returns Promise<Paywall>

  Deprecated

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

getShowWatermark

• getShowWatermark(): boolean

  Returns boolean

getSubscription

• getSubscription(subscriptionId: GetSubscription): Promise<Subscription>

  Get subscription

  Parameters

  • subscriptionId: GetSubscription

    subscription id

  Returns Promise<Subscription>

  the subscription data

getSubscriptions

• getSubscriptions(
      params?: GetSubscriptionsParams,
  ): Promise<GetSubscriptionsResult>

  Parameters

  • params: GetSubscriptionsParams = {}

  Returns Promise<GetSubscriptionsResult>

getUsageHistoryV2

• getUsageHistoryV2(input: UsageHistoryV2Input): Promise<UsageHistoryV2Fragment>

  Get customer usage history of a feature.

  Parameters

  • input: UsageHistoryV2Input

  Returns Promise<UsageHistoryV2Fragment>

previewNextInvoice

• previewNextInvoice(
      previewNextInvoice: PreviewNextInvoice,
  ): Promise<SubscriptionInvoicePreviewFragment>

  Preview the subscription next invoice

  Parameters

  • previewNextInvoice: PreviewNextInvoice

  Returns Promise<SubscriptionInvoicePreviewFragment>

  Preview of the next invoice.

previewSubscription

• previewSubscription(
      previewSubscription: PreviewSubscription,
  ): Promise<SubscriptionPreviewV2>

  Preview subscription provisioning\updates

  Parameters

  • previewSubscription: PreviewSubscription

  Returns Promise<SubscriptionPreviewV2>

  Preview of the subscription.

refresh

• refresh(): Promise<void>

  Reload entitlements

  Returns Promise<void>

removeListener

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

  Remove a listener to stop handle updates of entitlements changes

  Type Parameters

  • K extends keyof Events

  Parameters

  • eventName: K
  • listener: Events[K]

  Returns void

saveAutomaticRechargeConfiguration

• saveAutomaticRechargeConfiguration(
      input: SaveAutoRechargeSettingsInput,
  ): Promise<AutoRechargeSettingsFragment>

  Save automatic recharge configuration

  Parameters

  • input: SaveAutoRechargeSettingsInput

    the input for saving automatic recharge configuration

  Returns Promise<AutoRechargeSettingsFragment>

  the saved automatic recharge configuration

setCustomerId

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

  Set the customer ID, usually after the customer signs in or restores a session

  Parameters

  • customerId: string
  • customerToken: string | null = null
  • resourceId: string | null = null

  Returns Promise<void>

setResource

• setResource(resourceId: string): Promise<void>

  Set the customer's resource ID, usually after the customer select a specific resource.

  Parameters

  • resourceId: string

  Returns Promise<void>

waitForCheckoutCompleted

• waitForCheckoutCompleted(
      timeoutMs?: WaitForCheckoutCompleted,
  ): Promise<Subscription | null>

  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

  • timeoutMs: WaitForCheckoutCompleted = {}

  Returns Promise<Subscription | null>

waitForInitialization

• waitForInitialization(): Promise<StiggClient>

  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.

Staticinitialize

• initialize(configuration: ClientConfiguration): StiggClient

  Creates an instance of Stigg client. Overridden at module load time by initializeStigg to add offline mode support.

  Parameters

  • configuration: ClientConfiguration

    configuration settings.

  Returns StiggClient

  The new client instance.