auth0 2.37.0 → 2.38.0

package/src/management/EmailProviderManager.js

@@ -1,147 +1,129 @@
-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');
 
 /**
- * Simple facade for consuming a REST API endpoint.
- * @external RestClient
- * @see https://github.com/ngonzalvez/rest-facade
- */
-
-/**
- * @class EmailProviderManager
  * Auth0 Email 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 EmailProviderManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide client options');
-  }
+class EmailProviderManager {
+  /**
+   * @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');
+    }
+
+    /**
+     * Options object for the Rest Client instance.
+     *
+     * @type {object}
+     */
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
 
-  if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-    throw new ArgumentError('The provided base URL is invalid');
+    /**
+     * Provides an abstraction layer for consuming the
+     * [Auth0 Clients endpoint]{@link https://auth0.com/docs/api/v2#!/Clients}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/emails/provider`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
   }
 
   /**
-   * Options object for the Rest Client instance.
+   * Configure the email provider.
    *
-   * @type {Object}
+   * @example
+   * management.emailProvider.configure(data, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Email provider configured.
+   * });
+   * @param   {object}    data     The email provider data object.
+   * @param   {Function}  [cb]     Callback function.
+   * @returns  {Promise|undefined}
    */
-  var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' },
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+  configure(...args) {
+    return this.resource.create(...args);
+  }
 
   /**
-   * Provides an abstraction layer for consuming the
-   * [Auth0 Clients endpoint]{@link https://auth0.com/docs/api/v2#!/Clients}.
+   * Get the email provider.
    *
-   * @type {external:RestClient}
+   * @example
+   * management.emailProvider.get(function (err, provider) {
+   *   console.log(provider);
+   * });
+   * @param   {Function}  [cb]    Callback function.
+   * @param   {object}    [params]          Clients parameters.
+   * @param   {number}    [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+   * @param   {number}    [params.include_fields]  true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/emails/provider',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
-
-/**
- * Configure the email provider.
- *
- * @method    configure
- * @memberOf  module:management.EmailProviderManager.prototype
- *
- * @example
- * management.emailProvider.configure(data, function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   // Email provider configured.
- * });
- * @param   {Object}    data     The email provider data object.
- * @param   {Function}  [cb]     Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(EmailProviderManager, 'configure', 'resource.create');
-
-/**
- * Get the email provider.
- *
- * @method    get
- * @memberOf  module:management.EmailProviderManager.prototype
- *
- * @example
- * management.emailProvider.get(function (err, provider) {
- *   console.log(provider);
- * });
- *
- * @param   {Function}  [cb]    Callback function.
- * @param   {Object}    [params]          Clients parameters.
- * @param   {Number}    [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
- * @param   {Number}    [params.include_fields]  true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
-
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
+  get(...args) {
+    return this.resource.getAll(...args);
+  }
 
-/**
- * Update the email provider.
- *
- * @method    update
- * @memberOf  module:management.EmailProviderManager.prototype
- *
- * @example
- * management.emailProvider.update(params, data, function (err, provider) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   // Updated email provider.
- *   console.log(provider);
- * });
- *
- * @param   {Object}    params            Email provider parameters.
- * @param   {Object}    data              Updated email provider data.
- * @param   {Function}  [cb]              Callback function.
- *
- * @return    {Promise|undefined}
- */
-utils.wrapPropertyMethod(EmailProviderManager, 'update', 'resource.patch');
+  /**
+   * Update the email provider.
+   *
+   * @example
+   * management.emailProvider.update(params, data, function (err, provider) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Updated email provider.
+   *   console.log(provider);
+   * });
+   * @param   {object}    params            Email provider parameters.
+   * @param   {object}    data              Updated email provider data.
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  update(...args) {
+    return this.resource.patch(...args);
+  }
 
-/**
- * Delete email provider.
- *
- * @method    delete
- * @memberOf  module:management.EmailProviderManager.prototype
- *
- * @example
- * management.emailProvider.delete(function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   // Email provider configured.
- * });
- *
- * @param   {Function}  [cb]    Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(EmailProviderManager, 'delete', 'resource.delete');
+  /**
+   * Delete email provider.
+   *
+   * @example
+   * management.emailProvider.delete(function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Email provider configured.
+   * });
+   * @param   {Function}  [cb]    Callback function.
+   * @returns  {Promise|undefined}
+   */
+  delete(...args) {
+    return this.resource.delete(...args);
+  }
+}
 
 module.exports = EmailProviderManager;

package/src/management/EmailTemplatesManager.js

