@torrow/sdk-docs 0.10.0 → 0.11.1

package/dist/index.d.ts

@@ -495,8 +495,8 @@ declare const torrowItemBaseFieldDocEntries: {
     };
     readonly publicityType: {
         readonly description: "Кто может видеть элемент и как выдаётся доступ (персональный, по ссылке, публичный и т.д.).";
-        readonly examples: readonly ["Personal", "Link", "PublicAvailable", "PublicWithRequest", "Private", "Undefined"];
-        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).";
+        readonly examples: readonly ["Personal", "Link", "PublicAvailable", "PublicWithRequest"];
+        readonly usage: "SDK принимает только Personal, PublicWithRequest, PublicAvailable и Link. При чтении серверные Private и Undefined становятся Personal; исходные wire DTO сохраняют эти значения. Private можно вернуть отдельным изменением после подтверждённого исправления сервера, Undefined — по отдельному решению. Пайп `ttPublicityType` и настройки создания: Personal по умолчанию в формах; Link при создании дочернего ресурса от родителя (см. resource-item-business). Для карточек «только по ссылке» часто сочетается с `anyoneAccess: Read` и отключённым поиском (`searchMode: NoneSearchMode`). Текстовый **`client.search.*`** (contacts/notes/…) индексирует только **`PublicAvailable`** / **`PublicWithRequest`**; смена — **`updatePublicity`** (см. **`docs/agents/participation-flow.md`** §3).";
     };
     readonly searchMode: {
         readonly description: "Участие элемента в поиске/выдаче (контракт API).";
@@ -1464,7 +1464,7 @@ declare const loyaltySystemsSdkMethodFieldDocEntries: {
         readonly description: "`GET .../{torrowId}/participants/count`.";
     };
     readonly updatePublicity: {
-        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
+        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`** (Personal, PublicWithRequest, PublicAvailable, Link; Private/Undefined исключены); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
     };
     readonly updateImageId: {
         readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
@@ -1690,7 +1690,7 @@ declare const loyaltyCardsSdkMethodFieldDocEntries: {
         readonly description: "`GET .../uniquename/{uniqueName}` — без доп. query (в отличие от **cases**).";
     };
     readonly updatePublicity: {
-        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
+        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`** (Personal, PublicWithRequest, PublicAvailable, Link; Private/Undefined исключены); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
     };
     readonly updateImageId: {
         readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
@@ -1988,7 +1988,7 @@ declare const itemDeleteQueryFieldDocs: {
 /** Методы Core, общие для loyalty-доменов (без photo-endpoints). */
 declare const torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto: {
     readonly updatePublicity: {
-        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
+        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`** (Personal, PublicWithRequest, PublicAvailable, Link; Private/Undefined исключены); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
     };
     readonly updateImageId: {
         readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
@@ -2198,7 +2198,7 @@ declare const torrowItemFacadeSdkMethodFieldDocEntries: {
         readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
     };
     readonly updatePublicity: {
-        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
+        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`** (Personal, PublicWithRequest, PublicAvailable, Link; Private/Undefined исключены); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
     };
     readonly updateImageId: {
         readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
@@ -2363,7 +2363,7 @@ declare const torrowItemFacadeContactsItemSdkMethodFieldDocEntries: {
         readonly description: "`POST .../{itemId}/unblock` — query **`versionToCheck`**, **`isNeedAnnouncement`**. Только **администратор Torrow** (обычная сессия → HTTP 403).";
     };
     readonly updatePublicity: {
-        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
+        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`** (Personal, PublicWithRequest, PublicAvailable, Link; Private/Undefined исключены); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
     };
     readonly updateImageId: {
         readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";
@@ -2492,7 +2492,7 @@ declare const torrowItemCoreFacadeSdkMethodFieldDocEntries: {
         readonly description: "`GET .../{torrowId}/photo/puturl` — presigned; **`fileId`**, **`fileName?`**, **`fileSize?`**; только при **`withPhotoEndpoints`** (сейчас **contacts**). SDK: **`{ url, urlExpiration }`**.";
     };
     readonly updatePublicity: {
-        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**.";
+        readonly description: "`PUT .../{torrowId}/publicity` — тело **`PublicityType`** (Personal, PublicWithRequest, PublicAvailable, Link; Private/Undefined исключены); query **`versionToCheck`**, **`isNeedAnnouncement`**.";
     };
     readonly updateImageId: {
         readonly description: "`PUT .../{torrowId}/image/id` — тело JSON-string **`fileId`**.";

package/dist/index.js

@@ -463,8 +463,8 @@ var torrowItemBaseFieldDocEntries = {
   },
   publicityType: {
     description: "\u041A\u0442\u043E \u043C\u043E\u0436\u0435\u0442 \u0432\u0438\u0434\u0435\u0442\u044C \u044D\u043B\u0435\u043C\u0435\u043D\u0442 \u0438 \u043A\u0430\u043A \u0432\u044B\u0434\u0430\u0451\u0442\u0441\u044F \u0434\u043E\u0441\u0442\u0443\u043F (\u043F\u0435\u0440\u0441\u043E\u043D\u0430\u043B\u044C\u043D\u044B\u0439, \u043F\u043E \u0441\u0441\u044B\u043B\u043A\u0435, \u043F\u0443\u0431\u043B\u0438\u0447\u043D\u044B\u0439 \u0438 \u0442.\u0434.).",
-    examples: ["Personal", "Link", "PublicAvailable", "PublicWithRequest", "Private", "Undefined"],
-    usage: "\u041F\u0430\u0439\u043F `ttPublicityType` \u0438 \u043D\u0430\u0441\u0442\u0440\u043E\u0439\u043A\u0438 \u0441\u043E\u0437\u0434\u0430\u043D\u0438\u044F: Personal \u043F\u043E \u0443\u043C\u043E\u043B\u0447\u0430\u043D\u0438\u044E \u0432 \u0444\u043E\u0440\u043C\u0430\u0445; Link \u043F\u0440\u0438 \u0441\u043E\u0437\u0434\u0430\u043D\u0438\u0438 \u0434\u043E\u0447\u0435\u0440\u043D\u0435\u0433\u043E \u0440\u0435\u0441\u0443\u0440\u0441\u0430 \u043E\u0442 \u0440\u043E\u0434\u0438\u0442\u0435\u043B\u044F (\u0441\u043C. resource-item-business). \u0414\u043B\u044F \u043A\u0430\u0440\u0442\u043E\u0447\u0435\u043A \xAB\u0442\u043E\u043B\u044C\u043A\u043E \u043F\u043E \u0441\u0441\u044B\u043B\u043A\u0435\xBB \u0447\u0430\u0441\u0442\u043E \u0441\u043E\u0447\u0435\u0442\u0430\u0435\u0442\u0441\u044F \u0441 `anyoneAccess: Read` \u0438 \u043E\u0442\u043A\u043B\u044E\u0447\u0451\u043D\u043D\u044B\u043C \u043F\u043E\u0438\u0441\u043A\u043E\u043C (`searchMode: NoneSearchMode`). \u0422\u0435\u043A\u0441\u0442\u043E\u0432\u044B\u0439 **`client.search.*`** (contacts/notes/\u2026) \u0438\u043D\u0434\u0435\u043A\u0441\u0438\u0440\u0443\u0435\u0442 \u0442\u043E\u043B\u044C\u043A\u043E **`PublicAvailable`** / **`PublicWithRequest`**; \u0441\u043C\u0435\u043D\u0430 \u2014 **`updatePublicity`** (\u0441\u043C. **`docs/agents/participation-flow.md`** \xA73)."
+    examples: ["Personal", "Link", "PublicAvailable", "PublicWithRequest"],
+    usage: "SDK \u043F\u0440\u0438\u043D\u0438\u043C\u0430\u0435\u0442 \u0442\u043E\u043B\u044C\u043A\u043E Personal, PublicWithRequest, PublicAvailable \u0438 Link. \u041F\u0440\u0438 \u0447\u0442\u0435\u043D\u0438\u0438 \u0441\u0435\u0440\u0432\u0435\u0440\u043D\u044B\u0435 Private \u0438 Undefined \u0441\u0442\u0430\u043D\u043E\u0432\u044F\u0442\u0441\u044F Personal; \u0438\u0441\u0445\u043E\u0434\u043D\u044B\u0435 wire DTO \u0441\u043E\u0445\u0440\u0430\u043D\u044F\u044E\u0442 \u044D\u0442\u0438 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u044F. Private \u043C\u043E\u0436\u043D\u043E \u0432\u0435\u0440\u043D\u0443\u0442\u044C \u043E\u0442\u0434\u0435\u043B\u044C\u043D\u044B\u043C \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u0435\u043C \u043F\u043E\u0441\u043B\u0435 \u043F\u043E\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0451\u043D\u043D\u043E\u0433\u043E \u0438\u0441\u043F\u0440\u0430\u0432\u043B\u0435\u043D\u0438\u044F \u0441\u0435\u0440\u0432\u0435\u0440\u0430, Undefined \u2014 \u043F\u043E \u043E\u0442\u0434\u0435\u043B\u044C\u043D\u043E\u043C\u0443 \u0440\u0435\u0448\u0435\u043D\u0438\u044E. \u041F\u0430\u0439\u043F `ttPublicityType` \u0438 \u043D\u0430\u0441\u0442\u0440\u043E\u0439\u043A\u0438 \u0441\u043E\u0437\u0434\u0430\u043D\u0438\u044F: Personal \u043F\u043E \u0443\u043C\u043E\u043B\u0447\u0430\u043D\u0438\u044E \u0432 \u0444\u043E\u0440\u043C\u0430\u0445; Link \u043F\u0440\u0438 \u0441\u043E\u0437\u0434\u0430\u043D\u0438\u0438 \u0434\u043E\u0447\u0435\u0440\u043D\u0435\u0433\u043E \u0440\u0435\u0441\u0443\u0440\u0441\u0430 \u043E\u0442 \u0440\u043E\u0434\u0438\u0442\u0435\u043B\u044F (\u0441\u043C. resource-item-business). \u0414\u043B\u044F \u043A\u0430\u0440\u0442\u043E\u0447\u0435\u043A \xAB\u0442\u043E\u043B\u044C\u043A\u043E \u043F\u043E \u0441\u0441\u044B\u043B\u043A\u0435\xBB \u0447\u0430\u0441\u0442\u043E \u0441\u043E\u0447\u0435\u0442\u0430\u0435\u0442\u0441\u044F \u0441 `anyoneAccess: Read` \u0438 \u043E\u0442\u043A\u043B\u044E\u0447\u0451\u043D\u043D\u044B\u043C \u043F\u043E\u0438\u0441\u043A\u043E\u043C (`searchMode: NoneSearchMode`). \u0422\u0435\u043A\u0441\u0442\u043E\u0432\u044B\u0439 **`client.search.*`** (contacts/notes/\u2026) \u0438\u043D\u0434\u0435\u043A\u0441\u0438\u0440\u0443\u0435\u0442 \u0442\u043E\u043B\u044C\u043A\u043E **`PublicAvailable`** / **`PublicWithRequest`**; \u0441\u043C\u0435\u043D\u0430 \u2014 **`updatePublicity`** (\u0441\u043C. **`docs/agents/participation-flow.md`** \xA73)."
   },
   searchMode: {
     description: "\u0423\u0447\u0430\u0441\u0442\u0438\u0435 \u044D\u043B\u0435\u043C\u0435\u043D\u0442\u0430 \u0432 \u043F\u043E\u0438\u0441\u043A\u0435/\u0432\u044B\u0434\u0430\u0447\u0435 (\u043A\u043E\u043D\u0442\u0440\u0430\u043A\u0442 API).",
@@ -638,7 +638,7 @@ var contactItemSpecificFieldDocs = mapFieldDocsToStrings(
 var noteSpecificFieldDocEntries = {
   publicityType: {
     ...torrowItemBaseFieldDocEntries.publicityType,
-    usage: "notes.create \u043F\u0440\u0438\u043D\u0438\u043C\u0430\u0435\u0442 publicityType \u0432 \u0438\u0441\u0445\u043E\u0434\u043D\u043E\u043C \u0442\u0435\u043B\u0435 (\u043D\u0430\u043F\u0440\u0438\u043C\u0435\u0440 Link); \u0431\u0435\u0437 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u044F \u0438\u0441\u043F\u043E\u043B\u044C\u0437\u0443\u0435\u0442\u0441\u044F Personal. \u0414\u043E\u043F\u043E\u043B\u043D\u0438\u0442\u0435\u043B\u044C\u043D\u044B\u0439 updatePublicity \u043F\u0440\u0438 \u0441\u043E\u0437\u0434\u0430\u043D\u0438\u0438 \u043D\u0435 \u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044F."
+    usage: "notes.create/update \u043F\u0440\u0438\u043D\u0438\u043C\u0430\u044E\u0442 \u0442\u043E\u043B\u044C\u043A\u043E Personal, PublicWithRequest, PublicAvailable \u0438 Link; \u0441\u0435\u0440\u0432\u0435\u0440\u043D\u044B\u0435 Private/Undefined \u043F\u0440\u0438 \u0447\u0442\u0435\u043D\u0438\u0438 \u0441\u0442\u0430\u043D\u043E\u0432\u044F\u0442\u0441\u044F Personal. notes.create \u043F\u0440\u0438\u043D\u0438\u043C\u0430\u0435\u0442 publicityType \u0432 \u0438\u0441\u0445\u043E\u0434\u043D\u043E\u043C \u0442\u0435\u043B\u0435 (\u043D\u0430\u043F\u0440\u0438\u043C\u0435\u0440 Link); \u0431\u0435\u0437 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u044F \u0438\u0441\u043F\u043E\u043B\u044C\u0437\u0443\u0435\u0442\u0441\u044F Personal. \u0414\u043E\u043F\u043E\u043B\u043D\u0438\u0442\u0435\u043B\u044C\u043D\u044B\u0439 updatePublicity \u043F\u0440\u0438 \u0441\u043E\u0437\u0434\u0430\u043D\u0438\u0438 \u043D\u0435 \u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044F."
   },
   meta: {
     ...torrowItemBaseFieldDocEntries.meta,
@@ -3831,7 +3831,7 @@ var itemDeleteQueryFieldDocs = mapFieldDocsToStrings(itemDeleteQueryFieldDocEntr
 // ../../src/field-docs/item-social-facet-field-docs.ts
 var torrowItemCoreFacadeSdkMethodFieldDocEntriesWithoutPhoto = {
   updatePublicity: {
-    description: "`PUT .../{torrowId}/publicity` \u2014 \u0442\u0435\u043B\u043E **`PublicityType`**; query **`versionToCheck`**, **`isNeedAnnouncement`**."
+    description: "`PUT .../{torrowId}/publicity` \u2014 \u0442\u0435\u043B\u043E **`PublicityType`** (Personal, PublicWithRequest, PublicAvailable, Link; Private/Undefined \u0438\u0441\u043A\u043B\u044E\u0447\u0435\u043D\u044B); query **`versionToCheck`**, **`isNeedAnnouncement`**."
   },
   updateImageId: {
     description: "`PUT .../{torrowId}/image/id` \u2014 \u0442\u0435\u043B\u043E JSON-string **`fileId`**."