@dynamic-labs/sdk-api-core 0.0.868 → 0.0.869

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.
@@ -1040,10 +1040,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1040
1040
  */
1041
1041
  authMfaPasskeyDeviceOptions(requestParameters: AuthMfaPasskeyDeviceOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1042
1042
  /**
1043
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
1043
1044
  * Upgrade JWT scope with valid MFA session
1044
1045
  */
1045
1046
  authMfaRecoveryRaw(requestParameters: AuthMfaRecoveryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1046
1047
  /**
1048
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
1047
1049
  * Upgrade JWT scope with valid MFA session
1048
1050
  */
1049
1051
  authMfaRecovery(requestParameters: AuthMfaRecoveryRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
@@ -1056,10 +1058,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1056
1058
  */
1057
1059
  authMfaRecoveryOptions(requestParameters: AuthMfaRecoveryOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1058
1060
  /**
1061
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
1059
1062
  * Upgrade JWT scope with valid MFA session
1060
1063
  */
1061
1064
  authMfaTotpDeviceRaw(requestParameters: AuthMfaTotpDeviceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1062
1065
  /**
1066
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
1063
1067
  * Upgrade JWT scope with valid MFA session
1064
1068
  */
1065
1069
  authMfaTotpDevice(requestParameters: AuthMfaTotpDeviceRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
@@ -1072,18 +1076,22 @@ export declare class SDKApi extends runtime.BaseAPI {
1072
1076
  */
1073
1077
  authMfaTotpDeviceOptions(requestParameters: AuthMfaTotpDeviceOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1074
1078
  /**
1079
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
1075
1080
  * Upgrade JWT scope with valid MFA session
1076
1081
  */
1077
1082
  authenticateMfaEmailRaw(requestParameters: AuthenticateMfaEmailRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1078
1083
  /**
1084
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
1079
1085
  * Upgrade JWT scope with valid MFA session
1080
1086
  */
1081
1087
  authenticateMfaEmail(requestParameters: AuthenticateMfaEmailRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
1082
1088
  /**
1089
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
1083
1090
  * Upgrade JWT scope with valid MFA session
1084
1091
  */
1085
1092
  authenticateMfaPasskeyDeviceRaw(requestParameters: AuthenticateMfaPasskeyDeviceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1086
1093
  /**
1094
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
1087
1095
  * Upgrade JWT scope with valid MFA session
1088
1096
  */
1089
1097
  authenticateMfaPasskeyDevice(requestParameters: AuthenticateMfaPasskeyDeviceRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
@@ -1096,11 +1104,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1096
1104
  */
1097
1105
  authenticatePasskeyOptions(requestParameters: AuthenticatePasskeyOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1098
1106
  /**
1099
- * Backup multiple keyShares for a waaS wallet
1107
+ * Backs up the client key shares for the specified WAAS wallet.
1108
+ * Back up keyshares for a WAAS wallet
1100
1109
  */
1101
1110
  backupKeySharesRaw(requestParameters: BackupKeySharesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BackupMultipleClientKeySharesResponse>>;
1102
1111
  /**
1103
- * Backup multiple keyShares for a waaS wallet
1112
+ * Backs up the client key shares for the specified WAAS wallet.
1113
+ * Back up keyshares for a WAAS wallet
1104
1114
  */
1105
1115
  backupKeyShares(requestParameters: BackupKeySharesRequest, initOverrides?: RequestInit): Promise<BackupMultipleClientKeySharesResponse>;
1106
1116
  /**
@@ -1112,11 +1122,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1112
1122
  */
1113
1123
  backupKeySharesOptions(requestParameters: BackupKeySharesOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1114
1124
  /**
1115
- * Backup multiple keyShares for a waaS wallet to Google Drive
1125
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
1126
+ * Back up keyshares to Google Drive
1116
1127
  */
1117
1128
  backupKeySharesToGoogleDriveRaw(requestParameters: BackupKeySharesToGoogleDriveRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BackupMultipleClientKeySharesResponse>>;
1118
1129
  /**
1119
- * Backup multiple keyShares for a waaS wallet to Google Drive
1130
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
1131
+ * Back up keyshares to Google Drive
1120
1132
  */
1121
1133
  backupKeySharesToGoogleDrive(requestParameters: BackupKeySharesToGoogleDriveRequest, initOverrides?: RequestInit): Promise<BackupMultipleClientKeySharesResponse>;
1122
1134
  /**
@@ -1128,10 +1140,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1128
1140
  */
1129
1141
  backupKeySharesToGoogleDriveOptions(requestParameters: BackupKeySharesToGoogleDriveOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1130
1142
  /**
1143
+ * Records a backup action and event for the specified location without performing the actual backup.
1131
1144
  * Create backup action and event for a specified location without performing actual backup
1132
1145
  */
1133
1146
  backupKeySharesToLocationRaw(requestParameters: BackupKeySharesToLocationOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BackupKeySharesToLocationResponse>>;
1134
1147
  /**
1148
+ * Records a backup action and event for the specified location without performing the actual backup.
1135
1149
  * Create backup action and event for a specified location without performing actual backup
1136
1150
  */
1137
1151
  backupKeySharesToLocation(requestParameters: BackupKeySharesToLocationOperationRequest, initOverrides?: RequestInit): Promise<BackupKeySharesToLocationResponse>;
@@ -1144,10 +1158,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1144
1158
  */
1145
1159
  backupKeySharesToLocationOptions(requestParameters: BackupKeySharesToLocationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1146
1160
  /**
1161
+ * Records backup actions and events for multiple locations without performing the actual backups.
1147
1162
  * Create backup action and event for multiple locations without performing actual backup
1148
1163
  */
1149
1164
  backupKeySharesToLocationsRaw(requestParameters: BackupKeySharesToLocationsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BackupKeySharesToLocationsResponse>>;
1150
1165
  /**
1166
+ * Records backup actions and events for multiple locations without performing the actual backups.
1151
1167
  * Create backup action and event for multiple locations without performing actual backup
1152
1168
  */
1153
1169
  backupKeySharesToLocations(requestParameters: BackupKeySharesToLocationsOperationRequest, initOverrides?: RequestInit): Promise<BackupKeySharesToLocationsResponse>;
@@ -1161,12 +1177,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1161
1177
  backupKeySharesToLocationsOptions(requestParameters: BackupKeySharesToLocationsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1162
1178
  /**
1163
1179
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
1164
- * Redirect URL for sign-in with coinbase
1180
+ * Handle Coinbase OAuth redirect
1165
1181
  */
1166
1182
  cbOauthRedirectRaw(requestParameters: CbOauthRedirectRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
1167
1183
  /**
1168
1184
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
1169
- * Redirect URL for sign-in with coinbase
1185
+ * Handle Coinbase OAuth redirect
1170
1186
  */
1171
1187
  cbOauthRedirect(requestParameters: CbOauthRedirectRequest, initOverrides?: RequestInit): Promise<string>;
1172
1188
  /**
@@ -1206,10 +1222,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1206
1222
  */
1207
1223
  checkWalletSanctionsOptions(requestParameters: CheckWalletSanctionsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1208
1224
  /**
1225
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
1209
1226
  * Claim a pregenerated embedded wallet
1210
1227
  */
1211
1228
  claimEmbeddedWalletRaw(requestParameters: ClaimEmbeddedWalletRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1212
1229
  /**
1230
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
1213
1231
  * Claim a pregenerated embedded wallet
1214
1232
  */
1215
1233
  claimEmbeddedWallet(requestParameters: ClaimEmbeddedWalletRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
@@ -1247,19 +1265,21 @@ export declare class SDKApi extends runtime.BaseAPI {
1247
1265
  coinbaseOrdersOptions(requestParameters: CoinbaseOrdersOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1248
1266
  /**
1249
1267
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1250
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1268
+ * Complete passkey recovery for an embedded wallet
1251
1269
  */
1252
1270
  completePasskeyRecoveryRaw(requestParameters: CompletePasskeyRecoveryOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1253
1271
  /**
1254
1272
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1255
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1273
+ * Complete passkey recovery for an embedded wallet
1256
1274
  */
1257
1275
  completePasskeyRecovery(requestParameters: CompletePasskeyRecoveryOperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
1258
1276
  /**
1277
+ * Creates a new Coinbase onramp order for the authenticated user.
1259
1278
  * Create a Coinbase onramp order
1260
1279
  */
1261
1280
  createCoinbaseOnrampOrderRaw(requestParameters: CreateCoinbaseOnrampOrderRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<CoinbaseOnrampOrderResponse>>;
1262
1281
  /**
1282
+ * Creates a new Coinbase onramp order for the authenticated user.
1263
1283
  * Create a Coinbase onramp order
1264
1284
  */
1265
1285
  createCoinbaseOnrampOrder(requestParameters: CreateCoinbaseOnrampOrderRequest, initOverrides?: RequestInit): Promise<CoinbaseOnrampOrderResponse>;
@@ -1274,10 +1294,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1274
1294
  */
1275
1295
  createCryptoDotComPayment(requestParameters: CreateCryptoDotComPaymentRequest, initOverrides?: RequestInit): Promise<CryptoDotComPaymentResponse>;
1276
1296
  /**
1297
+ * Initiates the email verification process and sends a verification code.
1277
1298
  * Initialize email verification process
1278
1299
  */
1279
1300
  createEmailVerificationRaw(requestParameters: CreateEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmailVerificationCreateResponse>>;
1280
1301
  /**
1302
+ * Initiates the email verification process and sends a verification code.
1281
1303
  * Initialize email verification process
1282
1304
  */
1283
1305
  createEmailVerification(requestParameters: CreateEmailVerificationRequest, initOverrides?: RequestInit): Promise<EmailVerificationCreateResponse>;
@@ -1308,26 +1330,32 @@ export declare class SDKApi extends runtime.BaseAPI {
1308
1330
  */
1309
1331
  createEmbeddedWalletsOptions(requestParameters: CreateEmbeddedWalletsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1310
1332
  /**
1311
- * Track a global wallet connection
1333
+ * Creates a new global wallet connection for the authenticated user.
1334
+ * Create a global wallet connection
1312
1335
  */
1313
1336
  createGlobalWalletConnectionRaw(requestParameters: CreateGlobalWalletConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GlobalWalletConnection>>;
1314
1337
  /**
1315
- * Track a global wallet connection
1338
+ * Creates a new global wallet connection for the authenticated user.
1339
+ * Create a global wallet connection
1316
1340
  */
1317
1341
  createGlobalWalletConnection(requestParameters: CreateGlobalWalletConnectionRequest, initOverrides?: RequestInit): Promise<GlobalWalletConnection>;
1318
1342
  /**
1319
- * Generate new recovery codes for user
1343
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1344
+ * Generate new recovery codes
1320
1345
  */
1321
1346
  createNewRecoveryCodesRaw(requestParameters: CreateNewRecoveryCodesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFARegenRecoveryCodesResponse>>;
1322
1347
  /**
1323
- * Generate new recovery codes for user
1348
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1349
+ * Generate new recovery codes
1324
1350
  */
1325
1351
  createNewRecoveryCodes(requestParameters: CreateNewRecoveryCodesRequest, initOverrides?: RequestInit): Promise<MFARegenRecoveryCodesResponse>;
1326
1352
  /**
1353
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1327
1354
  * Create rooms for a waas mpc ceremony
1328
1355
  */
1329
1356
  createRoomsRaw(requestParameters: CreateRoomsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<CreateRoomsResponse>>;
1330
1357
  /**
1358
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1331
1359
  * Create rooms for a waas mpc ceremony
1332
1360
  */
1333
1361
  createRooms(requestParameters: CreateRoomsOperationRequest, initOverrides?: RequestInit): Promise<CreateRoomsResponse>;
@@ -1340,10 +1368,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1340
1368
  */
1341
1369
  createRoomsOptions(requestParameters: CreateRoomsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1342
1370
  /**
1371
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1343
1372
  * Create rooms for a waas mpc ceremony without a walletId
1344
1373
  */
1345
1374
  createRoomsWithoutWalletIdRaw(requestParameters: CreateRoomsWithoutWalletIdOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<CreateRoomsWithoutWalletIdResponse>>;
1346
1375
  /**
1376
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1347
1377
  * Create rooms for a waas mpc ceremony without a walletId
1348
1378
  */
1349
1379
  createRoomsWithoutWalletId(requestParameters: CreateRoomsWithoutWalletIdOperationRequest, initOverrides?: RequestInit): Promise<CreateRoomsWithoutWalletIdResponse>;
@@ -1356,11 +1386,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1356
1386
  */
1357
1387
  createRoomsWithoutWalletIdOptions(requestParameters: CreateRoomsWithoutWalletIdOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1358
1388
  /**
1359
- * Initialize sms verification process
1389
+ * Initiates the SMS verification process and sends a verification code.
1390
+ * Initialize SMS verification process
1360
1391
  */
1361
1392
  createSmsVerificationRaw(requestParameters: CreateSmsVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SmsVerificationCreateResponse>>;
1362
1393
  /**
1363
- * Initialize sms verification process
1394
+ * Initiates the SMS verification process and sends a verification code.
1395
+ * Initialize SMS verification process
1364
1396
  */
1365
1397
  createSmsVerification(requestParameters: CreateSmsVerificationRequest, initOverrides?: RequestInit): Promise<SmsVerificationCreateResponse>;
1366
1398
  /**
@@ -1383,12 +1415,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1383
1415
  createVisit(requestParameters: CreateVisitRequest, initOverrides?: RequestInit): Promise<void>;
1384
1416
  /**
1385
1417
  * Create a new waas account
1386
- * Create a new waas account
1418
+ * Create a WAAS wallet
1387
1419
  */
1388
1420
  createWaasAccountRaw(requestParameters: CreateWaasAccountOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OpenRoomResponseWithServerKeygenIds>>;
1389
1421
  /**
1390
1422
  * Create a new waas account
1391
- * Create a new waas account
1423
+ * Create a WAAS wallet
1392
1424
  */
1393
1425
  createWaasAccount(requestParameters: CreateWaasAccountOperationRequest, initOverrides?: RequestInit): Promise<OpenRoomResponseWithServerKeygenIds>;
1394
1426
  /**
@@ -1419,27 +1451,31 @@ export declare class SDKApi extends runtime.BaseAPI {
1419
1451
  cryptoDotComPaymentOptions(requestParameters: CryptoDotComPaymentOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1420
1452
  /**
1421
1453
  * Deletes the embedded wallets for a user
1422
- * Deletes the embedded wallets for a user
1454
+ * Delete embedded wallets for a user
1423
1455
  */
1424
1456
  deleteEmbeddedWalletsRaw(requestParameters: DeleteEmbeddedWalletsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
1425
1457
  /**
1426
1458
  * Deletes the embedded wallets for a user
1427
- * Deletes the embedded wallets for a user
1459
+ * Delete embedded wallets for a user
1428
1460
  */
1429
1461
  deleteEmbeddedWallets(requestParameters: DeleteEmbeddedWalletsOperationRequest, initOverrides?: RequestInit): Promise<void>;
1430
1462
  /**
1431
- * Delete a device (if not default device)
1463
+ * Permanently removes an MFA device from the authenticated user account.
1464
+ * Delete an MFA device
1432
1465
  */
1433
1466
  deleteMfaDeviceRaw(requestParameters: DeleteMfaDeviceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
1434
1467
  /**
1435
- * Delete a device (if not default device)
1468
+ * Permanently removes an MFA device from the authenticated user account.
1469
+ * Delete an MFA device
1436
1470
  */
1437
1471
  deleteMfaDevice(requestParameters: DeleteMfaDeviceRequest, initOverrides?: RequestInit): Promise<void>;
1438
1472
  /**
1473
+ * Permanently removes a passkey from the authenticated user account.
1439
1474
  * Delete a passkey
1440
1475
  */
1441
1476
  deletePasskeyRaw(requestParameters: DeletePasskeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
1442
1477
  /**
1478
+ * Permanently removes a passkey from the authenticated user account.
1443
1479
  * Delete a passkey
1444
1480
  */
1445
1481
  deletePasskey(requestParameters: DeletePasskeyRequest, initOverrides?: RequestInit): Promise<void>;
@@ -1462,11 +1498,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1462
1498
  */
1463
1499
  deliverDelegatedShareOptions(requestParameters: DeliverDelegatedShareOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1464
1500
  /**
1465
- * Set a global wallet connection as disconnected
1501
+ * Disconnects the specified global wallet connection.
1502
+ * Disconnect a global wallet connection
1466
1503
  */
1467
1504
  disconnectGlobalWalletConnectionRaw(requestParameters: DisconnectGlobalWalletConnectionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GlobalWalletConnection>>;
1468
1505
  /**
1469
- * Set a global wallet connection as disconnected
1506
+ * Disconnects the specified global wallet connection.
1507
+ * Disconnect a global wallet connection
1470
1508
  */
1471
1509
  disconnectGlobalWalletConnection(requestParameters: DisconnectGlobalWalletConnectionRequest, initOverrides?: RequestInit): Promise<GlobalWalletConnection>;
1472
1510
  /**
@@ -1526,11 +1564,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1526
1564
  */
1527
1565
  eventsOptions(requestParameters: EventsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1528
1566
  /**
1529
- * Export private Key of a waas account
1567
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
1568
+ * Export a WAAS wallet private key
1530
1569
  */
1531
1570
  exportPrivateKeyRaw(requestParameters: ExportPrivateKeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OpenRoomResponseWithServerKeygenIds>>;
1532
1571
  /**
1533
- * Export private Key of a waas account
1572
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
1573
+ * Export a WAAS wallet private key
1534
1574
  */
1535
1575
  exportPrivateKey(requestParameters: ExportPrivateKeyRequest, initOverrides?: RequestInit): Promise<OpenRoomResponseWithServerKeygenIds>;
1536
1576
  /**
@@ -1542,11 +1582,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1542
1582
  */
1543
1583
  exportPrivateKeyOptions(requestParameters: ExportPrivateKeyOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1544
1584
  /**
1545
- * Endpoint to sign-in using a token issued by an external auth provider
1585
+ * Authenticates a user using a token from an external auth provider.
1586
+ * Sign in with an external auth provider token
1546
1587
  */
1547
1588
  externalAuthSigninRaw(requestParameters: ExternalAuthSigninOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1548
1589
  /**
1549
- * Endpoint to sign-in using a token issued by an external auth provider
1590
+ * Authenticates a user using a token from an external auth provider.
1591
+ * Sign in with an external auth provider token
1550
1592
  */
1551
1593
  externalAuthSignin(requestParameters: ExternalAuthSigninOperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
1552
1594
  /**
@@ -1558,10 +1600,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1558
1600
  */
1559
1601
  externalAuthSigninOptions(requestParameters: ExternalAuthSigninOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1560
1602
  /**
1603
+ * [DEPRECATED] Please use /externalAuth/signin instead.
1561
1604
  * [DEPRECATED] Please use /externalAuth/signin instead
1562
1605
  */
1563
1606
  externalAuthVerifyRaw(requestParameters: ExternalAuthVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
1564
1607
  /**
1608
+ * [DEPRECATED] Please use /externalAuth/signin instead.
1565
1609
  * [DEPRECATED] Please use /externalAuth/signin instead
1566
1610
  */
1567
1611
  externalAuthVerify(requestParameters: ExternalAuthVerifyRequest, initOverrides?: RequestInit): Promise<void>;
@@ -1575,12 +1619,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1575
1619
  externalAuthVerifyOptions(requestParameters: ExternalAuthVerifyOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1576
1620
  /**
1577
1621
  * Farcaster SignIn endpoint to exchange SIWF data
1578
- * Farcaster provider SignIn endpoint
1622
+ * Sign in with Farcaster
1579
1623
  */
1580
1624
  farcasterSignInRaw(requestParameters: FarcasterSignInOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1581
1625
  /**
1582
1626
  * Farcaster SignIn endpoint to exchange SIWF data
1583
- * Farcaster provider SignIn endpoint
1627
+ * Sign in with Farcaster
1584
1628
  */
1585
1629
  farcasterSignIn(requestParameters: FarcasterSignInOperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
1586
1630
  /**
@@ -1593,12 +1637,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1593
1637
  farcasterSignInOptions(requestParameters: FarcasterSignInOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1594
1638
  /**
1595
1639
  * Farcaster Verify endpoint to exchange SIWF data
1596
- * Farcaster provider Verify endpoint
1640
+ * Verify Farcaster account linking
1597
1641
  */
1598
1642
  farcasterVerifyRaw(requestParameters: FarcasterVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
1599
1643
  /**
1600
1644
  * Farcaster Verify endpoint to exchange SIWF data
1601
- * Farcaster provider Verify endpoint
1645
+ * Verify Farcaster account linking
1602
1646
  */
1603
1647
  farcasterVerify(requestParameters: FarcasterVerifyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
1604
1648
  /**
@@ -1610,19 +1654,23 @@ export declare class SDKApi extends runtime.BaseAPI {
1610
1654
  */
1611
1655
  farcasterVerifyOptions(requestParameters: FarcasterVerifyOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1612
1656
  /**
1657
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
1613
1658
  * Generate a Coinbase onramp buy URL
1614
1659
  */
1615
1660
  generateCoinbaseOnrampBuyUrlRaw(requestParameters: GenerateCoinbaseOnrampBuyUrlRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<CoinbaseOnrampGetBuyUrlResponse>>;
1616
1661
  /**
1662
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
1617
1663
  * Generate a Coinbase onramp buy URL
1618
1664
  */
1619
1665
  generateCoinbaseOnrampBuyUrl(requestParameters: GenerateCoinbaseOnrampBuyUrlRequest, initOverrides?: RequestInit): Promise<CoinbaseOnrampGetBuyUrlResponse>;
1620
1666
  /**
1621
- * Get the token balances for an account
1667
+ * Returns the token balances for a specific account address on a given chain.
1668
+ * Get token balances for an account
1622
1669
  */
1623
1670
  getAccountBalancesRaw(requestParameters: GetAccountBalancesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<TokenBalance>>>;
1624
1671
  /**
1625
- * Get the token balances for an account
1672
+ * Returns the token balances for a specific account address on a given chain.
1673
+ * Get token balances for an account
1626
1674
  */
1627
1675
  getAccountBalances(requestParameters: GetAccountBalancesRequest, initOverrides?: RequestInit): Promise<Array<TokenBalance>>;
1628
1676
  /**
@@ -1634,11 +1682,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1634
1682
  */
1635
1683
  getAccountBalancesOptions(requestParameters: GetAccountBalancesOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1636
1684
  /**
1637
- * Get auth token for given embedded wallet type
1685
+ * Returns an auth token for the specified embedded wallet type.
1686
+ * Get an auth token for an embedded wallet type
1638
1687
  */
1639
1688
  getAuthTokenRaw(requestParameters: GetAuthTokenRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmbeddedWalletAuthToken>>;
1640
1689
  /**
1641
- * Get auth token for given embedded wallet type
1690
+ * Returns an auth token for the specified embedded wallet type.
1691
+ * Get an auth token for an embedded wallet type
1642
1692
  */
1643
1693
  getAuthToken(requestParameters: GetAuthTokenRequest, initOverrides?: RequestInit): Promise<EmbeddedWalletAuthToken>;
1644
1694
  /**
@@ -1650,11 +1700,13 @@ export declare class SDKApi extends runtime.BaseAPI {
1650
1700
  */
1651
1701
  getAuthTokenOpts(requestParameters: GetAuthTokenOptsRequest, initOverrides?: RequestInit): Promise<void>;
1652
1702
  /**
1653
- * Fetch user profile for the current authenticated user
1703
+ * Returns the full profile of the currently authenticated user.
1704
+ * Get the current user\'s profile
1654
1705
  */
1655
1706
  getAuthenticatedUserRaw(requestParameters: GetAuthenticatedUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SdkUser>>;
1656
1707
  /**
1657
- * Fetch user profile for the current authenticated user
1708
+ * Returns the full profile of the currently authenticated user.
1709
+ * Get the current user\'s profile
1658
1710
  */
1659
1711
  getAuthenticatedUser(requestParameters: GetAuthenticatedUserRequest, initOverrides?: RequestInit): Promise<SdkUser>;
1660
1712
  /**
@@ -1687,20 +1739,22 @@ export declare class SDKApi extends runtime.BaseAPI {
1687
1739
  getCoinbaseSupportedNetworks(requestParameters: GetCoinbaseSupportedNetworksRequest, initOverrides?: RequestInit): Promise<Array<string>>;
1688
1740
  /**
1689
1741
  * Generates the request body for a user\'s create V2 wallet account request
1690
- * Generates the request body for a user\'s create V2 wallet account request
1742
+ * Generate the create wallet account request body
1691
1743
  */
1692
1744
  getCreateWalletAccountRequestRaw(requestParameters: GetCreateWalletAccountRequestRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TurnkeyCreateWalletAccountsRequestBody>>;
1693
1745
  /**
1694
1746
  * Generates the request body for a user\'s create V2 wallet account request
1695
- * Generates the request body for a user\'s create V2 wallet account request
1747
+ * Generate the create wallet account request body
1696
1748
  */
1697
1749
  getCreateWalletAccountRequest(requestParameters: GetCreateWalletAccountRequestRequest, initOverrides?: RequestInit): Promise<TurnkeyCreateWalletAccountsRequestBody>;
1698
1750
  /**
1699
1751
  * Exchange rates for the given currency
1752
+ * Get currency exchange rates
1700
1753
  */
1701
1754
  getCurrencyExchangeRatesRaw(requestParameters: GetCurrencyExchangeRatesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Currency>>>;
1702
1755
  /**
1703
1756
  * Exchange rates for the given currency
1757
+ * Get currency exchange rates
1704
1758
  */
1705
1759
  getCurrencyExchangeRates(requestParameters: GetCurrencyExchangeRatesRequest, initOverrides?: RequestInit): Promise<Array<Currency>>;
1706
1760
  /**
@@ -1713,12 +1767,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1713
1767
  getCurrencyExchangeRatesOptions(requestParameters: GetCurrencyExchangeRatesOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1714
1768
  /**
1715
1769
  * Return the email provider to be used for signing in with a given email. If an external provider such as magicLink is disabled, this endpoint would return emailOnly. If an external provider such as magicLink is enabled, it will return emailOnly when the email already exists in Dynamic and it is associated with a wallet, otherwise it will return magicLink.
1716
- * Get signin email provider
1770
+ * Get the sign-in email provider
1717
1771
  */
1718
1772
  getEmailProviderRaw(requestParameters: GetEmailProviderRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmailProviderResponse>>;
1719
1773
  /**
1720
1774
  * Return the email provider to be used for signing in with a given email. If an external provider such as magicLink is disabled, this endpoint would return emailOnly. If an external provider such as magicLink is enabled, it will return emailOnly when the email already exists in Dynamic and it is associated with a wallet, otherwise it will return magicLink.
1721
- * Get signin email provider
1775
+ * Get the sign-in email provider
1722
1776
  */
1723
1777
  getEmailProvider(requestParameters: GetEmailProviderRequest, initOverrides?: RequestInit): Promise<EmailProviderResponse>;
1724
1778
  /**
@@ -1730,19 +1784,23 @@ export declare class SDKApi extends runtime.BaseAPI {
1730
1784
  */
1731
1785
  getEmbeddedWalletBackupOption(requestParameters: GetEmbeddedWalletBackupOptionRequest, initOverrides?: RequestInit): Promise<void>;
1732
1786
  /**
1733
- * Return the backup key for the embedded wallet of the authenticated user
1787
+ * Returns the backup key for an embedded wallet.
1788
+ * Get the backup key for an embedded wallet
1734
1789
  */
1735
1790
  getEmbeddedWalletBackupsRaw(requestParameters: GetEmbeddedWalletBackupsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmbeddedWalletSecret>>;
1736
1791
  /**
1737
- * Return the backup key for the embedded wallet of the authenticated user
1792
+ * Returns the backup key for an embedded wallet.
1793
+ * Get the backup key for an embedded wallet
1738
1794
  */
1739
1795
  getEmbeddedWalletBackups(requestParameters: GetEmbeddedWalletBackupsRequest, initOverrides?: RequestInit): Promise<EmbeddedWalletSecret>;
1740
1796
  /**
1741
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
1797
+ * Returns the passcode for a pregenerated embedded wallet.
1798
+ * Get the passcode for a pregenerated embedded wallet
1742
1799
  */
1743
1800
  getEmbeddedWalletPasscodeRaw(requestParameters: GetEmbeddedWalletPasscodeRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmbeddedWalletSecret>>;
1744
1801
  /**
1745
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
1802
+ * Returns the passcode for a pregenerated embedded wallet.
1803
+ * Get the passcode for a pregenerated embedded wallet
1746
1804
  */
1747
1805
  getEmbeddedWalletPasscode(requestParameters: GetEmbeddedWalletPasscodeRequest, initOverrides?: RequestInit): Promise<EmbeddedWalletSecret>;
1748
1806
  /**
@@ -1755,19 +1813,21 @@ export declare class SDKApi extends runtime.BaseAPI {
1755
1813
  getEmbeddedWalletPasscodeOption(requestParameters: GetEmbeddedWalletPasscodeOptionRequest, initOverrides?: RequestInit): Promise<void>;
1756
1814
  /**
1757
1815
  * Generates the request body for a user\'s delete V2 wallets request
1758
- * Generates the request body for a user\'s delete V2 wallets request
1816
+ * Generate the delete wallets request body
1759
1817
  */
1760
1818
  getEmbeddedWalletsDeleteRequestRaw(requestParameters: GetEmbeddedWalletsDeleteRequestRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TurnkeyDeleteEmbeddedWalletsRequestBody>>;
1761
1819
  /**
1762
1820
  * Generates the request body for a user\'s delete V2 wallets request
1763
- * Generates the request body for a user\'s delete V2 wallets request
1821
+ * Generate the delete wallets request body
1764
1822
  */
1765
1823
  getEmbeddedWalletsDeleteRequest(requestParameters: GetEmbeddedWalletsDeleteRequestRequest, initOverrides?: RequestInit): Promise<TurnkeyDeleteEmbeddedWalletsRequestBody>;
1766
1824
  /**
1825
+ * Returns the OAuth access token for the specified user OAuth account.
1767
1826
  * Get the access token for a user OAuth account
1768
1827
  */
1769
1828
  getEndUserOauthAccessTokenRaw(requestParameters: GetEndUserOauthAccessTokenRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserOauthAccessTokenResponse>>;
1770
1829
  /**
1830
+ * Returns the OAuth access token for the specified user OAuth account.
1771
1831
  * Get the access token for a user OAuth account
1772
1832
  */
1773
1833
  getEndUserOauthAccessToken(requestParameters: GetEndUserOauthAccessTokenRequest, initOverrides?: RequestInit): Promise<UserOauthAccessTokenResponse>;
@@ -1780,18 +1840,22 @@ export declare class SDKApi extends runtime.BaseAPI {
1780
1840
  */
1781
1841
  getEndUserOauthAccessTokenOptions(requestParameters: GetEndUserOauthAccessTokenOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1782
1842
  /**
1783
- * Get the environment\'s settings
1843
+ * Returns the project settings and configuration for the specified environment.
1844
+ * Get environment settings
1784
1845
  */
1785
1846
  getEnvironmentSettingsRaw(requestParameters: GetEnvironmentSettingsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ProjectSettings>>;
1786
1847
  /**
1787
- * Get the environment\'s settings
1848
+ * Returns the project settings and configuration for the specified environment.
1849
+ * Get environment settings
1788
1850
  */
1789
1851
  getEnvironmentSettings(requestParameters: GetEnvironmentSettingsRequest, initOverrides?: RequestInit): Promise<ProjectSettings>;
1790
1852
  /**
1853
+ * Returns the exchange account transactions for the authenticated user.
1791
1854
  * Get the exchange account transactions for a given dynamic user
1792
1855
  */
1793
1856
  getExchangeTransactionsRaw(requestParameters: GetExchangeTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<ExchangeTransaction>>>;
1794
1857
  /**
1858
+ * Returns the exchange account transactions for the authenticated user.
1795
1859
  * Get the exchange account transactions for a given dynamic user
1796
1860
  */
1797
1861
  getExchangeTransactions(requestParameters: GetExchangeTransactionsRequest, initOverrides?: RequestInit): Promise<Array<ExchangeTransaction>>;
@@ -1804,10 +1868,12 @@ export declare class SDKApi extends runtime.BaseAPI {
1804
1868
  */
1805
1869
  getExchangeTransactionsOptions(requestParameters: GetExchangeTransactionsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1806
1870
  /**
1871
+ * Returns the available transfer destinations for exchange account transactions.
1807
1872
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
1808
1873
  */
1809
1874
  getExchangeTransferDestinationsRaw(requestParameters: GetExchangeTransferDestinationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransferDestinationResponse>>;
1810
1875
  /**
1876
+ * Returns the available transfer destinations for exchange account transactions.
1811
1877
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
1812
1878
  */
1813
1879
  getExchangeTransferDestinations(requestParameters: GetExchangeTransferDestinationsRequest, initOverrides?: RequestInit): Promise<TransferDestinationResponse>;
@@ -1820,19 +1886,23 @@ export declare class SDKApi extends runtime.BaseAPI {
1820
1886
  */
1821
1887
  getExchangeTransferDestinationsOptions(requestParameters: GetExchangeTransferDestinationsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1822
1888
  /**
1889
+ * Returns the global wallet settings configured for the specified environment.
1823
1890
  * Get the global wallet settings for the environment
1824
1891
  */
1825
1892
  getGlobalWalletsSettingsRaw(requestParameters: GetGlobalWalletsSettingsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GlobalWalletSettings>>;
1826
1893
  /**
1894
+ * Returns the global wallet settings configured for the specified environment.
1827
1895
  * Get the global wallet settings for the environment
1828
1896
  */
1829
1897
  getGlobalWalletsSettings(requestParameters: GetGlobalWalletsSettingsRequest, initOverrides?: RequestInit): Promise<GlobalWalletSettings>;
1830
1898
  /**
1831
1899
  * Health check endpoint to check for uptime of API.
1900
+ * Check API health
1832
1901
  */
1833
1902
  getHealthcheckRaw(requestParameters: GetHealthcheckRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<HealthcheckResponse>>;
1834
1903
  /**
1835
1904
  * Health check endpoint to check for uptime of API.
1905
+ * Check API health
1836
1906
  */
1837
1907
  getHealthcheck(requestParameters: GetHealthcheckRequest, initOverrides?: RequestInit): Promise<HealthcheckResponse>;
1838
1908
  /**
@@ -1844,27 +1914,33 @@ export declare class SDKApi extends runtime.BaseAPI {
1844
1914
  */
1845
1915
  getHealthcheckOptions(requestParameters: GetHealthcheckOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1846
1916
  /**
1847
- * Find jwks for public key
1917
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
1918
+ * Get JWKS for the environment
1848
1919
  */
1849
1920
  getJwksByEnvironmentIdRaw(requestParameters: GetJwksByEnvironmentIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<JwksResponse>>;
1850
1921
  /**
1851
- * Find jwks for public key
1922
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
1923
+ * Get JWKS for the environment
1852
1924
  */
1853
1925
  getJwksByEnvironmentId(requestParameters: GetJwksByEnvironmentIdRequest, initOverrides?: RequestInit): Promise<JwksResponse>;
1854
1926
  /**
1855
- * Find jwks for public key (JSON format)
1927
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
1928
+ * Get JWKS for the environment (JSON format)
1856
1929
  */
1857
1930
  getJwksJsonByEnvironmentIdRaw(requestParameters: GetJwksJsonByEnvironmentIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<JwksResponse>>;
1858
1931
  /**
1859
- * Find jwks for public key (JSON format)
1932
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
1933
+ * Get JWKS for the environment (JSON format)
1860
1934
  */
1861
1935
  getJwksJsonByEnvironmentId(requestParameters: GetJwksJsonByEnvironmentIdRequest, initOverrides?: RequestInit): Promise<JwksResponse>;
1862
1936
  /**
1863
- * Get the current user\'s MFA by device id
1937
+ * Returns details of a specific MFA device by its ID.
1938
+ * Get an MFA device by ID
1864
1939
  */
1865
1940
  getMfaDeviceRaw(requestParameters: GetMfaDeviceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFADevice>>;
1866
1941
  /**
1867
- * Get the current user\'s MFA by device id
1942
+ * Returns details of a specific MFA device by its ID.
1943
+ * Get an MFA device by ID
1868
1944
  */
1869
1945
  getMfaDevice(requestParameters: GetMfaDeviceRequest, initOverrides?: RequestInit): Promise<MFADevice>;
1870
1946
  /**
@@ -1876,27 +1952,33 @@ export declare class SDKApi extends runtime.BaseAPI {
1876
1952
  */
1877
1953
  getMfaDeviceOptions(requestParameters: GetMfaDeviceOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1878
1954
  /**
1879
- * Find the configuration for the enabled networks associated to an environment
1955
+ * Returns the network configurations enabled for the specified environment.
1956
+ * Get network configurations for the environment
1880
1957
  */
1881
1958
  getNetworksConfigurationByEnvIdRaw(requestParameters: GetNetworksConfigurationByEnvIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<NetworkConfigurationResponse>>>;
1882
1959
  /**
1883
- * Find the configuration for the enabled networks associated to an environment
1960
+ * Returns the network configurations enabled for the specified environment.
1961
+ * Get network configurations for the environment
1884
1962
  */
1885
1963
  getNetworksConfigurationByEnvId(requestParameters: GetNetworksConfigurationByEnvIdRequest, initOverrides?: RequestInit): Promise<Array<NetworkConfigurationResponse>>;
1886
1964
  /**
1965
+ * Creates and returns a nonce for use in the wallet authentication flow.
1887
1966
  * Create nonce for authentication flow
1888
1967
  */
1889
1968
  getNonceRaw(requestParameters: GetNonceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonceResponse>>;
1890
1969
  /**
1970
+ * Creates and returns a nonce for use in the wallet authentication flow.
1891
1971
  * Create nonce for authentication flow
1892
1972
  */
1893
1973
  getNonce(requestParameters: GetNonceRequest, initOverrides?: RequestInit): Promise<NonceResponse>;
1894
1974
  /**
1895
- * Gets passkey authentication options
1975
+ * Returns the WebAuthn authentication options for passkey verification.
1976
+ * Get passkey authentication options
1896
1977
  */
1897
1978
  getPasskeyAuthenticationOptionsRaw(requestParameters: GetPasskeyAuthenticationOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetPasskeyAuthenticationOptionsResponse>>;
1898
1979
  /**
1899
- * Gets passkey authentication options
1980
+ * Returns the WebAuthn authentication options for passkey verification.
1981
+ * Get passkey authentication options
1900
1982
  */
1901
1983
  getPasskeyAuthenticationOptions(requestParameters: GetPasskeyAuthenticationOptionsRequest, initOverrides?: RequestInit): Promise<GetPasskeyAuthenticationOptionsResponse>;
1902
1984
  /**
@@ -1908,19 +1990,23 @@ export declare class SDKApi extends runtime.BaseAPI {
1908
1990
  */
1909
1991
  getPasskeyAuthenticationOptionsOptions(requestParameters: GetPasskeyAuthenticationOptionsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1910
1992
  /**
1911
- * Gets passkey authentication options
1993
+ * Returns the WebAuthn authentication options for passkey sign-in.
1994
+ * Get passkey sign-in options
1912
1995
  */
1913
1996
  getPasskeyAuthenticationSigninOptionsRaw(requestParameters: GetPasskeyAuthenticationSigninOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetPasskeyAuthenticationOptionsResponse>>;
1914
1997
  /**
1915
- * Gets passkey authentication options
1998
+ * Returns the WebAuthn authentication options for passkey sign-in.
1999
+ * Get passkey sign-in options
1916
2000
  */
1917
2001
  getPasskeyAuthenticationSigninOptions(requestParameters: GetPasskeyAuthenticationSigninOptionsRequest, initOverrides?: RequestInit): Promise<GetPasskeyAuthenticationOptionsResponse>;
1918
2002
  /**
1919
- * Gets passkey data associated with a user
2003
+ * Returns the WebAuthn registration options needed to register a new passkey.
2004
+ * Get user passkeys
1920
2005
  */
1921
2006
  getPasskeyRegistrationOptionsRaw(requestParameters: GetPasskeyRegistrationOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetPasskeyRegistrationOptionsResponse>>;
1922
2007
  /**
1923
- * Gets passkey data associated with a user
2008
+ * Returns the WebAuthn registration options needed to register a new passkey.
2009
+ * Get user passkeys
1924
2010
  */
1925
2011
  getPasskeyRegistrationOptions(requestParameters: GetPasskeyRegistrationOptionsRequest, initOverrides?: RequestInit): Promise<GetPasskeyRegistrationOptionsResponse>;
1926
2012
  /**
@@ -1932,46 +2018,52 @@ export declare class SDKApi extends runtime.BaseAPI {
1932
2018
  */
1933
2019
  getPasskeyRegistrationOptionsOptions(requestParameters: GetPasskeyRegistrationOptionsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
1934
2020
  /**
2021
+ * Returns the MFA recovery codes for the authenticated user.
1935
2022
  * Get recovery codes
1936
2023
  */
1937
2024
  getRecoveryCodesRaw(requestParameters: GetRecoveryCodesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFAGetRecoveryCodesResponse>>;
1938
2025
  /**
2026
+ * Returns the MFA recovery codes for the authenticated user.
1939
2027
  * Get recovery codes
1940
2028
  */
1941
2029
  getRecoveryCodes(requestParameters: GetRecoveryCodesRequest, initOverrides?: RequestInit): Promise<MFAGetRecoveryCodesResponse>;
1942
2030
  /**
1943
2031
  * Find the configuration for the enabled offramps associated to an environment
1944
- * Configuration for enabled offramps
2032
+ * Get enabled offramps for the environment
1945
2033
  */
1946
2034
  getSupportedOfframpsRaw(requestParameters: GetSupportedOfframpsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SupportedOfframpsResponse>>;
1947
2035
  /**
1948
2036
  * Find the configuration for the enabled offramps associated to an environment
1949
- * Configuration for enabled offramps
2037
+ * Get enabled offramps for the environment
1950
2038
  */
1951
2039
  getSupportedOfframps(requestParameters: GetSupportedOfframpsRequest, initOverrides?: RequestInit): Promise<SupportedOfframpsResponse>;
1952
2040
  /**
1953
2041
  * Find the configuration for the enabled onramps associated to an environment
1954
- * Configuration for enabled onramps
2042
+ * Get enabled onramps for the environment
1955
2043
  */
1956
2044
  getSupportedOnrampsRaw(requestParameters: GetSupportedOnrampsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SupportedOnrampsResponse>>;
1957
2045
  /**
1958
2046
  * Find the configuration for the enabled onramps associated to an environment
1959
- * Configuration for enabled onramps
2047
+ * Get enabled onramps for the environment
1960
2048
  */
1961
2049
  getSupportedOnramps(requestParameters: GetSupportedOnrampsRequest, initOverrides?: RequestInit): Promise<SupportedOnrampsResponse>;
1962
2050
  /**
1963
- * Get HTML with rendered Telegram login widget
2051
+ * Returns the HTML content for the Telegram login widget.
2052
+ * Get Telegram login widget HTML
1964
2053
  */
1965
2054
  getTelegramAuthRaw(requestParameters: GetTelegramAuthRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
1966
2055
  /**
1967
- * Get HTML with rendered Telegram login widget
2056
+ * Returns the HTML content for the Telegram login widget.
2057
+ * Get Telegram login widget HTML
1968
2058
  */
1969
2059
  getTelegramAuth(requestParameters: GetTelegramAuthRequest, initOverrides?: RequestInit): Promise<string>;
1970
2060
  /**
2061
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
1971
2062
  * Get the exchange accounts for a given dynamic user
1972
2063
  */
1973
2064
  getUserAccountsRaw(requestParameters: GetUserAccountsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Account>>>;
1974
2065
  /**
2066
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
1975
2067
  * Get the exchange accounts for a given dynamic user
1976
2068
  */
1977
2069
  getUserAccounts(requestParameters: GetUserAccountsRequest, initOverrides?: RequestInit): Promise<Array<Account>>;
@@ -2002,37 +2094,43 @@ export declare class SDKApi extends runtime.BaseAPI {
2002
2094
  */
2003
2095
  getUserFieldsCheckOptions(requestParameters: GetUserFieldsCheckOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2004
2096
  /**
2005
- * Get the current user\'s MFA Devices
2097
+ * Returns the list of MFA devices registered for the authenticated user.
2098
+ * Get the current user\'s MFA devices
2006
2099
  */
2007
2100
  getUserMfaDevicesRaw(requestParameters: GetUserMfaDevicesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFAListDevicesResponse>>;
2008
2101
  /**
2009
- * Get the current user\'s MFA Devices
2102
+ * Returns the list of MFA devices registered for the authenticated user.
2103
+ * Get the current user\'s MFA devices
2010
2104
  */
2011
2105
  getUserMfaDevices(requestParameters: GetUserMfaDevicesRequest, initOverrides?: RequestInit): Promise<MFAListDevicesResponse>;
2012
2106
  /**
2013
- * Get the current user\'s MFA Methods
2107
+ * Returns the available MFA methods for the authenticated user.
2108
+ * Get the current user\'s MFA methods
2014
2109
  */
2015
2110
  getUserMfaMethodsRaw(requestParameters: GetUserMfaMethodsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFAMethodsResponse>>;
2016
2111
  /**
2017
- * Get the current user\'s MFA Methods
2112
+ * Returns the available MFA methods for the authenticated user.
2113
+ * Get the current user\'s MFA methods
2018
2114
  */
2019
2115
  getUserMfaMethods(requestParameters: GetUserMfaMethodsRequest, initOverrides?: RequestInit): Promise<MFAMethodsResponse>;
2020
2116
  /**
2021
- * Gets passkey data associated with a user
2117
+ * Returns the list of passkeys registered for the authenticated user.
2118
+ * Get user passkeys
2022
2119
  */
2023
2120
  getUserPasskeysRaw(requestParameters: GetUserPasskeysRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetUserPasskeysResponse>>;
2024
2121
  /**
2025
- * Gets passkey data associated with a user
2122
+ * Returns the list of passkeys registered for the authenticated user.
2123
+ * Get user passkeys
2026
2124
  */
2027
2125
  getUserPasskeys(requestParameters: GetUserPasskeysRequest, initOverrides?: RequestInit): Promise<GetUserPasskeysResponse>;
2028
2126
  /**
2029
2127
  * Fetches a single WaaS wallet and returns it with the same payload structure as the users endpoint. This endpoint returns user information along with verified credentials filtered to only include the specified WaaS wallet.
2030
- * Fetch a single WaaS wallet with verified credentials
2128
+ * Get a WAAS wallet by address
2031
2129
  */
2032
2130
  getWaasWalletWithVerifiedCredentialsRaw(requestParameters: GetWaasWalletWithVerifiedCredentialsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SdkUser>>;
2033
2131
  /**
2034
2132
  * Fetches a single WaaS wallet and returns it with the same payload structure as the users endpoint. This endpoint returns user information along with verified credentials filtered to only include the specified WaaS wallet.
2035
- * Fetch a single WaaS wallet with verified credentials
2133
+ * Get a WAAS wallet by address
2036
2134
  */
2037
2135
  getWaasWalletWithVerifiedCredentials(requestParameters: GetWaasWalletWithVerifiedCredentialsRequest, initOverrides?: RequestInit): Promise<SdkUser>;
2038
2136
  /**
@@ -2079,22 +2177,22 @@ export declare class SDKApi extends runtime.BaseAPI {
2079
2177
  globalWalletsSettingsOptions(requestParameters: GlobalWalletsSettingsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2080
2178
  /**
2081
2179
  * Hard delete the authenticated user
2082
- * Hard delete a user
2180
+ * Delete the current user
2083
2181
  */
2084
2182
  hardDeleteUserRaw(requestParameters: HardDeleteUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2085
2183
  /**
2086
2184
  * Hard delete the authenticated user
2087
- * Hard delete a user
2185
+ * Delete the current user
2088
2186
  */
2089
2187
  hardDeleteUser(requestParameters: HardDeleteUserRequest, initOverrides?: RequestInit): Promise<void>;
2090
2188
  /**
2091
2189
  * Import a private key to create a waas account
2092
- * Import an existing private key to create a waas account
2190
+ * Import a private key to create a WAAS wallet
2093
2191
  */
2094
2192
  importPrivateKeyRaw(requestParameters: ImportPrivateKeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OpenRoomResponseWithServerKeygenIds>>;
2095
2193
  /**
2096
2194
  * Import a private key to create a waas account
2097
- * Import an existing private key to create a waas account
2195
+ * Import a private key to create a WAAS wallet
2098
2196
  */
2099
2197
  importPrivateKey(requestParameters: ImportPrivateKeyRequest, initOverrides?: RequestInit): Promise<OpenRoomResponseWithServerKeygenIds>;
2100
2198
  /**
@@ -2107,12 +2205,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2107
2205
  importPrivateKeyOptions(requestParameters: ImportPrivateKeyOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2108
2206
  /**
2109
2207
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
2110
- * Initialize oauth auth sequence
2208
+ * Initialize an OAuth authentication sequence
2111
2209
  */
2112
2210
  initAuthRaw(requestParameters: InitAuthRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2113
2211
  /**
2114
2212
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
2115
- * Initialize oauth auth sequence
2213
+ * Initialize an OAuth authentication sequence
2116
2214
  */
2117
2215
  initAuth(requestParameters: InitAuthRequest, initOverrides?: RequestInit): Promise<void>;
2118
2216
  /**
@@ -2161,12 +2259,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2161
2259
  legacyEmbeddedWalletDeleteRequestOptions(requestParameters: LegacyEmbeddedWalletDeleteRequestOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2162
2260
  /**
2163
2261
  * Generates the turnkey request body for a user\'s delete wallets request
2164
- * Generates the turnkey request body for a user\'s delete wallets request
2262
+ * Generate the delete wallets request body
2165
2263
  */
2166
2264
  legacyGetEmbeddedWalletsDeleteRequestRaw(requestParameters: LegacyGetEmbeddedWalletsDeleteRequestRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TurnkeyDeleteEmbeddedWalletsRequestBody>>;
2167
2265
  /**
2168
2266
  * Generates the turnkey request body for a user\'s delete wallets request
2169
- * Generates the turnkey request body for a user\'s delete wallets request
2267
+ * Generate the delete wallets request body
2170
2268
  */
2171
2269
  legacyGetEmbeddedWalletsDeleteRequest(requestParameters: LegacyGetEmbeddedWalletsDeleteRequestRequest, initOverrides?: RequestInit): Promise<TurnkeyDeleteEmbeddedWalletsRequestBody>;
2172
2270
  /**
@@ -2186,21 +2284,23 @@ export declare class SDKApi extends runtime.BaseAPI {
2186
2284
  */
2187
2285
  listMfaMethodsOptions(requestParameters: ListMfaMethodsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2188
2286
  /**
2189
- * Update SDK settings for a specific environment
2287
+ * Logs the SDK settings being used by the client for the environment.
2288
+ * Update SDK settings for the environment
2190
2289
  */
2191
2290
  logDynamicSdkSettingsRaw(requestParameters: LogDynamicSdkSettingsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2192
2291
  /**
2193
- * Update SDK settings for a specific environment
2292
+ * Logs the SDK settings being used by the client for the environment.
2293
+ * Update SDK settings for the environment
2194
2294
  */
2195
2295
  logDynamicSdkSettings(requestParameters: LogDynamicSdkSettingsRequest, initOverrides?: RequestInit): Promise<void>;
2196
2296
  /**
2197
2297
  * Used to merge two owned accounts connected by email address
2198
- * After successful verification allow to merge two owned accounts
2298
+ * Merge two owned accounts
2199
2299
  */
2200
2300
  mergeUsersRaw(requestParameters: MergeUsersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2201
2301
  /**
2202
2302
  * Used to merge two owned accounts connected by email address
2203
- * After successful verification allow to merge two owned accounts
2303
+ * Merge two owned accounts
2204
2304
  */
2205
2305
  mergeUsers(requestParameters: MergeUsersRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2206
2306
  /**
@@ -2229,12 +2329,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2229
2329
  nonceOptions(requestParameters: NonceOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2230
2330
  /**
2231
2331
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
2232
- * Oauth provider authorization endpoint
2332
+ * Get OAuth provider authorization HTML
2233
2333
  */
2234
2334
  oauthAuthorizeHtmlRaw(requestParameters: OauthAuthorizeHtmlRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
2235
2335
  /**
2236
2336
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
2237
- * Oauth provider authorization endpoint
2337
+ * Get OAuth provider authorization HTML
2238
2338
  */
2239
2339
  oauthAuthorizeHtml(requestParameters: OauthAuthorizeHtmlRequest, initOverrides?: RequestInit): Promise<string>;
2240
2340
  /**
@@ -2246,11 +2346,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2246
2346
  */
2247
2347
  oauthAuthorizeHtmlOptions(requestParameters: OauthAuthorizeHtmlOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2248
2348
  /**
2249
- * Get redirect URL for Oauth provider login
2349
+ * Redirects the user to the specified OAuth provider login page.
2350
+ * Redirect to OAuth provider login
2250
2351
  */
2251
2352
  oauthLoginRaw(requestParameters: OauthLoginRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2252
2353
  /**
2253
- * Get redirect URL for Oauth provider login
2354
+ * Redirects the user to the specified OAuth provider login page.
2355
+ * Redirect to OAuth provider login
2254
2356
  */
2255
2357
  oauthLogin(requestParameters: OauthLoginRequest, initOverrides?: RequestInit): Promise<void>;
2256
2358
  /**
@@ -2262,11 +2364,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2262
2364
  */
2263
2365
  oauthLoginOptions(requestParameters: OauthLoginOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2264
2366
  /**
2265
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
2367
+ * Returns the login URL for the specified OAuth provider.
2368
+ * Get the OAuth provider login URL
2266
2369
  */
2267
2370
  oauthLoginUrlRaw(requestParameters: OauthLoginUrlRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OauthProviderLoginUrl>>;
2268
2371
  /**
2269
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
2372
+ * Returns the login URL for the specified OAuth provider.
2373
+ * Get the OAuth provider login URL
2270
2374
  */
2271
2375
  oauthLoginUrl(requestParameters: OauthLoginUrlRequest, initOverrides?: RequestInit): Promise<OauthProviderLoginUrl>;
2272
2376
  /**
@@ -2279,12 +2383,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2279
2383
  oauthLoginUrlOptions(requestParameters: OauthLoginUrlOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2280
2384
  /**
2281
2385
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
2282
- * Oauth provider redirect endpoint for apple ID
2386
+ * Handle Apple ID OAuth redirect
2283
2387
  */
2284
2388
  oauthRedirectAppleRaw(requestParameters: OauthRedirectAppleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
2285
2389
  /**
2286
2390
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
2287
- * Oauth provider redirect endpoint for apple ID
2391
+ * Handle Apple ID OAuth redirect
2288
2392
  */
2289
2393
  oauthRedirectApple(requestParameters: OauthRedirectAppleRequest, initOverrides?: RequestInit): Promise<string>;
2290
2394
  /**
@@ -2297,12 +2401,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2297
2401
  oauthRedirectAppleOptions(requestParameters: OauthRedirectAppleOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2298
2402
  /**
2299
2403
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
2300
- * Oauth provider redirect endpoint
2404
+ * Handle OAuth provider redirect
2301
2405
  */
2302
2406
  oauthRedirectCodeRaw(requestParameters: OauthRedirectCodeRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
2303
2407
  /**
2304
2408
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
2305
- * Oauth provider redirect endpoint
2409
+ * Handle OAuth provider redirect
2306
2410
  */
2307
2411
  oauthRedirectCode(requestParameters: OauthRedirectCodeRequest, initOverrides?: RequestInit): Promise<string>;
2308
2412
  /**
@@ -2314,11 +2418,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2314
2418
  */
2315
2419
  oauthRedirectOptions(requestParameters: OauthRedirectOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2316
2420
  /**
2317
- * Returns the authorization code or error retuned by oauth provider
2421
+ * Returns the OAuth authorization result for the given state.
2422
+ * Get the OAuth provider authorization result
2318
2423
  */
2319
2424
  oauthResultRaw(requestParameters: OauthResultOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OauthResultResponse>>;
2320
2425
  /**
2321
- * Returns the authorization code or error retuned by oauth provider
2426
+ * Returns the OAuth authorization result for the given state.
2427
+ * Get the OAuth provider authorization result
2322
2428
  */
2323
2429
  oauthResult(requestParameters: OauthResultOperationRequest, initOverrides?: RequestInit): Promise<OauthResultResponse>;
2324
2430
  /**
@@ -2330,13 +2436,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2330
2436
  */
2331
2437
  oauthResultOptions(requestParameters: OauthResultOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2332
2438
  /**
2333
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
2334
- * Oauth provider SignIn endpoint
2439
+ * Standard OAuth SignIn callback to exchange temporary code for oauth access and return a valid Dynamic JWT and user
2440
+ * Sign in with OAuth provider
2335
2441
  */
2336
2442
  oauthSignInRaw(requestParameters: OauthSignInRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2337
2443
  /**
2338
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
2339
- * Oauth provider SignIn endpoint
2444
+ * Standard OAuth SignIn callback to exchange temporary code for oauth access and return a valid Dynamic JWT and user
2445
+ * Sign in with OAuth provider
2340
2446
  */
2341
2447
  oauthSignIn(requestParameters: OauthSignInRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2342
2448
  /**
@@ -2348,13 +2454,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2348
2454
  */
2349
2455
  oauthSignInOptions(requestParameters: OauthSignInOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2350
2456
  /**
2351
- * Standard OAuth verify callback to exchange temproary code for oauth access
2352
- * Oauth provider verify endpoint
2457
+ * Standard OAuth verify callback to exchange temporary code for oauth access
2458
+ * Verify OAuth provider authorization
2353
2459
  */
2354
2460
  oauthVerifyRaw(requestParameters: OauthVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2355
2461
  /**
2356
- * Standard OAuth verify callback to exchange temproary code for oauth access
2357
- * Oauth provider verify endpoint
2462
+ * Standard OAuth verify callback to exchange temporary code for oauth access
2463
+ * Verify OAuth provider authorization
2358
2464
  */
2359
2465
  oauthVerify(requestParameters: OauthVerifyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2360
2466
  /**
@@ -2382,10 +2488,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2382
2488
  */
2383
2489
  onrampsOptions(requestParameters: OnrampsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2384
2490
  /**
2491
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
2385
2492
  * Add fees to a Solana transaction
2386
2493
  */
2387
2494
  optimizeTransactionRaw(requestParameters: OptimizeTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SolanaTransactionOptimizationResponse>>;
2388
2495
  /**
2496
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
2389
2497
  * Add fees to a Solana transaction
2390
2498
  */
2391
2499
  optimizeTransaction(requestParameters: OptimizeTransactionRequest, initOverrides?: RequestInit): Promise<SolanaTransactionOptimizationResponse>;
@@ -2414,10 +2522,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2414
2522
  */
2415
2523
  passkeyRecoveryOptions(requestParameters: PasskeyRecoveryOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2416
2524
  /**
2525
+ * Transfers funds from an exchange account to an external address or another account.
2417
2526
  * Transfer funds from an exchange account to an external address or another Coinbase account
2418
2527
  */
2419
2528
  postExchangeAccountTransferRaw(requestParameters: PostExchangeAccountTransferRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ExchangeTransferResponse>>;
2420
2529
  /**
2530
+ * Transfers funds from an exchange account to an external address or another account.
2421
2531
  * Transfer funds from an exchange account to an external address or another Coinbase account
2422
2532
  */
2423
2533
  postExchangeAccountTransfer(requestParameters: PostExchangeAccountTransferRequest, initOverrides?: RequestInit): Promise<ExchangeTransferResponse>;
@@ -2430,10 +2540,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2430
2540
  */
2431
2541
  postExchangeAccountTransferOptions(requestParameters: PostExchangeAccountTransferOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2432
2542
  /**
2543
+ * Returns token balances for multiple account addresses across different chains.
2433
2544
  * Get account balances for multiple addresses
2434
2545
  */
2435
2546
  postMultichainAccountBalancesRaw(requestParameters: PostMultichainAccountBalancesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MultichainAccountBalanceResponse>>;
2436
2547
  /**
2548
+ * Returns token balances for multiple account addresses across different chains.
2437
2549
  * Get account balances for multiple addresses
2438
2550
  */
2439
2551
  postMultichainAccountBalances(requestParameters: PostMultichainAccountBalancesRequest, initOverrides?: RequestInit): Promise<MultichainAccountBalanceResponse>;
@@ -2446,37 +2558,43 @@ export declare class SDKApi extends runtime.BaseAPI {
2446
2558
  */
2447
2559
  postMultichainAccountBalancesOptions(requestParameters: PostMultichainAccountBalancesOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2448
2560
  /**
2561
+ * Handles the Telegram authentication callback after user authorization.
2449
2562
  * Handle Telegram authentication
2450
2563
  */
2451
2564
  postTelegramAuthRaw(requestParameters: PostTelegramAuthRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2452
2565
  /**
2566
+ * Handles the Telegram authentication callback after user authorization.
2453
2567
  * Handle Telegram authentication
2454
2568
  */
2455
2569
  postTelegramAuth(requestParameters: PostTelegramAuthRequest, initOverrides?: RequestInit): Promise<void>;
2456
2570
  /**
2457
2571
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
2458
- * prefetch information for wallet address
2572
+ * Prefetch information for a wallet address
2459
2573
  */
2460
2574
  prefetchRaw(requestParameters: PrefetchOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2461
2575
  /**
2462
2576
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
2463
- * prefetch information for wallet address
2577
+ * Prefetch information for a wallet address
2464
2578
  */
2465
2579
  prefetch(requestParameters: PrefetchOperationRequest, initOverrides?: RequestInit): Promise<void>;
2466
2580
  /**
2467
- * Publish events for SDK
2581
+ * Publishes SDK analytics events for the given environment.
2582
+ * Publish SDK events
2468
2583
  */
2469
2584
  publishEventRaw(requestParameters: PublishEventRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2470
2585
  /**
2471
- * Publish events for SDK
2586
+ * Publishes SDK analytics events for the given environment.
2587
+ * Publish SDK events
2472
2588
  */
2473
2589
  publishEvent(requestParameters: PublishEventRequest, initOverrides?: RequestInit): Promise<void>;
2474
2590
  /**
2475
- * Recover multiple keyShares
2591
+ * Recovers the client key shares for the specified WAAS wallet from backup.
2592
+ * Recover WAAS keyshares
2476
2593
  */
2477
2594
  recoverKeySharesRaw(requestParameters: RecoverKeySharesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RecoverMultipleClientKeySharesResponse>>;
2478
2595
  /**
2479
- * Recover multiple keyShares
2596
+ * Recovers the client key shares for the specified WAAS wallet from backup.
2597
+ * Recover WAAS keyshares
2480
2598
  */
2481
2599
  recoverKeyShares(requestParameters: RecoverKeySharesRequest, initOverrides?: RequestInit): Promise<RecoverMultipleClientKeySharesResponse>;
2482
2600
  /**
@@ -2504,19 +2622,23 @@ export declare class SDKApi extends runtime.BaseAPI {
2504
2622
  */
2505
2623
  recoveryEmailOptions(requestParameters: RecoveryEmailOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2506
2624
  /**
2507
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
2625
+ * Refreshes the JWT auth token and returns a new token with updated claims.
2626
+ * Refresh the JWT auth token
2508
2627
  */
2509
2628
  refreshAuthRaw(requestParameters: RefreshAuthRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2510
2629
  /**
2511
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
2630
+ * Refreshes the JWT auth token and returns a new token with updated claims.
2631
+ * Refresh the JWT auth token
2512
2632
  */
2513
2633
  refreshAuth(requestParameters: RefreshAuthRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2514
2634
  /**
2515
- * Refresh keyshares
2635
+ * Refreshes the MPC key shares for the specified WAAS wallet.
2636
+ * Refresh WAAS keyshares
2516
2637
  */
2517
2638
  refreshKeySharesRaw(requestParameters: RefreshKeySharesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OpenRoomResponseWithServerKeygenIds>>;
2518
2639
  /**
2519
- * Refresh keyshares
2640
+ * Refreshes the MPC key shares for the specified WAAS wallet.
2641
+ * Refresh WAAS keyshares
2520
2642
  */
2521
2643
  refreshKeyShares(requestParameters: RefreshKeySharesRequest, initOverrides?: RequestInit): Promise<OpenRoomResponseWithServerKeygenIds>;
2522
2644
  /**
@@ -2536,19 +2658,23 @@ export declare class SDKApi extends runtime.BaseAPI {
2536
2658
  */
2537
2659
  refreshOptions(requestParameters: RefreshOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2538
2660
  /**
2661
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
2539
2662
  * Register a new passkey
2540
2663
  */
2541
2664
  registerPasskeyRaw(requestParameters: RegisterPasskeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2542
2665
  /**
2666
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
2543
2667
  * Register a new passkey
2544
2668
  */
2545
2669
  registerPasskey(requestParameters: RegisterPasskeyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2546
2670
  /**
2547
- * Register a new Passkey MFA device
2671
+ * Initiates passkey MFA device registration and returns the setup details.
2672
+ * Register a passkey MFA device
2548
2673
  */
2549
2674
  registerPasskeyMfaDeviceRaw(requestParameters: RegisterPasskeyMfaDeviceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFARegisterPasskeyDeviceGetResponse>>;
2550
2675
  /**
2551
- * Register a new Passkey MFA device
2676
+ * Initiates passkey MFA device registration and returns the setup details.
2677
+ * Register a passkey MFA device
2552
2678
  */
2553
2679
  registerPasskeyMfaDevice(requestParameters: RegisterPasskeyMfaDeviceRequest, initOverrides?: RequestInit): Promise<MFARegisterPasskeyDeviceGetResponse>;
2554
2680
  /**
@@ -2560,10 +2686,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2560
2686
  */
2561
2687
  registerPasskeyMfaDeviceOptions(requestParameters: RegisterPasskeyMfaDeviceOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2562
2688
  /**
2689
+ * Verifies the passkey credential to complete MFA device registration.
2563
2690
  * Verify Passkey MFA device
2564
2691
  */
2565
2692
  registerPasskeyMfaDeviceVerifyRaw(requestParameters: RegisterPasskeyMfaDeviceVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2566
2693
  /**
2694
+ * Verifies the passkey credential to complete MFA device registration.
2567
2695
  * Verify Passkey MFA device
2568
2696
  */
2569
2697
  registerPasskeyMfaDeviceVerify(requestParameters: RegisterPasskeyMfaDeviceVerifyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
@@ -2578,11 +2706,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2578
2706
  */
2579
2707
  registerSessionKey(requestParameters: RegisterSessionKeyOperationRequest, initOverrides?: RequestInit): Promise<RegisterEmbeddedWalletSessionKeyResponse>;
2580
2708
  /**
2581
- * Register a new TOTP MFA device and get Totp Secret
2709
+ * Initiates TOTP MFA device registration and returns the setup details.
2710
+ * Register a TOTP MFA device
2582
2711
  */
2583
2712
  registerTotpMfaDeviceRaw(requestParameters: RegisterTotpMfaDeviceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFARegisterTotpDeviceGetResponse>>;
2584
2713
  /**
2585
- * Register a new TOTP MFA device and get Totp Secret
2714
+ * Initiates TOTP MFA device registration and returns the setup details.
2715
+ * Register a TOTP MFA device
2586
2716
  */
2587
2717
  registerTotpMfaDevice(requestParameters: RegisterTotpMfaDeviceRequest, initOverrides?: RequestInit): Promise<MFARegisterTotpDeviceGetResponse>;
2588
2718
  /**
@@ -2594,19 +2724,23 @@ export declare class SDKApi extends runtime.BaseAPI {
2594
2724
  */
2595
2725
  registerTotpMfaDeviceOptions(requestParameters: RegisterTotpMfaDeviceOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2596
2726
  /**
2727
+ * Verifies the TOTP code to complete MFA device registration.
2597
2728
  * Verify TOTP MFA device
2598
2729
  */
2599
2730
  registerTotpMfaDeviceVerifyRaw(requestParameters: RegisterTotpMfaDeviceVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MFADevice>>;
2600
2731
  /**
2732
+ * Verifies the TOTP code to complete MFA device registration.
2601
2733
  * Verify TOTP MFA device
2602
2734
  */
2603
2735
  registerTotpMfaDeviceVerify(requestParameters: RegisterTotpMfaDeviceVerifyRequest, initOverrides?: RequestInit): Promise<MFADevice>;
2604
2736
  /**
2605
- * Reshare secret shares and update the threshold
2737
+ * Reshares the MPC secret shares for the specified WAAS wallet.
2738
+ * Reshare WAAS secret shares
2606
2739
  */
2607
2740
  reshareRaw(requestParameters: ReshareOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OpenRoomResponseForReshare>>;
2608
2741
  /**
2609
- * Reshare secret shares and update the threshold
2742
+ * Reshares the MPC secret shares for the specified WAAS wallet.
2743
+ * Reshare WAAS secret shares
2610
2744
  */
2611
2745
  reshare(requestParameters: ReshareOperationRequest, initOverrides?: RequestInit): Promise<OpenRoomResponseForReshare>;
2612
2746
  /**
@@ -2636,11 +2770,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2636
2770
  */
2637
2771
  restoreEmbeddedWalletOptions(requestParameters: RestoreEmbeddedWalletOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2638
2772
  /**
2639
- * Send new code for email verification
2773
+ * Resends the email verification code to the email address on file.
2774
+ * Resend email verification code
2640
2775
  */
2641
2776
  retryEmailVerificationRaw(requestParameters: RetryEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmailVerificationCreateResponse>>;
2642
2777
  /**
2643
- * Send new code for email verification
2778
+ * Resends the email verification code to the email address on file.
2779
+ * Resend email verification code
2644
2780
  */
2645
2781
  retryEmailVerification(requestParameters: RetryEmailVerificationRequest, initOverrides?: RequestInit): Promise<EmailVerificationCreateResponse>;
2646
2782
  /**
@@ -2652,11 +2788,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2652
2788
  */
2653
2789
  retryEmailVerificationOptions(requestParameters: RetryEmailVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2654
2790
  /**
2655
- * Send new code for sms verification
2791
+ * Resends the SMS verification code to the phone number on file.
2792
+ * Resend SMS verification code
2656
2793
  */
2657
2794
  retrySmsVerificationRaw(requestParameters: RetrySmsVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SmsVerificationCreateResponse>>;
2658
2795
  /**
2659
- * Send new code for sms verification
2796
+ * Resends the SMS verification code to the phone number on file.
2797
+ * Resend SMS verification code
2660
2798
  */
2661
2799
  retrySmsVerification(requestParameters: RetrySmsVerificationRequest, initOverrides?: RequestInit): Promise<SmsVerificationCreateResponse>;
2662
2800
  /**
@@ -2668,10 +2806,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2668
2806
  */
2669
2807
  retrySmsVerificationOptions(requestParameters: RetrySmsVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2670
2808
  /**
2809
+ * Revokes the current user session and invalidates the JWT.
2671
2810
  * Revoke a session
2672
2811
  */
2673
2812
  revokeSessionRaw(requestParameters: RevokeSessionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2674
2813
  /**
2814
+ * Revokes the current user session and invalidates the JWT.
2675
2815
  * Revoke a session
2676
2816
  */
2677
2817
  revokeSession(requestParameters: RevokeSessionRequest, initOverrides?: RequestInit): Promise<void>;
@@ -2684,10 +2824,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2684
2824
  */
2685
2825
  revokeSessionOption(requestParameters: RevokeSessionOptionRequest, initOverrides?: RequestInit): Promise<void>;
2686
2826
  /**
2827
+ * Scans a URL for potential phishing or malicious activity and returns the result.
2687
2828
  * Scan a URL for potential malicious activity
2688
2829
  */
2689
2830
  scanUrlRaw(requestParameters: ScanUrlRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ScanWebsiteUrlResponse>>;
2690
2831
  /**
2832
+ * Scans a URL for potential phishing or malicious activity and returns the result.
2691
2833
  * Scan a URL for potential malicious activity
2692
2834
  */
2693
2835
  scanUrl(requestParameters: ScanUrlRequest, initOverrides?: RequestInit): Promise<ScanWebsiteUrlResponse>;
@@ -2707,12 +2849,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2707
2849
  sdkSettingsOptions(requestParameters: SdkSettingsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2708
2850
  /**
2709
2851
  * When a user selects a wallet to be the primary wallet in a multi-wallet enabled environment, this endpoint is called to record this on the backend.
2710
- * Update wallet in a multi-wallet selection
2852
+ * Update primary wallet selection
2711
2853
  */
2712
2854
  selectUserWalletRaw(requestParameters: SelectUserWalletRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2713
2855
  /**
2714
2856
  * When a user selects a wallet to be the primary wallet in a multi-wallet enabled environment, this endpoint is called to record this on the backend.
2715
- * Update wallet in a multi-wallet selection
2857
+ * Update primary wallet selection
2716
2858
  */
2717
2859
  selectUserWallet(requestParameters: SelectUserWalletRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2718
2860
  /**
@@ -2724,11 +2866,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2724
2866
  */
2725
2867
  selectUserWalletOptions(requestParameters: SelectUserWalletOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2726
2868
  /**
2727
- * Check that session is valid
2869
+ * Checks whether the current user session is still valid.
2870
+ * Check session validity
2728
2871
  */
2729
2872
  sessionCheckRaw(requestParameters: SessionCheckRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2730
2873
  /**
2731
- * Check that session is valid
2874
+ * Checks whether the current user session is still valid.
2875
+ * Check session validity
2732
2876
  */
2733
2877
  sessionCheck(requestParameters: SessionCheckRequest, initOverrides?: RequestInit): Promise<void>;
2734
2878
  /**
@@ -2756,11 +2900,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2756
2900
  */
2757
2901
  settingsOptions(requestParameters: SettingsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2758
2902
  /**
2759
- * Verify an email and sign in user
2903
+ * Verifies the email code and authenticates the user, returning a JWT.
2904
+ * Verify email and sign in
2760
2905
  */
2761
2906
  signInWithEmailVerificationRaw(requestParameters: SignInWithEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2762
2907
  /**
2763
- * Verify an email and sign in user
2908
+ * Verifies the email code and authenticates the user, returning a JWT.
2909
+ * Verify email and sign in
2764
2910
  */
2765
2911
  signInWithEmailVerification(requestParameters: SignInWithEmailVerificationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2766
2912
  /**
@@ -2772,11 +2918,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2772
2918
  */
2773
2919
  signInWithEmailVerificationOptions(requestParameters: SignInWithEmailVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2774
2920
  /**
2775
- * Verify an sms and sign in user
2921
+ * Verifies the SMS code and authenticates the user, returning a JWT.
2922
+ * Verify SMS and sign in
2776
2923
  */
2777
2924
  signInWithSmsVerificationRaw(requestParameters: SignInWithSmsVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2778
2925
  /**
2779
- * Verify an sms and sign in user
2926
+ * Verifies the SMS code and authenticates the user, returning a JWT.
2927
+ * Verify SMS and sign in
2780
2928
  */
2781
2929
  signInWithSmsVerification(requestParameters: SignInWithSmsVerificationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2782
2930
  /**
@@ -2788,11 +2936,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2788
2936
  */
2789
2937
  signInWithSmsVerificationOptions(requestParameters: SignInWithSmsVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2790
2938
  /**
2791
- * Sign a message with a waas account
2939
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
2940
+ * Sign a message with a WAAS wallet
2792
2941
  */
2793
2942
  signMessageRaw(requestParameters: SignMessageRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OpenRoomResponse>>;
2794
2943
  /**
2795
- * Sign a message with a waas account
2944
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
2945
+ * Sign a message with a WAAS wallet
2796
2946
  */
2797
2947
  signMessage(requestParameters: SignMessageRequest, initOverrides?: RequestInit): Promise<OpenRoomResponse>;
2798
2948
  /**
@@ -2804,18 +2954,22 @@ export declare class SDKApi extends runtime.BaseAPI {
2804
2954
  */
2805
2955
  signMessageOptions(requestParameters: SignMessageOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2806
2956
  /**
2957
+ * Authenticates a user using a passkey and returns a JWT.
2807
2958
  * Authenticate a passkey
2808
2959
  */
2809
2960
  signinWithPasskeyRaw(requestParameters: SigninWithPasskeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2810
2961
  /**
2962
+ * Authenticates a user using a passkey and returns a JWT.
2811
2963
  * Authenticate a passkey
2812
2964
  */
2813
2965
  signinWithPasskey(requestParameters: SigninWithPasskeyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2814
2966
  /**
2967
+ * Simulates an EVM transaction and returns the expected outcome.
2815
2968
  * Simulate an EVM transaction
2816
2969
  */
2817
2970
  simulateEVMTransactionRaw(requestParameters: SimulateEVMTransactionOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SimulateTransactionResponse>>;
2818
2971
  /**
2972
+ * Simulates an EVM transaction and returns the expected outcome.
2819
2973
  * Simulate an EVM transaction
2820
2974
  */
2821
2975
  simulateEVMTransaction(requestParameters: SimulateEVMTransactionOperationRequest, initOverrides?: RequestInit): Promise<SimulateTransactionResponse>;
@@ -2828,10 +2982,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2828
2982
  */
2829
2983
  simulateEVMTransactionOptions(requestParameters: SimulateEVMTransactionOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2830
2984
  /**
2985
+ * Simulates a Solana transaction and returns the expected outcome.
2831
2986
  * Simulate a Solana transaction
2832
2987
  */
2833
2988
  simulateSVMTransactionRaw(requestParameters: SimulateSVMTransactionOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SimulateTransactionResponse>>;
2834
2989
  /**
2990
+ * Simulates a Solana transaction and returns the expected outcome.
2835
2991
  * Simulate a Solana transaction
2836
2992
  */
2837
2993
  simulateSVMTransaction(requestParameters: SimulateSVMTransactionOperationRequest, initOverrides?: RequestInit): Promise<SimulateTransactionResponse>;
@@ -2844,10 +3000,12 @@ export declare class SDKApi extends runtime.BaseAPI {
2844
3000
  */
2845
3001
  simulateSVMTransactionOptions(requestParameters: SimulateSVMTransactionOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2846
3002
  /**
3003
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
2847
3004
  * Simulate an EVM AA UserOp
2848
3005
  */
2849
3006
  simulateUserOpRaw(requestParameters: SimulateUserOpOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SimulateTransactionResponse>>;
2850
3007
  /**
3008
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
2851
3009
  * Simulate an EVM AA UserOp
2852
3010
  */
2853
3011
  simulateUserOp(requestParameters: SimulateUserOpOperationRequest, initOverrides?: RequestInit): Promise<SimulateTransactionResponse>;
@@ -2904,11 +3062,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2904
3062
  */
2905
3063
  telegramAuthOptions(requestParameters: TelegramAuthOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2906
3064
  /**
2907
- * Telegram provider check auth
3065
+ * Checks if a Telegram authentication attempt has been completed.
3066
+ * Check Telegram authentication status
2908
3067
  */
2909
3068
  telegramCheckAuthRaw(requestParameters: TelegramCheckAuthRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2910
3069
  /**
2911
- * Telegram provider check auth
3070
+ * Checks if a Telegram authentication attempt has been completed.
3071
+ * Check Telegram authentication status
2912
3072
  */
2913
3073
  telegramCheckAuth(requestParameters: TelegramCheckAuthRequest, initOverrides?: RequestInit): Promise<void>;
2914
3074
  /**
@@ -2920,11 +3080,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2920
3080
  */
2921
3081
  telegramCheckAuthOptions(requestParameters: TelegramCheckAuthOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2922
3082
  /**
2923
- * Telegram provider SignIn endpoint
3083
+ * Authenticates a user using their Telegram account credentials.
3084
+ * Sign in with Telegram
2924
3085
  */
2925
3086
  telegramSignInRaw(requestParameters: TelegramSignInRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2926
3087
  /**
2927
- * Telegram provider SignIn endpoint
3088
+ * Authenticates a user using their Telegram account credentials.
3089
+ * Sign in with Telegram
2928
3090
  */
2929
3091
  telegramSignIn(requestParameters: TelegramSignInRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2930
3092
  /**
@@ -2936,11 +3098,13 @@ export declare class SDKApi extends runtime.BaseAPI {
2936
3098
  */
2937
3099
  telegramSignInOptions(requestParameters: TelegramSignInOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2938
3100
  /**
2939
- * Telegram provider Verify endpoint
3101
+ * Verifies and links a Telegram account to the authenticated user.
3102
+ * Verify Telegram account linking
2940
3103
  */
2941
3104
  telegramVerifyRaw(requestParameters: TelegramVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
2942
3105
  /**
2943
- * Telegram provider Verify endpoint
3106
+ * Verifies and links a Telegram account to the authenticated user.
3107
+ * Verify Telegram account linking
2944
3108
  */
2945
3109
  telegramVerify(requestParameters: TelegramVerifyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
2946
3110
  /**
@@ -2952,52 +3116,62 @@ export declare class SDKApi extends runtime.BaseAPI {
2952
3116
  */
2953
3117
  telegramVerifyOptions(requestParameters: TelegramVerifyOptionsRequest, initOverrides?: RequestInit): Promise<void>;
2954
3118
  /**
3119
+ * Updates the V2 recovery email address for the authenticated user.
2955
3120
  * Update a user\'s V2 recovery email
2956
3121
  */
2957
3122
  updateEmbeddedWalletRecoveryEmailRaw(requestParameters: UpdateEmbeddedWalletRecoveryEmailRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2958
3123
  /**
3124
+ * Updates the V2 recovery email address for the authenticated user.
2959
3125
  * Update a user\'s V2 recovery email
2960
3126
  */
2961
3127
  updateEmbeddedWalletRecoveryEmail(requestParameters: UpdateEmbeddedWalletRecoveryEmailRequest, initOverrides?: RequestInit): Promise<void>;
2962
3128
  /**
2963
- * Update a passkey\'s info
3129
+ * Updates the specified passkey for the authenticated user.
3130
+ * Update a passkey
2964
3131
  */
2965
3132
  updatePasskeyRaw(requestParameters: UpdatePasskeyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserPasskey>>;
2966
3133
  /**
2967
- * Update a passkey\'s info
3134
+ * Updates the specified passkey for the authenticated user.
3135
+ * Update a passkey
2968
3136
  */
2969
3137
  updatePasskey(requestParameters: UpdatePasskeyRequest, initOverrides?: RequestInit): Promise<UserPasskey>;
2970
3138
  /**
2971
- * Update a user\'s fields
3139
+ * Updates the authenticated user profile fields.
3140
+ * Update user fields
2972
3141
  */
2973
3142
  updateSelfRaw(requestParameters: UpdateSelfRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UpdateSelfResponse>>;
2974
3143
  /**
2975
- * Update a user\'s fields
3144
+ * Updates the authenticated user profile fields.
3145
+ * Update user fields
2976
3146
  */
2977
3147
  updateSelf(requestParameters: UpdateSelfRequest, initOverrides?: RequestInit): Promise<UpdateSelfResponse>;
2978
3148
  /**
2979
- * Update a device
3149
+ * Updates the specified MFA device for the authenticated user.
3150
+ * Update an MFA device
2980
3151
  */
2981
3152
  updateUserMfaDeviceRaw(requestParameters: UpdateUserMfaDeviceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
2982
3153
  /**
2983
- * Update a device
3154
+ * Updates the specified MFA device for the authenticated user.
3155
+ * Update an MFA device
2984
3156
  */
2985
3157
  updateUserMfaDevice(requestParameters: UpdateUserMfaDeviceRequest, initOverrides?: RequestInit): Promise<void>;
2986
3158
  /**
2987
3159
  * Updates the settings for a WAAS wallet
2988
- * Update the WAAS wallet settings for the wallet
3160
+ * Update WAAS wallet settings
2989
3161
  */
2990
3162
  updateWaasWalletSettingsRaw(requestParameters: UpdateWaasWalletSettingsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UpdateWaasWalletSettingsResponse>>;
2991
3163
  /**
2992
3164
  * Updates the settings for a WAAS wallet
2993
- * Update the WAAS wallet settings for the wallet
3165
+ * Update WAAS wallet settings
2994
3166
  */
2995
3167
  updateWaasWalletSettings(requestParameters: UpdateWaasWalletSettingsOperationRequest, initOverrides?: RequestInit): Promise<UpdateWaasWalletSettingsResponse>;
2996
3168
  /**
3169
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
2997
3170
  * Update V1 embedded wallet to V2
2998
3171
  */
2999
3172
  upgradeEmbeddedWalletToV2Raw(requestParameters: UpgradeEmbeddedWalletToV2OperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
3000
3173
  /**
3174
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
3001
3175
  * Update V1 embedded wallet to V2
3002
3176
  */
3003
3177
  upgradeEmbeddedWalletToV2(requestParameters: UpgradeEmbeddedWalletToV2OperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
@@ -3026,19 +3200,23 @@ export declare class SDKApi extends runtime.BaseAPI {
3026
3200
  */
3027
3201
  usersOptions(requestParameters: UsersOptionsRequest, initOverrides?: RequestInit): Promise<void>;
3028
3202
  /**
3203
+ * Verifies the signed payload and returns a JWT authentication token.
3029
3204
  * Verify payload and return JWT
3030
3205
  */
3031
3206
  verifyRaw(requestParameters: VerifyOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
3032
3207
  /**
3208
+ * Verifies the signed payload and returns a JWT authentication token.
3033
3209
  * Verify payload and return JWT
3034
3210
  */
3035
3211
  verify(requestParameters: VerifyOperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
3036
3212
  /**
3037
- * Verify email verification request
3213
+ * Verifies the email code and completes the email verification process.
3214
+ * Verify email verification code
3038
3215
  */
3039
3216
  verifyEmailVerificationRaw(requestParameters: VerifyEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UpdateSelfResponse>>;
3040
3217
  /**
3041
- * Verify email verification request
3218
+ * Verifies the email code and completes the email verification process.
3219
+ * Verify email verification code
3042
3220
  */
3043
3221
  verifyEmailVerification(requestParameters: VerifyEmailVerificationRequest, initOverrides?: RequestInit): Promise<UpdateSelfResponse>;
3044
3222
  /**
@@ -3051,12 +3229,12 @@ export declare class SDKApi extends runtime.BaseAPI {
3051
3229
  verifyEmailVerificationOptions(requestParameters: VerifyEmailVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
3052
3230
  /**
3053
3231
  * Link a wallet to a valid environment user, and return an updated JWT
3054
- * Link wallet to user
3232
+ * Link a wallet to a user
3055
3233
  */
3056
3234
  verifyLinkRaw(requestParameters: VerifyLinkRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
3057
3235
  /**
3058
3236
  * Link a wallet to a valid environment user, and return an updated JWT
3059
- * Link wallet to user
3237
+ * Link a wallet to a user
3060
3238
  */
3061
3239
  verifyLink(requestParameters: VerifyLinkRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
3062
3240
  /**
@@ -3102,11 +3280,13 @@ export declare class SDKApi extends runtime.BaseAPI {
3102
3280
  */
3103
3281
  verifyPrefetch(requestParameters: VerifyPrefetchRequest, initOverrides?: RequestInit): Promise<void>;
3104
3282
  /**
3105
- * Verify sms verification request
3283
+ * Verifies the SMS code and completes the phone number verification process.
3284
+ * Verify SMS verification code
3106
3285
  */
3107
3286
  verifySmsVerificationRaw(requestParameters: VerifySmsVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UpdateSelfResponse>>;
3108
3287
  /**
3109
- * Verify sms verification request
3288
+ * Verifies the SMS code and completes the phone number verification process.
3289
+ * Verify SMS verification code
3110
3290
  */
3111
3291
  verifySmsVerification(requestParameters: VerifySmsVerificationRequest, initOverrides?: RequestInit): Promise<UpdateSelfResponse>;
3112
3292
  /**
@@ -3119,12 +3299,12 @@ export declare class SDKApi extends runtime.BaseAPI {
3119
3299
  verifySmsVerificationOptions(requestParameters: VerifySmsVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
3120
3300
  /**
3121
3301
  * Used to link a wallet after user has confirmed transfer to the new account
3122
- * Verify wallet transfer
3302
+ * Verify a wallet transfer
3123
3303
  */
3124
3304
  verifyTransferRaw(requestParameters: VerifyTransferRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
3125
3305
  /**
3126
3306
  * Used to link a wallet after user has confirmed transfer to the new account
3127
- * Verify wallet transfer
3307
+ * Verify a wallet transfer
3128
3308
  */
3129
3309
  verifyTransfer(requestParameters: VerifyTransferRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
3130
3310
  /**
@@ -3137,12 +3317,12 @@ export declare class SDKApi extends runtime.BaseAPI {
3137
3317
  verifyTransferOptions(requestParameters: VerifyTransferOptionsRequest, initOverrides?: RequestInit): Promise<void>;
3138
3318
  /**
3139
3319
  * Remove a link from to a valid environment user, and return an updated JWT
3140
- * unlink wallet from user
3320
+ * Unlink a wallet from a user
3141
3321
  */
3142
3322
  verifyUnlinkRaw(requestParameters: VerifyUnlinkOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
3143
3323
  /**
3144
3324
  * Remove a link from to a valid environment user, and return an updated JWT
3145
- * unlink wallet from user
3325
+ * Unlink a wallet from a user
3146
3326
  */
3147
3327
  verifyUnlink(requestParameters: VerifyUnlinkOperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
3148
3328
  /**
@@ -3178,10 +3358,12 @@ export declare class SDKApi extends runtime.BaseAPI {
3178
3358
  */
3179
3359
  walletAccountRequestOptions(requestParameters: WalletAccountRequestOptionsRequest, initOverrides?: RequestInit): Promise<void>;
3180
3360
  /**
3361
+ * Authenticates a user by verifying their wallet signature.
3181
3362
  * Sign in with wallet
3182
3363
  */
3183
3364
  walletsSigninRaw(requestParameters: WalletsSigninRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
3184
3365
  /**
3366
+ * Authenticates a user by verifying their wallet signature.
3185
3367
  * Sign in with wallet
3186
3368
  */
3187
3369
  walletsSignin(requestParameters: WalletsSigninRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
@@ -3195,12 +3377,12 @@ export declare class SDKApi extends runtime.BaseAPI {
3195
3377
  walletsSigninOptions(requestParameters: WalletsSigninOptionsRequest, initOverrides?: RequestInit): Promise<void>;
3196
3378
  /**
3197
3379
  * Verify a wallet, and return an updated JWT
3198
- * Verify wallet
3380
+ * Verify a wallet
3199
3381
  */
3200
3382
  walletsVerifyRaw(requestParameters: WalletsVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
3201
3383
  /**
3202
3384
  * Verify a wallet, and return an updated JWT
3203
- * Verify wallet
3385
+ * Verify a wallet
3204
3386
  */
3205
3387
  walletsVerify(requestParameters: WalletsVerifyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
3206
3388
  /**