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

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.
@@ -102,6 +102,7 @@ import { InitEmailAuthRequestToJSON } from '../models/InitEmailAuthRequest.js';
102
102
  import { InitEmailAuthResponseFromJSON } from '../models/InitEmailAuthResponse.js';
103
103
  import { InitPasskeyRecoveryRequestToJSON } from '../models/InitPasskeyRecoveryRequest.js';
104
104
  import { InitPasskeyRecoveryResponseFromJSON } from '../models/InitPasskeyRecoveryResponse.js';
105
+ import { InlineObjectToJSON } from '../models/InlineObject.js';
105
106
  import { JwksResponseFromJSON } from '../models/JwksResponse.js';
106
107
  import '../models/MFAAction.js';
107
108
  import '../models/PublicKeyCredentialType.js';
@@ -180,6 +181,7 @@ import { SupportedOfframpsResponseFromJSON } from '../models/SupportedOfframpsRe
180
181
  import { SupportedOnrampsResponseFromJSON } from '../models/SupportedOnrampsResponse.js';
181
182
  import { TelegramPostRequestToJSON } from '../models/TelegramPostRequest.js';
182
183
  import '../models/TokenScope.js';
184
+ import { TransactionFeeEstimateResponseFromJSON } from '../models/TransactionFeeEstimateResponse.js';
183
185
  import { TransferDestinationResponseFromJSON } from '../models/TransferDestinationResponse.js';
184
186
  import { TurnkeyCreateWalletAccountsRequestBodyFromJSON } from '../models/TurnkeyCreateWalletAccountsRequestBody.js';
185
187
  import { TurnkeyDeleteEmbeddedWalletsRequestBodyFromJSON } from '../models/TurnkeyDeleteEmbeddedWalletsRequestBody.js';
@@ -264,6 +266,7 @@ class SDKApi extends BaseAPI {
264
266
  });
265
267
  }
266
268
  /**
269
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
267
270
  * Upgrade JWT scope with valid MFA session
268
271
  */
269
272
  authMfaRecoveryRaw(requestParameters, initOverrides) {
@@ -295,6 +298,7 @@ class SDKApi extends BaseAPI {
295
298
  });
296
299
  }
297
300
  /**
301
+ * Authenticates via recovery code and upgrades the JWT scope with a valid MFA session.
298
302
  * Upgrade JWT scope with valid MFA session
299
303
  */
300
304
  authMfaRecovery(requestParameters, initOverrides) {
@@ -331,6 +335,7 @@ class SDKApi extends BaseAPI {
331
335
  });
332
336
  }
333
337
  /**
338
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
334
339
  * Upgrade JWT scope with valid MFA session
335
340
  */
336
341
  authMfaTotpDeviceRaw(requestParameters, initOverrides) {
@@ -362,6 +367,7 @@ class SDKApi extends BaseAPI {
362
367
  });
363
368
  }
364
369
  /**
370
+ * Authenticates via TOTP code and upgrades the JWT scope with a valid MFA session.
365
371
  * Upgrade JWT scope with valid MFA session
366
372
  */
367
373
  authMfaTotpDevice(requestParameters, initOverrides) {
@@ -398,6 +404,7 @@ class SDKApi extends BaseAPI {
398
404
  });
399
405
  }
400
406
  /**
407
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
401
408
  * Upgrade JWT scope with valid MFA session
402
409
  */
403
410
  authenticateMfaEmailRaw(requestParameters, initOverrides) {
@@ -429,6 +436,7 @@ class SDKApi extends BaseAPI {
429
436
  });
430
437
  }
431
438
  /**
439
+ * Authenticates via email verification and upgrades the JWT scope with a valid MFA session.
432
440
  * Upgrade JWT scope with valid MFA session
433
441
  */
434
442
  authenticateMfaEmail(requestParameters, initOverrides) {
@@ -438,6 +446,7 @@ class SDKApi extends BaseAPI {
438
446
  });
439
447
  }
440
448
  /**
449
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
441
450
  * Upgrade JWT scope with valid MFA session
442
451
  */
443
452
  authenticateMfaPasskeyDeviceRaw(requestParameters, initOverrides) {
@@ -469,6 +478,7 @@ class SDKApi extends BaseAPI {
469
478
  });
470
479
  }
471
480
  /**
481
+ * Authenticates via passkey and upgrades the JWT scope with a valid MFA session.
472
482
  * Upgrade JWT scope with valid MFA session
473
483
  */
474
484
  authenticateMfaPasskeyDevice(requestParameters, initOverrides) {
@@ -508,7 +518,8 @@ class SDKApi extends BaseAPI {
508
518
  });
509
519
  }
510
520
  /**
511
- * Backup multiple keyShares for a waaS wallet
521
+ * Backs up the client key shares for the specified WAAS wallet.
522
+ * Back up keyshares for a WAAS wallet
512
523
  */
