Merge branch 'main' into chore/renovateBaseBranch

Author: millotp

.eslintignore

@@ -6,3 +6,4 @@ composer.json
 tsconfig.json
 vendor
 builddir
+foo

.github/workflows/check.yml

@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 10
     env:
-      CACHE_VERSION: 1 # bump this to run all clients on the CI.
+      CACHE_VERSION: 1.01 # bump this to run all clients on the CI.
     steps:
       - name: debugging - dump GitHub context
         env:
@@ -199,10 +199,10 @@ jobs:
           type: specs
 
       - name: Remove generated clients
-        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
+        if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
         run: |
           cd clients/algoliasearch-client-javascript/packages
-          ls | grep -v -E "(client-common|requester-*|algoliasearch)" | xargs rm -rf
+          ls | grep -v -E "(logger-console|client-common|requester-*|algoliasearch)" | xargs rm -rf
           cd algoliasearch
           ls | grep -v -E "__tests__" | xargs rm -rf
 
@@ -228,11 +228,11 @@ jobs:
         run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }}
 
       - name: Test JavaScript bundle size
-        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
+        if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
         run: cd clients/algoliasearch-client-javascript && yarn test:size
 
       - name: Test JavaScript bundle and types
-        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
+        if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
         run: cd clients/algoliasearch-client-javascript && yarn test:bundle
 
       - name: Remove previous CTS output
@@ -335,7 +335,7 @@ jobs:
         run: yarn cli generate ${{ matrix.client.language }} ${{ matrix.client.toRun }}
 
       - name: Update composer.lock
-        if: ${{ matrix.client.language == 'php' && startsWith(env.head_ref, 'chore/renovateBaseBranch')  && matrix.client.isMainVersion }}
+        if: ${{ matrix.client.language == 'php' && startsWith(github.head_ref, 'chore/renovateBaseBranch')  && matrix.client.isMainVersion }}
         run: cd ${{ matrix.client.path }} && composer update
 
       - name: Check for file duplicates in Swift

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/FallbackParams.cs

@@ -267,9 +267,9 @@ public FallbackParams()
   public List<string> UnretrievableAttributes { get; set; }
 
   /// <summary>
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
   /// </summary>
-  /// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
+  /// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
   [JsonPropertyName("disableTypoToleranceOnWords")]
   public List<string> DisableTypoToleranceOnWords { get; set; }
 

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendHit.cs

@@ -28,11 +28,9 @@ public RecommendHit()
   /// Initializes a new instance of the RecommendHit class.
   /// </summary>
   /// <param name="objectID">Unique record identifier. (required).</param>
-  /// <param name="score">Recommendation score. (required).</param>
-  public RecommendHit(string objectID, double score)
+  public RecommendHit(string objectID)
   {
     ObjectID = objectID ?? throw new ArgumentNullException(nameof(objectID));
-    Score = score;
     AdditionalProperties = new Dictionary<string, object>();
   }
 
@@ -74,7 +72,7 @@ public RecommendHit(string objectID, double score)
   /// </summary>
   /// <value>Recommendation score.</value>
   [JsonPropertyName("_score")]
-  public double Score { get; set; }
+  public double? Score { get; set; }
 
   /// <summary>
   /// Gets or Sets additional properties

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendSearchParams.cs

@@ -267,9 +267,9 @@ public RecommendSearchParams()
   public List<string> UnretrievableAttributes { get; set; }
 
   /// <summary>
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
   /// </summary>
-  /// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
+  /// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
   [JsonPropertyName("disableTypoToleranceOnWords")]
   public List<string> DisableTypoToleranceOnWords { get; set; }
 

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/SearchRecommendRulesParams.cs

@@ -38,16 +38,16 @@ public SearchRecommendRulesParams()
   public string Context { get; set; }
 
   /// <summary>
-  /// Requested page of the API response.
+  /// Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. 
   /// </summary>
-  /// <value>Requested page of the API response.</value>
+  /// <value>Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. </value>
   [JsonPropertyName("page")]
   public int? Page { get; set; }
 
   /// <summary>
-  /// Maximum number of hits per page.
+  /// Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. 
   /// </summary>
