ChecklistsResource

API reference for the Checklists resource.

Template Methods

listTemplates

List all checklist templates.

async listTemplates(): Promise<ChecklistTemplate[]>

---

getTemplate

Get a specific template.

async getTemplate(id: string): Promise<ChecklistTemplate>

---

createTemplate

Create a new template.

async createTemplate(data: CreateTemplateInput): Promise<ChecklistTemplate>

Parameters:

interface CreateTemplateInput {
  title: string;
  description?: string;
  standard?: string;
  standards?: string[];
  items: ChecklistItem[];
  isReusable?: boolean;
  isAssuranceTask?: boolean;
  badgeClass?: string;
  repeat?: {
    frequency?: string;
    interval?: number;
    startDate?: string;
    endDate?: string | null;
  };
  reviewDate?: string | null;
}

---

updateTemplate

Update a template.

async updateTemplate(id: string, data: Partial<CreateTemplateInput>): Promise<ChecklistTemplate>

---

deleteTemplate

Delete a template.

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

Checklist Methods

list

List all checklists.

async list(options?: { templateId?: string; status?: string }): Promise<Checklist[]>

---

get

Get a specific checklist.

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

---

create

Create a new checklist.

async create(data: CreateChecklistInput): Promise<Checklist>

---

createFromTemplate

Create a checklist from a template.

async createFromTemplate(templateId: string): Promise<Checklist>

---

update

Update a checklist.

async update(id: string, data: UpdateChecklistInput): Promise<Checklist>

---

submit

Submit/complete a checklist.

async submit(id: string, data?: SubmitChecklistInput): Promise<Checklist>

Parameters:

interface SubmitChecklistInput {
  signature?: string;
  values?: Record<string, any>;
  findings?: any[];
}

---

delete

Delete a checklist.

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

Types

ChecklistTemplate

interface ChecklistTemplate {
  id: string;
  title: string;
  description?: string;
  standard?: string;
  standards?: string[];
  items: ChecklistItem[];
  isReusable?: boolean;
  isAssuranceTask?: boolean;
  badgeClass?: string;
  repeat?: {
    frequency?: string;
    interval?: number;
    startDate?: string;
    endDate?: string | null;
  };
  reviewDate?: string | null;
  tenantId?: string;
  createdBy?: string;
  createdAt?: string;
  updatedAt?: string;
}

Checklist

interface Checklist {
  id: string;
  title: string;
  description?: string;
  templateId?: string;
  standard?: string;
  standards?: string[];
  items: ChecklistItem[];
  status: 'draft' | 'in-progress' | 'completed' | string;
  isAssuranceTask?: boolean;
  isReusable?: boolean;
  repeat?: {
    frequency?: string;
    interval?: number;
    startDate?: string;
    endDate?: string | null;
  };
  reviewDate?: string | null;
  tenantId?: string;
  createdBy?: string;
  createdAt?: string;
  updatedAt?: string;
  completedAt?: string | null;
  completedBy?: string | null;
  completionHistory?: Array<{
    completedAt: string;
    completedBy: string;
    values?: Record<string, any>;
    signature?: string;
    findings?: any[];
  }>;
  findings?: any[];
}

ChecklistItem

interface ChecklistItem {
  id?: string;
  title: string;
  description?: string;
  type?: string;
  required?: boolean;
  options?: string[];
}