Merge branch 'master' into master

src/management/LogsManager.js

@@ -58,12 +58,31 @@ var LogsManager = function(options) {
  * @method    getAll
  * @memberOf  module:management.LogsManager.prototype
  *
- * @example
- * management.logs.getAll(function (err, 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>
+ *
+ * // Pagination settings.
+ * var params = {
+ *   per_page: 10,
+ *   page: 2
+ * };
+ *
+ * management.logs.getAll(params, function (err, logs) {
  *   console.log(logs.length);
  * });
  *
- * @param   {Function}  [cb]    Callback function.
+ * @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   {Function}  [cb]                    Callback function.
  *
  * @return  {Promise|undefined}
  */

src/management/RulesConfigsManager.js

@@ -0,0 +1,129 @@
+var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * Simple facade for consuming a REST API endpoint.
+ * @external RestClient
+ * @see https://github.com/ngonzalvez/rest-facade
+ */
+
+
+/**
+ * @class RulesConfigsManager
+ * The rules configs manager class provides a simple abstraction for performing CRUD operations
+ * on Auth0 RulesConfigsManager.
+ * @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 RulesConfigsManager = function (options) {
+  if (options === null || typeof options !== 'object') {
+    throw new ArgumentError('Must provide manager options');
+  }
+
+  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}
+   */
+  var clientOptions = {
+    headers: options.headers,
+    query: { repeatParams: false }
+  };
+
+  /**
+   * Provides an abstraction layer for performing CRUD operations on
+   * {@link https://auth0.com/docs/api/v2#!/RulesConfigsManager Auth0 RulesConfigsManager}.
+   *
+   * @type {external:RestClient}
+   */
+  var auth0RestClient = new Auth0RestClient(options.baseUrl + '/rules-configs/:key', clientOptions, options.tokenProvider);
+  this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+
+/**
+ * Set a new rules config.
+ *
+ * @method    set
+ * @memberOf  module:management.RulesConfigsManager.prototype
+ *
+ * @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.
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'set', 'resource.update');
+
+
+/**
+ * Get all rules configs.
+ *
+ * @method    getAll
+ * @memberOf  module:management.RulesConfigsManager.prototype
+ *
+ * @example
+ * management.rulesConfigs.getAll(function (err, rulesConfig) {
+ *   console.log(rulesConfig.length);
+ * });
+ *
+ * @param   {Function}  [cb]     Callback function.
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'getAll', 'resource.getAll');
+
+
+/**
+ * Delete an existing rules config.
+ *
+ * @method    delete
+ * @memberOf  module:management.RulesConfigsManager.prototype
+ *
+ * @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.
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'delete', 'resource.delete');
+
+module.exports = RulesConfigsManager;

src/management/index.js

@@ -24,6 +24,7 @@ var TicketsManager = require('./TicketsManager');
 var LogsManager = require('./LogsManager');
 var ResourceServersManager = require('./ResourceServersManager');
 var ManagementTokenProvider = require('./ManagementTokenProvider');
+var RulesConfigsManager = require('./RulesConfigsManager');
 var EmailTemplatesManager = require('./EmailTemplatesManager');
 var GuardianManager = require('./GuardianManager');
 
@@ -253,6 +254,13 @@ var ManagementClient = function(options) {
    * @type {EmailTemplatesManager}
    */
   this.emailTemplates = new EmailTemplatesManager(managerOptions);
+
+  /**
+   * RulesConfigs manager.
+   *
+   * @type {RulesConfigsManager}
+   */
+  this.rulesConfigs = new RulesConfigsManager(managerOptions);
 };
 
 /**
@@ -1633,13 +1641,31 @@ utils.wrapPropertyMethod(ManagementClient, 'getLog', 'logs.get');
  * @method    getLogs
  * @memberOf  module:management.ManagementClient.prototype
  *
- * @example
- * management.getLogs(function (err, 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>
+ *
+ * // Pagination settings.
+ * var params = {
+ *   per_page: 10,
+ *   page: 2
+ * };
+ *
+ * management.getLogs(params, function (err, logs) {
  *   console.log(logs.length);
  * });
  *
- * @param   {Object}    data     Log data object.
- * @param   {Function}  [cb]     Callback function.
+ * @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   {Function}  [cb]                    Callback function.
  *
  * @return  {Promise|undefined}
  */
@@ -1757,4 +1783,78 @@ utils.wrapPropertyMethod(ManagementClient, 'deleteResourceServer', 'resourceServ
  * @return    {Promise|undefined}
  */
 utils.wrapPropertyMethod(ManagementClient, 'updateResourceServer', 'resourceServers.update');
+
+/**
+ * Set a new rules config.
+ *
+ * @method    setRulesConfig
+ * @memberOf  module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = { key: RULE_CONFIG_KEY };
+ * var data =   { value: RULES_CONFIG_VALUE };
+ *
+ * management.setRulesConfig(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.
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'setRulesConfig', 'rulesConfigs.set');
+
+/**
+ * Get rules config.
+ *
+ * @method    getRulesConfigs
+ * @memberOf  module:management.ManagementClient.prototype
+ *
+ * @example
+ *
+ * management.getRulesConfigs(function (err, rulesConfigs) {
+ *   if (err) {
+ *     // Handle error.
+ *   }
+ *
+ *   // Get Rules Configs.
+ * });
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getRulesConfigs', 'rulesConfigs.getAll');
+
+/**
+ * Delete rules config.
+ *
+ * @method    deleteRulesConfig
+ * @memberOf  module:management.ManagementClient.prototype
+ *
+ * @example
+ *
+ * management.deleteRulesConfig({ 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.
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+
+
 module.exports = ManagementClient;

test/management/management-client.tests.js

@@ -14,6 +14,7 @@ var EmailProviderManager = require('../../src/management/EmailProviderManager');
 var JobsManager = require('../../src/management/JobsManager');
 var RulesManager = require('../../src/management/RulesManager');
 var StatsManager = require('../../src/management/StatsManager');
+var RulesConfigsManager = require('../../src/management/RulesConfigsManager');
 
 var TenantManager = require('../../src/management/TenantManager');
 
@@ -137,7 +138,11 @@ describe('ManagementClient', function() {
       TenantManager: {
         property: 'tenant',
         cls: TenantManager
-      }
+      },
+      'RulesConfigsManager': {
+        property: 'rulesConfigs',
+        cls: RulesConfigsManager
+      },
     };
 
     before(function() {
@@ -197,7 +202,10 @@ describe('ManagementClient', function() {
       'getTenantSettings',
       'updateTenantSettings',
       'deleteUserMultifactor',
-      'deleteUserMultifcator'
+      'deleteUserMultifcator',
+      'setRulesConfig',
+      'getRulesConfigs',
+      'deleteRulesConfig'
     ];
 
     before(function() {