Stigg | @stigg/node-server-sdk

Stigg Node.js SDK client

Hierarchy

Stigg

Implements

Methods

addListener

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

Implementation of StiggEntitlementAPI.addListener
- Defined in src/client.ts:118
Add a listener to get real-time updates of entitlement and usage changes

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

cancelSubscription

cancelSubscription(cancelSubscription: CancelSubscription): Promise<Subscription>

Implementation of StiggManagementAPI.cancelSubscription
- Defined in src/client.ts:763
Create a Subscription

Parameters
- cancelSubscription: CancelSubscription
Returns Promise<Subscription>
Canceled subscription. Throw exception on errors.

cancelSubscriptionScheduledUpdates

cancelSubscriptionScheduledUpdates(cancelSubscriptionScheduledUpdates: CancelSubscriptionScheduledUpdates): Promise<{ subscriptionId: string }>

- Defined in src/client.ts:935
Cancel a subscription scheduled updates

Parameters
- cancelSubscriptionScheduledUpdates: CancelSubscriptionScheduledUpdates
Returns Promise<{ subscriptionId: string }>
The subscription id

close

close(): void

- Defined in src/client.ts:170
Discards all network connections, background tasks, and other resources held by the client.

Do not attempt to use the client after calling this method.

Returns void

createCustomer

createCustomer(input: CreateCustomer): Promise<SlimCustomer>

Implementation of StiggManagementAPI.createCustomer
- Defined in src/client.ts:582
Create a Customer.

deprecated
use provisionCustomer instead to create both customer and subscription in single operation. See provisionCustomer for more info.

Parameters
- input: CreateCustomer
Returns Promise<SlimCustomer>
Newly created customer. Throw exception on errors.

createSubscription

createSubscription(createSubscription: CreateSubscription): Promise<Subscription>

Implementation of StiggManagementAPI.createSubscription
- Defined in src/client.ts:698
Create a Subscription

deprecated
use provisionSubscription instead to create subscription or checkout session according to customer and subscription payment requirements. See provisionSubscription for more info.

Parameters
- createSubscription: CreateSubscription
Returns Promise<Subscription>
Newly created subscription. Throw exception on errors.

estimateSubscription

estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>

Implementation of StiggManagementAPI.estimateSubscription
- Defined in src/client.ts:885
Estimate subscription

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

estimateSubscriptionUpdate

estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>

Implementation of StiggManagementAPI.estimateSubscriptionUpdate
- Defined in src/client.ts:909
Estimate subscription update

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

getActiveSubscriptions

getActiveSubscriptions(__namedParameters: GetActiveSubscriptions): Promise<FullSubscription[]>

Implementation of StiggManagementAPI.getActiveSubscriptions
- Defined in src/client.ts:668
Get customer's active subscriptions.

Parameters
- __namedParameters: GetActiveSubscriptions
Returns Promise<FullSubscription[]>
List of active subscriptions.

getBooleanEntitlement

getBooleanEntitlement(__namedParameters: GetBooleanEntitlement): Promise<BooleanEntitlement>

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

Parameters
- __namedParameters: GetBooleanEntitlement
Returns Promise<BooleanEntitlement>
boolean entitlement.

getCoupons

getCoupons(): Promise<Coupon[]>

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

Returns Promise<Coupon[]>

getCustomer

getCustomer(customerId: string): Promise<FullCustomer>

- Defined in src/client.ts:639
Get a Customer.

Parameters
- customerId: string
  
  customer id
Returns Promise<FullCustomer>
Full customer details.

getEntitlements

getEntitlements(customerId: string, resourceId?: string): Promise<undefined | Entitlement[] | ({ accessDeniedReason: AccessDeniedReason; feature: { id: string }; hasAccess: boolean; isFallback: boolean } | { accessDeniedReason: AccessDeniedReason; feature: { id: string }; hasAccess: boolean; isFallback: boolean; isUnlimited?: boolean; value?: number } | { accessDeniedReason: AccessDeniedReason; feature: { id: string }; hasAccess: boolean; isFallback: boolean; isUnlimited?: boolean; usageLimit?: number })[]>

