Migrate Audit Logs to camelCased (#780)

## Description

* Part of a wider initiative to migrate our Node SDK to camel case for
the 3.0.0 release.
* Migrates the Audit Log module to camel case.

## 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.

Co-authored-by: Willman Duffy <[email protected]>

Author: willmanduffy

src/audit-logs/audit-logs.spec.ts

@@ -4,7 +4,15 @@ import {
   CreateAuditLogEventRequestOptions,
 } from './interfaces';
 import { AuditLogExportOptions } from './interfaces/audit-log-export-options.interface';
-import { AuditLogExport } from './interfaces/audit-log-export.interface';
+import {
+  AuditLogExport,
+  AuditLogExportResponse,
+} from './interfaces/audit-log-export.interface';
+import {
+  deserializeAuditLogExport,
+  serializeAuditLogExportOptions,
+  serializeCreateAuditLogEventOptions,
+} from './serializers';
 
 export class AuditLogs {
   constructor(private readonly workos: WorkOS) {}
@@ -17,24 +25,27 @@ export class AuditLogs {
     await this.workos.post(
       '/audit_logs/events',
       {
-        event,
+        event: serializeCreateAuditLogEventOptions(event),
         organization_id: organization,
       },
       options,
     );
   }
 
   async createExport(options: AuditLogExportOptions): Promise<AuditLogExport> {
-    const { data } = await this.workos.post('/audit_logs/exports', options);
+    const { data } = await this.workos.post<AuditLogExportResponse>(
+      '/audit_logs/exports',
+      serializeAuditLogExportOptions(options),
+    );
 
-    return data;
+    return deserializeAuditLogExport(data);
   }
 
   async getExport(auditLogExportId: string): Promise<AuditLogExport> {
-    const { data } = await this.workos.get(
+    const { data } = await this.workos.get<AuditLogExportResponse>(
       `/audit_logs/exports/${auditLogExportId}`,
     );
 
-    return data;
+    return deserializeAuditLogExport(data);
   }
 }

src/audit-logs/audit-logs.ts

@@ -1,13 +1,24 @@
 export interface AuditLogExportOptions {
   actions?: string[];
   /**
-   * @deprecated Please use `actor_names` instead.
+   * @deprecated Please use `actorNames` instead.
    */
   actors?: string[];
+  actorNames?: string[];
+  actorIds?: string[];
+  organizationId: string;
+  rangeEnd: Date;
+  rangeStart: Date;
+  targets?: string[];
+}
+
+export interface SerializedAuditLogExportOptions {
+  actions?: string[];
+  actors?: string[];
   actor_names?: string[];
   actor_ids?: string[];
   organization_id: string;
-  range_end: Date;
-  range_start: Date;
+  range_end: string;
+  range_start: string;
   targets?: string[];
 }

src/audit-logs/interfaces/audit-log-export-options.interface.ts

@@ -1,4 +1,13 @@
 export interface AuditLogExport {
+  object: 'audit_log_export';
+  id: string;
+  state: 'pending' | 'ready' | 'error';
+  url?: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface AuditLogExportResponse {
   object: 'audit_log_export';
   id: string;
   state: 'pending' | 'ready' | 'error';

src/audit-logs/interfaces/audit-log-export.interface.ts

@@ -17,7 +17,20 @@ export interface AuditLogTarget {
 export interface CreateAuditLogEventOptions {
   action: string;
   version?: number;
-  occurred_at: Date;
+  occurredAt: Date;
+  actor: AuditLogActor;
+  targets: AuditLogTarget[];
+  context: {
+    location: string;
+    userAgent?: string;
+  };
+  metadata?: Record<string, string | number | boolean>;
+}
+
+export interface SerializedCreateAuditLogEventOptions {
+  action: string;
+  version?: number;
+  occurred_at: string;
   actor: AuditLogActor;
   targets: AuditLogTarget[];
   context: {

src/audit-logs/interfaces/create-audit-log-event-options.interface.ts

@@ -0,0 +1,17 @@
+import {
+  AuditLogExportOptions,
+  SerializedAuditLogExportOptions,
+} from '../interfaces';
+
+export const serializeAuditLogExportOptions = (
+  options: AuditLogExportOptions,
+): SerializedAuditLogExportOptions => ({
+  actions: options.actions,
+  actors: options.actors,
+  actor_names: options.actorNames,
+  actor_ids: options.actorIds,
+  organization_id: options.organizationId,
+  range_end: options.rangeEnd.toISOString(),
+  range_start: options.rangeStart.toISOString(),
+  targets: options.targets,
+});

src/audit-logs/serializers/audit-log-export-options.serializer.ts

@@ -0,0 +1,12 @@
+import { AuditLogExport, AuditLogExportResponse } from '../interfaces';
+
+export const deserializeAuditLogExport = (
+  auditLogExport: AuditLogExportResponse,
+): AuditLogExport => ({
+  object: auditLogExport.object,
+  id: auditLogExport.id,
+  state: auditLogExport.state,
+  url: auditLogExport.url,
+  createdAt: auditLogExport.created_at,
+  updatedAt: auditLogExport.updated_at,
+});

src/audit-logs/serializers/audit-log-export.serializer.ts

@@ -0,0 +1,19 @@
+import {
+  CreateAuditLogEventOptions,
+  SerializedCreateAuditLogEventOptions,
+} from '../interfaces';
+
+export const serializeCreateAuditLogEventOptions = (
+  event: CreateAuditLogEventOptions,
+): SerializedCreateAuditLogEventOptions => ({
+  action: event.action,
+  version: event.version,
+  occurred_at: event.occurredAt.toISOString(),
+  actor: event.actor,
+  targets: event.targets,
+  context: {
+    location: event.context.location,
+    user_agent: event.context.userAgent,
+  },
+  metadata: event.metadata,
+});

src/audit-logs/serializers/create-audit-log-event-options.serializer.ts

@@ -0,0 +1,3 @@
+export * from './audit-log-export.serializer';
+export * from './audit-log-export-options.serializer';
+export * from './create-audit-log-event-options.serializer';

src/audit-logs/serializers/index.ts

@@ -0,0 +1,7 @@
+export const mockWorkOsResponse = (status: number, data: unknown) => ({
+  data,
+  status,
+  headers: {},
+  statusText: '',
+  config: {} as any,
+});