Issue data model

FieldTypeRequiredDescription
idstringNo
created_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
titlestringYes
statusenumYesValues: COMPLETED, NEW, ROADMAP, IN_PROGRESS, ON_HOLD, VALIDATING, REJECTED
urlstringNo
workspace_idstringYes(reference to KmsSpace)
typestring[]No
resolution_timenumberNo
ticket_refstringYes
sizenumberNo1-5, 1 is lowest
importancenumberNo1-5, 1 is lowest
customer_notestringNo

TypeScript

TypeScript
export type Issue = {
	id?: string;
	created_at?: string; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	title: string;
	status: 'COMPLETED' | 'NEW' | 'ROADMAP' | 'IN_PROGRESS' | 'ON_HOLD' | 'VALIDATING' | 'REJECTED';
	url?: string;
	workspace_id: string; // (reference to KmsSpace)
	type?: string[];
	resolution_time?: number;
	ticket_ref: string;
	size?: number; // 1-5, 1 is lowest
	importance?: number; // 1-5, 1 is lowest
	customer_note?: string;
} 

Zod

Zod
import { z } from 'zod';

export const ZodIssue = z.object({
	id: z.string().optional(),
	created_at: z.string().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	title: z.string(),
	status: z.enum("COMPLETED", "NEW", "ROADMAP", "IN_PROGRESS", "ON_HOLD", "VALIDATING", "REJECTED"),
	url: z.string().optional(),
	workspace_id: z.string().describe("(reference to KmsSpace)"),
	type: z.array().optional(),
	resolution_time: z.number().optional(),
	ticket_ref: z.string(),
	size: z.number().optional().describe("1-5, 1 is lowest"),
	importance: z.number().optional().describe("1-5, 1 is lowest"),
	customer_note: z.string().optional()
});

Python

Python
import dataclasses

@dataclasses.dataclass
class IssueStatus(str, Enum):
	COMPLETED = 'COMPLETED'
	NEW = 'NEW'
	ROADMAP = 'ROADMAP'
	IN_PROGRESS = 'IN_PROGRESS'
	ON_HOLD = 'ON_HOLD'
	VALIDATING = 'VALIDATING'
	REJECTED = 'REJECTED'

@dataclasses.dataclass
class Issue:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	title: str
	status: IssueStatus
	url: Optional[str]
	"""(reference to KmsSpace)"""
	workspace_id: str
	type: Optional[List[List[str]]]
	resolution_time: Optional[int]
	ticket_ref: str
	"""1-5, 1 is lowest"""
	size: Optional[int]
	"""1-5, 1 is lowest"""
	importance: Optional[int]
	customer_note: Optional[str]
Are we missing anything? Let us know
Was this page helpful?