Merge branch 'master' into auth-before-import

boilerroomtv · May 30, 2018 · af160e2 · af160e2
2 parents 44e2a3b + 6f2f597
commit af160e2
Show file tree

Hide file tree

Showing 60 changed files with 3,215 additions and 872 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,62 +1,90 @@
 # Change Log
 
+## [v2.10.0](https://github.com/auth0/node-auth0/tree/v2.10.0) (2018-05-29)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.9.3...v2.10.0)
+
+**Added**
+
+* Adding pagination docs for clients/connections [\#268](https://github.com/auth0/node-auth0/pull/268) ([luisrudge](https://github.com/luisrudge))
+
+**Fixed**
+
+* Fix deleteUserMultifactor naming [\#259](https://github.com/auth0/node-auth0/pull/259) ([luisrudge](https://github.com/luisrudge))
+
 ## [v2.9.3](https://github.com/auth0/node-auth0/tree/v2.9.3) (2018-03-01)
+
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.9.2...v2.9.3)
 
 **Fixed**
-- Add client secret to passwordGrant [\#217](https://github.com/auth0/node-auth0/pull/217) ([luisrudge](https://github.com/luisrudge))
 
+* Add client secret to passwordGrant [\#217](https://github.com/auth0/node-auth0/pull/217) ([luisrudge](https://github.com/luisrudge))
 
 ## [v2.9.2](https://github.com/auth0/node-auth0/tree/v2.9.2) (2018-01-16)
+
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.9.1...v2.9.2)
 
 **Security**
-- Update rest facade [\#232](https://github.com/auth0/node-auth0/pull/232) ([luisrudge](https://github.com/luisrudge))
+
+* Update rest facade [\#232](https://github.com/auth0/node-auth0/pull/232) ([luisrudge](https://github.com/luisrudge))
 
 ## [v2.9.1](https://github.com/auth0/node-auth0/tree/v2.9.1) (2017-12-08)
+
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.9.0...v2.9.1)
 
 **Fixed**
-- fixed missing data object error [\#224](https://github.com/auth0/node-auth0/pull/224) ([dctoon](https://github.com/dctoon))
+
+* fixed missing data object error [\#224](https://github.com/auth0/node-auth0/pull/224) ([dctoon](https://github.com/dctoon))
 
 ## [v2.9.0](https://github.com/auth0/node-auth0/tree/v2.9.0) (2017-12-07)
+
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.8.0...v2.9.0)
 
 **Added**
-- Added support for /users-by-email method. [\#218](https://github.com/auth0/node-auth0/pull/218) ([kopertop](https://github.com/kopertop))
-- Add retry functionality for management api requests [\#215](https://github.com/auth0/node-auth0/pull/215) ([dctoon](https://github.com/dctoon))
+
+* Added support for /users-by-email method. [\#218](https://github.com/auth0/node-auth0/pull/218) ([kopertop](https://github.com/kopertop))
+* Add retry functionality for management api requests [\#215](https://github.com/auth0/node-auth0/pull/215) ([dctoon](https://github.com/dctoon))
 
 ## [v2.8.0](https://github.com/auth0/node-auth0/tree/v2.8.0) (2017-09-30)
+
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.7.1...v2.8.0)
 
 **Added**
-- Added tokenProvider functionality [\#196](https://github.com/auth0/node-auth0/pull/196) ([dctoon](https://github.com/dctoon))
+
+* Added tokenProvider functionality [\#196](https://github.com/auth0/node-auth0/pull/196) ([dctoon](https://github.com/dctoon))
 
 **Fixed**
-- Fix wrapPropertyMethod mistake for updateClientGrant [\#202](https://github.com/auth0/node-auth0/pull/202) ([danedmunds](https://github.com/danedmunds))
+
+* Fix wrapPropertyMethod mistake for updateClientGrant [\#202](https://github.com/auth0/node-auth0/pull/202) ([danedmunds](https://github.com/danedmunds))
 
 ## [v2.7.1](https://github.com/auth0/node-auth0/tree/v2.7.1) (2017-09-30)
+
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.7.0...v2.7.1)
 
 **Fixed**
-- Fix auth/users.getInfo to return JSON (fixes #158) [\#192](https://github.com/auth0/node-auth0/pull/192) ([pilwon](https://github.com/pilwon))
+
+* Fix auth/users.getInfo to return JSON (fixes #158) [\#192](https://github.com/auth0/node-auth0/pull/192) ([pilwon](https://github.com/pilwon))
 
 **Security**
-- Update request to address ReDoS vulnerability [\#206](https://github.com/auth0/node-auth0/pull/206) ([dancrumb](https://github.com/dancrumb))
+
+* Update request to address ReDoS vulnerability [\#206](https://github.com/auth0/node-auth0/pull/206) ([dancrumb](https://github.com/dancrumb))
 
 ## [v2.7.0](https://github.com/auth0/node-auth0/tree/v2.7.0) (2017-06-28)
+
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.6.0...v2.7.0)
 
 **Added**
-- Add password grant method [\#189](https://github.com/auth0/node-auth0/pull/189) ([hzalaz](https://github.com/hzalaz))
-- Retrieve a user's Guardian enrollments [\#181](https://github.com/auth0/node-auth0/pull/181) ([joshuaali](https://github.com/joshuaali))
-- Add get user logs [\#176](https://github.com/auth0/node-auth0/pull/176) ([amiram](https://github.com/amiram))
+
+* Add password grant method [\#189](https://github.com/auth0/node-auth0/pull/189) ([hzalaz](https://github.com/hzalaz))
+* Retrieve a user's Guardian enrollments [\#181](https://github.com/auth0/node-auth0/pull/181) ([joshuaali](https://github.com/joshuaali))
+* Add get user logs [\#176](https://github.com/auth0/node-auth0/pull/176) ([amiram](https://github.com/amiram))
 
 **Changed**
-- Update packages and utilize error classes from rest-facade correctly (Fixes #154) [\#183](https://github.com/auth0/node-auth0/pull/183) ([charsleysa](https://github.com/charsleysa))
+
+* Update packages and utilize error classes from rest-facade correctly (Fixes #154) [\#183](https://github.com/auth0/node-auth0/pull/183) ([charsleysa](https://github.com/charsleysa))
 
 **Fixed**
-- Fix impersonation to send AT in the params. [\#190](https://github.com/auth0/node-auth0/pull/190) ([hzalaz](https://github.com/hzalaz))
-- Fixed minor typo in DatabaseAuthenticator module [\#184](https://github.com/auth0/node-auth0/pull/184) ([scostello-paanalytics](https://github.com/scostello-paanalytics))
-- fix: avoid possible prototype override protection bypass [\#170](https://github.com/auth0/node-auth0/pull/170) ([AlmaasAre](https://github.com/AlmaasAre))
 
+* Fix impersonation to send AT in the params. [\#190](https://github.com/auth0/node-auth0/pull/190) ([hzalaz](https://github.com/hzalaz))
+* Fixed minor typo in DatabaseAuthenticator module [\#184](https://github.com/auth0/node-auth0/pull/184) ([scostello-paanalytics](https://github.com/scostello-paanalytics))
+* fix: avoid possible prototype override protection bypass [\#170](https://github.com/auth0/node-auth0/pull/170) ([AlmaasAre](https://github.com/AlmaasAre))
diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index.js.html b/docs/index.js.html
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
diff --git a/docs/module-auth.html b/docs/module-auth.html
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
diff --git a/docs/module-management.html b/docs/module-management.html
diff --git a/docs/module-utils.html b/docs/module-utils.html
diff --git a/docs/utils.js.html b/docs/utils.js.html
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "auth0",
-  "version": "2.9.3",
+  "version": "2.10.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
   "scripts": {

diff --git a/src/management/ClientsManager.js b/src/management/ClientsManager.js
@@ -86,12 +86,26 @@ utils.wrapPropertyMethod(ClientsManager, 'create', 'resource.create');
  * @method    getAll
  * @memberOf  module:management.ClientsManager.prototype
  *
- * @example
+ * @example <caption>
+ *   This method takes an optional object as first argument that may be used to
+ *   specify pagination settings. 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.clients.getAll(function (err, clients) {
  *   console.log(clients.length);
  * });
  *
- * @param   {Function}  [cb]    Callback function.
+ * @param   {Object}    [params]          Clients params.
+ * @param   {Number}    [params.per_page] Number of clients per page.
+ * @param   {Number}    [params.page]     Page number.
+ * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}
  */

diff --git a/src/management/ConnectionsManager.js b/src/management/ConnectionsManager.js
@@ -80,12 +80,26 @@ utils.wrapPropertyMethod(ConnectionsManager, 'create', 'resource.create');
  * @method    getAll
  * @memberOf  module:management.ConnectionsManager.prototype
  *
- * @example
+ * @example <caption>
+ *   This method takes an optional object as first argument that may be used to
+ *   specify pagination settings. 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.connections.getAll(function (err, connections) {
  *   console.log(connections.length);
  * });
  *
- * @param   {Function}  [cb]    Callback function.
+ * @param   {Object}    [params]          Connections params.
+ * @param   {Number}    [params.per_page] Number of connections per page.
+ * @param   {Number}    [params.page]     Page number.
+ * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}
  */

diff --git a/src/management/UsersManager.js b/src/management/UsersManager.js
@@ -144,7 +144,8 @@ UsersManager.prototype.create = function(data, cb) {
  *
  * @example <caption>
  *   This method takes an optional object as first argument that may be used to
- *   specify pagination settings and the search query.
+ *   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.