chore: generated code for commit 60322c0b. [skip ci]

algolia/api-clients-automation@60322c0

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: Thomas Raffray <[email protected]>

Author: 4 people

Sources/Abtesting/AbtestingClient.swift

@@ -46,7 +46,7 @@ open class AbtestingClient {
         return body
     }
 
-    // Creates an A/B test.
+    // Creates a new A/B test.
     // Required API Key ACLs:
     //  - editSettings
     //
@@ -333,7 +333,7 @@ open class AbtestingClient {
         )
     }
 
-    /// - parameter id: (path) Unique A/B test ID.
+    /// - parameter id: (path) Unique A/B test identifier.
     /// - returns: ABTestResponse
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func deleteABTest(id: Int, requestOptions: RequestOptions? = nil) async throws -> ABTestResponse {
@@ -349,12 +349,11 @@ open class AbtestingClient {
         return body
     }
 
-    // Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests`
-    // operation](#tag/abtest/operation/listABTests).
+    // Deletes an A/B test by its ID.
     // Required API Key ACLs:
     //  - editSettings
     //
-    // - parameter id: (path) Unique A/B test ID.
+    // - parameter id: (path) Unique A/B test identifier.
     // - returns: RequestBuilder<ABTestResponse>
 
     open func deleteABTestWithHTTPInfo(
@@ -380,7 +379,7 @@ open class AbtestingClient {
         )
     }
 
-    /// - parameter id: (path) Unique A/B test ID.
+    /// - parameter id: (path) Unique A/B test identifier.
     /// - returns: ABTest
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func getABTest(id: Int, requestOptions: RequestOptions? = nil) async throws -> ABTest {
@@ -393,12 +392,11 @@ open class AbtestingClient {
         return body
     }
 
-    // Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests`
-    // operation](#tag/abtest/operation/listABTests).
+    // Retrieves the details for an A/B test by its ID.
     // Required API Key ACLs:
     //  - analytics
     //
-    // - parameter id: (path) Unique A/B test ID.
+    // - parameter id: (path) Unique A/B test identifier.
     // - returns: RequestBuilder<ABTest>
 
     open func getABTestWithHTTPInfo(
@@ -426,8 +424,10 @@ open class AbtestingClient {
 
     /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
     /// - parameter limit: (query) Number of items to return. (optional, default to 10)
-    /// - parameter indexPrefix: (query) Only return A/B tests for indices starting with this prefix. (optional)
-    /// - parameter indexSuffix: (query) Only return A/B tests for indices ending with this suffix. (optional)
+    /// - parameter indexPrefix: (query) Index name prefix. Only A/B tests for indices starting with this string are
+    /// included in the response. (optional)
+    /// - parameter indexSuffix: (query) Index name suffix. Only A/B tests for indices ending with this string are
+    /// included in the response. (optional)
     /// - returns: ListABTestsResponse
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func listABTests(
@@ -452,17 +452,19 @@ open class AbtestingClient {
         return body
     }
 
-    // List all A/B tests.
+    // Lists all A/B tests you configured for this application.
     // Required API Key ACLs:
     //  - analytics
     //
     // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
     //
     // - parameter limit: (query) Number of items to return. (optional, default to 10)
     //
-    // - parameter indexPrefix: (query) Only return A/B tests for indices starting with this prefix. (optional)
+    // - parameter indexPrefix: (query) Index name prefix. Only A/B tests for indices starting with this string are
+    // included in the response. (optional)
     //
-    // - parameter indexSuffix: (query) Only return A/B tests for indices ending with this suffix. (optional)
+    // - parameter indexSuffix: (query) Index name suffix. Only A/B tests for indices ending with this string are
+    // included in the response. (optional)
     // - returns: RequestBuilder<ListABTestsResponse>
 
     open func listABTestsWithHTTPInfo(
@@ -493,7 +495,7 @@ open class AbtestingClient {
         )
     }
 
-    /// - parameter id: (path) Unique A/B test ID.
+    /// - parameter id: (path) Unique A/B test identifier.
     /// - returns: ABTestResponse
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func stopABTest(id: Int, requestOptions: RequestOptions? = nil) async throws -> ABTestResponse {
@@ -509,13 +511,11 @@ open class AbtestingClient {
         return body
     }
 
-    // If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search
-    // requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the
-    // [`listABTests` operation](#tag/abtest/operation/listABTests).
+    // Stops an A/B test by its ID.  You can't restart stopped A/B tests.
     // Required API Key ACLs:
     //  - editSettings
     //
-    // - parameter id: (path) Unique A/B test ID.
+    // - parameter id: (path) Unique A/B test identifier.
     // - returns: RequestBuilder<ABTestResponse>
 
     open func stopABTestWithHTTPInfo(

Sources/Abtesting/Models/ABTest.swift

@@ -7,35 +7,26 @@ import Foundation
 #endif
 
 public struct ABTest: Codable, JSONEncodable {
-    /// Unique A/B test ID.
+    /// Unique A/B test identifier.
     public var abTestID: Int
-    /// [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance)
-    /// based on click data. A value of 0.95 or over is considered to be _significant_.
     public var clickSignificance: Double?
-    /// [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance)
-    /// based on conversion. A value of 0.95 or over is considered to be _significant_.
     public var conversionSignificance: Double?
-    /// [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance)
-    /// based on add-to-cart data. A value of 0.95 or over is considered to be _significant_.
     public var addToCartSignificance: Double?
-    /// [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance)
-    /// based on purchase data. A value of 0.95 or over is considered to be _significant_.
     public var purchaseSignificance: Double?
-    /// [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance)
-    /// based on revenue data. A value of 0.95 or over is considered to be _significant_.
     public var revenueSignificance: [String: Double]?
-    /// Update date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+    /// Date and time when the A/B test was last updated, in RFC 3339 format.
     public var updatedAt: String
-    /// Creation date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+    /// Date and time when the A/B test was created, in RFC 3339 format.
     public var createdAt: String
-    /// End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+    /// End date and time of the A/B test, in RFC 3339 format.
     public var endAt: String
     /// A/B test name.
     public var name: String
-    /// A/B test status.
-    public var status: String
-    /// A/B test variants.
+    public var status: AbtestingStatus
+    /// A/B test variants.  The first variant is your _control_ index, typically your production index. The second
+    /// variant is an index with changed settings that you want to test against the control.
     public var variants: [Variant]
+    public var configuration: ABTestConfiguration?
 
     public init(
         abTestID: Int,
@@ -48,8 +39,9 @@ public struct ABTest: Codable, JSONEncodable {
         createdAt: String,
         endAt: String,
         name: String,
-        status: String,
-        variants: [Variant]
+        status: AbtestingStatus,
+        variants: [Variant],
+        configuration: ABTestConfiguration? = nil
     ) {
         self.abTestID = abTestID
         self.clickSignificance = clickSignificance
@@ -63,6 +55,7 @@ public struct ABTest: Codable, JSONEncodable {
         self.name = name
         self.status = status
         self.variants = variants
+        self.configuration = configuration
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
@@ -78,6 +71,7 @@ public struct ABTest: Codable, JSONEncodable {
         case name
         case status
         case variants
+        case configuration
     }
 
     // Encodable protocol methods
@@ -96,6 +90,7 @@ public struct ABTest: Codable, JSONEncodable {
         try container.encode(self.name, forKey: .name)
         try container.encode(self.status, forKey: .status)
         try container.encode(self.variants, forKey: .variants)
+        try container.encodeIfPresent(self.configuration, forKey: .configuration)
     }
 }
 
@@ -112,7 +107,8 @@ extension ABTest: Equatable {
             lhs.endAt == rhs.endAt &&
             lhs.name == rhs.name &&
             lhs.status == rhs.status &&
-            lhs.variants == rhs.variants
+            lhs.variants == rhs.variants &&
+            lhs.configuration == rhs.configuration
     }
 }
 
@@ -130,5 +126,6 @@ extension ABTest: Hashable {
         hasher.combine(self.name.hashValue)
         hasher.combine(self.status.hashValue)
         hasher.combine(self.variants.hashValue)
+        hasher.combine(self.configuration?.hashValue)
     }
 }

Sources/Abtesting/Models/ABTestConfiguration.swift

@@ -0,0 +1,55 @@
+// 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
+
+/// A/B test configuration.
+public struct ABTestConfiguration: Codable, JSONEncodable {
+    public var outliers: Outliers
+    public var emptySearch: EmptySearch?
+    public var minimumDetectableEffect: MinimumDetectableEffect?
+
+    public init(
+        outliers: Outliers,
+        emptySearch: EmptySearch? = nil,
+        minimumDetectableEffect: MinimumDetectableEffect? = nil
+    ) {
+        self.outliers = outliers
+        self.emptySearch = emptySearch
+        self.minimumDetectableEffect = minimumDetectableEffect
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case outliers
+        case emptySearch
+        case minimumDetectableEffect
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.outliers, forKey: .outliers)
+        try container.encodeIfPresent(self.emptySearch, forKey: .emptySearch)
+        try container.encodeIfPresent(self.minimumDetectableEffect, forKey: .minimumDetectableEffect)
+    }
+}
+
+extension ABTestConfiguration: Equatable {
+    public static func ==(lhs: ABTestConfiguration, rhs: ABTestConfiguration) -> Bool {
+        lhs.outliers == rhs.outliers &&
+            lhs.emptySearch == rhs.emptySearch &&
+            lhs.minimumDetectableEffect == rhs.minimumDetectableEffect
+    }
+}
+
+extension ABTestConfiguration: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.outliers.hashValue)
+        hasher.combine(self.emptySearch?.hashValue)
+        hasher.combine(self.minimumDetectableEffect?.hashValue)
+    }
+}

Sources/Abtesting/Models/ABTestResponse.swift

@@ -9,7 +9,7 @@ import Foundation
 public struct ABTestResponse: Codable, JSONEncodable {
     /// A/B test index.
     public var index: String
-    /// Unique A/B test ID.
+    /// Unique A/B test identifier.
     public var abTestID: Int
     /// 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

Sources/Abtesting/Models/AbTestsVariant.swift

@@ -9,9 +9,9 @@ import Foundation
 public struct AbTestsVariant: Codable, JSONEncodable {
     /// A/B test index.
     public var index: String
-    /// A/B test traffic percentage.
+    /// Percentage of search requests each variant receives.
     public var trafficPercentage: Int
-    /// A/B test description.
+    /// Description for this variant.
     public var description: String?
 
     public init(index: String, trafficPercentage: Int, description: String? = nil) {

Sources/Abtesting/Models/AbTestsVariantSearchParams.swift

@@ -9,9 +9,9 @@ import Foundation
 public struct AbTestsVariantSearchParams: Codable, JSONEncodable {
     /// A/B test index.
     public var index: String
-    /// A/B test traffic percentage.
+    /// Percentage of search requests each variant receives.
     public var trafficPercentage: Int
-    /// A/B test description.
+    /// Description for this variant.
     public var description: String?
     public var customSearchParameters: AnyCodable
 

Sources/Abtesting/Models/AbtestingStatus.swift

@@ -0,0 +1,20 @@
+// 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
+
+/// A/B test status.  - `active`. The A/B test is live and search traffic is split between the two variants. -
+/// `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. -
+/// `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`.
+/// Creating the A/B test failed.
+public enum AbtestingStatus: String, Codable, CaseIterable {
+    case active
+    case stopped
+    case expired
+    case failed
+}
+
+extension AbtestingStatus: Hashable {}

Sources/Abtesting/Models/AddABTestsRequest.swift

@@ -11,7 +11,7 @@ public struct AddABTestsRequest: Codable, JSONEncodable {
     public var name: String
     /// A/B test variants.
     public var variants: [AddABTestsVariant]
-    /// End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+    /// End date and time of the A/B test, in RFC 3339 format.
     public var endAt: String
 
     public init(name: String, variants: [AddABTestsVariant], endAt: String) {

Sources/Abtesting/Models/CustomSearchParams.swift

@@ -6,9 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Applies search parameters from [a restricted set of
-/// options](https://www.algolia.com/doc/api-reference/api-methods/add-ab-test/#method-param-customsearchparameters).
-/// Only use this parameter if the two variants use the same index.
+/// Search parameters to add to the test variant. Only use this parameter if the two variants use the same index.
 public struct CustomSearchParams: Codable, JSONEncodable {
     public var customSearchParameters: AnyCodable
 

Sources/Abtesting/Models/Effect.swift

@@ -0,0 +1,17 @@
+// 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
+
+/// Metric for which you want to detect the smallest relative difference.
+public enum Effect: String, Codable, CaseIterable {
+    case addToCartRate
+    case clickThroughRate
+    case conversionRate
+    case purchaseRate
+}
+
+extension Effect: Hashable {}