@nizam-os/carrier-sdk 2.5.2 → 2.6.0

package/dist/api/types/Job.js

@@ -8,6 +8,8 @@ var Job;
     Job.Kind = {
         MembershipCacheRebuild: "membership_cache_rebuild",
         ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration",
+        FileVirusScan: "file_virus_scan",
+        FileThumbnailGeneration: "file_thumbnail_generation",
     };
     /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
     Job.Status = {

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

@@ -0,0 +1,27 @@
+import type * as NizamCarrier from "../index.js";
+/**
+ * Envelope for paginated list responses (Stripe-style cursor pagination).
+ */
+export interface ListResponseFile {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    object?: ListResponseFile.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamCarrier.File_[] | 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 ListResponseFile {
+    /** 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/ListResponseFile.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.ListResponseFile = void 0;
+var ListResponseFile;
+(function (ListResponseFile) {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    ListResponseFile.Object_ = {
+        List: "list",
+    };
+})(ListResponseFile || (exports.ListResponseFile = ListResponseFile = {}));

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

@@ -0,0 +1,27 @@
+import type * as NizamCarrier 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?: NizamCarrier.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 NizamCarrier 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?: NizamCarrier.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 NizamCarrier 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?: NizamCarrier.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/TaskAttemptPhoto.d.ts

@@ -0,0 +1,30 @@
+import type * as NizamCarrier from "../index.js";
+/**
+ * A proof-of-delivery photo captured during a task attempt.
+ */
+export interface TaskAttemptPhoto {
+    /** Photo record id. */
+    id?: string | undefined;
+    /** Central file id — request bytes via the files download-url endpoint. */
+    file_id?: string | undefined;
+    /** Display order within the attempt. */
+    sequence?: number | undefined;
+    /** Photo category, when categorised. */
+    photo_type?: string | undefined;
+    /** Operator-entered caption. */
+    caption?: string | undefined;
+    /** Device capture time (EXIF), when reported. */
+    taken_at?: string | undefined;
+    /** May the bytes be served right now (scan verdict + lifecycle)? */
+    downloadable?: boolean | undefined;
+    thumbnails?: NizamCarrier.TaskAttemptPhotoThumbnail[] | undefined;
+    /** When the photo row was recorded. */
+    created_at?: string | undefined;
+    object?: TaskAttemptPhoto.Object_ | undefined;
+}
+export declare namespace TaskAttemptPhoto {
+    const Object_: {
+        readonly TaskAttemptPhoto: "task_attempt_photo";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

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

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

@@ -0,0 +1,9 @@
+/**
+ * One rendered thumbnail variant.
+ */
+export interface TaskAttemptPhotoThumbnail {
+    /** Bounding-box size the variant was rendered into (px). */
+    max_dimension?: number | undefined;
+    /** The variant's file id — request bytes via the files download-url endpoint. */
+    file_id?: string | undefined;
+}

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

@@ -0,0 +1,22 @@
+import type * as NizamCarrier from "../index.js";
+/**
+ * A freshly initiated upload: the session handle, the pre-reserved file id and the presigned part URLs. Resume/complete/cancel go through the generic file-uploads endpoints.
+ */
+export interface UploadInitiation {
+    /** Upload session id — the handle for resume/complete/cancel. */
+    upload_session_id?: string | undefined;
+    /** Pre-reserved file id — the id the completed file WILL carry. */
+    file_id?: string | undefined;
+    /** Fixed size of every part except the last. */
+    part_size_bytes?: number | undefined;
+    /** Session deadline; the sweep aborts the upload after this. */
+    expires_at?: string | undefined;
+    parts?: NizamCarrier.UploadInitiationPart[] | undefined;
+    object?: UploadInitiation.Object_ | undefined;
+}
+export declare namespace UploadInitiation {
+    const Object_: {
+        readonly FileUploadInitiation: "file_upload_initiation";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

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

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

@@ -0,0 +1,13 @@
+/**
+ * One presigned part PUT.
+ */
+export interface UploadInitiationPart {
+    /** 1-based part number. */
+    part_number?: number | undefined;
+    /** Presigned URL to PUT the part's bytes to. */
+    url?: string | undefined;
+    /** Headers that were signed into the URL; repeat them verbatim. */
+    headers?: Record<string, string> | undefined;
+    /** URL expiry; re-request via resume if it lapses. */
+    url_expires_at?: string | undefined;
+}

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

@@ -16,6 +16,12 @@ export * from "./CreateOperatorRequest.js";
 export * from "./CreateOrganizationRequest.js";
 export * from "./CreateTeleoperatedOperatorRequest.js";
 export * from "./Currency.js";
+export * from "./File_.js";
+export * from "./FileDownloadUrl.js";
+export * from "./FileUploadPart.js";
+export * from "./FileUploadPartReport.js";
+export * from "./FileUploadSession.js";
+export * from "./HeatmapCell.js";
 export * from "./InternalUserUpdateRequest.js";
 export * from "./Invite.js";
 export * from "./InviteUserRequest.js";
@@ -27,23 +33,34 @@ export * from "./ListResponseAssetListItem.js";
 export * from "./ListResponseBusinessCategory.js";
 export * from "./ListResponseCountry.js";
 export * from "./ListResponseCurrency.js";
+export * from "./ListResponseFile.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";
 export * from "./SetActiveOrganizationRequest.js";
+export * from "./TaskAttemptPhoto.js";
+export * from "./TaskAttemptPhotoThumbnail.js";
 export * from "./Timezone.js";
 export * from "./UpdateOrganizationRequest.js";
+export * from "./UploadInitiation.js";
+export * from "./UploadInitiationPart.js";
 export * from "./User.js";
 export * from "./UserResource.js";

package/dist/api/types/index.js

@@ -32,6 +32,12 @@ __exportStar(require("./CreateOperatorRequest.js"), exports);
 __exportStar(require("./CreateOrganizationRequest.js"), exports);
 __exportStar(require("./CreateTeleoperatedOperatorRequest.js"), exports);
 __exportStar(require("./Currency.js"), exports);
+__exportStar(require("./File_.js"), exports);
+__exportStar(require("./FileDownloadUrl.js"), exports);
+__exportStar(require("./FileUploadPart.js"), exports);
+__exportStar(require("./FileUploadPartReport.js"), exports);
+__exportStar(require("./FileUploadSession.js"), exports);
+__exportStar(require("./HeatmapCell.js"), exports);
 __exportStar(require("./InternalUserUpdateRequest.js"), exports);
 __exportStar(require("./Invite.js"), exports);
 __exportStar(require("./InviteUserRequest.js"), exports);
@@ -43,23 +49,34 @@ __exportStar(require("./ListResponseAssetListItem.js"), exports);
 __exportStar(require("./ListResponseBusinessCategory.js"), exports);
 __exportStar(require("./ListResponseCountry.js"), exports);
 __exportStar(require("./ListResponseCurrency.js"), exports);
+__exportStar(require("./ListResponseFile.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);
 __exportStar(require("./SetActiveOrganizationRequest.js"), exports);
+__exportStar(require("./TaskAttemptPhoto.js"), exports);
+__exportStar(require("./TaskAttemptPhotoThumbnail.js"), exports);
 __exportStar(require("./Timezone.js"), exports);
 __exportStar(require("./UpdateOrganizationRequest.js"), exports);
+__exportStar(require("./UploadInitiation.js"), exports);
+__exportStar(require("./UploadInitiationPart.js"), exports);
 __exportStar(require("./User.js"), exports);
 __exportStar(require("./UserResource.js"), exports);

package/package.json

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