fix: add verification_phone_number property to create sign request (box/box-openapi#515) (#391)

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

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "41feeaa", "specHash": "3dc6f70", "version": "0.6.0" }
+{ "engineHash": "41feeaa", "specHash": "1080bb4", "version": "0.6.0" }

Sources/Schemas/SignRequestCreateSigner/SignRequestCreateSigner.swift

@@ -12,6 +12,7 @@ public class SignRequestCreateSigner: Codable {
         case redirectUrl = "redirect_url"
         case declinedRedirectUrl = "declined_redirect_url"
         case loginRequired = "login_required"
+        case verificationPhoneNumber = "verification_phone_number"
         case password
         case signerGroupId = "signer_group_id"
         case suppressNotifications = "suppress_notifications"
@@ -58,6 +59,11 @@ public class SignRequestCreateSigner: Codable {
     /// a free Box account.
     public let loginRequired: Bool?
 
+    /// If set, this phone number will be used to verify the signer
+    /// via two-factor authentication before they are able to sign the document.
+    /// Cannot be selected in combination with `login_required`.
+    public let verificationPhoneNumber: String?
+
     /// If set, the signer is required to enter the password before they are able
     /// to sign a document. This field is write only.
     public let password: String?
@@ -102,6 +108,9 @@ public class SignRequestCreateSigner: Codable {
     ///     before signing the request. If the signer does not have
     ///     an existing account, they will have the option to create
     ///     a free Box account.
+    ///   - verificationPhoneNumber: If set, this phone number will be used to verify the signer
+    ///     via two-factor authentication before they are able to sign the document.
+    ///     Cannot be selected in combination with `login_required`.
     ///   - password: If set, the signer is required to enter the password before they are able
     ///     to sign a document. This field is write only.
     ///   - signerGroupId: If set, signers who have the same value will be assigned to the same input and to the same signer group.
@@ -112,7 +121,7 @@ public class SignRequestCreateSigner: Codable {
     ///     determine which signers belongs to same group. A successful response will provide a generated UUID value
     ///     instead for signers in the same signer group.
     ///   - suppressNotifications: If true, no emails about the sign request will be sent
-    public init(email: String? = nil, role: SignRequestCreateSignerRoleField? = nil, isInPerson: Bool? = nil, order: Int64? = nil, embedUrlExternalUserId: String? = nil, redirectUrl: String? = nil, declinedRedirectUrl: String? = nil, loginRequired: Bool? = nil, password: String? = nil, signerGroupId: String? = nil, suppressNotifications: Bool? = nil) {
+    public init(email: String? = nil, role: SignRequestCreateSignerRoleField? = nil, isInPerson: Bool? = nil, order: Int64? = nil, embedUrlExternalUserId: String? = nil, redirectUrl: String? = nil, declinedRedirectUrl: String? = nil, loginRequired: Bool? = nil, verificationPhoneNumber: String? = nil, password: String? = nil, signerGroupId: String? = nil, suppressNotifications: Bool? = nil) {
         self.email = email
         self.role = role
         self.isInPerson = isInPerson
@@ -121,6 +130,7 @@ public class SignRequestCreateSigner: Codable {
         self.redirectUrl = redirectUrl
         self.declinedRedirectUrl = declinedRedirectUrl
         self.loginRequired = loginRequired
+        self.verificationPhoneNumber = verificationPhoneNumber
         self.password = password
         self.signerGroupId = signerGroupId
         self.suppressNotifications = suppressNotifications
@@ -136,6 +146,7 @@ public class SignRequestCreateSigner: Codable {
         redirectUrl = try container.decodeIfPresent(String.self, forKey: .redirectUrl)
         declinedRedirectUrl = try container.decodeIfPresent(String.self, forKey: .declinedRedirectUrl)
         loginRequired = try container.decodeIfPresent(Bool.self, forKey: .loginRequired)
+        verificationPhoneNumber = try container.decodeIfPresent(String.self, forKey: .verificationPhoneNumber)
         password = try container.decodeIfPresent(String.self, forKey: .password)
         signerGroupId = try container.decodeIfPresent(String.self, forKey: .signerGroupId)
         suppressNotifications = try container.decodeIfPresent(Bool.self, forKey: .suppressNotifications)
@@ -151,6 +162,7 @@ public class SignRequestCreateSigner: Codable {
         try container.encodeIfPresent(redirectUrl, forKey: .redirectUrl)
         try container.encodeIfPresent(declinedRedirectUrl, forKey: .declinedRedirectUrl)
         try container.encodeIfPresent(loginRequired, forKey: .loginRequired)
+        try container.encodeIfPresent(verificationPhoneNumber, forKey: .verificationPhoneNumber)
         try container.encodeIfPresent(password, forKey: .password)
         try container.encodeIfPresent(signerGroupId, forKey: .signerGroupId)
         try container.encodeIfPresent(suppressNotifications, forKey: .suppressNotifications)

Sources/Schemas/SignRequestSigner/SignRequestSigner.swift

@@ -58,6 +58,9 @@ public class SignRequestSigner: SignRequestCreateSigner {
     ///     before signing the request. If the signer does not have
     ///     an existing account, they will have the option to create
     ///     a free Box account.
+    ///   - verificationPhoneNumber: If set, this phone number will be used to verify the signer
+    ///     via two-factor authentication before they are able to sign the document.
+    ///     Cannot be selected in combination with `login_required`.
     ///   - password: If set, the signer is required to enter the password before they are able
     ///     to sign a document. This field is write only.
     ///   - signerGroupId: If set, signers who have the same value will be assigned to the same input and to the same signer group.
@@ -78,14 +81,14 @@ public class SignRequestSigner: SignRequestCreateSigner {
     ///     only if the `embed_url_external_user_id`
     ///     parameter was passed in the
     ///     `create Box Sign request` call.
-    public init(email: String? = nil, role: SignRequestCreateSignerRoleField? = nil, isInPerson: Bool? = nil, order: Int64? = nil, embedUrlExternalUserId: String? = nil, redirectUrl: String? = nil, declinedRedirectUrl: String? = nil, loginRequired: Bool? = nil, password: String? = nil, signerGroupId: String? = nil, suppressNotifications: Bool? = nil, hasViewedDocument: Bool? = nil, signerDecision: SignRequestSignerSignerDecisionField? = nil, inputs: [SignRequestSignerInput]? = nil, embedUrl: String? = nil, iframeableEmbedUrl: String? = nil) {
+    public init(email: String? = nil, role: SignRequestCreateSignerRoleField? = nil, isInPerson: Bool? = nil, order: Int64? = nil, embedUrlExternalUserId: String? = nil, redirectUrl: String? = nil, declinedRedirectUrl: String? = nil, loginRequired: Bool? = nil, verificationPhoneNumber: String? = nil, password: String? = nil, signerGroupId: String? = nil, suppressNotifications: Bool? = nil, hasViewedDocument: Bool? = nil, signerDecision: SignRequestSignerSignerDecisionField? = nil, inputs: [SignRequestSignerInput]? = nil, embedUrl: String? = nil, iframeableEmbedUrl: String? = nil) {
         self.hasViewedDocument = hasViewedDocument
         self.signerDecision = signerDecision
         self.inputs = inputs
         self.embedUrl = embedUrl
         self.iframeableEmbedUrl = iframeableEmbedUrl
 
-        super.init(email: email, role: role, isInPerson: isInPerson, order: order, embedUrlExternalUserId: embedUrlExternalUserId, redirectUrl: redirectUrl, declinedRedirectUrl: declinedRedirectUrl, loginRequired: loginRequired, password: password, signerGroupId: signerGroupId, suppressNotifications: suppressNotifications)
+        super.init(email: email, role: role, isInPerson: isInPerson, order: order, embedUrlExternalUserId: embedUrlExternalUserId, redirectUrl: redirectUrl, declinedRedirectUrl: declinedRedirectUrl, loginRequired: loginRequired, verificationPhoneNumber: verificationPhoneNumber, password: password, signerGroupId: signerGroupId, suppressNotifications: suppressNotifications)
     }
 
     required public init(from decoder: Decoder) throws {