files.com 1.0.166 → 1.0.167

package/README.md

@@ -133,21 +133,25 @@ You can set the following global properties using static methods on the `Files`
       await File.uploadFile(destinationFileName, sourceFilePath)
     }
 
-#### Getting a file record by path
+#### Downloading a file
+
+##### Get a downloadable file object by path
 
     import File from 'files.com/lib/models/File'
-    const foundFile = await File.findDownload(remoteFilePath)
 
-#### Download a file (not available in browser)
+    const foundFile = await File.find(remoteFilePath)
+    const downloadableFile = await foundFile.download()
+
+##### Download a file (not available in browser)
 
     import { isBrowser } from 'files.com/lib/utils'
 
     if (!isBrowser()) {
       // download to a file on disk
-      await foundFile.downloadToFile(localFilePath)
+      await downloadableFile.downloadToFile(localFilePath)
 
       // download to a writable stream
-      await foundFile.downloadToStream(stream)
+      await downloadableFile.downloadToStream(stream)
     }
 
 ### Additional Object Documentation

package/_VERSION

@@ -1 +1 @@
-1.0.166
+1.0.167

package/lib/models/ActionWebhookFailure.js

@@ -43,6 +43,7 @@ var ActionWebhookFailure = /*#__PURE__*/(0, _createClass2.default)(function Acti
   });
   (0, _defineProperty2.default)(this, "retry", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -94,9 +95,14 @@ var ActionWebhookFailure = /*#__PURE__*/(0, _createClass2.default)(function Acti
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context.abrupt("return", _Api.default.sendRequest("/action_webhook_failures/".concat(params['id'], "/retry"), 'POST', params, _this.options));
+            _context.next = 16;
+            return _Api.default.sendRequest("/action_webhook_failures/".concat(params['id'], "/retry"), 'POST', params, _this.options);
 
-          case 15:
+          case 16:
+            response = _context.sent;
+            return _context.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+
+          case 18:
           case "end":
             return _context.stop();
         }

package/lib/models/ApiKey.js

@@ -106,6 +106,7 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
   });
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -181,9 +182,14 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
             throw new Error('Parameter missing: id');
 
           case 20:
-            return _context.abrupt("return", _Api.default.sendRequest("/api_keys/".concat(params['id']), 'PATCH', params, _this.options));
+            _context.next = 22;
+            return _Api.default.sendRequest("/api_keys/".concat(params['id']), 'PATCH', params, _this.options);
+
+          case 22:
+            response = _context.sent;
+            return _context.abrupt("return", new ApiKey(response === null || response === void 0 ? void 0 : response.data, _this.options));
 
-          case 21:
+          case 24:
           case "end":
             return _context.stop();
         }
@@ -192,6 +198,7 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
   })));
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
+        response,
         _args2 = arguments;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -243,9 +250,14 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context2.abrupt("return", _Api.default.sendRequest("/api_keys/".concat(params['id']), 'DELETE', params, _this.options));
+            _context2.next = 16;
+            return _Api.default.sendRequest("/api_keys/".concat(params['id']), 'DELETE', params, _this.options);
+
+          case 16:
+            response = _context2.sent;
+            return _context2.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
 
-          case 15:
+          case 18:
           case "end":
             return _context2.stop();
         }

package/lib/models/As2Partner.js

