auth0 3.4.0 → 4.0.0-beta.1

package/src/management/ClientsManager.js

@@ -1,184 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const BaseManager = require('./BaseManager');
-
-/**
- * Auth0 Clients Manager.
- *
- * {@link https://auth0.com/docs/api/v2#!/Clients Clients} represent
- * applications.
- * You can learn more about this in the
- * {@link https://auth0.com/docs/applications Applications} section of the
- * documentation.
- */
-class ClientsManager 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#!/Clients Auth0 Clients endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/clients/:client_id');
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/management/v2#!/Clients/post_rotate_secret Auth0 Clients Rotate a client secret}.
-     *
-     * @type {external:RestClient}
-     */
-    this.rotateSecretResource = this._getRestClient('/clients/:client_id/rotate-secret');
-  }
-
-  /**
-   * Create an Auth0 client.
-   *
-   * @example
-   * management.clients.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Client created.
-   * });
-   * @param   {object}    data     The client data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all Auth0 clients.
-   *
-   * @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.clients.getAll(params, function (err, clients) {
-   *   console.log(clients.length);
-   * });
-   * @param   {object}    [params]          Clients 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 client.
-   *
-   * @example
-   * management.clients.get({ client_id: CLIENT_ID }, function (err, client) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(client);
-   * });
-   * @param   {object}    params            Client parameters.
-   * @param   {string}    params.client_id  Application client ID.
-   * @param   {string}    params.fields     Comma-separated list of fields to include or exclude (based on value provided for include_fields).
-   * @param   {string}    params.include_fields  Whether specified fields are to be included (true) or excluded (false).
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Update an Auth0 client.
-   *
-   * @example
-   * var data = { name: 'newClientName' };
-   * var params = { client_id: CLIENT_ID };
-   *
-   * management.clients.update(params, data, function (err, client) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(client.name);  // 'newClientName'
-   * });
-   * @param   {object}    params            Client parameters.
-   * @param   {string}    params.client_id  Application client ID.
-   * @param   {object}    data              Updated client data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  update(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Delete an Auth0 client.
-   *
-   * @example
-   * management.clients.delete({ client_id: CLIENT_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Client deleted.
-   * });
-   * @param   {object}    params            Client parameters.
-   * @param   {string}    params.client_id  Application client ID.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-
-  /**
-   * Rotate a client secret
-   *
-   * @example
-   * management.clients.rotateClientSecret({ client_id: CLIENT_ID }, function (err, user) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Client secret rotated.
-   * });
-   * @param   {object}    params              params object
-   * @param   {string}    params.client_id    Application client ID.
-   * @returns  {Promise|undefined}
-   */
-  rotateClientSecret(params, cb) {
-    const query = params || {};
-
-    // Require a client ID.
-    if (!params.client_id) {
-      throw new ArgumentError('The client_id cannot be null or undefined');
-    }
-
-    if (cb && cb instanceof Function) {
-      return this.rotateSecretResource.create(query, {}, cb);
-    }
-
-    return this.rotateSecretResource.create(query, {});
-  }
-}
-
-module.exports = ClientsManager;

package/src/management/ConnectionsManager.js

