Skip to content

Commit 1516dda

Browse files
authored
feat: add Box Sign shared requests (#504)
1 parent 557d7fd commit 1516dda

File tree

3 files changed

+93
-3
lines changed

3 files changed

+93
-3
lines changed

openapi.json

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"url": "http://www.apache.org/licenses/LICENSE-2.0"
1515
},
1616
"version": "2024.0",
17-
"x-box-commit-hash": "863c136f26"
17+
"x-box-commit-hash": "04cc4aa874"
1818
},
1919
"servers": [
2020
{
@@ -23349,6 +23349,33 @@
2334923349
"maximum": 1000
2335023350
},
2335123351
"example": 1000
23352+
},
23353+
{
23354+
"name": "senders",
23355+
"in": "query",
23356+
"description": "A list of sender emails to filter the signature requests by sender. \nIf provided, `shared_requests` must be set to `true`.",
23357+
"required": false,
23358+
"schema": {
23359+
"type": "array",
23360+
"items": {
23361+
"type": "string"
23362+
}
23363+
},
23364+
"example": [
23365+
23366+
23367+
]
23368+
},
23369+
{
23370+
"name": "shared_requests",
23371+
"in": "query",
23372+
"description": "If set to `true`, only includes requests that user is not an owner,\nbut user is a collaborator. Collaborator access is determined by the\nuser access level of the sign files of the request.\nDefault is `false`. Must be set to `true` if `senders` are provided.",
23373+
"required": false,
23374+
"schema": {
23375+
"type": "boolean",
23376+
"default": false
23377+
},
23378+
"example": true
2335223379
}
2335323380
],
2335423381
"responses": {
@@ -34126,6 +34153,24 @@
3412634153
}
3412734154
],
3412834155
"nullable": false
34156+
},
34157+
"collaborator_level": {
34158+
"description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\"",
34159+
"type": "string",
34160+
"example": "owner",
34161+
"nullable": true
34162+
},
34163+
"sender_email": {
34164+
"description": "The email address of the sender of the sign request.",
34165+
"type": "string",
34166+
"example": "[email protected]",
34167+
"nullable": true
34168+
},
34169+
"sender_id": {
34170+
"description": "The user ID of the sender of the sign request.",
34171+
"type": "integer",
34172+
"example": 12345,
34173+
"nullable": true
3412934174
}
3413034175
}
3413134176
}

openapi/openapi-v2025.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"url": "http://www.apache.org/licenses/LICENSE-2.0"
1515
},
1616
"version": "2025.0",
17-
"x-box-commit-hash": "863c136f26"
17+
"x-box-commit-hash": "04cc4aa874"
1818
},
1919
"servers": [
2020
{

openapi/openapi.json

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"url": "http://www.apache.org/licenses/LICENSE-2.0"
1515
},
1616
"version": "2024.0",
17-
"x-box-commit-hash": "863c136f26"
17+
"x-box-commit-hash": "04cc4aa874"
1818
},
1919
"servers": [
2020
{
@@ -23349,6 +23349,33 @@
2334923349
"maximum": 1000
2335023350
},
2335123351
"example": 1000
23352+
},
23353+
{
23354+
"name": "senders",
23355+
"in": "query",
23356+
"description": "A list of sender emails to filter the signature requests by sender. \nIf provided, `shared_requests` must be set to `true`.",
23357+
"required": false,
23358+
"schema": {
23359+
"type": "array",
23360+
"items": {
23361+
"type": "string"
23362+
}
23363+
},
23364+
"example": [
23365+
23366+
23367+
]
23368+
},
23369+
{
23370+
"name": "shared_requests",
23371+
"in": "query",
23372+
"description": "If set to `true`, only includes requests that user is not an owner,\nbut user is a collaborator. Collaborator access is determined by the\nuser access level of the sign files of the request.\nDefault is `false`. Must be set to `true` if `senders` are provided.",
23373+
"required": false,
23374+
"schema": {
23375+
"type": "boolean",
23376+
"default": false
23377+
},
23378+
"example": true
2335223379
}
2335323380
],
2335423381
"responses": {
@@ -34126,6 +34153,24 @@
3412634153
}
3412734154
],
3412834155
"nullable": false
34156+
},
34157+
"collaborator_level": {
34158+
"description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\"",
34159+
"type": "string",
34160+
"example": "owner",
34161+
"nullable": true
34162+
},
34163+
"sender_email": {
34164+
"description": "The email address of the sender of the sign request.",
34165+
"type": "string",
34166+
"example": "[email protected]",
34167+
"nullable": true
34168+
},
34169+
"sender_id": {
34170+
"description": "The user ID of the sender of the sign request.",
34171+
"type": "integer",
34172+
"example": 12345,
34173+
"nullable": true
3412934174
}
3413034175
}
3413134176
}

0 commit comments

Comments
 (0)