Skip to content

sync docs with latest sdk release #433

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 2 commits into
base: main
Choose a base branch
from
Open

sync docs with latest sdk release #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5094f37
sync docs with latest sdk release
moeodeh3 Oct 1, 2025
be27cb3
fixed sdk-reference link, nuked old formatted directory
ethankonk Oct 1, 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
131 changes: 61 additions & 70 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@
"dark": "#050a0b"
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude"
]
"options": ["copy", "view", "chatgpt", "claude"]
},
"favicon": "/favicon.svg",
"navigation": {
Expand Down Expand Up @@ -207,10 +202,7 @@
},
{
"group": "Cookbook",
"pages": [
"cookbook/morpho",
"cookbook/aave"
]
"pages": ["cookbook/morpho", "cookbook/aave"]
}
]
},
Expand Down Expand Up @@ -396,66 +388,65 @@
{
"group": "SDK reference",
"pages": [
"generated-docs/formatted/core/turnkey-client-add-oauth-provider",
"generated-docs/formatted/core/turnkey-client-add-passkey",
"generated-docs/formatted/core/turnkey-client-clear-all-sessions",
"generated-docs/formatted/core/turnkey-client-clear-session",
"generated-docs/formatted/core/turnkey-client-clear-unused-key-pairs",
"generated-docs/formatted/core/turnkey-client-complete-oauth",
"generated-docs/formatted/core/turnkey-client-complete-otp",
"generated-docs/formatted/core/turnkey-client-connect-wallet-account",
"generated-docs/formatted/core/turnkey-client-constructor",
"generated-docs/formatted/core/turnkey-client-create-api-key-pair",
"generated-docs/formatted/core/turnkey-client-create-passkey",
"generated-docs/formatted/core/turnkey-client-create-wallet",
"generated-docs/formatted/core/turnkey-client-create-wallet-accounts",
"generated-docs/formatted/core/turnkey-client-delete-sub-organization",
"generated-docs/formatted/core/turnkey-client-disconnect-wallet-account",
"generated-docs/formatted/core/turnkey-client-export-private-key",
"generated-docs/formatted/core/turnkey-client-export-wallet",
"generated-docs/formatted/core/turnkey-client-export-wallet-account",
"generated-docs/formatted/core/turnkey-client-fetch-user",
"generated-docs/formatted/core/turnkey-client-fetch-wallet-accounts",
"generated-docs/formatted/core/turnkey-client-fetch-wallets",
"generated-docs/formatted/core/turnkey-client-get-active-session-key",
"generated-docs/formatted/core/turnkey-client-get-all-sessions",
"generated-docs/formatted/core/turnkey-client-get-proxy-auth-config",
"generated-docs/formatted/core/turnkey-client-get-session",
"generated-docs/formatted/core/turnkey-client-get-wallet-providers",
"generated-docs/formatted/core/turnkey-client-import-private-key",
"generated-docs/formatted/core/turnkey-client-import-wallet",
"generated-docs/formatted/core/turnkey-client-init",
"generated-docs/formatted/core/turnkey-client-init-otp",
"generated-docs/formatted/core/turnkey-client-login-or-signup-with-wallet",
"generated-docs/formatted/core/turnkey-client-login-with-oauth",
"generated-docs/formatted/core/turnkey-client-login-with-otp",
"generated-docs/formatted/core/turnkey-client-login-with-passkey",
"generated-docs/formatted/core/turnkey-client-login-with-wallet",
"generated-docs/formatted/core/turnkey-client-logout",
"generated-docs/formatted/core/turnkey-client-refresh-session",
"generated-docs/formatted/core/turnkey-client-remove-oauth-providers",
"generated-docs/formatted/core/turnkey-client-remove-passkeys",
"generated-docs/formatted/core/turnkey-client-remove-user-email",
"generated-docs/formatted/core/turnkey-client-remove-user-phone-number",
"generated-docs/formatted/core/turnkey-client-set-active-session",
"generated-docs/formatted/core/turnkey-client-sign-and-send-transaction",
"generated-docs/formatted/core/turnkey-client-sign-message",
"generated-docs/formatted/core/turnkey-client-sign-transaction",
"generated-docs/formatted/core/turnkey-client-sign-up-with-oauth",
"generated-docs/formatted/core/turnkey-client-sign-up-with-otp",
"generated-docs/formatted/core/turnkey-client-sign-up-with-passkey",
"generated-docs/formatted/core/turnkey-client-sign-up-with-wallet",
"generated-docs/formatted/core/turnkey-client-store-session",
"generated-docs/formatted/core/turnkey-client-switch-wallet-provider-chain",
"generated-docs/formatted/core/turnkey-client-update-user-email",
"generated-docs/formatted/core/turnkey-client-update-user-name",
"generated-docs/formatted/core/turnkey-client-update-user-phone-number",
"generated-docs/formatted/core/turnkey-client-verify-otp",
"generated-docs/formatted/core/turnkey-client-switch-wallet-account-chain",
"generated-docs/formatted/core/turnkey-client-fetch-private-keys",
"generated-docs/formatted/core/turnkey-client-fetch-or-create-p256-api-key-user",
"generated-docs/formatted/core/turnkey-client-fetch-or-create-policies",
"generated-docs/formatted/core/turnkey-client-fetch-wallet-providers"
"generated-docs/core/turnkey-client-add-oauth-provider",
Copy link
Contributor

@andrewkmin andrewkmin Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what are we gonna do with everything in https://github.com/tkhq/docs/tree/main/generated-docs/formatted ?

are we just nuking that namespace?

Copy link
Contributor

@andrewkmin andrewkmin Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also I'm noticing it's a bit hard to see the real diff here in terms of net new endpoints covered, existing endpoints deleted, etc. but will trust the tooling on this that there are no omissions

Copy link
Contributor

@ethankonk ethankonk Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, nuking the namespace now. I don't think that should cause any issues, will double check though

"generated-docs/core/turnkey-client-add-passkey",
"generated-docs/core/turnkey-client-clear-all-sessions",
"generated-docs/core/turnkey-client-clear-session",
"generated-docs/core/turnkey-client-clear-unused-key-pairs",
"generated-docs/core/turnkey-client-complete-oauth",
"generated-docs/core/turnkey-client-complete-otp",
"generated-docs/core/turnkey-client-connect-wallet-account",
"generated-docs/core/turnkey-client-constructor",
"generated-docs/core/turnkey-client-create-api-key-pair",
"generated-docs/core/turnkey-client-create-passkey",
"generated-docs/core/turnkey-client-create-wallet",
"generated-docs/core/turnkey-client-create-wallet-accounts",
"generated-docs/core/turnkey-client-delete-sub-organization",
"generated-docs/core/turnkey-client-disconnect-wallet-account",
"generated-docs/core/turnkey-client-export-private-key",
"generated-docs/core/turnkey-client-export-wallet",
"generated-docs/core/turnkey-client-export-wallet-account",
"generated-docs/core/turnkey-client-fetch-boot-proof-for-app-proof",
"generated-docs/core/turnkey-client-fetch-or-create-p256-api-key-user",
"generated-docs/core/turnkey-client-fetch-or-create-policies",
"generated-docs/core/turnkey-client-fetch-private-keys",
"generated-docs/core/turnkey-client-fetch-user",
"generated-docs/core/turnkey-client-fetch-wallet-accounts",
"generated-docs/core/turnkey-client-fetch-wallet-providers",
"generated-docs/core/turnkey-client-fetch-wallets",
"generated-docs/core/turnkey-client-get-active-session-key",
"generated-docs/core/turnkey-client-get-all-sessions",
"generated-docs/core/turnkey-client-get-proxy-auth-config",
"generated-docs/core/turnkey-client-get-session",
"generated-docs/core/turnkey-client-import-private-key",
"generated-docs/core/turnkey-client-import-wallet",
"generated-docs/core/turnkey-client-init",
"generated-docs/core/turnkey-client-init-otp",
"generated-docs/core/turnkey-client-login-or-signup-with-wallet",
"generated-docs/core/turnkey-client-login-with-oauth",
"generated-docs/core/turnkey-client-login-with-otp",
"generated-docs/core/turnkey-client-login-with-passkey",
"generated-docs/core/turnkey-client-login-with-wallet",
"generated-docs/core/turnkey-client-logout",
"generated-docs/core/turnkey-client-refresh-session",
"generated-docs/core/turnkey-client-remove-oauth-providers",
"generated-docs/core/turnkey-client-remove-passkeys",
"generated-docs/core/turnkey-client-remove-user-email",
"generated-docs/core/turnkey-client-remove-user-phone-number",
"generated-docs/core/turnkey-client-set-active-session",
"generated-docs/core/turnkey-client-sign-and-send-transaction",
"generated-docs/core/turnkey-client-sign-message",
"generated-docs/core/turnkey-client-sign-transaction",
"generated-docs/core/turnkey-client-sign-up-with-oauth",
"generated-docs/core/turnkey-client-sign-up-with-otp",
"generated-docs/core/turnkey-client-sign-up-with-passkey",
"generated-docs/core/turnkey-client-sign-up-with-wallet",
"generated-docs/core/turnkey-client-store-session",
"generated-docs/core/turnkey-client-switch-wallet-account-chain",
"generated-docs/core/turnkey-client-update-user-email",
"generated-docs/core/turnkey-client-update-user-name",
"generated-docs/core/turnkey-client-update-user-phone-number",
"generated-docs/core/turnkey-client-verify-otp"
]
}
]
Expand Down
7 changes: 5 additions & 2 deletions ...ore/turnkey-client-add-oauth-provider.mdx → ...ore/turnkey-client-add-oauth-provider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,17 @@ Adds an OAuth provider to the user.