- Defined in src/client.ts:331
Get entitlements per user

Parameters
- customerId: string
- Optional resourceId: string
Returns Promise<undefined | Entitlement[] | ({ accessDeniedReason: AccessDeniedReason; feature: { id: string }; hasAccess: boolean; isFallback: boolean } | { accessDeniedReason: AccessDeniedReason; feature: { id: string }; hasAccess: boolean; isFallback: boolean; isUnlimited?: boolean; value?: number } | { accessDeniedReason: AccessDeniedReason; feature: { id: string }; hasAccess: boolean; isFallback: boolean; isUnlimited?: boolean; usageLimit?: number })[]>

getMeteredEntitlement

getMeteredEntitlement(__namedParameters: GetMeteredEntitlement): Promise<MeteredEntitlement>

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

Parameters
- __namedParameters: GetMeteredEntitlement
Returns Promise<MeteredEntitlement>
metered entitlement

getNumericEntitlement

getNumericEntitlement(__namedParameters: GetNumericEntitlement): Promise<NumericEntitlement>

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

Parameters
- __namedParameters: GetNumericEntitlement
Returns Promise<NumericEntitlement>
numeric entitlement

getPaywall

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

Implementation of StiggManagementAPI.getPaywall
- Defined in src/client.ts:818
Get the paywall data

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

getProducts

getProducts(): Promise<Product[]>

Implementation of StiggManagementAPI.getProducts
- Defined in src/client.ts:869
Get a list of products

Returns Promise<Product[]>

importCustomer

importCustomer(__namedParameters: ImportCustomer): Promise<SlimCustomer>

Implementation of StiggManagementAPI.importCustomer
- Defined in src/client.ts:432
Import a Customer from billing integration. Private information such as email and name are not imported and needs to be send in order to be persisted in Stigg. Active billing integration is required for this functionality.

Parameters
- __namedParameters: ImportCustomer
Returns Promise<SlimCustomer>
Newly created customer. Throw exception on errors.

importCustomerBulk

importCustomerBulk(__namedParameters: ImportCustomerBulk): Promise<void>

Implementation of StiggManagementAPI.importCustomerBulk
- Defined in src/client.ts:405
Parameters
- __namedParameters: ImportCustomerBulk
Returns Promise<void>

importSubscriptionBulk

importSubscriptionBulk(__namedParameters: ImportSubscriptionBulk): Promise<void>

Implementation of StiggManagementAPI.importSubscriptionBulk
- Defined in src/client.ts:459
Parameters
- __namedParameters: ImportSubscriptionBulk
Returns Promise<void>

initiateCheckout

initiateCheckout(initiateCheckout: InitiateCheckout): Promise<Checkout>

Implementation of StiggManagementAPI.initiateCheckout
- Defined in src/client.ts:794
Initiate a checkout to purchase a plan

deprecated
use provisionSubscription instead to create subscription or checkout session according to customer and subscription payment requirements. See provisionSubscription for more info.

Parameters
- initiateCheckout: InitiateCheckout
Returns Promise<Checkout>
Container object for the checkout process. Throw exception on errors.

migrateSubscriptionToLatest

migrateSubscriptionToLatest(migrateSubscriptionToLatest: MigrateSubscriptionToLatest): Promise<{ subscriptionId: string }>

- Defined in src/client.ts:965
Migrate subscription to latest plan and addons version and pricing. using SubscriptionMigrationTime.EndOfBillingPeriod is possible only if Stripe integration is enabled and will migrate the subscription in the end of the current billing period. Using Immediate will perform the migration imidietly. Default, migration will happen imidietly.

Parameters
- migrateSubscriptionToLatest: MigrateSubscriptionToLatest
Returns Promise<{ subscriptionId: string }>
The subscription id

provisionCustomer

provisionCustomer(__namedParameters: ProvisionCustomer): Promise<ProvisionedCustomer>

Implementation of StiggManagementAPI.provisionCustomer
- Defined in src/client.ts:489
Create a Customer and its first subscription

