@nizam-os/customer-sdk 2.4.3 → 2.6.0

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

@@ -0,0 +1,9 @@
+/**
+ * The storage ETag received for one uploaded part.
+ */
+export interface FileUploadPartReport {
+    /** 1-based part number from the initiation layout. */
+    part_number?: number | undefined;
+    /** The ETag header value returned by the part's PUT (quotes optional). */
+    etag: string;
+}

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

@@ -0,0 +1,51 @@
+import type * as NizamCustomer from "../index.js";
+/**
+ * A resumable multipart upload in flight. The browser PUTs each part directly to the presigned URL (echoing the part's `headers` verbatim), persists the returned ETags, and completes the session with the full part list. `file_id` is the id the finished file WILL carry — safe to build optimistic UI against.
+ */
+export interface FileUploadSession {
+    /** Session id — the handle for resume / complete / cancel. */
+    id?: string | undefined;
+    /** Pre-reserved id of the file this upload will become. */
+    file_id?: string | undefined;
+    /** The kind declared at initiation. */
+    kind?: FileUploadSession.Kind | undefined;
+    /** Session lifecycle. */
+    status?: FileUploadSession.Status | undefined;
+    /** Nominal part size; every part except the last must be exactly this size. */
+    part_size_bytes?: number | undefined;
+    /** Total parts in the layout. */
+    part_count?: number | undefined;
+    /** Bytes confirmed so far (client-reported, re-verified at completion). */
+    bytes_uploaded?: number | undefined;
+    completed_part_numbers?: number[] | undefined;
+    parts?: NizamCustomer.FileUploadPart[] | undefined;
+    /** Deadline: the session expires and is swept if not completed by then. */
+    expires_at?: string | undefined;
+    object?: FileUploadSession.Object_ | undefined;
+}
+export declare namespace FileUploadSession {
+    /** The kind declared at initiation. */
+    const Kind: {
+        readonly ProfilePicture: "profile_picture";
+        readonly ChatAttachment: "chat_attachment";
+        readonly TaskPodPhoto: "task_pod_photo";
+        readonly ImportSource: "import_source";
+        readonly ImportReport: "import_report";
+        readonly SignedDocument: "signed_document";
+        readonly ProductImage: "product_image";
+    };
+    type Kind = (typeof Kind)[keyof typeof Kind];
+    /** Session lifecycle. */
+    const Status: {
+        readonly Initiated: "initiated";
+        readonly InProgress: "in_progress";
+        readonly Completed: "completed";
+        readonly Aborted: "aborted";
+        readonly Expired: "expired";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    const Object_: {
+        readonly FileUploadSession: "file_upload_session";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/FileUploadSession.js

@@ -0,0 +1,28 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileUploadSession = void 0;
+var FileUploadSession;
+(function (FileUploadSession) {
+    /** The kind declared at initiation. */
+    FileUploadSession.Kind = {
+        ProfilePicture: "profile_picture",
+        ChatAttachment: "chat_attachment",
+        TaskPodPhoto: "task_pod_photo",
+        ImportSource: "import_source",
+        ImportReport: "import_report",
+        SignedDocument: "signed_document",
+        ProductImage: "product_image",
+    };
+    /** Session lifecycle. */
+    FileUploadSession.Status = {
+        Initiated: "initiated",
+        InProgress: "in_progress",
+        Completed: "completed",
+        Aborted: "aborted",
+        Expired: "expired",
+    };
+    FileUploadSession.Object_ = {
+        FileUploadSession: "file_upload_session",
+    };
+})(FileUploadSession || (exports.FileUploadSession = FileUploadSession = {}));

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

@@ -0,0 +1,86 @@
+/**
+ * A stored file's metadata: what it is (kind), who uploaded it, integrity (checksum), lifecycle (status + scan verdict + retention), and what business entity it documents (subject). The bytes themselves are served only through short-lived download URLs.
+ */
+export interface File_ {
+    /** Stable file id (pre-reserved at upload initiation). */
+    id?: string | undefined;
+    /** Owning organization. */
+    organization_id?: string | undefined;
+    /** 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;
+    /** Type of the business entity this file documents. */
+    subject_type?: string | undefined;
+    /** Id of the business entity this file documents. */
+    subject_id?: string | undefined;
+    /** 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;
+    /** MIME type declared by the uploader at initiation. */
+    declared_content_type?: string | undefined;
+    /** 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;
+    /** SHA-256 of the content, 64 lowercase hex characters. */
+    checksum_sha256?: string | undefined;
+    /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
+    status?: File_.Status | undefined;
+    /** Access posture of the bytes, fixed by the kind's policy. */
+    visibility?: File_.Visibility | undefined;
+    /** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
+    virus_scan_status?: File_.VirusScanStatus | undefined;
+    /** When the scan verdict was produced. */
+    virus_scanned_at?: string | undefined;
+    /** When this file becomes eligible for the lifecycle sweep (TTL kinds). */
+    expires_at?: string | undefined;
+    /** Regulatory hold: the file cannot be deleted before this instant. */
+    retention_until?: string | undefined;
+    /** Upload completion time. */
+    created_at?: string | undefined;
+    /** Last lifecycle/scan change. */
+    updated_at?: string | undefined;
+    object?: File_.Object_ | undefined;
+}
+export declare namespace File_ {
+    /** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
+    const Kind: {
+        readonly ProfilePicture: "profile_picture";
+        readonly ChatAttachment: "chat_attachment";
+        readonly TaskPodPhoto: "task_pod_photo";
+        readonly ImportSource: "import_source";
+        readonly ImportReport: "import_report";
+        readonly SignedDocument: "signed_document";
+        readonly ProductImage: "product_image";
+    };
+    type Kind = (typeof Kind)[keyof typeof Kind];
+    /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
+    const Status: {
+        readonly Active: "active";
+        readonly Quarantined: "quarantined";
+        readonly Deleted: "deleted";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /** Access posture of the bytes, fixed by the kind's policy. */
+    const Visibility: {
+        readonly Private: "private";
+        readonly Public: "public";
+        readonly PublicCdn: "public_cdn";
+    };
+    type Visibility = (typeof Visibility)[keyof typeof Visibility];
+    /** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
+    const VirusScanStatus: {
+        readonly Pending: "pending";
+        readonly Clean: "clean";
+        readonly Infected: "infected";
+        readonly Error: "error";
+        readonly Skipped: "skipped";
+    };
+    type VirusScanStatus = (typeof VirusScanStatus)[keyof typeof VirusScanStatus];
+    const Object_: {
+        readonly File: "file";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/File_.js

@@ -0,0 +1,40 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.File_ = void 0;
+var File_;
+(function (File_) {
+    /** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
+    File_.Kind = {
+        ProfilePicture: "profile_picture",
+        ChatAttachment: "chat_attachment",
+        TaskPodPhoto: "task_pod_photo",
+        ImportSource: "import_source",
+        ImportReport: "import_report",
+        SignedDocument: "signed_document",
+        ProductImage: "product_image",
+    };
+    /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
+    File_.Status = {
+        Active: "active",
+        Quarantined: "quarantined",
+        Deleted: "deleted",
+    };
+    /** Access posture of the bytes, fixed by the kind's policy. */
+    File_.Visibility = {
+        Private: "private",
+        Public: "public",
+        PublicCdn: "public_cdn",
+    };
+    /** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
+    File_.VirusScanStatus = {
+        Pending: "pending",
+        Clean: "clean",
+        Infected: "infected",
+        Error: "error",
+        Skipped: "skipped",
+    };
+    File_.Object_ = {
+        File: "file",
+    };
+})(File_ || (exports.File_ = File_ = {}));

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

@@ -47,6 +47,8 @@ export declare namespace Job {
     const Kind: {
         readonly MembershipCacheRebuild: "membership_cache_rebuild";
         readonly ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration";
+        readonly FileVirusScan: "file_virus_scan";
+        readonly FileThumbnailGeneration: "file_thumbnail_generation";
     };
     type Kind = (typeof Kind)[keyof typeof Kind];
     /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */

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 NizamCustomer 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?: NizamCustomer.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/TaskAttemptPhoto.d.ts

@@ -0,0 +1,30 @@
+import type * as NizamCustomer 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?: NizamCustomer.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 NizamCustomer 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?: NizamCustomer.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/User.d.ts

@@ -17,6 +17,8 @@ export interface User {
     last_login_at?: string | undefined;
     /** Total logins observed by this service. */
     login_count?: number | undefined;
+    /** File id of the current profile picture (epic #151 / #166); null until one is uploaded. Request bytes via the files download-url endpoint, or let `GET /users/{id}/profile-picture` pick the nearest thumbnail. */
+    profile_picture_file_id?: string | undefined;
     /** Object type discriminator (Stripe pattern). */
     object?: User.Object_ | undefined;
 }

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

@@ -7,6 +7,7 @@ export * from "./AssetListItem.js";
 export * from "./Assignment.js";
 export * from "./BulkJobSubmission.js";
 export * from "./BusinessCategory.js";
+export * from "./CaptureTaskAttemptPhotoRequest.js";
 export * from "./CloseAssignmentRequest.js";
 export * from "./Country.js";
 export * from "./CreateAssetRequest.js";
@@ -17,6 +18,11 @@ 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";
@@ -29,6 +35,7 @@ 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";
@@ -51,7 +58,11 @@ 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

@@ -23,6 +23,7 @@ __exportStar(require("./AssetListItem.js"), exports);
 __exportStar(require("./Assignment.js"), exports);
 __exportStar(require("./BulkJobSubmission.js"), exports);
 __exportStar(require("./BusinessCategory.js"), exports);
+__exportStar(require("./CaptureTaskAttemptPhotoRequest.js"), exports);
 __exportStar(require("./CloseAssignmentRequest.js"), exports);
 __exportStar(require("./Country.js"), exports);
 __exportStar(require("./CreateAssetRequest.js"), exports);
@@ -33,6 +34,11 @@ __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);
@@ -45,6 +51,7 @@ __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);
@@ -67,7 +74,11 @@ __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/customer-sdk",
-  "version": "2.4.3",
+  "version": "2.6.0",
   "description": "Nizam Customer API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,