@poweredbysous/storefront-sdk 2.2.0 → 2.4.0

package/dist/index.d.cts

@@ -2541,6 +2541,7 @@ interface components {
             /** Format: double */
             longitude?: number | null;
             open_status?: components["schemas"]["OpenStatus"] | null;
+            phone?: string;
         };
         /** @description Pickup address of a brand location (from its primary pickup location). */
         BrandLocationAddress: {
@@ -2764,24 +2765,10 @@ interface components {
             /**
              * @description How many products this category shows, descendants included.
              *
-             *     Counted through the compliance gate (D15), because the count and the
-             *     listing are one read model: ``/categories/`` reported 5 while
-             *     ``/categories/<id>/products/`` returned 0, which discloses how many
-             *     hidden products sit in each category and, by diffing, which categories
-             *     are affected. Search's ``total`` had already closed the same gap.
-             *
-             *     No ``annotated_product_count`` shortcut any more: a ``Count()`` in the
-             *     view cannot know the verdict, so such an annotation would be an ungated
-             *     number that silently won over this one.
-             *
              *     The listing precomputes every category's count in one pass
-             *     (``views._build_gated_counts``) and passes it in context, because doing
-             *     it per category asked the gate — a fixed handful of queries however
-             *     many ids it is given — once per category in the tree. ``MAX_DEPTH = 4``
-             *     bounds the depth but not the breadth, and breadth is what drives it.
-             *
-             *     The fallback below is the single-object path (retrieve), where there is
-             *     no tree to amortise over and one gate call is the whole cost.
+             *     (``views._build_product_counts``) and passes it in context; the
+             *     fallback below is the single-object path (retrieve), which counts its
+             *     own subtree directly.
              */
             readonly product_count: number;
         };
@@ -2963,6 +2950,14 @@ interface components {
             language_preference?: (components["schemas"]["LanguagePreferenceEnum"] | components["schemas"]["NullEnum"]) | null;
             marketing_opt_in?: boolean | null;
         };
+        /**
+         * @description What merchant-portal-backend's publish needs to know about a store
+         *     whose delivery methods the portal's toggles own.
+         */
+        DeliveryMethodToggles: {
+            wizard_choice_applies: components["schemas"]["WizardChoiceApplies"];
+            publish_readiness: string[];
+        };
         /**
          * @description * `merchant` - Merchant
          *     * `customer` - Customer
@@ -2984,6 +2979,7 @@ interface components {
             unit_price: string;
             line_total: string;
             tax_amount: string;
+            deposit_amount?: string;
         };
         /**
          * @description The snapshot computed by ``eligibility_for_order``.
@@ -3303,6 +3299,11 @@ interface components {
              * @description Aggregated non-discountable surcharges (VAT-inclusive)
              */
             surcharge_total?: string;
+            /**
+             * Format: decimal
+             * @description Deposits (subset of surcharge_total), shown separately.
+             */
+            deposit_total?: string;
             cancellation_reason?: string;
             /** Format: decimal */
             total: string;
@@ -3446,6 +3447,11 @@ interface components {
             tax_amount: string;
             /** Format: decimal */
             line_total: string;
+            /**
+             * Format: decimal
+             * @description Deposit charged on this line, snapshotted at order time so removing the line refunds it.
+             */
+            deposit_amount?: string;
             fulfillment_type: string;
             /** Format: date */
             fulfillment_date?: string | null;
@@ -3793,6 +3799,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         /**
@@ -3909,6 +3916,8 @@ interface components {
             /** Format: decimal */
             price: string;
             /** Format: decimal */
+            readonly deposit_amount: string | null;
+            /** Format: decimal */
             compare_at_price?: string | null;
             currency?: string;
             /** Format: decimal */
@@ -4489,6 +4498,7 @@ interface components {
             readonly updated_at: string;
             readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
             readonly uber_direct_supported_countries: string[];
+            readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
         };
         /**
          * @description * `draft` - Draft
@@ -4571,6 +4581,8 @@ interface components {
             price: string;
             currency: string;
             image_url: string;
+            /** Format: decimal */
+            deposit_amount?: string | null;
             reason: string;
         };
         Surcharge: {
@@ -4586,7 +4598,7 @@ interface components {
             amount: string;
             /**
              * Format: decimal
-             * @description VAT rate for this surcharge, independent of the product's rate. German Pfand is charged at the standard rate (19%) while the food line is often reduced (7%), so the surcharge cannot inherit the product's rate. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
+             * @description VAT rate for this surcharge. Not used for a deposit attached to a product or modifier: German Pfand is an ancillary charge on the container and is taxed at the rate of the item it is attached to (UStAE A 10.1 Abs. 8). A deposit's rate here only applies when it is charged per order as the reusable-packaging deposit. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
              */
             vat_rate: string;
             /** @description Category: sup, deposit, bag_fee, packaging, etc. */
@@ -4733,6 +4745,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         /** @description POST /api/v1/withdrawals/confirm input. */
@@ -4752,6 +4765,11 @@ interface components {
             completed_at: string | null;
             eligibility_snapshot: components["schemas"]["EligibilitySnapshot"];
         };
+        /** @description Per delivery method: whether the wizard's toggle still decides it. */
+        WizardChoiceApplies: {
+            uber_direct: boolean;
+            lieferando: boolean;
+        };
         /** @description Customer-facing Zeemijlen balance + redemption economics. */
         ZeemijlenSummary: {
             points_balance: number;
@@ -8144,7 +8162,7 @@ interface operations {
                     };
                 };
             };
-            /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `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. */
+            /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`. 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. */
             400: {
                 headers: {
                     [name: string]: unknown;

package/dist/index.d.ts

@@ -2541,6 +2541,7 @@ interface components {
             /** Format: double */
             longitude?: number | null;
             open_status?: components["schemas"]["OpenStatus"] | null;
+            phone?: string;
         };
         /** @description Pickup address of a brand location (from its primary pickup location). */
         BrandLocationAddress: {
@@ -2764,24 +2765,10 @@ interface components {
             /**
              * @description How many products this category shows, descendants included.
              *
-             *     Counted through the compliance gate (D15), because the count and the
-             *     listing are one read model: ``/categories/`` reported 5 while
-             *     ``/categories/<id>/products/`` returned 0, which discloses how many
-             *     hidden products sit in each category and, by diffing, which categories
-             *     are affected. Search's ``total`` had already closed the same gap.
-             *
-             *     No ``annotated_product_count`` shortcut any more: a ``Count()`` in the
-             *     view cannot know the verdict, so such an annotation would be an ungated
-             *     number that silently won over this one.
-             *
              *     The listing precomputes every category's count in one pass
-             *     (``views._build_gated_counts``) and passes it in context, because doing
-             *     it per category asked the gate — a fixed handful of queries however
-             *     many ids it is given — once per category in the tree. ``MAX_DEPTH = 4``
-             *     bounds the depth but not the breadth, and breadth is what drives it.
-             *
-             *     The fallback below is the single-object path (retrieve), where there is
-             *     no tree to amortise over and one gate call is the whole cost.
+             *     (``views._build_product_counts``) and passes it in context; the
+             *     fallback below is the single-object path (retrieve), which counts its
+             *     own subtree directly.
              */
             readonly product_count: number;
         };
@@ -2963,6 +2950,14 @@ interface components {
             language_preference?: (components["schemas"]["LanguagePreferenceEnum"] | components["schemas"]["NullEnum"]) | null;
             marketing_opt_in?: boolean | null;
         };
+        /**
+         * @description What merchant-portal-backend's publish needs to know about a store
+         *     whose delivery methods the portal's toggles own.
+         */
+        DeliveryMethodToggles: {
+            wizard_choice_applies: components["schemas"]["WizardChoiceApplies"];
+            publish_readiness: string[];
+        };
         /**
          * @description * `merchant` - Merchant
          *     * `customer` - Customer
@@ -2984,6 +2979,7 @@ interface components {
             unit_price: string;
             line_total: string;
             tax_amount: string;
+            deposit_amount?: string;
         };
         /**
          * @description The snapshot computed by ``eligibility_for_order``.
@@ -3303,6 +3299,11 @@ interface components {
              * @description Aggregated non-discountable surcharges (VAT-inclusive)
              */
             surcharge_total?: string;
+            /**
+             * Format: decimal
+             * @description Deposits (subset of surcharge_total), shown separately.
+             */
+            deposit_total?: string;
             cancellation_reason?: string;
             /** Format: decimal */
             total: string;
@@ -3446,6 +3447,11 @@ interface components {
             tax_amount: string;
             /** Format: decimal */
             line_total: string;
+            /**
+             * Format: decimal
+             * @description Deposit charged on this line, snapshotted at order time so removing the line refunds it.
+             */
+            deposit_amount?: string;
             fulfillment_type: string;
             /** Format: date */
             fulfillment_date?: string | null;
@@ -3793,6 +3799,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         /**
@@ -3909,6 +3916,8 @@ interface components {
             /** Format: decimal */
             price: string;
             /** Format: decimal */
+            readonly deposit_amount: string | null;
+            /** Format: decimal */
             compare_at_price?: string | null;
             currency?: string;
             /** Format: decimal */
@@ -4489,6 +4498,7 @@ interface components {
             readonly updated_at: string;
             readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
             readonly uber_direct_supported_countries: string[];
+            readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
         };
         /**
          * @description * `draft` - Draft
@@ -4571,6 +4581,8 @@ interface components {
             price: string;
             currency: string;
             image_url: string;
+            /** Format: decimal */
+            deposit_amount?: string | null;
             reason: string;
         };
         Surcharge: {
@@ -4586,7 +4598,7 @@ interface components {
             amount: string;
             /**
              * Format: decimal
-             * @description VAT rate for this surcharge, independent of the product's rate. German Pfand is charged at the standard rate (19%) while the food line is often reduced (7%), so the surcharge cannot inherit the product's rate. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
+             * @description VAT rate for this surcharge. Not used for a deposit attached to a product or modifier: German Pfand is an ancillary charge on the container and is taxed at the rate of the item it is attached to (UStAE A 10.1 Abs. 8). A deposit's rate here only applies when it is charged per order as the reusable-packaging deposit. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
              */
             vat_rate: string;
             /** @description Category: sup, deposit, bag_fee, packaging, etc. */
@@ -4733,6 +4745,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         /** @description POST /api/v1/withdrawals/confirm input. */
@@ -4752,6 +4765,11 @@ interface components {
             completed_at: string | null;
             eligibility_snapshot: components["schemas"]["EligibilitySnapshot"];
         };
+        /** @description Per delivery method: whether the wizard's toggle still decides it. */
+        WizardChoiceApplies: {
+            uber_direct: boolean;
+            lieferando: boolean;
+        };
         /** @description Customer-facing Zeemijlen balance + redemption economics. */
         ZeemijlenSummary: {
             points_balance: number;
@@ -8144,7 +8162,7 @@ interface operations {
                     };
                 };
             };
-            /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `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. */
+            /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`. 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. */
             400: {
                 headers: {
                     [name: string]: unknown;

package/package.json

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