feat(specs): add recommend batch rules endpoint (generated)

algolia/api-clients-automation#3782

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Raed <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: 4 people

Sources/Recommend/Models/RecommendRule.swift

@@ -17,21 +17,25 @@ public struct RecommendRule: Codable, JSONEncodable {
     public var description: String?
     /// Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
     public var enabled: Bool?
+    /// Time periods when the rule is active.
+    public var validity: [RecommendTimeRange]?
 
     public init(
         metadata: RuleMetadata? = nil,
         objectID: String? = nil,
         condition: RecommendCondition? = nil,
         consequence: RecommendConsequence? = nil,
         description: String? = nil,
-        enabled: Bool? = nil
+        enabled: Bool? = nil,
+        validity: [RecommendTimeRange]? = nil
     ) {
         self.metadata = metadata
         self.objectID = objectID
         self.condition = condition
         self.consequence = consequence
         self.description = description
         self.enabled = enabled
+        self.validity = validity
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
@@ -41,6 +45,7 @@ public struct RecommendRule: Codable, JSONEncodable {
         case consequence
         case description
         case enabled
+        case validity
     }
 
     // Encodable protocol methods
@@ -53,6 +58,7 @@ public struct RecommendRule: Codable, JSONEncodable {
         try container.encodeIfPresent(self.consequence, forKey: .consequence)
         try container.encodeIfPresent(self.description, forKey: .description)
         try container.encodeIfPresent(self.enabled, forKey: .enabled)
+        try container.encodeIfPresent(self.validity, forKey: .validity)
     }
 }
 
@@ -63,7 +69,8 @@ extension RecommendRule: Equatable {
             lhs.condition == rhs.condition &&
             lhs.consequence == rhs.consequence &&
             lhs.description == rhs.description &&
-            lhs.enabled == rhs.enabled
+            lhs.enabled == rhs.enabled &&
+            lhs.validity == rhs.validity
     }
 }
 
@@ -75,5 +82,6 @@ extension RecommendRule: Hashable {
         hasher.combine(self.consequence?.hashValue)
         hasher.combine(self.description?.hashValue)
         hasher.combine(self.enabled?.hashValue)
+        hasher.combine(self.validity?.hashValue)
     }
 }

Sources/Recommend/Models/RecommendTimeRange.swift

@@ -0,0 +1,46 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on
+// https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import Foundation
+#if canImport(Core)
+    import Core
+#endif
+
+public struct RecommendTimeRange: Codable, JSONEncodable {
+    /// When the rule should start to be active, in Unix epoch time.
+    public var from: Int
+    /// When the rule should stop to be active, in Unix epoch time.
+    public var until: Int
+
+    public init(from: Int, until: Int) {
+        self.from = from
+        self.until = until
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case from
+        case until
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.from, forKey: .from)
+        try container.encode(self.until, forKey: .until)
+    }
+}
+
+extension RecommendTimeRange: Equatable {
+    public static func ==(lhs: RecommendTimeRange, rhs: RecommendTimeRange) -> Bool {
+        lhs.from == rhs.from &&
+            lhs.until == rhs.until
+    }
+}
+
+extension RecommendTimeRange: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.from.hashValue)
+        hasher.combine(self.until.hashValue)
+    }
+}

Sources/Recommend/Models/RecommendUpdatedAtResponse.swift

@@ -0,0 +1,49 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on
+// https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import Foundation
+#if canImport(Core)
+    import Core
+#endif
+
+/// Response, taskID, and update timestamp.
+public struct RecommendUpdatedAtResponse: Codable, JSONEncodable {
+    /// Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run
+    /// immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and
+    /// this `taskID`.
+    public var taskID: Int64
+    /// Date and time when the object was updated, in RFC 3339 format.
+    public var updatedAt: String
+
+    public init(taskID: Int64, updatedAt: String) {
+        self.taskID = taskID
+        self.updatedAt = updatedAt
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case taskID
+        case updatedAt
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.taskID, forKey: .taskID)
+        try container.encode(self.updatedAt, forKey: .updatedAt)
+    }
+}
+
+extension RecommendUpdatedAtResponse: Equatable {
+    public static func ==(lhs: RecommendUpdatedAtResponse, rhs: RecommendUpdatedAtResponse) -> Bool {
+        lhs.taskID == rhs.taskID &&
+            lhs.updatedAt == rhs.updatedAt
+    }
+}
+
+extension RecommendUpdatedAtResponse: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.taskID.hashValue)
+        hasher.combine(self.updatedAt.hashValue)
+    }
+}

Sources/Recommend/RecommendClient.swift

@@ -32,6 +32,92 @@ open class RecommendClient {
         self.transporter.setClientApiKey(apiKey: apiKey)
     }
 
