@workos-inc/node 7.5.0 → 7.7.0

package/lib/common/interfaces/event.interface.d.ts

@@ -1,9 +1,9 @@
 import { DirectoryUser, DirectoryUserResponse, DirectoryGroup, DirectoryGroupResponse, EventDirectory, EventDirectoryResponse } from '../../directory-sync/interfaces';
 import { Organization, OrganizationResponse } from '../../organizations/interfaces';
 import { Connection, ConnectionResponse } from '../../sso/interfaces';
-import { InvitationEvent, InvitationEventResponse, MagicAuthEvent, MagicAuthEventResponse, Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
+import { EmailVerificationEvent, EmailVerificationEventResponse, InvitationEvent, InvitationEventResponse, MagicAuthEvent, MagicAuthEventResponse, PasswordResetEvent, PasswordResetEventResponse, Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
 import { OrganizationMembership, OrganizationMembershipResponse } from '../../user-management/interfaces/organization-membership.interface';
-import { RoleEvent, RoleEventResponse } from '../../user-management/interfaces/role.interface';
+import { RoleEvent, RoleEventResponse } from '../../roles/interfaces/role.interface';
 export interface EventBase {
     id: string;
     createdAt: string;
@@ -140,6 +140,14 @@ export interface DsyncUserUpdatedEventResponse extends EventResponseBase {
     event: 'dsync.user.updated';
     data: DirectoryUserResponse & Record<'previous_attributes', any>;
 }
+export interface EmailVerificationCreatedEvent extends EventBase {
+    event: 'email_verification.created';
+    data: EmailVerificationEvent;
+}
+export interface EmailVerificationCreatedEventResponse extends EventResponseBase {
+    event: 'email_verification.created';
+    data: EmailVerificationEventResponse;
+}
 export interface InvitationCreatedEvent extends EventBase {
     event: 'invitation.created';
     data: InvitationEvent;
@@ -156,6 +164,14 @@ export interface MagicAuthCreatedEventResponse extends EventResponseBase {
     event: 'magic_auth.created';
     data: MagicAuthEventResponse;
 }
+export interface PasswordResetCreatedEvent extends EventBase {
+    event: 'password_reset.created';
+    data: PasswordResetEvent;
+}
+export interface PasswordResetCreatedEventResponse extends EventResponseBase {
+    event: 'password_reset.created';
+    data: PasswordResetEventResponse;
+}
 export interface UserCreatedEvent extends EventBase {
     event: 'user.created';
     data: User;
@@ -280,7 +296,7 @@ export interface SessionCreatedEventResponse extends EventResponseBase {
     event: 'session.created';
     data: SessionResponse;
 }
-export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | InvitationCreatedEvent | MagicAuthCreatedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | OrganizationMembershipRemoved | RoleCreatedEvent | RoleDeletedEvent | SessionCreatedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent;
-export type EventResponse = ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | InvitationCreatedEventResponse | MagicAuthCreatedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | SessionCreatedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse;
+export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | EmailVerificationCreatedEvent | InvitationCreatedEvent | MagicAuthCreatedEvent | PasswordResetCreatedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | OrganizationMembershipRemoved | RoleCreatedEvent | RoleDeletedEvent | SessionCreatedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent;
+export type EventResponse = ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | EmailVerificationCreatedEventResponse | InvitationCreatedEventResponse | MagicAuthCreatedEventResponse | PasswordResetCreatedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | SessionCreatedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse;
 export type EventName = Event['event'];
 export {};

package/lib/common/serializers/event.serializer.js

@@ -40,10 +40,14 @@ const deserializeEvent = (event) => {
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_1.deserializeDirectoryUser)(event.data) });
         case 'dsync.user.updated':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_1.deserializeUpdatedEventDirectoryUser)(event.data) });
+        case 'email_verification.created':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeEmailVerificationEvent)(event.data) });
         case 'invitation.created':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeInvitationEvent)(event.data) });
         case 'magic_auth.created':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeMagicAuthEvent)(event.data) });
+        case 'password_reset.created':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializePasswordResetEvent)(event.data) });
         case 'user.created':
         case 'user.updated':
         case 'user.deleted':

package/lib/directory-sync/directory-sync.spec.js

