@dynamic-labs/sdk-api 0.0.236 → 0.0.238

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynamic-labs/sdk-api",
3
- "version": "0.0.236",
3
+ "version": "0.0.238",
4
4
  "author": "Dynamic Labs",
5
5
  "license": "Apache-2.0",
6
6
  "publishConfig": {
@@ -55,7 +55,7 @@ require('../models/VisitorFilterableFieldsEnum.cjs');
55
55
  */
56
56
  class SDKApi extends runtime.BaseAPI {
57
57
  /**
58
- * initializes the email verification process
58
+ * Initialize email verification process
59
59
  */
60
60
  createEmailVerificationRaw(requestParameters, initOverrides) {
61
61
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -79,7 +79,7 @@ class SDKApi extends runtime.BaseAPI {
79
79
  });
80
80
  }
81
81
  /**
82
- * initializes the email verification process
82
+ * Initialize email verification process
83
83
  */
84
84
  createEmailVerification(requestParameters, initOverrides) {
85
85
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -116,6 +116,7 @@ class SDKApi extends runtime.BaseAPI {
116
116
  }
117
117
  /**
118
118
  * Endpoint to send minimal wallet information for a connect-only or connect-first visitor.
119
+ * Create a visit
119
120
  */
120
121
  createVisitRaw(requestParameters, initOverrides) {
121
122
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -140,6 +141,7 @@ class SDKApi extends runtime.BaseAPI {
140
141
  }
141
142
  /**
142
143
  * Endpoint to send minimal wallet information for a connect-only or connect-first visitor.
144
+ * Create a visit
143
145
  */
144
146
  createVisit(requestParameters, initOverrides) {
145
147
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -199,7 +201,8 @@ class SDKApi extends runtime.BaseAPI {
199
201
  });
200
202
  }
201
203
  /**
202
- * This endpoint returns 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.
204
+ * 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.
205
+ * Get signin email provider
203
206
  */
204
207
  getEmailProviderRaw(requestParameters, initOverrides) {
205
208
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -224,7 +227,8 @@ class SDKApi extends runtime.BaseAPI {
224
227
  });
225
228
  }
226
229
  /**
227
- * This endpoint returns 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.
230
+ * 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.
231
+ * Get signin email provider
228
232
  */
229
233
  getEmailProvider(requestParameters, initOverrides) {
230
234
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -261,7 +265,7 @@ class SDKApi extends runtime.BaseAPI {
261
265
  });
262
266
  }
263
267
  /**
264
- * Find the jwks for the public key for this environment
268
+ * Find jwks for public key
265
269
  */
266
270
  getJwksByEnvironmentIdRaw(requestParameters, initOverrides) {
267
271
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -280,7 +284,7 @@ class SDKApi extends runtime.BaseAPI {
280
284
  });
281
285
  }
282
286
  /**
283
- * Find the jwks for the public key for this environment
287
+ * Find jwks for public key
284
288
  */
285
289
  getJwksByEnvironmentId(requestParameters, initOverrides) {
286
290
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -317,7 +321,7 @@ class SDKApi extends runtime.BaseAPI {
317
321
  });
318
322
  }
319
323
  /**
320
- * Creates a nonce for the authentication flow
324
+ * Create nonce for authentication flow
321
325
  */
322
326
  getNonceRaw(requestParameters, initOverrides) {
323
327
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -336,7 +340,7 @@ class SDKApi extends runtime.BaseAPI {
336
340
  });
337
341
  }
338
342
  /**
339
- * Creates a nonce for the authentication flow
343
+ * Create nonce for authentication flow
340
344
  */
