typizer 0.1.0 → 0.3.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 +76 -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 +509 -5
- package/dist/gen/sdk.gen.js +893 -4
- package/dist/gen/types.gen.d.ts +4279 -913
- 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 +50 -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 +3 -1
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,146 @@ 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
|
+
});
|
|
349
|
+
/**
|
|
350
|
+
* Виджет поддержки: включён ли
|
|
351
|
+
*
|
|
352
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer.
|
|
353
|
+
*
|
|
354
|
+
* Доступ: публичный, без учётных данных.
|
|
355
|
+
*
|
|
356
|
+
* @deprecated
|
|
357
|
+
*/
|
|
358
|
+
export const getSupportWidgetConfig = (options) => (options?.client ?? client).get({ url: '/v1/support/widget/config', ...options });
|
|
359
|
+
/**
|
|
360
|
+
* Задача proof-of-work для нового посетителя
|
|
361
|
+
*
|
|
362
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer. Найдите nonce, чтобы sha256(challenge + ':' + nonce) начинался с difficulty нулевых бит.
|
|
363
|
+
*
|
|
364
|
+
* Доступ: публичный, без учётных данных.
|
|
365
|
+
*
|
|
366
|
+
* @deprecated
|
|
367
|
+
*/
|
|
368
|
+
export const createSupportWidgetChallenge = (options) => (options?.client ?? client).post({ url: '/v1/support/widget/challenge', ...options });
|
|
369
|
+
/**
|
|
370
|
+
* Новый анонимный посетитель (после proof-of-work)
|
|
371
|
+
*
|
|
372
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer. Каждая задача — один раз.
|
|
373
|
+
*
|
|
374
|
+
* Доступ: публичный, без учётных данных.
|
|
375
|
+
*
|
|
376
|
+
* @deprecated
|
|
377
|
+
*/
|
|
378
|
+
export const createSupportWidgetVisitor = (options) => (options.client ?? client).post({
|
|
379
|
+
url: '/v1/support/widget/visitors',
|
|
380
|
+
...options,
|
|
381
|
+
headers: {
|
|
382
|
+
'Content-Type': 'application/json',
|
|
383
|
+
...options.headers
|
|
384
|
+
}
|
|
385
|
+
});
|
|
386
|
+
/**
|
|
387
|
+
* Текущая переписка виджета
|
|
388
|
+
*
|
|
389
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer. Без переписки conversation равно null. Отмечает ответы просмотренными.
|
|
390
|
+
*
|
|
391
|
+
* Доступ: публичный, без учётных данных.
|
|
392
|
+
*
|
|
393
|
+
* @deprecated
|
|
394
|
+
*/
|
|
395
|
+
export const getSupportWidgetState = (options) => (options?.client ?? client).get({ url: '/v1/support/widget/messages', ...options });
|
|
396
|
+
/**
|
|
397
|
+
* Написать в поддержку из виджета
|
|
398
|
+
*
|
|
399
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer. Сразу возвращает ссылки на документацию (suggestions, без ИИ); ответ ИИ-помощника приходит в поток или при опросе. Idempotency-Key игнорируется.
|
|
400
|
+
*
|
|
401
|
+
* Доступ: публичный, без учётных данных.
|
|
402
|
+
*
|
|
403
|
+
* @deprecated
|
|
404
|
+
*/
|
|
405
|
+
export const createSupportWidgetMessage = (options) => (options.client ?? client).post({
|
|
406
|
+
url: '/v1/support/widget/messages',
|
|
407
|
+
...options,
|
|
408
|
+
headers: {
|
|
409
|
+
'Content-Type': 'application/json',
|
|
410
|
+
...options.headers
|
|
411
|
+
}
|
|
412
|
+
});
|
|
413
|
+
/**
|
|
414
|
+
* Новые ответы потоком server-sent events
|
|
415
|
+
*
|
|
416
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer. События message (support_message) и conversation (без сообщений), комментарий ping каждые 15 с; поток живёт до 120 с. Перегрузка — 503: опрашивайте GET …/messages.
|
|
417
|
+
*
|
|
418
|
+
* Доступ: публичный, без учётных данных.
|
|
419
|
+
*
|
|
420
|
+
* @deprecated
|
|
421
|
+
*/
|
|
422
|
+
export const streamSupportWidget = (options) => (options?.client ?? client).sse.get({ url: '/v1/support/widget/stream', ...options });
|
|
423
|
+
/**
|
|
424
|
+
* Оставить email: прислать код подтверждения
|
|
425
|
+
*
|
|
426
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer. Только анонимному посетителю. Код из 6 цифр на 10 минут.
|
|
427
|
+
*
|
|
428
|
+
* Доступ: публичный, без учётных данных.
|
|
429
|
+
*
|
|
430
|
+
* @deprecated
|
|
431
|
+
*/
|
|
432
|
+
export const createSupportEmailCode = (options) => (options.client ?? client).post({
|
|
433
|
+
url: '/v1/support/widget/email',
|
|
434
|
+
...options,
|
|
435
|
+
headers: {
|
|
436
|
+
'Content-Type': 'application/json',
|
|
437
|
+
...options.headers
|
|
438
|
+
}
|
|
439
|
+
});
|
|
440
|
+
/**
|
|
441
|
+
* Подтвердить email кодом
|
|
442
|
+
*
|
|
443
|
+
* Виджет поддержки сайта (не для интеграций). Origin — только сайты Typizer. 400 — неверный код, 409 — код истёк или не запрошен, 429 — попытки кончились (5).
|
|
444
|
+
*
|
|
445
|
+
* Доступ: публичный, без учётных данных.
|
|
446
|
+
*
|
|
447
|
+
* @deprecated
|
|
448
|
+
*/
|
|
449
|
+
export const verifySupportEmail = (options) => (options.client ?? client).post({
|
|
450
|
+
url: '/v1/support/widget/email/verify',
|
|
451
|
+
...options,
|
|
452
|
+
headers: {
|
|
453
|
+
'Content-Type': 'application/json',
|
|
454
|
+
...options.headers
|
|
455
|
+
}
|
|
456
|
+
});
|
|
275
457
|
/**
|
|
276
458
|
* Текущие и предстоящие работы и сбои
|
|
277
459
|
*
|
|
@@ -301,6 +483,8 @@ export const getOpenApiDocument = (options) => (options?.client ?? client).get({
|
|
|
301
483
|
* 409 conflict: сначала передайте владение или удалите ту организацию.
|
|
302
484
|
*
|
|
303
485
|
* Доступ: только сессия.
|
|
486
|
+
*
|
|
487
|
+
* @deprecated
|
|
304
488
|
*/
|
|
305
489
|
export const deleteMe = (options) => (options?.client ?? client).delete({
|
|
306
490
|
security: [{
|
|
@@ -329,6 +513,8 @@ export const getMe = (options) => (options?.client ?? client).get({
|
|
|
329
513
|
* Журнал входов текущего пользователя
|
|
330
514
|
*
|
|
331
515
|
* Доступ: только сессия.
|
|
516
|
+
*
|
|
517
|
+
* @deprecated
|
|
332
518
|
*/
|
|
333
519
|
export const listSignIns = (options) => (options?.client ?? client).get({
|
|
334
520
|
security: [{
|
|
@@ -345,6 +531,8 @@ export const listSignIns = (options) => (options?.client ?? client).get({
|
|
|
345
531
|
* Только сессия: состояние согласия на маркетинговые рассылки по последнему решению текущего пользователя в журнале согласий (дать или отозвать его — POST /v1/consents). Без решений — granted равно false, version и updated_at равны null.
|
|
346
532
|
*
|
|
347
533
|
* Доступ: только сессия.
|
|
534
|
+
*
|
|
535
|
+
* @deprecated
|
|
348
536
|
*/
|
|
349
537
|
export const getMyConsents = (options) => (options?.client ?? client).get({
|
|
350
538
|
security: [{
|
|
@@ -359,6 +547,8 @@ export const getMyConsents = (options) => (options?.client ?? client).get({
|
|
|
359
547
|
* Активные ключи API организации
|
|
360
548
|
*
|
|
361
549
|
* Доступ: только сессия с ролью owner или admin.
|
|
550
|
+
*
|
|
551
|
+
* @deprecated
|
|
362
552
|
*/
|
|
363
553
|
export const listApiKeys = (options) => (options?.client ?? client).get({
|
|
364
554
|
security: [{
|
|
@@ -373,6 +563,8 @@ export const listApiKeys = (options) => (options?.client ?? client).get({
|
|
|
373
563
|
* Создать ключ API (ключ показывается один раз)
|
|
374
564
|
*
|
|
375
565
|
* Доступ: только сессия с ролью owner или admin.
|
|
566
|
+
*
|
|
567
|
+
* @deprecated
|
|
376
568
|
*/
|
|
377
569
|
export const createApiKey = (options) => (options.client ?? client).post({
|
|
378
570
|
security: [{
|
|
@@ -391,6 +583,8 @@ export const createApiKey = (options) => (options.client ?? client).post({
|
|
|
391
583
|
* Отозвать ключ API навсегда
|
|
392
584
|
*
|
|
393
585
|
* Доступ: только сессия с ролью owner или admin.
|
|
586
|
+
*
|
|
587
|
+
* @deprecated
|
|
394
588
|
*/
|
|
395
589
|
export const deleteApiKey = (options) => (options.client ?? client).delete({
|
|
396
590
|
security: [{
|
|
@@ -401,6 +595,184 @@ export const deleteApiKey = (options) => (options.client ?? client).delete({
|
|
|
401
595
|
url: '/v1/api_keys/{id}',
|
|
402
596
|
...options
|
|
403
597
|
});
|
|
598
|
+
/**
|
|
599
|
+
* Одноразовая ссылка для подключения бота в Telegram или MAX либо портала Битрикс24 к организации
|
|
600
|
+
*
|
|
601
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
602
|
+
*
|
|
603
|
+
* @deprecated
|
|
604
|
+
*/
|
|
605
|
+
export const createConnectorLink = (options) => (options.client ?? client).post({
|
|
606
|
+
security: [{
|
|
607
|
+
in: 'cookie',
|
|
608
|
+
name: '__Secure-better-auth.session_token',
|
|
609
|
+
type: 'apiKey'
|
|
610
|
+
}],
|
|
611
|
+
url: '/v1/connector_links',
|
|
612
|
+
...options,
|
|
613
|
+
headers: {
|
|
614
|
+
'Content-Type': 'application/json',
|
|
615
|
+
...options.headers
|
|
616
|
+
}
|
|
617
|
+
});
|
|
618
|
+
/**
|
|
619
|
+
* Запрос на подключение интеграции (amoCRM): какой аккаунт и кто его запросил
|
|
620
|
+
*
|
|
621
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
622
|
+
*
|
|
623
|
+
* @deprecated
|
|
624
|
+
*/
|
|
625
|
+
export const getConnectorLinkRequest = (options) => (options.client ?? client).get({
|
|
626
|
+
security: [{
|
|
627
|
+
in: 'cookie',
|
|
628
|
+
name: '__Secure-better-auth.session_token',
|
|
629
|
+
type: 'apiKey'
|
|
630
|
+
}],
|
|
631
|
+
url: '/v1/connector_links/requests/{id}',
|
|
632
|
+
...options
|
|
633
|
+
});
|
|
634
|
+
/**
|
|
635
|
+
* Начать подключение интеграции (amoCRM): адрес авторизации в amoCRM
|
|
636
|
+
*
|
|
637
|
+
* Подключение завершится, только когда этот же браузер пройдёт авторизацию в amoCRM под администратором аккаунта из запроса, а администратор amoCRM подтвердит организацию в виджете. Адрес действует 10 минут и срабатывает один раз.
|
|
638
|
+
*
|
|
639
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
640
|
+
*
|
|
641
|
+
* @deprecated
|
|
642
|
+
*/
|
|
643
|
+
export const approveConnectorLinkRequest = (options) => (options.client ?? client).post({
|
|
644
|
+
security: [{
|
|
645
|
+
in: 'cookie',
|
|
646
|
+
name: '__Secure-better-auth.session_token',
|
|
647
|
+
type: 'apiKey'
|
|
648
|
+
}],
|
|
649
|
+
url: '/v1/connector_links/requests/{id}/approve',
|
|
650
|
+
...options
|
|
651
|
+
});
|
|
652
|
+
/**
|
|
653
|
+
* Отклонить запрос на подключение интеграции (amoCRM)
|
|
654
|
+
*
|
|
655
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
656
|
+
*
|
|
657
|
+
* @deprecated
|
|
658
|
+
*/
|
|
659
|
+
export const rejectConnectorLinkRequest = (options) => (options.client ?? client).post({
|
|
660
|
+
security: [{
|
|
661
|
+
in: 'cookie',
|
|
662
|
+
name: '__Secure-better-auth.session_token',
|
|
663
|
+
type: 'apiKey'
|
|
664
|
+
}],
|
|
665
|
+
url: '/v1/connector_links/requests/{id}/reject',
|
|
666
|
+
...options
|
|
667
|
+
});
|
|
668
|
+
/**
|
|
669
|
+
* Адреса для приёма документов по почте
|
|
670
|
+
*
|
|
671
|
+
* Доступ: только сессия с ролью owner или admin или member.
|
|
672
|
+
*
|
|
673
|
+
* @deprecated
|
|
674
|
+
*/
|
|
675
|
+
export const listInboundMailboxes = (options) => (options?.client ?? client).get({
|
|
676
|
+
security: [{
|
|
677
|
+
in: 'cookie',
|
|
678
|
+
name: '__Secure-better-auth.session_token',
|
|
679
|
+
type: 'apiKey'
|
|
680
|
+
}],
|
|
681
|
+
url: '/v1/inbound_mailboxes',
|
|
682
|
+
...options
|
|
683
|
+
});
|
|
684
|
+
/**
|
|
685
|
+
* Создать адрес для приёма документов по почте
|
|
686
|
+
*
|
|
687
|
+
* Не больше 20 адресов на организацию (409). Только владелец или администратор.
|
|
688
|
+
*
|
|
689
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
690
|
+
*
|
|
691
|
+
* @deprecated
|
|
692
|
+
*/
|
|
693
|
+
export const createInboundMailbox = (options) => (options.client ?? client).post({
|
|
694
|
+
security: [{
|
|
695
|
+
in: 'cookie',
|
|
696
|
+
name: '__Secure-better-auth.session_token',
|
|
697
|
+
type: 'apiKey'
|
|
698
|
+
}],
|
|
699
|
+
url: '/v1/inbound_mailboxes',
|
|
700
|
+
...options,
|
|
701
|
+
headers: {
|
|
702
|
+
'Content-Type': 'application/json',
|
|
703
|
+
...options.headers
|
|
704
|
+
}
|
|
705
|
+
});
|
|
706
|
+
/**
|
|
707
|
+
* Удалить адрес
|
|
708
|
+
*
|
|
709
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
710
|
+
*
|
|
711
|
+
* @deprecated
|
|
712
|
+
*/
|
|
713
|
+
export const deleteInboundMailbox = (options) => (options.client ?? client).delete({
|
|
714
|
+
security: [{
|
|
715
|
+
in: 'cookie',
|
|
716
|
+
name: '__Secure-better-auth.session_token',
|
|
717
|
+
type: 'apiKey'
|
|
718
|
+
}],
|
|
719
|
+
url: '/v1/inbound_mailboxes/{id}',
|
|
720
|
+
...options
|
|
721
|
+
});
|
|
722
|
+
/**
|
|
723
|
+
* Изменить настройки адреса
|
|
724
|
+
*
|
|
725
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
726
|
+
*
|
|
727
|
+
* @deprecated
|
|
728
|
+
*/
|
|
729
|
+
export const updateInboundMailbox = (options) => (options.client ?? client).patch({
|
|
730
|
+
security: [{
|
|
731
|
+
in: 'cookie',
|
|
732
|
+
name: '__Secure-better-auth.session_token',
|
|
733
|
+
type: 'apiKey'
|
|
734
|
+
}],
|
|
735
|
+
url: '/v1/inbound_mailboxes/{id}',
|
|
736
|
+
...options,
|
|
737
|
+
headers: {
|
|
738
|
+
'Content-Type': 'application/json',
|
|
739
|
+
...options.headers
|
|
740
|
+
}
|
|
741
|
+
});
|
|
742
|
+
/**
|
|
743
|
+
* Сменить адрес: старый перестаёт принимать письма сразу
|
|
744
|
+
*
|
|
745
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
746
|
+
*
|
|
747
|
+
* @deprecated
|
|
748
|
+
*/
|
|
749
|
+
export const rotateInboundMailbox = (options) => (options.client ?? client).post({
|
|
750
|
+
security: [{
|
|
751
|
+
in: 'cookie',
|
|
752
|
+
name: '__Secure-better-auth.session_token',
|
|
753
|
+
type: 'apiKey'
|
|
754
|
+
}],
|
|
755
|
+
url: '/v1/inbound_mailboxes/{id}/rotate',
|
|
756
|
+
...options
|
|
757
|
+
});
|
|
758
|
+
/**
|
|
759
|
+
* Журнал писем адреса за 30 дней, новые первыми
|
|
760
|
+
*
|
|
761
|
+
* Только служебные сведения: время, отправитель, итог, число документов. Ни текста, ни темы, ни вложений.
|
|
762
|
+
*
|
|
763
|
+
* Доступ: только сессия с ролью owner или admin или member.
|
|
764
|
+
*
|
|
765
|
+
* @deprecated
|
|
766
|
+
*/
|
|
767
|
+
export const listInboundMessages = (options) => (options.client ?? client).get({
|
|
768
|
+
security: [{
|
|
769
|
+
in: 'cookie',
|
|
770
|
+
name: '__Secure-better-auth.session_token',
|
|
771
|
+
type: 'apiKey'
|
|
772
|
+
}],
|
|
773
|
+
url: '/v1/inbound_mailboxes/{id}/messages',
|
|
774
|
+
...options
|
|
775
|
+
});
|
|
404
776
|
/**
|
|
405
777
|
* Удалить организацию
|
|
406
778
|
*
|
|
@@ -413,6 +785,8 @@ export const deleteApiKey = (options) => (options.client ?? client).delete({
|
|
|
413
785
|
* она удаляется вместе с аккаунтом (DELETE /v1/me).
|
|
414
786
|
*
|
|
415
787
|
* Доступ: только сессия с ролью owner.
|
|
788
|
+
*
|
|
789
|
+
* @deprecated
|
|
416
790
|
*/
|
|
417
791
|
export const deleteOrganization = (options) => (options?.client ?? client).delete({
|
|
418
792
|
security: [{
|
|
@@ -441,6 +815,8 @@ export const getOrganization = (options) => (options?.client ?? client).get({
|
|
|
441
815
|
* Изменить сроки хранения
|
|
442
816
|
*
|
|
443
817
|
* Доступ: только сессия с ролью owner или admin.
|
|
818
|
+
*
|
|
819
|
+
* @deprecated
|
|
444
820
|
*/
|
|
445
821
|
export const updateOrganization = (options) => (options.client ?? client).patch({
|
|
446
822
|
security: [{
|
|
@@ -609,7 +985,7 @@ export const getTypizer = (options) => (options.client ?? client).get({
|
|
|
609
985
|
/**
|
|
610
986
|
* Изменить типизатор
|
|
611
987
|
*
|
|
612
|
-
* Версии неизменяемы: изменённые schema или instructions создают новую версию, и она становится текущей. Перестановка поля внутри properties — это изменение (порядок полей — порядок результата); перестановка ключевого слова внутри поля — нет. Остальные поля меняются на месте.
|
|
988
|
+
* Версии неизменяемы: изменённые schema или instructions создают новую версию, и она становится текущей. Перестановка поля внутри properties — это изменение (порядок полей — порядок результата); перестановка ключевого слова внутри поля — нет. Остальные поля меняются на месте. Изменение схемы или инструкций добавленной из каталога схемы (catalog_source.relation: installed) делает типизатор вашей копией (forked): новые версии источника будут предлагаться, а не применяться.
|
|
613
989
|
*
|
|
614
990
|
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
615
991
|
*/
|
|
@@ -670,6 +1046,308 @@ export const getTypizerXsd = (options) => (options.client ?? client).get({
|
|
|
670
1046
|
url: '/v1/typizers/{id}/xsd',
|
|
671
1047
|
...options
|
|
672
1048
|
});
|
|
1049
|
+
/**
|
|
1050
|
+
* Профиль автора вашей организации
|
|
1051
|
+
*
|
|
1052
|
+
* Только сессия Кабинета. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. 404, пока профиль не создан.
|
|
1053
|
+
*
|
|
1054
|
+
* Доступ: только сессия.
|
|
1055
|
+
*
|
|
1056
|
+
* @deprecated
|
|
1057
|
+
*/
|
|
1058
|
+
export const getOwnCatalogPublisher = (options) => (options?.client ?? client).get({
|
|
1059
|
+
security: [{
|
|
1060
|
+
in: 'cookie',
|
|
1061
|
+
name: '__Secure-better-auth.session_token',
|
|
1062
|
+
type: 'apiKey'
|
|
1063
|
+
}],
|
|
1064
|
+
url: '/v1/catalog/publisher',
|
|
1065
|
+
...options
|
|
1066
|
+
});
|
|
1067
|
+
/**
|
|
1068
|
+
* Создать или изменить профиль автора
|
|
1069
|
+
*
|
|
1070
|
+
* Только сессия владельца или администратора организации. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Занятый или зарезервированный slug, смена slug после первой публикации — 409 с param: slug. Почту, телефоны и другие персональные данные в имени и описании не принимаем (400 с findings).
|
|
1071
|
+
*
|
|
1072
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
1073
|
+
*
|
|
1074
|
+
* @deprecated
|
|
1075
|
+
*/
|
|
1076
|
+
export const upsertOwnCatalogPublisher = (options) => (options.client ?? client).put({
|
|
1077
|
+
security: [{
|
|
1078
|
+
in: 'cookie',
|
|
1079
|
+
name: '__Secure-better-auth.session_token',
|
|
1080
|
+
type: 'apiKey'
|
|
1081
|
+
}],
|
|
1082
|
+
url: '/v1/catalog/publisher',
|
|
1083
|
+
...options,
|
|
1084
|
+
headers: {
|
|
1085
|
+
'Content-Type': 'application/json',
|
|
1086
|
+
...options.headers
|
|
1087
|
+
}
|
|
1088
|
+
});
|
|
1089
|
+
/**
|
|
1090
|
+
* Схемы, опубликованные вашей организацией
|
|
1091
|
+
*
|
|
1092
|
+
* Только сессия Кабинета. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Включая приватные, на проверке и отклонённые; новые первыми.
|
|
1093
|
+
*
|
|
1094
|
+
* Доступ: только сессия.
|
|
1095
|
+
*
|
|
1096
|
+
* @deprecated
|
|
1097
|
+
*/
|
|
1098
|
+
export const listOwnCatalogEntries = (options) => (options?.client ?? client).get({
|
|
1099
|
+
security: [{
|
|
1100
|
+
in: 'cookie',
|
|
1101
|
+
name: '__Secure-better-auth.session_token',
|
|
1102
|
+
type: 'apiKey'
|
|
1103
|
+
}],
|
|
1104
|
+
url: '/v1/catalog/mine',
|
|
1105
|
+
...options
|
|
1106
|
+
});
|
|
1107
|
+
/**
|
|
1108
|
+
* Профиль автора и его схемы
|
|
1109
|
+
*
|
|
1110
|
+
* Автор typizer — официальные схемы. Остальные авторы: Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404.
|
|
1111
|
+
*
|
|
1112
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1113
|
+
*/
|
|
1114
|
+
export const getCatalogPublisher = (options) => (options.client ?? client).get({
|
|
1115
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1116
|
+
in: 'cookie',
|
|
1117
|
+
name: '__Secure-better-auth.session_token',
|
|
1118
|
+
type: 'apiKey'
|
|
1119
|
+
}],
|
|
1120
|
+
url: '/v1/catalog/publishers/{slug}',
|
|
1121
|
+
...options
|
|
1122
|
+
});
|
|
1123
|
+
/**
|
|
1124
|
+
* Каталог готовых схем
|
|
1125
|
+
*
|
|
1126
|
+
* Официальные схемы Typizer и опубликованные организациями (когда они доступны вашей организации). Схемы «по ссылке» в список не попадают. Порядок может немного сдвинуться между страницами при пересчёте популярности (раз в час).
|
|
1127
|
+
*
|
|
1128
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1129
|
+
*/
|
|
1130
|
+
export const listCatalog = (options) => (options?.client ?? client).get({
|
|
1131
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1132
|
+
in: 'cookie',
|
|
1133
|
+
name: '__Secure-better-auth.session_token',
|
|
1134
|
+
type: 'apiKey'
|
|
1135
|
+
}],
|
|
1136
|
+
url: '/v1/catalog',
|
|
1137
|
+
...options
|
|
1138
|
+
});
|
|
1139
|
+
/**
|
|
1140
|
+
* Добавить схему к себе
|
|
1141
|
+
*
|
|
1142
|
+
* Создаёт типизатор из версии схемы (по умолчанию — последней). Повторный вызов для того же мажора возвращает уже добавленный типизатор с кодом 200. У официальных схем минорные версии приходят сами, о новом мажоре сообщит catalog_source.update. Схемы сообщества сами не меняются: новая версия предлагается в catalog_source.update и применяется через catalog_update. Поддерживает Idempotency-Key.
|
|
1143
|
+
*
|
|
1144
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1145
|
+
*/
|
|
1146
|
+
export const installCatalogEntry = (options) => (options.client ?? client).post({
|
|
1147
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1148
|
+
in: 'cookie',
|
|
1149
|
+
name: '__Secure-better-auth.session_token',
|
|
1150
|
+
type: 'apiKey'
|
|
1151
|
+
}],
|
|
1152
|
+
url: '/v1/catalog/{entry}/install',
|
|
1153
|
+
...options,
|
|
1154
|
+
headers: {
|
|
1155
|
+
'Content-Type': 'application/json',
|
|
1156
|
+
...options.headers
|
|
1157
|
+
}
|
|
1158
|
+
});
|
|
1159
|
+
/**
|
|
1160
|
+
* Создать типизатор на основе схемы
|
|
1161
|
+
*
|
|
1162
|
+
* Всегда создаёт новый типизатор — вашу копию схемы, которую можно менять. Новые версии источника предлагаются в catalog_source.update. Поддерживает Idempotency-Key.
|
|
1163
|
+
*
|
|
1164
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1165
|
+
*/
|
|
1166
|
+
export const forkCatalogEntry = (options) => (options.client ?? client).post({
|
|
1167
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1168
|
+
in: 'cookie',
|
|
1169
|
+
name: '__Secure-better-auth.session_token',
|
|
1170
|
+
type: 'apiKey'
|
|
1171
|
+
}],
|
|
1172
|
+
url: '/v1/catalog/{entry}/fork',
|
|
1173
|
+
...options,
|
|
1174
|
+
headers: {
|
|
1175
|
+
'Content-Type': 'application/json',
|
|
1176
|
+
...options.headers
|
|
1177
|
+
}
|
|
1178
|
+
});
|
|
1179
|
+
/**
|
|
1180
|
+
* Убрать из избранного
|
|
1181
|
+
*
|
|
1182
|
+
* Избранное общее для организации. Повторный вызов ничего не меняет.
|
|
1183
|
+
*
|
|
1184
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1185
|
+
*/
|
|
1186
|
+
export const unfavoriteCatalogEntry = (options) => (options.client ?? client).delete({
|
|
1187
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1188
|
+
in: 'cookie',
|
|
1189
|
+
name: '__Secure-better-auth.session_token',
|
|
1190
|
+
type: 'apiKey'
|
|
1191
|
+
}],
|
|
1192
|
+
url: '/v1/catalog/{entry}/favorite',
|
|
1193
|
+
...options
|
|
1194
|
+
});
|
|
1195
|
+
/**
|
|
1196
|
+
* Добавить в избранное
|
|
1197
|
+
*
|
|
1198
|
+
* Избранное общее для организации. Повторный вызов ничего не меняет.
|
|
1199
|
+
*
|
|
1200
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1201
|
+
*/
|
|
1202
|
+
export const favoriteCatalogEntry = (options) => (options.client ?? client).put({
|
|
1203
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1204
|
+
in: 'cookie',
|
|
1205
|
+
name: '__Secure-better-auth.session_token',
|
|
1206
|
+
type: 'apiKey'
|
|
1207
|
+
}],
|
|
1208
|
+
url: '/v1/catalog/{entry}/favorite',
|
|
1209
|
+
...options
|
|
1210
|
+
});
|
|
1211
|
+
/**
|
|
1212
|
+
* Версии схемы, новые первыми
|
|
1213
|
+
*
|
|
1214
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1215
|
+
*/
|
|
1216
|
+
export const listCatalogVersions = (options) => (options.client ?? client).get({
|
|
1217
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1218
|
+
in: 'cookie',
|
|
1219
|
+
name: '__Secure-better-auth.session_token',
|
|
1220
|
+
type: 'apiKey'
|
|
1221
|
+
}],
|
|
1222
|
+
url: '/v1/catalog/{entry}/versions',
|
|
1223
|
+
...options
|
|
1224
|
+
});
|
|
1225
|
+
/**
|
|
1226
|
+
* Пожаловаться на схему
|
|
1227
|
+
*
|
|
1228
|
+
* Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Одна открытая жалоба от организации на схему (повтор — 409).
|
|
1229
|
+
*
|
|
1230
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1231
|
+
*/
|
|
1232
|
+
export const reportCatalogEntry = (options) => (options.client ?? client).post({
|
|
1233
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1234
|
+
in: 'cookie',
|
|
1235
|
+
name: '__Secure-better-auth.session_token',
|
|
1236
|
+
type: 'apiKey'
|
|
1237
|
+
}],
|
|
1238
|
+
url: '/v1/catalog/{entry}/reports',
|
|
1239
|
+
...options,
|
|
1240
|
+
headers: {
|
|
1241
|
+
'Content-Type': 'application/json',
|
|
1242
|
+
...options.headers
|
|
1243
|
+
}
|
|
1244
|
+
});
|
|
1245
|
+
/**
|
|
1246
|
+
* Снять свою схему с публикации
|
|
1247
|
+
*
|
|
1248
|
+
* Только сессия владельца или администратора организации. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404. Уже добавленные другими организациями типизаторы продолжают работать.
|
|
1249
|
+
*
|
|
1250
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
1251
|
+
*
|
|
1252
|
+
* @deprecated
|
|
1253
|
+
*/
|
|
1254
|
+
export const unpublishCatalogEntry = (options) => (options.client ?? client).post({
|
|
1255
|
+
security: [{
|
|
1256
|
+
in: 'cookie',
|
|
1257
|
+
name: '__Secure-better-auth.session_token',
|
|
1258
|
+
type: 'apiKey'
|
|
1259
|
+
}],
|
|
1260
|
+
url: '/v1/catalog/{entry}/unpublish',
|
|
1261
|
+
...options
|
|
1262
|
+
});
|
|
1263
|
+
/**
|
|
1264
|
+
* Схема каталога
|
|
1265
|
+
*
|
|
1266
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1267
|
+
*/
|
|
1268
|
+
export const getCatalogEntry = (options) => (options.client ?? client).get({
|
|
1269
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1270
|
+
in: 'cookie',
|
|
1271
|
+
name: '__Secure-better-auth.session_token',
|
|
1272
|
+
type: 'apiKey'
|
|
1273
|
+
}],
|
|
1274
|
+
url: '/v1/catalog/{entry}',
|
|
1275
|
+
...options
|
|
1276
|
+
});
|
|
1277
|
+
/**
|
|
1278
|
+
* Схема сообщества по адресу автора
|
|
1279
|
+
*
|
|
1280
|
+
* Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 404.
|
|
1281
|
+
*
|
|
1282
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1283
|
+
*/
|
|
1284
|
+
export const getCommunityCatalogEntry = (options) => (options.client ?? client).get({
|
|
1285
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1286
|
+
in: 'cookie',
|
|
1287
|
+
name: '__Secure-better-auth.session_token',
|
|
1288
|
+
type: 'apiKey'
|
|
1289
|
+
}],
|
|
1290
|
+
url: '/v1/catalog/{publisher}/{slug}',
|
|
1291
|
+
...options
|
|
1292
|
+
});
|
|
1293
|
+
/**
|
|
1294
|
+
* Опубликовать типизатор в каталоге
|
|
1295
|
+
*
|
|
1296
|
+
* Только сессия владельца или администратора организации. Схемы сообщества пока закрыты: без включённой для организации функции маршрут отвечает 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.
|
|
1297
|
+
*
|
|
1298
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
1299
|
+
*
|
|
1300
|
+
* @deprecated
|
|
1301
|
+
*/
|
|
1302
|
+
export const publishTypizer = (options) => (options.client ?? client).post({
|
|
1303
|
+
security: [{
|
|
1304
|
+
in: 'cookie',
|
|
1305
|
+
name: '__Secure-better-auth.session_token',
|
|
1306
|
+
type: 'apiKey'
|
|
1307
|
+
}],
|
|
1308
|
+
url: '/v1/typizers/{id}/publish',
|
|
1309
|
+
...options,
|
|
1310
|
+
headers: {
|
|
1311
|
+
'Content-Type': 'application/json',
|
|
1312
|
+
...options.headers
|
|
1313
|
+
}
|
|
1314
|
+
});
|
|
1315
|
+
/**
|
|
1316
|
+
* Что изменится при обновлении из каталога
|
|
1317
|
+
*
|
|
1318
|
+
* Изменения схемы от версии типизатора до version (по умолчанию — новейшей доступной) и список изменений источника. conflict — вы тоже меняли это поле. Нет обновления — 409.
|
|
1319
|
+
*
|
|
1320
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
1321
|
+
*/
|
|
1322
|
+
export const getTypizerCatalogUpdate = (options) => (options.client ?? client).get({
|
|
1323
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1324
|
+
in: 'cookie',
|
|
1325
|
+
name: '__Secure-better-auth.session_token',
|
|
1326
|
+
type: 'apiKey'
|
|
1327
|
+
}],
|
|
1328
|
+
url: '/v1/typizers/{id}/catalog_update',
|
|
1329
|
+
...options
|
|
1330
|
+
});
|
|
1331
|
+
/**
|
|
1332
|
+
* Обновить типизатор из каталога
|
|
1333
|
+
*
|
|
1334
|
+
* Добавленная схема (installed) переходит на версию version целиком (paths не передаются). Типизатор на основе схемы (forked) подтягивает только выбранные paths. Создаёт новую версию типизатора. Поддерживает Idempotency-Key.
|
|
1335
|
+
*
|
|
1336
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
1337
|
+
*/
|
|
1338
|
+
export const applyTypizerCatalogUpdate = (options) => (options.client ?? client).post({
|
|
1339
|
+
security: [{ scheme: 'bearer', type: 'http' }, {
|
|
1340
|
+
in: 'cookie',
|
|
1341
|
+
name: '__Secure-better-auth.session_token',
|
|
1342
|
+
type: 'apiKey'
|
|
1343
|
+
}],
|
|
1344
|
+
url: '/v1/typizers/{id}/catalog_update',
|
|
1345
|
+
...options,
|
|
1346
|
+
headers: {
|
|
1347
|
+
'Content-Type': 'application/json',
|
|
1348
|
+
...options.headers
|
|
1349
|
+
}
|
|
1350
|
+
});
|
|
673
1351
|
/**
|
|
674
1352
|
* Запустить типизатор на документе
|
|
675
1353
|
*
|
|
@@ -821,9 +1499,9 @@ export const exportBatch = (options) => (options.client ?? client).get({
|
|
|
821
1499
|
...options
|
|
822
1500
|
});
|
|
823
1501
|
/**
|
|
824
|
-
* Извлечь данные по разовой схеме
|
|
1502
|
+
* Извлечь данные по разовой схеме или схеме из каталога
|
|
825
1503
|
*
|
|
826
|
-
* Прогон
|
|
1504
|
+
* Прогон без сохранения типизатора (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
1505
|
*
|
|
828
1506
|
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
829
1507
|
*/
|
|
@@ -1006,6 +1684,8 @@ export const getUsage = (options) => (options?.client ?? client).get({
|
|
|
1006
1684
|
* Только сессия (любая роль); диалог виден пользователю, который его начал.
|
|
1007
1685
|
*
|
|
1008
1686
|
* Доступ: только сессия.
|
|
1687
|
+
*
|
|
1688
|
+
* @deprecated
|
|
1009
1689
|
*/
|
|
1010
1690
|
export const listAgentThreads = (options) => (options?.client ?? client).get({
|
|
1011
1691
|
security: [{
|
|
@@ -1022,6 +1702,8 @@ export const listAgentThreads = (options) => (options?.client ?? client).get({
|
|
|
1022
1702
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Поддерживает Idempotency-Key.
|
|
1023
1703
|
*
|
|
1024
1704
|
* Доступ: только сессия.
|
|
1705
|
+
*
|
|
1706
|
+
* @deprecated
|
|
1025
1707
|
*/
|
|
1026
1708
|
export const createAgentThread = (options) => (options?.client ?? client).post({
|
|
1027
1709
|
security: [{
|
|
@@ -1042,6 +1724,8 @@ export const createAgentThread = (options) => (options?.client ?? client).post({
|
|
|
1042
1724
|
* Только сессия (любая роль); диалог виден пользователю, который его начал.
|
|
1043
1725
|
*
|
|
1044
1726
|
* Доступ: только сессия.
|
|
1727
|
+
*
|
|
1728
|
+
* @deprecated
|
|
1045
1729
|
*/
|
|
1046
1730
|
export const getAgentThread = (options) => (options.client ?? client).get({
|
|
1047
1731
|
security: [{
|
|
@@ -1058,6 +1742,8 @@ export const getAgentThread = (options) => (options.client ?? client).get({
|
|
|
1058
1742
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. draft_schema проверяется как схема типизатора (param — это draft_schema# и указатель).
|
|
1059
1743
|
*
|
|
1060
1744
|
* Доступ: только сессия.
|
|
1745
|
+
*
|
|
1746
|
+
* @deprecated
|
|
1061
1747
|
*/
|
|
1062
1748
|
export const updateAgentThread = (options) => (options.client ?? client).patch({
|
|
1063
1749
|
security: [{
|
|
@@ -1078,6 +1764,8 @@ export const updateAgentThread = (options) => (options.client ?? client).patch({
|
|
|
1078
1764
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Запускает черновик схемы на образце диалога (source agent); страницы не резервируются и не списываются. Расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве; сверх квоты 429 с Retry-After). 409 conflict без черновика или образца; 400 too_many_pages для образца больше 10 страниц. Отвечает так же, как создание прогона. Поддерживает Idempotency-Key.
|
|
1079
1765
|
*
|
|
1080
1766
|
* Доступ: только сессия.
|
|
1767
|
+
*
|
|
1768
|
+
* @deprecated
|
|
1081
1769
|
*/
|
|
1082
1770
|
export const createAgentSampleRun = (options) => (options.client ?? client).post({
|
|
1083
1771
|
security: [{
|
|
@@ -1094,6 +1782,8 @@ export const createAgentSampleRun = (options) => (options.client ?? client).post
|
|
|
1094
1782
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Диалог, связанный с типизатором, сохраняет его новую версию (200); иначе — если диалог ни разу не сохранялся или его типизатор с тех пор архивирован — создаётся новый типизатор (201), и диалог связывается с ним. 409 conflict без черновика. Поддерживает Idempotency-Key.
|
|
1095
1783
|
*
|
|
1096
1784
|
* Доступ: только сессия.
|
|
1785
|
+
*
|
|
1786
|
+
* @deprecated
|
|
1097
1787
|
*/
|
|
1098
1788
|
export const saveAgentThread = (options) => (options.client ?? client).post({
|
|
1099
1789
|
security: [{
|
|
@@ -1114,6 +1804,8 @@ export const saveAgentThread = (options) => (options.client ?? client).post({
|
|
|
1114
1804
|
* Только сессия (любая роль); диалог виден пользователю, который его начал. Расходует одну единицу дневной квоты ассистента (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
1805
|
*
|
|
1116
1806
|
* Доступ: только сессия.
|
|
1807
|
+
*
|
|
1808
|
+
* @deprecated
|
|
1117
1809
|
*/
|
|
1118
1810
|
export const createAgentMessage = (options) => (options.client ?? client).sse.post({
|
|
1119
1811
|
security: [{
|
|
@@ -1128,3 +1820,200 @@ export const createAgentMessage = (options) => (options.client ?? client).sse.po
|
|
|
1128
1820
|
...options.headers
|
|
1129
1821
|
}
|
|
1130
1822
|
});
|
|
1823
|
+
/**
|
|
1824
|
+
* Поддержка: включена ли и её ограничения
|
|
1825
|
+
*
|
|
1826
|
+
* Только сессия. Не для интеграций.
|
|
1827
|
+
*
|
|
1828
|
+
* Доступ: только сессия.
|
|
1829
|
+
*
|
|
1830
|
+
* @deprecated
|
|
1831
|
+
*/
|
|
1832
|
+
export const getSupportConfig = (options) => (options?.client ?? client).get({
|
|
1833
|
+
security: [{
|
|
1834
|
+
in: 'cookie',
|
|
1835
|
+
name: '__Secure-better-auth.session_token',
|
|
1836
|
+
type: 'apiKey'
|
|
1837
|
+
}],
|
|
1838
|
+
url: '/v1/support/config',
|
|
1839
|
+
...options
|
|
1840
|
+
});
|
|
1841
|
+
/**
|
|
1842
|
+
* Обращения, новые первыми
|
|
1843
|
+
*
|
|
1844
|
+
* Только сессия. Не для интеграций. scope=org — все обращения организации (owner и admin).
|
|
1845
|
+
*
|
|
1846
|
+
* Доступ: только сессия.
|
|
1847
|
+
*
|
|
1848
|
+
* @deprecated
|
|
1849
|
+
*/
|
|
1850
|
+
export const listSupportConversations = (options) => (options?.client ?? client).get({
|
|
1851
|
+
security: [{
|
|
1852
|
+
in: 'cookie',
|
|
1853
|
+
name: '__Secure-better-auth.session_token',
|
|
1854
|
+
type: 'apiKey'
|
|
1855
|
+
}],
|
|
1856
|
+
url: '/v1/support/conversations',
|
|
1857
|
+
...options
|
|
1858
|
+
});
|
|
1859
|
+
/**
|
|
1860
|
+
* Новое обращение
|
|
1861
|
+
*
|
|
1862
|
+
* Только сессия. Не для интеграций. Отвечает ИИ-помощник, сложные вопросы передаёт человеку. Idempotency-Key игнорируется.
|
|
1863
|
+
*
|
|
1864
|
+
* Доступ: только сессия.
|
|
1865
|
+
*
|
|
1866
|
+
* @deprecated
|
|
1867
|
+
*/
|
|
1868
|
+
export const createSupportConversation = (options) => (options.client ?? client).post({
|
|
1869
|
+
security: [{
|
|
1870
|
+
in: 'cookie',
|
|
1871
|
+
name: '__Secure-better-auth.session_token',
|
|
1872
|
+
type: 'apiKey'
|
|
1873
|
+
}],
|
|
1874
|
+
url: '/v1/support/conversations',
|
|
1875
|
+
...options,
|
|
1876
|
+
headers: {
|
|
1877
|
+
'Content-Type': 'application/json',
|
|
1878
|
+
...options.headers
|
|
1879
|
+
}
|
|
1880
|
+
});
|
|
1881
|
+
/**
|
|
1882
|
+
* Обращение с перепиской
|
|
1883
|
+
*
|
|
1884
|
+
* Только сессия. Не для интеграций. Отмечает ответы просмотренными.
|
|
1885
|
+
*
|
|
1886
|
+
* Доступ: только сессия.
|
|
1887
|
+
*
|
|
1888
|
+
* @deprecated
|
|
1889
|
+
*/
|
|
1890
|
+
export const getSupportConversation = (options) => (options.client ?? client).get({
|
|
1891
|
+
security: [{
|
|
1892
|
+
in: 'cookie',
|
|
1893
|
+
name: '__Secure-better-auth.session_token',
|
|
1894
|
+
type: 'apiKey'
|
|
1895
|
+
}],
|
|
1896
|
+
url: '/v1/support/conversations/{id}',
|
|
1897
|
+
...options
|
|
1898
|
+
});
|
|
1899
|
+
/**
|
|
1900
|
+
* Ответить в обращении
|
|
1901
|
+
*
|
|
1902
|
+
* Только сессия. Не для интеграций. Решённое или закрытое обращение открывается снова. Idempotency-Key игнорируется.
|
|
1903
|
+
*
|
|
1904
|
+
* Доступ: только сессия.
|
|
1905
|
+
*
|
|
1906
|
+
* @deprecated
|
|
1907
|
+
*/
|
|
1908
|
+
export const createSupportMessage = (options) => (options.client ?? client).post({
|
|
1909
|
+
security: [{
|
|
1910
|
+
in: 'cookie',
|
|
1911
|
+
name: '__Secure-better-auth.session_token',
|
|
1912
|
+
type: 'apiKey'
|
|
1913
|
+
}],
|
|
1914
|
+
url: '/v1/support/conversations/{id}/messages',
|
|
1915
|
+
...options,
|
|
1916
|
+
headers: {
|
|
1917
|
+
'Content-Type': 'application/json',
|
|
1918
|
+
...options.headers
|
|
1919
|
+
}
|
|
1920
|
+
});
|
|
1921
|
+
/**
|
|
1922
|
+
* Вопрос решён
|
|
1923
|
+
*
|
|
1924
|
+
* Только сессия. Не для интеграций. Idempotency-Key игнорируется.
|
|
1925
|
+
*
|
|
1926
|
+
* Доступ: только сессия.
|
|
1927
|
+
*
|
|
1928
|
+
* @deprecated
|
|
1929
|
+
*/
|
|
1930
|
+
export const closeSupportConversation = (options) => (options.client ?? client).post({
|
|
1931
|
+
security: [{
|
|
1932
|
+
in: 'cookie',
|
|
1933
|
+
name: '__Secure-better-auth.session_token',
|
|
1934
|
+
type: 'apiKey'
|
|
1935
|
+
}],
|
|
1936
|
+
url: '/v1/support/conversations/{id}/close',
|
|
1937
|
+
...options
|
|
1938
|
+
});
|
|
1939
|
+
/**
|
|
1940
|
+
* Вопрос не решён: открыть снова
|
|
1941
|
+
*
|
|
1942
|
+
* Только сессия. Не для интеграций. Idempotency-Key игнорируется.
|
|
1943
|
+
*
|
|
1944
|
+
* Доступ: только сессия.
|
|
1945
|
+
*
|
|
1946
|
+
* @deprecated
|
|
1947
|
+
*/
|
|
1948
|
+
export const reopenSupportConversation = (options) => (options.client ?? client).post({
|
|
1949
|
+
security: [{
|
|
1950
|
+
in: 'cookie',
|
|
1951
|
+
name: '__Secure-better-auth.session_token',
|
|
1952
|
+
type: 'apiKey'
|
|
1953
|
+
}],
|
|
1954
|
+
url: '/v1/support/conversations/{id}/reopen',
|
|
1955
|
+
...options
|
|
1956
|
+
});
|
|
1957
|
+
/**
|
|
1958
|
+
* Оценить решённое обращение
|
|
1959
|
+
*
|
|
1960
|
+
* Только сессия. Не для интеграций. 409 — обращение ещё не решено. Idempotency-Key игнорируется.
|
|
1961
|
+
*
|
|
1962
|
+
* Доступ: только сессия.
|
|
1963
|
+
*
|
|
1964
|
+
* @deprecated
|
|
1965
|
+
*/
|
|
1966
|
+
export const rateSupportConversation = (options) => (options.client ?? client).post({
|
|
1967
|
+
security: [{
|
|
1968
|
+
in: 'cookie',
|
|
1969
|
+
name: '__Secure-better-auth.session_token',
|
|
1970
|
+
type: 'apiKey'
|
|
1971
|
+
}],
|
|
1972
|
+
url: '/v1/support/conversations/{id}/rating',
|
|
1973
|
+
...options,
|
|
1974
|
+
headers: {
|
|
1975
|
+
'Content-Type': 'application/json',
|
|
1976
|
+
...options.headers
|
|
1977
|
+
}
|
|
1978
|
+
});
|
|
1979
|
+
/**
|
|
1980
|
+
* Загрузить вложение для обращения
|
|
1981
|
+
*
|
|
1982
|
+
* Только сессия. Не для интеграций. Multipart, поле file: PDF, PNG, JPEG, WebP, TIFF, TXT, CSV, JSON, XML, DOCX, XLSX до 10485760 байт. Действует 24 часа, пока не приложено к сообщению. Idempotency-Key игнорируется.
|
|
1983
|
+
*
|
|
1984
|
+
* Доступ: только сессия.
|
|
1985
|
+
*
|
|
1986
|
+
* @deprecated
|
|
1987
|
+
*/
|
|
1988
|
+
export const createSupportAttachment = (options) => (options.client ?? client).post({
|
|
1989
|
+
...formDataBodySerializer,
|
|
1990
|
+
security: [{
|
|
1991
|
+
in: 'cookie',
|
|
1992
|
+
name: '__Secure-better-auth.session_token',
|
|
1993
|
+
type: 'apiKey'
|
|
1994
|
+
}],
|
|
1995
|
+
url: '/v1/support/attachments',
|
|
1996
|
+
...options,
|
|
1997
|
+
headers: {
|
|
1998
|
+
'Content-Type': null,
|
|
1999
|
+
...options.headers
|
|
2000
|
+
}
|
|
2001
|
+
});
|
|
2002
|
+
/**
|
|
2003
|
+
* Короткоживущий токен виджета для вошедшего пользователя
|
|
2004
|
+
*
|
|
2005
|
+
* Только сессия. Не для интеграций. JWT на 10 минут: виджет на сайте и в Кабинете пишет от имени пользователя Кабинета.
|
|
2006
|
+
*
|
|
2007
|
+
* Доступ: только сессия.
|
|
2008
|
+
*
|
|
2009
|
+
* @deprecated
|
|
2010
|
+
*/
|
|
2011
|
+
export const createSupportWidgetToken = (options) => (options?.client ?? client).post({
|
|
2012
|
+
security: [{
|
|
2013
|
+
in: 'cookie',
|
|
2014
|
+
name: '__Secure-better-auth.session_token',
|
|
2015
|
+
type: 'apiKey'
|
|
2016
|
+
}],
|
|
2017
|
+
url: '/v1/support/widget/token',
|
|
2018
|
+
...options
|
|
2019
|
+
});
|