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/types.gen.d.ts
CHANGED
|
@@ -32,6 +32,13 @@ export type Problem = {
|
|
|
32
32
|
* Сколько документов прислал запрос (вместе с `batch_id`)
|
|
33
33
|
*/
|
|
34
34
|
expected?: number;
|
|
35
|
+
/**
|
|
36
|
+
* Найденные персональные данные (400 при публикации в каталог): путь и вид, без самих значений
|
|
37
|
+
*/
|
|
38
|
+
findings?: Array<{
|
|
39
|
+
path: string;
|
|
40
|
+
kind: string;
|
|
41
|
+
}>;
|
|
35
42
|
/**
|
|
36
43
|
* Сколько секунд подождать перед повтором: только в результатах инструментов MCP, где нет заголовка `Retry-After`
|
|
37
44
|
*/
|
|
@@ -211,7 +218,7 @@ export type PaymentList = {
|
|
|
211
218
|
};
|
|
212
219
|
export type ConsentRequest = {
|
|
213
220
|
/**
|
|
214
|
-
* `cookies_analytics` (баннер cookie на
|
|
221
|
+
* `cookies_analytics` (баннер cookie на typizer.ru или docs.typizer.ru, аккаунт не нужен) или `marketing` (только сессия)
|
|
215
222
|
*/
|
|
216
223
|
kind: 'cookies_analytics' | 'marketing';
|
|
217
224
|
/**
|
|
@@ -222,13 +229,17 @@ export type ConsentRequest = {
|
|
|
222
229
|
* Текущая версия документа согласия (`cookies` или `marketing-consent`)
|
|
223
230
|
*/
|
|
224
231
|
doc_version: string;
|
|
232
|
+
/**
|
|
233
|
+
* Сайт, на котором принято решение. Необязательно: сервер всё равно определяет сайт по заголовку Origin и записывает его; если поле передано и не совпадает с Origin — 400.
|
|
234
|
+
*/
|
|
235
|
+
site?: 'typizer.ru' | 'docs.typizer.ru' | 'my.typizer.ru';
|
|
225
236
|
};
|
|
226
237
|
export type DemoSampleList = {
|
|
227
238
|
object: 'list';
|
|
228
239
|
data: Array<DemoSample>;
|
|
229
240
|
};
|
|
230
241
|
export type DemoSample = {
|
|
231
|
-
id: 'invoice' | 'contract' | 'upd';
|
|
242
|
+
id: 'invoice' | 'contract' | 'upd' | 'schet-na-oplatu-pdf' | 'schet-na-oplatu-scan' | 'schet-faktura-pdf' | 'schet-faktura-scan' | 'platezhnoe-poruchenie-pdf' | 'bankovskaya-vypiska-pdf' | 'kassovyj-chek-photo' | 'upd-pdf' | 'upd-scan' | 'torg-12-scan' | 'ttn-pdf' | 'doverennost-scan' | 'akt-pdf' | 'smeta-pdf' | 'ks-2-pdf' | 'ks-3-pdf' | 'avansovyj-otchet-scan' | 'invoice-pdf' | 'vypiska-egryul-pdf' | 'vypiska-egrn-pdf' | 'dogovor-pdf' | 'rezyume-pdf' | 'trudovaya-knizhka-scan' | 'spravka-2-ndfl-pdf' | 'pasport-rf-scan' | 'pasport-rf-photo' | 'snils-scan' | 'snils-photo' | 'voditelskoe-udostoverenie-scan' | 'voditelskoe-udostoverenie-photo' | 'sts-photo' | 'sts-scan' | 'pts-scan';
|
|
232
243
|
title: string;
|
|
233
244
|
pages: number;
|
|
234
245
|
prompt: string;
|
|
@@ -237,6 +248,21 @@ export type DemoSample = {
|
|
|
237
248
|
*/
|
|
238
249
|
file_url: string;
|
|
239
250
|
};
|
|
251
|
+
export type DemoQuota = {
|
|
252
|
+
object: 'demo_quota';
|
|
253
|
+
/**
|
|
254
|
+
* Прогонов без кеша в сутки на адрес
|
|
255
|
+
*/
|
|
256
|
+
runs_per_day: number;
|
|
257
|
+
/**
|
|
258
|
+
* Сколько из них осталось сегодня (с учётом общего дневного лимита сервиса)
|
|
259
|
+
*/
|
|
260
|
+
runs_left: number;
|
|
261
|
+
/**
|
|
262
|
+
* Когда счётчик обнулится: полночь по Москве, ISO 8601
|
|
263
|
+
*/
|
|
264
|
+
resets_at: string;
|
|
265
|
+
};
|
|
240
266
|
export type DemoRun = {
|
|
241
267
|
/**
|
|
242
268
|
* `null` у ответа из кеша
|
|
@@ -266,17 +292,64 @@ export type DemoRun = {
|
|
|
266
292
|
code: string;
|
|
267
293
|
message: string;
|
|
268
294
|
} | null;
|
|
295
|
+
/**
|
|
296
|
+
* Сколько прогонов без кеша осталось этому адресу сегодня (по Москве) после этого. Есть только в ответе `POST /v1/demo/runs`, на который прогон потрачен
|
|
297
|
+
*/
|
|
298
|
+
demo_runs_left?: number;
|
|
269
299
|
};
|
|
270
300
|
export type DemoRunRequest = {
|
|
271
301
|
/**
|
|
272
302
|
* Один из образцов `GET /v1/demo/samples`
|
|
273
303
|
*/
|
|
274
|
-
sample: 'invoice' | 'contract' | 'upd';
|
|
304
|
+
sample: 'invoice' | 'contract' | 'upd' | 'schet-na-oplatu-pdf' | 'schet-na-oplatu-scan' | 'schet-faktura-pdf' | 'schet-faktura-scan' | 'platezhnoe-poruchenie-pdf' | 'bankovskaya-vypiska-pdf' | 'kassovyj-chek-photo' | 'upd-pdf' | 'upd-scan' | 'torg-12-scan' | 'ttn-pdf' | 'doverennost-scan' | 'akt-pdf' | 'smeta-pdf' | 'ks-2-pdf' | 'ks-3-pdf' | 'avansovyj-otchet-scan' | 'invoice-pdf' | 'vypiska-egryul-pdf' | 'vypiska-egrn-pdf' | 'dogovor-pdf' | 'rezyume-pdf' | 'trudovaya-knizhka-scan' | 'spravka-2-ndfl-pdf' | 'pasport-rf-scan' | 'pasport-rf-photo' | 'snils-scan' | 'snils-photo' | 'voditelskoe-udostoverenie-scan' | 'voditelskoe-udostoverenie-photo' | 'sts-photo' | 'sts-scan' | 'pts-scan';
|
|
275
305
|
/**
|
|
276
306
|
* Что извлечь, своими словами (1–500 символов)
|
|
277
307
|
*/
|
|
278
308
|
prompt: string;
|
|
279
309
|
};
|
|
310
|
+
export type OcrQuota = {
|
|
311
|
+
object: 'ocr_quota';
|
|
312
|
+
files_per_day: number;
|
|
313
|
+
files_left: number;
|
|
314
|
+
max_pages: number;
|
|
315
|
+
max_file_bytes: number;
|
|
316
|
+
resets_at: string;
|
|
317
|
+
};
|
|
318
|
+
export type OcrResult = {
|
|
319
|
+
object: 'ocr_result';
|
|
320
|
+
/**
|
|
321
|
+
* Страниц в файле
|
|
322
|
+
*/
|
|
323
|
+
pages_total: number;
|
|
324
|
+
/**
|
|
325
|
+
* Сколько распознано: не больше 5, с первой
|
|
326
|
+
*/
|
|
327
|
+
pages_processed: number;
|
|
328
|
+
/**
|
|
329
|
+
* Распознана только часть файла: первые страницы или ответ сокращён
|
|
330
|
+
*/
|
|
331
|
+
truncated: boolean;
|
|
332
|
+
pages: Array<OcrPage>;
|
|
333
|
+
tables: Array<OcrTable>;
|
|
334
|
+
/**
|
|
335
|
+
* Сколько файлов этот адрес ещё может распознать сегодня (по Москве)
|
|
336
|
+
*/
|
|
337
|
+
files_left: number;
|
|
338
|
+
};
|
|
339
|
+
export type OcrPage = {
|
|
340
|
+
page: number;
|
|
341
|
+
/**
|
|
342
|
+
* Текст страницы в порядке чтения
|
|
343
|
+
*/
|
|
344
|
+
text: string;
|
|
345
|
+
};
|
|
346
|
+
export type OcrTable = {
|
|
347
|
+
page: number;
|
|
348
|
+
/**
|
|
349
|
+
* Строки таблицы; объединённая ячейка записана в первую из своих клеток
|
|
350
|
+
*/
|
|
351
|
+
rows: Array<Array<string>>;
|
|
352
|
+
};
|
|
280
353
|
export type Status = {
|
|
281
354
|
object: 'status';
|
|
282
355
|
data: Array<MaintenanceEvent>;
|
|
@@ -343,6 +416,14 @@ export type Me = {
|
|
|
343
416
|
features: {
|
|
344
417
|
billing_enabled: boolean;
|
|
345
418
|
edo_diadoc: boolean;
|
|
419
|
+
/**
|
|
420
|
+
* Схемы сообщества в каталоге: просмотр, публикация, жалобы
|
|
421
|
+
*/
|
|
422
|
+
catalog_community: boolean;
|
|
423
|
+
/**
|
|
424
|
+
* Приём документов по почте («Почта для документов»)
|
|
425
|
+
*/
|
|
426
|
+
inbound_mail: boolean;
|
|
346
427
|
};
|
|
347
428
|
};
|
|
348
429
|
export type Scope = 'typizers:read' | 'typizers:write' | 'runs:read' | 'runs:write' | 'billing:read';
|
|
@@ -424,6 +505,108 @@ export type DeletedApiKey = {
|
|
|
424
505
|
object: 'api_key';
|
|
425
506
|
deleted: true;
|
|
426
507
|
};
|
|
508
|
+
export type ConnectorLink = {
|
|
509
|
+
object: 'connector_link';
|
|
510
|
+
connector: 'telegram' | 'max' | 'bitrix24';
|
|
511
|
+
/**
|
|
512
|
+
* Telegram и MAX — ссылка на бота; Битрикс24 — страница подключения портала на connect.typizer.ru
|
|
513
|
+
*/
|
|
514
|
+
url: string;
|
|
515
|
+
expires_at: string;
|
|
516
|
+
};
|
|
517
|
+
export type CreateConnectorLinkRequest = {
|
|
518
|
+
connector: 'telegram' | 'max' | 'bitrix24';
|
|
519
|
+
};
|
|
520
|
+
export type ConnectorLinkRequest = {
|
|
521
|
+
object: 'connector_link_request';
|
|
522
|
+
connector: 'amocrm';
|
|
523
|
+
account: {
|
|
524
|
+
host: string;
|
|
525
|
+
name: string;
|
|
526
|
+
user_name: string;
|
|
527
|
+
};
|
|
528
|
+
/**
|
|
529
|
+
* pending — ждёт подтверждения; approved_by_you — вы начали авторизацию в amoCRM; held — запрос подтверждает другой администратор; authorized — осталось подтвердить в amoCRM
|
|
530
|
+
*/
|
|
531
|
+
status: 'pending' | 'approved_by_you' | 'held' | 'authorized';
|
|
532
|
+
expires_at: string | null;
|
|
533
|
+
};
|
|
534
|
+
export type ConnectorLinkAuthorization = {
|
|
535
|
+
object: 'connector_link_authorization';
|
|
536
|
+
authorize_url: string;
|
|
537
|
+
expires_at: string;
|
|
538
|
+
};
|
|
539
|
+
export type ConnectorLinkRequestRejected = {
|
|
540
|
+
object: 'connector_link_request';
|
|
541
|
+
deleted: true;
|
|
542
|
+
};
|
|
543
|
+
export type InboundMailboxList = {
|
|
544
|
+
object: 'list';
|
|
545
|
+
data: Array<InboundMailbox>;
|
|
546
|
+
has_more: boolean;
|
|
547
|
+
};
|
|
548
|
+
export type InboundMailbox = {
|
|
549
|
+
id: string;
|
|
550
|
+
object: 'inbound_mailbox';
|
|
551
|
+
name: string;
|
|
552
|
+
address: string;
|
|
553
|
+
typizer_id: string;
|
|
554
|
+
typizer_name: string | null;
|
|
555
|
+
allowed_senders: Array<string>;
|
|
556
|
+
/**
|
|
557
|
+
* Участники организации могут присылать письма
|
|
558
|
+
*/
|
|
559
|
+
allow_members: boolean;
|
|
560
|
+
/**
|
|
561
|
+
* Отправитель должен пройти проверку SPF/DKIM/DMARC
|
|
562
|
+
*/
|
|
563
|
+
require_auth: boolean;
|
|
564
|
+
/**
|
|
565
|
+
* Отвечать отправителю письмом с результатами (Excel и JSON во вложении)
|
|
566
|
+
*/
|
|
567
|
+
reply_with_results: boolean;
|
|
568
|
+
last_message_at: string | null;
|
|
569
|
+
created_at: string;
|
|
570
|
+
updated_at: string;
|
|
571
|
+
};
|
|
572
|
+
export type CreateInboundMailboxRequest = {
|
|
573
|
+
name?: string;
|
|
574
|
+
typizer_id: string;
|
|
575
|
+
/**
|
|
576
|
+
* Кому ещё можно присылать письма: адреса (`buh@romashka.example`) или целые домены (`@romashka.example`)
|
|
577
|
+
*/
|
|
578
|
+
allowed_senders?: Array<string>;
|
|
579
|
+
allow_members?: boolean;
|
|
580
|
+
require_auth?: boolean;
|
|
581
|
+
reply_with_results?: boolean;
|
|
582
|
+
};
|
|
583
|
+
export type UpdateInboundMailboxRequest = {
|
|
584
|
+
name?: string;
|
|
585
|
+
typizer_id?: string;
|
|
586
|
+
/**
|
|
587
|
+
* Кому ещё можно присылать письма: адреса (`buh@romashka.example`) или целые домены (`@romashka.example`)
|
|
588
|
+
*/
|
|
589
|
+
allowed_senders?: Array<string>;
|
|
590
|
+
allow_members?: boolean;
|
|
591
|
+
require_auth?: boolean;
|
|
592
|
+
reply_with_results?: boolean;
|
|
593
|
+
};
|
|
594
|
+
export type DeletedInboundMailbox = {
|
|
595
|
+
id: string;
|
|
596
|
+
object: 'inbound_mailbox';
|
|
597
|
+
deleted: true;
|
|
598
|
+
};
|
|
599
|
+
export type InboundMessage = {
|
|
600
|
+
id: string;
|
|
601
|
+
object: 'inbound_message';
|
|
602
|
+
received_at: string;
|
|
603
|
+
sender: string | null;
|
|
604
|
+
outcome: 'processing' | 'accepted' | 'rejected_sender' | 'rejected_auth' | 'no_documents' | 'no_balance' | 'failed';
|
|
605
|
+
documents: number;
|
|
606
|
+
skipped: number;
|
|
607
|
+
batch_id: string | null;
|
|
608
|
+
replied_at: string | null;
|
|
609
|
+
};
|
|
427
610
|
export type Organization = {
|
|
428
611
|
id: string;
|
|
429
612
|
object: 'organization';
|
|
@@ -465,7 +648,7 @@ export type File = {
|
|
|
465
648
|
* Сколько страниц прогон, по оценке, оплатит до старта; прогон оплачивает фактическое число
|
|
466
649
|
*/
|
|
467
650
|
pages_estimate: number | null;
|
|
468
|
-
source: 'api' | 'my' | 'mcp' | 'demo' | 'agent';
|
|
651
|
+
source: 'api' | 'my' | 'mcp' | 'demo' | 'agent' | 'email';
|
|
469
652
|
/**
|
|
470
653
|
* Когда файл будет удалён по сроку хранения файлов организации
|
|
471
654
|
*/
|
|
@@ -501,6 +684,50 @@ export type Typizer = {
|
|
|
501
684
|
* `precise` перепроверяет извлечение (оплачивается больше страниц)
|
|
502
685
|
*/
|
|
503
686
|
mode: 'standard' | 'precise';
|
|
687
|
+
/**
|
|
688
|
+
* Откуда типизатор в каталоге; `null` — создан не из каталога
|
|
689
|
+
*/
|
|
690
|
+
catalog_source: {
|
|
691
|
+
/**
|
|
692
|
+
* `null`, если схема больше не видна организации
|
|
693
|
+
*/
|
|
694
|
+
entry_id: string | null;
|
|
695
|
+
ref: string | null;
|
|
696
|
+
title: string;
|
|
697
|
+
publisher: {
|
|
698
|
+
/**
|
|
699
|
+
* `null` у Typizer
|
|
700
|
+
*/
|
|
701
|
+
id: string | null;
|
|
702
|
+
slug: string;
|
|
703
|
+
display_name: string;
|
|
704
|
+
/**
|
|
705
|
+
* `official` — схема Typizer, `verified` — организация подтверждена, `partner` — партнёр Typizer
|
|
706
|
+
*/
|
|
707
|
+
badges: Array<'official' | 'verified' | 'partner'>;
|
|
708
|
+
} | null;
|
|
709
|
+
/**
|
|
710
|
+
* `installed` — добавлена к себе как есть; `forked` — создана на основе и изменяется организацией
|
|
711
|
+
*/
|
|
712
|
+
relation: 'installed' | 'forked';
|
|
713
|
+
/**
|
|
714
|
+
* Версия схемы, которой соответствует типизатор (или основа копии)
|
|
715
|
+
*/
|
|
716
|
+
version: string;
|
|
717
|
+
status: 'active' | 'removed';
|
|
718
|
+
/**
|
|
719
|
+
* `true` только у добавленной официальной схемы: её минорные версии приходят сами. Схемы сообщества сами не обновляются — новая версия предлагается в `update`
|
|
720
|
+
*/
|
|
721
|
+
auto_update: boolean;
|
|
722
|
+
/**
|
|
723
|
+
* Доступное обновление: смотрите и применяйте через `catalog_update`
|
|
724
|
+
*/
|
|
725
|
+
update: {
|
|
726
|
+
version: string;
|
|
727
|
+
breaking: boolean;
|
|
728
|
+
changelog: string;
|
|
729
|
+
} | null;
|
|
730
|
+
} | null;
|
|
504
731
|
created_at: string;
|
|
505
732
|
updated_at: string;
|
|
506
733
|
};
|
|
@@ -585,18 +812,332 @@ export type TypizerVersion = {
|
|
|
585
812
|
instructions: string;
|
|
586
813
|
created_at: string;
|
|
587
814
|
};
|
|
815
|
+
export type CatalogPublisher = {
|
|
816
|
+
id: string | null;
|
|
817
|
+
object: 'catalog_publisher';
|
|
818
|
+
slug: string;
|
|
819
|
+
display_name: string;
|
|
820
|
+
badges: Array<'official' | 'verified' | 'partner'>;
|
|
821
|
+
about: string | null;
|
|
822
|
+
website: string | null;
|
|
823
|
+
since: string;
|
|
824
|
+
stats: {
|
|
825
|
+
entries: number;
|
|
826
|
+
orgs_30d: number | null;
|
|
827
|
+
};
|
|
828
|
+
entries: Array<CatalogEntryBrief>;
|
|
829
|
+
};
|
|
830
|
+
export type CatalogEntryBrief = {
|
|
831
|
+
id: string;
|
|
832
|
+
object: 'catalog_entry';
|
|
833
|
+
/**
|
|
834
|
+
* Ссылка для `catalog` в `POST /v1/extract`: `slug` или `publisher/slug`; можно добавить `@1` или `@1.2.0`
|
|
835
|
+
*/
|
|
836
|
+
ref: string;
|
|
837
|
+
kind: 'official' | 'community';
|
|
838
|
+
slug: string;
|
|
839
|
+
title: string;
|
|
840
|
+
summary: string;
|
|
841
|
+
/**
|
|
842
|
+
* Категория: `invoices` — счета и счета-фактуры, `bank` — банк и касса, `shipping` — отгрузка и перевозка, `contracts` — работы, сметы и договоры, `registries` — реестры и выписки, `hr` — кадровые документы, `identity` — удостоверения и авто. Раздела `medical` больше нет — ошибка 400
|
|
843
|
+
*/
|
|
844
|
+
category: 'invoices' | 'bank' | 'shipping' | 'contracts' | 'registries' | 'hr' | 'identity';
|
|
845
|
+
tags: Array<string>;
|
|
846
|
+
publisher: CatalogPublisherBrief;
|
|
847
|
+
featured: boolean;
|
|
848
|
+
latest_version: CatalogVersionBrief;
|
|
849
|
+
/**
|
|
850
|
+
* До 6 полей верхнего уровня для карточки
|
|
851
|
+
*/
|
|
852
|
+
fields_preview: Array<string>;
|
|
853
|
+
stats: {
|
|
854
|
+
/**
|
|
855
|
+
* Сколько организаций пользовались схемой за 30 дней; `null`, если меньше 5 («Новая»)
|
|
856
|
+
*/
|
|
857
|
+
orgs_30d: number | null;
|
|
858
|
+
favorites: number;
|
|
859
|
+
};
|
|
860
|
+
/**
|
|
861
|
+
* Страница схемы на typizer.ru (у официальных)
|
|
862
|
+
*/
|
|
863
|
+
web_url: string | null;
|
|
864
|
+
updated_at: string;
|
|
865
|
+
viewer: {
|
|
866
|
+
favorited: boolean;
|
|
867
|
+
/**
|
|
868
|
+
* Типизаторов вашей организации из этой схемы
|
|
869
|
+
*/
|
|
870
|
+
typizer_count: number;
|
|
871
|
+
};
|
|
872
|
+
};
|
|
873
|
+
export type CatalogPublisherBrief = {
|
|
874
|
+
/**
|
|
875
|
+
* `null` у Typizer
|
|
876
|
+
*/
|
|
877
|
+
id: string | null;
|
|
878
|
+
slug: string;
|
|
879
|
+
display_name: string;
|
|
880
|
+
/**
|
|
881
|
+
* `official` — схема Typizer, `verified` — организация подтверждена, `partner` — партнёр Typizer
|
|
882
|
+
*/
|
|
883
|
+
badges: Array<'official' | 'verified' | 'partner'>;
|
|
884
|
+
};
|
|
885
|
+
/**
|
|
886
|
+
* Последняя версия старшего мажора
|
|
887
|
+
*/
|
|
888
|
+
export type CatalogVersionBrief = {
|
|
889
|
+
id: string;
|
|
890
|
+
object: 'catalog_version';
|
|
891
|
+
version: string;
|
|
892
|
+
major: number;
|
|
893
|
+
/**
|
|
894
|
+
* Ломающие изменения относительно прошлой версии
|
|
895
|
+
*/
|
|
896
|
+
breaking: boolean;
|
|
897
|
+
changelog: string;
|
|
898
|
+
field_count: number;
|
|
899
|
+
published_at: string;
|
|
900
|
+
};
|
|
901
|
+
export type CatalogPublisherRequest = {
|
|
902
|
+
/**
|
|
903
|
+
* Адрес автора: латиница, цифры и дефис, 2–32 знака. После первой публикации не меняется
|
|
904
|
+
*/
|
|
905
|
+
slug: string;
|
|
906
|
+
display_name: string;
|
|
907
|
+
about?: string | null;
|
|
908
|
+
website?: string | null;
|
|
909
|
+
};
|
|
910
|
+
export type CatalogOwnEntry = CatalogEntryBrief & {
|
|
911
|
+
visibility: 'private' | 'unlisted' | 'public';
|
|
912
|
+
review_state: 'none' | 'pending' | 'approved' | 'rejected';
|
|
913
|
+
review_note: string | null;
|
|
914
|
+
hidden: boolean;
|
|
915
|
+
/**
|
|
916
|
+
* Ваш типизатор, из которого опубликована схема
|
|
917
|
+
*/
|
|
918
|
+
source_typizer_id: string | null;
|
|
919
|
+
};
|
|
920
|
+
export type CatalogList = {
|
|
921
|
+
object: 'list';
|
|
922
|
+
data: Array<CatalogEntryBrief>;
|
|
923
|
+
has_more: boolean;
|
|
924
|
+
/**
|
|
925
|
+
* Передайте в `cursor`, чтобы получить следующую страницу
|
|
926
|
+
*/
|
|
927
|
+
next_cursor: string | null;
|
|
928
|
+
};
|
|
929
|
+
export type CatalogInstallRequest = {
|
|
930
|
+
/**
|
|
931
|
+
* Мажор (`1` — последняя 1.x) или точная версия (`1.2.0`)
|
|
932
|
+
*/
|
|
933
|
+
version?: string;
|
|
934
|
+
/**
|
|
935
|
+
* Название типизатора; по умолчанию — название схемы
|
|
936
|
+
*/
|
|
937
|
+
name?: string;
|
|
938
|
+
};
|
|
939
|
+
export type CatalogFavorite = {
|
|
940
|
+
object: 'catalog_favorite';
|
|
941
|
+
entry_id: string;
|
|
942
|
+
favorited: boolean;
|
|
943
|
+
};
|
|
944
|
+
export type CatalogReport = {
|
|
945
|
+
id: string;
|
|
946
|
+
object: 'catalog_report';
|
|
947
|
+
status: 'open';
|
|
948
|
+
};
|
|
949
|
+
export type CatalogReportRequest = {
|
|
950
|
+
/**
|
|
951
|
+
* `pii` — персональные данные (схема сразу скрывается до проверки), `plagiarism` — чужая схема, `broken` — не работает, `spam`, `other`. Официальные схемы: только `broken` и `other`
|
|
952
|
+
*/
|
|
953
|
+
reason: 'pii' | 'plagiarism' | 'broken' | 'spam' | 'other';
|
|
954
|
+
details?: string;
|
|
955
|
+
/**
|
|
956
|
+
* Мажор (`1` — последняя 1.x) или точная версия (`1.2.0`)
|
|
957
|
+
*/
|
|
958
|
+
version?: string;
|
|
959
|
+
};
|
|
960
|
+
export type CatalogEntry = {
|
|
961
|
+
id: string;
|
|
962
|
+
object: 'catalog_entry';
|
|
963
|
+
/**
|
|
964
|
+
* Ссылка для `catalog` в `POST /v1/extract`: `slug` или `publisher/slug`; можно добавить `@1` или `@1.2.0`
|
|
965
|
+
*/
|
|
966
|
+
ref: string;
|
|
967
|
+
kind: 'official' | 'community';
|
|
968
|
+
slug: string;
|
|
969
|
+
title: string;
|
|
970
|
+
summary: string;
|
|
971
|
+
/**
|
|
972
|
+
* Категория: `invoices` — счета и счета-фактуры, `bank` — банк и касса, `shipping` — отгрузка и перевозка, `contracts` — работы, сметы и договоры, `registries` — реестры и выписки, `hr` — кадровые документы, `identity` — удостоверения и авто. Раздела `medical` больше нет — ошибка 400
|
|
973
|
+
*/
|
|
974
|
+
category: 'invoices' | 'bank' | 'shipping' | 'contracts' | 'registries' | 'hr' | 'identity';
|
|
975
|
+
tags: Array<string>;
|
|
976
|
+
publisher: CatalogPublisherBrief;
|
|
977
|
+
featured: boolean;
|
|
978
|
+
latest_version: CatalogVersionBrief;
|
|
979
|
+
/**
|
|
980
|
+
* До 6 полей верхнего уровня для карточки
|
|
981
|
+
*/
|
|
982
|
+
fields_preview: Array<string>;
|
|
983
|
+
stats: {
|
|
984
|
+
/**
|
|
985
|
+
* Сколько организаций пользовались схемой за 30 дней; `null`, если меньше 5 («Новая»)
|
|
986
|
+
*/
|
|
987
|
+
orgs_30d: number | null;
|
|
988
|
+
favorites: number;
|
|
989
|
+
};
|
|
990
|
+
/**
|
|
991
|
+
* Страница схемы на typizer.ru (у официальных)
|
|
992
|
+
*/
|
|
993
|
+
web_url: string | null;
|
|
994
|
+
updated_at: string;
|
|
995
|
+
/**
|
|
996
|
+
* Описание в Markdown (схемы сообщества)
|
|
997
|
+
*/
|
|
998
|
+
description: string | null;
|
|
999
|
+
prompt: string | null;
|
|
1000
|
+
visibility: 'private' | 'unlisted' | 'public';
|
|
1001
|
+
version: CatalogVersion;
|
|
1002
|
+
majors: Array<{
|
|
1003
|
+
major: number;
|
|
1004
|
+
latest: string;
|
|
1005
|
+
}>;
|
|
1006
|
+
/**
|
|
1007
|
+
* На основе какой схемы каталога сделана эта
|
|
1008
|
+
*/
|
|
1009
|
+
lineage: {
|
|
1010
|
+
entry_id: string | null;
|
|
1011
|
+
ref: string | null;
|
|
1012
|
+
title: string;
|
|
1013
|
+
version: string;
|
|
1014
|
+
status: 'active' | 'removed' | 'private';
|
|
1015
|
+
} | null;
|
|
1016
|
+
viewer: {
|
|
1017
|
+
favorited: boolean;
|
|
1018
|
+
typizers: Array<{
|
|
1019
|
+
id: string;
|
|
1020
|
+
name: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* `installed` — добавлена к себе как есть; `forked` — создана на основе и изменяется организацией
|
|
1023
|
+
*/
|
|
1024
|
+
relation: 'installed' | 'forked';
|
|
1025
|
+
version: string;
|
|
1026
|
+
}>;
|
|
1027
|
+
};
|
|
1028
|
+
/**
|
|
1029
|
+
* Только владельцу или администратору организации-автора
|
|
1030
|
+
*/
|
|
1031
|
+
owner?: {
|
|
1032
|
+
review_state: 'none' | 'pending' | 'approved' | 'rejected';
|
|
1033
|
+
review_note: string | null;
|
|
1034
|
+
hidden: boolean;
|
|
1035
|
+
source_typizer_id: string | null;
|
|
1036
|
+
};
|
|
1037
|
+
created_at: string;
|
|
1038
|
+
};
|
|
1039
|
+
/**
|
|
1040
|
+
* Запрошенная версия (`?version=`) или последняя
|
|
1041
|
+
*/
|
|
1042
|
+
export type CatalogVersion = CatalogVersionBrief & {
|
|
1043
|
+
schema: {
|
|
1044
|
+
[key: string]: unknown;
|
|
1045
|
+
};
|
|
1046
|
+
instructions: string;
|
|
1047
|
+
/**
|
|
1048
|
+
* Пример ответа на вымышленных данных (только у официальных схем)
|
|
1049
|
+
*/
|
|
1050
|
+
example_output: {
|
|
1051
|
+
[key: string]: unknown;
|
|
1052
|
+
} | null;
|
|
1053
|
+
/**
|
|
1054
|
+
* Изменения относительно прошлой версии
|
|
1055
|
+
*/
|
|
1056
|
+
changes: Array<SchemaChange>;
|
|
1057
|
+
};
|
|
1058
|
+
export type SchemaChange = {
|
|
1059
|
+
/**
|
|
1060
|
+
* Путь к полю: `a.b`, `items[].x`; пустая строка — корень схемы
|
|
1061
|
+
*/
|
|
1062
|
+
path: string;
|
|
1063
|
+
kind: 'added' | 'removed' | 'type_changed' | 'required_added' | 'required_removed' | 'enum_narrowed' | 'enum_widened' | 'format_changed' | 'check_changed' | 'description_changed' | 'order_changed';
|
|
1064
|
+
breaking: boolean;
|
|
1065
|
+
};
|
|
1066
|
+
export type PublishTypizerRequest = {
|
|
1067
|
+
/**
|
|
1068
|
+
* Обязателен при первой публикации; потом не меняется
|
|
1069
|
+
*/
|
|
1070
|
+
slug?: string;
|
|
1071
|
+
title: string;
|
|
1072
|
+
summary: string;
|
|
1073
|
+
description?: string | null;
|
|
1074
|
+
/**
|
|
1075
|
+
* Категория: `invoices` — счета и счета-фактуры, `bank` — банк и касса, `shipping` — отгрузка и перевозка, `contracts` — работы, сметы и договоры, `registries` — реестры и выписки, `hr` — кадровые документы, `identity` — удостоверения и авто. Раздела `medical` больше нет — ошибка 400
|
|
1076
|
+
*/
|
|
1077
|
+
category: 'invoices' | 'bank' | 'shipping' | 'contracts' | 'registries' | 'hr' | 'identity';
|
|
1078
|
+
tags?: Array<string>;
|
|
1079
|
+
/**
|
|
1080
|
+
* `unlisted` — доступна по ссылке, в каталоге не видна; `public` — в каталоге после проверки модератором
|
|
1081
|
+
*/
|
|
1082
|
+
visibility: 'unlisted' | 'public';
|
|
1083
|
+
changelog: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* Согласие с условиями и лицензией каталога
|
|
1086
|
+
*/
|
|
1087
|
+
accept_terms: true;
|
|
1088
|
+
};
|
|
1089
|
+
export type CatalogUpdate = {
|
|
1090
|
+
object: 'catalog_update';
|
|
1091
|
+
typizer_id: string;
|
|
1092
|
+
/**
|
|
1093
|
+
* `installed` — добавлена к себе как есть; `forked` — создана на основе и изменяется организацией
|
|
1094
|
+
*/
|
|
1095
|
+
relation: 'installed' | 'forked';
|
|
1096
|
+
from: string;
|
|
1097
|
+
to: string;
|
|
1098
|
+
breaking: boolean;
|
|
1099
|
+
changelog: Array<{
|
|
1100
|
+
version: string;
|
|
1101
|
+
notes: string;
|
|
1102
|
+
published_at: string;
|
|
1103
|
+
}>;
|
|
1104
|
+
changes: Array<SchemaChange & {
|
|
1105
|
+
/**
|
|
1106
|
+
* Узел схемы в новой версии (`null`, если поле удалено)
|
|
1107
|
+
*/
|
|
1108
|
+
upstream?: unknown;
|
|
1109
|
+
/**
|
|
1110
|
+
* Узел схемы в вашем типизаторе (`null`, если поля нет)
|
|
1111
|
+
*/
|
|
1112
|
+
local?: unknown;
|
|
1113
|
+
/**
|
|
1114
|
+
* Вы тоже меняли это поле
|
|
1115
|
+
*/
|
|
1116
|
+
conflict: boolean;
|
|
1117
|
+
}>;
|
|
1118
|
+
};
|
|
1119
|
+
export type CatalogUpdateRequest = {
|
|
1120
|
+
/**
|
|
1121
|
+
* Мажор (`1` — последняя 1.x) или точная версия (`1.2.0`)
|
|
1122
|
+
*/
|
|
1123
|
+
version: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Только для типизатора на основе схемы (`forked`): какие изменения подтянуть — пути из `changes` `GET catalog_update`, `#instructions` — инструкции
|
|
1126
|
+
*/
|
|
1127
|
+
paths?: Array<string>;
|
|
1128
|
+
};
|
|
588
1129
|
export type Run = {
|
|
589
1130
|
id: string;
|
|
590
1131
|
object: 'run';
|
|
591
1132
|
status: 'queued' | 'processing' | 'succeeded' | 'failed';
|
|
592
1133
|
/**
|
|
593
|
-
* `null` у прогонов `POST /v1/extract`
|
|
1134
|
+
* `null` у прогонов `POST /v1/extract` (разовая схема или схема из каталога)
|
|
594
1135
|
*/
|
|
595
1136
|
typizer_id: string | null;
|
|
596
1137
|
typizer_version: number | null;
|
|
597
1138
|
mode: 'standard' | 'precise';
|
|
598
1139
|
format: 'json' | 'xml' | 'csv' | 'xlsx';
|
|
599
|
-
source: 'api' | 'my' | 'mcp' | 'demo' | 'agent';
|
|
1140
|
+
source: 'api' | 'my' | 'mcp' | 'demo' | 'agent' | 'email';
|
|
600
1141
|
pages: {
|
|
601
1142
|
physical: number | null;
|
|
602
1143
|
billed: number | null;
|
|
@@ -622,6 +1163,14 @@ export type Run = {
|
|
|
622
1163
|
metadata: {
|
|
623
1164
|
[key: string]: string;
|
|
624
1165
|
};
|
|
1166
|
+
/**
|
|
1167
|
+
* Схема каталога, по которой сделан прогон; иначе `null`
|
|
1168
|
+
*/
|
|
1169
|
+
catalog: {
|
|
1170
|
+
entry_id: string;
|
|
1171
|
+
ref: string;
|
|
1172
|
+
version: string;
|
|
1173
|
+
} | null;
|
|
625
1174
|
created_at: string;
|
|
626
1175
|
completed_at: string | null;
|
|
627
1176
|
};
|
|
@@ -689,9 +1238,13 @@ export type ExtractRequest = {
|
|
|
689
1238
|
/**
|
|
690
1239
|
* Подмножество JSON Schema (draft 2020-12) с корнем `object`: не больше 200 полей и 10 уровней схемы (core), 131072 байт (128 КиБ) в компактном JSON в UTF-8, 64 уровней вложенности JSON (включая `examples`), и ни в одной строке нет NUL или непарного суррогата. Имена полей — буквы, десятичные цифры, `_` и `-`, начинаются с буквы или `_` (они становятся именами элементов XML). Порядок `properties` сохраняется: по нему идут столбцы результата, элементы XML и XSD.
|
|
691
1240
|
*/
|
|
692
|
-
schema
|
|
1241
|
+
schema?: {
|
|
693
1242
|
[key: string]: unknown;
|
|
694
1243
|
};
|
|
1244
|
+
/**
|
|
1245
|
+
* Схема из каталога вместо `schema`: `slug` или `publisher/slug`, по желанию с версией — `@1` (последняя 1.x) или `@1.2.0`. Без версии — последняя. Вместе с `catalog` нельзя передавать `instructions`: чтобы добавить свои указания, создайте типизатор на основе схемы
|
|
1246
|
+
*/
|
|
1247
|
+
catalog?: string;
|
|
695
1248
|
/**
|
|
696
1249
|
* Дополнительные указания для извлечения, передаются модели вместе со схемой
|
|
697
1250
|
*/
|
|
@@ -1707,6 +2260,34 @@ export type ListDemoSamplesResponses = {
|
|
|
1707
2260
|
200: DemoSampleList;
|
|
1708
2261
|
};
|
|
1709
2262
|
export type ListDemoSamplesResponse = ListDemoSamplesResponses[keyof ListDemoSamplesResponses];
|
|
2263
|
+
export type GetDemoQuotaData = {
|
|
2264
|
+
body?: never;
|
|
2265
|
+
path?: never;
|
|
2266
|
+
query?: never;
|
|
2267
|
+
url: '/v1/demo/quota';
|
|
2268
|
+
};
|
|
2269
|
+
export type GetDemoQuotaErrors = {
|
|
2270
|
+
/**
|
|
2271
|
+
* `rate_limited`: Превышен лимит запросов
|
|
2272
|
+
*/
|
|
2273
|
+
429: Problem;
|
|
2274
|
+
/**
|
|
2275
|
+
* `internal_error`: Внутренняя ошибка
|
|
2276
|
+
*/
|
|
2277
|
+
500: Problem;
|
|
2278
|
+
/**
|
|
2279
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
2280
|
+
*/
|
|
2281
|
+
503: Problem;
|
|
2282
|
+
};
|
|
2283
|
+
export type GetDemoQuotaError = GetDemoQuotaErrors[keyof GetDemoQuotaErrors];
|
|
2284
|
+
export type GetDemoQuotaResponses = {
|
|
2285
|
+
/**
|
|
2286
|
+
* Остаток на сегодня
|
|
2287
|
+
*/
|
|
2288
|
+
200: DemoQuota;
|
|
2289
|
+
};
|
|
2290
|
+
export type GetDemoQuotaResponse = GetDemoQuotaResponses[keyof GetDemoQuotaResponses];
|
|
1710
2291
|
export type CreateDemoRunData = {
|
|
1711
2292
|
body?: DemoRunRequest;
|
|
1712
2293
|
headers?: {
|
|
@@ -1813,11 +2394,106 @@ export type GetDemoRunResponses = {
|
|
|
1813
2394
|
200: DemoRun;
|
|
1814
2395
|
};
|
|
1815
2396
|
export type GetDemoRunResponse = GetDemoRunResponses[keyof GetDemoRunResponses];
|
|
1816
|
-
export type
|
|
2397
|
+
export type GetToolOcrQuotaData = {
|
|
1817
2398
|
body?: never;
|
|
1818
2399
|
path?: never;
|
|
1819
2400
|
query?: never;
|
|
1820
|
-
url: '/v1/
|
|
2401
|
+
url: '/v1/tools/ocr/quota';
|
|
2402
|
+
};
|
|
2403
|
+
export type GetToolOcrQuotaErrors = {
|
|
2404
|
+
/**
|
|
2405
|
+
* `rate_limited`: Превышен лимит запросов
|
|
2406
|
+
*/
|
|
2407
|
+
429: Problem;
|
|
2408
|
+
/**
|
|
2409
|
+
* `internal_error`: Внутренняя ошибка
|
|
2410
|
+
*/
|
|
2411
|
+
500: Problem;
|
|
2412
|
+
/**
|
|
2413
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
2414
|
+
*/
|
|
2415
|
+
503: Problem;
|
|
2416
|
+
};
|
|
2417
|
+
export type GetToolOcrQuotaError = GetToolOcrQuotaErrors[keyof GetToolOcrQuotaErrors];
|
|
2418
|
+
export type GetToolOcrQuotaResponses = {
|
|
2419
|
+
/**
|
|
2420
|
+
* Остаток на сегодня
|
|
2421
|
+
*/
|
|
2422
|
+
200: OcrQuota;
|
|
2423
|
+
};
|
|
2424
|
+
export type GetToolOcrQuotaResponse = GetToolOcrQuotaResponses[keyof GetToolOcrQuotaResponses];
|
|
2425
|
+
export type CreateToolOcrData = {
|
|
2426
|
+
body: {
|
|
2427
|
+
/**
|
|
2428
|
+
* PDF или изображение (PNG, JPEG, WebP, TIFF, BMP) до 10485760 байт
|
|
2429
|
+
*/
|
|
2430
|
+
file: Blob | File;
|
|
2431
|
+
/**
|
|
2432
|
+
* Согласие на обработку персональных данных (`pd-consent`, цель 2)
|
|
2433
|
+
*/
|
|
2434
|
+
consent_pd: 'true';
|
|
2435
|
+
/**
|
|
2436
|
+
* Текущая версия документа `pd-consent`
|
|
2437
|
+
*/
|
|
2438
|
+
consent_version: string;
|
|
2439
|
+
};
|
|
2440
|
+
headers?: {
|
|
2441
|
+
/**
|
|
2442
|
+
* Принимается для единообразия клиентов и в этой операции игнорируется: ничего не блокируется и не повторяется (некорректное значение всё же может получить 400).
|
|
2443
|
+
*/
|
|
2444
|
+
'Idempotency-Key'?: string;
|
|
2445
|
+
};
|
|
2446
|
+
path?: never;
|
|
2447
|
+
query?: never;
|
|
2448
|
+
url: '/v1/tools/ocr';
|
|
2449
|
+
};
|
|
2450
|
+
export type CreateToolOcrErrors = {
|
|
2451
|
+
/**
|
|
2452
|
+
* `invalid_request`: Некорректный запрос
|
|
2453
|
+
*/
|
|
2454
|
+
400: Problem;
|
|
2455
|
+
/**
|
|
2456
|
+
* `forbidden`: Доступ запрещён
|
|
2457
|
+
*/
|
|
2458
|
+
403: Problem;
|
|
2459
|
+
/**
|
|
2460
|
+
* `file_too_large`: Файл слишком большой
|
|
2461
|
+
*/
|
|
2462
|
+
413: Problem;
|
|
2463
|
+
/**
|
|
2464
|
+
* `unsupported_file_type`: Неподдерживаемый тип файла
|
|
2465
|
+
*/
|
|
2466
|
+
415: Problem;
|
|
2467
|
+
/**
|
|
2468
|
+
* `document_unreadable`: Документ не читается; `extraction_failed`: Извлечение не удалось
|
|
2469
|
+
*/
|
|
2470
|
+
422: Problem;
|
|
2471
|
+
/**
|
|
2472
|
+
* `rate_limited`: Превышен лимит запросов
|
|
2473
|
+
*/
|
|
2474
|
+
429: Problem;
|
|
2475
|
+
/**
|
|
2476
|
+
* `internal_error`: Внутренняя ошибка
|
|
2477
|
+
*/
|
|
2478
|
+
500: Problem;
|
|
2479
|
+
/**
|
|
2480
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
2481
|
+
*/
|
|
2482
|
+
503: Problem;
|
|
2483
|
+
};
|
|
2484
|
+
export type CreateToolOcrError = CreateToolOcrErrors[keyof CreateToolOcrErrors];
|
|
2485
|
+
export type CreateToolOcrResponses = {
|
|
2486
|
+
/**
|
|
2487
|
+
* Распознанный текст и таблицы
|
|
2488
|
+
*/
|
|
2489
|
+
200: OcrResult;
|
|
2490
|
+
};
|
|
2491
|
+
export type CreateToolOcrResponse = CreateToolOcrResponses[keyof CreateToolOcrResponses];
|
|
2492
|
+
export type GetStatusData = {
|
|
2493
|
+
body?: never;
|
|
2494
|
+
path?: never;
|
|
2495
|
+
query?: never;
|
|
2496
|
+
url: '/v1/status';
|
|
1821
2497
|
};
|
|
1822
2498
|
export type GetStatusErrors = {
|
|
1823
2499
|
/**
|
|
@@ -2222,19 +2898,23 @@ export type DeleteApiKeyResponses = {
|
|
|
2222
2898
|
200: DeletedApiKey;
|
|
2223
2899
|
};
|
|
2224
2900
|
export type DeleteApiKeyResponse = DeleteApiKeyResponses[keyof DeleteApiKeyResponses];
|
|
2225
|
-
export type
|
|
2226
|
-
body
|
|
2901
|
+
export type CreateConnectorLinkData = {
|
|
2902
|
+
body: CreateConnectorLinkRequest;
|
|
2227
2903
|
headers?: {
|
|
2228
2904
|
/**
|
|
2229
2905
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2230
2906
|
*/
|
|
2231
2907
|
'Typizer-Organization'?: string;
|
|
2908
|
+
/**
|
|
2909
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
2910
|
+
*/
|
|
2911
|
+
'Idempotency-Key'?: string;
|
|
2232
2912
|
};
|
|
2233
2913
|
path?: never;
|
|
2234
2914
|
query?: never;
|
|
2235
|
-
url: '/v1/
|
|
2915
|
+
url: '/v1/connector_links';
|
|
2236
2916
|
};
|
|
2237
|
-
export type
|
|
2917
|
+
export type CreateConnectorLinkErrors = {
|
|
2238
2918
|
/**
|
|
2239
2919
|
* `invalid_request`: Некорректный запрос
|
|
2240
2920
|
*/
|
|
@@ -2248,7 +2928,11 @@ export type DeleteOrganizationErrors = {
|
|
|
2248
2928
|
*/
|
|
2249
2929
|
403: Problem;
|
|
2250
2930
|
/**
|
|
2251
|
-
* `
|
|
2931
|
+
* `not_found`: Не найдено
|
|
2932
|
+
*/
|
|
2933
|
+
404: Problem;
|
|
2934
|
+
/**
|
|
2935
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
2252
2936
|
*/
|
|
2253
2937
|
409: Problem;
|
|
2254
2938
|
/**
|
|
@@ -2264,15 +2948,15 @@ export type DeleteOrganizationErrors = {
|
|
|
2264
2948
|
*/
|
|
2265
2949
|
503: Problem;
|
|
2266
2950
|
};
|
|
2267
|
-
export type
|
|
2268
|
-
export type
|
|
2951
|
+
export type CreateConnectorLinkError = CreateConnectorLinkErrors[keyof CreateConnectorLinkErrors];
|
|
2952
|
+
export type CreateConnectorLinkResponses = {
|
|
2269
2953
|
/**
|
|
2270
|
-
*
|
|
2954
|
+
* Ссылка; действует 15 минут и срабатывает один раз
|
|
2271
2955
|
*/
|
|
2272
|
-
|
|
2956
|
+
201: ConnectorLink;
|
|
2273
2957
|
};
|
|
2274
|
-
export type
|
|
2275
|
-
export type
|
|
2958
|
+
export type CreateConnectorLinkResponse = CreateConnectorLinkResponses[keyof CreateConnectorLinkResponses];
|
|
2959
|
+
export type GetConnectorLinkRequestData = {
|
|
2276
2960
|
body?: never;
|
|
2277
2961
|
headers?: {
|
|
2278
2962
|
/**
|
|
@@ -2280,15 +2964,13 @@ export type GetOrganizationData = {
|
|
|
2280
2964
|
*/
|
|
2281
2965
|
'Typizer-Organization'?: string;
|
|
2282
2966
|
};
|
|
2283
|
-
path
|
|
2967
|
+
path: {
|
|
2968
|
+
id: string;
|
|
2969
|
+
};
|
|
2284
2970
|
query?: never;
|
|
2285
|
-
url: '/v1/
|
|
2971
|
+
url: '/v1/connector_links/requests/{id}';
|
|
2286
2972
|
};
|
|
2287
|
-
export type
|
|
2288
|
-
/**
|
|
2289
|
-
* `invalid_request`: Некорректный запрос
|
|
2290
|
-
*/
|
|
2291
|
-
400: Problem;
|
|
2973
|
+
export type GetConnectorLinkRequestErrors = {
|
|
2292
2974
|
/**
|
|
2293
2975
|
* `unauthorized`: Не авторизовано
|
|
2294
2976
|
*/
|
|
@@ -2297,6 +2979,14 @@ export type GetOrganizationErrors = {
|
|
|
2297
2979
|
* `forbidden`: Доступ запрещён
|
|
2298
2980
|
*/
|
|
2299
2981
|
403: Problem;
|
|
2982
|
+
/**
|
|
2983
|
+
* `not_found`: Не найдено
|
|
2984
|
+
*/
|
|
2985
|
+
404: Problem;
|
|
2986
|
+
/**
|
|
2987
|
+
* `conflict`: Конфликт состояния
|
|
2988
|
+
*/
|
|
2989
|
+
409: Problem;
|
|
2300
2990
|
/**
|
|
2301
2991
|
* `rate_limited`: Превышен лимит запросов
|
|
2302
2992
|
*/
|
|
@@ -2310,27 +3000,33 @@ export type GetOrganizationErrors = {
|
|
|
2310
3000
|
*/
|
|
2311
3001
|
503: Problem;
|
|
2312
3002
|
};
|
|
2313
|
-
export type
|
|
2314
|
-
export type
|
|
3003
|
+
export type GetConnectorLinkRequestError = GetConnectorLinkRequestErrors[keyof GetConnectorLinkRequestErrors];
|
|
3004
|
+
export type GetConnectorLinkRequestResponses = {
|
|
2315
3005
|
/**
|
|
2316
|
-
*
|
|
3006
|
+
* Запрос, созданный виджетом в amoCRM
|
|
2317
3007
|
*/
|
|
2318
|
-
200:
|
|
3008
|
+
200: ConnectorLinkRequest;
|
|
2319
3009
|
};
|
|
2320
|
-
export type
|
|
2321
|
-
export type
|
|
2322
|
-
body
|
|
3010
|
+
export type GetConnectorLinkRequestResponse = GetConnectorLinkRequestResponses[keyof GetConnectorLinkRequestResponses];
|
|
3011
|
+
export type ApproveConnectorLinkRequestData = {
|
|
3012
|
+
body?: never;
|
|
2323
3013
|
headers?: {
|
|
2324
3014
|
/**
|
|
2325
3015
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2326
3016
|
*/
|
|
2327
3017
|
'Typizer-Organization'?: string;
|
|
3018
|
+
/**
|
|
3019
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
3020
|
+
*/
|
|
3021
|
+
'Idempotency-Key'?: string;
|
|
3022
|
+
};
|
|
3023
|
+
path: {
|
|
3024
|
+
id: string;
|
|
2328
3025
|
};
|
|
2329
|
-
path?: never;
|
|
2330
3026
|
query?: never;
|
|
2331
|
-
url: '/v1/
|
|
3027
|
+
url: '/v1/connector_links/requests/{id}/approve';
|
|
2332
3028
|
};
|
|
2333
|
-
export type
|
|
3029
|
+
export type ApproveConnectorLinkRequestErrors = {
|
|
2334
3030
|
/**
|
|
2335
3031
|
* `invalid_request`: Некорректный запрос
|
|
2336
3032
|
*/
|
|
@@ -2343,6 +3039,14 @@ export type UpdateOrganizationErrors = {
|
|
|
2343
3039
|
* `forbidden`: Доступ запрещён
|
|
2344
3040
|
*/
|
|
2345
3041
|
403: Problem;
|
|
3042
|
+
/**
|
|
3043
|
+
* `not_found`: Не найдено
|
|
3044
|
+
*/
|
|
3045
|
+
404: Problem;
|
|
3046
|
+
/**
|
|
3047
|
+
* `conflict`: Конфликт состояния; `idempotency_conflict`: Конфликт идемпотентности
|
|
3048
|
+
*/
|
|
3049
|
+
409: Problem;
|
|
2346
3050
|
/**
|
|
2347
3051
|
* `rate_limited`: Превышен лимит запросов
|
|
2348
3052
|
*/
|
|
@@ -2356,21 +3060,16 @@ export type UpdateOrganizationErrors = {
|
|
|
2356
3060
|
*/
|
|
2357
3061
|
503: Problem;
|
|
2358
3062
|
};
|
|
2359
|
-
export type
|
|
2360
|
-
export type
|
|
3063
|
+
export type ApproveConnectorLinkRequestError = ApproveConnectorLinkRequestErrors[keyof ApproveConnectorLinkRequestErrors];
|
|
3064
|
+
export type ApproveConnectorLinkRequestResponses = {
|
|
2361
3065
|
/**
|
|
2362
|
-
*
|
|
3066
|
+
* Адрес авторизации
|
|
2363
3067
|
*/
|
|
2364
|
-
200:
|
|
3068
|
+
200: ConnectorLinkAuthorization;
|
|
2365
3069
|
};
|
|
2366
|
-
export type
|
|
2367
|
-
export type
|
|
2368
|
-
body
|
|
2369
|
-
/**
|
|
2370
|
-
* Документ, не больше 52428800 байт (50 МиБ)
|
|
2371
|
-
*/
|
|
2372
|
-
file: Blob | File;
|
|
2373
|
-
};
|
|
3070
|
+
export type ApproveConnectorLinkRequestResponse = ApproveConnectorLinkRequestResponses[keyof ApproveConnectorLinkRequestResponses];
|
|
3071
|
+
export type RejectConnectorLinkRequestData = {
|
|
3072
|
+
body?: never;
|
|
2374
3073
|
headers?: {
|
|
2375
3074
|
/**
|
|
2376
3075
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
@@ -2381,13 +3080,15 @@ export type CreateFileData = {
|
|
|
2381
3080
|
*/
|
|
2382
3081
|
'Idempotency-Key'?: string;
|
|
2383
3082
|
};
|
|
2384
|
-
path
|
|
3083
|
+
path: {
|
|
3084
|
+
id: string;
|
|
3085
|
+
};
|
|
2385
3086
|
query?: never;
|
|
2386
|
-
url: '/v1/
|
|
3087
|
+
url: '/v1/connector_links/requests/{id}/reject';
|
|
2387
3088
|
};
|
|
2388
|
-
export type
|
|
3089
|
+
export type RejectConnectorLinkRequestErrors = {
|
|
2389
3090
|
/**
|
|
2390
|
-
* `invalid_request`: Некорректный
|
|
3091
|
+
* `invalid_request`: Некорректный запрос
|
|
2391
3092
|
*/
|
|
2392
3093
|
400: Problem;
|
|
2393
3094
|
/**
|
|
@@ -2395,25 +3096,17 @@ export type CreateFileErrors = {
|
|
|
2395
3096
|
*/
|
|
2396
3097
|
401: Problem;
|
|
2397
3098
|
/**
|
|
2398
|
-
* `
|
|
3099
|
+
* `forbidden`: Доступ запрещён
|
|
2399
3100
|
*/
|
|
2400
3101
|
403: Problem;
|
|
2401
3102
|
/**
|
|
2402
|
-
* `
|
|
2403
|
-
*/
|
|
2404
|
-
409: Problem;
|
|
2405
|
-
/**
|
|
2406
|
-
* `file_too_large`: Файл слишком большой
|
|
2407
|
-
*/
|
|
2408
|
-
413: Problem;
|
|
2409
|
-
/**
|
|
2410
|
-
* `unsupported_file_type`: Неподдерживаемый тип файла
|
|
3103
|
+
* `not_found`: Не найдено
|
|
2411
3104
|
*/
|
|
2412
|
-
|
|
3105
|
+
404: Problem;
|
|
2413
3106
|
/**
|
|
2414
|
-
* `
|
|
3107
|
+
* `conflict`: Конфликт состояния; `idempotency_conflict`: Конфликт идемпотентности
|
|
2415
3108
|
*/
|
|
2416
|
-
|
|
3109
|
+
409: Problem;
|
|
2417
3110
|
/**
|
|
2418
3111
|
* `rate_limited`: Превышен лимит запросов
|
|
2419
3112
|
*/
|
|
@@ -2427,15 +3120,15 @@ export type CreateFileErrors = {
|
|
|
2427
3120
|
*/
|
|
2428
3121
|
503: Problem;
|
|
2429
3122
|
};
|
|
2430
|
-
export type
|
|
2431
|
-
export type
|
|
3123
|
+
export type RejectConnectorLinkRequestError = RejectConnectorLinkRequestErrors[keyof RejectConnectorLinkRequestErrors];
|
|
3124
|
+
export type RejectConnectorLinkRequestResponses = {
|
|
2432
3125
|
/**
|
|
2433
|
-
*
|
|
3126
|
+
* Запрос удалён
|
|
2434
3127
|
*/
|
|
2435
|
-
|
|
3128
|
+
200: ConnectorLinkRequestRejected;
|
|
2436
3129
|
};
|
|
2437
|
-
export type
|
|
2438
|
-
export type
|
|
3130
|
+
export type RejectConnectorLinkRequestResponse = RejectConnectorLinkRequestResponses[keyof RejectConnectorLinkRequestResponses];
|
|
3131
|
+
export type ListInboundMailboxesData = {
|
|
2439
3132
|
body?: never;
|
|
2440
3133
|
headers?: {
|
|
2441
3134
|
/**
|
|
@@ -2443,23 +3136,17 @@ export type DeleteFileData = {
|
|
|
2443
3136
|
*/
|
|
2444
3137
|
'Typizer-Organization'?: string;
|
|
2445
3138
|
};
|
|
2446
|
-
path
|
|
2447
|
-
id: string;
|
|
2448
|
-
};
|
|
3139
|
+
path?: never;
|
|
2449
3140
|
query?: never;
|
|
2450
|
-
url: '/v1/
|
|
3141
|
+
url: '/v1/inbound_mailboxes';
|
|
2451
3142
|
};
|
|
2452
|
-
export type
|
|
2453
|
-
/**
|
|
2454
|
-
* `invalid_id`: Некорректный идентификатор
|
|
2455
|
-
*/
|
|
2456
|
-
400: Problem;
|
|
3143
|
+
export type ListInboundMailboxesErrors = {
|
|
2457
3144
|
/**
|
|
2458
3145
|
* `unauthorized`: Не авторизовано
|
|
2459
3146
|
*/
|
|
2460
3147
|
401: Problem;
|
|
2461
3148
|
/**
|
|
2462
|
-
* `
|
|
3149
|
+
* `forbidden`: Доступ запрещён
|
|
2463
3150
|
*/
|
|
2464
3151
|
403: Problem;
|
|
2465
3152
|
/**
|
|
@@ -2479,31 +3166,33 @@ export type DeleteFileErrors = {
|
|
|
2479
3166
|
*/
|
|
2480
3167
|
503: Problem;
|
|
2481
3168
|
};
|
|
2482
|
-
export type
|
|
2483
|
-
export type
|
|
3169
|
+
export type ListInboundMailboxesError = ListInboundMailboxesErrors[keyof ListInboundMailboxesErrors];
|
|
3170
|
+
export type ListInboundMailboxesResponses = {
|
|
2484
3171
|
/**
|
|
2485
|
-
*
|
|
3172
|
+
* Адреса организации
|
|
2486
3173
|
*/
|
|
2487
|
-
200:
|
|
3174
|
+
200: InboundMailboxList;
|
|
2488
3175
|
};
|
|
2489
|
-
export type
|
|
2490
|
-
export type
|
|
2491
|
-
body
|
|
3176
|
+
export type ListInboundMailboxesResponse = ListInboundMailboxesResponses[keyof ListInboundMailboxesResponses];
|
|
3177
|
+
export type CreateInboundMailboxData = {
|
|
3178
|
+
body: CreateInboundMailboxRequest;
|
|
2492
3179
|
headers?: {
|
|
2493
3180
|
/**
|
|
2494
3181
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2495
3182
|
*/
|
|
2496
3183
|
'Typizer-Organization'?: string;
|
|
3184
|
+
/**
|
|
3185
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
3186
|
+
*/
|
|
3187
|
+
'Idempotency-Key'?: string;
|
|
2497
3188
|
};
|
|
2498
|
-
path
|
|
2499
|
-
id: string;
|
|
2500
|
-
};
|
|
3189
|
+
path?: never;
|
|
2501
3190
|
query?: never;
|
|
2502
|
-
url: '/v1/
|
|
3191
|
+
url: '/v1/inbound_mailboxes';
|
|
2503
3192
|
};
|
|
2504
|
-
export type
|
|
3193
|
+
export type CreateInboundMailboxErrors = {
|
|
2505
3194
|
/**
|
|
2506
|
-
* `invalid_id`: Некорректный идентификатор
|
|
3195
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
2507
3196
|
*/
|
|
2508
3197
|
400: Problem;
|
|
2509
3198
|
/**
|
|
@@ -2511,13 +3200,17 @@ export type GetFileErrors = {
|
|
|
2511
3200
|
*/
|
|
2512
3201
|
401: Problem;
|
|
2513
3202
|
/**
|
|
2514
|
-
* `
|
|
3203
|
+
* `forbidden`: Доступ запрещён
|
|
2515
3204
|
*/
|
|
2516
3205
|
403: Problem;
|
|
2517
3206
|
/**
|
|
2518
3207
|
* `not_found`: Не найдено
|
|
2519
3208
|
*/
|
|
2520
3209
|
404: Problem;
|
|
3210
|
+
/**
|
|
3211
|
+
* `conflict`: Конфликт состояния; `idempotency_conflict`: Конфликт идемпотентности
|
|
3212
|
+
*/
|
|
3213
|
+
409: Problem;
|
|
2521
3214
|
/**
|
|
2522
3215
|
* `rate_limited`: Превышен лимит запросов
|
|
2523
3216
|
*/
|
|
@@ -2531,15 +3224,15 @@ export type GetFileErrors = {
|
|
|
2531
3224
|
*/
|
|
2532
3225
|
503: Problem;
|
|
2533
3226
|
};
|
|
2534
|
-
export type
|
|
2535
|
-
export type
|
|
3227
|
+
export type CreateInboundMailboxError = CreateInboundMailboxErrors[keyof CreateInboundMailboxErrors];
|
|
3228
|
+
export type CreateInboundMailboxResponses = {
|
|
2536
3229
|
/**
|
|
2537
|
-
*
|
|
3230
|
+
* Адрес
|
|
2538
3231
|
*/
|
|
2539
|
-
|
|
3232
|
+
201: InboundMailbox;
|
|
2540
3233
|
};
|
|
2541
|
-
export type
|
|
2542
|
-
export type
|
|
3234
|
+
export type CreateInboundMailboxResponse = CreateInboundMailboxResponses[keyof CreateInboundMailboxResponses];
|
|
3235
|
+
export type DeleteInboundMailboxData = {
|
|
2543
3236
|
body?: never;
|
|
2544
3237
|
headers?: {
|
|
2545
3238
|
/**
|
|
@@ -2551,9 +3244,9 @@ export type GetFileContentData = {
|
|
|
2551
3244
|
id: string;
|
|
2552
3245
|
};
|
|
2553
3246
|
query?: never;
|
|
2554
|
-
url: '/v1/
|
|
3247
|
+
url: '/v1/inbound_mailboxes/{id}';
|
|
2555
3248
|
};
|
|
2556
|
-
export type
|
|
3249
|
+
export type DeleteInboundMailboxErrors = {
|
|
2557
3250
|
/**
|
|
2558
3251
|
* `invalid_id`: Некорректный идентификатор
|
|
2559
3252
|
*/
|
|
@@ -2563,7 +3256,7 @@ export type GetFileContentErrors = {
|
|
|
2563
3256
|
*/
|
|
2564
3257
|
401: Problem;
|
|
2565
3258
|
/**
|
|
2566
|
-
* `
|
|
3259
|
+
* `forbidden`: Доступ запрещён
|
|
2567
3260
|
*/
|
|
2568
3261
|
403: Problem;
|
|
2569
3262
|
/**
|
|
@@ -2583,36 +3276,29 @@ export type GetFileContentErrors = {
|
|
|
2583
3276
|
*/
|
|
2584
3277
|
503: Problem;
|
|
2585
3278
|
};
|
|
2586
|
-
export type
|
|
2587
|
-
export type
|
|
3279
|
+
export type DeleteInboundMailboxError = DeleteInboundMailboxErrors[keyof DeleteInboundMailboxErrors];
|
|
3280
|
+
export type DeleteInboundMailboxResponses = {
|
|
2588
3281
|
/**
|
|
2589
|
-
*
|
|
3282
|
+
* Удалён
|
|
2590
3283
|
*/
|
|
2591
|
-
200:
|
|
3284
|
+
200: DeletedInboundMailbox;
|
|
2592
3285
|
};
|
|
2593
|
-
export type
|
|
2594
|
-
export type
|
|
2595
|
-
body
|
|
3286
|
+
export type DeleteInboundMailboxResponse = DeleteInboundMailboxResponses[keyof DeleteInboundMailboxResponses];
|
|
3287
|
+
export type UpdateInboundMailboxData = {
|
|
3288
|
+
body: UpdateInboundMailboxRequest;
|
|
2596
3289
|
headers?: {
|
|
2597
3290
|
/**
|
|
2598
3291
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2599
3292
|
*/
|
|
2600
3293
|
'Typizer-Organization'?: string;
|
|
2601
3294
|
};
|
|
2602
|
-
path
|
|
2603
|
-
|
|
2604
|
-
/**
|
|
2605
|
-
* Элементов на странице, 1–100
|
|
2606
|
-
*/
|
|
2607
|
-
limit?: number;
|
|
2608
|
-
/**
|
|
2609
|
-
* `next_cursor` предыдущей страницы: список продолжается после этого идентификатора
|
|
2610
|
-
*/
|
|
2611
|
-
starting_after?: string;
|
|
3295
|
+
path: {
|
|
3296
|
+
id: string;
|
|
2612
3297
|
};
|
|
2613
|
-
|
|
3298
|
+
query?: never;
|
|
3299
|
+
url: '/v1/inbound_mailboxes/{id}';
|
|
2614
3300
|
};
|
|
2615
|
-
export type
|
|
3301
|
+
export type UpdateInboundMailboxErrors = {
|
|
2616
3302
|
/**
|
|
2617
3303
|
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
2618
3304
|
*/
|
|
@@ -2622,9 +3308,1476 @@ export type ListTypizersErrors = {
|
|
|
2622
3308
|
*/
|
|
2623
3309
|
401: Problem;
|
|
2624
3310
|
/**
|
|
2625
|
-
* `
|
|
3311
|
+
* `forbidden`: Доступ запрещён
|
|
3312
|
+
*/
|
|
3313
|
+
403: Problem;
|
|
3314
|
+
/**
|
|
3315
|
+
* `not_found`: Не найдено
|
|
3316
|
+
*/
|
|
3317
|
+
404: Problem;
|
|
3318
|
+
/**
|
|
3319
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3320
|
+
*/
|
|
3321
|
+
429: Problem;
|
|
3322
|
+
/**
|
|
3323
|
+
* `internal_error`: Внутренняя ошибка
|
|
3324
|
+
*/
|
|
3325
|
+
500: Problem;
|
|
3326
|
+
/**
|
|
3327
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3328
|
+
*/
|
|
3329
|
+
503: Problem;
|
|
3330
|
+
};
|
|
3331
|
+
export type UpdateInboundMailboxError = UpdateInboundMailboxErrors[keyof UpdateInboundMailboxErrors];
|
|
3332
|
+
export type UpdateInboundMailboxResponses = {
|
|
3333
|
+
/**
|
|
3334
|
+
* Адрес после изменения
|
|
3335
|
+
*/
|
|
3336
|
+
200: InboundMailbox;
|
|
3337
|
+
};
|
|
3338
|
+
export type UpdateInboundMailboxResponse = UpdateInboundMailboxResponses[keyof UpdateInboundMailboxResponses];
|
|
3339
|
+
export type RotateInboundMailboxData = {
|
|
3340
|
+
body?: never;
|
|
3341
|
+
headers?: {
|
|
3342
|
+
/**
|
|
3343
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3344
|
+
*/
|
|
3345
|
+
'Typizer-Organization'?: string;
|
|
3346
|
+
/**
|
|
3347
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
3348
|
+
*/
|
|
3349
|
+
'Idempotency-Key'?: string;
|
|
3350
|
+
};
|
|
3351
|
+
path: {
|
|
3352
|
+
id: string;
|
|
3353
|
+
};
|
|
3354
|
+
query?: never;
|
|
3355
|
+
url: '/v1/inbound_mailboxes/{id}/rotate';
|
|
3356
|
+
};
|
|
3357
|
+
export type RotateInboundMailboxErrors = {
|
|
3358
|
+
/**
|
|
3359
|
+
* `invalid_id`: Некорректный идентификатор; `invalid_request`: Некорректный запрос
|
|
3360
|
+
*/
|
|
3361
|
+
400: Problem;
|
|
3362
|
+
/**
|
|
3363
|
+
* `unauthorized`: Не авторизовано
|
|
3364
|
+
*/
|
|
3365
|
+
401: Problem;
|
|
3366
|
+
/**
|
|
3367
|
+
* `forbidden`: Доступ запрещён
|
|
3368
|
+
*/
|
|
3369
|
+
403: Problem;
|
|
3370
|
+
/**
|
|
3371
|
+
* `not_found`: Не найдено
|
|
3372
|
+
*/
|
|
3373
|
+
404: Problem;
|
|
3374
|
+
/**
|
|
3375
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
3376
|
+
*/
|
|
3377
|
+
409: Problem;
|
|
3378
|
+
/**
|
|
3379
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3380
|
+
*/
|
|
3381
|
+
429: Problem;
|
|
3382
|
+
/**
|
|
3383
|
+
* `internal_error`: Внутренняя ошибка
|
|
3384
|
+
*/
|
|
3385
|
+
500: Problem;
|
|
3386
|
+
/**
|
|
3387
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3388
|
+
*/
|
|
3389
|
+
503: Problem;
|
|
3390
|
+
};
|
|
3391
|
+
export type RotateInboundMailboxError = RotateInboundMailboxErrors[keyof RotateInboundMailboxErrors];
|
|
3392
|
+
export type RotateInboundMailboxResponses = {
|
|
3393
|
+
/**
|
|
3394
|
+
* Адрес с новым `address`
|
|
3395
|
+
*/
|
|
3396
|
+
200: InboundMailbox;
|
|
3397
|
+
};
|
|
3398
|
+
export type RotateInboundMailboxResponse = RotateInboundMailboxResponses[keyof RotateInboundMailboxResponses];
|
|
3399
|
+
export type ListInboundMessagesData = {
|
|
3400
|
+
body?: never;
|
|
3401
|
+
headers?: {
|
|
3402
|
+
/**
|
|
3403
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3404
|
+
*/
|
|
3405
|
+
'Typizer-Organization'?: string;
|
|
3406
|
+
};
|
|
3407
|
+
path: {
|
|
3408
|
+
id: string;
|
|
3409
|
+
};
|
|
3410
|
+
query?: {
|
|
3411
|
+
/**
|
|
3412
|
+
* Элементов на странице, 1–100
|
|
3413
|
+
*/
|
|
3414
|
+
limit?: number;
|
|
3415
|
+
/**
|
|
3416
|
+
* `next_cursor` предыдущей страницы: список продолжается после этого идентификатора
|
|
3417
|
+
*/
|
|
3418
|
+
starting_after?: string;
|
|
3419
|
+
};
|
|
3420
|
+
url: '/v1/inbound_mailboxes/{id}/messages';
|
|
3421
|
+
};
|
|
3422
|
+
export type ListInboundMessagesErrors = {
|
|
3423
|
+
/**
|
|
3424
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
3425
|
+
*/
|
|
3426
|
+
400: Problem;
|
|
3427
|
+
/**
|
|
3428
|
+
* `unauthorized`: Не авторизовано
|
|
3429
|
+
*/
|
|
3430
|
+
401: Problem;
|
|
3431
|
+
/**
|
|
3432
|
+
* `forbidden`: Доступ запрещён
|
|
3433
|
+
*/
|
|
3434
|
+
403: Problem;
|
|
3435
|
+
/**
|
|
3436
|
+
* `not_found`: Не найдено
|
|
3437
|
+
*/
|
|
3438
|
+
404: Problem;
|
|
3439
|
+
/**
|
|
3440
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3441
|
+
*/
|
|
3442
|
+
429: Problem;
|
|
3443
|
+
/**
|
|
3444
|
+
* `internal_error`: Внутренняя ошибка
|
|
3445
|
+
*/
|
|
3446
|
+
500: Problem;
|
|
3447
|
+
/**
|
|
3448
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3449
|
+
*/
|
|
3450
|
+
503: Problem;
|
|
3451
|
+
};
|
|
3452
|
+
export type ListInboundMessagesError = ListInboundMessagesErrors[keyof ListInboundMessagesErrors];
|
|
3453
|
+
export type ListInboundMessagesResponses = {
|
|
3454
|
+
/**
|
|
3455
|
+
* Страница журнала
|
|
3456
|
+
*/
|
|
3457
|
+
200: {
|
|
3458
|
+
object: 'list';
|
|
3459
|
+
data: Array<InboundMessage>;
|
|
3460
|
+
has_more: boolean;
|
|
3461
|
+
next_cursor: string | null;
|
|
3462
|
+
};
|
|
3463
|
+
};
|
|
3464
|
+
export type ListInboundMessagesResponse = ListInboundMessagesResponses[keyof ListInboundMessagesResponses];
|
|
3465
|
+
export type DeleteOrganizationData = {
|
|
3466
|
+
body?: never;
|
|
3467
|
+
headers?: {
|
|
3468
|
+
/**
|
|
3469
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3470
|
+
*/
|
|
3471
|
+
'Typizer-Organization'?: string;
|
|
3472
|
+
};
|
|
3473
|
+
path?: never;
|
|
3474
|
+
query?: never;
|
|
3475
|
+
url: '/v1/organization';
|
|
3476
|
+
};
|
|
3477
|
+
export type DeleteOrganizationErrors = {
|
|
3478
|
+
/**
|
|
3479
|
+
* `invalid_request`: Некорректный запрос
|
|
3480
|
+
*/
|
|
3481
|
+
400: Problem;
|
|
3482
|
+
/**
|
|
3483
|
+
* `unauthorized`: Не авторизовано
|
|
3484
|
+
*/
|
|
3485
|
+
401: Problem;
|
|
3486
|
+
/**
|
|
3487
|
+
* `forbidden`: Доступ запрещён
|
|
3488
|
+
*/
|
|
3489
|
+
403: Problem;
|
|
3490
|
+
/**
|
|
3491
|
+
* `conflict`: Конфликт состояния
|
|
3492
|
+
*/
|
|
3493
|
+
409: Problem;
|
|
3494
|
+
/**
|
|
3495
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3496
|
+
*/
|
|
3497
|
+
429: Problem;
|
|
3498
|
+
/**
|
|
3499
|
+
* `internal_error`: Внутренняя ошибка
|
|
3500
|
+
*/
|
|
3501
|
+
500: Problem;
|
|
3502
|
+
/**
|
|
3503
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3504
|
+
*/
|
|
3505
|
+
503: Problem;
|
|
3506
|
+
};
|
|
3507
|
+
export type DeleteOrganizationError = DeleteOrganizationErrors[keyof DeleteOrganizationErrors];
|
|
3508
|
+
export type DeleteOrganizationResponses = {
|
|
3509
|
+
/**
|
|
3510
|
+
* Организация удалена
|
|
3511
|
+
*/
|
|
3512
|
+
204: void;
|
|
3513
|
+
};
|
|
3514
|
+
export type DeleteOrganizationResponse = DeleteOrganizationResponses[keyof DeleteOrganizationResponses];
|
|
3515
|
+
export type GetOrganizationData = {
|
|
3516
|
+
body?: never;
|
|
3517
|
+
headers?: {
|
|
3518
|
+
/**
|
|
3519
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3520
|
+
*/
|
|
3521
|
+
'Typizer-Organization'?: string;
|
|
3522
|
+
};
|
|
3523
|
+
path?: never;
|
|
3524
|
+
query?: never;
|
|
3525
|
+
url: '/v1/organization';
|
|
3526
|
+
};
|
|
3527
|
+
export type GetOrganizationErrors = {
|
|
3528
|
+
/**
|
|
3529
|
+
* `invalid_request`: Некорректный запрос
|
|
3530
|
+
*/
|
|
3531
|
+
400: Problem;
|
|
3532
|
+
/**
|
|
3533
|
+
* `unauthorized`: Не авторизовано
|
|
3534
|
+
*/
|
|
3535
|
+
401: Problem;
|
|
3536
|
+
/**
|
|
3537
|
+
* `forbidden`: Доступ запрещён
|
|
3538
|
+
*/
|
|
3539
|
+
403: Problem;
|
|
3540
|
+
/**
|
|
3541
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3542
|
+
*/
|
|
3543
|
+
429: Problem;
|
|
3544
|
+
/**
|
|
3545
|
+
* `internal_error`: Внутренняя ошибка
|
|
3546
|
+
*/
|
|
3547
|
+
500: Problem;
|
|
3548
|
+
/**
|
|
3549
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3550
|
+
*/
|
|
3551
|
+
503: Problem;
|
|
3552
|
+
};
|
|
3553
|
+
export type GetOrganizationError = GetOrganizationErrors[keyof GetOrganizationErrors];
|
|
3554
|
+
export type GetOrganizationResponses = {
|
|
3555
|
+
/**
|
|
3556
|
+
* Организация
|
|
3557
|
+
*/
|
|
3558
|
+
200: Organization;
|
|
3559
|
+
};
|
|
3560
|
+
export type GetOrganizationResponse = GetOrganizationResponses[keyof GetOrganizationResponses];
|
|
3561
|
+
export type UpdateOrganizationData = {
|
|
3562
|
+
body: UpdateOrganizationRequest;
|
|
3563
|
+
headers?: {
|
|
3564
|
+
/**
|
|
3565
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3566
|
+
*/
|
|
3567
|
+
'Typizer-Organization'?: string;
|
|
3568
|
+
};
|
|
3569
|
+
path?: never;
|
|
3570
|
+
query?: never;
|
|
3571
|
+
url: '/v1/organization';
|
|
3572
|
+
};
|
|
3573
|
+
export type UpdateOrganizationErrors = {
|
|
3574
|
+
/**
|
|
3575
|
+
* `invalid_request`: Некорректный запрос
|
|
3576
|
+
*/
|
|
3577
|
+
400: Problem;
|
|
3578
|
+
/**
|
|
3579
|
+
* `unauthorized`: Не авторизовано
|
|
3580
|
+
*/
|
|
3581
|
+
401: Problem;
|
|
3582
|
+
/**
|
|
3583
|
+
* `forbidden`: Доступ запрещён
|
|
3584
|
+
*/
|
|
3585
|
+
403: Problem;
|
|
3586
|
+
/**
|
|
3587
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3588
|
+
*/
|
|
3589
|
+
429: Problem;
|
|
3590
|
+
/**
|
|
3591
|
+
* `internal_error`: Внутренняя ошибка
|
|
3592
|
+
*/
|
|
3593
|
+
500: Problem;
|
|
3594
|
+
/**
|
|
3595
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3596
|
+
*/
|
|
3597
|
+
503: Problem;
|
|
3598
|
+
};
|
|
3599
|
+
export type UpdateOrganizationError = UpdateOrganizationErrors[keyof UpdateOrganizationErrors];
|
|
3600
|
+
export type UpdateOrganizationResponses = {
|
|
3601
|
+
/**
|
|
3602
|
+
* Организация после изменения
|
|
3603
|
+
*/
|
|
3604
|
+
200: Organization;
|
|
3605
|
+
};
|
|
3606
|
+
export type UpdateOrganizationResponse = UpdateOrganizationResponses[keyof UpdateOrganizationResponses];
|
|
3607
|
+
export type CreateFileData = {
|
|
3608
|
+
body: {
|
|
3609
|
+
/**
|
|
3610
|
+
* Документ, не больше 52428800 байт (50 МиБ)
|
|
3611
|
+
*/
|
|
3612
|
+
file: Blob | File;
|
|
3613
|
+
};
|
|
3614
|
+
headers?: {
|
|
3615
|
+
/**
|
|
3616
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3617
|
+
*/
|
|
3618
|
+
'Typizer-Organization'?: string;
|
|
3619
|
+
/**
|
|
3620
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
3621
|
+
*/
|
|
3622
|
+
'Idempotency-Key'?: string;
|
|
3623
|
+
};
|
|
3624
|
+
path?: never;
|
|
3625
|
+
query?: never;
|
|
3626
|
+
url: '/v1/files';
|
|
3627
|
+
};
|
|
3628
|
+
export type CreateFileErrors = {
|
|
3629
|
+
/**
|
|
3630
|
+
* `invalid_request`: Некорректный запрос; `too_many_pages`: Слишком много страниц
|
|
3631
|
+
*/
|
|
3632
|
+
400: Problem;
|
|
3633
|
+
/**
|
|
3634
|
+
* `unauthorized`: Не авторизовано
|
|
3635
|
+
*/
|
|
3636
|
+
401: Problem;
|
|
3637
|
+
/**
|
|
3638
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
3639
|
+
*/
|
|
3640
|
+
403: Problem;
|
|
3641
|
+
/**
|
|
3642
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
3643
|
+
*/
|
|
3644
|
+
409: Problem;
|
|
3645
|
+
/**
|
|
3646
|
+
* `file_too_large`: Файл слишком большой
|
|
3647
|
+
*/
|
|
3648
|
+
413: Problem;
|
|
3649
|
+
/**
|
|
3650
|
+
* `unsupported_file_type`: Неподдерживаемый тип файла
|
|
3651
|
+
*/
|
|
3652
|
+
415: Problem;
|
|
3653
|
+
/**
|
|
3654
|
+
* `document_unreadable`: Документ не читается
|
|
3655
|
+
*/
|
|
3656
|
+
422: Problem;
|
|
3657
|
+
/**
|
|
3658
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3659
|
+
*/
|
|
3660
|
+
429: Problem;
|
|
3661
|
+
/**
|
|
3662
|
+
* `internal_error`: Внутренняя ошибка
|
|
3663
|
+
*/
|
|
3664
|
+
500: Problem;
|
|
3665
|
+
/**
|
|
3666
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3667
|
+
*/
|
|
3668
|
+
503: Problem;
|
|
3669
|
+
};
|
|
3670
|
+
export type CreateFileError = CreateFileErrors[keyof CreateFileErrors];
|
|
3671
|
+
export type CreateFileResponses = {
|
|
3672
|
+
/**
|
|
3673
|
+
* Сохранён
|
|
3674
|
+
*/
|
|
3675
|
+
201: File;
|
|
3676
|
+
};
|
|
3677
|
+
export type CreateFileResponse = CreateFileResponses[keyof CreateFileResponses];
|
|
3678
|
+
export type DeleteFileData = {
|
|
3679
|
+
body?: never;
|
|
3680
|
+
headers?: {
|
|
3681
|
+
/**
|
|
3682
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3683
|
+
*/
|
|
3684
|
+
'Typizer-Organization'?: string;
|
|
3685
|
+
};
|
|
3686
|
+
path: {
|
|
3687
|
+
id: string;
|
|
3688
|
+
};
|
|
3689
|
+
query?: never;
|
|
3690
|
+
url: '/v1/files/{id}';
|
|
3691
|
+
};
|
|
3692
|
+
export type DeleteFileErrors = {
|
|
3693
|
+
/**
|
|
3694
|
+
* `invalid_id`: Некорректный идентификатор
|
|
3695
|
+
*/
|
|
3696
|
+
400: Problem;
|
|
3697
|
+
/**
|
|
3698
|
+
* `unauthorized`: Не авторизовано
|
|
3699
|
+
*/
|
|
3700
|
+
401: Problem;
|
|
3701
|
+
/**
|
|
3702
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
3703
|
+
*/
|
|
3704
|
+
403: Problem;
|
|
3705
|
+
/**
|
|
3706
|
+
* `not_found`: Не найдено
|
|
3707
|
+
*/
|
|
3708
|
+
404: Problem;
|
|
3709
|
+
/**
|
|
3710
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3711
|
+
*/
|
|
3712
|
+
429: Problem;
|
|
3713
|
+
/**
|
|
3714
|
+
* `internal_error`: Внутренняя ошибка
|
|
3715
|
+
*/
|
|
3716
|
+
500: Problem;
|
|
3717
|
+
/**
|
|
3718
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3719
|
+
*/
|
|
3720
|
+
503: Problem;
|
|
3721
|
+
};
|
|
3722
|
+
export type DeleteFileError = DeleteFileErrors[keyof DeleteFileErrors];
|
|
3723
|
+
export type DeleteFileResponses = {
|
|
3724
|
+
/**
|
|
3725
|
+
* Удалён
|
|
3726
|
+
*/
|
|
3727
|
+
200: DeletedFile;
|
|
3728
|
+
};
|
|
3729
|
+
export type DeleteFileResponse = DeleteFileResponses[keyof DeleteFileResponses];
|
|
3730
|
+
export type GetFileData = {
|
|
3731
|
+
body?: never;
|
|
3732
|
+
headers?: {
|
|
3733
|
+
/**
|
|
3734
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3735
|
+
*/
|
|
3736
|
+
'Typizer-Organization'?: string;
|
|
3737
|
+
};
|
|
3738
|
+
path: {
|
|
3739
|
+
id: string;
|
|
3740
|
+
};
|
|
3741
|
+
query?: never;
|
|
3742
|
+
url: '/v1/files/{id}';
|
|
3743
|
+
};
|
|
3744
|
+
export type GetFileErrors = {
|
|
3745
|
+
/**
|
|
3746
|
+
* `invalid_id`: Некорректный идентификатор
|
|
3747
|
+
*/
|
|
3748
|
+
400: Problem;
|
|
3749
|
+
/**
|
|
3750
|
+
* `unauthorized`: Не авторизовано
|
|
3751
|
+
*/
|
|
3752
|
+
401: Problem;
|
|
3753
|
+
/**
|
|
3754
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
3755
|
+
*/
|
|
3756
|
+
403: Problem;
|
|
3757
|
+
/**
|
|
3758
|
+
* `not_found`: Не найдено
|
|
3759
|
+
*/
|
|
3760
|
+
404: Problem;
|
|
3761
|
+
/**
|
|
3762
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3763
|
+
*/
|
|
3764
|
+
429: Problem;
|
|
3765
|
+
/**
|
|
3766
|
+
* `internal_error`: Внутренняя ошибка
|
|
3767
|
+
*/
|
|
3768
|
+
500: Problem;
|
|
3769
|
+
/**
|
|
3770
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3771
|
+
*/
|
|
3772
|
+
503: Problem;
|
|
3773
|
+
};
|
|
3774
|
+
export type GetFileError = GetFileErrors[keyof GetFileErrors];
|
|
3775
|
+
export type GetFileResponses = {
|
|
3776
|
+
/**
|
|
3777
|
+
* Файл
|
|
3778
|
+
*/
|
|
3779
|
+
200: File;
|
|
3780
|
+
};
|
|
3781
|
+
export type GetFileResponse = GetFileResponses[keyof GetFileResponses];
|
|
3782
|
+
export type GetFileContentData = {
|
|
3783
|
+
body?: never;
|
|
3784
|
+
headers?: {
|
|
3785
|
+
/**
|
|
3786
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3787
|
+
*/
|
|
3788
|
+
'Typizer-Organization'?: string;
|
|
3789
|
+
};
|
|
3790
|
+
path: {
|
|
3791
|
+
id: string;
|
|
3792
|
+
};
|
|
3793
|
+
query?: never;
|
|
3794
|
+
url: '/v1/files/{id}/content';
|
|
3795
|
+
};
|
|
3796
|
+
export type GetFileContentErrors = {
|
|
3797
|
+
/**
|
|
3798
|
+
* `invalid_id`: Некорректный идентификатор
|
|
3799
|
+
*/
|
|
3800
|
+
400: Problem;
|
|
3801
|
+
/**
|
|
3802
|
+
* `unauthorized`: Не авторизовано
|
|
3803
|
+
*/
|
|
3804
|
+
401: Problem;
|
|
3805
|
+
/**
|
|
3806
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
3807
|
+
*/
|
|
3808
|
+
403: Problem;
|
|
3809
|
+
/**
|
|
3810
|
+
* `not_found`: Не найдено
|
|
3811
|
+
*/
|
|
3812
|
+
404: Problem;
|
|
3813
|
+
/**
|
|
3814
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3815
|
+
*/
|
|
3816
|
+
429: Problem;
|
|
3817
|
+
/**
|
|
3818
|
+
* `internal_error`: Внутренняя ошибка
|
|
3819
|
+
*/
|
|
3820
|
+
500: Problem;
|
|
3821
|
+
/**
|
|
3822
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3823
|
+
*/
|
|
3824
|
+
503: Problem;
|
|
3825
|
+
};
|
|
3826
|
+
export type GetFileContentError = GetFileContentErrors[keyof GetFileContentErrors];
|
|
3827
|
+
export type GetFileContentResponses = {
|
|
3828
|
+
/**
|
|
3829
|
+
* Содержимое; `Content-Type` — определённый `mime`
|
|
3830
|
+
*/
|
|
3831
|
+
200: Blob | File;
|
|
3832
|
+
};
|
|
3833
|
+
export type GetFileContentResponse = GetFileContentResponses[keyof GetFileContentResponses];
|
|
3834
|
+
export type ListTypizersData = {
|
|
3835
|
+
body?: never;
|
|
3836
|
+
headers?: {
|
|
3837
|
+
/**
|
|
3838
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3839
|
+
*/
|
|
3840
|
+
'Typizer-Organization'?: string;
|
|
3841
|
+
};
|
|
3842
|
+
path?: never;
|
|
3843
|
+
query?: {
|
|
3844
|
+
/**
|
|
3845
|
+
* Элементов на странице, 1–100
|
|
3846
|
+
*/
|
|
3847
|
+
limit?: number;
|
|
3848
|
+
/**
|
|
3849
|
+
* `next_cursor` предыдущей страницы: список продолжается после этого идентификатора
|
|
3850
|
+
*/
|
|
3851
|
+
starting_after?: string;
|
|
3852
|
+
};
|
|
3853
|
+
url: '/v1/typizers';
|
|
3854
|
+
};
|
|
3855
|
+
export type ListTypizersErrors = {
|
|
3856
|
+
/**
|
|
3857
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
3858
|
+
*/
|
|
3859
|
+
400: Problem;
|
|
3860
|
+
/**
|
|
3861
|
+
* `unauthorized`: Не авторизовано
|
|
3862
|
+
*/
|
|
3863
|
+
401: Problem;
|
|
3864
|
+
/**
|
|
3865
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
3866
|
+
*/
|
|
3867
|
+
403: Problem;
|
|
3868
|
+
/**
|
|
3869
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3870
|
+
*/
|
|
3871
|
+
429: Problem;
|
|
3872
|
+
/**
|
|
3873
|
+
* `internal_error`: Внутренняя ошибка
|
|
3874
|
+
*/
|
|
3875
|
+
500: Problem;
|
|
3876
|
+
/**
|
|
3877
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3878
|
+
*/
|
|
3879
|
+
503: Problem;
|
|
3880
|
+
};
|
|
3881
|
+
export type ListTypizersError = ListTypizersErrors[keyof ListTypizersErrors];
|
|
3882
|
+
export type ListTypizersResponses = {
|
|
3883
|
+
/**
|
|
3884
|
+
* Страница типизаторов
|
|
3885
|
+
*/
|
|
3886
|
+
200: {
|
|
3887
|
+
object: 'list';
|
|
3888
|
+
data: Array<Typizer>;
|
|
3889
|
+
has_more: boolean;
|
|
3890
|
+
next_cursor: string | null;
|
|
3891
|
+
};
|
|
3892
|
+
};
|
|
3893
|
+
export type ListTypizersResponse = ListTypizersResponses[keyof ListTypizersResponses];
|
|
3894
|
+
export type CreateTypizerData = {
|
|
3895
|
+
body: CreateTypizerRequest;
|
|
3896
|
+
headers?: {
|
|
3897
|
+
/**
|
|
3898
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3899
|
+
*/
|
|
3900
|
+
'Typizer-Organization'?: string;
|
|
3901
|
+
/**
|
|
3902
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
3903
|
+
*/
|
|
3904
|
+
'Idempotency-Key'?: string;
|
|
3905
|
+
};
|
|
3906
|
+
path?: never;
|
|
3907
|
+
query?: never;
|
|
3908
|
+
url: '/v1/typizers';
|
|
3909
|
+
};
|
|
3910
|
+
export type CreateTypizerErrors = {
|
|
3911
|
+
/**
|
|
3912
|
+
* `invalid_schema`: Некорректная схема; `unsupported_schema_feature`: Неподдерживаемая возможность схемы; `invalid_request`: Некорректный запрос. У `invalid_schema` и `unsupported_schema_feature` `param` — это `schema#` и указатель RFC 6901 внутрь схемы (управляющие символы заменены, не больше 256 символов). Ограничения: не больше 200 полей и 10 уровней схемы (core), 131072 байт (128 КиБ) в компактном JSON в UTF-8, 64 уровней вложенности JSON (включая `examples`), и ни в одной строке нет NUL или непарного суррогата.
|
|
3913
|
+
*/
|
|
3914
|
+
400: Problem;
|
|
3915
|
+
/**
|
|
3916
|
+
* `unauthorized`: Не авторизовано
|
|
3917
|
+
*/
|
|
3918
|
+
401: Problem;
|
|
3919
|
+
/**
|
|
3920
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
3921
|
+
*/
|
|
3922
|
+
403: Problem;
|
|
3923
|
+
/**
|
|
3924
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
3925
|
+
*/
|
|
3926
|
+
409: Problem;
|
|
3927
|
+
/**
|
|
3928
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3929
|
+
*/
|
|
3930
|
+
429: Problem;
|
|
3931
|
+
/**
|
|
3932
|
+
* `internal_error`: Внутренняя ошибка
|
|
3933
|
+
*/
|
|
3934
|
+
500: Problem;
|
|
3935
|
+
/**
|
|
3936
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3937
|
+
*/
|
|
3938
|
+
503: Problem;
|
|
3939
|
+
};
|
|
3940
|
+
export type CreateTypizerError = CreateTypizerErrors[keyof CreateTypizerErrors];
|
|
3941
|
+
export type CreateTypizerResponses = {
|
|
3942
|
+
/**
|
|
3943
|
+
* Создан
|
|
3944
|
+
*/
|
|
3945
|
+
201: Typizer;
|
|
3946
|
+
};
|
|
3947
|
+
export type CreateTypizerResponse = CreateTypizerResponses[keyof CreateTypizerResponses];
|
|
3948
|
+
export type GenerateTypizerData = {
|
|
3949
|
+
body: GenerateTypizerRequest;
|
|
3950
|
+
headers?: {
|
|
3951
|
+
/**
|
|
3952
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3953
|
+
*/
|
|
3954
|
+
'Typizer-Organization'?: string;
|
|
3955
|
+
/**
|
|
3956
|
+
* Принимается для единообразия клиентов и в этой операции игнорируется: ничего не блокируется и не повторяется (некорректное значение всё же может получить 400).
|
|
3957
|
+
*/
|
|
3958
|
+
'Idempotency-Key'?: string;
|
|
3959
|
+
};
|
|
3960
|
+
path?: never;
|
|
3961
|
+
query?: never;
|
|
3962
|
+
url: '/v1/typizers/generate';
|
|
3963
|
+
};
|
|
3964
|
+
export type GenerateTypizerErrors = {
|
|
3965
|
+
/**
|
|
3966
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
3967
|
+
*/
|
|
3968
|
+
400: Problem;
|
|
3969
|
+
/**
|
|
3970
|
+
* `unauthorized`: Не авторизовано
|
|
3971
|
+
*/
|
|
3972
|
+
401: Problem;
|
|
3973
|
+
/**
|
|
3974
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
3975
|
+
*/
|
|
3976
|
+
403: Problem;
|
|
3977
|
+
/**
|
|
3978
|
+
* `not_found`: Не найдено
|
|
3979
|
+
*/
|
|
3980
|
+
404: Problem;
|
|
3981
|
+
/**
|
|
3982
|
+
* `extraction_failed`: Извлечение не удалось
|
|
3983
|
+
*/
|
|
3984
|
+
422: Problem;
|
|
3985
|
+
/**
|
|
3986
|
+
* `rate_limited`: Превышен лимит запросов
|
|
3987
|
+
*/
|
|
3988
|
+
429: Problem;
|
|
3989
|
+
/**
|
|
3990
|
+
* `internal_error`: Внутренняя ошибка
|
|
3991
|
+
*/
|
|
3992
|
+
500: Problem;
|
|
3993
|
+
/**
|
|
3994
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
3995
|
+
*/
|
|
3996
|
+
503: Problem;
|
|
3997
|
+
};
|
|
3998
|
+
export type GenerateTypizerError = GenerateTypizerErrors[keyof GenerateTypizerErrors];
|
|
3999
|
+
export type GenerateTypizerResponses = {
|
|
4000
|
+
/**
|
|
4001
|
+
* Черновик
|
|
4002
|
+
*/
|
|
4003
|
+
200: TypizerDraft;
|
|
4004
|
+
};
|
|
4005
|
+
export type GenerateTypizerResponse = GenerateTypizerResponses[keyof GenerateTypizerResponses];
|
|
4006
|
+
export type DeleteTypizerData = {
|
|
4007
|
+
body?: never;
|
|
4008
|
+
headers?: {
|
|
4009
|
+
/**
|
|
4010
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4011
|
+
*/
|
|
4012
|
+
'Typizer-Organization'?: string;
|
|
4013
|
+
};
|
|
4014
|
+
path: {
|
|
4015
|
+
id: string;
|
|
4016
|
+
};
|
|
4017
|
+
query?: never;
|
|
4018
|
+
url: '/v1/typizers/{id}';
|
|
4019
|
+
};
|
|
4020
|
+
export type DeleteTypizerErrors = {
|
|
4021
|
+
/**
|
|
4022
|
+
* `invalid_id`: Некорректный идентификатор
|
|
4023
|
+
*/
|
|
4024
|
+
400: Problem;
|
|
4025
|
+
/**
|
|
4026
|
+
* `unauthorized`: Не авторизовано
|
|
4027
|
+
*/
|
|
4028
|
+
401: Problem;
|
|
4029
|
+
/**
|
|
4030
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4031
|
+
*/
|
|
4032
|
+
403: Problem;
|
|
4033
|
+
/**
|
|
4034
|
+
* `not_found`: Не найдено
|
|
4035
|
+
*/
|
|
4036
|
+
404: Problem;
|
|
4037
|
+
/**
|
|
4038
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4039
|
+
*/
|
|
4040
|
+
429: Problem;
|
|
4041
|
+
/**
|
|
4042
|
+
* `internal_error`: Внутренняя ошибка
|
|
4043
|
+
*/
|
|
4044
|
+
500: Problem;
|
|
4045
|
+
/**
|
|
4046
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4047
|
+
*/
|
|
4048
|
+
503: Problem;
|
|
4049
|
+
};
|
|
4050
|
+
export type DeleteTypizerError = DeleteTypizerErrors[keyof DeleteTypizerErrors];
|
|
4051
|
+
export type DeleteTypizerResponses = {
|
|
4052
|
+
/**
|
|
4053
|
+
* Архивирован
|
|
4054
|
+
*/
|
|
4055
|
+
200: DeletedTypizer;
|
|
4056
|
+
};
|
|
4057
|
+
export type DeleteTypizerResponse = DeleteTypizerResponses[keyof DeleteTypizerResponses];
|
|
4058
|
+
export type GetTypizerData = {
|
|
4059
|
+
body?: never;
|
|
4060
|
+
headers?: {
|
|
4061
|
+
/**
|
|
4062
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4063
|
+
*/
|
|
4064
|
+
'Typizer-Organization'?: string;
|
|
4065
|
+
};
|
|
4066
|
+
path: {
|
|
4067
|
+
id: string;
|
|
4068
|
+
};
|
|
4069
|
+
query?: never;
|
|
4070
|
+
url: '/v1/typizers/{id}';
|
|
4071
|
+
};
|
|
4072
|
+
export type GetTypizerErrors = {
|
|
4073
|
+
/**
|
|
4074
|
+
* `invalid_id`: Некорректный идентификатор
|
|
4075
|
+
*/
|
|
4076
|
+
400: Problem;
|
|
4077
|
+
/**
|
|
4078
|
+
* `unauthorized`: Не авторизовано
|
|
4079
|
+
*/
|
|
4080
|
+
401: Problem;
|
|
4081
|
+
/**
|
|
4082
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4083
|
+
*/
|
|
4084
|
+
403: Problem;
|
|
4085
|
+
/**
|
|
4086
|
+
* `not_found`: Не найдено
|
|
4087
|
+
*/
|
|
4088
|
+
404: Problem;
|
|
4089
|
+
/**
|
|
4090
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4091
|
+
*/
|
|
4092
|
+
429: Problem;
|
|
4093
|
+
/**
|
|
4094
|
+
* `internal_error`: Внутренняя ошибка
|
|
4095
|
+
*/
|
|
4096
|
+
500: Problem;
|
|
4097
|
+
/**
|
|
4098
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4099
|
+
*/
|
|
4100
|
+
503: Problem;
|
|
4101
|
+
};
|
|
4102
|
+
export type GetTypizerError = GetTypizerErrors[keyof GetTypizerErrors];
|
|
4103
|
+
export type GetTypizerResponses = {
|
|
4104
|
+
/**
|
|
4105
|
+
* Типизатор
|
|
4106
|
+
*/
|
|
4107
|
+
200: Typizer;
|
|
4108
|
+
};
|
|
4109
|
+
export type GetTypizerResponse = GetTypizerResponses[keyof GetTypizerResponses];
|
|
4110
|
+
export type UpdateTypizerData = {
|
|
4111
|
+
body: UpdateTypizerRequest;
|
|
4112
|
+
headers?: {
|
|
4113
|
+
/**
|
|
4114
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4115
|
+
*/
|
|
4116
|
+
'Typizer-Organization'?: string;
|
|
4117
|
+
};
|
|
4118
|
+
path: {
|
|
4119
|
+
id: string;
|
|
4120
|
+
};
|
|
4121
|
+
query?: never;
|
|
4122
|
+
url: '/v1/typizers/{id}';
|
|
4123
|
+
};
|
|
4124
|
+
export type UpdateTypizerErrors = {
|
|
4125
|
+
/**
|
|
4126
|
+
* `invalid_schema`: Некорректная схема; `unsupported_schema_feature`: Неподдерживаемая возможность схемы; `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор. У `invalid_schema` и `unsupported_schema_feature` `param` — это `schema#` и указатель RFC 6901 внутрь схемы (управляющие символы заменены, не больше 256 символов). Ограничения: не больше 200 полей и 10 уровней схемы (core), 131072 байт (128 КиБ) в компактном JSON в UTF-8, 64 уровней вложенности JSON (включая `examples`), и ни в одной строке нет NUL или непарного суррогата.
|
|
4127
|
+
*/
|
|
4128
|
+
400: Problem;
|
|
4129
|
+
/**
|
|
4130
|
+
* `unauthorized`: Не авторизовано
|
|
4131
|
+
*/
|
|
4132
|
+
401: Problem;
|
|
4133
|
+
/**
|
|
4134
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4135
|
+
*/
|
|
4136
|
+
403: Problem;
|
|
4137
|
+
/**
|
|
4138
|
+
* `not_found`: Не найдено
|
|
4139
|
+
*/
|
|
4140
|
+
404: Problem;
|
|
4141
|
+
/**
|
|
4142
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4143
|
+
*/
|
|
4144
|
+
429: Problem;
|
|
4145
|
+
/**
|
|
4146
|
+
* `internal_error`: Внутренняя ошибка
|
|
4147
|
+
*/
|
|
4148
|
+
500: Problem;
|
|
4149
|
+
/**
|
|
4150
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4151
|
+
*/
|
|
4152
|
+
503: Problem;
|
|
4153
|
+
};
|
|
4154
|
+
export type UpdateTypizerError = UpdateTypizerErrors[keyof UpdateTypizerErrors];
|
|
4155
|
+
export type UpdateTypizerResponses = {
|
|
4156
|
+
/**
|
|
4157
|
+
* Типизатор после изменения
|
|
4158
|
+
*/
|
|
4159
|
+
200: Typizer;
|
|
4160
|
+
};
|
|
4161
|
+
export type UpdateTypizerResponse = UpdateTypizerResponses[keyof UpdateTypizerResponses];
|
|
4162
|
+
export type ListTypizerVersionsData = {
|
|
4163
|
+
body?: never;
|
|
4164
|
+
headers?: {
|
|
4165
|
+
/**
|
|
4166
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4167
|
+
*/
|
|
4168
|
+
'Typizer-Organization'?: string;
|
|
4169
|
+
};
|
|
4170
|
+
path: {
|
|
4171
|
+
id: string;
|
|
4172
|
+
};
|
|
4173
|
+
query?: {
|
|
4174
|
+
/**
|
|
4175
|
+
* Элементов на странице, 1–100
|
|
4176
|
+
*/
|
|
4177
|
+
limit?: number;
|
|
4178
|
+
/**
|
|
4179
|
+
* `next_cursor` предыдущей страницы: список продолжается после этого идентификатора
|
|
4180
|
+
*/
|
|
4181
|
+
starting_after?: string;
|
|
4182
|
+
};
|
|
4183
|
+
url: '/v1/typizers/{id}/versions';
|
|
4184
|
+
};
|
|
4185
|
+
export type ListTypizerVersionsErrors = {
|
|
4186
|
+
/**
|
|
4187
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
4188
|
+
*/
|
|
4189
|
+
400: Problem;
|
|
4190
|
+
/**
|
|
4191
|
+
* `unauthorized`: Не авторизовано
|
|
4192
|
+
*/
|
|
4193
|
+
401: Problem;
|
|
4194
|
+
/**
|
|
4195
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4196
|
+
*/
|
|
4197
|
+
403: Problem;
|
|
4198
|
+
/**
|
|
4199
|
+
* `not_found`: Не найдено
|
|
4200
|
+
*/
|
|
4201
|
+
404: Problem;
|
|
4202
|
+
/**
|
|
4203
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4204
|
+
*/
|
|
4205
|
+
429: Problem;
|
|
4206
|
+
/**
|
|
4207
|
+
* `internal_error`: Внутренняя ошибка
|
|
4208
|
+
*/
|
|
4209
|
+
500: Problem;
|
|
4210
|
+
/**
|
|
4211
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4212
|
+
*/
|
|
4213
|
+
503: Problem;
|
|
4214
|
+
};
|
|
4215
|
+
export type ListTypizerVersionsError = ListTypizerVersionsErrors[keyof ListTypizerVersionsErrors];
|
|
4216
|
+
export type ListTypizerVersionsResponses = {
|
|
4217
|
+
/**
|
|
4218
|
+
* Страница версий
|
|
4219
|
+
*/
|
|
4220
|
+
200: {
|
|
4221
|
+
object: 'list';
|
|
4222
|
+
data: Array<TypizerVersion>;
|
|
4223
|
+
has_more: boolean;
|
|
4224
|
+
next_cursor: string | null;
|
|
4225
|
+
};
|
|
4226
|
+
};
|
|
4227
|
+
export type ListTypizerVersionsResponse = ListTypizerVersionsResponses[keyof ListTypizerVersionsResponses];
|
|
4228
|
+
export type GetTypizerVersionData = {
|
|
4229
|
+
body?: never;
|
|
4230
|
+
headers?: {
|
|
4231
|
+
/**
|
|
4232
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4233
|
+
*/
|
|
4234
|
+
'Typizer-Organization'?: string;
|
|
4235
|
+
};
|
|
4236
|
+
path: {
|
|
4237
|
+
id: string;
|
|
4238
|
+
n: number;
|
|
4239
|
+
};
|
|
4240
|
+
query?: never;
|
|
4241
|
+
url: '/v1/typizers/{id}/versions/{n}';
|
|
4242
|
+
};
|
|
4243
|
+
export type GetTypizerVersionErrors = {
|
|
4244
|
+
/**
|
|
4245
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
4246
|
+
*/
|
|
4247
|
+
400: Problem;
|
|
4248
|
+
/**
|
|
4249
|
+
* `unauthorized`: Не авторизовано
|
|
4250
|
+
*/
|
|
4251
|
+
401: Problem;
|
|
4252
|
+
/**
|
|
4253
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4254
|
+
*/
|
|
4255
|
+
403: Problem;
|
|
4256
|
+
/**
|
|
4257
|
+
* `not_found`: Не найдено
|
|
4258
|
+
*/
|
|
4259
|
+
404: Problem;
|
|
4260
|
+
/**
|
|
4261
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4262
|
+
*/
|
|
4263
|
+
429: Problem;
|
|
4264
|
+
/**
|
|
4265
|
+
* `internal_error`: Внутренняя ошибка
|
|
4266
|
+
*/
|
|
4267
|
+
500: Problem;
|
|
4268
|
+
/**
|
|
4269
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4270
|
+
*/
|
|
4271
|
+
503: Problem;
|
|
4272
|
+
};
|
|
4273
|
+
export type GetTypizerVersionError = GetTypizerVersionErrors[keyof GetTypizerVersionErrors];
|
|
4274
|
+
export type GetTypizerVersionResponses = {
|
|
4275
|
+
/**
|
|
4276
|
+
* Версия
|
|
4277
|
+
*/
|
|
4278
|
+
200: TypizerVersion;
|
|
4279
|
+
};
|
|
4280
|
+
export type GetTypizerVersionResponse = GetTypizerVersionResponses[keyof GetTypizerVersionResponses];
|
|
4281
|
+
export type GetTypizerXsdData = {
|
|
4282
|
+
body?: never;
|
|
4283
|
+
headers?: {
|
|
4284
|
+
/**
|
|
4285
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4286
|
+
*/
|
|
4287
|
+
'Typizer-Organization'?: string;
|
|
4288
|
+
};
|
|
4289
|
+
path: {
|
|
4290
|
+
id: string;
|
|
4291
|
+
};
|
|
4292
|
+
query?: never;
|
|
4293
|
+
url: '/v1/typizers/{id}/xsd';
|
|
4294
|
+
};
|
|
4295
|
+
export type GetTypizerXsdErrors = {
|
|
4296
|
+
/**
|
|
4297
|
+
* `invalid_id`: Некорректный идентификатор
|
|
4298
|
+
*/
|
|
4299
|
+
400: Problem;
|
|
4300
|
+
/**
|
|
4301
|
+
* `unauthorized`: Не авторизовано
|
|
4302
|
+
*/
|
|
4303
|
+
401: Problem;
|
|
4304
|
+
/**
|
|
4305
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4306
|
+
*/
|
|
4307
|
+
403: Problem;
|
|
4308
|
+
/**
|
|
4309
|
+
* `not_found`: Не найдено
|
|
4310
|
+
*/
|
|
4311
|
+
404: Problem;
|
|
4312
|
+
/**
|
|
4313
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4314
|
+
*/
|
|
4315
|
+
429: Problem;
|
|
4316
|
+
/**
|
|
4317
|
+
* `internal_error`: Внутренняя ошибка
|
|
4318
|
+
*/
|
|
4319
|
+
500: Problem;
|
|
4320
|
+
/**
|
|
4321
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4322
|
+
*/
|
|
4323
|
+
503: Problem;
|
|
4324
|
+
};
|
|
4325
|
+
export type GetTypizerXsdError = GetTypizerXsdErrors[keyof GetTypizerXsdErrors];
|
|
4326
|
+
export type GetTypizerXsdResponses = {
|
|
4327
|
+
/**
|
|
4328
|
+
* Схема XSD
|
|
4329
|
+
*/
|
|
4330
|
+
200: Blob | File;
|
|
4331
|
+
};
|
|
4332
|
+
export type GetTypizerXsdResponse = GetTypizerXsdResponses[keyof GetTypizerXsdResponses];
|
|
4333
|
+
export type GetOwnCatalogPublisherData = {
|
|
4334
|
+
body?: never;
|
|
4335
|
+
headers?: {
|
|
4336
|
+
/**
|
|
4337
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4338
|
+
*/
|
|
4339
|
+
'Typizer-Organization'?: string;
|
|
4340
|
+
};
|
|
4341
|
+
path?: never;
|
|
4342
|
+
query?: never;
|
|
4343
|
+
url: '/v1/catalog/publisher';
|
|
4344
|
+
};
|
|
4345
|
+
export type GetOwnCatalogPublisherErrors = {
|
|
4346
|
+
/**
|
|
4347
|
+
* `unauthorized`: Не авторизовано
|
|
4348
|
+
*/
|
|
4349
|
+
401: Problem;
|
|
4350
|
+
/**
|
|
4351
|
+
* `forbidden`: Доступ запрещён
|
|
4352
|
+
*/
|
|
4353
|
+
403: Problem;
|
|
4354
|
+
/**
|
|
4355
|
+
* `not_found`: Не найдено
|
|
4356
|
+
*/
|
|
4357
|
+
404: Problem;
|
|
4358
|
+
/**
|
|
4359
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4360
|
+
*/
|
|
4361
|
+
429: Problem;
|
|
4362
|
+
/**
|
|
4363
|
+
* `internal_error`: Внутренняя ошибка
|
|
4364
|
+
*/
|
|
4365
|
+
500: Problem;
|
|
4366
|
+
/**
|
|
4367
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4368
|
+
*/
|
|
4369
|
+
503: Problem;
|
|
4370
|
+
};
|
|
4371
|
+
export type GetOwnCatalogPublisherError = GetOwnCatalogPublisherErrors[keyof GetOwnCatalogPublisherErrors];
|
|
4372
|
+
export type GetOwnCatalogPublisherResponses = {
|
|
4373
|
+
/**
|
|
4374
|
+
* Профиль
|
|
4375
|
+
*/
|
|
4376
|
+
200: CatalogPublisher;
|
|
4377
|
+
};
|
|
4378
|
+
export type GetOwnCatalogPublisherResponse = GetOwnCatalogPublisherResponses[keyof GetOwnCatalogPublisherResponses];
|
|
4379
|
+
export type UpsertOwnCatalogPublisherData = {
|
|
4380
|
+
body: CatalogPublisherRequest;
|
|
4381
|
+
headers?: {
|
|
4382
|
+
/**
|
|
4383
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4384
|
+
*/
|
|
4385
|
+
'Typizer-Organization'?: string;
|
|
4386
|
+
};
|
|
4387
|
+
path?: never;
|
|
4388
|
+
query?: never;
|
|
4389
|
+
url: '/v1/catalog/publisher';
|
|
4390
|
+
};
|
|
4391
|
+
export type UpsertOwnCatalogPublisherErrors = {
|
|
4392
|
+
/**
|
|
4393
|
+
* `invalid_request`: Некорректный запрос
|
|
4394
|
+
*/
|
|
4395
|
+
400: Problem;
|
|
4396
|
+
/**
|
|
4397
|
+
* `unauthorized`: Не авторизовано
|
|
4398
|
+
*/
|
|
4399
|
+
401: Problem;
|
|
4400
|
+
/**
|
|
4401
|
+
* `forbidden`: Доступ запрещён
|
|
4402
|
+
*/
|
|
4403
|
+
403: Problem;
|
|
4404
|
+
/**
|
|
4405
|
+
* `not_found`: Не найдено
|
|
4406
|
+
*/
|
|
4407
|
+
404: Problem;
|
|
4408
|
+
/**
|
|
4409
|
+
* `conflict`: Конфликт состояния
|
|
4410
|
+
*/
|
|
4411
|
+
409: Problem;
|
|
4412
|
+
/**
|
|
4413
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4414
|
+
*/
|
|
4415
|
+
429: Problem;
|
|
4416
|
+
/**
|
|
4417
|
+
* `internal_error`: Внутренняя ошибка
|
|
4418
|
+
*/
|
|
4419
|
+
500: Problem;
|
|
4420
|
+
/**
|
|
4421
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4422
|
+
*/
|
|
4423
|
+
503: Problem;
|
|
4424
|
+
};
|
|
4425
|
+
export type UpsertOwnCatalogPublisherError = UpsertOwnCatalogPublisherErrors[keyof UpsertOwnCatalogPublisherErrors];
|
|
4426
|
+
export type UpsertOwnCatalogPublisherResponses = {
|
|
4427
|
+
/**
|
|
4428
|
+
* Профиль
|
|
4429
|
+
*/
|
|
4430
|
+
200: CatalogPublisher;
|
|
4431
|
+
};
|
|
4432
|
+
export type UpsertOwnCatalogPublisherResponse = UpsertOwnCatalogPublisherResponses[keyof UpsertOwnCatalogPublisherResponses];
|
|
4433
|
+
export type ListOwnCatalogEntriesData = {
|
|
4434
|
+
body?: never;
|
|
4435
|
+
headers?: {
|
|
4436
|
+
/**
|
|
4437
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4438
|
+
*/
|
|
4439
|
+
'Typizer-Organization'?: string;
|
|
4440
|
+
};
|
|
4441
|
+
path?: never;
|
|
4442
|
+
query?: {
|
|
4443
|
+
/**
|
|
4444
|
+
* Элементов на странице, 1–100
|
|
4445
|
+
*/
|
|
4446
|
+
limit?: number;
|
|
4447
|
+
/**
|
|
4448
|
+
* `next_cursor` предыдущей страницы: список продолжается после этого идентификатора
|
|
4449
|
+
*/
|
|
4450
|
+
starting_after?: string;
|
|
4451
|
+
};
|
|
4452
|
+
url: '/v1/catalog/mine';
|
|
4453
|
+
};
|
|
4454
|
+
export type ListOwnCatalogEntriesErrors = {
|
|
4455
|
+
/**
|
|
4456
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
4457
|
+
*/
|
|
4458
|
+
400: Problem;
|
|
4459
|
+
/**
|
|
4460
|
+
* `unauthorized`: Не авторизовано
|
|
4461
|
+
*/
|
|
4462
|
+
401: Problem;
|
|
4463
|
+
/**
|
|
4464
|
+
* `forbidden`: Доступ запрещён
|
|
4465
|
+
*/
|
|
4466
|
+
403: Problem;
|
|
4467
|
+
/**
|
|
4468
|
+
* `not_found`: Не найдено
|
|
4469
|
+
*/
|
|
4470
|
+
404: Problem;
|
|
4471
|
+
/**
|
|
4472
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4473
|
+
*/
|
|
4474
|
+
429: Problem;
|
|
4475
|
+
/**
|
|
4476
|
+
* `internal_error`: Внутренняя ошибка
|
|
4477
|
+
*/
|
|
4478
|
+
500: Problem;
|
|
4479
|
+
/**
|
|
4480
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4481
|
+
*/
|
|
4482
|
+
503: Problem;
|
|
4483
|
+
};
|
|
4484
|
+
export type ListOwnCatalogEntriesError = ListOwnCatalogEntriesErrors[keyof ListOwnCatalogEntriesErrors];
|
|
4485
|
+
export type ListOwnCatalogEntriesResponses = {
|
|
4486
|
+
/**
|
|
4487
|
+
* Страница схем
|
|
4488
|
+
*/
|
|
4489
|
+
200: {
|
|
4490
|
+
object: 'list';
|
|
4491
|
+
data: Array<CatalogOwnEntry>;
|
|
4492
|
+
has_more: boolean;
|
|
4493
|
+
next_cursor: string | null;
|
|
4494
|
+
};
|
|
4495
|
+
};
|
|
4496
|
+
export type ListOwnCatalogEntriesResponse = ListOwnCatalogEntriesResponses[keyof ListOwnCatalogEntriesResponses];
|
|
4497
|
+
export type GetCatalogPublisherData = {
|
|
4498
|
+
body?: never;
|
|
4499
|
+
headers?: {
|
|
4500
|
+
/**
|
|
4501
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4502
|
+
*/
|
|
4503
|
+
'Typizer-Organization'?: string;
|
|
4504
|
+
};
|
|
4505
|
+
path: {
|
|
4506
|
+
slug: string;
|
|
4507
|
+
};
|
|
4508
|
+
query?: never;
|
|
4509
|
+
url: '/v1/catalog/publishers/{slug}';
|
|
4510
|
+
};
|
|
4511
|
+
export type GetCatalogPublisherErrors = {
|
|
4512
|
+
/**
|
|
4513
|
+
* `unauthorized`: Не авторизовано
|
|
4514
|
+
*/
|
|
4515
|
+
401: Problem;
|
|
4516
|
+
/**
|
|
4517
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4518
|
+
*/
|
|
4519
|
+
403: Problem;
|
|
4520
|
+
/**
|
|
4521
|
+
* `not_found`: Не найдено
|
|
4522
|
+
*/
|
|
4523
|
+
404: Problem;
|
|
4524
|
+
/**
|
|
4525
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4526
|
+
*/
|
|
4527
|
+
429: Problem;
|
|
4528
|
+
/**
|
|
4529
|
+
* `internal_error`: Внутренняя ошибка
|
|
4530
|
+
*/
|
|
4531
|
+
500: Problem;
|
|
4532
|
+
/**
|
|
4533
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4534
|
+
*/
|
|
4535
|
+
503: Problem;
|
|
4536
|
+
};
|
|
4537
|
+
export type GetCatalogPublisherError = GetCatalogPublisherErrors[keyof GetCatalogPublisherErrors];
|
|
4538
|
+
export type GetCatalogPublisherResponses = {
|
|
4539
|
+
/**
|
|
4540
|
+
* Профиль
|
|
4541
|
+
*/
|
|
4542
|
+
200: CatalogPublisher;
|
|
4543
|
+
};
|
|
4544
|
+
export type GetCatalogPublisherResponse = GetCatalogPublisherResponses[keyof GetCatalogPublisherResponses];
|
|
4545
|
+
export type ListCatalogData = {
|
|
4546
|
+
body?: never;
|
|
4547
|
+
headers?: {
|
|
4548
|
+
/**
|
|
4549
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4550
|
+
*/
|
|
4551
|
+
'Typizer-Organization'?: string;
|
|
4552
|
+
};
|
|
4553
|
+
path?: never;
|
|
4554
|
+
query?: {
|
|
4555
|
+
/**
|
|
4556
|
+
* Поиск по названию, описанию, тегам и полям (в том числе латинским именам вроде `kpp`)
|
|
4557
|
+
*/
|
|
4558
|
+
q?: string;
|
|
4559
|
+
/**
|
|
4560
|
+
* Категория: `invoices` — счета и счета-фактуры, `bank` — банк и касса, `shipping` — отгрузка и перевозка, `contracts` — работы, сметы и договоры, `registries` — реестры и выписки, `hr` — кадровые документы, `identity` — удостоверения и авто. Раздела `medical` больше нет — ошибка 400
|
|
4561
|
+
*/
|
|
4562
|
+
category?: 'invoices' | 'bank' | 'shipping' | 'contracts' | 'registries' | 'hr' | 'identity';
|
|
4563
|
+
kind?: 'official' | 'community';
|
|
4564
|
+
/**
|
|
4565
|
+
* Slug автора; `typizer` — официальные
|
|
4566
|
+
*/
|
|
4567
|
+
publisher?: string;
|
|
4568
|
+
/**
|
|
4569
|
+
* Только избранное вашей организации
|
|
4570
|
+
*/
|
|
4571
|
+
favorites?: 'true';
|
|
4572
|
+
/**
|
|
4573
|
+
* `recommended` (по умолчанию), `popular`, `new`, `updated`
|
|
4574
|
+
*/
|
|
4575
|
+
sort?: 'recommended' | 'popular' | 'new' | 'updated';
|
|
4576
|
+
/**
|
|
4577
|
+
* Элементов на странице, 1–100
|
|
4578
|
+
*/
|
|
4579
|
+
limit?: number;
|
|
4580
|
+
/**
|
|
4581
|
+
* `next_cursor` предыдущей страницы
|
|
4582
|
+
*/
|
|
4583
|
+
cursor?: string;
|
|
4584
|
+
};
|
|
4585
|
+
url: '/v1/catalog';
|
|
4586
|
+
};
|
|
4587
|
+
export type ListCatalogErrors = {
|
|
4588
|
+
/**
|
|
4589
|
+
* `invalid_request`: Некорректный запрос
|
|
4590
|
+
*/
|
|
4591
|
+
400: Problem;
|
|
4592
|
+
/**
|
|
4593
|
+
* `unauthorized`: Не авторизовано
|
|
4594
|
+
*/
|
|
4595
|
+
401: Problem;
|
|
4596
|
+
/**
|
|
4597
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4598
|
+
*/
|
|
4599
|
+
403: Problem;
|
|
4600
|
+
/**
|
|
4601
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4602
|
+
*/
|
|
4603
|
+
429: Problem;
|
|
4604
|
+
/**
|
|
4605
|
+
* `internal_error`: Внутренняя ошибка
|
|
4606
|
+
*/
|
|
4607
|
+
500: Problem;
|
|
4608
|
+
/**
|
|
4609
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4610
|
+
*/
|
|
4611
|
+
503: Problem;
|
|
4612
|
+
};
|
|
4613
|
+
export type ListCatalogError = ListCatalogErrors[keyof ListCatalogErrors];
|
|
4614
|
+
export type ListCatalogResponses = {
|
|
4615
|
+
/**
|
|
4616
|
+
* Страница каталога
|
|
4617
|
+
*/
|
|
4618
|
+
200: CatalogList;
|
|
4619
|
+
};
|
|
4620
|
+
export type ListCatalogResponse = ListCatalogResponses[keyof ListCatalogResponses];
|
|
4621
|
+
export type InstallCatalogEntryData = {
|
|
4622
|
+
body?: CatalogInstallRequest;
|
|
4623
|
+
headers?: {
|
|
4624
|
+
/**
|
|
4625
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4626
|
+
*/
|
|
4627
|
+
'Typizer-Organization'?: string;
|
|
4628
|
+
/**
|
|
4629
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
4630
|
+
*/
|
|
4631
|
+
'Idempotency-Key'?: string;
|
|
4632
|
+
};
|
|
4633
|
+
path: {
|
|
4634
|
+
/**
|
|
4635
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
4636
|
+
*/
|
|
4637
|
+
entry: string;
|
|
4638
|
+
};
|
|
4639
|
+
query?: never;
|
|
4640
|
+
url: '/v1/catalog/{entry}/install';
|
|
4641
|
+
};
|
|
4642
|
+
export type InstallCatalogEntryErrors = {
|
|
4643
|
+
/**
|
|
4644
|
+
* `invalid_request`: Некорректный запрос
|
|
4645
|
+
*/
|
|
4646
|
+
400: Problem;
|
|
4647
|
+
/**
|
|
4648
|
+
* `unauthorized`: Не авторизовано
|
|
4649
|
+
*/
|
|
4650
|
+
401: Problem;
|
|
4651
|
+
/**
|
|
4652
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4653
|
+
*/
|
|
4654
|
+
403: Problem;
|
|
4655
|
+
/**
|
|
4656
|
+
* `not_found`: Не найдено
|
|
4657
|
+
*/
|
|
4658
|
+
404: Problem;
|
|
4659
|
+
/**
|
|
4660
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
4661
|
+
*/
|
|
4662
|
+
409: Problem;
|
|
4663
|
+
/**
|
|
4664
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4665
|
+
*/
|
|
4666
|
+
429: Problem;
|
|
4667
|
+
/**
|
|
4668
|
+
* `internal_error`: Внутренняя ошибка
|
|
4669
|
+
*/
|
|
4670
|
+
500: Problem;
|
|
4671
|
+
/**
|
|
4672
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4673
|
+
*/
|
|
4674
|
+
503: Problem;
|
|
4675
|
+
};
|
|
4676
|
+
export type InstallCatalogEntryError = InstallCatalogEntryErrors[keyof InstallCatalogEntryErrors];
|
|
4677
|
+
export type InstallCatalogEntryResponses = {
|
|
4678
|
+
/**
|
|
4679
|
+
* Уже добавлена
|
|
4680
|
+
*/
|
|
4681
|
+
200: Typizer;
|
|
4682
|
+
/**
|
|
4683
|
+
* Добавлена
|
|
4684
|
+
*/
|
|
4685
|
+
201: Typizer;
|
|
4686
|
+
};
|
|
4687
|
+
export type InstallCatalogEntryResponse = InstallCatalogEntryResponses[keyof InstallCatalogEntryResponses];
|
|
4688
|
+
export type ForkCatalogEntryData = {
|
|
4689
|
+
body?: CatalogInstallRequest;
|
|
4690
|
+
headers?: {
|
|
4691
|
+
/**
|
|
4692
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4693
|
+
*/
|
|
4694
|
+
'Typizer-Organization'?: string;
|
|
4695
|
+
/**
|
|
4696
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
4697
|
+
*/
|
|
4698
|
+
'Idempotency-Key'?: string;
|
|
4699
|
+
};
|
|
4700
|
+
path: {
|
|
4701
|
+
/**
|
|
4702
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
4703
|
+
*/
|
|
4704
|
+
entry: string;
|
|
4705
|
+
};
|
|
4706
|
+
query?: never;
|
|
4707
|
+
url: '/v1/catalog/{entry}/fork';
|
|
4708
|
+
};
|
|
4709
|
+
export type ForkCatalogEntryErrors = {
|
|
4710
|
+
/**
|
|
4711
|
+
* `invalid_request`: Некорректный запрос
|
|
4712
|
+
*/
|
|
4713
|
+
400: Problem;
|
|
4714
|
+
/**
|
|
4715
|
+
* `unauthorized`: Не авторизовано
|
|
4716
|
+
*/
|
|
4717
|
+
401: Problem;
|
|
4718
|
+
/**
|
|
4719
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4720
|
+
*/
|
|
4721
|
+
403: Problem;
|
|
4722
|
+
/**
|
|
4723
|
+
* `not_found`: Не найдено
|
|
4724
|
+
*/
|
|
4725
|
+
404: Problem;
|
|
4726
|
+
/**
|
|
4727
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
4728
|
+
*/
|
|
4729
|
+
409: Problem;
|
|
4730
|
+
/**
|
|
4731
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4732
|
+
*/
|
|
4733
|
+
429: Problem;
|
|
4734
|
+
/**
|
|
4735
|
+
* `internal_error`: Внутренняя ошибка
|
|
4736
|
+
*/
|
|
4737
|
+
500: Problem;
|
|
4738
|
+
/**
|
|
4739
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4740
|
+
*/
|
|
4741
|
+
503: Problem;
|
|
4742
|
+
};
|
|
4743
|
+
export type ForkCatalogEntryError = ForkCatalogEntryErrors[keyof ForkCatalogEntryErrors];
|
|
4744
|
+
export type ForkCatalogEntryResponses = {
|
|
4745
|
+
/**
|
|
4746
|
+
* Создан
|
|
4747
|
+
*/
|
|
4748
|
+
201: Typizer;
|
|
4749
|
+
};
|
|
4750
|
+
export type ForkCatalogEntryResponse = ForkCatalogEntryResponses[keyof ForkCatalogEntryResponses];
|
|
4751
|
+
export type UnfavoriteCatalogEntryData = {
|
|
4752
|
+
body?: never;
|
|
4753
|
+
headers?: {
|
|
4754
|
+
/**
|
|
4755
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4756
|
+
*/
|
|
4757
|
+
'Typizer-Organization'?: string;
|
|
4758
|
+
};
|
|
4759
|
+
path: {
|
|
4760
|
+
/**
|
|
4761
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
4762
|
+
*/
|
|
4763
|
+
entry: string;
|
|
4764
|
+
};
|
|
4765
|
+
query?: never;
|
|
4766
|
+
url: '/v1/catalog/{entry}/favorite';
|
|
4767
|
+
};
|
|
4768
|
+
export type UnfavoriteCatalogEntryErrors = {
|
|
4769
|
+
/**
|
|
4770
|
+
* `unauthorized`: Не авторизовано
|
|
4771
|
+
*/
|
|
4772
|
+
401: Problem;
|
|
4773
|
+
/**
|
|
4774
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
2626
4775
|
*/
|
|
2627
4776
|
403: Problem;
|
|
4777
|
+
/**
|
|
4778
|
+
* `not_found`: Не найдено
|
|
4779
|
+
*/
|
|
4780
|
+
404: Problem;
|
|
2628
4781
|
/**
|
|
2629
4782
|
* `rate_limited`: Превышен лимит запросов
|
|
2630
4783
|
*/
|
|
@@ -2638,40 +4791,83 @@ export type ListTypizersErrors = {
|
|
|
2638
4791
|
*/
|
|
2639
4792
|
503: Problem;
|
|
2640
4793
|
};
|
|
2641
|
-
export type
|
|
2642
|
-
export type
|
|
4794
|
+
export type UnfavoriteCatalogEntryError = UnfavoriteCatalogEntryErrors[keyof UnfavoriteCatalogEntryErrors];
|
|
4795
|
+
export type UnfavoriteCatalogEntryResponses = {
|
|
2643
4796
|
/**
|
|
2644
|
-
*
|
|
4797
|
+
* Состояние избранного
|
|
2645
4798
|
*/
|
|
2646
|
-
200:
|
|
2647
|
-
object: 'list';
|
|
2648
|
-
data: Array<Typizer>;
|
|
2649
|
-
has_more: boolean;
|
|
2650
|
-
next_cursor: string | null;
|
|
2651
|
-
};
|
|
4799
|
+
200: CatalogFavorite;
|
|
2652
4800
|
};
|
|
2653
|
-
export type
|
|
2654
|
-
export type
|
|
2655
|
-
body
|
|
4801
|
+
export type UnfavoriteCatalogEntryResponse = UnfavoriteCatalogEntryResponses[keyof UnfavoriteCatalogEntryResponses];
|
|
4802
|
+
export type FavoriteCatalogEntryData = {
|
|
4803
|
+
body?: never;
|
|
2656
4804
|
headers?: {
|
|
2657
4805
|
/**
|
|
2658
4806
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2659
4807
|
*/
|
|
2660
4808
|
'Typizer-Organization'?: string;
|
|
4809
|
+
};
|
|
4810
|
+
path: {
|
|
2661
4811
|
/**
|
|
2662
|
-
*
|
|
4812
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
2663
4813
|
*/
|
|
2664
|
-
|
|
4814
|
+
entry: string;
|
|
2665
4815
|
};
|
|
2666
|
-
path?: never;
|
|
2667
4816
|
query?: never;
|
|
2668
|
-
url: '/v1/
|
|
4817
|
+
url: '/v1/catalog/{entry}/favorite';
|
|
2669
4818
|
};
|
|
2670
|
-
export type
|
|
4819
|
+
export type FavoriteCatalogEntryErrors = {
|
|
2671
4820
|
/**
|
|
2672
|
-
* `
|
|
4821
|
+
* `unauthorized`: Не авторизовано
|
|
2673
4822
|
*/
|
|
2674
|
-
|
|
4823
|
+
401: Problem;
|
|
4824
|
+
/**
|
|
4825
|
+
* `insufficient_scope`: Недостаточно прав ключа; `forbidden`: Доступ запрещён
|
|
4826
|
+
*/
|
|
4827
|
+
403: Problem;
|
|
4828
|
+
/**
|
|
4829
|
+
* `not_found`: Не найдено
|
|
4830
|
+
*/
|
|
4831
|
+
404: Problem;
|
|
4832
|
+
/**
|
|
4833
|
+
* `rate_limited`: Превышен лимит запросов
|
|
4834
|
+
*/
|
|
4835
|
+
429: Problem;
|
|
4836
|
+
/**
|
|
4837
|
+
* `internal_error`: Внутренняя ошибка
|
|
4838
|
+
*/
|
|
4839
|
+
500: Problem;
|
|
4840
|
+
/**
|
|
4841
|
+
* `upstream_unavailable`: Сервис обработки временно недоступен
|
|
4842
|
+
*/
|
|
4843
|
+
503: Problem;
|
|
4844
|
+
};
|
|
4845
|
+
export type FavoriteCatalogEntryError = FavoriteCatalogEntryErrors[keyof FavoriteCatalogEntryErrors];
|
|
4846
|
+
export type FavoriteCatalogEntryResponses = {
|
|
4847
|
+
/**
|
|
4848
|
+
* Состояние избранного
|
|
4849
|
+
*/
|
|
4850
|
+
200: CatalogFavorite;
|
|
4851
|
+
};
|
|
4852
|
+
export type FavoriteCatalogEntryResponse = FavoriteCatalogEntryResponses[keyof FavoriteCatalogEntryResponses];
|
|
4853
|
+
export type ListCatalogVersionsData = {
|
|
4854
|
+
body?: never;
|
|
4855
|
+
headers?: {
|
|
4856
|
+
/**
|
|
4857
|
+
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
4858
|
+
*/
|
|
4859
|
+
'Typizer-Organization'?: string;
|
|
4860
|
+
};
|
|
4861
|
+
path: {
|
|
4862
|
+
/**
|
|
4863
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
4864
|
+
*/
|
|
4865
|
+
entry: string;
|
|
4866
|
+
};
|
|
4867
|
+
query?: never;
|
|
4868
|
+
url: '/v1/catalog/{entry}/versions';
|
|
4869
|
+
};
|
|
4870
|
+
export type ListCatalogVersionsErrors = {
|
|
2675
4871
|
/**
|
|
2676
4872
|
* `unauthorized`: Не авторизовано
|
|
2677
4873
|
*/
|
|
@@ -2681,9 +4877,9 @@ export type CreateTypizerErrors = {
|
|
|
2681
4877
|
*/
|
|
2682
4878
|
403: Problem;
|
|
2683
4879
|
/**
|
|
2684
|
-
* `
|
|
4880
|
+
* `not_found`: Не найдено
|
|
2685
4881
|
*/
|
|
2686
|
-
|
|
4882
|
+
404: Problem;
|
|
2687
4883
|
/**
|
|
2688
4884
|
* `rate_limited`: Превышен лимит запросов
|
|
2689
4885
|
*/
|
|
@@ -2697,33 +4893,43 @@ export type CreateTypizerErrors = {
|
|
|
2697
4893
|
*/
|
|
2698
4894
|
503: Problem;
|
|
2699
4895
|
};
|
|
2700
|
-
export type
|
|
2701
|
-
export type
|
|
4896
|
+
export type ListCatalogVersionsError = ListCatalogVersionsErrors[keyof ListCatalogVersionsErrors];
|
|
4897
|
+
export type ListCatalogVersionsResponses = {
|
|
2702
4898
|
/**
|
|
2703
|
-
*
|
|
4899
|
+
* Версии (до 100)
|
|
2704
4900
|
*/
|
|
2705
|
-
|
|
4901
|
+
200: {
|
|
4902
|
+
object: 'list';
|
|
4903
|
+
data: Array<CatalogVersionBrief>;
|
|
4904
|
+
has_more: boolean;
|
|
4905
|
+
next_cursor: string | null;
|
|
4906
|
+
};
|
|
2706
4907
|
};
|
|
2707
|
-
export type
|
|
2708
|
-
export type
|
|
2709
|
-
body:
|
|
4908
|
+
export type ListCatalogVersionsResponse = ListCatalogVersionsResponses[keyof ListCatalogVersionsResponses];
|
|
4909
|
+
export type ReportCatalogEntryData = {
|
|
4910
|
+
body: CatalogReportRequest;
|
|
2710
4911
|
headers?: {
|
|
2711
4912
|
/**
|
|
2712
4913
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2713
4914
|
*/
|
|
2714
4915
|
'Typizer-Organization'?: string;
|
|
2715
4916
|
/**
|
|
2716
|
-
*
|
|
4917
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
2717
4918
|
*/
|
|
2718
4919
|
'Idempotency-Key'?: string;
|
|
2719
4920
|
};
|
|
2720
|
-
path
|
|
4921
|
+
path: {
|
|
4922
|
+
/**
|
|
4923
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
4924
|
+
*/
|
|
4925
|
+
entry: string;
|
|
4926
|
+
};
|
|
2721
4927
|
query?: never;
|
|
2722
|
-
url: '/v1/
|
|
4928
|
+
url: '/v1/catalog/{entry}/reports';
|
|
2723
4929
|
};
|
|
2724
|
-
export type
|
|
4930
|
+
export type ReportCatalogEntryErrors = {
|
|
2725
4931
|
/**
|
|
2726
|
-
* `invalid_request`: Некорректный
|
|
4932
|
+
* `invalid_request`: Некорректный запрос
|
|
2727
4933
|
*/
|
|
2728
4934
|
400: Problem;
|
|
2729
4935
|
/**
|
|
@@ -2739,9 +4945,9 @@ export type GenerateTypizerErrors = {
|
|
|
2739
4945
|
*/
|
|
2740
4946
|
404: Problem;
|
|
2741
4947
|
/**
|
|
2742
|
-
* `
|
|
4948
|
+
* `conflict`: Конфликт состояния; `idempotency_conflict`: Конфликт идемпотентности
|
|
2743
4949
|
*/
|
|
2744
|
-
|
|
4950
|
+
409: Problem;
|
|
2745
4951
|
/**
|
|
2746
4952
|
* `rate_limited`: Превышен лимит запросов
|
|
2747
4953
|
*/
|
|
@@ -2755,31 +4961,38 @@ export type GenerateTypizerErrors = {
|
|
|
2755
4961
|
*/
|
|
2756
4962
|
503: Problem;
|
|
2757
4963
|
};
|
|
2758
|
-
export type
|
|
2759
|
-
export type
|
|
4964
|
+
export type ReportCatalogEntryError = ReportCatalogEntryErrors[keyof ReportCatalogEntryErrors];
|
|
4965
|
+
export type ReportCatalogEntryResponses = {
|
|
2760
4966
|
/**
|
|
2761
|
-
*
|
|
4967
|
+
* Жалоба принята
|
|
2762
4968
|
*/
|
|
2763
|
-
|
|
4969
|
+
201: CatalogReport;
|
|
2764
4970
|
};
|
|
2765
|
-
export type
|
|
2766
|
-
export type
|
|
4971
|
+
export type ReportCatalogEntryResponse = ReportCatalogEntryResponses[keyof ReportCatalogEntryResponses];
|
|
4972
|
+
export type UnpublishCatalogEntryData = {
|
|
2767
4973
|
body?: never;
|
|
2768
4974
|
headers?: {
|
|
2769
4975
|
/**
|
|
2770
4976
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2771
4977
|
*/
|
|
2772
4978
|
'Typizer-Organization'?: string;
|
|
4979
|
+
/**
|
|
4980
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
4981
|
+
*/
|
|
4982
|
+
'Idempotency-Key'?: string;
|
|
2773
4983
|
};
|
|
2774
4984
|
path: {
|
|
2775
|
-
|
|
4985
|
+
/**
|
|
4986
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
4987
|
+
*/
|
|
4988
|
+
entry: string;
|
|
2776
4989
|
};
|
|
2777
4990
|
query?: never;
|
|
2778
|
-
url: '/v1/
|
|
4991
|
+
url: '/v1/catalog/{entry}/unpublish';
|
|
2779
4992
|
};
|
|
2780
|
-
export type
|
|
4993
|
+
export type UnpublishCatalogEntryErrors = {
|
|
2781
4994
|
/**
|
|
2782
|
-
* `
|
|
4995
|
+
* `invalid_request`: Некорректный запрос
|
|
2783
4996
|
*/
|
|
2784
4997
|
400: Problem;
|
|
2785
4998
|
/**
|
|
@@ -2787,13 +5000,17 @@ export type DeleteTypizerErrors = {
|
|
|
2787
5000
|
*/
|
|
2788
5001
|
401: Problem;
|
|
2789
5002
|
/**
|
|
2790
|
-
* `
|
|
5003
|
+
* `forbidden`: Доступ запрещён
|
|
2791
5004
|
*/
|
|
2792
5005
|
403: Problem;
|
|
2793
5006
|
/**
|
|
2794
5007
|
* `not_found`: Не найдено
|
|
2795
5008
|
*/
|
|
2796
5009
|
404: Problem;
|
|
5010
|
+
/**
|
|
5011
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
5012
|
+
*/
|
|
5013
|
+
409: Problem;
|
|
2797
5014
|
/**
|
|
2798
5015
|
* `rate_limited`: Превышен лимит запросов
|
|
2799
5016
|
*/
|
|
@@ -2807,15 +5024,15 @@ export type DeleteTypizerErrors = {
|
|
|
2807
5024
|
*/
|
|
2808
5025
|
503: Problem;
|
|
2809
5026
|
};
|
|
2810
|
-
export type
|
|
2811
|
-
export type
|
|
5027
|
+
export type UnpublishCatalogEntryError = UnpublishCatalogEntryErrors[keyof UnpublishCatalogEntryErrors];
|
|
5028
|
+
export type UnpublishCatalogEntryResponses = {
|
|
2812
5029
|
/**
|
|
2813
|
-
*
|
|
5030
|
+
* Снята с публикации
|
|
2814
5031
|
*/
|
|
2815
|
-
200:
|
|
5032
|
+
200: CatalogEntry;
|
|
2816
5033
|
};
|
|
2817
|
-
export type
|
|
2818
|
-
export type
|
|
5034
|
+
export type UnpublishCatalogEntryResponse = UnpublishCatalogEntryResponses[keyof UnpublishCatalogEntryResponses];
|
|
5035
|
+
export type GetCatalogEntryData = {
|
|
2819
5036
|
body?: never;
|
|
2820
5037
|
headers?: {
|
|
2821
5038
|
/**
|
|
@@ -2824,14 +5041,22 @@ export type GetTypizerData = {
|
|
|
2824
5041
|
'Typizer-Organization'?: string;
|
|
2825
5042
|
};
|
|
2826
5043
|
path: {
|
|
2827
|
-
|
|
5044
|
+
/**
|
|
5045
|
+
* Идентификатор `cat_…` или slug официальной схемы
|
|
5046
|
+
*/
|
|
5047
|
+
entry: string;
|
|
2828
5048
|
};
|
|
2829
|
-
query?:
|
|
2830
|
-
|
|
5049
|
+
query?: {
|
|
5050
|
+
/**
|
|
5051
|
+
* Мажор (`1` — последняя 1.x) или точная версия (`1.2.0`)
|
|
5052
|
+
*/
|
|
5053
|
+
version?: string;
|
|
5054
|
+
};
|
|
5055
|
+
url: '/v1/catalog/{entry}';
|
|
2831
5056
|
};
|
|
2832
|
-
export type
|
|
5057
|
+
export type GetCatalogEntryErrors = {
|
|
2833
5058
|
/**
|
|
2834
|
-
* `
|
|
5059
|
+
* `invalid_request`: Некорректный запрос
|
|
2835
5060
|
*/
|
|
2836
5061
|
400: Problem;
|
|
2837
5062
|
/**
|
|
@@ -2859,16 +5084,16 @@ export type GetTypizerErrors = {
|
|
|
2859
5084
|
*/
|
|
2860
5085
|
503: Problem;
|
|
2861
5086
|
};
|
|
2862
|
-
export type
|
|
2863
|
-
export type
|
|
5087
|
+
export type GetCatalogEntryError = GetCatalogEntryErrors[keyof GetCatalogEntryErrors];
|
|
5088
|
+
export type GetCatalogEntryResponses = {
|
|
2864
5089
|
/**
|
|
2865
|
-
*
|
|
5090
|
+
* Схема
|
|
2866
5091
|
*/
|
|
2867
|
-
200:
|
|
5092
|
+
200: CatalogEntry;
|
|
2868
5093
|
};
|
|
2869
|
-
export type
|
|
2870
|
-
export type
|
|
2871
|
-
body
|
|
5094
|
+
export type GetCatalogEntryResponse = GetCatalogEntryResponses[keyof GetCatalogEntryResponses];
|
|
5095
|
+
export type GetCommunityCatalogEntryData = {
|
|
5096
|
+
body?: never;
|
|
2872
5097
|
headers?: {
|
|
2873
5098
|
/**
|
|
2874
5099
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
@@ -2876,14 +5101,20 @@ export type UpdateTypizerData = {
|
|
|
2876
5101
|
'Typizer-Organization'?: string;
|
|
2877
5102
|
};
|
|
2878
5103
|
path: {
|
|
2879
|
-
|
|
5104
|
+
publisher: string;
|
|
5105
|
+
slug: string;
|
|
2880
5106
|
};
|
|
2881
|
-
query?:
|
|
2882
|
-
|
|
5107
|
+
query?: {
|
|
5108
|
+
/**
|
|
5109
|
+
* Мажор (`1` — последняя 1.x) или точная версия (`1.2.0`)
|
|
5110
|
+
*/
|
|
5111
|
+
version?: string;
|
|
5112
|
+
};
|
|
5113
|
+
url: '/v1/catalog/{publisher}/{slug}';
|
|
2883
5114
|
};
|
|
2884
|
-
export type
|
|
5115
|
+
export type GetCommunityCatalogEntryErrors = {
|
|
2885
5116
|
/**
|
|
2886
|
-
* `
|
|
5117
|
+
* `invalid_request`: Некорректный запрос
|
|
2887
5118
|
*/
|
|
2888
5119
|
400: Problem;
|
|
2889
5120
|
/**
|
|
@@ -2911,38 +5142,33 @@ export type UpdateTypizerErrors = {
|
|
|
2911
5142
|
*/
|
|
2912
5143
|
503: Problem;
|
|
2913
5144
|
};
|
|
2914
|
-
export type
|
|
2915
|
-
export type
|
|
5145
|
+
export type GetCommunityCatalogEntryError = GetCommunityCatalogEntryErrors[keyof GetCommunityCatalogEntryErrors];
|
|
5146
|
+
export type GetCommunityCatalogEntryResponses = {
|
|
2916
5147
|
/**
|
|
2917
|
-
*
|
|
5148
|
+
* Схема
|
|
2918
5149
|
*/
|
|
2919
|
-
200:
|
|
5150
|
+
200: CatalogEntry;
|
|
2920
5151
|
};
|
|
2921
|
-
export type
|
|
2922
|
-
export type
|
|
2923
|
-
body
|
|
5152
|
+
export type GetCommunityCatalogEntryResponse = GetCommunityCatalogEntryResponses[keyof GetCommunityCatalogEntryResponses];
|
|
5153
|
+
export type PublishTypizerData = {
|
|
5154
|
+
body: PublishTypizerRequest;
|
|
2924
5155
|
headers?: {
|
|
2925
5156
|
/**
|
|
2926
5157
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
2927
5158
|
*/
|
|
2928
5159
|
'Typizer-Organization'?: string;
|
|
5160
|
+
/**
|
|
5161
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
5162
|
+
*/
|
|
5163
|
+
'Idempotency-Key'?: string;
|
|
2929
5164
|
};
|
|
2930
5165
|
path: {
|
|
2931
5166
|
id: string;
|
|
2932
5167
|
};
|
|
2933
|
-
query?:
|
|
2934
|
-
|
|
2935
|
-
* Элементов на странице, 1–100
|
|
2936
|
-
*/
|
|
2937
|
-
limit?: number;
|
|
2938
|
-
/**
|
|
2939
|
-
* `next_cursor` предыдущей страницы: список продолжается после этого идентификатора
|
|
2940
|
-
*/
|
|
2941
|
-
starting_after?: string;
|
|
2942
|
-
};
|
|
2943
|
-
url: '/v1/typizers/{id}/versions';
|
|
5168
|
+
query?: never;
|
|
5169
|
+
url: '/v1/typizers/{id}/publish';
|
|
2944
5170
|
};
|
|
2945
|
-
export type
|
|
5171
|
+
export type PublishTypizerErrors = {
|
|
2946
5172
|
/**
|
|
2947
5173
|
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
2948
5174
|
*/
|
|
@@ -2952,13 +5178,17 @@ export type ListTypizerVersionsErrors = {
|
|
|
2952
5178
|
*/
|
|
2953
5179
|
401: Problem;
|
|
2954
5180
|
/**
|
|
2955
|
-
* `
|
|
5181
|
+
* `forbidden`: Доступ запрещён
|
|
2956
5182
|
*/
|
|
2957
5183
|
403: Problem;
|
|
2958
5184
|
/**
|
|
2959
5185
|
* `not_found`: Не найдено
|
|
2960
5186
|
*/
|
|
2961
5187
|
404: Problem;
|
|
5188
|
+
/**
|
|
5189
|
+
* `idempotency_conflict`: Конфликт идемпотентности
|
|
5190
|
+
*/
|
|
5191
|
+
409: Problem;
|
|
2962
5192
|
/**
|
|
2963
5193
|
* `rate_limited`: Превышен лимит запросов
|
|
2964
5194
|
*/
|
|
@@ -2972,20 +5202,19 @@ export type ListTypizerVersionsErrors = {
|
|
|
2972
5202
|
*/
|
|
2973
5203
|
503: Problem;
|
|
2974
5204
|
};
|
|
2975
|
-
export type
|
|
2976
|
-
export type
|
|
5205
|
+
export type PublishTypizerError = PublishTypizerErrors[keyof PublishTypizerErrors];
|
|
5206
|
+
export type PublishTypizerResponses = {
|
|
2977
5207
|
/**
|
|
2978
|
-
*
|
|
5208
|
+
* Новая версия
|
|
2979
5209
|
*/
|
|
2980
|
-
200:
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
};
|
|
5210
|
+
200: CatalogEntry;
|
|
5211
|
+
/**
|
|
5212
|
+
* Опубликована
|
|
5213
|
+
*/
|
|
5214
|
+
201: CatalogEntry;
|
|
2986
5215
|
};
|
|
2987
|
-
export type
|
|
2988
|
-
export type
|
|
5216
|
+
export type PublishTypizerResponse = PublishTypizerResponses[keyof PublishTypizerResponses];
|
|
5217
|
+
export type GetTypizerCatalogUpdateData = {
|
|
2989
5218
|
body?: never;
|
|
2990
5219
|
headers?: {
|
|
2991
5220
|
/**
|
|
@@ -2995,12 +5224,16 @@ export type GetTypizerVersionData = {
|
|
|
2995
5224
|
};
|
|
2996
5225
|
path: {
|
|
2997
5226
|
id: string;
|
|
2998
|
-
n: number;
|
|
2999
5227
|
};
|
|
3000
|
-
query?:
|
|
3001
|
-
|
|
5228
|
+
query?: {
|
|
5229
|
+
/**
|
|
5230
|
+
* Мажор (`1` — последняя 1.x) или точная версия (`1.2.0`)
|
|
5231
|
+
*/
|
|
5232
|
+
version?: string;
|
|
5233
|
+
};
|
|
5234
|
+
url: '/v1/typizers/{id}/catalog_update';
|
|
3002
5235
|
};
|
|
3003
|
-
export type
|
|
5236
|
+
export type GetTypizerCatalogUpdateErrors = {
|
|
3004
5237
|
/**
|
|
3005
5238
|
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
3006
5239
|
*/
|
|
@@ -3017,6 +5250,10 @@ export type GetTypizerVersionErrors = {
|
|
|
3017
5250
|
* `not_found`: Не найдено
|
|
3018
5251
|
*/
|
|
3019
5252
|
404: Problem;
|
|
5253
|
+
/**
|
|
5254
|
+
* `conflict`: Конфликт состояния
|
|
5255
|
+
*/
|
|
5256
|
+
409: Problem;
|
|
3020
5257
|
/**
|
|
3021
5258
|
* `rate_limited`: Превышен лимит запросов
|
|
3022
5259
|
*/
|
|
@@ -3030,31 +5267,35 @@ export type GetTypizerVersionErrors = {
|
|
|
3030
5267
|
*/
|
|
3031
5268
|
503: Problem;
|
|
3032
5269
|
};
|
|
3033
|
-
export type
|
|
3034
|
-
export type
|
|
5270
|
+
export type GetTypizerCatalogUpdateError = GetTypizerCatalogUpdateErrors[keyof GetTypizerCatalogUpdateErrors];
|
|
5271
|
+
export type GetTypizerCatalogUpdateResponses = {
|
|
3035
5272
|
/**
|
|
3036
|
-
*
|
|
5273
|
+
* Обновление
|
|
3037
5274
|
*/
|
|
3038
|
-
200:
|
|
5275
|
+
200: CatalogUpdate;
|
|
3039
5276
|
};
|
|
3040
|
-
export type
|
|
3041
|
-
export type
|
|
3042
|
-
body
|
|
5277
|
+
export type GetTypizerCatalogUpdateResponse = GetTypizerCatalogUpdateResponses[keyof GetTypizerCatalogUpdateResponses];
|
|
5278
|
+
export type ApplyTypizerCatalogUpdateData = {
|
|
5279
|
+
body: CatalogUpdateRequest;
|
|
3043
5280
|
headers?: {
|
|
3044
5281
|
/**
|
|
3045
5282
|
* Организация, от имени которой выполняется запрос (`org_…`). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
|
|
3046
5283
|
*/
|
|
3047
5284
|
'Typizer-Organization'?: string;
|
|
5285
|
+
/**
|
|
5286
|
+
* 1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (`Idempotent-Replayed: true`); тот же ключ с другим запросом или пока первый ещё выполняется — 409 `idempotency_conflict`.
|
|
5287
|
+
*/
|
|
5288
|
+
'Idempotency-Key'?: string;
|
|
3048
5289
|
};
|
|
3049
5290
|
path: {
|
|
3050
5291
|
id: string;
|
|
3051
5292
|
};
|
|
3052
5293
|
query?: never;
|
|
3053
|
-
url: '/v1/typizers/{id}/
|
|
5294
|
+
url: '/v1/typizers/{id}/catalog_update';
|
|
3054
5295
|
};
|
|
3055
|
-
export type
|
|
5296
|
+
export type ApplyTypizerCatalogUpdateErrors = {
|
|
3056
5297
|
/**
|
|
3057
|
-
* `invalid_id`: Некорректный идентификатор
|
|
5298
|
+
* `invalid_request`: Некорректный запрос; `invalid_id`: Некорректный идентификатор
|
|
3058
5299
|
*/
|
|
3059
5300
|
400: Problem;
|
|
3060
5301
|
/**
|
|
@@ -3069,6 +5310,10 @@ export type GetTypizerXsdErrors = {
|
|
|
3069
5310
|
* `not_found`: Не найдено
|
|
3070
5311
|
*/
|
|
3071
5312
|
404: Problem;
|
|
5313
|
+
/**
|
|
5314
|
+
* `conflict`: Конфликт состояния; `idempotency_conflict`: Конфликт идемпотентности
|
|
5315
|
+
*/
|
|
5316
|
+
409: Problem;
|
|
3072
5317
|
/**
|
|
3073
5318
|
* `rate_limited`: Превышен лимит запросов
|
|
3074
5319
|
*/
|
|
@@ -3082,14 +5327,14 @@ export type GetTypizerXsdErrors = {
|
|
|
3082
5327
|
*/
|
|
3083
5328
|
503: Problem;
|
|
3084
5329
|
};
|
|
3085
|
-
export type
|
|
3086
|
-
export type
|
|
5330
|
+
export type ApplyTypizerCatalogUpdateError = ApplyTypizerCatalogUpdateErrors[keyof ApplyTypizerCatalogUpdateErrors];
|
|
5331
|
+
export type ApplyTypizerCatalogUpdateResponses = {
|
|
3087
5332
|
/**
|
|
3088
|
-
*
|
|
5333
|
+
* Типизатор после обновления
|
|
3089
5334
|
*/
|
|
3090
|
-
200:
|
|
5335
|
+
200: Typizer;
|
|
3091
5336
|
};
|
|
3092
|
-
export type
|
|
5337
|
+
export type ApplyTypizerCatalogUpdateResponse = ApplyTypizerCatalogUpdateResponses[keyof ApplyTypizerCatalogUpdateResponses];
|
|
3093
5338
|
export type CreateRunData = {
|
|
3094
5339
|
body?: CreateRunRequest;
|
|
3095
5340
|
headers?: {
|
|
@@ -3196,7 +5441,7 @@ export type ListRunsData = {
|
|
|
3196
5441
|
status?: 'queued' | 'processing' | 'succeeded' | 'failed';
|
|
3197
5442
|
typizer_id?: string;
|
|
3198
5443
|
batch_id?: string;
|
|
3199
|
-
source?: 'api' | 'my' | 'mcp' | 'demo' | 'agent';
|
|
5444
|
+
source?: 'api' | 'my' | 'mcp' | 'demo' | 'agent' | 'email';
|
|
3200
5445
|
/**
|
|
3201
5446
|
* Только прогоны, созданные позже этого момента (не включая его)
|
|
3202
5447
|
*/
|