@poweredbysous/storefront-all-sdk 4.0.0 → 4.2.0

package/dist/index.d.cts

@@ -3001,7 +3001,7 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Operation `discovery_collections_retrieve`. */
+        /** @description Return active collection cards with reader-language copy. */
         get: operations["discovery_collections_retrieve"];
         put?: never;
         post?: never;
@@ -3086,6 +3086,52 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/discovery/product-collections/{slug}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Return a collection page in the reader's language.
+         *
+         *     Marketplace query parameters narrow the saved collection and never
+         *     widen it.
+         */
+        get: operations["discovery_product_collections_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/discovery/stores/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description The ``public_id`` of every store on the ExploreSOUS channel.
+         *
+         *     A flat membership set, deliberately not a field on the partner index:
+         *     that read is brand-grouped and does not say how many locations a brand
+         *     has, and this one is a different question. It reveals nothing
+         *     ExploreSOUS's sitemap does not, which publishes a URL for every one.
+         */
+        get: operations["discovery_stores_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/fulfillment/address-check/": {
         parameters: {
             query?: never;
@@ -7617,6 +7663,7 @@ interface components {
             product_type_classified: boolean;
             requires_attestation: boolean;
             deposit_config_enabled: boolean;
+            legacy_product_info_enabled: boolean;
             fields: components["schemas"]["ComplianceSchemaField"][];
         };
         ConfirmEdit: {
@@ -8021,6 +8068,7 @@ interface components {
             price_band: number | null;
             michelin_stars: number | null;
             tags: string[];
+            book_url: string;
         };
         /**
          * @description The whole directory plus its filter vocabulary, in one read.
@@ -8032,6 +8080,10 @@ interface components {
             tags: components["schemas"]["DiscoveryTag"][];
             partners: components["schemas"]["DiscoveryPartner"][];
         };
+        /** @description The stores ExploreSOUS serves, as ``X-Vendor-ID`` values. */
+        DiscoveryStoreMembership: {
+            store_ids: string[];
+        };
         /** @description One filter option, already named in the reader's language. */
         DiscoveryTag: {
             slug: string;
@@ -8535,6 +8587,15 @@ interface components {
             fulfillment_types: {
                 [key: string]: number;
             };
+            offering: {
+                [key: string]: number;
+            };
+            menu_types: {
+                [key: string]: number;
+            };
+            party_sizes: {
+                [key: string]: number;
+            };
         };
         /** @description One product, with its name and description in the reader's language. */
         MarketplaceProduct: {
@@ -8551,6 +8612,11 @@ interface components {
             product_url_path: string;
             fulfillment_types: string[];
             cuisine_tags: string[];
+            offering: string | null;
+            menu_types: string[];
+            party_sizes: number[];
+            /** @description Price divided by party size, in cents; null without a party size. */
+            price_per_person_cents: number | null;
         };
         /** @description One page of marketplace products, shaped like the catalogue pagination. */
         MarketplaceSearch: {
@@ -10065,6 +10131,24 @@ interface components {
             pre_order_lead_time?: number | null;
             readonly variant_overrides: components["schemas"]["VariantPriceOverride"][];
         };
+        /**
+         * @description A product collection: its copy, then one page of its products.
+         *
+         *     Pinned products come first in staff's order; the saved filter's matches
+         *     follow in the reader's sort. ``count`` covers both.
+         */
+        ProductCollection: {
+            count: number;
+            total_pages: number;
+            page: number;
+            next: string | null;
+            previous: string | null;
+            results: components["schemas"]["MarketplaceProduct"][];
+            facets: components["schemas"]["MarketplaceFacets"];
+            slug: string;
+            name: string;
+            description: string;
+        };
         /** @description Resolve tags from ProductTranslation, falling back to Product.tags. */
         ProductDetail: {
             readonly id: number;
@@ -18510,7 +18594,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;
@@ -25600,11 +25684,22 @@ interface operations {
             query?: {
                 brand_slug?: string;
                 cuisine_tags?: string[];
+                /** @description Only products servable on this store-local date (YYYY-MM-DD), within the next 60 days. Advisory: add-to-cart is the authority. */
+                date?: string;
                 fulfillment_types?: ("delivery" | "pickup" | "dinein")[];
+                /** @description Menu type slugs, for example `vegan` or `meat-fish`. */
+                menu_types?: string[];
+                /** @description Offering slugs, for example `menubox` or `shop`. */
+                offering?: string[];
                 page?: number;
                 page_size?: number;
+                party_sizes?: number[];
                 price_max?: number;
                 price_min?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_max?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_min?: number;
                 q?: string;
                 /**
                  * @description * `relevance` - relevance
@@ -25731,6 +25826,155 @@ interface operations {
             };
         };
     };
+    discovery_product_collections_retrieve: {
+        parameters: {
+            query?: {
+                brand_slug?: string;
+                cuisine_tags?: string[];
+                /** @description Only products servable on this store-local date (YYYY-MM-DD), within the next 60 days. Advisory: add-to-cart is the authority. */
+                date?: string;
+                fulfillment_types?: ("delivery" | "pickup" | "dinein")[];
+                /** @description Menu type slugs, for example `vegan` or `meat-fish`. */
+                menu_types?: string[];
+                /** @description Offering slugs, for example `menubox` or `shop`. */
+                offering?: string[];
+                page?: number;
+                page_size?: number;
+                party_sizes?: number[];
+                price_max?: number;
+                price_min?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_max?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_min?: number;
+                q?: string;
+                /**
+                 * @description * `relevance` - relevance
+                 *     * `price_asc` - price_asc
+                 *     * `price_desc` - price_desc
+                 */
+                sort?: "relevance" | "price_asc" | "price_desc";
+                /** @description Narrow to these stores, typically the `store_public_ids` the deliverability read returned. */
+                store_public_ids?: string[];
+            };
+            header?: never;
+            path: {
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductCollection"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            /** @description Possible error codes: `MARKETPLACE_SEARCH_UNAVAILABLE`. Retryable: yes. */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
+    discovery_stores_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiscoveryStoreMembership"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     fulfillment_address_check_create: {
         parameters: {
             query?: never;
@@ -36602,6 +36846,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

@@ -3001,7 +3001,7 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Operation `discovery_collections_retrieve`. */
+        /** @description Return active collection cards with reader-language copy. */
         get: operations["discovery_collections_retrieve"];
         put?: never;
         post?: never;
@@ -3086,6 +3086,52 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/discovery/product-collections/{slug}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Return a collection page in the reader's language.
+         *
+         *     Marketplace query parameters narrow the saved collection and never
+         *     widen it.
+         */
+        get: operations["discovery_product_collections_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/discovery/stores/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description The ``public_id`` of every store on the ExploreSOUS channel.
+         *
+         *     A flat membership set, deliberately not a field on the partner index:
+         *     that read is brand-grouped and does not say how many locations a brand
+         *     has, and this one is a different question. It reveals nothing
+         *     ExploreSOUS's sitemap does not, which publishes a URL for every one.
+         */
+        get: operations["discovery_stores_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/fulfillment/address-check/": {
         parameters: {
             query?: never;
@@ -7617,6 +7663,7 @@ interface components {
             product_type_classified: boolean;
             requires_attestation: boolean;
             deposit_config_enabled: boolean;
+            legacy_product_info_enabled: boolean;
             fields: components["schemas"]["ComplianceSchemaField"][];
         };
         ConfirmEdit: {
@@ -8021,6 +8068,7 @@ interface components {
             price_band: number | null;
             michelin_stars: number | null;
             tags: string[];
+            book_url: string;
         };
         /**
          * @description The whole directory plus its filter vocabulary, in one read.
@@ -8032,6 +8080,10 @@ interface components {
             tags: components["schemas"]["DiscoveryTag"][];
             partners: components["schemas"]["DiscoveryPartner"][];
         };
+        /** @description The stores ExploreSOUS serves, as ``X-Vendor-ID`` values. */
+        DiscoveryStoreMembership: {
+            store_ids: string[];
+        };
         /** @description One filter option, already named in the reader's language. */
         DiscoveryTag: {
             slug: string;
@@ -8535,6 +8587,15 @@ interface components {
             fulfillment_types: {
                 [key: string]: number;
             };
+            offering: {
+                [key: string]: number;
+            };
+            menu_types: {
+                [key: string]: number;
+            };
+            party_sizes: {
+                [key: string]: number;
+            };
         };
         /** @description One product, with its name and description in the reader's language. */
         MarketplaceProduct: {
@@ -8551,6 +8612,11 @@ interface components {
             product_url_path: string;
             fulfillment_types: string[];
             cuisine_tags: string[];
+            offering: string | null;
+            menu_types: string[];
+            party_sizes: number[];
+            /** @description Price divided by party size, in cents; null without a party size. */
+            price_per_person_cents: number | null;
         };
         /** @description One page of marketplace products, shaped like the catalogue pagination. */
         MarketplaceSearch: {
@@ -10065,6 +10131,24 @@ interface components {
             pre_order_lead_time?: number | null;
             readonly variant_overrides: components["schemas"]["VariantPriceOverride"][];
         };
+        /**
+         * @description A product collection: its copy, then one page of its products.
+         *
+         *     Pinned products come first in staff's order; the saved filter's matches
+         *     follow in the reader's sort. ``count`` covers both.
+         */
+        ProductCollection: {
+            count: number;
+            total_pages: number;
+            page: number;
+            next: string | null;
+            previous: string | null;
+            results: components["schemas"]["MarketplaceProduct"][];
+            facets: components["schemas"]["MarketplaceFacets"];
+            slug: string;
+            name: string;
+            description: string;
+        };
         /** @description Resolve tags from ProductTranslation, falling back to Product.tags. */
         ProductDetail: {
             readonly id: number;
@@ -18510,7 +18594,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;
@@ -25600,11 +25684,22 @@ interface operations {
             query?: {
                 brand_slug?: string;
                 cuisine_tags?: string[];
+                /** @description Only products servable on this store-local date (YYYY-MM-DD), within the next 60 days. Advisory: add-to-cart is the authority. */
+                date?: string;
                 fulfillment_types?: ("delivery" | "pickup" | "dinein")[];
+                /** @description Menu type slugs, for example `vegan` or `meat-fish`. */
+                menu_types?: string[];
+                /** @description Offering slugs, for example `menubox` or `shop`. */
+                offering?: string[];
                 page?: number;
                 page_size?: number;
+                party_sizes?: number[];
                 price_max?: number;
                 price_min?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_max?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_min?: number;
                 q?: string;
                 /**
                  * @description * `relevance` - relevance
@@ -25731,6 +25826,155 @@ interface operations {
             };
         };
     };
+    discovery_product_collections_retrieve: {
+        parameters: {
+            query?: {
+                brand_slug?: string;
+                cuisine_tags?: string[];
+                /** @description Only products servable on this store-local date (YYYY-MM-DD), within the next 60 days. Advisory: add-to-cart is the authority. */
+                date?: string;
+                fulfillment_types?: ("delivery" | "pickup" | "dinein")[];
+                /** @description Menu type slugs, for example `vegan` or `meat-fish`. */
+                menu_types?: string[];
+                /** @description Offering slugs, for example `menubox` or `shop`. */
+                offering?: string[];
+                page?: number;
+                page_size?: number;
+                party_sizes?: number[];
+                price_max?: number;
+                price_min?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_max?: number;
+                /** @description Cents, inclusive. Excludes products with no party size. */
+                price_per_person_min?: number;
+                q?: string;
+                /**
+                 * @description * `relevance` - relevance
+                 *     * `price_asc` - price_asc
+                 *     * `price_desc` - price_desc
+                 */
+                sort?: "relevance" | "price_asc" | "price_desc";
+                /** @description Narrow to these stores, typically the `store_public_ids` the deliverability read returned. */
+                store_public_ids?: string[];
+            };
+            header?: never;
+            path: {
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductCollection"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            /** @description Possible error codes: `MARKETPLACE_SEARCH_UNAVAILABLE`. Retryable: yes. */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
+    discovery_stores_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiscoveryStoreMembership"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     fulfillment_address_check_create: {
         parameters: {
             query?: never;
@@ -36602,6 +36846,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-all-sdk",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "Type-safe TypeScript SDK for all SOUS Storefront Backend endpoints",
   "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"
   }
 }