box-node-sdk 3.8.0 → 3.8.2

package/lib-esm/managers/file-requests-manager.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+class FileRequestsManager {
+    constructor(client) {
+        // Attach the client, for making API calls
+        this.client = client;
+    }
+    /**
+     * 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, callback) {
+        const apiPath = (0, url_path_1.default)('file_requests', fileRequestId);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, callback);
+    }
+    /**
+     * 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, callback) {
+        const apiPath = (0, url_path_1.default)('file_requests', fileRequestId);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, callback);
+    }
+    /**
+     * 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, copyRequest, callback) {
+        const apiPath = (0, url_path_1.default)('file_requests', fileRequestIdToCopy, 'copy');
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, { body: copyRequest }, callback);
+    }
+    /**
+     * 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, fileRequestChange, originalRequestEtag, callback) {
+        const apiPath = (0, url_path_1.default)('file_requests', fileRequestId);
+        let params = { body: fileRequestChange };
+        if (originalRequestEtag) {
+            params = {
+                ...params,
+                headers: { 'if-match': originalRequestEtag },
+            };
+        }
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+}
+module.exports = FileRequestsManager;
+//# sourceMappingURL=file-requests-manager.js.map

package/lib-esm/managers/file-requests-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-requests-manager.js","sourceRoot":"","sources":["../../src/managers/file-requests-manager.ts"],"names":[],"mappings":";;;;AAMA,gEAAuC;AAEvC,MAAM,mBAAmB;IAGvB,YAAY,MAAiB;QAC3B,0CAA0C;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,aAAqB,EAAE,QAAmB;QAChD,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,aAAqB,EAAE,QAAmB;QAC/C,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,mBAA2B,EAC3B,WAAgC,EAChC,QAAmB;QAEnB,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,EAAE,IAAI,EAAE,WAAW,EAAE,EACrB,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,aAAqB,EACrB,iBAAwC,EACxC,mBAA4B,EAC5B,QAAmB;QAEnB,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACxD,IAAI,MAAM,GAAQ,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;QAC9C,IAAI,mBAAmB,EAAE,CAAC;YACxB,MAAM,GAAG;gBACP,GAAG,MAAM;gBACT,OAAO,EAAE,EAAE,UAAU,EAAE,mBAAmB,EAAE;aAC7C,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED,iBAAS,mBAAmB,CAAC"}