@poweredbysous/storefront-admin-sdk 4.0.2 → 4.2.0

package/dist/index.d.cts

@@ -2150,7 +2150,13 @@ interface paths {
          * @description Return the authenticated merchant's information.
          *
          *     Uses the default StoreAuthentication and IsStore permission.
-         *     Useful for testing merchant authentication.
+         *
+         *     With ``?include=location`` the payload also carries the store's pickup
+         *     address and position, so the ExploreSOUS directory can pin it. That costs
+         *     a (cached) geocode, so it is opt-in: the store and product pages read this
+         *     endpoint without it and never pay for one. ``address`` is null without an
+         *     active pickup location; the coordinates are null when the address cannot
+         *     be placed.
          */
         get: operations["merchant_me_retrieve"];
         put?: never;
@@ -2784,6 +2790,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/products/deliverability/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Which products reach a position, and how: the address-aware list, body-borne.
+         *
+         *     The same filter and badges as ``GET /products/?latitude=&longitude=``,
+         *     but the position and postcode travel in the body, because a URL is
+         *     written to every access log between the shopper and here. Returns every
+         *     reachable product (ids and badges only), so there is no page to run off
+         *     the end of.
+         */
+        post: operations["products_deliverability_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/products/search/": {
         parameters: {
             query?: never;
@@ -5243,6 +5274,40 @@ interface components {
             pre_order_lead_time?: number | null;
             readonly variant_overrides: components["schemas"]["VariantPriceOverride"][];
         };
+        /** @description Which products reach the address, and the badges each carries there. */
+        ProductDeliverability: {
+            results: components["schemas"]["ProductDeliverabilityItem"][];
+            delivery_metadata: components["schemas"]["ProductDeliveryMetadata"];
+        };
+        ProductDeliverabilityItem: {
+            id: number;
+            address_fulfillment_types: string[];
+        };
+        /**
+         * @description Body of ``POST /products/deliverability/``: where the shopper is.
+         *
+         *     A body, not a query string, because a position and a postcode are personal
+         *     data and a URL is written to every access log on the way here. ``latitude``
+         *     and ``longitude`` are ``RegexField`` rather than ``DecimalField`` because
+         *     ``DecimalField`` bounds are runtime-only in OpenAPI: generated clients see
+         *     a bare string. The pattern restates the ±90 / ±180 bounds where the client
+         *     can read them, and the view still converts to ``Decimal``.
+         */
+        ProductDeliverabilityRequest: {
+            /** @description Latitude, within ±90 degrees. */
+            latitude: string;
+            /** @description Longitude, within ±180 degrees. */
+            longitude: string;
+            postal_code?: string;
+            /** @description ISO 3166-1 alpha-2. A nationwide carrier that declares per-country service areas only offers its products once the country is known. */
+            country?: string;
+        };
+        ProductDeliveryMetadata: {
+            delivery_unavailable: boolean;
+            near_delivery_zone: boolean;
+            /** @description Closest pickup location; present only when delivery is unavailable. */
+            nearest_pickup?: components["schemas"]["ProductNearestPickup"];
+        };
         /** @description Resolve tags from ProductTranslation, falling back to Product.tags. */
         ProductDetail: {
             readonly id: number;
@@ -5394,6 +5459,13 @@ interface components {
             position?: number;
             readonly modifiers: components["schemas"]["ProductModifier"][];
         };
+        /** @description The closest pickup location: the same shape ``address-check`` returns. */
+        ProductNearestPickup: {
+            id: number;
+            name: string;
+            /** Format: double */
+            distance_km: number;
+        };
         /**
          * @description Display-only promotion badge attached to a product.
          *
@@ -5799,11 +5871,23 @@ interface components {
             store_public_id: string;
             methods: components["schemas"]["DeliveryMethodState"][];
         };
+        StoreMeAddress: {
+            address_1: string;
+            address_2: string;
+            city: string;
+            postal_code: string;
+            country: string;
+        };
         StoreMeResponse: {
             id: number;
             public_id: string;
             name: string;
             currency: string;
+            address?: components["schemas"]["StoreMeAddress"] | null;
+            /** Format: double */
+            latitude?: number | null;
+            /** Format: double */
+            longitude?: number | null;
         };
         /**
          * @description Read/write serializer for the store-onboarding wizard.
@@ -15888,7 +15972,10 @@ interface operations {
     };
     merchant_me_retrieve: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description `location` adds `address`, `latitude` and `longitude`. Omit it and those keys are absent and nothing is geocoded. */
+                include?: "location";
+            };
             header?: never;
             path?: never;
             cookie?: never;
@@ -19554,6 +19641,85 @@ interface operations {
             };
         };
     };
+    products_deliverability_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ProductDeliverabilityRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["ProductDeliverabilityRequest"];
+                "multipart/form-data": components["schemas"]["ProductDeliverabilityRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductDeliverability"];
+                };
+            };
+            /** @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. Possible error codes include `PRODUCT_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"];
+                };
+            };
+        };
+    };
     products_search_retrieve: {
         parameters: {
             query?: {

package/dist/index.d.ts

@@ -2150,7 +2150,13 @@ interface paths {
          * @description Return the authenticated merchant's information.
          *
          *     Uses the default StoreAuthentication and IsStore permission.
-         *     Useful for testing merchant authentication.
+         *
+         *     With ``?include=location`` the payload also carries the store's pickup
+         *     address and position, so the ExploreSOUS directory can pin it. That costs
+         *     a (cached) geocode, so it is opt-in: the store and product pages read this
+         *     endpoint without it and never pay for one. ``address`` is null without an
+         *     active pickup location; the coordinates are null when the address cannot
+         *     be placed.
          */
         get: operations["merchant_me_retrieve"];
         put?: never;
