@algolia/n8n-nodes-algolia 0.6.0 → 0.7.0

package/dist/nodes/Algolia/specs/advanced-personalization.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.2",
   "info": {
     "title": "Advanced Personalization API",
-    "description": "The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app.\n\n## Client libraries\n\nUse Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.\nThe official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/).\n\nSee: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)\n\n## Base URLs\n\nThe Advanced Personalization API can be reached from multiple domains, each specific to a region.\n\n- `https://ai-personalization.eu.algolia.com`\n- `https://ai-personalization.us.algolia.com`\n\nUse the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).\n\n**All requests must use HTTPS.**\n\n## Authentication\n\nTo authenticate your API requests, add these headers:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. An API key with the `search`, `browse` and `recommendation` ACL permissions.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).\n\n## Request format\n\nRequest bodies must be JSON objects.\n\n## Response status and errors\n\nThe Advanced Personalization API returns JSON responses.\nSince JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.\n\nSuccessful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.\nError responses have a `message` property with more information.\n\n## Rate limiting\n\nWhen making requests to the Advanced Personalization API, you are limited to 500 API calls per minute per application.\n\nThe following headers provide information about your current limit:\n\n- `x-ratelimit-limit`: The number of requests allowed every 60 seconds.\n- `x-ratelimit-remaining`: The number of requests remaining in the current 60 second period.\n- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of the next time period.\n\n## Version\n\nThe current version of the Advanced Personalization API is version 2, as indicated by the `/2/` in each endpoint's URL.\n",
+    "description": "The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app.\n\n## Client libraries\n\nUse Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.\nThe official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla).\n\nSee: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem)\n\n## Base URLs\n\nThe Advanced Personalization API can be reached from multiple domains, each specific to a region.\n\n- `https://ai-personalization.eu.algolia.com`\n- `https://ai-personalization.us.algolia.com`\n\nUse the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).\n\n**All requests must use HTTPS.**\n\n## Authentication\n\nTo authenticate your API requests, add these headers:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. An API key with the `search`, `browse` and `recommendation` ACL permissions.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).\n\n## Request format\n\nRequest bodies must be JSON objects.\n\n## Response status and errors\n\nThe Advanced Personalization API returns JSON responses.\nSince JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.\n\nSuccessful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.\nError responses have a `message` property with more information.\n\n## Rate limiting\n\nWhen making requests to the Advanced Personalization API, you are limited to 500 API calls per minute per application.\n\nThe following headers provide information about your current limit:\n\n- `x-ratelimit-limit`: The number of requests allowed every 60 seconds.\n- `x-ratelimit-remaining`: The number of requests remaining in the current 60 second period.\n- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com) of the next time period.\n\n## Version\n\nThe current version of the Advanced Personalization API is version 2, as indicated by the `/2/` in each endpoint's URL.\n",
     "version": "2.0.0"
   },
   "servers": [
@@ -11,10 +11,7 @@
       "variables": {
         "region": {
           "description": "Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).\n",
-          "enum": [
-            "eu",
-            "us"
-          ],
+          "enum": ["eu", "us"],
           "default": "eu"
         }
       }
@@ -37,13 +34,14 @@
       "x-displayName": "Users",
       "description": "Manage user profiles generated by Advanced Personalization.\n\nUser profiles contain the affinities each user has for the different facets in your index.\n",
       "externalDocs": {
-        "url": "https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles/",
-        "description": "Related guide: User Profiles.\n"
+        "url": "https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles",
+        "description": "User profiles."
       }
     }
   ],
   "externalDocs": {
-    "url": "https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/"
+    "url": "https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization",
+    "description": "What is Advanced Personalization."
   },
   "paths": {
     "/{path}": {
@@ -218,15 +216,9 @@
     },
     "/2/config": {
       "get": {
-        "tags": [
-          "config"
-        ],
+        "tags": ["config"],
         "operationId": "getConfig",
-        "x-acl": [
-          "search",
-          "browse",
-          "recommendation"
-        ],
+        "x-acl": ["search", "browse", "recommendation"],
         "summary": "Retrieve the configuration",
         "description": "Retrieves a list of configuration objects for each index.",
         "responses": {
@@ -249,15 +241,9 @@
         }
       },
       "put": {
-        "tags": [
-          "config"
-        ],
+        "tags": ["config"],
         "operationId": "putConfig",
-        "x-acl": [
-          "search",
-          "browse",
-          "recommendation"
-        ],
+        "x-acl": ["search", "browse", "recommendation"],
         "summary": "Update the configuration",
         "description": "Updates the configuration.\n\nThe configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index, create a new configuration object for the index.\n",
         "requestBody": {
@@ -294,17 +280,11 @@
                               "$ref": "#/components/schemas/events"
                             }
                           },
-                          "required": [
-                            "type"
-                          ]
+                          "required": ["type"]
                         }
                       }
                     },
