auth0 2.37.0 → 2.38.0

package/src/management/StatsManager.js

@@ -1,123 +1,107 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var Auth0RestClient = require('../Auth0RestClient');
-var RetryRestClient = require('../RetryRestClient');
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
 
 /**
- * Simple facade for consuming a REST API endpoint.
- * @external RestClient
- * @see https://github.com/ngonzalvez/rest-facade
- */
-
-/**
- * @class
  * Abstracts interaction with the stats endpoint.
- * @constructor
- * @memberOf module:management
- *
- * @param {Object} options            The client options.
- * @param {String} options.baseUrl    The URL of the API.
- * @param {Object} [options.headers]  Headers to be included in all requests.
- * @param {Object} [options.retry]    Retry Policy Config
  */
-var StatsManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide manager options');
-  }
+class StatsManager {
+  /**
+   * @param {object} options            The client options.
+   * @param {string} options.baseUrl    The URL of the API.
+   * @param {object} [options.headers]  Headers to be included in all requests.
+   * @param {object} [options.retry]    Retry Policy Config
+   */
+  constructor(options) {
+    if (options === null || typeof options !== 'object') {
+      throw new ArgumentError('Must provide manager options');
+    }
 
-  if (options.baseUrl === null || options.baseUrl === undefined) {
-    throw new ArgumentError('Must provide a base URL for the API');
-  }
+    if (options.baseUrl === null || options.baseUrl === undefined) {
+      throw new ArgumentError('Must provide a base URL for the API');
+    }
 
-  if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-    throw new ArgumentError('The provided base URL is invalid');
-  }
+    if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+      throw new ArgumentError('The provided base URL is invalid');
+    }
 
-  var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' },
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    /**
+     * Provides an abstraction layer for consuming the
+     * {@link https://auth0.com/docs/api/v2#!/Stats Stats endpoint}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/stats/:type`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+  }
 
   /**
-   * Provides an abstraction layer for consuming the
-   * {@link https://auth0.com/docs/api/v2#!/Stats Stats endpoint}.
+   * Get the daily stats.
+   *
+   * @example
+   * var params = {
+   *   from: '{YYYYMMDD}',  // First day included in the stats.
+   *   to: '{YYYYMMDD}'  // Last day included in the stats.
+   * };
    *
-   * @type {external:RestClient}
+   * management.stats.getDaily(params, function (err, stats) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(stats);
+   * });
+   * @param   {object}    params        Stats parameters.
+   * @param   {string}    params.from   The first day in YYYYMMDD format.
+   * @param   {string}    params.to     The last day in YYYYMMDD format.
+   * @param   {Function}  [cb]          Callback function.
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/stats/:type',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
+  getDaily(params, cb) {
+    params = params || {};
+    params.type = 'daily';
 
-/**
- * Get the daily stats.
- *
- * @method    getDaily
- * @memberOf  module:management.StatsManager.prototype
- *
- * @example
- * var params = {
- *   from: '{YYYYMMDD}',  // First day included in the stats.
- *   to: '{YYYYMMDD}'  // Last day included in the stats.
- * };
- *
- * management.stats.getDaily(params, function (err, stats) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(stats);
- * });
- *
- * @param   {Object}    params        Stats parameters.
- * @param   {String}    params.from   The first day in YYYYMMDD format.
- * @param   {String}    params.to     The last day in YYYYMMDD format.
- * @param   {Function}  [cb]          Callback function.
- *
- * @return  {Promise|undefined}
- */
-StatsManager.prototype.getDaily = function(params, cb) {
-  params = params || {};
-  params.type = 'daily';
+    if (cb && cb instanceof Function) {
+      return this.resource.get(params, cb);
+    }
 
-  if (cb && cb instanceof Function) {
-    return this.resource.get(params, cb);
+    return this.resource.get(params);
   }
 
-  return this.resource.get(params);
-};
+  /**
+   * Get a the active users count.
+   *
+   * @example
+   * management.stats.getActiveUsersCount(function (err, usersCount) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(usersCount);
+   * });
+   * @param   {Function}  [cb]  Callback function.
+   * @returns  {Promise|undefined}
+   */
+  getActiveUsersCount(cb) {
+    const options = { type: 'active-users' };
 
-/**
- * Get a the active users count.
- *
- * @method    getActiveUsersCount
- * @memberOf  module:management.StatsManager.prototype
- *
- * @example
- * management.stats.getActiveUsersCount(function (err, usersCount) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(usersCount);
- * });
- *
- * @param   {Function}  [cb]  Callback function.
- *
- * @return  {Promise|undefined}
- */
-StatsManager.prototype.getActiveUsersCount = function(cb) {
-  var options = { type: 'active-users' };
+    if (cb && cb instanceof Function) {
+      return this.resource.get(options, cb);
+    }
 
-  if (cb && cb instanceof Function) {
-    return this.resource.get(options, cb);
+    // Return a promise.
+    return this.resource.get(options);
   }
-
-  // Return a promise.
-  return this.resource.get(options);
-};
+}
 
 module.exports = StatsManager;

