files.com 1.2.42 → 1.2.43

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.42';
+var version = '1.2.43';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/Snapshot.js

@@ -82,13 +82,9 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
   (0, _defineProperty2.default)(this, "setPaths", function (value) {
     _this.attributes.paths = value;
   });
-  // Parameters:
-  //   expires_at - string - When the snapshot expires.
-  //   name - string - A name for the snapshot.
-  //   paths - array(string) - An array of paths to add to the snapshot.
-  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+  // Finalize Snapshot
+  (0, _defineProperty2.default)(this, "finalize", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
-      response,
       _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
@@ -112,134 +108,187 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
+        case 8:
+          if (params.id) {
+            _context.next = 14;
+            break;
+          }
+          if (!_this.attributes.id) {
+            _context.next = 13;
+            break;
+          }
+          params.id = _this.id;
+          _context.next = 14;
+          break;
+        case 13:
+          throw new errors.MissingParameterError('Parameter missing: id');
+        case 14:
+          _context.next = 16;
+          return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params.id), "/finalize"), 'POST', params, _this.options);
+        case 16:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  // Parameters:
+  //   expires_at - string - When the snapshot expires.
+  //   name - string - A name for the snapshot.
+  //   paths - array(string) - An array of paths to add to the snapshot.
+  (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) switch (_context2.prev = _context2.next) {
+        case 0:
+          params = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
+          if (_this.attributes.id) {
+            _context2.next = 3;
+            break;
+          }
+          throw new errors.EmptyPropertyError('Current object has no id');
+        case 3:
+          if ((0, _utils.isObject)(params)) {
+            _context2.next = 5;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
+        case 5:
+          params.id = _this.attributes.id;
+          if (!(params.id && !(0, _utils.isInt)(params.id))) {
+            _context2.next = 8;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
         case 8:
           if (!(params.expires_at && !(0, _utils.isString)(params.expires_at))) {
-            _context.next = 10;
+            _context2.next = 10;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: expires_at must be of type String, received ".concat((0, _utils.getType)(params.expires_at)));
         case 10:
           if (!(params.name && !(0, _utils.isString)(params.name))) {
-            _context.next = 12;
+            _context2.next = 12;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0, _utils.getType)(params.name)));
         case 12:
           if (!(params.paths && !(0, _utils.isArray)(params.paths))) {
-            _context.next = 14;
+            _context2.next = 14;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: paths must be of type Array, received ".concat((0, _utils.getType)(params.paths)));
         case 14:
           if (params.id) {
-            _context.next = 20;
+            _context2.next = 20;
             break;
           }
           if (!_this.attributes.id) {
-            _context.next = 19;
+            _context2.next = 19;
             break;
           }
           params.id = _this.id;
-          _context.next = 20;
+          _context2.next = 20;
           break;
         case 19:
           throw new errors.MissingParameterError('Parameter missing: id');
         case 20:
-          _context.next = 22;
+          _context2.next = 22;
           return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params.id)), 'PATCH', params, _this.options);
         case 22:
-          response = _context.sent;
-          return _context.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, _this.options));
+          response = _context2.sent;
+          return _context2.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, _this.options));
         case 24:
         case "end":
-          return _context.stop();
+          return _context2.stop();
       }
-    }, _callee);
+    }, _callee2);
   })));
