feat: DDOC-855 add iframeable_embed_url param to box sign request (#340)

* feat: DDOC-855 add iframeable_embed param * fix lint issues * Update signer mock id * review updates for parameters
box · Aug 17, 2023 · 739416b · 739416b
1 parent 2eb4b35
commit 739416b
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/content/paths/memberships__post_group_memberships.yml b/content/paths/memberships__post_group_memberships.yml
@@ -70,7 +70,7 @@ requestBody:
               Setting these permissions overwrites the default
               access levels of an admin.
 
-              Specifying a value of "null" for this object will disable
+              Specifying a value of "null" for this object will deactivate
               all configurable permissions. Specifying permissions will set
               them accordingly, omitted permissions will be enabled by default.
             additionalProperties:

diff --git a/content/paths/memberships__put_group_memberships_id.yml b/content/paths/memberships__put_group_memberships_id.yml
@@ -43,7 +43,7 @@ requestBody:
               Setting these permissions overwrites the default
               access levels of an admin.
 
-              Specifying a value of "null" for this object will disable
+              Specifying a value of "null" for this object will deactivate
               all configurable permissions. Specifying permissions will set
               them accordingly, omitted permissions will be enabled by default.
             additionalProperties:

diff --git a/content/schemas/sign_request_signer.yml b/content/schemas/sign_request_signer.yml
@@ -44,3 +44,19 @@ allOf:
         readOnly: true
         example: https://example.com
         description: URL to direct a signer to for signing
+
+      # yamllint disable rule:line-length
+
+      iframeable_embed_url:
+        type: string
+        nullable: true
+        example: https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4
+        description: |-
+          This URL is specifically designed for
+          signing documents within an HTML `iframe` tag.
+          It will be returned in the response
+          only if the `embed_url_external_user_id`
+          parameter was passed in the
+          `create sign request` call.
+
+      # yamllint enable rule:line-length