@dynamic-labs/sdk-api 0.0.237 → 0.0.239

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.237",
3
+ "version": "0.0.239",
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* () {
@@ -542,6 +549,9 @@ class SDKApi extends runtime.BaseAPI {
542
549
  if (requestParameters.providerType === null || requestParameters.providerType === undefined) {
543
550
  throw new runtime.RequiredError('providerType', 'Required parameter requestParameters.providerType was null or undefined when calling oauthRedirectCode.');
544
551
  }
552
+ if (requestParameters.code === null || requestParameters.code === undefined) {
553
+ throw new runtime.RequiredError('code', 'Required parameter requestParameters.code was null or undefined when calling oauthRedirectCode.');
554
+ }
545
555
  const queryParameters = {};
546
556
  if (requestParameters.code !== undefined) {
547
557
  queryParameters['code'] = requestParameters.code;
@@ -567,6 +577,7 @@ class SDKApi extends runtime.BaseAPI {
567
577
  }
568
578
  /**
569
579
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
580
+ * Oauth provider redirect endpoint
570
581
  */
571
582
  oauthRedirectCode(requestParameters, initOverrides) {
572
583
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -606,6 +617,7 @@ class SDKApi extends runtime.BaseAPI {
606
617
  }
607
618
  /**
608
619
  * Standard OAuth verify callback to exchange temproary code for oauth access
620
+ * Oauth provider verify endpoint
609
621
  */
610
622
  oauthVerifyRaw(requestParameters, initOverrides) {
611
623
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -633,6 +645,7 @@ class SDKApi extends runtime.BaseAPI {
633
645
  }
634
646
  /**
635
647
  * Standard OAuth verify callback to exchange temproary code for oauth access
648
+ * Oauth provider verify endpoint
636
649
  */
637
650
  oauthVerify(requestParameters, initOverrides) {
638
651
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -726,6 +739,7 @@ class SDKApi extends runtime.BaseAPI {
726
739
  }
727
740
  /**
728
741
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
742
+ * prefetch information for wallet address
729
743
  */
730
744
  prefetchRaw(requestParameters, initOverrides) {
731
745
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -750,6 +764,7 @@ class SDKApi extends runtime.BaseAPI {
750
764
  }
751
765
  /**
752
766
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
767
+ * prefetch information for wallet address
753
768
  */
754
769
  prefetch(requestParameters, initOverrides) {
755
770
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -851,7 +866,7 @@ class SDKApi extends runtime.BaseAPI {
851
866
  });
852
867
  }
853
868
  /**
854
- * Sends a new code for the email verification flow
869
+ * Send new code for email verification
855
870
  */
856
871
  retryEmailVerificationRaw(requestParameters, initOverrides) {
857
872
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -875,7 +890,7 @@ class SDKApi extends runtime.BaseAPI {
875
890
  });
876
891
  }
877
892
  /**
878
- * Sends a new code for the email verification flow
893
+ * Send new code for email verification
879
894
  */
880
895
  retryEmailVerification(requestParameters, initOverrides) {
881
896
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -911,7 +926,7 @@ class SDKApi extends runtime.BaseAPI {
911
926
  });
912
927
  }
913
928
  /**
914
- * Revoke a session from the SDK environment
929
+ * Revoke a session
915
930
  */
916
931
  revokeSessionRaw(requestParameters, initOverrides) {
917
932
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -937,7 +952,7 @@ class SDKApi extends runtime.BaseAPI {
937
952
  });
938
953
  }
939
954
  /**
940
- * Revoke a session from the SDK environment
955
+ * Revoke a session
941
956
  */
942
957
  revokeSession(requestParameters, initOverrides) {
943
958
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1024,7 +1039,7 @@ class SDKApi extends runtime.BaseAPI {
1024
1039
  });
1025
1040
  }
1026
1041
  /**
1027
- * verify the email and sign in the user
1042
+ * Verify an email and sign in user
1028
1043
  */
1029
1044
  signInWithEmailVerificationRaw(requestParameters, initOverrides) {
1030
1045
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1048,7 +1063,7 @@ class SDKApi extends runtime.BaseAPI {
1048
1063
  });
1049
1064
  }
1050
1065
  /**
1051
- * verify the email and sign in the user
1066
+ * Verify an email and sign in user
1052
1067
  */
1053
1068
  signInWithEmailVerification(requestParameters, initOverrides) {
1054
1069
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1116,7 +1131,7 @@ class SDKApi extends runtime.BaseAPI {
1116
1131
  });
1117
1132
  }
1118
1133
  /**
1119
- * Update the user\'s fields
1134
+ * Update a user\'s fields
1120
1135
  */
1121
1136
  updateSelfRaw(requestParameters, initOverrides) {
1122
1137
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1147,7 +1162,7 @@ class SDKApi extends runtime.BaseAPI {
1147
1162
  });
