feat(specs): add support for widgets / banners in search for the csharp client (generated)

algolia/api-clients-automation#3870

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Jonas <[email protected]>
Co-authored-by: Jonas Kalmar Rønning <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: 4 people

Sources/Recommend/Models/RecommendBanner.swift

@@ -0,0 +1,45 @@
+// 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 search banner with image and url.
+public struct RecommendBanner: Codable, JSONEncodable {
+    public var image: RecommendBannerImage?
+    public var link: RecommendBannerLink?
+
+    public init(image: RecommendBannerImage? = nil, link: RecommendBannerLink? = nil) {
+        self.image = image
+        self.link = link
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case image
+        case link
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.image, forKey: .image)
+        try container.encodeIfPresent(self.link, forKey: .link)
+    }
+}
+
+extension RecommendBanner: Equatable {
+    public static func ==(lhs: RecommendBanner, rhs: RecommendBanner) -> Bool {
+        lhs.image == rhs.image &&
+            lhs.link == rhs.link
+    }
+}
+
+extension RecommendBanner: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.image?.hashValue)
+        hasher.combine(self.link?.hashValue)
+    }
+}

Sources/Recommend/Models/RecommendBannerImage.swift

@@ -0,0 +1,45 @@
+// 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
+
+/// image of a search banner.
+public struct RecommendBannerImage: Codable, JSONEncodable {
+    public var urls: RecommendBannerImageUrl?
+    public var title: String?
+
+    public init(urls: RecommendBannerImageUrl? = nil, title: String? = nil) {
+        self.urls = urls
+        self.title = title
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case urls
+        case title
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.urls, forKey: .urls)
+        try container.encodeIfPresent(self.title, forKey: .title)
+    }
+}
+
+extension RecommendBannerImage: Equatable {
+    public static func ==(lhs: RecommendBannerImage, rhs: RecommendBannerImage) -> Bool {
+        lhs.urls == rhs.urls &&
+            lhs.title == rhs.title
+    }
+}
+
+extension RecommendBannerImage: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.urls?.hashValue)
+        hasher.combine(self.title?.hashValue)
+    }
+}

Sources/Recommend/Models/RecommendBannerImageUrl.swift

@@ -0,0 +1,39 @@
+// 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
+
+/// url for a search banner image.
+public struct RecommendBannerImageUrl: Codable, JSONEncodable {
+    public var url: String?
+
+    public init(url: String? = nil) {
+        self.url = url
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case url
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.url, forKey: .url)
+    }
+}
+
+extension RecommendBannerImageUrl: Equatable {
+    public static func ==(lhs: RecommendBannerImageUrl, rhs: RecommendBannerImageUrl) -> Bool {
+        lhs.url == rhs.url
+    }
+}
+
+extension RecommendBannerImageUrl: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.url?.hashValue)
+    }
+}

Sources/Recommend/Models/RecommendBannerLink.swift

@@ -0,0 +1,39 @@
+// 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
+
+/// link for a banner defined in merchandising studio.
+public struct RecommendBannerLink: Codable, JSONEncodable {
+    public var url: String?
+
+    public init(url: String? = nil) {
+        self.url = url
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case url
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.url, forKey: .url)
+    }
+}
+
+extension RecommendBannerLink: Equatable {
+    public static func ==(lhs: RecommendBannerLink, rhs: RecommendBannerLink) -> Bool {
+        lhs.url == rhs.url
+    }
+}
+
+extension RecommendBannerLink: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.url?.hashValue)
+    }
+}

Sources/Recommend/Models/RecommendBanners.swift

@@ -0,0 +1,39 @@
+// 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
+
+/// banners defined in the merchandising studio for the given search.
+public struct RecommendBanners: Codable, JSONEncodable {
+    public var banners: RecommendBanner?
+
+    public init(banners: RecommendBanner? = nil) {
+        self.banners = banners
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case banners
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.banners, forKey: .banners)
+    }
+}
+
+extension RecommendBanners: Equatable {
+    public static func ==(lhs: RecommendBanners, rhs: RecommendBanners) -> Bool {
+        lhs.banners == rhs.banners
+    }
+}
+
+extension RecommendBanners: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.banners?.hashValue)
+    }
+}

Sources/Recommend/Models/RecommendRenderingContent.swift

