feat: Support iframeable_embed_url for sign request (#925)

box · Sep 25, 2023 · e9de994 · e9de994
1 parent 8fb1b64
commit e9de994
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 5 deletions.
diff --git a/Box.V2.Test.Integration/BoxSignRequestManagerIntegrationTest.cs b/Box.V2.Test.Integration/BoxSignRequestManagerIntegrationTest.cs
@@ -35,7 +35,8 @@ public async Task CreateSignRequestAsync_ForCorrectSignRequestCreateRequest_Shou
                     {
                         Email = "[email protected]",
                         RedirectUrl = new Uri("https://www.box.com/redirect_url_signer_1"),
-                        DeclinedRedirectUrl = new Uri("https://www.box.com/declined_redirect_url_singer_1")
+                        DeclinedRedirectUrl = new Uri("https://www.box.com/declined_redirect_url_singer_1"),
+                        EmbedUrlExternalUserId = UserId
                     }
                 },
                 ParentFolder = new BoxRequestEntity()
@@ -54,6 +55,10 @@ public async Task CreateSignRequestAsync_ForCorrectSignRequestCreateRequest_Shou
             Assert.AreEqual(signRequestCreateRequest.DeclinedRedirectUrl.ToString(), signRequest.DeclinedRedirectUrl.ToString());
             Assert.AreEqual(signRequestCreateRequest.ParentFolder.Id, signRequest.ParentFolder.Id);
 
+            // first signer is the sender with role final_copy_reader, second is the recipient with role signer
+            Assert.AreEqual(2, signRequest.Signers.Count);
+            Assert.IsNotNull(signRequest.Signers[1].IframeableEmbedUrl);
+
             await UserClient.SignRequestsManager.CancelSignRequestAsync(signRequest.Id);
 
             signRequest = await UserClient.SignRequestsManager.GetSignRequestByIdAsync(signRequest.Id);

diff --git a/Box.V2.Test/BoxSignRequestsManagerTest.cs b/Box.V2.Test/BoxSignRequestsManagerTest.cs
@@ -164,6 +164,7 @@ public async Task CreateSignRequest_OptionalParams_Success()
             Assert.AreEqual("[email protected]", response.Signers[0].Email);
             Assert.AreEqual("https://box.com/redirect_url_signer_1", response.Signers[0].RedirectUrl.ToString());
             Assert.AreEqual("https://box.com/declined_redirect_url_signer_1", response.Signers[0].DeclinedRedirectUrl.ToString());
+            Assert.AreEqual("https://app.box.com/embed/sign/document/bf7aaac6/", response.Signers[0].IframeableEmbedUrl);
             Assert.AreEqual(1, response.Signers[0].Inputs.Count);
             Assert.IsTrue(response.Signers[0].Inputs[0].CheckboxValue.Value);
             Assert.AreEqual(BoxSignRequestSingerInputContentType.checkbox, response.Signers[0].Inputs[0].ContentType);
@@ -213,6 +214,7 @@ public async Task GetSignRequest_Success()
             Assert.AreEqual("[email protected]", response.Entries[0].Signers[0].Email);
             Assert.AreEqual("https://box.com/redirect_url_signer_1", response.Entries[0].Signers[0].RedirectUrl.ToString());
             Assert.AreEqual("https://box.com/declined_redirect_url_signer_1", response.Entries[0].Signers[0].DeclinedRedirectUrl.ToString());
+            Assert.AreEqual("https://app.box.com/embed/sign/document/bf7aaac6/", response.Entries[0].Signers[0].IframeableEmbedUrl);
             Assert.AreEqual("12345", response.Entries[0].ParentFolder.Id);
             Assert.IsTrue(response.Entries[0].IsDocumentPreparationNeeded);
             Assert.IsTrue(response.Entries[0].AreRemindersEnabled);
