@privy-io/api-types 0.10.0 → 0.12.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.
Files changed (135) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/client.d.mts +22 -28
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +22 -28
  5. package/client.d.ts.map +1 -1
  6. package/client.js +6 -12
  7. package/client.js.map +1 -1
  8. package/client.mjs +7 -13
  9. package/client.mjs.map +1 -1
  10. package/internal/utils/log.d.mts.map +1 -1
  11. package/internal/utils/log.d.ts.map +1 -1
  12. package/internal/utils/log.js +2 -0
  13. package/internal/utils/log.js.map +1 -1
  14. package/internal/utils/log.mjs +2 -0
  15. package/internal/utils/log.mjs.map +1 -1
  16. package/package.json +1 -1
  17. package/resources/apps.d.mts +5 -0
  18. package/resources/apps.d.mts.map +1 -1
  19. package/resources/apps.d.ts +5 -0
  20. package/resources/apps.d.ts.map +1 -1
  21. package/resources/client-auth.d.mts +496 -514
  22. package/resources/client-auth.d.mts.map +1 -1
  23. package/resources/client-auth.d.ts +496 -514
  24. package/resources/client-auth.d.ts.map +1 -1
  25. package/resources/client-auth.js.map +1 -1
  26. package/resources/client-auth.mjs.map +1 -1
  27. package/resources/cross-app.d.mts +5 -0
  28. package/resources/cross-app.d.mts.map +1 -1
  29. package/resources/cross-app.d.ts +5 -0
  30. package/resources/cross-app.d.ts.map +1 -1
  31. package/resources/embedded-wallets.d.mts +10 -10
  32. package/resources/embedded-wallets.d.mts.map +1 -1
  33. package/resources/embedded-wallets.d.ts +10 -10
  34. package/resources/embedded-wallets.d.ts.map +1 -1
  35. package/resources/fiat.d.mts +110 -0
  36. package/resources/fiat.d.mts.map +1 -0
  37. package/resources/fiat.d.ts +110 -0
  38. package/resources/fiat.d.ts.map +1 -0
  39. package/resources/fiat.js +9 -0
  40. package/resources/fiat.js.map +1 -0
  41. package/resources/fiat.mjs +5 -0
  42. package/resources/fiat.mjs.map +1 -0
  43. package/resources/funding.d.mts +46 -46
  44. package/resources/funding.d.mts.map +1 -1
  45. package/resources/funding.d.ts +46 -46
  46. package/resources/funding.d.ts.map +1 -1
  47. package/resources/index.d.mts +11 -10
  48. package/resources/index.d.mts.map +1 -1
  49. package/resources/index.d.ts +11 -10
  50. package/resources/index.d.ts.map +1 -1
  51. package/resources/index.js +3 -1
  52. package/resources/index.js.map +1 -1
  53. package/resources/index.mjs +2 -1
  54. package/resources/index.mjs.map +1 -1
  55. package/resources/key-quorums.d.mts +1 -132
  56. package/resources/key-quorums.d.mts.map +1 -1
  57. package/resources/key-quorums.d.ts +1 -132
  58. package/resources/key-quorums.d.ts.map +1 -1
  59. package/resources/key-quorums.js +0 -92
  60. package/resources/key-quorums.js.map +1 -1
  61. package/resources/key-quorums.mjs +0 -92
  62. package/resources/key-quorums.mjs.map +1 -1
  63. package/resources/policies.d.mts +2 -312
  64. package/resources/policies.d.mts.map +1 -1
  65. package/resources/policies.d.ts +2 -312
  66. package/resources/policies.d.ts.map +1 -1
  67. package/resources/policies.js +0 -229
  68. package/resources/policies.js.map +1 -1
  69. package/resources/policies.mjs +0 -229
  70. package/resources/policies.mjs.map +1 -1
  71. package/resources/swaps.d.mts +54 -26
  72. package/resources/swaps.d.mts.map +1 -1
  73. package/resources/swaps.d.ts +54 -26
  74. package/resources/swaps.d.ts.map +1 -1
  75. package/resources/transactions.d.mts +28 -44
  76. package/resources/transactions.d.mts.map +1 -1
  77. package/resources/transactions.d.ts +28 -44
  78. package/resources/transactions.d.ts.map +1 -1
  79. package/resources/transactions.js +0 -17
  80. package/resources/transactions.js.map +1 -1
  81. package/resources/transactions.mjs +0 -17
  82. package/resources/transactions.mjs.map +1 -1
  83. package/resources/users.d.mts +1 -345
  84. package/resources/users.d.mts.map +1 -1
  85. package/resources/users.d.ts +1 -345
  86. package/resources/users.d.ts.map +1 -1
  87. package/resources/users.js +0 -272
  88. package/resources/users.js.map +1 -1
  89. package/resources/users.mjs +0 -272
  90. package/resources/users.mjs.map +1 -1
  91. package/resources/wallet-actions.d.mts +22 -3
  92. package/resources/wallet-actions.d.mts.map +1 -1
  93. package/resources/wallet-actions.d.ts +22 -3
  94. package/resources/wallet-actions.d.ts.map +1 -1
  95. package/resources/wallets/index.d.mts +1 -1
  96. package/resources/wallets/index.d.mts.map +1 -1
  97. package/resources/wallets/index.d.ts +1 -1
  98. package/resources/wallets/index.d.ts.map +1 -1
  99. package/resources/wallets/index.js.map +1 -1
  100. package/resources/wallets/index.mjs.map +1 -1
  101. package/resources/wallets/transactions.d.mts +6 -2
  102. package/resources/wallets/transactions.d.mts.map +1 -1
  103. package/resources/wallets/transactions.d.ts +6 -2
  104. package/resources/wallets/transactions.d.ts.map +1 -1
  105. package/resources/wallets/wallets.d.mts +184 -342
  106. package/resources/wallets/wallets.d.mts.map +1 -1
  107. package/resources/wallets/wallets.d.ts +184 -342
  108. package/resources/wallets/wallets.d.ts.map +1 -1
  109. package/resources/wallets/wallets.js +41 -102
  110. package/resources/wallets/wallets.js.map +1 -1
  111. package/resources/wallets/wallets.mjs +41 -102
  112. package/resources/wallets/wallets.mjs.map +1 -1
  113. package/src/client.ts +122 -153
  114. package/src/internal/utils/log.ts +2 -0
  115. package/src/resources/apps.ts +6 -0
  116. package/src/resources/client-auth.ts +743 -787
  117. package/src/resources/cross-app.ts +6 -0
  118. package/src/resources/embedded-wallets.ts +16 -15
  119. package/src/resources/fiat.ts +177 -0
  120. package/src/resources/funding.ts +65 -65
  121. package/src/resources/index.ts +97 -107
  122. package/src/resources/key-quorums.ts +1 -203
  123. package/src/resources/policies.ts +1 -495
  124. package/src/resources/swaps.ts +59 -25
  125. package/src/resources/transactions.ts +35 -55
  126. package/src/resources/users.ts +1 -479
  127. package/src/resources/wallet-actions.ts +38 -2
  128. package/src/resources/wallets/index.ts +4 -9
  129. package/src/resources/wallets/transactions.ts +6 -2
  130. package/src/resources/wallets/wallets.ts +236 -450
  131. package/src/version.ts +1 -1
  132. package/version.d.mts +1 -1
  133. package/version.d.ts +1 -1
  134. package/version.js +1 -1
  135. package/version.mjs +1 -1
@@ -2,669 +2,11 @@
2
2
 
3
3
  import { APIResource } from '../core/resource';
4
4
  import * as EmbeddedWalletsAPI from './embedded-wallets';
5
+ import * as FiatAPI from './fiat';
5
6
  import * as UsersAPI from './users';
6
7
 
7
8
  export class ClientAuth extends APIResource {}
8
9
 