341
345
  getNonce(requestParameters, initOverrides) {
342
346
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -346,6 +350,7 @@ class SDKApi extends runtime.BaseAPI {
346
350
  }
347
351
  /**
348
352
  * Find the configuration for the enabled onramps associated to an environment
353
+ * Configuration for enabled onramps
349
354
  */
350
355
  getSupportedOnrampsRaw(requestParameters, initOverrides) {
351
356
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -383,6 +388,7 @@ class SDKApi extends runtime.BaseAPI {
383
388
  }
384
389
  /**
385
390
  * Find the configuration for the enabled onramps associated to an environment
391
+ * Configuration for enabled onramps
386
392
  */
387
393
  getSupportedOnramps(requestParameters, initOverrides) {
388
394
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -533,6 +539,7 @@ class SDKApi extends runtime.BaseAPI {
533
539
  }
534
540
  /**
535
541
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
542
+ * Oauth provider redirect endpoint
536
543
  */
537
544
  oauthRedirectCodeRaw(requestParameters, initOverrides) {
538
545
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -567,6 +574,7 @@ class SDKApi extends runtime.BaseAPI {
567
574
  }
568
575
  /**
569
576
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
577
+ * Oauth provider redirect endpoint
570
578
  */
571
579
  oauthRedirectCode(requestParameters, initOverrides) {
572
580
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -606,6 +614,7 @@ class SDKApi extends runtime.BaseAPI {
606
614
  }
607
615
  /**
608
616
  * Standard OAuth verify callback to exchange temproary code for oauth access
617
+ * Oauth provider verify endpoint
609
618
  */
610
619
  oauthVerifyRaw(requestParameters, initOverrides) {
611
620
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -633,6 +642,7 @@ class SDKApi extends runtime.BaseAPI {
633
642
  }
634
643
  /**
635
644
  * Standard OAuth verify callback to exchange temproary code for oauth access
645
+ * Oauth provider verify endpoint
636
646
  */
637
647
  oauthVerify(requestParameters, initOverrides) {
638
648
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -726,6 +736,7 @@ class SDKApi extends runtime.BaseAPI {
726
736
  }
727
737
  /**
728
738
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
739
+ * prefetch information for wallet address
729
740
  */
730
741
  prefetchRaw(requestParameters, initOverrides) {
731
742
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -750,6 +761,7 @@ class SDKApi extends runtime.BaseAPI {
750
761
  }
751
762
  /**
752
763
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
764
+ * prefetch information for wallet address
753
765
  */
754
766
  prefetch(requestParameters, initOverrides) {
755
767
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -851,7 +863,7 @@ class SDKApi extends runtime.BaseAPI {
851
863
  });
852
864
  }
853
865
  /**
854
- * Sends a new code for the email verification flow
866
+ * Send new code for email verification
855
867
  */
856
868
  retryEmailVerificationRaw(requestParameters, initOverrides) {
857
869
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -875,7 +887,7 @@ class SDKApi extends runtime.BaseAPI {
875
887
  });
876
888
  }
877
889
  /**
878
- * Sends a new code for the email verification flow
890
+ * Send new code for email verification
879
891
  */
880
892
  retryEmailVerification(requestParameters, initOverrides) {
881
893
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -911,7 +923,7 @@ class SDKApi extends runtime.BaseAPI {
911
923
  });
912
924
  }
913
925
  /**
914
- * Revoke a session from the SDK environment
926
+ * Revoke a session
915
927
  */
916
928
  revokeSessionRaw(requestParameters, initOverrides) {
917
929
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -937,7 +949,7 @@ class SDKApi extends runtime.BaseAPI {
937
949
  });
938
950
  }
939
951
  /**
940
- * Revoke a session from the SDK environment
952
+ * Revoke a session
941
953
  */
942
954
  revokeSession(requestParameters, initOverrides) {
943
955
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1024,7 +1036,7 @@ class SDKApi extends runtime.BaseAPI {
1024
1036
  });
1025
1037
  }
1026
1038
  /**
1027
- * verify the email and sign in the user
1039
+ * Verify an email and sign in user
1028
1040
  */
1029
1041
  signInWithEmailVerificationRaw(requestParameters, initOverrides) {
1030
1042
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1048,7 +1060,7 @@ class SDKApi extends runtime.BaseAPI {
1048
1060
  });
1049
1061
  }
1050
1062
  /**
1051
- * verify the email and sign in the user
1063
+ * Verify an email and sign in user
1052
1064
  */
1053
1065
  signInWithEmailVerification(requestParameters, initOverrides) {
1054
1066
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1116,7 +1128,7 @@ class SDKApi extends runtime.BaseAPI {
1116
1128
  });
1117
1129
  }
1118
1130
  /**
1119
- * Update the user\'s fields
1131
+ * Update a user\'s fields
1120
1132
  */
1121
1133
  updateSelfRaw(requestParameters, initOverrides) {
1122
1134
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1147,7 +1159,7 @@ class SDKApi extends runtime.BaseAPI {
1147
1159
  });
1148
1160
  }
1149
1161
  /**
1150
- * Update the user\'s fields
1162
+ * Update a user\'s fields
1151
1163
  */
1152
1164
  updateSelf(requestParameters, initOverrides) {
1153
1165
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1183,7 +1195,7 @@ class SDKApi extends runtime.BaseAPI {
1183
1195
  });
1184
1196
  }
1185
1197
  /**
1186
- * Verifies payload and returns jwt
1198
+ * Verify payload and return JWT
1187
1199
  */
1188
1200
  verifyRaw(requestParameters, initOverrides) {
1189
1201
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1207,7 +1219,7 @@ class SDKApi extends runtime.BaseAPI {
1207
1219
  });
1208
1220
  }
1209
1221
  /**
1210
- * Verifies payload and returns jwt
1222
+ * Verify payload and return JWT
1211
1223
  */
1212
1224
  verify(requestParameters, initOverrides) {
1213
1225
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1216,7 +1228,7 @@ class SDKApi extends runtime.BaseAPI {
1216
1228
  });
1217
1229
  }
1218
1230
  /**
1219
- * verify the email verification request
1231
+ * Verify email verification request
1220
1232
  */
1221
1233
  verifyEmailVerificationRaw(requestParameters, initOverrides) {
1222
1234
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1247,7 +1259,7 @@ class SDKApi extends runtime.BaseAPI {
1247
1259
  });
1248
1260
  }
