gitverse-api-sdk 4.0.2 → 5.0.1

package/dist/api/pulls.d.ts

@@ -1,73 +1,7 @@
 /**
-* Типы пользователей в системе
+* Типы данных для GitVerse API
+* @generated Сгенерировано автоматически из OpenAPI спецификации
 */
-declare const UserType: {
-	readonly Organization: "Organization"
-	readonly User: "User"
-};
-/**
-* Тип для типов пользователей
-*/
-type UserType = (typeof UserType)[keyof typeof UserType];
-/**
-* Типы видимости для репозиториев и пользователей
-*/
-declare const VisibilityType: {
-	readonly Limited: "limited"
-	readonly Private: "private"
-	readonly Public: "public"
-};
-/**
-* Тип для типов видимости
-*/
-type VisibilityType = (typeof VisibilityType)[keyof typeof VisibilityType];
-/**
-* Состояния pull request
-*/
-declare const PullRequestState: {
-	readonly Closed: "closed"
-	readonly Open: "open"
-};
-/**
-* Тип для состояний pull request
-*/
-type PullRequestState = (typeof PullRequestState)[keyof typeof PullRequestState];
-/**
-* Фильтры состояний pull request, включая "все"
-*/
-declare const PullRequestStateFilter: {
-	readonly All: "all"
-	readonly Closed: "closed"
-	readonly Open: "open"
-};
-/**
-* Тип для фильтров состояний pull request
-*/
-type PullRequestStateFilter = (typeof PullRequestStateFilter)[keyof typeof PullRequestStateFilter];
-/**
-* Критерии сортировки pull request
-*/
-declare const PullRequestSortCriteria: {
-	readonly Created: "created"
-	readonly LongRunning: "long-running"
-	readonly Popularity: "popularity"
-	readonly Updated: "updated"
-};
-/**
-* Тип для критериев сортировки pull request
-*/
-type PullRequestSortCriteria = (typeof PullRequestSortCriteria)[keyof typeof PullRequestSortCriteria];
-/**
-* Направления сортировки pull request
-*/
-declare const PullRequestSortDirection: {
-	readonly Ascending: "asc"
-	readonly Descending: "desc"
-};
-/**
-* Тип для направлений сортировки pull request
-*/
-type PullRequestSortDirection = (typeof PullRequestSortDirection)[keyof typeof PullRequestSortDirection];
 /**
 * Опции для выполнения HTTP-запросов
 */
@@ -81,329 +15,297 @@ interface RequestOptions {
 	*/
 	signal?: AbortSignal;
 }