Parameters
- __namedParameters: ProvisionCustomer
Returns Promise<ProvisionedCustomer>
Newly created customer and subscription. Throw exception on errors.

provisionSubscription

provisionSubscription(provisionSubscription: ProvisionSubscription): Promise<ProvisionSubscriptionResult>

Implementation of StiggManagementAPI.provisionSubscription
- Defined in src/client.ts:545
Provision a Subscription.

Parameters
- provisionSubscription: ProvisionSubscription
Returns Promise<ProvisionSubscriptionResult>
Provision subscription result. Throw exception on errors.

removeListener

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

- Defined in src/client.ts:127
Remove a listener to stop handle updates of entitlements changes and usage changes

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

reportUsage

reportUsage(__namedParameters: ReportUsage): Promise<ReportUsageAck>

Implementation of StiggEntitlementAPI.reportUsage
- Defined in src/client.ts:358
Report usage for metered entitlement

Parameters
- __namedParameters: ReportUsage
Returns Promise<ReportUsageAck>

updateCustomer

updateCustomer(__namedParameters: UpdateCustomer): Promise<SlimCustomer>

- Defined in src/client.ts:600
Update a Customer.

Parameters
- __namedParameters: UpdateCustomer
Returns Promise<SlimCustomer>
Updated customer. Throw exception on errors.

updateSubscription

updateSubscription(updateSubscription: UpdateSubscription): Promise<Subscription>

Implementation of StiggManagementAPI.updateSubscription
- Defined in src/client.ts:733
Update a Subscription

Parameters
- updateSubscription: UpdateSubscription
Returns Promise<Subscription>
updated subscription. Throw exception on errors.

waitForInitialization

waitForInitialization(): Promise<Stigg>

- Defined in src/client.ts:109
Returns Promise<Stigg>

Static initialize

initialize(configuration: ClientConfiguration): Stigg

- Defined in src/client.ts:136
Initialize an instance of the Stigg SDK client.

Parameters
- configuration: ClientConfiguration
  
  client configuration object provided by the consumer.
Returns Stigg
stigg SDK instance.

Hierarchy

Implements

Index

Methods

Methods

addListener

Type parameters

K: keyof Events

Parameters

eventName: K

listener: Events[K]

Returns void

cancelSubscription

Parameters

cancelSubscription: CancelSubscription

Returns Promise<Subscription>

cancelSubscriptionScheduledUpdates

Parameters

cancelSubscriptionScheduledUpdates: CancelSubscriptionScheduledUpdates

Returns Promise<{ subscriptionId: string }>

close

Returns void

createCustomer

Parameters

input: CreateCustomer

Returns Promise<SlimCustomer>

createSubscription

Parameters

createSubscription: CreateSubscription

Returns Promise<Subscription>

estimateSubscription

Parameters

estimateSubscription: EstimateSubscription

Returns Promise<SubscriptionPreview>

estimateSubscriptionUpdate

Parameters

estimateSubscriptionUpdate: EstimateSubscriptionUpdate

Returns Promise<SubscriptionPreview>

getActiveSubscriptions

Parameters

__namedParameters: GetActiveSubscriptions

Returns Promise<FullSubscription[]>

getBooleanEntitlement

Parameters

__namedParameters: GetBooleanEntitlement

Returns Promise<BooleanEntitlement>

getCoupons

Returns Promise<Coupon[]>

getCustomer

Parameters

customerId: string

Returns Promise<FullCustomer>

getEntitlements

Parameters

customerId: string

Optional resourceId: string

getMeteredEntitlement

Parameters

__namedParameters: GetMeteredEntitlement

Returns Promise<MeteredEntitlement>

getNumericEntitlement

Parameters

__namedParameters: GetNumericEntitlement

Returns Promise<NumericEntitlement>

getPaywall

Parameters

__namedParameters: GetPaywall = {}

Returns Promise<Paywall>

getProducts

Returns Promise<Product[]>

importCustomer

Parameters

__namedParameters: ImportCustomer

Returns Promise<SlimCustomer>

importCustomerBulk

Parameters

__namedParameters: ImportCustomerBulk

Returns Promise<void>

importSubscriptionBulk

Parameters