@wix/auto_sdk_comments_comments 1.0.1 → 1.0.3

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 (57) hide show
  1. package/build/cjs/src/comments-v2-comment-comments.context.d.ts +2 -2
  2. package/build/cjs/src/comments-v2-comment-comments.context.js +3 -2
  3. package/build/cjs/src/comments-v2-comment-comments.context.js.map +1 -1
  4. package/build/cjs/src/comments-v2-comment-comments.http.js +104 -98
  5. package/build/cjs/src/comments-v2-comment-comments.http.js.map +1 -1
  6. package/build/cjs/src/comments-v2-comment-comments.public.d.ts +1 -1
  7. package/build/cjs/src/comments-v2-comment-comments.public.js +3 -2
  8. package/build/cjs/src/comments-v2-comment-comments.public.js.map +1 -1
  9. package/build/cjs/src/comments-v2-comment-comments.types.d.ts +385 -78
  10. package/build/cjs/src/comments-v2-comment-comments.types.js +12 -1
  11. package/build/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
  12. package/build/cjs/src/comments-v2-comment-comments.universal.d.ts +413 -84
  13. package/build/cjs/src/comments-v2-comment-comments.universal.js +29 -18
  14. package/build/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
  15. package/build/es/src/comments-v2-comment-comments.context.d.ts +2 -2
  16. package/build/es/src/comments-v2-comment-comments.context.js +1 -1
  17. package/build/es/src/comments-v2-comment-comments.context.js.map +1 -1
  18. package/build/es/src/comments-v2-comment-comments.http.js +104 -98
  19. package/build/es/src/comments-v2-comment-comments.http.js.map +1 -1
  20. package/build/es/src/comments-v2-comment-comments.public.d.ts +1 -1
  21. package/build/es/src/comments-v2-comment-comments.public.js +1 -1
  22. package/build/es/src/comments-v2-comment-comments.public.js.map +1 -1
  23. package/build/es/src/comments-v2-comment-comments.types.d.ts +385 -78
  24. package/build/es/src/comments-v2-comment-comments.types.js +11 -0
  25. package/build/es/src/comments-v2-comment-comments.types.js.map +1 -1
  26. package/build/es/src/comments-v2-comment-comments.universal.d.ts +413 -84
  27. package/build/es/src/comments-v2-comment-comments.universal.js +27 -16
  28. package/build/es/src/comments-v2-comment-comments.universal.js.map +1 -1
  29. package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +2 -2
  30. package/build/internal/cjs/src/comments-v2-comment-comments.context.js +3 -2
  31. package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +1 -1
  32. package/build/internal/cjs/src/comments-v2-comment-comments.http.js +104 -98
  33. package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +1 -1
  34. package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +1 -1
  35. package/build/internal/cjs/src/comments-v2-comment-comments.public.js +3 -2
  36. package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +1 -1
  37. package/build/internal/cjs/src/comments-v2-comment-comments.types.d.ts +385 -78
  38. package/build/internal/cjs/src/comments-v2-comment-comments.types.js +12 -1
  39. package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
  40. package/build/internal/cjs/src/comments-v2-comment-comments.universal.d.ts +413 -84
  41. package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +29 -18
  42. package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
  43. package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +2 -2
  44. package/build/internal/es/src/comments-v2-comment-comments.context.js +1 -1
  45. package/build/internal/es/src/comments-v2-comment-comments.context.js.map +1 -1
  46. package/build/internal/es/src/comments-v2-comment-comments.http.js +104 -98
  47. package/build/internal/es/src/comments-v2-comment-comments.http.js.map +1 -1
  48. package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +1 -1
  49. package/build/internal/es/src/comments-v2-comment-comments.public.js +1 -1
  50. package/build/internal/es/src/comments-v2-comment-comments.public.js.map +1 -1
  51. package/build/internal/es/src/comments-v2-comment-comments.types.d.ts +385 -78
  52. package/build/internal/es/src/comments-v2-comment-comments.types.js +11 -0
  53. package/build/internal/es/src/comments-v2-comment-comments.types.js.map +1 -1
  54. package/build/internal/es/src/comments-v2-comment-comments.universal.d.ts +413 -84
  55. package/build/internal/es/src/comments-v2-comment-comments.universal.js +27 -16
  56. package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +1 -1
  57. package/package.json +2 -2
