@poweredbysous/storefront-sdk 2.0.1 → 2.2.0

package/dist/index.d.cts

@@ -657,6 +657,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/checkout/{checkout_id}/marketing-consent/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * @description PATCH /api/v1/checkout/{id}/marketing-consent/ — the customer's opt-in
+         *     for special offers and updates.
+         *
+         *     Kept off the delivery PATCH deliberately: consent is an independent choice
+         *     the customer can toggle at any point in the flow, and folding it into
+         *     ``set_delivery`` would force a ``DELIVERY_SET`` transition on a write that
+         *     changes no totals. Store-scoped like every other checkout mutation.
+         */
+        patch: operations["checkout_marketing_consent_partial_update"];
+        trace?: never;
+    };
     "/api/v1/checkout/{checkout_id}/packaging-choice/": {
         parameters: {
             query?: never;
@@ -2549,7 +2574,7 @@ interface components {
             id: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /**
@@ -2764,7 +2789,7 @@ interface components {
             id: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /**
@@ -3038,7 +3063,7 @@ interface components {
             id: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /** @description 6-character alphanumeric code for sharing */
@@ -3231,7 +3256,7 @@ interface components {
             order_number: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /**
@@ -3589,6 +3614,24 @@ interface components {
             /** Format: uuid */
             service_point_id?: string | null;
         };
+        /**
+         * @description Marketing consent captured at checkout.
+         *
+         *     A single opt-in for special offers and updates (over email, SMS or
+         *     WhatsApp), plus the version identifier of the consent copy the customer
+         *     saw. Stored on the checkout and copied to the order at creation, then
+         *     forwarded to the merchant portal, which persists it onto the customer
+         *     record. Unticked by default; the order completes regardless of state.
+         */
+        PatchedMarketingConsentInput: {
+            /** @default false */
+            opted_in: boolean;
+            /**
+             * @description Version id of the consent copy shown to the customer.
+             * @default
+             */
+            version: string;
+        };
         PatchedPromotion: {
             readonly id?: number;
             /** @description Per-location id (PAT-1306). Required when location_scope=SINGLE; NULL for SUBSET and ALL_LOCATIONS. */
@@ -7872,6 +7915,107 @@ interface operations {
             };
         };
     };
+    checkout_marketing_consent_partial_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                checkout_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedMarketingConsentInput"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedMarketingConsentInput"];
+                "multipart/form-data": components["schemas"]["PatchedMarketingConsentInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. 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;
+                };
+                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: `CHECKOUT_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_GROUP_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_RATE_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: `CHECKOUT_INVALID_STATUS`. Retryable: no. Possible error codes include `CHECKOUT_INVALID_STATUS`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PAYMENT_IN_FLIGHT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `store_closed_for_date`. Use `x-error-codes` for machine-readable retryability metadata. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `SHIPPING_RATE_EXPIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            410: {
+                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. Possible error codes include `MERCHANT_AT_CAPACITY`. 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"];
+                };
+            };
+        };
+    };
     checkout_packaging_choice_create: {
         parameters: {
             query?: never;

package/dist/index.d.ts

@@ -657,6 +657,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/checkout/{checkout_id}/marketing-consent/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * @description PATCH /api/v1/checkout/{id}/marketing-consent/ — the customer's opt-in
+         *     for special offers and updates.
+         *
+         *     Kept off the delivery PATCH deliberately: consent is an independent choice
+         *     the customer can toggle at any point in the flow, and folding it into
+         *     ``set_delivery`` would force a ``DELIVERY_SET`` transition on a write that
+         *     changes no totals. Store-scoped like every other checkout mutation.
+         */
+        patch: operations["checkout_marketing_consent_partial_update"];
+        trace?: never;
+    };
     "/api/v1/checkout/{checkout_id}/packaging-choice/": {
         parameters: {
             query?: never;
@@ -2549,7 +2574,7 @@ interface components {
             id: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /**
@@ -2764,7 +2789,7 @@ interface components {
             id: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /**
@@ -3038,7 +3063,7 @@ interface components {
             id: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /** @description 6-character alphanumeric code for sharing */
@@ -3231,7 +3256,7 @@ interface components {
             order_number: string;
             /**
              * Format: int64
-             * @description company_id from the authenticated merchant
+             * @description Store.id from the authenticated merchant
              */
             store_id: number;
             /**
@@ -3589,6 +3614,24 @@ interface components {
             /** Format: uuid */
             service_point_id?: string | null;
         };
+        /**
+         * @description Marketing consent captured at checkout.
+         *
+         *     A single opt-in for special offers and updates (over email, SMS or
+         *     WhatsApp), plus the version identifier of the consent copy the customer
+         *     saw. Stored on the checkout and copied to the order at creation, then
+         *     forwarded to the merchant portal, which persists it onto the customer
+         *     record. Unticked by default; the order completes regardless of state.
+         */
+        PatchedMarketingConsentInput: {
+            /** @default false */
+            opted_in: boolean;
+            /**
+             * @description Version id of the consent copy shown to the customer.
+             * @default
+             */
+            version: string;
+        };
         PatchedPromotion: {
             readonly id?: number;
             /** @description Per-location id (PAT-1306). Required when location_scope=SINGLE; NULL for SUBSET and ALL_LOCATIONS. */
@@ -7872,6 +7915,107 @@ interface operations {
             };
         };
     };
+    checkout_marketing_consent_partial_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                checkout_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedMarketingConsentInput"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedMarketingConsentInput"];
+                "multipart/form-data": components["schemas"]["PatchedMarketingConsentInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. 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;
+                };
+                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: `CHECKOUT_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_GROUP_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_RATE_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: `CHECKOUT_INVALID_STATUS`. Retryable: no. Possible error codes include `CHECKOUT_INVALID_STATUS`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PAYMENT_IN_FLIGHT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `store_closed_for_date`. Use `x-error-codes` for machine-readable retryability metadata. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `SHIPPING_RATE_EXPIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            410: {
+                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. Possible error codes include `MERCHANT_AT_CAPACITY`. 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"];
+                };
+            };
+        };
+    };
     checkout_packaging_choice_create: {
         parameters: {
             query?: never;

package/package.json

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