package/src/management/TenantManager.js

@@ -1,115 +1,99 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var Auth0RestClient = require('../Auth0RestClient');
-var RetryRestClient = require('../RetryRestClient');
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
 
 /**
- * Simple facade for consuming a REST API endpoint.
- * @external RestClient
- * @see https://github.com/ngonzalvez/rest-facade
- */
-
-/**
- * @class
  * Abstracts interaction with the tenant endpoint.
- * @constructor
- * @memberOf module:management
- *
- * @param {Object} options            The client options.
- * @param {String} options.baseUrl    The URL of the API.
- * @param {Object} [options.headers]  Headers to be included in all requests.
- * @param {Object} [options.retry]    Retry Policy Config
  */
-var TenantManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide manager options');
-  }
+class TenantManager {
+  /**
+   * @param {object} options            The client options.
+   * @param {string} options.baseUrl    The URL of the API.
+   * @param {object} [options.headers]  Headers to be included in all requests.
+   * @param {object} [options.retry]    Retry Policy Config
+   */
+  constructor(options) {
+    if (options === null || typeof options !== 'object') {
+      throw new ArgumentError('Must provide manager options');
+    }
 
-  if (options.baseUrl === null || options.baseUrl === undefined) {
-    throw new ArgumentError('Must provide a base URL for the API');
-  }
+    if (options.baseUrl === null || options.baseUrl === undefined) {
+      throw new ArgumentError('Must provide a base URL for the API');
+    }
 
-  if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-    throw new ArgumentError('The provided base URL is invalid');
-  }
+    if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+      throw new ArgumentError('The provided base URL is invalid');
+    }
 
-  var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' },
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    /**
+     * Provides an abstraction layer for consuming the
+     * {@link https://auth0.com/docs/api/v2#!/Stats Stats endpoint}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/tenants/settings`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+  }
 
   /**
-   * Provides an abstraction layer for consuming the
-   * {@link https://auth0.com/docs/api/v2#!/Stats Stats endpoint}.
+   * Update the tenant settings.
    *
-   * @type {external:RestClient}
+   * @example
+   * management.tenant.updateSettings(data, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   * });
+   * @param   {object}    data  The new tenant settings.
+   * @param   {Function}  [cb]  Callback function.
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/tenants/settings',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
+  updateSettings(data, cb) {
+    if (cb && cb instanceof Function) {
+      return this.resource.patch({}, data, cb);
+    }
 
-/**
- * Update the tenant settings.
- *
- * @method    updateSettings
- * @memberOf  module:management.TenantManager.prototype
- *
- * @example
- * management.tenant.updateSettings(data, function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- * });
- *
- * @param   {Object}    data  The new tenant settings.
- * @param   {Function}  [cb]  Callback function.
- *
- * @return  {Promise|undefined}
- */
-TenantManager.prototype.updateSettings = function(data, cb) {
-  if (cb && cb instanceof Function) {
-    return this.resource.patch({}, data, cb);
+    // Return a promise.
+    return this.resource.patch({}, data);
   }
 
-  // Return a promise.
-  return this.resource.patch({}, data);
-};
+  /**
+   * Get the tenant settings..
+   *
+   * @example
+   * management.tenant.getSettings({ include_fields: true, fields: 'friendly_name' }, function (err, settings) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(settings);
+   * });
+   * @param   {object}    [data]  Request parameters
+   * @param   {Function}  [cb]    Callback function.
+   * @returns  {Promise|undefined}
+   */
+  getSettings(data, cb) {
+    if (data instanceof Function && !cb) {
+      cb = data;
+      data = {};
+    }
+    if (cb && cb instanceof Function) {
+      return this.resource.get(data, cb);
+    }
 
-/**
- * Get the tenant settings..
- *
- * @method    getSettings
- * @memberOf  module:management.TenantManager.prototype
- *
- * @example
- * management.tenant.getSettings({ include_fields: true, fields: 'friendly_name' }, function (err, settings) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(settings);
- * });
- *
- * @param   {Object}    [data]  Request parameters
- * @param   {Function}  [cb]    Callback function.
- *
- * @return  {Promise|undefined}
- */
-TenantManager.prototype.getSettings = function(data, cb) {
-  if (data instanceof Function && !cb) {
-    cb = data;
-    data = {};
+    // Return a promise.
+    return this.resource.get(data);
   }
-  if (cb && cb instanceof Function) {
-    return this.resource.get(data, cb);
-  }
-
-  // Return a promise.
-  return this.resource.get(data);
-};
+}
 
 module.exports = TenantManager;

