gitverse-api-sdk 5.1.0 → 5.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,208 +1,43 @@
1
+ import type { GitVerseClient } from "../client";
2
+ import type { CreateEmailParams, DeleteEmailParams, Email } from "../types";
1
3
  /**
2
- * Типы данных для GitVerse API
3
- * @generated Сгенерировано автоматически из OpenAPI спецификации
4
- */
5
- /**
6
- * Опции для выполнения HTTP-запросов
7
- */
8
- interface RequestOptions {
9
- /**
10
- * AbortSignal для отмены запроса
11
- * @example
12
- * const controller = new AbortController();
13
- * const promise = client.users.getCurrent({ signal: controller.signal });
14
- * controller.abort(); // Отменяет запрос
15
- */
16
- signal?: AbortSignal;
17
- }
18
- interface CreateEmailParams {
19
- emails?: string[];
20
- }
21
- interface DeleteEmailParams {
22
- emails?: string[];
23
- }
24
- interface Email {
25
- email?: string;
26
- primary?: boolean;
27
- verified?: boolean;
28
- visibility?: string;
29
- }
30
- /**
31
- * Предупреждение об устаревшей версии API
32
- */
33
- declare class ApiVersionWarning {
34
- /** Текущая используемая версия */
35
- readonly currentVersion: string;
36
- /** Последняя доступная версия */
37
- readonly latestVersion: string;
38
- /** Дата вывода из эксплуатации */
39
- readonly decommissioning?: string;
40
- constructor(currentVersion: string, latestVersion: string, decommissioning?: string);
41
- /**
42
- * Возвращает сообщение о предупреждении
43
- */
44
- getMessage(): string;
45
- }
46
- declare const HTTPMethods: {
47
- readonly DELETE: "DELETE"
48
- readonly GET: "GET"
49
- readonly PATCH: "PATCH"
50
- readonly POST: "POST"
51
- readonly PUT: "PUT"
52
- };
53
- type HTTPMethods = (typeof HTTPMethods)[keyof typeof HTTPMethods];
54
- /**
55
- * Параметры для конфигурации GitVerse клиента
56
- */
57
- interface GitVerseClientConfig {
58
- /**
59
- * Базовый URL API GitVerse
60
- * @default 'https://api.gitverse.ru'
61
- */
62
- baseUrl?: string;
63
- /**
64
- * Токен доступа для авторизации в API
65
- */
66
- token?: string;
67
- /**
68
- * Версия API
69
- * @default '1'
70
- */
71
- apiVersion?: string;
72
- }
73
- /**
74
- * Основной класс для работы с GitVerse API
75
- */
76
- declare class GitVerseClient {
77
- private baseUrl;
78
- private token?;
79
- private apiVersion;
80
- /**
81
- * Callback для обработки предупреждений об устаревшей версии API
82
- */
83
- onApiVersionWarning?: (warning: ApiVersionWarning) => void;
84
- /**
85
- * Создает новый экземпляр GitVerse клиента
86
- * @param config Конфигурация клиента
87
- */
88
- constructor(config?: GitVerseClientConfig);
89
- /**
90
- * Устанавливает токен авторизации
91
- * @param token Токен доступа
92
- */
93
- setToken(token: string): void;
94
- /**
95
- * Извлекает информацию о Rate Limit из заголовков ответа
96
- */
97
- private extractRateLimitInfo;
98
- /**
99
- * Извлекает информацию о версии API из заголовков ответа
100
- */
101
- private extractApiVersionInfo;
102
- /**
103
- * Извлекает метаданные из заголовков ответа
104
- */
105
- private extractMetadata;
106
- /**
107
- * Выполняет API-запрос с учетом авторизации и версии API
108
- * @param path Путь к API-ресурсу
109
- * @param method HTTP-метод
110
- * @param body Тело запроса (опционально)
111
- * @param options Опции запроса (опционально)
112
- * @returns Ответ от API
113
- * @throws {RateLimitError} При превышении лимита запросов (429)
114
- * @throws {GitVerseApiError} При других ошибках API
115
- */
116
- request<T>(path: string, method: HTTPMethods, body?: unknown, options?: RequestOptions): Promise<T>;
117
- /**
118
- * Выполняет GET-запрос
119
- * @param path Путь к API-ресурсу
120
- * @param options Опции запроса (опционально)
121
- * @returns Ответ от API
122
- */
123
- get<T>(path: string, options?: RequestOptions): Promise<T>;
124
- /**
125
- * Выполняет POST-запрос
126
- * @param path Путь к API-ресурсу
127
- * @param body Тело запроса
128
- * @param options Опции запроса (опционально)
129
- * @returns Ответ от API
130
- */
131
- post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
132
- /**
133
- * Выполняет PUT-запрос
134
- * @param path Путь к API-ресурсу
135
- * @param body Тело запроса
136
- * @param options Опции запроса (опционально)
137
- * @returns Ответ от API
138
- */
139
- put<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
140
- /**
141
- * Выполняет DELETE-запрос
142
- * @param path Путь к API-ресурсу
143
- * @param body Тело запроса (опционально)
144
- * @param options Опции запроса (опционально)
145
- * @returns Ответ от API
146
- */
147
- delete<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
148
- /**
149
- * Выполняет PATCH-запрос
150
- * @param path Путь к API-ресурсу
151
- * @param body Тело запроса
152
- * @param options Опции запроса (опционально)
153
- * @returns Ответ от API
154
- */
155
- patch<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
156
- /**
157
- * Выполняет загрузку файла через multipart/form-data
158
- * @param path Путь к API-ресурсу
159
- * @param fieldName Имя поля для файла
160
- * @param file Файл для загрузки (Blob или ArrayBuffer)
161
- * @param fileName Имя файла
162
- * @param options Опции запроса (опционально)
163
- * @returns Ответ от API
164
- */
165
- uploadFile<T>(path: string, fieldName: string, file: Blob | ArrayBuffer, fileName: string, options?: RequestOptions): Promise<T>;
166
- }
167
- /**
168
- * API для работы с email адресами
169
- */
170
- declare class EmailsApi {
171
- private client;
172
- /**
173
- * Создает новый экземпляр API
174
- * @param client GitVerse клиент
175
- */
176
- constructor(client: GitVerseClient);
177
- /**
178
- * Get user email addresses
179
- * @param queryParams Параметры запроса
180
- * @param options Опции запроса
181
- * @returns Email[]
182
- */
183
- list(queryParams?: {
184
- page?: number
185
- per_page?: number
186
- }, options?: {
187
- signal?: AbortSignal
188
- }): Promise<Email[]>;
189
- /**
190
- * Add email addresses
191
- * @param params Email addresses to add
192
- * @param options Опции запроса
193
- * @returns Email[]
194
- */
195
- create(params: CreateEmailParams, options?: {
196
- signal?: AbortSignal
197
- }): Promise<Email[]>;
198
- /**
199
- * Delete email addresses
200
- * @param params Email addresses to delete
201
- * @param options Опции запроса
202
- * @returns void
203
- */
204
- delete(params: DeleteEmailParams, options?: {
205
- signal?: AbortSignal
206
- }): Promise<void>;
4
+ * API для работы с email адресами
5
+ */
6
+ export declare class EmailsApi {
7
+ private client;
8
+ /**
9
+ * Создает новый экземпляр API
10
+ * @param client GitVerse клиент
11
+ */
12
+ constructor(client: GitVerseClient);
13
+ /**
14
+ * Get user email addresses
15
+ * @param queryParams Параметры запроса
16
+ * @param options Опции запроса
17
+ * @returns Email[]
18
+ */
19
+ list(queryParams?: {
20
+ page?: number;
21
+ per_page?: number;
22
+ }, options?: {
23
+ signal?: AbortSignal;
24
+ }): Promise<Email[]>;
25
+ /**
26
+ * Add email addresses
27
+ * @param params Email addresses to add
28
+ * @param options Опции запроса
29
+ * @returns Email[]
30
+ */
31
+ create(params: CreateEmailParams, options?: {
32
+ signal?: AbortSignal;
33
+ }): Promise<Email[]>;
34
+ /**
35
+ * Delete email addresses
36
+ * @param params Email addresses to delete
37
+ * @param options Опции запроса
38
+ * @returns void
39
+ */
40
+ delete(params: DeleteEmailParams, options?: {
41
+ signal?: AbortSignal;
42
+ }): Promise<void>;
207
43
  }
208
- export { EmailsApi };