@wix/auto_sdk_gbp_locations 1.0.15 → 1.0.17

package/build/cjs/index.d.ts

@@ -380,6 +380,14 @@ interface ListReviewsSignature {
      *
      * `metrics` carries the location's average rating and total review count.
      * Those cover every review on the profile, not just the current page.
+     *
+     * Errors:
+     * - `NOT_FOUND`: the location isn't recorded for this site. Google isn't called.
+     * - `REVIEWS_LOCATION_NOT_FOUND`: Google returned 404 for this location's
+     * reviews. The description names the location id; Google's response body
+     * is withheld.
+     * - `GOOGLE_API_CALL_FAILED`: the call to Google failed for any other reason.
+     * Google's status is in the error payload; its response body is withheld.
      * @param - Location ID. This is Google's location identifier.
      */
     (locationId: string, options?: ListReviewsOptions): Promise<NonNullablePaths<ListReviewsResponse, `reviews` | `reviews.${number}.reviewId` | `reviews.${number}.starRating` | `reviews.${number}.comment` | `reviews.${number}.createTime` | `reviews.${number}.reviewerDisplayName` | `reviews.${number}.anonymousReviewer` | `reviews.${number}.reply.text` | `reviews.${number}.reply.updateTime` | `metrics.averageRating` | `metrics.totalReviewCount`, 3> & {
@@ -635,22 +643,15 @@ interface DeleteLocalPostSignature {
 declare function reportLocalPostInsights$1(httpClient: HttpClient): ReportLocalPostInsightsSignature;
 interface ReportLocalPostInsightsSignature {
     /**
-     * Retrieves metric totals for up to 100 posts on a location.
-     *
-     * Specify the posts in `localPostIds`, the metrics in `metrics`, and the
-     * window in `timeRange`. The window can start at most 18 months before
-     * today, and not later than today. Each post comes back with one total per requested metric.
+     * Unavailable: Google discontinued post insights on February 20, 2023, without replacement.
      *
-     * Google can report data late, so totals for the last few days may still
-     * grow.
-     *
-     * Errors:
-     * - `INVALID_LOCAL_POST_REQUEST`: `timeRange` ends before it starts, starts in
-     * the future, or starts more than 18 months ago. Google isn't called.
-     * - `GOOGLE_API_CALL_FAILED`: the call to Google failed. Google's status is in
-     * the error payload.
+     * Retained for compatibility. Returns `LOCAL_POST_INSIGHTS_UNAVAILABLE` without
+     * contacting Google. Use GetLocationInsights only for whole-location performance;
+     * those metrics cannot be attributed to individual posts.
+     * See https://developers.google.com/my-business/content/sunset-dates.
      * @param - Location ID. This is Google's location identifier.
      * @param - IDs of the posts to report on. Every post must belong to the location.
+     * @deprecated
      */
     (locationId: string, localPostIds: string[], options: NonNullablePaths<ReportLocalPostInsightsOptions, `metrics` | `timeRange`, 0>): Promise<NonNullablePaths<ReportLocalPostInsightsResponse, `localPostInsights` | `localPostInsights.${number}.localPostId` | `timeZone`, 2> & {
         __applicationErrorsType?: ReportLocalPostInsightsApplicationErrors;

package/build/cjs/index.js

@@ -113,6 +113,73 @@ var import_timestamp2 = require("@wix/sdk-runtime/transformations/timestamp");
 var import_field_mask = require("@wix/sdk-runtime/transformations/field-mask");
 var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
 var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+var TRANSFORM_PATHS_0 = [
+  { path: "gbplocation.createdDate" },
+  { path: "gbplocation.updatedDate" }
+];
+var TRANSFORM_PATHS_1 = [
+  { path: "locations.createdDate" },
+  { path: "locations.updatedDate" }
+];
+var TRANSFORM_PATHS_2 = [
+  { path: "locations.googleLocation.latLng.latitude" },
+  { path: "locations.googleLocation.latLng.longitude" }
+];
+var TRANSFORM_PATHS_3 = [
+  { path: "locations.location.createdDate" },
+  { path: "locations.location.updatedDate" }
+];
+var TRANSFORM_PATHS_4 = [
+  { path: "location.googleLocation.latLng.latitude" },
+  { path: "location.googleLocation.latLng.longitude" }
+];
+var TRANSFORM_PATHS_5 = [
+  { path: "location.location.createdDate" },
+  { path: "location.location.updatedDate" }
+];
+var TRANSFORM_PATHS_6 = [
+  { path: "location.createdDate" },
+  { path: "location.updatedDate" }
+];
+var TRANSFORM_PATHS_7 = [{ path: "fieldMask" }];
+var TRANSFORM_PATHS_8 = [
+  { path: "location.latLng.latitude" },
+  { path: "location.latLng.longitude" }
+];
+var TRANSFORM_PATHS_9 = [
+  { path: "results.item.createdDate" },
+  { path: "results.item.updatedDate" }
+];
+var TRANSFORM_PATHS_10 = [{ path: "metrics.averageRating" }];
+var TRANSFORM_PATHS_11 = [
+  { path: "localPost.createdDate" },
+  { path: "localPost.updatedDate" }
+];
+var TRANSFORM_PATHS_12 = [
+  { path: "localPosts.createdDate" },
+  { path: "localPosts.updatedDate" }
+];
+var TRANSFORM_PATHS_13 = [
+  { path: "timeRange.startDate" },
+  { path: "timeRange.endDate" }
+];
+var TRANSFORM_PATHS_14 = [
+  { path: "lodging.allUnits.totalLivingAreas.layout.livingAreaSqMeters" },
+  { path: "lodging.commonLivingArea.layout.livingAreaSqMeters" },
+  {
+    path: "lodging.guestUnits.features.totalLivingAreas.layout.livingAreaSqMeters"
+  },
+  { path: "lodging.someUnits.totalLivingAreas.layout.livingAreaSqMeters" }
+];
+var TRANSFORM_PATHS_15 = [{ path: "lodging.metadata.updateTime" }];
+var TRANSFORM_PATHS_16 = [
+  { path: "attributeMetadata.valueMetadata.numberValue" }
+];
+var TRANSFORM_PATHS_17 = [{ path: "metrics.dailyValues.date" }];
+var TRANSFORM_PATHS_18 = [
+  { path: "matches.location.latLng.latitude" },
+  { path: "matches.location.latLng.longitude" }
+];
 function resolveWixGbpLocationV1GbpLocationsServiceUrl(opts) {
   const domainToMappings = {
     "bo._base_domain_": [
@@ -274,10 +341,7 @@ function getGbpLocation(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "gbplocation.createdDate" },
-            { path: "gbplocation.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_0
         }
       ])
     };
@@ -304,10 +368,7 @@ function queryGbpLocations(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "locations.createdDate" },
-            { path: "locations.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_1
         }
       ]),
       fallback: [
@@ -345,17 +406,11 @@ function queryGoogleLocations(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            { path: "locations.googleLocation.latLng.latitude" },
-            { path: "locations.googleLocation.latLng.longitude" }
-          ]
+          paths: TRANSFORM_PATHS_2
         },
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "locations.location.createdDate" },
-            { path: "locations.location.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_3
         }
       ]),
       fallback: [
@@ -393,17 +448,11 @@ function getGoogleLocation(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            { path: "location.googleLocation.latLng.latitude" },
-            { path: "location.googleLocation.latLng.longitude" }
-          ]
+          paths: TRANSFORM_PATHS_4
         },
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "location.location.createdDate" },
-            { path: "location.location.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_5
         }
       ])
     };
