Update documentation for UserInfo (#977)

README.md

@@ -79,6 +79,7 @@ See [more examples](https://github.com/auth0/node-auth0/blob/master/EXAMPLES.md#
 
 - [AuthenticationClient](https://auth0.github.io/node-auth0/classes/auth.AuthenticationClient.html)
 - [ManagementClient](https://auth0.github.io/node-auth0/classes/management.ManagementClient.html)
+- [UserInfoClient](https://auth0.github.io/node-auth0/classes/userinfo.UserInfoClient.html)
 
 ## Feedback
 

docs/classes/auth.AuthApiError.html

@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AuthApiError</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L32">src/auth/base-auth-api.ts:32</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L32">src/auth/base-auth-api.ts:32</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -73,29 +73,29 @@ <h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-
 <h4 class="tsd-returns-title">Returns <a href="auth.AuthApiError.html" class="tsd-signature-type tsd-kind-class">AuthApiError</a></h4><aside class="tsd-sources">
 <p>Overrides Error.constructor</p>
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="body" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>body</span><a href="#body" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="error_description" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>error_<wbr/>description</span><a href="#error_description" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">error_<wbr/>description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="headers" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Headers</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -107,7 +107,7 @@ <h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permali
 <div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AuthApiError&quot;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <p>Overrides Error.name</p>
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -118,7 +118,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">status<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/4d43370e/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/15efd282/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
@@ -1248,5 +1248,25 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li><a href="../variables/management.TenantSettingsUpdateEnabledLocalesEnum-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Tenant<wbr/>Settings<wbr/>Update<wbr/>Enabled<wbr/>Locales<wbr/>Enum</span></a></li>
 <li><a href="../variables/management.TenantSettingsUpdateFlagsChangePwdFlowV1Enum-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Tenant<wbr/>Settings<wbr/>Update<wbr/>Flags<wbr/>Change<wbr/>Pwd<wbr/>Flow<wbr/>V1<wbr/>Enum</span></a></li>
 <li><a href="../variables/management.UserEnrollmentAuthMethodEnum-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>User<wbr/>Enrollment<wbr/>Auth<wbr/>Method<wbr/>Enum</span></a></li>
-<li><a href="../variables/management.UserEnrollmentStatusEnum-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>User<wbr/>Enrollment<wbr/>Status<wbr/>Enum</span></a></li></ul></div></details></li></ul></div></details></li></ul></div></details></li></ul></nav></div></div></div>
+<li><a href="../variables/management.UserEnrollmentStatusEnum-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>User<wbr/>Enrollment<wbr/>Status<wbr/>Enum</span></a></li></ul></div></details></li></ul></div></details></li>
+<li>
+<details class="tsd-index-accordion" data-key="userinfo"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/userinfo.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>userinfo</span></a></summary>
+<div class="tsd-accordion-details">
+<ul class="tsd-nested-navigation">
+<li>
+<details class="tsd-index-accordion" data-key="userinfo$Classes"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><span>Classes</span></summary>
+<div class="tsd-accordion-details">
+<ul class="tsd-nested-navigation">
+<li><a href="userinfo.UserInfoClient.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>User<wbr/>Info<wbr/>Client</span></a></li>
+<li><a href="userinfo.UserInfoError.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>User<wbr/>Info<wbr/>Error</span></a></li></ul></div></details></li>
+<li>
+<details class="tsd-index-accordion" data-key="userinfo$Interfaces"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><span>Interfaces</span></summary>
+<div class="tsd-accordion-details">
+<ul class="tsd-nested-navigation">
+<li><a href="../interfaces/userinfo.UserInfoResponse.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>User<wbr/>Info<wbr/>Response</span></a></li></ul></div></details></li>
+<li>
+<details class="tsd-index-accordion" data-key="userinfo$Functions"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><span>Functions</span></summary>
+<div class="tsd-accordion-details">
+<ul class="tsd-nested-navigation">
+<li><a href="../functions/userinfo.parseError.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>parse<wbr/>Error</span></a></li></ul></div></details></li></ul></div></details></li></ul></div></details></li></ul></nav></div></div></div>
 <div class="overlay"></div></body></html>