feat(guardian): support policies, selected-provider, message-types methods [MFA-310]

[pmalouin]

Changes

Adding support for 6 Management API endpoints, related to Guardian/MFA features. Here is the list of API endpoints and their related method added to this SDK:

• GET /api/v2/guardian/policies
  • management.guardian.getPolicies()
  • management.getGuardianPolicies() (alias)
• PUT /api/v2/guardian/policies
  • management.guardian.updatePolicies()
  • management.updateGuardianPolicies() (alias)
• GET /api/v2/guardian/factors/sms/selected-provider
  • management.guardian.getPhoneFactorSelectedProvider()
  • management.getGuardianPhoneFactorSelectedProvider() (alias)
• PUT /api/v2/guardian/factors/sms/selected-provider
  • management.guardian.updatePhoneFactorSelectedProvider()
  • management.updateGuardianPhoneFactorSelectedProvider() (alias)
• GET /api/v2/guardian/factors/phone/message-types
  • management.guardian.getPhoneFactorMessageTypes()
  • management.getGuardianPhoneFactorMessageTypes() (alias)
• PUT /api/v2/guardian/factors/phone/message-types
  • management.guardian.updatePhoneFactorMessageTypes()
  • management.updateGuardianPhoneFactorMessageTypes() (alias)

These endpoints are going to be publicly documented in our API explorer once we kick off our Voice MFA beta program.

References

https://auth0team.atlassian.net/browse/MFA-310

Testing

• Do a manual round of testing by calling the methods.

• Generate the jsdoc (npm run jsdoc:generate) and browse the resulting documentation website to ensure the methods are clearly documented.

• This change adds unit test coverage

• This change adds integration test coverage

Checklist

• I have read the Auth0 general contribution guidelines
• I have read the Auth0 Code of Conduct
• All existing and new tests complete without errors

[pmalouin]

The first argument here is the generic "params", that we have no use for. But since this is a convention for all GET endpoints, it seems that it is preferable to keep it here.

See also other methods that have the same approach:

• node-auth0/src/management/PromptsManager.js

  Lines 56 to 78 in 48b7f8f

  	/**
  	* Update the prompts settings.
  	*
  	* @method updateSettings
  	* @memberOf module:management.PromptsManager.prototype
  	*
  	* @example
  	* management.prompts.updateSettings(data, function (err, prompts) {
  	* if (err) {
  	* // Handle error.
  	* }
  	*
  	* // Updated prompts
  	* console.log(prompts);
  	* });
  	*
  	* @param {Object} params Prompts parameters.
  	* @param {Object} data Updated prompts data.
  	* @param {Function} [cb] Callback function.
  	*
  	* @return {Promise|undefined}
  	*/
  	utils.wrapPropertyMethod(PromptsManager, 'updateSettings', 'resource.patch');

• node-auth0/src/management/BrandingManager.js

  Lines 56 to 78 in 48b7f8f

  	/**
  	* Update the branding settings.
  	*
  	* @method updateSettings
  	* @memberOf module:management.BrandingManager.prototype
  	*
  	* @example
  	* management.branding.updateSettings(data, function (err, branding) {
  	* if (err) {
  	* // Handle error.
  	* }
  	*
  	* // Updated branding
  	* console.log(branding);
  	* });
  	*
  	* @param {Object} params Branding parameters.
  	* @param {Object} data Updated branding data.
  	* @param {Function} [cb] Callback function.
  	*
  	* @return {Promise|undefined}
  	*/
  	utils.wrapPropertyMethod(BrandingManager, 'updateSettings', 'resource.patch');

[pmalouin]

One argument to keep the param argument is to allow extending the method with additional parameters/options in the future (ex. if the API endpoint starts accepting optional query params).

[pmalouin]

We discussed whether this should be /sms/selected-provider (the one that is already in production) or the new alias /phone/selected-provider (almost ready, but not available in PSaaS until July's release). To make the release smooth and ship this early, I opted to use the /sms/selected-provider. cc @joseluisdiaz

[TSLarson]

👍

[julienwoll]

ok, shall we create a task to change it in the future ?

[TSLarson]

LGTM!

[julienwoll]

What about /phone/twilio ?