@nizam-os/dashboard-sdk 6.3.0 → 6.5.0

package/dist/api/resources/positions/client/Client.d.ts

@@ -0,0 +1,73 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as NizamDashboard from "../../../index.js";
+export declare namespace PositionsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PositionsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PositionsClient.Options>;
+    constructor(options: PositionsClient.Options);
+    /**
+     * Keyset-paginated track over a required [start, end) device-time window (max 31 days — the window drives partition pruning). Optionally narrowed to one operator.
+     *
+     * @param {NizamDashboard.ListPositionsRequest} request
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.positions.listPositions({
+     *         operator_id: "00000000-0000-0000-0000-000000000000",
+     *         start: "2026-05-20T14:00:00Z",
+     *         end: "2026-05-20T14:00:00Z",
+     *         starting_after: "Y3Vyc29yX25leHRfMDFKNVE=",
+     *         ending_before: "Y3Vyc29yX25leHRfMDFKNVE="
+     *     })
+     */
+    listPositions(request: NizamDashboard.ListPositionsRequest, requestOptions?: PositionsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.ListResponsePosition>;
+    private __listPositions;
+    /**
+     * Live snapshot for initial map load and STOMP-reconnect reconciliation. Served from the Redis hot cache (positions fresher than ~60s); a cold cache falls back to the most recent recorded position per operator over the last 15 minutes. Unpaginated by design: the result is bounded by the fleet's currently-reporting operators.
+     *
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.positions.listCurrentPositions()
+     */
+    listCurrentPositions(requestOptions?: PositionsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.ListResponseOperatorPosition>;
+    private __listCurrentPositions;
+    /**
+     * Counts recorded positions per H3 hex cell (resolution 9 ≈ 150 m or 11 ≈ 24 m) inside a `bbox` viewport over a device-time window (default: the last 24 hours). Cells are returned as hex strings — H3 indexes exceed the JavaScript safe-integer range. Unpaginated: bounded by the viewport's cell cover (max 4096 cells).
+     *
+     * @param {NizamDashboard.GetPositionsHeatmapRequest} request
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.positions.getPositionsHeatmap({
+     *         bbox: "<string>",
+     *         start: "2026-05-20T14:00:00Z",
+     *         end: "2026-05-20T14:00:00Z"
+     *     })
+     */
+    getPositionsHeatmap(request: NizamDashboard.GetPositionsHeatmapRequest, requestOptions?: PositionsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.ListResponseHeatmapCell>;
+    private __getPositionsHeatmap;
+}

package/dist/api/resources/positions/client/Client.js

@@ -0,0 +1,266 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PositionsClient = void 0;
+const BaseClient_js_1 = require("../../../../BaseClient.js");
+const headers_js_1 = require("../../../../core/headers.js");
+const core = __importStar(require("../../../../core/index.js"));
+const environments = __importStar(require("../../../../environments.js"));
+const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+const NizamDashboard = __importStar(require("../../../index.js"));
+class PositionsClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * Keyset-paginated track over a required [start, end) device-time window (max 31 days — the window drives partition pruning). Optionally narrowed to one operator.
+     *
+     * @param {NizamDashboard.ListPositionsRequest} request
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.positions.listPositions({
+     *         operator_id: "00000000-0000-0000-0000-000000000000",
+     *         start: "2026-05-20T14:00:00Z",
+     *         end: "2026-05-20T14:00:00Z",
+     *         starting_after: "Y3Vyc29yX25leHRfMDFKNVE=",
+     *         ending_before: "Y3Vyc29yX25leHRfMDFKNVE="
+     *     })
+     */
+    listPositions(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listPositions(request, requestOptions));
+    }
+    async __listPositions(request, requestOptions) {
+        const { operator_id: operatorId, start, end, limit, starting_after: startingAfter, ending_before: endingBefore, } = request;
+        const _queryParams = {
+            operator_id: operatorId,
+            start,
+            end,
+            limit,
+            starting_after: startingAfter,
+            ending_before: endingBefore,
+        };
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.NizamDashboardEnvironment.Production, "v1/fleet/positions"),
+            method: "GET",
+            headers: _headers,
+            queryString: core.url
+                .queryBuilder()
+                .addMany(_queryParams)
+                .mergeAdditional(requestOptions?.queryParams)
+                .build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new NizamDashboard.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new NizamDashboard.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamDashboard.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamDashboard.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamDashboard.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamDashboardError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/fleet/positions");
+    }
+    /**
+     * Live snapshot for initial map load and STOMP-reconnect reconciliation. Served from the Redis hot cache (positions fresher than ~60s); a cold cache falls back to the most recent recorded position per operator over the last 15 minutes. Unpaginated by design: the result is bounded by the fleet's currently-reporting operators.
+     *
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.positions.listCurrentPositions()
+     */
+    listCurrentPositions(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listCurrentPositions(requestOptions));
+    }
+    async __listCurrentPositions(requestOptions) {
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.NizamDashboardEnvironment.Production, "v1/fleet/positions/current"),
+            method: "GET",
+            headers: _headers,
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: _response.body,
+                rawResponse: _response.rawResponse,
+            };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new NizamDashboard.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new NizamDashboard.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamDashboard.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamDashboard.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamDashboard.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamDashboardError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/fleet/positions/current");
+    }
+    /**
+     * Counts recorded positions per H3 hex cell (resolution 9 ≈ 150 m or 11 ≈ 24 m) inside a `bbox` viewport over a device-time window (default: the last 24 hours). Cells are returned as hex strings — H3 indexes exceed the JavaScript safe-integer range. Unpaginated: bounded by the viewport's cell cover (max 4096 cells).
+     *
+     * @param {NizamDashboard.GetPositionsHeatmapRequest} request
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.positions.getPositionsHeatmap({
+     *         bbox: "<string>",
+     *         start: "2026-05-20T14:00:00Z",
+     *         end: "2026-05-20T14:00:00Z"
+     *     })
+     */
+    getPositionsHeatmap(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getPositionsHeatmap(request, requestOptions));
+    }
+    async __getPositionsHeatmap(request, requestOptions) {
+        const { h3_res: h3Res, bbox, start, end } = request;
+        const _queryParams = {
+            h3_res: h3Res,
+            bbox,
+            start: start != null ? start : undefined,
+            end: end != null ? end : undefined,
+        };
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.NizamDashboardEnvironment.Production, "v1/fleet/positions/heatmap"),
+            method: "GET",
+            headers: _headers,
+            queryString: core.url
+                .queryBuilder()
+                .addMany(_queryParams)
+                .mergeAdditional(requestOptions?.queryParams)
+                .build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: _response.body,
+                rawResponse: _response.rawResponse,
+            };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new NizamDashboard.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new NizamDashboard.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamDashboard.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamDashboard.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamDashboard.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamDashboardError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/fleet/positions/heatmap");
+    }
+}
+exports.PositionsClient = PositionsClient;

