feat: Add Box Sign shared requests (box/box-openapi#504) (#348)

Co-authored-by: box-sdk-build <[email protected]>

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "b5ed925", "specHash": "99792c6", "version": "0.5.0" }
+{ "engineHash": "b5ed925", "specHash": "3dc3f1e", "version": "0.5.0" }

Sources/Managers/SignRequests/GetSignRequestsQueryParams.swift

@@ -10,6 +10,16 @@ public class GetSignRequestsQueryParams {
     /// The maximum number of items to return per page.
     public let limit: Int64?
 
+    /// A list of sender emails to filter the signature requests by sender. 
+    /// If provided, `shared_requests` must be set to `true`.
+    public let senders: [String]?
+
+    /// If set to `true`, only includes requests that user is not an owner,
+    /// but user is a collaborator. Collaborator access is determined by the
+    /// user access level of the sign files of the request.
+    /// Default is `false`. Must be set to `true` if `senders` are provided.
+    public let sharedRequests: Bool?
+
     /// Initializer for a GetSignRequestsQueryParams.
     ///
     /// - Parameters:
@@ -18,9 +28,17 @@ public class GetSignRequestsQueryParams {
     ///     
     ///     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) {
+    ///   - senders: A list of sender emails to filter the signature requests by sender. 
+    ///     If provided, `shared_requests` must be set to `true`.
+    ///   - sharedRequests: If set to `true`, only includes requests that user is not an owner,
+    ///     but user is a collaborator. Collaborator access is determined by the
+    ///     user access level of the sign files of the request.
+    ///     Default is `false`. Must be set to `true` if `senders` are provided.
+    public init(marker: String? = nil, limit: Int64? = nil, senders: [String]? = nil, sharedRequests: Bool? = nil) {
         self.marker = marker
         self.limit = limit
+        self.senders = senders
+        self.sharedRequests = sharedRequests
     }
 
 }

Sources/Managers/SignRequests/SignRequestsManager.swift

@@ -59,7 +59,7 @@ public class SignRequestsManager {
     /// - Returns: The `SignRequests`.
     /// - Throws: The `GeneralError`.
     public func getSignRequests(queryParams: GetSignRequestsQueryParams = GetSignRequestsQueryParams(), headers: GetSignRequestsHeaders = GetSignRequestsHeaders()) async throws -> SignRequests {
-        let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["marker": Utils.Strings.toString(value: queryParams.marker), "limit": Utils.Strings.toString(value: queryParams.limit)])
+        let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["marker": Utils.Strings.toString(value: queryParams.marker), "limit": Utils.Strings.toString(value: queryParams.limit), "senders": Utils.Strings.toString(value: queryParams.senders), "shared_requests": Utils.Strings.toString(value: queryParams.sharedRequests)])
         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/sign_requests")", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: "json", auth: self.auth, networkSession: self.networkSession))
         return try SignRequests.deserialize(from: response.data)

Sources/Schemas/SignRequest/SignRequest.swift

@@ -14,6 +14,9 @@ public class SignRequest: SignRequestBase {
         case signFiles = "sign_files"
         case autoExpireAt = "auto_expire_at"
         case parentFolder = "parent_folder"
+        case collaboratorLevel = "collaborator_level"
+        case senderEmail = "sender_email"
+        case senderId = "sender_id"
     }
 
     /// object type
