@nizam-os/carrier-sdk 2.5.3 → 2.7.0

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

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

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptureTaskAttemptPhotoRequest = void 0;
+var CaptureTaskAttemptPhotoRequest_js_1 = require("./CaptureTaskAttemptPhotoRequest.js");
+Object.defineProperty(exports, "CaptureTaskAttemptPhotoRequest", { enumerable: true, get: function () { return CaptureTaskAttemptPhotoRequest_js_1.CaptureTaskAttemptPhotoRequest; } });

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

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

package/dist/api/resources/taskAttempts/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.TaskAttemptsClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "TaskAttemptsClient", { enumerable: true, get: function () { return Client_js_1.TaskAttemptsClient; } });
+__exportStar(require("./client/index.js"), exports);

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

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

package/dist/api/resources/taskAttempts/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/resources/users/client/Client.d.ts

@@ -38,4 +38,47 @@ export declare class UsersClient {
      */
     me(requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.User>;
     private __me;
+    /**
+     * Declares a profile-picture upload for the AUTHENTICATED user (the subject is pinned server-side) and returns presigned part URLs. PUT the bytes to the URLs, then complete via the generic file-uploads endpoint — completion re-points the profile and soft-deletes the replaced picture; thumbnails (256/128/64 px) render asynchronously. The reference upload flow of epic #151 (#166).
+     *
+     * @param {NizamCarrier.InitiateProfilePictureUploadRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.BadRequestError}
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.ContentTooLargeError}
+     * @throws {@link NizamCarrier.UnprocessableEntityError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.users.initiateProfilePictureUpload({
+     *         filename: "avatar.png",
+     *         content_type: "image/png",
+     *         size_bytes: 204857,
+     *         checksum_sha256: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
+     *     })
+     */
+    initiateProfilePictureUpload(request: NizamCarrier.InitiateProfilePictureUploadRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.UploadInitiation>;
+    private __initiateProfilePictureUpload;
+    /**
+     * 302-redirects to a short-lived URL for the thumbnail variant nearest the requested `size` (smallest rendered variant that still covers it; the original while thumbnails are still rendering). Cross-tenant callers get 404: the picture's file row is only visible inside the organization it was uploaded in (RLS).
+     *
+     * @param {NizamCarrier.GetUserProfilePictureRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.NotFoundError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.users.getUserProfilePicture({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    getUserProfilePicture(request: NizamCarrier.GetUserProfilePictureRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __getUserProfilePicture;
 }

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

@@ -116,5 +116,147 @@ class UsersClient {
         }
         return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/me");
     }
+    /**
+     * Declares a profile-picture upload for the AUTHENTICATED user (the subject is pinned server-side) and returns presigned part URLs. PUT the bytes to the URLs, then complete via the generic file-uploads endpoint — completion re-points the profile and soft-deletes the replaced picture; thumbnails (256/128/64 px) render asynchronously. The reference upload flow of epic #151 (#166).
+     *
+     * @param {NizamCarrier.InitiateProfilePictureUploadRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.BadRequestError}
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.ContentTooLargeError}
+     * @throws {@link NizamCarrier.UnprocessableEntityError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.users.initiateProfilePictureUpload({
+     *         filename: "avatar.png",
+     *         content_type: "image/png",
+     *         size_bytes: 204857,
+     *         checksum_sha256: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
+     *     })
+     */
+    initiateProfilePictureUpload(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__initiateProfilePictureUpload(request, requestOptions));
+    }
+    async __initiateProfilePictureUpload(request, 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.NizamCarrierEnvironment.Production, "v1/me/profile-picture"),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            requestType: "json",
+            body: request,
+            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 NizamCarrier.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new NizamCarrier.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamCarrier.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new NizamCarrier.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                case 422:
+                    throw new NizamCarrier.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamCarrier.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamCarrier.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamCarrierError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/me/profile-picture");
+    }
+    /**
+     * 302-redirects to a short-lived URL for the thumbnail variant nearest the requested `size` (smallest rendered variant that still covers it; the original while thumbnails are still rendering). Cross-tenant callers get 404: the picture's file row is only visible inside the organization it was uploaded in (RLS).
+     *
+     * @param {NizamCarrier.GetUserProfilePictureRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.NotFoundError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.users.getUserProfilePicture({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    getUserProfilePicture(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getUserProfilePicture(request, requestOptions));
+    }
+    async __getUserProfilePicture(request, requestOptions) {
+        const { id, size } = request;
+        const _queryParams = {
+            size,
+        };
+        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.NizamCarrierEnvironment.Production, `v1/users/${core.url.encodePathParam(id)}/profile-picture`),
+            method: "GET",
+            headers: _headers,
+            queryString: core.url
+                .queryBuilder()
+                .addMany(_queryParams)
+                .mergeAdditional(requestOptions?.queryParams)
+                .build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: undefined, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new NizamCarrier.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamCarrier.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new NizamCarrier.NotFoundError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamCarrier.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamCarrier.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamCarrierError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/users/{id}/profile-picture");
+    }
 }
 exports.UsersClient = UsersClient;

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

@@ -1 +1 @@
-export {};
+export * from "./requests/index.js";

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

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

package/dist/api/resources/users/client/requests/GetUserProfilePictureRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @example
+ *     {
+ *         id: "00000000-0000-0000-0000-000000000000"
+ *     }
+ */
+export interface GetUserProfilePictureRequest {
+    id: string;
+    /** Desired bounding-box size in px (rendered variants: 256/128/64). */
+    size?: number;
+}

package/dist/api/resources/users/client/requests/GetUserProfilePictureRequest.js

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

package/dist/api/resources/users/client/requests/InitiateProfilePictureUploadRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         filename: "avatar.png",
+ *         content_type: "image/png",
+ *         size_bytes: 204857,
+ *         checksum_sha256: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
+ *     }
+ */
+export interface InitiateProfilePictureUploadRequest {
+    /** Original filename. */
+    filename: string;
+    /** Declared MIME type — profile pictures accept image/jpeg, image/png, image/webp; re-verified server-side at completion. */
+    content_type: string;
+    /** Exact byte size; verified against storage at completion. */
+    size_bytes?: number;
+    /** Client-computed SHA-256 of the content, lowercase hex; re-verified server-side by the pipeline. */
+    checksum_sha256: string;
+}

package/dist/api/resources/users/client/requests/InitiateProfilePictureUploadRequest.js

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * A short-lived URL granting read access to the 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;
+    /** When the URL stops working. */
+    expires_at?: string | undefined;
+    object?: FileDownloadUrl.Object_ | undefined;
+}
+export declare namespace FileDownloadUrl {
+    const Object_: {
+        readonly FileDownloadUrl: "file_download_url";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

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

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

@@ -0,0 +1,13 @@
+/**
+ * A presigned PUT for one part. Send the raw part bytes; repeat `headers` verbatim; keep the response's `ETag` header for completion.
+ */
+export interface FileUploadPart {
+    /** 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 — the PUT must repeat them verbatim. */
+    headers?: Record<string, string> | undefined;
+    /** When this URL stops working (re-issue via resume). */
+    url_expires_at?: string | undefined;
+}

package/dist/api/types/FileUploadPart.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/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 NizamCarrier 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?: NizamCarrier.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 = {