@poweredbysous/storefront-all-sdk 4.2.0 → 4.4.0

package/dist/index.d.cts

@@ -3086,6 +3086,23 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/discovery/product-collections/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List the active product collections in the reader's language. */
+        get: operations["discovery_product_collections_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/discovery/product-collections/{slug}/": {
         parameters: {
             query?: never;
@@ -3743,7 +3760,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;
@@ -7863,18 +7886,26 @@ interface components {
             partial: boolean;
         };
         /**
-         * @description The address to answer for.
+         * @description The address, or the position, to answer for.
+         *
+         *     An address is ``postal_code`` and ``country``, with street and city
+         *     optional: most Dutch delivery areas resolve on postcode alone, and
+         *     demanding a house number to filter a listing page would ask for more
+         *     personal data than the answer needs.
          *
-         *     ``postal_code`` and ``country`` are required and the rest is optional:
-         *     most Dutch delivery areas resolve on postcode alone, and demanding a
-         *     house number to filter a listing page would ask for more personal data
-         *     than the answer needs.
+         *     A position (``latitude`` and ``longitude``, together) stands in for the
+         *     postcode when there is none. It is reverse-geocoded to a postcode and
+         *     country, which replace any ``country`` sent. A postcode, when sent, wins.
          */
         DeliverabilityRequest: {
-            postal_code: string;
-            country: string;
+            postal_code?: string;
+            country?: string;
             address_line_1?: string;
             city?: string;
+            /** Format: double */
+            latitude?: number;
+            /** Format: double */
+            longitude?: number;
         };
         /**
          * @description One area a merchant drew on a map.
@@ -8069,6 +8100,7 @@ interface components {
             michelin_stars: number | null;
             tags: string[];
             book_url: string;
+            locations: components["schemas"]["DiscoveryPartnerLocation"][];
         };
         /**
          * @description The whole directory plus its filter vocabulary, in one read.
@@ -8080,6 +8112,14 @@ interface components {
             tags: components["schemas"]["DiscoveryTag"][];
             partners: components["schemas"]["DiscoveryPartner"][];
         };
+        /** @description One of a partner's stores, placed for a map pin. */
+        DiscoveryPartnerLocation: {
+            public_id: string;
+            /** Format: double */
+            latitude: number | null;
+            /** Format: double */
+            longitude: number | null;
+        };
         /** @description The stores ExploreSOUS serves, as ``X-Vendor-ID`` values. */
         DiscoveryStoreMembership: {
             store_ids: string[];
@@ -8604,6 +8644,14 @@ interface components {
             store_public_id: string;
             brand_slug: string;
             brand_name: string;
+            store_name: string;
+            /**
+             * Format: double
+             * @description The store's pickup location, for a map pin; null when it cannot be placed.
+             */
+            store_latitude: number | null;
+            /** Format: double */
+            store_longitude: number | null;
             name: string;
             description: string;
             price_cents: number;
@@ -10149,6 +10197,14 @@ interface components {
             name: string;
             description: string;
         };
+        /** @description The active product collections, by slug, for the sitemap's URLs. */
+        ProductCollectionList: {
+            collections: components["schemas"]["ProductCollectionSummary"][];
+        };
+        /** @description One listed product collection: its slug, the URL the page lives at. */
+        ProductCollectionSummary: {
+            slug: string;
+        };
         /** @description Resolve tags from ProductTranslation, falling back to Product.tags. */
         ProductDetail: {
             readonly id: number;
@@ -10190,6 +10246,7 @@ interface components {
             readonly modifier_groups: components["schemas"]["ProductModifierGroup"][];
             readonly attribute_values: components["schemas"]["ProductAttributeValue"][];
             readonly net_quantity: string | null;
+            readonly unit_price: components["schemas"]["UnitPrice"] | null;
             readonly images: components["schemas"]["ProductImage"][];
             readonly surcharges: components["schemas"]["Surcharge"][];
             readonly metadata: {
@@ -11055,11 +11112,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.
@@ -25826,6 +25895,61 @@ interface operations {
             };
         };
     };
+    discovery_product_collections_list: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductCollectionList"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     discovery_product_collections_retrieve: {
         parameters: {
             query?: {
@@ -28938,7 +29062,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;

package/dist/index.d.ts

@@ -3086,6 +3086,23 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/discovery/product-collections/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List the active product collections in the reader's language. */
+        get: operations["discovery_product_collections_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/discovery/product-collections/{slug}/": {
         parameters: {
             query?: never;
@@ -3743,7 +3760,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;
@@ -7863,18 +7886,26 @@ interface components {
             partial: boolean;
         };
         /**
-         * @description The address to answer for.
+         * @description The address, or the position, to answer for.
+         *
+         *     An address is ``postal_code`` and ``country``, with street and city
+         *     optional: most Dutch delivery areas resolve on postcode alone, and
+         *     demanding a house number to filter a listing page would ask for more
+         *     personal data than the answer needs.
          *
-         *     ``postal_code`` and ``country`` are required and the rest is optional:
-         *     most Dutch delivery areas resolve on postcode alone, and demanding a
-         *     house number to filter a listing page would ask for more personal data
-         *     than the answer needs.
+         *     A position (``latitude`` and ``longitude``, together) stands in for the
+         *     postcode when there is none. It is reverse-geocoded to a postcode and
+         *     country, which replace any ``country`` sent. A postcode, when sent, wins.
          */
         DeliverabilityRequest: {
-            postal_code: string;
-            country: string;
+            postal_code?: string;
+            country?: string;
             address_line_1?: string;
             city?: string;
+            /** Format: double */
+            latitude?: number;
+            /** Format: double */
+            longitude?: number;
         };
         /**
          * @description One area a merchant drew on a map.
@@ -8069,6 +8100,7 @@ interface components {
             michelin_stars: number | null;
             tags: string[];
             book_url: string;
+            locations: components["schemas"]["DiscoveryPartnerLocation"][];
         };
         /**
          * @description The whole directory plus its filter vocabulary, in one read.
@@ -8080,6 +8112,14 @@ interface components {
             tags: components["schemas"]["DiscoveryTag"][];
             partners: components["schemas"]["DiscoveryPartner"][];
         };
+        /** @description One of a partner's stores, placed for a map pin. */
+        DiscoveryPartnerLocation: {
+            public_id: string;
+            /** Format: double */
+            latitude: number | null;
+            /** Format: double */
+            longitude: number | null;
+        };
         /** @description The stores ExploreSOUS serves, as ``X-Vendor-ID`` values. */
         DiscoveryStoreMembership: {
             store_ids: string[];
@@ -8604,6 +8644,14 @@ interface components {
             store_public_id: string;
             brand_slug: string;
             brand_name: string;
+            store_name: string;
+            /**
+             * Format: double
+             * @description The store's pickup location, for a map pin; null when it cannot be placed.
+             */
+            store_latitude: number | null;
+            /** Format: double */
+            store_longitude: number | null;
             name: string;
             description: string;
             price_cents: number;
@@ -10149,6 +10197,14 @@ interface components {
             name: string;
             description: string;
         };
+        /** @description The active product collections, by slug, for the sitemap's URLs. */
+        ProductCollectionList: {
+            collections: components["schemas"]["ProductCollectionSummary"][];
+        };
+        /** @description One listed product collection: its slug, the URL the page lives at. */
+        ProductCollectionSummary: {
+            slug: string;
+        };
         /** @description Resolve tags from ProductTranslation, falling back to Product.tags. */
         ProductDetail: {
             readonly id: number;
@@ -10190,6 +10246,7 @@ interface components {
             readonly modifier_groups: components["schemas"]["ProductModifierGroup"][];
             readonly attribute_values: components["schemas"]["ProductAttributeValue"][];
             readonly net_quantity: string | null;
+            readonly unit_price: components["schemas"]["UnitPrice"] | null;
             readonly images: components["schemas"]["ProductImage"][];
             readonly surcharges: components["schemas"]["Surcharge"][];
             readonly metadata: {
@@ -11055,11 +11112,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.
@@ -25826,6 +25895,61 @@ interface operations {
             };
         };
     };
+    discovery_product_collections_list: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductCollectionList"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     discovery_product_collections_retrieve: {
         parameters: {
             query?: {
@@ -28938,7 +29062,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;

package/package.json

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