Class: CatalogService
Defined in: javascript/src/bursar.ts:114
Catalog operations. Configuration writes live here, never in BillingService.
Constructors
Constructor
new CatalogService(
credits):CatalogService
Defined in: javascript/src/bursar.ts:115
Parameters
credits
CatalogCreditsService
Returns
CatalogService
Accessors
isLoaded
Get Signature
get isLoaded():
boolean
Defined in: javascript/src/bursar.ts:123
Whether this process currently has a pricing engine loaded.
Returns
boolean
Methods
activate()
activate(
version,rollout?):Promise<string>
Defined in: javascript/src/bursar.ts:156
Parameters
version
number
rollout?
CatalogRollout | null
Returns
Promise<string>
applyDueChanges()
applyDueChanges(
limit?):Promise<number>
Defined in: javascript/src/bursar.ts:174
Apply one bounded batch of renewal-effective plan changes.
Parameters
limit?
number = 100
Returns
Promise<number>
getActive()
getActive():
Promise<CatalogRevision|null>
Defined in: javascript/src/bursar.ts:118
Return the active persisted catalog revision, if one exists.
Returns
Promise<CatalogRevision | null>
getConfig()
getConfig():
Promise<ParsedBursarConfig>
Defined in: javascript/src/bursar.ts:142
Returns
Promise<ParsedBursarConfig>
invalidate()
invalidate():
void
Defined in: javascript/src/bursar.ts:138
Force the next refresh to reload the active catalog.
Returns
void
load()
load():
Promise<void>
Defined in: javascript/src/bursar.ts:128
Load the active persisted catalog into this process.
Returns
Promise<void>
publicView()
publicView():
Promise<PublicCatalog>
Defined in: javascript/src/bursar.ts:148
Returns
Promise<PublicCatalog>
publishAndActivate()
publishAndActivate(
config,label?,rollout?):Promise<string>
Defined in: javascript/src/bursar.ts:160
Parameters
config
BursarConfig
label?
string | null
rollout?
CatalogRollout | null
Returns
Promise<string>
publishDraft()
publishDraft(
config,label?):Promise<string>
Defined in: javascript/src/bursar.ts:152
Parameters
config
BursarConfig
label?
string | null
Returns
Promise<string>
refresh()
refresh():
Promise<void>
Defined in: javascript/src/bursar.ts:133
Block until a stale in-process catalog has been refreshed.
Returns
Promise<void>
setRevisionPin()
setRevisionPin(
userId,pinned):Promise<boolean>
Defined in: javascript/src/bursar.ts:169
Pin or unpin one current assignment from automatic catalog rollout.
Parameters
userId
string
pinned
boolean
Returns
Promise<boolean>