mirror of
https://github.com/windmill-labs/windmill.git
synced 2026-08-18 16:02:10 +00:00
Ruben Fiszel
173 lines
95 KiB
HTML
173 lines
95 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UserService | windmill-client</title><meta name="description" content="Documentation for windmill-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">windmill-client</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">windmill-client</a></li><li><a href="UserService.html">UserService</a></li></ul><h1>Class UserService</h1></div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:116</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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="UserService.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="UserService.html#acceptInvite" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Invite</span></a>
|
|
<a href="UserService.html#createToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Token</span></a>
|
|
<a href="UserService.html#createTokenImpersonate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Token<wbr/>Impersonate</span></a>
|
|
<a href="UserService.html#createUserGlobally" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>User<wbr/>Globally</span></a>
|
|
<a href="UserService.html#declineInvite" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decline<wbr/>Invite</span></a>
|
|
<a href="UserService.html#deleteToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Token</span></a>
|
|
<a href="UserService.html#deleteUser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>User</span></a>
|
|
<a href="UserService.html#existsEmail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists<wbr/>Email</span></a>
|
|
<a href="UserService.html#getCurrentEmail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Email</span></a>
|
|
<a href="UserService.html#getRunnable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Runnable</span></a>
|
|
<a href="UserService.html#getTutorialProgress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tutorial<wbr/>Progress</span></a>
|
|
<a href="UserService.html#getUsage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Usage</span></a>
|
|
<a href="UserService.html#getUser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User</span></a>
|
|
<a href="UserService.html#globalUserDelete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>User<wbr/>Delete</span></a>
|
|
<a href="UserService.html#globalUserRename" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>User<wbr/>Rename</span></a>
|
|
<a href="UserService.html#globalUserUpdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>User<wbr/>Update</span></a>
|
|
<a href="UserService.html#globalUsernameInfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Username<wbr/>Info</span></a>
|
|
<a href="UserService.html#globalWhoami" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Whoami</span></a>
|
|
<a href="UserService.html#isOwnerOfPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Owner<wbr/>Of<wbr/>Path</span></a>
|
|
<a href="UserService.html#leaveInstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Instance</span></a>
|
|
<a href="UserService.html#listTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Tokens</span></a>
|
|
<a href="UserService.html#listUsernames" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Usernames</span></a>
|
|
<a href="UserService.html#listUsers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Users</span></a>
|
|
<a href="UserService.html#listUsersAsSuperAdmin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Users<wbr/>As<wbr/>Super<wbr/>Admin</span></a>
|
|
<a href="UserService.html#listUsersUsage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Users<wbr/>Usage</span></a>
|
|
<a href="UserService.html#listWorkspaceInvites" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Workspace<wbr/>Invites</span></a>
|
|
<a href="UserService.html#login" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login</span></a>
|
|
<a href="UserService.html#loginWithOauth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login<wbr/>With<wbr/>Oauth</span></a>
|
|
<a href="UserService.html#logout" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout</span></a>
|
|
<a href="UserService.html#refreshUserToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>User<wbr/>Token</span></a>
|
|
<a href="UserService.html#setPassword" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Password</span></a>
|
|
<a href="UserService.html#updateTutorialProgress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Tutorial<wbr/>Progress</span></a>
|
|
<a href="UserService.html#updateUser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>User</span></a>
|
|
<a href="UserService.html#usernameToEmail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>username<wbr/>To<wbr/>Email</span></a>
|
|
<a href="UserService.html#whoami" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>whoami</span></a>
|
|
<a href="UserService.html#whois" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>whois</span></a>
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_UserService" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>User<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="UserService.html" class="tsd-signature-type tsd-kind-class">UserService</a><a href="#constructor.new_UserService" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="UserService.html" class="tsd-signature-type tsd-kind-class">UserService</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="acceptInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>accept<wbr/>Invite</span><a href="#acceptInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="acceptInvite.acceptInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">accept<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#acceptInvite.acceptInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>accept invite to workspace</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/AcceptInviteData.html" class="tsd-signature-type tsd-kind-type-alias">AcceptInviteData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string status</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:467</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create<wbr/>Token</span><a href="#createToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createToken.createToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createToken.createToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>create token</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CreateTokenData.html" class="tsd-signature-type tsd-kind-type-alias">CreateTokenData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string token created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:624</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createTokenImpersonate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create<wbr/>Token<wbr/>Impersonate</span><a href="#createTokenImpersonate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createTokenImpersonate.createTokenImpersonate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Token<wbr/>Impersonate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createTokenImpersonate.createTokenImpersonate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>create token to impersonate a user (require superadmin)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CreateTokenImpersonateData.html" class="tsd-signature-type tsd-kind-type-alias">CreateTokenImpersonateData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string token created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:640</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createUserGlobally" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create<wbr/>User<wbr/>Globally</span><a href="#createUserGlobally" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createUserGlobally.createUserGlobally-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>User<wbr/>Globally</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createUserGlobally.createUserGlobally-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>create user</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CreateUserGloballyData.html" class="tsd-signature-type tsd-kind-type-alias">CreateUserGloballyData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string user created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:229</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="declineInvite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>decline<wbr/>Invite</span><a href="#declineInvite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="declineInvite.declineInvite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">decline<wbr/>Invite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#declineInvite.declineInvite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>decline invite to workspace</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DeclineInviteData.html" class="tsd-signature-type tsd-kind-type-alias">DeclineInviteData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string status</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:483</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>delete<wbr/>Token</span><a href="#deleteToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteToken.deleteToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#deleteToken.deleteToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>delete token</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DeleteTokenData.html" class="tsd-signature-type tsd-kind-type-alias">DeleteTokenData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string delete token</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:656</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>delete<wbr/>User</span><a href="#deleteUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteUser.deleteUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#deleteUser.deleteUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>delete user (require admin privilege)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DeleteUserData.html" class="tsd-signature-type tsd-kind-type-alias">DeleteUserData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string delete user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:320</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="existsEmail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>exists<wbr/>Email</span><a href="#existsEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="existsEmail.existsEmail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exists<wbr/>Email</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#existsEmail.existsEmail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>exists email</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ExistsEmailData.html" class="tsd-signature-type tsd-kind-type-alias">ExistsEmailData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>boolean user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:518</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getCurrentEmail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Current<wbr/>Email</span><a href="#getCurrentEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCurrentEmail.getCurrentEmail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Current<wbr/>Email</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#getCurrentEmail.getCurrentEmail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get current user email (if logged in)</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string user email</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:336</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRunnable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Runnable</span><a href="#getRunnable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRunnable.getRunnable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Runnable</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetRunnableResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetRunnableResponse</a><span class="tsd-signature-symbol">></span><a href="#getRunnable.getRunnable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get all runnables in every workspace</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetRunnableResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetRunnableResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown free all runnables</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:412</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTutorialProgress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Tutorial<wbr/>Progress</span><a href="#getTutorialProgress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTutorialProgress.getTutorialProgress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Tutorial<wbr/>Progress</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetTutorialProgressResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetTutorialProgressResponse</a><span class="tsd-signature-symbol">></span><a href="#getTutorialProgress.getTutorialProgress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get tutorial progress</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetTutorialProgressResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetTutorialProgressResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown tutorial progress</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:360</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUsage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Usage</span><a href="#getUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUsage.getUsage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#getUsage.getUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get current usage outside of premium workspaces</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>number free usage</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:400</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>User</span><a href="#getUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUser.getUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/User.html" class="tsd-signature-type tsd-kind-type-alias">User</a><span class="tsd-signature-symbol">></span><a href="#getUser.getUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get user (require admin privilege)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetUserData.html" class="tsd-signature-type tsd-kind-type-alias">GetUserData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/User.html" class="tsd-signature-type tsd-kind-type-alias">User</a><span class="tsd-signature-symbol">></span></h4><p>User user created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:154</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="globalUserDelete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>global<wbr/>User<wbr/>Delete</span><a href="#globalUserDelete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="globalUserDelete.globalUserDelete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">global<wbr/>User<wbr/>Delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#globalUserDelete.globalUserDelete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>global delete user (require super admin)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GlobalUserDeleteData.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUserDeleteData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string user deleted</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:302</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="globalUserRename" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>global<wbr/>User<wbr/>Rename</span><a href="#globalUserRename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="globalUserRename.globalUserRename-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">global<wbr/>User<wbr/>Rename</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#globalUserRename.globalUserRename-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>global rename user (require super admin)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GlobalUserRenameData.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUserRenameData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string user renamed</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:283</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="globalUserUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>global<wbr/>User<wbr/>Update</span><a href="#globalUserUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="globalUserUpdate.globalUserUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">global<wbr/>User<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#globalUserUpdate.globalUserUpdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>global update user (require super admin)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GlobalUserUpdateData.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUserUpdateData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string user updated</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:246</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="globalUsernameInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>global<wbr/>Username<wbr/>Info</span><a href="#globalUsernameInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="globalUsernameInfo.globalUsernameInfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">global<wbr/>Username<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GlobalUsernameInfoResponse.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUsernameInfoResponse</a><span class="tsd-signature-symbol">></span><a href="#globalUsernameInfo.globalUsernameInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>global username info (require super admin)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GlobalUsernameInfoData.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUsernameInfoData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GlobalUsernameInfoResponse.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUsernameInfoResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown user renamed</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:265</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="globalWhoami" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>global<wbr/>Whoami</span><a href="#globalWhoami" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="globalWhoami.globalWhoami-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">global<wbr/>Whoami</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GlobalUserInfo.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUserInfo</a><span class="tsd-signature-symbol">></span><a href="#globalWhoami.globalWhoami-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get current global whoami (if logged in)</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GlobalUserInfo.html" class="tsd-signature-type tsd-kind-type-alias">GlobalUserInfo</a><span class="tsd-signature-symbol">></span></h4><p>GlobalUserInfo user email</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:424</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isOwnerOfPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Owner<wbr/>Of<wbr/>Path</span><a href="#isOwnerOfPath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isOwnerOfPath.isOwnerOfPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Owner<wbr/>Of<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#isOwnerOfPath.isOwnerOfPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>is owner of path</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/IsOwnerOfPathData.html" class="tsd-signature-type tsd-kind-type-alias">IsOwnerOfPathData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>boolean is owner</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:195</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leaveInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>leave<wbr/>Instance</span><a href="#leaveInstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leaveInstance.leaveInstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">leave<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#leaveInstance.leaveInstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>leave instance</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string status</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:388</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listTokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Tokens</span><a href="#listTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listTokens.listTokens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Tokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListTokensResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListTokensResponse</a><span class="tsd-signature-symbol">></span><a href="#listTokens.listTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list token</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListTokensData.html" class="tsd-signature-type tsd-kind-type-alias">ListTokensData</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListTokensResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListTokensResponse</a><span class="tsd-signature-symbol">></span></h4><p>TruncatedToken truncated token</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:673</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listUsernames" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Usernames</span><a href="#listUsernames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listUsernames.listUsernames-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Usernames</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsernamesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsernamesResponse</a><span class="tsd-signature-symbol">></span><a href="#listUsernames.listUsernames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list usernames</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListUsernamesData.html" class="tsd-signature-type tsd-kind-type-alias">ListUsernamesData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsernamesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsernamesResponse</a><span class="tsd-signature-symbol">></span></h4><p>string user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:588</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listUsers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Users</span><a href="#listUsers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listUsers.listUsers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Users</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsersResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersResponse</a><span class="tsd-signature-symbol">></span><a href="#listUsers.listUsers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list users</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListUsersData.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsersResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersResponse</a><span class="tsd-signature-symbol">></span></h4><p>User user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:554</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listUsersAsSuperAdmin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Users<wbr/>As<wbr/>Super<wbr/>Admin</span><a href="#listUsersAsSuperAdmin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listUsersAsSuperAdmin.listUsersAsSuperAdmin-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Users<wbr/>As<wbr/>Super<wbr/>Admin</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsersAsSuperAdminResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersAsSuperAdminResponse</a><span class="tsd-signature-symbol">></span><a href="#listUsersAsSuperAdmin.listUsersAsSuperAdmin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list all users as super admin (require to be super amdin)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListUsersAsSuperAdminData.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersAsSuperAdminData</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsersAsSuperAdminResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersAsSuperAdminResponse</a><span class="tsd-signature-symbol">></span></h4><p>GlobalUserInfo user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:536</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listUsersUsage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Users<wbr/>Usage</span><a href="#listUsersUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listUsersUsage.listUsersUsage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Users<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsersUsageResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersUsageResponse</a><span class="tsd-signature-symbol">></span><a href="#listUsersUsage.listUsersUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list users usage</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListUsersUsageData.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersUsageData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListUsersUsageResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListUsersUsageResponse</a><span class="tsd-signature-symbol">></span></h4><p>UserUsage user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:571</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listWorkspaceInvites" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Workspace<wbr/>Invites</span><a href="#listWorkspaceInvites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listWorkspaceInvites.listWorkspaceInvites-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Workspace<wbr/>Invites</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListWorkspaceInvitesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListWorkspaceInvitesResponse</a><span class="tsd-signature-symbol">></span><a href="#listWorkspaceInvites.listWorkspaceInvites-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list all workspace invites</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListWorkspaceInvitesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListWorkspaceInvitesResponse</a><span class="tsd-signature-symbol">></span></h4><p>WorkspaceInvite list all workspace invites</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:436</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="login" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>login</span><a href="#login" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="login.login-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">login</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#login.login-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>login with password</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/LoginData.html" class="tsd-signature-type tsd-kind-type-alias">LoginData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string Successfully authenticated. The session ID is returned in a cookie named <code>token</code> and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:125</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loginWithOauth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>login<wbr/>With<wbr/>Oauth</span><a href="#loginWithOauth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loginWithOauth.loginWithOauth-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">login<wbr/>With<wbr/>Oauth</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#loginWithOauth.loginWithOauth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>login with oauth authorization flow</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/LoginWithOauthData.html" class="tsd-signature-type tsd-kind-type-alias">LoginWithOauthData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string Successfully authenticated. The session ID is returned in a cookie named <code>token</code> and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:692</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="logout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>logout</span><a href="#logout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="logout.logout-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">logout</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#logout.logout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>logout</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string clear cookies and clear token (if applicable)</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:139</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="refreshUserToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>refresh<wbr/>User<wbr/>Token</span><a href="#refreshUserToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="refreshUserToken.refreshUserToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">refresh<wbr/>User<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#refreshUserToken.refreshUserToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>refresh the current token</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string free usage</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:348</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setPassword" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Password</span><a href="#setPassword" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setPassword.setPassword-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Password</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#setPassword.setPassword-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>set password</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/SetPasswordData.html" class="tsd-signature-type tsd-kind-type-alias">SetPasswordData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string password set</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:213</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateTutorialProgress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>update<wbr/>Tutorial<wbr/>Progress</span><a href="#updateTutorialProgress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateTutorialProgress.updateTutorialProgress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Tutorial<wbr/>Progress</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#updateTutorialProgress.updateTutorialProgress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>update tutorial progress</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/UpdateTutorialProgressData.html" class="tsd-signature-type tsd-kind-type-alias">UpdateTutorialProgressData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string tutorial progress</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:374</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>update<wbr/>User</span><a href="#updateUser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateUser.updateUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#updateUser.updateUser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>update user (require admin privilege)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/UpdateUserData.html" class="tsd-signature-type tsd-kind-type-alias">UpdateUserData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string edited user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:174</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="usernameToEmail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>username<wbr/>To<wbr/>Email</span><a href="#usernameToEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="usernameToEmail.usernameToEmail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">username<wbr/>To<wbr/>Email</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#usernameToEmail.usernameToEmail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get email from username</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/UsernameToEmailData.html" class="tsd-signature-type tsd-kind-type-alias">UsernameToEmailData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string email</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:606</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="whoami" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>whoami</span><a href="#whoami" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="whoami.whoami-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">whoami</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/User.html" class="tsd-signature-type tsd-kind-type-alias">User</a><span class="tsd-signature-symbol">></span><a href="#whoami.whoami-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>whoami</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/WhoamiData.html" class="tsd-signature-type tsd-kind-type-alias">WhoamiData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/User.html" class="tsd-signature-type tsd-kind-type-alias">User</a><span class="tsd-signature-symbol">></span></h4><p>User user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:450</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="whois" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>whois</span><a href="#whois" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="whois.whois-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">whois</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/User.html" class="tsd-signature-type tsd-kind-type-alias">User</a><span class="tsd-signature-symbol">></span><a href="#whois.whois-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>whois</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/WhoisData.html" class="tsd-signature-type tsd-kind-type-alias">WhoisData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/User.html" class="tsd-signature-type tsd-kind-type-alias">User</a><span class="tsd-signature-symbol">></span></h4><p>User user</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:500</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#acceptInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>accept<wbr/>Invite</span></a><a href="#createToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Token</span></a><a href="#createTokenImpersonate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Token<wbr/>Impersonate</span></a><a href="#createUserGlobally" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>User<wbr/>Globally</span></a><a href="#declineInvite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decline<wbr/>Invite</span></a><a href="#deleteToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Token</span></a><a href="#deleteUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>User</span></a><a href="#existsEmail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists<wbr/>Email</span></a><a href="#getCurrentEmail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Email</span></a><a href="#getRunnable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Runnable</span></a><a href="#getTutorialProgress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tutorial<wbr/>Progress</span></a><a href="#getUsage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Usage</span></a><a href="#getUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User</span></a><a href="#globalUserDelete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>User<wbr/>Delete</span></a><a href="#globalUserRename" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>User<wbr/>Rename</span></a><a href="#globalUserUpdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>User<wbr/>Update</span></a><a href="#globalUsernameInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Username<wbr/>Info</span></a><a href="#globalWhoami" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Whoami</span></a><a href="#isOwnerOfPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Owner<wbr/>Of<wbr/>Path</span></a><a href="#leaveInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Instance</span></a><a href="#listTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Tokens</span></a><a href="#listUsernames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Usernames</span></a><a href="#listUsers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Users</span></a><a href="#listUsersAsSuperAdmin" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Users<wbr/>As<wbr/>Super<wbr/>Admin</span></a><a href="#listUsersUsage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Users<wbr/>Usage</span></a><a href="#listWorkspaceInvites" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Workspace<wbr/>Invites</span></a><a href="#login" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login</span></a><a href="#loginWithOauth" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login<wbr/>With<wbr/>Oauth</span></a><a href="#logout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout</span></a><a href="#refreshUserToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>User<wbr/>Token</span></a><a href="#setPassword" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Password</span></a><a href="#updateTutorialProgress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Tutorial<wbr/>Progress</span></a><a href="#updateUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>User</span></a><a href="#usernameToEmail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>username<wbr/>To<wbr/>Email</span></a><a href="#whoami" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>whoami</span></a><a href="#whois" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>whois</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>windmill-client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |