chore: generated code for commit c0bf5709. [skip ci]

algolia/api-clients-automation@c0bf570

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

Author: algolia-bot

Sources/Abtesting/AbtestingClient.swift

@@ -0,0 +1,39 @@
+//
+//  RequestOptions.swift
+//
+//
+//  Created by Algolia on 11/01/2024.
+//
+
+import Foundation
+
+public class RequestOptions {
+  private(set) var headers: [String: String]
+  private(set) var queryItems: [URLQueryItem]
+  private(set) var readTimeout: TimeInterval?
+  private(set) var writeTimeout: TimeInterval?
+  private(set) var body: [String: Any?]
+
+  public init(
+    headers: [String: String] = [:],
+    queryItems: [URLQueryItem] = [],
+    readTimeout: TimeInterval? = nil,
+    writeTimeout: TimeInterval? = nil,
+    body: [String: Any?] = [:]
+  ) {
+    self.headers = headers
+    self.queryItems = queryItems
+    self.readTimeout = readTimeout
+    self.writeTimeout = writeTimeout
+    self.body = body
+  }
+
+  public func timeout(for callType: CallType) -> TimeInterval? {
+    switch callType {
+    case .read:
+      return readTimeout
+    case .write:
+      return writeTimeout
+    }
+  }
+}

Sources/Analytics/AnalyticsClient.swift

