From 31c9985561eb3cadda853f8230f9cc5777e0d07e Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 29 Jan 2024 20:45:17 +0000 Subject: [PATCH] chore: generated code for commit 16d841a2. [skip ci] https://github.com/algolia/api-clients-automation/commit/16d841a21b73b2d9df818a938966458d0e23d50c Co-authored-by: algolia-bot Co-authored-by: Pierre Millot --- packages/algoliasearch/lite/src/liteClient.ts | 5 +- .../client-abtesting/src/abtestingClient.ts | 24 +- .../client-analytics/src/analyticsClient.ts | 72 ++++-- .../client-insights/src/insightsClient.ts | 6 - .../src/personalizationClient.ts | 20 +- .../src/querySuggestionsClient.ts | 32 ++- packages/client-search/src/searchClient.ts | 223 +++++++++++++----- packages/ingestion/src/ingestionClient.ts | 187 ++++++++++++--- packages/monitoring/src/monitoringClient.ts | 13 - packages/recommend/src/recommendClient.ts | 24 +- 10 files changed, 429 insertions(+), 177 deletions(-) diff --git a/packages/algoliasearch/lite/src/liteClient.ts b/packages/algoliasearch/lite/src/liteClient.ts index 814ec3e1f..120abf65b 100644 --- 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 index 73663d9f8..6cb5cc15d 100644 --- 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 index 80de058a9..a45162bc7 100644 --- 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 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 index 2a8609417..30fdbabb9 100644 --- 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 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. */ diff --git a/packages/client-personalization/src/personalizationClient.ts b/packages/client-personalization/src/personalizationClient.ts index 6a8e9d9ee..744b5c230 100644 --- a/packages/client-personalization/src/personalizationClient.ts +++ b/packages/client-personalization/src/personalizationClient.ts @@ -108,7 +108,6 @@ export function createPersonalizationClient({ /** * 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. @@ -141,7 +140,6 @@ export function createPersonalizationClient({ /** * 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. @@ -174,7 +172,6 @@ export function createPersonalizationClient({ /** * 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. @@ -209,7 +206,6 @@ export function createPersonalizationClient({ /** * 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. @@ -244,7 +240,9 @@ export function createPersonalizationClient({ /** * Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed. * - * @summary Delete a user profile. + * Required API Key ACLs: + * - recommendation. + * * @param deleteUserProfile - The deleteUserProfile object. * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -279,7 +277,9 @@ export function createPersonalizationClient({ /** * The strategy contains information on the events and facets that impact user profiles and personalized search results. * - * @summary Get the current strategy. + * Required API Key ACLs: + * - recommendation. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getPersonalizationStrategy( @@ -302,7 +302,9 @@ export function createPersonalizationClient({ /** * Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes. * - * @summary Get a user profile. + * Required API Key ACLs: + * - recommendation. + * * @param getUserTokenProfile - The getUserTokenProfile object. * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -337,7 +339,9 @@ export function createPersonalizationClient({ /** * A strategy defines the events and facets that impact user profiles and personalized search results. * - * @summary Set a new strategy. + * Required API Key ACLs: + * - recommendation. + * * @param personalizationStrategyParams - The personalizationStrategyParams object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ diff --git a/packages/client-query-suggestions/src/querySuggestionsClient.ts b/packages/client-query-suggestions/src/querySuggestionsClient.ts index 507cec326..0e5ff0b39 100644 --- a/packages/client-query-suggestions/src/querySuggestionsClient.ts +++ b/packages/client-query-suggestions/src/querySuggestionsClient.ts @@ -112,7 +112,9 @@ export function createQuerySuggestionsClient({ /** * Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application. * - * @summary Create a configuration. + * Required API Key ACLs: + * - editSettings. + * * @param querySuggestionsConfigurationWithIndex - The querySuggestionsConfigurationWithIndex object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -144,7 +146,6 @@ export function createQuerySuggestionsClient({ /** * 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. @@ -177,7 +178,6 @@ export function createQuerySuggestionsClient({ /** * 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. @@ -210,7 +210,6 @@ export function createQuerySuggestionsClient({ /** * 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. @@ -245,7 +244,6 @@ export function createQuerySuggestionsClient({ /** * 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. @@ -280,7 +278,9 @@ export function createQuerySuggestionsClient({ /** * Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted. * - * @summary Delete a configuration. + * Required API Key ACLs: + * - editSettings. + * * @param deleteConfig - The deleteConfig object. * @param deleteConfig.indexName - Query Suggestions index name. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -315,7 +315,9 @@ export function createQuerySuggestionsClient({ /** * List all Query Suggestions configurations of your Algolia application. * - * @summary List configurations. + * Required API Key ACLs: + * - settings. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getAllConfigs( @@ -338,7 +340,9 @@ export function createQuerySuggestionsClient({ /** * Get a single Query Suggestions configuration. * - * @summary Get a configuration. + * Required API Key ACLs: + * - settings. + * * @param getConfig - The getConfig object. * @param getConfig.indexName - Query Suggestions index name. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -373,7 +377,9 @@ export function createQuerySuggestionsClient({ /** * Report the status of a Query Suggestions index. * - * @summary Get configuration status. + * Required API Key ACLs: + * - settings. + * * @param getConfigStatus - The getConfigStatus object. * @param getConfigStatus.indexName - Query Suggestions index name. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -408,7 +414,9 @@ export function createQuerySuggestionsClient({ /** * Get the logs for a single Query Suggestions index. * - * @summary Get logs. + * Required API Key ACLs: + * - settings. + * * @param getLogFile - The getLogFile object. * @param getLogFile.indexName - Query Suggestions index name. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -443,7 +451,9 @@ export function createQuerySuggestionsClient({ /** * Update a QuerySuggestions configuration. * - * @summary Update a configuration. + * Required API Key ACLs: + * - editSettings. + * * @param updateConfig - The updateConfig object. * @param updateConfig.indexName - Query Suggestions index name. * @param updateConfig.querySuggestionsConfiguration - The querySuggestionsConfiguration object. diff --git a/packages/client-search/src/searchClient.ts b/packages/client-search/src/searchClient.ts index 98ceab1da..dd108bfda 100644 --- a/packages/client-search/src/searchClient.ts +++ b/packages/client-search/src/searchClient.ts @@ -490,7 +490,9 @@ export function createSearchClient({ /** * Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string. * - * @summary Add API key. + * Required API Key ACLs: + * - admin. + * * @param apiKey - The apiKey object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -528,7 +530,9 @@ export function createSearchClient({ /** * If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). * - * @summary Add or update a record (using objectID). + * Required API Key ACLs: + * - addObject. + * * @param addOrUpdateObject - The addOrUpdateObject object. * @param addOrUpdateObject.indexName - Index on which to perform the request. * @param addOrUpdateObject.objectID - Unique record (object) identifier. @@ -577,7 +581,9 @@ export function createSearchClient({ /** * Add a source to the list of allowed sources. * - * @summary Add a source. + * Required API Key ACLs: + * - admin. + * * @param source - Source to add. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -615,7 +621,9 @@ export function createSearchClient({ /** * Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. * - * @summary Assign or move a user ID. + * Required API Key ACLs: + * - admin. + * * @param assignUserId - The assignUserId object. * @param assignUserId.xAlgoliaUserID - UserID to assign. * @param assignUserId.assignUserIdParams - The assignUserIdParams object. @@ -665,7 +673,6 @@ export function createSearchClient({ /** * To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name. * - * @summary Batch write operations on one index. * @param batch - The batch object. * @param batch.indexName - Index on which to perform the request. * @param batch.batchWriteParams - The batchWriteParams object. @@ -714,7 +721,9 @@ export function createSearchClient({ /** * Assign multiple user IDs to a cluster. **You can\'t _move_ users with this operation.**. * - * @summary Batch assign userIDs. + * Required API Key ACLs: + * - admin. + * * @param batchAssignUserIds - The batchAssignUserIds object. * @param batchAssignUserIds.xAlgoliaUserID - UserID to assign. * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object. @@ -769,7 +778,9 @@ export function createSearchClient({ /** * Add or remove a batch of dictionary entries. * - * @summary Batch dictionary entries. + * Required API Key ACLs: + * - editSettings. + * * @param batchDictionaryEntries - The batchDictionaryEntries object. * @param batchDictionaryEntries.dictionaryName - Dictionary to search in. * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object. @@ -821,7 +832,9 @@ export function createSearchClient({ /** * Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn\'t support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance. * - * @summary Get all records from an index. + * Required API Key ACLs: + * - browse. + * * @param browse - The browse object. * @param browse.indexName - Index on which to perform the request. * @param browse.browseParams - The browseParams object. @@ -858,7 +871,9 @@ export function createSearchClient({ /** * Delete the records but leave settings and index-specific API keys untouched. * - * @summary Delete all records from an index. + * Required API Key ACLs: + * - deleteIndex. + * * @param clearObjects - The clearObjects object. * @param clearObjects.indexName - Index on which to perform the request. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -893,7 +908,9 @@ export function createSearchClient({ /** * Delete all rules in the index. * - * @summary Delete all rules. + * Required API Key ACLs: + * - editSettings. + * * @param clearRules - The clearRules object. * @param clearRules.indexName - Index on which to perform the request. * @param clearRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. @@ -933,7 +950,9 @@ export function createSearchClient({ /** * Delete all synonyms in the index. * - * @summary Delete all synonyms. + * Required API Key ACLs: + * - editSettings. + * * @param clearSynonyms - The clearSynonyms object. * @param clearSynonyms.indexName - Index on which to perform the request. * @param clearSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. @@ -973,7 +992,6 @@ export function createSearchClient({ /** * 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. @@ -1006,7 +1024,6 @@ export function createSearchClient({ /** * 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. @@ -1039,7 +1056,6 @@ export function createSearchClient({ /** * 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. @@ -1074,7 +1090,6 @@ export function createSearchClient({ /** * 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. @@ -1109,7 +1124,9 @@ export function createSearchClient({ /** * Delete an existing API key. The request must be authenticated with the admin API key. * - * @summary Delete API key. + * Required API Key ACLs: + * - admin. + * * @param deleteApiKey - The deleteApiKey object. * @param deleteApiKey.key - API key. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1144,7 +1161,9 @@ export function createSearchClient({ /** * This operation doesn\'t support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn\'t accept empty filters or queries. * - * @summary Delete all records matching a query. + * Required API Key ACLs: + * - deleteIndex. + * * @param deleteBy - The deleteBy object. * @param deleteBy.indexName - Index on which to perform the request. * @param deleteBy.deleteByParams - The deleteByParams object. @@ -1187,7 +1206,9 @@ export function createSearchClient({ /** * Delete an existing index. * - * @summary Delete index. + * Required API Key ACLs: + * - deleteIndex. + * * @param deleteIndex - The deleteIndex object. * @param deleteIndex.indexName - Index on which to perform the request. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1222,7 +1243,9 @@ export function createSearchClient({ /** * To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead. * - * @summary Delete a record. + * Required API Key ACLs: + * - deleteObject. + * * @param deleteObject - The deleteObject object. * @param deleteObject.indexName - Index on which to perform the request. * @param deleteObject.objectID - Unique record (object) identifier. @@ -1263,7 +1286,9 @@ export function createSearchClient({ /** * Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). * - * @summary Delete a rule. + * Required API Key ACLs: + * - editSettings. + * * @param deleteRule - The deleteRule object. * @param deleteRule.indexName - Index on which to perform the request. * @param deleteRule.objectID - Unique identifier of a rule object. @@ -1309,7 +1334,9 @@ export function createSearchClient({ /** * Remove a source from the list of allowed sources. * - * @summary Remove a source. + * Required API Key ACLs: + * - admin. + * * @param deleteSource - The deleteSource object. * @param deleteSource.source - IP address range of the source. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1344,7 +1371,9 @@ export function createSearchClient({ /** * Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * - * @summary Delete a synonym. + * Required API Key ACLs: + * - editSettings. + * * @param deleteSynonym - The deleteSynonym object. * @param deleteSynonym.indexName - Index on which to perform the request. * @param deleteSynonym.objectID - Unique identifier of a synonym object. @@ -1390,7 +1419,6 @@ export function createSearchClient({ /** * Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key. * - * @summary Get API key permissions. * @param getApiKey - The getApiKey object. * @param getApiKey.key - API key. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1425,7 +1453,9 @@ export function createSearchClient({ /** * Lists Algolia\'s [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language\'s [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features. * - * @summary List available languages. + * Required API Key ACLs: + * - settings. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getDictionaryLanguages( @@ -1448,7 +1478,9 @@ export function createSearchClient({ /** * Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings). * - * @summary Get stop word settings. + * Required API Key ACLs: + * - settings. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getDictionarySettings( @@ -1471,7 +1503,9 @@ export function createSearchClient({ /** * The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There\'s also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn\'t appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN\'s endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). * - * @summary Return the latest log entries. + * Required API Key ACLs: + * - logs. + * * @param getLogs - The getLogs object. * @param getLogs.offset - First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. * @param getLogs.length - Maximum number of entries to retrieve. @@ -1516,7 +1550,9 @@ export function createSearchClient({ /** * To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). * - * @summary Get a record. + * Required API Key ACLs: + * - search. + * * @param getObject - The getObject object. * @param getObject.indexName - Index on which to perform the request. * @param getObject.objectID - Unique record (object) identifier. @@ -1562,7 +1598,9 @@ export function createSearchClient({ /** * Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests. * - * @summary Get multiple records. + * Required API Key ACLs: + * - search. + * * @param getObjectsParams - Request object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -1602,7 +1640,9 @@ export function createSearchClient({ /** * Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). * - * @summary Get a rule. + * Required API Key ACLs: + * - settings. + * * @param getRule - The getRule object. * @param getRule.indexName - Index on which to perform the request. * @param getRule.objectID - Unique identifier of a rule object. @@ -1643,7 +1683,9 @@ export function createSearchClient({ /** * Return an object containing an index\'s [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). * - * @summary Get index settings. + * Required API Key ACLs: + * - search. + * * @param getSettings - The getSettings object. * @param getSettings.indexName - Index on which to perform the request. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1678,7 +1720,9 @@ export function createSearchClient({ /** * Get all allowed sources (IP addresses). * - * @summary Get all allowed IP addresses. + * Required API Key ACLs: + * - admin. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getSources(requestOptions?: RequestOptions): Promise { @@ -1699,7 +1743,9 @@ export function createSearchClient({ /** * Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * - * @summary Get a synonym object. + * Required API Key ACLs: + * - settings. + * * @param getSynonym - The getSynonym object. * @param getSynonym.indexName - Index on which to perform the request. * @param getSynonym.objectID - Unique identifier of a synonym object. @@ -1740,7 +1786,9 @@ export function createSearchClient({ /** * Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task. * - * @summary Check a task\'s status. + * Required API Key ACLs: + * - addObject. + * * @param getTask - The getTask object. * @param getTask.indexName - Index on which to perform the request. * @param getTask.taskID - Unique task identifier. @@ -1781,7 +1829,9 @@ export function createSearchClient({ /** * Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time. * - * @summary Get top userID. + * Required API Key ACLs: + * - admin. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getTopUserIds( @@ -1804,7 +1854,9 @@ export function createSearchClient({ /** * Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time. * - * @summary Get userID. + * Required API Key ACLs: + * - admin. + * * @param getUserId - The getUserId object. * @param getUserId.userID - UserID to assign. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1839,7 +1891,9 @@ export function createSearchClient({ /** * To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process. * - * @summary Get migration and user mapping status. + * Required API Key ACLs: + * - admin. + * * @param hasPendingMappings - The hasPendingMappings object. * @param hasPendingMappings.getClusters - Indicates whether to include the cluster\'s pending mapping state in the response. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1869,7 +1923,9 @@ export function createSearchClient({ /** * List all API keys associated with your Algolia application, including their permissions and restrictions. * - * @summary List API keys. + * Required API Key ACLs: + * - admin. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ listApiKeys(requestOptions?: RequestOptions): Promise { @@ -1890,7 +1946,9 @@ export function createSearchClient({ /** * List the available clusters in a multi-cluster setup. * - * @summary List clusters. + * Required API Key ACLs: + * - admin. + * * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ listClusters( @@ -1913,7 +1971,9 @@ export function createSearchClient({ /** * List indices in an Algolia application. * - * @summary List indices. + * Required API Key ACLs: + * - listIndexes. + * * @param listIndices - The listIndices object. * @param listIndices.page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. * @param listIndices.hitsPerPage - Maximum number of hits per page. @@ -1948,7 +2008,9 @@ export function createSearchClient({ /** * List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time. * - * @summary List userIDs. + * Required API Key ACLs: + * - admin. + * * @param listUserIds - The listUserIds object. * @param listUserIds.page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. * @param listUserIds.hitsPerPage - Maximum number of hits per page. @@ -1983,7 +2045,6 @@ export function createSearchClient({ /** * To reduce the time spent on network round trips, you can perform several write actions in a single request. It\'s a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name. * - * @summary Batch write operations on multiple indices. * @param batchParams - The batchParams object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -2021,7 +2082,9 @@ export function createSearchClient({ /** * This `operation`, _copy_ or _move_, will copy or move a source index\'s (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn\'t exist, it will be created. The choice between moving or copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one. > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/). * - * @summary Copy, move, or rename an index. + * Required API Key ACLs: + * - addObject. + * * @param operationIndex - The operationIndex object. * @param operationIndex.indexName - Index on which to perform the request. * @param operationIndex.operationIndexParams - The operationIndexParams object. @@ -2075,7 +2138,9 @@ export function createSearchClient({ /** * Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor. * - * @summary Update record attributes. + * Required API Key ACLs: + * - addObject. + * * @param partialUpdateObject - The partialUpdateObject object. * @param partialUpdateObject.indexName - Index on which to perform the request. * @param partialUpdateObject.objectID - Unique record (object) identifier. @@ -2134,7 +2199,9 @@ export function createSearchClient({ /** * Remove a userID and its associated data from the multi-clusters. * - * @summary Remove userID. + * Required API Key ACLs: + * - admin. + * * @param removeUserId - The removeUserId object. * @param removeUserId.userID - UserID to assign. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -2169,7 +2236,9 @@ export function createSearchClient({ /** * Replace all allowed sources. * - * @summary Replace all sources. + * Required API Key ACLs: + * - admin. + * * @param replaceSources - The replaceSources object. * @param replaceSources.source - Allowed sources. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -2202,7 +2271,9 @@ export function createSearchClient({ /** * Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key. * - * @summary Restore API key. + * Required API Key ACLs: + * - admin. + * * @param restoreApiKey - The restoreApiKey object. * @param restoreApiKey.key - API key. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -2237,7 +2308,9 @@ export function createSearchClient({ /** * Add a record (object) to an index or replace it. If the record doesn\'t contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). * - * @summary Add or update a record. + * Required API Key ACLs: + * - addObject. + * * @param saveObject - The saveObject object. * @param saveObject.indexName - Index on which to perform the request. * @param saveObject.body - The Algolia record. @@ -2280,7 +2353,9 @@ export function createSearchClient({ /** * To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules). * - * @summary Create or update a rule. + * Required API Key ACLs: + * - editSettings. + * * @param saveRule - The saveRule object. * @param saveRule.indexName - Index on which to perform the request. * @param saveRule.objectID - Unique identifier of a rule object. @@ -2340,7 +2415,9 @@ export function createSearchClient({ /** * Create or update multiple rules. * - * @summary Save a batch of rules. + * Required API Key ACLs: + * - editSettings. + * * @param saveRules - The saveRules object. * @param saveRules.indexName - Index on which to perform the request. * @param saveRules.rules - The rules object. @@ -2398,7 +2475,9 @@ export function createSearchClient({ /** * Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn\'t exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms). * - * @summary Save a synonym. + * Required API Key ACLs: + * - editSettings. + * * @param saveSynonym - The saveSynonym object. * @param saveSynonym.indexName - Index on which to perform the request. * @param saveSynonym.objectID - Unique identifier of a synonym object. @@ -2463,7 +2542,9 @@ export function createSearchClient({ /** * Create or update multiple synonyms. * - * @summary Save a batch of synonyms. + * Required API Key ACLs: + * - editSettings. + * * @param saveSynonyms - The saveSynonyms object. * @param saveSynonyms.indexName - Index on which to perform the request. * @param saveSynonyms.synonymHit - The synonymHit object. @@ -2522,7 +2603,9 @@ export function createSearchClient({ /** * 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. */ @@ -2587,7 +2670,9 @@ export function createSearchClient({ /** * Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries. * - * @summary Search dictionary entries. + * Required API Key ACLs: + * - settings. + * * @param searchDictionaryEntries - The searchDictionaryEntries object. * @param searchDictionaryEntries.dictionaryName - Dictionary to search in. * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object. @@ -2641,7 +2726,9 @@ export function createSearchClient({ /** * [Search for a facet\'s values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn\'t supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`. * - * @summary Search for facet values. + * Required API Key ACLs: + * - search. + * * @param searchForFacetValues - The searchForFacetValues object. * @param searchForFacetValues.indexName - Index on which to perform the request. * @param searchForFacetValues.facetName - Facet name. @@ -2690,7 +2777,9 @@ export function createSearchClient({ /** * Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body. * - * @summary Search for rules. + * Required API Key ACLs: + * - settings. + * * @param searchRules - The searchRules object. * @param searchRules.indexName - Index on which to perform the request. * @param searchRules.searchRulesParams - The searchRulesParams object. @@ -2729,7 +2818,9 @@ export function createSearchClient({ /** * Return records that match the query. * - * @summary Search an index. + * Required API Key ACLs: + * - search. + * * @param searchSingleIndex - The searchSingleIndex object. * @param searchSingleIndex.indexName - Index on which to perform the request. * @param searchSingleIndex.searchParams - The searchParams object. @@ -2768,7 +2859,9 @@ export function createSearchClient({ /** * Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body. * - * @summary Search for synonyms. + * Required API Key ACLs: + * - settings. + * * @param searchSynonyms - The searchSynonyms object. * @param searchSynonyms.indexName - Index on which to perform the request. * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation. @@ -2807,7 +2900,9 @@ export function createSearchClient({ /** * Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time. To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours). * - * @summary Search for a user ID. + * Required API Key ACLs: + * - admin. + * * @param searchUserIdsParams - The searchUserIdsParams object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -2847,7 +2942,9 @@ export function createSearchClient({ /** * Set stop word settings for a specific language. * - * @summary Set stop word settings. + * Required API Key ACLs: + * - editSettings. + * * @param dictionarySettingsParams - The dictionarySettingsParams object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -2885,7 +2982,9 @@ export function createSearchClient({ /** * Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value. * - * @summary Update index settings. + * Required API Key ACLs: + * - editSettings. + * * @param setSettings - The setSettings object. * @param setSettings.indexName - Index on which to perform the request. * @param setSettings.indexSettings - The indexSettings object. @@ -2933,7 +3032,9 @@ export function createSearchClient({ /** * Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key. * - * @summary Update an API key. + * Required API Key ACLs: + * - admin. + * * @param updateApiKey - The updateApiKey object. * @param updateApiKey.key - API key. * @param updateApiKey.apiKey - The apiKey object. diff --git a/packages/ingestion/src/ingestionClient.ts b/packages/ingestion/src/ingestionClient.ts index 8e6efd0c5..97d8a1870 100644 --- a/packages/ingestion/src/ingestionClient.ts +++ b/packages/ingestion/src/ingestionClient.ts @@ -197,7 +197,11 @@ export function createIngestionClient({ /** * Create a authentication. * - * @summary Create a authentication. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param authenticationCreate -. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -245,7 +249,11 @@ export function createIngestionClient({ /** * Create a destination. * - * @summary Create a destination. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param destinationCreate -. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -293,7 +301,11 @@ export function createIngestionClient({ /** * Create a source. * - * @summary Create a source. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param sourceCreate -. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -341,7 +353,6 @@ export function createIngestionClient({ /** * Create a task. * - * @summary Create a task. * @param taskCreate -. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -394,7 +405,6 @@ export function createIngestionClient({ /** * 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. @@ -427,7 +437,6 @@ export function createIngestionClient({ /** * 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. @@ -460,7 +469,6 @@ export function createIngestionClient({ /** * 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. @@ -495,7 +503,6 @@ export function createIngestionClient({ /** * 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. @@ -530,7 +537,11 @@ export function createIngestionClient({ /** * Soft delete the authentication of the given authenticationID. * - * @summary Delete a authentication. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param deleteAuthentication - The deleteAuthentication object. * @param deleteAuthentication.authenticationID - The authentication UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -565,7 +576,11 @@ export function createIngestionClient({ /** * Soft delete the destination of the given destinationID. * - * @summary Delete a destination. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param deleteDestination - The deleteDestination object. * @param deleteDestination.destinationID - The destination UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -600,7 +615,11 @@ export function createIngestionClient({ /** * Soft delete the source of the given sourceID. * - * @summary Delete a source. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param deleteSource - The deleteSource object. * @param deleteSource.sourceID - The source UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -635,7 +654,6 @@ export function createIngestionClient({ /** * Soft delete the task of the given taskID. * - * @summary Delete a task. * @param deleteTask - The deleteTask object. * @param deleteTask.taskID - The task UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -670,7 +688,11 @@ export function createIngestionClient({ /** * Disable the task of the given taskID. * - * @summary Disable a task. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param disableTask - The disableTask object. * @param disableTask.taskID - The task UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -705,7 +727,11 @@ export function createIngestionClient({ /** * Enable the task of the given taskID. * - * @summary Enable a task. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param enableTask - The enableTask object. * @param enableTask.taskID - The task UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -740,7 +766,11 @@ export function createIngestionClient({ /** * Get the authentication of the given authenticationID. * - * @summary Get a authentication. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getAuthentication - The getAuthentication object. * @param getAuthentication.authenticationID - The authentication UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -775,7 +805,11 @@ export function createIngestionClient({ /** * Get a list of authentications for the given query parameters, with pagination details. * - * @summary Get a list of authentications. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getAuthentications - The getAuthentications object. * @param getAuthentications.itemsPerPage - The number of items per page to return. * @param getAuthentications.page - The page number to fetch, starting at 1. @@ -837,7 +871,11 @@ export function createIngestionClient({ /** * Get the destination of the given destinationID. * - * @summary Get a destination. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getDestination - The getDestination object. * @param getDestination.destinationID - The destination UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -872,7 +910,11 @@ export function createIngestionClient({ /** * Get a list of destinations for the given query parameters, with pagination details. * - * @summary Get a list of destinations. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getDestinations - The getDestinations object. * @param getDestinations.itemsPerPage - The number of items per page to return. * @param getDestinations.page - The page number to fetch, starting at 1. @@ -934,7 +976,11 @@ export function createIngestionClient({ /** * Retrieve a stream listing for a given Singer specification compatible docker type source ID. * - * @summary Retrieve a stream listing. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getDockerSourceStreams - The getDockerSourceStreams object. * @param getDockerSourceStreams.sourceID - The source UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -969,7 +1015,11 @@ export function createIngestionClient({ /** * Get a single event for a specific runID. * - * @summary Get an event. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getEvent - The getEvent object. * @param getEvent.runID - The run UUID. * @param getEvent.eventID - The event UUID. @@ -1010,7 +1060,11 @@ export function createIngestionClient({ /** * Get a list of events associated to the given runID, for the given query parameters. * - * @summary Get a list of events. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getEvents - The getEvents object. * @param getEvents.runID - The run UUID. * @param getEvents.itemsPerPage - The number of items per page to return. @@ -1095,7 +1149,11 @@ export function createIngestionClient({ /** * Get a single run for the given ID. * - * @summary Get a run. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getRun - The getRun object. * @param getRun.runID - The run UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1128,7 +1186,11 @@ export function createIngestionClient({ /** * Get a list of runs for the given query parameters, with pagination details. * - * @summary Get a list of runs. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getRuns - The getRuns object. * @param getRuns.itemsPerPage - The number of items per page to return. * @param getRuns.page - The page number to fetch, starting at 1. @@ -1202,7 +1264,11 @@ export function createIngestionClient({ /** * Get the source of the given sourceID. * - * @summary Get a source. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getSource - The getSource object. * @param getSource.sourceID - The source UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1237,7 +1303,11 @@ export function createIngestionClient({ /** * Get a list of sources for the given query parameters, with pagination details. * - * @summary Get a list of sources. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getSources - The getSources object. * @param getSources.itemsPerPage - The number of items per page to return. * @param getSources.page - The page number to fetch, starting at 1. @@ -1299,7 +1369,11 @@ export function createIngestionClient({ /** * Get the task of the given taskID. * - * @summary Get a task. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getTask - The getTask object. * @param getTask.taskID - The task UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1334,7 +1408,11 @@ export function createIngestionClient({ /** * Get a list of tasks for the given query parameters, with pagination details. * - * @summary Get a list of tasks. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param getTasks - The getTasks object. * @param getTasks.itemsPerPage - The number of items per page to return. * @param getTasks.page - The page number to fetch, starting at 1. @@ -1414,7 +1492,11 @@ export function createIngestionClient({ /** * Run the task of the given taskID. * - * @summary Run a task. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param runTask - The runTask object. * @param runTask.taskID - The task UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1449,7 +1531,11 @@ export function createIngestionClient({ /** * Search among authentications with a defined set of parameters. * - * @summary Search among authentications. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param authenticationSearch - The authenticationSearch object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -1487,7 +1573,11 @@ export function createIngestionClient({ /** * Search among destinations with a defined set of parameters. * - * @summary Search among destinations. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param destinationSearch - The destinationSearch object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -1525,7 +1615,11 @@ export function createIngestionClient({ /** * Search among sources with a defined set of parameters. * - * @summary Search among sources. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param sourceSearch - The sourceSearch object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -1563,7 +1657,11 @@ export function createIngestionClient({ /** * Search among tasks with a defined set of parameters. * - * @summary Search among tasks. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param taskSearch - The taskSearch object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -1601,7 +1699,11 @@ export function createIngestionClient({ /** * Trigger a stream listing request for a Singer specification compatible docker type source. * - * @summary Trigger a stream listing request. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object. * @param triggerDockerSourceDiscover.sourceID - The source UUID. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -1636,7 +1738,11 @@ export function createIngestionClient({ /** * Update the authentication of the given authenticationID. * - * @summary Update a authentication. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param updateAuthentication - The updateAuthentication object. * @param updateAuthentication.authenticationID - The authentication UUID. * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object. @@ -1679,7 +1785,11 @@ export function createIngestionClient({ /** * Update the destination of the given destinationID. * - * @summary Update a destination. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param updateDestination - The updateDestination object. * @param updateDestination.destinationID - The destination UUID. * @param updateDestination.destinationUpdate - The destinationUpdate object. @@ -1722,7 +1832,11 @@ export function createIngestionClient({ /** * Update the source of the given sourceID. * - * @summary Update a source. + * Required API Key ACLs: + * - addObject + * - deleteIndex + * - editSettings. + * * @param updateSource - The updateSource object. * @param updateSource.sourceID - The source UUID. * @param updateSource.sourceUpdate - The sourceUpdate object. @@ -1765,7 +1879,6 @@ export function createIngestionClient({ /** * Update the task of the given taskID. * - * @summary Update a task. * @param updateTask - The updateTask object. * @param updateTask.taskID - The task UUID. * @param updateTask.taskUpdate - The taskUpdate object. diff --git a/packages/monitoring/src/monitoringClient.ts b/packages/monitoring/src/monitoringClient.ts index 5ac459f18..ed60da639 100644 --- a/packages/monitoring/src/monitoringClient.ts +++ b/packages/monitoring/src/monitoringClient.ts @@ -107,7 +107,6 @@ export function createMonitoringClient({ /** * 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. @@ -140,7 +139,6 @@ export function createMonitoringClient({ /** * 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. @@ -173,7 +171,6 @@ export function createMonitoringClient({ /** * 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. @@ -208,7 +205,6 @@ export function createMonitoringClient({ /** * 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. @@ -243,7 +239,6 @@ export function createMonitoringClient({ /** * List known incidents for selected clusters. * - * @summary List incidents for selected clusters. * @param getClusterIncidents - The getClusterIncidents object. * @param getClusterIncidents.clusters - Subset of clusters, separated by comma. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -278,7 +273,6 @@ export function createMonitoringClient({ /** * Report whether a cluster is operational. * - * @summary List statuses of selected clusters. * @param getClusterStatus - The getClusterStatus object. * @param getClusterStatus.clusters - Subset of clusters, separated by comma. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -313,7 +307,6 @@ export function createMonitoringClient({ /** * List known incidents for all clusters. * - * @summary List incidents. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getIncidents(requestOptions?: RequestOptions): Promise { @@ -334,7 +327,6 @@ export function createMonitoringClient({ /** * List the average times for indexing operations for selected clusters. * - * @summary Get indexing times. * @param getIndexingTime - The getIndexingTime object. * @param getIndexingTime.clusters - Subset of clusters, separated by comma. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -369,7 +361,6 @@ export function createMonitoringClient({ /** * List the servers belonging to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application\'s cluster. - Without authentication, the response lists the servers for all Algolia clusters. * - * @summary List servers. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getInventory(requestOptions?: RequestOptions): Promise { @@ -390,7 +381,6 @@ export function createMonitoringClient({ /** * List the average latency for search requests for selected clusters. * - * @summary Get search latency times. * @param getLatency - The getLatency object. * @param getLatency.clusters - Subset of clusters, separated by comma. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -425,7 +415,6 @@ export function createMonitoringClient({ /** * Report the aggregate value of a metric for a selected period of time. * - * @summary Get metrics for a given period. * @param getMetrics - The getMetrics object. * @param getMetrics.metric - Metric to report. For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter. * @param getMetrics.period - Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. @@ -466,7 +455,6 @@ export function createMonitoringClient({ /** * Test whether clusters are reachable or not. * - * @summary Test the reachability of clusters. * @param getReachability - The getReachability object. * @param getReachability.clusters - Subset of clusters, separated by comma. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. @@ -501,7 +489,6 @@ export function createMonitoringClient({ /** * Report whether clusters are operational. The response depends on whether you authenticate your API request. - With authentication, the response includes the status of the cluster assigned to your Algolia application. - Without authentication, the response lists the statuses of all public Algolia clusters. * - * @summary List cluster statuses. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ getStatus(requestOptions?: RequestOptions): Promise { diff --git a/packages/recommend/src/recommendClient.ts b/packages/recommend/src/recommendClient.ts index 0f31f54e6..a1a4b46da 100644 --- a/packages/recommend/src/recommendClient.ts +++ b/packages/recommend/src/recommendClient.ts @@ -135,7 +135,6 @@ export function createRecommendClient({ /** * 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 createRecommendClient({ /** * 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 createRecommendClient({ /** * 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 createRecommendClient({ /** * 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 createRecommendClient({ /** * Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). * - * @summary Delete a Recommend rule. + * Required API Key ACLs: + * - editSettings. + * * @param deleteRecommendRule - The deleteRecommendRule object. * @param deleteRecommendRule.indexName - Index on which to perform the request. * @param deleteRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). @@ -321,7 +319,9 @@ export function createRecommendClient({ /** * Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). * - * @summary Get a Recommend rule. + * Required API Key ACLs: + * - settings. + * * @param getRecommendRule - The getRecommendRule object. * @param getRecommendRule.indexName - Index on which to perform the request. * @param getRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). @@ -371,7 +371,9 @@ export function createRecommendClient({ /** * Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task. * - * @summary Get a Recommend task\'s status. + * Required API Key ACLs: + * - editSettings. + * * @param getRecommendStatus - The getRecommendStatus object. * @param getRecommendStatus.indexName - Index on which to perform the request. * @param getRecommendStatus.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). @@ -420,7 +422,9 @@ export function createRecommendClient({ /** * Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values). * - * @summary Get recommendations and trending items. + * Required API Key ACLs: + * - search. + * * @param getRecommendationsParams - The getRecommendationsParams object. * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. */ @@ -460,7 +464,9 @@ export function createRecommendClient({ /** * List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). * - * @summary List Recommend rules. + * Required API Key ACLs: + * - settings. + * * @param searchRecommendRules - The searchRecommendRules object. * @param searchRecommendRules.indexName - Index on which to perform the request. * @param searchRecommendRules.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).