@polymorfa/sdk 0.1.0-dev.20260923115544 → 0.1.0-dev.20260923132258

package/dist/platform/calls.d.ts

@@ -0,0 +1,175 @@
+import { CursorPage } from "../pagination.js";
+import { HttpTransport } from "../transport/http.js";
+import type { ApiResponse, RequestOptions } from "../transport/types.js";
+import type { ClientOwner } from "./developer-types.js";
+export type CallDirection = "inbound" | "outbound";
+/** How the number connects to WhatsApp. */
+export type CallUpstream = "linked_device" | "cloud_api";
+/**
+ * How the call went. `answered`: media connected, including answered calls
+ * still in progress. `declined`: declined by a participant or the other
+ * party, or the line was busy. `missed`: nobody answered before ringing
+ * stopped or the caller hung up. `failed`: ended before it connected for any
+ * other reason. `in_progress`: still ringing.
+ */
+export type CallOutcome = "answered" | "missed" | "declined" | "failed" | "in_progress";
+/** Call state. `offered` and `accepted` calls may still be live. */
+export type CallRecordState = "offered" | "accepted" | "rejected" | "missed" | "ended";
+export type CallStatsGroupBy = "day" | "hour" | "session" | "outcome";
+export type CallExportFormat = "csv" | "ndjson";
+/** One call detail record. The other party appears only as `peerRef`. */
+export interface CallRecord {
+    readonly callId: string;
+    /** Owning project when known, preserved after the number is deleted. */
+    readonly projectId: string | null;
+    /** Session name of the number that placed or received the call. */
+    readonly sessionId: string;
+    readonly direction: CallDirection;
+    readonly upstream: CallUpstream;
+    readonly outcome: CallOutcome;
+    readonly state: CallRecordState;
+    readonly hasVideo: boolean;
+    /**
+     * Team-specific pseudonym of the other party: the same party has the same
+     * value across your team's calls. Never a phone number. `null` when unknown.
+     */
+    readonly peerRef: string | null;
+    readonly startedAt: string;
+    readonly connectedAt: string | null;
+    readonly endedAt: string | null;
+    /** Connected seconds; 0 for a call that never connected, `null` until it ends. */
+    readonly durationSeconds: number | null;
+    /** Such as `user_hangup` or `ring_timeout`; `null` until the call ends. */
+    readonly endReason: string | null;
+}
+export interface CallStatsMetrics {
+    /** Calls that started in the range. */
+    readonly calls: number;
+    readonly answered: number;
+    readonly missed: number;
+    readonly declined: number;
+    readonly failed: number;
+    /** Calls still ringing. */
+    readonly inProgress: number;
+    /** `answered` divided by calls no longer ringing (four decimals), or `null` when there are none. */
+    readonly answerRate: number | null;
+    /** Connected seconds of answered calls. */
+    readonly totalDurationSeconds: number;
+    /** Mean connected seconds of ended answered calls (one decimal), or `null` when there are none. */
+    readonly averageDurationSeconds: number | null;
+}
+export interface CallStatsGroup extends CallStatsMetrics {
+    /**
+     * Local date (`2026-09-18`) for `day`, local hour (`2026-09-18T14:00`) for
+     * `hour`, session name for `session`, or the outcome for `outcome`.
+     */
+    readonly key: string;
+    /** Start of the day or hour bucket; `null` for `session` and `outcome` groups. */
+    readonly start: string | null;
+}
+export interface CallStatsHeatmapCell {
+    /** ISO day of week in `timezone`: 1 is Monday, 7 is Sunday. */
+    readonly dayOfWeek: number;
+    /** Hour of day in `timezone`, 0 to 23. */
+    readonly hour: number;
+    readonly calls: number;
+    readonly answered: number;
+}
+export interface CallStats {
+    readonly since: string;
+    readonly until: string;
+    readonly timezone: string;
+    readonly groupBy: CallStatsGroupBy;
+    readonly totals: CallStatsMetrics;
+    readonly groups: readonly CallStatsGroup[];
+    /** True when a `session` grouping left out numbers beyond the first 500. Totals still count every call. */
+    readonly groupsTruncated: boolean;
+    /** 168 cells, Monday 00:00 first. */
+    readonly heatmap: readonly CallStatsHeatmapCell[];
+}
+/** Filters shared by call statistics, call records and the export. */
+export interface CallFilters {
+    /** Session name of one number (1 to 128 characters). */
+    readonly sessionId?: string;
+    readonly direction?: CallDirection;
+    readonly upstream?: CallUpstream;
+    readonly outcome?: CallOutcome;
+    /** Include calls that started at or after this time. */
+    readonly since?: string | Date;
+    /** Include calls that started before this time. */
+    readonly until?: string | Date;
+}
+export interface CallStatsParams extends CallFilters {
+    /** Defaults to `day`. `day` covers at most 366 days, `hour` at most 31. */
+    readonly groupBy?: CallStatsGroupBy;
+    /** IANA time zone name for day and hour buckets and the heatmap. Defaults to `UTC`. */
+    readonly timezone?: string;
+}
+export interface ListCallRecordsParams extends CallFilters {
+    /** 1 to 100; the API default is 25. */
+    readonly limit?: number;
+    readonly cursor?: string;
+}
+export interface ExportCallRecordsParams extends CallFilters {
+    /** Defaults to `csv`. */
+    readonly format?: CallExportFormat;
+    /** Records per page, 1 to 1,000; the API default is 1,000. */
+    readonly limit?: number;
+    /** The `nextCursor` of the previous page. Send the same filters. */
+    readonly cursor?: string;
+}
+/** Team clients may name a project; omitting it covers every project. */
+interface TeamProjectFilter {
+    readonly projectId?: string;
+}
+type ParamsFor<O extends ClientOwner, P> = O extends "project" ? P : P & TeamProjectFilter;
+export type CallStatsParamsFor<O extends ClientOwner> = ParamsFor<O, CallStatsParams>;
+export type ListCallRecordsParamsFor<O extends ClientOwner> = ParamsFor<O, ListCallRecordsParams>;
+export type ExportCallRecordsParamsFor<O extends ClientOwner> = ParamsFor<O, ExportCallRecordsParams>;
+/** One page of exported call records. */
+export interface CallRecordExportPage {
+    readonly format: CallExportFormat;
+    /**
+     * CSV with a header row and CRLF line endings, or one JSON call record per
+     * line for `ndjson`.
+     */
+    readonly body: string;
+    /** Cursor of the next page, or `null` on the last page. */
+    readonly nextCursor: string | null;
+}
+/**
+ * Call analytics and call detail records (`sessions:read`). Team clients
+ * cover every project unless they pass `projectId`; project clients read
+ * their own project.
+ */
+export declare class PlatformCallsResource<O extends ClientOwner> {
+    #private;
+    private readonly transport;
+    private readonly projectId;
+    constructor(transport: HttpTransport, projectId: string | null);
+    /**
+     * Call volume, outcomes, answer rate and connected duration for a time
+     * range, grouped by day, hour, number or outcome, with an hour-of-week
+     * heatmap. Without `since` and `until` the range is the last 7 days.
+     */
+    stats(params?: CallStatsParamsFor<O>, options?: RequestOptions): Promise<ApiResponse<CallStats>>;
+    /**
+     * Call detail records, newest first. Iterate the returned page with
+     * `for await` to read every matching record.
+     */
+    list(params?: ListCallRecordsParamsFor<O>, options?: RequestOptions): Promise<CursorPage<CallRecord>>;
+    /**
+     * One page of up to 1,000 call records as CSV or newline-delimited JSON.
+     * Pass `nextCursor` back as `cursor`, with the same filters, for the next
+     * page. `exportAll` walks every page for you.
+     */
+    export(params?: ExportCallRecordsParamsFor<O>, options?: RequestOptions): Promise<ApiResponse<CallRecordExportPage>>;
+    /**
+     * Yields the body of every export page in order, starting at
+     * `params.cursor` when given. CSV pages after the first omit their header
+     * row, so the concatenated chunks form one CSV document.
+     */
+    exportAll(params?: ExportCallRecordsParamsFor<O>, options?: RequestOptions): AsyncGenerator<string, void, undefined>;
+}
+export {};
+//# sourceMappingURL=calls.d.ts.map

