usage

Type aliases

AggregatedUsageEntity

Ƭ AggregatedUsageEntity: Partial<BillableUsageEntity> & { billableUsage: number ; count: number }


BillableUsageEntity

Ƭ BillableUsageEntity: BillableUsageResponseDTO

Variables

PossibleAggregationFields

Const PossibleAggregationFields: Set<string>

Functions

aggregateUsage

aggregateUsage(usages: BillableUsageEntity[], aggregationFields: Set<string>): AggregatedUsageEntity[]

Parameters:

NameType
usagesBillableUsageEntity[]
aggregationFieldsSet<string>

getUsage

getUsage(take: number | undefined, skip: number | undefined, filters: IFilter[] | undefined, options?: { account?: Account }): Promise<BillableUsageEntity[]>

Parameters:

NameType
takenumber | undefined
skipnumber | undefined
filtersIFilter[] | undefined
options?object
options.account?Account

Returns: Promise<BillableUsageEntity[]>


getUsageFilters

getUsageFilters(filters: IFilter[] | undefined, fillFilters: IFilter[], options?: { account?: Account }): Promise<IFilter[]>

Parameters:

NameType
filtersIFilter[] | undefined
fillFiltersIFilter[]
options?object
options.account?Account

Returns: Promise<IFilter[]>


getUsageForJob

getUsageForJob(jobId: string, options?: { account?: Account }): Promise<BillableUsageEntity[] | undefined>

Parameters:

NameType
jobIdstring
options?object
options.account?Account

Returns: Promise<BillableUsageEntity[] | undefined>

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.