+    /// - parameter indexName: (path) Name of the index on which to perform the operation.
+    /// - parameter model: (path) [Recommend
+    /// model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+    /// - parameter recommendRule: (body)  (optional)
+    /// - returns: RecommendUpdatedAtResponse
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    open func batchRecommendRules(
+        indexName: String,
+        model: RecommendModels,
+        recommendRule: [RecommendRule]? = nil,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> RecommendUpdatedAtResponse {
+        let response: Response<RecommendUpdatedAtResponse> = try await batchRecommendRulesWithHTTPInfo(
+            indexName: indexName,
+            model: model,
+            recommendRule: recommendRule,
+            requestOptions: requestOptions
+        )
+
+        guard let body = response.body else {
+            throw AlgoliaError.missingData
+        }
+
+        return body
+    }
+
+    // Create or update a batch of Recommend Rules  Each Recommend Rule is created or updated, depending on whether a
+    // Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in
+    // which case the batch will atomically replace all the existing Recommend Rules.  Recommend Rules are similar to
+    // Search Rules, except that the conditions and consequences apply to a [source
+    // item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the
+    // following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn't require a facet value placeholder (it tries to match the data source item's attributes instead).
+    // Required API Key ACLs:
+    //  - editSettings
+    //
+    // - parameter indexName: (path) Name of the index on which to perform the operation.
+    //
+    // - parameter model: (path) [Recommend
+    // model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+    //
+    // - parameter recommendRule: (body)  (optional)
+    // - returns: RequestBuilder<RecommendUpdatedAtResponse>
+
+    open func batchRecommendRulesWithHTTPInfo(
+        indexName: String,
+        model: RecommendModels,
+        recommendRule: [RecommendRule]? = nil,
+        requestOptions userRequestOptions: RequestOptions? = nil
+    ) async throws -> Response<RecommendUpdatedAtResponse> {
+        guard !indexName.isEmpty else {
+            throw AlgoliaError.invalidArgument("indexName", "batchRecommendRules")
+        }
+
+        var resourcePath = "/1/indexes/{indexName}/{model}/recommend/rules/batch"
+        let indexNamePreEscape = "\(APIHelper.mapValueToPathItem(indexName))"
+        let indexNamePostEscape = indexNamePreEscape
+            .addingPercentEncoding(withAllowedCharacters: .urlPathAlgoliaAllowed) ?? ""
+        resourcePath = resourcePath.replacingOccurrences(
+            of: "{indexName}",
+            with: indexNamePostEscape,
+            options: .literal,
+            range: nil
+        )
+        let modelPreEscape = "\(APIHelper.mapValueToPathItem(model))"
+        let modelPostEscape = modelPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAlgoliaAllowed) ?? ""
+        resourcePath = resourcePath.replacingOccurrences(
+            of: "{model}",
+            with: modelPostEscape,
+            options: .literal,
+            range: nil
+        )
+        let body = recommendRule
+        let queryParameters: [String: Any?]? = nil
+
+        let nillableHeaders: [String: Any?]? = nil
+
+        let headers = APIHelper.rejectNilHeaders(nillableHeaders)
+
+        return try await self.transporter.send(
+            method: "POST",
+            path: resourcePath,
+            data: body ?? AnyCodable(),
+            requestOptions: RequestOptions(headers: headers, queryParameters: queryParameters) + userRequestOptions
+        )
+    }
+
     /// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
     /// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
     /// - returns: AnyCodable

Sources/Search/Models/Rule.swift

@@ -20,15 +20,15 @@ public struct Rule: Codable, JSONEncodable {
     /// Whether the rule is active.
     public var enabled: Bool?
     /// Time periods when the rule is active.
-    public var validity: [TimeRange]?
+    public var validity: [SearchTimeRange]?
 
     public init(
         objectID: String,
         conditions: [SearchCondition]? = nil,
         consequence: SearchConsequence? = nil,
         description: String? = nil,
         enabled: Bool? = nil,
-        validity: [TimeRange]? = nil
+        validity: [SearchTimeRange]? = nil
     ) {
         self.objectID = objectID
         self.conditions = conditions

Sources/Search/Models/TimeRange.swift renamed to Sources/Search/Models/SearchTimeRange.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-public struct TimeRange: Codable, JSONEncodable {
+public struct SearchTimeRange: Codable, JSONEncodable {
     /// When the rule should start to be active, in Unix epoch time.
     public var from: Int
     /// When the rule should stop to be active, in Unix epoch time.
@@ -31,14 +31,14 @@ public struct TimeRange: Codable, JSONEncodable {
     }
 }
 
-extension TimeRange: Equatable {
-    public static func ==(lhs: TimeRange, rhs: TimeRange) -> Bool {
+extension SearchTimeRange: Equatable {
+    public static func ==(lhs: SearchTimeRange, rhs: SearchTimeRange) -> Bool {
         lhs.from == rhs.from &&
             lhs.until == rhs.until
     }
 }
 
-extension TimeRange: Hashable {
+extension SearchTimeRange: Hashable {
     public func hash(into hasher: inout Hasher) {
         hasher.combine(self.from.hashValue)
         hasher.combine(self.until.hashValue)