files.com 1.0.247 → 1.0.249

package/lib/models/History.js

@@ -31,42 +31,55 @@ var History = /*#__PURE__*/(0, _createClass2.default)(function History() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.path;
   });
+  // int64 # Action ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
+  // string # 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;
   });
+  // date-time # Action occurrence date/time
   (0, _defineProperty2.default)(this, "getWhen", function () {
     return _this.attributes.when;
   });
+  // string # The destination path for this action, if applicable
   (0, _defineProperty2.default)(this, "getDestination", function () {
     return _this.attributes.destination;
   });
+  // string # Friendly displayed output
   (0, _defineProperty2.default)(this, "getDisplay", function () {
     return _this.attributes.display;
   });
+  // string # IP Address that performed this action
   (0, _defineProperty2.default)(this, "getIp", function () {
     return _this.attributes.ip;
   });
+  // string # The source path for this action, if applicable
   (0, _defineProperty2.default)(this, "getSource", function () {
     return _this.attributes.source;
   });
+  // array # Targets
   (0, _defineProperty2.default)(this, "getTargets", function () {
     return _this.attributes.targets;
   });
+  // int64 # User ID
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
+  // string # Username
   (0, _defineProperty2.default)(this, "getUsername", function () {
     return _this.attributes.username;
   });
+  // string # Type of action
   (0, _defineProperty2.default)(this, "getAction", function () {
     return _this.attributes.action;
   });
+  // string # Failure type.  If action was a user login or session failure, why did it fail?
   (0, _defineProperty2.default)(this, "getFailureType", function () {
     return _this.attributes.failure_type;
   });
+  // string # Interface on which this action occurred.
   (0, _defineProperty2.default)(this, "getInterface", function () {
     return _this.attributes.interface;
   });