@@ -416,10 +465,7 @@ function createLocation(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [
-          { path: "location.createdDate" },
-          { path: "location.updatedDate" }
-        ]
+        paths: TRANSFORM_PATHS_6
       }
     ]);
     const metadata = {
@@ -439,10 +485,7 @@ function createLocation(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "location.createdDate" },
-            { path: "location.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_6
         }
       ])
     };
@@ -455,14 +498,11 @@ function updateLocation(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
-        paths: [{ path: "fieldMask" }]
+        paths: TRANSFORM_PATHS_7
       },
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [
-          { path: "location.createdDate" },
-          { path: "location.updatedDate" }
-        ]
+        paths: TRANSFORM_PATHS_6
       }
     ]);
     const metadata = {
@@ -482,10 +522,7 @@ function updateLocation(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "location.createdDate" },
-            { path: "location.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_6
         }
       ])
     };
@@ -519,10 +556,7 @@ function createGoogleLocation(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_float.transformSDKFloatToRESTFloat,
-        paths: [
-          { path: "location.latLng.latitude" },
-          { path: "location.latLng.longitude" }
-        ]
+        paths: TRANSFORM_PATHS_8
       }
     ]);
     const metadata = {
@@ -542,10 +576,7 @@ function createGoogleLocation(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "location.createdDate" },
-            { path: "location.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_6
         }
       ])
     };
