@privy-io/api-types 0.9.0 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/CHANGELOG.md +46 -0
  2. package/client.d.mts +40 -43
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +40 -43
  5. package/client.d.ts.map +1 -1
  6. package/client.js +28 -20
  7. package/client.js.map +1 -1
  8. package/client.mjs +29 -21
  9. package/client.mjs.map +1 -1
  10. package/internal/types.d.mts +6 -6
  11. package/internal/types.d.mts.map +1 -1
  12. package/internal/types.d.ts +6 -6
  13. package/internal/types.d.ts.map +1 -1
  14. package/package.json +1 -1
  15. package/resources/accounts.d.mts +128 -86
  16. package/resources/accounts.d.mts.map +1 -1
  17. package/resources/accounts.d.ts +128 -86
  18. package/resources/accounts.d.ts.map +1 -1
  19. package/resources/aggregations.d.mts +43 -43
  20. package/resources/aggregations.d.mts.map +1 -1
  21. package/resources/aggregations.d.ts +43 -43
  22. package/resources/aggregations.d.ts.map +1 -1
  23. package/resources/apps.d.mts +169 -135
  24. package/resources/apps.d.mts.map +1 -1
  25. package/resources/apps.d.ts +169 -135
  26. package/resources/apps.d.ts.map +1 -1
  27. package/resources/client-auth.d.mts +931 -947
  28. package/resources/client-auth.d.mts.map +1 -1
  29. package/resources/client-auth.d.ts +931 -947
  30. package/resources/client-auth.d.ts.map +1 -1
  31. package/resources/client-auth.js.map +1 -1
  32. package/resources/client-auth.mjs.map +1 -1
  33. package/resources/embedded-wallets.d.mts +122 -122
  34. package/resources/embedded-wallets.d.mts.map +1 -1
  35. package/resources/embedded-wallets.d.ts +122 -122
  36. package/resources/embedded-wallets.d.ts.map +1 -1
  37. package/resources/fiat.d.mts +110 -0
  38. package/resources/fiat.d.mts.map +1 -0
  39. package/resources/fiat.d.ts +110 -0
  40. package/resources/fiat.d.ts.map +1 -0
  41. package/resources/fiat.js +9 -0
  42. package/resources/fiat.js.map +1 -0
  43. package/resources/fiat.mjs +5 -0
  44. package/resources/fiat.mjs.map +1 -0
  45. package/resources/funding.d.mts +86 -86
  46. package/resources/funding.d.mts.map +1 -1
  47. package/resources/funding.d.ts +86 -86
  48. package/resources/funding.d.ts.map +1 -1
  49. package/resources/index.d.mts +20 -18
  50. package/resources/index.d.mts.map +1 -1
  51. package/resources/index.d.ts +20 -18
  52. package/resources/index.d.ts.map +1 -1
  53. package/resources/index.js +5 -1
  54. package/resources/index.js.map +1 -1
  55. package/resources/index.mjs +3 -1
  56. package/resources/index.mjs.map +1 -1
  57. package/resources/intents.d.mts +269 -265
  58. package/resources/intents.d.mts.map +1 -1
  59. package/resources/intents.d.ts +269 -265
  60. package/resources/intents.d.ts.map +1 -1
  61. package/resources/key-quorums.d.mts +15 -146
  62. package/resources/key-quorums.d.mts.map +1 -1
  63. package/resources/key-quorums.d.ts +15 -146
  64. package/resources/key-quorums.d.ts.map +1 -1
  65. package/resources/key-quorums.js +0 -92
  66. package/resources/key-quorums.js.map +1 -1
  67. package/resources/key-quorums.mjs +0 -92
  68. package/resources/key-quorums.mjs.map +1 -1
  69. package/resources/kraken-embed.d.mts +12 -20
  70. package/resources/kraken-embed.d.mts.map +1 -1
  71. package/resources/kraken-embed.d.ts +12 -20
  72. package/resources/kraken-embed.d.ts.map +1 -1
  73. package/resources/organizations.d.mts +65 -0
  74. package/resources/organizations.d.mts.map +1 -0
  75. package/resources/organizations.d.ts +65 -0
  76. package/resources/organizations.d.ts.map +1 -0
  77. package/resources/organizations.js +9 -0
  78. package/resources/organizations.js.map +1 -0
  79. package/resources/organizations.mjs +5 -0
  80. package/resources/organizations.mjs.map +1 -0
  81. package/resources/policies.d.mts +261 -553
  82. package/resources/policies.d.mts.map +1 -1
  83. package/resources/policies.d.ts +261 -553
  84. package/resources/policies.d.ts.map +1 -1
  85. package/resources/policies.js +0 -229
  86. package/resources/policies.js.map +1 -1
  87. package/resources/policies.mjs +0 -229
  88. package/resources/policies.mjs.map +1 -1
  89. package/resources/shared.d.mts +28 -28
  90. package/resources/shared.d.mts.map +1 -1
  91. package/resources/shared.d.ts +28 -28
  92. package/resources/shared.d.ts.map +1 -1
  93. package/resources/swaps.d.mts +6 -9
  94. package/resources/swaps.d.mts.map +1 -1
  95. package/resources/swaps.d.ts +6 -9
  96. package/resources/swaps.d.ts.map +1 -1
  97. package/resources/swaps.js.map +1 -1
  98. package/resources/swaps.mjs.map +1 -1
  99. package/resources/transactions.d.mts +80 -96
  100. package/resources/transactions.d.mts.map +1 -1
  101. package/resources/transactions.d.ts +80 -96
  102. package/resources/transactions.d.ts.map +1 -1
  103. package/resources/transactions.js +0 -17
  104. package/resources/transactions.js.map +1 -1
  105. package/resources/transactions.mjs +0 -17
  106. package/resources/transactions.mjs.map +1 -1
  107. package/resources/users.d.mts +480 -815
  108. package/resources/users.d.mts.map +1 -1
  109. package/resources/users.d.ts +480 -815
  110. package/resources/users.d.ts.map +1 -1
  111. package/resources/users.js +0 -272
  112. package/resources/users.js.map +1 -1
  113. package/resources/users.mjs +0 -272
  114. package/resources/users.mjs.map +1 -1
  115. package/resources/wallet-actions.d.mts +302 -145
  116. package/resources/wallet-actions.d.mts.map +1 -1
  117. package/resources/wallet-actions.d.ts +302 -145
  118. package/resources/wallet-actions.d.ts.map +1 -1
  119. package/resources/wallets/index.d.mts +1 -1
  120. package/resources/wallets/index.d.mts.map +1 -1
  121. package/resources/wallets/index.d.ts +1 -1
  122. package/resources/wallets/index.d.ts.map +1 -1
  123. package/resources/wallets/index.js.map +1 -1
  124. package/resources/wallets/index.mjs.map +1 -1
  125. package/resources/wallets/transactions.d.mts +7 -2
  126. package/resources/wallets/transactions.d.mts.map +1 -1
  127. package/resources/wallets/transactions.d.ts +7 -2
  128. package/resources/wallets/transactions.d.ts.map +1 -1
  129. package/resources/wallets/transactions.js +1 -1
  130. package/resources/wallets/transactions.mjs +1 -1
  131. package/resources/wallets/wallets.d.mts +1592 -1580
  132. package/resources/wallets/wallets.d.mts.map +1 -1
  133. package/resources/wallets/wallets.d.ts +1592 -1580
  134. package/resources/wallets/wallets.d.ts.map +1 -1
  135. package/resources/wallets/wallets.js +45 -103
  136. package/resources/wallets/wallets.js.map +1 -1
  137. package/resources/wallets/wallets.mjs +45 -103
  138. package/resources/wallets/wallets.mjs.map +1 -1
  139. package/resources/webhooks.d.mts +935 -877
  140. package/resources/webhooks.d.mts.map +1 -1
  141. package/resources/webhooks.d.ts +935 -877
  142. package/resources/webhooks.d.ts.map +1 -1
  143. package/resources/yield.d.mts +157 -157
  144. package/resources/yield.d.mts.map +1 -1
  145. package/resources/yield.d.ts +157 -157
  146. package/resources/yield.d.ts.map +1 -1
  147. package/src/client.ts +650 -618
  148. package/src/internal/types.ts +6 -8
  149. package/src/resources/accounts.ts +157 -103
  150. package/src/resources/aggregations.ts +55 -55
  151. package/src/resources/apps.ts +221 -178
  152. package/src/resources/client-auth.ts +1271 -1315
  153. package/src/resources/embedded-wallets.ts +160 -160
  154. package/src/resources/fiat.ts +177 -0
  155. package/src/resources/funding.ts +130 -130
  156. package/src/resources/index.ts +551 -542
  157. package/src/resources/intents.ts +326 -322
  158. package/src/resources/key-quorums.ts +16 -218
  159. package/src/resources/kraken-embed.ts +14 -22
  160. package/src/resources/organizations.ts +82 -0
  161. package/src/resources/policies.ts +383 -848
  162. package/src/resources/shared.ts +34 -34
  163. package/src/resources/swaps.ts +5 -10
  164. package/src/resources/transactions.ts +116 -136
  165. package/src/resources/users.ts +693 -1160
  166. package/src/resources/wallet-actions.ts +392 -185
  167. package/src/resources/wallets/index.ts +160 -156
  168. package/src/resources/wallets/transactions.ts +18 -3
  169. package/src/resources/wallets/wallets.ts +2123 -2113
  170. package/src/resources/webhooks.ts +1172 -1100
  171. package/src/resources/yield.ts +188 -188
  172. package/src/version.ts +1 -1
  173. package/version.d.mts +1 -1
  174. package/version.d.mts.map +1 -1
  175. package/version.d.ts +1 -1
  176. package/version.d.ts.map +1 -1
  177. package/version.js +1 -1
  178. package/version.js.map +1 -1
  179. package/version.mjs +1 -1
  180. package/version.mjs.map +1 -1
@@ -2,14 +2,15 @@
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
  /**
10
- * The request body for authenticating with a custom JWT.
11
+ * Input for authenticating with a custom JWT.
11
12
  */