@@ -118,6 +118,60 @@ describe('DirectorySync', () => {
         created_at: '2021-10-27 15:21:50.640959',
         updated_at: '2021-12-13 12:15:45.531847',
     };
+    const userWithRole = {
+        object: 'directory_user',
+        id: 'directory_user_456',
+        customAttributes: {
+            custom: true,
+        },
+        directoryId: 'dir_123',
+        organizationId: 'org_123',
+        emails: [
+            {
+                primary: true,
+                type: 'type',
+                value: 'jonsnow@workos.com',
+            },
+        ],
+        firstName: 'Jon',
+        groups: [group],
+        idpId: 'idp_foo',
+        lastName: 'Snow',
+        jobTitle: 'Knight of the Watch',
+        rawAttributes: {},
+        state: 'active',
+        username: 'jonsnow',
+        role: { slug: 'super_admin' },
+        createdAt: '2021-10-27 15:21:50.640959',
+        updatedAt: '2021-12-13 12:15:45.531847',
+    };
+    const userWithRoleResponse = {
+        object: 'directory_user',
+        id: 'directory_user_456',
+        custom_attributes: {
+            custom: true,
+        },
+        directory_id: 'dir_123',
+        organization_id: 'org_123',
+        emails: [
+            {
+                primary: true,
+                type: 'type',
+                value: 'jonsnow@workos.com',
+            },
+        ],
+        first_name: 'Jon',
+        groups: [groupResponse],
+        idp_id: 'idp_foo',
+        last_name: 'Snow',
+        job_title: 'Knight of the Watch',
+        raw_attributes: {},
+        state: 'active',
+        username: 'jonsnow',
+        role: { slug: 'super_admin' },
+        created_at: '2021-10-27 15:21:50.640959',
+        updated_at: '2021-12-13 12:15:45.531847',
+    };
     describe('listDirectories', () => {
         describe('with options', () => {
             it('requests Directories with query parameters', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -351,5 +405,12 @@ describe('DirectorySync', () => {
             const subject = yield workos.directorySync.getUser('dir_usr_123');
             expect(subject).toEqual(userWithGroup);
         }));
+        describe('with a Role', () => {
+            it(`requests a Directory User`, () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)(userWithRoleResponse);
+                const subject = yield workos.directorySync.getUser('directory_user_456');
+                expect(subject).toEqual(userWithRole);
+            }));
+        });
     });
 });

package/lib/directory-sync/interfaces/directory-user.interface.d.ts

@@ -1,3 +1,4 @@
+import { RoleResponse } from '../../roles/interfaces/';
 import { DirectoryGroup, DirectoryGroupResponse } from './directory-group.interface';
 export type DefaultCustomAttributes = Record<string, unknown>;
 export interface DirectoryUser<TCustomAttributes extends object = DefaultCustomAttributes, TRawAttributes = any> {
@@ -18,6 +19,7 @@ export interface DirectoryUser<TCustomAttributes extends object = DefaultCustomA
     lastName: string | null;
     jobTitle: string | null;
     state: 'active' | 'inactive';
+    role?: RoleResponse;
     createdAt: string;
     updatedAt: string;
 }
@@ -39,6 +41,7 @@ export interface DirectoryUserResponse<TCustomAttributes extends object = Defaul
     last_name: string | null;
     job_title: string | null;
     state: 'active' | 'inactive';
+    role?: RoleResponse;
     created_at: string;
     updated_at: string;
 }

package/lib/directory-sync/serializers/directory-user.serializer.js

@@ -16,6 +16,7 @@ const deserializeDirectoryUser = (directoryUser) => ({
     lastName: directoryUser.last_name,
     jobTitle: directoryUser.job_title,
     state: directoryUser.state,
+    role: directoryUser.role,
     createdAt: directoryUser.created_at,
     updatedAt: directoryUser.updated_at,
 });
@@ -36,6 +37,7 @@ const deserializeUpdatedEventDirectoryUser = (directoryUser) => ({
     lastName: directoryUser.last_name,
     jobTitle: directoryUser.job_title,
     state: directoryUser.state,
+    role: directoryUser.role,
     createdAt: directoryUser.created_at,
     updatedAt: directoryUser.updated_at,
     previousAttributes: directoryUser.previous_attributes,

package/lib/events/events.spec.js

@@ -106,5 +106,93 @@ describe('Event', () => {
                 listMetadata: {},
             });
         }));