@@ -579,14 +610,11 @@ function updateGoogleLocation(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
-        paths: [{ path: "fieldMask" }]
+        paths: TRANSFORM_PATHS_7
       },
       {
         transformFn: import_float.transformSDKFloatToRESTFloat,
-        paths: [
-          { path: "location.latLng.latitude" },
-          { path: "location.latLng.longitude" }
-        ]
+        paths: TRANSFORM_PATHS_8
       }
     ]);
     const metadata = {
@@ -606,10 +634,7 @@ function updateGoogleLocation(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            { path: "location.latLng.latitude" },
-            { path: "location.latLng.longitude" }
-          ]
+          paths: TRANSFORM_PATHS_8
         }
       ])
     };
@@ -622,10 +647,7 @@ function bulkCreateLocations(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [
-          { path: "locations.createdDate" },
-          { path: "locations.updatedDate" }
-        ]
+        paths: TRANSFORM_PATHS_1
       }
     ]);
     const metadata = {
@@ -645,10 +667,7 @@ function bulkCreateLocations(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "results.item.createdDate" },
-            { path: "results.item.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_9
         }
       ])
     };
@@ -745,7 +764,7 @@ function updateNotificationSetting(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
-        paths: [{ path: "fieldMask" }]
+        paths: TRANSFORM_PATHS_7
       }
     ]);
     const metadata = {
@@ -786,7 +805,7 @@ function listReviews(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [{ path: "metrics.averageRating" }]
+          paths: TRANSFORM_PATHS_10
         }
       ])
     };
@@ -904,10 +923,7 @@ function createLocalPost(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [
-          { path: "localPost.createdDate" },
-          { path: "localPost.updatedDate" }
-        ]
+        paths: TRANSFORM_PATHS_11
       }
     ]);
     const metadata = {
@@ -927,10 +943,7 @@ function createLocalPost(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "localPost.createdDate" },
-            { path: "localPost.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_11
         }
       ])
     };
@@ -957,10 +970,7 @@ function listLocalPosts(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "localPosts.createdDate" },
-            { path: "localPosts.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_12
         }
       ])
     };
@@ -987,10 +997,7 @@ function getLocalPost(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "localPost.createdDate" },
-            { path: "localPost.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_11
         }
       ])
     };
@@ -1003,14 +1010,11 @@ function updateLocalPost(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
-        paths: [{ path: "fieldMask" }]
+        paths: TRANSFORM_PATHS_7
       },
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [
-          { path: "localPost.createdDate" },
-          { path: "localPost.updatedDate" }
-        ]
+        paths: TRANSFORM_PATHS_11
       }
     ]);
     const metadata = {
@@ -1030,10 +1034,7 @@ function updateLocalPost(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "localPost.createdDate" },
-            { path: "localPost.updatedDate" }
-          ]
+          paths: TRANSFORM_PATHS_11
         }
       ])
     };
