feat(clients): add missing guides (#4457) (generated) [skip ci]

algolia-bot · Fluf22 · shortcuts · algolia-bot · commit 3e54c8fc136a · 2025-02-12T16:04:06.000Z
Co-authored-by: Thomas Raffray &lt;Fluf22@users.noreply.github.com&gt;
Co-authored-by: shortcuts &lt;vannicattec@gmail.com&gt;
diff --git a/docs/guides/csharp/src/searchFuturePublishedBooks.cs b/docs/guides/csharp/src/searchFuturePublishedBooks.cs
@@ -0,0 +1,34 @@
+namespace Algolia;
+
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Text.Json;
+using Algolia.Search.Clients;
+using Algolia.Search.Http;
+using Algolia.Search.Models.Search;
+
+class SearchFuturePublishedBooks
+{
+  async Task Main(string[] args)
+  {
+    try
+    {
+      var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
+      var dateTimestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();
+      var searchParams = new SearchParams(
+        new SearchParamsObject
+        {
+          Query = "<YOUR_SEARCH_QUERY>",
+          Filters = $"date_timestamp > {dateTimestamp}",
+        }
+      );
+
+      await client.SearchSingleIndexAsync<Hit>("<YOUR_INDEX_NAME>", searchParams);
+    }
+    catch (Exception e)
+    {
+      Console.WriteLine(e.Message);
+    }
+  }
+}
diff --git a/docs/guides/csharp/src/searchRecentlyPublishedBooks.cs b/docs/guides/csharp/src/searchRecentlyPublishedBooks.cs
@@ -15,12 +15,14 @@ async Task Main(string[] args)
     try
     {
       var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
-      var dateTimestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();
+      var date = DateTime.UtcNow.AddYears(-1);
+      var sTime = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
+      var unixTime = (long)(date - sTime).TotalSeconds;
       var searchParams = new SearchParams(
         new SearchParamsObject
         {
           Query = "<YOUR_SEARCH_QUERY>",
-          Filters = $"date_timestamp > {dateTimestamp}",
+          Filters = $"date_timestamp > {unixTime}",
         }
       );
 
diff --git a/docs/guides/dart/lib/searchFuturePublishedBooks.dart b/docs/guides/dart/lib/searchFuturePublishedBooks.dart
@@ -0,0 +1,15 @@
+import 'package:algolia_client_search/algolia_client_search.dart';
+
+void searchFuturePublishedBooks() async {
+  final client =
+      SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');
+
+  final dateTimestamp = DateTime.now().millisecondsSinceEpoch;
+  final searchParams = SearchParamsObject(
+      query: "<YOUR_SEARCH_QUERY>", filters: "date_timestamp > $dateTimestamp");
+
+  await client.searchSingleIndex(
+    indexName: "<YOUR_INDEX_NAME>",
+    searchParams: searchParams,
+  );
+}
diff --git a/docs/guides/dart/lib/searchRecentlyPublishedBooks.dart b/docs/guides/dart/lib/searchRecentlyPublishedBooks.dart
@@ -4,7 +4,8 @@ void searchRecentlyPublishedBooks() async {
   final client =
       SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');
 
-  final dateTimestamp = DateTime.now().millisecondsSinceEpoch;
+  final dateTimestamp =
+      DateTime.now().subtract(Duration(days: 365)).millisecondsSinceEpoch;
   final searchParams = SearchParamsObject(
       query: "<YOUR_SEARCH_QUERY>", filters: "date_timestamp > $dateTimestamp");
 
diff --git a/docs/guides/go/src/searchFuturePublishedBooks.go b/docs/guides/go/src/searchFuturePublishedBooks.go
@@ -0,0 +1,29 @@
+package main
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/algolia/algoliasearch-client-go/v4/algolia/search"
+)
+
+func searchFuturePublishedBooks() {
+	client, err := search.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
+	if err != nil {
+		// The client can fail to initialize if you pass an invalid parameter.
+		panic(err)
+	}
+
+	dateTimestamp := time.Now().UnixMilli()
+	searchParams := search.SearchParamsObjectAsSearchParams(
+		search.NewSearchParamsObject().
+			SetQuery("<YOUR_SEARCH_QUERY>").
+			SetFilters(fmt.Sprintf("date_timestamp > %d", dateTimestamp)),
+	)
+
+	_, err = client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
+		"<YOUR_INDEX_NAME>").WithSearchParams(searchParams))
+	if err != nil {
+		panic(err)
+	}
+}
diff --git a/docs/guides/go/src/searchRecentlyPublishedBooks.go b/docs/guides/go/src/searchRecentlyPublishedBooks.go
@@ -14,7 +14,7 @@ func searchRecentlyPublishedBooks() {
 		panic(err)
 	}
 
