Pullrequest data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idsstring[]No(reference to HrisEmployee)
repo_idstringNo(reference to RepoRepository)
titlestringNo
notesstringNo
target_branch_idstringNo
source_branch_idstringNo
statusenumNoValues: PENDING, APPROVED, REJECTED
labelsstring[]No
closed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
commit_idsstring[]No(reference to RepoCommit)
metadataRepoMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type RepoPullrequest = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	user_ids?: string[]; // (reference to HrisEmployee)
	repo_id?: string; // (reference to RepoRepository)
	title?: string;
	notes?: string;
	target_branch_id?: string;
	source_branch_id?: string;
	status?: 'PENDING' | 'APPROVED' | 'REJECTED';
	labels?: string[];
	closed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	commit_ids?: string[]; // (reference to RepoCommit)
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodRepoPullrequest = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	user_ids: z.array().optional().describe("(reference to HrisEmployee)"),
	repo_id: z.string().optional().describe("(reference to RepoRepository)"),
	title: z.string().optional(),
	notes: z.string().optional(),
	target_branch_id: z.string().optional(),
	source_branch_id: z.string().optional(),
	status: z.enum("PENDING", "APPROVED", "REJECTED").optional(),
	labels: z.array().optional(),
	closed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	commit_ids: z.array().optional().describe("(reference to RepoCommit)"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class RepoPullrequestStatus(str, Enum):
	PENDING = 'PENDING'
	APPROVED = 'APPROVED'
	REJECTED = 'REJECTED'

@dataclasses.dataclass
class RepoPullrequest:
	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]
	"""(reference to HrisEmployee)"""
	user_ids: Optional[List[List[str]]]
	"""(reference to RepoRepository)"""
	repo_id: Optional[str]
	title: Optional[str]
	notes: Optional[str]
	target_branch_id: Optional[str]
	source_branch_id: Optional[str]
	status: Optional[RepoPullrequestStatus]
	labels: Optional[List[List[str]]]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	closed_at: Optional[str]
	"""(reference to RepoCommit)"""
	commit_ids: Optional[List[List[str]]]
	metadata: Optional[PropertyRepoPullrequestMetadata]
Are we missing anything? Let us know
Was this page helpful?