auth0 3.4.0 → 4.0.0-beta.0

package/src/management/EmailProviderManager.js

@@ -1,101 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Auth0 Email Provider.
- */
-class EmailProviderManager 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
-     * [Auth0 Clients endpoint]{@link https://auth0.com/docs/api/v2#!/Clients}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/emails/provider');
-  }
-
-  /**
-   * Configure the email provider.
-   *
-   * @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}
-   */
-  configure(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get the email provider.
-   *
-   * @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}
-   */
-  get(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * 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.
-   *
-   * @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,90 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * This class provides a simple abstraction for performing CRUD operations
- * on Auth0's Email Templates. {@link https://auth0.com/docs/api/management/v2#!/Email_Templates/get_email_templates_by_templateName}
- */
-class EmailTemplatesManager 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/management/v2#!/Email_Templates/get_email_templates_by_templateName Auth0's Email Templates}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/email-templates/:name');
-  }
-
-  /**
-   * Create a new Email Template.
-   *
-   * @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.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get an Auth0 Email Template.
-   *
-   * @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}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * 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;

package/src/management/GrantsManager.js

@@ -1,84 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Auth0 Grants Manager.
- *
- * See {@link https://auth0.com/docs/api/v2#!/Grants Grants}
- */
-class GrantsManager 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#!/Grants Auth0 Grants endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/grants/:id');
-  }
-
-  /**
-   * Get all Auth0 Grants.
-   *
-   * @example
-   * var params = {
-   *   per_page: 10,
-   *   page: 0,
-   *   include_totals: true,
-   *   user_id: 'USER_ID',
-   *   client_id: 'CLIENT_ID',
-   *   audience: 'AUDIENCE'
-   * };
-   *
-   * management.getGrants(params, function (err, grants) {
-   *   console.log(grants.length);
-   * });
-   * @param   {object}    params                Grants parameters.
-   * @param   {number}    params.per_page       Number of results per page.
-   * @param   {number}    params.page           Page number, zero indexed.
-   * @param   {boolean}   params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
-   * @param   {string}    params.user_id        The user_id of the grants to retrieve.
-   * @param   {string}    params.client_id      The client_id of the grants to retrieve.
-   * @param   {string}    params.audience       The audience of the grants to retrieve.
-   * @param   {Function}  [cb]                  Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Delete an Auth0 grant.
-   *
-   * @example
-   * var params = {
-   *    id: 'GRANT_ID',
-   *    user_id: 'USER_ID'
-   * };
-   *
-   * management.deleteGrant(params, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Grant deleted.
-   * });
-   * @param   {object}    params         Grant parameters.
-   * @param   {string}    params.id      Grant ID.
-   * @param   {string}    params.user_id The user_id of the grants to delete.
-   * @param   {Function}  [cb]           Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = GrantsManager;

package/src/management/GuardianManager.js

@@ -1,361 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Abstracts interaction with the Guardian endpoint.
- */
-class GuardianManager 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 retrieving Guardian enrollments.
-     *
-     * @type {external:RestClient}
-     */
-    this.enrollments = this._getRestClient('/guardian/enrollments/:id');
-
-    /**
-     * Provides an abstraction layer for retrieving Guardian tickets.
-     *
-     * @type {external:RestClient}
-     */
-    this.tickets = this._getRestClient('/guardian/enrollments/ticket');
-
-    /**
-     * Provides an abstraction layer for retrieving Guardian factors.
-     *
-     * @type {external:RestClient}
-     */
-    this.factors = this._getRestClient('/guardian/factors/:name');
-
-    /**
-     * Provides an abstraction layer for configuring Factor settings
-     *
-     * @type {external:RestClient}
-     */
-    this.factorSettings = this._getRestClient('/guardian/factors/:name/settings');
-
-    /**
-     * Provides an abstraction layer for retrieving Guardian factor templates.
-     *
-     * @type {external:RestClient}
-     */
-    this.factorsTemplates = this._getRestClient('/guardian/factors/:name/templates');
-
-    /**
-     * Provides an abstraction layer for retrieving Guardian factor providers.
-     *
-     * @type {external:RestClient}
-     */
-    this.factorsProviders = this._getRestClient('/guardian/factors/:name/providers/:provider');
-
-    /**
-     * Provides an abstraction layer for retrieving Guardian policies.
-     *
-     * @type {external:RestClient}
-     */
-    this.policies = this._getRestClient('/guardian/policies');
-
-    /**
-     * Provides an abstraction layer for retrieving Guardian phone factor selected provider.
-     *
-     * @type {external:RestClient}
-     */
-    this.factorsPhoneSelectedProvider = this._getRestClient(
-      '/guardian/factors/sms/selected-provider'
-    );
-
-    /**
-     * Provides an abstraction layer for retrieving Guardian phone factor message types.
-     *
-     * @type {external:RestClient}
-     */
-    this.factorsPhoneMessageTypes = this._getRestClient('/guardian/factors/phone/message-types');
-  }
-
-  /**
-   * Get a single Guardian enrollment.
-   *
-   * @example
-   * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
-   *   console.log(enrollment);
-   * });
-   * @param   {object}    data      The user data object.
-   * @param   {string}    data.id   The user id.
-   * @param   {Function}  [cb]      Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getGuardianEnrollment(...args) {
-    return this.enrollments.get(...args);
-  }
-
-  /**
-   * Delete a Guardian enrollment.
-   *
-   * @example
-   * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
-   *   console.log(enrollments);
-   * });
-   * @param   {object}    data      The user data object.
-   * @param   {string}    data.id   The user id.
-   * @param   {Function}  [cb]      Callback function.
-   * @returns  {Promise|undefined}
-   */
-  deleteGuardianEnrollment(...args) {
-    return this.enrollments.delete(...args);
-  }
-
-  /**
-   * Create a Guardian enrollment ticket.
-   *
-   * @example
-   * management.guardian.createEnrollmentTicket(function (err, ticket) {
-   *   console.log(ticket);
-   * });
-   * @param   {Function}  [cb]      Callback function.
-   * @returns  {Promise|undefined}
-   */
-  createEnrollmentTicket(...args) {
-    return this.tickets.create(...args);
-  }
-
-  /**
-   * Get a list of factors and statuses.
-   *
-   * @example
-   * management.guardian.getFactors(function (err, factors) {
-   *   console.log(factors.length);
-   * });
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getFactors(...args) {
-    return this.factors.getAll(...args);
-  }
-
-  /**
-   * Get Guardian factor configuration
-   *
-   * @example
-   * management.guardian.getFactorSettings({ name: 'webauthn-roaming' }, function (err, settings) {
-   *   console.log(settings);
-   * });
-   * @param   {object}    params            Factor  parameters.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getFactorSettings(...args) {
-    return this.factorSettings.get(...args);
-  }
-
-  /**
-   * Update Guardian factor configuration
-   *
-   * @example
-   * management.guardian.updateFactorSettings(
-   *  { name: 'webauthn-roaming' },
-   *  { userVerification: 'discouraged', overrideRelyingParty: false },
-   *  function (err, settings) {
-   *   console.log(settings);
-   * });
-   * @param   {object}    params            Factor  parameters.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  updateFactorSettings(...args) {
-    return this.factorSettings.update(...args);
-  }
-
-  /**
-   * Get Guardian factor provider configuration
-   *
-   * @example
-   * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
-   *   console.log(provider);
-   * });
-   * @param   {object}    params            Factor provider parameters.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getFactorProvider(...args) {
-    return this.factorsProviders.get(...args);
-  }
-
-  /**
-   * Update Guardian's factor provider
-   *
-   * @example
-   * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
-   *   messaging_service_sid: 'XXXXXXXXXXXXXX',
-   *   auth_token: 'XXXXXXXXXXXXXX',
-   *   sid: 'XXXXXXXXXXXXXX'
-   * }, function (err, provider) {
-   *   console.log(provider);
-   * });
-   * @param   {object}    params            Factor provider parameters.
-   * @param   {object}    data              Updated Factor provider data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  updateFactorProvider(...args) {
-    return this.factorsProviders.update(...args);
-  }
-
-  /**
-   * Get Guardian enrollment and verification factor templates
-   *
-   * @example
-   * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
-   *   console.log(templates);
-   * });
-   * @param   {object}    params            Factor parameters.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getFactorTemplates(...args) {
-    return this.factorsTemplates.get(...args);
-  }
-
-  /**
-   * Update Guardian enrollment and verification factor templates
-   *
-   * @example
-   * management.guardian.updateFactorProvider({ name: 'sms' }, {
-   *   enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
-   *   verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
-   * }, function (err, templates) {
-   *   console.log(templates);
-   * });
-   * @param   {object}    params            Factor parameters.
-   * @param   {object}    data              Updated factor templates data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  updateFactorTemplates(...args) {
-    return this.factorsTemplates.update(...args);
-  }
-
-  /**
-   * Update Guardian Factor
-   *
-   * @example
-   * management.guardian.updateFactor({ name: 'sms' }, {
-   *   enabled: true
-   * }, function (err, factor) {
-   *   console.log(factor);
-   * });
-   * @param   {object}    params            Factor parameters.
-   * @param   {object}    data              Updated factor data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  updateFactor(...args) {
-    return this.factors.update(...args);
-  }
-
-  /**
-   * Get enabled Guardian policies
-   *
-   * @example
-   * management.guardian.getPolicies(function (err, policies) {
-   *   console.log(policies);
-   * });
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getPolicies(...args) {
-    return this.policies.get(...args);
-  }
-
-  /**
-   * Update enabled Guardian policies
-   *
-   * @example
-   * management.guardian.updatePolicies({}, [
-   *   'all-applications'
-   * ], function (err, policies) {
-   *   console.log(policies);
-   * });
-   * @param   {object}    params            Parameters.
-   * @param   {string[]}  data              Policies to enable. Empty array disables all policies.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  updatePolicies(...args) {
-    return this.policies.update(...args);
-  }
-
-  /**
-   * Get the Guardian phone factor's selected provider
-   *
-   * @example
-   * management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
-   *   console.log(selectedProvider);
-   * });
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getPhoneFactorSelectedProvider(...args) {
-    return this.factorsPhoneSelectedProvider.get(...args);
-  }
-
-  /**
-   * Update the Guardian phone factor's selected provider
-   *
-   * @example
-   * management.guardian.updatePhoneFactorSelectedProvider({}, {
-   *   provider: 'twilio'
-   * }, function (err, factor) {
-   *   console.log(factor);
-   * });
-   * @param   {object}    params            Parameters.
-   * @param   {object}    data              Updated selected provider data.
-   * @param   {string}    data.provider     Name of the selected provider
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  updatePhoneFactorSelectedProvider(...args) {
-    return this.factorsPhoneSelectedProvider.update(...args);
-  }
-
-  /**
-   * Get the Guardian phone factor's message types
-   *
-   * @example
-   * management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
-   *   console.log(messageTypes);
-   * });
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getPhoneFactorMessageTypes(...args) {
-    return this.factorsPhoneMessageTypes.get(...args);
-  }
-
-  /**
-   * Update the Guardian phone factor's message types
-   *
-   * @example
-   * management.guardian.updatePhoneFactorMessageTypes({}, {
-   *   message_types: ['sms', 'voice']
-   * }, function (err, factor) {
-   *   console.log(factor);
-   * });
-   * @param   {object}    params                Parameters.
-   * @param   {object}    data                  Updated selected provider data.
-   * @param   {string[]}  data.message_types    Message types (only `"sms"` and `"voice"` are supported).
-   * @param   {Function}  [cb]                  Callback function.
-   * @returns  {Promise|undefined}
-   */
-  updatePhoneFactorMessageTypes(...args) {
-    return this.factorsPhoneMessageTypes.update(...args);
-  }
-}
-
-module.exports = GuardianManager;