-	dateTimestamp := time.Now().UnixMilli()
+	dateTimestamp := time.Now().AddDate(-1, 0, 0).Unix()
 	searchParams := search.SearchParamsObjectAsSearchParams(
 		search.NewSearchParamsObject().
 			SetQuery("<YOUR_SEARCH_QUERY>").
diff --git a/docs/guides/java/src/test/java/com/algolia/searchFuturePublishedBooks.java b/docs/guides/java/src/test/java/com/algolia/searchFuturePublishedBooks.java
@@ -0,0 +1,19 @@
+package com.algolia;
+
+import com.algolia.api.SearchClient;
+import com.algolia.config.*;
+import com.algolia.model.search.*;
+
+public class searchFuturePublishedBooks {
+
+  public static void main(String[] args) throws Exception {
+    try (SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");) {
+      long dateTimestamp = System.currentTimeMillis();
+      SearchParams searchParams = new SearchParamsObject().setQuery("<YOUR_SEARCH_QUERY>").setFilters("date_timestamp > " + dateTimestamp);
+
+      client.searchSingleIndex("<YOUR_INDEX_NAME>", searchParams, Hit.class);
+    } catch (Exception e) {
+      System.out.println("An error occurred: " + e.getMessage());
+    }
+  }
+}
diff --git a/docs/guides/java/src/test/java/com/algolia/searchRecentlyPublishedBooks.java b/docs/guides/java/src/test/java/com/algolia/searchRecentlyPublishedBooks.java
@@ -3,12 +3,14 @@
 import com.algolia.api.SearchClient;
 import com.algolia.config.*;
 import com.algolia.model.search.*;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
 
 public class searchRecentlyPublishedBooks {
 
   public static void main(String[] args) throws Exception {
     try (SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");) {
-      long dateTimestamp = System.currentTimeMillis();
+      long dateTimestamp = ZonedDateTime.now(ZoneOffset.UTC).plusYears(-1).toEpochSecond();
       SearchParams searchParams = new SearchParamsObject().setQuery("<YOUR_SEARCH_QUERY>").setFilters("date_timestamp > " + dateTimestamp);
 
       client.searchSingleIndex("<YOUR_INDEX_NAME>", searchParams, Hit.class);
diff --git a/docs/guides/javascript/src/searchFuturePublishedBooks.ts b/docs/guides/javascript/src/searchFuturePublishedBooks.ts
@@ -0,0 +1,16 @@
+import type { SearchParams } from 'algoliasearch';
+import { algoliasearch } from 'algoliasearch';
+
+try {
+  const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
+
+  const dateTimestamp = Date.now();
+  const searchParams: SearchParams = {
+    query: '<YOUR_SEARCH_QUERY>',
+    filters: `date_timestamp > ${dateTimestamp}`,
+  };
+
+  await client.searchSingleIndex({ indexName: 'indexName', searchParams: searchParams });
+} catch (e: any) {
+  console.error(e);
+}
diff --git a/docs/guides/javascript/src/searchRecentlyPublishedBooks.ts b/docs/guides/javascript/src/searchRecentlyPublishedBooks.ts
@@ -4,10 +4,10 @@ import { algoliasearch } from 'algoliasearch';
 try {
   const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
 
-  const dateTimestamp = Date.now();
+  const d = new Date();
   const searchParams: SearchParams = {
     query: '<YOUR_SEARCH_QUERY>',
-    filters: `date_timestamp > ${dateTimestamp}`,
+    filters: `date_timestamp > ${Math.floor(d.setDate(d.getDate() - 365) / 1000)}`,
   };
 
   await client.searchSingleIndex({ indexName: 'indexName', searchParams: searchParams });
diff --git a/docs/guides/kotlin/src/main/kotlin/com/algolia/snippets/searchFuturePublishedBooks.kt b/docs/guides/kotlin/src/main/kotlin/com/algolia/snippets/searchFuturePublishedBooks.kt
@@ -0,0 +1,23 @@
+import java.time.Instant
+
+import com.algolia.client.api.SearchClient
+import com.algolia.client.configuration.*
+import com.algolia.client.transport.*
+import com.algolia.client.extensions.*
+
+import com.algolia.client.model.search.*
+
+suspend fun searchFuturePublishedBooks() {
+  val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
+
+  val dateTimestamp = Instant.now().epochSecond
+  val searchParams = SearchParamsObject(
+    query = "<YOUR_SEARCH_QUERY>",
+    filters = "date_timestamp > $dateTimestamp",
+  )
+
+  client.searchSingleIndex(
+    indexName = "<YOUR_INDEX_NAME>",
+    searchParams = searchParams,
+  )
+}
diff --git a/docs/guides/kotlin/src/main/kotlin/com/algolia/snippets/searchRecentlyPublishedBooks.kt b/docs/guides/kotlin/src/main/kotlin/com/algolia/snippets/searchRecentlyPublishedBooks.kt
@@ -1,4 +1,5 @@
 import java.time.Instant
+import java.time.temporal.ChronoUnit
 
 import com.algolia.client.api.SearchClient
 import com.algolia.client.configuration.*
@@ -10,7 +11,7 @@ import com.algolia.client.model.search.*
 suspend fun searchRecentlyPublishedBooks() {
   val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
 
-  val dateTimestamp = Instant.now().epochSecond
+  val dateTimestamp = Instant.now().minus(365, ChronoUnit.DAYS).epochSecond
   val searchParams = SearchParamsObject(
     query = "<YOUR_SEARCH_QUERY>",
     filters = "date_timestamp > $dateTimestamp",
diff --git a/docs/guides/php/src/searchFuturePublishedBooks.php b/docs/guides/php/src/searchFuturePublishedBooks.php
@@ -0,0 +1,22 @@
+<?php
+
+require __DIR__.'/../vendor/autoload.php';
+use Algolia\AlgoliaSearch\Api\SearchClient;
+use Algolia\AlgoliaSearch\Model\Search\SearchParamsObject;
+
+try {
+    $client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
+
+    $dateTimestamp = time();
+    $searchParams = (new SearchParamsObject())
+        ->setQuery('<YOUR_SEARCH_QUERY>')
+        ->setFilters('date_timestamp > '.$dateTimestamp)
+    ;
+
+    $client->searchSingleIndex(
+        '<YOUR_INDEX_NAME>',
+        $searchParams,
+    );
+} catch (Exception $e) {
+    echo $e->getMessage().PHP_EOL;
+}
diff --git a/docs/guides/php/src/searchRecentlyPublishedBooks.php b/docs/guides/php/src/searchRecentlyPublishedBooks.php
@@ -7,7 +7,7 @@
 try {
     $client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
 
-    $dateTimestamp = time();
+    $dateTimestamp = strtotime('-1 years');
     $searchParams = (new SearchParamsObject())
         ->setQuery('<YOUR_SEARCH_QUERY>')
         ->setFilters('date_timestamp > '.$dateTimestamp)
diff --git a/docs/guides/python/searchFuturePublishedBooks.py b/docs/guides/python/searchFuturePublishedBooks.py
@@ -0,0 +1,21 @@
+import time
+
+from algoliasearch.search.client import SearchClientSync
+
+
+if __name__ == "__main__":
+    try:
+        _client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
+
+        date_timestamp = time.time()  # Get current timestamp
+        search_params = {
+            "query": "<YOUR_SEARCH_QUERY>",
+            "filters": f"date_timestamp > {date_timestamp}",
+        }
+
+        _client.search_single_index(
+            index_name="<YOUR_INDEX_NAME>",
+            search_params=search_params,
+        )
+    except Exception as e:
+        print(f"Error: {e}")
diff --git a/docs/guides/python/searchRecentlyPublishedBooks.py b/docs/guides/python/searchRecentlyPublishedBooks.py
@@ -1,3 +1,4 @@
+import datetime
 import time
 
 from algoliasearch.search.client import SearchClientSync
@@ -7,7 +8,8 @@
     try:
         _client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
 
-        date_timestamp = time.time()  # Get current timestamp
+        date = datetime.datetime.now() - datetime.timedelta(days=365)
+        date_timestamp = int(time.mktime(date.timetuple()))
         search_params = {
             "query": "<YOUR_SEARCH_QUERY>",
             "filters": f"date_timestamp > {date_timestamp}",
diff --git a/docs/guides/ruby/searchFuturePublishedBooks.rb b/docs/guides/ruby/searchFuturePublishedBooks.rb
@@ -0,0 +1,14 @@
+import(time)
+
+require "algolia"
+
+client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
+
+# Get current timestamp
+date_timestamp = Time.now.to_i
+search_params = Algolia::Search::SearchParamsObject.new(
+  query: "<YOUR_SEARCH_QUERY>",
+  filters: "date_timestamp > #{date_timestamp}"
+)
+
+client.search_single_index("<YOUR_INDEX_NAME>", search_params)
diff --git a/docs/guides/ruby/searchRecentlyPublishedBooks.rb b/docs/guides/ruby/searchRecentlyPublishedBooks.rb
@@ -4,8 +4,7 @@
 
 client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
 
-# Get current timestamp
-date_timestamp = Time.now.to_i
+date_timestamp = Time.now.to_i - 60 * 60 * 24 * 365
 search_params = Algolia::Search::SearchParamsObject.new(
   query: "<YOUR_SEARCH_QUERY>",
   filters: "date_timestamp > #{date_timestamp}"
diff --git a/docs/guides/scala/src/main/scala/searchFuturePublishedBooks.scala b/docs/guides/scala/src/main/scala/searchFuturePublishedBooks.scala
@@ -0,0 +1,31 @@
+import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.Future
+import java.time.Instant
+
+import algoliasearch.api.SearchClient
+import algoliasearch.config.*
+import algoliasearch.extension.SearchClientExtensions
+
+import algoliasearch.search.SearchParamsObject
+
+def searchFuturePublishedBooks(): Future[Unit] = {
+  val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
+
+  val dateTimestamp = Instant.now.getEpochSecond
+  val searchParams = SearchParamsObject(
+    query = Some("<YOUR_SEARCH_QUERY>"),
+    filters = Some(s"date_timestamp > $dateTimestamp")
+  )
+
+  client
+    .searchSingleIndex(
+      indexName = "<YOUR_INDEX_NAME>",
+      searchParams = Some(searchParams)
+    )
+    .map { response =>
+      println(response)
+    }
+    .recover { case ex: Exception =>
+      println(s"An error occurred: ${ex.getMessage}")
+    }
+}
diff --git a/docs/guides/scala/src/main/scala/searchRecentlyPublishedBooks.scala b/docs/guides/scala/src/main/scala/searchRecentlyPublishedBooks.scala
@@ -1,6 +1,6 @@
 import scala.concurrent.ExecutionContext.Implicits.global
 import scala.concurrent.Future
-import java.time.Instant
+import java.time.{Instant, LocalDateTime, ZoneOffset}
 
 import algoliasearch.api.SearchClient
 import algoliasearch.config.*
@@ -11,7 +11,7 @@ import algoliasearch.search.SearchParamsObject
 def searchRecentlyPublishedBooks(): Future[Unit] = {
   val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
 
-  val dateTimestamp = Instant.now.getEpochSecond
+  val dateTimestamp = LocalDateTime.now().minusYears(1).toInstant(ZoneOffset.UTC).getEpochSecond
   val searchParams = SearchParamsObject(
     query = Some("<YOUR_SEARCH_QUERY>"),
     filters = Some(s"date_timestamp > $dateTimestamp")
diff --git a/docs/guides/swift/Sources/searchFuturePublishedBooks.swift b/docs/guides/swift/Sources/searchFuturePublishedBooks.swift
@@ -0,0 +1,26 @@
+import Foundation
+#if os(Linux) // For linux interop
+    import FoundationNetworking
+#endif
+
+import Core
+import Search
+
+func searchFuturePublishedBooks() async throws {
+    do {
+        let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
+
+        let dateTimestamp = Int(Date().timeIntervalSince1970)
+        let searchParams = SearchSearchParams.searchSearchParamsObject(
+            SearchSearchParamsObject(query: "<YOUR_SEARCH_QUERY>", filters: "date_timestamp > \(dateTimestamp)")
+        )
+
+        let response: SearchResponse<Hit> = try await client.searchSingleIndex(
+            indexName: "<YOUR_INDEX_NAME>",
+            searchParams: searchParams
+        )
+        print(response)
+    } catch {
+        print(error)
+    }
+}
diff --git a/docs/guides/swift/Sources/searchRecentlyPublishedBooks.swift b/docs/guides/swift/Sources/searchRecentlyPublishedBooks.swift

Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,14 @@ async Task Main(string[] args)`
`15`	`15`	`try`
`16`	`16`	`{`
`17`	`17`	`var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));`
`18`		`- var dateTimestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();`
	`18`	`+ var date = DateTime.UtcNow.AddYears(-1);`
	`19`	`+ var sTime = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);`
	`20`	`+ var unixTime = (long)(date - sTime).TotalSeconds;`
`19`	`21`	`var searchParams = new SearchParams(`
`20`	`22`	`new SearchParamsObject`
`21`	`23`	`{`
`22`	`24`	`Query = "<YOUR_SEARCH_QUERY>",`
`23`		`- Filters = $"date_timestamp > {dateTimestamp}",`
	`25`	`+ Filters = $"date_timestamp > {unixTime}",`
`24`	`26`	`}`
`25`	`27`	`);`
`26`	`28`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ func searchRecentlyPublishedBooks() {`
`14`	`14`	`panic(err)`
`15`	`15`	`}`
`16`	`16`
`17`		`- dateTimestamp := time.Now().UnixMilli()`
	`17`	`+ dateTimestamp := time.Now().AddDate(-1, 0, 0).Unix()`
`18`	`18`	`searchParams := search.SearchParamsObjectAsSearchParams(`
`19`	`19`	`search.NewSearchParamsObject().`
`20`	`20`	`SetQuery("<YOUR_SEARCH_QUERY>").`