@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.
@@ -264,6 +264,7 @@ class SDKApi extends BaseAPI {
264
264
  });
265
265
  }
266
266
  /**
267
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
267
268
  * Upgrade JWT scope with valid MFA session
268
269
  */
269
270
  authMfaRecoveryRaw(requestParameters, initOverrides) {
@@ -295,6 +296,7 @@ class SDKApi extends BaseAPI {
295
296
  });
296
297
  }
297
298
  /**
299
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
298
300
  * Upgrade JWT scope with valid MFA session
299
301
  */
300
302
  authMfaRecovery(requestParameters, initOverrides) {
@@ -331,6 +333,7 @@ class SDKApi extends BaseAPI {
331
333
  });
332
334
  }
333
335
  /**
336
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
334
337
  * Upgrade JWT scope with valid MFA session
335
338
  */
336
339
  authMfaTotpDeviceRaw(requestParameters, initOverrides) {
@@ -362,6 +365,7 @@ class SDKApi extends BaseAPI {
362
365
  });
363
366
  }
364
367
  /**
368
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
365
369
  * Upgrade JWT scope with valid MFA session
366
370
  */
367
371
  authMfaTotpDevice(requestParameters, initOverrides) {
@@ -398,6 +402,7 @@ class SDKApi extends BaseAPI {
398
402
  });
399
403
  }
400
404
  /**
405
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
401
406
  * Upgrade JWT scope with valid MFA session
402
407
  */
403
408
  authenticateMfaEmailRaw(requestParameters, initOverrides) {
@@ -429,6 +434,7 @@ class SDKApi extends BaseAPI {
429
434
  });
430
435
  }
431
436
  /**
437
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
432
438
  * Upgrade JWT scope with valid MFA session
433
439
  */
434
440
  authenticateMfaEmail(requestParameters, initOverrides) {
@@ -438,6 +444,7 @@ class SDKApi extends BaseAPI {
438
444
  });
439
445
  }
440
446
  /**
447
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
441
448
  * Upgrade JWT scope with valid MFA session
442
449
  */
443
450
  authenticateMfaPasskeyDeviceRaw(requestParameters, initOverrides) {
@@ -469,6 +476,7 @@ class SDKApi extends BaseAPI {
469
476
  });
470
477
  }
471
478
  /**
479
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
472
480
  * Upgrade JWT scope with valid MFA session
473
481
  */
474
482
  authenticateMfaPasskeyDevice(requestParameters, initOverrides) {
@@ -508,7 +516,8 @@ class SDKApi extends BaseAPI {
508
516
  });
509
517
  }
510
518
  /**
511
- * Backup multiple keyShares for a waaS wallet
519
+ * Backs up the client key shares for the specified WAAS wallet.
520
+ * Back up keyshares for a WAAS wallet
512
521
  */
