npm - @poweredbysous/storefront-all-sdk - Versions diffs - 4.12.0 → 4.13.1 - Mend

@poweredbysous/storefront-all-sdk 4.12.0 → 4.13.1

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

@@ -591,16 +591,38 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description The store's enabled cloud printers. An empty list: no cloud printing. */
+        /**
+         * @description The store's enabled cloud printers (an empty list: no cloud printing).
+         *
+         *     Backoffice can add one.
+         */
         get: operations["admin_printing_store_devices"];
         put?: never;
-        post?: never;
+        /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
+        post: operations["admin_printing_add_store_device"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** @description One printer of the store: change its tickets per order (backoffice only). */
+        patch: operations["admin_printing_update_store_device"];
+        trace?: never;
+    };
     "/api/v1/admin/products/": {
         parameters: {
             query?: never;
@@ -7587,6 +7609,7 @@ interface components {
             readonly promotion: {
                 [key: string]: unknown;
             } | null;
+            readonly pending_auto_discount: components["schemas"]["CartPendingAutoDiscount"] | null;
             readonly shipping_estimate: components["schemas"]["ShippingEstimate"] | null;
             /**
              * Format: decimal
@@ -7726,6 +7749,40 @@ interface components {
             /** @description 'product' or 'modifier' */
             source: string;
         };
+        /**
+         * @description A codeless discount the cart holds products for but does not get yet.
+         *
+         *     Documentation only: the payload is built by
+         *     ``CartSerializer.get_pending_auto_discount``. Null whenever a discount is
+         *     on the cart, a typed code included.
+         */
+        CartPendingAutoDiscount: {
+            /** Format: uuid */
+            discount_id: string;
+            name: string;
+            /**
+             * @description min_order_not_met: the cart subtotal is below min_order_amount; amount_needed says by how much. fulfillment_type_not_allowed: no line the discount covers uses one of allowed_fulfillment_types. Reported before the minimum, since adding to the basket cannot lift it.
+             *
+             *     * `min_order_not_met` - min_order_not_met
+             *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+             */
+            reason: components["schemas"]["CartPendingAutoDiscountReasonEnum"];
+            /** Format: decimal */
+            min_order_amount: string | null;
+            /**
+             * Format: decimal
+             * @description What the subtotal still needs. Null unless min_order_not_met.
+             */
+            amount_needed: string | null;
+            allowed_fulfillment_types: string[];
+            currency: string;
+        };
+        /**
+         * @description * `min_order_not_met` - min_order_not_met
+         *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+         * @enum {string}
+         */
+        CartPendingAutoDiscountReasonEnum: "min_order_not_met" | "fulfillment_type_not_allowed";
         Category: {
             readonly id: number;
             slug: string;
@@ -10252,6 +10309,9 @@ interface components {
             dismiss_duration?: string | null;
             targeting?: unknown;
         };
+        PatchedPrintDeviceUpdateRequest: {
+            copies?: number;
+        };
         PatchedProductChannelListing: {
             readonly id?: number;
             readonly product_id?: number;
@@ -10496,6 +10556,10 @@ interface components {
         PrintDevice: {
             id: number;
             name: string;
+            /** @description The printer's serial number (Sunmi: the MSN on its label). */
+            device_identifier: string;
+            /** @description Tickets per automatic print. A manual print is always one. */
+            copies: number;
             /**
              * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
              *
@@ -10505,6 +10569,25 @@ interface components {
             alert_state: components["schemas"]["AlertStateEnum"];
             /** Format: date-time */
             last_seen_at: string | null;
+            /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
+            online: boolean | null;
+            /**
+             * Format: date-time
+             * @description When that check ran.
+             */
+            online_checked_at: string | null;
+        };
+        /** @description A backoffice user adds a printer to the store in the URL. */
+        PrintDeviceCreateRequest: {
+            /** @description Serial from the printer's label, e.g. N439259A11700. */
+            device_identifier: string;
+            /** @description e.g. "Kitchen" */
+            name: string;
+            /**
+             * @description Tickets per automatic print.
+             * @default 1
+             */
+            copies: number;
         };
         PrintDevicesResponse: {
             devices: components["schemas"]["PrintDevice"][];
@@ -14837,6 +14920,223 @@ interface operations {
             };
         };
     };
+    admin_printing_add_store_device: {
+        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: {
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PrintDeviceCreateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
+                "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @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": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @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"];
+                };
+            };
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    admin_printing_update_store_device: {
+        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: {
+                device_id: number;
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @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": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @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_list: {
         parameters: {
             query?: {

package/dist/index.d.ts CHANGED Viewed

@@ -591,16 +591,38 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description The store's enabled cloud printers. An empty list: no cloud printing. */
+        /**
+         * @description The store's enabled cloud printers (an empty list: no cloud printing).
+         *
+         *     Backoffice can add one.
+         */
         get: operations["admin_printing_store_devices"];
         put?: never;
-        post?: never;
+        /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
+        post: operations["admin_printing_add_store_device"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** @description One printer of the store: change its tickets per order (backoffice only). */
+        patch: operations["admin_printing_update_store_device"];
+        trace?: never;
+    };
     "/api/v1/admin/products/": {
         parameters: {
             query?: never;
@@ -7587,6 +7609,7 @@ interface components {
             readonly promotion: {
                 [key: string]: unknown;
             } | null;
+            readonly pending_auto_discount: components["schemas"]["CartPendingAutoDiscount"] | null;
             readonly shipping_estimate: components["schemas"]["ShippingEstimate"] | null;
             /**
              * Format: decimal
@@ -7726,6 +7749,40 @@ interface components {
             /** @description 'product' or 'modifier' */
             source: string;
         };
+        /**
+         * @description A codeless discount the cart holds products for but does not get yet.
+         *
+         *     Documentation only: the payload is built by
+         *     ``CartSerializer.get_pending_auto_discount``. Null whenever a discount is
+         *     on the cart, a typed code included.
+         */
+        CartPendingAutoDiscount: {
+            /** Format: uuid */
+            discount_id: string;
+            name: string;
+            /**
+             * @description min_order_not_met: the cart subtotal is below min_order_amount; amount_needed says by how much. fulfillment_type_not_allowed: no line the discount covers uses one of allowed_fulfillment_types. Reported before the minimum, since adding to the basket cannot lift it.
+             *
+             *     * `min_order_not_met` - min_order_not_met
+             *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+             */
+            reason: components["schemas"]["CartPendingAutoDiscountReasonEnum"];
+            /** Format: decimal */
+            min_order_amount: string | null;
+            /**
+             * Format: decimal
+             * @description What the subtotal still needs. Null unless min_order_not_met.
+             */
+            amount_needed: string | null;
+            allowed_fulfillment_types: string[];
+            currency: string;
+        };
+        /**
+         * @description * `min_order_not_met` - min_order_not_met
+         *     * `fulfillment_type_not_allowed` - fulfillment_type_not_allowed
+         * @enum {string}
+         */
+        CartPendingAutoDiscountReasonEnum: "min_order_not_met" | "fulfillment_type_not_allowed";
         Category: {
             readonly id: number;
             slug: string;
@@ -10252,6 +10309,9 @@ interface components {
             dismiss_duration?: string | null;
             targeting?: unknown;
         };
+        PatchedPrintDeviceUpdateRequest: {
+            copies?: number;
+        };
         PatchedProductChannelListing: {
             readonly id?: number;
             readonly product_id?: number;
@@ -10496,6 +10556,10 @@ interface components {
         PrintDevice: {
             id: number;
             name: string;
+            /** @description The printer's serial number (Sunmi: the MSN on its label). */
+            device_identifier: string;
+            /** @description Tickets per automatic print. A manual print is always one. */
+            copies: number;
             /**
              * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
              *
@@ -10505,6 +10569,25 @@ interface components {
             alert_state: components["schemas"]["AlertStateEnum"];
             /** Format: date-time */
             last_seen_at: string | null;
+            /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
+            online: boolean | null;
+            /**
+             * Format: date-time
+             * @description When that check ran.
+             */
+            online_checked_at: string | null;
+        };
+        /** @description A backoffice user adds a printer to the store in the URL. */
+        PrintDeviceCreateRequest: {
+            /** @description Serial from the printer's label, e.g. N439259A11700. */
+            device_identifier: string;
+            /** @description e.g. "Kitchen" */
+            name: string;
+            /**
+             * @description Tickets per automatic print.
+             * @default 1
+             */
+            copies: number;
         };
         PrintDevicesResponse: {
             devices: components["schemas"]["PrintDevice"][];
@@ -14837,6 +14920,223 @@ interface operations {
             };
         };
     };
+    admin_printing_add_store_device: {
+        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: {
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PrintDeviceCreateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
+                "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @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": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @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"];
+                };
+            };
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    admin_printing_update_store_device: {
+        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: {
+                device_id: number;
+                store_public_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+                "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PrintDevice"];
+                };
+            };
+            /** @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": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** @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_list: {
         parameters: {
             query?: {

package/package.json CHANGED Viewed

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