Skip to content

feat: add new sign request metadata #565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wsocha merged 1 commit into from
Nov 26, 2025
Merged

feat: add new sign request metadata #565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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
}
}
}
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2025.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down
49 changes: 48 additions & 1 deletion openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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
}
}
}
Expand All @@ -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",
Expand Down