Updated OpenAPI specs

yext · Sep 19, 2024 · 26de8f3 · 26de8f3
1 parent 2fa0926
commit 26de8f3
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 0 deletions.
diff --git a/json/knowledgeapi.json b/json/knowledgeapi.json
@@ -90049,6 +90049,43 @@
           "privacyPolicy": {
             "type": "string",
             "description": "Review-collection pages contain a link to the Yext privacy policy by default.\nThis field lets you replace that link with a link to your own privacy policy.\n\nUpdate request must contain a URL or null. If null, the Yext privacy policy link will be used.\n\nIf the **`v`** parameter is before `20200910`, please refer to **`privacyPolicyOverride`** as\nthe parameter name instead of **`privacyPolicy`**.\n"
+          },
+          "balancingOptimization": {
+            "type": "string",
+            "enum": [
+              "DISTRIBUTION",
+              "MORE_REVIEWS",
+              "MUST_BE_LOGGED_IN"
+            ],
+            "description": "Defaults to **`DISTRIBUTION`**. Optionally configure the algorithm to prioritize sites where you have fewer reviews to generate more reviews\n(**`MORE_REVIEWS`**), or prioritize sites where a user is already logged in on their device (**`MUST_BE_LOGGED_IN`**).\n"
+          },
+          "algorithmConfiguration": {
+            "type": "array",
+            "description": "Optionally prioritize the following issues to determine where to send review invites: **`WEBSITE`**: generate more first-party reviews if one\nof the last 5 reviews has 1 star, **`RATING`**: prioritize sites that have the lower rating, **`RECENCY`**: prioritize sites that haven’t\nreceived a review in the last month.\n",
+            "items": {
+              "type": "string",
+              "enum": [
+                "WEBSITE",
+                "RECENCY",
+                "RATING"
+              ],
+              "uniqueItems": true,
+              "maxItems": 3
+            }
+          },
+          "siteDistribution": {
+            "type": "object",
+            "description": "Configure the target distribution of reviews for each site by specifying the ratio as an integer for each site to generate reviews for. E.g.\n**`GOOGLEMYBUSINESS: 1`** and **`FIRSTPARTY: 1`**,  would send half of the review invites to Google and half to your First Party site.\n",
+            "additionalProperties": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "minProperties": 0,
+            "example": {
+              "FACEBOOK": 3,
+              "GOOGLEMYBUSINESS": 5,
+              "FIRSTPARTY": 1
+            }
           }
         }
       },

diff --git a/yaml/knowledgeapi.yaml b/yaml/knowledgeapi.yaml
@@ -119297,6 +119297,42 @@ components:
 
             If the **`v`** parameter is before `20200910`, please refer to **`privacyPolicyOverride`** as
             the parameter name instead of **`privacyPolicy`**.
+        balancingOptimization:
+          type: string
+          enum:
+            - DISTRIBUTION
+            - MORE_REVIEWS
+            - MUST_BE_LOGGED_IN
+          description: |
+            Defaults to **`DISTRIBUTION`**. Optionally configure the algorithm to prioritize sites where you have fewer reviews to generate more reviews
+            (**`MORE_REVIEWS`**), or prioritize sites where a user is already logged in on their device (**`MUST_BE_LOGGED_IN`**).
+        algorithmConfiguration:
+          type: array
+          description: |
+            Optionally prioritize the following issues to determine where to send review invites: **`WEBSITE`**: generate more first-party reviews if one
+            of the last 5 reviews has 1 star, **`RATING`**: prioritize sites that have the lower rating, **`RECENCY`**: prioritize sites that haven’t
+            received a review in the last month.
+          items:
+            type: string
+            enum:
+              - WEBSITE
+              - RECENCY
+              - RATING
+            uniqueItems: true
+            maxItems: 3
+        siteDistribution:
+          type: object
+          description: |
+            Configure the target distribution of reviews for each site by specifying the ratio as an integer for each site to generate reviews for. E.g.
+            **`GOOGLEMYBUSINESS: 1`** and **`FIRSTPARTY: 1`**,  would send half of the review invites to Google and half to your First Party site.
+          additionalProperties:
+            type: integer
+            minimum: 1
+          minProperties: 0
+          example:
+            FACEBOOK: 3
+            GOOGLEMYBUSINESS: 5
+            FIRSTPARTY: 1
     Offer:
       type: object
       description: |