-  /// <value>Maximum number of hits per page.</value>
+  /// <value>Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. </value>
   [JsonPropertyName("hitsPerPage")]
   public int? HitsPerPage { get; set; }
 

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/TrendingFacetHit.cs

@@ -24,12 +24,10 @@ public TrendingFacetHit() { }
   /// <summary>
   /// Initializes a new instance of the TrendingFacetHit class.
   /// </summary>
-  /// <param name="score">Recommendation score. (required).</param>
   /// <param name="facetName">Facet attribute. To be used in combination with &#x60;facetValue&#x60;. If specified, only recommendations matching the facet filter will be returned.  (required).</param>
   /// <param name="facetValue">Facet value. To be used in combination with &#x60;facetName&#x60;. If specified, only recommendations matching the facet filter will be returned.  (required).</param>
-  public TrendingFacetHit(double score, string facetName, string facetValue)
+  public TrendingFacetHit(string facetName, string facetValue)
   {
-    Score = score;
     FacetName = facetName ?? throw new ArgumentNullException(nameof(facetName));
     FacetValue = facetValue ?? throw new ArgumentNullException(nameof(facetValue));
   }
@@ -39,7 +37,7 @@ public TrendingFacetHit(double score, string facetName, string facetValue)
   /// </summary>
   /// <value>Recommendation score.</value>
   [JsonPropertyName("_score")]
-  public double Score { get; set; }
+  public double? Score { get; set; }
 
   /// <summary>
   /// Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned. 

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/IndexSettings.cs

@@ -76,9 +76,9 @@ public IndexSettings()
   public List<string> UnretrievableAttributes { get; set; }
 
   /// <summary>
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
   /// </summary>
-  /// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
+  /// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
   [JsonPropertyName("disableTypoToleranceOnWords")]
   public List<string> DisableTypoToleranceOnWords { get; set; }
 

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs

@@ -25,7 +25,7 @@ public SearchDictionaryEntriesResponse() { }
   /// Initializes a new instance of the SearchDictionaryEntriesResponse class.
   /// </summary>
   /// <param name="hits">Dictionary entries matching the search criteria. (required).</param>
-  /// <param name="page">Requested page of the API response. (required).</param>
+  /// <param name="page">Requested page of the API response.  Algolia uses &#x60;page&#x60; and &#x60;hitsPerPage&#x60; to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - &#x60;hitsPerPage&#x60;: sets the number of search results (_hits_) displayed per page. - &#x60;page&#x60;: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is &#x60;page&#x3D;0&#x60;, the second is &#x60;page&#x3D;1&#x60;, and so on.  For example, to display 10 results per page starting from the third page, set &#x60;hitsPerPage&#x60; to 10 and &#x60;page&#x60; to 2.  (required).</param>
   /// <param name="nbHits">Number of results (hits). (required).</param>
   /// <param name="nbPages">Number of pages of results. (required).</param>
   public SearchDictionaryEntriesResponse(List<DictionaryEntry> hits, int page, int nbHits, int nbPages)
@@ -44,9 +44,9 @@ public SearchDictionaryEntriesResponse(List<DictionaryEntry> hits, int page, int
   public List<DictionaryEntry> Hits { get; set; }
 
   /// <summary>
-  /// Requested page of the API response.
+  /// Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. 
   /// </summary>
-  /// <value>Requested page of the API response.</value>
+  /// <value>Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. </value>
   [JsonPropertyName("page")]
   public int Page { get; set; }
 

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchRulesParams.cs

@@ -44,16 +44,16 @@ public SearchRulesParams()
   public string Context { get; set; }
 
   /// <summary>
-  /// Requested page of the API response.
+  /// Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. 
   /// </summary>
-  /// <value>Requested page of the API response.</value>
+  /// <value>Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. </value>
   [JsonPropertyName("page")]
   public int? Page { get; set; }
 
   /// <summary>
-  /// Maximum number of hits per page.
+  /// Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. 
   /// </summary>
-  /// <value>Maximum number of hits per page.</value>
+  /// <value>Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. </value>
   [JsonPropertyName("hitsPerPage")]
   public int? HitsPerPage { get; set; }