skapi-js 1.5.6 → 1.5.7

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/dist/skapi.d.mts CHANGED
@@ -838,6 +838,10 @@ declare class Skapi {
838
838
  token: string;
839
839
  id: string;
840
840
  merge?: boolean | string[];
841
+ template?: {
842
+ /** message_id of the template to use for the welcome e-mail (sent the first time this OpenID user account is created). */
843
+ welcome?: string;
844
+ };
841
845
  }): Promise<{
842
846
  userProfile: UserProfile;
843
847
  openid: {
@@ -1425,6 +1429,12 @@ declare class Skapi {
1425
1429
  * Automatically login to account after signup. Will not work if signup confirmation is required.
1426
1430
  */
1427
1431
  login?: boolean;
1432
+ template?: {
1433
+ /** message_id of the template to use for the signup confirmation e-mail. */
1434
+ signup_confirmation?: string;
1435
+ /** message_id of the template to use for the welcome e-mail (sent on the user's first confirmed login). */
1436
+ welcome?: string;
1437
+ };
1428
1438
  }): Promise<UserProfile | "SUCCESS: The account has been created. User's signup confirmation is required." | 'SUCCESS: The account has been created.'>;
1429
1439
  /**
1430
1440
  * Resets a password using email, verification code, and new password.
@@ -1446,7 +1456,11 @@ declare class Skapi {
1446
1456
  */
1447
1457
  verifyEmail(params?: Form<{
1448
1458
  code: string;
1449
- }>): Promise<string>;
1459
+ }>, options?: {
1460
+ template?: {
1461
+ verification?: string;
1462
+ };
1463
+ }): Promise<string>;
1450
1464
  /**
1451
1465
  * Verifies the user phone number with a confirmation code.
1452
1466
  * @param params Payload for the request.
@@ -1454,7 +1468,11 @@ declare class Skapi {
1454
1468
  */
1455
1469
  verifyPhoneNumber(params?: Form<{
1456
1470
  code: string;
1457
- }>): Promise<string>;
1471
+ }>, options?: {
1472
+ template?: {
1473
+ verification?: string;
1474
+ };
1475
+ }): Promise<string>;
1458
1476
  /**
1459
1477
  * Sends a password reset verification code to the user email.
1460
1478
  * @param params Payload for the request.
@@ -1463,7 +1481,12 @@ declare class Skapi {
1463
1481
  forgotPassword(params: Form<{
1464
1482
  /** Signin E-Mail. */
1465
1483
  email: string;
1466
- }>): Promise<'SUCCESS: Verification code has been sent.'>;
1484
+ }>, options?: {
1485
+ template?: {
1486
+ /** message_id of the template to use for the password-reset verification e-mail. */
1487
+ verification?: string;
1488
+ };
1489
+ }): Promise<'SUCCESS: Verification code has been sent.'>;
1467
1490
  /**
1468
1491
  * Changes password for the authenticated user.
1469
1492
  * @param params Request parameters.
package/dist/skapi.d.ts CHANGED
@@ -838,6 +838,10 @@ declare class Skapi {
838
838
  token: string;
839
839
  id: string;
840
840
  merge?: boolean | string[];
841
+ template?: {
842
+ /** message_id of the template to use for the welcome e-mail (sent the first time this OpenID user account is created). */
843
+ welcome?: string;
844
+ };
841
845
  }): Promise<{
842
846
  userProfile: UserProfile;
843
847
  openid: {
@@ -1425,6 +1429,12 @@ declare class Skapi {
1425
1429
  * Automatically login to account after signup. Will not work if signup confirmation is required.
1426
1430
  */
1427
1431
  login?: boolean;
1432
+ template?: {
1433
+ /** message_id of the template to use for the signup confirmation e-mail. */
1434
+ signup_confirmation?: string;
1435
+ /** message_id of the template to use for the welcome e-mail (sent on the user's first confirmed login). */
1436
+ welcome?: string;
1437
+ };
1428
1438
  }): Promise<UserProfile | "SUCCESS: The account has been created. User's signup confirmation is required." | 'SUCCESS: The account has been created.'>;
1429
1439
  /**
1430
1440
  * Resets a password using email, verification code, and new password.
@@ -1446,7 +1456,11 @@ declare class Skapi {
1446
1456
  */
1447
1457
  verifyEmail(params?: Form<{
1448
1458
  code: string;
1449
- }>): Promise<string>;
1459
+ }>, options?: {
1460
+ template?: {
1461
+ verification?: string;
1462
+ };
1463
+ }): Promise<string>;
1450
1464
  /**
1451
1465
  * Verifies the user phone number with a confirmation code.
1452
1466
  * @param params Payload for the request.
@@ -1454,7 +1468,11 @@ declare class Skapi {
1454
1468
  */
1455
1469
  verifyPhoneNumber(params?: Form<{
1456
1470
  code: string;
1457
- }>): Promise<string>;
1471
+ }>, options?: {
1472
+ template?: {
1473
+ verification?: string;
1474
+ };
1475
+ }): Promise<string>;
1458
1476
  /**
1459
1477
  * Sends a password reset verification code to the user email.
1460
1478
  * @param params Payload for the request.
@@ -1463,7 +1481,12 @@ declare class Skapi {
1463
1481
  forgotPassword(params: Form<{
1464
1482
  /** Signin E-Mail. */
1465
1483
  email: string;
1466
- }>): Promise<'SUCCESS: Verification code has been sent.'>;
1484
+ }>, options?: {
1485
+ template?: {
1486
+ /** message_id of the template to use for the password-reset verification e-mail. */
1487
+ verification?: string;
1488
+ };
1489
+ }): Promise<'SUCCESS: Verification code has been sent.'>;
1467
1490
  /**
1468
1491
  * Changes password for the authenticated user.
1469
1492
  * @param params Request parameters.