@scanlab/api-types 0.0.1 → 0.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scanlab/api-types",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "TypeScript types for the ScanLab API",
   "main": "scanlab-api.d.ts",
   "types": "scanlab-api.d.ts",

package/scanlab-api.d.ts

@@ -63,6 +63,94 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/admin/orders": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Retrieves all orders, with all fields */
+        get: operations["adminGetOrders"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/admin/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, with all fields */
+        get: operations["adminGetOrder"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/admin/orders/status": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** Updates the status of an order */
+        patch: operations["adminUpdateOrderStatus"];
+        trace?: never;
+    };
+    "/admin/orders/image-count": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** Updates the image count for an order */
+        patch: operations["updateOrderImageCount"];
+        trace?: never;
+    };
+    "/admin/orders/download-link": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** Updates the image count for an order */
+        patch: operations["updateOrderImageCount"];
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -75,7 +163,6 @@ export interface components {
          *     - `completed`: Film has been digitalized
          *     - `paid`: Order has been paid
          *     - `cancelled`: Order cancelled
-         *
          * @example pending
          * @enum {string}
          */
@@ -94,6 +181,12 @@ export interface components {
              * @example 2025-04-05T10:30:00Z
              */
             createdAt: string;
+            /**
+             * Format: date-time
+             * @description ISO 8601 timestamp of when the order was updated
+             * @example 2025-04-05T10:30:00Z
+             */
+            updatedAt?: string;
             /**
              * Format: float
              * @description Price of the order (optional)
@@ -101,11 +194,26 @@ export interface components {
              */
             price?: number;
             /**
-             * Format: date-time
-             * @description ISO 8601 timestamp of payment (optional)
-             * @example 2025-04-10T14:00:00Z
+             * @description Number of images in the order (optional)
+             * @example 5
+             */
+            imageCount?: number;
+            /**
+             * @description Whether a discount was applied to the order
+             * @example true
+             */
+            withDiscount?: boolean | null;
+            /**
+             * Format: uri
+             * @description Link to download the digitalized images
+             * @example https://example.com/download/ATX-B2C
              */
-            paidAt?: string;
+            downloadLink?: string | null;
+            /**
+             * @description The final price after applying the discount (optional)
+             * @example 10
+             */
+            discountedPrice?: number | null;
         };
         /** @description Data Transfer Object for an order's status history */
         OrderStatusHistoryDto: {
@@ -126,6 +234,11 @@ export interface components {
             value?: unknown;
         };
         ErrorResponse: {
+            /**
+             * @description HTTP status code of the error
+             * @example 404
+             */
+            status?: number;
             /**
              * @description Application-specific error code
              * @example ORDER_NOT_FOUND
@@ -330,4 +443,170 @@ export interface operations {
             };
         };
     };
+    adminGetOrders: {
+        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"][];
+                };
+            };
+        };
+    };
+    adminGetOrder: {
+        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"];
+                };
+            };
+        };
+    };
+    adminUpdateOrderStatus: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Object containing the order code and new status */
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Unique code of the order
+                     * @example ATX-B2C
+                     */
+                    code: string;
+                    status: components["schemas"]["OrderStatus"];
+                };
+            };
+        };
+        responses: {
+            /** @description Order status successfully updated */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example Order status updated successfully */
+                        message?: string;
+                    };
+                };
+            };
+        };
+    };
+    updateOrderImageCount: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Object containing the order code and new image count */
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Unique code of the order
+                     * @example ATX-B2C
+                     */
+                    code: string;
+                    /**
+                     * @description New image count for the order
+                     * @example 10
+                     */
+                    imageCount: number;
+                };
+            };
+        };
+        responses: {
+            /** @description Image count successfully updated */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example Order image count updated successfully */
+                        message?: string;
+                    };
+                };
+            };
+        };
+    };
+    updateOrderImageCount: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Object containing the order code and new image count */
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Unique code of the order
+                     * @example ATX-B2C
+                     */
+                    code: string;
+                    /**
+                     * Format: uri
+                     * @description New download link for the order
+                     * @example https://example.com/download/ATX-B2C
+                     */
+                    downloadLink?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Image count successfully updated */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example Order download link updated successfully */
+                        message?: string;
+                    };
+                };
+            };
+        };
+    };
 }