Mark upsert and send_completion_email are optional

Also update description.
auth0 · Mar 6, 2020 · 057063f · 057063f
1 parent 6aaf3b9
commit 057063f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/src/management/JobsManager.js b/src/management/JobsManager.js
@@ -144,13 +144,13 @@ JobsManager.prototype.get = function(params, cb) {
  *   }
  * });
  *
- * @param   {Object}    data                        Users import data.
- * @param   {String}    data.connection_id          connection_id of the connection to which users will be imported.
- * @param   {String}    [data.users]                Path to the users data file. Either users or users_json is mandatory.
- * @param   {String}    [data.users_json]           JSON data for the users.
- * @param   {String}    data.upsert                 OPTIONAL: set to true to upsert users, defaults to false
- * @param   {String}    data.send_completion_email  OPTIONAL: defaults to true
- * @param   {Function}  [cb]                        Callback function.
+ * @param   {Object}    data                          Users import data.
+ * @param   {String}    data.connection_id            connection_id of the connection to which users will be imported.
+ * @param   {String}    [data.users]                  Path to the users data file. Either users or users_json is mandatory.
+ * @param   {String}    [data.users_json]             JSON data for the users.
+ * @param   {String}    [data.upsert]                 Whether to update users if they already exist (true) or to ignore them (false).
+ * @param   {String}    [data.send_completion_email]  Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ * @param   {Function}  [cb]                          Callback function.
  *
  * @return  {Promise|undefined}
  */

diff --git a/src/management/index.js b/src/management/index.js
@@ -2033,13 +2033,13 @@ utils.wrapPropertyMethod(ManagementClient, 'getJob', 'jobs.get');
  *   }
  * });
  *
- * @param   {Object}    data                        Users import data.
- * @param   {String}    data.connection_id          connection_id of the connection to which users will be imported.
- * @param   {String}    [data.users]                Path to the users data file. Either users or users_json is mandatory.
- * @param   {String}    [data.users_json]           JSON data for the users.
- * @param   {String}    data.upsert                 OPTIONAL: set to true to upsert users, defaults to false
- * @param   {String}    data.send_completion_email  OPTIONAL: defaults to true
- * @param   {Function}  [cb]                        Callback function.
+ * @param   {Object}    data                          Users import data.
+ * @param   {String}    data.connection_id            connection_id of the connection to which users will be imported.
+ * @param   {String}    [data.users]                  Path to the users data file. Either users or users_json is mandatory.
+ * @param   {String}    [data.users_json]             JSON data for the users.
+ * @param   {String}    [data.upsert]                 Whether to update users if they already exist (true) or to ignore them (false).
+ * @param   {String}    [data.send_completion_email]  Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ * @param   {Function}  [cb]                          Callback function.
  *
  * @return  {Promise|undefined}
  */