update docs for dynamicPublicIp param on machines create and update

Author: sanfilip

lib/machines/create.js

@@ -29,7 +29,8 @@ var assign = require('lodash.assign');
  * @param {string} params.billingType - Either 'monthly' or 'hourly' billing
  * @param {string} params.machineName - A memorable name for this machine
  * @param {string} params.templateId - Template id of the template to use for creating this machine
- * @param {boolean} [params.assignPublicIp] - Assign a new public ip address on machine creation
+ * @param {boolean} [params.assignPublicIp] - Assign a new public ip address on machine creation. Cannot be used with dynamicPublicIp.
+ * @param {boolean} [params.dynamicPublicIp] - Assigns a new public ip address on machine start and releases it from the account on machine stop. Cannot be used with assignPublicIp.
  * @param {string} [params.networkId] - If creating on a specific network, specify its id
  * @param {string} [params.teamId] - If creating the machine for a team, specify the team id
  * @param {string} [params.userId] - If assigning to an existing user other than yourself, specify the user id (mutually exclusive with email, password, firstName, lastName)
@@ -111,9 +112,10 @@ var assign = require('lodash.assign');
  *   "publicIpAddress": "169.255.255.254",
  *   "region": null,
  *   "userId": "u123abc",
- *   "teamId": "te456def"
- *   "scriptId": "sc123abc"
- *   "dtLastRun": null
+ *   "teamId": "te456def",
+ *   "scriptId": "sc123abc",
+ *   "dtLastRun": null,
+ *   "dynamicPublicIp": null
  * }
  */
 

lib/machines/list.js

@@ -76,9 +76,10 @@ var assign = require('lodash.assign');
  *     "publicIpAddress": null,
  *     "region": "East Coast (NY2)",
  *     "userId": "u123abc",
- *     "teamId": "te456def"
- *     "scriptId": "sc123abc"
- *     "dtLastRun": "2017-06-30T07:22:49.763Z"
+ *     "teamId": "te456def",
+ *     "scriptId": "sc123abc",
+ *     "dtLastRun": "2017-06-30T07:22:49.763Z",
+ *     "dynamicPublicIp": null
  *   }
  * ]
  */

lib/machines/show.js

@@ -69,9 +69,10 @@ var assign = require('lodash.assign');
  *   "publicIpAddress": null,
  *   "region": "East Coast (NY2)",
  *   "userId": "u123abc",
- *   "teamId": "te456def"
- *   "scriptId": "sc123abc"
- *   "dtLastRun": "2017-06-30T07:22:49.763Z"
+ *   "teamId": "te456def",
+ *   "scriptId": "sc123abc",
+ *   "dtLastRun": "2017-06-30T07:22:49.763Z",
+ *   "dynamicPublicIp": null,
  *   "events": [
  *     {
  *       "name": "start",

lib/machines/update.js

@@ -15,6 +15,7 @@ var assign = require('lodash.assign');
  * @param {number} [params.autoSnapshotFrequency] - One of 'hour', 'day', 'week', or null
  * @param {number} [params.autoSnapshotSaveCount] - Number of snapshots to save
  * @param {boolean} [params.performAutoSnapshot] - Perform auto snapshots
+ * @param {boolean} [params.dynamicPublicIp] - If true, assigns a new public ip address on machine start and releases it from the account on machine stop
  * @param {function} cb - Node-style error-first callback function
  * @example
  * paperspace.machines.update({
@@ -35,11 +36,12 @@ var assign = require('lodash.assign');
  *     --shutdownTimeoutForces true \
  *     --performAutoSnapshot true \
  *     --autoSnapshotFrequency "week" \
- *     --autoSnapshotSaveCount 4
+ *     --autoSnapshotSaveCount 4 \
+ *     --dynamicPublicIp true
  * @example
  * # HTTP request:
  * https://api.paperspace.io
- * POST /machines/ps123abc/updateMachinePublic {"machineId": "ps123abc", "machineName": "New Machine Name", "shutdownTimeoutInHours": 24, "shutdownTimeoutForces": true, "performAutoSnapshot": true, "autoSnapshotFrequency": "week", "autoSnapshotSaveCount": 4}
+ * POST /machines/ps123abc/updateMachinePublic {"machineId": "ps123abc", "machineName": "New Machine Name", "shutdownTimeoutInHours": 24, "shutdownTimeoutForces": true, "performAutoSnapshot": true, "autoSnapshotFrequency": "week", "autoSnapshotSaveCount": 4, "dynamicPublicIp": true}
  * x-api-key: 1ba4f98e7c0...
  * # Returns 204 on success
  */

lib/machines/waitfor.js

@@ -60,9 +60,10 @@ var assign = require('lodash.assign');
  *   "publicIpAddress": null,
  *   "region": "East Coast (NY2)",
  *   "userId": "u123abc",
- *   "teamId": "te456def"
- *   "scriptId": "sc123abc"
- *   "dtLastRun": "2017-06-30T07:22:49.763Z"
+ *   "teamId": "te456def",
+ *   "scriptId": "sc123abc",
+ *   "dtLastRun": "2017-06-30T07:22:49.763Z",
+ *   "dynamicPublicIp": null
  * }
  */