-  (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
+  (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
     var params,
-      _args2 = arguments;
-    return _regenerator.default.wrap(function _callee2$(_context2) {
-      while (1) switch (_context2.prev = _context2.next) {
+      _args3 = arguments;
+    return _regenerator.default.wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
         case 0:
-          params = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
+          params = _args3.length > 0 && _args3[0] !== undefined ? _args3[0] : {};
           if (_this.attributes.id) {
-            _context2.next = 3;
+            _context3.next = 3;
             break;
           }
           throw new errors.EmptyPropertyError('Current object has no id');
         case 3:
           if ((0, _utils.isObject)(params)) {
-            _context2.next = 5;
+            _context3.next = 5;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
         case 5:
           params.id = _this.attributes.id;
           if (!(params.id && !(0, _utils.isInt)(params.id))) {
-            _context2.next = 8;
+            _context3.next = 8;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
         case 8:
           if (params.id) {
-            _context2.next = 14;
+            _context3.next = 14;
             break;
           }
           if (!_this.attributes.id) {
-            _context2.next = 13;
+            _context3.next = 13;
             break;
           }
           params.id = _this.id;
-          _context2.next = 14;
+          _context3.next = 14;
           break;
         case 13:
           throw new errors.MissingParameterError('Parameter missing: id');
         case 14:
-          _context2.next = 16;
+          _context3.next = 16;
           return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params.id)), 'DELETE', params, _this.options);
         case 16:
         case "end":
-          return _context2.stop();
+          return _context3.stop();
       }
-    }, _callee2);
+    }, _callee3);
   })));
   (0, _defineProperty2.default)(this, "destroy", function () {
     var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     return _this.delete(params);
   });
-  (0, _defineProperty2.default)(this, "save", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
+  (0, _defineProperty2.default)(this, "save", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
     var _newObject, newObject;
-    return _regenerator.default.wrap(function _callee3$(_context3) {
-      while (1) switch (_context3.prev = _context3.next) {
+    return _regenerator.default.wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
         case 0:
           if (!_this.attributes.id) {
-            _context3.next = 6;
+            _context4.next = 6;
             break;
           }
-          _context3.next = 3;
+          _context4.next = 3;
           return _this.update(_this.attributes);
         case 3:
-          _newObject = _context3.sent;
+          _newObject = _context4.sent;
           _this.attributes = _objectSpread({}, _newObject.attributes);
-          return _context3.abrupt("return", true);
+          return _context4.abrupt("return", true);
         case 6:
-          _context3.next = 8;
+          _context4.next = 8;
           return Snapshot.create(_this.attributes, _this.options);
         case 8:
-          newObject = _context3.sent;
+          newObject = _context4.sent;
           _this.attributes = _objectSpread({}, newObject.attributes);
-          return _context3.abrupt("return", true);
+          return _context4.abrupt("return", true);
         case 11:
         case "end":
-          return _context3.stop();
+          return _context4.stop();
       }
-    }, _callee3);
+    }, _callee4);
   })));
