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:154
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

applySubscription

applySubscription(applySubscriptionInput: ApplySubscription): Promise<ApplySubscriptionResults>

Implementation of StiggManagementAPI.applySubscription
- Defined in src/client.ts:931
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>

archiveCustomer

archiveCustomer(customerId: string): Promise<string>

Implementation of StiggManagementAPI.archiveCustomer
- Defined in src/client.ts:781
Parameters
- customerId: string
Returns Promise<string>

cancelSubscription

cancelSubscription(cancelSubscription: CancelSubscription): Promise<Subscription>

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

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

cancelSubscriptionScheduledUpdates

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

Implementation of StiggManagementAPI.cancelSubscriptionScheduledUpdates
- Defined in src/client.ts:1134
Cancel a subscription scheduled updates

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

close

close(): void

- Defined in src/client.ts:210
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:668
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:863
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:1060
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:1084
Estimate subscription update

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

fetchUsageHistory

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

- Defined in src/client.ts:641
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<FullSubscription[]>

Implementation of StiggManagementAPI.getActiveSubscriptions
- Defined in src/client.ts:833
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:267
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:1028
Get a list of coupons

Returns Promise<Coupon[]>

getCustomer

getCustomer(customerId: string): Promise<FullCustomer>

Implementation of StiggManagementAPI.getCustomer
- Defined in src/client.ts:730
Get a Customer.

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

getCustomerStatistics

getCustomerStatistics(customerId: string): Promise<CustomerStatisticsModel>

Implementation of StiggManagementAPI.getCustomerStatistics
- Defined in src/client.ts:758
Get Customer Statistics.

Parameters
- customerId: string
  
  customer id
Returns Promise<CustomerStatisticsModel>
customer statistics.

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:372
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:339
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:303
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:993
Get the paywall data

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

getProducts

getProducts(): Promise<Product[]>

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

Returns Promise<Product[]>

grantPromotionalEntitlements

grantPromotionalEntitlements(input: GrantPromotionalEntitlementsInput): Promise<PromotionalEntitlementFragment[]>

Implementation of StiggManagementAPI.grantPromotionalEntitlements
- Defined in src/client.ts:1210
Parameters
- input: GrantPromotionalEntitlementsInput
Returns Promise<PromotionalEntitlementFragment[]>

importCustomer

importCustomer(__namedParameters: ImportCustomer): Promise<SlimCustomer>

Implementation of StiggManagementAPI.importCustomer
- Defined in src/client.ts:492
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:465
Parameters
- __namedParameters: ImportCustomerBulk
Returns Promise<void>

importSubscriptionBulk

importSubscriptionBulk(__namedParameters: ImportSubscriptionBulk): Promise<void>

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

migrateSubscriptionToLatest

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

- Defined in src/client.ts:1165
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

previewSubscription

previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>

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

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

provisionCustomer

provisionCustomer(__namedParameters: ProvisionCustomer): Promise<ProvisionedCustomer>

Implementation of StiggManagementAPI.provisionCustomer
- Defined in src/client.ts:549
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:610
Provision a Subscription.

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

reloadEntitlements

reloadEntitlements(customerId: string, resourceId?: string): Promise<{ entitledEntityExists: undefined | boolean }>

- Defined in src/client.ts:1250
Reload entitlements of a customer or customer resource. Note: this method skips the Edge API, so use it only when you need "read-after-write" consistency after entitlements presumably have changed.

Parameters
- customerId: string
- Optional resourceId: string
Returns Promise<{ entitledEntityExists: undefined | boolean }>

removeListener

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

- Defined in src/client.ts:163
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

reportEvent

reportEvent(events: ReportEvent | ReportEvent[]): Promise<void>

Implementation of StiggEntitlementAPI.reportEvent
- Defined in src/client.ts:395
Report usage event

Parameters
- events: ReportEvent | ReportEvent[]
Returns Promise<void>

reportUsage

reportUsage(__namedParameters: ReportUsage): Promise<ReportUsageAck>

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

Parameters
- __namedParameters: ReportUsage
Returns Promise<ReportUsageAck>

revokePromotionalEntitlements

revokePromotionalEntitlements(input: RevokePromotionalEntitlementInput): Promise<{ id: string }>

Implementation of StiggManagementAPI.revokePromotionalEntitlements
- Defined in src/client.ts:1227
Parameters
- input: RevokePromotionalEntitlementInput
Returns Promise<{ id: string }>

transferSubscription

transferSubscription(input: TransferSubscriptionInput): Promise<Subscription>

Implementation of StiggManagementAPI.transferSubscription
- Defined in src/client.ts:1193
Transfer paid subscription from sourceResourceId to destinationResourceId. sourceResourceId must have a paid active subscription. destinationResourceId must have a free active subscription.

Parameters
- input: TransferSubscriptionInput
Returns Promise<Subscription>
The subscription connected to destinationResource.

unarchiveCustomer

unarchiveCustomer(customerId: string): Promise<SlimCustomer>

Implementation of StiggManagementAPI.unarchiveCustomer
- Defined in src/client.ts:804
Parameters
- customerId: string
Returns Promise<SlimCustomer>

updateCustomer

updateCustomer(__namedParameters: UpdateCustomer): Promise<SlimCustomer>

Implementation of StiggManagementAPI.updateCustomer
- Defined in src/client.ts:687
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:899
Update a Subscription

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

waitForInitialization

waitForInitialization(): Promise<Stigg>

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

Static initialize

initialize(configuration: ClientConfiguration): Stigg

- Defined in src/client.ts:172
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

applySubscription

Parameters

applySubscriptionInput: ApplySubscription

Returns Promise<ApplySubscriptionResults>

archiveCustomer

Parameters

customerId: string

Returns Promise<string>

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>

fetchUsageHistory

Parameters

fetchUsageHistory: FetchUsageHistory

Returns Promise<undefined | UsageHistoryPoint[]>

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>

getCustomerStatistics

Parameters

customerId: string

Returns Promise<CustomerStatisticsModel>

getEntitlements

Parameters

customerId: string

Optional resourceId: string

getMeteredEntitlement

Parameters

__namedParameters: GetMeteredEntitlement

Returns Promise<MeteredEntitlement>

getNumericEntitlement

Parameters

__namedParameters: GetNumericEntitlement

Returns Promise<NumericEntitlement>