feat(boxsdkgen): Support chunk upload session plan API (box/box-openapi#616) (#1632)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "04310d4", "specHash": "be75fa1", "version": "6.14.0" }
+{ "engineHash": "04310d4", "specHash": "88cd5aa", "version": "6.14.0" }

BoxSdkGen/BoxSdkGen.xcodeproj/project.pbxproj

@@ -188,6 +188,47 @@ public class ChunkedUploadsManager {
         return try UploadParts.deserialize(from: response.data!)
     }
 
+    /// Using this method with urls provided in response when creating a new upload session is preferred to use over CreateFileUploadSessionPlan method. 
+    /// This allows to always upload your content to the closest Box data center and can significantly improve upload speed.
+    ///  Plan an upload session by checking which parts already exist on the server.
+    /// This endpoint allows clients to optimize uploads by skipping parts that
+    /// have already been uploaded (cache hits) and only uploading missing parts.
+    /// 
+    /// The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
+    /// and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
+    ///
+    /// - Parameters:
+    ///   - url: URL of createFileUploadSessionPlan method
+    ///   - requestBody: Request body of createFileUploadSessionPlan method
+    ///   - headers: Headers of createFileUploadSessionPlan method
+    /// - Returns: The `UploadSessionPlanResponse`.
+    /// - Throws: The `GeneralError`.
+    public func createFileUploadSessionPlanByUrl(url: String, requestBody: UploadSessionPlanRequest, headers: CreateFileUploadSessionPlanByUrlHeaders = CreateFileUploadSessionPlanByUrlHeaders()) async throws -> UploadSessionPlanResponse {
+        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: url, method: "POST", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try UploadSessionPlanResponse.deserialize(from: response.data!)
+    }
+
+    /// Plan an upload session by checking which parts already exist on the server.
+    /// This endpoint allows clients to optimize uploads by skipping parts that
+    /// have already been uploaded (cache hits) and only uploading missing parts.
+    /// 
+    /// The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
+    /// and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
+    ///
+    /// - Parameters:
+    ///   - uploadSessionId: The ID of the upload session.
+    ///     Example: "D5E3F7A"
+    ///   - requestBody: Request body of createFileUploadSessionPlan method
+    ///   - headers: Headers of createFileUploadSessionPlan method
+    /// - Returns: The `UploadSessionPlanResponse`.
+    /// - Throws: The `GeneralError`.
+    public func createFileUploadSessionPlan(uploadSessionId: String, requestBody: UploadSessionPlanRequest, headers: CreateFileUploadSessionPlanHeaders = CreateFileUploadSessionPlanHeaders()) async throws -> UploadSessionPlanResponse {
+        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.uploadUrl)\("/2.0/files/upload_sessions/")\(Utils.Strings.toString(value: uploadSessionId)!)\("/plan")", method: "POST", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try UploadSessionPlanResponse.deserialize(from: response.data!)
+    }
+
     /// Using this method with urls provided in response when creating a new upload session is preferred to use over CreateFileUploadSessionCommit method. 
     /// This allows to always upload your content to the closest Box data center and can significantly improve upload speed.
     ///  Close an upload session and create a file from the uploaded chunks.

BoxSdkGen/Sources/Managers/ChunkedUploads/ChunkedUploadsManager.swift

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

BoxSdkGen/Sources/Managers/ChunkedUploads/CreateFileUploadSessionPlanByUrlHeaders.swift

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

BoxSdkGen/Sources/Managers/ChunkedUploads/CreateFileUploadSessionPlanHeaders.swift

