@workos-inc/node 3.4.0 → 3.5.0

package/lib/users/interfaces/index.d.ts

@@ -4,7 +4,6 @@ export * from './authenticate-user-with-password-options.interface';
 export * from './authenticate-user-with-token-options.interface';
 export * from './authentication-response.interface';
 export * from './complete-password-reset-options.interface';
-export * from './create-email-verification-challenge-options.interface';
 export * from './create-password-reset-challenge-options.interface';
 export * from './create-user-options.interface';
 export * from './delete-user-options.interface';
@@ -13,8 +12,9 @@ export * from './list-users-options.interface';
 export * from './magic-auth-challenge.interface';
 export * from './remove-user-from-organization-options.interface';
 export * from './send-magic-auth-code-options.interface';
+export * from './send-verification-email-options';
 export * from './session.interface';
 export * from './update-user-options.interface';
 export * from './update-user-password-options.interface';
 export * from './user.interface';
-export * from './verify-email-options.interface';
+export * from './verify-email-code-options.interface';

package/lib/users/interfaces/index.js

@@ -20,7 +20,6 @@ __exportStar(require("./authenticate-user-with-password-options.interface"), exp
 __exportStar(require("./authenticate-user-with-token-options.interface"), exports);
 __exportStar(require("./authentication-response.interface"), exports);
 __exportStar(require("./complete-password-reset-options.interface"), exports);
-__exportStar(require("./create-email-verification-challenge-options.interface"), exports);
 __exportStar(require("./create-password-reset-challenge-options.interface"), exports);
 __exportStar(require("./create-user-options.interface"), exports);
 __exportStar(require("./delete-user-options.interface"), exports);
@@ -29,8 +28,9 @@ __exportStar(require("./list-users-options.interface"), exports);
 __exportStar(require("./magic-auth-challenge.interface"), exports);
 __exportStar(require("./remove-user-from-organization-options.interface"), exports);
 __exportStar(require("./send-magic-auth-code-options.interface"), exports);
+__exportStar(require("./send-verification-email-options"), exports);
 __exportStar(require("./session.interface"), exports);
 __exportStar(require("./update-user-options.interface"), exports);
 __exportStar(require("./update-user-password-options.interface"), exports);
 __exportStar(require("./user.interface"), exports);
-__exportStar(require("./verify-email-options.interface"), exports);
+__exportStar(require("./verify-email-code-options.interface"), exports);

package/lib/users/interfaces/send-verification-email-options.d.ts

@@ -0,0 +1,3 @@
+export interface SendVerificationEmailOptions {
+    userId: string;
+}

package/lib/users/interfaces/verify-email-code-options.interface.d.ts

@@ -0,0 +1,7 @@
+export interface VerifyEmailCodeOptions {
+    code: string;
+    userId: string;
+}
+export interface SerializedVerifyEmailCodeOptions {
+    code: string;
+}

package/lib/users/serializers/index.d.ts

@@ -3,7 +3,6 @@ export * from './authenticate-user-with-magic-auth-options.serializer';
 export * from './authenticate-user-with-password-options.serializer';
 export * from './authentication-response.serializer';
 export * from './complete-password-reset-options.serializer';
-export * from './create-email-verification-challenge.serializer';
 export * from './create-password-reset-challenge.serializer';
 export * from './create-user-options.serializer';
 export * from './send-magic-auth-code-options.serializer';

package/lib/users/serializers/index.js

@@ -19,7 +19,6 @@ __exportStar(require("./authenticate-user-with-magic-auth-options.serializer"),
 __exportStar(require("./authenticate-user-with-password-options.serializer"), exports);
 __exportStar(require("./authentication-response.serializer"), exports);
 __exportStar(require("./complete-password-reset-options.serializer"), exports);
-__exportStar(require("./create-email-verification-challenge.serializer"), exports);
 __exportStar(require("./create-password-reset-challenge.serializer"), exports);
 __exportStar(require("./create-user-options.serializer"), exports);
 __exportStar(require("./send-magic-auth-code-options.serializer"), exports);

package/lib/users/users.d.ts

@@ -1,6 +1,6 @@
 import { WorkOS } from '../workos';
 import { AutoPaginatable } from '../common/utils/pagination';
-import { AddUserToOrganizationOptions, AuthenticateUserWithCodeOptions, AuthenticateUserWithMagicAuthOptions, AuthenticateUserWithPasswordOptions, AuthenticationResponse, CompletePasswordResetOptions, CreateEmailVerificationChallengeOptions, CreateEmailVerificationChallengeResponse, CreatePasswordResetChallengeOptions, CreatePasswordResetChallengeResponse, CreateUserOptions, DeleteUserOptions, EnrollUserInMfaFactorOptions, ListUsersOptions, MagicAuthChallenge, RemoveUserFromOrganizationOptions, SendMagicAuthCodeOptions, UpdateUserOptions, UpdateUserPasswordOptions, User, VerifyEmailOptions } from './interfaces';
+import { AddUserToOrganizationOptions, AuthenticateUserWithCodeOptions, AuthenticateUserWithMagicAuthOptions, AuthenticateUserWithPasswordOptions, AuthenticationResponse, CompletePasswordResetOptions, CreatePasswordResetChallengeOptions, CreatePasswordResetChallengeResponse, CreateUserOptions, DeleteUserOptions, EnrollUserInMfaFactorOptions, ListUsersOptions, RemoveUserFromOrganizationOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, UpdateUserPasswordOptions, User, VerifyEmailCodeOptions } from './interfaces';
 import { Challenge, Factor } from '../mfa/interfaces';
 export declare class Users {
     private readonly workos;
@@ -11,9 +11,13 @@ export declare class Users {
     authenticateUserWithMagicAuth(payload: AuthenticateUserWithMagicAuthOptions): Promise<AuthenticationResponse>;
     authenticateUserWithPassword(payload: AuthenticateUserWithPasswordOptions): Promise<AuthenticationResponse>;
     authenticateUserWithCode(payload: AuthenticateUserWithCodeOptions): Promise<AuthenticationResponse>;
-    createEmailVerificationChallenge({ userId, verificationUrl, }: CreateEmailVerificationChallengeOptions): Promise<CreateEmailVerificationChallengeResponse>;
-    sendMagicAuthCode(options: SendMagicAuthCodeOptions): Promise<MagicAuthChallenge>;
-    verifyEmail({ code, userId }: VerifyEmailOptions): Promise<User>;
+    sendVerificationEmail({ userId, }: SendVerificationEmailOptions): Promise<{
+        user: User;
+    }>;
+    sendMagicAuthCode(options: SendMagicAuthCodeOptions): Promise<{
+        user: User;
+    }>;
+    verifyEmailCode({ code, userId, }: VerifyEmailCodeOptions): Promise<User>;
     createPasswordResetChallenge(payload: CreatePasswordResetChallengeOptions): Promise<CreatePasswordResetChallengeResponse>;
     completePasswordReset(payload: CompletePasswordResetOptions): Promise<User>;
     addUserToOrganization({ userId, organizationId, }: AddUserToOrganizationOptions): Promise<User>;

package/lib/users/users.js

@@ -54,23 +54,21 @@ class Users {
             return (0, serializers_1.deserializeAuthenticationResponse)(data);
         });
     }
-    createEmailVerificationChallenge({ userId, verificationUrl, }) {
+    sendVerificationEmail({ userId, }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post(`/users/${userId}/email_verification_challenge`, {
-                verification_url: verificationUrl,
-            });
-            return (0, serializers_1.deserializeCreateEmailVerificationChallengeResponse)(data);
+            const { data } = yield this.workos.post(`/users/${userId}/send_verification_email`, {});
+            return { user: (0, serializers_1.deserializeUser)(data.user) };
         });
     }
     sendMagicAuthCode(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.post('/users/magic_auth/send', (0, serializers_1.serializeSendMagicAuthCodeOptions)(options));
-            return data;
+            return { user: (0, serializers_1.deserializeUser)(data.user) };
         });
     }
