feat(clients): helper to switch API key in use (generated)

algolia/api-clients-automation#3616

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: 3 people

client/src/commonMain/kotlin/com/algolia/client/api/AbtestingClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class AbtestingClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   public val region: String? = null,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {

client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class AnalyticsClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   public val region: String? = null,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {

client/src/commonMain/kotlin/com/algolia/client/api/ApiClient.kt

@@ -12,7 +12,15 @@ import com.algolia.client.transport.Requester
  */
 public sealed interface ApiClient {
   public val appId: String
-  public val apiKey: String
+  public var apiKey: String
   public val options: ClientOptions
   public val requester: Requester
+
+  /**
+   * Helper method to switch the API key used to authenticate requests.
+   */
+  public fun setClientApiKey(apiKey: String) {
+    this.apiKey = apiKey
+    this.requester.setClientApiKey(apiKey)
+  }
 }

client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class IngestionClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   public val region: String,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {

client/src/commonMain/kotlin/com/algolia/client/api/InsightsClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class InsightsClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   public val region: String? = null,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {

client/src/commonMain/kotlin/com/algolia/client/api/MonitoringClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class MonitoringClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {
 

client/src/commonMain/kotlin/com/algolia/client/api/PersonalizationClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class PersonalizationClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   public val region: String,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {

client/src/commonMain/kotlin/com/algolia/client/api/QuerySuggestionsClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class QuerySuggestionsClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   public val region: String,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {

client/src/commonMain/kotlin/com/algolia/client/api/RecommendClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class RecommendClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {
 

client/src/commonMain/kotlin/com/algolia/client/api/SearchClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class SearchClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {
 

client/src/commonMain/kotlin/com/algolia/client/api/UsageClient.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 
 public class UsageClient(
   override val appId: String,
-  override val apiKey: String,
+  override var apiKey: String,
   override val options: ClientOptions = ClientOptions(),
 ) : ApiClient {
 

client/src/commonMain/kotlin/com/algolia/client/configuration/internal/HttpClient.kt

@@ -9,7 +9,7 @@ import io.ktor.client.request.*
 import io.ktor.serialization.kotlinx.json.*
 
 private const val HEADER_APPLICATION_ID = "x-algolia-application-id"
-private const val HEADER_APIKEY = "x-algolia-api-key"
+public const val HEADER_APIKEY: String = "x-algolia-api-key"
 
 internal fun algoliaHttpClient(
   appId: String,

client/src/commonMain/kotlin/com/algolia/client/transport/Requester.kt

@@ -30,4 +30,6 @@ public interface Requester {
     requestOptions: RequestOptions? = null,
     returnType: TypeInfo,
   ): T
+
+  public fun setClientApiKey(apiKey: String)
 }

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

@@ -2,6 +2,7 @@ package com.algolia.client.transport.internal
 
 import com.algolia.client.configuration.CallType
 import com.algolia.client.configuration.Host
+import com.algolia.client.configuration.internal.HEADER_APIKEY
 import com.algolia.client.exception.AlgoliaRetryException
 import com.algolia.client.exception.internal.asApiException
 import com.algolia.client.exception.internal.asClientException
@@ -38,6 +39,15 @@ public class KtorRequester(
   private val mutex: Mutex = Mutex()
   private val retryableHosts = hosts.map { RetryableHost(it) }
 
+  public override fun setClientApiKey(apiKey: String) {
+    headers {
+      if (contains(HEADER_APIKEY)) {
+        remove(HEADER_APIKEY)
+      }
+      append(HEADER_APIKEY, apiKey)
+    }
+  }
+
   override suspend fun <T> execute(
     requestConfig: RequestConfig,
     requestOptions: RequestOptions?,