fix(specs): getObject return object (#3446) (generated) [skip ci]

Co-authored-by: Pierre Millot <pierre.millot@algolia.com>

clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs

@@ -724,8 +724,8 @@ public interface ISearchClient
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
-  /// <returns>Task of Dictionary{string, string}</returns>
-  Task<Dictionary<string, string>> GetObjectAsync(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default);
+  /// <returns>Task of object</returns>
+  Task<object> GetObjectAsync(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
   /// Retrieves one record by its object ID.  To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).  (Synchronous version)
@@ -738,8 +738,8 @@ public interface ISearchClient
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
-  /// <returns>Dictionary{string, string}</returns>
-  Dictionary<string, string> GetObject(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default);
+  /// <returns>object</returns>
+  object GetObject(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
   /// Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests. 
@@ -2929,8 +2929,8 @@ public GetLogsResponse GetLogs(int? offset = default, int? length = default, str
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
-  /// <returns>Task of Dictionary{string, string}</returns>
-  public async Task<Dictionary<string, string>> GetObjectAsync(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default)
+  /// <returns>Task of object</returns>
+  public async Task<object> GetObjectAsync(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default)
   {
 
     if (indexName == null)
@@ -2946,7 +2946,7 @@ public async Task<Dictionary<string, string>> GetObjectAsync(string indexName, s
     requestOptions.PathParameters.Add("objectID", QueryStringHelper.ParameterToString(objectID));
 
     requestOptions.AddQueryParameter("attributesToRetrieve", attributesToRetrieve);
-    return await _transport.ExecuteRequestAsync<Dictionary<string, string>>(new HttpMethod("GET"), "/1/indexes/{indexName}/{objectID}", requestOptions, cancellationToken).ConfigureAwait(false);
+    return await _transport.ExecuteRequestAsync<object>(new HttpMethod("GET"), "/1/indexes/{indexName}/{objectID}", requestOptions, cancellationToken).ConfigureAwait(false);
   }
 
 
@@ -2964,8 +2964,8 @@ public async Task<Dictionary<string, string>> GetObjectAsync(string indexName, s
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
-  /// <returns>Dictionary{string, string}</returns>
-  public Dictionary<string, string> GetObject(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
+  /// <returns>object</returns>
+  public object GetObject(string indexName, string objectID, List<string> attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
     AsyncHelper.RunSync(() => GetObjectAsync(indexName, objectID, attributesToRetrieve, options, cancellationToken));
 
 

clients/algoliasearch-client-dart/packages/client_search/lib/src/api/search_client.dart

@@ -1051,7 +1051,7 @@ final class SearchClient implements ApiClient {
   /// * [objectID] Unique record identifier.
   /// * [attributesToRetrieve] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key.
   /// * [requestOptions] additional request configuration.
-  Future<Map<String, String>> getObject({
+  Future<Object> getObject({
     required String indexName,
     required String objectID,
     List<String>? attributesToRetrieve,
@@ -1081,9 +1081,9 @@ final class SearchClient implements ApiClient {
       request: request,
       options: requestOptions,
     );
-    return deserialize<Map<String, String>, String>(
+    return deserialize<Object, Object>(
       response,
-      'Map<String, String>',
+      'Object',
       growable: true,
     );
   }

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

@@ -2383,7 +2383,7 @@ public CompletableFuture<GetLogsResponse> getLogsAsync() throws AlgoliaRuntimeEx
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public Map<String, String> getObject(
+  public Object getObject(
     @Nonnull String indexName,
     @Nonnull String objectID,
     List<String> attributesToRetrieve,
@@ -2404,7 +2404,7 @@ public Map<String, String> getObject(
    *     won't be retrieved unless the request is authenticated with the admin API key. (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public Map<String, String> getObject(@Nonnull String indexName, @Nonnull String objectID, List<String> attributesToRetrieve)
+  public Object getObject(@Nonnull String indexName, @Nonnull String objectID, List<String> attributesToRetrieve)
     throws AlgoliaRuntimeException {
     return this.getObject(indexName, objectID, attributesToRetrieve, null);
   }
@@ -2419,7 +2419,7 @@ public Map<String, String> getObject(@Nonnull String indexName, @Nonnull String
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public Map<String, String> getObject(@Nonnull String indexName, @Nonnull String objectID, RequestOptions requestOptions)
+  public Object getObject(@Nonnull String indexName, @Nonnull String objectID, RequestOptions requestOptions)
     throws AlgoliaRuntimeException {
     return this.getObject(indexName, objectID, null, requestOptions);
   }
@@ -2432,7 +2432,7 @@ public Map<String, String> getObject(@Nonnull String indexName, @Nonnull String
    * @param objectID Unique record identifier. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public Map<String, String> getObject(@Nonnull String indexName, @Nonnull String objectID) throws AlgoliaRuntimeException {
+  public Object getObject(@Nonnull String indexName, @Nonnull String objectID) throws AlgoliaRuntimeException {
     return this.getObject(indexName, objectID, null, null);
   }
 
@@ -2450,7 +2450,7 @@ public Map<String, String> getObject(@Nonnull String indexName, @Nonnull String
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public CompletableFuture<Map<String, String>> getObjectAsync(
+  public CompletableFuture<Object> getObjectAsync(
     @Nonnull String indexName,
     @Nonnull String objectID,
     List<String> attributesToRetrieve,
@@ -2465,7 +2465,7 @@ public CompletableFuture<Map<String, String>> getObjectAsync(
       .setMethod("GET")
       .addQueryParameter("attributesToRetrieve", attributesToRetrieve)
       .build();
-    return executeAsync(request, requestOptions, new TypeReference<Map<String, String>>() {});
+    return executeAsync(request, requestOptions, new TypeReference<Object>() {});
   }
 
   /**
@@ -2480,11 +2480,8 @@ public CompletableFuture<Map<String, String>> getObjectAsync(
    *     won't be retrieved unless the request is authenticated with the admin API key. (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public CompletableFuture<Map<String, String>> getObjectAsync(
-    @Nonnull String indexName,
-    @Nonnull String objectID,
-    List<String> attributesToRetrieve
-  ) throws AlgoliaRuntimeException {
+  public CompletableFuture<Object> getObjectAsync(@Nonnull String indexName, @Nonnull String objectID, List<String> attributesToRetrieve)
+    throws AlgoliaRuntimeException {
     return this.getObjectAsync(indexName, objectID, attributesToRetrieve, null);
   }
 
@@ -2498,11 +2495,8 @@ public CompletableFuture<Map<String, String>> getObjectAsync(
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public CompletableFuture<Map<String, String>> getObjectAsync(
-    @Nonnull String indexName,
-    @Nonnull String objectID,
-    RequestOptions requestOptions
-  ) throws AlgoliaRuntimeException {
+  public CompletableFuture<Object> getObjectAsync(@Nonnull String indexName, @Nonnull String objectID, RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
     return this.getObjectAsync(indexName, objectID, null, requestOptions);
   }
 
@@ -2514,8 +2508,7 @@ public CompletableFuture<Map<String, String>> getObjectAsync(
    * @param objectID Unique record identifier. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public CompletableFuture<Map<String, String>> getObjectAsync(@Nonnull String indexName, @Nonnull String objectID)
-    throws AlgoliaRuntimeException {
+  public CompletableFuture<Object> getObjectAsync(@Nonnull String indexName, @Nonnull String objectID) throws AlgoliaRuntimeException {
     return this.getObjectAsync(indexName, objectID, null, null);
   }
 

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -1837,7 +1837,7 @@ export function createSearchClient({
     getObject(
       { indexName, objectID, attributesToRetrieve }: GetObjectProps,
       requestOptions?: RequestOptions
-    ): Promise<Record<string, string>> {
+    ): Promise<Record<string, any>> {
       if (!indexName) {
         throw new Error(
           'Parameter `indexName` is required when calling `getObject`.'

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/SearchClient.kt

@@ -630,7 +630,7 @@ public class SearchClient(
    * @param attributesToRetrieve Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key.
    * @param requestOptions additional request configuration.
    */
-  public suspend fun getObject(indexName: String, objectID: String, attributesToRetrieve: List<String>? = null, requestOptions: RequestOptions? = null): Map<kotlin.String, String> {
+  public suspend fun getObject(indexName: String, objectID: String, attributesToRetrieve: List<String>? = null, requestOptions: RequestOptions? = null): JsonObject {
     require(indexName.isNotBlank()) { "Parameter `indexName` is required when calling `getObject`." }
     require(objectID.isNotBlank()) { "Parameter `objectID` is required when calling `getObject`." }
     val requestConfig = RequestConfig(

clients/algoliasearch-client-php/lib/Api/SearchClient.php

@@ -1263,7 +1263,7 @@ public function getLogs($offset = null, $length = null, $indexName = null, $type
      * @param array  $attributesToRetrieve Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. (optional)
      * @param array  $requestOptions       the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return array<string, mixed>|array<string,string>
+     * @return array<string, mixed>|object
      */
     public function getObject($indexName, $objectID, $attributesToRetrieve = null, $requestOptions = [])
     {

clients/algoliasearch-client-python/algoliasearch/search/client.py

@@ -2606,7 +2606,7 @@ async def get_object(
             ),
         ] = None,
         request_options: Optional[Union[dict, RequestOptions]] = None,
-    ) -> Dict[str, str]:
+    ) -> object:
         """
         Retrieves one record by its object ID.  To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
 
@@ -2620,13 +2620,13 @@ async def get_object(
         :param attributes_to_retrieve: Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key.
         :type attributes_to_retrieve: List[str]
         :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-        :return: Returns the deserialized response in a 'Dict[str, str]' result object.
+        :return: Returns the deserialized response in a 'object' result object.
         """
         return (
             await self.get_object_with_http_info(
                 index_name, object_id, attributes_to_retrieve, request_options
             )
-        ).deserialize(Dict[str, str])
+        ).deserialize(object)
 
     async def get_objects_with_http_info(
         self,

clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb

@@ -1389,10 +1389,10 @@ def get_object_with_http_info(index_name, object_id, attributes_to_retrieve = ni
     # @param object_id [String] Unique record identifier. (required)
     # @param attributes_to_retrieve [Array<String>] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  &#x60;objectID&#x60; is always retrieved.  Attributes included in &#x60;unretrievableAttributes&#x60; won&#39;t be retrieved unless the request is authenticated with the admin API key.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [Hash<String, String>]
+    # @return [Object]
     def get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
       response = get_object_with_http_info(index_name, object_id, attributes_to_retrieve, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Hash<String, String>")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Object")
     end
 
     # Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests.

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/SearchClient.scala

@@ -826,7 +826,7 @@ class SearchClient(
       objectID: String,
       attributesToRetrieve: Option[Seq[String]] = None,
       requestOptions: Option[RequestOptions] = None
-  )(implicit ec: ExecutionContext): Future[Map[String, String]] = Future {
+  )(implicit ec: ExecutionContext): Future[Any] = Future {
     requireNotNull(indexName, "Parameter `indexName` is required when calling `getObject`.")
     requireNotNull(objectID, "Parameter `objectID` is required when calling `getObject`.")
 
@@ -836,7 +836,7 @@ class SearchClient(
       .withPath(s"/1/indexes/${escape(indexName)}/${escape(objectID)}")
       .withQueryParameter("attributesToRetrieve", attributesToRetrieve)
       .build()
-    execute[Map[String, String]](request, requestOptions)
+    execute[Any](request, requestOptions)
   }
 
   /** Retrieves one or more records, potentially from different indices. Records are returned in the same order as the

clients/algoliasearch-client-swift/Sources/Search/SearchClient.swift

@@ -1726,15 +1726,15 @@ open class SearchClient {
     /// to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is
     /// always retrieved.  Attributes included in `unretrievableAttributes` won't be retrieved unless the request is
     /// authenticated with the admin API key.  (optional)
-    /// - returns: [String: String]
+    /// - returns: AnyCodable
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func getObject(
         indexName: String,
         objectID: String,
         attributesToRetrieve: [String]? = nil,
         requestOptions: RequestOptions? = nil
-    ) async throws -> [String: String] {
-        let response: Response<[String: String]> = try await getObjectWithHTTPInfo(
+    ) async throws -> AnyCodable {
+        let response: Response<AnyCodable> = try await getObjectWithHTTPInfo(
             indexName: indexName,
             objectID: objectID,
             attributesToRetrieve: attributesToRetrieve,
@@ -1762,14 +1762,14 @@ open class SearchClient {
     // always
     // retrieved.  Attributes included in `unretrievableAttributes` won't be retrieved unless the request is
     // authenticated with the admin API key.  (optional)
-    // - returns: RequestBuilder<[String: String]>
+    // - returns: RequestBuilder<AnyCodable>
 
     open func getObjectWithHTTPInfo(
         indexName: String,
         objectID: String,
         attributesToRetrieve: [String]? = nil,
         requestOptions userRequestOptions: RequestOptions? = nil
-    ) async throws -> Response<[String: String]> {
+    ) async throws -> Response<AnyCodable> {
         guard !indexName.isEmpty else {
             throw AlgoliaError.invalidArgument("indexName", "getObject")
         }