@torrow/sdk-docs 0.3.0 → 0.5.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.
Files changed (3) hide show
  1. package/dist/index.js +21 -16
  2. package/dist/index.js.map +1 -1
  3. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -233,27 +233,27 @@ var contactItemSpecificFieldDocs = mapFieldDocsToStrings(
233
233
 
234
234
  // ../../src/field-docs/note-item.ts
235
235
  var noteSpecificFieldDocEntries = {
236
+ publicityType: {
237
+ ...torrowItemBaseFieldDocEntries.publicityType,
238
+ 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."
239
+ },
240
+ meta: {
241
+ ...torrowItemBaseFieldDocEntries.meta,
242
+ usage: "notes.update \u043F\u0440\u0438\u043D\u0438\u043C\u0430\u0435\u0442 meta.version \u0438\u0437 \u043F\u0440\u043E\u0447\u0438\u0442\u0430\u043D\u043D\u043E\u0439 \u0437\u0430\u043C\u0435\u0442\u043A\u0438 \u0432 \u0442\u0435\u043B\u0435 \u0437\u0430\u043F\u0440\u043E\u0441\u0430; \u0441\u0435\u0440\u0432\u0435\u0440 \u0438\u0441\u043F\u043E\u043B\u044C\u0437\u0443\u0435\u0442 \u0435\u0433\u043E \u0434\u043B\u044F \u043F\u0440\u043E\u0432\u0435\u0440\u043A\u0438 \u043A\u043E\u043D\u043A\u0443\u0440\u0438\u0440\u0443\u044E\u0449\u0438\u0445 \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u0439. SDK \u0441\u043E\u0445\u0440\u0430\u043D\u044F\u0435\u0442 \u043F\u0435\u0440\u0435\u0434\u0430\u043D\u043D\u044B\u0439 checkVersion \u0438 \u043D\u0435 \u043F\u043E\u0434\u0441\u0442\u0430\u0432\u043B\u044F\u0435\u0442 false. \u0414\u043B\u044F delete \u0432\u0435\u0440\u0441\u0438\u044F \u043F\u0435\u0440\u0435\u0434\u0430\u0451\u0442\u0441\u044F \u043A\u0430\u043A versionToCheck \u0432 query."
243
+ },
236
244
  noteType: {
237
- description: "\u0422\u0438\u043F \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0433\u043E \u0437\u0430\u043C\u0435\u0442\u043A\u0438; \u043E\u043F\u0440\u0435\u0434\u0435\u043B\u044F\u0435\u0442 \u0438\u043D\u0442\u0435\u0440\u043F\u0440\u0435\u0442\u0430\u0446\u0438\u044E \u043F\u043E\u043B\u044F data \u0438 UI.",
245
+ description: "\u0422\u0438\u043F \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0433\u043E \u0437\u0430\u043C\u0435\u0442\u043A\u0438. \u041F\u043E\u0434\u0434\u0435\u0440\u0436\u0438\u0432\u0430\u0435\u043C\u044B\u0435 \u0441\u0446\u0435\u043D\u0430\u0440\u0438\u0438 SDK: Html \u0438 Markdown; \u043E\u0441\u0442\u0430\u043B\u044C\u043D\u044B\u0435 \u0441\u0435\u0440\u0432\u0435\u0440\u043D\u044B\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u044F \u0441\u043E\u0445\u0440\u0430\u043D\u0435\u043D\u044B \u0434\u043B\u044F \u0441\u043E\u0432\u043C\u0435\u0441\u0442\u0438\u043C\u043E\u0441\u0442\u0438.",
238
246
  examples: [
239
- "Text",
240
247
  "Html",
241
- "Hlink",
242
- "File",
243
- "Photo",
244
- "Voice",
245
- "Geolocation",
246
- "Qr",
247
- "ServiceSpecification",
248
- "Unknown"
248
+ "Markdown"
249
249
  ],
250
250
  valueSchema: "NoteType",
251
- usage: "\u041A\u043E\u043C\u043F\u043E\u043D\u0435\u043D\u0442 note-info: \u043F\u0440\u0438 Text \u043F\u0440\u043E\u0432\u0435\u0440\u044F\u0435\u0442\u0441\u044F note.data; \u0434\u043B\u044F \u0444\u0430\u0439\u043B\u043E\u0432 \u2014 files[0]; imagePreviewSize \u0437\u0430\u0434\u0430\u0451\u0442 \u0441\u043B\u0430\u0439\u0434\u0435\u0440/\u0441\u043A\u0440\u044B\u0442\u0438\u0435 \u0444\u0430\u0439\u043B\u043E\u0432. \u0417\u0430\u043C\u0435\u0442\u043A\u0438 \u043D\u0430 \u043A\u0430\u0440\u0442\u043E\u0447\u043A\u0435 \u043A\u043E\u043D\u0442\u0430\u043A\u0442\u0430 \u0447\u0430\u0441\u0442\u043E \u043F\u043E\u043F\u0430\u0434\u0430\u044E\u0442 \u0432 \u043E\u0442\u0434\u0435\u043B\u044C\u043D\u044B\u0439 \u0431\u043B\u043E\u043A \u0440\u0430\u0441\u043A\u043B\u0430\u0434\u043A\u0438 \u0440\u043E\u0434\u0438\u0442\u0435\u043B\u044F (`ContactItem.solutionData.viewBlockSettings`, objectType \u0437\u0430\u043C\u0435\u0442\u043A\u0438 \u2014 \u0447\u0438\u0441\u043B\u043E\u0432\u043E\u0439 \u043A\u043E\u0434 \u0432 API)."
251
+ usage: "\u0414\u043B\u044F \u043D\u043E\u0432\u043E\u0433\u043E \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0433\u043E \u044F\u0432\u043D\u043E \u0437\u0430\u0434\u0430\u0432\u0430\u0439\u0442\u0435 Html \u0438\u043B\u0438 Markdown. \u0424\u0430\u0439\u043B\u044B \u043F\u0440\u0438\u043A\u043B\u0430\u0434\u044B\u0432\u0430\u044E\u0442\u0441\u044F \u0447\u0435\u0440\u0435\u0437 files \u043D\u0435\u0437\u0430\u0432\u0438\u0441\u0438\u043C\u043E \u043E\u0442 \u0444\u043E\u0440\u043C\u0430\u0442\u0430 \u0442\u0435\u043A\u0441\u0442\u0430; imagePreviewSize \u0437\u0430\u0434\u0430\u0451\u0442 \u043E\u0442\u043E\u0431\u0440\u0430\u0436\u0435\u043D\u0438\u0435 \u0432\u043B\u043E\u0436\u0435\u043D\u0438\u0439. \u0417\u0430\u043C\u0435\u0442\u043A\u0438 \u043D\u0430 \u043A\u0430\u0440\u0442\u043E\u0447\u043A\u0435 \u043A\u043E\u043D\u0442\u0430\u043A\u0442\u0430 \u043C\u043E\u0433\u0443\u0442 \u043F\u043E\u043F\u0430\u0434\u0430\u0442\u044C \u0432 \u043E\u0442\u0434\u0435\u043B\u044C\u043D\u044B\u0439 \u0431\u043B\u043E\u043A ContactItem.solutionData.viewBlockSettings."
252
252
  },
253
253
  data: {
254
- description: "\u041F\u043E\u043B\u0435\u0437\u043D\u0430\u044F \u043D\u0430\u0433\u0440\u0443\u0437\u043A\u0430: \u0441\u0442\u0440\u043E\u043A\u0430 HTML/\u0442\u0435\u043A\u0441\u0442\u0430, JSON \u0438\u043B\u0438 opaque \u0432 \u0437\u0430\u0432\u0438\u0441\u0438\u043C\u043E\u0441\u0442\u0438 \u043E\u0442 noteType (\u0442\u0438\u043F unknown \u0432 OpenAPI).",
255
- examples: ['"<p>\u0417\u0430\u043C\u0435\u0442\u043A\u0430</p>"', '"plain text"', "{}"],
256
- usage: "hasText \u0432 UI = !!note.data; \u0434\u043B\u044F Html/Text \u2014 \u043A\u043E\u043D\u0442\u0435\u043D\u0442 \u0440\u0435\u0434\u0430\u043A\u0442\u043E\u0440\u0430."
254
+ description: "\u0421\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0435: HTML-\u0441\u0442\u0440\u043E\u043A\u0430 \u0434\u043B\u044F Html, \u0438\u0441\u0445\u043E\u0434\u043D\u044B\u0439 Markdown \u0434\u043B\u044F Markdown (\u0442\u0438\u043F unknown \u0432 OpenAPI \u0441\u043E\u0445\u0440\u0430\u043D\u0451\u043D \u0434\u043B\u044F \u0441\u043E\u0432\u043C\u0435\u0441\u0442\u0438\u043C\u043E\u0441\u0442\u0438).",
255
+ examples: ['"<p>\u0417\u0430\u043C\u0435\u0442\u043A\u0430</p>"', '"# \u0417\u0430\u043C\u0435\u0442\u043A\u0430\\n\\n\u0422\u0435\u043A\u0441\u0442\\n"'],
256
+ usage: "SDK \u0441\u043E\u0445\u0440\u0430\u043D\u044F\u0435\u0442 \u0438\u0441\u0445\u043E\u0434\u043D\u0443\u044E \u0441\u0442\u0440\u043E\u043A\u0443, \u043F\u0440\u043E\u0431\u0435\u043B\u044B \u0438 \u043F\u0435\u0440\u0435\u043D\u043E\u0441\u044B \u0431\u0435\u0437 \u043F\u0440\u0435\u043E\u0431\u0440\u0430\u0437\u043E\u0432\u0430\u043D\u0438\u044F \u0440\u0430\u0437\u043C\u0435\u0442\u043A\u0438. \u0420\u0435\u043D\u0434\u0435\u0440\u0438\u043D\u0433 \u0438 \u043E\u0447\u0438\u0441\u0442\u043A\u0430 HTML \u043E\u0442\u043D\u043E\u0441\u044F\u0442\u0441\u044F \u043A \u043F\u0440\u0438\u043B\u043E\u0436\u0435\u043D\u0438\u044E."
257
257
  },
258
258
  files: {
259
259
  description: "\u0412\u043B\u043E\u0436\u0435\u043D\u043D\u044B\u0435 \u0444\u0430\u0439\u043B\u044B (\u043D\u0435 \u043E\u0441\u043D\u043E\u0432\u043D\u043E\u0435 image).",
@@ -4006,7 +4006,7 @@ var ENUM_VALUES = {
4006
4006
  "LastModifiedDescOrderDesc"
4007
4007
  ],
4008
4008
  LinkType: ["Unknown", "User", "Pinned", "Group"],
4009
- NoteType: ["Unknown", "Text", "Html", "Hlink", "File", "Photo", "Voice", "Geolocation", "Qr", "ServiceSpecification"],
4009
+ NoteType: ["Unknown", "Text", "Html", "Markdown", "Hlink", "File", "Photo", "Voice", "Geolocation", "Qr", "ServiceSpecification"],
4010
4010
  ObjectSortCondition: [
4011
4011
  "CreateDateAsc",
4012
4012
  "CreateDateDesc",
@@ -4605,6 +4605,11 @@ function getDetailedEnumValueDescription(enumName, value) {
4605
4605
  return `\u0417\u043D\u0430\u0447\u0435\u043D\u0438\u0435 \`${value}\` \u0432 enum \`${enumName}\` \u043E\u043F\u0440\u0435\u0434\u0435\u043B\u044F\u0435\u0442 \u0440\u0435\u0436\u0438\u043C/\u043A\u0430\u0442\u0435\u0433\u043E\u0440\u0438\u044E "${readableValue}" \u0432 \u0441\u043E\u043E\u0442\u0432\u0435\u0442\u0441\u0442\u0432\u0443\u044E\u0449\u0435\u043C API-\u0441\u0446\u0435\u043D\u0430\u0440\u0438\u0438.`;
4606
4606
  }
4607
4607
  function getEnumValueDescription(enumName, value) {
4608
+ if (enumName === "NoteType") {
4609
+ if (value === "Html") return "HTML-\u0437\u0430\u043C\u0435\u0442\u043A\u0430: data \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u0442 HTML-\u0441\u0442\u0440\u043E\u043A\u0443. \u041F\u043E\u0434\u0434\u0435\u0440\u0436\u0438\u0432\u0430\u0435\u043C\u044B\u0439 \u0441\u0446\u0435\u043D\u0430\u0440\u0438\u0439 SDK.";
4610
+ if (value === "Markdown") return "Markdown-\u0437\u0430\u043C\u0435\u0442\u043A\u0430: data \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u0442 \u0438\u0441\u0445\u043E\u0434\u043D\u044B\u0439 Markdown \u0441 \u0441\u043E\u0445\u0440\u0430\u043D\u0435\u043D\u0438\u0435\u043C \u043F\u0440\u043E\u0431\u0435\u043B\u043E\u0432 \u0438 \u043F\u0435\u0440\u0435\u043D\u043E\u0441\u043E\u0432. \u041F\u043E\u0434\u0434\u0435\u0440\u0436\u0438\u0432\u0430\u0435\u043C\u044B\u0439 \u0441\u0446\u0435\u043D\u0430\u0440\u0438\u0439 SDK.";
4611
+ return "\u0421\u0435\u0440\u0432\u0435\u0440\u043D\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 " + value + ": \u0441\u043E\u0445\u0440\u0430\u043D\u0435\u043D\u043E \u0434\u043B\u044F \u0441\u043E\u0432\u043C\u0435\u0441\u0442\u0438\u043C\u043E\u0441\u0442\u0438; \u0432\u043D\u0435 \u043F\u043E\u0434\u0434\u0435\u0440\u0436\u0438\u0432\u0430\u0435\u043C\u044B\u0445 \u0441\u0446\u0435\u043D\u0430\u0440\u0438\u0435\u0432 \u0441\u043E\u0437\u0434\u0430\u043D\u0438\u044F Html/Markdown.";
4612
+ }
4608
4613
  const explicitDescription = SIGNIFICANT_ENUM_VALUE_DESCRIPTIONS[enumName]?.[value];
4609
4614
  if (explicitDescription) {
4610
4615
  return explicitDescription;
@@ -4815,7 +4820,7 @@ var imagePreviewSizeFieldDocEntries = createEnumFieldDocEntries(
4815
4820
  var imagePreviewSizeFieldDocs = mapFieldDocsToStrings(imagePreviewSizeFieldDocEntries);
4816
4821
  var noteTypeFieldDocEntries = createEnumFieldDocEntries(
4817
4822
  "NoteType",
4818
- "\u0422\u0438\u043F \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0433\u043E \u0437\u0430\u043C\u0435\u0442\u043A\u0438."
4823
+ "\u0422\u0438\u043F \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0433\u043E \u0437\u0430\u043C\u0435\u0442\u043A\u0438. \u041F\u043E\u0434\u0434\u0435\u0440\u0436\u0438\u0432\u0430\u0435\u043C\u044B\u0435 \u0441\u0446\u0435\u043D\u0430\u0440\u0438\u0438: Html \u0438 Markdown; \u043E\u0441\u0442\u0430\u043B\u044C\u043D\u044B\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u044F \u2014 \u0441\u043E\u0432\u043C\u0435\u0441\u0442\u0438\u043C\u043E\u0441\u0442\u044C \u0441 \u0441\u0435\u0440\u0432\u0435\u0440\u043D\u044B\u043C \u043A\u043E\u043D\u0442\u0440\u0430\u043A\u0442\u043E\u043C."
4819
4824
  );
4820
4825
  var noteTypeFieldDocs = mapFieldDocsToStrings(noteTypeFieldDocEntries);
4821
4826
  var linkTypeFieldDocEntries = createEnumFieldDocEntries(