chore: generated code for commit 10e08c9e. [skip ci]

algolia/api-clients-automation@10e08c9

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Kai Welke <[email protected]>
Co-authored-by: shortcuts <[email protected]>

Author: 3 people

…ySuggestionsConfigurationWithIndex.swift …rces/QuerySuggestions/Models/AppID.swiftSources/QuerySuggestions/Models/BaseQuerySuggestionsConfigurationWithIndex.swift renamed to Sources/QuerySuggestions/Models/AppID.swift Sources/QuerySuggestions/Models/BaseQuerySuggestionsConfigurationWithIndex.swift renamed to Sources/QuerySuggestions/Models/AppID.swift

@@ -6,22 +6,22 @@ import Foundation
     import Core
 #endif
 
-public struct BaseQuerySuggestionsConfigurationWithIndex: Codable, JSONEncodable {
-    /// Query Suggestions index name.
-    public var indexName: String
+public struct AppID: Codable, JSONEncodable {
+    /// Algolia application ID to which this Query Suggestions configuration belongs.
+    public var appID: String?
 
-    public init(indexName: String) {
-        self.indexName = indexName
+    public init(appID: String? = nil) {
+        self.appID = appID
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
-        case indexName
+        case appID
     }
 
     // Encodable protocol methods
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
-        try container.encode(self.indexName, forKey: .indexName)
+        try container.encodeIfPresent(self.appID, forKey: .appID)
     }
 }

Sources/QuerySuggestions/Models/BaseQuerySuggestionsConfigurationResponse.swift

@@ -7,9 +7,9 @@ import Foundation
 #endif
 
 public struct GetConfigStatus200Response: Codable, JSONEncodable {
-    /// Query Suggestions index name.
+    /// Name of the Query Suggestions index.
     public var indexName: String?
-    /// Indicates whether the creation or update of the Query Suggestions is in progress.
+    /// Whether the creation or update of the Query Suggestions index is in progress.
     public var isRunning: Bool?
     /// Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last
     /// built.

Sources/QuerySuggestions/Models/GetConfigStatus200Response.swift

@@ -12,7 +12,7 @@ public struct GetLogFile200Response: Codable, JSONEncodable {
     public var level: ModelLogLevel?
     /// Details about this log entry.
     public var message: String?
-    /// Level indicating the position of a suggestion in a hierarchy of records.   For example, a `contextLevel` of 1
+    /// Level indicating the position of a suggestion in a hierarchy of records.  For example, a `contextLevel` of 1
     /// indicates that this suggestion belongs to a previous suggestion with `contextLevel` 0.
     public var contextLevel: Int?
 

Sources/QuerySuggestions/Models/GetLogFile200Response.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// The type of log entry.   - `SKIP`. A query is skipped because it doesn't match the conditions for
+/// Type of log entry.  - `SKIP`. A query is skipped because it doesn't match the conditions for
 /// successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An
 /// informative log entry. - `ERROR`. The Query Suggestions process encountered an error.
 public enum ModelLogLevel: String, Codable, CaseIterable {

Sources/QuerySuggestions/Models/ModelLogLevel.swift

@@ -11,11 +11,10 @@ public struct QuerySuggestionsConfiguration: Codable, JSONEncodable {
     /// Algolia indices from which to get the popular searches for query suggestions.
     public var sourceIndices: [SourceIndex]
     public var languages: QuerySuggestionsLanguages?
-    /// Patterns to exclude from query suggestions.
     public var exclude: [String]?
-    /// Turn on personalized query suggestions.
+    /// Whether to turn on personalized query suggestions.
     public var enablePersonalization: Bool?
-    /// Allow suggestions with special characters.
+    /// Whether to include suggestions with special characters.
     public var allowSpecialCharacters: Bool?
 
     public init(

Sources/QuerySuggestions/Models/QuerySuggestionsConfiguration.swift

@@ -6,39 +6,31 @@ import Foundation
     import Core
 #endif
 
+/// API response for retrieving Query Suggestions configurations.
 public struct QuerySuggestionsConfigurationResponse: Codable, JSONEncodable {
-    /// API key used to read from your source index.
-    public var sourceIndicesAPIKey: String?
-    /// API key used to write and configure your Query Suggestions index.
-    public var suggestionsIndicesAPIKey: String?
-    /// API key used to read from external Algolia indices.
-    public var externalIndicesAPIKey: String?
-    /// Query Suggestions index name.
+    /// Algolia application ID to which this Query Suggestions configuration belongs.
+    public var appID: String
+    /// Name of the Query Suggestions index.
     public var indexName: String
     /// Algolia indices from which to get the popular searches for query suggestions.
     public var sourceIndices: [SourceIndex]
-    public var languages: QuerySuggestionsLanguages?
-    /// Patterns to exclude from query suggestions.
+    public var languages: QuerySuggestionsLanguages
     public var exclude: [String]?
-    /// Turn on personalized query suggestions.
-    public var enablePersonalization: Bool?
-    /// Allow suggestions with special characters.
-    public var allowSpecialCharacters: Bool?
+    /// Whether to turn on personalized query suggestions.
+    public var enablePersonalization: Bool
+    /// Whether to include suggestions with special characters.
+    public var allowSpecialCharacters: Bool
 
     public init(
-        sourceIndicesAPIKey: String? = nil,
-        suggestionsIndicesAPIKey: String? = nil,
-        externalIndicesAPIKey: String? = nil,
+        appID: String,
         indexName: String,
         sourceIndices: [SourceIndex],
-        languages: QuerySuggestionsLanguages? = nil,
-        exclude: [String]? = nil,
-        enablePersonalization: Bool? = nil,
-        allowSpecialCharacters: Bool? = nil
+        languages: QuerySuggestionsLanguages,
+        exclude: [String]?,
+        enablePersonalization: Bool,
+        allowSpecialCharacters: Bool
     ) {
-        self.sourceIndicesAPIKey = sourceIndicesAPIKey
-        self.suggestionsIndicesAPIKey = suggestionsIndicesAPIKey
-        self.externalIndicesAPIKey = externalIndicesAPIKey
+        self.appID = appID
         self.indexName = indexName
         self.sourceIndices = sourceIndices
         self.languages = languages
@@ -48,9 +40,7 @@ public struct QuerySuggestionsConfigurationResponse: Codable, JSONEncodable {
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
-        case sourceIndicesAPIKey
-        case suggestionsIndicesAPIKey
-        case externalIndicesAPIKey
+        case appID
         case indexName
         case sourceIndices
         case languages
@@ -63,14 +53,12 @@ public struct QuerySuggestionsConfigurationResponse: Codable, JSONEncodable {
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
-        try container.encodeIfPresent(self.sourceIndicesAPIKey, forKey: .sourceIndicesAPIKey)
-        try container.encodeIfPresent(self.suggestionsIndicesAPIKey, forKey: .suggestionsIndicesAPIKey)
-        try container.encodeIfPresent(self.externalIndicesAPIKey, forKey: .externalIndicesAPIKey)
+        try container.encode(self.appID, forKey: .appID)
         try container.encode(self.indexName, forKey: .indexName)
         try container.encode(self.sourceIndices, forKey: .sourceIndices)
-        try container.encodeIfPresent(self.languages, forKey: .languages)
-        try container.encodeIfPresent(self.exclude, forKey: .exclude)
-        try container.encodeIfPresent(self.enablePersonalization, forKey: .enablePersonalization)
-        try container.encodeIfPresent(self.allowSpecialCharacters, forKey: .allowSpecialCharacters)
+        try container.encode(self.languages, forKey: .languages)
+        try container.encode(self.exclude, forKey: .exclude)
+        try container.encode(self.enablePersonalization, forKey: .enablePersonalization)
+        try container.encode(self.allowSpecialCharacters, forKey: .allowSpecialCharacters)
     }
 }

Sources/QuerySuggestions/Models/QuerySuggestionsConfigurationResponse.swift

@@ -8,52 +8,51 @@ import Foundation
 
 /// Query Suggestions configuration.
 public struct QuerySuggestionsConfigurationWithIndex: Codable, JSONEncodable {
-    /// Query Suggestions index name.
-    public var indexName: String
     /// Algolia indices from which to get the popular searches for query suggestions.
     public var sourceIndices: [SourceIndex]
     public var languages: QuerySuggestionsLanguages?
-    /// Patterns to exclude from query suggestions.
     public var exclude: [String]?
-    /// Turn on personalized query suggestions.
+    /// Whether to turn on personalized query suggestions.
     public var enablePersonalization: Bool?
-    /// Allow suggestions with special characters.
+    /// Whether to include suggestions with special characters.
     public var allowSpecialCharacters: Bool?
+    /// Name of the Query Suggestions index.
+    public var indexName: String
 
     public init(
-        indexName: String,
         sourceIndices: [SourceIndex],
         languages: QuerySuggestionsLanguages? = nil,
         exclude: [String]? = nil,
         enablePersonalization: Bool? = nil,
-        allowSpecialCharacters: Bool? = nil
+        allowSpecialCharacters: Bool? = nil,
+        indexName: String
     ) {
-        self.indexName = indexName
         self.sourceIndices = sourceIndices
         self.languages = languages
         self.exclude = exclude
         self.enablePersonalization = enablePersonalization
         self.allowSpecialCharacters = allowSpecialCharacters
+        self.indexName = indexName
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
-        case indexName
         case sourceIndices
         case languages
         case exclude
         case enablePersonalization
         case allowSpecialCharacters
+        case indexName
     }
 
     // Encodable protocol methods
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
-        try container.encode(self.indexName, forKey: .indexName)
         try container.encode(self.sourceIndices, forKey: .sourceIndices)
         try container.encodeIfPresent(self.languages, forKey: .languages)
         try container.encodeIfPresent(self.exclude, forKey: .exclude)
         try container.encodeIfPresent(self.enablePersonalization, forKey: .enablePersonalization)
         try container.encodeIfPresent(self.allowSpecialCharacters, forKey: .allowSpecialCharacters)
+        try container.encode(self.indexName, forKey: .indexName)
     }
 }

Sources/QuerySuggestions/Models/QuerySuggestionsConfigurationWithIndex.swift

@@ -6,8 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Set the language for deduplicating singular and plural suggestions. If specified, only the more popular form is
-/// included.
+/// Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
 public enum QuerySuggestionsLanguages: Codable, JSONEncodable, AbstractEncodable {
     case arrayOfString([String])
     case bool(Bool)

Sources/QuerySuggestions/Models/QuerySuggestionsLanguages.swift

@@ -10,27 +10,18 @@ import Foundation
 public struct SourceIndex: Codable, JSONEncodable {
     /// Name of the Algolia index to use as source for query suggestions.
     public var indexName: String
-    /// If true, Query Suggestions uses all replicas of the primary index to find popular searches. If false, only the
-    /// primary index is used.
+    /// If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index
+    /// is used.
     public var replicas: Bool?
-    /// [Analytics tags](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) for filtering the
-    /// popular searches.
     public var analyticsTags: [String]?
-    /// Facets to use as top categories with your suggestions.  If provided, Query Suggestions adds the top facet values
-    /// to each suggestion.
     public var facets: [Facet]?
     /// Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits`
-    /// hits to be included in the Query Suggestions index.
+    /// search results to be included in the Query Suggestions index.
     public var minHits: Int?
     /// Minimum letters required to be included as a suggestion.  A search query must be at least `minLetters` long to
     /// be included in the Query Suggestions index.
     public var minLetters: Int?
     public var generate: [[String]]?
-    /// Algolia indices with popular searches to use as query suggestions.  Records of these indices must have these
-    /// attributes:    - `query`: search query which will be added as a suggestion   - `count`: measure of popularity of
-    /// that search query  For example, you can export popular searches from an external analytics tool, such as Google
-    /// Analytics or Adobe Analytics, and feed this data into an external Algolia index. You can use this external index
-    /// to generate query suggestions until your Algolia analytics has collected enough data.
     public var external: [String]?
 
     public init(