@@ -54,6 +57,15 @@ public class SignRequest: SignRequestBase {
 
     public let parentFolder: FolderMini?
 
+    /// The collaborator level of the user to the sign request. Values can include "owner", "editor", and "viewer"
+    public let collaboratorLevel: String?
+
+    /// The email address of the sender of the sign request.
+    public let senderEmail: String?
+
+    /// The user ID of the sender of the sign request.
+    public let senderId: Int64?
+
     /// Initializer for a SignRequest.
     ///
     /// - Parameters:
@@ -88,7 +100,10 @@ public class SignRequest: SignRequestBase {
     ///     and can be downloaded at any point in the signing process.
     ///   - autoExpireAt: Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned.
     ///   - parentFolder: 
-    public init(isDocumentPreparationNeeded: Bool? = nil, redirectUrl: String? = nil, declinedRedirectUrl: String? = nil, areTextSignaturesEnabled: Bool? = nil, emailSubject: String? = nil, emailMessage: String? = nil, areRemindersEnabled: Bool? = nil, name: String? = nil, prefillTags: [SignRequestPrefillTag]? = nil, daysValid: Int64? = nil, externalId: String? = nil, templateId: String? = nil, externalSystemName: String? = nil, type: SignRequestTypeField? = nil, sourceFiles: [FileBase]? = nil, signers: [SignRequestSigner]? = nil, signatureColor: String? = nil, id: String? = nil, prepareUrl: String? = nil, signingLog: FileMini? = nil, status: SignRequestStatusField? = nil, signFiles: SignRequestSignFilesField? = nil, autoExpireAt: Date? = nil, parentFolder: FolderMini? = nil) {
+    ///   - collaboratorLevel: The collaborator level of the user to the sign request. Values can include "owner", "editor", and "viewer"
+    ///   - senderEmail: The email address of the sender of the sign request.
+    ///   - senderId: The user ID of the sender of the sign request.
+    public init(isDocumentPreparationNeeded: Bool? = nil, redirectUrl: String? = nil, declinedRedirectUrl: String? = nil, areTextSignaturesEnabled: Bool? = nil, emailSubject: String? = nil, emailMessage: String? = nil, areRemindersEnabled: Bool? = nil, name: String? = nil, prefillTags: [SignRequestPrefillTag]? = nil, daysValid: Int64? = nil, externalId: String? = nil, templateId: String? = nil, externalSystemName: String? = nil, type: SignRequestTypeField? = nil, sourceFiles: [FileBase]? = nil, signers: [SignRequestSigner]? = nil, signatureColor: String? = nil, id: String? = nil, prepareUrl: String? = nil, signingLog: FileMini? = nil, status: SignRequestStatusField? = nil, signFiles: SignRequestSignFilesField? = nil, autoExpireAt: Date? = nil, parentFolder: FolderMini? = nil, collaboratorLevel: String? = nil, senderEmail: String? = nil, senderId: Int64? = nil) {
         self.type = type
         self.sourceFiles = sourceFiles
         self.signers = signers
@@ -100,6 +115,9 @@ public class SignRequest: SignRequestBase {
         self.signFiles = signFiles
         self.autoExpireAt = autoExpireAt
         self.parentFolder = parentFolder
+        self.collaboratorLevel = collaboratorLevel
+        self.senderEmail = senderEmail
+        self.senderId = senderId
 
         super.init(isDocumentPreparationNeeded: isDocumentPreparationNeeded, redirectUrl: redirectUrl, declinedRedirectUrl: declinedRedirectUrl, areTextSignaturesEnabled: areTextSignaturesEnabled, emailSubject: emailSubject, emailMessage: emailMessage, areRemindersEnabled: areRemindersEnabled, name: name, prefillTags: prefillTags, daysValid: daysValid, externalId: externalId, templateId: templateId, externalSystemName: externalSystemName)
     }
@@ -122,6 +140,9 @@ public class SignRequest: SignRequestBase {
         }
 
         parentFolder = try container.decodeIfPresent(FolderMini.self, forKey: .parentFolder)
+        collaboratorLevel = try container.decodeIfPresent(String.self, forKey: .collaboratorLevel)
+        senderEmail = try container.decodeIfPresent(String.self, forKey: .senderEmail)
+        senderId = try container.decodeIfPresent(Int64.self, forKey: .senderId)
 
         try super.init(from: decoder)
     }
@@ -142,6 +163,9 @@ public class SignRequest: SignRequestBase {
         }
 
         try container.encodeIfPresent(parentFolder, forKey: .parentFolder)
+        try container.encodeIfPresent(collaboratorLevel, forKey: .collaboratorLevel)
+        try container.encodeIfPresent(senderEmail, forKey: .senderEmail)
+        try container.encodeIfPresent(senderId, forKey: .senderId)
         try super.encode(to: encoder)
     }