@workos-inc/node 7.2.0 → 7.4.0

package/lib/common/exceptions/bad-request.exception.d.ts

@@ -1,6 +1,7 @@
-export declare class BadRequestException extends Error {
-    readonly status: number;
-    readonly name: string;
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class BadRequestException extends Error implements RequestException {
+    readonly status = 400;
+    readonly name = "BadRequestException";
     readonly message: string;
     readonly code?: string;
     readonly errors?: unknown[];

package/lib/common/exceptions/generic-server.exception.d.ts

@@ -1,4 +1,5 @@
-export declare class GenericServerException extends Error {
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class GenericServerException extends Error implements RequestException {
     readonly status: number;
     readonly rawData: unknown;
     readonly requestID: string;

package/lib/common/exceptions/index.d.ts

@@ -3,6 +3,7 @@ export * from './bad-request.exception';
 export * from './no-api-key-provided.exception';
 export * from './not-found.exception';
 export * from './oauth.exception';
+export * from './rate-limit-exceeded.exception';
 export * from './signature-verification.exception';
 export * from './unauthorized.exception';
 export * from './unprocessable-entity.exception';

package/lib/common/exceptions/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./bad-request.exception"), exports);
 __exportStar(require("./no-api-key-provided.exception"), exports);
 __exportStar(require("./not-found.exception"), exports);
 __exportStar(require("./oauth.exception"), exports);
+__exportStar(require("./rate-limit-exceeded.exception"), exports);
 __exportStar(require("./signature-verification.exception"), exports);
 __exportStar(require("./unauthorized.exception"), exports);
 __exportStar(require("./unprocessable-entity.exception"), exports);

package/lib/common/exceptions/no-api-key-provided.exception.d.ts

@@ -1,5 +1,5 @@
 export declare class NoApiKeyProvidedException extends Error {
-    readonly status: number;
-    readonly name: string;
+    readonly status = 500;
+    readonly name = "NoApiKeyProvidedException";
     readonly message: string;
 }

package/lib/common/exceptions/not-found.exception.d.ts

@@ -1,6 +1,7 @@
-export declare class NotFoundException extends Error {
-    readonly status: number;
-    readonly name: string;
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class NotFoundException extends Error implements RequestException {
+    readonly status = 404;
+    readonly name = "NotFoundException";
     readonly message: string;
     readonly code?: string;
     readonly requestID: string;

package/lib/common/exceptions/oauth.exception.d.ts

@@ -1,9 +1,10 @@
-export declare class OauthException extends Error {
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class OauthException extends Error implements RequestException {
     readonly status: number;
     readonly requestID: string;
     readonly error: string | undefined;
     readonly errorDescription: string | undefined;
     readonly rawData: unknown;
-    readonly name: string;
+    readonly name = "OauthException";
     constructor(status: number, requestID: string, error: string | undefined, errorDescription: string | undefined, rawData: unknown);
 }

package/lib/common/exceptions/rate-limit-exceeded.exception.d.ts

@@ -0,0 +1,13 @@
+import { GenericServerException } from './generic-server.exception';
+export declare class RateLimitExceededException extends GenericServerException {
+    /**
+     * The number of seconds to wait before retrying the request.
+     */
+    readonly retryAfter: number | null;
+    readonly name = "RateLimitExceededException";
+    constructor(message: string, requestID: string, 
+    /**
+     * The number of seconds to wait before retrying the request.
+     */
+    retryAfter: number | null);
+}

package/lib/common/exceptions/rate-limit-exceeded.exception.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitExceededException = void 0;
+const generic_server_exception_1 = require("./generic-server.exception");
+// Inheriting from `GenericServerException` in order to maintain backwards
+// compatibility with what 429 errors would have previously been thrown as.
+//
+// TODO: Consider making it the base class for all request errors.
+class RateLimitExceededException extends generic_server_exception_1.GenericServerException {
+    constructor(message, requestID, 
+    /**
+     * The number of seconds to wait before retrying the request.
+     */
+    retryAfter) {
+        super(429, message, {}, requestID);
+        this.retryAfter = retryAfter;
+        this.name = 'RateLimitExceededException';
+    }
+}
+exports.RateLimitExceededException = RateLimitExceededException;

package/lib/common/exceptions/signature-verification.exception.d.ts

@@ -1,4 +1,4 @@
 export declare class SignatureVerificationException extends Error {
-    readonly name: string;
+    readonly name = "SignatureVerificationException";
     constructor(message: string);
 }

package/lib/common/exceptions/unauthorized.exception.d.ts

@@ -1,7 +1,8 @@
-export declare class UnauthorizedException extends Error {
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class UnauthorizedException extends Error implements RequestException {
     readonly requestID: string;
-    readonly status: number;
-    readonly name: string;
+    readonly status = 401;
+    readonly name = "UnauthorizedException";
     readonly message: string;
     constructor(requestID: string);
 }

package/lib/common/exceptions/unprocessable-entity.exception.d.ts

@@ -1,7 +1,8 @@
 import { UnprocessableEntityError } from '../interfaces';
-export declare class UnprocessableEntityException extends Error {
-    readonly status: number;
-    readonly name: string;
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class UnprocessableEntityException extends Error implements RequestException {
+    readonly status = 422;
+    readonly name = "UnprocessableEntityException";
     readonly message: string;
     readonly code?: string;
     readonly requestID: string;

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

@@ -1,7 +1,7 @@
 import { DirectoryUser, DirectoryUserResponse, DirectoryGroup, DirectoryGroupResponse, EventDirectory, EventDirectoryResponse } from '../../directory-sync/interfaces';
 import { Organization, OrganizationResponse } from '../../organizations/interfaces';
 import { Connection, ConnectionResponse } from '../../sso/interfaces';
-import { Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
+import { InvitationEvent, InvitationEventResponse, MagicAuthEvent, MagicAuthEventResponse, 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';
 export interface EventBase {
@@ -140,6 +140,22 @@ export interface DsyncUserUpdatedEventResponse extends EventResponseBase {
     event: 'dsync.user.updated';
     data: DirectoryUserResponse & Record<'previous_attributes', any>;
 }
+export interface InvitationCreatedEvent extends EventBase {
+    event: 'invitation.created';
+    data: InvitationEvent;
+}
+export interface InvitationCreatedEventResponse extends EventResponseBase {
+    event: 'invitation.created';
+    data: InvitationEventResponse;
+}
+export interface MagicAuthCreatedEvent extends EventBase {
+    event: 'magic_auth.created';
+    data: MagicAuthEvent;
+}
+export interface MagicAuthCreatedEventResponse extends EventResponseBase {
+    event: 'magic_auth.created';
+    data: MagicAuthEventResponse;
+}
 export interface UserCreatedEvent extends EventBase {
     event: 'user.created';
     data: User;
@@ -264,7 +280,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 | 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 | 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 | 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 EventName = Event['event'];
 export {};

package/lib/common/interfaces/request-exception.interface.d.ts

@@ -0,0 +1,5 @@
+export interface RequestException {
+    readonly status: number;
+    readonly message: string;
+    readonly requestID: string;
+}

package/lib/common/interfaces/request-exception.interface.js

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

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

@@ -40,6 +40,10 @@ 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 '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 'user.created':
         case 'user.updated':
         case 'user.deleted':

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

@@ -7,7 +7,9 @@
     "revoked_at": "2023-07-18T02:07:19.911Z",
     "expires_at": "2023-07-18T02:07:19.911Z",
     "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "inviter_user_id": null,
     "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
+    "accept_invitation_url": "https://myauthkit.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

@@ -10,7 +10,9 @@
             "revoked_at": "2023-07-18T02:07:19.911Z",
             "expires_at": "2023-07-18T02:07:19.911Z",
             "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
+            "inviter_user_id": null,
             "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
+            "accept_invitation_url": "https://myauthkit.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/magic_auth.json

@@ -0,0 +1,10 @@
+{
+    "object": "magic_auth",
+    "id": "magic_auth_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/interfaces/create-magic-auth-options.interface.d.ts

@@ -0,0 +1,8 @@
+export interface CreateMagicAuthOptions {
+    email: string;
+    invitationToken?: string;
+}
+export interface SerializedCreateMagicAuthOptions {
+    email: string;
+    invitation_token?: string;
+}

package/lib/user-management/interfaces/create-magic-auth-options.interface.js

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

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

@@ -9,6 +9,7 @@ export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-refresh-token-options.interface';
 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-user-options.interface';
 export * from './enroll-auth-factor.interface';
@@ -19,6 +20,7 @@ export * from './list-auth-factors-options.interface';
 export * from './list-invitations-options.interface';
 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 './reset-password-options.interface';
 export * from './revoke-session-options.interface';

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

@@ -25,6 +25,7 @@ __exportStar(require("./authenticate-with-password-options.interface"), exports)
 __exportStar(require("./authenticate-with-refresh-token-options.interface"), exports);
 __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-user-options.interface"), exports);
 __exportStar(require("./enroll-auth-factor.interface"), exports);
@@ -35,6 +36,7 @@ __exportStar(require("./list-auth-factors-options.interface"), exports);
 __exportStar(require("./list-invitations-options.interface"), exports);
 __exportStar(require("./list-organization-memberships-options.interface"), exports);
 __exportStar(require("./list-users-options.interface"), exports);
+__exportStar(require("./magic-auth.interface"), exports);
 __exportStar(require("./organization-membership.interface"), exports);
 __exportStar(require("./reset-password-options.interface"), exports);
 __exportStar(require("./revoke-session-options.interface"), exports);

package/lib/user-management/interfaces/invitation.interface.d.ts

@@ -7,7 +7,22 @@ export interface Invitation {
     revokedAt: string | null;
     expiresAt: string;
     organizationId: string | null;
+    inviterUserId: string | null;
     token: string;
+    acceptInvitationUrl: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface InvitationEvent {
+    object: 'invitation';
+    id: string;
+    email: string;
+    state: 'pending' | 'accepted' | 'expired' | 'revoked';
+    acceptedAt: string | null;
+    revokedAt: string | null;
+    expiresAt: string;
+    organizationId: string | null;
+    inviterUserId: string | null;
     createdAt: string;
     updatedAt: string;
 }
@@ -20,7 +35,22 @@ export interface InvitationResponse {
     revoked_at: string | null;
     expires_at: string;
     organization_id: string | null;
+    inviter_user_id: string | null;
     token: string;
+    accept_invitation_url: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface InvitationEventResponse {
+    object: 'invitation';
+    id: string;
+    email: string;
+    state: 'pending' | 'accepted' | 'expired' | 'revoked';
+    accepted_at: string | null;
+    revoked_at: string | null;
+    expires_at: string;
+    organization_id: string | null;
+    inviter_user_id: string | null;
     created_at: string;
     updated_at: string;
 }

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

@@ -0,0 +1,38 @@
+export interface MagicAuth {
+    object: 'magic_auth';
+    id: string;
+    userId: string;
+    email: string;
+    expiresAt: string;
+    code: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface MagicAuthEvent {
+    object: 'magic_auth';
+    id: string;
+    userId: string;
+    email: string;
+    expiresAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface MagicAuthResponse {
+    object: 'magic_auth';
+    id: string;
+    user_id: string;
+    email: string;
+    expires_at: string;
+    code: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface MagicAuthEventResponse {
+    object: 'magic_auth';
+    id: string;
+    user_id: string;
+    email: string;
+    expires_at: string;
+    created_at: string;
+    updated_at: string;
+}

package/lib/user-management/interfaces/magic-auth.interface.js

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

package/lib/user-management/serializers/create-magic-auth-options.serializer.d.ts

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

package/lib/user-management/serializers/create-magic-auth-options.serializer.js

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

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

@@ -4,8 +4,11 @@ export * from './authenticate-with-password-options.serializer';
 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 './enroll-auth-factor-options.serializer';
 export * from './factor.serializer';
+export * from './invitation.serializer';
+export * from './magic-auth.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

@@ -20,8 +20,11 @@ __exportStar(require("./authenticate-with-password-options.serializer"), exports
 __exportStar(require("./authenticate-with-refresh-token.options.serializer"), exports);
 __exportStar(require("./authenticate-with-totp-options.serializer"), exports);
 __exportStar(require("./authentication-response.serializer"), exports);
+__exportStar(require("./create-magic-auth-options.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("./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/invitation.serializer.d.ts

@@ -1,2 +1,3 @@
-import { Invitation, InvitationResponse } from '../interfaces/invitation.interface';
+import { Invitation, InvitationEvent, InvitationEventResponse, InvitationResponse } from '../interfaces/invitation.interface';
 export declare const deserializeInvitation: (invitation: InvitationResponse) => Invitation;
+export declare const deserializeInvitationEvent: (invitation: InvitationEventResponse) => InvitationEvent;

package/lib/user-management/serializers/invitation.serializer.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeInvitation = void 0;
+exports.deserializeInvitationEvent = exports.deserializeInvitation = void 0;
 const deserializeInvitation = (invitation) => ({
     object: invitation.object,
     id: invitation.id,
@@ -10,8 +10,24 @@ const deserializeInvitation = (invitation) => ({
     revokedAt: invitation.revoked_at,
     expiresAt: invitation.expires_at,
     organizationId: invitation.organization_id,
+    inviterUserId: invitation.inviter_user_id,
     token: invitation.token,
+    acceptInvitationUrl: invitation.accept_invitation_url,
     createdAt: invitation.created_at,
     updatedAt: invitation.updated_at,
 });
 exports.deserializeInvitation = deserializeInvitation;
+const deserializeInvitationEvent = (invitation) => ({
+    object: invitation.object,
+    id: invitation.id,
+    email: invitation.email,
+    state: invitation.state,
+    acceptedAt: invitation.accepted_at,
+    revokedAt: invitation.revoked_at,
+    expiresAt: invitation.expires_at,
+    organizationId: invitation.organization_id,
+    inviterUserId: invitation.inviter_user_id,
+    createdAt: invitation.created_at,
+    updatedAt: invitation.updated_at,
+});
+exports.deserializeInvitationEvent = deserializeInvitationEvent;

package/lib/user-management/serializers/magic-auth.serializer.d.ts

@@ -0,0 +1,3 @@
+import { MagicAuth, MagicAuthEvent, MagicAuthEventResponse, MagicAuthResponse } from '../interfaces/magic-auth.interface';
+export declare const deserializeMagicAuth: (magicAuth: MagicAuthResponse) => MagicAuth;
+export declare const deserializeMagicAuthEvent: (magicAuth: MagicAuthEventResponse) => MagicAuthEvent;

package/lib/user-management/serializers/magic-auth.serializer.js

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

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 } from './interfaces';
+import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, CreateUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions, AuthenticateWithRefreshTokenOptions, RefreshAuthenticationResponse, MagicAuth, CreateMagicAuthOptions } from './interfaces';
 import { Challenge } from '../mfa/interfaces';
 import { OrganizationMembership } from './interfaces/organization-membership.interface';
 import { ListOrganizationMembershipsOptions } from './interfaces/list-organization-memberships-options.interface';
@@ -30,6 +30,11 @@ export declare class UserManagement {
     sendVerificationEmail({ userId, }: SendVerificationEmailOptions): Promise<{
         user: User;
     }>;
+    getMagicAuth(magicAuthId: string): Promise<MagicAuth>;
+    createMagicAuth(options: CreateMagicAuthOptions): Promise<MagicAuth>;
+    /**
+     * @deprecated Please use `createMagicAuth` instead. This method will be removed in a future major version.
+     */
     sendMagicAuthCode(options: SendMagicAuthCodeOptions): Promise<void>;
     verifyEmail({ code, userId, }: VerifyEmailOptions): Promise<{
         user: User;

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

@@ -106,6 +106,21 @@ class UserManagement {
             return { user: (0, serializers_1.deserializeUser)(data.user) };
         });
     }
+    getMagicAuth(magicAuthId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/magic_auth/${magicAuthId}`);
+            return (0, serializers_1.deserializeMagicAuth)(data);
+        });
+    }
+    createMagicAuth(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/magic_auth', (0, serializers_1.serializeCreateMagicAuthOptions)(Object.assign({}, options)));
+            return (0, serializers_1.deserializeMagicAuth)(data);
+        });
+    }
+    /**
+     * @deprecated Please use `createMagicAuth` instead. This method will be removed in a future major version.
+     */
     sendMagicAuthCode(options) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.workos.post('/user_management/magic_auth/send', (0, serializers_1.serializeSendMagicAuthCodeOptions)(options));

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

@@ -22,10 +22,12 @@ const organization_membership_json_1 = __importDefault(require("./fixtures/organ
 const list_organization_memberships_json_1 = __importDefault(require("./fixtures/list-organization-memberships.json"));
 const invitation_json_1 = __importDefault(require("./fixtures/invitation.json"));
 const list_invitations_json_1 = __importDefault(require("./fixtures/list-invitations.json"));
+const magic_auth_json_1 = __importDefault(require("./fixtures/magic_auth.json"));
 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 const userId = 'user_01H5JQDV7R7ATEYZDEG0W5PRYS';
 const organizationMembershipId = 'om_01H5JQDV7R7ATEYZDEG0W5PRYS';
 const invitationId = 'invitation_01H5JQDV7R7ATEYZDEG0W5PRYS';
+const magicAuthId = 'magic_auth_01H5JQDV7R7ATEYZDEG0W5PRYS';
 describe('UserManagement', () => {
     beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     describe('getUser', () => {
@@ -324,6 +326,43 @@ describe('UserManagement', () => {
             }));
         });
     });
+    describe('getMagicAuth', () => {
+        it('sends a Get Magic Auth request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(magic_auth_json_1.default);
+            const magicAuth = yield workos.userManagement.getMagicAuth(magicAuthId);
+            expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/magic_auth/${magicAuthId}`);
+            expect(magicAuth).toMatchObject({
+                id: 'magic_auth_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('createMagicAuth', () => {
+        it('sends a Create Magic Auth request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(magic_auth_json_1.default);
+            const response = yield workos.userManagement.createMagicAuth({
+                email: 'bob.loblaw@example.com',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/user_management/magic_auth');
+            expect((0, test_utils_1.fetchBody)()).toEqual({
+                email: 'bob.loblaw@example.com',
+            });
+            expect(response).toMatchObject({
+                id: 'magic_auth_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('sendMagicAuthCode', () => {
         it('sends a Send Magic Auth Code request', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)();

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.2.0';
+const VERSION = '7.4.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -170,6 +170,10 @@ class WorkOS {
                         requestID,
                     });
                 }
+                case 429: {
+                    const retryAfter = headers.get('Retry-After');
+                    throw new exceptions_1.RateLimitExceededException(data.message, requestID, retryAfter ? Number(retryAfter) : null);
+                }
                 default: {
                     if (error || errorDescription) {
                         throw new exceptions_1.OauthException(status, requestID, error, errorDescription, data);

package/lib/workos.spec.js

@@ -17,6 +17,7 @@ const test_utils_1 = require("./common/utils/test-utils");
 const promises_1 = __importDefault(require("fs/promises"));
 const exceptions_1 = require("./common/exceptions");
 const workos_1 = require("./workos");
+const rate_limit_exceeded_exception_1 = require("./common/exceptions/rate-limit-exceeded.exception");
 describe('WorkOS', () => {
     beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     describe('constructor', () => {
@@ -163,6 +164,18 @@ describe('WorkOS', () => {
                 yield expect(workos.post('/path', {})).rejects.toStrictEqual(new exceptions_1.OauthException(400, 'a-request-id', 'error', 'error description', { error: 'error', error_description: 'error description' }));
             }));
         });
+        describe('when the api responses with a 429', () => {
+            it('throws a RateLimitExceededException', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)({
+                    message: 'Too many requests',
+                }, {
+                    status: 429,
+                    headers: { 'X-Request-ID': 'a-request-id', 'Retry-After': '10' },
+                });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.get('/path')).rejects.toStrictEqual(new rate_limit_exceeded_exception_1.RateLimitExceededException('Too many requests', 'a-request-id', 10));
+            }));
+        });
         describe('when the entity is null', () => {
             it('sends a null body', () => __awaiter(void 0, void 0, void 0, function* () {
                 (0, test_utils_1.fetchOnce)();

package/package.json

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