From 92f36fe2d15d4f82d7fb51dd4901d301fd6c5c70 Mon Sep 17 00:00:00 2001 From: box-apimgmt Date: Wed, 26 Nov 2025 08:24:38 -0800 Subject: [PATCH] feat: add new sign request metadata --- openapi.json | 49 +++++++++++++++++++++++++++++++++++- openapi/openapi-v2025.0.json | 2 +- openapi/openapi.json | 49 +++++++++++++++++++++++++++++++++++- 3 files changed, 97 insertions(+), 3 deletions(-) diff --git a/openapi.json b/openapi.json index 5735e84c..7dc1408d 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "ff61e4068c" + "x-box-commit-hash": "57f6be0109" }, "servers": [ { @@ -36040,6 +36040,26 @@ "example": "owner", "nullable": true }, + "short_id": { + "description": "Short identifier for the sign request.", + "type": "string", + "example": "SR-12345", + "nullable": false + }, + "created_at": { + "description": "Timestamp marking when the sign request was created.", + "type": "string", + "format": "date-time", + "example": "2025-02-01T12:00:00Z", + "nullable": false + }, + "finished_at": { + "description": "Timestamp indicating when all signing actions completed.", + "type": "string", + "format": "date-time", + "example": "2025-02-02T12:00:00Z", + "nullable": true + }, "sender_email": { "description": "The email address of the sender of the sign request.", "type": "string", @@ -36388,6 +36408,14 @@ "type": "string", "example": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4", "nullable": true + }, + "attachments": { + "description": "Attachments that the signer uploaded.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SignRequestSignerAttachment" + }, + "nullable": true } } } @@ -36397,6 +36425,25 @@ ], "title": "Signer fields for Box Sign request response" }, + "SignRequestSignerAttachment": { + "description": "Metadata describing a file uploaded by a signer as an attachment.", + "type": "object", + "properties": { + "id": { + "description": "Identifier of the attachment file.", + "type": "string", + "example": "12345", + "nullable": true + }, + "name": { + "description": "Display name of the attachment file.", + "type": "string", + "example": "proof_of_identity.pdf", + "nullable": true + } + }, + "title": "Signer Attachment" + }, "SignRequestSignerInput": { "description": "Input created by a Signer on a Sign Request.", "type": "object", diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 6f16ae74..b2a972ab 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "ff61e4068c" + "x-box-commit-hash": "57f6be0109" }, "servers": [ { diff --git a/openapi/openapi.json b/openapi/openapi.json index 5735e84c..7dc1408d 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "ff61e4068c" + "x-box-commit-hash": "57f6be0109" }, "servers": [ { @@ -36040,6 +36040,26 @@ "example": "owner", "nullable": true }, + "short_id": { + "description": "Short identifier for the sign request.", + "type": "string", + "example": "SR-12345", + "nullable": false + }, + "created_at": { + "description": "Timestamp marking when the sign request was created.", + "type": "string", + "format": "date-time", + "example": "2025-02-01T12:00:00Z", + "nullable": false + }, + "finished_at": { + "description": "Timestamp indicating when all signing actions completed.", + "type": "string", + "format": "date-time", + "example": "2025-02-02T12:00:00Z", + "nullable": true + }, "sender_email": { "description": "The email address of the sender of the sign request.", "type": "string", @@ -36388,6 +36408,14 @@ "type": "string", "example": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4", "nullable": true + }, + "attachments": { + "description": "Attachments that the signer uploaded.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SignRequestSignerAttachment" + }, + "nullable": true } } } @@ -36397,6 +36425,25 @@ ], "title": "Signer fields for Box Sign request response" }, + "SignRequestSignerAttachment": { + "description": "Metadata describing a file uploaded by a signer as an attachment.", + "type": "object", + "properties": { + "id": { + "description": "Identifier of the attachment file.", + "type": "string", + "example": "12345", + "nullable": true + }, + "name": { + "description": "Display name of the attachment file.", + "type": "string", + "example": "proof_of_identity.pdf", + "nullable": true + } + }, + "title": "Signer Attachment" + }, "SignRequestSignerInput": { "description": "Input created by a Signer on a Sign Request.", "type": "object",