files.com 1.0.255 → 1.0.257

package/lib/models/FileUploadPart.js

@@ -65,6 +65,10 @@ var FileUploadPart = /*#__PURE__*/(0, _createClass2.default)(function FileUpload
   (0, _defineProperty2.default)(this, "getParallelParts", function () {
     return _this.attributes.parallel_parts;
   });
+  // boolean # If `true`, parts may be retried. If `false`, a part cannot be retried and the upload should be restarted.
+  (0, _defineProperty2.default)(this, "getRetryParts", function () {
+    return _this.attributes.retry_parts;
+  });
   // object # Additional HTTP parameters to send with the upload
   (0, _defineProperty2.default)(this, "getParameters", function () {
     return _this.attributes.parameters;

package/lib/models/InboxRecipient.js

@@ -66,13 +66,6 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
   (0, _defineProperty2.default)(this, "setSentAt", function (value) {
     _this.attributes.sent_at = value;
   });
-  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
-  (0, _defineProperty2.default)(this, "getUserId", function () {
-    return _this.attributes.user_id;
-  });
-  (0, _defineProperty2.default)(this, "setUserId", function (value) {
-    _this.attributes.user_id = value;
-  });
   // int64 # Inbox to share.
   (0, _defineProperty2.default)(this, "getInboxId", function () {
     return _this.attributes.inbox_id;
@@ -110,7 +103,6 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
   this.options = _objectSpread({}, options);
 });
 // Parameters:
-//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
@@ -133,38 +125,32 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
         }
         throw new errors.MissingParameterError('Parameter missing: inbox_id');
       case 4:
-        if (!(params['user_id'] && !(0, _utils.isInt)(params['user_id']))) {
-          _context.next = 6;
-          break;
-        }
-        throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params['user_id'])));
-      case 6:
         if (!(params['cursor'] && !(0, _utils.isString)(params['cursor']))) {
-          _context.next = 8;
+          _context.next = 6;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params['cursor'])));
-      case 8:
+      case 6:
         if (!(params['per_page'] && !(0, _utils.isInt)(params['per_page']))) {
-          _context.next = 10;
+          _context.next = 8;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params['per_page'])));
-      case 10:
+      case 8:
         if (!(params['inbox_id'] && !(0, _utils.isInt)(params['inbox_id']))) {
-          _context.next = 12;
+          _context.next = 10;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: inbox_id must be of type Int, received ".concat((0, _utils.getType)(params['inbox_id'])));
-      case 12:
-        _context.next = 14;
+      case 10:
+        _context.next = 12;
         return _Api.default.sendRequest("/inbox_recipients", 'GET', params, options);
-      case 14:
+      case 12:
         response = _context.sent;
         return _context.abrupt("return", (response === null || response === void 0 ? void 0 : (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
           return new InboxRecipient(obj, options);
         })) || []);
-      case 16:
+      case 14:
       case "end":
         return _context.stop();
     }
@@ -176,7 +162,6 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
   return InboxRecipient.list(params, options);
 });
 // Parameters:
-//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 //   inbox_id (required) - int64 - Inbox to share.
 //   recipient (required) - string - Email address to share this inbox with.
 //   name - string - Name of recipient.
@@ -205,48 +190,42 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
         }
         throw new errors.MissingParameterError('Parameter missing: recipient');
       case 6:
-        if (!(params['user_id'] && !(0, _utils.isInt)(params['user_id']))) {
-          _context2.next = 8;
-          break;
-        }
-        throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params['user_id'])));
-      case 8:
         if (!(params['inbox_id'] && !(0, _utils.isInt)(params['inbox_id']))) {
-          _context2.next = 10;
+          _context2.next = 8;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: inbox_id must be of type Int, received ".concat((0, _utils.getType)(params['inbox_id'])));
-      case 10:
+      case 8:
         if (!(params['recipient'] && !(0, _utils.isString)(params['recipient']))) {
-          _context2.next = 12;
+          _context2.next = 10;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: recipient must be of type String, received ".concat((0, _utils.getType)(params['recipient'])));
-      case 12:
+      case 10:
         if (!(params['name'] && !(0, _utils.isString)(params['name']))) {
-          _context2.next = 14;
+          _context2.next = 12;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0, _utils.getType)(params['name'])));
-      case 14:
+      case 12:
         if (!(params['company'] && !(0, _utils.isString)(params['company']))) {
-          _context2.next = 16;
+          _context2.next = 14;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: company must be of type String, received ".concat((0, _utils.getType)(params['company'])));
-      case 16:
+      case 14:
         if (!(params['note'] && !(0, _utils.isString)(params['note']))) {
-          _context2.next = 18;
+          _context2.next = 16;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: note must be of type String, received ".concat((0, _utils.getType)(params['note'])));
-      case 18:
-        _context2.next = 20;
+      case 16:
+        _context2.next = 18;
         return _Api.default.sendRequest("/inbox_recipients", 'POST', params, options);
-      case 20:
+      case 18:
         response = _context2.sent;
         return _context2.abrupt("return", new InboxRecipient(response === null || response === void 0 ? void 0 : response.data, options));
-      case 22:
+      case 20:
       case "end":
         return _context2.stop();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.0.255",
+  "version": "1.0.257",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/isomorphic/File.node.js

@@ -21,6 +21,19 @@ const saveUrlToStream = async (url, stream) => new Promise((resolve, reject) =>
   })
 })
 
