@poweredbysous/storefront-all-sdk 4.9.0 → 4.11.0

package/dist/index.d.cts

@@ -3154,6 +3154,13 @@ interface paths {
          *
          *     Meilisearch unreachable answers 502 rather than an empty page, so
          *     "nothing matches" and "search is down" never look the same.
+         *
+         *     A 200 is cacheable by shared caches for a minute (``CACHE_CONTROL_OK``).
+         *     That is safe because the body is a function of the URL and the language
+         *     only: there are no authentication classes, no cookie is read or set, and
+         *     the store ids it may carry are public identifiers. Search staleness is
+         *     acceptable by contract (add-to-cart re-checks fulfilment). Anything that
+         *     is not a 200 is ``no-store`` so an outage is never replayed from a cache.
          */
         get: operations["discovery_marketplace_retrieve"];
         put?: never;
@@ -3225,6 +3232,54 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/discovery/shopify-products/{handle}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description The ExploreSOUS dish an old Shopify product URL now answers with.
+         *
+         *     The old storefront served each product at ``/products/<handle>``. The
+         *     product import remembers which SOUS product each handle became, so
+         *     ExploreSOUS can send that URL, with its search ranking, to the same dish
+         *     in one permanent redirect. A 404 is the answer for every handle with no
+         *     live dish, and the caller falls back to the partner or a search.
+         */
+        get: operations["discovery_shopify_products_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/discovery/store-routes/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Each ExploreSOUS store's brand and location slug, for its page URL.
+         *
+         *     ExploreSOUS serves a store at ``/brands/{brand_slug}/{slug}`` and resolves
+         *     both ways with this: a segment pair to the store, and an old
+         *     ``/stores/{public_id}`` link to its new address.
+         */
+        get: operations["discovery_store_routes_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/discovery/stores/": {
         parameters: {
             query?: never;
@@ -6964,6 +7019,8 @@ interface components {
             available_shipping_providers: components["schemas"]["ShippingProviderOption"][];
             pickup_locations: components["schemas"]["AddressCheckPickupLocation"][];
             delivery_unavailable: boolean;
+            /** @description ISO country code of the address when the store's nationwide carriers all leave that country out, so the client can say the store does not deliver there. Null otherwise. */
+            unserved_country: string | null;
             near_delivery_zone: boolean;
         };
         AddressLookupResponse: {
@@ -7659,12 +7716,12 @@ interface components {
                 [key: string]: unknown;
             }[];
             /**
-             * @description How many products this category shows, descendants included.
+             * @description How many products this category's listing shows, descendants included.
              *
-             *     The listing precomputes every category's count in one pass
-             *     (``views._build_product_counts``) and passes it in context; the
-             *     fallback below is the single-object path (retrieve), which counts its
-             *     own subtree directly.
+             *     Precomputed for every category in one pass
+             *     (``views._build_product_counts``) and passed in context, on both list
+             *     and retrieve: counting here instead would count products the listing
+             *     leaves out.
              */
             readonly product_count: number;
         };
@@ -8345,6 +8402,7 @@ interface components {
             seo_title: string;
             images: string[];
             book_url: string;
+            michelin_stars: number | null;
         };
         DiscoveryCollection: {
             slug: string;
@@ -8385,6 +8443,15 @@ interface components {
         DiscoveryStoreMembership: {
             store_ids: string[];
         };
+        DiscoveryStoreRoute: {
+            public_id: string;
+            brand_slug: string | null;
+            slug: string | null;
+        };
+        /** @description Each ExploreSOUS store's ``/brands/{brand_slug}/{slug}`` address. */
+        DiscoveryStoreRoutes: {
+            stores: components["schemas"]["DiscoveryStoreRoute"][];
+        };
         /** @description One filter option, already named in the reader's language. */
         DiscoveryTag: {
             slug: string;
@@ -11403,6 +11470,8 @@ interface components {
             remaining_for_free_shipping: string | null;
             /** @description Products no carrier delivers to this address. The total does not cover them and checkout cannot route them, so the customer must remove them or change the address. Empty when every item ships. */
             unshippable_product_ids: number[];
+            /** @description ISO country code of the delivery address when every carrier of the unshippable products leaves that country out, so the client can say the store does not deliver there. Null otherwise. */
+            unserved_country: string | null;
         };
         /**
          * @description One carrier's share of the basket. Documentation only — never used to
@@ -11429,6 +11498,18 @@ interface components {
             /** Format: decimal */
             free_delivery_threshold: string | null;
         };
+        /**
+         * @description Where an old Shopify product URL's dish lives on ExploreSOUS.
+         *
+         *     ``/partners/{brand_slug}/{slug}/p/{product_id}`` on the ExploreSOUS site.
+         */
+        ShopifyProductRoute: {
+            brand_slug: string;
+            slug: string;
+            product_id: number;
+            /** @description The dish's title in the request's language (``?lang=`` or ``Accept-Language``), with the product endpoint's fallback. */
+            title: string;
+        };
         /**
          * @description * `manual` - Manual
          *     * `auto` - Auto-translated
@@ -26995,6 +27076,118 @@ interface operations {
             };
         };
     };
+    discovery_shopify_products_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                handle: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ShopifyProductRoute"];
+                };
+            };
+            /** @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 `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"];
+                };
+            };
+        };
+    };
+    discovery_store_routes_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiscoveryStoreRoutes"];
+                };
+            };
+            /** @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 `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"];
+                };
+            };
+        };
+    };
     discovery_stores_retrieve: {
         parameters: {
             query?: never;

package/dist/index.d.ts

@@ -3154,6 +3154,13 @@ interface paths {
          *
          *     Meilisearch unreachable answers 502 rather than an empty page, so
          *     "nothing matches" and "search is down" never look the same.
+         *
+         *     A 200 is cacheable by shared caches for a minute (``CACHE_CONTROL_OK``).
+         *     That is safe because the body is a function of the URL and the language
+         *     only: there are no authentication classes, no cookie is read or set, and
+         *     the store ids it may carry are public identifiers. Search staleness is
+         *     acceptable by contract (add-to-cart re-checks fulfilment). Anything that
+         *     is not a 200 is ``no-store`` so an outage is never replayed from a cache.
          */
         get: operations["discovery_marketplace_retrieve"];
         put?: never;
@@ -3225,6 +3232,54 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/discovery/shopify-products/{handle}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description The ExploreSOUS dish an old Shopify product URL now answers with.
+         *
+         *     The old storefront served each product at ``/products/<handle>``. The
+         *     product import remembers which SOUS product each handle became, so
+         *     ExploreSOUS can send that URL, with its search ranking, to the same dish
+         *     in one permanent redirect. A 404 is the answer for every handle with no
+         *     live dish, and the caller falls back to the partner or a search.
+         */
+        get: operations["discovery_shopify_products_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/discovery/store-routes/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Each ExploreSOUS store's brand and location slug, for its page URL.
+         *
+         *     ExploreSOUS serves a store at ``/brands/{brand_slug}/{slug}`` and resolves
+         *     both ways with this: a segment pair to the store, and an old
+         *     ``/stores/{public_id}`` link to its new address.
+         */
+        get: operations["discovery_store_routes_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/discovery/stores/": {
         parameters: {
             query?: never;
@@ -6964,6 +7019,8 @@ interface components {
             available_shipping_providers: components["schemas"]["ShippingProviderOption"][];
             pickup_locations: components["schemas"]["AddressCheckPickupLocation"][];
             delivery_unavailable: boolean;
+            /** @description ISO country code of the address when the store's nationwide carriers all leave that country out, so the client can say the store does not deliver there. Null otherwise. */
+            unserved_country: string | null;
             near_delivery_zone: boolean;
         };
         AddressLookupResponse: {
@@ -7659,12 +7716,12 @@ interface components {
                 [key: string]: unknown;
             }[];
             /**
-             * @description How many products this category shows, descendants included.
+             * @description How many products this category's listing shows, descendants included.
              *
-             *     The listing precomputes every category's count in one pass
-             *     (``views._build_product_counts``) and passes it in context; the
-             *     fallback below is the single-object path (retrieve), which counts its
-             *     own subtree directly.
+             *     Precomputed for every category in one pass
+             *     (``views._build_product_counts``) and passed in context, on both list
+             *     and retrieve: counting here instead would count products the listing
+             *     leaves out.
              */
             readonly product_count: number;
         };
@@ -8345,6 +8402,7 @@ interface components {
             seo_title: string;
             images: string[];
             book_url: string;
+            michelin_stars: number | null;
         };
         DiscoveryCollection: {
             slug: string;
@@ -8385,6 +8443,15 @@ interface components {
         DiscoveryStoreMembership: {
             store_ids: string[];
         };
+        DiscoveryStoreRoute: {
+            public_id: string;
+            brand_slug: string | null;
+            slug: string | null;
+        };
+        /** @description Each ExploreSOUS store's ``/brands/{brand_slug}/{slug}`` address. */
+        DiscoveryStoreRoutes: {
+            stores: components["schemas"]["DiscoveryStoreRoute"][];
+        };
         /** @description One filter option, already named in the reader's language. */
         DiscoveryTag: {
             slug: string;
@@ -11403,6 +11470,8 @@ interface components {
             remaining_for_free_shipping: string | null;
             /** @description Products no carrier delivers to this address. The total does not cover them and checkout cannot route them, so the customer must remove them or change the address. Empty when every item ships. */
             unshippable_product_ids: number[];
+            /** @description ISO country code of the delivery address when every carrier of the unshippable products leaves that country out, so the client can say the store does not deliver there. Null otherwise. */
+            unserved_country: string | null;
         };
         /**
          * @description One carrier's share of the basket. Documentation only — never used to
@@ -11429,6 +11498,18 @@ interface components {
             /** Format: decimal */
             free_delivery_threshold: string | null;
         };
+        /**
+         * @description Where an old Shopify product URL's dish lives on ExploreSOUS.
+         *
+         *     ``/partners/{brand_slug}/{slug}/p/{product_id}`` on the ExploreSOUS site.
+         */
+        ShopifyProductRoute: {
+            brand_slug: string;
+            slug: string;
+            product_id: number;
+            /** @description The dish's title in the request's language (``?lang=`` or ``Accept-Language``), with the product endpoint's fallback. */
+            title: string;
+        };
         /**
          * @description * `manual` - Manual
          *     * `auto` - Auto-translated
@@ -26995,6 +27076,118 @@ interface operations {
             };
         };
     };
+    discovery_shopify_products_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                handle: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ShopifyProductRoute"];
+                };
+            };
+            /** @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 `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"];
+                };
+            };
+        };
+    };
+    discovery_store_routes_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiscoveryStoreRoutes"];
+                };
+            };
+            /** @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 `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"];
+                };
+            };
+        };
+    };
     discovery_stores_retrieve: {
         parameters: {
             query?: never;

package/package.json

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