@@ -0,0 +1,74 @@
+import Foundation
+
+/// Represents a planned upload part with `SHA-512` hash
+/// for upload session planning.
+public class UploadPartPlan: Codable, RawJSONReadable {
+    private enum CodingKeys: String, CodingKey {
+        case offset
+        case size
+        case sha512
+    }
+
+    /// Internal backing store for rawData. Used to store raw dictionary data associated with the instance.
+    private var _rawData: [String: Any]?
+
+    /// Returns the raw dictionary data associated with the instance. This is a read-only property.
+    public var rawData: [String: Any]? {
+        return _rawData
+    }
+
+
+    /// The offset of the chunk within the file
+    /// in bytes. The lower bound of the position
+    /// of the chunk within the file.
+    public let offset: Int64
+
+    /// The size of the chunk in bytes.
+    public let size: Int64
+
+    /// The `SHA-512` hash of the chunk.
+    public let sha512: String
+
+    /// Initializer for a UploadPartPlan.
+    ///
+    /// - Parameters:
+    ///   - offset: The offset of the chunk within the file
+    ///     in bytes. The lower bound of the position
+    ///     of the chunk within the file.
+    ///   - size: The size of the chunk in bytes.
+    ///   - sha512: The `SHA-512` hash of the chunk.
+    public init(offset: Int64, size: Int64, sha512: String) {
+        self.offset = offset
+        self.size = size
+        self.sha512 = sha512
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        offset = try container.decode(Int64.self, forKey: .offset)
+        size = try container.decode(Int64.self, forKey: .size)
+        sha512 = try container.decode(String.self, forKey: .sha512)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(offset, forKey: .offset)
+        try container.encode(size, forKey: .size)
+        try container.encode(sha512, forKey: .sha512)
+    }
+
+    /// Sets the raw JSON data.
+    ///
+    /// - Parameters:
+    ///   - rawData: A dictionary containing the raw JSON data
+    func setRawData(rawData: [String: Any]?) {
+        self._rawData = rawData
+    }
+
+    /// Gets the raw JSON data
+    /// - Returns: The `[String: Any]?`.
+    func getRawData() -> [String: Any]? {
+        return self._rawData
+    }
+
+}

BoxSdkGen/Sources/Schemas/UploadPartPlan/UploadPartPlan.swift

@@ -0,0 +1,82 @@
+import Foundation
+
+/// Represents a planned upload part that already exists
+/// on the server (cache hit).
+public class UploadPartPlanHit: Codable, RawJSONReadable {
+    private enum CodingKeys: String, CodingKey {
+        case offset
+        case size
+        case sha512
+        case partId = "part_id"
+    }
+
+    /// Internal backing store for rawData. Used to store raw dictionary data associated with the instance.
+    private var _rawData: [String: Any]?
+
+    /// Returns the raw dictionary data associated with the instance. This is a read-only property.
+    public var rawData: [String: Any]? {
+        return _rawData
+    }
+
+
+    /// The offset of the chunk within the file
+    /// in bytes. The lower bound of the position
+    /// of the chunk within the file.
+    public let offset: Int64
+
+    /// The size of the chunk in bytes.
+    public let size: Int64
+
+    /// The `SHA-512` hash of the chunk.
+    public let sha512: String
+
+    /// The unique ID of the chunk.
+    public let partId: String
+
+    /// Initializer for a UploadPartPlanHit.
+    ///
+    /// - Parameters:
+    ///   - offset: The offset of the chunk within the file
+    ///     in bytes. The lower bound of the position
+    ///     of the chunk within the file.
+    ///   - size: The size of the chunk in bytes.
+    ///   - sha512: The `SHA-512` hash of the chunk.
+    ///   - partId: The unique ID of the chunk.
+    public init(offset: Int64, size: Int64, sha512: String, partId: String) {
+        self.offset = offset
+        self.size = size
+        self.sha512 = sha512
+        self.partId = partId
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        offset = try container.decode(Int64.self, forKey: .offset)
+        size = try container.decode(Int64.self, forKey: .size)
+        sha512 = try container.decode(String.self, forKey: .sha512)
+        partId = try container.decode(String.self, forKey: .partId)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(offset, forKey: .offset)
+        try container.encode(size, forKey: .size)
+        try container.encode(sha512, forKey: .sha512)
+        try container.encode(partId, forKey: .partId)
+    }
+
+    /// Sets the raw JSON data.
+    ///
+    /// - Parameters:
+    ///   - rawData: A dictionary containing the raw JSON data
+    func setRawData(rawData: [String: Any]?) {
+        self._rawData = rawData
+    }
+
+    /// Gets the raw JSON data
+    /// - Returns: The `[String: Any]?`.
+    func getRawData() -> [String: Any]? {
+        return self._rawData
+    }
+
+}