+const saveUrlToString = async url => new Promise((resolve, reject) => {
+  const https = require('https')
+
+  https.get(url, response => {
+    const chunks = []
+    response.on('data', chunk => chunks.push(Buffer.from(chunk)))
+    response.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')))
+  })
+  .on('error', error => {
+    reject(error)
+  })
+})
+
 const saveUrlToFile = async (url, destinationPath) => {
   const stream = openDiskFileWriteStream(destinationPath)
   await saveUrlToStream(url, stream)
@@ -32,4 +45,5 @@ export {
   openDiskFileWriteStream,
   saveUrlToFile,
   saveUrlToStream,
+  saveUrlToString,
 }

package/src/models/File.js

@@ -199,6 +199,21 @@ class File {
     return saveUrlToStream(downloadUri, writableStream)
   }
 
+  downloadToString = async () => {
+    if (isBrowser()) {
+      throw new errors.NotImplementedError('String downloads are only available in a NodeJS environment')
+    }
+
+    const downloadUri = this.getDownloadUri()
+
+    if (!downloadUri) {
+      throw new errors.EmptyPropertyError('Current object has no download URI')
+    }
+
+    const { saveUrlToString } = require('../isomorphic/File.node.js')
+    return saveUrlToString(downloadUri)
+  }
+
   downloadToFile = async destinationPath => {
     if (isBrowser()) {
       throw new errors.NotImplementedError('Disk file downloads are only available in a NodeJS environment')

package/src/models/FileUploadPart.js

@@ -50,6 +50,9 @@ class FileUploadPart {
   // boolean # If `true`, multiple parts may be uploaded in parallel.  If `false`, be sure to only upload one part at a time, in order.
   getParallelParts = () => this.attributes.parallel_parts
 
+  // boolean # If `true`, parts may be retried. If `false`, a part cannot be retried and the upload should be restarted.
+  getRetryParts = () => this.attributes.retry_parts
+
   // object # Additional HTTP parameters to send with the upload
   getParameters = () => this.attributes.parameters
 

package/src/models/InboxRecipient.js

@@ -58,13 +58,6 @@ class InboxRecipient {
     this.attributes.sent_at = value
   }
 
-  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
-  getUserId = () => this.attributes.user_id
-
-  setUserId = value => {
-    this.attributes.user_id = value
-  }
-
   // int64 # Inbox to share.
   getInboxId = () => this.attributes.inbox_id
 
@@ -91,7 +84,6 @@ class InboxRecipient {
   }
 
   // Parameters:
-  //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
   //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
@@ -102,10 +94,6 @@ class InboxRecipient {
       throw new errors.MissingParameterError('Parameter missing: inbox_id')
     }
 
-    if (params['user_id'] && !isInt(params['user_id'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params['user_id'])}`)
-    }
-
     if (params['cursor'] && !isString(params['cursor'])) {
       throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
     }
@@ -127,7 +115,6 @@ class InboxRecipient {
     InboxRecipient.list(params, options)
 
   // Parameters:
-  //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
   //   inbox_id (required) - int64 - Inbox to share.
   //   recipient (required) - string - Email address to share this inbox with.
   //   name - string - Name of recipient.
@@ -143,10 +130,6 @@ class InboxRecipient {
       throw new errors.MissingParameterError('Parameter missing: recipient')
     }
 
-    if (params['user_id'] && !isInt(params['user_id'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params['user_id'])}`)
-    }
-
     if (params['inbox_id'] && !isInt(params['inbox_id'])) {
       throw new errors.InvalidParameterError(`Bad parameter: inbox_id must be of type Int, received ${getType(params['inbox_id'])}`)
     }

package/test/src/index.js

@@ -64,7 +64,7 @@ const testSuite = async () => {
     Logger.info('***** testFolderListAutoPagination() succeeded! *****')
   }
 
-  const testUploadAndDownload = async () => {
+  const testUploadAndDownloadToFile = async () => {
     const sourceFilePath = '../files.com-logo.png'
 
     const displayName = `files.com-logo__${nonce}.png`
@@ -99,7 +99,37 @@ const testSuite = async () => {
 
     await file.delete()
 
-    Logger.info('***** testUploadAndDownload() succeeded! *****')
+    Logger.info('***** testUploadAndDownloadToFile() succeeded! *****')
+  }
+
+  const testUploadAndDownloadToString = async () => {
+    const displayName = `test-text__${nonce}.txt`
+    const destinationPath = `${SDK_TEST_ROOT_FOLDER}/${displayName}`
+
+    const sourceFileContents = 'The quick brown fox jumped over the lazy dogs.'
+    const file = await File.uploadData(destinationPath, sourceFileContents)
+
+    assert(!!file.path)
+    assert(file.display_name === displayName)
+
+    const foundFile = await File.find(destinationPath)
+
+    assert(foundFile.path === destinationPath)
+    assert(foundFile.display_name === displayName)
+    assert(typeof foundFile.getDownloadUri() === 'undefined')
+
+    if (!isBrowser()) {
+      const downloadableFile = await foundFile.download()
+      assert(typeof downloadableFile.getDownloadUri() !== 'undefined')
+
+      const downloadedFileContents = await downloadableFile.downloadToString()
+
+      assert(sourceFileContents === downloadedFileContents)
+    }
+
+    await file.delete()
+
+    Logger.info('***** testUploadAndDownloadToString() succeeded! *****')
   }
 
   /* to run this test, put a file (or symlink) at huge-file.ext * /
@@ -200,7 +230,8 @@ const testSuite = async () => {
   //
 
   await testFolderListAutoPagination()
-  await testUploadAndDownload()
+  await testUploadAndDownloadToFile()
+  await testUploadAndDownloadToString()
   // await testUploadHugeFile() // to run this test, put a file (or symlink) at huge-file.ext
   await testSession()
   await testFailure()