@workos-inc/node 3.6.0 → 3.7.0

package/lib/users/fixtures/list-factors.json

@@ -0,0 +1,23 @@
+{
+    "object": "list",
+    "data": [
+        {
+            "object": "authentication_factor",
+            "id": "auth_factor_1234",
+            "created_at": "2022-03-15T20:39:19.892Z",
+            "updated_at": "2022-03-15T20:39:19.892Z",
+            "type": "totp",
+            "totp": {
+                "issuer": "WorkOS",
+                "qr_code": "qr-code-test",
+                "secret": "secret-test",
+                "uri": "uri-test",
+                "user": "some_user"
+            }
+        }
+    ],
+    "list_metadata": {
+        "before": null,
+        "after": null
+    }
+}

package/lib/users/interfaces/{authenticate-user-with-token-options.interface.d.ts → authenticate-with-code-options.interface.d.ts}

@@ -1,13 +1,17 @@
-export interface AuthenticateUserWithCodeOptions {
+export interface AuthenticateWithCodeOptions {
     clientId: string;
     code: string;
+    ipAddress?: string;
+    userAgent?: string;
 }
 export interface AuthenticateUserWithCodeCredentials {
     clientSecret: string | undefined;
 }
-export interface SerializedAuthenticateUserWithCodeOptions {
+export interface SerializedAuthenticateWithCodeOptions {
     grant_type: 'authorization_code';
     client_id: string;
     client_secret: string | undefined;
     code: string;
+    ip_address?: string;
+    user_agent?: string;
 }

package/lib/users/interfaces/{authenticate-user-with-magic-auth-options.interface.d.ts → authenticate-with-magic-auth-options.interface.d.ts}

@@ -1,19 +1,19 @@
-export interface AuthenticateUserWithMagicAuthOptions {
+export interface AuthenticateWithMagicAuthOptions {
     clientId: string;
     code: string;
-    magicAuthChallengeId: string;
+    userId: string;
     ipAddress?: string;
     userAgent?: string;
 }
 export interface AuthenticateUserWithMagicAuthCredentials {
     clientSecret: string | undefined;
 }
-export interface SerializedAuthenticateUserWithMagicAuthOptions {
+export interface SerializedAuthenticateWithMagicAuthOptions {
     grant_type: 'urn:workos:oauth:grant-type:magic-auth:code';
     client_id: string;
     client_secret: string | undefined;
     code: string;
-    magic_auth_challenge_id: string;
+    user_id: string;
     ip_address?: string;
     user_agent?: string;
 }

package/lib/users/interfaces/{authenticate-user-with-password-options.interface.d.ts → authenticate-with-password-options.interface.d.ts}

@@ -1,4 +1,4 @@
-export interface AuthenticateUserWithPasswordOptions {
+export interface AuthenticateWithPasswordOptions {
     clientId: string;
     email: string;
     password: string;
@@ -8,7 +8,7 @@ export interface AuthenticateUserWithPasswordOptions {
 export interface AuthenticateUserWithPasswordCredentials {
     clientSecret: string | undefined;
 }
-export interface SerializedAuthenticateUserWithPasswordOptions {
+export interface SerializedAuthenticateWithPasswordOptions {
     grant_type: 'password';
     client_id: string;
     client_secret: string | undefined;

package/lib/users/interfaces/authenticate-with-totp-options.interface.d.ts

@@ -0,0 +1,21 @@
+export interface AuthenticateWithTotpOptions {
+    clientId: string;
+    code: string;
+    pendingAuthenticationToken: string;
+    authenticationChallengeId: string;
+    ipAddress?: string;
+    userAgent?: string;
+}
+export interface AuthenticateUserWithTotpCredentials {
+    clientSecret: string | undefined;
+}
+export interface SerializedAuthenticateWithTotpOptions {
+    grant_type: 'urn:workos:oauth:grant-type:mfa-totp';
+    client_id: string;
+    client_secret: string | undefined;
+    code: string;
+    pending_authentication_token: string;
+    authentication_challenge_id: string;
+    ip_address?: string;
+    user_agent?: string;
+}

package/lib/users/interfaces/{enroll-user-in-mfa-factor.interface.d.ts → enroll-auth-factor.interface.d.ts}

@@ -1,4 +1,4 @@
-export interface EnrollUserInMfaFactorOptions {
+export interface EnrollAuthFactorOptions {
     userId: string;
     type: 'totp';
     totpIssuer: string;

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

@@ -1,15 +1,16 @@
 export * from './add-user-to-organization-options.interface';
-export * from './authenticate-user-with-magic-auth-options.interface';
-export * from './authenticate-user-with-password-options.interface';
-export * from './authenticate-user-with-token-options.interface';
+export * from './authenticate-with-magic-auth-options.interface';
+export * from './authenticate-with-password-options.interface';
+export * from './authenticate-with-code-options.interface';
+export * from './authenticate-with-totp-options.interface';
 export * from './authentication-response.interface';
-export * from './complete-password-reset-options.interface';
-export * from './create-password-reset-challenge-options.interface';
+export * from './reset-password-options.interface';
+export * from './send-password-reset-options.interface';
 export * from './create-user-options.interface';
 export * from './delete-user-options.interface';
-export * from './enroll-user-in-mfa-factor.interface';
+export * from './enroll-auth-factor.interface';
 export * from './list-users-options.interface';
-export * from './magic-auth-challenge.interface';
+export * from './list-auth-factors-options.interface';
 export * from './remove-user-from-organization-options.interface';
 export * from './send-magic-auth-code-options.interface';
 export * from './send-verification-email-options';

package/lib/users/interfaces/index.js

@@ -15,17 +15,18 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./add-user-to-organization-options.interface"), exports);
-__exportStar(require("./authenticate-user-with-magic-auth-options.interface"), exports);
-__exportStar(require("./authenticate-user-with-password-options.interface"), exports);
-__exportStar(require("./authenticate-user-with-token-options.interface"), exports);
+__exportStar(require("./authenticate-with-magic-auth-options.interface"), exports);
+__exportStar(require("./authenticate-with-password-options.interface"), exports);
+__exportStar(require("./authenticate-with-code-options.interface"), exports);
+__exportStar(require("./authenticate-with-totp-options.interface"), exports);
 __exportStar(require("./authentication-response.interface"), exports);
-__exportStar(require("./complete-password-reset-options.interface"), exports);
-__exportStar(require("./create-password-reset-challenge-options.interface"), exports);
+__exportStar(require("./reset-password-options.interface"), exports);
+__exportStar(require("./send-password-reset-options.interface"), exports);
 __exportStar(require("./create-user-options.interface"), exports);
 __exportStar(require("./delete-user-options.interface"), exports);
-__exportStar(require("./enroll-user-in-mfa-factor.interface"), exports);
+__exportStar(require("./enroll-auth-factor.interface"), exports);
 __exportStar(require("./list-users-options.interface"), exports);
-__exportStar(require("./magic-auth-challenge.interface"), exports);
+__exportStar(require("./list-auth-factors-options.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);

package/lib/users/interfaces/list-auth-factors-options.interface.d.ts

@@ -0,0 +1,4 @@
+import { PaginationOptions } from '../../common/interfaces';
+export interface ListAuthFactorsOptions extends PaginationOptions {
+    userId: string;
+}

package/lib/users/interfaces/reset-password-options.interface.d.ts

@@ -0,0 +1,8 @@
+export interface ResetPasswordOptions {
+    token: string;
+    newPassword: string;
+}
+export interface SerializedResetPasswordOptions {
+    token: string;
+    new_password: string;
+}

package/lib/users/interfaces/send-magic-auth-code-options.interface.d.ts

@@ -1,6 +1,6 @@
 export interface SendMagicAuthCodeOptions {
-    emailAddress: string;
+    email: string;
 }
 export interface SerializedSendMagicAuthCodeOptions {
-    email_address: string;
+    email: string;
 }

package/lib/users/interfaces/{create-password-reset-challenge-options.interface.d.ts → send-password-reset-options.interface.d.ts}

@@ -1,17 +1,17 @@
 import { User, UserResponse } from './user.interface';
-export interface CreatePasswordResetChallengeOptions {
+export interface SendPasswordResetEmailOptions {
     email: string;
     passwordResetUrl: string;
 }
-export interface SerializedCreatePasswordResetChallengeOptions {
+export interface SerializedSendPasswordResetEmailOptions {
     email: string;
     password_reset_url: string;
 }
-export interface CreatePasswordResetChallengeResponse {
+export interface SendPasswordResetEmailResponse {
     token: string;
     user: User;
 }
-export interface CreatePasswordResetChallengeResponseResponse {
+export interface SendPasswordResetEmailResponseResponse {
     token: string;
     user: UserResponse;
 }

package/lib/users/interfaces/send-password-reset-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/users/serializers/authenticate-with-code-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateUserWithCodeCredentials, AuthenticateWithCodeOptions, SerializedAuthenticateWithCodeOptions } from '../interfaces';
+export declare const serializeAuthenticateWithCodeOptions: (options: AuthenticateWithCodeOptions & AuthenticateUserWithCodeCredentials) => SerializedAuthenticateWithCodeOptions;

package/lib/users/serializers/authenticate-with-code-options.serializer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeAuthenticateWithCodeOptions = void 0;
+const serializeAuthenticateWithCodeOptions = (options) => ({
+    grant_type: 'authorization_code',
+    client_id: options.clientId,
+    client_secret: options.clientSecret,
+    code: options.code,
+    ip_address: options.ipAddress,
+    user_agent: options.userAgent,
+});
+exports.serializeAuthenticateWithCodeOptions = serializeAuthenticateWithCodeOptions;

package/lib/users/serializers/authenticate-with-magic-auth-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateUserWithMagicAuthCredentials, AuthenticateWithMagicAuthOptions, SerializedAuthenticateWithMagicAuthOptions } from '../interfaces';
+export declare const serializeAuthenticateWithMagicAuthOptions: (options: AuthenticateWithMagicAuthOptions & AuthenticateUserWithMagicAuthCredentials) => SerializedAuthenticateWithMagicAuthOptions;

package/lib/users/serializers/{authenticate-user-with-magic-auth-options.serializer.js → authenticate-with-magic-auth-options.serializer.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeAuthenticateUserWithMagicAuthOptions = void 0;
-const serializeAuthenticateUserWithMagicAuthOptions = (options) => ({
+exports.serializeAuthenticateWithMagicAuthOptions = void 0;
+const serializeAuthenticateWithMagicAuthOptions = (options) => ({
     grant_type: 'urn:workos:oauth:grant-type:magic-auth:code',
     client_id: options.clientId,
     client_secret: options.clientSecret,
     code: options.code,
-    magic_auth_challenge_id: options.magicAuthChallengeId,
+    user_id: options.userId,
     ip_address: options.ipAddress,
     user_agent: options.userAgent,
 });
-exports.serializeAuthenticateUserWithMagicAuthOptions = serializeAuthenticateUserWithMagicAuthOptions;
+exports.serializeAuthenticateWithMagicAuthOptions = serializeAuthenticateWithMagicAuthOptions;

package/lib/users/serializers/authenticate-with-password-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateUserWithPasswordCredentials, AuthenticateWithPasswordOptions, SerializedAuthenticateWithPasswordOptions } from '../interfaces';
+export declare const serializeAuthenticateWithPasswordOptions: (options: AuthenticateWithPasswordOptions & AuthenticateUserWithPasswordCredentials) => SerializedAuthenticateWithPasswordOptions;

package/lib/users/serializers/{authenticate-user-with-password-options.serializer.js → authenticate-with-password-options.serializer.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeAuthenticateUserWithPasswordOptions = void 0;
-const serializeAuthenticateUserWithPasswordOptions = (options) => ({
+exports.serializeAuthenticateWithPasswordOptions = void 0;
+const serializeAuthenticateWithPasswordOptions = (options) => ({
     grant_type: 'password',
     client_id: options.clientId,
     client_secret: options.clientSecret,
@@ -10,4 +10,4 @@ const serializeAuthenticateUserWithPasswordOptions = (options) => ({
     ip_address: options.ipAddress,
     user_agent: options.userAgent,
 });
-exports.serializeAuthenticateUserWithPasswordOptions = serializeAuthenticateUserWithPasswordOptions;
+exports.serializeAuthenticateWithPasswordOptions = serializeAuthenticateWithPasswordOptions;

package/lib/users/serializers/authenticate-with-totp-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateUserWithTotpCredentials, AuthenticateWithTotpOptions, SerializedAuthenticateWithTotpOptions } from '../interfaces';
+export declare const serializeAuthenticateWithTotpOptions: (options: AuthenticateWithTotpOptions & AuthenticateUserWithTotpCredentials) => SerializedAuthenticateWithTotpOptions;

package/lib/users/serializers/authenticate-with-totp-options.serializer.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeAuthenticateWithTotpOptions = void 0;
+const serializeAuthenticateWithTotpOptions = (options) => ({
+    grant_type: 'urn:workos:oauth:grant-type:mfa-totp',
+    client_id: options.clientId,
+    client_secret: options.clientSecret,
+    code: options.code,
+    authentication_challenge_id: options.authenticationChallengeId,
+    pending_authentication_token: options.pendingAuthenticationToken,
+    ip_address: options.ipAddress,
+    user_agent: options.userAgent,
+});
+exports.serializeAuthenticateWithTotpOptions = serializeAuthenticateWithTotpOptions;

package/lib/users/serializers/enroll-auth-factor-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { EnrollAuthFactorOptions, SerializedEnrollUserInMfaFactorOptions } from '../interfaces';
+export declare const serializeEnrollAuthFactorOptions: (options: EnrollAuthFactorOptions) => SerializedEnrollUserInMfaFactorOptions;

package/lib/users/serializers/enroll-auth-factor-options.serializer.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeEnrollAuthFactorOptions = void 0;
+const serializeEnrollAuthFactorOptions = (options) => ({
+    type: options.type,
+    totp_issuer: options.totpIssuer,
+    totp_user: options.totpUser,
+});
+exports.serializeEnrollAuthFactorOptions = serializeEnrollAuthFactorOptions;

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

@@ -1,9 +1,11 @@
-export * from './authenticate-user-with-code-options.serializer';
-export * from './authenticate-user-with-magic-auth-options.serializer';
-export * from './authenticate-user-with-password-options.serializer';
+export * from './authenticate-with-code-options.serializer';
+export * from './authenticate-with-magic-auth-options.serializer';
+export * from './authenticate-with-password-options.serializer';
+export * from './authenticate-with-totp-options.serializer';
 export * from './authentication-response.serializer';
-export * from './complete-password-reset-options.serializer';
-export * from './create-password-reset-challenge.serializer';
+export * from './enroll-auth-factor-options.serializer';
+export * from './reset-password-options.serializer';
+export * from './send-password-reset-email.serializer';
 export * from './create-user-options.serializer';
 export * from './send-magic-auth-code-options.serializer';
 export * from './update-user-options.serializer';

package/lib/users/serializers/index.js

@@ -14,12 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./authenticate-user-with-code-options.serializer"), exports);
-__exportStar(require("./authenticate-user-with-magic-auth-options.serializer"), exports);
-__exportStar(require("./authenticate-user-with-password-options.serializer"), exports);
+__exportStar(require("./authenticate-with-code-options.serializer"), exports);
+__exportStar(require("./authenticate-with-magic-auth-options.serializer"), exports);
+__exportStar(require("./authenticate-with-password-options.serializer"), exports);
+__exportStar(require("./authenticate-with-totp-options.serializer"), exports);
 __exportStar(require("./authentication-response.serializer"), exports);
-__exportStar(require("./complete-password-reset-options.serializer"), exports);
-__exportStar(require("./create-password-reset-challenge.serializer"), exports);
+__exportStar(require("./enroll-auth-factor-options.serializer"), exports);
+__exportStar(require("./reset-password-options.serializer"), exports);
+__exportStar(require("./send-password-reset-email.serializer"), exports);
 __exportStar(require("./create-user-options.serializer"), exports);
 __exportStar(require("./send-magic-auth-code-options.serializer"), exports);
 __exportStar(require("./update-user-options.serializer"), exports);

package/lib/users/serializers/reset-password-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { ResetPasswordOptions, SerializedResetPasswordOptions } from '../interfaces';
+export declare const serializeResetPasswordOptions: (options: ResetPasswordOptions) => SerializedResetPasswordOptions;

package/lib/users/serializers/reset-password-options.serializer.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeResetPasswordOptions = void 0;
+const serializeResetPasswordOptions = (options) => ({
+    token: options.token,
+    new_password: options.newPassword,
+});
+exports.serializeResetPasswordOptions = serializeResetPasswordOptions;

package/lib/users/serializers/send-magic-auth-code-options.serializer.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializeSendMagicAuthCodeOptions = void 0;
 const serializeSendMagicAuthCodeOptions = (options) => ({
-    email_address: options.emailAddress,
+    email: options.email,
 });
 exports.serializeSendMagicAuthCodeOptions = serializeSendMagicAuthCodeOptions;

package/lib/users/serializers/send-password-reset-email.serializer.d.ts

@@ -0,0 +1,3 @@
+import { SendPasswordResetEmailOptions, SendPasswordResetEmailResponse, SendPasswordResetEmailResponseResponse, SerializedSendPasswordResetEmailOptions } from '../interfaces';
+export declare const deserializeSendPasswordResetEmailResponse: (sendPasswordResetEmailResponse: SendPasswordResetEmailResponseResponse) => SendPasswordResetEmailResponse;
+export declare const serializeSendPasswordResetEmailOptions: (options: SendPasswordResetEmailOptions) => SerializedSendPasswordResetEmailOptions;

package/lib/users/serializers/send-password-reset-email.serializer.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeSendPasswordResetEmailOptions = exports.deserializeSendPasswordResetEmailResponse = void 0;
+const user_serializer_1 = require("./user.serializer");
+const deserializeSendPasswordResetEmailResponse = (sendPasswordResetEmailResponse) => ({
+    token: sendPasswordResetEmailResponse.token,
+    user: (0, user_serializer_1.deserializeUser)(sendPasswordResetEmailResponse.user),
+});
+exports.deserializeSendPasswordResetEmailResponse = deserializeSendPasswordResetEmailResponse;
+const serializeSendPasswordResetEmailOptions = (options) => ({
+    email: options.email,
+    password_reset_url: options.passwordResetUrl,
+});
+exports.serializeSendPasswordResetEmailOptions = serializeSendPasswordResetEmailOptions;

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, CreatePasswordResetChallengeOptions, CreatePasswordResetChallengeResponse, CreateUserOptions, DeleteUserOptions, EnrollUserInMfaFactorOptions, ListUsersOptions, RemoveUserFromOrganizationOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, UpdateUserPasswordOptions, User, VerifyEmailCodeOptions } from './interfaces';
+import { AddUserToOrganizationOptions, AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, SendPasswordResetEmailResponse, CreateUserOptions, DeleteUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, RemoveUserFromOrganizationOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, UpdateUserPasswordOptions, User, VerifyEmailCodeOptions } from './interfaces';
 import { Challenge, Factor } from '../mfa/interfaces';
 export declare class Users {
     private readonly workos;
@@ -8,25 +8,31 @@ export declare class Users {
     getUser(userId: string): Promise<User>;
     listUsers(options?: ListUsersOptions): Promise<AutoPaginatable<User>>;
     createUser(payload: CreateUserOptions): Promise<User>;
-    authenticateUserWithMagicAuth(payload: AuthenticateUserWithMagicAuthOptions): Promise<AuthenticationResponse>;
-    authenticateUserWithPassword(payload: AuthenticateUserWithPasswordOptions): Promise<AuthenticationResponse>;
-    authenticateUserWithCode(payload: AuthenticateUserWithCodeOptions): Promise<AuthenticationResponse>;
+    authenticateWithMagicAuth(payload: AuthenticateWithMagicAuthOptions): Promise<AuthenticationResponse>;
+    authenticateWithPassword(payload: AuthenticateWithPasswordOptions): Promise<AuthenticationResponse>;
+    authenticateWithCode(payload: AuthenticateWithCodeOptions): Promise<AuthenticationResponse>;
+    authenticateWithTotp(payload: AuthenticateWithTotpOptions): Promise<AuthenticationResponse>;
     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>;
+    verifyEmailCode({ code, userId, }: VerifyEmailCodeOptions): Promise<{
+        user: User;
+    }>;
+    sendPasswordResetEmail(payload: SendPasswordResetEmailOptions): Promise<SendPasswordResetEmailResponse>;
+    resetPassword(payload: ResetPasswordOptions): Promise<{
+        user: User;
+    }>;
     addUserToOrganization({ userId, organizationId, }: AddUserToOrganizationOptions): Promise<User>;
     removeUserFromOrganization({ userId, organizationId, }: RemoveUserFromOrganizationOptions): Promise<User>;
     updateUser(payload: UpdateUserOptions): Promise<User>;
     updateUserPassword(payload: UpdateUserPasswordOptions): Promise<User>;
-    enrollUserInMfaFactor(payload: EnrollUserInMfaFactorOptions): Promise<{
+    enrollAuthFactor(payload: EnrollAuthFactorOptions): Promise<{
         authenticationFactor: Factor;
         authenticationChallenge: Challenge;
     }>;
+    listAuthFactors(options: ListAuthFactorsOptions): Promise<AutoPaginatable<Factor>>;
     deleteUser(payload: DeleteUserOptions): Promise<void>;
 }

package/lib/users/users.js

@@ -14,7 +14,6 @@ const pagination_1 = require("../common/utils/pagination");
 const serializers_1 = require("./serializers");
 const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
 const serializers_2 = require("../mfa/serializers");
-const enroll_user_in_mfa_factor_options_serializer_1 = require("./serializers/enroll-user-in-mfa-factor-options.serializer");
 class Users {
     constructor(workos) {
         this.workos = workos;
@@ -36,21 +35,27 @@ class Users {
             return (0, serializers_1.deserializeUser)(data);
         });
     }
-    authenticateUserWithMagicAuth(payload) {
+    authenticateWithMagicAuth(payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/users/authenticate', (0, serializers_1.serializeAuthenticateUserWithMagicAuthOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            const { data } = yield this.workos.post('/users/authenticate', (0, serializers_1.serializeAuthenticateWithMagicAuthOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
             return (0, serializers_1.deserializeAuthenticationResponse)(data);
         });
     }
-    authenticateUserWithPassword(payload) {
+    authenticateWithPassword(payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/users/authenticate', (0, serializers_1.serializeAuthenticateUserWithPasswordOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            const { data } = yield this.workos.post('/users/authenticate', (0, serializers_1.serializeAuthenticateWithPasswordOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
             return (0, serializers_1.deserializeAuthenticationResponse)(data);
         });
     }
-    authenticateUserWithCode(payload) {
+    authenticateWithCode(payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/users/authenticate', (0, serializers_1.serializeAuthenticateUserWithCodeOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            const { data } = yield this.workos.post('/users/authenticate', (0, serializers_1.serializeAuthenticateWithCodeOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            return (0, serializers_1.deserializeAuthenticationResponse)(data);
+        });
+    }
+    authenticateWithTotp(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/users/authenticate', (0, serializers_1.serializeAuthenticateWithTotpOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
             return (0, serializers_1.deserializeAuthenticationResponse)(data);
         });
     }
@@ -71,19 +76,19 @@ class Users {
             const { data } = yield this.workos.post(`/users/${userId}/verify_email_code`, {
                 code,
             });
-            return (0, serializers_1.deserializeUser)(data);
+            return { user: (0, serializers_1.deserializeUser)(data.user) };
         });
     }
-    createPasswordResetChallenge(payload) {
+    sendPasswordResetEmail(payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/users/password_reset_challenge', (0, serializers_1.serializeCreatePasswordResetChallengeOptions)(payload));
-            return (0, serializers_1.deserializeCreatePasswordResetChallengeResponse)(data);
+            const { data } = yield this.workos.post('/users/send_password_reset_email', (0, serializers_1.serializeSendPasswordResetEmailOptions)(payload));
+            return (0, serializers_1.deserializeSendPasswordResetEmailResponse)(data);
         });
     }
-    completePasswordReset(payload) {
+    resetPassword(payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/users/password_reset', (0, serializers_1.serializeCompletePasswordResetOptions)(payload));
-            return (0, serializers_1.deserializeUser)(data);
+            const { data } = yield this.workos.post('/users/password_reset', (0, serializers_1.serializeResetPasswordOptions)(payload));
+            return { user: (0, serializers_1.deserializeUser)(data.user) };
         });
     }
     addUserToOrganization({ userId, organizationId, }) {
@@ -112,15 +117,20 @@ class Users {
             return (0, serializers_1.deserializeUser)(data);
         });
     }
-    enrollUserInMfaFactor(payload) {
+    enrollAuthFactor(payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post(`/users/${payload.userId}/auth/factors`, (0, enroll_user_in_mfa_factor_options_serializer_1.serializeEnrollUserInMfaFactorOptions)(payload));
+            const { data } = yield this.workos.post(`/users/${payload.userId}/auth/factors`, (0, serializers_1.serializeEnrollAuthFactorOptions)(payload));
             return {
                 authenticationFactor: (0, serializers_2.deserializeFactor)(data.authentication_factor),
                 authenticationChallenge: (0, serializers_2.deserializeChallenge)(data.authentication_challenge),
             };
         });
     }
+    listAuthFactors(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new pagination_1.AutoPaginatable(yield (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, `/users/${options.userId}/auth/factors`, serializers_2.deserializeFactor, options), (params) => (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, `/users/${options.userId}/auth/factors`, serializers_2.deserializeFactor, params), options);
+        });
+    }
     deleteUser(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.workos.delete(`/users/${payload.userId}`);

package/lib/users/users.spec.js

@@ -17,6 +17,7 @@ const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
 const workos_1 = require("../workos");
 const user_json_1 = __importDefault(require("./fixtures/user.json"));
 const list_users_json_1 = __importDefault(require("./fixtures/list-users.json"));
+const list_factors_json_1 = __importDefault(require("./fixtures/list-factors.json"));
 const mock = new axios_mock_adapter_1.default(axios_1.default);
 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 const userId = 'user_01H5JQDV7R7ATEYZDEG0W5PRYS';
@@ -100,10 +101,10 @@ describe('UserManagement', () => {
             mock.onPost('/users/authenticate').reply(200, {
                 user: user_json_1.default,
             });
-            const resp = yield workos.users.authenticateUserWithMagicAuth({
+            const resp = yield workos.users.authenticateWithMagicAuth({
                 clientId: 'proj_whatever',
                 code: '123456',
-                magicAuthChallengeId: 'auth_challenge_123',
+                userId: user_json_1.default.id,
             });
             expect(mock.history.post[0].url).toEqual('/users/authenticate');
             expect(resp).toMatchObject({
@@ -118,7 +119,7 @@ describe('UserManagement', () => {
             mock.onPost('/users/authenticate').reply(200, {
                 user: user_json_1.default,
             });
-            const resp = yield workos.users.authenticateUserWithPassword({
+            const resp = yield workos.users.authenticateWithPassword({
                 clientId: 'proj_whatever',
                 email: 'test01@example.com',
                 password: 'extra-secure',
@@ -134,7 +135,7 @@ describe('UserManagement', () => {
     describe('authenticateUserWithCode', () => {
         it('sends a token authentication request', () => __awaiter(void 0, void 0, void 0, function* () {
             mock.onPost('/users/authenticate').reply(200, { user: user_json_1.default });
-            const resp = yield workos.users.authenticateUserWithCode({
+            const resp = yield workos.users.authenticateWithCode({
                 clientId: 'proj_whatever',
                 code: 'or this',
             });
@@ -150,6 +151,31 @@ describe('UserManagement', () => {
             });
         }));
     });
+    describe('authenticateUserWithTotp', () => {
+        it('sends a token authentication request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost('/users/authenticate').reply(200, { user: user_json_1.default });
+            const resp = yield workos.users.authenticateWithTotp({
+                clientId: 'proj_whatever',
+                code: 'or this',
+                authenticationChallengeId: 'auth_challenge_01H96FETXGTW1QMBSBT2T36PW0',
+                pendingAuthenticationToken: 'cTDQJTTkTkkVYxQUlKBIxEsFs',
+            });
+            expect(mock.history.post[0].url).toEqual('/users/authenticate');
+            expect(JSON.parse(mock.history.post[0].data)).toMatchObject({
+                client_id: 'proj_whatever',
+                code: 'or this',
+                client_secret: 'sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU',
+                grant_type: 'urn:workos:oauth:grant-type:mfa-totp',
+                authentication_challenge_id: 'auth_challenge_01H96FETXGTW1QMBSBT2T36PW0',
+                pending_authentication_token: 'cTDQJTTkTkkVYxQUlKBIxEsFs',
+            });
+            expect(resp).toMatchObject({
+                user: {
+                    email: 'test01@example.com',
+                },
+            });
+        }));
+    });
     describe('sendVerificationEmail', () => {
         it('sends a Create Email Verification Challenge request', () => __awaiter(void 0, void 0, void 0, function* () {
             mock
@@ -176,13 +202,13 @@ describe('UserManagement', () => {
             it('sends a Complete Email Verification request', () => __awaiter(void 0, void 0, void 0, function* () {
                 mock
                     .onPost(`/users/user_123/verify_email_code`)
-                    .reply(200, user_json_1.default);
+                    .reply(200, { user: 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_code`);
-                expect(resp).toMatchObject({
+                expect(resp.user).toMatchObject({
                     email: 'test01@example.com',
                 });
             }));
@@ -192,7 +218,7 @@ describe('UserManagement', () => {
         it('sends a Send Magic Auth Code request', () => __awaiter(void 0, void 0, void 0, function* () {
             mock
                 .onPost('/users/magic_auth/send', {
-                email_address: 'bob.loblaw@example.com',
+                email: 'bob.loblaw@example.com',
             })
                 .reply(200, {
                 user: {
@@ -206,7 +232,7 @@ describe('UserManagement', () => {
                 },
             });
             const response = yield workos.users.sendMagicAuthCode({
-                emailAddress: 'bob.loblaw@example.com',
+                email: 'bob.loblaw@example.com',
             });
             expect(mock.history.post[0].url).toEqual('/users/magic_auth/send');
             expect(response).toMatchObject({
@@ -224,15 +250,15 @@ describe('UserManagement', () => {
     });
     describe('createPasswordResetChallenge', () => {
         it('sends a Create Password Reset Challenge request', () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onPost(`/users/password_reset_challenge`).reply(200, {
+            mock.onPost(`/users/send_password_reset_email`).reply(200, {
                 token: 'password-reset-token',
                 user: user_json_1.default,
             });
-            const resp = yield workos.users.createPasswordResetChallenge({
+            const resp = yield workos.users.sendPasswordResetEmail({
                 email: 'test01@example.com',
                 passwordResetUrl: 'https://example.com/forgot-password',
             });
-            expect(mock.history.post[0].url).toEqual(`/users/password_reset_challenge`);
+            expect(mock.history.post[0].url).toEqual(`/users/send_password_reset_email`);
             expect(resp).toMatchObject({
                 token: 'password-reset-token',
                 user: {
@@ -243,13 +269,13 @@ describe('UserManagement', () => {
     });
     describe('completePasswordReset', () => {
         it('sends a completePasswordReset request', () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onPost(`/users/password_reset`).reply(200, user_json_1.default);
-            const resp = yield workos.users.completePasswordReset({
+            mock.onPost(`/users/password_reset`).reply(200, { user: user_json_1.default });
+            const resp = yield workos.users.resetPassword({
                 token: '',
                 newPassword: 'correct horse battery staple',
             });
             expect(mock.history.post[0].url).toEqual(`/users/password_reset`);
-            expect(resp).toMatchObject({
+            expect(resp.user).toMatchObject({
                 email: 'test01@example.com',
             });
         }));
@@ -332,8 +358,8 @@ describe('UserManagement', () => {
             });
         }));
     });
-    describe('enrollUserInMfaFactor', () => {
-        it('sends an enrollUserInMfaFactor request', () => __awaiter(void 0, void 0, void 0, function* () {
+    describe('enrollAuthFactor', () => {
+        it('sends an enrollAuthFactor request', () => __awaiter(void 0, void 0, void 0, function* () {
             mock.onPost(`/users/${userId}/auth/factors`).reply(200, {
                 authentication_factor: {
                     object: 'authentication_factor',
@@ -359,7 +385,7 @@ describe('UserManagement', () => {
                     authentication_factor_id: 'auth_factor_1234',
                 },
             });
-            const resp = yield workos.users.enrollUserInMfaFactor({
+            const resp = yield workos.users.enrollAuthFactor({
                 userId,
                 type: 'totp',
                 totpIssuer: 'WorkOS',
@@ -393,6 +419,36 @@ describe('UserManagement', () => {
             });
         }));
     });
+    describe('listAuthFactors', () => {
+        it('sends a listAuthFactors request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet(`/users/${userId}/auth/factors`).reply(200, list_factors_json_1.default);
+            const resp = yield workos.users.listAuthFactors({ userId });
+            expect(mock.history.get[0].url).toEqual(`/users/${userId}/auth/factors`);
+            expect(resp).toMatchObject({
+                object: 'list',
+                data: [
+                    {
+                        object: 'authentication_factor',
+                        id: 'auth_factor_1234',
+                        createdAt: '2022-03-15T20:39:19.892Z',
+                        updatedAt: '2022-03-15T20:39:19.892Z',
+                        type: 'totp',
+                        totp: {
+                            issuer: 'WorkOS',
+                            qrCode: 'qr-code-test',
+                            secret: 'secret-test',
+                            uri: 'uri-test',
+                            user: 'some_user',
+                        },
+                    },
+                ],
+                listMetadata: {
+                    before: null,
+                    after: null,
+                },
+            });
+        }));
+    });
     describe('deleteUser', () => {
         it('sends a deleteUser request', () => __awaiter(void 0, void 0, void 0, function* () {
             mock.onDelete(`/users/${userId}`).reply(200);

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.6.0';
+const VERSION = '3.7.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

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

package/lib/users/interfaces/complete-password-reset-options.interface.d.ts

@@ -1,8 +0,0 @@
-export interface CompletePasswordResetOptions {
-    token: string;
-    newPassword: string;
-}
-export interface SerializedCompletePasswordResetOptions {
-    token: string;
-    new_password: string;
-}

package/lib/users/interfaces/magic-auth-challenge.interface.d.ts

@@ -1,3 +0,0 @@
-export interface MagicAuthChallenge {
-    id: string;
-}

package/lib/users/serializers/authenticate-user-with-code-options.serializer.d.ts

@@ -1,2 +0,0 @@
-import { AuthenticateUserWithCodeCredentials, AuthenticateUserWithCodeOptions, SerializedAuthenticateUserWithCodeOptions } from '../interfaces';
-export declare const serializeAuthenticateUserWithCodeOptions: (options: AuthenticateUserWithCodeOptions & AuthenticateUserWithCodeCredentials) => SerializedAuthenticateUserWithCodeOptions;

package/lib/users/serializers/authenticate-user-with-code-options.serializer.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeAuthenticateUserWithCodeOptions = void 0;
-const serializeAuthenticateUserWithCodeOptions = (options) => ({
-    grant_type: 'authorization_code',
-    client_id: options.clientId,
-    client_secret: options.clientSecret,
-    code: options.code,
-});
-exports.serializeAuthenticateUserWithCodeOptions = serializeAuthenticateUserWithCodeOptions;

package/lib/users/serializers/authenticate-user-with-magic-auth-options.serializer.d.ts

@@ -1,2 +0,0 @@
-import { AuthenticateUserWithMagicAuthCredentials, AuthenticateUserWithMagicAuthOptions, SerializedAuthenticateUserWithMagicAuthOptions } from '../interfaces';
-export declare const serializeAuthenticateUserWithMagicAuthOptions: (options: AuthenticateUserWithMagicAuthOptions & AuthenticateUserWithMagicAuthCredentials) => SerializedAuthenticateUserWithMagicAuthOptions;

package/lib/users/serializers/authenticate-user-with-password-options.serializer.d.ts

@@ -1,2 +0,0 @@
-import { AuthenticateUserWithPasswordCredentials, AuthenticateUserWithPasswordOptions, SerializedAuthenticateUserWithPasswordOptions } from '../interfaces';
-export declare const serializeAuthenticateUserWithPasswordOptions: (options: AuthenticateUserWithPasswordOptions & AuthenticateUserWithPasswordCredentials) => SerializedAuthenticateUserWithPasswordOptions;

package/lib/users/serializers/complete-password-reset-options.serializer.d.ts

@@ -1,2 +0,0 @@
-import { CompletePasswordResetOptions, SerializedCompletePasswordResetOptions } from '../interfaces';
-export declare const serializeCompletePasswordResetOptions: (options: CompletePasswordResetOptions) => SerializedCompletePasswordResetOptions;

package/lib/users/serializers/complete-password-reset-options.serializer.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeCompletePasswordResetOptions = void 0;
-const serializeCompletePasswordResetOptions = (options) => ({
-    token: options.token,
-    new_password: options.newPassword,
-});
-exports.serializeCompletePasswordResetOptions = serializeCompletePasswordResetOptions;

package/lib/users/serializers/create-password-reset-challenge.serializer.d.ts

@@ -1,3 +0,0 @@
-import { CreatePasswordResetChallengeOptions, CreatePasswordResetChallengeResponse, CreatePasswordResetChallengeResponseResponse, SerializedCreatePasswordResetChallengeOptions } from '../interfaces';
-export declare const deserializeCreatePasswordResetChallengeResponse: (createPasswordResetChallengeResponse: CreatePasswordResetChallengeResponseResponse) => CreatePasswordResetChallengeResponse;
-export declare const serializeCreatePasswordResetChallengeOptions: (options: CreatePasswordResetChallengeOptions) => SerializedCreatePasswordResetChallengeOptions;

package/lib/users/serializers/create-password-reset-challenge.serializer.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeCreatePasswordResetChallengeOptions = exports.deserializeCreatePasswordResetChallengeResponse = void 0;
-const user_serializer_1 = require("./user.serializer");
-const deserializeCreatePasswordResetChallengeResponse = (createPasswordResetChallengeResponse) => ({
-    token: createPasswordResetChallengeResponse.token,
-    user: (0, user_serializer_1.deserializeUser)(createPasswordResetChallengeResponse.user),
-});
-exports.deserializeCreatePasswordResetChallengeResponse = deserializeCreatePasswordResetChallengeResponse;
-const serializeCreatePasswordResetChallengeOptions = (options) => ({
-    email: options.email,
-    password_reset_url: options.passwordResetUrl,
-});
-exports.serializeCreatePasswordResetChallengeOptions = serializeCreatePasswordResetChallengeOptions;

package/lib/users/serializers/enroll-user-in-mfa-factor-options.serializer.d.ts

@@ -1,2 +0,0 @@
-import { EnrollUserInMfaFactorOptions, SerializedEnrollUserInMfaFactorOptions } from '../interfaces';
-export declare const serializeEnrollUserInMfaFactorOptions: (options: EnrollUserInMfaFactorOptions) => SerializedEnrollUserInMfaFactorOptions;

package/lib/users/serializers/enroll-user-in-mfa-factor-options.serializer.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeEnrollUserInMfaFactorOptions = void 0;
-const serializeEnrollUserInMfaFactorOptions = (options) => ({
-    type: options.type,
-    totp_issuer: options.totpIssuer,
-    totp_user: options.totpUser,
-});
-exports.serializeEnrollUserInMfaFactorOptions = serializeEnrollUserInMfaFactorOptions;