gitverse-api-sdk 5.1.0 → 5.2.0

package/dist/api/releases.d.ts

@@ -1,386 +1,137 @@
+import type { GitVerseClient } from "../client";
+import type { Attachment, CreateReleaseParams, Release, UpdateReleaseParams } 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 CreateReleaseParams {
-	body?: string;
-	draft?: boolean;
-	name?: string;
-	prerelease?: boolean;
-	tag_name?: string;
-	target_commitish?: string;
-}
-interface UpdateReleaseParams {
-	body?: string;
-	draft?: boolean;
-	name?: string;
-	prerelease?: boolean;
-	tag_name?: string;
-	target_commitish?: string;
-}
-interface Attachment {
-	browser_download_url?: string;
-	created_at?: string;
-	download_count?: number;
-	id?: number;
-	name?: string;
-	size?: number;
-	uuid?: 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 Release {
-	assets?: Attachment[];
-	author?: User;
-	body?: string;
-	created_at?: string;
-	draft?: boolean;
-	html_url?: string;
-	id?: number;
-	name?: string;
-	prerelease?: boolean;
-	published_at?: string;
-	tag_name?: string;
-	tarball_url?: string;
-	target_commitish?: string;
-	upload_url?: string;
-	url?: string;
-	zipball_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 ReleasesApi {
-	private client;
-	/**
-	* Создает новый экземпляр API
-	* @param client GitVerse клиент
-	*/
-	constructor(client: GitVerseClient);
-	/**
-	* Returns a list of releases
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param queryParams Параметры запроса
-	* @param options Опции запроса
-	* @returns Release[]
-	*/
-	list(owner: string, repo: string, queryParams?: {
-		page?: number
-		per_page?: number
-		draft?: boolean
-		pre_release?: boolean
-	}, options?: {
-		signal?: AbortSignal
-	}): Promise<Release[]>;
-	/**
-	* Create a release
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param params Parameters for creating the release
-	* @param options Опции запроса
-	* @returns Release
-	*/
-	create(owner: string, repo: string, params: CreateReleaseParams, options?: {
-		signal?: AbortSignal
-	}): Promise<Release>;
-	/**
-	* Gets a release by its tag name
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param tag Tag name of the release to retrieve (e.g., 'v1.0.0')
-	* @param options Опции запроса
-	* @returns Release
-	*/
-	getByTag(owner: string, repo: string, tag: string, options?: {
-		signal?: AbortSignal
-	}): Promise<Release>;
-	/**
-	* Deletes a release by its tag name
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param tag Tag name of the release to delete (e.g., 'v1.0.0')
-	* @param options Опции запроса
-	* @returns void
-	*/
-	deleteByTag(owner: string, repo: string, tag: string, options?: {
-		signal?: AbortSignal
-	}): Promise<void>;
-	/**
-	* Return a release
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param release_id Identifier of the release
-	* @param options Опции запроса
-	* @returns Release
-	*/
-	get(owner: string, repo: string, release_id: string, options?: {
-		signal?: AbortSignal
-	}): Promise<Release>;
-	/**
-	* Edit a release
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param release_id Identifier of the release
-	* @param params Parameters for editing the release
-	* @param options Опции запроса
-	* @returns Release
-	*/
-	update(owner: string, repo: string, release_id: string, params: UpdateReleaseParams, options?: {
-		signal?: AbortSignal
-	}): Promise<Release>;
-	/**
-	* Delete a release
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param release_id Identifier of the release
-	* @param options Опции запроса
-	* @returns void
-	*/
-	delete(owner: string, repo: string, release_id: string, options?: {
-		signal?: AbortSignal
-	}): Promise<void>;
-	/**
-	* Returns a list of assets (files) for a release
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param release_id Identifier of the release
-	* @param queryParams Параметры запроса
-	* @param options Опции запроса
-	* @returns Attachment[]
-	*/
-	listAssets(owner: string, repo: string, release_id: string, queryParams?: {
-		page?: number
-		per_page?: number
-	}, options?: {
-		signal?: AbortSignal
-	}): Promise<Attachment[]>;
-	/**
-	* Upload asset to release
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param release_id Identifier of the release
-	* @param queryParams Параметры запроса
-	* @param options Опции запроса
-	* @returns Attachment
-	*/
-	uploadAsset(owner: string, repo: string, release_id: string, queryParams?: {
-		name: string
-	}, options?: {
-		signal?: AbortSignal
-	}): Promise<Attachment>;
-	/**
-	* Delete asset from release
-	* @param owner Owner of the repository (owner or organization name)
-	* @param repo Name of the repository without the .git extension
-	* @param release_id Identifier of the release
-	* @param asset_id Identifier of the asset
-	* @param options Опции запроса
-	* @returns void
-	*/
-	deleteAsset(owner: string, repo: string, release_id: string, asset_id: string, options?: {
-		signal?: AbortSignal
-	}): Promise<void>;
+ * API для работы с релизами
+ */
+export declare class ReleasesApi {
+    private client;
+    /**
+     * Создает новый экземпляр API
+     * @param client GitVerse клиент
+     */
+    constructor(client: GitVerseClient);
+    /**
+     * Returns a list of releases
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param queryParams Параметры запроса
+     * @param options Опции запроса
+     * @returns Release[]
+     */
+    list(owner: string, repo: string, queryParams?: {
+        page?: number;
+        per_page?: number;
+        draft?: boolean;
+        pre_release?: boolean;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Release[]>;
+    /**
+     * Create a release
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param params Parameters for creating the release
+     * @param options Опции запроса
+     * @returns Release
+     */
+    create(owner: string, repo: string, params: CreateReleaseParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<Release>;
+    /**
+     * Gets a release by its tag name
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param tag Tag name of the release to retrieve (e.g., 'v1.0.0')
+     * @param options Опции запроса
+     * @returns Release
+     */
+    getByTag(owner: string, repo: string, tag: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<Release>;
+    /**
+     * Deletes a release by its tag name
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param tag Tag name of the release to delete (e.g., 'v1.0.0')
+     * @param options Опции запроса
+     * @returns void
+     */
+    deleteByTag(owner: string, repo: string, tag: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Return a release
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param release_id Identifier of the release
+     * @param options Опции запроса
+     * @returns Release
+     */
+    get(owner: string, repo: string, release_id: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<Release>;
+    /**
+     * Edit a release
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param release_id Identifier of the release
+     * @param params Parameters for editing the release
+     * @param options Опции запроса
+     * @returns Release
+     */
+    update(owner: string, repo: string, release_id: string, params: UpdateReleaseParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<Release>;
+    /**
+     * Delete a release
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param release_id Identifier of the release
+     * @param options Опции запроса
+     * @returns void
+     */
+    delete(owner: string, repo: string, release_id: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Returns a list of assets (files) for a release
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param release_id Identifier of the release
+     * @param queryParams Параметры запроса
+     * @param options Опции запроса
+     * @returns Attachment[]
+     */
+    listAssets(owner: string, repo: string, release_id: string, queryParams?: {
+        page?: number;
+        per_page?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Attachment[]>;
+    /**
+     * Upload asset to release
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param release_id Identifier of the release
+     * @param queryParams Параметры запроса
+     * @param options Опции запроса
+     * @returns Attachment
+     */
+    uploadAsset(owner: string, repo: string, release_id: string, queryParams?: {
+        name: string;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Attachment>;
+    /**
+     * Delete asset from release
+     * @param owner Owner of the repository (owner or organization name)
+     * @param repo Name of the repository without the .git extension
+     * @param release_id Identifier of the release
+     * @param asset_id Identifier of the asset
+     * @param options Опции запроса
+     * @returns void
+     */
+    deleteAsset(owner: string, repo: string, release_id: string, asset_id: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
 }
-export { ReleasesApi };