Update Node SDK to include auditlogs.listSchemas

[swaroopAkkineniWorkos]

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

Description

Adding in the following Audit Log endpoints:

• List Schemas

[swaroopAkkineniWorkos]

@greptile review

[greptile-apps]

_{16 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

[swaroopAkkineniWorkos]

@greptile re-review plz

[greptile-apps]

_{5 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[swaroopAkkineniWorkos]

@greptile re-review plz

[greptile-apps]

_{6 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[swaroopAkkineniWorkos]

@greptile re-review plz

[greptile-apps]

_{4 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[swaroopAkkineniWorkos]

@greptile re-review plz

[swaroopAkkineniWorkos]

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

[greptile-apps]

Greptile Overview

Greptile Summary

This PR adds the listSchemas endpoint to the Audit Logs API, completing the audit log schema management functionality. The implementation properly handles pagination and follows existing SDK patterns.

Key Changes

• Added listSchemas() method to AuditLogs class with pagination support via AutoPaginatable
• Renamed create-audit-log-schema-options.interface.ts to audit-log-schema.interface.ts and consolidated schema-related types
• Made actor field properly optional in both AuditLogSchema and AuditLogSchemaResponse interfaces
• Renamed CreateAuditLogSchemaResponse to AuditLogSchemaResponse for better consistency
• Updated deserializer to handle optional actor field correctly
• Added comprehensive test coverage including pagination, error handling, and edge cases

Confidence Score: 5/5

• This PR is safe to merge with no issues found
• The implementation follows established patterns in the codebase, includes comprehensive test coverage, properly handles edge cases (optional fields, pagination), and introduces no security concerns or breaking changes
• No files require special attention

Important Files Changed

Filename	Overview
src/audit-logs/audit-logs.ts	Added listSchemas method following existing patterns with proper pagination support
src/audit-logs/interfaces/audit-log-schema.interface.ts	Renamed from create-audit-log-schema-options.interface.ts, made actor field properly optional, and renamed response type
src/audit-logs/serializers/create-audit-log-schema.serializer.ts	Updated deserializeAuditLogSchema to handle optional actor field correctly

Sequence Diagram

sequenceDiagram
    participant Client
    participant AuditLogs
    participant WorkOS
    participant API as WorkOS API
    participant Deserializer

    Client->>AuditLogs: listSchemas(options)
    Note over AuditLogs: Extract action from options<br/>Build endpoint URL
    AuditLogs->>WorkOS: fetchAndDeserialize(endpoint, deserializeFn, paginationOptions)
    WorkOS->>API: GET /audit_logs/actions/{action}/schemas?order=desc&limit=...
    API-->>WorkOS: ListResponse<AuditLogSchemaResponse>
    WorkOS->>Deserializer: deserializeList(data, deserializeAuditLogSchema)
    loop For each schema in response
        Deserializer->>Deserializer: deserializeAuditLogSchema(schema)
        Note over Deserializer: Convert metadata from<br/>{properties: {key: {type: 'string'}}}<br/>to {key: 'string'}
        Note over Deserializer: Handle optional actor field
    end
    Deserializer-->>WorkOS: List<AuditLogSchema>
    WorkOS-->>AuditLogs: List<AuditLogSchema>
    AuditLogs->>AuditLogs: new AutoPaginatable(list, fetchFn, options)
    AuditLogs-->>Client: AutoPaginatable<AuditLogSchema>

Loading

[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]

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