1148
1163
  }
1149
1164
  /**
1150
- * Update the user\'s fields
1165
+ * Update a user\'s fields
1151
1166
  */
1152
1167
  updateSelf(requestParameters, initOverrides) {
1153
1168
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1183,7 +1198,7 @@ class SDKApi extends runtime.BaseAPI {
1183
1198
  });
1184
1199
  }
1185
1200
  /**
1186
- * Verifies payload and returns jwt
1201
+ * Verify payload and return JWT
1187
1202
  */
1188
1203
  verifyRaw(requestParameters, initOverrides) {
1189
1204
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1207,7 +1222,7 @@ class SDKApi extends runtime.BaseAPI {
1207
1222
  });
1208
1223
  }
1209
1224
  /**
1210
- * Verifies payload and returns jwt
1225
+ * Verify payload and return JWT
1211
1226
  */
1212
1227
  verify(requestParameters, initOverrides) {
1213
1228
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1216,7 +1231,7 @@ class SDKApi extends runtime.BaseAPI {
1216
1231
  });
1217
1232
  }
1218
1233
  /**
1219
- * verify the email verification request
1234
+ * Verify email verification request
1220
1235
  */
1221
1236
  verifyEmailVerificationRaw(requestParameters, initOverrides) {
1222
1237
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1247,7 +1262,7 @@ class SDKApi extends runtime.BaseAPI {
1247
1262
  });
1248
1263
  }
1249
1264
  /**
1250
- * verify the email verification request
1265
+ * Verify email verification request
1251
1266
  */
1252
1267
  verifyEmailVerification(requestParameters, initOverrides) {
1253
1268
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1284,6 +1299,7 @@ class SDKApi extends runtime.BaseAPI {
1284
1299
  }
1285
1300
  /**
1286
1301
  * Link a wallet to a valid environment user, and return an updated JWT
1302
+ * Link wallet to user
1287
1303
  */
1288
1304
  verifyLinkRaw(requestParameters, initOverrides) {
1289
1305
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1315,6 +1331,7 @@ class SDKApi extends runtime.BaseAPI {
1315
1331
  }
1316
1332
  /**
1317
1333
  * Link a wallet to a valid environment user, and return an updated JWT
1334
+ * Link wallet to user
1318
1335
  */
1319
1336
  verifyLink(requestParameters, initOverrides) {
1320
1337
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1404,7 +1421,8 @@ class SDKApi extends runtime.BaseAPI {
1404
1421
  });
1405
1422
  }
1406
1423
  /**
1407
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1424
+ * Used to link a wallet after user has confirmed transfer to the new account
1425
+ * Verify wallet transfer
1408
1426
  */
1409
1427
  verifyTransferRaw(requestParameters, initOverrides) {
1410
1428
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1435,7 +1453,8 @@ class SDKApi extends runtime.BaseAPI {
1435
1453
  });
1436
1454
  }
1437
1455
  /**
1438
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1456
+ * Used to link a wallet after user has confirmed transfer to the new account
1457
+ * Verify wallet transfer
1439
1458
  */
