@nizam-os/carrier-sdk 2.5.3 → 2.7.0

package/dist/Client.d.ts

@@ -1,6 +1,8 @@
+import { FilesClient } from "./api/resources/files/client/Client.js";
 import { InvitesClient } from "./api/resources/invites/client/Client.js";
 import { LookupsClient } from "./api/resources/lookups/client/Client.js";
 import { RealtimeClient } from "./api/resources/realtime/client/Client.js";
+import { TaskAttemptsClient } from "./api/resources/taskAttempts/client/Client.js";
 import { UsersClient } from "./api/resources/users/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
 import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
@@ -12,15 +14,19 @@ export declare namespace NizamCarrierClient {
 }
 export declare class NizamCarrierClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<NizamCarrierClient.Options>;
+    protected _files: FilesClient | undefined;
     protected _invites: InvitesClient | undefined;
     protected _lookups: LookupsClient | undefined;
     protected _users: UsersClient | undefined;
     protected _realtime: RealtimeClient | undefined;
+    protected _taskAttempts: TaskAttemptsClient | undefined;
     constructor(options: NizamCarrierClient.Options);
+    get files(): FilesClient;
     get invites(): InvitesClient;
     get lookups(): LookupsClient;
     get users(): UsersClient;
     get realtime(): RealtimeClient;
+    get taskAttempts(): TaskAttemptsClient;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.

package/dist/Client.js