package/dist/platform/calls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calls.d.ts","sourceRoot":"","sources":["../../src/platform/calls.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EACV,WAAW,EAEX,cAAc,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAOxD,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,UAAU,CAAC;AACnD,2CAA2C;AAC3C,MAAM,MAAM,YAAY,GAAG,eAAe,GAAG,WAAW,CAAC;AACzD;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACrB,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAC;AAChE,oEAAoE;AACpE,MAAM,MAAM,eAAe,GACzB,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC3D,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AACtE,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEhD,yEAAyE;AACzE,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,wEAAwE;IACxE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,mEAAmE;IACnE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kFAAkF;IAClF,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2BAA2B;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,oGAAoG;IACpG,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,2CAA2C;IAC3C,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACtC,mGAAmG;IACnG,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,kFAAkF;IAClF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC;IAC3C,2GAA2G;IAC3G,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,qCAAqC;IACrC,QAAQ,CAAC,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;CACnD;AAED,sEAAsE;AACtE,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;IAC/B,wDAAwD;IACxD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IACpC,uFAAuF;IACvF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACxD,uCAAuC;IACvC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,WAAW;IAC1D,yBAAyB;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IACnC,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,oEAAoE;IACpE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yEAAyE;AACzE,UAAU,iBAAiB;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,KAAK,SAAS,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,IAAI,CAAC,SAAS,SAAS,GAC1D,CAAC,GACD,CAAC,GAAG,iBAAiB,CAAC;AAE1B,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,WAAW,IAAI,SAAS,CAC/D,CAAC,EACD,eAAe,CAChB,CAAC;AACF,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,WAAW,IAAI,SAAS,CACrE,CAAC,EACD,qBAAqB,CACtB,CAAC;AACF,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,WAAW,IAAI,SAAS,CACvE,CAAC,EACD,uBAAuB,CACxB,CAAC;AAEF,yCAAyC;AACzC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,2DAA2D;IAC3D,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAuBD;;;;GAIG;AACH,qBAAa,qBAAqB,CAAC,CAAC,SAAS,WAAW;;IAIpD,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,SAAS,EAAE,aAAa,EACxB,SAAS,EAAE,MAAM,GAAG,IAAI;IAK3C;;;;OAIG;IACH,KAAK,CACH,MAAM,GAAE,kBAAkB,CAAC,CAAC,CAA+B,EAC3D,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAmBlC;;;OAGG;IACH,IAAI,CACF,MAAM,GAAE,wBAAwB,CAAC,CAAC,CAAqC,EACvE,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAWlC;;;;OAIG;IACH,MAAM,CACJ,MAAM,GAAE,0BAA0B,CAAC,CAAC,CAAuC,EAC3E,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAwD7C;;;;OAIG;IACI,SAAS,CACd,MAAM,GAAE,0BAA0B,CAAC,CAAC,CAAuC,EAC3E,OAAO,GAAE,cAAmB,GAC3B,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC;CA+E3C"}