-                    "required": [
-                      "index",
-                      "affinities",
-                      "source"
-                    ]
+                    "required": ["index", "affinities", "source"]
                   },
                   "personalizationReRanking": {
                     "$ref": "#/components/schemas/personalizationReRanking"
@@ -316,12 +296,7 @@
                     "$ref": "#/components/schemas/features"
                   }
                 },
-                "required": [
-                  "indices",
-                  "personalizationReRanking",
-                  "profileType",
-                  "features"
-                ]
+                "required": ["indices", "personalizationReRanking", "profileType", "features"]
               }
             }
           }
@@ -354,12 +329,7 @@
                       "type": "string"
                     }
                   },
-                  "required": [
-                    "status",
-                    "errors",
-                    "warnings",
-                    "message"
-                  ]
+                  "required": ["status", "errors", "warnings", "message"]
                 }
               }
             }
@@ -381,15 +351,9 @@
     },
     "/2/users": {
       "get": {
-        "tags": [
-          "users"
-        ],
+        "tags": ["users"],
         "operationId": "getUsers",
-        "x-acl": [
-          "search",
-          "browse",
-          "recommendation"
-        ],
+        "x-acl": ["search", "browse", "recommendation"],
         "summary": "Get a list of user profiles",
         "description": "Retrieves a list of user profiles in [lexicographical order](https://www.educative.io/answers/what-is-a-lexicographic-order).",
         "parameters": [
@@ -437,9 +401,7 @@
                       "type": "string"
                     }
                   },
-                  "required": [
-                    "users"
-                  ]
+                  "required": ["users"]
                 }
               }
             }
@@ -458,15 +420,9 @@
     },
     "/2/users/{userID}": {
       "get": {
-        "tags": [
-          "users"
-        ],
+        "tags": ["users"],
         "operationId": "getUser",
-        "x-acl": [
-          "search",
-          "browse",
-          "recommendation"
-        ],
+        "x-acl": ["search", "browse", "recommendation"],
         "summary": "Get a user profile",
         "description": "Retrieves a user profile.",
         "parameters": [
@@ -503,15 +459,9 @@
         }
       },
       "delete": {
-        "tags": [
-          "users"
-        ],
+        "tags": ["users"],
         "operationId": "deleteUser",
-        "x-acl": [
-          "search",
-          "browse",
-          "recommendation"
-        ],
+        "x-acl": ["search", "browse", "recommendation"],
         "summary": "Delete a user profile",
         "description": "Deletes a user profile.",
         "parameters": [
@@ -565,13 +515,9 @@
     },
     "/2/realtime/users/{userToken}": {
       "get": {
-        "tags": [
-          "users"
-        ],
+        "tags": ["users"],
         "operationId": "getRealtimeUser",
-        "x-acl": [
-          "recommendation"
-        ],
+        "x-acl": ["recommendation"],
         "summary": "Retrieve the real-time user's personalization profile",
         "description": "Retrieves the real-time user's personalization profiles containing search filters.",
         "parameters": [
@@ -607,13 +553,9 @@
     },
     "/2/realtime/users/{userToken}/compute": {
       "post": {
-        "tags": [
-          "users"
-        ],
+        "tags": ["users"],
         "operationId": "computeRealtimeUser",
-        "x-acl": [
-          "recommendation"
-        ],
+        "x-acl": ["recommendation"],
         "summary": "Compute the real-time user's personalization profile",
         "description": "Sends a request to compute the real-time user's personalization profile.",
         "deprecated": true,
@@ -651,9 +593,7 @@
       "get": {
         "x-helper": true,
         "x-asynchronous-helper": false,
-        "tags": [
-          "Api Key"
-        ],
+        "tags": ["Api Key"],
         "operationId": "setClientApiKey",
         "summary": "Switch the API key used to authenticate requests",
         "description": "Switch the API key used to authenticate requests.\n",
@@ -741,16 +681,11 @@
         },
         "examples": {
           "singleIndex": {
-            "value": [
-              "products_EN"
-            ],
+            "value": ["products_EN"],
             "summary": "Filter by single index"
           },
           "multipleIndices": {
-            "value": [
-              "products_EN",
-              "products_FR"
-            ],
+            "value": ["products_EN", "products_FR"],
             "summary": "Filter by multiple indices"
           }
         },
@@ -848,24 +783,15 @@
       "sourceType": {
         "title": "type",
         "type": "string",
-        "enum": [
-          "insights"
-        ]
+        "enum": ["insights"]
       },
       "eventType": {
         "type": "string",
-        "enum": [
-          "view",
-          "click",
-          "conversion"
-        ]
+        "enum": ["view", "click", "conversion"]
       },
       "subtype": {
         "type": "string",
-        "enum": [
-          "addToCart",
-          "purchase"
-        ]
+        "enum": ["addToCart", "purchase"]
       },
       "event": {
         "type": "object",
@@ -880,10 +806,7 @@
             "type": "string"
           }
         },
-        "required": [
-          "type",
-          "name"
-        ]
+        "required": ["type", "name"]
       },
       "events": {
         "type": "object",
@@ -913,12 +836,7 @@
             }
           }
         },
-        "required": [
-          "viewDetails",
-          "viewListing",
-          "addToCart",
-          "purchase"
-        ]
+        "required": ["viewDetails", "viewListing", "addToCart", "purchase"]
       },
       "issue": {
         "type": "object",
@@ -934,38 +852,22 @@
             "type": "string"
           }
         },
