checkly 9.2.0 → 9.3.0

package/dist/rest/usage.d.ts

@@ -0,0 +1,130 @@
+import type { AxiosInstance } from 'axios';
+export declare const USAGE_INTERVALS: readonly ["total", "day", "week", "month"];
+export type UsageInterval = typeof USAGE_INTERVALS[number];
+export declare const USAGE_GROUP_BY: readonly ["account", "checkType", "account,checkType"];
+export type UsageGroupBy = typeof USAGE_GROUP_BY[number];
+export type UsageWarningCode = 'PARTIAL_WINDOW' | 'USAGE_TERMS_FLAGGED' | 'UNKNOWN_BUDGET';
+export type UsageErrorCode = 'ACCOUNT_NOT_IN_USAGE_TERMS' | 'INVALID_CURSOR' | 'INVALID_RANGE' | 'NO_USAGE_TERMS' | 'USAGE_STORE_UNAVAILABLE' | 'USAGE_TERMS_CONFLICT';
+export interface UsageTermsParams {
+    /** YYYY-MM-DD, inclusive. Resolves the usage terms that cover this date. Defaults to today. */
+    to?: string;
+}
+export interface UsageRangeParams extends UsageTermsParams {
+    /** YYYY-MM-DD, inclusive. */
+    from?: string;
+    accountIds?: string[];
+    checkTypes?: string[];
+}
+export interface UsageSeriesParams extends UsageRangeParams {
+    interval?: UsageInterval;
+    groupBy?: UsageGroupBy;
+    limit?: number;
+    nextId?: string;
+}
+export interface UsageAccount {
+    id: string;
+    name: string;
+}
+export interface UsageTerms {
+    id: string;
+    name: string;
+    accounts: UsageAccount[];
+    contractStartDate: string;
+    contractEndDate: string;
+    usageStartDate: string;
+    creditBudget: number | null;
+    standardCreditsPerUnit: number | null;
+    premiumCreditsPerUnit: number | null;
+}
+export interface UsageCredits {
+    used: number | null;
+    percentOfBudget: number | null;
+}
+export interface CheckRunMeasures {
+    totalRuns: number;
+    finalRuns: number;
+    retryRuns: number;
+    cancelledRuns: number;
+    multiStepRequests: number;
+    playwrightBillableDurationMs: number;
+    degradedRuns: number;
+    failedRuns: number;
+    errorRuns: number;
+    abortedRuns: number;
+    overMaxResponseTimeRuns: number;
+    standardBillableUnits: number;
+    premiumBillableUnits: number;
+}
+export interface AiInvocationMeasures {
+    invocations: number;
+    durationMs: number;
+}
+export type UsageMeter = {
+    meterType: 'CHECK_RUN';
+    measures: CheckRunMeasures;
+} | {
+    meterType: 'AI_INVOCATION';
+    measures: AiInvocationMeasures;
+};
+export interface UsageMetrics {
+    credits: UsageCredits;
+    meters: UsageMeter[];
+}
+export interface UsageWarning {
+    code: UsageWarningCode;
+    message: string;
+}
+export interface UsageProjectionWindow {
+    usage: UsageMetrics;
+    projectedAnnualPercentOfBudget: number | null;
+    projectedCreditsAtContractEnd: number | null;
+    projectedPercentAtContractEnd: number | null;
+    projectedWeeksUntilExhausted: number | null;
+}
+export interface UsageProjections {
+    weeksSinceStart: number;
+    weeksRemaining: number;
+    remainingCredits: number | null;
+    windows: {
+        sinceStart: UsageProjectionWindow;
+        last30Days: UsageProjectionWindow;
+        last7Days: UsageProjectionWindow;
+        last1Day: UsageProjectionWindow;
+    };
+}
+export interface UsageSummary {
+    usageTermsId: string;
+    period: {
+        from: string;
+        to: string;
+    };
+    totals: UsageMetrics;
+    projections: UsageProjections;
+}
+export interface UsageRow extends UsageMetrics {
+    periodStart: string;
+    periodEnd: string;
+    accountId?: string;
+    checkType?: string;
+}
+export interface UsageSeries {
+    usageTermsId: string;
+    period: {
+        from: string;
+        to: string;
+        interval: UsageInterval;
+        groupBy: UsageGroupBy;
+    };
+    data: UsageRow[];
+    length: number;
+    nextId: string | null;
+    warnings: UsageWarning[];
+}
+declare class Usage {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getTerms(params?: UsageTermsParams): Promise<import("axios").AxiosResponse<UsageTerms, any, {}, any>>;
+    getSummary(params?: UsageRangeParams): Promise<import("axios").AxiosResponse<UsageSummary, any, {}, any>>;
+    getSeries(params?: UsageSeriesParams): Promise<import("axios").AxiosResponse<UsageSeries, any, {}, any>>;
+}
+export default Usage;

package/dist/rest/usage.js

@@ -0,0 +1,38 @@
+export const USAGE_INTERVALS = ['total', 'day', 'week', 'month'];
+export const USAGE_GROUP_BY = ['account', 'checkType', 'account,checkType'];
+// The API accepts repeated or comma-separated values. Axios would serialize
+// arrays as `accountIds[]=...`, which the API does not parse as a list, so join them.
+function toQuery(params) {
+    const query = {};
+    const set = (key, value) => {
+        if (value !== undefined)
+            query[key] = value;
+    };
+    const joined = (values) => (values?.length ? values.join(',') : undefined);
+    set('from', params.from);
+    set('to', params.to);
+    set('accountIds', joined(params.accountIds));
+    set('checkTypes', joined(params.checkTypes));
+    set('interval', params.interval);
+    set('groupBy', params.groupBy);
+    set('limit', params.limit);
+    set('nextId', params.nextId);
+    return query;
+}
+class Usage {
+    api;
+    constructor(api) {
+        this.api = api;
+    }
+    getTerms(params = {}) {
+        return this.api.get('/v1/usage/terms', { params: toQuery(params) });
+    }
+    getSummary(params = {}) {
+        return this.api.get('/v1/usage/summary', { params: toQuery(params) });
+    }
+    getSeries(params = {}) {
+        return this.api.get('/v1/usage/series', { params: toQuery(params) });
+    }
+}
+export default Usage;
+//# sourceMappingURL=usage.js.map

package/dist/rest/usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/rest/usage.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAU,CAAA;AAGzE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,mBAAmB,CAAU,CAAA;AAoIpF,4EAA4E;AAC5E,sFAAsF;AACtF,SAAS,OAAO,CAAE,MAAyB;IACzC,MAAM,KAAK,GAA+B,EAAE,CAAA;IAC5C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,KAA6B,EAAE,EAAE;QACzD,IAAI,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAC7C,CAAC,CAAA;IACD,MAAM,MAAM,GAAG,CAAC,MAA4B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEhG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IACxB,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAA;IACpB,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC5C,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC5C,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;IAChC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;IAC9B,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IAC1B,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IAC5B,OAAO,KAAK,CAAA;AACd,CAAC;AAED,MAAM,KAAK;IACT,GAAG,CAAe;IAClB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,QAAQ,CAAE,SAA2B,EAAE;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAa,iBAAiB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACjF,CAAC;IAED,UAAU,CAAE,SAA2B,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,mBAAmB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACrF,CAAC;IAED,SAAS,CAAE,SAA4B,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,kBAAkB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACnF,CAAC;CACF;AAED,eAAe,KAAK,CAAA"}