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