Update Node SDK to include auditlogs.listSchemas by swaroopAkkineniWorkos · Pull Request #1457 · workos/workos-node

swaroopAkkineniWorkos · 2026-02-01T01:59:46Z

https://linear.app/workos/issue/ENT-5028/update-node-sdk-to-include-listschemas

Description

Adding in the following Audit Log endpoints:

List Schemas

swaroopAkkineniWorkos · 2026-02-01T02:39:42Z

@greptile review

greptile-apps

_{16 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

swaroopAkkineniWorkos · 2026-02-01T07:33:38Z

@greptile re-review plz

greptile-apps

_{5 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

swaroopAkkineniWorkos · 2026-02-01T07:46:28Z

@greptile re-review plz

greptile-apps

_{6 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

swaroopAkkineniWorkos · 2026-02-01T08:47:51Z

@greptile re-review plz

greptile-apps

_{4 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

swaroopAkkineniWorkos · 2026-02-02T15:17:05Z

@greptile re-review plz

swaroopAkkineniWorkos · 2026-02-02T15:17:32Z

@claude can you review and ensure it complies with the listSchema api

greptile-apps

_{3 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps

_{3 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

mattgd · 2026-02-02T15:51:25Z

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

 }

-export interface CreateAuditLogSchemaResponse {
+export interface AuditLogSchemaResponse {


If this is exported publicly, this would be a breaking change. Perhaps we can alias CreateAuditLogSchemaResponse to AuditLogSchemaResponse and mark CreateAuditLogSchemaResponse as deprecated?

@mattgd updated. Added the alias and also leaving all the exports in CreateAuditLogSchemaResponse as is and just exporting the types from the common, new audit log interface i made.

swaroopAkkineniWorkos · 2026-02-02T17:57:29Z

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

-export interface AuditLogTargetSchema {
-  type: string;
-  metadata?: Record<string, string | boolean | number> | undefined;
-}


moved to src/audit-logs/interfaces/audit-log-schema.interface.ts

swaroopAkkineniWorkos · 2026-02-02T18:13:16Z

@greptile re-review plz

greptile-apps · 2026-02-02T18:16:20Z

Greptile Overview

Greptile Summary

This PR adds support for the Audit Logs “List Schemas” endpoint by introducing AuditLogs.listSchemas, new schema-related interfaces (AuditLogSchema, AuditLogSchemaResponse, ListSchemasOptions), and tests that validate pagination and deserialization behavior. It reuses the existing audit log schema deserializer (originally for create schema) so both create/list return the same simplified metadata shape in the SDK.

Confidence Score: 4/5

This PR is likely safe to merge with low risk; changes are additive and covered by tests.
The new endpoint follows existing pagination/serialization patterns and includes comprehensive spec coverage. Remaining concerns are mainly type-shape ergonomics (properties typed as required-but-undefined) and minor import hygiene in tests, rather than runtime-breaking logic.
src/audit-logs/interfaces/audit-log-schema.interface.ts

Important Files Changed

Filename	Overview
src/audit-logs/audit-logs.ts	Adds `auditLogs.listSchemas` using `fetchAndDeserialize` + `AutoPaginatable` over `/audit_logs/actions/{action}/schemas`.
src/audit-logs/audit-logs.spec.ts	Adds coverage for `listSchemas` including pagination and optional fields; minor import could be `import type`.
src/audit-logs/interfaces/audit-log-schema.interface.ts	Introduces shared schema types for create/list; `AuditLogSchemaMetadata` typing makes `properties` required-but-undefined.
src/audit-logs/interfaces/create-audit-log-schema-options.interface.ts	Refactors create-schema interfaces to re-export shared schema types and deprecates `CreateAuditLogSchemaResponse` in favor of `AuditLogSchemaResponse`.
src/audit-logs/interfaces/index.ts	Exports the new schema and list-schemas option interfaces from the audit-logs barrel.
src/audit-logs/interfaces/list-schemas-options.interface.ts	Adds `ListSchemasOptions` extending `PaginationOptions` with required `action`.
src/audit-logs/serializers/create-audit-log-schema.serializer.ts	Updates schema deserializer to accept `AuditLogSchemaResponse` and handle missing `actor` safely.

Sequence Diagram

sequenceDiagram
  participant C as SDK Consumer
  participant AL as AuditLogs
  participant P as AutoPaginatable
  participant W as WorkOS HTTP client
  participant API as WorkOS API

  C->>AL: listSchemas({action, limit?, after?, order?})
  AL->>AL: endpoint = /audit_logs/actions/{action}/schemas
  AL->>W: GET endpoint (query = paginationOptions)
  W->>API: GET /audit_logs/actions/{action}/schemas
  API-->>W: 200 ListResponse<AuditLogSchemaResponse>
  W-->>AL: response data
  AL->>AL: deserializeAuditLogSchema(schemaResponse)
  AL-->>P: new AutoPaginatable(firstPage, getNextPageFn, options)
  P-->>C: paginated result (data + listMetadata)

  C->>P: nextPage()
  P->>W: GET endpoint (query = {after/before/limit/order})
  W->>API: GET /audit_logs/actions/{action}/schemas
  API-->>W: 200 ListResponse<AuditLogSchemaResponse>
  W-->>P: response data
  P->>P: deserializeAuditLogSchema(...) for each item
  P-->>C: next page

greptile-apps

_{7 files reviewed, 3 comments}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2026-02-02T18:16:24Z

src/audit-logs/audit-logs.ts

+  async listSchemas(
+    options: ListSchemasOptions,
+  ): Promise<AutoPaginatable<AuditLogSchema, ListSchemasOptions>> {
+    const { action, ...paginationOptions } = options;
+    const endpoint = `/audit_logs/actions/${action}/schemas`;


[P2] listSchemas should accept optional options like other list methods

listSchemas(options: ListSchemasOptions) forces callers to pass an object, even ListSchemasOptions is mostly pagination + required action. Most other list-style SDK methods take options?: ... and allow a simpler call-site / future optional expansion. Consider listSchemas(action: string, options?: PaginationOptions) or listSchemas(options: ListSchemasOptions) but make options optional with a runtime check.

(If this is intentional API design, please ignore—just flagging because it differs from the rest of the SDK pattern.)

_{Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!}

Prompt To Fix With AI

This is a comment left during a code review. Path: src/audit-logs/audit-logs.ts Line: 88:92 Comment: [P2] `listSchemas` should accept optional options like other list methods `listSchemas(options: ListSchemasOptions)` forces callers to pass an object, even `ListSchemasOptions` is mostly pagination + required `action`. Most other list-style SDK methods take `options?: ...` and allow a simpler call-site / future optional expansion. Consider `listSchemas(action: string, options?: PaginationOptions)` or `listSchemas(options: ListSchemasOptions)` but make `options` optional with a runtime check. (If this is intentional API design, please ignore—just flagging because it differs from the rest of the SDK pattern.) <sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub> How can I resolve this? If you propose a fix, please make it concise.

@swaroopAkkineniWorkos This isn't a bad suggestion, since it might be a bit easier for devs to use listSchemas(action) if they're using the auto-pagination.

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

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

greptile-apps

_{7 files reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}

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

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

mattgd · 2026-02-04T15:58:00Z

src/audit-logs/audit-logs.ts

+  async listSchemas(
+    options: ListSchemasOptions,
+  ): Promise<AutoPaginatable<AuditLogSchema, ListSchemasOptions>> {
+    const { action, ...paginationOptions } = options;
+    const endpoint = `/audit_logs/actions/${action}/schemas`;


@swaroopAkkineniWorkos This isn't a bad suggestion, since it might be a bit easier for devs to use listSchemas(action) if they're using the auto-pagination.

mattgd · 2026-02-04T15:59:07Z

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

+export type {
+  AuditLogSchema,
+  AuditLogSchemaResponse,
+  AuditLogSchemaMetadata,
+  AuditLogActorSchema,
+  AuditLogTargetSchema,
+} from './audit-log-schema.interface';
+
+import type {
+  AuditLogSchemaMetadata,
+  AuditLogSchemaResponse,
+  AuditLogActorSchema,
+  AuditLogTargetSchema,
+} from './audit-log-schema.interface';


I believe this actually isn't required because the barrel file exports these all at the same location whether they're in this file or the audit-log-schema.interface.ts file.

init

4bf8530

swaroopAkkineniWorkos changed the title ~~init~~ Update Node SDK to ensure that all audit-log api's are in it Feb 1, 2026

lol

0b3f7d0

greptile-apps bot reviewed Feb 1, 2026

View reviewed changes

lol

c155b07

workos deleted a comment from greptile-apps bot Feb 1, 2026

greptile-apps bot reviewed Feb 1, 2026

View reviewed changes

workos deleted a comment from greptile-apps bot Feb 1, 2026

greptile-apps bot reviewed Feb 1, 2026

View reviewed changes

swaroopAkkineniWorkos added 2 commits January 31, 2026 22:28

moar

64dee8d

moar

32f9bc3

workos deleted a comment from greptile-apps bot Feb 1, 2026

greptile-apps bot reviewed Feb 1, 2026

View reviewed changes

swaroopAkkineniWorkos added 6 commits February 2, 2026 04:17

revert package-lock to main

d5e63cb

lol

a55e9b7

review

6d3cf2a

moar

e4ae749

lol

2767707

lol

ddb4337

workos deleted a comment from greptile-apps bot Feb 2, 2026

greptile-apps bot reviewed Feb 2, 2026

View reviewed changes

swaroopAkkineniWorkos marked this pull request as ready for review February 2, 2026 15:22

swaroopAkkineniWorkos requested a review from a team as a code owner February 2, 2026 15:22

swaroopAkkineniWorkos requested review from a team, PavanKulkarni, ajworkos, atainter, csrbarber, katie-west, kendallstrautman and mattgd and removed request for a team February 2, 2026 15:22

swaroopAkkineniWorkos added the enhancement New feature or request label Feb 2, 2026

swaroopAkkineniWorkos changed the title ~~Update Node SDK to ensure that all audit-log api's are in it~~ Update Node SDK to include auditlogs.listSchemas Feb 2, 2026

greptile-apps bot reviewed Feb 2, 2026

View reviewed changes

mattgd reviewed Feb 2, 2026

View reviewed changes

lol

f325b7e

swaroopAkkineniWorkos commented Feb 2, 2026

View reviewed changes

swaroopAkkineniWorkos added 3 commits February 2, 2026 08:02

moar

1b36ea2

prettier

34c491f

prettier

1e0672f

workos deleted a comment from greptile-apps bot Feb 2, 2026

greptile-apps bot reviewed Feb 2, 2026

View reviewed changes

swaroopAkkineniWorkos marked this pull request as draft February 2, 2026 18:18

swaroopAkkineniWorkos requested a review from mattgd February 2, 2026 19:25

swaroopAkkineniWorkos marked this pull request as ready for review February 2, 2026 20:39

greptile-apps bot reviewed Feb 2, 2026

View reviewed changes

src/audit-logs/interfaces/audit-log-schema.interface.ts Show resolved Hide resolved

src/audit-logs/audit-logs.spec.ts Show resolved Hide resolved

swaroopAkkineniWorkos added 2 commits February 4, 2026 04:38

nit

3079d1c

nit

d120d41

mattgd reviewed Feb 4, 2026

View reviewed changes

Conversation

swaroopAkkineniWorkos commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

swaroopAkkineniWorkos commented Feb 1, 2026

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

swaroopAkkineniWorkos commented Feb 1, 2026

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

swaroopAkkineniWorkos commented Feb 1, 2026

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

swaroopAkkineniWorkos commented Feb 1, 2026

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

swaroopAkkineniWorkos commented Feb 2, 2026

Uh oh!

swaroopAkkineniWorkos commented Feb 2, 2026

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

mattgd Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

swaroopAkkineniWorkos Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

swaroopAkkineniWorkos Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

swaroopAkkineniWorkos commented Feb 2, 2026

Uh oh!

greptile-apps bot commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Overview

Greptile Summary

Confidence Score: 4/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

mattgd Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mattgd Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

mattgd Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

swaroopAkkineniWorkos commented Feb 1, 2026 •

edited

Loading

greptile-apps bot commented Feb 2, 2026 •

edited

Loading