@poweredbysous/storefront-all-sdk 4.18.0 → 4.20.0

package/dist/index.d.ts

@@ -598,7 +598,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;
@@ -623,6 +626,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;
@@ -8605,6 +8686,10 @@ interface components {
              * @description Storefront CustomerProfile.id of the logged-in customer, so the order can attribute Zeemijlen. Omitted for guest checkouts.
              */
             customer_profile_id?: string | null;
+            /** @description PostHog distinct_id. Dropped unless `attribution.consent` is `granted`. Stored on the checkout for the server PostHog capture; never forwarded to the order. */
+            posthog_distinct_id?: string;
+            /** @description PostHog $session_id. Dropped unless `attribution.consent` is `granted`. Stored on the checkout for the server PostHog capture; never forwarded to the order. */
+            posthog_session_id?: string;
         };
         CreateEdit: {
             /** @default  */
@@ -9073,6 +9158,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;
+        };
         EventBatch: {
             events: components["schemas"]["EventInput"][];
         };
@@ -9658,7 +9762,7 @@ interface components {
             party_sizes: {
                 [key: string]: number;
             };
-            /** @description Date (YYYY-MM-DD) to how many matching products can be delivered that day. The `date` parameter never narrows these counts. */
+            /** @description Date (YYYY-MM-DD) to how many matching products can be delivered that day. Counted without the `date` parameter; every other facet is counted with it. */
             servable_dates: {
                 [key: string]: number;
             };
@@ -9962,6 +10066,12 @@ interface components {
             token: string;
             user: components["schemas"]["UserMe"];
         };
+        /**
+         * @description * `menubox` - menubox
+         *     * `shop` - shop
+         * @enum {string}
+         */
+        OfferingEnum: "menubox" | "shop";
         /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
         OpenStatus: {
             open: boolean;
@@ -11106,6 +11216,7 @@ interface components {
             analytics?: unknown;
             labels?: unknown;
             frame_ancestors?: unknown;
+            setup?: unknown;
             multi_store?: boolean;
             brand_slug?: string;
             default_store?: string;
@@ -11179,6 +11290,7 @@ interface components {
         PriceSyncModeEnum: "report" | "write";
         PrintDevice: {
             id: number;
+            provider: components["schemas"]["ProviderEnum"];
             name: string;
             /** @description The printer's serial number (Sunmi: the MSN on its label). */
             device_identifier: string;
@@ -11193,16 +11305,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" */
@@ -11549,6 +11669,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 */
@@ -11794,6 +11915,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;
@@ -12342,7 +12506,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.
              *
@@ -12384,6 +12548,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;
@@ -12434,6 +12600,7 @@ interface components {
             analytics?: unknown;
             labels?: unknown;
             frame_ancestors?: unknown;
+            setup?: unknown;
             multi_store?: boolean;
             brand_slug?: string;
             default_store?: string;
@@ -12482,6 +12649,7 @@ interface components {
             analytics?: unknown;
             labels?: unknown;
             frame_ancestors?: unknown;
+            setup?: unknown;
             multi_store?: boolean;
             brand_slug?: string;
             default_store?: string;
@@ -12617,6 +12785,14 @@ interface components {
             /** Format: date-time */
             updated_at: string;
         };
+        /** @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
@@ -12676,11 +12852,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
@@ -15824,6 +16001,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?: {
@@ -29273,7 +29798,7 @@ interface operations {
                 /** @description Only products created within this many days. */
                 created_within_days?: number;
                 cuisine_tags?: string[];
-                /** @description The delivery date the reader has chosen (YYYY-MM-DD). A hint, not a filter: products that cannot be delivered that day are still listed and counted, and each result's `servable_dates` says whether it can. Add-to-cart is the authority. */
+                /** @description The delivery date the reader has chosen (YYYY-MM-DD). Only products that can be delivered that day are listed and counted. `facets.servable_dates` is still counted without it, so a calendar can offer the other days. Add-to-cart is the authority. */
                 date?: string;
                 fulfillment_types?: ("delivery" | "pickup" | "dinein")[];
                 /** @description Menu type slugs, for example `vegan` or `meat-fish`. */
@@ -29481,7 +30006,7 @@ interface operations {
                 /** @description Only products created within this many days. */
                 created_within_days?: number;
                 cuisine_tags?: string[];
-                /** @description The delivery date the reader has chosen (YYYY-MM-DD). A hint, not a filter: products that cannot be delivered that day are still listed and counted, and each result's `servable_dates` says whether it can. Add-to-cart is the authority. */
+                /** @description The delivery date the reader has chosen (YYYY-MM-DD). Only products that can be delivered that day are listed and counted. `facets.servable_dates` is still counted without it, so a calendar can offer the other days. Add-to-cart is the authority. */
                 date?: string;
                 fulfillment_types?: ("delivery" | "pickup" | "dinein")[];
                 /** @description Menu type slugs, for example `vegan` or `meat-fish`. */