@@ -2784,6 +2790,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/products/deliverability/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Which products reach a position, and how: the address-aware list, body-borne.
+         *
+         *     The same filter and badges as ``GET /products/?latitude=&longitude=``,
+         *     but the position and postcode travel in the body, because a URL is
+         *     written to every access log between the shopper and here. Returns every
+         *     reachable product (ids and badges only), so there is no page to run off
+         *     the end of.
+         */
+        post: operations["products_deliverability_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/products/search/": {
         parameters: {
             query?: never;
@@ -5243,6 +5274,40 @@ interface components {
             pre_order_lead_time?: number | null;
             readonly variant_overrides: components["schemas"]["VariantPriceOverride"][];
         };
+        /** @description Which products reach the address, and the badges each carries there. */
+        ProductDeliverability: {
+            results: components["schemas"]["ProductDeliverabilityItem"][];
+            delivery_metadata: components["schemas"]["ProductDeliveryMetadata"];
+        };
+        ProductDeliverabilityItem: {
+            id: number;
+            address_fulfillment_types: string[];
+        };
+        /**
+         * @description Body of ``POST /products/deliverability/``: where the shopper is.
+         *
+         *     A body, not a query string, because a position and a postcode are personal
+         *     data and a URL is written to every access log on the way here. ``latitude``
+         *     and ``longitude`` are ``RegexField`` rather than ``DecimalField`` because
+         *     ``DecimalField`` bounds are runtime-only in OpenAPI: generated clients see
+         *     a bare string. The pattern restates the ±90 / ±180 bounds where the client
+         *     can read them, and the view still converts to ``Decimal``.
+         */
+        ProductDeliverabilityRequest: {
+            /** @description Latitude, within ±90 degrees. */
+            latitude: string;
+            /** @description Longitude, within ±180 degrees. */
+            longitude: string;
+            postal_code?: string;
+            /** @description ISO 3166-1 alpha-2. A nationwide carrier that declares per-country service areas only offers its products once the country is known. */
+            country?: string;
+        };
+        ProductDeliveryMetadata: {
+            delivery_unavailable: boolean;
+            near_delivery_zone: boolean;
+            /** @description Closest pickup location; present only when delivery is unavailable. */
+            nearest_pickup?: components["schemas"]["ProductNearestPickup"];
+        };
         /** @description Resolve tags from ProductTranslation, falling back to Product.tags. */
         ProductDetail: {
             readonly id: number;
@@ -5394,6 +5459,13 @@ interface components {
             position?: number;
             readonly modifiers: components["schemas"]["ProductModifier"][];
         };
+        /** @description The closest pickup location: the same shape ``address-check`` returns. */
+        ProductNearestPickup: {
+            id: number;
+            name: string;
+            /** Format: double */
+            distance_km: number;
+        };
         /**
          * @description Display-only promotion badge attached to a product.
          *
@@ -5799,11 +5871,23 @@ interface components {
             store_public_id: string;
             methods: components["schemas"]["DeliveryMethodState"][];
         };
+        StoreMeAddress: {
+            address_1: string;
+            address_2: string;
+            city: string;
+            postal_code: string;
+            country: string;
+        };
         StoreMeResponse: {
             id: number;
             public_id: string;
             name: string;
             currency: string;
+            address?: components["schemas"]["StoreMeAddress"] | null;
+            /** Format: double */
+            latitude?: number | null;
+            /** Format: double */
+            longitude?: number | null;
         };
         /**
          * @description Read/write serializer for the store-onboarding wizard.
@@ -15888,7 +15972,10 @@ interface operations {
     };
     merchant_me_retrieve: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description `location` adds `address`, `latitude` and `longitude`. Omit it and those keys are absent and nothing is geocoded. */
+                include?: "location";
+            };
             header?: never;
             path?: never;
             cookie?: never;
@@ -19554,6 +19641,85 @@ interface operations {
             };
         };
     };
+    products_deliverability_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ProductDeliverabilityRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["ProductDeliverabilityRequest"];
+                "multipart/form-data": components["schemas"]["ProductDeliverabilityRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductDeliverability"];
+                };
+            };
+            /** @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. Possible error codes include `PRODUCT_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"];
+                };
+            };
+        };
+    };
     products_search_retrieve: {
         parameters: {
             query?: {

package/package.json

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