513
522
  backupKeySharesRaw(requestParameters, initOverrides) {
514
523
  return __awaiter(this, void 0, void 0, function* () {
@@ -542,7 +551,8 @@ class SDKApi extends BaseAPI {
542
551
  });
543
552
  }
544
553
  /**
545
- * Backup multiple keyShares for a waaS wallet
554
+ * Backs up the client key shares for the specified WAAS wallet.
555
+ * Back up keyshares for a WAAS wallet
546
556
  */
547
557
  backupKeyShares(requestParameters, initOverrides) {
548
558
  return __awaiter(this, void 0, void 0, function* () {
@@ -581,7 +591,8 @@ class SDKApi extends BaseAPI {
581
591
  });
582
592
  }
583
593
  /**
584
- * Backup multiple keyShares for a waaS wallet to Google Drive
594
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
595
+ * Back up keyshares to Google Drive
585
596
  */
586
597
  backupKeySharesToGoogleDriveRaw(requestParameters, initOverrides) {
587
598
  return __awaiter(this, void 0, void 0, function* () {
@@ -610,7 +621,8 @@ class SDKApi extends BaseAPI {
610
621
  });
611
622
  }
612
623
  /**
613
- * Backup multiple keyShares for a waaS wallet to Google Drive
624
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
625
+ * Back up keyshares to Google Drive
614
626
  */
615
627
  backupKeySharesToGoogleDrive(requestParameters, initOverrides) {
616
628
  return __awaiter(this, void 0, void 0, function* () {
@@ -649,6 +661,7 @@ class SDKApi extends BaseAPI {
649
661
  });
650
662
  }
651
663
  /**
664
+ * Records a backup action and event for the specified location without performing the actual backup.
652
665
  * Create backup action and event for a specified location without performing actual backup
653
666
  */
654
667
  backupKeySharesToLocationRaw(requestParameters, initOverrides) {
@@ -683,6 +696,7 @@ class SDKApi extends BaseAPI {
683
696
  });
684
697
  }
685
698
  /**
699
+ * Records a backup action and event for the specified location without performing the actual backup.
686
700
  * Create backup action and event for a specified location without performing actual backup
687
701
  */
688
702
  backupKeySharesToLocation(requestParameters, initOverrides) {
@@ -722,6 +736,7 @@ class SDKApi extends BaseAPI {
722
736
  });
723
737
  }
724
738
  /**
739
+ * Records backup actions and events for multiple locations without performing the actual backups.
725
740
  * Create backup action and event for multiple locations without performing actual backup
726
741
  */
727
742
  backupKeySharesToLocationsRaw(requestParameters, initOverrides) {
@@ -756,6 +771,7 @@ class SDKApi extends BaseAPI {
756
771
  });
757
772
  }
758
773
  /**
774
+ * Records backup actions and events for multiple locations without performing the actual backups.
759
775
  * Create backup action and event for multiple locations without performing actual backup
760
776
  */
761
777
  backupKeySharesToLocations(requestParameters, initOverrides) {
@@ -796,7 +812,7 @@ class SDKApi extends BaseAPI {
796
812
  }
797
813
  /**
798
814
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
799
- * Redirect URL for sign-in with coinbase
815
+ * Handle Coinbase OAuth redirect
800
816
  */
801
817
  cbOauthRedirectRaw(requestParameters, initOverrides) {
802
818
  return __awaiter(this, void 0, void 0, function* () {
@@ -834,7 +850,7 @@ class SDKApi extends BaseAPI {
834
850
  }
835
851
  /**
836
852
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
837
- * Redirect URL for sign-in with coinbase
853
+ * Handle Coinbase OAuth redirect
838
854
  */
839
855
  cbOauthRedirect(requestParameters, initOverrides) {
840
856
  return __awaiter(this, void 0, void 0, function* () {
@@ -981,6 +997,7 @@ class SDKApi extends BaseAPI {
981
997
  });
982
998
  }
983
999
  /**
1000
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
984
1001
  * Claim a pregenerated embedded wallet
985
1002
  */
986
1003
  claimEmbeddedWalletRaw(requestParameters, initOverrides) {
@@ -1012,6 +1029,7 @@ class SDKApi extends BaseAPI {
1012
1029
  });
1013
1030
  }
1014
1031
  /**
1032
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
1015
1033
  * Claim a pregenerated embedded wallet
1016
1034
  */
1017
1035
  claimEmbeddedWallet(requestParameters, initOverrides) {
@@ -1130,7 +1148,7 @@ class SDKApi extends BaseAPI {
1130
1148
  }
1131
1149
  /**
1132
1150
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1133
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1151
+ * Complete passkey recovery for an embedded wallet
1134
1152
  */
1135
1153
  completePasskeyRecoveryRaw(requestParameters, initOverrides) {
1136
1154
  return __awaiter(this, void 0, void 0, function* () {
@@ -1162,7 +1180,7 @@ class SDKApi extends BaseAPI {
1162
1180
  }
1163
1181
  /**
1164
1182
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1165
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1183
+ * Complete passkey recovery for an embedded wallet
1166
1184
  */
1167
1185
  completePasskeyRecovery(requestParameters, initOverrides) {
1168
1186
  return __awaiter(this, void 0, void 0, function* () {
@@ -1171,6 +1189,7 @@ class SDKApi extends BaseAPI {
1171
1189
  });
1172
1190
  }
1173
1191
  /**
1192
+ * Creates a new Coinbase onramp order for the authenticated user.
1174
1193
  * Create a Coinbase onramp order
1175
1194
  */
1176
1195
  createCoinbaseOnrampOrderRaw(requestParameters, initOverrides) {
@@ -1202,6 +1221,7 @@ class SDKApi extends BaseAPI {
1202
1221
  });
1203
1222
  }
1204
1223
  /**
1224
+ * Creates a new Coinbase onramp order for the authenticated user.
1205
1225
  * Create a Coinbase onramp order
1206
1226
  */
1207
1227
  createCoinbaseOnrampOrder(requestParameters, initOverrides) {
@@ -1253,6 +1273,7 @@ class SDKApi extends BaseAPI {
1253
1273
  });
1254
1274
  }
1255
1275
  /**
1276
+ * Initiates the email verification process and sends a verification code.
1256
1277
  * Initialize email verification process
1257
1278
  */
1258
1279
  createEmailVerificationRaw(requestParameters, initOverrides) {
@@ -1277,6 +1298,7 @@ class SDKApi extends BaseAPI {
1277
1298
  });
1278
1299
  }
1279
1300
  /**
1301
+ * Initiates the email verification process and sends a verification code.
1280
1302
  * Initialize email verification process
1281
1303
  */
1282
1304
  createEmailVerification(requestParameters, initOverrides) {
@@ -1382,7 +1404,8 @@ class SDKApi extends BaseAPI {
1382
1404
  });
1383
1405
  }
1384
1406
  /**
1385
- * Track a global wallet connection
1407
+ * Creates a new global wallet connection for the authenticated user.
1408
+ * Create a global wallet connection
1386
1409
  */
1387
1410
  createGlobalWalletConnectionRaw(requestParameters, initOverrides) {
1388
1411
  return __awaiter(this, void 0, void 0, function* () {
@@ -1413,7 +1436,8 @@ class SDKApi extends BaseAPI {
1413
1436
  });
1414
1437
  }
1415
1438
  /**
1416
- * Track a global wallet connection
1439
+ * Creates a new global wallet connection for the authenticated user.
1440
+ * Create a global wallet connection
1417
1441
  */
1418
1442
  createGlobalWalletConnection(requestParameters, initOverrides) {
1419
1443
  return __awaiter(this, void 0, void 0, function* () {
@@ -1422,7 +1446,8 @@ class SDKApi extends BaseAPI {
1422
1446
  });
1423
1447
  }
1424
1448
  /**
1425
- * Generate new recovery codes for user
1449
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1450
+ * Generate new recovery codes
1426
1451
  */
1427
1452
  createNewRecoveryCodesRaw(requestParameters, initOverrides) {
1428
1453
  return __awaiter(this, void 0, void 0, function* () {
@@ -1448,7 +1473,8 @@ class SDKApi extends BaseAPI {
1448
1473
  });
1449
1474
  }
1450
1475
  /**
1451
- * Generate new recovery codes for user
1476
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1477
+ * Generate new recovery codes
1452
1478
  */
1453
1479
  createNewRecoveryCodes(requestParameters, initOverrides) {
1454
1480
  return __awaiter(this, void 0, void 0, function* () {
@@ -1457,6 +1483,7 @@ class SDKApi extends BaseAPI {
1457
1483
  });
1458
1484
  }
1459
1485
  /**
1486
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1460
1487
  * Create rooms for a waas mpc ceremony
1461
1488
  */
1462
1489
  createRoomsRaw(requestParameters, initOverrides) {
@@ -1491,6 +1518,7 @@ class SDKApi extends BaseAPI {
1491
1518
  });
1492
1519
  }
1493
1520
  /**
1521
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1494
1522
  * Create rooms for a waas mpc ceremony
1495
1523
  */
1496
1524
  createRooms(requestParameters, initOverrides) {
@@ -1530,6 +1558,7 @@ class SDKApi extends BaseAPI {
1530
1558
  });
1531
1559
  }
1532
1560
  /**
1561
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1533
1562
  * Create rooms for a waas mpc ceremony without a walletId
1534
1563
  */
1535
1564
  createRoomsWithoutWalletIdRaw(requestParameters, initOverrides) {
@@ -1561,6 +1590,7 @@ class SDKApi extends BaseAPI {
1561
1590
  });
1562
1591
  }
1563
1592
  /**
1593
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1564
1594
  * Create rooms for a waas mpc ceremony without a walletId
1565
1595
  */
1566
1596
  createRoomsWithoutWalletId(requestParameters, initOverrides) {
@@ -1597,7 +1627,8 @@ class SDKApi extends BaseAPI {
1597
1627
  });
1598
1628
  }
1599
1629
  /**
1600
- * Initialize sms verification process
1630
+ * Initiates the SMS verification process and sends a verification code.
1631
+ * Initialize SMS verification process
1601
1632
  */
1602
1633
  createSmsVerificationRaw(requestParameters, initOverrides) {
1603
1634
  return __awaiter(this, void 0, void 0, function* () {
@@ -1621,7 +1652,8 @@ class SDKApi extends BaseAPI {
1621
1652
  });
1622
1653
  }
1623
1654
  /**
1624
- * Initialize sms verification process
1655
+ * Initiates the SMS verification process and sends a verification code.
1656
+ * Initialize SMS verification process
1625
1657
  */
1626
1658
  createSmsVerification(requestParameters, initOverrides) {
1627
1659
  return __awaiter(this, void 0, void 0, function* () {
@@ -1692,7 +1724,7 @@ class SDKApi extends BaseAPI {
1692
1724
  }
1693
1725
  /**
1694
1726
  * Create a new waas account
1695
- * Create a new waas account
1727
+ * Create a WAAS wallet
1696
1728
  */
1697
1729
  createWaasAccountRaw(requestParameters, initOverrides) {
1698
1730
  return __awaiter(this, void 0, void 0, function* () {
@@ -1724,7 +1756,7 @@ class SDKApi extends BaseAPI {
1724
1756
  }
1725
1757
  /**
1726
1758
  * Create a new waas account
1727
- * Create a new waas account
1759
+ * Create a WAAS wallet
1728
1760
  */
1729
1761
  createWaasAccount(requestParameters, initOverrides) {
1730
1762
  return __awaiter(this, void 0, void 0, function* () {
@@ -1830,7 +1862,7 @@ class SDKApi extends BaseAPI {
1830
1862
  }
1831
1863
  /**
1832
1864
  * Deletes the embedded wallets for a user
1833
- * Deletes the embedded wallets for a user
1865
+ * Delete embedded wallets for a user
1834
1866
  */
1835
1867
  deleteEmbeddedWalletsRaw(requestParameters, initOverrides) {
1836
1868
  return __awaiter(this, void 0, void 0, function* () {
@@ -1859,7 +1891,7 @@ class SDKApi extends BaseAPI {
1859
1891
  }
1860
1892
  /**
1861
1893
  * Deletes the embedded wallets for a user
1862
- * Deletes the embedded wallets for a user
1894
+ * Delete embedded wallets for a user
1863
1895
  */
1864
1896
  deleteEmbeddedWallets(requestParameters, initOverrides) {
1865
1897
  return __awaiter(this, void 0, void 0, function* () {
@@ -1867,7 +1899,8 @@ class SDKApi extends BaseAPI {
1867
1899
  });
1868
1900
  }
1869
1901
  /**
1870
- * Delete a device (if not default device)
1902
+ * Permanently removes an MFA device from the authenticated user account.
1903
+ * Delete an MFA device
1871
1904
  */
1872
1905
  deleteMfaDeviceRaw(requestParameters, initOverrides) {
1873
1906
  return __awaiter(this, void 0, void 0, function* () {
@@ -1902,7 +1935,8 @@ class SDKApi extends BaseAPI {
1902
1935
  });
1903
1936
  }
1904
1937
  /**
1905
- * Delete a device (if not default device)
1938
+ * Permanently removes an MFA device from the authenticated user account.
1939
+ * Delete an MFA device
1906
1940
  */
1907
1941
  deleteMfaDevice(requestParameters, initOverrides) {
1908
1942
  return __awaiter(this, void 0, void 0, function* () {
@@ -1910,6 +1944,7 @@ class SDKApi extends BaseAPI {
1910
1944
  });
1911
1945
  }
1912
1946
  /**
1947
+ * Permanently removes a passkey from the authenticated user account.
1913
1948
  * Delete a passkey
1914
1949
  */
1915
1950
  deletePasskeyRaw(requestParameters, initOverrides) {
@@ -1941,6 +1976,7 @@ class SDKApi extends BaseAPI {
1941
1976
  });
1942
1977
  }
1943
1978
  /**
1979
+ * Permanently removes a passkey from the authenticated user account.
1944
1980
  * Delete a passkey
1945
1981
  */
1946
1982
  deletePasskey(requestParameters, initOverrides) {
@@ -2024,7 +2060,8 @@ class SDKApi extends BaseAPI {
2024
2060
  });
2025
2061
  }
2026
2062
  /**
2027
- * Set a global wallet connection as disconnected
2063
+ * Disconnects the specified global wallet connection.
2064
+ * Disconnect a global wallet connection
2028
2065
  */
2029
2066
  disconnectGlobalWalletConnectionRaw(requestParameters, initOverrides) {
2030
2067
  return __awaiter(this, void 0, void 0, function* () {
@@ -2053,7 +2090,8 @@ class SDKApi extends BaseAPI {
2053
2090
  });
2054
2091
  }
2055
2092
  /**
2056
- * Set a global wallet connection as disconnected
2093
+ * Disconnects the specified global wallet connection.
2094
+ * Disconnect a global wallet connection
2057
2095
  */
2058
2096
  disconnectGlobalWalletConnection(requestParameters, initOverrides) {
2059
2097
  return __awaiter(this, void 0, void 0, function* () {
@@ -2277,7 +2315,8 @@ class SDKApi extends BaseAPI {
2277
2315
  });
2278
2316
  }
2279
2317
  /**
2280
- * Export private Key of a waas account
2318
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
2319
+ * Export a WAAS wallet private key
2281
2320
  */
2282
2321
  exportPrivateKeyRaw(requestParameters, initOverrides) {
2283
2322
  return __awaiter(this, void 0, void 0, function* () {
@@ -2311,7 +2350,8 @@ class SDKApi extends BaseAPI {
2311
2350
  });
2312
2351
  }
2313
2352
  /**
2314
- * Export private Key of a waas account
2353
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
2354
+ * Export a WAAS wallet private key
2315
2355
  */
2316
2356
  exportPrivateKey(requestParameters, initOverrides) {
2317
2357
  return __awaiter(this, void 0, void 0, function* () {
@@ -2350,7 +2390,8 @@ class SDKApi extends BaseAPI {
2350
2390
  });
2351
2391
  }
2352
2392
  /**
2353
- * Endpoint to sign-in using a token issued by an external auth provider
2393
+ * Authenticates a user using a token from an external auth provider.
2394
+ * Sign in with an external auth provider token
2354
2395
  */
2355
2396
  externalAuthSigninRaw(requestParameters, initOverrides) {
2356
2397
  return __awaiter(this, void 0, void 0, function* () {
@@ -2381,7 +2422,8 @@ class SDKApi extends BaseAPI {
2381
2422
  });
2382
2423
  }
2383
2424
  /**
2384
- * Endpoint to sign-in using a token issued by an external auth provider
2425
+ * Authenticates a user using a token from an external auth provider.
2426
+ * Sign in with an external auth provider token
2385
2427
  */
2386
2428
  externalAuthSignin(requestParameters, initOverrides) {
2387
2429
  return __awaiter(this, void 0, void 0, function* () {
@@ -2417,6 +2459,7 @@ class SDKApi extends BaseAPI {
2417
2459
  });
2418
2460
  }
2419
2461
  /**
2462
+ * [DEPRECATED] Please use /externalAuth/signin instead.
2420
2463
  * [DEPRECATED] Please use /externalAuth/signin instead
2421
2464
  */
2422
2465
  externalAuthVerifyRaw(requestParameters, initOverrides) {
@@ -2448,6 +2491,7 @@ class SDKApi extends BaseAPI {
2448
2491
  });
2449
2492
  }
2450
2493
  /**
2494
+ * [DEPRECATED] Please use /externalAuth/signin instead.
2451
2495
  * [DEPRECATED] Please use /externalAuth/signin instead
2452
2496
  */
2453
2497
  externalAuthVerify(requestParameters, initOverrides) {
@@ -2484,7 +2528,7 @@ class SDKApi extends BaseAPI {
2484
2528
  }
2485
2529
  /**
2486
2530
  * Farcaster SignIn endpoint to exchange SIWF data
2487
- * Farcaster provider SignIn endpoint
2531
+ * Sign in with Farcaster
2488
2532
  */
2489
2533
  farcasterSignInRaw(requestParameters, initOverrides) {
2490
2534
  return __awaiter(this, void 0, void 0, function* () {
@@ -2506,7 +2550,7 @@ class SDKApi extends BaseAPI {
2506
2550
  }
2507
2551
  /**
2508
2552
  * Farcaster SignIn endpoint to exchange SIWF data
2509
- * Farcaster provider SignIn endpoint
2553
+ * Sign in with Farcaster
2510
2554
  */
2511
2555
  farcasterSignIn(requestParameters, initOverrides) {
2512
2556
  return __awaiter(this, void 0, void 0, function* () {
@@ -2543,7 +2587,7 @@ class SDKApi extends BaseAPI {
2543
2587
  }
2544
2588
  /**
2545
2589
  * Farcaster Verify endpoint to exchange SIWF data
2546
- * Farcaster provider Verify endpoint
2590
+ * Verify Farcaster account linking
2547
2591
  */
2548
2592
  farcasterVerifyRaw(requestParameters, initOverrides) {
2549
2593
  return __awaiter(this, void 0, void 0, function* () {
@@ -2572,7 +2616,7 @@ class SDKApi extends BaseAPI {
2572
2616
  }
2573
2617
  /**
2574
2618
  * Farcaster Verify endpoint to exchange SIWF data
2575
- * Farcaster provider Verify endpoint
2619
+ * Verify Farcaster account linking
2576
2620
  */
2577
2621
  farcasterVerify(requestParameters, initOverrides) {
2578
2622
  return __awaiter(this, void 0, void 0, function* () {
@@ -2608,6 +2652,7 @@ class SDKApi extends BaseAPI {
2608
2652
  });
2609
2653
  }
2610
2654
  /**
2655
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
2611
2656
  * Generate a Coinbase onramp buy URL
2612
2657
  */
2613
2658
  generateCoinbaseOnrampBuyUrlRaw(requestParameters, initOverrides) {
@@ -2632,6 +2677,7 @@ class SDKApi extends BaseAPI {
2632
2677
  });
2633
2678
  }
2634
2679
  /**
2680
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
2635
2681
  * Generate a Coinbase onramp buy URL
2636
2682
  */
2637
2683
  generateCoinbaseOnrampBuyUrl(requestParameters, initOverrides) {
@@ -2641,7 +2687,8 @@ class SDKApi extends BaseAPI {
2641
2687
  });
2642
2688
  }
2643
2689
  /**
2644
- * Get the token balances for an account
2690
+ * Returns the token balances for a specific account address on a given chain.
2691
+ * Get token balances for an account
2645
2692
  */
2646
2693
  getAccountBalancesRaw(requestParameters, initOverrides) {
2647
2694
  return __awaiter(this, void 0, void 0, function* () {
@@ -2687,7 +2734,8 @@ class SDKApi extends BaseAPI {
2687
2734
  });
2688
2735
  }
2689
2736
  /**
2690
- * Get the token balances for an account
2737
+ * Returns the token balances for a specific account address on a given chain.
2738
+ * Get token balances for an account
2691
2739
  */
2692
2740
  getAccountBalances(requestParameters, initOverrides) {
2693
2741
  return __awaiter(this, void 0, void 0, function* () {
@@ -2741,7 +2789,8 @@ class SDKApi extends BaseAPI {
2741
2789
  });
2742
2790
  }
2743
2791
  /**
2744
- * Get auth token for given embedded wallet type
2792
+ * Returns an auth token for the specified embedded wallet type.
2793
+ * Get an auth token for an embedded wallet type
2745
2794
  */
2746
2795
  getAuthTokenRaw(requestParameters, initOverrides) {
2747
2796
  return __awaiter(this, void 0, void 0, function* () {
@@ -2770,7 +2819,8 @@ class SDKApi extends BaseAPI {
2770
2819
  });
2771
2820
  }
2772
2821
  /**
2773
- * Get auth token for given embedded wallet type
2822
+ * Returns an auth token for the specified embedded wallet type.
2823
+ * Get an auth token for an embedded wallet type
2774
2824
  */
2775
2825
  getAuthToken(requestParameters, initOverrides) {
2776
2826
  return __awaiter(this, void 0, void 0, function* () {
@@ -2806,7 +2856,8 @@ class SDKApi extends BaseAPI {
2806
2856
  });
2807
2857
  }
2808
2858
  /**
2809
- * Fetch user profile for the current authenticated user
2859
+ * Returns the full profile of the currently authenticated user.
2860
+ * Get the current user\'s profile
2810
2861
  */
2811
2862
  getAuthenticatedUserRaw(requestParameters, initOverrides) {
2812
2863
  return __awaiter(this, void 0, void 0, function* () {
@@ -2832,7 +2883,8 @@ class SDKApi extends BaseAPI {
2832
2883
  });
2833
2884
  }
2834
2885
  /**
2835
- * Fetch user profile for the current authenticated user
2886
+ * Returns the full profile of the currently authenticated user.
2887
+ * Get the current user\'s profile
2836
2888
  */
2837
2889
  getAuthenticatedUser(requestParameters, initOverrides) {
2838
2890
  return __awaiter(this, void 0, void 0, function* () {
@@ -2929,7 +2981,7 @@ class SDKApi extends BaseAPI {
2929
2981
  }
2930
2982
  /**
2931
2983
  * Generates the request body for a user\'s create V2 wallet account request
2932
- * Generates the request body for a user\'s create V2 wallet account request
2984
+ * Generate the create wallet account request body
2933
2985
  */
2934
2986
  getCreateWalletAccountRequestRaw(requestParameters, initOverrides) {
2935
2987
  return __awaiter(this, void 0, void 0, function* () {
@@ -2962,7 +3014,7 @@ class SDKApi extends BaseAPI {
2962
3014
  }
2963
3015
  /**
2964
3016
  * Generates the request body for a user\'s create V2 wallet account request
2965
- * Generates the request body for a user\'s create V2 wallet account request
3017
+ * Generate the create wallet account request body
2966
3018
  */
2967
3019
  getCreateWalletAccountRequest(requestParameters, initOverrides) {
2968
3020
  return __awaiter(this, void 0, void 0, function* () {
@@ -2972,6 +3024,7 @@ class SDKApi extends BaseAPI {
2972
3024
  }
2973
3025
  /**
2974
3026
  * Exchange rates for the given currency
3027
+ * Get currency exchange rates
2975
3028
  */
2976
3029
  getCurrencyExchangeRatesRaw(requestParameters, initOverrides) {
2977
3030
  return __awaiter(this, void 0, void 0, function* () {
@@ -2991,6 +3044,7 @@ class SDKApi extends BaseAPI {
2991
3044
  }
2992
3045
  /**
2993
3046
  * Exchange rates for the given currency
3047
+ * Get currency exchange rates
2994
3048
  */
2995
3049
  getCurrencyExchangeRates(requestParameters, initOverrides) {
2996
3050
  return __awaiter(this, void 0, void 0, function* () {
@@ -3027,7 +3081,7 @@ class SDKApi extends BaseAPI {
3027
3081
  }
3028
3082
  /**
3029
3083
  * 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.
3030
- * Get signin email provider
3084
+ * Get the sign-in email provider
3031
3085
  */
3032
3086
  getEmailProviderRaw(requestParameters, initOverrides) {
3033
3087
  return __awaiter(this, void 0, void 0, function* () {
@@ -3053,7 +3107,7 @@ class SDKApi extends BaseAPI {
3053
3107
  }
3054
3108
  /**
3055
3109
  * 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.
3056
- * Get signin email provider
3110
+ * Get the sign-in email provider
3057
3111
  */
3058
3112
  getEmailProvider(requestParameters, initOverrides) {
3059
3113
  return __awaiter(this, void 0, void 0, function* () {
@@ -3089,7 +3143,8 @@ class SDKApi extends BaseAPI {
3089
3143
  });
3090
3144
  }
3091
3145
  /**
3092
- * Return the backup key for the embedded wallet of the authenticated user
3146
+ * Returns the backup key for an embedded wallet.
3147
+ * Get the backup key for an embedded wallet
3093
3148
  */
3094
3149
  getEmbeddedWalletBackupsRaw(requestParameters, initOverrides) {
3095
3150
  return __awaiter(this, void 0, void 0, function* () {
@@ -3115,7 +3170,8 @@ class SDKApi extends BaseAPI {
3115
3170
  });
3116
3171
  }
3117
3172
  /**
3118
- * Return the backup key for the embedded wallet of the authenticated user
3173
+ * Returns the backup key for an embedded wallet.
3174
+ * Get the backup key for an embedded wallet
3119
3175
  */
3120
3176
  getEmbeddedWalletBackups(requestParameters, initOverrides) {
3121
3177
  return __awaiter(this, void 0, void 0, function* () {
@@ -3124,7 +3180,8 @@ class SDKApi extends BaseAPI {
3124
3180
  });
3125
3181
  }
3126
3182
  /**
3127
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
3183
+ * Returns the passcode for a pregenerated embedded wallet.
3184
+ * Get the passcode for a pregenerated embedded wallet
3128
3185
  */
3129
3186
  getEmbeddedWalletPasscodeRaw(requestParameters, initOverrides) {
3130
3187
  return __awaiter(this, void 0, void 0, function* () {
@@ -3150,7 +3207,8 @@ class SDKApi extends BaseAPI {
3150
3207
  });
3151
3208
  }
3152
3209
  /**
3153
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
3210
+ * Returns the passcode for a pregenerated embedded wallet.
3211
+ * Get the passcode for a pregenerated embedded wallet
3154
3212
  */
3155
3213
  getEmbeddedWalletPasscode(requestParameters, initOverrides) {
3156
3214
  return __awaiter(this, void 0, void 0, function* () {
@@ -3187,7 +3245,7 @@ class SDKApi extends BaseAPI {
3187
3245
  }
3188
3246
  /**
3189
3247
  * Generates the request body for a user\'s delete V2 wallets request
3190
- * Generates the request body for a user\'s delete V2 wallets request
3248
+ * Generate the delete wallets request body
3191
3249
  */
3192
3250
  getEmbeddedWalletsDeleteRequestRaw(requestParameters, initOverrides) {
3193
3251
  return __awaiter(this, void 0, void 0, function* () {
@@ -3217,7 +3275,7 @@ class SDKApi extends BaseAPI {
3217
3275
  }
3218
3276
  /**
3219
3277
  * Generates the request body for a user\'s delete V2 wallets request
3220
- * Generates the request body for a user\'s delete V2 wallets request
3278
+ * Generate the delete wallets request body
3221
3279
  */
3222
3280
  getEmbeddedWalletsDeleteRequest(requestParameters, initOverrides) {
3223
3281
  return __awaiter(this, void 0, void 0, function* () {
@@ -3226,6 +3284,7 @@ class SDKApi extends BaseAPI {
3226
3284
  });
3227
3285
  }
3228
3286
  /**
3287
+ * Returns the OAuth access token for the specified user OAuth account.
3229
3288
  * Get the access token for a user OAuth account
3230
3289
  */
3231
3290
  getEndUserOauthAccessTokenRaw(requestParameters, initOverrides) {
@@ -3248,6 +3307,7 @@ class SDKApi extends BaseAPI {
3248
3307
  });
3249
3308
  }
3250
3309
  /**
3310
+ * Returns the OAuth access token for the specified user OAuth account.
3251
3311
  * Get the access token for a user OAuth account
3252
3312
  */
3253
3313
  getEndUserOauthAccessToken(requestParameters, initOverrides) {
@@ -3287,7 +3347,8 @@ class SDKApi extends BaseAPI {
3287
3347
  });
3288
3348
  }
3289
3349
  /**
3290
- * Get the environment\'s settings
3350
+ * Returns the project settings and configuration for the specified environment.
3351
+ * Get environment settings
3291
3352
  */
3292
3353
  getEnvironmentSettingsRaw(requestParameters, initOverrides) {
3293
3354
  return __awaiter(this, void 0, void 0, function* () {
@@ -3309,7 +3370,8 @@ class SDKApi extends BaseAPI {
3309
3370
  });
3310
3371
  }
3311
3372
  /**
3312
- * Get the environment\'s settings
3373
+ * Returns the project settings and configuration for the specified environment.
3374
+ * Get environment settings
3313
3375
  */
3314
3376
  getEnvironmentSettings(requestParameters, initOverrides) {
3315
3377
  return __awaiter(this, void 0, void 0, function* () {
@@ -3318,6 +3380,7 @@ class SDKApi extends BaseAPI {
3318
3380
  });
3319
3381
  }
3320
3382
  /**
3383
+ * Returns the exchange account transactions for the authenticated user.
3321
3384
  * Get the exchange account transactions for a given dynamic user
3322
3385
  */
3323
3386
  getExchangeTransactionsRaw(requestParameters, initOverrides) {
@@ -3350,6 +3413,7 @@ class SDKApi extends BaseAPI {
3350
3413
  });
3351
3414
  }
3352
3415
  /**
3416
+ * Returns the exchange account transactions for the authenticated user.
3353
3417
  * Get the exchange account transactions for a given dynamic user
3354
3418
  */
3355
3419
  getExchangeTransactions(requestParameters, initOverrides) {
@@ -3389,6 +3453,7 @@ class SDKApi extends BaseAPI {
3389
3453
  });
3390
3454
  }
3391
3455
  /**
3456
+ * Returns the available transfer destinations for exchange account transactions.
3392
3457
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
3393
3458
  */
3394
3459
  getExchangeTransferDestinationsRaw(requestParameters, initOverrides) {
@@ -3418,6 +3483,7 @@ class SDKApi extends BaseAPI {
3418
3483
  });
3419
3484
  }
3420
3485
  /**
3486
+ * Returns the available transfer destinations for exchange account transactions.
3421
3487
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
3422
3488
  */
3423
3489
  getExchangeTransferDestinations(requestParameters, initOverrides) {
@@ -3457,6 +3523,7 @@ class SDKApi extends BaseAPI {
3457
3523
  });
3458
3524
  }
3459
3525
  /**
3526
+ * Returns the global wallet settings configured for the specified environment.
3460
3527
  * Get the global wallet settings for the environment
3461
3528
  */
3462
3529
  getGlobalWalletsSettingsRaw(requestParameters, initOverrides) {
@@ -3476,6 +3543,7 @@ class SDKApi extends BaseAPI {
3476
3543
  });
3477
3544
  }
3478
3545
  /**
3546
+ * Returns the global wallet settings configured for the specified environment.
3479
3547
  * Get the global wallet settings for the environment
3480
3548
  */
3481
3549
  getGlobalWalletsSettings(requestParameters, initOverrides) {
@@ -3486,6 +3554,7 @@ class SDKApi extends BaseAPI {
3486
3554
  }
3487
3555
  /**
3488
3556
  * Health check endpoint to check for uptime of API.
3557
+ * Check API health
3489
3558
  */
3490
3559
  getHealthcheckRaw(requestParameters, initOverrides) {
3491
3560
  return __awaiter(this, void 0, void 0, function* () {
@@ -3505,6 +3574,7 @@ class SDKApi extends BaseAPI {
3505
3574
  }
3506
3575
  /**
3507
3576
  * Health check endpoint to check for uptime of API.
3577
+ * Check API health
3508
3578
  */
3509
3579
  getHealthcheck(requestParameters, initOverrides) {
3510
3580
  return __awaiter(this, void 0, void 0, function* () {
@@ -3540,7 +3610,8 @@ class SDKApi extends BaseAPI {
3540
3610
  });
3541
3611
  }
3542
3612
  /**
3543
- * Find jwks for public key
3613
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
3614
+ * Get JWKS for the environment
3544
3615
  */
3545
3616
  getJwksByEnvironmentIdRaw(requestParameters, initOverrides) {
3546
3617
  return __awaiter(this, void 0, void 0, function* () {
@@ -3559,7 +3630,8 @@ class SDKApi extends BaseAPI {
3559
3630
  });
3560
3631
  }
3561
3632
  /**
3562
- * Find jwks for public key
3633
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
3634
+ * Get JWKS for the environment
3563
3635
  */
3564
3636
  getJwksByEnvironmentId(requestParameters, initOverrides) {
3565
3637
  return __awaiter(this, void 0, void 0, function* () {
@@ -3568,7 +3640,8 @@ class SDKApi extends BaseAPI {
3568
3640
  });
3569
3641
  }
3570
3642
  /**
3571
- * Find jwks for public key (JSON format)
3643
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
3644
+ * Get JWKS for the environment (JSON format)
3572
3645
  */
3573
3646
  getJwksJsonByEnvironmentIdRaw(requestParameters, initOverrides) {
3574
3647
  return __awaiter(this, void 0, void 0, function* () {
@@ -3587,7 +3660,8 @@ class SDKApi extends BaseAPI {
3587
3660
  });
3588
3661
  }
3589
3662
  /**
3590
- * Find jwks for public key (JSON format)
3663
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
3664
+ * Get JWKS for the environment (JSON format)
3591
3665
  */
3592
3666
  getJwksJsonByEnvironmentId(requestParameters, initOverrides) {
3593
3667
  return __awaiter(this, void 0, void 0, function* () {
@@ -3596,7 +3670,8 @@ class SDKApi extends BaseAPI {
3596
3670
  });
3597
3671
  }
3598
3672
  /**
3599
- * Get the current user\'s MFA by device id
3673
+ * Returns details of a specific MFA device by its ID.
3674
+ * Get an MFA device by ID
3600
3675
  */
3601
3676
  getMfaDeviceRaw(requestParameters, initOverrides) {
3602
3677
  return __awaiter(this, void 0, void 0, function* () {
@@ -3625,7 +3700,8 @@ class SDKApi extends BaseAPI {
3625
3700
  });
3626
3701
  }
3627
3702
  /**
3628
- * Get the current user\'s MFA by device id
3703
+ * Returns details of a specific MFA device by its ID.
3704
+ * Get an MFA device by ID
3629
3705
  */
3630
3706
  getMfaDevice(requestParameters, initOverrides) {
3631
3707
  return __awaiter(this, void 0, void 0, function* () {
@@ -3664,7 +3740,8 @@ class SDKApi extends BaseAPI {
3664
3740
  });
3665
3741
  }
3666
3742
  /**
3667
- * Find the configuration for the enabled networks associated to an environment
3743
+ * Returns the network configurations enabled for the specified environment.
3744
+ * Get network configurations for the environment
3668
3745
  */
3669
3746
  getNetworksConfigurationByEnvIdRaw(requestParameters, initOverrides) {
3670
3747
  return __awaiter(this, void 0, void 0, function* () {
@@ -3683,7 +3760,8 @@ class SDKApi extends BaseAPI {
3683
3760
  });
3684
3761
  }
3685
3762
  /**
3686
- * Find the configuration for the enabled networks associated to an environment
3763
+ * Returns the network configurations enabled for the specified environment.
3764
+ * Get network configurations for the environment
3687
3765
  */
3688
3766
  getNetworksConfigurationByEnvId(requestParameters, initOverrides) {
3689
3767
  return __awaiter(this, void 0, void 0, function* () {
@@ -3692,6 +3770,7 @@ class SDKApi extends BaseAPI {
3692
3770
  });
3693
3771
  }
3694
3772
  /**
3773
+ * Creates and returns a nonce for use in the wallet authentication flow.
3695
3774
  * Create nonce for authentication flow
3696
3775
  */
3697
3776
  getNonceRaw(requestParameters, initOverrides) {
@@ -3711,6 +3790,7 @@ class SDKApi extends BaseAPI {
3711
3790
  });
3712
3791
  }
3713
3792
  /**
3793
+ * Creates and returns a nonce for use in the wallet authentication flow.
3714
3794
  * Create nonce for authentication flow
3715
3795
  */
3716
3796
  getNonce(requestParameters, initOverrides) {
@@ -3720,7 +3800,8 @@ class SDKApi extends BaseAPI {
3720
3800
  });
3721
3801
  }
3722
3802
  /**
3723
- * Gets passkey authentication options
3803
+ * Returns the WebAuthn authentication options for passkey verification.
3804
+ * Get passkey authentication options
3724
3805
  */
3725
3806
  getPasskeyAuthenticationOptionsRaw(requestParameters, initOverrides) {
3726
3807
  return __awaiter(this, void 0, void 0, function* () {
@@ -3749,7 +3830,8 @@ class SDKApi extends BaseAPI {
3749
3830
  });
3750
3831
  }
3751
3832
  /**
3752
- * Gets passkey authentication options
3833
+ * Returns the WebAuthn authentication options for passkey verification.
3834
+ * Get passkey authentication options
3753
3835
  */
3754
3836
  getPasskeyAuthenticationOptions(requestParameters, initOverrides) {
3755
3837
  return __awaiter(this, void 0, void 0, function* () {
@@ -3788,7 +3870,8 @@ class SDKApi extends BaseAPI {
3788
3870
  });
3789
3871
  }
3790
3872
  /**
3791
- * Gets passkey authentication options
3873
+ * Returns the WebAuthn authentication options for passkey sign-in.
3874
+ * Get passkey sign-in options
3792
3875
  */
3793
3876
  getPasskeyAuthenticationSigninOptionsRaw(requestParameters, initOverrides) {
3794
3877
  return __awaiter(this, void 0, void 0, function* () {
@@ -3810,7 +3893,8 @@ class SDKApi extends BaseAPI {
3810
3893
  });
3811
3894
  }
3812
3895
  /**
3813
- * Gets passkey authentication options
3896
+ * Returns the WebAuthn authentication options for passkey sign-in.
3897
+ * Get passkey sign-in options
3814
3898
  */
3815
3899
  getPasskeyAuthenticationSigninOptions(requestParameters, initOverrides) {
3816
3900
  return __awaiter(this, void 0, void 0, function* () {
@@ -3819,7 +3903,8 @@ class SDKApi extends BaseAPI {
3819
3903
  });
3820
3904
  }
3821
3905
  /**
3822
- * Gets passkey data associated with a user
3906
+ * Returns the WebAuthn registration options needed to register a new passkey.
3907
+ * Get user passkeys
3823
3908
  */
3824
3909
  getPasskeyRegistrationOptionsRaw(requestParameters, initOverrides) {
3825
3910
  return __awaiter(this, void 0, void 0, function* () {
@@ -3838,7 +3923,8 @@ class SDKApi extends BaseAPI {
3838
3923
  });
3839
3924
  }
3840
3925
  /**
3841
- * Gets passkey data associated with a user
3926
+ * Returns the WebAuthn registration options needed to register a new passkey.
3927
+ * Get user passkeys
3842
3928
  */
3843
3929
  getPasskeyRegistrationOptions(requestParameters, initOverrides) {
3844
3930
  return __awaiter(this, void 0, void 0, function* () {
@@ -3874,6 +3960,7 @@ class SDKApi extends BaseAPI {
3874
3960
  });
3875
3961
  }
3876
3962
  /**
3963
+ * Returns the MFA recovery codes for the authenticated user.
3877
3964
  * Get recovery codes
3878
3965
  */
3879
3966
  getRecoveryCodesRaw(requestParameters, initOverrides) {
@@ -3900,6 +3987,7 @@ class SDKApi extends BaseAPI {
3900
3987
  });
3901
3988
  }
3902
3989
  /**
3990
+ * Returns the MFA recovery codes for the authenticated user.
3903
3991
  * Get recovery codes
3904
3992
  */
3905
3993
  getRecoveryCodes(requestParameters, initOverrides) {
@@ -3910,7 +3998,7 @@ class SDKApi extends BaseAPI {
3910
3998
  }
3911
3999
  /**
3912
4000
  * Find the configuration for the enabled offramps associated to an environment
3913
- * Configuration for enabled offramps
4001
+ * Get enabled offramps for the environment
3914
4002
  */
3915
4003
  getSupportedOfframpsRaw(requestParameters, initOverrides) {
3916
4004
  return __awaiter(this, void 0, void 0, function* () {
@@ -3948,7 +4036,7 @@ class SDKApi extends BaseAPI {
3948
4036
  }
3949
4037
  /**
3950
4038
  * Find the configuration for the enabled offramps associated to an environment
3951
- * Configuration for enabled offramps
4039
+ * Get enabled offramps for the environment
3952
4040
  */
3953
4041
  getSupportedOfframps(requestParameters, initOverrides) {
3954
4042
  return __awaiter(this, void 0, void 0, function* () {
@@ -3958,7 +4046,7 @@ class SDKApi extends BaseAPI {
3958
4046
  }
3959
4047
  /**
3960
4048
  * Find the configuration for the enabled onramps associated to an environment
3961
- * Configuration for enabled onramps
4049
+ * Get enabled onramps for the environment
3962
4050
  */
3963
4051
  getSupportedOnrampsRaw(requestParameters, initOverrides) {
3964
4052
  return __awaiter(this, void 0, void 0, function* () {
@@ -4008,7 +4096,7 @@ class SDKApi extends BaseAPI {
4008
4096
  }
4009
4097
  /**
4010
4098
  * Find the configuration for the enabled onramps associated to an environment
4011
- * Configuration for enabled onramps
4099
+ * Get enabled onramps for the environment
4012
4100
  */
4013
4101
  getSupportedOnramps(requestParameters, initOverrides) {
4014
4102
  return __awaiter(this, void 0, void 0, function* () {
@@ -4017,7 +4105,8 @@ class SDKApi extends BaseAPI {
4017
4105
  });
4018
4106
  }
4019
4107
  /**
4020
- * Get HTML with rendered Telegram login widget
4108
+ * Returns the HTML content for the Telegram login widget.
4109
+ * Get Telegram login widget HTML
4021
4110
  */
4022
4111
  getTelegramAuthRaw(requestParameters, initOverrides) {
4023
4112
  return __awaiter(this, void 0, void 0, function* () {
@@ -4042,7 +4131,8 @@ class SDKApi extends BaseAPI {
4042
4131
  });
4043
4132
  }
4044
4133
  /**
4045
- * Get HTML with rendered Telegram login widget
4134
+ * Returns the HTML content for the Telegram login widget.
4135
+ * Get Telegram login widget HTML
4046
4136
  */
4047
4137
  getTelegramAuth(requestParameters, initOverrides) {
4048
4138
  return __awaiter(this, void 0, void 0, function* () {
@@ -4051,6 +4141,7 @@ class SDKApi extends BaseAPI {
4051
4141
  });
4052
4142
  }
4053
4143
  /**
4144
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
4054
4145
  * Get the exchange accounts for a given dynamic user
4055
4146
  */
4056
4147
  getUserAccountsRaw(requestParameters, initOverrides) {
@@ -4086,6 +4177,7 @@ class SDKApi extends BaseAPI {
4086
4177
  });
4087
4178
  }
4088
4179
  /**
4180
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
4089
4181
  * Get the exchange accounts for a given dynamic user
4090
4182
  */
4091
4183
  getUserAccounts(requestParameters, initOverrides) {
@@ -4192,7 +4284,8 @@ class SDKApi extends BaseAPI {
4192
4284
  });
4193
4285
  }
4194
4286
  /**
4195
- * Get the current user\'s MFA Devices
4287
+ * Returns the list of MFA devices registered for the authenticated user.
4288
+ * Get the current user\'s MFA devices
4196
4289
  */
4197
4290
  getUserMfaDevicesRaw(requestParameters, initOverrides) {
4198
4291
  return __awaiter(this, void 0, void 0, function* () {
@@ -4218,7 +4311,8 @@ class SDKApi extends BaseAPI {
4218
4311
  });
4219
4312
  }
4220
4313
  /**
4221
- * Get the current user\'s MFA Devices
4314
+ * Returns the list of MFA devices registered for the authenticated user.
4315
+ * Get the current user\'s MFA devices
4222
4316
  */
4223
4317
  getUserMfaDevices(requestParameters, initOverrides) {
4224
4318
  return __awaiter(this, void 0, void 0, function* () {
@@ -4227,7 +4321,8 @@ class SDKApi extends BaseAPI {
4227
4321
  });
4228
4322
  }
4229
4323
  /**
4230
- * Get the current user\'s MFA Methods
4324
+ * Returns the available MFA methods for the authenticated user.
4325
+ * Get the current user\'s MFA methods
4231
4326
  */
4232
4327
  getUserMfaMethodsRaw(requestParameters, initOverrides) {
4233
4328
  return __awaiter(this, void 0, void 0, function* () {
@@ -4256,7 +4351,8 @@ class SDKApi extends BaseAPI {
4256
4351
  });
4257
4352
  }
4258
4353
  /**
4259
- * Get the current user\'s MFA Methods
4354
+ * Returns the available MFA methods for the authenticated user.
4355
+ * Get the current user\'s MFA methods
4260
4356
  */
4261
4357
  getUserMfaMethods(requestParameters, initOverrides) {
4262
4358
  return __awaiter(this, void 0, void 0, function* () {
@@ -4265,7 +4361,8 @@ class SDKApi extends BaseAPI {
4265
4361
  });
4266
4362
  }
4267
4363
  /**
4268
- * Gets passkey data associated with a user
4364
+ * Returns the list of passkeys registered for the authenticated user.
4365
+ * Get user passkeys
4269
4366
  */
4270
4367
  getUserPasskeysRaw(requestParameters, initOverrides) {
4271
4368
  return __awaiter(this, void 0, void 0, function* () {
@@ -4291,7 +4388,8 @@ class SDKApi extends BaseAPI {
4291
4388
  });
4292
4389
  }
4293
4390
  /**
4294
- * Gets passkey data associated with a user
4391
+ * Returns the list of passkeys registered for the authenticated user.
4392
+ * Get user passkeys
4295
4393
  */
4296
4394
  getUserPasskeys(requestParameters, initOverrides) {
4297
4395
  return __awaiter(this, void 0, void 0, function* () {
@@ -4301,7 +4399,7 @@ class SDKApi extends BaseAPI {
4301
4399
  }
4302
4400
  /**
4303
4401
  * 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.
4304
- * Fetch a single WaaS wallet with verified credentials
4402
+ * Get a WAAS wallet by address
4305
4403
  */
4306
4404
  getWaasWalletWithVerifiedCredentialsRaw(requestParameters, initOverrides) {
4307
4405
  return __awaiter(this, void 0, void 0, function* () {
@@ -4331,7 +4429,7 @@ class SDKApi extends BaseAPI {
4331
4429
  }
4332
4430
  /**
4333
4431
  * 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.
4334
- * Fetch a single WaaS wallet with verified credentials
4432
+ * Get a WAAS wallet by address
4335
4433
  */
4336
4434
  getWaasWalletWithVerifiedCredentials(requestParameters, initOverrides) {
4337
4435
  return __awaiter(this, void 0, void 0, function* () {
@@ -4525,7 +4623,7 @@ class SDKApi extends BaseAPI {
4525
4623
  }
4526
4624
  /**
4527
4625
  * Hard delete the authenticated user
4528
- * Hard delete a user
4626
+ * Delete the current user
4529
4627
  */
4530
4628
  hardDeleteUserRaw(requestParameters, initOverrides) {
4531
4629
  return __awaiter(this, void 0, void 0, function* () {
@@ -4552,7 +4650,7 @@ class SDKApi extends BaseAPI {
4552
4650
  }
4553
4651
  /**
4554
4652
  * Hard delete the authenticated user
4555
- * Hard delete a user
4653
+ * Delete the current user
4556
4654
  */
4557
4655
  hardDeleteUser(requestParameters, initOverrides) {
4558
4656
  return __awaiter(this, void 0, void 0, function* () {
@@ -4561,7 +4659,7 @@ class SDKApi extends BaseAPI {
4561
4659
  }
4562
4660
  /**
4563
4661
  * Import a private key to create a waas account
4564
- * Import an existing private key to create a waas account
4662
+ * Import a private key to create a WAAS wallet
4565
4663
  */
4566
4664
  importPrivateKeyRaw(requestParameters, initOverrides) {
4567
4665
  return __awaiter(this, void 0, void 0, function* () {
@@ -4593,7 +4691,7 @@ class SDKApi extends BaseAPI {
4593
4691
  }
4594
4692
  /**
4595
4693
  * Import a private key to create a waas account
4596
- * Import an existing private key to create a waas account
4694
+ * Import a private key to create a WAAS wallet
4597
4695
  */
4598
4696
  importPrivateKey(requestParameters, initOverrides) {
4599
4697
  return __awaiter(this, void 0, void 0, function* () {
@@ -4630,7 +4728,7 @@ class SDKApi extends BaseAPI {
4630
4728
  }
4631
4729
  /**
4632
4730
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
4633
- * Initialize oauth auth sequence
4731
+ * Initialize an OAuth authentication sequence
4634
4732
  */
4635
4733
  initAuthRaw(requestParameters, initOverrides) {
4636
4734
  return __awaiter(this, void 0, void 0, function* () {
@@ -4658,7 +4756,7 @@ class SDKApi extends BaseAPI {
4658
4756
  }
4659
4757
  /**
4660
4758
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
4661
- * Initialize oauth auth sequence
4759
+ * Initialize an OAuth authentication sequence
4662
4760
  */
4663
4761
  initAuth(requestParameters, initOverrides) {
4664
4762
  return __awaiter(this, void 0, void 0, function* () {
@@ -4835,7 +4933,7 @@ class SDKApi extends BaseAPI {
4835
4933
  }
4836
4934
  /**
4837
4935
  * Generates the turnkey request body for a user\'s delete wallets request
4838
- * Generates the turnkey request body for a user\'s delete wallets request
4936
+ * Generate the delete wallets request body
4839
4937
  */
4840
4938
  legacyGetEmbeddedWalletsDeleteRequestRaw(requestParameters, initOverrides) {
4841
4939
  return __awaiter(this, void 0, void 0, function* () {
@@ -4862,7 +4960,7 @@ class SDKApi extends BaseAPI {
4862
4960
  }
4863
4961
  /**
4864
4962
  * Generates the turnkey request body for a user\'s delete wallets request
4865
- * Generates the turnkey request body for a user\'s delete wallets request
4963
+ * Generate the delete wallets request body
4866
4964
  */
4867
4965
  legacyGetEmbeddedWalletsDeleteRequest(requestParameters, initOverrides) {
4868
4966
  return __awaiter(this, void 0, void 0, function* () {
@@ -4928,7 +5026,8 @@ class SDKApi extends BaseAPI {
4928
5026
  });
4929
5027
  }
4930
5028
  /**
4931
- * Update SDK settings for a specific environment
5029
+ * Logs the SDK settings being used by the client for the environment.
5030
+ * Update SDK settings for the environment
4932
5031
  */
4933
5032
  logDynamicSdkSettingsRaw(requestParameters, initOverrides) {
4934
5033
  return __awaiter(this, void 0, void 0, function* () {
@@ -4952,7 +5051,8 @@ class SDKApi extends BaseAPI {
4952
5051
  });
4953
5052
  }
4954
5053
  /**
4955
- * Update SDK settings for a specific environment
5054
+ * Logs the SDK settings being used by the client for the environment.
5055
+ * Update SDK settings for the environment
4956
5056
  */
4957
5057
  logDynamicSdkSettings(requestParameters, initOverrides) {
4958
5058
  return __awaiter(this, void 0, void 0, function* () {
@@ -4961,7 +5061,7 @@ class SDKApi extends BaseAPI {
4961
5061
  }
4962
5062
  /**
4963
5063
  * Used to merge two owned accounts connected by email address
4964
- * After successful verification allow to merge two owned accounts
5064
+ * Merge two owned accounts
4965
5065
  */
4966
5066
  mergeUsersRaw(requestParameters, initOverrides) {
4967
5067
  return __awaiter(this, void 0, void 0, function* () {
@@ -4988,7 +5088,7 @@ class SDKApi extends BaseAPI {
4988
5088
  }
4989
5089
  /**
4990
5090
  * Used to merge two owned accounts connected by email address
4991
- * After successful verification allow to merge two owned accounts
5091
+ * Merge two owned accounts
4992
5092
  */
4993
5093
  mergeUsers(requestParameters, initOverrides) {
4994
5094
  return __awaiter(this, void 0, void 0, function* () {
@@ -5079,7 +5179,7 @@ class SDKApi extends BaseAPI {
5079
5179
  }
5080
5180
  /**
5081
5181
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
5082
- * Oauth provider authorization endpoint
5182
+ * Get OAuth provider authorization HTML
5083
5183
  */
5084
5184
  oauthAuthorizeHtmlRaw(requestParameters, initOverrides) {
5085
5185
  return __awaiter(this, void 0, void 0, function* () {
@@ -5111,7 +5211,7 @@ class SDKApi extends BaseAPI {
5111
5211
  }
5112
5212
  /**
5113
5213
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
5114
- * Oauth provider authorization endpoint
5214
+ * Get OAuth provider authorization HTML
5115
5215
  */
5116
5216
  oauthAuthorizeHtml(requestParameters, initOverrides) {
5117
5217
  return __awaiter(this, void 0, void 0, function* () {
@@ -5150,7 +5250,8 @@ class SDKApi extends BaseAPI {
5150
5250
  });
5151
5251
  }
5152
5252
  /**
5153
- * Get redirect URL for Oauth provider login
5253
+ * Redirects the user to the specified OAuth provider login page.
5254
+ * Redirect to OAuth provider login
5154
5255
  */
5155
5256
  oauthLoginRaw(requestParameters, initOverrides) {
5156
5257
  return __awaiter(this, void 0, void 0, function* () {
@@ -5172,7 +5273,8 @@ class SDKApi extends BaseAPI {
5172
5273
  });
5173
5274
  }
5174
5275
  /**
5175
- * Get redirect URL for Oauth provider login
5276
+ * Redirects the user to the specified OAuth provider login page.
5277
+ * Redirect to OAuth provider login
5176
5278
  */
5177
5279
  oauthLogin(requestParameters, initOverrides) {
5178
5280
  return __awaiter(this, void 0, void 0, function* () {
@@ -5210,7 +5312,8 @@ class SDKApi extends BaseAPI {
5210
5312
  });
5211
5313
  }
5212
5314
  /**
5213
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
5315
+ * Returns the login URL for the specified OAuth provider.
5316
+ * Get the OAuth provider login URL
5214
5317
  */
5215
5318
  oauthLoginUrlRaw(requestParameters, initOverrides) {
5216
5319
  return __awaiter(this, void 0, void 0, function* () {
@@ -5232,7 +5335,8 @@ class SDKApi extends BaseAPI {
5232
5335
  });
5233
5336
  }
5234
5337
  /**
5235
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
5338
+ * Returns the login URL for the specified OAuth provider.
5339
+ * Get the OAuth provider login URL
5236
5340
  */
5237
5341
  oauthLoginUrl(requestParameters, initOverrides) {
5238
5342
  return __awaiter(this, void 0, void 0, function* () {
@@ -5272,7 +5376,7 @@ class SDKApi extends BaseAPI {
5272
5376
  }
5273
5377
  /**
5274
5378
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5275
- * Oauth provider redirect endpoint for apple ID
5379
+ * Handle Apple ID OAuth redirect
5276
5380
  */
5277
5381
  oauthRedirectAppleRaw(requestParameters, initOverrides) {
5278
5382
  return __awaiter(this, void 0, void 0, function* () {
@@ -5314,7 +5418,7 @@ class SDKApi extends BaseAPI {
5314
5418
  }
5315
5419
  /**
5316
5420
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5317
- * Oauth provider redirect endpoint for apple ID
5421
+ * Handle Apple ID OAuth redirect
5318
5422
  */
5319
5423
  oauthRedirectApple(requestParameters, initOverrides) {
5320
5424
  return __awaiter(this, void 0, void 0, function* () {
@@ -5351,7 +5455,7 @@ class SDKApi extends BaseAPI {
5351
5455
  }
5352
5456
  /**
5353
5457
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5354
- * Oauth provider redirect endpoint
5458
+ * Handle OAuth provider redirect
5355
5459
  */
5356
5460
  oauthRedirectCodeRaw(requestParameters, initOverrides) {
5357
5461
  return __awaiter(this, void 0, void 0, function* () {
@@ -5392,7 +5496,7 @@ class SDKApi extends BaseAPI {
5392
5496
  }
5393
5497
  /**
5394
5498
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5395
- * Oauth provider redirect endpoint
5499
+ * Handle OAuth provider redirect
5396
5500
  */
5397
5501
  oauthRedirectCode(requestParameters, initOverrides) {
5398
5502
  return __awaiter(this, void 0, void 0, function* () {
@@ -5431,7 +5535,8 @@ class SDKApi extends BaseAPI {
5431
5535
  });
5432
5536
  }
5433
5537
  /**
5434
- * Returns the authorization code or error retuned by oauth provider
5538
+ * Returns the OAuth authorization result for the given state.
5539
+ * Get the OAuth provider authorization result
5435
5540
  */
5436
5541
  oauthResultRaw(requestParameters, initOverrides) {
5437
5542
  return __awaiter(this, void 0, void 0, function* () {
@@ -5458,7 +5563,8 @@ class SDKApi extends BaseAPI {
5458
5563
  });
5459
5564
  }
5460
5565
  /**
5461
- * Returns the authorization code or error retuned by oauth provider
5566
+ * Returns the OAuth authorization result for the given state.
5567
+ * Get the OAuth provider authorization result
5462
5568
  */
5463
5569
  oauthResult(requestParameters, initOverrides) {
5464
5570
  return __awaiter(this, void 0, void 0, function* () {
@@ -5497,8 +5603,8 @@ class SDKApi extends BaseAPI {
5497
5603
  });
5498
5604
  }
5499
5605
  /**
5500
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
5501
- * Oauth provider SignIn endpoint
5606
+ * Standard OAuth SignIn callback to exchange temporary code for oauth access and return a valid Dynamic JWT and user
5607
+ * Sign in with OAuth provider
5502
5608
  */
5503
5609
  oauthSignInRaw(requestParameters, initOverrides) {
5504
5610
  return __awaiter(this, void 0, void 0, function* () {
@@ -5525,8 +5631,8 @@ class SDKApi extends BaseAPI {
5525
5631
  });
5526
5632
  }
5527
5633
  /**
5528
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
5529
- * Oauth provider SignIn endpoint
5634
+ * Standard OAuth SignIn callback to exchange temporary code for oauth access and return a valid Dynamic JWT and user
5635
+ * Sign in with OAuth provider
5530
5636
  */
5531
5637
  oauthSignIn(requestParameters, initOverrides) {
5532
5638
  return __awaiter(this, void 0, void 0, function* () {
@@ -5565,8 +5671,8 @@ class SDKApi extends BaseAPI {
5565
5671
  });
5566
5672
  }
5567
5673
  /**
5568
- * Standard OAuth verify callback to exchange temproary code for oauth access
5569
- * Oauth provider verify endpoint
5674
+ * Standard OAuth verify callback to exchange temporary code for oauth access
5675
+ * Verify OAuth provider authorization
5570
5676
  */
5571
5677
  oauthVerifyRaw(requestParameters, initOverrides) {
5572
5678
  return __awaiter(this, void 0, void 0, function* () {
@@ -5593,8 +5699,8 @@ class SDKApi extends BaseAPI {
5593
5699
  });
5594
5700
  }
5595
5701
  /**
5596
- * Standard OAuth verify callback to exchange temproary code for oauth access
5597
- * Oauth provider verify endpoint
5702
+ * Standard OAuth verify callback to exchange temporary code for oauth access
5703
+ * Verify OAuth provider authorization
5598
5704
  */
5599
5705
  oauthVerify(requestParameters, initOverrides) {
5600
5706
  return __awaiter(this, void 0, void 0, function* () {
@@ -5687,6 +5793,7 @@ class SDKApi extends BaseAPI {
5687
5793
  });
5688
5794
  }
5689
5795
  /**
5796
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
5690
5797
  * Add fees to a Solana transaction
5691
5798
  */
5692
5799
  optimizeTransactionRaw(requestParameters, initOverrides) {
@@ -5711,6 +5818,7 @@ class SDKApi extends BaseAPI {
5711
5818
  });
5712
5819
  }
5713
5820
  /**
5821
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
5714
5822
  * Add fees to a Solana transaction
5715
5823
  */
5716
5824
  optimizeTransaction(requestParameters, initOverrides) {
@@ -5801,6 +5909,7 @@ class SDKApi extends BaseAPI {
5801
5909
  });
5802
5910
  }
5803
5911
  /**
5912
+ * Transfers funds from an exchange account to an external address or another account.
5804
5913
  * Transfer funds from an exchange account to an external address or another Coinbase account
5805
5914
  */
5806
5915
  postExchangeAccountTransferRaw(requestParameters, initOverrides) {
@@ -5838,6 +5947,7 @@ class SDKApi extends BaseAPI {
5838
5947
  });
5839
5948
  }
5840
5949
  /**
5950
+ * Transfers funds from an exchange account to an external address or another account.
5841
5951
  * Transfer funds from an exchange account to an external address or another Coinbase account
5842
5952
  */
5843
5953
  postExchangeAccountTransfer(requestParameters, initOverrides) {
@@ -5880,6 +5990,7 @@ class SDKApi extends BaseAPI {
5880
5990
  });
5881
5991
  }
5882
5992
  /**
5993
+ * Returns token balances for multiple account addresses across different chains.
5883
5994
  * Get account balances for multiple addresses
5884
5995
  */
5885
5996
  postMultichainAccountBalancesRaw(requestParameters, initOverrides) {
@@ -5904,6 +6015,7 @@ class SDKApi extends BaseAPI {
5904
6015
  });
5905
6016
  }
5906
6017
  /**
6018
+ * Returns token balances for multiple account addresses across different chains.
5907
6019
  * Get account balances for multiple addresses
5908
6020
  */
5909
6021
  postMultichainAccountBalances(requestParameters, initOverrides) {
@@ -5945,6 +6057,7 @@ class SDKApi extends BaseAPI {
5945
6057
  });
5946
6058
  }
5947
6059
  /**
6060
+ * Handles the Telegram authentication callback after user authorization.
5948
6061
  * Handle Telegram authentication
5949
6062
  */
5950
6063
  postTelegramAuthRaw(requestParameters, initOverrides) {
@@ -5969,6 +6082,7 @@ class SDKApi extends BaseAPI {
5969
6082
  });
5970
6083
  }
5971
6084
  /**
6085
+ * Handles the Telegram authentication callback after user authorization.
5972
6086
  * Handle Telegram authentication
5973
6087
  */
5974
6088
  postTelegramAuth(requestParameters, initOverrides) {
@@ -5978,7 +6092,7 @@ class SDKApi extends BaseAPI {
5978
6092
  }
5979
6093
  /**
5980
6094
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
5981
- * prefetch information for wallet address
6095
+ * Prefetch information for a wallet address
5982
6096
  */
5983
6097
  prefetchRaw(requestParameters, initOverrides) {
5984
6098
  return __awaiter(this, void 0, void 0, function* () {
@@ -6003,7 +6117,7 @@ class SDKApi extends BaseAPI {
6003
6117
  }
6004
6118
  /**
6005
6119
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
6006
- * prefetch information for wallet address
6120
+ * Prefetch information for a wallet address
6007
6121
  */
6008
6122
  prefetch(requestParameters, initOverrides) {
6009
6123
  return __awaiter(this, void 0, void 0, function* () {
@@ -6011,7 +6125,8 @@ class SDKApi extends BaseAPI {
6011
6125
  });
6012
6126
  }
6013
6127
  /**
6014
- * Publish events for SDK
6128
+ * Publishes SDK analytics events for the given environment.
6129
+ * Publish SDK events
6015
6130
  */
6016
6131
  publishEventRaw(requestParameters, initOverrides) {
6017
6132
  return __awaiter(this, void 0, void 0, function* () {
@@ -6035,7 +6150,8 @@ class SDKApi extends BaseAPI {
6035
6150
  });
6036
6151
  }
6037
6152
  /**
6038
- * Publish events for SDK
6153
+ * Publishes SDK analytics events for the given environment.
6154
+ * Publish SDK events
6039
6155
  */
6040
6156
  publishEvent(requestParameters, initOverrides) {
6041
6157
  return __awaiter(this, void 0, void 0, function* () {
@@ -6043,7 +6159,8 @@ class SDKApi extends BaseAPI {
6043
6159
  });
6044
6160
  }
6045
6161
  /**
6046
- * Recover multiple keyShares
6162
+ * Recovers the client key shares for the specified WAAS wallet from backup.
6163
+ * Recover WAAS keyshares
6047
6164
  */
6048
6165
  recoverKeySharesRaw(requestParameters, initOverrides) {
6049
6166
  return __awaiter(this, void 0, void 0, function* () {
@@ -6074,7 +6191,8 @@ class SDKApi extends BaseAPI {
6074
6191
  });
6075
6192
  }
6076
6193
  /**
6077
- * Recover multiple keyShares
6194
+ * Recovers the client key shares for the specified WAAS wallet from backup.
6195
+ * Recover WAAS keyshares
6078
6196
  */
6079
6197
  recoverKeyShares(requestParameters, initOverrides) {
6080
6198
  return __awaiter(this, void 0, void 0, function* () {
@@ -6167,7 +6285,8 @@ class SDKApi extends BaseAPI {
6167
6285
  });
6168
6286
  }
6169
6287
  /**
6170
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
6288
+ * Refreshes the JWT auth token and returns a new token with updated claims.
6289
+ * Refresh the JWT auth token
6171
6290
  */
6172
6291
  refreshAuthRaw(requestParameters, initOverrides) {
6173
6292
  return __awaiter(this, void 0, void 0, function* () {
@@ -6193,7 +6312,8 @@ class SDKApi extends BaseAPI {
6193
6312
  });
6194
6313
  }
6195
6314
  /**
6196
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
6315
+ * Refreshes the JWT auth token and returns a new token with updated claims.
6316
+ * Refresh the JWT auth token
6197
6317
  */
6198
6318
  refreshAuth(requestParameters, initOverrides) {
6199
6319
  return __awaiter(this, void 0, void 0, function* () {
@@ -6202,7 +6322,8 @@ class SDKApi extends BaseAPI {
6202
6322
  });
6203
6323
  }
6204
6324
  /**
6205
- * Refresh keyshares
6325
+ * Refreshes the MPC key shares for the specified WAAS wallet.
6326
+ * Refresh WAAS keyshares
6206
6327
  */
6207
6328
  refreshKeySharesRaw(requestParameters, initOverrides) {
6208
6329
  return __awaiter(this, void 0, void 0, function* () {
@@ -6231,7 +6352,8 @@ class SDKApi extends BaseAPI {
6231
6352
  });
6232
6353
  }
6233
6354
  /**
6234
- * Refresh keyshares
6355
+ * Refreshes the MPC key shares for the specified WAAS wallet.
6356
+ * Refresh WAAS keyshares
6235
6357
  */
6236
6358
  refreshKeyShares(requestParameters, initOverrides) {
6237
6359
  return __awaiter(this, void 0, void 0, function* () {
@@ -6297,6 +6419,7 @@ class SDKApi extends BaseAPI {
6297
6419
  });
6298
6420
  }
6299
6421
  /**
6422
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
6300
6423
  * Register a new passkey
6301
6424
  */
6302
6425
  registerPasskeyRaw(requestParameters, initOverrides) {
@@ -6328,6 +6451,7 @@ class SDKApi extends BaseAPI {
6328
6451
  });
6329
6452
  }
6330
6453
  /**
6454
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
6331
6455
  * Register a new passkey
6332
6456
  */
6333
6457
  registerPasskey(requestParameters, initOverrides) {
@@ -6337,7 +6461,8 @@ class SDKApi extends BaseAPI {
6337
6461
  });
6338
6462
  }
6339
6463
  /**
6340
- * Register a new Passkey MFA device
6464
+ * Initiates passkey MFA device registration and returns the setup details.
6465
+ * Register a passkey MFA device
6341
6466
  */
6342
6467
  registerPasskeyMfaDeviceRaw(requestParameters, initOverrides) {
6343
6468
  return __awaiter(this, void 0, void 0, function* () {
@@ -6363,7 +6488,8 @@ class SDKApi extends BaseAPI {
6363
6488
  });
6364
6489
  }
6365
6490
  /**
6366
- * Register a new Passkey MFA device
6491
+ * Initiates passkey MFA device registration and returns the setup details.
6492
+ * Register a passkey MFA device
6367
6493
  */
6368
6494
  registerPasskeyMfaDevice(requestParameters, initOverrides) {
6369
6495
  return __awaiter(this, void 0, void 0, function* () {
@@ -6399,6 +6525,7 @@ class SDKApi extends BaseAPI {
6399
6525
  });
6400
6526
  }
6401
6527
  /**
6528
+ * Verifies the passkey credential to complete MFA device registration.
6402
6529
  * Verify Passkey MFA device
6403
6530
  */
6404
6531
  registerPasskeyMfaDeviceVerifyRaw(requestParameters, initOverrides) {
@@ -6430,6 +6557,7 @@ class SDKApi extends BaseAPI {
6430
6557
  });
6431
6558
  }
6432
6559
  /**
6560
+ * Verifies the passkey credential to complete MFA device registration.
6433
6561
  * Verify Passkey MFA device
6434
6562
  */
6435
6563
  registerPasskeyMfaDeviceVerify(requestParameters, initOverrides) {
@@ -6481,7 +6609,8 @@ class SDKApi extends BaseAPI {
6481
6609
  });
6482
6610
  }
6483
6611
  /**
6484
- * Register a new TOTP MFA device and get Totp Secret
6612
+ * Initiates TOTP MFA device registration and returns the setup details.
6613
+ * Register a TOTP MFA device
6485
6614
  */
6486
6615
  registerTotpMfaDeviceRaw(requestParameters, initOverrides) {
6487
6616
  return __awaiter(this, void 0, void 0, function* () {
@@ -6507,7 +6636,8 @@ class SDKApi extends BaseAPI {
6507
6636
  });
6508
6637
  }
6509
6638
  /**
6510
- * Register a new TOTP MFA device and get Totp Secret
6639
+ * Initiates TOTP MFA device registration and returns the setup details.
6640
+ * Register a TOTP MFA device
6511
6641
  */
6512
6642
  registerTotpMfaDevice(requestParameters, initOverrides) {
6513
6643
  return __awaiter(this, void 0, void 0, function* () {
@@ -6543,6 +6673,7 @@ class SDKApi extends BaseAPI {
6543
6673
  });
6544
6674
  }
6545
6675
  /**
6676
+ * Verifies the TOTP code to complete MFA device registration.
6546
6677
  * Verify TOTP MFA device
6547
6678
  */
6548
6679
  registerTotpMfaDeviceVerifyRaw(requestParameters, initOverrides) {
@@ -6574,6 +6705,7 @@ class SDKApi extends BaseAPI {
6574
6705
  });
6575
6706
  }
6576
6707
  /**
6708
+ * Verifies the TOTP code to complete MFA device registration.
6577
6709
  * Verify TOTP MFA device
6578
6710
  */
6579
6711
  registerTotpMfaDeviceVerify(requestParameters, initOverrides) {
@@ -6583,7 +6715,8 @@ class SDKApi extends BaseAPI {
6583
6715
  });
6584
6716
  }
6585
6717
  /**
6586
- * Reshare secret shares and update the threshold
6718
+ * Reshares the MPC secret shares for the specified WAAS wallet.
6719
+ * Reshare WAAS secret shares
6587
6720
  */
6588
6721
  reshareRaw(requestParameters, initOverrides) {
6589
6722
  return __awaiter(this, void 0, void 0, function* () {
@@ -6617,7 +6750,8 @@ class SDKApi extends BaseAPI {
6617
6750
  });
6618
6751
  }
6619
6752
  /**
6620
- * Reshare secret shares and update the threshold
6753
+ * Reshares the MPC secret shares for the specified WAAS wallet.
6754
+ * Reshare WAAS secret shares
6621
6755
  */
6622
6756
  reshare(requestParameters, initOverrides) {
6623
6757
  return __awaiter(this, void 0, void 0, function* () {
@@ -6725,7 +6859,8 @@ class SDKApi extends BaseAPI {
6725
6859
  });
6726
6860
  }
6727
6861
  /**
6728
- * Send new code for email verification
6862
+ * Resends the email verification code to the email address on file.
6863
+ * Resend email verification code
6729
6864
  */
6730
6865
  retryEmailVerificationRaw(requestParameters, initOverrides) {
6731
6866
  return __awaiter(this, void 0, void 0, function* () {
@@ -6749,7 +6884,8 @@ class SDKApi extends BaseAPI {
6749
6884
  });
6750
6885
  }
6751
6886
  /**
6752
- * Send new code for email verification
6887
+ * Resends the email verification code to the email address on file.
6888
+ * Resend email verification code
6753
6889
  */
6754
6890
  retryEmailVerification(requestParameters, initOverrides) {
6755
6891
  return __awaiter(this, void 0, void 0, function* () {
@@ -6785,7 +6921,8 @@ class SDKApi extends BaseAPI {
6785
6921
  });
6786
6922
  }
6787
6923
  /**
6788
- * Send new code for sms verification
6924
+ * Resends the SMS verification code to the phone number on file.
6925
+ * Resend SMS verification code
6789
6926
  */
6790
6927
  retrySmsVerificationRaw(requestParameters, initOverrides) {
6791
6928
  return __awaiter(this, void 0, void 0, function* () {
@@ -6809,7 +6946,8 @@ class SDKApi extends BaseAPI {
6809
6946
  });
6810
6947
  }
6811
6948
  /**
6812
- * Send new code for sms verification
6949
+ * Resends the SMS verification code to the phone number on file.
6950
+ * Resend SMS verification code
6813
6951
  */
6814
6952
  retrySmsVerification(requestParameters, initOverrides) {
6815
6953
  return __awaiter(this, void 0, void 0, function* () {
@@ -6845,6 +6983,7 @@ class SDKApi extends BaseAPI {
6845
6983
  });
6846
6984
  }
6847
6985
  /**
6986
+ * Revokes the current user session and invalidates the JWT.
6848
6987
  * Revoke a session
6849
6988
  */
6850
6989
  revokeSessionRaw(requestParameters, initOverrides) {
@@ -6871,6 +7010,7 @@ class SDKApi extends BaseAPI {
6871
7010
  });
6872
7011
  }
6873
7012
  /**
7013
+ * Revokes the current user session and invalidates the JWT.
6874
7014
  * Revoke a session
6875
7015
  */
6876
7016
  revokeSession(requestParameters, initOverrides) {
@@ -6906,6 +7046,7 @@ class SDKApi extends BaseAPI {
6906
7046
  });
6907
7047
  }
6908
7048
  /**
7049
+ * Scans a URL for potential phishing or malicious activity and returns the result.
6909
7050
  * Scan a URL for potential malicious activity
6910
7051
  */
6911
7052
  scanUrlRaw(requestParameters, initOverrides) {
@@ -6930,6 +7071,7 @@ class SDKApi extends BaseAPI {
6930
7071
  });
6931
7072
  }
6932
7073
  /**
7074
+ * Scans a URL for potential phishing or malicious activity and returns the result.
6933
7075
  * Scan a URL for potential malicious activity
6934
7076
  */
6935
7077
  scanUrl(requestParameters, initOverrides) {
@@ -6992,7 +7134,7 @@ class SDKApi extends BaseAPI {
6992
7134
  }
6993
7135
  /**
6994
7136
  * 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.
6995
- * Update wallet in a multi-wallet selection
7137
+ * Update primary wallet selection
6996
7138
  */
6997
7139
  selectUserWalletRaw(requestParameters, initOverrides) {
6998
7140
  return __awaiter(this, void 0, void 0, function* () {
@@ -7024,7 +7166,7 @@ class SDKApi extends BaseAPI {
7024
7166
  }
7025
7167
  /**
7026
7168
  * 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.
7027
- * Update wallet in a multi-wallet selection
7169
+ * Update primary wallet selection
7028
7170
  */
7029
7171
  selectUserWallet(requestParameters, initOverrides) {
7030
7172
  return __awaiter(this, void 0, void 0, function* () {
@@ -7060,7 +7202,8 @@ class SDKApi extends BaseAPI {
7060
7202
  });
7061
7203
  }
7062
7204
  /**
7063
- * Check that session is valid
7205
+ * Checks whether the current user session is still valid.
7206
+ * Check session validity
7064
7207
  */
7065
7208
  sessionCheckRaw(requestParameters, initOverrides) {
7066
7209
  return __awaiter(this, void 0, void 0, function* () {
@@ -7086,7 +7229,8 @@ class SDKApi extends BaseAPI {
7086
7229
  });
7087
7230
  }
7088
7231
  /**
7089
- * Check that session is valid
7232
+ * Checks whether the current user session is still valid.
7233
+ * Check session validity
7090
7234
  */
7091
7235
  sessionCheck(requestParameters, initOverrides) {
7092
7236
  return __awaiter(this, void 0, void 0, function* () {
@@ -7175,7 +7319,8 @@ class SDKApi extends BaseAPI {
7175
7319
  });
7176
7320
  }
7177
7321
  /**
7178
- * Verify an email and sign in user
7322
+ * Verifies the email code and authenticates the user, returning a JWT.
7323
+ * Verify email and sign in
7179
7324
  */
7180
7325
  signInWithEmailVerificationRaw(requestParameters, initOverrides) {
7181
7326
  return __awaiter(this, void 0, void 0, function* () {
@@ -7199,7 +7344,8 @@ class SDKApi extends BaseAPI {
7199
7344
  });
7200
7345
  }
7201
7346
  /**
7202
- * Verify an email and sign in user
7347
+ * Verifies the email code and authenticates the user, returning a JWT.
7348
+ * Verify email and sign in
7203
7349
  */
7204
7350
  signInWithEmailVerification(requestParameters, initOverrides) {
7205
7351
  return __awaiter(this, void 0, void 0, function* () {
@@ -7235,7 +7381,8 @@ class SDKApi extends BaseAPI {
7235
7381
  });
7236
7382
  }
7237
7383
  /**
7238
- * Verify an sms and sign in user
7384
+ * Verifies the SMS code and authenticates the user, returning a JWT.
7385
+ * Verify SMS and sign in
7239
7386
  */
7240
7387
  signInWithSmsVerificationRaw(requestParameters, initOverrides) {
7241
7388
  return __awaiter(this, void 0, void 0, function* () {
@@ -7259,7 +7406,8 @@ class SDKApi extends BaseAPI {
7259
7406
  });
7260
7407
  }
7261
7408
  /**
7262
- * Verify an sms and sign in user
7409
+ * Verifies the SMS code and authenticates the user, returning a JWT.
7410
+ * Verify SMS and sign in
7263
7411
  */
7264
7412
  signInWithSmsVerification(requestParameters, initOverrides) {
7265
7413
  return __awaiter(this, void 0, void 0, function* () {
@@ -7295,7 +7443,8 @@ class SDKApi extends BaseAPI {
7295
7443
  });
7296
7444
  }
7297
7445
  /**
7298
- * Sign a message with a waas account
7446
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
7447
+ * Sign a message with a WAAS wallet
7299
7448
  */
7300
7449
  signMessageRaw(requestParameters, initOverrides) {
7301
7450
  return __awaiter(this, void 0, void 0, function* () {
@@ -7329,7 +7478,8 @@ class SDKApi extends BaseAPI {
7329
7478
  });
7330
7479
  }
7331
7480
  /**
7332
- * Sign a message with a waas account
7481
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
7482
+ * Sign a message with a WAAS wallet
7333
7483
  */
7334
7484
  signMessage(requestParameters, initOverrides) {
7335
7485
  return __awaiter(this, void 0, void 0, function* () {
@@ -7368,6 +7518,7 @@ class SDKApi extends BaseAPI {
7368
7518
  });
7369
7519
  }
7370
7520
  /**
7521
+ * Authenticates a user using a passkey and returns a JWT.
7371
7522
  * Authenticate a passkey
7372
7523
  */
7373
7524
  signinWithPasskeyRaw(requestParameters, initOverrides) {
@@ -7392,6 +7543,7 @@ class SDKApi extends BaseAPI {
7392
7543
  });
7393
7544
  }
7394
7545
  /**
7546
+ * Authenticates a user using a passkey and returns a JWT.
7395
7547
  * Authenticate a passkey
7396
7548
  */
7397
7549
  signinWithPasskey(requestParameters, initOverrides) {
@@ -7401,6 +7553,7 @@ class SDKApi extends BaseAPI {
7401
7553
  });
7402
7554
  }
7403
7555
  /**
7556
+ * Simulates an EVM transaction and returns the expected outcome.
7404
7557
  * Simulate an EVM transaction
7405
7558
  */
7406
7559
  simulateEVMTransactionRaw(requestParameters, initOverrides) {
@@ -7425,6 +7578,7 @@ class SDKApi extends BaseAPI {
7425
7578
  });
7426
7579
  }
7427
7580
  /**
7581
+ * Simulates an EVM transaction and returns the expected outcome.
7428
7582
  * Simulate an EVM transaction
7429
7583
  */
7430
7584
  simulateEVMTransaction(requestParameters, initOverrides) {
@@ -7461,6 +7615,7 @@ class SDKApi extends BaseAPI {
7461
7615
  });
7462
7616
  }
7463
7617
  /**
7618
+ * Simulates a Solana transaction and returns the expected outcome.
7464
7619
  * Simulate a Solana transaction
7465
7620
  */
7466
7621
  simulateSVMTransactionRaw(requestParameters, initOverrides) {
@@ -7485,6 +7640,7 @@ class SDKApi extends BaseAPI {
7485
7640
  });
7486
7641
  }
7487
7642
  /**
7643
+ * Simulates a Solana transaction and returns the expected outcome.
7488
7644
  * Simulate a Solana transaction
7489
7645
  */
7490
7646
  simulateSVMTransaction(requestParameters, initOverrides) {
@@ -7521,6 +7677,7 @@ class SDKApi extends BaseAPI {
7521
7677
  });
7522
7678
  }
7523
7679
  /**
7680
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
7524
7681
  * Simulate an EVM AA UserOp
7525
7682
  */
7526
7683
  simulateUserOpRaw(requestParameters, initOverrides) {
@@ -7545,6 +7702,7 @@ class SDKApi extends BaseAPI {
7545
7702
  });
7546
7703
  }
7547
7704
  /**
7705
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
7548
7706
  * Simulate an EVM AA UserOp
7549
7707
  */
7550
7708
  simulateUserOp(requestParameters, initOverrides) {
@@ -7739,7 +7897,8 @@ class SDKApi extends BaseAPI {
7739
7897
  });
7740
7898
  }
7741
7899
  /**
7742
- * Telegram provider check auth
7900
+ * Checks if a Telegram authentication attempt has been completed.
7901
+ * Check Telegram authentication status
7743
7902
  */
7744
7903
  telegramCheckAuthRaw(requestParameters, initOverrides) {
7745
7904
  return __awaiter(this, void 0, void 0, function* () {
@@ -7760,7 +7919,8 @@ class SDKApi extends BaseAPI {
7760
7919
  });
7761
7920
  }
7762
7921
  /**
7763
- * Telegram provider check auth
7922
+ * Checks if a Telegram authentication attempt has been completed.
7923
+ * Check Telegram authentication status
7764
7924
  */
7765
7925
  telegramCheckAuth(requestParameters, initOverrides) {
7766
7926
  return __awaiter(this, void 0, void 0, function* () {
@@ -7795,7 +7955,8 @@ class SDKApi extends BaseAPI {
7795
7955
  });
7796
7956
  }
7797
7957
  /**
7798
- * Telegram provider SignIn endpoint
7958
+ * Authenticates a user using their Telegram account credentials.
7959
+ * Sign in with Telegram
7799
7960
  */
7800
7961
  telegramSignInRaw(requestParameters, initOverrides) {
7801
7962
  return __awaiter(this, void 0, void 0, function* () {
@@ -7816,7 +7977,8 @@ class SDKApi extends BaseAPI {
7816
7977
  });
7817
7978
  }
7818
7979
  /**
7819
- * Telegram provider SignIn endpoint
7980
+ * Authenticates a user using their Telegram account credentials.
7981
+ * Sign in with Telegram
7820
7982
  */
7821
7983
  telegramSignIn(requestParameters, initOverrides) {
7822
7984
  return __awaiter(this, void 0, void 0, function* () {
@@ -7852,7 +8014,8 @@ class SDKApi extends BaseAPI {
7852
8014
  });
7853
8015
  }
7854
8016
  /**
7855
- * Telegram provider Verify endpoint
8017
+ * Verifies and links a Telegram account to the authenticated user.
8018
+ * Verify Telegram account linking
7856
8019
  */
7857
8020
  telegramVerifyRaw(requestParameters, initOverrides) {
7858
8021
  return __awaiter(this, void 0, void 0, function* () {
@@ -7880,7 +8043,8 @@ class SDKApi extends BaseAPI {
7880
8043
  });
7881
8044
  }
7882
8045
  /**
7883
- * Telegram provider Verify endpoint
8046
+ * Verifies and links a Telegram account to the authenticated user.
8047
+ * Verify Telegram account linking
7884
8048
  */
7885
8049
  telegramVerify(requestParameters, initOverrides) {
7886
8050
  return __awaiter(this, void 0, void 0, function* () {
@@ -7916,6 +8080,7 @@ class SDKApi extends BaseAPI {
7916
8080
  });
7917
8081
  }
7918
8082
  /**
8083
+ * Updates the V2 recovery email address for the authenticated user.
7919
8084
  * Update a user\'s V2 recovery email
7920
8085
  */
7921
8086
  updateEmbeddedWalletRecoveryEmailRaw(requestParameters, initOverrides) {
@@ -7947,6 +8112,7 @@ class SDKApi extends BaseAPI {
7947
8112
  });
7948
8113
  }
7949
8114
  /**
8115
+ * Updates the V2 recovery email address for the authenticated user.
7950
8116
  * Update a user\'s V2 recovery email
7951
8117
  */
7952
8118
  updateEmbeddedWalletRecoveryEmail(requestParameters, initOverrides) {
@@ -7955,7 +8121,8 @@ class SDKApi extends BaseAPI {
7955
8121
  });
7956
8122
  }
7957
8123
  /**
7958
- * Update a passkey\'s info
8124
+ * Updates the specified passkey for the authenticated user.
8125
+ * Update a passkey
7959
8126
  */
7960
8127
  updatePasskeyRaw(requestParameters, initOverrides) {
7961
8128
  return __awaiter(this, void 0, void 0, function* () {
@@ -7986,7 +8153,8 @@ class SDKApi extends BaseAPI {
7986
8153
  });
7987
8154
  }
7988
8155
  /**
7989
- * Update a passkey\'s info
8156
+ * Updates the specified passkey for the authenticated user.
8157
+ * Update a passkey
7990
8158
  */
7991
8159
  updatePasskey(requestParameters, initOverrides) {
7992
8160
  return __awaiter(this, void 0, void 0, function* () {
@@ -7995,7 +8163,8 @@ class SDKApi extends BaseAPI {
7995
8163
  });
7996
8164
  }
7997
8165
  /**
7998
- * Update a user\'s fields
8166
+ * Updates the authenticated user profile fields.
8167
+ * Update user fields
7999
8168
  */
8000
8169
  updateSelfRaw(requestParameters, initOverrides) {
8001
8170
  return __awaiter(this, void 0, void 0, function* () {
@@ -8026,7 +8195,8 @@ class SDKApi extends BaseAPI {
8026
8195
  });
8027
8196
  }
8028
8197
  /**
8029
- * Update a user\'s fields
8198
+ * Updates the authenticated user profile fields.
8199
+ * Update user fields
8030
8200
  */
8031
8201
  updateSelf(requestParameters, initOverrides) {
8032
8202
  return __awaiter(this, void 0, void 0, function* () {
@@ -8035,7 +8205,8 @@ class SDKApi extends BaseAPI {
8035
8205
  });
8036
8206
  }
8037
8207
  /**
8038
- * Update a device
8208
+ * Updates the specified MFA device for the authenticated user.
8209
+ * Update an MFA device
8039
8210
  */
8040
8211
  updateUserMfaDeviceRaw(requestParameters, initOverrides) {
8041
8212
  return __awaiter(this, void 0, void 0, function* () {
@@ -8066,7 +8237,8 @@ class SDKApi extends BaseAPI {
8066
8237
  });
8067
8238
  }
8068
8239
  /**
8069
- * Update a device
8240
+ * Updates the specified MFA device for the authenticated user.
8241
+ * Update an MFA device
8070
8242
  */
8071
8243
  updateUserMfaDevice(requestParameters, initOverrides) {
8072
8244
  return __awaiter(this, void 0, void 0, function* () {
@@ -8075,7 +8247,7 @@ class SDKApi extends BaseAPI {
8075
8247
  }
8076
8248
  /**
8077
8249
  * Updates the settings for a WAAS wallet
8078
- * Update the WAAS wallet settings for the wallet
8250
+ * Update WAAS wallet settings
8079
8251
  */
8080
8252
  updateWaasWalletSettingsRaw(requestParameters, initOverrides) {
8081
8253
  return __awaiter(this, void 0, void 0, function* () {
@@ -8110,7 +8282,7 @@ class SDKApi extends BaseAPI {
8110
8282
  }
8111
8283
  /**
8112
8284
  * Updates the settings for a WAAS wallet
8113
- * Update the WAAS wallet settings for the wallet
8285
+ * Update WAAS wallet settings
8114
8286
  */
8115
8287
  updateWaasWalletSettings(requestParameters, initOverrides) {
8116
8288
  return __awaiter(this, void 0, void 0, function* () {
@@ -8119,6 +8291,7 @@ class SDKApi extends BaseAPI {
8119
8291
  });
8120
8292
  }
8121
8293
  /**
8294
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
8122
8295
  * Update V1 embedded wallet to V2
8123
8296
  */
8124
8297
  upgradeEmbeddedWalletToV2Raw(requestParameters, initOverrides) {
@@ -8143,6 +8316,7 @@ class SDKApi extends BaseAPI {
8143
8316
  });
8144
8317
  }
8145
8318
  /**
8319
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
8146
8320
  * Update V1 embedded wallet to V2
8147
8321
  */
8148
8322
  upgradeEmbeddedWalletToV2(requestParameters, initOverrides) {
@@ -8233,6 +8407,7 @@ class SDKApi extends BaseAPI {
8233
8407
  });
8234
8408
  }
8235
8409
  /**
8410
+ * Verifies the signed payload and returns a JWT authentication token.
8236
8411
  * Verify payload and return JWT
8237
8412
  */
8238
8413
  verifyRaw(requestParameters, initOverrides) {
@@ -8257,6 +8432,7 @@ class SDKApi extends BaseAPI {
8257
8432
  });
8258
8433
  }
8259
8434
  /**
8435
+ * Verifies the signed payload and returns a JWT authentication token.
8260
8436
  * Verify payload and return JWT
8261
8437
  */
8262
8438
  verify(requestParameters, initOverrides) {
@@ -8266,7 +8442,8 @@ class SDKApi extends BaseAPI {
8266
8442
  });
8267
8443
  }
8268
8444
  /**
8269
- * Verify email verification request
8445
+ * Verifies the email code and completes the email verification process.
8446
+ * Verify email verification code
8270
8447
  */
8271
8448
  verifyEmailVerificationRaw(requestParameters, initOverrides) {
8272
8449
  return __awaiter(this, void 0, void 0, function* () {
@@ -8297,7 +8474,8 @@ class SDKApi extends BaseAPI {
8297
8474
  });
8298
8475
  }
8299
8476
  /**
8300
- * Verify email verification request
8477
+ * Verifies the email code and completes the email verification process.
8478
+ * Verify email verification code
8301
8479
  */
8302
8480
  verifyEmailVerification(requestParameters, initOverrides) {
8303
8481
  return __awaiter(this, void 0, void 0, function* () {
@@ -8334,7 +8512,7 @@ class SDKApi extends BaseAPI {
8334
8512
  }
8335
8513
  /**
8336
8514
  * Link a wallet to a valid environment user, and return an updated JWT
8337
- * Link wallet to user
8515
+ * Link a wallet to a user
8338
8516
  */
8339
8517
  verifyLinkRaw(requestParameters, initOverrides) {
8340
8518
  return __awaiter(this, void 0, void 0, function* () {
@@ -8366,7 +8544,7 @@ class SDKApi extends BaseAPI {
8366
8544
  }
8367
8545
  /**
8368
8546
  * Link a wallet to a valid environment user, and return an updated JWT
8369
- * Link wallet to user
8547
+ * Link a wallet to a user
8370
8548
  */
8371
8549
  verifyLink(requestParameters, initOverrides) {
8372
8550
  return __awaiter(this, void 0, void 0, function* () {
@@ -8525,7 +8703,8 @@ class SDKApi extends BaseAPI {
8525
8703
  });
8526
8704
  }
8527
8705
  /**
8528
- * Verify sms verification request
8706
+ * Verifies the SMS code and completes the phone number verification process.
8707
+ * Verify SMS verification code
8529
8708
  */
8530
8709
  verifySmsVerificationRaw(requestParameters, initOverrides) {
8531
8710
  return __awaiter(this, void 0, void 0, function* () {
@@ -8556,7 +8735,8 @@ class SDKApi extends BaseAPI {
8556
8735
  });
8557
8736
  }
8558
8737
  /**
8559
- * Verify sms verification request
8738
+ * Verifies the SMS code and completes the phone number verification process.
8739
+ * Verify SMS verification code
8560
8740
  */
8561
8741
  verifySmsVerification(requestParameters, initOverrides) {
8562
8742
  return __awaiter(this, void 0, void 0, function* () {
@@ -8593,7 +8773,7 @@ class SDKApi extends BaseAPI {
8593
8773
  }
8594
8774
  /**
8595
8775
  * Used to link a wallet after user has confirmed transfer to the new account
8596
- * Verify wallet transfer
8776
+ * Verify a wallet transfer
8597
8777
  */
8598
8778
  verifyTransferRaw(requestParameters, initOverrides) {
8599
8779
  return __awaiter(this, void 0, void 0, function* () {
@@ -8625,7 +8805,7 @@ class SDKApi extends BaseAPI {
8625
8805
  }
8626
8806
  /**
8627
8807
  * Used to link a wallet after user has confirmed transfer to the new account
8628
- * Verify wallet transfer
8808
+ * Verify a wallet transfer
8629
8809
  */
8630
8810
  verifyTransfer(requestParameters, initOverrides) {
8631
8811
  return __awaiter(this, void 0, void 0, function* () {
@@ -8662,7 +8842,7 @@ class SDKApi extends BaseAPI {
8662
8842
  }
8663
8843
  /**
8664
8844
  * Remove a link from to a valid environment user, and return an updated JWT
8665
- * unlink wallet from user
8845
+ * Unlink a wallet from a user
8666
8846
  */
8667
8847
  verifyUnlinkRaw(requestParameters, initOverrides) {
8668
8848
  return __awaiter(this, void 0, void 0, function* () {
@@ -8694,7 +8874,7 @@ class SDKApi extends BaseAPI {
8694
8874
  }
8695
8875
  /**
8696
8876
  * Remove a link from to a valid environment user, and return an updated JWT
8697
- * unlink wallet from user
8877
+ * Unlink a wallet from a user
8698
8878
  */
8699
8879
  verifyUnlink(requestParameters, initOverrides) {
8700
8880
  return __awaiter(this, void 0, void 0, function* () {
@@ -8814,6 +8994,7 @@ class SDKApi extends BaseAPI {
8814
8994
  });
8815
8995
  }
8816
8996
  /**
8997
+ * Authenticates a user by verifying their wallet signature.
8817
8998
  * Sign in with wallet
8818
8999
  */
8819
9000
  walletsSigninRaw(requestParameters, initOverrides) {
@@ -8838,6 +9019,7 @@ class SDKApi extends BaseAPI {
8838
9019
  });
8839
9020
  }
8840
9021
  /**
9022
+ * Authenticates a user by verifying their wallet signature.
8841
9023
  * Sign in with wallet
8842
9024
  */
8843
9025
  walletsSignin(requestParameters, initOverrides) {
@@ -8875,7 +9057,7 @@ class SDKApi extends BaseAPI {
8875
9057
  }
8876
9058
  /**
8877
9059
  * Verify a wallet, and return an updated JWT
8878
- * Verify wallet
9060
+ * Verify a wallet
8879
9061
  */
8880
9062
  walletsVerifyRaw(requestParameters, initOverrides) {
8881
9063
  return __awaiter(this, void 0, void 0, function* () {
@@ -8907,7 +9089,7 @@ class SDKApi extends BaseAPI {
8907
9089
  }
8908
9090
  /**
8909
9091
  * Verify a wallet, and return an updated JWT
8910
- * Verify wallet
9092
+ * Verify a wallet
8911
9093
  */
8912
9094
  walletsVerify(requestParameters, initOverrides) {
8913
9095
  return __awaiter(this, void 0, void 0, function* () {