@@ -83,6 +96,14 @@ var History = /*#__PURE__*/(0, _createClass2.default)(function History() {
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   start_at - string - Leave blank or set to a date/time to filter earlier entries.
+//   end_at - string - Leave blank or set to a date/time to filter later entries.
+//   display - string - Display format. Leave blank or set to `full` or `parent`.
+//   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 `user_id` and `created_at`.
+//   path (required) - string - Path to operate on.
 (0, _defineProperty2.default)(History, "listForFile", /*#__PURE__*/function () {
   var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(path) {
     var _response$data;
@@ -161,6 +182,14 @@ var History = /*#__PURE__*/(0, _createClass2.default)(function History() {
     return _ref3.apply(this, arguments);
   };
 }());
+// Parameters:
+//   start_at - string - Leave blank or set to a date/time to filter earlier entries.
+//   end_at - string - Leave blank or set to a date/time to filter later entries.
+//   display - string - Display format. Leave blank or set to `full` or `parent`.
+//   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 `user_id` and `created_at`.
+//   path (required) - string - Path to operate on.
 (0, _defineProperty2.default)(History, "listForFolder", /*#__PURE__*/function () {
   var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(path) {
     var _response$data2;
@@ -239,6 +268,14 @@ var History = /*#__PURE__*/(0, _createClass2.default)(function History() {
     return _ref4.apply(this, arguments);
   };
 }());
+// Parameters:
+//   start_at - string - Leave blank or set to a date/time to filter earlier entries.
+//   end_at - string - Leave blank or set to a date/time to filter later entries.
+//   display - string - Display format. Leave blank or set to `full` or `parent`.
+//   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 `user_id` and `created_at`.
+//   user_id (required) - int64 - User ID.
 (0, _defineProperty2.default)(History, "listForUser", /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(user_id) {
     var _response$data3;
@@ -317,6 +354,13 @@ var History = /*#__PURE__*/(0, _createClass2.default)(function History() {
     return _ref5.apply(this, arguments);
   };
 }());
+// Parameters:
+//   start_at - string - Leave blank or set to a date/time to filter earlier entries.
+//   end_at - string - Leave blank or set to a date/time to filter later entries.
+//   display - string - Display format. Leave blank or set to `full` or `parent`.
+//   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 `user_id` and `created_at`.
 (0, _defineProperty2.default)(History, "listLogins", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var _response$data4;
   var params,
@@ -371,6 +415,19 @@ var History = /*#__PURE__*/(0, _createClass2.default)(function History() {
     }
   }, _callee4);
 })));
+// Parameters:
+//   start_at - string - Leave blank or set to a date/time to filter earlier entries.
+//   end_at - string - Leave blank or set to a date/time to filter later entries.
+//   display - string - Display format. Leave blank or set to `full` or `parent`.
+//   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 `path`, `folder`, `user_id` or `created_at`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+//   filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
 (0, _defineProperty2.default)(History, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
   var _response$data5;
   var params,

package/lib/models/HistoryExport.js

@@ -31,156 +31,182 @@ var HistoryExport = /*#__PURE__*/(0, _createClass2.default)(function HistoryExpo
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # History Export ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # Version of the history for the export.
   (0, _defineProperty2.default)(this, "getHistoryVersion", function () {
     return _this.attributes.history_version;
   });
   (0, _defineProperty2.default)(this, "setHistoryVersion", function (value) {
     _this.attributes.history_version = value;
   });
+  // date-time # Start date/time of export range.
   (0, _defineProperty2.default)(this, "getStartAt", function () {
     return _this.attributes.start_at;
   });
   (0, _defineProperty2.default)(this, "setStartAt", function (value) {
     _this.attributes.start_at = value;
   });
+  // date-time # End date/time of export range.
   (0, _defineProperty2.default)(this, "getEndAt", function () {
     return _this.attributes.end_at;
   });
   (0, _defineProperty2.default)(this, "setEndAt", function (value) {
     _this.attributes.end_at = value;
   });
+  // string # Status of export.  Will be: `building`, `ready`, or `failed`
   (0, _defineProperty2.default)(this, "getStatus", function () {
     return _this.attributes.status;
   });
   (0, _defineProperty2.default)(this, "setStatus", function (value) {
     _this.attributes.status = value;
   });
+  // string # Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
   (0, _defineProperty2.default)(this, "getQueryAction", function () {
     return _this.attributes.query_action;
   });
   (0, _defineProperty2.default)(this, "setQueryAction", function (value) {
     _this.attributes.query_action = value;
   });
+  // string # Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
   (0, _defineProperty2.default)(this, "getQueryInterface", function () {
     return _this.attributes.query_interface;
   });
   (0, _defineProperty2.default)(this, "setQueryInterface", function (value) {
     _this.attributes.query_interface = value;
   });
+  // string # Return results that are actions performed by the user indiciated by this User ID
   (0, _defineProperty2.default)(this, "getQueryUserId", function () {
     return _this.attributes.query_user_id;
   });
   (0, _defineProperty2.default)(this, "setQueryUserId", function (value) {
     _this.attributes.query_user_id = value;
   });
+  // string # Return results that are file actions related to the file indicated by this File ID
   (0, _defineProperty2.default)(this, "getQueryFileId", function () {
     return _this.attributes.query_file_id;
   });
   (0, _defineProperty2.default)(this, "setQueryFileId", function (value) {
     _this.attributes.query_file_id = value;
   });
+  // string # Return results that are file actions inside the parent folder specified by this folder ID
   (0, _defineProperty2.default)(this, "getQueryParentId", function () {
     return _this.attributes.query_parent_id;
   });
   (0, _defineProperty2.default)(this, "setQueryParentId", function (value) {
     _this.attributes.query_parent_id = value;
   });
+  // string # Return results that are file actions related to this path.
   (0, _defineProperty2.default)(this, "getQueryPath", function () {
     return _this.attributes.query_path;
   });
   (0, _defineProperty2.default)(this, "setQueryPath", function (value) {
     _this.attributes.query_path = value;
   });
+  // string # Return results that are file actions related to files or folders inside this folder path.
   (0, _defineProperty2.default)(this, "getQueryFolder", function () {
     return _this.attributes.query_folder;
   });
   (0, _defineProperty2.default)(this, "setQueryFolder", function (value) {
     _this.attributes.query_folder = value;
   });
+  // string # Return results that are file moves originating from this path.
   (0, _defineProperty2.default)(this, "getQuerySrc", function () {
     return _this.attributes.query_src;
   });
   (0, _defineProperty2.default)(this, "setQuerySrc", function (value) {
     _this.attributes.query_src = value;
   });
+  // string # Return results that are file moves with this path as destination.
   (0, _defineProperty2.default)(this, "getQueryDestination", function () {
     return _this.attributes.query_destination;
   });
   (0, _defineProperty2.default)(this, "setQueryDestination", function (value) {
     _this.attributes.query_destination = value;
   });
+  // string # Filter results by this IP address.
   (0, _defineProperty2.default)(this, "getQueryIp", function () {
     return _this.attributes.query_ip;
   });
   (0, _defineProperty2.default)(this, "setQueryIp", function (value) {
     _this.attributes.query_ip = value;
   });
+  // string # Filter results by this username.
   (0, _defineProperty2.default)(this, "getQueryUsername", function () {
     return _this.attributes.query_username;
   });
   (0, _defineProperty2.default)(this, "setQueryUsername", function (value) {
     _this.attributes.query_username = value;
   });
+  // string # If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
   (0, _defineProperty2.default)(this, "getQueryFailureType", function () {
     return _this.attributes.query_failure_type;
   });
   (0, _defineProperty2.default)(this, "setQueryFailureType", function (value) {
     _this.attributes.query_failure_type = value;
   });
+  // string # If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
   (0, _defineProperty2.default)(this, "getQueryTargetId", function () {
     return _this.attributes.query_target_id;
   });
   (0, _defineProperty2.default)(this, "setQueryTargetId", function (value) {
     _this.attributes.query_target_id = value;
   });
+  // string # If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
   (0, _defineProperty2.default)(this, "getQueryTargetName", function () {
     return _this.attributes.query_target_name;
   });
   (0, _defineProperty2.default)(this, "setQueryTargetName", function (value) {
     _this.attributes.query_target_name = value;
   });
+  // string # If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
   (0, _defineProperty2.default)(this, "getQueryTargetPermission", function () {
     return _this.attributes.query_target_permission;
   });
   (0, _defineProperty2.default)(this, "setQueryTargetPermission", function (value) {
     _this.attributes.query_target_permission = value;
   });
+  // string # If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
   (0, _defineProperty2.default)(this, "getQueryTargetUserId", function () {
     return _this.attributes.query_target_user_id;
   });
   (0, _defineProperty2.default)(this, "setQueryTargetUserId", function (value) {
     _this.attributes.query_target_user_id = value;
   });
+  // string # If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
   (0, _defineProperty2.default)(this, "getQueryTargetUsername", function () {
     return _this.attributes.query_target_username;
   });
   (0, _defineProperty2.default)(this, "setQueryTargetUsername", function (value) {
     _this.attributes.query_target_username = value;
   });
+  // string # If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
   (0, _defineProperty2.default)(this, "getQueryTargetPlatform", function () {
     return _this.attributes.query_target_platform;
   });
   (0, _defineProperty2.default)(this, "setQueryTargetPlatform", function (value) {
     _this.attributes.query_target_platform = value;
   });
+  // string # If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
   (0, _defineProperty2.default)(this, "getQueryTargetPermissionSet", function () {
     return _this.attributes.query_target_permission_set;
   });
   (0, _defineProperty2.default)(this, "setQueryTargetPermissionSet", function (value) {
     _this.attributes.query_target_permission_set = value;
   });
+  // string # If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
   (0, _defineProperty2.default)(this, "getResultsUrl", function () {
     return _this.attributes.results_url;
   });
   (0, _defineProperty2.default)(this, "setResultsUrl", function (value) {
     _this.attributes.results_url = value;
   });
+  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
@@ -209,6 +235,8 @@ var HistoryExport = /*#__PURE__*/(0, _createClass2.default)(function HistoryExpo
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   id (required) - int64 - History Export ID.
 (0, _defineProperty2.default)(HistoryExport, "find", /*#__PURE__*/function () {
   var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(id) {
     var params,
@@ -259,6 +287,29 @@ var HistoryExport = /*#__PURE__*/(0, _createClass2.default)(function HistoryExpo
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return HistoryExport.find(id, params, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   start_at - string - Start date/time of export range.
+//   end_at - string - End date/time of export range.
+//   query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+//   query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
+//   query_user_id - string - Return results that are actions performed by the user indiciated by this User ID
+//   query_file_id - string - Return results that are file actions related to the file indicated by this File ID
+//   query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
+//   query_path - string - Return results that are file actions related to this path.
+//   query_folder - string - Return results that are file actions related to files or folders inside this folder path.
+//   query_src - string - Return results that are file moves originating from this path.
+//   query_destination - string - Return results that are file moves with this path as destination.
+//   query_ip - string - Filter results by this IP address.
+//   query_username - string - Filter results by this username.
+//   query_failure_type - string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
+//   query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
+//   query_target_name - string - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
+//   query_target_permission - string - If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
+//   query_target_user_id - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
+//   query_target_username - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
+//   query_target_platform - string - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
+//   query_target_permission_set - string - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
 (0, _defineProperty2.default)(HistoryExport, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
   var params,
     options,

package/lib/models/HistoryExportResult.js

@@ -31,75 +31,99 @@ var HistoryExportResult = /*#__PURE__*/(0, _createClass2.default)(function Histo
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Action ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
+  // int64 # When the action happened
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
+  // int64 # When the action happened, in ISO8601 format.
   (0, _defineProperty2.default)(this, "getCreatedAtIso8601", function () {
     return _this.attributes.created_at_iso8601;
   });
+  // int64 # User ID
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
+  // int64 # File ID related to the action
   (0, _defineProperty2.default)(this, "getFileId", function () {
     return _this.attributes.file_id;
   });
+  // int64 # ID of the parent folder
   (0, _defineProperty2.default)(this, "getParentId", function () {
     return _this.attributes.parent_id;
   });
+  // string # Path of the related action 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;
   });
+  // string # Folder in which the action occurred
   (0, _defineProperty2.default)(this, "getFolder", function () {
     return _this.attributes.folder;
   });
+  // string # File move originated from this path
   (0, _defineProperty2.default)(this, "getSrc", function () {
     return _this.attributes.src;
   });
+  // string # File moved to this destination folder
   (0, _defineProperty2.default)(this, "getDestination", function () {
     return _this.attributes.destination;
   });
+  // string # Client IP that performed the action
   (0, _defineProperty2.default)(this, "getIp", function () {
     return _this.attributes.ip;
   });
+  // string # Username of the user that performed the action
   (0, _defineProperty2.default)(this, "getUsername", function () {
     return _this.attributes.username;
   });
+  // string # What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
   (0, _defineProperty2.default)(this, "getAction", function () {
     return _this.attributes.action;
   });
+  // string # The type of login failure, if applicable.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
   (0, _defineProperty2.default)(this, "getFailureType", function () {
     return _this.attributes.failure_type;
   });
+  // string # Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
   (0, _defineProperty2.default)(this, "getInterface", function () {
     return _this.attributes.interface;
   });
+  // int64 # ID of the object (such as Users, or API Keys) on which the action was taken
   (0, _defineProperty2.default)(this, "getTargetId", function () {
     return _this.attributes.target_id;
   });
+  // string # Name of the User, Group or other object with a name related to this action
   (0, _defineProperty2.default)(this, "getTargetName", function () {
     return _this.attributes.target_name;
   });
+  // string # Permission level of the action
   (0, _defineProperty2.default)(this, "getTargetPermission", function () {
     return _this.attributes.target_permission;
   });
+  // boolean # Whether or not the action was recursive
   (0, _defineProperty2.default)(this, "getTargetRecursive", function () {
     return _this.attributes.target_recursive;
   });
+  // int64 # If searching for Histories about API keys, this is when the API key will expire
   (0, _defineProperty2.default)(this, "getTargetExpiresAt", function () {
     return _this.attributes.target_expires_at;
   });
+  // string # If searching for Histories about API keys, this represents the permission set of the associated  API key
   (0, _defineProperty2.default)(this, "getTargetPermissionSet", function () {
     return _this.attributes.target_permission_set;
   });
+  // string # If searching for Histories about API keys, this is the platform on which the action was taken
   (0, _defineProperty2.default)(this, "getTargetPlatform", function () {
     return _this.attributes.target_platform;
   });
+  // string # If searching for Histories about API keys, this is the username on which the action was taken
   (0, _defineProperty2.default)(this, "getTargetUsername", function () {
     return _this.attributes.target_username;
   });
+  // int64 # If searching for Histories about API keys, this is the User ID on which the action was taken
   (0, _defineProperty2.default)(this, "getTargetUserId", function () {
     return _this.attributes.target_user_id;
   });
@@ -116,6 +140,11 @@ var HistoryExportResult = /*#__PURE__*/(0, _createClass2.default)(function Histo
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   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).
+//   history_export_id (required) - int64 - ID of the associated history export.
 (0, _defineProperty2.default)(HistoryExportResult, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,

package/lib/models/Image.js

@@ -29,9 +29,11 @@ var Image = /*#__PURE__*/(0, _createClass2.default)(function Image() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # Image name
   (0, _defineProperty2.default)(this, "getName", function () {
     return _this.attributes.name;
   });
+  // string # Image URI
   (0, _defineProperty2.default)(this, "getUri", function () {
     return _this.attributes.uri;
   });

package/lib/models/InboxRecipient.js

@@ -31,48 +31,56 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # The recipient's company.
   (0, _defineProperty2.default)(this, "getCompany", function () {
     return _this.attributes.company;
   });
   (0, _defineProperty2.default)(this, "setCompany", function (value) {
     _this.attributes.company = value;
   });
+  // string # The recipient's name.
   (0, _defineProperty2.default)(this, "getName", function () {
     return _this.attributes.name;
   });
   (0, _defineProperty2.default)(this, "setName", function (value) {
     _this.attributes.name = value;
   });
+  // string # A note sent to the recipient with the inbox.
   (0, _defineProperty2.default)(this, "getNote", function () {
     return _this.attributes.note;
   });
   (0, _defineProperty2.default)(this, "setNote", function (value) {
     _this.attributes.note = value;
   });
+  // string # The recipient's email address.
   (0, _defineProperty2.default)(this, "getRecipient", function () {
     return _this.attributes.recipient;
   });
   (0, _defineProperty2.default)(this, "setRecipient", function (value) {
     _this.attributes.recipient = value;
   });
+  // date-time # When the Inbox was shared with this recipient.
   (0, _defineProperty2.default)(this, "getSentAt", function () {
     return _this.attributes.sent_at;
   });
   (0, _defineProperty2.default)(this, "setSentAt", function (value) {
     _this.attributes.sent_at = value;
   });
+  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
   (0, _defineProperty2.default)(this, "setUserId", function (value) {
     _this.attributes.user_id = value;
   });
+  // int64 # Inbox to share.
   (0, _defineProperty2.default)(this, "getInboxId", function () {
     return _this.attributes.inbox_id;
   });
   (0, _defineProperty2.default)(this, "setInboxId", function (value) {
     _this.attributes.inbox_id = value;
   });
+  // boolean # Set to true to share the link with the recipient upon creation.
   (0, _defineProperty2.default)(this, "getShareAfterCreate", function () {
     return _this.attributes.share_after_create;
   });
@@ -101,6 +109,18 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   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 `has_registrations`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
+//   filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
+//   inbox_id (required) - int64 - List recipients for the inbox with this ID.
 (0, _defineProperty2.default)(InboxRecipient, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,
@@ -160,6 +180,14 @@ var InboxRecipient = /*#__PURE__*/(0, _createClass2.default)(function InboxRecip
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return InboxRecipient.list(params, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   inbox_id (required) - int64 - Inbox to share.
+//   recipient (required) - string - Email address to share this inbox with.
+//   name - string - Name of recipient.
+//   company - string - Company of recipient.
+//   note - string - Note to include in email.
+//   share_after_create - boolean - Set to true to share the link with the recipient upon creation.
 (0, _defineProperty2.default)(InboxRecipient, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
   var params,
     options,

package/lib/models/InboxRegistration.js

@@ -31,36 +31,47 @@ var InboxRegistration = /*#__PURE__*/(0, _createClass2.default)(function InboxRe
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # Registration cookie code
   (0, _defineProperty2.default)(this, "getCode", function () {
     return _this.attributes.code;
   });
+  // string # Registrant name
   (0, _defineProperty2.default)(this, "getName", function () {
     return _this.attributes.name;
   });
+  // string # Registrant company name
   (0, _defineProperty2.default)(this, "getCompany", function () {
     return _this.attributes.company;
   });
+  // string # Registrant email address
   (0, _defineProperty2.default)(this, "getEmail", function () {
     return _this.attributes.email;
   });
+  // string # Clickwrap text that was shown to the registrant
   (0, _defineProperty2.default)(this, "getClickwrapBody", function () {
     return _this.attributes.clickwrap_body;
   });
+  // int64 # Id of associated form field set
   (0, _defineProperty2.default)(this, "getFormFieldSetId", function () {
     return _this.attributes.form_field_set_id;
   });
+  // object # Data for form field set with form field ids as keys and user data as values
   (0, _defineProperty2.default)(this, "getFormFieldData", function () {
     return _this.attributes.form_field_data;
   });
+  // int64 # Id of associated inbox
   (0, _defineProperty2.default)(this, "getInboxId", function () {
     return _this.attributes.inbox_id;
   });
+  // int64 # Id of associated inbox recipient
   (0, _defineProperty2.default)(this, "getInboxRecipientId", function () {
     return _this.attributes.inbox_recipient_id;
   });
+  // string # Title of associated inbox
   (0, _defineProperty2.default)(this, "getInboxTitle", function () {
     return _this.attributes.inbox_title;
   });
+  // date-time # Registration creation date/time
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
@@ -77,6 +88,10 @@ var InboxRegistration = /*#__PURE__*/(0, _createClass2.default)(function InboxRe
   });
   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).
+//   folder_behavior_id - int64 - ID of the associated Inbox.
 (0, _defineProperty2.default)(InboxRegistration, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,