chore: generated code for commit 0f8d4432. [skip ci]

algolia/api-clients-automation@0f8d443 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]> Co-authored-by: shortcuts <[email protected]>
algolia · Mar 13, 2024 · 21830b8 · 21830b8
1 parent d91c9ef
commit 21830b8
Show file tree

Hide file tree

Showing 18 changed files with 192 additions and 137 deletions.
diff --git a/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java b/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java
@@ -479,11 +479,11 @@ public CompletableFuture<Object> customPutAsync(@Nonnull String path) throws Alg
   }
 
   /**
-   * 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).
+   * Deletes all events related to the specified user token from events metrics and analytics. To
+   * delete a personalization user profile, see [Delete a user
+   * profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
-   * @param userToken The user token for which to delete all associated events. (required)
+   * @param userToken User token for which to delete all associated events. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -494,23 +494,23 @@ public void deleteUserToken(@Nonnull String userToken, RequestOptions requestOpt
   }
 
   /**
-   * 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).
+   * Deletes all events related to the specified user token from events metrics and analytics. To
+   * delete a personalization user profile, see [Delete a user
+   * profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
-   * @param userToken The user token for which to delete all associated events. (required)
+   * @param userToken User token for which to delete all associated events. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public void deleteUserToken(@Nonnull String userToken) throws AlgoliaRuntimeException {
     this.deleteUserToken(userToken, null);
   }
 
   /**
-   * (asynchronously) Delete all events related to a certain user token from events metrics and
+   * (asynchronously) Deletes all events related to the specified 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).
+   * profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
-   * @param userToken The user token for which to delete all associated events. (required)
+   * @param userToken User token for which to delete all associated events. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -524,19 +524,19 @@ public CompletableFuture<Void> deleteUserTokenAsync(@Nonnull String userToken, R
   }
 
   /**
-   * (asynchronously) Delete all events related to a certain user token from events metrics and
+   * (asynchronously) Deletes all events related to the specified 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).
+   * profile](/specs/personalization#tag/profiles/operation/deleteUserProfile).
    *
-   * @param userToken The user token for which to delete all associated events. (required)
+   * @param userToken User token for which to delete all associated events. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<Void> deleteUserTokenAsync(@Nonnull String userToken) throws AlgoliaRuntimeException {
     return this.deleteUserTokenAsync(userToken, null);
   }
 
   /**
-   * Send a list of events to the Insights API. You can include up to 1,000 events in a single
+   * Sends a list of events to the Insights API. You can include up to 1,000 events in a single
    * request, but the request body must be smaller than 2&nbsp;MB.
    *
    * @param insightsEvents (required)
@@ -549,7 +549,7 @@ public EventsResponse pushEvents(@Nonnull InsightsEvents insightsEvents, Request
   }
 
   /**
-   * Send a list of events to the Insights API. You can include up to 1,000 events in a single
+   * Sends a list of events to the Insights API. You can include up to 1,000 events in a single
    * request, but the request body must be smaller than 2&nbsp;MB.
    *
    * @param insightsEvents (required)
@@ -560,7 +560,7 @@ public EventsResponse pushEvents(@Nonnull InsightsEvents insightsEvents) throws
   }
 
   /**
-   * (asynchronously) Send a list of events to the Insights API. You can include up to 1,000 events
+   * (asynchronously) Sends a list of events to the Insights API. You can include up to 1,000 events
    * in a single request, but the request body must be smaller than 2&nbsp;MB.
    *
    * @param insightsEvents (required)
@@ -577,7 +577,7 @@ public CompletableFuture<EventsResponse> pushEventsAsync(@Nonnull InsightsEvents
   }
 
   /**
-   * (asynchronously) Send a list of events to the Insights API. You can include up to 1,000 events
+   * (asynchronously) Sends a list of events to the Insights API. You can include up to 1,000 events
    * in a single request, but the request body must be smaller than 2&nbsp;MB.
    *
    * @param insightsEvents (required)

diff --git a/algoliasearch/src/main/java/com/algolia/model/insights/AddedToCartObjectIDs.java b/algoliasearch/src/main/java/com/algolia/model/insights/AddedToCartObjectIDs.java
@@ -57,8 +57,8 @@ public AddedToCartObjectIDs setEventName(String eventName) {
   }
 
   /**
-   * The name of the event, up to 64 ASCII characters. Consider naming events consistently—for
-   * example, by adopting Segment's
+   * Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by
+   * adopting Segment's
    * [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
    * framework.
    */
