@torrow/sdk-docs 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/README.md +35 -0
- package/dist/index.d.ts +4428 -0
- package/dist/index.js +4937 -0
- package/dist/index.js.map +1 -0
- package/package.json +45 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,4428 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Структурированное описание поля DTO для **ИИ и генерации MCP-инструментов**
|
|
3
|
+
* (параметры `inputSchema`, описания аргументов, few-shot).
|
|
4
|
+
*
|
|
5
|
+
* Строковый вид для промптов: {@link fieldDocToString}.
|
|
6
|
+
*/
|
|
7
|
+
type ItemFieldDoc = {
|
|
8
|
+
/** Смысл поля и формат значения. */
|
|
9
|
+
description: string;
|
|
10
|
+
/** Примеры литералов (как в API/JSON), не выдумывать формат id — только иллюстрация. */
|
|
11
|
+
examples?: readonly string[];
|
|
12
|
+
/** Коротко: типичный сценарий использования в клиенте (UI, права, бизнес-поток). */
|
|
13
|
+
usage?: string;
|
|
14
|
+
/** Ссылка на вложенную схему OpenAPI `components.schemas.*`. */
|
|
15
|
+
valueSchema?: string;
|
|
16
|
+
};
|
|
17
|
+
declare function fieldDocToString(doc: ItemFieldDoc): string;
|
|
18
|
+
/** Сводка в одну строку для обратной совместимости и простых промптов. */
|
|
19
|
+
declare function mapFieldDocsToStrings<const T extends Record<string, ItemFieldDoc>>(entries: T): {
|
|
20
|
+
[K in keyof T]: string;
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
declare const torrowItemBaseFieldDocEntries: {
|
|
24
|
+
readonly id: {
|
|
25
|
+
readonly description: "Стабильный идентификатор элемента в Torrow (torrow id), строка. В путях REST: `/api/v1/{domain}/{torrowId}`.";
|
|
26
|
+
readonly examples: readonly ["3fa85f64-5717-4562-b3fc-2c963f66afa6"];
|
|
27
|
+
readonly usage: "При create/update передаётся в URL/теле; клиент хранит id после ответа сервера. Связь с операциями блокировки/удаления по itemId.";
|
|
28
|
+
};
|
|
29
|
+
readonly name: {
|
|
30
|
+
readonly description: "Отображаемое имя элемента в списках, карточке и поиске.";
|
|
31
|
+
readonly examples: readonly ["Моя услуга", "Иван Иванов", "Каталог услуг"];
|
|
32
|
+
readonly usage: "Заголовок в mind-map и списках; часто редактируется вместе с masterInfo. У контактов с заполненным `visitCard` часто совпадает с отображаемым именем в слоте FullName.";
|
|
33
|
+
};
|
|
34
|
+
readonly uniqueName: {
|
|
35
|
+
readonly description: "Уникальное имя в рамках правил продукта (slug для публичной ссылки на хостинге продукта). Может быть пустым.";
|
|
36
|
+
readonly examples: readonly ["demo_booking", "city_services"];
|
|
37
|
+
readonly usage: "Проверка уникальности на сервере; используется в URL публичной карточки. Не путать с id элемента.";
|
|
38
|
+
};
|
|
39
|
+
readonly image: {
|
|
40
|
+
readonly description: "Метаданные основного изображения/аватара элемента.";
|
|
41
|
+
readonly valueSchema: "FileInfo";
|
|
42
|
+
readonly usage: "Превью в карточке; загрузка через отдельные API putUrl/image id.";
|
|
43
|
+
};
|
|
44
|
+
readonly masterInfo: {
|
|
45
|
+
readonly description: "Заголовок, подзаголовок, локализованные строки для карточки и анонса.";
|
|
46
|
+
readonly valueSchema: "MasterInfo";
|
|
47
|
+
readonly usage: "Отображение в шапке элемента; различается по типам элементов.";
|
|
48
|
+
};
|
|
49
|
+
readonly publicityType: {
|
|
50
|
+
readonly description: "Кто может видеть элемент и как выдаётся доступ (персональный, по ссылке, публичный и т.д.).";
|
|
51
|
+
readonly examples: readonly ["Personal", "Link", "PublicAvailable", "PublicWithRequest", "Private", "Undefined"];
|
|
52
|
+
readonly usage: "Пайп `ttPublicityType` и настройки создания: Personal по умолчанию в формах; Link при создании дочернего ресурса от родителя (см. resource-item-business). Для карточек «только по ссылке» часто сочетается с `anyoneAccess: Read` и отключённым поиском (`searchMode: NoneSearchMode`).";
|
|
53
|
+
};
|
|
54
|
+
readonly searchMode: {
|
|
55
|
+
readonly description: "Участие элемента в поиске/выдаче (контракт API).";
|
|
56
|
+
readonly examples: readonly ["UnknownSearchMode", "NoneSearchMode", "Partial", "Full"];
|
|
57
|
+
readonly usage: "Фильтрация в списках и индексация. `NoneSearchMode` — элемент не ищется в общей выдаче, но может открываться по прямой ссылке/uniqueName.";
|
|
58
|
+
};
|
|
59
|
+
readonly anyoneAccess: {
|
|
60
|
+
readonly description: "Параметры анонимного или широкого доступа без явного участия.";
|
|
61
|
+
readonly valueSchema: "AnyoneAccess";
|
|
62
|
+
readonly examples: readonly ["NoneAnyoneAccess", "Read", "ReadWrite", "Denied"];
|
|
63
|
+
readonly usage: "С `publicityType: Link` и `Read` аноним может читать карточку по ссылке в пределах прав сервера.";
|
|
64
|
+
};
|
|
65
|
+
readonly tags: {
|
|
66
|
+
readonly description: "Список строковых тегов (хэштеги) для группировки и фильтров.";
|
|
67
|
+
readonly examples: readonly ["работа", "семья", "срочно"];
|
|
68
|
+
};
|
|
69
|
+
readonly rating: {
|
|
70
|
+
readonly description: "Агрегированный рейтинг/оценки, если включены для типа.";
|
|
71
|
+
readonly valueSchema: "Rating";
|
|
72
|
+
};
|
|
73
|
+
readonly personalInfo: {
|
|
74
|
+
readonly description: "Персональное участие текущего профиля в элементе: роль участника, порядок сортировки, напоминания, тип контента.";
|
|
75
|
+
readonly valueSchema: "PersonalInfo";
|
|
76
|
+
readonly usage: "В сервисе проверяется itemContentType Full для сценариев check-in; права через OperationType на item.";
|
|
77
|
+
};
|
|
78
|
+
readonly blockInfo: {
|
|
79
|
+
readonly description: "Состояние и причина блокировки элемента.";
|
|
80
|
+
readonly valueSchema: "BlockInfo";
|
|
81
|
+
readonly usage: "Сервисы block/unblock по типу объекта (Case, Contact, Note).";
|
|
82
|
+
};
|
|
83
|
+
readonly groupInfo: {
|
|
84
|
+
readonly description: "Связь с группами, родителями, иерархией mind-map.";
|
|
85
|
+
readonly valueSchema: "GroupInfo";
|
|
86
|
+
};
|
|
87
|
+
readonly solutionData: {
|
|
88
|
+
readonly description: "Предметная конфигурация «решения» под тип элемента.";
|
|
89
|
+
readonly valueSchema: "SolutionData";
|
|
90
|
+
readonly usage: "У контакта часто задаёт раскладку карточки: `viewBlockSettings.blockSettings[]` с `name`, `order` и **числовым** `objectType` (в продукте: 1003 — заметка, 1005 — услуга и т.д.; см. константы клиента `NOTE`/`SERVICE`). Строковые имена типов в других полях (`childItemStats.objectType`) приходят как enum-строки.";
|
|
91
|
+
};
|
|
92
|
+
readonly childItemStats: {
|
|
93
|
+
readonly description: "Агрегированная статистика по дочерним элементам (количества по типам).";
|
|
94
|
+
readonly valueSchema: "ChildItemStat[]";
|
|
95
|
+
readonly examples: readonly ["[{\"objectType\":\"Service\",\"itemCount\":2},{\"objectType\":\"Note\",\"itemCount\":1}]"];
|
|
96
|
+
readonly usage: "На странице услуги: решение показывать ли check-in при отсутствии детей. Для контакта обычно приходит при `GET .../contacts/{id}?includeChildTypes=true` (см. OpenAPI). Без авторизации список дочерних id через отдельные эндпоинты mind-map может быть недоступен.";
|
|
97
|
+
};
|
|
98
|
+
readonly feedbackOptions: {
|
|
99
|
+
readonly description: "Настройки сбора отзывов и обратной связи.";
|
|
100
|
+
readonly valueSchema: "FeedbackOptions";
|
|
101
|
+
};
|
|
102
|
+
readonly integrationIds: {
|
|
103
|
+
readonly description: "Идентификаторы подключённых интеграций (внешние системы).";
|
|
104
|
+
readonly examples: readonly ["integration-uuid-1"];
|
|
105
|
+
};
|
|
106
|
+
readonly meta: {
|
|
107
|
+
readonly description: "Служебная мета: версия объекта для оптимистичных обновлений, soft-delete, архив, даты.";
|
|
108
|
+
readonly valueSchema: "ObjectInfo";
|
|
109
|
+
readonly usage: "При update/delete передаётся `versionToCheck` из `meta.version` в query (см. описание метода в OpenAPI).";
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
declare const torrowItemBaseFieldDocs: {
|
|
113
|
+
readonly id: string;
|
|
114
|
+
readonly name: string;
|
|
115
|
+
readonly uniqueName: string;
|
|
116
|
+
readonly image: string;
|
|
117
|
+
readonly masterInfo: string;
|
|
118
|
+
readonly publicityType: string;
|
|
119
|
+
readonly searchMode: string;
|
|
120
|
+
readonly anyoneAccess: string;
|
|
121
|
+
readonly tags: string;
|
|
122
|
+
readonly rating: string;
|
|
123
|
+
readonly personalInfo: string;
|
|
124
|
+
readonly blockInfo: string;
|
|
125
|
+
readonly groupInfo: string;
|
|
126
|
+
readonly solutionData: string;
|
|
127
|
+
readonly childItemStats: string;
|
|
128
|
+
readonly feedbackOptions: string;
|
|
129
|
+
readonly integrationIds: string;
|
|
130
|
+
readonly meta: string;
|
|
131
|
+
};
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* **`ContactItem`** — структурированные описания полей.
|
|
135
|
+
* @see components.schemas.ContactItem
|
|
136
|
+
*/
|
|
137
|
+
|
|
138
|
+
declare const contactItemSpecificFieldDocEntries: {
|
|
139
|
+
readonly addresses: {
|
|
140
|
+
readonly description: "Почтовые и другие адреса контакта.";
|
|
141
|
+
readonly valueSchema: "Address[]";
|
|
142
|
+
readonly usage: "Отображение адреса в карточке; клик открывает карту/детали.";
|
|
143
|
+
};
|
|
144
|
+
readonly birthday: {
|
|
145
|
+
readonly description: "Дата рождения контакта.";
|
|
146
|
+
readonly examples: readonly ["1990-05-15T00:00:00.000Z"];
|
|
147
|
+
};
|
|
148
|
+
readonly communications: {
|
|
149
|
+
readonly description: "Каналы связи: телефон, email, сайты, мессенджеры и т.д. У одного типа может быть несколько записей (например, несколько WebSite) — различаются полем order.";
|
|
150
|
+
readonly valueSchema: "Communication[]";
|
|
151
|
+
readonly usage: "У телефона в `value` — отображаемый формат, в `valueForSearch` — нормализованные цифры для поиска. У мессенджеров (`Telegram`, `Max`) `value` часто хранит идентификатор/handle; проверка канала отражается в `checkState`/`checkDate`. Основной канал для уведомлений — `personalInfo.defaultCommunication`.";
|
|
152
|
+
};
|
|
153
|
+
readonly dates: {
|
|
154
|
+
readonly description: "Памятные даты (именины, юбилеи).";
|
|
155
|
+
readonly valueSchema: "MemorableDate[]";
|
|
156
|
+
};
|
|
157
|
+
readonly firstName: {
|
|
158
|
+
readonly description: "Имя (поле визитки; для человека — имя, для «организации как контакта» может хранить часть названия).";
|
|
159
|
+
readonly examples: readonly ["Иван", "Студия"];
|
|
160
|
+
readonly usage: "Вместе с lastName/middleName может заполняться даже у бизнес-контактов; отображаемый заголовок чаще смотри в `name` и visitCard.";
|
|
161
|
+
};
|
|
162
|
+
readonly lastName: {
|
|
163
|
+
readonly description: "Фамилия или вторая часть названия визитки.";
|
|
164
|
+
readonly examples: readonly ["Иванов", "Запись"];
|
|
165
|
+
readonly usage: "Смысл поля тот же, что у firstName: не всегда классическое ФИО физлица.";
|
|
166
|
+
};
|
|
167
|
+
readonly middleName: {
|
|
168
|
+
readonly description: "Отчество.";
|
|
169
|
+
readonly examples: readonly ["Иванович"];
|
|
170
|
+
};
|
|
171
|
+
readonly company: {
|
|
172
|
+
readonly description: "Организация / место работы.";
|
|
173
|
+
readonly examples: readonly ["ООО Ромашка"];
|
|
174
|
+
};
|
|
175
|
+
readonly position: {
|
|
176
|
+
readonly description: "Должность.";
|
|
177
|
+
readonly examples: readonly ["Врач"];
|
|
178
|
+
};
|
|
179
|
+
readonly description: {
|
|
180
|
+
readonly description: "Свободный текст описания контакта (биография, заметки).";
|
|
181
|
+
};
|
|
182
|
+
readonly gender: {
|
|
183
|
+
readonly description: "Пол.";
|
|
184
|
+
readonly valueSchema: "Gender";
|
|
185
|
+
};
|
|
186
|
+
readonly registerInfo: {
|
|
187
|
+
readonly description: "Дополнительные поля, связанные с регистрацией пользователя (хобби, география и т.д. — см. схему `RegisterInfo` в OpenAPI), если контакт участвует в **Профиле** при регистрации.";
|
|
188
|
+
readonly valueSchema: "RegisterInfo";
|
|
189
|
+
readonly usage: "Может заполняться при первичной регистрации вместе с контактными данными **Профиля** (контакта пользователя).";
|
|
190
|
+
};
|
|
191
|
+
readonly photos: {
|
|
192
|
+
readonly description: "Дополнительные фотографии помимо image.";
|
|
193
|
+
readonly valueSchema: "FileInfo[]";
|
|
194
|
+
};
|
|
195
|
+
readonly visitCard: ItemFieldDoc;
|
|
196
|
+
readonly profileType: {
|
|
197
|
+
readonly description: "Роль контакта относительно учётной записи пользователя Torrow. Значения — строковый enum в OpenAPI (`ProfileType`). **Не путать с полем `visitCard`:** это разные вещи (см. ниже).";
|
|
198
|
+
readonly valueSchema: "ProfileType";
|
|
199
|
+
readonly usage: "**Профиль** в продукте — это `ContactItem`, который описывает самого пользователя Torrow и привязан к его учётной записи. В API такой контакт помечается, в частности, значением **`MyProfile`**: участие в записях, обратная связь, выбор «с какого профиля действовать», личный кабинет. У одного пользователя может быть несколько таких контактов (лимит задаёт продукт). Список и добавление **Профилей** выполняются **отдельными операциями раздела User** в OpenAPI (например `GET`/`POST` **`/api/v1/user/profiles`**, ответы `ProfileListResp` / `AddProfileResp`), а не только общим CRUD контактов по `/api/v1/contacts/...`. В SDK: **`TorrowClient.profiles`**, описания методов и тел — **`ProfilesSdkMethods`**, **`ProfileListResp`**, **`AddProfileResp`** в `mcpUserProfilesFieldCatalog`. Обычный контакт в адресной книге без роли профиля владельца — как правило **`None`** или отсутствие значения. **`AnyProfile`**, **`CopyProfile`**, **`UnknownProfile`** — прочие значения enum; уточняй по спецификации и ответам сервера. Поле **`visitCard`** — это **не** Профиль: это структура слотов отображения (как визитка на экране) и может быть у разных контактов, включая Профиль; сам факт «это Профиль пользователя» задаётся **`profileType`** и связью через API пользователя.";
|
|
200
|
+
};
|
|
201
|
+
readonly activityStatus: {
|
|
202
|
+
readonly description: "Статус активности контакта в UI.";
|
|
203
|
+
readonly valueSchema: "ActivityStatus";
|
|
204
|
+
};
|
|
205
|
+
readonly profileProperties: {
|
|
206
|
+
readonly description: "Расширенные свойства профиля.";
|
|
207
|
+
readonly valueSchema: "ProfileProperties";
|
|
208
|
+
readonly usage: "Часто содержит цвет акцента карточки (`color`, hex) и доступность владельца (`profileUserAvailability`).";
|
|
209
|
+
};
|
|
210
|
+
readonly contactProperties: {
|
|
211
|
+
readonly description: "Настройки контакта: видимость расписания контакта (`timetableVisibility`), кто может приглашать (`invitationRight`), право видеть расписание (`timetableVisibilityRight`).";
|
|
212
|
+
readonly valueSchema: "ContactProperties";
|
|
213
|
+
readonly usage: "Маппинг из форм создания/настроек. Расписание может быть скрыто на уровне контакта, при этом дочерние услуги всё равно ведут свою запись и слоты.";
|
|
214
|
+
};
|
|
215
|
+
readonly hasTimetable: {
|
|
216
|
+
readonly description: "Признак: у контакта заведено расписание (слоты).";
|
|
217
|
+
readonly examples: readonly ["true", "false"];
|
|
218
|
+
readonly usage: "Может быть false, даже если у вложенных услуг есть бронирование: расписание живёт на услуге, а не на контакте.";
|
|
219
|
+
};
|
|
220
|
+
readonly loyaltyCard: {
|
|
221
|
+
readonly description: "Вложенный элемент — карта лояльности, привязанная к контакту.";
|
|
222
|
+
readonly valueSchema: "TorrowItem";
|
|
223
|
+
};
|
|
224
|
+
};
|
|
225
|
+
declare const contactItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
226
|
+
declare const contactItemFieldDocs: {
|
|
227
|
+
[x: string]: string;
|
|
228
|
+
};
|
|
229
|
+
declare const contactItemSpecificFieldDocs: {
|
|
230
|
+
[x: string]: string;
|
|
231
|
+
};
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* **`NoteItem`**
|
|
235
|
+
* @see components.schemas.NoteItem; UI: `libs/mobile/mind-map/.../note-info.component`
|
|
236
|
+
*/
|
|
237
|
+
|
|
238
|
+
declare const noteItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
239
|
+
declare const noteItemFieldDocs: {
|
|
240
|
+
[x: string]: string;
|
|
241
|
+
};
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* **`ContextItem`** — группа/метка для организации элементов.
|
|
245
|
+
*/
|
|
246
|
+
|
|
247
|
+
declare const contextItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
248
|
+
declare const contextItemFieldDocs: {
|
|
249
|
+
[x: string]: string;
|
|
250
|
+
};
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* **`CalendarItem`**
|
|
254
|
+
*/
|
|
255
|
+
|
|
256
|
+
declare const calendarItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
257
|
+
declare const calendarItemFieldDocs: {
|
|
258
|
+
[x: string]: string;
|
|
259
|
+
};
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* **`ResourceItem`** — продуктовый ресурс (слот, аренда, билет и т.д.).
|
|
263
|
+
* @see resource-item-business: publicity Link при создании с parentId
|
|
264
|
+
*/
|
|
265
|
+
|
|
266
|
+
declare const resourceItemSpecificFieldDocEntries: {
|
|
267
|
+
readonly description: {
|
|
268
|
+
readonly description: "Текстовое описание ресурса в каталоге и при записи.";
|
|
269
|
+
};
|
|
270
|
+
readonly itemId: {
|
|
271
|
+
readonly description: "Связь с элементом-представлением ресурса в модели API.";
|
|
272
|
+
readonly examples: readonly ["uuid"];
|
|
273
|
+
};
|
|
274
|
+
readonly parentResourceId: {
|
|
275
|
+
readonly description: "Родительский ресурс в иерархии (подресурсы).";
|
|
276
|
+
readonly usage: "Иерархия resource group / вложенные услуги.";
|
|
277
|
+
};
|
|
278
|
+
readonly timetableId: {
|
|
279
|
+
readonly description: "Идентификатор расписания, к которому привязан ресурс.";
|
|
280
|
+
};
|
|
281
|
+
readonly schedule: {
|
|
282
|
+
readonly description: "Расписание доступности.";
|
|
283
|
+
readonly valueSchema: "Schedule";
|
|
284
|
+
};
|
|
285
|
+
readonly priceInfo: {
|
|
286
|
+
readonly description: "Отображаемая и расчётная ценовая информация.";
|
|
287
|
+
readonly valueSchema: "PriceInfo";
|
|
288
|
+
};
|
|
289
|
+
readonly item: {
|
|
290
|
+
readonly description: "Вложенный TorrowItem с контентом ресурса.";
|
|
291
|
+
readonly valueSchema: "TorrowItem";
|
|
292
|
+
};
|
|
293
|
+
readonly parentResource: {
|
|
294
|
+
readonly description: "Родитель как TorrowItem.";
|
|
295
|
+
readonly valueSchema: "TorrowItem";
|
|
296
|
+
};
|
|
297
|
+
readonly usageType: {
|
|
298
|
+
readonly description: "Тип потребления ресурса (время, количество и т.д.).";
|
|
299
|
+
readonly valueSchema: "UsageType";
|
|
300
|
+
};
|
|
301
|
+
readonly serviceDescriptions: {
|
|
302
|
+
readonly description: "Описания строк услуги/позиций.";
|
|
303
|
+
readonly valueSchema: "ServiceDescription[]";
|
|
304
|
+
};
|
|
305
|
+
readonly code: {
|
|
306
|
+
readonly description: "Код номенклатуры или внешний артикул.";
|
|
307
|
+
readonly examples: readonly ["SRV-001"];
|
|
308
|
+
};
|
|
309
|
+
readonly duration: {
|
|
310
|
+
readonly description: "Длительность в единицах API (часто минуты).";
|
|
311
|
+
readonly examples: readonly ["30", "60"];
|
|
312
|
+
};
|
|
313
|
+
readonly priceProperties: {
|
|
314
|
+
readonly description: "Правила цены.";
|
|
315
|
+
readonly valueSchema: "PriceProperties";
|
|
316
|
+
};
|
|
317
|
+
readonly amountProperties: {
|
|
318
|
+
readonly description: "Количество, лимиты списания.";
|
|
319
|
+
readonly valueSchema: "AmountProperties";
|
|
320
|
+
};
|
|
321
|
+
readonly usageCondition: {
|
|
322
|
+
readonly description: "Условия допустимого использования.";
|
|
323
|
+
readonly valueSchema: "UsageCondition";
|
|
324
|
+
};
|
|
325
|
+
readonly appendixList: {
|
|
326
|
+
readonly description: "Приложения и дополнительные материалы.";
|
|
327
|
+
readonly valueSchema: "Appendix[]";
|
|
328
|
+
};
|
|
329
|
+
readonly paymentProperties: {
|
|
330
|
+
readonly description: "Настройки оплаты по ресурсу.";
|
|
331
|
+
readonly valueSchema: "PaymentProperties";
|
|
332
|
+
};
|
|
333
|
+
readonly ticketProperties: {
|
|
334
|
+
readonly description: "Параметры билета/пропуска (в т.ч. state оплаты в кейсе).";
|
|
335
|
+
readonly valueSchema: "TicketProperties";
|
|
336
|
+
readonly usage: "В кейсе читается ticketProperties.state (Paid/Used) для кнопки оплаты.";
|
|
337
|
+
};
|
|
338
|
+
readonly loyaltyTransactionPropertiesList: {
|
|
339
|
+
readonly description: "Параметры транзакций лояльности.";
|
|
340
|
+
readonly valueSchema: "LoyaltyTransactionProperties[]";
|
|
341
|
+
};
|
|
342
|
+
readonly behaviorSettings: {
|
|
343
|
+
readonly description: "SDK-слой поверх `tags`: типизированные параметры поведения ресурса (`ResourceBehaviorSettings`): `marginTimeSec` (`<sec>:MarginTime`) и `lockId` (`<lockNumber>:lockId`) для TTLock.";
|
|
344
|
+
readonly usage: "Заполняется SDK при чтении (`resourceItems.getById`, `resourceItems.listPersonal`) и сериализуется в `tags` при `resourceItems.create/update`.";
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
declare const resourceItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
348
|
+
declare const resourceItemFieldDocs: {
|
|
349
|
+
[x: string]: string;
|
|
350
|
+
};
|
|
351
|
+
declare const resourceItemSpecificFieldDocs: {
|
|
352
|
+
[x: string]: string;
|
|
353
|
+
};
|
|
354
|
+
|
|
355
|
+
/**
|
|
356
|
+
* **`ServiceItem`** — услуга с записью и расписанием.
|
|
357
|
+
* @see ServicePage useEffectStartCheckInProcessOnOpen, childItemStats
|
|
358
|
+
*/
|
|
359
|
+
|
|
360
|
+
declare const serviceItemSpecificFieldDocEntries: {
|
|
361
|
+
readonly description: {
|
|
362
|
+
readonly description: "Описание услуги для клиента.";
|
|
363
|
+
readonly usage: "Текст бронирования, предоплаты и т.п. в списке услуг контакта часто собирается из `buttonName`, `priceInfo`/`priceProperties`, `stepDescriptionList`, а не только из этого поля и `TorrowItem.name`.";
|
|
364
|
+
};
|
|
365
|
+
readonly placeId: {
|
|
366
|
+
readonly description: "Идентификатор места оказания.";
|
|
367
|
+
readonly examples: readonly ["uuid-place"];
|
|
368
|
+
};
|
|
369
|
+
readonly place: {
|
|
370
|
+
readonly description: "Текстовое название или адрес места.";
|
|
371
|
+
readonly examples: readonly ["ул. Ленина, 1"];
|
|
372
|
+
};
|
|
373
|
+
readonly schedule: {
|
|
374
|
+
readonly description: "Расписание слотов/доступности.";
|
|
375
|
+
readonly valueSchema: "Schedule";
|
|
376
|
+
};
|
|
377
|
+
readonly bookingDuration: {
|
|
378
|
+
readonly description: "Длительность брони слота (единицы по контракту API, часто секунды/минуты в int64).";
|
|
379
|
+
readonly examples: readonly ["3600"];
|
|
380
|
+
};
|
|
381
|
+
readonly timetableView: {
|
|
382
|
+
readonly description: "Вариант отображения расписания в клиенте.";
|
|
383
|
+
readonly examples: readonly ["0", "1"];
|
|
384
|
+
};
|
|
385
|
+
readonly registrationOpen: {
|
|
386
|
+
readonly description: "Граница открытия записи (смещение или метка — уточнять по Swagger).";
|
|
387
|
+
};
|
|
388
|
+
readonly registrationClose: {
|
|
389
|
+
readonly description: "Граница закрытия записи.";
|
|
390
|
+
};
|
|
391
|
+
readonly maxConsumerQuantity: {
|
|
392
|
+
readonly description: "Максимум клиентов на слот/услугу.";
|
|
393
|
+
readonly examples: readonly ["1", "10"];
|
|
394
|
+
};
|
|
395
|
+
readonly executorIdList: {
|
|
396
|
+
readonly description: "Список профилей исполнителей.";
|
|
397
|
+
readonly examples: readonly ["[uuid1, uuid2]"];
|
|
398
|
+
};
|
|
399
|
+
readonly needApproval: {
|
|
400
|
+
readonly description: "Требуется подтверждение заявки исполнителем.";
|
|
401
|
+
readonly examples: readonly ["true", "false"];
|
|
402
|
+
};
|
|
403
|
+
readonly timeAlignment: {
|
|
404
|
+
readonly description: "Шаг сетки времени для слотов.";
|
|
405
|
+
};
|
|
406
|
+
readonly orderQuote: {
|
|
407
|
+
readonly description: "Параметры очереди заказов.";
|
|
408
|
+
};
|
|
409
|
+
readonly marginTime: {
|
|
410
|
+
readonly description: "Пауза между слотами.";
|
|
411
|
+
};
|
|
412
|
+
readonly executorUsagePercent: {
|
|
413
|
+
readonly description: "Доля загрузки исполнителя (0–100 или 0–1 — по контракту).";
|
|
414
|
+
readonly examples: readonly ["0.75"];
|
|
415
|
+
};
|
|
416
|
+
readonly firstWeekDate: {
|
|
417
|
+
readonly description: "Опорная дата первой недели для построения расписания.";
|
|
418
|
+
readonly examples: readonly ["2025-04-07T00:00:00.000Z"];
|
|
419
|
+
};
|
|
420
|
+
readonly clientGroupId: {
|
|
421
|
+
readonly description: "Ограничение услуги группой клиентов.";
|
|
422
|
+
};
|
|
423
|
+
readonly resourceGroupList: {
|
|
424
|
+
readonly description: "Группы ресурсов (что именно бронируется).";
|
|
425
|
+
readonly valueSchema: "ResourceGroup[]";
|
|
426
|
+
};
|
|
427
|
+
readonly participateFieldRequirements: {
|
|
428
|
+
readonly description: "Обязательные поля при записи (телефон, email и т.д.).";
|
|
429
|
+
readonly valueSchema: "ParticipateFieldRequirements";
|
|
430
|
+
readonly usage: "TorrowItemHelper.hasRequiredPhoneOrEmail для валидации формы.";
|
|
431
|
+
};
|
|
432
|
+
readonly appendixList: {
|
|
433
|
+
readonly description: "Приложения к услуге.";
|
|
434
|
+
readonly valueSchema: "Appendix[]";
|
|
435
|
+
};
|
|
436
|
+
readonly sessionDurationProperties: {
|
|
437
|
+
readonly description: "Правила длительности сессии (тип, шаг времени).";
|
|
438
|
+
readonly valueSchema: "SessionDurationProperties";
|
|
439
|
+
};
|
|
440
|
+
readonly checkInAllCases: {
|
|
441
|
+
readonly description: "Автоматический чек-ин по всем связанным кейсам.";
|
|
442
|
+
readonly examples: readonly ["true", "false"];
|
|
443
|
+
};
|
|
444
|
+
readonly stepDescriptionList: {
|
|
445
|
+
readonly description: "Пошаговое описание сценария услуги.";
|
|
446
|
+
readonly valueSchema: "StepDescription[]";
|
|
447
|
+
};
|
|
448
|
+
readonly buttonName: {
|
|
449
|
+
readonly description: "Подпись основной кнопки действия (запись, оформить).";
|
|
450
|
+
readonly examples: readonly ["Записаться"];
|
|
451
|
+
};
|
|
452
|
+
readonly numeratorInfo: {
|
|
453
|
+
readonly description: "Нумерация заказов/документов.";
|
|
454
|
+
readonly valueSchema: "NumeratorInfo";
|
|
455
|
+
};
|
|
456
|
+
readonly priceProperties: {
|
|
457
|
+
readonly description: "Правила ценообразования.";
|
|
458
|
+
readonly valueSchema: "PriceProperties";
|
|
459
|
+
};
|
|
460
|
+
readonly priceInfo: {
|
|
461
|
+
readonly description: "Итоговая ценовая информация.";
|
|
462
|
+
readonly valueSchema: "PriceInfo";
|
|
463
|
+
};
|
|
464
|
+
readonly checkinPermission: {
|
|
465
|
+
readonly description: "Кто и когда может отметить прибытие.";
|
|
466
|
+
readonly valueSchema: "CheckinPermission";
|
|
467
|
+
};
|
|
468
|
+
readonly caseActionList: {
|
|
469
|
+
readonly description: "Автоматические действия при смене состояния кейса.";
|
|
470
|
+
readonly valueSchema: "CaseAction[]";
|
|
471
|
+
};
|
|
472
|
+
readonly packingStrategyProperties: {
|
|
473
|
+
readonly description: "Упаковка слотов/ресурсов в расписании.";
|
|
474
|
+
readonly valueSchema: "PackingStrategyProperties";
|
|
475
|
+
};
|
|
476
|
+
readonly loyaltyTransactionPropertiesList: {
|
|
477
|
+
readonly description: "Настройки лояльности для услуги.";
|
|
478
|
+
readonly valueSchema: "LoyaltyTransactionProperties[]";
|
|
479
|
+
};
|
|
480
|
+
readonly behaviorSettings: {
|
|
481
|
+
readonly description: "SDK-слой поверх `tags`: типизированные параметры поведения услуги (`ServiceBehaviorSettings`) для чтения/обновления без ручной работы со строковыми тегами.";
|
|
482
|
+
readonly usage: "Заполняется SDK при чтении (`services.getById`, `services.listPersonal`) и сериализуется обратно в `tags` при `services.create/update`.";
|
|
483
|
+
};
|
|
484
|
+
};
|
|
485
|
+
declare const serviceItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
486
|
+
declare const serviceItemFieldDocs: {
|
|
487
|
+
[x: string]: string;
|
|
488
|
+
};
|
|
489
|
+
declare const serviceItemSpecificFieldDocs: {
|
|
490
|
+
[x: string]: string;
|
|
491
|
+
};
|
|
492
|
+
|
|
493
|
+
/**
|
|
494
|
+
* **`CaseItem`** — **событие** в продукте (визит, запись и т.д.); **заказ** — частный случай события после записи на **услугу** (`createOrder`).
|
|
495
|
+
* @see CasePage getPayButtonType — ticketState, paymentProvider
|
|
496
|
+
*/
|
|
497
|
+
|
|
498
|
+
declare const caseItemSpecificFieldDocEntries: {
|
|
499
|
+
readonly beginDate: {
|
|
500
|
+
readonly description: "Начало периода оказания услуги / визита.";
|
|
501
|
+
readonly examples: readonly ["2025-04-12T09:00:00.000Z"];
|
|
502
|
+
};
|
|
503
|
+
readonly endDate: {
|
|
504
|
+
readonly description: "Окончание периода.";
|
|
505
|
+
readonly examples: readonly ["2025-04-12T10:00:00.000Z"];
|
|
506
|
+
};
|
|
507
|
+
readonly description: {
|
|
508
|
+
readonly description: "Комментарий к заказу, пожелания клиента или заметка исполнителя.";
|
|
509
|
+
};
|
|
510
|
+
readonly placeId: {
|
|
511
|
+
readonly description: "Идентификатор места.";
|
|
512
|
+
readonly examples: readonly ["uuid"];
|
|
513
|
+
};
|
|
514
|
+
readonly serviceId: {
|
|
515
|
+
readonly description: "Идентификатор услуги, к которой относится кейс.";
|
|
516
|
+
readonly examples: readonly ["uuid"];
|
|
517
|
+
readonly usage: "Навигация к карточке услуги; сценарии записи.";
|
|
518
|
+
};
|
|
519
|
+
readonly groupId: {
|
|
520
|
+
readonly description: "Идентификатор группового события/пакета кейсов.";
|
|
521
|
+
};
|
|
522
|
+
readonly place: {
|
|
523
|
+
readonly description: "Текстовое описание места (если placeId не задан или для отображения).";
|
|
524
|
+
readonly examples: readonly ["Кабинет 3"];
|
|
525
|
+
};
|
|
526
|
+
readonly caseState: {
|
|
527
|
+
readonly description: "Состояние жизненного цикла заказа.";
|
|
528
|
+
readonly examples: readonly ["Verifying", "Waiting", "Processing", "Preparing", "Completed", "Closed", "Rejected", "Canceled", "TimeControlled", "TaskNotCompleted", "TaskCompleted", "UnknownCaseState"];
|
|
529
|
+
readonly valueSchema: "CaseState";
|
|
530
|
+
readonly usage: "Отображение статуса в карточке и триггеры case actions.";
|
|
531
|
+
};
|
|
532
|
+
readonly caseType: {
|
|
533
|
+
readonly description: "Тип планирования кейса по времени.";
|
|
534
|
+
readonly examples: readonly ["Time", "RepeatedTime", "Today", "Week", "Later", "Date", "State", "UnknownTimeType"];
|
|
535
|
+
readonly valueSchema: "CaseType";
|
|
536
|
+
};
|
|
537
|
+
readonly caseStateDate: {
|
|
538
|
+
readonly description: "Момент последнего изменения caseState.";
|
|
539
|
+
readonly examples: readonly ["2025-04-12T11:00:00.000Z"];
|
|
540
|
+
};
|
|
541
|
+
readonly personalInfo: {
|
|
542
|
+
readonly description: "Участие текущего профиля в кейсе: участник, билет, оплата, связанные ResourceItem.";
|
|
543
|
+
readonly valueSchema: "CasePersonalInfo";
|
|
544
|
+
readonly usage: "Для оплаты: personalInfo.caseParticipant, ticketResource.ticketProperties.state (Paid/Used), paymentProperties.paymentProviderType (Cash и т.д.) — см. CasePage.";
|
|
545
|
+
};
|
|
546
|
+
readonly bookingResourceList: {
|
|
547
|
+
readonly description: "Забронированные ресурсы (слоты, услуги).";
|
|
548
|
+
readonly valueSchema: "BookingResource[]";
|
|
549
|
+
};
|
|
550
|
+
readonly schedule: {
|
|
551
|
+
readonly description: "Расписание, связанное с кейсом.";
|
|
552
|
+
readonly valueSchema: "Schedule";
|
|
553
|
+
};
|
|
554
|
+
readonly registrationOpen: {
|
|
555
|
+
readonly description: "Параметр окна регистрации на кейс (см. Swagger).";
|
|
556
|
+
};
|
|
557
|
+
readonly registrationClose: {
|
|
558
|
+
readonly description: "Параметр закрытия регистрации.";
|
|
559
|
+
};
|
|
560
|
+
readonly visitCard: {
|
|
561
|
+
readonly description: "Поля визитки/карточки заказа.";
|
|
562
|
+
readonly valueSchema: "CaseVisitCard";
|
|
563
|
+
};
|
|
564
|
+
readonly bookingDuration: {
|
|
565
|
+
readonly description: "Длительность брони.";
|
|
566
|
+
readonly examples: readonly ["60"];
|
|
567
|
+
};
|
|
568
|
+
readonly maxConsumerQuantity: {
|
|
569
|
+
readonly description: "Лимит участников.";
|
|
570
|
+
readonly examples: readonly ["5"];
|
|
571
|
+
};
|
|
572
|
+
readonly bookingConsumerQuantity: {
|
|
573
|
+
readonly description: "Фактическое число записанных.";
|
|
574
|
+
readonly examples: readonly ["3"];
|
|
575
|
+
};
|
|
576
|
+
readonly executorUsagePercent: {
|
|
577
|
+
readonly description: "Загрузка исполнителя.";
|
|
578
|
+
};
|
|
579
|
+
readonly availableResources: {
|
|
580
|
+
readonly description: "Доступные для выбора ресурсы при записи.";
|
|
581
|
+
readonly valueSchema: "AvailableResources";
|
|
582
|
+
};
|
|
583
|
+
readonly needApproval: {
|
|
584
|
+
readonly description: "Ожидается подтверждение.";
|
|
585
|
+
readonly examples: readonly ["true", "false"];
|
|
586
|
+
};
|
|
587
|
+
readonly createSingleCases: {
|
|
588
|
+
readonly description: "Порождение одиночных кейсов в групповом режиме.";
|
|
589
|
+
readonly examples: readonly ["true", "false"];
|
|
590
|
+
};
|
|
591
|
+
readonly orderNumber: {
|
|
592
|
+
readonly description: "Человекочитаемый номер заказа.";
|
|
593
|
+
readonly valueSchema: "OrderNumber";
|
|
594
|
+
readonly examples: readonly ["ORD-2025-0042"];
|
|
595
|
+
};
|
|
596
|
+
readonly checkinPermission: {
|
|
597
|
+
readonly description: "Права на чек-ин.";
|
|
598
|
+
readonly valueSchema: "CheckinPermission";
|
|
599
|
+
};
|
|
600
|
+
readonly hidden: {
|
|
601
|
+
readonly description: "Скрыть кейс в списках пользователя.";
|
|
602
|
+
readonly examples: readonly ["true", "false"];
|
|
603
|
+
};
|
|
604
|
+
readonly consumersCount: {
|
|
605
|
+
readonly description: "Число потребителей (агрегат для UI).";
|
|
606
|
+
readonly examples: readonly ["2"];
|
|
607
|
+
};
|
|
608
|
+
readonly caseSummary: {
|
|
609
|
+
readonly description: "Краткая сводка по заказу.";
|
|
610
|
+
readonly valueSchema: "CaseSummary";
|
|
611
|
+
};
|
|
612
|
+
readonly appendixList: {
|
|
613
|
+
readonly description: "Приложения.";
|
|
614
|
+
readonly valueSchema: "Appendix[]";
|
|
615
|
+
};
|
|
616
|
+
readonly participateFieldRequirements: {
|
|
617
|
+
readonly description: "Обязательные поля при участии.";
|
|
618
|
+
readonly valueSchema: "ParticipateFieldRequirements";
|
|
619
|
+
};
|
|
620
|
+
readonly resourceGroupList: {
|
|
621
|
+
readonly description: "Группы ресурсов.";
|
|
622
|
+
readonly valueSchema: "ResourceGroup[]";
|
|
623
|
+
};
|
|
624
|
+
readonly priceProperties: {
|
|
625
|
+
readonly description: "Ценообразование.";
|
|
626
|
+
readonly valueSchema: "PriceProperties";
|
|
627
|
+
};
|
|
628
|
+
readonly priceInfo: {
|
|
629
|
+
readonly description: "Цена.";
|
|
630
|
+
readonly valueSchema: "PriceInfo";
|
|
631
|
+
};
|
|
632
|
+
readonly priority: {
|
|
633
|
+
readonly description: "Приоритет в очереди/обработке.";
|
|
634
|
+
readonly examples: readonly ["1.0"];
|
|
635
|
+
};
|
|
636
|
+
readonly clientGroupId: {
|
|
637
|
+
readonly description: "Группа клиентов.";
|
|
638
|
+
};
|
|
639
|
+
readonly caseActionList: {
|
|
640
|
+
readonly description: "Автоматизации и напоминания.";
|
|
641
|
+
readonly valueSchema: "CaseAction[]";
|
|
642
|
+
};
|
|
643
|
+
readonly loyaltyTransactionPropertiesList: {
|
|
644
|
+
readonly description: "Лояльность.";
|
|
645
|
+
readonly valueSchema: "LoyaltyTransactionProperties[]";
|
|
646
|
+
};
|
|
647
|
+
};
|
|
648
|
+
declare const caseItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
649
|
+
declare const caseItemFieldDocs: {
|
|
650
|
+
[x: string]: string;
|
|
651
|
+
};
|
|
652
|
+
declare const caseItemSpecificFieldDocs: {
|
|
653
|
+
[x: string]: string;
|
|
654
|
+
};
|
|
655
|
+
|
|
656
|
+
declare const objectInfoFieldDocEntries: {
|
|
657
|
+
readonly deleteState: {
|
|
658
|
+
readonly description: "Состояние мягкого удаления.";
|
|
659
|
+
readonly valueSchema: "DeleteState";
|
|
660
|
+
};
|
|
661
|
+
readonly archiveState: {
|
|
662
|
+
readonly description: "Состояние архивации.";
|
|
663
|
+
readonly valueSchema: "ArchiveState";
|
|
664
|
+
};
|
|
665
|
+
readonly version: {
|
|
666
|
+
readonly description: "Версия сущности для оптимистичной блокировки при update/delete.";
|
|
667
|
+
readonly examples: readonly ["1", "42"];
|
|
668
|
+
readonly usage: "Передаётся как versionToCheck в query; несовпадение — конфликт на сервере.";
|
|
669
|
+
};
|
|
670
|
+
readonly lastModified: {
|
|
671
|
+
readonly description: "Время последнего изменения (ISO 8601).";
|
|
672
|
+
readonly examples: readonly ["2025-04-12T10:30:00.000Z"];
|
|
673
|
+
};
|
|
674
|
+
readonly createDate: {
|
|
675
|
+
readonly description: "Время создания (ISO 8601).";
|
|
676
|
+
readonly examples: readonly ["2025-01-01T08:00:00.000Z"];
|
|
677
|
+
};
|
|
678
|
+
};
|
|
679
|
+
declare const objectInfoFieldDocs: {
|
|
680
|
+
readonly deleteState: string;
|
|
681
|
+
readonly archiveState: string;
|
|
682
|
+
readonly version: string;
|
|
683
|
+
readonly lastModified: string;
|
|
684
|
+
readonly createDate: string;
|
|
685
|
+
};
|
|
686
|
+
|
|
687
|
+
/**
|
|
688
|
+
* Подробности **`ContactItem.visitCard`** и полей **`ContactVisitCardField`**.
|
|
689
|
+
*
|
|
690
|
+
* Это поле задаёт **слоты отображения** (визитная вёрстка контакта), а не сущность «Профиль пользователя».
|
|
691
|
+
* Профиль — отдельный продуктовый и API-контур (`profileType`, операции **`/api/v1/user/profiles`**).
|
|
692
|
+
*
|
|
693
|
+
* `expression` в API — JSON в виде **строки**: парсинг на стороне клиента, тип слота задаёт источник данных
|
|
694
|
+
* (поля контакта, `communications`, `addresses`). Клиент может пересчитывать отображаемую строку `value`
|
|
695
|
+
* из `expression` и актуальных полей контакта перед сохранением.
|
|
696
|
+
*/
|
|
697
|
+
|
|
698
|
+
declare const contactVisitCardFieldDoc: ItemFieldDoc;
|
|
699
|
+
|
|
700
|
+
/**
|
|
701
|
+
* Агрегат описаний полей **элементов** (*Item) для **генерации MCP-сервера** и внешних тулов:
|
|
702
|
+
* каждый ключ — имя схемы в OpenAPI, значение — карта полей → {@link ItemFieldDoc}.
|
|
703
|
+
*
|
|
704
|
+
* Связи и mind map: {@link mcpRelationFieldCatalog}; запись и оплата: `mcpBookingFieldCatalog` в `mcp-booking-catalog.ts`;
|
|
705
|
+
* представления: `mcpViewsFieldCatalog` в `mcp-views-catalog.ts`; объединение: {@link mcpFullFieldCatalog}.
|
|
706
|
+
*
|
|
707
|
+
* Строковые плоские карты (`*FieldDocs`) получайте через {@link fieldDocToString} при необходимости
|
|
708
|
+
* или используйте готовые `contactItemFieldDocs` из пакета.
|
|
709
|
+
*/
|
|
710
|
+
|
|
711
|
+
declare const mcpItemFieldCatalog: {
|
|
712
|
+
TorrowItem: Record<string, ItemFieldDoc>;
|
|
713
|
+
ContactItem: Record<string, ItemFieldDoc>;
|
|
714
|
+
NoteItem: Record<string, ItemFieldDoc>;
|
|
715
|
+
ContextItem: Record<string, ItemFieldDoc>;
|
|
716
|
+
CalendarItem: Record<string, ItemFieldDoc>;
|
|
717
|
+
ResourceItem: Record<string, ItemFieldDoc>;
|
|
718
|
+
ServiceItem: Record<string, ItemFieldDoc>;
|
|
719
|
+
CaseItem: Record<string, ItemFieldDoc>;
|
|
720
|
+
ObjectInfo: Record<string, ItemFieldDoc>;
|
|
721
|
+
};
|
|
722
|
+
|
|
723
|
+
/**
|
|
724
|
+
* Каталог полей **записи на услугу, мастера и оплаты** для MCP и агентов.
|
|
725
|
+
* Объединяется в {@link mcpFullFieldCatalog}.
|
|
726
|
+
*/
|
|
727
|
+
|
|
728
|
+
declare const mcpBookingFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Описания схем токенов и конфигурации авторизации для MCP / агентов.
|
|
732
|
+
* Ключи верхнего уровня: `TokenResp`, `RefreshReq`, `TokenReq`, `RevokeReq` совпадают с `components.schemas`;
|
|
733
|
+
* `TorrowClientConfigAuth` — условное имя для полей {@link TorrowClientConfig}, относящихся к токенам.
|
|
734
|
+
*/
|
|
735
|
+
|
|
736
|
+
declare const mcpAuthFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* Каталог **Search** для MCP и агентов. Объединяется в {@link mcpFullFieldCatalog}.
|
|
740
|
+
*/
|
|
741
|
+
|
|
742
|
+
declare const mcpSearchFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* Каталоги операций (**TorrowItemCoreFacade**, ActionHistory, Accounting, Announcement, ExportImport, Report, Loyalty*, BlockReason, Contacts communication) для {@link mcpFullFieldCatalog}.
|
|
746
|
+
*/
|
|
747
|
+
|
|
748
|
+
declare const mcpOperationsFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* Каталог **Профилей пользователя** (User API) для MCP и агентов. Объединяется в {@link mcpFullFieldCatalog}.
|
|
752
|
+
*/
|
|
753
|
+
|
|
754
|
+
declare const mcpUserProfilesFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
755
|
+
|
|
756
|
+
/**
|
|
757
|
+
* Каталог полей **представлений (views)** для MCP и агентов. Объединяется в {@link mcpFullFieldCatalog}.
|
|
758
|
+
*/
|
|
759
|
+
|
|
760
|
+
declare const mcpViewsFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
761
|
+
|
|
762
|
+
/**
|
|
763
|
+
* Каталог описаний схем **связей и mind map** для MCP / агентов.
|
|
764
|
+
* Имена верхнего уровня совпадают с `components.schemas` в OpenAPI (кроме `RelationsApiDomain`).
|
|
765
|
+
*/
|
|
766
|
+
|
|
767
|
+
declare const mcpRelationFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
768
|
+
/** Объединение каталогов *Item, связей, записи/оплаты и представлений — один объект для генерации MCP. */
|
|
769
|
+
declare const mcpFullFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
770
|
+
|
|
771
|
+
declare const accountingTransactionsSdkMethodFieldDocEntries: {
|
|
772
|
+
readonly create: {
|
|
773
|
+
readonly description: "`POST /api/v1/accountingtransactions` — тело **`AccountingTransaction`**; query **`securityToken`**.";
|
|
774
|
+
};
|
|
775
|
+
readonly update: {
|
|
776
|
+
readonly description: "`PUT /api/v1/accountingtransactions/{torrowId}` — полное обновление DTO.";
|
|
777
|
+
};
|
|
778
|
+
readonly delete: {
|
|
779
|
+
readonly description: "`DELETE /api/v1/accountingtransactions/{torrowId}` → **`DeleteResponse`**.";
|
|
780
|
+
};
|
|
781
|
+
readonly updateState: {
|
|
782
|
+
readonly description: "`PUT .../state` — смена состояния через query **`state`** (`AccountingTransactionState`).";
|
|
783
|
+
};
|
|
784
|
+
readonly getBalance: {
|
|
785
|
+
readonly description: "`GET .../balance` — массив **`BalanceValue`**; опционально **`balanceDate`**.";
|
|
786
|
+
};
|
|
787
|
+
readonly listTransactions: {
|
|
788
|
+
readonly description: "`GET .../transactions` — список **`AccountingTransaction`** с фильтрами и пагинацией.";
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
declare const accountingTransactionsSdkMethodFieldDocs: {
|
|
792
|
+
readonly create: string;
|
|
793
|
+
readonly update: string;
|
|
794
|
+
readonly delete: string;
|
|
795
|
+
readonly updateState: string;
|
|
796
|
+
readonly getBalance: string;
|
|
797
|
+
readonly listTransactions: string;
|
|
798
|
+
};
|
|
799
|
+
declare const announcementsSdkMethodFieldDocEntries: {
|
|
800
|
+
readonly list: {
|
|
801
|
+
readonly description: "`GET /api/v1/announcements` — **`AnnouncementInfo[]`**; query как в Swagger (**`lmfrom`**, **`lmto`** в нижнем регистре).";
|
|
802
|
+
};
|
|
803
|
+
readonly updateState: {
|
|
804
|
+
readonly description: "`POST /api/v1/announcements/updatestate` — массив **`UpdateAnnouncementStateReq`** → **`TorrowObject[]`**.";
|
|
805
|
+
};
|
|
806
|
+
};
|
|
807
|
+
declare const announcementsSdkMethodFieldDocs: {
|
|
808
|
+
readonly list: string;
|
|
809
|
+
readonly updateState: string;
|
|
810
|
+
};
|
|
811
|
+
declare const exportImportSdkMethodFieldDocEntries: {
|
|
812
|
+
readonly exportSubgraph: {
|
|
813
|
+
readonly description: "`POST /api/v1/export` — тело **`ExportRequest`** (`itemId`, `depth`) → **`ExportGraph`**.";
|
|
814
|
+
};
|
|
815
|
+
readonly importFromFile: {
|
|
816
|
+
readonly description: "`POST /api/v1/import` — тело **`ImportByFileRequest`** (граф + `parentId` / флаги) → **`TorrowItem`**.";
|
|
817
|
+
};
|
|
818
|
+
readonly importByUniqueName: {
|
|
819
|
+
readonly description: "`POST /api/v1/importbyuniquename` — **`ImportByUniqueNameRequest`**.";
|
|
820
|
+
};
|
|
821
|
+
};
|
|
822
|
+
declare const exportImportSdkMethodFieldDocs: {
|
|
823
|
+
readonly exportSubgraph: string;
|
|
824
|
+
readonly importFromFile: string;
|
|
825
|
+
readonly importByUniqueName: string;
|
|
826
|
+
};
|
|
827
|
+
declare const reportsSdkMethodFieldDocEntries: {
|
|
828
|
+
readonly generate: {
|
|
829
|
+
readonly description: "`POST /api/v1/reports` — **`GenerateReportReq`**; опционально **`profileId`** в query.";
|
|
830
|
+
};
|
|
831
|
+
readonly generateForProfile: {
|
|
832
|
+
readonly description: "`POST /api/v1/reports/{profileId}` — то же тело, профиль в path.";
|
|
833
|
+
};
|
|
834
|
+
};
|
|
835
|
+
declare const reportsSdkMethodFieldDocs: {
|
|
836
|
+
readonly generate: string;
|
|
837
|
+
readonly generateForProfile: string;
|
|
838
|
+
};
|
|
839
|
+
declare const actionHistorySdkMethodFieldDocEntries: {
|
|
840
|
+
readonly list: {
|
|
841
|
+
readonly description: "`GET /api/v1/actionhistory` — **`ActionHistoryInfo[]`**; query как в OpenAPI (**`lmfrom`**, **`lmto`** lower-case, `types`, `states`, `itemIds`).";
|
|
842
|
+
};
|
|
843
|
+
};
|
|
844
|
+
declare const actionHistorySdkMethodFieldDocs: {
|
|
845
|
+
readonly list: string;
|
|
846
|
+
};
|
|
847
|
+
declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
848
|
+
readonly create: {
|
|
849
|
+
readonly description: "`POST /api/v1/loyaltysystems` — тело **`LoyaltySystemItem`**; query **`parentId`**, **`profileId`**.";
|
|
850
|
+
};
|
|
851
|
+
readonly update: {
|
|
852
|
+
readonly description: "`PUT /api/v1/loyaltysystems/{torrowId}`.";
|
|
853
|
+
};
|
|
854
|
+
readonly delete: {
|
|
855
|
+
readonly description: "`DELETE /api/v1/loyaltysystems/{torrowId}` — как у элементов: **`cascade`**, **`withPinnedItems`**.";
|
|
856
|
+
};
|
|
857
|
+
readonly getById: {
|
|
858
|
+
readonly description: "`GET /api/v1/loyaltysystems/{torrowId}`.";
|
|
859
|
+
};
|
|
860
|
+
readonly listPersonal: {
|
|
861
|
+
readonly description: "`GET .../personallist` — query с **`lmFrom`** / **`lmTo`** (camelCase в OpenAPI), не `lmfrom`.";
|
|
862
|
+
};
|
|
863
|
+
readonly deleteFromPersonalList: {
|
|
864
|
+
readonly description: "`DELETE .../personallist/{torrowId}`.";
|
|
865
|
+
};
|
|
866
|
+
readonly createLoyaltyCard: {
|
|
867
|
+
readonly description: "`POST .../{loyaltySystemId}/loyaltycard` — **`CreateLoyaltyCardReq`** (обязателен **`profileId`**).";
|
|
868
|
+
};
|
|
869
|
+
readonly postStatistics: {
|
|
870
|
+
readonly description: "`POST /api/v1/loyaltysystems/statistics` — **`GetLoyaltySystemsStatisticsReq`**.";
|
|
871
|
+
};
|
|
872
|
+
readonly getParticipantsCount: {
|
|
873
|
+
readonly description: "`GET .../{torrowId}/participants/count`.";
|
|
874
|
+
};
|
|
875
|
+
readonly updatePublicity: {
|
|
876
|
+
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
877
|
+
};
|
|
878
|
+
readonly updateImageId: {
|
|
879
|
+
readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
|
|
880
|
+
};
|
|
881
|
+
readonly updateTorrowAccountId: {
|
|
882
|
+
readonly description: "`PUT .../{torrowId}/torrowaccount/id` — тело JSON-string id аккаунта.";
|
|
883
|
+
};
|
|
884
|
+
readonly updateMasterInfo: {
|
|
885
|
+
readonly description: "`PUT .../{torrowId}/masterinfo` — **`UpdateMasterInfoReq`**.";
|
|
886
|
+
};
|
|
887
|
+
readonly updateIntegrations: {
|
|
888
|
+
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
889
|
+
};
|
|
890
|
+
readonly listParticipants: {
|
|
891
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty*** в Swagger query **`lmFrom`/`lmTo`** (camelCase), у **contact/case** в типах SDK — **`lmfrom`/`lmto`**.";
|
|
892
|
+
};
|
|
893
|
+
readonly generateSecurityToken: {
|
|
894
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
895
|
+
};
|
|
896
|
+
readonly updateParticipationType: {
|
|
897
|
+
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
898
|
+
};
|
|
899
|
+
readonly requestAccess: {
|
|
900
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`** (string); query **`userMessage`**.";
|
|
901
|
+
};
|
|
902
|
+
readonly revokeAccessRequest: {
|
|
903
|
+
readonly description: "`PUT .../participation/revokerequest`.";
|
|
904
|
+
};
|
|
905
|
+
readonly setGroup: {
|
|
906
|
+
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
907
|
+
};
|
|
908
|
+
readonly unsetGroup: {
|
|
909
|
+
readonly description: "`PUT .../group/unset` — **`UnsetGroupItemReq`**.";
|
|
910
|
+
};
|
|
911
|
+
readonly updateTags: {
|
|
912
|
+
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
913
|
+
};
|
|
914
|
+
readonly listGroup: {
|
|
915
|
+
readonly description: "`GET .../{torrowId}/group/list` — query как в OpenAPI (**`lmfrom`**, **`lmto`** lower-case и др.); у **loyaltycards** пути в API нет — в SDK вызов бросает (**`withGroupListEndpoint: false`**).";
|
|
916
|
+
};
|
|
917
|
+
readonly updateGroups: {
|
|
918
|
+
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
919
|
+
};
|
|
920
|
+
readonly includeToGroups: {
|
|
921
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
922
|
+
};
|
|
923
|
+
readonly excludeFromGroups: {
|
|
924
|
+
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
925
|
+
};
|
|
926
|
+
readonly includeToParent: {
|
|
927
|
+
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
928
|
+
};
|
|
929
|
+
readonly excludeFromParent: {
|
|
930
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — **`ExcludeReq`**.";
|
|
931
|
+
};
|
|
932
|
+
readonly includeForUser: {
|
|
933
|
+
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
934
|
+
};
|
|
935
|
+
readonly excludeFromUser: {
|
|
936
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — **`ExcludeReq`**.";
|
|
937
|
+
};
|
|
938
|
+
readonly rejectOffer: {
|
|
939
|
+
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
940
|
+
};
|
|
941
|
+
readonly reject: {
|
|
942
|
+
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
943
|
+
};
|
|
944
|
+
readonly share: {
|
|
945
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
946
|
+
};
|
|
947
|
+
readonly revokeOffer: {
|
|
948
|
+
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
949
|
+
};
|
|
950
|
+
readonly grantAccess: {
|
|
951
|
+
readonly description: "`PUT .../participation/grantaccess` — body: `string[]`.";
|
|
952
|
+
};
|
|
953
|
+
readonly declineAccess: {
|
|
954
|
+
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
955
|
+
};
|
|
956
|
+
readonly updatePersonalListOrder: {
|
|
957
|
+
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
958
|
+
};
|
|
959
|
+
readonly updateAlias: {
|
|
960
|
+
readonly description: "`PUT .../{itemId}/alias` — body: string (**alias**); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
961
|
+
};
|
|
962
|
+
readonly updateLastUsageTime: {
|
|
963
|
+
readonly description: "`PUT .../{itemId}/lastusagetime` — body: ISO date-time string.";
|
|
964
|
+
};
|
|
965
|
+
readonly updateParticipationProfile: {
|
|
966
|
+
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
967
|
+
};
|
|
968
|
+
readonly sendLink: {
|
|
969
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
970
|
+
};
|
|
971
|
+
readonly getShortUrl: {
|
|
972
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string`.";
|
|
973
|
+
};
|
|
974
|
+
readonly updateUniqueName: {
|
|
975
|
+
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
976
|
+
};
|
|
977
|
+
readonly getByUniqueName: {
|
|
978
|
+
readonly description: "`GET .../uniquename/{uniqueName}` — у **cases** доп. query **`profileId`** (override); иначе только **`signal`**.";
|
|
979
|
+
};
|
|
980
|
+
readonly getImageInfo: {
|
|
981
|
+
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
982
|
+
};
|
|
983
|
+
readonly getImagePutUrl: {
|
|
984
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; query **`fileId`**, **`fileName`**, **`fileSize`**.";
|
|
985
|
+
};
|
|
986
|
+
readonly saveToMindMap: {
|
|
987
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
988
|
+
};
|
|
989
|
+
readonly updateSolutionData: {
|
|
990
|
+
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
991
|
+
};
|
|
992
|
+
readonly updatePersonalSolutionData: {
|
|
993
|
+
readonly description: "`PUT .../{itemId}/personalsolutiondata` — **`PersonalSolutionData`**.";
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
declare const loyaltySystemsSdkMethodFieldDocs: {
|
|
997
|
+
readonly create: string;
|
|
998
|
+
readonly update: string;
|
|
999
|
+
readonly delete: string;
|
|
1000
|
+
readonly getById: string;
|
|
1001
|
+
readonly listPersonal: string;
|
|
1002
|
+
readonly deleteFromPersonalList: string;
|
|
1003
|
+
readonly createLoyaltyCard: string;
|
|
1004
|
+
readonly postStatistics: string;
|
|
1005
|
+
readonly getParticipantsCount: string;
|
|
1006
|
+
readonly updatePublicity: string;
|
|
1007
|
+
readonly updateImageId: string;
|
|
1008
|
+
readonly updateTorrowAccountId: string;
|
|
1009
|
+
readonly updateMasterInfo: string;
|
|
1010
|
+
readonly updateIntegrations: string;
|
|
1011
|
+
readonly listParticipants: string;
|
|
1012
|
+
readonly generateSecurityToken: string;
|
|
1013
|
+
readonly updateParticipationType: string;
|
|
1014
|
+
readonly requestAccess: string;
|
|
1015
|
+
readonly revokeAccessRequest: string;
|
|
1016
|
+
readonly setGroup: string;
|
|
1017
|
+
readonly unsetGroup: string;
|
|
1018
|
+
readonly updateTags: string;
|
|
1019
|
+
readonly listGroup: string;
|
|
1020
|
+
readonly updateGroups: string;
|
|
1021
|
+
readonly includeToGroups: string;
|
|
1022
|
+
readonly excludeFromGroups: string;
|
|
1023
|
+
readonly includeToParent: string;
|
|
1024
|
+
readonly excludeFromParent: string;
|
|
1025
|
+
readonly includeForUser: string;
|
|
1026
|
+
readonly excludeFromUser: string;
|
|
1027
|
+
readonly rejectOffer: string;
|
|
1028
|
+
readonly reject: string;
|
|
1029
|
+
readonly share: string;
|
|
1030
|
+
readonly revokeOffer: string;
|
|
1031
|
+
readonly grantAccess: string;
|
|
1032
|
+
readonly declineAccess: string;
|
|
1033
|
+
readonly updatePersonalListOrder: string;
|
|
1034
|
+
readonly updateAlias: string;
|
|
1035
|
+
readonly updateLastUsageTime: string;
|
|
1036
|
+
readonly updateParticipationProfile: string;
|
|
1037
|
+
readonly sendLink: string;
|
|
1038
|
+
readonly getShortUrl: string;
|
|
1039
|
+
readonly updateUniqueName: string;
|
|
1040
|
+
readonly getByUniqueName: string;
|
|
1041
|
+
readonly getImageInfo: string;
|
|
1042
|
+
readonly getImagePutUrl: string;
|
|
1043
|
+
readonly saveToMindMap: string;
|
|
1044
|
+
readonly updateSolutionData: string;
|
|
1045
|
+
readonly updatePersonalSolutionData: string;
|
|
1046
|
+
};
|
|
1047
|
+
declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
1048
|
+
readonly update: {
|
|
1049
|
+
readonly description: "`PUT /api/v1/loyaltycards/{torrowId}` — **`LoyaltyCardItem`**.";
|
|
1050
|
+
};
|
|
1051
|
+
readonly delete: {
|
|
1052
|
+
readonly description: "`DELETE ...` — **`cascade`**, **`withPinnedItems`**.";
|
|
1053
|
+
};
|
|
1054
|
+
readonly getById: {
|
|
1055
|
+
readonly description: "`GET ...` — опционально **`includeBalance`** (по умолчанию в API true).";
|
|
1056
|
+
};
|
|
1057
|
+
readonly listPersonal: {
|
|
1058
|
+
readonly description: "`GET .../personallist` — как у систем, плюс **`includeBalance`** в query.";
|
|
1059
|
+
};
|
|
1060
|
+
readonly deleteFromPersonalList: {
|
|
1061
|
+
readonly description: "`DELETE .../personallist/{torrowId}`.";
|
|
1062
|
+
};
|
|
1063
|
+
readonly createSubscription: {
|
|
1064
|
+
readonly description: "`POST /api/v1/loyaltycards/{loyaltyCardId}/subscription` — **`CreateLoyaltyCardSubscriptionReq`** → **`LoyaltyCardSubscription`**.";
|
|
1065
|
+
};
|
|
1066
|
+
readonly getParticipantsCount: {
|
|
1067
|
+
readonly description: "`GET .../{torrowId}/participants/count`.";
|
|
1068
|
+
};
|
|
1069
|
+
readonly getBalance: {
|
|
1070
|
+
readonly description: "`GET .../{torrowId}/balance` — query: `balanceDate`, `securityToken`.";
|
|
1071
|
+
};
|
|
1072
|
+
readonly listTransactions: {
|
|
1073
|
+
readonly description: "`GET .../{torrowId}/transactions` — query как у accounting list.";
|
|
1074
|
+
};
|
|
1075
|
+
readonly getSubscriptionBalance: {
|
|
1076
|
+
readonly description: "`GET .../subscriptions/{subscriptionId}/balance`.";
|
|
1077
|
+
};
|
|
1078
|
+
readonly getSubscriptionTransactions: {
|
|
1079
|
+
readonly description: "`GET .../subscriptions/{subscriptionId}/transactions`.";
|
|
1080
|
+
};
|
|
1081
|
+
readonly getTimetableStatistics: {
|
|
1082
|
+
readonly description: "`POST /api/v1/loyaltycards/timetable/statistics` — **`GetTimetableStatisticsRequest`** → **`GetTimetableStatisticsResponse`**.";
|
|
1083
|
+
};
|
|
1084
|
+
readonly updateNotificationWayList: {
|
|
1085
|
+
readonly description: "`PUT .../{itemId}/notificationwaylist` — у **loyaltycards** в OpenAPI есть путь; у **loyaltysystems** нет — метод только на **`LoyaltyCards`**.";
|
|
1086
|
+
};
|
|
1087
|
+
readonly getImagePutUrl: {
|
|
1088
|
+
readonly description: "Presigned загрузка изображения карты (`GET .../image/puturl`).";
|
|
1089
|
+
};
|
|
1090
|
+
readonly getImageInfo: {
|
|
1091
|
+
readonly description: "Метаданные изображения карты (`GET .../image/info`).";
|
|
1092
|
+
};
|
|
1093
|
+
readonly getByUniqueName: {
|
|
1094
|
+
readonly description: "`GET .../uniquename/{uniqueName}` — без доп. query (в отличие от **cases**).";
|
|
1095
|
+
};
|
|
1096
|
+
readonly updatePublicity: {
|
|
1097
|
+
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1098
|
+
};
|
|
1099
|
+
readonly updateImageId: {
|
|
1100
|
+
readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
|
|
1101
|
+
};
|
|
1102
|
+
readonly updateTorrowAccountId: {
|
|
1103
|
+
readonly description: "`PUT .../{torrowId}/torrowaccount/id` — тело JSON-string id аккаунта.";
|
|
1104
|
+
};
|
|
1105
|
+
readonly updateMasterInfo: {
|
|
1106
|
+
readonly description: "`PUT .../{torrowId}/masterinfo` — **`UpdateMasterInfoReq`**.";
|
|
1107
|
+
};
|
|
1108
|
+
readonly updateIntegrations: {
|
|
1109
|
+
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1110
|
+
};
|
|
1111
|
+
readonly listParticipants: {
|
|
1112
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty*** в Swagger query **`lmFrom`/`lmTo`** (camelCase), у **contact/case** в типах SDK — **`lmfrom`/`lmto`**.";
|
|
1113
|
+
};
|
|
1114
|
+
readonly generateSecurityToken: {
|
|
1115
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1116
|
+
};
|
|
1117
|
+
readonly updateParticipationType: {
|
|
1118
|
+
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1119
|
+
};
|
|
1120
|
+
readonly requestAccess: {
|
|
1121
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`** (string); query **`userMessage`**.";
|
|
1122
|
+
};
|
|
1123
|
+
readonly revokeAccessRequest: {
|
|
1124
|
+
readonly description: "`PUT .../participation/revokerequest`.";
|
|
1125
|
+
};
|
|
1126
|
+
readonly setGroup: {
|
|
1127
|
+
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
1128
|
+
};
|
|
1129
|
+
readonly unsetGroup: {
|
|
1130
|
+
readonly description: "`PUT .../group/unset` — **`UnsetGroupItemReq`**.";
|
|
1131
|
+
};
|
|
1132
|
+
readonly updateTags: {
|
|
1133
|
+
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1134
|
+
};
|
|
1135
|
+
readonly listGroup: {
|
|
1136
|
+
readonly description: "`GET .../{torrowId}/group/list` — query как в OpenAPI (**`lmfrom`**, **`lmto`** lower-case и др.); у **loyaltycards** пути в API нет — в SDK вызов бросает (**`withGroupListEndpoint: false`**).";
|
|
1137
|
+
};
|
|
1138
|
+
readonly updateGroups: {
|
|
1139
|
+
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1140
|
+
};
|
|
1141
|
+
readonly includeToGroups: {
|
|
1142
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1143
|
+
};
|
|
1144
|
+
readonly excludeFromGroups: {
|
|
1145
|
+
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
1146
|
+
};
|
|
1147
|
+
readonly includeToParent: {
|
|
1148
|
+
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1149
|
+
};
|
|
1150
|
+
readonly excludeFromParent: {
|
|
1151
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — **`ExcludeReq`**.";
|
|
1152
|
+
};
|
|
1153
|
+
readonly includeForUser: {
|
|
1154
|
+
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1155
|
+
};
|
|
1156
|
+
readonly excludeFromUser: {
|
|
1157
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — **`ExcludeReq`**.";
|
|
1158
|
+
};
|
|
1159
|
+
readonly rejectOffer: {
|
|
1160
|
+
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1161
|
+
};
|
|
1162
|
+
readonly reject: {
|
|
1163
|
+
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1164
|
+
};
|
|
1165
|
+
readonly share: {
|
|
1166
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1167
|
+
};
|
|
1168
|
+
readonly revokeOffer: {
|
|
1169
|
+
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1170
|
+
};
|
|
1171
|
+
readonly grantAccess: {
|
|
1172
|
+
readonly description: "`PUT .../participation/grantaccess` — body: `string[]`.";
|
|
1173
|
+
};
|
|
1174
|
+
readonly declineAccess: {
|
|
1175
|
+
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1176
|
+
};
|
|
1177
|
+
readonly updatePersonalListOrder: {
|
|
1178
|
+
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
1179
|
+
};
|
|
1180
|
+
readonly updateAlias: {
|
|
1181
|
+
readonly description: "`PUT .../{itemId}/alias` — body: string (**alias**); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1182
|
+
};
|
|
1183
|
+
readonly updateLastUsageTime: {
|
|
1184
|
+
readonly description: "`PUT .../{itemId}/lastusagetime` — body: ISO date-time string.";
|
|
1185
|
+
};
|
|
1186
|
+
readonly updateParticipationProfile: {
|
|
1187
|
+
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1188
|
+
};
|
|
1189
|
+
readonly sendLink: {
|
|
1190
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1191
|
+
};
|
|
1192
|
+
readonly getShortUrl: {
|
|
1193
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string`.";
|
|
1194
|
+
};
|
|
1195
|
+
readonly updateUniqueName: {
|
|
1196
|
+
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
1197
|
+
};
|
|
1198
|
+
readonly saveToMindMap: {
|
|
1199
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1200
|
+
};
|
|
1201
|
+
readonly updateSolutionData: {
|
|
1202
|
+
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1203
|
+
};
|
|
1204
|
+
readonly updatePersonalSolutionData: {
|
|
1205
|
+
readonly description: "`PUT .../{itemId}/personalsolutiondata` — **`PersonalSolutionData`**.";
|
|
1206
|
+
};
|
|
1207
|
+
};
|
|
1208
|
+
declare const loyaltyCardsSdkMethodFieldDocs: {
|
|
1209
|
+
readonly update: string;
|
|
1210
|
+
readonly delete: string;
|
|
1211
|
+
readonly getById: string;
|
|
1212
|
+
readonly listPersonal: string;
|
|
1213
|
+
readonly deleteFromPersonalList: string;
|
|
1214
|
+
readonly createSubscription: string;
|
|
1215
|
+
readonly getParticipantsCount: string;
|
|
1216
|
+
readonly getBalance: string;
|
|
1217
|
+
readonly listTransactions: string;
|
|
1218
|
+
readonly getSubscriptionBalance: string;
|
|
1219
|
+
readonly getSubscriptionTransactions: string;
|
|
1220
|
+
readonly getTimetableStatistics: string;
|
|
1221
|
+
readonly updateNotificationWayList: string;
|
|
1222
|
+
readonly getImagePutUrl: string;
|
|
1223
|
+
readonly getImageInfo: string;
|
|
1224
|
+
readonly getByUniqueName: string;
|
|
1225
|
+
readonly updatePublicity: string;
|
|
1226
|
+
readonly updateImageId: string;
|
|
1227
|
+
readonly updateTorrowAccountId: string;
|
|
1228
|
+
readonly updateMasterInfo: string;
|
|
1229
|
+
readonly updateIntegrations: string;
|
|
1230
|
+
readonly listParticipants: string;
|
|
1231
|
+
readonly generateSecurityToken: string;
|
|
1232
|
+
readonly updateParticipationType: string;
|
|
1233
|
+
readonly requestAccess: string;
|
|
1234
|
+
readonly revokeAccessRequest: string;
|
|
1235
|
+
readonly setGroup: string;
|
|
1236
|
+
readonly unsetGroup: string;
|
|
1237
|
+
readonly updateTags: string;
|
|
1238
|
+
readonly listGroup: string;
|
|
1239
|
+
readonly updateGroups: string;
|
|
1240
|
+
readonly includeToGroups: string;
|
|
1241
|
+
readonly excludeFromGroups: string;
|
|
1242
|
+
readonly includeToParent: string;
|
|
1243
|
+
readonly excludeFromParent: string;
|
|
1244
|
+
readonly includeForUser: string;
|
|
1245
|
+
readonly excludeFromUser: string;
|
|
1246
|
+
readonly rejectOffer: string;
|
|
1247
|
+
readonly reject: string;
|
|
1248
|
+
readonly share: string;
|
|
1249
|
+
readonly revokeOffer: string;
|
|
1250
|
+
readonly grantAccess: string;
|
|
1251
|
+
readonly declineAccess: string;
|
|
1252
|
+
readonly updatePersonalListOrder: string;
|
|
1253
|
+
readonly updateAlias: string;
|
|
1254
|
+
readonly updateLastUsageTime: string;
|
|
1255
|
+
readonly updateParticipationProfile: string;
|
|
1256
|
+
readonly sendLink: string;
|
|
1257
|
+
readonly getShortUrl: string;
|
|
1258
|
+
readonly updateUniqueName: string;
|
|
1259
|
+
readonly saveToMindMap: string;
|
|
1260
|
+
readonly updateSolutionData: string;
|
|
1261
|
+
readonly updatePersonalSolutionData: string;
|
|
1262
|
+
};
|
|
1263
|
+
declare const userSettingsSdkMethodFieldDocEntries: {
|
|
1264
|
+
readonly get: {
|
|
1265
|
+
readonly description: "`GET /api/v1/user/settings` — прочитать `UserSettingsInfo` текущего пользователя.";
|
|
1266
|
+
};
|
|
1267
|
+
readonly update: {
|
|
1268
|
+
readonly description: "`PUT /api/v1/user/settings/update` — сохранить `UserSettingsInfo` и получить `TorrowObject`.";
|
|
1269
|
+
};
|
|
1270
|
+
};
|
|
1271
|
+
declare const userSettingsSdkMethodFieldDocs: {
|
|
1272
|
+
readonly get: string;
|
|
1273
|
+
readonly update: string;
|
|
1274
|
+
};
|
|
1275
|
+
declare const userSdkMethodFieldDocEntries: {
|
|
1276
|
+
readonly getLoyaltyCard: {
|
|
1277
|
+
readonly description: "`GET /api/v1/user/loyaltycard` — карта лояльности текущего пользователя.";
|
|
1278
|
+
};
|
|
1279
|
+
readonly listAccounts: {
|
|
1280
|
+
readonly description: "`GET /api/v1/user/accounts` — список аккаунтов пользователя.";
|
|
1281
|
+
};
|
|
1282
|
+
readonly initAddAccount: {
|
|
1283
|
+
readonly description: "`POST /api/v1/user/accounts/add/init` — старт подтверждения добавления аккаунта.";
|
|
1284
|
+
};
|
|
1285
|
+
readonly completeAddAccount: {
|
|
1286
|
+
readonly description: "`POST /api/v1/user/accounts/add/complete` — завершение добавления аккаунта по коду.";
|
|
1287
|
+
};
|
|
1288
|
+
readonly deleteAccount: {
|
|
1289
|
+
readonly description: "`DELETE /api/v1/user/accounts/delete` — удаление аккаунта пользователя.";
|
|
1290
|
+
};
|
|
1291
|
+
readonly listDevices: {
|
|
1292
|
+
readonly description: "`GET /api/v1/user/devices` — список устройств (`DeviceInfo[]`).";
|
|
1293
|
+
};
|
|
1294
|
+
readonly deleteDevice: {
|
|
1295
|
+
readonly description: "`DELETE /api/v1/user/devices/{deviceId}` — удалить устройство.";
|
|
1296
|
+
};
|
|
1297
|
+
readonly getDeviceSettings: {
|
|
1298
|
+
readonly description: "`GET /api/v1/user/devices/{deviceId}/settings` — читать настройки устройства.";
|
|
1299
|
+
};
|
|
1300
|
+
readonly updateDeviceSettings: {
|
|
1301
|
+
readonly description: "`PUT /api/v1/user/devices/{deviceId}/settings` — сохранить строку настроек.";
|
|
1302
|
+
};
|
|
1303
|
+
readonly getDefaultProfile: {
|
|
1304
|
+
readonly description: "`GET /api/v1/user/defaultprofile` — дефолтный профиль пользователя.";
|
|
1305
|
+
};
|
|
1306
|
+
readonly setDefaultProfileByContactId: {
|
|
1307
|
+
readonly description: "`PUT /api/v1/user/defaultprofile` — выбрать дефолтный профиль по contactId.";
|
|
1308
|
+
};
|
|
1309
|
+
readonly createDefaultProfile: {
|
|
1310
|
+
readonly description: "`POST /api/v1/user/defaultprofile` — создать и назначить дефолтный профиль.";
|
|
1311
|
+
};
|
|
1312
|
+
readonly listDeliveryWays: {
|
|
1313
|
+
readonly description: "`GET /api/v1/user/deliveryways` — пользовательские способы доставки.";
|
|
1314
|
+
};
|
|
1315
|
+
readonly listDefaultNotificationWays: {
|
|
1316
|
+
readonly description: "`GET /api/v1/user/defaultnotificationways` — дефолтные notification rules.";
|
|
1317
|
+
};
|
|
1318
|
+
readonly updateDefaultNotificationWays: {
|
|
1319
|
+
readonly description: "`PUT /api/v1/user/defaultnotificationways` — обновить notification rules.";
|
|
1320
|
+
};
|
|
1321
|
+
readonly updatePlace: {
|
|
1322
|
+
readonly description: "`PUT /api/v1/user/place` — обновить place для профиля/пользователя.";
|
|
1323
|
+
};
|
|
1324
|
+
readonly register: {
|
|
1325
|
+
readonly description: "`POST /api/v1/user/register` — регистрация пользователя в аккаунте.";
|
|
1326
|
+
};
|
|
1327
|
+
readonly getTimetable: {
|
|
1328
|
+
readonly description: "`PUT /api/v1/user/timetable` — расписание текущего пользователя.";
|
|
1329
|
+
};
|
|
1330
|
+
readonly listCalendars: {
|
|
1331
|
+
readonly description: "`GET /api/v1/user/calendars` — подключенные календари.";
|
|
1332
|
+
};
|
|
1333
|
+
readonly updateCalendars: {
|
|
1334
|
+
readonly description: "`PUT /api/v1/user/calendars/update` — сохранить календари пользователя.";
|
|
1335
|
+
};
|
|
1336
|
+
readonly initDelete: {
|
|
1337
|
+
readonly description: "`DELETE /api/v1/user/delete/init` — старт удаления пользователя (session).";
|
|
1338
|
+
};
|
|
1339
|
+
readonly completeDelete: {
|
|
1340
|
+
readonly description: "`DELETE /api/v1/user/delete/complete` — завершить удаление по коду.";
|
|
1341
|
+
};
|
|
1342
|
+
readonly count: {
|
|
1343
|
+
readonly description: "`GET /api/v1/user/count` — число пользователей (админ/статистика).";
|
|
1344
|
+
};
|
|
1345
|
+
};
|
|
1346
|
+
declare const userSdkMethodFieldDocs: {
|
|
1347
|
+
readonly getLoyaltyCard: string;
|
|
1348
|
+
readonly listAccounts: string;
|
|
1349
|
+
readonly initAddAccount: string;
|
|
1350
|
+
readonly completeAddAccount: string;
|
|
1351
|
+
readonly deleteAccount: string;
|
|
1352
|
+
readonly listDevices: string;
|
|
1353
|
+
readonly deleteDevice: string;
|
|
1354
|
+
readonly getDeviceSettings: string;
|
|
1355
|
+
readonly updateDeviceSettings: string;
|
|
1356
|
+
readonly getDefaultProfile: string;
|
|
1357
|
+
readonly setDefaultProfileByContactId: string;
|
|
1358
|
+
readonly createDefaultProfile: string;
|
|
1359
|
+
readonly listDeliveryWays: string;
|
|
1360
|
+
readonly listDefaultNotificationWays: string;
|
|
1361
|
+
readonly updateDefaultNotificationWays: string;
|
|
1362
|
+
readonly updatePlace: string;
|
|
1363
|
+
readonly register: string;
|
|
1364
|
+
readonly getTimetable: string;
|
|
1365
|
+
readonly listCalendars: string;
|
|
1366
|
+
readonly updateCalendars: string;
|
|
1367
|
+
readonly initDelete: string;
|
|
1368
|
+
readonly completeDelete: string;
|
|
1369
|
+
readonly count: string;
|
|
1370
|
+
};
|
|
1371
|
+
|
|
1372
|
+
/** Методы Core, общие для loyalty-доменов (без photo-endpoints). */
|
|
1373
|
+
declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
|
|
1374
|
+
readonly updatePublicity: {
|
|
1375
|
+
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1376
|
+
};
|
|
1377
|
+
readonly updateImageId: {
|
|
1378
|
+
readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
|
|
1379
|
+
};
|
|
1380
|
+
readonly updateTorrowAccountId: {
|
|
1381
|
+
readonly description: "`PUT .../{torrowId}/torrowaccount/id` — тело JSON-string id аккаунта.";
|
|
1382
|
+
};
|
|
1383
|
+
readonly updateMasterInfo: {
|
|
1384
|
+
readonly description: "`PUT .../{torrowId}/masterinfo` — **`UpdateMasterInfoReq`**.";
|
|
1385
|
+
};
|
|
1386
|
+
readonly updateIntegrations: {
|
|
1387
|
+
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1388
|
+
};
|
|
1389
|
+
readonly listParticipants: {
|
|
1390
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty*** в Swagger query **`lmFrom`/`lmTo`** (camelCase), у **contact/case** в типах SDK — **`lmfrom`/`lmto`**.";
|
|
1391
|
+
};
|
|
1392
|
+
readonly generateSecurityToken: {
|
|
1393
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1394
|
+
};
|
|
1395
|
+
readonly updateParticipationType: {
|
|
1396
|
+
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1397
|
+
};
|
|
1398
|
+
readonly requestAccess: {
|
|
1399
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`** (string); query **`userMessage`**.";
|
|
1400
|
+
};
|
|
1401
|
+
readonly revokeAccessRequest: {
|
|
1402
|
+
readonly description: "`PUT .../participation/revokerequest`.";
|
|
1403
|
+
};
|
|
1404
|
+
readonly setGroup: {
|
|
1405
|
+
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
1406
|
+
};
|
|
1407
|
+
readonly unsetGroup: {
|
|
1408
|
+
readonly description: "`PUT .../group/unset` — **`UnsetGroupItemReq`**.";
|
|
1409
|
+
};
|
|
1410
|
+
readonly updateTags: {
|
|
1411
|
+
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1412
|
+
};
|
|
1413
|
+
readonly listGroup: {
|
|
1414
|
+
readonly description: "`GET .../{torrowId}/group/list` — query как в OpenAPI (**`lmfrom`**, **`lmto`** lower-case и др.); у **loyaltycards** пути в API нет — в SDK вызов бросает (**`withGroupListEndpoint: false`**).";
|
|
1415
|
+
};
|
|
1416
|
+
readonly updateGroups: {
|
|
1417
|
+
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1418
|
+
};
|
|
1419
|
+
readonly includeToGroups: {
|
|
1420
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1421
|
+
};
|
|
1422
|
+
readonly excludeFromGroups: {
|
|
1423
|
+
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
1424
|
+
};
|
|
1425
|
+
readonly includeToParent: {
|
|
1426
|
+
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1427
|
+
};
|
|
1428
|
+
readonly excludeFromParent: {
|
|
1429
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — **`ExcludeReq`**.";
|
|
1430
|
+
};
|
|
1431
|
+
readonly includeForUser: {
|
|
1432
|
+
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1433
|
+
};
|
|
1434
|
+
readonly excludeFromUser: {
|
|
1435
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — **`ExcludeReq`**.";
|
|
1436
|
+
};
|
|
1437
|
+
readonly rejectOffer: {
|
|
1438
|
+
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1439
|
+
};
|
|
1440
|
+
readonly reject: {
|
|
1441
|
+
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1442
|
+
};
|
|
1443
|
+
readonly share: {
|
|
1444
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1445
|
+
};
|
|
1446
|
+
readonly revokeOffer: {
|
|
1447
|
+
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1448
|
+
};
|
|
1449
|
+
readonly grantAccess: {
|
|
1450
|
+
readonly description: "`PUT .../participation/grantaccess` — body: `string[]`.";
|
|
1451
|
+
};
|
|
1452
|
+
readonly declineAccess: {
|
|
1453
|
+
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1454
|
+
};
|
|
1455
|
+
readonly updatePersonalListOrder: {
|
|
1456
|
+
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
1457
|
+
};
|
|
1458
|
+
readonly updateAlias: {
|
|
1459
|
+
readonly description: "`PUT .../{itemId}/alias` — body: string (**alias**); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1460
|
+
};
|
|
1461
|
+
readonly updateLastUsageTime: {
|
|
1462
|
+
readonly description: "`PUT .../{itemId}/lastusagetime` — body: ISO date-time string.";
|
|
1463
|
+
};
|
|
1464
|
+
readonly updateParticipationProfile: {
|
|
1465
|
+
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1466
|
+
};
|
|
1467
|
+
readonly sendLink: {
|
|
1468
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1469
|
+
};
|
|
1470
|
+
readonly getShortUrl: {
|
|
1471
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string`.";
|
|
1472
|
+
};
|
|
1473
|
+
readonly updateUniqueName: {
|
|
1474
|
+
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
1475
|
+
};
|
|
1476
|
+
readonly getByUniqueName: {
|
|
1477
|
+
readonly description: "`GET .../uniquename/{uniqueName}` — у **cases** доп. query **`profileId`** (override); иначе только **`signal`**.";
|
|
1478
|
+
};
|
|
1479
|
+
readonly getImageInfo: {
|
|
1480
|
+
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1481
|
+
};
|
|
1482
|
+
readonly getImagePutUrl: {
|
|
1483
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; query **`fileId`**, **`fileName`**, **`fileSize`**.";
|
|
1484
|
+
};
|
|
1485
|
+
readonly saveToMindMap: {
|
|
1486
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1487
|
+
};
|
|
1488
|
+
readonly updateSolutionData: {
|
|
1489
|
+
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1490
|
+
};
|
|
1491
|
+
readonly updatePersonalSolutionData: {
|
|
1492
|
+
readonly description: "`PUT .../{itemId}/personalsolutiondata` — **`PersonalSolutionData`**.";
|
|
1493
|
+
};
|
|
1494
|
+
};
|
|
1495
|
+
/** Только **contacts** (`TorrowItemFacadeOptions.withPhotoEndpoints`). */
|
|
1496
|
+
declare const torrowItemFacadePhotoEndpointSdkMethodFieldDocEntries: {
|
|
1497
|
+
readonly getPhotoInfo: {
|
|
1498
|
+
readonly description: "`GET .../{torrowId}/photo/info` — **`FileInfo`**; только при **`withPhotoEndpoints`** (сейчас **contacts**), иначе SDK бросает ошибку.";
|
|
1499
|
+
};
|
|
1500
|
+
readonly getPhotoPutUrl: {
|
|
1501
|
+
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; только при **`withPhotoEndpoints`** (сейчас **contacts**).";
|
|
1502
|
+
};
|
|
1503
|
+
};
|
|
1504
|
+
/**
|
|
1505
|
+
* Методы только **`TorrowItemFacade`** (нет у **loyalty*** на **`TorrowItemCoreFacade`**).
|
|
1506
|
+
* Домены: **contacts**, **cases**, **services**, **notes**, **calendars**, **contexts**, **resourceItems** — общий HTTP-слой совпадает; доменные CRUD/сценарии описываются отдельно (booking, payment, search, …).
|
|
1507
|
+
*/
|
|
1508
|
+
declare const torrowItemFacadeExtensionSdkMethodFieldDocEntries: {
|
|
1509
|
+
readonly updateFeedbackOptions: {
|
|
1510
|
+
readonly description: "`PUT .../{torrowId}/feedbacks/options` — **`FeedbackOptions`**.";
|
|
1511
|
+
};
|
|
1512
|
+
readonly getParticipantsAnonymousCount: {
|
|
1513
|
+
readonly description: "`GET .../{torrowId}/participants/anonymous` → **`GetParticipationCountResp`**.";
|
|
1514
|
+
};
|
|
1515
|
+
readonly getParticipantsNonAnonymousCount: {
|
|
1516
|
+
readonly description: "`GET .../{torrowId}/participants/nonanonymous` — query **`participantStateList`**, **`participantTypeList`**.";
|
|
1517
|
+
};
|
|
1518
|
+
readonly listTags: {
|
|
1519
|
+
readonly description: "`GET .../{torrowId}/tags` — фильтры **`ItemTagsListQuery`** → `string[]`.";
|
|
1520
|
+
};
|
|
1521
|
+
readonly listGroups: {
|
|
1522
|
+
readonly description: "`GET .../{torrowId}/groups` — **`GroupStatus[]`**; query как в OpenAPI.";
|
|
1523
|
+
};
|
|
1524
|
+
readonly updateAccounts: {
|
|
1525
|
+
readonly description: "`PUT .../{torrowId}/updateaccounts` — **`UpdateItemAccountsReq[]`** → **`IncludeExcludeResp`**.";
|
|
1526
|
+
};
|
|
1527
|
+
readonly shareItemLink: {
|
|
1528
|
+
readonly description: "`POST .../{torrowId}/participation/shareitemlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1529
|
+
};
|
|
1530
|
+
readonly updateOfflinable: {
|
|
1531
|
+
readonly description: "`PUT .../{itemId}/offlinable` — body: boolean.";
|
|
1532
|
+
};
|
|
1533
|
+
readonly updateReminders: {
|
|
1534
|
+
readonly description: "`PUT .../{itemId}/reminders` — **`PersonalReminder[]`**.";
|
|
1535
|
+
};
|
|
1536
|
+
readonly updateNotificationWayList: {
|
|
1537
|
+
readonly description: "`PUT .../{itemId}/notificationwaylist` — **`NotificationWay[]`** (у **loyaltycards** тот же путь, но класс не от **Base** — см. **`LoyaltyCardsSdkMethods`**).";
|
|
1538
|
+
};
|
|
1539
|
+
readonly block: {
|
|
1540
|
+
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**.";
|
|
1541
|
+
};
|
|
1542
|
+
readonly unblock: {
|
|
1543
|
+
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1544
|
+
};
|
|
1545
|
+
};
|
|
1546
|
+
/** Полный общий слой **`TorrowItemFacade`** без photo-endpoints (`GET .../participants` — **`lmfrom`/`lmto`**). */
|
|
1547
|
+
declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
1548
|
+
readonly updateFeedbackOptions: {
|
|
1549
|
+
readonly description: "`PUT .../{torrowId}/feedbacks/options` — **`FeedbackOptions`**.";
|
|
1550
|
+
};
|
|
1551
|
+
readonly getParticipantsAnonymousCount: {
|
|
1552
|
+
readonly description: "`GET .../{torrowId}/participants/anonymous` → **`GetParticipationCountResp`**.";
|
|
1553
|
+
};
|
|
1554
|
+
readonly getParticipantsNonAnonymousCount: {
|
|
1555
|
+
readonly description: "`GET .../{torrowId}/participants/nonanonymous` — query **`participantStateList`**, **`participantTypeList`**.";
|
|
1556
|
+
};
|
|
1557
|
+
readonly listTags: {
|
|
1558
|
+
readonly description: "`GET .../{torrowId}/tags` — фильтры **`ItemTagsListQuery`** → `string[]`.";
|
|
1559
|
+
};
|
|
1560
|
+
readonly listGroups: {
|
|
1561
|
+
readonly description: "`GET .../{torrowId}/groups` — **`GroupStatus[]`**; query как в OpenAPI.";
|
|
1562
|
+
};
|
|
1563
|
+
readonly updateAccounts: {
|
|
1564
|
+
readonly description: "`PUT .../{torrowId}/updateaccounts` — **`UpdateItemAccountsReq[]`** → **`IncludeExcludeResp`**.";
|
|
1565
|
+
};
|
|
1566
|
+
readonly shareItemLink: {
|
|
1567
|
+
readonly description: "`POST .../{torrowId}/participation/shareitemlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1568
|
+
};
|
|
1569
|
+
readonly updateOfflinable: {
|
|
1570
|
+
readonly description: "`PUT .../{itemId}/offlinable` — body: boolean.";
|
|
1571
|
+
};
|
|
1572
|
+
readonly updateReminders: {
|
|
1573
|
+
readonly description: "`PUT .../{itemId}/reminders` — **`PersonalReminder[]`**.";
|
|
1574
|
+
};
|
|
1575
|
+
readonly updateNotificationWayList: {
|
|
1576
|
+
readonly description: "`PUT .../{itemId}/notificationwaylist` — **`NotificationWay[]`** (у **loyaltycards** тот же путь, но класс не от **Base** — см. **`LoyaltyCardsSdkMethods`**).";
|
|
1577
|
+
};
|
|
1578
|
+
readonly block: {
|
|
1579
|
+
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**.";
|
|
1580
|
+
};
|
|
1581
|
+
readonly unblock: {
|
|
1582
|
+
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1583
|
+
};
|
|
1584
|
+
readonly updatePublicity: {
|
|
1585
|
+
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1586
|
+
};
|
|
1587
|
+
readonly updateImageId: {
|
|
1588
|
+
readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
|
|
1589
|
+
};
|
|
1590
|
+
readonly updateTorrowAccountId: {
|
|
1591
|
+
readonly description: "`PUT .../{torrowId}/torrowaccount/id` — тело JSON-string id аккаунта.";
|
|
1592
|
+
};
|
|
1593
|
+
readonly updateMasterInfo: {
|
|
1594
|
+
readonly description: "`PUT .../{torrowId}/masterinfo` — **`UpdateMasterInfoReq`**.";
|
|
1595
|
+
};
|
|
1596
|
+
readonly updateIntegrations: {
|
|
1597
|
+
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1598
|
+
};
|
|
1599
|
+
readonly listParticipants: {
|
|
1600
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty*** в Swagger query **`lmFrom`/`lmTo`** (camelCase), у **contact/case** в типах SDK — **`lmfrom`/`lmto`**.";
|
|
1601
|
+
};
|
|
1602
|
+
readonly generateSecurityToken: {
|
|
1603
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1604
|
+
};
|
|
1605
|
+
readonly updateParticipationType: {
|
|
1606
|
+
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1607
|
+
};
|
|
1608
|
+
readonly requestAccess: {
|
|
1609
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`** (string); query **`userMessage`**.";
|
|
1610
|
+
};
|
|
1611
|
+
readonly revokeAccessRequest: {
|
|
1612
|
+
readonly description: "`PUT .../participation/revokerequest`.";
|
|
1613
|
+
};
|
|
1614
|
+
readonly setGroup: {
|
|
1615
|
+
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
1616
|
+
};
|
|
1617
|
+
readonly unsetGroup: {
|
|
1618
|
+
readonly description: "`PUT .../group/unset` — **`UnsetGroupItemReq`**.";
|
|
1619
|
+
};
|
|
1620
|
+
readonly updateTags: {
|
|
1621
|
+
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1622
|
+
};
|
|
1623
|
+
readonly listGroup: {
|
|
1624
|
+
readonly description: "`GET .../{torrowId}/group/list` — query как в OpenAPI (**`lmfrom`**, **`lmto`** lower-case и др.); у **loyaltycards** пути в API нет — в SDK вызов бросает (**`withGroupListEndpoint: false`**).";
|
|
1625
|
+
};
|
|
1626
|
+
readonly updateGroups: {
|
|
1627
|
+
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1628
|
+
};
|
|
1629
|
+
readonly includeToGroups: {
|
|
1630
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1631
|
+
};
|
|
1632
|
+
readonly excludeFromGroups: {
|
|
1633
|
+
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
1634
|
+
};
|
|
1635
|
+
readonly includeToParent: {
|
|
1636
|
+
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1637
|
+
};
|
|
1638
|
+
readonly excludeFromParent: {
|
|
1639
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — **`ExcludeReq`**.";
|
|
1640
|
+
};
|
|
1641
|
+
readonly includeForUser: {
|
|
1642
|
+
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1643
|
+
};
|
|
1644
|
+
readonly excludeFromUser: {
|
|
1645
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — **`ExcludeReq`**.";
|
|
1646
|
+
};
|
|
1647
|
+
readonly rejectOffer: {
|
|
1648
|
+
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1649
|
+
};
|
|
1650
|
+
readonly reject: {
|
|
1651
|
+
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1652
|
+
};
|
|
1653
|
+
readonly share: {
|
|
1654
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1655
|
+
};
|
|
1656
|
+
readonly revokeOffer: {
|
|
1657
|
+
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1658
|
+
};
|
|
1659
|
+
readonly grantAccess: {
|
|
1660
|
+
readonly description: "`PUT .../participation/grantaccess` — body: `string[]`.";
|
|
1661
|
+
};
|
|
1662
|
+
readonly declineAccess: {
|
|
1663
|
+
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1664
|
+
};
|
|
1665
|
+
readonly updatePersonalListOrder: {
|
|
1666
|
+
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
1667
|
+
};
|
|
1668
|
+
readonly updateAlias: {
|
|
1669
|
+
readonly description: "`PUT .../{itemId}/alias` — body: string (**alias**); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1670
|
+
};
|
|
1671
|
+
readonly updateLastUsageTime: {
|
|
1672
|
+
readonly description: "`PUT .../{itemId}/lastusagetime` — body: ISO date-time string.";
|
|
1673
|
+
};
|
|
1674
|
+
readonly updateParticipationProfile: {
|
|
1675
|
+
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1676
|
+
};
|
|
1677
|
+
readonly sendLink: {
|
|
1678
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1679
|
+
};
|
|
1680
|
+
readonly getShortUrl: {
|
|
1681
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string`.";
|
|
1682
|
+
};
|
|
1683
|
+
readonly updateUniqueName: {
|
|
1684
|
+
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
1685
|
+
};
|
|
1686
|
+
readonly getByUniqueName: {
|
|
1687
|
+
readonly description: "`GET .../uniquename/{uniqueName}` — у **cases** доп. query **`profileId`** (override); иначе только **`signal`**.";
|
|
1688
|
+
};
|
|
1689
|
+
readonly getImageInfo: {
|
|
1690
|
+
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1691
|
+
};
|
|
1692
|
+
readonly getImagePutUrl: {
|
|
1693
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; query **`fileId`**, **`fileName`**, **`fileSize`**.";
|
|
1694
|
+
};
|
|
1695
|
+
readonly saveToMindMap: {
|
|
1696
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1697
|
+
};
|
|
1698
|
+
readonly updateSolutionData: {
|
|
1699
|
+
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1700
|
+
};
|
|
1701
|
+
readonly updatePersonalSolutionData: {
|
|
1702
|
+
readonly description: "`PUT .../{itemId}/personalsolutiondata` — **`PersonalSolutionData`**.";
|
|
1703
|
+
};
|
|
1704
|
+
};
|
|
1705
|
+
/** То же + **`getPhotoInfo`/`getPhotoPutUrl`** — как у **`client.contacts`** (`withPhotoEndpoints`). */
|
|
1706
|
+
declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
1707
|
+
readonly getPhotoInfo: {
|
|
1708
|
+
readonly description: "`GET .../{torrowId}/photo/info` — **`FileInfo`**; только при **`withPhotoEndpoints`** (сейчас **contacts**), иначе SDK бросает ошибку.";
|
|
1709
|
+
};
|
|
1710
|
+
readonly getPhotoPutUrl: {
|
|
1711
|
+
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; только при **`withPhotoEndpoints`** (сейчас **contacts**).";
|
|
1712
|
+
};
|
|
1713
|
+
readonly updateFeedbackOptions: {
|
|
1714
|
+
readonly description: "`PUT .../{torrowId}/feedbacks/options` — **`FeedbackOptions`**.";
|
|
1715
|
+
};
|
|
1716
|
+
readonly getParticipantsAnonymousCount: {
|
|
1717
|
+
readonly description: "`GET .../{torrowId}/participants/anonymous` → **`GetParticipationCountResp`**.";
|
|
1718
|
+
};
|
|
1719
|
+
readonly getParticipantsNonAnonymousCount: {
|
|
1720
|
+
readonly description: "`GET .../{torrowId}/participants/nonanonymous` — query **`participantStateList`**, **`participantTypeList`**.";
|
|
1721
|
+
};
|
|
1722
|
+
readonly listTags: {
|
|
1723
|
+
readonly description: "`GET .../{torrowId}/tags` — фильтры **`ItemTagsListQuery`** → `string[]`.";
|
|
1724
|
+
};
|
|
1725
|
+
readonly listGroups: {
|
|
1726
|
+
readonly description: "`GET .../{torrowId}/groups` — **`GroupStatus[]`**; query как в OpenAPI.";
|
|
1727
|
+
};
|
|
1728
|
+
readonly updateAccounts: {
|
|
1729
|
+
readonly description: "`PUT .../{torrowId}/updateaccounts` — **`UpdateItemAccountsReq[]`** → **`IncludeExcludeResp`**.";
|
|
1730
|
+
};
|
|
1731
|
+
readonly shareItemLink: {
|
|
1732
|
+
readonly description: "`POST .../{torrowId}/participation/shareitemlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1733
|
+
};
|
|
1734
|
+
readonly updateOfflinable: {
|
|
1735
|
+
readonly description: "`PUT .../{itemId}/offlinable` — body: boolean.";
|
|
1736
|
+
};
|
|
1737
|
+
readonly updateReminders: {
|
|
1738
|
+
readonly description: "`PUT .../{itemId}/reminders` — **`PersonalReminder[]`**.";
|
|
1739
|
+
};
|
|
1740
|
+
readonly updateNotificationWayList: {
|
|
1741
|
+
readonly description: "`PUT .../{itemId}/notificationwaylist` — **`NotificationWay[]`** (у **loyaltycards** тот же путь, но класс не от **Base** — см. **`LoyaltyCardsSdkMethods`**).";
|
|
1742
|
+
};
|
|
1743
|
+
readonly block: {
|
|
1744
|
+
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**.";
|
|
1745
|
+
};
|
|
1746
|
+
readonly unblock: {
|
|
1747
|
+
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1748
|
+
};
|
|
1749
|
+
readonly updatePublicity: {
|
|
1750
|
+
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1751
|
+
};
|
|
1752
|
+
readonly updateImageId: {
|
|
1753
|
+
readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
|
|
1754
|
+
};
|
|
1755
|
+
readonly updateTorrowAccountId: {
|
|
1756
|
+
readonly description: "`PUT .../{torrowId}/torrowaccount/id` — тело JSON-string id аккаунта.";
|
|
1757
|
+
};
|
|
1758
|
+
readonly updateMasterInfo: {
|
|
1759
|
+
readonly description: "`PUT .../{torrowId}/masterinfo` — **`UpdateMasterInfoReq`**.";
|
|
1760
|
+
};
|
|
1761
|
+
readonly updateIntegrations: {
|
|
1762
|
+
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1763
|
+
};
|
|
1764
|
+
readonly listParticipants: {
|
|
1765
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty*** в Swagger query **`lmFrom`/`lmTo`** (camelCase), у **contact/case** в типах SDK — **`lmfrom`/`lmto`**.";
|
|
1766
|
+
};
|
|
1767
|
+
readonly generateSecurityToken: {
|
|
1768
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1769
|
+
};
|
|
1770
|
+
readonly updateParticipationType: {
|
|
1771
|
+
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1772
|
+
};
|
|
1773
|
+
readonly requestAccess: {
|
|
1774
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`** (string); query **`userMessage`**.";
|
|
1775
|
+
};
|
|
1776
|
+
readonly revokeAccessRequest: {
|
|
1777
|
+
readonly description: "`PUT .../participation/revokerequest`.";
|
|
1778
|
+
};
|
|
1779
|
+
readonly setGroup: {
|
|
1780
|
+
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
1781
|
+
};
|
|
1782
|
+
readonly unsetGroup: {
|
|
1783
|
+
readonly description: "`PUT .../group/unset` — **`UnsetGroupItemReq`**.";
|
|
1784
|
+
};
|
|
1785
|
+
readonly updateTags: {
|
|
1786
|
+
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1787
|
+
};
|
|
1788
|
+
readonly listGroup: {
|
|
1789
|
+
readonly description: "`GET .../{torrowId}/group/list` — query как в OpenAPI (**`lmfrom`**, **`lmto`** lower-case и др.); у **loyaltycards** пути в API нет — в SDK вызов бросает (**`withGroupListEndpoint: false`**).";
|
|
1790
|
+
};
|
|
1791
|
+
readonly updateGroups: {
|
|
1792
|
+
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1793
|
+
};
|
|
1794
|
+
readonly includeToGroups: {
|
|
1795
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1796
|
+
};
|
|
1797
|
+
readonly excludeFromGroups: {
|
|
1798
|
+
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
1799
|
+
};
|
|
1800
|
+
readonly includeToParent: {
|
|
1801
|
+
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1802
|
+
};
|
|
1803
|
+
readonly excludeFromParent: {
|
|
1804
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — **`ExcludeReq`**.";
|
|
1805
|
+
};
|
|
1806
|
+
readonly includeForUser: {
|
|
1807
|
+
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1808
|
+
};
|
|
1809
|
+
readonly excludeFromUser: {
|
|
1810
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — **`ExcludeReq`**.";
|
|
1811
|
+
};
|
|
1812
|
+
readonly rejectOffer: {
|
|
1813
|
+
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1814
|
+
};
|
|
1815
|
+
readonly reject: {
|
|
1816
|
+
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1817
|
+
};
|
|
1818
|
+
readonly share: {
|
|
1819
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1820
|
+
};
|
|
1821
|
+
readonly revokeOffer: {
|
|
1822
|
+
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1823
|
+
};
|
|
1824
|
+
readonly grantAccess: {
|
|
1825
|
+
readonly description: "`PUT .../participation/grantaccess` — body: `string[]`.";
|
|
1826
|
+
};
|
|
1827
|
+
readonly declineAccess: {
|
|
1828
|
+
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1829
|
+
};
|
|
1830
|
+
readonly updatePersonalListOrder: {
|
|
1831
|
+
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
1832
|
+
};
|
|
1833
|
+
readonly updateAlias: {
|
|
1834
|
+
readonly description: "`PUT .../{itemId}/alias` — body: string (**alias**); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1835
|
+
};
|
|
1836
|
+
readonly updateLastUsageTime: {
|
|
1837
|
+
readonly description: "`PUT .../{itemId}/lastusagetime` — body: ISO date-time string.";
|
|
1838
|
+
};
|
|
1839
|
+
readonly updateParticipationProfile: {
|
|
1840
|
+
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1841
|
+
};
|
|
1842
|
+
readonly sendLink: {
|
|
1843
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1844
|
+
};
|
|
1845
|
+
readonly getShortUrl: {
|
|
1846
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string`.";
|
|
1847
|
+
};
|
|
1848
|
+
readonly updateUniqueName: {
|
|
1849
|
+
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
1850
|
+
};
|
|
1851
|
+
readonly getByUniqueName: {
|
|
1852
|
+
readonly description: "`GET .../uniquename/{uniqueName}` — у **cases** доп. query **`profileId`** (override); иначе только **`signal`**.";
|
|
1853
|
+
};
|
|
1854
|
+
readonly getImageInfo: {
|
|
1855
|
+
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1856
|
+
};
|
|
1857
|
+
readonly getImagePutUrl: {
|
|
1858
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; query **`fileId`**, **`fileName`**, **`fileSize`**.";
|
|
1859
|
+
};
|
|
1860
|
+
readonly saveToMindMap: {
|
|
1861
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1862
|
+
};
|
|
1863
|
+
readonly updateSolutionData: {
|
|
1864
|
+
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1865
|
+
};
|
|
1866
|
+
readonly updatePersonalSolutionData: {
|
|
1867
|
+
readonly description: "`PUT .../{itemId}/personalsolutiondata` — **`PersonalSolutionData`**.";
|
|
1868
|
+
};
|
|
1869
|
+
};
|
|
1870
|
+
/** Полный набор методов Core для каталога **`TorrowItemCoreFacadeSdkMethods`** (включая photo). */
|
|
1871
|
+
declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
|
|
1872
|
+
readonly getPhotoInfo: {
|
|
1873
|
+
readonly description: "`GET .../{torrowId}/photo/info` — **`FileInfo`**; только при **`withPhotoEndpoints`** (сейчас **contacts**), иначе SDK бросает ошибку.";
|
|
1874
|
+
};
|
|
1875
|
+
readonly getPhotoPutUrl: {
|
|
1876
|
+
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; только при **`withPhotoEndpoints`** (сейчас **contacts**).";
|
|
1877
|
+
};
|
|
1878
|
+
readonly updatePublicity: {
|
|
1879
|
+
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1880
|
+
};
|
|
1881
|
+
readonly updateImageId: {
|
|
1882
|
+
readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
|
|
1883
|
+
};
|
|
1884
|
+
readonly updateTorrowAccountId: {
|
|
1885
|
+
readonly description: "`PUT .../{torrowId}/torrowaccount/id` — тело JSON-string id аккаунта.";
|
|
1886
|
+
};
|
|
1887
|
+
readonly updateMasterInfo: {
|
|
1888
|
+
readonly description: "`PUT .../{torrowId}/masterinfo` — **`UpdateMasterInfoReq`**.";
|
|
1889
|
+
};
|
|
1890
|
+
readonly updateIntegrations: {
|
|
1891
|
+
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1892
|
+
};
|
|
1893
|
+
readonly listParticipants: {
|
|
1894
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty*** в Swagger query **`lmFrom`/`lmTo`** (camelCase), у **contact/case** в типах SDK — **`lmfrom`/`lmto`**.";
|
|
1895
|
+
};
|
|
1896
|
+
readonly generateSecurityToken: {
|
|
1897
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1898
|
+
};
|
|
1899
|
+
readonly updateParticipationType: {
|
|
1900
|
+
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1901
|
+
};
|
|
1902
|
+
readonly requestAccess: {
|
|
1903
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`** (string); query **`userMessage`**.";
|
|
1904
|
+
};
|
|
1905
|
+
readonly revokeAccessRequest: {
|
|
1906
|
+
readonly description: "`PUT .../participation/revokerequest`.";
|
|
1907
|
+
};
|
|
1908
|
+
readonly setGroup: {
|
|
1909
|
+
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
1910
|
+
};
|
|
1911
|
+
readonly unsetGroup: {
|
|
1912
|
+
readonly description: "`PUT .../group/unset` — **`UnsetGroupItemReq`**.";
|
|
1913
|
+
};
|
|
1914
|
+
readonly updateTags: {
|
|
1915
|
+
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1916
|
+
};
|
|
1917
|
+
readonly listGroup: {
|
|
1918
|
+
readonly description: "`GET .../{torrowId}/group/list` — query как в OpenAPI (**`lmfrom`**, **`lmto`** lower-case и др.); у **loyaltycards** пути в API нет — в SDK вызов бросает (**`withGroupListEndpoint: false`**).";
|
|
1919
|
+
};
|
|
1920
|
+
readonly updateGroups: {
|
|
1921
|
+
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1922
|
+
};
|
|
1923
|
+
readonly includeToGroups: {
|
|
1924
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1925
|
+
};
|
|
1926
|
+
readonly excludeFromGroups: {
|
|
1927
|
+
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
1928
|
+
};
|
|
1929
|
+
readonly includeToParent: {
|
|
1930
|
+
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1931
|
+
};
|
|
1932
|
+
readonly excludeFromParent: {
|
|
1933
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — **`ExcludeReq`**.";
|
|
1934
|
+
};
|
|
1935
|
+
readonly includeForUser: {
|
|
1936
|
+
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1937
|
+
};
|
|
1938
|
+
readonly excludeFromUser: {
|
|
1939
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — **`ExcludeReq`**.";
|
|
1940
|
+
};
|
|
1941
|
+
readonly rejectOffer: {
|
|
1942
|
+
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1943
|
+
};
|
|
1944
|
+
readonly reject: {
|
|
1945
|
+
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1946
|
+
};
|
|
1947
|
+
readonly share: {
|
|
1948
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1949
|
+
};
|
|
1950
|
+
readonly revokeOffer: {
|
|
1951
|
+
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1952
|
+
};
|
|
1953
|
+
readonly grantAccess: {
|
|
1954
|
+
readonly description: "`PUT .../participation/grantaccess` — body: `string[]`.";
|
|
1955
|
+
};
|
|
1956
|
+
readonly declineAccess: {
|
|
1957
|
+
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1958
|
+
};
|
|
1959
|
+
readonly updatePersonalListOrder: {
|
|
1960
|
+
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
1961
|
+
};
|
|
1962
|
+
readonly updateAlias: {
|
|
1963
|
+
readonly description: "`PUT .../{itemId}/alias` — body: string (**alias**); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1964
|
+
};
|
|
1965
|
+
readonly updateLastUsageTime: {
|
|
1966
|
+
readonly description: "`PUT .../{itemId}/lastusagetime` — body: ISO date-time string.";
|
|
1967
|
+
};
|
|
1968
|
+
readonly updateParticipationProfile: {
|
|
1969
|
+
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1970
|
+
};
|
|
1971
|
+
readonly sendLink: {
|
|
1972
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1973
|
+
};
|
|
1974
|
+
readonly getShortUrl: {
|
|
1975
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string`.";
|
|
1976
|
+
};
|
|
1977
|
+
readonly updateUniqueName: {
|
|
1978
|
+
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
1979
|
+
};
|
|
1980
|
+
readonly getByUniqueName: {
|
|
1981
|
+
readonly description: "`GET .../uniquename/{uniqueName}` — у **cases** доп. query **`profileId`** (override); иначе только **`signal`**.";
|
|
1982
|
+
};
|
|
1983
|
+
readonly getImageInfo: {
|
|
1984
|
+
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1985
|
+
};
|
|
1986
|
+
readonly getImagePutUrl: {
|
|
1987
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; query **`fileId`**, **`fileName`**, **`fileSize`**.";
|
|
1988
|
+
};
|
|
1989
|
+
readonly saveToMindMap: {
|
|
1990
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1991
|
+
};
|
|
1992
|
+
readonly updateSolutionData: {
|
|
1993
|
+
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1994
|
+
};
|
|
1995
|
+
readonly updatePersonalSolutionData: {
|
|
1996
|
+
readonly description: "`PUT .../{itemId}/personalsolutiondata` — **`PersonalSolutionData`**.";
|
|
1997
|
+
};
|
|
1998
|
+
};
|
|
1999
|
+
declare const torrowItemCoreFacadeSdkMethodFieldDocs: {
|
|
2000
|
+
readonly getPhotoInfo: string;
|
|
2001
|
+
readonly getPhotoPutUrl: string;
|
|
2002
|
+
readonly updatePublicity: string;
|
|
2003
|
+
readonly updateImageId: string;
|
|
2004
|
+
readonly updateTorrowAccountId: string;
|
|
2005
|
+
readonly updateMasterInfo: string;
|
|
2006
|
+
readonly updateIntegrations: string;
|
|
2007
|
+
readonly listParticipants: string;
|
|
2008
|
+
readonly generateSecurityToken: string;
|
|
2009
|
+
readonly updateParticipationType: string;
|
|
2010
|
+
readonly requestAccess: string;
|
|
2011
|
+
readonly revokeAccessRequest: string;
|
|
2012
|
+
readonly setGroup: string;
|
|
2013
|
+
readonly unsetGroup: string;
|
|
2014
|
+
readonly updateTags: string;
|
|
2015
|
+
readonly listGroup: string;
|
|
2016
|
+
readonly updateGroups: string;
|
|
2017
|
+
readonly includeToGroups: string;
|
|
2018
|
+
readonly excludeFromGroups: string;
|
|
2019
|
+
readonly includeToParent: string;
|
|
2020
|
+
readonly excludeFromParent: string;
|
|
2021
|
+
readonly includeForUser: string;
|
|
2022
|
+
readonly excludeFromUser: string;
|
|
2023
|
+
readonly rejectOffer: string;
|
|
2024
|
+
readonly reject: string;
|
|
2025
|
+
readonly share: string;
|
|
2026
|
+
readonly revokeOffer: string;
|
|
2027
|
+
readonly grantAccess: string;
|
|
2028
|
+
readonly declineAccess: string;
|
|
2029
|
+
readonly updatePersonalListOrder: string;
|
|
2030
|
+
readonly updateAlias: string;
|
|
2031
|
+
readonly updateLastUsageTime: string;
|
|
2032
|
+
readonly updateParticipationProfile: string;
|
|
2033
|
+
readonly sendLink: string;
|
|
2034
|
+
readonly getShortUrl: string;
|
|
2035
|
+
readonly updateUniqueName: string;
|
|
2036
|
+
readonly getByUniqueName: string;
|
|
2037
|
+
readonly getImageInfo: string;
|
|
2038
|
+
readonly getImagePutUrl: string;
|
|
2039
|
+
readonly saveToMindMap: string;
|
|
2040
|
+
readonly updateSolutionData: string;
|
|
2041
|
+
readonly updatePersonalSolutionData: string;
|
|
2042
|
+
};
|
|
2043
|
+
declare const torrowItemFacadeSdkMethodFieldDocs: {
|
|
2044
|
+
readonly updateFeedbackOptions: string;
|
|
2045
|
+
readonly getParticipantsAnonymousCount: string;
|
|
2046
|
+
readonly getParticipantsNonAnonymousCount: string;
|
|
2047
|
+
readonly listTags: string;
|
|
2048
|
+
readonly listGroups: string;
|
|
2049
|
+
readonly updateAccounts: string;
|
|
2050
|
+
readonly shareItemLink: string;
|
|
2051
|
+
readonly updateOfflinable: string;
|
|
2052
|
+
readonly updateReminders: string;
|
|
2053
|
+
readonly updateNotificationWayList: string;
|
|
2054
|
+
readonly block: string;
|
|
2055
|
+
readonly unblock: string;
|
|
2056
|
+
readonly updatePublicity: string;
|
|
2057
|
+
readonly updateImageId: string;
|
|
2058
|
+
readonly updateTorrowAccountId: string;
|
|
2059
|
+
readonly updateMasterInfo: string;
|
|
2060
|
+
readonly updateIntegrations: string;
|
|
2061
|
+
readonly listParticipants: string;
|
|
2062
|
+
readonly generateSecurityToken: string;
|
|
2063
|
+
readonly updateParticipationType: string;
|
|
2064
|
+
readonly requestAccess: string;
|
|
2065
|
+
readonly revokeAccessRequest: string;
|
|
2066
|
+
readonly setGroup: string;
|
|
2067
|
+
readonly unsetGroup: string;
|
|
2068
|
+
readonly updateTags: string;
|
|
2069
|
+
readonly listGroup: string;
|
|
2070
|
+
readonly updateGroups: string;
|
|
2071
|
+
readonly includeToGroups: string;
|
|
2072
|
+
readonly excludeFromGroups: string;
|
|
2073
|
+
readonly includeToParent: string;
|
|
2074
|
+
readonly excludeFromParent: string;
|
|
2075
|
+
readonly includeForUser: string;
|
|
2076
|
+
readonly excludeFromUser: string;
|
|
2077
|
+
readonly rejectOffer: string;
|
|
2078
|
+
readonly reject: string;
|
|
2079
|
+
readonly share: string;
|
|
2080
|
+
readonly revokeOffer: string;
|
|
2081
|
+
readonly grantAccess: string;
|
|
2082
|
+
readonly declineAccess: string;
|
|
2083
|
+
readonly updatePersonalListOrder: string;
|
|
2084
|
+
readonly updateAlias: string;
|
|
2085
|
+
readonly updateLastUsageTime: string;
|
|
2086
|
+
readonly updateParticipationProfile: string;
|
|
2087
|
+
readonly sendLink: string;
|
|
2088
|
+
readonly getShortUrl: string;
|
|
2089
|
+
readonly updateUniqueName: string;
|
|
2090
|
+
readonly getByUniqueName: string;
|
|
2091
|
+
readonly getImageInfo: string;
|
|
2092
|
+
readonly getImagePutUrl: string;
|
|
2093
|
+
readonly saveToMindMap: string;
|
|
2094
|
+
readonly updateSolutionData: string;
|
|
2095
|
+
readonly updatePersonalSolutionData: string;
|
|
2096
|
+
};
|
|
2097
|
+
declare const torrowItemFacadeContactsItemSdkMethodFieldDocs: {
|
|
2098
|
+
readonly getPhotoInfo: string;
|
|
2099
|
+
readonly getPhotoPutUrl: string;
|
|
2100
|
+
readonly updateFeedbackOptions: string;
|
|
2101
|
+
readonly getParticipantsAnonymousCount: string;
|
|
2102
|
+
readonly getParticipantsNonAnonymousCount: string;
|
|
2103
|
+
readonly listTags: string;
|
|
2104
|
+
readonly listGroups: string;
|
|
2105
|
+
readonly updateAccounts: string;
|
|
2106
|
+
readonly shareItemLink: string;
|
|
2107
|
+
readonly updateOfflinable: string;
|
|
2108
|
+
readonly updateReminders: string;
|
|
2109
|
+
readonly updateNotificationWayList: string;
|
|
2110
|
+
readonly block: string;
|
|
2111
|
+
readonly unblock: string;
|
|
2112
|
+
readonly updatePublicity: string;
|
|
2113
|
+
readonly updateImageId: string;
|
|
2114
|
+
readonly updateTorrowAccountId: string;
|
|
2115
|
+
readonly updateMasterInfo: string;
|
|
2116
|
+
readonly updateIntegrations: string;
|
|
2117
|
+
readonly listParticipants: string;
|
|
2118
|
+
readonly generateSecurityToken: string;
|
|
2119
|
+
readonly updateParticipationType: string;
|
|
2120
|
+
readonly requestAccess: string;
|
|
2121
|
+
readonly revokeAccessRequest: string;
|
|
2122
|
+
readonly setGroup: string;
|
|
2123
|
+
readonly unsetGroup: string;
|
|
2124
|
+
readonly updateTags: string;
|
|
2125
|
+
readonly listGroup: string;
|
|
2126
|
+
readonly updateGroups: string;
|
|
2127
|
+
readonly includeToGroups: string;
|
|
2128
|
+
readonly excludeFromGroups: string;
|
|
2129
|
+
readonly includeToParent: string;
|
|
2130
|
+
readonly excludeFromParent: string;
|
|
2131
|
+
readonly includeForUser: string;
|
|
2132
|
+
readonly excludeFromUser: string;
|
|
2133
|
+
readonly rejectOffer: string;
|
|
2134
|
+
readonly reject: string;
|
|
2135
|
+
readonly share: string;
|
|
2136
|
+
readonly revokeOffer: string;
|
|
2137
|
+
readonly grantAccess: string;
|
|
2138
|
+
readonly declineAccess: string;
|
|
2139
|
+
readonly updatePersonalListOrder: string;
|
|
2140
|
+
readonly updateAlias: string;
|
|
2141
|
+
readonly updateLastUsageTime: string;
|
|
2142
|
+
readonly updateParticipationProfile: string;
|
|
2143
|
+
readonly sendLink: string;
|
|
2144
|
+
readonly getShortUrl: string;
|
|
2145
|
+
readonly updateUniqueName: string;
|
|
2146
|
+
readonly getByUniqueName: string;
|
|
2147
|
+
readonly getImageInfo: string;
|
|
2148
|
+
readonly getImagePutUrl: string;
|
|
2149
|
+
readonly saveToMindMap: string;
|
|
2150
|
+
readonly updateSolutionData: string;
|
|
2151
|
+
readonly updatePersonalSolutionData: string;
|
|
2152
|
+
};
|
|
2153
|
+
|
|
2154
|
+
declare const serviceImplicitTagParamsFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
2155
|
+
declare const serviceImplicitTagParamsFieldDocs: {
|
|
2156
|
+
[x: string]: string;
|
|
2157
|
+
};
|
|
2158
|
+
declare const resourceBehaviorSettingsFieldDocEntries: {
|
|
2159
|
+
readonly marginTimeSec: {
|
|
2160
|
+
readonly description: "Отступ между событиями ресурса в секундах (`\"<sec>:MarginTime\"`).";
|
|
2161
|
+
readonly examples: readonly ["3600:MarginTime"];
|
|
2162
|
+
};
|
|
2163
|
+
readonly lockId: {
|
|
2164
|
+
readonly description: "Идентификатор TTLock-замка в `resource.tags` (`\"<lockNumber>:lockId\"`). Используется для интеграции с TTLock.";
|
|
2165
|
+
readonly examples: readonly ["11432744:lockId"];
|
|
2166
|
+
};
|
|
2167
|
+
};
|
|
2168
|
+
declare const resourceBehaviorSettingsFieldDocs: {
|
|
2169
|
+
readonly marginTimeSec: string;
|
|
2170
|
+
readonly lockId: string;
|
|
2171
|
+
};
|
|
2172
|
+
/**
|
|
2173
|
+
* Явный индекс публичных helper-методов для MCP-каталога.
|
|
2174
|
+
* Если добавляем новый helper в implicit-tag-слой — добавляем имя сюда,
|
|
2175
|
+
* и TS проверит, что описание в `serviceImplicitTagMethodDocByName` есть.
|
|
2176
|
+
*/
|
|
2177
|
+
declare const SERVICE_IMPLICIT_TAG_METHOD_NAMES: readonly ["parseServiceImplicitTagParams", "buildServiceImplicitTags", "mergeServiceImplicitTags", "upsertServiceImplicitTagParams", "isPrimaryServiceStepName", "getServiceStepDisplayName"];
|
|
2178
|
+
declare const serviceImplicitTagMethodsFieldDocEntries: Record<(typeof SERVICE_IMPLICIT_TAG_METHOD_NAMES)[number], ItemFieldDoc>;
|
|
2179
|
+
declare const serviceImplicitTagMethodsFieldDocs: {
|
|
2180
|
+
parseServiceImplicitTagParams: string;
|
|
2181
|
+
buildServiceImplicitTags: string;
|
|
2182
|
+
mergeServiceImplicitTags: string;
|
|
2183
|
+
upsertServiceImplicitTagParams: string;
|
|
2184
|
+
isPrimaryServiceStepName: string;
|
|
2185
|
+
getServiceStepDisplayName: string;
|
|
2186
|
+
};
|
|
2187
|
+
declare const RESOURCE_IMPLICIT_TAG_METHOD_NAMES: readonly ["parseResourceBehaviorSettings", "mergeResourceBehaviorTags"];
|
|
2188
|
+
declare const resourceImplicitTagMethodsFieldDocEntries: Record<(typeof RESOURCE_IMPLICIT_TAG_METHOD_NAMES)[number], ItemFieldDoc>;
|
|
2189
|
+
declare const resourceImplicitTagMethodsFieldDocs: {
|
|
2190
|
+
parseResourceBehaviorSettings: string;
|
|
2191
|
+
mergeResourceBehaviorTags: string;
|
|
2192
|
+
};
|
|
2193
|
+
|
|
2194
|
+
declare const blockReasonFieldDocEntries: {
|
|
2195
|
+
readonly id: {
|
|
2196
|
+
readonly description: "Числовой идентификатор причины блокировки в справочнике.";
|
|
2197
|
+
readonly valueSchema: "int32";
|
|
2198
|
+
};
|
|
2199
|
+
readonly defaultName: {
|
|
2200
|
+
readonly description: "Отображаемое имя по умолчанию (часто мультиязычное имя на стороне сервиса словарей).";
|
|
2201
|
+
readonly valueSchema: "string | null";
|
|
2202
|
+
};
|
|
2203
|
+
readonly order: {
|
|
2204
|
+
readonly description: "Порядок сортировки в списке причин.";
|
|
2205
|
+
readonly valueSchema: "int32";
|
|
2206
|
+
};
|
|
2207
|
+
readonly isDeleted: {
|
|
2208
|
+
readonly description: "Мягкое удаление записи справочника.";
|
|
2209
|
+
readonly valueSchema: "boolean";
|
|
2210
|
+
};
|
|
2211
|
+
};
|
|
2212
|
+
declare const blockReasonFieldDocs: {
|
|
2213
|
+
readonly id: string;
|
|
2214
|
+
readonly defaultName: string;
|
|
2215
|
+
readonly order: string;
|
|
2216
|
+
readonly isDeleted: string;
|
|
2217
|
+
};
|
|
2218
|
+
declare const blockReasonsSdkMethodFieldDocEntries: {
|
|
2219
|
+
readonly create: {
|
|
2220
|
+
readonly description: "`POST /api/v1/blockreason` — создать причину; ответ: id.";
|
|
2221
|
+
};
|
|
2222
|
+
readonly getById: {
|
|
2223
|
+
readonly description: "`GET /api/v1/blockreason/{id}` — одна причина, query `lng`.";
|
|
2224
|
+
};
|
|
2225
|
+
readonly listAll: {
|
|
2226
|
+
readonly description: "`GET /api/v1/blockreason/all` — список с пагинацией и сортировкой словаря.";
|
|
2227
|
+
};
|
|
2228
|
+
readonly delete: {
|
|
2229
|
+
readonly description: "`DELETE /api/v1/blockreason/{id}`.";
|
|
2230
|
+
};
|
|
2231
|
+
};
|
|
2232
|
+
declare const blockReasonsSdkMethodFieldDocs: {
|
|
2233
|
+
readonly create: string;
|
|
2234
|
+
readonly getById: string;
|
|
2235
|
+
readonly listAll: string;
|
|
2236
|
+
readonly delete: string;
|
|
2237
|
+
};
|
|
2238
|
+
|
|
2239
|
+
declare const sendCommunicationCodeReqFieldDocEntries: {
|
|
2240
|
+
readonly value: {
|
|
2241
|
+
readonly description: "Телефон, email или иное значение канала, на которое отправляется код.";
|
|
2242
|
+
readonly valueSchema: "string | null";
|
|
2243
|
+
};
|
|
2244
|
+
readonly type: {
|
|
2245
|
+
readonly description: "Тип коммуникации (`CommunicationType`: Phone, Email, Telegram, Max, …).";
|
|
2246
|
+
readonly valueSchema: "CommunicationType";
|
|
2247
|
+
};
|
|
2248
|
+
readonly language: {
|
|
2249
|
+
readonly description: "Язык шаблона сообщения / UI.";
|
|
2250
|
+
readonly valueSchema: "string | null";
|
|
2251
|
+
};
|
|
2252
|
+
};
|
|
2253
|
+
declare const sendCommunicationCodeReqFieldDocs: {
|
|
2254
|
+
readonly value: string;
|
|
2255
|
+
readonly type: string;
|
|
2256
|
+
readonly language: string;
|
|
2257
|
+
};
|
|
2258
|
+
declare const sendCommunicationCodeRespFieldDocEntries: {
|
|
2259
|
+
readonly sessionId: {
|
|
2260
|
+
readonly description: "Идентификатор сессии подтверждения для `verifyCommunicationCode`.";
|
|
2261
|
+
readonly valueSchema: "string | null";
|
|
2262
|
+
};
|
|
2263
|
+
readonly sessionLifeTimeSeconds: {
|
|
2264
|
+
readonly description: "TTL сессии в секундах.";
|
|
2265
|
+
readonly valueSchema: "int32";
|
|
2266
|
+
};
|
|
2267
|
+
};
|
|
2268
|
+
declare const sendCommunicationCodeRespFieldDocs: {
|
|
2269
|
+
readonly sessionId: string;
|
|
2270
|
+
readonly sessionLifeTimeSeconds: string;
|
|
2271
|
+
};
|
|
2272
|
+
declare const verifyCommunicationCodeReqFieldDocEntries: {
|
|
2273
|
+
readonly sessionId: {
|
|
2274
|
+
readonly description: "Сессия из ответа sendCode.";
|
|
2275
|
+
readonly valueSchema: "string | null";
|
|
2276
|
+
};
|
|
2277
|
+
readonly code: {
|
|
2278
|
+
readonly description: "Код из SMS/email.";
|
|
2279
|
+
readonly valueSchema: "string | null";
|
|
2280
|
+
};
|
|
2281
|
+
};
|
|
2282
|
+
declare const verifyCommunicationCodeReqFieldDocs: {
|
|
2283
|
+
readonly sessionId: string;
|
|
2284
|
+
readonly code: string;
|
|
2285
|
+
};
|
|
2286
|
+
declare const verifyCommunicationCodeRespFieldDocEntries: {
|
|
2287
|
+
readonly success: {
|
|
2288
|
+
readonly description: "Успех проверки кода.";
|
|
2289
|
+
readonly valueSchema: "boolean";
|
|
2290
|
+
};
|
|
2291
|
+
readonly value: {
|
|
2292
|
+
readonly description: "Нормализованное подтверждённое значение (например E.164).";
|
|
2293
|
+
readonly valueSchema: "string | null";
|
|
2294
|
+
};
|
|
2295
|
+
readonly channel: {
|
|
2296
|
+
readonly description: "Канал доставки после верификации (`DeliveryChannel`, включая Telegram/Max).";
|
|
2297
|
+
readonly valueSchema: "DeliveryChannel";
|
|
2298
|
+
};
|
|
2299
|
+
};
|
|
2300
|
+
declare const verifyCommunicationCodeRespFieldDocs: {
|
|
2301
|
+
readonly success: string;
|
|
2302
|
+
readonly value: string;
|
|
2303
|
+
readonly channel: string;
|
|
2304
|
+
};
|
|
2305
|
+
declare const contactsCommunicationSdkMethodFieldDocEntries: {
|
|
2306
|
+
readonly sendCommunicationCode: {
|
|
2307
|
+
readonly description: "`POST /api/v1/contacts/communication/sendcode` — отправить код на канал (`SendCommunicationCodeReq`).";
|
|
2308
|
+
};
|
|
2309
|
+
readonly verifyCommunicationCode: {
|
|
2310
|
+
readonly description: "`POST /api/v1/contacts/communication/verify` — проверить код (`VerifyCommunicationCodeReq`).";
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
declare const contactsCommunicationSdkMethodFieldDocs: {
|
|
2314
|
+
readonly sendCommunicationCode: string;
|
|
2315
|
+
readonly verifyCommunicationCode: string;
|
|
2316
|
+
};
|
|
2317
|
+
|
|
2318
|
+
declare const userSettingsInfoFieldDocEntries: {
|
|
2319
|
+
readonly settings: {
|
|
2320
|
+
readonly description: "Сериализованная строка пользовательских настроек (обычно JSON), которую хранит User API.";
|
|
2321
|
+
readonly valueSchema: "string | null";
|
|
2322
|
+
readonly usage: "SDK не интерпретирует структуру внутри `settings`; приложение хранит/читает свой формат и версионирует его самостоятельно.";
|
|
2323
|
+
};
|
|
2324
|
+
};
|
|
2325
|
+
declare const userSettingsInfoFieldDocs: {
|
|
2326
|
+
readonly settings: string;
|
|
2327
|
+
};
|
|
2328
|
+
declare const solutionDataFieldDocEntries: {
|
|
2329
|
+
readonly quickFilterTags: {
|
|
2330
|
+
readonly description: "Теги быстрых фильтров отображаемых при поиске элементов, которые вложенны в данную группу карточки.";
|
|
2331
|
+
readonly valueSchema: "string[] | null";
|
|
2332
|
+
readonly usage: "В продукте обновляется через setQuickFilters и синхронизируется с `tags`: при удалении тегов из элемента лишние quick-filters удаляются из `solutionData.quickFilterTags`.";
|
|
2333
|
+
};
|
|
2334
|
+
readonly metrics: {
|
|
2335
|
+
readonly description: "Переопределение счетчиков аналитики для конкретного элемента.";
|
|
2336
|
+
readonly valueSchema: "Metrics";
|
|
2337
|
+
readonly usage: "Форма Analytics Tools пишет в `solutionData.metrics`; при page open/event отправляются hit/event в глобальные счетчики и дополнительно в элементные счетчики из `metrics`.";
|
|
2338
|
+
};
|
|
2339
|
+
readonly surveyId: {
|
|
2340
|
+
readonly description: "ID привязанного опроса/анкеты.";
|
|
2341
|
+
readonly valueSchema: "string | null";
|
|
2342
|
+
};
|
|
2343
|
+
readonly viewBlockSettings: {
|
|
2344
|
+
readonly description: "Конфигурация блоков/секций карточки дочерних элементов.";
|
|
2345
|
+
readonly valueSchema: "ViewBlockSettings";
|
|
2346
|
+
readonly usage: "Форма item appearance сохраняет `viewBlockSettings.blockSettings[]`; порядок секций берется из `order`, а `filter.tags` используется для отдельных выборок child-views с фильтрацией по тегам.";
|
|
2347
|
+
};
|
|
2348
|
+
readonly layoutType: {
|
|
2349
|
+
readonly description: "Тип layout карточки (int-код UI раскладки/обложки).";
|
|
2350
|
+
readonly valueSchema: "int32 | null";
|
|
2351
|
+
readonly usage: "Выбирается в item appearance. На мобильном влияет на режим image-header (`BigImagePanel` + image => image view с opacity toolbar).";
|
|
2352
|
+
};
|
|
2353
|
+
readonly homeItemIds: {
|
|
2354
|
+
readonly description: "Закрепленные home-элементы (обычно один выбранный id).";
|
|
2355
|
+
readonly valueSchema: "string[] | null";
|
|
2356
|
+
readonly usage: "Выбираются в item appearance через picker родительского элемента; сохраняются в solutionData и используются как persisted-настройка навигации/точки входа.";
|
|
2357
|
+
};
|
|
2358
|
+
readonly vk: {
|
|
2359
|
+
readonly description: "Параметры интеграции/виджета VK в решении.";
|
|
2360
|
+
readonly valueSchema: "Vk";
|
|
2361
|
+
};
|
|
2362
|
+
readonly zoom: {
|
|
2363
|
+
readonly description: "Состояние масштаба/viewport для mind map и визуализаций.";
|
|
2364
|
+
readonly valueSchema: "Zoom";
|
|
2365
|
+
};
|
|
2366
|
+
};
|
|
2367
|
+
declare const solutionDataFieldDocs: {
|
|
2368
|
+
readonly quickFilterTags: string;
|
|
2369
|
+
readonly metrics: string;
|
|
2370
|
+
readonly surveyId: string;
|
|
2371
|
+
readonly viewBlockSettings: string;
|
|
2372
|
+
readonly layoutType: string;
|
|
2373
|
+
readonly homeItemIds: string;
|
|
2374
|
+
readonly vk: string;
|
|
2375
|
+
readonly zoom: string;
|
|
2376
|
+
};
|
|
2377
|
+
declare const blockInfoFieldDocEntries: {
|
|
2378
|
+
readonly reasonId: {
|
|
2379
|
+
readonly description: "Код причины блокировки.";
|
|
2380
|
+
readonly valueSchema: "int32";
|
|
2381
|
+
};
|
|
2382
|
+
readonly blockDate: {
|
|
2383
|
+
readonly description: "Дата и время блокировки.";
|
|
2384
|
+
readonly valueSchema: "date-time string | null";
|
|
2385
|
+
};
|
|
2386
|
+
readonly reasonNote: {
|
|
2387
|
+
readonly description: "Свободный комментарий к причине блокировки.";
|
|
2388
|
+
readonly valueSchema: "string | null";
|
|
2389
|
+
};
|
|
2390
|
+
};
|
|
2391
|
+
declare const blockInfoFieldDocs: {
|
|
2392
|
+
readonly reasonId: string;
|
|
2393
|
+
readonly blockDate: string;
|
|
2394
|
+
readonly reasonNote: string;
|
|
2395
|
+
};
|
|
2396
|
+
declare const usageConditionFieldDocEntries: {
|
|
2397
|
+
readonly usageConditionType: {
|
|
2398
|
+
readonly description: "Тип условия (`None`, `Exclusion`, `Additional`, ...).";
|
|
2399
|
+
readonly valueSchema: "UsageConditionType";
|
|
2400
|
+
};
|
|
2401
|
+
readonly conditionIdList: {
|
|
2402
|
+
readonly description: "Ссылки на условия/правила, участвующие в ограничении использования.";
|
|
2403
|
+
readonly valueSchema: "string[] | null";
|
|
2404
|
+
};
|
|
2405
|
+
};
|
|
2406
|
+
declare const usageConditionFieldDocs: {
|
|
2407
|
+
readonly usageConditionType: string;
|
|
2408
|
+
readonly conditionIdList: string;
|
|
2409
|
+
};
|
|
2410
|
+
declare const usageTypeFieldDocEntries: {
|
|
2411
|
+
readonly value: {
|
|
2412
|
+
readonly description: "Тип использования ресурса (`Specification`, `Rent`, `Sale`, `Payment`, `Ticket`).";
|
|
2413
|
+
readonly valueSchema: "UsageType";
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
|
+
declare const usageTypeFieldDocs: {
|
|
2417
|
+
readonly value: string;
|
|
2418
|
+
};
|
|
2419
|
+
declare const usageConditionTypeFieldDocEntries: {
|
|
2420
|
+
readonly value: {
|
|
2421
|
+
readonly description: "Класс условия использования (`None`, `Exclusion`, `Additional`).";
|
|
2422
|
+
readonly valueSchema: "UsageConditionType";
|
|
2423
|
+
};
|
|
2424
|
+
};
|
|
2425
|
+
declare const usageConditionTypeFieldDocs: {
|
|
2426
|
+
readonly value: string;
|
|
2427
|
+
};
|
|
2428
|
+
declare const viewBlockSettingsFieldDocEntries: {
|
|
2429
|
+
readonly blockSettings: {
|
|
2430
|
+
readonly description: "Список настроек секций карточки (по типам дочерних элементов).";
|
|
2431
|
+
readonly valueSchema: "BlockSettings[] | null";
|
|
2432
|
+
readonly usage: "При рендере карточки секции сортируются по `order`; если каких-то дефолтных типов нет, UI добавляет fallback-секции (contact/note/case/service/calendar/resource).";
|
|
2433
|
+
};
|
|
2434
|
+
};
|
|
2435
|
+
declare const viewBlockSettingsFieldDocs: {
|
|
2436
|
+
readonly blockSettings: string;
|
|
2437
|
+
};
|
|
2438
|
+
declare const blockSettingsFieldDocEntries: {
|
|
2439
|
+
readonly objectType: {
|
|
2440
|
+
readonly description: "Тип дочернего элемента для секции (числовой objectType из API).";
|
|
2441
|
+
readonly valueSchema: "TorrowObjectType";
|
|
2442
|
+
readonly usage: "Сопоставляется с enum-типом в клиенте (`getTorrowObjectTypeByNumber`) и используется для загрузки соответствующего view (contacts/notes/services/cases/calendars/resources).";
|
|
2443
|
+
};
|
|
2444
|
+
readonly name: {
|
|
2445
|
+
readonly description: "Название блока (label в UI).";
|
|
2446
|
+
readonly valueSchema: "string | null";
|
|
2447
|
+
};
|
|
2448
|
+
readonly order: {
|
|
2449
|
+
readonly description: "Порядок блока в раскладке.";
|
|
2450
|
+
readonly valueSchema: "int32 | null";
|
|
2451
|
+
};
|
|
2452
|
+
readonly filter: {
|
|
2453
|
+
readonly description: "Дополнительный фильтр секции.";
|
|
2454
|
+
readonly valueSchema: "Filter";
|
|
2455
|
+
readonly usage: "Для секции поддерживается `filter.tags`: при наличии запускается дополнительный запрос child-view c `listOptions.tags`.";
|
|
2456
|
+
};
|
|
2457
|
+
};
|
|
2458
|
+
declare const blockSettingsFieldDocs: {
|
|
2459
|
+
readonly objectType: string;
|
|
2460
|
+
readonly name: string;
|
|
2461
|
+
readonly order: string;
|
|
2462
|
+
readonly filter: string;
|
|
2463
|
+
};
|
|
2464
|
+
declare const metricsFieldDocEntries: {
|
|
2465
|
+
readonly yandexMetrics: {
|
|
2466
|
+
readonly description: "ID счетчика Яндекс.Метрики для элемента.";
|
|
2467
|
+
readonly valueSchema: "string | null";
|
|
2468
|
+
readonly usage: "При наличии инициализируется отдельный счетчик и получает page hit / reachGoal в дополнение к глобальному счетчику приложения.";
|
|
2469
|
+
};
|
|
2470
|
+
readonly googleAnalytics: {
|
|
2471
|
+
readonly description: "GA measurement id для элемента.";
|
|
2472
|
+
readonly valueSchema: "string | null";
|
|
2473
|
+
readonly usage: "При наличии отправляются page view / events в GA именно этого элемента.";
|
|
2474
|
+
};
|
|
2475
|
+
readonly facebookPixel: {
|
|
2476
|
+
readonly description: "Facebook Pixel id для элемента.";
|
|
2477
|
+
readonly valueSchema: "string | null";
|
|
2478
|
+
readonly usage: "Поле есть в API/SDK и в форме редактирования; в продукте может быть скрыто feature/policy флагами, но сохраняется в `solutionData.metrics`.";
|
|
2479
|
+
};
|
|
2480
|
+
};
|
|
2481
|
+
declare const metricsFieldDocs: {
|
|
2482
|
+
readonly yandexMetrics: string;
|
|
2483
|
+
readonly googleAnalytics: string;
|
|
2484
|
+
readonly facebookPixel: string;
|
|
2485
|
+
};
|
|
2486
|
+
declare const filterFieldDocEntries: {
|
|
2487
|
+
readonly tags: {
|
|
2488
|
+
readonly description: "Теги для фильтрации дочерних элементов внутри секции.";
|
|
2489
|
+
readonly valueSchema: "string[] | null";
|
|
2490
|
+
readonly usage: "Заполняется в форме секции (`quickFilterTags`) и маппится в `BlockSettings.filter.tags`; влияет на состав элементов в конкретном блоке карточки.";
|
|
2491
|
+
};
|
|
2492
|
+
};
|
|
2493
|
+
declare const filterFieldDocs: {
|
|
2494
|
+
readonly tags: string;
|
|
2495
|
+
};
|
|
2496
|
+
declare const personalSolutionDataFieldDocEntries: {
|
|
2497
|
+
readonly favoriteOrder: {
|
|
2498
|
+
readonly description: "Персональный порядок/приоритет элемента для текущего профиля.";
|
|
2499
|
+
readonly valueSchema: "int32";
|
|
2500
|
+
};
|
|
2501
|
+
};
|
|
2502
|
+
declare const personalSolutionDataFieldDocs: {
|
|
2503
|
+
readonly favoriteOrder: string;
|
|
2504
|
+
};
|
|
2505
|
+
declare const notificationPropertiesFieldDocEntries: {
|
|
2506
|
+
readonly deliveryStrategy: {
|
|
2507
|
+
readonly description: "Стратегия отправки уведомлений (`Always`, `Schedule`, ... по enum API).";
|
|
2508
|
+
readonly valueSchema: "DeliveryStrategy";
|
|
2509
|
+
};
|
|
2510
|
+
readonly deliveryChannelMessageList: {
|
|
2511
|
+
readonly description: "Шаблоны сообщений по каналам доставки.";
|
|
2512
|
+
readonly valueSchema: "DeliveryChannelMessage[] | null";
|
|
2513
|
+
};
|
|
2514
|
+
readonly beginAcceptableTime: {
|
|
2515
|
+
readonly description: "Начало допустимого окна отправки (минуты/код времени API).";
|
|
2516
|
+
readonly valueSchema: "int32 | null";
|
|
2517
|
+
};
|
|
2518
|
+
readonly endAcceptableTime: {
|
|
2519
|
+
readonly description: "Конец допустимого окна отправки.";
|
|
2520
|
+
readonly valueSchema: "int32 | null";
|
|
2521
|
+
};
|
|
2522
|
+
};
|
|
2523
|
+
declare const notificationPropertiesFieldDocs: {
|
|
2524
|
+
readonly deliveryStrategy: string;
|
|
2525
|
+
readonly deliveryChannelMessageList: string;
|
|
2526
|
+
readonly beginAcceptableTime: string;
|
|
2527
|
+
readonly endAcceptableTime: string;
|
|
2528
|
+
};
|
|
2529
|
+
declare const userDeliveryWayFieldDocEntries: {
|
|
2530
|
+
readonly deliveryChannel: {
|
|
2531
|
+
readonly description: "Канал доставки (`Sms`, `Email`, `Push`, `Telegram`, `Max` и т.п.).";
|
|
2532
|
+
readonly valueSchema: "DeliveryChannel";
|
|
2533
|
+
};
|
|
2534
|
+
readonly searchValue: {
|
|
2535
|
+
readonly description: "Поисковое/идентификационное значение получателя (телефон, email).";
|
|
2536
|
+
readonly valueSchema: "string | null";
|
|
2537
|
+
};
|
|
2538
|
+
readonly deliveryParameters: {
|
|
2539
|
+
readonly description: "Параметры канала в сериализованной форме.";
|
|
2540
|
+
readonly valueSchema: "string | null";
|
|
2541
|
+
};
|
|
2542
|
+
};
|
|
2543
|
+
declare const userDeliveryWayFieldDocs: {
|
|
2544
|
+
readonly deliveryChannel: string;
|
|
2545
|
+
readonly searchValue: string;
|
|
2546
|
+
readonly deliveryParameters: string;
|
|
2547
|
+
};
|
|
2548
|
+
declare const deviceSettingsInfoFieldDocEntries: {
|
|
2549
|
+
readonly deviceId: {
|
|
2550
|
+
readonly description: "ID устройства пользователя.";
|
|
2551
|
+
readonly valueSchema: "string | null";
|
|
2552
|
+
};
|
|
2553
|
+
readonly settings: {
|
|
2554
|
+
readonly description: "Сериализованные настройки для конкретного устройства.";
|
|
2555
|
+
readonly valueSchema: "string | null";
|
|
2556
|
+
};
|
|
2557
|
+
};
|
|
2558
|
+
declare const deviceSettingsInfoFieldDocs: {
|
|
2559
|
+
readonly deviceId: string;
|
|
2560
|
+
readonly settings: string;
|
|
2561
|
+
};
|
|
2562
|
+
|
|
2563
|
+
declare const generateSecurityTokenReqFieldDocEntries: {
|
|
2564
|
+
readonly forUser: {
|
|
2565
|
+
readonly description: "Токен ограничен текущим пользователем/профилем.";
|
|
2566
|
+
readonly valueSchema: "boolean | null";
|
|
2567
|
+
};
|
|
2568
|
+
readonly expiresAt: {
|
|
2569
|
+
readonly description: "Срок действия security-token.";
|
|
2570
|
+
readonly valueSchema: "date-time string | null";
|
|
2571
|
+
};
|
|
2572
|
+
readonly operationTypeList: {
|
|
2573
|
+
readonly description: "Список разрешённых операций для токена.";
|
|
2574
|
+
readonly valueSchema: "OperationType[] | null";
|
|
2575
|
+
};
|
|
2576
|
+
readonly participantType: {
|
|
2577
|
+
readonly description: "Минимальная роль участия при использовании токена.";
|
|
2578
|
+
readonly valueSchema: "ParticipantType";
|
|
2579
|
+
};
|
|
2580
|
+
readonly participantState: {
|
|
2581
|
+
readonly description: "Ожидаемое состояние участия для доступа по токену.";
|
|
2582
|
+
readonly valueSchema: "ParticipantState";
|
|
2583
|
+
};
|
|
2584
|
+
readonly roleIdList: {
|
|
2585
|
+
readonly description: "Ограничение по role id (контракт API).";
|
|
2586
|
+
readonly valueSchema: "int32[] | null";
|
|
2587
|
+
};
|
|
2588
|
+
};
|
|
2589
|
+
declare const generateSecurityTokenReqFieldDocs: {
|
|
2590
|
+
readonly forUser: string;
|
|
2591
|
+
readonly expiresAt: string;
|
|
2592
|
+
readonly operationTypeList: string;
|
|
2593
|
+
readonly participantType: string;
|
|
2594
|
+
readonly participantState: string;
|
|
2595
|
+
readonly roleIdList: string;
|
|
2596
|
+
};
|
|
2597
|
+
declare const generateSecurityTokenRespFieldDocEntries: {
|
|
2598
|
+
readonly token: {
|
|
2599
|
+
readonly description: "Сгенерированный security-token для guest/limited access.";
|
|
2600
|
+
readonly valueSchema: "string | null";
|
|
2601
|
+
};
|
|
2602
|
+
};
|
|
2603
|
+
declare const generateSecurityTokenRespFieldDocs: {
|
|
2604
|
+
readonly token: string;
|
|
2605
|
+
};
|
|
2606
|
+
declare const shareItemReqFieldDocEntries: {
|
|
2607
|
+
readonly userProfileId: {
|
|
2608
|
+
readonly description: "Профиль-инициатор шаринга (если отличается от контекста токена).";
|
|
2609
|
+
readonly valueSchema: "string | null";
|
|
2610
|
+
};
|
|
2611
|
+
readonly readerProfileIdList: {
|
|
2612
|
+
readonly description: "Список профилей-получателей (основное поле API).";
|
|
2613
|
+
readonly valueSchema: "string[] | null";
|
|
2614
|
+
};
|
|
2615
|
+
readonly readerProfileIdsList: {
|
|
2616
|
+
readonly description: "Легаси-алиас списка получателей (встречается в старых контрактах).";
|
|
2617
|
+
readonly valueSchema: "string[] | null";
|
|
2618
|
+
};
|
|
2619
|
+
readonly participantType: {
|
|
2620
|
+
readonly description: "Тип доступа, который выдают получателям.";
|
|
2621
|
+
readonly valueSchema: "ParticipantType";
|
|
2622
|
+
};
|
|
2623
|
+
readonly userMessage: {
|
|
2624
|
+
readonly description: "Комментарий/сообщение получателю при шаринге.";
|
|
2625
|
+
readonly valueSchema: "string | null";
|
|
2626
|
+
};
|
|
2627
|
+
readonly versionToCheck: {
|
|
2628
|
+
readonly description: "Версия объекта для optimistic lock.";
|
|
2629
|
+
readonly valueSchema: "int32 | null";
|
|
2630
|
+
};
|
|
2631
|
+
readonly isNeedAnnouncement: {
|
|
2632
|
+
readonly description: "Флаг генерации анонса после share.";
|
|
2633
|
+
readonly valueSchema: "boolean | null";
|
|
2634
|
+
};
|
|
2635
|
+
};
|
|
2636
|
+
declare const shareItemReqFieldDocs: {
|
|
2637
|
+
readonly userProfileId: string;
|
|
2638
|
+
readonly readerProfileIdList: string;
|
|
2639
|
+
readonly readerProfileIdsList: string;
|
|
2640
|
+
readonly participantType: string;
|
|
2641
|
+
readonly userMessage: string;
|
|
2642
|
+
readonly versionToCheck: string;
|
|
2643
|
+
readonly isNeedAnnouncement: string;
|
|
2644
|
+
};
|
|
2645
|
+
declare const sendLinkOfItemReqFieldDocEntries: {
|
|
2646
|
+
readonly profileId: {
|
|
2647
|
+
readonly description: "Профиль-инициатор отправки ссылки.";
|
|
2648
|
+
readonly valueSchema: "string | null";
|
|
2649
|
+
};
|
|
2650
|
+
readonly recipientProfileIdList: {
|
|
2651
|
+
readonly description: "Список профилей-получателей ссылки.";
|
|
2652
|
+
readonly valueSchema: "string[] | null";
|
|
2653
|
+
};
|
|
2654
|
+
readonly message: {
|
|
2655
|
+
readonly description: "Сопроводительное сообщение к ссылке.";
|
|
2656
|
+
readonly valueSchema: "string | null";
|
|
2657
|
+
};
|
|
2658
|
+
};
|
|
2659
|
+
declare const sendLinkOfItemReqFieldDocs: {
|
|
2660
|
+
readonly profileId: string;
|
|
2661
|
+
readonly recipientProfileIdList: string;
|
|
2662
|
+
readonly message: string;
|
|
2663
|
+
};
|
|
2664
|
+
declare const sendLinkOfItemRespFieldDocEntries: {
|
|
2665
|
+
readonly isSuccess: {
|
|
2666
|
+
readonly description: "Итог отправки ссылки.";
|
|
2667
|
+
readonly valueSchema: "boolean";
|
|
2668
|
+
};
|
|
2669
|
+
};
|
|
2670
|
+
declare const sendLinkOfItemRespFieldDocs: {
|
|
2671
|
+
readonly isSuccess: string;
|
|
2672
|
+
};
|
|
2673
|
+
declare const participationFieldDocEntries: {
|
|
2674
|
+
readonly meta: {
|
|
2675
|
+
readonly description: "Мета участия (`version`, даты, системные атрибуты).";
|
|
2676
|
+
readonly valueSchema: "ObjectInfo";
|
|
2677
|
+
};
|
|
2678
|
+
readonly profileId: {
|
|
2679
|
+
readonly description: "Профиль участника, для которого действует участие.";
|
|
2680
|
+
readonly valueSchema: "string | null";
|
|
2681
|
+
};
|
|
2682
|
+
readonly participantState: {
|
|
2683
|
+
readonly description: "Состояние участия (`Requested`, `Approved`, ...).";
|
|
2684
|
+
readonly valueSchema: "ParticipantState";
|
|
2685
|
+
};
|
|
2686
|
+
readonly participantType: {
|
|
2687
|
+
readonly description: "Роль участия (`Reader`, `Editor`, `Owner`, ...).";
|
|
2688
|
+
readonly valueSchema: "ParticipantType";
|
|
2689
|
+
};
|
|
2690
|
+
readonly notificationWayList: {
|
|
2691
|
+
readonly description: "Каналы уведомлений участника по объекту.";
|
|
2692
|
+
readonly valueSchema: "NotificationWay[] | null";
|
|
2693
|
+
};
|
|
2694
|
+
readonly subscriptionList: {
|
|
2695
|
+
readonly description: "Подписки/настройки подписок участника.";
|
|
2696
|
+
readonly valueSchema: "Subscription[] | null";
|
|
2697
|
+
};
|
|
2698
|
+
};
|
|
2699
|
+
declare const participationFieldDocs: {
|
|
2700
|
+
readonly meta: string;
|
|
2701
|
+
readonly profileId: string;
|
|
2702
|
+
readonly participantState: string;
|
|
2703
|
+
readonly participantType: string;
|
|
2704
|
+
readonly notificationWayList: string;
|
|
2705
|
+
readonly subscriptionList: string;
|
|
2706
|
+
};
|
|
2707
|
+
declare const profileWithErrorFieldDocEntries: {
|
|
2708
|
+
readonly profile: {
|
|
2709
|
+
readonly description: "ID профиля, по которому операция завершилась с ошибкой.";
|
|
2710
|
+
readonly valueSchema: "string | null";
|
|
2711
|
+
};
|
|
2712
|
+
readonly torrowErrorClient: {
|
|
2713
|
+
readonly description: "Структура ошибки API для этого профиля.";
|
|
2714
|
+
readonly valueSchema: "TorrowErrorClient";
|
|
2715
|
+
};
|
|
2716
|
+
};
|
|
2717
|
+
declare const profileWithErrorFieldDocs: {
|
|
2718
|
+
readonly profile: string;
|
|
2719
|
+
readonly torrowErrorClient: string;
|
|
2720
|
+
};
|
|
2721
|
+
declare const participationRespFieldDocEntries: {
|
|
2722
|
+
readonly participationList: {
|
|
2723
|
+
readonly description: "Список успешных participation-изменений.";
|
|
2724
|
+
readonly valueSchema: "Participation[] | null";
|
|
2725
|
+
};
|
|
2726
|
+
readonly failedToParticipate: {
|
|
2727
|
+
readonly description: "Профили, по которым операция не выполнена, с ошибками.";
|
|
2728
|
+
readonly valueSchema: "ProfileWithError[] | null";
|
|
2729
|
+
};
|
|
2730
|
+
};
|
|
2731
|
+
declare const participationRespFieldDocs: {
|
|
2732
|
+
readonly participationList: string;
|
|
2733
|
+
readonly failedToParticipate: string;
|
|
2734
|
+
};
|
|
2735
|
+
|
|
2736
|
+
declare const accountingTransactionFieldDocEntries: {
|
|
2737
|
+
readonly accountId: {
|
|
2738
|
+
readonly description: "Счёт/баланс, к которому относится транзакция.";
|
|
2739
|
+
readonly valueSchema: "string | null";
|
|
2740
|
+
};
|
|
2741
|
+
readonly transactionDate: {
|
|
2742
|
+
readonly description: "Дата проводки транзакции.";
|
|
2743
|
+
readonly valueSchema: "date-time string";
|
|
2744
|
+
};
|
|
2745
|
+
readonly state: {
|
|
2746
|
+
readonly description: "Состояние транзакции (`Intended`, `Reserved`, `Commited`, ...).";
|
|
2747
|
+
readonly valueSchema: "AccountingTransactionState";
|
|
2748
|
+
};
|
|
2749
|
+
readonly type: {
|
|
2750
|
+
readonly description: "Тип транзакции (`Balance` или `Operation`).";
|
|
2751
|
+
readonly valueSchema: "AccountingTransactionType";
|
|
2752
|
+
};
|
|
2753
|
+
readonly transactionValues: {
|
|
2754
|
+
readonly description: "Список изменений по продуктам/валютам.";
|
|
2755
|
+
readonly valueSchema: "BalanceValue[] | null";
|
|
2756
|
+
};
|
|
2757
|
+
readonly comment: {
|
|
2758
|
+
readonly description: "Пояснение к операции (для UI/аудита).";
|
|
2759
|
+
readonly valueSchema: "string | null";
|
|
2760
|
+
};
|
|
2761
|
+
readonly operationCategory: {
|
|
2762
|
+
readonly description: "Категория операции (int-код API).";
|
|
2763
|
+
readonly valueSchema: "int32";
|
|
2764
|
+
};
|
|
2765
|
+
readonly operationCategoryName: {
|
|
2766
|
+
readonly description: "Человекочитаемое имя категории операции.";
|
|
2767
|
+
readonly valueSchema: "string | null";
|
|
2768
|
+
};
|
|
2769
|
+
readonly validityDate: {
|
|
2770
|
+
readonly description: "Срок действия транзакции/резерва, если применимо.";
|
|
2771
|
+
readonly valueSchema: "date-time string | null";
|
|
2772
|
+
};
|
|
2773
|
+
readonly transactionInfo: {
|
|
2774
|
+
readonly description: "Доп. служебные данные транзакции.";
|
|
2775
|
+
readonly valueSchema: "TransactionInfo";
|
|
2776
|
+
};
|
|
2777
|
+
readonly id: {
|
|
2778
|
+
readonly description: "ID транзакции.";
|
|
2779
|
+
readonly valueSchema: "string | null";
|
|
2780
|
+
};
|
|
2781
|
+
readonly meta: {
|
|
2782
|
+
readonly description: "Мета (`version`, даты изменения и т.д.).";
|
|
2783
|
+
readonly valueSchema: "ObjectInfo";
|
|
2784
|
+
};
|
|
2785
|
+
};
|
|
2786
|
+
declare const accountingTransactionFieldDocs: {
|
|
2787
|
+
readonly accountId: string;
|
|
2788
|
+
readonly transactionDate: string;
|
|
2789
|
+
readonly state: string;
|
|
2790
|
+
readonly type: string;
|
|
2791
|
+
readonly transactionValues: string;
|
|
2792
|
+
readonly comment: string;
|
|
2793
|
+
readonly operationCategory: string;
|
|
2794
|
+
readonly operationCategoryName: string;
|
|
2795
|
+
readonly validityDate: string;
|
|
2796
|
+
readonly transactionInfo: string;
|
|
2797
|
+
readonly id: string;
|
|
2798
|
+
readonly meta: string;
|
|
2799
|
+
};
|
|
2800
|
+
declare const balanceValueFieldDocEntries: {
|
|
2801
|
+
readonly productId: {
|
|
2802
|
+
readonly description: "ID продукта/балансовой позиции.";
|
|
2803
|
+
readonly valueSchema: "int32";
|
|
2804
|
+
};
|
|
2805
|
+
readonly amount: {
|
|
2806
|
+
readonly description: "Количество/сумма в этой позиции.";
|
|
2807
|
+
readonly valueSchema: "double | null";
|
|
2808
|
+
};
|
|
2809
|
+
readonly productName: {
|
|
2810
|
+
readonly description: "Название продукта/единицы баланса.";
|
|
2811
|
+
readonly valueSchema: "string | null";
|
|
2812
|
+
};
|
|
2813
|
+
};
|
|
2814
|
+
declare const balanceValueFieldDocs: {
|
|
2815
|
+
readonly productId: string;
|
|
2816
|
+
readonly amount: string;
|
|
2817
|
+
readonly productName: string;
|
|
2818
|
+
};
|
|
2819
|
+
declare const actionHistoryInfoFieldDocEntries: {
|
|
2820
|
+
readonly actionHistoryType: {
|
|
2821
|
+
readonly description: "Тип действия в истории.";
|
|
2822
|
+
readonly valueSchema: "ActionHistoryType";
|
|
2823
|
+
};
|
|
2824
|
+
readonly state: {
|
|
2825
|
+
readonly description: "Состояние записи истории.";
|
|
2826
|
+
readonly valueSchema: "ActionHistoryState";
|
|
2827
|
+
};
|
|
2828
|
+
readonly userMessage: {
|
|
2829
|
+
readonly description: "Пользовательское сообщение (если передавалось в операции).";
|
|
2830
|
+
readonly valueSchema: "string | null";
|
|
2831
|
+
};
|
|
2832
|
+
readonly text: {
|
|
2833
|
+
readonly description: "Системный/локализованный текст события.";
|
|
2834
|
+
readonly valueSchema: "string | null";
|
|
2835
|
+
};
|
|
2836
|
+
readonly userProfileView: {
|
|
2837
|
+
readonly description: "Профиль пользователя, инициировавшего действие.";
|
|
2838
|
+
readonly valueSchema: "ContactView";
|
|
2839
|
+
};
|
|
2840
|
+
readonly correspondentProfileViewList: {
|
|
2841
|
+
readonly description: "Профили корреспондентов/получателей события.";
|
|
2842
|
+
readonly valueSchema: "ContactView[] | null";
|
|
2843
|
+
};
|
|
2844
|
+
readonly id: {
|
|
2845
|
+
readonly description: "ID записи action-history.";
|
|
2846
|
+
readonly valueSchema: "string | null";
|
|
2847
|
+
};
|
|
2848
|
+
readonly meta: {
|
|
2849
|
+
readonly description: "Метаобъект записи.";
|
|
2850
|
+
readonly valueSchema: "ObjectInfo";
|
|
2851
|
+
};
|
|
2852
|
+
};
|
|
2853
|
+
declare const actionHistoryInfoFieldDocs: {
|
|
2854
|
+
readonly actionHistoryType: string;
|
|
2855
|
+
readonly state: string;
|
|
2856
|
+
readonly userMessage: string;
|
|
2857
|
+
readonly text: string;
|
|
2858
|
+
readonly userProfileView: string;
|
|
2859
|
+
readonly correspondentProfileViewList: string;
|
|
2860
|
+
readonly id: string;
|
|
2861
|
+
readonly meta: string;
|
|
2862
|
+
};
|
|
2863
|
+
declare const announcementInfoFieldDocEntries: {
|
|
2864
|
+
readonly type: {
|
|
2865
|
+
readonly description: "Тип анонса (share, grant access, create order, ...).";
|
|
2866
|
+
readonly valueSchema: "AnnouncementType";
|
|
2867
|
+
};
|
|
2868
|
+
readonly state: {
|
|
2869
|
+
readonly description: "Состояние анонса (`New`, `Read`, `Hidden`).";
|
|
2870
|
+
readonly valueSchema: "AnnouncementState";
|
|
2871
|
+
};
|
|
2872
|
+
readonly category: {
|
|
2873
|
+
readonly description: "Категория визуализации (`Action`, `Alert`, `Reminder`, ...).";
|
|
2874
|
+
readonly valueSchema: "AnnouncementCategory";
|
|
2875
|
+
};
|
|
2876
|
+
readonly priority: {
|
|
2877
|
+
readonly description: "Приоритет показа (`Low`, `Normal`, `High`).";
|
|
2878
|
+
readonly valueSchema: "AnnouncementPriority";
|
|
2879
|
+
};
|
|
2880
|
+
readonly senderProfileView: {
|
|
2881
|
+
readonly description: "Профиль отправителя анонса.";
|
|
2882
|
+
readonly valueSchema: "ContactView";
|
|
2883
|
+
};
|
|
2884
|
+
readonly recipientProfileView: {
|
|
2885
|
+
readonly description: "Профиль получателя анонса.";
|
|
2886
|
+
readonly valueSchema: "ContactView";
|
|
2887
|
+
};
|
|
2888
|
+
readonly userMessage: {
|
|
2889
|
+
readonly description: "Сообщение пользователя (если источник события его содержал).";
|
|
2890
|
+
readonly valueSchema: "string | null";
|
|
2891
|
+
};
|
|
2892
|
+
readonly text: {
|
|
2893
|
+
readonly description: "Итоговый текст уведомления для ленты.";
|
|
2894
|
+
readonly valueSchema: "string | null";
|
|
2895
|
+
};
|
|
2896
|
+
readonly creationDate: {
|
|
2897
|
+
readonly description: "Дата создания уведомления.";
|
|
2898
|
+
readonly valueSchema: "date-time string | null";
|
|
2899
|
+
};
|
|
2900
|
+
readonly id: {
|
|
2901
|
+
readonly description: "ID уведомления.";
|
|
2902
|
+
readonly valueSchema: "string | null";
|
|
2903
|
+
};
|
|
2904
|
+
readonly meta: {
|
|
2905
|
+
readonly description: "Метаобъект уведомления.";
|
|
2906
|
+
readonly valueSchema: "ObjectInfo";
|
|
2907
|
+
};
|
|
2908
|
+
};
|
|
2909
|
+
declare const announcementInfoFieldDocs: {
|
|
2910
|
+
readonly type: string;
|
|
2911
|
+
readonly state: string;
|
|
2912
|
+
readonly category: string;
|
|
2913
|
+
readonly priority: string;
|
|
2914
|
+
readonly senderProfileView: string;
|
|
2915
|
+
readonly recipientProfileView: string;
|
|
2916
|
+
readonly userMessage: string;
|
|
2917
|
+
readonly text: string;
|
|
2918
|
+
readonly creationDate: string;
|
|
2919
|
+
readonly id: string;
|
|
2920
|
+
readonly meta: string;
|
|
2921
|
+
};
|
|
2922
|
+
declare const updateAnnouncementStateReqFieldDocEntries: {
|
|
2923
|
+
readonly newState: {
|
|
2924
|
+
readonly description: "Новое состояние уведомления (`Read`/`Hidden`/...).";
|
|
2925
|
+
readonly valueSchema: "AnnouncementState";
|
|
2926
|
+
};
|
|
2927
|
+
readonly announcementId: {
|
|
2928
|
+
readonly description: "ID анонса, состояние которого обновляют.";
|
|
2929
|
+
readonly valueSchema: "string | null";
|
|
2930
|
+
};
|
|
2931
|
+
};
|
|
2932
|
+
declare const updateAnnouncementStateReqFieldDocs: {
|
|
2933
|
+
readonly newState: string;
|
|
2934
|
+
readonly announcementId: string;
|
|
2935
|
+
};
|
|
2936
|
+
declare const exportRequestFieldDocEntries: {
|
|
2937
|
+
readonly itemId: {
|
|
2938
|
+
readonly description: "Корневой item для экспорта подграфа.";
|
|
2939
|
+
readonly valueSchema: "string | null";
|
|
2940
|
+
};
|
|
2941
|
+
readonly depth: {
|
|
2942
|
+
readonly description: "Глубина обхода связей при экспорте.";
|
|
2943
|
+
readonly valueSchema: "int32 | null";
|
|
2944
|
+
};
|
|
2945
|
+
};
|
|
2946
|
+
declare const exportRequestFieldDocs: {
|
|
2947
|
+
readonly itemId: string;
|
|
2948
|
+
readonly depth: string;
|
|
2949
|
+
};
|
|
2950
|
+
declare const exportGraphFieldDocEntries: {
|
|
2951
|
+
readonly rootId: {
|
|
2952
|
+
readonly description: "ID корневого элемента экспортированного графа.";
|
|
2953
|
+
readonly valueSchema: "string | null";
|
|
2954
|
+
};
|
|
2955
|
+
readonly items: {
|
|
2956
|
+
readonly description: "Снимок элементов подграфа (узлы).";
|
|
2957
|
+
readonly valueSchema: "TorrowItem[] | null";
|
|
2958
|
+
};
|
|
2959
|
+
readonly views: {
|
|
2960
|
+
readonly description: "Экспортированные представления (views) для элементов графа.";
|
|
2961
|
+
readonly valueSchema: "ItemView[] | null";
|
|
2962
|
+
};
|
|
2963
|
+
readonly timetableCases: {
|
|
2964
|
+
readonly description: "Связанные записи расписания/кейсы, попавшие в экспорт.";
|
|
2965
|
+
readonly valueSchema: "TimetableCase[] | null";
|
|
2966
|
+
};
|
|
2967
|
+
};
|
|
2968
|
+
declare const exportGraphFieldDocs: {
|
|
2969
|
+
readonly rootId: string;
|
|
2970
|
+
readonly items: string;
|
|
2971
|
+
readonly views: string;
|
|
2972
|
+
readonly timetableCases: string;
|
|
2973
|
+
};
|
|
2974
|
+
declare const importByFileRequestFieldDocEntries: {
|
|
2975
|
+
readonly exportGraph: {
|
|
2976
|
+
readonly description: "Граф, ранее полученный через export API.";
|
|
2977
|
+
readonly valueSchema: "ExportGraph";
|
|
2978
|
+
};
|
|
2979
|
+
readonly parentId: {
|
|
2980
|
+
readonly description: "Куда импортировать корень графа.";
|
|
2981
|
+
readonly valueSchema: "string | null";
|
|
2982
|
+
};
|
|
2983
|
+
readonly profileId: {
|
|
2984
|
+
readonly description: "Профиль-владелец для импортируемых объектов.";
|
|
2985
|
+
readonly valueSchema: "string | null";
|
|
2986
|
+
};
|
|
2987
|
+
readonly withoutRoot: {
|
|
2988
|
+
readonly description: "Импортировать только дочерние узлы графа без корня.";
|
|
2989
|
+
readonly valueSchema: "boolean | null";
|
|
2990
|
+
};
|
|
2991
|
+
readonly notDuplicateRoot: {
|
|
2992
|
+
readonly description: "Не дублировать root, если уже существует.";
|
|
2993
|
+
readonly valueSchema: "boolean | null";
|
|
2994
|
+
};
|
|
2995
|
+
};
|
|
2996
|
+
declare const importByFileRequestFieldDocs: {
|
|
2997
|
+
readonly exportGraph: string;
|
|
2998
|
+
readonly parentId: string;
|
|
2999
|
+
readonly profileId: string;
|
|
3000
|
+
readonly withoutRoot: string;
|
|
3001
|
+
readonly notDuplicateRoot: string;
|
|
3002
|
+
};
|
|
3003
|
+
declare const importByUniqueNameRequestFieldDocEntries: {
|
|
3004
|
+
readonly uniqueName: {
|
|
3005
|
+
readonly description: "Уникальное имя экспортированного набора/корня.";
|
|
3006
|
+
readonly valueSchema: "string | null";
|
|
3007
|
+
};
|
|
3008
|
+
readonly depth: {
|
|
3009
|
+
readonly description: "Глубина импортируемого подграфа.";
|
|
3010
|
+
readonly valueSchema: "int32 | null";
|
|
3011
|
+
};
|
|
3012
|
+
readonly parentId: {
|
|
3013
|
+
readonly description: "Родитель, куда включают импортированный граф.";
|
|
3014
|
+
readonly valueSchema: "string | null";
|
|
3015
|
+
};
|
|
3016
|
+
readonly profileId: {
|
|
3017
|
+
readonly description: "Профиль контекста импорта.";
|
|
3018
|
+
readonly valueSchema: "string | null";
|
|
3019
|
+
};
|
|
3020
|
+
readonly withoutRoot: {
|
|
3021
|
+
readonly description: "Импорт без корневого узла.";
|
|
3022
|
+
readonly valueSchema: "boolean | null";
|
|
3023
|
+
};
|
|
3024
|
+
readonly notDuplicateRoot: {
|
|
3025
|
+
readonly description: "Не создавать дубль root при совпадении.";
|
|
3026
|
+
readonly valueSchema: "boolean | null";
|
|
3027
|
+
};
|
|
3028
|
+
};
|
|
3029
|
+
declare const importByUniqueNameRequestFieldDocs: {
|
|
3030
|
+
readonly uniqueName: string;
|
|
3031
|
+
readonly depth: string;
|
|
3032
|
+
readonly parentId: string;
|
|
3033
|
+
readonly profileId: string;
|
|
3034
|
+
readonly withoutRoot: string;
|
|
3035
|
+
readonly notDuplicateRoot: string;
|
|
3036
|
+
};
|
|
3037
|
+
declare const generateReportReqFieldDocEntries: {
|
|
3038
|
+
readonly options: {
|
|
3039
|
+
readonly description: "Опции доставки/локали отчёта.";
|
|
3040
|
+
readonly valueSchema: "ReportOptions";
|
|
3041
|
+
};
|
|
3042
|
+
readonly properties: {
|
|
3043
|
+
readonly description: "Параметры формирования отчёта (контракт API).";
|
|
3044
|
+
readonly valueSchema: "ReportProperties";
|
|
3045
|
+
};
|
|
3046
|
+
};
|
|
3047
|
+
declare const generateReportReqFieldDocs: {
|
|
3048
|
+
readonly options: string;
|
|
3049
|
+
readonly properties: string;
|
|
3050
|
+
};
|
|
3051
|
+
declare const reportPropertiesFieldDocEntries: {
|
|
3052
|
+
readonly fakeForTsGeneratorDoNotRemove: {
|
|
3053
|
+
readonly description: "Техническое поле OpenAPI для генератора типов. В бизнес-логике отчётов не используется и обычно не передаётся.";
|
|
3054
|
+
readonly valueSchema: "int32 | null";
|
|
3055
|
+
};
|
|
3056
|
+
};
|
|
3057
|
+
declare const reportPropertiesFieldDocs: {
|
|
3058
|
+
readonly fakeForTsGeneratorDoNotRemove: string;
|
|
3059
|
+
};
|
|
3060
|
+
declare const reportOptionsFieldDocEntries: {
|
|
3061
|
+
readonly reportDeliveryType: {
|
|
3062
|
+
readonly description: "Способ доставки отчёта: `Link` или `Email`.";
|
|
3063
|
+
readonly valueSchema: "ReportDeliveryType";
|
|
3064
|
+
};
|
|
3065
|
+
readonly reportDeliveryAddresses: {
|
|
3066
|
+
readonly description: "Email-адреса получателей, если доставка через Email.";
|
|
3067
|
+
readonly valueSchema: "string[] | null";
|
|
3068
|
+
};
|
|
3069
|
+
readonly language: {
|
|
3070
|
+
readonly description: "Язык отчёта (обычно BCP-47, напр. `ru`, `en`).";
|
|
3071
|
+
readonly valueSchema: "string";
|
|
3072
|
+
};
|
|
3073
|
+
readonly timeZone: {
|
|
3074
|
+
readonly description: "Таймзона для дат отчёта (в приложении используется локальная IANA зона пользователя).";
|
|
3075
|
+
readonly valueSchema: "string";
|
|
3076
|
+
readonly examples: readonly ["Europe/Moscow", "UTC"];
|
|
3077
|
+
};
|
|
3078
|
+
};
|
|
3079
|
+
declare const reportOptionsFieldDocs: {
|
|
3080
|
+
readonly reportDeliveryType: string;
|
|
3081
|
+
readonly reportDeliveryAddresses: string;
|
|
3082
|
+
readonly language: string;
|
|
3083
|
+
readonly timeZone: string;
|
|
3084
|
+
};
|
|
3085
|
+
declare const generateReportRespFieldDocEntries: {
|
|
3086
|
+
readonly reportLink: {
|
|
3087
|
+
readonly description: "Ссылка на готовый отчёт.";
|
|
3088
|
+
readonly valueSchema: "string | null";
|
|
3089
|
+
};
|
|
3090
|
+
readonly expirationTime: {
|
|
3091
|
+
readonly description: "Срок действия ссылки на отчёт.";
|
|
3092
|
+
readonly valueSchema: "date-time string | null";
|
|
3093
|
+
};
|
|
3094
|
+
};
|
|
3095
|
+
declare const generateReportRespFieldDocs: {
|
|
3096
|
+
readonly reportLink: string;
|
|
3097
|
+
readonly expirationTime: string;
|
|
3098
|
+
};
|
|
3099
|
+
declare const loyaltyCardSubscriptionFieldDocEntries: {
|
|
3100
|
+
readonly subscriptionId: {
|
|
3101
|
+
readonly description: "ID подписки карты лояльности.";
|
|
3102
|
+
readonly valueSchema: "string | null";
|
|
3103
|
+
};
|
|
3104
|
+
readonly name: {
|
|
3105
|
+
readonly description: "Название подписки (тариф/пакет).";
|
|
3106
|
+
readonly valueSchema: "string | null";
|
|
3107
|
+
};
|
|
3108
|
+
readonly state: {
|
|
3109
|
+
readonly description: "Состояние подписки (int-код API).";
|
|
3110
|
+
readonly valueSchema: "int32";
|
|
3111
|
+
};
|
|
3112
|
+
readonly createDate: {
|
|
3113
|
+
readonly description: "Дата создания подписки.";
|
|
3114
|
+
readonly valueSchema: "date-time string | null";
|
|
3115
|
+
};
|
|
3116
|
+
readonly beginDate: {
|
|
3117
|
+
readonly description: "Дата начала действия подписки.";
|
|
3118
|
+
readonly valueSchema: "date-time string | null";
|
|
3119
|
+
};
|
|
3120
|
+
readonly endDate: {
|
|
3121
|
+
readonly description: "Дата окончания действия подписки.";
|
|
3122
|
+
readonly valueSchema: "date-time string | null";
|
|
3123
|
+
};
|
|
3124
|
+
readonly caseParticipantId: {
|
|
3125
|
+
readonly description: "ID участника кейса, на основе которого создана подписка.";
|
|
3126
|
+
readonly valueSchema: "string | null";
|
|
3127
|
+
};
|
|
3128
|
+
readonly image: {
|
|
3129
|
+
readonly description: "Изображение/иконка подписки.";
|
|
3130
|
+
readonly valueSchema: "FileInfo";
|
|
3131
|
+
};
|
|
3132
|
+
};
|
|
3133
|
+
declare const loyaltyCardSubscriptionFieldDocs: {
|
|
3134
|
+
readonly subscriptionId: string;
|
|
3135
|
+
readonly name: string;
|
|
3136
|
+
readonly state: string;
|
|
3137
|
+
readonly createDate: string;
|
|
3138
|
+
readonly beginDate: string;
|
|
3139
|
+
readonly endDate: string;
|
|
3140
|
+
readonly caseParticipantId: string;
|
|
3141
|
+
readonly image: string;
|
|
3142
|
+
};
|
|
3143
|
+
declare const loyaltySystemsStatisticsReqFieldDocEntries: {
|
|
3144
|
+
readonly loyaltySystemIdList: {
|
|
3145
|
+
readonly description: "Список программ лояльности, по которым считают агрегаты.";
|
|
3146
|
+
readonly valueSchema: "string[]";
|
|
3147
|
+
};
|
|
3148
|
+
readonly name: {
|
|
3149
|
+
readonly description: "Имя набора статистики/среза (лейбл запроса).";
|
|
3150
|
+
readonly valueSchema: "string";
|
|
3151
|
+
};
|
|
3152
|
+
readonly filterList: {
|
|
3153
|
+
readonly description: "Фильтры карт/подписок для статистики.";
|
|
3154
|
+
readonly valueSchema: "LoyaltyCardFilterCondition[] | null";
|
|
3155
|
+
};
|
|
3156
|
+
readonly includeDeleted: {
|
|
3157
|
+
readonly description: "Включать удалённые объекты в расчёт.";
|
|
3158
|
+
readonly valueSchema: "boolean | null";
|
|
3159
|
+
};
|
|
3160
|
+
readonly take: {
|
|
3161
|
+
readonly description: "Лимит элементов при расчёте.";
|
|
3162
|
+
readonly valueSchema: "int32 | null";
|
|
3163
|
+
};
|
|
3164
|
+
readonly skip: {
|
|
3165
|
+
readonly description: "Смещение для пакетной обработки.";
|
|
3166
|
+
readonly valueSchema: "int32 | null";
|
|
3167
|
+
};
|
|
3168
|
+
readonly lastModifiedFrom: {
|
|
3169
|
+
readonly description: "Нижняя граница по дате изменения.";
|
|
3170
|
+
readonly valueSchema: "date-time string | null";
|
|
3171
|
+
};
|
|
3172
|
+
readonly lastModifiedTo: {
|
|
3173
|
+
readonly description: "Верхняя граница по дате изменения.";
|
|
3174
|
+
readonly valueSchema: "date-time string | null";
|
|
3175
|
+
};
|
|
3176
|
+
readonly createDateFrom: {
|
|
3177
|
+
readonly description: "Нижняя граница по дате создания.";
|
|
3178
|
+
readonly valueSchema: "date-time string | null";
|
|
3179
|
+
};
|
|
3180
|
+
readonly createDateTo: {
|
|
3181
|
+
readonly description: "Верхняя граница по дате создания.";
|
|
3182
|
+
readonly valueSchema: "date-time string | null";
|
|
3183
|
+
};
|
|
3184
|
+
};
|
|
3185
|
+
declare const loyaltySystemsStatisticsReqFieldDocs: {
|
|
3186
|
+
readonly loyaltySystemIdList: string;
|
|
3187
|
+
readonly name: string;
|
|
3188
|
+
readonly filterList: string;
|
|
3189
|
+
readonly includeDeleted: string;
|
|
3190
|
+
readonly take: string;
|
|
3191
|
+
readonly skip: string;
|
|
3192
|
+
readonly lastModifiedFrom: string;
|
|
3193
|
+
readonly lastModifiedTo: string;
|
|
3194
|
+
readonly createDateFrom: string;
|
|
3195
|
+
readonly createDateTo: string;
|
|
3196
|
+
};
|
|
3197
|
+
declare const loyaltySystemsStatisticsRespFieldDocEntries: {
|
|
3198
|
+
readonly name: {
|
|
3199
|
+
readonly description: "Имя среза статистики из запроса.";
|
|
3200
|
+
readonly valueSchema: "string | null";
|
|
3201
|
+
};
|
|
3202
|
+
readonly count: {
|
|
3203
|
+
readonly description: "Рассчитанное количество элементов по срезу.";
|
|
3204
|
+
readonly valueSchema: "int32 | null";
|
|
3205
|
+
};
|
|
3206
|
+
};
|
|
3207
|
+
declare const loyaltySystemsStatisticsRespFieldDocs: {
|
|
3208
|
+
readonly name: string;
|
|
3209
|
+
readonly count: string;
|
|
3210
|
+
};
|
|
3211
|
+
declare const getLoyaltySystemsStatisticsReqFieldDocEntries: {
|
|
3212
|
+
readonly loyaltySystemsStatisticsReqList: {
|
|
3213
|
+
readonly description: "Пакет запросов статистики по программам лояльности.";
|
|
3214
|
+
readonly valueSchema: "LoyaltySystemsStatisticsReq[]";
|
|
3215
|
+
};
|
|
3216
|
+
};
|
|
3217
|
+
declare const getLoyaltySystemsStatisticsReqFieldDocs: {
|
|
3218
|
+
readonly loyaltySystemsStatisticsReqList: string;
|
|
3219
|
+
};
|
|
3220
|
+
declare const getLoyaltySystemsStatisticsRespFieldDocEntries: {
|
|
3221
|
+
readonly loyaltySystemsStatisticsRespList: {
|
|
3222
|
+
readonly description: "Пакет ответов статистики по каждому входному срезу.";
|
|
3223
|
+
readonly valueSchema: "LoyaltySystemsStatisticsResp[] | null";
|
|
3224
|
+
};
|
|
3225
|
+
};
|
|
3226
|
+
declare const getLoyaltySystemsStatisticsRespFieldDocs: {
|
|
3227
|
+
readonly loyaltySystemsStatisticsRespList: string;
|
|
3228
|
+
};
|
|
3229
|
+
declare const transactionInfoFieldDocEntries: {
|
|
3230
|
+
readonly basisItem: {
|
|
3231
|
+
readonly description: "Базовый объект-основание транзакции (например кейс/карта/подписка).";
|
|
3232
|
+
readonly valueSchema: "TorrowItem";
|
|
3233
|
+
};
|
|
3234
|
+
};
|
|
3235
|
+
declare const transactionInfoFieldDocs: {
|
|
3236
|
+
readonly basisItem: string;
|
|
3237
|
+
};
|
|
3238
|
+
declare const torrowErrorClientFieldDocEntries: {
|
|
3239
|
+
readonly code: {
|
|
3240
|
+
readonly description: "Код ошибки API.";
|
|
3241
|
+
readonly valueSchema: "int32";
|
|
3242
|
+
};
|
|
3243
|
+
readonly name: {
|
|
3244
|
+
readonly description: "Системное имя ошибки.";
|
|
3245
|
+
readonly valueSchema: "string | null";
|
|
3246
|
+
};
|
|
3247
|
+
readonly message: {
|
|
3248
|
+
readonly description: "Пользовательское сообщение ошибки.";
|
|
3249
|
+
readonly valueSchema: "string | null";
|
|
3250
|
+
};
|
|
3251
|
+
readonly systemMessage: {
|
|
3252
|
+
readonly description: "Техническое сообщение сервера.";
|
|
3253
|
+
readonly valueSchema: "string | null";
|
|
3254
|
+
};
|
|
3255
|
+
readonly innerError: {
|
|
3256
|
+
readonly description: "Вложенная причина ошибки.";
|
|
3257
|
+
readonly valueSchema: "TorrowErrorClient";
|
|
3258
|
+
};
|
|
3259
|
+
readonly traceUrl: {
|
|
3260
|
+
readonly description: "URL трейса/диагностики (если включено на сервере).";
|
|
3261
|
+
readonly valueSchema: "string | null";
|
|
3262
|
+
};
|
|
3263
|
+
readonly traceIdentifier: {
|
|
3264
|
+
readonly description: "Идентификатор трассировки для саппорта.";
|
|
3265
|
+
readonly valueSchema: "string | null";
|
|
3266
|
+
};
|
|
3267
|
+
readonly parameters: {
|
|
3268
|
+
readonly description: "Параметры ошибки (ключ-значение).";
|
|
3269
|
+
readonly valueSchema: "Record<string, string | null> | null";
|
|
3270
|
+
};
|
|
3271
|
+
};
|
|
3272
|
+
declare const torrowErrorClientFieldDocs: {
|
|
3273
|
+
readonly code: string;
|
|
3274
|
+
readonly name: string;
|
|
3275
|
+
readonly message: string;
|
|
3276
|
+
readonly systemMessage: string;
|
|
3277
|
+
readonly innerError: string;
|
|
3278
|
+
readonly traceUrl: string;
|
|
3279
|
+
readonly traceIdentifier: string;
|
|
3280
|
+
readonly parameters: string;
|
|
3281
|
+
};
|
|
3282
|
+
declare const getParticipationCountRespFieldDocEntries: {
|
|
3283
|
+
readonly count: {
|
|
3284
|
+
readonly description: "Количество участников по текущему фильтру.";
|
|
3285
|
+
readonly valueSchema: "int32";
|
|
3286
|
+
};
|
|
3287
|
+
readonly isExactValue: {
|
|
3288
|
+
readonly description: "Точное ли это значение (`false` — сервер мог вернуть приближённую оценку).";
|
|
3289
|
+
readonly valueSchema: "boolean";
|
|
3290
|
+
};
|
|
3291
|
+
};
|
|
3292
|
+
declare const getParticipationCountRespFieldDocs: {
|
|
3293
|
+
readonly count: string;
|
|
3294
|
+
readonly isExactValue: string;
|
|
3295
|
+
};
|
|
3296
|
+
declare const fileInfoFieldDocEntries: {
|
|
3297
|
+
readonly id: {
|
|
3298
|
+
readonly description: "ID файла в хранилище.";
|
|
3299
|
+
readonly valueSchema: "string | null";
|
|
3300
|
+
};
|
|
3301
|
+
readonly url: {
|
|
3302
|
+
readonly description: "Текущий URL файла (может быть временным).";
|
|
3303
|
+
readonly valueSchema: "string | null";
|
|
3304
|
+
};
|
|
3305
|
+
readonly urlExpiration: {
|
|
3306
|
+
readonly description: "Срок действия `url`.";
|
|
3307
|
+
readonly valueSchema: "date-time string | null";
|
|
3308
|
+
};
|
|
3309
|
+
readonly eTag: {
|
|
3310
|
+
readonly description: "ETag файла для кеша/валидации.";
|
|
3311
|
+
readonly valueSchema: "string | null";
|
|
3312
|
+
};
|
|
3313
|
+
readonly fileName: {
|
|
3314
|
+
readonly description: "Имя файла.";
|
|
3315
|
+
readonly valueSchema: "string | null";
|
|
3316
|
+
};
|
|
3317
|
+
readonly fileSize: {
|
|
3318
|
+
readonly description: "Размер файла в байтах.";
|
|
3319
|
+
readonly valueSchema: "int64 | null";
|
|
3320
|
+
};
|
|
3321
|
+
readonly refreshUrl: {
|
|
3322
|
+
readonly description: "URL для обновления/рефреша ссылки.";
|
|
3323
|
+
readonly valueSchema: "string | null";
|
|
3324
|
+
};
|
|
3325
|
+
};
|
|
3326
|
+
declare const fileInfoFieldDocs: {
|
|
3327
|
+
readonly id: string;
|
|
3328
|
+
readonly url: string;
|
|
3329
|
+
readonly urlExpiration: string;
|
|
3330
|
+
readonly eTag: string;
|
|
3331
|
+
readonly fileName: string;
|
|
3332
|
+
readonly fileSize: string;
|
|
3333
|
+
readonly refreshUrl: string;
|
|
3334
|
+
};
|
|
3335
|
+
declare const putUrlRespFieldDocEntries: {
|
|
3336
|
+
readonly url: {
|
|
3337
|
+
readonly description: "Presigned URL для загрузки файла.";
|
|
3338
|
+
readonly valueSchema: "string | null";
|
|
3339
|
+
};
|
|
3340
|
+
readonly urlExpiration: {
|
|
3341
|
+
readonly description: "Срок действия presigned URL.";
|
|
3342
|
+
readonly valueSchema: "date-time string";
|
|
3343
|
+
};
|
|
3344
|
+
};
|
|
3345
|
+
declare const putUrlRespFieldDocs: {
|
|
3346
|
+
readonly url: string;
|
|
3347
|
+
readonly urlExpiration: string;
|
|
3348
|
+
};
|
|
3349
|
+
declare const updateFileIdRespFieldDocEntries: {
|
|
3350
|
+
readonly fileInfo: {
|
|
3351
|
+
readonly description: "Актуальная информация о привязанном файле.";
|
|
3352
|
+
readonly valueSchema: "FileInfo";
|
|
3353
|
+
};
|
|
3354
|
+
readonly meta: {
|
|
3355
|
+
readonly description: "Мета объекта после обновления file id.";
|
|
3356
|
+
readonly valueSchema: "ObjectInfo";
|
|
3357
|
+
};
|
|
3358
|
+
};
|
|
3359
|
+
declare const updateFileIdRespFieldDocs: {
|
|
3360
|
+
readonly fileInfo: string;
|
|
3361
|
+
readonly meta: string;
|
|
3362
|
+
};
|
|
3363
|
+
|
|
3364
|
+
declare const searchSdkMethodFieldDocEntries: {
|
|
3365
|
+
readonly advisedItems: {
|
|
3366
|
+
readonly description: "`GET /api/v1/search/adviseditems` — подборка **`TorrowItem`** (тип, гео, язык, пагинация).";
|
|
3367
|
+
readonly usage: "Рекомендации рядом с точкой / общий каталог — по политике продукта.";
|
|
3368
|
+
};
|
|
3369
|
+
readonly orders: {
|
|
3370
|
+
readonly description: "`PUT /api/v1/search/{torrowId}/orders` — список представлений заказов (**`CaseView[]`**) под родителем с **`OrderFilter`** в теле.";
|
|
3371
|
+
readonly usage: "Альтернатива **`client.raw.put`**; см. **`examples/node/raw/24-search-orders-raw.ts`** и **`78-search-contacts.ts`**.";
|
|
3372
|
+
};
|
|
3373
|
+
readonly contacts: {
|
|
3374
|
+
readonly description: "`GET /api/v1/search/contacts` — **`ContactView[]`** по тексту и опциям.";
|
|
3375
|
+
};
|
|
3376
|
+
readonly notes: {
|
|
3377
|
+
readonly description: "`GET /api/v1/search/notes` — **`NoteView[]`**.";
|
|
3378
|
+
};
|
|
3379
|
+
readonly calendars: {
|
|
3380
|
+
readonly description: "`GET /api/v1/search/calendars` — **`CalendarView[]`**.";
|
|
3381
|
+
};
|
|
3382
|
+
readonly cases: {
|
|
3383
|
+
readonly description: "`GET /api/v1/search/cases` — **`CaseView[]`**.";
|
|
3384
|
+
};
|
|
3385
|
+
readonly resources: {
|
|
3386
|
+
readonly description: "`GET /api/v1/search/resources` — **`ResourceView[]`**.";
|
|
3387
|
+
};
|
|
3388
|
+
readonly services: {
|
|
3389
|
+
readonly description: "`GET /api/v1/search/services` — **`ServiceView[]`**.";
|
|
3390
|
+
};
|
|
3391
|
+
};
|
|
3392
|
+
declare const searchSdkMethodFieldDocs: {
|
|
3393
|
+
readonly advisedItems: string;
|
|
3394
|
+
readonly orders: string;
|
|
3395
|
+
readonly contacts: string;
|
|
3396
|
+
readonly notes: string;
|
|
3397
|
+
readonly calendars: string;
|
|
3398
|
+
readonly cases: string;
|
|
3399
|
+
readonly resources: string;
|
|
3400
|
+
readonly services: string;
|
|
3401
|
+
};
|
|
3402
|
+
declare const orderFilterFieldDocEntries: {
|
|
3403
|
+
readonly searchText: {
|
|
3404
|
+
readonly description: "Подстрока для фильтрации заказов (семантика на стороне API).";
|
|
3405
|
+
};
|
|
3406
|
+
readonly fuzzyDistance: {
|
|
3407
|
+
readonly description: "Допуск «размытия» для текстового поиска (int).";
|
|
3408
|
+
};
|
|
3409
|
+
readonly from: {
|
|
3410
|
+
readonly description: "Начало интервала по времени (**ISO date-time**).";
|
|
3411
|
+
};
|
|
3412
|
+
readonly to: {
|
|
3413
|
+
readonly description: "Конец интервала (**ISO date-time**).";
|
|
3414
|
+
};
|
|
3415
|
+
readonly strictlyInTimeRange: {
|
|
3416
|
+
readonly description: "Если true — строго внутри интервала.";
|
|
3417
|
+
};
|
|
3418
|
+
readonly orderStateList: {
|
|
3419
|
+
readonly description: "Список **`CaseState`** для фильтра.";
|
|
3420
|
+
readonly valueSchema: "CaseState";
|
|
3421
|
+
};
|
|
3422
|
+
readonly orderTypeList: {
|
|
3423
|
+
readonly description: "Список **`CaseType`** для фильтра.";
|
|
3424
|
+
readonly valueSchema: "CaseType";
|
|
3425
|
+
};
|
|
3426
|
+
};
|
|
3427
|
+
declare const orderFilterFieldDocs: {
|
|
3428
|
+
readonly searchText: string;
|
|
3429
|
+
readonly fuzzyDistance: string;
|
|
3430
|
+
readonly from: string;
|
|
3431
|
+
readonly to: string;
|
|
3432
|
+
readonly strictlyInTimeRange: string;
|
|
3433
|
+
readonly orderStateList: string;
|
|
3434
|
+
readonly orderTypeList: string;
|
|
3435
|
+
};
|
|
3436
|
+
|
|
3437
|
+
declare const viewsSdkMethodFieldDocEntries: {
|
|
3438
|
+
readonly listUserForParent: {
|
|
3439
|
+
readonly description: "`GET /api/v1/{domain}/{parentId}/views/user`. Список пользовательских представлений дочерних элементов под родителем (mind map). Query: `tags`, `take`, `skip`, `lmFrom`, `lmTo`, `includeDeleted`, `sort`. Ответ: массив `*View` по домену (`ContactView`, `NoteView`, …).";
|
|
3440
|
+
readonly valueSchema: "ViewListQuery → DomainViewMap[domain][]";
|
|
3441
|
+
};
|
|
3442
|
+
readonly createUserViews: {
|
|
3443
|
+
readonly description: "`POST /api/v1/{domain}/{parentId}/views/user`. Тело: `CreateViewListReq`. Ответ: `CreateViewListResp` с `createdViewInfoList`.";
|
|
3444
|
+
readonly valueSchema: "CreateViewListReq → CreateViewListResp";
|
|
3445
|
+
};
|
|
3446
|
+
readonly listUserAll: {
|
|
3447
|
+
readonly description: "`GET /api/v1/{domain}/views/user`. Все пользовательские представления по типу элемента без фильтра по одному `parentId`. Query: `take`, `skip`, `lmFrom`, `lmTo`, `includeDeleted`, `sort`.";
|
|
3448
|
+
readonly valueSchema: "ViewListRootQuery → DomainViewMap[domain][]";
|
|
3449
|
+
};
|
|
3450
|
+
readonly getUserView: {
|
|
3451
|
+
readonly description: "`GET /api/v1/{domain}/{parentId}/views/user/{childId}`. Одно представление.";
|
|
3452
|
+
readonly valueSchema: "→ DomainViewMap[domain]";
|
|
3453
|
+
};
|
|
3454
|
+
readonly deleteUserView: {
|
|
3455
|
+
readonly description: "`DELETE /api/v1/{domain}/{parentId}/views/user/{childId}`. Удалить представление пользователя (убрать узел из mind map под родителем). Ответ: `DeleteResponse`.";
|
|
3456
|
+
readonly valueSchema: "→ DeleteResponse";
|
|
3457
|
+
};
|
|
3458
|
+
readonly createPinnedViews: {
|
|
3459
|
+
readonly description: "`POST /api/v1/{domain}/{parentId}/views/pinned`. Создать закреплённые представления. Тело: `CreateViewListReq`.";
|
|
3460
|
+
readonly valueSchema: "CreateViewListReq → CreateViewListResp";
|
|
3461
|
+
};
|
|
3462
|
+
readonly listPinnedForParent: {
|
|
3463
|
+
readonly description: "`GET /api/v1/{domain}/{parentId}/views/pinned`. Список закреплённых; query как у `listUserForParent`.";
|
|
3464
|
+
readonly valueSchema: "ViewListQuery → DomainViewMap[domain][]";
|
|
3465
|
+
};
|
|
3466
|
+
readonly deletePinnedView: {
|
|
3467
|
+
readonly description: "`DELETE .../views/pinned/{childId}`. Снять закрепление через удаление записи закрепления.";
|
|
3468
|
+
readonly valueSchema: "→ DeleteResponse";
|
|
3469
|
+
};
|
|
3470
|
+
readonly getPinnedView: {
|
|
3471
|
+
readonly description: "`GET .../views/pinned/{childId}`.";
|
|
3472
|
+
readonly valueSchema: "→ DomainViewMap[domain]";
|
|
3473
|
+
};
|
|
3474
|
+
readonly updatePinnedOrder: {
|
|
3475
|
+
readonly description: "`POST .../views/pinned/updateorder`. Тело: `UpdateViewListOrderReq`.";
|
|
3476
|
+
readonly valueSchema: "UpdateViewListOrderReq → UpdateViewListOrderResp";
|
|
3477
|
+
};
|
|
3478
|
+
readonly updateUserViewOrder: {
|
|
3479
|
+
readonly description: "`POST .../views/user/updateorder`. Порядок пользовательских представлений.";
|
|
3480
|
+
readonly valueSchema: "UpdateViewListOrderReq → UpdateViewListOrderResp";
|
|
3481
|
+
};
|
|
3482
|
+
readonly pinUserView: {
|
|
3483
|
+
readonly description: "`POST .../views/user/{childId}/pin`. Query `alias`. Ответ: `ObjectInfo`. Закрепить пользовательское представление.";
|
|
3484
|
+
readonly valueSchema: "query alias → ObjectInfo";
|
|
3485
|
+
};
|
|
3486
|
+
readonly unpinUserView: {
|
|
3487
|
+
readonly description: "`POST .../unpin`. Для домена **`contacts`** путь: `.../views/pinned/{childId}/unpin`; для остальных (`notes`, `contexts`, `resources`, `services`, `cases`, `calendars`): `.../views/user/{childId}/unpin`. Query `alias`. Ответ: `ObjectInfo`.";
|
|
3488
|
+
readonly valueSchema: "query alias → ObjectInfo";
|
|
3489
|
+
readonly usage: "Вызывай `TorrowClient.views.unpinUserView` — SDK выбирает сегмент `user` или `pinned` автоматически.";
|
|
3490
|
+
};
|
|
3491
|
+
};
|
|
3492
|
+
declare const createViewListReqFieldDocEntries: {
|
|
3493
|
+
readonly childIdList: {
|
|
3494
|
+
readonly description: "Список id дочерних элементов, для которых создаются представления под выбранным родителем.";
|
|
3495
|
+
readonly valueSchema: "string[] | null";
|
|
3496
|
+
readonly examples: readonly ["[\"550e8400-e29b-41d4-a716-446655440000\"]"];
|
|
3497
|
+
};
|
|
3498
|
+
};
|
|
3499
|
+
declare const createViewListReqFieldDocs: {
|
|
3500
|
+
readonly childIdList: string;
|
|
3501
|
+
};
|
|
3502
|
+
declare const updateViewListOrderReqFieldDocEntries: {
|
|
3503
|
+
readonly orderedViewList: {
|
|
3504
|
+
readonly description: "Новый порядок: пары `childId` и числовой `order` для сортировки в UI.";
|
|
3505
|
+
readonly valueSchema: "ViewOrder[] | null";
|
|
3506
|
+
};
|
|
3507
|
+
};
|
|
3508
|
+
declare const updateViewListOrderReqFieldDocs: {
|
|
3509
|
+
readonly orderedViewList: string;
|
|
3510
|
+
};
|
|
3511
|
+
declare const viewInfoFieldDocEntries: {
|
|
3512
|
+
readonly itemLinkKey: {
|
|
3513
|
+
readonly description: "Ключ связи родитель–потомок для созданного представления.";
|
|
3514
|
+
readonly valueSchema: "ItemLinkKey";
|
|
3515
|
+
};
|
|
3516
|
+
readonly itemLinkInfo: {
|
|
3517
|
+
readonly description: "Мета связи и объекта после операции.";
|
|
3518
|
+
readonly valueSchema: "ObjectInfo";
|
|
3519
|
+
};
|
|
3520
|
+
};
|
|
3521
|
+
declare const viewInfoFieldDocs: {
|
|
3522
|
+
readonly itemLinkKey: string;
|
|
3523
|
+
readonly itemLinkInfo: string;
|
|
3524
|
+
};
|
|
3525
|
+
declare const createViewListRespFieldDocEntries: {
|
|
3526
|
+
readonly createdViewInfoList: {
|
|
3527
|
+
readonly description: "Список созданных view-записей с линками и метаданными.";
|
|
3528
|
+
readonly valueSchema: "ViewInfo[] | null";
|
|
3529
|
+
};
|
|
3530
|
+
};
|
|
3531
|
+
declare const updateViewListOrderRespFieldDocEntries: {
|
|
3532
|
+
readonly updatedViewInfoList: {
|
|
3533
|
+
readonly description: "Список view, для которых успешно обновился `order`.";
|
|
3534
|
+
readonly valueSchema: "ViewInfo[] | null";
|
|
3535
|
+
};
|
|
3536
|
+
};
|
|
3537
|
+
declare const deleteResponseFieldDocEntries: {
|
|
3538
|
+
readonly success: {
|
|
3539
|
+
readonly description: "Флаг успешного удаления view.";
|
|
3540
|
+
readonly valueSchema: "boolean";
|
|
3541
|
+
};
|
|
3542
|
+
readonly deletedCount: {
|
|
3543
|
+
readonly description: "Количество удалённых записей (обычно 1).";
|
|
3544
|
+
readonly valueSchema: "int32";
|
|
3545
|
+
};
|
|
3546
|
+
};
|
|
3547
|
+
declare const viewsSdkMethodFieldDocs: {
|
|
3548
|
+
readonly listUserForParent: string;
|
|
3549
|
+
readonly createUserViews: string;
|
|
3550
|
+
readonly listUserAll: string;
|
|
3551
|
+
readonly getUserView: string;
|
|
3552
|
+
readonly deleteUserView: string;
|
|
3553
|
+
readonly createPinnedViews: string;
|
|
3554
|
+
readonly listPinnedForParent: string;
|
|
3555
|
+
readonly deletePinnedView: string;
|
|
3556
|
+
readonly getPinnedView: string;
|
|
3557
|
+
readonly updatePinnedOrder: string;
|
|
3558
|
+
readonly updateUserViewOrder: string;
|
|
3559
|
+
readonly pinUserView: string;
|
|
3560
|
+
readonly unpinUserView: string;
|
|
3561
|
+
};
|
|
3562
|
+
declare const createViewListRespFieldDocs: {
|
|
3563
|
+
readonly createdViewInfoList: string;
|
|
3564
|
+
};
|
|
3565
|
+
declare const updateViewListOrderRespFieldDocs: {
|
|
3566
|
+
readonly updatedViewInfoList: string;
|
|
3567
|
+
};
|
|
3568
|
+
declare const deleteResponseFieldDocs: {
|
|
3569
|
+
readonly success: string;
|
|
3570
|
+
readonly deletedCount: string;
|
|
3571
|
+
};
|
|
3572
|
+
|
|
3573
|
+
declare const actionHistoryTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3574
|
+
declare const actionHistoryTypeFieldDocs: {
|
|
3575
|
+
[x: string]: string;
|
|
3576
|
+
};
|
|
3577
|
+
declare const actionHistoryStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3578
|
+
declare const actionHistoryStateFieldDocs: {
|
|
3579
|
+
[x: string]: string;
|
|
3580
|
+
};
|
|
3581
|
+
declare const announcementStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3582
|
+
declare const announcementStateFieldDocs: {
|
|
3583
|
+
[x: string]: string;
|
|
3584
|
+
};
|
|
3585
|
+
declare const itemViewSortConditionFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3586
|
+
declare const itemViewSortConditionFieldDocs: {
|
|
3587
|
+
[x: string]: string;
|
|
3588
|
+
};
|
|
3589
|
+
declare const participantTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3590
|
+
declare const participantTypeFieldDocs: {
|
|
3591
|
+
[x: string]: string;
|
|
3592
|
+
};
|
|
3593
|
+
declare const participantStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3594
|
+
declare const participantStateFieldDocs: {
|
|
3595
|
+
[x: string]: string;
|
|
3596
|
+
};
|
|
3597
|
+
declare const accountingTransactionStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3598
|
+
declare const accountingTransactionStateFieldDocs: {
|
|
3599
|
+
[x: string]: string;
|
|
3600
|
+
};
|
|
3601
|
+
declare const operationTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3602
|
+
declare const operationTypeFieldDocs: {
|
|
3603
|
+
[x: string]: string;
|
|
3604
|
+
};
|
|
3605
|
+
declare const torrowObjectTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3606
|
+
declare const torrowObjectTypeFieldDocs: {
|
|
3607
|
+
[x: string]: string;
|
|
3608
|
+
};
|
|
3609
|
+
declare const itemSortConditionFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3610
|
+
declare const itemSortConditionFieldDocs: {
|
|
3611
|
+
[x: string]: string;
|
|
3612
|
+
};
|
|
3613
|
+
declare const objectSortConditionFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3614
|
+
declare const objectSortConditionFieldDocs: {
|
|
3615
|
+
[x: string]: string;
|
|
3616
|
+
};
|
|
3617
|
+
declare const accountTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3618
|
+
declare const accountTypeFieldDocs: {
|
|
3619
|
+
[x: string]: string;
|
|
3620
|
+
};
|
|
3621
|
+
declare const communicationTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3622
|
+
declare const communicationTypeFieldDocs: {
|
|
3623
|
+
[x: string]: string;
|
|
3624
|
+
};
|
|
3625
|
+
declare const accountingTransactionTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3626
|
+
declare const accountingTransactionTypeFieldDocs: {
|
|
3627
|
+
[x: string]: string;
|
|
3628
|
+
};
|
|
3629
|
+
declare const announcementCategoryFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3630
|
+
declare const announcementCategoryFieldDocs: {
|
|
3631
|
+
[x: string]: string;
|
|
3632
|
+
};
|
|
3633
|
+
declare const announcementPriorityFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3634
|
+
declare const announcementPriorityFieldDocs: {
|
|
3635
|
+
[x: string]: string;
|
|
3636
|
+
};
|
|
3637
|
+
declare const announcementTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3638
|
+
declare const announcementTypeFieldDocs: {
|
|
3639
|
+
[x: string]: string;
|
|
3640
|
+
};
|
|
3641
|
+
declare const anyoneAccessFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3642
|
+
declare const anyoneAccessFieldDocs: {
|
|
3643
|
+
[x: string]: string;
|
|
3644
|
+
};
|
|
3645
|
+
declare const archiveStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3646
|
+
declare const archiveStateFieldDocs: {
|
|
3647
|
+
[x: string]: string;
|
|
3648
|
+
};
|
|
3649
|
+
declare const availabilityTimeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3650
|
+
declare const availabilityTimeFieldDocs: {
|
|
3651
|
+
[x: string]: string;
|
|
3652
|
+
};
|
|
3653
|
+
declare const availableResourcesFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3654
|
+
declare const availableResourcesFieldDocs: {
|
|
3655
|
+
[x: string]: string;
|
|
3656
|
+
};
|
|
3657
|
+
declare const caseParticipantStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3658
|
+
declare const caseParticipantStateFieldDocs: {
|
|
3659
|
+
[x: string]: string;
|
|
3660
|
+
};
|
|
3661
|
+
declare const caseParticipantTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3662
|
+
declare const caseParticipantTypeFieldDocs: {
|
|
3663
|
+
[x: string]: string;
|
|
3664
|
+
};
|
|
3665
|
+
declare const caseStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3666
|
+
declare const caseStateFieldDocs: {
|
|
3667
|
+
[x: string]: string;
|
|
3668
|
+
};
|
|
3669
|
+
declare const caseTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3670
|
+
declare const caseTypeFieldDocs: {
|
|
3671
|
+
[x: string]: string;
|
|
3672
|
+
};
|
|
3673
|
+
declare const deleteStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3674
|
+
declare const deleteStateFieldDocs: {
|
|
3675
|
+
[x: string]: string;
|
|
3676
|
+
};
|
|
3677
|
+
declare const deliveryChannelFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3678
|
+
declare const deliveryChannelFieldDocs: {
|
|
3679
|
+
[x: string]: string;
|
|
3680
|
+
};
|
|
3681
|
+
declare const deliveryStrategyFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3682
|
+
declare const deliveryStrategyFieldDocs: {
|
|
3683
|
+
[x: string]: string;
|
|
3684
|
+
};
|
|
3685
|
+
declare const genderFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3686
|
+
declare const genderFieldDocs: {
|
|
3687
|
+
[x: string]: string;
|
|
3688
|
+
};
|
|
3689
|
+
declare const imagePreviewSizeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3690
|
+
declare const imagePreviewSizeFieldDocs: {
|
|
3691
|
+
[x: string]: string;
|
|
3692
|
+
};
|
|
3693
|
+
declare const noteTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3694
|
+
declare const noteTypeFieldDocs: {
|
|
3695
|
+
[x: string]: string;
|
|
3696
|
+
};
|
|
3697
|
+
declare const participationFieldRequirementTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3698
|
+
declare const participationFieldRequirementTypeFieldDocs: {
|
|
3699
|
+
[x: string]: string;
|
|
3700
|
+
};
|
|
3701
|
+
declare const participationFieldTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3702
|
+
declare const participationFieldTypeFieldDocs: {
|
|
3703
|
+
[x: string]: string;
|
|
3704
|
+
};
|
|
3705
|
+
declare const paymentProviderTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3706
|
+
declare const paymentProviderTypeFieldDocs: {
|
|
3707
|
+
[x: string]: string;
|
|
3708
|
+
};
|
|
3709
|
+
declare const profileTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3710
|
+
declare const profileTypeFieldDocs: {
|
|
3711
|
+
[x: string]: string;
|
|
3712
|
+
};
|
|
3713
|
+
declare const profileUserAvailabilityFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3714
|
+
declare const profileUserAvailabilityFieldDocs: {
|
|
3715
|
+
[x: string]: string;
|
|
3716
|
+
};
|
|
3717
|
+
declare const reminderLocationDirectionFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3718
|
+
declare const reminderLocationDirectionFieldDocs: {
|
|
3719
|
+
[x: string]: string;
|
|
3720
|
+
};
|
|
3721
|
+
declare const reportDeliveryTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3722
|
+
declare const reportDeliveryTypeFieldDocs: {
|
|
3723
|
+
[x: string]: string;
|
|
3724
|
+
};
|
|
3725
|
+
declare const showCaseInTimetableTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3726
|
+
declare const showCaseInTimetableTypeFieldDocs: {
|
|
3727
|
+
[x: string]: string;
|
|
3728
|
+
};
|
|
3729
|
+
declare const ticketStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3730
|
+
declare const ticketStateFieldDocs: {
|
|
3731
|
+
[x: string]: string;
|
|
3732
|
+
};
|
|
3733
|
+
|
|
3734
|
+
/** Ответ **`POST /api/v1/auth/token`** и **`POST /api/v1/auth/refresh`**. */
|
|
3735
|
+
declare const tokenRespFieldDocEntries: {
|
|
3736
|
+
readonly accessToken: {
|
|
3737
|
+
readonly description: "JWT или иной Bearer для заголовка `Authorization` при вызовах API от имени пользователя.";
|
|
3738
|
+
readonly usage: "Подставляй в `TorrowClientConfig.getAccessToken` (или вручную в `Authorization`). Не логируй целиком.";
|
|
3739
|
+
readonly examples: readonly ["eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…"];
|
|
3740
|
+
};
|
|
3741
|
+
readonly refreshToken: {
|
|
3742
|
+
readonly description: "Долгоживущий токен для выдачи новой пары без повторного логина.";
|
|
3743
|
+
readonly usage: "Храни безопасно; отправляй только в теле `POST /api/v1/auth/refresh`. После refresh сервер может вернуть новый refresh — замени сохранённый.";
|
|
3744
|
+
readonly examples: readonly ["opaque-refresh-string…"];
|
|
3745
|
+
};
|
|
3746
|
+
readonly expiration: {
|
|
3747
|
+
readonly description: "Срок жизни **access**-токена в **секундах**, отсчитанный от момента ответа (не Unix timestamp).";
|
|
3748
|
+
readonly usage: "Абсолютное время истечения access: `Date.now() + expiration * 1000`. Учитывай запас (skew) до истечения, затем вызывай refresh.";
|
|
3749
|
+
readonly examples: readonly ["3600", "900"];
|
|
3750
|
+
};
|
|
3751
|
+
};
|
|
3752
|
+
declare const tokenRespFieldDocs: {
|
|
3753
|
+
readonly accessToken: string;
|
|
3754
|
+
readonly refreshToken: string;
|
|
3755
|
+
readonly expiration: string;
|
|
3756
|
+
};
|
|
3757
|
+
/** Тело **`POST /api/v1/auth/refresh`**. */
|
|
3758
|
+
declare const refreshReqFieldDocEntries: {
|
|
3759
|
+
readonly refreshToken: {
|
|
3760
|
+
readonly description: "Текущий refresh-токен пользователя.";
|
|
3761
|
+
readonly usage: "Обязателен для обмена; клиент без `Authorization` (см. пример `74-auth-getaccesstoken-with-refresh.ts`).";
|
|
3762
|
+
};
|
|
3763
|
+
readonly deviceInfo: {
|
|
3764
|
+
readonly description: "Сведения об устройстве клиента (`DeviceInfo` в OpenAPI).";
|
|
3765
|
+
readonly usage: "В продакшене мобильный клиент обычно передаёт `deviceId`, тип устройства, push-токен и т.д. Для минимальных сценариев поле может отсутствовать — сверяй с контрактом стенда.";
|
|
3766
|
+
readonly valueSchema: "DeviceInfo";
|
|
3767
|
+
};
|
|
3768
|
+
};
|
|
3769
|
+
declare const refreshReqFieldDocs: {
|
|
3770
|
+
readonly refreshToken: string;
|
|
3771
|
+
readonly deviceInfo: string;
|
|
3772
|
+
};
|
|
3773
|
+
/** Тело **`POST /api/v1/auth/token`** (обмен кода/сессии на токены — зависит от способа входа). */
|
|
3774
|
+
declare const tokenReqFieldDocEntries: {
|
|
3775
|
+
readonly sessionId: {
|
|
3776
|
+
readonly description: "Идентификатор сессии после шага отправки кода / создания сессии.";
|
|
3777
|
+
readonly usage: "Часто приходит из потока `sendcode` / `session` до вызова `token`.";
|
|
3778
|
+
};
|
|
3779
|
+
readonly code: {
|
|
3780
|
+
readonly description: "Одноразовый код подтверждения (SMS, email и т.п.), если применимо.";
|
|
3781
|
+
readonly usage: "Вместе с `sessionId` или по правилам конкретного потока Auth в продукте.";
|
|
3782
|
+
};
|
|
3783
|
+
readonly scopes: {
|
|
3784
|
+
readonly description: "Запрашиваемые области доступа (строки), если API их использует.";
|
|
3785
|
+
readonly examples: readonly ["[\"api\"]"];
|
|
3786
|
+
};
|
|
3787
|
+
readonly deviceInfo: {
|
|
3788
|
+
readonly description: "Сведения об устройстве (`DeviceInfo`).";
|
|
3789
|
+
readonly valueSchema: "DeviceInfo";
|
|
3790
|
+
};
|
|
3791
|
+
readonly splitTokens: {
|
|
3792
|
+
readonly description: "Флаг разделения токенов в ответе (семантика на стороне сервиса identity).";
|
|
3793
|
+
readonly usage: "Передавай только если контракт стенда это требует; иначе опусти.";
|
|
3794
|
+
};
|
|
3795
|
+
};
|
|
3796
|
+
declare const tokenReqFieldDocs: {
|
|
3797
|
+
readonly sessionId: string;
|
|
3798
|
+
readonly code: string;
|
|
3799
|
+
readonly scopes: string;
|
|
3800
|
+
readonly deviceInfo: string;
|
|
3801
|
+
readonly splitTokens: string;
|
|
3802
|
+
};
|
|
3803
|
+
/** Тело **`POST /api/v1/auth/revoke`**. */
|
|
3804
|
+
declare const revokeReqFieldDocEntries: {
|
|
3805
|
+
readonly token: {
|
|
3806
|
+
readonly description: "Refresh-токен, который нужно инвалидировать на сервере.";
|
|
3807
|
+
readonly usage: "Вызывай при выходе пользователя или компрометации refresh.";
|
|
3808
|
+
};
|
|
3809
|
+
};
|
|
3810
|
+
declare const revokeReqFieldDocs: {
|
|
3811
|
+
readonly token: string;
|
|
3812
|
+
};
|
|
3813
|
+
/** Тело `POST /api/v1/auth/sendcode`. */
|
|
3814
|
+
declare const sendCodeReqFieldDocEntries: {
|
|
3815
|
+
readonly accountName: {
|
|
3816
|
+
readonly description: "Телефон/email/логин, куда отправляют код.";
|
|
3817
|
+
readonly valueSchema: "string | null";
|
|
3818
|
+
};
|
|
3819
|
+
readonly accountType: {
|
|
3820
|
+
readonly description: "Тип аккаунта (`PhoneNumber`, `Email`, ... в зависимости от контракта identity).";
|
|
3821
|
+
readonly valueSchema: "AccountType";
|
|
3822
|
+
};
|
|
3823
|
+
readonly language: {
|
|
3824
|
+
readonly description: "Язык сообщений/кода.";
|
|
3825
|
+
readonly valueSchema: "string | null";
|
|
3826
|
+
};
|
|
3827
|
+
readonly regionStorageId: {
|
|
3828
|
+
readonly description: "Региональный storage ID (если используется backend identity).";
|
|
3829
|
+
readonly valueSchema: "string | null";
|
|
3830
|
+
};
|
|
3831
|
+
readonly captchaToken: {
|
|
3832
|
+
readonly description: "Токен captcha, если включена антибот-проверка.";
|
|
3833
|
+
readonly valueSchema: "string | null";
|
|
3834
|
+
};
|
|
3835
|
+
};
|
|
3836
|
+
declare const sendCodeReqFieldDocs: {
|
|
3837
|
+
readonly accountName: string;
|
|
3838
|
+
readonly accountType: string;
|
|
3839
|
+
readonly language: string;
|
|
3840
|
+
readonly regionStorageId: string;
|
|
3841
|
+
readonly captchaToken: string;
|
|
3842
|
+
};
|
|
3843
|
+
/** Ответ `POST /api/v1/auth/sendcode`. */
|
|
3844
|
+
declare const sendCodeRespFieldDocEntries: {
|
|
3845
|
+
readonly sessionId: {
|
|
3846
|
+
readonly description: "ID auth-сессии для следующего шага (`requestToken`).";
|
|
3847
|
+
readonly valueSchema: "string | null";
|
|
3848
|
+
};
|
|
3849
|
+
readonly sessionLifeTimeSeconds: {
|
|
3850
|
+
readonly description: "TTL сессии/кода в секундах.";
|
|
3851
|
+
readonly valueSchema: "int32";
|
|
3852
|
+
};
|
|
3853
|
+
};
|
|
3854
|
+
declare const sendCodeRespFieldDocs: {
|
|
3855
|
+
readonly sessionId: string;
|
|
3856
|
+
readonly sessionLifeTimeSeconds: string;
|
|
3857
|
+
};
|
|
3858
|
+
/** Тело `POST /api/v1/auth/session`. */
|
|
3859
|
+
declare const createAuthSessionReqFieldDocEntries: {
|
|
3860
|
+
readonly accountType: {
|
|
3861
|
+
readonly description: "Тип аккаунта для создаваемой auth-сессии.";
|
|
3862
|
+
readonly valueSchema: "AccountType";
|
|
3863
|
+
};
|
|
3864
|
+
readonly language: {
|
|
3865
|
+
readonly description: "Язык интерфейса/сообщений сессии.";
|
|
3866
|
+
readonly valueSchema: "string | null";
|
|
3867
|
+
};
|
|
3868
|
+
readonly regionStorageId: {
|
|
3869
|
+
readonly description: "Регион storage для identity.";
|
|
3870
|
+
readonly valueSchema: "string | null";
|
|
3871
|
+
};
|
|
3872
|
+
readonly inviteSessionId: {
|
|
3873
|
+
readonly description: "ID invite-сессии (если вход по приглашению).";
|
|
3874
|
+
readonly valueSchema: "string | null";
|
|
3875
|
+
};
|
|
3876
|
+
readonly captchaToken: {
|
|
3877
|
+
readonly description: "Captcha token для защиты от ботов.";
|
|
3878
|
+
readonly valueSchema: "string | null";
|
|
3879
|
+
};
|
|
3880
|
+
readonly scopes: {
|
|
3881
|
+
readonly description: "Запрашиваемые scopes сессии.";
|
|
3882
|
+
readonly valueSchema: "string[] | null";
|
|
3883
|
+
};
|
|
3884
|
+
readonly deviceInfo: {
|
|
3885
|
+
readonly description: "Информация об устройстве.";
|
|
3886
|
+
readonly valueSchema: "DeviceInfo";
|
|
3887
|
+
};
|
|
3888
|
+
};
|
|
3889
|
+
declare const createAuthSessionReqFieldDocs: {
|
|
3890
|
+
readonly accountType: string;
|
|
3891
|
+
readonly language: string;
|
|
3892
|
+
readonly regionStorageId: string;
|
|
3893
|
+
readonly inviteSessionId: string;
|
|
3894
|
+
readonly captchaToken: string;
|
|
3895
|
+
readonly scopes: string;
|
|
3896
|
+
readonly deviceInfo: string;
|
|
3897
|
+
};
|
|
3898
|
+
/** Ответ `POST /api/v1/auth/session`. */
|
|
3899
|
+
declare const createAuthSessionRespFieldDocEntries: {
|
|
3900
|
+
readonly sessionId: {
|
|
3901
|
+
readonly description: "ID созданной auth-сессии.";
|
|
3902
|
+
readonly valueSchema: "string | null";
|
|
3903
|
+
};
|
|
3904
|
+
readonly sessionLifeTimeSeconds: {
|
|
3905
|
+
readonly description: "Срок жизни сессии.";
|
|
3906
|
+
readonly valueSchema: "int32";
|
|
3907
|
+
};
|
|
3908
|
+
readonly communicationTypeList: {
|
|
3909
|
+
readonly description: "Доступные каналы подтверждения (SMS/email/etc).";
|
|
3910
|
+
readonly valueSchema: "CommunicationType[] | null";
|
|
3911
|
+
};
|
|
3912
|
+
};
|
|
3913
|
+
declare const createAuthSessionRespFieldDocs: {
|
|
3914
|
+
readonly sessionId: string;
|
|
3915
|
+
readonly sessionLifeTimeSeconds: string;
|
|
3916
|
+
readonly communicationTypeList: string;
|
|
3917
|
+
};
|
|
3918
|
+
/**
|
|
3919
|
+
* Поверхность SDK, связанная с Bearer и гостевым доступом (не схема OpenAPI, а конфиг клиента).
|
|
3920
|
+
*/
|
|
3921
|
+
declare const torrowClientAuthConfigFieldDocEntries: {
|
|
3922
|
+
readonly getAccessToken: {
|
|
3923
|
+
readonly description: "Асинхронный колбэк: возвращает строку Bearer или `undefined` (тогда заголовок `Authorization` не ставится).";
|
|
3924
|
+
readonly usage: "Реализуй кэш access в памяти/хранилище; перед возвратом при необходимости вызови **`client.auth.refresh`** (отдельный HTTP без Bearer этого колбэка) или свой анонимный `HttpClient` — иначе рекурсия.";
|
|
3925
|
+
};
|
|
3926
|
+
readonly securityToken: {
|
|
3927
|
+
readonly description: "Гостевой или общий токен доступа к сущности: SDK добавляет его в query как `securityToken` на каждый запрос.";
|
|
3928
|
+
readonly usage: "Типично для заказов/событий после `createOrder` (`consumerSecurityToken` и т.п.); см. кейсы в capability-map и `TorrowClientConfig`.";
|
|
3929
|
+
readonly examples: readonly ["guest-or-shared-token…"];
|
|
3930
|
+
};
|
|
3931
|
+
};
|
|
3932
|
+
declare const torrowClientAuthConfigFieldDocs: {
|
|
3933
|
+
readonly getAccessToken: string;
|
|
3934
|
+
readonly securityToken: string;
|
|
3935
|
+
};
|
|
3936
|
+
/** Методы **`TorrowClient.auth`** ↔ REST AuthIdentity. */
|
|
3937
|
+
declare const authSdkMethodFieldDocEntries: {
|
|
3938
|
+
readonly refresh: {
|
|
3939
|
+
readonly description: "`POST /api/v1/auth/refresh` — тело `RefreshReq`, ответ `TokenResp`.";
|
|
3940
|
+
readonly usage: "Безопасно вызывать с того же экземпляра `TorrowClient`, у которого задан `getAccessToken`: внутренний вызов не использует Bearer.";
|
|
3941
|
+
};
|
|
3942
|
+
readonly requestToken: {
|
|
3943
|
+
readonly description: "`POST /api/v1/auth/token` — тело `TokenReq`, ответ `TokenResp`.";
|
|
3944
|
+
readonly usage: "После **`sendCode`**: `sessionId` из ответа + код из SMS/email. Пример — **`examples/node/auth/75-auth-request-token.ts`**.";
|
|
3945
|
+
};
|
|
3946
|
+
readonly revoke: {
|
|
3947
|
+
readonly description: "`POST /api/v1/auth/revoke` — тело `RevokeReq`, ответ пустой при успехе.";
|
|
3948
|
+
readonly usage: "Выход и инвалидация refresh на сервере.";
|
|
3949
|
+
};
|
|
3950
|
+
readonly sendCode: {
|
|
3951
|
+
readonly description: "`POST /api/v1/auth/sendcode` — тело `SendCodeReq`, ответ `SendCodeResp`.";
|
|
3952
|
+
readonly usage: "Первый шаг OTP: в ответе **`sessionId`** для `requestToken`. Цепочка с примером — **`examples/node/auth/75-auth-request-token.ts`**.";
|
|
3953
|
+
};
|
|
3954
|
+
readonly createSession: {
|
|
3955
|
+
readonly description: "`POST /api/v1/auth/session` — тело `CreateAuthSessionReq`, ответ `CreateAuthSessionResp`.";
|
|
3956
|
+
readonly usage: "Создание сессии входа (регион, язык, captcha и т.д. по контракту).";
|
|
3957
|
+
};
|
|
3958
|
+
};
|
|
3959
|
+
declare const authSdkMethodFieldDocs: {
|
|
3960
|
+
readonly refresh: string;
|
|
3961
|
+
readonly requestToken: string;
|
|
3962
|
+
readonly revoke: string;
|
|
3963
|
+
readonly sendCode: string;
|
|
3964
|
+
readonly createSession: string;
|
|
3965
|
+
};
|
|
3966
|
+
|
|
3967
|
+
declare const profilesSdkMethodFieldDocEntries: {
|
|
3968
|
+
readonly list: {
|
|
3969
|
+
readonly description: "`GET /api/v1/user/profiles`. Возвращает **`ProfileListResp`**: список контактов-Профилей текущего пользователя (не общий каталог контактов mind map). Требуется авторизация пользователя.";
|
|
3970
|
+
readonly valueSchema: "→ ProfileListResp";
|
|
3971
|
+
};
|
|
3972
|
+
readonly add: {
|
|
3973
|
+
readonly description: "`POST /api/v1/user/profiles`. Тело: **`ContactItem`** (черновик контакта для нового Профиля). Ответ: **`AddProfileResp`**: `profile` — созданный/связанный контакт; `personalContactList` помечено в схеме как устаревшее.";
|
|
3974
|
+
readonly valueSchema: "ContactItem → AddProfileResp";
|
|
3975
|
+
};
|
|
3976
|
+
readonly addByContactId: {
|
|
3977
|
+
readonly description: "`PUT /api/v1/user/profiles`. Тело в OpenAPI — **строка** (JSON-строка): `torrow id` уже существующего контакта, который нужно зарегистрировать как Профиль. Ответ: **`AddProfileResp`. Не путать с `PUT` обновления обычного контакта по `/api/v1/contacts/{id}`.";
|
|
3978
|
+
readonly valueSchema: "string (contactId) → AddProfileResp";
|
|
3979
|
+
readonly usage: "Передай строку id существующего контакта; SDK сериализует её как JSON string.";
|
|
3980
|
+
};
|
|
3981
|
+
readonly updateProfileProperties: {
|
|
3982
|
+
readonly description: "`PUT /api/v1/user/profiles/{profileId}/profileproperties`. Тело: **`ProfileProperties`** (цвет карточки, доступность, заметка). Ответ: **`UpdateProfilePropertiesResp`** с опциональным `torrowObject`.";
|
|
3983
|
+
readonly valueSchema: "ProfileProperties → UpdateProfilePropertiesResp";
|
|
3984
|
+
};
|
|
3985
|
+
readonly remove: {
|
|
3986
|
+
readonly description: "`DELETE /api/v1/user/profiles/{profileId}`. Удалить Профиль по id контакта. Ответ: **`RemoveProfileResp`**: актуальный список `personalContactList` после операции.";
|
|
3987
|
+
readonly valueSchema: "→ RemoveProfileResp";
|
|
3988
|
+
};
|
|
3989
|
+
};
|
|
3990
|
+
declare const profileListRespFieldDocEntries: {
|
|
3991
|
+
readonly profileList: {
|
|
3992
|
+
readonly description: "Массив контактов — **Профили** пользователя (`ContactItem`, ожидаемо с `profileType` вроде `MyProfile`). Пустой или отсутствует, если профилей нет.";
|
|
3993
|
+
readonly valueSchema: "ContactItem[] | null";
|
|
3994
|
+
};
|
|
3995
|
+
};
|
|
3996
|
+
declare const addProfileRespFieldDocEntries: {
|
|
3997
|
+
readonly profile: {
|
|
3998
|
+
readonly description: "Созданный или связанный **Профиль** после операции добавления.";
|
|
3999
|
+
readonly valueSchema: "ContactItem";
|
|
4000
|
+
};
|
|
4001
|
+
readonly personalContactList: {
|
|
4002
|
+
readonly description: "Устаревшее поле в схеме OpenAPI; предпочитай `profile` и актуальный список через `list`.";
|
|
4003
|
+
readonly valueSchema: "ContactItem[] | null";
|
|
4004
|
+
};
|
|
4005
|
+
};
|
|
4006
|
+
declare const removeProfileRespFieldDocEntries: {
|
|
4007
|
+
readonly personalContactList: {
|
|
4008
|
+
readonly description: "Список контактов-Профилей после удаления (в том числе пустой), в форме ответа сервера на эту операцию.";
|
|
4009
|
+
readonly valueSchema: "ContactItem[] | null";
|
|
4010
|
+
};
|
|
4011
|
+
};
|
|
4012
|
+
declare const updateProfilePropertiesRespFieldDocEntries: {
|
|
4013
|
+
readonly torrowObject: {
|
|
4014
|
+
readonly description: "Обёртка сервера над обновлённым объектом после смены свойств профиля (если вернулась).";
|
|
4015
|
+
readonly valueSchema: "TorrowObject";
|
|
4016
|
+
};
|
|
4017
|
+
};
|
|
4018
|
+
/** Поля тела `PUT .../profileproperties` — те же `ProfileProperties`, что у `ContactItem.profileProperties`. */
|
|
4019
|
+
declare const profilePropertiesFieldDocEntries: {
|
|
4020
|
+
readonly id: {
|
|
4021
|
+
readonly description: "Идентификатор сущности свойств профиля (если задан в API).";
|
|
4022
|
+
readonly valueSchema: "string | null";
|
|
4023
|
+
};
|
|
4024
|
+
readonly profileUserAvailability: {
|
|
4025
|
+
readonly description: "Доступность владельца профиля для отображения (занят, свободен, скрыт и т.д.).";
|
|
4026
|
+
readonly valueSchema: "ProfileUserAvailability";
|
|
4027
|
+
};
|
|
4028
|
+
readonly availabilityNote: {
|
|
4029
|
+
readonly description: "Текстовая заметка к доступности.";
|
|
4030
|
+
readonly valueSchema: "string | null";
|
|
4031
|
+
};
|
|
4032
|
+
readonly color: {
|
|
4033
|
+
readonly description: "Цвет акцента карточки Профиля в UI (часто hex).";
|
|
4034
|
+
readonly valueSchema: "string | null";
|
|
4035
|
+
readonly examples: readonly ["#4a90d9"];
|
|
4036
|
+
};
|
|
4037
|
+
};
|
|
4038
|
+
declare const profilesSdkMethodFieldDocs: {
|
|
4039
|
+
readonly list: string;
|
|
4040
|
+
readonly add: string;
|
|
4041
|
+
readonly addByContactId: string;
|
|
4042
|
+
readonly updateProfileProperties: string;
|
|
4043
|
+
readonly remove: string;
|
|
4044
|
+
};
|
|
4045
|
+
declare const profileListRespFieldDocs: {
|
|
4046
|
+
readonly profileList: string;
|
|
4047
|
+
};
|
|
4048
|
+
declare const addProfileRespFieldDocs: {
|
|
4049
|
+
readonly profile: string;
|
|
4050
|
+
readonly personalContactList: string;
|
|
4051
|
+
};
|
|
4052
|
+
declare const removeProfileRespFieldDocs: {
|
|
4053
|
+
readonly personalContactList: string;
|
|
4054
|
+
};
|
|
4055
|
+
declare const updateProfilePropertiesRespFieldDocs: {
|
|
4056
|
+
readonly torrowObject: string;
|
|
4057
|
+
};
|
|
4058
|
+
declare const profilePropertiesFieldDocs: {
|
|
4059
|
+
readonly id: string;
|
|
4060
|
+
readonly profileUserAvailability: string;
|
|
4061
|
+
readonly availabilityNote: string;
|
|
4062
|
+
readonly color: string;
|
|
4063
|
+
};
|
|
4064
|
+
|
|
4065
|
+
/** Сегмент пути `/api/v1/{segment}/...` — не отдельная схема OpenAPI, а параметр SDK. */
|
|
4066
|
+
/**
|
|
4067
|
+
* Соответствие методов `TorrowClient.relations` телам запросов и путям REST.
|
|
4068
|
+
* Удобно для MCP-инструментов с именами `torrow_relations_include_to_parent` и т.д.
|
|
4069
|
+
*/
|
|
4070
|
+
declare const relationsSdkMethodFieldDocEntries: {
|
|
4071
|
+
readonly includeToParent: {
|
|
4072
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/include/items`. Тело: `IncludeToParentReq`. Ответ: `IncludeExcludeResp`. Включает элементы в иерархию под родителем.";
|
|
4073
|
+
readonly valueSchema: "IncludeToParentReq → IncludeExcludeResp";
|
|
4074
|
+
};
|
|
4075
|
+
readonly includeForUser: {
|
|
4076
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/include/foruser`. Тело: `IncludeForUserReq`. Ответ: `IncludeExcludeResp`. Персональный mind map пользователя под узлом `parentId`.";
|
|
4077
|
+
readonly valueSchema: "IncludeForUserReq → IncludeExcludeResp";
|
|
4078
|
+
};
|
|
4079
|
+
readonly excludeFromParent: {
|
|
4080
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/exclude/items`. Тело: `ExcludeReq`. Ответ: `ExcludeResp`. Отвязка от родителя.";
|
|
4081
|
+
readonly valueSchema: "ExcludeReq → ExcludeResp";
|
|
4082
|
+
};
|
|
4083
|
+
readonly excludeFromUser: {
|
|
4084
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/exclude/fromuser`. Тело: `ExcludeReq`. Ответ: `ExcludeResp`. Убрать из персонального представления.";
|
|
4085
|
+
readonly valueSchema: "ExcludeReq → ExcludeResp";
|
|
4086
|
+
};
|
|
4087
|
+
readonly includeToGroups: {
|
|
4088
|
+
readonly description: "`PUT /api/v1/{domain}/include/togroups`. Тело: `IncludeToGroupsReq`. Ответ: `IncludeExcludeResp`. Массовое включение в несколько групп.";
|
|
4089
|
+
readonly valueSchema: "IncludeToGroupsReq → IncludeExcludeResp";
|
|
4090
|
+
};
|
|
4091
|
+
readonly excludeFromGroups: {
|
|
4092
|
+
readonly description: "`PUT /api/v1/{domain}/exclude/fromgroups`. Тело: `ExcludeFromGroupsReq`. Ответ: `ExcludeResp`.";
|
|
4093
|
+
readonly valueSchema: "ExcludeFromGroupsReq → ExcludeResp";
|
|
4094
|
+
};
|
|
4095
|
+
readonly saveToMindMap: {
|
|
4096
|
+
readonly description: "`PUT /api/v1/{domain}/{itemId}/savetomindmap`. Тело: `SaveItemToMindMapReq`. Ответ: `Participation`. Обновить положение/alias/участие узла в карте.";
|
|
4097
|
+
readonly valueSchema: "SaveItemToMindMapReq → Participation";
|
|
4098
|
+
};
|
|
4099
|
+
};
|
|
4100
|
+
declare const relationsApiDomainFieldDocEntries: {
|
|
4101
|
+
readonly segment: {
|
|
4102
|
+
readonly description: "Имя REST-коллекции элемента. Определяет префикс URL: `/api/v1/{segment}/...`. Для сущности Resource в API используется `resources` (в SDK фасад ресурсов — `resourceItems`).";
|
|
4103
|
+
readonly examples: readonly ["contacts", "notes", "contexts", "resources", "services", "cases", "calendars"];
|
|
4104
|
+
readonly usage: "Один и тот же набор операций include/exclude/savetomindmap повторяется для каждого типа элемента в Swagger; отличие только в сегменте пути.";
|
|
4105
|
+
};
|
|
4106
|
+
};
|
|
4107
|
+
declare const itemLinkKeyFieldDocEntries: {
|
|
4108
|
+
readonly parentId: {
|
|
4109
|
+
readonly description: "Идентификатор родительского элемента в связи (mind map / иерархия).";
|
|
4110
|
+
readonly valueSchema: "string (torrow id)";
|
|
4111
|
+
};
|
|
4112
|
+
readonly itemId: {
|
|
4113
|
+
readonly description: "Идентификатор дочернего или связанного элемента.";
|
|
4114
|
+
readonly valueSchema: "string (torrow id)";
|
|
4115
|
+
};
|
|
4116
|
+
readonly ownerId: {
|
|
4117
|
+
readonly description: "Владелец связи (профиль/пользователь), если применимо к персональному представлению.";
|
|
4118
|
+
readonly valueSchema: "string | null";
|
|
4119
|
+
};
|
|
4120
|
+
};
|
|
4121
|
+
declare const includedLinkMetaFieldDocEntries: {
|
|
4122
|
+
readonly key: {
|
|
4123
|
+
readonly description: "Составной ключ созданной или обновлённой связи.";
|
|
4124
|
+
readonly valueSchema: "ItemLinkKey";
|
|
4125
|
+
};
|
|
4126
|
+
readonly info: {
|
|
4127
|
+
readonly description: "Мета связи (версия и т.п.) после include.";
|
|
4128
|
+
readonly valueSchema: "ObjectInfo";
|
|
4129
|
+
};
|
|
4130
|
+
};
|
|
4131
|
+
declare const excludedLinkMetaFieldDocEntries: {
|
|
4132
|
+
readonly key: {
|
|
4133
|
+
readonly description: "Ключ удалённой или затронутой связи.";
|
|
4134
|
+
readonly valueSchema: "ItemLinkKey";
|
|
4135
|
+
};
|
|
4136
|
+
readonly count: {
|
|
4137
|
+
readonly description: "Число затронутых связей/записей для данного ключа (контракт API).";
|
|
4138
|
+
readonly examples: readonly ["1", "0"];
|
|
4139
|
+
readonly valueSchema: "int32";
|
|
4140
|
+
};
|
|
4141
|
+
};
|
|
4142
|
+
declare const itemPropertiesFieldDocEntries: {
|
|
4143
|
+
readonly itemId: {
|
|
4144
|
+
readonly description: "Torrow id элемента, который включают под родителя в иерархии.";
|
|
4145
|
+
readonly usage: "Обязательное поле в каждом элементе `itemPropertiesList` для `includeToParent`.";
|
|
4146
|
+
};
|
|
4147
|
+
readonly order: {
|
|
4148
|
+
readonly description: "Порядок сортировки среди детей одного родителя (меньше — выше в списке, согласно клиенту).";
|
|
4149
|
+
readonly examples: readonly ["0", "1", "10"];
|
|
4150
|
+
readonly valueSchema: "int32 | null";
|
|
4151
|
+
};
|
|
4152
|
+
readonly tags: {
|
|
4153
|
+
readonly description: "Теги связи элемента с родителем (фильтры, группировка в UI).";
|
|
4154
|
+
readonly examples: readonly ["[\"важное\"]", "[]"];
|
|
4155
|
+
readonly valueSchema: "string[] | null";
|
|
4156
|
+
};
|
|
4157
|
+
readonly alias: {
|
|
4158
|
+
readonly description: "Псевдоним узла в mind map для данной связи.";
|
|
4159
|
+
readonly valueSchema: "string | null";
|
|
4160
|
+
};
|
|
4161
|
+
readonly tagsByItemId: {
|
|
4162
|
+
readonly description: "Устаревшее: теги по id элемента. Предпочитать `tags`.";
|
|
4163
|
+
readonly valueSchema: "deprecated map";
|
|
4164
|
+
};
|
|
4165
|
+
readonly aliasByItemId: {
|
|
4166
|
+
readonly description: "Устаревшее: псевдонимы по id. Предпочитать `alias`.";
|
|
4167
|
+
readonly valueSchema: "deprecated map";
|
|
4168
|
+
};
|
|
4169
|
+
};
|
|
4170
|
+
declare const baseItemPropertiesFieldDocEntries: {
|
|
4171
|
+
readonly itemId: {
|
|
4172
|
+
readonly description: "Элемент, который добавляют в персональное представление пользователя под `parentId` маршрута.";
|
|
4173
|
+
readonly usage: "Используется в `IncludeForUserReq` (include/foruser).";
|
|
4174
|
+
};
|
|
4175
|
+
readonly order: {
|
|
4176
|
+
readonly description: "Порядок узла в списке представления пользователя.";
|
|
4177
|
+
readonly examples: readonly ["0", "1"];
|
|
4178
|
+
readonly valueSchema: "int32 | null";
|
|
4179
|
+
};
|
|
4180
|
+
};
|
|
4181
|
+
declare const groupItemPropertiesFieldDocEntries: {
|
|
4182
|
+
readonly itemId: {
|
|
4183
|
+
readonly description: "Элемент, включаемый в каждую из групп из `IncludeToGroupsReq.groupIds` (список id групп задаётся на уровне запроса, не здесь).";
|
|
4184
|
+
};
|
|
4185
|
+
readonly participantType: {
|
|
4186
|
+
readonly description: "Роль участия элемента в группе (Owner, Editor, Reader, …).";
|
|
4187
|
+
readonly valueSchema: "ParticipantType";
|
|
4188
|
+
readonly examples: readonly ["Reader", "Editor", "Owner"];
|
|
4189
|
+
};
|
|
4190
|
+
readonly order: {
|
|
4191
|
+
readonly description: "Порядок внутри группы.";
|
|
4192
|
+
readonly valueSchema: "int32 | null";
|
|
4193
|
+
};
|
|
4194
|
+
readonly tags: {
|
|
4195
|
+
readonly description: "Теги для связи элемент–группа.";
|
|
4196
|
+
readonly valueSchema: "string[] | null";
|
|
4197
|
+
};
|
|
4198
|
+
readonly alias: {
|
|
4199
|
+
readonly description: "Псевдоним в группе.";
|
|
4200
|
+
readonly valueSchema: "string | null";
|
|
4201
|
+
};
|
|
4202
|
+
readonly tagsByItemId: {
|
|
4203
|
+
readonly description: "Устаревшее.";
|
|
4204
|
+
readonly valueSchema: "deprecated";
|
|
4205
|
+
};
|
|
4206
|
+
readonly aliasByItemId: {
|
|
4207
|
+
readonly description: "Устаревшее.";
|
|
4208
|
+
readonly valueSchema: "deprecated";
|
|
4209
|
+
};
|
|
4210
|
+
};
|
|
4211
|
+
declare const includeToParentReqFieldDocEntries: {
|
|
4212
|
+
readonly itemPropertiesList: {
|
|
4213
|
+
readonly description: "Список детей, привязываемых к `parentId` из URL (`PUT .../{parentId}/include/items`).";
|
|
4214
|
+
readonly valueSchema: "ItemProperties[]";
|
|
4215
|
+
readonly usage: "Сценарий «прикрепить элемент к контакту/контексту/…» в продукте.";
|
|
4216
|
+
};
|
|
4217
|
+
readonly versionToCheck: {
|
|
4218
|
+
readonly description: "Ожидаемая версия родителя для оптимистичной блокировки; несовпадение — конфликт.";
|
|
4219
|
+
readonly examples: readonly ["1", "18"];
|
|
4220
|
+
readonly valueSchema: "int32 | null";
|
|
4221
|
+
readonly usage: "Берётся из `parent.meta.version`, если нужна проверка.";
|
|
4222
|
+
};
|
|
4223
|
+
readonly isNeedAnnouncement: {
|
|
4224
|
+
readonly description: "Сгенерировать уведомление/анонс об изменении для подписчиков.";
|
|
4225
|
+
readonly examples: readonly ["true", "false"];
|
|
4226
|
+
readonly valueSchema: "boolean | null";
|
|
4227
|
+
};
|
|
4228
|
+
};
|
|
4229
|
+
declare const includeForUserReqFieldDocEntries: {
|
|
4230
|
+
readonly itemPropertiesList: {
|
|
4231
|
+
readonly description: "Элементы и порядок для добавления в mind map **текущего пользователя** под родителем из пути.";
|
|
4232
|
+
readonly valueSchema: "BaseItemProperties[]";
|
|
4233
|
+
readonly usage: "Маршрут `include/foruser`; отличается от include/items тем, что работает с персональным представлением.";
|
|
4234
|
+
};
|
|
4235
|
+
readonly versionToCheck: {
|
|
4236
|
+
readonly description: "Версия родителя для проверки при изменении (если API ожидает).";
|
|
4237
|
+
readonly valueSchema: "int32 | null";
|
|
4238
|
+
};
|
|
4239
|
+
readonly isNeedAnnouncement: {
|
|
4240
|
+
readonly description: "Нужен ли анонс.";
|
|
4241
|
+
readonly valueSchema: "boolean | null";
|
|
4242
|
+
};
|
|
4243
|
+
};
|
|
4244
|
+
declare const excludeReqFieldDocEntries: {
|
|
4245
|
+
readonly itemIds: {
|
|
4246
|
+
readonly description: "Список id элементов, которые отвязывают от родителя (`exclude/items`) или убирают из персонального вида (`exclude/fromuser`).";
|
|
4247
|
+
readonly valueSchema: "string[]";
|
|
4248
|
+
readonly usage: "Путь задаёт контекст: исключение из иерархии родителя vs из mind map пользователя.";
|
|
4249
|
+
};
|
|
4250
|
+
readonly versionToCheck: {
|
|
4251
|
+
readonly description: "Версия родителя для оптимистичной проверки.";
|
|
4252
|
+
readonly valueSchema: "int32 | null";
|
|
4253
|
+
};
|
|
4254
|
+
readonly isNeedAnnouncement: {
|
|
4255
|
+
readonly description: "Анонс об изменении.";
|
|
4256
|
+
readonly valueSchema: "boolean | null";
|
|
4257
|
+
};
|
|
4258
|
+
};
|
|
4259
|
+
declare const includeToGroupsReqFieldDocEntries: {
|
|
4260
|
+
readonly itemPropertiesList: {
|
|
4261
|
+
readonly description: "Элементы с опциональной ролью (`participantType`), порядком и тегами; каждый `itemId` будет связан со **всеми** `groupIds`.";
|
|
4262
|
+
readonly valueSchema: "GroupItemProperties[]";
|
|
4263
|
+
};
|
|
4264
|
+
readonly parentId: {
|
|
4265
|
+
readonly description: "Общий родительский контекст для операции (если задан в API).";
|
|
4266
|
+
readonly valueSchema: "string | null";
|
|
4267
|
+
};
|
|
4268
|
+
readonly groupIds: {
|
|
4269
|
+
readonly description: "Идентификаторы групп (элементов-групп), в которые включают перечисленные `itemId`.";
|
|
4270
|
+
readonly valueSchema: "string[]";
|
|
4271
|
+
readonly usage: "Маршрут без `{parentId}` в пути: `PUT /api/v1/{domain}/include/togroups`.";
|
|
4272
|
+
};
|
|
4273
|
+
readonly recursive: {
|
|
4274
|
+
readonly description: "Рекурсивное включение в подгруппы (семантика сервера).";
|
|
4275
|
+
readonly examples: readonly ["true", "false"];
|
|
4276
|
+
readonly valueSchema: "boolean";
|
|
4277
|
+
};
|
|
4278
|
+
readonly versionToCheck: {
|
|
4279
|
+
readonly description: "Версия для проверки согласованности.";
|
|
4280
|
+
readonly valueSchema: "int32 | null";
|
|
4281
|
+
};
|
|
4282
|
+
readonly isNeedAnnouncement: {
|
|
4283
|
+
readonly description: "Анонс.";
|
|
4284
|
+
readonly valueSchema: "boolean | null";
|
|
4285
|
+
};
|
|
4286
|
+
};
|
|
4287
|
+
declare const excludeFromGroupsReqFieldDocEntries: {
|
|
4288
|
+
readonly groupIds: {
|
|
4289
|
+
readonly description: "Группы, из которых убирают элементы.";
|
|
4290
|
+
readonly valueSchema: "string[]";
|
|
4291
|
+
};
|
|
4292
|
+
readonly itemIds: {
|
|
4293
|
+
readonly description: "Элементы для исключения из указанных групп.";
|
|
4294
|
+
readonly valueSchema: "string[]";
|
|
4295
|
+
};
|
|
4296
|
+
readonly versionToCheck: {
|
|
4297
|
+
readonly description: "Версия для оптимистичной проверки.";
|
|
4298
|
+
readonly valueSchema: "int32 | null";
|
|
4299
|
+
};
|
|
4300
|
+
readonly isNeedAnnouncement: {
|
|
4301
|
+
readonly description: "Анонс.";
|
|
4302
|
+
readonly valueSchema: "boolean | null";
|
|
4303
|
+
};
|
|
4304
|
+
};
|
|
4305
|
+
declare const saveItemToMindMapReqFieldDocEntries: {
|
|
4306
|
+
readonly userProfileId: {
|
|
4307
|
+
readonly description: "Профиль пользователя, для чьего mind map применяется операция (если отличается от токена).";
|
|
4308
|
+
readonly valueSchema: "string | null";
|
|
4309
|
+
};
|
|
4310
|
+
readonly parentItemId: {
|
|
4311
|
+
readonly description: "Новый или текущий родительский узел в mind map; `null` — согласно правилам API (корень или снятие привязки).";
|
|
4312
|
+
readonly valueSchema: "string | null";
|
|
4313
|
+
};
|
|
4314
|
+
readonly alias: {
|
|
4315
|
+
readonly description: "Отображаемый псевдоним узла в карте.";
|
|
4316
|
+
readonly valueSchema: "string | null";
|
|
4317
|
+
};
|
|
4318
|
+
readonly offlinable: {
|
|
4319
|
+
readonly description: "Доступность узла в офлайн-режиме (флаг клиента/сервера).";
|
|
4320
|
+
readonly examples: readonly ["true", "false"];
|
|
4321
|
+
readonly valueSchema: "boolean";
|
|
4322
|
+
};
|
|
4323
|
+
readonly order: {
|
|
4324
|
+
readonly description: "Позиция среди соседей в ветке.";
|
|
4325
|
+
readonly valueSchema: "int32 | null";
|
|
4326
|
+
};
|
|
4327
|
+
readonly versionToCheck: {
|
|
4328
|
+
readonly description: "Версия **самого элемента** `itemId` из пути, если требуется проверка.";
|
|
4329
|
+
readonly valueSchema: "int32 | null";
|
|
4330
|
+
};
|
|
4331
|
+
readonly isNeedAnnouncement: {
|
|
4332
|
+
readonly description: "Анонс.";
|
|
4333
|
+
readonly valueSchema: "boolean | null";
|
|
4334
|
+
};
|
|
4335
|
+
readonly securityToken: {
|
|
4336
|
+
readonly description: "Гостевой или ограниченный доступ по токену (как в других операциях API).";
|
|
4337
|
+
readonly valueSchema: "string | null";
|
|
4338
|
+
};
|
|
4339
|
+
readonly participantType: {
|
|
4340
|
+
readonly description: "Тип участия при сохранении в mind map (например PublicReader для публичной карточки).";
|
|
4341
|
+
readonly valueSchema: "ParticipantType";
|
|
4342
|
+
readonly examples: readonly ["Reader", "PublicReader", "Owner"];
|
|
4343
|
+
};
|
|
4344
|
+
};
|
|
4345
|
+
declare const includeRespFieldDocEntries: {
|
|
4346
|
+
readonly success: {
|
|
4347
|
+
readonly description: "Признак успешного include на стороне сервера.";
|
|
4348
|
+
readonly examples: readonly ["true"];
|
|
4349
|
+
readonly valueSchema: "boolean";
|
|
4350
|
+
};
|
|
4351
|
+
readonly linkMetaList: {
|
|
4352
|
+
readonly description: "Метаданные по созданным/изменённым связям.";
|
|
4353
|
+
readonly valueSchema: "IncludedLinkMeta[] | null";
|
|
4354
|
+
};
|
|
4355
|
+
};
|
|
4356
|
+
declare const excludeRespFieldDocEntries: {
|
|
4357
|
+
readonly success: {
|
|
4358
|
+
readonly description: "Успешность exclude.";
|
|
4359
|
+
readonly valueSchema: "boolean";
|
|
4360
|
+
};
|
|
4361
|
+
readonly linkMetaList: {
|
|
4362
|
+
readonly description: "Сводка по исключённым связям (ключи и счётчики).";
|
|
4363
|
+
readonly valueSchema: "ExcludedLinkMeta[] | null";
|
|
4364
|
+
};
|
|
4365
|
+
};
|
|
4366
|
+
declare const includeExcludeRespFieldDocEntries: {
|
|
4367
|
+
readonly includeResp: {
|
|
4368
|
+
readonly description: "Результат части include, если в одном ответе объединены операции.";
|
|
4369
|
+
readonly valueSchema: "IncludeResp";
|
|
4370
|
+
};
|
|
4371
|
+
readonly excludeResp: {
|
|
4372
|
+
readonly description: "Результат части exclude.";
|
|
4373
|
+
readonly valueSchema: "ExcludeResp";
|
|
4374
|
+
};
|
|
4375
|
+
};
|
|
4376
|
+
declare const relationsSdkMethodFieldDocs: {
|
|
4377
|
+
[x: string]: string;
|
|
4378
|
+
};
|
|
4379
|
+
declare const relationsApiDomainFieldDocs: {
|
|
4380
|
+
[x: string]: string;
|
|
4381
|
+
};
|
|
4382
|
+
declare const itemPropertiesFieldDocs: {
|
|
4383
|
+
[x: string]: string;
|
|
4384
|
+
};
|
|
4385
|
+
declare const baseItemPropertiesFieldDocs: {
|
|
4386
|
+
[x: string]: string;
|
|
4387
|
+
};
|
|
4388
|
+
declare const groupItemPropertiesFieldDocs: {
|
|
4389
|
+
[x: string]: string;
|
|
4390
|
+
};
|
|
4391
|
+
declare const includeToParentReqFieldDocs: {
|
|
4392
|
+
[x: string]: string;
|
|
4393
|
+
};
|
|
4394
|
+
declare const includeForUserReqFieldDocs: {
|
|
4395
|
+
[x: string]: string;
|
|
4396
|
+
};
|
|
4397
|
+
declare const excludeReqFieldDocs: {
|
|
4398
|
+
[x: string]: string;
|
|
4399
|
+
};
|
|
4400
|
+
declare const includeToGroupsReqFieldDocs: {
|
|
4401
|
+
[x: string]: string;
|
|
4402
|
+
};
|
|
4403
|
+
declare const excludeFromGroupsReqFieldDocs: {
|
|
4404
|
+
[x: string]: string;
|
|
4405
|
+
};
|
|
4406
|
+
declare const saveItemToMindMapReqFieldDocs: {
|
|
4407
|
+
[x: string]: string;
|
|
4408
|
+
};
|
|
4409
|
+
declare const includeRespFieldDocs: {
|
|
4410
|
+
[x: string]: string;
|
|
4411
|
+
};
|
|
4412
|
+
declare const excludeRespFieldDocs: {
|
|
4413
|
+
[x: string]: string;
|
|
4414
|
+
};
|
|
4415
|
+
declare const includeExcludeRespFieldDocs: {
|
|
4416
|
+
[x: string]: string;
|
|
4417
|
+
};
|
|
4418
|
+
declare const itemLinkKeyFieldDocs: {
|
|
4419
|
+
[x: string]: string;
|
|
4420
|
+
};
|
|
4421
|
+
declare const includedLinkMetaFieldDocs: {
|
|
4422
|
+
[x: string]: string;
|
|
4423
|
+
};
|
|
4424
|
+
declare const excludedLinkMetaFieldDocs: {
|
|
4425
|
+
[x: string]: string;
|
|
4426
|
+
};
|
|
4427
|
+
|
|
4428
|
+
export { type ItemFieldDoc, accountTypeFieldDocEntries, accountTypeFieldDocs, accountingTransactionFieldDocEntries, accountingTransactionFieldDocs, accountingTransactionStateFieldDocEntries, accountingTransactionStateFieldDocs, accountingTransactionTypeFieldDocEntries, accountingTransactionTypeFieldDocs, accountingTransactionsSdkMethodFieldDocEntries, accountingTransactionsSdkMethodFieldDocs, actionHistoryInfoFieldDocEntries, actionHistoryInfoFieldDocs, actionHistorySdkMethodFieldDocEntries, actionHistorySdkMethodFieldDocs, actionHistoryStateFieldDocEntries, actionHistoryStateFieldDocs, actionHistoryTypeFieldDocEntries, actionHistoryTypeFieldDocs, addProfileRespFieldDocEntries, addProfileRespFieldDocs, announcementCategoryFieldDocEntries, announcementCategoryFieldDocs, announcementInfoFieldDocEntries, announcementInfoFieldDocs, announcementPriorityFieldDocEntries, announcementPriorityFieldDocs, announcementStateFieldDocEntries, announcementStateFieldDocs, announcementTypeFieldDocEntries, announcementTypeFieldDocs, announcementsSdkMethodFieldDocEntries, announcementsSdkMethodFieldDocs, anyoneAccessFieldDocEntries, anyoneAccessFieldDocs, archiveStateFieldDocEntries, archiveStateFieldDocs, authSdkMethodFieldDocEntries, authSdkMethodFieldDocs, availabilityTimeFieldDocEntries, availabilityTimeFieldDocs, availableResourcesFieldDocEntries, availableResourcesFieldDocs, balanceValueFieldDocEntries, balanceValueFieldDocs, baseItemPropertiesFieldDocEntries, baseItemPropertiesFieldDocs, blockInfoFieldDocEntries, blockInfoFieldDocs, blockReasonFieldDocEntries, blockReasonFieldDocs, blockReasonsSdkMethodFieldDocEntries, blockReasonsSdkMethodFieldDocs, blockSettingsFieldDocEntries, blockSettingsFieldDocs, calendarItemFieldDocEntries, calendarItemFieldDocs, caseItemFieldDocEntries, caseItemFieldDocs, caseItemSpecificFieldDocEntries, caseItemSpecificFieldDocs, caseParticipantStateFieldDocEntries, caseParticipantStateFieldDocs, caseParticipantTypeFieldDocEntries, caseParticipantTypeFieldDocs, caseStateFieldDocEntries, caseStateFieldDocs, caseTypeFieldDocEntries, caseTypeFieldDocs, communicationTypeFieldDocEntries, communicationTypeFieldDocs, contactItemFieldDocEntries, contactItemFieldDocs, contactItemSpecificFieldDocEntries, contactItemSpecificFieldDocs, contactVisitCardFieldDoc, contactsCommunicationSdkMethodFieldDocEntries, contactsCommunicationSdkMethodFieldDocs, contextItemFieldDocEntries, contextItemFieldDocs, createAuthSessionReqFieldDocEntries, createAuthSessionReqFieldDocs, createAuthSessionRespFieldDocEntries, createAuthSessionRespFieldDocs, createViewListReqFieldDocEntries, createViewListReqFieldDocs, createViewListRespFieldDocEntries, createViewListRespFieldDocs, deleteResponseFieldDocEntries, deleteResponseFieldDocs, deleteStateFieldDocEntries, deleteStateFieldDocs, deliveryChannelFieldDocEntries, deliveryChannelFieldDocs, deliveryStrategyFieldDocEntries, deliveryStrategyFieldDocs, deviceSettingsInfoFieldDocEntries, deviceSettingsInfoFieldDocs, excludeFromGroupsReqFieldDocEntries, excludeFromGroupsReqFieldDocs, excludeReqFieldDocEntries, excludeReqFieldDocs, excludeRespFieldDocEntries, excludeRespFieldDocs, excludedLinkMetaFieldDocEntries, excludedLinkMetaFieldDocs, exportGraphFieldDocEntries, exportGraphFieldDocs, exportImportSdkMethodFieldDocEntries, exportImportSdkMethodFieldDocs, exportRequestFieldDocEntries, exportRequestFieldDocs, fieldDocToString, fileInfoFieldDocEntries, fileInfoFieldDocs, filterFieldDocEntries, filterFieldDocs, genderFieldDocEntries, genderFieldDocs, generateReportReqFieldDocEntries, generateReportReqFieldDocs, generateReportRespFieldDocEntries, generateReportRespFieldDocs, generateSecurityTokenReqFieldDocEntries, generateSecurityTokenReqFieldDocs, generateSecurityTokenRespFieldDocEntries, generateSecurityTokenRespFieldDocs, getLoyaltySystemsStatisticsReqFieldDocEntries, getLoyaltySystemsStatisticsReqFieldDocs, getLoyaltySystemsStatisticsRespFieldDocEntries, getLoyaltySystemsStatisticsRespFieldDocs, getParticipationCountRespFieldDocEntries, getParticipationCountRespFieldDocs, groupItemPropertiesFieldDocEntries, groupItemPropertiesFieldDocs, imagePreviewSizeFieldDocEntries, imagePreviewSizeFieldDocs, importByFileRequestFieldDocEntries, importByFileRequestFieldDocs, importByUniqueNameRequestFieldDocEntries, importByUniqueNameRequestFieldDocs, includeExcludeRespFieldDocEntries, includeExcludeRespFieldDocs, includeForUserReqFieldDocEntries, includeForUserReqFieldDocs, includeRespFieldDocEntries, includeRespFieldDocs, includeToGroupsReqFieldDocEntries, includeToGroupsReqFieldDocs, includeToParentReqFieldDocEntries, includeToParentReqFieldDocs, includedLinkMetaFieldDocEntries, includedLinkMetaFieldDocs, itemLinkKeyFieldDocEntries, itemLinkKeyFieldDocs, itemPropertiesFieldDocEntries, itemPropertiesFieldDocs, itemSortConditionFieldDocEntries, itemSortConditionFieldDocs, itemViewSortConditionFieldDocEntries, itemViewSortConditionFieldDocs, loyaltyCardSubscriptionFieldDocEntries, loyaltyCardSubscriptionFieldDocs, loyaltyCardsSdkMethodFieldDocEntries, loyaltyCardsSdkMethodFieldDocs, loyaltySystemsSdkMethodFieldDocEntries, loyaltySystemsSdkMethodFieldDocs, loyaltySystemsStatisticsReqFieldDocEntries, loyaltySystemsStatisticsReqFieldDocs, loyaltySystemsStatisticsRespFieldDocEntries, loyaltySystemsStatisticsRespFieldDocs, mapFieldDocsToStrings, mcpAuthFieldCatalog, mcpBookingFieldCatalog, mcpFullFieldCatalog, mcpItemFieldCatalog, mcpOperationsFieldCatalog, mcpRelationFieldCatalog, mcpSearchFieldCatalog, mcpUserProfilesFieldCatalog, mcpViewsFieldCatalog, metricsFieldDocEntries, metricsFieldDocs, noteItemFieldDocEntries, noteItemFieldDocs, noteTypeFieldDocEntries, noteTypeFieldDocs, notificationPropertiesFieldDocEntries, notificationPropertiesFieldDocs, objectInfoFieldDocEntries, objectInfoFieldDocs, objectSortConditionFieldDocEntries, objectSortConditionFieldDocs, operationTypeFieldDocEntries, operationTypeFieldDocs, orderFilterFieldDocEntries, orderFilterFieldDocs, participantStateFieldDocEntries, participantStateFieldDocs, participantTypeFieldDocEntries, participantTypeFieldDocs, participationFieldDocEntries, participationFieldDocs, participationFieldRequirementTypeFieldDocEntries, participationFieldRequirementTypeFieldDocs, participationFieldTypeFieldDocEntries, participationFieldTypeFieldDocs, participationRespFieldDocEntries, participationRespFieldDocs, paymentProviderTypeFieldDocEntries, paymentProviderTypeFieldDocs, personalSolutionDataFieldDocEntries, personalSolutionDataFieldDocs, profileListRespFieldDocEntries, profileListRespFieldDocs, profilePropertiesFieldDocEntries, profilePropertiesFieldDocs, profileTypeFieldDocEntries, profileTypeFieldDocs, profileUserAvailabilityFieldDocEntries, profileUserAvailabilityFieldDocs, profileWithErrorFieldDocEntries, profileWithErrorFieldDocs, profilesSdkMethodFieldDocEntries, profilesSdkMethodFieldDocs, putUrlRespFieldDocEntries, putUrlRespFieldDocs, refreshReqFieldDocEntries, refreshReqFieldDocs, relationsApiDomainFieldDocEntries, relationsApiDomainFieldDocs, relationsSdkMethodFieldDocEntries, relationsSdkMethodFieldDocs, reminderLocationDirectionFieldDocEntries, reminderLocationDirectionFieldDocs, removeProfileRespFieldDocEntries, removeProfileRespFieldDocs, reportDeliveryTypeFieldDocEntries, reportDeliveryTypeFieldDocs, reportOptionsFieldDocEntries, reportOptionsFieldDocs, reportPropertiesFieldDocEntries, reportPropertiesFieldDocs, reportsSdkMethodFieldDocEntries, reportsSdkMethodFieldDocs, resourceBehaviorSettingsFieldDocEntries, resourceBehaviorSettingsFieldDocs, resourceImplicitTagMethodsFieldDocEntries, resourceImplicitTagMethodsFieldDocs, resourceItemFieldDocEntries, resourceItemFieldDocs, resourceItemSpecificFieldDocEntries, resourceItemSpecificFieldDocs, revokeReqFieldDocEntries, revokeReqFieldDocs, saveItemToMindMapReqFieldDocEntries, saveItemToMindMapReqFieldDocs, searchSdkMethodFieldDocEntries, searchSdkMethodFieldDocs, sendCodeReqFieldDocEntries, sendCodeReqFieldDocs, sendCodeRespFieldDocEntries, sendCodeRespFieldDocs, sendCommunicationCodeReqFieldDocEntries, sendCommunicationCodeReqFieldDocs, sendCommunicationCodeRespFieldDocEntries, sendCommunicationCodeRespFieldDocs, sendLinkOfItemReqFieldDocEntries, sendLinkOfItemReqFieldDocs, sendLinkOfItemRespFieldDocEntries, sendLinkOfItemRespFieldDocs, serviceImplicitTagMethodsFieldDocEntries, serviceImplicitTagMethodsFieldDocs, serviceImplicitTagParamsFieldDocEntries, serviceImplicitTagParamsFieldDocs, serviceItemFieldDocEntries, serviceItemFieldDocs, serviceItemSpecificFieldDocEntries, serviceItemSpecificFieldDocs, shareItemReqFieldDocEntries, shareItemReqFieldDocs, showCaseInTimetableTypeFieldDocEntries, showCaseInTimetableTypeFieldDocs, solutionDataFieldDocEntries, solutionDataFieldDocs, ticketStateFieldDocEntries, ticketStateFieldDocs, tokenReqFieldDocEntries, tokenReqFieldDocs, tokenRespFieldDocEntries, tokenRespFieldDocs, torrowClientAuthConfigFieldDocEntries, torrowClientAuthConfigFieldDocs, torrowErrorClientFieldDocEntries, torrowErrorClientFieldDocs, torrowItemBaseFieldDocEntries, torrowItemBaseFieldDocs, torrowItemCoreFacadeSdkMethodFieldDocEntries, torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto, torrowItemCoreFacadeSdkMethodFieldDocs, torrowItemFacadeContactsItemSdkMethodFieldDocEntries, torrowItemFacadeContactsItemSdkMethodFieldDocs, torrowItemFacadeExtensionSdkMethodFieldDocEntries, torrowItemFacadePhotoEndpointSdkMethodFieldDocEntries, torrowItemFacadeSdkMethodFieldDocEntries, torrowItemFacadeSdkMethodFieldDocs, torrowObjectTypeFieldDocEntries, torrowObjectTypeFieldDocs, transactionInfoFieldDocEntries, transactionInfoFieldDocs, updateAnnouncementStateReqFieldDocEntries, updateAnnouncementStateReqFieldDocs, updateFileIdRespFieldDocEntries, updateFileIdRespFieldDocs, updateProfilePropertiesRespFieldDocEntries, updateProfilePropertiesRespFieldDocs, updateViewListOrderReqFieldDocEntries, updateViewListOrderReqFieldDocs, updateViewListOrderRespFieldDocEntries, updateViewListOrderRespFieldDocs, usageConditionFieldDocEntries, usageConditionFieldDocs, usageConditionTypeFieldDocEntries, usageConditionTypeFieldDocs, usageTypeFieldDocEntries, usageTypeFieldDocs, userDeliveryWayFieldDocEntries, userDeliveryWayFieldDocs, userSdkMethodFieldDocEntries, userSdkMethodFieldDocs, userSettingsInfoFieldDocEntries, userSettingsInfoFieldDocs, userSettingsSdkMethodFieldDocEntries, userSettingsSdkMethodFieldDocs, verifyCommunicationCodeReqFieldDocEntries, verifyCommunicationCodeReqFieldDocs, verifyCommunicationCodeRespFieldDocEntries, verifyCommunicationCodeRespFieldDocs, viewBlockSettingsFieldDocEntries, viewBlockSettingsFieldDocs, viewInfoFieldDocEntries, viewInfoFieldDocs, viewsSdkMethodFieldDocEntries, viewsSdkMethodFieldDocs };
|