feat: Support Box Doc Gen API (box/box-codegen#644) (#343)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "5ab9c2b", "specHash": "cf0a265", "version": "0.5.0" }
+{ "engineHash": "ead925a", "specHash": "091b558", "version": "0.5.0" }

BoxSdkGen.xcodeproj/project.pbxproj

@@ -145,6 +145,10 @@ public class BoxClient {
 
     public let ai: AiManager
 
+    public let docgenTemplate: DocgenTemplateManager
+
+    public let docgen: DocgenManager
+
     public init(auth: Authentication, networkSession: NetworkSession = NetworkSession(baseUrls: BaseUrls())) {
         self.auth = auth
         self.networkSession = networkSession
@@ -218,6 +222,8 @@ public class BoxClient {
         self.signTemplates = SignTemplatesManager(auth: self.auth, networkSession: self.networkSession)
         self.integrationMappings = IntegrationMappingsManager(auth: self.auth, networkSession: self.networkSession)
         self.ai = AiManager(auth: self.auth, networkSession: self.networkSession)
+        self.docgenTemplate = DocgenTemplateManager(auth: self.auth, networkSession: self.networkSession)
+        self.docgen = DocgenManager(auth: self.auth, networkSession: self.networkSession)
     }
 
     /// Create a new client to impersonate user with the provided ID. All calls made with the new client will be made in context of the impersonated user, leaving the original client unmodified.

Sources/Client/BoxClient.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class CreateDocgenBatchV2025R0Headers {
+    /// Version header
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a CreateDocgenBatchV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/Docgen/CreateDocgenBatchV2025R0Headers.swift

@@ -0,0 +1,70 @@
+import Foundation
+
+public class DocgenManager {
+    public let auth: Authentication?
+
+    public let networkSession: NetworkSession
+
+    public init(auth: Authentication? = nil, networkSession: NetworkSession = NetworkSession()) {
+        self.auth = auth
+        self.networkSession = networkSession
+    }
+
+    /// Get details of the Box Doc Gen job.
+    ///
+    /// - Parameters:
+    ///   - jobId: Box Doc Gen job ID.
+    ///     Example: 123
+    ///   - headers: Headers of getDocgenJobByIdV2025R0 method
+    /// - Returns: The `DocGenJobV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func getDocgenJobByIdV2025R0(jobId: String, headers: GetDocgenJobByIdV2025R0Headers = GetDocgenJobByIdV2025R0Headers()) async throws -> DocGenJobV2025R0 {
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/docgen_jobs/")\(jobId)", method: "GET", headers: headersMap, responseFormat: "json", auth: self.auth, networkSession: self.networkSession))
+        return try DocGenJobV2025R0.deserialize(from: response.data)
+    }
+
+    /// Lists all Box Doc Gen jobs for a user.
+    ///
+    /// - Parameters:
+    ///   - queryParams: Query parameters of getDocgenJobsV2025R0 method
+    ///   - headers: Headers of getDocgenJobsV2025R0 method
+    /// - Returns: The `DocGenJobsFullV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func getDocgenJobsV2025R0(queryParams: GetDocgenJobsV2025R0QueryParams = GetDocgenJobsV2025R0QueryParams(), headers: GetDocgenJobsV2025R0Headers = GetDocgenJobsV2025R0Headers()) async throws -> DocGenJobsFullV2025R0 {
+        let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["marker": Utils.Strings.toString(value: queryParams.marker), "limit": Utils.Strings.toString(value: queryParams.limit)])
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/docgen_jobs")", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: "json", auth: self.auth, networkSession: self.networkSession))
+        return try DocGenJobsFullV2025R0.deserialize(from: response.data)
+    }
+
+    /// Lists Box Doc Gen jobs in a batch
+    ///
+    /// - Parameters:
+    ///   - batchId: Box Doc Gen batch ID.
+    ///     Example: 123
+    ///   - queryParams: Query parameters of getDocgenBatchJobByIdV2025R0 method
+    ///   - headers: Headers of getDocgenBatchJobByIdV2025R0 method
+    /// - Returns: The `DocGenJobsV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func getDocgenBatchJobByIdV2025R0(batchId: String, queryParams: GetDocgenBatchJobByIdV2025R0QueryParams = GetDocgenBatchJobByIdV2025R0QueryParams(), headers: GetDocgenBatchJobByIdV2025R0Headers = GetDocgenBatchJobByIdV2025R0Headers()) async throws -> DocGenJobsV2025R0 {
+        let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["marker": Utils.Strings.toString(value: queryParams.marker), "limit": Utils.Strings.toString(value: queryParams.limit)])
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/docgen_batch_jobs/")\(batchId)", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: "json", auth: self.auth, networkSession: self.networkSession))
+        return try DocGenJobsV2025R0.deserialize(from: response.data)
+    }
+
+    /// Generates a document using a Box Doc Gen template.
+    ///
+    /// - Parameters:
+    ///   - requestBody: Request body of createDocgenBatchV2025R0 method
+    ///   - headers: Headers of createDocgenBatchV2025R0 method
+    /// - Returns: The `DocGenBatchBaseV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func createDocgenBatchV2025R0(requestBody: DocGenBatchCreateRequestV2025R0, headers: CreateDocgenBatchV2025R0Headers = CreateDocgenBatchV2025R0Headers()) async throws -> DocGenBatchBaseV2025R0 {
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/docgen_batches")", method: "POST", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: "json", auth: self.auth, networkSession: self.networkSession))
+        return try DocGenBatchBaseV2025R0.deserialize(from: response.data)
+    }
+
+}