@@ -11,15 +11,22 @@ import Foundation
 public struct RecommendRenderingContent: Codable, JSONEncodable {
     public var facetOrdering: RecommendFacetOrdering?
     public var redirect: RecommendRedirectURL?
+    public var widgets: RecommendWidgets?
 
-    public init(facetOrdering: RecommendFacetOrdering? = nil, redirect: RecommendRedirectURL? = nil) {
+    public init(
+        facetOrdering: RecommendFacetOrdering? = nil,
+        redirect: RecommendRedirectURL? = nil,
+        widgets: RecommendWidgets? = nil
+    ) {
         self.facetOrdering = facetOrdering
         self.redirect = redirect
+        self.widgets = widgets
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
         case facetOrdering
         case redirect
+        case widgets
     }
 
     // Encodable protocol methods
@@ -28,19 +35,22 @@ public struct RecommendRenderingContent: Codable, JSONEncodable {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encodeIfPresent(self.facetOrdering, forKey: .facetOrdering)
         try container.encodeIfPresent(self.redirect, forKey: .redirect)
+        try container.encodeIfPresent(self.widgets, forKey: .widgets)
     }
 }
 
 extension RecommendRenderingContent: Equatable {
     public static func ==(lhs: RecommendRenderingContent, rhs: RecommendRenderingContent) -> Bool {
         lhs.facetOrdering == rhs.facetOrdering &&
-            lhs.redirect == rhs.redirect
+            lhs.redirect == rhs.redirect &&
+            lhs.widgets == rhs.widgets
     }
 }
 
 extension RecommendRenderingContent: Hashable {
     public func hash(into hasher: inout Hasher) {
         hasher.combine(self.facetOrdering?.hashValue)
         hasher.combine(self.redirect?.hashValue)
+        hasher.combine(self.widgets?.hashValue)
     }
 }

Sources/Recommend/Models/RecommendWidgets.swift

@@ -0,0 +1,39 @@
+// 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
+
+/// widgets returned from any rules that are applied to the current search.
+public struct RecommendWidgets: Codable, JSONEncodable {
+    public var banners: RecommendBanners?
+
+    public init(banners: RecommendBanners? = nil) {
+        self.banners = banners
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case banners
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.banners, forKey: .banners)
+    }
+}
+
+extension RecommendWidgets: Equatable {
+    public static func ==(lhs: RecommendWidgets, rhs: RecommendWidgets) -> Bool {
+        lhs.banners == rhs.banners
+    }
+}
+
+extension RecommendWidgets: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.banners?.hashValue)
+    }
+}

Sources/Search/Models/SearchBanner.swift

@@ -0,0 +1,45 @@
+// 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 search banner with image and url.
+public struct SearchBanner: Codable, JSONEncodable {
+    public var image: SearchBannerImage?
+    public var link: SearchBannerLink?
+
+    public init(image: SearchBannerImage? = nil, link: SearchBannerLink? = nil) {
+        self.image = image
+        self.link = link
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case image
+        case link
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.image, forKey: .image)
+        try container.encodeIfPresent(self.link, forKey: .link)
+    }
+}
+
+extension SearchBanner: Equatable {
+    public static func ==(lhs: SearchBanner, rhs: SearchBanner) -> Bool {
+        lhs.image == rhs.image &&
+            lhs.link == rhs.link
+    }
+}
+
+extension SearchBanner: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.image?.hashValue)
+        hasher.combine(self.link?.hashValue)
+    }
+}

Sources/Search/Models/SearchBannerImage.swift

@@ -0,0 +1,45 @@
+// 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
+
+/// image of a search banner.
+public struct SearchBannerImage: Codable, JSONEncodable {
+    public var urls: SearchBannerImageUrl?
+    public var title: String?
+
+    public init(urls: SearchBannerImageUrl? = nil, title: String? = nil) {
+        self.urls = urls
+        self.title = title
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case urls
+        case title
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.urls, forKey: .urls)
+        try container.encodeIfPresent(self.title, forKey: .title)
+    }
+}
+
+extension SearchBannerImage: Equatable {
+    public static func ==(lhs: SearchBannerImage, rhs: SearchBannerImage) -> Bool {
+        lhs.urls == rhs.urls &&
+            lhs.title == rhs.title
+    }
+}
+
+extension SearchBannerImage: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.urls?.hashValue)
+        hasher.combine(self.title?.hashValue)
+    }
+}