@torrow/sdk-docs 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1225 -338
- package/dist/index.js +1442 -256
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -39,7 +39,7 @@ declare const torrowItemBaseFieldDocEntries: {
|
|
|
39
39
|
readonly image: {
|
|
40
40
|
readonly description: "Метаданные основного изображения/аватара элемента.";
|
|
41
41
|
readonly valueSchema: "FileInfo";
|
|
42
|
-
readonly usage: "Превью в карточке; загрузка через
|
|
42
|
+
readonly usage: "Превью в карточке; загрузка байтов через `.../image/puturl` (`fileId`, опционально `fileName`/`fileSize` в query), затем в теле **`create`**/**`update`** — **`{ id }`** (как torrow-apps). В ответах GET — полный **FileInfo** (`url`, `fileName`, …). **image/info**, **updateImageId** — после создания.";
|
|
43
43
|
};
|
|
44
44
|
readonly masterInfo: {
|
|
45
45
|
readonly description: "Заголовок, подзаголовок, локализованные строки для карточки и анонса.";
|
|
@@ -49,18 +49,18 @@ declare const torrowItemBaseFieldDocEntries: {
|
|
|
49
49
|
readonly publicityType: {
|
|
50
50
|
readonly description: "Кто может видеть элемент и как выдаётся доступ (персональный, по ссылке, публичный и т.д.).";
|
|
51
51
|
readonly examples: readonly ["Personal", "Link", "PublicAvailable", "PublicWithRequest", "Private", "Undefined"];
|
|
52
|
-
readonly usage: "Пайп `ttPublicityType` и настройки создания: Personal по умолчанию в формах; Link при создании дочернего ресурса от родителя (см. resource-item-business). Для карточек «только по ссылке» часто сочетается с `anyoneAccess: Read` и отключённым поиском (`searchMode: NoneSearchMode`).";
|
|
52
|
+
readonly usage: "Пайп `ttPublicityType` и настройки создания: Personal по умолчанию в формах; Link при создании дочернего ресурса от родителя (см. resource-item-business). Для карточек «только по ссылке» часто сочетается с `anyoneAccess: Read` и отключённым поиском (`searchMode: NoneSearchMode`). Текстовый **`client.search.*`** (contacts/notes/…) индексирует только **`PublicAvailable`** / **`PublicWithRequest`**; смена — **`updatePublicity`** (см. **`docs/agents/participation-flow.md`** §3).";
|
|
53
53
|
};
|
|
54
54
|
readonly searchMode: {
|
|
55
55
|
readonly description: "Участие элемента в поиске/выдаче (контракт API).";
|
|
56
56
|
readonly examples: readonly ["UnknownSearchMode", "NoneSearchMode", "Partial", "Full"];
|
|
57
|
-
readonly usage: "Фильтрация в списках и индексация. `NoneSearchMode` — элемент не ищется в общей выдаче, но может открываться по прямой ссылке/uniqueName.";
|
|
57
|
+
readonly usage: "Фильтрация в списках и индексация. `NoneSearchMode` — элемент не ищется в общей выдаче, но может открываться по прямой ссылке/uniqueName. В телах create/update SDK не передаётся: значение выставляет сервер от `publicityType`.";
|
|
58
58
|
};
|
|
59
59
|
readonly anyoneAccess: {
|
|
60
60
|
readonly description: "Параметры анонимного или широкого доступа без явного участия.";
|
|
61
61
|
readonly valueSchema: "AnyoneAccess";
|
|
62
62
|
readonly examples: readonly ["NoneAnyoneAccess", "Read", "ReadWrite", "Denied"];
|
|
63
|
-
readonly usage: "С `publicityType: Link` и `Read` аноним может читать карточку по ссылке в пределах прав сервера.";
|
|
63
|
+
readonly usage: "С `publicityType: Link` и `Read` аноним может читать карточку по ссылке в пределах прав сервера. В телах create/update SDK не передаётся: значение выставляет сервер от `publicityType`.";
|
|
64
64
|
};
|
|
65
65
|
readonly tags: {
|
|
66
66
|
readonly description: "Список строковых тегов (хэштеги) для группировки и фильтров.";
|
|
@@ -78,7 +78,7 @@ declare const torrowItemBaseFieldDocEntries: {
|
|
|
78
78
|
readonly blockInfo: {
|
|
79
79
|
readonly description: "Состояние и причина блокировки элемента.";
|
|
80
80
|
readonly valueSchema: "BlockInfo";
|
|
81
|
-
readonly usage: "
|
|
81
|
+
readonly usage: "Методы block/unblock по типу объекта (Case, Contact, Note, …). Выполняет только **администратор Torrow**; обычная сессия — HTTP 403.";
|
|
82
82
|
};
|
|
83
83
|
readonly groupInfo: {
|
|
84
84
|
readonly description: "Связь с группами, родителями, иерархией mind-map.";
|
|
@@ -148,7 +148,7 @@ declare const contactItemSpecificFieldDocEntries: {
|
|
|
148
148
|
readonly communications: {
|
|
149
149
|
readonly description: "Каналы связи: телефон, email, сайты, мессенджеры и т.д. У одного типа может быть несколько записей (например, несколько WebSite) — различаются полем order.";
|
|
150
150
|
readonly valueSchema: "Communication[]";
|
|
151
|
-
readonly usage: "У телефона в `value` — отображаемый формат, в `valueForSearch` — нормализованные цифры для поиска. У мессенджеров (`Telegram`, `Max`) `value` часто хранит идентификатор/handle
|
|
151
|
+
readonly usage: "У телефона в `value` — отображаемый формат, в `valueForSearch` — нормализованные цифры для поиска. У мессенджеров (`Telegram`, `Max`) `value` часто хранит идентификатор/handle. `checkDate` — read-only (ответ GET), в **`CommunicationForCreateOrUpdate`** нет. `checkState` опционален при create/update; если не передан — SDK подставляет `Unchecked`. Основной канал для уведомлений — `personalInfo.defaultCommunication`.";
|
|
152
152
|
};
|
|
153
153
|
readonly dates: {
|
|
154
154
|
readonly description: "Памятные даты (именины, юбилеи).";
|
|
@@ -196,16 +196,16 @@ declare const contactItemSpecificFieldDocEntries: {
|
|
|
196
196
|
readonly profileType: {
|
|
197
197
|
readonly description: "Роль контакта относительно учётной записи пользователя Torrow. Значения — строковый enum в OpenAPI (`ProfileType`). **Не путать с полем `visitCard`:** это разные вещи (см. ниже).";
|
|
198
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
|
|
199
|
+
readonly usage: "**Профиль** в продукте — это `ContactItem`, который описывает самого пользователя Torrow и привязан к его учётной записи. В API такой контакт помечается, в частности, значением **`MyProfile`**: участие в записях, обратная связь, выбор «с какого профиля действовать», личный кабинет. У одного пользователя может быть несколько таких контактов (лимит задаёт продукт). Список и добавление **Профилей** выполняются **отдельными операциями раздела User** в OpenAPI (например `GET`/`POST` **`/api/v1/user/profiles`**, ответы `ProfileListResp` / `AddProfileResp`), а не только общим CRUD контактов по `/api/v1/contacts/...`. В SDK: **`TorrowClient.profiles.list()`** возвращает **`ContactItem[]`** (ответ HTTP — **`ProfileListResp`**); описания — **`ProfilesSdkMethods`**, **`ProfileListResp`**, **`AddProfileResp`** в `mcpUserProfilesFieldCatalog`. Обычный контакт в адресной книге без роли профиля владельца — как правило **`None`** или отсутствие значения. **`AnyProfile`**, **`CopyProfile`**, **`UnknownProfile`** — прочие значения enum; уточняй по спецификации и ответам сервера. Поле **`visitCard`** — это **не** Профиль: это структура слотов отображения (как визитка на экране) и может быть у разных контактов, включая Профиль; сам факт «это Профиль пользователя» задаётся **`profileType`** и связью через API пользователя. Для **`POST /api/v1/contacts`** поля **`profileType`**, **`profileProperties`**, **`hasTimetable`** в типе **`ContactItemForCreateOrUpdate`** нет — они передаются при **`client.profiles.add`** в типе **`UserProfileItemForAdd`**.";
|
|
200
200
|
};
|
|
201
201
|
readonly activityStatus: {
|
|
202
|
-
readonly description: "Статус активности контакта в UI.";
|
|
202
|
+
readonly description: "Статус активности контакта в UI. **Только для чтения:** в теле `POST`/`PUT` контактов не задаётся; в **`TorrowItemForCreateOrUpdate`** / **`ContactItemForCreateOrUpdate`** поля нет (ключ **`activityStatus`** в `TorrowItemKeysExcludedFromItemWriteBody`).";
|
|
203
203
|
readonly valueSchema: "ActivityStatus";
|
|
204
204
|
};
|
|
205
205
|
readonly profileProperties: {
|
|
206
206
|
readonly description: "Расширенные свойства профиля.";
|
|
207
207
|
readonly valueSchema: "ProfileProperties";
|
|
208
|
-
readonly usage: "Часто содержит цвет акцента карточки (`color`, hex) и доступность владельца (`profileUserAvailability`).";
|
|
208
|
+
readonly usage: "Часто содержит цвет акцента карточки (`color`, hex) и доступность владельца (`profileUserAvailability`). В **`ContactItemForCreateOrUpdate`** поля нет — передаётся в **`UserProfileItemForAdd`** при **`client.profiles.add`**.";
|
|
209
209
|
};
|
|
210
210
|
readonly contactProperties: {
|
|
211
211
|
readonly description: "Настройки контакта: видимость расписания контакта (`timetableVisibility`), кто может приглашать (`invitationRight`), право видеть расписание (`timetableVisibilityRight`).";
|
|
@@ -215,7 +215,7 @@ declare const contactItemSpecificFieldDocEntries: {
|
|
|
215
215
|
readonly hasTimetable: {
|
|
216
216
|
readonly description: "Признак: у контакта заведено расписание (слоты).";
|
|
217
217
|
readonly examples: readonly ["true", "false"];
|
|
218
|
-
readonly usage: "Может быть false, даже если у вложенных услуг есть бронирование: расписание живёт на услуге, а не на контакте.";
|
|
218
|
+
readonly usage: "Может быть false, даже если у вложенных услуг есть бронирование: расписание живёт на услуге, а не на контакте. В **`ContactItemForCreateOrUpdate`** поля нет — в **`UserProfileItemForAdd`** при создании Профиля.";
|
|
219
219
|
};
|
|
220
220
|
readonly loyaltyCard: {
|
|
221
221
|
readonly description: "Вложенный элемент — карта лояльности, привязанная к контакту.";
|
|
@@ -240,10 +240,26 @@ declare const noteItemFieldDocs: {
|
|
|
240
240
|
[x: string]: string;
|
|
241
241
|
};
|
|
242
242
|
|
|
243
|
+
declare const notesSdkMethodFieldDocEntries: {
|
|
244
|
+
readonly getFileInfo: {
|
|
245
|
+
readonly description: "`GET /api/v1/notes/{torrowId}/file/info` → **`FileInfo`**. Query **`fileId`** — id вложения из `files[]` (обязателен при нескольких файлах).";
|
|
246
|
+
readonly valueSchema: "(torrowId: string, fileId: string, options?: { signal? }) → FileInfo";
|
|
247
|
+
readonly usage: "Скачивание вложения: если в **`NoteItem.files`** у элемента с этим `id` есть живой `url` (`urlExpiration` > now), можно брать URL оттуда; иначе **`client.notes.getFileInfo(noteId, fileId)`**. Пример: **`notes-file-text-urls.ts`**, **`notes-file-image-urls.ts`**.";
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
declare const notesSdkMethodFieldDocs: {
|
|
251
|
+
readonly getFileInfo: string;
|
|
252
|
+
};
|
|
253
|
+
|
|
243
254
|
/**
|
|
244
255
|
* **`ContextItem`** — группа/метка для организации элементов.
|
|
245
256
|
*/
|
|
246
257
|
|
|
258
|
+
/** Справочник ключей пресет-иконок (wire — basename `*.svg`, не отдельное поле DTO). */
|
|
259
|
+
declare const contextIconPresetValuesFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
260
|
+
declare const contextIconPresetValuesFieldDocs: {
|
|
261
|
+
[x: string]: string;
|
|
262
|
+
};
|
|
247
263
|
declare const contextItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
248
264
|
declare const contextItemFieldDocs: {
|
|
249
265
|
[x: string]: string;
|
|
@@ -253,11 +269,123 @@ declare const contextItemFieldDocs: {
|
|
|
253
269
|
* **`CalendarItem`**
|
|
254
270
|
*/
|
|
255
271
|
|
|
272
|
+
/**
|
|
273
|
+
* Индексы вида расписания (`calendarViewIndex` / `timetableView`) для MCP.
|
|
274
|
+
* В JSON — **число**; имена Day/Schedule — только подписи (как `LayoutTypeValues`).
|
|
275
|
+
*/
|
|
276
|
+
declare const timetableViewTypeValuesFieldDocEntries: {
|
|
277
|
+
readonly value: {
|
|
278
|
+
readonly description: "Справочник int-кодов вида расписания по умолчанию (`CalendarItem.calendarViewIndex`, `ServiceItem.timetableView`). Не OpenAPI-enum: в теле API передавай **число** (`0`…`5`).";
|
|
279
|
+
readonly valueSchema: "TimetableViewTypeValues";
|
|
280
|
+
readonly examples: readonly ["0", "1", "2", "3", "4", "5"];
|
|
281
|
+
readonly usage: "UI apps: Day / Poster / Schedule. В TypeScript SDK — `TimetableViewTypeValues.*` (то же число). Не передавай имя `Schedule` строкой — только int.";
|
|
282
|
+
};
|
|
283
|
+
readonly Day: {
|
|
284
|
+
readonly description: "`0` — вид «День» (дефолт формы календаря в apps, если тип не выбран явно).";
|
|
285
|
+
readonly examples: readonly ["0"];
|
|
286
|
+
readonly valueSchema: "TimetableViewTypeValues";
|
|
287
|
+
};
|
|
288
|
+
readonly Month: {
|
|
289
|
+
readonly description: "`1` — вид «Месяц» (в UI календаря часто скрыт).";
|
|
290
|
+
readonly examples: readonly ["1"];
|
|
291
|
+
readonly valueSchema: "TimetableViewTypeValues";
|
|
292
|
+
};
|
|
293
|
+
readonly MonthEventList: {
|
|
294
|
+
readonly description: "`2` — список событий месяца.";
|
|
295
|
+
readonly examples: readonly ["2"];
|
|
296
|
+
readonly valueSchema: "TimetableViewTypeValues";
|
|
297
|
+
};
|
|
298
|
+
readonly ConnectCalendar: {
|
|
299
|
+
readonly description: "`3` — подключённый/внешний календарь.";
|
|
300
|
+
readonly examples: readonly ["3"];
|
|
301
|
+
readonly valueSchema: "TimetableViewTypeValues";
|
|
302
|
+
};
|
|
303
|
+
readonly Poster: {
|
|
304
|
+
readonly description: "`4` — «Афиша».";
|
|
305
|
+
readonly examples: readonly ["4"];
|
|
306
|
+
readonly valueSchema: "TimetableViewTypeValues";
|
|
307
|
+
};
|
|
308
|
+
readonly Schedule: {
|
|
309
|
+
readonly description: "`5` — «Список событий» / Schedule.";
|
|
310
|
+
readonly examples: readonly ["5"];
|
|
311
|
+
readonly valueSchema: "TimetableViewTypeValues";
|
|
312
|
+
};
|
|
313
|
+
};
|
|
314
|
+
declare const timetableViewTypeValuesFieldDocs: {
|
|
315
|
+
readonly value: string;
|
|
316
|
+
readonly Day: string;
|
|
317
|
+
readonly Month: string;
|
|
318
|
+
readonly MonthEventList: string;
|
|
319
|
+
readonly ConnectCalendar: string;
|
|
320
|
+
readonly Poster: string;
|
|
321
|
+
readonly Schedule: string;
|
|
322
|
+
};
|
|
256
323
|
declare const calendarItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
257
324
|
declare const calendarItemFieldDocs: {
|
|
258
325
|
[x: string]: string;
|
|
259
326
|
};
|
|
260
327
|
|
|
328
|
+
/**
|
|
329
|
+
* **`LoyaltySystemItem`** — поля create/update, критичные для MCP
|
|
330
|
+
* (wire-строки OpenAPI в `examples`, не имена TS-констант).
|
|
331
|
+
*/
|
|
332
|
+
|
|
333
|
+
declare const loyaltySystemItemFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
334
|
+
declare const loyaltySystemItemFieldDocs: {
|
|
335
|
+
[x: string]: string;
|
|
336
|
+
};
|
|
337
|
+
|
|
338
|
+
declare const sessionDurationPropertiesFieldDocEntries: {
|
|
339
|
+
readonly sessionDurationType: {
|
|
340
|
+
readonly description: "Тип длительности сессии. В JSON — **строка** OpenAPI: `Sum`, `Constant`, `Custom`, `SessionDurationNone`, … Каталог MCP **`SessionDurationType`**.";
|
|
341
|
+
readonly examples: readonly ["Sum", "Constant", "Custom", "SessionDurationNone"];
|
|
342
|
+
readonly valueSchema: "SessionDurationType";
|
|
343
|
+
};
|
|
344
|
+
readonly timeSelectionType: {
|
|
345
|
+
readonly description: "Кто выбирает время. В JSON — **строка**: `Consumer`, `Executor`, `TimeSelectionNone`. Каталог **`TimeSelectionType`**.";
|
|
346
|
+
readonly examples: readonly ["Consumer", "Executor", "TimeSelectionNone"];
|
|
347
|
+
readonly valueSchema: "TimeSelectionType";
|
|
348
|
+
};
|
|
349
|
+
readonly stateManagementType: {
|
|
350
|
+
readonly description: "Авто/ручное управление состоянием. В JSON — **строка**: `Auto`, `Manual`. Каталог **`StateManagementType`**.";
|
|
351
|
+
readonly examples: readonly ["Auto", "Manual"];
|
|
352
|
+
readonly valueSchema: "StateManagementType";
|
|
353
|
+
};
|
|
354
|
+
readonly sessionPrecisionType: {
|
|
355
|
+
readonly description: "Точность слота. В JSON — **строка**: `DateTime`, `Date`. Каталог **`SessionPrecisionType`**.";
|
|
356
|
+
readonly examples: readonly ["DateTime", "Date"];
|
|
357
|
+
readonly valueSchema: "SessionPrecisionType";
|
|
358
|
+
};
|
|
359
|
+
readonly defaultDuration: {
|
|
360
|
+
readonly description: "Длительность по умолчанию в секундах (для `Constant` / кастомных сценариев).";
|
|
361
|
+
readonly examples: readonly ["3600"];
|
|
362
|
+
readonly valueSchema: "int32 | null";
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
declare const sessionDurationPropertiesFieldDocs: {
|
|
366
|
+
readonly sessionDurationType: string;
|
|
367
|
+
readonly timeSelectionType: string;
|
|
368
|
+
readonly stateManagementType: string;
|
|
369
|
+
readonly sessionPrecisionType: string;
|
|
370
|
+
readonly defaultDuration: string;
|
|
371
|
+
};
|
|
372
|
+
declare const checkinPermissionFieldDocEntries: {
|
|
373
|
+
readonly userAccessLevel: {
|
|
374
|
+
readonly description: "Кто может check-in / запись. В JSON — **строка** OpenAPI: `Authenticated`, `Unauthenticated`. Каталог MCP **`UserAccessLevel`**.";
|
|
375
|
+
readonly examples: readonly ["Authenticated", "Unauthenticated"];
|
|
376
|
+
readonly valueSchema: "UserAccessLevel";
|
|
377
|
+
};
|
|
378
|
+
readonly consumerMinTimeSecBetweenCasesInService: {
|
|
379
|
+
readonly description: "Минимальный интервал (сек) между кейсами одного потребителя в услуге.";
|
|
380
|
+
readonly examples: readonly ["0", "3600"];
|
|
381
|
+
readonly valueSchema: "int32 | null";
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
declare const checkinPermissionFieldDocs: {
|
|
385
|
+
readonly userAccessLevel: string;
|
|
386
|
+
readonly consumerMinTimeSecBetweenCasesInService: string;
|
|
387
|
+
};
|
|
388
|
+
|
|
261
389
|
/**
|
|
262
390
|
* **`ResourceItem`** — продуктовый ресурс (слот, аренда, билет и т.д.).
|
|
263
391
|
* @see resource-item-business: publicity Link при создании с parentId
|
|
@@ -379,8 +507,10 @@ declare const serviceItemSpecificFieldDocEntries: {
|
|
|
379
507
|
readonly examples: readonly ["3600"];
|
|
380
508
|
};
|
|
381
509
|
readonly timetableView: {
|
|
382
|
-
readonly description: "
|
|
383
|
-
readonly examples: readonly ["0", "
|
|
510
|
+
readonly description: "Вид расписания по умолчанию — **int** в JSON: `0` Day … `5` Schedule (см. MCP **`TimetableViewTypeValues`**). Не строка.";
|
|
511
|
+
readonly examples: readonly ["0", "4", "5"];
|
|
512
|
+
readonly valueSchema: "TimetableViewTypeValues | int32 | null";
|
|
513
|
+
readonly usage: "UI: `SERVICE_FORM.TYPE_INPUT`. То же число, что `CalendarItem.calendarViewIndex`.";
|
|
384
514
|
};
|
|
385
515
|
readonly registrationOpen: {
|
|
386
516
|
readonly description: "Граница открытия записи (смещение или метка — уточнять по Swagger).";
|
|
@@ -434,7 +564,7 @@ declare const serviceItemSpecificFieldDocEntries: {
|
|
|
434
564
|
readonly valueSchema: "Appendix[]";
|
|
435
565
|
};
|
|
436
566
|
readonly sessionDurationProperties: {
|
|
437
|
-
readonly description: "Правила длительности
|
|
567
|
+
readonly description: "Правила длительности сессии. Поля-enum — **строки OpenAPI** (`Sum`, `Consumer`, `Auto`, `DateTime`, …); каталоги MCP: `SessionDurationType`, `TimeSelectionType`, `StateManagementType`, `SessionPrecisionType`.";
|
|
438
568
|
readonly valueSchema: "SessionDurationProperties";
|
|
439
569
|
};
|
|
440
570
|
readonly checkInAllCases: {
|
|
@@ -442,7 +572,7 @@ declare const serviceItemSpecificFieldDocEntries: {
|
|
|
442
572
|
readonly examples: readonly ["true", "false"];
|
|
443
573
|
};
|
|
444
574
|
readonly stepDescriptionList: {
|
|
445
|
-
readonly description: "Пошаговое описание сценария услуги.";
|
|
575
|
+
readonly description: "Пошаговое описание сценария услуги. `stepType` — **число** (`1` Time, `2` Resource, `3` Payment); см. `StepDescription`.";
|
|
446
576
|
readonly valueSchema: "StepDescription[]";
|
|
447
577
|
};
|
|
448
578
|
readonly buttonName: {
|
|
@@ -462,7 +592,7 @@ declare const serviceItemSpecificFieldDocEntries: {
|
|
|
462
592
|
readonly valueSchema: "PriceInfo";
|
|
463
593
|
};
|
|
464
594
|
readonly checkinPermission: {
|
|
465
|
-
readonly description: "Кто и когда может отметить прибытие.";
|
|
595
|
+
readonly description: "Кто и когда может отметить прибытие. `userAccessLevel` — строка OpenAPI (`Authenticated` / `Unauthenticated`); каталог MCP **`UserAccessLevel`** / схема **`CheckinPermission`**.";
|
|
466
596
|
readonly valueSchema: "CheckinPermission";
|
|
467
597
|
};
|
|
468
598
|
readonly caseActionList: {
|
|
@@ -594,7 +724,7 @@ declare const caseItemSpecificFieldDocEntries: {
|
|
|
594
724
|
readonly examples: readonly ["ORD-2025-0042"];
|
|
595
725
|
};
|
|
596
726
|
readonly checkinPermission: {
|
|
597
|
-
readonly description: "Права на чек-ин.";
|
|
727
|
+
readonly description: "Права на чек-ин. `userAccessLevel` — строка OpenAPI (`Authenticated` / …); см. MCP **`UserAccessLevel`** / **`CheckinPermission`**.";
|
|
598
728
|
readonly valueSchema: "CheckinPermission";
|
|
599
729
|
};
|
|
600
730
|
readonly hidden: {
|
|
@@ -717,6 +847,7 @@ declare const mcpItemFieldCatalog: {
|
|
|
717
847
|
ResourceItem: Record<string, ItemFieldDoc>;
|
|
718
848
|
ServiceItem: Record<string, ItemFieldDoc>;
|
|
719
849
|
CaseItem: Record<string, ItemFieldDoc>;
|
|
850
|
+
LoyaltySystemItem: Record<string, ItemFieldDoc>;
|
|
720
851
|
ObjectInfo: Record<string, ItemFieldDoc>;
|
|
721
852
|
};
|
|
722
853
|
|
|
@@ -730,7 +861,8 @@ declare const mcpBookingFieldCatalog: Record<string, Record<string, ItemFieldDoc
|
|
|
730
861
|
/**
|
|
731
862
|
* Описания схем токенов и конфигурации авторизации для MCP / агентов.
|
|
732
863
|
* Ключи верхнего уровня: `TokenResp`, `RefreshReq`, `TokenReq`, `RevokeReq` совпадают с `components.schemas`;
|
|
733
|
-
* `TorrowClientConfigAuth` — условное имя для
|
|
864
|
+
* `TorrowClientConfigAuth` — условное имя для поля {@link TorrowClientConfig.getAccessToken} в справочнике MCP.
|
|
865
|
+
* `GuestAccessSecurityToken` — как и зачем передавать гостевой query/body **`securityToken`** (не Bearer).
|
|
734
866
|
*/
|
|
735
867
|
|
|
736
868
|
declare const mcpAuthFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
@@ -741,6 +873,12 @@ declare const mcpAuthFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
|
741
873
|
|
|
742
874
|
declare const mcpSearchFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
743
875
|
|
|
876
|
+
/**
|
|
877
|
+
* Каталог методов **`client.notes`** для MCP и агентов. Объединяется в {@link mcpFullFieldCatalog}.
|
|
878
|
+
*/
|
|
879
|
+
|
|
880
|
+
declare const mcpNotesFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
881
|
+
|
|
744
882
|
/**
|
|
745
883
|
* Каталоги операций (**TorrowItemCoreFacade**, ActionHistory, Accounting, Announcement, ExportImport, Report, Loyalty*, BlockReason, Contacts communication) для {@link mcpFullFieldCatalog}.
|
|
746
884
|
*/
|
|
@@ -761,7 +899,7 @@ declare const mcpViewsFieldCatalog: Record<string, Record<string, ItemFieldDoc>>
|
|
|
761
899
|
|
|
762
900
|
/**
|
|
763
901
|
* Каталог описаний схем **связей и mind map** для MCP / агентов.
|
|
764
|
-
* Имена верхнего уровня совпадают с `components.schemas` в OpenAPI (кроме `
|
|
902
|
+
* Имена верхнего уровня совпадают с `components.schemas` в OpenAPI (кроме `RelationsSdkMethods`).
|
|
765
903
|
*/
|
|
766
904
|
|
|
767
905
|
declare const mcpRelationFieldCatalog: Record<string, Record<string, ItemFieldDoc>>;
|
|
@@ -776,7 +914,7 @@ declare const accountingTransactionsSdkMethodFieldDocEntries: {
|
|
|
776
914
|
readonly description: "`PUT /api/v1/accountingtransactions/{torrowId}` — полное обновление DTO.";
|
|
777
915
|
};
|
|
778
916
|
readonly delete: {
|
|
779
|
-
readonly description: "`DELETE /api/v1/accountingtransactions/{torrowId}` → **`
|
|
917
|
+
readonly description: "`DELETE /api/v1/accountingtransactions/{torrowId}` → число **`deleteCount`**.";
|
|
780
918
|
};
|
|
781
919
|
readonly updateState: {
|
|
782
920
|
readonly description: "`PUT .../state` — смена состояния через query **`state`** (`AccountingTransactionState`).";
|
|
@@ -785,7 +923,7 @@ declare const accountingTransactionsSdkMethodFieldDocEntries: {
|
|
|
785
923
|
readonly description: "`GET .../balance` — массив **`BalanceValue`**; опционально **`balanceDate`**.";
|
|
786
924
|
};
|
|
787
925
|
readonly listTransactions: {
|
|
788
|
-
readonly description:
|
|
926
|
+
readonly description: string;
|
|
789
927
|
};
|
|
790
928
|
};
|
|
791
929
|
declare const accountingTransactionsSdkMethodFieldDocs: {
|
|
@@ -798,7 +936,7 @@ declare const accountingTransactionsSdkMethodFieldDocs: {
|
|
|
798
936
|
};
|
|
799
937
|
declare const announcementsSdkMethodFieldDocEntries: {
|
|
800
938
|
readonly list: {
|
|
801
|
-
readonly description:
|
|
939
|
+
readonly description: string;
|
|
802
940
|
};
|
|
803
941
|
readonly updateState: {
|
|
804
942
|
readonly description: "`POST /api/v1/announcements/updatestate` — массив **`UpdateAnnouncementStateReq`** → **`TorrowObject[]`**.";
|
|
@@ -838,7 +976,7 @@ declare const reportsSdkMethodFieldDocs: {
|
|
|
838
976
|
};
|
|
839
977
|
declare const actionHistorySdkMethodFieldDocEntries: {
|
|
840
978
|
readonly list: {
|
|
841
|
-
readonly description:
|
|
979
|
+
readonly description: string;
|
|
842
980
|
};
|
|
843
981
|
};
|
|
844
982
|
declare const actionHistorySdkMethodFieldDocs: {
|
|
@@ -852,7 +990,7 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
|
852
990
|
readonly description: "`PUT /api/v1/loyaltysystems/{torrowId}`.";
|
|
853
991
|
};
|
|
854
992
|
readonly delete: {
|
|
855
|
-
readonly description:
|
|
993
|
+
readonly description: string;
|
|
856
994
|
};
|
|
857
995
|
readonly getById: {
|
|
858
996
|
readonly description: "`GET /api/v1/loyaltysystems/{torrowId}`.";
|
|
@@ -864,10 +1002,13 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
|
864
1002
|
readonly description: "`DELETE .../personallist/{torrowId}`.";
|
|
865
1003
|
};
|
|
866
1004
|
readonly createLoyaltyCard: {
|
|
867
|
-
readonly description: "`POST .../{loyaltySystemId}/loyaltycard` — **`CreateLoyaltyCardReq`** (
|
|
1005
|
+
readonly description: "`POST .../{loyaltySystemId}/loyaltycard` — тело **`CreateLoyaltyCardReq`** (`profileId` обязателен; опционально **`basisItemId`** — элемент-основание карты/абонемента, напр. заказ). Поля: каталог MCP **`CreateLoyaltyCardReq`**.";
|
|
1006
|
+
};
|
|
1007
|
+
readonly searchLoyaltyCards: {
|
|
1008
|
+
readonly description: "`POST .../{torrowId}/loyaltycards` — поиск карт в программе; тело **`SearchLoyaltyCardsReq`** (`text`, `filter`, `sort`, `take`/`skip`). В apps: `SearchLoyaltyCardsTask`.";
|
|
868
1009
|
};
|
|
869
1010
|
readonly postStatistics: {
|
|
870
|
-
readonly description: "`POST /api/v1/loyaltysystems/statistics` — **`GetLoyaltySystemsStatisticsReq`**.";
|
|
1011
|
+
readonly description: "`POST /api/v1/loyaltysystems/statistics` — тело **`GetLoyaltySystemsStatisticsReq`**; ответ SDK: **`LoyaltySystemsStatisticsResp[]`**.";
|
|
871
1012
|
};
|
|
872
1013
|
readonly getParticipantsCount: {
|
|
873
1014
|
readonly description: "`GET .../{torrowId}/participants/count`.";
|
|
@@ -888,19 +1029,19 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
|
888
1029
|
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
889
1030
|
};
|
|
890
1031
|
readonly listParticipants: {
|
|
891
|
-
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty***
|
|
1032
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** (`Offered`/`Requested`/`Accepted`/…) / **`participantTypeList`**, пагинация; у **loyalty*** query **`lmFrom`/`lmTo`**, у **contact/case** — **`lmfrom`/`lmto`**. Флоу статусов: **`docs/agents/participation-flow.md`**.";
|
|
892
1033
|
};
|
|
893
1034
|
readonly generateSecurityToken: {
|
|
894
|
-
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1035
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**. Внешняя ссылка: `participantType` **Reader** (обычная) или **Owner** (ссылка управления); получатель сохраняет через **`saveToMindMap({ securityToken })`**. Apps: `ShareWithRightsService`.";
|
|
895
1036
|
};
|
|
896
1037
|
readonly updateParticipationType: {
|
|
897
1038
|
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
898
1039
|
};
|
|
899
1040
|
readonly requestAccess: {
|
|
900
|
-
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId
|
|
1041
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`**; query **`userMessage`**. State → **`Requested`**; владельцу — announcement **`RequestAccessToItem`**. Не для владельца своего item. Флоу: **`docs/agents/participation-flow.md`**.";
|
|
901
1042
|
};
|
|
902
1043
|
readonly revokeAccessRequest: {
|
|
903
|
-
readonly description: "`PUT .../participation/revokerequest
|
|
1044
|
+
readonly description: "`PUT .../participation/revokerequest` — requester отменяет свой **`Requested`** → **`Revoked`**.";
|
|
904
1045
|
};
|
|
905
1046
|
readonly setGroup: {
|
|
906
1047
|
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
@@ -911,14 +1052,14 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
|
911
1052
|
readonly updateTags: {
|
|
912
1053
|
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
913
1054
|
};
|
|
914
|
-
readonly
|
|
915
|
-
readonly description: "`GET .../{
|
|
1055
|
+
readonly listGroups: {
|
|
1056
|
+
readonly description: "`GET .../{parentId}/group/list` — **группы родительского элемента, доступные для включения дочерних элементов** (torrow-apps: `getGroups(parentId)`). В apps при пустом `group/list` UI часто даёт `[parent]`. **Не** члены группы. Члены: `search.*(…, { groupIds })`. У **loyaltycards** пути нет → SDK бросает (`withGroupListEndpoint: false`).";
|
|
916
1057
|
};
|
|
917
1058
|
readonly updateGroups: {
|
|
918
1059
|
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
919
1060
|
};
|
|
920
1061
|
readonly includeToGroups: {
|
|
921
|
-
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1062
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**. После include члены группы проверяй через `search.*(…, { groupIds })`, не через `listGroups`.";
|
|
922
1063
|
};
|
|
923
1064
|
readonly excludeFromGroups: {
|
|
924
1065
|
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
@@ -927,31 +1068,31 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
|
927
1068
|
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
928
1069
|
};
|
|
929
1070
|
readonly excludeFromParent: {
|
|
930
|
-
readonly description: "`PUT .../{parentId}/exclude/items` —
|
|
1071
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
931
1072
|
};
|
|
932
1073
|
readonly includeForUser: {
|
|
933
1074
|
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
934
1075
|
};
|
|
935
1076
|
readonly excludeFromUser: {
|
|
936
|
-
readonly description: "`PUT .../{parentId}/exclude/fromuser` —
|
|
1077
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
937
1078
|
};
|
|
938
1079
|
readonly rejectOffer: {
|
|
939
|
-
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1080
|
+
readonly description: "`PUT .../participation/rejectoffer` — invitee отклоняет **`Offered`** → **`Rejected`**; body: **`profileId`**; query **`userMessage`**.";
|
|
940
1081
|
};
|
|
941
1082
|
readonly reject: {
|
|
942
1083
|
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
943
1084
|
};
|
|
944
1085
|
readonly share: {
|
|
945
|
-
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1086
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**. Создаёт **`Offered`**; invitee — announcement **`ShareItem`**. Принять = **`saveToMindMap`** (нет `acceptOffer`). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
946
1087
|
};
|
|
947
1088
|
readonly revokeOffer: {
|
|
948
|
-
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1089
|
+
readonly description: "`PUT .../participation/revokeoffer` — владелец отзывает **`Offered`** → **`Revoked`**; body: `string[]` (**profileIds**).";
|
|
949
1090
|
};
|
|
950
1091
|
readonly grantAccess: {
|
|
951
|
-
readonly description: "`PUT .../participation/grantaccess` — body: `string[]
|
|
1092
|
+
readonly description: "`PUT .../participation/grantaccess` — владелец принимает **`Requested`** → **`Accepted`**; body: `string[]` (**profileIds**).";
|
|
952
1093
|
};
|
|
953
1094
|
readonly declineAccess: {
|
|
954
|
-
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1095
|
+
readonly description: "`PUT .../participation/declineaccess` — владелец отклоняет **`Requested`** → **`Declined`**; body: `string[]`; query **`userMessage`**.";
|
|
955
1096
|
};
|
|
956
1097
|
readonly updatePersonalListOrder: {
|
|
957
1098
|
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
@@ -966,10 +1107,10 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
|
966
1107
|
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
967
1108
|
};
|
|
968
1109
|
readonly sendLink: {
|
|
969
|
-
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1110
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**. In-app ссылка (**`SendLinkOfItem`**); **не** создаёт `Offered`.";
|
|
970
1111
|
};
|
|
971
1112
|
readonly getShortUrl: {
|
|
972
|
-
readonly description: "`POST .../{torrowId}/shorturl` → `string
|
|
1113
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string` (короткая URL элемента).";
|
|
973
1114
|
};
|
|
974
1115
|
readonly updateUniqueName: {
|
|
975
1116
|
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
@@ -981,10 +1122,10 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
|
|
|
981
1122
|
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
982
1123
|
};
|
|
983
1124
|
readonly getImagePutUrl: {
|
|
984
|
-
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload;
|
|
1125
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; параметры **`fileId`**, **`fileName?`**, **`fileSize?`** (query). SDK: **`{ url, urlExpiration }`**.";
|
|
985
1126
|
};
|
|
986
1127
|
readonly saveToMindMap: {
|
|
987
|
-
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1128
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**. Accept invite (`Offered`→`Accepted`), open/link save, или save с **`securityToken`** (Reader/Owner link). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
988
1129
|
};
|
|
989
1130
|
readonly updateSolutionData: {
|
|
990
1131
|
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1001,6 +1142,7 @@ declare const loyaltySystemsSdkMethodFieldDocs: {
|
|
|
1001
1142
|
readonly listPersonal: string;
|
|
1002
1143
|
readonly deleteFromPersonalList: string;
|
|
1003
1144
|
readonly createLoyaltyCard: string;
|
|
1145
|
+
readonly searchLoyaltyCards: string;
|
|
1004
1146
|
readonly postStatistics: string;
|
|
1005
1147
|
readonly getParticipantsCount: string;
|
|
1006
1148
|
readonly updatePublicity: string;
|
|
@@ -1016,7 +1158,7 @@ declare const loyaltySystemsSdkMethodFieldDocs: {
|
|
|
1016
1158
|
readonly setGroup: string;
|
|
1017
1159
|
readonly unsetGroup: string;
|
|
1018
1160
|
readonly updateTags: string;
|
|
1019
|
-
readonly
|
|
1161
|
+
readonly listGroups: string;
|
|
1020
1162
|
readonly updateGroups: string;
|
|
1021
1163
|
readonly includeToGroups: string;
|
|
1022
1164
|
readonly excludeFromGroups: string;
|
|
@@ -1049,7 +1191,7 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
|
1049
1191
|
readonly description: "`PUT /api/v1/loyaltycards/{torrowId}` — **`LoyaltyCardItem`**.";
|
|
1050
1192
|
};
|
|
1051
1193
|
readonly delete: {
|
|
1052
|
-
readonly description:
|
|
1194
|
+
readonly description: string;
|
|
1053
1195
|
};
|
|
1054
1196
|
readonly getById: {
|
|
1055
1197
|
readonly description: "`GET ...` — опционально **`includeBalance`** (по умолчанию в API true).";
|
|
@@ -1061,7 +1203,7 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
|
1061
1203
|
readonly description: "`DELETE .../personallist/{torrowId}`.";
|
|
1062
1204
|
};
|
|
1063
1205
|
readonly createSubscription: {
|
|
1064
|
-
readonly description: "`POST /api/v1/loyaltycards/{loyaltyCardId}/subscription` — **`CreateLoyaltyCardSubscriptionReq`** → **`LoyaltyCardSubscription`**.";
|
|
1206
|
+
readonly description: "`POST /api/v1/loyaltycards/{loyaltyCardId}/subscription` — **`CreateLoyaltyCardSubscriptionReq`** → **`LoyaltyCardSubscription`**; у **`initialTransaction.basisItemId`** — то же основание (заказ и т.п.), см. MCP **`InitialTransaction`**.";
|
|
1065
1207
|
};
|
|
1066
1208
|
readonly getParticipantsCount: {
|
|
1067
1209
|
readonly description: "`GET .../{torrowId}/participants/count`.";
|
|
@@ -1078,8 +1220,11 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
|
1078
1220
|
readonly getSubscriptionTransactions: {
|
|
1079
1221
|
readonly description: "`GET .../subscriptions/{subscriptionId}/transactions`.";
|
|
1080
1222
|
};
|
|
1223
|
+
readonly getTimetable: {
|
|
1224
|
+
readonly description: "`PUT /api/v1/loyaltycards/{torrowId}/timetable` — тело **`TimetableFilter`**, query **`TimetableQueryOptions`**; ответ **`TimetableCase[]`**. В apps: `LoyaltyCardClient.getTimetable`.";
|
|
1225
|
+
};
|
|
1081
1226
|
readonly getTimetableStatistics: {
|
|
1082
|
-
readonly description: "`POST /api/v1/loyaltycards/timetable/statistics` — **`GetTimetableStatisticsRequest
|
|
1227
|
+
readonly description: "`POST /api/v1/loyaltycards/timetable/statistics` — **`GetTimetableStatisticsRequest`**; SDK: **`TimetableStatisticsResp[]`**.";
|
|
1083
1228
|
};
|
|
1084
1229
|
readonly updateNotificationWayList: {
|
|
1085
1230
|
readonly description: "`PUT .../{itemId}/notificationwaylist` — у **loyaltycards** в OpenAPI есть путь; у **loyaltysystems** нет — метод только на **`LoyaltyCards`**.";
|
|
@@ -1109,19 +1254,19 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
|
1109
1254
|
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1110
1255
|
};
|
|
1111
1256
|
readonly listParticipants: {
|
|
1112
|
-
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty***
|
|
1257
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** (`Offered`/`Requested`/`Accepted`/…) / **`participantTypeList`**, пагинация; у **loyalty*** query **`lmFrom`/`lmTo`**, у **contact/case** — **`lmfrom`/`lmto`**. Флоу статусов: **`docs/agents/participation-flow.md`**.";
|
|
1113
1258
|
};
|
|
1114
1259
|
readonly generateSecurityToken: {
|
|
1115
|
-
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1260
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**. Внешняя ссылка: `participantType` **Reader** (обычная) или **Owner** (ссылка управления); получатель сохраняет через **`saveToMindMap({ securityToken })`**. Apps: `ShareWithRightsService`.";
|
|
1116
1261
|
};
|
|
1117
1262
|
readonly updateParticipationType: {
|
|
1118
1263
|
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1119
1264
|
};
|
|
1120
1265
|
readonly requestAccess: {
|
|
1121
|
-
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId
|
|
1266
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`**; query **`userMessage`**. State → **`Requested`**; владельцу — announcement **`RequestAccessToItem`**. Не для владельца своего item. Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1122
1267
|
};
|
|
1123
1268
|
readonly revokeAccessRequest: {
|
|
1124
|
-
readonly description: "`PUT .../participation/revokerequest
|
|
1269
|
+
readonly description: "`PUT .../participation/revokerequest` — requester отменяет свой **`Requested`** → **`Revoked`**.";
|
|
1125
1270
|
};
|
|
1126
1271
|
readonly setGroup: {
|
|
1127
1272
|
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
@@ -1132,14 +1277,14 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
|
1132
1277
|
readonly updateTags: {
|
|
1133
1278
|
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1134
1279
|
};
|
|
1135
|
-
readonly
|
|
1136
|
-
readonly description: "`GET .../{
|
|
1280
|
+
readonly listGroups: {
|
|
1281
|
+
readonly description: "`GET .../{parentId}/group/list` — **группы родительского элемента, доступные для включения дочерних элементов** (torrow-apps: `getGroups(parentId)`). В apps при пустом `group/list` UI часто даёт `[parent]`. **Не** члены группы. Члены: `search.*(…, { groupIds })`. У **loyaltycards** пути нет → SDK бросает (`withGroupListEndpoint: false`).";
|
|
1137
1282
|
};
|
|
1138
1283
|
readonly updateGroups: {
|
|
1139
1284
|
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1140
1285
|
};
|
|
1141
1286
|
readonly includeToGroups: {
|
|
1142
|
-
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1287
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**. После include члены группы проверяй через `search.*(…, { groupIds })`, не через `listGroups`.";
|
|
1143
1288
|
};
|
|
1144
1289
|
readonly excludeFromGroups: {
|
|
1145
1290
|
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
@@ -1148,31 +1293,31 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
|
1148
1293
|
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1149
1294
|
};
|
|
1150
1295
|
readonly excludeFromParent: {
|
|
1151
|
-
readonly description: "`PUT .../{parentId}/exclude/items` —
|
|
1296
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1152
1297
|
};
|
|
1153
1298
|
readonly includeForUser: {
|
|
1154
1299
|
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1155
1300
|
};
|
|
1156
1301
|
readonly excludeFromUser: {
|
|
1157
|
-
readonly description: "`PUT .../{parentId}/exclude/fromuser` —
|
|
1302
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1158
1303
|
};
|
|
1159
1304
|
readonly rejectOffer: {
|
|
1160
|
-
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1305
|
+
readonly description: "`PUT .../participation/rejectoffer` — invitee отклоняет **`Offered`** → **`Rejected`**; body: **`profileId`**; query **`userMessage`**.";
|
|
1161
1306
|
};
|
|
1162
1307
|
readonly reject: {
|
|
1163
1308
|
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1164
1309
|
};
|
|
1165
1310
|
readonly share: {
|
|
1166
|
-
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1311
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**. Создаёт **`Offered`**; invitee — announcement **`ShareItem`**. Принять = **`saveToMindMap`** (нет `acceptOffer`). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1167
1312
|
};
|
|
1168
1313
|
readonly revokeOffer: {
|
|
1169
|
-
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1314
|
+
readonly description: "`PUT .../participation/revokeoffer` — владелец отзывает **`Offered`** → **`Revoked`**; body: `string[]` (**profileIds**).";
|
|
1170
1315
|
};
|
|
1171
1316
|
readonly grantAccess: {
|
|
1172
|
-
readonly description: "`PUT .../participation/grantaccess` — body: `string[]
|
|
1317
|
+
readonly description: "`PUT .../participation/grantaccess` — владелец принимает **`Requested`** → **`Accepted`**; body: `string[]` (**profileIds**).";
|
|
1173
1318
|
};
|
|
1174
1319
|
readonly declineAccess: {
|
|
1175
|
-
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1320
|
+
readonly description: "`PUT .../participation/declineaccess` — владелец отклоняет **`Requested`** → **`Declined`**; body: `string[]`; query **`userMessage`**.";
|
|
1176
1321
|
};
|
|
1177
1322
|
readonly updatePersonalListOrder: {
|
|
1178
1323
|
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
@@ -1187,16 +1332,16 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
|
|
|
1187
1332
|
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1188
1333
|
};
|
|
1189
1334
|
readonly sendLink: {
|
|
1190
|
-
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1335
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**. In-app ссылка (**`SendLinkOfItem`**); **не** создаёт `Offered`.";
|
|
1191
1336
|
};
|
|
1192
1337
|
readonly getShortUrl: {
|
|
1193
|
-
readonly description: "`POST .../{torrowId}/shorturl` → `string
|
|
1338
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string` (короткая URL элемента).";
|
|
1194
1339
|
};
|
|
1195
1340
|
readonly updateUniqueName: {
|
|
1196
1341
|
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
1197
1342
|
};
|
|
1198
1343
|
readonly saveToMindMap: {
|
|
1199
|
-
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1344
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**. Accept invite (`Offered`→`Accepted`), open/link save, или save с **`securityToken`** (Reader/Owner link). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1200
1345
|
};
|
|
1201
1346
|
readonly updateSolutionData: {
|
|
1202
1347
|
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1217,6 +1362,7 @@ declare const loyaltyCardsSdkMethodFieldDocs: {
|
|
|
1217
1362
|
readonly listTransactions: string;
|
|
1218
1363
|
readonly getSubscriptionBalance: string;
|
|
1219
1364
|
readonly getSubscriptionTransactions: string;
|
|
1365
|
+
readonly getTimetable: string;
|
|
1220
1366
|
readonly getTimetableStatistics: string;
|
|
1221
1367
|
readonly updateNotificationWayList: string;
|
|
1222
1368
|
readonly getImagePutUrl: string;
|
|
@@ -1235,7 +1381,7 @@ declare const loyaltyCardsSdkMethodFieldDocs: {
|
|
|
1235
1381
|
readonly setGroup: string;
|
|
1236
1382
|
readonly unsetGroup: string;
|
|
1237
1383
|
readonly updateTags: string;
|
|
1238
|
-
readonly
|
|
1384
|
+
readonly listGroups: string;
|
|
1239
1385
|
readonly updateGroups: string;
|
|
1240
1386
|
readonly includeToGroups: string;
|
|
1241
1387
|
readonly excludeFromGroups: string;
|
|
@@ -1286,28 +1432,28 @@ declare const userSdkMethodFieldDocEntries: {
|
|
|
1286
1432
|
readonly description: "`POST /api/v1/user/accounts/add/complete` — завершение добавления аккаунта по коду.";
|
|
1287
1433
|
};
|
|
1288
1434
|
readonly deleteAccount: {
|
|
1289
|
-
readonly description: "`DELETE /api/v1/user/accounts/delete` — удаление
|
|
1435
|
+
readonly description: "`DELETE /api/v1/user/accounts/delete` — удаление аккаунта; SDK возвращает **`deletedCount`** (`number`).";
|
|
1290
1436
|
};
|
|
1291
1437
|
readonly listDevices: {
|
|
1292
1438
|
readonly description: "`GET /api/v1/user/devices` — список устройств (`DeviceInfo[]`).";
|
|
1293
1439
|
};
|
|
1294
1440
|
readonly deleteDevice: {
|
|
1295
|
-
readonly description: "`DELETE /api/v1/user/devices/{deviceId}` — удалить
|
|
1441
|
+
readonly description: "`DELETE /api/v1/user/devices/{deviceId}` — удалить устройство; SDK: **`deleteCount`** (`number`).";
|
|
1296
1442
|
};
|
|
1297
1443
|
readonly getDeviceSettings: {
|
|
1298
|
-
readonly description: "`GET /api/v1/user/devices/{deviceId}/settings` — читать настройки
|
|
1444
|
+
readonly description: "`GET /api/v1/user/devices/{deviceId}/settings` — читать настройки (SDK: wire string → JSON, битое → `null`).";
|
|
1299
1445
|
};
|
|
1300
1446
|
readonly updateDeviceSettings: {
|
|
1301
|
-
readonly description: "`PUT /api/v1/user/devices/{deviceId}/settings` — сохранить
|
|
1447
|
+
readonly description: "`PUT /api/v1/user/devices/{deviceId}/settings` — сохранить настройки (SDK: JSON → wire string в query).";
|
|
1302
1448
|
};
|
|
1303
1449
|
readonly getDefaultProfile: {
|
|
1304
1450
|
readonly description: "`GET /api/v1/user/defaultprofile` — дефолтный профиль пользователя.";
|
|
1305
1451
|
};
|
|
1306
1452
|
readonly setDefaultProfileByContactId: {
|
|
1307
|
-
readonly description: "`PUT /api/v1/user/defaultprofile` — выбрать дефолтный профиль по contactId
|
|
1453
|
+
readonly description: "`PUT /api/v1/user/defaultprofile` — выбрать дефолтный профиль по contactId; SDK: **`ContactItem`**.";
|
|
1308
1454
|
};
|
|
1309
1455
|
readonly createDefaultProfile: {
|
|
1310
|
-
readonly description: "`POST /api/v1/user/defaultprofile` — создать и назначить дефолтный
|
|
1456
|
+
readonly description: "`POST /api/v1/user/defaultprofile` — создать и назначить дефолтный профиль; тело: **`UserProfileItemForAdd`**; ответ: **`ContactItem`**. Перед POST фасад добивает `discriminator` / `publicityType` / non-empty `name` и contact write normalizations including `visitCard` — как у `profiles.add`.";
|
|
1311
1457
|
};
|
|
1312
1458
|
readonly listDeliveryWays: {
|
|
1313
1459
|
readonly description: "`GET /api/v1/user/deliveryways` — пользовательские способы доставки.";
|
|
@@ -1340,7 +1486,7 @@ declare const userSdkMethodFieldDocEntries: {
|
|
|
1340
1486
|
readonly description: "`DELETE /api/v1/user/delete/complete` — завершить удаление по коду.";
|
|
1341
1487
|
};
|
|
1342
1488
|
readonly count: {
|
|
1343
|
-
readonly description: "`GET /api/v1/user/count` — число
|
|
1489
|
+
readonly description: "`GET /api/v1/user/count` — число пользователей. Публичный endpoint: доступен без Bearer (и с сессией).";
|
|
1344
1490
|
};
|
|
1345
1491
|
};
|
|
1346
1492
|
declare const userSdkMethodFieldDocs: {
|
|
@@ -1369,6 +1515,25 @@ declare const userSdkMethodFieldDocs: {
|
|
|
1369
1515
|
readonly count: string;
|
|
1370
1516
|
};
|
|
1371
1517
|
|
|
1518
|
+
/** Общее описание item-delete для MCP-записей методов `delete`. */
|
|
1519
|
+
declare const itemDeleteMethodDescription = "\u041E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u044B\u0435 query **`cascade`**, **`withPinnedItems`** (\u0441\u043C. **`ItemDeleteQuery`**); SDK \u0432\u043E\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 \u0447\u0438\u0441\u043B\u043E **`deleteCount`**.";
|
|
1520
|
+
declare const itemDeleteQueryFieldDocEntries: {
|
|
1521
|
+
readonly cascade: {
|
|
1522
|
+
readonly description: "Каскадное удаление вложенных дочерних элементов в иерархии (mind map / include). `false` — удалить только сам элемент, без дочерних; `true` — вместе с вложенными (в приложении: «удалить с вложенными элементами»).";
|
|
1523
|
+
readonly valueSchema: "boolean (required)";
|
|
1524
|
+
readonly examples: readonly ["false", "true"];
|
|
1525
|
+
};
|
|
1526
|
+
readonly withPinnedItems: {
|
|
1527
|
+
readonly description: "Удалять закреплённые (pinned) дочерние представления/элементы вместе с родителем. `false` — не трогать закреплённые вложения; `true` — удалить и их.";
|
|
1528
|
+
readonly valueSchema: "boolean (required)";
|
|
1529
|
+
readonly examples: readonly ["false", "true"];
|
|
1530
|
+
};
|
|
1531
|
+
};
|
|
1532
|
+
declare const itemDeleteQueryFieldDocs: {
|
|
1533
|
+
readonly cascade: string;
|
|
1534
|
+
readonly withPinnedItems: string;
|
|
1535
|
+
};
|
|
1536
|
+
|
|
1372
1537
|
/** Методы Core, общие для loyalty-доменов (без photo-endpoints). */
|
|
1373
1538
|
declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
|
|
1374
1539
|
readonly updatePublicity: {
|
|
@@ -1387,19 +1552,19 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
|
|
|
1387
1552
|
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1388
1553
|
};
|
|
1389
1554
|
readonly listParticipants: {
|
|
1390
|
-
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty***
|
|
1555
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** (`Offered`/`Requested`/`Accepted`/…) / **`participantTypeList`**, пагинация; у **loyalty*** query **`lmFrom`/`lmTo`**, у **contact/case** — **`lmfrom`/`lmto`**. Флоу статусов: **`docs/agents/participation-flow.md`**.";
|
|
1391
1556
|
};
|
|
1392
1557
|
readonly generateSecurityToken: {
|
|
1393
|
-
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1558
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**. Внешняя ссылка: `participantType` **Reader** (обычная) или **Owner** (ссылка управления); получатель сохраняет через **`saveToMindMap({ securityToken })`**. Apps: `ShareWithRightsService`.";
|
|
1394
1559
|
};
|
|
1395
1560
|
readonly updateParticipationType: {
|
|
1396
1561
|
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1397
1562
|
};
|
|
1398
1563
|
readonly requestAccess: {
|
|
1399
|
-
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId
|
|
1564
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`**; query **`userMessage`**. State → **`Requested`**; владельцу — announcement **`RequestAccessToItem`**. Не для владельца своего item. Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1400
1565
|
};
|
|
1401
1566
|
readonly revokeAccessRequest: {
|
|
1402
|
-
readonly description: "`PUT .../participation/revokerequest
|
|
1567
|
+
readonly description: "`PUT .../participation/revokerequest` — requester отменяет свой **`Requested`** → **`Revoked`**.";
|
|
1403
1568
|
};
|
|
1404
1569
|
readonly setGroup: {
|
|
1405
1570
|
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
@@ -1410,14 +1575,14 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
|
|
|
1410
1575
|
readonly updateTags: {
|
|
1411
1576
|
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1412
1577
|
};
|
|
1413
|
-
readonly
|
|
1414
|
-
readonly description: "`GET .../{
|
|
1578
|
+
readonly listGroups: {
|
|
1579
|
+
readonly description: "`GET .../{parentId}/group/list` — **группы родительского элемента, доступные для включения дочерних элементов** (torrow-apps: `getGroups(parentId)`). В apps при пустом `group/list` UI часто даёт `[parent]`. **Не** члены группы. Члены: `search.*(…, { groupIds })`. У **loyaltycards** пути нет → SDK бросает (`withGroupListEndpoint: false`).";
|
|
1415
1580
|
};
|
|
1416
1581
|
readonly updateGroups: {
|
|
1417
1582
|
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1418
1583
|
};
|
|
1419
1584
|
readonly includeToGroups: {
|
|
1420
|
-
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1585
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**. После include члены группы проверяй через `search.*(…, { groupIds })`, не через `listGroups`.";
|
|
1421
1586
|
};
|
|
1422
1587
|
readonly excludeFromGroups: {
|
|
1423
1588
|
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
@@ -1426,31 +1591,31 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
|
|
|
1426
1591
|
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1427
1592
|
};
|
|
1428
1593
|
readonly excludeFromParent: {
|
|
1429
|
-
readonly description: "`PUT .../{parentId}/exclude/items` —
|
|
1594
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1430
1595
|
};
|
|
1431
1596
|
readonly includeForUser: {
|
|
1432
1597
|
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1433
1598
|
};
|
|
1434
1599
|
readonly excludeFromUser: {
|
|
1435
|
-
readonly description: "`PUT .../{parentId}/exclude/fromuser` —
|
|
1600
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1436
1601
|
};
|
|
1437
1602
|
readonly rejectOffer: {
|
|
1438
|
-
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1603
|
+
readonly description: "`PUT .../participation/rejectoffer` — invitee отклоняет **`Offered`** → **`Rejected`**; body: **`profileId`**; query **`userMessage`**.";
|
|
1439
1604
|
};
|
|
1440
1605
|
readonly reject: {
|
|
1441
1606
|
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1442
1607
|
};
|
|
1443
1608
|
readonly share: {
|
|
1444
|
-
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1609
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**. Создаёт **`Offered`**; invitee — announcement **`ShareItem`**. Принять = **`saveToMindMap`** (нет `acceptOffer`). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1445
1610
|
};
|
|
1446
1611
|
readonly revokeOffer: {
|
|
1447
|
-
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1612
|
+
readonly description: "`PUT .../participation/revokeoffer` — владелец отзывает **`Offered`** → **`Revoked`**; body: `string[]` (**profileIds**).";
|
|
1448
1613
|
};
|
|
1449
1614
|
readonly grantAccess: {
|
|
1450
|
-
readonly description: "`PUT .../participation/grantaccess` — body: `string[]
|
|
1615
|
+
readonly description: "`PUT .../participation/grantaccess` — владелец принимает **`Requested`** → **`Accepted`**; body: `string[]` (**profileIds**).";
|
|
1451
1616
|
};
|
|
1452
1617
|
readonly declineAccess: {
|
|
1453
|
-
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1618
|
+
readonly description: "`PUT .../participation/declineaccess` — владелец отклоняет **`Requested`** → **`Declined`**; body: `string[]`; query **`userMessage`**.";
|
|
1454
1619
|
};
|
|
1455
1620
|
readonly updatePersonalListOrder: {
|
|
1456
1621
|
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
@@ -1465,10 +1630,10 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
|
|
|
1465
1630
|
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1466
1631
|
};
|
|
1467
1632
|
readonly sendLink: {
|
|
1468
|
-
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1633
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**. In-app ссылка (**`SendLinkOfItem`**); **не** создаёт `Offered`.";
|
|
1469
1634
|
};
|
|
1470
1635
|
readonly getShortUrl: {
|
|
1471
|
-
readonly description: "`POST .../{torrowId}/shorturl` → `string
|
|
1636
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string` (короткая URL элемента).";
|
|
1472
1637
|
};
|
|
1473
1638
|
readonly updateUniqueName: {
|
|
1474
1639
|
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
@@ -1480,10 +1645,10 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
|
|
|
1480
1645
|
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1481
1646
|
};
|
|
1482
1647
|
readonly getImagePutUrl: {
|
|
1483
|
-
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload;
|
|
1648
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; параметры **`fileId`**, **`fileName?`**, **`fileSize?`** (query). SDK: **`{ url, urlExpiration }`**.";
|
|
1484
1649
|
};
|
|
1485
1650
|
readonly saveToMindMap: {
|
|
1486
|
-
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1651
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**. Accept invite (`Offered`→`Accepted`), open/link save, или save с **`securityToken`** (Reader/Owner link). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1487
1652
|
};
|
|
1488
1653
|
readonly updateSolutionData: {
|
|
1489
1654
|
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1498,7 +1663,7 @@ declare const torrowItemFacadePhotoEndpointSdkMethodFieldDocEntries: {
|
|
|
1498
1663
|
readonly description: "`GET .../{torrowId}/photo/info` — **`FileInfo`**; только при **`withPhotoEndpoints`** (сейчас **contacts**), иначе SDK бросает ошибку.";
|
|
1499
1664
|
};
|
|
1500
1665
|
readonly getPhotoPutUrl: {
|
|
1501
|
-
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; только при **`withPhotoEndpoints`** (сейчас **contacts**).";
|
|
1666
|
+
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; **`fileId`**, **`fileName?`**, **`fileSize?`**; только при **`withPhotoEndpoints`** (сейчас **contacts**). SDK: **`{ url, urlExpiration }`**.";
|
|
1502
1667
|
};
|
|
1503
1668
|
};
|
|
1504
1669
|
/**
|
|
@@ -1518,14 +1683,14 @@ declare const torrowItemFacadeExtensionSdkMethodFieldDocEntries: {
|
|
|
1518
1683
|
readonly listTags: {
|
|
1519
1684
|
readonly description: "`GET .../{torrowId}/tags` — фильтры **`ItemTagsListQuery`** → `string[]`.";
|
|
1520
1685
|
};
|
|
1521
|
-
readonly
|
|
1522
|
-
readonly description: "`GET .../{
|
|
1686
|
+
readonly listItemGroups: {
|
|
1687
|
+
readonly description: "`GET .../{itemId}/groups?parentId=` — **`GroupStatus[]`**: в каких группах родителя состоит child (torrow-apps: `getItemGroups(itemId, parentId)`). Каталог групп родителя для include — `listGroups(parentId)` (`…/group/list`). Члены группы — `search.*(groupIds)`.";
|
|
1523
1688
|
};
|
|
1524
1689
|
readonly updateAccounts: {
|
|
1525
1690
|
readonly description: "`PUT .../{torrowId}/updateaccounts` — **`UpdateItemAccountsReq[]`** → **`IncludeExcludeResp`**.";
|
|
1526
1691
|
};
|
|
1527
1692
|
readonly shareItemLink: {
|
|
1528
|
-
readonly description: "`POST .../{torrowId}/participation/shareitemlink` — **`
|
|
1693
|
+
readonly description: "**WIP / do not use in product.** `POST .../{torrowId}/participation/shareitemlink` — **`GetShareItemSessionReq`** → URL `string`. Invite-session (срок/лимит); activate: **`client.item.activateShareItemSession`**. Gateway stub (`Task.FromResult(\"\")`, HTTP 200) — пустой URL не баг SDK; apps InvitationLink (ContactItem) копирует `\"\"`. Activate stub, unused in apps UI. Не путать с **`sendLink`** / **`share`** / **`generateSecurityToken`** (продуктовая альтернатива + client URI). Не клеить URL из shortUrl/item path.";
|
|
1529
1694
|
};
|
|
1530
1695
|
readonly updateOfflinable: {
|
|
1531
1696
|
readonly description: "`PUT .../{itemId}/offlinable` — body: boolean.";
|
|
@@ -1537,10 +1702,10 @@ declare const torrowItemFacadeExtensionSdkMethodFieldDocEntries: {
|
|
|
1537
1702
|
readonly description: "`PUT .../{itemId}/notificationwaylist` — **`NotificationWay[]`** (у **loyaltycards** тот же путь, но класс не от **Base** — см. **`LoyaltyCardsSdkMethods`**).";
|
|
1538
1703
|
};
|
|
1539
1704
|
readonly block: {
|
|
1540
|
-
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**.";
|
|
1705
|
+
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
|
|
1541
1706
|
};
|
|
1542
1707
|
readonly unblock: {
|
|
1543
|
-
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1708
|
+
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
|
|
1544
1709
|
};
|
|
1545
1710
|
};
|
|
1546
1711
|
/** Полный общий слой **`TorrowItemFacade`** без photo-endpoints (`GET .../participants` — **`lmfrom`/`lmto`**). */
|
|
@@ -1557,14 +1722,14 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
|
1557
1722
|
readonly listTags: {
|
|
1558
1723
|
readonly description: "`GET .../{torrowId}/tags` — фильтры **`ItemTagsListQuery`** → `string[]`.";
|
|
1559
1724
|
};
|
|
1560
|
-
readonly
|
|
1561
|
-
readonly description: "`GET .../{
|
|
1725
|
+
readonly listItemGroups: {
|
|
1726
|
+
readonly description: "`GET .../{itemId}/groups?parentId=` — **`GroupStatus[]`**: в каких группах родителя состоит child (torrow-apps: `getItemGroups(itemId, parentId)`). Каталог групп родителя для include — `listGroups(parentId)` (`…/group/list`). Члены группы — `search.*(groupIds)`.";
|
|
1562
1727
|
};
|
|
1563
1728
|
readonly updateAccounts: {
|
|
1564
1729
|
readonly description: "`PUT .../{torrowId}/updateaccounts` — **`UpdateItemAccountsReq[]`** → **`IncludeExcludeResp`**.";
|
|
1565
1730
|
};
|
|
1566
1731
|
readonly shareItemLink: {
|
|
1567
|
-
readonly description: "`POST .../{torrowId}/participation/shareitemlink` — **`
|
|
1732
|
+
readonly description: "**WIP / do not use in product.** `POST .../{torrowId}/participation/shareitemlink` — **`GetShareItemSessionReq`** → URL `string`. Invite-session (срок/лимит); activate: **`client.item.activateShareItemSession`**. Gateway stub (`Task.FromResult(\"\")`, HTTP 200) — пустой URL не баг SDK; apps InvitationLink (ContactItem) копирует `\"\"`. Activate stub, unused in apps UI. Не путать с **`sendLink`** / **`share`** / **`generateSecurityToken`** (продуктовая альтернатива + client URI). Не клеить URL из shortUrl/item path.";
|
|
1568
1733
|
};
|
|
1569
1734
|
readonly updateOfflinable: {
|
|
1570
1735
|
readonly description: "`PUT .../{itemId}/offlinable` — body: boolean.";
|
|
@@ -1576,10 +1741,10 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
|
1576
1741
|
readonly description: "`PUT .../{itemId}/notificationwaylist` — **`NotificationWay[]`** (у **loyaltycards** тот же путь, но класс не от **Base** — см. **`LoyaltyCardsSdkMethods`**).";
|
|
1577
1742
|
};
|
|
1578
1743
|
readonly block: {
|
|
1579
|
-
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**.";
|
|
1744
|
+
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
|
|
1580
1745
|
};
|
|
1581
1746
|
readonly unblock: {
|
|
1582
|
-
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1747
|
+
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
|
|
1583
1748
|
};
|
|
1584
1749
|
readonly updatePublicity: {
|
|
1585
1750
|
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1597,19 +1762,19 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
|
1597
1762
|
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1598
1763
|
};
|
|
1599
1764
|
readonly listParticipants: {
|
|
1600
|
-
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty***
|
|
1765
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** (`Offered`/`Requested`/`Accepted`/…) / **`participantTypeList`**, пагинация; у **loyalty*** query **`lmFrom`/`lmTo`**, у **contact/case** — **`lmfrom`/`lmto`**. Флоу статусов: **`docs/agents/participation-flow.md`**.";
|
|
1601
1766
|
};
|
|
1602
1767
|
readonly generateSecurityToken: {
|
|
1603
|
-
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1768
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**. Внешняя ссылка: `participantType` **Reader** (обычная) или **Owner** (ссылка управления); получатель сохраняет через **`saveToMindMap({ securityToken })`**. Apps: `ShareWithRightsService`.";
|
|
1604
1769
|
};
|
|
1605
1770
|
readonly updateParticipationType: {
|
|
1606
1771
|
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1607
1772
|
};
|
|
1608
1773
|
readonly requestAccess: {
|
|
1609
|
-
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId
|
|
1774
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`**; query **`userMessage`**. State → **`Requested`**; владельцу — announcement **`RequestAccessToItem`**. Не для владельца своего item. Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1610
1775
|
};
|
|
1611
1776
|
readonly revokeAccessRequest: {
|
|
1612
|
-
readonly description: "`PUT .../participation/revokerequest
|
|
1777
|
+
readonly description: "`PUT .../participation/revokerequest` — requester отменяет свой **`Requested`** → **`Revoked`**.";
|
|
1613
1778
|
};
|
|
1614
1779
|
readonly setGroup: {
|
|
1615
1780
|
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
@@ -1620,14 +1785,14 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
|
1620
1785
|
readonly updateTags: {
|
|
1621
1786
|
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1622
1787
|
};
|
|
1623
|
-
readonly
|
|
1624
|
-
readonly description: "`GET .../{
|
|
1788
|
+
readonly listGroups: {
|
|
1789
|
+
readonly description: "`GET .../{parentId}/group/list` — **группы родительского элемента, доступные для включения дочерних элементов** (torrow-apps: `getGroups(parentId)`). В apps при пустом `group/list` UI часто даёт `[parent]`. **Не** члены группы. Члены: `search.*(…, { groupIds })`. У **loyaltycards** пути нет → SDK бросает (`withGroupListEndpoint: false`).";
|
|
1625
1790
|
};
|
|
1626
1791
|
readonly updateGroups: {
|
|
1627
1792
|
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1628
1793
|
};
|
|
1629
1794
|
readonly includeToGroups: {
|
|
1630
|
-
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1795
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**. После include члены группы проверяй через `search.*(…, { groupIds })`, не через `listGroups`.";
|
|
1631
1796
|
};
|
|
1632
1797
|
readonly excludeFromGroups: {
|
|
1633
1798
|
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
@@ -1636,31 +1801,31 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
|
1636
1801
|
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1637
1802
|
};
|
|
1638
1803
|
readonly excludeFromParent: {
|
|
1639
|
-
readonly description: "`PUT .../{parentId}/exclude/items` —
|
|
1804
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1640
1805
|
};
|
|
1641
1806
|
readonly includeForUser: {
|
|
1642
1807
|
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1643
1808
|
};
|
|
1644
1809
|
readonly excludeFromUser: {
|
|
1645
|
-
readonly description: "`PUT .../{parentId}/exclude/fromuser` —
|
|
1810
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1646
1811
|
};
|
|
1647
1812
|
readonly rejectOffer: {
|
|
1648
|
-
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1813
|
+
readonly description: "`PUT .../participation/rejectoffer` — invitee отклоняет **`Offered`** → **`Rejected`**; body: **`profileId`**; query **`userMessage`**.";
|
|
1649
1814
|
};
|
|
1650
1815
|
readonly reject: {
|
|
1651
1816
|
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1652
1817
|
};
|
|
1653
1818
|
readonly share: {
|
|
1654
|
-
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1819
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**. Создаёт **`Offered`**; invitee — announcement **`ShareItem`**. Принять = **`saveToMindMap`** (нет `acceptOffer`). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1655
1820
|
};
|
|
1656
1821
|
readonly revokeOffer: {
|
|
1657
|
-
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1822
|
+
readonly description: "`PUT .../participation/revokeoffer` — владелец отзывает **`Offered`** → **`Revoked`**; body: `string[]` (**profileIds**).";
|
|
1658
1823
|
};
|
|
1659
1824
|
readonly grantAccess: {
|
|
1660
|
-
readonly description: "`PUT .../participation/grantaccess` — body: `string[]
|
|
1825
|
+
readonly description: "`PUT .../participation/grantaccess` — владелец принимает **`Requested`** → **`Accepted`**; body: `string[]` (**profileIds**).";
|
|
1661
1826
|
};
|
|
1662
1827
|
readonly declineAccess: {
|
|
1663
|
-
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1828
|
+
readonly description: "`PUT .../participation/declineaccess` — владелец отклоняет **`Requested`** → **`Declined`**; body: `string[]`; query **`userMessage`**.";
|
|
1664
1829
|
};
|
|
1665
1830
|
readonly updatePersonalListOrder: {
|
|
1666
1831
|
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
@@ -1675,10 +1840,10 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
|
1675
1840
|
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1676
1841
|
};
|
|
1677
1842
|
readonly sendLink: {
|
|
1678
|
-
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
1843
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**. In-app ссылка (**`SendLinkOfItem`**); **не** создаёт `Offered`.";
|
|
1679
1844
|
};
|
|
1680
1845
|
readonly getShortUrl: {
|
|
1681
|
-
readonly description: "`POST .../{torrowId}/shorturl` → `string
|
|
1846
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string` (короткая URL элемента).";
|
|
1682
1847
|
};
|
|
1683
1848
|
readonly updateUniqueName: {
|
|
1684
1849
|
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
@@ -1690,10 +1855,10 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
|
|
|
1690
1855
|
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1691
1856
|
};
|
|
1692
1857
|
readonly getImagePutUrl: {
|
|
1693
|
-
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload;
|
|
1858
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; параметры **`fileId`**, **`fileName?`**, **`fileSize?`** (query). SDK: **`{ url, urlExpiration }`**.";
|
|
1694
1859
|
};
|
|
1695
1860
|
readonly saveToMindMap: {
|
|
1696
|
-
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
1861
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**. Accept invite (`Offered`→`Accepted`), open/link save, или save с **`securityToken`** (Reader/Owner link). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1697
1862
|
};
|
|
1698
1863
|
readonly updateSolutionData: {
|
|
1699
1864
|
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1708,7 +1873,7 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1708
1873
|
readonly description: "`GET .../{torrowId}/photo/info` — **`FileInfo`**; только при **`withPhotoEndpoints`** (сейчас **contacts**), иначе SDK бросает ошибку.";
|
|
1709
1874
|
};
|
|
1710
1875
|
readonly getPhotoPutUrl: {
|
|
1711
|
-
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; только при **`withPhotoEndpoints`** (сейчас **contacts**).";
|
|
1876
|
+
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; **`fileId`**, **`fileName?`**, **`fileSize?`**; только при **`withPhotoEndpoints`** (сейчас **contacts**). SDK: **`{ url, urlExpiration }`**.";
|
|
1712
1877
|
};
|
|
1713
1878
|
readonly updateFeedbackOptions: {
|
|
1714
1879
|
readonly description: "`PUT .../{torrowId}/feedbacks/options` — **`FeedbackOptions`**.";
|
|
@@ -1722,14 +1887,14 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1722
1887
|
readonly listTags: {
|
|
1723
1888
|
readonly description: "`GET .../{torrowId}/tags` — фильтры **`ItemTagsListQuery`** → `string[]`.";
|
|
1724
1889
|
};
|
|
1725
|
-
readonly
|
|
1726
|
-
readonly description: "`GET .../{
|
|
1890
|
+
readonly listItemGroups: {
|
|
1891
|
+
readonly description: "`GET .../{itemId}/groups?parentId=` — **`GroupStatus[]`**: в каких группах родителя состоит child (torrow-apps: `getItemGroups(itemId, parentId)`). Каталог групп родителя для include — `listGroups(parentId)` (`…/group/list`). Члены группы — `search.*(groupIds)`.";
|
|
1727
1892
|
};
|
|
1728
1893
|
readonly updateAccounts: {
|
|
1729
1894
|
readonly description: "`PUT .../{torrowId}/updateaccounts` — **`UpdateItemAccountsReq[]`** → **`IncludeExcludeResp`**.";
|
|
1730
1895
|
};
|
|
1731
1896
|
readonly shareItemLink: {
|
|
1732
|
-
readonly description: "`POST .../{torrowId}/participation/shareitemlink` — **`
|
|
1897
|
+
readonly description: "**WIP / do not use in product.** `POST .../{torrowId}/participation/shareitemlink` — **`GetShareItemSessionReq`** → URL `string`. Invite-session (срок/лимит); activate: **`client.item.activateShareItemSession`**. Gateway stub (`Task.FromResult(\"\")`, HTTP 200) — пустой URL не баг SDK; apps InvitationLink (ContactItem) копирует `\"\"`. Activate stub, unused in apps UI. Не путать с **`sendLink`** / **`share`** / **`generateSecurityToken`** (продуктовая альтернатива + client URI). Не клеить URL из shortUrl/item path.";
|
|
1733
1898
|
};
|
|
1734
1899
|
readonly updateOfflinable: {
|
|
1735
1900
|
readonly description: "`PUT .../{itemId}/offlinable` — body: boolean.";
|
|
@@ -1741,10 +1906,10 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1741
1906
|
readonly description: "`PUT .../{itemId}/notificationwaylist` — **`NotificationWay[]`** (у **loyaltycards** тот же путь, но класс не от **Base** — см. **`LoyaltyCardsSdkMethods`**).";
|
|
1742
1907
|
};
|
|
1743
1908
|
readonly block: {
|
|
1744
|
-
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**.";
|
|
1909
|
+
readonly description: "`POST .../{itemId}/block` — query **`reasonId`**, **`reasonNote`**, **`language`**, … → **`TorrowItem`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
|
|
1745
1910
|
};
|
|
1746
1911
|
readonly unblock: {
|
|
1747
|
-
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1912
|
+
readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
|
|
1748
1913
|
};
|
|
1749
1914
|
readonly updatePublicity: {
|
|
1750
1915
|
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1762,19 +1927,19 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1762
1927
|
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1763
1928
|
};
|
|
1764
1929
|
readonly listParticipants: {
|
|
1765
|
-
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty***
|
|
1930
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** (`Offered`/`Requested`/`Accepted`/…) / **`participantTypeList`**, пагинация; у **loyalty*** query **`lmFrom`/`lmTo`**, у **contact/case** — **`lmfrom`/`lmto`**. Флоу статусов: **`docs/agents/participation-flow.md`**.";
|
|
1766
1931
|
};
|
|
1767
1932
|
readonly generateSecurityToken: {
|
|
1768
|
-
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
1933
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**. Внешняя ссылка: `participantType` **Reader** (обычная) или **Owner** (ссылка управления); получатель сохраняет через **`saveToMindMap({ securityToken })`**. Apps: `ShareWithRightsService`.";
|
|
1769
1934
|
};
|
|
1770
1935
|
readonly updateParticipationType: {
|
|
1771
1936
|
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1772
1937
|
};
|
|
1773
1938
|
readonly requestAccess: {
|
|
1774
|
-
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId
|
|
1939
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`**; query **`userMessage`**. State → **`Requested`**; владельцу — announcement **`RequestAccessToItem`**. Не для владельца своего item. Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1775
1940
|
};
|
|
1776
1941
|
readonly revokeAccessRequest: {
|
|
1777
|
-
readonly description: "`PUT .../participation/revokerequest
|
|
1942
|
+
readonly description: "`PUT .../participation/revokerequest` — requester отменяет свой **`Requested`** → **`Revoked`**.";
|
|
1778
1943
|
};
|
|
1779
1944
|
readonly setGroup: {
|
|
1780
1945
|
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
@@ -1785,14 +1950,14 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1785
1950
|
readonly updateTags: {
|
|
1786
1951
|
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1787
1952
|
};
|
|
1788
|
-
readonly
|
|
1789
|
-
readonly description: "`GET .../{
|
|
1953
|
+
readonly listGroups: {
|
|
1954
|
+
readonly description: "`GET .../{parentId}/group/list` — **группы родительского элемента, доступные для включения дочерних элементов** (torrow-apps: `getGroups(parentId)`). В apps при пустом `group/list` UI часто даёт `[parent]`. **Не** члены группы. Члены: `search.*(…, { groupIds })`. У **loyaltycards** пути нет → SDK бросает (`withGroupListEndpoint: false`).";
|
|
1790
1955
|
};
|
|
1791
1956
|
readonly updateGroups: {
|
|
1792
1957
|
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1793
1958
|
};
|
|
1794
1959
|
readonly includeToGroups: {
|
|
1795
|
-
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
1960
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**. После include члены группы проверяй через `search.*(…, { groupIds })`, не через `listGroups`.";
|
|
1796
1961
|
};
|
|
1797
1962
|
readonly excludeFromGroups: {
|
|
1798
1963
|
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
@@ -1801,31 +1966,31 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1801
1966
|
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1802
1967
|
};
|
|
1803
1968
|
readonly excludeFromParent: {
|
|
1804
|
-
readonly description: "`PUT .../{parentId}/exclude/items` —
|
|
1969
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1805
1970
|
};
|
|
1806
1971
|
readonly includeForUser: {
|
|
1807
1972
|
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1808
1973
|
};
|
|
1809
1974
|
readonly excludeFromUser: {
|
|
1810
|
-
readonly description: "`PUT .../{parentId}/exclude/fromuser` —
|
|
1975
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1811
1976
|
};
|
|
1812
1977
|
readonly rejectOffer: {
|
|
1813
|
-
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
1978
|
+
readonly description: "`PUT .../participation/rejectoffer` — invitee отклоняет **`Offered`** → **`Rejected`**; body: **`profileId`**; query **`userMessage`**.";
|
|
1814
1979
|
};
|
|
1815
1980
|
readonly reject: {
|
|
1816
1981
|
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1817
1982
|
};
|
|
1818
1983
|
readonly share: {
|
|
1819
|
-
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
1984
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**. Создаёт **`Offered`**; invitee — announcement **`ShareItem`**. Принять = **`saveToMindMap`** (нет `acceptOffer`). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1820
1985
|
};
|
|
1821
1986
|
readonly revokeOffer: {
|
|
1822
|
-
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
1987
|
+
readonly description: "`PUT .../participation/revokeoffer` — владелец отзывает **`Offered`** → **`Revoked`**; body: `string[]` (**profileIds**).";
|
|
1823
1988
|
};
|
|
1824
1989
|
readonly grantAccess: {
|
|
1825
|
-
readonly description: "`PUT .../participation/grantaccess` — body: `string[]
|
|
1990
|
+
readonly description: "`PUT .../participation/grantaccess` — владелец принимает **`Requested`** → **`Accepted`**; body: `string[]` (**profileIds**).";
|
|
1826
1991
|
};
|
|
1827
1992
|
readonly declineAccess: {
|
|
1828
|
-
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
1993
|
+
readonly description: "`PUT .../participation/declineaccess` — владелец отклоняет **`Requested`** → **`Declined`**; body: `string[]`; query **`userMessage`**.";
|
|
1829
1994
|
};
|
|
1830
1995
|
readonly updatePersonalListOrder: {
|
|
1831
1996
|
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
@@ -1840,10 +2005,10 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1840
2005
|
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1841
2006
|
};
|
|
1842
2007
|
readonly sendLink: {
|
|
1843
|
-
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
2008
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**. In-app ссылка (**`SendLinkOfItem`**); **не** создаёт `Offered`.";
|
|
1844
2009
|
};
|
|
1845
2010
|
readonly getShortUrl: {
|
|
1846
|
-
readonly description: "`POST .../{torrowId}/shorturl` → `string
|
|
2011
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string` (короткая URL элемента).";
|
|
1847
2012
|
};
|
|
1848
2013
|
readonly updateUniqueName: {
|
|
1849
2014
|
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
@@ -1855,10 +2020,10 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
|
|
|
1855
2020
|
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1856
2021
|
};
|
|
1857
2022
|
readonly getImagePutUrl: {
|
|
1858
|
-
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload;
|
|
2023
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; параметры **`fileId`**, **`fileName?`**, **`fileSize?`** (query). SDK: **`{ url, urlExpiration }`**.";
|
|
1859
2024
|
};
|
|
1860
2025
|
readonly saveToMindMap: {
|
|
1861
|
-
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
2026
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**. Accept invite (`Offered`→`Accepted`), open/link save, или save с **`securityToken`** (Reader/Owner link). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1862
2027
|
};
|
|
1863
2028
|
readonly updateSolutionData: {
|
|
1864
2029
|
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1873,7 +2038,7 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
|
|
|
1873
2038
|
readonly description: "`GET .../{torrowId}/photo/info` — **`FileInfo`**; только при **`withPhotoEndpoints`** (сейчас **contacts**), иначе SDK бросает ошибку.";
|
|
1874
2039
|
};
|
|
1875
2040
|
readonly getPhotoPutUrl: {
|
|
1876
|
-
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; только при **`withPhotoEndpoints`** (сейчас **contacts**).";
|
|
2041
|
+
readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; **`fileId`**, **`fileName?`**, **`fileSize?`**; только при **`withPhotoEndpoints`** (сейчас **contacts**). SDK: **`{ url, urlExpiration }`**.";
|
|
1877
2042
|
};
|
|
1878
2043
|
readonly updatePublicity: {
|
|
1879
2044
|
readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -1891,19 +2056,19 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
|
|
|
1891
2056
|
readonly description: "`PUT .../{torrowId}/integrations` — body: `string[]` (**integrationIds**).";
|
|
1892
2057
|
};
|
|
1893
2058
|
readonly listParticipants: {
|
|
1894
|
-
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** / **`participantTypeList`**, пагинация; у **loyalty***
|
|
2059
|
+
readonly description: "`GET .../{torrowId}/participants` — фильтры **`participantStateList`** (`Offered`/`Requested`/`Accepted`/…) / **`participantTypeList`**, пагинация; у **loyalty*** query **`lmFrom`/`lmTo`**, у **contact/case** — **`lmfrom`/`lmto`**. Флоу статусов: **`docs/agents/participation-flow.md`**.";
|
|
1895
2060
|
};
|
|
1896
2061
|
readonly generateSecurityToken: {
|
|
1897
|
-
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**.";
|
|
2062
|
+
readonly description: "`POST .../{torrowId}/generatesecuritytoken` — **`GenerateSecurityTokenReq`** → **`GenerateSecurityTokenResp`**. Внешняя ссылка: `participantType` **Reader** (обычная) или **Owner** (ссылка управления); получатель сохраняет через **`saveToMindMap({ securityToken })`**. Apps: `ShareWithRightsService`.";
|
|
1898
2063
|
};
|
|
1899
2064
|
readonly updateParticipationType: {
|
|
1900
2065
|
readonly description: "`PUT .../{torrowId}/participation/{participantProfileId}/type` — body: **`ParticipantType`** (в path id профиля участника).";
|
|
1901
2066
|
};
|
|
1902
2067
|
readonly requestAccess: {
|
|
1903
|
-
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId
|
|
2068
|
+
readonly description: "`PUT .../participation/requestaccess` — body: **`profileId`**; query **`userMessage`**. State → **`Requested`**; владельцу — announcement **`RequestAccessToItem`**. Не для владельца своего item. Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1904
2069
|
};
|
|
1905
2070
|
readonly revokeAccessRequest: {
|
|
1906
|
-
readonly description: "`PUT .../participation/revokerequest
|
|
2071
|
+
readonly description: "`PUT .../participation/revokerequest` — requester отменяет свой **`Requested`** → **`Revoked`**.";
|
|
1907
2072
|
};
|
|
1908
2073
|
readonly setGroup: {
|
|
1909
2074
|
readonly description: "`PUT .../group/set` — **`SetGroupItemReq`**.";
|
|
@@ -1914,14 +2079,14 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
|
|
|
1914
2079
|
readonly updateTags: {
|
|
1915
2080
|
readonly description: "`PUT .../{torrowId}/tags` — body: `string[]`; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1916
2081
|
};
|
|
1917
|
-
readonly
|
|
1918
|
-
readonly description: "`GET .../{
|
|
2082
|
+
readonly listGroups: {
|
|
2083
|
+
readonly description: "`GET .../{parentId}/group/list` — **группы родительского элемента, доступные для включения дочерних элементов** (torrow-apps: `getGroups(parentId)`). В apps при пустом `group/list` UI часто даёт `[parent]`. **Не** члены группы. Члены: `search.*(…, { groupIds })`. У **loyaltycards** пути нет → SDK бросает (`withGroupListEndpoint: false`).";
|
|
1919
2084
|
};
|
|
1920
2085
|
readonly updateGroups: {
|
|
1921
2086
|
readonly description: "`PUT .../{torrowId}/updategroups` — **`UpdateItemGroupsReq[]`**; query **`parentId`**, **`tags`**, **`alias`**, **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
1922
2087
|
};
|
|
1923
2088
|
readonly includeToGroups: {
|
|
1924
|
-
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**.";
|
|
2089
|
+
readonly description: "`PUT .../include/togroups` — **`IncludeToGroupsReq`**. После include члены группы проверяй через `search.*(…, { groupIds })`, не через `listGroups`.";
|
|
1925
2090
|
};
|
|
1926
2091
|
readonly excludeFromGroups: {
|
|
1927
2092
|
readonly description: "`PUT .../exclude/fromgroups` — **`ExcludeFromGroupsReq`**.";
|
|
@@ -1930,31 +2095,31 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
|
|
|
1930
2095
|
readonly description: "`PUT .../{parentId}/include/items` — **`IncludeToParentReq`**.";
|
|
1931
2096
|
};
|
|
1932
2097
|
readonly excludeFromParent: {
|
|
1933
|
-
readonly description: "`PUT .../{parentId}/exclude/items` —
|
|
2098
|
+
readonly description: "`PUT .../{parentId}/exclude/items` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1934
2099
|
};
|
|
1935
2100
|
readonly includeForUser: {
|
|
1936
2101
|
readonly description: "`PUT .../{parentId}/include/foruser` — **`IncludeForUserReq`**.";
|
|
1937
2102
|
};
|
|
1938
2103
|
readonly excludeFromUser: {
|
|
1939
|
-
readonly description: "`PUT .../{parentId}/exclude/fromuser` —
|
|
2104
|
+
readonly description: "`PUT .../{parentId}/exclude/fromuser` — `childIds` и опции `versionToCheck`/`isNeedAnnouncement`.";
|
|
1940
2105
|
};
|
|
1941
2106
|
readonly rejectOffer: {
|
|
1942
|
-
readonly description: "`PUT .../participation/rejectoffer` — body: **`profileId`**; query **`userMessage`**.";
|
|
2107
|
+
readonly description: "`PUT .../participation/rejectoffer` — invitee отклоняет **`Offered`** → **`Rejected`**; body: **`profileId`**; query **`userMessage`**.";
|
|
1943
2108
|
};
|
|
1944
2109
|
readonly reject: {
|
|
1945
2110
|
readonly description: "`PUT .../participation/reject` — body: **`profileId`**.";
|
|
1946
2111
|
};
|
|
1947
2112
|
readonly share: {
|
|
1948
|
-
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**.";
|
|
2113
|
+
readonly description: "`PUT .../participation/share` — **`ShareItemReq`** → **`ParticipationResp`**. Создаёт **`Offered`**; invitee — announcement **`ShareItem`**. Принять = **`saveToMindMap`** (нет `acceptOffer`). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1949
2114
|
};
|
|
1950
2115
|
readonly revokeOffer: {
|
|
1951
|
-
readonly description: "`PUT .../participation/revokeoffer` — body: `string[]` (**profileIds**).";
|
|
2116
|
+
readonly description: "`PUT .../participation/revokeoffer` — владелец отзывает **`Offered`** → **`Revoked`**; body: `string[]` (**profileIds**).";
|
|
1952
2117
|
};
|
|
1953
2118
|
readonly grantAccess: {
|
|
1954
|
-
readonly description: "`PUT .../participation/grantaccess` — body: `string[]
|
|
2119
|
+
readonly description: "`PUT .../participation/grantaccess` — владелец принимает **`Requested`** → **`Accepted`**; body: `string[]` (**profileIds**).";
|
|
1955
2120
|
};
|
|
1956
2121
|
readonly declineAccess: {
|
|
1957
|
-
readonly description: "`PUT .../participation/declineaccess` — body: `string[]`; query **`userMessage`**.";
|
|
2122
|
+
readonly description: "`PUT .../participation/declineaccess` — владелец отклоняет **`Requested`** → **`Declined`**; body: `string[]`; query **`userMessage`**.";
|
|
1958
2123
|
};
|
|
1959
2124
|
readonly updatePersonalListOrder: {
|
|
1960
2125
|
readonly description: "`POST .../personallist/updateorder` — **`UpdatePersonalListOrderReq`** → **`UpdatePersonalListOrderResp`**.";
|
|
@@ -1969,10 +2134,10 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
|
|
|
1969
2134
|
readonly description: "`PUT .../{itemId}/participation/profile` — body: **`profileId`** (string).";
|
|
1970
2135
|
};
|
|
1971
2136
|
readonly sendLink: {
|
|
1972
|
-
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**.";
|
|
2137
|
+
readonly description: "`PUT .../{itemId}/sendlink` — **`SendLinkOfItemReq`** → **`SendLinkOfItemResp`**. In-app ссылка (**`SendLinkOfItem`**); **не** создаёт `Offered`.";
|
|
1973
2138
|
};
|
|
1974
2139
|
readonly getShortUrl: {
|
|
1975
|
-
readonly description: "`POST .../{torrowId}/shorturl` → `string
|
|
2140
|
+
readonly description: "`POST .../{torrowId}/shorturl` → `string` (короткая URL элемента).";
|
|
1976
2141
|
};
|
|
1977
2142
|
readonly updateUniqueName: {
|
|
1978
2143
|
readonly description: "`PUT .../{itemId}/uniquename` — body: string (**uniqueName**).";
|
|
@@ -1984,10 +2149,10 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
|
|
|
1984
2149
|
readonly description: "`GET .../{torrowId}/image/info` → **`FileInfo`**.";
|
|
1985
2150
|
};
|
|
1986
2151
|
readonly getImagePutUrl: {
|
|
1987
|
-
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload;
|
|
2152
|
+
readonly description: "`GET .../{torrowId}/image/puturl` — presigned upload; параметры **`fileId`**, **`fileName?`**, **`fileSize?`** (query). SDK: **`{ url, urlExpiration }`**.";
|
|
1988
2153
|
};
|
|
1989
2154
|
readonly saveToMindMap: {
|
|
1990
|
-
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**.";
|
|
2155
|
+
readonly description: "`PUT .../{torrowId}/savetomindmap` — **`SaveItemToMindMapReq`** → **`Participation`**. Accept invite (`Offered`→`Accepted`), open/link save, или save с **`securityToken`** (Reader/Owner link). Флоу: **`docs/agents/participation-flow.md`**.";
|
|
1991
2156
|
};
|
|
1992
2157
|
readonly updateSolutionData: {
|
|
1993
2158
|
readonly description: "`PUT .../{torrowId}/solutiondata` — **`SolutionData`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
|
|
@@ -2012,7 +2177,7 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocs: {
|
|
|
2012
2177
|
readonly setGroup: string;
|
|
2013
2178
|
readonly unsetGroup: string;
|
|
2014
2179
|
readonly updateTags: string;
|
|
2015
|
-
readonly
|
|
2180
|
+
readonly listGroups: string;
|
|
2016
2181
|
readonly updateGroups: string;
|
|
2017
2182
|
readonly includeToGroups: string;
|
|
2018
2183
|
readonly excludeFromGroups: string;
|
|
@@ -2045,7 +2210,7 @@ declare const torrowItemFacadeSdkMethodFieldDocs: {
|
|
|
2045
2210
|
readonly getParticipantsAnonymousCount: string;
|
|
2046
2211
|
readonly getParticipantsNonAnonymousCount: string;
|
|
2047
2212
|
readonly listTags: string;
|
|
2048
|
-
readonly
|
|
2213
|
+
readonly listItemGroups: string;
|
|
2049
2214
|
readonly updateAccounts: string;
|
|
2050
2215
|
readonly shareItemLink: string;
|
|
2051
2216
|
readonly updateOfflinable: string;
|
|
@@ -2066,7 +2231,7 @@ declare const torrowItemFacadeSdkMethodFieldDocs: {
|
|
|
2066
2231
|
readonly setGroup: string;
|
|
2067
2232
|
readonly unsetGroup: string;
|
|
2068
2233
|
readonly updateTags: string;
|
|
2069
|
-
readonly
|
|
2234
|
+
readonly listGroups: string;
|
|
2070
2235
|
readonly updateGroups: string;
|
|
2071
2236
|
readonly includeToGroups: string;
|
|
2072
2237
|
readonly excludeFromGroups: string;
|
|
@@ -2101,7 +2266,7 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocs: {
|
|
|
2101
2266
|
readonly getParticipantsAnonymousCount: string;
|
|
2102
2267
|
readonly getParticipantsNonAnonymousCount: string;
|
|
2103
2268
|
readonly listTags: string;
|
|
2104
|
-
readonly
|
|
2269
|
+
readonly listItemGroups: string;
|
|
2105
2270
|
readonly updateAccounts: string;
|
|
2106
2271
|
readonly shareItemLink: string;
|
|
2107
2272
|
readonly updateOfflinable: string;
|
|
@@ -2122,7 +2287,7 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocs: {
|
|
|
2122
2287
|
readonly setGroup: string;
|
|
2123
2288
|
readonly unsetGroup: string;
|
|
2124
2289
|
readonly updateTags: string;
|
|
2125
|
-
readonly
|
|
2290
|
+
readonly listGroups: string;
|
|
2126
2291
|
readonly updateGroups: string;
|
|
2127
2292
|
readonly includeToGroups: string;
|
|
2128
2293
|
readonly excludeFromGroups: string;
|
|
@@ -2217,16 +2382,16 @@ declare const blockReasonFieldDocs: {
|
|
|
2217
2382
|
};
|
|
2218
2383
|
declare const blockReasonsSdkMethodFieldDocEntries: {
|
|
2219
2384
|
readonly create: {
|
|
2220
|
-
readonly description: "`POST /api/v1/blockreason` — создать причину; ответ: id.";
|
|
2385
|
+
readonly description: "`POST /api/v1/blockreason` — создать причину; ответ: id. Только **администратор Torrow**.";
|
|
2221
2386
|
};
|
|
2222
2387
|
readonly getById: {
|
|
2223
|
-
readonly description: "`GET /api/v1/blockreason/{id}` — одна причина, query `lng`.";
|
|
2388
|
+
readonly description: "`GET /api/v1/blockreason/{id}` — одна причина, query `lng`. Только **администратор Torrow**.";
|
|
2224
2389
|
};
|
|
2225
2390
|
readonly listAll: {
|
|
2226
|
-
readonly description: "`GET /api/v1/blockreason/all` — список с пагинацией и сортировкой словаря.";
|
|
2391
|
+
readonly description: "`GET /api/v1/blockreason/all` — список с пагинацией и сортировкой словаря. Только **администратор Torrow** (обычная сессия → HTTP 403).";
|
|
2227
2392
|
};
|
|
2228
2393
|
readonly delete: {
|
|
2229
|
-
readonly description: "`DELETE /api/v1/blockreason/{id}`.";
|
|
2394
|
+
readonly description: "`DELETE /api/v1/blockreason/{id}`. Только **администратор Torrow**.";
|
|
2230
2395
|
};
|
|
2231
2396
|
};
|
|
2232
2397
|
declare const blockReasonsSdkMethodFieldDocs: {
|
|
@@ -2236,6 +2401,75 @@ declare const blockReasonsSdkMethodFieldDocs: {
|
|
|
2236
2401
|
readonly delete: string;
|
|
2237
2402
|
};
|
|
2238
2403
|
|
|
2404
|
+
declare const apiKeyInfoFieldDocEntries: {
|
|
2405
|
+
readonly keyId: {
|
|
2406
|
+
readonly description: "Идентификатор API-ключа (для `delete` и отображения в списке).";
|
|
2407
|
+
readonly valueSchema: "string | null";
|
|
2408
|
+
};
|
|
2409
|
+
readonly name: {
|
|
2410
|
+
readonly description: "Человекочитаемое имя ключа.";
|
|
2411
|
+
readonly valueSchema: "string | null";
|
|
2412
|
+
};
|
|
2413
|
+
readonly creationTime: {
|
|
2414
|
+
readonly description: "Время создания ключа (`date-time` → `Date`).";
|
|
2415
|
+
readonly valueSchema: "Date";
|
|
2416
|
+
};
|
|
2417
|
+
readonly expiration: {
|
|
2418
|
+
readonly description: "Срок действия ключа (`date-time` → `Date | null`).";
|
|
2419
|
+
readonly valueSchema: "Date | null";
|
|
2420
|
+
};
|
|
2421
|
+
};
|
|
2422
|
+
declare const apiKeyInfoFieldDocs: {
|
|
2423
|
+
readonly keyId: string;
|
|
2424
|
+
readonly name: string;
|
|
2425
|
+
readonly creationTime: string;
|
|
2426
|
+
readonly expiration: string;
|
|
2427
|
+
};
|
|
2428
|
+
declare const createApiKeyRequestFieldDocEntries: {
|
|
2429
|
+
readonly name: {
|
|
2430
|
+
readonly description: "Имя ключа (maxLength 100).";
|
|
2431
|
+
readonly valueSchema: "string | null";
|
|
2432
|
+
};
|
|
2433
|
+
readonly lifetimeDays: {
|
|
2434
|
+
readonly description: "Срок жизни ключа в днях (1…int32); `null` — по правилам сервера.";
|
|
2435
|
+
readonly valueSchema: "int32 | null";
|
|
2436
|
+
};
|
|
2437
|
+
};
|
|
2438
|
+
declare const createApiKeyRequestFieldDocs: {
|
|
2439
|
+
readonly name: string;
|
|
2440
|
+
readonly lifetimeDays: string;
|
|
2441
|
+
};
|
|
2442
|
+
declare const createApiKeyResponseFieldDocEntries: {
|
|
2443
|
+
readonly apiKey: {
|
|
2444
|
+
readonly description: "Метаданные созданного ключа (`ApiKeyInfo`).";
|
|
2445
|
+
readonly valueSchema: "ApiKeyInfo";
|
|
2446
|
+
};
|
|
2447
|
+
readonly key: {
|
|
2448
|
+
readonly description: "Секрет API-ключа. Возвращается **один раз** при `create`. Не логировать и не сохранять в открытых логах/телеметрии.";
|
|
2449
|
+
readonly valueSchema: "string | null";
|
|
2450
|
+
};
|
|
2451
|
+
};
|
|
2452
|
+
declare const createApiKeyResponseFieldDocs: {
|
|
2453
|
+
readonly apiKey: string;
|
|
2454
|
+
readonly key: string;
|
|
2455
|
+
};
|
|
2456
|
+
declare const apiKeysSdkMethodFieldDocEntries: {
|
|
2457
|
+
readonly list: {
|
|
2458
|
+
readonly description: "`GET /api/v1/apikeys` — список API-ключей текущего пользователя (`ApiKeyInfo[]`).";
|
|
2459
|
+
};
|
|
2460
|
+
readonly create: {
|
|
2461
|
+
readonly description: "`POST /api/v1/apikeys` — создать ключ; body `CreateApiKeyRequest` → `CreateApiKeyResponse` (поле `key` — секрет, один раз).";
|
|
2462
|
+
};
|
|
2463
|
+
readonly delete: {
|
|
2464
|
+
readonly description: "`DELETE /api/v1/apikeys/{keyId}` — отозвать ключ; ответ без тела.";
|
|
2465
|
+
};
|
|
2466
|
+
};
|
|
2467
|
+
declare const apiKeysSdkMethodFieldDocs: {
|
|
2468
|
+
readonly list: string;
|
|
2469
|
+
readonly create: string;
|
|
2470
|
+
readonly delete: string;
|
|
2471
|
+
};
|
|
2472
|
+
|
|
2239
2473
|
declare const sendCommunicationCodeReqFieldDocEntries: {
|
|
2240
2474
|
readonly value: {
|
|
2241
2475
|
readonly description: "Телефон, email или иное значение канала, на которое отправляется код.";
|
|
@@ -2317,9 +2551,9 @@ declare const contactsCommunicationSdkMethodFieldDocs: {
|
|
|
2317
2551
|
|
|
2318
2552
|
declare const userSettingsInfoFieldDocEntries: {
|
|
2319
2553
|
readonly settings: {
|
|
2320
|
-
readonly description: "
|
|
2321
|
-
readonly valueSchema: "
|
|
2322
|
-
readonly usage: "
|
|
2554
|
+
readonly description: "JSON пользовательских настроек в SDK (wire OpenAPI — `string | null`). При чтении: `JSON.parse`, пустое/битое → `null`; при записи: `JSON.stringify`.";
|
|
2555
|
+
readonly valueSchema: "JsonValue | null";
|
|
2556
|
+
readonly usage: "Структуру внутри `settings` приложение задаёт само и версионирует; SDK парсит/сериализует JSON без схемы объекта.";
|
|
2323
2557
|
};
|
|
2324
2558
|
};
|
|
2325
2559
|
declare const userSettingsInfoFieldDocs: {
|
|
@@ -2346,9 +2580,10 @@ declare const solutionDataFieldDocEntries: {
|
|
|
2346
2580
|
readonly usage: "Форма item appearance сохраняет `viewBlockSettings.blockSettings[]`; порядок секций берется из `order`, а `filter.tags` используется для отдельных выборок child-views с фильтрацией по тегам.";
|
|
2347
2581
|
};
|
|
2348
2582
|
readonly layoutType: {
|
|
2349
|
-
readonly description: "Тип layout карточки (int-код UI раскладки/обложки).";
|
|
2350
|
-
readonly valueSchema: "int32 | null";
|
|
2351
|
-
readonly
|
|
2583
|
+
readonly description: "Тип layout карточки (int-код UI раскладки/обложки). Известные коды и смысл — каталог MCP **`LayoutTypeValues`** / константы `LayoutTypeValues` в `@torrow/sdk-client` (torrow-apps `LayoutType`).";
|
|
2584
|
+
readonly valueSchema: "LayoutTypeValues | int32 | null";
|
|
2585
|
+
readonly examples: readonly ["0", "1", "2", "3", "4", "5", "6", "7"];
|
|
2586
|
+
readonly usage: "Пишется формой item appearance (`updateSolutionData`). В UI выбора обложки: NonImage / SideImage / SmallImagePanel / MediumImagePanel / BigImagePanel. На мобильном `BigImagePanel` + image включает image-view с opacity toolbar. Поле не enum OpenAPI — допустим любой int; агенту для выбора значения смотреть `LayoutTypeValues.*`.";
|
|
2352
2587
|
};
|
|
2353
2588
|
readonly homeItemIds: {
|
|
2354
2589
|
readonly description: "Закрепленные home-элементы (обычно один выбранный id).";
|
|
@@ -2374,6 +2609,73 @@ declare const solutionDataFieldDocs: {
|
|
|
2374
2609
|
readonly vk: string;
|
|
2375
2610
|
readonly zoom: string;
|
|
2376
2611
|
};
|
|
2612
|
+
/**
|
|
2613
|
+
* Известные int-коды `SolutionData.layoutType` для MCP/ИИ (torrow-apps `LayoutType`, UI «Обложка элемента»).
|
|
2614
|
+
* Wire-значение — число в JSON; ключи совпадают с `LayoutTypeValues` в `@torrow/sdk-client`.
|
|
2615
|
+
*/
|
|
2616
|
+
declare const layoutTypeValuesFieldDocEntries: {
|
|
2617
|
+
readonly value: {
|
|
2618
|
+
readonly description: "Справочник известных кодов обложки карточки (`SolutionData.layoutType`). Не OpenAPI-enum: поле остаётся `number | null`, список ниже — продуктовый контракт UI.";
|
|
2619
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2620
|
+
readonly usage: "Константы SDK: `LayoutTypeValues.<Name>` → int в теле `updateSolutionData`. Appearance form предлагает NonImage, SideImage, SmallImagePanel, MediumImagePanel, BigImagePanel. Дефолт контакта/заметки — SideImage; case/service/resource — MediumImagePanel (`TorrowItemHelper.getDefaultLayoutType`).";
|
|
2621
|
+
};
|
|
2622
|
+
readonly Unknown: {
|
|
2623
|
+
readonly description: "`0` — служебное/не задано; клиент обычно подставляет default layout по типу item, а не показывает Unknown в селекторе обложки.";
|
|
2624
|
+
readonly examples: readonly ["0"];
|
|
2625
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2626
|
+
};
|
|
2627
|
+
readonly SideImage: {
|
|
2628
|
+
readonly description: "`1` — «Изображение» (side image): компактная картинка сбоку от заголовка/карточки. Дефолт для Contact/Note/Context и прочих не-case/service/resource.";
|
|
2629
|
+
readonly examples: readonly ["1"];
|
|
2630
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2631
|
+
readonly usage: "Виджет `ttSideImage`; показывается при наличии `item.image`.";
|
|
2632
|
+
};
|
|
2633
|
+
readonly SmallImagePanel: {
|
|
2634
|
+
readonly description: "`2` — «Маленький баннер»: небольшой image-panel в шапке карточки.";
|
|
2635
|
+
readonly examples: readonly ["2"];
|
|
2636
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2637
|
+
readonly usage: "Слот `ttSmallImageMobilePanelSlot`; видим при `layoutType === SmallImagePanel` и наличии image.";
|
|
2638
|
+
};
|
|
2639
|
+
readonly MediumImagePanel: {
|
|
2640
|
+
readonly description: "`3` — «Средний баннер»: средний image-panel. Дефолт для Case/Service/Resource (и их view) в torrow-apps.";
|
|
2641
|
+
readonly examples: readonly ["3"];
|
|
2642
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2643
|
+
};
|
|
2644
|
+
readonly BigImagePanel: {
|
|
2645
|
+
readonly description: "`4` — «Большой баннер»: крупная обложка; на мобильном с image включает fullscreen-like image view и toolbar с меняющейся opacity при скролле.";
|
|
2646
|
+
readonly examples: readonly ["4"];
|
|
2647
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2648
|
+
readonly usage: "Имя может «прибиваться» поверх большого баннера (`isVisibleNailedName`).";
|
|
2649
|
+
};
|
|
2650
|
+
readonly SmallSlider: {
|
|
2651
|
+
readonly description: "`5` — layout со слайдером изображений (small). Есть в модели `LayoutType`, в форме appearance item cover обычно не предлагается.";
|
|
2652
|
+
readonly examples: readonly ["5"];
|
|
2653
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2654
|
+
readonly usage: "Не путать с `NoteItem.imagePreviewSize` (`ImagePreviewSize.SmallSlider`) — это другое поле.";
|
|
2655
|
+
};
|
|
2656
|
+
readonly BigSlider: {
|
|
2657
|
+
readonly description: "`6` — layout со слайдером изображений (big). Есть в модели `LayoutType`, в форме appearance item cover обычно не предлагается.";
|
|
2658
|
+
readonly examples: readonly ["6"];
|
|
2659
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2660
|
+
readonly usage: "Не путать с `NoteItem.imagePreviewSize` (`ImagePreviewSize.*Slider`).";
|
|
2661
|
+
};
|
|
2662
|
+
readonly NonImage: {
|
|
2663
|
+
readonly description: "`7` — «Нет изображения»: шапка без обложки/баннера (`ttNonImagePanel`), даже если у item есть `image`.";
|
|
2664
|
+
readonly examples: readonly ["7"];
|
|
2665
|
+
readonly valueSchema: "LayoutTypeValues";
|
|
2666
|
+
};
|
|
2667
|
+
};
|
|
2668
|
+
declare const layoutTypeValuesFieldDocs: {
|
|
2669
|
+
readonly value: string;
|
|
2670
|
+
readonly Unknown: string;
|
|
2671
|
+
readonly SideImage: string;
|
|
2672
|
+
readonly SmallImagePanel: string;
|
|
2673
|
+
readonly MediumImagePanel: string;
|
|
2674
|
+
readonly BigImagePanel: string;
|
|
2675
|
+
readonly SmallSlider: string;
|
|
2676
|
+
readonly BigSlider: string;
|
|
2677
|
+
readonly NonImage: string;
|
|
2678
|
+
};
|
|
2377
2679
|
declare const blockInfoFieldDocEntries: {
|
|
2378
2680
|
readonly reasonId: {
|
|
2379
2681
|
readonly description: "Код причины блокировки.";
|
|
@@ -2551,8 +2853,8 @@ declare const deviceSettingsInfoFieldDocEntries: {
|
|
|
2551
2853
|
readonly valueSchema: "string | null";
|
|
2552
2854
|
};
|
|
2553
2855
|
readonly settings: {
|
|
2554
|
-
readonly description: "
|
|
2555
|
-
readonly valueSchema: "
|
|
2856
|
+
readonly description: "Настройки устройства как JSON. Wire OpenAPI — `string | null` (query/тело); SDK: parse при чтении (`null` если не JSON), stringify при записи.";
|
|
2857
|
+
readonly valueSchema: "JsonValue | null";
|
|
2556
2858
|
};
|
|
2557
2859
|
};
|
|
2558
2860
|
declare const deviceSettingsInfoFieldDocs: {
|
|
@@ -2609,7 +2911,7 @@ declare const shareItemReqFieldDocEntries: {
|
|
|
2609
2911
|
readonly valueSchema: "string | null";
|
|
2610
2912
|
};
|
|
2611
2913
|
readonly readerProfileIdList: {
|
|
2612
|
-
readonly description: "Список профилей-получателей (основное поле API).";
|
|
2914
|
+
readonly description: "Список профилей-получателей (основное поле API). Каждый id должен уже быть в личном списке владельца, иначе `failedToParticipate` → `CONTACT_IS_NOT_IN_PERSONAL_LIST`.";
|
|
2613
2915
|
readonly valueSchema: "string[] | null";
|
|
2614
2916
|
};
|
|
2615
2917
|
readonly readerProfileIdsList: {
|
|
@@ -2661,6 +2963,35 @@ declare const sendLinkOfItemReqFieldDocs: {
|
|
|
2661
2963
|
readonly recipientProfileIdList: string;
|
|
2662
2964
|
readonly message: string;
|
|
2663
2965
|
};
|
|
2966
|
+
declare const getShareItemSessionReqFieldDocEntries: {
|
|
2967
|
+
readonly userProfileId: {
|
|
2968
|
+
readonly description: "Профиль инициатора invite-session ссылки.";
|
|
2969
|
+
readonly valueSchema: "string | null";
|
|
2970
|
+
};
|
|
2971
|
+
readonly expiredDate: {
|
|
2972
|
+
readonly description: "Срок действия session URL.";
|
|
2973
|
+
readonly valueSchema: "Date";
|
|
2974
|
+
};
|
|
2975
|
+
readonly activateCount: {
|
|
2976
|
+
readonly description: "Сколько раз можно активировать session.";
|
|
2977
|
+
readonly valueSchema: "number";
|
|
2978
|
+
};
|
|
2979
|
+
readonly code: {
|
|
2980
|
+
readonly description: "Опциональный код активации.";
|
|
2981
|
+
readonly valueSchema: "string | null";
|
|
2982
|
+
};
|
|
2983
|
+
readonly userMessage: {
|
|
2984
|
+
readonly description: "Сообщение к invite-session.";
|
|
2985
|
+
readonly valueSchema: "string | null";
|
|
2986
|
+
};
|
|
2987
|
+
};
|
|
2988
|
+
declare const getShareItemSessionReqFieldDocs: {
|
|
2989
|
+
readonly userProfileId: string;
|
|
2990
|
+
readonly expiredDate: string;
|
|
2991
|
+
readonly activateCount: string;
|
|
2992
|
+
readonly code: string;
|
|
2993
|
+
readonly userMessage: string;
|
|
2994
|
+
};
|
|
2664
2995
|
declare const sendLinkOfItemRespFieldDocEntries: {
|
|
2665
2996
|
readonly isSuccess: {
|
|
2666
2997
|
readonly description: "Итог отправки ссылки.";
|
|
@@ -2841,6 +3172,42 @@ declare const actionHistoryInfoFieldDocEntries: {
|
|
|
2841
3172
|
readonly description: "Профили корреспондентов/получателей события.";
|
|
2842
3173
|
readonly valueSchema: "ContactView[] | null";
|
|
2843
3174
|
};
|
|
3175
|
+
readonly itemContactView: {
|
|
3176
|
+
readonly description: "Снимок контакта, к которому относится событие (если применимо).";
|
|
3177
|
+
readonly valueSchema: "ContactView";
|
|
3178
|
+
};
|
|
3179
|
+
readonly itemContextView: {
|
|
3180
|
+
readonly description: "Снимок контекста, к которому относится событие (если применимо).";
|
|
3181
|
+
readonly valueSchema: "ContextView";
|
|
3182
|
+
};
|
|
3183
|
+
readonly itemNoteView: {
|
|
3184
|
+
readonly description: "Снимок заметки, к которой относится событие (если применимо).";
|
|
3185
|
+
readonly valueSchema: "NoteView";
|
|
3186
|
+
};
|
|
3187
|
+
readonly itemCaseView: {
|
|
3188
|
+
readonly description: "Снимок события/кейса, к которому относится запись (если применимо).";
|
|
3189
|
+
readonly valueSchema: "CaseView";
|
|
3190
|
+
};
|
|
3191
|
+
readonly itemCalendarView: {
|
|
3192
|
+
readonly description: "Снимок календаря, к которому относится событие (если применимо).";
|
|
3193
|
+
readonly valueSchema: "CalendarView";
|
|
3194
|
+
};
|
|
3195
|
+
readonly itemServiceView: {
|
|
3196
|
+
readonly description: "Снимок услуги, к которой относится событие (если применимо).";
|
|
3197
|
+
readonly valueSchema: "ServiceView";
|
|
3198
|
+
};
|
|
3199
|
+
readonly itemResourceView: {
|
|
3200
|
+
readonly description: "Снимок ресурса, к которому относится событие (если применимо).";
|
|
3201
|
+
readonly valueSchema: "ResourceView";
|
|
3202
|
+
};
|
|
3203
|
+
readonly itemLoyaltyCardView: {
|
|
3204
|
+
readonly description: "Снимок карты лояльности, к которой относится событие (если применимо).";
|
|
3205
|
+
readonly valueSchema: "LoyaltyCardView";
|
|
3206
|
+
};
|
|
3207
|
+
readonly itemLoyaltySystemView: {
|
|
3208
|
+
readonly description: "Снимок программы лояльности, к которой относится событие (если применимо).";
|
|
3209
|
+
readonly valueSchema: "LoyaltySystemView";
|
|
3210
|
+
};
|
|
2844
3211
|
readonly id: {
|
|
2845
3212
|
readonly description: "ID записи action-history.";
|
|
2846
3213
|
readonly valueSchema: "string | null";
|
|
@@ -2857,9 +3224,133 @@ declare const actionHistoryInfoFieldDocs: {
|
|
|
2857
3224
|
readonly text: string;
|
|
2858
3225
|
readonly userProfileView: string;
|
|
2859
3226
|
readonly correspondentProfileViewList: string;
|
|
3227
|
+
readonly itemContactView: string;
|
|
3228
|
+
readonly itemContextView: string;
|
|
3229
|
+
readonly itemNoteView: string;
|
|
3230
|
+
readonly itemCaseView: string;
|
|
3231
|
+
readonly itemCalendarView: string;
|
|
3232
|
+
readonly itemServiceView: string;
|
|
3233
|
+
readonly itemResourceView: string;
|
|
3234
|
+
readonly itemLoyaltyCardView: string;
|
|
3235
|
+
readonly itemLoyaltySystemView: string;
|
|
2860
3236
|
readonly id: string;
|
|
2861
3237
|
readonly meta: string;
|
|
2862
3238
|
};
|
|
3239
|
+
/** Query `GET /api/v1/actionhistory` (`ActionHistoryListQuery` / OpenAPI). */
|
|
3240
|
+
declare const actionHistoryListQueryFieldDocEntries: {
|
|
3241
|
+
readonly language: {
|
|
3242
|
+
readonly description: "Язык локализации текста событий (BCP-47, напр. `ru`, `en`). В OpenAPI не `required`, но на шлюзе **фактически обязателен**: пустой/отсутствующий → HTTP 500 `INVALID_ARGUMENT` (`Language is null or empty`).";
|
|
3243
|
+
readonly valueSchema: "string";
|
|
3244
|
+
readonly examples: readonly ["ru", "en"];
|
|
3245
|
+
};
|
|
3246
|
+
readonly take: {
|
|
3247
|
+
readonly description: "Максимум записей в ответе (пагинация). Default в OpenAPI — `2147483647`.";
|
|
3248
|
+
readonly valueSchema: "int32";
|
|
3249
|
+
};
|
|
3250
|
+
readonly skip: {
|
|
3251
|
+
readonly description: "Смещение пагинации. Default в OpenAPI — `0`.";
|
|
3252
|
+
readonly valueSchema: "int32";
|
|
3253
|
+
};
|
|
3254
|
+
readonly lmfrom: {
|
|
3255
|
+
readonly description: "Нижняя граница фильтра по времени изменения записи истории. Имя query **lower-case** (`lmfrom`, не `lmFrom`).";
|
|
3256
|
+
readonly valueSchema: "Date | null (date-time)";
|
|
3257
|
+
};
|
|
3258
|
+
readonly lmto: {
|
|
3259
|
+
readonly description: "Верхняя граница фильтра по времени изменения записи истории. Имя query **lower-case** (`lmto`, не `lmTo`).";
|
|
3260
|
+
readonly valueSchema: "Date | null (date-time)";
|
|
3261
|
+
};
|
|
3262
|
+
readonly includeDeleted: {
|
|
3263
|
+
readonly description: "Включать записи по удалённым объектам. Default в OpenAPI — `false`.";
|
|
3264
|
+
readonly valueSchema: "boolean";
|
|
3265
|
+
};
|
|
3266
|
+
readonly sort: {
|
|
3267
|
+
readonly description: "Условие сортировки списка.";
|
|
3268
|
+
readonly valueSchema: "ItemViewSortCondition";
|
|
3269
|
+
};
|
|
3270
|
+
readonly types: {
|
|
3271
|
+
readonly description: "Фильтр по типам действий (`CreateItem`, `UpdateItem`, …).";
|
|
3272
|
+
readonly valueSchema: "ActionHistoryType[]";
|
|
3273
|
+
};
|
|
3274
|
+
readonly states: {
|
|
3275
|
+
readonly description: "Фильтр по состоянию записи (`Executing`, `Success`, …).";
|
|
3276
|
+
readonly valueSchema: "ActionHistoryState[]";
|
|
3277
|
+
};
|
|
3278
|
+
readonly itemIds: {
|
|
3279
|
+
readonly description: "Фильтр по id элементов. Опционален: без параметра / `[]` — лента действий пользователя; непустой список — история по выбранным item (нужны существующие id с доступом). Невалидный id на шлюзе может дать HTTP 500.";
|
|
3280
|
+
readonly valueSchema: "string[]";
|
|
3281
|
+
};
|
|
3282
|
+
};
|
|
3283
|
+
declare const actionHistoryListQueryFieldDocs: {
|
|
3284
|
+
readonly language: string;
|
|
3285
|
+
readonly take: string;
|
|
3286
|
+
readonly skip: string;
|
|
3287
|
+
readonly lmfrom: string;
|
|
3288
|
+
readonly lmto: string;
|
|
3289
|
+
readonly includeDeleted: string;
|
|
3290
|
+
readonly sort: string;
|
|
3291
|
+
readonly types: string;
|
|
3292
|
+
readonly states: string;
|
|
3293
|
+
readonly itemIds: string;
|
|
3294
|
+
};
|
|
3295
|
+
/** Query `GET /api/v1/announcements` (`AnnouncementsListQuery` / OpenAPI). */
|
|
3296
|
+
declare const announcementsListQueryFieldDocEntries: {
|
|
3297
|
+
readonly language: {
|
|
3298
|
+
readonly description: "Язык локализации текста уведомлений (BCP-47, напр. `ru`, `en`). В OpenAPI не `required`, но на шлюзе **фактически обязателен**: пустой/отсутствующий → HTTP 500 `INVALID_ARGUMENT` (`Language is null or empty`).";
|
|
3299
|
+
readonly valueSchema: "string";
|
|
3300
|
+
readonly examples: readonly ["ru", "en"];
|
|
3301
|
+
};
|
|
3302
|
+
readonly state: {
|
|
3303
|
+
readonly description: "Один фильтр по состоянию (`New`, `Hidden`, `Read`, …). Если задан — имеет приоритет над **`stateList`**. Без **`state`** и **`stateList`** шлюз отдаёт **пустой** список (не ошибку).";
|
|
3304
|
+
readonly valueSchema: "AnnouncementState";
|
|
3305
|
+
readonly examples: readonly ["New", "Hidden"];
|
|
3306
|
+
};
|
|
3307
|
+
readonly stateList: {
|
|
3308
|
+
readonly description: "Фильтр по нескольким состояниям. В приложении лента грузит **`New`** (новые) и **`Hidden`** (обработанные) отдельными запросами. Без **`state`** и **`stateList`** ответ пустой.";
|
|
3309
|
+
readonly valueSchema: "AnnouncementState[]";
|
|
3310
|
+
readonly examples: readonly ["[\"New\", \"Hidden\"]"];
|
|
3311
|
+
};
|
|
3312
|
+
readonly take: {
|
|
3313
|
+
readonly description: "Максимум записей в ответе (пагинация). Default в OpenAPI — `2147483647`.";
|
|
3314
|
+
readonly valueSchema: "int32";
|
|
3315
|
+
};
|
|
3316
|
+
readonly skip: {
|
|
3317
|
+
readonly description: "Смещение пагинации. Default в OpenAPI — `0`.";
|
|
3318
|
+
readonly valueSchema: "int32";
|
|
3319
|
+
};
|
|
3320
|
+
readonly lmfrom: {
|
|
3321
|
+
readonly description: "Нижняя граница фильтра по времени изменения. Имя query **lower-case** (`lmfrom`, не `lmFrom`).";
|
|
3322
|
+
readonly valueSchema: "Date | null (date-time)";
|
|
3323
|
+
};
|
|
3324
|
+
readonly lmto: {
|
|
3325
|
+
readonly description: "Верхняя граница фильтра по времени изменения. Имя query **lower-case** (`lmto`, не `lmTo`).";
|
|
3326
|
+
readonly valueSchema: "Date | null (date-time)";
|
|
3327
|
+
};
|
|
3328
|
+
readonly includeDeleted: {
|
|
3329
|
+
readonly description: "Включать удалённые уведомления. Default в OpenAPI — `false`.";
|
|
3330
|
+
readonly valueSchema: "boolean";
|
|
3331
|
+
};
|
|
3332
|
+
readonly sort: {
|
|
3333
|
+
readonly description: "Условие сортировки списка (в приложении часто `LastModifiedDesc`).";
|
|
3334
|
+
readonly valueSchema: "ItemViewSortCondition";
|
|
3335
|
+
readonly examples: readonly ["LastModifiedDesc"];
|
|
3336
|
+
};
|
|
3337
|
+
readonly profileId: {
|
|
3338
|
+
readonly description: "Опциональный фильтр по профилю-получателю уведомления.";
|
|
3339
|
+
readonly valueSchema: "string | null";
|
|
3340
|
+
};
|
|
3341
|
+
};
|
|
3342
|
+
declare const announcementsListQueryFieldDocs: {
|
|
3343
|
+
readonly language: string;
|
|
3344
|
+
readonly state: string;
|
|
3345
|
+
readonly stateList: string;
|
|
3346
|
+
readonly take: string;
|
|
3347
|
+
readonly skip: string;
|
|
3348
|
+
readonly lmfrom: string;
|
|
3349
|
+
readonly lmto: string;
|
|
3350
|
+
readonly includeDeleted: string;
|
|
3351
|
+
readonly sort: string;
|
|
3352
|
+
readonly profileId: string;
|
|
3353
|
+
};
|
|
2863
3354
|
declare const announcementInfoFieldDocEntries: {
|
|
2864
3355
|
readonly type: {
|
|
2865
3356
|
readonly description: "Тип анонса (share, grant access, create order, ...).";
|
|
@@ -3049,12 +3540,18 @@ declare const generateReportReqFieldDocs: {
|
|
|
3049
3540
|
readonly properties: string;
|
|
3050
3541
|
};
|
|
3051
3542
|
declare const reportPropertiesFieldDocEntries: {
|
|
3543
|
+
readonly discriminator: {
|
|
3544
|
+
readonly description: "Subtype отчёта (NJsonSchema inheritance). Swagger описывает только базу; runtime требует одно из: `CaseReportProperties`, `ServiceReportProperties`, `ServicesResourcesReportProperties`, `ResourcesRentReportProperties`, `ResourceReportProperties`. Пустой `{}` → HTTP 500.";
|
|
3545
|
+
readonly valueSchema: "string";
|
|
3546
|
+
readonly examples: readonly ["CaseReportProperties", "ServiceReportProperties"];
|
|
3547
|
+
};
|
|
3052
3548
|
readonly fakeForTsGeneratorDoNotRemove: {
|
|
3053
3549
|
readonly description: "Техническое поле OpenAPI для генератора типов. В бизнес-логике отчётов не используется и обычно не передаётся.";
|
|
3054
3550
|
readonly valueSchema: "int32 | null";
|
|
3055
3551
|
};
|
|
3056
3552
|
};
|
|
3057
3553
|
declare const reportPropertiesFieldDocs: {
|
|
3554
|
+
readonly discriminator: string;
|
|
3058
3555
|
readonly fakeForTsGeneratorDoNotRemove: string;
|
|
3059
3556
|
};
|
|
3060
3557
|
declare const reportOptionsFieldDocEntries: {
|
|
@@ -3140,6 +3637,54 @@ declare const loyaltyCardSubscriptionFieldDocs: {
|
|
|
3140
3637
|
readonly caseParticipantId: string;
|
|
3141
3638
|
readonly image: string;
|
|
3142
3639
|
};
|
|
3640
|
+
/** Тело `POST .../loyaltysystems/{id}/loyaltycard` — **`CreateLoyaltyCardReq`**. */
|
|
3641
|
+
declare const createLoyaltyCardReqFieldDocEntries: {
|
|
3642
|
+
readonly profileId: {
|
|
3643
|
+
readonly description: "Профиль владельца выпускаемой карты (обязателен).";
|
|
3644
|
+
readonly valueSchema: "string";
|
|
3645
|
+
readonly usage: "`client.loyaltySystems.createLoyaltyCard(systemId, { profileId, … })`.";
|
|
3646
|
+
};
|
|
3647
|
+
readonly basisItemId: {
|
|
3648
|
+
readonly description: "ID элемента (например, заказа / `CaseItem`), на основании которого создаются карта клиента и абонемент.";
|
|
3649
|
+
readonly valueSchema: "string | null";
|
|
3650
|
+
readonly usage: "Сценарий записи/оплаты → выпуск карты с привязкой к заказу; `null` — выпуск без элемента-основания.";
|
|
3651
|
+
};
|
|
3652
|
+
readonly contactInformation: {
|
|
3653
|
+
readonly description: "Контактные данные держателя карты при выпуске (если передаются отдельно от профиля).";
|
|
3654
|
+
readonly valueSchema: "ContactInformation";
|
|
3655
|
+
};
|
|
3656
|
+
};
|
|
3657
|
+
declare const createLoyaltyCardReqFieldDocs: {
|
|
3658
|
+
readonly profileId: string;
|
|
3659
|
+
readonly basisItemId: string;
|
|
3660
|
+
readonly contactInformation: string;
|
|
3661
|
+
};
|
|
3662
|
+
/** Вложенный объект в **`CreateLoyaltyCardSubscriptionReq.initialTransaction`**. */
|
|
3663
|
+
declare const initialTransactionFieldDocEntries: {
|
|
3664
|
+
readonly beginTransactionValues: {
|
|
3665
|
+
readonly description: "Начальные значения баланса/продуктов при создании абонемента.";
|
|
3666
|
+
readonly valueSchema: "TransactionValue[]";
|
|
3667
|
+
};
|
|
3668
|
+
readonly state: {
|
|
3669
|
+
readonly description: "Состояние начальной транзакции (`Intended`, `Reserved`, `Commited`, …).";
|
|
3670
|
+
readonly valueSchema: "AccountingTransactionState";
|
|
3671
|
+
};
|
|
3672
|
+
readonly basisItemId: {
|
|
3673
|
+
readonly description: "ID элемента (например, заказа / `CaseItem`), на основании которого созданы карта клиента и абонемент; связывается с начальной транзакцией подписки.";
|
|
3674
|
+
readonly valueSchema: "string | null";
|
|
3675
|
+
readonly usage: "Тот же смысл, что у **`CreateLoyaltyCardReq.basisItemId`**, в контексте `createSubscription`.";
|
|
3676
|
+
};
|
|
3677
|
+
readonly caseParticipantId: {
|
|
3678
|
+
readonly description: "ID участника кейса, связанного с начальной транзакцией (если применимо).";
|
|
3679
|
+
readonly valueSchema: "string | null";
|
|
3680
|
+
};
|
|
3681
|
+
};
|
|
3682
|
+
declare const initialTransactionFieldDocs: {
|
|
3683
|
+
readonly beginTransactionValues: string;
|
|
3684
|
+
readonly state: string;
|
|
3685
|
+
readonly basisItemId: string;
|
|
3686
|
+
readonly caseParticipantId: string;
|
|
3687
|
+
};
|
|
3143
3688
|
declare const loyaltySystemsStatisticsReqFieldDocEntries: {
|
|
3144
3689
|
readonly loyaltySystemIdList: {
|
|
3145
3690
|
readonly description: "Список программ лояльности, по которым считают агрегаты.";
|
|
@@ -3167,19 +3712,19 @@ declare const loyaltySystemsStatisticsReqFieldDocEntries: {
|
|
|
3167
3712
|
};
|
|
3168
3713
|
readonly lastModifiedFrom: {
|
|
3169
3714
|
readonly description: "Нижняя граница по дате изменения.";
|
|
3170
|
-
readonly valueSchema: "
|
|
3715
|
+
readonly valueSchema: "Date | null";
|
|
3171
3716
|
};
|
|
3172
3717
|
readonly lastModifiedTo: {
|
|
3173
3718
|
readonly description: "Верхняя граница по дате изменения.";
|
|
3174
|
-
readonly valueSchema: "
|
|
3719
|
+
readonly valueSchema: "Date | null";
|
|
3175
3720
|
};
|
|
3176
3721
|
readonly createDateFrom: {
|
|
3177
3722
|
readonly description: "Нижняя граница по дате создания.";
|
|
3178
|
-
readonly valueSchema: "
|
|
3723
|
+
readonly valueSchema: "Date | null";
|
|
3179
3724
|
};
|
|
3180
3725
|
readonly createDateTo: {
|
|
3181
3726
|
readonly description: "Верхняя граница по дате создания.";
|
|
3182
|
-
readonly valueSchema: "
|
|
3727
|
+
readonly valueSchema: "Date | null";
|
|
3183
3728
|
};
|
|
3184
3729
|
};
|
|
3185
3730
|
declare const loyaltySystemsStatisticsReqFieldDocs: {
|
|
@@ -3297,14 +3842,17 @@ declare const fileInfoFieldDocEntries: {
|
|
|
3297
3842
|
readonly id: {
|
|
3298
3843
|
readonly description: "ID файла в хранилище.";
|
|
3299
3844
|
readonly valueSchema: "string | null";
|
|
3845
|
+
readonly usage: "В теле **create**/**update** item (`image`, `files[]`, …) достаточно только **`id`** — в БД сохраняется ссылка на файл. **`fileName`** / **`fileSize`** для puturl — query **`getImagePutUrl`** / **`getFilePutUrl`**, не обязательны в теле item.";
|
|
3300
3846
|
};
|
|
3301
3847
|
readonly url: {
|
|
3302
3848
|
readonly description: "Текущий URL файла (может быть временным).";
|
|
3303
3849
|
readonly valueSchema: "string | null";
|
|
3850
|
+
readonly usage: "Только в ответах (**getById**, **getFileInfo**, …); в write-тело не передаётся.";
|
|
3304
3851
|
};
|
|
3305
3852
|
readonly urlExpiration: {
|
|
3306
3853
|
readonly description: "Срок действия `url`.";
|
|
3307
3854
|
readonly valueSchema: "date-time string | null";
|
|
3855
|
+
readonly usage: "Только read; presigned download URL из ответа сервера.";
|
|
3308
3856
|
};
|
|
3309
3857
|
readonly eTag: {
|
|
3310
3858
|
readonly description: "ETag файла для кеша/валидации.";
|
|
@@ -3313,14 +3861,17 @@ declare const fileInfoFieldDocEntries: {
|
|
|
3313
3861
|
readonly fileName: {
|
|
3314
3862
|
readonly description: "Имя файла.";
|
|
3315
3863
|
readonly valueSchema: "string | null";
|
|
3864
|
+
readonly usage: "Read и query puturl; в create/update item не обязателен (как в torrow-apps).";
|
|
3316
3865
|
};
|
|
3317
3866
|
readonly fileSize: {
|
|
3318
3867
|
readonly description: "Размер файла в байтах.";
|
|
3319
3868
|
readonly valueSchema: "int64 | null";
|
|
3869
|
+
readonly usage: "Read и query puturl; в create/update item не обязателен.";
|
|
3320
3870
|
};
|
|
3321
3871
|
readonly refreshUrl: {
|
|
3322
3872
|
readonly description: "URL для обновления/рефреша ссылки.";
|
|
3323
3873
|
readonly valueSchema: "string | null";
|
|
3874
|
+
readonly usage: "Только read; альтернатива явному **getFileInfo** / **getImageInfo** при протухшем `url`.";
|
|
3324
3875
|
};
|
|
3325
3876
|
};
|
|
3326
3877
|
declare const fileInfoFieldDocs: {
|
|
@@ -3363,30 +3914,36 @@ declare const updateFileIdRespFieldDocs: {
|
|
|
3363
3914
|
|
|
3364
3915
|
declare const searchSdkMethodFieldDocEntries: {
|
|
3365
3916
|
readonly advisedItems: {
|
|
3366
|
-
readonly description:
|
|
3367
|
-
readonly usage:
|
|
3917
|
+
readonly description: string;
|
|
3918
|
+
readonly usage: string;
|
|
3368
3919
|
};
|
|
3369
3920
|
readonly orders: {
|
|
3370
3921
|
readonly description: "`PUT /api/v1/search/{torrowId}/orders` — список представлений заказов (**`CaseView[]`**) под родителем с **`OrderFilter`** в теле.";
|
|
3371
|
-
readonly usage: "Альтернатива **`client.raw.put`**; см. **`examples/node/raw/
|
|
3922
|
+
readonly usage: "Альтернатива **`client.raw.put`**; см. **`examples/node/raw/search-orders-raw.ts`**.";
|
|
3372
3923
|
};
|
|
3373
3924
|
readonly contacts: {
|
|
3374
3925
|
readonly description: "`GET /api/v1/search/contacts` — **`ContactView[]`** по тексту и опциям.";
|
|
3926
|
+
readonly usage: string;
|
|
3375
3927
|
};
|
|
3376
3928
|
readonly notes: {
|
|
3377
3929
|
readonly description: "`GET /api/v1/search/notes` — **`NoteView[]`**.";
|
|
3930
|
+
readonly usage: string;
|
|
3378
3931
|
};
|
|
3379
3932
|
readonly calendars: {
|
|
3380
3933
|
readonly description: "`GET /api/v1/search/calendars` — **`CalendarView[]`**.";
|
|
3934
|
+
readonly usage: string;
|
|
3381
3935
|
};
|
|
3382
3936
|
readonly cases: {
|
|
3383
3937
|
readonly description: "`GET /api/v1/search/cases` — **`CaseView[]`**.";
|
|
3938
|
+
readonly usage: string;
|
|
3384
3939
|
};
|
|
3385
3940
|
readonly resources: {
|
|
3386
3941
|
readonly description: "`GET /api/v1/search/resources` — **`ResourceView[]`**.";
|
|
3942
|
+
readonly usage: string;
|
|
3387
3943
|
};
|
|
3388
3944
|
readonly services: {
|
|
3389
3945
|
readonly description: "`GET /api/v1/search/services` — **`ServiceView[]`**.";
|
|
3946
|
+
readonly usage: string;
|
|
3390
3947
|
};
|
|
3391
3948
|
};
|
|
3392
3949
|
declare const searchSdkMethodFieldDocs: {
|
|
@@ -3399,6 +3956,45 @@ declare const searchSdkMethodFieldDocs: {
|
|
|
3399
3956
|
readonly resources: string;
|
|
3400
3957
|
readonly services: string;
|
|
3401
3958
|
};
|
|
3959
|
+
/** Query `GET /api/v1/search/adviseditems` (`AdvisedItemsSearchQuery` / OpenAPI). */
|
|
3960
|
+
declare const advisedItemsSearchQueryFieldDocEntries: {
|
|
3961
|
+
readonly type: {
|
|
3962
|
+
readonly description: "Режим подборки: **`NearLocation`** (рядом с точкой) или **`Recommendation`** (персональные рекомендации).";
|
|
3963
|
+
readonly valueSchema: "AdvisedItemType";
|
|
3964
|
+
readonly examples: readonly ["NearLocation", "Recommendation"];
|
|
3965
|
+
};
|
|
3966
|
+
readonly longitude: {
|
|
3967
|
+
readonly description: "Долгота WGS84. Для **`NearLocation`** задавай вместе с **`latitude`**.";
|
|
3968
|
+
readonly valueSchema: "number (double)";
|
|
3969
|
+
readonly examples: readonly ["30.3141"];
|
|
3970
|
+
};
|
|
3971
|
+
readonly latitude: {
|
|
3972
|
+
readonly description: "Широта WGS84. Для **`NearLocation`** задавай вместе с **`longitude`**.";
|
|
3973
|
+
readonly valueSchema: "number (double)";
|
|
3974
|
+
readonly examples: readonly ["59.9386"];
|
|
3975
|
+
};
|
|
3976
|
+
readonly language: {
|
|
3977
|
+
readonly description: "Язык локализации подборки (BCP-47).";
|
|
3978
|
+
readonly valueSchema: "string";
|
|
3979
|
+
readonly examples: readonly ["ru", "en"];
|
|
3980
|
+
};
|
|
3981
|
+
readonly take: {
|
|
3982
|
+
readonly description: "Максимум элементов в ответе (пагинация).";
|
|
3983
|
+
readonly valueSchema: "int32";
|
|
3984
|
+
};
|
|
3985
|
+
readonly skip: {
|
|
3986
|
+
readonly description: "Смещение пагинации.";
|
|
3987
|
+
readonly valueSchema: "int32";
|
|
3988
|
+
};
|
|
3989
|
+
};
|
|
3990
|
+
declare const advisedItemsSearchQueryFieldDocs: {
|
|
3991
|
+
readonly type: string;
|
|
3992
|
+
readonly longitude: string;
|
|
3993
|
+
readonly latitude: string;
|
|
3994
|
+
readonly language: string;
|
|
3995
|
+
readonly take: string;
|
|
3996
|
+
readonly skip: string;
|
|
3997
|
+
};
|
|
3402
3998
|
declare const orderFilterFieldDocEntries: {
|
|
3403
3999
|
readonly searchText: {
|
|
3404
4000
|
readonly description: "Подстрока для фильтрации заказов (семантика на стороне API).";
|
|
@@ -3434,64 +4030,69 @@ declare const orderFilterFieldDocs: {
|
|
|
3434
4030
|
readonly orderTypeList: string;
|
|
3435
4031
|
};
|
|
3436
4032
|
|
|
3437
|
-
declare const
|
|
3438
|
-
readonly
|
|
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 →
|
|
4033
|
+
declare const userViewsSdkMethodFieldDocEntries: {
|
|
4034
|
+
readonly listForParent: {
|
|
4035
|
+
readonly description: "`client.views.user.listForParent`: `GET /api/v1/{domain}/{parentId}/views/user`. Список пользовательских представлений дочерних элементов под родителем (mind map). Query: `tags`, `take`, `skip`, `lmFrom`, `lmTo`, `includeDeleted`, `sort`. Ответ: массив `*View` по домену (`ContactView`, `NoteView`, …).";
|
|
4036
|
+
readonly valueSchema: "TorrowItemType + ViewListQuery → TorrowItemViewByTypeMap[itemType][]";
|
|
3441
4037
|
};
|
|
3442
|
-
readonly
|
|
3443
|
-
readonly description: "`POST /api/v1/{domain}/{parentId}/views/user`.
|
|
3444
|
-
readonly valueSchema: "
|
|
4038
|
+
readonly create: {
|
|
4039
|
+
readonly description: "`client.views.user.create(parentId, childIds)`: `POST /api/v1/{domain}/{parentId}/views/user`. Прямое создание User view под parent; не объявляй его автоматически эквивалентным доменному `client.relations.saveToMindMap`. Domain выводится из непустого однотипного `childIds`; SDK формирует wire-body `{ childIdList }`. Ответ: массив **`ViewInfo`**.";
|
|
4040
|
+
readonly valueSchema: "parentId + readonly string[] → ViewInfo[]";
|
|
3445
4041
|
};
|
|
3446
|
-
readonly
|
|
3447
|
-
readonly description: "`GET /api/v1/{domain}/views/user`. Все пользовательские представления по типу элемента без фильтра по одному `parentId`. Query: `take`, `skip`, `lmFrom`, `lmTo`, `includeDeleted`, `sort`.";
|
|
3448
|
-
readonly valueSchema: "ViewListRootQuery →
|
|
4042
|
+
readonly listAll: {
|
|
4043
|
+
readonly description: "`client.views.user.listAll`: `GET /api/v1/{domain}/views/user`. Все пользовательские представления по типу элемента без фильтра по одному `parentId`. Query: `take`, `skip`, `lmFrom`, `lmTo`, `includeDeleted`, `sort`.";
|
|
4044
|
+
readonly valueSchema: "TorrowItemType + ViewListRootQuery → TorrowItemViewByTypeMap[itemType][]";
|
|
3449
4045
|
};
|
|
3450
|
-
readonly
|
|
3451
|
-
readonly description: "`GET /api/v1/{domain}/{parentId}/views/user/{childId}`.
|
|
3452
|
-
readonly valueSchema: "→
|
|
4046
|
+
readonly get: {
|
|
4047
|
+
readonly description: "`client.views.user.get`: `GET /api/v1/{domain}/{parentId}/views/user/{childId}`. Domain выводится из `childId`; возвращается общее объединение `TorrowItemView`.";
|
|
4048
|
+
readonly valueSchema: "childId → TorrowItemView";
|
|
3453
4049
|
};
|
|
3454
|
-
readonly
|
|
3455
|
-
readonly description: "`DELETE /api/v1/{domain}/{parentId}/views/user/{childId}`.
|
|
3456
|
-
readonly valueSchema: "→
|
|
4050
|
+
readonly delete: {
|
|
4051
|
+
readonly description: "`client.views.user.delete`: `DELETE /api/v1/{domain}/{parentId}/views/user/{childId}`. Domain выводится из `childId`. Ответ: **`deleteCount`** (`DeleteResponse.deleteCount`).";
|
|
4052
|
+
readonly valueSchema: "→ number (deleteCount)";
|
|
3457
4053
|
};
|
|
3458
|
-
readonly
|
|
3459
|
-
readonly description: "`POST /
|
|
3460
|
-
readonly valueSchema: "
|
|
4054
|
+
readonly updateOrder: {
|
|
4055
|
+
readonly description: "`client.views.user.updateOrder(parentId, orderedViews)`: `POST .../views/user/updateorder`. Domain выводится из `orderedViews[].childId`; SDK формирует wire-body `{ orderedViewList }`. Ответ: **`ViewInfo[]`**.";
|
|
4056
|
+
readonly valueSchema: "parentId + readonly ViewOrderInput[] → ViewInfo[]";
|
|
3461
4057
|
};
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
|
-
|
|
4058
|
+
};
|
|
4059
|
+
declare const pinnedViewsSdkMethodFieldDocEntries: {
|
|
4060
|
+
readonly listForParent: {
|
|
4061
|
+
readonly description: "`client.views.pinned.listForParent`: `GET /api/v1/{domain}/{parentId}/views/pinned`. Список закреплённых; query как у `client.views.user.listForParent`.";
|
|
4062
|
+
readonly valueSchema: "TorrowItemType + ViewListQuery → TorrowItemViewByTypeMap[itemType][]";
|
|
3465
4063
|
};
|
|
3466
|
-
readonly
|
|
3467
|
-
readonly description: "`
|
|
3468
|
-
readonly valueSchema: "→
|
|
4064
|
+
readonly create: {
|
|
4065
|
+
readonly description: "`client.views.pinned.create(parentId, childIds)`: `POST /api/v1/{domain}/{parentId}/views/pinned`. Прямое создание Pinned view под parent; не объявляй его автоматически эквивалентным доменному `client.relations.includeToParent`. Domain выводится из непустого однотипного `childIds`; SDK формирует wire-body `{ childIdList }`. Ответ: **`ViewInfo[]`**.";
|
|
4066
|
+
readonly valueSchema: "parentId + readonly string[] → ViewInfo[]";
|
|
3469
4067
|
};
|
|
3470
|
-
readonly
|
|
3471
|
-
readonly description: "`GET .../views/pinned/{childId}`.";
|
|
3472
|
-
readonly valueSchema: "→
|
|
4068
|
+
readonly get: {
|
|
4069
|
+
readonly description: "`client.views.pinned.get`: `GET .../views/pinned/{childId}`. Domain выводится из `childId`; возвращается общее объединение `TorrowItemView`.";
|
|
4070
|
+
readonly valueSchema: "childId → TorrowItemView";
|
|
3473
4071
|
};
|
|
3474
|
-
readonly
|
|
3475
|
-
readonly description: "`
|
|
3476
|
-
readonly valueSchema: "
|
|
4072
|
+
readonly delete: {
|
|
4073
|
+
readonly description: "`client.views.pinned.delete`: `DELETE .../views/pinned/{childId}`. Domain выводится из `childId`. Ответ: **`deleteCount`**.";
|
|
4074
|
+
readonly valueSchema: "→ number (deleteCount)";
|
|
3477
4075
|
};
|
|
3478
|
-
readonly
|
|
3479
|
-
readonly description: "`POST .../views/
|
|
3480
|
-
readonly valueSchema: "
|
|
4076
|
+
readonly updateOrder: {
|
|
4077
|
+
readonly description: "`client.views.pinned.updateOrder(parentId, orderedViews)`: `POST .../views/pinned/updateorder`. Domain выводится из `orderedViews[].childId`; SDK формирует wire-body `{ orderedViewList }`. Ответ: **`ViewInfo[]`**.";
|
|
4078
|
+
readonly valueSchema: "parentId + readonly ViewOrderInput[] → ViewInfo[]";
|
|
3481
4079
|
};
|
|
3482
|
-
|
|
3483
|
-
|
|
4080
|
+
};
|
|
4081
|
+
declare const viewsSdkMethodFieldDocEntries: {
|
|
4082
|
+
readonly pin: {
|
|
4083
|
+
readonly description: "`client.views.pin`: `POST .../views/user/{childId}/pin`. Query `alias`. Ответ: `ObjectInfo`. Конвертация **User → Pinned** (`LinkType`).";
|
|
3484
4084
|
readonly valueSchema: "query alias → ObjectInfo";
|
|
4085
|
+
readonly usage: "Domain SDK выводит из `childId`. Это переход User → Pinned, а не первоначальное создание связи. Для доменного создания используй `client.relations.saveToMindMap` / `includeToParent`; для списков и порядка — `client.views.*`. Связи: `docs/agents/relations-flow.md`.";
|
|
3485
4086
|
};
|
|
3486
|
-
readonly
|
|
3487
|
-
readonly description: "`POST .../unpin`. Для домена **`contacts`** путь: `.../views/pinned/{childId}/unpin`; для остальных (`notes`, `contexts`, `resources`, `services`, `cases`, `calendars`): `.../views/user/{childId}/unpin`. Query `alias`. Ответ: `ObjectInfo`.";
|
|
4087
|
+
readonly unpin: {
|
|
4088
|
+
readonly description: "`client.views.unpin`: `POST .../unpin`. Для домена **`contacts`** путь: `.../views/pinned/{childId}/unpin`; для остальных (`notes`, `contexts`, `resources`, `services`, `cases`, `calendars`): `.../views/user/{childId}/unpin`. Query `alias`. Ответ: `ObjectInfo`. **Pinned → User**.";
|
|
3488
4089
|
readonly valueSchema: "query alias → ObjectInfo";
|
|
3489
|
-
readonly usage: "
|
|
4090
|
+
readonly usage: "Domain SDK выводит из `childId`; затем выбирает сегмент `user` или `pinned`. Это переход Pinned → User, не замена `relations.exclude*`; не дублируется на `RelationsFacade`.";
|
|
3490
4091
|
};
|
|
3491
4092
|
};
|
|
3492
4093
|
declare const createViewListReqFieldDocEntries: {
|
|
3493
4094
|
readonly childIdList: {
|
|
3494
|
-
readonly description: "Список id дочерних элементов, для которых создаются представления под выбранным родителем.";
|
|
4095
|
+
readonly description: "Список id дочерних элементов, для которых создаются представления под выбранным родителем. В SDK facade список должен быть непустым и однотипным, поскольку определяет REST domain.";
|
|
3495
4096
|
readonly valueSchema: "string[] | null";
|
|
3496
4097
|
readonly examples: readonly ["[\"550e8400-e29b-41d4-a716-446655440000\"]"];
|
|
3497
4098
|
};
|
|
@@ -3535,29 +4136,29 @@ declare const updateViewListOrderRespFieldDocEntries: {
|
|
|
3535
4136
|
};
|
|
3536
4137
|
};
|
|
3537
4138
|
declare const deleteResponseFieldDocEntries: {
|
|
3538
|
-
readonly
|
|
3539
|
-
readonly description: "
|
|
3540
|
-
readonly valueSchema: "boolean";
|
|
3541
|
-
};
|
|
3542
|
-
readonly deletedCount: {
|
|
3543
|
-
readonly description: "Количество удалённых записей (обычно 1).";
|
|
4139
|
+
readonly deleteCount: {
|
|
4140
|
+
readonly description: "Количество удалённых записей. Для view-операций обычно 0 или 1; для `client.*.delete` — 1 при удалении только элемента, больше при `cascade: true` и/или `withPinnedItems: true` (см. **`ItemDeleteQuery`**).";
|
|
3544
4141
|
readonly valueSchema: "int32";
|
|
3545
4142
|
};
|
|
3546
4143
|
};
|
|
3547
4144
|
declare const viewsSdkMethodFieldDocs: {
|
|
3548
|
-
readonly
|
|
3549
|
-
readonly
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
readonly
|
|
3553
|
-
readonly
|
|
3554
|
-
readonly
|
|
3555
|
-
readonly
|
|
3556
|
-
readonly
|
|
3557
|
-
readonly
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
readonly
|
|
4145
|
+
readonly pin: string;
|
|
4146
|
+
readonly unpin: string;
|
|
4147
|
+
};
|
|
4148
|
+
declare const userViewsSdkMethodFieldDocs: {
|
|
4149
|
+
readonly listForParent: string;
|
|
4150
|
+
readonly create: string;
|
|
4151
|
+
readonly listAll: string;
|
|
4152
|
+
readonly get: string;
|
|
4153
|
+
readonly delete: string;
|
|
4154
|
+
readonly updateOrder: string;
|
|
4155
|
+
};
|
|
4156
|
+
declare const pinnedViewsSdkMethodFieldDocs: {
|
|
4157
|
+
readonly listForParent: string;
|
|
4158
|
+
readonly create: string;
|
|
4159
|
+
readonly get: string;
|
|
4160
|
+
readonly delete: string;
|
|
4161
|
+
readonly updateOrder: string;
|
|
3561
4162
|
};
|
|
3562
4163
|
declare const createViewListRespFieldDocs: {
|
|
3563
4164
|
readonly createdViewInfoList: string;
|
|
@@ -3566,8 +4167,7 @@ declare const updateViewListOrderRespFieldDocs: {
|
|
|
3566
4167
|
readonly updatedViewInfoList: string;
|
|
3567
4168
|
};
|
|
3568
4169
|
declare const deleteResponseFieldDocs: {
|
|
3569
|
-
readonly
|
|
3570
|
-
readonly deletedCount: string;
|
|
4170
|
+
readonly deleteCount: string;
|
|
3571
4171
|
};
|
|
3572
4172
|
|
|
3573
4173
|
declare const actionHistoryTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
@@ -3618,6 +4218,18 @@ declare const accountTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
|
3618
4218
|
declare const accountTypeFieldDocs: {
|
|
3619
4219
|
[x: string]: string;
|
|
3620
4220
|
};
|
|
4221
|
+
declare const advisedItemTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4222
|
+
declare const advisedItemTypeFieldDocs: {
|
|
4223
|
+
[x: string]: string;
|
|
4224
|
+
};
|
|
4225
|
+
declare const verificationMethodFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4226
|
+
declare const verificationMethodFieldDocs: {
|
|
4227
|
+
[x: string]: string;
|
|
4228
|
+
};
|
|
4229
|
+
declare const tokenStatusFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4230
|
+
declare const tokenStatusFieldDocs: {
|
|
4231
|
+
[x: string]: string;
|
|
4232
|
+
};
|
|
3621
4233
|
declare const communicationTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3622
4234
|
declare const communicationTypeFieldDocs: {
|
|
3623
4235
|
[x: string]: string;
|
|
@@ -3694,6 +4306,10 @@ declare const noteTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
|
3694
4306
|
declare const noteTypeFieldDocs: {
|
|
3695
4307
|
[x: string]: string;
|
|
3696
4308
|
};
|
|
4309
|
+
declare const linkTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4310
|
+
declare const linkTypeFieldDocs: {
|
|
4311
|
+
[x: string]: string;
|
|
4312
|
+
};
|
|
3697
4313
|
declare const participationFieldRequirementTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
3698
4314
|
declare const participationFieldRequirementTypeFieldDocs: {
|
|
3699
4315
|
[x: string]: string;
|
|
@@ -3730,17 +4346,53 @@ declare const ticketStateFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
|
3730
4346
|
declare const ticketStateFieldDocs: {
|
|
3731
4347
|
[x: string]: string;
|
|
3732
4348
|
};
|
|
4349
|
+
declare const ticketPaymentConfirmationSourceFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4350
|
+
declare const ticketPaymentConfirmationSourceFieldDocs: {
|
|
4351
|
+
[x: string]: string;
|
|
4352
|
+
};
|
|
4353
|
+
declare const sessionDurationTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4354
|
+
declare const sessionDurationTypeFieldDocs: {
|
|
4355
|
+
[x: string]: string;
|
|
4356
|
+
};
|
|
4357
|
+
declare const timeSelectionTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4358
|
+
declare const timeSelectionTypeFieldDocs: {
|
|
4359
|
+
[x: string]: string;
|
|
4360
|
+
};
|
|
4361
|
+
declare const stateManagementTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4362
|
+
declare const stateManagementTypeFieldDocs: {
|
|
4363
|
+
[x: string]: string;
|
|
4364
|
+
};
|
|
4365
|
+
declare const sessionPrecisionTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4366
|
+
declare const sessionPrecisionTypeFieldDocs: {
|
|
4367
|
+
[x: string]: string;
|
|
4368
|
+
};
|
|
4369
|
+
declare const userAccessLevelFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4370
|
+
declare const userAccessLevelFieldDocs: {
|
|
4371
|
+
[x: string]: string;
|
|
4372
|
+
};
|
|
4373
|
+
declare const loyaltyCardIssueTypeFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4374
|
+
declare const loyaltyCardIssueTypeFieldDocs: {
|
|
4375
|
+
[x: string]: string;
|
|
4376
|
+
};
|
|
4377
|
+
declare const loyaltyCardUpdateKeyInformationFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4378
|
+
declare const loyaltyCardUpdateKeyInformationFieldDocs: {
|
|
4379
|
+
[x: string]: string;
|
|
4380
|
+
};
|
|
4381
|
+
declare const loyaltyCardUpdateNonKeyInformationFieldDocEntries: Record<string, ItemFieldDoc>;
|
|
4382
|
+
declare const loyaltyCardUpdateNonKeyInformationFieldDocs: {
|
|
4383
|
+
[x: string]: string;
|
|
4384
|
+
};
|
|
3733
4385
|
|
|
3734
4386
|
/** Ответ **`POST /api/v1/auth/token`** и **`POST /api/v1/auth/refresh`**. */
|
|
3735
4387
|
declare const tokenRespFieldDocEntries: {
|
|
3736
4388
|
readonly accessToken: {
|
|
3737
4389
|
readonly description: "JWT или иной Bearer для заголовка `Authorization` при вызовах API от имени пользователя.";
|
|
3738
|
-
readonly usage: "Подставляй в `TorrowClientConfig.getAccessToken` (или вручную в `Authorization`). Не логируй целиком.";
|
|
4390
|
+
readonly usage: "Подставляй в `TorrowClientConfig.getAccessToken` (или вручную в `Authorization`). Не логируй целиком. При `status !== TokenReady` может быть пустым.";
|
|
3739
4391
|
readonly examples: readonly ["eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…"];
|
|
3740
4392
|
};
|
|
3741
4393
|
readonly refreshToken: {
|
|
3742
4394
|
readonly description: "Долгоживущий токен для выдачи новой пары без повторного логина.";
|
|
3743
|
-
readonly usage: "Храни безопасно; отправляй только в теле `POST /api/v1/auth/refresh`. После refresh сервер может вернуть новый refresh — замени сохранённый.";
|
|
4395
|
+
readonly usage: "Храни безопасно; отправляй только в теле `POST /api/v1/auth/refresh`. После refresh сервер может вернуть новый refresh — замени сохранённый. При `Pending`/`Failed` обычно пуст.";
|
|
3744
4396
|
readonly examples: readonly ["opaque-refresh-string…"];
|
|
3745
4397
|
};
|
|
3746
4398
|
readonly expiration: {
|
|
@@ -3748,21 +4400,27 @@ declare const tokenRespFieldDocEntries: {
|
|
|
3748
4400
|
readonly usage: "Абсолютное время истечения access: `Date.now() + expiration * 1000`. Учитывай запас (skew) до истечения, затем вызывай refresh.";
|
|
3749
4401
|
readonly examples: readonly ["3600", "900"];
|
|
3750
4402
|
};
|
|
4403
|
+
readonly status: {
|
|
4404
|
+
readonly description: "Статус выдачи токенов (`TokenStatus`). Классический OTP/`refresh` → `TokenReady`; для MTS Mobile ID возможны `Pending`, `AwaitingSmsCode`, `Failed` с пустыми токенами.";
|
|
4405
|
+
readonly usage: "Пока `Pending` — полли `requestToken` с интервалом из `SendCodeResp.pollIntervalSeconds` (без кода или с уже принятым). `AwaitingSmsCode` — fallback на ввод SMS. `Failed` — новый `sendCode`.";
|
|
4406
|
+
readonly valueSchema: "TokenStatus";
|
|
4407
|
+
};
|
|
3751
4408
|
};
|
|
3752
4409
|
declare const tokenRespFieldDocs: {
|
|
3753
4410
|
readonly accessToken: string;
|
|
3754
4411
|
readonly refreshToken: string;
|
|
3755
4412
|
readonly expiration: string;
|
|
4413
|
+
readonly status: string;
|
|
3756
4414
|
};
|
|
3757
4415
|
/** Тело **`POST /api/v1/auth/refresh`**. */
|
|
3758
4416
|
declare const refreshReqFieldDocEntries: {
|
|
3759
4417
|
readonly refreshToken: {
|
|
3760
4418
|
readonly description: "Текущий refresh-токен пользователя.";
|
|
3761
|
-
readonly usage: "Обязателен для
|
|
4419
|
+
readonly usage: "Обязателен для обмена. Вызов идёт через `AuthFacade` без Bearer пользователя; на шлюзе обычно нужен `authIdentityBasic` (см. `examples/node/auth/auth-refresh.ts`).";
|
|
3762
4420
|
};
|
|
3763
4421
|
readonly deviceInfo: {
|
|
3764
4422
|
readonly description: "Сведения об устройстве клиента (`DeviceInfo` в OpenAPI).";
|
|
3765
|
-
readonly usage: "
|
|
4423
|
+
readonly usage: "Минимум: непустые `deviceId` + `deviceType` (`DeviceTypeValues` из `@torrow/sdk-client`: Unknown|Mobile|Tablet|Desktop). На проде — ещё push/os.";
|
|
3766
4424
|
readonly valueSchema: "DeviceInfo";
|
|
3767
4425
|
};
|
|
3768
4426
|
};
|
|
@@ -3778,14 +4436,16 @@ declare const tokenReqFieldDocEntries: {
|
|
|
3778
4436
|
};
|
|
3779
4437
|
readonly code: {
|
|
3780
4438
|
readonly description: "Одноразовый код подтверждения (SMS, email и т.п.), если применимо.";
|
|
3781
|
-
readonly usage: "Вместе с `sessionId`
|
|
4439
|
+
readonly usage: "Вместе с `sessionId` для классического OTP. Для MTS Mobile ID на фазе polling код может отсутствовать, пока `TokenResp.status === Pending`.";
|
|
3782
4440
|
};
|
|
3783
4441
|
readonly scopes: {
|
|
3784
|
-
readonly description: "Запрашиваемые области
|
|
3785
|
-
readonly
|
|
4442
|
+
readonly description: "Запрашиваемые области доступа. OpenAPI — `string[]`; в SDK известные значения — **`AuthScopeValues`**: `user_api`, `admin_api`, `offline_access` (дефолт OTP — **`DefaultAuthScopes`**).";
|
|
4443
|
+
readonly valueSchema: "AuthScope[] | null";
|
|
4444
|
+
readonly examples: readonly ["[\"user_api\",\"offline_access\"]"];
|
|
3786
4445
|
};
|
|
3787
4446
|
readonly deviceInfo: {
|
|
3788
4447
|
readonly description: "Сведения об устройстве (`DeviceInfo`).";
|
|
4448
|
+
readonly usage: "`deviceType` — только OpenAPI enum; в SDK: **`DeviceTypeValues`** (`Desktop` по умолчанию в примерах).";
|
|
3789
4449
|
readonly valueSchema: "DeviceInfo";
|
|
3790
4450
|
};
|
|
3791
4451
|
readonly splitTokens: {
|
|
@@ -3816,29 +4476,51 @@ declare const sendCodeReqFieldDocEntries: {
|
|
|
3816
4476
|
readonly description: "Телефон/email/логин, куда отправляют код.";
|
|
3817
4477
|
readonly valueSchema: "string | null";
|
|
3818
4478
|
};
|
|
3819
|
-
readonly
|
|
3820
|
-
readonly description: "Тип аккаунта (`
|
|
4479
|
+
readonly type: {
|
|
4480
|
+
readonly description: "Тип аккаунта (`AccountType`). Для OTP/`sendCode` в продукте и примерах — **`Phone`** или **`Email`**. **`Undefined`** Identity отвергает; **`Telegram`** — не этот эндпоинт (deep-link → `createSession`).";
|
|
3821
4481
|
readonly valueSchema: "AccountType";
|
|
4482
|
+
readonly usage: "Примеры: `auth-send-code.ts` / `auth-login-with-otp.ts` (`SendCodeAccountType` = Phone|Email).";
|
|
3822
4483
|
};
|
|
3823
4484
|
readonly language: {
|
|
3824
4485
|
readonly description: "Язык сообщений/кода.";
|
|
3825
4486
|
readonly valueSchema: "string | null";
|
|
3826
4487
|
};
|
|
3827
|
-
readonly
|
|
3828
|
-
readonly description: "
|
|
4488
|
+
readonly captcha: {
|
|
4489
|
+
readonly description: "Токен captcha, если включена антибот-проверка.";
|
|
3829
4490
|
readonly valueSchema: "string | null";
|
|
3830
4491
|
};
|
|
3831
|
-
readonly
|
|
3832
|
-
readonly description: "
|
|
4492
|
+
readonly captchaType: {
|
|
4493
|
+
readonly description: "Провайдер captcha, выдавший токен. OpenAPI — `string`; в SDK известные значения — **`AuthCaptchaTypeValues`**: `YandexSmartCaptcha`, `GoogleRecaptcha` (v2 invisible).";
|
|
4494
|
+
readonly valueSchema: "AuthCaptchaType | null";
|
|
4495
|
+
readonly examples: readonly ["YandexSmartCaptcha", "GoogleRecaptcha"];
|
|
4496
|
+
};
|
|
4497
|
+
readonly inviteSessionId: {
|
|
4498
|
+
readonly description: "ID invite-сессии (вход по приглашению).";
|
|
3833
4499
|
readonly valueSchema: "string | null";
|
|
3834
4500
|
};
|
|
4501
|
+
readonly regionStorageId: {
|
|
4502
|
+
readonly description: "Региональный storage ID (если используется backend identity).";
|
|
4503
|
+
readonly valueSchema: "int32 | null";
|
|
4504
|
+
};
|
|
4505
|
+
readonly preferredMethod: {
|
|
4506
|
+
readonly description: "Желаемый способ доставки (`VerificationMethod`). `UnknownMethod` (дефолт) — выбор сервера; иначе — если доступен, иначе fallback по приоритету.";
|
|
4507
|
+
readonly valueSchema: "VerificationMethod";
|
|
4508
|
+
};
|
|
4509
|
+
readonly supportedMethods: {
|
|
4510
|
+
readonly description: "Capability negotiation: методы, которые этот билд клиента умеет вести. Out-of-band вроде `MtsMobileId` выбираются только если перечислены здесь — старые клиенты без списка остаются на классическом вводе кода.";
|
|
4511
|
+
readonly valueSchema: "VerificationMethod[] | null";
|
|
4512
|
+
};
|
|
3835
4513
|
};
|
|
3836
4514
|
declare const sendCodeReqFieldDocs: {
|
|
3837
4515
|
readonly accountName: string;
|
|
3838
|
-
readonly
|
|
4516
|
+
readonly type: string;
|
|
3839
4517
|
readonly language: string;
|
|
4518
|
+
readonly captcha: string;
|
|
4519
|
+
readonly captchaType: string;
|
|
4520
|
+
readonly inviteSessionId: string;
|
|
3840
4521
|
readonly regionStorageId: string;
|
|
3841
|
-
readonly
|
|
4522
|
+
readonly preferredMethod: string;
|
|
4523
|
+
readonly supportedMethods: string;
|
|
3842
4524
|
};
|
|
3843
4525
|
/** Ответ `POST /api/v1/auth/sendcode`. */
|
|
3844
4526
|
declare const sendCodeRespFieldDocEntries: {
|
|
@@ -3846,54 +4528,86 @@ declare const sendCodeRespFieldDocEntries: {
|
|
|
3846
4528
|
readonly description: "ID auth-сессии для следующего шага (`requestToken`).";
|
|
3847
4529
|
readonly valueSchema: "string | null";
|
|
3848
4530
|
};
|
|
3849
|
-
readonly
|
|
3850
|
-
readonly description: "TTL
|
|
4531
|
+
readonly codeLifetimeSeconds: {
|
|
4532
|
+
readonly description: "TTL кода в секундах (**deprecated** в OpenAPI — предпочитай `sessionLifeTimeInSeconds` / `codeLength`).";
|
|
4533
|
+
readonly valueSchema: "int32";
|
|
4534
|
+
};
|
|
4535
|
+
readonly sessionLifeTimeInSeconds: {
|
|
4536
|
+
readonly description: "TTL auth-сессии в секундах.";
|
|
4537
|
+
readonly valueSchema: "int32";
|
|
4538
|
+
};
|
|
4539
|
+
readonly nextAvailableUsageTime: {
|
|
4540
|
+
readonly description: "Когда можно снова запросить код (rate limit), если сервер вернул.";
|
|
4541
|
+
readonly valueSchema: "Date | null";
|
|
4542
|
+
};
|
|
4543
|
+
readonly attemptCountToUseSession: {
|
|
4544
|
+
readonly description: "Сколько попыток ввода кода осталось/доступно для сессии (семантика стенда).";
|
|
4545
|
+
readonly valueSchema: "int32";
|
|
4546
|
+
};
|
|
4547
|
+
readonly usedMethod: {
|
|
4548
|
+
readonly description: "Фактически выбранный сервером способ доставки/подтверждения.";
|
|
4549
|
+
readonly usage: "UI: подпись «код в SMS» / Telegram / flash-call; при `MtsMobileId` — polling `requestToken` по `status`.";
|
|
4550
|
+
readonly valueSchema: "VerificationMethod";
|
|
4551
|
+
};
|
|
4552
|
+
readonly availableMethods: {
|
|
4553
|
+
readonly description: "Методы, которые клиент может запросить для этого аккаунта (UX «другой способ»).";
|
|
4554
|
+
readonly valueSchema: "VerificationMethod[] | null";
|
|
4555
|
+
};
|
|
4556
|
+
readonly codeLength: {
|
|
4557
|
+
readonly description: "Длина доставленного кода — размер поля ввода в UI.";
|
|
4558
|
+
readonly valueSchema: "int32";
|
|
4559
|
+
};
|
|
4560
|
+
readonly pollIntervalSeconds: {
|
|
4561
|
+
readonly description: "Для `usedMethod === MtsMobileId`: рекомендуемый интервал (сек) между повторными `requestToken` пока `TokenResp.status === Pending`.";
|
|
3851
4562
|
readonly valueSchema: "int32";
|
|
3852
4563
|
};
|
|
3853
4564
|
};
|
|
3854
4565
|
declare const sendCodeRespFieldDocs: {
|
|
3855
4566
|
readonly sessionId: string;
|
|
3856
|
-
readonly
|
|
4567
|
+
readonly codeLifetimeSeconds: string;
|
|
4568
|
+
readonly sessionLifeTimeInSeconds: string;
|
|
4569
|
+
readonly nextAvailableUsageTime: string;
|
|
4570
|
+
readonly attemptCountToUseSession: string;
|
|
4571
|
+
readonly usedMethod: string;
|
|
4572
|
+
readonly availableMethods: string;
|
|
4573
|
+
readonly codeLength: string;
|
|
4574
|
+
readonly pollIntervalSeconds: string;
|
|
3857
4575
|
};
|
|
3858
4576
|
/** Тело `POST /api/v1/auth/session`. */
|
|
3859
4577
|
declare const createAuthSessionReqFieldDocEntries: {
|
|
3860
4578
|
readonly accountType: {
|
|
3861
|
-
readonly description: "Тип аккаунта для
|
|
4579
|
+
readonly description: "Тип аккаунта для auth-сессии с **`authUrl`**. На шлюзе в `AuthUrlsByAccountType` обычно только **`Telegram`**; `Phone`/`Email` → часто 500.";
|
|
3862
4580
|
readonly valueSchema: "AccountType";
|
|
3863
|
-
|
|
3864
|
-
readonly language: {
|
|
3865
|
-
readonly description: "Язык интерфейса/сообщений сессии.";
|
|
3866
|
-
readonly valueSchema: "string | null";
|
|
4581
|
+
readonly usage: "Пример: `auth-login-with-link.ts` (env `TORROW_AUTH_CREATE_SESSION_ACCOUNT_TYPE`, дефолт Telegram).";
|
|
3867
4582
|
};
|
|
3868
4583
|
readonly regionStorageId: {
|
|
3869
|
-
readonly description: "Регион storage для identity.";
|
|
3870
|
-
readonly valueSchema: "
|
|
4584
|
+
readonly description: "Регион storage для identity (обязателен в OpenAPI).";
|
|
4585
|
+
readonly valueSchema: "int32";
|
|
4586
|
+
};
|
|
4587
|
+
readonly language: {
|
|
4588
|
+
readonly description: "Язык интерфейса/сообщений сессии (обязателен в OpenAPI).";
|
|
4589
|
+
readonly valueSchema: "string";
|
|
3871
4590
|
};
|
|
3872
4591
|
readonly inviteSessionId: {
|
|
3873
4592
|
readonly description: "ID invite-сессии (если вход по приглашению).";
|
|
3874
4593
|
readonly valueSchema: "string | null";
|
|
3875
4594
|
};
|
|
3876
|
-
readonly
|
|
4595
|
+
readonly captcha: {
|
|
3877
4596
|
readonly description: "Captcha token для защиты от ботов.";
|
|
3878
4597
|
readonly valueSchema: "string | null";
|
|
3879
4598
|
};
|
|
3880
|
-
readonly
|
|
3881
|
-
readonly description: "
|
|
3882
|
-
readonly valueSchema: "string
|
|
3883
|
-
};
|
|
3884
|
-
readonly deviceInfo: {
|
|
3885
|
-
readonly description: "Информация об устройстве.";
|
|
3886
|
-
readonly valueSchema: "DeviceInfo";
|
|
4599
|
+
readonly deviceId: {
|
|
4600
|
+
readonly description: "Идентификатор устройства клиента.";
|
|
4601
|
+
readonly valueSchema: "string | null";
|
|
3887
4602
|
};
|
|
3888
4603
|
};
|
|
3889
4604
|
declare const createAuthSessionReqFieldDocs: {
|
|
3890
4605
|
readonly accountType: string;
|
|
3891
|
-
readonly language: string;
|
|
3892
4606
|
readonly regionStorageId: string;
|
|
4607
|
+
readonly language: string;
|
|
3893
4608
|
readonly inviteSessionId: string;
|
|
3894
|
-
readonly
|
|
3895
|
-
readonly
|
|
3896
|
-
readonly deviceInfo: string;
|
|
4609
|
+
readonly captcha: string;
|
|
4610
|
+
readonly deviceId: string;
|
|
3897
4611
|
};
|
|
3898
4612
|
/** Ответ `POST /api/v1/auth/session`. */
|
|
3899
4613
|
declare const createAuthSessionRespFieldDocEntries: {
|
|
@@ -3901,19 +4615,34 @@ declare const createAuthSessionRespFieldDocEntries: {
|
|
|
3901
4615
|
readonly description: "ID созданной auth-сессии.";
|
|
3902
4616
|
readonly valueSchema: "string | null";
|
|
3903
4617
|
};
|
|
3904
|
-
readonly
|
|
3905
|
-
readonly description: "Срок жизни
|
|
4618
|
+
readonly sessionLifeTimeInSeconds: {
|
|
4619
|
+
readonly description: "Срок жизни сессии в секундах.";
|
|
4620
|
+
readonly valueSchema: "int32";
|
|
4621
|
+
};
|
|
4622
|
+
readonly nextAvailableUsageTime: {
|
|
4623
|
+
readonly description: "Когда сессию/код можно использовать снова (rate limit), если задано.";
|
|
4624
|
+
readonly valueSchema: "Date | null";
|
|
4625
|
+
};
|
|
4626
|
+
readonly attemptCountToUseSession: {
|
|
4627
|
+
readonly description: "Счётчик попыток использования сессии.";
|
|
3906
4628
|
readonly valueSchema: "int32";
|
|
3907
4629
|
};
|
|
3908
|
-
readonly
|
|
3909
|
-
readonly description: "
|
|
3910
|
-
readonly valueSchema: "
|
|
4630
|
+
readonly code: {
|
|
4631
|
+
readonly description: "Код/секрет сессии, если сервер вернул сразу (редко; зависит от потока).";
|
|
4632
|
+
readonly valueSchema: "string | null";
|
|
4633
|
+
};
|
|
4634
|
+
readonly authUrl: {
|
|
4635
|
+
readonly description: "URL внешнего шага аутентификации (deep link / redirect), если применимо.";
|
|
4636
|
+
readonly valueSchema: "string | null";
|
|
3911
4637
|
};
|
|
3912
4638
|
};
|
|
3913
4639
|
declare const createAuthSessionRespFieldDocs: {
|
|
3914
4640
|
readonly sessionId: string;
|
|
3915
|
-
readonly
|
|
3916
|
-
readonly
|
|
4641
|
+
readonly sessionLifeTimeInSeconds: string;
|
|
4642
|
+
readonly nextAvailableUsageTime: string;
|
|
4643
|
+
readonly attemptCountToUseSession: string;
|
|
4644
|
+
readonly code: string;
|
|
4645
|
+
readonly authUrl: string;
|
|
3917
4646
|
};
|
|
3918
4647
|
/**
|
|
3919
4648
|
* Поверхность SDK, связанная с Bearer и гостевым доступом (не схема OpenAPI, а конфиг клиента).
|
|
@@ -3921,39 +4650,39 @@ declare const createAuthSessionRespFieldDocs: {
|
|
|
3921
4650
|
declare const torrowClientAuthConfigFieldDocEntries: {
|
|
3922
4651
|
readonly getAccessToken: {
|
|
3923
4652
|
readonly description: "Асинхронный колбэк: возвращает строку Bearer или `undefined` (тогда заголовок `Authorization` не ставится).";
|
|
3924
|
-
readonly usage: "
|
|
4653
|
+
readonly usage: "Предпочтительно **`@torrow/sdk-auth`** (`TokenSession` → `session.client`, storage + проактивный refresh + опциональный 401→retry). Вручную: кэш access + **`client.auth.refresh`** (без Bearer этого колбэка) — иначе рекурсия. Гостевой **`securityToken`** — только в опциях конкретного вызова фасада, не в конфиге клиента.";
|
|
3925
4654
|
};
|
|
3926
|
-
readonly
|
|
3927
|
-
readonly description: "
|
|
3928
|
-
readonly usage: "
|
|
3929
|
-
readonly
|
|
4655
|
+
readonly authIdentityBasic: {
|
|
4656
|
+
readonly description: "HTTP Basic приложения на шлюзе (`AuthIdentityBasic`: `username`/`password` ≈ `clientId`/`clientSecret`). Не user Bearer.";
|
|
4657
|
+
readonly usage: "Нужен для **`client.auth.*`** на `torrow.net`. С сессией — **`TorrowAuth`** + **`appCredentials`** (маппинг внутри auth-пакета). Low-level: **`auth-send-code.ts`**.";
|
|
4658
|
+
readonly valueSchema: "AuthIdentityBasic";
|
|
3930
4659
|
};
|
|
3931
4660
|
};
|
|
3932
4661
|
declare const torrowClientAuthConfigFieldDocs: {
|
|
3933
4662
|
readonly getAccessToken: string;
|
|
3934
|
-
readonly
|
|
4663
|
+
readonly authIdentityBasic: string;
|
|
3935
4664
|
};
|
|
3936
4665
|
/** Методы **`TorrowClient.auth`** ↔ REST AuthIdentity. */
|
|
3937
4666
|
declare const authSdkMethodFieldDocEntries: {
|
|
3938
4667
|
readonly refresh: {
|
|
3939
4668
|
readonly description: "`POST /api/v1/auth/refresh` — тело `RefreshReq`, ответ `TokenResp`.";
|
|
3940
|
-
readonly usage: "Безопасно вызывать с того же экземпляра `TorrowClient`, у которого задан `getAccessToken`: внутренний вызов не использует Bearer.";
|
|
4669
|
+
readonly usage: "Безопасно вызывать с того же экземпляра `TorrowClient`, у которого задан `getAccessToken`: внутренний вызов не использует Bearer. На `torrow.net` задай `authIdentityBasic`, иначе часто `REQUEST_IS_INVALID`.";
|
|
3941
4670
|
};
|
|
3942
4671
|
readonly requestToken: {
|
|
3943
|
-
readonly description: "`POST /api/v1/auth/token` — тело `TokenReq`, ответ `TokenResp
|
|
3944
|
-
readonly usage: "После **`sendCode`**: `sessionId`
|
|
4672
|
+
readonly description: "`POST /api/v1/auth/token` — тело `TokenReq`, ответ `TokenResp` (смотри `status`).";
|
|
4673
|
+
readonly usage: "После **`sendCode`**: `sessionId` + код (классика) или polling без кода при `MtsMobileId`/`Pending`. Оркестрация — **`TorrowAuth.loginWithOtp`**; явный обмен — **`session.requestTokenWithCode`** (`auth-complete-with-code.ts`); low-level — **`auth-send-code.ts`**.";
|
|
3945
4674
|
};
|
|
3946
4675
|
readonly revoke: {
|
|
3947
4676
|
readonly description: "`POST /api/v1/auth/revoke` — тело `RevokeReq`, ответ пустой при успехе.";
|
|
3948
|
-
readonly usage: "Выход и инвалидация refresh на сервере.";
|
|
4677
|
+
readonly usage: "Выход и инвалидация refresh на сервере. Предпочтительно **`session.logout()`**.";
|
|
3949
4678
|
};
|
|
3950
4679
|
readonly sendCode: {
|
|
3951
4680
|
readonly description: "`POST /api/v1/auth/sendcode` — тело `SendCodeReq`, ответ `SendCodeResp`.";
|
|
3952
|
-
readonly usage: "Первый шаг OTP:
|
|
4681
|
+
readonly usage: "Первый шаг OTP: **`sessionId`**, **`usedMethod`**, **`codeLength`**, при Mobile ID — **`pollIntervalSeconds`**. Только sendCode — **`examples/node/auth/auth-send-code.ts`**; склейка с токенами — **`TorrowAuth.loginWithOtp`** / **`auth-login-with-otp.ts`**.";
|
|
3953
4682
|
};
|
|
3954
4683
|
readonly createSession: {
|
|
3955
4684
|
readonly description: "`POST /api/v1/auth/session` — тело `CreateAuthSessionReq`, ответ `CreateAuthSessionResp`.";
|
|
3956
|
-
readonly usage: "
|
|
4685
|
+
readonly usage: "Не OTP-логин приложения: в torrow-apps вход — `sendCode`/`requestToken`. Этот метод — сессия под внешний deep-link (`authUrl`); на шлюзе в `AuthUrlsByAccountType` обычно только `Telegram`. Для `Phone`/`Email` часто 500 `KeyNotFoundException`. Оркестрация — **`TorrowAuth.loginWithLink`** / **`auth-login-with-link.ts`**.";
|
|
3957
4686
|
};
|
|
3958
4687
|
};
|
|
3959
4688
|
declare const authSdkMethodFieldDocs: {
|
|
@@ -3963,28 +4692,125 @@ declare const authSdkMethodFieldDocs: {
|
|
|
3963
4692
|
readonly sendCode: string;
|
|
3964
4693
|
readonly createSession: string;
|
|
3965
4694
|
};
|
|
4695
|
+
/**
|
|
4696
|
+
* Фасад **`TorrowAuth`** / advanced **`TokenSession`** (**`@torrow/sdk-auth`**).
|
|
4697
|
+
* MCP: **`mcpAuthFieldCatalog.AuthSdkHelpers`**.
|
|
4698
|
+
*/
|
|
4699
|
+
declare const authSdkHelperFieldDocEntries: {
|
|
4700
|
+
readonly "TorrowAuth.connect": {
|
|
4701
|
+
readonly description: "Restore из **`TokenStorage`**: при необходимости refresh → `{ client, session }`. **Без** OTP-hook.";
|
|
4702
|
+
readonly usage: "`appCredentials` + `tokenStorage` + `deviceInfo`. Статус — **`session.status`**. Пример: **`auth-connect.ts`**.";
|
|
4703
|
+
};
|
|
4704
|
+
readonly "TorrowAuth.loginWithOtp": {
|
|
4705
|
+
readonly description: "`sendCode` → Mobile ID poll / classic код → persist → `{ client, session }`.";
|
|
4706
|
+
readonly usage: "`account: { accountType, accountName }` (как SendCodeReq). UI: **`onSendCode({ accountName, accountType, usedMethod, codeLength, … })`**; **`getCode({ codeLength })`** только когда нужны цифры (экран уже из `onSendCode`). Примеры: **`auth-login-with-otp.ts`**, **`auth-login-with-otp-mobile-id.ts`**.";
|
|
4707
|
+
};
|
|
4708
|
+
readonly "TorrowAuth.loginWithLink": {
|
|
4709
|
+
readonly description: "Telegram deep-link: `createSession` → **`onLink(authUrl)`** → внутренний poll `requestToken` → persist.";
|
|
4710
|
+
readonly usage: "Код OTP **не** вводить. Пример: **`auth-login-with-link.ts`**.";
|
|
4711
|
+
};
|
|
4712
|
+
readonly "TorrowAuth.fromTokens": {
|
|
4713
|
+
readonly description: "Сид `accessToken` [/ `refreshToken`] в storage → connect-семантика.";
|
|
4714
|
+
readonly usage: "`appCredentials` опционален: без него нет refresh. Opaque/integration key: задай `accessExpiresAtMs` или бессрочно без TTL. У JWT runtime freshness AND-ит `exp` — будущий explicit `accessExpiresAtMs` не оживит просроченный JWT. Пример: **`auth-from-tokens.ts`**.";
|
|
4715
|
+
};
|
|
4716
|
+
readonly "TorrowAuth.anonymous": {
|
|
4717
|
+
readonly description: "`TorrowClient` без Bearer (`getAccessToken: undefined`).";
|
|
4718
|
+
readonly usage: "Публичные GET. Пример: **`auth-anonymous-public-service.ts`**.";
|
|
4719
|
+
};
|
|
4720
|
+
readonly requestTokenWithCode: {
|
|
4721
|
+
readonly description: "**`TokenSession.requestTokenWithCode`**: токены по `sessionId` + OTP-коду (`requestToken`) → persist при TokenReady.";
|
|
4722
|
+
readonly usage: "После `sendCode` + кода (UI/stdin). Не ready → **`AuthSessionNotReadyError`** (poll — внутри **`loginWithLink`**). Пример: **`auth-complete-with-code.ts`**.";
|
|
4723
|
+
};
|
|
4724
|
+
};
|
|
4725
|
+
declare const authSdkHelperFieldDocs: {
|
|
4726
|
+
readonly "TorrowAuth.connect": string;
|
|
4727
|
+
readonly "TorrowAuth.loginWithOtp": string;
|
|
4728
|
+
readonly "TorrowAuth.loginWithLink": string;
|
|
4729
|
+
readonly "TorrowAuth.fromTokens": string;
|
|
4730
|
+
readonly "TorrowAuth.anonymous": string;
|
|
4731
|
+
readonly requestTokenWithCode: string;
|
|
4732
|
+
};
|
|
4733
|
+
/**
|
|
4734
|
+
* Гостевой **`securityToken`**: не access JWT, не заголовок `Authorization`.
|
|
4735
|
+
* Ключи — подсказки для агентов (MCP: **`mcpAuthFieldCatalog.GuestAccessSecurityToken`**).
|
|
4736
|
+
*/
|
|
4737
|
+
declare const guestAccessSecurityTokenFieldDocEntries: {
|
|
4738
|
+
readonly purpose: {
|
|
4739
|
+
readonly description: "Одноразовый или контекстный **opaque**-токен, который сервер принимает **вместо или вместе с** полноценной пользовательской сессией, чтобы отдать данные по конкретной сущности (часто **событие/заказ**), не раскрывая всё дерево прав владельца.";
|
|
4740
|
+
readonly usage: "Типичный UX: пользователь **не залогинен**, но открыл ссылку после записи на услугу; сервер выдал токен вместе с ответом **`createOrder`**, приложение подставляет его в следующие **чтения** этого кейса.";
|
|
4741
|
+
};
|
|
4742
|
+
readonly notBearer: {
|
|
4743
|
+
readonly description: "**Не** подставлять в `Authorization` и **не** путать с `TokenResp.accessToken` / env **`TORROW_ACCESS_TOKEN`**.";
|
|
4744
|
+
readonly usage: "`TORROW_ACCESS_TOKEN` → `TorrowClientConfig.getAccessToken` → заголовок **`Authorization: Bearer …`**. `securityToken` → только поля **`securityToken`** в query или в теле запроса по OpenAPI.";
|
|
4745
|
+
};
|
|
4746
|
+
readonly openApiWire: {
|
|
4747
|
+
readonly description: "В OpenAPI параметр чаще всего называется **`securityToken`** (query на `GET/PUT/DELETE …` или поле в JSON-теле — сверяй конкретный путь в **`docs/torrow-swagger.json`**).";
|
|
4748
|
+
readonly usage: "SDK не добавляет его глобально: передаёшь в **опциях** соответствующего метода фасада (например `cases.getById(id, { securityToken })`) или в свойстве тела (`GetReCheckInScheduleReq.securityToken` для `services.getReCheckInSchedule`).";
|
|
4749
|
+
};
|
|
4750
|
+
readonly afterCreateOrder: {
|
|
4751
|
+
readonly description: "После **`client.services.createOrder`** в ответе **`OrderResp`** часто есть строка, которую продукт кладёт в query как **`securityToken`** при открытии экрана события у гостя.";
|
|
4752
|
+
readonly usage: "Возьми **`OrderResp.consumerSecurityToken`** (если пришёл) и передай тем же ключом в **`client.cases.getById(order.id, { securityToken: consumerSecurityToken, caseParticipantId: … })`** — иначе **`personalInfo.ticketResource`** и ссылка на оплату могут не вернуться.";
|
|
4753
|
+
readonly examples: readonly ["consumerSecurityToken из OrderResp"];
|
|
4754
|
+
};
|
|
4755
|
+
readonly envInExamples: {
|
|
4756
|
+
readonly description: "В репозитории примеров переменная **`TORROW_SECURITY_TOKEN`** используется **только** там, где сценарий явно про гостевой доступ (сейчас **`examples/node/orders/case-payment-url.ts`**).";
|
|
4757
|
+
readonly usage: "В своём коде приложения храни значение там же, где хранишь deep link / черновик заказа (state роутера), а не в общем `TorrowClient`-конфиге — конфиг клиента **не** содержит `securityToken`.";
|
|
4758
|
+
};
|
|
4759
|
+
};
|
|
4760
|
+
declare const guestAccessSecurityTokenFieldDocs: {
|
|
4761
|
+
readonly purpose: string;
|
|
4762
|
+
readonly notBearer: string;
|
|
4763
|
+
readonly openApiWire: string;
|
|
4764
|
+
readonly afterCreateOrder: string;
|
|
4765
|
+
readonly envInExamples: string;
|
|
4766
|
+
};
|
|
4767
|
+
/** Значения OpenAPI **`DeviceType`** ↔ **`DeviceTypeValues`** в `@torrow/sdk-client`. */
|
|
4768
|
+
declare const deviceTypeValuesFieldDocEntries: {
|
|
4769
|
+
readonly Unknown: {
|
|
4770
|
+
readonly description: "Тип устройства не определён / не передан явно.";
|
|
4771
|
+
readonly usage: "`DeviceTypeValues.Unknown` → `DeviceInfo.deviceType`.";
|
|
4772
|
+
};
|
|
4773
|
+
readonly Mobile: {
|
|
4774
|
+
readonly description: "Мобильный клиент.";
|
|
4775
|
+
readonly usage: "`DeviceTypeValues.Mobile`.";
|
|
4776
|
+
};
|
|
4777
|
+
readonly Tablet: {
|
|
4778
|
+
readonly description: "Планшет.";
|
|
4779
|
+
readonly usage: "`DeviceTypeValues.Tablet`.";
|
|
4780
|
+
};
|
|
4781
|
+
readonly Desktop: {
|
|
4782
|
+
readonly description: "Десктоп / веб-десктоп (дефолт в примерах SDK).";
|
|
4783
|
+
readonly usage: "`DeviceTypeValues.Desktop`. Парсинг env: `parseDeviceType`.";
|
|
4784
|
+
};
|
|
4785
|
+
};
|
|
4786
|
+
declare const deviceTypeValuesFieldDocs: {
|
|
4787
|
+
readonly Unknown: string;
|
|
4788
|
+
readonly Mobile: string;
|
|
4789
|
+
readonly Tablet: string;
|
|
4790
|
+
readonly Desktop: string;
|
|
4791
|
+
};
|
|
3966
4792
|
|
|
3967
4793
|
declare const profilesSdkMethodFieldDocEntries: {
|
|
3968
4794
|
readonly list: {
|
|
3969
|
-
readonly description: "`GET /api/v1/user/profiles`.
|
|
3970
|
-
readonly valueSchema: "→
|
|
4795
|
+
readonly description: "`GET /api/v1/user/profiles`. Разворачивает ответ **`ProfileListResp`**: возвращает **`ContactItem[]`** (Профили текущего пользователя; не общий CRUD `/api/v1/contacts`). Пустой массив, если **`profileList`** отсутствует или **`null`**. Требуется Bearer пользователя.";
|
|
4796
|
+
readonly valueSchema: "→ ContactItem[]";
|
|
3971
4797
|
};
|
|
3972
4798
|
readonly add: {
|
|
3973
|
-
readonly description: "`POST /api/v1/user/profiles`. Тело: **`
|
|
3974
|
-
readonly valueSchema: "
|
|
4799
|
+
readonly description: "`POST /api/v1/user/profiles`. Тело: **`UserProfileItemForAdd`** (поля контакта для write из **`ContactItemForCreateOrUpdate`** плюс **`profileType`**, **`profileProperties`**, **`hasTimetable`**). OpenAPI ссылается на **`ContactItem`**. Фасад разворачивает **`AddProfileResp.profile`** и возвращает **`ContactItem`**. Мутация учётки: создаёт Профиль; не путать с CRUD `/api/v1/contacts`. Перед POST фасад добивает `discriminator` / `publicityType` / non-empty `name` и contact write normalizations including `visitCard`.";
|
|
4800
|
+
readonly valueSchema: "UserProfileItemForAdd → ContactItem";
|
|
3975
4801
|
};
|
|
3976
4802
|
readonly addByContactId: {
|
|
3977
|
-
readonly description: "`PUT /api/v1/user/profiles`. Тело в OpenAPI — **строка** (JSON-строка): `torrow id` уже существующего контакта, который нужно зарегистрировать как Профиль.
|
|
3978
|
-
readonly valueSchema: "string (contactId) →
|
|
4803
|
+
readonly description: "`PUT /api/v1/user/profiles`. Тело в OpenAPI — **строка** (JSON-строка): `torrow id` уже существующего контакта, который нужно зарегистрировать как Профиль. Фасад возвращает **`ContactItem`** (`AddProfileResp.profile`). Не путать с `PUT` обновления обычного контакта по `/api/v1/contacts/{id}`.";
|
|
4804
|
+
readonly valueSchema: "string (contactId) → ContactItem";
|
|
3979
4805
|
readonly usage: "Передай строку id существующего контакта; SDK сериализует её как JSON string.";
|
|
3980
4806
|
};
|
|
3981
4807
|
readonly updateProfileProperties: {
|
|
3982
|
-
readonly description: "`PUT /api/v1/user/profiles/{profileId}/profileproperties`. Тело: **`ProfileProperties`** (цвет карточки, доступность, заметка).
|
|
3983
|
-
readonly valueSchema: "ProfileProperties →
|
|
4808
|
+
readonly description: "`PUT /api/v1/user/profiles/{profileId}/profileproperties`. Тело: **`ProfileProperties`** (цвет карточки, доступность, заметка). Фасад возвращает **`torrowObject`** из ответа (если сервер его прислал), иначе `undefined`.";
|
|
4809
|
+
readonly valueSchema: "ProfileProperties → TorrowObject | undefined";
|
|
3984
4810
|
};
|
|
3985
4811
|
readonly remove: {
|
|
3986
|
-
readonly description: "`DELETE /api/v1/user/profiles/{profileId}`. Удалить Профиль по id контакта.
|
|
3987
|
-
readonly valueSchema: "→
|
|
4812
|
+
readonly description: "`DELETE /api/v1/user/profiles/{profileId}`. Удалить Профиль по id контакта. Фасад возвращает актуальный **`personalContactList`** как **`ContactItem[]`**. Не удаляй последний Профиль учётки и Профиль с живыми personal-link (как в apps).";
|
|
4813
|
+
readonly valueSchema: "→ ContactItem[]";
|
|
3988
4814
|
};
|
|
3989
4815
|
};
|
|
3990
4816
|
declare const profileListRespFieldDocEntries: {
|
|
@@ -4062,46 +4888,43 @@ declare const profilePropertiesFieldDocs: {
|
|
|
4062
4888
|
readonly color: string;
|
|
4063
4889
|
};
|
|
4064
4890
|
|
|
4065
|
-
/** Сегмент пути `/api/v1/{segment}/...` — не отдельная схема OpenAPI, а параметр SDK. */
|
|
4066
4891
|
/**
|
|
4067
4892
|
* Соответствие методов `TorrowClient.relations` телам запросов и путям REST.
|
|
4068
4893
|
* Удобно для MCP-инструментов с именами `torrow_relations_include_to_parent` и т.д.
|
|
4069
4894
|
*/
|
|
4070
4895
|
declare const relationsSdkMethodFieldDocEntries: {
|
|
4071
4896
|
readonly includeToParent: {
|
|
4072
|
-
readonly description: "`PUT /api/v1/{domain}/{parentId}/include/items`.
|
|
4073
|
-
readonly valueSchema: "
|
|
4897
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/include/items`. Параметры SDK: `parentId`, массив `itemPropertiesList` (`itemId`, опционально `order` и свойства item), опции `versionToCheck`/`isNeedAnnouncement`. Ответ: `IncludeExcludeResp`. **Pinned link** (`LinkType.Pinned`): доменная операция создания связи parent → child. Для чтения и порядка результата используй `client.views.pinned.*`.";
|
|
4898
|
+
readonly valueSchema: "parentId + ItemProperties[] + TorrowOptions → IncludeExcludeResp";
|
|
4899
|
+
readonly usage: "Domain SDK выводит из `parentId`. Канон apps AttachItemTask. Pin User→Pinned — `client.views.pin`, не этот метод. Не путай с прямым `views.pinned.create`. См. `docs/agents/relations-flow.md`.";
|
|
4074
4900
|
};
|
|
4075
4901
|
readonly includeForUser: {
|
|
4076
|
-
readonly description: "`PUT /api/v1/{domain}/{parentId}/include/foruser`.
|
|
4077
|
-
readonly valueSchema: "
|
|
4902
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/include/foruser`. Параметры SDK: `parentId`, массив `itemPropertiesList` (`itemId`, опционально `order`), опции `versionToCheck`/`isNeedAnnouncement`. Ответ: `IncludeExcludeResp`. Batch-операция создания нескольких User-связей под parent (`LinkType.User`). Для одного item предпочитай `saveToMindMap`; для чтения используй `client.views.user.*`.";
|
|
4903
|
+
readonly valueSchema: "parentId + BaseItemProperties[] + TorrowOptions → IncludeExcludeResp";
|
|
4904
|
+
readonly usage: "Domain SDK выводит из `parentId`. OpenAPI batch. torrow-apps для user link вызывает `saveToMindMap`, не этот эндпоинт. Предпочитай `saveToMindMap` в продукте.";
|
|
4078
4905
|
};
|
|
4079
4906
|
readonly excludeFromParent: {
|
|
4080
|
-
readonly description: "`PUT /api/v1/{domain}/{parentId}/exclude/items`.
|
|
4081
|
-
readonly valueSchema: "
|
|
4907
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/exclude/items`. Параметры SDK: `parentId`, `childIds`, опции `versionToCheck`/`isNeedAnnouncement`. Ответ: `ExcludeResp`. Доменная операция снятия Pinned-связи с родителя; для удаления конкретного view есть отдельный `client.views.pinned.delete`.";
|
|
4908
|
+
readonly valueSchema: "childIds + TorrowOptions → ExcludeResp";
|
|
4082
4909
|
};
|
|
4083
4910
|
readonly excludeFromUser: {
|
|
4084
|
-
readonly description: "`PUT /api/v1/{domain}/{parentId}/exclude/fromuser`.
|
|
4085
|
-
readonly valueSchema: "
|
|
4911
|
+
readonly description: "`PUT /api/v1/{domain}/{parentId}/exclude/fromuser`. Параметры SDK: `parentId`, `childIds`, опции `versionToCheck`/`isNeedAnnouncement`. Ответ: `ExcludeResp`. Доменная операция снятия User-связи; для удаления конкретного view есть отдельный `client.views.user.delete`.";
|
|
4912
|
+
readonly valueSchema: "childIds + TorrowOptions → ExcludeResp";
|
|
4086
4913
|
};
|
|
4087
4914
|
readonly includeToGroups: {
|
|
4088
|
-
readonly description: "`PUT /api/v1/{domain}/include/togroups`. Тело: `IncludeToGroupsReq`. Ответ: `IncludeExcludeResp`. Массовое включение в
|
|
4915
|
+
readonly description: "`PUT /api/v1/{domain}/include/togroups`. Тело: `IncludeToGroupsReq`. Ответ: `IncludeExcludeResp`. Массовое включение в группы (ACL).";
|
|
4089
4916
|
readonly valueSchema: "IncludeToGroupsReq → IncludeExcludeResp";
|
|
4917
|
+
readonly usage: "Domain SDK выводит из `groupIds`; список должен быть непустым и однотипным. Члены группы — `search.*(groupIds)`, не `listGroups`. UI apps часто `updateGroups` на item.";
|
|
4090
4918
|
};
|
|
4091
4919
|
readonly excludeFromGroups: {
|
|
4092
4920
|
readonly description: "`PUT /api/v1/{domain}/exclude/fromgroups`. Тело: `ExcludeFromGroupsReq`. Ответ: `ExcludeResp`.";
|
|
4093
4921
|
readonly valueSchema: "ExcludeFromGroupsReq → ExcludeResp";
|
|
4922
|
+
readonly usage: "Domain SDK выводит из `itemIds`; список должен быть непустым и однотипным.";
|
|
4094
4923
|
};
|
|
4095
4924
|
readonly saveToMindMap: {
|
|
4096
|
-
readonly description: "`PUT /api/v1/{domain}/{itemId}/savetomindmap`. Тело: `SaveItemToMindMapReq`. Ответ: `Participation`.
|
|
4925
|
+
readonly description: "`PUT /api/v1/{domain}/{itemId}/savetomindmap`. Тело: `SaveItemToMindMapReq`. Ответ: `Participation`. Доменная операция сохранения **одного item** в личную структуру (`LinkType.User`); для чтения результата используй `client.views.user.*`.";
|
|
4097
4926
|
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; отличие только в сегменте пути.";
|
|
4927
|
+
readonly usage: "Domain SDK выводит из `itemId` аргумента. Передавай `offlinable: true`, `parentItemId`, `userProfileId`. Не путать с participation accept на item-фасаде.";
|
|
4105
4928
|
};
|
|
4106
4929
|
};
|
|
4107
4930
|
declare const itemLinkKeyFieldDocEntries: {
|
|
@@ -4118,6 +4941,38 @@ declare const itemLinkKeyFieldDocEntries: {
|
|
|
4118
4941
|
readonly valueSchema: "string | null";
|
|
4119
4942
|
};
|
|
4120
4943
|
};
|
|
4944
|
+
/** OpenAPI `ItemLink` — связь parent↔child в view/hit (`NoteView.itemLink` и т.п.). */
|
|
4945
|
+
declare const itemLinkFieldDocEntries: {
|
|
4946
|
+
readonly parentId: {
|
|
4947
|
+
readonly description: "Родительский элемент связи.";
|
|
4948
|
+
readonly valueSchema: "string | null";
|
|
4949
|
+
};
|
|
4950
|
+
readonly meta: {
|
|
4951
|
+
readonly description: "Метаданные связи (версия и т.п.).";
|
|
4952
|
+
readonly valueSchema: "ObjectInfo";
|
|
4953
|
+
};
|
|
4954
|
+
readonly itemId: {
|
|
4955
|
+
readonly description: "Дочерний / связанный элемент.";
|
|
4956
|
+
readonly valueSchema: "string | null";
|
|
4957
|
+
};
|
|
4958
|
+
readonly linkType: {
|
|
4959
|
+
readonly description: "Тип связи User / Pinned (и пр.). Флоу: `docs/agents/relations-flow.md`.";
|
|
4960
|
+
readonly valueSchema: "LinkType";
|
|
4961
|
+
readonly usage: "Assert в examples — best-effort; membership в listUser/listPinned — канон проверки.";
|
|
4962
|
+
};
|
|
4963
|
+
readonly order: {
|
|
4964
|
+
readonly description: "Порядок среди соседей под родителем.";
|
|
4965
|
+
readonly valueSchema: "int32 | null";
|
|
4966
|
+
};
|
|
4967
|
+
readonly alias: {
|
|
4968
|
+
readonly description: "Псевдоним узла в mind map для этой связи.";
|
|
4969
|
+
readonly valueSchema: "string | null";
|
|
4970
|
+
};
|
|
4971
|
+
readonly tags: {
|
|
4972
|
+
readonly description: "Теги связи.";
|
|
4973
|
+
readonly valueSchema: "string[] | null";
|
|
4974
|
+
};
|
|
4975
|
+
};
|
|
4121
4976
|
declare const includedLinkMetaFieldDocEntries: {
|
|
4122
4977
|
readonly key: {
|
|
4123
4978
|
readonly description: "Составной ключ созданной или обновлённой связи.";
|
|
@@ -4308,7 +5163,7 @@ declare const saveItemToMindMapReqFieldDocEntries: {
|
|
|
4308
5163
|
readonly valueSchema: "string | null";
|
|
4309
5164
|
};
|
|
4310
5165
|
readonly parentItemId: {
|
|
4311
|
-
readonly description: "
|
|
5166
|
+
readonly description: "Родитель для **User-link placement** (`client.relations.saveToMindMap`). Для participation accept часто не нужен — см. `participation-flow.md`. `null` — по правилам API (корень / снятие).";
|
|
4312
5167
|
readonly valueSchema: "string | null";
|
|
4313
5168
|
};
|
|
4314
5169
|
readonly alias: {
|
|
@@ -4316,7 +5171,7 @@ declare const saveItemToMindMapReqFieldDocEntries: {
|
|
|
4316
5171
|
readonly valueSchema: "string | null";
|
|
4317
5172
|
};
|
|
4318
5173
|
readonly offlinable: {
|
|
4319
|
-
readonly description: "
|
|
5174
|
+
readonly description: "Офлайн-доступность узла. Для placement apps обычно `true`; не обязателен для accept offer / `securityToken` — см. `participation-flow.md`.";
|
|
4320
5175
|
readonly examples: readonly ["true", "false"];
|
|
4321
5176
|
readonly valueSchema: "boolean";
|
|
4322
5177
|
};
|
|
@@ -4376,9 +5231,6 @@ declare const includeExcludeRespFieldDocEntries: {
|
|
|
4376
5231
|
declare const relationsSdkMethodFieldDocs: {
|
|
4377
5232
|
[x: string]: string;
|
|
4378
5233
|
};
|
|
4379
|
-
declare const relationsApiDomainFieldDocs: {
|
|
4380
|
-
[x: string]: string;
|
|
4381
|
-
};
|
|
4382
5234
|
declare const itemPropertiesFieldDocs: {
|
|
4383
5235
|
[x: string]: string;
|
|
4384
5236
|
};
|
|
@@ -4418,6 +5270,9 @@ declare const includeExcludeRespFieldDocs: {
|
|
|
4418
5270
|
declare const itemLinkKeyFieldDocs: {
|
|
4419
5271
|
[x: string]: string;
|
|
4420
5272
|
};
|
|
5273
|
+
declare const itemLinkFieldDocs: {
|
|
5274
|
+
[x: string]: string;
|
|
5275
|
+
};
|
|
4421
5276
|
declare const includedLinkMetaFieldDocs: {
|
|
4422
5277
|
[x: string]: string;
|
|
4423
5278
|
};
|
|
@@ -4425,4 +5280,36 @@ declare const excludedLinkMetaFieldDocs: {
|
|
|
4425
5280
|
[x: string]: string;
|
|
4426
5281
|
};
|
|
4427
5282
|
|
|
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 };
|
|
5283
|
+
declare const torrowIdHelperFieldDocEntries: {
|
|
5284
|
+
readonly getTorrowObjectTypeFromTorrowId: {
|
|
5285
|
+
readonly description: "Строго проверяет Torrow ID и возвращает известный SDK `TorrowObjectType` из числового кода ID.";
|
|
5286
|
+
readonly valueSchema: "string → TorrowObjectType";
|
|
5287
|
+
readonly usage: "Неизвестный numeric code даёт `TorrowIdError` с reason `unknown-object-type-code`; SDK не угадывает соответствие по порядку OpenAPI enum.";
|
|
5288
|
+
};
|
|
5289
|
+
};
|
|
5290
|
+
declare const torrowItemTypeHelperFieldDocEntries: {
|
|
5291
|
+
readonly getTorrowItemTypeFromTorrowId: {
|
|
5292
|
+
readonly description: "Возвращает `TorrowItemType`, закодированный в одном каноническом Torrow ID.";
|
|
5293
|
+
readonly valueSchema: "string → TorrowItemType";
|
|
5294
|
+
readonly usage: "Известные non-item типы (`User`, `File`) дают `unsupported-item-type`.";
|
|
5295
|
+
};
|
|
5296
|
+
readonly getTorrowItemTypeFromTorrowIds: {
|
|
5297
|
+
readonly description: "Возвращает общий `TorrowItemType` непустого однотипного списка Torrow ID.";
|
|
5298
|
+
readonly valueSchema: "readonly string[] → TorrowItemType";
|
|
5299
|
+
readonly usage: "Пустой список и смешанные item types дают типизированный `TorrowIdError`.";
|
|
5300
|
+
};
|
|
5301
|
+
readonly isTorrowItemType: {
|
|
5302
|
+
readonly description: "Runtime guard для внешней строки с семантическим item type (`Note`, `Contact`, ...).";
|
|
5303
|
+
readonly valueSchema: "string → boolean";
|
|
5304
|
+
};
|
|
5305
|
+
};
|
|
5306
|
+
declare const torrowIdHelperFieldDocs: {
|
|
5307
|
+
readonly getTorrowObjectTypeFromTorrowId: string;
|
|
5308
|
+
};
|
|
5309
|
+
declare const torrowItemTypeHelperFieldDocs: {
|
|
5310
|
+
readonly getTorrowItemTypeFromTorrowId: string;
|
|
5311
|
+
readonly getTorrowItemTypeFromTorrowIds: string;
|
|
5312
|
+
readonly isTorrowItemType: string;
|
|
5313
|
+
};
|
|
5314
|
+
|
|
5315
|
+
export { type ItemFieldDoc, accountTypeFieldDocEntries, accountTypeFieldDocs, accountingTransactionFieldDocEntries, accountingTransactionFieldDocs, accountingTransactionStateFieldDocEntries, accountingTransactionStateFieldDocs, accountingTransactionTypeFieldDocEntries, accountingTransactionTypeFieldDocs, accountingTransactionsSdkMethodFieldDocEntries, accountingTransactionsSdkMethodFieldDocs, actionHistoryInfoFieldDocEntries, actionHistoryInfoFieldDocs, actionHistoryListQueryFieldDocEntries, actionHistoryListQueryFieldDocs, actionHistorySdkMethodFieldDocEntries, actionHistorySdkMethodFieldDocs, actionHistoryStateFieldDocEntries, actionHistoryStateFieldDocs, actionHistoryTypeFieldDocEntries, actionHistoryTypeFieldDocs, addProfileRespFieldDocEntries, addProfileRespFieldDocs, advisedItemTypeFieldDocEntries, advisedItemTypeFieldDocs, advisedItemsSearchQueryFieldDocEntries, advisedItemsSearchQueryFieldDocs, announcementCategoryFieldDocEntries, announcementCategoryFieldDocs, announcementInfoFieldDocEntries, announcementInfoFieldDocs, announcementPriorityFieldDocEntries, announcementPriorityFieldDocs, announcementStateFieldDocEntries, announcementStateFieldDocs, announcementTypeFieldDocEntries, announcementTypeFieldDocs, announcementsListQueryFieldDocEntries, announcementsListQueryFieldDocs, announcementsSdkMethodFieldDocEntries, announcementsSdkMethodFieldDocs, anyoneAccessFieldDocEntries, anyoneAccessFieldDocs, apiKeyInfoFieldDocEntries, apiKeyInfoFieldDocs, apiKeysSdkMethodFieldDocEntries, apiKeysSdkMethodFieldDocs, archiveStateFieldDocEntries, archiveStateFieldDocs, authSdkHelperFieldDocEntries, authSdkHelperFieldDocs, 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, checkinPermissionFieldDocEntries, checkinPermissionFieldDocs, communicationTypeFieldDocEntries, communicationTypeFieldDocs, contactItemFieldDocEntries, contactItemFieldDocs, contactItemSpecificFieldDocEntries, contactItemSpecificFieldDocs, contactVisitCardFieldDoc, contactsCommunicationSdkMethodFieldDocEntries, contactsCommunicationSdkMethodFieldDocs, contextIconPresetValuesFieldDocEntries, contextIconPresetValuesFieldDocs, contextItemFieldDocEntries, contextItemFieldDocs, createApiKeyRequestFieldDocEntries, createApiKeyRequestFieldDocs, createApiKeyResponseFieldDocEntries, createApiKeyResponseFieldDocs, createAuthSessionReqFieldDocEntries, createAuthSessionReqFieldDocs, createAuthSessionRespFieldDocEntries, createAuthSessionRespFieldDocs, createLoyaltyCardReqFieldDocEntries, createLoyaltyCardReqFieldDocs, createViewListReqFieldDocEntries, createViewListReqFieldDocs, createViewListRespFieldDocEntries, createViewListRespFieldDocs, deleteResponseFieldDocEntries, deleteResponseFieldDocs, deleteStateFieldDocEntries, deleteStateFieldDocs, deliveryChannelFieldDocEntries, deliveryChannelFieldDocs, deliveryStrategyFieldDocEntries, deliveryStrategyFieldDocs, deviceSettingsInfoFieldDocEntries, deviceSettingsInfoFieldDocs, deviceTypeValuesFieldDocEntries, deviceTypeValuesFieldDocs, 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, getShareItemSessionReqFieldDocEntries, getShareItemSessionReqFieldDocs, groupItemPropertiesFieldDocEntries, groupItemPropertiesFieldDocs, guestAccessSecurityTokenFieldDocEntries, guestAccessSecurityTokenFieldDocs, imagePreviewSizeFieldDocEntries, imagePreviewSizeFieldDocs, importByFileRequestFieldDocEntries, importByFileRequestFieldDocs, importByUniqueNameRequestFieldDocEntries, importByUniqueNameRequestFieldDocs, includeExcludeRespFieldDocEntries, includeExcludeRespFieldDocs, includeForUserReqFieldDocEntries, includeForUserReqFieldDocs, includeRespFieldDocEntries, includeRespFieldDocs, includeToGroupsReqFieldDocEntries, includeToGroupsReqFieldDocs, includeToParentReqFieldDocEntries, includeToParentReqFieldDocs, includedLinkMetaFieldDocEntries, includedLinkMetaFieldDocs, initialTransactionFieldDocEntries, initialTransactionFieldDocs, itemDeleteMethodDescription, itemDeleteQueryFieldDocEntries, itemDeleteQueryFieldDocs, itemLinkFieldDocEntries, itemLinkFieldDocs, itemLinkKeyFieldDocEntries, itemLinkKeyFieldDocs, itemPropertiesFieldDocEntries, itemPropertiesFieldDocs, itemSortConditionFieldDocEntries, itemSortConditionFieldDocs, itemViewSortConditionFieldDocEntries, itemViewSortConditionFieldDocs, layoutTypeValuesFieldDocEntries, layoutTypeValuesFieldDocs, linkTypeFieldDocEntries, linkTypeFieldDocs, loyaltyCardIssueTypeFieldDocEntries, loyaltyCardIssueTypeFieldDocs, loyaltyCardSubscriptionFieldDocEntries, loyaltyCardSubscriptionFieldDocs, loyaltyCardUpdateKeyInformationFieldDocEntries, loyaltyCardUpdateKeyInformationFieldDocs, loyaltyCardUpdateNonKeyInformationFieldDocEntries, loyaltyCardUpdateNonKeyInformationFieldDocs, loyaltyCardsSdkMethodFieldDocEntries, loyaltyCardsSdkMethodFieldDocs, loyaltySystemItemFieldDocEntries, loyaltySystemItemFieldDocs, loyaltySystemsSdkMethodFieldDocEntries, loyaltySystemsSdkMethodFieldDocs, loyaltySystemsStatisticsReqFieldDocEntries, loyaltySystemsStatisticsReqFieldDocs, loyaltySystemsStatisticsRespFieldDocEntries, loyaltySystemsStatisticsRespFieldDocs, mapFieldDocsToStrings, mcpAuthFieldCatalog, mcpBookingFieldCatalog, mcpFullFieldCatalog, mcpItemFieldCatalog, mcpNotesFieldCatalog, mcpOperationsFieldCatalog, mcpRelationFieldCatalog, mcpSearchFieldCatalog, mcpUserProfilesFieldCatalog, mcpViewsFieldCatalog, metricsFieldDocEntries, metricsFieldDocs, noteItemFieldDocEntries, noteItemFieldDocs, noteTypeFieldDocEntries, noteTypeFieldDocs, notesSdkMethodFieldDocEntries, notesSdkMethodFieldDocs, 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, pinnedViewsSdkMethodFieldDocEntries, pinnedViewsSdkMethodFieldDocs, profileListRespFieldDocEntries, profileListRespFieldDocs, profilePropertiesFieldDocEntries, profilePropertiesFieldDocs, profileTypeFieldDocEntries, profileTypeFieldDocs, profileUserAvailabilityFieldDocEntries, profileUserAvailabilityFieldDocs, profileWithErrorFieldDocEntries, profileWithErrorFieldDocs, profilesSdkMethodFieldDocEntries, profilesSdkMethodFieldDocs, putUrlRespFieldDocEntries, putUrlRespFieldDocs, refreshReqFieldDocEntries, refreshReqFieldDocs, 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, sessionDurationPropertiesFieldDocEntries, sessionDurationPropertiesFieldDocs, sessionDurationTypeFieldDocEntries, sessionDurationTypeFieldDocs, sessionPrecisionTypeFieldDocEntries, sessionPrecisionTypeFieldDocs, shareItemReqFieldDocEntries, shareItemReqFieldDocs, showCaseInTimetableTypeFieldDocEntries, showCaseInTimetableTypeFieldDocs, solutionDataFieldDocEntries, solutionDataFieldDocs, stateManagementTypeFieldDocEntries, stateManagementTypeFieldDocs, ticketPaymentConfirmationSourceFieldDocEntries, ticketPaymentConfirmationSourceFieldDocs, ticketStateFieldDocEntries, ticketStateFieldDocs, timeSelectionTypeFieldDocEntries, timeSelectionTypeFieldDocs, timetableViewTypeValuesFieldDocEntries, timetableViewTypeValuesFieldDocs, tokenReqFieldDocEntries, tokenReqFieldDocs, tokenRespFieldDocEntries, tokenRespFieldDocs, tokenStatusFieldDocEntries, tokenStatusFieldDocs, torrowClientAuthConfigFieldDocEntries, torrowClientAuthConfigFieldDocs, torrowErrorClientFieldDocEntries, torrowErrorClientFieldDocs, torrowIdHelperFieldDocEntries, torrowIdHelperFieldDocs, torrowItemBaseFieldDocEntries, torrowItemBaseFieldDocs, torrowItemCoreFacadeSdkMethodFieldDocEntries, torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto, torrowItemCoreFacadeSdkMethodFieldDocs, torrowItemFacadeContactsItemSdkMethodFieldDocEntries, torrowItemFacadeContactsItemSdkMethodFieldDocs, torrowItemFacadeExtensionSdkMethodFieldDocEntries, torrowItemFacadePhotoEndpointSdkMethodFieldDocEntries, torrowItemFacadeSdkMethodFieldDocEntries, torrowItemFacadeSdkMethodFieldDocs, torrowItemTypeHelperFieldDocEntries, torrowItemTypeHelperFieldDocs, torrowObjectTypeFieldDocEntries, torrowObjectTypeFieldDocs, transactionInfoFieldDocEntries, transactionInfoFieldDocs, updateAnnouncementStateReqFieldDocEntries, updateAnnouncementStateReqFieldDocs, updateFileIdRespFieldDocEntries, updateFileIdRespFieldDocs, updateProfilePropertiesRespFieldDocEntries, updateProfilePropertiesRespFieldDocs, updateViewListOrderReqFieldDocEntries, updateViewListOrderReqFieldDocs, updateViewListOrderRespFieldDocEntries, updateViewListOrderRespFieldDocs, usageConditionFieldDocEntries, usageConditionFieldDocs, usageConditionTypeFieldDocEntries, usageConditionTypeFieldDocs, usageTypeFieldDocEntries, usageTypeFieldDocs, userAccessLevelFieldDocEntries, userAccessLevelFieldDocs, userDeliveryWayFieldDocEntries, userDeliveryWayFieldDocs, userSdkMethodFieldDocEntries, userSdkMethodFieldDocs, userSettingsInfoFieldDocEntries, userSettingsInfoFieldDocs, userSettingsSdkMethodFieldDocEntries, userSettingsSdkMethodFieldDocs, userViewsSdkMethodFieldDocEntries, userViewsSdkMethodFieldDocs, verificationMethodFieldDocEntries, verificationMethodFieldDocs, verifyCommunicationCodeReqFieldDocEntries, verifyCommunicationCodeReqFieldDocs, verifyCommunicationCodeRespFieldDocEntries, verifyCommunicationCodeRespFieldDocs, viewBlockSettingsFieldDocEntries, viewBlockSettingsFieldDocs, viewInfoFieldDocEntries, viewInfoFieldDocs, viewsSdkMethodFieldDocEntries, viewsSdkMethodFieldDocs };
|