@privy-io/api-types 0.9.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +46 -0
- package/client.d.mts +40 -43
- package/client.d.mts.map +1 -1
- package/client.d.ts +40 -43
- package/client.d.ts.map +1 -1
- package/client.js +28 -20
- package/client.js.map +1 -1
- package/client.mjs +29 -21
- package/client.mjs.map +1 -1
- package/internal/types.d.mts +6 -6
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +6 -6
- package/internal/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/accounts.d.mts +128 -86
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +128 -86
- package/resources/accounts.d.ts.map +1 -1
- package/resources/aggregations.d.mts +43 -43
- package/resources/aggregations.d.mts.map +1 -1
- package/resources/aggregations.d.ts +43 -43
- package/resources/aggregations.d.ts.map +1 -1
- package/resources/apps.d.mts +169 -135
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +169 -135
- package/resources/apps.d.ts.map +1 -1
- package/resources/client-auth.d.mts +931 -947
- package/resources/client-auth.d.mts.map +1 -1
- package/resources/client-auth.d.ts +931 -947
- package/resources/client-auth.d.ts.map +1 -1
- package/resources/client-auth.js.map +1 -1
- package/resources/client-auth.mjs.map +1 -1
- package/resources/embedded-wallets.d.mts +122 -122
- package/resources/embedded-wallets.d.mts.map +1 -1
- package/resources/embedded-wallets.d.ts +122 -122
- package/resources/embedded-wallets.d.ts.map +1 -1
- package/resources/fiat.d.mts +110 -0
- package/resources/fiat.d.mts.map +1 -0
- package/resources/fiat.d.ts +110 -0
- package/resources/fiat.d.ts.map +1 -0
- package/resources/fiat.js +9 -0
- package/resources/fiat.js.map +1 -0
- package/resources/fiat.mjs +5 -0
- package/resources/fiat.mjs.map +1 -0
- package/resources/funding.d.mts +86 -86
- package/resources/funding.d.mts.map +1 -1
- package/resources/funding.d.ts +86 -86
- package/resources/funding.d.ts.map +1 -1
- package/resources/index.d.mts +20 -18
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +20 -18
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -1
- package/resources/index.mjs.map +1 -1
- package/resources/intents.d.mts +269 -265
- package/resources/intents.d.mts.map +1 -1
- package/resources/intents.d.ts +269 -265
- package/resources/intents.d.ts.map +1 -1
- package/resources/key-quorums.d.mts +15 -146
- package/resources/key-quorums.d.mts.map +1 -1
- package/resources/key-quorums.d.ts +15 -146
- package/resources/key-quorums.d.ts.map +1 -1
- package/resources/key-quorums.js +0 -92
- package/resources/key-quorums.js.map +1 -1
- package/resources/key-quorums.mjs +0 -92
- package/resources/key-quorums.mjs.map +1 -1
- package/resources/kraken-embed.d.mts +12 -20
- package/resources/kraken-embed.d.mts.map +1 -1
- package/resources/kraken-embed.d.ts +12 -20
- package/resources/kraken-embed.d.ts.map +1 -1
- package/resources/organizations.d.mts +65 -0
- package/resources/organizations.d.mts.map +1 -0
- package/resources/organizations.d.ts +65 -0
- package/resources/organizations.d.ts.map +1 -0
- package/resources/organizations.js +9 -0
- package/resources/organizations.js.map +1 -0
- package/resources/organizations.mjs +5 -0
- package/resources/organizations.mjs.map +1 -0
- package/resources/policies.d.mts +261 -553
- package/resources/policies.d.mts.map +1 -1
- package/resources/policies.d.ts +261 -553
- package/resources/policies.d.ts.map +1 -1
- package/resources/policies.js +0 -229
- package/resources/policies.js.map +1 -1
- package/resources/policies.mjs +0 -229
- package/resources/policies.mjs.map +1 -1
- package/resources/shared.d.mts +28 -28
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +28 -28
- package/resources/shared.d.ts.map +1 -1
- package/resources/swaps.d.mts +6 -9
- package/resources/swaps.d.mts.map +1 -1
- package/resources/swaps.d.ts +6 -9
- package/resources/swaps.d.ts.map +1 -1
- package/resources/swaps.js.map +1 -1
- package/resources/swaps.mjs.map +1 -1
- package/resources/transactions.d.mts +80 -96
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts +80 -96
- package/resources/transactions.d.ts.map +1 -1
- package/resources/transactions.js +0 -17
- package/resources/transactions.js.map +1 -1
- package/resources/transactions.mjs +0 -17
- package/resources/transactions.mjs.map +1 -1
- package/resources/users.d.mts +480 -815
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +480 -815
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +0 -272
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +0 -272
- package/resources/users.mjs.map +1 -1
- package/resources/wallet-actions.d.mts +302 -145
- package/resources/wallet-actions.d.mts.map +1 -1
- package/resources/wallet-actions.d.ts +302 -145
- package/resources/wallet-actions.d.ts.map +1 -1
- package/resources/wallets/index.d.mts +1 -1
- package/resources/wallets/index.d.mts.map +1 -1
- package/resources/wallets/index.d.ts +1 -1
- package/resources/wallets/index.d.ts.map +1 -1
- package/resources/wallets/index.js.map +1 -1
- package/resources/wallets/index.mjs.map +1 -1
- package/resources/wallets/transactions.d.mts +7 -2
- package/resources/wallets/transactions.d.mts.map +1 -1
- package/resources/wallets/transactions.d.ts +7 -2
- package/resources/wallets/transactions.d.ts.map +1 -1
- package/resources/wallets/transactions.js +1 -1
- package/resources/wallets/transactions.mjs +1 -1
- package/resources/wallets/wallets.d.mts +1592 -1580
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +1592 -1580
- package/resources/wallets/wallets.d.ts.map +1 -1
- package/resources/wallets/wallets.js +45 -103
- package/resources/wallets/wallets.js.map +1 -1
- package/resources/wallets/wallets.mjs +45 -103
- package/resources/wallets/wallets.mjs.map +1 -1
- package/resources/webhooks.d.mts +935 -877
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +935 -877
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/yield.d.mts +157 -157
- package/resources/yield.d.mts.map +1 -1
- package/resources/yield.d.ts +157 -157
- package/resources/yield.d.ts.map +1 -1
- package/src/client.ts +650 -618
- package/src/internal/types.ts +6 -8
- package/src/resources/accounts.ts +157 -103
- package/src/resources/aggregations.ts +55 -55
- package/src/resources/apps.ts +221 -178
- package/src/resources/client-auth.ts +1271 -1315
- package/src/resources/embedded-wallets.ts +160 -160
- package/src/resources/fiat.ts +177 -0
- package/src/resources/funding.ts +130 -130
- package/src/resources/index.ts +551 -542
- package/src/resources/intents.ts +326 -322
- package/src/resources/key-quorums.ts +16 -218
- package/src/resources/kraken-embed.ts +14 -22
- package/src/resources/organizations.ts +82 -0
- package/src/resources/policies.ts +383 -848
- package/src/resources/shared.ts +34 -34
- package/src/resources/swaps.ts +5 -10
- package/src/resources/transactions.ts +116 -136
- package/src/resources/users.ts +693 -1160
- package/src/resources/wallet-actions.ts +392 -185
- package/src/resources/wallets/index.ts +160 -156
- package/src/resources/wallets/transactions.ts +18 -3
- package/src/resources/wallets/wallets.ts +2123 -2113
- package/src/resources/webhooks.ts +1172 -1100
- package/src/resources/yield.ts +188 -188
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
package/src/resources/users.ts
CHANGED
|
@@ -4,324 +4,53 @@ import { APIResource } from '../core/resource';
|
|
|
4
4
|
import * as UsersAPI from './users';
|
|
5
5
|
import * as ClientAuthAPI from './client-auth';
|
|
6
6
|
import * as EmbeddedWalletsAPI from './embedded-wallets';
|
|
7
|
-
import * as SharedAPI from './shared';
|
|
8
7
|
import * as WalletsAPI from './wallets/wallets';
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
import { buildHeaders } from '../internal/headers';
|
|
12
|
-
import { RequestOptions } from '../internal/request-options';
|
|
13
|
-
import { path } from '../internal/utils/path';
|
|
8
|
+
|
|
9
|
+
export class Users extends APIResource {}
|
|
14
10
|
|
|
15
11
|
/**
|
|
16
|
-
*
|
|
12
|
+
* The authenticated user.
|
|
17
13
|
*/
|
|
18
|
-
export
|
|
19
|
-
|
|
20
|
-
* Create a new user with linked accounts. Optionally pre-generate embedded wallets
|
|
21
|
-
* for the user.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```ts
|
|
25
|
-
* const user = await client.users.create({
|
|
26
|
-
* linked_accounts: [
|
|
27
|
-
* { address: 'tom.bombadill@privy.io', type: 'email' },
|
|
28
|
-
* ],
|
|
29
|
-
* });
|
|
30
|
-
* ```
|
|
31
|
-
*/
|
|
32
|
-
create(body: UserCreateParams, options?: RequestOptions): APIPromise<User> {
|
|
33
|
-
return this._client.post('/v1/users', { body, ...options });
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Get all users in your app.
|
|
38
|
-
*
|
|
39
|
-
* @example
|
|
40
|
-
* ```ts
|
|
41
|
-
* // Automatically fetches more pages as needed.
|
|
42
|
-
* for await (const user of client.users.list()) {
|
|
43
|
-
* // ...
|
|
44
|
-
* }
|
|
45
|
-
* ```
|
|
46
|
-
*/
|
|
47
|
-
list(
|
|
48
|
-
query: UserListParams | null | undefined = {},
|
|
49
|
-
options?: RequestOptions,
|
|
50
|
-
): PagePromise<UsersCursor, User> {
|
|
51
|
-
return this._client.getAPIList('/v1/users', Cursor<User>, { query, ...options });
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
/**
|
|
55
|
-
* Delete a user by user ID.
|
|
56
|
-
*
|
|
57
|
-
* @example
|
|
58
|
-
* ```ts
|
|
59
|
-
* await client.users.delete('user_id');
|
|
60
|
-
* ```
|
|
61
|
-
*/
|
|
62
|
-
delete(userID: string, options?: RequestOptions): APIPromise<void> {
|
|
63
|
-
return this._client.delete(path`/v1/users/${userID}`, {
|
|
64
|
-
...options,
|
|
65
|
-
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
66
|
-
});
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* Get a user by user ID.
|
|
71
|
-
*
|
|
72
|
-
* @example
|
|
73
|
-
* ```ts
|
|
74
|
-
* const user = await client.users._get('user_id');
|
|
75
|
-
* ```
|
|
76
|
-
*/
|
|
77
|
-
_get(userID: string, options?: RequestOptions): APIPromise<User> {
|
|
78
|
-
return this._client.get(path`/v1/users/${userID}`, options);
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Looks up a user by their custom auth ID.
|
|
83
|
-
*
|
|
84
|
-
* @example
|
|
85
|
-
* ```ts
|
|
86
|
-
* const user = await client.users.getByCustomAuthID({
|
|
87
|
-
* custom_user_id: 'custom_user_id',
|
|
88
|
-
* });
|
|
89
|
-
* ```
|
|
90
|
-
*/
|
|
91
|
-
getByCustomAuthID(body: UserGetByCustomAuthIDParams, options?: RequestOptions): APIPromise<User> {
|
|
92
|
-
return this._client.post('/v1/users/custom_auth/id', { body, ...options });
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
/**
|
|
96
|
-
* Looks up a user by their Discord username.
|
|
97
|
-
*
|
|
98
|
-
* @example
|
|
99
|
-
* ```ts
|
|
100
|
-
* const user = await client.users.getByDiscordUsername({
|
|
101
|
-
* username: 'username',
|
|
102
|
-
* });
|
|
103
|
-
* ```
|
|
104
|
-
*/
|
|
105
|
-
getByDiscordUsername(body: UserGetByDiscordUsernameParams, options?: RequestOptions): APIPromise<User> {
|
|
106
|
-
return this._client.post('/v1/users/discord/username', { body, ...options });
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
/**
|
|
110
|
-
* Looks up a user by their email address.
|
|
111
|
-
*
|
|
112
|
-
* @example
|
|
113
|
-
* ```ts
|
|
114
|
-
* const user = await client.users.getByEmailAddress({
|
|
115
|
-
* address: 'dev@stainless.com',
|
|
116
|
-
* });
|
|
117
|
-
* ```
|
|
118
|
-
*/
|
|
119
|
-
getByEmailAddress(body: UserGetByEmailAddressParams, options?: RequestOptions): APIPromise<User> {
|
|
120
|
-
return this._client.post('/v1/users/email/address', { body, ...options });
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
/**
|
|
124
|
-
* Looks up a user by their Farcaster ID.
|
|
125
|
-
*
|
|
126
|
-
* @example
|
|
127
|
-
* ```ts
|
|
128
|
-
* const user = await client.users.getByFarcasterID({
|
|
129
|
-
* fid: 0,
|
|
130
|
-
* });
|
|
131
|
-
* ```
|
|
132
|
-
*/
|
|
133
|
-
getByFarcasterID(body: UserGetByFarcasterIDParams, options?: RequestOptions): APIPromise<User> {
|
|
134
|
-
return this._client.post('/v1/users/farcaster/fid', { body, ...options });
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Looks up a user by their Github username.
|
|
139
|
-
*
|
|
140
|
-
* @example
|
|
141
|
-
* ```ts
|
|
142
|
-
* const user = await client.users.getByGitHubUsername({
|
|
143
|
-
* username: 'username',
|
|
144
|
-
* });
|
|
145
|
-
* ```
|
|
146
|
-
*/
|
|
147
|
-
getByGitHubUsername(body: UserGetByGitHubUsernameParams, options?: RequestOptions): APIPromise<User> {
|
|
148
|
-
return this._client.post('/v1/users/github/username', { body, ...options });
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* Looks up a user by their phone number.
|
|
153
|
-
*
|
|
154
|
-
* @example
|
|
155
|
-
* ```ts
|
|
156
|
-
* const user = await client.users.getByPhoneNumber({
|
|
157
|
-
* number: 'number',
|
|
158
|
-
* });
|
|
159
|
-
* ```
|
|
160
|
-
*/
|
|
161
|
-
getByPhoneNumber(body: UserGetByPhoneNumberParams, options?: RequestOptions): APIPromise<User> {
|
|
162
|
-
return this._client.post('/v1/users/phone/number', { body, ...options });
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
/**
|
|
166
|
-
* Looks up a user by their smart wallet address.
|
|
167
|
-
*
|
|
168
|
-
* @example
|
|
169
|
-
* ```ts
|
|
170
|
-
* const user = await client.users.getBySmartWalletAddress({
|
|
171
|
-
* address: 'address',
|
|
172
|
-
* });
|
|
173
|
-
* ```
|
|
174
|
-
*/
|
|
175
|
-
getBySmartWalletAddress(
|
|
176
|
-
body: UserGetBySmartWalletAddressParams,
|
|
177
|
-
options?: RequestOptions,
|
|
178
|
-
): APIPromise<User> {
|
|
179
|
-
return this._client.post('/v1/users/smart_wallet/address', { body, ...options });
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
/**
|
|
183
|
-
* Looks up a user by their Telegram user ID.
|
|
184
|
-
*
|
|
185
|
-
* @example
|
|
186
|
-
* ```ts
|
|
187
|
-
* const user = await client.users.getByTelegramUserID({
|
|
188
|
-
* telegram_user_id: 'telegram_user_id',
|
|
189
|
-
* });
|
|
190
|
-
* ```
|
|
191
|
-
*/
|
|
192
|
-
getByTelegramUserID(body: UserGetByTelegramUserIDParams, options?: RequestOptions): APIPromise<User> {
|
|
193
|
-
return this._client.post('/v1/users/telegram/telegram_user_id', { body, ...options });
|
|
194
|
-
}
|
|
14
|
+
export interface AuthenticatedUser {
|
|
15
|
+
token: string | null;
|
|
195
16
|
|
|
196
|
-
|
|
197
|
-
* Looks up a user by their Telegram username.
|
|
198
|
-
*
|
|
199
|
-
* @example
|
|
200
|
-
* ```ts
|
|
201
|
-
* const user = await client.users.getByTelegramUsername({
|
|
202
|
-
* username: 'username',
|
|
203
|
-
* });
|
|
204
|
-
* ```
|
|
205
|
-
*/
|
|
206
|
-
getByTelegramUsername(body: UserGetByTelegramUsernameParams, options?: RequestOptions): APIPromise<User> {
|
|
207
|
-
return this._client.post('/v1/users/telegram/username', { body, ...options });
|
|
208
|
-
}
|
|
17
|
+
privy_access_token: string | null;
|
|
209
18
|
|
|
210
|
-
|
|
211
|
-
* Looks up a user by their Twitter subject.
|
|
212
|
-
*
|
|
213
|
-
* @example
|
|
214
|
-
* ```ts
|
|
215
|
-
* const user = await client.users.getByTwitterSubject({
|
|
216
|
-
* subject: 'subject',
|
|
217
|
-
* });
|
|
218
|
-
* ```
|
|
219
|
-
*/
|
|
220
|
-
getByTwitterSubject(body: UserGetByTwitterSubjectParams, options?: RequestOptions): APIPromise<User> {
|
|
221
|
-
return this._client.post('/v1/users/twitter/subject', { body, ...options });
|
|
222
|
-
}
|
|
19
|
+
refresh_token: string | null;
|
|
223
20
|
|
|
224
21
|
/**
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
* @example
|
|
228
|
-
* ```ts
|
|
229
|
-
* const user = await client.users.getByTwitterUsername({
|
|
230
|
-
* username: 'username',
|
|
231
|
-
* });
|
|
232
|
-
* ```
|
|
22
|
+
* Instructs the client on how to handle tokens received
|
|
233
23
|
*/
|
|
234
|
-
|
|
235
|
-
return this._client.post('/v1/users/twitter/username', { body, ...options });
|
|
236
|
-
}
|
|
24
|
+
session_update_action: 'set' | 'ignore' | 'clear';
|
|
237
25
|
|
|
238
26
|
/**
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
* @example
|
|
242
|
-
* ```ts
|
|
243
|
-
* const user = await client.users.getByWalletAddress({
|
|
244
|
-
* address: 'address',
|
|
245
|
-
* });
|
|
246
|
-
* ```
|
|
27
|
+
* A Privy user object.
|
|
247
28
|
*/
|
|
248
|
-
|
|
249
|
-
return this._client.post('/v1/users/wallet/address', { body, ...options });
|
|
250
|
-
}
|
|
29
|
+
user: User;
|
|
251
30
|
|
|
252
|
-
|
|
253
|
-
* Creates an embedded wallet for an existing user.
|
|
254
|
-
*
|
|
255
|
-
* @example
|
|
256
|
-
* ```ts
|
|
257
|
-
* const user = await client.users.pregenerateWallets(
|
|
258
|
-
* 'user_id',
|
|
259
|
-
* { wallets: [{ chain_type: 'ethereum' }] },
|
|
260
|
-
* );
|
|
261
|
-
* ```
|
|
262
|
-
*/
|
|
263
|
-
pregenerateWallets(
|
|
264
|
-
userID: string,
|
|
265
|
-
body: UserPregenerateWalletsParams,
|
|
266
|
-
options?: RequestOptions,
|
|
267
|
-
): APIPromise<User> {
|
|
268
|
-
return this._client.post(path`/v1/users/${userID}/wallets`, { body, ...options });
|
|
269
|
-
}
|
|
31
|
+
identity_token?: string;
|
|
270
32
|
|
|
271
|
-
|
|
272
|
-
* Search users by search term, emails, phone numbers, or wallet addresses.
|
|
273
|
-
*
|
|
274
|
-
* @example
|
|
275
|
-
* ```ts
|
|
276
|
-
* const user = await client.users.search({
|
|
277
|
-
* searchTerm: 'searchTerm',
|
|
278
|
-
* });
|
|
279
|
-
* ```
|
|
280
|
-
*/
|
|
281
|
-
search(body: UserSearchParams, options?: RequestOptions): APIPromise<User> {
|
|
282
|
-
return this._client.post('/v1/users/search', { body, ...options });
|
|
283
|
-
}
|
|
33
|
+
is_new_user?: boolean;
|
|
284
34
|
|
|
285
35
|
/**
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
* @example
|
|
289
|
-
* ```ts
|
|
290
|
-
* const user = await client.users.setCustomMetadata(
|
|
291
|
-
* 'user_id',
|
|
292
|
-
* { custom_metadata: { key: 'value' } },
|
|
293
|
-
* );
|
|
294
|
-
* ```
|
|
36
|
+
* OAuth tokens associated with the user.
|
|
295
37
|
*/
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
body: UserSetCustomMetadataParams,
|
|
299
|
-
options?: RequestOptions,
|
|
300
|
-
): APIPromise<User> {
|
|
301
|
-
return this._client.post(path`/v1/users/${userID}/custom_metadata`, { body, ...options });
|
|
302
|
-
}
|
|
38
|
+
oauth_tokens?: OAuthTokens;
|
|
39
|
+
}
|
|
303
40
|
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
* const user = await client.users.unlinkLinkedAccount(
|
|
310
|
-
* 'user_id',
|
|
311
|
-
* { handle: 'test@test.com', type: 'email' },
|
|
312
|
-
* );
|
|
313
|
-
* ```
|
|
314
|
-
*/
|
|
315
|
-
unlinkLinkedAccount(
|
|
316
|
-
userID: string,
|
|
317
|
-
body: UserUnlinkLinkedAccountParams,
|
|
318
|
-
options?: RequestOptions,
|
|
319
|
-
): APIPromise<User> {
|
|
320
|
-
return this._client.post(path`/v1/users/${userID}/accounts/unlink`, { body, ...options });
|
|
321
|
-
}
|
|
41
|
+
/**
|
|
42
|
+
* An embedded wallet associated with a cross-app account.
|
|
43
|
+
*/
|
|
44
|
+
export interface CrossAppEmbeddedWallet {
|
|
45
|
+
address: string;
|
|
322
46
|
}
|
|
323
47
|
|
|
324
|
-
|
|
48
|
+
/**
|
|
49
|
+
* A smart wallet associated with a cross-app account.
|
|
50
|
+
*/
|
|
51
|
+
export interface CrossAppSmartWallet {
|
|
52
|
+
address: string;
|
|
53
|
+
}
|
|
325
54
|
|
|
326
55
|
/**
|
|
327
56
|
* Custom metadata associated with the user.
|
|
@@ -329,215 +58,245 @@ export type UsersCursor = Cursor<User>;
|
|
|
329
58
|
export type CustomMetadata = { [key: string]: string | number | boolean };
|
|
330
59
|
|
|
331
60
|
/**
|
|
332
|
-
* The
|
|
61
|
+
* The method used to recover an embedded wallet account.
|
|
333
62
|
*/
|
|
334
|
-
export
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
63
|
+
export type EmbeddedWalletRecoveryMethod =
|
|
64
|
+
| 'privy'
|
|
65
|
+
| 'user-passcode'
|
|
66
|
+
| 'google-drive'
|
|
67
|
+
| 'icloud'
|
|
68
|
+
| 'recovery-encryption-key'
|
|
69
|
+
| 'privy-v2';
|
|
341
70
|
|
|
342
71
|
/**
|
|
343
|
-
*
|
|
72
|
+
* A linked account for the user.
|
|
344
73
|
*/
|
|
345
|
-
export
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
74
|
+
export type LinkedAccount =
|
|
75
|
+
| LinkedAccountEmail
|
|
76
|
+
| LinkedAccountPhone
|
|
77
|
+
| LinkedAccountEthereum
|
|
78
|
+
| LinkedAccountSolana
|
|
79
|
+
| LinkedAccountSmartWallet
|
|
80
|
+
| LinkedAccountEthereumEmbeddedWallet
|
|
81
|
+
| LinkedAccountSolanaEmbeddedWallet
|
|
82
|
+
| LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
83
|
+
| LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
84
|
+
| LinkedAccountCurveSigningEmbeddedWallet
|
|
85
|
+
| LinkedAccountGoogleOAuth
|
|
86
|
+
| LinkedAccountTwitterOAuth
|
|
87
|
+
| LinkedAccountDiscordOAuth
|
|
88
|
+
| LinkedAccountGitHubOAuth
|
|
89
|
+
| LinkedAccountSpotifyOAuth
|
|
90
|
+
| LinkedAccountInstagramOAuth
|
|
91
|
+
| LinkedAccountTiktokOAuth
|
|
92
|
+
| LinkedAccountLineOAuth
|
|
93
|
+
| LinkedAccountTwitchOAuth
|
|
94
|
+
| LinkedAccountLinkedInOAuth
|
|
95
|
+
| LinkedAccountAppleOAuth
|
|
96
|
+
| LinkedAccountCustomOAuth
|
|
97
|
+
| LinkedAccountCustomJwt
|
|
98
|
+
| LinkedAccountFarcaster
|
|
99
|
+
| LinkedAccountPasskey
|
|
100
|
+
| LinkedAccountTelegram
|
|
101
|
+
| LinkedAccountCrossApp
|
|
102
|
+
| LinkedAccountAuthorizationKey;
|
|
350
103
|
|
|
351
104
|
/**
|
|
352
|
-
* The payload for importing
|
|
105
|
+
* The payload for importing an Apple account.
|
|
353
106
|
*/
|
|
354
|
-
export interface
|
|
355
|
-
|
|
107
|
+
export interface LinkedAccountAppleInput {
|
|
108
|
+
subject: string;
|
|
356
109
|
|
|
357
|
-
type: '
|
|
110
|
+
type: 'apple_oauth';
|
|
111
|
+
|
|
112
|
+
email?: string;
|
|
358
113
|
}
|
|
359
114
|
|
|
360
115
|
/**
|
|
361
|
-
*
|
|
116
|
+
* An Apple OAuth account linked to the user.
|
|
362
117
|
*/
|
|
363
|
-
export interface
|
|
364
|
-
email: string;
|
|
118
|
+
export interface LinkedAccountAppleOAuth {
|
|
119
|
+
email: string | null;
|
|
365
120
|
|
|
366
|
-
|
|
121
|
+
first_verified_at: number | null;
|
|
122
|
+
|
|
123
|
+
latest_verified_at: number | null;
|
|
367
124
|
|
|
368
125
|
subject: string;
|
|
369
126
|
|
|
370
|
-
type: '
|
|
127
|
+
type: 'apple_oauth';
|
|
128
|
+
|
|
129
|
+
verified_at: number;
|
|
371
130
|
}
|
|
372
131
|
|
|
373
132
|
/**
|
|
374
|
-
*
|
|
133
|
+
* An authorization key linked to the user.
|
|
375
134
|
*/
|
|
376
|
-
export interface
|
|
377
|
-
|
|
135
|
+
export interface LinkedAccountAuthorizationKey {
|
|
136
|
+
first_verified_at: number | null;
|
|
378
137
|
|
|
379
|
-
|
|
138
|
+
latest_verified_at: number | null;
|
|
380
139
|
|
|
381
|
-
|
|
140
|
+
public_key: string;
|
|
382
141
|
|
|
383
|
-
|
|
142
|
+
type: 'authorization_key';
|
|
384
143
|
|
|
385
|
-
|
|
144
|
+
verified_at: number;
|
|
386
145
|
}
|
|
387
146
|
|
|
388
147
|
/**
|
|
389
|
-
*
|
|
148
|
+
* Base schema for wallet accounts linked to the user.
|
|
390
149
|
*/
|
|
391
|
-
export interface
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
type: 'discord_oauth';
|
|
150
|
+
export interface LinkedAccountBaseWallet {
|
|
151
|
+
address: string;
|
|
395
152
|
|
|
396
|
-
|
|
153
|
+
chain_type: 'solana' | 'ethereum';
|
|
397
154
|
|
|
398
|
-
|
|
155
|
+
type: 'wallet' | 'smart_wallet';
|
|
399
156
|
}
|
|
400
157
|
|
|
401
158
|
/**
|
|
402
|
-
*
|
|
159
|
+
* A Bitcoin SegWit embedded wallet account linked to the user.
|
|
403
160
|
*/
|
|
404
|
-
export interface
|
|
405
|
-
|
|
161
|
+
export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
|
|
162
|
+
id: string | null;
|
|
406
163
|
|
|
407
|
-
|
|
164
|
+
address: string;
|
|
408
165
|
|
|
409
|
-
|
|
166
|
+
chain_id: string;
|
|
410
167
|
|
|
411
|
-
|
|
168
|
+
chain_type: 'bitcoin-segwit';
|
|
412
169
|
|
|
413
|
-
|
|
414
|
-
}
|
|
170
|
+
connector_type: 'embedded';
|
|
415
171
|
|
|
416
|
-
|
|
417
|
-
* The payload for importing a Spotify account.
|
|
418
|
-
*/
|
|
419
|
-
export interface LinkedAccountSpotifyInput {
|
|
420
|
-
subject: string;
|
|
172
|
+
delegated: boolean;
|
|
421
173
|
|
|
422
|
-
|
|
174
|
+
first_verified_at: number | null;
|
|
423
175
|
|
|
424
|
-
|
|
176
|
+
imported: boolean;
|
|
425
177
|
|
|
426
|
-
|
|
427
|
-
}
|
|
178
|
+
latest_verified_at: number | null;
|
|
428
179
|
|
|
429
|
-
|
|
430
|
-
* The payload for importing an Instagram account.
|
|
431
|
-
*/
|
|
432
|
-
export interface LinkedAccountInstagramInput {
|
|
433
|
-
subject: string;
|
|
180
|
+
public_key: string;
|
|
434
181
|
|
|
435
|
-
|
|
182
|
+
/**
|
|
183
|
+
* The method used to recover an embedded wallet account.
|
|
184
|
+
*/
|
|
185
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
436
186
|
|
|
437
|
-
|
|
187
|
+
type: 'wallet';
|
|
188
|
+
|
|
189
|
+
verified_at: number;
|
|
190
|
+
|
|
191
|
+
wallet_client: 'privy';
|
|
192
|
+
|
|
193
|
+
wallet_client_type: 'privy';
|
|
194
|
+
|
|
195
|
+
wallet_index: number;
|
|
438
196
|
}
|
|
439
197
|
|
|
440
198
|
/**
|
|
441
|
-
*
|
|
199
|
+
* A Bitcoin Taproot embedded wallet account linked to the user.
|
|
442
200
|
*/
|
|
443
|
-
export interface
|
|
444
|
-
|
|
201
|
+
export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
|
|
202
|
+
id: string | null;
|
|
445
203
|
|
|
446
|
-
|
|
204
|
+
address: string;
|
|
205
|
+
|
|
206
|
+
chain_id: string;
|
|
207
|
+
|
|
208
|
+
chain_type: 'bitcoin-taproot';
|
|
209
|
+
|
|
210
|
+
connector_type: 'embedded';
|
|
211
|
+
|
|
212
|
+
delegated: boolean;
|
|
447
213
|
|
|
448
|
-
|
|
214
|
+
first_verified_at: number | null;
|
|
449
215
|
|
|
450
|
-
|
|
451
|
-
}
|
|
216
|
+
imported: boolean;
|
|
452
217
|
|
|
453
|
-
|
|
454
|
-
* The payload for importing a LINE account.
|
|
455
|
-
*/
|
|
456
|
-
export interface LinkedAccountLineInput {
|
|
457
|
-
subject: string;
|
|
218
|
+
latest_verified_at: number | null;
|
|
458
219
|
|
|
459
|
-
|
|
220
|
+
public_key: string;
|
|
460
221
|
|
|
461
|
-
|
|
222
|
+
/**
|
|
223
|
+
* The method used to recover an embedded wallet account.
|
|
224
|
+
*/
|
|
225
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
462
226
|
|
|
463
|
-
|
|
227
|
+
type: 'wallet';
|
|
464
228
|
|
|
465
|
-
|
|
466
|
-
}
|
|
229
|
+
verified_at: number;
|
|
467
230
|
|
|
468
|
-
|
|
469
|
-
* The payload for importing a Twitch account.
|
|
470
|
-
*/
|
|
471
|
-
export interface LinkedAccountTwitchInput {
|
|
472
|
-
subject: string;
|
|
231
|
+
wallet_client: 'privy';
|
|
473
232
|
|
|
474
|
-
|
|
233
|
+
wallet_client_type: 'privy';
|
|
475
234
|
|
|
476
|
-
|
|
235
|
+
wallet_index: number;
|
|
477
236
|
}
|
|
478
237
|
|
|
479
238
|
/**
|
|
480
|
-
*
|
|
239
|
+
* A cross-app account linked to the user.
|
|
481
240
|
*/
|
|
482
|
-
export interface
|
|
483
|
-
|
|
241
|
+
export interface LinkedAccountCrossApp {
|
|
242
|
+
embedded_wallets: Array<CrossAppEmbeddedWallet>;
|
|
484
243
|
|
|
485
|
-
|
|
244
|
+
first_verified_at: number | null;
|
|
486
245
|
|
|
487
|
-
|
|
488
|
-
}
|
|
246
|
+
latest_verified_at: number | null;
|
|
489
247
|
|
|
490
|
-
|
|
491
|
-
* The payload for importing a LinkedIn account.
|
|
492
|
-
*/
|
|
493
|
-
export interface LinkedAccountLinkedInInput {
|
|
494
|
-
subject: string;
|
|
248
|
+
provider_app_id: string;
|
|
495
249
|
|
|
496
|
-
|
|
250
|
+
smart_wallets: Array<CrossAppSmartWallet>;
|
|
497
251
|
|
|
498
|
-
|
|
252
|
+
subject: string;
|
|
499
253
|
|
|
500
|
-
|
|
254
|
+
type: 'cross_app';
|
|
501
255
|
|
|
502
|
-
|
|
256
|
+
verified_at: number;
|
|
503
257
|
}
|
|
504
258
|
|
|
505
259
|
/**
|
|
506
|
-
*
|
|
260
|
+
* A curve signing embedded wallet account linked to the user.
|
|
507
261
|
*/
|
|
508
|
-
export interface
|
|
509
|
-
|
|
262
|
+
export interface LinkedAccountCurveSigningEmbeddedWallet {
|
|
263
|
+
id: string | null;
|
|
510
264
|
|
|
511
|
-
|
|
265
|
+
address: string;
|
|
512
266
|
|
|
513
|
-
|
|
267
|
+
chain_id: string;
|
|
514
268
|
|
|
515
|
-
|
|
269
|
+
/**
|
|
270
|
+
* The wallet chain types that support curve-based signing.
|
|
271
|
+
*/
|
|
272
|
+
chain_type: WalletsAPI.CurveSigningChainType;
|
|
516
273
|
|
|
517
|
-
|
|
274
|
+
connector_type: 'embedded';
|
|
518
275
|
|
|
519
|
-
|
|
276
|
+
delegated: boolean;
|
|
520
277
|
|
|
521
|
-
|
|
278
|
+
first_verified_at: number | null;
|
|
522
279
|
|
|
523
|
-
|
|
524
|
-
}
|
|
280
|
+
imported: boolean;
|
|
525
281
|
|
|
526
|
-
|
|
527
|
-
* The payload for importing a Telegram account.
|
|
528
|
-
*/
|
|
529
|
-
export interface LinkedAccountTelegramInput {
|
|
530
|
-
telegram_user_id: string;
|
|
282
|
+
latest_verified_at: number | null;
|
|
531
283
|
|
|
532
|
-
|
|
284
|
+
public_key: string;
|
|
533
285
|
|
|
534
|
-
|
|
286
|
+
/**
|
|
287
|
+
* The method used to recover an embedded wallet account.
|
|
288
|
+
*/
|
|
289
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
535
290
|
|
|
536
|
-
|
|
291
|
+
type: 'wallet';
|
|
537
292
|
|
|
538
|
-
|
|
293
|
+
verified_at: number;
|
|
539
294
|
|
|
540
|
-
|
|
295
|
+
wallet_client: 'privy';
|
|
296
|
+
|
|
297
|
+
wallet_client_type: 'privy';
|
|
298
|
+
|
|
299
|
+
wallet_index: number;
|
|
541
300
|
}
|
|
542
301
|
|
|
543
302
|
/**
|
|
@@ -550,76 +309,77 @@ export interface LinkedAccountCustomJwtInput {
|
|
|
550
309
|
}
|
|
551
310
|
|
|
552
311
|
/**
|
|
553
|
-
*
|
|
312
|
+
* A custom JWT account linked to the user.
|
|
554
313
|
*/
|
|
555
|
-
export interface
|
|
556
|
-
|
|
314
|
+
export interface LinkedAccountCustomJwt {
|
|
315
|
+
custom_user_id: string;
|
|
557
316
|
|
|
558
|
-
|
|
317
|
+
first_verified_at: number | null;
|
|
559
318
|
|
|
560
|
-
|
|
319
|
+
latest_verified_at: number | null;
|
|
561
320
|
|
|
562
|
-
|
|
321
|
+
type: 'custom_auth';
|
|
563
322
|
|
|
564
|
-
|
|
323
|
+
verified_at: number;
|
|
565
324
|
}
|
|
566
325
|
|
|
567
326
|
/**
|
|
568
|
-
*
|
|
327
|
+
* A custom OAuth account linked to the user.
|
|
569
328
|
*/
|
|
570
|
-
export
|
|
571
|
-
|
|
|
572
|
-
|
|
573
|
-
|
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
329
|
+
export interface LinkedAccountCustomOAuth {
|
|
330
|
+
first_verified_at: number | null;
|
|
331
|
+
|
|
332
|
+
latest_verified_at: number | null;
|
|
333
|
+
|
|
334
|
+
subject: string;
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* The ID of a custom OAuth provider, set up for this app. Must start with
|
|
338
|
+
* "custom:".
|
|
339
|
+
*/
|
|
340
|
+
type: ClientAuthAPI.CustomOAuthProviderID;
|
|
341
|
+
|
|
342
|
+
verified_at: number;
|
|
343
|
+
|
|
344
|
+
email?: string;
|
|
345
|
+
|
|
346
|
+
name?: string;
|
|
347
|
+
|
|
348
|
+
profile_picture_url?: string;
|
|
349
|
+
|
|
350
|
+
username?: string;
|
|
351
|
+
}
|
|
589
352
|
|
|
590
353
|
/**
|
|
591
|
-
* The payload for
|
|
354
|
+
* The payload for importing a Discord account.
|
|
592
355
|
*/
|
|
593
|
-
export interface
|
|
594
|
-
|
|
595
|
-
}
|
|
356
|
+
export interface LinkedAccountDiscordInput {
|
|
357
|
+
subject: string;
|
|
596
358
|
|
|
597
|
-
|
|
598
|
-
export interface User {
|
|
599
|
-
linked_accounts: Array<UsersAPI.LinkedAccountInput>;
|
|
359
|
+
type: 'discord_oauth';
|
|
600
360
|
|
|
601
|
-
|
|
361
|
+
username: string;
|
|
602
362
|
|
|
603
|
-
|
|
363
|
+
email?: string;
|
|
364
|
+
}
|
|
604
365
|
|
|
605
|
-
|
|
366
|
+
/**
|
|
367
|
+
* A Discord OAuth account linked to the user.
|
|
368
|
+
*/
|
|
369
|
+
export interface LinkedAccountDiscordOAuth {
|
|
370
|
+
email: string | null;
|
|
606
371
|
|
|
607
|
-
|
|
372
|
+
first_verified_at: number | null;
|
|
608
373
|
|
|
609
|
-
|
|
374
|
+
latest_verified_at: number | null;
|
|
610
375
|
|
|
611
|
-
|
|
376
|
+
subject: string;
|
|
612
377
|
|
|
613
|
-
|
|
614
|
-
* Custom metadata associated with the user.
|
|
615
|
-
*/
|
|
616
|
-
custom_metadata?: UsersAPI.CustomMetadata;
|
|
378
|
+
type: 'discord_oauth';
|
|
617
379
|
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
wallets?: Array<EmbeddedWalletsAPI.WalletCreationInput>;
|
|
622
|
-
}
|
|
380
|
+
username: string | null;
|
|
381
|
+
|
|
382
|
+
verified_at: number;
|
|
623
383
|
}
|
|
624
384
|
|
|
625
385
|
/**
|
|
@@ -638,31 +398,81 @@ export interface LinkedAccountEmail {
|
|
|
638
398
|
}
|
|
639
399
|
|
|
640
400
|
/**
|
|
641
|
-
*
|
|
401
|
+
* The payload for importing an email account.
|
|
642
402
|
*/
|
|
643
|
-
export interface
|
|
644
|
-
|
|
403
|
+
export interface LinkedAccountEmailInput {
|
|
404
|
+
address: string;
|
|
645
405
|
|
|
646
|
-
|
|
406
|
+
type: 'email';
|
|
407
|
+
}
|
|
647
408
|
|
|
648
|
-
|
|
409
|
+
export type LinkedAccountEmbeddedWallet =
|
|
410
|
+
| LinkedAccountEthereumEmbeddedWallet
|
|
411
|
+
| LinkedAccountSolanaEmbeddedWallet
|
|
412
|
+
| LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
413
|
+
| LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
414
|
+
| LinkedAccountCurveSigningEmbeddedWallet;
|
|
649
415
|
|
|
650
|
-
|
|
416
|
+
/**
|
|
417
|
+
* An embedded wallet account with an ID.
|
|
418
|
+
*/
|
|
419
|
+
export type LinkedAccountEmbeddedWalletWithID =
|
|
420
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountEthereumEmbeddedWallet
|
|
421
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountSolanaEmbeddedWallet
|
|
422
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
423
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
424
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountCurveSigningEmbeddedWallet;
|
|
425
|
+
|
|
426
|
+
export namespace LinkedAccountEmbeddedWalletWithID {
|
|
427
|
+
/**
|
|
428
|
+
* An Ethereum embedded wallet account linked to the user.
|
|
429
|
+
*/
|
|
430
|
+
export interface LinkedAccountEthereumEmbeddedWallet
|
|
431
|
+
extends Omit<UsersAPI.LinkedAccountEthereumEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
432
|
+
id: string;
|
|
433
|
+
|
|
434
|
+
recovery_method: 'privy-v2';
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
/**
|
|
438
|
+
* A Solana embedded wallet account linked to the user.
|
|
439
|
+
*/
|
|
440
|
+
export interface LinkedAccountSolanaEmbeddedWallet
|
|
441
|
+
extends Omit<UsersAPI.LinkedAccountSolanaEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
442
|
+
id: string;
|
|
443
|
+
|
|
444
|
+
recovery_method: 'privy-v2';
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
/**
|
|
448
|
+
* A Bitcoin SegWit embedded wallet account linked to the user.
|
|
449
|
+
*/
|
|
450
|
+
export interface LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
451
|
+
extends Omit<UsersAPI.LinkedAccountBitcoinSegwitEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
452
|
+
id: string;
|
|
651
453
|
|
|
652
|
-
|
|
454
|
+
recovery_method: 'privy-v2';
|
|
455
|
+
}
|
|
653
456
|
|
|
654
|
-
|
|
655
|
-
|
|
457
|
+
/**
|
|
458
|
+
* A Bitcoin Taproot embedded wallet account linked to the user.
|
|
459
|
+
*/
|
|
460
|
+
export interface LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
461
|
+
extends Omit<UsersAPI.LinkedAccountBitcoinTaprootEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
462
|
+
id: string;
|
|
656
463
|
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
*/
|
|
660
|
-
export interface LinkedAccountBaseWallet {
|
|
661
|
-
address: string;
|
|
464
|
+
recovery_method: 'privy-v2';
|
|
465
|
+
}
|
|
662
466
|
|
|
663
|
-
|
|
467
|
+
/**
|
|
468
|
+
* A curve signing embedded wallet account linked to the user.
|
|
469
|
+
*/
|
|
470
|
+
export interface LinkedAccountCurveSigningEmbeddedWallet
|
|
471
|
+
extends Omit<UsersAPI.LinkedAccountCurveSigningEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
472
|
+
id: string;
|
|
664
473
|
|
|
665
|
-
|
|
474
|
+
recovery_method: 'privy-v2';
|
|
475
|
+
}
|
|
666
476
|
}
|
|
667
477
|
|
|
668
478
|
/**
|
|
@@ -691,48 +501,41 @@ export interface LinkedAccountEthereum {
|
|
|
691
501
|
}
|
|
692
502
|
|
|
693
503
|
/**
|
|
694
|
-
*
|
|
504
|
+
* An Ethereum embedded wallet account linked to the user.
|
|
695
505
|
*/
|
|
696
|
-
export interface
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
first_verified_at: number | null;
|
|
700
|
-
|
|
701
|
-
latest_verified_at: number | null;
|
|
702
|
-
|
|
703
|
-
/**
|
|
704
|
-
* The supported smart wallet providers.
|
|
705
|
-
*/
|
|
706
|
-
smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
|
|
506
|
+
export interface LinkedAccountEthereumEmbeddedWallet {
|
|
507
|
+
id: string | null;
|
|
707
508
|
|
|
708
|
-
|
|
509
|
+
address: string;
|
|
709
510
|
|
|
710
|
-
|
|
511
|
+
chain_id: string;
|
|
711
512
|
|
|
712
|
-
|
|
713
|
-
}
|
|
513
|
+
chain_type: 'ethereum';
|
|
714
514
|
|
|
715
|
-
|
|
716
|
-
* A Solana wallet account linked to the user.
|
|
717
|
-
*/
|
|
718
|
-
export interface LinkedAccountSolana {
|
|
719
|
-
address: string;
|
|
515
|
+
connector_type: 'embedded';
|
|
720
516
|
|
|
721
|
-
|
|
517
|
+
delegated: boolean;
|
|
722
518
|
|
|
723
519
|
first_verified_at: number | null;
|
|
724
520
|
|
|
521
|
+
imported: boolean;
|
|
522
|
+
|
|
725
523
|
latest_verified_at: number | null;
|
|
726
524
|
|
|
525
|
+
/**
|
|
526
|
+
* The method used to recover an embedded wallet account.
|
|
527
|
+
*/
|
|
528
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
529
|
+
|
|
727
530
|
type: 'wallet';
|
|
728
531
|
|
|
729
532
|
verified_at: number;
|
|
730
533
|
|
|
731
|
-
wallet_client: '
|
|
534
|
+
wallet_client: 'privy';
|
|
732
535
|
|
|
733
|
-
|
|
536
|
+
wallet_client_type: 'privy';
|
|
734
537
|
|
|
735
|
-
|
|
538
|
+
wallet_index: number;
|
|
736
539
|
}
|
|
737
540
|
|
|
738
541
|
/**
|
|
@@ -767,435 +570,381 @@ export interface LinkedAccountFarcaster {
|
|
|
767
570
|
}
|
|
768
571
|
|
|
769
572
|
/**
|
|
770
|
-
*
|
|
573
|
+
* The payload for importing a Farcaster account.
|
|
771
574
|
*/
|
|
772
|
-
export interface
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
enrolled_in_mfa: boolean;
|
|
776
|
-
|
|
777
|
-
first_verified_at: number | null;
|
|
778
|
-
|
|
779
|
-
latest_verified_at: number | null;
|
|
575
|
+
export interface LinkedAccountFarcasterInput {
|
|
576
|
+
fid: number;
|
|
780
577
|
|
|
781
|
-
|
|
578
|
+
owner_address: string;
|
|
782
579
|
|
|
783
|
-
|
|
580
|
+
type: 'farcaster';
|
|
784
581
|
|
|
785
|
-
|
|
582
|
+
bio?: string;
|
|
786
583
|
|
|
787
|
-
|
|
584
|
+
display_name?: string;
|
|
788
585
|
|
|
789
|
-
|
|
586
|
+
homepage_url?: string;
|
|
790
587
|
|
|
791
|
-
|
|
588
|
+
profile_picture_url?: string;
|
|
792
589
|
|
|
793
|
-
|
|
590
|
+
username?: string;
|
|
794
591
|
}
|
|
795
592
|
|
|
796
593
|
/**
|
|
797
|
-
*
|
|
594
|
+
* The payload for importing a Github account.
|
|
798
595
|
*/
|
|
799
|
-
export interface
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
latest_verified_at: number | null;
|
|
803
|
-
|
|
804
|
-
telegram_user_id: string;
|
|
805
|
-
|
|
806
|
-
type: 'telegram';
|
|
807
|
-
|
|
808
|
-
verified_at: number;
|
|
596
|
+
export interface LinkedAccountGitHubInput {
|
|
597
|
+
subject: string;
|
|
809
598
|
|
|
810
|
-
|
|
599
|
+
type: 'github_oauth';
|
|
811
600
|
|
|
812
|
-
|
|
601
|
+
username: string;
|
|
813
602
|
|
|
814
|
-
|
|
603
|
+
email?: string;
|
|
815
604
|
|
|
816
|
-
|
|
605
|
+
name?: string;
|
|
817
606
|
}
|
|
818
607
|
|
|
819
608
|
/**
|
|
820
|
-
*
|
|
821
|
-
*/
|
|
822
|
-
export type EmbeddedWalletRecoveryMethod =
|
|
823
|
-
| 'privy'
|
|
824
|
-
| 'user-passcode'
|
|
825
|
-
| 'google-drive'
|
|
826
|
-
| 'icloud'
|
|
827
|
-
| 'recovery-encryption-key'
|
|
828
|
-
| 'privy-v2';
|
|
829
|
-
|
|
830
|
-
/**
|
|
831
|
-
* An Ethereum embedded wallet account linked to the user.
|
|
609
|
+
* A GitHub OAuth account linked to the user.
|
|
832
610
|
*/
|
|
833
|
-
export interface
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
address: string;
|
|
837
|
-
|
|
838
|
-
chain_id: string;
|
|
839
|
-
|
|
840
|
-
chain_type: 'ethereum';
|
|
841
|
-
|
|
842
|
-
connector_type: 'embedded';
|
|
843
|
-
|
|
844
|
-
delegated: boolean;
|
|
611
|
+
export interface LinkedAccountGitHubOAuth {
|
|
612
|
+
email: string | null;
|
|
845
613
|
|
|
846
614
|
first_verified_at: number | null;
|
|
847
615
|
|
|
848
|
-
imported: boolean;
|
|
849
|
-
|
|
850
616
|
latest_verified_at: number | null;
|
|
851
617
|
|
|
852
|
-
|
|
853
|
-
* The method used to recover an embedded wallet account.
|
|
854
|
-
*/
|
|
855
|
-
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
856
|
-
|
|
857
|
-
type: 'wallet';
|
|
618
|
+
name: string | null;
|
|
858
619
|
|
|
859
|
-
|
|
620
|
+
subject: string;
|
|
860
621
|
|
|
861
|
-
|
|
622
|
+
type: 'github_oauth';
|
|
862
623
|
|
|
863
|
-
|
|
624
|
+
username: string | null;
|
|
864
625
|
|
|
865
|
-
|
|
626
|
+
verified_at: number;
|
|
866
627
|
}
|
|
867
628
|
|
|
868
629
|
/**
|
|
869
|
-
*
|
|
630
|
+
* The payload for importing a Google account.
|
|
870
631
|
*/
|
|
871
|
-
export interface
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
address: string;
|
|
632
|
+
export interface LinkedAccountGoogleInput {
|
|
633
|
+
email: string;
|
|
875
634
|
|
|
876
|
-
|
|
635
|
+
name: string;
|
|
877
636
|
|
|
878
|
-
|
|
637
|
+
subject: string;
|
|
879
638
|
|
|
880
|
-
|
|
639
|
+
type: 'google_oauth';
|
|
640
|
+
}
|
|
881
641
|
|
|
882
|
-
|
|
642
|
+
/**
|
|
643
|
+
* A Google OAuth account linked to the user.
|
|
644
|
+
*/
|
|
645
|
+
export interface LinkedAccountGoogleOAuth {
|
|
646
|
+
email: string;
|
|
883
647
|
|
|
884
648
|
first_verified_at: number | null;
|
|
885
649
|
|
|
886
|
-
imported: boolean;
|
|
887
|
-
|
|
888
650
|
latest_verified_at: number | null;
|
|
889
651
|
|
|
890
|
-
|
|
652
|
+
name: string | null;
|
|
891
653
|
|
|
892
|
-
|
|
893
|
-
* The method used to recover an embedded wallet account.
|
|
894
|
-
*/
|
|
895
|
-
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
654
|
+
subject: string;
|
|
896
655
|
|
|
897
|
-
type: '
|
|
656
|
+
type: 'google_oauth';
|
|
898
657
|
|
|
899
658
|
verified_at: number;
|
|
900
|
-
|
|
901
|
-
wallet_client: 'privy';
|
|
902
|
-
|
|
903
|
-
wallet_client_type: 'privy';
|
|
904
|
-
|
|
905
|
-
wallet_index: number;
|
|
906
659
|
}
|
|
907
660
|
|
|
908
661
|
/**
|
|
909
|
-
*
|
|
662
|
+
* The input for adding a linked account to a user.
|
|
910
663
|
*/
|
|
911
|
-
export
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
664
|
+
export type LinkedAccountInput =
|
|
665
|
+
| LinkedAccountWalletInput
|
|
666
|
+
| LinkedAccountEmailInput
|
|
667
|
+
| LinkedAccountPhoneInput
|
|
668
|
+
| LinkedAccountGoogleInput
|
|
669
|
+
| LinkedAccountTwitterInput
|
|
670
|
+
| LinkedAccountDiscordInput
|
|
671
|
+
| LinkedAccountGitHubInput
|
|
672
|
+
| LinkedAccountSpotifyInput
|
|
673
|
+
| LinkedAccountInstagramInput
|
|
674
|
+
| LinkedAccountTiktokInput
|
|
675
|
+
| LinkedAccountLineInput
|
|
676
|
+
| LinkedAccountTwitchInput
|
|
677
|
+
| LinkedAccountAppleInput
|
|
678
|
+
| LinkedAccountLinkedInInput
|
|
679
|
+
| LinkedAccountFarcasterInput
|
|
680
|
+
| LinkedAccountTelegramInput
|
|
681
|
+
| LinkedAccountCustomJwtInput
|
|
682
|
+
| LinkedAccountPasskeyInput;
|
|
925
683
|
|
|
926
|
-
|
|
684
|
+
/**
|
|
685
|
+
* The payload for importing an Instagram account.
|
|
686
|
+
*/
|
|
687
|
+
export interface LinkedAccountInstagramInput {
|
|
688
|
+
subject: string;
|
|
927
689
|
|
|
928
|
-
|
|
690
|
+
type: 'instagram_oauth';
|
|
929
691
|
|
|
930
|
-
|
|
692
|
+
username: string;
|
|
693
|
+
}
|
|
931
694
|
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
695
|
+
/**
|
|
696
|
+
* An Instagram OAuth account linked to the user.
|
|
697
|
+
*/
|
|
698
|
+
export interface LinkedAccountInstagramOAuth {
|
|
699
|
+
first_verified_at: number | null;
|
|
936
700
|
|
|
937
|
-
|
|
701
|
+
latest_verified_at: number | null;
|
|
938
702
|
|
|
939
|
-
|
|
703
|
+
subject: string;
|
|
940
704
|
|
|
941
|
-
|
|
705
|
+
type: 'instagram_oauth';
|
|
942
706
|
|
|
943
|
-
|
|
707
|
+
username: string | null;
|
|
944
708
|
|
|
945
|
-
|
|
709
|
+
verified_at: number;
|
|
946
710
|
}
|
|
947
711
|
|
|
948
712
|
/**
|
|
949
|
-
*
|
|
713
|
+
* The payload for importing a LINE account.
|
|
950
714
|
*/
|
|
951
|
-
export interface
|
|
952
|
-
|
|
715
|
+
export interface LinkedAccountLineInput {
|
|
716
|
+
subject: string;
|
|
953
717
|
|
|
954
|
-
|
|
718
|
+
type: 'line_oauth';
|
|
955
719
|
|
|
956
|
-
|
|
720
|
+
email?: string;
|
|
957
721
|
|
|
958
|
-
|
|
722
|
+
name?: string;
|
|
959
723
|
|
|
960
|
-
|
|
724
|
+
profile_picture_url?: string;
|
|
725
|
+
}
|
|
961
726
|
|
|
962
|
-
|
|
727
|
+
/**
|
|
728
|
+
* A LINE OAuth account linked to the user.
|
|
729
|
+
*/
|
|
730
|
+
export interface LinkedAccountLineOAuth {
|
|
731
|
+
email: string | null;
|
|
963
732
|
|
|
964
733
|
first_verified_at: number | null;
|
|
965
734
|
|
|
966
|
-
imported: boolean;
|
|
967
|
-
|
|
968
735
|
latest_verified_at: number | null;
|
|
969
736
|
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
/**
|
|
973
|
-
* The method used to recover an embedded wallet account.
|
|
974
|
-
*/
|
|
975
|
-
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
976
|
-
|
|
977
|
-
type: 'wallet';
|
|
737
|
+
name: string | null;
|
|
978
738
|
|
|
979
|
-
|
|
739
|
+
profile_picture_url: string | null;
|
|
980
740
|
|
|
981
|
-
|
|
741
|
+
subject: string;
|
|
982
742
|
|
|
983
|
-
|
|
743
|
+
type: 'line_oauth';
|
|
984
744
|
|
|
985
|
-
|
|
745
|
+
verified_at: number;
|
|
986
746
|
}
|
|
987
747
|
|
|
988
748
|
/**
|
|
989
|
-
*
|
|
749
|
+
* The payload for importing a LinkedIn account.
|
|
990
750
|
*/
|
|
991
|
-
export interface
|
|
992
|
-
|
|
751
|
+
export interface LinkedAccountLinkedInInput {
|
|
752
|
+
subject: string;
|
|
993
753
|
|
|
994
|
-
|
|
754
|
+
type: 'linkedin_oauth';
|
|
995
755
|
|
|
996
|
-
|
|
756
|
+
email?: string;
|
|
997
757
|
|
|
998
|
-
|
|
999
|
-
* The wallet chain types that support curve-based signing.
|
|
1000
|
-
*/
|
|
1001
|
-
chain_type: WalletsAPI.CurveSigningChainType;
|
|
758
|
+
name?: string;
|
|
1002
759
|
|
|
1003
|
-
|
|
760
|
+
vanityName?: string;
|
|
761
|
+
}
|
|
1004
762
|
|
|
1005
|
-
|
|
763
|
+
/**
|
|
764
|
+
* A LinkedIn OAuth account linked to the user.
|
|
765
|
+
*/
|
|
766
|
+
export interface LinkedAccountLinkedInOAuth {
|
|
767
|
+
email: string | null;
|
|
1006
768
|
|
|
1007
769
|
first_verified_at: number | null;
|
|
1008
770
|
|
|
1009
|
-
imported: boolean;
|
|
1010
|
-
|
|
1011
771
|
latest_verified_at: number | null;
|
|
1012
772
|
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
/**
|
|
1016
|
-
* The method used to recover an embedded wallet account.
|
|
1017
|
-
*/
|
|
1018
|
-
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
773
|
+
subject: string;
|
|
1019
774
|
|
|
1020
|
-
type: '
|
|
775
|
+
type: 'linkedin_oauth';
|
|
1021
776
|
|
|
1022
777
|
verified_at: number;
|
|
1023
778
|
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
wallet_client_type: 'privy';
|
|
779
|
+
name?: string;
|
|
1027
780
|
|
|
1028
|
-
|
|
781
|
+
vanity_name?: string;
|
|
1029
782
|
}
|
|
1030
783
|
|
|
1031
|
-
export type LinkedAccountEmbeddedWallet =
|
|
1032
|
-
| LinkedAccountEthereumEmbeddedWallet
|
|
1033
|
-
| LinkedAccountSolanaEmbeddedWallet
|
|
1034
|
-
| LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
1035
|
-
| LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
1036
|
-
| LinkedAccountCurveSigningEmbeddedWallet;
|
|
1037
|
-
|
|
1038
784
|
/**
|
|
1039
|
-
*
|
|
785
|
+
* A passkey account linked to the user.
|
|
1040
786
|
*/
|
|
1041
|
-
export
|
|
1042
|
-
|
|
1043
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountSolanaEmbeddedWallet
|
|
1044
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
1045
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
1046
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountCurveSigningEmbeddedWallet;
|
|
787
|
+
export interface LinkedAccountPasskey {
|
|
788
|
+
credential_id: string;
|
|
1047
789
|
|
|
1048
|
-
|
|
1049
|
-
/**
|
|
1050
|
-
* An Ethereum embedded wallet account linked to the user.
|
|
1051
|
-
*/
|
|
1052
|
-
export interface LinkedAccountEthereumEmbeddedWallet
|
|
1053
|
-
extends Omit<UsersAPI.LinkedAccountEthereumEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1054
|
-
id: string;
|
|
790
|
+
enrolled_in_mfa: boolean;
|
|
1055
791
|
|
|
1056
|
-
|
|
1057
|
-
}
|
|
792
|
+
first_verified_at: number | null;
|
|
1058
793
|
|
|
1059
|
-
|
|
1060
|
-
* A Solana embedded wallet account linked to the user.
|
|
1061
|
-
*/
|
|
1062
|
-
export interface LinkedAccountSolanaEmbeddedWallet
|
|
1063
|
-
extends Omit<UsersAPI.LinkedAccountSolanaEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1064
|
-
id: string;
|
|
794
|
+
latest_verified_at: number | null;
|
|
1065
795
|
|
|
1066
|
-
|
|
1067
|
-
}
|
|
796
|
+
type: 'passkey';
|
|
1068
797
|
|
|
1069
|
-
|
|
1070
|
-
* A Bitcoin SegWit embedded wallet account linked to the user.
|
|
1071
|
-
*/
|
|
1072
|
-
export interface LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
1073
|
-
extends Omit<UsersAPI.LinkedAccountBitcoinSegwitEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1074
|
-
id: string;
|
|
798
|
+
verified_at: number;
|
|
1075
799
|
|
|
1076
|
-
|
|
1077
|
-
}
|
|
800
|
+
authenticator_name?: string;
|
|
1078
801
|
|
|
1079
|
-
|
|
1080
|
-
* A Bitcoin Taproot embedded wallet account linked to the user.
|
|
1081
|
-
*/
|
|
1082
|
-
export interface LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
1083
|
-
extends Omit<UsersAPI.LinkedAccountBitcoinTaprootEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1084
|
-
id: string;
|
|
802
|
+
created_with_browser?: string;
|
|
1085
803
|
|
|
1086
|
-
|
|
1087
|
-
}
|
|
804
|
+
created_with_device?: string;
|
|
1088
805
|
|
|
1089
|
-
|
|
1090
|
-
* A curve signing embedded wallet account linked to the user.
|
|
1091
|
-
*/
|
|
1092
|
-
export interface LinkedAccountCurveSigningEmbeddedWallet
|
|
1093
|
-
extends Omit<UsersAPI.LinkedAccountCurveSigningEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1094
|
-
id: string;
|
|
806
|
+
created_with_os?: string;
|
|
1095
807
|
|
|
1096
|
-
|
|
1097
|
-
}
|
|
808
|
+
public_key?: string;
|
|
1098
809
|
}
|
|
1099
810
|
|
|
1100
811
|
/**
|
|
1101
|
-
*
|
|
812
|
+
* The payload for importing a passkey account.
|
|
1102
813
|
*/
|
|
1103
|
-
export interface
|
|
1104
|
-
|
|
814
|
+
export interface LinkedAccountPasskeyInput {
|
|
815
|
+
credential_device_type: 'singleDevice' | 'multiDevice';
|
|
816
|
+
|
|
817
|
+
credential_id: string;
|
|
818
|
+
|
|
819
|
+
credential_public_key: string;
|
|
820
|
+
|
|
821
|
+
credential_username: string;
|
|
822
|
+
|
|
823
|
+
type: 'passkey';
|
|
824
|
+
}
|
|
1105
825
|
|
|
826
|
+
/**
|
|
827
|
+
* A phone number account linked to the user.
|
|
828
|
+
*/
|
|
829
|
+
export interface LinkedAccountPhone {
|
|
1106
830
|
first_verified_at: number | null;
|
|
1107
831
|
|
|
1108
832
|
latest_verified_at: number | null;
|
|
1109
833
|
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
subject: string;
|
|
834
|
+
phoneNumber: string;
|
|
1113
835
|
|
|
1114
|
-
type: '
|
|
836
|
+
type: 'phone';
|
|
1115
837
|
|
|
1116
838
|
verified_at: number;
|
|
839
|
+
|
|
840
|
+
number?: string;
|
|
1117
841
|
}
|
|
1118
842
|
|
|
1119
843
|
/**
|
|
1120
|
-
*
|
|
844
|
+
* The payload for importing a phone account.
|
|
1121
845
|
*/
|
|
1122
|
-
export interface
|
|
1123
|
-
|
|
846
|
+
export interface LinkedAccountPhoneInput {
|
|
847
|
+
number: string;
|
|
1124
848
|
|
|
1125
|
-
|
|
849
|
+
type: 'phone';
|
|
850
|
+
}
|
|
1126
851
|
|
|
1127
|
-
|
|
852
|
+
/**
|
|
853
|
+
* A smart wallet account linked to the user.
|
|
854
|
+
*/
|
|
855
|
+
export interface LinkedAccountSmartWallet {
|
|
856
|
+
address: string;
|
|
1128
857
|
|
|
1129
|
-
|
|
858
|
+
first_verified_at: number | null;
|
|
1130
859
|
|
|
1131
|
-
|
|
860
|
+
latest_verified_at: number | null;
|
|
1132
861
|
|
|
1133
|
-
|
|
862
|
+
/**
|
|
863
|
+
* The supported smart wallet providers.
|
|
864
|
+
*/
|
|
865
|
+
smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
|
|
1134
866
|
|
|
1135
|
-
|
|
867
|
+
type: 'smart_wallet';
|
|
1136
868
|
|
|
1137
869
|
verified_at: number;
|
|
870
|
+
|
|
871
|
+
smart_wallet_version?: string;
|
|
1138
872
|
}
|
|
1139
873
|
|
|
1140
874
|
/**
|
|
1141
|
-
* A
|
|
875
|
+
* A Solana wallet account linked to the user.
|
|
1142
876
|
*/
|
|
1143
|
-
export interface
|
|
1144
|
-
|
|
877
|
+
export interface LinkedAccountSolana {
|
|
878
|
+
address: string;
|
|
879
|
+
|
|
880
|
+
chain_type: 'solana';
|
|
1145
881
|
|
|
1146
882
|
first_verified_at: number | null;
|
|
1147
883
|
|
|
1148
884
|
latest_verified_at: number | null;
|
|
1149
885
|
|
|
1150
|
-
|
|
886
|
+
type: 'wallet';
|
|
1151
887
|
|
|
1152
|
-
|
|
888
|
+
verified_at: number;
|
|
1153
889
|
|
|
1154
|
-
|
|
890
|
+
wallet_client: 'unknown';
|
|
1155
891
|
|
|
1156
|
-
|
|
892
|
+
connector_type?: string;
|
|
893
|
+
|
|
894
|
+
wallet_client_type?: string;
|
|
1157
895
|
}
|
|
1158
896
|
|
|
1159
897
|
/**
|
|
1160
|
-
* A
|
|
898
|
+
* A Solana embedded wallet account linked to the user.
|
|
1161
899
|
*/
|
|
1162
|
-
export interface
|
|
1163
|
-
|
|
900
|
+
export interface LinkedAccountSolanaEmbeddedWallet {
|
|
901
|
+
id: string | null;
|
|
902
|
+
|
|
903
|
+
address: string;
|
|
904
|
+
|
|
905
|
+
chain_id: string;
|
|
906
|
+
|
|
907
|
+
chain_type: 'solana';
|
|
908
|
+
|
|
909
|
+
connector_type: 'embedded';
|
|
910
|
+
|
|
911
|
+
delegated: boolean;
|
|
1164
912
|
|
|
1165
913
|
first_verified_at: number | null;
|
|
1166
914
|
|
|
1167
|
-
|
|
915
|
+
imported: boolean;
|
|
916
|
+
|
|
917
|
+
latest_verified_at: number | null;
|
|
918
|
+
|
|
919
|
+
public_key: string;
|
|
920
|
+
|
|
921
|
+
/**
|
|
922
|
+
* The method used to recover an embedded wallet account.
|
|
923
|
+
*/
|
|
924
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
1168
925
|
|
|
1169
|
-
|
|
926
|
+
type: 'wallet';
|
|
1170
927
|
|
|
1171
|
-
|
|
928
|
+
verified_at: number;
|
|
1172
929
|
|
|
1173
|
-
|
|
930
|
+
wallet_client: 'privy';
|
|
1174
931
|
|
|
1175
|
-
|
|
932
|
+
wallet_client_type: 'privy';
|
|
1176
933
|
|
|
1177
|
-
|
|
934
|
+
wallet_index: number;
|
|
1178
935
|
}
|
|
1179
936
|
|
|
1180
937
|
/**
|
|
1181
|
-
*
|
|
938
|
+
* The payload for importing a Spotify account.
|
|
1182
939
|
*/
|
|
1183
|
-
export interface
|
|
1184
|
-
email: string | null;
|
|
1185
|
-
|
|
1186
|
-
first_verified_at: number | null;
|
|
1187
|
-
|
|
1188
|
-
latest_verified_at: number | null;
|
|
1189
|
-
|
|
940
|
+
export interface LinkedAccountSpotifyInput {
|
|
1190
941
|
subject: string;
|
|
1191
942
|
|
|
1192
|
-
type: '
|
|
943
|
+
type: 'spotify_oauth';
|
|
1193
944
|
|
|
1194
|
-
|
|
945
|
+
email?: string;
|
|
1195
946
|
|
|
1196
947
|
name?: string;
|
|
1197
|
-
|
|
1198
|
-
vanity_name?: string;
|
|
1199
948
|
}
|
|
1200
949
|
|
|
1201
950
|
/**
|
|
@@ -1218,73 +967,71 @@ export interface LinkedAccountSpotifyOAuth {
|
|
|
1218
967
|
}
|
|
1219
968
|
|
|
1220
969
|
/**
|
|
1221
|
-
*
|
|
970
|
+
* A Telegram account linked to the user.
|
|
1222
971
|
*/
|
|
1223
|
-
export interface
|
|
972
|
+
export interface LinkedAccountTelegram {
|
|
1224
973
|
first_verified_at: number | null;
|
|
1225
974
|
|
|
1226
975
|
latest_verified_at: number | null;
|
|
1227
976
|
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
type: 'instagram_oauth';
|
|
977
|
+
telegram_user_id: string;
|
|
1231
978
|
|
|
1232
|
-
|
|
979
|
+
type: 'telegram';
|
|
1233
980
|
|
|
1234
981
|
verified_at: number;
|
|
982
|
+
|
|
983
|
+
first_name?: string | null;
|
|
984
|
+
|
|
985
|
+
last_name?: string | null;
|
|
986
|
+
|
|
987
|
+
photo_url?: string | null;
|
|
988
|
+
|
|
989
|
+
username?: string | null;
|
|
1235
990
|
}
|
|
1236
991
|
|
|
1237
992
|
/**
|
|
1238
|
-
*
|
|
993
|
+
* The payload for importing a Telegram account.
|
|
1239
994
|
*/
|
|
1240
|
-
export interface
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
latest_verified_at: number | null;
|
|
995
|
+
export interface LinkedAccountTelegramInput {
|
|
996
|
+
telegram_user_id: string;
|
|
1244
997
|
|
|
1245
|
-
|
|
998
|
+
type: 'telegram';
|
|
1246
999
|
|
|
1247
|
-
|
|
1000
|
+
first_name?: string;
|
|
1248
1001
|
|
|
1249
|
-
|
|
1002
|
+
last_name?: string;
|
|
1250
1003
|
|
|
1251
|
-
|
|
1004
|
+
photo_url?: string;
|
|
1252
1005
|
|
|
1253
|
-
|
|
1006
|
+
username?: string;
|
|
1254
1007
|
}
|
|
1255
1008
|
|
|
1256
1009
|
/**
|
|
1257
|
-
*
|
|
1010
|
+
* The payload for importing a Tiktok account.
|
|
1258
1011
|
*/
|
|
1259
|
-
export interface
|
|
1260
|
-
email: string | null;
|
|
1261
|
-
|
|
1262
|
-
first_verified_at: number | null;
|
|
1263
|
-
|
|
1264
|
-
latest_verified_at: number | null;
|
|
1265
|
-
|
|
1012
|
+
export interface LinkedAccountTiktokInput {
|
|
1266
1013
|
name: string | null;
|
|
1267
1014
|
|
|
1268
|
-
profile_picture_url: string | null;
|
|
1269
|
-
|
|
1270
1015
|
subject: string;
|
|
1271
1016
|
|
|
1272
|
-
type: '
|
|
1017
|
+
type: 'tiktok_oauth';
|
|
1273
1018
|
|
|
1274
|
-
|
|
1019
|
+
username: string;
|
|
1275
1020
|
}
|
|
1276
1021
|
|
|
1277
1022
|
/**
|
|
1278
|
-
* A
|
|
1023
|
+
* A TikTok OAuth account linked to the user.
|
|
1279
1024
|
*/
|
|
1280
|
-
export interface
|
|
1025
|
+
export interface LinkedAccountTiktokOAuth {
|
|
1281
1026
|
first_verified_at: number | null;
|
|
1282
1027
|
|
|
1283
1028
|
latest_verified_at: number | null;
|
|
1284
1029
|
|
|
1030
|
+
name: string | null;
|
|
1031
|
+
|
|
1285
1032
|
subject: string;
|
|
1286
1033
|
|
|
1287
|
-
type: '
|
|
1034
|
+
type: 'tiktok_oauth';
|
|
1288
1035
|
|
|
1289
1036
|
username: string | null;
|
|
1290
1037
|
|
|
@@ -1292,147 +1039,69 @@ export interface LinkedAccountTwitchOAuth {
|
|
|
1292
1039
|
}
|
|
1293
1040
|
|
|
1294
1041
|
/**
|
|
1295
|
-
*
|
|
1042
|
+
* The payload for importing a Twitch account.
|
|
1296
1043
|
*/
|
|
1297
|
-
export interface
|
|
1298
|
-
email: string | null;
|
|
1299
|
-
|
|
1300
|
-
first_verified_at: number | null;
|
|
1301
|
-
|
|
1302
|
-
latest_verified_at: number | null;
|
|
1303
|
-
|
|
1044
|
+
export interface LinkedAccountTwitchInput {
|
|
1304
1045
|
subject: string;
|
|
1305
1046
|
|
|
1306
|
-
type: '
|
|
1047
|
+
type: 'twitch_oauth';
|
|
1307
1048
|
|
|
1308
|
-
|
|
1049
|
+
username?: string;
|
|
1309
1050
|
}
|
|
1310
1051
|
|
|
1311
1052
|
/**
|
|
1312
|
-
* A
|
|
1053
|
+
* A Twitch OAuth account linked to the user.
|
|
1313
1054
|
*/
|
|
1314
|
-
export interface
|
|
1055
|
+
export interface LinkedAccountTwitchOAuth {
|
|
1315
1056
|
first_verified_at: number | null;
|
|
1316
1057
|
|
|
1317
1058
|
latest_verified_at: number | null;
|
|
1318
1059
|
|
|
1319
1060
|
subject: string;
|
|
1320
1061
|
|
|
1321
|
-
|
|
1322
|
-
* The ID of a custom OAuth provider, set up for this app. Must start with
|
|
1323
|
-
* "custom:".
|
|
1324
|
-
*/
|
|
1325
|
-
type: ClientAuthAPI.CustomOAuthProviderID;
|
|
1326
|
-
|
|
1327
|
-
verified_at: number;
|
|
1328
|
-
|
|
1329
|
-
email?: string;
|
|
1330
|
-
|
|
1331
|
-
name?: string;
|
|
1062
|
+
type: 'twitch_oauth';
|
|
1332
1063
|
|
|
1333
|
-
|
|
1064
|
+
username: string | null;
|
|
1334
1065
|
|
|
1335
|
-
|
|
1066
|
+
verified_at: number;
|
|
1336
1067
|
}
|
|
1337
1068
|
|
|
1338
1069
|
/**
|
|
1339
|
-
*
|
|
1070
|
+
* The payload for importing a Twitter account.
|
|
1340
1071
|
*/
|
|
1341
|
-
export interface
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
first_verified_at: number | null;
|
|
1345
|
-
|
|
1346
|
-
latest_verified_at: number | null;
|
|
1072
|
+
export interface LinkedAccountTwitterInput {
|
|
1073
|
+
name: string;
|
|
1347
1074
|
|
|
1348
|
-
|
|
1075
|
+
subject: string;
|
|
1349
1076
|
|
|
1350
|
-
|
|
1351
|
-
}
|
|
1077
|
+
type: 'twitter_oauth';
|
|
1352
1078
|
|
|
1353
|
-
|
|
1354
|
-
* An embedded wallet associated with a cross-app account.
|
|
1355
|
-
*/
|
|
1356
|
-
export interface CrossAppEmbeddedWallet {
|
|
1357
|
-
address: string;
|
|
1358
|
-
}
|
|
1079
|
+
username: string;
|
|
1359
1080
|
|
|
1360
|
-
|
|
1361
|
-
* A smart wallet associated with a cross-app account.
|
|
1362
|
-
*/
|
|
1363
|
-
export interface CrossAppSmartWallet {
|
|
1364
|
-
address: string;
|
|
1081
|
+
profile_picture_url?: string;
|
|
1365
1082
|
}
|
|
1366
1083
|
|
|
1367
1084
|
/**
|
|
1368
|
-
* A
|
|
1085
|
+
* A Twitter OAuth account linked to the user.
|
|
1369
1086
|
*/
|
|
1370
|
-
export interface
|
|
1371
|
-
embedded_wallets: Array<CrossAppEmbeddedWallet>;
|
|
1372
|
-
|
|
1087
|
+
export interface LinkedAccountTwitterOAuth {
|
|
1373
1088
|
first_verified_at: number | null;
|
|
1374
1089
|
|
|
1375
1090
|
latest_verified_at: number | null;
|
|
1376
1091
|
|
|
1377
|
-
|
|
1092
|
+
name: string | null;
|
|
1378
1093
|
|
|
1379
|
-
|
|
1094
|
+
profile_picture_url: string | null;
|
|
1380
1095
|
|
|
1381
1096
|
subject: string;
|
|
1382
1097
|
|
|
1383
|
-
type: '
|
|
1384
|
-
|
|
1385
|
-
verified_at: number;
|
|
1386
|
-
}
|
|
1387
|
-
|
|
1388
|
-
/**
|
|
1389
|
-
* An authorization key linked to the user.
|
|
1390
|
-
*/
|
|
1391
|
-
export interface LinkedAccountAuthorizationKey {
|
|
1392
|
-
first_verified_at: number | null;
|
|
1393
|
-
|
|
1394
|
-
latest_verified_at: number | null;
|
|
1395
|
-
|
|
1396
|
-
public_key: string;
|
|
1098
|
+
type: 'twitter_oauth';
|
|
1397
1099
|
|
|
1398
|
-
|
|
1100
|
+
username: string | null;
|
|
1399
1101
|
|
|
1400
1102
|
verified_at: number;
|
|
1401
1103
|
}
|
|
1402
1104
|
|
|
1403
|
-
/**
|
|
1404
|
-
* A linked account for the user.
|
|
1405
|
-
*/
|
|
1406
|
-
export type LinkedAccount =
|
|
1407
|
-
| LinkedAccountEmail
|
|
1408
|
-
| LinkedAccountPhone
|
|
1409
|
-
| LinkedAccountEthereum
|
|
1410
|
-
| LinkedAccountSolana
|
|
1411
|
-
| LinkedAccountSmartWallet
|
|
1412
|
-
| LinkedAccountEthereumEmbeddedWallet
|
|
1413
|
-
| LinkedAccountSolanaEmbeddedWallet
|
|
1414
|
-
| LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
1415
|
-
| LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
1416
|
-
| LinkedAccountCurveSigningEmbeddedWallet
|
|
1417
|
-
| LinkedAccountGoogleOAuth
|
|
1418
|
-
| LinkedAccountTwitterOAuth
|
|
1419
|
-
| LinkedAccountDiscordOAuth
|
|
1420
|
-
| LinkedAccountGitHubOAuth
|
|
1421
|
-
| LinkedAccountSpotifyOAuth
|
|
1422
|
-
| LinkedAccountInstagramOAuth
|
|
1423
|
-
| LinkedAccountTiktokOAuth
|
|
1424
|
-
| LinkedAccountLineOAuth
|
|
1425
|
-
| LinkedAccountTwitchOAuth
|
|
1426
|
-
| LinkedAccountLinkedInOAuth
|
|
1427
|
-
| LinkedAccountAppleOAuth
|
|
1428
|
-
| LinkedAccountCustomOAuth
|
|
1429
|
-
| LinkedAccountCustomJwt
|
|
1430
|
-
| LinkedAccountFarcaster
|
|
1431
|
-
| LinkedAccountPasskey
|
|
1432
|
-
| LinkedAccountTelegram
|
|
1433
|
-
| LinkedAccountCrossApp
|
|
1434
|
-
| LinkedAccountAuthorizationKey;
|
|
1435
|
-
|
|
1436
1105
|
/**
|
|
1437
1106
|
* The possible types of linked accounts.
|
|
1438
1107
|
*/
|
|
@@ -1460,6 +1129,58 @@ export type LinkedAccountType =
|
|
|
1460
1129
|
| 'authorization_key'
|
|
1461
1130
|
| ClientAuthAPI.CustomOAuthProviderID;
|
|
1462
1131
|
|
|
1132
|
+
/**
|
|
1133
|
+
* The payload for importing a wallet account.
|
|
1134
|
+
*/
|
|
1135
|
+
export interface LinkedAccountWalletInput {
|
|
1136
|
+
address: string;
|
|
1137
|
+
|
|
1138
|
+
chain_type: 'ethereum' | 'solana';
|
|
1139
|
+
|
|
1140
|
+
type: 'wallet';
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
/**
|
|
1144
|
+
* A multi-factor authentication method linked to the user.
|
|
1145
|
+
*/
|
|
1146
|
+
export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
|
|
1147
|
+
|
|
1148
|
+
/**
|
|
1149
|
+
* OAuth tokens associated with the user.
|
|
1150
|
+
*/
|
|
1151
|
+
export interface OAuthTokens {
|
|
1152
|
+
access_token: string;
|
|
1153
|
+
|
|
1154
|
+
provider: string;
|
|
1155
|
+
|
|
1156
|
+
access_token_expires_in_seconds?: number;
|
|
1157
|
+
|
|
1158
|
+
refresh_token?: string;
|
|
1159
|
+
|
|
1160
|
+
refresh_token_expires_in_seconds?: number;
|
|
1161
|
+
|
|
1162
|
+
scopes?: Array<string>;
|
|
1163
|
+
}
|
|
1164
|
+
|
|
1165
|
+
/**
|
|
1166
|
+
* A Passkey MFA method.
|
|
1167
|
+
*/
|
|
1168
|
+
export interface PasskeyMfaMethod {
|
|
1169
|
+
type: 'passkey';
|
|
1170
|
+
|
|
1171
|
+
verified_at: number;
|
|
1172
|
+
}
|
|
1173
|
+
|
|
1174
|
+
/**
|
|
1175
|
+
* The payload for partially updating custom metadata on a user.
|
|
1176
|
+
*/
|
|
1177
|
+
export interface PatchUsersCustomMetadata {
|
|
1178
|
+
/**
|
|
1179
|
+
* Custom metadata associated with the user.
|
|
1180
|
+
*/
|
|
1181
|
+
custom_metadata: CustomMetadata;
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1463
1184
|
/**
|
|
1464
1185
|
* A SMS MFA method.
|
|
1465
1186
|
*/
|
|
@@ -1478,20 +1199,6 @@ export interface TotpMfaMethod {
|
|
|
1478
1199
|
verified_at: number;
|
|
1479
1200
|
}
|
|
1480
1201
|
|
|
1481
|
-
/**
|
|
1482
|
-
* A Passkey MFA method.
|
|
1483
|
-
*/
|
|
1484
|
-
export interface PasskeyMfaMethod {
|
|
1485
|
-
type: 'passkey';
|
|
1486
|
-
|
|
1487
|
-
verified_at: number;
|
|
1488
|
-
}
|
|
1489
|
-
|
|
1490
|
-
/**
|
|
1491
|
-
* A multi-factor authentication method linked to the user.
|
|
1492
|
-
*/
|
|
1493
|
-
export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
|
|
1494
|
-
|
|
1495
1202
|
/**
|
|
1496
1203
|
* A Privy user object.
|
|
1497
1204
|
*/
|
|
@@ -1524,293 +1231,119 @@ export interface User {
|
|
|
1524
1231
|
}
|
|
1525
1232
|
|
|
1526
1233
|
/**
|
|
1527
|
-
*
|
|
1528
|
-
*/
|
|
1529
|
-
export interface OAuthTokens {
|
|
1530
|
-
access_token: string;
|
|
1531
|
-
|
|
1532
|
-
provider: string;
|
|
1533
|
-
|
|
1534
|
-
access_token_expires_in_seconds?: number;
|
|
1535
|
-
|
|
1536
|
-
refresh_token?: string;
|
|
1537
|
-
|
|
1538
|
-
refresh_token_expires_in_seconds?: number;
|
|
1539
|
-
|
|
1540
|
-
scopes?: Array<string>;
|
|
1541
|
-
}
|
|
1542
|
-
|
|
1543
|
-
/**
|
|
1544
|
-
* The user object along their identity token.
|
|
1234
|
+
* The payload for batch creating users.
|
|
1545
1235
|
*/
|
|
1546
|
-
export interface
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
/**
|
|
1550
|
-
* A Privy user object.
|
|
1551
|
-
*/
|
|
1552
|
-
user: User;
|
|
1236
|
+
export interface UserBatchCreateInput {
|
|
1237
|
+
users: Array<UserBatchCreateInput.User>;
|
|
1553
1238
|
}
|
|
1554
1239
|
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
export interface AuthenticatedUser {
|
|
1559
|
-
token: string | null;
|
|
1560
|
-
|
|
1561
|
-
privy_access_token: string | null;
|
|
1562
|
-
|
|
1563
|
-
refresh_token: string | null;
|
|
1564
|
-
|
|
1565
|
-
/**
|
|
1566
|
-
* Instructs the client on how to handle tokens received
|
|
1567
|
-
*/
|
|
1568
|
-
session_update_action: 'set' | 'ignore' | 'clear';
|
|
1569
|
-
|
|
1570
|
-
/**
|
|
1571
|
-
* A Privy user object.
|
|
1572
|
-
*/
|
|
1573
|
-
user: User;
|
|
1574
|
-
|
|
1575
|
-
identity_token?: string;
|
|
1576
|
-
|
|
1577
|
-
is_new_user?: boolean;
|
|
1240
|
+
export namespace UserBatchCreateInput {
|
|
1241
|
+
export interface User {
|
|
1242
|
+
linked_accounts: Array<UsersAPI.LinkedAccountInput>;
|
|
1578
1243
|
|
|
1579
|
-
|
|
1580
|
-
* OAuth tokens associated with the user.
|
|
1581
|
-
*/
|
|
1582
|
-
oauth_tokens?: OAuthTokens;
|
|
1583
|
-
}
|
|
1244
|
+
create_embedded_wallet?: boolean;
|
|
1584
1245
|
|
|
1585
|
-
|
|
1586
|
-
linked_accounts: Array<LinkedAccountInput>;
|
|
1246
|
+
create_ethereum_smart_wallet?: boolean;
|
|
1587
1247
|
|
|
1588
|
-
|
|
1589
|
-
* Custom metadata associated with the user.
|
|
1590
|
-
*/
|
|
1591
|
-
custom_metadata?: CustomMetadata;
|
|
1248
|
+
create_ethereum_wallet?: boolean;
|
|
1592
1249
|
|
|
1593
|
-
|
|
1594
|
-
* Wallets to create for the user.
|
|
1595
|
-
*/
|
|
1596
|
-
wallets?: Array<UserCreateParams.Wallet>;
|
|
1597
|
-
}
|
|
1250
|
+
create_n_embedded_wallets?: number;
|
|
1598
1251
|
|
|
1599
|
-
|
|
1600
|
-
export interface Wallet {
|
|
1601
|
-
/**
|
|
1602
|
-
* The wallet chain types.
|
|
1603
|
-
*/
|
|
1604
|
-
chain_type: WalletsAPI.WalletChainType;
|
|
1252
|
+
create_n_ethereum_wallets?: number;
|
|
1605
1253
|
|
|
1606
|
-
|
|
1607
|
-
* Additional signers for the wallet.
|
|
1608
|
-
*/
|
|
1609
|
-
additional_signers?: Array<Wallet.AdditionalSigner>;
|
|
1254
|
+
create_solana_wallet?: boolean;
|
|
1610
1255
|
|
|
1611
1256
|
/**
|
|
1612
|
-
*
|
|
1613
|
-
* with `chain_type: "ethereum"`.
|
|
1257
|
+
* Custom metadata associated with the user.
|
|
1614
1258
|
*/
|
|
1615
|
-
|
|
1259
|
+
custom_metadata?: UsersAPI.CustomMetadata;
|
|
1616
1260
|
|
|
1617
1261
|
/**
|
|
1618
|
-
*
|
|
1619
|
-
* wallet.
|
|
1262
|
+
* Wallets to create.
|
|
1620
1263
|
*/
|
|
1621
|
-
|
|
1622
|
-
}
|
|
1623
|
-
|
|
1624
|
-
export namespace Wallet {
|
|
1625
|
-
export interface AdditionalSigner {
|
|
1626
|
-
/**
|
|
1627
|
-
* A unique identifier for a key quorum.
|
|
1628
|
-
*/
|
|
1629
|
-
signer_id: SharedAPI.KeyQuorumID;
|
|
1630
|
-
|
|
1631
|
-
/**
|
|
1632
|
-
* The array of policy IDs that will be applied to wallet requests. If specified,
|
|
1633
|
-
* this will override the base policy IDs set on the wallet. Currently, only one
|
|
1634
|
-
* policy is supported per signer.
|
|
1635
|
-
*/
|
|
1636
|
-
override_policy_ids?: Array<string>;
|
|
1637
|
-
}
|
|
1638
|
-
}
|
|
1639
|
-
}
|
|
1640
|
-
|
|
1641
|
-
export interface UserListParams extends CursorParams {}
|
|
1642
|
-
|
|
1643
|
-
export interface UserGetByCustomAuthIDParams {
|
|
1644
|
-
custom_user_id: string;
|
|
1645
|
-
}
|
|
1646
|
-
|
|
1647
|
-
export interface UserGetByDiscordUsernameParams {
|
|
1648
|
-
username: string;
|
|
1649
|
-
}
|
|
1650
|
-
|
|
1651
|
-
export interface UserGetByEmailAddressParams {
|
|
1652
|
-
address: string;
|
|
1653
|
-
}
|
|
1654
|
-
|
|
1655
|
-
export interface UserGetByFarcasterIDParams {
|
|
1656
|
-
fid: number;
|
|
1657
|
-
}
|
|
1658
|
-
|
|
1659
|
-
export interface UserGetByGitHubUsernameParams {
|
|
1660
|
-
username: string;
|
|
1661
|
-
}
|
|
1662
|
-
|
|
1663
|
-
export interface UserGetByPhoneNumberParams {
|
|
1664
|
-
number: string;
|
|
1665
|
-
}
|
|
1666
|
-
|
|
1667
|
-
export interface UserGetBySmartWalletAddressParams {
|
|
1668
|
-
address: string;
|
|
1669
|
-
}
|
|
1670
|
-
|
|
1671
|
-
export interface UserGetByTelegramUserIDParams {
|
|
1672
|
-
telegram_user_id: string;
|
|
1673
|
-
}
|
|
1674
|
-
|
|
1675
|
-
export interface UserGetByTelegramUsernameParams {
|
|
1676
|
-
username: string;
|
|
1677
|
-
}
|
|
1678
|
-
|
|
1679
|
-
export interface UserGetByTwitterSubjectParams {
|
|
1680
|
-
subject: string;
|
|
1681
|
-
}
|
|
1682
|
-
|
|
1683
|
-
export interface UserGetByTwitterUsernameParams {
|
|
1684
|
-
username: string;
|
|
1685
|
-
}
|
|
1686
|
-
|
|
1687
|
-
export interface UserGetByWalletAddressParams {
|
|
1688
|
-
address: string;
|
|
1689
|
-
}
|
|
1690
|
-
|
|
1691
|
-
export interface UserPregenerateWalletsParams {
|
|
1692
|
-
wallets: Array<EmbeddedWalletsAPI.WalletCreationInput>;
|
|
1693
|
-
}
|
|
1694
|
-
|
|
1695
|
-
export type UserSearchParams = UserSearchParams.Variant0 | UserSearchParams.Variant1;
|
|
1696
|
-
|
|
1697
|
-
export declare namespace UserSearchParams {
|
|
1698
|
-
export interface Variant0 {
|
|
1699
|
-
searchTerm: string;
|
|
1700
|
-
}
|
|
1701
|
-
|
|
1702
|
-
export interface Variant1 {
|
|
1703
|
-
emails: Array<string>;
|
|
1704
|
-
|
|
1705
|
-
phoneNumbers: Array<string>;
|
|
1706
|
-
|
|
1707
|
-
walletAddresses: Array<string>;
|
|
1264
|
+
wallets?: Array<EmbeddedWalletsAPI.WalletCreationInput>;
|
|
1708
1265
|
}
|
|
1709
1266
|
}
|
|
1710
1267
|
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
}
|
|
1717
|
-
|
|
1718
|
-
export interface UserUnlinkLinkedAccountParams {
|
|
1719
|
-
handle: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* The user object along their identity token.
|
|
1270
|
+
*/
|
|
1271
|
+
export interface UserWithIdentityToken {
|
|
1272
|
+
identity_token: string | null;
|
|
1720
1273
|
|
|
1721
1274
|
/**
|
|
1722
|
-
*
|
|
1275
|
+
* A Privy user object.
|
|
1723
1276
|
*/
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
provider?: string;
|
|
1277
|
+
user: User;
|
|
1727
1278
|
}
|
|
1728
1279
|
|
|
1729
1280
|
export declare namespace Users {
|
|
1730
1281
|
export {
|
|
1282
|
+
type AuthenticatedUser as AuthenticatedUser,
|
|
1283
|
+
type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet,
|
|
1284
|
+
type CrossAppSmartWallet as CrossAppSmartWallet,
|
|
1731
1285
|
type CustomMetadata as CustomMetadata,
|
|
1732
|
-
type
|
|
1733
|
-
type
|
|
1734
|
-
type
|
|
1735
|
-
type
|
|
1736
|
-
type
|
|
1286
|
+
type EmbeddedWalletRecoveryMethod as EmbeddedWalletRecoveryMethod,
|
|
1287
|
+
type LinkedAccount as LinkedAccount,
|
|
1288
|
+
type LinkedAccountAppleInput as LinkedAccountAppleInput,
|
|
1289
|
+
type LinkedAccountAppleOAuth as LinkedAccountAppleOAuth,
|
|
1290
|
+
type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey,
|
|
1291
|
+
type LinkedAccountBaseWallet as LinkedAccountBaseWallet,
|
|
1292
|
+
type LinkedAccountBitcoinSegwitEmbeddedWallet as LinkedAccountBitcoinSegwitEmbeddedWallet,
|
|
1293
|
+
type LinkedAccountBitcoinTaprootEmbeddedWallet as LinkedAccountBitcoinTaprootEmbeddedWallet,
|
|
1294
|
+
type LinkedAccountCrossApp as LinkedAccountCrossApp,
|
|
1295
|
+
type LinkedAccountCurveSigningEmbeddedWallet as LinkedAccountCurveSigningEmbeddedWallet,
|
|
1296
|
+
type LinkedAccountCustomJwtInput as LinkedAccountCustomJwtInput,
|
|
1297
|
+
type LinkedAccountCustomJwt as LinkedAccountCustomJwt,
|
|
1298
|
+
type LinkedAccountCustomOAuth as LinkedAccountCustomOAuth,
|
|
1737
1299
|
type LinkedAccountDiscordInput as LinkedAccountDiscordInput,
|
|
1300
|
+
type LinkedAccountDiscordOAuth as LinkedAccountDiscordOAuth,
|
|
1301
|
+
type LinkedAccountEmail as LinkedAccountEmail,
|
|
1302
|
+
type LinkedAccountEmailInput as LinkedAccountEmailInput,
|
|
1303
|
+
type LinkedAccountEmbeddedWallet as LinkedAccountEmbeddedWallet,
|
|
1304
|
+
type LinkedAccountEmbeddedWalletWithID as LinkedAccountEmbeddedWalletWithID,
|
|
1305
|
+
type LinkedAccountEthereum as LinkedAccountEthereum,
|
|
1306
|
+
type LinkedAccountEthereumEmbeddedWallet as LinkedAccountEthereumEmbeddedWallet,
|
|
1307
|
+
type LinkedAccountFarcaster as LinkedAccountFarcaster,
|
|
1308
|
+
type LinkedAccountFarcasterInput as LinkedAccountFarcasterInput,
|
|
1738
1309
|
type LinkedAccountGitHubInput as LinkedAccountGitHubInput,
|
|
1739
|
-
type
|
|
1310
|
+
type LinkedAccountGitHubOAuth as LinkedAccountGitHubOAuth,
|
|
1311
|
+
type LinkedAccountGoogleInput as LinkedAccountGoogleInput,
|
|
1312
|
+
type LinkedAccountGoogleOAuth as LinkedAccountGoogleOAuth,
|
|
1313
|
+
type LinkedAccountInput as LinkedAccountInput,
|
|
1740
1314
|
type LinkedAccountInstagramInput as LinkedAccountInstagramInput,
|
|
1741
|
-
type
|
|
1315
|
+
type LinkedAccountInstagramOAuth as LinkedAccountInstagramOAuth,
|
|
1742
1316
|
type LinkedAccountLineInput as LinkedAccountLineInput,
|
|
1743
|
-
type
|
|
1744
|
-
type LinkedAccountAppleInput as LinkedAccountAppleInput,
|
|
1317
|
+
type LinkedAccountLineOAuth as LinkedAccountLineOAuth,
|
|
1745
1318
|
type LinkedAccountLinkedInInput as LinkedAccountLinkedInInput,
|
|
1746
|
-
type
|
|
1747
|
-
type
|
|
1748
|
-
type LinkedAccountCustomJwtInput as LinkedAccountCustomJwtInput,
|
|
1319
|
+
type LinkedAccountLinkedInOAuth as LinkedAccountLinkedInOAuth,
|
|
1320
|
+
type LinkedAccountPasskey as LinkedAccountPasskey,
|
|
1749
1321
|
type LinkedAccountPasskeyInput as LinkedAccountPasskeyInput,
|
|
1750
|
-
type LinkedAccountInput as LinkedAccountInput,
|
|
1751
|
-
type UserBatchCreateInput as UserBatchCreateInput,
|
|
1752
|
-
type LinkedAccountEmail as LinkedAccountEmail,
|
|
1753
1322
|
type LinkedAccountPhone as LinkedAccountPhone,
|
|
1754
|
-
type
|
|
1755
|
-
type LinkedAccountEthereum as LinkedAccountEthereum,
|
|
1323
|
+
type LinkedAccountPhoneInput as LinkedAccountPhoneInput,
|
|
1756
1324
|
type LinkedAccountSmartWallet as LinkedAccountSmartWallet,
|
|
1757
1325
|
type LinkedAccountSolana as LinkedAccountSolana,
|
|
1758
|
-
type LinkedAccountFarcaster as LinkedAccountFarcaster,
|
|
1759
|
-
type LinkedAccountPasskey as LinkedAccountPasskey,
|
|
1760
|
-
type LinkedAccountTelegram as LinkedAccountTelegram,
|
|
1761
|
-
type EmbeddedWalletRecoveryMethod as EmbeddedWalletRecoveryMethod,
|
|
1762
|
-
type LinkedAccountEthereumEmbeddedWallet as LinkedAccountEthereumEmbeddedWallet,
|
|
1763
1326
|
type LinkedAccountSolanaEmbeddedWallet as LinkedAccountSolanaEmbeddedWallet,
|
|
1764
|
-
type
|
|
1765
|
-
type LinkedAccountBitcoinTaprootEmbeddedWallet as LinkedAccountBitcoinTaprootEmbeddedWallet,
|
|
1766
|
-
type LinkedAccountCurveSigningEmbeddedWallet as LinkedAccountCurveSigningEmbeddedWallet,
|
|
1767
|
-
type LinkedAccountEmbeddedWallet as LinkedAccountEmbeddedWallet,
|
|
1768
|
-
type LinkedAccountEmbeddedWalletWithID as LinkedAccountEmbeddedWalletWithID,
|
|
1769
|
-
type LinkedAccountGoogleOAuth as LinkedAccountGoogleOAuth,
|
|
1770
|
-
type LinkedAccountTwitterOAuth as LinkedAccountTwitterOAuth,
|
|
1771
|
-
type LinkedAccountDiscordOAuth as LinkedAccountDiscordOAuth,
|
|
1772
|
-
type LinkedAccountGitHubOAuth as LinkedAccountGitHubOAuth,
|
|
1773
|
-
type LinkedAccountLinkedInOAuth as LinkedAccountLinkedInOAuth,
|
|
1327
|
+
type LinkedAccountSpotifyInput as LinkedAccountSpotifyInput,
|
|
1774
1328
|
type LinkedAccountSpotifyOAuth as LinkedAccountSpotifyOAuth,
|
|
1775
|
-
type
|
|
1329
|
+
type LinkedAccountTelegram as LinkedAccountTelegram,
|
|
1330
|
+
type LinkedAccountTelegramInput as LinkedAccountTelegramInput,
|
|
1331
|
+
type LinkedAccountTiktokInput as LinkedAccountTiktokInput,
|
|
1776
1332
|
type LinkedAccountTiktokOAuth as LinkedAccountTiktokOAuth,
|
|
1777
|
-
type
|
|
1333
|
+
type LinkedAccountTwitchInput as LinkedAccountTwitchInput,
|
|
1778
1334
|
type LinkedAccountTwitchOAuth as LinkedAccountTwitchOAuth,
|
|
1779
|
-
type
|
|
1780
|
-
type
|
|
1781
|
-
type LinkedAccountCustomJwt as LinkedAccountCustomJwt,
|
|
1782
|
-
type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet,
|
|
1783
|
-
type CrossAppSmartWallet as CrossAppSmartWallet,
|
|
1784
|
-
type LinkedAccountCrossApp as LinkedAccountCrossApp,
|
|
1785
|
-
type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey,
|
|
1786
|
-
type LinkedAccount as LinkedAccount,
|
|
1335
|
+
type LinkedAccountTwitterInput as LinkedAccountTwitterInput,
|
|
1336
|
+
type LinkedAccountTwitterOAuth as LinkedAccountTwitterOAuth,
|
|
1787
1337
|
type LinkedAccountType as LinkedAccountType,
|
|
1338
|
+
type LinkedAccountWalletInput as LinkedAccountWalletInput,
|
|
1339
|
+
type LinkedMfaMethod as LinkedMfaMethod,
|
|
1340
|
+
type OAuthTokens as OAuthTokens,
|
|
1341
|
+
type PasskeyMfaMethod as PasskeyMfaMethod,
|
|
1342
|
+
type PatchUsersCustomMetadata as PatchUsersCustomMetadata,
|
|
1788
1343
|
type SMSMfaMethod as SMSMfaMethod,
|
|
1789
1344
|
type TotpMfaMethod as TotpMfaMethod,
|
|
1790
|
-
type PasskeyMfaMethod as PasskeyMfaMethod,
|
|
1791
|
-
type LinkedMfaMethod as LinkedMfaMethod,
|
|
1792
1345
|
type User as User,
|
|
1793
|
-
type
|
|
1346
|
+
type UserBatchCreateInput as UserBatchCreateInput,
|
|
1794
1347
|
type UserWithIdentityToken as UserWithIdentityToken,
|
|
1795
|
-
type AuthenticatedUser as AuthenticatedUser,
|
|
1796
|
-
type UsersCursor as UsersCursor,
|
|
1797
|
-
type UserCreateParams as UserCreateParams,
|
|
1798
|
-
type UserListParams as UserListParams,
|
|
1799
|
-
type UserGetByCustomAuthIDParams as UserGetByCustomAuthIDParams,
|
|
1800
|
-
type UserGetByDiscordUsernameParams as UserGetByDiscordUsernameParams,
|
|
1801
|
-
type UserGetByEmailAddressParams as UserGetByEmailAddressParams,
|
|
1802
|
-
type UserGetByFarcasterIDParams as UserGetByFarcasterIDParams,
|
|
1803
|
-
type UserGetByGitHubUsernameParams as UserGetByGitHubUsernameParams,
|
|
1804
|
-
type UserGetByPhoneNumberParams as UserGetByPhoneNumberParams,
|
|
1805
|
-
type UserGetBySmartWalletAddressParams as UserGetBySmartWalletAddressParams,
|
|
1806
|
-
type UserGetByTelegramUserIDParams as UserGetByTelegramUserIDParams,
|
|
1807
|
-
type UserGetByTelegramUsernameParams as UserGetByTelegramUsernameParams,
|
|
1808
|
-
type UserGetByTwitterSubjectParams as UserGetByTwitterSubjectParams,
|
|
1809
|
-
type UserGetByTwitterUsernameParams as UserGetByTwitterUsernameParams,
|
|
1810
|
-
type UserGetByWalletAddressParams as UserGetByWalletAddressParams,
|
|
1811
|
-
type UserPregenerateWalletsParams as UserPregenerateWalletsParams,
|
|
1812
|
-
type UserSearchParams as UserSearchParams,
|
|
1813
|
-
type UserSetCustomMetadataParams as UserSetCustomMetadataParams,
|
|
1814
|
-
type UserUnlinkLinkedAccountParams as UserUnlinkLinkedAccountParams,
|
|
1815
1348
|
};
|
|
1816
1349
|
}
|