Sources/Managers/Docgen/DocgenManager.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class GetDocgenBatchJobByIdV2025R0Headers {
+    /// Version header
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a GetDocgenBatchJobByIdV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/Docgen/GetDocgenBatchJobByIdV2025R0Headers.swift

@@ -0,0 +1,26 @@
+import Foundation
+
+public class GetDocgenBatchJobByIdV2025R0QueryParams {
+    /// Defines the position marker at which to begin returning results. This is
+    /// used when paginating using marker-based pagination.
+    /// 
+    /// This requires `usemarker` to be set to `true`.
+    public let marker: String?
+
+    /// The maximum number of items to return per page.
+    public let limit: Int64?
+
+    /// Initializer for a GetDocgenBatchJobByIdV2025R0QueryParams.
+    ///
+    /// - Parameters:
+    ///   - marker: Defines the position marker at which to begin returning results. This is
+    ///     used when paginating using marker-based pagination.
+    ///     
+    ///     This requires `usemarker` to be set to `true`.
+    ///   - limit: The maximum number of items to return per page.
+    public init(marker: String? = nil, limit: Int64? = nil) {
+        self.marker = marker
+        self.limit = limit
+    }
+
+}

Sources/Managers/Docgen/GetDocgenBatchJobByIdV2025R0QueryParams.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class GetDocgenJobByIdV2025R0Headers {
+    /// Version header
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a GetDocgenJobByIdV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/Docgen/GetDocgenJobByIdV2025R0Headers.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class GetDocgenJobsV2025R0Headers {
+    /// Version header
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a GetDocgenJobsV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/Docgen/GetDocgenJobsV2025R0Headers.swift

@@ -0,0 +1,26 @@
+import Foundation
+
+public class GetDocgenJobsV2025R0QueryParams {
+    /// Defines the position marker at which to begin returning results. This is
+    /// used when paginating using marker-based pagination.
+    /// 
+    /// This requires `usemarker` to be set to `true`.
+    public let marker: String?
+
+    /// The maximum number of items to return per page.
+    public let limit: Int64?
+
+    /// Initializer for a GetDocgenJobsV2025R0QueryParams.
+    ///
+    /// - Parameters:
+    ///   - marker: Defines the position marker at which to begin returning results. This is
+    ///     used when paginating using marker-based pagination.
+    ///     
+    ///     This requires `usemarker` to be set to `true`.
+    ///   - limit: The maximum number of items to return per page.
+    public init(marker: String? = nil, limit: Int64? = nil) {
+        self.marker = marker
+        self.limit = limit
+    }
+
+}