@printhive/api 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,4 +1,148 @@
 interface paths {
+    "/v1/printers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List organization printers and loaded filament */
+        get: {
+            parameters: {
+                query?: {
+                    limit?: number;
+                    cursor?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            printers: {
+                                /** Format: uuid */
+                                id: string;
+                                name: string;
+                                make: string;
+                                model: string;
+                                modelId: null | string;
+                                family: string;
+                                nozzleDiameter: null | number;
+                                buildPlate: null | string;
+                                connected: null | boolean;
+                                readyMarked: boolean;
+                                readiness: {
+                                    ready: boolean;
+                                    bedClear: null | boolean;
+                                };
+                                maintenance: boolean;
+                                /** @enum {string} */
+                                state: "idle" | "printing" | "paused" | "offline" | "maintenance" | "ready-marked" | "unknown";
+                                loadedFilament: {
+                                    slot: string;
+                                    position: number;
+                                    address: {
+                                        ams_id: number;
+                                        slot_id: number;
+                                    };
+                                    /** @enum {string} */
+                                    state: "loaded" | "empty" | "unknown";
+                                    material: null | string;
+                                    color: null | string;
+                                    colorHex: null | string;
+                                }[];
+                            }[];
+                            nextCursor: string | null;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/printers/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Read an organization printer and loaded filament */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** Format: uuid */
+                            id: string;
+                            name: string;
+                            make: string;
+                            model: string;
+                            modelId: null | string;
+                            family: string;
+                            nozzleDiameter: null | number;
+                            buildPlate: null | string;
+                            connected: null | boolean;
+                            readyMarked: boolean;
+                            readiness: {
+                                ready: boolean;
+                                bedClear: null | boolean;
+                            };
+                            maintenance: boolean;
+                            /** @enum {string} */
+                            state: "idle" | "printing" | "paused" | "offline" | "maintenance" | "ready-marked" | "unknown";
+                            loadedFilament: {
+                                slot: string;
+                                position: number;
+                                address: {
+                                    ams_id: number;
+                                    slot_id: number;
+                                };
+                                /** @enum {string} */
+                                state: "loaded" | "empty" | "unknown";
+                                material: null | string;
+                                color: null | string;
+                                colorHex: null | string;
+                            }[];
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/partner-production/uploads": {
         parameters: {
             query?: never;
@@ -138,6 +282,7 @@ interface paths {
                                     /** @enum {string} */
                                     status: "missing";
                                 };
+                                printerModel?: string;
                             };
                         } | {
                             /** Format: uuid */
@@ -218,6 +363,7 @@ interface paths {
                                     /** @enum {string} */
                                     status: "missing";
                                 };
+                                printerModel?: string;
                             } | null;
                             error: {
                                 /** @enum {string} */
@@ -344,6 +490,7 @@ interface paths {
                                     /** @enum {string} */
                                     status: "missing";
                                 };
+                                printerModel?: string;
                             };
                         } | {
                             /** Format: uuid */
@@ -424,6 +571,7 @@ interface paths {
                                     /** @enum {string} */
                                     status: "missing";
                                 };
+                                printerModel?: string;
                             } | null;
                             error: {
                                 /** @enum {string} */
@@ -767,6 +915,7 @@ interface paths {
                                     /** @enum {string} */
                                     status: "missing";
                                 };
+                                printerModel?: string;
                             };
                         } | {
                             /** Format: uuid */
@@ -847,6 +996,7 @@ interface paths {
                                     /** @enum {string} */
                                     status: "missing";
                                 };
+                                printerModel?: string;
                             } | null;
                             error: {
                                 /** @enum {string} */
@@ -1068,6 +1218,7 @@ interface paths {
                                         /** @enum {string} */
                                         status: "missing";
                                     };
+                                    printerModel?: string;
                                 };
                             } | {
                                 /** Format: uuid */
@@ -1148,6 +1299,7 @@ interface paths {
                                         /** @enum {string} */
                                         status: "missing";
                                     };
+                                    printerModel?: string;
                                 } | null;
                                 error: {
                                     /** @enum {string} */
@@ -1388,6 +1540,7 @@ interface paths {
                                         /** @enum {string} */
                                         status: "missing";
                                     };
+                                    printerModel?: string;
                                 };
                             } | {
                                 /** Format: uuid */
@@ -1468,6 +1621,7 @@ interface paths {
                                         /** @enum {string} */
                                         status: "missing";
                                     };
+                                    printerModel?: string;
                                 } | null;
                                 error: {
                                     /** @enum {string} */
@@ -1575,6 +1729,526 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/print-jobs/create": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Create one print job for one plate */
+        post: {
+            parameters: {
+                query?: never;
+                header?: {
+                    "idempotency-key"?: string;
+                };
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        name: string;
+                        externalId?: string;
+                        model_file_id: string;
+                        organization_id?: string;
+                        /** @description Organization ID (optional, defaults to user's primary organization) */
+                        organizationId?: string;
+                        /** Format: uuid */
+                        printer_id?: string | null;
+                        /** @description One-based plate number in the project archive */
+                        plate?: number;
+                        /** @description Complete filament requirements for the selected plate. Cannot be combined with raw AMS mappings. Matched using Smart Queue material and color proximity rules. */
+                        filaments?: {
+                            /** @description Zero-based project filament index */
+                            sourceSlot: number;
+                            material: string;
+                            color: string;
+                            targetSlot?: {
+                                ams_id: number;
+                                slot_id: number;
+                            };
+                        }[];
+                        /**
+                         * @description Create assigned jobs waiting for filament, or reject mismatches with 422
+                         * @default wait
+                         * @enum {string}
+                         */
+                        on_filament_mismatch?: "wait" | "reject";
+                        /** Format: uuid */
+                        task_id?: string | null;
+                        /** @description Optional make ID to derive required materials */
+                        make_id?: string;
+                        print_options?: {
+                            enable_ams?: boolean;
+                            enable_bed_leveling?: boolean;
+                            start_immediately?: boolean;
+                            /** @description Deprecated compatibility alias for start_immediately */
+                            set_printer_ready?: boolean;
+                            auto_assign?: boolean;
+                            constraints?: Record<string, never>;
+                        } & {
+                            [key: string]: unknown;
+                        };
+                    };
+                    "multipart/form-data": {
+                        /** Format: binary */
+                        file: string;
+                        name?: string;
+                        /** @description One-based plate number in the project archive */
+                        plate: number;
+                        /** @description Complete filament requirements for the selected plate. Cannot be combined with raw AMS mappings. Matched using Smart Queue material and color proximity rules. */
+                        filaments: {
+                            /** @description Zero-based project filament index */
+                            sourceSlot: number;
+                            material: string;
+                            color: string;
+                            targetSlot?: {
+                                ams_id: number;
+                                slot_id: number;
+                            };
+                        }[];
+                        /** Format: uuid */
+                        printer_id?: string;
+                        /**
+                         * @description Create assigned jobs waiting for filament, or reject mismatches with 422
+                         * @default wait
+                         * @enum {string}
+                         */
+                        on_filament_mismatch?: "wait" | "reject";
+                        externalId?: string;
+                        /**
+                         * @default automatic
+                         * @enum {string}
+                         */
+                        release?: "automatic" | "manual";
+                        print_options?: {
+                            [key: string]: unknown;
+                        };
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            job?: {
+                                id: number;
+                                name?: string;
+                                status?: string;
+                                model_file_id?: string | null;
+                                printer_id?: string | null;
+                                organization_id?: string;
+                                print_options?: {
+                                    [key: string]: unknown;
+                                } | null;
+                            } & {
+                                [key: string]: unknown;
+                            };
+                            /** @description Detailed match results for fully eligible printers */
+                            eligiblePrinters?: {
+                                printerId?: string;
+                                match?: {
+                                    score?: number;
+                                    reasons?: string[];
+                                    matched_at?: string;
+                                    printer_id?: string;
+                                };
+                            }[];
+                            /** @description Detailed match results for partially eligible printers including missing materials */
+                            partiallyEligiblePrinters?: {
+                                printerId?: string;
+                                match?: {
+                                    score?: number;
+                                    reasons?: string[];
+                                    matched_at?: string;
+                                    printer_id?: string;
+                                    missing?: {
+                                        index?: number;
+                                        type?: string;
+                                        color?: string;
+                                        explicitMaterialId?: string;
+                                    }[];
+                                };
+                            }[];
+                        };
+                    };
+                };
+                /** @description Default Response */
+                202: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** Format: uuid */
+                            requestId: string;
+                            /** @enum {string} */
+                            status: "preparing" | "held" | "created" | "failed" | "cancelled";
+                            externalId: string | null;
+                            createdAt: string;
+                            job: ({
+                                id: number;
+                                status: string;
+                                /** Format: uuid */
+                                model_file_id: string | null;
+                                /** Format: uuid */
+                                printer_id: string | null;
+                                print_options: {
+                                    [key: string]: unknown;
+                                } | null;
+                            } & {
+                                [key: string]: unknown;
+                            }) | null;
+                            requiredActions: {
+                                [key: string]: unknown;
+                            }[];
+                            error: {
+                                [key: string]: unknown;
+                            } | null;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            reason?: string;
+                            retry_count?: number;
+                            max_retries?: number;
+                            next_eligible_at?: string | null;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @enum {string} */
+                            error?: "filament_requirements_unsatisfied" | "printer_model_incompatible" | "hardware:nozzle_diameter_mismatch" | "target_slot_unavailable" | "insufficient_filament_routes";
+                            message?: string;
+                            filaments?: {
+                                sourceSlot?: number;
+                                /** @enum {string} */
+                                reason?: "missing_material" | "color_distance" | "slot_empty" | "slot_conflict";
+                            }[];
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/print-jobs/create-requests/{requestId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Poll one asynchronous single-plate creation request */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    requestId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** Format: uuid */
+                            requestId: string;
+                            /** @enum {string} */
+                            status: "preparing" | "held" | "created" | "failed" | "cancelled";
+                            externalId: string | null;
+                            createdAt: string;
+                            job: ({
+                                id: number;
+                                status: string;
+                                /** Format: uuid */
+                                model_file_id: string | null;
+                                /** Format: uuid */
+                                printer_id: string | null;
+                                print_options: {
+                                    [key: string]: unknown;
+                                } | null;
+                            } & {
+                                [key: string]: unknown;
+                            }) | null;
+                            requiredActions: {
+                                [key: string]: unknown;
+                            }[];
+                            error: {
+                                [key: string]: unknown;
+                            } | null;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/print-jobs/create-requests/{requestId}/release": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Authorize admission of a manually held creation request */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    requestId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                202: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            authorized: boolean;
+                        };
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                            code?: string;
+                            statusCode?: number;
+                        };
+                    };
+                };
+                /** @description API key requires control scope */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                            code?: string;
+                            statusCode?: number;
+                        };
+                    };
+                };
+                /** @description Creation request not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                        };
+                    };
+                };
+                /** @description Creation request no longer supports this action */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/print-jobs/create-requests/{requestId}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Cancel a creation request before job admission */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    requestId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                202: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            cancelled: boolean;
+                        };
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                            code?: string;
+                            statusCode?: number;
+                        };
+                    };
+                };
+                /** @description API key requires control scope */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                            code?: string;
+                            statusCode?: number;
+                        };
+                    };
+                };
+                /** @description Creation request not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                        };
+                    };
+                };
+                /** @description Creation request no longer supports this action */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            message?: string;
+                            requestId?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 
 type PrintHiveOptions = {
@@ -1584,6 +2258,76 @@ type PrintHiveOptions = {
     timeoutMs?: number;
     maxRetries?: number;
 };
+type Request<T> = {
+    path: string;
+    decode: (response: Response) => Promise<T>;
+    query?: URLSearchParams;
+    signal?: AbortSignal;
+} & ({
+    method: "GET";
+} | {
+    method: "POST";
+    body: () => Promise<BodyInit>;
+    size?: number;
+    contentType?: string | null;
+    idempotencyKey: string;
+    replayable: boolean;
+});
+declare class Transport {
+    private readonly options;
+    constructor(options: PrintHiveOptions);
+    request<T>(request: Request<T>): Promise<T>;
+}
+
+type CreateOperation = paths["/v1/print-jobs/create"]["post"];
+type CreatedPrintJob = CreateOperation["responses"][201]["content"]["application/json"];
+type PrintJobCreateRequest = paths["/v1/print-jobs/create-requests/{requestId}"]["get"]["responses"][200]["content"]["application/json"];
+type JsonPrintJobInput = CreateOperation["requestBody"]["content"]["application/json"] & {
+    idempotencyKey?: string;
+};
+type UploadedPrintJobInput = Omit<CreateOperation["requestBody"]["content"]["multipart/form-data"], "file"> & {
+    file: string | Uint8Array;
+    filename: string;
+    idempotencyKey?: string;
+};
+declare class PrintJobCreateStoppedError extends Error {
+    readonly request: PrintJobCreateRequest;
+    constructor(request: PrintJobCreateRequest);
+}
+declare class PrintJobs {
+    private readonly transport;
+    constructor(transport: Transport);
+    create(input: UploadedPrintJobInput): Promise<PrintJobCreateRequest & {
+        idempotencyKey: string;
+    }>;
+    create(input: JsonPrintJobInput): Promise<CreatedPrintJob & {
+        idempotencyKey: string;
+    }>;
+    getCreateRequest(requestId: string, signal?: AbortSignal): Promise<PrintJobCreateRequest>;
+    waitUntilCreated(requestId: string, options?: WaitOptions): Promise<{
+        requestId: string;
+        status: "preparing" | "held" | "created" | "failed" | "cancelled";
+        externalId: string | null;
+        createdAt: string;
+        job: ({
+            id: number;
+            status: string;
+            model_file_id: string | null;
+            printer_id: string | null;
+            print_options: {
+                [key: string]: unknown;
+            } | null;
+        } & {
+            [key: string]: unknown;
+        }) | null;
+        requiredActions: {
+            [key: string]: unknown;
+        }[];
+        error: {
+            [key: string]: unknown;
+        } | null;
+    }>;
+}
 
 type ApiLimit = {
     name: string;
@@ -1718,6 +2462,7 @@ declare class PrintHive {
                 } | {
                     status: "missing";
                 };
+                printerModel?: string;
             };
         } | {
             sourceVersionId: string;
@@ -1783,6 +2528,7 @@ declare class PrintHive {
                 } | {
                     status: "missing";
                 };
+                printerModel?: string;
             } | null;
             error: {
                 code: "invalid_archive" | "unsafe_path" | "unsafe_xml" | "resource_limit" | "invalid_project" | "toolpath_only" | "processing_timeout" | "storage_object_changed" | "inspection_interrupted" | "upload_interrupted";
@@ -1887,6 +2633,7 @@ declare class PrintHive {
                     } | {
                         status: "missing";
                     };
+                    printerModel?: string;
                 };
             } | {
                 sourceVersionId: string;
@@ -1952,6 +2699,7 @@ declare class PrintHive {
                     } | {
                         status: "missing";
                     };
+                    printerModel?: string;
                 } | null;
                 error: {
                     code: "invalid_archive" | "unsafe_path" | "unsafe_xml" | "resource_limit" | "invalid_project" | "toolpath_only" | "processing_timeout" | "storage_object_changed" | "inspection_interrupted" | "upload_interrupted";
@@ -1966,7 +2714,15 @@ declare class PrintHive {
         }>;
         listSourceFiles(modelId: string): AsyncGenerator<PartnerSource>;
     };
+    readonly printers: {
+        list: (input?: {
+            limit?: number;
+            cursor?: string;
+        }) => Promise<unknown>;
+        get: (id: string) => Promise<unknown>;
+    };
+    readonly printJobs: PrintJobs;
     constructor(options: PrintHiveOptions);
 }
 
-export { type ApiErrorBody, type ApiLimit, type PartnerModel, type PartnerSource, PrintHive, PrintHiveApiError, PrintHiveNetworkError, type PrintHiveOptions, type UploadOptions, type WaitOptions, type paths };
+export { type ApiErrorBody, type ApiLimit, type CreatedPrintJob, type JsonPrintJobInput, type PartnerModel, type PartnerSource, PrintHive, PrintHiveApiError, PrintHiveNetworkError, type PrintHiveOptions, type PrintJobCreateRequest, PrintJobCreateStoppedError, type UploadOptions, type UploadedPrintJobInput, type WaitOptions, type paths };