@nizam-os/customer-sdk 4.0.0 → 5.1.0

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

@@ -3,13 +3,13 @@
  */
 export interface Country {
     /** ISO 3166-1 alpha-2 code. */
-    code?: string | undefined;
+    code: string;
     /** Display name in the Accept-Language locale. */
-    name?: string | undefined;
+    name: string;
     /** E.164 country calling code with `+` prefix, or null if not allocated. */
     calling_code?: string | undefined;
     /** Object type discriminator. */
-    object?: Country.Object_ | undefined;
+    object: Country.Object_;
 }
 export declare namespace Country {
     /** Object type discriminator. */

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

@@ -4,10 +4,24 @@
 export interface CreateAssetRequest {
     /** Top-level kind. */
     kind: CreateAssetRequest.Kind;
+    /** Initial lifecycle status — the asset's birth state. Optional; defaults to `active`. Subsequent changes go through the status-transition endpoint. */
+    status?: CreateAssetRequest.Status | undefined;
     /** Display name. */
     name?: string | undefined;
+    /** Sub-kind within the kind (free-form). */
+    sub_kind?: string | undefined;
     /** SAE J3016 autonomy level 0..5. */
     autonomy_level?: number | undefined;
+    /** Vehicle Identification Number — 17 chars of A-Z (no I, O, Q) and 0-9, uppercase. Unique per organization. */
+    vin?: string | undefined;
+    /** License plate. */
+    plate_number?: string | undefined;
+    /** Manufacturer. */
+    make?: string | undefined;
+    /** Model designation. */
+    model?: string | undefined;
+    /** Model year — 1900 or later, and no later than next year. */
+    year?: number | undefined;
 }
 export declare namespace CreateAssetRequest {
     /** Top-level kind. */
@@ -23,4 +37,15 @@ export declare namespace CreateAssetRequest {
         readonly Equipment: "equipment";
     };
     type Kind = (typeof Kind)[keyof typeof Kind];
+    /** Initial lifecycle status — the asset's birth state. Optional; defaults to `active`. Subsequent changes go through the status-transition endpoint. */
+    const Status: {
+        readonly Active: "active";
+        readonly Maintenance: "maintenance";
+        readonly OutOfService: "out_of_service";
+        readonly Retired: "retired";
+        readonly Sold: "sold";
+        readonly Inactive: "inactive";
+        readonly Lost: "lost";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
 }

package/dist/api/types/CreateAssetRequest.js

@@ -16,4 +16,14 @@ var CreateAssetRequest;
         Pallet: "pallet",
         Equipment: "equipment",
     };
+    /** Initial lifecycle status — the asset's birth state. Optional; defaults to `active`. Subsequent changes go through the status-transition endpoint. */
+    CreateAssetRequest.Status = {
+        Active: "active",
+        Maintenance: "maintenance",
+        OutOfService: "out_of_service",
+        Retired: "retired",
+        Sold: "sold",
+        Inactive: "inactive",
+        Lost: "lost",
+    };
 })(CreateAssetRequest || (exports.CreateAssetRequest = CreateAssetRequest = {}));

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

