auth0/src/management/TenantManager.js

SDK for Auth0 API v2

var ArgumentError = require('rest-facade').ArgumentError;
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
 * Abstracts interaction with the tenant endpoint.
 * @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 TenantManager = 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');
  }

  var clientOptions = {
    errorFormatter: { message: 'message', name: 'error' },
    headers: options.headers,
    query: { repeatParams: false }
  };

  /**
   * Provides an abstraction layer for consuming the
   * {@link https://auth0.com/docs/api/v2#!/Stats Stats endpoint}.
   *
   * @type {external:RestClient}
   */
  var auth0RestClient = new Auth0RestClient(
    options.baseUrl + '/tenants/settings',
    clientOptions,
    options.tokenProvider
  );
  this.resource = new RetryRestClient(auth0RestClient, options.retry);
};

/**
 * Update the tenant settings.
 *
 * @method    updateSettings
 * @memberOf  module:management.TenantManager.prototype
 *
 * @example
 * management.tenant.updateSettings(data, function (err) {
 *   if (err) {
 *     // Handle error.
 *   }
 * });
 *
 * @param   {Object}    data  The new tenant settings.
 * @param   {Function}  [cb]  Callback function.
 *
 * @return  {Promise|undefined}
 */
TenantManager.prototype.updateSettings = function(data, cb) {
  if (cb && cb instanceof Function) {
    return this.resource.patch({}, data, cb);
  }

  // Return a promise.
  return this.resource.patch({}, data);
};

/**
 * Get the tenant settings..
 *
 * @method    getSettings
 * @memberOf  module:management.TenantManager.prototype
 *
 * @example
 * management.tenant.getSettings({ include_fields: true, fields: 'friendly_name' }, function (err, settings) {
 *   if (err) {
 *     // Handle error.
 *   }
 *
 *   console.log(settings);
 * });
 *
 * @param   {Object}    [data]  Request parameters
 * @param   {Function}  [cb]    Callback function.
 *
 * @return  {Promise|undefined}
 */
TenantManager.prototype.getSettings = function(data, cb) {
  if (data instanceof Function && !cb) {
    cb = data;
    data = {};
  }
  if (cb && cb instanceof Function) {
    return this.resource.get(data, cb);
  }

  // Return a promise.
  return this.resource.get(data);
};

module.exports = TenantManager;