gitverse-api-sdk 5.0.0 → 5.1.0

package/dist/api/issues.d.ts

@@ -1,37 +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];
-/**
-* Состояния issue
-*/
-declare const IssueState: {
-	readonly Closed: "closed"
-	readonly Open: "open"
-};
-/**
-* Тип для состояний issue
-*/
-type IssueState = (typeof IssueState)[keyof typeof IssueState];
 /**
 * Опции для выполнения HTTP-запросов
 */
@@ -45,398 +15,232 @@ interface RequestOptions {
 	*/
 	signal?: AbortSignal;
 }
-/**
-* Базовые параметры пагинации
-*/
-interface PaginationParams {
-	/** Номер страницы (начиная с 1) */
-	page?: number;
-	/** Количество элементов на странице */
-	per_page?: number;
-}
-/**
-* Параметры для получения списка issues
-*/
-interface ListIssuesParams extends PaginationParams {
-	/** Фильтр по состоянию issue */
-	state?: "open" | "closed" | "all";
-	/** Ключевое слово для поиска в заголовке и содержимом */
-	q?: string;
-	/** Метки через запятую (префикс '-' для исключения) */
-	labels?: string;
-	/** Имена или ID майлстоунов через запятую */
-	milestones?: string;
-	/** Фильтр по имени создателя */
-	created_by?: string;
-	/** Фильтр по имени назначенного пользователя */
-	assigned_by?: string;
-	/** Фильтр по упомянутому пользователю */
-	mentioned_by?: string;
-	/** Фильтр по типу: issues или pulls */
-	type?: "issues" | "pulls";
-	/** Только элементы обновлённые после этого времени (RFC3339) */
-	since?: string;
-	/** Только элементы обновлённые до этого времени (RFC3339) */
-	before?: string;
+interface Attachment {
+	browser_download_url?: string;
+	created_at?: string;
+	download_count?: number;
+	id?: number;
+	name?: string;
+	size?: number;
+	uuid?: string;
 }
-/**
-* Параметры для получения списка комментариев к issue
-*/
-interface ListCommentsParams {
-	/** Только комментарии после этого времени (RFC3339) */
-	since?: string;
-	/** Только комментарии до этого времени (RFC3339) */
-	before?: string;
+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;
 }
-/**
-* Параметры для получения timeline issue
-*/
-interface GetTimelineParams extends PaginationParams {
-	/** Только события после этого времени (RFC3339) */
-	since?: string;
-	/** Только события до этого времени (RFC3339) */
-	before?: string;
+interface Comment {
+	author_association?: string;
+	body?: string;
+	created_at?: string;
+	/** Адрес страницы с комметарием */
+	html_url?: string;
+	id?: number;
+	/** Url для получения issue/PR */
+	issue_url?: string;
+	updated_at?: string;
+	/** Url для получения пользователя */
+	url?: string;
+	user?: UserPublicInfo;
 }
-/**
-* Интерфейс пользователя
-*/
-interface User2 {
-	/** Уникальный идентификатор пользователя */
-	id: number;
-	/** Имя пользователя */
-	name?: string;
-	/** Логин пользователя */
-	login: string;
-	/** Полное имя пользователя */
-	full_name?: string;
-	/** Тип аккаунта: пользователь или организация */
-	type: UserType;
-	/** Биография пользователя */
+interface User {
+	/** Адрес аватарки */
+	avatar_url?: string;
+	/** О себе */
 	bio?: string;
-	/** Электронная почта пользователя */
+	/** Дата создания учетной записи */
+	created_at?: string;
+	/** Почта */
 	email?: string;
-	/** URL аватара пользователя */
-	avatar_url: string;
-	/** Веб-ссылка на профиль пользователя */
-	html_url: string;
-	/** API-ссылка на профиль пользователя */
-	url?: string;
-	/** API-ссылка на список подписчиков пользователя */
-	followers_url?: string;
-	/** API-ссылка на репозитории пользователя */
-	repos_url?: string;
-	/** API-ссылка на организации пользователя */
-	organizations_url?: string;
-	/** Права администратора */
-	site_admin: boolean;
-	/** Местоположение пользователя */
-	location?: string;
-	/** Верификация аккаунта */
-	is_verified?: boolean;
-	/** Настройки приватности профиля */
-	visibility?: VisibilityType;
-	/** Персональный веб-сайт */
-	website?: string;
-	/** Количество подписчиков */
+	/** Счетчики */
 	followers?: number;
-	/** Количество подписок */
+	/** Url для получения подписчиков пользователя */
+	followers_url?: string;
 	following?: number;
-	/** Количество публичных репозиториев */
-	public_repos?: number;
-	/** Количество репозиториев, отмеченных звездой */
-	stars_count?: number;
-	/** API-ссылка на подписки пользователя */
+	/** Url для получения подписок пользователя */
 	following_url?: string;
-	/** API-ссылка на избранные репозитории */
+	/** Полное имя */
+	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;
-	/** API-ссылка на подписки на уведомления */
+	/** Количество репозиториев в избранном */
+	stars_count?: number;
+	/** Url для получения подписок пользователя */
 	subscriptions_url?: string;
-	/** Дата создания аккаунта */
-	created_at: string;
-	/** Дата последнего обновления аккаунта */
+	/** Тип пользователя */
+	type?: string;
+	/** Дата изменения учетной записи */
 	updated_at?: string;
+	/** Url для получения пользователя */
+	url?: string;
+	/** Вебсайт */
+	website?: string;
 }
-/**
-* Интерфейс метки (label) для issues и pull requests
-*/
 interface Label {
-	/** Идентификатор метки */
-	id: number;
-	/** Имя метки */
-	name: string;
-	/** Описание метки */
+	/** example: 00aabb */
+	color?: string;
 	description?: string;
-	/** Цвет метки в формате HEX */
-	color: string;
-	/** URL метки */
-	url?: string;
-	/** Эксклюзивная метка (взаимоисключающая в группе) */
+	/** 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 PullRequestMeta {
+	draft?: boolean;
+	html_url?: string;
+	merged?: boolean;
+	merged_at?: string;
+}
+interface RepositoryMeta {
+	full_name?: string;
+	id?: number;
+	name?: string;
+	owner?: string;
 }
-/**
-* Интерфейс issue
-*/
 interface Issue {
-	/** Уникальный идентификатор issue */
-	id: number;
-	/** Номер issue в репозитории */
-	number: number;
-	/** Заголовок issue */
-	title: string;
-	/** Описание issue */
+	assets?: Attachment[];
+	assignee?: User;
+	assignees?: User[];
 	body?: string;
-	/** Состояние issue */
-	state: IssueState;
-	/** Пользователь, создавший issue */
-	user: User2;
-	/** Список меток */
-	labels: Label[];
-	/** Назначенный пользователь */
-	assignee?: User2 | null;
-	/** Назначенные пользователи */
-	assignees?: User2[];
-	/** Информация о майлстоуне */
-	milestone?: Milestone | null;
-	/** Заблокирован ли issue */
+	closed_at?: string;
+	comments?: number;
+	created_at?: string;
+	due_date?: string;
+	html_url?: string;
+	id?: number;
 	is_locked?: boolean;
-	/** Срок выполнения */
-	due_date?: string | null;
-	/** Связанный pull request (если issue создан из PR) */
-	pull_request?: PullRequestMeta | null;
-	/** Информация о репозитории */
-	repository?: RepositoryMeta;
-	/** Ссылка на ветку */
-	ref?: string;
-	/** Оригинальный автор (для импортированных issues) */
+	labels?: Label[];
+	milestone?: Milestone;
+	number?: number;
 	original_author?: string;
-	/** ID оригинального автора */
 	original_author_id?: number;
-	/** Вложения */
-	assets?: Asset[];
-	/** Дата создания */
-	created_at: string;
-	/** Дата обновления */
-	updated_at: string;
-	/** Дата закрытия */
-	closed_at?: string | null;
-	/** Количество комментариев */
-	comments: number;
-	/** Веб-ссылка на issue */
-	html_url: string;
-	/** API-ссылка на issue */
-	url: string;
+	pull_request?: PullRequestMeta;
+	ref?: string;
+	repository?: RepositoryMeta;
+	state?: string;
+	title?: string;
+	updated_at?: string;
+	url?: string;
+	user?: User;
 }
-/**
-* Интерфейс комментария к issue или pull request
-*/
-interface Comment {
-	/** Уникальный идентификатор комментария */
-	id: number;
-	/** Текст комментария */
-	body: string;
-	/** Пользователь, создавший комментарий */
-	user: User2;
-	/** Дата создания */
-	created_at: string;
-	/** Дата обновления */
-	updated_at: string;
-	/** Веб-ссылка на комментарий */
-	html_url: string;
-	/** API-ссылка на комментарий */
-	url: string;
-	/** Ассоциация автора с репозиторием */
-	author_association?: string;
-	/** URL issue */
-	issue_url?: 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;
 }
-/**
-* Интерфейс комментария/события в timeline issue (согласно OpenAPI v1.1)
-*/
-interface TimelineComment {
-	/** Уникальный идентификатор */
+interface TrackedTime {
+	/** swagger:strfmt date-time */
+	created?: string;
 	id?: number;
-	/** Тип события */
-	type?: string;
-	/** Текст комментария */
+	issue?: Issue;
+	/** deprecated (only for backwards compatibility) */
+	issue_id?: number;
+	/** Time in seconds */
+	time?: number;
+	/** deprecated (only for backwards compatibility) */
+	user_id?: number;
+	user_name?: string;
+}
+interface TimelineComment {
+	assignee?: User;
+	assignee_team?: Team;
 	body?: string;
-	/** Веб-ссылка */
+	/** swagger:strfmt date-time */
+	created_at?: string;
+	dependent_issue?: Issue;
 	html_url?: string;
-	/** Ссылка на issue */
+	id?: number;
 	issue_url?: string;
-	/** Ссылка на pull request */
-	pull_request_url?: string;
-	/** Пользователь, создавший событие */
-	user?: User2;
-	/** Назначенный пользователь */
-	assignee?: User2;
-	/** Назначенная команда */
-	assignee_team?: Team;
-	/** Метка (для событий с метками) */
 	label?: Label;
-	/** Milestone */
 	milestone?: Milestone;
-	/** Старый milestone (для событий изменения milestone) */
-	old_milestone?: Milestone;
-	/** Новая ссылка */
 	new_ref?: string;
-	/** Старая ссылка */
-	old_ref?: string;
-	/** Новый заголовок */
 	new_title?: string;
-	/** Старый заголовок */
+	old_milestone?: Milestone;
+	old_project_id?: number;
+	old_ref?: string;
 	old_title?: string;
-	/** ID проекта */
 	project_id?: number;
-	/** Старый ID проекта */
-	old_project_id?: number;
-	/** Действие со ссылкой */
+	pull_request_url?: string;
 	ref_action?: string;
-	/** Ссылочный комментарий */
 	ref_comment?: Comment;
-	/** SHA коммита, где была ссылка на issue/PR */
+	/** commit SHA where issue/PR was referenced */
 	ref_commit_sha?: string;
-	/** Ссылочный issue */
 	ref_issue?: Issue;
-	/** Зависимый issue */
-	dependent_issue?: Issue;
-	/** Были ли назначенные удалены (true) или добавлены (false) */
+	/** whether the assignees were removed or added */
 	removed_assignee?: boolean;
-	/** Пользователь, разрешивший комментарий */
-	resolve_doer?: User2;
-	/** ID ревью */
+	resolve_doer?: User;
 	review_id?: number;
-	/** Отслеживаемое время */
 	tracked_time?: TrackedTime;
-	/** Дата создания */
-	created_at?: string;
-	/** Дата обновления */
+	type?: string;
+	/** swagger:strfmt date-time */
 	updated_at?: string;
-}
-/**
-* Интерфейс отслеживаемого времени
-*/
-interface TrackedTime {
-	/** Идентификатор */
-	id?: number;
-	/** Дата создания */
-	created?: string;
-	/** Время в секундах */
-	time?: number;
-	/** ID пользователя (deprecated) */
-	user_id?: number;
-	/** Имя пользователя */
-	user_name?: string;
-	/** ID issue (deprecated) */
-	issue_id?: number;
-	/** Issue */
-	issue?: Issue;
-}
-/**
-* Интерфейс команды (team)
-*/
-/**
-* Краткая информация о репозитории (для вложенных объектов)
-*/
-interface RepositoryMeta {
-	/** Идентификатор репозитория */
-	id: number;
-	/** Название репозитория */
-	name: string;
-	/** Полное название репозитория */
-	full_name: string;
-}
-/**
-* Краткая информация о pull request (для вложенных объектов в issue)
-*/
-interface PullRequestMeta {
-	/** URL pull request */
-	url?: string;
-	/** Веб-ссылка на pull request */
-	html_url?: string;
-	/** Ссылка на diff */
-	diff_url?: string;
-	/** Ссылка на patch */
-	patch_url?: string;
-	/** Был ли PR смёрджен */
-	merged?: boolean;
-	/** Дата мёрджа */
-	merged_at?: string | null;
-}
-interface Team {
-	/** Идентификатор команды */
-	id: number;
-	/** Название команды */
-	name: string;
-	/** Описание команды */
-	description?: string;
-	/** Права доступа */
-	permission: "pull" | "push" | "admin";
-	/** Количество участников */
-	num_members?: number;
-	/** Количество репозиториев */
-	num_repos?: number;
-	/** Может создавать репозитории в организации */
-	can_create_org_repo?: boolean;
-	/** Включает все репозитории */
-	includes_all_repositories?: boolean;
-	/** Права на Actions */
-	permission_actions?: string;
-	/** Права на код */
-	permission_code?: string;
-	/** Права на packages */
-	permission_packages?: string;
-	/** Права на pull requests */
-	permission_pulls?: string;
-	/** Права на релизы */
-	permission_releases?: string;
-}
-/**
-* Интерфейс ассета релиза
-*/
-interface Asset {
-	/** Идентификатор ассета */
-	id: number;
-	/** UUID ассета */
-	uuid: string;
-	/** Название файла */
-	name: string;
-	/** Размер в байтах */
-	size: number;
-	/** Количество скачиваний */
-	download_count: number;
-	/** Дата создания */
-	created_at: string;
-	/** URL для скачивания */
-	browser_download_url: string;
+	user?: User;
 }
 /**
 * Предупреждение об устаревшей версии API
@@ -576,34 +380,103 @@ declare class GitVerseClient {
 	uploadFile<T>(path: string, fieldName: string, file: Blob | ArrayBuffer, fileName: string, options?: RequestOptions): Promise<T>;
 }
 /**
-* Класс для работы с issues репозитория
+* API для работы с issues
 */
 declare class IssuesApi {
 	private client;
+	/**
+	* Создает новый экземпляр API
+	* @param client GitVerse клиент
+	*/
 	constructor(client: GitVerseClient);
 	/**
-	* Получить список issues репозитория
+	* List issues and pull requests
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param queryParams Параметры запроса
+	* @param options Опции запроса
+	* @returns Issue[]
 	*/
-	list(owner: string, repo: string, params?: ListIssuesParams, options?: RequestOptions): Promise<Issue[]>;
+	list(owner: string, repo: string, queryParams?: {
+		state?: string
+		q?: string
+		labels?: string
+		milestones?: string
+		created_by?: string
+		assigned_by?: string
+		mentioned_by?: string
+		type?: string
+		since?: string
+		before?: string
+		page?: number
+		per_page?: number
+	}, options?: {
+		signal?: AbortSignal
+	}): Promise<Issue[]>;
 	/**
-	* Получить конкретный issue
+	* Get a specific issue comment
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param id Comment ID
+	* @param options Опции запроса
+	* @returns Comment
 	*/
-	get(owner: string, repo: string, index: number, options?: RequestOptions): Promise<Issue>;
+	getComment(owner: string, repo: string, id: number, options?: {
+		signal?: AbortSignal
+	}): Promise<Comment>;
 	/**
-	* Получить комментарий по ID
+	* Get issue or pull request
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param index Issue or pull request index in the repository
+	* @param options Опции запроса
+	* @returns Issue
 	*/
-	getComment(owner: string, repo: string, id: number, options?: RequestOptions): Promise<Comment>;
+	get(owner: string, repo: string, index: number, options?: {
+		signal?: AbortSignal
+	}): Promise<Issue>;
 	/**
-	* Получить список комментариев к issue
+	* List issue comments
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param index Issue or pull request index in the repository
+	* @param queryParams Параметры запроса
+	* @param options Опции запроса
+	* @returns Comment[]
 	*/
-	getComments(owner: string, repo: string, index: number, params?: ListCommentsParams, options?: RequestOptions): Promise<Comment[]>;
+	listComments(owner: string, repo: string, index: number, queryParams?: {
+		since?: string
+		before?: string
+	}, options?: {
+		signal?: AbortSignal
+	}): Promise<Comment[]>;
 	/**
-	* Получить список меток issue
+	* List issue labels
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param index Issue index in the repository
+	* @param options Опции запроса
+	* @returns Label[]
 	*/
-	getLabels(owner: string, repo: string, index: number, options?: RequestOptions): Promise<Label[]>;
+	listLabels(owner: string, repo: string, index: number, options?: {
+		signal?: AbortSignal
+	}): Promise<Label[]>;
 	/**
-	* Получить timeline событий issue
+	* List issue comments and timeline events
+	* @param owner Repository owner
+	* @param repo Repository name
+	* @param index Issue index in the repository
+	* @param queryParams Параметры запроса
+	* @param options Опции запроса
+	* @returns TimelineComment[]
 	*/
-	getTimeline(owner: string, repo: string, index: number, params?: GetTimelineParams, options?: RequestOptions): Promise<TimelineComment[]>;
+	listTimeline(owner: string, repo: string, index: number, queryParams?: {
+		page?: number
+		per_page?: number
+		since?: string
+		before?: string
+	}, options?: {
+		signal?: AbortSignal
+	}): Promise<TimelineComment[]>;
 }
 export { IssuesApi };