@nizam-os/operator-sdk 2.5.2 → 2.6.0

package/dist/Client.d.ts

@@ -1,5 +1,6 @@
 import { InvitesClient } from "./api/resources/invites/client/Client.js";
 import { LookupsClient } from "./api/resources/lookups/client/Client.js";
+import { PositionsClient } from "./api/resources/positions/client/Client.js";
 import { RealtimeClient } from "./api/resources/realtime/client/Client.js";
 import { UsersClient } from "./api/resources/users/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
@@ -15,11 +16,13 @@ export declare class NizamOperatorRuntimeClient {
     protected _invites: InvitesClient | undefined;
     protected _lookups: LookupsClient | undefined;
     protected _users: UsersClient | undefined;
+    protected _positions: PositionsClient | undefined;
     protected _realtime: RealtimeClient | undefined;
     constructor(options: NizamOperatorRuntimeClient.Options);
     get invites(): InvitesClient;
     get lookups(): LookupsClient;
     get users(): UsersClient;
+    get positions(): PositionsClient;
     get realtime(): RealtimeClient;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/Client.js

@@ -37,8 +37,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NizamOperatorRuntimeClient = void 0;
 const Client_js_1 = require("./api/resources/invites/client/Client.js");
 const Client_js_2 = require("./api/resources/lookups/client/Client.js");
-const Client_js_3 = require("./api/resources/realtime/client/Client.js");
-const Client_js_4 = require("./api/resources/users/client/Client.js");
+const Client_js_3 = require("./api/resources/positions/client/Client.js");
+const Client_js_4 = require("./api/resources/realtime/client/Client.js");
+const Client_js_5 = require("./api/resources/users/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 class NizamOperatorRuntimeClient {
@@ -52,10 +53,13 @@ class NizamOperatorRuntimeClient {
         return (this._lookups ?? (this._lookups = new Client_js_2.LookupsClient(this._options)));
     }
     get users() {
-        return (this._users ?? (this._users = new Client_js_4.UsersClient(this._options)));
+        return (this._users ?? (this._users = new Client_js_5.UsersClient(this._options)));
+    }
+    get positions() {
+        return (this._positions ?? (this._positions = new Client_js_3.PositionsClient(this._options)));
     }
     get realtime() {
-        return (this._realtime ?? (this._realtime = new Client_js_3.RealtimeClient(this._options)));
+        return (this._realtime ?? (this._realtime = new Client_js_4.RealtimeClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/api/errors/BadGatewayError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as NizamOperatorRuntime from "../index.js";
+export declare class BadGatewayError extends errors.NizamOperatorRuntimeError {
+    constructor(body: NizamOperatorRuntime.ProblemDetail, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/BadGatewayError.js

@@ -0,0 +1,54 @@
+"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.BadGatewayError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class BadGatewayError extends errors.NizamOperatorRuntimeError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadGatewayError",
+            statusCode: 502,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}
+exports.BadGatewayError = BadGatewayError;

package/dist/api/errors/BadRequestError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as NizamOperatorRuntime from "../index.js";
+export declare class BadRequestError extends errors.NizamOperatorRuntimeError {
+    constructor(body: NizamOperatorRuntime.ProblemDetail, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/BadRequestError.js

@@ -0,0 +1,54 @@
+"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.BadRequestError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class BadRequestError extends errors.NizamOperatorRuntimeError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}
+exports.BadRequestError = BadRequestError;

package/dist/api/errors/index.d.ts

@@ -1,3 +1,5 @@
+export * from "./BadGatewayError.js";
+export * from "./BadRequestError.js";
 export * from "./ConflictError.js";
 export * from "./ForbiddenError.js";
 export * from "./GoneError.js";

package/dist/api/errors/index.js

@@ -14,6 +14,8 @@ 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("./BadGatewayError.js"), exports);
+__exportStar(require("./BadRequestError.js"), exports);
 __exportStar(require("./ConflictError.js"), exports);
 __exportStar(require("./ForbiddenError.js"), exports);
 __exportStar(require("./GoneError.js"), exports);

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

@@ -1,5 +1,6 @@
 export * from "./invites/client/requests/index.js";
 export * as invites from "./invites/index.js";
 export * as lookups from "./lookups/index.js";
+export * as positions from "./positions/index.js";
 export * as realtime from "./realtime/index.js";
 export * as users from "./users/index.js";

package/dist/api/resources/index.js

@@ -36,9 +36,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.users = exports.realtime = exports.lookups = exports.invites = void 0;
+exports.users = exports.realtime = exports.positions = exports.lookups = exports.invites = void 0;
 __exportStar(require("./invites/client/requests/index.js"), exports);
 exports.invites = __importStar(require("./invites/index.js"));
 exports.lookups = __importStar(require("./lookups/index.js"));
+exports.positions = __importStar(require("./positions/index.js"));
 exports.realtime = __importStar(require("./realtime/index.js"));
 exports.users = __importStar(require("./users/index.js"));

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

@@ -0,0 +1,31 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as NizamOperatorRuntime 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);
+    /**
+     * Exchanges the caller's access token for a short-lived MQTT credential (aud=mqtt) scoped to the caller's own operator. Connect to the broker with username = the operator id and password = the returned token, then publish position pings to the returned topic. The credential expires after `expires_in` seconds — re-mint before then (budget: 30/hour).
+     *
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamOperatorRuntime.BadRequestError}
+     * @throws {@link NizamOperatorRuntime.UnauthorizedError}
+     * @throws {@link NizamOperatorRuntime.ForbiddenError}
+     * @throws {@link NizamOperatorRuntime.NotFoundError}
+     * @throws {@link NizamOperatorRuntime.TooManyRequestsError}
+     * @throws {@link NizamOperatorRuntime.InternalServerError}
+     * @throws {@link NizamOperatorRuntime.BadGatewayError}
+     *
+     * @example
+     *     await client.positions.mintMqttToken()
+     */
+    mintMqttToken(requestOptions?: PositionsClient.RequestOptions): core.HttpResponsePromise<NizamOperatorRuntime.MqttToken>;
+    private __mintMqttToken;
+}

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

@@ -0,0 +1,114 @@
+"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 NizamOperatorRuntime = __importStar(require("../../../index.js"));
+class PositionsClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * Exchanges the caller's access token for a short-lived MQTT credential (aud=mqtt) scoped to the caller's own operator. Connect to the broker with username = the operator id and password = the returned token, then publish position pings to the returned topic. The credential expires after `expires_in` seconds — re-mint before then (budget: 30/hour).
+     *
+     * @param {PositionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamOperatorRuntime.BadRequestError}
+     * @throws {@link NizamOperatorRuntime.UnauthorizedError}
+     * @throws {@link NizamOperatorRuntime.ForbiddenError}
+     * @throws {@link NizamOperatorRuntime.NotFoundError}
+     * @throws {@link NizamOperatorRuntime.TooManyRequestsError}
+     * @throws {@link NizamOperatorRuntime.InternalServerError}
+     * @throws {@link NizamOperatorRuntime.BadGatewayError}
+     *
+     * @example
+     *     await client.positions.mintMqttToken()
+     */
+    mintMqttToken(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__mintMqttToken(requestOptions));
+    }
+    async __mintMqttToken(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.NizamOperatorRuntimeEnvironment.Production, "v1/me/mqtt-token"),
+            method: "POST",
+            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 NizamOperatorRuntime.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new NizamOperatorRuntime.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamOperatorRuntime.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new NizamOperatorRuntime.NotFoundError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamOperatorRuntime.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamOperatorRuntime.InternalServerError(_response.error.body, _response.rawResponse);
+                case 502:
+                    throw new NizamOperatorRuntime.BadGatewayError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamOperatorRuntimeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/me/mqtt-token");
+    }
+}
+exports.PositionsClient = PositionsClient;

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

@@ -0,0 +1 @@
+export {};

package/dist/api/resources/positions/client/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/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/ListResponseHeatmapCell.d.ts

@@ -0,0 +1,27 @@
+import type * as NizamOperatorRuntime from "../index.js";
+/**
+ * Envelope for paginated list responses (Stripe-style cursor pagination).
+ */
+export interface ListResponseHeatmapCell {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    object?: ListResponseHeatmapCell.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamOperatorRuntime.HeatmapCell[] | undefined;
+    /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
+    has_more?: boolean | undefined;
+    /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
+    has_previous?: boolean | undefined;
+    /** Opaque cursor for the next page. `null` on the last page. */
+    next_cursor?: string | undefined;
+    /** Opaque cursor for the previous page. `null` on the first page. */
+    prev_cursor?: string | undefined;
+    /** Page size that produced this response. */
+    limit?: number | undefined;
+}
+export declare namespace ListResponseHeatmapCell {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    const Object_: {
+        readonly List: "list";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ListResponseHeatmapCell.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResponseHeatmapCell = void 0;
+var ListResponseHeatmapCell;
+(function (ListResponseHeatmapCell) {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    ListResponseHeatmapCell.Object_ = {
+        List: "list",
+    };
+})(ListResponseHeatmapCell || (exports.ListResponseHeatmapCell = ListResponseHeatmapCell = {}));

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

@@ -0,0 +1,27 @@
+import type * as NizamOperatorRuntime from "../index.js";
+/**
+ * Envelope for paginated list responses (Stripe-style cursor pagination).
+ */
+export interface ListResponseOperatorPosition {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    object?: ListResponseOperatorPosition.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamOperatorRuntime.OperatorPosition[] | undefined;
+    /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
+    has_more?: boolean | undefined;
+    /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
+    has_previous?: boolean | undefined;
+    /** Opaque cursor for the next page. `null` on the last page. */
+    next_cursor?: string | undefined;
+    /** Opaque cursor for the previous page. `null` on the first page. */
+    prev_cursor?: string | undefined;
+    /** Page size that produced this response. */
+    limit?: number | undefined;
+}
+export declare namespace ListResponseOperatorPosition {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    const Object_: {
+        readonly List: "list";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ListResponseOperatorPosition.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResponseOperatorPosition = void 0;
+var ListResponseOperatorPosition;
+(function (ListResponseOperatorPosition) {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    ListResponseOperatorPosition.Object_ = {
+        List: "list",
+    };
+})(ListResponseOperatorPosition || (exports.ListResponseOperatorPosition = ListResponseOperatorPosition = {}));

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

@@ -0,0 +1,27 @@
+import type * as NizamOperatorRuntime from "../index.js";
+/**
+ * Envelope for paginated list responses (Stripe-style cursor pagination).
+ */
+export interface ListResponsePosition {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    object?: ListResponsePosition.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamOperatorRuntime.Position[] | undefined;
+    /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
+    has_more?: boolean | undefined;
+    /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
+    has_previous?: boolean | undefined;
+    /** Opaque cursor for the next page. `null` on the last page. */
+    next_cursor?: string | undefined;
+    /** Opaque cursor for the previous page. `null` on the first page. */
+    prev_cursor?: string | undefined;
+    /** Page size that produced this response. */
+    limit?: number | undefined;
+}
+export declare namespace ListResponsePosition {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    const Object_: {
+        readonly List: "list";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ListResponsePosition.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResponsePosition = void 0;
+var ListResponsePosition;
+(function (ListResponsePosition) {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    ListResponsePosition.Object_ = {
+        List: "list",
+    };
+})(ListResponsePosition || (exports.ListResponsePosition = ListResponsePosition = {}));

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

@@ -0,0 +1,12 @@
+/**
+ * A short-lived MQTT publish credential for the position ingest broker.
+ */
+export interface MqttToken {
+    /** JWT to present as the MQTT CONNECT password. The CONNECT username must be the operator id embedded in the token's operator_id claim. */
+    token?: string | undefined;
+    /** Seconds until the token expires. Re-mint before this elapses to stay connected. */
+    expires_in?: number | undefined;
+    /** The only topic this credential may publish to: nizam/{organizationId}/operators/{operatorId}/location. */
+    topic?: string | undefined;
+    object?: string | undefined;
+}

package/dist/api/types/MqttToken.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/types/OperatorPosition.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The current position of one operator.
+ */
+export interface OperatorPosition {
+    /** Operator id. */
+    operator_id?: string | undefined;
+    /** Latitude (WGS84). */
+    lat?: number | undefined;
+    /** Longitude (WGS84). */
+    lng?: number | undefined;
+    /** Direction of travel, compass degrees [0,360). */
+    heading?: number | undefined;
+    /** Course over ground, compass degrees [0,360). */
+    bearing?: number | undefined;
+    /** Ground speed, km/h. */
+    speed?: number | undefined;
+    /** Altitude above the WGS84 ellipsoid, metres. */
+    altitude?: number | undefined;
+    /** Device-time of the fix. */
+    captured_at?: string | undefined;
+    object?: OperatorPosition.Object_ | undefined;
+}
+export declare namespace OperatorPosition {
+    const Object_: {
+        readonly OperatorPosition: "operator_position";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/OperatorPosition.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.OperatorPosition = void 0;
+var OperatorPosition;
+(function (OperatorPosition) {
+    OperatorPosition.Object_ = {
+        OperatorPosition: "operator_position",
+    };
+})(OperatorPosition || (exports.OperatorPosition = OperatorPosition = {}));

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

@@ -0,0 +1,30 @@
+/**
+ * One recorded GPS position of an operator.
+ */
+export interface Position {
+    /** Position id. */
+    id?: string | undefined;
+    /** Operator the fix belongs to. */
+    operator_id?: string | undefined;
+    /** Latitude (WGS84). */
+    lat?: number | undefined;
+    /** Longitude (WGS84). */
+    lng?: number | undefined;
+    /** Direction of travel, compass degrees [0,360). */
+    heading?: number | undefined;
+    /** Course over ground toward the destination, compass degrees [0,360). */
+    bearing?: number | undefined;
+    /** Ground speed, km/h. */
+    speed?: number | undefined;
+    /** Altitude above the WGS84 ellipsoid, metres. */
+    altitude?: number | undefined;
+    /** Device-time the fix was captured (authoritative). */
+    recorded_at?: string | undefined;
+    object?: Position.Object_ | undefined;
+}
+export declare namespace Position {
+    const Object_: {
+        readonly Position: "position";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/Position.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.Position = void 0;
+var Position;
+(function (Position) {
+    Position.Object_ = {
+        Position: "position",
+    };
+})(Position || (exports.Position = Position = {}));

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

@@ -16,6 +16,7 @@ export * from "./CreateOperatorRequest.js";
 export * from "./CreateOrganizationRequest.js";
 export * from "./CreateTeleoperatedOperatorRequest.js";
 export * from "./Currency.js";
+export * from "./HeatmapCell.js";
 export * from "./InternalUserUpdateRequest.js";
 export * from "./Invite.js";
 export * from "./InviteUserRequest.js";
@@ -27,18 +28,24 @@ export * from "./ListResponseAssetListItem.js";
 export * from "./ListResponseBusinessCategory.js";
 export * from "./ListResponseCountry.js";
 export * from "./ListResponseCurrency.js";
+export * from "./ListResponseHeatmapCell.js";
 export * from "./ListResponseJob.js";
 export * from "./ListResponseLanguage.js";
 export * from "./ListResponseMembership.js";
+export * from "./ListResponseOperatorPosition.js";
 export * from "./ListResponseOrganization.js";
+export * from "./ListResponsePosition.js";
 export * from "./ListResponseTimezone.js";
 export * from "./ListResponseUserResource.js";
 export * from "./Membership.js";
 export * from "./MembershipChoice.js";
 export * from "./MembershipDriftResponse.js";
+export * from "./MqttToken.js";
 export * from "./OpenAssignmentRequest.js";
 export * from "./Operator.js";
+export * from "./OperatorPosition.js";
 export * from "./Organization.js";
+export * from "./Position.js";
 export * from "./ProblemDetail.js";
 export * from "./RealtimeTicket.js";
 export * from "./ReconcileResponse.js";

package/dist/api/types/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./CreateOperatorRequest.js"), exports);
 __exportStar(require("./CreateOrganizationRequest.js"), exports);
 __exportStar(require("./CreateTeleoperatedOperatorRequest.js"), exports);
 __exportStar(require("./Currency.js"), exports);
+__exportStar(require("./HeatmapCell.js"), exports);
 __exportStar(require("./InternalUserUpdateRequest.js"), exports);
 __exportStar(require("./Invite.js"), exports);
 __exportStar(require("./InviteUserRequest.js"), exports);
@@ -43,18 +44,24 @@ __exportStar(require("./ListResponseAssetListItem.js"), exports);
 __exportStar(require("./ListResponseBusinessCategory.js"), exports);
 __exportStar(require("./ListResponseCountry.js"), exports);
 __exportStar(require("./ListResponseCurrency.js"), exports);
+__exportStar(require("./ListResponseHeatmapCell.js"), exports);
 __exportStar(require("./ListResponseJob.js"), exports);
 __exportStar(require("./ListResponseLanguage.js"), exports);
 __exportStar(require("./ListResponseMembership.js"), exports);
+__exportStar(require("./ListResponseOperatorPosition.js"), exports);
 __exportStar(require("./ListResponseOrganization.js"), exports);
+__exportStar(require("./ListResponsePosition.js"), exports);
 __exportStar(require("./ListResponseTimezone.js"), exports);
 __exportStar(require("./ListResponseUserResource.js"), exports);
 __exportStar(require("./Membership.js"), exports);
 __exportStar(require("./MembershipChoice.js"), exports);
 __exportStar(require("./MembershipDriftResponse.js"), exports);
+__exportStar(require("./MqttToken.js"), exports);
 __exportStar(require("./OpenAssignmentRequest.js"), exports);
 __exportStar(require("./Operator.js"), exports);
+__exportStar(require("./OperatorPosition.js"), exports);
 __exportStar(require("./Organization.js"), exports);
+__exportStar(require("./Position.js"), exports);
 __exportStar(require("./ProblemDetail.js"), exports);
 __exportStar(require("./RealtimeTicket.js"), exports);
 __exportStar(require("./ReconcileResponse.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizam-os/operator-sdk",
-  "version": "2.5.2",
+  "version": "2.6.0",
   "description": "Nizam Operator API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,