1249
1261
  /**
1250
- * verify the email verification request
1262
+ * Verify email verification request
1251
1263
  */
1252
1264
  verifyEmailVerification(requestParameters, initOverrides) {
1253
1265
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1284,6 +1296,7 @@ class SDKApi extends runtime.BaseAPI {
1284
1296
  }
1285
1297
  /**
1286
1298
  * Link a wallet to a valid environment user, and return an updated JWT
1299
+ * Link wallet to user
1287
1300
  */
1288
1301
  verifyLinkRaw(requestParameters, initOverrides) {
1289
1302
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1315,6 +1328,7 @@ class SDKApi extends runtime.BaseAPI {
1315
1328
  }
1316
1329
  /**
1317
1330
  * Link a wallet to a valid environment user, and return an updated JWT
1331
+ * Link wallet to user
1318
1332
  */
1319
1333
  verifyLink(requestParameters, initOverrides) {
1320
1334
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1404,7 +1418,8 @@ class SDKApi extends runtime.BaseAPI {
1404
1418
  });
1405
1419
  }
1406
1420
  /**
1407
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1421
+ * Used to link a wallet after user has confirmed transfer to the new account
1422
+ * Verify wallet transfer
1408
1423
  */
1409
1424
  verifyTransferRaw(requestParameters, initOverrides) {
1410
1425
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1435,7 +1450,8 @@ class SDKApi extends runtime.BaseAPI {
1435
1450
  });
1436
1451
  }
1437
1452
  /**
1438
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1453
+ * Used to link a wallet after user has confirmed transfer to the new account
1454
+ * Verify wallet transfer
1439
1455
  */
