auth0 3.4.0 → 4.0.0-beta.0

package/src/management/PromptsManager.js

@@ -1,162 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const BaseManager = require('./BaseManager');
-
-/**
- * Manages settings related to prompts.
- */
-class PromptsManager 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/management/v2#!/Prompts Prompts endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/prompts');
-
-    /**
-     * Retrieve custom text for a specific prompt and language.
-     * {@link https://auth0.com/docs/api/management/v2#!/Prompts/get_custom_text_by_language Custom Text endpoint}
-     *
-     *
-     * @type {external:RestClient}
-     */
-    this.customTextByLanguage = this._getRestClient('/prompts/:prompt/custom-text/:language');
-  }
-
-  /**
-   * Update the prompts settings.
-   *
-   * @example
-   * management.prompts.updateSettings(params, data, function (err, prompts) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   * // Updated prompts
-   *    console.log(prompts);
-   * });
-   * @param   {object}    params            Prompts parameters.
-   * @param   {object}    data              Updated prompts data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  updateSettings(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Get the prompts settings..
-   *
-   * @example
-   * management.prompts.getSettings(data, function (err, prompts) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   * // Prompts
-   *    console.log(prompts);
-   * });
-   * @param   {object}    params            Prompts parameters.
-   * @param   {object}    data              Prompts data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  getSettings(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Retrieve custom text for a specific prompt and language.
-   *
-   * @example
-   * var params = { prompt: PROMPT_NAME, language: LANGUAGE };
-   *
-   * management.prompts.getCustomTextByLanguage(params, function (err, customText) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log('CustomText', customText);
-   * });
-   * @param   {object}    params            Data object.
-   * @param   {string}    params.prompt     Name of the prompt.
-   * @param   {string}    params.language   Language to retrieve.
-   * @param   {Function}  [cb]              Callback function
-   * @returns  {Promise|undefined}
-   */
-  getCustomTextByLanguage(params, cb) {
-    params = params || {};
-
-    if (!params.prompt || typeof params.prompt !== 'string') {
-      throw new ArgumentError('The prompt parameter must be a string');
-    }
-
-    if (!params.language || typeof params.language !== 'string') {
-      throw new ArgumentError('The language parameter must be a string');
-    }
-
-    if (cb && cb instanceof Function) {
-      return this.customTextByLanguage.get(params, cb);
-    }
-
-    return this.customTextByLanguage.get(params);
-  }
-
-  /**
-   * Set custom text for a specific prompt.
-   *
-   * @example
-   * var params = { prompt: PROMPT_NAME, language: LANGUAGE, body: BODY_OBJECT };
-   *
-   * management.prompts.updateCustomTextByLanguage(params, function (err, customText) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log('CustomText', customText);
-   * });
-   * @param   {object}    params            Data object.
-   * @param   {string}    params.prompt     Name of the prompt.
-   * @param   {string}    params.language   Language to retrieve.
-   * @param   {object}    params.body       An object containing custom dictionaries for a group of screens.
-   * @param   {Function}  [cb]              Callback function
-   * @returns  {Promise|undefined}
-   */
-  updateCustomTextByLanguage(params, cb) {
-    params = params || {};
-
-    if (!params.prompt || typeof params.prompt !== 'string') {
-      throw new ArgumentError('The prompt parameter must be a string');
-    }
-
-    if (!params.language || typeof params.language !== 'string') {
-      throw new ArgumentError('The language parameter must be a string');
-    }
-
-    if (!params.body || typeof params.body !== 'object') {
-      throw new ArgumentError('The body parameter must be an object');
-    }
-
-    const options = {
-      prompt: params.prompt,
-      language: params.language,
-    };
-
-    if (cb && cb instanceof Function) {
-      return this.customTextByLanguage.update(options, params.body, cb);
-    }
-
-    return this.customTextByLanguage.update(options, params.body);
-  }
-}
-
-module.exports = PromptsManager;

package/src/management/ResourceServersManager.js

