Data Models

Overview of all frozen dataclasses and value types returned by the OptixLog SDK.

The OptixLog SDK returns rich, typed data objects from every API call. All models are either frozen dataclasses or plain classes with explicit __init__ signatures. They are read-only value objects — you never mutate them.

Where models live

All model classes are importable from optixlog.management:

from optixlog.management import (
    ProjectConfig,
    Organization,
    Team,
    User,
    TeamMembership,
    ProjectMember,
    NodeLabel,
    FileRef,
    WorkflowNode,
    AuditEvent,
    ProjectSnapshot,
)
from optixlog import EntityRef, Page

Model summary

Class	Module	Frozen	Description
`EntityRef`	`optixlog`	yes	Lightweight `(type, id, name?)` reference used throughout the SDK.
`Page[T]`	`optixlog`	yes	Paginated result container: `items`, `next_cursor`, `total`.
`ProjectConfig`	`optixlog.management`	yes	Project metadata: name, description, status, timestamps.
`Organization`	`optixlog.management`	yes	Organization info: contact details, industry, timestamps.
`Team`	`optixlog.management`	no*	Team with bound `memberships` collection.
`User`	`optixlog.management`	yes	User identity: email, auth details, timestamps.
`TeamMembership`	`optixlog.management`	yes	A user's membership in a team: role, joined_at, optional hydrated user/team.
`ProjectMember`	`optixlog.management`	yes	A project member: user ref + optional membership list.
`NodeLabel`	`optixlog.management`	yes	A workflow node type label: id, name, documentation ID.
`FileRef`	`optixlog.management`	yes	A file attachment reference: URI, MIME type, size, role, slot.
`WorkflowNode`	`optixlog.management`	yes	A workflow graph node: properties, attachments, edges, timestamps.
`AuditEvent`	`optixlog.management`	yes	An audit log entry: action, level, actor, targets, metadata.
`ProjectSnapshot`	`optixlog.management`	yes	A multi-section project snapshot: all fields optional.

* Team is not a @dataclass because it carries a client-bound memberships collection alongside an optional member_count, which dataclass field ordering rules cannot express. Its fields are otherwise immutable by convention.