package/dist/api/resources/positions/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/api/resources/positions/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests/index.js"), exports);

package/dist/api/resources/positions/client/requests/GetPositionsHeatmapRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @example
+ *     {
+ *         bbox: "<string>",
+ *         start: "2026-05-20T14:00:00Z",
+ *         end: "2026-05-20T14:00:00Z"
+ *     }
+ */
+export interface GetPositionsHeatmapRequest {
+    h3_res?: number;
+    bbox: string;
+    start?: string;
+    end?: string;
+}

package/dist/api/resources/positions/client/requests/GetPositionsHeatmapRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/positions/client/requests/ListPositionsRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @example
+ *     {
+ *         operator_id: "00000000-0000-0000-0000-000000000000",
+ *         start: "2026-05-20T14:00:00Z",
+ *         end: "2026-05-20T14:00:00Z",
+ *         starting_after: "Y3Vyc29yX25leHRfMDFKNVE=",
+ *         ending_before: "Y3Vyc29yX25leHRfMDFKNVE="
+ *     }
+ */
+export interface ListPositionsRequest {
+    operator_id?: string;
+    start: string;
+    end: string;
+    /** Page size. Default 20, maximum 100. Out-of-range values are silently clamped; the response body's `limit` field reflects what was applied. */
+    limit?: number;
+    /** Opaque cursor — return the page starting strictly after this entity in the sort order. Mutually exclusive with `ending_before`. */
+    starting_after?: string;
+    /** Opaque cursor — return the page ending strictly before this entity in the sort order. Mutually exclusive with `starting_after`. */
+    ending_before?: string;
+}

package/dist/api/resources/positions/client/requests/ListPositionsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/positions/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export type { GetPositionsHeatmapRequest } from "./GetPositionsHeatmapRequest.js";
+export type { ListPositionsRequest } from "./ListPositionsRequest.js";

package/dist/api/resources/positions/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/positions/exports.d.ts