BoxSdkGen/Sources/Schemas/UploadPartPlanHit/UploadPartPlanHit.swift

@@ -2,6 +2,7 @@ import Foundation
 
 public class UploadSessionSessionEndpointsField: Codable, RawJSONReadable {
     private enum CodingKeys: String, CodingKey {
+        case plan
         case uploadPart = "upload_part"
         case commit
         case abort
@@ -19,6 +20,10 @@ public class UploadSessionSessionEndpointsField: Codable, RawJSONReadable {
     }
 
 
+    /// The URL used to plan the upload session by checking which parts
+    /// already exist on the server.
+    public let plan: String?
+
     /// The URL to upload parts to.
     public let uploadPart: String?
 
@@ -40,13 +45,16 @@ public class UploadSessionSessionEndpointsField: Codable, RawJSONReadable {
     /// Initializer for a UploadSessionSessionEndpointsField.
     ///
     /// - Parameters:
+    ///   - plan: The URL used to plan the upload session by checking which parts
+    ///     already exist on the server.
     ///   - uploadPart: The URL to upload parts to.
     ///   - commit: The URL used to commit the file.
     ///   - abort: The URL for used to abort the session.
     ///   - listParts: The URL users to list all parts.
     ///   - status: The URL used to get the status of the upload.
     ///   - logEvent: The URL used to get the upload log from.
-    public init(uploadPart: String? = nil, commit: String? = nil, abort: String? = nil, listParts: String? = nil, status: String? = nil, logEvent: String? = nil) {
+    public init(plan: String? = nil, uploadPart: String? = nil, commit: String? = nil, abort: String? = nil, listParts: String? = nil, status: String? = nil, logEvent: String? = nil) {
+        self.plan = plan
         self.uploadPart = uploadPart
         self.commit = commit
         self.abort = abort
@@ -57,6 +65,7 @@ public class UploadSessionSessionEndpointsField: Codable, RawJSONReadable {
 
     required public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
+        plan = try container.decodeIfPresent(String.self, forKey: .plan)
         uploadPart = try container.decodeIfPresent(String.self, forKey: .uploadPart)
         commit = try container.decodeIfPresent(String.self, forKey: .commit)
         abort = try container.decodeIfPresent(String.self, forKey: .abort)
@@ -67,6 +76,7 @@ public class UploadSessionSessionEndpointsField: Codable, RawJSONReadable {
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(plan, forKey: .plan)
         try container.encodeIfPresent(uploadPart, forKey: .uploadPart)
         try container.encodeIfPresent(commit, forKey: .commit)
         try container.encodeIfPresent(abort, forKey: .abort)

BoxSdkGen/Sources/Schemas/UploadSession/UploadSessionSessionEndpointsField.swift

@@ -0,0 +1,55 @@
+import Foundation
+
+/// Request body for planning an upload session.
+/// This allows checking which parts already exist
+/// on the server before uploading.
+public class UploadSessionPlanRequest: Codable, RawJSONReadable {
+    private enum CodingKeys: String, CodingKey {
+        case parts
+    }
+
+    /// Internal backing store for rawData. Used to store raw dictionary data associated with the instance.
+    private var _rawData: [String: Any]?
+
+    /// Returns the raw dictionary data associated with the instance. This is a read-only property.
+    public var rawData: [String: Any]? {
+        return _rawData
+    }
+
+
+    /// The list of parts to check for existence.
+    public let parts: [UploadPartPlan]
+
+    /// Initializer for a UploadSessionPlanRequest.
+    ///
+    /// - Parameters:
+    ///   - parts: The list of parts to check for existence.
+    public init(parts: [UploadPartPlan]) {
+        self.parts = parts
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        parts = try container.decode([UploadPartPlan].self, forKey: .parts)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(parts, forKey: .parts)
+    }
+
+    /// Sets the raw JSON data.
+    ///
+    /// - Parameters:
+    ///   - rawData: A dictionary containing the raw JSON data
+    func setRawData(rawData: [String: Any]?) {
+        self._rawData = rawData
+    }
+
+    /// Gets the raw JSON data
+    /// - Returns: The `[String: Any]?`.
+    func getRawData() -> [String: Any]? {
+        return self._rawData
+    }
+
+}