typizer 0.0.0-stage → 0.1.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/LICENSE +21 -0
- package/README.md +222 -2
- package/dist/gen/client/client.gen.d.ts +2 -0
- package/dist/gen/client/client.gen.js +216 -0
- package/dist/gen/client/index.d.ts +10 -0
- package/dist/gen/client/index.js +6 -0
- package/dist/gen/client/types.gen.d.ts +120 -0
- package/dist/gen/client/types.gen.js +2 -0
- package/dist/gen/client/utils.gen.d.ts +37 -0
- package/dist/gen/client/utils.gen.js +228 -0
- package/dist/gen/client.gen.d.ts +12 -0
- package/dist/gen/client.gen.js +3 -0
- package/dist/gen/core/auth.gen.d.ts +25 -0
- package/dist/gen/core/auth.gen.js +14 -0
- package/dist/gen/core/bodySerializer.gen.d.ts +25 -0
- package/dist/gen/core/bodySerializer.gen.js +57 -0
- package/dist/gen/core/params.gen.d.ts +43 -0
- package/dist/gen/core/params.gen.js +109 -0
- package/dist/gen/core/pathSerializer.gen.d.ts +33 -0
- package/dist/gen/core/pathSerializer.gen.js +106 -0
- package/dist/gen/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/gen/core/queryKeySerializer.gen.js +92 -0
- package/dist/gen/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/gen/core/serverSentEvents.gen.js +132 -0
- package/dist/gen/core/types.gen.d.ts +83 -0
- package/dist/gen/core/types.gen.js +2 -0
- package/dist/gen/core/utils.gen.d.ts +19 -0
- package/dist/gen/core/utils.gen.js +87 -0
- package/dist/gen/index.d.ts +2 -0
- package/dist/gen/index.js +2 -0
- package/dist/gen/sdk.gen.d.ts +540 -0
- package/dist/gen/sdk.gen.js +1130 -0
- package/dist/gen/types.gen.d.ts +4741 -0
- package/dist/gen/types.gen.js +2 -0
- package/dist/index.d.ts +20 -0
- package/dist/index.js +17 -0
- package/package.json +52 -3
|
@@ -0,0 +1,540 @@
|
|
|
1
|
+
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type ServerSentEventsResult, type TDataShape } from './client/index.js';
|
|
2
|
+
import type { CreateAgentMessageData, CreateAgentMessageResponse, CreateAgentMessageResponses, CreateAgentSampleRunData, CreateAgentSampleRunErrors, CreateAgentSampleRunResponses, CreateAgentThreadData, CreateAgentThreadErrors, CreateAgentThreadResponses, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateBatchData, CreateBatchErrors, CreateBatchResponses, CreateCheckoutData, CreateCheckoutErrors, CreateCheckoutResponses, CreateConsentData, CreateConsentErrors, CreateConsentResponses, CreateContractRequestData, CreateContractRequestErrors, CreateContractRequestResponses, CreateDemoRunData, CreateDemoRunErrors, CreateDemoRunResponses, CreateFileData, CreateFileErrors, CreateFileResponses, CreateInvoiceData, CreateInvoiceErrors, CreateInvoiceResponses, CreateRunData, CreateRunErrors, CreateRunResponses, CreateTypizerData, CreateTypizerErrors, CreateTypizerResponses, CreateWebhookEndpointData, CreateWebhookEndpointErrors, CreateWebhookEndpointResponses, DeleteApiKeyData, DeleteApiKeyErrors, DeleteApiKeyResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteMeData, DeleteMeErrors, DeleteMeResponses, DeleteOrganizationData, DeleteOrganizationErrors, DeleteOrganizationResponses, DeleteTypizerData, DeleteTypizerErrors, DeleteTypizerResponses, DeleteWebhookEndpointData, DeleteWebhookEndpointErrors, DeleteWebhookEndpointResponses, ExportBatchData, ExportBatchErrors, ExportBatchResponses, ExtractData, ExtractErrors, ExtractResponses, GenerateTypizerData, GenerateTypizerErrors, GenerateTypizerResponses, GetActPdfData, GetActPdfErrors, GetActPdfResponses, GetAgentThreadData, GetAgentThreadErrors, GetAgentThreadResponses, GetBalanceData, GetBalanceErrors, GetBalanceResponses, GetBatchData, GetBatchErrors, GetBatchResponses, GetBillingProfileData, GetBillingProfileErrors, GetBillingProfileResponses, GetCompanyData, GetCompanyErrors, GetCompanyResponses, GetContractRequestPdfData, GetContractRequestPdfErrors, GetContractRequestPdfResponses, GetDemoRunData, GetDemoRunErrors, GetDemoRunResponses, GetFileContentData, GetFileContentErrors, GetFileContentResponses, GetFileData, GetFileErrors, GetFileResponses, GetMeData, GetMeErrors, GetMeResponses, GetMyConsentsData, GetMyConsentsErrors, GetMyConsentsResponses, GetOpenApiDocumentData, GetOpenApiDocumentErrors, GetOpenApiDocumentResponses, GetOrganizationData, GetOrganizationErrors, GetOrganizationResponses, GetPaymentData, GetPaymentErrors, GetPaymentResponses, GetRunData, GetRunErrors, GetRunOutputData, GetRunOutputErrors, GetRunOutputResponses, GetRunResponses, GetStatusData, GetStatusErrors, GetStatusResponses, GetTypizerData, GetTypizerErrors, GetTypizerResponses, GetTypizerVersionData, GetTypizerVersionErrors, GetTypizerVersionResponses, GetTypizerXsdData, GetTypizerXsdErrors, GetTypizerXsdResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetWebhookEndpointData, GetWebhookEndpointErrors, GetWebhookEndpointResponses, ListAgentThreadsData, ListAgentThreadsErrors, ListAgentThreadsResponses, ListApiKeysData, ListApiKeysErrors, ListApiKeysResponses, ListBatchesData, ListBatchesErrors, ListBatchesResponses, ListContractRequestsData, ListContractRequestsErrors, ListContractRequestsResponses, ListDemoSamplesData, ListDemoSamplesErrors, ListDemoSamplesResponses, ListPaymentsData, ListPaymentsErrors, ListPaymentsResponses, ListRunsData, ListRunsErrors, ListRunsResponses, ListSignInsData, ListSignInsErrors, ListSignInsResponses, ListTypizersData, ListTypizersErrors, ListTypizersResponses, ListTypizerVersionsData, ListTypizerVersionsErrors, ListTypizerVersionsResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhookEndpointsData, ListWebhookEndpointsErrors, ListWebhookEndpointsResponses, RetryRunData, RetryRunErrors, RetryRunResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, SaveAgentThreadData, SaveAgentThreadErrors, SaveAgentThreadResponses, StartLoginData, StartLoginErrors, StartLoginResponses, SuggestCompaniesData, SuggestCompaniesErrors, SuggestCompaniesResponses, TestWebhookEndpointData, TestWebhookEndpointErrors, TestWebhookEndpointResponses, UpdateAgentThreadData, UpdateAgentThreadErrors, UpdateAgentThreadResponses, UpdateAutotopupData, UpdateAutotopupErrors, UpdateAutotopupResponses, UpdateBillingProfileData, UpdateBillingProfileErrors, UpdateBillingProfileResponses, UpdateOrganizationData, UpdateOrganizationErrors, UpdateOrganizationResponses, UpdateTypizerData, UpdateTypizerErrors, UpdateTypizerResponses, UpdateWebhookEndpointData, UpdateWebhookEndpointErrors, UpdateWebhookEndpointResponses } from './types.gen.js';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Начать вход: отправить на почту одноразовый код и ссылку для входа
|
|
18
|
+
*
|
|
19
|
+
* Доступ: публичный, без учётных данных.
|
|
20
|
+
*/
|
|
21
|
+
export declare const startLogin: <ThrowOnError extends boolean = false>(options: Options<StartLoginData, ThrowOnError>) => RequestResult<StartLoginResponses, StartLoginErrors, ThrowOnError>;
|
|
22
|
+
/**
|
|
23
|
+
* Купить пакет страниц картой, через СБП или другим способом платёжной формы банка
|
|
24
|
+
*
|
|
25
|
+
* Создаёт платёж и возвращает платёжную форму банка. Страницы зачисляются, когда банк подтвердит платёж.
|
|
26
|
+
*
|
|
27
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
28
|
+
*/
|
|
29
|
+
export declare const createCheckout: <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutData, ThrowOnError>) => RequestResult<CreateCheckoutResponses, CreateCheckoutErrors, ThrowOnError>;
|
|
30
|
+
/**
|
|
31
|
+
* Найти компании и ИП по названию, ИНН или ОГРН
|
|
32
|
+
*
|
|
33
|
+
* Доступ: только сессия.
|
|
34
|
+
*/
|
|
35
|
+
export declare const suggestCompanies: <ThrowOnError extends boolean = false>(options: Options<SuggestCompaniesData, ThrowOnError>) => RequestResult<SuggestCompaniesResponses, SuggestCompaniesErrors, ThrowOnError>;
|
|
36
|
+
/**
|
|
37
|
+
* Получить компанию или ИП по ИНН
|
|
38
|
+
*
|
|
39
|
+
* Доступ: только сессия.
|
|
40
|
+
*/
|
|
41
|
+
export declare const getCompany: <ThrowOnError extends boolean = false>(options: Options<GetCompanyData, ThrowOnError>) => RequestResult<GetCompanyResponses, GetCompanyErrors, ThrowOnError>;
|
|
42
|
+
/**
|
|
43
|
+
* Платёжные реквизиты организации и настройки автопополнения
|
|
44
|
+
*
|
|
45
|
+
* Доступ: только сессия.
|
|
46
|
+
*/
|
|
47
|
+
export declare const getBillingProfile: <ThrowOnError extends boolean = false>(options?: Options<GetBillingProfileData, ThrowOnError>) => RequestResult<GetBillingProfileResponses, GetBillingProfileErrors, ThrowOnError>;
|
|
48
|
+
/**
|
|
49
|
+
* Сохранить платёжные реквизиты организации (для счетов и закрывающих документов)
|
|
50
|
+
*
|
|
51
|
+
* ИНН, КПП и ОГРН проверяются; компания ищется в реестре. Разовый бонус за ИНН начисляется, когда организация оплатила пакет и её ИНН принадлежит действующей компании: при этом сохранении, если оплата уже была, иначе после первой оплаты.
|
|
52
|
+
*
|
|
53
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
54
|
+
*/
|
|
55
|
+
export declare const updateBillingProfile: <ThrowOnError extends boolean = false>(options: Options<UpdateBillingProfileData, ThrowOnError>) => RequestResult<UpdateBillingProfileResponses, UpdateBillingProfileErrors, ThrowOnError>;
|
|
56
|
+
/**
|
|
57
|
+
* Скачать акт оказанных услуг в PDF
|
|
58
|
+
*
|
|
59
|
+
* Всегда скачивание (Content-Disposition: attachment). Не больше 2 скачиваний одновременно на организацию (и на пользователя): сверх этого 429 с Retry-After.
|
|
60
|
+
*
|
|
61
|
+
* Доступ: только сессия.
|
|
62
|
+
*/
|
|
63
|
+
export declare const getActPdf: <ThrowOnError extends boolean = false>(options: Options<GetActPdfData, ThrowOnError>) => RequestResult<GetActPdfResponses, GetActPdfErrors, ThrowOnError>;
|
|
64
|
+
/**
|
|
65
|
+
* Запросить счёт на пакет страниц (для компаний и ИП)
|
|
66
|
+
*
|
|
67
|
+
* Нужен платёжный профиль с ИНН. Банк выставляет счёт и отправляет его на почту; страницы зачисляются после оплаты.
|
|
68
|
+
*
|
|
69
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
70
|
+
*/
|
|
71
|
+
export declare const createInvoice: <ThrowOnError extends boolean = false>(options: Options<CreateInvoiceData, ThrowOnError>) => RequestResult<CreateInvoiceResponses, CreateInvoiceErrors, ThrowOnError>;
|
|
72
|
+
/**
|
|
73
|
+
* Включить автопополнение (с согласием) или выключить, сменить пакет или порог
|
|
74
|
+
*
|
|
75
|
+
* Для включения нужна карта, сохранённая при оплате с согласием на автопополнение (иначе 409). Выключение также удаляет сохранённую карту.
|
|
76
|
+
*
|
|
77
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
78
|
+
*/
|
|
79
|
+
export declare const updateAutotopup: <ThrowOnError extends boolean = false>(options: Options<UpdateAutotopupData, ThrowOnError>) => RequestResult<UpdateAutotopupResponses, UpdateAutotopupErrors, ThrowOnError>;
|
|
80
|
+
/**
|
|
81
|
+
* Запросы договоров организации, новые первыми
|
|
82
|
+
*
|
|
83
|
+
* Доступ: только сессия.
|
|
84
|
+
*/
|
|
85
|
+
export declare const listContractRequests: <ThrowOnError extends boolean = false>(options?: Options<ListContractRequestsData, ThrowOnError>) => RequestResult<ListContractRequestsResponses, ListContractRequestsErrors, ThrowOnError>;
|
|
86
|
+
/**
|
|
87
|
+
* Запросить подписанный договор (для компаний и ИП)
|
|
88
|
+
*
|
|
89
|
+
* Договор составляется по платёжному профилю и отправляется через Диадок или письмом на адрес для документов. Не больше 5 запросов на организацию в сутки. Новый запрос отклоняется, пока предыдущий в работе; договор, отправленный письмом, перестаёт считаться в работе через 30 дней.
|
|
90
|
+
*
|
|
91
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
92
|
+
*/
|
|
93
|
+
export declare const createContractRequest: <ThrowOnError extends boolean = false>(options?: Options<CreateContractRequestData, ThrowOnError>) => RequestResult<CreateContractRequestResponses, CreateContractRequestErrors, ThrowOnError>;
|
|
94
|
+
/**
|
|
95
|
+
* Скачать запрошенный договор в PDF
|
|
96
|
+
*
|
|
97
|
+
* Всегда скачивание (Content-Disposition: attachment). Не больше 2 скачиваний одновременно на организацию (и на пользователя).
|
|
98
|
+
*
|
|
99
|
+
* Доступ: только сессия.
|
|
100
|
+
*/
|
|
101
|
+
export declare const getContractRequestPdf: <ThrowOnError extends boolean = false>(options: Options<GetContractRequestPdfData, ThrowOnError>) => RequestResult<GetContractRequestPdfResponses, GetContractRequestPdfErrors, ThrowOnError>;
|
|
102
|
+
/**
|
|
103
|
+
* Платежи организации, новые первыми
|
|
104
|
+
*
|
|
105
|
+
* Доступ: только сессия.
|
|
106
|
+
*/
|
|
107
|
+
export declare const listPayments: <ThrowOnError extends boolean = false>(options?: Options<ListPaymentsData, ThrowOnError>) => RequestResult<ListPaymentsResponses, ListPaymentsErrors, ThrowOnError>;
|
|
108
|
+
/**
|
|
109
|
+
* Получить платёж со счётом и актом
|
|
110
|
+
*
|
|
111
|
+
* Доступ: только сессия.
|
|
112
|
+
*/
|
|
113
|
+
export declare const getPayment: <ThrowOnError extends boolean = false>(options: Options<GetPaymentData, ThrowOnError>) => RequestResult<GetPaymentResponses, GetPaymentErrors, ThrowOnError>;
|
|
114
|
+
/**
|
|
115
|
+
* Записать необязательное согласие (аналитические cookie, маркетинг)
|
|
116
|
+
*
|
|
117
|
+
* Записывает в журнал одно решение: согласие дано или отозвано. Вызывается с typizer.ru и из Кабинета, поэтому нужен собственный Origin. Cookie сессии необязательна: с ней запись привязывается к аккаунту; для marketing она нужна (без неё 401). doc_version должна быть текущей версией документа. 120 запросов в минуту с одного адреса. Idempotency-Key игнорируется.
|
|
118
|
+
*
|
|
119
|
+
* Доступ: публичный; сессия необязательна (с ней запрос выполняется от имени её пользователя).
|
|
120
|
+
*/
|
|
121
|
+
export declare const createConsent: <ThrowOnError extends boolean = false>(options: Options<CreateConsentData, ThrowOnError>) => RequestResult<CreateConsentResponses, CreateConsentErrors, ThrowOnError>;
|
|
122
|
+
/**
|
|
123
|
+
* Образцы для демо на лендинге
|
|
124
|
+
*
|
|
125
|
+
* Без авторизации. Синтетические документы-образцы и запрос, показываемый для каждого. Как и любой вызов /v1, входит в общий лимит запросов с одного адреса (429 с Retry-After).
|
|
126
|
+
*
|
|
127
|
+
* Доступ: публичный, без учётных данных.
|
|
128
|
+
*/
|
|
129
|
+
export declare const listDemoSamples: <ThrowOnError extends boolean = false>(options?: Options<ListDemoSamplesData, ThrowOnError>) => RequestResult<ListDemoSamplesResponses, ListDemoSamplesErrors, ThrowOnError>;
|
|
130
|
+
/**
|
|
131
|
+
* Запустить демо на лендинге
|
|
132
|
+
*
|
|
133
|
+
* Без авторизации; вызывается с лендинга (нужен собственный Origin). JSON {sample, prompt} запускает образец: на его собственный запрос ответ приходит сразу из заранее посчитанного результата, на пресет галереи — из кеша или настоящим прогоном, на любой другой запрос — настоящим прогоном. Multipart (file, prompt, consent_pd, consent_version) запускает ваш PDF или изображение не больше 3 страниц; файл удаляется сразу после прогона, а результат хранится 1 ч. Прогоны, на которые нет ответа в кеше, ограничены 3 на адрес в сутки (по Москве) и общим дневным лимитом сервиса (429, Retry-After до полуночи); запросы — 30 в минуту с одного адреса. Idempotency-Key игнорируется. 200 с завершённым прогоном, иначе 202: опрашивайте GET /v1/demo/runs/{id}?token=.
|
|
134
|
+
*
|
|
135
|
+
* Доступ: публичный, без учётных данных.
|
|
136
|
+
*/
|
|
137
|
+
export declare const createDemoRun: <ThrowOnError extends boolean = false>(options?: Options<CreateDemoRunData, ThrowOnError>) => RequestResult<CreateDemoRunResponses, CreateDemoRunErrors, ThrowOnError>;
|
|
138
|
+
/**
|
|
139
|
+
* Получить демо-прогон
|
|
140
|
+
*
|
|
141
|
+
* Без авторизации: нужен token прогона. Только демо-прогоны; что угодно другое или неверный token — 404. wait (0–60) держит запрос до завершения прогона.
|
|
142
|
+
*
|
|
143
|
+
* Доступ: публичный, без учётных данных.
|
|
144
|
+
*/
|
|
145
|
+
export declare const getDemoRun: <ThrowOnError extends boolean = false>(options: Options<GetDemoRunData, ThrowOnError>) => RequestResult<GetDemoRunResponses, GetDemoRunErrors, ThrowOnError>;
|
|
146
|
+
/**
|
|
147
|
+
* Текущие и предстоящие работы и сбои
|
|
148
|
+
*
|
|
149
|
+
* Без авторизации. События в статусе in_progress и ещё не закончившиеся scheduled, по времени начала, ранние первыми. Список может отставать до 30 с (Cache-Control: public, max-age=30). Не больше 600 запросов в минуту с одного адреса. Во время работ, затрагивающих API, обработку или MCP, и за 24 ч до них каждый ответ /v1 и /mcp также несёт заголовок Typizer-Maintenance: <id>; starts=<iso>; ends=<iso>.
|
|
150
|
+
*
|
|
151
|
+
* Доступ: публичный, без учётных данных.
|
|
152
|
+
*/
|
|
153
|
+
export declare const getStatus: <ThrowOnError extends boolean = false>(options?: Options<GetStatusData, ThrowOnError>) => RequestResult<GetStatusResponses, GetStatusErrors, ThrowOnError>;
|
|
154
|
+
/**
|
|
155
|
+
* Документ OpenAPI 3.1 этого API
|
|
156
|
+
*
|
|
157
|
+
* Доступ: публичный, без учётных данных.
|
|
158
|
+
*/
|
|
159
|
+
export declare const getOpenApiDocument: <ThrowOnError extends boolean = false>(options?: Options<GetOpenApiDocumentData, ThrowOnError>) => RequestResult<GetOpenApiDocumentResponses, GetOpenApiDocumentErrors, ThrowOnError>;
|
|
160
|
+
/**
|
|
161
|
+
* Удалить аккаунт и отозвать согласие на обработку персональных данных
|
|
162
|
+
*
|
|
163
|
+
* Только сессия, вход не раньше чем 10 минут назад (иначе 403 forbidden «recent sign-in required»: войдите заново).
|
|
164
|
+
*
|
|
165
|
+
* Так отзывается согласие на обработку персональных данных (pd-consent, п. 7.3): аккаунт
|
|
166
|
+
* обезличивается — удаляются почта, имя и фото, завершаются все сессии, способы входа, ключи API
|
|
167
|
+
* и членства, — а личная организация удаляется (файлы и результаты удаляют задачи хранения).
|
|
168
|
+
* Отзыв записывается в журнал согласий; платёжные записи хранятся, как требует налоговое
|
|
169
|
+
* законодательство.
|
|
170
|
+
*
|
|
171
|
+
* Если пользователь — единственный владелец другой организации, ничего не меняется и ответ —
|
|
172
|
+
* 409 conflict: сначала передайте владение или удалите ту организацию.
|
|
173
|
+
*
|
|
174
|
+
* Доступ: только сессия.
|
|
175
|
+
*/
|
|
176
|
+
export declare const deleteMe: <ThrowOnError extends boolean = false>(options?: Options<DeleteMeData, ThrowOnError>) => RequestResult<DeleteMeResponses, DeleteMeErrors, ThrowOnError>;
|
|
177
|
+
/**
|
|
178
|
+
* Кто вызывает: пользователь или ключ API, организация, флаги функций
|
|
179
|
+
*
|
|
180
|
+
* Доступ: ключ API или сессия.
|
|
181
|
+
*/
|
|
182
|
+
export declare const getMe: <ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>) => RequestResult<GetMeResponses, GetMeErrors, ThrowOnError>;
|
|
183
|
+
/**
|
|
184
|
+
* Журнал входов текущего пользователя
|
|
185
|
+
*
|
|
186
|
+
* Доступ: только сессия.
|
|
187
|
+
*/
|
|
188
|
+
export declare const listSignIns: <ThrowOnError extends boolean = false>(options?: Options<ListSignInsData, ThrowOnError>) => RequestResult<ListSignInsResponses, ListSignInsErrors, ThrowOnError>;
|
|
189
|
+
/**
|
|
190
|
+
* Узнать, подписан ли пользователь на маркетинговые рассылки
|
|
191
|
+
*
|
|
192
|
+
* Только сессия: состояние согласия на маркетинговые рассылки по последнему решению текущего пользователя в журнале согласий (дать или отозвать его — POST /v1/consents). Без решений — granted равно false, version и updated_at равны null.
|
|
193
|
+
*
|
|
194
|
+
* Доступ: только сессия.
|
|
195
|
+
*/
|
|
196
|
+
export declare const getMyConsents: <ThrowOnError extends boolean = false>(options?: Options<GetMyConsentsData, ThrowOnError>) => RequestResult<GetMyConsentsResponses, GetMyConsentsErrors, ThrowOnError>;
|
|
197
|
+
/**
|
|
198
|
+
* Активные ключи API организации
|
|
199
|
+
*
|
|
200
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
201
|
+
*/
|
|
202
|
+
export declare const listApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListApiKeysData, ThrowOnError>) => RequestResult<ListApiKeysResponses, ListApiKeysErrors, ThrowOnError>;
|
|
203
|
+
/**
|
|
204
|
+
* Создать ключ API (ключ показывается один раз)
|
|
205
|
+
*
|
|
206
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
207
|
+
*/
|
|
208
|
+
export declare const createApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>) => RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
|
|
209
|
+
/**
|
|
210
|
+
* Отозвать ключ API навсегда
|
|
211
|
+
*
|
|
212
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
213
|
+
*/
|
|
214
|
+
export declare const deleteApiKey: <ThrowOnError extends boolean = false>(options: Options<DeleteApiKeyData, ThrowOnError>) => RequestResult<DeleteApiKeyResponses, DeleteApiKeyErrors, ThrowOnError>;
|
|
215
|
+
/**
|
|
216
|
+
* Удалить организацию
|
|
217
|
+
*
|
|
218
|
+
* Только сессия владельца, вход не раньше чем 10 минут назад (иначе 403 forbidden «recent sign-in required»).
|
|
219
|
+
*
|
|
220
|
+
* Организация блокируется и обезличивается: её ключи API отзываются, конечные точки вебхуков
|
|
221
|
+
* отключаются, приглашения и чаты ассистента удаляются, типизаторы архивируются, а файлы и
|
|
222
|
+
* результаты прогонов в течение часа удаляют задачи хранения. Платёжные записи хранятся, как
|
|
223
|
+
* требует налоговое законодательство. Личная организация отдельно не удаляется (409 conflict):
|
|
224
|
+
* она удаляется вместе с аккаунтом (DELETE /v1/me).
|
|
225
|
+
*
|
|
226
|
+
* Доступ: только сессия с ролью owner.
|
|
227
|
+
*/
|
|
228
|
+
export declare const deleteOrganization: <ThrowOnError extends boolean = false>(options?: Options<DeleteOrganizationData, ThrowOnError>) => RequestResult<DeleteOrganizationResponses, DeleteOrganizationErrors, ThrowOnError>;
|
|
229
|
+
/**
|
|
230
|
+
* Текущая организация и её сроки хранения
|
|
231
|
+
*
|
|
232
|
+
* Доступ: ключ API или сессия.
|
|
233
|
+
*/
|
|
234
|
+
export declare const getOrganization: <ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>) => RequestResult<GetOrganizationResponses, GetOrganizationErrors, ThrowOnError>;
|
|
235
|
+
/**
|
|
236
|
+
* Изменить сроки хранения
|
|
237
|
+
*
|
|
238
|
+
* Доступ: только сессия с ролью owner или admin.
|
|
239
|
+
*/
|
|
240
|
+
export declare const updateOrganization: <ThrowOnError extends boolean = false>(options: Options<UpdateOrganizationData, ThrowOnError>) => RequestResult<UpdateOrganizationResponses, UpdateOrganizationErrors, ThrowOnError>;
|
|
241
|
+
/**
|
|
242
|
+
* Загрузить документ (multipart, поле file)
|
|
243
|
+
*
|
|
244
|
+
* Единственный способ загрузить файл, до 50 МиБ: тело всегда идёт через API. Не больше 2 загрузок одновременно на организацию (сверх этого 429 rate_limited); если сервис занят — 503. Оба ответа приходят с Retry-After: 1. Всё тело должно прийти за 120 с без пауз дольше 15 с (иначе 408). Не больше 20 загрузок в секунду на ключ API или пользователя (429). Поддерживает Idempotency-Key.
|
|
245
|
+
*
|
|
246
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
247
|
+
*/
|
|
248
|
+
export declare const createFile: <ThrowOnError extends boolean = false>(options: Options<CreateFileData, ThrowOnError>) => RequestResult<CreateFileResponses, CreateFileErrors, ThrowOnError>;
|
|
249
|
+
/**
|
|
250
|
+
* Удалить файл сейчас
|
|
251
|
+
*
|
|
252
|
+
* Файл сразу пропадает для всех; его хранилище стирается сейчас или, если не вышло, при следующей очистке по сроку хранения. Повторный DELETE того же файла отвечает 404: клиент, повторяющий запрос после потерянного ответа, считает 404 удалением. 503 с Retry-After: 1, если файл на мгновение занят.
|
|
253
|
+
*
|
|
254
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
255
|
+
*/
|
|
256
|
+
export declare const deleteFile: <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) => RequestResult<DeleteFileResponses, DeleteFileErrors, ThrowOnError>;
|
|
257
|
+
/**
|
|
258
|
+
* Получить файл
|
|
259
|
+
*
|
|
260
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
261
|
+
*/
|
|
262
|
+
export declare const getFile: <ThrowOnError extends boolean = false>(options: Options<GetFileData, ThrowOnError>) => RequestResult<GetFileResponses, GetFileErrors, ThrowOnError>;
|
|
263
|
+
/**
|
|
264
|
+
* Скачать исходное содержимое файла
|
|
265
|
+
*
|
|
266
|
+
* Всегда скачивание (Content-Disposition: attachment), без отображения: содержимое — ровно то, что было загружено. Передача, сорвавшаяся на середине, обрывается, а не завершается раньше; сверяйте длину с Content-Length. HEAD отвечает теми же заголовками, не читая файл. Не больше 2 скачиваний одновременно на организацию (и на пользователя): сверх этого 429 с Retry-After.
|
|
267
|
+
*
|
|
268
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
269
|
+
*/
|
|
270
|
+
export declare const getFileContent: <ThrowOnError extends boolean = false>(options: Options<GetFileContentData, ThrowOnError>) => RequestResult<GetFileContentResponses, GetFileContentErrors, ThrowOnError>;
|
|
271
|
+
/**
|
|
272
|
+
* Список типизаторов, новые первыми
|
|
273
|
+
*
|
|
274
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
275
|
+
*/
|
|
276
|
+
export declare const listTypizers: <ThrowOnError extends boolean = false>(options?: Options<ListTypizersData, ThrowOnError>) => RequestResult<ListTypizersResponses, ListTypizersErrors, ThrowOnError>;
|
|
277
|
+
/**
|
|
278
|
+
* Создать типизатор (версия 1)
|
|
279
|
+
*
|
|
280
|
+
* Поддерживает Idempotency-Key.
|
|
281
|
+
*
|
|
282
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
283
|
+
*/
|
|
284
|
+
export declare const createTypizer: <ThrowOnError extends boolean = false>(options: Options<CreateTypizerData, ThrowOnError>) => RequestResult<CreateTypizerResponses, CreateTypizerErrors, ThrowOnError>;
|
|
285
|
+
/**
|
|
286
|
+
* Составить черновик типизатора по описанию или документу-образцу
|
|
287
|
+
*
|
|
288
|
+
* Запрашивает у модели схему, название и инструкции; ничего не сохраняется (типизатор создаётся через POST /v1/typizers). Передайте description, file_id или оба. Каждый вызов расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве) непосредственно перед обращением к модели; сверх квоты — 429 с Retry-After до полуночи по Москве. Конвертация образца: документ, который не удаётся сконвертировать, — 422 extraction_failed с param: "file_id" (не повторяйте; запоминается на 24 ч); занятый конвертер — 429 с Retry-After: 5; сверх 200 конвертаций на пользователя за сутки по Москве — 429 с Retry-After до полуночи по Москве; при исчерпанной квоте ассистента — 429 до любой конвертации; недоступный или слишком медленный конвертер или модель — 503 upstream_unavailable (повторите позже). Ответ модели, не являющийся корректной схемой, — 422 extraction_failed. Idempotency-Key принимается и игнорируется.
|
|
289
|
+
*
|
|
290
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
291
|
+
*/
|
|
292
|
+
export declare const generateTypizer: <ThrowOnError extends boolean = false>(options: Options<GenerateTypizerData, ThrowOnError>) => RequestResult<GenerateTypizerResponses, GenerateTypizerErrors, ThrowOnError>;
|
|
293
|
+
/**
|
|
294
|
+
* Архивировать типизатор
|
|
295
|
+
*
|
|
296
|
+
* Типизатор пропадает из списка и с этого момента отвечает 404; его версии сохраняются для прогонов, которые их использовали.
|
|
297
|
+
*
|
|
298
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
299
|
+
*/
|
|
300
|
+
export declare const deleteTypizer: <ThrowOnError extends boolean = false>(options: Options<DeleteTypizerData, ThrowOnError>) => RequestResult<DeleteTypizerResponses, DeleteTypizerErrors, ThrowOnError>;
|
|
301
|
+
/**
|
|
302
|
+
* Получить типизатор с текущей версией
|
|
303
|
+
*
|
|
304
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
305
|
+
*/
|
|
306
|
+
export declare const getTypizer: <ThrowOnError extends boolean = false>(options: Options<GetTypizerData, ThrowOnError>) => RequestResult<GetTypizerResponses, GetTypizerErrors, ThrowOnError>;
|
|
307
|
+
/**
|
|
308
|
+
* Изменить типизатор
|
|
309
|
+
*
|
|
310
|
+
* Версии неизменяемы: изменённые schema или instructions создают новую версию, и она становится текущей. Перестановка поля внутри properties — это изменение (порядок полей — порядок результата); перестановка ключевого слова внутри поля — нет. Остальные поля меняются на месте.
|
|
311
|
+
*
|
|
312
|
+
* Доступ: ключ API со скоупом typizers:write или сессия.
|
|
313
|
+
*/
|
|
314
|
+
export declare const updateTypizer: <ThrowOnError extends boolean = false>(options: Options<UpdateTypizerData, ThrowOnError>) => RequestResult<UpdateTypizerResponses, UpdateTypizerErrors, ThrowOnError>;
|
|
315
|
+
/**
|
|
316
|
+
* Версии типизатора, новые первыми
|
|
317
|
+
*
|
|
318
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
319
|
+
*/
|
|
320
|
+
export declare const listTypizerVersions: <ThrowOnError extends boolean = false>(options: Options<ListTypizerVersionsData, ThrowOnError>) => RequestResult<ListTypizerVersionsResponses, ListTypizerVersionsErrors, ThrowOnError>;
|
|
321
|
+
/**
|
|
322
|
+
* Получить версию типизатора
|
|
323
|
+
*
|
|
324
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
325
|
+
*/
|
|
326
|
+
export declare const getTypizerVersion: <ThrowOnError extends boolean = false>(options: Options<GetTypizerVersionData, ThrowOnError>) => RequestResult<GetTypizerVersionResponses, GetTypizerVersionErrors, ThrowOnError>;
|
|
327
|
+
/**
|
|
328
|
+
* Скачать XSD текущей версии
|
|
329
|
+
*
|
|
330
|
+
* Описывает XML, который выгружает прогон этого типизатора (корень <document>); отдаётся как файл.
|
|
331
|
+
*
|
|
332
|
+
* Доступ: ключ API со скоупом typizers:read или сессия.
|
|
333
|
+
*/
|
|
334
|
+
export declare const getTypizerXsd: <ThrowOnError extends boolean = false>(options: Options<GetTypizerXsdData, ThrowOnError>) => RequestResult<GetTypizerXsdResponses, GetTypizerXsdErrors, ThrowOnError>;
|
|
335
|
+
/**
|
|
336
|
+
* Запустить типизатор на документе
|
|
337
|
+
*
|
|
338
|
+
* Передайте документ ровно одним способом: частью multipart file, полем file_id или url. Тело — JSON или multipart с остальными полями в виде текста (metadata — объект JSON). Страницы резервируются на балансе при создании прогона (402 insufficient_balance, если их не хватает) и списываются при его завершении. Загрузки: не больше 2 одновременно на организацию (429), всё тело за 120 с без пауз дольше 15 с (408). Не больше 20 новых прогонов в секунду на ключ API или пользователя (429; много документов — через пакеты). Поддерживает Idempotency-Key.
|
|
339
|
+
*
|
|
340
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
341
|
+
*/
|
|
342
|
+
export declare const createRun: <ThrowOnError extends boolean = false>(options: Options<CreateRunData, ThrowOnError>) => RequestResult<CreateRunResponses, CreateRunErrors, ThrowOnError>;
|
|
343
|
+
/**
|
|
344
|
+
* Список прогонов, новые первыми
|
|
345
|
+
*
|
|
346
|
+
* Пагинация по курсору, новые первыми. В списке output и fields всегда null (output_expired всё равно показывает, хранится ли результат); за ними запросите прогон или его /output.
|
|
347
|
+
*
|
|
348
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
349
|
+
*/
|
|
350
|
+
export declare const listRuns: <ThrowOnError extends boolean = false>(options?: Options<ListRunsData, ThrowOnError>) => RequestResult<ListRunsResponses, ListRunsErrors, ThrowOnError>;
|
|
351
|
+
/**
|
|
352
|
+
* Получить прогон
|
|
353
|
+
*
|
|
354
|
+
* С output и fields, пока результат хранится (срок хранения результатов организации), затем там null и output_expired: true.
|
|
355
|
+
*
|
|
356
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
357
|
+
*/
|
|
358
|
+
export declare const getRun: <ThrowOnError extends boolean = false>(options: Options<GetRunData, ThrowOnError>) => RequestResult<GetRunResponses, GetRunErrors, ThrowOnError>;
|
|
359
|
+
/**
|
|
360
|
+
* Скачать результат прогона
|
|
361
|
+
*
|
|
362
|
+
* Результат успешного прогона в виде файла (Content-Disposition: attachment; filename="<run id>.<ext>"). Столбцы и элементы идут в порядке свойств схемы. csv — один файл или zip из data.csv и отдельного файла на каждое поле-массив. В csv и xlsx текстовое значение, которое таблица могла бы выполнить как формулу (начинается с =, +, -, @, табуляции или перевода строки), записывается с ведущим '. 409, если прогон не завершился успешно; 404 «output expired», когда результат больше не хранится. Файл передаётся потоком по мере формирования (без Content-Length); сбой на середине обрывает передачу, а не завершает её раньше. xlsx отклоняется (413 file_too_large), если в таблице больше строк, чем вмещает лист (1 048 575). Не больше 2 выгрузок одновременно на организацию (429), 503, пока сервер занят; оба ответа с Retry-After.
|
|
363
|
+
*
|
|
364
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
365
|
+
*/
|
|
366
|
+
export declare const getRunOutput: <ThrowOnError extends boolean = false>(options: Options<GetRunOutputData, ThrowOnError>) => RequestResult<GetRunOutputResponses, GetRunOutputErrors, ThrowOnError>;
|
|
367
|
+
/**
|
|
368
|
+
* Повторить неудачный прогон
|
|
369
|
+
*
|
|
370
|
+
* Создаёт новый прогон с версией типизатора неудачного прогона (даже если типизатор с тех пор изменён или удалён) или его разовой схемой и инструкциями, файлом, format, mode и metadata, а также его webhook_url, пока у активной конечной точки вебхуков есть этот URL (но не у отключённой вами). Страницы резервируются как для любого прогона (402 insufficient_balance). 409, если прогон не завершился неудачей, если его файл больше не хранится («source file expired») или если прогон сделан ассистентом (запустите его снова из ассистента). Входит в лимит новых прогонов (20 в секунду на ключ API или пользователя, 429). Поддерживает Idempotency-Key; передавайте его: каждый вызов без ключа создаёт ещё один прогон и резервирует под него страницы.
|
|
371
|
+
*
|
|
372
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
373
|
+
*/
|
|
374
|
+
export declare const retryRun: <ThrowOnError extends boolean = false>(options: Options<RetryRunData, ThrowOnError>) => RequestResult<RetryRunResponses, RetryRunErrors, ThrowOnError>;
|
|
375
|
+
/**
|
|
376
|
+
* Список пакетов, новые первыми
|
|
377
|
+
*
|
|
378
|
+
* Пагинация по курсору, новые первыми. Прогоны пакета: GET /v1/runs?batch_id=.
|
|
379
|
+
*
|
|
380
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
381
|
+
*/
|
|
382
|
+
export declare const listBatches: <ThrowOnError extends boolean = false>(options?: Options<ListBatchesData, ThrowOnError>) => RequestResult<ListBatchesResponses, ListBatchesErrors, ThrowOnError>;
|
|
383
|
+
/**
|
|
384
|
+
* Запустить типизатор на многих документах
|
|
385
|
+
*
|
|
386
|
+
* Один прогон на файл, у всех одна версия типизатора, format, mode и metadata: JSON с file_ids или multipart с частями files (одна из них может быть .zip). Сначала страницы всех прогонов сверяются с балансом (402 insufficient_balance, ничего не создаётся), затем резервируются по прогону. Всё или ничего: если прогон создать не удаётся (например, 402, потому что страницы тем временем израсходованы), запрос завершается этой ошибкой, ничего из пакета не запускается, а страницы возвращаются; уже созданные прогоны остаются в списке как неудачные в пакете completed. Пакет завершается, когда закончены все прогоны (вебхук batch.completed). Не больше 500 документов (.zip считается по числу файлов). Загрузки: не больше 2 одновременно на организацию (429), тело с .zip занимает обе; всё тело за 100 с без пауз дольше 15 с (408). На весь запрос — 100 с: пакет, который не удалось сохранить за это время, отклоняется с 503 «batch too large to process in one request; split it», и ничего из него не сохраняется. Поддерживает Idempotency-Key; повтор пакета, который из-за обрыва получил меньше прогонов, чем было прислано, — 409 conflict «batch was only partially created; create a new batch for the remaining documents» с batch_id, created и expected. Не больше 2 пакетов в секунду и 60 в минуту на ключ API или пользователя (429).
|
|
387
|
+
*
|
|
388
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
389
|
+
*/
|
|
390
|
+
export declare const createBatch: <ThrowOnError extends boolean = false>(options?: Options<CreateBatchData, ThrowOnError>) => RequestResult<CreateBatchResponses, CreateBatchErrors, ThrowOnError>;
|
|
391
|
+
/**
|
|
392
|
+
* Получить пакет
|
|
393
|
+
*
|
|
394
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
395
|
+
*/
|
|
396
|
+
export declare const getBatch: <ThrowOnError extends boolean = false>(options: Options<GetBatchData, ThrowOnError>) => RequestResult<GetBatchResponses, GetBatchErrors, ThrowOnError>;
|
|
397
|
+
/**
|
|
398
|
+
* Скачать результаты пакета
|
|
399
|
+
*
|
|
400
|
+
* Результаты успешных прогонов пакета, которые ещё хранятся, в порядке создания прогонов (Content-Disposition: attachment; filename="<batch id>.<ext>"). csv — одна таблица со столбцом run_id или zip из data.csv и отдельного файла на каждое поле-массив; xlsx — то же в виде листов; zip — по одному <run id>.json на прогон. В csv и xlsx текстовое значение, которое таблица могла бы выполнить как формулу, записывается с ведущим '. 409, пока пакет обрабатывается. Передаётся потоком по мере формирования (без Content-Length); сбой на середине обрывает передачу, а не завершает её раньше. xlsx отклоняется (413), если в таблице больше строк, чем вмещает лист. Не больше 2 выгрузок одновременно на организацию (429), 503, пока сервер занят; оба ответа с Retry-After.
|
|
401
|
+
*
|
|
402
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
403
|
+
*/
|
|
404
|
+
export declare const exportBatch: <ThrowOnError extends boolean = false>(options: Options<ExportBatchData, ThrowOnError>) => RequestResult<ExportBatchResponses, ExportBatchErrors, ThrowOnError>;
|
|
405
|
+
/**
|
|
406
|
+
* Извлечь данные по разовой схеме
|
|
407
|
+
*
|
|
408
|
+
* Прогон с разовой схемой, без сохранения типизатора (typizer_id равен null). Схема подчиняется правилам типизатора (см. POST /v1/typizers). Передайте документ ровно одним способом: частью multipart file, полем file_id или url. Тело — JSON или multipart с остальными полями в виде текста (metadata — объект JSON). Страницы резервируются на балансе при создании прогона (402 insufficient_balance, если их не хватает) и списываются при его завершении. Загрузки: не больше 2 одновременно на организацию (429), всё тело за 120 с без пауз дольше 15 с (408). Не больше 20 новых прогонов в секунду на ключ API или пользователя (429; много документов — через пакеты). Поддерживает Idempotency-Key.
|
|
409
|
+
*
|
|
410
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
411
|
+
*/
|
|
412
|
+
export declare const extract: <ThrowOnError extends boolean = false>(options?: Options<ExtractData, ThrowOnError>) => RequestResult<ExtractResponses, ExtractErrors, ThrowOnError>;
|
|
413
|
+
/**
|
|
414
|
+
* Список конечных точек вебхуков, новые первыми
|
|
415
|
+
*
|
|
416
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
417
|
+
*/
|
|
418
|
+
export declare const listWebhookEndpoints: <ThrowOnError extends boolean = false>(options?: Options<ListWebhookEndpointsData, ThrowOnError>) => RequestResult<ListWebhookEndpointsResponses, ListWebhookEndpointsErrors, ThrowOnError>;
|
|
419
|
+
/**
|
|
420
|
+
* Создать конечную точку вебхуков
|
|
421
|
+
*
|
|
422
|
+
* Одна конечная точка на URL: URL, который у организации уже есть (в том числе созданный для webhook_url прогона или отключённый), — 409; вместо этого измените ту конечную точку. Не больше 50 активных конечных точек на организацию, включая созданные для прогонов (409). Доставки подписываются по Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature) секретом конечной точки (secret). Поддерживает Idempotency-Key (в ответе-повторе secret: null).
|
|
423
|
+
*
|
|
424
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
425
|
+
*/
|
|
426
|
+
export declare const createWebhookEndpoint: <ThrowOnError extends boolean = false>(options: Options<CreateWebhookEndpointData, ThrowOnError>) => RequestResult<CreateWebhookEndpointResponses, CreateWebhookEndpointErrors, ThrowOnError>;
|
|
427
|
+
/**
|
|
428
|
+
* Удалить конечную точку вебхуков и журнал её доставок
|
|
429
|
+
*
|
|
430
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
431
|
+
*/
|
|
432
|
+
export declare const deleteWebhookEndpoint: <ThrowOnError extends boolean = false>(options: Options<DeleteWebhookEndpointData, ThrowOnError>) => RequestResult<DeleteWebhookEndpointResponses, DeleteWebhookEndpointErrors, ThrowOnError>;
|
|
433
|
+
/**
|
|
434
|
+
* Получить конечную точку вебхуков
|
|
435
|
+
*
|
|
436
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
437
|
+
*/
|
|
438
|
+
export declare const getWebhookEndpoint: <ThrowOnError extends boolean = false>(options: Options<GetWebhookEndpointData, ThrowOnError>) => RequestResult<GetWebhookEndpointResponses, GetWebhookEndpointErrors, ThrowOnError>;
|
|
439
|
+
/**
|
|
440
|
+
* Изменить конечную точку вебхуков
|
|
441
|
+
*
|
|
442
|
+
* url, который уже есть у другой конечной точки организации, — 409; повторное включение конечной точки сверх лимита активных — 409.
|
|
443
|
+
*
|
|
444
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
445
|
+
*/
|
|
446
|
+
export declare const updateWebhookEndpoint: <ThrowOnError extends boolean = false>(options: Options<UpdateWebhookEndpointData, ThrowOnError>) => RequestResult<UpdateWebhookEndpointResponses, UpdateWebhookEndpointErrors, ThrowOnError>;
|
|
447
|
+
/**
|
|
448
|
+
* Отправить тестовое событие на конечную точку
|
|
449
|
+
*
|
|
450
|
+
* Событие run.succeeded с примером прогона (run_test, output: {"example": true}) только на эту конечную точку; повторяется, как любая доставка. Отключённая конечная точка — 409. Тесты и повторы: 20 в минуту на организацию (429). Поддерживает Idempotency-Key.
|
|
451
|
+
*
|
|
452
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
453
|
+
*/
|
|
454
|
+
export declare const testWebhookEndpoint: <ThrowOnError extends boolean = false>(options: Options<TestWebhookEndpointData, ThrowOnError>) => RequestResult<TestWebhookEndpointResponses, TestWebhookEndpointErrors, ThrowOnError>;
|
|
455
|
+
/**
|
|
456
|
+
* Доставки конечной точки, новые первыми
|
|
457
|
+
*
|
|
458
|
+
* Статус, коды ответов, попытки и время; тело события не показывается.
|
|
459
|
+
*
|
|
460
|
+
* Доступ: ключ API со скоупом runs:read или сессия.
|
|
461
|
+
*/
|
|
462
|
+
export declare const listWebhookDeliveries: <ThrowOnError extends boolean = false>(options: Options<ListWebhookDeliveriesData, ThrowOnError>) => RequestResult<ListWebhookDeliveriesResponses, ListWebhookDeliveriesErrors, ThrowOnError>;
|
|
463
|
+
/**
|
|
464
|
+
* Повторить неудачную доставку один раз
|
|
465
|
+
*
|
|
466
|
+
* Только доставка в статусе failed у активной конечной точки (иначе 409). Ещё одна попытка, сейчас; если она не удалась, доставка снова failed (без новых автоматических повторов). Тесты и повторы: 20 в минуту на организацию (429). Поддерживает Idempotency-Key.
|
|
467
|
+
*
|
|
468
|
+
* Доступ: ключ API со скоупом runs:write или сессия.
|
|
469
|
+
*/
|
|
470
|
+
export declare const retryWebhookDelivery: <ThrowOnError extends boolean = false>(options: Options<RetryWebhookDeliveryData, ThrowOnError>) => RequestResult<RetryWebhookDeliveryResponses, RetryWebhookDeliveryErrors, ThrowOnError>;
|
|
471
|
+
/**
|
|
472
|
+
* Баланс страниц организации
|
|
473
|
+
*
|
|
474
|
+
* Доступ: ключ API со скоупом billing:read или сессия.
|
|
475
|
+
*/
|
|
476
|
+
export declare const getBalance: <ThrowOnError extends boolean = false>(options?: Options<GetBalanceData, ThrowOnError>) => RequestResult<GetBalanceResponses, GetBalanceErrors, ThrowOnError>;
|
|
477
|
+
/**
|
|
478
|
+
* Прогоны и оплаченные страницы за период
|
|
479
|
+
*
|
|
480
|
+
* Прогоны, созданные в период [from, to] (целые дни по Москве), по дням, типизаторам или ключам API. Не больше 366 дней (иначе 400, param: to). Дни без прогонов не выводятся. Демо-прогоны не учитываются.
|
|
481
|
+
*
|
|
482
|
+
* Доступ: ключ API со скоупом billing:read или сессия.
|
|
483
|
+
*/
|
|
484
|
+
export declare const getUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) => RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError>;
|
|
485
|
+
/**
|
|
486
|
+
* Ваши диалоги с ассистентом, новые первыми
|
|
487
|
+
*
|
|
488
|
+
* Только сессия (любая роль); диалог виден пользователю, который его начал.
|
|
489
|
+
*
|
|
490
|
+
* Доступ: только сессия.
|
|
491
|
+
*/
|
|
492
|
+
export declare const listAgentThreads: <ThrowOnError extends boolean = false>(options?: Options<ListAgentThreadsData, ThrowOnError>) => RequestResult<ListAgentThreadsResponses, ListAgentThreadsErrors, ThrowOnError>;
|
|
493
|
+
/**
|
|
494
|
+
* Начать диалог с ассистентом
|
|
495
|
+
*
|
|
496
|
+
* Только сессия (любая роль); диалог виден пользователю, который его начал. Поддерживает Idempotency-Key.
|
|
497
|
+
*
|
|
498
|
+
* Доступ: только сессия.
|
|
499
|
+
*/
|
|
500
|
+
export declare const createAgentThread: <ThrowOnError extends boolean = false>(options?: Options<CreateAgentThreadData, ThrowOnError>) => RequestResult<CreateAgentThreadResponses, CreateAgentThreadErrors, ThrowOnError>;
|
|
501
|
+
/**
|
|
502
|
+
* Получить диалог с сообщениями
|
|
503
|
+
*
|
|
504
|
+
* Только сессия (любая роль); диалог виден пользователю, который его начал.
|
|
505
|
+
*
|
|
506
|
+
* Доступ: только сессия.
|
|
507
|
+
*/
|
|
508
|
+
export declare const getAgentThread: <ThrowOnError extends boolean = false>(options: Options<GetAgentThreadData, ThrowOnError>) => RequestResult<GetAgentThreadResponses, GetAgentThreadErrors, ThrowOnError>;
|
|
509
|
+
/**
|
|
510
|
+
* Изменить черновик схемы вручную или сменить образец
|
|
511
|
+
*
|
|
512
|
+
* Только сессия (любая роль); диалог виден пользователю, который его начал. draft_schema проверяется как схема типизатора (param — это draft_schema# и указатель).
|
|
513
|
+
*
|
|
514
|
+
* Доступ: только сессия.
|
|
515
|
+
*/
|
|
516
|
+
export declare const updateAgentThread: <ThrowOnError extends boolean = false>(options: Options<UpdateAgentThreadData, ThrowOnError>) => RequestResult<UpdateAgentThreadResponses, UpdateAgentThreadErrors, ThrowOnError>;
|
|
517
|
+
/**
|
|
518
|
+
* Запустить черновик на образце (бесплатно)
|
|
519
|
+
*
|
|
520
|
+
* Только сессия (любая роль); диалог виден пользователю, который его начал. Запускает черновик схемы на образце диалога (source agent); страницы не резервируются и не списываются. Расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве; сверх квоты 429 с Retry-After). 409 conflict без черновика или образца; 400 too_many_pages для образца больше 10 страниц. Отвечает так же, как создание прогона. Поддерживает Idempotency-Key.
|
|
521
|
+
*
|
|
522
|
+
* Доступ: только сессия.
|
|
523
|
+
*/
|
|
524
|
+
export declare const createAgentSampleRun: <ThrowOnError extends boolean = false>(options: Options<CreateAgentSampleRunData, ThrowOnError>) => RequestResult<CreateAgentSampleRunResponses, CreateAgentSampleRunErrors, ThrowOnError>;
|
|
525
|
+
/**
|
|
526
|
+
* Сохранить черновик как типизатор
|
|
527
|
+
*
|
|
528
|
+
* Только сессия (любая роль); диалог виден пользователю, который его начал. Диалог, связанный с типизатором, сохраняет его новую версию (200); иначе — если диалог ни разу не сохранялся или его типизатор с тех пор архивирован — создаётся новый типизатор (201), и диалог связывается с ним. 409 conflict без черновика. Поддерживает Idempotency-Key.
|
|
529
|
+
*
|
|
530
|
+
* Доступ: только сессия.
|
|
531
|
+
*/
|
|
532
|
+
export declare const saveAgentThread: <ThrowOnError extends boolean = false>(options: Options<SaveAgentThreadData, ThrowOnError>) => RequestResult<SaveAgentThreadResponses, SaveAgentThreadErrors, ThrowOnError>;
|
|
533
|
+
/**
|
|
534
|
+
* Отправить сообщение; ассистент отвечает потоком server-sent events
|
|
535
|
+
*
|
|
536
|
+
* Только сессия (любая роль); диалог виден пользователю, который его начал. Расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве; сверх квоты 429 с Retry-After до открытия потока). Стоимость модели ассистента также ограничена на пользователя и на организацию за сутки по Москве: когда лимит исчерпан, 429 до открытия потока или событие error с 429, завершающее текущий ход. Одно сообщение за раз в диалоге: 409 conflict, пока ассистент отвечает на предыдущее. Ответ — text/event-stream с событиями message_start, text_delta, tool_call, tool_result, schema_updated, sample_run, ask_user, error (ошибка в формате problem) и последним message_end (stop_reason: end_turn, ask_user, max_steps или aborted); комментарий : ping каждые 15 с. Ход длится не больше 300 с. Idempotency-Key принимается и игнорируется.
|
|
537
|
+
*
|
|
538
|
+
* Доступ: только сессия.
|
|
539
|
+
*/
|
|
540
|
+
export declare const createAgentMessage: <ThrowOnError extends boolean = false>(options: Options<CreateAgentMessageData, ThrowOnError, CreateAgentMessageResponse>) => Promise<ServerSentEventsResult<CreateAgentMessageResponses>>;
|