@wix/auto_sdk_comments_comments 1.0.0 → 1.0.2

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 (29) hide show
  1. package/build/cjs/src/comments-v2-comment-comments.context.d.ts +1 -1
  2. package/build/cjs/src/comments-v2-comment-comments.public.d.ts +1 -1
  3. package/build/cjs/src/comments-v2-comment-comments.public.js.map +1 -1
  4. package/build/cjs/src/comments-v2-comment-comments.types.d.ts +351 -77
  5. package/build/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
  6. package/build/cjs/src/comments-v2-comment-comments.universal.d.ts +397 -83
  7. package/build/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
  8. package/build/es/src/comments-v2-comment-comments.context.d.ts +1 -1
  9. package/build/es/src/comments-v2-comment-comments.public.d.ts +1 -1
  10. package/build/es/src/comments-v2-comment-comments.public.js.map +1 -1
  11. package/build/es/src/comments-v2-comment-comments.types.d.ts +351 -77
  12. package/build/es/src/comments-v2-comment-comments.types.js.map +1 -1
  13. package/build/es/src/comments-v2-comment-comments.universal.d.ts +397 -83
  14. package/build/es/src/comments-v2-comment-comments.universal.js.map +1 -1
  15. package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +1 -1
  16. package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +1 -1
  17. package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +1 -1
  18. package/build/internal/cjs/src/comments-v2-comment-comments.types.d.ts +351 -77
  19. package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
  20. package/build/internal/cjs/src/comments-v2-comment-comments.universal.d.ts +397 -83
  21. package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
  22. package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +1 -1
  23. package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +1 -1
  24. package/build/internal/es/src/comments-v2-comment-comments.public.js.map +1 -1
  25. package/build/internal/es/src/comments-v2-comment-comments.types.d.ts +351 -77
  26. package/build/internal/es/src/comments-v2-comment-comments.types.js.map +1 -1
  27. package/build/internal/es/src/comments-v2-comment-comments.universal.d.ts +397 -83
  28. package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +1 -1
  29. 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 {
@@ -778,6 +806,25 @@ export interface ImageData {
778
806
  caption?: string | null;
779
807
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
780
808
  disableDownload?: boolean | null;
809
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
810
+ decorative?: boolean | null;
811
+ /** Styling for the image. */
812
+ styles?: ImageDataStyles;
813
+ }
814
+ export interface StylesBorder {
815
+ /** Border width in pixels. */
816
+ width?: number | null;
817
+ /**
818
+ * Border color as a hexadecimal value.
819
+ * @format COLOR_HEX
820
+ */
821
+ color?: string | null;
822
+ /** Border radius in pixels. */
823
+ radius?: number | null;
824
+ }
825
+ export interface ImageDataStyles {
826
+ /** Border attributes. */
827
+ border?: StylesBorder;
781
828
  }
782
829
  export interface LinkPreviewData {
783
830
  /** Styling for the link preview's container. */
@@ -924,13 +971,22 @@ export declare enum BackgroundType {
924
971
  export interface Gradient {
925
972
  /** The gradient angle in degrees. */
926
973
  angle?: number | null;
927
- /** The start color as a hexademical value. */
974
+ /**
975
+ * The start color as a hexademical value.
976
+ * @format COLOR_HEX
977
+ */
928
978
  startColor?: string | null;
929
- /** The end color as a hexademical value. */
979
+ /**
980
+ * The end color as a hexademical value.
981
+ * @format COLOR_HEX
982
+ */
930
983
  lastColor?: string | null;
931
984
  }
932
985
  export interface Background extends BackgroundBackgroundOneOf {
933
- /** The background color as a hexademical value. */
986
+ /**
987
+ * The background color as a hexademical value.
988
+ * @format COLOR_HEX
989
+ */
934
990
  color?: string | null;
935
991
  /** An image to use for the background. */
936
992
  image?: Media;
@@ -941,7 +997,10 @@ export interface Background extends BackgroundBackgroundOneOf {
941
997
  }
942
998
  /** @oneof */
943
999
  export interface BackgroundBackgroundOneOf {
944
- /** The background color as a hexademical value. */
1000
+ /**
1001
+ * The background color as a hexademical value.
1002
+ * @format COLOR_HEX
1003
+ */
945
1004
  color?: string | null;
946
1005
  /** An image to use for the background. */
947
1006
  image?: Media;
@@ -1253,17 +1312,32 @@ export declare enum VerticalAlignment {
1253
1312
  export interface CellStyle {
1254
1313
  /** Vertical alignment for the cell's text. */
1255
1314
  verticalAlignment?: VerticalAlignment;
1256
- /** Cell background color as a hexadecimal value. */
1315
+ /**
1316
+ * Cell background color as a hexadecimal value.
1317
+ * @format COLOR_HEX
1318
+ */
1257
1319
  backgroundColor?: string | null;
1258
1320
  }
1259
1321
  export interface BorderColors {
1260
- /** Left border color as a hexadecimal value. */
1322
+ /**
1323
+ * Left border color as a hexadecimal value.
1324
+ * @format COLOR_HEX
1325
+ */
1261
1326
  left?: string | null;
1262
- /** Right border color as a hexadecimal value. */
1327
+ /**
1328
+ * Right border color as a hexadecimal value.
1329
+ * @format COLOR_HEX
1330
+ */
1263
1331
  right?: string | null;
1264
- /** Top border color as a hexadecimal value. */
1332
+ /**
1333
+ * Top border color as a hexadecimal value.
1334
+ * @format COLOR_HEX
1335
+ */
1265
1336
  top?: string | null;
1266
- /** Bottom border color as a hexadecimal value. */
1337
+ /**
1338
+ * Bottom border color as a hexadecimal value.
1339
+ * @format COLOR_HEX
1340
+ */
1267
1341
  bottom?: string | null;
1268
1342
  }
1269
1343
  /**
@@ -1372,24 +1446,48 @@ export interface TextNodeStyle {
1372
1446
  lineHeight?: string | null;
1373
1447
  }
1374
1448
  export interface Mention extends MentionIdentityOneOf {
1375
- /** Wix user ID. */
1449
+ /**
1450
+ * Wix user ID.
1451
+ * @format GUID
1452
+ */
1376
1453
  userId?: string | null;
1377
- /** Member ID. See the Members API for more details. */
1454
+ /**
1455
+ * Member ID. See the Members API for more details.
1456
+ * @format GUID
1457
+ */
1378
1458
  memberId?: string | null;
1379
- /** Visitor ID. */
1459
+ /**
1460
+ * Visitor ID.
1461
+ * @format GUID
1462
+ */
1380
1463
  visitorId?: string | null;
1381
- /** Group ID. See the Groups API for more details. */
1464
+ /**
1465
+ * Group ID. See the Groups API for more details.
1466
+ * @format GUID
1467
+ */
1382
1468
  groupId?: string | null;
1383
1469
  }
1384
1470
  /** @oneof */
1385
1471
  export interface MentionIdentityOneOf {
1386
- /** Wix user ID. */
1472
+ /**
1473
+ * Wix user ID.
1474
+ * @format GUID
1475
+ */
1387
1476
  userId?: string | null;
1388
- /** Member ID. See the Members API for more details. */
1477
+ /**
1478
+ * Member ID. See the Members API for more details.
1479
+ * @format GUID
1480
+ */
1389
1481
  memberId?: string | null;
1390
- /** Visitor ID. */
1482
+ /**
1483
+ * Visitor ID.
1484
+ * @format GUID
1485
+ */
1391
1486
  visitorId?: string | null;
1392
- /** Group ID. See the Groups API for more details. */
1487
+ /**
1488
+ * Group ID. See the Groups API for more details.
1489
+ * @format GUID
1490
+ */
1393
1491
  groupId?: string | null;
1394
1492
  }
1395
1493
  export interface Attachment extends AttachmentMediaOneOf {
@@ -1401,7 +1499,10 @@ export interface Attachment extends AttachmentMediaOneOf {
1401
1499
  audio?: string;
1402
1500
  /** Information about the document. */
1403
1501
  document?: string;
1404
- /** Mime type of attachment. */
1502
+ /**
1503
+ * Mime type of attachment.
1504
+ * @maxLength 3000
1505
+ */
1405
1506
  mimeType?: string | null;
1406
1507
  }
1407
1508
  /** @oneof */
@@ -1455,45 +1556,91 @@ export interface VideoResolution {
1455
1556
  assetKey?: string | null;
1456
1557
  }
1457
1558
  export interface ContentAuthor extends ContentAuthorAuthorOneOf {
1458
- /** Wix user ID. */
1559
+ /**
1560
+ * Wix user ID.
1561
+ * @format GUID
1562
+ */
1459
1563
  userId?: string | null;
1460
- /** Member ID. See the Members API for more details. */
1564
+ /**
1565
+ * Member ID. See the Members API for more details.
1566
+ * @format GUID
1567
+ */
1461
1568
  memberId?: string | null;
1462
- /** Visitor ID. */
1569
+ /**
1570
+ * Visitor ID.
1571
+ * @format GUID
1572
+ */
1463
1573
  visitorId?: string | null;
1464
- /** 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). */
1574
+ /**
1575
+ * 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).
1576
+ * @format GUID
1577
+ */
1465
1578
  appId?: string | null;
1466
1579
  }
1467
1580
  /** @oneof */
1468
1581
  export interface ContentAuthorAuthorOneOf {
1469
- /** Wix user ID. */
1582
+ /**
1583
+ * Wix user ID.
1584
+ * @format GUID
1585
+ */
1470
1586
  userId?: string | null;
1471
- /** Member ID. See the Members API for more details. */
1587
+ /**
1588
+ * Member ID. See the Members API for more details.
1589
+ * @format GUID
1590
+ */
1472
1591
  memberId?: string | null;
1473
- /** Visitor ID. */
1592
+ /**
1593
+ * Visitor ID.
1594
+ * @format GUID
1595
+ */
1474
1596
  visitorId?: string | null;
1475
- /** 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). */
1597
+ /**
1598
+ * 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).
1599
+ * @format GUID
1600
+ */
1476
1601
  appId?: string | null;
1477
1602
  }
1478
1603
  export interface CommentAuthor extends CommentAuthorIdentityOneOf {
1479
- /** Wix user ID. */
1604
+ /**
1605
+ * Wix user ID.
1606
+ * @format GUID
1607
+ */
1480
1608
  userId?: string | null;
1481
- /** Member ID. See the Members API for more details. */
1609
+ /**
1610
+ * Member ID. See the Members API for more details.
1611
+ * @format GUID
1612
+ */
1482
1613
  memberId?: string | null;
1483
- /** Visitor ID. */
1614
+ /**
1615
+ * Visitor ID.
1616
+ * @format GUID
1617
+ */
1484
1618
  visitorId?: string | null;
1485
1619
  }
1486
1620
  /** @oneof */
1487
1621
  export interface CommentAuthorIdentityOneOf {
1488
- /** Wix user ID. */
1622
+ /**
1623
+ * Wix user ID.
1624
+ * @format GUID
1625
+ */
1489
1626
  userId?: string | null;
1490
- /** Member ID. See the Members API for more details. */
1627
+ /**
1628
+ * Member ID. See the Members API for more details.
1629
+ * @format GUID
1630
+ */
1491
1631
  memberId?: string | null;
1492
- /** Visitor ID. */
1632
+ /**
1633
+ * Visitor ID.
1634
+ * @format GUID
1635
+ */
1493
1636
  visitorId?: string | null;
1494
1637
  }
1495
1638
  export interface ParentComment {
1496
- /** Comment ID of the parent comment. */
1639
+ /**
1640
+ * Comment ID of the parent comment.
1641
+ * @format GUID
1642
+ * @immutable
1643
+ */
1497
1644
  _id?: string | null;
1498
1645
  /**
1499
1646
  * Author of the parent comment.
@@ -1550,9 +1697,15 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
1550
1697
  versionedUpdate?: VersionedDocumentUpdateOperation;
1551
1698
  /** delete by document ids with versioning */
1552
1699
  versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1553
- /** type of the documents */
1700
+ /**
1701
+ * type of the documents
1702
+ * @minLength 2
1703
+ */
1554
1704
  documentType?: string;
1555
- /** language of the documents (mandatory) */
1705
+ /**
1706
+ * language of the documents (mandatory)
1707
+ * @minLength 2
1708
+ */
1556
1709
  language?: string | null;
1557
1710
  /**
1558
1711
  * one or more search documents
@@ -1679,7 +1832,10 @@ export interface ResourceCommentCountChanged {
1679
1832
  publishedCommentCount?: number;
1680
1833
  }
1681
1834
  export interface GetCommentRequest {
1682
- /** ID of the comment to retrieve. */
1835
+ /**
1836
+ * ID of the comment to retrieve.
1837
+ * @format GUID
1838
+ */
1683
1839
  commentId: string;
1684
1840
  }
1685
1841
  export interface GetCommentResponse {
@@ -1704,7 +1860,10 @@ export interface CommentContentChanged {
1704
1860
  currentContent?: CommentContent;
1705
1861
  }
1706
1862
  export interface DeleteCommentRequest {
1707
- /** ID of the comment to delete. */
1863
+ /**
1864
+ * ID of the comment to delete.
1865
+ * @format GUID
1866
+ */
1708
1867
  commentId: string;
1709
1868
  }
1710
1869
  export interface DeleteCommentResponse {
@@ -1713,7 +1872,10 @@ export interface CommentDeleted {
1713
1872
  comment?: Comment;
1714
1873
  }
1715
1874
  export interface ModerateDraftContentRequest {
1716
- /** ID of the comment to moderate. */
1875
+ /**
1876
+ * ID of the comment to moderate.
1877
+ * @format GUID
1878
+ */
1717
1879
  commentId: string;
1718
1880
  /**
1719
1881
  * Revision number, which increments by `1` each time the comment is updated.
@@ -1738,7 +1900,10 @@ export interface CommentHidden {
1738
1900
  comment?: Comment;
1739
1901
  }
1740
1902
  export interface QueryCommentsRequest {
1741
- /** App ID to query comments for. */
1903
+ /**
1904
+ * App ID to query comments for.
1905
+ * @format GUID
1906
+ */
1742
1907
  appId: string;
1743
1908
  /** Query options. */
1744
1909
  query: CursorQuery;
@@ -1760,6 +1925,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1760
1925
  * Sort object.
1761
1926
  *
1762
1927
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1928
+ * @maxSize 5
1763
1929
  */
1764
1930
  sort?: Sorting[];
1765
1931
  }
@@ -1773,7 +1939,10 @@ export interface CursorQueryPagingMethodOneOf {
1773
1939
  cursorPaging?: CursorPaging;
1774
1940
  }
1775
1941
  export interface Sorting {
1776
- /** Name of the field to sort by. */
1942
+ /**
1943
+ * Name of the field to sort by.
1944
+ * @maxLength 512
1945
+ */
1777
1946
  fieldName?: string;
1778
1947
  /** Sort order. */
1779
1948
  order?: SortOrder;
@@ -1783,13 +1952,17 @@ export declare enum SortOrder {
1783
1952
  DESC = "DESC"
1784
1953
  }
1785
1954
  export interface CursorPaging {
1786
- /** Maximum number of items to return in the results. */
1955
+ /**
1956
+ * Maximum number of items to return in the results.
1957
+ * @max 100
1958
+ */
1787
1959
  limit?: number | null;
1788
1960
  /**
1789
1961
  * Pointer to the next or previous page in the list of results.
1790
1962
  *
1791
1963
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1792
1964
  * Not relevant for the first request.
1965
+ * @maxLength 16000
1793
1966
  */
1794
1967
  cursor?: string | null;
1795
1968
  }
@@ -1813,13 +1986,22 @@ export interface CursorPagingMetadata {
1813
1986
  hasNext?: boolean | null;
1814
1987
  }
1815
1988
  export interface Cursors {
1816
- /** Cursor string pointing to the next page in the list of results. */
1989
+ /**
1990
+ * Cursor string pointing to the next page in the list of results.
1991
+ * @maxLength 16000
1992
+ */
1817
1993
  next?: string | null;
1818
- /** Cursor pointing to the previous page in the list of results. */
1994
+ /**
1995
+ * Cursor pointing to the previous page in the list of results.
1996
+ * @maxLength 16000
1997
+ */
1819
1998
  prev?: string | null;
1820
1999
  }
1821
2000
  export interface MarkCommentRequest {
1822
- /** ID of the comment to mark. */
2001
+ /**
2002
+ * ID of the comment to mark.
2003
+ * @format GUID
2004
+ */
1823
2005
  commentId: string;
1824
2006
  }
1825
2007
  export interface MarkCommentResponse {
@@ -1830,7 +2012,10 @@ export interface CommentMarked {
1830
2012
  comment?: Comment;
1831
2013
  }
1832
2014
  export interface UnmarkCommentRequest {
1833
- /** ID of the comment to unmark. */
2015
+ /**
2016
+ * ID of the comment to unmark.
2017
+ * @format GUID
2018
+ */
1834
2019
  commentId: string;
1835
2020
  }
1836
2021
  export interface UnmarkCommentResponse {
@@ -1841,7 +2026,10 @@ export interface CommentUnmarked {
1841
2026
  comment?: Comment;
1842
2027
  }
1843
2028
  export interface HideCommentRequest {
1844
- /** ID of the comment to hide. */
2029
+ /**
2030
+ * ID of the comment to hide.
2031
+ * @format GUID
2032
+ */
1845
2033
  commentId: string;
1846
2034
  }
1847
2035
  export interface HideCommentResponse {
@@ -1849,7 +2037,10 @@ export interface HideCommentResponse {
1849
2037
  comment?: Comment;
1850
2038
  }
1851
2039
  export interface PublishCommentRequest {
1852
- /** ID of the comment to publish. */
2040
+ /**
2041
+ * ID of the comment to publish.
2042
+ * @format GUID
2043
+ */
1853
2044
  commentId: string;
1854
2045
  }
1855
2046
  export interface PublishCommentResponse {
@@ -1858,7 +2049,10 @@ export interface PublishCommentResponse {
1858
2049
  }
1859
2050
  /** Count comments options. */
1860
2051
  export interface CountCommentsRequest {
1861
- /** App ID to count the comments of. */
2052
+ /**
2053
+ * App ID to count the comments of.
2054
+ * @format GUID
2055
+ */
1862
2056
  appId?: string;
1863
2057
  /** Filter to identify the comments that need to be counted. */
1864
2058
  filter?: Record<string, any> | null;
@@ -1868,20 +2062,28 @@ export interface CountCommentsResponse {
1868
2062
  count?: number;
1869
2063
  }
1870
2064
  export interface ListCommentsByResourceRequest {
1871
- /** ID of the app from which the comments are listed. */
2065
+ /**
2066
+ * ID of the app from which the comments are listed.
2067
+ * @format GUID
2068
+ */
1872
2069
  appId: string;
1873
2070
  /**
1874
2071
  * ID of the specific context the comment is in response to.
1875
2072
  *
1876
2073
  * 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`.
2074
+ * @maxLength 128
1877
2075
  */
1878
2076
  contextId: string;
1879
- /** Reserved for internal use. */
2077
+ /**
2078
+ * Reserved for internal use.
2079
+ * @maxLength 128
2080
+ */
1880
2081
  contextType?: string;
1881
2082
  /**
1882
2083
  * ID of the specific resource that the comment is in response to.
1883
2084
  *
1884
2085
  * 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`.
2086
+ * @maxLength 128
1885
2087
  */
1886
2088
  resourceId: string;
1887
2089
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -1944,9 +2146,16 @@ export declare enum ReplySortOrder {
1944
2146
  export interface ListCommentsByResourceCursorPaging {
1945
2147
  /** Pointer to the next or previous page in the list of results. */
1946
2148
  cursor?: string | null;
1947
- /** Number of items to return. */
2149
+ /**
2150
+ * Number of items to return.
2151
+ * @min 1
2152
+ * @max 100
2153
+ */
1948
2154
  limit?: number | null;
1949
- /** Maximum number of replies in a response. Only applicable to parent comments. */
2155
+ /**
2156
+ * Maximum number of replies in a response. Only applicable to parent comments.
2157
+ * @max 100
2158
+ */
1950
2159
  repliesLimit?: number | null;
1951
2160
  }
1952
2161
  export interface ListCommentsByResourceResponse {
@@ -1966,11 +2175,15 @@ export interface RepliesListResponse {
1966
2175
  export interface GetCommentThreadRequest {
1967
2176
  /**
1968
2177
  * App ID.
2178
+ * @maxLength 128
1969
2179
  * @deprecated App ID.
1970
2180
  * @targetRemovalDate 2024-11-01
1971
2181
  */
1972
2182
  appId?: string;
1973
- /** Comment ID. */
2183
+ /**
2184
+ * Comment ID.
2185
+ * @format GUID
2186
+ */
1974
2187
  commentId: string;
1975
2188
  /** Comment sorting. */
1976
2189
  commentSort?: CommentSort;
@@ -1986,7 +2199,10 @@ export interface GetCommentThreadResponse {
1986
2199
  commentReplies?: Record<string, RepliesListResponse>;
1987
2200
  }
1988
2201
  export interface BulkPublishCommentRequest {
1989
- /** ID of the app where to publish the comment. */
2202
+ /**
2203
+ * ID of the app where to publish the comment.
2204
+ * @format GUID
2205
+ */
1990
2206
  appId: string;
1991
2207
  /** 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"`}. */
1992
2208
  filter: Record<string, any> | null;
@@ -1996,11 +2212,15 @@ export interface BulkPublishCommentResponse {
1996
2212
  * Job ID.
1997
2213
  *
1998
2214
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2215
+ * @format GUID
1999
2216
  */
2000
2217
  jobId?: string;
2001
2218
  }
2002
2219
  export interface BulkHideCommentRequest {
2003
- /** ID of the app where to hide the comments. */
2220
+ /**
2221
+ * ID of the app where to hide the comments.
2222
+ * @format GUID
2223
+ */
2004
2224
  appId: string;
2005
2225
  /** 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"`}. */
2006
2226
  filter: Record<string, any> | null;
@@ -2010,11 +2230,15 @@ export interface BulkHideCommentResponse {
2010
2230
  * Job ID.
2011
2231
  *
2012
2232
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2233
+ * @format GUID
2013
2234
  */
2014
2235
  jobId?: string;
2015
2236
  }
2016
2237
  export interface BulkDeleteCommentRequest {
2017
- /** ID of the app where to delete the comments. */
2238
+ /**
2239
+ * ID of the app where to delete the comments.
2240
+ * @format GUID
2241
+ */
2018
2242
  appId: string;
2019
2243
  /** 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"`}. */
2020
2244
  filter: Record<string, any> | null;
@@ -2024,11 +2248,15 @@ export interface BulkDeleteCommentResponse {
2024
2248
  * Job ID.
2025
2249
  *
2026
2250
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2251
+ * @format GUID
2027
2252
  */
2028
2253
  jobId?: string;
2029
2254
  }
2030
2255
  export interface BulkModerateDraftContentRequest {
2031
- /** ID of the app where to moderate the comments. */
2256
+ /**
2257
+ * ID of the app where to moderate the comments.
2258
+ * @format GUID
2259
+ */
2032
2260
  appId: string;
2033
2261
  /** 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"`}. */
2034
2262
  filter: Record<string, any> | null;
@@ -2040,11 +2268,15 @@ export interface BulkModerateDraftContentResponse {
2040
2268
  * Job ID.
2041
2269
  *
2042
2270
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2271
+ * @format GUID
2043
2272
  */
2044
2273
  jobId?: string;
2045
2274
  }
2046
2275
  export interface BulkMoveCommentByFilterRequest {
2047
- /** ID of the app from which to move the comments. */
2276
+ /**
2277
+ * ID of the app from which to move the comments.
2278
+ * @format GUID
2279
+ */
2048
2280
  appId: string;
2049
2281
  /** 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"`}. */
2050
2282
  filter: Record<string, any> | null;
@@ -2052,9 +2284,15 @@ export interface BulkMoveCommentByFilterRequest {
2052
2284
  destination?: Destination;
2053
2285
  }
2054
2286
  export interface Destination {
2055
- /** Context ID of where to move the comment to. */
2287
+ /**
2288
+ * Context ID of where to move the comment to.
2289
+ * @maxLength 128
2290
+ */
2056
2291
  contextId?: string;
2057
- /** Resource ID of where to move the comment to. */
2292
+ /**
2293
+ * Resource ID of where to move the comment to.
2294
+ * @maxLength 128
2295
+ */
2058
2296
  resourceId?: string;
2059
2297
  }
2060
2298
  export interface BulkMoveCommentByFilterResponse {
@@ -2062,6 +2300,7 @@ export interface BulkMoveCommentByFilterResponse {
2062
2300
  * Job ID.
2063
2301
  *
2064
2302
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2303
+ * @format GUID
2065
2304
  */
2066
2305
  jobId?: string;
2067
2306
  }
@@ -2140,9 +2379,15 @@ export interface ActionEvent {
2140
2379
  body?: string;
2141
2380
  }
2142
2381
  export interface MessageEnvelope {
2143
- /** App instance ID. */
2382
+ /**
2383
+ * App instance ID.
2384
+ * @format GUID
2385
+ */
2144
2386
  instanceId?: string | null;
2145
- /** Event type. */
2387
+ /**
2388
+ * Event type.
2389
+ * @maxLength 150
2390
+ */
2146
2391
  eventType?: string;
2147
2392
  /** The identification type and identity data. */
2148
2393
  identity?: IdentificationData;
@@ -2150,26 +2395,50 @@ export interface MessageEnvelope {
2150
2395
  data?: string;
2151
2396
  }
2152
2397
  export interface IdentificationData extends IdentificationDataIdOneOf {
2153
- /** ID of a site visitor that has not logged in to the site. */
2398
+ /**
2399
+ * ID of a site visitor that has not logged in to the site.
2400
+ * @format GUID
2401
+ */
2154
2402
  anonymousVisitorId?: string;
2155
- /** ID of a site visitor that has logged in to the site. */
2403
+ /**
2404
+ * ID of a site visitor that has logged in to the site.
2405
+ * @format GUID
2406
+ */
2156
2407
  memberId?: string;
2157
- /** ID of a Wix user (site owner, contributor, etc.). */
2408
+ /**
2409
+ * ID of a Wix user (site owner, contributor, etc.).
2410
+ * @format GUID
2411
+ */
2158
2412
  wixUserId?: string;
2159
- /** ID of an app. */
2413
+ /**
2414
+ * ID of an app.
2415
+ * @format GUID
2416
+ */
2160
2417
  appId?: string;
2161
2418
  /** @readonly */
2162
2419
  identityType?: WebhookIdentityType;
2163
2420
  }
2164
2421
  /** @oneof */
2165
2422
  export interface IdentificationDataIdOneOf {
2166
- /** ID of a site visitor that has not logged in to the site. */
2423
+ /**
2424
+ * ID of a site visitor that has not logged in to the site.
2425
+ * @format GUID
2426
+ */
2167
2427
  anonymousVisitorId?: string;
2168
- /** ID of a site visitor that has logged in to the site. */
2428
+ /**
2429
+ * ID of a site visitor that has logged in to the site.
2430
+ * @format GUID
2431
+ */
2169
2432
  memberId?: string;
2170
- /** ID of a Wix user (site owner, contributor, etc.). */
2433
+ /**
2434
+ * ID of a Wix user (site owner, contributor, etc.).
2435
+ * @format GUID
2436
+ */
2171
2437
  wixUserId?: string;
2172
- /** ID of an app. */
2438
+ /**
2439
+ * ID of an app.
2440
+ * @format GUID
2441
+ */
2173
2442
  appId?: string;
2174
2443
  }
2175
2444
  export declare enum WebhookIdentityType {
@@ -2511,9 +2780,15 @@ export interface BulkMoveCommentByFilterResponseNonNullableFields {
2511
2780
  jobId: string;
2512
2781
  }
2513
2782
  export interface BaseEventMetadata {
2514
- /** App instance ID. */
2783
+ /**
2784
+ * App instance ID.
2785
+ * @format GUID
2786
+ */
2515
2787
  instanceId?: string | null;
2516
- /** Event type. */
2788
+ /**
2789
+ * Event type.
2790
+ * @maxLength 150
2791
+ */
2517
2792
  eventType?: string;
2518
2793
  /** The identification type and identity data. */
2519
2794
  identity?: IdentificationData;
@@ -2569,6 +2844,8 @@ export interface CommentContentChangedEnvelope {
2569
2844
  * @permissionId WIX_COMMENTS.COMMENT_READ
2570
2845
  * @webhook
2571
2846
  * @eventType wix.comments.v2.comment_comment_content_changed
2847
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2848
+ * @slug comment_content_changed
2572
2849
  */
2573
2850
  export declare function onCommentContentChanged(handler: (event: CommentContentChangedEnvelope) => void | Promise<void>): void;
2574
2851
  export interface CommentHiddenEnvelope {
@@ -2584,6 +2861,8 @@ export interface CommentHiddenEnvelope {
2584
2861
  * @permissionId WIX_COMMENTS.COMMENT_READ
2585
2862
  * @webhook
2586
2863
  * @eventType wix.comments.v2.comment_comment_hidden
2864
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2865
+ * @slug comment_hidden
2587
2866
  * @documentationMaturity preview
2588
2867
  */
2589
2868
  export declare function onCommentHidden(handler: (event: CommentHiddenEnvelope) => void | Promise<void>): void;
@@ -2600,6 +2879,8 @@ export interface CommentMarkedEnvelope {
2600
2879
  * @permissionId WIX_COMMENTS.COMMENT_READ
2601
2880
  * @webhook
2602
2881
  * @eventType wix.comments.v2.comment_comment_marked
2882
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2883
+ * @slug comment_marked
2603
2884
  */
2604
2885
  export declare function onCommentMarked(handler: (event: CommentMarkedEnvelope) => void | Promise<void>): void;
2605
2886
  export interface CommentMovedEnvelope {
@@ -2615,6 +2896,8 @@ export interface CommentMovedEnvelope {
2615
2896
  * @permissionId WIX_COMMENTS.COMMENT_READ
2616
2897
  * @webhook
2617
2898
  * @eventType wix.comments.v2.comment_comment_moved
2899
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2900
+ * @slug comment_moved
2618
2901
  * @documentationMaturity preview
2619
2902
  */
2620
2903
  export declare function onCommentMoved(handler: (event: CommentMovedEnvelope) => void | Promise<void>): void;
@@ -2631,6 +2914,8 @@ export interface CommentPublishedEnvelope {
2631
2914
  * @permissionId WIX_COMMENTS.COMMENT_READ
2632
2915
  * @webhook
2633
2916
  * @eventType wix.comments.v2.comment_comment_published
2917
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2918
+ * @slug comment_published
2634
2919
  * @documentationMaturity preview
2635
2920
  */
2636
2921
  export declare function onCommentPublished(handler: (event: CommentPublishedEnvelope) => void | Promise<void>): void;
@@ -2647,6 +2932,8 @@ export interface CommentUnmarkedEnvelope {
2647
2932
  * @permissionId WIX_COMMENTS.COMMENT_READ
2648
2933
  * @webhook
2649
2934
  * @eventType wix.comments.v2.comment_comment_unmarked
2935
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2936
+ * @slug comment_unmarked
2650
2937
  */
2651
2938
  export declare function onCommentUnmarked(handler: (event: CommentUnmarkedEnvelope) => void | Promise<void>): void;
2652
2939
  export interface CommentCreatedEnvelope {
@@ -2662,6 +2949,8 @@ export interface CommentCreatedEnvelope {
2662
2949
  * @permissionId WIX_COMMENTS.COMMENT_READ
2663
2950
  * @webhook
2664
2951
  * @eventType wix.comments.v2.comment_created
2952
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2953
+ * @slug created
2665
2954
  */
2666
2955
  export declare function onCommentCreated(handler: (event: CommentCreatedEnvelope) => void | Promise<void>): void;
2667
2956
  export interface CommentResourceCommentCountChangedEnvelope {
@@ -2677,6 +2966,8 @@ export interface CommentResourceCommentCountChangedEnvelope {
2677
2966
  * @permissionId WIX_COMMENTS.COMMENT_READ
2678
2967
  * @webhook
2679
2968
  * @eventType wix.comments.v2.comment_resource_comment_count_changed
2969
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2970
+ * @slug resource_comment_count_changed
2680
2971
  */
2681
2972
  export declare function onCommentResourceCommentCountChanged(handler: (event: CommentResourceCommentCountChangedEnvelope) => void | Promise<void>): void;
2682
2973
  export interface CommentUpdatedEnvelope {
@@ -2692,6 +2983,8 @@ export interface CommentUpdatedEnvelope {
2692
2983
  * @permissionId WIX_COMMENTS.COMMENT_READ
2693
2984
  * @webhook
2694
2985
  * @eventType wix.comments.v2.comment_updated
2986
+ * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2987
+ * @slug updated
2695
2988
  */
2696
2989
  export declare function onCommentUpdated(handler: (event: CommentUpdatedEnvelope) => void | Promise<void>): void;
2697
2990
  /**
@@ -2760,6 +3053,7 @@ export declare function updateComment(_id: string | null, comment: UpdateComment
2760
3053
  export interface UpdateComment {
2761
3054
  /**
2762
3055
  * Comment ID.
3056
+ * @format GUID
2763
3057
  * @readonly
2764
3058
  */
2765
3059
  _id?: string | null;
@@ -2782,13 +3076,19 @@ export interface UpdateComment {
2782
3076
  * @readonly
2783
3077
  */
2784
3078
  _updatedDate?: Date | null;
2785
- /** ID of the app that the comment is added to. */
3079
+ /**
3080
+ * ID of the app that the comment is added to.
3081
+ * @format GUID
3082
+ * @immutable
3083
+ */
2786
3084
  appId?: string | null;
2787
3085
  /**
2788
3086
  * ID of the specific context the comment is in response to.
2789
3087
  *
2790
3088
  * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
2791
3089
  * the `forumPostId` is used as both the `contextId` and the `resourceId`.
3090
+ * @immutable
3091
+ * @maxLength 128
2792
3092
  */
2793
3093
  contextId?: string | null;
2794
3094
  /**
@@ -2796,11 +3096,16 @@ export interface UpdateComment {
2796
3096
  *
2797
3097
  * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
2798
3098
  * the `forumPostId` is used as both the `resourceId` and the `contextId`.
3099
+ * @immutable
3100
+ * @maxLength 128
2799
3101
  */
2800
3102
  resourceId?: string | null;
2801
3103
  /** Published comment content. */
2802
3104
  content?: CommentContent;
2803
- /** Comment's author. */
3105
+ /**
3106
+ * Comment's author.
3107
+ * @immutable
3108
+ */
2804
3109
  author?: CommentAuthor;
2805
3110
  /**
2806
3111
  * Parent comment information.
@@ -2837,7 +3142,10 @@ export interface UpdateComment {
2837
3142
  reactionSummary?: CommentReactionSummary;
2838
3143
  /** Whether the comment is marked. */
2839
3144
  marked?: boolean;
2840
- /** Date and time when the comment was actually created. */
3145
+ /**
3146
+ * Date and time when the comment was actually created.
3147
+ * @immutable
3148
+ */
2841
3149
  commentDate?: Date | null;
2842
3150
  /**
2843
3151
  * Whether the comment has the updated content.
@@ -3043,14 +3351,19 @@ export interface ListCommentsByResourceOptions {
3043
3351
  * ID of the specific context the comment is in response to.
3044
3352
  *
3045
3353
  * 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`.
3354
+ * @maxLength 128
3046
3355
  */
3047
3356
  contextId: string;
3048
- /** Reserved for internal use. */
3357
+ /**
3358
+ * Reserved for internal use.
3359
+ * @maxLength 128
3360
+ */
3049
3361
  contextType?: string;
3050
3362
  /**
3051
3363
  * ID of the specific resource that the comment is in response to.
3052
3364
  *
3053
3365
  * 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`.
3366
+ * @maxLength 128
3054
3367
  */
3055
3368
  resourceId: string;
3056
3369
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -3082,6 +3395,7 @@ export declare function getCommentThread(commentId: string, options?: GetComment
3082
3395
  export interface GetCommentThreadOptions {
3083
3396
  /**
3084
3397
  * App ID.
3398
+ * @maxLength 128
3085
3399
  * @deprecated App ID.
3086
3400
  * @targetRemovalDate 2024-11-01
3087
3401
  */