auth0 2.36.2 → 2.39.0

package/src/management/LogStreamsManager.js

@@ -1,179 +1,163 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var utils = require('../utils');
-var Auth0RestClient = require('../Auth0RestClient');
-var RetryRestClient = require('../RetryRestClient');
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
 
 /**
- * @class LogStreamsManager
  * The logStreams class provides a simple abstraction for performing CRUD operations
  * on Auth0 Log Streams.
- * @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 LogStreamsManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide client options');
-  }
+class LogStreamsManager {
+  /**
+   * @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 client 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');
+    /**
+     * Options object for the Rest Client instance.
+     *
+     * @type {object}
+     */
+    const clientOptions = {
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    /**
+     * Provides an abstraction layer for performing CRUD operations on
+     * {@link https://auth0.com/docs/api/management/v2#!/Log_Streams Auth0
+     *  Log Streams}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/log-streams/:id `,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
   }
 
   /**
-   * Options object for the Rest Client instance.
+   * Get all Log Streams.
+   *
+   * @example
    *
-   * @type {Object}
+   * management.logStreams.getAll(function (err, logStreams) {
+   *   console.log(logStreams.length);
+   * });
+   * @param   {Function}  [cb]                    Callback function.
+   * @returns  {Promise|undefined}
    */
-  var clientOptions = {
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+  getAll(...args) {
+    return this.resource.getAll(...args);
+  }
 
   /**
-   * Provides an abstraction layer for performing CRUD operations on
-   * {@link https://auth0.com/docs/api/management/v2#!/Log_Streams Auth0
-   *  Log Streams}.
+   * Get an Auth0 Log Streams.
    *
-   * @type {external:RestClient}
+   * @example
+   * management.logStreams.get({ id: LOG_STREAM_ID }, function (err, logStream) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(logStream);
+   * });
+   * @param   {object}    params          Log Stream parameters.
+   * @param   {string}    params.id       Log Stream ID.
+   * @param   {Function}  [cb]            Callback function.
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/log-streams/:id ',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
-
-/**
- * Get all Log Streams.
- *
- * @method    getAll
- * @memberOf  module:management.LogStreamsManager.prototype
- *
- * @example
- *
- * management.logStreams.getAll(function (err, logStreams) {
- *   console.log(logStreams.length);
- * });
- *
- * @param   {Function}  [cb]                    Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(LogStreamsManager, 'getAll', 'resource.getAll');
-
-/**
- * Get an Auth0 Log Streams.
- *
- * @method    get
- * @memberOf  module:management.LogStreamsManager.prototype
- *
- * @example
- * management.logStreams.get({ id: LOG_STREAM_ID }, function (err, logStream) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(logStream);
- * });
- *
- * @param   {Object}    params          Log Stream parameters.
- * @param   {String}    params.id       Log Stream ID.
- * @param   {Function}  [cb]            Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(LogStreamsManager, 'get', 'resource.get');
+  get(...args) {
+    return this.resource.get(...args);
+  }
 
-/**
- * Create an Auth0 Log Stream.
- *
- * @method    create
- * @memberOf  module:management.LogStreamsManager.prototype
- *
- * @example
- * management.logStreams.create(data, function (err, log) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(log);
- * });
- *
- * @param   {Object}    data          Log Stream data.
- * @param   {Function}  [cb]          Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(LogStreamsManager, 'create', 'resource.create');
+  /**
+   * Create an Auth0 Log Stream.
+   *
+   * @example
+   * management.logStreams.create(data, function (err, log) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(log);
+   * });
+   * @param   {object}    data          Log Stream data.
+   * @param   {Function}  [cb]          Callback function.
+   * @returns  {Promise|undefined}
+   */
+  create(...args) {
+    return this.resource.create(...args);
+  }
 
-/**
- * Update an Auth0 Log Streams.
- *
- * @method    update
- * @memberOf  module:management.LogStreamsManager.prototype
- *
- * @example
- * var data = { name: 'New name' };
- * var params = { id: LOG_STREAM_ID };
- *
- * // Using auth0 instance.
- * management.updateLogStream(params, data, function (err, logStream) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(logStream.name);  // 'New name'
- * });
- *
- * // Using the logStreams manager directly.
- * management.logStreams.update(params, data, function (err, logStream) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(logStream.name);
- * });
- *
- * @param   {Object}    params          Log Stream parameters.
- * @param   {String}    params.id       Log Stream ID.
- * @param   {Object}    data            Updated Log Stream data.
- * @param   {Function}  [cb]            Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(LogStreamsManager, 'update', 'resource.patch');
+  /**
+   * Update an Auth0 Log Streams.
+   *
+   * @example
+   * var data = { name: 'New name' };
+   * var params = { id: LOG_STREAM_ID };
+   *
+   * // Using auth0 instance.
+   * management.updateLogStream(params, data, function (err, logStream) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(logStream.name);  // 'New name'
+   * });
+   *
+   * // Using the logStreams manager directly.
+   * management.logStreams.update(params, data, function (err, logStream) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(logStream.name);
+   * });
+   * @param   {object}    params          Log Stream parameters.
+   * @param   {string}    params.id       Log Stream ID.
+   * @param   {object}    data            Updated Log Stream data.
+   * @param   {Function}  [cb]            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  update(...args) {
+    return this.resource.patch(...args);
+  }
 
-/**
- * Delete an Auth0 Log Streams.
- *
- * @method    delete
- * @memberOf  module:management.LogStreamsManager.prototype
- *
- * @example
- * management.logStreams.delete({ id: LOG_STREAM_ID }, function (err, log) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(log);
- * });
- *
- * @param   {Object}    params          Log Stream parameters.
- * @param   {String}    params.id       Log Stream ID.
- * @param   {Function}  [cb]            Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(LogStreamsManager, 'delete', 'resource.delete');
+  /**
+   * Delete an Auth0 Log Streams.
+   *
+   * @example
+   * management.logStreams.delete({ id: LOG_STREAM_ID }, function (err, log) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(log);
+   * });
+   * @param   {object}    params          Log Stream parameters.
+   * @param   {string}    params.id       Log Stream ID.
+   * @param   {Function}  [cb]            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  delete(...args) {
+    return this.resource.delete(...args);
+  }
+}
 
 module.exports = LogStreamsManager;

package/src/management/LogsManager.js

@@ -1,116 +1,109 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var utils = require('../utils');
-var Auth0RestClient = require('../Auth0RestClient');
-var RetryRestClient = require('../RetryRestClient');
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
 
 /**
- * @class LogsManager
  * Represents the relationship between Auth0 and an Identity provider.
- * @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 LogsManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide client options');
-  }
+class LogsManager {
+  /**
+   * @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 client 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');
+    /**
+     * Options object for the Rest Client instance.
+     *
+     * @type {object}
+     */
+    const clientOptions = {
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    /**
+     * Provides an abstraction layer for performing CRUD operations on
+     * {@link https://auth0.com/docs/api/v2#!/LogsManagers Auth0
+     *  Logs}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/logs/:id`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
   }
 
   /**
-   * Options object for the Rest Client instance.
+   * Get all logs.
+   *
+   * @example <caption>
+   *   This method takes an optional object as first argument that may be used to
+   *   specify pagination settings and the search query. If pagination options are
+   *   not present, the first page of a limited number of results will be returned.
+   * </caption>
    *
-   * @type {Object}
+   * // Pagination settings.
+   * var params = {
+   *   per_page: 10,
+   *   page: 2
+   * };
+   *
+   * management.logs.getAll(params, function (err, logs) {
+   *   console.log(logs.length);
+   * });
+   * @param   {object}    [params]                Logs params.
+   * @param   {string}    [params.q]              Search Criteria using Query String Syntax
+   * @param   {number}    [params.page]           Page number. Zero based
+   * @param   {number}    [params.per_page]       The amount of entries per page
+   * @param   {string}    [params.sort]           The field to use for sorting.
+   * @param   {string}    [params.fields]         A comma separated 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.
+   * @param   {boolean}   [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
+   * @param   {string}    [params.from]           For checkpoint pagination, log event Id from which to start selection from.
+   * @param   {number}    [params.take]           When using the `from` parameter, the number of entries to retrieve. Default 50, max 100.
+   * @param   {Function}  [cb]                    Callback function.
+   * @returns  {Promise|undefined}
    */
-  var clientOptions = {
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+  getAll(...args) {
+    return this.resource.getAll(...args);
+  }
 
   /**
-   * Provides an abstraction layer for performing CRUD operations on
-   * {@link https://auth0.com/docs/api/v2#!/LogsManagers Auth0
-   *  Logs}.
+   * Get an Auth0 log.
    *
-   * @type {external:RestClient}
+   * @example
+   * management.logs.get({ id: EVENT_ID }, function (err, log) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(log);
+   * });
+   * @param   {object}    params          Log parameters.
+   * @param   {string}    params.id       Log ID.
+   * @param   {Function}  [cb]            Callback function.
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/logs/:id ',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
-
-/**
- * Get all logs.
- *
- * @method    getAll
- * @memberOf  module:management.LogsManager.prototype
- *
- * @example <caption>
- *   This method takes an optional object as first argument that may be used to
- *   specify pagination settings and the search query. 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: 2
- * };
- *
- * management.logs.getAll(params, function (err, logs) {
- *   console.log(logs.length);
- * });
- *
- * @param   {Object}    [params]                Logs params.
- * @param   {String}    [params.q]              Search Criteria using Query String Syntax
- * @param   {Number}    [params.page]           Page number. Zero based
- * @param   {Number}    [params.per_page]       The amount of entries per page
- * @param   {String}    [params.sort]           The field to use for sorting.
- * @param   {String}    [params.fields]         A comma separated 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.
- * @param   {Boolean}   [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
- * @param   {String}    [params.from]           For checkpoint pagination, log event Id from which to start selection from.
- * @param   {Number}    [params.take]           When using the `from` parameter, the number of entries to retrieve. Default 50, max 100.
- * @param   {Function}  [cb]                    Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(LogsManager, 'getAll', 'resource.getAll');
-
-/**
- * Get an Auth0 log.
- *
- * @method    get
- * @memberOf  module:management.LogsManager.prototype
- *
- * @example
- * management.logs.get({ id: EVENT_ID }, function (err, log) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(log);
- * });
- *
- * @param   {Object}    params          Log parameters.
- * @param   {String}    params.id       Log ID.
- * @param   {Function}  [cb]            Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(LogsManager, 'get', 'resource.get');
+  get(...args) {
+    return this.resource.get(...args);
+  }
+}
 
 module.exports = LogsManager;