Platform modulesModule reference3 values3 types

Quota Milestones

Threshold-crossing helpers and webhook payload delivery utilities for milestone-based quota notifications.

Configure threshold arrays in ascending percentages and ensure webhook retry/alert handling in callers.

checkMilestones

functioncheckMilestones

checkMilestones(orgId: string, projectId: string, operationType: OperationType, currentUsage: number, previousUsage: number, limit: number, thresholds: readonly number[] = MILESTONE_THRESHOLDS): CrossedMilestone[]

Parameters

Name	Type	Flags
orgId	string	required
projectId	string	required
operationType	OperationType	required
currentUsage	number	required
previousUsage	number	required
limit	number	required
thresholds	readonly number[]	optional

TypeScript SDKTypeScript

import { checkMilestones } from "@arelis-ai/arelis-governance-sdk";

// @arelis-ai/governance-quotas/milestones
// Signature: checkMilestones(orgId: string, projectId: string, operationType: OperationType, currentUsage: number, previousUsage: number, limit: number, thresholds: readonly number[] = MILESTONE_THRESHOLDS): CrossedMilestone[]

const result = await checkMilestones(...[] as unknown[]);
console.log(result);

Return

// Return type
CrossedMilestone[]

buildMilestonePayload

functionbuildMilestonePayload

buildMilestonePayload(milestone: CrossedMilestone): MilestoneWebhookPayload

Parameters

Name	Type	Flags
milestone	CrossedMilestone	required

TypeScript SDKTypeScript

import { buildMilestonePayload } from "@arelis-ai/arelis-governance-sdk";

// @arelis-ai/governance-quotas/milestones
// Signature: buildMilestonePayload(milestone: CrossedMilestone): MilestoneWebhookPayload

const result = await buildMilestonePayload(...[] as unknown[]);
console.log(result);

Return

// Return type
MilestoneWebhookPayload

deliverWebhook

functiondeliverWebhook

deliverWebhook(url: string, payload: MilestoneWebhookPayload): Promise<{ success: boolean; statusCode?: number; error?: string }>

Parameters

Name	Type	Flags
url	string	required
payload	MilestoneWebhookPayload	required

TypeScript SDKTypeScript

import { deliverWebhook } from "@arelis-ai/arelis-governance-sdk";

// @arelis-ai/governance-quotas/milestones
// Signature: deliverWebhook(url: string, payload: MilestoneWebhookPayload): Promise<{ success: boolean; statusCode?: number; error?: string }>

const result = await deliverWebhook(...[] as unknown[]);
console.log(result);

Return

// Return type
Promise<{ success: boolean; statusCode?: number; error?: string }>