<p><strong>Package:</strong> <code>core</code></p>

<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2982">core.ts:2982</a></p>
<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3135">__clients__/core.ts:3135</a></p>

<H3Bordered text="Parameters" />

<ParamField body="params" type='object' required={true} path="params" >
<ParamField body="params" type='AddOauthProviderParams' required={true} >
<Expandable title="params details">
<NestedParam parentKey="params" childKey="oidcToken" type='string' required={true}>
OIDC token for the OAuth provider.
</NestedParam>
<NestedParam parentKey="params" childKey="organizationId" type='string' required={false}>
organization ID to specify the sub-organization (defaults to the current session's organizationId).
</NestedParam>
<NestedParam parentKey="params" childKey="providerName" type='string' required={true}>
name of the OAuth provider to add (e.g., "Google", "Apple").
Expand Down
7 changes: 5 additions & 2 deletions ...atted/core/turnkey-client-add-passkey.mdx → ...-docs/core/turnkey-client-add-passkey.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,20 @@ Adds a new passkey authenticator for the user.

<p><strong>Package:</strong> <code>core</code></p>

<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3141">core.ts:3141</a></p>
<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3311">__clients__/core.ts:3311</a></p>

<H3Bordered text="Parameters" />

<ParamField body="params" type='object' required={false} path="params" >
<ParamField body="params" type='AddPasskeyParams' required={false} >
<Expandable title="params details">
<NestedParam parentKey="params" childKey="displayName" type='string' required={false}>
display name of the passkey (defaults to the value of `name`).
</NestedParam>
<NestedParam parentKey="params" childKey="name" type='string' required={false}>
name of the passkey (defaults to "Turnkey Passkey-`timestamp`").
</NestedParam>
<NestedParam parentKey="params" childKey="organizationId" type='string' required={false}>
organization ID to specify the sub-organization (defaults to the current session's organizationId).
</NestedParam>
<NestedParam parentKey="params" childKey="stampWith" type='StamperType' required={false}>
parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
Expand Down
2 changes: 1 addition & 1 deletion ...ore/turnkey-client-clear-all-sessions.mdx → ...ore/turnkey-client-clear-all-sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Clears all sessions and resets the active session state.

<p><strong>Package:</strong> <code>core</code></p>

<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3844">core.ts:3844</a></p>
<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L4080">__clients__/core.ts:4080</a></p>

<H3Bordered text="Parameters" />

Expand Down
4 changes: 2 additions & 2 deletions ...ted/core/turnkey-client-clear-session.mdx → ...ocs/core/turnkey-client-clear-session.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Clears the session associated with the specified session key, or the active sess

<p><strong>Package:</strong> <code>core</code></p>

<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3811">core.ts:3811</a></p>
<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L4047">__clients__/core.ts:4047</a></p>

<H3Bordered text="Parameters" />

<ParamField body="params" type='object' required={false} path="params" >
<ParamField body="params" type='ClearSessionParams' required={false} >
<Expandable title="params details">
<NestedParam parentKey="params" childKey="sessionKey" type='string' required={false}>
session key to clear the session under (defaults to the default session key).
Expand Down
2 changes: 1 addition & 1 deletion ...turnkey-client-clear-unused-key-pairs.mdx → ...turnkey-client-clear-unused-key-pairs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Clears any unused API key pairs from persistent storage.

<p><strong>Package:</strong> <code>core</code></p>

<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L4073">core.ts:4073</a></p>
<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L4305">__clients__/core.ts:4305</a></p>

<H3Bordered text="Parameters" />

Expand Down
44 changes: 42 additions & 2 deletions ...ed/core/turnkey-client-complete-oauth.mdx → ...cs/core/turnkey-client-complete-oauth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,55 @@ Completes the OAuth authentication flow by either signing up or logging in the u

<p><strong>Package:</strong> <code>core</code></p>

<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1528">core.ts:1528</a></p>
<p><strong>Defined in:</strong> <a href="https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1557">__clients__/core.ts:1557</a></p>

<H3Bordered text="Parameters" />

<ParamField body="params" type='object' required={true} path="params" >
<ParamField body="params" type='CompleteOauthParams' required={true} >
<Expandable title="params details">
<NestedParam parentKey="params" childKey="createSubOrgParams" type='CreateSubOrgParams' required={false}>
parameters for sub-organization creation (e.g., authenticators, user metadata).
</NestedParam>
<Expandable title="createSubOrgParams details">
<NestedParam parentKey="params.createSubOrgParams" childKey="apiKeys" type='object[]' required={false}>
list of api keys
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="authenticators" type='object[]' required={false}>
list of authenticators
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="customWallet" type='CustomWallet' required={false}>
custom wallets to create during sub-org creation time
</NestedParam>
<Expandable title="customWallet details">
<NestedParam parentKey="params.createSubOrgParams.customWallet" childKey="walletAccounts" type='v1WalletAccountParams[]' required={true}>
list of wallet accounts to create
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams.customWallet" childKey="walletName" type='string' required={true}>
name of the wallet created
</NestedParam>
</Expandable>
<NestedParam parentKey="params.createSubOrgParams" childKey="oauthProviders" type='Provider[]' required={false}>
list of oauth providers
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="subOrgName" type='string' required={false}>
name of the sub-organization
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="userEmail" type='string' required={false}>
email of the user
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="userName" type='string' required={false}>
name of the user
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="userPhoneNumber" type='string' required={false}>
phone number of the user
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="userTag" type='string' required={false}>
tag of the user
</NestedParam>
<NestedParam parentKey="params.createSubOrgParams" childKey="verificationToken" type='string' required={false}>
verification token if email or phone number is provided
</NestedParam>
</Expandable>
<NestedParam parentKey="params" childKey="invalidateExisting" type='boolean' required={false}>
flag to invalidate existing sessions for the user.
</NestedParam>
Expand Down
Loading