@poweredbysous/storefront-admin-sdk 4.3.1 → 4.4.0

package/dist/index.d.cts

@@ -353,6 +353,30 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/nationwide-shipping/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read the company's nationwide-shipping switch
+         * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
+         */
+        get: operations["admin_nationwide_shipping_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Switch nationwide shipping on or off for every store of the company
+         * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
+         */
+        patch: operations["admin_nationwide_shipping_partial_update"];
+        trace?: never;
+    };
     "/api/v1/admin/pages/": {
         parameters: {
             query?: never;
@@ -4370,6 +4394,13 @@ interface components {
          * @enum {string}
          */
         NamespaceEnum: "merchant" | "product" | "category" | "collection" | "geocoding" | "shipping" | "translation" | "keycloak" | "segment" | "page" | "channel";
+        /** @description The company's nationwide-shipping switch (exploreSOUS). */
+        NationwideShipping: {
+            /** @description Whether the company is on exploreSOUS and so has the switch. */
+            is_available: boolean;
+            /** @description Whether any of the company's stores ships nationwide. */
+            is_enabled: boolean;
+        };
         /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
         OpenStatus: {
             open: boolean;
@@ -5207,6 +5238,9 @@ interface components {
         PatchedSetCompanyAvailability: {
             is_available?: boolean;
         };
+        PatchedSetNationwideShipping: {
+            is_enabled?: boolean;
+        };
         /**
          * @description PATCH body for a store's delivery-method row.
          *
@@ -7501,6 +7535,182 @@ interface operations {
             };
         };
     };
+    admin_nationwide_shipping_retrieve: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NationwideShipping"];
+                };
+            };
+            /** @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. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. 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 `NATIONWIDE_CARRIER_UNCLEAR`. 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 `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_nationwide_shipping_partial_update: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedSetNationwideShipping"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedSetNationwideShipping"];
+                "multipart/form-data": components["schemas"]["PatchedSetNationwideShipping"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NationwideShipping"];
+                };
+            };
+            /** @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. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. 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 `NATIONWIDE_CARRIER_UNCLEAR`. 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 `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_pages_list: {
         parameters: {
             query?: {

package/dist/index.d.ts

@@ -353,6 +353,30 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/nationwide-shipping/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read the company's nationwide-shipping switch
+         * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
+         */
+        get: operations["admin_nationwide_shipping_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Switch nationwide shipping on or off for every store of the company
+         * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
+         */
+        patch: operations["admin_nationwide_shipping_partial_update"];
+        trace?: never;
+    };
     "/api/v1/admin/pages/": {
         parameters: {
             query?: never;
@@ -4370,6 +4394,13 @@ interface components {
          * @enum {string}
          */
         NamespaceEnum: "merchant" | "product" | "category" | "collection" | "geocoding" | "shipping" | "translation" | "keycloak" | "segment" | "page" | "channel";
+        /** @description The company's nationwide-shipping switch (exploreSOUS). */
+        NationwideShipping: {
+            /** @description Whether the company is on exploreSOUS and so has the switch. */
+            is_available: boolean;
+            /** @description Whether any of the company's stores ships nationwide. */
+            is_enabled: boolean;
+        };
         /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
         OpenStatus: {
             open: boolean;
@@ -5207,6 +5238,9 @@ interface components {
         PatchedSetCompanyAvailability: {
             is_available?: boolean;
         };
+        PatchedSetNationwideShipping: {
+            is_enabled?: boolean;
+        };
         /**
          * @description PATCH body for a store's delivery-method row.
          *
@@ -7501,6 +7535,182 @@ interface operations {
             };
         };
     };
+    admin_nationwide_shipping_retrieve: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NationwideShipping"];
+                };
+            };
+            /** @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. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. 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 `NATIONWIDE_CARRIER_UNCLEAR`. 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 `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_nationwide_shipping_partial_update: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
+                "X-Sous-Company-Id"?: number;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedSetNationwideShipping"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedSetNationwideShipping"];
+                "multipart/form-data": components["schemas"]["PatchedSetNationwideShipping"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NationwideShipping"];
+                };
+            };
+            /** @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. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. 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 `NATIONWIDE_CARRIER_UNCLEAR`. 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 `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_pages_list: {
         parameters: {
             query?: {

package/package.json

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