@@ -27,7 +27,7 @@ public struct JSONDataEncoding {
   /// - throws: An `Error` if the encoding process encounters an error.
   ///
   /// - returns: The encoded request.
-  public func encode(_ urlRequest: URLRequest, with parameters: [String: Any]?) -> URLRequest {
+  public func encode(_ urlRequest: URLRequest, with parameters: [String: Any?]?) -> URLRequest {
     var urlRequest = urlRequest
 
     guard let jsonData = parameters?[JSONDataEncoding.jsonDataKey] as? Data, !jsonData.isEmpty
@@ -44,14 +44,25 @@ public struct JSONDataEncoding {
     return urlRequest
   }
 
-  public static func encodingParameters(jsonData: Data?) -> [String: Any]? {
-    var returnedParams: [String: Any]?
+  public static func encodingParameters(jsonData: Data?) -> [String: Any?]? {
+    var returnedParams: [String: Any?]?
     if let jsonData = jsonData, !jsonData.isEmpty {
-      var params: [String: Any] = [:]
+      var params: [String: Any?] = [:]
       params[jsonDataKey] = jsonData
       returnedParams = params
     }
     return returnedParams
   }
 
+  public static func encodingParameters(jsonData: [String: Any?]?) -> [String: Any?]? {
+    var returnedParams: [String: Any?]?
+    let jsonEncodedBody = try? JSONSerialization.data(withJSONObject: jsonData, options: [])
+    if let jsonEncodedBody = jsonEncodedBody, !jsonEncodedBody.isEmpty {
+      var params: [String: Any?] = [:]
+      params[jsonDataKey] = jsonEncodedBody
+      returnedParams = params
+    }
+    return returnedParams
+  }
+
 }

Sources/Core/Common/RequestOptions.swift

@@ -26,30 +26,27 @@ open class Transporter {
 open class RequestBuilder<T> {
   var credential: URLCredential?
   var headers: [String: String]
-  public let parameters: [String: Any]?
+  public var parameters: [String: Any?]?
   public let method: String
   public let path: String
-  public let queryItems: [URLQueryItem]?
+  public var queryItems: [URLQueryItem]
   public let requestTask: RequestTask = RequestTask()
-  public let requiresAuthentication: Bool
   public let hostIterator: HostIterator
+  public let timeout: TimeInterval
 
   public let transporter: Transporter
 
   /// Optional block to obtain a reference to the request's progress instance when available.
   public var onProgressReady: ((Progress) -> Void)?
 
   required public init(
-    method: String, path: String, queryItems: [URLQueryItem]?, parameters: [String: Any]?,
-    headers: [String: String] = [:],
-    requiresAuthentication: Bool, transporter: Transporter
+    method: String, path: String, queryItems: [URLQueryItem]?, parameters: [String: Any?]?,
+    headers: [String: String] = [:], transporter: Transporter, requestOptions: RequestOptions? = nil
   ) {
     self.method = method
     self.path = path
-    self.queryItems = queryItems
-    self.parameters = parameters
+    self.queryItems = queryItems ?? []
     self.headers = headers
-    self.requiresAuthentication = requiresAuthentication
     self.transporter = transporter
 
     let httpMethod = HTTPMethod(rawValue: method)
@@ -59,6 +56,30 @@ open class RequestBuilder<T> {
     }
 
     self.hostIterator = transporter.retryStrategy.retryableHosts(for: httpMethod.toCallType())
+
+    self.timeout =
+      requestOptions?.timeout(for: httpMethod.toCallType())
+      ?? self.transporter.configuration.timeout(for: httpMethod.toCallType())
+
+    if let requestOptions = requestOptions {
+      self.queryItems.append(contentsOf: requestOptions.queryItems)
+
+      for (key, value) in requestOptions.headers {
+        self.headers.updateValue(value, forKey: key)
+      }
+
+      if requestOptions.body == nil && parameters == nil {
+        self.parameters = nil
+        return
+      }
+
+      if requestOptions.body != nil {
+        self.parameters = JSONDataEncoding.encodingParameters(jsonData: requestOptions.body)
+        return
+      }
+    }
+
+    self.parameters = parameters
   }
 
   open func addHeaders(_ aHeaders: [String: String]) {
@@ -106,11 +127,6 @@ open class RequestBuilder<T> {
     }
     return self
   }
-
-  open func addCredential() -> Self {
-    credential = Transporter.credential
-    return self
-  }
 }
 
 public protocol RequestBuilderFactory {

Sources/Core/Helpers/JSONDataEncoding.swift

@@ -60,13 +60,12 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
   public var taskDidReceiveChallenge: AlgoliaSearchClientAPIChallengeHandler?
 
   required public init(
-    method: String, path: String, queryItems: [URLQueryItem]?, parameters: [String: Any]?,
-    headers: [String: String] = [:],
-    requiresAuthentication: Bool, transporter: Transporter
+    method: String, path: String, queryItems: [URLQueryItem]?, parameters: [String: Any?]?,
+    headers: [String: String] = [:], transporter: Transporter, requestOptions: RequestOptions? = nil
   ) {
     super.init(
       method: method, path: path, queryItems: queryItems, parameters: parameters, headers: headers,
-      requiresAuthentication: requiresAuthentication, transporter: transporter)
+      transporter: transporter, requestOptions: requestOptions)
   }
 
   /**
@@ -291,7 +290,7 @@ open class URLSessionDecodableRequestBuilder<T: Decodable>: URLSessionRequestBui
   ) throws -> URLRequest {
     var superReq = try super.createURLRequest(
       urlSession: urlSession, method: method, host: host, encoding: encoding, headers: headers)
-    superReq.timeoutInterval = self.transporter.configuration.timeout(for: method.toCallType())
+    superReq.timeoutInterval = self.timeout
 
     guard let url = superReq.url else { throw URLRequest.FormatError.missingURL }
     guard let components = URLComponents(url: url, resolvingAgainstBaseURL: false) else {
@@ -422,11 +421,11 @@ public enum HTTPMethod: String {
 }
 
 public protocol ParameterEncoding {
-  func encode(_ urlRequest: URLRequest, with parameters: [String: Any]?) throws -> URLRequest
+  func encode(_ urlRequest: URLRequest, with parameters: [String: Any?]?) throws -> URLRequest
 }
 
 private class URLEncoding: ParameterEncoding {
-  func encode(_ urlRequest: URLRequest, with parameters: [String: Any]?) throws -> URLRequest {
+  func encode(_ urlRequest: URLRequest, with parameters: [String: Any?]?) throws -> URLRequest {
 
     var urlRequest = urlRequest