files.com 1.0.247 → 1.0.249

package/lib/models/Clickwrap.js

@@ -31,42 +31,54 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Clickwrap ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
   (0, _defineProperty2.default)(this, "getName", function () {
     return _this.attributes.name;
   });
   (0, _defineProperty2.default)(this, "setName", function (value) {
     _this.attributes.name = value;
   });
+  // string # Body text of Clickwrap (supports Markdown formatting).
   (0, _defineProperty2.default)(this, "getBody", function () {
     return _this.attributes.body;
   });
   (0, _defineProperty2.default)(this, "setBody", function (value) {
     _this.attributes.body = value;
   });
+  // string # Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
   (0, _defineProperty2.default)(this, "getUseWithUsers", function () {
     return _this.attributes.use_with_users;
   });
   (0, _defineProperty2.default)(this, "setUseWithUsers", function (value) {
     _this.attributes.use_with_users = value;
   });
+  // string # Use this Clickwrap for Bundles?
   (0, _defineProperty2.default)(this, "getUseWithBundles", function () {
     return _this.attributes.use_with_bundles;
   });
   (0, _defineProperty2.default)(this, "setUseWithBundles", function (value) {
     _this.attributes.use_with_bundles = value;
   });
+  // string # Use this Clickwrap for Inboxes?
   (0, _defineProperty2.default)(this, "getUseWithInboxes", function () {
     return _this.attributes.use_with_inboxes;
   });
   (0, _defineProperty2.default)(this, "setUseWithInboxes", function (value) {
     _this.attributes.use_with_inboxes = value;
   });
+  // Parameters:
+  //   name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+  //   body - string - Body text of Clickwrap (supports Markdown formatting).
+  //   use_with_bundles - string - Use this Clickwrap for Bundles?
+  //   use_with_inboxes - string - Use this Clickwrap for Inboxes?
+  //   use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       response,
@@ -227,6 +239,9 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
   });
   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)(Clickwrap, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
   var _response$data;
   var params,
@@ -268,6 +283,8 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return Clickwrap.list(params, options);
 });
+// Parameters:
+//   id (required) - int64 - Clickwrap ID.
 (0, _defineProperty2.default)(Clickwrap, "find", /*#__PURE__*/function () {
   var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
     var params,
@@ -318,6 +335,12 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return Clickwrap.find(id, params, options);
 });
