UNPKG

box-node-sdk

Version:

Official SDK for Box Plaform APIs

github.com/box/box-node-sdk

box/box-node-sdk

57 lines (56 loc) • 3.5 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
import BoxClient from '../box-client'; import { FileRequest, FileRequestCopyBody, FileRequestUpdateBody } from '../schemas'; declare class FileRequestsManager { client: BoxClient; constructor(client: BoxClient); /** * Gets File Request by ID. * @param {string} fileRequestId File Request ID * @param {Function} [callback] passed the user info if it was acquired successfully * @returns {Promise<FileRequest>} a promise with FileRequest details */ getById(fileRequestId: string, callback?: Function): Promise<FileRequest>; /** * Delete File Request. * @param {string} fileRequestId File Request ID * @param {Function} [callback] passed the user info if it was acquired successfully * @returns {Promise<void>} Returns a promise resolving to nothing */ delete(fileRequestId: string, callback?: Function): Promise<FileRequest>; /** * Copies existing FileRequest to new folder * @param {string} fileRequestIdToCopy ID of file request to copy * @param copyRequest copy request details * @param {string} copyRequest.folder.id ID of folder to which file request will be copied * @param {string} copyRequest.folder.type type of folder. Value is always 'folder' * @param {string} [copyRequest.title] new title of file request * @param {string} [copyRequest.description] new description of file request * @param {string} [copyRequest.expires_at] new date when file request expires * @param {boolean} [copyRequest.is_description_required] is file request submitter required to provide a description * of the files they are submitting * @param {boolean} [copyRequest.is_email_required] is file request submitter required to provide their email address * @param {string} [copyRequest.status] new status of file request * @param {Function} [callback] passed the user info if it was acquired successfully * @returns {Promise<FileRequest>} Returns a promise with FileRequest details */ copy(fileRequestIdToCopy: string, copyRequest: FileRequestCopyBody, callback?: Function): Promise<FileRequest>; /** * Update existing file request * @param {string} fileRequestId ID of file request * @param {string} fileRequestChange change of file request * @param {string} [fileRequestChange.description] new description of file request * @param {string} [fileRequestChange.expires_at] new date when file request expires * @param {boolean} [fileRequestChange.is_description_required] is file request submitter required to provide a * description of the files they are submitting * @param {boolean} [fileRequestChange.is_email_required] is file request submitter required to provide their * email address * @param {string} [fileRequestChange.status] new status of file request * @param {string} [fileRequestChange.title] new title of file request * @param {string} [originalRequestEtag] pass in the item's last observed etag value into this header and * the endpoint will fail with a 412 Precondition Failed if it has changed since. * @param {Function} callback passed the user info if it was acquired successfully * @returns {Promise<FileRequest>} Returns a promise with FileRequest details */ update(fileRequestId: string, fileRequestChange: FileRequestUpdateBody, originalRequestEtag?: string, callback?: Function): Promise<FileRequest>; } export = FileRequestsManager;