feat: Add External User Deletion API (box/box-openapi#550) (#969)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "ef443c1", "specHash": "99e14a6", "version": "0.1.0" }
+{ "engineHash": "54ce521", "specHash": "623b811", "version": "0.1.0" }

BoxSdkGen.xcodeproj/project.pbxproj

@@ -163,6 +163,8 @@ public class BoxClient {
 
     public let archives: ArchivesManager
 
+    public let externalUsers: ExternalUsersManager
+
     public init(auth: Authentication, networkSession: NetworkSession = NetworkSession(baseUrls: BaseUrls())) {
         self.auth = auth
         self.networkSession = networkSession
@@ -245,6 +247,7 @@ public class BoxClient {
         self.hubItems = HubItemsManager(auth: self.auth, networkSession: self.networkSession)
         self.shieldLists = ShieldListsManager(auth: self.auth, networkSession: self.networkSession)
         self.archives = ArchivesManager(auth: self.auth, networkSession: self.networkSession)
+        self.externalUsers = ExternalUsersManager(auth: self.auth, networkSession: self.networkSession)
     }
 
     /// Make a custom http request using the client authentication and network session.

Sources/Client/BoxClient.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class CreateExternalUserSubmitDeleteJobV2025R0Headers {
+    /// Version header.
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a CreateExternalUserSubmitDeleteJobV2025R0Headers.
+    ///
+    /// - 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/ExternalUsers/CreateExternalUserSubmitDeleteJobV2025R0Headers.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+public class ExternalUsersManager {
+    public let auth: Authentication?
+
+    public let networkSession: NetworkSession
+
+    public init(auth: Authentication? = nil, networkSession: NetworkSession = NetworkSession()) {
+        self.auth = auth
+        self.networkSession = networkSession
+    }
+
+    /// Delete external users from current user enterprise. This will remove each
+    /// external user from all invited collaborations within the current enterprise.
+    ///
+    /// - Parameters:
+    ///   - requestBody: Request body of createExternalUserSubmitDeleteJobV2025R0 method
+    ///   - headers: Headers of createExternalUserSubmitDeleteJobV2025R0 method
+    /// - Returns: The `ExternalUsersSubmitDeleteJobResponseV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func createExternalUserSubmitDeleteJobV2025R0(requestBody: ExternalUsersSubmitDeleteJobRequestV2025R0, headers: CreateExternalUserSubmitDeleteJobV2025R0Headers = CreateExternalUserSubmitDeleteJobV2025R0Headers()) async throws -> ExternalUsersSubmitDeleteJobResponseV2025R0 {
+        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/external_users/submit_delete_job")", method: "POST", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try ExternalUsersSubmitDeleteJobResponseV2025R0.deserialize(from: response.data!)
+    }
+
+}

Sources/Managers/ExternalUsers/ExternalUsersManager.swift

@@ -0,0 +1,69 @@
+import Foundation
+
+/// Result of a single external user deletion request.
+public class ExternalUserDeletionResultV2025R0: Codable, RawJSONReadable {
+    private enum CodingKeys: String, CodingKey {
+        case userId = "user_id"
+        case status
+        case detail
+    }
+
+    /// 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 ID of the external user.
+    public let userId: String
+
+    /// HTTP status code for a specific user's deletion request.
+    public let status: Int64
+
+    /// Deletion request status details.
+    public let detail: String?
+
+    /// Initializer for a ExternalUserDeletionResultV2025R0.
+    ///
+    /// - Parameters:
+    ///   - userId: The ID of the external user.
+    ///   - status: HTTP status code for a specific user's deletion request.
+    ///   - detail: Deletion request status details.
+    public init(userId: String, status: Int64, detail: String? = nil) {
+        self.userId = userId
+        self.status = status
+        self.detail = detail
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        userId = try container.decode(String.self, forKey: .userId)
+        status = try container.decode(Int64.self, forKey: .status)
+        detail = try container.decodeIfPresent(String.self, forKey: .detail)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(userId, forKey: .userId)
+        try container.encode(status, forKey: .status)
+        try container.encodeIfPresent(detail, forKey: .detail)
+    }
+
+    /// 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
+    }
+
+}

Sources/Schemas/V2025R0/ExternalUserDeletionResultV2025R0/ExternalUserDeletionResultV2025R0.swift

@@ -0,0 +1,53 @@
+import Foundation
+
+/// Request to submit a job to delete external users from the current enterprise.
+public class ExternalUsersSubmitDeleteJobRequestV2025R0: Codable, RawJSONReadable {
+    private enum CodingKeys: String, CodingKey {
+        case externalUsers = "external_users"
+    }
+
+    /// 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
+    }
+
+
+    /// List of external users to delete.
+    public let externalUsers: [UserReferenceV2025R0]
+
+    /// Initializer for a ExternalUsersSubmitDeleteJobRequestV2025R0.
+    ///
+    /// - Parameters:
+    ///   - externalUsers: List of external users to delete.
+    public init(externalUsers: [UserReferenceV2025R0]) {
+        self.externalUsers = externalUsers
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        externalUsers = try container.decode([UserReferenceV2025R0].self, forKey: .externalUsers)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(externalUsers, forKey: .externalUsers)
+    }
+
+    /// 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
+    }
+
+}

