@dynamic-labs/sdk-api 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.
Files changed (112) hide show
  1. package/package.json +1 -1
  2. package/src/apis/AllowlistsApi.cjs +26 -6
  3. package/src/apis/AllowlistsApi.d.ts +26 -6
  4. package/src/apis/AllowlistsApi.js +26 -6
  5. package/src/apis/AnalyticsApi.cjs +12 -0
  6. package/src/apis/AnalyticsApi.d.ts +12 -0
  7. package/src/apis/AnalyticsApi.js +12 -0
  8. package/src/apis/ChainalysisApi.cjs +6 -0
  9. package/src/apis/ChainalysisApi.d.ts +6 -0
  10. package/src/apis/ChainalysisApi.js +6 -0
  11. package/src/apis/ChainsApi.cjs +4 -2
  12. package/src/apis/ChainsApi.d.ts +4 -2
  13. package/src/apis/ChainsApi.js +4 -2
  14. package/src/apis/CustomFieldsApi.cjs +14 -4
  15. package/src/apis/CustomFieldsApi.d.ts +14 -4
  16. package/src/apis/CustomFieldsApi.js +14 -4
  17. package/src/apis/CustomHostnamesApi.cjs +10 -4
  18. package/src/apis/CustomHostnamesApi.d.ts +10 -4
  19. package/src/apis/CustomHostnamesApi.js +10 -4
  20. package/src/apis/CustomNetworksApi.cjs +10 -0
  21. package/src/apis/CustomNetworksApi.d.ts +10 -0
  22. package/src/apis/CustomNetworksApi.js +10 -0
  23. package/src/apis/DeeplinkUrlsApi.cjs +12 -6
  24. package/src/apis/DeeplinkUrlsApi.d.ts +12 -6
  25. package/src/apis/DeeplinkUrlsApi.js +12 -6
  26. package/src/apis/EnvironmentsApi.cjs +20 -10
  27. package/src/apis/EnvironmentsApi.d.ts +20 -10
  28. package/src/apis/EnvironmentsApi.js +20 -10
  29. package/src/apis/EventsApi.cjs +8 -2
  30. package/src/apis/EventsApi.d.ts +8 -2
  31. package/src/apis/EventsApi.js +8 -2
  32. package/src/apis/ExportsApi.cjs +8 -0
  33. package/src/apis/ExportsApi.d.ts +8 -0
  34. package/src/apis/ExportsApi.js +8 -0
  35. package/src/apis/ExternalJwtApi.cjs +4 -2
  36. package/src/apis/ExternalJwtApi.d.ts +4 -2
  37. package/src/apis/ExternalJwtApi.js +4 -2
  38. package/src/apis/GatesApi.cjs +16 -2
  39. package/src/apis/GatesApi.d.ts +16 -2
  40. package/src/apis/GatesApi.js +16 -2
  41. package/src/apis/GlobalWalletAccessControlApi.cjs +22 -8
  42. package/src/apis/GlobalWalletAccessControlApi.d.ts +22 -8
  43. package/src/apis/GlobalWalletAccessControlApi.js +22 -8
  44. package/src/apis/GlobalWalletConnectionsApi.cjs +4 -2
  45. package/src/apis/GlobalWalletConnectionsApi.d.ts +4 -2
  46. package/src/apis/GlobalWalletConnectionsApi.js +4 -2
  47. package/src/apis/GlobalWalletsApi.cjs +18 -8
  48. package/src/apis/GlobalWalletsApi.d.ts +18 -8
  49. package/src/apis/GlobalWalletsApi.js +18 -8
  50. package/src/apis/InvitesApi.cjs +16 -6
  51. package/src/apis/InvitesApi.d.ts +16 -6
  52. package/src/apis/InvitesApi.js +16 -6
  53. package/src/apis/MembersApi.cjs +16 -8
  54. package/src/apis/MembersApi.d.ts +16 -8
  55. package/src/apis/MembersApi.js +16 -8
  56. package/src/apis/MfaApi.cjs +8 -4
  57. package/src/apis/MfaApi.d.ts +8 -4
  58. package/src/apis/MfaApi.js +8 -4
  59. package/src/apis/MfaSettingsApi.cjs +6 -0
  60. package/src/apis/MfaSettingsApi.d.ts +6 -0
  61. package/src/apis/MfaSettingsApi.js +6 -0
  62. package/src/apis/NameServicesApi.cjs +22 -10
  63. package/src/apis/NameServicesApi.d.ts +22 -10
  64. package/src/apis/NameServicesApi.js +22 -10
  65. package/src/apis/OrganizationsApi.cjs +34 -10
  66. package/src/apis/OrganizationsApi.d.ts +34 -10
  67. package/src/apis/OrganizationsApi.js +34 -10
  68. package/src/apis/OriginsApi.cjs +12 -6
  69. package/src/apis/OriginsApi.d.ts +12 -6
  70. package/src/apis/OriginsApi.js +12 -6
  71. package/src/apis/ProjectsApi.cjs +18 -8
  72. package/src/apis/ProjectsApi.d.ts +18 -8
  73. package/src/apis/ProjectsApi.js +18 -8
  74. package/src/apis/SDKApi.cjs +350 -164
  75. package/src/apis/SDKApi.d.ts +350 -164
  76. package/src/apis/SDKApi.js +350 -164
  77. package/src/apis/SDKViewsApi.cjs +12 -6
  78. package/src/apis/SDKViewsApi.d.ts +12 -6
  79. package/src/apis/SDKViewsApi.js +12 -6
  80. package/src/apis/SessionsApi.cjs +4 -0
  81. package/src/apis/SessionsApi.d.ts +4 -0
  82. package/src/apis/SessionsApi.js +4 -0
  83. package/src/apis/SettingsApi.cjs +32 -4
  84. package/src/apis/SettingsApi.d.ts +32 -4
  85. package/src/apis/SettingsApi.js +32 -4
  86. package/src/apis/TestAccountApi.cjs +10 -4
  87. package/src/apis/TestAccountApi.d.ts +10 -4
  88. package/src/apis/TestAccountApi.js +10 -4
  89. package/src/apis/TokensApi.cjs +12 -6
  90. package/src/apis/TokensApi.d.ts +12 -6
  91. package/src/apis/TokensApi.js +12 -6
  92. package/src/apis/UserApiTokensApi.cjs +12 -6
  93. package/src/apis/UserApiTokensApi.d.ts +12 -6
  94. package/src/apis/UserApiTokensApi.js +12 -6
  95. package/src/apis/UsersApi.cjs +28 -4
  96. package/src/apis/UsersApi.d.ts +28 -4
  97. package/src/apis/UsersApi.js +28 -4
  98. package/src/apis/VisitsApi.cjs +2 -0
  99. package/src/apis/VisitsApi.d.ts +2 -0
  100. package/src/apis/VisitsApi.js +2 -0
  101. package/src/apis/WaasApi.cjs +32 -4
  102. package/src/apis/WaasApi.d.ts +32 -4
  103. package/src/apis/WaasApi.js +32 -4
  104. package/src/apis/WalletConnectApi.cjs +2 -0
  105. package/src/apis/WalletConnectApi.d.ts +2 -0
  106. package/src/apis/WalletConnectApi.js +2 -0
  107. package/src/apis/WalletsApi.cjs +20 -6
  108. package/src/apis/WalletsApi.d.ts +20 -6
  109. package/src/apis/WalletsApi.js +20 -6
  110. package/src/apis/WebhooksApi.cjs +32 -16
  111. package/src/apis/WebhooksApi.d.ts +32 -16
  112. package/src/apis/WebhooksApi.js +32 -16
@@ -286,6 +286,7 @@ class SDKApi extends BaseAPI {
286
286
  });
287
287
  }
288
288
  /**
289
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
289
290
  * Upgrade JWT scope with valid MFA session
290
291
  */
291
292
  authMfaRecoveryRaw(requestParameters, initOverrides) {
@@ -317,6 +318,7 @@ class SDKApi extends BaseAPI {
317
318
  });
318
319
  }
319
320
  /**
321
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
320
322
  * Upgrade JWT scope with valid MFA session
321
323
  */
322
324
  authMfaRecovery(requestParameters, initOverrides) {
@@ -353,6 +355,7 @@ class SDKApi extends BaseAPI {
353
355
  });
354
356
  }
355
357
  /**
358
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
356
359
  * Upgrade JWT scope with valid MFA session
357
360
  */
358
361
  authMfaTotpDeviceRaw(requestParameters, initOverrides) {
@@ -384,6 +387,7 @@ class SDKApi extends BaseAPI {
384
387
  });
385
388
  }
386
389
  /**
390
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
387
391
  * Upgrade JWT scope with valid MFA session
388
392
  */
389
393
  authMfaTotpDevice(requestParameters, initOverrides) {
@@ -420,6 +424,7 @@ class SDKApi extends BaseAPI {
420
424
  });
421
425
  }
422
426
  /**
427
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
423
428
  * Upgrade JWT scope with valid MFA session
424
429
  */
425
430
  authenticateMfaEmailRaw(requestParameters, initOverrides) {
@@ -451,6 +456,7 @@ class SDKApi extends BaseAPI {
451
456
  });
452
457
  }
453
458
  /**
459
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
454
460
  * Upgrade JWT scope with valid MFA session
455
461
  */
456
462
  authenticateMfaEmail(requestParameters, initOverrides) {
@@ -460,6 +466,7 @@ class SDKApi extends BaseAPI {
460
466
  });
461
467
  }
462
468
  /**
469
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
463
470
  * Upgrade JWT scope with valid MFA session
464
471
  */
465
472
  authenticateMfaPasskeyDeviceRaw(requestParameters, initOverrides) {
@@ -491,6 +498,7 @@ class SDKApi extends BaseAPI {
491
498
  });
492
499
  }
493
500
  /**
501
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
494
502
  * Upgrade JWT scope with valid MFA session
495
503
  */
496
504
  authenticateMfaPasskeyDevice(requestParameters, initOverrides) {
@@ -530,7 +538,8 @@ class SDKApi extends BaseAPI {
530
538
  });
531
539
  }
532
540
  /**
533
- * Backup multiple keyShares for a waaS wallet
541
+ * Backs up the client key shares for the specified WAAS wallet.
542
+ * Back up keyshares for a WAAS wallet
534
543
  */
