@poweredbysous/storefront-sdk 2.4.0 → 3.0.1

package/dist/index.d.cts

@@ -1414,6 +1414,40 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/merchant-comms/storefront/active/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Adds .store property to views for readability. */
+        get: operations["merchant_comms_storefront_active_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/merchant-comms/storefront/events/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Adds .store property to views for readability. */
+        post: operations["merchant_comms_storefront_events_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/merchant/me/": {
         parameters: {
             query?: never;
@@ -2835,6 +2869,102 @@ interface components {
          * @enum {string}
          */
         ChangeTypeEnum: "add" | "remove" | "quantity_change" | "option_change" | "adjustment";
+        /** @description Serialized checkout data for API responses. */
+        Checkout: {
+            id: string;
+            cart_id: string;
+            store_id: number;
+            channel_id: number | null;
+            status: string;
+            currency: string;
+            display_currency: string;
+            fx_rate_to_display: string;
+            email: string | null;
+            shipping_address: {
+                [key: string]: unknown;
+            } | null;
+            billing_address: {
+                [key: string]: unknown;
+            } | null;
+            shipping_method: {
+                [key: string]: string;
+            } | null;
+            payment_method: string | null;
+            payment_status: string | null;
+            line_items: {
+                [key: string]: unknown;
+            }[];
+            tax_components: {
+                [key: string]: unknown;
+            }[];
+            subtotal: string;
+            tax_total: string;
+            shipping_cost: string;
+            surcharge_total: string;
+            display_surcharge_total: string;
+            deposit_total: string;
+            display_deposit_total: string;
+            packaging_choice: string;
+            discount_amount: string;
+            discount_code: string | null;
+            discount_name: string | null;
+            applied_promotion_id: number | null;
+            promotion_discount_amount: string;
+            total: string;
+            service_fees: {
+                [key: string]: unknown;
+            };
+            platform_fee_customer: string;
+            platform_fee_merchant: string;
+            delivery_fee_customer: string;
+            delivery_fee_merchant: string;
+            service_fees_total: string;
+            display_service_fees_total: string;
+            display_subtotal: string;
+            display_tax_total: string;
+            display_shipping_cost: string;
+            display_discount_amount: string;
+            display_promotion_discount_amount: string;
+            display_total: string;
+            fulfillment_slot_id: string | null;
+            service_point_id: string | null;
+            gift_card_details: {
+                [key: string]: unknown;
+            } | null;
+            gift_card_redemptions: {
+                id: number;
+                masked_code: string;
+                amount: string;
+                currency: string;
+                state: string;
+            }[];
+            gift_card_redemption_amount: string;
+            display_gift_card_redemption_amount: string;
+            points_to_redeem: number;
+            points_discount_amount: string;
+            display_points_discount_amount: string;
+            customer_id: number | null;
+            order_number: string | null;
+            purpose: string;
+            attribution: {
+                [key: string]: string;
+            } | null;
+            marketing_consent: {
+                [key: string]: unknown;
+            } | null;
+            warnings: {
+                [key: string]: string;
+            }[];
+            available_payment_gateways: {
+                [key: string]: unknown;
+            }[] | null;
+            created_at: string | null;
+            updated_at: string | null;
+            shipping_groups: {
+                id: string;
+                required_minimum_age: number | null;
+            }[];
+        };
         /**
          * @description Ad-click and campaign identifiers captured by the storefront at landing.
          *
@@ -3023,6 +3153,25 @@ interface components {
             eligible_promotions: components["schemas"]["EligiblePromotionItem"][];
             best_promotion_id: number | null;
         };
+        EventBatch: {
+            events: components["schemas"]["EventInput"][];
+        };
+        EventInput: {
+            /** Format: uuid */
+            message_id: string;
+            /** Format: uuid */
+            content_id?: string | null;
+            event_type: components["schemas"]["EventTypeEnum"];
+            subject_key: string;
+            metadata?: unknown;
+        };
+        /**
+         * @description * `impression` - Impression
+         *     * `click` - Click
+         *     * `dismiss` - Dismiss
+         * @enum {string}
+         */
+        EventTypeEnum: "impression" | "click" | "dismiss";
         /**
          * @description * `nationwide_delivery` - Nationwide Delivery
          *     * `local_delivery` - Local Delivery
@@ -4605,6 +4754,16 @@ interface components {
             surcharge_type: string;
             is_active?: boolean;
         };
+        /**
+         * @description * `top_banner` - Top Banner
+         *     * `bottom_banner` - Bottom Banner
+         *     * `modal` - Modal
+         *     * `toast` - Toast
+         *     * `inline_cart` - Inline Cart
+         *     * `inline_checkout` - Inline Checkout
+         * @enum {string}
+         */
+        SurfaceEnum: "top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout";
         TableSession: {
             /** Format: uuid */
             id: string;
@@ -4618,6 +4777,15 @@ interface components {
             /** Format: date-time */
             updated_at: string;
         };
+        /**
+         * @description * `info` - Info
+         *     * `success` - Success
+         *     * `warning` - Warning
+         *     * `urgent` - Urgent
+         *     * `promotional` - Promotional
+         * @enum {string}
+         */
+        ThemeEnum: "info" | "success" | "warning" | "urgent" | "promotional";
         TokenRefreshResponse: {
             token: string;
         };
@@ -4748,6 +4916,31 @@ interface components {
             value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
+        /** @description Slim serializer for the widget delivery endpoint. */
+        WidgetMessage: {
+            /** Format: uuid */
+            readonly id: string;
+            /** @description Lower values display first. */
+            priority?: number;
+            dismissible?: boolean;
+            /** @description How long a dismiss lasts. NULL = permanent until message updated. */
+            dismiss_duration?: string | null;
+            readonly contents: components["schemas"]["WidgetMessageContent"][];
+        };
+        WidgetMessageContent: {
+            /** Format: uuid */
+            readonly id: string;
+            surface: components["schemas"]["SurfaceEnum"];
+            readonly headline: string;
+            readonly body: string;
+            readonly cta_label: string;
+            /** Format: uri */
+            cta_url?: string;
+            theme?: components["schemas"]["ThemeEnum"];
+            /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
+            custom_colors?: unknown;
+            extra?: unknown;
+        };
         /** @description POST /api/v1/withdrawals/confirm input. */
         WithdrawalConfirmRequest: {
             token: string;
@@ -5606,7 +5799,7 @@ interface operations {
             query?: {
                 /** @description Delivery destination city. */
                 address_city?: string;
-                /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE). Case-insensitive. */
+                /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE). Case-insensitive; any other value is ignored. Unlike a live quote it needs no street or city: a nationwide carrier prices by country, so latitude, longitude, postal_code and this can return cost_known=true. Omit postal_code and a carrier whose service area lists postcodes is left out of the estimate. */
                 address_country?: string;
                 /** @description Delivery destination street line. Required together with address_city and address_country to trigger a live shipping quote (e.g. from Uber Direct); without all three the shipping_estimate group will report cost_known=false. */
                 address_street?: string;
@@ -6924,9 +7117,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `PRODUCT_UNAVAILABLE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7022,9 +7213,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7230,9 +7419,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `GIFT_CARD_EMPTY`, `GIFT_CARD_INVALID_CODE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7331,9 +7518,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7432,9 +7617,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7527,9 +7710,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_NOT_PAID`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7756,9 +7937,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7955,9 +8134,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8056,9 +8233,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8462,9 +8637,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8655,9 +8828,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8750,9 +8921,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8845,9 +9014,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -11864,6 +12031,163 @@ interface operations {
             };
         };
     };
+    merchant_comms_storefront_active_list: {
+        parameters: {
+            query?: {
+                /** @description Surface types to fetch. Repeat the key (?surfaces=a&surfaces=b) as the array schema implies; a single comma-separated value is also accepted. */
+                surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WidgetMessage"][];
+                };
+            };
+            /** @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": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    merchant_comms_storefront_events_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["EventBatch"];
+                "application/x-www-form-urlencoded": components["schemas"]["EventBatch"];
+                "multipart/form-data": components["schemas"]["EventBatch"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @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": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     merchant_me_retrieve: {
         parameters: {
             query?: never;
@@ -14976,7 +15300,11 @@ interface operations {
     };
     pickup_locations_time_slots_retrieve: {
         parameters: {
-            query?: {
+            query: {
+                /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
+                date: string;
+                /** @description Set to `local_delivery` to return own-delivery slots. */
+                fulfillment_type?: string;
                 /** @description Language override for translated content. The primary mechanism is the `Accept-Language` header; this query parameter is an override for widget embedding where merchants cannot control browser headers. Defaults to `en`. */
                 lang?: string;
             };
@@ -15212,6 +15540,8 @@ interface operations {
     products_list: {
         parameters: {
             query?: {
+                /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE), used with latitude and longitude. A nationwide carrier that declares per-country service areas only offers its products once the country is known. Case-insensitive; any other value is treated as no country. */
+                country?: string;
                 /** @description Sort order for products. Use '-popularity' for most popular first. */
                 ordering?: "-popularity" | "-position" | "position";
                 /** @description A page number within the paginated result set. */

package/dist/index.d.ts

@@ -1414,6 +1414,40 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/merchant-comms/storefront/active/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Adds .store property to views for readability. */
+        get: operations["merchant_comms_storefront_active_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/merchant-comms/storefront/events/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Adds .store property to views for readability. */
+        post: operations["merchant_comms_storefront_events_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/merchant/me/": {
         parameters: {
             query?: never;
@@ -2835,6 +2869,102 @@ interface components {
          * @enum {string}
          */
         ChangeTypeEnum: "add" | "remove" | "quantity_change" | "option_change" | "adjustment";
+        /** @description Serialized checkout data for API responses. */
+        Checkout: {
+            id: string;
+            cart_id: string;
+            store_id: number;
+            channel_id: number | null;
+            status: string;
+            currency: string;
+            display_currency: string;
+            fx_rate_to_display: string;
+            email: string | null;
+            shipping_address: {
+                [key: string]: unknown;
+            } | null;
+            billing_address: {
+                [key: string]: unknown;
+            } | null;
+            shipping_method: {
+                [key: string]: string;
+            } | null;
+            payment_method: string | null;
+            payment_status: string | null;
+            line_items: {
+                [key: string]: unknown;
+            }[];
+            tax_components: {
+                [key: string]: unknown;
+            }[];
+            subtotal: string;
+            tax_total: string;
+            shipping_cost: string;
+            surcharge_total: string;
+            display_surcharge_total: string;
+            deposit_total: string;
+            display_deposit_total: string;
+            packaging_choice: string;
+            discount_amount: string;
+            discount_code: string | null;
+            discount_name: string | null;
+            applied_promotion_id: number | null;
+            promotion_discount_amount: string;
+            total: string;
+            service_fees: {
+                [key: string]: unknown;
+            };
+            platform_fee_customer: string;
+            platform_fee_merchant: string;
+            delivery_fee_customer: string;
+            delivery_fee_merchant: string;
+            service_fees_total: string;
+            display_service_fees_total: string;
+            display_subtotal: string;
+            display_tax_total: string;
+            display_shipping_cost: string;
+            display_discount_amount: string;
+            display_promotion_discount_amount: string;
+            display_total: string;
+            fulfillment_slot_id: string | null;
+            service_point_id: string | null;
+            gift_card_details: {
+                [key: string]: unknown;
+            } | null;
+            gift_card_redemptions: {
+                id: number;
+                masked_code: string;
+                amount: string;
+                currency: string;
+                state: string;
+            }[];
+            gift_card_redemption_amount: string;
+            display_gift_card_redemption_amount: string;
+            points_to_redeem: number;
+            points_discount_amount: string;
+            display_points_discount_amount: string;
+            customer_id: number | null;
+            order_number: string | null;
+            purpose: string;
+            attribution: {
+                [key: string]: string;
+            } | null;
+            marketing_consent: {
+                [key: string]: unknown;
+            } | null;
+            warnings: {
+                [key: string]: string;
+            }[];
+            available_payment_gateways: {
+                [key: string]: unknown;
+            }[] | null;
+            created_at: string | null;
+            updated_at: string | null;
+            shipping_groups: {
+                id: string;
+                required_minimum_age: number | null;
+            }[];
+        };
         /**
          * @description Ad-click and campaign identifiers captured by the storefront at landing.
          *
@@ -3023,6 +3153,25 @@ interface components {
             eligible_promotions: components["schemas"]["EligiblePromotionItem"][];
             best_promotion_id: number | null;
         };
+        EventBatch: {
+            events: components["schemas"]["EventInput"][];
+        };
+        EventInput: {
+            /** Format: uuid */
+            message_id: string;
+            /** Format: uuid */
+            content_id?: string | null;
+            event_type: components["schemas"]["EventTypeEnum"];
+            subject_key: string;
+            metadata?: unknown;
+        };
+        /**
+         * @description * `impression` - Impression
+         *     * `click` - Click
+         *     * `dismiss` - Dismiss
+         * @enum {string}
+         */
+        EventTypeEnum: "impression" | "click" | "dismiss";
         /**
          * @description * `nationwide_delivery` - Nationwide Delivery
          *     * `local_delivery` - Local Delivery
@@ -4605,6 +4754,16 @@ interface components {
             surcharge_type: string;
             is_active?: boolean;
         };
+        /**
+         * @description * `top_banner` - Top Banner
+         *     * `bottom_banner` - Bottom Banner
+         *     * `modal` - Modal
+         *     * `toast` - Toast
+         *     * `inline_cart` - Inline Cart
+         *     * `inline_checkout` - Inline Checkout
+         * @enum {string}
+         */
+        SurfaceEnum: "top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout";
         TableSession: {
             /** Format: uuid */
             id: string;
@@ -4618,6 +4777,15 @@ interface components {
             /** Format: date-time */
             updated_at: string;
         };
+        /**
+         * @description * `info` - Info
+         *     * `success` - Success
+         *     * `warning` - Warning
+         *     * `urgent` - Urgent
+         *     * `promotional` - Promotional
+         * @enum {string}
+         */
+        ThemeEnum: "info" | "success" | "warning" | "urgent" | "promotional";
         TokenRefreshResponse: {
             token: string;
         };
@@ -4748,6 +4916,31 @@ interface components {
             value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
+        /** @description Slim serializer for the widget delivery endpoint. */
+        WidgetMessage: {
+            /** Format: uuid */
+            readonly id: string;
+            /** @description Lower values display first. */
+            priority?: number;
+            dismissible?: boolean;
+            /** @description How long a dismiss lasts. NULL = permanent until message updated. */
+            dismiss_duration?: string | null;
+            readonly contents: components["schemas"]["WidgetMessageContent"][];
+        };
+        WidgetMessageContent: {
+            /** Format: uuid */
+            readonly id: string;
+            surface: components["schemas"]["SurfaceEnum"];
+            readonly headline: string;
+            readonly body: string;
+            readonly cta_label: string;
+            /** Format: uri */
+            cta_url?: string;
+            theme?: components["schemas"]["ThemeEnum"];
+            /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
+            custom_colors?: unknown;
+            extra?: unknown;
+        };
         /** @description POST /api/v1/withdrawals/confirm input. */
         WithdrawalConfirmRequest: {
             token: string;
@@ -5606,7 +5799,7 @@ interface operations {
             query?: {
                 /** @description Delivery destination city. */
                 address_city?: string;
-                /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE). Case-insensitive. */
+                /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE). Case-insensitive; any other value is ignored. Unlike a live quote it needs no street or city: a nationwide carrier prices by country, so latitude, longitude, postal_code and this can return cost_known=true. Omit postal_code and a carrier whose service area lists postcodes is left out of the estimate. */
                 address_country?: string;
                 /** @description Delivery destination street line. Required together with address_city and address_country to trigger a live shipping quote (e.g. from Uber Direct); without all three the shipping_estimate group will report cost_known=false. */
                 address_street?: string;
@@ -6924,9 +7117,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `PRODUCT_UNAVAILABLE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7022,9 +7213,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7230,9 +7419,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `GIFT_CARD_EMPTY`, `GIFT_CARD_INVALID_CODE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7331,9 +7518,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7432,9 +7617,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7527,9 +7710,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_NOT_PAID`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7756,9 +7937,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7955,9 +8134,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8056,9 +8233,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8462,9 +8637,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8655,9 +8828,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8750,9 +8921,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8845,9 +9014,7 @@ interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        [key: string]: unknown;
-                    };
+                    "application/json": components["schemas"]["Checkout"];
                 };
             };
             /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -11864,6 +12031,163 @@ interface operations {
             };
         };
     };
+    merchant_comms_storefront_active_list: {
+        parameters: {
+            query?: {
+                /** @description Surface types to fetch. Repeat the key (?surfaces=a&surfaces=b) as the array schema implies; a single comma-separated value is also accepted. */
+                surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WidgetMessage"][];
+                };
+            };
+            /** @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": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    merchant_comms_storefront_events_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["EventBatch"];
+                "application/x-www-form-urlencoded": components["schemas"]["EventBatch"];
+                "multipart/form-data": components["schemas"]["EventBatch"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @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": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     merchant_me_retrieve: {
         parameters: {
             query?: never;
@@ -14976,7 +15300,11 @@ interface operations {
     };
     pickup_locations_time_slots_retrieve: {
         parameters: {
-            query?: {
+            query: {
+                /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
+                date: string;
+                /** @description Set to `local_delivery` to return own-delivery slots. */
+                fulfillment_type?: string;
                 /** @description Language override for translated content. The primary mechanism is the `Accept-Language` header; this query parameter is an override for widget embedding where merchants cannot control browser headers. Defaults to `en`. */
                 lang?: string;
             };
@@ -15212,6 +15540,8 @@ interface operations {
     products_list: {
         parameters: {
             query?: {
+                /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE), used with latitude and longitude. A nationwide carrier that declares per-country service areas only offers its products once the country is known. Case-insensitive; any other value is treated as no country. */
+                country?: string;
                 /** @description Sort order for products. Use '-popularity' for most popular first. */
                 ordering?: "-popularity" | "-position" | "position";
                 /** @description A page number within the paginated result set. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poweredbysous/storefront-sdk",
-  "version": "2.4.0",
+  "version": "3.0.1",
   "description": "Type-safe TypeScript SDK for SOUS Storefront Backend",
   "license": "UNLICENSED",
   "private": false,
@@ -41,6 +41,6 @@
     "openapi-typescript": "^7.6.1",
     "tsup": "^8.3.5",
     "typescript": "^5.8.2",
-    "vitest": "^3.2.4"
+    "vitest": "^5.0.3"
   }
 }