+        describe('directory user updated events', () => {
+            describe('with a role', () => {
+                const directoryUserUpdated = {
+                    id: 'event_01234ABCD',
+                    createdAt: '2020-05-06 04:21:48.649164',
+                    event: 'dsync.user.updated',
+                    data: {
+                        object: 'directory_user',
+                        id: 'directory_user_456',
+                        customAttributes: {
+                            custom: true,
+                        },
+                        directoryId: 'dir_123',
+                        organizationId: 'org_123',
+                        emails: [
+                            {
+                                primary: true,
+                                type: 'type',
+                                value: 'jonsnow@workos.com',
+                            },
+                        ],
+                        firstName: 'Jon',
+                        idpId: 'idp_foo',
+                        lastName: 'Snow',
+                        jobTitle: 'Knight of the Watch',
+                        rawAttributes: {},
+                        state: 'active',
+                        username: 'jonsnow',
+                        role: { slug: 'super_admin' },
+                        previousAttributes: {
+                            role: { slug: 'member' },
+                        },
+                        createdAt: '2021-10-27 15:21:50.640959',
+                        updatedAt: '2021-12-13 12:15:45.531847',
+                    },
+                };
+                const directoryUserUpdatedResponse = {
+                    id: 'event_01234ABCD',
+                    created_at: '2020-05-06 04:21:48.649164',
+                    event: 'dsync.user.updated',
+                    data: {
+                        object: 'directory_user',
+                        id: 'directory_user_456',
+                        custom_attributes: {
+                            custom: true,
+                        },
+                        directory_id: 'dir_123',
+                        organization_id: 'org_123',
+                        emails: [
+                            {
+                                primary: true,
+                                type: 'type',
+                                value: 'jonsnow@workos.com',
+                            },
+                        ],
+                        first_name: 'Jon',
+                        idp_id: 'idp_foo',
+                        last_name: 'Snow',
+                        job_title: 'Knight of the Watch',
+                        raw_attributes: {},
+                        state: 'active',
+                        username: 'jonsnow',
+                        role: { slug: 'super_admin' },
+                        previous_attributes: {
+                            role: { slug: 'member' },
+                        },
+                        created_at: '2021-10-27 15:21:50.640959',
+                        updated_at: '2021-12-13 12:15:45.531847',
+                    },
+                };
+                const directoryUserEventsListResponse = {
+                    object: 'list',
+                    data: [directoryUserUpdatedResponse],
+                    list_metadata: {},
+                };
+                it(`returns the role`, () => __awaiter(void 0, void 0, void 0, function* () {
+                    (0, test_utils_1.fetchOnce)(directoryUserEventsListResponse);
+                    const list = yield workos.events.listEvents({
+                        events: ['dsync.user.updated'],
+                    });
+                    expect(list).toEqual({
+                        object: 'list',
+                        data: [directoryUserUpdated],
+                        listMetadata: {},
+                    });
+                }));
+            });
+        });
     });
 });

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

@@ -0,0 +1 @@
+export * from './role.interface';

package/lib/roles/interfaces/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./role.interface"), exports);

package/lib/user-management/fixtures/email_verification.json

@@ -0,0 +1,10 @@
+{
+    "object": "email_verification",
+    "id": "email_verification_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "user_id": "user_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "email": "dane@workos.com",
+    "expires_at": "2023-07-18T02:07:19.911Z",
+    "code": "123456",
+    "created_at": "2023-07-18T02:07:19.911Z",
+    "updated_at": "2023-07-18T02:07:19.911Z"
+}

package/lib/user-management/fixtures/invitation.json

@@ -9,7 +9,7 @@
     "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
     "inviter_user_id": null,
     "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
-    "accept_invitation_url": "https://myauthkit.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
+    "accept_invitation_url": "https://your-app.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
     "created_at": "2023-07-18T02:07:19.911Z",
     "updated_at": "2023-07-18T02:07:19.911Z"
 }

package/lib/user-management/fixtures/list-invitations.json

@@ -12,7 +12,7 @@
             "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
             "inviter_user_id": null,
             "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