9
- /**
10
- * The request body for authenticating with a custom JWT.
11
- */
12
- export interface CustomJwtAuthenticateRequestBody {
13
- token?: string;
14
-
15
- /**
16
- * Whether to allow sign-up during authentication.
17
- */
18
- mode?: AuthenticateModeOption;
19
- }
20
-
21
- /**
22
- * The request body for linking a custom JWT account.
23
- */
24
- export interface CustomJwtLinkRequestBody {
25
- token?: string;
26
- }
27
-
28
- /**
29
- * The request body for authenticating with Farcaster.
30
- */
31
- export interface FarcasterAuthenticateRequestBody {
32
- channel_token: string;
33
-
34
- fid: number;
35
-
36
- message: string;
37
-
38
- signature: string;
39
-
40
- /**
41
- * Whether to allow sign-up during authentication.
42
- */
43
- mode?: AuthenticateModeOption;
44
- }
45
-
46
- /**
47
- * The response body for initiating a Farcaster connection.
48
- */
49
- export interface FarcasterConnectInitResponseBody {
50
- channel_token: string;
51
-
52
- connect_uri: string;
53
- }
54
-
55
- /**
56
- * The response body for completing a Farcaster connection.
57
- */
58
- export interface FarcasterConnectStatusCompletedResponseBody {
59
- bio: string;
60
-
61
- display_name: string;
62
-
63
- fid: number;
64
-
65
- message: string;
66
-
67
- nonce: string;
68
-
69
- pfp_url: string;
70
-
71
- signature: string;
72
-
73
- state: 'completed';
74
-
75
- username: string;
76
- }
77
-
78
- /**
79
- * The response body for pending a Farcaster connection.
80
- */
81
- export interface FarcasterConnectStatusPendingResponseBody {
82
- nonce: string;
83
-
84
- state: 'pending';
85
- }
86
-
87
- /**
88
- * The request body for initiating a Farcaster connection.
89
- */
90
- export interface FarcasterInitRequestBody {
91
- token?: string;
92
-
93
- redirect_url?: string;
94
-
95
- relying_party?: string;
96
- }
97
-
98
- /**
99
- * The request body for linking a Farcaster account.
100
- */
101
- export interface FarcasterLinkRequestBody {
102
- channel_token: string;
103
-
104
- fid: number;
105
-
106
- message: string;
107
-
108
- signature: string;
109
- }
110
-
111
- /**
112
- * The request body for initiating a Farcaster signer connection.
113
- */
114
- export interface FarcasterSignerInitRequestBody {
115
- ed25519_public_key: string;
116
-
117
- deadline?: string;
118
- }
119
-
120
- /**
121
- * The response body from initiating a Farcaster signer connection.
122
- */
123
- export type FarcasterSignerInitResponseBody =
124
- | FarcasterSignerInitPendingApproval
125
- | FarcasterSignerApproved
126
- | FarcasterSignerRevoked;
127
-
128
- /**
129
- * The response body from checking the status of a Farcaster signer connection.
130
- */
131
- export type FarcasterSignerStatusResponseBody =
132
- | FarcasterSignerStatusPendingApproval
133
- | FarcasterSignerApproved
134
- | FarcasterSignerRevoked;
135
-
136
- /**
137
- * The request body for unlinking a Farcaster account.
138
- */
139
- export interface FarcasterUnlinkRequestBody {
140
- fid: number;
141
- }
142
-
143
- /**
144
- * The request body for authenticating a Farcaster V2 account.
145
- */
146
- export interface FarcasterV2AuthenticateRequestBody {
147
- fid: number;
148
-
149
- message: string;
150
-
151
- signature: string;
152
-
153
- /**
154
- * Whether to allow sign-up during authentication.
155
- */
156
- mode?: AuthenticateModeOption;
157
- }
158
-
159
- /**
160
- * The response body for initiating a Farcaster V2 connection.
161
- */
162
- export interface FarcasterV2InitResponseBody {
163
- expires_at: string;
164
-
165
- nonce: string;
166
- }
167
-
168
- /**
169
- * The request body for authenticating a guest.
170
- */
171
- export interface GuestAuthenticateRequestBody {
172
- guest_credential: string;
173
- }
174
-
175
- /**
176
- * The request body for enrolling a passkey MFA flow.
177
- */
178
- export interface MfaPasskeyEnrollmentRequestBody {
179
- credential_ids: Array<string>;
180
-
181
- remove_for_login?: boolean;
182
- }
183
-
184
- /**
185
- * The request body for initiating a passkey MFA flow.
186
- */
187
- export interface MfaPasskeyInitRequestBody {
188
- relying_party?: string;
189
- }
190
-
191
- /**
192
- * The response body for initializing a passkey MFA flow.
193
- */
194
- export interface MfaPasskeyInitResponseBody {
195
- /**
196
- * WebAuthn authentication options as defined by the Web Authentication
197
- * specification.
198
- */
199
- options: PasskeyAuthenticatorVerifyOptions;
200
-
201
- relying_party?: string;
202
- }
203
-
204
- /**
205
- * The request body for verifying a passkey MFA flow.
206
- */
207
- export interface MfaPasskeyVerifyRequestBody {
208
- /**
209
- * WebAuthn authentication response as defined by the Web Authentication
210
- * specification.
211
- */
212
- authenticator_response: PasskeyAuthenticatorVerifyResponse;
213
-
214
- relying_party?: string;
215
- }
216
-
217
- /**
218
- * The request body for enrolling a SMS MFA code.
219
- */
220
- export interface MfaSMSEnrollRequestBody {
221
- code: string;
222
-
223
- phoneNumber: string;
224
- }
225
-
226
- /**
227
- * The request body for initiating a SMS MFA flow.
228
- */
229
- export type MfaSMSInitRequestBody = MfaSMSInitVerifyInput | MfaSMSInitEnrollInput;
230
-
231
- /**
232
- * The request body for verifying a SMS MFA code.
233
- */
234
- export interface MfaSMSVerifyRequestBody {
235
- code: string;
236
- }
237
-
238
- /**
239
- * The response body for initializing a TOTP MFA code.
240
- */
241
- export interface MfaTotpInitResponseBody {
242
- totpAuthUrl: string;
243
-
244
- totpSecret: string;
245
- }
246
-
247
- /**
248
- * The input for verifying a TOTP MFA code.
249
- */
250
- export interface MfaTotpInput {
251
- code: string;
252
- }
253
-
254
- /**
255
- * The response body for verifying a MFA code.
256
- */
257
- export interface MfaVerifyResponseBody {
258
- token: string;
259
- }
260
-
261
- /**
262
- * The request body for authenticating an OAuth account.
263
- */
264
- export interface OAuthAuthenticateRequestBody {
265
- authorization_code: string;
266
-
267
- state_code: string;
268
-
269
- /**
270
- * The type of OAuth authorization code.
271
- */
272
- code_type?: OAuthCodeType;
273
-
274
- code_verifier?: string;
275
-
276
- /**
277
- * Whether to allow sign-up during authentication.
278
- */
279
- mode?: AuthenticateModeOption;
280
- }
281
-
282
- /**
283
- * The request body for getting an OAuth authorization code.
284
- */
285
- export interface OAuthAuthorizationCodeRequestBody {
286
- code_challenge: string;
287
-
288
- redirect_to: string;
289
-
290
- state: string;
291
- }
292
-
293
- /**
294
- * The request body for initiating an OAuth ceremony.
295
- */
296
- export interface OAuthInitRequestBody {
297
- /**
298
- * The ID of an OAuth provider.
299
- */
300
- provider: OAuthProviderID;
301
-
302
- redirect_to: string;
303
-
304
- token?: string;
305
-
306
- code_challenge?: string;
307
-
308
- state_code?: string;
309
- }
310
-
311
- /**
312
- * The response for initiating an OAuth ceremony.
313
- */
314
- export interface OAuthInitResponseBody {
315
- url: string;
316
- }
317
-
318
- /**
319
- * The request body for linking an OAuth account.
320
- */
321
- export interface OAuthLinkRequestBody {
322
- authorization_code: string;
323
-
324
- state_code: string;
325
-
326
- /**
327
- * The type of OAuth authorization code.
328
- */
329
- code_type?: OAuthCodeType;
330
-
331
- code_verifier?: string;
332
- }
333
-
334
- /**
335
- * The response for linking an OAuth account.
336
- */
337
- export interface OAuthLinkResponseBody extends UsersAPI.User {
338
- /**
339
- * OAuth tokens associated with the user.
340
- */
341
- oauth_tokens?: UsersAPI.OAuthTokens;
342
- }
343
-
344
- /**
345
- * The request body for unlinking an OAuth account.
346
- */
347
- export interface OAuthUnlinkRequestBody {
348
- /**
349
- * The ID of an OAuth provider.
350
- */
351
- provider: OAuthProviderID;
352
-
353
- subject: string;
354
- }
355
-
356
- /**
357
- * The request body for verifying a PRAT.
358
- */
359
- export interface OAuthVerifyRequestBody {
360
- prat: string;
361
- }
362
-
363
- /**
364
- * The response body when verifying a PRAT.
365
- */
366
- export interface OAuthVerifyResponseBody {
367
- verified: boolean;
368
- }
369
-
370
- /**
371
- * The input for refreshing a session or logging out.
372
- */
373
- export interface OptionalRefreshTokenInput {
374
- refresh_token?: string;
375
- }
376
-
377
- /**
378
- * The request body for authenticating a passwordless account.
379
- */
380
- export interface PasswordlessAuthenticateRequestBody {
381
- code: string;
382
-
383
- email: string;
384
-
385
- /**
386
- * Whether to allow sign-up during authentication.
387
- */
388
- mode?: AuthenticateModeOption;
389
- }
390
-
391
- /**
392
- * The request body for initiating a passwordless ceremony.
393
- */
394
- export interface PasswordlessInitRequestBody {
395
- email: string;
396
-
397
- token?: string;
398
- }
399
-
400
- /**
401
- * The request body for linking a passwordless account.
402
- */
403
- export interface PasswordlessLinkRequestBody {
404
- code: string;
405
-
406
- email: string;
407
- }
408
-
409
- /**
410
- * The request body for authenticating a passwordless sms account.
411
- */
412
- export interface PasswordlessSMSAuthenticateRequestBody {
413
- code: string;
414
-
415
- phoneNumber: string;
416
-
417
- /**
418
- * Whether to allow sign-up during authentication.
419
- */
420
- mode?: AuthenticateModeOption;
421
- }
422
-
423
- /**
424
- * The request body for initiating a passwordless sms ceremony.
425
- */
426
- export interface PasswordlessSMSInitRequestBody {
427
- phoneNumber: string;
428
-
429
- token?: string;
430
- }
431
-
432
- /**
433
- * The request body for linking a passwordless sms account.
434
- */
435
- export interface PasswordlessSMSLinkRequestBody {
436
- code: string;
437
-
438
- phoneNumber: string;
439
- }
440
-
441
- /**
442
- * The request body for unlinking a passwordless sms account.
443
- */
444
- export interface PasswordlessSMSUnlinkRequestBody {
445
- phoneNumber: string;
446
- }
447
-
448
- /**
449
- * The request body for updating a passwordless sms account.
450
- */
451
- export interface PasswordlessSMSUpdateRequestBody {
452
- code: string;
453
-
454
- new_phone_number: string;
455
-
456
- old_phone_number: string;
457
- }
458
-
459
- /**
460
- * The request body for unlinking a passwordless account.
461
- */
462
- export interface PasswordlessUnlinkRequestBody {
463
- address: string;
464
- }
465
-
466
- /**
467
- * The request body for updating a passwordless account.
468
- */
469
- export interface PasswordlessUpdateRequestBody {
470
- code: string;
471
-
472
- newAddress: string;
473
-
474
- oldAddress: string;
475
- }
476
-
477
- /**
478
- * The request body for authenticating a SIWE ceremony.
479
- */
480
- export interface SiweAuthenticateRequestBody {
481
- message: string;
482
-
483
- signature: string;
484
-
485
- chainId?: string | null;
486
-
487
- connectorType?: string | null;
488
-
489
- /**
490
- * Whether to allow sign-up during authentication.
491
- */
492
- mode?: AuthenticateModeOption;
493
-
494
- walletClientType?: string | null;
495
- }
496
-
497
- /**
498
- * The request body for initiating a SIWE ceremony.
499
- */
500
- export interface SiweInitRequestBody {
501
- address: string;
502
- }
503
-
504
- /**
505
- * The response body for initiating a SIWE ceremony.
506
- */
507
- export interface SiweInitResponseBody {
508
- address: string;
509
-
510
- expires_at: string;
511
-
512
- nonce: string;
513
- }
514
-
515
- /**
516
- * The request body for linking a SIWE ceremony.
517
- */
518
- export interface SiweLinkRequestBody {
519
- message: string;
520
-
521
- signature: string;
522
-
523
- chainId?: string | null;
524
-
525
- connectorType?: string | null;
526
-
527
- walletClientType?: string | null;
528
- }
529
-
530
- /**
531
- * The request body for linking a SIWE ceremony to a smart wallet.
532
- */
533
- export interface SiweLinkSmartWalletRequestBody {
534
- message: string;
535
-
536
- signature: string;
537
-
538
- /**
539
- * The supported smart wallet providers.
540
- */
541
- smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
542
-
543
- smart_wallet_version?: string;
544
- }
545
-
546
- /**
547
- * The request body for unlinking a SIWE ceremony.
548
- */
549
- export interface SiweUnlinkRequestBody {
550
- address: string;
551
- }
552
-
553
- /**
554
- * The request body for authenticating a SIWS ceremony.
555
- */
556
- export interface SiwsAuthenticateRequestBody {
557
- message: string;
558
-
559
- signature: string;
560
-
561
- connectorType?: string | null;
562
-
563
- message_type?: 'transaction' | 'plain';
564
-
565
- /**
566
- * Whether to allow sign-up during authentication.
567
- */
568
- mode?: AuthenticateModeOption;
569
-
570
- walletClientType?: string | null;
571
- }
572
-
573
- /**
574
- * The request body for initiating a SIWS ceremony.
575
- */
576
- export interface SiwsInitRequestBody {
577
- address: string;
578
- }
579
-
580
- /**
581
- * The response body for initiating a SIWS ceremony.
582
- */
583
- export interface SiwsInitResponseBody {
584
- address: string;
585
-
586
- expires_at: string;
587
-
588
- nonce: string;
589
- }
590
-
591
- /**
592
- * The request body for linking a SIWS ceremony.
593
- */
594
- export interface SiwsLinkRequestBody {
595
- message: string;
596
-
597
- signature: string;
598
-
599
- connectorType?: string | null;
600
-
601
- message_type?: 'transaction' | 'plain';
602
-
603
- walletClientType?: string | null;
604
- }
605
-
606
- /**
607
- * The request body for unlinking a SIWS ceremony.
608
- */
609
- export interface SiwsUnlinkRequestBody {
610
- address: string;
611
- }
612
-
613
- /**
614
- * The request body for authenticating with Telegram.
615
- */
616
- export interface TelegramAuthenticateRequestBody {
617
- captcha_token?: string;
618
-
619
- /**
620
- * Whether to allow sign-up during authentication.
621
- */
622
- mode?: AuthenticateModeOption;
623
-
624
- /**
625
- * Auth result object returned by Telegram when a user authenticates using the
626
- * login widget.
627
- */
628
- telegram_auth_result?: TelegramAuthResult;
629
-
630
- /**
631
- * Auth result object returned by Telegram when a user authenticates using a mini
632
- * app.
633
- */
634
- telegram_web_app_data?: TelegramWebAppData;
635
- }
636
-
637
- /**
638
- * The request body for linking a Telegram account.
639
- */
640
- export interface TelegramLinkRequestBody {
641
- captcha_token?: string;
642
-
643
- /**
644
- * Whether to allow sign-up during authentication.
645
- */
646
- mode?: AuthenticateModeOption;
647
-
648
- /**
649
- * Auth result object returned by Telegram when a user authenticates using the
650
- * login widget.
651
- */
652
- telegram_auth_result?: TelegramAuthResult;
653
-
654
- /**
655
- * Auth result object returned by Telegram when a user authenticates using a mini
656
- * app.
657
- */
658
- telegram_web_app_data?: TelegramWebAppData;
659
- }
660
-
661
- /**
662
- * The request body for unlinking a Telegram account.
663
- */
664
- export interface TelegramUnlinkRequestBody {
665
- telegram_user_id: string;
666
- }
667
-
668
10
  /**
669
11
  * Input for authenticating with a custom JWT.
670
12
  */