1440
1459
  verifyTransfer(requestParameters, initOverrides) {
1441
1460
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1472,6 +1491,7 @@ class SDKApi extends runtime.BaseAPI {
1472
1491
  }
1473
1492
  /**
1474
1493
  * Remove a link from to a valid environment user, and return an updated JWT
1494
+ * unlink wallet from user
1475
1495
  */
1476
1496
  verifyUnlinkRaw(requestParameters, initOverrides) {
1477
1497
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -1503,6 +1523,7 @@ class SDKApi extends runtime.BaseAPI {
1503
1523
  }
1504
1524
  /**
1505
1525
  * Remove a link from to a valid environment user, and return an updated JWT
1526
+ * unlink wallet from user
1506
1527
  */
1507
1528
  verifyUnlink(requestParameters, initOverrides) {
1508
1529
  return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -71,7 +71,7 @@ export interface OauthLoginOptionsRequest {
71
71
  export interface OauthRedirectCodeRequest {
72
72
  environmentId: string;
73
73
  providerType: ProviderEnum;
74
- code?: string;
74
+ code: string;
75
75
  scope?: string;
76
76
  authuser?: string;
77
77
  prompt?: string;
@@ -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* () {
@@ -538,6 +545,9 @@ class SDKApi extends BaseAPI {
538
545
  if (requestParameters.providerType === null || requestParameters.providerType === undefined) {
539
546
  throw new RequiredError('providerType', 'Required parameter requestParameters.providerType was null or undefined when calling oauthRedirectCode.');
540
547
  }
548
+ if (requestParameters.code === null || requestParameters.code === undefined) {
549
+ throw new RequiredError('code', 'Required parameter requestParameters.code was null or undefined when calling oauthRedirectCode.');
550
+ }
541
551
  const queryParameters = {};
542
552
  if (requestParameters.code !== undefined) {
543
553
  queryParameters['code'] = requestParameters.code;
@@ -563,6 +573,7 @@ class SDKApi extends BaseAPI {
563
573
  }
564
574
  /**
565
575
  * Endpoint where an oauth provider would redirect after a successful user authorizing the oauth application.
576
+ * Oauth provider redirect endpoint
566
577
  */
567
578
  oauthRedirectCode(requestParameters, initOverrides) {
568
579
  return __awaiter(this, void 0, void 0, function* () {
@@ -602,6 +613,7 @@ class SDKApi extends BaseAPI {
602
613
  }
603
614
  /**
604
615
  * Standard OAuth verify callback to exchange temproary code for oauth access
616
+ * Oauth provider verify endpoint
605
617
  */
606
618
  oauthVerifyRaw(requestParameters, initOverrides) {
607
619
  return __awaiter(this, void 0, void 0, function* () {
@@ -629,6 +641,7 @@ class SDKApi extends BaseAPI {
629
641
  }
630
642
  /**
631
643
  * Standard OAuth verify callback to exchange temproary code for oauth access
644
+ * Oauth provider verify endpoint
632
645
  */
633
646
  oauthVerify(requestParameters, initOverrides) {
634
647
  return __awaiter(this, void 0, void 0, function* () {
@@ -722,6 +735,7 @@ class SDKApi extends BaseAPI {
722
735
  }
723
736
  /**
724
737
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
738
+ * prefetch information for wallet address
725
739
  */
726
740
  prefetchRaw(requestParameters, initOverrides) {
727
741
  return __awaiter(this, void 0, void 0, function* () {
@@ -746,6 +760,7 @@ class SDKApi extends BaseAPI {
746
760
  }
747
761
  /**
748
762
  * Endpoint to send minimal wallet information to the API to prefetch name service information for an address.
763
+ * prefetch information for wallet address
749
764
  */
750
765
  prefetch(requestParameters, initOverrides) {
751
766
  return __awaiter(this, void 0, void 0, function* () {
@@ -847,7 +862,7 @@ class SDKApi extends BaseAPI {
847
862
  });
848
863
  }
849
864
  /**
850
- * Sends a new code for the email verification flow
865
+ * Send new code for email verification
851
866
  */
852
867
  retryEmailVerificationRaw(requestParameters, initOverrides) {
853
868
  return __awaiter(this, void 0, void 0, function* () {
@@ -871,7 +886,7 @@ class SDKApi extends BaseAPI {
871
886
  });
872
887
  }
873
888
  /**
874
- * Sends a new code for the email verification flow
889
+ * Send new code for email verification
875
890
  */
876
891
  retryEmailVerification(requestParameters, initOverrides) {
877
892
  return __awaiter(this, void 0, void 0, function* () {
@@ -907,7 +922,7 @@ class SDKApi extends BaseAPI {
907
922
  });
908
923
  }
909
924
  /**
910
- * Revoke a session from the SDK environment
925
+ * Revoke a session
911
926
  */
912
927
  revokeSessionRaw(requestParameters, initOverrides) {
913
928
  return __awaiter(this, void 0, void 0, function* () {
@@ -933,7 +948,7 @@ class SDKApi extends BaseAPI {
933
948
  });
934
949
  }
935
950
  /**
936
- * Revoke a session from the SDK environment
951
+ * Revoke a session
937
952
  */
938
953
  revokeSession(requestParameters, initOverrides) {
939
954
  return __awaiter(this, void 0, void 0, function* () {
@@ -1020,7 +1035,7 @@ class SDKApi extends BaseAPI {
1020
1035
  });
1021
1036
  }
1022
1037
  /**
1023
- * verify the email and sign in the user
1038
+ * Verify an email and sign in user
1024
1039
  */
1025
1040
  signInWithEmailVerificationRaw(requestParameters, initOverrides) {
1026
1041
  return __awaiter(this, void 0, void 0, function* () {
@@ -1044,7 +1059,7 @@ class SDKApi extends BaseAPI {
1044
1059
  });
1045
1060
  }
1046
1061
  /**
1047
- * verify the email and sign in the user
1062
+ * Verify an email and sign in user
1048
1063
  */
1049
1064
  signInWithEmailVerification(requestParameters, initOverrides) {
1050
1065
  return __awaiter(this, void 0, void 0, function* () {
@@ -1112,7 +1127,7 @@ class SDKApi extends BaseAPI {
1112
1127
  });
1113
1128
  }
1114
1129
  /**
1115
- * Update the user\'s fields
1130
+ * Update a user\'s fields
1116
1131
  */
1117
1132
  updateSelfRaw(requestParameters, initOverrides) {
1118
1133
  return __awaiter(this, void 0, void 0, function* () {
@@ -1143,7 +1158,7 @@ class SDKApi extends BaseAPI {
1143
1158
  });
1144
1159
  }
1145
1160
  /**
1146
- * Update the user\'s fields
1161
+ * Update a user\'s fields
1147
1162
  */
1148
1163
  updateSelf(requestParameters, initOverrides) {
1149
1164
  return __awaiter(this, void 0, void 0, function* () {
@@ -1179,7 +1194,7 @@ class SDKApi extends BaseAPI {
1179
1194
  });
1180
1195
  }
1181
1196
  /**
1182
- * Verifies payload and returns jwt
1197
+ * Verify payload and return JWT
1183
1198
  */
1184
1199
  verifyRaw(requestParameters, initOverrides) {
1185
1200
  return __awaiter(this, void 0, void 0, function* () {
@@ -1203,7 +1218,7 @@ class SDKApi extends BaseAPI {
1203
1218
  });
1204
1219
  }
1205
1220
  /**
1206
- * Verifies payload and returns jwt
1221
+ * Verify payload and return JWT
1207
1222
  */
1208
1223
  verify(requestParameters, initOverrides) {
1209
1224
  return __awaiter(this, void 0, void 0, function* () {
@@ -1212,7 +1227,7 @@ class SDKApi extends BaseAPI {
1212
1227
  });
1213
1228
  }
1214
1229
  /**
1215
- * verify the email verification request
1230
+ * Verify email verification request
1216
1231
  */
1217
1232
  verifyEmailVerificationRaw(requestParameters, initOverrides) {
1218
1233
  return __awaiter(this, void 0, void 0, function* () {
@@ -1243,7 +1258,7 @@ class SDKApi extends BaseAPI {
1243
1258
  });
1244
1259
  }
1245
1260
  /**
1246
- * verify the email verification request
1261
+ * Verify email verification request
1247
1262
  */
1248
1263
  verifyEmailVerification(requestParameters, initOverrides) {
1249
1264
  return __awaiter(this, void 0, void 0, function* () {
@@ -1280,6 +1295,7 @@ class SDKApi extends BaseAPI {
1280
1295
  }
1281
1296
  /**
1282
1297
  * Link a wallet to a valid environment user, and return an updated JWT
1298
+ * Link wallet to user
1283
1299
  */
1284
1300
  verifyLinkRaw(requestParameters, initOverrides) {
1285
1301
  return __awaiter(this, void 0, void 0, function* () {
@@ -1311,6 +1327,7 @@ class SDKApi extends BaseAPI {
1311
1327
  }
1312
1328
  /**
1313
1329
  * Link a wallet to a valid environment user, and return an updated JWT
1330
+ * Link wallet to user
1314
1331
  */
1315
1332
  verifyLink(requestParameters, initOverrides) {
1316
1333
  return __awaiter(this, void 0, void 0, function* () {
@@ -1400,7 +1417,8 @@ class SDKApi extends BaseAPI {
1400
1417
  });
1401
1418
  }
1402
1419
  /**
1403
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1420
+ * Used to link a wallet after user has confirmed transfer to the new account
1421
+ * Verify wallet transfer
1404
1422
  */
1405
1423
  verifyTransferRaw(requestParameters, initOverrides) {
1406
1424
  return __awaiter(this, void 0, void 0, function* () {
@@ -1431,7 +1449,8 @@ class SDKApi extends BaseAPI {
1431
1449
  });
1432
1450
  }
1433
1451
  /**
1434
- * This is a subsequent call to link a wallet after user has confirmed transfer to the new account
1452
+ * Used to link a wallet after user has confirmed transfer to the new account
1453
+ * Verify wallet transfer
1435
1454
  */
1436
1455
  verifyTransfer(requestParameters, initOverrides) {
1437
1456
  return __awaiter(this, void 0, void 0, function* () {
@@ -1468,6 +1487,7 @@ class SDKApi extends BaseAPI {
1468
1487
  }
1469
1488
  /**
1470
1489
  * Remove a link from to a valid environment user, and return an updated JWT
1490
+ * unlink wallet from user
1471
1491
  */
1472
1492
  verifyUnlinkRaw(requestParameters, initOverrides) {
1473
1493
  return __awaiter(this, void 0, void 0, function* () {
@@ -1499,6 +1519,7 @@ class SDKApi extends BaseAPI {
1499
1519
  }
1500
1520
  /**
1501
1521
  * Remove a link from to a valid environment user, and return an updated JWT
1522
+ * unlink wallet from user
1502
1523
  */
1503
1524
  verifyUnlink(requestParameters, initOverrides) {
1504
1525
  return __awaiter(this, void 0, void 0, function* () {