add locale to user (#1363)

## Description

adds `locale` to the User object, adds support for updating User locale

## Documentation

Does this require changes to the WorkOS Docs? E.g. the [API
Reference](https://workos.com/docs/reference) or code snippets need
updates.

```
[X] Yes
```

If yes, link a related docs PR and add a docs maintainer as a reviewer.
Their approval is required.

Author: stacurry

src/user-management/fixtures/list-users.json

@@ -11,7 +11,8 @@
       "updated_at": "2023-07-18T02:07:19.911Z",
       "email_verified": true,
       "profile_picture_url": "https://example.com/profile_picture.jpg",
-      "last_sign_in_at": "2023-07-18T02:07:19.911Z"
+      "last_sign_in_at": "2023-07-18T02:07:19.911Z",
+      "locale": "en-US"
     }
   ],
   "list_metadata": {

src/user-management/fixtures/user.json

@@ -9,5 +9,6 @@
   "email_verified": true,
   "profile_picture_url": "https://example.com/profile_picture.jpg",
   "last_sign_in_at": "2023-07-18T02:07:19.911Z",
+  "locale": "en-US",
   "metadata": { "key": "value" }
 }

src/user-management/interfaces/update-user-options.interface.ts

@@ -10,6 +10,7 @@ export interface UpdateUserOptions {
   passwordHash?: string;
   passwordHashType?: PasswordHashType;
   externalId?: string;
+  locale?: string;
   metadata?: Record<string, string | null>;
 }
 
@@ -22,5 +23,6 @@ export interface SerializedUpdateUserOptions {
   password_hash?: string;
   password_hash_type?: PasswordHashType;
   external_id?: string;
+  locale?: string;
   metadata?: Record<string, string | null>;
 }

src/user-management/interfaces/user.interface.ts

@@ -7,6 +7,7 @@ export interface User {
   firstName: string | null;
   lastName: string | null;
   lastSignInAt: string | null;
+  locale: string | null;
   createdAt: string;
   updatedAt: string;
   externalId: string | null;
@@ -22,6 +23,7 @@ export interface UserResponse {
   first_name: string | null;
   last_name: string | null;
   last_sign_in_at: string | null;
+  locale: string | null;
   created_at: string;
   updated_at: string;
   external_id?: string;

src/user-management/serializers/update-user-options.serializer.ts

@@ -11,5 +11,6 @@ export const serializeUpdateUserOptions = (
   password_hash: options.passwordHash,
   password_hash_type: options.passwordHashType,
   external_id: options.externalId,
+  locale: options.locale,
   metadata: options.metadata,
 });

src/user-management/serializers/user.serializer.ts

@@ -9,6 +9,7 @@ export const deserializeUser = (user: UserResponse): User => ({
   profilePictureUrl: user.profile_picture_url,
   lastName: user.last_name,
   lastSignInAt: user.last_sign_in_at,
+  locale: user.locale,
   createdAt: user.created_at,
   updatedAt: user.updated_at,
   externalId: user.external_id ?? null,

src/user-management/user-management.spec.ts

@@ -56,6 +56,7 @@ describe('UserManagement', () => {
         lastName: 'User',
         emailVerified: true,
         lastSignInAt: '2023-07-18T02:07:19.911Z',
+        locale: 'en-US',
       });
     });
   });
@@ -78,6 +79,7 @@ describe('UserManagement', () => {
         lastName: 'User',
         emailVerified: true,
         lastSignInAt: '2023-07-18T02:07:19.911Z',
+        locale: 'en-US',
         externalId,
       });
     });
@@ -1479,6 +1481,25 @@ describe('UserManagement', () => {
         metadata: {},
       });
     });
+
+    it('updates user locale', async () => {
+      fetchOnce(userFixture);
+
+      const resp = await workos.userManagement.updateUser({
+        userId,
+        locale: 'en-US',
+      });
+
+      expect(fetchURL()).toContain(`/user_management/users/${userId}`);
+      expect(fetchBody()).toEqual({
+        locale: 'en-US',
+      });
+
+      expect(resp).toMatchObject({
+        id: userId,
+        locale: 'en-US',
+      });
+    });
   });
 
   describe('enrollAuthFactor', () => {