Sources/Schemas/V2025R0/ExternalUsersSubmitDeleteJobRequestV2025R0/ExternalUsersSubmitDeleteJobRequestV2025R0.swift

@@ -0,0 +1,53 @@
+import Foundation
+
+/// Multi-status response containing the result for each external user deletion request.
+public class ExternalUsersSubmitDeleteJobResponseV2025R0: Codable, RawJSONReadable {
+    private enum CodingKeys: String, CodingKey {
+        case entries
+    }
+
+    /// 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
+    }
+
+
+    /// Array of results of each external user deletion request.
+    public let entries: [ExternalUserDeletionResultV2025R0]
+
+    /// Initializer for a ExternalUsersSubmitDeleteJobResponseV2025R0.
+    ///
+    /// - Parameters:
+    ///   - entries: Array of results of each external user deletion request.
+    public init(entries: [ExternalUserDeletionResultV2025R0]) {
+        self.entries = entries
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        entries = try container.decode([ExternalUserDeletionResultV2025R0].self, forKey: .entries)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(entries, forKey: .entries)
+    }
+
+    /// 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
+    }
+
+}

Sources/Schemas/V2025R0/ExternalUsersSubmitDeleteJobResponseV2025R0/ExternalUsersSubmitDeleteJobResponseV2025R0.swift

@@ -16,7 +16,7 @@ public class ShieldListContentIpV2025R0: Codable, RawJSONReadable {
     }
 
 
-    /// List of ips and cidrs.
+    /// List of ip addresses and CIDRs.
     public let ipAddresses: [String]
 
     /// The type of content in the shield list.
@@ -25,7 +25,7 @@ public class ShieldListContentIpV2025R0: Codable, RawJSONReadable {
     /// Initializer for a ShieldListContentIpV2025R0.
     ///
     /// - Parameters:
-    ///   - ipAddresses: List of ips and cidrs.
+    ///   - ipAddresses: List of ip addresses and CIDRs.
     ///   - type: The type of content in the shield list.
     public init(ipAddresses: [String], type: ShieldListContentIpV2025R0TypeField = ShieldListContentIpV2025R0TypeField.ip) {
         self.ipAddresses = ipAddresses

Sources/Schemas/V2025R0/ShieldListContentIpV2025R0/ShieldListContentIpV2025R0.swift

@@ -0,0 +1,61 @@
+import Foundation
+
+/// User reference.
+public class UserReferenceV2025R0: Codable, RawJSONReadable {
+    private enum CodingKeys: String, CodingKey {
+        case id
+        case type
+    }
+
+    /// 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 unique identifier for the user.
+    public let id: String
+
+    /// The value is always `user`.
+    public let type: UserReferenceV2025R0TypeField
+
+    /// Initializer for a UserReferenceV2025R0.
+    ///
+    /// - Parameters:
+    ///   - id: The unique identifier for the user.
+    ///   - type: The value is always `user`.
+    public init(id: String, type: UserReferenceV2025R0TypeField = UserReferenceV2025R0TypeField.user) {
+        self.id = id
+        self.type = type
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        id = try container.decode(String.self, forKey: .id)
+        type = try container.decode(UserReferenceV2025R0TypeField.self, forKey: .type)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(id, forKey: .id)
+        try container.encode(type, forKey: .type)
+    }
+
+    /// 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
+    }
+
+}