Skip to content

Commit 560f9b0

Browse files
algolia-botkai687
andcommitted
fix(specs): note on insights API server (generated)
algolia/api-clients-automation#3649 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]>
1 parent 70aac4a commit 560f9b0

27 files changed

+405
-378
lines changed

src/main/scala/algoliasearch/insights/AddToCartEvent.scala

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@
44
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
55
* Insights API. See: [Algolia's
66
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
7-
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
8-
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
9-
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
10-
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
11-
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
12-
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
13-
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
14-
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
15-
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
16-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
17-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
18-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
19-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
20-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
7+
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
8+
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
9+
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
10+
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
11+
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
12+
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
13+
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
14+
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
15+
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
16+
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
17+
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
18+
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
19+
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
20+
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
21+
* as indicated by the `/1/` in each endpoint's URL.
2122
*
2223
* The version of the OpenAPI document: 1.0.0
2324
*

src/main/scala/algoliasearch/insights/AddedToCartObjectIDs.scala

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@
44
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
55
* Insights API. See: [Algolia's
66
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
7-
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
8-
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
9-
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
10-
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
11-
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
12-
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
13-
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
14-
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
15-
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
16-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
17-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
18-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
19-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
20-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
7+
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
8+
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
9+
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
10+
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
11+
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
12+
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
13+
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
14+
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
15+
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
16+
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
17+
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
18+
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
19+
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
20+
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
21+
* as indicated by the `/1/` in each endpoint's URL.
2122
*
2223
* The version of the OpenAPI document: 1.0.0
2324
*

src/main/scala/algoliasearch/insights/AddedToCartObjectIDsAfterSearch.scala

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@
44
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
55
* Insights API. See: [Algolia's
66
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
7-
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
8-
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
9-
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
10-
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
11-
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
12-
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
13-
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
14-
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
15-
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
16-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
17-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
18-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
19-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
20-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
7+
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
8+
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
9+
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
10+
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
11+
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
12+
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
13+
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
14+
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
15+
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
16+
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
17+
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
18+
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
19+
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
20+
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
21+
* as indicated by the `/1/` in each endpoint's URL.
2122
*
2223
* The version of the OpenAPI document: 1.0.0
2324
*

src/main/scala/algoliasearch/insights/ClickEvent.scala

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@
44
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
55
* Insights API. See: [Algolia's
66
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
7-
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
8-
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
9-
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
10-
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
11-
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
12-
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
13-
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
14-
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
15-
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
16-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
17-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
18-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
19-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
20-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
7+
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
8+
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
9+
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
10+
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
11+
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
12+
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
13+
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
14+
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
15+
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
16+
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
17+
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
18+
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
19+
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
20+
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
21+
* as indicated by the `/1/` in each endpoint's URL.
2122
*
2223
* The version of the OpenAPI document: 1.0.0
2324
*

src/main/scala/algoliasearch/insights/ClickedFilters.scala

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@
44
* libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the
55
* Insights API. See: [Algolia's
66
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
7-
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io`
8-
* (`https://insights.algolia.io` is an alias) - `https://insights.de.algolia.io` **All requests must use HTTPS.** ##
9-
* Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
10-
* application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
11-
* access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
12-
* and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
13-
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
14-
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
15-
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
16-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
17-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
18-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
19-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
20-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
7+
* The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` -
8+
* `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above
9+
* servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate
10+
* your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. -
11+
* `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list
12+
* (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the
13+
* [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects.
14+
* ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body
15+
* with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx`
16+
* status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
17+
* information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or
18+
* `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the
19+
* [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia
20+
* features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1,
21+
* as indicated by the `/1/` in each endpoint's URL.
2122
*
2223
* The version of the OpenAPI document: 1.0.0
2324
*

0 commit comments

Comments
 (0)