package/src/management/TicketsManager.js

@@ -1,135 +1,127 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var Auth0RestClient = require('../Auth0RestClient');
-var RetryRestClient = require('../RetryRestClient');
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
 
 /**
- * @class
  * Abstracts interaction with the tickets endpoint.
- * @constructor
- * @memberOf module:management
- *
- * @param {Object} options            The client options.
- * @param {String} options.baseUrl    The URL of the API.
- * @param {Object} [options.headers]  Headers to be included in all requests.
- * @param {Object} [options.retry]    Retry Policy Config
  */
-var TicketsManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide manager options');
-  }
+class TicketsManager {
+  /**
+   * @param {object} options            The client options.
+   * @param {string} options.baseUrl    The URL of the API.
+   * @param {object} [options.headers]  Headers to be included in all requests.
+   * @param {object} [options.retry]    Retry Policy Config
+   */
+  constructor(options) {
+    if (options === null || typeof options !== 'object') {
+      throw new ArgumentError('Must provide manager options');
+    }
 
-  if (options.baseUrl === null || options.baseUrl === undefined) {
-    throw new ArgumentError('Must provide a base URL for the API');
-  }
+    if (options.baseUrl === null || options.baseUrl === undefined) {
+      throw new ArgumentError('Must provide a base URL for the API');
+    }
 
-  if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-    throw new ArgumentError('The provided base URL is invalid');
-  }
+    if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+      throw new ArgumentError('The provided base URL is invalid');
+    }
 