package/dist/platform/calls.js

@@ -0,0 +1,261 @@
+import { PolymorfaConfigurationError, PolymorfaServerError, } from "../errors.js";
+import { CursorPage } from "../pagination.js";
+import { RawClient } from "../raw.js";
+import { HttpTransport } from "../transport/http.js";
+import { decodeCursorPage, unwrapResponse, } from "./response.js";
+const DIRECTIONS = ["inbound", "outbound"];
+const UPSTREAMS = ["linked_device", "cloud_api"];
+const OUTCOMES = [
+    "answered",
+    "missed",
+    "declined",
+    "failed",
+    "in_progress",
+];
+const GROUP_BY = [
+    "day",
+    "hour",
+    "session",
+    "outcome",
+];
+const FORMATS = ["csv", "ndjson"];
+const CONTENT_TYPES = {
+    csv: "text/csv",
+    ndjson: "application/x-ndjson",
+};
+/**
+ * Call analytics and call detail records (`sessions:read`). Team clients
+ * cover every project unless they pass `projectId`; project clients read
+ * their own project.
+ */
+export class PlatformCallsResource {
+    transport;
+    projectId;
+    #raw;
+    constructor(transport, projectId) {
+        this.transport = transport;
+        this.projectId = projectId;
+        this.#raw = new RawClient(transport);
+    }
+    /**
+     * Call volume, outcomes, answer rate and connected duration for a time
+     * range, grouped by day, hour, number or outcome, with an hour-of-week
+     * heatmap. Without `since` and `until` the range is the last 7 days.
+     */
+    stats(params = {}, options = {}) {
+        const query = this.#filters(params);
+        const { groupBy, timezone } = params;
+        if (groupBy !== undefined) {
+            query.groupBy = oneOf(groupBy, GROUP_BY, "groupBy");
+        }
+        if (timezone !== undefined) {
+            query.timezone = text(timezone, "timezone", 64);
+        }
+        return this.transport
+            .request({
+            method: "GET",
+            path: "/platform/calls/stats",
+            query,
+            ...options,
+        })
+            .then(unwrapResponse);
+    }
+    /**
+     * Call detail records, newest first. Iterate the returned page with
+     * `for await` to read every matching record.
+     */
+    list(params = {}, options = {}) {
+        const query = this.#filters(params);
+        const { limit, cursor } = params;
+        if (limit !== undefined)
+            query.limit = integer(limit, "limit", 1, 100);
+        if (cursor !== undefined)
+            query.cursor = text(cursor, "cursor", 256);
+        return this.#raw.paginate({ method: "GET", path: "/platform/calls", query, ...options }, (decodeCursorPage));
+    }
+    /**
+     * One page of up to 1,000 call records as CSV or newline-delimited JSON.
+     * Pass `nextCursor` back as `cursor`, with the same filters, for the next
+     * page. `exportAll` walks every page for you.
+     */
+    export(params = {}, options = {}) {
+        const query = this.#filters(params);
+        const { format, limit, cursor } = params;
+        const resolved = format === undefined ? "csv" : oneOf(format, FORMATS, "format");
+        query.format = resolved;
+        if (limit !== undefined)
+            query.limit = integer(limit, "limit", 1, 1000);
+        if (cursor !== undefined)
+            query.cursor = text(cursor, "cursor", 256);
+        return this.transport
+            .requestText({ method: "GET", path: "/platform/calls/export", query, ...options }, CONTENT_TYPES[resolved])
+            .then((response) => {
+            const contentType = response.metadata.headers["content-type"];
+            if (contentType?.split(";", 1)[0]?.trim().toLowerCase() !==
+                CONTENT_TYPES[resolved]) {
+                throw new PolymorfaServerError("The Polymorfa API returned an unexpected call export content type.", {
+                    code: "invalid_response",
+                    status: response.metadata.status,
+                    ...(response.metadata.requestId === undefined
+                        ? {}
+                        : { requestId: response.metadata.requestId }),
+                    metadata: response.metadata,
+                });
+            }
+            if (typeof response.data !== "string") {
+                throw new PolymorfaServerError("The Polymorfa API returned an invalid export body.", {
+                    code: "invalid_response",
+                    status: response.metadata.status,
+                    ...(response.metadata.requestId === undefined
+                        ? {}
+                        : { requestId: response.metadata.requestId }),
+                    metadata: response.metadata,
+                });
+            }
+            const next = response.metadata.headers["polymorfa-next-cursor"];
+            return Object.freeze({
+                data: Object.freeze({
+                    format: resolved,
+                    body: response.data,
+                    nextCursor: next === undefined || next === "" ? null : next,
+                }),
+                metadata: response.metadata,
+            });
+        });
+    }
+    /**
+     * Yields the body of every export page in order, starting at
+     * `params.cursor` when given. CSV pages after the first omit their header
+     * row, so the concatenated chunks form one CSV document.
+     */
+    async *exportAll(params = {}, options = {}) {
+        let cursor = params.cursor;
+        let first = true;
+        // Cursors already requested. A page whose next cursor is one of these is
+        // rejected before its body is yielded, so a replayed page never reaches
+        // the consumer's output.
+        const seen = new Set(cursor === undefined ? [] : [cursor]);
+        while (true) {
+            const { data, metadata } = await this.export({ ...params, ...(cursor === undefined ? {} : { cursor }) }, options);
+            if (data.nextCursor !== null && seen.has(data.nextCursor)) {
+                throw new PolymorfaServerError("The Polymorfa API repeated an export cursor.", {
+                    code: "invalid_response",
+                    status: metadata.status,
+                    ...(metadata.requestId === undefined
+                        ? {}
+                        : { requestId: metadata.requestId }),
+                    metadata,
+                });
+            }
+            const body = !first && data.format === "csv" ? withoutHeader(data.body) : data.body;
+            first = false;
+            if (body.length > 0)
+                yield body;
+            if (data.nextCursor === null)
+                return;
+            seen.add(data.nextCursor);
+            cursor = data.nextCursor;
+        }
+    }
+    #filters(params) {
+        if (typeof params !== "object" || params === null) {
+            throw new PolymorfaConfigurationError("Call filters must be an object.", "params");
+        }
+        const query = {};
+        if (this.projectId !== null) {
+            if (params.projectId !== undefined &&
+                params.projectId !== this.projectId) {
+                throw new PolymorfaConfigurationError("A project client reads only its own project's calls.", "projectId");
+            }
+            query.projectId = this.projectId;
+        }
+        else if (params.projectId !== undefined) {
+            query.projectId = text(params.projectId, "projectId", 64);
+        }
+        if (params.sessionId !== undefined) {
+            query.sessionId = text(params.sessionId, "sessionId", 128);
+        }
+        if (params.direction !== undefined) {
+            query.direction = oneOf(params.direction, DIRECTIONS, "direction");
+        }
+        if (params.upstream !== undefined) {
+            query.upstream = oneOf(params.upstream, UPSTREAMS, "upstream");
+        }
+        if (params.outcome !== undefined) {
+            query.outcome = oneOf(params.outcome, OUTCOMES, "outcome");
+        }
+        if (params.since !== undefined) {
+            query.since = timestamp(params.since, "since");
+        }
+        if (params.until !== undefined) {
+            query.until = timestamp(params.until, "until");
+        }
+        return query;
+    }
+}
+function withoutHeader(body) {
+    const end = body.indexOf("\n");
+    return end === -1 ? "" : body.slice(end + 1);
+}
+function oneOf(value, allowed, field) {
+    if (typeof value !== "string" || !allowed.includes(value)) {
+        throw new PolymorfaConfigurationError(`${field} must be one of ${allowed.join(", ")}.`, field);
+    }
+    return value;
+}
+function text(value, field, maxLength) {
+    if (typeof value !== "string" ||
+        value.trim().length === 0 ||
+        value.length > maxLength) {
+        throw new PolymorfaConfigurationError(`${field} must be a non-empty string of at most ${maxLength} characters.`, field);
+    }
+    return value;
+}
+function integer(value, field, minimum, maximum) {
+    if (typeof value !== "number" ||
+        !Number.isInteger(value) ||
+        value < minimum ||
+        value > maximum) {
+        throw new PolymorfaConfigurationError(`${field} must be an integer from ${minimum} to ${maximum}.`, field);
+    }
+    return value;
+}
+function timestamp(value, field) {
+    if (value instanceof Date) {
+        if (Number.isNaN(value.getTime())) {
+            throw new PolymorfaConfigurationError(`${field} must be a valid date.`, field);
+        }
+        return value.toISOString();
+    }
+    if (typeof value !== "string" || !isIsoDateTime(value)) {
+        throw new PolymorfaConfigurationError(`${field} must be an ISO 8601 date-time with a time zone, such as 2026-09-01T00:00:00Z, or a Date.`, field);
+    }
+    return value;
+}
+const ISO_DATE_TIME = /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.\d{1,9})?(?:Z|[+-](\d{2}):(\d{2}))$/;
+/**
+ * An RFC 3339 date-time (`2026-09-01T00:00:00Z`, `2026-09-01T09:30:00.5+03:00`)
+ * naming a real calendar instant. Date-only values and other strings that
+ * `Date.parse` tolerates are refused, as the API refuses them.
+ */
+function isIsoDateTime(value) {
+    const match = ISO_DATE_TIME.exec(value);
+    if (!match)
+        return false;
+    const part = (index) => Number(match[index] ?? 0);
+    const [year, month, day] = [part(1), part(2), part(3)];
+    const [hour, minute, second] = [part(4), part(5), part(6)];
+    const [offsetHour, offsetMinute] = [part(7), part(8)];
+    if (month < 1 || month > 12 || day < 1)
+        return false;
+    const lastDay = new Date(0);
+    lastDay.setUTCFullYear(year, month, 0);
+    const daysInMonth = lastDay.getUTCDate();
+    return (day <= daysInMonth &&
+        hour <= 23 &&
+        minute <= 59 &&
+        second <= 59 &&
+        offsetHour <= 23 &&
+        offsetMinute <= 59);
+}
+//# sourceMappingURL=calls.js.map