+// Parameters:
+//   name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+//   body - string - Body text of Clickwrap (supports Markdown formatting).
+//   use_with_bundles - string - Use this Clickwrap for Bundles?
+//   use_with_inboxes - string - Use this Clickwrap for Inboxes?
+//   use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
 (0, _defineProperty2.default)(Clickwrap, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
   var params,
     options,

package/lib/models/DnsRecord.js

@@ -31,15 +31,19 @@ var DnsRecord = /*#__PURE__*/(0, _createClass2.default)(function DnsRecord() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # Unique label for DNS record; used by Zapier and other integrations.
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
+  // string # DNS record domain name
   (0, _defineProperty2.default)(this, "getDomain", function () {
     return _this.attributes.domain;
   });
+  // string # DNS record type
   (0, _defineProperty2.default)(this, "getRrtype", function () {
     return _this.attributes.rrtype;
   });
+  // string # DNS record value
   (0, _defineProperty2.default)(this, "getValue", function () {
     return _this.attributes.value;
   });
@@ -56,6 +60,9 @@ var DnsRecord = /*#__PURE__*/(0, _createClass2.default)(function DnsRecord() {
   });
   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)(DnsRecord, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,

package/lib/models/Errors.js

@@ -29,9 +29,11 @@ var Errors = /*#__PURE__*/(0, _createClass2.default)(function Errors() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // array # A list of fields where errors occur
   (0, _defineProperty2.default)(this, "getFields", function () {
     return _this.attributes.fields;
   });
+  // array # A list of error messages
   (0, _defineProperty2.default)(this, "getMessages", function () {
     return _this.attributes.messages;
   });

package/lib/models/ExternalEvent.js

@@ -31,63 +31,74 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Event ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # Type of event being recorded.
   (0, _defineProperty2.default)(this, "getEventType", function () {
     return _this.attributes.event_type;
   });
   (0, _defineProperty2.default)(this, "setEventType", function (value) {
     _this.attributes.event_type = value;
   });
+  // string # Status of event.
   (0, _defineProperty2.default)(this, "getStatus", function () {
     return _this.attributes.status;
   });
   (0, _defineProperty2.default)(this, "setStatus", function (value) {
     _this.attributes.status = value;
   });
+  // string # Event body
   (0, _defineProperty2.default)(this, "getBody", function () {
     return _this.attributes.body;
   });
   (0, _defineProperty2.default)(this, "setBody", function (value) {
     _this.attributes.body = value;
   });
+  // date-time # External event create date/time
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
+  // string # Link to log file.
   (0, _defineProperty2.default)(this, "getBodyUrl", function () {
     return _this.attributes.body_url;
   });
   (0, _defineProperty2.default)(this, "setBodyUrl", function (value) {
     _this.attributes.body_url = value;
   });
+  // int64 # Folder Behavior ID
   (0, _defineProperty2.default)(this, "getFolderBehaviorId", function () {
     return _this.attributes.folder_behavior_id;
   });
   (0, _defineProperty2.default)(this, "setFolderBehaviorId", function (value) {
     _this.attributes.folder_behavior_id = value;
   });
+  // int64 # For sync events, the number of files handled successfully.
   (0, _defineProperty2.default)(this, "getSuccessfulFiles", function () {
     return _this.attributes.successful_files;
   });
   (0, _defineProperty2.default)(this, "setSuccessfulFiles", function (value) {
     _this.attributes.successful_files = value;
   });
+  // int64 # For sync events, the number of files that encountered errors.
   (0, _defineProperty2.default)(this, "getErroredFiles", function () {
     return _this.attributes.errored_files;
   });
   (0, _defineProperty2.default)(this, "setErroredFiles", function (value) {
     _this.attributes.errored_files = value;
   });
+  // int64 # For sync events, the total number of bytes synced.
   (0, _defineProperty2.default)(this, "getBytesSynced", function () {
     return _this.attributes.bytes_synced;
   });
   (0, _defineProperty2.default)(this, "setBytesSynced", function (value) {
     _this.attributes.bytes_synced = value;
   });
+  // string # Associated Remote Server type, if any
   (0, _defineProperty2.default)(this, "getRemoteServerType", function () {
     return _this.attributes.remote_server_type;
   });
@@ -116,6 +127,16 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
   });
   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 `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+//   filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
 (0, _defineProperty2.default)(ExternalEvent, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,
@@ -157,6 +178,8 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return ExternalEvent.list(params, options);
 });
+// Parameters:
+//   id (required) - int64 - External Event ID.
 (0, _defineProperty2.default)(ExternalEvent, "find", /*#__PURE__*/function () {
   var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id) {
     var params,
@@ -207,6 +230,9 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return ExternalEvent.find(id, params, options);
 });
+// Parameters:
+//   status (required) - string - Status of event.
+//   body (required) - string - Event body
 (0, _defineProperty2.default)(ExternalEvent, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
   var params,
     options,

package/lib/models/File.js

@@ -137,165 +137,199 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       return _ref4.apply(this, arguments);
     };
   }());
+  // string # File/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 # File/Folder display name
   (0, _defineProperty2.default)(this, "getDisplayName", function () {
     return _this.attributes.display_name;
   });
   (0, _defineProperty2.default)(this, "setDisplayName", function (value) {
     _this.attributes.display_name = value;
   });
+  // string # Type: `directory` or `file`.
   (0, _defineProperty2.default)(this, "getType", function () {
     return _this.attributes.type;
   });
   (0, _defineProperty2.default)(this, "setType", function (value) {
     _this.attributes.type = value;
   });
+  // int64 # File/Folder size
   (0, _defineProperty2.default)(this, "getSize", function () {
     return _this.attributes.size;
   });
   (0, _defineProperty2.default)(this, "setSize", function (value) {
     _this.attributes.size = value;
   });
+  // date-time # File created date/time
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
+  // date-time # File last modified date/time, according to the server.  This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
   (0, _defineProperty2.default)(this, "getMtime", function () {
     return _this.attributes.mtime;
   });
   (0, _defineProperty2.default)(this, "setMtime", function (value) {
     _this.attributes.mtime = value;
   });
+  // date-time # File last modified date/time, according to the client who set it.  Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times.  This allows Desktop<->Cloud syncing to preserve modified at times.
   (0, _defineProperty2.default)(this, "getProvidedMtime", function () {
     return _this.attributes.provided_mtime;
   });
   (0, _defineProperty2.default)(this, "setProvidedMtime", function (value) {
     _this.attributes.provided_mtime = value;
   });
+  // string # File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
   (0, _defineProperty2.default)(this, "getCrc32", function () {
     return _this.attributes.crc32;
   });
   (0, _defineProperty2.default)(this, "setCrc32", function (value) {
     _this.attributes.crc32 = value;
   });
+  // string # File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
   (0, _defineProperty2.default)(this, "getMd5", function () {
     return _this.attributes.md5;
   });
   (0, _defineProperty2.default)(this, "setMd5", function (value) {
     _this.attributes.md5 = value;
   });
+  // string # MIME Type.  This is determined by the filename extension and is not stored separately internally.
   (0, _defineProperty2.default)(this, "getMimeType", function () {
     return _this.attributes.mime_type;
   });
   (0, _defineProperty2.default)(this, "setMimeType", function (value) {
     _this.attributes.mime_type = value;
   });
+  // string # Region location
   (0, _defineProperty2.default)(this, "getRegion", function () {
     return _this.attributes.region;
   });
   (0, _defineProperty2.default)(this, "setRegion", function (value) {
     _this.attributes.region = value;
   });
+  // string # A short string representing the current user's permissions.  Can be `r`,`w`,`d`, `l` or any combination
   (0, _defineProperty2.default)(this, "getPermissions", function () {
     return _this.attributes.permissions;
   });
   (0, _defineProperty2.default)(this, "setPermissions", function (value) {
     _this.attributes.permissions = value;
   });
+  // boolean # Are subfolders locked and unable to be modified?
   (0, _defineProperty2.default)(this, "getSubfoldersLocked", function () {
     return _this.attributes.subfolders_locked;
   });
   (0, _defineProperty2.default)(this, "setSubfoldersLocked", function (value) {
     _this.attributes.subfolders_locked = value;
   });
+  // boolean # Is this folder locked and unable to be modified?
   (0, _defineProperty2.default)(this, "getIsLocked", function () {
     return _this.attributes.is_locked;
   });
   (0, _defineProperty2.default)(this, "setIsLocked", function (value) {
     _this.attributes.is_locked = value;
   });
+  // string # Link to download file. Provided only in response to a download request.
   (0, _defineProperty2.default)(this, "getDownloadUri", function () {
     return _this.attributes.download_uri;
   });
   (0, _defineProperty2.default)(this, "setDownloadUri", function (value) {
     _this.attributes.download_uri = value;
   });
+  // string # Bookmark/priority color of file/folder
   (0, _defineProperty2.default)(this, "getPriorityColor", function () {
     return _this.attributes.priority_color;
   });
   (0, _defineProperty2.default)(this, "setPriorityColor", function (value) {
     _this.attributes.priority_color = value;
   });
+  // int64 # File preview ID
   (0, _defineProperty2.default)(this, "getPreviewId", function () {
     return _this.attributes.preview_id;
   });
   (0, _defineProperty2.default)(this, "setPreviewId", function (value) {
     _this.attributes.preview_id = value;
   });
+  // Preview # File preview
   (0, _defineProperty2.default)(this, "getPreview", function () {
     return _this.attributes.preview;
   });
   (0, _defineProperty2.default)(this, "setPreview", function (value) {
     _this.attributes.preview = value;
   });
+  // string # The action to perform.  Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
   (0, _defineProperty2.default)(this, "getAction", function () {
     return _this.attributes.action;
   });
   (0, _defineProperty2.default)(this, "setAction", function (value) {
     _this.attributes.action = value;
   });
+  // int64 # Length of file.
   (0, _defineProperty2.default)(this, "getLength", function () {
     return _this.attributes.length;
   });
   (0, _defineProperty2.default)(this, "setLength", function (value) {
     _this.attributes.length = value;
   });
+  // boolean # Create parent directories if they do not exist?
   (0, _defineProperty2.default)(this, "getMkdirParents", function () {
     return _this.attributes.mkdir_parents;
   });
   (0, _defineProperty2.default)(this, "setMkdirParents", function (value) {
     _this.attributes.mkdir_parents = value;
   });
+  // int64 # Part if uploading a part.
   (0, _defineProperty2.default)(this, "getPart", function () {
     return _this.attributes.part;
   });
   (0, _defineProperty2.default)(this, "setPart", function (value) {
     _this.attributes.part = value;
   });
+  // int64 # How many parts to fetch?
   (0, _defineProperty2.default)(this, "getParts", function () {
     return _this.attributes.parts;
   });
   (0, _defineProperty2.default)(this, "setParts", function (value) {
     _this.attributes.parts = value;
   });
+  // string #
   (0, _defineProperty2.default)(this, "getRef", function () {
     return _this.attributes.ref;
   });
   (0, _defineProperty2.default)(this, "setRef", function (value) {
     _this.attributes.ref = value;
   });
+  // int64 # File byte offset to restart from.
   (0, _defineProperty2.default)(this, "getRestart", function () {
     return _this.attributes.restart;
   });
   (0, _defineProperty2.default)(this, "setRestart", function (value) {
     _this.attributes.restart = value;
   });
+  // string # If copying folder, copy just the structure?
   (0, _defineProperty2.default)(this, "getStructure", function () {
     return _this.attributes.structure;
   });
   (0, _defineProperty2.default)(this, "setStructure", function (value) {
     _this.attributes.structure = value;
   });
+  // boolean # Allow file rename instead of overwrite?
   (0, _defineProperty2.default)(this, "getWithRename", function () {
     return _this.attributes.with_rename;
   });
   (0, _defineProperty2.default)(this, "setWithRename", function (value) {
     _this.attributes.with_rename = value;
   });
+  // Download file
+  //
+  // Parameters:
+  //   action - string - Can be blank, `redirect` or `stat`.  If set to `stat`, we will return file information but without a download URL, and without logging a download.  If set to `redirect` we will serve a 302 redirect directly to the file.  This is used for integrations with Zapier, and is not recommended for most integrations.
+  //   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+  //   with_previews - boolean - Include file preview information?
+  //   with_priority_color - boolean - Include file priority color information?
   (0, _defineProperty2.default)(this, "download", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
     var params,
       response,
@@ -360,6 +394,9 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }
     }, _callee5);
   })));
+  // Parameters:
+  //   provided_mtime - string - Modified time of file.
+  //   priority_color - string - Priority/Bookmark color of file.
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
     var params,
       response,
@@ -424,6 +461,8 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }
     }, _callee6);
   })));
+  // Parameters:
+  //   recursive - boolean - If true, will recursively delete folers.  Otherwise, will error on non-empty folders.
   (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
     var params,
       response,
@@ -480,6 +519,11 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     return _this.delete(params);
   });
+  // Copy file/folder
+  //
+  // Parameters:
+  //   destination (required) - string - Copy destination path.
+  //   structure - boolean - Copy structure only?
   (0, _defineProperty2.default)(this, "copy", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8() {
     var params,
       response,
@@ -552,6 +596,10 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }
     }, _callee8);
   })));
+  // Move file/folder
+  //
+  // Parameters:
+  //   destination (required) - string - Move destination path.
   (0, _defineProperty2.default)(this, "move", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9() {
     var params,
       response,
@@ -624,6 +672,16 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }
     }, _callee9);
   })));
+  // Begin file upload
+  //
+  // Parameters:
+  //   mkdir_parents - boolean - Create parent directories if they do not exist?
+  //   part - int64 - Part if uploading a part.
+  //   parts - int64 - How many parts to fetch?
+  //   ref - string -
+  //   restart - int64 - File byte offset to restart from.
+  //   size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting).
+  //   with_rename - boolean - Allow file rename instead of overwrite?
   (0, _defineProperty2.default)(this, "beginUpload", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10() {
     var _response$data;
     var params,
@@ -818,6 +876,9 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     return _ref15.apply(this, arguments);
   };
 }());
+/**
+ * @note see File.copy() for list of supported params
+ */
 (0, _defineProperty2.default)(File, "uploadStream", /*#__PURE__*/function () {
   var _ref16 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16(destinationPath, readableStream, params, options) {
     var firstFileUploadPart, file;
@@ -949,6 +1010,10 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     return _ref16.apply(this, arguments);
   };
 }());
+/**
+ * data - string, Buffer, Stream, any object implementing Symbol.iterator or Symbol.asyncIterator
+ * @note see File.copy() for list of supported params
+ */
 (0, _defineProperty2.default)(File, "uploadData", /*#__PURE__*/function () {
   var _ref19 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee17(destinationPath, data, params, options) {
     return _regenerator.default.wrap(function _callee17$(_context17) {
@@ -971,6 +1036,9 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     return _ref19.apply(this, arguments);
   };
 }());
+/**
+ * @note see File.copy() for list of supported params
+ */
 (0, _defineProperty2.default)(File, "uploadFile", /*#__PURE__*/function () {
   var _ref20 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee18(destinationPath, sourceFilePath, params, options) {
     var _require3, openDiskFileReadStream, stream;
@@ -996,6 +1064,21 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     return _ref20.apply(this, arguments);
   };
 }());
+// Parameters:
+//   path (required) - string - Path to operate on.
+//   action - string - The action to perform.  Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
+//   etags[etag] (required) - array(string) - etag identifier.
+//   etags[part] (required) - array(int64) - Part number.
+//   length - int64 - Length of file.
+//   mkdir_parents - boolean - Create parent directories if they do not exist?
+//   part - int64 - Part if uploading a part.
+//   parts - int64 - How many parts to fetch?
+//   provided_mtime - string - User provided modification time.
+//   ref - string -
+//   restart - int64 - File byte offset to restart from.
+//   size - int64 - Size of file.
+//   structure - string - If copying folder, copy just the structure?
+//   with_rename - boolean - Allow file rename instead of overwrite?
 (0, _defineProperty2.default)(File, "create", /*#__PURE__*/function () {
   var _ref21 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee19(path) {
     var params,
@@ -1095,6 +1178,11 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     return _ref21.apply(this, arguments);
   };
 }());
+// Parameters:
+//   path (required) - string - Path to operate on.
+//   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+//   with_previews - boolean - Include file preview information?
+//   with_priority_color - boolean - Include file priority color information?
 (0, _defineProperty2.default)(File, "find", /*#__PURE__*/function () {
   var _ref22 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee20(path) {
     var params,

package/lib/models/FileAction.js

@@ -29,9 +29,11 @@ var FileAction = /*#__PURE__*/(0, _createClass2.default)(function FileAction() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.path;
   });
+  // string # Status of file operation.
   (0, _defineProperty2.default)(this, "getStatus", function () {
     return _this.attributes.status;
   });
+  // int64 # If status is pending, this is the id of the FileMigration to check for status updates.
   (0, _defineProperty2.default)(this, "getFileMigrationId", function () {
     return _this.attributes.file_migration_id;
   });

package/lib/models/FileComment.js

@@ -31,30 +31,36 @@ var FileComment = /*#__PURE__*/(0, _createClass2.default)(function FileComment()
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # File Comment ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # Comment body.
   (0, _defineProperty2.default)(this, "getBody", function () {
     return _this.attributes.body;
   });
   (0, _defineProperty2.default)(this, "setBody", function (value) {
     _this.attributes.body = value;
   });
+  // array # Reactions to this comment.
   (0, _defineProperty2.default)(this, "getReactions", function () {
     return _this.attributes.reactions;
   });
   (0, _defineProperty2.default)(this, "setReactions", function (value) {
     _this.attributes.reactions = value;
   });
+  // string # File path.
   (0, _defineProperty2.default)(this, "getPath", function () {
     return _this.attributes.path;
   });
   (0, _defineProperty2.default)(this, "setPath", function (value) {
     _this.attributes.path = value;
   });
+  // Parameters:
+  //   body (required) - string - Comment body.
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       response,
@@ -205,6 +211,10 @@ var FileComment = /*#__PURE__*/(0, _createClass2.default)(function FileComment()
   });
   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).
+//   path (required) - string - Path to operate on.
 (0, _defineProperty2.default)(FileComment, "listFor", /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(path) {
     var _response$data;
@@ -265,6 +275,9 @@ var FileComment = /*#__PURE__*/(0, _createClass2.default)(function FileComment()
     return _ref5.apply(this, arguments);
   };
 }());
+// Parameters:
+//   body (required) - string - Comment body.
+//   path (required) - string - File path.
 (0, _defineProperty2.default)(FileComment, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var params,
     options,