@@ -1067,7 +1068,7 @@ function reportLocalPostInsights(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [{ path: "timeRange.startDate" }, { path: "timeRange.endDate" }]
+        paths: TRANSFORM_PATHS_13
       }
     ]);
     const metadata = {
@@ -1171,22 +1172,11 @@ function getLocationLodging(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            {
-              path: "lodging.allUnits.totalLivingAreas.layout.livingAreaSqMeters"
-            },
-            { path: "lodging.commonLivingArea.layout.livingAreaSqMeters" },
-            {
-              path: "lodging.guestUnits.features.totalLivingAreas.layout.livingAreaSqMeters"
-            },
-            {
-              path: "lodging.someUnits.totalLivingAreas.layout.livingAreaSqMeters"
-            }
-          ]
+          paths: TRANSFORM_PATHS_14
         },
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [{ path: "lodging.metadata.updateTime" }]
+          paths: TRANSFORM_PATHS_15
         }
       ])
     };
@@ -1199,26 +1189,15 @@ function updateLocationLodging(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
-        paths: [{ path: "fieldMask" }]
+        paths: TRANSFORM_PATHS_7
       },
       {
         transformFn: import_float.transformSDKFloatToRESTFloat,
-        paths: [
-          {
-            path: "lodging.allUnits.totalLivingAreas.layout.livingAreaSqMeters"
-          },
-          { path: "lodging.commonLivingArea.layout.livingAreaSqMeters" },
-          {
-            path: "lodging.guestUnits.features.totalLivingAreas.layout.livingAreaSqMeters"
-          },
-          {
-            path: "lodging.someUnits.totalLivingAreas.layout.livingAreaSqMeters"
-          }
-        ]
+        paths: TRANSFORM_PATHS_14
       },
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [{ path: "lodging.metadata.updateTime" }]
+        paths: TRANSFORM_PATHS_15
       }
     ]);
     const metadata = {
@@ -1238,22 +1217,11 @@ function updateLocationLodging(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            {
-              path: "lodging.allUnits.totalLivingAreas.layout.livingAreaSqMeters"
-            },
-            { path: "lodging.commonLivingArea.layout.livingAreaSqMeters" },
-            {
-              path: "lodging.guestUnits.features.totalLivingAreas.layout.livingAreaSqMeters"
-            },
-            {
-              path: "lodging.someUnits.totalLivingAreas.layout.livingAreaSqMeters"
-            }
-          ]
+          paths: TRANSFORM_PATHS_14
         },
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [{ path: "lodging.metadata.updateTime" }]
+          paths: TRANSFORM_PATHS_15
         }
       ])
     };
@@ -1280,7 +1248,7 @@ function listAttributeMetadata(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [{ path: "attributeMetadata.valueMetadata.numberValue" }]
+          paths: TRANSFORM_PATHS_16
         }
       ])
     };
@@ -1398,7 +1366,7 @@ function getLocationInsights(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [{ path: "timeRange.startDate" }, { path: "timeRange.endDate" }]
+        paths: TRANSFORM_PATHS_13
       }
     ]);
     const metadata = {
@@ -1418,7 +1386,7 @@ function getLocationInsights(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [{ path: "metrics.dailyValues.date" }]
+          paths: TRANSFORM_PATHS_17
         }
       ])
     };
@@ -1557,10 +1525,7 @@ function searchGoogleLocations(payload) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
       {
         transformFn: import_float.transformSDKFloatToRESTFloat,
-        paths: [
-          { path: "location.latLng.latitude" },
-          { path: "location.latLng.longitude" }
-        ]
+        paths: TRANSFORM_PATHS_8
       }
     ]);
     const metadata = {
@@ -1580,10 +1545,7 @@ function searchGoogleLocations(payload) {
       transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
         {
           transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            { path: "matches.location.latLng.latitude" },
-            { path: "matches.location.latLng.longitude" }
-          ]
+          paths: TRANSFORM_PATHS_18
         }
       ])
     };