Merge branch 'main' into docs/API-530/remaining-php-doc

Author: damcou

.eslintrc.js

@@ -101,8 +101,9 @@ module.exports = {
         'no-continue': 0,
         '@typescript-eslint/prefer-enum-initializers': 0,
 
-        '@typescript-eslint/no-unused-vars': 2,
         'unused-imports/no-unused-imports-ts': 2,
+        '@typescript-eslint/no-unused-vars': 2,
+        '@typescript-eslint/consistent-indexed-object-style': 2,
         '@typescript-eslint/member-ordering': [
           'error',
           {

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

@@ -1738,7 +1738,7 @@ public CompletableFuture<Map<String, String>> getObjectAsync(String indexName, S
   /**
    * Retrieve one or more objects, potentially from different indices, in a single API call.
    *
-   * @param getObjectsParams (required)
+   * @param getObjectsParams The Algolia object. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return GetObjectsResponse
@@ -1757,7 +1757,7 @@ public GetObjectsResponse getObjects(GetObjectsParams getObjectsParams) throws A
    * (asynchronously) Retrieve one or more objects, potentially from different indices, in a single
    * API call.
    *
-   * @param getObjectsParams (required)
+   * @param getObjectsParams The Algolia object. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return The awaitable future
@@ -3551,7 +3551,7 @@ public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(String indexName,
   /**
    * Perform a search operation targeting one or many indices.
    *
-   * @param searchMethodParams (required)
+   * @param searchMethodParams The `search` requests and strategy. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return SearchResponses
@@ -3569,7 +3569,7 @@ public SearchResponses search(SearchMethodParams searchMethodParams) throws Algo
   /**
    * (asynchronously) Perform a search operation targeting one or many indices.
    *
-   * @param searchMethodParams (required)
+   * @param searchMethodParams The `search` requests and strategy. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return The awaitable future

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/abtesting/ABTest.java

@@ -1,7 +1,6 @@
 package com.algolia.model.abtesting;
 
 import com.google.gson.annotations.SerializedName;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
@@ -30,7 +29,7 @@ public class ABTest {
   private String status;
 
   @SerializedName("variants")
-  private List<Variant> variants = new ArrayList<>();
+  private List<Variant> variants;
 
   public ABTest setAbTestID(Integer abTestID) {
     this.abTestID = abTestID;

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/abtesting/AddABTestsRequest.java

@@ -1,7 +1,6 @@
 package com.algolia.model.abtesting;
 
 import com.google.gson.annotations.SerializedName;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
@@ -12,7 +11,7 @@ public class AddABTestsRequest {
   private String name;
 
   @SerializedName("variant")
-  private List<AddABTestsVariant> variant = new ArrayList<>();
+  private List<AddABTestsVariant> variant;
 
   @SerializedName("endAt")
   private String endAt;

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/abtesting/ListABTestsResponse.java

@@ -1,15 +1,14 @@
 package com.algolia.model.abtesting;
 
 import com.google.gson.annotations.SerializedName;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
 /** ListABTestsResponse */
 public class ListABTestsResponse {
 
   @SerializedName("abtests")
-  private List<ABTest> abtests = new ArrayList<>();
+  private List<ABTest> abtests;
 
   @SerializedName("count")
   private Integer count;

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/GetAverageClickPositionResponseDates.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/AverageClickEvent.java

@@ -3,8 +3,8 @@
 import com.google.gson.annotations.SerializedName;
 import java.util.Objects;
 
-/** GetAverageClickPositionResponseDates */
-public class GetAverageClickPositionResponseDates {
+/** AverageClickEvent */
+public class AverageClickEvent {
 
   @SerializedName("average")
   private Double average;
@@ -15,7 +15,7 @@ public class GetAverageClickPositionResponseDates {
   @SerializedName("date")
   private String date;
 
-  public GetAverageClickPositionResponseDates setAverage(Double average) {
+  public AverageClickEvent setAverage(Double average) {
     this.average = average;
     return this;
   }
@@ -30,7 +30,7 @@ public Double getAverage() {
     return average;
   }
 
-  public GetAverageClickPositionResponseDates setClickCount(Integer clickCount) {
+  public AverageClickEvent setClickCount(Integer clickCount) {
     this.clickCount = clickCount;
     return this;
   }
@@ -45,7 +45,7 @@ public Integer getClickCount() {
     return clickCount;
   }
 
-  public GetAverageClickPositionResponseDates setDate(String date) {
+  public AverageClickEvent setDate(String date) {
     this.date = date;
     return this;
   }
@@ -68,11 +68,11 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
-    GetAverageClickPositionResponseDates getAverageClickPositionResponseDates = (GetAverageClickPositionResponseDates) o;
+    AverageClickEvent averageClickEvent = (AverageClickEvent) o;
     return (
-      Objects.equals(this.average, getAverageClickPositionResponseDates.average) &&
-      Objects.equals(this.clickCount, getAverageClickPositionResponseDates.clickCount) &&
-      Objects.equals(this.date, getAverageClickPositionResponseDates.date)
+      Objects.equals(this.average, averageClickEvent.average) &&
+      Objects.equals(this.clickCount, averageClickEvent.clickCount) &&
+      Objects.equals(this.date, averageClickEvent.date)
     );
   }
 
@@ -84,7 +84,7 @@ public int hashCode() {
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
-    sb.append("class GetAverageClickPositionResponseDates {\n");
+    sb.append("class AverageClickEvent {\n");
     sb.append("    average: ").append(toIndentedString(average)).append("\n");
     sb.append("    clickCount: ").append(toIndentedString(clickCount)).append("\n");
     sb.append("    date: ").append(toIndentedString(date)).append("\n");

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/GetClickPositionsResponsePositions.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/ClickPosition.java

@@ -1,25 +1,24 @@
 package com.algolia.model.analytics;
 
 import com.google.gson.annotations.SerializedName;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
-/** GetClickPositionsResponsePositions */
-public class GetClickPositionsResponsePositions {
+/** ClickPosition */
+public class ClickPosition {
 
   @SerializedName("position")
-  private List<Integer> position = new ArrayList<>();
+  private List<Integer> position;
 
   @SerializedName("clickCount")
   private Integer clickCount;
 
-  public GetClickPositionsResponsePositions setPosition(List<Integer> position) {
+  public ClickPosition setPosition(List<Integer> position) {
     this.position = position;
     return this;
   }
 
-  public GetClickPositionsResponsePositions addPosition(Integer positionItem) {
+  public ClickPosition addPosition(Integer positionItem) {
     this.position.add(positionItem);
     return this;
   }
@@ -36,7 +35,7 @@ public List<Integer> getPosition() {
     return position;
   }
 
-  public GetClickPositionsResponsePositions setClickCount(Integer clickCount) {
+  public ClickPosition setClickCount(Integer clickCount) {
     this.clickCount = clickCount;
     return this;
   }
@@ -59,11 +58,8 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
-    GetClickPositionsResponsePositions getClickPositionsResponsePositions = (GetClickPositionsResponsePositions) o;
-    return (
-      Objects.equals(this.position, getClickPositionsResponsePositions.position) &&
-      Objects.equals(this.clickCount, getClickPositionsResponsePositions.clickCount)
-    );
+    ClickPosition clickPosition = (ClickPosition) o;
+    return Objects.equals(this.position, clickPosition.position) && Objects.equals(this.clickCount, clickPosition.clickCount);
   }
 
   @Override
@@ -74,7 +70,7 @@ public int hashCode() {
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
-    sb.append("class GetClickPositionsResponsePositions {\n");
+    sb.append("class ClickPosition {\n");
     sb.append("    position: ").append(toIndentedString(position)).append("\n");
     sb.append("    clickCount: ").append(toIndentedString(clickCount)).append("\n");
     sb.append("}");

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/GetClickThroughRateResponseDates.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/ClickThroughRateEvent.java

@@ -3,8 +3,8 @@
 import com.google.gson.annotations.SerializedName;
 import java.util.Objects;
 
-/** GetClickThroughRateResponseDates */
-public class GetClickThroughRateResponseDates {
+/** ClickThroughRateEvent */
+public class ClickThroughRateEvent {
 
   @SerializedName("rate")
   private Double rate;
@@ -18,7 +18,7 @@ public class GetClickThroughRateResponseDates {
   @SerializedName("date")
   private String date;
 
-  public GetClickThroughRateResponseDates setRate(Double rate) {
+  public ClickThroughRateEvent setRate(Double rate) {
     this.rate = rate;
     return this;
   }
@@ -33,7 +33,7 @@ public Double getRate() {
     return rate;
   }
 
-  public GetClickThroughRateResponseDates setClickCount(Integer clickCount) {
+  public ClickThroughRateEvent setClickCount(Integer clickCount) {
     this.clickCount = clickCount;
     return this;
   }
@@ -48,7 +48,7 @@ public Integer getClickCount() {
     return clickCount;
   }
 
-  public GetClickThroughRateResponseDates setTrackedSearchCount(Integer trackedSearchCount) {
+  public ClickThroughRateEvent setTrackedSearchCount(Integer trackedSearchCount) {
     this.trackedSearchCount = trackedSearchCount;
     return this;
   }
@@ -63,7 +63,7 @@ public Integer getTrackedSearchCount() {
     return trackedSearchCount;
   }
 
-  public GetClickThroughRateResponseDates setDate(String date) {
+  public ClickThroughRateEvent setDate(String date) {
     this.date = date;
     return this;
   }
@@ -86,12 +86,12 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
-    GetClickThroughRateResponseDates getClickThroughRateResponseDates = (GetClickThroughRateResponseDates) o;
+    ClickThroughRateEvent clickThroughRateEvent = (ClickThroughRateEvent) o;
     return (
-      Objects.equals(this.rate, getClickThroughRateResponseDates.rate) &&
-      Objects.equals(this.clickCount, getClickThroughRateResponseDates.clickCount) &&
-      Objects.equals(this.trackedSearchCount, getClickThroughRateResponseDates.trackedSearchCount) &&
-      Objects.equals(this.date, getClickThroughRateResponseDates.date)
+      Objects.equals(this.rate, clickThroughRateEvent.rate) &&
+      Objects.equals(this.clickCount, clickThroughRateEvent.clickCount) &&
+      Objects.equals(this.trackedSearchCount, clickThroughRateEvent.trackedSearchCount) &&
+      Objects.equals(this.date, clickThroughRateEvent.date)
     );
   }
 
@@ -103,7 +103,7 @@ public int hashCode() {
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
-    sb.append("class GetClickThroughRateResponseDates {\n");
+    sb.append("class ClickThroughRateEvent {\n");
     sb.append("    rate: ").append(toIndentedString(rate)).append("\n");
     sb.append("    clickCount: ").append(toIndentedString(clickCount)).append("\n");
     sb.append("    trackedSearchCount: ").append(toIndentedString(trackedSearchCount)).append("\n");

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/GetConversationRateResponseDates.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/analytics/ConversionRateEvent.java

@@ -3,8 +3,8 @@
 import com.google.gson.annotations.SerializedName;
 import java.util.Objects;
 
-/** GetConversationRateResponseDates */
-public class GetConversationRateResponseDates {
+/** ConversionRateEvent */
+public class ConversionRateEvent {
 
   @SerializedName("rate")
   private Double rate;
@@ -18,7 +18,7 @@ public class GetConversationRateResponseDates {
   @SerializedName("date")
   private String date;
 
-  public GetConversationRateResponseDates setRate(Double rate) {
+  public ConversionRateEvent setRate(Double rate) {
     this.rate = rate;
     return this;
   }
@@ -33,7 +33,7 @@ public Double getRate() {
     return rate;
   }
 
-  public GetConversationRateResponseDates setTrackedSearchCount(Integer trackedSearchCount) {
+  public ConversionRateEvent setTrackedSearchCount(Integer trackedSearchCount) {
     this.trackedSearchCount = trackedSearchCount;
     return this;
   }
@@ -48,7 +48,7 @@ public Integer getTrackedSearchCount() {
     return trackedSearchCount;
   }
 
-  public GetConversationRateResponseDates setConversionCount(Integer conversionCount) {
+  public ConversionRateEvent setConversionCount(Integer conversionCount) {
     this.conversionCount = conversionCount;
     return this;
   }
@@ -63,7 +63,7 @@ public Integer getConversionCount() {
     return conversionCount;
   }
 
-  public GetConversationRateResponseDates setDate(String date) {
+  public ConversionRateEvent setDate(String date) {
     this.date = date;
     return this;
   }
@@ -86,12 +86,12 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
-    GetConversationRateResponseDates getConversationRateResponseDates = (GetConversationRateResponseDates) o;
+    ConversionRateEvent conversionRateEvent = (ConversionRateEvent) o;
     return (
-      Objects.equals(this.rate, getConversationRateResponseDates.rate) &&
-      Objects.equals(this.trackedSearchCount, getConversationRateResponseDates.trackedSearchCount) &&
-      Objects.equals(this.conversionCount, getConversationRateResponseDates.conversionCount) &&
-      Objects.equals(this.date, getConversationRateResponseDates.date)
+      Objects.equals(this.rate, conversionRateEvent.rate) &&
+      Objects.equals(this.trackedSearchCount, conversionRateEvent.trackedSearchCount) &&
+      Objects.equals(this.conversionCount, conversionRateEvent.conversionCount) &&
+      Objects.equals(this.date, conversionRateEvent.date)
     );
   }
 
@@ -103,7 +103,7 @@ public int hashCode() {
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
-    sb.append("class GetConversationRateResponseDates {\n");
+    sb.append("class ConversionRateEvent {\n");
     sb.append("    rate: ").append(toIndentedString(rate)).append("\n");
     sb.append("    trackedSearchCount: ").append(toIndentedString(trackedSearchCount)).append("\n");
     sb.append("    conversionCount: ").append(toIndentedString(conversionCount)).append("\n");