npm - @poweredbysous/storefront-all-sdk - Versions diffs - 4.7.0 → 4.8.0 - Mend

@poweredbysous/storefront-all-sdk 4.7.0 → 4.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/index.d.cts CHANGED Viewed

@@ -3192,6 +3192,107 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/exploresous/consent/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description GET / PUT /api/v1/exploresous/consent/ - the signed-in customer's choices.
+         *
+         *     Always the account the token belongs to; no id is read from the request.
+         */
+        get: operations["exploresous_consent_retrieve"];
+        /**
+         * @description GET / PUT /api/v1/exploresous/consent/ - the signed-in customer's choices.
+         *
+         *     Always the account the token belongs to; no id is read from the request.
+         */
+        put: operations["exploresous_consent_update"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/exploresous/history/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description GET /api/v1/exploresous/history/ - the signed-in customer's imported orders.
+         *
+         *     The account comes from the verified token only; no id in the query or body
+         *     is read. ``history_available`` is false until the history is signed off.
+         */
+        get: operations["exploresous_history_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/exploresous/link/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description POST /api/v1/exploresous/link/ - link the WorkOS sign-in to a SOUS account.
+         *
+         *     Authenticates the token without requiring an existing link: this is the call
+         *     that creates it. 200 ``linked``, or 409 ``held`` with a message for the
+         *     customer; the reason is logged, never returned.
+         */
+        post: operations["exploresous_link_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/exploresous/unsubscribe/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description /api/v1/exploresous/unsubscribe/ - login-free one-click unsubscribe.
+         *
+         *     POST withdraws the channel the signed token names. GET only describes it, so
+         *     a mail scanner prefetching the link cannot unsubscribe anyone; the
+         *     storefront page confirms and POSTs.
+         */
+        get: operations["exploresous_unsubscribe_retrieve"];
+        put?: never;
+        /**
+         * @description /api/v1/exploresous/unsubscribe/ - login-free one-click unsubscribe.
+         *
+         *     POST withdraws the channel the signed token names. GET only describes it, so
+         *     a mail scanner prefetching the link cannot unsubscribe anyone; the
+         *     storefront page confirms and POSTs.
+         */
+        post: operations["exploresous_unsubscribe_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/fulfillment/address-check/": {
         parameters: {
             query?: never;
@@ -7582,6 +7683,12 @@ interface components {
             /** Format: date-time */
             readonly created_at: string;
         };
+        /**
+         * @description * `email` - Email
+         *     * `sms` - SMS
+         * @enum {string}
+         */
+        ChannelEnum: "email" | "sms";
         /**
          * @description * `own_website` - Own Website
          *     * `uber_eats` - Uber Eats
@@ -7791,6 +7898,26 @@ interface components {
             /** @default  */
             payment_data: string;
         };
+        /** @description The customer's choice for one channel. */
+        ConsentChoice: {
+            channel: components["schemas"]["ChannelEnum"];
+            status: components["schemas"]["ConsentChoiceStatusEnum"];
+            phone?: string;
+        };
+        /**
+         * @description * `active` - Active
+         *     * `withdrawn` - Withdrawn
+         * @enum {string}
+         */
+        ConsentChoiceStatusEnum: "active" | "withdrawn";
+        ConsentRow: {
+            channel: string;
+            status: string;
+        };
+        /** @description The customer's ExploreSOUS consent, per channel. */
+        Consents: {
+            consents: components["schemas"]["ConsentRow"][];
+        };
         ContentTranslation: {
             language_code: string;
             headline?: string;
@@ -8412,6 +8539,45 @@ interface components {
          * @enum {string}
          */
         HealthStatusEnum: "champion" | "loyal" | "potential_loyal" | "new" | "promising" | "needs_attention" | "about_to_sleep" | "at_risk" | "cant_lose" | "hibernating" | "lost";
+        /** @description The history endpoint's response. */
+        History: {
+            history_available: boolean;
+            orders: components["schemas"]["HistoryOrder"][];
+        };
+        /** @description One line of a past order, as ``projection._lines`` stores it. */
+        HistoryLineItem: {
+            title: string;
+            variant_title: string;
+            quantity: number;
+            unit_price: string | null;
+            vendor: string;
+            partner_name: string;
+            store_id: number | null;
+        };
+        /** @description One past order, as ``history.HistoryOrder``. */
+        HistoryOrder: {
+            name: string;
+            /** Format: date-time */
+            placed_at: string | null;
+            /** Format: date-time */
+            cancelled_at: string | null;
+            financial_status: string;
+            fulfilment_status: string;
+            currency: string;
+            /** Format: decimal */
+            total_amount: string | null;
+            /** Format: decimal */
+            subtotal_amount: string | null;
+            /** Format: decimal */
+            shipping_amount: string | null;
+            /** Format: decimal */
+            tax_amount: string | null;
+            /** Format: decimal */
+            discount_amount: string | null;
+            /** Format: decimal */
+            refunded_amount: string | null;
+            line_items: components["schemas"]["HistoryLineItem"][];
+        };
         /**
          * @description * `customer` - Customer
          *     * `merchant` - Merchant
@@ -8673,6 +8839,12 @@ interface components {
         LightspeedWebhook: {
             endpoint_id: string;
         };
+        /** @description The link endpoint's answer: linked, or held with a message for the customer. */
+        LinkOutcome: {
+            outcome: components["schemas"]["OutcomeEnum"];
+            user_id?: number;
+            detail?: string;
+        };
         /** @description One location's delivery-method state, grouped by the stores serving it. */
         LocationDeliveryMethodSummary: {
             location_public_id: string;
@@ -9335,6 +9507,12 @@ interface components {
             /** Format: date-time */
             readonly updated_at: string;
         };
+        /**
+         * @description * `linked` - linked
+         *     * `held` - held
+         * @enum {string}
+         */
+        OutcomeEnum: "linked" | "held";
         /** @description One POS catalogue item with drift classification. */
         POSCatalogueItem: {
             sku: string;
@@ -11613,6 +11791,16 @@ interface components {
             slug: string;
             abbreviation: string;
         };
+        /** @description The signed token from the unsubscribe link (body or query). */
+        UnsubscribeToken: {
+            token: string;
+        };
+        /** @description What an unsubscribe link covers, and for POST the resulting status. */
+        Unsubscribed: {
+            channel: string;
+            scope: string;
+            status?: string;
+        };
         User: {
             /** @description Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. */
             username: string;
@@ -26533,6 +26721,430 @@ interface operations {
             };
         };
     };
+    exploresous_consent_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Consents"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_consent_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ConsentChoice"];
+                "application/x-www-form-urlencoded": components["schemas"]["ConsentChoice"];
+                "multipart/form-data": components["schemas"]["ConsentChoice"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Consents"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_history_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["History"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_link_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LinkOutcome"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LinkOutcome"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_unsubscribe_retrieve: {
+        parameters: {
+            query: {
+                token: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Unsubscribed"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
+    exploresous_unsubscribe_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UnsubscribeToken"];
+                "application/x-www-form-urlencoded": components["schemas"]["UnsubscribeToken"];
+                "multipart/form-data": components["schemas"]["UnsubscribeToken"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Unsubscribed"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
     fulfillment_address_check_create: {
         parameters: {
             query?: never;

package/dist/index.d.ts CHANGED Viewed

@@ -3192,6 +3192,107 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/exploresous/consent/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description GET / PUT /api/v1/exploresous/consent/ - the signed-in customer's choices.
+         *
+         *     Always the account the token belongs to; no id is read from the request.
+         */
+        get: operations["exploresous_consent_retrieve"];
+        /**
+         * @description GET / PUT /api/v1/exploresous/consent/ - the signed-in customer's choices.
+         *
+         *     Always the account the token belongs to; no id is read from the request.
+         */
+        put: operations["exploresous_consent_update"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/exploresous/history/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description GET /api/v1/exploresous/history/ - the signed-in customer's imported orders.
+         *
+         *     The account comes from the verified token only; no id in the query or body
+         *     is read. ``history_available`` is false until the history is signed off.
+         */
+        get: operations["exploresous_history_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/exploresous/link/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description POST /api/v1/exploresous/link/ - link the WorkOS sign-in to a SOUS account.
+         *
+         *     Authenticates the token without requiring an existing link: this is the call
+         *     that creates it. 200 ``linked``, or 409 ``held`` with a message for the
+         *     customer; the reason is logged, never returned.
+         */
+        post: operations["exploresous_link_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/exploresous/unsubscribe/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description /api/v1/exploresous/unsubscribe/ - login-free one-click unsubscribe.
+         *
+         *     POST withdraws the channel the signed token names. GET only describes it, so
+         *     a mail scanner prefetching the link cannot unsubscribe anyone; the
+         *     storefront page confirms and POSTs.
+         */
+        get: operations["exploresous_unsubscribe_retrieve"];
+        put?: never;
+        /**
+         * @description /api/v1/exploresous/unsubscribe/ - login-free one-click unsubscribe.
+         *
+         *     POST withdraws the channel the signed token names. GET only describes it, so
+         *     a mail scanner prefetching the link cannot unsubscribe anyone; the
+         *     storefront page confirms and POSTs.
+         */
+        post: operations["exploresous_unsubscribe_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/fulfillment/address-check/": {
         parameters: {
             query?: never;
@@ -7582,6 +7683,12 @@ interface components {
             /** Format: date-time */
             readonly created_at: string;
         };
+        /**
+         * @description * `email` - Email
+         *     * `sms` - SMS
+         * @enum {string}
+         */
+        ChannelEnum: "email" | "sms";
         /**
          * @description * `own_website` - Own Website
          *     * `uber_eats` - Uber Eats
@@ -7791,6 +7898,26 @@ interface components {
             /** @default  */
             payment_data: string;
         };
+        /** @description The customer's choice for one channel. */
+        ConsentChoice: {
+            channel: components["schemas"]["ChannelEnum"];
+            status: components["schemas"]["ConsentChoiceStatusEnum"];
+            phone?: string;
+        };
+        /**
+         * @description * `active` - Active
+         *     * `withdrawn` - Withdrawn
+         * @enum {string}
+         */
+        ConsentChoiceStatusEnum: "active" | "withdrawn";
+        ConsentRow: {
+            channel: string;
+            status: string;
+        };
+        /** @description The customer's ExploreSOUS consent, per channel. */
+        Consents: {
+            consents: components["schemas"]["ConsentRow"][];
+        };
         ContentTranslation: {
             language_code: string;
             headline?: string;
@@ -8412,6 +8539,45 @@ interface components {
          * @enum {string}
          */
         HealthStatusEnum: "champion" | "loyal" | "potential_loyal" | "new" | "promising" | "needs_attention" | "about_to_sleep" | "at_risk" | "cant_lose" | "hibernating" | "lost";
+        /** @description The history endpoint's response. */
+        History: {
+            history_available: boolean;
+            orders: components["schemas"]["HistoryOrder"][];
+        };
+        /** @description One line of a past order, as ``projection._lines`` stores it. */
+        HistoryLineItem: {
+            title: string;
+            variant_title: string;
+            quantity: number;
+            unit_price: string | null;
+            vendor: string;
+            partner_name: string;
+            store_id: number | null;
+        };
+        /** @description One past order, as ``history.HistoryOrder``. */
+        HistoryOrder: {
+            name: string;
+            /** Format: date-time */
+            placed_at: string | null;
+            /** Format: date-time */
+            cancelled_at: string | null;
+            financial_status: string;
+            fulfilment_status: string;
+            currency: string;
+            /** Format: decimal */
+            total_amount: string | null;
+            /** Format: decimal */
+            subtotal_amount: string | null;
+            /** Format: decimal */
+            shipping_amount: string | null;
+            /** Format: decimal */
+            tax_amount: string | null;
+            /** Format: decimal */
+            discount_amount: string | null;
+            /** Format: decimal */
+            refunded_amount: string | null;
+            line_items: components["schemas"]["HistoryLineItem"][];
+        };
         /**
          * @description * `customer` - Customer
          *     * `merchant` - Merchant
@@ -8673,6 +8839,12 @@ interface components {
         LightspeedWebhook: {
             endpoint_id: string;
         };
+        /** @description The link endpoint's answer: linked, or held with a message for the customer. */
+        LinkOutcome: {
+            outcome: components["schemas"]["OutcomeEnum"];
+            user_id?: number;
+            detail?: string;
+        };
         /** @description One location's delivery-method state, grouped by the stores serving it. */
         LocationDeliveryMethodSummary: {
             location_public_id: string;
@@ -9335,6 +9507,12 @@ interface components {
             /** Format: date-time */
             readonly updated_at: string;
         };
+        /**
+         * @description * `linked` - linked
+         *     * `held` - held
+         * @enum {string}
+         */
+        OutcomeEnum: "linked" | "held";
         /** @description One POS catalogue item with drift classification. */
         POSCatalogueItem: {
             sku: string;
@@ -11613,6 +11791,16 @@ interface components {
             slug: string;
             abbreviation: string;
         };
+        /** @description The signed token from the unsubscribe link (body or query). */
+        UnsubscribeToken: {
+            token: string;
+        };
+        /** @description What an unsubscribe link covers, and for POST the resulting status. */
+        Unsubscribed: {
+            channel: string;
+            scope: string;
+            status?: string;
+        };
         User: {
             /** @description Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. */
             username: string;
@@ -26533,6 +26721,430 @@ interface operations {
             };
         };
     };
+    exploresous_consent_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Consents"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_consent_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ConsentChoice"];
+                "application/x-www-form-urlencoded": components["schemas"]["ConsentChoice"];
+                "multipart/form-data": components["schemas"]["ConsentChoice"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Consents"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_history_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["History"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_link_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LinkOutcome"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LinkOutcome"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    exploresous_unsubscribe_retrieve: {
+        parameters: {
+            query: {
+                token: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Unsubscribed"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
+    exploresous_unsubscribe_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UnsubscribeToken"];
+                "application/x-www-form-urlencoded": components["schemas"]["UnsubscribeToken"];
+                "multipart/form-data": components["schemas"]["UnsubscribeToken"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Unsubscribed"];
+                };
+            };
+            /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+            /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["APIErrorEnvelope"];
+                };
+            };
+        };
+    };
     fulfillment_address_check_create: {
         parameters: {
             query?: never;

package/package.json CHANGED Viewed

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