@@ -109,6 +109,7 @@ var As2Partner = /*#__PURE__*/(0, _createClass2.default)(function As2Partner() {
   });
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -184,9 +185,14 @@ var As2Partner = /*#__PURE__*/(0, _createClass2.default)(function As2Partner() {
             throw new Error('Parameter missing: id');
 
           case 20:
-            return _context.abrupt("return", _Api.default.sendRequest("/as2_partners/".concat(params['id']), 'PATCH', params, _this.options));
+            _context.next = 22;
+            return _Api.default.sendRequest("/as2_partners/".concat(params['id']), 'PATCH', params, _this.options);
+
+          case 22:
+            response = _context.sent;
+            return _context.abrupt("return", new As2Partner(response === null || response === void 0 ? void 0 : response.data, _this.options));
 
-          case 21:
+          case 24:
           case "end":
             return _context.stop();
         }
@@ -195,6 +201,7 @@ var As2Partner = /*#__PURE__*/(0, _createClass2.default)(function As2Partner() {
   })));
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
+        response,
         _args2 = arguments;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -246,9 +253,14 @@ var As2Partner = /*#__PURE__*/(0, _createClass2.default)(function As2Partner() {
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context2.abrupt("return", _Api.default.sendRequest("/as2_partners/".concat(params['id']), 'DELETE', params, _this.options));
+            _context2.next = 16;
+            return _Api.default.sendRequest("/as2_partners/".concat(params['id']), 'DELETE', params, _this.options);
+
+          case 16:
+            response = _context2.sent;
+            return _context2.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
 
-          case 15:
+          case 18:
           case "end":
             return _context2.stop();
         }

package/lib/models/As2Station.js

@@ -121,6 +121,7 @@ var As2Station = /*#__PURE__*/(0, _createClass2.default)(function As2Station() {
   });
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -196,9 +197,14 @@ var As2Station = /*#__PURE__*/(0, _createClass2.default)(function As2Station() {
             throw new Error('Parameter missing: id');
 
           case 20:
-            return _context.abrupt("return", _Api.default.sendRequest("/as2_stations/".concat(params['id']), 'PATCH', params, _this.options));
+            _context.next = 22;
+            return _Api.default.sendRequest("/as2_stations/".concat(params['id']), 'PATCH', params, _this.options);
+
+          case 22:
+            response = _context.sent;
+            return _context.abrupt("return", new As2Station(response === null || response === void 0 ? void 0 : response.data, _this.options));
 
-          case 21:
+          case 24:
           case "end":
             return _context.stop();
         }
@@ -207,6 +213,7 @@ var As2Station = /*#__PURE__*/(0, _createClass2.default)(function As2Station() {
   })));
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
+        response,
         _args2 = arguments;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -258,9 +265,14 @@ var As2Station = /*#__PURE__*/(0, _createClass2.default)(function As2Station() {
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context2.abrupt("return", _Api.default.sendRequest("/as2_stations/".concat(params['id']), 'DELETE', params, _this.options));
+            _context2.next = 16;
+            return _Api.default.sendRequest("/as2_stations/".concat(params['id']), 'DELETE', params, _this.options);
+
+          case 16:
+            response = _context2.sent;
+            return _context2.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
 
-          case 15:
+          case 18:
           case "end":
             return _context2.stop();
         }

package/lib/models/Automation.js

@@ -157,6 +157,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   });
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -338,9 +339,14 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
             throw new Error('Parameter missing: automation');
 
           case 48:
-            return _context.abrupt("return", _Api.default.sendRequest("/automations/".concat(params['id']), 'PATCH', params, _this.options));
+            _context.next = 50;
+            return _Api.default.sendRequest("/automations/".concat(params['id']), 'PATCH', params, _this.options);
+
+          case 50:
+            response = _context.sent;
+            return _context.abrupt("return", new Automation(response === null || response === void 0 ? void 0 : response.data, _this.options));
 
-          case 49:
+          case 52:
           case "end":
             return _context.stop();
         }
@@ -349,6 +355,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   })));
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
+        response,
         _args2 = arguments;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -400,9 +407,14 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context2.abrupt("return", _Api.default.sendRequest("/automations/".concat(params['id']), 'DELETE', params, _this.options));
+            _context2.next = 16;
+            return _Api.default.sendRequest("/automations/".concat(params['id']), 'DELETE', params, _this.options);
 
-          case 15:
+          case 16:
+            response = _context2.sent;
+            return _context2.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+
+          case 18:
           case "end":
             return _context2.stop();
         }

package/lib/models/Behavior.js

@@ -97,6 +97,7 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
   });
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -188,9 +189,14 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
             throw new Error('Parameter missing: id');
 
           case 24:
-            return _context.abrupt("return", _Api.default.sendRequest("/behaviors/".concat(params['id']), 'PATCH', params, _this.options));
+            _context.next = 26;
+            return _Api.default.sendRequest("/behaviors/".concat(params['id']), 'PATCH', params, _this.options);
+
+          case 26:
+            response = _context.sent;
+            return _context.abrupt("return", new Behavior(response === null || response === void 0 ? void 0 : response.data, _this.options));
 
