npm - @poweredbysous/storefront-admin-sdk - Versions diffs - 4.7.1 → 4.8.0 - Mend

@poweredbysous/storefront-admin-sdk 4.7.1 → 4.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/index.d.cts CHANGED Viewed

@@ -554,7 +554,10 @@ interface paths {
          */
         get: operations["admin_printing_store_devices"];
         put?: never;
-        /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
+        /**
+         * @description Bind a printer with its provider for this store and save it
+         *     (backoffice only).
+         */
         post: operations["admin_printing_add_store_device"];
         delete?: never;
         options?: never;
@@ -579,6 +582,84 @@ interface paths {
         patch: operations["admin_printing_update_store_device"];
         trace?: never;
     };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/regenerate-secret/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description A new polling URL for an Epson printer; the old one stops at once. */
+        post: operations["admin_printing_regenerate_store_device_url"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/remove/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Remove a printer for good: it stops printing, its history stays. */
+        post: operations["admin_printing_remove_store_device"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/setup/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description An Epson printer's Web Config values, and whether it has polled yet.
+         *
+         *     The portal's setup card polls this while it is open: ``last_seen_at``
+         *     turns "Waiting for the printer" into "Connected". 404 for a Sunmi printer:
+         *     it has nothing to set up.
+         */
+        get: operations["admin_printing_store_device_setup"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/test-print/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Print one Test print slip, with no order, on this printer.
+         *
+         *     202 with the job; a repeated ``request_id`` returns the first job.
+         */
+        post: operations["admin_printing_test_print_store_device"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/admin/products/": {
         parameters: {
             query?: never;
@@ -4349,6 +4430,25 @@ interface components {
             eligible_promotions: components["schemas"]["EligiblePromotionItem"][];
             best_promotion_id: number | null;
         };
+        /** @description What to type into an Epson printer's Web Config (Server Direct Print). */
+        EpsonSetup: {
+            provider: components["schemas"]["ProviderEnum"];
+            /** @description Web Config "ID": the serial from the printer's label. */
+            printer_id: string;
+            /** @description Web Config "URL". Secret: whoever has it can read the store's slips. */
+            poll_url: string;
+            /** @description Web Config "Interval". */
+            interval_seconds: number;
+            /** @description Web Config "Server Authentication": true Enable, false Disable. */
+            server_authentication: boolean;
+            /**
+             * Format: date-time
+             * @description The printer's last poll. Null: it has not polled this URL yet ("Waiting for the printer").
+             */
+            last_seen_at: string | null;
+            /** @description Polled within three polling intervals, as the printer list's `online`. False after a first poll: it has stopped polling. */
+            online: boolean;
+        };
         /**
          * @description * `pending` - Pending
          *     * `fulfilled` - Fulfilled
@@ -4730,6 +4830,12 @@ interface components {
         };
         /** @enum {unknown} */
         NullEnum: null;
+        /**
+         * @description * `menubox` - menubox
+         *     * `shop` - shop
+         * @enum {string}
+         */
+        OfferingEnum: "menubox" | "shop";
         /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
         OpenStatus: {
             open: boolean;
@@ -5698,6 +5804,7 @@ interface components {
         };
         PrintDevice: {
             id: number;
+            provider: components["schemas"]["ProviderEnum"];
             name: string;
             /** @description The printer's serial number (Sunmi: the MSN on its label). */
             device_identifier: string;
@@ -5712,16 +5819,24 @@ 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. */
+            /** @description Sunmi: the last online check run by Sous staff, true online, false offline, null never checked; not live. Epson: live, true when the printer polled within three polling intervals. */
             online: boolean | null;
             /**
              * Format: date-time
-             * @description When that check ran.
+             * @description When the staff check ran. An Epson printer's live state comes from `last_seen_at` instead.
              */
             online_checked_at: string | null;
         };
         /** @description A backoffice user adds a printer to the store in the URL. */
         PrintDeviceCreateRequest: {
+            /**
+             * @description The printer's make. Sunmi is bound with Sunmi; an Epson printer gets its own polling URL (see the device's setup).
+             *
+             *     * `sunmi` - Sunmi
+             *     * `epson` - Epson
+             * @default sunmi
+             */
+            provider: components["schemas"]["ProviderEnum"];
             /** @description Serial from the printer's label, e.g. N439259A11700. */
             device_identifier: string;
             /** @description e.g. "Kitchen" */
@@ -5982,6 +6097,7 @@ interface components {
             /** Format: int64 */
             store_id: number;
             readonly product_type: components["schemas"]["ProductType"];
+            readonly offering: (components["schemas"]["OfferingEnum"] | components["schemas"]["NullEnum"]) | null;
             /** Format: decimal */
             price: string;
             /** Format: decimal */
@@ -6175,6 +6291,49 @@ interface components {
          * @enum {string}
          */
         PromotionTypeEnum: "buy_x_get_y" | "bogo";
+        /**
+         * @description * `sunmi` - Sunmi
+         *     * `epson` - Epson
+         * @enum {string}
+         */
+        ProviderEnum: "sunmi" | "epson";
+        /** @description The onboarding block the storefront reads: no portal-only ``setup``. */
+        PublicStoreOnboarding: {
+            slug: string;
+            name?: string;
+            tagline?: string;
+            description?: string;
+            logo_text?: string;
+            theme?: unknown;
+            layout?: string;
+            languages?: unknown;
+            default_language?: string;
+            currency?: string;
+            country?: string;
+            timezone?: string;
+            contact?: unknown;
+            hours?: unknown;
+            social?: unknown;
+            seo?: unknown;
+            fulfilment?: unknown;
+            cuisine?: string;
+            price_range?: string;
+            product_placeholder?: string;
+            analytics?: unknown;
+            labels?: unknown;
+            frame_ancestors?: unknown;
+            multi_store?: boolean;
+            brand_slug?: string;
+            default_store?: string;
+            readonly status: components["schemas"]["StoreOnboardingStatusEnum"];
+            /** Format: date-time */
+            readonly published_at: string | null;
+            /** Format: date-time */
+            readonly updated_at: string;
+            readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
+            readonly uber_direct_supported_countries: string[];
+            readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
+        };
         /** @description Serializer for the purchased gift card detail view. */
         PurchasedGiftCardDetail: {
             readonly id: number;
@@ -6426,7 +6585,7 @@ interface components {
                 [key: string]: unknown;
             } | null;
             readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
-            readonly onboarding: components["schemas"]["StoreOnboarding"] | null;
+            readonly onboarding: components["schemas"]["PublicStoreOnboarding"] | null;
             /**
              * @description False while the merchant has temporarily paused new orders.
              *
@@ -6468,6 +6627,8 @@ interface components {
         StoreDeliveryMethodStates: {
             store_public_id: string;
             methods: components["schemas"]["DeliveryMethodState"][];
+            /** @description Method ids (as in ``method``) the merchant chose in the unpublished onboarding draft that the company has no availability record for yet. Nothing is enabled until publish; a screen shows these as pending, not as on or off. */
+            pending_methods: string[];
         };
         StoreMeAddress: {
             address_1: string;
@@ -6487,49 +6648,6 @@ interface components {
             /** Format: double */
             longitude?: number | null;
         };
-        /**
-         * @description Read/write serializer for the store-onboarding wizard.
-         *
-         *     Supports partial updates (PATCH autosave). ``status`` and ``published_at``
-         *     are read-only — they are driven by the dedicated publish endpoint, not by
-         *     arbitrary field edits.
-         */
-        StoreOnboarding: {
-            slug: string;
-            name?: string;
-            tagline?: string;
-            description?: string;
-            logo_text?: string;
-            theme?: unknown;
-            layout?: string;
-            languages?: unknown;
-            default_language?: string;
-            currency?: string;
-            country?: string;
-            timezone?: string;
-            contact?: unknown;
-            hours?: unknown;
-            social?: unknown;
-            seo?: unknown;
-            fulfilment?: unknown;
-            cuisine?: string;
-            price_range?: string;
-            product_placeholder?: string;
-            analytics?: unknown;
-            labels?: unknown;
-            frame_ancestors?: unknown;
-            multi_store?: boolean;
-            brand_slug?: string;
-            default_store?: string;
-            readonly status: components["schemas"]["StoreOnboardingStatusEnum"];
-            /** Format: date-time */
-            readonly published_at: string | null;
-            /** Format: date-time */
-            readonly updated_at: string;
-            readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
-            readonly uber_direct_supported_countries: string[];
-            readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
-        };
         /**
          * @description * `draft` - Draft
          *     * `published` - Published
@@ -6576,6 +6694,14 @@ interface components {
          * @enum {string}
          */
         SurfaceEnum: "top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout";
+        /** @description ``request_id`` is generated per click: a retry prints nothing new. */
+        TestPrintRequest: {
+            /** Format: uuid */
+            request_id: string;
+        };
+        TestPrintResponse: {
+            job: components["schemas"]["PrintJob"];
+        };
         /**
          * @description * `info` - Info
          *     * `success` - Success
@@ -6632,11 +6758,12 @@ interface components {
             readonly created_at: string;
         };
         /**
-         * @description * `auto` - auto
-         *     * `manual` - manual
+         * @description * `auto` - Automatic (order arrived)
+         *     * `manual` - Manual (merchant portal)
+         *     * `test` - Test print (merchant portal)
          * @enum {string}
          */
-        TriggerEnum: "auto" | "manual";
+        TriggerEnum: "auto" | "manual" | "test";
         /**
          * @description * `authorization_request` - Authorization Request
          *     * `authorization_success` - Authorization Success
@@ -9553,6 +9680,354 @@ interface operations {
             };
         };
     };
+    admin_printing_regenerate_store_device_url: {
+        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?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EpsonSetup"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    admin_printing_remove_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?: never;
+        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_printing_store_device_setup: {
+        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?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EpsonSetup"];
+                };
+            };
+            /** @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_printing_test_print_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"]["TestPrintRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["TestPrintRequest"];
+                "multipart/form-data": components["schemas"]["TestPrintRequest"];
+            };
+        };
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TestPrintResponse"];
+                };
+            };
+            /** @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 CHANGED Viewed

@@ -554,7 +554,10 @@ interface paths {
          */
         get: operations["admin_printing_store_devices"];
         put?: never;
-        /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
+        /**
+         * @description Bind a printer with its provider for this store and save it
+         *     (backoffice only).
+         */
         post: operations["admin_printing_add_store_device"];
         delete?: never;
         options?: never;
@@ -579,6 +582,84 @@ interface paths {
         patch: operations["admin_printing_update_store_device"];
         trace?: never;
     };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/regenerate-secret/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description A new polling URL for an Epson printer; the old one stops at once. */
+        post: operations["admin_printing_regenerate_store_device_url"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/remove/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Remove a printer for good: it stops printing, its history stays. */
+        post: operations["admin_printing_remove_store_device"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/setup/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description An Epson printer's Web Config values, and whether it has polled yet.
+         *
+         *     The portal's setup card polls this while it is open: ``last_seen_at``
+         *     turns "Waiting for the printer" into "Connected". 404 for a Sunmi printer:
+         *     it has nothing to set up.
+         */
+        get: operations["admin_printing_store_device_setup"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/test-print/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Print one Test print slip, with no order, on this printer.
+         *
+         *     202 with the job; a repeated ``request_id`` returns the first job.
+         */
+        post: operations["admin_printing_test_print_store_device"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/admin/products/": {
         parameters: {
             query?: never;
@@ -4349,6 +4430,25 @@ interface components {
             eligible_promotions: components["schemas"]["EligiblePromotionItem"][];
             best_promotion_id: number | null;
         };
+        /** @description What to type into an Epson printer's Web Config (Server Direct Print). */
+        EpsonSetup: {
+            provider: components["schemas"]["ProviderEnum"];
+            /** @description Web Config "ID": the serial from the printer's label. */
+            printer_id: string;
+            /** @description Web Config "URL". Secret: whoever has it can read the store's slips. */
+            poll_url: string;
+            /** @description Web Config "Interval". */
+            interval_seconds: number;
+            /** @description Web Config "Server Authentication": true Enable, false Disable. */
+            server_authentication: boolean;
+            /**
+             * Format: date-time
+             * @description The printer's last poll. Null: it has not polled this URL yet ("Waiting for the printer").
+             */
+            last_seen_at: string | null;
+            /** @description Polled within three polling intervals, as the printer list's `online`. False after a first poll: it has stopped polling. */
+            online: boolean;
+        };
         /**
          * @description * `pending` - Pending
          *     * `fulfilled` - Fulfilled
@@ -4730,6 +4830,12 @@ interface components {
         };
         /** @enum {unknown} */
         NullEnum: null;
+        /**
+         * @description * `menubox` - menubox
+         *     * `shop` - shop
+         * @enum {string}
+         */
+        OfferingEnum: "menubox" | "shop";
         /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
         OpenStatus: {
             open: boolean;
@@ -5698,6 +5804,7 @@ interface components {
         };
         PrintDevice: {
             id: number;
+            provider: components["schemas"]["ProviderEnum"];
             name: string;
             /** @description The printer's serial number (Sunmi: the MSN on its label). */
             device_identifier: string;
@@ -5712,16 +5819,24 @@ 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. */
+            /** @description Sunmi: the last online check run by Sous staff, true online, false offline, null never checked; not live. Epson: live, true when the printer polled within three polling intervals. */
             online: boolean | null;
             /**
              * Format: date-time
-             * @description When that check ran.
+             * @description When the staff check ran. An Epson printer's live state comes from `last_seen_at` instead.
              */
             online_checked_at: string | null;
         };
         /** @description A backoffice user adds a printer to the store in the URL. */
         PrintDeviceCreateRequest: {
+            /**
+             * @description The printer's make. Sunmi is bound with Sunmi; an Epson printer gets its own polling URL (see the device's setup).
+             *
+             *     * `sunmi` - Sunmi
+             *     * `epson` - Epson
+             * @default sunmi
+             */
+            provider: components["schemas"]["ProviderEnum"];
             /** @description Serial from the printer's label, e.g. N439259A11700. */
             device_identifier: string;
             /** @description e.g. "Kitchen" */
@@ -5982,6 +6097,7 @@ interface components {
             /** Format: int64 */
             store_id: number;
             readonly product_type: components["schemas"]["ProductType"];
+            readonly offering: (components["schemas"]["OfferingEnum"] | components["schemas"]["NullEnum"]) | null;
             /** Format: decimal */
             price: string;
             /** Format: decimal */
@@ -6175,6 +6291,49 @@ interface components {
          * @enum {string}
          */
         PromotionTypeEnum: "buy_x_get_y" | "bogo";
+        /**
+         * @description * `sunmi` - Sunmi
+         *     * `epson` - Epson
+         * @enum {string}
+         */
+        ProviderEnum: "sunmi" | "epson";
+        /** @description The onboarding block the storefront reads: no portal-only ``setup``. */
+        PublicStoreOnboarding: {
+            slug: string;
+            name?: string;
+            tagline?: string;
+            description?: string;
+            logo_text?: string;
+            theme?: unknown;
+            layout?: string;
+            languages?: unknown;
+            default_language?: string;
+            currency?: string;
+            country?: string;
+            timezone?: string;
+            contact?: unknown;
+            hours?: unknown;
+            social?: unknown;
+            seo?: unknown;
+            fulfilment?: unknown;
+            cuisine?: string;
+            price_range?: string;
+            product_placeholder?: string;
+            analytics?: unknown;
+            labels?: unknown;
+            frame_ancestors?: unknown;
+            multi_store?: boolean;
+            brand_slug?: string;
+            default_store?: string;
+            readonly status: components["schemas"]["StoreOnboardingStatusEnum"];
+            /** Format: date-time */
+            readonly published_at: string | null;
+            /** Format: date-time */
+            readonly updated_at: string;
+            readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
+            readonly uber_direct_supported_countries: string[];
+            readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
+        };
         /** @description Serializer for the purchased gift card detail view. */
         PurchasedGiftCardDetail: {
             readonly id: number;
@@ -6426,7 +6585,7 @@ interface components {
                 [key: string]: unknown;
             } | null;
             readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
-            readonly onboarding: components["schemas"]["StoreOnboarding"] | null;
+            readonly onboarding: components["schemas"]["PublicStoreOnboarding"] | null;
             /**
              * @description False while the merchant has temporarily paused new orders.
              *
@@ -6468,6 +6627,8 @@ interface components {
         StoreDeliveryMethodStates: {
             store_public_id: string;
             methods: components["schemas"]["DeliveryMethodState"][];
+            /** @description Method ids (as in ``method``) the merchant chose in the unpublished onboarding draft that the company has no availability record for yet. Nothing is enabled until publish; a screen shows these as pending, not as on or off. */
+            pending_methods: string[];
         };
         StoreMeAddress: {
             address_1: string;
@@ -6487,49 +6648,6 @@ interface components {
             /** Format: double */
             longitude?: number | null;
         };
-        /**
-         * @description Read/write serializer for the store-onboarding wizard.
-         *
-         *     Supports partial updates (PATCH autosave). ``status`` and ``published_at``
-         *     are read-only — they are driven by the dedicated publish endpoint, not by
-         *     arbitrary field edits.
-         */
-        StoreOnboarding: {
-            slug: string;
-            name?: string;
-            tagline?: string;
-            description?: string;
-            logo_text?: string;
-            theme?: unknown;
-            layout?: string;
-            languages?: unknown;
-            default_language?: string;
-            currency?: string;
-            country?: string;
-            timezone?: string;
-            contact?: unknown;
-            hours?: unknown;
-            social?: unknown;
-            seo?: unknown;
-            fulfilment?: unknown;
-            cuisine?: string;
-            price_range?: string;
-            product_placeholder?: string;
-            analytics?: unknown;
-            labels?: unknown;
-            frame_ancestors?: unknown;
-            multi_store?: boolean;
-            brand_slug?: string;
-            default_store?: string;
-            readonly status: components["schemas"]["StoreOnboardingStatusEnum"];
-            /** Format: date-time */
-            readonly published_at: string | null;
-            /** Format: date-time */
-            readonly updated_at: string;
-            readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
-            readonly uber_direct_supported_countries: string[];
-            readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
-        };
         /**
          * @description * `draft` - Draft
          *     * `published` - Published
@@ -6576,6 +6694,14 @@ interface components {
          * @enum {string}
          */
         SurfaceEnum: "top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout";
+        /** @description ``request_id`` is generated per click: a retry prints nothing new. */
+        TestPrintRequest: {
+            /** Format: uuid */
+            request_id: string;
+        };
+        TestPrintResponse: {
+            job: components["schemas"]["PrintJob"];
+        };
         /**
          * @description * `info` - Info
          *     * `success` - Success
@@ -6632,11 +6758,12 @@ interface components {
             readonly created_at: string;
         };
         /**
-         * @description * `auto` - auto
-         *     * `manual` - manual
+         * @description * `auto` - Automatic (order arrived)
+         *     * `manual` - Manual (merchant portal)
+         *     * `test` - Test print (merchant portal)
          * @enum {string}
          */
-        TriggerEnum: "auto" | "manual";
+        TriggerEnum: "auto" | "manual" | "test";
         /**
          * @description * `authorization_request` - Authorization Request
          *     * `authorization_success` - Authorization Success
@@ -9553,6 +9680,354 @@ interface operations {
             };
         };
     };
+    admin_printing_regenerate_store_device_url: {
+        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?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EpsonSetup"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    admin_printing_remove_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?: never;
+        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_printing_store_device_setup: {
+        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?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EpsonSetup"];
+                };
+            };
+            /** @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_printing_test_print_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"]["TestPrintRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["TestPrintRequest"];
+                "multipart/form-data": components["schemas"]["TestPrintRequest"];
+            };
+        };
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TestPrintResponse"];
+                };
+            };
+            /** @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 CHANGED Viewed

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