@poweredbysous/storefront-admin-sdk 4.4.0 → 4.5.0

package/dist/index.d.cts

@@ -547,16 +547,38 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description The store's enabled cloud printers. An empty list: no cloud printing. */
+        /**
+         * @description The store's enabled cloud printers (an empty list: no cloud printing).
+         *
+         *     Backoffice can add one.
+         */
         get: operations["admin_printing_store_devices"];
         put?: never;
-        post?: never;
+        /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
+        post: operations["admin_printing_add_store_device"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** @description One printer of the store: change its tickets per order (backoffice only). */
+        patch: operations["admin_printing_update_store_device"];
+        trace?: never;
+    };
     "/api/v1/admin/products/": {
         parameters: {
             query?: never;
@@ -5170,6 +5192,9 @@ interface components {
             dismiss_duration?: string | null;
             targeting?: unknown;
         };
+        PatchedPrintDeviceUpdateRequest: {
+            copies?: number;
+        };
         PatchedProductChannelListing: {
             readonly id?: number;
             readonly product_id?: number;
@@ -5312,6 +5337,10 @@ interface components {
         PrintDevice: {
             id: number;
             name: string;
+            /** @description The printer's serial number (Sunmi: the MSN on its label). */
+            device_identifier: string;
+            /** @description Tickets per automatic print. A manual print is always one. */
+            copies: number;
             /**
              * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
              *
@@ -5321,6 +5350,25 @@ interface components {
             alert_state: components["schemas"]["AlertStateEnum"];
             /** Format: date-time */
             last_seen_at: string | null;
+            /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
+            online: boolean | null;
+            /**
+             * Format: date-time
+             * @description When that check ran.
+             */
+            online_checked_at: string | null;
+        };
+        /** @description A backoffice user adds a printer to the store in the URL. */
+        PrintDeviceCreateRequest: {
+            /** @description Serial from the printer's label, e.g. N439259A11700. */
+            device_identifier: string;
+            /** @description e.g. "Kitchen" */
+            name: string;
+            /**
+             * @description Tickets per automatic print.
+             * @default 1
+             */
+            copies: number;
         };
         PrintDevicesResponse: {
             devices: components["schemas"]["PrintDevice"][];
@@ -8885,6 +8933,223 @@ interface operations {
             };
         };
     };
+    admin_printing_add_store_device: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PrintDeviceCreateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
+                "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    admin_printing_update_store_device: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                device_id: number;
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
     admin_products_list: {
         parameters: {
             query?: {

package/dist/index.d.ts

@@ -547,16 +547,38 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description The store's enabled cloud printers. An empty list: no cloud printing. */
+        /**
+         * @description The store's enabled cloud printers (an empty list: no cloud printing).
+         *
+         *     Backoffice can add one.
+         */
         get: operations["admin_printing_store_devices"];
         put?: never;
-        post?: never;
+        /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
+        post: operations["admin_printing_add_store_device"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** @description One printer of the store: change its tickets per order (backoffice only). */
+        patch: operations["admin_printing_update_store_device"];
+        trace?: never;
+    };
     "/api/v1/admin/products/": {
         parameters: {
             query?: never;
@@ -5170,6 +5192,9 @@ interface components {
             dismiss_duration?: string | null;
             targeting?: unknown;
         };
+        PatchedPrintDeviceUpdateRequest: {
+            copies?: number;
+        };
         PatchedProductChannelListing: {
             readonly id?: number;
             readonly product_id?: number;
@@ -5312,6 +5337,10 @@ interface components {
         PrintDevice: {
             id: number;
             name: string;
+            /** @description The printer's serial number (Sunmi: the MSN on its label). */
+            device_identifier: string;
+            /** @description Tickets per automatic print. A manual print is always one. */
+            copies: number;
             /**
              * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
              *
@@ -5321,6 +5350,25 @@ interface components {
             alert_state: components["schemas"]["AlertStateEnum"];
             /** Format: date-time */
             last_seen_at: string | null;
+            /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
+            online: boolean | null;
+            /**
+             * Format: date-time
+             * @description When that check ran.
+             */
+            online_checked_at: string | null;
+        };
+        /** @description A backoffice user adds a printer to the store in the URL. */
+        PrintDeviceCreateRequest: {
+            /** @description Serial from the printer's label, e.g. N439259A11700. */
+            device_identifier: string;
+            /** @description e.g. "Kitchen" */
+            name: string;
+            /**
+             * @description Tickets per automatic print.
+             * @default 1
+             */
+            copies: number;
         };
         PrintDevicesResponse: {
             devices: components["schemas"]["PrintDevice"][];
@@ -8885,6 +8933,223 @@ interface operations {
             };
         };
     };
+    admin_printing_add_store_device: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PrintDeviceCreateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
+                "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    admin_printing_update_store_device: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                device_id: number;
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
     admin_products_list: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poweredbysous/storefront-admin-sdk",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Type-safe TypeScript SDK for SOUS Storefront Backend admin endpoints",
   "license": "UNLICENSED",
   "private": false,