535
544
  backupKeySharesRaw(requestParameters, initOverrides) {
536
545
  return __awaiter(this, void 0, void 0, function* () {
@@ -564,7 +573,8 @@ class SDKApi extends BaseAPI {
564
573
  });
565
574
  }
566
575
  /**
567
- * Backup multiple keyShares for a waaS wallet
576
+ * Backs up the client key shares for the specified WAAS wallet.
577
+ * Back up keyshares for a WAAS wallet
568
578
  */
569
579
  backupKeyShares(requestParameters, initOverrides) {
570
580
  return __awaiter(this, void 0, void 0, function* () {
@@ -603,7 +613,8 @@ class SDKApi extends BaseAPI {
603
613
  });
604
614
  }
605
615
  /**
606
- * Backup multiple keyShares for a waaS wallet to Google Drive
616
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
617
+ * Back up keyshares to Google Drive
607
618
  */
608
619
  backupKeySharesToGoogleDriveRaw(requestParameters, initOverrides) {
609
620
  return __awaiter(this, void 0, void 0, function* () {
@@ -632,7 +643,8 @@ class SDKApi extends BaseAPI {
632
643
  });
633
644
  }
634
645
  /**
635
- * Backup multiple keyShares for a waaS wallet to Google Drive
646
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
647
+ * Back up keyshares to Google Drive
636
648
  */
637
649
  backupKeySharesToGoogleDrive(requestParameters, initOverrides) {
638
650
  return __awaiter(this, void 0, void 0, function* () {
@@ -671,6 +683,7 @@ class SDKApi extends BaseAPI {
671
683
  });
672
684
  }
673
685
  /**
686
+ * Records a backup action and event for the specified location without performing the actual backup.
674
687
  * Create backup action and event for a specified location without performing actual backup
675
688
  */
676
689
  backupKeySharesToLocationRaw(requestParameters, initOverrides) {
@@ -705,6 +718,7 @@ class SDKApi extends BaseAPI {
705
718
  });
706
719
  }
707
720
  /**
721
+ * Records a backup action and event for the specified location without performing the actual backup.
708
722
  * Create backup action and event for a specified location without performing actual backup
709
723
  */
710
724
  backupKeySharesToLocation(requestParameters, initOverrides) {
@@ -744,6 +758,7 @@ class SDKApi extends BaseAPI {
744
758
  });
745
759
  }
746
760
  /**
761
+ * Records backup actions and events for multiple locations without performing the actual backups.
747
762
  * Create backup action and event for multiple locations without performing actual backup
748
763
  */
749
764
  backupKeySharesToLocationsRaw(requestParameters, initOverrides) {
@@ -778,6 +793,7 @@ class SDKApi extends BaseAPI {
778
793
  });
779
794
  }
780
795
  /**
796
+ * Records backup actions and events for multiple locations without performing the actual backups.
781
797
  * Create backup action and event for multiple locations without performing actual backup
782
798
  */
783
799
  backupKeySharesToLocations(requestParameters, initOverrides) {
@@ -818,7 +834,7 @@ class SDKApi extends BaseAPI {
818
834
  }
819
835
  /**
820
836
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
821
- * Redirect URL for sign-in with coinbase
837
+ * Handle Coinbase OAuth redirect
822
838
  */
823
839
  cbOauthRedirectRaw(requestParameters, initOverrides) {
824
840
  return __awaiter(this, void 0, void 0, function* () {
@@ -856,7 +872,7 @@ class SDKApi extends BaseAPI {
856
872
  }
857
873
  /**
858
874
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
859
- * Redirect URL for sign-in with coinbase
875
+ * Handle Coinbase OAuth redirect
860
876
  */
861
877
  cbOauthRedirect(requestParameters, initOverrides) {
862
878
  return __awaiter(this, void 0, void 0, function* () {
@@ -1003,6 +1019,7 @@ class SDKApi extends BaseAPI {
1003
1019
  });
1004
1020
  }
1005
1021
  /**
1022
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
1006
1023
  * Claim a pregenerated embedded wallet
1007
1024
  */
1008
1025
  claimEmbeddedWalletRaw(requestParameters, initOverrides) {
@@ -1034,6 +1051,7 @@ class SDKApi extends BaseAPI {
1034
1051
  });
1035
1052
  }
1036
1053
  /**
1054
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
1037
1055
  * Claim a pregenerated embedded wallet
1038
1056
  */
1039
1057
  claimEmbeddedWallet(requestParameters, initOverrides) {
@@ -1152,7 +1170,7 @@ class SDKApi extends BaseAPI {
1152
1170
  }
1153
1171
  /**
1154
1172
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1155
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1173
+ * Complete passkey recovery for an embedded wallet
1156
1174
  */
1157
1175
  completePasskeyRecoveryRaw(requestParameters, initOverrides) {
1158
1176
  return __awaiter(this, void 0, void 0, function* () {
@@ -1184,7 +1202,7 @@ class SDKApi extends BaseAPI {
1184
1202
  }
1185
1203
  /**
1186
1204
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1187
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1205
+ * Complete passkey recovery for an embedded wallet
1188
1206
  */
1189
1207
  completePasskeyRecovery(requestParameters, initOverrides) {
1190
1208
  return __awaiter(this, void 0, void 0, function* () {
@@ -1193,6 +1211,7 @@ class SDKApi extends BaseAPI {
1193
1211
  });
1194
1212
  }
1195
1213
  /**
1214
+ * Creates a new Coinbase onramp order for the authenticated user.
1196
1215
  * Create a Coinbase onramp order
1197
1216
  */
1198
1217
  createCoinbaseOnrampOrderRaw(requestParameters, initOverrides) {
@@ -1224,6 +1243,7 @@ class SDKApi extends BaseAPI {
1224
1243
  });
1225
1244
  }
1226
1245
  /**
1246
+ * Creates a new Coinbase onramp order for the authenticated user.
1227
1247
  * Create a Coinbase onramp order
1228
1248
  */
1229
1249
  createCoinbaseOnrampOrder(requestParameters, initOverrides) {
@@ -1275,6 +1295,7 @@ class SDKApi extends BaseAPI {
1275
1295
  });
1276
1296
  }
1277
1297
  /**
1298
+ * Initiates the email verification process and sends a verification code.
1278
1299
  * Initialize email verification process
1279
1300
  */
1280
1301
  createEmailVerificationRaw(requestParameters, initOverrides) {
@@ -1299,6 +1320,7 @@ class SDKApi extends BaseAPI {
1299
1320
  });
1300
1321
  }
1301
1322
  /**
1323
+ * Initiates the email verification process and sends a verification code.
1302
1324
  * Initialize email verification process
1303
1325
  */
1304
1326
  createEmailVerification(requestParameters, initOverrides) {
@@ -1404,7 +1426,8 @@ class SDKApi extends BaseAPI {
1404
1426
  });
1405
1427
  }
1406
1428
  /**
1407
- * Track a global wallet connection
1429
+ * Creates a new global wallet connection for the authenticated user.
1430
+ * Create a global wallet connection
1408
1431
  */
1409
1432
  createGlobalWalletConnectionRaw(requestParameters, initOverrides) {
1410
1433
  return __awaiter(this, void 0, void 0, function* () {
@@ -1435,7 +1458,8 @@ class SDKApi extends BaseAPI {
1435
1458
  });
1436
1459
  }
1437
1460
  /**
1438
- * Track a global wallet connection
1461
+ * Creates a new global wallet connection for the authenticated user.
1462
+ * Create a global wallet connection
1439
1463
  */
1440
1464
  createGlobalWalletConnection(requestParameters, initOverrides) {
1441
1465
  return __awaiter(this, void 0, void 0, function* () {
@@ -1444,7 +1468,8 @@ class SDKApi extends BaseAPI {
1444
1468
  });
1445
1469
  }
1446
1470
  /**
1447
- * Generate new recovery codes for user
1471
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1472
+ * Generate new recovery codes
1448
1473
  */
1449
1474
  createNewRecoveryCodesRaw(requestParameters, initOverrides) {
1450
1475
  return __awaiter(this, void 0, void 0, function* () {
@@ -1470,7 +1495,8 @@ class SDKApi extends BaseAPI {
1470
1495
  });
1471
1496
  }
1472
1497
  /**
1473
- * Generate new recovery codes for user
1498
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1499
+ * Generate new recovery codes
1474
1500
  */
1475
1501
  createNewRecoveryCodes(requestParameters, initOverrides) {
1476
1502
  return __awaiter(this, void 0, void 0, function* () {
@@ -1479,6 +1505,7 @@ class SDKApi extends BaseAPI {
1479
1505
  });
1480
1506
  }
1481
1507
  /**
1508
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1482
1509
  * Create rooms for a waas mpc ceremony
1483
1510
  */
1484
1511
  createRoomsRaw(requestParameters, initOverrides) {
@@ -1513,6 +1540,7 @@ class SDKApi extends BaseAPI {
1513
1540
  });
1514
1541
  }
1515
1542
  /**
1543
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1516
1544
  * Create rooms for a waas mpc ceremony
1517
1545
  */
1518
1546
  createRooms(requestParameters, initOverrides) {
@@ -1552,6 +1580,7 @@ class SDKApi extends BaseAPI {
1552
1580
  });
1553
1581
  }
1554
1582
  /**
1583
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1555
1584
  * Create rooms for a waas mpc ceremony without a walletId
1556
1585
  */
1557
1586
  createRoomsWithoutWalletIdRaw(requestParameters, initOverrides) {
@@ -1583,6 +1612,7 @@ class SDKApi extends BaseAPI {
1583
1612
  });
1584
1613
  }
1585
1614
  /**
1615
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1586
1616
  * Create rooms for a waas mpc ceremony without a walletId
1587
1617
  */
1588
1618
  createRoomsWithoutWalletId(requestParameters, initOverrides) {
@@ -1619,7 +1649,8 @@ class SDKApi extends BaseAPI {
1619
1649
  });
1620
1650
  }
1621
1651
  /**
1622
- * Initialize sms verification process
1652
+ * Initiates the SMS verification process and sends a verification code.
1653
+ * Initialize SMS verification process
1623
1654
  */
1624
1655
  createSmsVerificationRaw(requestParameters, initOverrides) {
1625
1656
  return __awaiter(this, void 0, void 0, function* () {
@@ -1643,7 +1674,8 @@ class SDKApi extends BaseAPI {
1643
1674
  });
1644
1675
  }
1645
1676
  /**
1646
- * Initialize sms verification process
1677
+ * Initiates the SMS verification process and sends a verification code.
1678
+ * Initialize SMS verification process
1647
1679
  */
1648
1680
  createSmsVerification(requestParameters, initOverrides) {
1649
1681
  return __awaiter(this, void 0, void 0, function* () {
@@ -1714,7 +1746,7 @@ class SDKApi extends BaseAPI {
1714
1746
  }
1715
1747
  /**
1716
1748
  * Create a new waas account
1717
- * Create a new waas account
1749
+ * Create a WAAS wallet
1718
1750
  */
1719
1751
  createWaasAccountRaw(requestParameters, initOverrides) {
1720
1752
  return __awaiter(this, void 0, void 0, function* () {
@@ -1746,7 +1778,7 @@ class SDKApi extends BaseAPI {
1746
1778
  }
1747
1779
  /**
1748
1780
  * Create a new waas account
1749
- * Create a new waas account
1781
+ * Create a WAAS wallet
1750
1782
  */
1751
1783
  createWaasAccount(requestParameters, initOverrides) {
1752
1784
  return __awaiter(this, void 0, void 0, function* () {
@@ -1852,7 +1884,7 @@ class SDKApi extends BaseAPI {
1852
1884
  }
1853
1885
  /**
1854
1886
  * Deletes the embedded wallets for a user
1855
- * Deletes the embedded wallets for a user
1887
+ * Delete embedded wallets for a user
1856
1888
  */
1857
1889
  deleteEmbeddedWalletsRaw(requestParameters, initOverrides) {
1858
1890
  return __awaiter(this, void 0, void 0, function* () {
@@ -1881,7 +1913,7 @@ class SDKApi extends BaseAPI {
1881
1913
  }
1882
1914
  /**
1883
1915
  * Deletes the embedded wallets for a user
1884
- * Deletes the embedded wallets for a user
1916
+ * Delete embedded wallets for a user
1885
1917
  */
1886
1918
  deleteEmbeddedWallets(requestParameters, initOverrides) {
1887
1919
  return __awaiter(this, void 0, void 0, function* () {
@@ -1889,7 +1921,8 @@ class SDKApi extends BaseAPI {
1889
1921
  });
1890
1922
  }
1891
1923
  /**
1892
- * Delete a device (if not default device)
1924
+ * Permanently removes an MFA device from the authenticated user account.
1925
+ * Delete an MFA device
1893
1926
  */
1894
1927
  deleteMfaDeviceRaw(requestParameters, initOverrides) {
1895
1928
  return __awaiter(this, void 0, void 0, function* () {
@@ -1924,7 +1957,8 @@ class SDKApi extends BaseAPI {
1924
1957
  });
1925
1958
  }
1926
1959
  /**
1927
- * Delete a device (if not default device)
1960
+ * Permanently removes an MFA device from the authenticated user account.
1961
+ * Delete an MFA device
1928
1962
  */
1929
1963
  deleteMfaDevice(requestParameters, initOverrides) {
1930
1964
  return __awaiter(this, void 0, void 0, function* () {
@@ -1932,6 +1966,7 @@ class SDKApi extends BaseAPI {
1932
1966
  });
1933
1967
  }
1934
1968
  /**
1969
+ * Permanently removes a passkey from the authenticated user account.
1935
1970
  * Delete a passkey
1936
1971
  */
1937
1972
  deletePasskeyRaw(requestParameters, initOverrides) {
@@ -1963,6 +1998,7 @@ class SDKApi extends BaseAPI {
1963
1998
  });
1964
1999
  }
1965
2000
  /**
2001
+ * Permanently removes a passkey from the authenticated user account.
1966
2002
  * Delete a passkey
1967
2003
  */
1968
2004
  deletePasskey(requestParameters, initOverrides) {
@@ -2046,7 +2082,8 @@ class SDKApi extends BaseAPI {
2046
2082
  });
2047
2083
  }
2048
2084
  /**
2049
- * Set a global wallet connection as disconnected
2085
+ * Disconnects the specified global wallet connection.
2086
+ * Disconnect a global wallet connection
2050
2087
  */
2051
2088
  disconnectGlobalWalletConnectionRaw(requestParameters, initOverrides) {
2052
2089
  return __awaiter(this, void 0, void 0, function* () {
@@ -2075,7 +2112,8 @@ class SDKApi extends BaseAPI {
2075
2112
  });
2076
2113
  }
2077
2114
  /**
2078
- * Set a global wallet connection as disconnected
2115
+ * Disconnects the specified global wallet connection.
2116
+ * Disconnect a global wallet connection
2079
2117
  */
2080
2118
  disconnectGlobalWalletConnection(requestParameters, initOverrides) {
2081
2119
  return __awaiter(this, void 0, void 0, function* () {
@@ -2299,7 +2337,8 @@ class SDKApi extends BaseAPI {
2299
2337
  });
2300
2338
  }
2301
2339
  /**
2302
- * Export private Key of a waas account
2340
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
2341
+ * Export a WAAS wallet private key
2303
2342
  */
2304
2343
  exportPrivateKeyRaw(requestParameters, initOverrides) {
2305
2344
  return __awaiter(this, void 0, void 0, function* () {
@@ -2333,7 +2372,8 @@ class SDKApi extends BaseAPI {
2333
2372
  });
2334
2373
  }
2335
2374
  /**
2336
- * Export private Key of a waas account
2375
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
2376
+ * Export a WAAS wallet private key
2337
2377
  */
2338
2378
  exportPrivateKey(requestParameters, initOverrides) {
2339
2379
  return __awaiter(this, void 0, void 0, function* () {
@@ -2372,7 +2412,8 @@ class SDKApi extends BaseAPI {
2372
2412
  });
2373
2413
  }
2374
2414
  /**
2375
- * Endpoint to sign-in using a token issued by an external auth provider
2415
+ * Authenticates a user using a token from an external auth provider.
2416
+ * Sign in with an external auth provider token
2376
2417
  */
2377
2418
  externalAuthSigninRaw(requestParameters, initOverrides) {
2378
2419
  return __awaiter(this, void 0, void 0, function* () {
@@ -2403,7 +2444,8 @@ class SDKApi extends BaseAPI {
2403
2444
  });
2404
2445
  }
2405
2446
  /**
2406
- * Endpoint to sign-in using a token issued by an external auth provider
2447
+ * Authenticates a user using a token from an external auth provider.
2448
+ * Sign in with an external auth provider token
2407
2449
  */
2408
2450
  externalAuthSignin(requestParameters, initOverrides) {
2409
2451
  return __awaiter(this, void 0, void 0, function* () {
@@ -2439,6 +2481,7 @@ class SDKApi extends BaseAPI {
2439
2481
  });
2440
2482
  }
2441
2483
  /**
2484
+ * [DEPRECATED] Please use /externalAuth/signin instead.
2442
2485
  * [DEPRECATED] Please use /externalAuth/signin instead
2443
2486
  */
2444
2487
  externalAuthVerifyRaw(requestParameters, initOverrides) {
@@ -2470,6 +2513,7 @@ class SDKApi extends BaseAPI {
2470
2513
  });
2471
2514
  }
2472
2515
  /**
2516
+ * [DEPRECATED] Please use /externalAuth/signin instead.
2473
2517
  * [DEPRECATED] Please use /externalAuth/signin instead
2474
2518
  */
2475
2519
  externalAuthVerify(requestParameters, initOverrides) {
@@ -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
  farcasterSignInRaw(requestParameters, initOverrides) {
2512
2556
  return __awaiter(this, void 0, void 0, function* () {
@@ -2528,7 +2572,7 @@ class SDKApi extends BaseAPI {
2528
2572
  }
2529
2573
  /**
2530
2574
  * Farcaster SignIn endpoint to exchange SIWF data
2531
- * Farcaster provider SignIn endpoint
2575
+ * Sign in with Farcaster
2532
2576
  */
2533
2577
  farcasterSignIn(requestParameters, initOverrides) {
2534
2578
  return __awaiter(this, void 0, void 0, function* () {
@@ -2565,7 +2609,7 @@ class SDKApi extends BaseAPI {
2565
2609
  }
2566
2610
  /**
2567
2611
  * Farcaster Verify endpoint to exchange SIWF data
2568
- * Farcaster provider Verify endpoint
2612
+ * Verify Farcaster account linking
2569
2613
  */
2570
2614
  farcasterVerifyRaw(requestParameters, initOverrides) {
2571
2615
  return __awaiter(this, void 0, void 0, function* () {
@@ -2594,7 +2638,7 @@ class SDKApi extends BaseAPI {
2594
2638
  }
2595
2639
  /**
2596
2640
  * Farcaster Verify endpoint to exchange SIWF data
2597
- * Farcaster provider Verify endpoint
2641
+ * Verify Farcaster account linking
2598
2642
  */
2599
2643
  farcasterVerify(requestParameters, initOverrides) {
2600
2644
  return __awaiter(this, void 0, void 0, function* () {
@@ -2630,6 +2674,7 @@ class SDKApi extends BaseAPI {
2630
2674
  });
2631
2675
  }
2632
2676
  /**
2677
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
2633
2678
  * Generate a Coinbase onramp buy URL
2634
2679
  */
2635
2680
  generateCoinbaseOnrampBuyUrlRaw(requestParameters, initOverrides) {
@@ -2654,6 +2699,7 @@ class SDKApi extends BaseAPI {
2654
2699
  });
2655
2700
  }
2656
2701
  /**
2702
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
2657
2703
  * Generate a Coinbase onramp buy URL
2658
2704
  */
2659
2705
  generateCoinbaseOnrampBuyUrl(requestParameters, initOverrides) {
@@ -2663,7 +2709,8 @@ class SDKApi extends BaseAPI {
2663
2709
  });
2664
2710
  }
2665
2711
  /**
2666
- * Get the token balances for an account
2712
+ * Returns the token balances for a specific account address on a given chain.
2713
+ * Get token balances for an account
2667
2714
  */
2668
2715
  getAccountBalancesRaw(requestParameters, initOverrides) {
2669
2716
  return __awaiter(this, void 0, void 0, function* () {
@@ -2709,7 +2756,8 @@ class SDKApi extends BaseAPI {
2709
2756
  });
2710
2757
  }
2711
2758
  /**
2712
- * Get the token balances for an account
2759
+ * Returns the token balances for a specific account address on a given chain.
2760
+ * Get token balances for an account
2713
2761
  */
2714
2762
  getAccountBalances(requestParameters, initOverrides) {
2715
2763
  return __awaiter(this, void 0, void 0, function* () {
@@ -2763,7 +2811,8 @@ class SDKApi extends BaseAPI {
2763
2811
  });
2764
2812
  }
2765
2813
  /**
2766
- * Get auth token for given embedded wallet type
2814
+ * Returns an auth token for the specified embedded wallet type.
2815
+ * Get an auth token for an embedded wallet type
2767
2816
  */
2768
2817
  getAuthTokenRaw(requestParameters, initOverrides) {
2769
2818
  return __awaiter(this, void 0, void 0, function* () {
@@ -2792,7 +2841,8 @@ class SDKApi extends BaseAPI {
2792
2841
  });
2793
2842
  }
2794
2843
  /**
2795
- * Get auth token for given embedded wallet type
2844
+ * Returns an auth token for the specified embedded wallet type.
2845
+ * Get an auth token for an embedded wallet type
2796
2846
  */
2797
2847
  getAuthToken(requestParameters, initOverrides) {
2798
2848
  return __awaiter(this, void 0, void 0, function* () {
@@ -2828,7 +2878,8 @@ class SDKApi extends BaseAPI {
2828
2878
  });
2829
2879
  }
2830
2880
  /**
2831
- * Fetch user profile for the current authenticated user
2881
+ * Returns the full profile of the currently authenticated user.
2882
+ * Get the current user\'s profile
2832
2883
  */
2833
2884
  getAuthenticatedUserRaw(requestParameters, initOverrides) {
2834
2885
  return __awaiter(this, void 0, void 0, function* () {
@@ -2854,7 +2905,8 @@ class SDKApi extends BaseAPI {
2854
2905
  });
2855
2906
  }
2856
2907
  /**
2857
- * Fetch user profile for the current authenticated user
2908
+ * Returns the full profile of the currently authenticated user.
2909
+ * Get the current user\'s profile
2858
2910
  */
2859
2911
  getAuthenticatedUser(requestParameters, initOverrides) {
2860
2912
  return __awaiter(this, void 0, void 0, function* () {
@@ -2951,7 +3003,7 @@ class SDKApi extends BaseAPI {
2951
3003
  }
2952
3004
  /**
2953
3005
  * Generates the request body for a user\'s create V2 wallet account request
2954
- * Generates the request body for a user\'s create V2 wallet account request
3006
+ * Generate the create wallet account request body
2955
3007
  */
2956
3008
  getCreateWalletAccountRequestRaw(requestParameters, initOverrides) {
2957
3009
  return __awaiter(this, void 0, void 0, function* () {
@@ -2984,7 +3036,7 @@ class SDKApi extends BaseAPI {
2984
3036
  }
2985
3037
  /**
2986
3038
  * Generates the request body for a user\'s create V2 wallet account request
2987
- * Generates the request body for a user\'s create V2 wallet account request
3039
+ * Generate the create wallet account request body
2988
3040
  */
2989
3041
  getCreateWalletAccountRequest(requestParameters, initOverrides) {
2990
3042
  return __awaiter(this, void 0, void 0, function* () {
@@ -2994,6 +3046,7 @@ class SDKApi extends BaseAPI {
2994
3046
  }
2995
3047
  /**
2996
3048
  * Exchange rates for the given currency
3049
+ * Get currency exchange rates
2997
3050
  */
2998
3051
  getCurrencyExchangeRatesRaw(requestParameters, initOverrides) {
2999
3052
  return __awaiter(this, void 0, void 0, function* () {
@@ -3013,6 +3066,7 @@ class SDKApi extends BaseAPI {
3013
3066
  }
3014
3067
  /**
3015
3068
  * Exchange rates for the given currency
3069
+ * Get currency exchange rates
3016
3070
  */
3017
3071
  getCurrencyExchangeRates(requestParameters, initOverrides) {
3018
3072
  return __awaiter(this, void 0, void 0, function* () {
@@ -3049,7 +3103,7 @@ class SDKApi extends BaseAPI {
3049
3103
  }
3050
3104
  /**
3051
3105
  * 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.
3052
- * Get signin email provider
3106
+ * Get the sign-in email provider
3053
3107
  */
3054
3108
  getEmailProviderRaw(requestParameters, initOverrides) {
3055
3109
  return __awaiter(this, void 0, void 0, function* () {
@@ -3075,7 +3129,7 @@ class SDKApi extends BaseAPI {
3075
3129
  }
3076
3130
  /**
3077
3131
  * 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.
3078
- * Get signin email provider
3132
+ * Get the sign-in email provider
3079
3133
  */
3080
3134
  getEmailProvider(requestParameters, initOverrides) {
3081
3135
  return __awaiter(this, void 0, void 0, function* () {
@@ -3111,7 +3165,8 @@ class SDKApi extends BaseAPI {
3111
3165
  });
3112
3166
  }
3113
3167
  /**
3114
- * Return the backup key for the embedded wallet of the authenticated user
3168
+ * Returns the backup key for an embedded wallet.
3169
+ * Get the backup key for an embedded wallet
3115
3170
  */
3116
3171
  getEmbeddedWalletBackupsRaw(requestParameters, initOverrides) {
3117
3172
  return __awaiter(this, void 0, void 0, function* () {
@@ -3137,7 +3192,8 @@ class SDKApi extends BaseAPI {
3137
3192
  });
3138
3193
  }
3139
3194
  /**
3140
- * Return the backup key for the embedded wallet of the authenticated user
3195
+ * Returns the backup key for an embedded wallet.
3196
+ * Get the backup key for an embedded wallet
3141
3197
  */
3142
3198
  getEmbeddedWalletBackups(requestParameters, initOverrides) {
3143
3199
  return __awaiter(this, void 0, void 0, function* () {
@@ -3146,7 +3202,8 @@ class SDKApi extends BaseAPI {
3146
3202
  });
3147
3203
  }
3148
3204
  /**
3149
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
3205
+ * Returns the passcode for a pregenerated embedded wallet.
3206
+ * Get the passcode for a pregenerated embedded wallet
3150
3207
  */
3151
3208
  getEmbeddedWalletPasscodeRaw(requestParameters, initOverrides) {
3152
3209
  return __awaiter(this, void 0, void 0, function* () {
@@ -3172,7 +3229,8 @@ class SDKApi extends BaseAPI {
3172
3229
  });
3173
3230
  }
3174
3231
  /**
3175
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
3232
+ * Returns the passcode for a pregenerated embedded wallet.
3233
+ * Get the passcode for a pregenerated embedded wallet
3176
3234
  */
3177
3235
  getEmbeddedWalletPasscode(requestParameters, initOverrides) {
3178
3236
  return __awaiter(this, void 0, void 0, function* () {
@@ -3209,7 +3267,7 @@ class SDKApi extends BaseAPI {
3209
3267
  }
3210
3268
  /**
3211
3269
  * Generates the request body for a user\'s delete V2 wallets request
3212
- * Generates the request body for a user\'s delete V2 wallets request
3270
+ * Generate the delete wallets request body
3213
3271
  */
3214
3272
  getEmbeddedWalletsDeleteRequestRaw(requestParameters, initOverrides) {
3215
3273
  return __awaiter(this, void 0, void 0, function* () {
@@ -3239,7 +3297,7 @@ class SDKApi extends BaseAPI {
3239
3297
  }
3240
3298
  /**
3241
3299
  * Generates the request body for a user\'s delete V2 wallets request
3242
- * Generates the request body for a user\'s delete V2 wallets request
3300
+ * Generate the delete wallets request body
3243
3301
  */
3244
3302
  getEmbeddedWalletsDeleteRequest(requestParameters, initOverrides) {
3245
3303
  return __awaiter(this, void 0, void 0, function* () {
@@ -3248,6 +3306,7 @@ class SDKApi extends BaseAPI {
3248
3306
  });
3249
3307
  }
3250
3308
  /**
3309
+ * Returns the OAuth access token for the specified user OAuth account.
3251
3310
  * Get the access token for a user OAuth account
3252
3311
  */
3253
3312
  getEndUserOauthAccessTokenRaw(requestParameters, initOverrides) {
@@ -3270,6 +3329,7 @@ class SDKApi extends BaseAPI {
3270
3329
  });
3271
3330
  }
3272
3331
  /**
3332
+ * Returns the OAuth access token for the specified user OAuth account.
3273
3333
  * Get the access token for a user OAuth account
3274
3334
  */
3275
3335
  getEndUserOauthAccessToken(requestParameters, initOverrides) {
@@ -3309,7 +3369,8 @@ class SDKApi extends BaseAPI {
3309
3369
  });
3310
3370
  }
3311
3371
  /**
3312
- * Get the environment\'s settings
3372
+ * Returns the project settings and configuration for the specified environment.
3373
+ * Get environment settings
3313
3374
  */
3314
3375
  getEnvironmentSettingsRaw(requestParameters, initOverrides) {
3315
3376
  return __awaiter(this, void 0, void 0, function* () {
@@ -3331,7 +3392,8 @@ class SDKApi extends BaseAPI {
3331
3392
  });
3332
3393
  }
3333
3394
  /**
3334
- * Get the environment\'s settings
3395
+ * Returns the project settings and configuration for the specified environment.
3396
+ * Get environment settings
3335
3397
  */
3336
3398
  getEnvironmentSettings(requestParameters, initOverrides) {
3337
3399
  return __awaiter(this, void 0, void 0, function* () {
@@ -3341,6 +3403,7 @@ class SDKApi extends BaseAPI {
3341
3403
  }
3342
3404
  /**
3343
3405
  * Exchange rates for the given currency
3406
+ * Get exchange rates
3344
3407
  */
3345
3408
  getExchangeRatesRaw(initOverrides) {
3346
3409
  return __awaiter(this, void 0, void 0, function* () {
@@ -3357,6 +3420,7 @@ class SDKApi extends BaseAPI {
3357
3420
  }
3358
3421
  /**
3359
3422
  * Exchange rates for the given currency
3423
+ * Get exchange rates
3360
3424
  */
3361
3425
  getExchangeRates(initOverrides) {
3362
3426
  return __awaiter(this, void 0, void 0, function* () {
@@ -3389,6 +3453,7 @@ class SDKApi extends BaseAPI {
3389
3453
  });
3390
3454
  }
3391
3455
  /**
3456
+ * Returns the exchange account transactions for the authenticated user.
3392
3457
  * Get the exchange account transactions for a given dynamic user
3393
3458
  */
3394
3459
  getExchangeTransactionsRaw(requestParameters, initOverrides) {
@@ -3421,6 +3486,7 @@ class SDKApi extends BaseAPI {
3421
3486
  });
3422
3487
  }
3423
3488
  /**
3489
+ * Returns the exchange account transactions for the authenticated user.
3424
3490
  * Get the exchange account transactions for a given dynamic user
3425
3491
  */
3426
3492
  getExchangeTransactions(requestParameters, initOverrides) {
@@ -3460,6 +3526,7 @@ class SDKApi extends BaseAPI {
3460
3526
  });
3461
3527
  }
3462
3528
  /**
3529
+ * Returns the available transfer destinations for exchange account transactions.
3463
3530
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
3464
3531
  */
3465
3532
  getExchangeTransferDestinationsRaw(requestParameters, initOverrides) {
@@ -3489,6 +3556,7 @@ class SDKApi extends BaseAPI {
3489
3556
  });
3490
3557
  }
3491
3558
  /**
3559
+ * Returns the available transfer destinations for exchange account transactions.
3492
3560
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
3493
3561
  */
3494
3562
  getExchangeTransferDestinations(requestParameters, initOverrides) {
@@ -3528,6 +3596,7 @@ class SDKApi extends BaseAPI {
3528
3596
  });
3529
3597
  }
3530
3598
  /**
3599
+ * Returns the global wallet settings configured for the specified environment.
3531
3600
  * Get the global wallet settings for the environment
3532
3601
  */
3533
3602
  getGlobalWalletsSettingsRaw(requestParameters, initOverrides) {
@@ -3547,6 +3616,7 @@ class SDKApi extends BaseAPI {
3547
3616
  });
3548
3617
  }
3549
3618
  /**
3619
+ * Returns the global wallet settings configured for the specified environment.
3550
3620
  * Get the global wallet settings for the environment
3551
3621
  */
3552
3622
  getGlobalWalletsSettings(requestParameters, initOverrides) {
@@ -3557,6 +3627,7 @@ class SDKApi extends BaseAPI {
3557
3627
  }
3558
3628
  /**
3559
3629
  * Health check endpoint to check for uptime of API.
3630
+ * Check API health
3560
3631
  */
3561
3632
  getHealthcheckRaw(requestParameters, initOverrides) {
3562
3633
  return __awaiter(this, void 0, void 0, function* () {
@@ -3576,6 +3647,7 @@ class SDKApi extends BaseAPI {
3576
3647
  }
3577
3648
  /**
3578
3649
  * Health check endpoint to check for uptime of API.
3650
+ * Check API health
3579
3651
  */
3580
3652
  getHealthcheck(requestParameters, initOverrides) {
3581
3653
  return __awaiter(this, void 0, void 0, function* () {
@@ -3611,7 +3683,8 @@ class SDKApi extends BaseAPI {
3611
3683
  });
3612
3684
  }
3613
3685
  /**
3614
- * Find jwks for public key
3686
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
3687
+ * Get JWKS for the environment
3615
3688
  */
3616
3689
  getJwksByEnvironmentIdRaw(requestParameters, initOverrides) {
3617
3690
  return __awaiter(this, void 0, void 0, function* () {
@@ -3630,7 +3703,8 @@ class SDKApi extends BaseAPI {
3630
3703
  });
3631
3704
  }
3632
3705
  /**
3633
- * Find jwks for public key
3706
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
3707
+ * Get JWKS for the environment
3634
3708
  */
3635
3709
  getJwksByEnvironmentId(requestParameters, initOverrides) {
3636
3710
  return __awaiter(this, void 0, void 0, function* () {
@@ -3639,7 +3713,8 @@ class SDKApi extends BaseAPI {
3639
3713
  });
3640
3714
  }
3641
3715
  /**
3642
- * Find jwks for public key (JSON format)
3716
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
3717
+ * Get JWKS for the environment (JSON format)
3643
3718
  */
3644
3719
  getJwksJsonByEnvironmentIdRaw(requestParameters, initOverrides) {
3645
3720
  return __awaiter(this, void 0, void 0, function* () {
@@ -3658,7 +3733,8 @@ class SDKApi extends BaseAPI {
3658
3733
  });
3659
3734
  }
3660
3735
  /**
3661
- * Find jwks for public key (JSON format)
3736
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
3737
+ * Get JWKS for the environment (JSON format)
3662
3738
  */
3663
3739
  getJwksJsonByEnvironmentId(requestParameters, initOverrides) {
3664
3740
  return __awaiter(this, void 0, void 0, function* () {
@@ -3667,7 +3743,8 @@ class SDKApi extends BaseAPI {
3667
3743
  });
3668
3744
  }
3669
3745
  /**
3670
- * Get the current user\'s MFA by device id
3746
+ * Returns details of a specific MFA device by its ID.
3747
+ * Get an MFA device by ID
3671
3748
  */
3672
3749
  getMfaDeviceRaw(requestParameters, initOverrides) {
3673
3750
  return __awaiter(this, void 0, void 0, function* () {
@@ -3696,7 +3773,8 @@ class SDKApi extends BaseAPI {
3696
3773
  });
3697
3774
  }
3698
3775
  /**
3699
- * Get the current user\'s MFA by device id
3776
+ * Returns details of a specific MFA device by its ID.
3777
+ * Get an MFA device by ID
3700
3778
  */
3701
3779
  getMfaDevice(requestParameters, initOverrides) {
3702
3780
  return __awaiter(this, void 0, void 0, function* () {
@@ -3735,7 +3813,8 @@ class SDKApi extends BaseAPI {
3735
3813
  });
3736
3814
  }
3737
3815
  /**
3738
- * Find the configuration for the enabled networks associated to an environment
3816
+ * Returns the network configurations enabled for the specified environment.
3817
+ * Get network configurations for the environment
3739
3818
  */
3740
3819
  getNetworksConfigurationByEnvIdRaw(requestParameters, initOverrides) {
3741
3820
  return __awaiter(this, void 0, void 0, function* () {
@@ -3754,7 +3833,8 @@ class SDKApi extends BaseAPI {
3754
3833
  });
3755
3834
  }
3756
3835
  /**
3757
- * Find the configuration for the enabled networks associated to an environment
3836
+ * Returns the network configurations enabled for the specified environment.
3837
+ * Get network configurations for the environment
3758
3838
  */
3759
3839
  getNetworksConfigurationByEnvId(requestParameters, initOverrides) {
3760
3840
  return __awaiter(this, void 0, void 0, function* () {
@@ -3763,6 +3843,7 @@ class SDKApi extends BaseAPI {
3763
3843
  });
3764
3844
  }
3765
3845
  /**
3846
+ * Creates and returns a nonce for use in the wallet authentication flow.
3766
3847
  * Create nonce for authentication flow
3767
3848
  */
3768
3849
  getNonceRaw(requestParameters, initOverrides) {
@@ -3782,6 +3863,7 @@ class SDKApi extends BaseAPI {
3782
3863
  });
3783
3864
  }
3784
3865
  /**
3866
+ * Creates and returns a nonce for use in the wallet authentication flow.
3785
3867
  * Create nonce for authentication flow
3786
3868
  */
3787
3869
  getNonce(requestParameters, initOverrides) {
@@ -3791,7 +3873,8 @@ class SDKApi extends BaseAPI {
3791
3873
  });
3792
3874
  }
3793
3875
  /**
3794
- * Gets passkey authentication options
3876
+ * Returns the WebAuthn authentication options for passkey verification.
3877
+ * Get passkey authentication options
3795
3878
  */
3796
3879
  getPasskeyAuthenticationOptionsRaw(requestParameters, initOverrides) {
3797
3880
  return __awaiter(this, void 0, void 0, function* () {
@@ -3820,7 +3903,8 @@ class SDKApi extends BaseAPI {
3820
3903
  });
3821
3904
  }
3822
3905
  /**
3823
- * Gets passkey authentication options
3906
+ * Returns the WebAuthn authentication options for passkey verification.
3907
+ * Get passkey authentication options
3824
3908
  */
3825
3909
  getPasskeyAuthenticationOptions(requestParameters, initOverrides) {
3826
3910
  return __awaiter(this, void 0, void 0, function* () {
@@ -3859,7 +3943,8 @@ class SDKApi extends BaseAPI {
3859
3943
  });
3860
3944
  }
3861
3945
  /**
3862
- * Gets passkey authentication options
3946
+ * Returns the WebAuthn authentication options for passkey sign-in.
3947
+ * Get passkey sign-in options
3863
3948
  */
3864
3949
  getPasskeyAuthenticationSigninOptionsRaw(requestParameters, initOverrides) {
3865
3950
  return __awaiter(this, void 0, void 0, function* () {
@@ -3881,7 +3966,8 @@ class SDKApi extends BaseAPI {
3881
3966
  });
3882
3967
  }
3883
3968
  /**
3884
- * Gets passkey authentication options
3969
+ * Returns the WebAuthn authentication options for passkey sign-in.
3970
+ * Get passkey sign-in options
3885
3971
  */
3886
3972
  getPasskeyAuthenticationSigninOptions(requestParameters, initOverrides) {
3887
3973
  return __awaiter(this, void 0, void 0, function* () {
@@ -3890,7 +3976,8 @@ class SDKApi extends BaseAPI {
3890
3976
  });
3891
3977
  }
3892
3978
  /**
3893
- * Gets passkey data associated with a user
3979
+ * Returns the WebAuthn registration options needed to register a new passkey.
3980
+ * Get user passkeys
3894
3981
  */
3895
3982
  getPasskeyRegistrationOptionsRaw(requestParameters, initOverrides) {
3896
3983
  return __awaiter(this, void 0, void 0, function* () {
@@ -3909,7 +3996,8 @@ class SDKApi extends BaseAPI {
3909
3996
  });
3910
3997
  }
3911
3998
  /**
3912
- * Gets passkey data associated with a user
3999
+ * Returns the WebAuthn registration options needed to register a new passkey.
4000
+ * Get user passkeys
3913
4001
  */
3914
4002
  getPasskeyRegistrationOptions(requestParameters, initOverrides) {
3915
4003
  return __awaiter(this, void 0, void 0, function* () {
@@ -3945,6 +4033,7 @@ class SDKApi extends BaseAPI {
3945
4033
  });
3946
4034
  }
3947
4035
  /**
4036
+ * Returns the MFA recovery codes for the authenticated user.
3948
4037
  * Get recovery codes
3949
4038
  */
3950
4039
  getRecoveryCodesRaw(requestParameters, initOverrides) {
@@ -3971,6 +4060,7 @@ class SDKApi extends BaseAPI {
3971
4060
  });
3972
4061
  }
3973
4062
  /**
4063
+ * Returns the MFA recovery codes for the authenticated user.
3974
4064
  * Get recovery codes
3975
4065
  */
3976
4066
  getRecoveryCodes(requestParameters, initOverrides) {
@@ -3981,7 +4071,7 @@ class SDKApi extends BaseAPI {
3981
4071
  }
3982
4072
  /**
3983
4073
  * Find the configuration for the enabled offramps associated to an environment
3984
- * Configuration for enabled offramps
4074
+ * Get enabled offramps for the environment
3985
4075
  */
3986
4076
  getSupportedOfframpsRaw(requestParameters, initOverrides) {
3987
4077
  return __awaiter(this, void 0, void 0, function* () {
@@ -4019,7 +4109,7 @@ class SDKApi extends BaseAPI {
4019
4109
  }
4020
4110
  /**
4021
4111
  * Find the configuration for the enabled offramps associated to an environment
4022
- * Configuration for enabled offramps
4112
+ * Get enabled offramps for the environment
4023
4113
  */
4024
4114
  getSupportedOfframps(requestParameters, initOverrides) {
4025
4115
  return __awaiter(this, void 0, void 0, function* () {
@@ -4029,7 +4119,7 @@ class SDKApi extends BaseAPI {
4029
4119
  }
4030
4120
  /**
4031
4121
  * Find the configuration for the enabled onramps associated to an environment
4032
- * Configuration for enabled onramps
4122
+ * Get enabled onramps for the environment
4033
4123
  */
4034
4124
  getSupportedOnrampsRaw(requestParameters, initOverrides) {
4035
4125
  return __awaiter(this, void 0, void 0, function* () {
@@ -4079,7 +4169,7 @@ class SDKApi extends BaseAPI {
4079
4169
  }
4080
4170
  /**
4081
4171
  * Find the configuration for the enabled onramps associated to an environment
4082
- * Configuration for enabled onramps
4172
+ * Get enabled onramps for the environment
4083
4173
  */
4084
4174
  getSupportedOnramps(requestParameters, initOverrides) {
4085
4175
  return __awaiter(this, void 0, void 0, function* () {
@@ -4088,7 +4178,8 @@ class SDKApi extends BaseAPI {
4088
4178
  });
4089
4179
  }
4090
4180
  /**
4091
- * Get HTML with rendered Telegram login widget
4181
+ * Returns the HTML content for the Telegram login widget.
4182
+ * Get Telegram login widget HTML
4092
4183
  */
4093
4184
  getTelegramAuthRaw(requestParameters, initOverrides) {
4094
4185
  return __awaiter(this, void 0, void 0, function* () {
@@ -4113,7 +4204,8 @@ class SDKApi extends BaseAPI {
4113
4204
  });
4114
4205
  }
4115
4206
  /**
4116
- * Get HTML with rendered Telegram login widget
4207
+ * Returns the HTML content for the Telegram login widget.
4208
+ * Get Telegram login widget HTML
4117
4209
  */
4118
4210
  getTelegramAuth(requestParameters, initOverrides) {
4119
4211
  return __awaiter(this, void 0, void 0, function* () {
@@ -4122,6 +4214,7 @@ class SDKApi extends BaseAPI {
4122
4214
  });
4123
4215
  }
4124
4216
  /**
4217
+ * Returns account balances for the specified user addresses.
4125
4218
  * Get account balances for multiple addresses
4126
4219
  */
4127
4220
  getUserAccountBalancesRaw(requestParameters, initOverrides) {
@@ -4149,6 +4242,7 @@ class SDKApi extends BaseAPI {
4149
4242
  });
4150
4243
  }
4151
4244
  /**
4245
+ * Returns account balances for the specified user addresses.
4152
4246
  * Get account balances for multiple addresses
4153
4247
  */
4154
4248
  getUserAccountBalances(requestParameters, initOverrides) {
@@ -4158,6 +4252,7 @@ class SDKApi extends BaseAPI {
4158
4252
  });
4159
4253
  }
4160
4254
  /**
4255
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
4161
4256
  * Get the exchange accounts for a given dynamic user
4162
4257
  */
4163
4258
  getUserAccountsRaw(requestParameters, initOverrides) {
@@ -4193,6 +4288,7 @@ class SDKApi extends BaseAPI {
4193
4288
  });
4194
4289
  }
4195
4290
  /**
4291
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
4196
4292
  * Get the exchange accounts for a given dynamic user
4197
4293
  */
4198
4294
  getUserAccounts(requestParameters, initOverrides) {
@@ -4299,7 +4395,8 @@ class SDKApi extends BaseAPI {
4299
4395
  });
4300
4396
  }
4301
4397
  /**
4302
- * Get the current user\'s MFA Devices
4398
+ * Returns the list of MFA devices registered for the authenticated user.
4399
+ * Get the current user\'s MFA devices
4303
4400
  */
4304
4401
  getUserMfaDevicesRaw(requestParameters, initOverrides) {
4305
4402
  return __awaiter(this, void 0, void 0, function* () {
@@ -4325,7 +4422,8 @@ class SDKApi extends BaseAPI {
4325
4422
  });
4326
4423
  }
4327
4424
  /**
4328
- * Get the current user\'s MFA Devices
4425
+ * Returns the list of MFA devices registered for the authenticated user.
4426
+ * Get the current user\'s MFA devices
4329
4427
  */
4330
4428
  getUserMfaDevices(requestParameters, initOverrides) {
4331
4429
  return __awaiter(this, void 0, void 0, function* () {
@@ -4334,7 +4432,8 @@ class SDKApi extends BaseAPI {
4334
4432
  });
4335
4433
  }
4336
4434
  /**
4337
- * Get the current user\'s MFA Methods
4435
+ * Returns the available MFA methods for the authenticated user.
4436
+ * Get the current user\'s MFA methods
4338
4437
  */
4339
4438
  getUserMfaMethodsRaw(requestParameters, initOverrides) {
4340
4439
  return __awaiter(this, void 0, void 0, function* () {
@@ -4363,7 +4462,8 @@ class SDKApi extends BaseAPI {
4363
4462
  });
4364
4463
  }
4365
4464
  /**
4366
- * Get the current user\'s MFA Methods
4465
+ * Returns the available MFA methods for the authenticated user.
4466
+ * Get the current user\'s MFA methods
4367
4467
  */
4368
4468
  getUserMfaMethods(requestParameters, initOverrides) {
4369
4469
  return __awaiter(this, void 0, void 0, function* () {
@@ -4372,7 +4472,8 @@ class SDKApi extends BaseAPI {
4372
4472
  });
4373
4473
  }
4374
4474
  /**
4375
- * Gets passkey data associated with a user
4475
+ * Returns the list of passkeys registered for the authenticated user.
4476
+ * Get user passkeys
4376
4477
  */
4377
4478
  getUserPasskeysRaw(requestParameters, initOverrides) {
4378
4479
  return __awaiter(this, void 0, void 0, function* () {
@@ -4398,7 +4499,8 @@ class SDKApi extends BaseAPI {
4398
4499
  });
4399
4500
  }
4400
4501
  /**
4401
- * Gets passkey data associated with a user
4502
+ * Returns the list of passkeys registered for the authenticated user.
4503
+ * Get user passkeys
4402
4504
  */
4403
4505
  getUserPasskeys(requestParameters, initOverrides) {
4404
4506
  return __awaiter(this, void 0, void 0, function* () {
@@ -4408,7 +4510,7 @@ class SDKApi extends BaseAPI {
4408
4510
  }
4409
4511
  /**
4410
4512
  * 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.
4411
- * Fetch a single WaaS wallet with verified credentials
4513
+ * Get a WAAS wallet by address
4412
4514
  */
4413
4515
  getWaasWalletWithVerifiedCredentialsRaw(requestParameters, initOverrides) {
4414
4516
  return __awaiter(this, void 0, void 0, function* () {
@@ -4438,7 +4540,7 @@ class SDKApi extends BaseAPI {
4438
4540
  }
4439
4541
  /**
4440
4542
  * 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.
4441
- * Fetch a single WaaS wallet with verified credentials
4543
+ * Get a WAAS wallet by address
4442
4544
  */
4443
4545
  getWaasWalletWithVerifiedCredentials(requestParameters, initOverrides) {
4444
4546
  return __awaiter(this, void 0, void 0, function* () {
@@ -4632,7 +4734,7 @@ class SDKApi extends BaseAPI {
4632
4734
  }
4633
4735
  /**
4634
4736
  * Hard delete the authenticated user
4635
- * Hard delete a user
4737
+ * Delete the current user
4636
4738
  */
4637
4739
  hardDeleteUserRaw(requestParameters, initOverrides) {
4638
4740
  return __awaiter(this, void 0, void 0, function* () {
@@ -4659,7 +4761,7 @@ class SDKApi extends BaseAPI {
4659
4761
  }
4660
4762
  /**
4661
4763
  * Hard delete the authenticated user
4662
- * Hard delete a user
4764
+ * Delete the current user
4663
4765
  */
4664
4766
  hardDeleteUser(requestParameters, initOverrides) {
4665
4767
  return __awaiter(this, void 0, void 0, function* () {
@@ -4668,7 +4770,7 @@ class SDKApi extends BaseAPI {
4668
4770
  }
4669
4771
  /**
4670
4772
  * Import a private key to create a waas account
4671
- * Import an existing private key to create a waas account
4773
+ * Import a private key to create a WAAS wallet
4672
4774
  */
4673
4775
  importPrivateKeyRaw(requestParameters, initOverrides) {
4674
4776
  return __awaiter(this, void 0, void 0, function* () {
@@ -4700,7 +4802,7 @@ class SDKApi extends BaseAPI {
4700
4802
  }
4701
4803
  /**
4702
4804
  * Import a private key to create a waas account
4703
- * Import an existing private key to create a waas account
4805
+ * Import a private key to create a WAAS wallet
4704
4806
  */
4705
4807
  importPrivateKey(requestParameters, initOverrides) {
4706
4808
  return __awaiter(this, void 0, void 0, function* () {
@@ -4737,7 +4839,7 @@ class SDKApi extends BaseAPI {
4737
4839
  }
4738
4840
  /**
4739
4841
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
4740
- * Initialize oauth auth sequence
4842
+ * Initialize an OAuth authentication sequence
4741
4843
  */
4742
4844
  initAuthRaw(requestParameters, initOverrides) {
4743
4845
  return __awaiter(this, void 0, void 0, function* () {
@@ -4765,7 +4867,7 @@ class SDKApi extends BaseAPI {
4765
4867
  }
4766
4868
  /**
4767
4869
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
4768
- * Initialize oauth auth sequence
4870
+ * Initialize an OAuth authentication sequence
4769
4871
  */
4770
4872
  initAuth(requestParameters, initOverrides) {
4771
4873
  return __awaiter(this, void 0, void 0, function* () {
@@ -4942,7 +5044,7 @@ class SDKApi extends BaseAPI {
4942
5044
  }
4943
5045
  /**
4944
5046
  * Generates the turnkey request body for a user\'s delete wallets request
4945
- * Generates the turnkey request body for a user\'s delete wallets request
5047
+ * Generate the delete wallets request body
4946
5048
  */
4947
5049
  legacyGetEmbeddedWalletsDeleteRequestRaw(requestParameters, initOverrides) {
4948
5050
  return __awaiter(this, void 0, void 0, function* () {
@@ -4969,7 +5071,7 @@ class SDKApi extends BaseAPI {
4969
5071
  }
4970
5072
  /**
4971
5073
  * Generates the turnkey request body for a user\'s delete wallets request
4972
- * Generates the turnkey request body for a user\'s delete wallets request
5074
+ * Generate the delete wallets request body
4973
5075
  */
4974
5076
  legacyGetEmbeddedWalletsDeleteRequest(requestParameters, initOverrides) {
4975
5077
  return __awaiter(this, void 0, void 0, function* () {
@@ -5035,7 +5137,8 @@ class SDKApi extends BaseAPI {
5035
5137
  });
5036
5138
  }
5037
5139
  /**
5038
- * Update SDK settings for a specific environment
5140
+ * Logs the SDK settings being used by the client for the environment.
5141
+ * Update SDK settings for the environment
5039
5142
  */
5040
5143
  logDynamicSdkSettingsRaw(requestParameters, initOverrides) {
5041
5144
  return __awaiter(this, void 0, void 0, function* () {
@@ -5059,7 +5162,8 @@ class SDKApi extends BaseAPI {
5059
5162
  });
5060
5163
  }
5061
5164
  /**
5062
- * Update SDK settings for a specific environment
5165
+ * Logs the SDK settings being used by the client for the environment.
5166
+ * Update SDK settings for the environment
5063
5167
  */
5064
5168
  logDynamicSdkSettings(requestParameters, initOverrides) {
5065
5169
  return __awaiter(this, void 0, void 0, function* () {
@@ -5068,7 +5172,7 @@ class SDKApi extends BaseAPI {
5068
5172
  }
5069
5173
  /**
5070
5174
  * Used to merge two owned accounts connected by email address
5071
- * After successful verification allow to merge two owned accounts
5175
+ * Merge two owned accounts
5072
5176
  */
5073
5177
  mergeUsersRaw(requestParameters, initOverrides) {
5074
5178
  return __awaiter(this, void 0, void 0, function* () {
@@ -5095,7 +5199,7 @@ class SDKApi extends BaseAPI {
5095
5199
  }
5096
5200
  /**
5097
5201
  * Used to merge two owned accounts connected by email address
5098
- * After successful verification allow to merge two owned accounts
5202
+ * Merge two owned accounts
5099
5203
  */
5100
5204
  mergeUsers(requestParameters, initOverrides) {
5101
5205
  return __awaiter(this, void 0, void 0, function* () {
@@ -5186,7 +5290,7 @@ class SDKApi extends BaseAPI {
5186
5290
  }
5187
5291
  /**
5188
5292
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
5189
- * Oauth provider authorization endpoint
5293
+ * Get OAuth provider authorization HTML
5190
5294
  */
5191
5295
  oauthAuthorizeHtmlRaw(requestParameters, initOverrides) {
5192
5296
  return __awaiter(this, void 0, void 0, function* () {
@@ -5218,7 +5322,7 @@ class SDKApi extends BaseAPI {
5218
5322
  }
5219
5323
  /**
5220
5324
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
5221
- * Oauth provider authorization endpoint
5325
+ * Get OAuth provider authorization HTML
5222
5326
  */
5223
5327
  oauthAuthorizeHtml(requestParameters, initOverrides) {
5224
5328
  return __awaiter(this, void 0, void 0, function* () {
@@ -5257,7 +5361,8 @@ class SDKApi extends BaseAPI {
5257
5361
  });
5258
5362
  }
5259
5363
  /**
5260
- * Get redirect URL for Oauth provider login
5364
+ * Redirects the user to the specified OAuth provider login page.
5365
+ * Redirect to OAuth provider login
5261
5366
  */
5262
5367
  oauthLoginRaw(requestParameters, initOverrides) {
5263
5368
  return __awaiter(this, void 0, void 0, function* () {
@@ -5279,7 +5384,8 @@ class SDKApi extends BaseAPI {
5279
5384
  });
5280
5385
  }
5281
5386
  /**
5282
- * Get redirect URL for Oauth provider login
5387
+ * Redirects the user to the specified OAuth provider login page.
5388
+ * Redirect to OAuth provider login
5283
5389
  */
5284
5390
  oauthLogin(requestParameters, initOverrides) {
5285
5391
  return __awaiter(this, void 0, void 0, function* () {
@@ -5317,7 +5423,8 @@ class SDKApi extends BaseAPI {
5317
5423
  });
5318
5424
  }
5319
5425
  /**
5320
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
5426
+ * Returns the login URL for the specified OAuth provider.
5427
+ * Get the OAuth provider login URL
5321
5428
  */
5322
5429
  oauthLoginUrlRaw(requestParameters, initOverrides) {
5323
5430
  return __awaiter(this, void 0, void 0, function* () {
@@ -5339,7 +5446,8 @@ class SDKApi extends BaseAPI {
5339
5446
  });
5340
5447
  }
5341
5448
  /**
5342
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
5449
+ * Returns the login URL for the specified OAuth provider.
5450
+ * Get the OAuth provider login URL
5343
5451
  */
5344
5452
  oauthLoginUrl(requestParameters, initOverrides) {
5345
5453
  return __awaiter(this, void 0, void 0, function* () {
@@ -5379,7 +5487,7 @@ class SDKApi extends BaseAPI {
5379
5487
  }
5380
5488
  /**
5381
5489
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5382
- * Oauth provider redirect endpoint for apple ID
5490
+ * Handle Apple ID OAuth redirect
5383
5491
  */
5384
5492
  oauthRedirectAppleRaw(requestParameters, initOverrides) {
5385
5493
  return __awaiter(this, void 0, void 0, function* () {
@@ -5421,7 +5529,7 @@ class SDKApi extends BaseAPI {
5421
5529
  }
5422
5530
  /**
5423
5531
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5424
- * Oauth provider redirect endpoint for apple ID
5532
+ * Handle Apple ID OAuth redirect
5425
5533
  */
5426
5534
  oauthRedirectApple(requestParameters, initOverrides) {
5427
5535
  return __awaiter(this, void 0, void 0, function* () {
@@ -5458,7 +5566,7 @@ class SDKApi extends BaseAPI {
5458
5566
  }
5459
5567
  /**
5460
5568
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5461
- * Oauth provider redirect endpoint
5569
+ * Handle OAuth provider redirect
5462
5570
  */
5463
5571
  oauthRedirectCodeRaw(requestParameters, initOverrides) {
5464
5572
  return __awaiter(this, void 0, void 0, function* () {
@@ -5499,7 +5607,7 @@ class SDKApi extends BaseAPI {
5499
5607
  }
5500
5608
  /**
5501
5609
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5502
- * Oauth provider redirect endpoint
5610
+ * Handle OAuth provider redirect
5503
5611
  */
5504
5612
  oauthRedirectCode(requestParameters, initOverrides) {
5505
5613
  return __awaiter(this, void 0, void 0, function* () {
@@ -5538,7 +5646,8 @@ class SDKApi extends BaseAPI {
5538
5646
  });
5539
5647
  }
5540
5648
  /**
5541
- * Returns the authorization code or error retuned by oauth provider
5649
+ * Returns the OAuth authorization result for the given state.
5650
+ * Get the OAuth provider authorization result
5542
5651
  */
5543
5652
  oauthResultRaw(requestParameters, initOverrides) {
5544
5653
  return __awaiter(this, void 0, void 0, function* () {
@@ -5565,7 +5674,8 @@ class SDKApi extends BaseAPI {
5565
5674
  });
5566
5675
  }
5567
5676
  /**
5568
- * Returns the authorization code or error retuned by oauth provider
5677
+ * Returns the OAuth authorization result for the given state.
5678
+ * Get the OAuth provider authorization result
5569
5679
  */
5570
5680
  oauthResult(requestParameters, initOverrides) {
5571
5681
  return __awaiter(this, void 0, void 0, function* () {
@@ -5604,8 +5714,8 @@ class SDKApi extends BaseAPI {
5604
5714
  });
5605
5715
  }
5606
5716
  /**
5607
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
5608
- * Oauth provider SignIn endpoint
5717
+ * Standard OAuth SignIn callback to exchange temporary code for oauth access and return a valid Dynamic JWT and user
5718
+ * Sign in with OAuth provider
5609
5719
  */
5610
5720
  oauthSignInRaw(requestParameters, initOverrides) {
5611
5721
  return __awaiter(this, void 0, void 0, function* () {
@@ -5632,8 +5742,8 @@ class SDKApi extends BaseAPI {
5632
5742
  });
5633
5743
  }
5634
5744
  /**
5635
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
5636
- * Oauth provider SignIn endpoint
5745
+ * Standard OAuth SignIn callback to exchange temporary code for oauth access and return a valid Dynamic JWT and user
5746
+ * Sign in with OAuth provider
5637
5747
  */
5638
5748
  oauthSignIn(requestParameters, initOverrides) {
5639
5749
  return __awaiter(this, void 0, void 0, function* () {
@@ -5672,8 +5782,8 @@ class SDKApi extends BaseAPI {
5672
5782
  });
5673
5783
  }
5674
5784
  /**
5675
- * Standard OAuth verify callback to exchange temproary code for oauth access
5676
- * Oauth provider verify endpoint
5785
+ * Standard OAuth verify callback to exchange temporary code for oauth access
5786
+ * Verify OAuth provider authorization
5677
5787
  */
5678
5788
  oauthVerifyRaw(requestParameters, initOverrides) {
5679
5789
  return __awaiter(this, void 0, void 0, function* () {
@@ -5700,8 +5810,8 @@ class SDKApi extends BaseAPI {
5700
5810
  });
5701
5811
  }
5702
5812
  /**
5703
- * Standard OAuth verify callback to exchange temproary code for oauth access
5704
- * Oauth provider verify endpoint
5813
+ * Standard OAuth verify callback to exchange temporary code for oauth access
5814
+ * Verify OAuth provider authorization
5705
5815
  */
5706
5816
  oauthVerify(requestParameters, initOverrides) {
5707
5817
  return __awaiter(this, void 0, void 0, function* () {
@@ -5794,6 +5904,7 @@ class SDKApi extends BaseAPI {
5794
5904
  });
5795
5905
  }
5796
5906
  /**
5907
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
5797
5908
  * Add fees to a Solana transaction
5798
5909
  */
5799
5910
  optimizeTransactionRaw(requestParameters, initOverrides) {
@@ -5818,6 +5929,7 @@ class SDKApi extends BaseAPI {
5818
5929
  });
5819
5930
  }
5820
5931
  /**
5932
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
5821
5933
  * Add fees to a Solana transaction
5822
5934
  */
5823
5935
  optimizeTransaction(requestParameters, initOverrides) {
@@ -5908,6 +6020,7 @@ class SDKApi extends BaseAPI {
5908
6020
  });
5909
6021
  }
5910
6022
  /**
6023
+ * Transfers funds from an exchange account to an external address or another account.
5911
6024
  * Transfer funds from an exchange account to an external address or another Coinbase account
5912
6025
  */
5913
6026
  postExchangeAccountTransferRaw(requestParameters, initOverrides) {
@@ -5945,6 +6058,7 @@ class SDKApi extends BaseAPI {
5945
6058
  });
5946
6059
  }
5947
6060
  /**
6061
+ * Transfers funds from an exchange account to an external address or another account.
5948
6062
  * Transfer funds from an exchange account to an external address or another Coinbase account
5949
6063
  */
5950
6064
  postExchangeAccountTransfer(requestParameters, initOverrides) {
@@ -5987,6 +6101,7 @@ class SDKApi extends BaseAPI {
5987
6101
  });
5988
6102
  }
5989
6103
  /**
6104
+ * Returns token balances for multiple account addresses across different chains.
5990
6105
  * Get account balances for multiple addresses
5991
6106
  */
5992
6107
  postMultichainAccountBalancesRaw(requestParameters, initOverrides) {
@@ -6011,6 +6126,7 @@ class SDKApi extends BaseAPI {
6011
6126
  });
6012
6127
  }
6013
6128
  /**
6129
+ * Returns token balances for multiple account addresses across different chains.
6014
6130
  * Get account balances for multiple addresses
6015
6131
  */
6016
6132
  postMultichainAccountBalances(requestParameters, initOverrides) {
@@ -6052,6 +6168,7 @@ class SDKApi extends BaseAPI {
6052
6168
  });
6053
6169
  }
6054
6170
  /**
6171
+ * Handles the Telegram authentication callback after user authorization.
6055
6172
  * Handle Telegram authentication
6056
6173
  */
6057
6174
  postTelegramAuthRaw(requestParameters, initOverrides) {
@@ -6076,6 +6193,7 @@ class SDKApi extends BaseAPI {
6076
6193
  });
6077
6194
  }
6078
6195
  /**
6196
+ * Handles the Telegram authentication callback after user authorization.
6079
6197
  * Handle Telegram authentication
6080
6198
  */
6081
6199
  postTelegramAuth(requestParameters, initOverrides) {
@@ -6085,7 +6203,7 @@ class SDKApi extends BaseAPI {
6085
6203
  }
6086
6204
  /**
6087
6205
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
6088
- * prefetch information for wallet address
6206
+ * Prefetch information for a wallet address
6089
6207
  */
6090
6208
  prefetchRaw(requestParameters, initOverrides) {
6091
6209
  return __awaiter(this, void 0, void 0, function* () {
@@ -6110,7 +6228,7 @@ class SDKApi extends BaseAPI {
6110
6228
  }
6111
6229
  /**
6112
6230
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
6113
- * prefetch information for wallet address
6231
+ * Prefetch information for a wallet address
6114
6232
  */
6115
6233
  prefetch(requestParameters, initOverrides) {
6116
6234
  return __awaiter(this, void 0, void 0, function* () {
@@ -6118,7 +6236,8 @@ class SDKApi extends BaseAPI {
6118
6236
  });
6119
6237
  }
6120
6238
  /**
6121
- * Publish events for SDK
6239
+ * Publishes SDK analytics events for the given environment.
6240
+ * Publish SDK events
6122
6241
  */
6123
6242
  publishEventRaw(requestParameters, initOverrides) {
6124
6243
  return __awaiter(this, void 0, void 0, function* () {
@@ -6142,7 +6261,8 @@ class SDKApi extends BaseAPI {
6142
6261
  });
6143
6262
  }
6144
6263
  /**
6145
- * Publish events for SDK
6264
+ * Publishes SDK analytics events for the given environment.
6265
+ * Publish SDK events
6146
6266
  */
6147
6267
  publishEvent(requestParameters, initOverrides) {
6148
6268
  return __awaiter(this, void 0, void 0, function* () {
@@ -6150,7 +6270,8 @@ class SDKApi extends BaseAPI {
6150
6270
  });
6151
6271
  }
6152
6272
  /**
6153
- * Recover multiple keyShares
6273
+ * Recovers the client key shares for the specified WAAS wallet from backup.
6274
+ * Recover WAAS keyshares
6154
6275
  */
6155
6276
  recoverKeySharesRaw(requestParameters, initOverrides) {
6156
6277
  return __awaiter(this, void 0, void 0, function* () {
@@ -6181,7 +6302,8 @@ class SDKApi extends BaseAPI {
6181
6302
  });
6182
6303
  }
6183
6304
  /**
6184
- * Recover multiple keyShares
6305
+ * Recovers the client key shares for the specified WAAS wallet from backup.
6306
+ * Recover WAAS keyshares
6185
6307
  */
6186
6308
  recoverKeyShares(requestParameters, initOverrides) {
6187
6309
  return __awaiter(this, void 0, void 0, function* () {
@@ -6274,7 +6396,8 @@ class SDKApi extends BaseAPI {
6274
6396
  });
6275
6397
  }
6276
6398
  /**
6277
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
6399
+ * Refreshes the JWT auth token and returns a new token with updated claims.
6400
+ * Refresh the JWT auth token
6278
6401
  */
6279
6402
  refreshAuthRaw(requestParameters, initOverrides) {
6280
6403
  return __awaiter(this, void 0, void 0, function* () {
@@ -6300,7 +6423,8 @@ class SDKApi extends BaseAPI {
6300
6423
  });
6301
6424
  }
6302
6425
  /**
6303
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
6426
+ * Refreshes the JWT auth token and returns a new token with updated claims.
6427
+ * Refresh the JWT auth token
6304
6428
  */
6305
6429
  refreshAuth(requestParameters, initOverrides) {
6306
6430
  return __awaiter(this, void 0, void 0, function* () {
@@ -6309,7 +6433,8 @@ class SDKApi extends BaseAPI {
6309
6433
  });
6310
6434
  }
6311
6435
  /**
6312
- * Refresh keyshares
6436
+ * Refreshes the MPC key shares for the specified WAAS wallet.
6437
+ * Refresh WAAS keyshares
6313
6438
  */
6314
6439
  refreshKeySharesRaw(requestParameters, initOverrides) {
6315
6440
  return __awaiter(this, void 0, void 0, function* () {
@@ -6338,7 +6463,8 @@ class SDKApi extends BaseAPI {
6338
6463
  });
6339
6464
  }
6340
6465
  /**
6341
- * Refresh keyshares
6466
+ * Refreshes the MPC key shares for the specified WAAS wallet.
6467
+ * Refresh WAAS keyshares
6342
6468
  */
6343
6469
  refreshKeyShares(requestParameters, initOverrides) {
6344
6470
  return __awaiter(this, void 0, void 0, function* () {
@@ -6404,6 +6530,7 @@ class SDKApi extends BaseAPI {
6404
6530
  });
6405
6531
  }
6406
6532
  /**
6533
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
6407
6534
  * Register a new passkey
6408
6535
  */
6409
6536
  registerPasskeyRaw(requestParameters, initOverrides) {
@@ -6435,6 +6562,7 @@ class SDKApi extends BaseAPI {
6435
6562
  });
6436
6563
  }
6437
6564
  /**
6565
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
6438
6566
  * Register a new passkey
6439
6567
  */
6440
6568
  registerPasskey(requestParameters, initOverrides) {
@@ -6444,7 +6572,8 @@ class SDKApi extends BaseAPI {
6444
6572
  });
6445
6573
  }
6446
6574
  /**
6447
- * Register a new Passkey MFA device
6575
+ * Initiates passkey MFA device registration and returns the setup details.
6576
+ * Register a passkey MFA device
6448
6577
  */
6449
6578
  registerPasskeyMfaDeviceRaw(requestParameters, initOverrides) {
6450
6579
  return __awaiter(this, void 0, void 0, function* () {
@@ -6470,7 +6599,8 @@ class SDKApi extends BaseAPI {
6470
6599
  });
6471
6600
  }
6472
6601
  /**
6473
- * Register a new Passkey MFA device
6602
+ * Initiates passkey MFA device registration and returns the setup details.
6603
+ * Register a passkey MFA device
6474
6604
  */
6475
6605
  registerPasskeyMfaDevice(requestParameters, initOverrides) {
6476
6606
  return __awaiter(this, void 0, void 0, function* () {
@@ -6506,6 +6636,7 @@ class SDKApi extends BaseAPI {
6506
6636
  });
6507
6637
  }
6508
6638
  /**
6639
+ * Verifies the passkey credential to complete MFA device registration.
6509
6640
  * Verify Passkey MFA device
6510
6641
  */
6511
6642
  registerPasskeyMfaDeviceVerifyRaw(requestParameters, initOverrides) {
@@ -6537,6 +6668,7 @@ class SDKApi extends BaseAPI {
6537
6668
  });
6538
6669
  }
6539
6670
  /**
6671
+ * Verifies the passkey credential to complete MFA device registration.
6540
6672
  * Verify Passkey MFA device
6541
6673
  */
6542
6674
  registerPasskeyMfaDeviceVerify(requestParameters, initOverrides) {
@@ -6588,7 +6720,8 @@ class SDKApi extends BaseAPI {
6588
6720
  });
6589
6721
  }
6590
6722
  /**
6591
- * Register a new TOTP MFA device and get Totp Secret
6723
+ * Initiates TOTP MFA device registration and returns the setup details.
6724
+ * Register a TOTP MFA device
6592
6725
  */
6593
6726
  registerTotpMfaDeviceRaw(requestParameters, initOverrides) {
6594
6727
  return __awaiter(this, void 0, void 0, function* () {
@@ -6614,7 +6747,8 @@ class SDKApi extends BaseAPI {
6614
6747
  });
6615
6748
  }
6616
6749
  /**
6617
- * Register a new TOTP MFA device and get Totp Secret
6750
+ * Initiates TOTP MFA device registration and returns the setup details.
6751
+ * Register a TOTP MFA device
6618
6752
  */
6619
6753
  registerTotpMfaDevice(requestParameters, initOverrides) {
6620
6754
  return __awaiter(this, void 0, void 0, function* () {
@@ -6650,6 +6784,7 @@ class SDKApi extends BaseAPI {
6650
6784
  });
6651
6785
  }
6652
6786
  /**
6787
+ * Verifies the TOTP code to complete MFA device registration.
6653
6788
  * Verify TOTP MFA device
6654
6789
  */
6655
6790
  registerTotpMfaDeviceVerifyRaw(requestParameters, initOverrides) {
@@ -6681,6 +6816,7 @@ class SDKApi extends BaseAPI {
6681
6816
  });
6682
6817
  }
6683
6818
  /**
6819
+ * Verifies the TOTP code to complete MFA device registration.
6684
6820
  * Verify TOTP MFA device
6685
6821
  */
6686
6822
  registerTotpMfaDeviceVerify(requestParameters, initOverrides) {
@@ -6690,7 +6826,8 @@ class SDKApi extends BaseAPI {
6690
6826
  });
6691
6827
  }
6692
6828
  /**
6693
- * Reshare secret shares and update the threshold
6829
+ * Reshares the MPC secret shares for the specified WAAS wallet.
6830
+ * Reshare WAAS secret shares
6694
6831
  */
6695
6832
  reshareRaw(requestParameters, initOverrides) {
6696
6833
  return __awaiter(this, void 0, void 0, function* () {
@@ -6724,7 +6861,8 @@ class SDKApi extends BaseAPI {
6724
6861
  });
6725
6862
  }
6726
6863
  /**
6727
- * Reshare secret shares and update the threshold
6864
+ * Reshares the MPC secret shares for the specified WAAS wallet.
6865
+ * Reshare WAAS secret shares
6728
6866
  */
6729
6867
  reshare(requestParameters, initOverrides) {
6730
6868
  return __awaiter(this, void 0, void 0, function* () {
@@ -6832,7 +6970,8 @@ class SDKApi extends BaseAPI {
6832
6970
  });
6833
6971
  }
6834
6972
  /**
6835
- * Send new code for email verification
6973
+ * Resends the email verification code to the email address on file.
6974
+ * Resend email verification code
6836
6975
  */
6837
6976
  retryEmailVerificationRaw(requestParameters, initOverrides) {
6838
6977
  return __awaiter(this, void 0, void 0, function* () {
@@ -6856,7 +6995,8 @@ class SDKApi extends BaseAPI {
6856
6995
  });
6857
6996
  }
6858
6997
  /**
6859
- * Send new code for email verification
6998
+ * Resends the email verification code to the email address on file.
6999
+ * Resend email verification code
6860
7000
  */
6861
7001
  retryEmailVerification(requestParameters, initOverrides) {
6862
7002
  return __awaiter(this, void 0, void 0, function* () {
@@ -6892,7 +7032,8 @@ class SDKApi extends BaseAPI {
6892
7032
  });
6893
7033
  }
6894
7034
  /**
6895
- * Send new code for sms verification
7035
+ * Resends the SMS verification code to the phone number on file.
7036
+ * Resend SMS verification code
6896
7037
  */
6897
7038
  retrySmsVerificationRaw(requestParameters, initOverrides) {
6898
7039
  return __awaiter(this, void 0, void 0, function* () {
@@ -6916,7 +7057,8 @@ class SDKApi extends BaseAPI {
6916
7057
  });
6917
7058
  }
6918
7059
  /**
6919
- * Send new code for sms verification
7060
+ * Resends the SMS verification code to the phone number on file.
7061
+ * Resend SMS verification code
6920
7062
  */
6921
7063
  retrySmsVerification(requestParameters, initOverrides) {
6922
7064
  return __awaiter(this, void 0, void 0, function* () {
@@ -6952,6 +7094,7 @@ class SDKApi extends BaseAPI {
6952
7094
  });
6953
7095
  }
6954
7096
  /**
7097
+ * Revokes the current user session and invalidates the JWT.
6955
7098
  * Revoke a session
6956
7099
  */
6957
7100
  revokeSessionRaw(requestParameters, initOverrides) {
@@ -6978,6 +7121,7 @@ class SDKApi extends BaseAPI {
6978
7121
  });
6979
7122
  }
6980
7123
  /**
7124
+ * Revokes the current user session and invalidates the JWT.
6981
7125
  * Revoke a session
6982
7126
  */
6983
7127
  revokeSession(requestParameters, initOverrides) {
@@ -7013,6 +7157,7 @@ class SDKApi extends BaseAPI {
7013
7157
  });
7014
7158
  }
7015
7159
  /**
7160
+ * Scans a URL for potential phishing or malicious activity and returns the result.
7016
7161
  * Scan a URL for potential malicious activity
7017
7162
  */
7018
7163
  scanUrlRaw(requestParameters, initOverrides) {
@@ -7037,6 +7182,7 @@ class SDKApi extends BaseAPI {
7037
7182
  });
7038
7183
  }
7039
7184
  /**
7185
+ * Scans a URL for potential phishing or malicious activity and returns the result.
7040
7186
  * Scan a URL for potential malicious activity
7041
7187
  */
7042
7188
  scanUrl(requestParameters, initOverrides) {
@@ -7099,7 +7245,7 @@ class SDKApi extends BaseAPI {
7099
7245
  }
7100
7246
  /**
7101
7247
  * 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.
7102
- * Update wallet in a multi-wallet selection
7248
+ * Update primary wallet selection
7103
7249
  */
7104
7250
  selectUserWalletRaw(requestParameters, initOverrides) {
7105
7251
  return __awaiter(this, void 0, void 0, function* () {
@@ -7131,7 +7277,7 @@ class SDKApi extends BaseAPI {
7131
7277
  }
7132
7278
  /**
7133
7279
  * 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.
7134
- * Update wallet in a multi-wallet selection
7280
+ * Update primary wallet selection
7135
7281
  */
7136
7282
  selectUserWallet(requestParameters, initOverrides) {
7137
7283
  return __awaiter(this, void 0, void 0, function* () {
@@ -7167,7 +7313,8 @@ class SDKApi extends BaseAPI {
7167
7313
  });
7168
7314
  }
7169
7315
  /**
7170
- * Check that session is valid
7316
+ * Checks whether the current user session is still valid.
7317
+ * Check session validity
7171
7318
  */
7172
7319
  sessionCheckRaw(requestParameters, initOverrides) {
7173
7320
  return __awaiter(this, void 0, void 0, function* () {
@@ -7193,7 +7340,8 @@ class SDKApi extends BaseAPI {
7193
7340
  });
7194
7341
  }
7195
7342
  /**
7196
- * Check that session is valid
7343
+ * Checks whether the current user session is still valid.
7344
+ * Check session validity
7197
7345
  */
7198
7346
  sessionCheck(requestParameters, initOverrides) {
7199
7347
  return __awaiter(this, void 0, void 0, function* () {
@@ -7282,7 +7430,8 @@ class SDKApi extends BaseAPI {
7282
7430
  });
7283
7431
  }
7284
7432
  /**
7285
- * Verify an email and sign in user
7433
+ * Verifies the email code and authenticates the user, returning a JWT.
7434
+ * Verify email and sign in
7286
7435
  */
7287
7436
  signInWithEmailVerificationRaw(requestParameters, initOverrides) {
7288
7437
  return __awaiter(this, void 0, void 0, function* () {
@@ -7306,7 +7455,8 @@ class SDKApi extends BaseAPI {
7306
7455
  });
7307
7456
  }
7308
7457
  /**
7309
- * Verify an email and sign in user
7458
+ * Verifies the email code and authenticates the user, returning a JWT.
7459
+ * Verify email and sign in
7310
7460
  */
7311
7461
  signInWithEmailVerification(requestParameters, initOverrides) {
7312
7462
  return __awaiter(this, void 0, void 0, function* () {
@@ -7342,7 +7492,8 @@ class SDKApi extends BaseAPI {
7342
7492
  });
7343
7493
  }
7344
7494
  /**
7345
- * Verify an sms and sign in user
7495
+ * Verifies the SMS code and authenticates the user, returning a JWT.
7496
+ * Verify SMS and sign in
7346
7497
  */
7347
7498
  signInWithSmsVerificationRaw(requestParameters, initOverrides) {
7348
7499
  return __awaiter(this, void 0, void 0, function* () {
@@ -7366,7 +7517,8 @@ class SDKApi extends BaseAPI {
7366
7517
  });
7367
7518
  }
7368
7519
  /**
7369
- * Verify an sms and sign in user
7520
+ * Verifies the SMS code and authenticates the user, returning a JWT.
7521
+ * Verify SMS and sign in
7370
7522
  */
7371
7523
  signInWithSmsVerification(requestParameters, initOverrides) {
7372
7524
  return __awaiter(this, void 0, void 0, function* () {
@@ -7402,7 +7554,8 @@ class SDKApi extends BaseAPI {
7402
7554
  });
7403
7555
  }
7404
7556
  /**
7405
- * Sign a message with a waas account
7557
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
7558
+ * Sign a message with a WAAS wallet
7406
7559
  */
7407
7560
  signMessageRaw(requestParameters, initOverrides) {
7408
7561
  return __awaiter(this, void 0, void 0, function* () {
@@ -7436,7 +7589,8 @@ class SDKApi extends BaseAPI {
7436
7589
  });
7437
7590
  }
7438
7591
  /**
7439
- * Sign a message with a waas account
7592
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
7593
+ * Sign a message with a WAAS wallet
7440
7594
  */
7441
7595
  signMessage(requestParameters, initOverrides) {
7442
7596
  return __awaiter(this, void 0, void 0, function* () {
@@ -7475,6 +7629,7 @@ class SDKApi extends BaseAPI {
7475
7629
  });
7476
7630
  }
7477
7631
  /**
7632
+ * Authenticates a user using a passkey and returns a JWT.
7478
7633
  * Authenticate a passkey
7479
7634
  */
7480
7635
  signinWithPasskeyRaw(requestParameters, initOverrides) {
@@ -7499,6 +7654,7 @@ class SDKApi extends BaseAPI {
7499
7654
  });
7500
7655
  }
7501
7656
  /**
7657
+ * Authenticates a user using a passkey and returns a JWT.
7502
7658
  * Authenticate a passkey
7503
7659
  */
7504
7660
  signinWithPasskey(requestParameters, initOverrides) {
@@ -7508,6 +7664,7 @@ class SDKApi extends BaseAPI {
7508
7664
  });
7509
7665
  }
7510
7666
  /**
7667
+ * Simulates an EVM transaction and returns the expected outcome.
7511
7668
  * Simulate an EVM transaction
7512
7669
  */
7513
7670
  simulateEVMTransactionRaw(requestParameters, initOverrides) {
@@ -7532,6 +7689,7 @@ class SDKApi extends BaseAPI {
7532
7689
  });
7533
7690
  }
7534
7691
  /**
7692
+ * Simulates an EVM transaction and returns the expected outcome.
7535
7693
  * Simulate an EVM transaction
7536
7694
  */
7537
7695
  simulateEVMTransaction(requestParameters, initOverrides) {
@@ -7568,6 +7726,7 @@ class SDKApi extends BaseAPI {
7568
7726
  });
7569
7727
  }
7570
7728
  /**
7729
+ * Simulates a Solana transaction and returns the expected outcome.
7571
7730
  * Simulate a Solana transaction
7572
7731
  */
7573
7732
  simulateSVMTransactionRaw(requestParameters, initOverrides) {
@@ -7592,6 +7751,7 @@ class SDKApi extends BaseAPI {
7592
7751
  });
7593
7752
  }
7594
7753
  /**
7754
+ * Simulates a Solana transaction and returns the expected outcome.
7595
7755
  * Simulate a Solana transaction
7596
7756
  */
7597
7757
  simulateSVMTransaction(requestParameters, initOverrides) {
@@ -7628,6 +7788,7 @@ class SDKApi extends BaseAPI {
7628
7788
  });
7629
7789
  }
7630
7790
  /**
7791
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
7631
7792
  * Simulate an EVM AA UserOp
7632
7793
  */
7633
7794
  simulateUserOpRaw(requestParameters, initOverrides) {
@@ -7652,6 +7813,7 @@ class SDKApi extends BaseAPI {
7652
7813
  });
7653
7814
  }
7654
7815
  /**
7816
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
7655
7817
  * Simulate an EVM AA UserOp
7656
7818
  */
7657
7819
  simulateUserOp(requestParameters, initOverrides) {
@@ -7846,7 +8008,8 @@ class SDKApi extends BaseAPI {
7846
8008
  });
7847
8009
  }
7848
8010
  /**
7849
- * Telegram provider check auth
8011
+ * Checks if a Telegram authentication attempt has been completed.
8012
+ * Check Telegram authentication status
7850
8013
  */
7851
8014
  telegramCheckAuthRaw(requestParameters, initOverrides) {
7852
8015
  return __awaiter(this, void 0, void 0, function* () {
@@ -7867,7 +8030,8 @@ class SDKApi extends BaseAPI {
7867
8030
  });
7868
8031
  }
7869
8032
  /**
7870
- * Telegram provider check auth
8033
+ * Checks if a Telegram authentication attempt has been completed.
8034
+ * Check Telegram authentication status
7871
8035
  */
7872
8036
  telegramCheckAuth(requestParameters, initOverrides) {
7873
8037
  return __awaiter(this, void 0, void 0, function* () {
@@ -7902,7 +8066,8 @@ class SDKApi extends BaseAPI {
7902
8066
  });
7903
8067
  }
7904
8068
  /**
7905
- * Telegram provider SignIn endpoint
8069
+ * Authenticates a user using their Telegram account credentials.
8070
+ * Sign in with Telegram
7906
8071
  */
7907
8072
  telegramSignInRaw(requestParameters, initOverrides) {
7908
8073
  return __awaiter(this, void 0, void 0, function* () {
@@ -7923,7 +8088,8 @@ class SDKApi extends BaseAPI {
7923
8088
  });
7924
8089
  }
7925
8090
  /**
7926
- * Telegram provider SignIn endpoint
8091
+ * Authenticates a user using their Telegram account credentials.
8092
+ * Sign in with Telegram
7927
8093
  */
7928
8094
  telegramSignIn(requestParameters, initOverrides) {
7929
8095
  return __awaiter(this, void 0, void 0, function* () {
@@ -7959,7 +8125,8 @@ class SDKApi extends BaseAPI {
7959
8125
  });
7960
8126
  }
7961
8127
  /**
7962
- * Telegram provider Verify endpoint
8128
+ * Verifies and links a Telegram account to the authenticated user.
8129
+ * Verify Telegram account linking
7963
8130
  */
7964
8131
  telegramVerifyRaw(requestParameters, initOverrides) {
7965
8132
  return __awaiter(this, void 0, void 0, function* () {
@@ -7987,7 +8154,8 @@ class SDKApi extends BaseAPI {
7987
8154
  });
7988
8155
  }
7989
8156
  /**
7990
- * Telegram provider Verify endpoint
8157
+ * Verifies and links a Telegram account to the authenticated user.
8158
+ * Verify Telegram account linking
7991
8159
  */
7992
8160
  telegramVerify(requestParameters, initOverrides) {
7993
8161
  return __awaiter(this, void 0, void 0, function* () {
@@ -8023,6 +8191,7 @@ class SDKApi extends BaseAPI {
8023
8191
  });
8024
8192
  }
8025
8193
  /**
8194
+ * Updates the V2 recovery email address for the authenticated user.
8026
8195
  * Update a user\'s V2 recovery email
8027
8196
  */
8028
8197
  updateEmbeddedWalletRecoveryEmailRaw(requestParameters, initOverrides) {
@@ -8054,6 +8223,7 @@ class SDKApi extends BaseAPI {
8054
8223
  });
8055
8224
  }
8056
8225
  /**
8226
+ * Updates the V2 recovery email address for the authenticated user.
8057
8227
  * Update a user\'s V2 recovery email
8058
8228
  */
8059
8229
  updateEmbeddedWalletRecoveryEmail(requestParameters, initOverrides) {
@@ -8062,7 +8232,8 @@ class SDKApi extends BaseAPI {
8062
8232
  });
8063
8233
  }
8064
8234
  /**
8065
- * Update a passkey\'s info
8235
+ * Updates the specified passkey for the authenticated user.
8236
+ * Update a passkey
8066
8237
  */
8067
8238
  updatePasskeyRaw(requestParameters, initOverrides) {
8068
8239
  return __awaiter(this, void 0, void 0, function* () {
@@ -8093,7 +8264,8 @@ class SDKApi extends BaseAPI {
8093
8264
  });
8094
8265
  }
8095
8266
  /**
8096
- * Update a passkey\'s info
8267
+ * Updates the specified passkey for the authenticated user.
8268
+ * Update a passkey
8097
8269
  */
8098
8270
  updatePasskey(requestParameters, initOverrides) {
8099
8271
  return __awaiter(this, void 0, void 0, function* () {
@@ -8102,7 +8274,8 @@ class SDKApi extends BaseAPI {
8102
8274
  });
8103
8275
  }
8104
8276
  /**
8105
- * Update a user\'s fields
8277
+ * Updates the authenticated user profile fields.
8278
+ * Update user fields
8106
8279
  */
8107
8280
  updateSelfRaw(requestParameters, initOverrides) {
8108
8281
  return __awaiter(this, void 0, void 0, function* () {
@@ -8133,7 +8306,8 @@ class SDKApi extends BaseAPI {
8133
8306
  });
8134
8307
  }
8135
8308
  /**
8136
- * Update a user\'s fields
8309
+ * Updates the authenticated user profile fields.
8310
+ * Update user fields
8137
8311
  */
8138
8312
  updateSelf(requestParameters, initOverrides) {
8139
8313
  return __awaiter(this, void 0, void 0, function* () {
@@ -8142,7 +8316,8 @@ class SDKApi extends BaseAPI {
8142
8316
  });
8143
8317
  }
8144
8318
  /**
8145
- * Update a device
8319
+ * Updates the specified MFA device for the authenticated user.
8320
+ * Update an MFA device
8146
8321
  */
8147
8322
  updateUserMfaDeviceRaw(requestParameters, initOverrides) {
8148
8323
  return __awaiter(this, void 0, void 0, function* () {
@@ -8173,7 +8348,8 @@ class SDKApi extends BaseAPI {
8173
8348
  });
8174
8349
  }
8175
8350
  /**
8176
- * Update a device
8351
+ * Updates the specified MFA device for the authenticated user.
8352
+ * Update an MFA device
8177
8353
  */
8178
8354
  updateUserMfaDevice(requestParameters, initOverrides) {
8179
8355
  return __awaiter(this, void 0, void 0, function* () {
@@ -8182,7 +8358,7 @@ class SDKApi extends BaseAPI {
8182
8358
  }
8183
8359
  /**
8184
8360
  * Updates the settings for a WAAS wallet
8185
- * Update the WAAS wallet settings for the wallet
8361
+ * Update WAAS wallet settings
8186
8362
  */
8187
8363
  updateWaasWalletSettingsRaw(requestParameters, initOverrides) {
8188
8364
  return __awaiter(this, void 0, void 0, function* () {
@@ -8217,7 +8393,7 @@ class SDKApi extends BaseAPI {
8217
8393
  }
8218
8394
  /**
8219
8395
  * Updates the settings for a WAAS wallet
8220
- * Update the WAAS wallet settings for the wallet
8396
+ * Update WAAS wallet settings
8221
8397
  */
8222
8398
  updateWaasWalletSettings(requestParameters, initOverrides) {
8223
8399
  return __awaiter(this, void 0, void 0, function* () {
@@ -8226,6 +8402,7 @@ class SDKApi extends BaseAPI {
8226
8402
  });
8227
8403
  }
8228
8404
  /**
8405
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
8229
8406
  * Update V1 embedded wallet to V2
8230
8407
  */
8231
8408
  upgradeEmbeddedWalletToV2Raw(requestParameters, initOverrides) {
@@ -8250,6 +8427,7 @@ class SDKApi extends BaseAPI {
8250
8427
  });
8251
8428
  }
8252
8429
  /**
8430
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
8253
8431
  * Update V1 embedded wallet to V2
8254
8432
  */
8255
8433
  upgradeEmbeddedWalletToV2(requestParameters, initOverrides) {
@@ -8340,6 +8518,7 @@ class SDKApi extends BaseAPI {
8340
8518
  });
8341
8519
  }
8342
8520
  /**
8521
+ * Verifies the signed payload and returns a JWT authentication token.
8343
8522
  * Verify payload and return JWT
8344
8523
  */
8345
8524
  verifyRaw(requestParameters, initOverrides) {
@@ -8364,6 +8543,7 @@ class SDKApi extends BaseAPI {
8364
8543
  });
8365
8544
  }
8366
8545
  /**
8546
+ * Verifies the signed payload and returns a JWT authentication token.
8367
8547
  * Verify payload and return JWT
8368
8548
  */
8369
8549
  verify(requestParameters, initOverrides) {
@@ -8373,7 +8553,8 @@ class SDKApi extends BaseAPI {
8373
8553
  });
8374
8554
  }
8375
8555
  /**
8376
- * Verify email verification request
8556
+ * Verifies the email code and completes the email verification process.
8557
+ * Verify email verification code
8377
8558
  */
8378
8559
  verifyEmailVerificationRaw(requestParameters, initOverrides) {
8379
8560
  return __awaiter(this, void 0, void 0, function* () {
@@ -8404,7 +8585,8 @@ class SDKApi extends BaseAPI {
8404
8585
  });
8405
8586
  }
8406
8587
  /**
8407
- * Verify email verification request
8588
+ * Verifies the email code and completes the email verification process.
8589
+ * Verify email verification code
8408
8590
  */
8409
8591
  verifyEmailVerification(requestParameters, initOverrides) {
8410
8592
  return __awaiter(this, void 0, void 0, function* () {
@@ -8441,7 +8623,7 @@ class SDKApi extends BaseAPI {
8441
8623
  }
8442
8624
  /**
8443
8625
  * Link a wallet to a valid environment user, and return an updated JWT
8444
- * Link wallet to user
8626
+ * Link a wallet to a user
8445
8627
  */
8446
8628
  verifyLinkRaw(requestParameters, initOverrides) {
8447
8629
  return __awaiter(this, void 0, void 0, function* () {
@@ -8473,7 +8655,7 @@ class SDKApi extends BaseAPI {
8473
8655
  }
8474
8656
  /**
8475
8657
  * Link a wallet to a valid environment user, and return an updated JWT
8476
- * Link wallet to user
8658
+ * Link a wallet to a user
8477
8659
  */
8478
8660
  verifyLink(requestParameters, initOverrides) {
8479
8661
  return __awaiter(this, void 0, void 0, function* () {
@@ -8632,7 +8814,8 @@ class SDKApi extends BaseAPI {
8632
8814
  });
8633
8815
  }
8634
8816
  /**
8635
- * Verify sms verification request
8817
+ * Verifies the SMS code and completes the phone number verification process.
8818
+ * Verify SMS verification code
8636
8819
  */
8637
8820
  verifySmsVerificationRaw(requestParameters, initOverrides) {
8638
8821
  return __awaiter(this, void 0, void 0, function* () {
@@ -8663,7 +8846,8 @@ class SDKApi extends BaseAPI {
8663
8846
  });
8664
8847
  }
8665
8848
  /**
8666
- * Verify sms verification request
8849
+ * Verifies the SMS code and completes the phone number verification process.
8850
+ * Verify SMS verification code
8667
8851
  */
8668
8852
  verifySmsVerification(requestParameters, initOverrides) {
8669
8853
  return __awaiter(this, void 0, void 0, function* () {
@@ -8700,7 +8884,7 @@ class SDKApi extends BaseAPI {
8700
8884
  }
8701
8885
  /**
8702
8886
  * Used to link a wallet after user has confirmed transfer to the new account
8703
- * Verify wallet transfer
8887
+ * Verify a wallet transfer
8704
8888
  */
8705
8889
  verifyTransferRaw(requestParameters, initOverrides) {
8706
8890
  return __awaiter(this, void 0, void 0, function* () {
@@ -8732,7 +8916,7 @@ class SDKApi extends BaseAPI {
8732
8916
  }
8733
8917
  /**
8734
8918
  * Used to link a wallet after user has confirmed transfer to the new account
8735
- * Verify wallet transfer
8919
+ * Verify a wallet transfer
8736
8920
  */
8737
8921
  verifyTransfer(requestParameters, initOverrides) {
8738
8922
  return __awaiter(this, void 0, void 0, function* () {
@@ -8769,7 +8953,7 @@ class SDKApi extends BaseAPI {
8769
8953
  }
8770
8954
  /**
8771
8955
  * Remove a link from to a valid environment user, and return an updated JWT
8772
- * unlink wallet from user
8956
+ * Unlink a wallet from a user
8773
8957
  */
8774
8958
  verifyUnlinkRaw(requestParameters, initOverrides) {
8775
8959
  return __awaiter(this, void 0, void 0, function* () {
@@ -8801,7 +8985,7 @@ class SDKApi extends BaseAPI {
8801
8985
  }
8802
8986
  /**
8803
8987
  * Remove a link from to a valid environment user, and return an updated JWT
8804
- * unlink wallet from user
8988
+ * Unlink a wallet from a user
8805
8989
  */
8806
8990
  verifyUnlink(requestParameters, initOverrides) {
8807
8991
  return __awaiter(this, void 0, void 0, function* () {
@@ -8921,6 +9105,7 @@ class SDKApi extends BaseAPI {
8921
9105
  });
8922
9106
  }
8923
9107
  /**
9108
+ * Authenticates a user by verifying their wallet signature.
8924
9109
  * Sign in with wallet
8925
9110
  */
8926
9111
  walletsSigninRaw(requestParameters, initOverrides) {
@@ -8945,6 +9130,7 @@ class SDKApi extends BaseAPI {
8945
9130
  });
8946
9131
  }
8947
9132
  /**
9133
+ * Authenticates a user by verifying their wallet signature.
8948
9134
  * Sign in with wallet
8949
9135
  */
8950
9136
  walletsSignin(requestParameters, initOverrides) {
@@ -8982,7 +9168,7 @@ class SDKApi extends BaseAPI {
8982
9168
  }
8983
9169
  /**
8984
9170
  * Verify a wallet, and return an updated JWT
8985
- * Verify wallet
9171
+ * Verify a wallet
8986
9172
  */
8987
9173
  walletsVerifyRaw(requestParameters, initOverrides) {
8988
9174
  return __awaiter(this, void 0, void 0, function* () {
@@ -9014,7 +9200,7 @@ class SDKApi extends BaseAPI {
9014
9200
  }
9015
9201
  /**
9016
9202
  * Verify a wallet, and return an updated JWT
9017
- * Verify wallet
9203
+ * Verify a wallet
9018
9204
  */
9019
9205
  walletsVerify(requestParameters, initOverrides) {
9020
9206
  return __awaiter(this, void 0, void 0, function* () {