chore: add searchSingleIndex snippet [skip-bc] (#3975) (generated) [s…

…kip-ci] Co-authored-by: Thomas Raffray <[email protected]>
algolia · Oct 17, 2024 · e3ec895 · e3ec895
1 parent 4d23232
commit e3ec895
Show file tree

Hide file tree

Showing 13 changed files with 147 additions and 38 deletions.
diff --git a/docs/bundled/search-snippets.json b/docs/bundled/search-snippets.json
@@ -210,7 +210,7 @@
       "default": "var response = await client.SearchRulesAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new SearchRulesParams { Query = \"zorro\" }\n);"
     },
     "searchSingleIndex": {
-      "default": "var response = await client.SearchSingleIndexAsync<Hit>(\"<YOUR_INDEX_NAME>\");"
+      "default": "var response = await client.SearchSingleIndexAsync<Hit>(\n  \"<YOUR_INDEX_NAME>\",\n  new SearchParams(\n    new SearchParamsObject\n    {\n      Query = \"myQuery\",\n      FacetFilters = new FacetFilters(\n        new List<FacetFilters> { new FacetFilters(\"tags:algolia\") }\n      ),\n    }\n  )\n);"
     },
     "searchSynonyms": {
       "default": "var response = await client.SearchSynonymsAsync(\"<YOUR_INDEX_NAME>\");"
@@ -456,7 +456,7 @@
       "default": "final response = await client.searchRules(\n  indexName: \"<YOUR_INDEX_NAME>\",\n  searchRulesParams: SearchRulesParams(\n    query: \"zorro\",\n  ),\n);"
     },
     "searchSingleIndex": {
-      "default": "final response = await client.searchSingleIndex(\n  indexName: \"<YOUR_INDEX_NAME>\",\n);"
+      "default": "final response = await client.searchSingleIndex(\n  indexName: \"<YOUR_INDEX_NAME>\",\n  searchParams: SearchParamsObject(\n    query: \"myQuery\",\n    facetFilters: [\n      \"tags:algolia\",\n    ],\n  ),\n);"
     },
     "searchSynonyms": {
       "default": "final response = await client.searchSynonyms(\n  indexName: \"<YOUR_INDEX_NAME>\",\n);"
@@ -702,7 +702,7 @@
       "default": "response, err := client.SearchRules(client.NewApiSearchRulesRequest(\n  \"<YOUR_INDEX_NAME>\",\n).WithSearchRulesParams(\n  search.NewEmptySearchRulesParams().SetQuery(\"zorro\")))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
     },
     "searchSingleIndex": {
-      "default": "response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(\n  \"<YOUR_INDEX_NAME>\",\n))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
+      "default": "response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(\n  \"<YOUR_INDEX_NAME>\",\n).WithSearchParams(search.SearchParamsObjectAsSearchParams(\n  search.NewEmptySearchParamsObject().SetQuery(\"myQuery\").SetFacetFilters(search.ArrayOfFacetFiltersAsFacetFilters(\n    []search.FacetFilters{*search.StringAsFacetFilters(\"tags:algolia\")})))))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
     },
     "searchSynonyms": {
       "default": "response, err := client.SearchSynonyms(client.NewApiSearchSynonymsRequest(\n  \"<YOUR_INDEX_NAME>\",\n))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
@@ -948,7 +948,7 @@
       "default": "client.searchRules(\"<YOUR_INDEX_NAME>\", new SearchRulesParams().setQuery(\"zorro\"));"
     },
     "searchSingleIndex": {
-      "default": "client.searchSingleIndex(\"<YOUR_INDEX_NAME>\", Hit.class);"
+      "default": "client.searchSingleIndex(\n  \"<YOUR_INDEX_NAME>\",\n  new SearchParamsObject().setQuery(\"myQuery\").setFacetFilters(FacetFilters.of(Arrays.asList(FacetFilters.of(\"tags:algolia\")))),\n  Hit.class\n);"
     },
     "searchSynonyms": {
       "default": "client.searchSynonyms(\"<YOUR_INDEX_NAME>\");"
@@ -1194,7 +1194,7 @@
       "default": "const response = await client.searchRules({ indexName: 'cts_e2e_browse', searchRulesParams: { query: 'zorro' } });"
     },
     "searchSingleIndex": {
-      "default": "const response = await client.searchSingleIndex({ indexName: 'indexName' });"
+      "default": "const response = await client.searchSingleIndex({\n  indexName: 'indexName',\n  searchParams: { query: 'myQuery', facetFilters: ['tags:algolia'] },\n});"
     },
     "searchSynonyms": {
       "default": "const response = await client.searchSynonyms({ indexName: 'indexName' });"
@@ -1440,7 +1440,7 @@
       "default": "var response = client.searchRules(\n  indexName = \"<YOUR_INDEX_NAME>\",\n  searchRulesParams = SearchRulesParams(\n    query = \"zorro\",\n  ),\n)"
     },
     "searchSingleIndex": {
-      "default": "var response = client.searchSingleIndex(\n  indexName = \"<YOUR_INDEX_NAME>\",\n)"
+      "default": "var response = client.searchSingleIndex(\n  indexName = \"<YOUR_INDEX_NAME>\",\n  searchParams = SearchParamsObject(\n    query = \"myQuery\",\n    facetFilters = FacetFilters.of(listOf(FacetFilters.of(\"tags:algolia\"))),\n  ),\n)"
     },
     "searchSynonyms": {
       "default": "var response = client.searchSynonyms(\n  indexName = \"<YOUR_INDEX_NAME>\",\n)"
@@ -1686,7 +1686,7 @@
       "default": "$response = $client->searchRules(\n    '<YOUR_INDEX_NAME>',\n    ['query' => 'zorro',\n    ],\n);"
     },
     "searchSingleIndex": {
-      "default": "$response = $client->searchSingleIndex(\n    '<YOUR_INDEX_NAME>',\n);"
+      "default": "$response = $client->searchSingleIndex(\n    '<YOUR_INDEX_NAME>',\n    ['query' => 'myQuery',\n        'facetFilters' => [\n            'tags:algolia',\n        ],\n    ],\n);"
     },
     "searchSynonyms": {
       "default": "$response = $client->searchSynonyms(\n    '<YOUR_INDEX_NAME>',\n);"
@@ -1932,7 +1932,7 @@
       "default": "response = client.search_rules(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    search_rules_params={\n        \"query\": \"zorro\",\n    },\n)"
     },
     "searchSingleIndex": {
-      "default": "response = client.search_single_index(\n    index_name=\"<YOUR_INDEX_NAME>\",\n)"
+      "default": "response = client.search_single_index(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    search_params={\n        \"query\": \"myQuery\",\n        \"facetFilters\": [\n            \"tags:algolia\",\n        ],\n    },\n)"
     },
     "searchSynonyms": {
       "default": "response = client.search_synonyms(\n    index_name=\"<YOUR_INDEX_NAME>\",\n)"
@@ -2178,7 +2178,7 @@
       "default": "response = client.search_rules(\"<YOUR_INDEX_NAME>\", Algolia::Search::SearchRulesParams.new(query: \"zorro\"))"
     },
     "searchSingleIndex": {
-      "default": "response = client.search_single_index(\"<YOUR_INDEX_NAME>\")"
+      "default": "response = client.search_single_index(\n  \"<YOUR_INDEX_NAME>\",\n  Algolia::Search::SearchParamsObject.new(query: \"myQuery\", facet_filters: [\"tags:algolia\"])\n)"
     },
     "searchSynonyms": {
       "default": "response = client.search_synonyms(\"<YOUR_INDEX_NAME>\")"
@@ -2401,7 +2401,7 @@
       "default": "val response = client.searchRules(\n  indexName = \"<YOUR_INDEX_NAME>\",\n  searchRulesParams = Some(\n    SearchRulesParams(\n      query = Some(\"zorro\")\n    )\n  )\n)"
     },
     "searchSingleIndex": {
-      "default": "val response = client.searchSingleIndex(\n  indexName = \"<YOUR_INDEX_NAME>\"\n)"
+      "default": "val response = client.searchSingleIndex(\n  indexName = \"<YOUR_INDEX_NAME>\",\n  searchParams = Some(\n    SearchParamsObject(\n      query = Some(\"myQuery\"),\n      facetFilters = Some(FacetFilters(Seq(FacetFilters(\"tags:algolia\"))))\n    )\n  )\n)"
     },
     "searchSynonyms": {
       "default": "val response = client.searchSynonyms(\n  indexName = \"<YOUR_INDEX_NAME>\"\n)"
@@ -2633,7 +2633,7 @@
       "default": "let response = try await client.searchRules(\n    indexName: \"<YOUR_INDEX_NAME>\",\n    searchRulesParams: SearchRulesParams(query: \"zorro\")\n)"
     },
     "searchSingleIndex": {
-      "default": "let response: SearchResponse<Hit> = try await client.searchSingleIndex(indexName: \"<YOUR_INDEX_NAME>\")"
+      "default": "let response: SearchResponse<Hit> = try await client.searchSingleIndex(\n    indexName: \"<YOUR_INDEX_NAME>\",\n    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(\n        query: \"myQuery\",\n        facetFilters: SearchFacetFilters.arrayOfSearchFacetFilters([SearchFacetFilters.string(\"tags:algolia\")])\n    ))\n)"
     },
     "searchSynonyms": {
       "default": "let response = try await client.searchSynonyms(indexName: \"<YOUR_INDEX_NAME>\")"

diff --git a/docs/snippets/csharp/src/Search.cs b/docs/snippets/csharp/src/Search.cs
@@ -1885,7 +1885,7 @@ public async Task SnippetForSearchClientSearchRules()
   /// <summary>
   /// Snippet for the SearchSingleIndex method.
   ///
-  /// search with minimal parameters
+  /// search with searchParams
   /// </summary>
   public async Task SnippetForSearchClientSearchSingleIndex()
   {
@@ -1894,7 +1894,18 @@ public async Task SnippetForSearchClientSearchSingleIndex()
     var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
 
     // Call the API
-    var response = await client.SearchSingleIndexAsync<Hit>("<YOUR_INDEX_NAME>");
+    var response = await client.SearchSingleIndexAsync<Hit>(
+      "<YOUR_INDEX_NAME>",
+      new SearchParams(
+        new SearchParamsObject
+        {
+          Query = "myQuery",
+          FacetFilters = new FacetFilters(
+            new List<FacetFilters> { new FacetFilters("tags:algolia") }
+          ),
+        }
+      )
+    );
     // >LOG
     // SEPARATOR<
   }

diff --git a/docs/snippets/dart/lib/search.dart b/docs/snippets/dart/lib/search.dart
@@ -1834,7 +1834,7 @@ void snippetForsearchRules() async {
 
 // Snippet for the searchSingleIndex method.
 //
-// search with minimal parameters
+// search with searchParams
 void snippetForsearchSingleIndex() async {
   // >SEPARATOR searchSingleIndex default
   // Initialize the client
@@ -1844,6 +1844,12 @@ void snippetForsearchSingleIndex() async {
   // Call the API
   final response = await client.searchSingleIndex(
     indexName: "<YOUR_INDEX_NAME>",
+    searchParams: SearchParamsObject(
+      query: "myQuery",
+      facetFilters: [
+        "tags:algolia",
+      ],
+    ),
   );
   // >LOG
   // SEPARATOR<

diff --git a/docs/snippets/go/src/search.go b/docs/snippets/go/src/search.go
diff --git a/docs/snippets/java/src/test/java/com/algolia/Search.java b/docs/snippets/java/src/test/java/com/algolia/Search.java
@@ -1618,14 +1618,18 @@ void snippetForSearchRules() throws Exception {
 
   // Snippet for the searchSingleIndex method.
   //
-  // search with minimal parameters
+  // search with searchParams
   void snippetForSearchSingleIndex() throws Exception {
     // >SEPARATOR searchSingleIndex default
     // Initialize the client
     SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
 
     // Call the API
-    client.searchSingleIndex("<YOUR_INDEX_NAME>", Hit.class);
+    client.searchSingleIndex(
+      "<YOUR_INDEX_NAME>",
+      new SearchParamsObject().setQuery("myQuery").setFacetFilters(FacetFilters.of(Arrays.asList(FacetFilters.of("tags:algolia")))),
+      Hit.class
+    );
     // >LOG
     // SEPARATOR<
   }

diff --git a/docs/snippets/javascript/src/search.ts b/docs/snippets/javascript/src/search.ts
@@ -1681,15 +1681,18 @@ export async function snippetForSearchRules(): Promise<void> {
 
 // Snippet for the searchSingleIndex method.
 //
-// search with minimal parameters
+// search with searchParams
 export async function snippetForSearchSingleIndex(): Promise<void> {
   // >SEPARATOR searchSingleIndex default
   // Initialize the client
   //
   const client = searchClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
 
   // Call the API
-  const response = await client.searchSingleIndex({ indexName: 'indexName' });
+  const response = await client.searchSingleIndex({
+    indexName: 'indexName',
+    searchParams: { query: 'myQuery', facetFilters: ['tags:algolia'] },
+  });
 
   // >LOG
   // use typed response

diff --git a/docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Search.kt b/docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Search.kt
@@ -2036,6 +2036,10 @@ class SnippetSearchClient {
     // Call the API
     var response = client.searchSingleIndex(
       indexName = "<YOUR_INDEX_NAME>",
+      searchParams = SearchParamsObject(
+        query = "myQuery",
+        facetFilters = FacetFilters.of(listOf(FacetFilters.of("tags:algolia"))),
+      ),
     )
 
     // >LOG

diff --git a/docs/snippets/php/src/Search.php b/docs/snippets/php/src/Search.php
@@ -2193,7 +2193,7 @@ public function snippetForSearchRules(): void
     /**
      * Snippet for the SearchSingleIndex method.
      *
-     * search with minimal parameters
+     * search with searchParams
      */
     public function snippetForSearchSingleIndex(): void
     {
@@ -2204,6 +2204,11 @@ public function snippetForSearchSingleIndex(): void
         // Call the API
         $response = $client->searchSingleIndex(
             '<YOUR_INDEX_NAME>',
+            ['query' => 'myQuery',
+                'facetFilters' => [
+                    'tags:algolia',
+                ],
+            ],
         );
 
         // >LOG

diff --git a/docs/snippets/python/search.py b/docs/snippets/python/search.py
@@ -2247,7 +2247,7 @@ def snippet_for_search_single_index():
     """
     Snippet for the searchSingleIndex method.
 
-    search with minimal parameters
+    search with searchParams
     """
     # >SEPARATOR searchSingleIndex default
     # Initialize the client
@@ -2257,6 +2257,12 @@ def snippet_for_search_single_index():
     # Call the API
     response = client.search_single_index(
         index_name="<YOUR_INDEX_NAME>",
+        search_params={
+            "query": "myQuery",
+            "facetFilters": [
+                "tags:algolia",
+            ],
+        },
     )
 
     # >LOG

diff --git a/docs/snippets/ruby/search.rb b/docs/snippets/ruby/search.rb
@@ -1910,14 +1910,17 @@ def snippet_for_search_rules
 
 # Snippet for the searchSingleIndex method.
 #
-# search with minimal parameters
+# search with searchParams
 def snippet_for_search_single_index
   # >SEPARATOR searchSingleIndex default
   # Initialize the client
   client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
 
   # Call the API
-  response = client.search_single_index("<YOUR_INDEX_NAME>")
+  response = client.search_single_index(
+    "<YOUR_INDEX_NAME>",
+    Algolia::Search::SearchParamsObject.new(query: "myQuery", facet_filters: ["tags:algolia"])
+  )
 
   # >LOG
   # use the class directly

diff --git a/docs/snippets/scala/src/main/scala/Search.scala b/docs/snippets/scala/src/main/scala/Search.scala
@@ -1712,7 +1712,7 @@ class SnippetSearchClient {
 
   /** Snippet for the searchSingleIndex method.
     *
-    * search with minimal parameters
+    * search with searchParams
     */
   def snippetForSearchClientSearchSingleIndex(): Unit = {
     // >SEPARATOR searchSingleIndex default
@@ -1721,7 +1721,13 @@ class SnippetSearchClient {
 
     // Call the API
     val response = client.searchSingleIndex(
-      indexName = "<YOUR_INDEX_NAME>"
+      indexName = "<YOUR_INDEX_NAME>",
+      searchParams = Some(
+        SearchParamsObject(
+          query = Some("myQuery"),
+          facetFilters = Some(FacetFilters(Seq(FacetFilters("tags:algolia"))))
+        )
+      )
     )
 
     // >LOG

diff --git a/docs/snippets/swift/Sources/Search.swift b/docs/snippets/swift/Sources/Search.swift
@@ -1422,14 +1422,20 @@ final class SearchClientSnippet {
 
     /// Snippet for the searchSingleIndex method.
     ///
-    /// search with minimal parameters
+    /// search with searchParams
     func snippetForSearchSingleIndex() async throws {
         // >SEPARATOR searchSingleIndex default
         // Initialize the client
         let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
 
         // Call the API
-        let response: SearchResponse<Hit> = try await client.searchSingleIndex(indexName: "<YOUR_INDEX_NAME>")
+        let response: SearchResponse<Hit> = try await client.searchSingleIndex(
+            indexName: "<YOUR_INDEX_NAME>",
+            searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
+                query: "myQuery",
+                facetFilters: SearchFacetFilters.arrayOfSearchFacetFilters([SearchFacetFilters.string("tags:algolia")])
+            ))
+        )
         // >LOG
         // SEPARATOR<
     }