-  Object.entries(attributes).forEach(function (_ref4) {
-    var _ref5 = (0, _slicedToArray2.default)(_ref4, 2),
-      key = _ref5[0],
-      value = _ref5[1];
+  Object.entries(attributes).forEach(function (_ref5) {
+    var _ref6 = (0, _slicedToArray2.default)(_ref5, 2),
+      key = _ref6[0],
+      value = _ref6[1];
     var normalizedKey = key.replace('?', '');
     _this.attributes[normalizedKey] = value;
     Object.defineProperty(_this, normalizedKey, {
@@ -253,41 +302,41 @@ _Snapshot = Snapshot;
 // Parameters:
 //   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).
-(0, _defineProperty2.default)(Snapshot, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+(0, _defineProperty2.default)(Snapshot, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
   var _response$data;
   var params,
     options,
     response,
-    _args4 = arguments;
-  return _regenerator.default.wrap(function _callee4$(_context4) {
-    while (1) switch (_context4.prev = _context4.next) {
+    _args5 = arguments;
+  return _regenerator.default.wrap(function _callee5$(_context5) {
+    while (1) switch (_context5.prev = _context5.next) {
       case 0:
-        params = _args4.length > 0 && _args4[0] !== undefined ? _args4[0] : {};
-        options = _args4.length > 1 && _args4[1] !== undefined ? _args4[1] : {};
+        params = _args5.length > 0 && _args5[0] !== undefined ? _args5[0] : {};
+        options = _args5.length > 1 && _args5[1] !== undefined ? _args5[1] : {};
         if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
-          _context4.next = 4;
+          _context5.next = 4;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params.cursor)));
       case 4:
         if (!(params.per_page && !(0, _utils.isInt)(params.per_page))) {
-          _context4.next = 6;
+          _context5.next = 6;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params.per_page)));
       case 6:
-        _context4.next = 8;
+        _context5.next = 8;
         return _Api.default.sendRequest('/snapshots', 'GET', params, options);
       case 8:
-        response = _context4.sent;
-        return _context4.abrupt("return", (response === null || response === void 0 || (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
+        response = _context5.sent;
+        return _context5.abrupt("return", (response === null || response === void 0 || (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
           return new _Snapshot(obj, options);
         })) || []);
       case 10:
       case "end":
-        return _context4.stop();
+        return _context5.stop();
     }
-  }, _callee4);
+  }, _callee5);
 })));
 (0, _defineProperty2.default)(Snapshot, "all", function () {
   var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -297,48 +346,48 @@ _Snapshot = Snapshot;
 // Parameters:
 //   id (required) - int64 - Snapshot ID.
 (0, _defineProperty2.default)(Snapshot, "find", /*#__PURE__*/function () {
-  var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(id) {
+  var _ref8 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(id) {
     var params,
       options,
       response,
-      _args5 = arguments;
-    return _regenerator.default.wrap(function _callee5$(_context5) {
-      while (1) switch (_context5.prev = _context5.next) {
+      _args6 = arguments;
+    return _regenerator.default.wrap(function _callee6$(_context6) {
+      while (1) switch (_context6.prev = _context6.next) {
         case 0:
-          params = _args5.length > 1 && _args5[1] !== undefined ? _args5[1] : {};
-          options = _args5.length > 2 && _args5[2] !== undefined ? _args5[2] : {};
+          params = _args6.length > 1 && _args6[1] !== undefined ? _args6[1] : {};
+          options = _args6.length > 2 && _args6[2] !== undefined ? _args6[2] : {};
           if ((0, _utils.isObject)(params)) {
-            _context5.next = 4;
+            _context6.next = 4;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
         case 4:
           params.id = id;
           if (params.id) {
-            _context5.next = 7;
+            _context6.next = 7;
             break;
           }
           throw new errors.MissingParameterError('Parameter missing: id');
         case 7:
           if (!(params.id && !(0, _utils.isInt)(params.id))) {
-            _context5.next = 9;
+            _context6.next = 9;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
         case 9:
-          _context5.next = 11;
+          _context6.next = 11;
           return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params.id)), 'GET', params, options);
         case 11:
-          response = _context5.sent;
-          return _context5.abrupt("return", new _Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
+          response = _context6.sent;
+          return _context6.abrupt("return", new _Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
         case 13:
         case "end":
-          return _context5.stop();
+          return _context6.stop();
       }
-    }, _callee5);
+    }, _callee6);
   }));
   return function (_x) {
-    return _ref7.apply(this, arguments);
+    return _ref8.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(Snapshot, "get", function (id) {
@@ -350,44 +399,44 @@ _Snapshot = Snapshot;
 //   expires_at - string - When the snapshot expires.
 //   name - string - A name for the snapshot.
 //   paths - array(string) - An array of paths to add to the snapshot.
-(0, _defineProperty2.default)(Snapshot, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
+(0, _defineProperty2.default)(Snapshot, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
   var params,
     options,
     response,
-    _args6 = arguments;
-  return _regenerator.default.wrap(function _callee6$(_context6) {
-    while (1) switch (_context6.prev = _context6.next) {
+    _args7 = arguments;
+  return _regenerator.default.wrap(function _callee7$(_context7) {
+    while (1) switch (_context7.prev = _context7.next) {
       case 0:
-        params = _args6.length > 0 && _args6[0] !== undefined ? _args6[0] : {};
-        options = _args6.length > 1 && _args6[1] !== undefined ? _args6[1] : {};
+        params = _args7.length > 0 && _args7[0] !== undefined ? _args7[0] : {};
+        options = _args7.length > 1 && _args7[1] !== undefined ? _args7[1] : {};
         if (!(params.expires_at && !(0, _utils.isString)(params.expires_at))) {
-          _context6.next = 4;
+          _context7.next = 4;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: expires_at must be of type String, received ".concat((0, _utils.getType)(params.expires_at)));
       case 4:
         if (!(params.name && !(0, _utils.isString)(params.name))) {
-          _context6.next = 6;
+          _context7.next = 6;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0, _utils.getType)(params.name)));
       case 6:
         if (!(params.paths && !(0, _utils.isArray)(params.paths))) {
-          _context6.next = 8;
+          _context7.next = 8;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: paths must be of type Array, received ".concat((0, _utils.getType)(params.paths)));
       case 8:
-        _context6.next = 10;
+        _context7.next = 10;
         return _Api.default.sendRequest('/snapshots', 'POST', params, options);
       case 10:
-        response = _context6.sent;
-        return _context6.abrupt("return", new _Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
+        response = _context7.sent;
+        return _context7.abrupt("return", new _Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
       case 12:
       case "end":
-        return _context6.stop();
+        return _context7.stop();
     }
-  }, _callee6);
+  }, _callee7);
 })));
 var _default = exports.default = Snapshot;
 module.exports = Snapshot;

package/package.json

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

package/src/Errors.js

@@ -200,6 +200,7 @@ export class NotFound_NestedNotFoundError extends NotFoundError { constructor(me
 export class NotFound_PlanNotFoundError extends NotFoundError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotFound_PlanNotFoundError' } } errorClasses.NotFound_PlanNotFoundError = NotFound_PlanNotFoundError
 export class NotFound_SiteNotFoundError extends NotFoundError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotFound_SiteNotFoundError' } } errorClasses.NotFound_SiteNotFoundError = NotFound_SiteNotFoundError
 export class NotFound_UserNotFoundError extends NotFoundError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotFound_UserNotFoundError' } } errorClasses.NotFound_UserNotFoundError = NotFound_UserNotFoundError
+export class ProcessingFailure_AlreadyCompletedError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_AlreadyCompletedError' } } errorClasses.ProcessingFailure_AlreadyCompletedError = ProcessingFailure_AlreadyCompletedError
 export class ProcessingFailure_AutomationCannotBeRunManuallyError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_AutomationCannotBeRunManuallyError' } } errorClasses.ProcessingFailure_AutomationCannotBeRunManuallyError = ProcessingFailure_AutomationCannotBeRunManuallyError
 export class ProcessingFailure_BundleOnlyAllowsPreviewsError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_BundleOnlyAllowsPreviewsError' } } errorClasses.ProcessingFailure_BundleOnlyAllowsPreviewsError = ProcessingFailure_BundleOnlyAllowsPreviewsError
 export class ProcessingFailure_BundleOperationRequiresSubfolderError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_BundleOperationRequiresSubfolderError' } } errorClasses.ProcessingFailure_BundleOperationRequiresSubfolderError = ProcessingFailure_BundleOperationRequiresSubfolderError

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.42'
+const version = '1.2.43'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Snapshot.js

@@ -77,6 +77,32 @@ class Snapshot {
     this.attributes.paths = value
   }
 
+  // Finalize Snapshot
+  finalize = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new errors.EmptyPropertyError('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params.id && !isInt(params.id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
+    }
+
+    if (!params.id) {
+      if (this.attributes.id) {
+        params.id = this.id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: id')
+      }
+    }
+
+    await Api.sendRequest(`/snapshots/${encodeURIComponent(params.id)}/finalize`, 'POST', params, this.options)
+  }
+
   // Parameters:
   //   expires_at - string - When the snapshot expires.
   //   name - string - A name for the snapshot.