chore: generated code for commit 60e8e6d6. [skip ci]

algolia/api-clients-automation@60e8e6d

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

Author: 4 people

Sources/Ingestion/IngestionClient.swift

@@ -1272,7 +1272,7 @@ open class IngestionClient {
         itemsPerPage: Int? = nil,
         page: Int? = nil,
         status: [EventStatus]? = nil,
-        type: [EventType]? = nil,
+        type: [IngestionEventType]? = nil,
         sort: EventSortKeys? = nil,
         order: OrderKeys? = nil,
         startDate: String? = nil,
@@ -1331,7 +1331,7 @@ open class IngestionClient {
         itemsPerPage: Int? = nil,
         page: Int? = nil,
         status: [EventStatus]? = nil,
-        type: [EventType]? = nil,
+        type: [IngestionEventType]? = nil,
         sort: EventSortKeys? = nil,
         order: OrderKeys? = nil,
         startDate: String? = nil,

Sources/Ingestion/Models/Event.swift

@@ -15,7 +15,7 @@ public struct Event: Codable, JSONEncodable {
     /// The parent event, the cause of this event.
     public var parentID: String?
     public var status: EventStatus
-    public var type: EventType
+    public var type: IngestionEventType
     /// The extracted record batch size.
     public var batchSize: Int
     public var data: [String: AnyCodable]?
@@ -27,7 +27,7 @@ public struct Event: Codable, JSONEncodable {
         runID: String,
         parentID: String? = nil,
         status: EventStatus,
-        type: EventType,
+        type: IngestionEventType,
         batchSize: Int,
         data: [String: AnyCodable]? = nil,
         publishedAt: String

Sources/Ingestion/Models/EventType.swift renamed to Sources/Ingestion/Models/IngestionEventType.swift

@@ -6,11 +6,11 @@ import Foundation
     import Core
 #endif
 
-public enum EventType: String, Codable, CaseIterable {
+public enum IngestionEventType: String, Codable, CaseIterable {
     case fetch
     case record
     case log
     case transform
 }
 
-extension EventType: Hashable {}
+extension IngestionEventType: Hashable {}

Sources/Personalization/Models/DeleteUserProfileResponse.swift

@@ -7,10 +7,11 @@ import Foundation
 #endif
 
 public struct DeleteUserProfileResponse: Codable, JSONEncodable {
-    /// userToken representing the user for which to fetch the Personalization profile.
+    /// Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events.
+    /// For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
     public var userToken: String
-    /// A date until which the data can safely be considered as deleted for the given user. Any data received after the
-    /// `deletedUntil` date will start building a new user profile.
+    /// Date and time when the user profile can be safely considered to be deleted. Any events received after the
+    /// `deletedUntil` date start a new user profile.
     public var deletedUntil: String
 
     public init(userToken: String, deletedUntil: String) {

Sources/Personalization/Models/EventScoring.swift

@@ -7,14 +7,13 @@ import Foundation
 #endif
 
 public struct EventScoring: Codable, JSONEncodable {
-    /// The score for the event.
+    /// Event score.
     public var score: Int
-    /// The name of the event.
+    /// Event name.
     public var eventName: String
-    /// The type of the event.
-    public var eventType: String
+    public var eventType: PersonalizationEventType
 
-    public init(score: Int, eventName: String, eventType: String) {
+    public init(score: Int, eventName: String, eventType: PersonalizationEventType) {
         self.score = score
         self.eventName = eventName
         self.eventType = eventType

Sources/Personalization/Models/FacetScoring.swift

@@ -7,9 +7,9 @@ import Foundation
 #endif
 
 public struct FacetScoring: Codable, JSONEncodable {
-    /// The score for the event.
+    /// Event score.
     public var score: Int
-    /// The name of the facet.
+    /// Facet attribute name.
     public var facetName: String
 
     public init(score: Int, facetName: String) {

Sources/Personalization/Models/GetUserTokenResponse.swift

@@ -7,11 +7,13 @@ import Foundation
 #endif
 
 public struct GetUserTokenResponse: Codable, JSONEncodable {
-    /// userToken representing the user for which to fetch the Personalization profile.
+    /// Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events.
+    /// For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
     public var userToken: String
-    /// Date of last event update. (ISO-8601 format).
+    /// Date and time of the last event from this user, in RFC 3339 format.
     public var lastEventAt: String
-    /// The userToken scores.
+    /// Scores for different facet values.  Scores represent the user affinity for a user profile towards specific facet
+    /// values, given the personalization strategy and past events.
     public var scores: AnyCodable
 
     public init(userToken: String, lastEventAt: String, scores: AnyCodable) {

Sources/Personalization/Models/PersonalizationEventType.swift

@@ -0,0 +1,16 @@
+// 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
+
+/// Event type.
+public enum PersonalizationEventType: String, Codable, CaseIterable {
+    case click
+    case conversion
+    case view
+}
+
+extension PersonalizationEventType: Hashable {}

Sources/Personalization/Models/PersonalizationStrategyParams.swift

@@ -7,12 +7,14 @@ import Foundation
 #endif
 
 public struct PersonalizationStrategyParams: Codable, JSONEncodable {
-    /// Scores associated with the events.
+    /// Scores associated with each event.  The higher the scores, the higher the impact of those events on the
+    /// personalization of search results.
     public var eventScoring: [EventScoring]
-    /// Scores associated with the facets.
+    /// Scores associated with each facet.  The higher the scores, the higher the impact of those events on the
+    /// personalization of search results.
     public var facetScoring: [FacetScoring]
-    /// The impact that personalization has on search results: a number between 0 (personalization disabled) and 100
-    /// (personalization fully enabled).
+    /// Impact of personalization on the search results.  If set to 0, personalization has no impact on the search
+    /// results.
     public var personalizationImpact: Int
 
     public init(eventScoring: [EventScoring], facetScoring: [FacetScoring], personalizationImpact: Int) {

Sources/Personalization/PersonalizationClient.swift

@@ -287,7 +287,8 @@ open class PersonalizationClient {
         )
     }
 
-    /// - parameter userToken: (path) userToken representing the user for which to fetch the Personalization profile.
+    /// - parameter userToken: (path) Unique identifier representing a user for which to fetch the personalization
+    /// profile.
     /// - returns: DeleteUserProfileResponse
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func deleteUserProfile(
@@ -306,14 +307,13 @@ open class PersonalizationClient {
         return body
     }
 
-    // Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the
-    // data can safely be considered as deleted for the given user. This means if you send events for the given user
-    // before this date, they will be ignored. Any data received after the deletedUntil date will start building a new
-    // user profile.  It might take a couple hours for the deletion request to be fully processed.
+    // Deletes a user profile.  The response includes a date and time when the user profile can safely be considered
+    // deleted.
     // Required API Key ACLs:
     //  - recommendation
     //
-    // - parameter userToken: (path) userToken representing the user for which to fetch the Personalization profile.
+    // - parameter userToken: (path) Unique identifier representing a user for which to fetch the personalization
+    // profile.
     // - returns: RequestBuilder<DeleteUserProfileResponse>
 
     open func deleteUserProfileWithHTTPInfo(
@@ -363,8 +363,7 @@ open class PersonalizationClient {
         return body
     }
 
-    // The strategy contains information on the events and facets that impact user profiles and personalized search
-    // results.
+    // Retrieves the current personalization strategy.
     // Required API Key ACLs:
     //  - recommendation
     //     - returns: RequestBuilder<PersonalizationStrategyParams>
@@ -389,7 +388,8 @@ open class PersonalizationClient {
         )
     }
 
-    /// - parameter userToken: (path) userToken representing the user for which to fetch the Personalization profile.
+    /// - parameter userToken: (path) Unique identifier representing a user for which to fetch the personalization
+    /// profile.
     /// - returns: GetUserTokenResponse
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func getUserTokenProfile(
@@ -408,15 +408,12 @@ open class PersonalizationClient {
         return body
     }
 
-    // Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the
-    // strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet
-    // value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The
-    // last
-    // processed event timestamp is provided using the ISO 8601 format for debugging purposes.
+    // Retrieves a user profile and their affinities for different facets.
     // Required API Key ACLs:
     //  - recommendation
     //
-    // - parameter userToken: (path) userToken representing the user for which to fetch the Personalization profile.
+    // - parameter userToken: (path) Unique identifier representing a user for which to fetch the personalization
+    // profile.
     // - returns: RequestBuilder<GetUserTokenResponse>
 
     open func getUserTokenProfileWithHTTPInfo(
@@ -471,7 +468,7 @@ open class PersonalizationClient {
         return body
     }
 
-    // A strategy defines the events and facets that impact user profiles and personalized search results.
+    // Creates a new personalization strategy.
     // Required API Key ACLs:
     //  - recommendation
     //