Skip to content

[WIP] Organize account methods into logical categories #1870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[WIP] Organize account methods into logical categories #1870

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92deac0
Account API references - Organize account methods into logical catego…
ebenezerdon Mar 19, 2025
6bb5dea
Merge branch 'main' into organise-account-references
ebenezerdon Mar 19, 2025
986c736
Clean up
ebenezerdon Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 112 additions & 10 deletions src/routes/docs/references/[version]/[platform]/[service]/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,17 +314,119 @@
<span class="icon-x" aria-hidden="true" />
</button>
</div>
<ul class="web-references-menu-list">
{#each data.methods as method}
<li class="web-references-menu-item">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}>{method.title}</a
>
{#if data.service?.name === 'account'}
<ul class="web-references-menu-list">
<li class="web-references-menu-category">
<h6 class="text-micro text-greyscale-500 mt-6 mb-4 uppercase">
Authentication & Sessions
</h6>
{#each data.methods.filter( (m) => ['get', 'createSession', 'createAnonymousSession', 'createEmailSession', 'createMagicURLSession', 'createOAuth2Session', 'getSession', 'updateSession', 'deleteSessions', 'deleteSession'].includes(m.id) ) as method}
<li class="web-references-menu-item mb-3">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}
>{method.title}</a
>
</li>
{/each}
</li>
{/each}
</ul>

<li class="web-references-menu-category">
<h6 class="text-micro text-greyscale-500 mt-6 mb-4 uppercase">
Account Management
</h6>
{#each data.methods.filter( (m) => ['create', 'updateEmail', 'updateName', 'updatePassword', 'updatePhone', 'delete', 'updateStatus'].includes(m.id) ) as method}
<li class="web-references-menu-item mb-3">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}
>{method.title}</a
>
</li>
{/each}
</li>

<li class="web-references-menu-category">
<h6 class="text-micro text-greyscale-500 mt-6 mb-4 uppercase">
Multi-Factor Authentication
</h6>
{#each data.methods.filter( (m) => ['createMfaAuthenticator', 'getMfaAuthenticators', 'deleteMfaAuthenticator', 'updateMfaAuthenticator', 'createMfaChallenge', 'updateMfaChallenge', 'getMfaFactors', 'getMfaRecoveryCodes', 'createMfaRecoveryCodes', 'updateMfaRecoveryCodes'].includes(m.id) ) as method}
<li class="web-references-menu-item mb-3">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}
>{method.title}</a
>
</li>
{/each}
</li>

<li class="web-references-menu-category">
<h6 class="text-micro text-greyscale-500 mt-6 mb-4 uppercase">
User Preferences
</h6>
{#each data.methods.filter( (m) => ['getPrefs', 'updatePrefs'].includes(m.id) ) as method}
<li class="web-references-menu-item mb-3">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}
>{method.title}</a
>
</li>
{/each}
</li>

<li class="web-references-menu-category">
<h6 class="text-micro text-greyscale-500 mt-6 mb-4 uppercase">
Security & Verification
</h6>
{#each data.methods.filter( (m) => ['createVerification', 'updateVerification', 'createEmailVerification', 'updateEmailVerification', 'createPhoneVerification', 'updatePhoneVerification', 'getLogs', 'getSessions', 'getJWT'].includes(m.id) ) as method}
<li class="web-references-menu-item mb-3">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}
>{method.title}</a
>
</li>
{/each}
</li>

{#if data.methods.filter((m) => !['get', 'createSession', 'createAnonymousSession', 'createEmailSession', 'createMagicURLSession', 'createOAuth2Session', 'getSession', 'updateSession', 'deleteSessions', 'deleteSession', 'create', 'updateEmail', 'updateName', 'updatePassword', 'updatePhone', 'delete', 'updateStatus', 'createMfaAuthenticator', 'getMfaAuthenticators', 'deleteMfaAuthenticator', 'updateMfaAuthenticator', 'createMfaChallenge', 'updateMfaChallenge', 'getMfaFactors', 'getMfaRecoveryCodes', 'createMfaRecoveryCodes', 'updateMfaRecoveryCodes', 'getPrefs', 'updatePrefs', 'createVerification', 'updateVerification', 'createEmailVerification', 'updateEmailVerification', 'createPhoneVerification', 'updatePhoneVerification', 'getLogs', 'getSessions', 'getJWT'].includes(m.id)).length > 0}
<li class="web-references-menu-category">
<h6 class="text-micro text-greyscale-500 mt-6 mb-4 uppercase">
Other Methods
</h6>
{#each data.methods.filter((m) => !['get', 'createSession', 'createAnonymousSession', 'createEmailSession', 'createMagicURLSession', 'createOAuth2Session', 'getSession', 'updateSession', 'deleteSessions', 'deleteSession', 'create', 'updateEmail', 'updateName', 'updatePassword', 'updatePhone', 'delete', 'updateStatus', 'createMfaAuthenticator', 'getMfaAuthenticators', 'deleteMfaAuthenticator', 'updateMfaAuthenticator', 'createMfaChallenge', 'updateMfaChallenge', 'getMfaFactors', 'getMfaRecoveryCodes', 'createMfaRecoveryCodes', 'updateMfaRecoveryCodes', 'getPrefs', 'updatePrefs', 'createVerification', 'updateVerification', 'createEmailVerification', 'updateEmailVerification', 'createPhoneVerification', 'updatePhoneVerification', 'getLogs', 'getSessions', 'getJWT'].includes(m.id)) as method}
<li class="web-references-menu-item mb-3">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}
>{method.title}</a
>
</li>
{/each}
</li>
{/if}
</ul>
{:else}
<ul class="web-references-menu-list">
{#each data.methods as method}
<li class="web-references-menu-item">
<a
href={`#${method.id}`}
class="web-references-menu-link text-caption"
class:is-selected={method.id === selected}>{method.title}</a
>
</li>
{/each}
</ul>
{/if}
<div class="border-greyscale-900/4 web-u-padding-block-20 border-t">
<button class="web-link inline-flex items-center gap-2" use:scrollToTop>
<span class="web-icon-arrow-up" aria-hidden="true" />
Expand Down