@poweredbysous/storefront-sdk 3.3.3 → 3.4.0

package/dist/index.d.cts

@@ -2125,6 +2125,28 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/products/{id}/orderable-dates/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description The dates this product can be ordered for, within the location's
+         *     pre-order horizon, as the cart's ``fulfilment-dates`` lists them for
+         *     a basket holding only this product's line, so the storefront can tell
+         *     a customer when a product it hides for their date is available.
+         */
+        get: operations["products_orderable_dates_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/products/{id}/suggestions/": {
         parameters: {
             query?: never;
@@ -2498,6 +2520,11 @@ interface components {
             fulfillment_type?: string;
             /** Format: date */
             fulfillment_date?: string;
+            /**
+             * Format: date
+             * @description The customer's chosen handover date. The product is refused when its own dates (weekly days, included and excluded dates, order-until) do not accept it; the line is not dated by it.
+             */
+            handover_date?: string;
             /** @default  */
             fulfillment_time_slot: string;
             options?: components["schemas"]["OptionInput"][];
@@ -2722,6 +2749,7 @@ interface components {
             readonly promotion: {
                 [key: string]: unknown;
             } | null;
+            readonly pending_auto_discount: components["schemas"]["CartPendingAutoDiscount"] | null;
             readonly shipping_estimate: components["schemas"]["ShippingEstimate"] | null;
             /**
              * Format: decimal
@@ -2806,6 +2834,7 @@ interface components {
                 [key: string]: unknown;
             } | null;
             readonly note: string;
+            readonly order_dates: components["schemas"]["CartLineOrderDates"] | null;
         };
         CartLineItemOption: {
             option_id: number;
@@ -2861,6 +2890,54 @@ interface components {
             /** @description 'product' or 'modifier' */
             source: string;
         };
+        /**
+         * @description The product's own dates. An excluded date closes it, an included date
+         *     opens it on a day ``weekly_days`` does not cover, and ``order_until`` closes
+         *     it once passed. Checkout refuses a handover date outside them with
+         *     ``PRODUCT_NOT_ORDERABLE_FOR_DATE``.
+         */
+        CartLineOrderDates: {
+            /** @description Lower-case weekday names, or null to follow the store's schedule. */
+            weekly_days: string[] | null;
+            included_dates: string[];
+            excluded_dates: string[];
+            /** Format: date */
+            order_until: string | null;
+        };
+        /**
+         * @description A codeless discount the cart holds products for but does not get yet.
+         *
+         *     Documentation only: the payload is built by
+         *     ``CartSerializer.get_pending_auto_discount``. Null whenever a discount is
+         *     on the cart, a typed code included.
+         */
+        CartPendingAutoDiscount: {
+            /** Format: uuid */
+            discount_id: string;
+            name: string;
+            /**
+             * @description min_order_not_met: the cart subtotal is below min_order_amount; amount_needed says by how much. fulfillment_type_not_allowed: no line the discount covers uses one of allowed_fulfillment_types. Reported before the minimum, since adding to the basket cannot lift it.
+             *
+             *     * `min_order_not_met` - min_order_not_met
+             *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+             */
+            reason: components["schemas"]["CartPendingAutoDiscountReasonEnum"];
+            /** Format: decimal */
+            min_order_amount: string | null;
+            /**
+             * Format: decimal
+             * @description What the subtotal still needs. Null unless min_order_not_met.
+             */
+            amount_needed: string | null;
+            allowed_fulfillment_types: string[];
+            currency: string;
+        };
+        /**
+         * @description * `min_order_not_met` - min_order_not_met
+         *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+         * @enum {string}
+         */
+        CartPendingAutoDiscountReasonEnum: "min_order_not_met" | "fulfillment_type_not_allowed";
         Category: {
             readonly id: number;
             slug: string;
@@ -4202,6 +4279,19 @@ interface components {
             /** Format: date-time */
             readonly updated_at: string;
         };
+        /**
+         * @description The dates one product can be ordered for, within the location's
+         *     pre-order horizon (``ProductViewSet.orderable_dates``).
+         */
+        ProductFulfilmentDates: {
+            dates: string[];
+            reason: (components["schemas"]["ProductFulfilmentDatesReasonEnum"] | components["schemas"]["NullEnum"]) | null;
+        };
+        /**
+         * @description * `no_dates` - no_dates
+         * @enum {string}
+         */
+        ProductFulfilmentDatesReasonEnum: "no_dates";
         ProductImage: {
             readonly id: number;
             /** Format: uri */
@@ -16002,6 +16092,8 @@ interface operations {
             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 The pickup or delivery date the customer has chosen (YYYY-MM-DD). Lists only the products that can be ordered today for that date by their own dates: weekly days, included and excluded dates, and order-until. Whether the store is open that day is the time-slots endpoint's answer, not this filter's. An unreadable value is ignored. */
+                handover_date?: 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. */
@@ -16238,6 +16330,91 @@ interface operations {
             };
         };
     };
+    products_orderable_dates_retrieve: {
+        parameters: {
+            query: {
+                /** @description For type=delivery: the customer's delivery types in order of preference, comma-separated (local_delivery, nationwide_delivery). The product's schedule follows the first of them it offers, the type its cart line would get; without one it follows the delivery types the product offers. */
+                fulfillment_types?: string;
+                /** @description Pickup location id, as the pickup time-slots endpoint takes it. Defaults to the store's active pickup location. */
+                location?: number;
+                /** @description Fulfilment type the dates are for. */
+                type: "delivery" | "pickup";
+                /** @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;
+            };
+            header?: never;
+            path: {
+                /** @description A unique integer value identifying this product. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductFulfilmentDates"];
+                };
+            };
+            /** @description Possible error codes: `VALIDATION_ERROR`. Retryable: no. 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: `NOT_FOUND`, `LOCATION_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LOCATION_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"];
+                };
+            };
+        };
+    };
     products_suggestions_list: {
         parameters: {
             query?: {

package/dist/index.d.ts

@@ -2125,6 +2125,28 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/products/{id}/orderable-dates/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description The dates this product can be ordered for, within the location's
+         *     pre-order horizon, as the cart's ``fulfilment-dates`` lists them for
+         *     a basket holding only this product's line, so the storefront can tell
+         *     a customer when a product it hides for their date is available.
+         */
+        get: operations["products_orderable_dates_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/products/{id}/suggestions/": {
         parameters: {
             query?: never;
@@ -2498,6 +2520,11 @@ interface components {
             fulfillment_type?: string;
             /** Format: date */
             fulfillment_date?: string;
+            /**
+             * Format: date
+             * @description The customer's chosen handover date. The product is refused when its own dates (weekly days, included and excluded dates, order-until) do not accept it; the line is not dated by it.
+             */
+            handover_date?: string;
             /** @default  */
             fulfillment_time_slot: string;
             options?: components["schemas"]["OptionInput"][];
@@ -2722,6 +2749,7 @@ interface components {
             readonly promotion: {
                 [key: string]: unknown;
             } | null;
+            readonly pending_auto_discount: components["schemas"]["CartPendingAutoDiscount"] | null;
             readonly shipping_estimate: components["schemas"]["ShippingEstimate"] | null;
             /**
              * Format: decimal
@@ -2806,6 +2834,7 @@ interface components {
                 [key: string]: unknown;
             } | null;
             readonly note: string;
+            readonly order_dates: components["schemas"]["CartLineOrderDates"] | null;
         };
         CartLineItemOption: {
             option_id: number;
@@ -2861,6 +2890,54 @@ interface components {
             /** @description 'product' or 'modifier' */
             source: string;
         };
+        /**
+         * @description The product's own dates. An excluded date closes it, an included date
+         *     opens it on a day ``weekly_days`` does not cover, and ``order_until`` closes
+         *     it once passed. Checkout refuses a handover date outside them with
+         *     ``PRODUCT_NOT_ORDERABLE_FOR_DATE``.
+         */
+        CartLineOrderDates: {
+            /** @description Lower-case weekday names, or null to follow the store's schedule. */
+            weekly_days: string[] | null;
+            included_dates: string[];
+            excluded_dates: string[];
+            /** Format: date */
+            order_until: string | null;
+        };
+        /**
+         * @description A codeless discount the cart holds products for but does not get yet.
+         *
+         *     Documentation only: the payload is built by
+         *     ``CartSerializer.get_pending_auto_discount``. Null whenever a discount is
+         *     on the cart, a typed code included.
+         */
+        CartPendingAutoDiscount: {
+            /** Format: uuid */
+            discount_id: string;
+            name: string;
+            /**
+             * @description min_order_not_met: the cart subtotal is below min_order_amount; amount_needed says by how much. fulfillment_type_not_allowed: no line the discount covers uses one of allowed_fulfillment_types. Reported before the minimum, since adding to the basket cannot lift it.
+             *
+             *     * `min_order_not_met` - min_order_not_met
+             *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+             */
+            reason: components["schemas"]["CartPendingAutoDiscountReasonEnum"];
+            /** Format: decimal */
+            min_order_amount: string | null;
+            /**
+             * Format: decimal
+             * @description What the subtotal still needs. Null unless min_order_not_met.
+             */
+            amount_needed: string | null;
+            allowed_fulfillment_types: string[];
+            currency: string;
+        };
+        /**
+         * @description * `min_order_not_met` - min_order_not_met
+         *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+         * @enum {string}
+         */
+        CartPendingAutoDiscountReasonEnum: "min_order_not_met" | "fulfillment_type_not_allowed";
         Category: {
             readonly id: number;
             slug: string;
@@ -4202,6 +4279,19 @@ interface components {
             /** Format: date-time */
             readonly updated_at: string;
         };
+        /**
+         * @description The dates one product can be ordered for, within the location's
+         *     pre-order horizon (``ProductViewSet.orderable_dates``).
+         */
+        ProductFulfilmentDates: {
+            dates: string[];
+            reason: (components["schemas"]["ProductFulfilmentDatesReasonEnum"] | components["schemas"]["NullEnum"]) | null;
+        };
+        /**
+         * @description * `no_dates` - no_dates
+         * @enum {string}
+         */
+        ProductFulfilmentDatesReasonEnum: "no_dates";
         ProductImage: {
             readonly id: number;
             /** Format: uri */
@@ -16002,6 +16092,8 @@ interface operations {
             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 The pickup or delivery date the customer has chosen (YYYY-MM-DD). Lists only the products that can be ordered today for that date by their own dates: weekly days, included and excluded dates, and order-until. Whether the store is open that day is the time-slots endpoint's answer, not this filter's. An unreadable value is ignored. */
+                handover_date?: 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. */
@@ -16238,6 +16330,91 @@ interface operations {
             };
         };
     };
+    products_orderable_dates_retrieve: {
+        parameters: {
+            query: {
+                /** @description For type=delivery: the customer's delivery types in order of preference, comma-separated (local_delivery, nationwide_delivery). The product's schedule follows the first of them it offers, the type its cart line would get; without one it follows the delivery types the product offers. */
+                fulfillment_types?: string;
+                /** @description Pickup location id, as the pickup time-slots endpoint takes it. Defaults to the store's active pickup location. */
+                location?: number;
+                /** @description Fulfilment type the dates are for. */
+                type: "delivery" | "pickup";
+                /** @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;
+            };
+            header?: never;
+            path: {
+                /** @description A unique integer value identifying this product. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductFulfilmentDates"];
+                };
+            };
+            /** @description Possible error codes: `VALIDATION_ERROR`. Retryable: no. 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: `NOT_FOUND`, `LOCATION_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LOCATION_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"];
+                };
+            };
+        };
+    };
     products_suggestions_list: {
         parameters: {
             query?: {

package/package.json

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