From de53f04400d834fe56c129e5445b3686b3784d34 Mon Sep 17 00:00:00 2001 From: davidpatrick Date: Tue, 17 Sep 2019 12:48:44 -0700 Subject: [PATCH] Release v2.20.0 --- CHANGELOG.md | 13 + docs/RetryRestClient.js.html | 4 +- docs/auth_DatabaseAuthenticator.js.html | 4 +- docs/auth_OAUthWithIDTokenValidation.js.html | 4 +- docs/auth_OAuthAuthenticator.js.html | 6 +- docs/auth_PasswordlessAuthenticator.js.html | 4 +- docs/auth_TokensManager.js.html | 4 +- docs/auth_UsersManager.js.html | 4 +- docs/auth_index.js.html | 4 +- docs/errors.js.html | 107 ++ docs/external-RestClient.html | 32 +- docs/index.html | 4 +- docs/index.js.html | 4 +- ...anagement_BlacklistedTokensManager.js.html | 4 +- docs/management_BrandingManager.js.html | 4 +- docs/management_ClientGrantsManager.js.html | 4 +- docs/management_ClientsManager.js.html | 4 +- docs/management_ConnectionsManager.js.html | 4 +- docs/management_CustomDomainsManager.js.html | 4 +- ...anagement_DeviceCredentialsManager.js.html | 4 +- docs/management_EmailProviderManager.js.html | 4 +- docs/management_EmailTemplatesManager.js.html | 4 +- docs/management_GrantsManager.js.html | 4 +- docs/management_GuardianManager.js.html | 4 +- docs/management_JobsManager.js.html | 4 +- docs/management_LogsManager.js.html | 4 +- ...management_ManagementTokenProvider.js.html | 4 +- docs/management_PromptsManager.js.html | 4 +- .../management_ResourceServersManager.js.html | 4 +- docs/management_RolesManager.js.html | 4 +- docs/management_RulesConfigsManager.js.html | 4 +- docs/management_RulesManager.js.html | 4 +- docs/management_StatsManager.js.html | 4 +- docs/management_TenantManager.js.html | 4 +- docs/management_TicketsManager.js.html | 4 +- docs/management_UserBlocksManager.js.html | 4 +- docs/management_UsersManager.js.html | 4 +- docs/management_index.js.html | 74 +- docs/module-auth.AuthenticationClient.html | 4 +- docs/module-auth.DatabaseAuthenticator.html | 4 +- ...odule-auth.OAUthWithIDTokenValidation.html | 4 +- docs/module-auth.OAuthAuthenticator.html | 18 +- ...module-auth.PasswordlessAuthenticator.html | 4 +- docs/module-auth.TokensManager.html | 4 +- docs/module-auth.UsersManager.html | 4 +- docs/module-auth.html | 4 +- docs/module-errors.html | 263 +++++ ...e-management.BlacklistedTokensManager.html | 4 +- docs/module-management.BrandingManager.html | 4 +- ...module-management.ClientGrantsManager.html | 4 +- docs/module-management.ClientsManager.html | 4 +- .../module-management.ConnectionsManager.html | 4 +- ...odule-management.CustomDomainsManager.html | 4 +- ...e-management.DeviceCredentialsManager.html | 4 +- ...odule-management.EmailProviderManager.html | 4 +- ...dule-management.EmailTemplatesManager.html | 4 +- docs/module-management.GrantsManager.html | 4 +- docs/module-management.GuardianManager.html | 4 +- docs/module-management.JobsManager.html | 16 +- docs/module-management.LogsManager.html | 4 +- docs/module-management.ManagementClient.html | 925 ++++++++++++++++-- ...le-management.ManagementTokenProvider.html | 4 +- docs/module-management.PromptsManager.html | 4 +- ...ule-management.ResourceServersManager.html | 4 +- docs/module-management.RetryRestClient.html | 4 +- docs/module-management.RolesManager.html | 4 +- ...module-management.RulesConfigsManager.html | 4 +- docs/module-management.RulesManager.html | 4 +- docs/module-management.StatsManager.html | 4 +- docs/module-management.TenantManager.html | 4 +- docs/module-management.TicketsManager.html | 4 +- docs/module-management.UserBlocksManager.html | 4 +- docs/module-management.UsersManager.html | 4 +- docs/module-management.html | 4 +- docs/module-utils.html | 4 +- docs/utils.js.html | 4 +- package.json | 2 +- scripts/release.js | 2 +- 78 files changed, 1486 insertions(+), 240 deletions(-) create mode 100644 docs/errors.js.html create mode 100644 docs/module-errors.html diff --git a/CHANGELOG.md b/CHANGELOG.md index a52533390..6bc947bc6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Change Log +## [v2.20.0](https://github.com/auth0/node-auth0/tree/v2.20.0) (2019-09-17) + +**Added** + +- expose createEmailTemplate, getEmailTemplate, updateEmailTemplates vi… [\#416](https://github.com/auth0/node-auth0/pull/416) ([rameshanandakrishnan](https://github.com/rameshanandakrishnan)) + +**Security** + +- Sanitize Error Request Data [\#424](https://github.com/auth0/node-auth0/pull/424) ([davidpatrick](https://github.com/davidpatrick)) +- [Security] Bump mixin-deep from 1.3.1 to 1.3.2 [\#421](https://github.com/auth0/node-auth0/pull/421) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.19.0...v2.20.0) + ## [v2.18.1](https://github.com/auth0/node-auth0/tree/v2.19.0) (2019-08-08) **Added** diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 655bdf19f..a9be84ae0 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -24,7 +24,7 @@
@@ -207,7 +207,7 @@

