@stigg/node-server-sdk - v4.47.0
Preparing search index...
StiggEntitlementAPI
Interface StiggEntitlementAPI
interface
StiggEntitlementAPI
{
addListener
:
<
K
extends
keyof
Events
>
(
eventName
:
K
,
callback
:
Events
[
K
]
,
)
=>
void
;
consumeCredits
:
(
params
:
ConsumeCredits
)
=>
Promise
<
ConsumeCreditsResult
>
;
consumeCreditsAsync
:
(
params
:
ConsumeCreditsAsync
)
=>
Promise
<
void
>
;
getBooleanEntitlement
:
(
params
:
GetBooleanEntitlement
,
)
=>
Promise
<
BooleanEntitlement
>
;
getCreditEntitlement
:
(
params
:
GetCreditEntitlement
,
)
=>
Promise
<
CreditEntitlement
>
;
getEntitlement
:
(
params
:
GetEntitlement
)
=>
Promise
<
Entitlement
>
;
getEntitlementsStateV2
:
(
customerId
:
string
,
resourceId
?:
string
,
)
=>
Promise
<
CustomerEntitlementsResultV2
>
;
getEntitlementV2
:
(
params
:
GetEntitlementV2Params
,
)
=>
Promise
<
EntitlementV2
>
;
getEnumEntitlement
:
(
params
:
GetEnumEntitlement
,
)
=>
Promise
<
EnumEntitlement
>
;
getMeteredEntitlement
:
(
params
:
GetMeteredEntitlement
,
)
=>
Promise
<
MeteredEntitlement
>
;
getNumericEntitlement
:
(
params
:
GetNumericEntitlement
,
)
=>
Promise
<
NumericEntitlement
>
;
reportEvent
:
(
params
:
ReportEvent
|
ReportEvent
[]
)
=>
Promise
<
void
>
;
reportUsage
:
(
params
:
ReportUsage
)
=>
Promise
<
ReportUsageAck
>
;
reportUsageBulk
:
(
params
:
ReportUsageBulk
)
=>
Promise
<
ReportUsageAck
[]
>
;
}
Implemented by
Stigg
Index
Properties
add
Listener
consume
Credits
consume
Credits
Async
get
Boolean
Entitlement
get
Credit
Entitlement
get
Entitlement
get
Entitlements
State
V2
get
Entitlement
V2
get
Enum
Entitlement
get
Metered
Entitlement
get
Numeric
Entitlement
report
Event
report
Usage
report
Usage
Bulk
Properties
add
Listener
addListener
:
<
K
extends
keyof
Events
>
(
eventName
:
K
,
callback
:
Events
[
K
]
)
=>
void
consume
Credits
consumeCredits
:
(
params
:
ConsumeCredits
)
=>
Promise
<
ConsumeCreditsResult
>
consume
Credits
Async
consumeCreditsAsync
:
(
params
:
ConsumeCreditsAsync
)
=>
Promise
<
void
>
get
Boolean
Entitlement
getBooleanEntitlement
:
(
params
:
GetBooleanEntitlement
,
)
=>
Promise
<
BooleanEntitlement
>
get
Credit
Entitlement
getCreditEntitlement
:
(
params
:
GetCreditEntitlement
,
)
=>
Promise
<
CreditEntitlement
>
get
Entitlement
getEntitlement
:
(
params
:
GetEntitlement
)
=>
Promise
<
Entitlement
>
get
Entitlements
State
V2
getEntitlementsStateV2
:
(
customerId
:
string
,
resourceId
?:
string
,
)
=>
Promise
<
CustomerEntitlementsResultV2
>
get
Entitlement
V2
getEntitlementV2
:
(
params
:
GetEntitlementV2Params
)
=>
Promise
<
EntitlementV2
>
get
Enum
Entitlement
getEnumEntitlement
:
(
params
:
GetEnumEntitlement
)
=>
Promise
<
EnumEntitlement
>
get
Metered
Entitlement
getMeteredEntitlement
:
(
params
:
GetMeteredEntitlement
,
)
=>
Promise
<
MeteredEntitlement
>
get
Numeric
Entitlement
getNumericEntitlement
:
(
params
:
GetNumericEntitlement
,
)
=>
Promise
<
NumericEntitlement
>
report
Event
reportEvent
:
(
params
:
ReportEvent
|
ReportEvent
[]
)
=>
Promise
<
void
>
report
Usage
reportUsage
:
(
params
:
ReportUsage
)
=>
Promise
<
ReportUsageAck
>
report
Usage
Bulk
reportUsageBulk
:
(
params
:
ReportUsageBulk
)
=>
Promise
<
ReportUsageAck
[]
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
add
Listener
consume
Credits
consume
Credits
Async
get
Boolean
Entitlement
get
Credit
Entitlement
get
Entitlement
get
Entitlements
State
V2
get
Entitlement
V2
get
Enum
Entitlement
get
Metered
Entitlement
get
Numeric
Entitlement
report
Event
report
Usage
report
Usage
Bulk
@stigg/node-server-sdk - v4.47.0
Loading...