files.com 1.0.248 → 1.0.249

package/lib/models/RemoteServerConfigurationFile.js

@@ -29,39 +29,51 @@ var RemoteServerConfigurationFile = /*#__PURE__*/(0, _createClass2.default)(func
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Agent ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
+  // string #
   (0, _defineProperty2.default)(this, "getPermissionSet", function () {
     return _this.attributes.permission_set;
   });
+  // string # Files Agent API Token
   (0, _defineProperty2.default)(this, "getApiToken", function () {
     return _this.attributes.api_token;
   });
+  // string # Agent local root path
   (0, _defineProperty2.default)(this, "getRoot", function () {
     return _this.attributes.root;
   });
+  // int64 # Incoming port for files agent connections
   (0, _defineProperty2.default)(this, "getPort", function () {
     return _this.attributes.port;
   });
+  // string
   (0, _defineProperty2.default)(this, "getHostname", function () {
     return _this.attributes.hostname;
   });
+  // string # public key
   (0, _defineProperty2.default)(this, "getPublicKey", function () {
     return _this.attributes.public_key;
   });
+  // string # private key
   (0, _defineProperty2.default)(this, "getPrivateKey", function () {
     return _this.attributes.private_key;
   });
+  // string # either running or shutdown
   (0, _defineProperty2.default)(this, "getStatus", function () {
     return _this.attributes.status;
   });
+  // string # agent config version
   (0, _defineProperty2.default)(this, "getConfigVersion", function () {
     return _this.attributes.config_version;
   });
+  // string
   (0, _defineProperty2.default)(this, "getServerHostKey", function () {
     return _this.attributes.server_host_key;
   });
+  // string
   (0, _defineProperty2.default)(this, "getSubdomain", function () {
     return _this.attributes.subdomain;
   });

package/lib/models/Request.js

@@ -31,48 +31,56 @@ var Request = /*#__PURE__*/(0, _createClass2.default)(function Request() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Request ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
   (0, _defineProperty2.default)(this, "getPath", function () {
     return _this.attributes.path;
   });
   (0, _defineProperty2.default)(this, "setPath", function (value) {
     _this.attributes.path = value;
   });
+  // string # Source filename, if applicable
   (0, _defineProperty2.default)(this, "getSource", function () {
     return _this.attributes.source;
   });
   (0, _defineProperty2.default)(this, "setSource", function (value) {
     _this.attributes.source = value;
   });
+  // string # Destination filename
   (0, _defineProperty2.default)(this, "getDestination", function () {
     return _this.attributes.destination;
   });
   (0, _defineProperty2.default)(this, "setDestination", function (value) {
     _this.attributes.destination = value;
   });
+  // string # ID of automation that created request
   (0, _defineProperty2.default)(this, "getAutomationId", function () {
     return _this.attributes.automation_id;
   });
   (0, _defineProperty2.default)(this, "setAutomationId", function (value) {
     _this.attributes.automation_id = value;
   });
+  // string # User making the request (if applicable)
   (0, _defineProperty2.default)(this, "getUserDisplayName", function () {
     return _this.attributes.user_display_name;
   });
   (0, _defineProperty2.default)(this, "setUserDisplayName", function (value) {
     _this.attributes.user_display_name = value;
   });
+  // string # A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
   (0, _defineProperty2.default)(this, "getUserIds", function () {
     return _this.attributes.user_ids;
   });
   (0, _defineProperty2.default)(this, "setUserIds", function (value) {
     _this.attributes.user_ids = value;
   });
+  // string # A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
   (0, _defineProperty2.default)(this, "getGroupIds", function () {
     return _this.attributes.group_ids;
   });
@@ -157,6 +165,12 @@ var Request = /*#__PURE__*/(0, _createClass2.default)(function Request() {
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   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[last_login_at]=desc). Valid fields are `destination`.
+//   mine - boolean - Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+//   path - string - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
 (0, _defineProperty2.default)(Request, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
   var _response$data;
   var params,
@@ -204,6 +218,12 @@ var Request = /*#__PURE__*/(0, _createClass2.default)(function Request() {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return Request.list(params, options);
 });
+// Parameters:
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   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[last_login_at]=desc). Valid fields are `destination`.
+//   mine - boolean - Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+//   path (required) - string - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
 (0, _defineProperty2.default)(Request, "getFolder", /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(path) {
     var _response$data2;
@@ -264,6 +284,11 @@ var Request = /*#__PURE__*/(0, _createClass2.default)(function Request() {
     return _ref5.apply(this, arguments);
   };
 }());
+// Parameters:
+//   path (required) - string - Folder path on which to request the file.
+//   destination (required) - string - Destination filename (without extension) to request.
+//   user_ids - string - A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
+//   group_ids - string - A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
 (0, _defineProperty2.default)(Request, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var params,
     options,

package/lib/models/Session.js

@@ -31,48 +31,56 @@ var Session = /*#__PURE__*/(0, _createClass2.default)(function Session() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # Session ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # Session language
   (0, _defineProperty2.default)(this, "getLanguage", function () {
     return _this.attributes.language;
   });
   (0, _defineProperty2.default)(this, "setLanguage", function (value) {
     _this.attributes.language = value;
   });
+  // boolean # Is this session read only?
   (0, _defineProperty2.default)(this, "getReadOnly", function () {
     return _this.attributes.read_only;
   });
   (0, _defineProperty2.default)(this, "setReadOnly", function (value) {
     _this.attributes.read_only = value;
   });
+  // boolean # Are insecure SFTP ciphers allowed for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure SSH ciphers for this user.)
   (0, _defineProperty2.default)(this, "getSftpInsecureCiphers", function () {
     return _this.attributes.sftp_insecure_ciphers;
   });
   (0, _defineProperty2.default)(this, "setSftpInsecureCiphers", function (value) {
     _this.attributes.sftp_insecure_ciphers = value;
   });
+  // string # Username to sign in as
   (0, _defineProperty2.default)(this, "getUsername", function () {
     return _this.attributes.username;
   });
   (0, _defineProperty2.default)(this, "setUsername", function (value) {
     _this.attributes.username = value;
   });
+  // string # Password for sign in
   (0, _defineProperty2.default)(this, "getPassword", function () {
     return _this.attributes.password;
   });
   (0, _defineProperty2.default)(this, "setPassword", function (value) {
     _this.attributes.password = value;
   });
+  // string # If this user has a 2FA device, provide its OTP or code here.
   (0, _defineProperty2.default)(this, "getOtp", function () {
     return _this.attributes.otp;
   });
   (0, _defineProperty2.default)(this, "setOtp", function (value) {
     _this.attributes.otp = value;
   });
+  // string # Identifier for a partially-completed login
   (0, _defineProperty2.default)(this, "getPartialSessionId", function () {
     return _this.attributes.partial_session_id;
   });
@@ -101,6 +109,11 @@ var Session = /*#__PURE__*/(0, _createClass2.default)(function Session() {
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   username - string - Username to sign in as
+//   password - string - Password for sign in
+//   otp - string - If this user has a 2FA device, provide its OTP or code here.
+//   partial_session_id - string - Identifier for a partially-completed login
 (0, _defineProperty2.default)(Session, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var params,
     options,

package/lib/models/SettingsChange.js

@@ -31,18 +31,23 @@ var SettingsChange = /*#__PURE__*/(0, _createClass2.default)(function SettingsCh
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // array # Markdown-formatted change messages.
   (0, _defineProperty2.default)(this, "getChanges", function () {
     return _this.attributes.changes;
   });
+  // date-time # The time this change was made
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
+  // int64 # The user id responsible for this change
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
+  // boolean # true if this change was performed by Files.com support.
   (0, _defineProperty2.default)(this, "getUserIsFilesSupport", function () {
     return _this.attributes.user_is_files_support;
   });
+  // string # The username of the user responsible for this change
   (0, _defineProperty2.default)(this, "getUsername", function () {
     return _this.attributes.username;
   });
@@ -59,6 +64,16 @@ var SettingsChange = /*#__PURE__*/(0, _createClass2.default)(function SettingsCh
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   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[last_login_at]=desc). Valid fields are `api_key_id`, `created_at` or `user_id`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+//   filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `api_key_id` and `user_id`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
 (0, _defineProperty2.default)(SettingsChange, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,

package/lib/models/SftpHostKey.js

@@ -31,36 +31,44 @@ var SftpHostKey = /*#__PURE__*/(0, _createClass2.default)(function SftpHostKey()
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Sftp Host Key ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # The friendly name of this SFTP Host Key.
   (0, _defineProperty2.default)(this, "getName", function () {
     return _this.attributes.name;
   });
   (0, _defineProperty2.default)(this, "setName", function (value) {
     _this.attributes.name = value;
   });
+  // string # MD5 Fingerpint of the public key
   (0, _defineProperty2.default)(this, "getFingerprintMd5", function () {
     return _this.attributes.fingerprint_md5;
   });
   (0, _defineProperty2.default)(this, "setFingerprintMd5", function (value) {
     _this.attributes.fingerprint_md5 = value;
   });
+  // string # SHA256 Fingerpint of the public key
   (0, _defineProperty2.default)(this, "getFingerprintSha256", function () {
     return _this.attributes.fingerprint_sha256;
   });
   (0, _defineProperty2.default)(this, "setFingerprintSha256", function (value) {
     _this.attributes.fingerprint_sha256 = value;
   });
+  // string # The private key data.
   (0, _defineProperty2.default)(this, "getPrivateKey", function () {
     return _this.attributes.private_key;
   });
   (0, _defineProperty2.default)(this, "setPrivateKey", function (value) {
     _this.attributes.private_key = value;
   });
+  // Parameters:
+  //   name - string - The friendly name of this SFTP Host Key.
+  //   private_key - string - The private key data.
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       response,
@@ -203,6 +211,9 @@ var SftpHostKey = /*#__PURE__*/(0, _createClass2.default)(function SftpHostKey()
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 (0, _defineProperty2.default)(SftpHostKey, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
   var _response$data;
   var params,
@@ -244,6 +255,8 @@ var SftpHostKey = /*#__PURE__*/(0, _createClass2.default)(function SftpHostKey()
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return SftpHostKey.list(params, options);
 });
+// Parameters:
+//   id (required) - int64 - Sftp Host Key ID.
 (0, _defineProperty2.default)(SftpHostKey, "find", /*#__PURE__*/function () {
   var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
     var params,
@@ -294,6 +307,9 @@ var SftpHostKey = /*#__PURE__*/(0, _createClass2.default)(function SftpHostKey()
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return SftpHostKey.find(id, params, options);
 });
+// Parameters:
+//   name - string - The friendly name of this SFTP Host Key.
+//   private_key - string - The private key data.
 (0, _defineProperty2.default)(SftpHostKey, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
   var params,
     options,