-/**
-* Интерфейс пользователя
-*/
-interface User2 {
-	/** Уникальный идентификатор пользователя */
-	id: number;
-	/** Имя пользователя */
-	name?: string;
-	/** Логин пользователя */
-	login: string;
-	/** Полное имя пользователя */
-	full_name?: string;
-	/** Тип аккаунта: пользователь или организация */
-	type: UserType;
-	/** Биография пользователя */
-	bio?: string;
-	/** Электронная почта пользователя */
-	email?: string;
-	/** URL аватара пользователя */
-	avatar_url: string;
-	/** Веб-ссылка на профиль пользователя */
-	html_url: string;
-	/** API-ссылка на профиль пользователя */
+interface CreatePullRequestParams {
+	/** список ответственных */
+	assignees?: string[];
+	/** ветка в которую происходит слияние */
+	base?: string;
+	/** тело запроса */
+	body?: string;
+	/** черновик */
+	draft?: boolean;
+	/** Deadline */
+	due_date?: string;
+	/** ветка из которой происходит слияние */
+	head?: string;
+	/** ветка из которой происходит слияние */
+	head_repo?: string;
+	/** Метки */
+	labels?: number[];
+	/** могут ли мэйнтейнеры изменять PR */
+	maintainer_can_modify?: boolean;
+	/** идентификатор "этапа" */
+	milestone?: number;
+	/** заголовок запроса */
+	title?: string;
+}
+interface UpdateBranchParams {
+	expected_head_sha?: string;
+}
+interface CommitMeta {
+	created?: string;
+	html_url?: string;
+	sha?: string;
 	url?: string;
-	/** API-ссылка на список подписчиков пользователя */
+}
+interface Permissions {
+	admin?: boolean;
+	pull?: boolean;
+	push?: boolean;
+}
+interface UserPublicInfo {
+	avatar_url?: string;
 	followers_url?: string;
-	/** API-ссылка на репозитории пользователя */
-	repos_url?: string;
-	/** API-ссылка на организации пользователя */
+	following_url?: string;
+	html_url?: string;
+	id?: number;
+	login?: string;
 	organizations_url?: string;
-	/** Права администратора */
-	site_admin: boolean;
-	/** Местоположение пользователя */
-	location?: string;
-	/** Верификация аккаунта */
-	is_verified?: boolean;
-	/** Настройки приватности профиля */
-	visibility?: VisibilityType;
-	/** Персональный веб-сайт */
-	website?: string;
-	/** Количество подписчиков */
+	repos_url?: string;
+	site_admin?: boolean;
+	type?: string;
+	url?: string;
+}
+interface CommitFiles {
+	additions?: number;
+	blob_url?: string;
+	changes?: number;
+	contents_url?: string;
+	deletions?: number;
+	filename?: string;
+	patch?: string;
+	raw_url?: string;
+	sha?: string;
+	status?: string;
+}
+interface CommitUser {
+	date?: string;
+	email?: string;
+	name?: string;
+}
+interface TreeMeta {
+	created?: string;
+	sha?: string;
+	url?: string;
+}
+interface RepoCommit {
+	author?: CommitUser;
+	committer?: CommitUser;
+	message?: string;
+	tree?: TreeMeta;
+	url?: string;
+}
+interface CommitStats {
+	additions?: number;
+	deletions?: number;
+	total?: number;
+}
+interface Commit {
+	author?: UserPublicInfo;
+	branch?: string;
+	commit?: RepoCommit;
+	committer?: UserPublicInfo;
+	created?: string;
+	files?: CommitFiles[];
+	html_url?: string;
+	parents?: CommitMeta[];
+	sha?: string;
+	stats?: CommitStats;
+	url?: string;
+}
+interface User {
+	/** Адрес аватарки */
+	avatar_url?: string;
+	/** О себе */
+	bio?: string;
+	/** Дата создания учетной записи */
+	created_at?: string;
+	/** Почта */
+	email?: string;
+	/** Счетчики */
 	followers?: number;
-	/** Количество подписок */
+	/** Url для получения подписчиков пользователя */
+	followers_url?: string;
 	following?: number;
-	/** Количество публичных репозиториев */
+	/** Url для получения подписок пользователя */
+	following_url?: string;
+	/** Полное имя */
+	full_name?: string;
+	/** Адрес страницы пользователя */
+	html_url?: string;
+	/** Идентификатор */
+	id?: number;
+	/** Верифицирован? */
+	is_verified?: boolean;
+	/** Местоположение */
+	location?: string;
+	/** Логин пользователя */
+	login?: string;
+	/** Имя пользователя */
+	name?: string;
+	/** Url для получения организаций пользователя */
+	organizations_url?: string;
+	/** Публичные репозитории */
 	public_repos?: number;
-	/** Количество репозиториев, отмеченных звездой */
+	/** Url для получения репозиториев пользователя */
+	repos_url?: string;
+	/** Есть ли права админа */
+	site_admin?: boolean;
+	/** Url для получения репозиториев пользователя, которые были добавлены в избранное */
+	starred_url?: string;
+	/** Количество репозиториев в избранном */
 	stars_count?: number;
-	/** Дата создания аккаунта */
-	created_at: string;
-	/** Дата последнего обновления аккаунта */
+	/** Url для получения подписок пользователя */
+	subscriptions_url?: string;
+	/** Тип пользователя */
+	type?: string;
+	/** Дата изменения учетной записи */
 	updated_at?: string;
+	/** Url для получения пользователя */
+	url?: string;
+	/** Вебсайт */
+	website?: string;
 }
-/**
-* Интерфейс базовой или целевой ветки для pull request
-*/
-interface PullRequestBase {
-	/** Метка ветки */
-	label: string;
-	/** Имя ветки */
-	ref: string;
-	/** SHA-хеш последнего коммита в ветке */
-	sha: string;
-	/** ID репозитория */
-	repo_id: number;
-	/** Информация о репозитории */
-	repo: {
-		/** ID репозитория */
-		id: number
-		/** Название репозитория */
-		name: string
-		/** Полное название репозитория в формате {owner}/{repo} */
-		full_name: string
-		/** Является ли репозиторий приватным */
-		private: boolean
-		/** Основная ветка репозитория */
-		default_branch: string
-	};
-}
-/**
-* Интерфейс pull request
-*/
-interface PullRequest {
-	/** Уникальный идентификатор pull request */
-	id: number;
-	/** API-ссылка на pull request */
-	url: string;
-	/** Номер pull request в репозитории */
-	number: number;
-	/** Информация о пользователе, создавшем pull request */
-	user: {
-		/** ID пользователя */
-		id: number
-		/** Логин пользователя */
-		login: string
-		/** Тип аккаунта */
-		type: string
-		/** URL аватара пользователя */
-		avatar_url: string
-		/** Веб-ссылка на профиль пользователя */
-		html_url: string
-		/** Права администратора */
-		site_admin: boolean
-	};
-	/** Заголовок pull request */
-	title: string;
-	/** Описание pull request */
-	body?: string;
-	/** Список меток */
-	labels: Label[];
-	/** Информация о майлстоуне */
-	milestone?: Milestone;
-	/** Информация о назначенном пользователе */
-	assignee?: User2;
-	/** Список назначенных пользователей */
-	assignees?: User2[];
-	/** Состояние pull request (открыт/закрыт) */
-	state: PullRequestState;
-	/** Заблокирован ли pull request */
-	locked: boolean;
-	/** Количество комментариев */
-	comments: number;
-	/** Веб-ссылка на pull request */
-	html_url: string;
-	/** Ссылка на diff файл */
-	diff_url: string;
-	/** Ссылка на patch файл */
-	patch_url: string;
-	/** Можно ли слить pull request */
-	mergeable: boolean;
-	/** Был ли pull request слит */
-	merged: boolean;
-	/** Дата слияния (если был слит) */
-	merged_at?: string | null;
-	/** SHA-хеш коммита слияния (если был слит) */
-	merge_commit_sha?: string | null;
-	/** Пользователь, выполнивший слияние */
-	merged_by?: User2 | null;
-	/** Может ли мейнтейнер изменять pull request */
-	maintainer_can_modify: boolean;
-	/** Информация о целевой ветке */
-	base: PullRequestBase;
-	/** Информация о ветке с изменениями */
-	head: PullRequestBase;
-	/** Дата создания pull request */
-	created_at: string;
-	/** Дата обновления pull request */
-	updated_at: string;
-	/** Дата закрытия pull request (если закрыт) */
-	closed_at?: string | null;
-}
-/**
-* Интерфейс параметров для создания pull request
-*/
-interface CreatePullRequestParams {
-	/** Заголовок pull request */
-	title: string;
-	/** Описание pull request */
-	body?: string;
-	/** Имя ветки, из которой предлагаются изменения */
-	head: string;
-	/** Имя ветки, в которую будут внесены изменения */
-	base: string;
-}
-/**
-* Интерфейс параметров для получения списка pull requests
-*/
-interface ListPullRequestsParams {
-	/**
-	* Фильтр по состоянию pull request
-	*
-	* @default "open"
-	*/
-	state?: PullRequestStateFilter;
-	/** Фильтр по ветке-источнику в формате branch, user:branch или user:repo:branch */
-	head?: string;
-	/** Фильтр по целевой ветке */
-	base?: string;
-	/**
-	* Критерий сортировки
-	*
-	* @default "created"
-	*/
-	sort?: PullRequestSortCriteria;
-	/**
-	* Направление сортировки
-	*
-	* @default "desc"
-	*/
-	direction?: PullRequestSortDirection;
-	/** Номер страницы (начиная с 1) */
-	page?: number;
-	/** Количество элементов на странице (максимум 100) */
-	per_page?: number;
-}
-/**
-* Интерфейс метки (label) для issues и pull requests
-*/
 interface Label {
-	/** Идентификатор метки */
-	id: number;
-	/** Имя метки */
-	name: string;
-	/** Описание метки */
+	/** example: 00aabb */
+	color?: string;
 	description?: string;
-	/** Цвет метки в формате HEX */
-	color: string;
-	/** URL метки */
+	/** example: false */
+	exclusive?: boolean;
+	id?: number;
+	/** example: false */
+	is_archived?: boolean;
+	name?: string;
 	url?: string;
 }
-/**
-* Интерфейс майлстоуна (milestone)
-*/
 interface Milestone {
-	/** Идентификатор майлстоуна */
-	id: number;
-	/** Номер майлстоуна */
-	number: number;
-	/** Название майлстоуна */
-	title: string;
-	/** Описание майлстоуна */
+	closed_at?: string;
+	closed_issues?: number;
+	created_at?: string;
 	description?: string;
-	/** Создатель майлстоуна */
-	creator: User2;
-	/** Состояние майлстоуна (open/closed) */
-	state: "open" | "closed";
-	/** Количество открытых задач */
-	open_issues: number;
-	/** Количество закрытых задач */
-	closed_issues: number;
-	/** Дата создания */
-	created_at: string;
-	/** Дата обновления */
-	updated_at: string;
-	/** Дата окончания (due date) */
 	due_on?: string;
+	id?: number;
+	open_issues?: number;
+	state?: string;
+	title?: string;
+	updated_at?: string;
 }
-/**
-* Интерфейс коммита
-*/
-interface Commit {
-	/** SHA-хеш коммита */
-	sha: string;
-	/** Node ID коммита */
-	node_id?: string;
-	/** Информация о коммите */
-	commit: {
-		/** Автор коммита */
-		author: {
-			name: string
-			email: string
-			date: string
-		}
-		/** Коммиттер */
-		committer: {
-			name: string
-			email: string
-			date: string
-		}
-		/** Сообщение коммита */
-		message: string
-		/** Дерево коммита */
-		tree: {
-			sha: string
-			url: string
-		}
-	};
-	/** Автор (пользователь GitVerse) */
-	author?: User2 | null;
-	/** Коммиттер (пользователь GitVerse) */
-	committer?: User2 | null;
-	/** Родительские коммиты */
-	parents: Array<{
-		sha: string
-		url: string
-		html_url: string
-	}>;
-	/** API-ссылка на коммит */
-	url: string;
-	/** Веб-ссылка на коммит */
-	html_url: string;
+interface Repository {
+	allow_merge_commit?: boolean;
+	allow_rebase_merge?: boolean;
+	allow_squash_merge?: boolean;
+	archived?: boolean;
+	clone_url?: string;
+	contents_url?: string;
+	created_at?: string;
+	default_branch?: string;
+	delete_branch_on_merge?: boolean;
+	description?: string;
+	disabled?: boolean;
+	fork?: boolean;
+	forks?: number;
+	forks_count?: number;
+	forks_url?: string;
+	full_name?: string;
+	has_issues?: boolean;
+	has_wiki?: boolean;
+	id?: number;
+	is_template?: boolean;
+	issue_comment_url?: string;
+	issues_url?: string;
+	language?: string;
+	languages_url?: string;
+	mirror_url?: string;
+	name?: string;
+	open_issues?: number;
+	open_issues_count?: number;
+	owner?: UserPublicInfo;
+	parent?: Repository;
+	permissions?: Permissions;
+	private?: boolean;
+	pulls_url?: string;
+	pushed_at?: string;
+	size?: number;
+	ssh_url?: string;
+	stargazers_count?: number;
+	template_repository?: Repository;
+	topics?: string[];
+	updated_at?: string;
+	url?: string;
+	visibility?: string;
+	watchers?: number;
+	watchers_count?: number;
 }
-/**
-* Параметры для обновления pull request
-*/
-interface UpdatePullRequestParams {
-	/** Новый заголовок */
-	title?: string;
-	/** Новое описание */
+interface PRBranchInfo {
+	label?: string;
+	ref?: string;
+	repo?: Repository;
+	repo_id?: number;
+	sha?: string;
+}
+interface Team {
+	/** Полномочия на создание репозиториев */
+	can_create_org_repo?: boolean;
+	/** Описание команды */
+	description?: string;
+	/** Идентификатор */
+	id?: number;
+	/** Включает все репозитории */
+	includes_all_repositories?: boolean;
+	/** Название команды */
+	name?: string;
+	/** Количество участников */
+	num_members?: number;
+	/** Количество репозиториев */
+	num_repos?: number;
+	/** Полномочия */
+	permission?: string;
+	/** Полномочие на действия с ветками */
+	permission_actions?: string;
+	/** Код полномочия */
+	permission_code?: string;
+	/** Полномочие на пакеты */
+	permission_packages?: string;
+	/** Полномочие на отправку пулл-реквестов */
+	permission_pulls?: string;
+	/** Полномочие на релизы */
+	permission_releases?: string;
+}
+interface PullRequest {
+	assignee?: User;
+	assignees?: User[];
+	base?: PRBranchInfo;
 	body?: string;
-	/** Новое состояние */
-	state?: PullRequestState;
-	/** Базовая ветка */
-	base?: string;
-	/** Можно ли мейнтейнерам модифицировать */
+	closed_at?: string;
+	comments?: number;
+	created_at?: string;
+	diff_url?: string;
+	head?: PRBranchInfo;
+	html_url?: string;
+	id?: number;
+	is_draft?: boolean;
+	labels?: Label[];
+	locked?: boolean;
 	maintainer_can_modify?: boolean;
+	merge_commit_sha?: string;
+	mergeable?: boolean;
+	merged?: boolean;
+	merged_at?: string;
+	merged_by?: User;
+	milestone?: Milestone;
+	number?: number;
+	patch_url?: string;
+	requested_reviewers?: User[];
+	requested_teams?: Team[];
+	state?: string;
+	title?: string;
+	updated_at?: string;
+	url?: string;
+	user?: User;
 }
-/**
-* Интерфейс файла в pull request
-*/
-interface PullRequestFile {
-	/** SHA-хеш файла */
-	sha: string;
-	/** Имя файла */
-	filename: string;
-	/** Статус изменения */
-	status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged";
-	/** Количество добавленных строк */
-	additions: number;
-	/** Количество удалённых строк */
-	deletions: number;
-	/** Общее количество изменений */
-	changes: number;
-	/** URL для получения содержимого */
-	blob_url: string;
-	/** Raw URL */
-	raw_url: string;
-	/** API URL */
-	contents_url: string;
-	/** Patch для файла */
-	patch?: string;
-	/** Предыдущее имя файла (для переименованных) */
-	previous_filename?: string;
+interface UpdateBranchResponse {
+	message?: string;
+	url?: string;
 }
 /**
 * Предупреждение об устаревшей версии API
@@ -531,81 +433,90 @@ declare class GitVerseClient {
 	* @returns Ответ от API
 	*/
 	patch<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+	/**
+	* Выполняет загрузку файла через multipart/form-data
+	* @param path Путь к API-ресурсу
+	* @param fieldName Имя поля для файла
+	* @param file Файл для загрузки (Blob или ArrayBuffer)
+	* @param fileName Имя файла
+	* @param options Опции запроса (опционально)
+	* @returns Ответ от API
+	*/
+	uploadFile<T>(path: string, fieldName: string, file: Blob | ArrayBuffer, fileName: string, options?: RequestOptions): Promise<T>;
 }
 /**
-* API для работы с запросами на слияние (пулл-реквестами)
+* API для работы с запросами на слияние
 */
 declare class PullsApi {
 	private client;
 	/**
-	* Создает новый экземпляр API для работы с пулл-реквестами
+	* Создает новый экземпляр API
 	* @param client GitVerse клиент
 	*/
 	constructor(client: GitVerseClient);
 	/**
-	* Создает новый запрос на слияние в репозитории
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param params Параметры создания запроса на слияние
-	* @returns Информация о созданном запросе на слияние
-	*/
-	create(owner: string, repo: string, params: CreatePullRequestParams, options?: RequestOptions): Promise<PullRequest>;
-	/**
-	* Получает запрос на слияние по его номеру
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param number Номер запроса на слияние
-	* @returns Информация о запросе на слияние
-	*/
-	get(owner: string, repo: string, number: number, options?: RequestOptions): Promise<PullRequest>;
-	/**
-	* Получает список запросов на слияние в репозитории
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param state Состояние запросов на слияние (открытые/закрытые/все)
-	* @returns Список запросов на слияние
-	*/
-	list(owner: string, repo: string, params?: ListPullRequestsParams, options?: RequestOptions): Promise<PullRequest[]>;
-	/**
-	* Обновляет pull request
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param number Номер pull request
-	* @param params Параметры для обновления
-	* @returns Обновлённый pull request
+	* Create a pull request
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param params Pull request creation parameters
+	* @param options Опции запроса
+	* @returns PullRequest
 	*/
-	update(owner: string, repo: string, number: number, params: UpdatePullRequestParams, options?: RequestOptions): Promise<PullRequest>;
+	create(owner: string, repo: string, params: CreatePullRequestParams, options?: {
+		signal?: AbortSignal
+	}): Promise<PullRequest>;
 	/**
-	* Получает список файлов в pull request
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param number Номер pull request
-	* @returns Список изменённых файлов
+	* List pull request commits
+	* @param owner Owner of the repository (username or organization)
+	* @param repo Name of the repository without .git extension
+	* @param pull_number The number that identifies the pull request
+	* @param queryParams Параметры запроса
+	* @param options Опции запроса
+	* @returns Commit[]
 	*/
-	getFiles(owner: string, repo: string, number: number, options?: RequestOptions): Promise<PullRequestFile[]>;
+	listCommits(owner: string, repo: string, pull_number: number, queryParams?: {
+		page?: number
+		per_page?: number
+	}, options?: {
+		signal?: AbortSignal
+	}): Promise<Commit[]>;
 	/**
-	* Обновляет ветку pull request с базовой веткой
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param number Номер pull request
-	* @returns Результат операции
+	* List pull request files
+	* @param owner Owner of the repository (username or organization)
+	* @param repo Name of the repository without .git extension
+	* @param pull_number The number that identifies the pull request
+	* @param queryParams Параметры запроса
+	* @param options Опции запроса
+	* @returns CommitFiles[]
 	*/
-	updateBranch(owner: string, repo: string, number: number, options?: RequestOptions): Promise<void>;
+	listFiles(owner: string, repo: string, pull_number: number, queryParams?: {
+		page?: number
+		per_page?: number
+	}, options?: {
+		signal?: AbortSignal
+	}): Promise<CommitFiles[]>;
 	/**
-	* Получает список коммитов в pull request
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param number Номер pull request
-	* @returns Список коммитов
+	* Checks if a pull request has been merged into the base branch.
+	* @param owner Owner of the repository (username or organization)
+	* @param repo Name of the repository without .git extension
+	* @param pull_number The number that identifies the pull request
+	* @param options Опции запроса
+	* @returns void
 	*/
-	getCommits(owner: string, repo: string, number: number, options?: RequestOptions): Promise<Commit[]>;
+	isMerged(owner: string, repo: string, pull_number: number, options?: {
+		signal?: AbortSignal
+	}): Promise<void>;
 	/**
-	* Проверяет, был ли pull request влит в базовую ветку
-	* @param owner Владелец репозитория
-	* @param repo Название репозитория
-	* @param number Номер pull request
-	* @returns true если PR был влит, false если не был влит или не существует
+	* Update a pull request branch
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param pull_number The number that identifies the pull request
+	* @param params Expected head SHA
+	* @param options Опции запроса
+	* @returns UpdateBranchResponse
 	*/
-	checkIfMerged(owner: string, repo: string, number: number, options?: RequestOptions): Promise<boolean>;
+	updateBranch(owner: string, repo: string, pull_number: number, params: UpdateBranchParams, options?: {
+		signal?: AbortSignal
+	}): Promise<UpdateBranchResponse>;
 }
 export { PullsApi };