Release: v6.1.0

- Added support for `reqlExpressions` on recommended item segments
- Formatting

Author: MichalDemko

README.md

@@ -46,7 +46,7 @@ https://github.com/recombee/swift-api-client
 Alternatively, in `Package.swift`:
 
 ```swift
-.package(url: "https://github.com/recombee/swift-api-client", from: "6.0.0")
+.package(url: "https://github.com/recombee/swift-api-client", from: "6.1.0")
 ```
 
 Then add to your target dependencies:

Sources/RecombeeClient/Requests/AddBookmark.swift

@@ -15,16 +15,16 @@ public struct AddBookmark: Request {
     public let itemId: String
 
     /// UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-    public var timestamp: Date? = nil
+    public var timestamp: Date?
 
     /// Sets whether the given user/item should be created if not present in the database.
     public var cascadeCreate: Bool? = true
 
     /// If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-    public var recommId: String? = nil
+    public var recommId: String?
 
     /// A dictionary of additional data for the interaction.
-    public var additionalData: JSONDictionary? = nil
+    public var additionalData: JSONDictionary?
 
     /// Initializes AddBookmark request
     /// - Parameters:

Sources/RecombeeClient/Requests/AddCartAddition.swift

@@ -15,22 +15,22 @@ public struct AddCartAddition: Request {
     public let itemId: String
 
     /// UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-    public var timestamp: Date? = nil
+    public var timestamp: Date?
 
     /// Sets whether the given user/item should be created if not present in the database.
     public var cascadeCreate: Bool? = true
 
     /// Amount (number) added to cart. The default is 1. For example, if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal 2.
-    public var amount: Double? = nil
+    public var amount: Double?
 
     /// Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
-    public var price: Double? = nil
+    public var price: Double?
 
     /// If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-    public var recommId: String? = nil
+    public var recommId: String?
 
     /// A dictionary of additional data for the interaction.
-    public var additionalData: JSONDictionary? = nil
+    public var additionalData: JSONDictionary?
 
     /// Initializes AddCartAddition request
     /// - Parameters:

Sources/RecombeeClient/Requests/AddDetailView.swift

@@ -15,22 +15,22 @@ public struct AddDetailView: Request {
     public let itemId: String
 
     /// UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-    public var timestamp: Date? = nil
+    public var timestamp: Date?
 
     /// Duration of the view
-    public var duration: Int? = nil
+    public var duration: Int?
 
     /// Sets whether the given user/item should be created if not present in the database.
     public var cascadeCreate: Bool? = true
 
     /// If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-    public var recommId: String? = nil
+    public var recommId: String?
 
     /// A dictionary of additional data for the interaction.
-    public var additionalData: JSONDictionary? = nil
+    public var additionalData: JSONDictionary?
 
     /// Indicates whether the item was automatically presented to the user (e.g., in a swiping feed) or explicitly requested by the user (e.g., by clicking on a link). Defaults to `false`.
-    public var autoPresented: Bool? = nil
+    public var autoPresented: Bool?
 
     /// Initializes AddDetailView request
     /// - Parameters:

Sources/RecombeeClient/Requests/AddPurchase.swift

@@ -15,25 +15,25 @@ public struct AddPurchase: Request {
     public let itemId: String
 
     /// UTC timestamp of the purchase as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-    public var timestamp: Date? = nil
+    public var timestamp: Date?
 
     /// Sets whether the given user/item should be created if not present in the database.
     public var cascadeCreate: Bool? = true
 
     /// Amount (number) of purchased items. The default is 1. For example, if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal 2.
-    public var amount: Double? = nil
+    public var amount: Double?
 
     /// Price paid by the user for the item. If `amount` is greater than 1, the sum of prices of all the items should be given.
-    public var price: Double? = nil
+    public var price: Double?
 
     /// Your profit from the purchased item. The profit is natural in the e-commerce domain (for example, if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30) but is also applicable in other domains (for example, at a news company it may be income from a displayed advertisement on article page). If `amount` is greater than 1, the sum of profit of all the items should be given.
-    public var profit: Double? = nil
+    public var profit: Double?
 
     /// If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-    public var recommId: String? = nil
+    public var recommId: String?
 
     /// A dictionary of additional data for the interaction.
-    public var additionalData: JSONDictionary? = nil
+    public var additionalData: JSONDictionary?
 
     /// Initializes AddPurchase request
     /// - Parameters:

Sources/RecombeeClient/Requests/AddRating.swift

@@ -18,16 +18,16 @@ public struct AddRating: Request {
     public let rating: Double
 
     /// UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-    public var timestamp: Date? = nil
+    public var timestamp: Date?
 
     /// Sets whether the given user/item should be created if not present in the database.
     public var cascadeCreate: Bool? = true
 
     /// If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-    public var recommId: String? = nil
+    public var recommId: String?
 
     /// A dictionary of additional data for the interaction.
-    public var additionalData: JSONDictionary? = nil
+    public var additionalData: JSONDictionary?
 
     /// Initializes AddRating request
     /// - Parameters:

Sources/RecombeeClient/Requests/Batch.swift

@@ -8,7 +8,7 @@ public struct Batch: Request {
     public let requests: [any Request]
 
     /// Whether to return distinct recommendations across all batched requests (default is false).
-    public var distinctRecomms: Bool? = nil
+    public var distinctRecomms: Bool?
 
     public var path: String { "/batch/" }
     public var method: HTTPMethod { .POST }

Sources/RecombeeClient/Requests/CompositeRecommendation.swift

@@ -37,38 +37,38 @@ public struct CompositeRecommendation: Request {
 
     /// ID of the item for which the recommendations are to be generated.
 
-    public var itemId: String? = nil
+    public var itemId: String?
 
     /// ID of the user for which the recommendations are to be generated.
 
-    public var userId: String? = nil
+    public var userId: String?
 
     /// Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
     /// See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
     /// The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
     /// Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
 
-    public var logic: Logic? = nil
+    public var logic: Logic?
 
     /// ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
 
-    public var segmentId: String? = nil
+    public var segmentId: String?
 
     /// If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
 
     public var cascadeCreate: Bool? = true
 
     /// Parameters applied for recommending the *Source* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Source*.
 
-    public var sourceSettings: CompositeRecommendationStageParameters? = nil
+    public var sourceSettings: CompositeRecommendationStageParameters?
 
     /// Parameters applied for recommending the *Result* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Result*.
 
-    public var resultSettings: CompositeRecommendationStageParameters? = nil
+    public var resultSettings: CompositeRecommendationStageParameters?
 
     /// Dictionary of custom options.
 
-    public var expertSettings: JSONDictionary? = nil
+    public var expertSettings: JSONDictionary?
 
     /// Initializes CompositeRecommendation request
     /// - Parameters:

Sources/RecombeeClient/Requests/RecommendItemSegmentsToItem.swift

@@ -43,34 +43,70 @@ public struct RecommendItemSegmentsToItem: Request {
     /// You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
     /// The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
 
-    public var scenario: String? = nil
+    public var scenario: String?
 
     /// If the user does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, as the user will be already known to the system.
 
     public var cascadeCreate: Bool? = true
 
     /// Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
 
-    public var filter: String? = nil
+    public var filter: String?
 
     /// Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
 
-    public var booster: String? = nil
+    public var booster: String?
 
     /// Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
     /// See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
     /// The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
     /// Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
 
-    public var logic: Logic? = nil
+    public var logic: Logic?
 
     /// Dictionary of custom options.
 
-    public var expertSettings: JSONDictionary? = nil
+    public var expertSettings: JSONDictionary?
 
     /// If there is a custom AB-testing running, return the name of the group to which the request belongs.
 
-    public var returnAbGroup: Bool? = nil
+    public var returnAbGroup: Bool?
+
+    /// A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+    /// This can be used to compute additional properties of the recommended Item Segments.
+    /// The keys are the names of the expressions, and the values are the actual ReQL expressions.
+    /// Example request:
+    /// ```json
+    /// {
+    ///   "reqlExpressions": {
+    ///     "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+    ///   }
+    /// }
+    /// ```
+    /// Example response:
+    /// ```json
+    /// {
+    ///   "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+    ///   "recomms":
+    ///     [
+    ///       {
+    ///         "id": "category-fantasy-books",
+    ///         "reqlEvaluations": {
+    ///           "countItems": 486
+    ///         }
+    ///       },
+    ///       {
+    ///         "id": "category-sci-fi-costumes",
+    ///         "reqlEvaluations": {
+    ///           "countItems": 19
+    ///         }
+    ///       }
+    ///     ],
+    ///    "numberNextRecommsCalls": 0
+    /// }
+    /// ```
+
+    public var reqlExpressions: JSONDictionary?
 
     /// Initializes RecommendItemSegmentsToItem request
     /// - Parameters:
@@ -101,8 +137,41 @@ public struct RecommendItemSegmentsToItem: Request {
     /// Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
     ///   - expertSettings: Dictionary of custom options.
     ///   - returnAbGroup: If there is a custom AB-testing running, return the name of the group to which the request belongs.
-
-    public init(itemId: String, targetUserId: String, count: Int, scenario: String? = nil, cascadeCreate: Bool? = true, filter: String? = nil, booster: String? = nil, logic: Logic? = nil, expertSettings: JSONDictionary? = nil, returnAbGroup: Bool? = nil) {
+    ///   - reqlExpressions: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+    /// This can be used to compute additional properties of the recommended Item Segments.
+    /// The keys are the names of the expressions, and the values are the actual ReQL expressions.
+    /// Example request:
+    /// ```json
+    /// {
+    ///   "reqlExpressions": {
+    ///     "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+    ///   }
+    /// }
+    /// ```
+    /// Example response:
+    /// ```json
+    /// {
+    ///   "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+    ///   "recomms":
+    ///     [
+    ///       {
+    ///         "id": "category-fantasy-books",
+    ///         "reqlEvaluations": {
+    ///           "countItems": 486
+    ///         }
+    ///       },
+    ///       {
+    ///         "id": "category-sci-fi-costumes",
+    ///         "reqlEvaluations": {
+    ///           "countItems": 19
+    ///         }
+    ///       }
+    ///     ],
+    ///    "numberNextRecommsCalls": 0
+    /// }
+    /// ```
+
+    public init(itemId: String, targetUserId: String, count: Int, scenario: String? = nil, cascadeCreate: Bool? = true, filter: String? = nil, booster: String? = nil, logic: Logic? = nil, expertSettings: JSONDictionary? = nil, returnAbGroup: Bool? = nil, reqlExpressions: JSONDictionary? = nil) {
         self.itemId = itemId
         self.targetUserId = targetUserId
         self.count = count
@@ -113,6 +182,7 @@ public struct RecommendItemSegmentsToItem: Request {
         self.logic = logic
         self.expertSettings = expertSettings
         self.returnAbGroup = returnAbGroup
+        self.reqlExpressions = reqlExpressions
     }
 
     /// The API path for the request
@@ -167,6 +237,10 @@ public struct RecommendItemSegmentsToItem: Request {
             body["returnAbGroup"] = returnAbGroup
         }
 
+        if let reqlExpressions = reqlExpressions {
+            body["reqlExpressions"] = reqlExpressions
+        }
+
         return body
     }
 }