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.
- package/README.md +112 -7
- package/dist/api/actions.d.ts +313 -544
- package/dist/api/emails.d.ts +41 -206
- package/dist/api/issues.d.ts +100 -480
- package/dist/api/organizations.d.ts +67 -228
- package/dist/api/pages.d.ts +33 -197
- package/dist/api/pulls.d.ts +75 -520
- package/dist/api/releases.d.ts +135 -384
- package/dist/api/repositories.d.ts +354 -1067
- package/dist/api/repositories.js.map +2 -2
- package/dist/api/stars.d.ts +55 -272
- package/dist/api/teams.d.ts +51 -288
- package/dist/api/users.d.ts +52 -263
- package/dist/client.d.ts +118 -150
- package/dist/enums.d.ts +47 -48
- package/dist/errors.d.ts +39 -73
- package/dist/index.d.ts +54 -2442
- package/dist/types.d.ts +1028 -904
- package/dist/utils.d.ts +72 -61
- package/package.json +1 -3
package/dist/api/emails.d.ts
CHANGED
|
@@ -1,208 +1,43 @@
|
|
|
1
|
+
import type { GitVerseClient } from "../client";
|
|
2
|
+
import type { CreateEmailParams, DeleteEmailParams, Email } from "../types";
|
|
1
3
|
/**
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
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 };
|