-  var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' },
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    /**
+     * Provides an abstraction layer for consuming the
+     * {@link https://auth0.com/docs/api/v2#!/Tickets Tickets endpoint}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/tickets/:type`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+  }
 
   /**
-   * Provides an abstraction layer for consuming the
-   * {@link https://auth0.com/docs/api/v2#!/Tickets Tickets endpoint}.
+   * Create a new password change ticket.
    *
-   * @type {external:RestClient}
+   * @example
+   * var params = {
+   *   result_url: '{REDIRECT_URL}',  // Redirect after using the ticket.
+   *   user_id: '{USER_ID}',  // Optional.
+   *   email: '{USER_EMAIL}',  // Optional.
+   *   new_password: '{PASSWORD}'
+   * };
+   *
+   * management.tickets.changePassword(params, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   * });
+   * @param   {object}  data
+   * @param   {string}  [data.result_url] URL the user will be redirected to once ticket is used.
+   * @param   {string}  [data.user_id] user_id for whom the ticket should be created. (Conflicts with: connection_id, email)
+   * @param   {string}  [data.client_id] ID of the client.
+   * @param   {string}  [data.organization_id] ID of the organization.
+   * @param   {string}  [data.connection_id] ID of the connection.
+   * @param   {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration.
+   * @param   {string}  [data.email] Email of the user. (Requires: connection_id)
+   * @param   {boolean} [data.mark_email_as_verified] Whether to set the email_verified attribute to true (true) or whether it should not be updated (false).
+   * @param   {boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false).
+   * @param   {Function}  [cb]  Callback function.
+   * @returns  {Promise}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/tickets/:type',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
+  changePassword(data, cb) {
+    const params = { type: 'password-change' };
 
-/**
- * Create a new password change ticket.
- *
- * @method    changePassword
- * @memberOf  module:management.TicketsManager.prototype
- *
- * @example
- * var params = {
- *   result_url: '{REDIRECT_URL}',  // Redirect after using the ticket.
- *   user_id: '{USER_ID}',  // Optional.
- *   email: '{USER_EMAIL}',  // Optional.
- *   new_password: '{PASSWORD}'
- * };
- *
- * management.tickets.changePassword(params, function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- * });
- *
- * @param   {Object}  data
- * @param   {String}  [data.result_url] URL the user will be redirected to once ticket is used.
- * @param   {String}  [data.user_id] user_id for whom the ticket should be created. (Conflicts with: connection_id, email)
- * @param   {String}  [data.client_id] ID of the client.
- * @param   {String}  [data.organization_id] ID of the organization.
- * @param   {String}  [data.connection_id] ID of the connection.
- * @param   {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration.
- * @param   {String}  [data.email] Email of the user. (Requires: connection_id)
- * @param   {Boolean} [data.mark_email_as_verified] Whether to set the email_verified attribute to true (true) or whether it should not be updated (false).
- * @param   {Boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false).
- * @param   {Function}  [cb]  Callback function.
- * @return  {Promise}
- */
-TicketsManager.prototype.changePassword = function(data, cb) {
-  var params = { type: 'password-change' };
+    if (cb && cb instanceof Function) {
+      return this.resource.create(params, data, cb);
+    }
 
-  if (cb && cb instanceof Function) {
-    return this.resource.create(params, data, cb);
+    // Return a promise.
+    return this.resource.create(params, data);
   }
 
-  // Return a promise.
-  return this.resource.create(params, data);
-};
+  /**
+   * Create an email verification ticket.
+   *
+   * @example
+   * var data = {
+   *   user_id: '{USER_ID}',
+   *   result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+   * };
+   *
+   * management.tickets.verifyEmail(data, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   * });
+   * @param   {object}  data
+   * @param   {string}  [data.result_url] URL the user will be redirected to once ticket is used.
+   * @param   {string}  data.user_id user_id for whom the ticket should be created.
+   * @param   {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration.
+   * @param   {boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the result_url (true), or not (false).
+   * @param   {object}  [data.identity] Used to verify secondary, federated, and passwordless-email identities.
+   * @param   {string}  data.identity.user_id user_id of the identity.
+   * @param   {string}  data.identity.provider provider of the identity.
+   * @param   {string}  [data.client_id] client ID.
+   * @param   {string}  [data.organization_id] organization ID.
+   * @param   {Function}  [cb]  Callback function.
+   * @returns  {Promise}
+   */
+  verifyEmail(data, cb) {
+    const params = { type: 'email-verification' };
 
-/**
- * Create an email verification ticket.
- *
- * @method    verifyEmail
- * @memberOf  module:management.TicketsManager.prototype
- *
- * @example
- * var data = {
- *   user_id: '{USER_ID}',
- *   result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
- * };
- *
- * management.tickets.verifyEmail(data, function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- * });
- *
- * @param   {Object}  data
- * @param   {String}  [data.result_url] URL the user will be redirected to once ticket is used.
- * @param   {String}  data.user_id user_id for whom the ticket should be created.
- * @param   {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration.
- * @param   {Boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the result_url (true), or not (false).
- * @param   {Object}  [data.identity] Used to verify secondary, federated, and passwordless-email identities.
- * @param   {String}  data.identity.user_id user_id of the identity.
- * @param   {String}  data.identity.provider provider of the identity.
- * @param   {String}  [data.client_id] client ID.
- * @param   {String}  [data.organization_id] organization ID.
- * @param   {Function}  [cb]  Callback function.
- * @return  {Promise}
- */
-TicketsManager.prototype.verifyEmail = function(data, cb) {
-  var params = { type: 'email-verification' };
+    if (cb && cb instanceof Function) {
+      return this.resource.create(params, data, cb);
+    }
 
-  if (cb && cb instanceof Function) {
-    return this.resource.create(params, data, cb);
+    // Return a promise.
+    return this.resource.create(params, data);
   }
-
-  // Return a promise.
-  return this.resource.create(params, data);
-};
+}
 
 module.exports = TicketsManager;