513
524
  backupKeySharesRaw(requestParameters, initOverrides) {
514
525
  return __awaiter(this, void 0, void 0, function* () {
@@ -542,7 +553,8 @@ class SDKApi extends BaseAPI {
542
553
  });
543
554
  }
544
555
  /**
545
- * Backup multiple keyShares for a waaS wallet
556
+ * Backs up the client key shares for the specified WAAS wallet.
557
+ * Back up keyshares for a WAAS wallet
546
558
  */
547
559
  backupKeyShares(requestParameters, initOverrides) {
548
560
  return __awaiter(this, void 0, void 0, function* () {
@@ -581,7 +593,8 @@ class SDKApi extends BaseAPI {
581
593
  });
582
594
  }
583
595
  /**
584
- * Backup multiple keyShares for a waaS wallet to Google Drive
596
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
597
+ * Back up keyshares to Google Drive
585
598
  */
586
599
  backupKeySharesToGoogleDriveRaw(requestParameters, initOverrides) {
587
600
  return __awaiter(this, void 0, void 0, function* () {
@@ -610,7 +623,8 @@ class SDKApi extends BaseAPI {
610
623
  });
611
624
  }
612
625
  /**
613
- * Backup multiple keyShares for a waaS wallet to Google Drive
626
+ * Backs up the client key shares for the specified WAAS wallet to Google Drive.
627
+ * Back up keyshares to Google Drive
614
628
  */
615
629
  backupKeySharesToGoogleDrive(requestParameters, initOverrides) {
616
630
  return __awaiter(this, void 0, void 0, function* () {
@@ -649,6 +663,7 @@ class SDKApi extends BaseAPI {
649
663
  });
650
664
  }
651
665
  /**
666
+ * Records a backup action and event for the specified location without performing the actual backup.
652
667
  * Create backup action and event for a specified location without performing actual backup
653
668
  */
654
669
  backupKeySharesToLocationRaw(requestParameters, initOverrides) {
@@ -683,6 +698,7 @@ class SDKApi extends BaseAPI {
683
698
  });
684
699
  }
685
700
  /**
701
+ * Records a backup action and event for the specified location without performing the actual backup.
686
702
  * Create backup action and event for a specified location without performing actual backup
687
703
  */
688
704
  backupKeySharesToLocation(requestParameters, initOverrides) {
@@ -722,6 +738,7 @@ class SDKApi extends BaseAPI {
722
738
  });
723
739
  }
724
740
  /**
741
+ * Records backup actions and events for multiple locations without performing the actual backups.
725
742
  * Create backup action and event for multiple locations without performing actual backup
726
743
  */
727
744
  backupKeySharesToLocationsRaw(requestParameters, initOverrides) {
@@ -756,6 +773,7 @@ class SDKApi extends BaseAPI {
756
773
  });
757
774
  }
758
775
  /**
776
+ * Records backup actions and events for multiple locations without performing the actual backups.
759
777
  * Create backup action and event for multiple locations without performing actual backup
760
778
  */
761
779
  backupKeySharesToLocations(requestParameters, initOverrides) {
@@ -796,7 +814,7 @@ class SDKApi extends BaseAPI {
796
814
  }
797
815
  /**
798
816
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
799
- * Redirect URL for sign-in with coinbase
817
+ * Handle Coinbase OAuth redirect
800
818
  */
801
819
  cbOauthRedirectRaw(requestParameters, initOverrides) {
802
820
  return __awaiter(this, void 0, void 0, function* () {
@@ -834,7 +852,7 @@ class SDKApi extends BaseAPI {
834
852
  }
835
853
  /**
836
854
  * This endpoint proxies requests to `/sdk/{environmentId}/providers/coinbasesocial/redirect` because Coinbase does not allow the string `coinbase` on the redirect URL path
837
- * Redirect URL for sign-in with coinbase
855
+ * Handle Coinbase OAuth redirect
838
856
  */
839
857
  cbOauthRedirect(requestParameters, initOverrides) {
840
858
  return __awaiter(this, void 0, void 0, function* () {
@@ -981,6 +999,7 @@ class SDKApi extends BaseAPI {
981
999
  });
982
1000
  }
983
1001
  /**
1002
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
984
1003
  * Claim a pregenerated embedded wallet
985
1004
  */
986
1005
  claimEmbeddedWalletRaw(requestParameters, initOverrides) {
@@ -1012,6 +1031,7 @@ class SDKApi extends BaseAPI {
1012
1031
  });
1013
1032
  }
1014
1033
  /**
1034
+ * Claims a pregenerated embedded wallet and associates it with the authenticated user.
1015
1035
  * Claim a pregenerated embedded wallet
1016
1036
  */
1017
1037
  claimEmbeddedWallet(requestParameters, initOverrides) {
@@ -1130,7 +1150,7 @@ class SDKApi extends BaseAPI {
1130
1150
  }
1131
1151
  /**
1132
1152
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1133
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1153
+ * Complete passkey recovery for an embedded wallet
1134
1154
  */
1135
1155
  completePasskeyRecoveryRaw(requestParameters, initOverrides) {
1136
1156
  return __awaiter(this, void 0, void 0, function* () {
@@ -1162,7 +1182,7 @@ class SDKApi extends BaseAPI {
1162
1182
  }
1163
1183
  /**
1164
1184
  * Completes the passkey recovery process for a user\'s passkey embedded wallet
1165
- * Completes the passkey recovery process for a user\'s passkey embedded wallet
1185
+ * Complete passkey recovery for an embedded wallet
1166
1186
  */
1167
1187
  completePasskeyRecovery(requestParameters, initOverrides) {
1168
1188
  return __awaiter(this, void 0, void 0, function* () {
@@ -1171,6 +1191,7 @@ class SDKApi extends BaseAPI {
1171
1191
  });
1172
1192
  }
1173
1193
  /**
1194
+ * Creates a new Coinbase onramp order for the authenticated user.
1174
1195
  * Create a Coinbase onramp order
1175
1196
  */
1176
1197
  createCoinbaseOnrampOrderRaw(requestParameters, initOverrides) {
@@ -1202,6 +1223,7 @@ class SDKApi extends BaseAPI {
1202
1223
  });
1203
1224
  }
1204
1225
  /**
1226
+ * Creates a new Coinbase onramp order for the authenticated user.
1205
1227
  * Create a Coinbase onramp order
1206
1228
  */
1207
1229
  createCoinbaseOnrampOrder(requestParameters, initOverrides) {
@@ -1253,6 +1275,7 @@ class SDKApi extends BaseAPI {
1253
1275
  });
1254
1276
  }
1255
1277
  /**
1278
+ * Initiates the email verification process and sends a verification code.
1256
1279
  * Initialize email verification process
1257
1280
  */
1258
1281
  createEmailVerificationRaw(requestParameters, initOverrides) {
@@ -1277,6 +1300,7 @@ class SDKApi extends BaseAPI {
1277
1300
  });
1278
1301
  }
1279
1302
  /**
1303
+ * Initiates the email verification process and sends a verification code.
1280
1304
  * Initialize email verification process
1281
1305
  */
1282
1306
  createEmailVerification(requestParameters, initOverrides) {
@@ -1382,7 +1406,8 @@ class SDKApi extends BaseAPI {
1382
1406
  });
1383
1407
  }
1384
1408
  /**
1385
- * Track a global wallet connection
1409
+ * Creates a new global wallet connection for the authenticated user.
1410
+ * Create a global wallet connection
1386
1411
  */
1387
1412
  createGlobalWalletConnectionRaw(requestParameters, initOverrides) {
1388
1413
  return __awaiter(this, void 0, void 0, function* () {
@@ -1413,7 +1438,8 @@ class SDKApi extends BaseAPI {
1413
1438
  });
1414
1439
  }
1415
1440
  /**
1416
- * Track a global wallet connection
1441
+ * Creates a new global wallet connection for the authenticated user.
1442
+ * Create a global wallet connection
1417
1443
  */
1418
1444
  createGlobalWalletConnection(requestParameters, initOverrides) {
1419
1445
  return __awaiter(this, void 0, void 0, function* () {
@@ -1422,7 +1448,8 @@ class SDKApi extends BaseAPI {
1422
1448
  });
1423
1449
  }
1424
1450
  /**
1425
- * Generate new recovery codes for user
1451
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1452
+ * Generate new recovery codes
1426
1453
  */
1427
1454
  createNewRecoveryCodesRaw(requestParameters, initOverrides) {
1428
1455
  return __awaiter(this, void 0, void 0, function* () {
@@ -1448,7 +1475,8 @@ class SDKApi extends BaseAPI {
1448
1475
  });
1449
1476
  }
1450
1477
  /**
1451
- * Generate new recovery codes for user
1478
+ * Generates a new set of MFA recovery codes, replacing any existing ones.
1479
+ * Generate new recovery codes
1452
1480
  */
1453
1481
  createNewRecoveryCodes(requestParameters, initOverrides) {
1454
1482
  return __awaiter(this, void 0, void 0, function* () {
@@ -1457,6 +1485,7 @@ class SDKApi extends BaseAPI {
1457
1485
  });
1458
1486
  }
1459
1487
  /**
1488
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1460
1489
  * Create rooms for a waas mpc ceremony
1461
1490
  */
1462
1491
  createRoomsRaw(requestParameters, initOverrides) {
@@ -1491,6 +1520,7 @@ class SDKApi extends BaseAPI {
1491
1520
  });
1492
1521
  }
1493
1522
  /**
1523
+ * Creates MPC ceremony rooms for the specified WAAS wallet.
1494
1524
  * Create rooms for a waas mpc ceremony
1495
1525
  */
1496
1526
  createRooms(requestParameters, initOverrides) {
@@ -1530,6 +1560,7 @@ class SDKApi extends BaseAPI {
1530
1560
  });
1531
1561
  }
1532
1562
  /**
1563
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1533
1564
  * Create rooms for a waas mpc ceremony without a walletId
1534
1565
  */
1535
1566
  createRoomsWithoutWalletIdRaw(requestParameters, initOverrides) {
@@ -1561,6 +1592,7 @@ class SDKApi extends BaseAPI {
1561
1592
  });
1562
1593
  }
1563
1594
  /**
1595
+ * Creates MPC ceremony rooms without requiring an existing wallet ID.
1564
1596
  * Create rooms for a waas mpc ceremony without a walletId
1565
1597
  */
1566
1598
  createRoomsWithoutWalletId(requestParameters, initOverrides) {
@@ -1597,7 +1629,8 @@ class SDKApi extends BaseAPI {
1597
1629
  });
1598
1630
  }
1599
1631
  /**
1600
- * Initialize sms verification process
1632
+ * Initiates the SMS verification process and sends a verification code.
1633
+ * Initialize SMS verification process
1601
1634
  */
1602
1635
  createSmsVerificationRaw(requestParameters, initOverrides) {
1603
1636
  return __awaiter(this, void 0, void 0, function* () {
@@ -1621,7 +1654,8 @@ class SDKApi extends BaseAPI {
1621
1654
  });
1622
1655
  }
1623
1656
  /**
1624
- * Initialize sms verification process
1657
+ * Initiates the SMS verification process and sends a verification code.
1658
+ * Initialize SMS verification process
1625
1659
  */
1626
1660
  createSmsVerification(requestParameters, initOverrides) {
1627
1661
  return __awaiter(this, void 0, void 0, function* () {
@@ -1692,7 +1726,7 @@ class SDKApi extends BaseAPI {
1692
1726
  }
1693
1727
  /**
1694
1728
  * Create a new waas account
1695
- * Create a new waas account
1729
+ * Create a WAAS wallet
1696
1730
  */
1697
1731
  createWaasAccountRaw(requestParameters, initOverrides) {
1698
1732
  return __awaiter(this, void 0, void 0, function* () {
@@ -1724,7 +1758,7 @@ class SDKApi extends BaseAPI {
1724
1758
  }
1725
1759
  /**
1726
1760
  * Create a new waas account
1727
- * Create a new waas account
1761
+ * Create a WAAS wallet
1728
1762
  */
1729
1763
  createWaasAccount(requestParameters, initOverrides) {
1730
1764
  return __awaiter(this, void 0, void 0, function* () {
@@ -1830,7 +1864,7 @@ class SDKApi extends BaseAPI {
1830
1864
  }
1831
1865
  /**
1832
1866
  * Deletes the embedded wallets for a user
1833
- * Deletes the embedded wallets for a user
1867
+ * Delete embedded wallets for a user
1834
1868
  */
1835
1869
  deleteEmbeddedWalletsRaw(requestParameters, initOverrides) {
1836
1870
  return __awaiter(this, void 0, void 0, function* () {
@@ -1859,7 +1893,7 @@ class SDKApi extends BaseAPI {
1859
1893
  }
1860
1894
  /**
1861
1895
  * Deletes the embedded wallets for a user
1862
- * Deletes the embedded wallets for a user
1896
+ * Delete embedded wallets for a user
1863
1897
  */
1864
1898
  deleteEmbeddedWallets(requestParameters, initOverrides) {
1865
1899
  return __awaiter(this, void 0, void 0, function* () {
@@ -1867,7 +1901,8 @@ class SDKApi extends BaseAPI {
1867
1901
  });
1868
1902
  }
1869
1903
  /**
1870
- * Delete a device (if not default device)
1904
+ * Permanently removes an MFA device from the authenticated user account.
1905
+ * Delete an MFA device
1871
1906
  */
1872
1907
  deleteMfaDeviceRaw(requestParameters, initOverrides) {
1873
1908
  return __awaiter(this, void 0, void 0, function* () {
@@ -1902,7 +1937,8 @@ class SDKApi extends BaseAPI {
1902
1937
  });
1903
1938
  }
1904
1939
  /**
1905
- * Delete a device (if not default device)
1940
+ * Permanently removes an MFA device from the authenticated user account.
1941
+ * Delete an MFA device
1906
1942
  */
1907
1943
  deleteMfaDevice(requestParameters, initOverrides) {
1908
1944
  return __awaiter(this, void 0, void 0, function* () {
@@ -1910,6 +1946,7 @@ class SDKApi extends BaseAPI {
1910
1946
  });
1911
1947
  }
1912
1948
  /**
1949
+ * Permanently removes a passkey from the authenticated user account.
1913
1950
  * Delete a passkey
1914
1951
  */
1915
1952
  deletePasskeyRaw(requestParameters, initOverrides) {
@@ -1941,6 +1978,7 @@ class SDKApi extends BaseAPI {
1941
1978
  });
1942
1979
  }
1943
1980
  /**
1981
+ * Permanently removes a passkey from the authenticated user account.
1944
1982
  * Delete a passkey
1945
1983
  */
1946
1984
  deletePasskey(requestParameters, initOverrides) {
@@ -2024,7 +2062,8 @@ class SDKApi extends BaseAPI {
2024
2062
  });
2025
2063
  }
2026
2064
  /**
2027
- * Set a global wallet connection as disconnected
2065
+ * Disconnects the specified global wallet connection.
2066
+ * Disconnect a global wallet connection
2028
2067
  */
2029
2068
  disconnectGlobalWalletConnectionRaw(requestParameters, initOverrides) {
2030
2069
  return __awaiter(this, void 0, void 0, function* () {
@@ -2053,7 +2092,8 @@ class SDKApi extends BaseAPI {
2053
2092
  });
2054
2093
  }
2055
2094
  /**
2056
- * Set a global wallet connection as disconnected
2095
+ * Disconnects the specified global wallet connection.
2096
+ * Disconnect a global wallet connection
2057
2097
  */
2058
2098
  disconnectGlobalWalletConnection(requestParameters, initOverrides) {
2059
2099
  return __awaiter(this, void 0, void 0, function* () {
@@ -2251,6 +2291,87 @@ class SDKApi extends BaseAPI {
2251
2291
  yield this.embeddedWalletExportOptionsRaw(requestParameters, initOverrides);
2252
2292
  });
2253
2293
  }
2294
+ /**
2295
+ * Estimates the gas fees for a given raw transaction.
2296
+ * Estimate transaction fees
2297
+ */
2298
+ estimateTransactionFeeRaw(requestParameters, initOverrides) {
2299
+ return __awaiter(this, void 0, void 0, function* () {
2300
+ if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
2301
+ throw new RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling estimateTransactionFee.');
2302
+ }
2303
+ if (requestParameters.chainName === null || requestParameters.chainName === undefined) {
2304
+ throw new RequiredError('chainName', 'Required parameter requestParameters.chainName was null or undefined when calling estimateTransactionFee.');
2305
+ }
2306
+ if (requestParameters.inlineObject === null || requestParameters.inlineObject === undefined) {
2307
+ throw new RequiredError('inlineObject', 'Required parameter requestParameters.inlineObject was null or undefined when calling estimateTransactionFee.');
2308
+ }
2309
+ const queryParameters = {};
2310
+ const headerParameters = {};
2311
+ headerParameters['Content-Type'] = 'application/json';
2312
+ if (this.configuration && this.configuration.accessToken) {
2313
+ const token = this.configuration.accessToken;
2314
+ const tokenString = yield token("bearerAuth", []);
2315
+ if (tokenString) {
2316
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
2317
+ }
2318
+ }
2319
+ const response = yield this.request({
2320
+ path: `/sdk/{environmentId}/chains/{chainName}/transactions/estimate`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))).replace(`{${"chainName"}}`, encodeURIComponent(String(requestParameters.chainName))),
2321
+ method: 'POST',
2322
+ headers: headerParameters,
2323
+ query: queryParameters,
2324
+ body: InlineObjectToJSON(requestParameters.inlineObject),
2325
+ }, initOverrides);
2326
+ return new JSONApiResponse(response, (jsonValue) => TransactionFeeEstimateResponseFromJSON(jsonValue));
2327
+ });
2328
+ }
2329
+ /**
2330
+ * Estimates the gas fees for a given raw transaction.
2331
+ * Estimate transaction fees
2332
+ */
2333
+ estimateTransactionFee(requestParameters, initOverrides) {
2334
+ return __awaiter(this, void 0, void 0, function* () {
2335
+ const response = yield this.estimateTransactionFeeRaw(requestParameters, initOverrides);
2336
+ return yield response.value();
2337
+ });
2338
+ }
2339
+ /**
2340
+ * Options call for this endpoint
2341
+ */
2342
+ estimateTransactionFeeOptionsRaw(requestParameters, initOverrides) {
2343
+ return __awaiter(this, void 0, void 0, function* () {
2344
+ if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
2345
+ throw new RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling estimateTransactionFeeOptions.');
2346
+ }
2347
+ if (requestParameters.chainName === null || requestParameters.chainName === undefined) {
2348
+ throw new RequiredError('chainName', 'Required parameter requestParameters.chainName was null or undefined when calling estimateTransactionFeeOptions.');
2349
+ }
2350
+ if (requestParameters.networkId === null || requestParameters.networkId === undefined) {
2351
+ throw new RequiredError('networkId', 'Required parameter requestParameters.networkId was null or undefined when calling estimateTransactionFeeOptions.');
2352
+ }
2353
+ const queryParameters = {};
2354
+ if (requestParameters.networkId !== undefined) {
2355
+ queryParameters['networkId'] = requestParameters.networkId;
2356
+ }
2357
+ const headerParameters = {};
2358
+ const response = yield this.request({
2359
+ path: `/sdk/{environmentId}/chains/{chainName}/transactions/estimate`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))).replace(`{${"chainName"}}`, encodeURIComponent(String(requestParameters.chainName))),
2360
+ method: 'OPTIONS',
2361
+ headers: headerParameters,
2362
+ query: queryParameters,
2363
+ }, initOverrides);
2364
+ return new VoidApiResponse(response);
2365
+ });
2366
+ }
2367
+ /**
2368
+ * Options call for this endpoint
2369
+ */
2370
+ estimateTransactionFeeOptions(requestParameters, initOverrides) {
2371
+ return __awaiter(this, void 0, void 0, function* () {
2372
+ yield this.estimateTransactionFeeOptionsRaw(requestParameters, initOverrides);
2373
+ });
2374
+ }
2254
2375
  /**
2255
2376
  */
2256
2377
  eventsOptionsRaw(requestParameters, initOverrides) {
@@ -2277,7 +2398,8 @@ class SDKApi extends BaseAPI {
2277
2398
  });
2278
2399
  }
2279
2400
  /**
2280
- * Export private Key of a waas account
2401
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
2402
+ * Export a WAAS wallet private key
2281
2403
  */
2282
2404
  exportPrivateKeyRaw(requestParameters, initOverrides) {
2283
2405
  return __awaiter(this, void 0, void 0, function* () {
@@ -2311,7 +2433,8 @@ class SDKApi extends BaseAPI {
2311
2433
  });
2312
2434
  }
2313
2435
  /**
2314
- * Export private Key of a waas account
2436
+ * Exports the private key of a WAAS wallet through an MPC ceremony.
2437
+ * Export a WAAS wallet private key
2315
2438
  */
2316
2439
  exportPrivateKey(requestParameters, initOverrides) {
2317
2440
  return __awaiter(this, void 0, void 0, function* () {
@@ -2350,7 +2473,8 @@ class SDKApi extends BaseAPI {
2350
2473
  });
2351
2474
  }
2352
2475
  /**
2353
- * Endpoint to sign-in using a token issued by an external auth provider
2476
+ * Authenticates a user using a token from an external auth provider.
2477
+ * Sign in with an external auth provider token
2354
2478
  */
2355
2479
  externalAuthSigninRaw(requestParameters, initOverrides) {
2356
2480
  return __awaiter(this, void 0, void 0, function* () {
@@ -2381,7 +2505,8 @@ class SDKApi extends BaseAPI {
2381
2505
  });
2382
2506
  }
2383
2507
  /**
2384
- * Endpoint to sign-in using a token issued by an external auth provider
2508
+ * Authenticates a user using a token from an external auth provider.
2509
+ * Sign in with an external auth provider token
2385
2510
  */
2386
2511
  externalAuthSignin(requestParameters, initOverrides) {
2387
2512
  return __awaiter(this, void 0, void 0, function* () {
@@ -2417,6 +2542,7 @@ class SDKApi extends BaseAPI {
2417
2542
  });
2418
2543
  }
2419
2544
  /**
2545
+ * [DEPRECATED] Please use /externalAuth/signin instead.
2420
2546
  * [DEPRECATED] Please use /externalAuth/signin instead
2421
2547
  */
2422
2548
  externalAuthVerifyRaw(requestParameters, initOverrides) {
@@ -2448,6 +2574,7 @@ class SDKApi extends BaseAPI {
2448
2574
  });
2449
2575
  }
2450
2576
  /**
2577
+ * [DEPRECATED] Please use /externalAuth/signin instead.
2451
2578
  * [DEPRECATED] Please use /externalAuth/signin instead
2452
2579
  */
2453
2580
  externalAuthVerify(requestParameters, initOverrides) {
@@ -2484,7 +2611,7 @@ class SDKApi extends BaseAPI {
2484
2611
  }
2485
2612
  /**
2486
2613
  * Farcaster SignIn endpoint to exchange SIWF data
2487
- * Farcaster provider SignIn endpoint
2614
+ * Sign in with Farcaster
2488
2615
  */
2489
2616
  farcasterSignInRaw(requestParameters, initOverrides) {
2490
2617
  return __awaiter(this, void 0, void 0, function* () {
@@ -2506,7 +2633,7 @@ class SDKApi extends BaseAPI {
2506
2633
  }
2507
2634
  /**
2508
2635
  * Farcaster SignIn endpoint to exchange SIWF data
2509
- * Farcaster provider SignIn endpoint
2636
+ * Sign in with Farcaster
2510
2637
  */
2511
2638
  farcasterSignIn(requestParameters, initOverrides) {
2512
2639
  return __awaiter(this, void 0, void 0, function* () {
@@ -2543,7 +2670,7 @@ class SDKApi extends BaseAPI {
2543
2670
  }
2544
2671
  /**
2545
2672
  * Farcaster Verify endpoint to exchange SIWF data
2546
- * Farcaster provider Verify endpoint
2673
+ * Verify Farcaster account linking
2547
2674
  */
2548
2675
  farcasterVerifyRaw(requestParameters, initOverrides) {
2549
2676
  return __awaiter(this, void 0, void 0, function* () {
@@ -2572,7 +2699,7 @@ class SDKApi extends BaseAPI {
2572
2699
  }
2573
2700
  /**
2574
2701
  * Farcaster Verify endpoint to exchange SIWF data
2575
- * Farcaster provider Verify endpoint
2702
+ * Verify Farcaster account linking
2576
2703
  */
2577
2704
  farcasterVerify(requestParameters, initOverrides) {
2578
2705
  return __awaiter(this, void 0, void 0, function* () {
@@ -2608,6 +2735,7 @@ class SDKApi extends BaseAPI {
2608
2735
  });
2609
2736
  }
2610
2737
  /**
2738
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
2611
2739
  * Generate a Coinbase onramp buy URL
2612
2740
  */
2613
2741
  generateCoinbaseOnrampBuyUrlRaw(requestParameters, initOverrides) {
@@ -2632,6 +2760,7 @@ class SDKApi extends BaseAPI {
2632
2760
  });
2633
2761
  }
2634
2762
  /**
2763
+ * Generates a Coinbase onramp buy URL for purchasing crypto.
2635
2764
  * Generate a Coinbase onramp buy URL
2636
2765
  */
2637
2766
  generateCoinbaseOnrampBuyUrl(requestParameters, initOverrides) {
@@ -2641,7 +2770,8 @@ class SDKApi extends BaseAPI {
2641
2770
  });
2642
2771
  }
2643
2772
  /**
2644
- * Get the token balances for an account
2773
+ * Returns the token balances for a specific account address on a given chain.
2774
+ * Get token balances for an account
2645
2775
  */
2646
2776
  getAccountBalancesRaw(requestParameters, initOverrides) {
2647
2777
  return __awaiter(this, void 0, void 0, function* () {
@@ -2687,7 +2817,8 @@ class SDKApi extends BaseAPI {
2687
2817
  });
2688
2818
  }
2689
2819
  /**
2690
- * Get the token balances for an account
2820
+ * Returns the token balances for a specific account address on a given chain.
2821
+ * Get token balances for an account
2691
2822
  */
2692
2823
  getAccountBalances(requestParameters, initOverrides) {
2693
2824
  return __awaiter(this, void 0, void 0, function* () {
@@ -2741,7 +2872,8 @@ class SDKApi extends BaseAPI {
2741
2872
  });
2742
2873
  }
2743
2874
  /**
2744
- * Get auth token for given embedded wallet type
2875
+ * Returns an auth token for the specified embedded wallet type.
2876
+ * Get an auth token for an embedded wallet type
2745
2877
  */
2746
2878
  getAuthTokenRaw(requestParameters, initOverrides) {
2747
2879
  return __awaiter(this, void 0, void 0, function* () {
@@ -2770,7 +2902,8 @@ class SDKApi extends BaseAPI {
2770
2902
  });
2771
2903
  }
2772
2904
  /**
2773
- * Get auth token for given embedded wallet type
2905
+ * Returns an auth token for the specified embedded wallet type.
2906
+ * Get an auth token for an embedded wallet type
2774
2907
  */
2775
2908
  getAuthToken(requestParameters, initOverrides) {
2776
2909
  return __awaiter(this, void 0, void 0, function* () {
@@ -2806,7 +2939,8 @@ class SDKApi extends BaseAPI {
2806
2939
  });
2807
2940
  }
2808
2941
  /**
2809
- * Fetch user profile for the current authenticated user
2942
+ * Returns the full profile of the currently authenticated user.
2943
+ * Get the current user\'s profile
2810
2944
  */
2811
2945
  getAuthenticatedUserRaw(requestParameters, initOverrides) {
2812
2946
  return __awaiter(this, void 0, void 0, function* () {
@@ -2832,7 +2966,8 @@ class SDKApi extends BaseAPI {
2832
2966
  });
2833
2967
  }
2834
2968
  /**
2835
- * Fetch user profile for the current authenticated user
2969
+ * Returns the full profile of the currently authenticated user.
2970
+ * Get the current user\'s profile
2836
2971
  */
2837
2972
  getAuthenticatedUser(requestParameters, initOverrides) {
2838
2973
  return __awaiter(this, void 0, void 0, function* () {
@@ -2929,7 +3064,7 @@ class SDKApi extends BaseAPI {
2929
3064
  }
2930
3065
  /**
2931
3066
  * Generates the request body for a user\'s create V2 wallet account request
2932
- * Generates the request body for a user\'s create V2 wallet account request
3067
+ * Generate the create wallet account request body
2933
3068
  */
2934
3069
  getCreateWalletAccountRequestRaw(requestParameters, initOverrides) {
2935
3070
  return __awaiter(this, void 0, void 0, function* () {
@@ -2962,7 +3097,7 @@ class SDKApi extends BaseAPI {
2962
3097
  }
2963
3098
  /**
2964
3099
  * Generates the request body for a user\'s create V2 wallet account request
2965
- * Generates the request body for a user\'s create V2 wallet account request
3100
+ * Generate the create wallet account request body
2966
3101
  */
2967
3102
  getCreateWalletAccountRequest(requestParameters, initOverrides) {
2968
3103
  return __awaiter(this, void 0, void 0, function* () {
@@ -2972,6 +3107,7 @@ class SDKApi extends BaseAPI {
2972
3107
  }
2973
3108
  /**
2974
3109
  * Exchange rates for the given currency
3110
+ * Get currency exchange rates
2975
3111
  */
2976
3112
  getCurrencyExchangeRatesRaw(requestParameters, initOverrides) {
2977
3113
  return __awaiter(this, void 0, void 0, function* () {
@@ -2991,6 +3127,7 @@ class SDKApi extends BaseAPI {
2991
3127
  }
2992
3128
  /**
2993
3129
  * Exchange rates for the given currency
3130
+ * Get currency exchange rates
2994
3131
  */
2995
3132
  getCurrencyExchangeRates(requestParameters, initOverrides) {
2996
3133
  return __awaiter(this, void 0, void 0, function* () {
@@ -3027,7 +3164,7 @@ class SDKApi extends BaseAPI {
3027
3164
  }
3028
3165
  /**
3029
3166
  * Return the email provider to be used for signing in with a given email. If an external provider such as magicLink is disabled, this endpoint would return emailOnly. If an external provider such as magicLink is enabled, it will return emailOnly when the email already exists in Dynamic and it is associated with a wallet, otherwise it will return magicLink.
3030
- * Get signin email provider
3167
+ * Get the sign-in email provider
3031
3168
  */
3032
3169
  getEmailProviderRaw(requestParameters, initOverrides) {
3033
3170
  return __awaiter(this, void 0, void 0, function* () {
@@ -3053,7 +3190,7 @@ class SDKApi extends BaseAPI {
3053
3190
  }
3054
3191
  /**
3055
3192
  * Return the email provider to be used for signing in with a given email. If an external provider such as magicLink is disabled, this endpoint would return emailOnly. If an external provider such as magicLink is enabled, it will return emailOnly when the email already exists in Dynamic and it is associated with a wallet, otherwise it will return magicLink.
3056
- * Get signin email provider
3193
+ * Get the sign-in email provider
3057
3194
  */
3058
3195
  getEmailProvider(requestParameters, initOverrides) {
3059
3196
  return __awaiter(this, void 0, void 0, function* () {
@@ -3089,7 +3226,8 @@ class SDKApi extends BaseAPI {
3089
3226
  });
3090
3227
  }
3091
3228
  /**
3092
- * Return the backup key for the embedded wallet of the authenticated user
3229
+ * Returns the backup key for an embedded wallet.
3230
+ * Get the backup key for an embedded wallet
3093
3231
  */
3094
3232
  getEmbeddedWalletBackupsRaw(requestParameters, initOverrides) {
3095
3233
  return __awaiter(this, void 0, void 0, function* () {
@@ -3115,7 +3253,8 @@ class SDKApi extends BaseAPI {
3115
3253
  });
3116
3254
  }
3117
3255
  /**
3118
- * Return the backup key for the embedded wallet of the authenticated user
3256
+ * Returns the backup key for an embedded wallet.
3257
+ * Get the backup key for an embedded wallet
3119
3258
  */
3120
3259
  getEmbeddedWalletBackups(requestParameters, initOverrides) {
3121
3260
  return __awaiter(this, void 0, void 0, function* () {
@@ -3124,7 +3263,8 @@ class SDKApi extends BaseAPI {
3124
3263
  });
3125
3264
  }
3126
3265
  /**
3127
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
3266
+ * Returns the passcode for a pregenerated embedded wallet.
3267
+ * Get the passcode for a pregenerated embedded wallet
3128
3268
  */
3129
3269
  getEmbeddedWalletPasscodeRaw(requestParameters, initOverrides) {
3130
3270
  return __awaiter(this, void 0, void 0, function* () {
@@ -3150,7 +3290,8 @@ class SDKApi extends BaseAPI {
3150
3290
  });
3151
3291
  }
3152
3292
  /**
3153
- * Return the passcode for the pregenerated embedded wallet of the authenticated user
3293
+ * Returns the passcode for a pregenerated embedded wallet.
3294
+ * Get the passcode for a pregenerated embedded wallet
3154
3295
  */
3155
3296
  getEmbeddedWalletPasscode(requestParameters, initOverrides) {
3156
3297
  return __awaiter(this, void 0, void 0, function* () {
@@ -3187,7 +3328,7 @@ class SDKApi extends BaseAPI {
3187
3328
  }
3188
3329
  /**
3189
3330
  * Generates the request body for a user\'s delete V2 wallets request
3190
- * Generates the request body for a user\'s delete V2 wallets request
3331
+ * Generate the delete wallets request body
3191
3332
  */
3192
3333
  getEmbeddedWalletsDeleteRequestRaw(requestParameters, initOverrides) {
3193
3334
  return __awaiter(this, void 0, void 0, function* () {
@@ -3217,7 +3358,7 @@ class SDKApi extends BaseAPI {
3217
3358
  }
3218
3359
  /**
3219
3360
  * Generates the request body for a user\'s delete V2 wallets request
3220
- * Generates the request body for a user\'s delete V2 wallets request
3361
+ * Generate the delete wallets request body
3221
3362
  */
3222
3363
  getEmbeddedWalletsDeleteRequest(requestParameters, initOverrides) {
3223
3364
  return __awaiter(this, void 0, void 0, function* () {
@@ -3226,6 +3367,7 @@ class SDKApi extends BaseAPI {
3226
3367
  });
3227
3368
  }
3228
3369
  /**
3370
+ * Returns the OAuth access token for the specified user OAuth account.
3229
3371
  * Get the access token for a user OAuth account
3230
3372
  */
3231
3373
  getEndUserOauthAccessTokenRaw(requestParameters, initOverrides) {
@@ -3248,6 +3390,7 @@ class SDKApi extends BaseAPI {
3248
3390
  });
3249
3391
  }
3250
3392
  /**
3393
+ * Returns the OAuth access token for the specified user OAuth account.
3251
3394
  * Get the access token for a user OAuth account
3252
3395
  */
3253
3396
  getEndUserOauthAccessToken(requestParameters, initOverrides) {
@@ -3287,7 +3430,8 @@ class SDKApi extends BaseAPI {
3287
3430
  });
3288
3431
  }
3289
3432
  /**
3290
- * Get the environment\'s settings
3433
+ * Returns the project settings and configuration for the specified environment.
3434
+ * Get environment settings
3291
3435
  */
3292
3436
  getEnvironmentSettingsRaw(requestParameters, initOverrides) {
3293
3437
  return __awaiter(this, void 0, void 0, function* () {
@@ -3309,7 +3453,8 @@ class SDKApi extends BaseAPI {
3309
3453
  });
3310
3454
  }
3311
3455
  /**
3312
- * Get the environment\'s settings
3456
+ * Returns the project settings and configuration for the specified environment.
3457
+ * Get environment settings
3313
3458
  */
3314
3459
  getEnvironmentSettings(requestParameters, initOverrides) {
3315
3460
  return __awaiter(this, void 0, void 0, function* () {
@@ -3318,6 +3463,7 @@ class SDKApi extends BaseAPI {
3318
3463
  });
3319
3464
  }
3320
3465
  /**
3466
+ * Returns the exchange account transactions for the authenticated user.
3321
3467
  * Get the exchange account transactions for a given dynamic user
3322
3468
  */
3323
3469
  getExchangeTransactionsRaw(requestParameters, initOverrides) {
@@ -3350,6 +3496,7 @@ class SDKApi extends BaseAPI {
3350
3496
  });
3351
3497
  }
3352
3498
  /**
3499
+ * Returns the exchange account transactions for the authenticated user.
3353
3500
  * Get the exchange account transactions for a given dynamic user
3354
3501
  */
3355
3502
  getExchangeTransactions(requestParameters, initOverrides) {
@@ -3389,6 +3536,7 @@ class SDKApi extends BaseAPI {
3389
3536
  });
3390
3537
  }
3391
3538
  /**
3539
+ * Returns the available transfer destinations for exchange account transactions.
3392
3540
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
3393
3541
  */
3394
3542
  getExchangeTransferDestinationsRaw(requestParameters, initOverrides) {
@@ -3418,6 +3566,7 @@ class SDKApi extends BaseAPI {
3418
3566
  });
3419
3567
  }
3420
3568
  /**
3569
+ * Returns the available transfer destinations for exchange account transactions.
3421
3570
  * Get the available exchange transfer destinations for account transactions for a given dynamic user
3422
3571
  */
3423
3572
  getExchangeTransferDestinations(requestParameters, initOverrides) {
@@ -3457,6 +3606,7 @@ class SDKApi extends BaseAPI {
3457
3606
  });
3458
3607
  }
3459
3608
  /**
3609
+ * Returns the global wallet settings configured for the specified environment.
3460
3610
  * Get the global wallet settings for the environment
3461
3611
  */
3462
3612
  getGlobalWalletsSettingsRaw(requestParameters, initOverrides) {
@@ -3476,6 +3626,7 @@ class SDKApi extends BaseAPI {
3476
3626
  });
3477
3627
  }
3478
3628
  /**
3629
+ * Returns the global wallet settings configured for the specified environment.
3479
3630
  * Get the global wallet settings for the environment
3480
3631
  */
3481
3632
  getGlobalWalletsSettings(requestParameters, initOverrides) {
@@ -3486,6 +3637,7 @@ class SDKApi extends BaseAPI {
3486
3637
  }
3487
3638
  /**
3488
3639
  * Health check endpoint to check for uptime of API.
3640
+ * Check API health
3489
3641
  */
3490
3642
  getHealthcheckRaw(requestParameters, initOverrides) {
3491
3643
  return __awaiter(this, void 0, void 0, function* () {
@@ -3505,6 +3657,7 @@ class SDKApi extends BaseAPI {
3505
3657
  }
3506
3658
  /**
3507
3659
  * Health check endpoint to check for uptime of API.
3660
+ * Check API health
3508
3661
  */
3509
3662
  getHealthcheck(requestParameters, initOverrides) {
3510
3663
  return __awaiter(this, void 0, void 0, function* () {
@@ -3540,7 +3693,8 @@ class SDKApi extends BaseAPI {
3540
3693
  });
3541
3694
  }
3542
3695
  /**
3543
- * Find jwks for public key
3696
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
3697
+ * Get JWKS for the environment
3544
3698
  */
3545
3699
  getJwksByEnvironmentIdRaw(requestParameters, initOverrides) {
3546
3700
  return __awaiter(this, void 0, void 0, function* () {
@@ -3559,7 +3713,8 @@ class SDKApi extends BaseAPI {
3559
3713
  });
3560
3714
  }
3561
3715
  /**
3562
- * Find jwks for public key
3716
+ * Returns the JSON Web Key Set (JWKS) for the specified environment.
3717
+ * Get JWKS for the environment
3563
3718
  */
3564
3719
  getJwksByEnvironmentId(requestParameters, initOverrides) {
3565
3720
  return __awaiter(this, void 0, void 0, function* () {
@@ -3568,7 +3723,8 @@ class SDKApi extends BaseAPI {
3568
3723
  });
3569
3724
  }
3570
3725
  /**
3571
- * Find jwks for public key (JSON format)
3726
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
3727
+ * Get JWKS for the environment (JSON format)
3572
3728
  */
3573
3729
  getJwksJsonByEnvironmentIdRaw(requestParameters, initOverrides) {
3574
3730
  return __awaiter(this, void 0, void 0, function* () {
@@ -3587,7 +3743,8 @@ class SDKApi extends BaseAPI {
3587
3743
  });
3588
3744
  }
3589
3745
  /**
3590
- * Find jwks for public key (JSON format)
3746
+ * Returns the JSON Web Key Set (JWKS) in JSON format for the specified environment.
3747
+ * Get JWKS for the environment (JSON format)
3591
3748
  */
3592
3749
  getJwksJsonByEnvironmentId(requestParameters, initOverrides) {
3593
3750
  return __awaiter(this, void 0, void 0, function* () {
@@ -3596,7 +3753,8 @@ class SDKApi extends BaseAPI {
3596
3753
  });
3597
3754
  }
3598
3755
  /**
3599
- * Get the current user\'s MFA by device id
3756
+ * Returns details of a specific MFA device by its ID.
3757
+ * Get an MFA device by ID
3600
3758
  */
3601
3759
  getMfaDeviceRaw(requestParameters, initOverrides) {
3602
3760
  return __awaiter(this, void 0, void 0, function* () {
@@ -3625,7 +3783,8 @@ class SDKApi extends BaseAPI {
3625
3783
  });
3626
3784
  }
3627
3785
  /**
3628
- * Get the current user\'s MFA by device id
3786
+ * Returns details of a specific MFA device by its ID.
3787
+ * Get an MFA device by ID
3629
3788
  */
3630
3789
  getMfaDevice(requestParameters, initOverrides) {
3631
3790
  return __awaiter(this, void 0, void 0, function* () {
@@ -3664,7 +3823,8 @@ class SDKApi extends BaseAPI {
3664
3823
  });
3665
3824
  }
3666
3825
  /**
3667
- * Find the configuration for the enabled networks associated to an environment
3826
+ * Returns the network configurations enabled for the specified environment.
3827
+ * Get network configurations for the environment
3668
3828
  */
3669
3829
  getNetworksConfigurationByEnvIdRaw(requestParameters, initOverrides) {
3670
3830
  return __awaiter(this, void 0, void 0, function* () {
@@ -3683,7 +3843,8 @@ class SDKApi extends BaseAPI {
3683
3843
  });
3684
3844
  }
3685
3845
  /**
3686
- * Find the configuration for the enabled networks associated to an environment
3846
+ * Returns the network configurations enabled for the specified environment.
3847
+ * Get network configurations for the environment
3687
3848
  */
3688
3849
  getNetworksConfigurationByEnvId(requestParameters, initOverrides) {
3689
3850
  return __awaiter(this, void 0, void 0, function* () {
@@ -3692,6 +3853,7 @@ class SDKApi extends BaseAPI {
3692
3853
  });
3693
3854
  }
3694
3855
  /**
3856
+ * Creates and returns a nonce for use in the wallet authentication flow.
3695
3857
  * Create nonce for authentication flow
3696
3858
  */
3697
3859
  getNonceRaw(requestParameters, initOverrides) {
@@ -3711,6 +3873,7 @@ class SDKApi extends BaseAPI {
3711
3873
  });
3712
3874
  }
3713
3875
  /**
3876
+ * Creates and returns a nonce for use in the wallet authentication flow.
3714
3877
  * Create nonce for authentication flow
3715
3878
  */
3716
3879
  getNonce(requestParameters, initOverrides) {
@@ -3720,7 +3883,8 @@ class SDKApi extends BaseAPI {
3720
3883
  });
3721
3884
  }
3722
3885
  /**
3723
- * Gets passkey authentication options
3886
+ * Returns the WebAuthn authentication options for passkey verification.
3887
+ * Get passkey authentication options
3724
3888
  */
3725
3889
  getPasskeyAuthenticationOptionsRaw(requestParameters, initOverrides) {
3726
3890
  return __awaiter(this, void 0, void 0, function* () {
@@ -3749,7 +3913,8 @@ class SDKApi extends BaseAPI {
3749
3913
  });
3750
3914
  }
3751
3915
  /**
3752
- * Gets passkey authentication options
3916
+ * Returns the WebAuthn authentication options for passkey verification.
3917
+ * Get passkey authentication options
3753
3918
  */
3754
3919
  getPasskeyAuthenticationOptions(requestParameters, initOverrides) {
3755
3920
  return __awaiter(this, void 0, void 0, function* () {
@@ -3788,7 +3953,8 @@ class SDKApi extends BaseAPI {
3788
3953
  });
3789
3954
  }
3790
3955
  /**
3791
- * Gets passkey authentication options
3956
+ * Returns the WebAuthn authentication options for passkey sign-in.
3957
+ * Get passkey sign-in options
3792
3958
  */
3793
3959
  getPasskeyAuthenticationSigninOptionsRaw(requestParameters, initOverrides) {
3794
3960
  return __awaiter(this, void 0, void 0, function* () {
@@ -3810,7 +3976,8 @@ class SDKApi extends BaseAPI {
3810
3976
  });
3811
3977
  }
3812
3978
  /**
3813
- * Gets passkey authentication options
3979
+ * Returns the WebAuthn authentication options for passkey sign-in.
3980
+ * Get passkey sign-in options
3814
3981
  */
3815
3982
  getPasskeyAuthenticationSigninOptions(requestParameters, initOverrides) {
3816
3983
  return __awaiter(this, void 0, void 0, function* () {
@@ -3819,7 +3986,8 @@ class SDKApi extends BaseAPI {
3819
3986
  });
3820
3987
  }
3821
3988
  /**
3822
- * Gets passkey data associated with a user
3989
+ * Returns the WebAuthn registration options needed to register a new passkey.
3990
+ * Get user passkeys
3823
3991
  */
3824
3992
  getPasskeyRegistrationOptionsRaw(requestParameters, initOverrides) {
3825
3993
  return __awaiter(this, void 0, void 0, function* () {
@@ -3838,7 +4006,8 @@ class SDKApi extends BaseAPI {
3838
4006
  });
3839
4007
  }
3840
4008
  /**
3841
- * Gets passkey data associated with a user
4009
+ * Returns the WebAuthn registration options needed to register a new passkey.
4010
+ * Get user passkeys
3842
4011
  */
3843
4012
  getPasskeyRegistrationOptions(requestParameters, initOverrides) {
3844
4013
  return __awaiter(this, void 0, void 0, function* () {
@@ -3874,6 +4043,7 @@ class SDKApi extends BaseAPI {
3874
4043
  });
3875
4044
  }
3876
4045
  /**
4046
+ * Returns the MFA recovery codes for the authenticated user.
3877
4047
  * Get recovery codes
3878
4048
  */
3879
4049
  getRecoveryCodesRaw(requestParameters, initOverrides) {
@@ -3900,6 +4070,7 @@ class SDKApi extends BaseAPI {
3900
4070
  });
3901
4071
  }
3902
4072
  /**
4073
+ * Returns the MFA recovery codes for the authenticated user.
3903
4074
  * Get recovery codes
3904
4075
  */
3905
4076
  getRecoveryCodes(requestParameters, initOverrides) {
@@ -3910,7 +4081,7 @@ class SDKApi extends BaseAPI {
3910
4081
  }
3911
4082
  /**
3912
4083
  * Find the configuration for the enabled offramps associated to an environment
3913
- * Configuration for enabled offramps
4084
+ * Get enabled offramps for the environment
3914
4085
  */
3915
4086
  getSupportedOfframpsRaw(requestParameters, initOverrides) {
3916
4087
  return __awaiter(this, void 0, void 0, function* () {
@@ -3948,7 +4119,7 @@ class SDKApi extends BaseAPI {
3948
4119
  }
3949
4120
  /**
3950
4121
  * Find the configuration for the enabled offramps associated to an environment
3951
- * Configuration for enabled offramps
4122
+ * Get enabled offramps for the environment
3952
4123
  */
3953
4124
  getSupportedOfframps(requestParameters, initOverrides) {
3954
4125
  return __awaiter(this, void 0, void 0, function* () {
@@ -3958,7 +4129,7 @@ class SDKApi extends BaseAPI {
3958
4129
  }
3959
4130
  /**
3960
4131
  * Find the configuration for the enabled onramps associated to an environment
3961
- * Configuration for enabled onramps
4132
+ * Get enabled onramps for the environment
3962
4133
  */
3963
4134
  getSupportedOnrampsRaw(requestParameters, initOverrides) {
3964
4135
  return __awaiter(this, void 0, void 0, function* () {
@@ -4008,7 +4179,7 @@ class SDKApi extends BaseAPI {
4008
4179
  }
4009
4180
  /**
4010
4181
  * Find the configuration for the enabled onramps associated to an environment
4011
- * Configuration for enabled onramps
4182
+ * Get enabled onramps for the environment
4012
4183
  */
4013
4184
  getSupportedOnramps(requestParameters, initOverrides) {
4014
4185
  return __awaiter(this, void 0, void 0, function* () {
@@ -4017,7 +4188,8 @@ class SDKApi extends BaseAPI {
4017
4188
  });
4018
4189
  }
4019
4190
  /**
4020
- * Get HTML with rendered Telegram login widget
4191
+ * Returns the HTML content for the Telegram login widget.
4192
+ * Get Telegram login widget HTML
4021
4193
  */
4022
4194
  getTelegramAuthRaw(requestParameters, initOverrides) {
4023
4195
  return __awaiter(this, void 0, void 0, function* () {
@@ -4042,7 +4214,8 @@ class SDKApi extends BaseAPI {
4042
4214
  });
4043
4215
  }
4044
4216
  /**
4045
- * Get HTML with rendered Telegram login widget
4217
+ * Returns the HTML content for the Telegram login widget.
4218
+ * Get Telegram login widget HTML
4046
4219
  */
4047
4220
  getTelegramAuth(requestParameters, initOverrides) {
4048
4221
  return __awaiter(this, void 0, void 0, function* () {
@@ -4051,6 +4224,7 @@ class SDKApi extends BaseAPI {
4051
4224
  });
4052
4225
  }
4053
4226
  /**
4227
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
4054
4228
  * Get the exchange accounts for a given dynamic user
4055
4229
  */
4056
4230
  getUserAccountsRaw(requestParameters, initOverrides) {
@@ -4086,6 +4260,7 @@ class SDKApi extends BaseAPI {
4086
4260
  });
4087
4261
  }
4088
4262
  /**
4263
+ * Returns the exchange accounts for the authenticated user on the specified exchange.
4089
4264
  * Get the exchange accounts for a given dynamic user
4090
4265
  */
4091
4266
  getUserAccounts(requestParameters, initOverrides) {
@@ -4192,7 +4367,8 @@ class SDKApi extends BaseAPI {
4192
4367
  });
4193
4368
  }
4194
4369
  /**
4195
- * Get the current user\'s MFA Devices
4370
+ * Returns the list of MFA devices registered for the authenticated user.
4371
+ * Get the current user\'s MFA devices
4196
4372
  */
4197
4373
  getUserMfaDevicesRaw(requestParameters, initOverrides) {
4198
4374
  return __awaiter(this, void 0, void 0, function* () {
@@ -4218,7 +4394,8 @@ class SDKApi extends BaseAPI {
4218
4394
  });
4219
4395
  }
4220
4396
  /**
4221
- * Get the current user\'s MFA Devices
4397
+ * Returns the list of MFA devices registered for the authenticated user.
4398
+ * Get the current user\'s MFA devices
4222
4399
  */
4223
4400
  getUserMfaDevices(requestParameters, initOverrides) {
4224
4401
  return __awaiter(this, void 0, void 0, function* () {
@@ -4227,7 +4404,8 @@ class SDKApi extends BaseAPI {
4227
4404
  });
4228
4405
  }
4229
4406
  /**
4230
- * Get the current user\'s MFA Methods
4407
+ * Returns the available MFA methods for the authenticated user.
4408
+ * Get the current user\'s MFA methods
4231
4409
  */
4232
4410
  getUserMfaMethodsRaw(requestParameters, initOverrides) {
4233
4411
  return __awaiter(this, void 0, void 0, function* () {
@@ -4256,7 +4434,8 @@ class SDKApi extends BaseAPI {
4256
4434
  });
4257
4435
  }
4258
4436
  /**
4259
- * Get the current user\'s MFA Methods
4437
+ * Returns the available MFA methods for the authenticated user.
4438
+ * Get the current user\'s MFA methods
4260
4439
  */
4261
4440
  getUserMfaMethods(requestParameters, initOverrides) {
4262
4441
  return __awaiter(this, void 0, void 0, function* () {
@@ -4265,7 +4444,8 @@ class SDKApi extends BaseAPI {
4265
4444
  });
4266
4445
  }
4267
4446
  /**
4268
- * Gets passkey data associated with a user
4447
+ * Returns the list of passkeys registered for the authenticated user.
4448
+ * Get user passkeys
4269
4449
  */
4270
4450
  getUserPasskeysRaw(requestParameters, initOverrides) {
4271
4451
  return __awaiter(this, void 0, void 0, function* () {
@@ -4291,7 +4471,8 @@ class SDKApi extends BaseAPI {
4291
4471
  });
4292
4472
  }
4293
4473
  /**
4294
- * Gets passkey data associated with a user
4474
+ * Returns the list of passkeys registered for the authenticated user.
4475
+ * Get user passkeys
4295
4476
  */
4296
4477
  getUserPasskeys(requestParameters, initOverrides) {
4297
4478
  return __awaiter(this, void 0, void 0, function* () {
@@ -4301,7 +4482,7 @@ class SDKApi extends BaseAPI {
4301
4482
  }
4302
4483
  /**
4303
4484
  * Fetches a single WaaS wallet and returns it with the same payload structure as the users endpoint. This endpoint returns user information along with verified credentials filtered to only include the specified WaaS wallet.
4304
- * Fetch a single WaaS wallet with verified credentials
4485
+ * Get a WAAS wallet by address
4305
4486
  */
4306
4487
  getWaasWalletWithVerifiedCredentialsRaw(requestParameters, initOverrides) {
4307
4488
  return __awaiter(this, void 0, void 0, function* () {
@@ -4331,7 +4512,7 @@ class SDKApi extends BaseAPI {
4331
4512
  }
4332
4513
  /**
4333
4514
  * Fetches a single WaaS wallet and returns it with the same payload structure as the users endpoint. This endpoint returns user information along with verified credentials filtered to only include the specified WaaS wallet.
4334
- * Fetch a single WaaS wallet with verified credentials
4515
+ * Get a WAAS wallet by address
4335
4516
  */
4336
4517
  getWaasWalletWithVerifiedCredentials(requestParameters, initOverrides) {
4337
4518
  return __awaiter(this, void 0, void 0, function* () {
@@ -4525,7 +4706,7 @@ class SDKApi extends BaseAPI {
4525
4706
  }
4526
4707
  /**
4527
4708
  * Hard delete the authenticated user
4528
- * Hard delete a user
4709
+ * Delete the current user
4529
4710
  */
4530
4711
  hardDeleteUserRaw(requestParameters, initOverrides) {
4531
4712
  return __awaiter(this, void 0, void 0, function* () {
@@ -4552,7 +4733,7 @@ class SDKApi extends BaseAPI {
4552
4733
  }
4553
4734
  /**
4554
4735
  * Hard delete the authenticated user
4555
- * Hard delete a user
4736
+ * Delete the current user
4556
4737
  */
4557
4738
  hardDeleteUser(requestParameters, initOverrides) {
4558
4739
  return __awaiter(this, void 0, void 0, function* () {
@@ -4561,7 +4742,7 @@ class SDKApi extends BaseAPI {
4561
4742
  }
4562
4743
  /**
4563
4744
  * Import a private key to create a waas account
4564
- * Import an existing private key to create a waas account
4745
+ * Import a private key to create a WAAS wallet
4565
4746
  */
4566
4747
  importPrivateKeyRaw(requestParameters, initOverrides) {
4567
4748
  return __awaiter(this, void 0, void 0, function* () {
@@ -4593,7 +4774,7 @@ class SDKApi extends BaseAPI {
4593
4774
  }
4594
4775
  /**
4595
4776
  * Import a private key to create a waas account
4596
- * Import an existing private key to create a waas account
4777
+ * Import a private key to create a WAAS wallet
4597
4778
  */
4598
4779
  importPrivateKey(requestParameters, initOverrides) {
4599
4780
  return __awaiter(this, void 0, void 0, function* () {
@@ -4630,7 +4811,7 @@ class SDKApi extends BaseAPI {
4630
4811
  }
4631
4812
  /**
4632
4813
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
4633
- * Initialize oauth auth sequence
4814
+ * Initialize an OAuth authentication sequence
4634
4815
  */
4635
4816
  initAuthRaw(requestParameters, initOverrides) {
4636
4817
  return __awaiter(this, void 0, void 0, function* () {
@@ -4658,7 +4839,7 @@ class SDKApi extends BaseAPI {
4658
4839
  }
4659
4840
  /**
4660
4841
  * This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.
4661
- * Initialize oauth auth sequence
4842
+ * Initialize an OAuth authentication sequence
4662
4843
  */
4663
4844
  initAuth(requestParameters, initOverrides) {
4664
4845
  return __awaiter(this, void 0, void 0, function* () {
@@ -4835,7 +5016,7 @@ class SDKApi extends BaseAPI {
4835
5016
  }
4836
5017
  /**
4837
5018
  * Generates the turnkey request body for a user\'s delete wallets request
4838
- * Generates the turnkey request body for a user\'s delete wallets request
5019
+ * Generate the delete wallets request body
4839
5020
  */
4840
5021
  legacyGetEmbeddedWalletsDeleteRequestRaw(requestParameters, initOverrides) {
4841
5022
  return __awaiter(this, void 0, void 0, function* () {
@@ -4862,7 +5043,7 @@ class SDKApi extends BaseAPI {
4862
5043
  }
4863
5044
  /**
4864
5045
  * Generates the turnkey request body for a user\'s delete wallets request
4865
- * Generates the turnkey request body for a user\'s delete wallets request
5046
+ * Generate the delete wallets request body
4866
5047
  */
4867
5048
  legacyGetEmbeddedWalletsDeleteRequest(requestParameters, initOverrides) {
4868
5049
  return __awaiter(this, void 0, void 0, function* () {
@@ -4928,7 +5109,8 @@ class SDKApi extends BaseAPI {
4928
5109
  });
4929
5110
  }
4930
5111
  /**
4931
- * Update SDK settings for a specific environment
5112
+ * Logs the SDK settings being used by the client for the environment.
5113
+ * Update SDK settings for the environment
4932
5114
  */
4933
5115
  logDynamicSdkSettingsRaw(requestParameters, initOverrides) {
4934
5116
  return __awaiter(this, void 0, void 0, function* () {
@@ -4952,7 +5134,8 @@ class SDKApi extends BaseAPI {
4952
5134
  });
4953
5135
  }
4954
5136
  /**
4955
- * Update SDK settings for a specific environment
5137
+ * Logs the SDK settings being used by the client for the environment.
5138
+ * Update SDK settings for the environment
4956
5139
  */
4957
5140
  logDynamicSdkSettings(requestParameters, initOverrides) {
4958
5141
  return __awaiter(this, void 0, void 0, function* () {
@@ -4961,7 +5144,7 @@ class SDKApi extends BaseAPI {
4961
5144
  }
4962
5145
  /**
4963
5146
  * Used to merge two owned accounts connected by email address
4964
- * After successful verification allow to merge two owned accounts
5147
+ * Merge two owned accounts
4965
5148
  */
4966
5149
  mergeUsersRaw(requestParameters, initOverrides) {
4967
5150
  return __awaiter(this, void 0, void 0, function* () {
@@ -4988,7 +5171,7 @@ class SDKApi extends BaseAPI {
4988
5171
  }
4989
5172
  /**
4990
5173
  * Used to merge two owned accounts connected by email address
4991
- * After successful verification allow to merge two owned accounts
5174
+ * Merge two owned accounts
4992
5175
  */
4993
5176
  mergeUsers(requestParameters, initOverrides) {
4994
5177
  return __awaiter(this, void 0, void 0, function* () {
@@ -5079,7 +5262,7 @@ class SDKApi extends BaseAPI {
5079
5262
  }
5080
5263
  /**
5081
5264
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
5082
- * Oauth provider authorization endpoint
5265
+ * Get OAuth provider authorization HTML
5083
5266
  */
5084
5267
  oauthAuthorizeHtmlRaw(requestParameters, initOverrides) {
5085
5268
  return __awaiter(this, void 0, void 0, function* () {
@@ -5111,7 +5294,7 @@ class SDKApi extends BaseAPI {
5111
5294
  }
5112
5295
  /**
5113
5296
  * Endpoint where an oauth provider would return authorization HTML used for mobile-friendly login, such as Apple ID with Touch ID on enabled devices.
5114
- * Oauth provider authorization endpoint
5297
+ * Get OAuth provider authorization HTML
5115
5298
  */
5116
5299
  oauthAuthorizeHtml(requestParameters, initOverrides) {
5117
5300
  return __awaiter(this, void 0, void 0, function* () {
@@ -5150,7 +5333,8 @@ class SDKApi extends BaseAPI {
5150
5333
  });
5151
5334
  }
5152
5335
  /**
5153
- * Get redirect URL for Oauth provider login
5336
+ * Redirects the user to the specified OAuth provider login page.
5337
+ * Redirect to OAuth provider login
5154
5338
  */
5155
5339
  oauthLoginRaw(requestParameters, initOverrides) {
5156
5340
  return __awaiter(this, void 0, void 0, function* () {
@@ -5172,7 +5356,8 @@ class SDKApi extends BaseAPI {
5172
5356
  });
5173
5357
  }
5174
5358
  /**
5175
- * Get redirect URL for Oauth provider login
5359
+ * Redirects the user to the specified OAuth provider login page.
5360
+ * Redirect to OAuth provider login
5176
5361
  */
5177
5362
  oauthLogin(requestParameters, initOverrides) {
5178
5363
  return __awaiter(this, void 0, void 0, function* () {
@@ -5210,7 +5395,8 @@ class SDKApi extends BaseAPI {
5210
5395
  });
5211
5396
  }
5212
5397
  /**
5213
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
5398
+ * Returns the login URL for the specified OAuth provider.
5399
+ * Get the OAuth provider login URL
5214
5400
  */
5215
5401
  oauthLoginUrlRaw(requestParameters, initOverrides) {
5216
5402
  return __awaiter(this, void 0, void 0, function* () {
@@ -5232,7 +5418,8 @@ class SDKApi extends BaseAPI {
5232
5418
  });
5233
5419
  }
5234
5420
  /**
5235
- * Get redirect URL for Oauth provider login. This will return a string that the SDK can manipulate before redirecting the browser to.
5421
+ * Returns the login URL for the specified OAuth provider.
5422
+ * Get the OAuth provider login URL
5236
5423
  */
5237
5424
  oauthLoginUrl(requestParameters, initOverrides) {
5238
5425
  return __awaiter(this, void 0, void 0, function* () {
@@ -5272,7 +5459,7 @@ class SDKApi extends BaseAPI {
5272
5459
  }
5273
5460
  /**
5274
5461
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5275
- * Oauth provider redirect endpoint for apple ID
5462
+ * Handle Apple ID OAuth redirect
5276
5463
  */
5277
5464
  oauthRedirectAppleRaw(requestParameters, initOverrides) {
5278
5465
  return __awaiter(this, void 0, void 0, function* () {
@@ -5314,7 +5501,7 @@ class SDKApi extends BaseAPI {
5314
5501
  }
5315
5502
  /**
5316
5503
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5317
- * Oauth provider redirect endpoint for apple ID
5504
+ * Handle Apple ID OAuth redirect
5318
5505
  */
5319
5506
  oauthRedirectApple(requestParameters, initOverrides) {
5320
5507
  return __awaiter(this, void 0, void 0, function* () {
@@ -5351,7 +5538,7 @@ class SDKApi extends BaseAPI {
5351
5538
  }
5352
5539
  /**
5353
5540
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5354
- * Oauth provider redirect endpoint
5541
+ * Handle OAuth provider redirect
5355
5542
  */
5356
5543
  oauthRedirectCodeRaw(requestParameters, initOverrides) {
5357
5544
  return __awaiter(this, void 0, void 0, function* () {
@@ -5392,7 +5579,7 @@ class SDKApi extends BaseAPI {
5392
5579
  }
5393
5580
  /**
5394
5581
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
5395
- * Oauth provider redirect endpoint
5582
+ * Handle OAuth provider redirect
5396
5583
  */
5397
5584
  oauthRedirectCode(requestParameters, initOverrides) {
5398
5585
  return __awaiter(this, void 0, void 0, function* () {
@@ -5431,7 +5618,8 @@ class SDKApi extends BaseAPI {
5431
5618
  });
5432
5619
  }
5433
5620
  /**
5434
- * Returns the authorization code or error retuned by oauth provider
5621
+ * Returns the OAuth authorization result for the given state.
5622
+ * Get the OAuth provider authorization result
5435
5623
  */
5436
5624
  oauthResultRaw(requestParameters, initOverrides) {
5437
5625
  return __awaiter(this, void 0, void 0, function* () {
@@ -5458,7 +5646,8 @@ class SDKApi extends BaseAPI {
5458
5646
  });
5459
5647
  }
5460
5648
  /**
5461
- * 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
5462
5651
  */
5463
5652
  oauthResult(requestParameters, initOverrides) {
5464
5653
  return __awaiter(this, void 0, void 0, function* () {
@@ -5497,8 +5686,8 @@ class SDKApi extends BaseAPI {
5497
5686
  });
5498
5687
  }
5499
5688
  /**
5500
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
5501
- * Oauth provider SignIn endpoint
5689
+ * Standard OAuth SignIn callback to exchange temporary code for oauth access and return a valid Dynamic JWT and user
5690
+ * Sign in with OAuth provider
5502
5691
  */
5503
5692
  oauthSignInRaw(requestParameters, initOverrides) {
5504
5693
  return __awaiter(this, void 0, void 0, function* () {
@@ -5525,8 +5714,8 @@ class SDKApi extends BaseAPI {
5525
5714
  });
5526
5715
  }
5527
5716
  /**
5528
- * Standard OAuth SignIn callback to exchange temproary code for oauth access and return a valid Dynamic JWT and user
5529
- * Oauth provider SignIn endpoint
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
5530
5719
  */
5531
5720
  oauthSignIn(requestParameters, initOverrides) {
5532
5721
  return __awaiter(this, void 0, void 0, function* () {
@@ -5565,8 +5754,8 @@ class SDKApi extends BaseAPI {
5565
5754
  });
5566
5755
  }
5567
5756
  /**
5568
- * Standard OAuth verify callback to exchange temproary code for oauth access
5569
- * Oauth provider verify endpoint
5757
+ * Standard OAuth verify callback to exchange temporary code for oauth access
5758
+ * Verify OAuth provider authorization
5570
5759
  */
5571
5760
  oauthVerifyRaw(requestParameters, initOverrides) {
5572
5761
  return __awaiter(this, void 0, void 0, function* () {
@@ -5593,8 +5782,8 @@ class SDKApi extends BaseAPI {
5593
5782
  });
5594
5783
  }
5595
5784
  /**
5596
- * Standard OAuth verify callback to exchange temproary code for oauth access
5597
- * Oauth provider verify endpoint
5785
+ * Standard OAuth verify callback to exchange temporary code for oauth access
5786
+ * Verify OAuth provider authorization
5598
5787
  */
5599
5788
  oauthVerify(requestParameters, initOverrides) {
5600
5789
  return __awaiter(this, void 0, void 0, function* () {
@@ -5687,6 +5876,7 @@ class SDKApi extends BaseAPI {
5687
5876
  });
5688
5877
  }
5689
5878
  /**
5879
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
5690
5880
  * Add fees to a Solana transaction
5691
5881
  */
5692
5882
  optimizeTransactionRaw(requestParameters, initOverrides) {
@@ -5711,6 +5901,7 @@ class SDKApi extends BaseAPI {
5711
5901
  });
5712
5902
  }
5713
5903
  /**
5904
+ * Adds priority fees and compute unit limits to a Solana transaction for optimization.
5714
5905
  * Add fees to a Solana transaction
5715
5906
  */
5716
5907
  optimizeTransaction(requestParameters, initOverrides) {
@@ -5801,6 +5992,7 @@ class SDKApi extends BaseAPI {
5801
5992
  });
5802
5993
  }
5803
5994
  /**
5995
+ * Transfers funds from an exchange account to an external address or another account.
5804
5996
  * Transfer funds from an exchange account to an external address or another Coinbase account
5805
5997
  */
5806
5998
  postExchangeAccountTransferRaw(requestParameters, initOverrides) {
@@ -5838,6 +6030,7 @@ class SDKApi extends BaseAPI {
5838
6030
  });
5839
6031
  }
5840
6032
  /**
6033
+ * Transfers funds from an exchange account to an external address or another account.
5841
6034
  * Transfer funds from an exchange account to an external address or another Coinbase account
5842
6035
  */
5843
6036
  postExchangeAccountTransfer(requestParameters, initOverrides) {
@@ -5880,6 +6073,7 @@ class SDKApi extends BaseAPI {
5880
6073
  });
5881
6074
  }
5882
6075
  /**
6076
+ * Returns token balances for multiple account addresses across different chains.
5883
6077
  * Get account balances for multiple addresses
5884
6078
  */
5885
6079
  postMultichainAccountBalancesRaw(requestParameters, initOverrides) {
@@ -5904,6 +6098,7 @@ class SDKApi extends BaseAPI {
5904
6098
  });
5905
6099
  }
5906
6100
  /**
6101
+ * Returns token balances for multiple account addresses across different chains.
5907
6102
  * Get account balances for multiple addresses
5908
6103
  */
5909
6104
  postMultichainAccountBalances(requestParameters, initOverrides) {
@@ -5945,6 +6140,7 @@ class SDKApi extends BaseAPI {
5945
6140
  });
5946
6141
  }
5947
6142
  /**
6143
+ * Handles the Telegram authentication callback after user authorization.
5948
6144
  * Handle Telegram authentication
5949
6145
  */
5950
6146
  postTelegramAuthRaw(requestParameters, initOverrides) {
@@ -5969,6 +6165,7 @@ class SDKApi extends BaseAPI {
5969
6165
  });
5970
6166
  }
5971
6167
  /**
6168
+ * Handles the Telegram authentication callback after user authorization.
5972
6169
  * Handle Telegram authentication
5973
6170
  */
5974
6171
  postTelegramAuth(requestParameters, initOverrides) {
@@ -5978,7 +6175,7 @@ class SDKApi extends BaseAPI {
5978
6175
  }
5979
6176
  /**
5980
6177
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
5981
- * prefetch information for wallet address
6178
+ * Prefetch information for a wallet address
5982
6179
  */
5983
6180
  prefetchRaw(requestParameters, initOverrides) {
5984
6181
  return __awaiter(this, void 0, void 0, function* () {
@@ -6003,7 +6200,7 @@ class SDKApi extends BaseAPI {
6003
6200
  }
6004
6201
  /**
6005
6202
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
6006
- * prefetch information for wallet address
6203
+ * Prefetch information for a wallet address
6007
6204
  */
6008
6205
  prefetch(requestParameters, initOverrides) {
6009
6206
  return __awaiter(this, void 0, void 0, function* () {
@@ -6011,7 +6208,8 @@ class SDKApi extends BaseAPI {
6011
6208
  });
6012
6209
  }
6013
6210
  /**
6014
- * Publish events for SDK
6211
+ * Publishes SDK analytics events for the given environment.
6212
+ * Publish SDK events
6015
6213
  */
6016
6214
  publishEventRaw(requestParameters, initOverrides) {
6017
6215
  return __awaiter(this, void 0, void 0, function* () {
@@ -6035,7 +6233,8 @@ class SDKApi extends BaseAPI {
6035
6233
  });
6036
6234
  }
6037
6235
  /**
6038
- * Publish events for SDK
6236
+ * Publishes SDK analytics events for the given environment.
6237
+ * Publish SDK events
6039
6238
  */
6040
6239
  publishEvent(requestParameters, initOverrides) {
6041
6240
  return __awaiter(this, void 0, void 0, function* () {
@@ -6043,7 +6242,8 @@ class SDKApi extends BaseAPI {
6043
6242
  });
6044
6243
  }
6045
6244
  /**
6046
- * Recover multiple keyShares
6245
+ * Recovers the client key shares for the specified WAAS wallet from backup.
6246
+ * Recover WAAS keyshares
6047
6247
  */
6048
6248
  recoverKeySharesRaw(requestParameters, initOverrides) {
6049
6249
  return __awaiter(this, void 0, void 0, function* () {
@@ -6074,7 +6274,8 @@ class SDKApi extends BaseAPI {
6074
6274
  });
6075
6275
  }
6076
6276
  /**
6077
- * Recover multiple keyShares
6277
+ * Recovers the client key shares for the specified WAAS wallet from backup.
6278
+ * Recover WAAS keyshares
6078
6279
  */
6079
6280
  recoverKeyShares(requestParameters, initOverrides) {
6080
6281
  return __awaiter(this, void 0, void 0, function* () {
@@ -6167,7 +6368,8 @@ class SDKApi extends BaseAPI {
6167
6368
  });
6168
6369
  }
6169
6370
  /**
6170
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
6371
+ * Refreshes the JWT auth token and returns a new token with updated claims.
6372
+ * Refresh the JWT auth token
6171
6373
  */
6172
6374
  refreshAuthRaw(requestParameters, initOverrides) {
6173
6375
  return __awaiter(this, void 0, void 0, function* () {
@@ -6193,7 +6395,8 @@ class SDKApi extends BaseAPI {
6193
6395
  });
6194
6396
  }
6195
6397
  /**
6196
- * Endpoint to refresh the JWT auth token using the current valid JWT auth token in the authorization header
6398
+ * Refreshes the JWT auth token and returns a new token with updated claims.
6399
+ * Refresh the JWT auth token
6197
6400
  */
6198
6401
  refreshAuth(requestParameters, initOverrides) {
6199
6402
  return __awaiter(this, void 0, void 0, function* () {
@@ -6202,7 +6405,8 @@ class SDKApi extends BaseAPI {
6202
6405
  });
6203
6406
  }
6204
6407
  /**
6205
- * Refresh keyshares
6408
+ * Refreshes the MPC key shares for the specified WAAS wallet.
6409
+ * Refresh WAAS keyshares
6206
6410
  */
6207
6411
  refreshKeySharesRaw(requestParameters, initOverrides) {
6208
6412
  return __awaiter(this, void 0, void 0, function* () {
@@ -6231,7 +6435,8 @@ class SDKApi extends BaseAPI {
6231
6435
  });
6232
6436
  }
6233
6437
  /**
6234
- * Refresh keyshares
6438
+ * Refreshes the MPC key shares for the specified WAAS wallet.
6439
+ * Refresh WAAS keyshares
6235
6440
  */
6236
6441
  refreshKeyShares(requestParameters, initOverrides) {
6237
6442
  return __awaiter(this, void 0, void 0, function* () {
@@ -6297,6 +6502,7 @@ class SDKApi extends BaseAPI {
6297
6502
  });
6298
6503
  }
6299
6504
  /**
6505
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
6300
6506
  * Register a new passkey
6301
6507
  */
6302
6508
  registerPasskeyRaw(requestParameters, initOverrides) {
@@ -6328,6 +6534,7 @@ class SDKApi extends BaseAPI {
6328
6534
  });
6329
6535
  }
6330
6536
  /**
6537
+ * Registers a new passkey for the authenticated user using WebAuthn credentials.
6331
6538
  * Register a new passkey
6332
6539
  */
6333
6540
  registerPasskey(requestParameters, initOverrides) {
@@ -6337,7 +6544,8 @@ class SDKApi extends BaseAPI {
6337
6544
  });
6338
6545
  }
6339
6546
  /**
6340
- * Register a new Passkey MFA device
6547
+ * Initiates passkey MFA device registration and returns the setup details.
6548
+ * Register a passkey MFA device
6341
6549
  */
6342
6550
  registerPasskeyMfaDeviceRaw(requestParameters, initOverrides) {
6343
6551
  return __awaiter(this, void 0, void 0, function* () {
@@ -6363,7 +6571,8 @@ class SDKApi extends BaseAPI {
6363
6571
  });
6364
6572
  }
6365
6573
  /**
6366
- * Register a new Passkey MFA device
6574
+ * Initiates passkey MFA device registration and returns the setup details.
6575
+ * Register a passkey MFA device
6367
6576
  */
6368
6577
  registerPasskeyMfaDevice(requestParameters, initOverrides) {
6369
6578
  return __awaiter(this, void 0, void 0, function* () {
@@ -6399,6 +6608,7 @@ class SDKApi extends BaseAPI {
6399
6608
  });
6400
6609
  }
6401
6610
  /**
6611
+ * Verifies the passkey credential to complete MFA device registration.
6402
6612
  * Verify Passkey MFA device
6403
6613
  */
6404
6614
  registerPasskeyMfaDeviceVerifyRaw(requestParameters, initOverrides) {
@@ -6430,6 +6640,7 @@ class SDKApi extends BaseAPI {
6430
6640
  });
6431
6641
  }
6432
6642
  /**
6643
+ * Verifies the passkey credential to complete MFA device registration.
6433
6644
  * Verify Passkey MFA device
6434
6645
  */
6435
6646
  registerPasskeyMfaDeviceVerify(requestParameters, initOverrides) {
@@ -6481,7 +6692,8 @@ class SDKApi extends BaseAPI {
6481
6692
  });
6482
6693
  }
6483
6694
  /**
6484
- * Register a new TOTP MFA device and get Totp Secret
6695
+ * Initiates TOTP MFA device registration and returns the setup details.
6696
+ * Register a TOTP MFA device
6485
6697
  */
6486
6698
  registerTotpMfaDeviceRaw(requestParameters, initOverrides) {
6487
6699
  return __awaiter(this, void 0, void 0, function* () {
@@ -6507,7 +6719,8 @@ class SDKApi extends BaseAPI {
6507
6719
  });
6508
6720
  }
6509
6721
  /**
6510
- * Register a new TOTP MFA device and get Totp Secret
6722
+ * Initiates TOTP MFA device registration and returns the setup details.
6723
+ * Register a TOTP MFA device
6511
6724
  */
6512
6725
  registerTotpMfaDevice(requestParameters, initOverrides) {
6513
6726
  return __awaiter(this, void 0, void 0, function* () {
@@ -6543,6 +6756,7 @@ class SDKApi extends BaseAPI {
6543
6756
  });
6544
6757
  }
6545
6758
  /**
6759
+ * Verifies the TOTP code to complete MFA device registration.
6546
6760
  * Verify TOTP MFA device
6547
6761
  */
6548
6762
  registerTotpMfaDeviceVerifyRaw(requestParameters, initOverrides) {
@@ -6574,6 +6788,7 @@ class SDKApi extends BaseAPI {
6574
6788
  });
6575
6789
  }
6576
6790
  /**
6791
+ * Verifies the TOTP code to complete MFA device registration.
6577
6792
  * Verify TOTP MFA device
6578
6793
  */
6579
6794
  registerTotpMfaDeviceVerify(requestParameters, initOverrides) {
@@ -6583,7 +6798,8 @@ class SDKApi extends BaseAPI {
6583
6798
  });
6584
6799
  }
6585
6800
  /**
6586
- * Reshare secret shares and update the threshold
6801
+ * Reshares the MPC secret shares for the specified WAAS wallet.
6802
+ * Reshare WAAS secret shares
6587
6803
  */
6588
6804
  reshareRaw(requestParameters, initOverrides) {
6589
6805
  return __awaiter(this, void 0, void 0, function* () {
@@ -6617,7 +6833,8 @@ class SDKApi extends BaseAPI {
6617
6833
  });
6618
6834
  }
6619
6835
  /**
6620
- * Reshare secret shares and update the threshold
6836
+ * Reshares the MPC secret shares for the specified WAAS wallet.
6837
+ * Reshare WAAS secret shares
6621
6838
  */
6622
6839
  reshare(requestParameters, initOverrides) {
6623
6840
  return __awaiter(this, void 0, void 0, function* () {
@@ -6725,7 +6942,8 @@ class SDKApi extends BaseAPI {
6725
6942
  });
6726
6943
  }
6727
6944
  /**
6728
- * Send new code for email verification
6945
+ * Resends the email verification code to the email address on file.
6946
+ * Resend email verification code
6729
6947
  */
6730
6948
  retryEmailVerificationRaw(requestParameters, initOverrides) {
6731
6949
  return __awaiter(this, void 0, void 0, function* () {
@@ -6749,7 +6967,8 @@ class SDKApi extends BaseAPI {
6749
6967
  });
6750
6968
  }
6751
6969
  /**
6752
- * Send new code for email verification
6970
+ * Resends the email verification code to the email address on file.
6971
+ * Resend email verification code
6753
6972
  */
6754
6973
  retryEmailVerification(requestParameters, initOverrides) {
6755
6974
  return __awaiter(this, void 0, void 0, function* () {
@@ -6785,7 +7004,8 @@ class SDKApi extends BaseAPI {
6785
7004
  });
6786
7005
  }
6787
7006
  /**
6788
- * Send new code for sms verification
7007
+ * Resends the SMS verification code to the phone number on file.
7008
+ * Resend SMS verification code
6789
7009
  */
6790
7010
  retrySmsVerificationRaw(requestParameters, initOverrides) {
6791
7011
  return __awaiter(this, void 0, void 0, function* () {
@@ -6809,7 +7029,8 @@ class SDKApi extends BaseAPI {
6809
7029
  });
6810
7030
  }
6811
7031
  /**
6812
- * Send new code for sms verification
7032
+ * Resends the SMS verification code to the phone number on file.
7033
+ * Resend SMS verification code
6813
7034
  */
6814
7035
  retrySmsVerification(requestParameters, initOverrides) {
6815
7036
  return __awaiter(this, void 0, void 0, function* () {
@@ -6845,6 +7066,7 @@ class SDKApi extends BaseAPI {
6845
7066
  });
6846
7067
  }
6847
7068
  /**
7069
+ * Revokes the current user session and invalidates the JWT.
6848
7070
  * Revoke a session
6849
7071
  */
6850
7072
  revokeSessionRaw(requestParameters, initOverrides) {
@@ -6871,6 +7093,7 @@ class SDKApi extends BaseAPI {
6871
7093
  });
6872
7094
  }
6873
7095
  /**
7096
+ * Revokes the current user session and invalidates the JWT.
6874
7097
  * Revoke a session
6875
7098
  */
6876
7099
  revokeSession(requestParameters, initOverrides) {
@@ -6906,6 +7129,7 @@ class SDKApi extends BaseAPI {
6906
7129
  });
6907
7130
  }
6908
7131
  /**
7132
+ * Scans a URL for potential phishing or malicious activity and returns the result.
6909
7133
  * Scan a URL for potential malicious activity
6910
7134
  */
6911
7135
  scanUrlRaw(requestParameters, initOverrides) {
@@ -6930,6 +7154,7 @@ class SDKApi extends BaseAPI {
6930
7154
  });
6931
7155
  }
6932
7156
  /**
7157
+ * Scans a URL for potential phishing or malicious activity and returns the result.
6933
7158
  * Scan a URL for potential malicious activity
6934
7159
  */
6935
7160
  scanUrl(requestParameters, initOverrides) {
@@ -6992,7 +7217,7 @@ class SDKApi extends BaseAPI {
6992
7217
  }
6993
7218
  /**
6994
7219
  * When a user selects a wallet to be the primary wallet in a multi-wallet enabled environment, this endpoint is called to record this on the backend.
6995
- * Update wallet in a multi-wallet selection
7220
+ * Update primary wallet selection
6996
7221
  */
6997
7222
  selectUserWalletRaw(requestParameters, initOverrides) {
6998
7223
  return __awaiter(this, void 0, void 0, function* () {
@@ -7024,7 +7249,7 @@ class SDKApi extends BaseAPI {
7024
7249
  }
7025
7250
  /**
7026
7251
  * When a user selects a wallet to be the primary wallet in a multi-wallet enabled environment, this endpoint is called to record this on the backend.
7027
- * Update wallet in a multi-wallet selection
7252
+ * Update primary wallet selection
7028
7253
  */
7029
7254
  selectUserWallet(requestParameters, initOverrides) {
7030
7255
  return __awaiter(this, void 0, void 0, function* () {
@@ -7060,7 +7285,8 @@ class SDKApi extends BaseAPI {
7060
7285
  });
7061
7286
  }
7062
7287
  /**
7063
- * Check that session is valid
7288
+ * Checks whether the current user session is still valid.
7289
+ * Check session validity
7064
7290
  */
7065
7291
  sessionCheckRaw(requestParameters, initOverrides) {
7066
7292
  return __awaiter(this, void 0, void 0, function* () {
@@ -7086,7 +7312,8 @@ class SDKApi extends BaseAPI {
7086
7312
  });
7087
7313
  }
7088
7314
  /**
7089
- * Check that session is valid
7315
+ * Checks whether the current user session is still valid.
7316
+ * Check session validity
7090
7317
  */
7091
7318
  sessionCheck(requestParameters, initOverrides) {
7092
7319
  return __awaiter(this, void 0, void 0, function* () {
@@ -7175,7 +7402,8 @@ class SDKApi extends BaseAPI {
7175
7402
  });
7176
7403
  }
7177
7404
  /**
7178
- * Verify an email and sign in user
7405
+ * Verifies the email code and authenticates the user, returning a JWT.
7406
+ * Verify email and sign in
7179
7407
  */
7180
7408
  signInWithEmailVerificationRaw(requestParameters, initOverrides) {
7181
7409
  return __awaiter(this, void 0, void 0, function* () {
@@ -7199,7 +7427,8 @@ class SDKApi extends BaseAPI {
7199
7427
  });
7200
7428
  }
7201
7429
  /**
7202
- * Verify an email and sign in user
7430
+ * Verifies the email code and authenticates the user, returning a JWT.
7431
+ * Verify email and sign in
7203
7432
  */
7204
7433
  signInWithEmailVerification(requestParameters, initOverrides) {
7205
7434
  return __awaiter(this, void 0, void 0, function* () {
@@ -7235,7 +7464,8 @@ class SDKApi extends BaseAPI {
7235
7464
  });
7236
7465
  }
7237
7466
  /**
7238
- * Verify an sms and sign in user
7467
+ * Verifies the SMS code and authenticates the user, returning a JWT.
7468
+ * Verify SMS and sign in
7239
7469
  */
7240
7470
  signInWithSmsVerificationRaw(requestParameters, initOverrides) {
7241
7471
  return __awaiter(this, void 0, void 0, function* () {
@@ -7259,7 +7489,8 @@ class SDKApi extends BaseAPI {
7259
7489
  });
7260
7490
  }
7261
7491
  /**
7262
- * Verify an sms and sign in user
7492
+ * Verifies the SMS code and authenticates the user, returning a JWT.
7493
+ * Verify SMS and sign in
7263
7494
  */
7264
7495
  signInWithSmsVerification(requestParameters, initOverrides) {
7265
7496
  return __awaiter(this, void 0, void 0, function* () {
@@ -7295,7 +7526,8 @@ class SDKApi extends BaseAPI {
7295
7526
  });
7296
7527
  }
7297
7528
  /**
7298
- * Sign a message with a waas account
7529
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
7530
+ * Sign a message with a WAAS wallet
7299
7531
  */
7300
7532
  signMessageRaw(requestParameters, initOverrides) {
7301
7533
  return __awaiter(this, void 0, void 0, function* () {
@@ -7329,7 +7561,8 @@ class SDKApi extends BaseAPI {
7329
7561
  });
7330
7562
  }
7331
7563
  /**
7332
- * Sign a message with a waas account
7564
+ * Signs a message using the specified WAAS wallet through an MPC ceremony.
7565
+ * Sign a message with a WAAS wallet
7333
7566
  */
7334
7567
  signMessage(requestParameters, initOverrides) {
7335
7568
  return __awaiter(this, void 0, void 0, function* () {
@@ -7368,6 +7601,7 @@ class SDKApi extends BaseAPI {
7368
7601
  });
7369
7602
  }
7370
7603
  /**
7604
+ * Authenticates a user using a passkey and returns a JWT.
7371
7605
  * Authenticate a passkey
7372
7606
  */
7373
7607
  signinWithPasskeyRaw(requestParameters, initOverrides) {
@@ -7392,6 +7626,7 @@ class SDKApi extends BaseAPI {
7392
7626
  });
7393
7627
  }
7394
7628
  /**
7629
+ * Authenticates a user using a passkey and returns a JWT.
7395
7630
  * Authenticate a passkey
7396
7631
  */
7397
7632
  signinWithPasskey(requestParameters, initOverrides) {
@@ -7401,6 +7636,7 @@ class SDKApi extends BaseAPI {
7401
7636
  });
7402
7637
  }
7403
7638
  /**
7639
+ * Simulates an EVM transaction and returns the expected outcome.
7404
7640
  * Simulate an EVM transaction
7405
7641
  */
7406
7642
  simulateEVMTransactionRaw(requestParameters, initOverrides) {
@@ -7425,6 +7661,7 @@ class SDKApi extends BaseAPI {
7425
7661
  });
7426
7662
  }
7427
7663
  /**
7664
+ * Simulates an EVM transaction and returns the expected outcome.
7428
7665
  * Simulate an EVM transaction
7429
7666
  */
7430
7667
  simulateEVMTransaction(requestParameters, initOverrides) {
@@ -7461,6 +7698,7 @@ class SDKApi extends BaseAPI {
7461
7698
  });
7462
7699
  }
7463
7700
  /**
7701
+ * Simulates a Solana transaction and returns the expected outcome.
7464
7702
  * Simulate a Solana transaction
7465
7703
  */
7466
7704
  simulateSVMTransactionRaw(requestParameters, initOverrides) {
@@ -7485,6 +7723,7 @@ class SDKApi extends BaseAPI {
7485
7723
  });
7486
7724
  }
7487
7725
  /**
7726
+ * Simulates a Solana transaction and returns the expected outcome.
7488
7727
  * Simulate a Solana transaction
7489
7728
  */
7490
7729
  simulateSVMTransaction(requestParameters, initOverrides) {
@@ -7521,6 +7760,7 @@ class SDKApi extends BaseAPI {
7521
7760
  });
7522
7761
  }
7523
7762
  /**
7763
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
7524
7764
  * Simulate an EVM AA UserOp
7525
7765
  */
7526
7766
  simulateUserOpRaw(requestParameters, initOverrides) {
@@ -7545,6 +7785,7 @@ class SDKApi extends BaseAPI {
7545
7785
  });
7546
7786
  }
7547
7787
  /**
7788
+ * Simulates an EVM Account Abstraction UserOp and returns the expected outcome.
7548
7789
  * Simulate an EVM AA UserOp
7549
7790
  */
7550
7791
  simulateUserOp(requestParameters, initOverrides) {
@@ -7739,7 +7980,8 @@ class SDKApi extends BaseAPI {
7739
7980
  });
7740
7981
  }
7741
7982
  /**
7742
- * Telegram provider check auth
7983
+ * Checks if a Telegram authentication attempt has been completed.
7984
+ * Check Telegram authentication status
7743
7985
  */
7744
7986
  telegramCheckAuthRaw(requestParameters, initOverrides) {
7745
7987
  return __awaiter(this, void 0, void 0, function* () {
@@ -7760,7 +8002,8 @@ class SDKApi extends BaseAPI {
7760
8002
  });
7761
8003
  }
7762
8004
  /**
7763
- * Telegram provider check auth
8005
+ * Checks if a Telegram authentication attempt has been completed.
8006
+ * Check Telegram authentication status
7764
8007
  */
7765
8008
  telegramCheckAuth(requestParameters, initOverrides) {
7766
8009
  return __awaiter(this, void 0, void 0, function* () {
@@ -7795,7 +8038,8 @@ class SDKApi extends BaseAPI {
7795
8038
  });
7796
8039
  }
7797
8040
  /**
7798
- * Telegram provider SignIn endpoint
8041
+ * Authenticates a user using their Telegram account credentials.
8042
+ * Sign in with Telegram
7799
8043
  */
7800
8044
  telegramSignInRaw(requestParameters, initOverrides) {
7801
8045
  return __awaiter(this, void 0, void 0, function* () {
@@ -7816,7 +8060,8 @@ class SDKApi extends BaseAPI {
7816
8060
  });
7817
8061
  }
7818
8062
  /**
7819
- * Telegram provider SignIn endpoint
8063
+ * Authenticates a user using their Telegram account credentials.
8064
+ * Sign in with Telegram
7820
8065
  */
7821
8066
  telegramSignIn(requestParameters, initOverrides) {
7822
8067
  return __awaiter(this, void 0, void 0, function* () {
@@ -7852,7 +8097,8 @@ class SDKApi extends BaseAPI {
7852
8097
  });
7853
8098
  }
7854
8099
  /**
7855
- * Telegram provider Verify endpoint
8100
+ * Verifies and links a Telegram account to the authenticated user.
8101
+ * Verify Telegram account linking
7856
8102
  */
7857
8103
  telegramVerifyRaw(requestParameters, initOverrides) {
7858
8104
  return __awaiter(this, void 0, void 0, function* () {
@@ -7880,7 +8126,8 @@ class SDKApi extends BaseAPI {
7880
8126
  });
7881
8127
  }
7882
8128
  /**
7883
- * Telegram provider Verify endpoint
8129
+ * Verifies and links a Telegram account to the authenticated user.
8130
+ * Verify Telegram account linking
7884
8131
  */
7885
8132
  telegramVerify(requestParameters, initOverrides) {
7886
8133
  return __awaiter(this, void 0, void 0, function* () {
@@ -7916,6 +8163,7 @@ class SDKApi extends BaseAPI {
7916
8163
  });
7917
8164
  }
7918
8165
  /**
8166
+ * Updates the V2 recovery email address for the authenticated user.
7919
8167
  * Update a user\'s V2 recovery email
7920
8168
  */
7921
8169
  updateEmbeddedWalletRecoveryEmailRaw(requestParameters, initOverrides) {
@@ -7947,6 +8195,7 @@ class SDKApi extends BaseAPI {
7947
8195
  });
7948
8196
  }
7949
8197
  /**
8198
+ * Updates the V2 recovery email address for the authenticated user.
7950
8199
  * Update a user\'s V2 recovery email
7951
8200
  */
7952
8201
  updateEmbeddedWalletRecoveryEmail(requestParameters, initOverrides) {
@@ -7955,7 +8204,8 @@ class SDKApi extends BaseAPI {
7955
8204
  });
7956
8205
  }
7957
8206
  /**
7958
- * Update a passkey\'s info
8207
+ * Updates the specified passkey for the authenticated user.
8208
+ * Update a passkey
7959
8209
  */
7960
8210
  updatePasskeyRaw(requestParameters, initOverrides) {
7961
8211
  return __awaiter(this, void 0, void 0, function* () {
@@ -7986,7 +8236,8 @@ class SDKApi extends BaseAPI {
7986
8236
  });
7987
8237
  }
7988
8238
  /**
7989
- * Update a passkey\'s info
8239
+ * Updates the specified passkey for the authenticated user.
8240
+ * Update a passkey
7990
8241
  */
7991
8242
  updatePasskey(requestParameters, initOverrides) {
7992
8243
  return __awaiter(this, void 0, void 0, function* () {
@@ -7995,7 +8246,8 @@ class SDKApi extends BaseAPI {
7995
8246
  });
7996
8247
  }
7997
8248
  /**
7998
- * Update a user\'s fields
8249
+ * Updates the authenticated user profile fields.
8250
+ * Update user fields
7999
8251
  */
8000
8252
  updateSelfRaw(requestParameters, initOverrides) {
8001
8253
  return __awaiter(this, void 0, void 0, function* () {
@@ -8026,7 +8278,8 @@ class SDKApi extends BaseAPI {
8026
8278
  });
8027
8279
  }
8028
8280
  /**
8029
- * Update a user\'s fields
8281
+ * Updates the authenticated user profile fields.
8282
+ * Update user fields
8030
8283
  */
8031
8284
  updateSelf(requestParameters, initOverrides) {
8032
8285
  return __awaiter(this, void 0, void 0, function* () {
@@ -8035,7 +8288,8 @@ class SDKApi extends BaseAPI {
8035
8288
  });
8036
8289
  }
8037
8290
  /**
8038
- * Update a device
8291
+ * Updates the specified MFA device for the authenticated user.
8292
+ * Update an MFA device
8039
8293
  */
8040
8294
  updateUserMfaDeviceRaw(requestParameters, initOverrides) {
8041
8295
  return __awaiter(this, void 0, void 0, function* () {
@@ -8066,7 +8320,8 @@ class SDKApi extends BaseAPI {
8066
8320
  });
8067
8321
  }
8068
8322
  /**
8069
- * Update a device
8323
+ * Updates the specified MFA device for the authenticated user.
8324
+ * Update an MFA device
8070
8325
  */
8071
8326
  updateUserMfaDevice(requestParameters, initOverrides) {
8072
8327
  return __awaiter(this, void 0, void 0, function* () {
@@ -8075,7 +8330,7 @@ class SDKApi extends BaseAPI {
8075
8330
  }
8076
8331
  /**
8077
8332
  * Updates the settings for a WAAS wallet
8078
- * Update the WAAS wallet settings for the wallet
8333
+ * Update WAAS wallet settings
8079
8334
  */
8080
8335
  updateWaasWalletSettingsRaw(requestParameters, initOverrides) {
8081
8336
  return __awaiter(this, void 0, void 0, function* () {
@@ -8110,7 +8365,7 @@ class SDKApi extends BaseAPI {
8110
8365
  }
8111
8366
  /**
8112
8367
  * Updates the settings for a WAAS wallet
8113
- * Update the WAAS wallet settings for the wallet
8368
+ * Update WAAS wallet settings
8114
8369
  */
8115
8370
  updateWaasWalletSettings(requestParameters, initOverrides) {
8116
8371
  return __awaiter(this, void 0, void 0, function* () {
@@ -8119,6 +8374,7 @@ class SDKApi extends BaseAPI {
8119
8374
  });
8120
8375
  }
8121
8376
  /**
8377
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
8122
8378
  * Update V1 embedded wallet to V2
8123
8379
  */
8124
8380
  upgradeEmbeddedWalletToV2Raw(requestParameters, initOverrides) {
@@ -8143,6 +8399,7 @@ class SDKApi extends BaseAPI {
8143
8399
  });
8144
8400
  }
8145
8401
  /**
8402
+ * Upgrades a V1 embedded wallet to V2 and returns a refreshed JWT.
8146
8403
  * Update V1 embedded wallet to V2
8147
8404
  */
8148
8405
  upgradeEmbeddedWalletToV2(requestParameters, initOverrides) {
@@ -8233,6 +8490,7 @@ class SDKApi extends BaseAPI {
8233
8490
  });
8234
8491
  }
8235
8492
  /**
8493
+ * Verifies the signed payload and returns a JWT authentication token.
8236
8494
  * Verify payload and return JWT
8237
8495
  */
8238
8496
  verifyRaw(requestParameters, initOverrides) {
@@ -8257,6 +8515,7 @@ class SDKApi extends BaseAPI {
8257
8515
  });
8258
8516
  }
8259
8517
  /**
8518
+ * Verifies the signed payload and returns a JWT authentication token.
8260
8519
  * Verify payload and return JWT
8261
8520
  */
8262
8521
  verify(requestParameters, initOverrides) {
@@ -8266,7 +8525,8 @@ class SDKApi extends BaseAPI {
8266
8525
  });
8267
8526
  }
8268
8527
  /**
8269
- * Verify email verification request
8528
+ * Verifies the email code and completes the email verification process.
8529
+ * Verify email verification code
8270
8530
  */
8271
8531
  verifyEmailVerificationRaw(requestParameters, initOverrides) {
8272
8532
  return __awaiter(this, void 0, void 0, function* () {
@@ -8297,7 +8557,8 @@ class SDKApi extends BaseAPI {
8297
8557
  });
8298
8558
  }
8299
8559
  /**
8300
- * Verify email verification request
8560
+ * Verifies the email code and completes the email verification process.
8561
+ * Verify email verification code
8301
8562
  */
8302
8563
  verifyEmailVerification(requestParameters, initOverrides) {
8303
8564
  return __awaiter(this, void 0, void 0, function* () {
@@ -8334,7 +8595,7 @@ class SDKApi extends BaseAPI {
8334
8595
  }
8335
8596
  /**
8336
8597
  * Link a wallet to a valid environment user, and return an updated JWT
8337
- * Link wallet to user
8598
+ * Link a wallet to a user
8338
8599
  */
8339
8600
  verifyLinkRaw(requestParameters, initOverrides) {
8340
8601
  return __awaiter(this, void 0, void 0, function* () {
@@ -8366,7 +8627,7 @@ class SDKApi extends BaseAPI {
8366
8627
  }
8367
8628
  /**
8368
8629
  * Link a wallet to a valid environment user, and return an updated JWT
8369
- * Link wallet to user
8630
+ * Link a wallet to a user
8370
8631
  */
8371
8632
  verifyLink(requestParameters, initOverrides) {
8372
8633
  return __awaiter(this, void 0, void 0, function* () {
@@ -8525,7 +8786,8 @@ class SDKApi extends BaseAPI {
8525
8786
  });
8526
8787
  }
8527
8788
  /**
8528
- * Verify sms verification request
8789
+ * Verifies the SMS code and completes the phone number verification process.
8790
+ * Verify SMS verification code
8529
8791
  */
8530
8792
  verifySmsVerificationRaw(requestParameters, initOverrides) {
8531
8793
  return __awaiter(this, void 0, void 0, function* () {
@@ -8556,7 +8818,8 @@ class SDKApi extends BaseAPI {
8556
8818
  });
8557
8819
  }
8558
8820
  /**
8559
- * Verify sms verification request
8821
+ * Verifies the SMS code and completes the phone number verification process.
8822
+ * Verify SMS verification code
8560
8823
  */
8561
8824
  verifySmsVerification(requestParameters, initOverrides) {
8562
8825
  return __awaiter(this, void 0, void 0, function* () {
@@ -8593,7 +8856,7 @@ class SDKApi extends BaseAPI {
8593
8856
  }
8594
8857
  /**
8595
8858
  * Used to link a wallet after user has confirmed transfer to the new account
8596
- * Verify wallet transfer
8859
+ * Verify a wallet transfer
8597
8860
  */
8598
8861
  verifyTransferRaw(requestParameters, initOverrides) {
8599
8862
  return __awaiter(this, void 0, void 0, function* () {
@@ -8625,7 +8888,7 @@ class SDKApi extends BaseAPI {
8625
8888
  }
8626
8889
  /**
8627
8890
  * Used to link a wallet after user has confirmed transfer to the new account
8628
- * Verify wallet transfer
8891
+ * Verify a wallet transfer
8629
8892
  */
8630
8893
  verifyTransfer(requestParameters, initOverrides) {
8631
8894
  return __awaiter(this, void 0, void 0, function* () {
@@ -8662,7 +8925,7 @@ class SDKApi extends BaseAPI {
8662
8925
  }
8663
8926
  /**
8664
8927
  * Remove a link from to a valid environment user, and return an updated JWT
8665
- * unlink wallet from user
8928
+ * Unlink a wallet from a user
8666
8929
  */
8667
8930
  verifyUnlinkRaw(requestParameters, initOverrides) {
8668
8931
  return __awaiter(this, void 0, void 0, function* () {
@@ -8694,7 +8957,7 @@ class SDKApi extends BaseAPI {
8694
8957
  }
8695
8958
  /**
8696
8959
  * Remove a link from to a valid environment user, and return an updated JWT
8697
- * unlink wallet from user
8960
+ * Unlink a wallet from a user
8698
8961
  */
8699
8962
  verifyUnlink(requestParameters, initOverrides) {
8700
8963
  return __awaiter(this, void 0, void 0, function* () {
@@ -8814,6 +9077,7 @@ class SDKApi extends BaseAPI {
8814
9077
  });
8815
9078
  }
8816
9079
  /**
9080
+ * Authenticates a user by verifying their wallet signature.
8817
9081
  * Sign in with wallet
8818
9082
  */
8819
9083
  walletsSigninRaw(requestParameters, initOverrides) {
@@ -8838,6 +9102,7 @@ class SDKApi extends BaseAPI {
8838
9102
  });
8839
9103
  }
8840
9104
  /**
9105
+ * Authenticates a user by verifying their wallet signature.
8841
9106
  * Sign in with wallet
8842
9107
  */
8843
9108
  walletsSignin(requestParameters, initOverrides) {
@@ -8875,7 +9140,7 @@ class SDKApi extends BaseAPI {
8875
9140
  }
8876
9141
  /**
8877
9142
  * Verify a wallet, and return an updated JWT
8878
- * Verify wallet
9143
+ * Verify a wallet
8879
9144
  */
8880
9145
  walletsVerifyRaw(requestParameters, initOverrides) {
8881
9146
  return __awaiter(this, void 0, void 0, function* () {
@@ -8907,7 +9172,7 @@ class SDKApi extends BaseAPI {
8907
9172
  }
8908
9173
  /**
8909
9174
  * Verify a wallet, and return an updated JWT
8910
- * Verify wallet
9175
+ * Verify a wallet
8911
9176
  */
8912
9177
  walletsVerify(requestParameters, initOverrides) {
8913
9178
  return __awaiter(this, void 0, void 0, function* () {