@@ -6,6 +6,7 @@
6
6
  export interface Comment {
7
7
  /**
8
8
  * Comment ID.
9
+ * @format GUID
9
10
  * @readonly
10
11
  */
11
12
  id?: string | null;
@@ -28,13 +29,19 @@ export interface Comment {
28
29
  * @readonly
29
30
  */
30
31
  updatedDate?: Date | null;
31
- /** ID of the app that the comment is added to. */
32
+ /**
33
+ * ID of the app that the comment is added to.
34
+ * @format GUID
35
+ * @immutable
36
+ */
32
37
  appId?: string | null;
33
38
  /**
34
39
  * ID of the specific context the comment is in response to.
35
40
  *
36
41
  * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
37
42
  * the `forumPostId` is used as both the `contextId` and the `resourceId`.
43
+ * @immutable
44
+ * @maxLength 128
38
45
  */
39
46
  contextId?: string | null;
40
47
  /**
@@ -42,11 +49,16 @@ export interface Comment {
42
49
  *
43
50
  * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
44
51
  * the `forumPostId` is used as both the `resourceId` and the `contextId`.
52
+ * @immutable
53
+ * @maxLength 128
45
54
  */
46
55
  resourceId?: string | null;
47
56
  /** Published comment content. */
48
57
  content?: CommentContent;
49
- /** Comment's author. */
58
+ /**
59
+ * Comment's author.
60
+ * @immutable
61
+ */
50
62
  author?: CommentAuthor;
51
63
  /**
52
64
  * Parent comment information.
@@ -83,7 +95,10 @@ export interface Comment {
83
95
  reactionSummary?: CommentReactionSummary;
84
96
  /** Whether the comment is marked. */
85
97
  marked?: boolean;
86
- /** Date and time when the comment was actually created. */
98
+ /**
99
+ * Date and time when the comment was actually created.
100
+ * @immutable
101
+ */
87
102
  commentDate?: Date | null;
88
103
  /**
89
104
  * Whether the comment has the updated content.
@@ -105,9 +120,13 @@ export interface CommentContent {
105
120
  * People to tag with this comment.
106
121
  *
107
122
  * People can include users, members, visitors, or groups.
123
+ * @maxSize 10
108
124
  */
109
125
  mentions?: Mention[];
110
- /** Content attachments. */
126
+ /**
127
+ * Content attachments.
128
+ * @maxSize 10
129
+ */
111
130
  attachments?: Attachment[];
112
131
  }
113
132
  export interface RichContent {
@@ -708,11 +727,20 @@ export interface GIFData {
708
727
  gifType?: GIFType;
709
728
  }
710
729
  export interface GIF {
711
- /** GIF format URL. */
730
+ /**
731
+ * GIF format URL.
732
+ * @format WEB_URL
733
+ */
712
734
  gif?: string | null;
713
- /** MP4 format URL. */
735
+ /**
736
+ * MP4 format URL.
737
+ * @format WEB_URL
738
+ */
714
739
  mp4?: string | null;
715
- /** Thumbnail URL. */
740
+ /**
741
+ * Thumbnail URL.
742
+ * @format WEB_URL
743
+ */
716
744
  still?: string | null;
717
745
  }
718
746
  export declare enum GIFType {
@@ -786,7 +814,10 @@ export interface ImageData {
786
814
  export interface StylesBorder {
787
815
  /** Border width in pixels. */
788
816
  width?: number | null;
789
- /** Border color. */
817
+ /**
818
+ * Border color as a hexadecimal value.
819
+ * @format COLOR_HEX
820
+ */
790
821
  color?: string | null;
791
822
  /** Border radius in pixels. */
792
823
  radius?: number | null;
@@ -808,6 +839,51 @@ export interface LinkPreviewData {
808
839
  description?: string | null;
809
840
  /** The preview content as HTML. */
810
841
  html?: string | null;
842
+ /** Styling for the link preview. */
843
+ styles?: LinkPreviewDataStyles;
844
+ }
845
+ export declare enum Position {
846
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
847
+ START = "START",
848
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
849
+ END = "END",
850
+ /** Thumbnail positioned at the top */
851
+ TOP = "TOP",
852
+ /** Thumbnail hidden and not displayed */
853
+ HIDDEN = "HIDDEN"
854
+ }
855
+ export interface LinkPreviewDataStyles {
856
+ /**
857
+ * Background color as a hexadecimal value.
858
+ * @format COLOR_HEX
859
+ */
860
+ backgroundColor?: string | null;
861
+ /**
862
+ * Title color as a hexadecimal value.
863
+ * @format COLOR_HEX
864
+ */
865
+ titleColor?: string | null;
866
+ /**
867
+ * Subtitle color as a hexadecimal value.
868
+ * @format COLOR_HEX
869
+ */
870
+ subtitleColor?: string | null;
871
+ /**
872
+ * Link color as a hexadecimal value.
873
+ * @format COLOR_HEX
874
+ */
875
+ linkColor?: string | null;
876
+ /** Border width in pixels. */
877
+ borderWidth?: number | null;
878
+ /** Border radius in pixels. */
879
+ borderRadius?: number | null;
880
+ /**
881
+ * Border color as a hexadecimal value.
882
+ * @format COLOR_HEX
883
+ */
884
+ borderColor?: string | null;
885
+ /** Position of thumbnail. Defaults to `START`. */
886
+ thumbnailPosition?: Position;
811
887
  }
812
888
  export interface MapData {
813
889
  /** Styling for the map's container. */
@@ -940,13 +1016,22 @@ export declare enum BackgroundType {
940
1016
  export interface Gradient {
941
1017
  /** The gradient angle in degrees. */
942
1018
  angle?: number | null;
943
- /** The start color as a hexademical value. */
1019
+ /**
1020
+ * The start color as a hexademical value.
1021
+ * @format COLOR_HEX
1022
+ */
944
1023
  startColor?: string | null;
945
- /** The end color as a hexademical value. */
1024
+ /**
1025
+ * The end color as a hexademical value.
1026
+ * @format COLOR_HEX
1027
+ */
946
1028
  lastColor?: string | null;
947
1029
  }
948
1030
  export interface Background extends BackgroundBackgroundOneOf {
949
- /** The background color as a hexademical value. */
1031
+ /**
1032
+ * The background color as a hexademical value.
1033
+ * @format COLOR_HEX
1034
+ */
950
1035
  color?: string | null;
951
1036
  /** An image to use for the background. */
952
1037
  image?: Media;
@@ -957,7 +1042,10 @@ export interface Background extends BackgroundBackgroundOneOf {
957
1042
  }
958
1043
  /** @oneof */
959
1044
  export interface BackgroundBackgroundOneOf {
960
- /** The background color as a hexademical value. */
1045
+ /**
1046
+ * The background color as a hexademical value.
1047
+ * @format COLOR_HEX
1048
+ */
961
1049
  color?: string | null;
962
1050
  /** An image to use for the background. */
963
1051
  image?: Media;
@@ -1269,17 +1357,32 @@ export declare enum VerticalAlignment {
1269
1357
  export interface CellStyle {
1270
1358
  /** Vertical alignment for the cell's text. */
1271
1359
  verticalAlignment?: VerticalAlignment;
1272
- /** Cell background color as a hexadecimal value. */
1360
+ /**
1361
+ * Cell background color as a hexadecimal value.
1362
+ * @format COLOR_HEX
1363
+ */
1273
1364
  backgroundColor?: string | null;
1274
1365
  }
1275
1366
  export interface BorderColors {
1276
- /** Left border color as a hexadecimal value. */
1367
+ /**
1368
+ * Left border color as a hexadecimal value.
1369
+ * @format COLOR_HEX
1370
+ */
1277
1371
  left?: string | null;
1278
- /** Right border color as a hexadecimal value. */
1372
+ /**
1373
+ * Right border color as a hexadecimal value.
1374
+ * @format COLOR_HEX
1375
+ */
1279
1376
  right?: string | null;
1280
- /** Top border color as a hexadecimal value. */
1377
+ /**
1378
+ * Top border color as a hexadecimal value.
1379
+ * @format COLOR_HEX
1380
+ */
1281
1381
  top?: string | null;
1282
- /** Bottom border color as a hexadecimal value. */
1382
+ /**
1383
+ * Bottom border color as a hexadecimal value.
1384
+ * @format COLOR_HEX
1385
+ */
1283
1386
  bottom?: string | null;
1284
1387
  }
1285
1388
  /**
@@ -1388,24 +1491,48 @@ export interface TextNodeStyle {
1388
1491
  lineHeight?: string | null;
1389
1492
  }
1390
1493
  export interface Mention extends MentionIdentityOneOf {
1391
- /** Wix user ID. */
1494
+ /**
1495
+ * Wix user ID.
1496
+ * @format GUID
1497
+ */
1392
1498
  userId?: string | null;
1393
- /** Member ID. See the Members API for more details. */
1499
+ /**
1500
+ * Member ID. See the Members API for more details.
1501
+ * @format GUID
1502
+ */
1394
1503
  memberId?: string | null;
1395
- /** Visitor ID. */
1504
+ /**
1505
+ * Visitor ID.
1506
+ * @format GUID
1507
+ */
1396
1508
  visitorId?: string | null;
1397
- /** Group ID. See the Groups API for more details. */
1509
+ /**
1510
+ * Group ID. See the Groups API for more details.
1511
+ * @format GUID
1512
+ */
1398
1513
  groupId?: string | null;
1399
1514
  }
1400
1515
  /** @oneof */
1401
1516
  export interface MentionIdentityOneOf {
1402
- /** Wix user ID. */
1517
+ /**
1518
+ * Wix user ID.
1519
+ * @format GUID
1520
+ */
1403
1521
  userId?: string | null;
1404
- /** Member ID. See the Members API for more details. */
1522
+ /**
1523
+ * Member ID. See the Members API for more details.
1524
+ * @format GUID
1525
+ */
1405
1526
  memberId?: string | null;
1406
- /** Visitor ID. */
1527
+ /**
1528
+ * Visitor ID.
1529
+ * @format GUID
1530
+ */
1407
1531
  visitorId?: string | null;
1408
- /** Group ID. See the Groups API for more details. */
1532
+ /**
1533
+ * Group ID. See the Groups API for more details.
1534
+ * @format GUID
1535
+ */
1409
1536
  groupId?: string | null;
1410
1537
  }
1411
1538
  export interface Attachment extends AttachmentMediaOneOf {
@@ -1417,7 +1544,10 @@ export interface Attachment extends AttachmentMediaOneOf {
1417
1544
  audio?: Audio;
1418
1545
  /** Information about the document. */
1419
1546
  document?: Document;
1420
- /** Mime type of attachment. */
1547
+ /**
1548
+ * Mime type of attachment.
1549
+ * @maxLength 3000
1550
+ */
1421
1551
  mimeType?: string | null;
1422
1552
  }
1423
1553
  /** @oneof */
@@ -1464,6 +1594,7 @@ export interface Image {
1464
1594
  /**
1465
1595
  * Image size in bytes.
1466
1596
  * @readonly
1597
+ * @format DECIMAL_VALUE
1467
1598
  */
1468
1599
  sizeInBytes?: string | null;
1469
1600
  }
@@ -1475,6 +1606,7 @@ export interface VideoV2 {
1475
1606
  /**
1476
1607
  * Available resolutions for the video, starting with the optimal resolution.
1477
1608
  * @readonly
1609
+ * @maxSize 100
1478
1610
  */
1479
1611
  resolutions?: VideoResolution[];
1480
1612
  /**
@@ -1490,6 +1622,7 @@ export interface VideoV2 {
1490
1622
  /**
1491
1623
  * Original video size in bytes.
1492
1624
  * @readonly
1625
+ * @format DECIMAL_VALUE
1493
1626
  */
1494
1627
  sizeInBytes?: string | null;
1495
1628
  /**
@@ -1550,6 +1683,7 @@ export interface Audio {
1550
1683
  /**
1551
1684
  * Audio size in bytes.
1552
1685
  * @readonly
1686
+ * @format DECIMAL_VALUE
1553
1687
  */
1554
1688
  sizeInBytes?: string | null;
1555
1689
  /**
@@ -1600,6 +1734,7 @@ export interface Document {
1600
1734
  /**
1601
1735
  * Document size in bytes.
1602
1736
  * @readonly
1737
+ * @format DECIMAL_VALUE
1603
1738
  */
1604
1739
  sizeInBytes?: string | null;
1605
1740
  /**
@@ -1609,45 +1744,91 @@ export interface Document {
1609
1744
  filename?: string | null;
1610
1745
  }
1611
1746
  export interface ContentAuthor extends ContentAuthorAuthorOneOf {
1612
- /** Wix user ID. */
1747
+ /**
1748
+ * Wix user ID.
1749
+ * @format GUID
1750
+ */
1613
1751
  userId?: string | null;
1614
- /** Member ID. See the Members API for more details. */
1752
+ /**
1753
+ * Member ID. See the Members API for more details.
1754
+ * @format GUID
1755
+ */
1615
1756
  memberId?: string | null;
1616
- /** Visitor ID. */
1757
+ /**
1758
+ * Visitor ID.
1759
+ * @format GUID
1760
+ */
1617
1761
  visitorId?: string | null;
1618
- /** Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance). */
1762
+ /**
1763
+ * Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance).
1764
+ * @format GUID
1765
+ */
1619
1766
  appId?: string | null;
1620
1767
  }
1621
1768
  /** @oneof */
1622
1769
  export interface ContentAuthorAuthorOneOf {
1623
- /** Wix user ID. */
1770
+ /**
1771
+ * Wix user ID.
1772
+ * @format GUID
1773
+ */
1624
1774
  userId?: string | null;
1625
- /** Member ID. See the Members API for more details. */
1775
+ /**
1776
+ * Member ID. See the Members API for more details.
1777
+ * @format GUID
1778
+ */
1626
1779
  memberId?: string | null;
1627
- /** Visitor ID. */
1780
+ /**
1781
+ * Visitor ID.
1782
+ * @format GUID
1783
+ */
1628
1784
  visitorId?: string | null;
1629
- /** Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance). */
1785
+ /**
1786
+ * Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance).
1787
+ * @format GUID
1788
+ */
1630
1789
  appId?: string | null;
1631
1790
  }
1632
1791
  export interface CommentAuthor extends CommentAuthorIdentityOneOf {
1633
- /** Wix user ID. */
1792
+ /**
1793
+ * Wix user ID.
1794
+ * @format GUID
1795
+ */
1634
1796
  userId?: string | null;
1635
- /** Member ID. See the Members API for more details. */
1797
+ /**
1798
+ * Member ID. See the Members API for more details.
1799
+ * @format GUID
1800
+ */
1636
1801
  memberId?: string | null;
1637
- /** Visitor ID. */
1802
+ /**
1803
+ * Visitor ID.
1804
+ * @format GUID
1805
+ */
1638
1806
  visitorId?: string | null;
1639
1807
  }
1640
1808
  /** @oneof */
1641
1809
  export interface CommentAuthorIdentityOneOf {
1642
- /** Wix user ID. */
1810
+ /**
1811
+ * Wix user ID.
1812
+ * @format GUID
1813
+ */
1643
1814
  userId?: string | null;
1644
- /** Member ID. See the Members API for more details. */
1815
+ /**
1816
+ * Member ID. See the Members API for more details.
1817
+ * @format GUID
1818
+ */
1645
1819
  memberId?: string | null;
1646
- /** Visitor ID. */
1820
+ /**
1821
+ * Visitor ID.
1822
+ * @format GUID
1823
+ */
1647
1824
  visitorId?: string | null;
1648
1825
  }
1649
1826
  export interface ParentComment {
1650
- /** Comment ID of the parent comment. */
1827
+ /**
1828
+ * Comment ID of the parent comment.
1829
+ * @format GUID
1830
+ * @immutable
1831
+ */
1651
1832
  id?: string | null;
1652
1833
  /**
1653
1834
  * Author of the parent comment.
@@ -1704,9 +1885,15 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
1704
1885
  versionedUpdate?: VersionedDocumentUpdateOperation;
1705
1886
  /** delete by document ids with versioning */
1706
1887
  versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1707
- /** type of the documents */
1888
+ /**
1889
+ * type of the documents
1890
+ * @minLength 2
1891
+ */
1708
1892
  documentType?: string;
1709
- /** language of the documents (mandatory) */
1893
+ /**
1894
+ * language of the documents (mandatory)
1895
+ * @minLength 2
1896
+ */
1710
1897
  language?: string | null;
1711
1898
  /**
1712
1899
  * one or more search documents
@@ -1833,7 +2020,10 @@ export interface ResourceCommentCountChanged {
1833
2020
  publishedCommentCount?: number;
1834
2021
  }
1835
2022
  export interface GetCommentRequest {
1836
- /** ID of the comment to retrieve. */
2023
+ /**
2024
+ * ID of the comment to retrieve.
2025
+ * @format GUID
2026
+ */
1837
2027
  commentId: string;
1838
2028
  }
1839
2029
  export interface GetCommentResponse {
@@ -1858,7 +2048,10 @@ export interface CommentContentChanged {
1858
2048
  currentContent?: CommentContent;
1859
2049
  }
1860
2050
  export interface DeleteCommentRequest {
1861
- /** ID of the comment to delete. */
2051
+ /**
2052
+ * ID of the comment to delete.
2053
+ * @format GUID
2054
+ */
1862
2055
  commentId: string;
1863
2056
  }
1864
2057
  export interface DeleteCommentResponse {
@@ -1867,7 +2060,10 @@ export interface CommentDeleted {
1867
2060
  comment?: Comment;
1868
2061
  }
1869
2062
  export interface ModerateDraftContentRequest {
1870
- /** ID of the comment to moderate. */
2063
+ /**
2064
+ * ID of the comment to moderate.
2065
+ * @format GUID
2066
+ */
1871
2067
  commentId: string;
1872
2068
  /**
1873
2069
  * Revision number, which increments by `1` each time the comment is updated.
@@ -1892,7 +2088,10 @@ export interface CommentHidden {
1892
2088
  comment?: Comment;
1893
2089
  }
1894
2090
  export interface QueryCommentsRequest {
1895
- /** App ID to query comments for. */
2091
+ /**
2092
+ * App ID to query comments for.
2093
+ * @format GUID
2094
+ */
1896
2095
  appId: string;
1897
2096
  /** Query options. */
1898
2097
  query: CursorQuery;
@@ -1914,6 +2113,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1914
2113
  * Sort object.
1915
2114
  *
1916
2115
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2116
+ * @maxSize 5
1917
2117
  */
1918
2118
  sort?: Sorting[];
1919
2119
  }
@@ -1927,7 +2127,10 @@ export interface CursorQueryPagingMethodOneOf {
1927
2127
  cursorPaging?: CursorPaging;
1928
2128
  }
1929
2129
  export interface Sorting {
1930
- /** Name of the field to sort by. */
2130
+ /**
2131
+ * Name of the field to sort by.
2132
+ * @maxLength 512
2133
+ */
1931
2134
  fieldName?: string;
1932
2135
  /** Sort order. */
1933
2136
  order?: SortOrder;
@@ -1937,13 +2140,17 @@ export declare enum SortOrder {
1937
2140
  DESC = "DESC"
1938
2141
  }
1939
2142
  export interface CursorPaging {
1940
- /** Maximum number of items to return in the results. */
2143
+ /**
2144
+ * Maximum number of items to return in the results.
2145
+ * @max 100
2146
+ */
1941
2147
  limit?: number | null;
1942
2148
  /**
1943
2149
  * Pointer to the next or previous page in the list of results.
1944
2150
  *
1945
2151
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1946
2152
  * Not relevant for the first request.
2153
+ * @maxLength 16000
1947
2154
  */
1948
2155
  cursor?: string | null;
1949
2156
  }
@@ -1967,13 +2174,22 @@ export interface CursorPagingMetadata {
1967
2174
  hasNext?: boolean | null;
1968
2175
  }
1969
2176
  export interface Cursors {
1970
- /** Cursor string pointing to the next page in the list of results. */
2177
+ /**
2178
+ * Cursor string pointing to the next page in the list of results.
2179
+ * @maxLength 16000
2180
+ */
1971
2181
  next?: string | null;
1972
- /** Cursor pointing to the previous page in the list of results. */
2182
+ /**
2183
+ * Cursor pointing to the previous page in the list of results.
2184
+ * @maxLength 16000
2185
+ */
1973
2186
  prev?: string | null;
1974
2187
  }
1975
2188
  export interface MarkCommentRequest {
1976
- /** ID of the comment to mark. */
2189
+ /**
2190
+ * ID of the comment to mark.
2191
+ * @format GUID
2192
+ */
1977
2193
  commentId: string;
1978
2194
  }
1979
2195
  export interface MarkCommentResponse {
@@ -1984,7 +2200,10 @@ export interface CommentMarked {
1984
2200
  comment?: Comment;
1985
2201
  }
1986
2202
  export interface UnmarkCommentRequest {
1987
- /** ID of the comment to unmark. */
2203
+ /**
2204
+ * ID of the comment to unmark.
2205
+ * @format GUID
2206
+ */
1988
2207
  commentId: string;
1989
2208
  }
1990
2209
  export interface UnmarkCommentResponse {
@@ -1995,7 +2214,10 @@ export interface CommentUnmarked {
1995
2214
  comment?: Comment;
1996
2215
  }
1997
2216
  export interface HideCommentRequest {
1998
- /** ID of the comment to hide. */
2217
+ /**
2218
+ * ID of the comment to hide.
2219
+ * @format GUID
2220
+ */
1999
2221
  commentId: string;
2000
2222
  }
2001
2223
  export interface HideCommentResponse {
@@ -2003,7 +2225,10 @@ export interface HideCommentResponse {
2003
2225
  comment?: Comment;
2004
2226
  }
2005
2227
  export interface PublishCommentRequest {
2006
- /** ID of the comment to publish. */
2228
+ /**
2229
+ * ID of the comment to publish.
2230
+ * @format GUID
2231
+ */
2007
2232
  commentId: string;
2008
2233
  }
2009
2234
  export interface PublishCommentResponse {
@@ -2012,7 +2237,10 @@ export interface PublishCommentResponse {
2012
2237
  }
2013
2238
  /** Count comments options. */
2014
2239
  export interface CountCommentsRequest {
2015
- /** App ID to count the comments of. */
2240
+ /**
2241
+ * App ID to count the comments of.
2242
+ * @format GUID
2243
+ */
2016
2244
  appId?: string;
2017
2245
  /** Filter to identify the comments that need to be counted. */
2018
2246
  filter?: Record<string, any> | null;
@@ -2022,20 +2250,28 @@ export interface CountCommentsResponse {
2022
2250
  count?: number;
2023
2251
  }
2024
2252
  export interface ListCommentsByResourceRequest {
2025
- /** ID of the app from which the comments are listed. */
2253
+ /**
2254
+ * ID of the app from which the comments are listed.
2255
+ * @format GUID
2256
+ */
2026
2257
  appId: string;
2027
2258
  /**
2028
2259
  * ID of the specific context the comment is in response to.
2029
2260
  *
2030
2261
  * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum, the `forumPostId` is used as both the `contextId` and the `resourceId`.
2262
+ * @maxLength 128
2031
2263
  */
2032
2264
  contextId: string;
2033
- /** Reserved for internal use. */
2265
+ /**
2266
+ * Reserved for internal use.
2267
+ * @maxLength 128
2268
+ */
2034
2269
  contextType?: string;
2035
2270
  /**
2036
2271
  * ID of the specific resource that the comment is in response to.
2037
2272
  *
2038
2273
  * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum, the `forumPostId` is used as both the `resourceId` and the `contextId`.
2274
+ * @maxLength 128
2039
2275
  */
2040
2276
  resourceId: string;
2041
2277
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -2098,9 +2334,16 @@ export declare enum ReplySortOrder {
2098
2334
  export interface ListCommentsByResourceCursorPaging {
2099
2335
  /** Pointer to the next or previous page in the list of results. */
2100
2336
  cursor?: string | null;
2101
- /** Number of items to return. */
2337
+ /**
2338
+ * Number of items to return.
2339
+ * @min 1
2340
+ * @max 100
2341
+ */
2102
2342
  limit?: number | null;
2103
- /** Maximum number of replies in a response. Only applicable to parent comments. */
2343
+ /**
2344
+ * Maximum number of replies in a response. Only applicable to parent comments.
2345
+ * @max 100
2346
+ */
2104
2347
  repliesLimit?: number | null;
2105
2348
  }
2106
2349
  export interface ListCommentsByResourceResponse {
@@ -2120,11 +2363,15 @@ export interface RepliesListResponse {
2120
2363
  export interface GetCommentThreadRequest {
2121
2364
  /**
2122
2365
  * App ID.
2366
+ * @maxLength 128
2123
2367
  * @deprecated App ID.
2124
2368
  * @targetRemovalDate 2024-11-01
2125
2369
  */
2126
2370
  appId?: string;
2127
- /** Comment ID. */
2371
+ /**
2372
+ * Comment ID.
2373
+ * @format GUID
2374
+ */
2128
2375
  commentId: string;
2129
2376
  /** Comment sorting. */
2130
2377
  commentSort?: CommentSort;
@@ -2140,7 +2387,10 @@ export interface GetCommentThreadResponse {
2140
2387
  commentReplies?: Record<string, RepliesListResponse>;
2141
2388
  }
2142
2389
  export interface BulkPublishCommentRequest {
2143
- /** ID of the app where to publish the comment. */
2390
+ /**
2391
+ * ID of the app where to publish the comment.
2392
+ * @format GUID
2393
+ */
2144
2394
  appId: string;
2145
2395
  /** Filter to identify the comments that need to be published. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
2146
2396
  filter: Record<string, any> | null;
@@ -2150,11 +2400,15 @@ export interface BulkPublishCommentResponse {
2150
2400
  * Job ID.
2151
2401
  *
2152
2402
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2403
+ * @format GUID
2153
2404
  */
2154
2405
  jobId?: string;
2155
2406
  }
2156
2407
  export interface BulkHideCommentRequest {
2157
- /** ID of the app where to hide the comments. */
2408
+ /**
2409
+ * ID of the app where to hide the comments.
2410
+ * @format GUID
2411
+ */
2158
2412
  appId: string;
2159
2413
  /** Filter to identify the comments that need to be hidden. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
2160
2414
  filter: Record<string, any> | null;
@@ -2164,11 +2418,15 @@ export interface BulkHideCommentResponse {
2164
2418
  * Job ID.
2165
2419
  *
2166
2420
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2421
+ * @format GUID
2167
2422
  */
2168
2423
  jobId?: string;
2169
2424
  }
2170
2425
  export interface BulkDeleteCommentRequest {
2171
- /** ID of the app where to delete the comments. */
2426
+ /**
2427
+ * ID of the app where to delete the comments.
2428
+ * @format GUID
2429
+ */
2172
2430
  appId: string;
2173
2431
  /** Filter to identify the comments that need to be deleted. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
2174
2432
  filter: Record<string, any> | null;
@@ -2178,11 +2436,15 @@ export interface BulkDeleteCommentResponse {
2178
2436
  * Job ID.
2179
2437
  *
2180
2438
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2439
+ * @format GUID
2181
2440
  */
2182
2441
  jobId?: string;
2183
2442
  }
2184
2443
  export interface BulkModerateDraftContentRequest {
2185
- /** ID of the app where to moderate the comments. */
2444
+ /**
2445
+ * ID of the app where to moderate the comments.
2446
+ * @format GUID
2447
+ */
2186
2448
  appId: string;
2187
2449
  /** Filter to identify the comment content that needs to be moderated. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
2188
2450
  filter: Record<string, any> | null;
@@ -2194,11 +2456,15 @@ export interface BulkModerateDraftContentResponse {
2194
2456
  * Job ID.
2195
2457
  *
2196
2458
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2459
+ * @format GUID
2197
2460
  */
2198
2461
  jobId?: string;
2199
2462
  }
2200
2463
  export interface BulkMoveCommentByFilterRequest {
2201
- /** ID of the app from which to move the comments. */
2464
+ /**
2465
+ * ID of the app from which to move the comments.
2466
+ * @format GUID
2467
+ */
2202
2468
  appId: string;
2203
2469
  /** Filter to identify the comments that need to be moved. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
2204
2470
  filter: Record<string, any> | null;
@@ -2206,9 +2472,15 @@ export interface BulkMoveCommentByFilterRequest {
2206
2472
  destination?: Destination;
2207
2473
  }
2208
2474
  export interface Destination {
2209
- /** Context ID of where to move the comment to. */
2475
+ /**
2476
+ * Context ID of where to move the comment to.
2477
+ * @maxLength 128
2478
+ */
2210
2479
  contextId?: string;
2211
- /** Resource ID of where to move the comment to. */
2480
+ /**
2481
+ * Resource ID of where to move the comment to.
2482
+ * @maxLength 128
2483
+ */
2212
2484
  resourceId?: string;
2213
2485
  }
2214
2486
  export interface BulkMoveCommentByFilterResponse {
@@ -2216,6 +2488,7 @@ export interface BulkMoveCommentByFilterResponse {
2216
2488
  * Job ID.
2217
2489
  *
2218
2490
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2491
+ * @format GUID
2219
2492
  */
2220
2493
  jobId?: string;
2221
2494
  }
@@ -2296,9 +2569,15 @@ export interface ActionEvent {
2296
2569
  bodyAsJson?: string;
2297
2570
  }
2298
2571
  export interface MessageEnvelope {
2299
- /** App instance ID. */
2572
+ /**
2573
+ * App instance ID.
2574
+ * @format GUID
2575
+ */
2300
2576
  instanceId?: string | null;
2301
- /** Event type. */
2577
+ /**
2578
+ * Event type.
2579
+ * @maxLength 150
2580
+ */
2302
2581
  eventType?: string;
2303
2582
  /** The identification type and identity data. */
2304
2583
  identity?: IdentificationData;
@@ -2306,26 +2585,50 @@ export interface MessageEnvelope {
2306
2585
  data?: string;
2307
2586
  }
2308
2587
  export interface IdentificationData extends IdentificationDataIdOneOf {
2309
- /** ID of a site visitor that has not logged in to the site. */
2588
+ /**
2589
+ * ID of a site visitor that has not logged in to the site.
2590
+ * @format GUID
2591
+ */
2310
2592
  anonymousVisitorId?: string;
2311
- /** ID of a site visitor that has logged in to the site. */
2593
+ /**
2594
+ * ID of a site visitor that has logged in to the site.
2595
+ * @format GUID
2596
+ */
2312
2597
  memberId?: string;
2313
- /** ID of a Wix user (site owner, contributor, etc.). */
2598
+ /**
2599
+ * ID of a Wix user (site owner, contributor, etc.).
2600
+ * @format GUID
2601
+ */
2314
2602
  wixUserId?: string;
2315
- /** ID of an app. */
2603
+ /**
2604
+ * ID of an app.
2605
+ * @format GUID
2606
+ */
2316
2607
  appId?: string;
2317
2608
  /** @readonly */
2318
2609
  identityType?: WebhookIdentityType;
2319
2610
  }
2320
2611
  /** @oneof */
2321
2612
  export interface IdentificationDataIdOneOf {
2322
- /** ID of a site visitor that has not logged in to the site. */
2613
+ /**
2614
+ * ID of a site visitor that has not logged in to the site.
2615
+ * @format GUID
2616
+ */
2323
2617
  anonymousVisitorId?: string;
2324
- /** ID of a site visitor that has logged in to the site. */
2618
+ /**
2619
+ * ID of a site visitor that has logged in to the site.
2620
+ * @format GUID
2621
+ */
2325
2622
  memberId?: string;
2326
- /** ID of a Wix user (site owner, contributor, etc.). */
2623
+ /**
2624
+ * ID of a Wix user (site owner, contributor, etc.).
2625
+ * @format GUID
2626
+ */
2327
2627
  wixUserId?: string;
2328
- /** ID of an app. */
2628
+ /**
2629
+ * ID of an app.
2630
+ * @format GUID
2631
+ */
2329
2632
  appId?: string;
2330
2633
  }
2331
2634
  export declare enum WebhookIdentityType {
@@ -2417,9 +2720,13 @@ interface ImageDataNonNullableFields {
2417
2720
  containerData?: PluginContainerDataNonNullableFields;
2418
2721
  link?: LinkNonNullableFields;
2419
2722
  }
2723
+ interface LinkPreviewDataStylesNonNullableFields {
2724
+ thumbnailPosition: Position;
2725
+ }
2420
2726
  interface LinkPreviewDataNonNullableFields {
2421
2727
  containerData?: PluginContainerDataNonNullableFields;
2422
2728
  link?: LinkNonNullableFields;
2729
+ styles?: LinkPreviewDataStylesNonNullableFields;
2423
2730
  }
2424
2731
  interface MapSettingsNonNullableFields {
2425
2732
  mapType: MapType;