-            "accept_invitation_url": "https://myauthkit.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
+            "accept_invitation_url": "https://your-app.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
             "created_at": "2023-07-18T02:07:19.911Z",
             "updated_at": "2023-07-18T02:07:19.911Z"
         }

package/lib/user-management/fixtures/password_reset.json

@@ -0,0 +1,10 @@
+{
+    "object": "password_reset",
+    "id": "password_reset_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "user_id": "user_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "email": "dane@workos.com",
+    "password_reset_token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
+    "password_reset_url": "https://your-app.com/reset-password?token=Z1uX3RbwcIl5fIGJJJCXXisdI",
+    "expires_at": "2023-07-18T02:07:19.911Z",
+    "created_at": "2023-07-18T02:07:19.911Z"
+}

package/lib/user-management/interfaces/create-password-reset-options.interface.d.ts

@@ -0,0 +1,6 @@
+export interface CreatePasswordResetOptions {
+    email: string;
+}
+export interface SerializedCreatePasswordResetOptions {
+    email: string;
+}

package/lib/user-management/interfaces/create-password-reset-options.interface.js

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

package/lib/user-management/interfaces/email-verification.interface.d.ts

@@ -0,0 +1,38 @@
+export interface EmailVerification {
+    object: 'email_verification';
+    id: string;
+    userId: string;
+    email: string;
+    expiresAt: string;
+    code: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface EmailVerificationEvent {
+    object: 'email_verification';
+    id: string;
+    userId: string;
+    email: string;
+    expiresAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface EmailVerificationResponse {
+    object: 'email_verification';
+    id: string;
+    user_id: string;
+    email: string;
+    expires_at: string;
+    code: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface EmailVerificationEventResponse {
+    object: 'email_verification';
+    id: string;
+    user_id: string;
+    email: string;
+    expires_at: string;
+    created_at: string;
+    updated_at: string;
+}

package/lib/user-management/interfaces/email-verification.interface.js

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

package/lib/user-management/interfaces/enroll-auth-factor.interface.d.ts

@@ -3,9 +3,11 @@ export interface EnrollAuthFactorOptions {
     type: 'totp';
     totpIssuer?: string;
     totpUser?: string;
+    totpSecret?: string;
 }
 export interface SerializedEnrollUserInMfaFactorOptions {
     type: 'totp';
     totp_issuer?: string;
     totp_user?: string;
+    totp_secret?: string;
 }

package/lib/user-management/interfaces/index.d.ts

@@ -11,7 +11,9 @@ export * from './authenticate-with-totp-options.interface';
 export * from './authentication-response.interface';
 export * from './create-magic-auth-options.interface';
 export * from './create-organization-membership-options.interface';
+export * from './create-password-reset-options.interface';
 export * from './create-user-options.interface';
+export * from './email-verification.interface';
 export * from './enroll-auth-factor.interface';
 export * from './factor.interface';
 export * from './impersonator.interface';
@@ -22,9 +24,9 @@ export * from './list-organization-memberships-options.interface';
 export * from './list-users-options.interface';
 export * from './magic-auth.interface';
 export * from './organization-membership.interface';
+export * from './password-reset.interface';
 export * from './reset-password-options.interface';
 export * from './revoke-session-options.interface';
-export * from './role.interface';
 export * from './send-invitation-options.interface';
 export * from './send-magic-auth-code-options.interface';
 export * from './send-password-reset-email-options.interface';
@@ -35,4 +37,3 @@ 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 './role.interface';

package/lib/user-management/interfaces/index.js

@@ -27,7 +27,9 @@ __exportStar(require("./authenticate-with-totp-options.interface"), exports);
 __exportStar(require("./authentication-response.interface"), exports);
 __exportStar(require("./create-magic-auth-options.interface"), exports);
 __exportStar(require("./create-organization-membership-options.interface"), exports);
+__exportStar(require("./create-password-reset-options.interface"), exports);
 __exportStar(require("./create-user-options.interface"), exports);
+__exportStar(require("./email-verification.interface"), exports);
 __exportStar(require("./enroll-auth-factor.interface"), exports);
 __exportStar(require("./factor.interface"), exports);
 __exportStar(require("./impersonator.interface"), exports);
@@ -38,9 +40,9 @@ __exportStar(require("./list-organization-memberships-options.interface"), expor
 __exportStar(require("./list-users-options.interface"), exports);
 __exportStar(require("./magic-auth.interface"), exports);
 __exportStar(require("./organization-membership.interface"), exports);
+__exportStar(require("./password-reset.interface"), exports);
 __exportStar(require("./reset-password-options.interface"), exports);
 __exportStar(require("./revoke-session-options.interface"), exports);
-__exportStar(require("./role.interface"), exports);
 __exportStar(require("./send-invitation-options.interface"), exports);
 __exportStar(require("./send-magic-auth-code-options.interface"), exports);
 __exportStar(require("./send-password-reset-email-options.interface"), exports);
@@ -51,4 +53,3 @@ __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("./role.interface"), exports);

package/lib/user-management/interfaces/organization-membership.interface.d.ts

@@ -1,4 +1,4 @@
-import { RoleResponse } from './role.interface';
+import { RoleResponse } from '../../roles/interfaces/';
 export type OrganizationMembershipStatus = 'active' | 'inactive' | 'pending';
 export interface OrganizationMembership {
     object: 'organization_membership';

package/lib/user-management/interfaces/password-reset.interface.d.ts

@@ -0,0 +1,36 @@
+export interface PasswordReset {
+    object: 'password_reset';
+    id: string;
+    userId: string;
+    email: string;
+    passwordResetToken: string;
+    passwordResetUrl: string;
+    expiresAt: string;
+    createdAt: string;
+}
+export interface PasswordResetEvent {
+    object: 'password_reset';
+    id: string;
+    userId: string;
+    email: string;
+    expiresAt: string;
+    createdAt: string;
+}
+export interface PasswordResetResponse {
+    object: 'password_reset';
+    id: string;
+    user_id: string;
+    email: string;
+    password_reset_token: string;
+    password_reset_url: string;
+    expires_at: string;
+    created_at: string;
+}
+export interface PasswordResetEventResponse {
+    object: 'password_reset';
+    id: string;
+    user_id: string;
+    email: string;
+    expires_at: string;
+    created_at: string;
+}

package/lib/user-management/interfaces/password-reset.interface.js

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

package/lib/user-management/serializers/create-password-reset-options.serializer.d.ts

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

package/lib/user-management/serializers/create-password-reset-options.serializer.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeCreatePasswordResetOptions = void 0;
+const serializeCreatePasswordResetOptions = (options) => ({
+    email: options.email,
+});
+exports.serializeCreatePasswordResetOptions = serializeCreatePasswordResetOptions;

package/lib/user-management/serializers/email-verification.serializer.d.ts

@@ -0,0 +1,3 @@
+import { EmailVerification, EmailVerificationEvent, EmailVerificationEventResponse, EmailVerificationResponse } from '../interfaces';
+export declare const deserializeEmailVerification: (emailVerification: EmailVerificationResponse) => EmailVerification;
+export declare const deserializeEmailVerificationEvent: (emailVerification: EmailVerificationEventResponse) => EmailVerificationEvent;

package/lib/user-management/serializers/email-verification.serializer.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeEmailVerificationEvent = exports.deserializeEmailVerification = void 0;
+const deserializeEmailVerification = (emailVerification) => ({
+    object: emailVerification.object,
+    id: emailVerification.id,
+    userId: emailVerification.user_id,
+    email: emailVerification.email,
+    expiresAt: emailVerification.expires_at,
+    code: emailVerification.code,
+    createdAt: emailVerification.created_at,
+    updatedAt: emailVerification.updated_at,
+});
+exports.deserializeEmailVerification = deserializeEmailVerification;
+const deserializeEmailVerificationEvent = (emailVerification) => ({
+    object: emailVerification.object,
+    id: emailVerification.id,
+    userId: emailVerification.user_id,
+    email: emailVerification.email,
+    expiresAt: emailVerification.expires_at,
+    createdAt: emailVerification.created_at,
+    updatedAt: emailVerification.updated_at,
+});
+exports.deserializeEmailVerificationEvent = deserializeEmailVerificationEvent;

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

@@ -5,5 +5,6 @@ const serializeEnrollAuthFactorOptions = (options) => ({
     type: options.type,
     totp_issuer: options.totpIssuer,
     totp_user: options.totpUser,
+    totp_secret: options.totpSecret,
 });
 exports.serializeEnrollAuthFactorOptions = serializeEnrollAuthFactorOptions;

package/lib/user-management/serializers/index.d.ts

@@ -5,10 +5,13 @@ export * from './authenticate-with-refresh-token.options.serializer';
 export * from './authenticate-with-totp-options.serializer';
 export * from './authentication-response.serializer';
 export * from './create-magic-auth-options.serializer';
+export * from './create-password-reset-options.serializer';
+export * from './email-verification.serializer';
 export * from './enroll-auth-factor-options.serializer';
 export * from './factor.serializer';
 export * from './invitation.serializer';
 export * from './magic-auth.serializer';
+export * from './password-reset.serializer';
 export * from './reset-password-options.serializer';
 export * from './send-password-reset-email.serializer';
 export * from './create-user-options.serializer';

package/lib/user-management/serializers/index.js

@@ -21,10 +21,13 @@ __exportStar(require("./authenticate-with-refresh-token.options.serializer"), ex
 __exportStar(require("./authenticate-with-totp-options.serializer"), exports);
 __exportStar(require("./authentication-response.serializer"), exports);
 __exportStar(require("./create-magic-auth-options.serializer"), exports);
+__exportStar(require("./create-password-reset-options.serializer"), exports);
+__exportStar(require("./email-verification.serializer"), exports);
 __exportStar(require("./enroll-auth-factor-options.serializer"), exports);
 __exportStar(require("./factor.serializer"), exports);
 __exportStar(require("./invitation.serializer"), exports);
 __exportStar(require("./magic-auth.serializer"), exports);
+__exportStar(require("./password-reset.serializer"), exports);
 __exportStar(require("./reset-password-options.serializer"), exports);
 __exportStar(require("./send-password-reset-email.serializer"), exports);
 __exportStar(require("./create-user-options.serializer"), exports);

package/lib/user-management/serializers/password-reset.serializer.d.ts

@@ -0,0 +1,3 @@
+import { PasswordReset, PasswordResetEvent, PasswordResetEventResponse, PasswordResetResponse } from '../interfaces';
+export declare const deserializePasswordReset: (passwordReset: PasswordResetResponse) => PasswordReset;
+export declare const deserializePasswordResetEvent: (passwordReset: PasswordResetEventResponse) => PasswordResetEvent;

package/lib/user-management/serializers/password-reset.serializer.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializePasswordResetEvent = exports.deserializePasswordReset = void 0;
+const deserializePasswordReset = (passwordReset) => ({
+    object: passwordReset.object,
+    id: passwordReset.id,
+    userId: passwordReset.user_id,
+    email: passwordReset.email,
+    passwordResetToken: passwordReset.password_reset_token,
+    passwordResetUrl: passwordReset.password_reset_url,
+    expiresAt: passwordReset.expires_at,
+    createdAt: passwordReset.created_at,
+});
+exports.deserializePasswordReset = deserializePasswordReset;
+const deserializePasswordResetEvent = (passwordReset) => ({
+    object: passwordReset.object,
+    id: passwordReset.id,
+    userId: passwordReset.user_id,
+    email: passwordReset.email,
+    expiresAt: passwordReset.expires_at,
+    createdAt: passwordReset.created_at,
+});
+exports.deserializePasswordResetEvent = deserializePasswordResetEvent;

package/lib/user-management/serializers/role.serializer.d.ts

@@ -1,2 +1,2 @@
-import { RoleEvent, RoleEventResponse } from '../interfaces';
+import { RoleEvent, RoleEventResponse } from '../../roles/interfaces';
 export declare const deserializeRole: (role: RoleEventResponse) => RoleEvent;

package/lib/user-management/user-management.d.ts

@@ -1,6 +1,6 @@
 import { WorkOS } from '../workos';
 import { AutoPaginatable } from '../common/utils/pagination';
-import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, CreateUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions, AuthenticateWithRefreshTokenOptions, RefreshAuthenticationResponse, MagicAuth, CreateMagicAuthOptions } from './interfaces';
+import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, CreateUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions, AuthenticateWithRefreshTokenOptions, RefreshAuthenticationResponse, MagicAuth, CreateMagicAuthOptions, EmailVerification, PasswordReset, CreatePasswordResetOptions } from './interfaces';
 import { Challenge } from '../mfa/interfaces';
 import { OrganizationMembership } from './interfaces/organization-membership.interface';
 import { ListOrganizationMembershipsOptions } from './interfaces/list-organization-memberships-options.interface';
@@ -27,6 +27,7 @@ export declare class UserManagement {
     authenticateWithTotp(payload: AuthenticateWithTotpOptions): Promise<AuthenticationResponse>;
     authenticateWithEmailVerification(payload: AuthenticateWithEmailVerificationOptions): Promise<AuthenticationResponse>;
     authenticateWithOrganizationSelection(payload: AuthenticateWithOrganizationSelectionOptions): Promise<AuthenticationResponse>;
+    getEmailVerification(emailVerificationId: string): Promise<EmailVerification>;
     sendVerificationEmail({ userId, }: SendVerificationEmailOptions): Promise<{
         user: User;
     }>;
@@ -39,6 +40,11 @@ export declare class UserManagement {
     verifyEmail({ code, userId, }: VerifyEmailOptions): Promise<{
         user: User;
     }>;
+    getPasswordReset(passwordResetId: string): Promise<PasswordReset>;
+    createPasswordReset(options: CreatePasswordResetOptions): Promise<PasswordReset>;
+    /**
+     * @deprecated Please use `createPasswordReset` instead. This method will be removed in a future major version.
+     */
     sendPasswordResetEmail(payload: SendPasswordResetEmailOptions): Promise<void>;
     resetPassword(payload: ResetPasswordOptions): Promise<{
         user: User;

package/lib/user-management/user-management.js

@@ -100,6 +100,12 @@ class UserManagement {
             return (0, serializers_1.deserializeAuthenticationResponse)(data);
         });
     }
+    getEmailVerification(emailVerificationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/email_verification/${emailVerificationId}`);
+            return (0, serializers_1.deserializeEmailVerification)(data);
+        });
+    }
     sendVerificationEmail({ userId, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.post(`/user_management/users/${userId}/email_verification/send`, {});
@@ -134,6 +140,21 @@ class UserManagement {
             return { user: (0, serializers_1.deserializeUser)(data.user) };
         });
     }
+    getPasswordReset(passwordResetId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/password_reset/${passwordResetId}`);
+            return (0, serializers_1.deserializePasswordReset)(data);
+        });
+    }
+    createPasswordReset(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/password_reset', (0, serializers_1.serializeCreatePasswordResetOptions)(Object.assign({}, options)));
+            return (0, serializers_1.deserializePasswordReset)(data);
+        });
+    }
+    /**
+     * @deprecated Please use `createPasswordReset` instead. This method will be removed in a future major version.
+     */
     sendPasswordResetEmail(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.workos.post('/user_management/password_reset/send', (0, serializers_1.serializeSendPasswordResetEmailOptions)(payload));

package/lib/user-management/user-management.spec.js

@@ -16,6 +16,7 @@ const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
 const test_utils_1 = require("../common/utils/test-utils");
 const workos_1 = require("../workos");
 const deactivate_organization_membership_json_1 = __importDefault(require("./fixtures/deactivate-organization-membership.json"));
+const email_verification_json_1 = __importDefault(require("./fixtures/email_verification.json"));
 const invitation_json_1 = __importDefault(require("./fixtures/invitation.json"));
 const list_factors_json_1 = __importDefault(require("./fixtures/list-factors.json"));
 const list_invitations_json_1 = __importDefault(require("./fixtures/list-invitations.json"));
@@ -23,12 +24,15 @@ const list_organization_memberships_json_1 = __importDefault(require("./fixtures
 const list_users_json_1 = __importDefault(require("./fixtures/list-users.json"));
 const magic_auth_json_1 = __importDefault(require("./fixtures/magic_auth.json"));
 const organization_membership_json_1 = __importDefault(require("./fixtures/organization-membership.json"));
+const password_reset_json_1 = __importDefault(require("./fixtures/password_reset.json"));
 const user_json_1 = __importDefault(require("./fixtures/user.json"));
 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 const userId = 'user_01H5JQDV7R7ATEYZDEG0W5PRYS';
 const organizationMembershipId = 'om_01H5JQDV7R7ATEYZDEG0W5PRYS';
+const emailVerificationId = 'email_verification_01H5JQDV7R7ATEYZDEG0W5PRYS';
 const invitationId = 'invitation_01H5JQDV7R7ATEYZDEG0W5PRYS';
 const magicAuthId = 'magic_auth_01H5JQDV7R7ATEYZDEG0W5PRYS';
+const passwordResetId = 'password_reset_01H5JQDV7R7ATEYZDEG0W5PRYS';
 describe('UserManagement', () => {
     beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     describe('getUser', () => {
@@ -293,6 +297,22 @@ describe('UserManagement', () => {
             });
         }));
     });
+    describe('getEmailVerification', () => {
+        it('sends a Get EmailVerification request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(email_verification_json_1.default);
+            const emailVerification = yield workos.userManagement.getEmailVerification(emailVerificationId);
+            expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/email_verification/${emailVerificationId}`);
+            expect(emailVerification).toMatchObject({
+                id: 'email_verification_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                userId: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                email: 'dane@workos.com',
+                expiresAt: '2023-07-18T02:07:19.911Z',
+                code: '123456',
+                createdAt: '2023-07-18T02:07:19.911Z',
+                updatedAt: '2023-07-18T02:07:19.911Z',
+            });
+        }));
+    });
     describe('sendVerificationEmail', () => {
         it('sends a Create Email Verification Challenge request', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)({ user: user_json_1.default });
@@ -377,6 +397,43 @@ describe('UserManagement', () => {
             expect(response).toBeUndefined();
         }));
     });
+    describe('getPasswordReset', () => {
+        it('sends a Get PaswordReset request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(password_reset_json_1.default);
+            const passwordReset = yield workos.userManagement.getPasswordReset(passwordResetId);
+            expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/password_reset/${passwordResetId}`);
+            expect(passwordReset).toMatchObject({
+                id: 'password_reset_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                userId: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                email: 'dane@workos.com',
+                passwordResetToken: 'Z1uX3RbwcIl5fIGJJJCXXisdI',
+                passwordResetUrl: 'https://your-app.com/reset-password?token=Z1uX3RbwcIl5fIGJJJCXXisdI',
+                expiresAt: '2023-07-18T02:07:19.911Z',
+                createdAt: '2023-07-18T02:07:19.911Z',
+            });
+        }));
+    });
+    describe('createMagicAuth', () => {
+        it('sends a Create Magic Auth request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(password_reset_json_1.default);
+            const response = yield workos.userManagement.createPasswordReset({
+                email: 'dane@workos.com',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/user_management/password_reset');
+            expect((0, test_utils_1.fetchBody)()).toEqual({
+                email: 'dane@workos.com',
+            });
+            expect(response).toMatchObject({
+                id: 'password_reset_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                userId: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                email: 'dane@workos.com',
+                passwordResetToken: 'Z1uX3RbwcIl5fIGJJJCXXisdI',
+                passwordResetUrl: 'https://your-app.com/reset-password?token=Z1uX3RbwcIl5fIGJJJCXXisdI',
+                expiresAt: '2023-07-18T02:07:19.911Z',
+                createdAt: '2023-07-18T02:07:19.911Z',
+            });
+        }));
+    });
     describe('sendPasswordResetEmail', () => {
         it('sends a Send Password Reset Email request', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)();
@@ -471,6 +528,7 @@ describe('UserManagement', () => {
                 type: 'totp',
                 totpIssuer: 'WorkOS',
                 totpUser: 'some_user',
+                totpSecret: 'secret-test',
             });
             expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/users/${userId}/auth_factors`);
             expect(resp).toMatchObject({

package/lib/workos.js

@@ -24,7 +24,7 @@ const audit_logs_1 = require("./audit-logs/audit-logs");
 const user_management_1 = require("./user-management/user-management");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
 const fetch_client_1 = require("./common/utils/fetch-client");
-const VERSION = '7.5.0';
+const VERSION = '7.7.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.5.0",
+  "version": "7.7.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -49,7 +49,7 @@
     "jest-fetch-mock": "^3.0.3",
     "prettier": "2.8.8",
     "supertest": "6.3.3",
-    "ts-jest": "29.1.2",
+    "ts-jest": "29.1.3",
     "tslint": "6.1.3",
     "typescript": "5.1.6"
   }