-    verifyEmail({ code, userId }) {
+    verifyEmailCode({ code, userId, }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post(`/users/${userId}/verify_email`, {
+            const { data } = yield this.workos.post(`/users/${userId}/verify_email_code`, {
                 code,
             });
             return (0, serializers_1.deserializeUser)(data);

package/lib/users/users.spec.js

@@ -168,32 +168,38 @@ describe('UserManagement', () => {
             });
         }));
     });
-    describe('createEmailVerificationChallenge', () => {
+    describe('sendVerificationEmail', () => {
         it('sends a Create Email Verification Challenge request', () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onPost(`/users/${userId}/email_verification_challenge`).reply(200, {
-                token: 'email-verification-challenge',
-                user: user_json_1.default,
-            });
-            const resp = yield workos.users.createEmailVerificationChallenge({
+            mock
+                .onPost(`/users/${userId}/send_verification_email`)
+                .reply(200, { user: user_json_1.default });
+            const resp = yield workos.users.sendVerificationEmail({
                 userId,
-                verificationUrl: 'https://example.com/verify-email',
             });
-            expect(mock.history.post[0].url).toEqual(`/users/${userId}/email_verification_challenge`);
+            expect(mock.history.post[0].url).toEqual(`/users/${userId}/send_verification_email`);
             expect(resp).toMatchObject({
-                token: 'email-verification-challenge',
                 user: {
+                    createdAt: '2023-07-18T02:07:19.911Z',
                     email: 'test01@example.com',
+                    emailVerified: true,
+                    firstName: 'Test 01',
+                    id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                    lastName: 'User',
+                    object: 'user',
+                    updatedAt: '2023-07-18T02:07:19.911Z',
                 },
             });
         }));
-        describe('verifyEmail', () => {
+        describe('verifyEmailCode', () => {
             it('sends a Complete Email Verification request', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost(`/users/user_123/verify_email`).reply(200, user_json_1.default);
-                const resp = yield workos.users.verifyEmail({
+                mock
+                    .onPost(`/users/user_123/verify_email_code`)
+                    .reply(200, user_json_1.default);
+                const resp = yield workos.users.verifyEmailCode({
                     userId: 'user_123',
                     code: '123456',
                 });
-                expect(mock.history.post[0].url).toEqual(`/users/user_123/verify_email`);
+                expect(mock.history.post[0].url).toEqual(`/users/user_123/verify_email_code`);
                 expect(resp).toMatchObject({
                     email: 'test01@example.com',
                 });
@@ -207,14 +213,30 @@ describe('UserManagement', () => {
                 email_address: 'bob.loblaw@example.com',
             })
                 .reply(200, {
-                id: 'auth_challenge_01E4ZCR3C56J083X43JQXF3JK5',
+                user: {
+                    object: 'user',
+                    email: 'test01@example.com',
+                    first_name: 'Test 01',
+                    last_name: 'User',
+                    email_verified: true,
+                    created_at: '2023-07-18T02:07:19.911Z',
+                    updated_at: '2023-07-18T02:07:19.911Z',
+                },
             });
             const response = yield workos.users.sendMagicAuthCode({
                 emailAddress: 'bob.loblaw@example.com',
             });
             expect(mock.history.post[0].url).toEqual('/users/magic_auth/send');
             expect(response).toMatchObject({
-                id: 'auth_challenge_01E4ZCR3C56J083X43JQXF3JK5',
+                user: {
+                    object: 'user',
+                    email: 'test01@example.com',
+                    firstName: 'Test 01',
+                    lastName: 'User',
+                    emailVerified: true,
+                    createdAt: '2023-07-18T02:07:19.911Z',
+                    updatedAt: '2023-07-18T02:07:19.911Z',
+                },
             });
         }));
     });

package/lib/workos.js

@@ -27,7 +27,7 @@ const mfa_1 = require("./mfa/mfa");
 const audit_logs_1 = require("./audit-logs/audit-logs");
 const users_1 = require("./users/users");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
-const VERSION = '3.4.0';
+const VERSION = '3.5.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.4.0",
+  "version": "3.5.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",

package/lib/users/interfaces/create-email-verification-challenge-options.interface.d.ts

@@ -1,16 +0,0 @@
-import { User, UserResponse } from './user.interface';
-export interface CreateEmailVerificationChallengeOptions {
-    userId: string;
-    verificationUrl: string;
-}
-export interface SerializedCreateEmailVerificationChallengeOptions {
-    verification_url: string;
-}
-export interface CreateEmailVerificationChallengeResponse {
-    token: string;
-    user: User;
-}
-export interface CreateEmailVerificationChallengeResponseResponse {
-    token: string;
-    user: UserResponse;
-}

package/lib/users/interfaces/verify-email-options.interface.d.ts

@@ -1,7 +0,0 @@
-export interface VerifyEmailOptions {
-    code: string;
-    userId: string;
-}
-export interface SerializedVerifyEmailOptions {
-    code: string;
-}

package/lib/users/serializers/create-email-verification-challenge.serializer.d.ts

@@ -1,2 +0,0 @@
-import { CreateEmailVerificationChallengeResponse, CreateEmailVerificationChallengeResponseResponse } from '../interfaces';
-export declare const deserializeCreateEmailVerificationChallengeResponse: (createEmailVerificationChallengeResponse: CreateEmailVerificationChallengeResponseResponse) => CreateEmailVerificationChallengeResponse;

package/lib/users/serializers/create-email-verification-challenge.serializer.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeCreateEmailVerificationChallengeResponse = void 0;
-const user_serializer_1 = require("./user.serializer");
-const deserializeCreateEmailVerificationChallengeResponse = (createEmailVerificationChallengeResponse) => ({
-    token: createEmailVerificationChallengeResponse.token,
-    user: (0, user_serializer_1.deserializeUser)(createEmailVerificationChallengeResponse.user),
-});
-exports.deserializeCreateEmailVerificationChallengeResponse = deserializeCreateEmailVerificationChallengeResponse;