@@ -1,213 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const BaseManager = require('./BaseManager');
-
-/**
- * Represents the relationship between Auth0 and an Identity provider.
- */
-class ConnectionsManager 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#!/ConnectionsManagers Auth0
-     *  Connections}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/connections/:id');
-
-    this.status = this._getRestClient('/connections/:id/status');
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/management/v2#!/Connections/delete_users_by_email
-     * endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.user = this._getRestClient('/connections/:id/users');
-  }
-
-  /**
-   * Create a new connection.
-   *
-   * @example
-   * management.connections.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Connection created.
-   * });
-   * @param   {object}    data     Connection data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all connections.
-   *
-   * @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.connections.getAll(params, function (err, connections) {
-   *   console.log(connections.length);
-   * });
-   * @param   {object}    [params]                Connections params.
-   * @param   {number}    [params.per_page]       Number of results per page.
-   * @param   {number}    [params.page]           Page number, zero indexed.
-   * @param   {string[]}  [params.fields]         List of fields to include or exclude
-   * @param   {boolean}   [params.include_fields] true if the fields specified are to be included in the result, false otherwise. Default true
-   * @param   {boolean}   [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
-   * @param   {string}    [params.strategy]       Provide strategies to only retrieve connections with such strategies
-   * @param   {string}    [params.name]           Provide the name of the connection to retrieve
-   * @param   {Function}  [cb]                    Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Get an Auth0 connection.
-   *
-   * @example
-   * management.connections.get({ id: CONNECTION_ID }, function (err, connection) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(connection);
-   * });
-   * @param   {object}    params          Connection parameters.
-   * @param   {string}    params.id       Connection ID.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Update an existing connection.
-   *
-   * @example
-   * var data = { name: 'newConnectionName' };
-   * var params = { id: CONNECTION_ID };
-   *
-   * management.connections.update(params, data, function (err, connection) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(connection.name);  // 'newConnectionName'
-   * });
-   * @param   {object}    params        Connection parameters.
-   * @param   {string}    params.id     Connection ID.
-   * @param   {object}    data          Updated connection data.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns    {Promise|undefined}
-   */
-  update(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Delete an existing connection.
-   *
-   * @example
-   * management.connections.delete({ id: CONNECTION_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Connection deleted.
-   * });
-   * @param   {object}    params          Connection parameters.
-   * @param   {string}    params.id       Connection ID.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-
-  /**
-   * Checks the status of an ad/ldap connection referenced by its ID.
-   *
-   * @example
-   * var params = {id : 'CONNECTION_ID'}
-   * @example <caption>
-   *   This methods takes the connection ID and returns the status when online, or an error when offline.
-   * </caption>
-   *
-   * management.connections.checkStatus( {id : 'CONNECTION_ID'}, function (err, status) {
-   *   if (err) {
-   *     console.log('OFFLINE', err);
-   *   } else {
-   *     console.log('ONLINE', status);
-   *   }
-   * });
-   * @param   {object}    params              Connection parameters
-   * @param   {string}    params.id           ID of the Connection.
-   * @param   {Function}  [cb]                Callback function.
-   * @returns  {Promise|undefined}
-   */
-  checkStatus(...args) {
-    return this.status.get(...args);
-  }
-
-  /**
-   * Delete a connection user by email.
-   *
-   * @example
-   * management.connections.deleteUserByEmail({ id: CONNECTION_ID, email:USER_EMAIL }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // User deleted.
-   * });
-   * @param   {object}    params          Connection parameters.
-   * @param   {string}    params.id       Connection ID.
-   * @param   {string}    params.email    User Email.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  deleteUserByEmail(params, cb) {
-    if (typeof params !== 'object' || typeof params.email !== 'string' || params.email.length < 1) {
-      throw new ArgumentError('You must provide an email for the deleteUserByEmail method');
-    }
-
-    if (!params.id) {
-      throw new ArgumentError('The connection id cannot be null or undefined');
-    }
-
-    if (cb && cb instanceof Function) {
-      return this.user.delete(params, {}, cb);
-    }
-
-    return this.user.delete(params, {});
-  }
-}
-
-module.exports = ConnectionsManager;

package/src/management/CustomDomainsManager.js

@@ -1,141 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const BaseManager = require('./BaseManager');
-
-/**
- * Auth0 Custom Domains Manager.
- *
- * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
- * custom domain names.
- * You can learn more about this in the
- * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
- * documentation.
- */
-class CustomDomainsManager 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#!/Custom_Domains Auth0 Custom Domains endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/custom-domains/:id');
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.vefifyResource = this._getRestClient('/custom-domains/:id/verify');
-  }
-
-  /**
-   * Create an Auth0 Custom Domain.
-   *
-   * @example
-   * management.customDomains.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // CustomDomain created.
-   * });
-   * @param   {object}    data     The custom domain data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all Auth0 CustomDomains.
-   *
-   * @example
-   * management.customDomains.getAll(function (err, customDomains) {
-   *   console.log(customDomains.length);
-   * });
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Get a Custom Domain.
-   *
-   * @example
-   * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(customDomain);
-   * });
-   * @param   {object}    params            Custom Domain parameters.
-   * @param   {string}    params.id         Custom Domain ID.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Verify a Custom Domain.
-   *
-   * @example
-   * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(customDomain);
-   * });
-   * @param   {object}    params            Custom Domain parameters.
-   * @param   {string}    params.id         Custom Domain ID.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  verify(params, cb) {
-    if (!params || !params.id) {
-      throw new ArgumentError('The custom domain id cannot be null or undefined');
-    }
-
-    if (cb && cb instanceof Function) {
-      return this.vefifyResource.create(params, {}, cb);
-    }
-
-    return this.vefifyResource.create(params, {});
-  }
-
-  /**
-   * Delete a Custom Domain.
-   *
-   * @example
-   * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // CustomDomain deleted.
-   * });
-   * @param   {object}    params            Custom Domain parameters.
-   * @param   {string}    params.id         Custom Domain ID.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = CustomDomainsManager;

package/src/management/DeviceCredentialsManager.js

@@ -1,91 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Manages Auth0 Device Credentials.
- */
-class DeviceCredentialsManager 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);
-
-    /**
-     * Options object for the RestClient instance.
-     *
-     * @type {object}
-     */
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/v2#!/Device_Credentials
-     *  Auth0 DeviceCredentialsManagers endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/device-credentials/:id');
-  }
-
-  /**
-   * Create an Auth0 credential.
-   *
-   * @example
-   * management.deviceCredentials.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Credential created.
-   * });
-   * @param   {object}    data     The device credential data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  createPublicKey(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all Auth0 credentials.
-   *
-   * @example
-   * var params = {user_id: "USER_ID"};
-   *
-   * management.deviceCredentials.getAll(params, function (err, credentials) {
-   *   console.log(credentials.length);
-   * });
-   * @param   {object}    params  Credential parameters.
-   * @param   {Function}  [cb]    Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Delete an Auth0 device credential.
-   *
-   * @example
-   * var params = { id: CREDENTIAL_ID };
-   *
-   * management.deviceCredentials.delete(params, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Credential deleted.
-   * });
-   * @param   {object}    params          Credential parameters.
-   * @param   {string}    params.id       Device credential ID.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = DeviceCredentialsManager;