@poweredbysous/storefront-all-sdk 4.3.0 → 4.4.0

package/dist/index.d.cts

@@ -3760,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;
@@ -7880,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.
@@ -8086,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.
@@ -8097,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[];
@@ -8621,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;
@@ -11081,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.
@@ -29019,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

@@ -3760,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;
@@ -7880,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.
@@ -8086,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.
@@ -8097,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[];
@@ -8621,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;
@@ -11081,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.
@@ -29019,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.3.0",
+  "version": "4.4.0",
   "description": "Type-safe TypeScript SDK for all SOUS Storefront Backend endpoints",
   "license": "UNLICENSED",
   "private": false,