@privy-io/api-types 0.3.4 → 0.5.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 +82 -0
- package/LICENSE +1 -1
- package/README.md +31 -0
- package/client.d.mts +21 -11
- package/client.d.mts.map +1 -1
- package/client.d.ts +21 -11
- package/client.d.ts.map +1 -1
- package/client.js +20 -3
- package/client.js.map +1 -1
- package/client.mjs +20 -3
- package/client.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +5 -0
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +5 -0
- package/internal/parse.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/aggregations.d.mts +507 -0
- package/resources/aggregations.d.mts.map +1 -0
- package/resources/aggregations.d.ts +507 -0
- package/resources/aggregations.d.ts.map +1 -0
- package/resources/aggregations.js +9 -0
- package/resources/aggregations.js.map +1 -0
- package/resources/aggregations.mjs +5 -0
- package/resources/aggregations.mjs.map +1 -0
- package/resources/client-auth.d.mts +183 -24
- package/resources/client-auth.d.mts.map +1 -1
- package/resources/client-auth.d.ts +183 -24
- package/resources/client-auth.d.ts.map +1 -1
- package/resources/funding.d.mts +4 -4
- package/resources/funding.d.mts.map +1 -1
- package/resources/funding.d.ts +4 -4
- package/resources/funding.d.ts.map +1 -1
- package/resources/index.d.mts +7 -4
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +7 -4
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -1
- package/resources/key-quorums.d.mts +4 -1
- package/resources/key-quorums.d.mts.map +1 -1
- package/resources/key-quorums.d.ts +4 -1
- package/resources/key-quorums.d.ts.map +1 -1
- package/resources/policies.d.mts +89 -135
- package/resources/policies.d.mts.map +1 -1
- package/resources/policies.d.ts +89 -135
- package/resources/policies.d.ts.map +1 -1
- package/resources/policies.js.map +1 -1
- package/resources/policies.mjs.map +1 -1
- package/resources/users.d.mts +679 -415
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +679 -415
- package/resources/users.d.ts.map +1 -1
- package/resources/wallets/balance.d.mts +11 -6
- package/resources/wallets/balance.d.mts.map +1 -1
- package/resources/wallets/balance.d.ts +11 -6
- package/resources/wallets/balance.d.ts.map +1 -1
- package/resources/wallets/balance.js +1 -2
- package/resources/wallets/balance.js.map +1 -1
- package/resources/wallets/balance.mjs +1 -2
- package/resources/wallets/balance.mjs.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 +3 -3
- package/resources/wallets/transactions.d.mts.map +1 -1
- package/resources/wallets/transactions.d.ts +3 -3
- package/resources/wallets/transactions.d.ts.map +1 -1
- package/resources/wallets/wallets.d.mts +347 -65
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +347 -65
- package/resources/wallets/wallets.d.ts.map +1 -1
- package/resources/wallets/wallets.js +1 -1
- package/resources/wallets/wallets.js.map +1 -1
- package/resources/wallets/wallets.mjs +1 -1
- package/resources/wallets/wallets.mjs.map +1 -1
- package/resources/webhooks.d.mts +940 -0
- package/resources/webhooks.d.mts.map +1 -0
- package/resources/webhooks.d.ts +940 -0
- package/resources/webhooks.d.ts.map +1 -0
- package/resources/webhooks.js +9 -0
- package/resources/webhooks.js.map +1 -0
- package/resources/webhooks.mjs +5 -0
- package/resources/webhooks.mjs.map +1 -0
- package/resources/yield.d.mts +264 -0
- package/resources/yield.d.mts.map +1 -0
- package/resources/yield.d.ts +264 -0
- package/resources/yield.d.ts.map +1 -0
- package/resources/yield.js +9 -0
- package/resources/yield.js.map +1 -0
- package/resources/yield.mjs +5 -0
- package/resources/yield.mjs.map +1 -0
- package/src/client.ts +331 -16
- package/src/internal/parse.ts +6 -0
- package/src/resources/aggregations.ts +853 -0
- package/src/resources/client-auth.ts +309 -35
- package/src/resources/funding.ts +4 -1
- package/src/resources/index.ts +156 -9
- package/src/resources/key-quorums.ts +4 -1
- package/src/resources/policies.ts +129 -214
- package/src/resources/users.ts +974 -650
- package/src/resources/wallets/balance.ts +24 -6
- package/src/resources/wallets/index.ts +13 -3
- package/src/resources/wallets/transactions.ts +11 -3
- package/src/resources/wallets/wallets.ts +468 -91
- package/src/resources/webhooks.ts +1287 -0
- package/src/resources/yield.ts +330 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/src/resources/users.ts
CHANGED
|
@@ -319,1020 +319,1310 @@ export class Users extends APIResource {
|
|
|
319
319
|
export type UsersCursor = Cursor<User>;
|
|
320
320
|
|
|
321
321
|
/**
|
|
322
|
-
*
|
|
322
|
+
* An email account linked to the user.
|
|
323
323
|
*/
|
|
324
|
-
export interface
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
privy_access_token: string | null;
|
|
328
|
-
|
|
329
|
-
refresh_token: string | null;
|
|
330
|
-
|
|
331
|
-
/**
|
|
332
|
-
* Instructs the client on how to handle tokens received
|
|
333
|
-
*/
|
|
334
|
-
session_update_action: 'set' | 'ignore' | 'clear';
|
|
324
|
+
export interface LinkedAccountEmail {
|
|
325
|
+
address: string;
|
|
335
326
|
|
|
336
|
-
|
|
327
|
+
first_verified_at: number | null;
|
|
337
328
|
|
|
338
|
-
|
|
329
|
+
latest_verified_at: number | null;
|
|
339
330
|
|
|
340
|
-
|
|
331
|
+
type: 'email';
|
|
341
332
|
|
|
342
|
-
|
|
343
|
-
* OAuth tokens associated with the user.
|
|
344
|
-
*/
|
|
345
|
-
oauth_tokens?: AuthenticatedUser.OAuthTokens;
|
|
333
|
+
verified_at: number;
|
|
346
334
|
}
|
|
347
335
|
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
access_token: string;
|
|
336
|
+
/**
|
|
337
|
+
* A phone number account linked to the user.
|
|
338
|
+
*/
|
|
339
|
+
export interface LinkedAccountPhone {
|
|
340
|
+
first_verified_at: number | null;
|
|
354
341
|
|
|
355
|
-
|
|
342
|
+
latest_verified_at: number | null;
|
|
356
343
|
|
|
357
|
-
|
|
344
|
+
phoneNumber: string;
|
|
358
345
|
|
|
359
|
-
|
|
346
|
+
type: 'phone';
|
|
360
347
|
|
|
361
|
-
|
|
348
|
+
verified_at: number;
|
|
362
349
|
|
|
363
|
-
|
|
364
|
-
}
|
|
350
|
+
number?: string;
|
|
365
351
|
}
|
|
366
352
|
|
|
367
353
|
/**
|
|
368
|
-
*
|
|
354
|
+
* Base schema for wallet accounts linked to the user.
|
|
369
355
|
*/
|
|
370
|
-
export
|
|
371
|
-
|
|
372
|
-
| LinkedAccount.LinkedAccountPhone
|
|
373
|
-
| LinkedAccount.LinkedAccountCrossApp
|
|
374
|
-
| LinkedAccount.LinkedAccountAuthorizationKey
|
|
375
|
-
| LinkedAccount.LinkedAccountCustomJwt
|
|
376
|
-
| LinkedAccount.LinkedAccountAppleOAuth
|
|
377
|
-
| LinkedAccount.LinkedAccountDiscordOAuth
|
|
378
|
-
| LinkedAccount.LinkedAccountGitHubOAuth
|
|
379
|
-
| LinkedAccount.LinkedAccountGoogleOAuth
|
|
380
|
-
| LinkedAccount.LinkedAccountInstagramOAuth
|
|
381
|
-
| LinkedAccount.LinkedAccountLinkedInOAuth
|
|
382
|
-
| LinkedAccount.LinkedAccountSpotifyOAuth
|
|
383
|
-
| LinkedAccount.LinkedAccountTiktokOAuth
|
|
384
|
-
| LinkedAccount.LinkedAccountLineOAuth
|
|
385
|
-
| LinkedAccount.LinkedAccountTwitchOAuth
|
|
386
|
-
| LinkedAccount.LinkedAccountTwitterOAuth
|
|
387
|
-
| LinkedAccountSmartWallet
|
|
388
|
-
| LinkedAccount.LinkedAccountPasskey
|
|
389
|
-
| LinkedAccount.LinkedAccountFarcaster
|
|
390
|
-
| LinkedAccount.LinkedAccountTelegram
|
|
391
|
-
| LinkedAccount.LinkedAccountEthereum
|
|
392
|
-
| LinkedAccountEthereumEmbeddedWallet
|
|
393
|
-
| LinkedAccount.LinkedAccountSolana
|
|
394
|
-
| LinkedAccountSolanaEmbeddedWallet
|
|
395
|
-
| LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
396
|
-
| LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
397
|
-
| LinkedAccountCurveSigningEmbeddedWallet
|
|
398
|
-
| LinkedAccount.LinkedAccountCustomOAuth;
|
|
399
|
-
|
|
400
|
-
export namespace LinkedAccount {
|
|
401
|
-
export interface LinkedAccountEmail {
|
|
402
|
-
address: string;
|
|
403
|
-
|
|
404
|
-
first_verified_at: number | null;
|
|
356
|
+
export interface LinkedAccountBaseWallet {
|
|
357
|
+
address: string;
|
|
405
358
|
|
|
406
|
-
|
|
359
|
+
chain_type: 'solana' | 'ethereum';
|
|
407
360
|
|
|
408
|
-
|
|
361
|
+
type: 'wallet' | 'smart_wallet';
|
|
362
|
+
}
|
|
409
363
|
|
|
410
|
-
|
|
411
|
-
|
|
364
|
+
/**
|
|
365
|
+
* An Ethereum wallet account linked to the user.
|
|
366
|
+
*/
|
|
367
|
+
export interface LinkedAccountEthereum {
|
|
368
|
+
address: string;
|
|
412
369
|
|
|
413
|
-
|
|
414
|
-
first_verified_at: number | null;
|
|
370
|
+
chain_type: 'ethereum';
|
|
415
371
|
|
|
416
|
-
|
|
372
|
+
first_verified_at: number | null;
|
|
417
373
|
|
|
418
|
-
|
|
374
|
+
latest_verified_at: number | null;
|
|
419
375
|
|
|
420
|
-
|
|
376
|
+
type: 'wallet';
|
|
421
377
|
|
|
422
|
-
|
|
378
|
+
verified_at: number;
|
|
423
379
|
|
|
424
|
-
|
|
425
|
-
}
|
|
380
|
+
wallet_client: 'unknown';
|
|
426
381
|
|
|
427
|
-
|
|
428
|
-
embedded_wallets: Array<LinkedAccountCrossApp.EmbeddedWallet>;
|
|
382
|
+
chain_id?: string;
|
|
429
383
|
|
|
430
|
-
|
|
384
|
+
connector_type?: string;
|
|
431
385
|
|
|
432
|
-
|
|
386
|
+
wallet_client_type?: string;
|
|
387
|
+
}
|
|
433
388
|
|
|
434
|
-
|
|
389
|
+
/**
|
|
390
|
+
* The provider for a smart wallet.
|
|
391
|
+
*/
|
|
392
|
+
export type SmartWalletType =
|
|
393
|
+
| 'safe'
|
|
394
|
+
| 'kernel'
|
|
395
|
+
| 'light_account'
|
|
396
|
+
| 'biconomy'
|
|
397
|
+
| 'coinbase_smart_wallet'
|
|
398
|
+
| 'thirdweb';
|
|
435
399
|
|
|
436
|
-
|
|
400
|
+
/**
|
|
401
|
+
* A smart wallet account linked to the user.
|
|
402
|
+
*/
|
|
403
|
+
export interface LinkedAccountSmartWallet {
|
|
404
|
+
address: string;
|
|
437
405
|
|
|
438
|
-
|
|
406
|
+
first_verified_at: number | null;
|
|
439
407
|
|
|
440
|
-
|
|
408
|
+
latest_verified_at: number | null;
|
|
441
409
|
|
|
442
|
-
|
|
443
|
-
|
|
410
|
+
/**
|
|
411
|
+
* The provider for a smart wallet.
|
|
412
|
+
*/
|
|
413
|
+
smart_wallet_type: SmartWalletType;
|
|
444
414
|
|
|
445
|
-
|
|
446
|
-
export interface EmbeddedWallet {
|
|
447
|
-
address: string;
|
|
448
|
-
}
|
|
415
|
+
type: 'smart_wallet';
|
|
449
416
|
|
|
450
|
-
|
|
451
|
-
address: string;
|
|
452
|
-
}
|
|
453
|
-
}
|
|
417
|
+
verified_at: number;
|
|
454
418
|
|
|
455
|
-
|
|
456
|
-
|
|
419
|
+
smart_wallet_version?: string;
|
|
420
|
+
}
|
|
457
421
|
|
|
458
|
-
|
|
422
|
+
/**
|
|
423
|
+
* A Solana wallet account linked to the user.
|
|
424
|
+
*/
|
|
425
|
+
export interface LinkedAccountSolana {
|
|
426
|
+
address: string;
|
|
459
427
|
|
|
460
|
-
|
|
428
|
+
chain_type: 'solana';
|
|
461
429
|
|
|
462
|
-
|
|
430
|
+
first_verified_at: number | null;
|
|
463
431
|
|
|
464
|
-
|
|
465
|
-
}
|
|
432
|
+
latest_verified_at: number | null;
|
|
466
433
|
|
|
467
|
-
|
|
468
|
-
custom_user_id: string;
|
|
434
|
+
type: 'wallet';
|
|
469
435
|
|
|
470
|
-
|
|
436
|
+
verified_at: number;
|
|
471
437
|
|
|
472
|
-
|
|
438
|
+
wallet_client: 'unknown';
|
|
473
439
|
|
|
474
|
-
|
|
440
|
+
connector_type?: string;
|
|
475
441
|
|
|
476
|
-
|
|
477
|
-
|
|
442
|
+
wallet_client_type?: string;
|
|
443
|
+
}
|
|
478
444
|
|
|
479
|
-
|
|
480
|
-
|
|
445
|
+
/**
|
|
446
|
+
* A Farcaster account linked to the user.
|
|
447
|
+
*/
|
|
448
|
+
export interface LinkedAccountFarcaster {
|
|
449
|
+
fid: number;
|
|
481
450
|
|
|
482
|
-
|
|
451
|
+
first_verified_at: number | null;
|
|
483
452
|
|
|
484
|
-
|
|
453
|
+
latest_verified_at: number | null;
|
|
485
454
|
|
|
486
|
-
|
|
455
|
+
owner_address: string;
|
|
487
456
|
|
|
488
|
-
|
|
457
|
+
type: 'farcaster';
|
|
489
458
|
|
|
490
|
-
|
|
491
|
-
}
|
|
459
|
+
verified_at: number;
|
|
492
460
|
|
|
493
|
-
|
|
494
|
-
email: string | null;
|
|
461
|
+
bio?: string;
|
|
495
462
|
|
|
496
|
-
|
|
463
|
+
display_name?: string;
|
|
497
464
|
|
|
498
|
-
|
|
465
|
+
homepage_url?: string;
|
|
499
466
|
|
|
500
|
-
|
|
467
|
+
profile_picture?: string;
|
|
501
468
|
|
|
502
|
-
|
|
469
|
+
profile_picture_url?: string;
|
|
503
470
|
|
|
504
|
-
|
|
471
|
+
signer_public_key?: string;
|
|
505
472
|
|
|
506
|
-
|
|
507
|
-
|
|
473
|
+
username?: string;
|
|
474
|
+
}
|
|
508
475
|
|
|
509
|
-
|
|
510
|
-
|
|
476
|
+
/**
|
|
477
|
+
* A passkey account linked to the user.
|
|
478
|
+
*/
|
|
479
|
+
export interface LinkedAccountPasskey {
|
|
480
|
+
credential_id: string;
|
|
511
481
|
|
|
512
|
-
|
|
482
|
+
enrolled_in_mfa: boolean;
|
|
513
483
|
|
|
514
|
-
|
|
484
|
+
first_verified_at: number | null;
|
|
515
485
|
|
|
516
|
-
|
|
486
|
+
latest_verified_at: number | null;
|
|
517
487
|
|
|
518
|
-
|
|
488
|
+
type: 'passkey';
|
|
519
489
|
|
|
520
|
-
|
|
490
|
+
verified_at: number;
|
|
521
491
|
|
|
522
|
-
|
|
492
|
+
authenticator_name?: string;
|
|
523
493
|
|
|
524
|
-
|
|
525
|
-
}
|
|
494
|
+
created_with_browser?: string;
|
|
526
495
|
|
|
527
|
-
|
|
528
|
-
email: string;
|
|
496
|
+
created_with_device?: string;
|
|
529
497
|
|
|
530
|
-
|
|
498
|
+
created_with_os?: string;
|
|
531
499
|
|
|
532
|
-
|
|
500
|
+
public_key?: string;
|
|
501
|
+
}
|
|
533
502
|
|
|
534
|
-
|
|
503
|
+
/**
|
|
504
|
+
* A Telegram account linked to the user.
|
|
505
|
+
*/
|
|
506
|
+
export interface LinkedAccountTelegram {
|
|
507
|
+
first_verified_at: number | null;
|
|
535
508
|
|
|
536
|
-
|
|
509
|
+
latest_verified_at: number | null;
|
|
537
510
|
|
|
538
|
-
|
|
511
|
+
telegram_user_id: string;
|
|
539
512
|
|
|
540
|
-
|
|
541
|
-
}
|
|
513
|
+
type: 'telegram';
|
|
542
514
|
|
|
543
|
-
|
|
544
|
-
first_verified_at: number | null;
|
|
515
|
+
verified_at: number;
|
|
545
516
|
|
|
546
|
-
|
|
517
|
+
first_name?: string | null;
|
|
547
518
|
|
|
548
|
-
|
|
519
|
+
last_name?: string | null;
|
|
549
520
|
|
|
550
|
-
|
|
521
|
+
photo_url?: string | null;
|
|
551
522
|
|
|
552
|
-
|
|
523
|
+
username?: string | null;
|
|
524
|
+
}
|
|
553
525
|
|
|
554
|
-
|
|
555
|
-
|
|
526
|
+
/**
|
|
527
|
+
* The method used to recover an embedded wallet account.
|
|
528
|
+
*/
|
|
529
|
+
export type EmbeddedWalletRecoveryMethod =
|
|
530
|
+
| 'privy'
|
|
531
|
+
| 'user-passcode'
|
|
532
|
+
| 'google-drive'
|
|
533
|
+
| 'icloud'
|
|
534
|
+
| 'recovery-encryption-key'
|
|
535
|
+
| 'privy-v2';
|
|
556
536
|
|
|
557
|
-
|
|
558
|
-
|
|
537
|
+
/**
|
|
538
|
+
* An Ethereum embedded wallet account linked to the user.
|
|
539
|
+
*/
|
|
540
|
+
export interface LinkedAccountEthereumEmbeddedWallet {
|
|
541
|
+
id: string | null;
|
|
559
542
|
|
|
560
|
-
|
|
543
|
+
address: string;
|
|
561
544
|
|
|
562
|
-
|
|
545
|
+
chain_id: string;
|
|
563
546
|
|
|
564
|
-
|
|
547
|
+
chain_type: 'ethereum';
|
|
565
548
|
|
|
566
|
-
|
|
549
|
+
connector_type: 'embedded';
|
|
567
550
|
|
|
568
|
-
|
|
551
|
+
delegated: boolean;
|
|
569
552
|
|
|
570
|
-
|
|
553
|
+
first_verified_at: number | null;
|
|
571
554
|
|
|
572
|
-
|
|
573
|
-
}
|
|
555
|
+
imported: boolean;
|
|
574
556
|
|
|
575
|
-
|
|
576
|
-
email: string | null;
|
|
557
|
+
latest_verified_at: number | null;
|
|
577
558
|
|
|
578
|
-
|
|
559
|
+
/**
|
|
560
|
+
* The method used to recover an embedded wallet account.
|
|
561
|
+
*/
|
|
562
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
579
563
|
|
|
580
|
-
|
|
564
|
+
type: 'wallet';
|
|
581
565
|
|
|
582
|
-
|
|
566
|
+
verified_at: number;
|
|
583
567
|
|
|
584
|
-
|
|
568
|
+
wallet_client: 'privy';
|
|
585
569
|
|
|
586
|
-
|
|
570
|
+
wallet_client_type: 'privy';
|
|
587
571
|
|
|
588
|
-
|
|
589
|
-
|
|
572
|
+
wallet_index: number;
|
|
573
|
+
}
|
|
590
574
|
|
|
591
|
-
|
|
592
|
-
|
|
575
|
+
/**
|
|
576
|
+
* A Solana embedded wallet account linked to the user.
|
|
577
|
+
*/
|
|
578
|
+
export interface LinkedAccountSolanaEmbeddedWallet {
|
|
579
|
+
id: string | null;
|
|
593
580
|
|
|
594
|
-
|
|
581
|
+
address: string;
|
|
595
582
|
|
|
596
|
-
|
|
583
|
+
chain_id: string;
|
|
597
584
|
|
|
598
|
-
|
|
585
|
+
chain_type: 'solana';
|
|
599
586
|
|
|
600
|
-
|
|
587
|
+
connector_type: 'embedded';
|
|
601
588
|
|
|
602
|
-
|
|
589
|
+
delegated: boolean;
|
|
603
590
|
|
|
604
|
-
|
|
605
|
-
}
|
|
591
|
+
first_verified_at: number | null;
|
|
606
592
|
|
|
607
|
-
|
|
608
|
-
email: string | null;
|
|
593
|
+
imported: boolean;
|
|
609
594
|
|
|
610
|
-
|
|
595
|
+
latest_verified_at: number | null;
|
|
611
596
|
|
|
612
|
-
|
|
597
|
+
public_key: string;
|
|
613
598
|
|
|
614
|
-
|
|
599
|
+
/**
|
|
600
|
+
* The method used to recover an embedded wallet account.
|
|
601
|
+
*/
|
|
602
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
615
603
|
|
|
616
|
-
|
|
604
|
+
type: 'wallet';
|
|
617
605
|
|
|
618
|
-
|
|
606
|
+
verified_at: number;
|
|
619
607
|
|
|
620
|
-
|
|
608
|
+
wallet_client: 'privy';
|
|
621
609
|
|
|
622
|
-
|
|
623
|
-
}
|
|
610
|
+
wallet_client_type: 'privy';
|
|
624
611
|
|
|
625
|
-
|
|
626
|
-
|
|
612
|
+
wallet_index: number;
|
|
613
|
+
}
|
|
627
614
|
|
|
628
|
-
|
|
615
|
+
/**
|
|
616
|
+
* A Bitcoin SegWit embedded wallet account linked to the user.
|
|
617
|
+
*/
|
|
618
|
+
export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
|
|
619
|
+
id: string | null;
|
|
629
620
|
|
|
630
|
-
|
|
621
|
+
address: string;
|
|
631
622
|
|
|
632
|
-
|
|
623
|
+
chain_id: string;
|
|
633
624
|
|
|
634
|
-
|
|
625
|
+
chain_type: 'bitcoin-segwit';
|
|
635
626
|
|
|
636
|
-
|
|
637
|
-
}
|
|
627
|
+
connector_type: 'embedded';
|
|
638
628
|
|
|
639
|
-
|
|
640
|
-
first_verified_at: number | null;
|
|
629
|
+
delegated: boolean;
|
|
641
630
|
|
|
642
|
-
|
|
631
|
+
first_verified_at: number | null;
|
|
643
632
|
|
|
644
|
-
|
|
633
|
+
imported: boolean;
|
|
645
634
|
|
|
646
|
-
|
|
635
|
+
latest_verified_at: number | null;
|
|
647
636
|
|
|
648
|
-
|
|
637
|
+
public_key: string;
|
|
649
638
|
|
|
650
|
-
|
|
639
|
+
/**
|
|
640
|
+
* The method used to recover an embedded wallet account.
|
|
641
|
+
*/
|
|
642
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
651
643
|
|
|
652
|
-
|
|
644
|
+
type: 'wallet';
|
|
653
645
|
|
|
654
|
-
|
|
655
|
-
}
|
|
646
|
+
verified_at: number;
|
|
656
647
|
|
|
657
|
-
|
|
658
|
-
credential_id: string;
|
|
648
|
+
wallet_client: 'privy';
|
|
659
649
|
|
|
660
|
-
|
|
650
|
+
wallet_client_type: 'privy';
|
|
661
651
|
|
|
662
|
-
|
|
652
|
+
wallet_index: number;
|
|
653
|
+
}
|
|
663
654
|
|
|
664
|
-
|
|
655
|
+
/**
|
|
656
|
+
* A Bitcoin Taproot embedded wallet account linked to the user.
|
|
657
|
+
*/
|
|
658
|
+
export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
|
|
659
|
+
id: string | null;
|
|
665
660
|
|
|
666
|
-
|
|
661
|
+
address: string;
|
|
667
662
|
|
|
668
|
-
|
|
663
|
+
chain_id: string;
|
|
669
664
|
|
|
670
|
-
|
|
665
|
+
chain_type: 'bitcoin-taproot';
|
|
671
666
|
|
|
672
|
-
|
|
667
|
+
connector_type: 'embedded';
|
|
673
668
|
|
|
674
|
-
|
|
669
|
+
delegated: boolean;
|
|
675
670
|
|
|
676
|
-
|
|
671
|
+
first_verified_at: number | null;
|
|
677
672
|
|
|
678
|
-
|
|
679
|
-
}
|
|
673
|
+
imported: boolean;
|
|
680
674
|
|
|
681
|
-
|
|
682
|
-
fid: number;
|
|
675
|
+
latest_verified_at: number | null;
|
|
683
676
|
|
|
684
|
-
|
|
677
|
+
public_key: string;
|
|
685
678
|
|
|
686
|
-
|
|
679
|
+
/**
|
|
680
|
+
* The method used to recover an embedded wallet account.
|
|
681
|
+
*/
|
|
682
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
687
683
|
|
|
688
|
-
|
|
684
|
+
type: 'wallet';
|
|
689
685
|
|
|
690
|
-
|
|
686
|
+
verified_at: number;
|
|
691
687
|
|
|
692
|
-
|
|
688
|
+
wallet_client: 'privy';
|
|
693
689
|
|
|
694
|
-
|
|
690
|
+
wallet_client_type: 'privy';
|
|
695
691
|
|
|
696
|
-
|
|
692
|
+
wallet_index: number;
|
|
693
|
+
}
|
|
697
694
|
|
|
698
|
-
|
|
695
|
+
/**
|
|
696
|
+
* A curve signing embedded wallet account linked to the user.
|
|
697
|
+
*/
|
|
698
|
+
export interface LinkedAccountCurveSigningEmbeddedWallet {
|
|
699
|
+
id: string | null;
|
|
699
700
|
|
|
700
|
-
|
|
701
|
+
address: string;
|
|
701
702
|
|
|
702
|
-
|
|
703
|
+
chain_id: string;
|
|
703
704
|
|
|
704
|
-
|
|
705
|
+
/**
|
|
706
|
+
* The wallet chain types that support curve-based signing.
|
|
707
|
+
*/
|
|
708
|
+
chain_type: WalletsAPI.CurveSigningChainType;
|
|
705
709
|
|
|
706
|
-
|
|
707
|
-
}
|
|
710
|
+
connector_type: 'embedded';
|
|
708
711
|
|
|
709
|
-
|
|
710
|
-
first_verified_at: number | null;
|
|
712
|
+
delegated: boolean;
|
|
711
713
|
|
|
712
|
-
|
|
714
|
+
first_verified_at: number | null;
|
|
713
715
|
|
|
714
|
-
|
|
716
|
+
imported: boolean;
|
|
715
717
|
|
|
716
|
-
|
|
718
|
+
latest_verified_at: number | null;
|
|
717
719
|
|
|
718
|
-
|
|
720
|
+
public_key: string;
|
|
719
721
|
|
|
720
|
-
|
|
722
|
+
/**
|
|
723
|
+
* The method used to recover an embedded wallet account.
|
|
724
|
+
*/
|
|
725
|
+
recovery_method: EmbeddedWalletRecoveryMethod;
|
|
721
726
|
|
|
722
|
-
|
|
727
|
+
type: 'wallet';
|
|
723
728
|
|
|
724
|
-
|
|
729
|
+
verified_at: number;
|
|
725
730
|
|
|
726
|
-
|
|
731
|
+
wallet_client: 'privy';
|
|
727
732
|
|
|
728
|
-
|
|
733
|
+
wallet_client_type: 'privy';
|
|
729
734
|
|
|
730
|
-
|
|
731
|
-
|
|
735
|
+
wallet_index: number;
|
|
736
|
+
}
|
|
732
737
|
|
|
733
|
-
|
|
734
|
-
|
|
738
|
+
export type LinkedAccountEmbeddedWallet =
|
|
739
|
+
| LinkedAccountEthereumEmbeddedWallet
|
|
740
|
+
| LinkedAccountSolanaEmbeddedWallet
|
|
741
|
+
| LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
742
|
+
| LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
743
|
+
| LinkedAccountCurveSigningEmbeddedWallet;
|
|
735
744
|
|
|
736
|
-
|
|
745
|
+
/**
|
|
746
|
+
* An embedded wallet account with an ID.
|
|
747
|
+
*/
|
|
748
|
+
export type LinkedAccountEmbeddedWalletWithID =
|
|
749
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountEthereumEmbeddedWallet
|
|
750
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountSolanaEmbeddedWallet
|
|
751
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
752
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
753
|
+
| LinkedAccountEmbeddedWalletWithID.LinkedAccountCurveSigningEmbeddedWallet;
|
|
737
754
|
|
|
738
|
-
|
|
755
|
+
export namespace LinkedAccountEmbeddedWalletWithID {
|
|
756
|
+
/**
|
|
757
|
+
* An Ethereum embedded wallet account linked to the user.
|
|
758
|
+
*/
|
|
759
|
+
export interface LinkedAccountEthereumEmbeddedWallet
|
|
760
|
+
extends Omit<UsersAPI.LinkedAccountEthereumEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
761
|
+
id: string;
|
|
739
762
|
|
|
740
|
-
|
|
763
|
+
recovery_method: 'privy-v2';
|
|
764
|
+
}
|
|
741
765
|
|
|
742
|
-
|
|
766
|
+
/**
|
|
767
|
+
* A Solana embedded wallet account linked to the user.
|
|
768
|
+
*/
|
|
769
|
+
export interface LinkedAccountSolanaEmbeddedWallet
|
|
770
|
+
extends Omit<UsersAPI.LinkedAccountSolanaEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
771
|
+
id: string;
|
|
743
772
|
|
|
744
|
-
|
|
773
|
+
recovery_method: 'privy-v2';
|
|
774
|
+
}
|
|
745
775
|
|
|
746
|
-
|
|
776
|
+
/**
|
|
777
|
+
* A Bitcoin SegWit embedded wallet account linked to the user.
|
|
778
|
+
*/
|
|
779
|
+
export interface LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
780
|
+
extends Omit<UsersAPI.LinkedAccountBitcoinSegwitEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
781
|
+
id: string;
|
|
747
782
|
|
|
748
|
-
|
|
783
|
+
recovery_method: 'privy-v2';
|
|
784
|
+
}
|
|
749
785
|
|
|
750
|
-
|
|
786
|
+
/**
|
|
787
|
+
* A Bitcoin Taproot embedded wallet account linked to the user.
|
|
788
|
+
*/
|
|
789
|
+
export interface LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
790
|
+
extends Omit<UsersAPI.LinkedAccountBitcoinTaprootEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
791
|
+
id: string;
|
|
751
792
|
|
|
752
|
-
|
|
793
|
+
recovery_method: 'privy-v2';
|
|
753
794
|
}
|
|
754
795
|
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
796
|
+
/**
|
|
797
|
+
* A curve signing embedded wallet account linked to the user.
|
|
798
|
+
*/
|
|
799
|
+
export interface LinkedAccountCurveSigningEmbeddedWallet
|
|
800
|
+
extends Omit<UsersAPI.LinkedAccountCurveSigningEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
801
|
+
id: string;
|
|
759
802
|
|
|
760
|
-
|
|
803
|
+
recovery_method: 'privy-v2';
|
|
804
|
+
}
|
|
805
|
+
}
|
|
761
806
|
|
|
762
|
-
|
|
807
|
+
/**
|
|
808
|
+
* A Google OAuth account linked to the user.
|
|
809
|
+
*/
|
|
810
|
+
export interface LinkedAccountGoogleOAuth {
|
|
811
|
+
email: string;
|
|
763
812
|
|
|
764
|
-
|
|
813
|
+
first_verified_at: number | null;
|
|
765
814
|
|
|
766
|
-
|
|
815
|
+
latest_verified_at: number | null;
|
|
767
816
|
|
|
768
|
-
|
|
817
|
+
name: string | null;
|
|
769
818
|
|
|
770
|
-
|
|
819
|
+
subject: string;
|
|
771
820
|
|
|
772
|
-
|
|
773
|
-
}
|
|
821
|
+
type: 'google_oauth';
|
|
774
822
|
|
|
775
|
-
|
|
776
|
-
|
|
823
|
+
verified_at: number;
|
|
824
|
+
}
|
|
777
825
|
|
|
778
|
-
|
|
826
|
+
/**
|
|
827
|
+
* A Twitter OAuth account linked to the user.
|
|
828
|
+
*/
|
|
829
|
+
export interface LinkedAccountTwitterOAuth {
|
|
830
|
+
first_verified_at: number | null;
|
|
779
831
|
|
|
780
|
-
|
|
832
|
+
latest_verified_at: number | null;
|
|
781
833
|
|
|
782
|
-
|
|
783
|
-
* The ID of a custom OAuth provider, set up for this app. Must start with
|
|
784
|
-
* "custom:".
|
|
785
|
-
*/
|
|
786
|
-
type: ClientAuthAPI.CustomOAuthProviderID;
|
|
834
|
+
name: string | null;
|
|
787
835
|
|
|
788
|
-
|
|
836
|
+
profile_picture_url: string | null;
|
|
789
837
|
|
|
790
|
-
|
|
838
|
+
subject: string;
|
|
791
839
|
|
|
792
|
-
|
|
840
|
+
type: 'twitter_oauth';
|
|
793
841
|
|
|
794
|
-
|
|
842
|
+
username: string | null;
|
|
795
843
|
|
|
796
|
-
|
|
797
|
-
}
|
|
844
|
+
verified_at: number;
|
|
798
845
|
}
|
|
799
846
|
|
|
800
|
-
|
|
801
|
-
|
|
847
|
+
/**
|
|
848
|
+
* A Discord OAuth account linked to the user.
|
|
849
|
+
*/
|
|
850
|
+
export interface LinkedAccountDiscordOAuth {
|
|
851
|
+
email: string | null;
|
|
802
852
|
|
|
803
|
-
|
|
804
|
-
* Unix timestamp of when the user was created in milliseconds.
|
|
805
|
-
*/
|
|
806
|
-
created_at: number;
|
|
853
|
+
first_verified_at: number | null;
|
|
807
854
|
|
|
808
|
-
|
|
809
|
-
* Indicates if the user has accepted the terms of service.
|
|
810
|
-
*/
|
|
811
|
-
has_accepted_terms: boolean;
|
|
855
|
+
latest_verified_at: number | null;
|
|
812
856
|
|
|
813
|
-
|
|
814
|
-
* Indicates if the user is a guest account user.
|
|
815
|
-
*/
|
|
816
|
-
is_guest: boolean;
|
|
857
|
+
subject: string;
|
|
817
858
|
|
|
818
|
-
|
|
859
|
+
type: 'discord_oauth';
|
|
819
860
|
|
|
820
|
-
|
|
861
|
+
username: string | null;
|
|
821
862
|
|
|
822
|
-
|
|
823
|
-
* Custom metadata associated with the user.
|
|
824
|
-
*/
|
|
825
|
-
custom_metadata?: { [key: string]: string | number | boolean };
|
|
863
|
+
verified_at: number;
|
|
826
864
|
}
|
|
827
865
|
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
866
|
+
/**
|
|
867
|
+
* A GitHub OAuth account linked to the user.
|
|
868
|
+
*/
|
|
869
|
+
export interface LinkedAccountGitHubOAuth {
|
|
870
|
+
email: string | null;
|
|
831
871
|
|
|
832
|
-
|
|
833
|
-
}
|
|
872
|
+
first_verified_at: number | null;
|
|
834
873
|
|
|
835
|
-
|
|
836
|
-
type: 'sms';
|
|
874
|
+
latest_verified_at: number | null;
|
|
837
875
|
|
|
838
|
-
|
|
839
|
-
}
|
|
876
|
+
name: string | null;
|
|
840
877
|
|
|
841
|
-
|
|
842
|
-
type: 'totp';
|
|
878
|
+
subject: string;
|
|
843
879
|
|
|
844
|
-
|
|
845
|
-
|
|
880
|
+
type: 'github_oauth';
|
|
881
|
+
|
|
882
|
+
username: string | null;
|
|
883
|
+
|
|
884
|
+
verified_at: number;
|
|
846
885
|
}
|
|
847
886
|
|
|
848
887
|
/**
|
|
849
|
-
*
|
|
888
|
+
* A LinkedIn OAuth account linked to the user.
|
|
850
889
|
*/
|
|
851
|
-
export interface
|
|
852
|
-
|
|
890
|
+
export interface LinkedAccountLinkedInOAuth {
|
|
891
|
+
email: string | null;
|
|
853
892
|
|
|
854
|
-
|
|
855
|
-
}
|
|
893
|
+
first_verified_at: number | null;
|
|
856
894
|
|
|
857
|
-
|
|
858
|
-
id: string | null;
|
|
895
|
+
latest_verified_at: number | null;
|
|
859
896
|
|
|
860
|
-
|
|
897
|
+
subject: string;
|
|
861
898
|
|
|
862
|
-
|
|
899
|
+
type: 'linkedin_oauth';
|
|
863
900
|
|
|
864
|
-
|
|
901
|
+
verified_at: number;
|
|
865
902
|
|
|
866
|
-
|
|
903
|
+
name?: string;
|
|
867
904
|
|
|
868
|
-
|
|
905
|
+
vanity_name?: string;
|
|
906
|
+
}
|
|
869
907
|
|
|
870
|
-
|
|
908
|
+
/**
|
|
909
|
+
* A Spotify OAuth account linked to the user.
|
|
910
|
+
*/
|
|
911
|
+
export interface LinkedAccountSpotifyOAuth {
|
|
912
|
+
email: string | null;
|
|
871
913
|
|
|
872
|
-
|
|
914
|
+
first_verified_at: number | null;
|
|
873
915
|
|
|
874
916
|
latest_verified_at: number | null;
|
|
875
917
|
|
|
876
|
-
|
|
877
|
-
| 'privy'
|
|
878
|
-
| 'user-passcode'
|
|
879
|
-
| 'google-drive'
|
|
880
|
-
| 'icloud'
|
|
881
|
-
| 'recovery-encryption-key'
|
|
882
|
-
| 'privy-v2';
|
|
918
|
+
name: string | null;
|
|
883
919
|
|
|
884
|
-
|
|
920
|
+
subject: string;
|
|
921
|
+
|
|
922
|
+
type: 'spotify_oauth';
|
|
885
923
|
|
|
886
924
|
verified_at: number;
|
|
925
|
+
}
|
|
887
926
|
|
|
888
|
-
|
|
927
|
+
/**
|
|
928
|
+
* An Instagram OAuth account linked to the user.
|
|
929
|
+
*/
|
|
930
|
+
export interface LinkedAccountInstagramOAuth {
|
|
931
|
+
first_verified_at: number | null;
|
|
889
932
|
|
|
890
|
-
|
|
933
|
+
latest_verified_at: number | null;
|
|
891
934
|
|
|
892
|
-
|
|
935
|
+
subject: string;
|
|
936
|
+
|
|
937
|
+
type: 'instagram_oauth';
|
|
938
|
+
|
|
939
|
+
username: string | null;
|
|
940
|
+
|
|
941
|
+
verified_at: number;
|
|
893
942
|
}
|
|
894
943
|
|
|
895
|
-
|
|
896
|
-
|
|
944
|
+
/**
|
|
945
|
+
* A TikTok OAuth account linked to the user.
|
|
946
|
+
*/
|
|
947
|
+
export interface LinkedAccountTiktokOAuth {
|
|
948
|
+
first_verified_at: number | null;
|
|
897
949
|
|
|
898
|
-
|
|
950
|
+
latest_verified_at: number | null;
|
|
899
951
|
|
|
900
|
-
|
|
952
|
+
name: string | null;
|
|
901
953
|
|
|
902
|
-
|
|
954
|
+
subject: string;
|
|
903
955
|
|
|
904
|
-
|
|
956
|
+
type: 'tiktok_oauth';
|
|
905
957
|
|
|
906
|
-
|
|
958
|
+
username: string | null;
|
|
907
959
|
|
|
908
|
-
|
|
960
|
+
verified_at: number;
|
|
961
|
+
}
|
|
909
962
|
|
|
910
|
-
|
|
963
|
+
/**
|
|
964
|
+
* A LINE OAuth account linked to the user.
|
|
965
|
+
*/
|
|
966
|
+
export interface LinkedAccountLineOAuth {
|
|
967
|
+
email: string | null;
|
|
968
|
+
|
|
969
|
+
first_verified_at: number | null;
|
|
911
970
|
|
|
912
971
|
latest_verified_at: number | null;
|
|
913
972
|
|
|
914
|
-
|
|
973
|
+
name: string | null;
|
|
915
974
|
|
|
916
|
-
|
|
917
|
-
| 'privy'
|
|
918
|
-
| 'user-passcode'
|
|
919
|
-
| 'google-drive'
|
|
920
|
-
| 'icloud'
|
|
921
|
-
| 'recovery-encryption-key'
|
|
922
|
-
| 'privy-v2';
|
|
975
|
+
profile_picture_url: string | null;
|
|
923
976
|
|
|
924
|
-
|
|
977
|
+
subject: string;
|
|
978
|
+
|
|
979
|
+
type: 'line_oauth';
|
|
925
980
|
|
|
926
981
|
verified_at: number;
|
|
982
|
+
}
|
|
927
983
|
|
|
928
|
-
|
|
984
|
+
/**
|
|
985
|
+
* A Twitch OAuth account linked to the user.
|
|
986
|
+
*/
|
|
987
|
+
export interface LinkedAccountTwitchOAuth {
|
|
988
|
+
first_verified_at: number | null;
|
|
929
989
|
|
|
930
|
-
|
|
990
|
+
latest_verified_at: number | null;
|
|
931
991
|
|
|
932
|
-
|
|
992
|
+
subject: string;
|
|
993
|
+
|
|
994
|
+
type: 'twitch_oauth';
|
|
995
|
+
|
|
996
|
+
username: string | null;
|
|
997
|
+
|
|
998
|
+
verified_at: number;
|
|
933
999
|
}
|
|
934
1000
|
|
|
935
|
-
|
|
936
|
-
|
|
1001
|
+
/**
|
|
1002
|
+
* An Apple OAuth account linked to the user.
|
|
1003
|
+
*/
|
|
1004
|
+
export interface LinkedAccountAppleOAuth {
|
|
1005
|
+
email: string | null;
|
|
937
1006
|
|
|
938
|
-
|
|
1007
|
+
first_verified_at: number | null;
|
|
939
1008
|
|
|
940
|
-
|
|
1009
|
+
latest_verified_at: number | null;
|
|
941
1010
|
|
|
942
|
-
|
|
1011
|
+
subject: string;
|
|
943
1012
|
|
|
944
|
-
|
|
1013
|
+
type: 'apple_oauth';
|
|
945
1014
|
|
|
946
|
-
|
|
1015
|
+
verified_at: number;
|
|
1016
|
+
}
|
|
947
1017
|
|
|
1018
|
+
/**
|
|
1019
|
+
* A custom OAuth account linked to the user.
|
|
1020
|
+
*/
|
|
1021
|
+
export interface LinkedAccountCustomOAuth {
|
|
948
1022
|
first_verified_at: number | null;
|
|
949
1023
|
|
|
950
|
-
imported: boolean;
|
|
951
|
-
|
|
952
1024
|
latest_verified_at: number | null;
|
|
953
1025
|
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
recovery_method:
|
|
957
|
-
| 'privy'
|
|
958
|
-
| 'user-passcode'
|
|
959
|
-
| 'google-drive'
|
|
960
|
-
| 'icloud'
|
|
961
|
-
| 'recovery-encryption-key'
|
|
962
|
-
| 'privy-v2';
|
|
1026
|
+
subject: string;
|
|
963
1027
|
|
|
964
|
-
|
|
1028
|
+
/**
|
|
1029
|
+
* The ID of a custom OAuth provider, set up for this app. Must start with
|
|
1030
|
+
* "custom:".
|
|
1031
|
+
*/
|
|
1032
|
+
type: ClientAuthAPI.CustomOAuthProviderID;
|
|
965
1033
|
|
|
966
1034
|
verified_at: number;
|
|
967
1035
|
|
|
968
|
-
|
|
1036
|
+
email?: string;
|
|
969
1037
|
|
|
970
|
-
|
|
1038
|
+
name?: string;
|
|
971
1039
|
|
|
972
|
-
|
|
1040
|
+
profile_picture_url?: string;
|
|
1041
|
+
|
|
1042
|
+
username?: string;
|
|
973
1043
|
}
|
|
974
1044
|
|
|
975
|
-
|
|
976
|
-
|
|
1045
|
+
/**
|
|
1046
|
+
* A custom JWT account linked to the user.
|
|
1047
|
+
*/
|
|
1048
|
+
export interface LinkedAccountCustomJwt {
|
|
1049
|
+
custom_user_id: string;
|
|
977
1050
|
|
|
978
|
-
|
|
1051
|
+
first_verified_at: number | null;
|
|
979
1052
|
|
|
980
|
-
|
|
1053
|
+
latest_verified_at: number | null;
|
|
981
1054
|
|
|
982
|
-
|
|
1055
|
+
type: 'custom_auth';
|
|
983
1056
|
|
|
984
|
-
|
|
1057
|
+
verified_at: number;
|
|
1058
|
+
}
|
|
985
1059
|
|
|
986
|
-
|
|
1060
|
+
/**
|
|
1061
|
+
* An embedded wallet associated with a cross-app account.
|
|
1062
|
+
*/
|
|
1063
|
+
export interface CrossAppEmbeddedWallet {
|
|
1064
|
+
address: string;
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
/**
|
|
1068
|
+
* A smart wallet associated with a cross-app account.
|
|
1069
|
+
*/
|
|
1070
|
+
export interface CrossAppSmartWallet {
|
|
1071
|
+
address: string;
|
|
1072
|
+
}
|
|
1073
|
+
|
|
1074
|
+
/**
|
|
1075
|
+
* A cross-app account linked to the user.
|
|
1076
|
+
*/
|
|
1077
|
+
export interface LinkedAccountCrossApp {
|
|
1078
|
+
embedded_wallets: Array<CrossAppEmbeddedWallet>;
|
|
987
1079
|
|
|
988
1080
|
first_verified_at: number | null;
|
|
989
1081
|
|
|
990
|
-
|
|
1082
|
+
latest_verified_at: number | null;
|
|
1083
|
+
|
|
1084
|
+
provider_app_id: string;
|
|
1085
|
+
|
|
1086
|
+
smart_wallets: Array<CrossAppSmartWallet>;
|
|
1087
|
+
|
|
1088
|
+
subject: string;
|
|
1089
|
+
|
|
1090
|
+
type: 'cross_app';
|
|
1091
|
+
|
|
1092
|
+
verified_at: number;
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
/**
|
|
1096
|
+
* An authorization key linked to the user.
|
|
1097
|
+
*/
|
|
1098
|
+
export interface LinkedAccountAuthorizationKey {
|
|
1099
|
+
first_verified_at: number | null;
|
|
991
1100
|
|
|
992
1101
|
latest_verified_at: number | null;
|
|
993
1102
|
|
|
994
1103
|
public_key: string;
|
|
995
1104
|
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1105
|
+
type: 'authorization_key';
|
|
1106
|
+
|
|
1107
|
+
verified_at: number;
|
|
1108
|
+
}
|
|
1109
|
+
|
|
1110
|
+
/**
|
|
1111
|
+
* A linked account for the user.
|
|
1112
|
+
*/
|
|
1113
|
+
export type LinkedAccount =
|
|
1114
|
+
| LinkedAccountEmail
|
|
1115
|
+
| LinkedAccountPhone
|
|
1116
|
+
| LinkedAccountEthereum
|
|
1117
|
+
| LinkedAccountSolana
|
|
1118
|
+
| LinkedAccountSmartWallet
|
|
1119
|
+
| LinkedAccountEthereumEmbeddedWallet
|
|
1120
|
+
| LinkedAccountSolanaEmbeddedWallet
|
|
1121
|
+
| LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
1122
|
+
| LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
1123
|
+
| LinkedAccountCurveSigningEmbeddedWallet
|
|
1124
|
+
| LinkedAccountGoogleOAuth
|
|
1125
|
+
| LinkedAccountTwitterOAuth
|
|
1126
|
+
| LinkedAccountDiscordOAuth
|
|
1127
|
+
| LinkedAccountGitHubOAuth
|
|
1128
|
+
| LinkedAccountSpotifyOAuth
|
|
1129
|
+
| LinkedAccountInstagramOAuth
|
|
1130
|
+
| LinkedAccountTiktokOAuth
|
|
1131
|
+
| LinkedAccountLineOAuth
|
|
1132
|
+
| LinkedAccountTwitchOAuth
|
|
1133
|
+
| LinkedAccountLinkedInOAuth
|
|
1134
|
+
| LinkedAccountAppleOAuth
|
|
1135
|
+
| LinkedAccountCustomOAuth
|
|
1136
|
+
| LinkedAccountCustomJwt
|
|
1137
|
+
| LinkedAccountFarcaster
|
|
1138
|
+
| LinkedAccountPasskey
|
|
1139
|
+
| LinkedAccountTelegram
|
|
1140
|
+
| LinkedAccountCrossApp
|
|
1141
|
+
| LinkedAccountAuthorizationKey;
|
|
1142
|
+
|
|
1143
|
+
/**
|
|
1144
|
+
* The possible types of linked accounts.
|
|
1145
|
+
*/
|
|
1146
|
+
export type LinkedAccountType =
|
|
1147
|
+
| 'email'
|
|
1148
|
+
| 'phone'
|
|
1149
|
+
| 'wallet'
|
|
1150
|
+
| 'smart_wallet'
|
|
1151
|
+
| 'google_oauth'
|
|
1152
|
+
| 'twitter_oauth'
|
|
1153
|
+
| 'discord_oauth'
|
|
1154
|
+
| 'github_oauth'
|
|
1155
|
+
| 'spotify_oauth'
|
|
1156
|
+
| 'instagram_oauth'
|
|
1157
|
+
| 'tiktok_oauth'
|
|
1158
|
+
| 'line_oauth'
|
|
1159
|
+
| 'twitch_oauth'
|
|
1160
|
+
| 'linkedin_oauth'
|
|
1161
|
+
| 'apple_oauth'
|
|
1162
|
+
| 'custom_auth'
|
|
1163
|
+
| 'farcaster'
|
|
1164
|
+
| 'passkey'
|
|
1165
|
+
| 'telegram'
|
|
1166
|
+
| 'cross_app'
|
|
1167
|
+
| 'authorization_key'
|
|
1168
|
+
| ClientAuthAPI.CustomOAuthProviderID;
|
|
1169
|
+
|
|
1170
|
+
/**
|
|
1171
|
+
* Custom metadata associated with the user.
|
|
1172
|
+
*/
|
|
1173
|
+
export type CustomMetadata = { [key: string]: string | number | boolean };
|
|
1174
|
+
|
|
1175
|
+
/**
|
|
1176
|
+
* The payload for importing a wallet account.
|
|
1177
|
+
*/
|
|
1178
|
+
export interface LinkedAccountWalletInput {
|
|
1179
|
+
address: string;
|
|
1180
|
+
|
|
1181
|
+
chain_type: 'ethereum' | 'solana';
|
|
1003
1182
|
|
|
1004
1183
|
type: 'wallet';
|
|
1184
|
+
}
|
|
1005
1185
|
|
|
1006
|
-
|
|
1186
|
+
/**
|
|
1187
|
+
* The payload for importing an email account.
|
|
1188
|
+
*/
|
|
1189
|
+
export interface LinkedAccountEmailInput {
|
|
1190
|
+
address: string;
|
|
1007
1191
|
|
|
1008
|
-
|
|
1192
|
+
type: 'email';
|
|
1193
|
+
}
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
* The payload for importing a phone account.
|
|
1197
|
+
*/
|
|
1198
|
+
export interface LinkedAccountPhoneInput {
|
|
1199
|
+
number: string;
|
|
1200
|
+
|
|
1201
|
+
type: 'phone';
|
|
1202
|
+
}
|
|
1203
|
+
|
|
1204
|
+
/**
|
|
1205
|
+
* The payload for importing a Google account.
|
|
1206
|
+
*/
|
|
1207
|
+
export interface LinkedAccountGoogleInput {
|
|
1208
|
+
email: string;
|
|
1209
|
+
|
|
1210
|
+
name: string;
|
|
1211
|
+
|
|
1212
|
+
subject: string;
|
|
1213
|
+
|
|
1214
|
+
type: 'google_oauth';
|
|
1215
|
+
}
|
|
1216
|
+
|
|
1217
|
+
/**
|
|
1218
|
+
* The payload for importing a Twitter account.
|
|
1219
|
+
*/
|
|
1220
|
+
export interface LinkedAccountTwitterInput {
|
|
1221
|
+
name: string;
|
|
1222
|
+
|
|
1223
|
+
subject: string;
|
|
1224
|
+
|
|
1225
|
+
type: 'twitter_oauth';
|
|
1009
1226
|
|
|
1010
|
-
|
|
1227
|
+
username: string;
|
|
1011
1228
|
|
|
1012
|
-
|
|
1229
|
+
profile_picture_url?: string;
|
|
1013
1230
|
}
|
|
1014
1231
|
|
|
1015
|
-
|
|
1016
|
-
|
|
1232
|
+
/**
|
|
1233
|
+
* The payload for importing a Discord account.
|
|
1234
|
+
*/
|
|
1235
|
+
export interface LinkedAccountDiscordInput {
|
|
1236
|
+
subject: string;
|
|
1017
1237
|
|
|
1018
|
-
|
|
1238
|
+
type: 'discord_oauth';
|
|
1019
1239
|
|
|
1020
|
-
|
|
1240
|
+
username: string;
|
|
1021
1241
|
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
*/
|
|
1025
|
-
chain_type: WalletsAPI.CurveSigningChainType;
|
|
1242
|
+
email?: string;
|
|
1243
|
+
}
|
|
1026
1244
|
|
|
1027
|
-
|
|
1245
|
+
/**
|
|
1246
|
+
* The payload for importing a Github account.
|
|
1247
|
+
*/
|
|
1248
|
+
export interface LinkedAccountGitHubInput {
|
|
1249
|
+
subject: string;
|
|
1028
1250
|
|
|
1029
|
-
|
|
1251
|
+
type: 'github_oauth';
|
|
1030
1252
|
|
|
1031
|
-
|
|
1253
|
+
username: string;
|
|
1032
1254
|
|
|
1033
|
-
|
|
1255
|
+
email?: string;
|
|
1034
1256
|
|
|
1035
|
-
|
|
1257
|
+
name?: string;
|
|
1258
|
+
}
|
|
1036
1259
|
|
|
1037
|
-
|
|
1260
|
+
/**
|
|
1261
|
+
* The payload for importing a Spotify account.
|
|
1262
|
+
*/
|
|
1263
|
+
export interface LinkedAccountSpotifyInput {
|
|
1264
|
+
subject: string;
|
|
1038
1265
|
|
|
1039
|
-
|
|
1040
|
-
| 'privy'
|
|
1041
|
-
| 'user-passcode'
|
|
1042
|
-
| 'google-drive'
|
|
1043
|
-
| 'icloud'
|
|
1044
|
-
| 'recovery-encryption-key'
|
|
1045
|
-
| 'privy-v2';
|
|
1266
|
+
type: 'spotify_oauth';
|
|
1046
1267
|
|
|
1047
|
-
|
|
1268
|
+
email?: string;
|
|
1048
1269
|
|
|
1049
|
-
|
|
1270
|
+
name?: string;
|
|
1271
|
+
}
|
|
1050
1272
|
|
|
1051
|
-
|
|
1273
|
+
/**
|
|
1274
|
+
* The payload for importing an Instagram account.
|
|
1275
|
+
*/
|
|
1276
|
+
export interface LinkedAccountInstagramInput {
|
|
1277
|
+
subject: string;
|
|
1052
1278
|
|
|
1053
|
-
|
|
1279
|
+
type: 'instagram_oauth';
|
|
1054
1280
|
|
|
1055
|
-
|
|
1281
|
+
username: string;
|
|
1056
1282
|
}
|
|
1057
1283
|
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
|
1063
|
-
| LinkedAccountCurveSigningEmbeddedWallet;
|
|
1284
|
+
/**
|
|
1285
|
+
* The payload for importing a Tiktok account.
|
|
1286
|
+
*/
|
|
1287
|
+
export interface LinkedAccountTiktokInput {
|
|
1288
|
+
name: string | null;
|
|
1064
1289
|
|
|
1065
|
-
|
|
1066
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountEthereumEmbeddedWallet
|
|
1067
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountSolanaEmbeddedWallet
|
|
1068
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinSegwitEmbeddedWallet
|
|
1069
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountBitcoinTaprootEmbeddedWallet
|
|
1070
|
-
| LinkedAccountEmbeddedWalletWithID.LinkedAccountCurveSigningEmbeddedWallet;
|
|
1290
|
+
subject: string;
|
|
1071
1291
|
|
|
1072
|
-
|
|
1073
|
-
export interface LinkedAccountEthereumEmbeddedWallet
|
|
1074
|
-
extends Omit<UsersAPI.LinkedAccountEthereumEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1075
|
-
id: string;
|
|
1292
|
+
type: 'tiktok_oauth';
|
|
1076
1293
|
|
|
1077
|
-
|
|
1078
|
-
|
|
1294
|
+
username: string;
|
|
1295
|
+
}
|
|
1079
1296
|
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1297
|
+
/**
|
|
1298
|
+
* The payload for importing a LINE account.
|
|
1299
|
+
*/
|
|
1300
|
+
export interface LinkedAccountLineInput {
|
|
1301
|
+
subject: string;
|
|
1083
1302
|
|
|
1084
|
-
|
|
1085
|
-
}
|
|
1303
|
+
type: 'line_oauth';
|
|
1086
1304
|
|
|
1087
|
-
|
|
1088
|
-
extends Omit<UsersAPI.LinkedAccountBitcoinSegwitEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1089
|
-
id: string;
|
|
1305
|
+
email?: string;
|
|
1090
1306
|
|
|
1091
|
-
|
|
1092
|
-
}
|
|
1307
|
+
name?: string;
|
|
1093
1308
|
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
id: string;
|
|
1309
|
+
profile_picture_url?: string;
|
|
1310
|
+
}
|
|
1097
1311
|
|
|
1098
|
-
|
|
1099
|
-
|
|
1312
|
+
/**
|
|
1313
|
+
* The payload for importing a Twitch account.
|
|
1314
|
+
*/
|
|
1315
|
+
export interface LinkedAccountTwitchInput {
|
|
1316
|
+
subject: string;
|
|
1100
1317
|
|
|
1101
|
-
|
|
1102
|
-
extends Omit<UsersAPI.LinkedAccountCurveSigningEmbeddedWallet, 'id' | 'recovery_method'> {
|
|
1103
|
-
id: string;
|
|
1318
|
+
type: 'twitch_oauth';
|
|
1104
1319
|
|
|
1105
|
-
|
|
1106
|
-
}
|
|
1320
|
+
username?: string;
|
|
1107
1321
|
}
|
|
1108
1322
|
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
| 'coinbase_smart_wallet'
|
|
1115
|
-
| 'thirdweb';
|
|
1323
|
+
/**
|
|
1324
|
+
* The payload for importing an Apple account.
|
|
1325
|
+
*/
|
|
1326
|
+
export interface LinkedAccountAppleInput {
|
|
1327
|
+
subject: string;
|
|
1116
1328
|
|
|
1117
|
-
|
|
1118
|
-
address: string;
|
|
1329
|
+
type: 'apple_oauth';
|
|
1119
1330
|
|
|
1120
|
-
|
|
1331
|
+
email?: string;
|
|
1332
|
+
}
|
|
1121
1333
|
|
|
1122
|
-
|
|
1334
|
+
/**
|
|
1335
|
+
* The payload for importing a LinkedIn account.
|
|
1336
|
+
*/
|
|
1337
|
+
export interface LinkedAccountLinkedInInput {
|
|
1338
|
+
subject: string;
|
|
1123
1339
|
|
|
1124
|
-
|
|
1340
|
+
type: 'linkedin_oauth';
|
|
1125
1341
|
|
|
1126
|
-
|
|
1342
|
+
email?: string;
|
|
1127
1343
|
|
|
1128
|
-
|
|
1344
|
+
name?: string;
|
|
1129
1345
|
|
|
1130
|
-
|
|
1346
|
+
vanityName?: string;
|
|
1131
1347
|
}
|
|
1132
1348
|
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
| UserCreateParams.LinkedAccountGoogleInput
|
|
1139
|
-
| UserCreateParams.LinkedAccountTwitterInput
|
|
1140
|
-
| UserCreateParams.LinkedAccountDiscordInput
|
|
1141
|
-
| UserCreateParams.LinkedAccountGitHubInput
|
|
1142
|
-
| UserCreateParams.LinkedAccountSpotifyInput
|
|
1143
|
-
| UserCreateParams.LinkedAccountInstagramInput
|
|
1144
|
-
| UserCreateParams.LinkedAccountTiktokInput
|
|
1145
|
-
| UserCreateParams.LinkedAccountLineInput
|
|
1146
|
-
| UserCreateParams.LinkedAccountTwitchInput
|
|
1147
|
-
| UserCreateParams.LinkedAccountAppleInput
|
|
1148
|
-
| UserCreateParams.LinkedAccountLinkedInInput
|
|
1149
|
-
| UserCreateParams.LinkedAccountFarcasterInput
|
|
1150
|
-
| UserCreateParams.LinkedAccountTelegramInput
|
|
1151
|
-
| UserCreateParams.LinkedAccountCustomJwtInput
|
|
1152
|
-
>;
|
|
1349
|
+
/**
|
|
1350
|
+
* The payload for importing a Farcaster account.
|
|
1351
|
+
*/
|
|
1352
|
+
export interface LinkedAccountFarcasterInput {
|
|
1353
|
+
fid: number;
|
|
1153
1354
|
|
|
1154
|
-
|
|
1155
|
-
* Custom metadata associated with the user.
|
|
1156
|
-
*/
|
|
1157
|
-
custom_metadata?: { [key: string]: string | number | boolean };
|
|
1355
|
+
owner_address: string;
|
|
1158
1356
|
|
|
1159
|
-
|
|
1160
|
-
* Wallets to create for the user.
|
|
1161
|
-
*/
|
|
1162
|
-
wallets?: Array<UserCreateParams.Wallet>;
|
|
1163
|
-
}
|
|
1357
|
+
type: 'farcaster';
|
|
1164
1358
|
|
|
1165
|
-
|
|
1166
|
-
export interface LinkedAccountWalletInput {
|
|
1167
|
-
address: string;
|
|
1359
|
+
bio?: string;
|
|
1168
1360
|
|
|
1169
|
-
|
|
1361
|
+
display_name?: string;
|
|
1170
1362
|
|
|
1171
|
-
|
|
1172
|
-
}
|
|
1363
|
+
homepage_url?: string;
|
|
1173
1364
|
|
|
1174
|
-
|
|
1175
|
-
address: string;
|
|
1365
|
+
profile_picture_url?: string;
|
|
1176
1366
|
|
|
1177
|
-
|
|
1178
|
-
|
|
1367
|
+
username?: string;
|
|
1368
|
+
}
|
|
1179
1369
|
|
|
1180
|
-
|
|
1181
|
-
|
|
1370
|
+
/**
|
|
1371
|
+
* The payload for importing a Telegram account.
|
|
1372
|
+
*/
|
|
1373
|
+
export interface LinkedAccountTelegramInput {
|
|
1374
|
+
telegram_user_id: string;
|
|
1182
1375
|
|
|
1183
|
-
|
|
1184
|
-
}
|
|
1376
|
+
type: 'telegram';
|
|
1185
1377
|
|
|
1186
|
-
|
|
1187
|
-
email: string;
|
|
1378
|
+
first_name?: string;
|
|
1188
1379
|
|
|
1189
|
-
|
|
1380
|
+
last_name?: string;
|
|
1190
1381
|
|
|
1191
|
-
|
|
1382
|
+
photo_url?: string;
|
|
1192
1383
|
|
|
1193
|
-
|
|
1194
|
-
|
|
1384
|
+
username?: string;
|
|
1385
|
+
}
|
|
1195
1386
|
|
|
1196
|
-
|
|
1197
|
-
|
|
1387
|
+
/**
|
|
1388
|
+
* The payload for importing a Custom JWT account.
|
|
1389
|
+
*/
|
|
1390
|
+
export interface LinkedAccountCustomJwtInput {
|
|
1391
|
+
custom_user_id: string;
|
|
1198
1392
|
|
|
1199
|
-
|
|
1393
|
+
type: 'custom_auth';
|
|
1394
|
+
}
|
|
1200
1395
|
|
|
1201
|
-
|
|
1396
|
+
/**
|
|
1397
|
+
* The payload for importing a passkey account.
|
|
1398
|
+
*/
|
|
1399
|
+
export interface LinkedAccountPasskeyInput {
|
|
1400
|
+
credential_device_type: 'singleDevice' | 'multiDevice';
|
|
1202
1401
|
|
|
1203
|
-
|
|
1402
|
+
credential_id: string;
|
|
1204
1403
|
|
|
1205
|
-
|
|
1206
|
-
}
|
|
1404
|
+
credential_public_key: string;
|
|
1207
1405
|
|
|
1208
|
-
|
|
1209
|
-
subject: string;
|
|
1406
|
+
credential_username: string;
|
|
1210
1407
|
|
|
1211
|
-
|
|
1408
|
+
type: 'passkey';
|
|
1409
|
+
}
|
|
1212
1410
|
|
|
1213
|
-
|
|
1411
|
+
/**
|
|
1412
|
+
* The input for adding a linked account to a user.
|
|
1413
|
+
*/
|
|
1414
|
+
export type LinkedAccountInput =
|
|
1415
|
+
| LinkedAccountWalletInput
|
|
1416
|
+
| LinkedAccountEmailInput
|
|
1417
|
+
| LinkedAccountPhoneInput
|
|
1418
|
+
| LinkedAccountGoogleInput
|
|
1419
|
+
| LinkedAccountTwitterInput
|
|
1420
|
+
| LinkedAccountDiscordInput
|
|
1421
|
+
| LinkedAccountGitHubInput
|
|
1422
|
+
| LinkedAccountSpotifyInput
|
|
1423
|
+
| LinkedAccountInstagramInput
|
|
1424
|
+
| LinkedAccountTiktokInput
|
|
1425
|
+
| LinkedAccountLineInput
|
|
1426
|
+
| LinkedAccountTwitchInput
|
|
1427
|
+
| LinkedAccountAppleInput
|
|
1428
|
+
| LinkedAccountLinkedInInput
|
|
1429
|
+
| LinkedAccountFarcasterInput
|
|
1430
|
+
| LinkedAccountTelegramInput
|
|
1431
|
+
| LinkedAccountCustomJwtInput
|
|
1432
|
+
| LinkedAccountPasskeyInput;
|
|
1214
1433
|
|
|
1215
|
-
|
|
1216
|
-
|
|
1434
|
+
/**
|
|
1435
|
+
* The payload for batch creating users.
|
|
1436
|
+
*/
|
|
1437
|
+
export interface UserBatchCreateInput {
|
|
1438
|
+
users: Array<UserBatchCreateInput.User>;
|
|
1439
|
+
}
|
|
1217
1440
|
|
|
1218
|
-
|
|
1219
|
-
|
|
1441
|
+
export namespace UserBatchCreateInput {
|
|
1442
|
+
export interface User {
|
|
1443
|
+
linked_accounts: Array<UsersAPI.LinkedAccountInput>;
|
|
1220
1444
|
|
|
1221
|
-
|
|
1445
|
+
create_embedded_wallet?: boolean;
|
|
1222
1446
|
|
|
1223
|
-
|
|
1447
|
+
create_ethereum_smart_wallet?: boolean;
|
|
1224
1448
|
|
|
1225
|
-
|
|
1449
|
+
create_ethereum_wallet?: boolean;
|
|
1226
1450
|
|
|
1227
|
-
|
|
1228
|
-
}
|
|
1451
|
+
create_n_embedded_wallets?: number;
|
|
1229
1452
|
|
|
1230
|
-
|
|
1231
|
-
subject: string;
|
|
1453
|
+
create_n_ethereum_wallets?: number;
|
|
1232
1454
|
|
|
1233
|
-
|
|
1455
|
+
create_solana_wallet?: boolean;
|
|
1234
1456
|
|
|
1235
|
-
|
|
1457
|
+
/**
|
|
1458
|
+
* Custom metadata associated with the user.
|
|
1459
|
+
*/
|
|
1460
|
+
custom_metadata?: UsersAPI.CustomMetadata;
|
|
1236
1461
|
|
|
1237
|
-
|
|
1462
|
+
wallets?: Array<User.Wallet>;
|
|
1238
1463
|
}
|
|
1239
1464
|
|
|
1240
|
-
export
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1465
|
+
export namespace User {
|
|
1466
|
+
export interface Wallet {
|
|
1467
|
+
/**
|
|
1468
|
+
* The wallet chain types.
|
|
1469
|
+
*/
|
|
1470
|
+
chain_type: WalletsAPI.WalletChainType;
|
|
1244
1471
|
|
|
1245
|
-
|
|
1246
|
-
}
|
|
1472
|
+
additional_signers?: Array<Wallet.AdditionalSigner>;
|
|
1247
1473
|
|
|
1248
|
-
|
|
1249
|
-
name: string | null;
|
|
1474
|
+
create_smart_wallet?: boolean;
|
|
1250
1475
|
|
|
1251
|
-
|
|
1476
|
+
policy_ids?: Array<string>;
|
|
1477
|
+
}
|
|
1252
1478
|
|
|
1253
|
-
|
|
1479
|
+
export namespace Wallet {
|
|
1480
|
+
export interface AdditionalSigner {
|
|
1481
|
+
signer_id: string;
|
|
1254
1482
|
|
|
1255
|
-
|
|
1483
|
+
override_policy_ids?: Array<string>;
|
|
1484
|
+
}
|
|
1485
|
+
}
|
|
1256
1486
|
}
|
|
1487
|
+
}
|
|
1488
|
+
|
|
1489
|
+
/**
|
|
1490
|
+
* A SMS MFA method.
|
|
1491
|
+
*/
|
|
1492
|
+
export interface SMSMfaMethod {
|
|
1493
|
+
type: 'sms';
|
|
1257
1494
|
|
|
1258
|
-
|
|
1259
|
-
|
|
1495
|
+
verified_at: number;
|
|
1496
|
+
}
|
|
1260
1497
|
|
|
1261
|
-
|
|
1498
|
+
/**
|
|
1499
|
+
* A TOTP MFA method.
|
|
1500
|
+
*/
|
|
1501
|
+
export interface TotpMfaMethod {
|
|
1502
|
+
type: 'totp';
|
|
1262
1503
|
|
|
1263
|
-
|
|
1504
|
+
verified_at: number;
|
|
1505
|
+
}
|
|
1264
1506
|
|
|
1265
|
-
|
|
1507
|
+
/**
|
|
1508
|
+
* A Passkey MFA method.
|
|
1509
|
+
*/
|
|
1510
|
+
export interface PasskeyMfaMethod {
|
|
1511
|
+
type: 'passkey';
|
|
1266
1512
|
|
|
1267
|
-
|
|
1268
|
-
|
|
1513
|
+
verified_at: number;
|
|
1514
|
+
}
|
|
1269
1515
|
|
|
1270
|
-
|
|
1271
|
-
|
|
1516
|
+
/**
|
|
1517
|
+
* A multi-factor authentication method linked to the user.
|
|
1518
|
+
*/
|
|
1519
|
+
export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
|
|
1272
1520
|
|
|
1273
|
-
|
|
1521
|
+
/**
|
|
1522
|
+
* A Privy user object.
|
|
1523
|
+
*/
|
|
1524
|
+
export interface User {
|
|
1525
|
+
id: string;
|
|
1274
1526
|
|
|
1275
|
-
|
|
1276
|
-
|
|
1527
|
+
/**
|
|
1528
|
+
* Unix timestamp of when the user was created in milliseconds.
|
|
1529
|
+
*/
|
|
1530
|
+
created_at: number;
|
|
1277
1531
|
|
|
1278
|
-
|
|
1279
|
-
|
|
1532
|
+
/**
|
|
1533
|
+
* Indicates if the user has accepted the terms of service.
|
|
1534
|
+
*/
|
|
1535
|
+
has_accepted_terms: boolean;
|
|
1280
1536
|
|
|
1281
|
-
|
|
1537
|
+
/**
|
|
1538
|
+
* Indicates if the user is a guest account user.
|
|
1539
|
+
*/
|
|
1540
|
+
is_guest: boolean;
|
|
1282
1541
|
|
|
1283
|
-
|
|
1284
|
-
}
|
|
1542
|
+
linked_accounts: Array<LinkedAccount>;
|
|
1285
1543
|
|
|
1286
|
-
|
|
1287
|
-
subject: string;
|
|
1544
|
+
mfa_methods: Array<LinkedMfaMethod>;
|
|
1288
1545
|
|
|
1289
|
-
|
|
1546
|
+
/**
|
|
1547
|
+
* Custom metadata associated with the user.
|
|
1548
|
+
*/
|
|
1549
|
+
custom_metadata?: CustomMetadata;
|
|
1550
|
+
}
|
|
1290
1551
|
|
|
1291
|
-
|
|
1552
|
+
/**
|
|
1553
|
+
* OAuth tokens associated with the user.
|
|
1554
|
+
*/
|
|
1555
|
+
export interface OAuthTokens {
|
|
1556
|
+
access_token: string;
|
|
1292
1557
|
|
|
1293
|
-
|
|
1558
|
+
provider: string;
|
|
1294
1559
|
|
|
1295
|
-
|
|
1296
|
-
}
|
|
1560
|
+
access_token_expires_in_seconds?: number;
|
|
1297
1561
|
|
|
1298
|
-
|
|
1299
|
-
fid: number;
|
|
1562
|
+
refresh_token?: string;
|
|
1300
1563
|
|
|
1301
|
-
|
|
1564
|
+
refresh_token_expires_in_seconds?: number;
|
|
1302
1565
|
|
|
1303
|
-
|
|
1566
|
+
scopes?: Array<string>;
|
|
1567
|
+
}
|
|
1304
1568
|
|
|
1305
|
-
|
|
1569
|
+
/**
|
|
1570
|
+
* The user object along their identity token.
|
|
1571
|
+
*/
|
|
1572
|
+
export interface UserWithIdentityToken {
|
|
1573
|
+
identity_token: string | null;
|
|
1306
1574
|
|
|
1307
|
-
|
|
1575
|
+
/**
|
|
1576
|
+
* A Privy user object.
|
|
1577
|
+
*/
|
|
1578
|
+
user: User;
|
|
1579
|
+
}
|
|
1308
1580
|
|
|
1309
|
-
|
|
1581
|
+
/**
|
|
1582
|
+
* The authenticated user.
|
|
1583
|
+
*/
|
|
1584
|
+
export interface AuthenticatedUser {
|
|
1585
|
+
token: string | null;
|
|
1310
1586
|
|
|
1311
|
-
|
|
1587
|
+
privy_access_token: string | null;
|
|
1312
1588
|
|
|
1313
|
-
|
|
1314
|
-
}
|
|
1589
|
+
refresh_token: string | null;
|
|
1315
1590
|
|
|
1316
|
-
|
|
1317
|
-
|
|
1591
|
+
/**
|
|
1592
|
+
* Instructs the client on how to handle tokens received
|
|
1593
|
+
*/
|
|
1594
|
+
session_update_action: 'set' | 'ignore' | 'clear';
|
|
1318
1595
|
|
|
1319
|
-
|
|
1596
|
+
/**
|
|
1597
|
+
* A Privy user object.
|
|
1598
|
+
*/
|
|
1599
|
+
user: User;
|
|
1320
1600
|
|
|
1321
|
-
|
|
1601
|
+
identity_token?: string;
|
|
1322
1602
|
|
|
1323
|
-
|
|
1603
|
+
is_new_user?: boolean;
|
|
1324
1604
|
|
|
1325
|
-
|
|
1605
|
+
/**
|
|
1606
|
+
* OAuth tokens associated with the user.
|
|
1607
|
+
*/
|
|
1608
|
+
oauth_tokens?: OAuthTokens;
|
|
1609
|
+
}
|
|
1326
1610
|
|
|
1327
|
-
|
|
1328
|
-
|
|
1611
|
+
export interface UserCreateParams {
|
|
1612
|
+
linked_accounts: Array<LinkedAccountInput>;
|
|
1329
1613
|
|
|
1330
|
-
|
|
1331
|
-
|
|
1614
|
+
/**
|
|
1615
|
+
* Custom metadata associated with the user.
|
|
1616
|
+
*/
|
|
1617
|
+
custom_metadata?: CustomMetadata;
|
|
1332
1618
|
|
|
1333
|
-
|
|
1334
|
-
|
|
1619
|
+
/**
|
|
1620
|
+
* Wallets to create for the user.
|
|
1621
|
+
*/
|
|
1622
|
+
wallets?: Array<UserCreateParams.Wallet>;
|
|
1623
|
+
}
|
|
1335
1624
|
|
|
1625
|
+
export namespace UserCreateParams {
|
|
1336
1626
|
export interface Wallet {
|
|
1337
1627
|
/**
|
|
1338
1628
|
* The wallet chain types.
|
|
@@ -1471,45 +1761,33 @@ export interface UserSetCustomMetadataParams {
|
|
|
1471
1761
|
/**
|
|
1472
1762
|
* Custom metadata associated with the user.
|
|
1473
1763
|
*/
|
|
1474
|
-
custom_metadata:
|
|
1764
|
+
custom_metadata: CustomMetadata;
|
|
1475
1765
|
}
|
|
1476
1766
|
|
|
1477
1767
|
export interface UserUnlinkLinkedAccountParams {
|
|
1478
1768
|
handle: string;
|
|
1479
1769
|
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
| 'farcaster'
|
|
1485
|
-
| 'passkey'
|
|
1486
|
-
| 'phone'
|
|
1487
|
-
| 'google_oauth'
|
|
1488
|
-
| 'discord_oauth'
|
|
1489
|
-
| 'twitter_oauth'
|
|
1490
|
-
| 'github_oauth'
|
|
1491
|
-
| 'linkedin_oauth'
|
|
1492
|
-
| 'apple_oauth'
|
|
1493
|
-
| 'spotify_oauth'
|
|
1494
|
-
| 'instagram_oauth'
|
|
1495
|
-
| 'tiktok_oauth'
|
|
1496
|
-
| 'line_oauth'
|
|
1497
|
-
| 'twitch_oauth'
|
|
1498
|
-
| 'custom_auth'
|
|
1499
|
-
| 'telegram'
|
|
1500
|
-
| 'cross_app'
|
|
1501
|
-
| 'guest'
|
|
1502
|
-
| (string & {});
|
|
1770
|
+
/**
|
|
1771
|
+
* The possible types of linked accounts.
|
|
1772
|
+
*/
|
|
1773
|
+
type: LinkedAccountType;
|
|
1503
1774
|
|
|
1504
1775
|
provider?: string;
|
|
1505
1776
|
}
|
|
1506
1777
|
|
|
1507
1778
|
export declare namespace Users {
|
|
1508
1779
|
export {
|
|
1509
|
-
type
|
|
1510
|
-
type
|
|
1511
|
-
type
|
|
1512
|
-
type
|
|
1780
|
+
type LinkedAccountEmail as LinkedAccountEmail,
|
|
1781
|
+
type LinkedAccountPhone as LinkedAccountPhone,
|
|
1782
|
+
type LinkedAccountBaseWallet as LinkedAccountBaseWallet,
|
|
1783
|
+
type LinkedAccountEthereum as LinkedAccountEthereum,
|
|
1784
|
+
type SmartWalletType as SmartWalletType,
|
|
1785
|
+
type LinkedAccountSmartWallet as LinkedAccountSmartWallet,
|
|
1786
|
+
type LinkedAccountSolana as LinkedAccountSolana,
|
|
1787
|
+
type LinkedAccountFarcaster as LinkedAccountFarcaster,
|
|
1788
|
+
type LinkedAccountPasskey as LinkedAccountPasskey,
|
|
1789
|
+
type LinkedAccountTelegram as LinkedAccountTelegram,
|
|
1790
|
+
type EmbeddedWalletRecoveryMethod as EmbeddedWalletRecoveryMethod,
|
|
1513
1791
|
type LinkedAccountEthereumEmbeddedWallet as LinkedAccountEthereumEmbeddedWallet,
|
|
1514
1792
|
type LinkedAccountSolanaEmbeddedWallet as LinkedAccountSolanaEmbeddedWallet,
|
|
1515
1793
|
type LinkedAccountBitcoinSegwitEmbeddedWallet as LinkedAccountBitcoinSegwitEmbeddedWallet,
|
|
@@ -1517,8 +1795,54 @@ export declare namespace Users {
|
|
|
1517
1795
|
type LinkedAccountCurveSigningEmbeddedWallet as LinkedAccountCurveSigningEmbeddedWallet,
|
|
1518
1796
|
type LinkedAccountEmbeddedWallet as LinkedAccountEmbeddedWallet,
|
|
1519
1797
|
type LinkedAccountEmbeddedWalletWithID as LinkedAccountEmbeddedWalletWithID,
|
|
1520
|
-
type
|
|
1521
|
-
type
|
|
1798
|
+
type LinkedAccountGoogleOAuth as LinkedAccountGoogleOAuth,
|
|
1799
|
+
type LinkedAccountTwitterOAuth as LinkedAccountTwitterOAuth,
|
|
1800
|
+
type LinkedAccountDiscordOAuth as LinkedAccountDiscordOAuth,
|
|
1801
|
+
type LinkedAccountGitHubOAuth as LinkedAccountGitHubOAuth,
|
|
1802
|
+
type LinkedAccountLinkedInOAuth as LinkedAccountLinkedInOAuth,
|
|
1803
|
+
type LinkedAccountSpotifyOAuth as LinkedAccountSpotifyOAuth,
|
|
1804
|
+
type LinkedAccountInstagramOAuth as LinkedAccountInstagramOAuth,
|
|
1805
|
+
type LinkedAccountTiktokOAuth as LinkedAccountTiktokOAuth,
|
|
1806
|
+
type LinkedAccountLineOAuth as LinkedAccountLineOAuth,
|
|
1807
|
+
type LinkedAccountTwitchOAuth as LinkedAccountTwitchOAuth,
|
|
1808
|
+
type LinkedAccountAppleOAuth as LinkedAccountAppleOAuth,
|
|
1809
|
+
type LinkedAccountCustomOAuth as LinkedAccountCustomOAuth,
|
|
1810
|
+
type LinkedAccountCustomJwt as LinkedAccountCustomJwt,
|
|
1811
|
+
type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet,
|
|
1812
|
+
type CrossAppSmartWallet as CrossAppSmartWallet,
|
|
1813
|
+
type LinkedAccountCrossApp as LinkedAccountCrossApp,
|
|
1814
|
+
type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey,
|
|
1815
|
+
type LinkedAccount as LinkedAccount,
|
|
1816
|
+
type LinkedAccountType as LinkedAccountType,
|
|
1817
|
+
type CustomMetadata as CustomMetadata,
|
|
1818
|
+
type LinkedAccountWalletInput as LinkedAccountWalletInput,
|
|
1819
|
+
type LinkedAccountEmailInput as LinkedAccountEmailInput,
|
|
1820
|
+
type LinkedAccountPhoneInput as LinkedAccountPhoneInput,
|
|
1821
|
+
type LinkedAccountGoogleInput as LinkedAccountGoogleInput,
|
|
1822
|
+
type LinkedAccountTwitterInput as LinkedAccountTwitterInput,
|
|
1823
|
+
type LinkedAccountDiscordInput as LinkedAccountDiscordInput,
|
|
1824
|
+
type LinkedAccountGitHubInput as LinkedAccountGitHubInput,
|
|
1825
|
+
type LinkedAccountSpotifyInput as LinkedAccountSpotifyInput,
|
|
1826
|
+
type LinkedAccountInstagramInput as LinkedAccountInstagramInput,
|
|
1827
|
+
type LinkedAccountTiktokInput as LinkedAccountTiktokInput,
|
|
1828
|
+
type LinkedAccountLineInput as LinkedAccountLineInput,
|
|
1829
|
+
type LinkedAccountTwitchInput as LinkedAccountTwitchInput,
|
|
1830
|
+
type LinkedAccountAppleInput as LinkedAccountAppleInput,
|
|
1831
|
+
type LinkedAccountLinkedInInput as LinkedAccountLinkedInInput,
|
|
1832
|
+
type LinkedAccountFarcasterInput as LinkedAccountFarcasterInput,
|
|
1833
|
+
type LinkedAccountTelegramInput as LinkedAccountTelegramInput,
|
|
1834
|
+
type LinkedAccountCustomJwtInput as LinkedAccountCustomJwtInput,
|
|
1835
|
+
type LinkedAccountPasskeyInput as LinkedAccountPasskeyInput,
|
|
1836
|
+
type LinkedAccountInput as LinkedAccountInput,
|
|
1837
|
+
type UserBatchCreateInput as UserBatchCreateInput,
|
|
1838
|
+
type SMSMfaMethod as SMSMfaMethod,
|
|
1839
|
+
type TotpMfaMethod as TotpMfaMethod,
|
|
1840
|
+
type PasskeyMfaMethod as PasskeyMfaMethod,
|
|
1841
|
+
type LinkedMfaMethod as LinkedMfaMethod,
|
|
1842
|
+
type User as User,
|
|
1843
|
+
type OAuthTokens as OAuthTokens,
|
|
1844
|
+
type UserWithIdentityToken as UserWithIdentityToken,
|
|
1845
|
+
type AuthenticatedUser as AuthenticatedUser,
|
|
1522
1846
|
type UsersCursor as UsersCursor,
|
|
1523
1847
|
type UserCreateParams as UserCreateParams,
|
|
1524
1848
|
type UserListParams as UserListParams,
|