chore: generated code for commit f8cee69. [skip ci]

Co-authored-by: Samuel Bodin <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/api/PersonalizationClient.java

@@ -223,11 +223,11 @@ private Call deleteUserProfileValidateBeforeCall(
   }
 
   /**
-   * Returns, as part of the response, a date until which the data can safely be considered as
-   * deleted for the given user. This means that 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 before for the deletion request to be fully
-   * processed.
+   * 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.
    *
    * @param userToken userToken representing the user for which to fetch the Personalization
    *     profile. (required)
@@ -250,11 +250,11 @@ public DeleteUserProfileResponse deleteUserProfile(String userToken)
   }
 
   /**
-   * (asynchronously) Returns, as part of the response, a date until which the data can safely be
-   * considered as deleted for the given user. This means that 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 before for the deletion request
-   * to be fully processed.
+   * (asynchronously) 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.
    *
    * @param userToken userToken representing the user for which to fetch the Personalization
    *     profile. (required)
@@ -508,10 +508,11 @@ private Call getUserTokenProfileValidateBeforeCall(
   }
 
   /**
-   * 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.
+   * 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.
    *
    * @param userToken userToken representing the user for which to fetch the Personalization
    *     profile. (required)
@@ -534,11 +535,11 @@ public GetUserTokenResponse getUserTokenProfile(String userToken)
   }
 
   /**
-   * (asynchronously) 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.
+   * (asynchronously) 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.
    *
    * @param userToken userToken representing the user for which to fetch the Personalization
    *     profile. (required)

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/api/RecommendClient.java

@@ -358,7 +358,7 @@ private Call getRecommendationsValidateBeforeCall(
   }
 
   /**
-   * Returns recommendations for a specific model and objectID.
+   * Returns recommendations or trending results, for a specific model and `objectID`.
    *
    * @param getRecommendationsParams (required)
    * @return GetRecommendationsResponse
@@ -385,7 +385,8 @@ public GetRecommendationsResponse getRecommendations(
   }
 
   /**
-   * (asynchronously) Returns recommendations for a specific model and objectID.
+   * (asynchronously) Returns recommendations or trending results, for a specific model and
+   * `objectID`.
    *
    * @param getRecommendationsParams (required)
    * @param callback The callback to be executed when the API call finishes

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/personalization/DeleteUserProfileResponse.java

@@ -34,7 +34,7 @@ public DeleteUserProfileResponse setDeletedUntil(String deletedUntil) {
 
   /**
    * A date until which the data can safely be considered as deleted for the given user. Any data
-   * received after the deletedUntil date will start building a new user profile.
+   * received after the `deletedUntil` date will start building a new user profile.
    *
    * @return deletedUntil
    */

clients/algoliasearch-client-javascript/packages/client-personalization/model/deleteUserProfileResponse.ts

@@ -4,7 +4,7 @@ export type DeleteUserProfileResponse = {
    */
   userToken: string;
   /**
-   * A date until which the data can safely be considered as deleted for the given user. Any data received after the deletedUntil date will start building a new user profile.
+   * A date until which the data can safely be considered as deleted for the given user. Any data received after the `deletedUntil` date will start building a new user profile.
    */
   deletedUntil: string;
 };

clients/algoliasearch-client-javascript/packages/client-personalization/src/personalizationClient.ts

@@ -97,9 +97,9 @@ export function createPersonalizationClient(
     },
 
     /**
-     * Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that 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 before for the deletion request to be fully processed.
+     * 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 the user profile and all its associated data.
+     * @summary Delete a user profile.
      * @param deleteUserProfile - The deleteUserProfile object.
      * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
      */
