From 1516dda73b04d1288efa1fd6504057207c8705d5 Mon Sep 17 00:00:00 2001 From: box-apimgmt <142984025+box-apimgmt@users.noreply.github.com> Date: Thu, 23 Jan 2025 12:28:06 +0100 Subject: [PATCH] feat: add Box Sign shared requests (#504) --- openapi.json | 47 +++++++++++++++++++++++++++++++++++- openapi/openapi-v2025.0.json | 2 +- openapi/openapi.json | 47 +++++++++++++++++++++++++++++++++++- 3 files changed, 93 insertions(+), 3 deletions(-) diff --git a/openapi.json b/openapi.json index 0b82dd06..85c61d9c 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": "863c136f26" + "x-box-commit-hash": "04cc4aa874" }, "servers": [ { @@ -23349,6 +23349,33 @@ "maximum": 1000 }, "example": 1000 + }, + { + "name": "senders", + "in": "query", + "description": "A list of sender emails to filter the signature requests by sender. \nIf provided, `shared_requests` must be set to `true`.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": [ + "sender1@boxdemo.com", + "sender2@boxdemo.com" + ] + }, + { + "name": "shared_requests", + "in": "query", + "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.", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "example": true } ], "responses": { @@ -34126,6 +34153,24 @@ } ], "nullable": false + }, + "collaborator_level": { + "description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\"", + "type": "string", + "example": "owner", + "nullable": true + }, + "sender_email": { + "description": "The email address of the sender of the sign request.", + "type": "string", + "example": "sender@box.com", + "nullable": true + }, + "sender_id": { + "description": "The user ID of the sender of the sign request.", + "type": "integer", + "example": 12345, + "nullable": true } } } diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 706de656..01f2bfee 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": "863c136f26" + "x-box-commit-hash": "04cc4aa874" }, "servers": [ { diff --git a/openapi/openapi.json b/openapi/openapi.json index 0b82dd06..85c61d9c 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": "863c136f26" + "x-box-commit-hash": "04cc4aa874" }, "servers": [ { @@ -23349,6 +23349,33 @@ "maximum": 1000 }, "example": 1000 + }, + { + "name": "senders", + "in": "query", + "description": "A list of sender emails to filter the signature requests by sender. \nIf provided, `shared_requests` must be set to `true`.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": [ + "sender1@boxdemo.com", + "sender2@boxdemo.com" + ] + }, + { + "name": "shared_requests", + "in": "query", + "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.", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "example": true } ], "responses": { @@ -34126,6 +34153,24 @@ } ], "nullable": false + }, + "collaborator_level": { + "description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\"", + "type": "string", + "example": "owner", + "nullable": true + }, + "sender_email": { + "description": "The email address of the sender of the sign request.", + "type": "string", + "example": "sender@box.com", + "nullable": true + }, + "sender_id": { + "description": "The user ID of the sender of the sign request.", + "type": "integer", + "example": 12345, + "nullable": true } } }