package/dist/platform/calls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calls.js","sourceRoot":"","sources":["../../src/platform/calls.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAOrD,OAAO,EAEL,gBAAgB,EAChB,cAAc,GACf,MAAM,eAAe,CAAC;AAoKvB,MAAM,UAAU,GAA6B,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AACrE,MAAM,SAAS,GAA4B,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;AAC1E,MAAM,QAAQ,GAA2B;IACvC,UAAU;IACV,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,aAAa;CACd,CAAC;AACF,MAAM,QAAQ,GAAgC;IAC5C,KAAK;IACL,MAAM;IACN,SAAS;IACT,SAAS;CACV,CAAC;AACF,MAAM,OAAO,GAAgC,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC/D,MAAM,aAAa,GAA+C;IAChE,GAAG,EAAE,UAAU;IACf,MAAM,EAAE,sBAAsB;CAC/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAIb;IACA;IAJV,IAAI,CAAY;IAEzB,YACmB,SAAwB,EACxB,SAAwB;QADxB,cAAS,GAAT,SAAS,CAAe;QACxB,cAAS,GAAT,SAAS,CAAe;QAEzC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CACH,SAAgC,EAA2B,EAC3D,UAA0B,EAAE;QAE5B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAyB,CAAC;QACxD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC,SAAS;aAClB,OAAO,CAA0B;YAChC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB;YAC7B,KAAK;YACL,GAAG,OAAO;SACX,CAAC;aACD,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,SAAsC,EAAiC,EACvE,UAA0B,EAAE;QAE5B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAA+B,CAAC;QAC1D,IAAI,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QACvE,IAAI,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CACvB,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAC7D,CAAA,gBAA4B,CAAA,CAC7B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,SAAwC,EAAmC,EAC3E,UAA0B,EAAE;QAE5B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAiC,CAAC;QACpE,MAAM,QAAQ,GACZ,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QAClE,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC;QACxB,IAAI,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACxE,IAAI,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,SAAS;aAClB,WAAW,CACV,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EACpE,aAAa,CAAC,QAAQ,CAAC,CACxB;aACA,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAC9D,IACE,WAAW,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnD,aAAa,CAAC,QAAQ,CAAC,EACvB,CAAC;gBACD,MAAM,IAAI,oBAAoB,CAC5B,oEAAoE,EACpE;oBACE,IAAI,EAAE,kBAAkB;oBACxB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM;oBAChC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;wBAC3C,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;oBAC/C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;iBAC5B,CACF,CAAC;YACJ,CAAC;YACD,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtC,MAAM,IAAI,oBAAoB,CAC5B,oDAAoD,EACpD;oBACE,IAAI,EAAE,kBAAkB;oBACxB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM;oBAChC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;wBAC3C,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;oBAC/C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;iBAC5B,CACF,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAChE,OAAO,MAAM,CAAC,MAAM,CAAC;gBACnB,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC;oBAClB,MAAM,EAAE,QAAQ;oBAChB,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,UAAU,EAAE,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;iBAC5D,CAAC;gBACF,QAAQ,EAAE,QAAQ,CAAC,QAAQ;aAC5B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,SAAS,CACd,SAAwC,EAAmC,EAC3E,UAA0B,EAAE;QAE5B,IAAI,MAAM,GAAI,MAAkC,CAAC,MAAM,CAAC;QACxD,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,yEAAyE;QACzE,wEAAwE;QACxE,yBAAyB;QACzB,MAAM,IAAI,GAAG,IAAI,GAAG,CAAS,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAC1C,EAAE,GAAG,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAC1D,OAAO,CACR,CAAC;YACF,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1D,MAAM,IAAI,oBAAoB,CAC5B,8CAA8C,EAC9C;oBACE,IAAI,EAAE,kBAAkB;oBACxB,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,GAAG,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;wBAClC,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC;oBACtC,QAAQ;iBACT,CACF,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,GACR,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACzE,KAAK,GAAG,KAAK,CAAC;YACd,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,IAAI,CAAC;YAChC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI;gBAAE,OAAO;YACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1B,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,QAAQ,CACN,MAAuC;QAEvC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClD,MAAM,IAAI,2BAA2B,CACnC,iCAAiC,EACjC,QAAQ,CACT,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAA+B,EAAE,CAAC;QAC7C,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAC5B,IACE,MAAM,CAAC,SAAS,KAAK,SAAS;gBAC9B,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,EACnC,CAAC;gBACD,MAAM,IAAI,2BAA2B,CACnC,sDAAsD,EACtD,WAAW,CACZ,CAAC;YACJ,CAAC;YACD,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,CAAC;aAAM,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1C,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACnC,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,KAAK,CACZ,KAAc,EACd,OAAqB,EACrB,KAAa;IAEb,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAU,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,2BAA2B,CACnC,GAAG,KAAK,mBAAmB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAChD,KAAK,CACN,CAAC;IACJ,CAAC;IACD,OAAO,KAAU,CAAC;AACpB,CAAC;AAED,SAAS,IAAI,CAAC,KAAc,EAAE,KAAa,EAAE,SAAiB;IAC5D,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;QACzB,KAAK,CAAC,MAAM,GAAG,SAAS,EACxB,CAAC;QACD,MAAM,IAAI,2BAA2B,CACnC,GAAG,KAAK,0CAA0C,SAAS,cAAc,EACzE,KAAK,CACN,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,OAAO,CACd,KAAc,EACd,KAAa,EACb,OAAe,EACf,OAAe;IAEf,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;QACxB,KAAK,GAAG,OAAO;QACf,KAAK,GAAG,OAAO,EACf,CAAC;QACD,MAAM,IAAI,2BAA2B,CACnC,GAAG,KAAK,4BAA4B,OAAO,OAAO,OAAO,GAAG,EAC5D,KAAK,CACN,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAAC,KAAc,EAAE,KAAa;IAC9C,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,2BAA2B,CACnC,GAAG,KAAK,wBAAwB,EAChC,KAAK,CACN,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,2BAA2B,CACnC,GAAG,KAAK,2FAA2F,EACnG,KAAK,CACN,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,aAAa,GACjB,0FAA0F,CAAC;AAE7F;;;;GAIG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,MAAM,IAAI,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,IAAI,GAAG,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACrD,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5B,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACvC,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IACzC,OAAO,CACL,GAAG,IAAI,WAAW;QAClB,IAAI,IAAI,EAAE;QACV,MAAM,IAAI,EAAE;QACZ,MAAM,IAAI,EAAE;QACZ,UAAU,IAAI,EAAE;QAChB,YAAY,IAAI,EAAE,CACnB,CAAC;AACJ,CAAC"}