@@ -1,143 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Auth0 Resource Servers Manager.
- *
- * {@link https://auth0.com/docs/api/management/v2#!/Resource_Servers Resource Servers} represents
- * your APIs.
- * You can learn more about this in the
- * {@link https://auth0.com/docs/api-auth API Authorization} section of the
- * documentation.
- */
-class ResourceServersManager 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#!/ResourceServers Auth0 Resource Servers endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/resource-servers/:id');
-  }
-
-  /**
-   * Create an API (Resource Server).
-   *
-   * @example
-   * management.resourceServers.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Resource Server created.
-   * });
-   * @param   {object}    data     Resource Server data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all resource servers.
-   *
-   * @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.resourceServers.getAll(params, function (err, resourceServers) {
-   *   console.log(resourceServers.length);
-   * });
-   * @param   {object}    [params]          Resource Servers 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 a Resource Server.
-   *
-   * @example
-   * management.resourceServers.get({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(resourceServer);
-   * });
-   * @param   {object}    params            Resource Server parameters.
-   * @param   {string}    params.id         Resource Server ID.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Update an existing resource server.
-   *
-   * @example
-   * var data = { name: 'newResourceServerName' };
-   * var params = { id: RESOURCE_SERVER_ID };
-   *
-   * management.resourceServers.update(params, data, function (err, resourceServer) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(resourceServer.name);  // 'newResourceServernName'
-   * });
-   * @param   {object}    params            Resource Server parameters.
-   * @param   {string}    params.id         Resource Server ID.
-   * @param   {object}    data              Updated Resource Server data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  update(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Delete an existing Resource Server.
-   *
-   * @example
-   * management.resourceServers.delete({ id: RESOURCE_SERVER_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Resource Server deleted.
-   * });
-   * @param   {object}    params            Resource Server parameters.
-   * @param   {string}    params.id         Resource Server ID.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = ResourceServersManager;

package/src/management/RolesManager.js

@@ -1,329 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const BaseManager = require('./BaseManager');
-
-/**
- * The role class provides a simple abstraction for performing CRUD operations
- * on Auth0 RolesManager.
- */
-class RolesManager 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#!/RolesManager Auth0 RolesManagers}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/roles/:id');
-
-    this.permissions = this._getRestClient('/roles/:id/permissions');
-
-    this.users = this._getRestClient('/roles/:id/users');
-  }
-
-  /**
-   * Create a new role.
-   *
-   * @example
-   * management.roles.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Role created.
-   * });
-   * @param   {object}    data     Role data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all roles.
-   *
-   * @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.roles.getAll(params, function (err, roles) {
-   *   console.log(roles.length);
-   * });
-   * @param   {object}    [params]          Roles 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 role.
-   *
-   * @example
-   * management.roles.get({ id: ROLE_ID }, function (err, role) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(role);
-   * });
-   * @param   {object}    params        Role parameters.
-   * @param   {string}    params.id     Role ID.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Update an existing role.
-   *
-   * @example
-   * var data = { name: 'New name' };
-   * var params = { id: ROLE_ID };
-   *
-   * // Using auth0 instance.
-   * management.updateRole(params, data, function (err, role) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(role.name);  // 'New name'
-   * });
-   *
-   * // Using the roles manager directly.
-   * management.roles.update(params, data, function (err, role) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(role.name);  // 'New name'
-   * });
-   * @param   {object}    params        Role parameters.
-   * @param   {string}    params.id     Role ID.
-   * @param   {object}    data          Updated role data.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  update(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Delete an existing role.
-   *
-   * @example
-   * management.roles.delete({ id: ROLE_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Role deleted.
-   * });
-   * @param   {object}    params        Role parameters.
-   * @param   {string}    params.id     Role ID.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-
-  /**
-   * Get Permissions in a Role
-   *
-   * @param params
-   * @param callback
-   * @example
-   * var params = {id : 'ROLE_ID'}
-   * @example <caption>
-   *   This method takes a first argument as the roleId and returns the permissions within that role
-   * </caption>
-   *
-   * management.roles.getPermissions( {id : 'ROLE_ID'}, function (err, permissions) {
-   *   console.log(permissions);
-   * });
-   * @param   {string}    [email]           Email address of user(s) to find
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getPermissions(params, callback) {
-    return this.permissions.getAll(params, callback);
-  }
-
-  /**
-   * Add permissions in a role
-   *
-   * @example
-   * var params =  { id :'ROLE_ID'};
-   * var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-   *
-   * management.roles.addPermissions(params, data, function (err, user) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // permissions added.
-   * });
-   * @param   {string}    params.id                ID of the Role.
-   * @param   {object}    data                permissions data
-   * @param   {string}    data.permissions    Array of permissions
-   * @param   {string}    data.permissions.permission_name  Name of a permission
-   * @param   {string}    data.permissions.resource_server_identifier  Identifier for a resource
-   * @param   {Function}  [cb]                  Callback function.
-   * @returns  {Promise|undefined}
-   */
-
-  addPermissions(params, data, cb) {
-    data = data || {};
-    params = params || {};
-
-    // Require a user ID.
-    if (!params.id) {
-      throw new ArgumentError('The roleId passed in params cannot be null or undefined');
-    }
-    if (typeof params.id !== 'string') {
-      throw new ArgumentError('The role Id has to be a string');
-    }
-
-    if (cb && cb instanceof Function) {
-      return this.permissions.create(params, data, cb);
-    }
-
-    return this.permissions.create(params, data);
-  }
-
-  /**
-   * Remove permissions from a role
-   *
-   * @example
-   * var params =  { id :'ROLE_ID'};
-   * var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-   *
-   * management.roles.removePermissions(params, data, function (err, user) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // permissions added.
-   * });
-   * @param   {string}    params.id                ID of the Role.
-   * @param   {object}    data                permissions data
-   * @param   {string}    data.permissions    Array of permissions
-   * @param   {string}    data.permissions.permission_name  Name of a permission
-   * @param   {string}    data.permissions.resource_server_identifier  Identifier for a resource
-   * @param   {Function}  [cb]                  Callback function.
-   * @returns  {Promise|undefined}
-   */
-
-  removePermissions(params, data, cb) {
-    data = data || {};
-    params = params || {};
-
-    // Require a user ID.
-    if (!params.id) {
-      throw new ArgumentError('The roleId passed in params cannot be null or undefined');
-    }
-    if (typeof params.id !== 'string') {
-      throw new ArgumentError('The role Id has to be a string');
-    }
-
-    if (cb && cb instanceof Function) {
-      return this.permissions.delete(params, data, cb);
-    }
-
-    return this.permissions.delete(params, data);
-  }
-
-  /**
-   * Get Users in a Role
-   *
-   * @example
-   * var params = {
-   *   roleId: 'ROLE_ID',
-   *   per_page: 50,
-   *   page: 0
-   * };
-   * @example <caption>
-   *   This method takes a roleId and returns all users within that role. Supports offset (page, per_page) and checkpoint pagination (from, take). You must use checkpoint pagination to retrieve beyond the first 1000 records.
-   * </caption>
-   *
-   * management.roles.getUsers(params, function (err, users) {
-   *   console.log(users);
-   * });
-   * @param   {string}    [roleId]          Id of the role
-   * @param   {number}    [params.per_page] Number of results per page.
-   * @param   {number}    [params.page]     Page number, zero indexed.
-   * @param   {string}    [params.from]     For checkpoint pagination, the Id from which to start selection from.
-   * @param   {number}    [params.take]     For checkpoint pagination, the number of entries to retrieve. Default 50.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getUsers(params, callback) {
-    return this.users.getAll(params, callback);
-  }
-
-  /**
-   * Assign users to a role
-   *
-   * @example
-   * var params =  { id :'ROLE_ID'};
-   * var data = { "users" : ["userId1","userId2"]};
-   *
-   * management.roles.assignUsers(params, data, function (err, user) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // permissions added.
-   * });
-   * @param   {string}    params.id                ID of the Role.
-   * @param   {object}    data                permissions data
-   * @param   {string}    data.permissions    Array of permissions
-   * @param   {string}    data.permissions.permission_name  Name of a permission
-   * @param   {string}    data.permissions.resource_server_identifier  Identifier for a resource
-   * @param   {Function}  [cb]                  Callback function.
-   * @returns  {Promise|undefined}
-   */
-
-  assignUsers(params, data, cb) {
-    data = data || {};
-    params = params || {};
-
-    // Require a user ID.
-    if (!params.id) {
-      throw new ArgumentError('The roleId passed in params cannot be null or undefined');
-    }
-    if (typeof params.id !== 'string') {
-      throw new ArgumentError('The role Id has to be a string');
-    }
-
-    if (cb && cb instanceof Function) {
-      return this.users.create(params, data, cb);
-    }
-
-    return this.users.create(params, data);
-  }
-}
-
-module.exports = RolesManager;