-        "required": [
-          "code",
-          "index",
-          "message"
-        ]
+        "required": ["code", "index", "message"]
       },
       "personalizationReRanking": {
         "type": "string",
         "description": "The impact that personalization has on the re-ranking of search results.",
-        "enum": [
-          "none",
-          "low",
-          "medium",
-          "high",
-          "maximum"
-        ]
+        "enum": ["none", "low", "medium", "high", "maximum"]
       },
       "profileType": {
         "type": "string",
-        "enum": [
-          "basic"
-        ],
+        "enum": ["basic"],
         "description": "The type of user profiles to generate.\n\nBasic profiles are based on past behaviors, ensuring search results align with previous interests.\n"
       },
       "status": {
         "title": "status",
         "type": "string",
-        "enum": [
-          "pending",
-          "active",
-          "paused"
-        ]
+        "enum": ["pending", "active", "paused"]
       },
       "errorCodes": {
         "title": "errorCodes",
@@ -1062,14 +964,7 @@
                   "type": "string"
                 }
               },
-              "required": [
-                "index",
-                "affinities",
-                "source",
-                "errors",
-                "warnings",
-                "lastUpdatedAt"
-              ]
+              "required": ["index", "affinities", "source", "errors", "warnings", "lastUpdatedAt"]
             }
           },
           "personalizationReRanking": {
@@ -1085,27 +980,17 @@
             "$ref": "#/components/schemas/features"
           }
         },
-        "required": [
-          "indices",
-          "personalzationReRanking",
-          "profileType",
-          "status",
-          "features"
-        ]
+        "required": ["indices", "personalzationReRanking", "profileType", "status", "features"]
       },
       "unauthorized": {
         "type": "integer",
         "description": "HTTP status code for an authorization error.",
-        "enum": [
-          401
-        ]
+        "enum": [401]
       },
       "ErrorMessages_unauthorized": {
         "type": "string",
         "description": "Details about the response, such as error messages.",
-        "enum": [
-          "Unauthorized"
-        ]
+        "enum": ["Unauthorized"]
       },
       "ErrorResponses_unauthorized": {
         "type": "object",
@@ -1121,16 +1006,12 @@
       "internalServerError": {
         "type": "integer",
         "description": "HTTP status code for an internal server error.",
-        "enum": [
-          500
-        ]
+        "enum": [500]
       },
       "ErrorMessages_internalServerError": {
         "type": "string",
         "description": "Details about the response, such as error messages.",
-        "enum": [
-          "Internal Server Error"
-        ]
+        "enum": ["Internal Server Error"]
       },
       "ErrorResponses_internalServerError": {
         "type": "object",
@@ -1146,16 +1027,12 @@
       "badRequest": {
         "type": "integer",
         "description": "HTTP status code for a bad request error.",
-        "enum": [
-          400
-        ]
+        "enum": [400]
       },
       "ErrorMessages_badRequest": {
         "type": "string",
         "description": "Details about the response, such as error messages.",
-        "enum": [
-          "Invalid request body"
-        ]
+        "enum": ["Invalid request body"]
       },
       "ErrorResponses_badRequest": {
         "type": "object",
@@ -1171,9 +1048,7 @@
       "paymentRequired": {
         "type": "integer",
         "description": "HTTP status code for a payment required error.",
-        "enum": [
-          402
-        ]
+        "enum": [402]
       },
       "featureNotEnabled": {
         "type": "string",
@@ -1228,38 +1103,24 @@
                   "type": "string"
                 }
               },
-              "required": [
-                "name",
-                "indices",
-                "value",
-                "score",
-                "lastUpdatedAt"
-              ]
+              "required": ["name", "indices", "value", "score", "lastUpdatedAt"]
             }
           },
           "lastUpdatedAt": {
             "type": "string"
           }
         },