@@ -1,129 +1,113 @@
-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');
 
 /**
- * Simple facade for consuming a REST API endpoint.
- * @external RestClient
- * @see https://github.com/ngonzalvez/rest-facade
- */
-
-/**
- * @class EmailTemplatesManager
  * This class provides a simple abstraction for performing CRUD operations
- * on Auth0's Email Templates. {@see https://auth0.com/docs/api/management/v2#!/Email_Templates/get_email_templates_by_templateName}
- * @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
+ * on Auth0's Email Templates. {@link https://auth0.com/docs/api/management/v2#!/Email_Templates/get_email_templates_by_templateName}
  */
-var EmailTemplatesManager = function(options) {
-  if (!options || 'object' !== typeof options) {
-    throw new ArgumentError('Must provide manager options');
-  }
+class EmailTemplatesManager {
+  /**
+   * @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 || 'object' !== typeof options) {
+      throw new ArgumentError('Must provide manager options');
+    }
+
+    if (!options.baseUrl || 'string' !== typeof options.baseUrl) {
+      throw new ArgumentError('Must provide a valid string as base URL for the API');
+    }
 
-  if (!options.baseUrl || 'string' !== typeof options.baseUrl) {
-    throw new ArgumentError('Must provide a valid string as base URL for the API');
+    /**
+     * 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#!/Email_Templates/get_email_templates_by_templateName Auth0's Email Templates}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/email-templates/:name`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
   }
 
   /**
-   * Options object for the Rest Client instance.
+   * Create a new Email Template.
+   *
+   * @example
+   * management.emailTemplates.create(data, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
    *
-   * @type {Object}
+   *   // Email Template created.
+   * });
+   * @param   {object}    data     Email Template data object.
+   * @param   {Function}  [cb]     Callback function.
+   * @returns  {Promise|undefined}
    */
-  var clientOptions = {
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+  create(...args) {
+    return this.resource.create(...args);
+  }
 
   /**
-   * Provides an abstraction layer for performing CRUD operations on
-   * {@link https://auth0.com/docs/api/management/v2#!/Email_Templates/get_email_templates_by_templateName Auth0's Email Templates}.
+   * Get an Auth0 Email Template.
    *
-   * @type {external:RestClient}
+   * @example
+   * management.emailTemplates.get({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(emailTemplate);
+   * });
+   * @param   {object}    params          Email Template parameters.
+   * @param   {string}    params.name     Template Name
+   * @param   {Function}  [cb]            Callback function.
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/email-templates/:name',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
-
-/**
- * Create a new Email Template.
- *
- * @method    create
- * @memberOf  module:management.EmailTemplatesManager.prototype
- *
- * @example
- * management.emailTemplates.create(data, function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   // Email Template created.
- * });
- *
- * @param   {Object}    data     Email Template data object.
- * @param   {Function}  [cb]     Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(EmailTemplatesManager, 'create', 'resource.create');
-
-/**
- * Get an Auth0 Email Template.
- *
- * @method    get
- * @memberOf  module:management.EmailTemplatesManager.prototype
- *
- * @example
- * management.emailTemplates.get({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(emailTemplate);
- * });
- *
- * @param   {Object}    params          Email Template parameters.
- * @param   {String}    params.name     Template Name
- * @param   {Function}  [cb]            Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(EmailTemplatesManager, 'get', 'resource.get');
+  get(...args) {
+    return this.resource.get(...args);
+  }
 
-/**
- * Update an existing Email Template.
- *
- * @method    update
- * @memberOf  module:management.EmailTemplatesManager.prototype
- *
- * @example
- * var data = { from: 'new@email.com' };
- * var params = { name: EMAIL_TEMPLATE_NAME };
- *
- * management.emailTemplates.update(params, data, function (err, emailTemplate) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(emailTemplate.from);  // 'new@email.com'
- * });
- *
- * @param   {Object}    params          Email Template parameters.
- * @param   {String}    params.name     Template Name
- * @param   {Object}    data            Updated Email Template data.
- * @param   {Function}  [cb]            Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(EmailTemplatesManager, 'update', 'resource.patch');
+  /**
+   * Update an existing Email Template.
+   *
+   * @example
+   * var data = { from: 'new@email.com' };
+   * var params = { name: EMAIL_TEMPLATE_NAME };
+   *
+   * management.emailTemplates.update(params, data, function (err, emailTemplate) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(emailTemplate.from);  // 'new@email.com'
+   * });
+   * @param   {object}    params          Email Template parameters.
+   * @param   {string}    params.name     Template Name
+   * @param   {object}    data            Updated Email Template data.
+   * @param   {Function}  [cb]            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  update(...args) {
+    return this.resource.patch(...args);
+  }
+}
 
 module.exports = EmailTemplatesManager;