@@ -94,7 +94,7 @@ public AddedToCartObjectIDs setIndex(String index) {
     return this;
   }
 
-  /** The name of an Algolia index. */
+  /** Index name to which the event's items belong. */
   @javax.annotation.Nonnull
   public String getIndex() {
     return index;
@@ -110,7 +110,7 @@ public AddedToCartObjectIDs addObjectIDs(String objectIDsItem) {
     return this;
   }
 
-  /** The object IDs of the records that are part of the event. */
+  /** Object IDs of the records that are part of the event. */
   @javax.annotation.Nonnull
   public List<String> getObjectIDs() {
     return objectIDs;
@@ -122,8 +122,9 @@ public AddedToCartObjectIDs setUserToken(String userToken) {
   }
 
   /**
-   * An anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Anonymous or pseudonymous user identifier. Don't use personally identifiable information in
+   * user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nonnull
   public String getUserToken() {
@@ -136,8 +137,11 @@ public AddedToCartObjectIDs setAuthenticatedUserToken(String authenticatedUserTo
   }
 
   /**
-   * An identifier for authenticated users. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Identifier for authenticated users. When the user signs in, you can get an identifier from your
+   * system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from
+   * before the user signed in, while providing a reliable way to identify users across sessions.
+   * Don't use personally identifiable information in user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nullable
   public String getAuthenticatedUserToken() {
@@ -183,7 +187,7 @@ public AddedToCartObjectIDs setTimestamp(Long timestamp) {
   }
 
   /**
-   * The timestamp of the event in milliseconds in [Unix epoch
+   * Timestamp of the event in milliseconds in [Unix epoch
    * time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it
    * receives an event as its timestamp.
    */

diff --git a/algoliasearch/src/main/java/com/algolia/model/insights/AddedToCartObjectIDsAfterSearch.java b/algoliasearch/src/main/java/com/algolia/model/insights/AddedToCartObjectIDsAfterSearch.java
@@ -58,8 +58,8 @@ public AddedToCartObjectIDsAfterSearch setEventName(String eventName) {
   }
 
   /**
-   * The name of the event, up to 64 ASCII characters. Consider naming events consistently—for
-   * example, by adopting Segment's
+   * Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by
+   * adopting Segment's
    * [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
    * framework.
    */
@@ -95,7 +95,7 @@ public AddedToCartObjectIDsAfterSearch setIndex(String index) {
     return this;
   }
 
-  /** The name of an Algolia index. */
+  /** Index name to which the event's items belong. */
   @javax.annotation.Nonnull
   public String getIndex() {
     return index;
@@ -126,7 +126,7 @@ public AddedToCartObjectIDsAfterSearch addObjectIDs(String objectIDsItem) {
     return this;
   }
 
-  /** The object IDs of the records that are part of the event. */
+  /** Object IDs of the records that are part of the event. */
   @javax.annotation.Nonnull
   public List<String> getObjectIDs() {
     return objectIDs;
@@ -138,8 +138,9 @@ public AddedToCartObjectIDsAfterSearch setUserToken(String userToken) {
   }
 
   /**
-   * An anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Anonymous or pseudonymous user identifier. Don't use personally identifiable information in
+   * user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nonnull
   public String getUserToken() {
@@ -152,8 +153,11 @@ public AddedToCartObjectIDsAfterSearch setAuthenticatedUserToken(String authenti
   }
 
   /**
-   * An identifier for authenticated users. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Identifier for authenticated users. When the user signs in, you can get an identifier from your
+   * system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from
+   * before the user signed in, while providing a reliable way to identify users across sessions.
+   * Don't use personally identifiable information in user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nullable
   public String getAuthenticatedUserToken() {
@@ -199,7 +203,7 @@ public AddedToCartObjectIDsAfterSearch setTimestamp(Long timestamp) {
   }
 
   /**
-   * The timestamp of the event in milliseconds in [Unix epoch
+   * Timestamp of the event in milliseconds in [Unix epoch
    * time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it
    * receives an event as its timestamp.
    */

diff --git a/algoliasearch/src/main/java/com/algolia/model/insights/ClickedFilters.java b/algoliasearch/src/main/java/com/algolia/model/insights/ClickedFilters.java
@@ -40,8 +40,8 @@ public ClickedFilters setEventName(String eventName) {
   }
 
   /**
-   * The name of the event, up to 64 ASCII characters. Consider naming events consistently—for
-   * example, by adopting Segment's
+   * Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by
+   * adopting Segment's
    * [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
    * framework.
    */
@@ -66,7 +66,7 @@ public ClickedFilters setIndex(String index) {
     return this;
   }
 
-  /** The name of an Algolia index. */
+  /** Index name to which the event's items belong. */
   @javax.annotation.Nonnull
   public String getIndex() {
     return index;
@@ -82,7 +82,10 @@ public ClickedFilters addFilters(String filtersItem) {
     return this;
   }
 
-  /** Facet filters. Each facet filter string must be URL-encoded, such as, `discount:10%25`. */
+  /**
+   * Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded,
+   * such as, `discount:10%25`.
+   */
   @javax.annotation.Nonnull
   public List<String> getFilters() {
     return filters;
@@ -94,8 +97,9 @@ public ClickedFilters setUserToken(String userToken) {
   }
 
   /**
-   * An anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Anonymous or pseudonymous user identifier. Don't use personally identifiable information in
+   * user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nonnull
   public String getUserToken() {
@@ -108,8 +112,11 @@ public ClickedFilters setAuthenticatedUserToken(String authenticatedUserToken) {
   }
 
   /**
-   * An identifier for authenticated users. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Identifier for authenticated users. When the user signs in, you can get an identifier from your
+   * system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from
+   * before the user signed in, while providing a reliable way to identify users across sessions.
+   * Don't use personally identifiable information in user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nullable
   public String getAuthenticatedUserToken() {
@@ -122,7 +129,7 @@ public ClickedFilters setTimestamp(Long timestamp) {
   }
 
   /**
-   * The timestamp of the event in milliseconds in [Unix epoch
+   * Timestamp of the event in milliseconds in [Unix epoch
    * time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it
    * receives an event as its timestamp.
    */

diff --git a/algoliasearch/src/main/java/com/algolia/model/insights/ClickedObjectIDs.java b/algoliasearch/src/main/java/com/algolia/model/insights/ClickedObjectIDs.java
@@ -44,8 +44,8 @@ public ClickedObjectIDs setEventName(String eventName) {
   }
 
   /**
-   * The name of the event, up to 64 ASCII characters. Consider naming events consistently—for
-   * example, by adopting Segment's
+   * Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by
+   * adopting Segment's
    * [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
    * framework.
    */
@@ -70,7 +70,7 @@ public ClickedObjectIDs setIndex(String index) {
     return this;
   }
 
-  /** The name of an Algolia index. */
+  /** Index name to which the event's items belong. */
   @javax.annotation.Nonnull
   public String getIndex() {
     return index;
@@ -86,7 +86,7 @@ public ClickedObjectIDs addObjectIDs(String objectIDsItem) {
     return this;
   }
 
-  /** The object IDs of the records that are part of the event. */
+  /** Object IDs of the records that are part of the event. */
   @javax.annotation.Nonnull
   public List<String> getObjectIDs() {
     return objectIDs;
@@ -98,8 +98,9 @@ public ClickedObjectIDs setUserToken(String userToken) {
   }
 
   /**
-   * An anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Anonymous or pseudonymous user identifier. Don't use personally identifiable information in
+   * user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nonnull
   public String getUserToken() {
@@ -112,8 +113,11 @@ public ClickedObjectIDs setAuthenticatedUserToken(String authenticatedUserToken)
   }
 
   /**
-   * An identifier for authenticated users. > **Note**: Never include personally identifiable
-   * information in user tokens.
+   * Identifier for authenticated users. When the user signs in, you can get an identifier from your
+   * system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from
+   * before the user signed in, while providing a reliable way to identify users across sessions.
+   * Don't use personally identifiable information in user tokens. For more information, see [User
+   * token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   @javax.annotation.Nullable
   public String getAuthenticatedUserToken() {
@@ -126,7 +130,7 @@ public ClickedObjectIDs setTimestamp(Long timestamp) {
   }
 
   /**
-   * The timestamp of the event in milliseconds in [Unix epoch
+   * Timestamp of the event in milliseconds in [Unix epoch
    * time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it
    * receives an event as its timestamp.
    */