package/dist/platform/usage.d.ts

@@ -0,0 +1,156 @@
+import { HttpTransport } from "../transport/http.js";
+import type { ApiResponse, RequestOptions } from "../transport/types.js";
+/**
+ * What was measured. Calls record `call.duration` (seconds) and, for outgoing
+ * Cloud API calls, `call.cloud_pulses` (6-second pulses). The other meters
+ * belong to voice automation and have no records yet.
+ */
+export type UsageMeter = "call.duration" | "call.cloud_pulses" | "campaign.call" | "tts.characters" | "tts.seconds" | "stt.seconds" | "agent.seconds" | "agent.tokens" | "agent.provider_cost" | "channels.peak" | "storage.byte_days";
+export type UsageUnit = "second" | "pulse" | "call" | "character" | "token" | "provider_unit" | "channel" | "byte_day";
+/** Whose provider key produced the usage. `none` for calls. */
+export type UsageKeySource = "none" | "managed" | "customer";
+export type UsagePricingState = "unpriced" | "priced" | "waived" | "settled";
+export type UsageSourceKind = "call" | "attempt" | "flow_run" | "conversation" | "asset" | "team";
+/** Dimensions of `call.duration` and `call.cloud_pulses` records. */
+export interface CallUsageDimensions {
+    readonly direction: "inbound" | "outbound";
+    readonly upstream: "linked_device" | "cloud_api";
+    readonly origin: "direct" | "campaign" | "flow" | "agent" | "inbound_automation";
+    readonly participants: number;
+    readonly connections: number;
+    readonly sipLegs: number;
+    readonly video: boolean;
+}
+export interface UsageRecord {
+    readonly id: string;
+    readonly meter: UsageMeter;
+    readonly quantity: number;
+    readonly unit: UsageUnit;
+    /** Closed, per-meter attributes. See {@link CallUsageDimensions} for calls. */
+    readonly dimensions: Readonly<Record<string, string | number | boolean>>;
+    readonly keySource: UsageKeySource;
+    readonly sourceKind: UsageSourceKind;
+    /** The call id for call meters. */
+    readonly sourceId: string;
+    readonly projectId: string | null;
+    /** The number (session name) the usage belongs to. */
+    readonly session: string | null;
+    readonly occurredAt: string;
+    readonly recordedAt: string;
+    /** Increases when a later observation corrects the record. Keep the highest. */
+    readonly revision: number;
+    /** `unpriced` while usage is measured but not charged. */
+    readonly pricingState: UsagePricingState;
+    readonly rateCard: {
+        readonly id: string;
+        readonly version: number;
+    } | null;
+    readonly pricedCredits: number | null;
+}
+export interface UsageRecordPage {
+    readonly records: readonly UsageRecord[];
+    /** Pass as `cursor` for the next page; `null` on the last page. */
+    readonly nextCursor: string | null;
+}
+export interface UsageMeterTotal {
+    readonly meter: UsageMeter;
+    readonly unit: UsageUnit;
+    readonly keySource: UsageKeySource;
+    readonly quantity: number;
+    readonly records: number;
+}
+export interface UsageSummary {
+    /** Calendar month in UTC, `YYYY-MM`. */
+    readonly period: string;
+    readonly start: string;
+    readonly end: string;
+    readonly projectId: string | null;
+    readonly session: string | null;
+    /** Always `false` while usage is measured but not charged. */
+    readonly billingEnabled: boolean;
+    readonly meters: readonly UsageMeterTotal[];
+    /** Totals per number, most call time first (at most 100). */
+    readonly numbers: readonly {
+        readonly session: string;
+        readonly projectId: string | null;
+        readonly meters: readonly UsageMeterTotal[];
+    }[];
+    readonly numbersTruncated: boolean;
+}
+export type UsageGateKey = "calls.outbound_monthly" | "voice.campaigns" | "voice.campaigns.recipients" | "voice.campaigns.calls_monthly" | "voice.channels.concurrent" | "voice.audio_library" | "voice.audio_library.assets" | "voice.flows" | "voice.agents.elevenlabs" | "voice.agents.openai_realtime" | "voice.providers.managed" | "voice.providers.customer_key" | "voice.agent_minutes_monthly" | "voice.tts_characters_monthly" | "voice.stt_minutes_monthly" | "voice.storage.recordings" | "voice.storage.transcripts";
+/**
+ * For an active gate, `record` counts actions over the limit without refusing
+ * them; `enforce` refuses them with `gate_limit_reached` (HTTP 402). `off`
+ * does not check. An inactive gate's configured mode does not enforce a limit.
+ */
+export type UsageGateMode = "off" | "record" | "enforce";
+export interface UsageGate {
+    readonly key: UsageGateKey;
+    readonly kind: "capability" | "quota" | "limit" | "concurrency";
+    readonly subject: "team" | "number" | "project" | "campaign";
+    readonly mode: UsageGateMode;
+    /** Whether an action checks this gate today. */
+    readonly active: boolean;
+    /** `-1` for no limit; `null` when the limit applies per number and no `session` was given. */
+    readonly limit: number | null;
+    readonly used: number | null;
+    readonly unit: UsageUnit | "count" | "minute" | null;
+    readonly overLimit: boolean | null;
+    /** Checks over the limit in the last 30 days (UTC). */
+    readonly decisions: {
+        readonly wouldBlock: number;
+        readonly blocked: number;
+        readonly evaluationError: number;
+    };
+}
+export interface UsageGateList {
+    readonly session: string | null;
+    readonly gates: readonly UsageGate[];
+}
+export interface UsageSummaryParams {
+    /** Organization keys only; a project client always reads its own project. */
+    readonly projectId?: string;
+    /** One number (session name). */
+    readonly session?: string;
+    /** Calendar month in UTC, `YYYY-MM`. Defaults to the current month. */
+    readonly period?: string;
+}
+export interface UsageRecordParams extends UsageSummaryParams {
+    /** Calendar month in UTC, `YYYY-MM`. Omit it to list records from every month. */
+    readonly period?: string;
+    /** One call's records. */
+    readonly callId?: string;
+    readonly meter?: UsageMeter;
+    /** 1 to 100; defaults to 25. */
+    readonly limit?: number;
+    readonly cursor?: string;
+}
+export interface UsageGateParams {
+    readonly projectId?: string;
+    /** Include limits that apply per number. */
+    readonly session?: string;
+}
+/**
+ * Metered usage and usage gates. Usage is measured, not charged. Requires the
+ * `sessions:read` scope; a project token reads only its own project's usage,
+ * and gate state needs an organization key.
+ */
+export declare class UsageResource {
+    private readonly transport;
+    private readonly projectId;
+    constructor(transport: HttpTransport, projectId: string | null);
+    /** `GET /platform/usage`: totals for one calendar month, by meter and by number. */
+    summary(params?: UsageSummaryParams, options?: RequestOptions): Promise<ApiResponse<UsageSummary>>;
+    /** `GET /platform/usage/records`: records newest first, one page. */
+    listRecords(params?: UsageRecordParams, options?: RequestOptions): Promise<ApiResponse<UsageRecordPage>>;
+    /** Iterates every matching record across pages. */
+    iterateRecords(params?: Omit<UsageRecordParams, "cursor">, options?: RequestOptions): AsyncGenerator<UsageRecord, void, undefined>;
+    /**
+     * `GET /platform/gates`: every usage gate with its mode, limit and usage.
+     * Gate state covers the whole team, so this needs an organization client;
+     * the API refuses project credentials with 403.
+     */
+    listGates(params?: UsageGateParams, options?: RequestOptions): Promise<ApiResponse<UsageGateList>>;
+    private get;
+}
+//# sourceMappingURL=usage.d.ts.map

