@poweredbysous/storefront-admin-sdk 3.1.0 → 3.3.0

package/dist/index.d.cts

@@ -577,6 +577,50 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/products/{product_id}/deposit/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a product's deposit (Pfand)
+         * @description Read or set one product's deposit (Pfand) from the Price tab.
+         *
+         *     The portal sends an amount, not a surcharge id: this turns it into an
+         *     attachment (``services.set_product_deposit``) and leaves the product's
+         *     other surcharges alone, unlike ``AdminProductSurchargesView`` which
+         *     replaces the whole set.
+         *
+         *     Adding a deposit is refused unless the store's compliance profile offers
+         *     one, so a store outside Germany — or with no country — cannot get a
+         *     deposit by calling the API directly when the portal never shows the
+         *     section. Removing one is always allowed.
+         */
+        get: operations["admin_products_deposit_retrieve"];
+        /**
+         * Set a product's deposit (Pfand)
+         * @description Read or set one product's deposit (Pfand) from the Price tab.
+         *
+         *     The portal sends an amount, not a surcharge id: this turns it into an
+         *     attachment (``services.set_product_deposit``) and leaves the product's
+         *     other surcharges alone, unlike ``AdminProductSurchargesView`` which
+         *     replaces the whole set.
+         *
+         *     Adding a deposit is refused unless the store's compliance profile offers
+         *     one, so a store outside Germany — or with no country — cannot get a
+         *     deposit by calling the API directly when the portal never shows the
+         *     section. Removing one is always allowed.
+         */
+        put: operations["admin_products_deposit_update"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/admin/products/{product_id}/surcharges/": {
         parameters: {
             query?: never;
@@ -3164,6 +3208,7 @@ interface components {
             /** Format: decimal */
             value_numeric?: string | null;
             selected_choice_slugs?: string[];
+            value_json?: unknown;
         };
         /**
          * @description The request body of the admin attribute-value upsert.
@@ -3183,6 +3228,21 @@ interface components {
         AdminAttributeValuesRequest: {
             values: components["schemas"]["AdminAttributeValueWrite"][];
         };
+        /**
+         * @description A product's deposit (Pfand) as the merchant portal's Price tab edits it.
+         *
+         *     ``amount`` is the per-unit deposit in the store's currency, VAT-inclusive
+         *     like every surcharge amount: positive, in cents. Optional even when
+         *     ``applies`` is true — the amount is not hard-blocking (PAT-2275), and
+         *     ``{"applies": true, "amount": null}`` is a saved state in which nothing
+         *     is charged or shown until an amount is set. Ignored (and read back as
+         *     ``null``) when ``applies`` is false, and must be between 0.01 and 10.00.
+         */
+        AdminProductDeposit: {
+            applies: boolean;
+            /** Format: decimal */
+            amount?: string | null;
+        };
         /**
          * @description Lightweight product row for the merchant-portal product picker.
          *
@@ -3331,8 +3391,8 @@ interface components {
         AdminStoreComplianceDefaults: {
             /** @description Merchant-authored statement of how a customer returns a deposit-carrying container for the Pfand refund (D7). The platform charges and displays the deposit; the merchant runs the return — this is the platform's disclosure of that process, not the process itself. A store with any active deposit-charging product must set this before that product can list (see ``compliance.resolver.validate_products``). Empty means unset. */
             deposit_return_policy?: string;
-            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A product-level value always takes precedence. Empty means unset. */
-            default_responsible_business?: string;
+            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A structured object of the operator's address sub-fields (company, street, postal_code, city, country). A product-level value always takes precedence. An empty object means unset. */
+            default_responsible_business?: unknown;
             /** @description Fallback ``country_of_origin`` compliance value for this store's own prepacked products (D26). A product-level value always takes precedence. Empty means unset. */
             default_country_of_origin?: string;
             /** @description Whether this store offers reusable delivery packaging. German VerpackG §33 obliges eligible restaurants to offer and display the option; stores outside that scope leave it off and see no change. */
@@ -3536,24 +3596,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;
         };
@@ -3623,12 +3669,13 @@ interface components {
             label: string;
             choices: components["schemas"]["ComplianceChoice"][];
             inherits_store_default: boolean;
-            inherited_value: string | null;
+            inherited_value: unknown;
         };
         ComplianceSchemaResponse: {
             product_type: string;
             product_type_classified: boolean;
             requires_attestation: boolean;
+            deposit_config_enabled: boolean;
             fields: components["schemas"]["ComplianceSchemaField"][];
         };
         ConfirmEdit: {
@@ -3805,6 +3852,14 @@ interface components {
             /** Format: date-time */
             disabled_at: string | 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-facing CRUD serializer for :class:`Discount`.
          *
@@ -3970,12 +4025,14 @@ interface components {
          *     * `datetime` - Date & Time
          *     * `dropdown` - Dropdown
          *     * `multiselect` - Multi-select
+         *     * `structured_list` - Structured List
+         *     * `structured_object` - Structured Object
          *     * `file` - File
          *     * `reference` - Reference
          *     * `color` - Color
          * @enum {string}
          */
-        InputTypeEnum: "text" | "rich_text" | "numeric" | "boolean" | "date" | "datetime" | "dropdown" | "multiselect" | "file" | "reference" | "color";
+        InputTypeEnum: "text" | "rich_text" | "numeric" | "boolean" | "date" | "datetime" | "dropdown" | "multiselect" | "structured_list" | "structured_object" | "file" | "reference" | "color";
         Invoice: {
             id: string;
             /** Format: int64 */
@@ -4259,6 +4316,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;
@@ -4402,6 +4464,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;
@@ -4782,8 +4849,8 @@ interface components {
         PatchedAdminStoreComplianceDefaults: {
             /** @description Merchant-authored statement of how a customer returns a deposit-carrying container for the Pfand refund (D7). The platform charges and displays the deposit; the merchant runs the return — this is the platform's disclosure of that process, not the process itself. A store with any active deposit-charging product must set this before that product can list (see ``compliance.resolver.validate_products``). Empty means unset. */
             deposit_return_policy?: string;
-            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A product-level value always takes precedence. Empty means unset. */
-            default_responsible_business?: string;
+            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A structured object of the operator's address sub-fields (company, street, postal_code, city, country). A product-level value always takes precedence. An empty object means unset. */
+            default_responsible_business?: unknown;
             /** @description Fallback ``country_of_origin`` compliance value for this store's own prepacked products (D26). A product-level value always takes precedence. Empty means unset. */
             default_country_of_origin?: string;
             /** @description Whether this store offers reusable delivery packaging. German VerpackG §33 obliges eligible restaurants to offer and display the option; stores outside that scope leave it off and see no change. */
@@ -5061,7 +5128,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. */
@@ -5136,6 +5203,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         /**
@@ -5265,6 +5333,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 */
@@ -5774,6 +5844,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
@@ -5787,6 +5858,8 @@ interface components {
             price: string;
             currency: string;
             image_url: string;
+            /** Format: decimal */
+            deposit_amount?: string | null;
             reason: string;
         };
         Surcharge: {
@@ -5802,7 +5875,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. */
@@ -5953,6 +6026,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         VariantPriceOverride: {
@@ -5996,6 +6070,11 @@ interface components {
             readonly updated_at: string;
             secret?: string;
         };
+        /** @description Per delivery method: whether the wizard's toggle still decides it. */
+        WizardChoiceApplies: {
+            uber_direct: boolean;
+            lieferando: boolean;
+        };
         /** @description Schedule/scope block the storefront re-judges at render time. */
         _DiscountRestrictions: {
             /** @description IANA name the backend judges the schedule in. Re-judge the window against this, not against the browser clock or a locally configured merchant timezone. Null when this store has no usable configured timezone - keep your own fallback in that case, rather than treating the absence as a value. */
@@ -8605,6 +8684,168 @@ interface operations {
             };
         };
     };
+    admin_products_deposit_retrieve: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                product_id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdminProductDeposit"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
+    admin_products_deposit_update: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                product_id: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdminProductDeposit"];
+                "application/x-www-form-urlencoded": components["schemas"]["AdminProductDeposit"];
+                "multipart/form-data": components["schemas"]["AdminProductDeposit"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdminProductDeposit"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
     admin_products_surcharges_update: {
         parameters: {
             query?: never;

package/dist/index.d.ts

@@ -577,6 +577,50 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/products/{product_id}/deposit/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a product's deposit (Pfand)
+         * @description Read or set one product's deposit (Pfand) from the Price tab.
+         *
+         *     The portal sends an amount, not a surcharge id: this turns it into an
+         *     attachment (``services.set_product_deposit``) and leaves the product's
+         *     other surcharges alone, unlike ``AdminProductSurchargesView`` which
+         *     replaces the whole set.
+         *
+         *     Adding a deposit is refused unless the store's compliance profile offers
+         *     one, so a store outside Germany — or with no country — cannot get a
+         *     deposit by calling the API directly when the portal never shows the
+         *     section. Removing one is always allowed.
+         */
+        get: operations["admin_products_deposit_retrieve"];
+        /**
+         * Set a product's deposit (Pfand)
+         * @description Read or set one product's deposit (Pfand) from the Price tab.
+         *
+         *     The portal sends an amount, not a surcharge id: this turns it into an
+         *     attachment (``services.set_product_deposit``) and leaves the product's
+         *     other surcharges alone, unlike ``AdminProductSurchargesView`` which
+         *     replaces the whole set.
+         *
+         *     Adding a deposit is refused unless the store's compliance profile offers
+         *     one, so a store outside Germany — or with no country — cannot get a
+         *     deposit by calling the API directly when the portal never shows the
+         *     section. Removing one is always allowed.
+         */
+        put: operations["admin_products_deposit_update"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/admin/products/{product_id}/surcharges/": {
         parameters: {
             query?: never;
@@ -3164,6 +3208,7 @@ interface components {
             /** Format: decimal */
             value_numeric?: string | null;
             selected_choice_slugs?: string[];
+            value_json?: unknown;
         };
         /**
          * @description The request body of the admin attribute-value upsert.
@@ -3183,6 +3228,21 @@ interface components {
         AdminAttributeValuesRequest: {
             values: components["schemas"]["AdminAttributeValueWrite"][];
         };
+        /**
+         * @description A product's deposit (Pfand) as the merchant portal's Price tab edits it.
+         *
+         *     ``amount`` is the per-unit deposit in the store's currency, VAT-inclusive
+         *     like every surcharge amount: positive, in cents. Optional even when
+         *     ``applies`` is true — the amount is not hard-blocking (PAT-2275), and
+         *     ``{"applies": true, "amount": null}`` is a saved state in which nothing
+         *     is charged or shown until an amount is set. Ignored (and read back as
+         *     ``null``) when ``applies`` is false, and must be between 0.01 and 10.00.
+         */
+        AdminProductDeposit: {
+            applies: boolean;
+            /** Format: decimal */
+            amount?: string | null;
+        };
         /**
          * @description Lightweight product row for the merchant-portal product picker.
          *
@@ -3331,8 +3391,8 @@ interface components {
         AdminStoreComplianceDefaults: {
             /** @description Merchant-authored statement of how a customer returns a deposit-carrying container for the Pfand refund (D7). The platform charges and displays the deposit; the merchant runs the return — this is the platform's disclosure of that process, not the process itself. A store with any active deposit-charging product must set this before that product can list (see ``compliance.resolver.validate_products``). Empty means unset. */
             deposit_return_policy?: string;
-            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A product-level value always takes precedence. Empty means unset. */
-            default_responsible_business?: string;
+            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A structured object of the operator's address sub-fields (company, street, postal_code, city, country). A product-level value always takes precedence. An empty object means unset. */
+            default_responsible_business?: unknown;
             /** @description Fallback ``country_of_origin`` compliance value for this store's own prepacked products (D26). A product-level value always takes precedence. Empty means unset. */
             default_country_of_origin?: string;
             /** @description Whether this store offers reusable delivery packaging. German VerpackG §33 obliges eligible restaurants to offer and display the option; stores outside that scope leave it off and see no change. */
@@ -3536,24 +3596,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;
         };
@@ -3623,12 +3669,13 @@ interface components {
             label: string;
             choices: components["schemas"]["ComplianceChoice"][];
             inherits_store_default: boolean;
-            inherited_value: string | null;
+            inherited_value: unknown;
         };
         ComplianceSchemaResponse: {
             product_type: string;
             product_type_classified: boolean;
             requires_attestation: boolean;
+            deposit_config_enabled: boolean;
             fields: components["schemas"]["ComplianceSchemaField"][];
         };
         ConfirmEdit: {
@@ -3805,6 +3852,14 @@ interface components {
             /** Format: date-time */
             disabled_at: string | 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-facing CRUD serializer for :class:`Discount`.
          *
@@ -3970,12 +4025,14 @@ interface components {
          *     * `datetime` - Date & Time
          *     * `dropdown` - Dropdown
          *     * `multiselect` - Multi-select
+         *     * `structured_list` - Structured List
+         *     * `structured_object` - Structured Object
          *     * `file` - File
          *     * `reference` - Reference
          *     * `color` - Color
          * @enum {string}
          */
-        InputTypeEnum: "text" | "rich_text" | "numeric" | "boolean" | "date" | "datetime" | "dropdown" | "multiselect" | "file" | "reference" | "color";
+        InputTypeEnum: "text" | "rich_text" | "numeric" | "boolean" | "date" | "datetime" | "dropdown" | "multiselect" | "structured_list" | "structured_object" | "file" | "reference" | "color";
         Invoice: {
             id: string;
             /** Format: int64 */
@@ -4259,6 +4316,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;
@@ -4402,6 +4464,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;
@@ -4782,8 +4849,8 @@ interface components {
         PatchedAdminStoreComplianceDefaults: {
             /** @description Merchant-authored statement of how a customer returns a deposit-carrying container for the Pfand refund (D7). The platform charges and displays the deposit; the merchant runs the return — this is the platform's disclosure of that process, not the process itself. A store with any active deposit-charging product must set this before that product can list (see ``compliance.resolver.validate_products``). Empty means unset. */
             deposit_return_policy?: string;
-            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A product-level value always takes precedence. Empty means unset. */
-            default_responsible_business?: string;
+            /** @description Fallback ``responsible_business`` compliance value for this store's own prepacked products, so a merchant can supply it once instead of on every product (D26). A structured object of the operator's address sub-fields (company, street, postal_code, city, country). A product-level value always takes precedence. An empty object means unset. */
+            default_responsible_business?: unknown;
             /** @description Fallback ``country_of_origin`` compliance value for this store's own prepacked products (D26). A product-level value always takes precedence. Empty means unset. */
             default_country_of_origin?: string;
             /** @description Whether this store offers reusable delivery packaging. German VerpackG §33 obliges eligible restaurants to offer and display the option; stores outside that scope leave it off and see no change. */
@@ -5061,7 +5128,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. */
@@ -5136,6 +5203,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         /**
@@ -5265,6 +5333,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 */
@@ -5774,6 +5844,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
@@ -5787,6 +5858,8 @@ interface components {
             price: string;
             currency: string;
             image_url: string;
+            /** Format: decimal */
+            deposit_amount?: string | null;
             reason: string;
         };
         Surcharge: {
@@ -5802,7 +5875,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. */
@@ -5953,6 +6026,7 @@ interface components {
             value_file?: string;
             /** Format: int64 */
             value_reference?: number | null;
+            value_json?: unknown;
             readonly selected_choices: components["schemas"]["AttributeChoice"][];
         };
         VariantPriceOverride: {
@@ -5996,6 +6070,11 @@ interface components {
             readonly updated_at: string;
             secret?: string;
         };
+        /** @description Per delivery method: whether the wizard's toggle still decides it. */
+        WizardChoiceApplies: {
+            uber_direct: boolean;
+            lieferando: boolean;
+        };
         /** @description Schedule/scope block the storefront re-judges at render time. */
         _DiscountRestrictions: {
             /** @description IANA name the backend judges the schedule in. Re-judge the window against this, not against the browser clock or a locally configured merchant timezone. Null when this store has no usable configured timezone - keep your own fallback in that case, rather than treating the absence as a value. */
@@ -8605,6 +8684,168 @@ interface operations {
             };
         };
     };
+    admin_products_deposit_retrieve: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                product_id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdminProductDeposit"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
+    admin_products_deposit_update: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path: {
+                product_id: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdminProductDeposit"];
+                "application/x-www-form-urlencoded": components["schemas"]["AdminProductDeposit"];
+                "multipart/form-data": components["schemas"]["AdminProductDeposit"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdminProductDeposit"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
     admin_products_surcharges_update: {
         parameters: {
             query?: never;

package/package.json

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