files.com 1.2.258 → 1.2.259

package/lib/models/SyncRun.js

@@ -0,0 +1,245 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+exports.__esModule = true;
+exports.default = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _Api = _interopRequireDefault(require("../Api"));
+var errors = _interopRequireWildcard(require("../Errors"));
+var _utils = require("../utils");
+var _SyncRun;
+/* eslint-disable no-unused-vars */
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/* eslint-enable no-unused-vars */
+/**
+ * Class SyncRun
+ */
+var SyncRun = /*#__PURE__*/(0, _createClass2.default)(function SyncRun() {
+  var _this = this;
+  var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  (0, _classCallCheck2.default)(this, SyncRun);
+  (0, _defineProperty2.default)(this, "attributes", {});
+  (0, _defineProperty2.default)(this, "options", {});
+  (0, _defineProperty2.default)(this, "isLoaded", function () {
+    return !!_this.attributes.id;
+  });
+  // int64 # SyncRun ID
+  (0, _defineProperty2.default)(this, "getId", function () {
+    return _this.attributes.id;
+  });
+  // int64 # ID of the Sync this run belongs to
+  (0, _defineProperty2.default)(this, "getSyncId", function () {
+    return _this.attributes.sync_id;
+  });
+  // int64 # Site ID
+  (0, _defineProperty2.default)(this, "getSiteId", function () {
+    return _this.attributes.site_id;
+  });
+  // string # Status of the sync run (success, failure, partial_failure, in_progress, skipped)
+  (0, _defineProperty2.default)(this, "getStatus", function () {
+    return _this.attributes.status;
+  });
+  // string # Type of remote server used, if any
+  (0, _defineProperty2.default)(this, "getRemoteServerType", function () {
+    return _this.attributes.remote_server_type;
+  });
+  // string # Log or summary body for this run
+  (0, _defineProperty2.default)(this, "getBody", function () {
+    return _this.attributes.body;
+  });
+  // array(array) # Array of errors encountered during the run
+  (0, _defineProperty2.default)(this, "getEventErrors", function () {
+    return _this.attributes.event_errors;
+  });
+  // int64 # Total bytes synced in this run
+  (0, _defineProperty2.default)(this, "getBytesSynced", function () {
+    return _this.attributes.bytes_synced;
+  });
+  // int64 # Number of files compared
+  (0, _defineProperty2.default)(this, "getComparedFiles", function () {
+    return _this.attributes.compared_files;
+  });
+  // int64 # Number of folders compared
+  (0, _defineProperty2.default)(this, "getComparedFolders", function () {
+    return _this.attributes.compared_folders;
+  });
+  // int64 # Number of files that errored
+  (0, _defineProperty2.default)(this, "getErroredFiles", function () {
+    return _this.attributes.errored_files;
+  });
+  // int64 # Number of files successfully synced
+  (0, _defineProperty2.default)(this, "getSuccessfulFiles", function () {
+    return _this.attributes.successful_files;
+  });
+  // float # Total runtime in seconds
+  (0, _defineProperty2.default)(this, "getRuntime", function () {
+    return _this.attributes.runtime;
+  });
+  // string # S3 path to the main log file
+  (0, _defineProperty2.default)(this, "getS3BodyPath", function () {
+    return _this.attributes.s3_body_path;
+  });
+  // string # S3 path to the internal log file
+  (0, _defineProperty2.default)(this, "getS3InternalBodyPath", function () {
+    return _this.attributes.s3_internal_body_path;
+  });
+  // date-time # When this run was completed
+  (0, _defineProperty2.default)(this, "getCompletedAt", function () {
+    return _this.attributes.completed_at;
+  });
+  // boolean # Whether notifications were sent for this run
+  (0, _defineProperty2.default)(this, "getNotified", function () {
+    return _this.attributes.notified;
+  });
+  // date-time # When this run was created
+  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
+    return _this.attributes.created_at;
+  });
+  // date-time # When this run was last updated
+  (0, _defineProperty2.default)(this, "getUpdatedAt", function () {
+    return _this.attributes.updated_at;
+  });
+  Object.entries(attributes).forEach(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    var normalizedKey = key.replace('?', '');
+    _this.attributes[normalizedKey] = value;
+    Object.defineProperty(_this, normalizedKey, {
+      value: value,
+      writable: false
+    });
+  });
+  this.options = _objectSpread({}, options);
+});
+_SyncRun = SyncRun;
+// 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. Valid fields are `sync_id`, `created_at` or `status`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `sync_id`. Valid field combinations are `[ sync_id, status ]`.
+//   sync_id (required) - int64 - ID of the Sync this run belongs to
+(0, _defineProperty2.default)(SyncRun, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
+  var _response$data;
+  var params,
+    options,
+    response,
+    _args = arguments;
+  return _regenerator.default.wrap(function (_context) {
+    while (1) switch (_context.prev = _context.next) {
+      case 0:
+        params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+        options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
+        if (params.sync_id) {
+          _context.next = 1;
+          break;
+        }
+        throw new errors.MissingParameterError('Parameter missing: sync_id');
+      case 1:
+        if (!(params.user_id && !(0, _utils.isInt)(params.user_id))) {
+          _context.next = 2;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params.user_id)));
+      case 2:
+        if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
+          _context.next = 3;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params.cursor)));
+      case 3:
+        if (!(params.per_page && !(0, _utils.isInt)(params.per_page))) {
+          _context.next = 4;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params.per_page)));
+      case 4:
+        if (!(params.sync_id && !(0, _utils.isInt)(params.sync_id))) {
+          _context.next = 5;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: sync_id must be of type Int, received ".concat((0, _utils.getType)(params.sync_id)));
+      case 5:
+        _context.next = 6;
+        return _Api.default.sendRequest('/sync_runs', 'GET', params, options);
+      case 6:
+        response = _context.sent;
+        return _context.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 _SyncRun(obj, options);
+        })) || []);
+      case 7:
+      case "end":
+        return _context.stop();
+    }
+  }, _callee);
+})));
+(0, _defineProperty2.default)(SyncRun, "all", function () {
+  var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return _SyncRun.list(params, options);
+});
+// Parameters:
+//   id (required) - int64 - Sync Run ID.
+(0, _defineProperty2.default)(SyncRun, "find", /*#__PURE__*/function () {
+  var _ref4 = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2(id) {
+    var params,
+      options,
+      response,
+      _args2 = arguments;
+    return _regenerator.default.wrap(function (_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          params = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : {};
+          options = _args2.length > 2 && _args2[2] !== undefined ? _args2[2] : {};
+          if ((0, _utils.isObject)(params)) {
+            _context2.next = 1;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
+        case 1:
+          params.id = id;
+          if (params.id) {
+            _context2.next = 2;
+            break;
+          }
+          throw new errors.MissingParameterError('Parameter missing: id');
+        case 2:
+          if (!(params.id && !(0, _utils.isInt)(params.id))) {
+            _context2.next = 3;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
+        case 3:
+          _context2.next = 4;
+          return _Api.default.sendRequest("/sync_runs/".concat(encodeURIComponent(params.id)), 'GET', params, options);
+        case 4:
+          response = _context2.sent;
+          return _context2.abrupt("return", new _SyncRun(response === null || response === void 0 ? void 0 : response.data, options));
+        case 5:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return function (_x) {
+    return _ref4.apply(this, arguments);
+  };
+}());
+(0, _defineProperty2.default)(SyncRun, "get", function (id) {
+  var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  return _SyncRun.find(id, params, options);
+});
+var _default = exports.default = SyncRun;
+module.exports = SyncRun;
+module.exports.default = SyncRun;

package/package.json

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

package/src/Files.js

@@ -6,7 +6,7 @@ let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
 let language = null
-const version = '1.2.258'
+const version = '1.2.259'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Site.js

@@ -193,6 +193,9 @@ class Site {
   // boolean # Use legacy checksums mode?
   getLegacyChecksumsMode = () => this.attributes.legacy_checksums_mode
 
+  // boolean # If true, we will migrate all remote server syncs to the new Sync model.
+  getMigrateRemoteServerSyncToSync = () => this.attributes.migrate_remote_server_sync_to_sync
+
   // boolean # Is the mobile app enabled?
   getMobileApp = () => this.attributes.mobile_app
 
@@ -594,6 +597,7 @@ class Site {
   //   calculate_file_checksums_sha1 - boolean - Calculate SHA1 checksums for files?
   //   calculate_file_checksums_sha256 - boolean - Calculate SHA256 checksums for files?
   //   legacy_checksums_mode - boolean - Use legacy checksums mode?
+  //   migrate_remote_server_sync_to_sync - boolean - If true, we will migrate all remote server syncs to the new Sync model.
   //   session_expiry - double - Session expiry in hours
   //   ssl_required - boolean - Is SSL required?  Disabling this is insecure.
   //   tls_disabled - boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site.  We intend to remove this capability entirely in early 2024.  If set, the `sftp_insecure_ciphers` flag will be automatically set to true.