auth0 3.3.0 → 4.0.0-beta.0

package/src/management/RulesConfigsManager.js

@@ -1,86 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * The rules configs manager class provides a simple abstraction for performing CRUD operations
- * on Auth0 RulesConfigsManager.
- */
-class RulesConfigsManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for performing CRUD operations on
-     * {@link https://auth0.com/docs/api/v2#!/RulesConfigsManager Auth0 RulesConfigsManager}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/rules-configs/:key');
-  }
-
-  /**
-   * Set a new rules config.
-   *
-   * @example
-   * var params = { key: RULE_CONFIG_KEY };
-   * var data =   { value: RULES_CONFIG_VALUE };
-   *
-   * management.rulesConfigs.set(params, data, function (err, rulesConfig) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Rules Config set.
-   * });
-   * @param   {object}    params        Rule Config parameters.
-   * @param   {string}    params.key    Rule Config key.
-   * @param   {object}    data          Rule Config Data parameters.
-   * @param   {string}    data.value    Rule Config Data value.
-   * @param   {Function}  [cb]    Callback function.
-   * @returns  {Promise|undefined}
-   */
-  set(...args) {
-    return this.resource.update(...args);
-  }
-
-  /**
-   * Get all rules configs.
-   *
-   * @example
-   * management.rulesConfigs.getAll(function (err, rulesConfig) {
-   *   console.log(rulesConfig.length);
-   * });
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Delete an existing rules config.
-   *
-   * @example
-   * management.rulesConfigs.delete({ key: RULE_CONFIG_KEY }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Rules Config deleted.
-   * });
-   * @param   {object}    params        Rule Configs parameters.
-   * @param   {string}    params.key    Rule Configs key.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = RulesConfigsManager;

package/src/management/RulesManager.js

@@ -1,148 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * The rule class provides a simple abstraction for performing CRUD operations
- * on Auth0 RulesManagers.
- */
-class RulesManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for performing CRUD operations on
-     * {@link https://auth0.com/docs/api/v2#!/RulesManagers Auth0 RulesManagers}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/rules/:id');
-  }
-
-  /**
-   * Create a new rule.
-   *
-   * @example
-   * management.rules.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Rule created.
-   * });
-   * @param   {object}    data     Rule data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all rules.
-   *
-   * @example <caption>
-   *   This method takes an optional object as first argument that may be used to
-   *   specify pagination settings. If pagination options are not present,
-   *   the first page of a limited number of results will be returned.
-   * </caption>
-   *
-   * // Pagination settings.
-   * var params = {
-   *   per_page: 10,
-   *   page: 0
-   * };
-   *
-   * management.rules.getAll(params, function (err, rules) {
-   *   console.log(rules.length);
-   * });
-   * @param   {object}    [params]          Rules parameters.
-   * @param   {number}    [params.per_page] Number of results per page.
-   * @param   {number}    [params.page]     Page number, zero indexed.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Get an Auth0 rule.
-   *
-   * @example
-   * management.rules.get({ id: RULE_ID }, function (err, rule) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(rule);
-   * });
-   * @param   {object}    params        Rule parameters.
-   * @param   {string}    params.id     Rule ID.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Update an existing rule.
-   *
-   * @example
-   * var data = { name: 'New name' };
-   * var params = { id: RULE_ID };
-   *
-   * // Using auth0 instance.
-   * management.updateRule(params, data, function (err, rule) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(rule.name);  // 'New name'
-   * });
-   *
-   * // Using the rules manager directly.
-   * management.rules.update(params, data, function (err, rule) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(rule.name);  // 'New name'
-   * });
-   * @param   {object}    params        Rule parameters.
-   * @param   {string}    params.id     Rule ID.
-   * @param   {object}    data          Updated rule data.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  update(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Delete an existing rule.
-   *
-   * @example
-   * management.rules.delete({ id: RULE_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Rule deleted.
-   * });
-   * @param   {object}    params        Rule parameters.
-   * @param   {string}    params.id     Rule ID.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = RulesManager;

package/src/management/StatsManager.js

@@ -1,84 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Abstracts interaction with the stats endpoint.
- */
-class StatsManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/v2#!/Stats Stats endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/stats/:type');
-  }
-
-  /**
-   * Get the daily stats.
-   *
-   * @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.
-   * @returns  {Promise|undefined}
-   */
-  getDaily(params, cb) {
-    params = params || {};
-    params.type = 'daily';
-
-    if (cb && cb instanceof Function) {
-      return this.resource.get(params, cb);
-    }
-
-    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' };
-
-    if (cb && cb instanceof Function) {
-      return this.resource.get(options, cb);
-    }
-
-    // Return a promise.
-    return this.resource.get(options);
-  }
-}
-
-module.exports = StatsManager;

