Interface: CreditStore
Defined in: javascript/src/stores/credit-store.ts:30
Interface for credit storage backends.
Methods
addCredits()
addCredits(
userId,amount,type?,metadata?,expiresAt?):Promise<AddCreditsResult>
Defined in: javascript/src/stores/credit-store.ts:33
Parameters
userId
string
amount
number
type?
string
metadata?
CreditMetadata | null
expiresAt?
Date | null
Returns
Promise<AddCreditsResult>
addTeamMember()
addTeamMember(
teamId,userId,role?,spendCap?):Promise<AddTeamMemberResult>
Defined in: javascript/src/stores/credit-store.ts:90
Parameters
teamId
string
userId
string
role?
string
spendCap?
number | null
Returns
Promise<AddTeamMemberResult>
aggregateStats()
aggregateStats(
start,end):Promise<AggregateStats>
Defined in: javascript/src/stores/credit-store.ts:85
Parameters
start
Date
end
Date
Returns
Promise<AggregateStats>
checkAllowance()
checkAllowance(
userId):Promise<AllowanceResult>
Defined in: javascript/src/stores/credit-store.ts:61
Parameters
userId
string
Returns
Promise<AllowanceResult>
checkFeature()
checkFeature(
userId,feature):Promise<CheckFeatureResult>
Defined in: javascript/src/stores/credit-store.ts:60
Parameters
userId
string
feature
string
Returns
Promise<CheckFeatureResult>
checkSpendCap()
checkSpendCap(
userId,model?,amount?):Promise<CapCheckResult>
Defined in: javascript/src/stores/credit-store.ts:65
Parameters
userId
string
model?
string | null
amount?
number
Returns
Promise<CapCheckResult>
createTeam()
createTeam(
name,initialBalance?):Promise<CreateTeamResult>
Defined in: javascript/src/stores/credit-store.ts:88
Parameters
name
string
initialBalance?
number
Returns
Promise<CreateTeamResult>
dailySpend()
dailySpend(
start,end):Promise<DailySpendRow[]>
Defined in: javascript/src/stores/credit-store.ts:82
Parameters
start
Date
end
Date
Returns
Promise<DailySpendRow[]>
deductCredits()
deductCredits(
userId,reservationId,amount,idempotencyKey?,metadata?):Promise<DeductionResult>
Defined in: javascript/src/stores/credit-store.ts:47
Parameters
userId
string
reservationId
string
amount
number
idempotencyKey?
string | null
metadata?
CreditMetadata | null
Returns
Promise<DeductionResult>
deductTeam()
deductTeam(
teamId,userId,amount,metadata?):Promise<TeamDeductionResult>
Defined in: javascript/src/stores/credit-store.ts:97
Parameters
teamId
string
userId
string
amount
number
metadata?
CreditMetadata | null
Returns
Promise<TeamDeductionResult>
getActivePricing()
getActivePricing():
Promise<PricingConfigResult|null>
Defined in: javascript/src/stores/credit-store.ts:54
Returns
Promise<PricingConfigResult | null>
getBalance()
getBalance(
userId):Promise<BalanceResult>
Defined in: javascript/src/stores/credit-store.ts:32
Parameters
userId
string
Returns
Promise<BalanceResult>
getTeamBalance()
getTeamBalance(
teamId):Promise<TeamBalanceResult>
Defined in: javascript/src/stores/credit-store.ts:89
Parameters
teamId
string
Returns
Promise<TeamBalanceResult>
getTeamMembers()
getTeamMembers(
teamId):Promise<TeamMember[]>
Defined in: javascript/src/stores/credit-store.ts:96
Parameters
teamId
string
Returns
Promise<TeamMember[]>
getUserPlan()
getUserPlan(
userId):Promise<GetUserPlanResult>
Defined in: javascript/src/stores/credit-store.ts:58
Parameters
userId
string
Returns
Promise<GetUserPlanResult>
incrementUsageWindow()
incrementUsageWindow(
userId,planId,amount):Promise<void>
Defined in: javascript/src/stores/credit-store.ts:62
Parameters
userId
string
planId
string
amount
number
Returns
Promise<void>
refundCredits()
refundCredits(
transactionId,amount?,reason?,metadata?):Promise<RefundResult>
Defined in: javascript/src/stores/credit-store.ts:68
Parameters
transactionId
string
amount?
number
reason?
string
metadata?
CreditMetadata | null
Returns
Promise<RefundResult>
reserveCredits()
reserveCredits(
userId,amount,operationType,metadata?,minBalance?):Promise<ReserveResult>
Defined in: javascript/src/stores/credit-store.ts:40
Parameters
userId
string
amount
number
operationType
string
metadata?
CreditMetadata | null
minBalance?
number
Returns
Promise<ReserveResult>
setActivePricing()
setActivePricing(
config,label?):Promise<string>
Defined in: javascript/src/stores/credit-store.ts:55
Parameters
config
label?
string | null
Returns
Promise<string>
setup()
setup(
databaseUrl?):Promise<SetupResult>
Defined in: javascript/src/stores/credit-store.ts:31
Parameters
databaseUrl?
string | null
Returns
Promise<SetupResult>
setUserPlan()
setUserPlan(
userId,planId):Promise<SetUserPlanResult>
Defined in: javascript/src/stores/credit-store.ts:59
Parameters
userId
string
planId
string
Returns
Promise<SetUserPlanResult>
spendByModel()
spendByModel(
start,end):Promise<SpendByModelRow[]>
Defined in: javascript/src/stores/credit-store.ts:80
Parameters
start
Date
end
Date
Returns
Promise<SpendByModelRow[]>
spendByUser()
spendByUser(
start,end):Promise<SpendByUserRow[]>
Defined in: javascript/src/stores/credit-store.ts:79
Parameters
start
Date
end
Date
Returns
Promise<SpendByUserRow[]>
sweepExpiredCredits()
sweepExpiredCredits(
dryRun?):Promise<SweepResult>
Defined in: javascript/src/stores/credit-store.ts:76
Parameters
dryRun?
boolean
Returns
Promise<SweepResult>
topUsers()
topUsers(
limit,start,end):Promise<TopUserRow[]>
Defined in: javascript/src/stores/credit-store.ts:81
Parameters
limit
number
start
Date
end
Date
Returns
Promise<TopUserRow[]>