IncidentsResource

API reference for the Incidents resource.

Methods

list

List all incidents.

async list(): Promise<Incident[]>

get

Get a single incident by ID.

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

create

Create a new incident.

async create(data: CreateIncidentInput): Promise<Incident>

Parameters:

interface CreateIncidentInput {
  summary: string;
  description?: string;
  owner?: string;
  status?: string;
  severity?: string;
  reportedDate?: string;
  resolvedDate?: string | null;
  auditId?: string | null;
}

update

Update an existing incident.

async update(id: string, data: Partial<CreateIncidentInput>): Promise<Incident>

delete

Delete an incident.

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

Types

Incident

interface Incident {
  id: string;
  summary: string;
  description?: string;
  owner?: string;
  status?: string;
  severity?: string;
  reportedDate?: string;
  resolvedDate?: string | null;
  auditId?: string | null;
  tenantId?: string;
  createdBy?: string;
  createdAt?: string;
  updatedAt?: string;
}