@@ -781,17 +123,7 @@ export interface BridgeFiatCustomerResponse {
781
123
  /**
782
124
  * Status of the KYC verification process.
783
125
  */
784
- status:
785
- | 'not_found'
786
- | 'active'
787
- | 'awaiting_questionnaire'
788
- | 'awaiting_ubo'
789
- | 'incomplete'
790
- | 'not_started'
791
- | 'offboarded'
792
- | 'paused'
793
- | 'rejected'
794
- | 'under_review';
126
+ status: FiatAPI.OnrampKYCStatus;
795
127
 
796
128
  kyc_url?: string;
797
129
 
@@ -906,17 +238,7 @@ export interface BridgeSandboxFiatCustomerResponse {
906
238
  /**
907
239
  * Status of the KYC verification process.
908
240
  */
909
- status:
910
- | 'not_found'
911
- | 'active'
912
- | 'awaiting_questionnaire'
913
- | 'awaiting_ubo'
914
- | 'incomplete'
915
- | 'not_started'
916
- | 'offboarded'
917
- | 'paused'
918
- | 'rejected'
919
- | 'under_review';
241
+ status: FiatAPI.OnrampKYCStatus;
920
242
 
921
243
  kyc_url?: string;
922
244
 
@@ -998,6 +320,25 @@ export interface CreateOrUpdateFiatCustomerRequestInput {
998
320
  */
999
321
  export type CryptoCurrencyCode = string;
1000
322
 
323
+ /**
324
+ * The request body for authenticating with a custom JWT.
325
+ */
326
+ export interface CustomJwtAuthenticateRequestBody {
327
+ token?: string;
328
+
329
+ /**
330
+ * Whether to allow sign-up during authentication.
331
+ */
332
+ mode?: AuthenticateModeOption;
333
+ }
334
+
335
+ /**
336
+ * The request body for linking a custom JWT account.
337
+ */
338
+ export interface CustomJwtLinkRequestBody {
339
+ token?: string;
340
+ }
341
+
1001
342
  /**
1002
343
  * The ID of a custom OAuth provider, set up for this app. Must start with
1003
344
  * "custom:".
@@ -1028,29 +369,79 @@ export interface FarcasterAuthenticateInput {
1028
369
 
1029
370
  fid: number;
1030
371
 
1031
- message: string;
372
+ message: string;
373
+
374
+ signature: string;
375
+
376
+ /**
377
+ * Whether to allow sign-up during authentication.
378
+ */
379
+ mode?: AuthenticateModeOption;
380
+ }
381
+
382
+ /**
383
+ * The request body for authenticating with Farcaster.
384
+ */
385
+ export interface FarcasterAuthenticateRequestBody {
386
+ channel_token: string;
387
+
388
+ fid: number;
389
+
390
+ message: string;
391
+
392
+ signature: string;
393
+
394
+ /**
395
+ * Whether to allow sign-up during authentication.
396
+ */
397
+ mode?: AuthenticateModeOption;
398
+ }
399
+
400
+ /**
401
+ * Proxy for the Farcaster Connect init response as defined in FIP-11.
402
+ */
403
+ export interface FarcasterConnectInitResponse {
404
+ channel_token: string;
405
+
406
+ connect_uri: string;
407
+ }
408
+
409
+ /**
410
+ * The response body for initiating a Farcaster connection.
411
+ */
412
+ export interface FarcasterConnectInitResponseBody {
413
+ channel_token: string;
414
+
415
+ connect_uri: string;
416
+ }
417
+
418
+ /**
419
+ * Proxy for the Farcaster Connect completed status response as defined in FIP-11.
420
+ */
421
+ export interface FarcasterConnectStatusCompletedResponse {
422
+ bio: string;
423
+
424
+ display_name: string;
425
+
426
+ fid: number;
427
+
428
+ message: string;
429
+
430
+ nonce: string;
431
+
432
+ pfp_url: string;
1032
433
 
1033
434
  signature: string;
1034
435
 
1035
- /**
1036
- * Whether to allow sign-up during authentication.
1037
- */
1038
- mode?: AuthenticateModeOption;
1039
- }
1040
-
1041
- /**
1042
- * Proxy for the Farcaster Connect init response as defined in FIP-11.
1043
- */
1044
- export interface FarcasterConnectInitResponse {
1045
- channel_token: string;
436
+ state: 'completed';
1046
437
 
1047
- connect_uri: string;
438
+ username: string;
1048
439
  }
1049
440
 
1050
441
  /**
1051
- * Proxy for the Farcaster Connect completed status response as defined in FIP-11.
442
+ * The response body for completing a Farcaster connection.
1052
443
  */
1053
- export interface FarcasterConnectStatusCompletedResponse {
444
+ export interface FarcasterConnectStatusCompletedResponseBody {
1054
445
  bio: string;
1055
446
 
1056
447
  display_name: string;
@@ -1079,6 +470,15 @@ export interface FarcasterConnectStatusPendingResponse {
1079
470
  state: 'pending';
1080
471
  }
1081
472
 
473
+ /**
474
+ * The response body for pending a Farcaster connection.
475
+ */
476
+ export interface FarcasterConnectStatusPendingResponseBody {
477
+ nonce: string;
478
+
479
+ state: 'pending';
480
+ }
481
+
1082
482
  /**
1083
483
  * Input for initiating a Farcaster connection.
1084
484
  */
@@ -1090,6 +490,17 @@ export interface FarcasterInitInput {
1090
490
  relying_party?: string;
1091
491
  }
1092
492
 
493
+ /**
494
+ * The request body for initiating a Farcaster connection.
495
+ */
496
+ export interface FarcasterInitRequestBody {
497
+ token?: string;
498
+
499
+ redirect_url?: string;
500
+
501
+ relying_party?: string;
502
+ }
503
+
1093
504
  /**
1094
505
  * Input for linking a Farcaster account.
1095
506
  */
@@ -1103,6 +514,19 @@ export interface FarcasterLinkInput {
1103
514
  signature: string;
1104
515
  }
1105
516
 
517
+ /**
518
+ * The request body for linking a Farcaster account.
519
+ */
520
+ export interface FarcasterLinkRequestBody {
521
+ channel_token: string;
522
+
523
+ fid: number;
524
+
525
+ message: string;
526
+
527
+ signature: string;
528
+ }
529
+
1106
530
  /**
1107
531
  * A Farcaster signer response when the signer has been approved.
1108
532
  */
@@ -1125,6 +549,23 @@ export interface FarcasterSignerInitPendingApproval {
1125
549
  status: 'pending_approval';
1126
550
  }
1127
551
 
552
+ /**
553
+ * The request body for initiating a Farcaster signer connection.
554
+ */
555
+ export interface FarcasterSignerInitRequestBody {
556
+ ed25519_public_key: string;
557
+
558
+ deadline?: string;
559
+ }
560
+
561
+ /**
562
+ * The response body from initiating a Farcaster signer connection.
563
+ */
564
+ export type FarcasterSignerInitResponseBody =
565
+ | FarcasterSignerInitPendingApproval
566
+ | FarcasterSignerApproved
567
+ | FarcasterSignerRevoked;
568
+
1128
569
  /**
1129
570
  * A Farcaster signer response when the signer has been revoked.
1130
571
  */
@@ -1145,6 +586,14 @@ export interface FarcasterSignerStatusPendingApproval {
1145
586
  status: 'pending_approval';
1146
587
  }
1147
588
 
589
+ /**
590
+ * The response body from checking the status of a Farcaster signer connection.
591
+ */
592
+ export type FarcasterSignerStatusResponseBody =
593
+ | FarcasterSignerStatusPendingApproval
594
+ | FarcasterSignerApproved
595
+ | FarcasterSignerRevoked;
596
+
1148
597
  /**
1149
598
  * Input for unlinking a Farcaster account.
1150
599
  */
@@ -1152,6 +601,13 @@ export interface FarcasterUnlinkInput {
1152
601
  fid: number;
1153
602
  }
1154
603
 
604
+ /**
605
+ * The request body for unlinking a Farcaster account.
606
+ */
607
+ export interface FarcasterUnlinkRequestBody {
608
+ fid: number;
609
+ }
610
+
1155
611
  /**
1156
612
  * Input for authenticating a Farcaster V2 account.
1157
613
  */
@@ -1438,6 +894,13 @@ export interface GetFiatOnrampURLResponse {
1438
894
  url: string;
1439
895
  }
1440
896
 
897
+ /**
898
+ * The request body for authenticating a guest.
899
+ */
900
+ export interface GuestAuthenticateRequestBody {
901
+ guest_credential: string;
902
+ }
903
+
1441
904
  /**
1442
905
  * Input for linking a custom JWT account.
1443
906
  */
@@ -1445,6 +908,57 @@ export interface LinkJwtInput {
1445
908
  token?: string;
1446
909
  }
1447
910
 
911
+ /**
912
+ * The request body for enrolling a passkey MFA flow.
913
+ */
914
+ export interface MfaPasskeyEnrollmentRequestBody {
915
+ credential_ids: Array<string>;
916
+
917
+ remove_for_login?: boolean;
918
+ }
919
+
920
+ /**
921
+ * The request body for initiating a passkey MFA flow.
922
+ */
923
+ export interface MfaPasskeyInitRequestBody {
924
+ relying_party?: string;
925
+ }
926
+
927
+ /**
928
+ * The response body for initializing a passkey MFA flow.
929
+ */
930
+ export interface MfaPasskeyInitResponseBody {
931
+ /**
932
+ * WebAuthn authentication options as defined by the Web Authentication
933
+ * specification.
934
+ */
935
+ options: PasskeyAuthenticatorVerifyOptions;
936
+
937
+ relying_party?: string;
938
+ }
939
+
940
+ /**
941
+ * The request body for verifying a passkey MFA flow.
942
+ */
943
+ export interface MfaPasskeyVerifyRequestBody {
944
+ /**
945
+ * WebAuthn authentication response as defined by the Web Authentication
946
+ * specification.
947
+ */
948
+ authenticator_response: PasskeyAuthenticatorVerifyResponse;
949
+
950
+ relying_party?: string;
951
+ }
952
+
953
+ /**
954
+ * The request body for enrolling a SMS MFA code.
955
+ */
956
+ export interface MfaSMSEnrollRequestBody {
957
+ code: string;
958
+
959
+ phoneNumber: string;
960
+ }
961
+
1448
962
  /**
1449
963
  * Input for enrolling SMS MFA.
1450
964
  */
@@ -1454,6 +968,11 @@ export interface MfaSMSInitEnrollInput {
1454
968
  phoneNumber: string;
1455
969
  }
1456
970
 
971
+ /**
972
+ * The request body for initiating a SMS MFA flow.
973
+ */
974
+ export type MfaSMSInitRequestBody = MfaSMSInitVerifyInput | MfaSMSInitEnrollInput;
975
+
1457
976
  /**
1458
977
  * Input for verifying SMS MFA.
1459
978
  */
@@ -1462,9 +981,122 @@ export interface MfaSMSInitVerifyInput {
1462
981
  }
1463
982
 
1464
983
  /**
1465
- * The type of OAuth authorization code.
984
+ * The request body for verifying a SMS MFA code.
985
+ */
986
+ export interface MfaSMSVerifyRequestBody {
987
+ code: string;
988
+ }
989
+
990
+ /**
991
+ * The response body for initializing a TOTP MFA code.
992
+ */
993
+ export interface MfaTotpInitResponseBody {
994
+ totpAuthUrl: string;
995
+
996
+ totpSecret: string;
997
+ }
998
+
999
+ /**
1000
+ * The input for verifying a TOTP MFA code.
1001
+ */
1002
+ export interface MfaTotpInput {
1003
+ code: string;
1004
+ }
1005
+
1006
+ /**
1007
+ * The response body for verifying a MFA code.
1008
+ */
1009
+ export interface MfaVerifyResponseBody {
1010
+ token: string;
1011
+ }
1012
+
1013
+ /**
1014
+ * The request body for authenticating an OAuth account.
1015
+ */
1016
+ export interface OAuthAuthenticateRequestBody {
1017
+ authorization_code: string;
1018
+
1019
+ state_code: string;
1020
+
1021
+ /**
1022
+ * The type of OAuth authorization code.
1023
+ */
1024
+ code_type?: OAuthCodeType;
1025
+
1026
+ code_verifier?: string;
1027
+
1028
+ /**
1029
+ * Whether to allow sign-up during authentication.
1030
+ */
1031
+ mode?: AuthenticateModeOption;
1032
+ }
1033
+
1034
+ /**
1035
+ * The request body for getting an OAuth authorization code.
1036
+ */
1037
+ export interface OAuthAuthorizationCodeRequestBody {
1038
+ code_challenge: string;
1039
+
1040
+ redirect_to: string;
1041
+
1042
+ state: string;
1043
+ }
1044
+
1045
+ /**
1046
+ * The type of OAuth authorization code.
1047
+ */
1048
+ export type OAuthCodeType = 'raw';
1049
+
1050
+ /**
1051
+ * The request body for initiating an OAuth ceremony.
1052
+ */
1053
+ export interface OAuthInitRequestBody {
1054
+ /**
1055
+ * The ID of an OAuth provider.
1056
+ */
1057
+ provider: OAuthProviderID;
1058
+
1059
+ redirect_to: string;
1060
+
1061
+ token?: string;
1062
+
1063
+ code_challenge?: string;
1064
+
1065
+ state_code?: string;
1066
+ }
1067
+
1068
+ /**
1069
+ * The response for initiating an OAuth ceremony.
1070
+ */
1071
+ export interface OAuthInitResponseBody {
1072
+ url: string;
1073
+ }
1074
+
1075
+ /**
1076
+ * The request body for linking an OAuth account.
1077
+ */
1078
+ export interface OAuthLinkRequestBody {
1079
+ authorization_code: string;
1080
+
1081
+ state_code: string;
1082
+
1083
+ /**
1084
+ * The type of OAuth authorization code.
1085
+ */
1086
+ code_type?: OAuthCodeType;
1087
+
1088
+ code_verifier?: string;
1089
+ }
1090
+
1091
+ /**
1092
+ * The response for linking an OAuth account.
1466
1093
  */
1467
- export type OAuthCodeType = 'raw';
1094
+ export interface OAuthLinkResponseBody extends UsersAPI.User {
1095
+ /**
1096
+ * OAuth tokens associated with the user.
1097
+ */
1098
+ oauth_tokens?: UsersAPI.OAuthTokens;
1099
+ }
1468
1100
 
1469
1101
  /**
1470
1102
  * The ID of an OAuth provider.
@@ -1516,11 +1148,44 @@ export interface OAuthTransferUserInfoMeta {
1516
1148
  providerAppId?: string;
1517
1149
  }
1518
1150
 
1151
+ /**
1152
+ * The request body for unlinking an OAuth account.
1153
+ */
1154
+ export interface OAuthUnlinkRequestBody {
1155
+ /**
1156
+ * The ID of an OAuth provider.
1157
+ */
1158
+ provider: OAuthProviderID;
1159
+
1160
+ subject: string;
1161
+ }
1162
+
1163
+ /**
1164
+ * The request body for verifying a PRAT.
1165
+ */
1166
+ export interface OAuthVerifyRequestBody {
1167
+ prat: string;
1168
+ }
1169
+
1170
+ /**
1171
+ * The response body when verifying a PRAT.
1172
+ */
1173
+ export interface OAuthVerifyResponseBody {
1174
+ verified: boolean;
1175
+ }
1176
+
1519
1177
  /**
1520
1178
  * Valid set of onramp providers
1521
1179
  */
1522
1180
  export type OnrampProvider = 'bridge' | 'bridge-sandbox';
1523
1181
 
1182
+ /**
1183
+ * The input for refreshing a session or logging out.
1184
+ */
1185
+ export interface OptionalRefreshTokenInput {
1186
+ refresh_token?: string;
1187
+ }
1188
+
1524
1189
  /**
1525
1190
  * The authenticator assertion response from a WebAuthn authentication ceremony.
1526
1191
  */
@@ -1805,6 +1470,70 @@ export interface PasskeyVerifyExtensions {
1805
1470
  hmac_create_secret?: boolean;
1806
1471
  }
1807
1472
 
1473
+ /**
1474
+ * The request body for authenticating a passwordless account.
1475
+ */
1476
+ export interface PasswordlessAuthenticateRequestBody {
1477
+ code: string;
1478
+
1479
+ email: string;
1480
+
1481
+ /**
1482
+ * Whether to allow sign-up during authentication.
1483
+ */
1484
+ mode?: AuthenticateModeOption;
1485
+ }
1486
+
1487
+ /**
1488
+ * The request body for initiating a passwordless ceremony.
1489
+ */
1490
+ export interface PasswordlessInitRequestBody {
1491
+ email: string;
1492
+
1493
+ token?: string;
1494
+ }
1495
+
1496
+ /**
1497
+ * The request body for linking a passwordless account.
1498
+ */
1499
+ export interface PasswordlessLinkRequestBody {
1500
+ code: string;
1501
+
1502
+ email: string;
1503
+ }
1504
+
1505
+ /**
1506
+ * The request body for authenticating a passwordless sms account.
1507
+ */
1508
+ export interface PasswordlessSMSAuthenticateRequestBody {
1509
+ code: string;
1510
+
1511
+ phoneNumber: string;
1512
+
1513
+ /**
1514
+ * Whether to allow sign-up during authentication.
1515
+ */
1516
+ mode?: AuthenticateModeOption;
1517
+ }
1518
+
1519
+ /**
1520
+ * The request body for initiating a passwordless sms ceremony.
1521
+ */
1522
+ export interface PasswordlessSMSInitRequestBody {
1523
+ phoneNumber: string;
1524
+
1525
+ token?: string;
1526
+ }
1527
+
1528
+ /**
1529
+ * The request body for linking a passwordless sms account.
1530
+ */
1531
+ export interface PasswordlessSMSLinkRequestBody {
1532
+ code: string;
1533
+
1534
+ phoneNumber: string;
1535
+ }
1536
+
1808
1537
  /**
1809
1538
  * The request body for transferring a passwordless sms account.
1810
1539
  */
@@ -1814,6 +1543,24 @@ export interface PasswordlessSMSTransferRequestBody {
1814
1543
  phoneNumber: string;
1815
1544
  }
1816
1545
 
1546
+ /**
1547
+ * The request body for unlinking a passwordless sms account.
1548
+ */
1549
+ export interface PasswordlessSMSUnlinkRequestBody {
1550
+ phoneNumber: string;
1551
+ }
1552
+
1553
+ /**
1554
+ * The request body for updating a passwordless sms account.
1555
+ */
1556
+ export interface PasswordlessSMSUpdateRequestBody {
1557
+ code: string;
1558
+
1559
+ new_phone_number: string;
1560
+
1561
+ old_phone_number: string;
1562
+ }
1563
+
1817
1564
  /**
1818
1565
  * The request body for transferring a passwordless account.
1819
1566
  */
@@ -1823,6 +1570,24 @@ export interface PasswordlessTransferRequestBody {
1823
1570
  nonce: string;
1824
1571
  }
1825
1572
 
1573
+ /**
1574
+ * The request body for unlinking a passwordless account.
1575
+ */
1576
+ export interface PasswordlessUnlinkRequestBody {
1577
+ address: string;
1578
+ }
1579
+
1580
+ /**
1581
+ * The request body for updating a passwordless account.
1582
+ */
1583
+ export interface PasswordlessUpdateRequestBody {
1584
+ code: string;
1585
+
1586
+ newAddress: string;
1587
+
1588
+ oldAddress: string;
1589
+ }
1590
+
1826
1591
  /**
1827
1592
  * The ID of a Privy app as an OAuth provider. Must start with "privy:".
1828
1593
  */
@@ -1851,78 +1616,192 @@ export interface ResponsePasskeyInitLink {
1851
1616
  */
1852
1617
  options: PasskeyAuthenticatorEnrollmentOptions;
1853
1618
 
1854
- relying_party?: string;
1619
+ relying_party?: string;
1620
+ }
1621
+
1622
+ /**
1623
+ * Response for initiating a passkey registration ceremony.
1624
+ */
1625
+ export interface ResponsePasskeyInitRegister {
1626
+ /**
1627
+ * WebAuthn registration options as defined by the Web Authentication
1628
+ * specification.
1629
+ */
1630
+ options: PasskeyAuthenticatorEnrollmentOptions;
1631
+
1632
+ relying_party?: string;
1633
+ }
1634
+
1635
+ /**
1636
+ * Input containing a SIWE wallet address.
1637
+ */
1638
+ export interface SiweAddressInput {
1639
+ address: string;
1640
+ }
1641
+
1642
+ /**
1643
+ * The request body for authenticating a SIWE ceremony.
1644
+ */
1645
+ export interface SiweAuthenticateRequestBody {
1646
+ message: string;
1647
+
1648
+ signature: string;
1649
+
1650
+ chainId?: string | null;
1651
+
1652
+ connectorType?: string | null;
1653
+
1654
+ /**
1655
+ * Whether to allow sign-up during authentication.
1656
+ */
1657
+ mode?: AuthenticateModeOption;
1658
+
1659
+ walletClientType?: string | null;
1660
+ }
1661
+
1662
+ /**
1663
+ * Input for initiating a SIWE ceremony.
1664
+ */
1665
+ export interface SiweInitInput {
1666
+ token?: string;
1667
+
1668
+ address?: string;
1669
+ }
1670
+
1671
+ /**
1672
+ * The request body for initiating a SIWE ceremony.
1673
+ */
1674
+ export interface SiweInitRequestBody {
1675
+ address: string;
1676
+ }
1677
+
1678
+ /**
1679
+ * The response body for initiating a SIWE ceremony.
1680
+ */
1681
+ export interface SiweInitResponseBody {
1682
+ address: string;
1683
+
1684
+ expires_at: string;
1685
+
1686
+ nonce: string;
1687
+ }
1688
+
1689
+ /**
1690
+ * Input for a SIWE signing ceremony.
1691
+ */
1692
+ export interface SiweInput {
1693
+ message: string;
1694
+
1695
+ signature: string;
1696
+
1697
+ chainId?: string | null;
1698
+
1699
+ connectorType?: string | null;
1700
+
1701
+ walletClientType?: string | null;
1702
+ }
1703
+
1704
+ /**
1705
+ * The request body for linking a SIWE ceremony.
1706
+ */
1707
+ export interface SiweLinkRequestBody {
1708
+ message: string;
1709
+
1710
+ signature: string;
1711
+
1712
+ chainId?: string | null;
1713
+
1714
+ connectorType?: string | null;
1715
+
1716
+ walletClientType?: string | null;
1717
+ }
1718
+
1719
+ /**
1720
+ * The request body for linking a SIWE ceremony to a smart wallet.
1721
+ */
1722
+ export interface SiweLinkSmartWalletRequestBody {
1723
+ message: string;
1724
+
1725
+ signature: string;
1726
+
1727
+ /**
1728
+ * The supported smart wallet providers.
1729
+ */
1730
+ smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
1731
+
1732
+ smart_wallet_version?: string;
1855
1733
  }
1856
1734
 
1857
1735
  /**
1858
- * Response for initiating a passkey registration ceremony.
1736
+ * A SIWE nonce response.
1859
1737
  */
1860
- export interface ResponsePasskeyInitRegister {
1861
- /**
1862
- * WebAuthn registration options as defined by the Web Authentication
1863
- * specification.
1864
- */
1865
- options: PasskeyAuthenticatorEnrollmentOptions;
1738
+ export interface SiweNonce {
1739
+ address: string;
1866
1740
 
1867
- relying_party?: string;
1741
+ expires_at: string;
1742
+
1743
+ nonce: string;
1868
1744
  }
1869
1745
 
1870
1746
  /**
1871
- * Input containing a SIWE wallet address.
1747
+ * The request body for unlinking a SIWE ceremony.
1872
1748
  */
1873
- export interface SiweAddressInput {
1749
+ export interface SiweUnlinkRequestBody {
1874
1750
  address: string;
1875
1751
  }
1876
1752
 
1877
1753
  /**
1878
- * Input for initiating a SIWE ceremony.
1754
+ * Input containing a SIWS wallet address.
1879
1755
  */
1880
- export interface SiweInitInput {
1881
- token?: string;
1882
-
1883
- address?: string;
1756
+ export interface SiwsAddressInput {
1757
+ address: string;
1884
1758
  }
1885
1759
 
1886
1760
  /**
1887
- * Input for a SIWE signing ceremony.
1761
+ * The request body for authenticating a SIWS ceremony.
1888
1762
  */
1889
- export interface SiweInput {
1763
+ export interface SiwsAuthenticateRequestBody {
1890
1764
  message: string;
1891
1765
 
1892
1766
  signature: string;
1893
1767
 
1894
- chainId?: string | null;
1895
-
1896
1768
  connectorType?: string | null;
1897
1769
 
1770
+ message_type?: 'transaction' | 'plain';
1771
+
1772
+ /**
1773
+ * Whether to allow sign-up during authentication.
1774
+ */
1775
+ mode?: AuthenticateModeOption;
1776
+
1898
1777
  walletClientType?: string | null;
1899
1778
  }
1900
1779
 
1901
1780
  /**
1902
- * A SIWE nonce response.
1781
+ * Input for initiating a SIWS ceremony.
1903
1782
  */
1904
- export interface SiweNonce {
1783
+ export interface SiwsInitInput {
1905
1784
  address: string;
1906
1785
 
1907
- expires_at: string;
1908
-
1909
- nonce: string;
1786
+ token?: string;
1910
1787
  }
1911
1788
 
1912
1789
  /**
1913
- * Input containing a SIWS wallet address.
1790
+ * The request body for initiating a SIWS ceremony.
1914
1791
  */
1915
- export interface SiwsAddressInput {
1792
+ export interface SiwsInitRequestBody {
1916
1793
  address: string;
1917
1794
  }
1918
1795
 
1919
1796
  /**
1920
- * Input for initiating a SIWS ceremony.
1797
+ * The response body for initiating a SIWS ceremony.
1921
1798
  */
1922
- export interface SiwsInitInput {
1799
+ export interface SiwsInitResponseBody {
1923
1800
  address: string;
1924
1801
 
1925
- token?: string;
1802
+ expires_at: string;
1803
+
1804
+ nonce: string;
1926
1805
  }
1927
1806
 
1928
1807
  /**
@@ -1940,6 +1819,21 @@ export interface SiwsInput {
1940
1819
  walletClientType?: string | null;
1941
1820
  }
1942
1821
 
1822
+ /**
1823
+ * The request body for linking a SIWS ceremony.
1824
+ */
1825
+ export interface SiwsLinkRequestBody {
1826
+ message: string;
1827
+
1828
+ signature: string;
1829
+
1830
+ connectorType?: string | null;
1831
+
1832
+ message_type?: 'transaction' | 'plain';
1833
+
1834
+ walletClientType?: string | null;
1835
+ }
1836
+
1943
1837
  /**
1944
1838
  * A SIWS nonce response.
1945
1839
  */
@@ -1951,6 +1845,13 @@ export interface SiwsNonce {
1951
1845
  nonce: string;
1952
1846
  }
1953
1847
 
1848
+ /**
1849
+ * The request body for unlinking a SIWS ceremony.
1850
+ */
1851
+ export interface SiwsUnlinkRequestBody {
1852
+ address: string;
1853
+ }
1854
+
1954
1855
  /**
1955
1856
  * Input for a smart wallet SIWE signing ceremony.
1956
1857
  */
@@ -2011,6 +1912,54 @@ export interface TelegramAuthenticateInput {
2011
1912
  telegram_web_app_data?: TelegramWebAppData;
2012
1913
  }
2013
1914
 
1915
+ /**
1916
+ * The request body for authenticating with Telegram.
1917
+ */
1918
+ export interface TelegramAuthenticateRequestBody {
1919
+ captcha_token?: string;
1920
+
1921
+ /**
1922
+ * Whether to allow sign-up during authentication.
1923
+ */
1924
+ mode?: AuthenticateModeOption;
1925
+
1926
+ /**
1927
+ * Auth result object returned by Telegram when a user authenticates using the
1928
+ * login widget.
1929
+ */
1930
+ telegram_auth_result?: TelegramAuthResult;
1931
+
1932
+ /**
1933
+ * Auth result object returned by Telegram when a user authenticates using a mini
1934
+ * app.
1935
+ */
1936
+ telegram_web_app_data?: TelegramWebAppData;
1937
+ }
1938
+
1939
+ /**
1940
+ * The request body for linking a Telegram account.
1941
+ */
1942
+ export interface TelegramLinkRequestBody {
1943
+ captcha_token?: string;
1944
+
1945
+ /**
1946
+ * Whether to allow sign-up during authentication.
1947
+ */
1948
+ mode?: AuthenticateModeOption;
1949
+
1950
+ /**
1951
+ * Auth result object returned by Telegram when a user authenticates using the
1952
+ * login widget.
1953
+ */
1954
+ telegram_auth_result?: TelegramAuthResult;
1955
+
1956
+ /**
1957
+ * Auth result object returned by Telegram when a user authenticates using a mini
1958
+ * app.
1959
+ */
1960
+ telegram_web_app_data?: TelegramWebAppData;
1961
+ }
1962
+
2014
1963
  /**
2015
1964
  * Input for unlinking a Telegram account.
2016
1965
  */
@@ -2018,6 +1967,13 @@ export interface TelegramUnlinkInput {
2018
1967
  telegram_user_id: string;
2019
1968
  }
2020
1969
 
1970
+ /**
1971
+ * The request body for unlinking a Telegram account.
1972
+ */
1973
+ export interface TelegramUnlinkRequestBody {
1974
+ telegram_user_id: string;
1975
+ }
1976
+
2021
1977
  /**
2022
1978
  * Auth result object returned by Telegram when a user authenticates using a mini
2023
1979
  * app.
@@ -2109,65 +2065,6 @@ export interface UnlinkPasskeyInput {
2109
2065
 
2110
2066
  export declare namespace ClientAuth {
2111
2067
  export {
2112
- type CustomJwtAuthenticateRequestBody as CustomJwtAuthenticateRequestBody,
2113
- type CustomJwtLinkRequestBody as CustomJwtLinkRequestBody,
2114
- type FarcasterAuthenticateRequestBody as FarcasterAuthenticateRequestBody,
2115
- type FarcasterConnectInitResponseBody as FarcasterConnectInitResponseBody,
2116
- type FarcasterConnectStatusCompletedResponseBody as FarcasterConnectStatusCompletedResponseBody,
2117
- type FarcasterConnectStatusPendingResponseBody as FarcasterConnectStatusPendingResponseBody,
2118
- type FarcasterInitRequestBody as FarcasterInitRequestBody,
2119
- type FarcasterLinkRequestBody as FarcasterLinkRequestBody,
2120
- type FarcasterSignerInitRequestBody as FarcasterSignerInitRequestBody,
2121
- type FarcasterSignerInitResponseBody as FarcasterSignerInitResponseBody,
2122
- type FarcasterSignerStatusResponseBody as FarcasterSignerStatusResponseBody,
2123
- type FarcasterUnlinkRequestBody as FarcasterUnlinkRequestBody,
2124
- type FarcasterV2AuthenticateRequestBody as FarcasterV2AuthenticateRequestBody,
2125
- type FarcasterV2InitResponseBody as FarcasterV2InitResponseBody,
2126
- type GuestAuthenticateRequestBody as GuestAuthenticateRequestBody,
2127
- type MfaPasskeyEnrollmentRequestBody as MfaPasskeyEnrollmentRequestBody,
2128
- type MfaPasskeyInitRequestBody as MfaPasskeyInitRequestBody,
2129
- type MfaPasskeyInitResponseBody as MfaPasskeyInitResponseBody,
2130
- type MfaPasskeyVerifyRequestBody as MfaPasskeyVerifyRequestBody,
2131
- type MfaSMSEnrollRequestBody as MfaSMSEnrollRequestBody,
2132
- type MfaSMSInitRequestBody as MfaSMSInitRequestBody,
2133
- type MfaSMSVerifyRequestBody as MfaSMSVerifyRequestBody,
2134
- type MfaTotpInitResponseBody as MfaTotpInitResponseBody,
2135
- type MfaTotpInput as MfaTotpInput,
2136
- type MfaVerifyResponseBody as MfaVerifyResponseBody,
2137
- type OAuthAuthenticateRequestBody as OAuthAuthenticateRequestBody,
2138
- type OAuthAuthorizationCodeRequestBody as OAuthAuthorizationCodeRequestBody,
2139
- type OAuthInitRequestBody as OAuthInitRequestBody,
2140
- type OAuthInitResponseBody as OAuthInitResponseBody,
2141
- type OAuthLinkRequestBody as OAuthLinkRequestBody,
2142
- type OAuthLinkResponseBody as OAuthLinkResponseBody,
2143
- type OAuthUnlinkRequestBody as OAuthUnlinkRequestBody,
2144
- type OAuthVerifyRequestBody as OAuthVerifyRequestBody,
2145
- type OAuthVerifyResponseBody as OAuthVerifyResponseBody,
2146
- type OptionalRefreshTokenInput as OptionalRefreshTokenInput,
2147
- type PasswordlessAuthenticateRequestBody as PasswordlessAuthenticateRequestBody,
2148
- type PasswordlessInitRequestBody as PasswordlessInitRequestBody,
2149
- type PasswordlessLinkRequestBody as PasswordlessLinkRequestBody,
2150
- type PasswordlessSMSAuthenticateRequestBody as PasswordlessSMSAuthenticateRequestBody,
2151
- type PasswordlessSMSInitRequestBody as PasswordlessSMSInitRequestBody,
2152
- type PasswordlessSMSLinkRequestBody as PasswordlessSMSLinkRequestBody,
2153
- type PasswordlessSMSUnlinkRequestBody as PasswordlessSMSUnlinkRequestBody,
2154
- type PasswordlessSMSUpdateRequestBody as PasswordlessSMSUpdateRequestBody,
2155
- type PasswordlessUnlinkRequestBody as PasswordlessUnlinkRequestBody,
2156
- type PasswordlessUpdateRequestBody as PasswordlessUpdateRequestBody,
2157
- type SiweAuthenticateRequestBody as SiweAuthenticateRequestBody,
2158
- type SiweInitRequestBody as SiweInitRequestBody,
2159
- type SiweInitResponseBody as SiweInitResponseBody,
2160
- type SiweLinkRequestBody as SiweLinkRequestBody,
2161
- type SiweLinkSmartWalletRequestBody as SiweLinkSmartWalletRequestBody,
2162
- type SiweUnlinkRequestBody as SiweUnlinkRequestBody,
2163
- type SiwsAuthenticateRequestBody as SiwsAuthenticateRequestBody,
2164
- type SiwsInitRequestBody as SiwsInitRequestBody,
2165
- type SiwsInitResponseBody as SiwsInitResponseBody,
2166
- type SiwsLinkRequestBody as SiwsLinkRequestBody,
2167
- type SiwsUnlinkRequestBody as SiwsUnlinkRequestBody,
2168
- type TelegramAuthenticateRequestBody as TelegramAuthenticateRequestBody,
2169
- type TelegramLinkRequestBody as TelegramLinkRequestBody,
2170
- type TelegramUnlinkRequestBody as TelegramUnlinkRequestBody,
2171
2068
  type AuthenticateJwtInput as AuthenticateJwtInput,
2172
2069
  type AuthenticateMode as AuthenticateMode,
2173
2070
  type AuthenticateModeOption as AuthenticateModeOption,
@@ -2194,23 +2091,37 @@ export declare namespace ClientAuth {
2194
2091
  type Caip2ChainID as Caip2ChainID,
2195
2092
  type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
2196
2093
  type CryptoCurrencyCode as CryptoCurrencyCode,
2094
+ type CustomJwtAuthenticateRequestBody as CustomJwtAuthenticateRequestBody,
2095
+ type CustomJwtLinkRequestBody as CustomJwtLinkRequestBody,
2197
2096
  type CustomOAuthProviderID as CustomOAuthProviderID,
2198
2097
  type ExternalOAuthProviderID as ExternalOAuthProviderID,
2199
2098
  type FarcasterAuthenticateInput as FarcasterAuthenticateInput,
2099
+ type FarcasterAuthenticateRequestBody as FarcasterAuthenticateRequestBody,
2200
2100
  type FarcasterConnectInitResponse as FarcasterConnectInitResponse,
2101
+ type FarcasterConnectInitResponseBody as FarcasterConnectInitResponseBody,
2201
2102
  type FarcasterConnectStatusCompletedResponse as FarcasterConnectStatusCompletedResponse,
2103
+ type FarcasterConnectStatusCompletedResponseBody as FarcasterConnectStatusCompletedResponseBody,
2202
2104
  type FarcasterConnectStatusPendingResponse as FarcasterConnectStatusPendingResponse,
2105
+ type FarcasterConnectStatusPendingResponseBody as FarcasterConnectStatusPendingResponseBody,
2203
2106
  type FarcasterInitInput as FarcasterInitInput,
2107
+ type FarcasterInitRequestBody as FarcasterInitRequestBody,
2204
2108
  type FarcasterLinkInput as FarcasterLinkInput,
2109
+ type FarcasterLinkRequestBody as FarcasterLinkRequestBody,
2205
2110
  type FarcasterSignerApproved as FarcasterSignerApproved,
2206
2111
  type FarcasterSignerInitPendingApproval as FarcasterSignerInitPendingApproval,
2112
+ type FarcasterSignerInitRequestBody as FarcasterSignerInitRequestBody,
2113
+ type FarcasterSignerInitResponseBody as FarcasterSignerInitResponseBody,
2207
2114
  type FarcasterSignerRevoked as FarcasterSignerRevoked,
2208
2115
  type FarcasterSignerStatusPendingApproval as FarcasterSignerStatusPendingApproval,
2116
+ type FarcasterSignerStatusResponseBody as FarcasterSignerStatusResponseBody,
2209
2117
  type FarcasterUnlinkInput as FarcasterUnlinkInput,
2118
+ type FarcasterUnlinkRequestBody as FarcasterUnlinkRequestBody,
2210
2119
  type FarcasterV2AuthenticateInput as FarcasterV2AuthenticateInput,
2120
+ type FarcasterV2AuthenticateRequestBody as FarcasterV2AuthenticateRequestBody,
2211
2121
  type FarcasterV2InitInput as FarcasterV2InitInput,
2212
2122
  type FarcasterV2InitRequestBody as FarcasterV2InitRequestBody,
2213
2123
  type FarcasterV2InitResponse as FarcasterV2InitResponse,
2124
+ type FarcasterV2InitResponseBody as FarcasterV2InitResponseBody,
2214
2125
  type FiatAmount as FiatAmount,
2215
2126
  type FiatCurrencyCode as FiatCurrencyCode,
2216
2127
  type FiatCustomerResponse as FiatCustomerResponse,
@@ -2230,15 +2141,36 @@ export declare namespace ClientAuth {
2230
2141
  type GetFiatOnrampTransactionStatusResponse as GetFiatOnrampTransactionStatusResponse,
2231
2142
  type GetFiatOnrampURLInput as GetFiatOnrampURLInput,
2232
2143
  type GetFiatOnrampURLResponse as GetFiatOnrampURLResponse,
2144
+ type GuestAuthenticateRequestBody as GuestAuthenticateRequestBody,
2233
2145
  type LinkJwtInput as LinkJwtInput,
2146
+ type MfaPasskeyEnrollmentRequestBody as MfaPasskeyEnrollmentRequestBody,
2147
+ type MfaPasskeyInitRequestBody as MfaPasskeyInitRequestBody,
2148
+ type MfaPasskeyInitResponseBody as MfaPasskeyInitResponseBody,
2149
+ type MfaPasskeyVerifyRequestBody as MfaPasskeyVerifyRequestBody,
2150
+ type MfaSMSEnrollRequestBody as MfaSMSEnrollRequestBody,
2234
2151
  type MfaSMSInitEnrollInput as MfaSMSInitEnrollInput,
2152
+ type MfaSMSInitRequestBody as MfaSMSInitRequestBody,
2235
2153
  type MfaSMSInitVerifyInput as MfaSMSInitVerifyInput,
2154
+ type MfaSMSVerifyRequestBody as MfaSMSVerifyRequestBody,
2155
+ type MfaTotpInitResponseBody as MfaTotpInitResponseBody,
2156
+ type MfaTotpInput as MfaTotpInput,
2157
+ type MfaVerifyResponseBody as MfaVerifyResponseBody,
2158
+ type OAuthAuthenticateRequestBody as OAuthAuthenticateRequestBody,
2159
+ type OAuthAuthorizationCodeRequestBody as OAuthAuthorizationCodeRequestBody,
2236
2160
  type OAuthCodeType as OAuthCodeType,
2161
+ type OAuthInitRequestBody as OAuthInitRequestBody,
2162
+ type OAuthInitResponseBody as OAuthInitResponseBody,
2163
+ type OAuthLinkRequestBody as OAuthLinkRequestBody,
2164
+ type OAuthLinkResponseBody as OAuthLinkResponseBody,
2237
2165
  type OAuthProviderID as OAuthProviderID,
2238
2166
  type OAuthTransferRequestBody as OAuthTransferRequestBody,
2239
2167
  type OAuthTransferUserInfo as OAuthTransferUserInfo,
2240
2168
  type OAuthTransferUserInfoMeta as OAuthTransferUserInfoMeta,
2169
+ type OAuthUnlinkRequestBody as OAuthUnlinkRequestBody,
2170
+ type OAuthVerifyRequestBody as OAuthVerifyRequestBody,
2171
+ type OAuthVerifyResponseBody as OAuthVerifyResponseBody,
2241
2172
  type OnrampProvider as OnrampProvider,
2173
+ type OptionalRefreshTokenInput as OptionalRefreshTokenInput,
2242
2174
  type PasskeyAssertionResponse as PasskeyAssertionResponse,
2243
2175
  type PasskeyAttestationResponse as PasskeyAttestationResponse,
2244
2176
  type PasskeyAuthenticateInput as PasskeyAuthenticateInput,
@@ -2258,24 +2190,48 @@ export declare namespace ClientAuth {
2258
2190
  type PasskeyRelyingParty as PasskeyRelyingParty,
2259
2191
  type PasskeyUser as PasskeyUser,
2260
2192
  type PasskeyVerifyExtensions as PasskeyVerifyExtensions,
2193
+ type PasswordlessAuthenticateRequestBody as PasswordlessAuthenticateRequestBody,
2194
+ type PasswordlessInitRequestBody as PasswordlessInitRequestBody,
2195
+ type PasswordlessLinkRequestBody as PasswordlessLinkRequestBody,
2196
+ type PasswordlessSMSAuthenticateRequestBody as PasswordlessSMSAuthenticateRequestBody,
2197
+ type PasswordlessSMSInitRequestBody as PasswordlessSMSInitRequestBody,
2198
+ type PasswordlessSMSLinkRequestBody as PasswordlessSMSLinkRequestBody,
2261
2199
  type PasswordlessSMSTransferRequestBody as PasswordlessSMSTransferRequestBody,
2200
+ type PasswordlessSMSUnlinkRequestBody as PasswordlessSMSUnlinkRequestBody,
2201
+ type PasswordlessSMSUpdateRequestBody as PasswordlessSMSUpdateRequestBody,
2262
2202
  type PasswordlessTransferRequestBody as PasswordlessTransferRequestBody,
2203
+ type PasswordlessUnlinkRequestBody as PasswordlessUnlinkRequestBody,
2204
+ type PasswordlessUpdateRequestBody as PasswordlessUpdateRequestBody,
2263
2205
  type PrivyOAuthProviderID as PrivyOAuthProviderID,
2264
2206
  type ResponsePasskeyInitAuthenticate as ResponsePasskeyInitAuthenticate,
2265
2207
  type ResponsePasskeyInitLink as ResponsePasskeyInitLink,
2266
2208
  type ResponsePasskeyInitRegister as ResponsePasskeyInitRegister,
2267
2209
  type SiweAddressInput as SiweAddressInput,
2210
+ type SiweAuthenticateRequestBody as SiweAuthenticateRequestBody,
2268
2211
  type SiweInitInput as SiweInitInput,
2212
+ type SiweInitRequestBody as SiweInitRequestBody,
2213
+ type SiweInitResponseBody as SiweInitResponseBody,
2269
2214
  type SiweInput as SiweInput,
2215
+ type SiweLinkRequestBody as SiweLinkRequestBody,
2216
+ type SiweLinkSmartWalletRequestBody as SiweLinkSmartWalletRequestBody,
2270
2217
  type SiweNonce as SiweNonce,
2218
+ type SiweUnlinkRequestBody as SiweUnlinkRequestBody,
2271
2219
  type SiwsAddressInput as SiwsAddressInput,
2220
+ type SiwsAuthenticateRequestBody as SiwsAuthenticateRequestBody,
2272
2221
  type SiwsInitInput as SiwsInitInput,
2222
+ type SiwsInitRequestBody as SiwsInitRequestBody,
2223
+ type SiwsInitResponseBody as SiwsInitResponseBody,
2273
2224
  type SiwsInput as SiwsInput,
2225
+ type SiwsLinkRequestBody as SiwsLinkRequestBody,
2274
2226
  type SiwsNonce as SiwsNonce,
2227
+ type SiwsUnlinkRequestBody as SiwsUnlinkRequestBody,
2275
2228
  type SmartWalletSiweInput as SmartWalletSiweInput,
2276
2229
  type TelegramAuthResult as TelegramAuthResult,
2277
2230
  type TelegramAuthenticateInput as TelegramAuthenticateInput,
2231
+ type TelegramAuthenticateRequestBody as TelegramAuthenticateRequestBody,
2232
+ type TelegramLinkRequestBody as TelegramLinkRequestBody,
2278
2233
  type TelegramUnlinkInput as TelegramUnlinkInput,
2234
+ type TelegramUnlinkRequestBody as TelegramUnlinkRequestBody,
2279
2235
  type TelegramWebAppData as TelegramWebAppData,
2280
2236
  type TransferFarcasterInput as TransferFarcasterInput,
2281
2237
  type TransferSiweInput as TransferSiweInput,