package/dist/platform/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/platform/usage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EACV,WAAW,EAEX,cAAc,EACf,MAAM,uBAAuB,CAAC;AAG/B;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,eAAe,GACf,mBAAmB,GACnB,eAAe,GACf,gBAAgB,GAChB,aAAa,GACb,aAAa,GACb,eAAe,GACf,cAAc,GACd,qBAAqB,GACrB,eAAe,GACf,mBAAmB,CAAC;AAExB,MAAM,MAAM,SAAS,GACjB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,WAAW,GACX,OAAO,GACP,eAAe,GACf,SAAS,GACT,UAAU,CAAC;AAEf,+DAA+D;AAC/D,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;AAC7D,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAC7E,MAAM,MAAM,eAAe,GACzB,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAEtE,qEAAqE;AACrE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAC3C,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW,CAAC;IACjD,QAAQ,CAAC,MAAM,EACb,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,CAAC;IAClE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,+EAA+E;IAC/E,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IACzE,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC;IACnC,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IACrC,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,0DAA0D;IAC1D,QAAQ,CAAC,YAAY,EAAE,iBAAiB,CAAC;IACzC,QAAQ,CAAC,QAAQ,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC5E,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IACzC,mEAAmE;IACnE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;IAC5C,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,EAAE,SAAS;QACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;KAC7C,EAAE,CAAC;IACJ,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,MAAM,YAAY,GACpB,wBAAwB,GACxB,iBAAiB,GACjB,4BAA4B,GAC5B,+BAA+B,GAC/B,2BAA2B,GAC3B,qBAAqB,GACrB,4BAA4B,GAC5B,aAAa,GACb,yBAAyB,GACzB,8BAA8B,GAC9B,yBAAyB,GACzB,8BAA8B,GAC9B,6BAA6B,GAC7B,8BAA8B,GAC9B,2BAA2B,GAC3B,0BAA0B,GAC1B,2BAA2B,CAAC;AAEhC;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEzD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,8FAA8F;IAC9F,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,CAAC;IACrD,QAAQ,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,uDAAuD;IACvD,QAAQ,CAAC,SAAS,EAAE;QAClB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;QAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;KAClC,CAAC;CACH;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,6EAA6E;IAC7E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,iCAAiC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,uEAAuE;IACvE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,kFAAkF;IAClF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0BAA0B;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAC5B,gCAAgC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,4CAA4C;IAC5C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,aAAa;IAEtB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,SAAS,EAAE,aAAa,EACxB,SAAS,EAAE,MAAM,GAAG,IAAI;IAG3C,oFAAoF;IAC9E,OAAO,CACX,MAAM,GAAE,kBAAuB,EAC/B,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAMrC,qEAAqE;IAC/D,WAAW,CACf,MAAM,GAAE,iBAAsB,EAC9B,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAUxC,mDAAmD;IAC5C,cAAc,CACnB,MAAM,GAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAM,EAC9C,OAAO,GAAE,cAAmB,GAC3B,cAAc,CAAC,WAAW,EAAE,IAAI,EAAE,SAAS,CAAC;IA6B/C;;;;OAIG;IACG,SAAS,CACb,MAAM,GAAE,eAAoB,EAC5B,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAMtC,OAAO,CAAC,GAAG;CAiBZ"}