package/src/management/TenantManager.js

@@ -1,76 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Abstracts interaction with the tenant endpoint.
- */
-class TenantManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/v2#!/Stats Stats endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/tenants/settings');
-  }
-
-  /**
-   * Update the tenant settings.
-   *
-   * @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}
-   */
-  updateSettings(data, cb) {
-    if (cb && cb instanceof Function) {
-      return this.resource.patch({}, data, cb);
-    }
-
-    // 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);
-    }
-
-    // Return a promise.
-    return this.resource.get(data);
-  }
-}
-
-module.exports = TenantManager;

package/src/management/TicketsManager.js

@@ -1,104 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Abstracts interaction with the tickets endpoint.
- */
-class TicketsManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/v2#!/Tickets Tickets endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/tickets/:type');
-  }
-
-  /**
-   * Create a new password change ticket.
-   *
-   * @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}
-   */
-  changePassword(data, cb) {
-    const params = { type: 'password-change' };
-
-    if (cb && cb instanceof Function) {
-      return this.resource.create(params, data, cb);
-    }
-
-    // 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' };
-
-    if (cb && cb instanceof Function) {
-      return this.resource.create(params, data, cb);
-    }
-
-    // Return a promise.
-    return this.resource.create(params, data);
-  }
-}
-
-module.exports = TicketsManager;

package/src/management/UserBlocksManager.js

@@ -1,121 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const BaseManager = require('./BaseManager');
-
-/**
- * Abstracts interaction with the user-blocks endpoint.
- */
-class UserBlocksManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    this.userBlocksById = this._getRestClient('/user-blocks/:id');
-
-    this.userBlocksByIdentifier = this._getRestClient('/user-blocks');
-  }
-
-  /**
-   * Get user blocks by id.
-   *
-   * @example
-   * management.userBlocks.get({ id: USER_ID }, function (err, blocks) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(blocks);
-   * });
-   * @param   {object}    params      The user data object..
-   * @param   {string}    params.id   The user id.
-   * @param   {Function}  [cb]        Callback function
-   * @returns  {Promise|undefined}
-   */
-  get(params, ...restOfArgs) {
-    if (typeof params !== 'object' || typeof params.id !== 'string') {
-      throw new ArgumentError('You must provide an user id for the get method');
-    }
-
-    return this.userBlocksById.get(params, ...restOfArgs);
-  }
-
-  /**
-   * Unblock an user by its id.
-   *
-   * @example
-   * management.userBlocks.delete({ id: USER_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // User unblocked.
-   * });
-   * @param   {object}    params      The user data object..
-   * @param   {string}    params.id   The user id.
-   * @param   {Function}  [cb]        Callback function
-   * @returns  {Promise|undefined}
-   */
-  delete(params, ...restOfArgs) {
-    if (typeof params !== 'object' || typeof params.id !== 'string') {
-      throw new ArgumentError('You must provide an user id for the delete method');
-    }
-
-    return this.userBlocksById.delete(params, ...restOfArgs);
-  }
-
-  /**
-   * Get user blocks by identifier.
-   *
-   * @example
-   * management.userBlocks.getByIdentifier({ identifier: USER_ID }, function (err, blocks) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(blocks);
-   * });
-   * @param   {object}    params              The user data object..
-   * @param   {string}    params.identifier   The user identifier, any of: username, phone_number, email.
-   * @param   {Function}  [cb]                Callback function
-   * @returns  {Promise|undefined}
-   */
-  getByIdentifier(params, ...restOfArgs) {
-    if (typeof params !== 'object' || typeof params.identifier !== 'string') {
-      throw new ArgumentError('You must provide an user identifier for the getByIdentifier method');
-    }
-
-    return this.userBlocksByIdentifier.get(params, ...restOfArgs);
-  }
-
-  /**
-   * Unblock an user by identifier.
-   *
-   * @example
-   * management.userBlocks.deleteByIdentifier({ identifier: USER_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // User unblocked.
-   * });
-   * @param   {object}    params              The user data object..
-   * @param   {string}    params.identifier   The user identifier, any of: username, phone_number, email.
-   * @param   {Function}  [cb]                Callback function
-   * @returns  {Promise|undefined}
-   */
-  deleteByIdentifier(params, ...restOfArgs) {
-    if (typeof params !== 'object' || typeof params.identifier !== 'string') {
-      throw new ArgumentError(
-        'You must provide an user identifier for the deleteByIdentifier method'
-      );
-    }
-
-    return this.userBlocksByIdentifier.delete(params, ...restOfArgs);
-  }
-}
-
-module.exports = UserBlocksManager;