@scanlab/api-types 0.0.1

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@scanlab/api-types",
+  "version": "0.0.1",
+  "description": "TypeScript types for the ScanLab API",
+  "main": "scanlab-api.d.ts",
+  "types": "scanlab-api.d.ts",
+  "keywords": [
+    "api",
+    "deno",
+    "film-scanning",
+    "openapi",
+    "order-management",
+    "scanlab",
+    "types",
+    "typescript"
+  ],
+  "author": "Tony Spegel",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TonySpegel/scan-lab-api.git"
+  }
+}

package/scanlab-api.d.ts

@@ -0,0 +1,333 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/orders": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Retrieves all orders */
+        get: operations["getOrders"];
+        put?: never;
+        /** Creates a new order */
+        post: operations["createOrder"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/orders/{code}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique code of the order */
+                code: string;
+            };
+            cookie?: never;
+        };
+        /** Retrieves a specific order by its code */
+        get: operations["getOrder"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** Updates the status of an existing order */
+        patch: operations["updateOrderStatus"];
+        trace?: never;
+    };
+    "/orders/{code}/status-history": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique code of the order */
+                code: string;
+            };
+            cookie?: never;
+        };
+        /** Retrieves the status history of a specific order */
+        get: operations["getOrderStatusHistory"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * @description Status of the order:
+         *     - `pending`: Order has been created, but film has not yet been received
+         *     - `received`: Film has been received
+         *     - `processing`: Film has been received and is being processed
+         *     - `completed`: Film has been digitalized
+         *     - `paid`: Order has been paid
+         *     - `cancelled`: Order cancelled
+         *
+         * @example pending
+         * @enum {string}
+         */
+        OrderStatus: "pending" | "received" | "processing" | "completed" | "paid" | "cancelled";
+        /** @description Data Transfer Object for an order (API response) */
+        OrderDto: {
+            /**
+             * @description Unique code of the order
+             * @example ATX-B2C
+             */
+            code: string;
+            status: components["schemas"]["OrderStatus"];
+            /**
+             * Format: date-time
+             * @description ISO 8601 timestamp of when the order was created
+             * @example 2025-04-05T10:30:00Z
+             */
+            createdAt: string;
+            /**
+             * Format: float
+             * @description Price of the order (optional)
+             * @example 15.99
+             */
+            price?: number;
+            /**
+             * Format: date-time
+             * @description ISO 8601 timestamp of payment (optional)
+             * @example 2025-04-10T14:00:00Z
+             */
+            paidAt?: string;
+        };
+        /** @description Data Transfer Object for an order's status history */
+        OrderStatusHistoryDto: {
+            status: components["schemas"]["OrderStatus"];
+            /**
+             * Format: date-time
+             * @description ISO 8601 timestamp of when the status was changed
+             * @example 2025-04-06T12:00:00Z
+             */
+            changedAt: string;
+        };
+        ErrorDetail: {
+            /** @description The field related to the error */
+            field?: string;
+            /** @description Specific error message for the field */
+            message?: string;
+            /** @description The value that caused the error (optional, type may vary) */
+            value?: unknown;
+        };
+        ErrorResponse: {
+            /**
+             * @description Application-specific error code
+             * @example ORDER_NOT_FOUND
+             */
+            code?: string;
+            /**
+             * @description General error message
+             * @example Order not found
+             */
+            message?: string;
+            errors?: components["schemas"]["ErrorDetail"][];
+        };
+        SuccessMessage: {
+            /** @example Operation successful */
+            message: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getOrders: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A list of all orders */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrderDto"][];
+                };
+            };
+        };
+    };
+    createOrder: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Object containing the details of the new order */
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Unique code of the order
+                     * @example ATX-B2C
+                     */
+                    code: string;
+                    status: components["schemas"]["OrderStatus"];
+                    /**
+                     * Format: float
+                     * @description Price of the order (optional)
+                     * @example 15.99
+                     */
+                    price?: number;
+                };
+            };
+        };
+        responses: {
+            /** @description Order successfully created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuccessMessage"];
+                };
+            };
+            /** @description Invalid request (e.g., missing required fields) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    getOrder: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique code of the order */
+                code: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful query, returns the order details */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrderDto"];
+                };
+            };
+            /** @description Order with the given code not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    updateOrderStatus: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique code of the order */
+                code: string;
+            };
+            cookie?: never;
+        };
+        /** @description Object with the new status for the order */
+        requestBody: {
+            content: {
+                "application/json": {
+                    status: components["schemas"]["OrderStatus"];
+                };
+            };
+        };
+        responses: {
+            /** @description Order status successfully updated */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuccessMessage"];
+                };
+            };
+            /** @description Invalid request (e.g. status missing in body, invalid body, missing code in path - even though path parameter is required) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    getOrderStatusHistory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique code of the order */
+                code: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A list of status changes for the specified order */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrderStatusHistoryDto"][];
+                };
+            };
+            /** @description No status history found for the given order code */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+}