-          case 25:
+          case 28:
           case "end":
             return _context.stop();
         }
@@ -199,6 +205,7 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
   })));
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
+        response,
         _args2 = arguments;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -250,9 +257,14 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context2.abrupt("return", _Api.default.sendRequest("/behaviors/".concat(params['id']), 'DELETE', params, _this.options));
+            _context2.next = 16;
+            return _Api.default.sendRequest("/behaviors/".concat(params['id']), 'DELETE', params, _this.options);
 
-          case 15:
+          case 16:
+            response = _context2.sent;
+            return _context2.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+
+          case 18:
           case "end":
             return _context2.stop();
         }

package/lib/models/Bundle.js

@@ -196,6 +196,7 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   });
   (0, _defineProperty2.default)(this, "share", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -271,9 +272,14 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
             throw new Error('Parameter missing: id');
 
           case 20:
-            return _context.abrupt("return", _Api.default.sendRequest("/bundles/".concat(params['id'], "/share"), 'POST', params, _this.options));
+            _context.next = 22;
+            return _Api.default.sendRequest("/bundles/".concat(params['id'], "/share"), 'POST', params, _this.options);
+
+          case 22:
+            response = _context.sent;
+            return _context.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
 
-          case 21:
+          case 24:
           case "end":
             return _context.stop();
         }
@@ -282,6 +288,7 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   })));
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
+        response,
         _args2 = arguments;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -413,9 +420,14 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
             throw new Error('Parameter missing: id');
 
           case 34:
-            return _context2.abrupt("return", _Api.default.sendRequest("/bundles/".concat(params['id']), 'PATCH', params, _this.options));
+            _context2.next = 36;
+            return _Api.default.sendRequest("/bundles/".concat(params['id']), 'PATCH', params, _this.options);
 
-          case 35:
+          case 36:
+            response = _context2.sent;
+            return _context2.abrupt("return", new Bundle(response === null || response === void 0 ? void 0 : response.data, _this.options));
+
+          case 38:
           case "end":
             return _context2.stop();
         }
@@ -424,6 +436,7 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   })));
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
     var params,
+        response,
         _args3 = arguments;
     return _regenerator.default.wrap(function _callee3$(_context3) {
       while (1) {
@@ -475,9 +488,14 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context3.abrupt("return", _Api.default.sendRequest("/bundles/".concat(params['id']), 'DELETE', params, _this.options));
+            _context3.next = 16;
+            return _Api.default.sendRequest("/bundles/".concat(params['id']), 'DELETE', params, _this.options);
 
-          case 15:
+          case 16:
+            response = _context3.sent;
+            return _context3.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+
+          case 18:
           case "end":
             return _context3.stop();
         }

package/lib/models/Clickwrap.js

@@ -79,6 +79,7 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
   });
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+        response,
         _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
@@ -170,9 +171,14 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
             throw new Error('Parameter missing: id');
 
           case 24:
-            return _context.abrupt("return", _Api.default.sendRequest("/clickwraps/".concat(params['id']), 'PATCH', params, _this.options));
+            _context.next = 26;
+            return _Api.default.sendRequest("/clickwraps/".concat(params['id']), 'PATCH', params, _this.options);
+
+          case 26:
+            response = _context.sent;
+            return _context.abrupt("return", new Clickwrap(response === null || response === void 0 ? void 0 : response.data, _this.options));
 
-          case 25:
+          case 28:
           case "end":
             return _context.stop();
         }
@@ -181,6 +187,7 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
   })));
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
+        response,
         _args2 = arguments;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
@@ -232,9 +239,14 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
             throw new Error('Parameter missing: id');
 
           case 14:
-            return _context2.abrupt("return", _Api.default.sendRequest("/clickwraps/".concat(params['id']), 'DELETE', params, _this.options));
+            _context2.next = 16;
+            return _Api.default.sendRequest("/clickwraps/".concat(params['id']), 'DELETE', params, _this.options);
 
-          case 15:
+          case 16:
+            response = _context2.sent;
+            return _context2.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+
+          case 18:
           case "end":
             return _context2.stop();
         }