-        "required": [
-          "userID",
-          "affinities",
-          "lastUpdatedAt"
-        ]
+        "required": ["userID", "affinities", "lastUpdatedAt"]
       },
       "unprocessableEntity": {
         "type": "integer",
         "description": "HTTP status code for an unprocessable entity error.",
-        "enum": [
-          422
-        ]
+        "enum": [422]
       },
       "genericUnprocessableEntity": {
         "type": "string",
         "description": "Details about the response, such as error messages.",
-        "enum": [
-          "Unprocessable Entity"
-        ]
+        "enum": ["Unprocessable Entity"]
       },
       "ErrorResponses_genericUnprocessableEntity": {
         "type": "object",
@@ -1275,9 +1136,7 @@
       "badUserID": {
         "type": "string",
         "description": "Details about the response, such as error messages.",
-        "enum": [
-          "Invalid userID format"
-        ]
+        "enum": ["Invalid userID format"]
       },
       "ErrorResponses_badUserID": {
         "type": "object",
@@ -1293,16 +1152,12 @@
       "notFound": {
         "type": "integer",
         "description": "HTTP status code for a not found error.",
-        "enum": [
-          404
-        ]
+        "enum": [404]
       },
       "genericNotFound": {
         "type": "string",
         "description": "Details about the response, such as error messages.",
-        "enum": [
-          "Not Found"
-        ]
+        "enum": ["Not Found"]
       },
       "ErrorResponses_genericNotFound": {
         "type": "object",
@@ -1341,19 +1196,13 @@
       },
       "userToken": {
         "type": "string",
-        "description": "Unique pseudonymous or anonymous user identifier.\n\nThis helps with analytics and click and conversion events.\nFor more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).\n",
+        "description": "Unique pseudonymous or anonymous user identifier.\n\nThis helps with analytics and click and conversion events.\nFor more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).\n",
         "example": "test-user-123",
-        "x-categories": [
-          "Personalization"
-        ]
+        "x-categories": ["Personalization"]
       },
       "strategy": {
         "type": "string",
-        "enum": [
-          "session",
-          "historical",
-          "hybrid"
-        ],
+        "enum": ["session", "historical", "hybrid"],
         "example": "session"
       },
       "searchFilter": {
@@ -1365,9 +1214,7 @@
             "items": {
               "type": "string"
             },
-            "example": [
-              "brand:Dyson<score=12>"
-            ]
+            "example": ["brand:Dyson<score=12>"]
           }
         }
       },
@@ -1380,11 +1227,7 @@
             "items": {
               "type": "string"
             },
-            "example": [
-              "storefront",
-              "storefront_price_asc",
-              "storefront_price_desc"
-            ]
+            "example": ["storefront", "storefront_price_asc", "storefront_price_desc"]
           },
           "strategy": {
             "$ref": "#/components/schemas/strategy"
@@ -1398,12 +1241,7 @@
         "title": "RealtimeUser",
         "type": "object",
         "additionalProperties": false,
-        "required": [
-          "version",
-          "userID",
-          "lastUpdatedAt",
-          "search"
-        ],
+        "required": ["version", "userID", "lastUpdatedAt", "search"],
         "properties": {
           "version": {
             "type": "string",
@@ -1557,10 +1395,7 @@
               "title": "tooManyRequestsResponse",
               "type": "object",
               "additionalProperties": false,
-              "required": [
-                "status",
-                "message"
-              ],
+              "required": ["status", "message"],
               "properties": {
                 "status": {
                   "type": "integer",
@@ -1595,10 +1430,7 @@
               "title": "acceptedResponse",
               "type": "object",
               "additionalProperties": false,
-              "required": [
-                "status",
-                "message"
-              ],
+              "required": ["status", "message"],
               "properties": {
                 "status": {
                   "type": "integer",
@@ -1623,10 +1455,7 @@
               "title": "conflictResponse",
               "type": "object",
               "additionalProperties": false,
-              "required": [
-                "status",
-                "message"
-              ],
+              "required": ["status", "message"],
               "properties": {
                 "status": {
                   "type": "integer",
@@ -1658,10 +1487,7 @@
   "x-tagGroups": [
     {
       "name": "Advanced Personalization",
-      "tags": [
-        "config",
-        "users"
-      ]
+      "tags": ["config", "users"]
     }
   ]
-}
+}