RetryRestClient.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index e3410b04d..5a832b92b 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -346,7 +346,7 @@

auth/DatabaseAuthenticator.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index c92039e9b..e853cea9d 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -163,7 +163,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 5b01cef58..f138f6f15 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -45,6 +45,7 @@

auth/OAuthAuthenticator.js

var ArgumentError = require('rest-facade').ArgumentError; var RestClient = require('rest-facade').Client; +var SanitizedError = require('../errors').SanitizedError; var OAUthWithIDTokenValidation = require('./OAUthWithIDTokenValidation'); function getParamsFromOptions(options) { @@ -89,6 +90,7 @@

auth/OAuthAuthenticator.js

* @type {Object} */ var clientOptions = { + errorCustomizer: SanitizedError, errorFormatter: { message: 'message', name: 'error' }, headers: options.headers }; @@ -448,7 +450,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index d21344a5c..1ba23d1ed 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -287,7 +287,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index d9089b55d..b59104adc 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@

auth/TokensManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 82993210e..ce9171abb 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -224,7 +224,7 @@

auth/UsersManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 4d34b8428..8ca635db6 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -603,7 +603,7 @@

auth/index.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html new file mode 100644 index 000000000..a5a20120d --- /dev/null +++ b/docs/errors.js.html @@ -0,0 +1,107 @@ + + + + + + errors.js - Documentation + + + + + + + + + + + + + + + + + +
+ +

errors.js

+ + + + + + + +
+
+ 
var util = require('util');
+
+/**
+ * @module errors
+ */
+var errors = (module.exports = {});
+
+/**
+ * Given a response request error, sanitize sensitive data.
+ *
+ * @method    sanitizeErrorRequestData
+ * @memberOf  module:errors
+ */
+errors.sanitizeErrorRequestData = function(error) {
+  if (!error.response || !error.response.request || !error.response.request._data) {
+    return error;
+  }
+
+  Object.keys(error.response.request._data).forEach(function(key) {
+    if (key.toLowerCase().match('password|secret')) {
+      error.response.request._data[key] = '[SANITIZED]';
+    }
+  });
+
+  return error;
+};
+
+/**
+ * Given an Api Error, modify the original error and sanitize
+ * sensitive information using sanitizeErrorRequestData
+ *
+ * @method    SanitizedError
+ * @memberOf  module:errors
+ */
+var SanitizedError = function(name, message, status, requestInfo, originalError) {
+  this.name = name || this.constructor.name || this.constructor.prototype.name || '';
+  this.message = message || '';
+  this.statusCode = status || (originalError && originalError.code);
+  this.requestInfo = Object.assign({}, requestInfo);
+  this.originalError = errors.sanitizeErrorRequestData(originalError);
+
+  Error.captureStackTrace(this, this.constructor);
+};
+
+util.inherits(SanitizedError, Error);
+
+errors.SanitizedError = SanitizedError;
+
+
+
+ + + + +
+ +
+ +
+ Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. +
+ + + + + diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index b1402b8ee..be3536675 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -87,7 +87,7 @@

Source:
@@ -187,7 +187,7 @@

Source:
@@ -287,7 +287,7 @@

Source:
@@ -387,7 +387,7 @@

Source:
@@ -487,7 +487,7 @@

Source:
@@ -587,7 +587,7 @@

Source:
@@ -687,7 +687,7 @@

Source:
@@ -887,7 +887,7 @@

Source:
@@ -987,7 +987,7 @@

Source:
@@ -1087,7 +1087,7 @@

Source:
@@ -1187,7 +1187,7 @@

Source:
@@ -1287,7 +1287,7 @@

Source:
@@ -1387,7 +1387,7 @@

Source:
@@ -1487,7 +1487,7 @@

Source:
@@ -1539,7 +1539,7 @@


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 69267ff9f..3a4f8c030 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

License


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index a5c695cb3..b985f7bb8 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@

index.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 18c8b12d3..e7bc25fea 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@

management/BlacklistedTokensManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index cf394d1b3..bf1dc88a4 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@

management/BrandingManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index e6dcde384..f930bb76d 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@

management/ClientGrantsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 718043c3c..8d95cb7b6 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@

management/ClientsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 712848434..765102488 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@

management/ConnectionsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index a382f144f..09c194bff 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@

management/CustomDomainsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 05ed896b3..1744f73d1 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@

management/DeviceCredentialsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 687dbd736..6c0901e8f 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@

management/EmailProviderManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 95521b87a..48202748c 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/EmailTemplatesManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index e1e0bb1ae..c01d116bc 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@

management/GrantsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index 59c9be7d3..96b17ee17 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index b7c0c404f..71ce6691b 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@

management/JobsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 7b8b23d14..a32ec12bc 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@

management/LogsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index d2327a315..4bb10dba6 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@

management/ManagementTokenProvider.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 116f67b2f..cc059ef03 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@

management/PromptsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index c4e8e3327..f69d6d479 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@

management/ResourceServersManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index 84e58474a..ab80951eb 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@

management/RolesManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 02eebf01f..f813f6be4 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/RulesConfigsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 303791a96..65bb8954f 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@

management/RulesManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index d6e64c8e3..b1a4f039f 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

management/StatsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 72dd36d02..34e16bd5f 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@

management/TenantManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index e47b880bf..113d1bf3c 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@

management/TicketsManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index a6554e34b..95fcfd3d0 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@

management/UserBlocksManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 3cb6d7bde..832a49996 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index abac30797..bd6156704 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@

management/index.js

*/ utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add'); +/** + * Create a new Email Template. + * + * @method createEmailTemplate + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.createEmailTemplate(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(ManagementClient, 'createEmailTemplate', 'emailTemplates.create'); + +/** + * Get an Auth0 Email Template. + * + * @method getEmailTemplate + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getEmailTemplate({ 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(ManagementClient, 'getEmailTemplate', 'emailTemplates.get'); + +/** + * Update an existing Email Template. + * + * @method updateEmailTemplates + * @memberOf module:management.ManagementClient.prototype + * + * @example + * var data = { from: 'new@email.com' }; + * var params = { name: EMAIL_TEMPLATE_NAME }; + * + * management.updateEmailTemplates(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(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update'); + /** * Get the email provider. * @@ -2880,7 +2950,7 @@

management/index.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 2318969f0..beaf697ed 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@
Examples

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index c958b6a9f..5cca41240 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index f4ca2c526..b8f357216 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index b1081b4ec..fe6720748 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@

new
Source:
@@ -452,7 +452,7 @@

(inner) Source:
@@ -536,7 +536,7 @@

Source:
@@ -777,7 +777,7 @@

password
Source:
@@ -1207,7 +1207,7 @@

refreshTo
Source:
@@ -1444,7 +1444,7 @@

signInSource:
@@ -1845,7 +1845,7 @@

socialSig
Source:
@@ -2050,7 +2050,7 @@

Returns:

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index 2c7338b26..6b4dd491a 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@
Examples

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index b90115d33..ecf882540 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 1fb994b71..c6664357a 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index 67edc6ef6..5f31661c2 100644 --- a/docs/module-auth.html +++ b/docs/module-auth.html @@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@

Classes


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html new file mode 100644 index 000000000..ba83f853f --- /dev/null +++ b/docs/module-errors.html @@ -0,0 +1,263 @@ + + + + + + errors - Documentation + + + + + + + + + + + + + + + + + +
+ +

errors

+ + + + + + + +
+ +
+ + + +
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + +

Methods

+ + + +
+ + + +

(static) SanitizedError()

+ + + + + +
+

Given an Api Error, modify the original error and sanitize +sensitive information using sanitizeErrorRequestData

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + + +

(static) sanitizeErrorRequestData()

+ + + + + +
+

Given a response request error, sanitize sensitive data.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+ + + + +
+ +
+ +
+ Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. +
+ + + + + \ No newline at end of file diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index 122846930..f69d82d5e 100644 --- a/docs/module-management.BlacklistedTokensManager.html +++ b/docs/module-management.BlacklistedTokensManager.html @@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index b604f8895..401bda83e 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index de293e317..74e4efc91 100644 --- a/docs/module-management.ClientGrantsManager.html +++ b/docs/module-management.ClientGrantsManager.html @@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 81c75d824..a5d4b0146 100644 --- a/docs/module-management.ClientsManager.html +++ b/docs/module-management.ClientsManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index d246d9852..09313b8ba 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 33024c066..a2f58e6bf 100644 --- a/docs/module-management.CustomDomainsManager.html +++ b/docs/module-management.CustomDomainsManager.html @@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index c50d0230e..8d5658130 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index 85b48818c..98b68990c 100644 --- a/docs/module-management.EmailProviderManager.html +++ b/docs/module-management.EmailProviderManager.html @@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index aa2d4f718..cfe8647da 100644 --- a/docs/module-management.EmailTemplatesManager.html +++ b/docs/module-management.EmailTemplatesManager.html @@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 4e2f67aee..dfdbc7616 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index fbb741e09..865df2f99 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 43f1c0d5d..cb838e052 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@

get -

Given a job ID, retrieve the failed/errored items

+

Get a job by its ID.

@@ -1030,7 +1030,7 @@

getSource:
@@ -1243,7 +1243,7 @@
Example
id: '{JOB_ID}' }; -management.jobs.errors(params, function (err, job) { +management.jobs.get(params, function (err, job) { if (err) { // Handle error. } @@ -1268,7 +1268,7 @@

get -

Get a job by its ID.

+

Given a job ID, retrieve the failed/errored items

@@ -1304,7 +1304,7 @@

getSource:
@@ -1517,7 +1517,7 @@
Example
id: '{JOB_ID}' }; -management.jobs.get(params, function (err, job) { +management.jobs.errors(params, function (err, job) { if (err) { // Handle error. } @@ -2198,7 +2198,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index be6183bb5..b5307d3f3 100644 --- a/docs/module-management.LogsManager.html +++ b/docs/module-management.LogsManager.html @@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 112165b2c..7fd390a6e 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@

a
Source:
@@ -3694,7 +3694,7 @@

Source:
@@ -4566,7 +4566,7 @@

cre
Source:
@@ -4955,6 +4955,222 @@

Example
+
+ + + +

createEmailTemplate(data, cbopt) → {Promise|undefined}

+ + + + + +
+

Create a new Email Template.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
data + + +Object + + + + + + + + + + +

Email Template data object.

+ +
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.createEmailTemplate(data, function (err) {
+  if (err) {
+    // Handle error.
+  // Email Template created.
+});
+ +
+ +
+ +
@@ -5002,7 +5218,7 @@

Source:
@@ -5186,7 +5402,7 @@

Source:
@@ -5366,7 +5582,7 @@

Source:
@@ -5558,7 +5774,7 @@

c
Source:
@@ -5776,7 +5992,7 @@

createRole<
Source:
@@ -7424,7 +7640,7 @@

del
Source:
@@ -7964,7 +8180,7 @@

de
Source:
@@ -8417,7 +8633,7 @@

d
Source:
@@ -8686,7 +8902,7 @@

deleteRole<
Source:
@@ -9224,7 +9440,7 @@

dele
Source:
@@ -10360,7 +10576,7 @@

exportUser
Source:
@@ -10774,7 +10990,7 @@

getAcce
Source:
@@ -10882,7 +11098,7 @@

ge
Source:
@@ -12765,7 +12981,7 @@

getCus
Source:
@@ -13034,7 +13250,7 @@

getCu
Source:
@@ -13150,7 +13366,7 @@

getDaily
Source:
@@ -13630,7 +13846,7 @@

getEm
Source:
@@ -13902,14 +14118,14 @@

Example
-

getGrants(params, cbopt) → {Promise|undefined}

+

getEmailTemplate(params, cbopt) → {Promise|undefined}

-

Get all Auth0 Grants.

+

Get an Auth0 Email Template.

@@ -13945,7 +14161,7 @@

getGrantsSource:
@@ -14016,7 +14232,7 @@
Parameters:
-

Grants parameters.

+

Email Template parameters.

@@ -14042,13 +14258,13 @@
Parameters:
- per_page + name -Number +String @@ -14059,7 +14275,15 @@
Parameters:
-

Number of results per page.

+

Template Name

+ + + + + + + + @@ -14068,38 +14292,299 @@
Parameters:
- page + cb -Number +function + + + <optional>
+ + + + + + + -

Page number, zero indexed.

+

Callback function.

+ + - - - include_totals - - - - + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+  if (err) {
+    // Handle error.
+  }
+
+  console.log(emailTemplate);
+});
+ +
+ +

+ + +
+ + + +

getGrants(params, cbopt) → {Promise|undefined}

+ + + + + +
+

Get all Auth0 Grants.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Grants parameters.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -23811,7 +24296,7 @@
Returns:
Example
- 
management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+    
management.unblockUser({ id: USER_ID }, function (err) {
   if (err) {
     // Handle error.
   }
@@ -23871,7 +24356,7 @@ 
unblockUse
     
     
Source:

     

     
 
@@ -23968,7 +24453,7 @@ 
Parameters:
- + @@ -24080,7 +24565,7 @@
Returns:
Example
- 
management.unblockUser({ id: USER_ID }, function (err) {
+    
management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
   if (err) {
     // Handle error.
   }
@@ -25694,7 +26179,7 @@ 
up
     
     
Source:

     

     
 
@@ -25900,6 +26385,312 @@ 
Example
+
+ + + +

updateEmailTemplates(params, data, cbopt) → {Promise|undefined}

+ + + + + +
+

Update an existing Email Template.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeDescription
per_page + + +Number + + + + +

Number of results per page.

+ +
page + + +Number + + + + +

Page number, zero indexed.

+ +
include_totals + + Boolean @@ -14879,7 +15364,7 @@

getJobSource:
@@ -15153,7 +15638,7 @@

getLogSource:
@@ -15422,7 +15907,7 @@

getLogsSource:
@@ -15929,7 +16414,7 @@

g
Source:
@@ -16153,7 +16638,7 @@

getR
Source:
@@ -16422,7 +16907,7 @@

get
Source:
@@ -16749,7 +17234,7 @@

getRoleSource:
@@ -17018,7 +17503,7 @@

getRolesSource:
@@ -17941,7 +18426,7 @@

getRul
Source:
@@ -18061,7 +18546,7 @@

getT
Source:
@@ -20758,7 +21243,7 @@

getUser
Source:
@@ -20983,7 +21468,7 @@

importUser
Source:
@@ -21881,7 +22366,7 @@

Source:
@@ -22974,7 +23459,7 @@

Source:
@@ -23245,7 +23730,7 @@

setRule
Source:
@@ -23602,7 +24087,7 @@

unblockUse
Source:
@@ -23699,7 +24184,7 @@

Parameters:

identifierid @@ -23716,7 +24201,7 @@
Parameters:
 -

The user identifier, any of: username, phone_number, email.

+

The user id.
ididentifier @@ -23985,7 +24470,7 @@
Parameters:
 -

The user id.

+

The user identifier, any of: username, phone_number, email.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Email Template parameters.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + + +

Template Name

+ +
+ + +
data + + +Object + + + + + + + + + + +

Updated Email Template data.

+ +
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+  if (err) {
+    // Handle error.
+  }
+
+  console.log(emailTemplate.from);  // 'new@email.com'
+});
+ +
+ + + +
@@ -25947,7 +26738,7 @@

u
Source:
@@ -26253,7 +27044,7 @@

updateRole<
Source:
@@ -26863,7 +27654,7 @@

u
Source:
@@ -27694,7 +28485,7 @@

ver
Source:
@@ -27932,7 +28723,7 @@

Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html index f4a7abdcb..0bc8a8c57 100644 --- a/docs/module-management.ManagementTokenProvider.html +++ b/docs/module-management.ManagementTokenProvider.html @@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@
Returns:

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index c8baa8ac0..2c1797c00 100644 --- a/docs/module-management.PromptsManager.html +++ b/docs/module-management.PromptsManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index 97f414bcb..baaa0ac04 100644 --- a/docs/module-management.ResourceServersManager.html +++ b/docs/module-management.ResourceServersManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index abadeb01d..81528cc9f 100644 --- a/docs/module-management.RetryRestClient.html +++ b/docs/module-management.RetryRestClient.html @@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index 907bf7ac7..5ce3055a3 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html index b70f317df..94b575198 100644 --- a/docs/module-management.RulesConfigsManager.html +++ b/docs/module-management.RulesConfigsManager.html @@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html index 8dd772a41..960660cb2 100644 --- a/docs/module-management.RulesManager.html +++ b/docs/module-management.RulesManager.html @@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html index 681b49a53..e8b765825 100644 --- a/docs/module-management.StatsManager.html +++ b/docs/module-management.StatsManager.html @@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html index c5f3b745a..32be39197 100644 --- a/docs/module-management.TenantManager.html +++ b/docs/module-management.TenantManager.html @@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html index 6a2b32a39..8600f2c9f 100644 --- a/docs/module-management.TicketsManager.html +++ b/docs/module-management.TicketsManager.html @@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html index ecb3c1352..e65dc5ff5 100644 --- a/docs/module-management.UserBlocksManager.html +++ b/docs/module-management.UserBlocksManager.html @@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html index 66bab6edc..8b693473a 100644 --- a/docs/module-management.UsersManager.html +++ b/docs/module-management.UsersManager.html @@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@
Example

- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-management.html b/docs/module-management.html index 8c1d3683e..ecf1efd0f 100644 --- a/docs/module-management.html +++ b/docs/module-management.html @@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@

Classes


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/module-utils.html b/docs/module-utils.html index 060f6ba15..8d919d4f5 100644 --- a/docs/module-utils.html +++ b/docs/module-utils.html @@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@

(static)
- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/docs/utils.js.html b/docs/utils.js.html index 2eee9fe8a..b71efcb9f 100644 --- a/docs/utils.js.html +++ b/docs/utils.js.html @@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@

utils.js


- Generated by JSDoc 3.6.3 on Thu Aug 08 2019 14:56:27 GMT-0300 (Brasilia Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme.
diff --git a/package.json b/package.json index 9d3fdf185..a3c23cd91 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "auth0", - "version": "2.19.0", + "version": "2.20.0", "description": "SDK for Auth0 API v2", "main": "src/index.js", "files": [ diff --git a/scripts/release.js b/scripts/release.js index 6b02b4bf9..25825e495 100644 --- a/scripts/release.js +++ b/scripts/release.js @@ -24,7 +24,7 @@ const createChangelog = async () => { '# Change Log', `# Change Log -## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today}) +## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today}) ${changelog} [Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})` )