Skip to content

feat: add signer language, cancel sign request reason #584

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
Feb 11, 2026
+67 −11
Merged

feat: add signer language, cancel sign request reason #584

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
38 changes: 33 additions & 5 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "c8490cfcb1"
"x-box-commit-hash": "dfe9629b78"
},
"servers": [
{
Expand Down Expand Up @@ -3708,7 +3708,7 @@
}
}
},
"403": {
"400": {
"description": "Returned when the request parameters are not valid.",
"content": {
"application/json": {
Expand Down Expand Up @@ -5004,7 +5004,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, reduce the number of items in the folder (for example, by\nrestructuring the folder into smaller subfolders) before retrying the\nrequest.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -5790,7 +5790,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, use marker-based pagination by setting `usemarker` to `true`.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -23256,6 +23256,16 @@
"example": "33243242"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignRequestCancelRequest"
}
}
}
},
"responses": {
"200": {
"description": "Returns a Sign Request object.",
Expand Down Expand Up @@ -27509,7 +27519,7 @@
"example": "done"
},
"confidence_score": {
"description": "The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"description": "The confidence score levels and numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"type": "object",
"additionalProperties": {}
},
Expand Down Expand Up @@ -38049,6 +38059,18 @@
"title": "Box Sign request (Base)",
"x-box-tag": "sign_requests"
},
"SignRequestCancelRequest": {
"description": "Request body for cancelling a sign request.",
"type": "object",
"properties": {
"reason": {
"description": "An optional reason for cancelling the sign request.",
"type": "string",
"example": "Project cancelled"
}
},
"title": "Sign request cancel request"
},
"SignRequestCreateRequest": {
"description": "Creates a Box Sign request object.",
"type": "object",
Expand Down Expand Up @@ -38184,6 +38206,12 @@
"type": "boolean",
"example": false,
"nullable": true
},
"language": {
"description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.",
"type": "string",
"example": "en",
"nullable": true
}
},
"title": "Signer fields used to create a Box Sign request 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": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "c8490cfcb1"
"x-box-commit-hash": "dfe9629b78"
},
"servers": [
{
Expand Down
38 changes: 33 additions & 5 deletions 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": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "c8490cfcb1"
"x-box-commit-hash": "dfe9629b78"
},
"servers": [
{
Expand Down Expand Up @@ -3708,7 +3708,7 @@
}
}
},
"403": {
"400": {
"description": "Returned when the request parameters are not valid.",
"content": {
"application/json": {
Expand Down Expand Up @@ -5004,7 +5004,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, reduce the number of items in the folder (for example, by\nrestructuring the folder into smaller subfolders) before retrying the\nrequest.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -5790,7 +5790,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, use marker-based pagination by setting `usemarker` to `true`.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -23256,6 +23256,16 @@
"example": "33243242"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignRequestCancelRequest"
}
}
}
},
"responses": {
"200": {
"description": "Returns a Sign Request object.",
Expand Down Expand Up @@ -27509,7 +27519,7 @@
"example": "done"
},
"confidence_score": {
"description": "The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"description": "The confidence score levels and numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"type": "object",
"additionalProperties": {}
},
Expand Down Expand Up @@ -38049,6 +38059,18 @@
"title": "Box Sign request (Base)",
"x-box-tag": "sign_requests"
},
"SignRequestCancelRequest": {
"description": "Request body for cancelling a sign request.",
"type": "object",
"properties": {
"reason": {
"description": "An optional reason for cancelling the sign request.",
"type": "string",
"example": "Project cancelled"
}
},
"title": "Sign request cancel request"
},
"SignRequestCreateRequest": {
"description": "Creates a Box Sign request object.",
"type": "object",
Expand Down Expand Up @@ -38184,6 +38206,12 @@
"type": "boolean",
"example": false,
"nullable": true
},
"language": {
"description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.",
"type": "string",
"example": "en",
"nullable": true
}
},
"title": "Signer fields used to create a Box Sign request object."
Expand Down