1440
1456
  verifyTransfer(requestParameters, initOverrides) {
1441
1457
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1472,6 +1488,7 @@ class SDKApi extends runtime.BaseAPI {
1472
1488
  }
1473
1489
  /**
1474
1490
  * Remove a link from to a valid environment user, and return an updated JWT
1491
+ * unlink wallet from user
1475
1492
  */
1476
1493
  verifyUnlinkRaw(requestParameters, initOverrides) {
1477
1494
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1503,6 +1520,7 @@ class SDKApi extends runtime.BaseAPI {
1503
1520
  }
1504
1521
  /**
1505
1522
  * Remove a link from to a valid environment user, and return an updated JWT
1523
+ * unlink wallet from user
1506
1524
  */
1507
1525
  verifyUnlink(requestParameters, initOverrides) {
1508
1526
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -189,11 +189,11 @@ export interface VerifyUnlinkOptionsRequest {
189
189
  */
190
190
  export declare class SDKApi extends runtime.BaseAPI {
191
191
  /**
192
- * initializes the email verification process
192
+ * Initialize email verification process
193
193
  */
194
194
  createEmailVerificationRaw(requestParameters: CreateEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmailVerificationCreateResponse>>;
195
195
  /**
196
- * initializes the email verification process
196
+ * Initialize email verification process
197
197
  */
198
198
  createEmailVerification(requestParameters: CreateEmailVerificationRequest, initOverrides?: RequestInit): Promise<EmailVerificationCreateResponse>;
199
199
  /**
@@ -206,10 +206,12 @@ export declare class SDKApi extends runtime.BaseAPI {
206
206
  createEmailVerificationOptions(requestParameters: CreateEmailVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
207
207
  /**
208
208
  * Endpoint to send minimal wallet information for a connect-only or connect-first visitor.
209
+ * Create a visit
209
210
  */
210
211
  createVisitRaw(requestParameters: CreateVisitRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
211
212
  /**
212
213
  * Endpoint to send minimal wallet information for a connect-only or connect-first visitor.
214
+ * Create a visit
213
215
  */
214
216
  createVisit(requestParameters: CreateVisitRequest, initOverrides?: RequestInit): Promise<void>;
215
217
  /**
@@ -227,11 +229,13 @@ export declare class SDKApi extends runtime.BaseAPI {
227
229
  */
228
230
  eventsOptions(requestParameters: EventsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
229
231
  /**
230
- * This endpoint returns 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.
232
+ * 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.
233
+ * Get signin email provider
231
234
  */
232
235
  getEmailProviderRaw(requestParameters: GetEmailProviderRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmailProviderResponse>>;
233
236
  /**
234
- * This endpoint returns 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.
237
+ * 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.
238
+ * Get signin email provider
235
239
  */
236
240
  getEmailProvider(requestParameters: GetEmailProviderRequest, initOverrides?: RequestInit): Promise<EmailProviderResponse>;
237
241
  /**
@@ -243,11 +247,11 @@ export declare class SDKApi extends runtime.BaseAPI {
243
247
  */
244
248
  getEnvironmentSettings(requestParameters: GetEnvironmentSettingsRequest, initOverrides?: RequestInit): Promise<ProjectSettings>;
245
249
  /**
246
- * Find the jwks for the public key for this environment
250
+ * Find jwks for public key
247
251
  */
248
252
  getJwksByEnvironmentIdRaw(requestParameters: GetJwksByEnvironmentIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<JwksResponse>>;
249
253
  /**
250
- * Find the jwks for the public key for this environment
254
+ * Find jwks for public key
251
255
  */
252
256
  getJwksByEnvironmentId(requestParameters: GetJwksByEnvironmentIdRequest, initOverrides?: RequestInit): Promise<JwksResponse>;
253
257
  /**
@@ -259,19 +263,21 @@ export declare class SDKApi extends runtime.BaseAPI {
259
263
  */
260
264
  getNetworksConfigurationByEnvId(requestParameters: GetNetworksConfigurationByEnvIdRequest, initOverrides?: RequestInit): Promise<Array<NetworkConfigurationResponse>>;
261
265
  /**
262
- * Creates a nonce for the authentication flow
266
+ * Create nonce for authentication flow
263
267
  */
264
268
  getNonceRaw(requestParameters: GetNonceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonceResponse>>;
265
269
  /**
266
- * Creates a nonce for the authentication flow
270
+ * Create nonce for authentication flow
267
271
  */
268
272
  getNonce(requestParameters: GetNonceRequest, initOverrides?: RequestInit): Promise<NonceResponse>;
269
273
  /**
270
274
  * Find the configuration for the enabled onramps associated to an environment
275
+ * Configuration for enabled onramps
271
276
  */
272
277
  getSupportedOnrampsRaw(requestParameters: GetSupportedOnrampsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SupportedOnrampsResponse>>;
273
278
  /**
274
279
  * Find the configuration for the enabled onramps associated to an environment
280
+ * Configuration for enabled onramps
275
281
  */
276
282
  getSupportedOnramps(requestParameters: GetSupportedOnrampsRequest, initOverrides?: RequestInit): Promise<SupportedOnrampsResponse>;
277
283
  /**
@@ -316,10 +322,12 @@ export declare class SDKApi extends runtime.BaseAPI {
316
322
  oauthLoginOptions(requestParameters: OauthLoginOptionsRequest, initOverrides?: RequestInit): Promise<void>;
317
323
  /**
318
324
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
325
+ * Oauth provider redirect endpoint
319
326
  */
320
327
  oauthRedirectCodeRaw(requestParameters: OauthRedirectCodeRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
321
328
  /**
322
329
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
330
+ * Oauth provider redirect endpoint
323
331
  */
324
332
  oauthRedirectCode(requestParameters: OauthRedirectCodeRequest, initOverrides?: RequestInit): Promise<string>;
325
333
  /**
@@ -332,10 +340,12 @@ export declare class SDKApi extends runtime.BaseAPI {
332
340
  oauthRedirectOptions(requestParameters: OauthRedirectOptionsRequest, initOverrides?: RequestInit): Promise<void>;
333
341
  /**
334
342
  * Standard OAuth verify callback to exchange temproary code for oauth access
343
+ * Oauth provider verify endpoint
335
344
  */
336
345
  oauthVerifyRaw(requestParameters: OauthVerifyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
337
346
  /**
338
347
  * Standard OAuth verify callback to exchange temproary code for oauth access
348
+ * Oauth provider verify endpoint
339
349
  */
340
350
  oauthVerify(requestParameters: OauthVerifyRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
341
351
  /**
@@ -364,10 +374,12 @@ export declare class SDKApi extends runtime.BaseAPI {
364
374
  optionsConnect(requestParameters: OptionsConnectRequest, initOverrides?: RequestInit): Promise<void>;
365
375
  /**
366
376
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
377
+ * prefetch information for wallet address
367
378
  */
368
379
  prefetchRaw(requestParameters: PrefetchOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
369
380
  /**
370
381
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
382
+ * prefetch information for wallet address
371
383
  */
372
384
  prefetch(requestParameters: PrefetchOperationRequest, initOverrides?: RequestInit): Promise<void>;
373
385
  /**
@@ -395,11 +407,11 @@ export declare class SDKApi extends runtime.BaseAPI {
395
407
  */
396
408
  refreshOptions(requestParameters: RefreshOptionsRequest, initOverrides?: RequestInit): Promise<void>;
397
409
  /**
398
- * Sends a new code for the email verification flow
410
+ * Send new code for email verification
399
411
  */
400
412
  retryEmailVerificationRaw(requestParameters: RetryEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<EmailVerificationCreateResponse>>;
401
413
  /**
402
- * Sends a new code for the email verification flow
414
+ * Send new code for email verification
403
415
  */
404
416
  retryEmailVerification(requestParameters: RetryEmailVerificationRequest, initOverrides?: RequestInit): Promise<EmailVerificationCreateResponse>;
405
417
  /**
@@ -411,11 +423,11 @@ export declare class SDKApi extends runtime.BaseAPI {
411
423
  */
412
424
  retryEmailVerificationOptions(requestParameters: RetryEmailVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
413
425
  /**
414
- * Revoke a session from the SDK environment
426
+ * Revoke a session
415
427
  */
416
428
  revokeSessionRaw(requestParameters: RevokeSessionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
417
429
  /**
418
- * Revoke a session from the SDK environment
430
+ * Revoke a session
419
431
  */
420
432
  revokeSession(requestParameters: RevokeSessionRequest, initOverrides?: RequestInit): Promise<void>;
421
433
  /**
@@ -441,11 +453,11 @@ export declare class SDKApi extends runtime.BaseAPI {
441
453
  */
442
454
  settingsOptions(requestParameters: SettingsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
443
455
  /**
444
- * verify the email and sign in the user
456
+ * Verify an email and sign in user
445
457
  */
446
458
  signInWithEmailVerificationRaw(requestParameters: SignInWithEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
447
459
  /**
448
- * verify the email and sign in the user
460
+ * Verify an email and sign in user
449
461
  */
450
462
  signInWithEmailVerification(requestParameters: SignInWithEmailVerificationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
451
463
  /**
@@ -465,11 +477,11 @@ export declare class SDKApi extends runtime.BaseAPI {
465
477
  */
466
478
  updateSdkSettings(requestParameters: UpdateSdkSettingsRequest, initOverrides?: RequestInit): Promise<void>;
467
479
  /**
468
- * Update the user\'s fields
480
+ * Update a user\'s fields
469
481
  */
470
482
  updateSelfRaw(requestParameters: UpdateSelfRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UpdateSelfResponse>>;
471
483
  /**
472
- * Update the user\'s fields
484
+ * Update a user\'s fields
473
485
  */
474
486
  updateSelf(requestParameters: UpdateSelfRequest, initOverrides?: RequestInit): Promise<UpdateSelfResponse>;
475
487
  /**
@@ -481,19 +493,19 @@ export declare class SDKApi extends runtime.BaseAPI {
481
493
  */
482
494
  usersOptions(requestParameters: UsersOptionsRequest, initOverrides?: RequestInit): Promise<void>;
483
495
  /**
484
- * Verifies payload and returns jwt
496
+ * Verify payload and return JWT
485
497
  */
486
498
  verifyRaw(requestParameters: VerifyOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
487
499
  /**
488
- * Verifies payload and returns jwt
500
+ * Verify payload and return JWT
489
501
  */
490
502
  verify(requestParameters: VerifyOperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
491
503
  /**
492
- * verify the email verification request
504
+ * Verify email verification request
493
505
  */
494
506
  verifyEmailVerificationRaw(requestParameters: VerifyEmailVerificationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UpdateSelfResponse>>;
495
507
  /**
496
- * verify the email verification request
508
+ * Verify email verification request
497
509
  */
498
510
  verifyEmailVerification(requestParameters: VerifyEmailVerificationRequest, initOverrides?: RequestInit): Promise<UpdateSelfResponse>;
499
511
  /**
@@ -506,10 +518,12 @@ export declare class SDKApi extends runtime.BaseAPI {
506
518
  verifyEmailVerificationOptions(requestParameters: VerifyEmailVerificationOptionsRequest, initOverrides?: RequestInit): Promise<void>;
507
519
  /**
508
520
  * Link a wallet to a valid environment user, and return an updated JWT
521
+ * Link wallet to user
509
522
  */
510
523
  verifyLinkRaw(requestParameters: VerifyLinkRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
511
524
  /**
512
525
  * Link a wallet to a valid environment user, and return an updated JWT
526
+ * Link wallet to user
513
527
  */
514
528
  verifyLink(requestParameters: VerifyLinkRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
515
529
  /**
@@ -537,11 +551,13 @@ export declare class SDKApi extends runtime.BaseAPI {
537
551
  */
538
552
  verifyPrefetch(requestParameters: VerifyPrefetchRequest, initOverrides?: RequestInit): Promise<void>;
539
553
  /**
540
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
554
+ * Used to link a wallet after user has confirmed transfer to the new account
555
+ * Verify wallet transfer
541
556
  */
542
557
  verifyTransferRaw(requestParameters: VerifyTransferRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
543
558
  /**
544
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
559
+ * Used to link a wallet after user has confirmed transfer to the new account
560
+ * Verify wallet transfer
545
561
  */
546
562
  verifyTransfer(requestParameters: VerifyTransferRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
547
563
  /**
@@ -554,10 +570,12 @@ export declare class SDKApi extends runtime.BaseAPI {
554
570
  verifyTransferOptions(requestParameters: VerifyTransferOptionsRequest, initOverrides?: RequestInit): Promise<void>;
555
571
  /**
556
572
  * Remove a link from to a valid environment user, and return an updated JWT
573
+ * unlink wallet from user
557
574
  */
558
575
  verifyUnlinkRaw(requestParameters: VerifyUnlinkOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VerifyResponse>>;
559
576
  /**
560
577
  * Remove a link from to a valid environment user, and return an updated JWT
578
+ * unlink wallet from user
561
579
  */
562
580
  verifyUnlink(requestParameters: VerifyUnlinkOperationRequest, initOverrides?: RequestInit): Promise<VerifyResponse>;
563
581
  /**
@@ -51,7 +51,7 @@ import '../models/VisitorFilterableFieldsEnum.js';
51
51
  */
52
52
  class SDKApi extends BaseAPI {
53
53
  /**
54
- * initializes the email verification process
54
+ * Initialize email verification process
55
55
  */
56
56
  createEmailVerificationRaw(requestParameters, initOverrides) {
57
57
  return __awaiter(this, void 0, void 0, function* () {
@@ -75,7 +75,7 @@ class SDKApi extends BaseAPI {
75
75
  });
76
76
  }
77
77
  /**
78
- * initializes the email verification process
78
+ * Initialize email verification process
79
79
  */
80
80
  createEmailVerification(requestParameters, initOverrides) {
81
81
  return __awaiter(this, void 0, void 0, function* () {
@@ -112,6 +112,7 @@ class SDKApi extends BaseAPI {
112
112
  }
113
113
  /**
114
114
  * Endpoint to send minimal wallet information for a connect-only or connect-first visitor.
115
+ * Create a visit
115
116
  */
116
117
  createVisitRaw(requestParameters, initOverrides) {
117
118
  return __awaiter(this, void 0, void 0, function* () {
@@ -136,6 +137,7 @@ class SDKApi extends BaseAPI {
136
137
  }
137
138
  /**
138
139
  * Endpoint to send minimal wallet information for a connect-only or connect-first visitor.
140
+ * Create a visit
139
141
  */
140
142
  createVisit(requestParameters, initOverrides) {
141
143
  return __awaiter(this, void 0, void 0, function* () {
@@ -195,7 +197,8 @@ class SDKApi extends BaseAPI {
195
197
  });
196
198
  }
197
199
  /**
198
- * This endpoint returns 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.
200
+ * 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.
201
+ * Get signin email provider
199
202
  */
200
203
  getEmailProviderRaw(requestParameters, initOverrides) {
201
204
  return __awaiter(this, void 0, void 0, function* () {
@@ -220,7 +223,8 @@ class SDKApi extends BaseAPI {
220
223
  });
221
224
  }
222
225
  /**
223
- * This endpoint returns 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.
226
+ * 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.
227
+ * Get signin email provider
224
228
  */
225
229
  getEmailProvider(requestParameters, initOverrides) {
226
230
  return __awaiter(this, void 0, void 0, function* () {
@@ -257,7 +261,7 @@ class SDKApi extends BaseAPI {
257
261
  });
258
262
  }
259
263
  /**
260
- * Find the jwks for the public key for this environment
264
+ * Find jwks for public key
261
265
  */
262
266
  getJwksByEnvironmentIdRaw(requestParameters, initOverrides) {
263
267
  return __awaiter(this, void 0, void 0, function* () {
@@ -276,7 +280,7 @@ class SDKApi extends BaseAPI {
276
280
  });
277
281
  }
278
282
  /**
279
- * Find the jwks for the public key for this environment
283
+ * Find jwks for public key
280
284
  */
281
285
  getJwksByEnvironmentId(requestParameters, initOverrides) {
282
286
  return __awaiter(this, void 0, void 0, function* () {
@@ -313,7 +317,7 @@ class SDKApi extends BaseAPI {
313
317
  });
314
318
  }
315
319
  /**
316
- * Creates a nonce for the authentication flow
320
+ * Create nonce for authentication flow
317
321
  */
318
322
  getNonceRaw(requestParameters, initOverrides) {
319
323
  return __awaiter(this, void 0, void 0, function* () {
@@ -332,7 +336,7 @@ class SDKApi extends BaseAPI {
332
336
  });
333
337
  }
334
338
  /**
335
- * Creates a nonce for the authentication flow
339
+ * Create nonce for authentication flow
336
340
  */
337
341
  getNonce(requestParameters, initOverrides) {
338
342
  return __awaiter(this, void 0, void 0, function* () {
@@ -342,6 +346,7 @@ class SDKApi extends BaseAPI {
342
346
  }
343
347
  /**
344
348
  * Find the configuration for the enabled onramps associated to an environment
349
+ * Configuration for enabled onramps
345
350
  */
346
351
  getSupportedOnrampsRaw(requestParameters, initOverrides) {
347
352
  return __awaiter(this, void 0, void 0, function* () {
@@ -379,6 +384,7 @@ class SDKApi extends BaseAPI {
379
384
  }
380
385
  /**
381
386
  * Find the configuration for the enabled onramps associated to an environment
387
+ * Configuration for enabled onramps
382
388
  */
383
389
  getSupportedOnramps(requestParameters, initOverrides) {
384
390
  return __awaiter(this, void 0, void 0, function* () {
@@ -529,6 +535,7 @@ class SDKApi extends BaseAPI {
529
535
  }
530
536
  /**
531
537
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
538
+ * Oauth provider redirect endpoint
532
539
  */
533
540
  oauthRedirectCodeRaw(requestParameters, initOverrides) {
534
541
  return __awaiter(this, void 0, void 0, function* () {
@@ -563,6 +570,7 @@ class SDKApi extends BaseAPI {
563
570
  }
564
571
  /**
565
572
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
573
+ * Oauth provider redirect endpoint
566
574
  */
567
575
  oauthRedirectCode(requestParameters, initOverrides) {
568
576
  return __awaiter(this, void 0, void 0, function* () {
@@ -602,6 +610,7 @@ class SDKApi extends BaseAPI {
602
610
  }
603
611
  /**
604
612
  * Standard OAuth verify callback to exchange temproary code for oauth access
613
+ * Oauth provider verify endpoint
605
614
  */
606
615
  oauthVerifyRaw(requestParameters, initOverrides) {
607
616
  return __awaiter(this, void 0, void 0, function* () {
@@ -629,6 +638,7 @@ class SDKApi extends BaseAPI {
629
638
  }
630
639
  /**
631
640
  * Standard OAuth verify callback to exchange temproary code for oauth access
641
+ * Oauth provider verify endpoint
632
642
  */
633
643
  oauthVerify(requestParameters, initOverrides) {
634
644
  return __awaiter(this, void 0, void 0, function* () {
@@ -722,6 +732,7 @@ class SDKApi extends BaseAPI {
722
732
  }
723
733
  /**
724
734
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
735
+ * prefetch information for wallet address
725
736
  */
726
737
  prefetchRaw(requestParameters, initOverrides) {
727
738
  return __awaiter(this, void 0, void 0, function* () {
@@ -746,6 +757,7 @@ class SDKApi extends BaseAPI {
746
757
  }
747
758
  /**
748
759
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
760
+ * prefetch information for wallet address
749
761
  */
750
762
  prefetch(requestParameters, initOverrides) {
751
763
  return __awaiter(this, void 0, void 0, function* () {
@@ -847,7 +859,7 @@ class SDKApi extends BaseAPI {
847
859
  });
848
860
  }
849
861
  /**
850
- * Sends a new code for the email verification flow
862
+ * Send new code for email verification
851
863
  */
852
864
  retryEmailVerificationRaw(requestParameters, initOverrides) {
853
865
  return __awaiter(this, void 0, void 0, function* () {
@@ -871,7 +883,7 @@ class SDKApi extends BaseAPI {
871
883
  });
872
884
  }
873
885
  /**
874
- * Sends a new code for the email verification flow
886
+ * Send new code for email verification
875
887
  */
876
888
  retryEmailVerification(requestParameters, initOverrides) {
877
889
  return __awaiter(this, void 0, void 0, function* () {
@@ -907,7 +919,7 @@ class SDKApi extends BaseAPI {
907
919
  });
908
920
  }
909
921
  /**
910
- * Revoke a session from the SDK environment
922
+ * Revoke a session
911
923
  */
912
924
  revokeSessionRaw(requestParameters, initOverrides) {
913
925
  return __awaiter(this, void 0, void 0, function* () {
@@ -933,7 +945,7 @@ class SDKApi extends BaseAPI {
933
945
  });
934
946
  }
935
947
  /**
936
- * Revoke a session from the SDK environment
948
+ * Revoke a session
937
949
  */
938
950
  revokeSession(requestParameters, initOverrides) {
939
951
  return __awaiter(this, void 0, void 0, function* () {
@@ -1020,7 +1032,7 @@ class SDKApi extends BaseAPI {
1020
1032
  });
1021
1033
  }
1022
1034
  /**
1023
- * verify the email and sign in the user
1035
+ * Verify an email and sign in user
1024
1036
  */
1025
1037
  signInWithEmailVerificationRaw(requestParameters, initOverrides) {
1026
1038
  return __awaiter(this, void 0, void 0, function* () {
@@ -1044,7 +1056,7 @@ class SDKApi extends BaseAPI {
1044
1056
  });
1045
1057
  }
1046
1058
  /**
1047
- * verify the email and sign in the user
1059
+ * Verify an email and sign in user
1048
1060
  */
1049
1061
  signInWithEmailVerification(requestParameters, initOverrides) {
1050
1062
  return __awaiter(this, void 0, void 0, function* () {
@@ -1112,7 +1124,7 @@ class SDKApi extends BaseAPI {
1112
1124
  });
1113
1125
  }
1114
1126
  /**
1115
- * Update the user\'s fields
1127
+ * Update a user\'s fields
1116
1128
  */
1117
1129
  updateSelfRaw(requestParameters, initOverrides) {
1118
1130
  return __awaiter(this, void 0, void 0, function* () {
@@ -1143,7 +1155,7 @@ class SDKApi extends BaseAPI {
1143
1155
  });
1144
1156
  }
1145
1157
  /**
1146
- * Update the user\'s fields
1158
+ * Update a user\'s fields
1147
1159
  */
1148
1160
  updateSelf(requestParameters, initOverrides) {
1149
1161
  return __awaiter(this, void 0, void 0, function* () {
@@ -1179,7 +1191,7 @@ class SDKApi extends BaseAPI {
1179
1191
  });
1180
1192
  }
1181
1193
  /**
1182
- * Verifies payload and returns jwt
1194
+ * Verify payload and return JWT
1183
1195
  */
1184
1196
  verifyRaw(requestParameters, initOverrides) {
1185
1197
  return __awaiter(this, void 0, void 0, function* () {
@@ -1203,7 +1215,7 @@ class SDKApi extends BaseAPI {
1203
1215
  });
1204
1216
  }
1205
1217
  /**
1206
- * Verifies payload and returns jwt
1218
+ * Verify payload and return JWT
1207
1219
  */
1208
1220
  verify(requestParameters, initOverrides) {
1209
1221
  return __awaiter(this, void 0, void 0, function* () {
@@ -1212,7 +1224,7 @@ class SDKApi extends BaseAPI {
1212
1224
  });
1213
1225
  }
1214
1226
  /**
1215
- * verify the email verification request
1227
+ * Verify email verification request
1216
1228
  */
1217
1229
  verifyEmailVerificationRaw(requestParameters, initOverrides) {
1218
1230
  return __awaiter(this, void 0, void 0, function* () {
@@ -1243,7 +1255,7 @@ class SDKApi extends BaseAPI {
1243
1255
  });
1244
1256
  }
1245
1257
  /**
1246
- * verify the email verification request
1258
+ * Verify email verification request
1247
1259
  */
1248
1260
  verifyEmailVerification(requestParameters, initOverrides) {
1249
1261
  return __awaiter(this, void 0, void 0, function* () {
@@ -1280,6 +1292,7 @@ class SDKApi extends BaseAPI {
1280
1292
  }
1281
1293
  /**
1282
1294
  * Link a wallet to a valid environment user, and return an updated JWT
1295
+ * Link wallet to user
1283
1296
  */
1284
1297
  verifyLinkRaw(requestParameters, initOverrides) {
1285
1298
  return __awaiter(this, void 0, void 0, function* () {
@@ -1311,6 +1324,7 @@ class SDKApi extends BaseAPI {
1311
1324
  }
1312
1325
  /**
1313
1326
  * Link a wallet to a valid environment user, and return an updated JWT
1327
+ * Link wallet to user
1314
1328
  */
1315
1329
  verifyLink(requestParameters, initOverrides) {
1316
1330
  return __awaiter(this, void 0, void 0, function* () {
@@ -1400,7 +1414,8 @@ class SDKApi extends BaseAPI {
1400
1414
  });
1401
1415
  }
1402
1416
  /**
1403
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1417
+ * Used to link a wallet after user has confirmed transfer to the new account
1418
+ * Verify wallet transfer
1404
1419
  */
1405
1420
  verifyTransferRaw(requestParameters, initOverrides) {
1406
1421
  return __awaiter(this, void 0, void 0, function* () {
@@ -1431,7 +1446,8 @@ class SDKApi extends BaseAPI {
1431
1446
  });
1432
1447
  }
1433
1448
  /**
1434
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1449
+ * Used to link a wallet after user has confirmed transfer to the new account
1450
+ * Verify wallet transfer
1435
1451
  */
1436
1452
  verifyTransfer(requestParameters, initOverrides) {
1437
1453
  return __awaiter(this, void 0, void 0, function* () {
@@ -1468,6 +1484,7 @@ class SDKApi extends BaseAPI {
1468
1484
  }
1469
1485
  /**
1470
1486
  * Remove a link from to a valid environment user, and return an updated JWT
1487
+ * unlink wallet from user
1471
1488
  */
1472
1489
  verifyUnlinkRaw(requestParameters, initOverrides) {
1473
1490
  return __awaiter(this, void 0, void 0, function* () {
@@ -1499,6 +1516,7 @@ class SDKApi extends BaseAPI {
1499
1516
  }
1500
1517
  /**
1501
1518
  * Remove a link from to a valid environment user, and return an updated JWT
1519
+ * unlink wallet from user
1502
1520
  */
1503
1521
  verifyUnlink(requestParameters, initOverrides) {
1504
1522
  return __awaiter(this, void 0, void 0, function* () {
package/src/runtime.cjs CHANGED
@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
5
5
  var _tslib = require('../_virtual/_tslib.cjs');
6
6
 
7
7
  /* tslint:disable */
8
- const BASE_PATH = "https://app.dynamic.xyz/api/v0".replace(/\/+$/, "");
8
+ const BASE_PATH = "https://app.dynamicauth.com/api/v0".replace(/\/+$/, "");
9
9
  const isBlob = (value) => typeof Blob !== 'undefined' && value instanceof Blob;
10
10
  /**
11
11
  * This is the base class for all generated API classes.
package/src/runtime.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import { __awaiter } from '../_virtual/_tslib.js';
2
2
 
3
3
  /* tslint:disable */
4
- const BASE_PATH = "https://app.dynamic.xyz/api/v0".replace(/\/+$/, "");
4
+ const BASE_PATH = "https://app.dynamicauth.com/api/v0".replace(/\/+$/, "");
5
5
  const isBlob = (value) => typeof Blob !== 'undefined' && value instanceof Blob;
6
6
  /**
7
7
  * This is the base class for all generated API classes.