-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add Box Sign shared requests (#504)
- Loading branch information
1 parent
557d7fd
commit 1516dda
Showing
3 changed files
with
93 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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": [ | ||
| "[email protected]", | ||
| "[email protected]" | ||
| ] | ||
| }, | ||
| { | ||
| "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": "[email protected]", | ||
| "nullable": true | ||
| }, | ||
| "sender_id": { | ||
| "description": "The user ID of the sender of the sign request.", | ||
| "type": "integer", | ||
| "example": 12345, | ||
| "nullable": true | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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": [ | ||
| "[email protected]", | ||
| "[email protected]" | ||
| ] | ||
| }, | ||
| { | ||
| "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": "[email protected]", | ||
| "nullable": true | ||
| }, | ||
| "sender_id": { | ||
| "description": "The user ID of the sender of the sign request.", | ||
| "type": "integer", | ||
| "example": 12345, | ||
| "nullable": true | ||
| } | ||
| } | ||
| } | ||
|
|
||