@@ -35,27 +35,35 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NizamCarrierClient = void 0;
-const Client_js_1 = require("./api/resources/invites/client/Client.js");
-const Client_js_2 = require("./api/resources/lookups/client/Client.js");
-const Client_js_3 = require("./api/resources/realtime/client/Client.js");
-const Client_js_4 = require("./api/resources/users/client/Client.js");
+const Client_js_1 = require("./api/resources/files/client/Client.js");
+const Client_js_2 = require("./api/resources/invites/client/Client.js");
+const Client_js_3 = require("./api/resources/lookups/client/Client.js");
+const Client_js_4 = require("./api/resources/realtime/client/Client.js");
+const Client_js_5 = require("./api/resources/taskAttempts/client/Client.js");
+const Client_js_6 = require("./api/resources/users/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 class NizamCarrierClient {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
+    get files() {
+        return (this._files ?? (this._files = new Client_js_1.FilesClient(this._options)));
+    }
     get invites() {
-        return (this._invites ?? (this._invites = new Client_js_1.InvitesClient(this._options)));
+        return (this._invites ?? (this._invites = new Client_js_2.InvitesClient(this._options)));
     }
     get lookups() {
-        return (this._lookups ?? (this._lookups = new Client_js_2.LookupsClient(this._options)));
+        return (this._lookups ?? (this._lookups = new Client_js_3.LookupsClient(this._options)));
     }
     get users() {
-        return (this._users ?? (this._users = new Client_js_4.UsersClient(this._options)));
+        return (this._users ?? (this._users = new Client_js_6.UsersClient(this._options)));
     }
     get realtime() {
-        return (this._realtime ?? (this._realtime = new Client_js_3.RealtimeClient(this._options)));
+        return (this._realtime ?? (this._realtime = new Client_js_4.RealtimeClient(this._options)));
+    }
+    get taskAttempts() {
+        return (this._taskAttempts ?? (this._taskAttempts = new Client_js_5.TaskAttemptsClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

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

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

package/dist/api/errors/BadRequestError.js

@@ -0,0 +1,54 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class BadRequestError extends errors.NizamCarrierError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}
+exports.BadRequestError = BadRequestError;

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

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

package/dist/api/errors/ContentTooLargeError.js

@@ -0,0 +1,54 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentTooLargeError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class ContentTooLargeError extends errors.NizamCarrierError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ContentTooLargeError",
+            statusCode: 413,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}
+exports.ContentTooLargeError = ContentTooLargeError;

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

@@ -1,4 +1,6 @@
+export * from "./BadRequestError.js";
 export * from "./ConflictError.js";
+export * from "./ContentTooLargeError.js";
 export * from "./ForbiddenError.js";
 export * from "./GoneError.js";
 export * from "./InternalServerError.js";

package/dist/api/errors/index.js

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

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

@@ -0,0 +1,188 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as NizamCarrier from "../../../index.js";
+export declare namespace FilesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class FilesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<FilesClient.Options>;
+    constructor(options: FilesClient.Options);
+    /**
+     * The active organization's files ordered by `created_at` descending (pass `sort=created_at` for ascending). `kind` / `status` accept comma-separated values; `subject_type` + `subject_id` narrow to the files documenting one business entity. Pagination is bidirectional (`starting_after` / `ending_before`).
+     *
+     * @param {NizamCarrier.ListFilesRequest} request
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.BadRequestError}
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.files.listFiles({
+     *         subject_type: "<string>",
+     *         subject_id: "00000000-0000-0000-0000-000000000000",
+     *         starting_after: "Y3Vyc29yX25leHRfMDFKNVE=",
+     *         ending_before: "Y3Vyc29yX25leHRfMDFKNVE="
+     *     })
+     */
+    listFiles(request?: NizamCarrier.ListFilesRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.ListResponseFile>;
+    private __listFiles;
+    /**
+     * Validates the declaration against the kind's policy (allowed portals, content types, size ceiling, organization quota), pre-reserves the final file id, and returns presigned part URLs. PUT each part's bytes directly to its URL (repeating the part's `headers` verbatim) and keep each response's `ETag` for completion. Sessions expire after 24h; the part URLs sooner — re-issue them via the resume endpoint.
+     *
+     * @param {NizamCarrier.InitiateFileUploadRequest} request
+     * @param {FilesClient.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.files.initiateFileUpload({
+     *         kind: "profile_picture",
+     *         subject_type: "task_attempt",
+     *         subject_id: "b3c4d5e6-7f8a-9b0c-1d2e-3f4a5b6c7d8e",
+     *         filename: "pod-photo.jpg",
+     *         content_type: "image/jpeg",
+     *         size_bytes: 2048576,
+     *         checksum_sha256: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
+     *     })
+     */
+    initiateFileUpload(request: NizamCarrier.InitiateFileUploadRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.FileUploadSession>;
+    private __initiateFileUpload;
+    /**
+     * Returns the session state — which parts are already confirmed — plus fresh presigned URLs for the parts still missing. The IndexedDB-persisted ETags from before the interruption stay valid; only re-upload the missing parts. Uploader-only: other members' sessions read as 404.
+     *
+     * @param {NizamCarrier.ResumeFileUploadRequest} request
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.NotFoundError}
+     * @throws {@link NizamCarrier.ConflictError}
+     * @throws {@link NizamCarrier.GoneError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.files.resumeFileUpload({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    resumeFileUpload(request: NizamCarrier.ResumeFileUploadRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.FileUploadSession>;
+    private __resumeFileUpload;
+    /**
+     * Aborts the storage-side multipart upload and marks the session aborted. Idempotent: cancelling an already-terminal session is a no-op.
+     *
+     * @param {NizamCarrier.CancelFileUploadRequest} request
+     * @param {FilesClient.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.files.cancelFileUpload({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    cancelFileUpload(request: NizamCarrier.CancelFileUploadRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __cancelFileUpload;
+    /**
+     * Assembles the file from the reported part ETags, verifies the declared size against storage, detects the real content type from the bytes, creates the file record under the pre-reserved id and enqueues the malware-scan / thumbnail pipeline. Scanned kinds stay undownloadable until the verdict lands (`virus_scan_status: clean`).
+     *
+     * @param {NizamCarrier.CompleteFileUploadRequest} request
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.BadRequestError}
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.NotFoundError}
+     * @throws {@link NizamCarrier.ConflictError}
+     * @throws {@link NizamCarrier.GoneError}
+     * @throws {@link NizamCarrier.UnprocessableEntityError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.files.completeFileUpload({
+     *         id: "00000000-0000-0000-0000-000000000000",
+     *         parts: [{
+     *                 part_number: 1,
+     *                 etag: "9bb58f26192e4ba00f01e2e7b136bbd8"
+     *             }]
+     *     })
+     */
+    completeFileUpload(request: NizamCarrier.CompleteFileUploadRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.File_>;
+    private __completeFileUpload;
+    /**
+     * Single file view: kind, integrity, lifecycle, scan verdict, subject. Org-scoped: any member of the owning organization can read it. Bytes are served only through the download-url endpoint.
+     *
+     * @param {NizamCarrier.GetFileRequest} request
+     * @param {FilesClient.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.files.getFile({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    getFile(request: NizamCarrier.GetFileRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.File_>;
+    private __getFile;
+    /**
+     * Soft-deletes the file: it disappears from listings immediately; the bytes are purged later by the lifecycle sweep once the grace period passes. Refused while a regulatory retention hold is in force (409).
+     *
+     * @param {NizamCarrier.DeleteFileRequest} request
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.NotFoundError}
+     * @throws {@link NizamCarrier.ConflictError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.files.deleteFile({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    deleteFile(request: NizamCarrier.DeleteFileRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteFile;
+    /**
+     * Authorizes the caller (org membership + the kind's portal allow-list + the scan verdict) and issues a short-lived URL for the bytes — presigned storage, or a signed CDN URL for public kinds when the CDN is enabled. Sensitive kinds append an access-audit row in the same transaction; POST because issuing a grant is an audited action, not a cacheable read.
+     *
+     * @param {NizamCarrier.CreateFileDownloadUrlRequest} request
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.NotFoundError}
+     * @throws {@link NizamCarrier.ConflictError}
+     * @throws {@link NizamCarrier.TooManyRequestsError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.files.createFileDownloadUrl({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    createFileDownloadUrl(request: NizamCarrier.CreateFileDownloadUrlRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.FileDownloadUrl>;
+    private __createFileDownloadUrl;
+}