AuditsResource

API reference for the Audits resource.

Audit Methods

list

List all audits.

async list(): Promise<Audit[]>

---

get

Get a specific audit.

async get(id: string): Promise<Audit>

---

create

Create a new audit.

async create(data: CreateAuditInput): Promise<Audit>

Parameters:

interface CreateAuditInput {
  type: string;
  scope?: string;
  owners?: string[];
  auditor?: string;
  scheduledDate?: string;
  status?: string;
  notes?: string;
}

---

update

Update an audit.

async update(id: string, data: Partial<CreateAuditInput>): Promise<Audit>

---

delete

Delete an audit.

async delete(id: string): Promise<void>

Finding Methods (within Audit)

listFindings

List findings for a specific audit.

async listFindings(auditId: string): Promise<Finding[]>

---

createFinding

Create a finding for an audit.

async createFinding(auditId: string, data: Omit<CreateFindingInput, 'auditId'>): Promise<Finding>

---

updateFinding

Update a finding within an audit.

async updateFinding(auditId: string, findingId: string, data: Partial<CreateFindingInput>): Promise<Finding>

---

deleteFinding

Delete a finding from an audit.

async deleteFinding(auditId: string, findingId: string): Promise<void>

Types

Audit

interface Audit {
  id: string;
  type: string;
  scope?: string;
  owners?: string[];
  auditor?: string;
  scheduledDate?: string;
  status?: string;
  notes?: string;
  tenantId?: string;
  createdBy?: string;
  createdAt?: string;
  updatedAt?: string;
}

Finding

interface Finding {
  id: string;
  title?: string;
  description: string;
  severity?: 'low' | 'medium' | 'high' | 'critical';
  status?: string;
  assignee?: string;
  dueDate?: string;
  control?: string;
  linkedDocuments?: string[];
  auditId?: string | null;
  origin?: 'audit' | 'standalone';
  tenantId?: string;
  createdBy?: string;
  createdAt?: string;
  updatedAt?: string;
}