@@ -173,7 +173,7 @@ export function createPersonalizationClient(
     /**
      * The strategy contains information on the events and facets that impact user profiles and personalized search results.
      *
-     * @summary Get the current personalization strategy.
+     * @summary Get the current strategy.
      */
     getPersonalizationStrategy(
       requestOptions?: RequestOptions
@@ -198,9 +198,9 @@ export function createPersonalizationClient(
     },
 
     /**
-     * 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.
+     * 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 the user profile built from Personalization strategy.
+     * @summary Get a user profile.
      * @param getUserTokenProfile - The getUserTokenProfile object.
      * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
      */
@@ -313,7 +313,7 @@ export function createPersonalizationClient(
     /**
      * A strategy defines the events and facets that impact user profiles and personalized search results.
      *
-     * @summary Set a new personalization strategy.
+     * @summary Set a new strategy.
      * @param personalizationStrategyParams - The personalizationStrategyParams object.
      */
     setPersonalizationStrategy(

clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts

@@ -66,7 +66,7 @@ export function createQuerySuggestionsClient(
     /**
      * Create a configuration of a Query Suggestions index. There\'s a limit of 100 configurations per application.
      *
-     * @summary Create a configuration of a Query Suggestions index.
+     * @summary Create a configuration.
      * @param querySuggestionsIndexWithIndexParam - The querySuggestionsIndexWithIndexParam object.
      */
     createConfig(
@@ -137,7 +137,7 @@ export function createQuerySuggestionsClient(
     /**
      * Delete a configuration of a Query Suggestion\'s index. By deleting a configuraton, you stop all updates to the underlying query suggestion index. Note that when doing this, the underlying index does not change - existing suggestions remain untouched.
      *
-     * @summary Delete a configuration of a Query Suggestion\'s index.
+     * @summary Delete a configuration.
      * @param deleteConfig - The deleteConfig object.
      * @param deleteConfig.indexName - The index in which to perform the request.
      */
@@ -211,7 +211,7 @@ export function createQuerySuggestionsClient(
     /**
      * Get all the configurations of Query Suggestions. For each index, you get a block of JSON with a list of its configuration settings.
      *
-     * @summary Get all the configurations of Query Suggestions.
+     * @summary List configurations.
      */
     getAllConfigs(
       requestOptions?: RequestOptions
@@ -238,7 +238,7 @@ export function createQuerySuggestionsClient(
     /**
      * Get the configuration of a single Query Suggestions index.
      *
-     * @summary Get the configuration of a single Query Suggestions index.
+     * @summary Get a single configuration.
      * @param getConfig - The getConfig object.
      * @param getConfig.indexName - The index in which to perform the request.
      */
@@ -277,7 +277,7 @@ export function createQuerySuggestionsClient(
     /**
      * Get the status of a Query Suggestion\'s index. The status includes whether the Query Suggestions index is currently in the process of being built, and the last build time.
      *
-     * @summary Get the status of a Query Suggestion\'s index.
+     * @summary Get configuration status.
      * @param getConfigStatus - The getConfigStatus object.
      * @param getConfigStatus.indexName - The index in which to perform the request.
      */
@@ -316,7 +316,7 @@ export function createQuerySuggestionsClient(
     /**
      * Get the log file of the last build of a single Query Suggestion index.
      *
-     * @summary Get the log file of the last build of a single Query Suggestion index.
+     * @summary Get a log file.
      * @param getLogFile - The getLogFile object.
      * @param getLogFile.indexName - The index in which to perform the request.
      */
@@ -429,7 +429,7 @@ export function createQuerySuggestionsClient(
     /**
      * Update the configuration of a Query Suggestions index.
      *
-     * @summary Update the configuration of a Query Suggestions index.
+     * @summary Update a configuration.
      * @param updateConfig - The updateConfig object.
      * @param updateConfig.indexName - The index in which to perform the request.
      * @param updateConfig.querySuggestionsIndexParam - The querySuggestionsIndexParam object.

clients/algoliasearch-client-javascript/packages/client-sources/src/sourcesClient.ts

@@ -166,7 +166,7 @@ export function createSourcesClient(
     /**
      * Add an ingestion job that will fetch data from an URL.
      *
-     * @summary Create a new ingestion job via URL.
+     * @summary Create fetch URL job.
      * @param postURLJob - The postURLJob object.
      */
     postIngestUrl(

clients/algoliasearch-client-javascript/packages/recommend/src/recommendClient.ts

@@ -153,9 +153,9 @@ export function createRecommendClient(options: CreateClientOptions) {
     },
 
     /**
-     * Returns recommendations for a specific model and objectID.
+     * Returns recommendations or trending results, for a specific model and `objectID`.
      *
-     * @summary Returns recommendations for a specific model and objectID.
+     * @summary Get results.
      * @param getRecommendationsParams - The getRecommendationsParams object.
      */
     getRecommendations(

clients/algoliasearch-client-php/lib/Api/PersonalizationClient.php

@@ -143,7 +143,7 @@ public function del($path, $parameters = null)
     }
 
     /**
-     * Delete the user profile and all its associated data.
+     * Delete a user profile.
      *
      * @param string $userToken userToken representing the user for which to fetch the Personalization profile. (required)
      *
@@ -227,7 +227,7 @@ public function get($path, $parameters = null)
     }
 
     /**
-     * Get the current personalization strategy.
+     * Get the current strategy.
      *
      *
      * @return array<string, mixed>|\Algolia\AlgoliaSearch\Model\Personalization\PersonalizationStrategyParams
@@ -247,7 +247,7 @@ public function getPersonalizationStrategy()
     }
 
     /**
-     * Get the user profile built from Personalization strategy.
+     * Get a user profile.
      *
      * @param string $userToken userToken representing the user for which to fetch the Personalization profile. (required)
      *
@@ -385,7 +385,7 @@ public function put($path, $parameters = null, $body = null)
     }
 
     /**
-     * Set a new personalization strategy.
+     * Set a new strategy.
      *
      * @param array $personalizationStrategyParams personalizationStrategyParams (required)
      * - $personalizationStrategyParams['eventScoring'] => (array) Scores associated with the events. (required)

clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php

@@ -99,7 +99,7 @@ public function getClientConfig()
     }
 
     /**
-     * Create a configuration of a Query Suggestions index.
+     * Create a configuration.
      *
      * @param array $querySuggestionsIndexWithIndexParam querySuggestionsIndexWithIndexParam (required)
      *
@@ -181,7 +181,7 @@ public function del($path, $parameters = null)
     }
 
     /**
-     * Delete a configuration of a Query Suggestion's index.
+     * Delete a configuration.
      *
      * @param string $indexName The index in which to perform the request. (required)
      *
@@ -265,7 +265,7 @@ public function get($path, $parameters = null)
     }
 
     /**
-     * Get all the configurations of Query Suggestions.
+     * List configurations.
      *
      *
      * @return array<string, mixed>|\Algolia\AlgoliaSearch\Model\QuerySuggestions\QuerySuggestionsIndex[]
@@ -285,7 +285,7 @@ public function getAllConfigs()
     }
 
     /**
-     * Get the configuration of a single Query Suggestions index.
+     * Get a single configuration.
      *
      * @param string $indexName The index in which to perform the request. (required)
      *
@@ -325,7 +325,7 @@ public function getConfig($indexName)
     }
 
     /**
-     * Get the status of a Query Suggestion&#39;s index.
+     * Get configuration status.
      *
      * @param string $indexName The index in which to perform the request. (required)
      *
@@ -365,7 +365,7 @@ public function getConfigStatus($indexName)
     }
 
     /**
-     * Get the log file of the last build of a single Query Suggestion index.
+     * Get a log file.
      *
      * @param string $indexName The index in which to perform the request. (required)
      *
@@ -503,7 +503,7 @@ public function put($path, $parameters = null, $body = null)
     }
 
     /**
-     * Update the configuration of a Query Suggestions index.
+     * Update a configuration.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param array $querySuggestionsIndexParam querySuggestionsIndexParam (required)

clients/algoliasearch-client-php/lib/Api/RecommendClient.php

@@ -186,7 +186,7 @@ public function get($path, $parameters = null)
     }
 
     /**
-     * Returns recommendations for a specific model and objectID.
+     * Get results.
      *
      * @param array $getRecommendationsParams getRecommendationsParams (required)
      * - $getRecommendationsParams['requests'] => (array) The `getRecommendations` requests. (required)

clients/algoliasearch-client-php/lib/Model/Personalization/DeleteUserProfileResponse.php

@@ -188,7 +188,7 @@ public function getDeletedUntil()
     /**
      * Sets deletedUntil
      *
-     * @param string $deletedUntil A date until which the data can safely be considered as deleted for the given user. Any data received after the deletedUntil date will start building a new user profile.
+     * @param string $deletedUntil A date until which the data can safely be considered as deleted for the given user. Any data received after the `deletedUntil` date will start building a new user profile.
      *
      * @return self
      */