@@ -0,0 +1,2 @@
+export { PositionsClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/api/resources/positions/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PositionsClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "PositionsClient", { enumerable: true, get: function () { return Client_js_1.PositionsClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/api/resources/positions/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/api/resources/positions/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/api/types/BulkJobSubmission.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Acknowledgement of a bulk admin action that fanned out one job per work item.
+ */
+export interface BulkJobSubmission {
+    job_ids?: string[] | undefined;
+    /** Number of jobs created (one per matched service account). */
+    count?: number | undefined;
+    object?: BulkJobSubmission.Object_ | undefined;
+}
+export declare namespace BulkJobSubmission {
+    const Object_: {
+        readonly BulkJobSubmission: "bulk_job_submission";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/BulkJobSubmission.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkJobSubmission = void 0;
+var BulkJobSubmission;
+(function (BulkJobSubmission) {
+    BulkJobSubmission.Object_ = {
+        BulkJobSubmission: "bulk_job_submission",
+    };
+})(BulkJobSubmission || (exports.BulkJobSubmission = BulkJobSubmission = {}));

package/dist/api/types/HeatmapCell.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Aggregated position count for one H3 hex cell.
+ */
+export interface HeatmapCell {
+    /** H3 cell index, lowercase hex (string — H3 indexes exceed the JS safe-integer range). */
+    h3_cell?: string | undefined;
+    /** H3 resolution of the cell (9 or 11). */
+    h3_res?: number | undefined;
+    /** Number of positions recorded in the cell over the window. */
+    count?: number | undefined;
+    object?: HeatmapCell.Object_ | undefined;
+}
+export declare namespace HeatmapCell {
+    const Object_: {
+        readonly HeatmapCell: "heatmap_cell";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/HeatmapCell.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeatmapCell = void 0;
+var HeatmapCell;
+(function (HeatmapCell) {
+    HeatmapCell.Object_ = {
+        HeatmapCell: "heatmap_cell",
+    };
+})(HeatmapCell || (exports.HeatmapCell = HeatmapCell = {}));

package/dist/api/types/Job.d.ts

@@ -0,0 +1,66 @@
+/**
+ * A long-running, retryable, operator-visible unit of work — bulk imports, exports, backfills, cache rebuilds. The job row is the persistent handle; the executing engine (Temporal workflow or lease worker, declared per kind) reports progress into it. Cancellation is cooperative: already-running work continues until the engine's next checkpoint.
+ */
+export interface Job {
+    /** Stable job id. */
+    id?: string | undefined;
+    /** Owning organization. */
+    organization_id?: string | undefined;
+    /** What kind of work this job performs; the kind also fixes the executing engine. */
+    kind?: Job.Kind | undefined;
+    /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
+    status?: Job.Status | undefined;
+    /** User who submitted the job. Null only if that user was since deleted. */
+    requested_by_id?: string | undefined;
+    /** Input handle the job consumes (kind-specific), e.g. an uploaded import file. */
+    source_uri?: string | undefined;
+    /** Artifact produced by a completed job (kind-specific), e.g. a result report. */
+    report_uri?: string | undefined;
+    /** Total work items, once the engine has sized the work. Null while unknown. */
+    rows_total?: number | undefined;
+    /** Work items processed so far (monotonic). */
+    rows_processed?: number | undefined;
+    /** Work items that failed so far (monotonic). */
+    rows_failed?: number | undefined;
+    /** Operator-facing failure reason. Set only when status is `failed`. */
+    error_summary?: string | undefined;
+    /** Temporal workflow id (Temporal-engine kinds only) — cross-reference into the Temporal UI. */
+    workflow_id?: string | undefined;
+    /** Temporal run id of the latest attempt (changes across workflow retries). */
+    run_id?: string | undefined;
+    /** Engine execution attempts spent so far. */
+    attempt_count?: number | undefined;
+    /** Retry budget: a failed job with attempt_count >= max_attempts is dead-lettered. */
+    max_attempts?: number | undefined;
+    /** When the first engine attempt started. Null while pending (and for jobs cancelled before starting). */
+    started_at?: string | undefined;
+    /** When the job reached a terminal status. */
+    finished_at?: string | undefined;
+    /** Submission time. */
+    created_at?: string | undefined;
+    /** Last state/progress change. */
+    updated_at?: string | undefined;
+    object?: Job.Object_ | undefined;
+}
+export declare namespace Job {
+    /** What kind of work this job performs; the kind also fixes the executing engine. */
+    const Kind: {
+        readonly MembershipCacheRebuild: "membership_cache_rebuild";
+        readonly ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration";
+    };
+    type Kind = (typeof Kind)[keyof typeof Kind];
+    /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
+    const Status: {
+        readonly Pending: "pending";
+        readonly Running: "running";
+        readonly Cancelling: "cancelling";
+        readonly Completed: "completed";
+        readonly Failed: "failed";
+        readonly Cancelled: "cancelled";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    const Object_: {
+        readonly Job: "job";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/Job.js

@@ -0,0 +1,24 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Job = void 0;
+var Job;
+(function (Job) {
+    /** What kind of work this job performs; the kind also fixes the executing engine. */
+    Job.Kind = {
+        MembershipCacheRebuild: "membership_cache_rebuild",
+        ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration",
+    };
+    /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
+    Job.Status = {
+        Pending: "pending",
+        Running: "running",
+        Cancelling: "cancelling",
+        Completed: "completed",
+        Failed: "failed",
+        Cancelled: "cancelled",
+    };
+    Job.Object_ = {
+        Job: "job",
+    };
+})(Job || (exports.Job = Job = {}));

package/dist/api/types/JobSubmission.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Acknowledgement that a job was submitted to its engine.
+ */
+export interface JobSubmission {
+    /** The created job — poll/cancel it via /v1/jobs/{id}. */
+    job_id?: string | undefined;
+    object?: JobSubmission.Object_ | undefined;
+}
+export declare namespace JobSubmission {
+    const Object_: {
+        readonly JobSubmission: "job_submission";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/JobSubmission.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobSubmission = void 0;
+var JobSubmission;
+(function (JobSubmission) {
+    JobSubmission.Object_ = {
+        JobSubmission: "job_submission",
+    };
+})(JobSubmission || (exports.JobSubmission = JobSubmission = {}));