document list method filters

Author: sanfilip

lib/machines/list.js

@@ -8,6 +8,32 @@ var assign = require('lodash.assign');
  * @method list
  * @description List information about all machines available to either the current
  * authenticated user or the team, if the user belongs to a team.
+ * The list method takes an optional first argument to limit the returned machine objects.
+ * @param {object} [filter] - An optional filter object to limit the returned machine objects
+ * @param {string} [filter.machineId] - Optional machine id to match on. Note: must be specified as "machineId", not "id".
+ * @param {string} [filter.name] - Optional name to match on
+ * @param {string} [filter.os] - Optional os to match on
+ * @param {string} [filter.ram] - Optional ram value to match on
+ * @param {number} [filter.cpus] - Optional cpu count to mactch on
+ * @param {string} [filter.gpu] - Optional gpu to match on
+ * @param {string} [filter.storageTotal] - Optional storageTotal value to match on
+ * @param {string} [filter.storageUsed] - Optional storageUsed value to match on
+ * @param {string} [filter.usageRate] - Optional usageRate value to match on
+ * @param {number} [filter.shutdownTimeoutInHours] - Optional shutdownTimeoutInHours value to mactch on
+ * @param {boolean} [filter.performAutoSnapshot] - Optional performAutoSnapshot value to match on, either true or false
+ * @param {string} [filter.autoSnapshotFrequency] - Optional autoSnapshotFrequency value to mactch on
+ * @param {number} [filter.autoSnapshotSaveCount] - Optional autoSnapshotSaveCount value to mactch on
+ * @param {string} [filter.agentType] - Optional agentType value to mactch on
+ * @param {string} [filter.dtCreated] - Optional datatime created value to match on
+ * @param {string} [filter.state] - Optional state value to mactch on
+ * @param {string} [filter.networkId] - Optional networkId to mactch on
+ * @param {string} [filter.privateIpAddress] - Optional privateIpAddress to mactch on
+ * @param {string} [filter.publicIpAddress] - Optional publicIpAddress to mactch on
+ * @param {string} [filter.region] - Optional region to mactch on
+ * @param {string} [filter.userId] - Optional userId to mactch on
+ * @param {string} [filter.teamId] - Optional teamId to mactch on
+ * @param {string} [filter.scriptId] - Optional scriptId to mactch on
+ * @param {string} [filter.dtLastRun] - Optional script datatime last run value to match on
  * @param {function} cb - Node-style error-first callback function
  * @returns {array} [ machine, ... ] - JSON array of machine objects
  * @example

lib/networks/list.js

@@ -8,6 +8,15 @@ var assign = require('lodash.assign');
  * @method list
  * @description List information about all networks available to either the current
  * authenticated user or the team, if the user belongs to a team.
+ * The list method takes an optional first argument to limit the returned network objects.
+ * @param {object} [filter] - An optional filter object to limit the returned network objects
+ * @param {string} [filter.id] - Optional network id to match on
+ * @param {string} [filter.name] - Optional name to match on
+ * @param {string} [filter.region] - Optional region to match on
+ * @param {string} [filter.dtCreated] - Optional datatime created value to match on
+ * @param {string} [filter.network] - Optional network to mactch on
+ * @param {string} [filter.netmask] - Optional netmask to mactch on
+ * @param {string} [filter.teamId] - Optional teamId to mactch on
  * @param {function} cb - Node-style error-first callback function
  * @returns {array} [ network, ... ] - JSON array of network objects
  * @example

lib/scripts/list.js

@@ -8,6 +8,16 @@ var assign = require('lodash.assign');
  * @method list
  * @description List information about all scripts assigned to either the current
  * authenticated user or the team, if the user belongs to a team.
+ * The list method takes an optional first argument to limit the returned script objects.
+ * @param {object} [filter] - An optional filter object to limit the returned script objects
+ * @param {string} [filter.id] - Optional script id to match on
+ * @param {string} [filter.ownerType] - Optional ownerType to match on, either 'user' or 'team'
+ * @param {string} [filter.ownerId] - Optional ownerId to match on, either a userId or teamId
+ * @param {string} [filter.name] - Optional name to match on
+ * @param {string} [filter.description] - Optional description to mactch on
+ * @param {string} [filter.dtCreated] - Optional datatime created value to match on
+ * @param {boolean} [filter.isEnabled] - Optional isEnabled value to match on, either true or false
+ * @param {boolean} [filter.runOnce] - Optional runOnce value to match on, either true or false
  * @param {function} cb - Node-style error-first callback function
  * @returns {array} [ script, ... ] - JSON array of script objects
  * @example

lib/templates/list.js

@@ -8,6 +8,16 @@ var assign = require('lodash.assign');
  * @method list
  * @description List information about all templates available to either the current
  * authenticated user or the team, if the user belongs to a team.
+ * The list method takes an optional first argument to limit the returned template objects.
+ * @param {object} [filter] - An optional filter object to limit the returned template objects
+ * @param {string} [filter.id] - Optional template id to match on
+ * @param {string} [filter.name] - Optional name to match on
+ * @param {string} [filter.label] - Optional label to mactch on
+ * @param {string} [filter.os] - Optional os to match on
+ * @param {string} [filter.dtCreated] - Optional datatime created value to match on
+ * @param {string} [filter.teamId] - Optional teamId to match on
+ * @param {string} [filter.userId] - Optional userId to match on
+ * @param {string} [filter.region] - Optional region to match on
  * @param {function} cb - Node-style error-first callback function
  * @returns {array} [ template, ... ] - JSON array of template objects
  * @example

lib/users/list.js

@@ -8,6 +8,14 @@ var assign = require('lodash.assign');
  * @method list
  * @description List information about all users available to either the current
  * authenticated user or the team, if the user belongs to a team.
+ * The list method takes an optional first argument to limit the returned user objects.
+ * @param {object} [filter] - An optional filter object to limit the returned user objects
+ * @param {string} [filter.id] - Optional user id to match on
+ * @param {string} [filter.email] - Optional email to match on
+ * @param {string} [filter.firstname] - Optional firstname to mactch on
+ * @param {string} [filter.lastname] - Optional lastname to match on
+ * @param {string} [filter.dtCreated] - Optional datatime created value to match on
+ * @param {string} [filter.teamId] - Optional teamId to match on
  * @param {function} cb - Node-style error-first callback function
  * @returns {array} [ user, ... ] - JSON array of user objects
  * @example