feat!: Change names of unions (box/box-codegen#789) (#967)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "1c54d3c", "specHash": "24fbeb9", "version": "0.1.0" }
+{ "engineHash": "ef443c1", "specHash": "99e14a6", "version": "0.1.0" }

BoxSdkGen.xcodeproj/project.pbxproj

@@ -45,13 +45,13 @@ public class AiManager {
     /// - Parameters:
     ///   - queryParams: Query parameters of getAiAgentDefaultConfig method
     ///   - headers: Headers of getAiAgentDefaultConfig method
-    /// - Returns: The `AiAgentAskOrAiAgentExtractOrAiAgentExtractStructuredOrAiAgentTextGen`.
+    /// - Returns: The `AiAgent`.
     /// - Throws: The `GeneralError`.
-    public func getAiAgentDefaultConfig(queryParams: GetAiAgentDefaultConfigQueryParams, headers: GetAiAgentDefaultConfigHeaders = GetAiAgentDefaultConfigHeaders()) async throws -> AiAgentAskOrAiAgentExtractOrAiAgentExtractStructuredOrAiAgentTextGen {
+    public func getAiAgentDefaultConfig(queryParams: GetAiAgentDefaultConfigQueryParams, headers: GetAiAgentDefaultConfigHeaders = GetAiAgentDefaultConfigHeaders()) async throws -> AiAgent {
         let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["mode": Utils.Strings.toString(value: queryParams.mode), "language": Utils.Strings.toString(value: queryParams.language), "model": Utils.Strings.toString(value: queryParams.model)])
         let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge([:], headers.extraHeaders))
         let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/ai_agent_default")", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
-        return try AiAgentAskOrAiAgentExtractOrAiAgentExtractStructuredOrAiAgentTextGen.deserialize(from: response.data!)
+        return try AiAgent.deserialize(from: response.data!)
     }
 
     /// Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.

Sources/Managers/Ai/AiManager.swift

@@ -116,7 +116,7 @@ public class FileVersionsManager {
     /// 
     /// This creates a new copy of the old version and puts it at the
     /// top of the versions history. The file will have the exact same contents
-    /// as the older version, with the the same hash digest, `etag`, and
+    /// as the older version, with the same hash digest, `etag`, and
     /// name as the original.
     /// 
     /// Other properties such as comments do not get updated to their

Sources/Managers/FileVersions/FileVersionsManager.swift

@@ -59,7 +59,7 @@ public class FilesManager {
     /// Deletes a file, either permanently or by moving it to
     /// the trash.
     /// 
-    /// The the enterprise settings determine whether the item will
+    /// The enterprise settings determine whether the item will
     /// be permanently deleted from Box or moved to the trash.
     ///
     /// - Parameters:

Sources/Managers/Files/FilesManager.swift

@@ -61,7 +61,7 @@ public class SearchForContentQueryParams {
     /// Date ranges are defined as comma separated RFC3339
     /// timestamps.
     /// 
-    /// If the the start date is omitted (`,2014-05-17T13:35:01-07:00`)
+    /// If the start date is omitted (`,2014-05-17T13:35:01-07:00`)
     /// anything created before the end date will be returned.
     /// 
     /// If the end date is omitted (`2014-05-15T13:35:01-07:00,`) the
@@ -171,7 +171,7 @@ public class SearchForContentQueryParams {
     public let trashContent: SearchForContentQueryParamsTrashContentField?
 
     /// Limits the search results to any items for which the metadata matches the provided filter.
-    /// This parameter is a list that specifies exactly **one** metadata template used to filter the search results. 
+    /// This parameter is a list that specifies exactly **one** metadata template used to filter the search results.
     /// The parameter is required unless the `query` parameter is provided.
     public let mdfilters: [MetadataFilter]?
 
@@ -246,7 +246,7 @@ public class SearchForContentQueryParams {
     /// 
     /// Date ranges are defined as comma separated RFC3339 timestamps.
     /// 
-    /// If the the start date is omitted (`2014-05-17T13:35:01-07:00`),
+    /// If the start date is omitted (`2014-05-17T13:35:01-07:00`),
     /// anything deleted before the end date will be returned.
     /// 
     /// If the end date is omitted (`2014-05-15T13:35:01-07:00`),
@@ -317,7 +317,7 @@ public class SearchForContentQueryParams {
     ///     Date ranges are defined as comma separated RFC3339
     ///     timestamps.
     ///     
-    ///     If the the start date is omitted (`,2014-05-17T13:35:01-07:00`)
+    ///     If the start date is omitted (`,2014-05-17T13:35:01-07:00`)
     ///     anything created before the end date will be returned.
     ///     
     ///     If the end date is omitted (`2014-05-15T13:35:01-07:00,`) the
@@ -409,7 +409,7 @@ public class SearchForContentQueryParams {
     ///       the trash
     ///     * `all_items` - Searches for both trashed and non-trashed items.
     ///   - mdfilters: Limits the search results to any items for which the metadata matches the provided filter.
-    ///     This parameter is a list that specifies exactly **one** metadata template used to filter the search results. 
+    ///     This parameter is a list that specifies exactly **one** metadata template used to filter the search results.
     ///     The parameter is required unless the `query` parameter is provided.
     ///   - sort: Defines the order in which search results are returned. This API
     ///     defaults to returning items by relevance unless this parameter is
@@ -468,7 +468,7 @@ public class SearchForContentQueryParams {
     ///     
     ///     Date ranges are defined as comma separated RFC3339 timestamps.
     ///     
-    ///     If the the start date is omitted (`2014-05-17T13:35:01-07:00`),
+    ///     If the start date is omitted (`2014-05-17T13:35:01-07:00`),
     ///     anything deleted before the end date will be returned.
     ///     
     ///     If the end date is omitted (`2014-05-15T13:35:01-07:00`),

Sources/Managers/Search/SearchForContentQueryParams.swift

@@ -34,13 +34,13 @@ public class SearchManager {
     /// - Parameters:
     ///   - queryParams: Query parameters of searchForContent method
     ///   - headers: Headers of searchForContent method
-    /// - Returns: The `SearchResultsOrSearchResultsWithSharedLinks`.
+    /// - Returns: The `SearchResultsResponse`.
     /// - Throws: The `GeneralError`.
-    public func searchForContent(queryParams: SearchForContentQueryParams = SearchForContentQueryParams(), headers: SearchForContentHeaders = SearchForContentHeaders()) async throws -> SearchResultsOrSearchResultsWithSharedLinks {
+    public func searchForContent(queryParams: SearchForContentQueryParams = SearchForContentQueryParams(), headers: SearchForContentHeaders = SearchForContentHeaders()) async throws -> SearchResultsResponse {
         let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["query": Utils.Strings.toString(value: queryParams.query), "scope": Utils.Strings.toString(value: queryParams.scope), "file_extensions": Utils.Strings.toString(value: queryParams.fileExtensions), "created_at_range": Utils.Strings.toString(value: queryParams.createdAtRange), "updated_at_range": Utils.Strings.toString(value: queryParams.updatedAtRange), "size_range": Utils.Strings.toString(value: queryParams.sizeRange), "owner_user_ids": Utils.Strings.toString(value: queryParams.ownerUserIds), "recent_updater_user_ids": Utils.Strings.toString(value: queryParams.recentUpdaterUserIds), "ancestor_folder_ids": Utils.Strings.toString(value: queryParams.ancestorFolderIds), "content_types": Utils.Strings.toString(value: queryParams.contentTypes), "type": Utils.Strings.toString(value: queryParams.type), "trash_content": Utils.Strings.toString(value: queryParams.trashContent), "mdfilters": Utils.Strings.toString(value: queryParams.mdfilters), "sort": Utils.Strings.toString(value: queryParams.sort), "direction": Utils.Strings.toString(value: queryParams.direction), "limit": Utils.Strings.toString(value: queryParams.limit), "include_recent_shared_links": Utils.Strings.toString(value: queryParams.includeRecentSharedLinks), "fields": Utils.Strings.toString(value: queryParams.fields), "offset": Utils.Strings.toString(value: queryParams.offset), "deleted_user_ids": Utils.Strings.toString(value: queryParams.deletedUserIds), "deleted_at_range": Utils.Strings.toString(value: queryParams.deletedAtRange)])
         let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge([:], headers.extraHeaders))
         let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/search")", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
-        return try SearchResultsOrSearchResultsWithSharedLinks.deserialize(from: response.data!)
+        return try SearchResultsResponse.deserialize(from: response.data!)
     }
 
 }

Sources/Managers/Search/SearchManager.swift

@@ -15,19 +15,19 @@ public class CreateBoxSkillCardsOnFileRequestBody: Codable, RawJSONReadable {
 
 
     /// A list of Box Skill cards to apply to this file.
-    public let cards: [KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard]
+    public let cards: [SkillCard]
 
     /// Initializer for a CreateBoxSkillCardsOnFileRequestBody.
     ///
     /// - Parameters:
     ///   - cards: A list of Box Skill cards to apply to this file.
-    public init(cards: [KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard]) {
+    public init(cards: [SkillCard]) {
         self.cards = cards
     }
 
     required public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
-        cards = try container.decode([KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard].self, forKey: .cards)
+        cards = try container.decode([SkillCard].self, forKey: .cards)
     }
 
     public func encode(to encoder: Encoder) throws {

Sources/Managers/Skills/CreateBoxSkillCardsOnFileRequestBody.swift

@@ -15,19 +15,19 @@ public class UpdateAllSkillCardsOnFileRequestBodyMetadataField: Codable, RawJSON
 
 
     /// A list of Box Skill cards to apply to this file.
-    public let cards: [KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard]?
+    public let cards: [SkillCard]?
 
     /// Initializer for a UpdateAllSkillCardsOnFileRequestBodyMetadataField.
     ///
     /// - Parameters:
     ///   - cards: A list of Box Skill cards to apply to this file.
-    public init(cards: [KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard]? = nil) {
+    public init(cards: [SkillCard]? = nil) {
         self.cards = cards
     }
 
     required public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
-        cards = try container.decodeIfPresent([KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard].self, forKey: .cards)
+        cards = try container.decodeIfPresent([SkillCard].self, forKey: .cards)
     }
 
     public func encode(to encoder: Encoder) throws {

Sources/Managers/Skills/UpdateAllSkillCardsOnFileRequestBodyMetadataField.swift

@@ -24,7 +24,7 @@ public class UpdateBoxSkillCardsOnFileRequestBody: Codable, RawJSONReadable {
     /// zero-indexed position of the card in the list of cards.
     public let path: String?
 
-    public let value: KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard?
+    public let value: SkillCard?
 
     /// Initializer for a UpdateBoxSkillCardsOnFileRequestBody.
     ///
@@ -34,7 +34,7 @@ public class UpdateBoxSkillCardsOnFileRequestBody: Codable, RawJSONReadable {
     ///     this will be in the format `/cards/{index}` where `index` is the
     ///     zero-indexed position of the card in the list of cards.
     ///   - value: 
-    public init(op: UpdateBoxSkillCardsOnFileRequestBodyOpField? = nil, path: String? = nil, value: KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard? = nil) {
+    public init(op: UpdateBoxSkillCardsOnFileRequestBodyOpField? = nil, path: String? = nil, value: SkillCard? = nil) {
         self.op = op
         self.path = path
         self.value = value
@@ -44,7 +44,7 @@ public class UpdateBoxSkillCardsOnFileRequestBody: Codable, RawJSONReadable {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         op = try container.decodeIfPresent(UpdateBoxSkillCardsOnFileRequestBodyOpField.self, forKey: .op)
         path = try container.decodeIfPresent(String.self, forKey: .path)
-        value = try container.decodeIfPresent(KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard.self, forKey: .value)
+        value = try container.decodeIfPresent(SkillCard.self, forKey: .value)
     }
 
     public func encode(to encoder: Encoder) throws {