gitverse-api-sdk 5.1.0 → 5.2.0

package/dist/api/pulls.d.ts

@@ -1,522 +1,77 @@
+import type { GitVerseClient } from "../client";
+import type { Commit, CommitFiles, CreatePullRequestParams, PullRequest, UpdateBranchParams, UpdateBranchResponse } from "../types";
 /**
-* Типы данных для GitVerse API
-* @generated Сгенерировано автоматически из OpenAPI спецификации
-*/
-/**
-* Опции для выполнения HTTP-запросов
-*/
-interface RequestOptions {
-	/**
-	* AbortSignal для отмены запроса
-	* @example
-	* const controller = new AbortController();
-	* const promise = client.users.getCurrent({ signal: controller.signal });
-	* controller.abort(); // Отменяет запрос
-	*/
-	signal?: AbortSignal;
-}
-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;
-}
-interface Permissions {
-	admin?: boolean;
-	pull?: boolean;
-	push?: boolean;
-}
-interface UserPublicInfo {
-	avatar_url?: string;
-	followers_url?: string;
-	following_url?: string;
-	html_url?: string;
-	id?: number;
-	login?: string;
-	organizations_url?: 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;
-	/** Url для получения подписок пользователя */
-	subscriptions_url?: string;
-	/** Тип пользователя */
-	type?: string;
-	/** Дата изменения учетной записи */
-	updated_at?: string;
-	/** Url для получения пользователя */
-	url?: string;
-	/** Вебсайт */
-	website?: string;
-}
-interface Label {
-	/** example: 00aabb */
-	color?: string;
-	description?: string;
-	/** example: false */
-	exclusive?: boolean;
-	id?: number;
-	/** example: false */
-	is_archived?: boolean;
-	name?: string;
-	url?: string;
-}
-interface Milestone {
-	closed_at?: string;
-	closed_issues?: number;
-	created_at?: string;
-	description?: string;
-	due_on?: string;
-	id?: number;
-	open_issues?: number;
-	state?: string;
-	title?: string;
-	updated_at?: 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;
-}
-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;
-	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;
-}
-interface UpdateBranchResponse {
-	message?: string;
-	url?: string;
-}
-/**
-* Предупреждение об устаревшей версии API
-*/
-declare class ApiVersionWarning {
-	/** Текущая используемая версия */
-	readonly currentVersion: string;
-	/** Последняя доступная версия */
-	readonly latestVersion: string;
-	/** Дата вывода из эксплуатации */
-	readonly decommissioning?: string;
-	constructor(currentVersion: string, latestVersion: string, decommissioning?: string);
-	/**
-	* Возвращает сообщение о предупреждении
-	*/
-	getMessage(): string;
-}
-declare const HTTPMethods: {
-	readonly DELETE: "DELETE"
-	readonly GET: "GET"
-	readonly PATCH: "PATCH"
-	readonly POST: "POST"
-	readonly PUT: "PUT"
-};
-type HTTPMethods = (typeof HTTPMethods)[keyof typeof HTTPMethods];
-/**
-* Параметры для конфигурации GitVerse клиента
-*/
-interface GitVerseClientConfig {
-	/**
-	* Базовый URL API GitVerse
-	* @default 'https://api.gitverse.ru'
-	*/
-	baseUrl?: string;
-	/**
-	* Токен доступа для авторизации в API
-	*/
-	token?: string;
-	/**
-	* Версия API
-	* @default '1'
-	*/
-	apiVersion?: string;
-}
-/**
-* Основной класс для работы с GitVerse API
-*/
-declare class GitVerseClient {
-	private baseUrl;
-	private token?;
-	private apiVersion;
-	/**
-	* Callback для обработки предупреждений об устаревшей версии API
-	*/
-	onApiVersionWarning?: (warning: ApiVersionWarning) => void;
-	/**
-	* Создает новый экземпляр GitVerse клиента
-	* @param config Конфигурация клиента
-	*/
-	constructor(config?: GitVerseClientConfig);
-	/**
-	* Устанавливает токен авторизации
-	* @param token Токен доступа
-	*/
-	setToken(token: string): void;
-	/**
-	* Извлекает информацию о Rate Limit из заголовков ответа
-	*/
-	private extractRateLimitInfo;
-	/**
-	* Извлекает информацию о версии API из заголовков ответа
-	*/
-	private extractApiVersionInfo;
-	/**
-	* Извлекает метаданные из заголовков ответа
-	*/
-	private extractMetadata;
-	/**
-	* Выполняет API-запрос с учетом авторизации и версии API
-	* @param path Путь к API-ресурсу
-	* @param method HTTP-метод
-	* @param body Тело запроса (опционально)
-	* @param options Опции запроса (опционально)
-	* @returns Ответ от API
-	* @throws {RateLimitError} При превышении лимита запросов (429)
-	* @throws {GitVerseApiError} При других ошибках API
-	*/
-	request<T>(path: string, method: HTTPMethods, body?: unknown, options?: RequestOptions): Promise<T>;
-	/**
-	* Выполняет GET-запрос
-	* @param path Путь к API-ресурсу
-	* @param options Опции запроса (опционально)
-	* @returns Ответ от API
-	*/
-	get<T>(path: string, options?: RequestOptions): Promise<T>;
-	/**
-	* Выполняет POST-запрос
-	* @param path Путь к API-ресурсу
-	* @param body Тело запроса
-	* @param options Опции запроса (опционально)
-	* @returns Ответ от API
-	*/
-	post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
-	/**
-	* Выполняет PUT-запрос
-	* @param path Путь к API-ресурсу
-	* @param body Тело запроса
-	* @param options Опции запроса (опционально)
-	* @returns Ответ от API
-	*/
-	put<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
-	/**
-	* Выполняет DELETE-запрос
-	* @param path Путь к API-ресурсу
-	* @param body Тело запроса (опционально)
-	* @param options Опции запроса (опционально)
-	* @returns Ответ от API
-	*/
-	delete<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
-	/**
-	* Выполняет PATCH-запрос
-	* @param path Путь к API-ресурсу
-	* @param body Тело запроса
-	* @param options Опции запроса (опционально)
-	* @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 для работы с запросами на слияние
-*/
-declare class PullsApi {
-	private client;
-	/**
-	* Создает новый экземпляр API
-	* @param client GitVerse клиент
-	*/
-	constructor(client: GitVerseClient);
-	/**
-	* Create a pull request
-	* @param owner Repository owner
-	* @param repo Repository name
-	* @param params Pull request creation parameters
-	* @param options Опции запроса
-	* @returns PullRequest
-	*/
-	create(owner: string, repo: string, params: CreatePullRequestParams, options?: {
-		signal?: AbortSignal
-	}): Promise<PullRequest>;
-	/**
-	* 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[]
-	*/
-	listCommits(owner: string, repo: string, pull_number: number, queryParams?: {
-		page?: number
-		per_page?: number
-	}, options?: {
-		signal?: AbortSignal
-	}): Promise<Commit[]>;
-	/**
-	* 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[]
-	*/
-	listFiles(owner: string, repo: string, pull_number: number, queryParams?: {
-		page?: number
-		per_page?: number
-	}, options?: {
-		signal?: AbortSignal
-	}): Promise<CommitFiles[]>;
-	/**
-	* 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
-	*/
-	isMerged(owner: string, repo: string, pull_number: number, options?: {
-		signal?: AbortSignal
-	}): Promise<void>;
-	/**
-	* 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
-	*/
-	updateBranch(owner: string, repo: string, pull_number: number, params: UpdateBranchParams, options?: {
-		signal?: AbortSignal
-	}): Promise<UpdateBranchResponse>;
+ * API для работы с запросами на слияние
+ */
+export declare class PullsApi {
+    private client;
+    /**
+     * Создает новый экземпляр API
+     * @param client GitVerse клиент
+     */
+    constructor(client: GitVerseClient);
+    /**
+     * Create a pull request
+     * @param owner Repository owner
+     * @param repo Repository name
+     * @param params Pull request creation parameters
+     * @param options Опции запроса
+     * @returns PullRequest
+     */
+    create(owner: string, repo: string, params: CreatePullRequestParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<PullRequest>;
+    /**
+     * 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[]
+     */
+    listCommits(owner: string, repo: string, pull_number: number, queryParams?: {
+        page?: number;
+        per_page?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Commit[]>;
+    /**
+     * 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[]
+     */
+    listFiles(owner: string, repo: string, pull_number: number, queryParams?: {
+        page?: number;
+        per_page?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<CommitFiles[]>;
+    /**
+     * 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
+     */
+    isMerged(owner: string, repo: string, pull_number: number, options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * 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
+     */
+    updateBranch(owner: string, repo: string, pull_number: number, params: UpdateBranchParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<UpdateBranchResponse>;
 }
-export { PullsApi };