12
- export interface CustomJwtAuthenticateRequestBody {
13
+ export interface AuthenticateJwtInput {
13
14
  token?: string;
14
15
 
15
16
  /**
@@ -19,368 +20,358 @@ export interface CustomJwtAuthenticateRequestBody {
19
20
  }
20
21
 
21
22
  /**
22
- * The request body for linking a custom JWT account.
23
+ * The authentication mode settings for the ceremony.
23
24
  */
24
- export interface CustomJwtLinkRequestBody {
25
- token?: string;
25
+ export interface AuthenticateMode {
26
+ /**
27
+ * Whether to allow sign-up during authentication.
28
+ */
29
+ mode?: AuthenticateModeOption;
26
30
  }
27
31
 
28
32
  /**
29
- * The request body for authenticating with Farcaster.
33
+ * Whether to allow sign-up during authentication.
30
34
  */
31
- export interface FarcasterAuthenticateRequestBody {
32
- channel_token: string;
33
-
34
- fid: number;
35
+ export type AuthenticateModeOption = 'no-signup' | 'login-or-sign-up';
35
36
 
37
+ /**
38
+ * Input for authenticating a SIWE ceremony.
39
+ */
40
+ export interface AuthenticateSiweInput {
36
41
  message: string;
37
42
 
38
43
  signature: string;
39
44
 
45
+ chainId?: string | null;
46
+
47
+ connectorType?: string | null;
48
+
40
49
  /**
41
50
  * Whether to allow sign-up during authentication.
42
51
  */
43
52
  mode?: AuthenticateModeOption;
44
- }
45
-
46
- /**
47
- * The response body for initiating a Farcaster connection.
48
- */
49
- export interface FarcasterConnectInitResponseBody {
50
- channel_token: string;
51
53
 
52
- connect_uri: string;
54
+ walletClientType?: string | null;
53
55
  }
54
56
 
55
57
  /**
56
- * The response body for completing a Farcaster connection.
58
+ * Input for authenticating a SIWS ceremony.
57
59
  */
58
- export interface FarcasterConnectStatusCompletedResponseBody {
59
- bio: string;
60
-
61
- display_name: string;
62
-
63
- fid: number;
64
-
60
+ export interface AuthenticateSiwsInput {
65
61
  message: string;
66
62
 
67
- nonce: string;
68
-
69
- pfp_url: string;
70
-
71
63
  signature: string;
72
64
 
73
- state: 'completed';
65
+ connectorType?: string | null;
74
66
 
75
- username: string;
76
- }
67
+ message_type?: 'transaction' | 'plain';
77
68
 
78
- /**
79
- * The response body for pending a Farcaster connection.
80
- */
81
- export interface FarcasterConnectStatusPendingResponseBody {
82
- nonce: string;
69
+ /**
70
+ * Whether to allow sign-up during authentication.
71
+ */
72
+ mode?: AuthenticateModeOption;
83
73
 
84
- state: 'pending';
74
+ walletClientType?: string | null;
85
75
  }
86
76
 
87
77
  /**
88
- * The request body for initiating a Farcaster connection.
78
+ * The deposit instructions for a virtual account.
89
79
  */
90
- export interface FarcasterInitRequestBody {
91
- token?: string;
92
-
93
- redirect_url?: string;
80
+ export interface BridgeBrlFiatVirtualAccountDepositInstructions {
81
+ account_holder_name: string;
94
82
 
95
- relying_party?: string;
96
- }
83
+ asset: 'brl';
97
84
 
98
- /**
99
- * The request body for linking a Farcaster account.
100
- */
101
- export interface FarcasterLinkRequestBody {
102
- channel_token: string;
85
+ bank_address: string;
103
86
 
104
- fid: number;
87
+ bank_name: string;
105
88
 
106
- message: string;
89
+ br_code: string;
107
90
 
108
- signature: string;
91
+ payment_rails: Array<'pix'>;
109
92
  }
110
93
 
94
+ export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
95
+
111
96
  /**
112
- * The request body for initiating a Farcaster signer connection.
97
+ * The deposit instructions for a virtual account.
113
98
  */
114
- export interface FarcasterSignerInitRequestBody {
115
- ed25519_public_key: string;
99
+ export interface BridgeEurFiatVirtualAccountDepositInstructions {
100
+ account_holder_name: string;
116
101
 
117
- deadline?: string;
118
- }
102
+ asset: 'eur';
119
103
 
120
- /**
121
- * The response body from initiating a Farcaster signer connection.
122
- */
123
- export type FarcasterSignerInitResponseBody =
124
- | FarcasterSignerInitPendingApproval
125
- | FarcasterSignerApproved
126
- | FarcasterSignerRevoked;
104
+ bank_address: string;
127
105
 
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;
106
+ bank_name: string;
135
107
 
136
- /**
137
- * The request body for unlinking a Farcaster account.
138
- */
139
- export interface FarcasterUnlinkRequestBody {
140
- fid: number;
108
+ bic: string;
109
+
110
+ iban: string;
111
+
112
+ payment_rails: Array<'sepa'>;
141
113
  }
142
114
 
143
115
  /**
144
- * The request body for authenticating a Farcaster V2 account.
116
+ * The response for getting a native onramp provider customer.
145
117
  */
146
- export interface FarcasterV2AuthenticateRequestBody {
147
- fid: number;
148
-
149
- message: string;
118
+ export interface BridgeFiatCustomerResponse {
119
+ has_accepted_terms: boolean;
150
120
 
151
- signature: string;
121
+ provider: 'bridge';
152
122
 
153
123
  /**
154
- * Whether to allow sign-up during authentication.
124
+ * Status of the KYC verification process.
155
125
  */
156
- mode?: AuthenticateModeOption;
157
- }
126
+ status: FiatAPI.OnrampKYCStatus;
158
127
 
159
- /**
160
- * The response body for initiating a Farcaster V2 connection.
161
- */
162
- export interface FarcasterV2InitResponseBody {
163
- expires_at: string;
128
+ kyc_url?: string;
164
129
 
165
- nonce: string;
130
+ rejection_reasons?: Array<BridgeFiatRejectionReason>;
166
131
  }
167
132
 
168
133
  /**
169
- * The request body for authenticating a guest.
134
+ * A rejection reason for a customer KYC verification.
170
135
  */
171
- export interface GuestAuthenticateRequestBody {
172
- guest_credential: string;
136
+ export interface BridgeFiatRejectionReason {
137
+ reason: string;
173
138
  }
174
139
 
175
140
  /**
176
- * The request body for enrolling a passkey MFA flow.
141
+ * The deposit instructions for a virtual account.
177
142
  */
178
- export interface MfaPasskeyEnrollmentRequestBody {
179
- credential_ids: Array<string>;
143
+ export type BridgeFiatVirtualAccountDepositInstructions =
144
+ | BridgeUsdFiatVirtualAccountDepositInstructions
145
+ | BridgeEurFiatVirtualAccountDepositInstructions
146
+ | BridgeMxnFiatVirtualAccountDepositInstructions
147
+ | BridgeBrlFiatVirtualAccountDepositInstructions
148
+ | BridgeGbpFiatVirtualAccountDepositInstructions;
180
149
 
181
- remove_for_login?: boolean;
150
+ export interface BridgeFiatVirtualAccountDestination {
151
+ address: string;
152
+
153
+ asset: BridgeDestinationAsset;
154
+
155
+ chain: string;
182
156
  }
183
157
 
184
158
  /**
185
- * The request body for initiating a passkey MFA flow.
159
+ * The request input for creating virtual account.
186
160
  */
187
- export interface MfaPasskeyInitRequestBody {
188
- relying_party?: string;
161
+ export interface BridgeFiatVirtualAccountRequest {
162
+ destination: BridgeFiatVirtualAccountDestination;
163
+
164
+ provider: 'bridge';
165
+
166
+ source: BridgeFiatVirtualAccountSource;
189
167
  }
190
168
 
191
169
  /**
192
- * The response body for initializing a passkey MFA flow.
170
+ * The response for creating virtual account.
193
171
  */
194
- export interface MfaPasskeyInitResponseBody {
172
+ export interface BridgeFiatVirtualAccountResponse {
195
173
  /**
196
- * WebAuthn authentication options as defined by the Web Authentication
197
- * specification.
174
+ * The deposit instructions for a virtual account.
198
175
  */
199
- options: PasskeyAuthenticatorVerifyOptions;
176
+ deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
200
177
 
201
- relying_party?: string;
178
+ destination: BridgeFiatVirtualAccountDestination;
179
+
180
+ provider: 'bridge';
181
+
182
+ status: string;
183
+ }
184
+
185
+ export interface BridgeFiatVirtualAccountSource {
186
+ asset: BridgeSourceAsset;
202
187
  }
203
188
 
204
189
  /**
205
- * The request body for verifying a passkey MFA flow.
190
+ * The deposit instructions for a virtual account.
206
191
  */
207
- export interface MfaPasskeyVerifyRequestBody {
208
- /**
209
- * WebAuthn authentication response as defined by the Web Authentication
210
- * specification.
211
- */
212
- authenticator_response: PasskeyAuthenticatorVerifyResponse;
192
+ export interface BridgeGbpFiatVirtualAccountDepositInstructions {
193
+ account_holder_name: string;
213
194
 
214
- relying_party?: string;
195
+ account_number: string;
196
+
197
+ asset: 'gbp';
198
+
199
+ bank_address: string;
200
+
201
+ bank_name: string;
202
+
203
+ payment_rails: Array<'faster_payments'>;
204
+
205
+ sort_code: string;
215
206
  }
216
207
 
217
208
  /**
218
- * The request body for enrolling a SMS MFA code.
209
+ * The deposit instructions for a virtual account.
219
210
  */
220
- export interface MfaSMSEnrollRequestBody {
221
- code: string;
211
+ export interface BridgeMxnFiatVirtualAccountDepositInstructions {
212
+ account_holder_name: string;
222
213
 
223
- phoneNumber: string;
214
+ asset: 'mxn';
215
+
216
+ bank_address: string;
217
+
218
+ bank_name: string;
219
+
220
+ clabe: string;
221
+
222
+ payment_rails: Array<'spei'>;
224
223
  }
225
224
 
226
225
  /**
227
- * The request body for initiating a SMS MFA flow.
226
+ * Bridge provider variant — production or sandbox.
228
227
  */
229
- export type MfaSMSInitRequestBody = MfaSMSInitVerifyInput | MfaSMSInitEnrollInput;
228
+ export type BridgeOnrampProvider = 'bridge' | 'bridge-sandbox';
230
229
 
231
230
  /**
232
- * The request body for verifying a SMS MFA code.
231
+ * The response for getting a native onramp provider customer.
233
232
  */
234
- export interface MfaSMSVerifyRequestBody {
235
- code: string;
236
- }
233
+ export interface BridgeSandboxFiatCustomerResponse {
234
+ has_accepted_terms: boolean;
237
235
 
238
- /**
239
- * The response body for initializing a TOTP MFA code.
240
- */
241
- export interface MfaTotpInitResponseBody {
242
- totpAuthUrl: string;
236
+ provider: 'bridge-sandbox';
243
237
 
244
- totpSecret: string;
245
- }
238
+ /**
239
+ * Status of the KYC verification process.
240
+ */
241
+ status: FiatAPI.OnrampKYCStatus;
246
242
 
247
- /**
248
- * The input for verifying a TOTP MFA code.
249
- */
250
- export interface MfaTotpInput {
251
- code: string;
243
+ kyc_url?: string;
244
+
245
+ rejection_reasons?: Array<BridgeFiatRejectionReason>;
252
246
  }
253
247
 
254
248
  /**
255
- * The response body for verifying a MFA code.
249
+ * The request input for creating virtual account.
256
250
  */
257
- export interface MfaVerifyResponseBody {
258
- token: string;
251
+ export interface BridgeSandboxFiatVirtualAccountRequest {
252
+ destination: BridgeFiatVirtualAccountDestination;
253
+
254
+ provider: 'bridge-sandbox';
255
+
256
+ source: BridgeFiatVirtualAccountSource;
259
257
  }
260
258
 
261
259
  /**
262
- * The request body for authenticating an OAuth account.
260
+ * The response for creating virtual account.
263
261
  */
264
- export interface OAuthAuthenticateRequestBody {
265
- authorization_code: string;
266
-
267
- state_code: string;
268
-
262
+ export interface BridgeSandboxFiatVirtualAccountResponse {
269
263
  /**
270
- * The type of OAuth authorization code.
264
+ * The deposit instructions for a virtual account.
271
265
  */
272
- code_type?: OAuthCodeType;
266
+ deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
273
267
 
274
- code_verifier?: string;
268
+ destination: BridgeFiatVirtualAccountDestination;
275
269
 
276
- /**
277
- * Whether to allow sign-up during authentication.
278
- */
279
- mode?: AuthenticateModeOption;
270
+ provider: 'bridge-sandbox';
271
+
272
+ status: string;
280
273
  }
281
274
 
275
+ export type BridgeSourceAsset = 'usd' | 'eur' | 'mxn' | 'brl' | 'gbp';
276
+
282
277
  /**
283
- * The request body for getting an OAuth authorization code.
278
+ * The deposit instructions for a virtual account.
284
279
  */
285
- export interface OAuthAuthorizationCodeRequestBody {
286
- code_challenge: string;
280
+ export interface BridgeUsdFiatVirtualAccountDepositInstructions {
281
+ asset: 'usd';
287
282
 
288
- redirect_to: string;
283
+ bank_account_number: string;
289
284
 
290
- state: string;
291
- }
285
+ bank_address: string;
292
286
 
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;
287
+ bank_beneficiary_address: string;
301
288
 
302
- redirect_to: string;
289
+ bank_beneficiary_name: string;
303
290
 
304
- token?: string;
291
+ bank_name: string;
305
292
 
306
- code_challenge?: string;
293
+ bank_routing_number: string;
307
294
 
308
- state_code?: string;
295
+ payment_rails: Array<'ach_push' | 'wire'>;
309
296
  }
310
297
 
311
298
  /**
312
- * The response for initiating an OAuth ceremony.
299
+ * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
300
+ * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
313
301
  */
314
- export interface OAuthInitResponseBody {
315
- url: string;
316
- }
302
+ export type Caip2ChainID = string;
317
303
 
318
304
  /**
319
- * The request body for linking an OAuth account.
305
+ * The request input for creating (or updating) a native onramp provider customer.
320
306
  */
321
- export interface OAuthLinkRequestBody {
322
- authorization_code: string;
323
-
324
- state_code: string;
307
+ export interface CreateOrUpdateFiatCustomerRequestInput {
308
+ has_accepted_terms: boolean;
325
309
 
326
310
  /**
327
- * The type of OAuth authorization code.
311
+ * Valid set of onramp providers
328
312
  */
329
- code_type?: OAuthCodeType;
313
+ provider: OnrampProvider;
330
314
 
331
- code_verifier?: string;
315
+ kyc_redirect_url?: string;
332
316
  }
333
317
 
334
318
  /**
335
- * The response for linking an OAuth account.
319
+ * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
336
320
  */
337
- export interface OAuthLinkResponseBody extends UsersAPI.User {
338
- /**
339
- * OAuth tokens associated with the user.
340
- */
341
- oauth_tokens?: UsersAPI.OAuthTokens;
342
- }
321
+ export type CryptoCurrencyCode = string;
343
322
 
344
323
  /**
345
- * The request body for unlinking an OAuth account.
324
+ * The request body for authenticating with a custom JWT.
346
325
  */
347
- export interface OAuthUnlinkRequestBody {
326
+ export interface CustomJwtAuthenticateRequestBody {
327
+ token?: string;
328
+
348
329
  /**
349
- * The ID of an OAuth provider.
330
+ * Whether to allow sign-up during authentication.
350
331
  */
351
- provider: OAuthProviderID;
352
-
353
- subject: string;
332
+ mode?: AuthenticateModeOption;
354
333
  }
355
334
 
356
335
  /**
357
- * The request body for verifying a PRAT.
336
+ * The request body for linking a custom JWT account.
358
337
  */
359
- export interface OAuthVerifyRequestBody {
360
- prat: string;
338
+ export interface CustomJwtLinkRequestBody {
339
+ token?: string;
361
340
  }
362
341
 
363
342
  /**
364
- * The response body when verifying a PRAT.
343
+ * The ID of a custom OAuth provider, set up for this app. Must start with
344
+ * "custom:".
365
345
  */
366
- export interface OAuthVerifyResponseBody {
367
- verified: boolean;
368
- }
346
+ export type CustomOAuthProviderID = `custom:${string}`;
369
347
 
370
348
  /**
371
- * The input for refreshing a session or logging out.
349
+ * The ID of an external OAuth provider.
372
350
  */
373
- export interface OptionalRefreshTokenInput {
374
- refresh_token?: string;
375
- }
351
+ export type ExternalOAuthProviderID =
352
+ | 'google'
353
+ | 'discord'
354
+ | 'twitter'
355
+ | 'github'
356
+ | 'spotify'
357
+ | 'instagram'
358
+ | 'tiktok'
359
+ | 'linkedin'
360
+ | 'apple'
361
+ | 'line'
362
+ | 'twitch';
376
363
 
377
364
  /**
378
- * The request body for authenticating a passwordless account.
365
+ * Input for authenticating with Farcaster.
379
366
  */
380
- export interface PasswordlessAuthenticateRequestBody {
381
- code: string;
367
+ export interface FarcasterAuthenticateInput {
368
+ channel_token: string;
382
369
 
383
- email: string;
370
+ fid: number;
371
+
372
+ message: string;
373
+
374
+ signature: string;
384
375
 
385
376
  /**
386
377
  * Whether to allow sign-up during authentication.
@@ -389,30 +380,16 @@ export interface PasswordlessAuthenticateRequestBody {
389
380
  }
390
381
 
391
382
  /**
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.
383
+ * The request body for authenticating with Farcaster.
402
384
  */
403
- export interface PasswordlessLinkRequestBody {
404
- code: string;
385
+ export interface FarcasterAuthenticateRequestBody {
386
+ channel_token: string;
405
387
 
406
- email: string;
407
- }
388
+ fid: number;
408
389
 
409
- /**
410
- * The request body for authenticating a passwordless sms account.
411
- */
412
- export interface PasswordlessSMSAuthenticateRequestBody {
413
- code: string;
390
+ message: string;
414
391
 
415
- phoneNumber: string;
392
+ signature: string;
416
393
 
417
394
  /**
418
395
  * Whether to allow sign-up during authentication.
@@ -421,615 +398,536 @@ export interface PasswordlessSMSAuthenticateRequestBody {
421
398
  }
422
399
 
423
400
  /**
424
- * The request body for initiating a passwordless sms ceremony.
401
+ * Proxy for the Farcaster Connect init response as defined in FIP-11.
425
402
  */
426
- export interface PasswordlessSMSInitRequestBody {
427
- phoneNumber: string;
403
+ export interface FarcasterConnectInitResponse {
404
+ channel_token: string;
428
405
 
429
- token?: string;
406
+ connect_uri: string;
430
407
  }
431
408
 
432
409
  /**
433
- * The request body for linking a passwordless sms account.
410
+ * The response body for initiating a Farcaster connection.
434
411
  */
435
- export interface PasswordlessSMSLinkRequestBody {
436
- code: string;
412
+ export interface FarcasterConnectInitResponseBody {
413
+ channel_token: string;
437
414
 
438
- phoneNumber: string;
415
+ connect_uri: string;
439
416
  }
440
417
 
441
418
  /**
442
- * The request body for unlinking a passwordless sms account.
419
+ * Proxy for the Farcaster Connect completed status response as defined in FIP-11.
443
420
  */
444
- export interface PasswordlessSMSUnlinkRequestBody {
445
- phoneNumber: string;
446
- }
421
+ export interface FarcasterConnectStatusCompletedResponse {
422
+ bio: string;
447
423
 
448
- /**
449
- * The request body for updating a passwordless sms account.
450
- */
451
- export interface PasswordlessSMSUpdateRequestBody {
452
- code: string;
424
+ display_name: string;
453
425
 
454
- new_phone_number: string;
426
+ fid: number;
455
427
 
456
- old_phone_number: string;
457
- }
428
+ message: string;
458
429
 
459
- /**
460
- * The request body for unlinking a passwordless account.
461
- */
462
- export interface PasswordlessUnlinkRequestBody {
463
- address: string;
464
- }
430
+ nonce: string;
465
431
 
466
- /**
467
- * The request body for updating a passwordless account.
468
- */
469
- export interface PasswordlessUpdateRequestBody {
470
- code: string;
432
+ pfp_url: string;
471
433
 
472
- newAddress: string;
434
+ signature: string;
473
435
 
474
- oldAddress: string;
436
+ state: 'completed';
437
+
438
+ username: string;
475
439
  }
476
440
 
477
441
  /**
478
- * The request body for authenticating a SIWE ceremony.
442
+ * The response body for completing a Farcaster connection.
479
443
  */
480
- export interface SiweAuthenticateRequestBody {
444
+ export interface FarcasterConnectStatusCompletedResponseBody {
445
+ bio: string;
446
+
447
+ display_name: string;
448
+
449
+ fid: number;
450
+
481
451
  message: string;
482
452
 
453
+ nonce: string;
454
+
455
+ pfp_url: string;
456
+
483
457
  signature: string;
484
458
 
485
- chainId?: string | null;
459
+ state: 'completed';
486
460
 
487
- connectorType?: string | null;
461
+ username: string;
462
+ }
488
463
 
489
- /**
490
- * Whether to allow sign-up during authentication.
491
- */
492
- mode?: AuthenticateModeOption;
464
+ /**
465
+ * Proxy for the Farcaster Connect pending status response as defined in FIP-11.
466
+ */
467
+ export interface FarcasterConnectStatusPendingResponse {
468
+ nonce: string;
493
469
 
494
- walletClientType?: string | null;
470
+ state: 'pending';
495
471
  }
496
472
 
497
473
  /**
498
- * The request body for initiating a SIWE ceremony.
474
+ * The response body for pending a Farcaster connection.
499
475
  */
500
- export interface SiweInitRequestBody {
501
- address: string;
476
+ export interface FarcasterConnectStatusPendingResponseBody {
477
+ nonce: string;
478
+
479
+ state: 'pending';
502
480
  }
503
481
 
504
482
  /**
505
- * The response body for initiating a SIWE ceremony.
483
+ * Input for initiating a Farcaster connection.
506
484
  */
507
- export interface SiweInitResponseBody {
508
- address: string;
485
+ export interface FarcasterInitInput {
486
+ token?: string;
509
487
 
510
- expires_at: string;
488
+ redirect_url?: string;
511
489
 
512
- nonce: string;
490
+ relying_party?: string;
513
491
  }
514
492
 
515
493
  /**
516
- * The request body for linking a SIWE ceremony.
494
+ * The request body for initiating a Farcaster connection.
517
495
  */
518
- export interface SiweLinkRequestBody {
519
- message: string;
520
-
521
- signature: string;
522
-
523
- chainId?: string | null;
496
+ export interface FarcasterInitRequestBody {
497
+ token?: string;
524
498
 
525
- connectorType?: string | null;
499
+ redirect_url?: string;
526
500
 
527
- walletClientType?: string | null;
501
+ relying_party?: string;
528
502
  }
529
503
 
530
504
  /**
531
- * The request body for linking a SIWE ceremony to a smart wallet.
505
+ * Input for linking a Farcaster account.
532
506
  */
533
- export interface SiweLinkSmartWalletRequestBody {
534
- message: string;
507
+ export interface FarcasterLinkInput {
508
+ channel_token: string;
535
509
 
536
- signature: string;
510
+ fid: number;
537
511
 
538
- /**
539
- * The supported smart wallet providers.
540
- */
541
- smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
512
+ message: string;
542
513
 
543
- smart_wallet_version?: string;
514
+ signature: string;
544
515
  }
545
516
 
546
517
  /**
547
- * The request body for unlinking a SIWE ceremony.
518
+ * The request body for linking a Farcaster account.
548
519
  */
549
- export interface SiweUnlinkRequestBody {
550
- address: string;
520
+ export interface FarcasterLinkRequestBody {
521
+ channel_token: string;
522
+
523
+ fid: number;
524
+
525
+ message: string;
526
+
527
+ signature: string;
551
528
  }
552
529
 
553
530
  /**
554
- * The request body for authenticating a SIWS ceremony.
531
+ * A Farcaster signer response when the signer has been approved.
555
532
  */
556
- export interface SiwsAuthenticateRequestBody {
557
- message: string;
533
+ export interface FarcasterSignerApproved {
534
+ fid: string;
558
535
 
559
- signature: string;
536
+ public_key: string;
560
537
 
561
- connectorType?: string | null;
538
+ status: 'approved';
539
+ }
562
540
 
563
- message_type?: 'transaction' | 'plain';
541
+ /**
542
+ * A Farcaster signer init response when the signer is pending approval.
543
+ */
544
+ export interface FarcasterSignerInitPendingApproval {
545
+ public_key: string;
564
546
 
565
- /**
566
- * Whether to allow sign-up during authentication.
567
- */
568
- mode?: AuthenticateModeOption;
547
+ signer_approval_url: string;
569
548
 
570
- walletClientType?: string | null;
549
+ status: 'pending_approval';
571
550
  }
572
551
 
573
552
  /**
574
- * The request body for initiating a SIWS ceremony.
553
+ * The request body for initiating a Farcaster signer connection.
575
554
  */
576
- export interface SiwsInitRequestBody {
577
- address: string;
555
+ export interface FarcasterSignerInitRequestBody {
556
+ ed25519_public_key: string;
557
+
558
+ deadline?: string;
578
559
  }
579
560
 
580
561
  /**
581
- * The response body for initiating a SIWS ceremony.
562
+ * The response body from initiating a Farcaster signer connection.
582
563
  */
583
- export interface SiwsInitResponseBody {
584
- address: string;
564
+ export type FarcasterSignerInitResponseBody =
565
+ | FarcasterSignerInitPendingApproval
566
+ | FarcasterSignerApproved
567
+ | FarcasterSignerRevoked;
585
568
 
586
- expires_at: string;
569
+ /**
570
+ * A Farcaster signer response when the signer has been revoked.
571
+ */
572
+ export interface FarcasterSignerRevoked {
573
+ fid: string;
587
574
 
588
- nonce: string;
575
+ public_key: string;
576
+
577
+ status: 'revoked';
589
578
  }
590
579
 
591
580
  /**
592
- * The request body for linking a SIWS ceremony.
581
+ * A Farcaster signer status response when the signer is pending approval.
593
582
  */
594
- export interface SiwsLinkRequestBody {
595
- message: string;
596
-
597
- signature: string;
583
+ export interface FarcasterSignerStatusPendingApproval {
584
+ public_key: string;
598
585
 
599
- connectorType?: string | null;
586
+ status: 'pending_approval';
587
+ }
600
588
 
601
- message_type?: 'transaction' | 'plain';
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;
602
596
 
603
- walletClientType?: string | null;
597
+ /**
598
+ * Input for unlinking a Farcaster account.
599
+ */
600
+ export interface FarcasterUnlinkInput {
601
+ fid: number;
604
602
  }
605
603
 
606
604
  /**
607
- * The request body for unlinking a SIWS ceremony.
605
+ * The request body for unlinking a Farcaster account.
608
606
  */
609
- export interface SiwsUnlinkRequestBody {
610
- address: string;
607
+ export interface FarcasterUnlinkRequestBody {
608
+ fid: number;
611
609
  }
612
610
 
613
611
  /**
614
- * The request body for authenticating with Telegram.
612
+ * Input for authenticating a Farcaster V2 account.
615
613
  */
616
- export interface TelegramAuthenticateRequestBody {
617
- captcha_token?: string;
614
+ export interface FarcasterV2AuthenticateInput {
615
+ fid: number;
618
616
 
619
- /**
620
- * Whether to allow sign-up during authentication.
621
- */
622
- mode?: AuthenticateModeOption;
617
+ message: string;
623
618
 
624
- /**
625
- * Auth result object returned by Telegram when a user authenticates using the
626
- * login widget.
627
- */
628
- telegram_auth_result?: TelegramAuthResult;
619
+ signature: string;
629
620
 
630
621
  /**
631
- * Auth result object returned by Telegram when a user authenticates using a mini
632
- * app.
622
+ * Whether to allow sign-up during authentication.
633
623
  */
634
- telegram_web_app_data?: TelegramWebAppData;
624
+ mode?: AuthenticateModeOption;
635
625
  }
636
626
 
637
627
  /**
638
- * The request body for linking a Telegram account.
628
+ * The request body for authenticating a Farcaster V2 account.
639
629
  */
640
- export interface TelegramLinkRequestBody {
641
- captcha_token?: string;
630
+ export interface FarcasterV2AuthenticateRequestBody {
631
+ fid: number;
642
632
 
643
- /**
644
- * Whether to allow sign-up during authentication.
645
- */
646
- mode?: AuthenticateModeOption;
633
+ message: string;
647
634
 
648
- /**
649
- * Auth result object returned by Telegram when a user authenticates using the
650
- * login widget.
651
- */
652
- telegram_auth_result?: TelegramAuthResult;
635
+ signature: string;
653
636
 
654
637
  /**
655
- * Auth result object returned by Telegram when a user authenticates using a mini
656
- * app.
638
+ * Whether to allow sign-up during authentication.
657
639
  */
658
- telegram_web_app_data?: TelegramWebAppData;
640
+ mode?: AuthenticateModeOption;
659
641
  }
660
642
 
661
643
  /**
662
- * The request body for unlinking a Telegram account.
644
+ * Input for initiating a Farcaster V2 connection.
663
645
  */
664
- export interface TelegramUnlinkRequestBody {
665
- telegram_user_id: string;
666
- }
646
+ export interface FarcasterV2InitInput {}
667
647
 
668
648
  /**
669
- * Whether to allow sign-up during authentication.
649
+ * The request body for initiating a Farcaster V2 connection.
670
650
  */
671
- export type AuthenticateModeOption = 'no-signup' | 'login-or-sign-up';
651
+ export interface FarcasterV2InitRequestBody {}
672
652
 
673
653
  /**
674
- * The authentication mode settings for the ceremony.
654
+ * Response for initiating a Farcaster V2 connection.
675
655
  */
676
- export interface AuthenticateMode {
677
- /**
678
- * Whether to allow sign-up during authentication.
679
- */
680
- mode?: AuthenticateModeOption;
656
+ export interface FarcasterV2InitResponse {
657
+ expires_at: string;
658
+
659
+ nonce: string;
681
660
  }
682
661
 
683
662
  /**
684
- * The ID of an external OAuth provider.
663
+ * The response body for initiating a Farcaster V2 connection.
685
664
  */
686
- export type ExternalOAuthProviderID =
687
- | 'google'
688
- | 'discord'
689
- | 'twitter'
690
- | 'github'
691
- | 'spotify'
692
- | 'instagram'
693
- | 'tiktok'
694
- | 'linkedin'
695
- | 'apple'
696
- | 'line'
697
- | 'twitch';
665
+ export interface FarcasterV2InitResponseBody {
666
+ expires_at: string;
698
667
 
699
- /**
700
- * The ID of a Privy app as an OAuth provider. Must start with "privy:".
701
- */
702
- export type PrivyOAuthProviderID = `privy:${string}`;
668
+ nonce: string;
669
+ }
703
670
 
704
671
  /**
705
- * The ID of a custom OAuth provider, set up for this app. Must start with
706
- * "custom:".
672
+ * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
707
673
  */
708
- export type CustomOAuthProviderID = `custom:${string}`;
674
+ export type FiatAmount = string;
709
675
 
710
676
  /**
711
- * The ID of an OAuth provider.
677
+ * ISO 4217 fiat currency code. Three uppercase ASCII letters.
712
678
  */
713
- export type OAuthProviderID = ExternalOAuthProviderID | PrivyOAuthProviderID | CustomOAuthProviderID;
679
+ export type FiatCurrencyCode = string;
714
680
 
715
681
  /**
716
- * Bridge provider variant — production or sandbox.
682
+ * The response for getting a native onramp provider customer.
717
683
  */
718
- export type BridgeOnrampProvider = 'bridge' | 'bridge-sandbox';
684
+ export type FiatCustomerResponse = BridgeFiatCustomerResponse | BridgeSandboxFiatCustomerResponse;
719
685
 
720
686
  /**
721
- * Valid set of onramp providers
687
+ * Destination cryptocurrency details for a fiat onramp quote request.
722
688
  */
723
- export type OnrampProvider = 'bridge' | 'bridge-sandbox';
724
-
725
- /**
726
- * The result of the WebAuthn credProps extension.
727
- */
728
- export interface PasskeyCredPropsResult {
729
- rk?: boolean;
730
- }
731
-
732
- /**
733
- * Client extension results returned by the WebAuthn authenticator.
734
- */
735
- export interface PasskeyClientExtensionResults {
736
- app_id?: boolean;
689
+ export interface FiatOnrampDestination {
690
+ address: string;
737
691
 
738
692
  /**
739
- * The result of the WebAuthn credProps extension.
693
+ * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
740
694
  */
741
- cred_props?: PasskeyCredPropsResult;
695
+ asset: CryptoCurrencyCode;
742
696
 
743
- hmac_create_secret?: boolean;
697
+ /**
698
+ * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
699
+ * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
700
+ */
701
+ chain: Caip2ChainID;
744
702
  }
745
703
 
746
704
  /**
747
- * A WebAuthn credential descriptor identifying a specific public key credential.
705
+ * Whether to use the sandbox or production environment for fiat onramp.
748
706
  */
749
- export interface PasskeyCredentialDescriptor {
750
- id: string;
751
-
752
- type: string;
753
-
754
- transports?: Array<string>;
755
- }
707
+ export type FiatOnrampEnvironment = 'sandbox' | 'production';
756
708
 
757
709
  /**
758
- * Relying party information for a WebAuthn ceremony.
710
+ * The fiat onramp provider to use.
759
711
  */
760
- export interface PasskeyRelyingParty {
761
- name: string;
762
-
763
- id?: string;
764
- }
712
+ export type FiatOnrampProvider =
713
+ | 'meld'
714
+ | 'meld-sandbox'
715
+ | 'moonpay'
716
+ | 'moonpay-sandbox'
717
+ | 'coinbase'
718
+ | 'coinbase-sandbox';
765
719
 
766
720
  /**
767
- * User entity for a WebAuthn registration ceremony.
721
+ * An error from a specific fiat onramp provider when fetching quotes.
768
722
  */
769
- export interface PasskeyUser {
770
- id: string;
771
-
772
- display_name: string;
723
+ export interface FiatOnrampProviderError {
724
+ error: string;
773
725
 
774
- name: string;
726
+ /**
727
+ * The fiat onramp provider to use.
728
+ */
729
+ provider: FiatOnrampProvider;
775
730
  }
776
731
 
777
732
  /**
778
- * A public key credential parameter specifying the algorithm and credential type.
733
+ * A single fiat onramp quote from a provider.
779
734
  */
780
- export interface PasskeyPubKeyCredParam {
781
- alg: number;
735
+ export interface FiatOnrampQuote {
736
+ payment_method: string;
782
737
 
783
- type: 'public-key';
784
- }
738
+ /**
739
+ * The fiat onramp provider to use.
740
+ */
741
+ provider: FiatOnrampProvider;
785
742
 
786
- /**
787
- * Authenticator selection criteria for a WebAuthn registration ceremony.
788
- */
789
- export interface PasskeyAuthenticatorSelection {
790
- authenticator_attachment?: string;
743
+ destination_currency_code?: string | null;
791
744
 
792
- require_resident_key?: boolean;
745
+ source_amount?: number | null;
793
746
 
794
- resident_key?: string;
747
+ source_currency_code?: string | null;
795
748
 
796
- user_verification?: string;
749
+ sub_provider?: string | null;
797
750
  }
798
751
 
799
752
  /**
800
- * Extensions for a WebAuthn registration ceremony.
753
+ * Source currency details for a fiat onramp quote request.
801
754
  */
802
- export interface PasskeyEnrollmentExtensions {
803
- app_id?: string;
804
-
755
+ export interface FiatOnrampSource {
805
756
  /**
806
- * The result of the WebAuthn credProps extension.
757
+ * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
807
758
  */
808
- cred_props?: PasskeyCredPropsResult;
759
+ amount: FiatAmount;
809
760
 
810
- hmac_create_secret?: boolean;
761
+ /**
762
+ * ISO 4217 fiat currency code. Three uppercase ASCII letters.
763
+ */
764
+ asset: FiatCurrencyCode;
811
765
  }
812
766
 
813
767
  /**
814
- * The authenticator attestation response from a WebAuthn registration ceremony.
768
+ * Normalized fiat onramp transaction status.
815
769
  */
816
- export interface PasskeyAttestationResponse {
817
- attestation_object: string;
818
-
819
- client_data_json: string;
820
-
821
- authenticator_data?: string;
822
-
823
- public_key?: string;
824
-
825
- public_key_algorithm?: number;
826
-
827
- transports?: Array<unknown>;
828
- }
770
+ export type FiatOnrampTransactionStatus =
771
+ | 'pending'
772
+ | 'processing'
773
+ | 'completed'
774
+ | 'failed'
775
+ | 'cancelled'
776
+ | 'refunded'
777
+ | 'unknown';
829
778
 
830
779
  /**
831
- * WebAuthn registration options as defined by the Web Authentication
832
- * specification.
780
+ * The request input for creating virtual account.
833
781
  */
834
- export interface PasskeyAuthenticatorEnrollmentOptions {
835
- challenge: string;
782
+ export type FiatVirtualAccountRequest =
783
+ | BridgeFiatVirtualAccountRequest
784
+ | BridgeSandboxFiatVirtualAccountRequest;
836
785
 
837
- pub_key_cred_params: Array<PasskeyPubKeyCredParam>;
786
+ /**
787
+ * The response for creating virtual account.
788
+ */
789
+ export type FiatVirtualAccountResponse =
790
+ | BridgeFiatVirtualAccountResponse
791
+ | BridgeSandboxFiatVirtualAccountResponse;
838
792
 
793
+ /**
794
+ * The request input for getting a native onramp provider customer.
795
+ */
796
+ export interface GetFiatCustomerRequestInput {
839
797
  /**
840
- * Relying party information for a WebAuthn ceremony.
798
+ * Valid set of onramp providers
841
799
  */
842
- rp: PasskeyRelyingParty;
800
+ provider: OnrampProvider;
801
+
802
+ kyc_redirect_url?: string;
803
+ }
843
804
 
805
+ /**
806
+ * The request input for getting fiat onramp quotes.
807
+ */
808
+ export interface GetFiatOnrampQuotesInput {
844
809
  /**
845
- * User entity for a WebAuthn registration ceremony.
810
+ * Destination cryptocurrency details for a fiat onramp quote request.
846
811
  */
847
- user: PasskeyUser;
848
-
849
- attestation?: string;
812
+ destination: FiatOnrampDestination;
850
813
 
851
814
  /**
852
- * Authenticator selection criteria for a WebAuthn registration ceremony.
815
+ * Whether to use the sandbox or production environment for fiat onramp.
853
816
  */
854
- authenticator_selection?: PasskeyAuthenticatorSelection;
855
-
856
- exclude_credentials?: Array<PasskeyCredentialDescriptor>;
817
+ environment: FiatOnrampEnvironment;
857
818
 
858
819
  /**
859
- * Extensions for a WebAuthn registration ceremony.
820
+ * Source currency details for a fiat onramp quote request.
860
821
  */
861
- extensions?: PasskeyEnrollmentExtensions;
862
-
863
- timeout?: number;
822
+ source: FiatOnrampSource;
864
823
  }
865
824
 
866
825
  /**
867
- * WebAuthn registration response as defined by the Web Authentication
868
- * specification.
826
+ * The response containing fiat onramp quotes.
869
827
  */
870
- export interface PasskeyAuthenticatorEnrollmentResponse {
871
- id: string;
872
-
873
- /**
874
- * Client extension results returned by the WebAuthn authenticator.
875
- */
876
- client_extension_results: PasskeyClientExtensionResults;
877
-
878
- raw_id: string;
879
-
880
- /**
881
- * The authenticator attestation response from a WebAuthn registration ceremony.
882
- */
883
- response: PasskeyAttestationResponse;
884
-
885
- type: 'public-key';
828
+ export interface GetFiatOnrampQuotesResponse {
829
+ quotes: Array<FiatOnrampQuote>;
886
830
 
887
- authenticator_attachment?: string;
831
+ provider_errors?: Array<FiatOnrampProviderError>;
888
832
  }
889
833
 
890
834
  /**
891
- * Response for initiating a passkey link ceremony.
835
+ * The request input for checking a fiat onramp session status.
892
836
  */
893
- export interface ResponsePasskeyInitLink {
837
+ export interface GetFiatOnrampTransactionStatusInput {
894
838
  /**
895
- * WebAuthn registration options as defined by the Web Authentication
896
- * specification.
839
+ * The fiat onramp provider to use.
897
840
  */
898
- options: PasskeyAuthenticatorEnrollmentOptions;
841
+ provider: FiatOnrampProvider;
899
842
 
900
- relying_party?: string;
843
+ session_id: string;
901
844
  }
902
845
 
903
846
  /**
904
- * Response for initiating a passkey registration ceremony.
847
+ * The response containing the fiat onramp session status.
905
848
  */
906
- export interface ResponsePasskeyInitRegister {
849
+ export interface GetFiatOnrampTransactionStatusResponse {
850
+ raw_status: string;
851
+
852
+ session_id: string;
853
+
907
854
  /**
908
- * WebAuthn registration options as defined by the Web Authentication
909
- * specification.
855
+ * Normalized fiat onramp transaction status.
910
856
  */
911
- options: PasskeyAuthenticatorEnrollmentOptions;
857
+ status: FiatOnrampTransactionStatus;
912
858
 
913
- relying_party?: string;
859
+ transaction_id?: string;
914
860
  }
915
861
 
916
862
  /**
917
- * Input for linking a passkey credential.
863
+ * The request input for getting a fiat onramp provider session URL.
918
864
  */
919
- export interface PasskeyLinkInput {
865
+ export interface GetFiatOnrampURLInput {
920
866
  /**
921
- * WebAuthn registration response as defined by the Web Authentication
922
- * specification.
867
+ * Destination cryptocurrency details for a fiat onramp quote request.
923
868
  */
924
- authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
869
+ destination: FiatOnrampDestination;
925
870
 
926
- relying_party?: string;
927
- }
871
+ payment_method: string;
928
872
 
929
- /**
930
- * Input for registering a passkey credential.
931
- */
932
- export interface PasskeyRegisterInput {
933
873
  /**
934
- * WebAuthn registration response as defined by the Web Authentication
935
- * specification.
874
+ * The fiat onramp provider to use.
936
875
  */
937
- authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
876
+ provider: FiatOnrampProvider;
938
877
 
939
- relying_party?: string;
878
+ /**
879
+ * Source currency details for a fiat onramp quote request.
880
+ */
881
+ source: FiatOnrampSource;
882
+
883
+ redirect_url?: string;
884
+
885
+ sub_provider?: string;
940
886
  }
941
887
 
942
888
  /**
943
- * Input for initiating a passkey ceremony.
889
+ * The response containing a fiat onramp provider session URL.
944
890
  */
945
- export interface PasskeyInitInput {
946
- token?: string;
891
+ export interface GetFiatOnrampURLResponse {
892
+ session_id: string;
947
893
 
948
- relying_party?: string;
894
+ url: string;
949
895
  }
950
896
 
951
897
  /**
952
- * Input for unlinking a passkey credential.
898
+ * The request body for authenticating a guest.
953
899
  */
954
- export interface UnlinkPasskeyInput {
955
- credential_id: string;
956
-
957
- remove_as_mfa?: boolean;
958
- }
959
-
960
- /**
961
- * Extensions for a WebAuthn authentication ceremony.
962
- */
963
- export interface PasskeyVerifyExtensions {
964
- app_id?: string;
965
-
966
- cred_props?: boolean;
967
-
968
- hmac_create_secret?: boolean;
900
+ export interface GuestAuthenticateRequestBody {
901
+ guest_credential: string;
969
902
  }
970
903
 
971
904
  /**
972
- * The authenticator assertion response from a WebAuthn authentication ceremony.
905
+ * Input for linking a custom JWT account.
973
906
  */
974
- export interface PasskeyAssertionResponse {
975
- authenticator_data: string;
976
-
977
- client_data_json: string;
978
-
979
- signature: string;
980
-
981
- user_handle?: string;
907
+ export interface LinkJwtInput {
908
+ token?: string;
982
909
  }
983
910
 
984
911
  /**
985
- * WebAuthn authentication options as defined by the Web Authentication
986
- * specification.
912
+ * The request body for enrolling a passkey MFA flow.
987
913
  */
988
- export interface PasskeyAuthenticatorVerifyOptions {
989
- challenge: string;
990
-
991
- allow_credentials?: Array<PasskeyCredentialDescriptor>;
992
-
993
- /**
994
- * Extensions for a WebAuthn authentication ceremony.
995
- */
996
- extensions?: PasskeyVerifyExtensions;
997
-
998
- rp_id?: string;
999
-
1000
- timeout?: number;
914
+ export interface MfaPasskeyEnrollmentRequestBody {
915
+ credential_ids: Array<string>;
1001
916
 
1002
- user_verification?: string;
917
+ remove_for_login?: boolean;
1003
918
  }
1004
919
 
1005
920
  /**
1006
- * WebAuthn authentication response as defined by the Web Authentication
1007
- * specification.
921
+ * The request body for initiating a passkey MFA flow.
1008
922
  */
1009
- export interface PasskeyAuthenticatorVerifyResponse {
1010
- id: string;
1011
-
1012
- /**
1013
- * Client extension results returned by the WebAuthn authenticator.
1014
- */
1015
- client_extension_results: PasskeyClientExtensionResults;
1016
-
1017
- raw_id: string;
1018
-
1019
- /**
1020
- * The authenticator assertion response from a WebAuthn authentication ceremony.
1021
- */
1022
- response: PasskeyAssertionResponse;
1023
-
1024
- type: 'public-key';
1025
-
1026
- authenticator_attachment?: string;
923
+ export interface MfaPasskeyInitRequestBody {
924
+ relying_party?: string;
1027
925
  }
1028
926
 
1029
927
  /**
1030
- * Response for initiating a passkey authentication ceremony.
928
+ * The response body for initializing a passkey MFA flow.
1031
929
  */
1032
- export interface ResponsePasskeyInitAuthenticate {
930
+ export interface MfaPasskeyInitResponseBody {
1033
931
  /**
1034
932
  * WebAuthn authentication options as defined by the Web Authentication
1035
933
  * specification.
@@ -1040,1247 +938,1305 @@ export interface ResponsePasskeyInitAuthenticate {
1040
938
  }
1041
939
 
1042
940
  /**
1043
- * Input for authenticating with a passkey.
941
+ * The request body for verifying a passkey MFA flow.
1044
942
  */
1045
- export interface PasskeyAuthenticateInput {
943
+ export interface MfaPasskeyVerifyRequestBody {
1046
944
  /**
1047
945
  * WebAuthn authentication response as defined by the Web Authentication
1048
946
  * specification.
1049
947
  */
1050
948
  authenticator_response: PasskeyAuthenticatorVerifyResponse;
1051
949
 
1052
- challenge: string;
1053
-
1054
950
  relying_party?: string;
1055
951
  }
1056
952
 
1057
953
  /**
1058
- * The request body for transferring a passwordless account.
954
+ * The request body for enrolling a SMS MFA code.
1059
955
  */
1060
- export interface PasswordlessTransferRequestBody {
1061
- email: string;
956
+ export interface MfaSMSEnrollRequestBody {
957
+ code: string;
1062
958
 
1063
- nonce: string;
959
+ phoneNumber: string;
1064
960
  }
1065
961
 
1066
962
  /**
1067
- * The request body for transferring a passwordless sms account.
963
+ * Input for enrolling SMS MFA.
1068
964
  */
1069
- export interface PasswordlessSMSTransferRequestBody {
1070
- nonce: string;
965
+ export interface MfaSMSInitEnrollInput {
966
+ action: 'enroll';
1071
967
 
1072
968
  phoneNumber: string;
1073
969
  }
1074
970
 
1075
971
  /**
1076
- * Input for authenticating with a custom JWT.
972
+ * The request body for initiating a SMS MFA flow.
1077
973
  */
1078
- export interface AuthenticateJwtInput {
1079
- token?: string;
974
+ export type MfaSMSInitRequestBody = MfaSMSInitVerifyInput | MfaSMSInitEnrollInput;
1080
975
 
1081
- /**
1082
- * Whether to allow sign-up during authentication.
1083
- */
1084
- mode?: AuthenticateModeOption;
976
+ /**
977
+ * Input for verifying SMS MFA.
978
+ */
979
+ export interface MfaSMSInitVerifyInput {
980
+ action: 'verify';
1085
981
  }
1086
982
 
1087
983
  /**
1088
- * Input for linking a custom JWT account.
984
+ * The request body for verifying a SMS MFA code.
1089
985
  */
1090
- export interface LinkJwtInput {
1091
- token?: string;
986
+ export interface MfaSMSVerifyRequestBody {
987
+ code: string;
1092
988
  }
1093
989
 
1094
990
  /**
1095
- * The request input for getting a native onramp provider customer.
991
+ * The response body for initializing a TOTP MFA code.
1096
992
  */
1097
- export interface GetFiatCustomerRequestInput {
1098
- /**
1099
- * Valid set of onramp providers
1100
- */
1101
- provider: OnrampProvider;
993
+ export interface MfaTotpInitResponseBody {
994
+ totpAuthUrl: string;
1102
995
 
1103
- kyc_redirect_url?: string;
996
+ totpSecret: string;
1104
997
  }
1105
998
 
1106
999
  /**
1107
- * The request input for creating (or updating) a native onramp provider customer.
1000
+ * The input for verifying a TOTP MFA code.
1108
1001
  */
1109
- export interface CreateOrUpdateFiatCustomerRequestInput {
1110
- has_accepted_terms: boolean;
1111
-
1112
- /**
1113
- * Valid set of onramp providers
1114
- */
1115
- provider: OnrampProvider;
1116
-
1117
- kyc_redirect_url?: string;
1002
+ export interface MfaTotpInput {
1003
+ code: string;
1118
1004
  }
1119
1005
 
1120
1006
  /**
1121
- * A rejection reason for a customer KYC verification.
1007
+ * The response body for verifying a MFA code.
1122
1008
  */
1123
- export interface BridgeFiatRejectionReason {
1124
- reason: string;
1009
+ export interface MfaVerifyResponseBody {
1010
+ token: string;
1125
1011
  }
1126
1012
 
1127
1013
  /**
1128
- * The response for getting a native onramp provider customer.
1014
+ * The request body for authenticating an OAuth account.
1129
1015
  */
1130
- export interface BridgeFiatCustomerResponse {
1131
- has_accepted_terms: boolean;
1016
+ export interface OAuthAuthenticateRequestBody {
1017
+ authorization_code: string;
1132
1018
 
1133
- provider: 'bridge';
1019
+ state_code: string;
1134
1020
 
1135
1021
  /**
1136
- * Status of the KYC verification process.
1022
+ * The type of OAuth authorization code.
1137
1023
  */
1138
- status:
1139
- | 'not_found'
1140
- | 'active'
1141
- | 'awaiting_questionnaire'
1142
- | 'awaiting_ubo'
1143
- | 'incomplete'
1144
- | 'not_started'
1145
- | 'offboarded'
1146
- | 'paused'
1147
- | 'rejected'
1148
- | 'under_review';
1024
+ code_type?: OAuthCodeType;
1149
1025
 
1150
- kyc_url?: string;
1026
+ code_verifier?: string;
1151
1027
 
1152
- rejection_reasons?: Array<BridgeFiatRejectionReason>;
1028
+ /**
1029
+ * Whether to allow sign-up during authentication.
1030
+ */
1031
+ mode?: AuthenticateModeOption;
1153
1032
  }
1154
1033
 
1155
1034
  /**
1156
- * The response for getting a native onramp provider customer.
1035
+ * The request body for getting an OAuth authorization code.
1157
1036
  */
1158
- export interface BridgeSandboxFiatCustomerResponse {
1159
- has_accepted_terms: boolean;
1160
-
1161
- provider: 'bridge-sandbox';
1162
-
1163
- /**
1164
- * Status of the KYC verification process.
1165
- */
1166
- status:
1167
- | 'not_found'
1168
- | 'active'
1169
- | 'awaiting_questionnaire'
1170
- | 'awaiting_ubo'
1171
- | 'incomplete'
1172
- | 'not_started'
1173
- | 'offboarded'
1174
- | 'paused'
1175
- | 'rejected'
1176
- | 'under_review';
1037
+ export interface OAuthAuthorizationCodeRequestBody {
1038
+ code_challenge: string;
1177
1039
 
1178
- kyc_url?: string;
1040
+ redirect_to: string;
1179
1041
 
1180
- rejection_reasons?: Array<BridgeFiatRejectionReason>;
1042
+ state: string;
1181
1043
  }
1182
1044
 
1183
1045
  /**
1184
- * The response for getting a native onramp provider customer.
1046
+ * The type of OAuth authorization code.
1185
1047
  */
1186
- export type FiatCustomerResponse = BridgeFiatCustomerResponse | BridgeSandboxFiatCustomerResponse;
1048
+ export type OAuthCodeType = 'raw';
1187
1049
 
1188
1050
  /**
1189
- * ISO 4217 fiat currency code. Three uppercase ASCII letters.
1051
+ * The request body for initiating an OAuth ceremony.
1190
1052
  */
1191
- export type FiatCurrencyCode = string;
1053
+ export interface OAuthInitRequestBody {
1054
+ /**
1055
+ * The ID of an OAuth provider.
1056
+ */
1057
+ provider: OAuthProviderID;
1192
1058
 
1193
- /**
1194
- * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
1195
- */
1196
- export type CryptoCurrencyCode = string;
1059
+ redirect_to: string;
1197
1060
 
1198
- /**
1199
- * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
1200
- * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
1201
- */
1202
- export type Caip2ChainID = string;
1061
+ token?: string;
1062
+
1063
+ code_challenge?: string;
1064
+
1065
+ state_code?: string;
1066
+ }
1203
1067
 
1204
1068
  /**
1205
- * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
1069
+ * The response for initiating an OAuth ceremony.
1206
1070
  */
1207
- export type FiatAmount = string;
1071
+ export interface OAuthInitResponseBody {
1072
+ url: string;
1073
+ }
1208
1074
 
1209
1075
  /**
1210
- * Source currency details for a fiat onramp quote request.
1076
+ * The request body for linking an OAuth account.
1211
1077
  */
1212
- export interface FiatOnrampSource {
1213
- /**
1214
- * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
1215
- */
1216
- amount: FiatAmount;
1078
+ export interface OAuthLinkRequestBody {
1079
+ authorization_code: string;
1080
+
1081
+ state_code: string;
1217
1082
 
1218
1083
  /**
1219
- * ISO 4217 fiat currency code. Three uppercase ASCII letters.
1084
+ * The type of OAuth authorization code.
1220
1085
  */
1221
- asset: FiatCurrencyCode;
1086
+ code_type?: OAuthCodeType;
1087
+
1088
+ code_verifier?: string;
1222
1089
  }
1223
1090
 
1224
1091
  /**
1225
- * Destination cryptocurrency details for a fiat onramp quote request.
1092
+ * The response for linking an OAuth account.
1226
1093
  */
1227
- export interface FiatOnrampDestination {
1228
- address: string;
1229
-
1230
- /**
1231
- * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
1232
- */
1233
- asset: CryptoCurrencyCode;
1234
-
1094
+ export interface OAuthLinkResponseBody extends UsersAPI.User {
1235
1095
  /**
1236
- * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
1237
- * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
1096
+ * OAuth tokens associated with the user.
1238
1097
  */
1239
- chain: Caip2ChainID;
1098
+ oauth_tokens?: UsersAPI.OAuthTokens;
1240
1099
  }
1241
1100
 
1242
1101
  /**
1243
- * Whether to use the sandbox or production environment for fiat onramp.
1102
+ * The ID of an OAuth provider.
1244
1103
  */
1245
- export type FiatOnrampEnvironment = 'sandbox' | 'production';
1104
+ export type OAuthProviderID = ExternalOAuthProviderID | PrivyOAuthProviderID | CustomOAuthProviderID;
1246
1105
 
1247
1106
  /**
1248
- * The fiat onramp provider to use.
1107
+ * The request body for transferring an OAuth account.
1249
1108
  */
1250
- export type FiatOnrampProvider =
1251
- | 'meld'
1252
- | 'meld-sandbox'
1253
- | 'moonpay'
1254
- | 'moonpay-sandbox'
1255
- | 'coinbase'
1256
- | 'coinbase-sandbox';
1257
-
1258
- /**
1259
- * The request input for getting fiat onramp quotes.
1260
- */
1261
- export interface GetFiatOnrampQuotesInput {
1262
- /**
1263
- * Destination cryptocurrency details for a fiat onramp quote request.
1264
- */
1265
- destination: FiatOnrampDestination;
1266
-
1267
- /**
1268
- * Whether to use the sandbox or production environment for fiat onramp.
1269
- */
1270
- environment: FiatOnrampEnvironment;
1109
+ export interface OAuthTransferRequestBody {
1110
+ nonce: string;
1271
1111
 
1272
1112
  /**
1273
- * Source currency details for a fiat onramp quote request.
1113
+ * User info for an OAuth transfer.
1274
1114
  */
1275
- source: FiatOnrampSource;
1115
+ userInfo: OAuthTransferUserInfo;
1276
1116
  }
1277
1117
 
1278
1118
  /**
1279
- * A single fiat onramp quote from a provider.
1119
+ * User info for an OAuth transfer.
1280
1120
  */
1281
- export interface FiatOnrampQuote {
1282
- payment_method: string;
1121
+ export interface OAuthTransferUserInfo {
1122
+ subject: string;
1123
+
1124
+ email?: string | null;
1125
+
1126
+ embeddedWalletAddresses?: Array<string>;
1283
1127
 
1284
1128
  /**
1285
- * The fiat onramp provider to use.
1129
+ * Metadata for an OAuth transfer user info.
1286
1130
  */
1287
- provider: FiatOnrampProvider;
1288
-
1289
- destination_currency_code?: string | null;
1131
+ meta?: OAuthTransferUserInfoMeta;
1290
1132
 
1291
- source_amount?: number | null;
1133
+ name?: string;
1292
1134
 
1293
- source_currency_code?: string | null;
1135
+ profilePictureUrl?: string;
1294
1136
 
1295
- sub_provider?: string | null;
1296
- }
1137
+ smartWalletAddresses?: Array<string>;
1297
1138
 
1298
- /**
1299
- * An error from a specific fiat onramp provider when fetching quotes.
1300
- */
1301
- export interface FiatOnrampProviderError {
1302
- error: string;
1139
+ username?: string;
1303
1140
 
1304
- /**
1305
- * The fiat onramp provider to use.
1306
- */
1307
- provider: FiatOnrampProvider;
1141
+ vanityName?: string;
1308
1142
  }
1309
1143
 
1310
1144
  /**
1311
- * The response containing fiat onramp quotes.
1145
+ * Metadata for an OAuth transfer user info.
1312
1146
  */
1313
- export interface GetFiatOnrampQuotesResponse {
1314
- quotes: Array<FiatOnrampQuote>;
1315
-
1316
- provider_errors?: Array<FiatOnrampProviderError>;
1147
+ export interface OAuthTransferUserInfoMeta {
1148
+ providerAppId?: string;
1317
1149
  }
1318
1150
 
1319
1151
  /**
1320
- * The request input for getting a fiat onramp provider session URL.
1152
+ * The request body for unlinking an OAuth account.
1321
1153
  */
1322
- export interface GetFiatOnrampURLInput {
1323
- /**
1324
- * Destination cryptocurrency details for a fiat onramp quote request.
1325
- */
1326
- destination: FiatOnrampDestination;
1327
-
1328
- payment_method: string;
1329
-
1330
- /**
1331
- * The fiat onramp provider to use.
1332
- */
1333
- provider: FiatOnrampProvider;
1334
-
1154
+ export interface OAuthUnlinkRequestBody {
1335
1155
  /**
1336
- * Source currency details for a fiat onramp quote request.
1156
+ * The ID of an OAuth provider.
1337
1157
  */
1338
- source: FiatOnrampSource;
1339
-
1340
- redirect_url?: string;
1158
+ provider: OAuthProviderID;
1341
1159
 
1342
- sub_provider?: string;
1160
+ subject: string;
1343
1161
  }
1344
1162
 
1345
1163
  /**
1346
- * The response containing a fiat onramp provider session URL.
1164
+ * The request body for verifying a PRAT.
1347
1165
  */
1348
- export interface GetFiatOnrampURLResponse {
1349
- session_id: string;
1350
-
1351
- url: string;
1166
+ export interface OAuthVerifyRequestBody {
1167
+ prat: string;
1352
1168
  }
1353
1169
 
1354
1170
  /**
1355
- * Normalized fiat onramp transaction status.
1171
+ * The response body when verifying a PRAT.
1356
1172
  */
1357
- export type FiatOnrampTransactionStatus =
1358
- | 'pending'
1359
- | 'processing'
1360
- | 'completed'
1361
- | 'failed'
1362
- | 'cancelled'
1363
- | 'refunded'
1364
- | 'unknown';
1173
+ export interface OAuthVerifyResponseBody {
1174
+ verified: boolean;
1175
+ }
1365
1176
 
1366
1177
  /**
1367
- * The request input for checking a fiat onramp session status.
1178
+ * Valid set of onramp providers
1368
1179
  */
1369
- export interface GetFiatOnrampTransactionStatusInput {
1370
- /**
1371
- * The fiat onramp provider to use.
1372
- */
1373
- provider: FiatOnrampProvider;
1180
+ export type OnrampProvider = 'bridge' | 'bridge-sandbox';
1374
1181
 
1375
- session_id: string;
1182
+ /**
1183
+ * The input for refreshing a session or logging out.
1184
+ */
1185
+ export interface OptionalRefreshTokenInput {
1186
+ refresh_token?: string;
1376
1187
  }
1377
1188
 
1378
1189
  /**
1379
- * The response containing the fiat onramp session status.
1190
+ * The authenticator assertion response from a WebAuthn authentication ceremony.
1380
1191
  */
1381
- export interface GetFiatOnrampTransactionStatusResponse {
1382
- raw_status: string;
1383
-
1384
- session_id: string;
1385
-
1386
- /**
1387
- * Normalized fiat onramp transaction status.
1388
- */
1389
- status: FiatOnrampTransactionStatus;
1390
-
1391
- transaction_id?: string;
1392
- }
1192
+ export interface PasskeyAssertionResponse {
1193
+ authenticator_data: string;
1393
1194
 
1394
- export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
1195
+ client_data_json: string;
1395
1196
 
1396
- export type BridgeSourceAsset = 'usd' | 'eur' | 'mxn' | 'brl' | 'gbp';
1197
+ signature: string;
1397
1198
 
1398
- export interface BridgeFiatVirtualAccountSource {
1399
- asset: BridgeSourceAsset;
1199
+ user_handle?: string;
1400
1200
  }
1401
1201
 
1402
- export interface BridgeFiatVirtualAccountDestination {
1403
- address: string;
1202
+ /**
1203
+ * The authenticator attestation response from a WebAuthn registration ceremony.
1204
+ */
1205
+ export interface PasskeyAttestationResponse {
1206
+ attestation_object: string;
1404
1207
 
1405
- asset: BridgeDestinationAsset;
1208
+ client_data_json: string;
1406
1209
 
1407
- chain: string;
1408
- }
1210
+ authenticator_data?: string;
1409
1211
 
1410
- /**
1411
- * The request input for creating virtual account.
1412
- */
1413
- export interface BridgeFiatVirtualAccountRequest {
1414
- destination: BridgeFiatVirtualAccountDestination;
1212
+ public_key?: string;
1415
1213
 
1416
- provider: 'bridge';
1214
+ public_key_algorithm?: number;
1417
1215
 
1418
- source: BridgeFiatVirtualAccountSource;
1216
+ transports?: Array<string>;
1419
1217
  }
1420
1218
 
1421
1219
  /**
1422
- * The request input for creating virtual account.
1220
+ * Input for authenticating with a passkey.
1423
1221
  */
1424
- export interface BridgeSandboxFiatVirtualAccountRequest {
1425
- destination: BridgeFiatVirtualAccountDestination;
1222
+ export interface PasskeyAuthenticateInput {
1223
+ /**
1224
+ * WebAuthn authentication response as defined by the Web Authentication
1225
+ * specification.
1226
+ */
1227
+ authenticator_response: PasskeyAuthenticatorVerifyResponse;
1426
1228
 
1427
- provider: 'bridge-sandbox';
1229
+ challenge: string;
1428
1230
 
1429
- source: BridgeFiatVirtualAccountSource;
1231
+ relying_party?: string;
1430
1232
  }
1431
1233
 
1432
1234
  /**
1433
- * The request input for creating virtual account.
1235
+ * WebAuthn registration options as defined by the Web Authentication
1236
+ * specification.
1434
1237
  */
1435
- export type FiatVirtualAccountRequest =
1436
- | BridgeFiatVirtualAccountRequest
1437
- | BridgeSandboxFiatVirtualAccountRequest;
1238
+ export interface PasskeyAuthenticatorEnrollmentOptions {
1239
+ challenge: string;
1438
1240
 
1439
- /**
1440
- * The deposit instructions for a virtual account.
1441
- */
1442
- export interface BridgeUsdFiatVirtualAccountDepositInstructions {
1443
- asset: 'usd';
1241
+ pub_key_cred_params: Array<PasskeyPubKeyCredParam>;
1444
1242
 
1445
- bank_account_number: string;
1243
+ /**
1244
+ * Relying party information for a WebAuthn ceremony.
1245
+ */
1246
+ rp: PasskeyRelyingParty;
1446
1247
 
1447
- bank_address: string;
1248
+ /**
1249
+ * User entity for a WebAuthn registration ceremony.
1250
+ */
1251
+ user: PasskeyUser;
1448
1252
 
1449
- bank_beneficiary_address: string;
1253
+ attestation?: string;
1450
1254
 
1451
- bank_beneficiary_name: string;
1255
+ /**
1256
+ * Authenticator selection criteria for a WebAuthn registration ceremony.
1257
+ */
1258
+ authenticator_selection?: PasskeyAuthenticatorSelection;
1452
1259
 
1453
- bank_name: string;
1260
+ exclude_credentials?: Array<PasskeyCredentialDescriptor>;
1454
1261
 
1455
- bank_routing_number: string;
1262
+ /**
1263
+ * Extensions for a WebAuthn registration ceremony.
1264
+ */
1265
+ extensions?: PasskeyEnrollmentExtensions;
1456
1266
 
1457
- payment_rails: Array<'ach_push' | 'wire'>;
1267
+ timeout?: number;
1458
1268
  }
1459
1269
 
1460
1270
  /**
1461
- * The deposit instructions for a virtual account.
1271
+ * WebAuthn registration response as defined by the Web Authentication
1272
+ * specification.
1462
1273
  */
1463
- export interface BridgeEurFiatVirtualAccountDepositInstructions {
1464
- account_holder_name: string;
1465
-
1466
- asset: 'eur';
1274
+ export interface PasskeyAuthenticatorEnrollmentResponse {
1275
+ id: string;
1467
1276
 
1468
- bank_address: string;
1277
+ /**
1278
+ * Client extension results returned by the WebAuthn authenticator.
1279
+ */
1280
+ client_extension_results: PasskeyClientExtensionResults;
1469
1281
 
1470
- bank_name: string;
1282
+ raw_id: string;
1471
1283
 
1472
- bic: string;
1284
+ /**
1285
+ * The authenticator attestation response from a WebAuthn registration ceremony.
1286
+ */
1287
+ response: PasskeyAttestationResponse;
1473
1288
 
1474
- iban: string;
1289
+ type: 'public-key';
1475
1290
 
1476
- payment_rails: Array<'sepa'>;
1291
+ authenticator_attachment?: string;
1477
1292
  }
1478
1293
 
1479
1294
  /**
1480
- * The deposit instructions for a virtual account.
1295
+ * Authenticator selection criteria for a WebAuthn registration ceremony.
1481
1296
  */
1482
- export interface BridgeMxnFiatVirtualAccountDepositInstructions {
1483
- account_holder_name: string;
1297
+ export interface PasskeyAuthenticatorSelection {
1298
+ authenticator_attachment?: string;
1484
1299
 
1485
- asset: 'mxn';
1486
-
1487
- bank_address: string;
1488
-
1489
- bank_name: string;
1300
+ require_resident_key?: boolean;
1490
1301
 
1491
- clabe: string;
1302
+ resident_key?: string;
1492
1303
 
1493
- payment_rails: Array<'spei'>;
1304
+ user_verification?: string;
1494
1305
  }
1495
1306
 
1496
1307
  /**
1497
- * The deposit instructions for a virtual account.
1308
+ * WebAuthn authentication options as defined by the Web Authentication
1309
+ * specification.
1498
1310
  */
1499
- export interface BridgeBrlFiatVirtualAccountDepositInstructions {
1500
- account_holder_name: string;
1311
+ export interface PasskeyAuthenticatorVerifyOptions {
1312
+ challenge: string;
1501
1313
 
1502
- asset: 'brl';
1314
+ allow_credentials?: Array<PasskeyCredentialDescriptor>;
1503
1315
 
1504
- bank_address: string;
1316
+ /**
1317
+ * Extensions for a WebAuthn authentication ceremony.
1318
+ */
1319
+ extensions?: PasskeyVerifyExtensions;
1505
1320
 
1506
- bank_name: string;
1321
+ rp_id?: string;
1507
1322
 
1508
- br_code: string;
1323
+ timeout?: number;
1509
1324
 
1510
- payment_rails: Array<'pix'>;
1325
+ user_verification?: string;
1511
1326
  }
1512
1327
 
1513
1328
  /**
1514
- * The deposit instructions for a virtual account.
1329
+ * WebAuthn authentication response as defined by the Web Authentication
1330
+ * specification.
1515
1331
  */
1516
- export interface BridgeGbpFiatVirtualAccountDepositInstructions {
1517
- account_holder_name: string;
1518
-
1519
- account_number: string;
1332
+ export interface PasskeyAuthenticatorVerifyResponse {
1333
+ id: string;
1520
1334
 
1521
- asset: 'gbp';
1335
+ /**
1336
+ * Client extension results returned by the WebAuthn authenticator.
1337
+ */
1338
+ client_extension_results: PasskeyClientExtensionResults;
1522
1339
 
1523
- bank_address: string;
1340
+ raw_id: string;
1524
1341
 
1525
- bank_name: string;
1342
+ /**
1343
+ * The authenticator assertion response from a WebAuthn authentication ceremony.
1344
+ */
1345
+ response: PasskeyAssertionResponse;
1526
1346
 
1527
- payment_rails: Array<'faster_payments'>;
1347
+ type: 'public-key';
1528
1348
 
1529
- sort_code: string;
1349
+ authenticator_attachment?: string;
1530
1350
  }
1531
1351
 
1532
1352
  /**
1533
- * The deposit instructions for a virtual account.
1353
+ * Client extension results returned by the WebAuthn authenticator.
1534
1354
  */
1535
- export type BridgeFiatVirtualAccountDepositInstructions =
1536
- | BridgeUsdFiatVirtualAccountDepositInstructions
1537
- | BridgeEurFiatVirtualAccountDepositInstructions
1538
- | BridgeMxnFiatVirtualAccountDepositInstructions
1539
- | BridgeBrlFiatVirtualAccountDepositInstructions
1540
- | BridgeGbpFiatVirtualAccountDepositInstructions;
1355
+ export interface PasskeyClientExtensionResults {
1356
+ app_id?: boolean;
1541
1357
 
1542
- /**
1543
- * The response for creating virtual account.
1544
- */
1545
- export interface BridgeFiatVirtualAccountResponse {
1546
1358
  /**
1547
- * The deposit instructions for a virtual account.
1359
+ * The result of the WebAuthn credProps extension.
1548
1360
  */
1549
- deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
1550
-
1551
- destination: BridgeFiatVirtualAccountDestination;
1552
-
1553
- provider: 'bridge';
1361
+ cred_props?: PasskeyCredPropsResult;
1554
1362
 
1555
- status: string;
1363
+ hmac_create_secret?: boolean;
1556
1364
  }
1557
1365
 
1558
1366
  /**
1559
- * The response for creating virtual account.
1367
+ * The result of the WebAuthn credProps extension.
1560
1368
  */
1561
- export interface BridgeSandboxFiatVirtualAccountResponse {
1562
- /**
1563
- * The deposit instructions for a virtual account.
1564
- */
1565
- deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
1369
+ export interface PasskeyCredPropsResult {
1370
+ rk?: boolean;
1371
+ }
1566
1372
 
1567
- destination: BridgeFiatVirtualAccountDestination;
1373
+ /**
1374
+ * A WebAuthn credential descriptor identifying a specific public key credential.
1375
+ */
1376
+ export interface PasskeyCredentialDescriptor {
1377
+ id: string;
1568
1378
 
1569
- provider: 'bridge-sandbox';
1379
+ type: string;
1570
1380
 
1571
- status: string;
1381
+ transports?: Array<string>;
1572
1382
  }
1573
1383
 
1574
1384
  /**
1575
- * The response for creating virtual account.
1385
+ * Extensions for a WebAuthn registration ceremony.
1576
1386
  */
1577
- export type FiatVirtualAccountResponse =
1578
- | BridgeFiatVirtualAccountResponse
1579
- | BridgeSandboxFiatVirtualAccountResponse;
1387
+ export interface PasskeyEnrollmentExtensions {
1388
+ app_id?: string;
1580
1389
 
1581
- /**
1582
- * The type of OAuth authorization code.
1583
- */
1584
- export type OAuthCodeType = 'raw';
1390
+ /**
1391
+ * The result of the WebAuthn credProps extension.
1392
+ */
1393
+ cred_props?: PasskeyCredPropsResult;
1585
1394
 
1586
- /**
1587
- * Metadata for an OAuth transfer user info.
1588
- */
1589
- export interface OAuthTransferUserInfoMeta {
1590
- providerAppId?: string;
1395
+ hmac_create_secret?: boolean;
1591
1396
  }
1592
1397
 
1593
1398
  /**
1594
- * User info for an OAuth transfer.
1399
+ * Input for initiating a passkey ceremony.
1595
1400
  */
1596
- export interface OAuthTransferUserInfo {
1597
- subject: string;
1598
-
1599
- email?: string | null;
1401
+ export interface PasskeyInitInput {
1402
+ token?: string;
1600
1403
 
1601
- embeddedWalletAddresses?: Array<string>;
1404
+ relying_party?: string;
1405
+ }
1602
1406
 
1407
+ /**
1408
+ * Input for linking a passkey credential.
1409
+ */
1410
+ export interface PasskeyLinkInput {
1603
1411
  /**
1604
- * Metadata for an OAuth transfer user info.
1412
+ * WebAuthn registration response as defined by the Web Authentication
1413
+ * specification.
1605
1414
  */
1606
- meta?: OAuthTransferUserInfoMeta;
1607
-
1608
- name?: string;
1609
-
1610
- profilePictureUrl?: string;
1415
+ authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
1611
1416
 
1612
- smartWalletAddresses?: Array<string>;
1417
+ relying_party?: string;
1418
+ }
1613
1419
 
1614
- username?: string;
1420
+ /**
1421
+ * A public key credential parameter specifying the algorithm and credential type.
1422
+ */
1423
+ export interface PasskeyPubKeyCredParam {
1424
+ alg: number;
1615
1425
 
1616
- vanityName?: string;
1426
+ type: 'public-key';
1617
1427
  }
1618
1428
 
1619
1429
  /**
1620
- * The request body for transferring an OAuth account.
1430
+ * Input for registering a passkey credential.
1621
1431
  */
1622
- export interface OAuthTransferRequestBody {
1623
- nonce: string;
1624
-
1432
+ export interface PasskeyRegisterInput {
1625
1433
  /**
1626
- * User info for an OAuth transfer.
1434
+ * WebAuthn registration response as defined by the Web Authentication
1435
+ * specification.
1627
1436
  */
1628
- userInfo: OAuthTransferUserInfo;
1437
+ authenticator_response: PasskeyAuthenticatorEnrollmentResponse;
1438
+
1439
+ relying_party?: string;
1629
1440
  }
1630
1441
 
1631
1442
  /**
1632
- * Input for a SIWE signing ceremony.
1443
+ * Relying party information for a WebAuthn ceremony.
1633
1444
  */
1634
- export interface SiweInput {
1635
- message: string;
1445
+ export interface PasskeyRelyingParty {
1446
+ name: string;
1636
1447
 
1637
- signature: string;
1448
+ id?: string;
1449
+ }
1638
1450
 
1639
- chainId?: string | null;
1451
+ /**
1452
+ * User entity for a WebAuthn registration ceremony.
1453
+ */
1454
+ export interface PasskeyUser {
1455
+ id: string;
1640
1456
 
1641
- connectorType?: string | null;
1457
+ display_name: string;
1642
1458
 
1643
- walletClientType?: string | null;
1459
+ name: string;
1644
1460
  }
1645
1461
 
1646
1462
  /**
1647
- * Input for a smart wallet SIWE signing ceremony.
1463
+ * Extensions for a WebAuthn authentication ceremony.
1648
1464
  */
1649
- export interface SmartWalletSiweInput {
1650
- message: string;
1651
-
1652
- signature: string;
1465
+ export interface PasskeyVerifyExtensions {
1466
+ app_id?: string;
1653
1467
 
1654
- /**
1655
- * The supported smart wallet providers.
1656
- */
1657
- smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
1468
+ cred_props?: boolean;
1658
1469
 
1659
- smart_wallet_version?: string;
1470
+ hmac_create_secret?: boolean;
1660
1471
  }
1661
1472
 
1662
1473
  /**
1663
- * Input for authenticating a SIWE ceremony.
1474
+ * The request body for authenticating a passwordless account.
1664
1475
  */
1665
- export interface AuthenticateSiweInput {
1666
- message: string;
1667
-
1668
- signature: string;
1669
-
1670
- chainId?: string | null;
1476
+ export interface PasswordlessAuthenticateRequestBody {
1477
+ code: string;
1671
1478
 
1672
- connectorType?: string | null;
1479
+ email: string;
1673
1480
 
1674
1481
  /**
1675
1482
  * Whether to allow sign-up during authentication.
1676
1483
  */
1677
1484
  mode?: AuthenticateModeOption;
1678
-
1679
- walletClientType?: string | null;
1680
1485
  }
1681
1486
 
1682
1487
  /**
1683
- * Input containing a SIWE wallet address.
1488
+ * The request body for initiating a passwordless ceremony.
1684
1489
  */
1685
- export interface SiweAddressInput {
1686
- address: string;
1490
+ export interface PasswordlessInitRequestBody {
1491
+ email: string;
1492
+
1493
+ token?: string;
1687
1494
  }
1688
1495
 
1689
1496
  /**
1690
- * Input for initiating a SIWE ceremony.
1497
+ * The request body for linking a passwordless account.
1691
1498
  */
1692
- export interface SiweInitInput {
1693
- token?: string;
1499
+ export interface PasswordlessLinkRequestBody {
1500
+ code: string;
1694
1501
 
1695
- address?: string;
1502
+ email: string;
1696
1503
  }
1697
1504
 
1698
1505
  /**
1699
- * A SIWE nonce response.
1506
+ * The request body for authenticating a passwordless sms account.
1700
1507
  */
1701
- export interface SiweNonce {
1702
- address: string;
1508
+ export interface PasswordlessSMSAuthenticateRequestBody {
1509
+ code: string;
1703
1510
 
1704
- expires_at: string;
1511
+ phoneNumber: string;
1705
1512
 
1706
- nonce: string;
1513
+ /**
1514
+ * Whether to allow sign-up during authentication.
1515
+ */
1516
+ mode?: AuthenticateModeOption;
1707
1517
  }
1708
1518
 
1709
1519
  /**
1710
- * Input for transferring a SIWE account.
1520
+ * The request body for initiating a passwordless sms ceremony.
1711
1521
  */
1712
- export interface TransferSiweInput {
1713
- address: string;
1714
-
1715
- nonce: string;
1522
+ export interface PasswordlessSMSInitRequestBody {
1523
+ phoneNumber: string;
1716
1524
 
1717
- chainId?: string | null;
1718
-
1719
- connectorType?: string | null;
1720
-
1721
- walletClientType?: string | null;
1722
- }
1525
+ token?: string;
1526
+ }
1723
1527
 
1724
1528
  /**
1725
- * Input for a SIWS signing ceremony.
1529
+ * The request body for linking a passwordless sms account.
1726
1530
  */
1727
- export interface SiwsInput {
1728
- message: string;
1729
-
1730
- signature: string;
1731
-
1732
- connectorType?: string | null;
1733
-
1734
- message_type?: 'transaction' | 'plain';
1531
+ export interface PasswordlessSMSLinkRequestBody {
1532
+ code: string;
1735
1533
 
1736
- walletClientType?: string | null;
1534
+ phoneNumber: string;
1737
1535
  }
1738
1536
 
1739
1537
  /**
1740
- * Input for authenticating a SIWS ceremony.
1538
+ * The request body for transferring a passwordless sms account.
1741
1539
  */
1742
- export interface AuthenticateSiwsInput {
1743
- message: string;
1744
-
1745
- signature: string;
1746
-
1747
- connectorType?: string | null;
1748
-
1749
- message_type?: 'transaction' | 'plain';
1750
-
1751
- /**
1752
- * Whether to allow sign-up during authentication.
1753
- */
1754
- mode?: AuthenticateModeOption;
1540
+ export interface PasswordlessSMSTransferRequestBody {
1541
+ nonce: string;
1755
1542
 
1756
- walletClientType?: string | null;
1543
+ phoneNumber: string;
1757
1544
  }
1758
1545
 
1759
1546
  /**
1760
- * Input containing a SIWS wallet address.
1547
+ * The request body for unlinking a passwordless sms account.
1761
1548
  */
1762
- export interface SiwsAddressInput {
1763
- address: string;
1549
+ export interface PasswordlessSMSUnlinkRequestBody {
1550
+ phoneNumber: string;
1764
1551
  }
1765
1552
 
1766
1553
  /**
1767
- * Input for initiating a SIWS ceremony.
1554
+ * The request body for updating a passwordless sms account.
1768
1555
  */
1769
- export interface SiwsInitInput {
1770
- address: string;
1556
+ export interface PasswordlessSMSUpdateRequestBody {
1557
+ code: string;
1771
1558
 
1772
- token?: string;
1559
+ new_phone_number: string;
1560
+
1561
+ old_phone_number: string;
1773
1562
  }
1774
1563
 
1775
1564
  /**
1776
- * A SIWS nonce response.
1565
+ * The request body for transferring a passwordless account.
1777
1566
  */
1778
- export interface SiwsNonce {
1779
- address: string;
1780
-
1781
- expires_at: string;
1567
+ export interface PasswordlessTransferRequestBody {
1568
+ email: string;
1782
1569
 
1783
1570
  nonce: string;
1784
1571
  }
1785
1572
 
1786
1573
  /**
1787
- * Input for transferring a SIWS account.
1574
+ * The request body for unlinking a passwordless account.
1788
1575
  */
1789
- export interface TransferSiwsInput {
1576
+ export interface PasswordlessUnlinkRequestBody {
1790
1577
  address: string;
1791
-
1792
- nonce: string;
1793
-
1794
- connectorType?: string | null;
1795
-
1796
- walletClientType?: string | null;
1797
1578
  }
1798
1579
 
1799
1580
  /**
1800
- * Auth result object returned by Telegram when a user authenticates using the
1801
- * login widget.
1581
+ * The request body for updating a passwordless account.
1802
1582
  */
1803
- export interface TelegramAuthResult {
1804
- id: number | null;
1805
-
1806
- auth_date: number | null;
1807
-
1808
- first_name: string;
1809
-
1810
- hash: string;
1811
-
1812
- last_name?: string;
1583
+ export interface PasswordlessUpdateRequestBody {
1584
+ code: string;
1813
1585
 
1814
- photo_url?: string;
1586
+ newAddress: string;
1815
1587
 
1816
- username?: string;
1588
+ oldAddress: string;
1817
1589
  }
1818
1590
 
1819
1591
  /**
1820
- * Auth result object returned by Telegram when a user authenticates using a mini
1821
- * app.
1592
+ * The ID of a Privy app as an OAuth provider. Must start with "privy:".
1822
1593
  */
1823
- export interface TelegramWebAppData {
1824
- auth_date: number | null;
1825
-
1826
- hash: string;
1827
-
1828
- user: string;
1829
-
1830
- chat_instance?: string;
1831
-
1832
- chat_type?: string;
1833
-
1834
- query_id?: string;
1594
+ export type PrivyOAuthProviderID = `privy:${string}`;
1835
1595
 
1836
- signature?: string;
1596
+ /**
1597
+ * Response for initiating a passkey authentication ceremony.
1598
+ */
1599
+ export interface ResponsePasskeyInitAuthenticate {
1600
+ /**
1601
+ * WebAuthn authentication options as defined by the Web Authentication
1602
+ * specification.
1603
+ */
1604
+ options: PasskeyAuthenticatorVerifyOptions;
1837
1605
 
1838
- start_param?: string;
1606
+ relying_party?: string;
1839
1607
  }
1840
1608
 
1841
1609
  /**
1842
- * Input for authenticating with Telegram.
1610
+ * Response for initiating a passkey link ceremony.
1843
1611
  */
1844
- export interface TelegramAuthenticateInput {
1845
- captcha_token?: string;
1846
-
1612
+ export interface ResponsePasskeyInitLink {
1847
1613
  /**
1848
- * Whether to allow sign-up during authentication.
1614
+ * WebAuthn registration options as defined by the Web Authentication
1615
+ * specification.
1849
1616
  */
1850
- mode?: AuthenticateModeOption;
1617
+ options: PasskeyAuthenticatorEnrollmentOptions;
1851
1618
 
1852
- /**
1853
- * Auth result object returned by Telegram when a user authenticates using the
1854
- * login widget.
1855
- */
1856
- telegram_auth_result?: TelegramAuthResult;
1619
+ relying_party?: string;
1620
+ }
1857
1621
 
1622
+ /**
1623
+ * Response for initiating a passkey registration ceremony.
1624
+ */
1625
+ export interface ResponsePasskeyInitRegister {
1858
1626
  /**
1859
- * Auth result object returned by Telegram when a user authenticates using a mini
1860
- * app.
1627
+ * WebAuthn registration options as defined by the Web Authentication
1628
+ * specification.
1861
1629
  */
1862
- telegram_web_app_data?: TelegramWebAppData;
1630
+ options: PasskeyAuthenticatorEnrollmentOptions;
1631
+
1632
+ relying_party?: string;
1863
1633
  }
1864
1634
 
1865
1635
  /**
1866
- * Input for unlinking a Telegram account.
1636
+ * Input containing a SIWE wallet address.
1867
1637
  */
1868
- export interface TelegramUnlinkInput {
1869
- telegram_user_id: string;
1638
+ export interface SiweAddressInput {
1639
+ address: string;
1870
1640
  }
1871
1641
 
1872
1642
  /**
1873
- * Input for transferring a Telegram account.
1643
+ * The request body for authenticating a SIWE ceremony.
1874
1644
  */
1875
- export interface TransferTelegramInput {
1876
- nonce: string;
1645
+ export interface SiweAuthenticateRequestBody {
1646
+ message: string;
1877
1647
 
1878
- /**
1879
- * Auth result object returned by Telegram when a user authenticates using the
1880
- * login widget.
1881
- */
1882
- telegram_auth_result?: TelegramAuthResult;
1648
+ signature: string;
1649
+
1650
+ chainId?: string | null;
1651
+
1652
+ connectorType?: string | null;
1883
1653
 
1884
1654
  /**
1885
- * Auth result object returned by Telegram when a user authenticates using a mini
1886
- * app.
1655
+ * Whether to allow sign-up during authentication.
1887
1656
  */
1888
- telegram_web_app_data?: TelegramWebAppData;
1657
+ mode?: AuthenticateModeOption;
1658
+
1659
+ walletClientType?: string | null;
1889
1660
  }
1890
1661
 
1891
1662
  /**
1892
- * Proxy for the Farcaster Connect init response as defined in FIP-11.
1663
+ * Input for initiating a SIWE ceremony.
1893
1664
  */
1894
- export interface FarcasterConnectInitResponse {
1895
- channel_token: string;
1665
+ export interface SiweInitInput {
1666
+ token?: string;
1896
1667
 
1897
- connect_uri: string;
1668
+ address?: string;
1898
1669
  }
1899
1670
 
1900
1671
  /**
1901
- * Proxy for the Farcaster Connect completed status response as defined in FIP-11.
1672
+ * The request body for initiating a SIWE ceremony.
1902
1673
  */
1903
- export interface FarcasterConnectStatusCompletedResponse {
1904
- bio: string;
1905
-
1906
- display_name: string;
1674
+ export interface SiweInitRequestBody {
1675
+ address: string;
1676
+ }
1907
1677
 
1908
- fid: number;
1678
+ /**
1679
+ * The response body for initiating a SIWE ceremony.
1680
+ */
1681
+ export interface SiweInitResponseBody {
1682
+ address: string;
1909
1683
 
1910
- message: string;
1684
+ expires_at: string;
1911
1685
 
1912
1686
  nonce: string;
1687
+ }
1913
1688
 
1914
- pfp_url: string;
1689
+ /**
1690
+ * Input for a SIWE signing ceremony.
1691
+ */
1692
+ export interface SiweInput {
1693
+ message: string;
1915
1694
 
1916
1695
  signature: string;
1917
1696
 
1918
- state: 'completed';
1697
+ chainId?: string | null;
1919
1698
 
1920
- username: string;
1699
+ connectorType?: string | null;
1700
+
1701
+ walletClientType?: string | null;
1921
1702
  }
1922
1703
 
1923
1704
  /**
1924
- * Proxy for the Farcaster Connect pending status response as defined in FIP-11.
1705
+ * The request body for linking a SIWE ceremony.
1925
1706
  */
1926
- export interface FarcasterConnectStatusPendingResponse {
1927
- nonce: string;
1707
+ export interface SiweLinkRequestBody {
1708
+ message: string;
1928
1709
 
1929
- state: 'pending';
1710
+ signature: string;
1711
+
1712
+ chainId?: string | null;
1713
+
1714
+ connectorType?: string | null;
1715
+
1716
+ walletClientType?: string | null;
1930
1717
  }
1931
1718
 
1932
1719
  /**
1933
- * Input for authenticating with Farcaster.
1720
+ * The request body for linking a SIWE ceremony to a smart wallet.
1934
1721
  */
1935
- export interface FarcasterAuthenticateInput {
1936
- channel_token: string;
1937
-
1938
- fid: number;
1939
-
1722
+ export interface SiweLinkSmartWalletRequestBody {
1940
1723
  message: string;
1941
1724
 
1942
1725
  signature: string;
1943
1726
 
1944
1727
  /**
1945
- * Whether to allow sign-up during authentication.
1728
+ * The supported smart wallet providers.
1946
1729
  */
1947
- mode?: AuthenticateModeOption;
1730
+ smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
1731
+
1732
+ smart_wallet_version?: string;
1948
1733
  }
1949
1734
 
1950
1735
  /**
1951
- * Input for linking a Farcaster account.
1736
+ * A SIWE nonce response.
1952
1737
  */
1953
- export interface FarcasterLinkInput {
1954
- channel_token: string;
1955
-
1956
- fid: number;
1738
+ export interface SiweNonce {
1739
+ address: string;
1957
1740
 
1958
- message: string;
1741
+ expires_at: string;
1959
1742
 
1960
- signature: string;
1743
+ nonce: string;
1961
1744
  }
1962
1745
 
1963
1746
  /**
1964
- * Input for initiating a Farcaster connection.
1747
+ * The request body for unlinking a SIWE ceremony.
1965
1748
  */
1966
- export interface FarcasterInitInput {
1967
- token?: string;
1749
+ export interface SiweUnlinkRequestBody {
1750
+ address: string;
1751
+ }
1968
1752
 
1969
- redirect_url?: string;
1753
+ /**
1754
+ * Input containing a SIWS wallet address.
1755
+ */
1756
+ export interface SiwsAddressInput {
1757
+ address: string;
1758
+ }
1970
1759
 
1971
- relying_party?: string;
1760
+ /**
1761
+ * The request body for authenticating a SIWS ceremony.
1762
+ */
1763
+ export interface SiwsAuthenticateRequestBody {
1764
+ message: string;
1765
+
1766
+ signature: string;
1767
+
1768
+ connectorType?: string | null;
1769
+
1770
+ message_type?: 'transaction' | 'plain';
1771
+
1772
+ /**
1773
+ * Whether to allow sign-up during authentication.
1774
+ */
1775
+ mode?: AuthenticateModeOption;
1776
+
1777
+ walletClientType?: string | null;
1972
1778
  }
1973
1779
 
1974
1780
  /**
1975
- * Input for unlinking a Farcaster account.
1781
+ * Input for initiating a SIWS ceremony.
1976
1782
  */
1977
- export interface FarcasterUnlinkInput {
1978
- fid: number;
1783
+ export interface SiwsInitInput {
1784
+ address: string;
1785
+
1786
+ token?: string;
1979
1787
  }
1980
1788
 
1981
1789
  /**
1982
- * Input for transferring a Farcaster account.
1790
+ * The request body for initiating a SIWS ceremony.
1983
1791
  */
1984
- export interface TransferFarcasterInput {
1985
- farcaster_embedded_address: string;
1792
+ export interface SiwsInitRequestBody {
1793
+ address: string;
1794
+ }
1986
1795
 
1987
- farcaster_id: string;
1796
+ /**
1797
+ * The response body for initiating a SIWS ceremony.
1798
+ */
1799
+ export interface SiwsInitResponseBody {
1800
+ address: string;
1801
+
1802
+ expires_at: string;
1988
1803
 
1989
1804
  nonce: string;
1990
1805
  }
1991
1806
 
1992
1807
  /**
1993
- * Input for initiating a Farcaster V2 connection.
1808
+ * Input for a SIWS signing ceremony.
1994
1809
  */
1995
- export type FarcasterV2InitInput = unknown;
1810
+ export interface SiwsInput {
1811
+ message: string;
1812
+
1813
+ signature: string;
1814
+
1815
+ connectorType?: string | null;
1816
+
1817
+ message_type?: 'transaction' | 'plain';
1818
+
1819
+ walletClientType?: string | null;
1820
+ }
1996
1821
 
1997
1822
  /**
1998
- * Response for initiating a Farcaster V2 connection.
1823
+ * The request body for linking a SIWS ceremony.
1999
1824
  */
2000
- export interface FarcasterV2InitResponse {
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
+
1837
+ /**
1838
+ * A SIWS nonce response.
1839
+ */
1840
+ export interface SiwsNonce {
1841
+ address: string;
1842
+
2001
1843
  expires_at: string;
2002
1844
 
2003
1845
  nonce: string;
2004
1846
  }
2005
1847
 
2006
1848
  /**
2007
- * Input for authenticating a Farcaster V2 account.
1849
+ * The request body for unlinking a SIWS ceremony.
2008
1850
  */
2009
- export interface FarcasterV2AuthenticateInput {
2010
- fid: number;
1851
+ export interface SiwsUnlinkRequestBody {
1852
+ address: string;
1853
+ }
2011
1854
 
1855
+ /**
1856
+ * Input for a smart wallet SIWE signing ceremony.
1857
+ */
1858
+ export interface SmartWalletSiweInput {
2012
1859
  message: string;
2013
1860
 
2014
1861
  signature: string;
2015
1862
 
2016
1863
  /**
2017
- * Whether to allow sign-up during authentication.
1864
+ * The supported smart wallet providers.
2018
1865
  */
2019
- mode?: AuthenticateModeOption;
1866
+ smart_wallet_type: EmbeddedWalletsAPI.SmartWalletType;
1867
+
1868
+ smart_wallet_version?: string;
2020
1869
  }
2021
1870
 
2022
1871
  /**
2023
- * The request body for initiating a Farcaster V2 connection.
1872
+ * Auth result object returned by Telegram when a user authenticates using the
1873
+ * login widget.
2024
1874
  */
2025
- export type FarcasterV2InitRequestBody = unknown;
1875
+ export interface TelegramAuthResult {
1876
+ id: number | null;
1877
+
1878
+ auth_date: number | null;
1879
+
1880
+ first_name: string;
1881
+
1882
+ hash: string;
1883
+
1884
+ last_name?: string;
1885
+
1886
+ photo_url?: string;
1887
+
1888
+ username?: string;
1889
+ }
2026
1890
 
2027
1891
  /**
2028
- * The response body for initiating a Farcaster V2 connection.
1892
+ * Input for authenticating with Telegram.
2029
1893
  */
2030
- export interface FarcasterV2InitResponseBody {
2031
- expires_at: string;
1894
+ export interface TelegramAuthenticateInput {
1895
+ captcha_token?: string;
2032
1896
 
2033
- nonce: string;
1897
+ /**
1898
+ * Whether to allow sign-up during authentication.
1899
+ */
1900
+ mode?: AuthenticateModeOption;
1901
+
1902
+ /**
1903
+ * Auth result object returned by Telegram when a user authenticates using the
1904
+ * login widget.
1905
+ */
1906
+ telegram_auth_result?: TelegramAuthResult;
1907
+
1908
+ /**
1909
+ * Auth result object returned by Telegram when a user authenticates using a mini
1910
+ * app.
1911
+ */
1912
+ telegram_web_app_data?: TelegramWebAppData;
2034
1913
  }
2035
1914
 
2036
1915
  /**
2037
- * The request body for authenticating a Farcaster V2 account.
1916
+ * The request body for authenticating with Telegram.
2038
1917
  */
2039
- export interface FarcasterV2AuthenticateRequestBody {
2040
- fid: number;
1918
+ export interface TelegramAuthenticateRequestBody {
1919
+ captcha_token?: string;
2041
1920
 
2042
- message: string;
1921
+ /**
1922
+ * Whether to allow sign-up during authentication.
1923
+ */
1924
+ mode?: AuthenticateModeOption;
2043
1925
 
2044
- signature: string;
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;
2045
1944
 
2046
1945
  /**
2047
1946
  * Whether to allow sign-up during authentication.
2048
1947
  */
2049
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;
2050
1961
  }
2051
1962
 
2052
1963
  /**
2053
- * A Farcaster signer init response when the signer is pending approval.
1964
+ * Input for unlinking a Telegram account.
2054
1965
  */
2055
- export interface FarcasterSignerInitPendingApproval {
2056
- public_key: string;
1966
+ export interface TelegramUnlinkInput {
1967
+ telegram_user_id: string;
1968
+ }
2057
1969
 
2058
- signer_approval_url: string;
1970
+ /**
1971
+ * The request body for unlinking a Telegram account.
1972
+ */
1973
+ export interface TelegramUnlinkRequestBody {
1974
+ telegram_user_id: string;
1975
+ }
2059
1976
 
2060
- status: 'pending_approval';
1977
+ /**
1978
+ * Auth result object returned by Telegram when a user authenticates using a mini
1979
+ * app.
1980
+ */
1981
+ export interface TelegramWebAppData {
1982
+ auth_date: number | null;
1983
+
1984
+ hash: string;
1985
+
1986
+ user: string;
1987
+
1988
+ chat_instance?: string;
1989
+
1990
+ chat_type?: string;
1991
+
1992
+ query_id?: string;
1993
+
1994
+ signature?: string;
1995
+
1996
+ start_param?: string;
2061
1997
  }
2062
1998
 
2063
1999
  /**
2064
- * A Farcaster signer response when the signer has been approved.
2000
+ * Input for transferring a Farcaster account.
2065
2001
  */
2066
- export interface FarcasterSignerApproved {
2067
- fid: string;
2002
+ export interface TransferFarcasterInput {
2003
+ farcaster_embedded_address: string;
2068
2004
 
2069
- public_key: string;
2005
+ farcaster_id: string;
2070
2006
 
2071
- status: 'approved';
2007
+ nonce: string;
2072
2008
  }
2073
2009
 
2074
2010
  /**
2075
- * A Farcaster signer response when the signer has been revoked.
2011
+ * Input for transferring a SIWE account.
2076
2012
  */
2077
- export interface FarcasterSignerRevoked {
2078
- fid: string;
2013
+ export interface TransferSiweInput {
2014
+ address: string;
2079
2015
 
2080
- public_key: string;
2016
+ nonce: string;
2081
2017
 
2082
- status: 'revoked';
2018
+ chainId?: string | null;
2019
+
2020
+ connectorType?: string | null;
2021
+
2022
+ walletClientType?: string | null;
2083
2023
  }
2084
2024
 
2085
2025
  /**
2086
- * A Farcaster signer status response when the signer is pending approval.
2026
+ * Input for transferring a SIWS account.
2087
2027
  */
2088
- export interface FarcasterSignerStatusPendingApproval {
2089
- public_key: string;
2028
+ export interface TransferSiwsInput {
2029
+ address: string;
2090
2030
 
2091
- status: 'pending_approval';
2031
+ nonce: string;
2032
+
2033
+ connectorType?: string | null;
2034
+
2035
+ walletClientType?: string | null;
2092
2036
  }
2093
2037
 
2094
2038
  /**
2095
- * Input for verifying SMS MFA.
2039
+ * Input for transferring a Telegram account.
2096
2040
  */
2097
- export interface MfaSMSInitVerifyInput {
2098
- action: 'verify';
2041
+ export interface TransferTelegramInput {
2042
+ nonce: string;
2043
+
2044
+ /**
2045
+ * Auth result object returned by Telegram when a user authenticates using the
2046
+ * login widget.
2047
+ */
2048
+ telegram_auth_result?: TelegramAuthResult;
2049
+
2050
+ /**
2051
+ * Auth result object returned by Telegram when a user authenticates using a mini
2052
+ * app.
2053
+ */
2054
+ telegram_web_app_data?: TelegramWebAppData;
2099
2055
  }
2100
2056
 
2101
2057
  /**
2102
- * Input for enrolling SMS MFA.
2058
+ * Input for unlinking a passkey credential.
2103
2059
  */
2104
- export interface MfaSMSInitEnrollInput {
2105
- action: 'enroll';
2060
+ export interface UnlinkPasskeyInput {
2061
+ credential_id: string;
2106
2062
 
2107
- phoneNumber: string;
2063
+ remove_as_mfa?: boolean;
2108
2064
  }
2109
2065
 
2110
2066
  export declare namespace ClientAuth {
2111
2067
  export {
2068
+ type AuthenticateJwtInput as AuthenticateJwtInput,
2069
+ type AuthenticateMode as AuthenticateMode,
2070
+ type AuthenticateModeOption as AuthenticateModeOption,
2071
+ type AuthenticateSiweInput as AuthenticateSiweInput,
2072
+ type AuthenticateSiwsInput as AuthenticateSiwsInput,
2073
+ type BridgeBrlFiatVirtualAccountDepositInstructions as BridgeBrlFiatVirtualAccountDepositInstructions,
2074
+ type BridgeDestinationAsset as BridgeDestinationAsset,
2075
+ type BridgeEurFiatVirtualAccountDepositInstructions as BridgeEurFiatVirtualAccountDepositInstructions,
2076
+ type BridgeFiatCustomerResponse as BridgeFiatCustomerResponse,
2077
+ type BridgeFiatRejectionReason as BridgeFiatRejectionReason,
2078
+ type BridgeFiatVirtualAccountDepositInstructions as BridgeFiatVirtualAccountDepositInstructions,
2079
+ type BridgeFiatVirtualAccountDestination as BridgeFiatVirtualAccountDestination,
2080
+ type BridgeFiatVirtualAccountRequest as BridgeFiatVirtualAccountRequest,
2081
+ type BridgeFiatVirtualAccountResponse as BridgeFiatVirtualAccountResponse,
2082
+ type BridgeFiatVirtualAccountSource as BridgeFiatVirtualAccountSource,
2083
+ type BridgeGbpFiatVirtualAccountDepositInstructions as BridgeGbpFiatVirtualAccountDepositInstructions,
2084
+ type BridgeMxnFiatVirtualAccountDepositInstructions as BridgeMxnFiatVirtualAccountDepositInstructions,
2085
+ type BridgeOnrampProvider as BridgeOnrampProvider,
2086
+ type BridgeSandboxFiatCustomerResponse as BridgeSandboxFiatCustomerResponse,
2087
+ type BridgeSandboxFiatVirtualAccountRequest as BridgeSandboxFiatVirtualAccountRequest,
2088
+ type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
2089
+ type BridgeSourceAsset as BridgeSourceAsset,
2090
+ type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
2091
+ type Caip2ChainID as Caip2ChainID,
2092
+ type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
2093
+ type CryptoCurrencyCode as CryptoCurrencyCode,
2112
2094
  type CustomJwtAuthenticateRequestBody as CustomJwtAuthenticateRequestBody,
2113
2095
  type CustomJwtLinkRequestBody as CustomJwtLinkRequestBody,
2096
+ type CustomOAuthProviderID as CustomOAuthProviderID,
2097
+ type ExternalOAuthProviderID as ExternalOAuthProviderID,
2098
+ type FarcasterAuthenticateInput as FarcasterAuthenticateInput,
2114
2099
  type FarcasterAuthenticateRequestBody as FarcasterAuthenticateRequestBody,
2100
+ type FarcasterConnectInitResponse as FarcasterConnectInitResponse,
2115
2101
  type FarcasterConnectInitResponseBody as FarcasterConnectInitResponseBody,
2102
+ type FarcasterConnectStatusCompletedResponse as FarcasterConnectStatusCompletedResponse,
2116
2103
  type FarcasterConnectStatusCompletedResponseBody as FarcasterConnectStatusCompletedResponseBody,
2104
+ type FarcasterConnectStatusPendingResponse as FarcasterConnectStatusPendingResponse,
2117
2105
  type FarcasterConnectStatusPendingResponseBody as FarcasterConnectStatusPendingResponseBody,
2106
+ type FarcasterInitInput as FarcasterInitInput,
2118
2107
  type FarcasterInitRequestBody as FarcasterInitRequestBody,
2108
+ type FarcasterLinkInput as FarcasterLinkInput,
2119
2109
  type FarcasterLinkRequestBody as FarcasterLinkRequestBody,
2110
+ type FarcasterSignerApproved as FarcasterSignerApproved,
2111
+ type FarcasterSignerInitPendingApproval as FarcasterSignerInitPendingApproval,
2120
2112
  type FarcasterSignerInitRequestBody as FarcasterSignerInitRequestBody,
2121
2113
  type FarcasterSignerInitResponseBody as FarcasterSignerInitResponseBody,
2114
+ type FarcasterSignerRevoked as FarcasterSignerRevoked,
2115
+ type FarcasterSignerStatusPendingApproval as FarcasterSignerStatusPendingApproval,
2122
2116
  type FarcasterSignerStatusResponseBody as FarcasterSignerStatusResponseBody,
2117
+ type FarcasterUnlinkInput as FarcasterUnlinkInput,
2123
2118
  type FarcasterUnlinkRequestBody as FarcasterUnlinkRequestBody,
2119
+ type FarcasterV2AuthenticateInput as FarcasterV2AuthenticateInput,
2124
2120
  type FarcasterV2AuthenticateRequestBody as FarcasterV2AuthenticateRequestBody,
2121
+ type FarcasterV2InitInput as FarcasterV2InitInput,
2122
+ type FarcasterV2InitRequestBody as FarcasterV2InitRequestBody,
2123
+ type FarcasterV2InitResponse as FarcasterV2InitResponse,
2125
2124
  type FarcasterV2InitResponseBody as FarcasterV2InitResponseBody,
2125
+ type FiatAmount as FiatAmount,
2126
+ type FiatCurrencyCode as FiatCurrencyCode,
2127
+ type FiatCustomerResponse as FiatCustomerResponse,
2128
+ type FiatOnrampDestination as FiatOnrampDestination,
2129
+ type FiatOnrampEnvironment as FiatOnrampEnvironment,
2130
+ type FiatOnrampProvider as FiatOnrampProvider,
2131
+ type FiatOnrampProviderError as FiatOnrampProviderError,
2132
+ type FiatOnrampQuote as FiatOnrampQuote,
2133
+ type FiatOnrampSource as FiatOnrampSource,
2134
+ type FiatOnrampTransactionStatus as FiatOnrampTransactionStatus,
2135
+ type FiatVirtualAccountRequest as FiatVirtualAccountRequest,
2136
+ type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
2137
+ type GetFiatCustomerRequestInput as GetFiatCustomerRequestInput,
2138
+ type GetFiatOnrampQuotesInput as GetFiatOnrampQuotesInput,
2139
+ type GetFiatOnrampQuotesResponse as GetFiatOnrampQuotesResponse,
2140
+ type GetFiatOnrampTransactionStatusInput as GetFiatOnrampTransactionStatusInput,
2141
+ type GetFiatOnrampTransactionStatusResponse as GetFiatOnrampTransactionStatusResponse,
2142
+ type GetFiatOnrampURLInput as GetFiatOnrampURLInput,
2143
+ type GetFiatOnrampURLResponse as GetFiatOnrampURLResponse,
2126
2144
  type GuestAuthenticateRequestBody as GuestAuthenticateRequestBody,
2145
+ type LinkJwtInput as LinkJwtInput,
2127
2146
  type MfaPasskeyEnrollmentRequestBody as MfaPasskeyEnrollmentRequestBody,
2128
2147
  type MfaPasskeyInitRequestBody as MfaPasskeyInitRequestBody,
2129
2148
  type MfaPasskeyInitResponseBody as MfaPasskeyInitResponseBody,
2130
2149
  type MfaPasskeyVerifyRequestBody as MfaPasskeyVerifyRequestBody,
2131
2150
  type MfaSMSEnrollRequestBody as MfaSMSEnrollRequestBody,
2151
+ type MfaSMSInitEnrollInput as MfaSMSInitEnrollInput,
2132
2152
  type MfaSMSInitRequestBody as MfaSMSInitRequestBody,
2153
+ type MfaSMSInitVerifyInput as MfaSMSInitVerifyInput,
2133
2154
  type MfaSMSVerifyRequestBody as MfaSMSVerifyRequestBody,
2134
2155
  type MfaTotpInitResponseBody as MfaTotpInitResponseBody,
2135
2156
  type MfaTotpInput as MfaTotpInput,
2136
2157
  type MfaVerifyResponseBody as MfaVerifyResponseBody,
2137
2158
  type OAuthAuthenticateRequestBody as OAuthAuthenticateRequestBody,
2138
2159
  type OAuthAuthorizationCodeRequestBody as OAuthAuthorizationCodeRequestBody,
2160
+ type OAuthCodeType as OAuthCodeType,
2139
2161
  type OAuthInitRequestBody as OAuthInitRequestBody,
2140
2162
  type OAuthInitResponseBody as OAuthInitResponseBody,
2141
2163
  type OAuthLinkRequestBody as OAuthLinkRequestBody,
2142
2164
  type OAuthLinkResponseBody as OAuthLinkResponseBody,
2165
+ type OAuthProviderID as OAuthProviderID,
2166
+ type OAuthTransferRequestBody as OAuthTransferRequestBody,
2167
+ type OAuthTransferUserInfo as OAuthTransferUserInfo,
2168
+ type OAuthTransferUserInfoMeta as OAuthTransferUserInfoMeta,
2143
2169
  type OAuthUnlinkRequestBody as OAuthUnlinkRequestBody,
2144
2170
  type OAuthVerifyRequestBody as OAuthVerifyRequestBody,
2145
2171
  type OAuthVerifyResponseBody as OAuthVerifyResponseBody,
2172
+ type OnrampProvider as OnrampProvider,
2146
2173
  type OptionalRefreshTokenInput as OptionalRefreshTokenInput,
2174
+ type PasskeyAssertionResponse as PasskeyAssertionResponse,
2175
+ type PasskeyAttestationResponse as PasskeyAttestationResponse,
2176
+ type PasskeyAuthenticateInput as PasskeyAuthenticateInput,
2177
+ type PasskeyAuthenticatorEnrollmentOptions as PasskeyAuthenticatorEnrollmentOptions,
2178
+ type PasskeyAuthenticatorEnrollmentResponse as PasskeyAuthenticatorEnrollmentResponse,
2179
+ type PasskeyAuthenticatorSelection as PasskeyAuthenticatorSelection,
2180
+ type PasskeyAuthenticatorVerifyOptions as PasskeyAuthenticatorVerifyOptions,
2181
+ type PasskeyAuthenticatorVerifyResponse as PasskeyAuthenticatorVerifyResponse,
2182
+ type PasskeyClientExtensionResults as PasskeyClientExtensionResults,
2183
+ type PasskeyCredPropsResult as PasskeyCredPropsResult,
2184
+ type PasskeyCredentialDescriptor as PasskeyCredentialDescriptor,
2185
+ type PasskeyEnrollmentExtensions as PasskeyEnrollmentExtensions,
2186
+ type PasskeyInitInput as PasskeyInitInput,
2187
+ type PasskeyLinkInput as PasskeyLinkInput,
2188
+ type PasskeyPubKeyCredParam as PasskeyPubKeyCredParam,
2189
+ type PasskeyRegisterInput as PasskeyRegisterInput,
2190
+ type PasskeyRelyingParty as PasskeyRelyingParty,
2191
+ type PasskeyUser as PasskeyUser,
2192
+ type PasskeyVerifyExtensions as PasskeyVerifyExtensions,
2147
2193
  type PasswordlessAuthenticateRequestBody as PasswordlessAuthenticateRequestBody,
2148
2194
  type PasswordlessInitRequestBody as PasswordlessInitRequestBody,
2149
2195
  type PasswordlessLinkRequestBody as PasswordlessLinkRequestBody,
2150
2196
  type PasswordlessSMSAuthenticateRequestBody as PasswordlessSMSAuthenticateRequestBody,
2151
2197
  type PasswordlessSMSInitRequestBody as PasswordlessSMSInitRequestBody,
2152
2198
  type PasswordlessSMSLinkRequestBody as PasswordlessSMSLinkRequestBody,
2199
+ type PasswordlessSMSTransferRequestBody as PasswordlessSMSTransferRequestBody,
2153
2200
  type PasswordlessSMSUnlinkRequestBody as PasswordlessSMSUnlinkRequestBody,
2154
2201
  type PasswordlessSMSUpdateRequestBody as PasswordlessSMSUpdateRequestBody,
2202
+ type PasswordlessTransferRequestBody as PasswordlessTransferRequestBody,
2155
2203
  type PasswordlessUnlinkRequestBody as PasswordlessUnlinkRequestBody,
2156
2204
  type PasswordlessUpdateRequestBody as PasswordlessUpdateRequestBody,
2205
+ type PrivyOAuthProviderID as PrivyOAuthProviderID,
2206
+ type ResponsePasskeyInitAuthenticate as ResponsePasskeyInitAuthenticate,
2207
+ type ResponsePasskeyInitLink as ResponsePasskeyInitLink,
2208
+ type ResponsePasskeyInitRegister as ResponsePasskeyInitRegister,
2209
+ type SiweAddressInput as SiweAddressInput,
2157
2210
  type SiweAuthenticateRequestBody as SiweAuthenticateRequestBody,
2211
+ type SiweInitInput as SiweInitInput,
2158
2212
  type SiweInitRequestBody as SiweInitRequestBody,
2159
2213
  type SiweInitResponseBody as SiweInitResponseBody,
2214
+ type SiweInput as SiweInput,
2160
2215
  type SiweLinkRequestBody as SiweLinkRequestBody,
2161
2216
  type SiweLinkSmartWalletRequestBody as SiweLinkSmartWalletRequestBody,
2217
+ type SiweNonce as SiweNonce,
2162
2218
  type SiweUnlinkRequestBody as SiweUnlinkRequestBody,
2219
+ type SiwsAddressInput as SiwsAddressInput,
2163
2220
  type SiwsAuthenticateRequestBody as SiwsAuthenticateRequestBody,
2221
+ type SiwsInitInput as SiwsInitInput,
2164
2222
  type SiwsInitRequestBody as SiwsInitRequestBody,
2165
2223
  type SiwsInitResponseBody as SiwsInitResponseBody,
2224
+ type SiwsInput as SiwsInput,
2166
2225
  type SiwsLinkRequestBody as SiwsLinkRequestBody,
2226
+ type SiwsNonce as SiwsNonce,
2167
2227
  type SiwsUnlinkRequestBody as SiwsUnlinkRequestBody,
2228
+ type SmartWalletSiweInput as SmartWalletSiweInput,
2229
+ type TelegramAuthResult as TelegramAuthResult,
2230
+ type TelegramAuthenticateInput as TelegramAuthenticateInput,
2168
2231
  type TelegramAuthenticateRequestBody as TelegramAuthenticateRequestBody,
2169
2232
  type TelegramLinkRequestBody as TelegramLinkRequestBody,
2233
+ type TelegramUnlinkInput as TelegramUnlinkInput,
2170
2234
  type TelegramUnlinkRequestBody as TelegramUnlinkRequestBody,
2171
- type AuthenticateModeOption as AuthenticateModeOption,
2172
- type AuthenticateMode as AuthenticateMode,
2173
- type ExternalOAuthProviderID as ExternalOAuthProviderID,
2174
- type PrivyOAuthProviderID as PrivyOAuthProviderID,
2175
- type CustomOAuthProviderID as CustomOAuthProviderID,
2176
- type OAuthProviderID as OAuthProviderID,
2177
- type BridgeOnrampProvider as BridgeOnrampProvider,
2178
- type OnrampProvider as OnrampProvider,
2179
- type PasskeyCredPropsResult as PasskeyCredPropsResult,
2180
- type PasskeyClientExtensionResults as PasskeyClientExtensionResults,
2181
- type PasskeyCredentialDescriptor as PasskeyCredentialDescriptor,
2182
- type PasskeyRelyingParty as PasskeyRelyingParty,
2183
- type PasskeyUser as PasskeyUser,
2184
- type PasskeyPubKeyCredParam as PasskeyPubKeyCredParam,
2185
- type PasskeyAuthenticatorSelection as PasskeyAuthenticatorSelection,
2186
- type PasskeyEnrollmentExtensions as PasskeyEnrollmentExtensions,
2187
- type PasskeyAttestationResponse as PasskeyAttestationResponse,
2188
- type PasskeyAuthenticatorEnrollmentOptions as PasskeyAuthenticatorEnrollmentOptions,
2189
- type PasskeyAuthenticatorEnrollmentResponse as PasskeyAuthenticatorEnrollmentResponse,
2190
- type ResponsePasskeyInitLink as ResponsePasskeyInitLink,
2191
- type ResponsePasskeyInitRegister as ResponsePasskeyInitRegister,
2192
- type PasskeyLinkInput as PasskeyLinkInput,
2193
- type PasskeyRegisterInput as PasskeyRegisterInput,
2194
- type PasskeyInitInput as PasskeyInitInput,
2195
- type UnlinkPasskeyInput as UnlinkPasskeyInput,
2196
- type PasskeyVerifyExtensions as PasskeyVerifyExtensions,
2197
- type PasskeyAssertionResponse as PasskeyAssertionResponse,
2198
- type PasskeyAuthenticatorVerifyOptions as PasskeyAuthenticatorVerifyOptions,
2199
- type PasskeyAuthenticatorVerifyResponse as PasskeyAuthenticatorVerifyResponse,
2200
- type ResponsePasskeyInitAuthenticate as ResponsePasskeyInitAuthenticate,
2201
- type PasskeyAuthenticateInput as PasskeyAuthenticateInput,
2202
- type PasswordlessTransferRequestBody as PasswordlessTransferRequestBody,
2203
- type PasswordlessSMSTransferRequestBody as PasswordlessSMSTransferRequestBody,
2204
- type AuthenticateJwtInput as AuthenticateJwtInput,
2205
- type LinkJwtInput as LinkJwtInput,
2206
- type GetFiatCustomerRequestInput as GetFiatCustomerRequestInput,
2207
- type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
2208
- type BridgeFiatRejectionReason as BridgeFiatRejectionReason,
2209
- type BridgeFiatCustomerResponse as BridgeFiatCustomerResponse,
2210
- type BridgeSandboxFiatCustomerResponse as BridgeSandboxFiatCustomerResponse,
2211
- type FiatCustomerResponse as FiatCustomerResponse,
2212
- type FiatCurrencyCode as FiatCurrencyCode,
2213
- type CryptoCurrencyCode as CryptoCurrencyCode,
2214
- type Caip2ChainID as Caip2ChainID,
2215
- type FiatAmount as FiatAmount,
2216
- type FiatOnrampSource as FiatOnrampSource,
2217
- type FiatOnrampDestination as FiatOnrampDestination,
2218
- type FiatOnrampEnvironment as FiatOnrampEnvironment,
2219
- type FiatOnrampProvider as FiatOnrampProvider,
2220
- type GetFiatOnrampQuotesInput as GetFiatOnrampQuotesInput,
2221
- type FiatOnrampQuote as FiatOnrampQuote,
2222
- type FiatOnrampProviderError as FiatOnrampProviderError,
2223
- type GetFiatOnrampQuotesResponse as GetFiatOnrampQuotesResponse,
2224
- type GetFiatOnrampURLInput as GetFiatOnrampURLInput,
2225
- type GetFiatOnrampURLResponse as GetFiatOnrampURLResponse,
2226
- type FiatOnrampTransactionStatus as FiatOnrampTransactionStatus,
2227
- type GetFiatOnrampTransactionStatusInput as GetFiatOnrampTransactionStatusInput,
2228
- type GetFiatOnrampTransactionStatusResponse as GetFiatOnrampTransactionStatusResponse,
2229
- type BridgeDestinationAsset as BridgeDestinationAsset,
2230
- type BridgeSourceAsset as BridgeSourceAsset,
2231
- type BridgeFiatVirtualAccountSource as BridgeFiatVirtualAccountSource,
2232
- type BridgeFiatVirtualAccountDestination as BridgeFiatVirtualAccountDestination,
2233
- type BridgeFiatVirtualAccountRequest as BridgeFiatVirtualAccountRequest,
2234
- type BridgeSandboxFiatVirtualAccountRequest as BridgeSandboxFiatVirtualAccountRequest,
2235
- type FiatVirtualAccountRequest as FiatVirtualAccountRequest,
2236
- type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
2237
- type BridgeEurFiatVirtualAccountDepositInstructions as BridgeEurFiatVirtualAccountDepositInstructions,
2238
- type BridgeMxnFiatVirtualAccountDepositInstructions as BridgeMxnFiatVirtualAccountDepositInstructions,
2239
- type BridgeBrlFiatVirtualAccountDepositInstructions as BridgeBrlFiatVirtualAccountDepositInstructions,
2240
- type BridgeGbpFiatVirtualAccountDepositInstructions as BridgeGbpFiatVirtualAccountDepositInstructions,
2241
- type BridgeFiatVirtualAccountDepositInstructions as BridgeFiatVirtualAccountDepositInstructions,
2242
- type BridgeFiatVirtualAccountResponse as BridgeFiatVirtualAccountResponse,
2243
- type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
2244
- type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
2245
- type OAuthCodeType as OAuthCodeType,
2246
- type OAuthTransferUserInfoMeta as OAuthTransferUserInfoMeta,
2247
- type OAuthTransferUserInfo as OAuthTransferUserInfo,
2248
- type OAuthTransferRequestBody as OAuthTransferRequestBody,
2249
- type SiweInput as SiweInput,
2250
- type SmartWalletSiweInput as SmartWalletSiweInput,
2251
- type AuthenticateSiweInput as AuthenticateSiweInput,
2252
- type SiweAddressInput as SiweAddressInput,
2253
- type SiweInitInput as SiweInitInput,
2254
- type SiweNonce as SiweNonce,
2235
+ type TelegramWebAppData as TelegramWebAppData,
2236
+ type TransferFarcasterInput as TransferFarcasterInput,
2255
2237
  type TransferSiweInput as TransferSiweInput,
2256
- type SiwsInput as SiwsInput,
2257
- type AuthenticateSiwsInput as AuthenticateSiwsInput,
2258
- type SiwsAddressInput as SiwsAddressInput,
2259
- type SiwsInitInput as SiwsInitInput,
2260
- type SiwsNonce as SiwsNonce,
2261
2238
  type TransferSiwsInput as TransferSiwsInput,
2262
- type TelegramAuthResult as TelegramAuthResult,
2263
- type TelegramWebAppData as TelegramWebAppData,
2264
- type TelegramAuthenticateInput as TelegramAuthenticateInput,
2265
- type TelegramUnlinkInput as TelegramUnlinkInput,
2266
2239
  type TransferTelegramInput as TransferTelegramInput,
2267
- type FarcasterConnectInitResponse as FarcasterConnectInitResponse,
2268
- type FarcasterConnectStatusCompletedResponse as FarcasterConnectStatusCompletedResponse,
2269
- type FarcasterConnectStatusPendingResponse as FarcasterConnectStatusPendingResponse,
2270
- type FarcasterAuthenticateInput as FarcasterAuthenticateInput,
2271
- type FarcasterLinkInput as FarcasterLinkInput,
2272
- type FarcasterInitInput as FarcasterInitInput,
2273
- type FarcasterUnlinkInput as FarcasterUnlinkInput,
2274
- type TransferFarcasterInput as TransferFarcasterInput,
2275
- type FarcasterV2InitInput as FarcasterV2InitInput,
2276
- type FarcasterV2InitResponse as FarcasterV2InitResponse,
2277
- type FarcasterV2AuthenticateInput as FarcasterV2AuthenticateInput,
2278
- type FarcasterV2InitRequestBody as FarcasterV2InitRequestBody,
2279
- type FarcasterSignerInitPendingApproval as FarcasterSignerInitPendingApproval,
2280
- type FarcasterSignerApproved as FarcasterSignerApproved,
2281
- type FarcasterSignerRevoked as FarcasterSignerRevoked,
2282
- type FarcasterSignerStatusPendingApproval as FarcasterSignerStatusPendingApproval,
2283
- type MfaSMSInitVerifyInput as MfaSMSInitVerifyInput,
2284
- type MfaSMSInitEnrollInput as MfaSMSInitEnrollInput,
2240
+ type UnlinkPasskeyInput as UnlinkPasskeyInput,
2285
2241
  };
2286
2242
  }