Skip to content

Commit

Permalink
fix(specs): note on insights API server (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3649

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
  • Loading branch information
algolia-bot and kai687 committed Sep 4, 2024
1 parent 70aac4a commit 560f9b0
Show file tree
Hide file tree
Showing 27 changed files with 405 additions and 378 deletions.
29 changes: 15 additions & 14 deletions src/main/scala/algoliasearch/insights/AddToCartEvent.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,21 @@
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
* Insights API. See: [Algolia's
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
* as indicated by the `/1/` in each endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
Expand Down
29 changes: 15 additions & 14 deletions src/main/scala/algoliasearch/insights/AddedToCartObjectIDs.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,21 @@
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
* Insights API. See: [Algolia's
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
* as indicated by the `/1/` in each endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,21 @@
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
* Insights API. See: [Algolia's
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
* as indicated by the `/1/` in each endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
Expand Down
29 changes: 15 additions & 14 deletions src/main/scala/algoliasearch/insights/ClickEvent.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,21 @@
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
* Insights API. See: [Algolia's
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
* as indicated by the `/1/` in each endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
Expand Down
29 changes: 15 additions & 14 deletions src/main/scala/algoliasearch/insights/ClickedFilters.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,21 @@
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
* Insights API. See: [Algolia's
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
* as indicated by the `/1/` in each endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
Expand Down
Loading

0 comments on commit 560f9b0

Please sign in to comment.