@@ -3,15 +3,15 @@
  */
 export interface Currency {
     /** ISO 4217 code. */
-    code?: string | undefined;
+    code: string;
     /** Display name in the Accept-Language locale. */
-    name?: string | undefined;
+    name: string;
     /** Short symbol in the Accept-Language locale. */
-    symbol?: string | undefined;
+    symbol: string;
     /** Default number of fractional digits per ISO 4217. */
-    fraction_digits?: number | undefined;
+    fraction_digits: number;
     /** Object type discriminator. */
-    object?: Currency.Object_ | undefined;
+    object: Currency.Object_;
 }
 export declare namespace Currency {
     /** Object type discriminator. */

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

@@ -3,17 +3,17 @@
  */
 export interface Device {
     /** Device id. */
-    id?: string | undefined;
+    id: string;
     /** Push transport. */
-    platform?: Device.Platform | undefined;
+    platform: Device.Platform;
     /** Registration lifecycle. */
-    status?: Device.Status | undefined;
+    status: Device.Status;
     /** When the device was first registered. */
-    registered_at?: string | undefined;
+    registered_at: string;
     /** When the registration was last refreshed (last seen). */
-    last_seen_at?: string | undefined;
+    last_seen_at: string;
     /** Object type discriminator. */
-    object?: Device.Object_ | undefined;
+    object: Device.Object_;
 }
 export declare namespace Device {
     /** Push transport. */

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

@@ -4,9 +4,9 @@ import type * as NizamCustomer from "../index.js";
  */
 export interface Devices {
     /** The caller's live device registrations. */
-    devices?: NizamCustomer.Device[] | undefined;
+    devices: NizamCustomer.Device[];
     /** Object type discriminator. */
-    object?: Devices.Object_ | undefined;
+    object: Devices.Object_;
 }
 export declare namespace Devices {
     /** Object type discriminator. */

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

@@ -0,0 +1,36 @@
+export interface ExportAssetsRequest {
+    /** Output format. */
+    format: ExportAssetsRequest.Format;
+    /** Columns to export, in display order. `id` is a UUID — the safe, stable re-import/audit key; `kind`/`status` carry their stored code, not the tenant's display label. */
+    fields: ExportAssetsRequest.Fields.Item[];
+    /** Asset ids to export (the current selection). Capped at 10000. */
+    ids: string[];
+}
+export declare namespace ExportAssetsRequest {
+    /** Output format. */
+    const Format: {
+        readonly Csv: "csv";
+        readonly Xlsx: "xlsx";
+        readonly Json: "json";
+    };
+    type Format = (typeof Format)[keyof typeof Format];
+    type Fields = Fields.Item[];
+    namespace Fields {
+        /** An exportable asset column key (mirrors the list columns). */
+        const Item: {
+            readonly Id: "id";
+            readonly Name: "name";
+            readonly Kind: "kind";
+            readonly SubKind: "sub_kind";
+            readonly AutonomyLevel: "autonomy_level";
+            readonly Status: "status";
+            readonly Make: "make";
+            readonly Model: "model";
+            readonly Year: "year";
+            readonly PlateNumber: "plate_number";
+            readonly Vin: "vin";
+            readonly CreatedAt: "created_at";
+        };
+        type Item = (typeof Item)[keyof typeof Item];
+    }
+}

package/dist/api/types/ExportAssetsRequest.js

@@ -0,0 +1,31 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportAssetsRequest = void 0;
+var ExportAssetsRequest;
+(function (ExportAssetsRequest) {
+    /** Output format. */
+    ExportAssetsRequest.Format = {
+        Csv: "csv",
+        Xlsx: "xlsx",
+        Json: "json",
+    };
+    let Fields;
+    (function (Fields) {
+        /** An exportable asset column key (mirrors the list columns). */
+        Fields.Item = {
+            Id: "id",
+            Name: "name",
+            Kind: "kind",
+            SubKind: "sub_kind",
+            AutonomyLevel: "autonomy_level",
+            Status: "status",
+            Make: "make",
+            Model: "model",
+            Year: "year",
+            PlateNumber: "plate_number",
+            Vin: "vin",
+            CreatedAt: "created_at",
+        };
+    })(Fields = ExportAssetsRequest.Fields || (ExportAssetsRequest.Fields = {}));
+})(ExportAssetsRequest || (exports.ExportAssetsRequest = ExportAssetsRequest = {}));

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

@@ -1,12 +1,12 @@
 /**
- * A short-lived URL granting read access to the file's bytes. Fetch it promptly — request a fresh grant after expiry.
+ * A short-lived URL granting read access to a file's bytes. Fetch it promptly — request a fresh grant after expiry.
  */
 export interface FileDownloadUrl {
     /** The URL to GET the bytes from. */
-    url?: string | undefined;
+    url: string;
     /** When the URL stops working. */
-    expires_at?: string | undefined;
-    object?: FileDownloadUrl.Object_ | undefined;
+    expires_at: string;
+    object: FileDownloadUrl.Object_;
 }
 export declare namespace FileDownloadUrl {
     const Object_: {

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

@@ -4,24 +4,24 @@ import type * as NizamCustomer from "../index.js";
  */
 export interface FileUploadSession {
     /** Session id — the handle for resume / complete / cancel. */
-    id?: string | undefined;
+    id: string;
     /** Pre-reserved id of the file this upload will become. */
-    file_id?: string | undefined;
+    file_id: string;
     /** The kind declared at initiation. */
-    kind?: FileUploadSession.Kind | undefined;
+    kind: FileUploadSession.Kind;
     /** Session lifecycle. */
-    status?: FileUploadSession.Status | undefined;
+    status: FileUploadSession.Status;
     /** Nominal part size; every part except the last must be exactly this size. */
-    part_size_bytes?: number | undefined;
+    part_size_bytes: number;
     /** Total parts in the layout. */
-    part_count?: number | undefined;
+    part_count: number;
     /** Bytes confirmed so far (client-reported, re-verified at completion). */
-    bytes_uploaded?: number | undefined;
-    completed_part_numbers?: number[] | undefined;
-    parts?: NizamCustomer.FileUploadPart[] | undefined;
+    bytes_uploaded: number;
+    completed_part_numbers: number[];
+    parts: NizamCustomer.FileUploadPart[];
     /** Deadline: the session expires and is swept if not completed by then. */
-    expires_at?: string | undefined;
-    object?: FileUploadSession.Object_ | undefined;
+    expires_at: string;
+    object: FileUploadSession.Object_;
 }
 export declare namespace FileUploadSession {
     /** The kind declared at initiation. */
@@ -33,6 +33,7 @@ export declare namespace FileUploadSession {
         readonly ImportReport: "import_report";
         readonly SignedDocument: "signed_document";
         readonly ProductImage: "product_image";
+        readonly DataExport: "data_export";
     };
     type Kind = (typeof Kind)[keyof typeof Kind];
     /** Session lifecycle. */

package/dist/api/types/FileUploadSession.js

@@ -13,6 +13,7 @@ var FileUploadSession;
         ImportReport: "import_report",
         SignedDocument: "signed_document",
         ProductImage: "product_image",
+        DataExport: "data_export",
     };
     /** Session lifecycle. */
     FileUploadSession.Status = {

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

@@ -3,13 +3,13 @@
  */
 export interface File_ {
     /** Stable file id (pre-reserved at upload initiation). */
-    id?: string | undefined;
+    id: string;
     /** Owning organization. */
-    organization_id?: string | undefined;
+    organization_id: string;
     /** Uploading user. Null for system-generated artifacts. */
     uploader_id?: string | undefined;
     /** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
-    kind?: File_.Kind | undefined;
+    kind: File_.Kind;
     /** Type of the business entity this file documents. */
     subject_type?: string | undefined;
     /** Id of the business entity this file documents. */
@@ -17,21 +17,21 @@ export interface File_ {
     /** For derived files (thumbnails): the original this one was rendered from. */
     parent_file_id?: string | undefined;
     /** Client-supplied filename, served back via Content-Disposition on download. */
-    original_filename?: string | undefined;
+    original_filename: string;
     /** MIME type declared by the uploader at initiation. */
-    declared_content_type?: string | undefined;
+    declared_content_type: string;
     /** MIME type detected server-side from the bytes (Tika). Null when detection was inconclusive. */
     sniffed_content_type?: string | undefined;
     /** Object size in bytes, storage-confirmed at completion. */
-    size_bytes?: number | undefined;
+    size_bytes: number;
     /** SHA-256 of the content, 64 lowercase hex characters. */
-    checksum_sha256?: string | undefined;
+    checksum_sha256: string;
     /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
-    status?: File_.Status | undefined;
+    status: File_.Status;
     /** Access posture of the bytes, fixed by the kind's policy. */
-    visibility?: File_.Visibility | undefined;
+    visibility: File_.Visibility;
     /** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
-    virus_scan_status?: File_.VirusScanStatus | undefined;
+    virus_scan_status: File_.VirusScanStatus;
     /** When the scan verdict was produced. */
     virus_scanned_at?: string | undefined;
     /** When this file becomes eligible for the lifecycle sweep (TTL kinds). */
@@ -39,10 +39,10 @@ export interface File_ {
     /** Regulatory hold: the file cannot be deleted before this instant. */
     retention_until?: string | undefined;
     /** Upload completion time. */
-    created_at?: string | undefined;
+    created_at: string;
     /** Last lifecycle/scan change. */
-    updated_at?: string | undefined;
-    object?: File_.Object_ | undefined;
+    updated_at: string;
+    object: File_.Object_;
 }
 export declare namespace File_ {
     /** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
@@ -54,6 +54,7 @@ export declare namespace File_ {
         readonly ImportReport: "import_report";
         readonly SignedDocument: "signed_document";
         readonly ProductImage: "product_image";
+        readonly DataExport: "data_export";
     };
     type Kind = (typeof Kind)[keyof typeof Kind];
     /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */

package/dist/api/types/File_.js

@@ -13,6 +13,7 @@ var File_;
         ImportReport: "import_report",
         SignedDocument: "signed_document",
         ProductImage: "product_image",
+        DataExport: "data_export",
     };
     /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
     File_.Status = {

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

@@ -3,12 +3,12 @@
  */
 export interface HeatmapCell {
     /** H3 cell index, lowercase hex (string — H3 indexes exceed the JS safe-integer range). */
-    h3_cell?: string | undefined;
+    h3_cell: string;
     /** H3 resolution of the cell (9 or 11). */
-    h3_res?: number | undefined;
+    h3_res: number;
     /** Number of positions recorded in the cell over the window. */
-    count?: number | undefined;
-    object?: HeatmapCell.Object_ | undefined;
+    count: number;
+    object: HeatmapCell.Object_;
 }
 export declare namespace HeatmapCell {
     const Object_: {

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

@@ -3,16 +3,16 @@
  */
 export interface ImportError {
     /** The 1-based data-row index that failed (header excluded). */
-    row_number?: number | undefined;
+    row_number: number;
     /** The offending column header, or null for a whole-row error. */
     field?: string | undefined;
     /** Stable machine-readable error code. */
-    error_code?: string | undefined;
+    error_code: string;
     /** Human-readable explanation of the error. */
-    error_message?: string | undefined;
+    error_message: string;
     /** The raw cell value that failed (truncated), when relevant. */
     raw_value?: string | undefined;
-    object?: ImportError.Object_ | undefined;
+    object: ImportError.Object_;
 }
 export declare namespace ImportError {
     const Object_: {

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

@@ -4,11 +4,11 @@ import type * as NizamCustomer from "../index.js";
  */
 export interface ImportSubmission {
     /** The created import job — poll/cancel it via /v1/jobs/{id}. */
-    job_id?: string | undefined;
+    job_id: string;
     /** The id the uploaded source file will carry. */
-    file_id?: string | undefined;
-    upload?: NizamCustomer.FileUploadSession | undefined;
-    object?: ImportSubmission.Object_ | undefined;
+    file_id: string;
+    upload: NizamCustomer.FileUploadSession;
+    object: ImportSubmission.Object_;
 }
 export declare namespace ImportSubmission {
     const Object_: {

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

@@ -3,21 +3,21 @@
  */
 export interface Invite {
     /** Stable UUID of this invite. */
-    id?: string | undefined;
+    id: string;
     /** Organization the invite confers membership in. */
-    organization_id?: string | undefined;
+    organization_id: string;
     /** Recipient email — canonical lowercase form. */
-    invited_email?: string | undefined;
+    invited_email: string;
     /** Role the recipient will hold after acceptance. */
-    role?: Invite.Role | undefined;
+    role: Invite.Role;
     /** Lifecycle status. */
-    status?: Invite.Status | undefined;
+    status: Invite.Status;
     /** When the invite expires. Recipients must accept before then. */
-    expires_at?: string | undefined;
+    expires_at: string;
     /** Bearer secret used to redeem the invite. Returned only on POST /v1/invites; subsequent lookups omit it. */
-    token?: string | undefined;
+    token: string;
     /** Object type discriminator. */
-    object?: Invite.Object_ | undefined;
+    object: Invite.Object_;
 }
 export declare namespace Invite {
     /** Role the recipient will hold after acceptance. */

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

@@ -3,13 +3,13 @@
  */
 export interface Job {
     /** Stable job id. */
-    id?: string | undefined;
+    id: string;
     /** Owning organization. */
-    organization_id?: string | undefined;
+    organization_id: string;
     /** What kind of work this job performs; the kind also fixes the executing engine. */
-    kind?: Job.Kind | undefined;
+    kind: Job.Kind;
     /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
-    status?: Job.Status | undefined;
+    status: Job.Status;
     /** User who submitted the job. Null only if that user was since deleted. */
     requested_by_id?: string | undefined;
     /** File the job consumes (kind-specific), e.g. an uploaded import file. References a file id; download via the file's own endpoint. */
@@ -19,9 +19,9 @@ export interface Job {
     /** 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;
+    rows_processed: number;
     /** Work items that failed so far (monotonic). */
-    rows_failed?: number | undefined;
+    rows_failed: number;
     /** 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. */
@@ -29,18 +29,18 @@ export interface Job {
     /** 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;
+    attempt_count: number;
     /** Retry budget: a failed job with attempt_count >= max_attempts is dead-lettered. */
-    max_attempts?: number | undefined;
+    max_attempts: number;
     /** 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;
+    created_at: string;
     /** Last state/progress change. */
-    updated_at?: string | undefined;
-    object?: Job.Object_ | undefined;
+    updated_at: string;
+    object: Job.Object_;
 }
 export declare namespace Job {
     /** What kind of work this job performs; the kind also fixes the executing engine. */

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

@@ -3,8 +3,8 @@
  */
 export interface JobSubmission {
     /** The created job — poll/cancel it via /v1/jobs/{id}. */
-    job_id?: string | undefined;
-    object?: JobSubmission.Object_ | undefined;
+    job_id: string;
+    object: JobSubmission.Object_;
 }
 export declare namespace JobSubmission {
     const Object_: {

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

@@ -3,13 +3,13 @@
  */
 export interface Language {
     /** ISO 639-1 two-letter code. */
-    code?: string | undefined;
+    code: string;
     /** Display name in the Accept-Language locale. */
-    name?: string | undefined;
+    name: string;
     /** Name in the language itself, useful in language pickers. */
-    native_name?: string | undefined;
+    native_name: string;
     /** Object type discriminator. */
-    object?: Language.Object_ | undefined;
+    object: Language.Object_;
 }
 export declare namespace Language {
     /** Object type discriminator. */

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

@@ -3,11 +3,11 @@ import type * as NizamCustomer from "../index.js";
  * An organization the current user belongs to, with their role inside it.
  */
 export interface Membership {
-    organization?: NizamCustomer.Organization | undefined;
+    organization: NizamCustomer.Organization;
     /** The user's role in this organization. */
-    role?: Membership.Role | undefined;
+    role: Membership.Role;
     /** Object type discriminator. */
-    object?: Membership.Object_ | undefined;
+    object: Membership.Object_;
 }
 export declare namespace Membership {
     /** The user's role in this organization. */

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

@@ -3,10 +3,10 @@
  */
 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;
+    token: string;
     /** Seconds until the token expires. Re-mint before this elapses to stay connected. */
-    expires_in?: number | undefined;
+    expires_in: number;
     /** The only topic this credential may publish to: nizam/{organizationId}/operators/{operatorId}/location. */
-    topic?: string | undefined;
-    object?: string | undefined;
+    topic: string;
+    object: string;
 }

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

@@ -3,27 +3,27 @@
  */
 export interface Notification {
     /** Object type discriminator. */
-    object?: Notification.Object_ | undefined;
+    object: Notification.Object_;
     /** Notification id. */
-    id?: string | undefined;
+    id: string;
     /** Notification kind (stable wire key). */
-    kind?: string | undefined;
+    kind: string;
     /** Opt-out / grouping category. */
-    category?: Notification.Category | undefined;
+    category: Notification.Category;
     /** Delivery priority. */
-    priority?: Notification.Priority | undefined;
+    priority: Notification.Priority;
     /** Kind-specific render payload. */
-    data?: Record<string, Record<string, unknown>> | undefined;
+    data: Record<string, Record<string, unknown>>;
     /** Whether the recipient has read it. */
-    read?: boolean | undefined;
+    read: boolean;
     /** When it was read (RFC 3339); null while unread. */
     read_at?: string | undefined;
     /** Whether the recipient has archived ("Done") it. */
-    archived?: boolean | undefined;
+    archived: boolean;
     /** When it was archived (RFC 3339); null while in the active inbox. */
     archived_at?: string | undefined;
     /** When it was raised (RFC 3339). */
-    created_at?: string | undefined;
+    created_at: string;
 }
 export declare namespace Notification {
     /** Object type discriminator. */

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

@@ -4,15 +4,15 @@ import type * as NizamCustomer from "../index.js";
  */
 export interface NotificationCounts {
     /** Active (non-archived) notifications. */
-    total?: number | undefined;
+    total: number;
     /** Active unread notifications. */
-    unread?: number | undefined;
+    unread: number;
     /** Archived ("Done") notifications. */
-    archived?: number | undefined;
+    archived: number;
     /** Per-category active counts; categories with no active row are omitted. */
-    categories?: NizamCustomer.NotificationCategoryCount[] | undefined;
+    categories: NizamCustomer.NotificationCategoryCount[];
     /** Object type discriminator. */
-    object?: NotificationCounts.Object_ | undefined;
+    object: NotificationCounts.Object_;
 }
 export declare namespace NotificationCounts {
     /** Object type discriminator. */