@@ -259,6 +261,7 @@ public async Task GetSignRequestById_Success()
             Assert.AreEqual("[email protected]", response.Signers[0].Email);
             Assert.AreEqual("https://box.com/redirect_url_signer_1", response.Signers[0].RedirectUrl.ToString());
             Assert.AreEqual("https://box.com/declined_redirect_url_signer_1", response.Signers[0].DeclinedRedirectUrl.ToString());
+            Assert.AreEqual("https://app.box.com/embed/sign/document/bf7aaac6/", response.Signers[0].IframeableEmbedUrl);
             Assert.AreEqual(1, response.Signers[0].Inputs.Count);
             Assert.IsTrue(response.Signers[0].Inputs[0].CheckboxValue.Value);
             Assert.AreEqual(BoxSignRequestSingerInputContentType.checkbox, response.Signers[0].Inputs[0].ContentType);

diff --git a/Box.V2.Test/Fixtures/BoxSignRequest/CancelSignRequest200.json b/Box.V2.Test/Fixtures/BoxSignRequest/CancelSignRequest200.json
@@ -70,7 +70,8 @@
       ],
       "embed_url": "https://example.com",
       "redirect_url": "https://box.com/redirect_url_signer_1",
-      "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1"
+      "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1",
+      "iframeable_embed_url": "https://app.box.com/embed/sign/document/bf7aaac6/"
     }
   ],
   "signing_log": {

diff --git a/Box.V2.Test/Fixtures/BoxSignRequest/CreateSignRequest200.json b/Box.V2.Test/Fixtures/BoxSignRequest/CreateSignRequest200.json
@@ -70,7 +70,8 @@
       ],
       "embed_url": "https://example.com",
       "redirect_url": "https://box.com/redirect_url_signer_1",
-      "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1"
+      "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1",
+      "iframeable_embed_url": "https://app.box.com/embed/sign/document/bf7aaac6/"
     }
   ],
   "signing_log": {

diff --git a/Box.V2.Test/Fixtures/BoxSignRequest/GetAllSignRequests200.json b/Box.V2.Test/Fixtures/BoxSignRequest/GetAllSignRequests200.json
@@ -36,7 +36,8 @@
           ],
           "embed_url": "https://example.com",
           "redirect_url": "https://box.com/redirect_url_signer_1",
-          "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1"
+          "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1",
+          "iframeable_embed_url": "https://app.box.com/embed/sign/document/bf7aaac6/"
         }
       ],
       "source_files": [

diff --git a/Box.V2.Test/Fixtures/BoxSignRequest/GetSignRequest200.json b/Box.V2.Test/Fixtures/BoxSignRequest/GetSignRequest200.json
@@ -70,7 +70,8 @@
       ],
       "embed_url": "https://example.com",
       "redirect_url": "https://box.com/redirect_url_signer_1",
-      "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1"
+      "declined_redirect_url": "https://box.com/declined_redirect_url_signer_1",
+      "iframeable_embed_url": "https://app.box.com/embed/sign/document/bf7aaac6/"
     }
   ],
   "signing_log": {

diff --git a/Box.V2/Models/BoxSignRequestSigner.cs b/Box.V2/Models/BoxSignRequestSigner.cs
@@ -21,6 +21,7 @@ public class BoxSignRequestSigner
         public const string FieldSignerDecision = "signer_decision";
         public const string FieldDeclinedRedirectUrl = "declined_redirect_url";
         public const string FieldRedirectUrl = "redirect_url";
+        public const string FieldIframeableEmbedUrl = "iframeable_embed_url";
 
         /// <summary>
         /// Email address of the signer.
@@ -90,6 +91,12 @@ public class BoxSignRequestSigner
         /// </summary>
         [JsonProperty(PropertyName = FieldRedirectUrl)]
         public virtual Uri RedirectUrl { get; private set; }
+
+        /// <summary>
+        /// This URL is specifically designed for signing documents within an HTML iframe tag.
+        /// </summary>
+        [JsonProperty(PropertyName = FieldIframeableEmbedUrl)]
+        public virtual string IframeableEmbedUrl { get; private set; }
     }
 
     /// <summary>