chore: generated code for commit 16d841a2. [skip ci]

algolia/api-clients-automation@16d841a Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
algolia · Jan 29, 2024 · 31c9985 · 31c9985
1 parent e7fa96f
commit 31c9985
Show file tree

Hide file tree

Showing 10 changed files with 429 additions and 177 deletions.
diff --git a/packages/algoliasearch/lite/src/liteClient.ts b/packages/algoliasearch/lite/src/liteClient.ts
@@ -125,7 +125,6 @@ export function createLiteClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -160,7 +159,9 @@ export function createLiteClient({
     /**
      * Send multiple search queries to one or more indices.
      *
-     * @summary Search multiple indices.
+     * Required API Key ACLs:
+     * - search.
+     *
      * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

diff --git a/packages/client-abtesting/src/abtestingClient.ts b/packages/client-abtesting/src/abtestingClient.ts
@@ -109,7 +109,9 @@ export function createAbtestingClient({
     /**
      * Creates an A/B test.
      *
-     * @summary Create an A/B test.
+     * Required API Key ACLs:
+     * - editSettings.
+     *
      * @param addABTestsRequest - The addABTestsRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -157,7 +159,6 @@ export function createAbtestingClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -190,7 +191,6 @@ export function createAbtestingClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -223,7 +223,6 @@ export function createAbtestingClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -258,7 +257,6 @@ export function createAbtestingClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -293,7 +291,9 @@ export function createAbtestingClient({
     /**
      * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
      *
-     * @summary Delete an A/B test.
+     * Required API Key ACLs:
+     * - editSettings.
+     *
      * @param deleteABTest - The deleteABTest object.
      * @param deleteABTest.id - Unique A/B test ID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -328,7 +328,9 @@ export function createAbtestingClient({
     /**
      * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
      *
-     * @summary Get A/B test details.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getABTest - The getABTest object.
      * @param getABTest.id - Unique A/B test ID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -361,7 +363,9 @@ export function createAbtestingClient({
     /**
      * List all A/B tests.
      *
-     * @summary List all A/B tests.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param listABTests - The listABTests object.
      * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
      * @param listABTests.limit - Number of records to return (page size).
@@ -406,7 +410,9 @@ export function createAbtestingClient({
     /**
      * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
      *
-     * @summary Stop an A/B test.
+     * Required API Key ACLs:
+     * - editSettings.
+     *
      * @param stopABTest - The stopABTest object.
      * @param stopABTest.id - Unique A/B test ID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

diff --git a/packages/client-analytics/src/analyticsClient.ts b/packages/client-analytics/src/analyticsClient.ts
@@ -135,7 +135,6 @@ export function createAnalyticsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -168,7 +167,6 @@ export function createAnalyticsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -201,7 +199,6 @@ export function createAnalyticsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -236,7 +233,6 @@ export function createAnalyticsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -271,7 +267,9 @@ export function createAnalyticsClient({
     /**
      * Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      *
-     * @summary Get average click position.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getAverageClickPosition - The getAverageClickPosition object.
      * @param getAverageClickPosition.index - Index name to target.
      * @param getAverageClickPosition.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -322,7 +320,9 @@ export function createAnalyticsClient({
     /**
      * Show the number of clicks events and their associated position in the search results.  > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      *
-     * @summary Get click positions.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getClickPositions - The getClickPositions object.
      * @param getClickPositions.index - Index name to target.
      * @param getClickPositions.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -373,7 +373,9 @@ export function createAnalyticsClient({
     /**
      * Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      *
-     * @summary Get click-through rate (CTR).
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getClickThroughRate - The getClickThroughRate object.
      * @param getClickThroughRate.index - Index name to target.
      * @param getClickThroughRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -424,7 +426,9 @@ export function createAnalyticsClient({
     /**
      * Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      *
-     * @summary Get conversion rate (CR).
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getConversationRate - The getConversationRate object.
      * @param getConversationRate.index - Index name to target.
      * @param getConversationRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -475,7 +479,9 @@ export function createAnalyticsClient({
     /**
      * Returns the rate at which searches don\'t lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      *
-     * @summary Get no click rate.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getNoClickRate - The getNoClickRate object.
      * @param getNoClickRate.index - Index name to target.
      * @param getNoClickRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -526,7 +532,9 @@ export function createAnalyticsClient({
     /**
      * Returns the rate at which searches didn\'t return any results.
      *
-     * @summary Get no results rate.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getNoResultsRate - The getNoResultsRate object.
      * @param getNoResultsRate.index - Index name to target.
      * @param getNoResultsRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -577,7 +585,9 @@ export function createAnalyticsClient({
     /**
      * Returns the number of searches within a time range.
      *
-     * @summary Get number of searches.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getSearchesCount - The getSearchesCount object.
      * @param getSearchesCount.index - Index name to target.
      * @param getSearchesCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -628,7 +638,9 @@ export function createAnalyticsClient({
     /**
      * Return the most popular of the last 1,000 searches that didn\'t lead to any clicks.
      *
-     * @summary Get top searches with no clicks.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getSearchesNoClicks - The getSearchesNoClicks object.
      * @param getSearchesNoClicks.index - Index name to target.
      * @param getSearchesNoClicks.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -696,7 +708,9 @@ export function createAnalyticsClient({
     /**
      * Returns the most popular of the latest 1,000 searches that didn\'t return any results.
      *
-     * @summary Get top searches with no results.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getSearchesNoResults - The getSearchesNoResults object.
      * @param getSearchesNoResults.index - Index name to target.
      * @param getSearchesNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -764,7 +778,9 @@ export function createAnalyticsClient({
     /**
      * Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5&nbsp;minutes.
      *
-     * @summary Get Analytics API status.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getStatus - The getStatus object.
      * @param getStatus.index - Index name to target.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -800,7 +816,9 @@ export function createAnalyticsClient({
     /**
      * Returns top countries. Limited to the 1,000 most frequent ones.
      *
-     * @summary Get top countries.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getTopCountries - The getTopCountries object.
      * @param getTopCountries.index - Index name to target.
      * @param getTopCountries.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
@@ -861,7 +879,9 @@ export function createAnalyticsClient({
     /**
      * Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      *
-     * @summary Get top filterable attributes.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getTopFilterAttributes - The getTopFilterAttributes object.
      * @param getTopFilterAttributes.index - Index name to target.
      * @param getTopFilterAttributes.search - User query.
@@ -935,7 +955,9 @@ export function createAnalyticsClient({
     /**
      * Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      *
-     * @summary Get top filter values for an attribute.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
      * @param getTopFilterForAttribute.attribute - Attribute name.
      * @param getTopFilterForAttribute.index - Index name to target.
@@ -1020,7 +1042,9 @@ export function createAnalyticsClient({
     /**
      * Returns top filters for filter-enabled searches that don\'t return results. Limited to the 1,000 most recently used filters.
      *
-     * @summary Get top filters for a no result search.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
      * @param getTopFiltersNoResults.index - Index name to target.
      * @param getTopFiltersNoResults.search - User query.
@@ -1094,7 +1118,9 @@ export function createAnalyticsClient({
     /**
      * Return the most popular clicked results in the last 1,000 searches.
      *
-     * @summary Get top hits.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getTopHits - The getTopHits object.
      * @param getTopHits.index - Index name to target.
      * @param getTopHits.search - User query.
@@ -1174,7 +1200,9 @@ export function createAnalyticsClient({
     /**
      * Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      *
-     * @summary Get top searches.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getTopSearches - The getTopSearches object.
      * @param getTopSearches.index - Index name to target.
      * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
@@ -1260,7 +1288,9 @@ export function createAnalyticsClient({
     /**
      * Return the count of unique users.
      *
-     * @summary Get user count.
+     * Required API Key ACLs:
+     * - analytics.
+     *
      * @param getUsersCount - The getUsersCount object.
      * @param getUsersCount.index - Index name to target.
      * @param getUsersCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.

diff --git a/packages/client-insights/src/insightsClient.ts b/packages/client-insights/src/insightsClient.ts
@@ -104,7 +104,6 @@ export function createInsightsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -137,7 +136,6 @@ export function createInsightsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -170,7 +168,6 @@ export function createInsightsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -205,7 +202,6 @@ export function createInsightsClient({
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -240,7 +236,6 @@ export function createInsightsClient({
     /**
      * Delete all events related to a certain user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](https://www.algolia.com/doc/rest-api/personalization/#delete-a-user-profile).
      *
-     * @summary Delete user token.
      * @param deleteUserToken - The deleteUserToken object.
      * @param deleteUserToken.userToken - The user token for which to delete all associated events.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -275,7 +270,6 @@ export function createInsightsClient({
     /**
      * Send a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbsp;MB.
      *
-     * @summary Send events.
      * @param insightsEvents - The insightsEvents object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */