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

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

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

@@ -312,7 +312,7 @@ private Call deleteABTestValidateBeforeCall(
   }
 
   /**
-   * Deletes the A/B Test and removes all associated metadata & metrics.
+   * Delete a test.
    *
    * @param id The A/B test ID. (required)
    * @return ABTestResponse
@@ -332,7 +332,7 @@ public ABTestResponse deleteABTest(Integer id)
   }
 
   /**
-   * (asynchronously) Deletes the A/B Test and removes all associated metadata & metrics.
+   * (asynchronously) Delete a test.
    *
    * @param id The A/B test ID. (required)
    * @param callback The callback to be executed when the API call finishes
@@ -503,8 +503,7 @@ private Call getABTestValidateBeforeCall(
   }
 
   /**
-   * Returns metadata and metrics for A/B test id. Behaves in the same way as GET /2/abtests however
-   * the endpoint will return 403.
+   * Returns metadata and metrics for an A/B test.
    *
    * @param id The A/B test ID. (required)
    * @return ABTest
@@ -523,8 +522,7 @@ public ABTest getABTest(Integer id) throws AlgoliaRuntimeException {
   }
 
   /**
-   * (asynchronously) Returns metadata and metrics for A/B test id. Behaves in the same way as GET
-   * /2/abtests however the endpoint will return 403.
+   * (asynchronously) Returns metadata and metrics for an A/B test.
    *
    * @param id The A/B test ID. (required)
    * @param callback The callback to be executed when the API call finishes
@@ -590,9 +588,8 @@ private Call listABTestsValidateBeforeCall(
   }
 
   /**
-   * Fetch all existing A/B tests for App that are available for the current API Key. Returns an
-   * array of metadata and metrics. When no data has been processed, the metrics will be returned as
-   * null.
+   * Fetch all existing A/B tests for App that are available for the current API Key. When no data
+   * has been processed, the metrics will be returned as null.
    *
    * @param offset Position of the starting record. Used for paging. 0 is the first record.
    *     (optional, default to 0)
@@ -620,8 +617,7 @@ public ListABTestsResponse listABTests() throws AlgoliaRuntimeException {
 
   /**
    * (asynchronously) Fetch all existing A/B tests for App that are available for the current API
-   * Key. Returns an array of metadata and metrics. When no data has been processed, the metrics
-   * will be returned as null.
+   * Key. When no data has been processed, the metrics will be returned as null.
    *
    * @param offset Position of the starting record. Used for paging. 0 is the first record.
    *     (optional, default to 0)

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

@@ -503,7 +503,9 @@ private Call getClickPositionsValidateBeforeCall(
   }
 
   /**
-   * Returns the distribution of clicks per range of positions.
+   * Returns the distribution of clicks per range of positions. If the groups all have a count of 0,
+   * it means Algolia didn’t receive any click events for the queries with the clickAnalytics search
+   * parameter set to true. The count is 0 until Algolia receives at least one click event.
    *
    * @param index The index name to target. (required)
    * @param startDate The lower bound timestamp (a date, a string like \"2006-01-02\") of the period
@@ -547,7 +549,10 @@ public GetClickPositionsResponse getClickPositions(String index)
   }
 
   /**
-   * (asynchronously) Returns the distribution of clicks per range of positions.
+   * (asynchronously) Returns the distribution of clicks per range of positions. If the groups all
+   * have a count of 0, it means Algolia didn’t receive any click events for the queries with the
+   * clickAnalytics search parameter set to true. The count is 0 until Algolia receives at least one
+   * click event.
    *
    * @param index The index name to target. (required)
    * @param startDate The lower bound timestamp (a date, a string like \"2006-01-02\") of the period

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

@@ -432,7 +432,14 @@ private Call pushEventsValidateBeforeCall(
   }
 
   /**
-   * This command pushes an array of events.
+   * This command pushes an array of events. An event is - an action: `eventName` - performed in a
+   * context: `eventType` - at some point in time provided: `timestamp` - by an end user:
+   * `userToken` - on something: `index` Notes: - To be accepted, all events sent must be valid. -
+   * The size of the body must be *less than 2 MB*. - When an event is tied to an Algolia search, it
+   * must also provide a `queryID`. If that event is a `click`, their absolute `positions` should
+   * also be passed. - We consider that an `index` provides access to 2 resources: objects and
+   * filters. An event can only interact with a single resource type, but not necessarily on a
+   * single item. As such an event will accept an array of `objectIDs` or `filters`.
    *
    * @param insightEvents (required)
    * @return PushEventsResponse
@@ -452,7 +459,16 @@ public PushEventsResponse pushEvents(InsightEvents insightEvents)
   }
 
   /**
-   * (asynchronously) This command pushes an array of events.
+   * (asynchronously) This command pushes an array of events. An event is - an action:
+   * `eventName` - performed in a context: `eventType` - at some point in time
+   * provided: `timestamp` - by an end user: `userToken` - on something:
+   * `index` Notes: - To be accepted, all events sent must be valid. - The size of the
+   * body must be *less than 2 MB*. - When an event is tied to an Algolia search, it must also
+   * provide a `queryID`. If that event is a `click`, their absolute
+   * `positions` should also be passed. - We consider that an `index` provides
+   * access to 2 resources: objects and filters. An event can only interact with a single resource
+   * type, but not necessarily on a single item. As such an event will accept an array of
+   * `objectIDs` or `filters`.
    *
    * @param insightEvents (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/analytics/GetClickPositionsResponsePositions.java

@@ -29,9 +29,9 @@ public GetClickPositionsResponsePositions addPositionItem(
   }
 
   /**
-   * Range of positions with the following pattern: Positions from 1 to 10 included are displayed in
-   * separated groups. Positions from 11 to 20 included are grouped together. Positions from 21 and
-   * up are grouped together.
+   * Range of positions with the following pattern: - Positions from 1 to 10 included are displayed
+   * in separated groups. - Positions from 11 to 20 included are grouped together. - Positions from
+   * 21 and up are grouped together.
    *
    * @return position
    */

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/insights/EventType.java

@@ -6,7 +6,7 @@
 import com.google.gson.stream.JsonWriter;
 import java.io.IOException;
 
-/** An eventType can be a click, a conversion, or a view. */
+/** Gets or Sets eventType */
 @JsonAdapter(EventType.Adapter.class)
 public enum EventType {
   CLICK("click"),

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/insights/InsightEvent.java

@@ -87,7 +87,8 @@ public InsightEvent setUserToken(String userToken) {
 
   /**
    * A user identifier. Depending if the user is logged-in or not, several strategies can be used
-   * from a sessionId to a technical identifier.
+   * from a sessionId to a technical identifier. You should always send pseudonymous or anonymous
+   * userTokens.
    *
    * @return userToken
    */

clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingClient.ts

@@ -67,7 +67,7 @@ export function createAbtestingClient(
     /**
      * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
      *
-     * @summary Creates a new A/B test with provided configuration.
+     * @summary Create a test.
      * @param addABTestsRequest - The addABTestsRequest object.
      */
     addABTests(
@@ -152,9 +152,9 @@ export function createAbtestingClient(
     },
 
     /**
-     * Deletes the A/B Test and removes all associated metadata & metrics.
+     * Delete a test.
      *
-     * @summary Deletes the A/B Test.
+     * @summary Delete a test.
      * @param deleteABTest - The deleteABTest object.
      * @param deleteABTest.id - The A/B test ID.
      */
@@ -226,9 +226,9 @@ export function createAbtestingClient(
     },
 
     /**
-     * Returns metadata and metrics for A/B test id. Behaves in the same way as GET /2/abtests however the endpoint will return 403.
+     * Returns metadata and metrics for an A/B test.
      *
-     * @summary Returns metadata and metrics for A/B test id.
+     * @summary Get a test.
      * @param getABTest - The getABTest object.
      * @param getABTest.id - The A/B test ID.
      */
@@ -263,9 +263,9 @@ export function createAbtestingClient(
     },
 
     /**
-     * Fetch all existing A/B tests for App that are available for the current API Key. Returns an array of metadata and metrics. When no data has been processed, the metrics will be returned as null.
+     * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
      *
-     * @summary Fetch all existing A/B tests for App that are available for the current API Key.
+     * @summary List all tests.
      * @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. Limit is the size of the page.
@@ -378,7 +378,7 @@ export function createAbtestingClient(
     /**
      * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
      *
-     * @summary Marks the A/B test as stopped.
+     * @summary Stop a test.
      * @param stopABTest - The stopABTest object.
      * @param stopABTest.id - The A/B test ID.
      */

clients/algoliasearch-client-javascript/packages/client-analytics/model/getClickPositionsResponsePositions.ts

@@ -1,6 +1,6 @@
 export type GetClickPositionsResponsePositions = {
   /**
-   * Range of positions with the following pattern: Positions from 1 to 10 included are displayed in separated groups. Positions from 11 to 20 included are grouped together. Positions from 21 and up are grouped together.
+   * Range of positions with the following pattern: - Positions from 1 to 10 included are displayed in separated groups. - Positions from 11 to 20 included are grouped together. - Positions from 21 and up are grouped together.
    */
   position: number[];
   /**