fix(clients): %s/setApiKey/setAlgoliaApiKey

Author: Fluf22

clients/algoliasearch-client-dart/packages/client_core/lib/src/api_client.dart

@@ -12,7 +12,7 @@ abstract interface class ApiClient {
   ClientOptions get options;
 
   /// Allow switching the API key used to authenticate requests.
-  void setApiKey(String apiKey);
+  void setAlgoliaApiKey(String apiKey);
 
   /// Dispose of underlying resources.
   void dispose();

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/dio/dio_requester.dart

@@ -116,7 +116,7 @@ class DioRequester implements Requester {
   void close() => _client.close();
 
   @override
-  void setApiKey(String apiKey) {
+  void setAlgoliaApiKey(String apiKey) {
     var authInterceptor = _client.interceptors
         .firstWhere((element) => element is AuthInterceptor) as AuthInterceptor;
     _client.interceptors.remove(authInterceptor);

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/requester.dart

@@ -12,7 +12,7 @@ abstract class Requester {
   Future<HttpResponse> perform(HttpRequest request);
 
   /// Allows to switch the API key used to authenticate requests.
-  void setApiKey(String apiKey);
+  void setAlgoliaApiKey(String apiKey);
 
   /// Closes any underlying resources that the Requester might be using.
   ///

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/config/Requester.java

@@ -4,35 +4,40 @@
 import java.io.Closeable;
 
 /**
- * Represents a mechanism for executing HTTP requests and deserializing responses. It provides
- * methods for making requests and returning the desired object representation. Implementations of
+ * Represents a mechanism for executing HTTP requests and deserializing
+ * responses. It provides
+ * methods for making requests and returning the desired object representation.
+ * Implementations of
  * this interface should ensure proper resource management.
  */
 public interface Requester extends Closeable {
   /**
-   * Executes an HTTP request and deserializes the response into a specified Java type.
+   * Executes an HTTP request and deserializes the response into a specified Java
+   * type.
    *
-   * @param <T> The type of the returned object.
-   * @param httpRequest The HTTP request to be executed.
+   * @param <T>            The type of the returned object.
+   * @param httpRequest    The HTTP request to be executed.
    * @param requestOptions Optional request options.
-   * @param returnType The class of the response.
-   * @param innerType The inner class type if the response is a container type.
+   * @param returnType     The class of the response.
+   * @param innerType      The inner class type if the response is a container
+   *                       type.
    * @return The deserialized response.
    */
   <T> T execute(HttpRequest httpRequest, RequestOptions requestOptions, Class<?> returnType, Class<?> innerType);
 
   /**
-   * Executes an HTTP request and deserializes the response into a specified type reference.
+   * Executes an HTTP request and deserializes the response into a specified type
+   * reference.
    *
-   * @param <T> The type of the returned object.
-   * @param httpRequest The HTTP request to be executed.
+   * @param <T>            The type of the returned object.
+   * @param httpRequest    The HTTP request to be executed.
    * @param requestOptions Optional request options.
-   * @param returnType The type reference of the response.
+   * @param returnType     The type reference of the response.
    * @return The deserialized response.
    */
   <T> T execute(HttpRequest httpRequest, RequestOptions requestOptions, TypeReference<?> returnType);
 
-  default void setApiKey(String apiKey) {
+  default void setAlgoliaApiKey(String apiKey) {
     System.out.println("Nothing to do here");
   }
 }

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/HttpRequester.java

@@ -20,8 +20,10 @@
 import okio.BufferedSink;
 
 /**
- * HttpRequester is responsible for making HTTP requests using the OkHttp client. It provides a
- * mechanism for request serialization and deserialization using a given {@link JsonSerializer}.
+ * HttpRequester is responsible for making HTTP requests using the OkHttp
+ * client. It provides a
+ * mechanism for request serialization and deserialization using a given
+ * {@link JsonSerializer}.
  */
 public final class HttpRequester implements Requester {
 
@@ -33,11 +35,11 @@ public final class HttpRequester implements Requester {
   /** Private constructor initialized using the builder pattern. */
   private HttpRequester(Builder builder, ClientConfig config) {
     OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder()
-      .connectTimeout(config.getConnectTimeout())
-      .readTimeout(config.getReadTimeout())
-      .writeTimeout(config.getWriteTimeout())
-      .addInterceptor(new HeaderInterceptor(config.getDefaultHeaders()))
-      .addNetworkInterceptor(new LogInterceptor(config.getLogger(), config.getLogLevel()));
+        .connectTimeout(config.getConnectTimeout())
+        .readTimeout(config.getReadTimeout())
+        .writeTimeout(config.getWriteTimeout())
+        .addInterceptor(new HeaderInterceptor(config.getDefaultHeaders()))
+        .addNetworkInterceptor(new LogInterceptor(config.getLogger(), config.getLogLevel()));
     builder.interceptors.forEach(clientBuilder::addInterceptor);
     builder.networkInterceptors.forEach(clientBuilder::addNetworkInterceptor);
     if (config.getCompressionType() == CompressionType.GZIP) {
@@ -51,7 +53,8 @@ private HttpRequester(Builder builder, ClientConfig config) {
   }
 
   @Override
-  public <T> T execute(HttpRequest httpRequest, RequestOptions requestOptions, Class<?> returnType, Class<?> innerType) {
+  public <T> T execute(HttpRequest httpRequest, RequestOptions requestOptions, Class<?> returnType,
+      Class<?> innerType) {
     return execute(httpRequest, requestOptions, serializer.getJavaType(returnType, innerType));
   }
 
@@ -61,7 +64,7 @@ public <T> T execute(HttpRequest httpRequest, RequestOptions requestOptions, Typ
   }
 
   @Override
-  public void setApiKey(@Nonnull String apiKey) {
+  public void setAlgoliaApiKey(@Nonnull String apiKey) {
     this.httpClient.interceptors().add(new HeaderInterceptor(Collections.singletonMap("X-Algolia-API-Key", apiKey)));
   }
 
@@ -77,7 +80,8 @@ private <T> T execute(@Nonnull HttpRequest httpRequest, RequestOptions requestOp
     RequestBody requestBody = createRequestBody(httpRequest);
 
     // Build the HTTP request.
-    Request request = new Request.Builder().url(url).headers(headers).method(httpRequest.getMethod(), requestBody).build();
+    Request request = new Request.Builder().url(url).headers(headers).method(httpRequest.getMethod(), requestBody)
+        .build();
 
     // Get or adjust the HTTP client according to request options.
     OkHttpClient client = getOkHttpClient(requestOptions);
@@ -106,9 +110,9 @@ private <T> T execute(@Nonnull HttpRequest httpRequest, RequestOptions requestOp
   @Nonnull
   private static HttpUrl createHttpUrl(@Nonnull HttpRequest request, RequestOptions requestOptions) {
     HttpUrl.Builder urlBuilder = new HttpUrl.Builder()
-      .scheme("https")
-      .host("algolia.com") // will be overridden by the retry strategy
-      .encodedPath(request.getPath());
+        .scheme("https")
+        .host("algolia.com") // will be overridden by the retry strategy
+        .encodedPath(request.getPath());
     request.getQueryParameters().forEach(urlBuilder::addEncodedQueryParameter);
     if (requestOptions != null) {
       requestOptions.getQueryParameters().forEach(urlBuilder::addEncodedQueryParameter);
@@ -156,13 +160,18 @@ private Headers createHeaders(@Nonnull HttpRequest request, RequestOptions reque
     return builder.build();
   }
 
-  /** Returns a suitable OkHttpClient instance based on the provided request options. */
+  /**
+   * Returns a suitable OkHttpClient instance based on the provided request
+   * options.
+   */
   @Nonnull
   private OkHttpClient getOkHttpClient(RequestOptions requestOptions) {
     // Return the default client if no request options are provided.
-    if (requestOptions == null) return httpClient;
+    if (requestOptions == null)
+      return httpClient;
 
-    // Create a new client builder from the default client and adjust timeouts if provided.
+    // Create a new client builder from the default client and adjust timeouts if
+    // provided.
     OkHttpClient.Builder builder = httpClient.newBuilder();
     if (requestOptions.getReadTimeout() != null) {
       builder.readTimeout(requestOptions.getReadTimeout());
@@ -175,7 +184,8 @@ private OkHttpClient getOkHttpClient(RequestOptions requestOptions) {
 
   @Override
   public void close() throws IOException {
-    if (isClosed.get()) return;
+    if (isClosed.get())
+      return;
     httpClient.dispatcher().executorService().shutdown();
     httpClient.connectionPool().evictAll();
     if (httpClient.cache() != null) {
@@ -185,7 +195,8 @@ public void close() throws IOException {
   }
 
   /**
-   * The Builder class for HttpRequester. It provides a mechanism for constructing an instance of
+   * The Builder class for HttpRequester. It provides a mechanism for constructing
+   * an instance of
    * HttpRequester with customized configurations.
    */
   public static class Builder {

clients/algoliasearch-client-javascript/packages/client-common/src/createAuth.ts

@@ -7,7 +7,7 @@ export function createAuth(
 ): {
   readonly headers: () => Headers;
   readonly queryParameters: () => QueryParameters;
-  readonly setApiKey: (newApiKey: string) => void;
+  readonly setAlgoliaApiKey: (newApiKey: string) => void;
 } {
   const credentials = {
     'x-algolia-api-key': apiKey,
@@ -23,7 +23,7 @@ export function createAuth(
       return authMode === 'WithinQueryParameters' ? credentials : {};
     },
 
-    setApiKey(newApiKey: string): void {
+    setAlgoliaApiKey(newApiKey: string): void {
       credentials['x-algolia-api-key'] = newApiKey;
     },
   };

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/Requester.kt

@@ -31,7 +31,7 @@ public interface Requester {
     returnType: TypeInfo,
   ): T
 
-  public fun setApiKey(apiKey: String) {
+  public fun setAlgoliaApiKey(apiKey: String) {
     println("Nothing to do here")
   }
 }

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/internal/KtorRequester.kt

@@ -39,11 +39,13 @@ public class KtorRequester(
   private val mutex: Mutex = Mutex()
   private val retryableHosts = hosts.map { RetryableHost(it) }
 
-  override fun setApiKey(apiKey: String) {
+  override fun setAlgoliaApiKey(apiKey: String) {
     httpClient.config {
       defaultRequest {
         headers {
-          remove(HEADER_APIKEY)
+          if (contains(HEADER_APIKEY)) {
+            remove(HEADER_APIKEY)
+          }
           append(HEADER_APIKEY, apiKey)
         }
       }

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/ApiClient.scala

@@ -90,7 +90,7 @@ abstract class ApiClient(
     Try(requester.close())
   }
 
-  def setApiKey(apiKey: String): Unit = {
-    requester.setApiKey(apiKey)
+  def setAlgoliaApiKey(apiKey: String): Unit = {
+    requester.setAlgoliaApiKey(apiKey)
   }
 }

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/config/Requester.scala

@@ -22,7 +22,7 @@ trait Requester extends AutoCloseable {
       requestOptions: Option[RequestOptions]
   ): T
 
-  def setApiKey(apiKey: String): Unit = {
+  def setAlgoliaApiKey(apiKey: String): Unit = {
     println("Nothing to do here")
   }
 }

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/internal/HttpRequester.scala

@@ -44,7 +44,7 @@ private[algoliasearch] class HttpRequester private (
     clientBuilder.build()
   }
 
-  override def setApiKey(apiKey: String): Unit = {
+  override def setAlgoliaApiKey(apiKey: String): Unit = {
     httpClient.newBuilder().addInterceptor(new Interceptor {
       override def intercept(chain: Interceptor.Chain): Response = {
         val request = chain.request().newBuilder().addHeader("X-Algolia-API-Key", apiKey).build()

clients/algoliasearch-client-swift/Sources/Core/Networking/Transporter.swift

@@ -43,7 +43,7 @@ open class Transporter {
         self.requestBuilder = requestBuilder
     }
 
-    public func setApiKey(apiKey: String) {
+    public func setAlgoliaApiKey(apiKey: String) {
         self.configuration.defaultHeaders?.updateValue(apiKey, forKey: "X-Algolia-API-Key")
     }
 

templates/dart/api.mustache

@@ -82,9 +82,9 @@ final class {{classname}} implements ApiClient {
 
   /// Allows to switch the API key used to authenticate requests.
   @override
-  void setApiKey(String apiKey) {
+  void setAlgoliaApiKey(String apiKey) {
     this.apiKey = apiKey;
-    this._retryStrategy.requester.setApiKey(apiKey);
+    this._retryStrategy.requester.setAlgoliaApiKey(apiKey);
   }
   {{#operation}}
 
@@ -221,4 +221,4 @@ final class {{classname}} implements ApiClient {
   @override
   void dispose() => _retryStrategy.dispose(); 
 }
-{{/operations}}
+{{/operations}}

templates/java/api.mustache

@@ -135,8 +135,8 @@ public class {{classname}} extends ApiClient {
    * 
    * @param apiKey The new API key to be used from now on.
    */
-  public void setApiKey(@Nonnull String apiKey) {
-    this.requester.setApiKey(apiKey);
+  public void setAlgoliaApiKey(@Nonnull String apiKey) {
+    this.requester.setAlgoliaApiKey(apiKey);
   }
 
     {{#operation}}
@@ -250,4 +250,4 @@ public class {{classname}} extends ApiClient {
 
   {{> api_helpers}}
 }
-{{/operations}}
+{{/operations}}

templates/javascript/clients/api-single.mustache

@@ -80,8 +80,8 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
     *
     * @param apiKey - The new API Key to use.
     */
-    setApiKey(apiKey: string): void {
-      auth.setApiKey(apiKey);
+    setAlgoliaApiKey(apiKey: string): void {
+      auth.setAlgoliaApiKey(apiKey);
     },
 
     {{#isSearchClient}}
@@ -159,4 +159,4 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
   };
 }
 
-{{/operations}}
+{{/operations}}

templates/kotlin/api.mustache

@@ -12,24 +12,16 @@ import kotlinx.serialization.json.*
 {{#operations}}
 public class {{classname}}(
   override val appId: String,
-  apiKey: String,
+  override var apiKey: String,
   {{#hasRegionalHost}}
   public val region: String{{#fallbackToAliasHost}}? = null{{/fallbackToAliasHost}},
   {{/hasRegionalHost}}
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {
 
-  public override var apiKey: String = ""
-    set(value) {
-      field = value
-      requester.setApiKey(value)
-    }
-
   init {
       require(appId.isNotBlank()) { "`appId` is missing." }
       require(apiKey.isNotBlank()) { "`apiKey` is missing." }
-
-      this.apiKey = apiKey
   }
 
   override val requester: Requester = requesterOf(clientName = "{{{baseName}}}", appId = appId, apiKey = apiKey, options = options) {
@@ -63,6 +55,14 @@ public class {{classname}}(
   {{/hostsWithoutVariables.size}}
   }
 
+  /**
+   * Helper method to switch the API key used to authenticate requests.
+   */
+  public fun setAlgoliaApiKey(apiKey: String) {
+    this.apiKey = apiKey
+    this.requester.setAlgoliaApiKey(apiKey)
+  }
+
   {{#operation}}
 
   /**

templates/php/api.mustache

@@ -160,7 +160,7 @@ use {{invokerPackage}}\Support\Helpers;
      * @return void
      *
      */
-    public function setApiKey($apiKey) {
+    public function setAlgoliaApiKey($apiKey) {
       $this->config->setAlgoliaApiKey($apiKey);
     }
 

templates/python/api.mustache

@@ -81,9 +81,9 @@ class {{classname}}:
         """Closes the underlying `transporter` of the API client."""
         return await self._transporter.close()
 
-    def set_api_key(self, api_key: str) -> None:
+    def set_algolia_api_key(self, api_key: str) -> None:
         """Sets a new API key to authenticate requests."""
-        self._transporter.set_api_key(api_key)
+        self._transporter.set_algolia_api_key(api_key)
 
     {{#isSearchClient}}
 {{> search_helpers}}
@@ -190,4 +190,4 @@ class {{classname}}:
         return (await self.{{operationId}}_with_http_info({{#allParams}}{{paramName}},{{/allParams}}request_options)).deserialize({{{returnType}}})
 
 {{/operation}}
-{{/operations}}
+{{/operations}}