typizer 0.1.0 → 0.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/CHANGELOG.md +60 -0
- package/README.md +273 -134
- package/dist/client.d.ts +323 -0
- package/dist/client.js +629 -0
- package/dist/core.d.ts +109 -0
- package/dist/core.js +339 -0
- package/dist/errors.d.ts +146 -0
- package/dist/errors.js +281 -0
- package/dist/files.d.ts +42 -0
- package/dist/files.js +159 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +329 -5
- package/dist/gen/sdk.gen.js +588 -4
- package/dist/gen/types.gen.d.ts +2490 -245
- package/dist/index.d.ts +26 -3
- package/dist/index.js +33 -4
- package/dist/pagination.d.ts +30 -0
- package/dist/pagination.js +49 -0
- package/dist/run.d.ts +48 -0
- package/dist/run.js +45 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.js +2 -0
- package/dist/webhooks.d.ts +40 -0
- package/dist/webhooks.js +208 -0
- package/package.json +9 -7
package/dist/gen/sdk.gen.js
CHANGED
|
@@ -5,6 +5,8 @@ import { formDataBodySerializer } from './client/index.js';
|
|
|
5
5
|
* Начать вход: отправить на почту одноразовый код и ссылку для входа
|
|
6
6
|
*
|
|
7
7
|
* Доступ: публичный, без учётных данных.
|
|
8
|
+
*
|
|
9
|
+
* @deprecated
|
|
8
10
|
*/
|
|
9
11
|
export const startLogin = (options) => (options.client ?? client).post({
|
|
10
12
|
url: '/v1/auth/start',
|
|
@@ -20,6 +22,8 @@ export const startLogin = (options) => (options.client ?? client).post({
|
|
|
20
22
|
* Создаёт платёж и возвращает платёжную форму банка. Страницы зачисляются, когда банк подтвердит платёж.
|
|
21
23
|
*
|
|
22
24
|
* Доступ: только сессия с ролью owner или admin.
|
|
25
|
+
*
|
|
26
|
+
* @deprecated
|
|
23
27
|
*/
|
|
24
28
|
export const createCheckout = (options) => (options.client ?? client).post({
|
|
25
29
|
security: [{
|
|
@@ -38,6 +42,8 @@ export const createCheckout = (options) => (options.client ?? client).post({
|
|
|
38
42
|
* Найти компании и ИП по названию, ИНН или ОГРН
|
|
39
43
|
*
|
|
40
44
|
* Доступ: только сессия.
|
|
45
|
+
*
|
|
46
|
+
* @deprecated
|
|
41
47
|
*/
|
|
42
48
|
export const suggestCompanies = (options) => (options.client ?? client).get({
|
|
43
49
|
security: [{
|
|
@@ -52,6 +58,8 @@ export const suggestCompanies = (options) => (options.client ?? client).get({
|
|
|
52
58
|
* Получить компанию или ИП по ИНН
|
|
53
59
|
*
|
|
54
60
|
* Доступ: только сессия.
|
|
61
|
+
*
|
|
62
|
+
* @deprecated
|
|
55
63
|
*/
|
|
56
64
|
export const getCompany = (options) => (options.client ?? client).get({
|
|
57
65
|
security: [{
|
|
@@ -66,6 +74,8 @@ export const getCompany = (options) => (options.client ?? client).get({
|
|
|
66
74
|
* Платёжные реквизиты организации и настройки автопополнения
|
|
67
75
|
*
|
|
68
76
|
* Доступ: только сессия.
|
|
77
|
+
*
|
|
78
|
+
* @deprecated
|
|
69
79
|
*/
|
|
70
80
|
export const getBillingProfile = (options) => (options?.client ?? client).get({
|
|
71
81
|
security: [{
|
|
@@ -82,6 +92,8 @@ export const getBillingProfile = (options) => (options?.client ?? client).get({
|
|
|
82
92
|
* ИНН, КПП и ОГРН проверяются; компания ищется в реестре. Разовый бонус за ИНН начисляется, когда организация оплатила пакет и её ИНН принадлежит действующей компании: при этом сохранении, если оплата уже была, иначе после первой оплаты.
|
|
83
93
|
*
|
|
84
94
|
* Доступ: только сессия с ролью owner или admin.
|
|
95
|
+
*
|
|
96
|
+
* @deprecated
|
|
85
97
|
*/
|
|
86
98
|
export const updateBillingProfile = (options) => (options.client ?? client).put({
|
|
87
99
|
security: [{
|
|
@@ -102,6 +114,8 @@ export const updateBillingProfile = (options) => (options.client ?? client).put(
|
|
|
102
114
|
* Всегда скачивание (Content-Disposition: attachment). Не больше 2 скачиваний одновременно на организацию (и на пользователя): сверх этого 429 с Retry-After.
|
|
103
115
|
*
|
|
104
116
|
* Доступ: только сессия.
|
|
117
|
+
*
|
|
118
|
+
* @deprecated
|
|
105
119
|
*/
|
|
106
120
|
export const getActPdf = (options) => (options.client ?? client).get({
|
|
107
121
|
security: [{
|
|
@@ -118,6 +132,8 @@ export const getActPdf = (options) => (options.client ?? client).get({
|
|
|
118
132
|
* Нужен платёжный профиль с ИНН. Банк выставляет счёт и отправляет его на почту; страницы зачисляются после оплаты.
|
|
119
133
|
*
|
|
120
134
|
* Доступ: только сессия с ролью owner или admin.
|
|
135
|
+
*
|
|
136
|
+
* @deprecated
|
|
121
137
|
*/
|
|
122
138
|
export const createInvoice = (options) => (options.client ?? client).post({
|
|
123
139
|
security: [{
|
|
@@ -138,6 +154,8 @@ export const createInvoice = (options) => (options.client ?? client).post({
|
|
|
138
154
|
* Для включения нужна карта, сохранённая при оплате с согласием на автопополнение (иначе 409). Выключение также удаляет сохранённую карту.
|
|
139
155
|
*
|
|
140
156
|
* Доступ: только сессия с ролью owner или admin.
|
|
157
|
+
*
|
|
158
|
+
* @deprecated
|
|
141
159
|
*/
|
|
142
160
|
export const updateAutotopup = (options) => (options.client ?? client).patch({
|
|
143
161
|
security: [{
|
|
@@ -156,6 +174,8 @@ export const updateAutotopup = (options) => (options.client ?? client).patch({
|
|
|
156
174
|
* Запросы договоров организации, новые первыми
|
|
157
175
|
*
|
|
158
176
|
* Доступ: только сессия.
|
|
177
|
+
*
|
|
178
|
+
* @deprecated
|
|
159
179
|
*/
|
|
160
180
|
export const listContractRequests = (options) => (options?.client ?? client).get({
|
|
161
181
|
security: [{
|
|
@@ -172,6 +192,8 @@ export const listContractRequests = (options) => (options?.client ?? client).get
|
|
|
172
192
|
* Договор составляется по платёжному профилю и отправляется через Диадок или письмом на адрес для документов. Не больше 5 запросов на организацию в сутки. Новый запрос отклоняется, пока предыдущий в работе; договор, отправленный письмом, перестаёт считаться в работе через 30 дней.
|
|
173
193
|
*
|
|
174
194
|
* Доступ: только сессия с ролью owner или admin.
|
|
195
|
+
*
|
|
196
|
+
* @deprecated
|
|
175
197
|
*/
|
|
176
198
|
export const createContractRequest = (options) => (options?.client ?? client).post({
|
|
177
199
|
security: [{
|
|
@@ -188,6 +210,8 @@ export const createContractRequest = (options) => (options?.client ?? client).po
|
|
|
188
210
|
* Всегда скачивание (Content-Disposition: attachment). Не больше 2 скачиваний одновременно на организацию (и на пользователя).
|
|
189
211
|
*
|
|
190
212
|
* Доступ: только сессия.
|
|
213
|
+
*
|
|
214
|
+
* @deprecated
|
|
191
215
|
*/
|
|
192
216
|
export const getContractRequestPdf = (options) => (options.client ?? client).get({
|
|
193
217
|
security: [{
|
|
@@ -202,6 +226,8 @@ export const getContractRequestPdf = (options) => (options.client ?? client).get
|
|
|
202
226
|
* Платежи организации, новые первыми
|
|
203
227
|
*
|
|
204
228
|
* Доступ: только сессия.
|
|
229
|
+
*
|
|
230
|
+
* @deprecated
|
|
205
231
|
*/
|
|
206
232
|
export const listPayments = (options) => (options?.client ?? client).get({
|
|
207
233
|
security: [{
|
|
@@ -216,6 +242,8 @@ export const listPayments = (options) => (options?.client ?? client).get({
|
|
|
216
242
|
* Получить платёж со счётом и актом
|
|
217
243
|
*
|
|
218
244
|
* Доступ: только сессия.
|
|
245
|
+
*
|
|
246
|
+
* @deprecated
|
|
219
247
|
*/
|
|
220
248
|
export const getPayment = (options) => (options.client ?? client).get({
|
|
221
249
|
security: [{
|
|
@@ -229,9 +257,11 @@ export const getPayment = (options) => (options.client ?? client).get({
|
|
|
229
257
|
/**
|
|
230
258
|
* Записать необязательное согласие (аналитические cookie, маркетинг)
|
|
231
259
|
*
|
|
232
|
-
* Записывает в журнал одно решение: согласие дано или отозвано. Вызывается с typizer.ru и из Кабинета, поэтому нужен собственный Origin
|
|
260
|
+
* Записывает в журнал одно решение: согласие дано или отозвано. Вызывается с typizer.ru, docs.typizer.ru и из Кабинета, поэтому нужен собственный Origin; сайт, на котором принято решение, сервер определяет по Origin и записывает в журнал. Cookie сессии необязательна: с ней запись привязывается к аккаунту; для marketing она нужна (без неё 401). doc_version должна быть текущей версией документа. 120 запросов в минуту с одного адреса. Idempotency-Key игнорируется.
|
|
233
261
|
*
|
|
234
262
|
* Доступ: публичный; сессия необязательна (с ней запрос выполняется от имени её пользователя).
|
|
263
|
+
*
|
|
264
|
+
* @deprecated
|
|
235
265
|
*/
|
|
236
266
|
export const createConsent = (options) => (options.client ?? client).post({
|
|
237
267
|
url: '/v1/consents',
|
|
@@ -247,14 +277,28 @@ export const createConsent = (options) => (options.client ?? client).post({
|
|
|
247
277
|
* Без авторизации. Синтетические документы-образцы и запрос, показываемый для каждого. Как и любой вызов /v1, входит в общий лимит запросов с одного адреса (429 с Retry-After).
|
|
248
278
|
*
|
|
249
279
|
* Доступ: публичный, без учётных данных.
|
|
280
|
+
*
|
|
281
|
+
* @deprecated
|
|
250
282
|
*/
|
|
251
283
|
export const listDemoSamples = (options) => (options?.client ?? client).get({ url: '/v1/demo/samples', ...options });
|
|
284
|
+
/**
|
|
285
|
+
* Сколько демо-прогонов осталось
|
|
286
|
+
*
|
|
287
|
+
* Без авторизации. Сколько прогонов без кеша (своим файлом или своим запросом к образцу) осталось адресу сегодня из 3; лендинг показывает это над кнопкой «Извлечь». Ничего не тратит и не создаёт. Если счётчики недоступны — 503 с Retry-After, а не догадка.
|
|
288
|
+
*
|
|
289
|
+
* Доступ: публичный, без учётных данных.
|
|
290
|
+
*
|
|
291
|
+
* @deprecated
|
|
292
|
+
*/
|
|
293
|
+
export const getDemoQuota = (options) => (options?.client ?? client).get({ url: '/v1/demo/quota', ...options });
|
|
252
294
|
/**
|
|
253
295
|
* Запустить демо на лендинге
|
|
254
296
|
*
|
|
255
297
|
* Без авторизации; вызывается с лендинга (нужен собственный Origin). JSON {sample, prompt} запускает образец: на его собственный запрос ответ приходит сразу из заранее посчитанного результата, на пресет галереи — из кеша или настоящим прогоном, на любой другой запрос — настоящим прогоном. Multipart (file, prompt, consent_pd, consent_version) запускает ваш PDF или изображение не больше 3 страниц; файл удаляется сразу после прогона, а результат хранится 1 ч. Прогоны, на которые нет ответа в кеше, ограничены 3 на адрес в сутки (по Москве) и общим дневным лимитом сервиса (429, Retry-After до полуночи); запросы — 30 в минуту с одного адреса. Idempotency-Key игнорируется. 200 с завершённым прогоном, иначе 202: опрашивайте GET /v1/demo/runs/{id}?token=.
|
|
256
298
|
*
|
|
257
299
|
* Доступ: публичный, без учётных данных.
|
|
300
|
+
*
|
|
301
|
+
* @deprecated
|
|
258
302
|
*/
|
|
259
303
|
export const createDemoRun = (options) => (options?.client ?? client).post({
|
|
260
304
|
url: '/v1/demo/runs',
|
|
@@ -270,8 +314,38 @@ export const createDemoRun = (options) => (options?.client ?? client).post({
|
|
|
270
314
|
* Без авторизации: нужен token прогона. Только демо-прогоны; что угодно другое или неверный token — 404. wait (0–60) держит запрос до завершения прогона.
|
|
271
315
|
*
|
|
272
316
|
* Доступ: публичный, без учётных данных.
|
|
317
|
+
*
|
|
318
|
+
* @deprecated
|
|
273
319
|
*/
|
|
274
320
|
export const getDemoRun = (options) => (options.client ?? client).get({ url: '/v1/demo/runs/{id}', ...options });
|
|
321
|
+
/**
|
|
322
|
+
* Сколько файлов можно распознать сегодня
|
|
323
|
+
*
|
|
324
|
+
* Без авторизации. Сколько файлов из 20 адрес ещё может распознать бесплатным инструментом сегодня, и его ограничения. Ничего не тратит и не создаёт. Если счётчики недоступны — 503 с Retry-After.
|
|
325
|
+
*
|
|
326
|
+
* Доступ: публичный, без учётных данных.
|
|
327
|
+
*
|
|
328
|
+
* @deprecated
|
|
329
|
+
*/
|
|
330
|
+
export const getToolOcrQuota = (options) => (options?.client ?? client).get({ url: '/v1/tools/ocr/quota', ...options });
|
|
331
|
+
/**
|
|
332
|
+
* Распознать текст и таблицы (бесплатный инструмент сайта)
|
|
333
|
+
*
|
|
334
|
+
* Без авторизации; вызывается со страниц typizer.ru/tools/ (нужен собственный Origin) — это виджет сайта, а не API для интеграций: для своих систем используйте POST /v1/extract. Multipart (file, consent_pd, consent_version): PDF или изображение; распознаются первые 5 страниц, ответ — текст по страницам и таблицы, синхронно. Файл обрабатывается в памяти и не сохраняется, результат тоже. Лимиты: 20 файлов на адрес в сутки (по Москве), 60 на сеть IPv6 /48 и общий дневной лимит страниц сервиса (429, Retry-After до полуночи); запросы — 10 в минуту с адреса. Если распознаватель занят — 503 с Retry-After. Idempotency-Key игнорируется.
|
|
335
|
+
*
|
|
336
|
+
* Доступ: публичный, без учётных данных.
|
|
337
|
+
*
|
|
338
|
+
* @deprecated
|
|
339
|
+
*/
|
|
340
|
+
export const createToolOcr = (options) => (options.client ?? client).post({
|
|
341
|
+
...formDataBodySerializer,
|
|
342
|
+
url: '/v1/tools/ocr',
|
|
343
|
+
...options,
|
|
344
|
+
headers: {
|
|
345
|
+
'Content-Type': null,
|
|
346
|
+
...options.headers
|
|
347
|
+
}
|
|
348
|
+
});
|
|
275
349
|
/**
|
|
276
350
|
* Текущие и предстоящие работы и сбои
|
|
277
351
|
*
|
|
@@ -301,6 +375,8 @@ export const getOpenApiDocument = (options) => (options?.client ?? client).get({
|
|
|
301
375
|
* 409 conflict: сначала передайте владение или удалите ту организацию.
|
|
302
376
|
*
|
|
303
377
|
* Доступ: только сессия.
|
|
378
|
+
*
|
|
379
|
+
* @deprecated
|
|
304
380
|
*/
|
|
305
381
|
export const deleteMe = (options) => (options?.client ?? client).delete({
|
|
306
382
|
security: [{
|
|
@@ -329,6 +405,8 @@ export const getMe = (options) => (options?.client ?? client).get({
|
|
|
329
405
|
* Журнал входов текущего пользователя
|
|
330
406
|
*
|
|
331
407
|
* Доступ: только сессия.
|
|
408
|
+
*
|
|
409
|
+
* @deprecated
|
|
332
410
|
*/
|
|
333
411
|
export const listSignIns = (options) => (options?.client ?? client).get({
|
|
334
412
|
security: [{
|
|
@@ -345,6 +423,8 @@ export const listSignIns = (options) => (options?.client ?? client).get({
|
|
|
345
423
|
* Только сессия: состояние согласия на маркетинговые рассылки по последнему решению текущего пользователя в журнале согласий (дать или отозвать его — POST /v1/consents). Без решений — granted равно false, version и updated_at равны null.
|
|
346
424
|
*
|
|
347
425
|
* Доступ: только сессия.
|
|
426
|
+
*
|
|
427
|
+
* @deprecated
|
|
348
428
|
*/
|
|
349
429
|
export const getMyConsents = (options) => (options?.client ?? client).get({
|
|
350
430
|
security: [{
|
|
@@ -359,6 +439,8 @@ export const getMyConsents = (options) => (options?.client ?? client).get({
|
|
|
359
439
|
* Активные ключи API организации
|
|
360
440
|
*
|
|
361
441
|
* Доступ: только сессия с ролью owner или admin.
|
|
442
|
+
*
|
|
443
|
+
* @deprecated
|
|
362
444
|
*/
|
|
363
445
|
export const listApiKeys = (options) => (options?.client ?? client).get({
|
|
364
446
|
security: [{
|
|
@@ -373,6 +455,8 @@ export const listApiKeys = (options) => (options?.client ?? client).get({
|
|
|
373
455
|
* Создать ключ API (ключ показывается один раз)
|
|
374
456
|
*
|
|
375
457
|
* Доступ: только сессия с ролью owner или admin.
|
|
458
|
+
*
|
|
459
|
+
* @deprecated
|
|
376
460
|
*/
|
|
377
461
|
export const createApiKey = (options) => (options.client ?? client).post({
|
|
378
462
|
security: [{
|
|
@@ -391,6 +475,8 @@ export const createApiKey = (options) => (options.client ?? client).post({
|
|
|
391
475
|
* Отозвать ключ API навсегда
|
|
392
476
|
*
|
|
393
477
|
* Доступ: только сессия с ролью owner или admin.
|
|
478
|
+
*
|
|
479
|
+
* @deprecated
|
|
394
480
|
*/
|
|
395
481
|
export const deleteApiKey = (options) => (options.client ?? client).delete({
|
|
396
482
|
security: [{
|
|
@@ -401,6 +487,184 @@ export const deleteApiKey = (options) => (options.client ?? client).delete({
|
|
|
401
487
|
url: '/v1/api_keys/{id}',
|
|
402
488
|
...options
|
|
403
489
|
});
|
|
490
|
+
/**
|
|
491
|
+
* Одноразовая ссылка для подключения бота в Telegram или MAX либо портала Битрикс24 к организации
|
|
492
|
+
*
|
|
493
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
494
|
+
*
|
|
495
|
+
* @deprecated
|
|
496
|
+
*/
|
|
497
|
+
export const createConnectorLink = (options) => (options.client ?? client).post({
|
|
498
|
+
security: [{
|
|
499
|
+
in: 'cookie',
|
|
500
|
+
name: '__Secure-better-auth.session_token',
|
|
501
|
+
type: 'apiKey'
|
|
502
|
+
}],
|
|
503
|
+
url: '/v1/connector_links',
|
|
504
|
+
...options,
|
|
505
|
+
headers: {
|
|
506
|
+
'Content-Type': 'application/json',
|
|
507
|
+
...options.headers
|
|
508
|
+
}
|
|
509
|
+
});
|
|
510
|
+
/**
|
|
511
|
+
* Запрос на подключение интеграции (amoCRM): какой аккаунт и кто его запросил
|
|
512
|
+
*
|
|
513
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
514
|
+
*
|
|
515
|
+
* @deprecated
|
|
516
|
+
*/
|
|
517
|
+
export const getConnectorLinkRequest = (options) => (options.client ?? client).get({
|
|
518
|
+
security: [{
|
|
519
|
+
in: 'cookie',
|
|
520
|
+
name: '__Secure-better-auth.session_token',
|
|
521
|
+
type: 'apiKey'
|
|
522
|
+
}],
|
|
523
|
+
url: '/v1/connector_links/requests/{id}',
|
|
524
|
+
...options
|
|
525
|
+
});
|
|
526
|
+
/**
|
|
527
|
+
* Начать подключение интеграции (amoCRM): адрес авторизации в amoCRM
|
|
528
|
+
*
|
|
529
|
+
* Подключение завершится, только когда этот же браузер пройдёт авторизацию в amoCRM под администратором аккаунта из запроса, а администратор amoCRM подтвердит организацию в виджете. Адрес действует 10 минут и срабатывает один раз.
|
|
530
|
+
*
|
|
531
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
532
|
+
*
|
|
533
|
+
* @deprecated
|
|
534
|
+
*/
|
|
535
|
+
export const approveConnectorLinkRequest = (options) => (options.client ?? client).post({
|
|
536
|
+
security: [{
|
|
537
|
+
in: 'cookie',
|
|
538
|
+
name: '__Secure-better-auth.session_token',
|
|
539
|
+
type: 'apiKey'
|
|
540
|
+
}],
|
|
541
|
+
url: '/v1/connector_links/requests/{id}/approve',
|
|
542
|
+
...options
|
|
543
|
+
});
|
|
544
|
+
/**
|
|
545
|
+
* Отклонить запрос на подключение интеграции (amoCRM)
|
|
546
|
+
*
|
|
547
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
548
|
+
*
|
|
549
|
+
* @deprecated
|
|
550
|
+
*/
|
|
551
|
+
export const rejectConnectorLinkRequest = (options) => (options.client ?? client).post({
|
|
552
|
+
security: [{
|
|
553
|
+
in: 'cookie',
|
|
554
|
+
name: '__Secure-better-auth.session_token',
|
|
555
|
+
type: 'apiKey'
|
|
556
|
+
}],
|
|
557
|
+
url: '/v1/connector_links/requests/{id}/reject',
|
|
558
|
+
...options
|
|
559
|
+
});
|
|
560
|
+
/**
|
|
561
|
+
* Адреса для приёма документов по почте
|
|
562
|
+
*
|
|
563
|
+
* Доступ: только сессия с ролью owner или admin или member.
|
|
564
|
+
*
|
|
565
|
+
* @deprecated
|
|
566
|
+
*/
|
|
567
|
+
export const listInboundMailboxes = (options) => (options?.client ?? client).get({
|
|
568
|
+
security: [{
|
|
569
|
+
in: 'cookie',
|
|
570
|
+
name: '__Secure-better-auth.session_token',
|
|
571
|
+
type: 'apiKey'
|
|
572
|
+
}],
|
|
573
|
+
url: '/v1/inbound_mailboxes',
|
|
574
|
+
...options
|
|
575
|
+
});
|
|
576
|
+
/**
|
|
577
|
+
* Создать адрес для приёма документов по почте
|
|
578
|
+
*
|
|
579
|
+
* Не больше 20 адресов на организацию (409). Только владелец или администратор.
|
|
580
|
+
*
|
|
581
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
582
|
+
*
|
|
583
|
+
* @deprecated
|
|
584
|
+
*/
|
|
585
|
+
export const createInboundMailbox = (options) => (options.client ?? client).post({
|
|
586
|
+
security: [{
|
|
587
|
+
in: 'cookie',
|
|
588
|
+
name: '__Secure-better-auth.session_token',
|
|
589
|
+
type: 'apiKey'
|
|
590
|
+
}],
|
|
591
|
+
url: '/v1/inbound_mailboxes',
|
|
592
|
+
...options,
|
|
593
|
+
headers: {
|
|
594
|
+
'Content-Type': 'application/json',
|
|
595
|
+
...options.headers
|
|
596
|
+
}
|
|
597
|
+
});
|
|
598
|
+
/**
|
|
599
|
+
* Удалить адрес
|
|
600
|
+
*
|
|
601
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
602
|
+
*
|
|
603
|
+
* @deprecated
|
|
604
|
+
*/
|
|
605
|
+
export const deleteInboundMailbox = (options) => (options.client ?? client).delete({
|
|
606
|
+
security: [{
|
|
607
|
+
in: 'cookie',
|
|
608
|
+
name: '__Secure-better-auth.session_token',
|
|
609
|
+
type: 'apiKey'
|
|
610
|
+
}],
|
|
611
|
+
url: '/v1/inbound_mailboxes/{id}',
|
|
612
|
+
...options
|
|
613
|
+
});
|
|
614
|
+
/**
|
|
615
|
+
* Изменить настройки адреса
|
|
616
|
+
*
|
|
617
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
618
|
+
*
|
|
619
|
+
* @deprecated
|
|
620
|
+
*/
|
|
621
|
+
export const updateInboundMailbox = (options) => (options.client ?? client).patch({
|
|
622
|
+
security: [{
|
|
623
|
+
in: 'cookie',
|
|
624
|
+
name: '__Secure-better-auth.session_token',
|
|
625
|
+
type: 'apiKey'
|
|
626
|
+
}],
|
|
627
|
+
url: '/v1/inbound_mailboxes/{id}',
|
|
628
|
+
...options,
|
|
629
|
+
headers: {
|
|
630
|
+
'Content-Type': 'application/json',
|
|
631
|
+
...options.headers
|
|
632
|
+
}
|
|
633
|
+
});
|
|
634
|
+
/**
|
|
635
|
+
* Сменить адрес: старый перестаёт принимать письма сразу
|
|
636
|
+
*
|
|
637
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
638
|
+
*
|
|
639
|
+
* @deprecated
|
|
640
|
+
*/
|
|
641
|
+
export const rotateInboundMailbox = (options) => (options.client ?? client).post({
|
|
642
|
+
security: [{
|
|
643
|
+
in: 'cookie',
|
|
644
|
+
name: '__Secure-better-auth.session_token',
|
|
645
|
+
type: 'apiKey'
|
|
646
|
+
}],
|
|
647
|
+
url: '/v1/inbound_mailboxes/{id}/rotate',
|
|
648
|
+
...options
|
|
649
|
+
});
|
|
650
|
+
/**
|
|
651
|
+
* Журнал писем адреса за 30 дней, новые первыми
|
|
652
|
+
*
|
|
653
|
+
* Только служебные сведения: время, отправитель, итог, число документов. Ни текста, ни темы, ни вложений.
|
|
654
|
+
*
|
|
655
|
+
* Доступ: только сессия с ролью owner или admin или member.
|
|
656
|
+
*
|
|
657
|
+
* @deprecated
|
|
658
|
+
*/
|
|
659
|
+
export const listInboundMessages = (options) => (options.client ?? client).get({
|
|
660
|
+
security: [{
|
|
661
|
+
in: 'cookie',
|
|
662
|
+
name: '__Secure-better-auth.session_token',
|
|
663
|
+
type: 'apiKey'
|
|
664
|
+
}],
|
|
665
|
+
url: '/v1/inbound_mailboxes/{id}/messages',
|
|
666
|
+
...options
|
|
667
|
+
});
|
|
404
668
|
/**
|
|
405
669
|
* Удалить организацию
|
|
406
670
|
*
|
|
@@ -413,6 +677,8 @@ export const deleteApiKey = (options) => (options.client ?? client).delete({
|
|
|
413
677
|
* она удаляется вместе с аккаунтом (DELETE /v1/me).
|
|
414
678
|
*
|
|
415
679
|
* Доступ: только сессия с ролью owner.
|
|
680
|
+
*
|
|
681
|
+
* @deprecated
|
|
416
682
|
*/
|
|
417
683
|
export const deleteOrganization = (options) => (options?.client ?? client).delete({
|
|
418
684
|
security: [{
|
|
@@ -441,6 +707,8 @@ export const getOrganization = (options) => (options?.client ?? client).get({
|
|
|
441
707
|
* Изменить сроки хранения
|
|
442
708
|
*
|
|
443
709
|
* Доступ: только сессия с ролью owner или admin.
|
|
710
|
+
*
|
|
711
|
+
* @deprecated
|
|
444
712
|
*/
|
|
445
713
|
export const updateOrganization = (options) => (options.client ?? client).patch({
|
|
446
714
|
security: [{
|
|
@@ -609,7 +877,7 @@ export const getTypizer = (options) => (options.client ?? client).get({
|
|
|
609
877
|
/**
|
|
610
878
|
* Изменить типизатор
|
|
611
879
|
*
|
|
612
|
-
* Версии неизменяемы: изменённые schema или instructions создают новую версию, и она становится текущей. Перестановка поля внутри properties — это изменение (порядок полей — порядок результата); перестановка ключевого слова внутри поля — нет. Остальные поля меняются на месте.
|
|
880
|
+
* Версии неизменяемы: изменённые schema или instructions создают новую версию, и она становится текущей. Перестановка поля внутри properties — это изменение (порядок полей — порядок результата); перестановка ключевого слова внутри поля — нет. Остальные поля меняются на месте. Изменение схемы или инструкций добавленной из каталога схемы (catalog_source.relation: installed) делает типизатор вашей копией (forked): новые версии источника будут предлагаться, а не применяться.
|
|
613
881
|
*
|
|
614
882
|
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
615
883
|
*/
|
|
@@ -670,6 +938,308 @@ export const getTypizerXsd = (options) => (options.client ?? client).get({
|
|
|
670
938
|
url: '/v1/typizers/{id}/xsd',
|
|
671
939
|
...options
|
|
672
940
|
});
|
|
941
|
+
/**
|
|
942
|
+
* Профиль автора вашей организации
|
|
943
|
+
*
|
|
944
|
+
* Только сессия Кабинета. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. 404, пока профиль не создан.
|
|
945
|
+
*
|
|
946
|
+
* Доступ: только сессия.
|
|
947
|
+
*
|
|
948
|
+
* @deprecated
|
|
949
|
+
*/
|
|
950
|
+
export const getOwnCatalogPublisher = (options) => (options?.client ?? client).get({
|
|
951
|
+
security: [{
|
|
952
|
+
in: 'cookie',
|
|
953
|
+
name: '__Secure-better-auth.session_token',
|
|
954
|
+
type: 'apiKey'
|
|
955
|
+
}],
|
|
956
|
+
url: '/v1/catalog/publisher',
|
|
957
|
+
...options
|
|
958
|
+
});
|
|
959
|
+
/**
|
|
960
|
+
* Создать или изменить профиль автора
|
|
961
|
+
*
|
|
962
|
+
* Только сессия владельца или администратора организации. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Занятый или зарезервированный slug, смена slug после первой публикации — 409 с param: slug. Почту, телефоны и другие персональные данные в имени и описании не принимаем (400 с findings).
|
|
963
|
+
*
|
|
964
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
965
|
+
*
|
|
966
|
+
* @deprecated
|
|
967
|
+
*/
|
|
968
|
+
export const upsertOwnCatalogPublisher = (options) => (options.client ?? client).put({
|
|
969
|
+
security: [{
|
|
970
|
+
in: 'cookie',
|
|
971
|
+
name: '__Secure-better-auth.session_token',
|
|
972
|
+
type: 'apiKey'
|
|
973
|
+
}],
|
|
974
|
+
url: '/v1/catalog/publisher',
|
|
975
|
+
...options,
|
|
976
|
+
headers: {
|
|
977
|
+
'Content-Type': 'application/json',
|
|
978
|
+
...options.headers
|
|
979
|
+
}
|
|
980
|
+
});
|
|
981
|
+
/**
|
|
982
|
+
* Схемы, опубликованные вашей организацией
|
|
983
|
+
*
|
|
984
|
+
* Только сессия Кабинета. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Включая приватные, на проверке и отклонённые; новые первыми.
|
|
985
|
+
*
|
|
986
|
+
* Доступ: только сессия.
|
|
987
|
+
*
|
|
988
|
+
* @deprecated
|
|
989
|
+
*/
|
|
990
|
+
export const listOwnCatalogEntries = (options) => (options?.client ?? client).get({
|
|
991
|
+
security: [{
|
|
992
|
+
in: 'cookie',
|
|
993
|
+
name: '__Secure-better-auth.session_token',
|
|
994
|
+
type: 'apiKey'
|
|
995
|
+
}],
|
|
996
|
+
url: '/v1/catalog/mine',
|
|
997
|
+
...options
|
|
998
|
+
});
|
|
999
|
+
/**
|
|
1000
|
+
* Профиль автора и его схемы
|
|
1001
|
+
*
|
|
1002
|
+
* Автор typizer — официальные схемы. Остальные авторы: Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404.
|
|
1003
|
+
*
|
|
1004
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1005
|
+
*/
|
|
1006
|
+
export const getCatalogPublisher = (options) => (options.client ?? client).get({
|
|
1007
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1008
|
+
in: 'cookie',
|
|
1009
|
+
name: '__Secure-better-auth.session_token',
|
|
1010
|
+
type: 'apiKey'
|
|
1011
|
+
}],
|
|
1012
|
+
url: '/v1/catalog/publishers/{slug}',
|
|
1013
|
+
...options
|
|
1014
|
+
});
|
|
1015
|
+
/**
|
|
1016
|
+
* Каталог готовых схем
|
|
1017
|
+
*
|
|
1018
|
+
* Официальные схемы Typizer и опубликованные организациями (когда они доступны вашей организации). Схемы «по ссылке» в список не попадают. Порядок может немного сдвинуться между страницами при пересчёте популярности (раз в час).
|
|
1019
|
+
*
|
|
1020
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1021
|
+
*/
|
|
1022
|
+
export const listCatalog = (options) => (options?.client ?? client).get({
|
|
1023
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1024
|
+
in: 'cookie',
|
|
1025
|
+
name: '__Secure-better-auth.session_token',
|
|
1026
|
+
type: 'apiKey'
|
|
1027
|
+
}],
|
|
1028
|
+
url: '/v1/catalog',
|
|
1029
|
+
...options
|
|
1030
|
+
});
|
|
1031
|
+
/**
|
|
1032
|
+
* Добавить схему к себе
|
|
1033
|
+
*
|
|
1034
|
+
* Создаёт типизатор из версии схемы (по умолчанию — последней). Повторный вызов для того же мажора возвращает уже добавленный типизатор с кодом 200. У официальных схем минорные версии приходят сами, о новом мажоре сообщит catalog_source.update. Схемы сообщества сами не меняются: новая версия предлагается в catalog_source.update и применяется через catalog_update. Поддерживает Idempotency-Key.
|
|
1035
|
+
*
|
|
1036
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1037
|
+
*/
|
|
1038
|
+
export const installCatalogEntry = (options) => (options.client ?? client).post({
|
|
1039
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1040
|
+
in: 'cookie',
|
|
1041
|
+
name: '__Secure-better-auth.session_token',
|
|
1042
|
+
type: 'apiKey'
|
|
1043
|
+
}],
|
|
1044
|
+
url: '/v1/catalog/{entry}/install',
|
|
1045
|
+
...options,
|
|
1046
|
+
headers: {
|
|
1047
|
+
'Content-Type': 'application/json',
|
|
1048
|
+
...options.headers
|
|
1049
|
+
}
|
|
1050
|
+
});
|
|
1051
|
+
/**
|
|
1052
|
+
* Создать типизатор на основе схемы
|
|
1053
|
+
*
|
|
1054
|
+
* Всегда создаёт новый типизатор — вашу копию схемы, которую можно менять. Новые версии источника предлагаются в catalog_source.update. Поддерживает Idempotency-Key.
|
|
1055
|
+
*
|
|
1056
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1057
|
+
*/
|
|
1058
|
+
export const forkCatalogEntry = (options) => (options.client ?? client).post({
|
|
1059
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1060
|
+
in: 'cookie',
|
|
1061
|
+
name: '__Secure-better-auth.session_token',
|
|
1062
|
+
type: 'apiKey'
|
|
1063
|
+
}],
|
|
1064
|
+
url: '/v1/catalog/{entry}/fork',
|
|
1065
|
+
...options,
|
|
1066
|
+
headers: {
|
|
1067
|
+
'Content-Type': 'application/json',
|
|
1068
|
+
...options.headers
|
|
1069
|
+
}
|
|
1070
|
+
});
|
|
1071
|
+
/**
|
|
1072
|
+
* Убрать из избранного
|
|
1073
|
+
*
|
|
1074
|
+
* Избранное общее для организации. Повторный вызов ничего не меняет.
|
|
1075
|
+
*
|
|
1076
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1077
|
+
*/
|
|
1078
|
+
export const unfavoriteCatalogEntry = (options) => (options.client ?? client).delete({
|
|
1079
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1080
|
+
in: 'cookie',
|
|
1081
|
+
name: '__Secure-better-auth.session_token',
|
|
1082
|
+
type: 'apiKey'
|
|
1083
|
+
}],
|
|
1084
|
+
url: '/v1/catalog/{entry}/favorite',
|
|
1085
|
+
...options
|
|
1086
|
+
});
|
|
1087
|
+
/**
|
|
1088
|
+
* Добавить в избранное
|
|
1089
|
+
*
|
|
1090
|
+
* Избранное общее для организации. Повторный вызов ничего не меняет.
|
|
1091
|
+
*
|
|
1092
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1093
|
+
*/
|
|
1094
|
+
export const favoriteCatalogEntry = (options) => (options.client ?? client).put({
|
|
1095
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1096
|
+
in: 'cookie',
|
|
1097
|
+
name: '__Secure-better-auth.session_token',
|
|
1098
|
+
type: 'apiKey'
|
|
1099
|
+
}],
|
|
1100
|
+
url: '/v1/catalog/{entry}/favorite',
|
|
1101
|
+
...options
|
|
1102
|
+
});
|
|
1103
|
+
/**
|
|
1104
|
+
* Версии схемы, новые первыми
|
|
1105
|
+
*
|
|
1106
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1107
|
+
*/
|
|
1108
|
+
export const listCatalogVersions = (options) => (options.client ?? client).get({
|
|
1109
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1110
|
+
in: 'cookie',
|
|
1111
|
+
name: '__Secure-better-auth.session_token',
|
|
1112
|
+
type: 'apiKey'
|
|
1113
|
+
}],
|
|
1114
|
+
url: '/v1/catalog/{entry}/versions',
|
|
1115
|
+
...options
|
|
1116
|
+
});
|
|
1117
|
+
/**
|
|
1118
|
+
* Пожаловаться на схему
|
|
1119
|
+
*
|
|
1120
|
+
* Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Одна открытая жалоба от организации на схему (повтор — 409).
|
|
1121
|
+
*
|
|
1122
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1123
|
+
*/
|
|
1124
|
+
export const reportCatalogEntry = (options) => (options.client ?? client).post({
|
|
1125
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1126
|
+
in: 'cookie',
|
|
1127
|
+
name: '__Secure-better-auth.session_token',
|
|
1128
|
+
type: 'apiKey'
|
|
1129
|
+
}],
|
|
1130
|
+
url: '/v1/catalog/{entry}/reports',
|
|
1131
|
+
...options,
|
|
1132
|
+
headers: {
|
|
1133
|
+
'Content-Type': 'application/json',
|
|
1134
|
+
...options.headers
|
|
1135
|
+
}
|
|
1136
|
+
});
|
|
1137
|
+
/**
|
|
1138
|
+
* Снять свою схему с публикации
|
|
1139
|
+
*
|
|
1140
|
+
* Только сессия владельца или администратора организации. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Уже добавленные другими организациями типизаторы продолжают работать.
|
|
1141
|
+
*
|
|
1142
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
1143
|
+
*
|
|
1144
|
+
* @deprecated
|
|
1145
|
+
*/
|
|
1146
|
+
export const unpublishCatalogEntry = (options) => (options.client ?? client).post({
|
|
1147
|
+
security: [{
|
|
1148
|
+
in: 'cookie',
|
|
1149
|
+
name: '__Secure-better-auth.session_token',
|
|
1150
|
+
type: 'apiKey'
|
|
1151
|
+
}],
|
|
1152
|
+
url: '/v1/catalog/{entry}/unpublish',
|
|
1153
|
+
...options
|
|
1154
|
+
});
|
|
1155
|
+
/**
|
|
1156
|
+
* Схема каталога
|
|
1157
|
+
*
|
|
1158
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1159
|
+
*/
|
|
1160
|
+
export const getCatalogEntry = (options) => (options.client ?? client).get({
|
|
1161
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1162
|
+
in: 'cookie',
|
|
1163
|
+
name: '__Secure-better-auth.session_token',
|
|
1164
|
+
type: 'apiKey'
|
|
1165
|
+
}],
|
|
1166
|
+
url: '/v1/catalog/{entry}',
|
|
1167
|
+
...options
|
|
1168
|
+
});
|
|
1169
|
+
/**
|
|
1170
|
+
* Схема сообщества по адресу автора
|
|
1171
|
+
*
|
|
1172
|
+
* Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404.
|
|
1173
|
+
*
|
|
1174
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1175
|
+
*/
|
|
1176
|
+
export const getCommunityCatalogEntry = (options) => (options.client ?? client).get({
|
|
1177
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1178
|
+
in: 'cookie',
|
|
1179
|
+
name: '__Secure-better-auth.session_token',
|
|
1180
|
+
type: 'apiKey'
|
|
1181
|
+
}],
|
|
1182
|
+
url: '/v1/catalog/{publisher}/{slug}',
|
|
1183
|
+
...options
|
|
1184
|
+
});
|
|
1185
|
+
/**
|
|
1186
|
+
* Опубликовать типизатор в каталоге
|
|
1187
|
+
*
|
|
1188
|
+
* Только сессия владельца или администратора организации. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Публикуется только структура: схема без examples и default, инструкции и описание. Прогоны, файлы и результаты не публикуются никогда. Первая публикация создаёт схему (201), следующие — новую версию (200); номер версии считается по изменениям. Если в схеме или описании найдены персональные данные — 400 invalid_request с findings: путь и вид каждой находки (inn, snils, ogrn, passport_rf, phone, email, bank_card, bank_account, suspicious_chars — невидимые или неизвестные символы), без самих значений. Без профиля автора — 409 с param: publisher. Поддерживает Idempotency-Key.
|
|
1189
|
+
*
|
|
1190
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
1191
|
+
*
|
|
1192
|
+
* @deprecated
|
|
1193
|
+
*/
|
|
1194
|
+
export const publishTypizer = (options) => (options.client ?? client).post({
|
|
1195
|
+
security: [{
|
|
1196
|
+
in: 'cookie',
|
|
1197
|
+
name: '__Secure-better-auth.session_token',
|
|
1198
|
+
type: 'apiKey'
|
|
1199
|
+
}],
|
|
1200
|
+
url: '/v1/typizers/{id}/publish',
|
|
1201
|
+
...options,
|
|
1202
|
+
headers: {
|
|
1203
|
+
'Content-Type': 'application/json',
|
|
1204
|
+
...options.headers
|
|
1205
|
+
}
|
|
1206
|
+
});
|
|
1207
|
+
/**
|
|
1208
|
+
* Что изменится при обновлении из каталога
|
|
1209
|
+
*
|
|
1210
|
+
* Изменения схемы от версии типизатора до version (по умолчанию — новейшей доступной) и список изменений источника. conflict — вы тоже меняли это поле. Нет обновления — 409.
|
|
1211
|
+
*
|
|
1212
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1213
|
+
*/
|
|
1214
|
+
export const getTypizerCatalogUpdate = (options) => (options.client ?? client).get({
|
|
1215
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1216
|
+
in: 'cookie',
|
|
1217
|
+
name: '__Secure-better-auth.session_token',
|
|
1218
|
+
type: 'apiKey'
|
|
1219
|
+
}],
|
|
1220
|
+
url: '/v1/typizers/{id}/catalog_update',
|
|
1221
|
+
...options
|
|
1222
|
+
});
|
|
1223
|
+
/**
|
|
1224
|
+
* Обновить типизатор из каталога
|
|
1225
|
+
*
|
|
1226
|
+
* Добавленная схема (installed) переходит на версию version целиком (paths не передаются). Типизатор на основе схемы (forked) подтягивает только выбранные paths. Создаёт новую версию типизатора. Поддерживает Idempotency-Key.
|
|
1227
|
+
*
|
|
1228
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1229
|
+
*/
|
|
1230
|
+
export const applyTypizerCatalogUpdate = (options) => (options.client ?? client).post({
|
|
1231
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1232
|
+
in: 'cookie',
|
|
1233
|
+
name: '__Secure-better-auth.session_token',
|
|
1234
|
+
type: 'apiKey'
|
|
1235
|
+
}],
|
|
1236
|
+
url: '/v1/typizers/{id}/catalog_update',
|
|
1237
|
+
...options,
|
|
1238
|
+
headers: {
|
|
1239
|
+
'Content-Type': 'application/json',
|
|
1240
|
+
...options.headers
|
|
1241
|
+
}
|
|
1242
|
+
});
|
|
673
1243
|
/**
|
|
674
1244
|
* Запустить типизатор на документе
|
|
675
1245
|
*
|
|
@@ -821,9 +1391,9 @@ export const exportBatch = (options) => (options.client ?? client).get({
|
|
|
821
1391
|
...options
|
|
822
1392
|
});
|
|
823
1393
|
/**
|
|
824
|
-
* Извлечь данные по разовой схеме
|
|
1394
|
+
* Извлечь данные по разовой схеме или схеме из каталога
|
|
825
1395
|
*
|
|
826
|
-
* Прогон
|
|
1396
|
+
* Прогон без сохранения типизатора (typizer_id равен null): по разовой схеме (schema, правила как у типизатора, см. POST /v1/typizers) или по схеме из каталога (catalog, например schet-faktura@1; какая версия использована — в run.catalog). Передайте ровно одно из schema и catalog. Передайте документ ровно одним способом: частью multipart file, полем file_id или url. Тело — JSON или multipart с остальными полями в виде текста (metadata — объект JSON). Страницы резервируются на балансе при создании прогона (402 insufficient_balance, если их не хватает) и списываются при его завершении. Загрузки: не больше 2 одновременно на организацию (429), всё тело за 120 с без пауз дольше 15 с (408). Не больше 20 новых прогонов в секунду на ключ API или пользователя (429; много документов — через пакеты). Поддерживает Idempotency-Key.
|
|
827
1397
|
*
|
|
828
1398
|
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
829
1399
|
*/
|
|
@@ -1006,6 +1576,8 @@ export const getUsage = (options) => (options?.client ?? client).get({
|
|
|
1006
1576
|
* Только сессия (любая роль); диалог виден пользователю, который его начал.
|
|
1007
1577
|
*
|
|
1008
1578
|
* Доступ: только сессия.
|
|
1579
|
+
*
|
|
1580
|
+
* @deprecated
|
|
1009
1581
|
*/
|
|
1010
1582
|
export const listAgentThreads = (options) => (options?.client ?? client).get({
|
|
1011
1583
|
security: [{
|
|
@@ -1022,6 +1594,8 @@ export const listAgentThreads = (options) => (options?.client ?? client).get({
|
|
|
1022
1594
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Поддерживает Idempotency-Key.
|
|
1023
1595
|
*
|
|
1024
1596
|
* Доступ: только сессия.
|
|
1597
|
+
*
|
|
1598
|
+
* @deprecated
|
|
1025
1599
|
*/
|
|
1026
1600
|
export const createAgentThread = (options) => (options?.client ?? client).post({
|
|
1027
1601
|
security: [{
|
|
@@ -1042,6 +1616,8 @@ export const createAgentThread = (options) => (options?.client ?? client).post({
|
|
|
1042
1616
|
* Только сессия (любая роль); диалог виден пользователю, который его начал.
|
|
1043
1617
|
*
|
|
1044
1618
|
* Доступ: только сессия.
|
|
1619
|
+
*
|
|
1620
|
+
* @deprecated
|
|
1045
1621
|
*/
|
|
1046
1622
|
export const getAgentThread = (options) => (options.client ?? client).get({
|
|
1047
1623
|
security: [{
|
|
@@ -1058,6 +1634,8 @@ export const getAgentThread = (options) => (options.client ?? client).get({
|
|
|
1058
1634
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. draft_schema проверяется как схема типизатора (param — это draft_schema# и указатель).
|
|
1059
1635
|
*
|
|
1060
1636
|
* Доступ: только сессия.
|
|
1637
|
+
*
|
|
1638
|
+
* @deprecated
|
|
1061
1639
|
*/
|
|
1062
1640
|
export const updateAgentThread = (options) => (options.client ?? client).patch({
|
|
1063
1641
|
security: [{
|
|
@@ -1078,6 +1656,8 @@ export const updateAgentThread = (options) => (options.client ?? client).patch({
|
|
|
1078
1656
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Запускает черновик схемы на образце диалога (source agent); страницы не резервируются и не списываются. Расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве; сверх квоты 429 с Retry-After). 409 conflict без черновика или образца; 400 too_many_pages для образца больше 10 страниц. Отвечает так же, как создание прогона. Поддерживает Idempotency-Key.
|
|
1079
1657
|
*
|
|
1080
1658
|
* Доступ: только сессия.
|
|
1659
|
+
*
|
|
1660
|
+
* @deprecated
|
|
1081
1661
|
*/
|
|
1082
1662
|
export const createAgentSampleRun = (options) => (options.client ?? client).post({
|
|
1083
1663
|
security: [{
|
|
@@ -1094,6 +1674,8 @@ export const createAgentSampleRun = (options) => (options.client ?? client).post
|
|
|
1094
1674
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Диалог, связанный с типизатором, сохраняет его новую версию (200); иначе — если диалог ни разу не сохранялся или его типизатор с тех пор архивирован — создаётся новый типизатор (201), и диалог связывается с ним. 409 conflict без черновика. Поддерживает Idempotency-Key.
|
|
1095
1675
|
*
|
|
1096
1676
|
* Доступ: только сессия.
|
|
1677
|
+
*
|
|
1678
|
+
* @deprecated
|
|
1097
1679
|
*/
|
|
1098
1680
|
export const saveAgentThread = (options) => (options.client ?? client).post({
|
|
1099
1681
|
security: [{
|
|
@@ -1114,6 +1696,8 @@ export const saveAgentThread = (options) => (options.client ?? client).post({
|
|
|
1114
1696
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве; сверх квоты 429 с Retry-After до открытия потока). Стоимость модели ассистента также ограничена на пользователя и на организацию за сутки по Москве: когда лимит исчерпан, 429 до открытия потока или событие error с 429, завершающее текущий ход. Одно сообщение за раз в диалоге: 409 conflict, пока ассистент отвечает на предыдущее. Ответ — text/event-stream с событиями message_start, text_delta, tool_call, tool_result, schema_updated, sample_run, ask_user, error (ошибка в формате problem) и последним message_end (stop_reason: end_turn, ask_user, max_steps или aborted); комментарий : ping каждые 15 с. Ход длится не больше 300 с. Idempotency-Key принимается и игнорируется.
|
|
1115
1697
|
*
|
|
1116
1698
|
* Доступ: только сессия.
|
|
1699
|
+
*
|
|
1700
|
+
* @deprecated
|
|
1117
1701
|
*/
|
|
1118
1702
|
export const createAgentMessage = (options) => (options.client ?? client).sse.post({
|
|
1119
1703
|
security: [{
|