@wix/auto_sdk_comments_comments 1.0.1 → 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.
@@ -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;
@@ -940,13 +971,22 @@ export declare enum BackgroundType {
940
971
  export interface Gradient {
941
972
  /** The gradient angle in degrees. */
942
973
  angle?: number | null;
943
- /** The start color as a hexademical value. */
974
+ /**
975
+ * The start color as a hexademical value.
976
+ * @format COLOR_HEX
977
+ */
944
978
  startColor?: string | null;
945
- /** The end color as a hexademical value. */
979
+ /**
980
+ * The end color as a hexademical value.
981
+ * @format COLOR_HEX
982
+ */
946
983
  lastColor?: string | null;
947
984
  }
948
985
  export interface Background extends BackgroundBackgroundOneOf {
949
- /** The background color as a hexademical value. */
986
+ /**
987
+ * The background color as a hexademical value.
988
+ * @format COLOR_HEX
989
+ */
950
990
  color?: string | null;
951
991
  /** An image to use for the background. */
952
992
  image?: Media;
@@ -957,7 +997,10 @@ export interface Background extends BackgroundBackgroundOneOf {
957
997
  }
958
998
  /** @oneof */
959
999
  export interface BackgroundBackgroundOneOf {
960
- /** The background color as a hexademical value. */
1000
+ /**
1001
+ * The background color as a hexademical value.
1002
+ * @format COLOR_HEX
1003
+ */
961
1004
  color?: string | null;
962
1005
  /** An image to use for the background. */
963
1006
  image?: Media;
@@ -1269,17 +1312,32 @@ export declare enum VerticalAlignment {
1269
1312
  export interface CellStyle {
1270
1313
  /** Vertical alignment for the cell's text. */
1271
1314
  verticalAlignment?: VerticalAlignment;
1272
- /** Cell background color as a hexadecimal value. */
1315
+ /**
1316
+ * Cell background color as a hexadecimal value.
1317
+ * @format COLOR_HEX
1318
+ */
1273
1319
  backgroundColor?: string | null;
1274
1320
  }
1275
1321
  export interface BorderColors {
1276
- /** Left border color as a hexadecimal value. */
1322
+ /**
1323
+ * Left border color as a hexadecimal value.
1324
+ * @format COLOR_HEX
1325
+ */
1277
1326
  left?: string | null;
1278
- /** Right border color as a hexadecimal value. */
1327
+ /**
1328
+ * Right border color as a hexadecimal value.
1329
+ * @format COLOR_HEX
1330
+ */
1279
1331
  right?: string | null;
1280
- /** Top border color as a hexadecimal value. */
1332
+ /**
1333
+ * Top border color as a hexadecimal value.
1334
+ * @format COLOR_HEX
1335
+ */
1281
1336
  top?: string | null;
1282
- /** Bottom border color as a hexadecimal value. */
1337
+ /**
1338
+ * Bottom border color as a hexadecimal value.
1339
+ * @format COLOR_HEX
1340
+ */
1283
1341
  bottom?: string | null;
1284
1342
  }
1285
1343
  /**
@@ -1388,24 +1446,48 @@ export interface TextNodeStyle {
1388
1446
  lineHeight?: string | null;
1389
1447
  }
1390
1448
  export interface Mention extends MentionIdentityOneOf {
1391
- /** Wix user ID. */
1449
+ /**
1450
+ * Wix user ID.
1451
+ * @format GUID
1452
+ */
1392
1453
  userId?: string | null;
1393
- /** Member ID. See the Members API for more details. */
1454
+ /**
1455
+ * Member ID. See the Members API for more details.
1456
+ * @format GUID
1457
+ */
1394
1458
  memberId?: string | null;
1395
- /** Visitor ID. */
1459
+ /**
1460
+ * Visitor ID.
1461
+ * @format GUID
1462
+ */
1396
1463
  visitorId?: string | null;
1397
- /** Group ID. See the Groups API for more details. */
1464
+ /**
1465
+ * Group ID. See the Groups API for more details.
1466
+ * @format GUID
1467
+ */
1398
1468
  groupId?: string | null;
1399
1469
  }
1400
1470
  /** @oneof */
1401
1471
  export interface MentionIdentityOneOf {
1402
- /** Wix user ID. */
1472
+ /**
1473
+ * Wix user ID.
1474
+ * @format GUID
1475
+ */
1403
1476
  userId?: string | null;
1404
- /** Member ID. See the Members API for more details. */
1477
+ /**
1478
+ * Member ID. See the Members API for more details.
1479
+ * @format GUID
1480
+ */
1405
1481
  memberId?: string | null;
1406
- /** Visitor ID. */
1482
+ /**
1483
+ * Visitor ID.
1484
+ * @format GUID
1485
+ */
1407
1486
  visitorId?: string | null;
1408
- /** Group ID. See the Groups API for more details. */
1487
+ /**
1488
+ * Group ID. See the Groups API for more details.
1489
+ * @format GUID
1490
+ */
1409
1491
  groupId?: string | null;
1410
1492
  }
1411
1493
  export interface Attachment extends AttachmentMediaOneOf {
@@ -1417,7 +1499,10 @@ export interface Attachment extends AttachmentMediaOneOf {
1417
1499
  audio?: string;
1418
1500
  /** Information about the document. */
1419
1501
  document?: string;
1420
- /** Mime type of attachment. */
1502
+ /**
1503
+ * Mime type of attachment.
1504
+ * @maxLength 3000
1505
+ */
1421
1506
  mimeType?: string | null;
1422
1507
  }
1423
1508
  /** @oneof */
@@ -1471,45 +1556,91 @@ export interface VideoResolution {
1471
1556
  assetKey?: string | null;
1472
1557
  }
1473
1558
  export interface ContentAuthor extends ContentAuthorAuthorOneOf {
1474
- /** Wix user ID. */
1559
+ /**
1560
+ * Wix user ID.
1561
+ * @format GUID
1562
+ */
1475
1563
  userId?: string | null;
1476
- /** Member ID. See the Members API for more details. */
1564
+ /**
1565
+ * Member ID. See the Members API for more details.
1566
+ * @format GUID
1567
+ */
1477
1568
  memberId?: string | null;
1478
- /** Visitor ID. */
1569
+ /**
1570
+ * Visitor ID.
1571
+ * @format GUID
1572
+ */
1479
1573
  visitorId?: string | null;
1480
- /** 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
+ */
1481
1578
  appId?: string | null;
1482
1579
  }
1483
1580
  /** @oneof */
1484
1581
  export interface ContentAuthorAuthorOneOf {
1485
- /** Wix user ID. */
1582
+ /**
1583
+ * Wix user ID.
1584
+ * @format GUID
1585
+ */
1486
1586
  userId?: string | null;
1487
- /** Member ID. See the Members API for more details. */
1587
+ /**
1588
+ * Member ID. See the Members API for more details.
1589
+ * @format GUID
1590
+ */
1488
1591
  memberId?: string | null;
1489
- /** Visitor ID. */
1592
+ /**
1593
+ * Visitor ID.
1594
+ * @format GUID
1595
+ */
1490
1596
  visitorId?: string | null;
1491
- /** 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
+ */
1492
1601
  appId?: string | null;
1493
1602
  }
1494
1603
  export interface CommentAuthor extends CommentAuthorIdentityOneOf {
1495
- /** Wix user ID. */
1604
+ /**
1605
+ * Wix user ID.
1606
+ * @format GUID
1607
+ */
1496
1608
  userId?: string | null;
1497
- /** Member ID. See the Members API for more details. */
1609
+ /**
1610
+ * Member ID. See the Members API for more details.
1611
+ * @format GUID
1612
+ */
1498
1613
  memberId?: string | null;
1499
- /** Visitor ID. */
1614
+ /**
1615
+ * Visitor ID.
1616
+ * @format GUID
1617
+ */
1500
1618
  visitorId?: string | null;
1501
1619
  }
1502
1620
  /** @oneof */
1503
1621
  export interface CommentAuthorIdentityOneOf {
1504
- /** Wix user ID. */
1622
+ /**
1623
+ * Wix user ID.
1624
+ * @format GUID
1625
+ */
1505
1626
  userId?: string | null;
1506
- /** Member ID. See the Members API for more details. */
1627
+ /**
1628
+ * Member ID. See the Members API for more details.
1629
+ * @format GUID
1630
+ */
1507
1631
  memberId?: string | null;
1508
- /** Visitor ID. */
1632
+ /**
1633
+ * Visitor ID.
1634
+ * @format GUID
1635
+ */
1509
1636
  visitorId?: string | null;
1510
1637
  }
1511
1638
  export interface ParentComment {
1512
- /** Comment ID of the parent comment. */
1639
+ /**
1640
+ * Comment ID of the parent comment.
1641
+ * @format GUID
1642
+ * @immutable
1643
+ */
1513
1644
  _id?: string | null;
1514
1645
  /**
1515
1646
  * Author of the parent comment.
@@ -1566,9 +1697,15 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
1566
1697
  versionedUpdate?: VersionedDocumentUpdateOperation;
1567
1698
  /** delete by document ids with versioning */
1568
1699
  versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1569
- /** type of the documents */
1700
+ /**
1701
+ * type of the documents
1702
+ * @minLength 2
1703
+ */
1570
1704
  documentType?: string;
1571
- /** language of the documents (mandatory) */
1705
+ /**
1706
+ * language of the documents (mandatory)
1707
+ * @minLength 2
1708
+ */
1572
1709
  language?: string | null;
1573
1710
  /**
1574
1711
  * one or more search documents
@@ -1695,7 +1832,10 @@ export interface ResourceCommentCountChanged {
1695
1832
  publishedCommentCount?: number;
1696
1833
  }
1697
1834
  export interface GetCommentRequest {
1698
- /** ID of the comment to retrieve. */
1835
+ /**
1836
+ * ID of the comment to retrieve.
1837
+ * @format GUID
1838
+ */
1699
1839
  commentId: string;
1700
1840
  }
1701
1841
  export interface GetCommentResponse {
@@ -1720,7 +1860,10 @@ export interface CommentContentChanged {
1720
1860
  currentContent?: CommentContent;
1721
1861
  }
1722
1862
  export interface DeleteCommentRequest {
1723
- /** ID of the comment to delete. */
1863
+ /**
1864
+ * ID of the comment to delete.
1865
+ * @format GUID
1866
+ */
1724
1867
  commentId: string;
1725
1868
  }
1726
1869
  export interface DeleteCommentResponse {
@@ -1729,7 +1872,10 @@ export interface CommentDeleted {
1729
1872
  comment?: Comment;
1730
1873
  }
1731
1874
  export interface ModerateDraftContentRequest {
1732
- /** ID of the comment to moderate. */
1875
+ /**
1876
+ * ID of the comment to moderate.
1877
+ * @format GUID
1878
+ */
1733
1879
  commentId: string;
1734
1880
  /**
1735
1881
  * Revision number, which increments by `1` each time the comment is updated.
@@ -1754,7 +1900,10 @@ export interface CommentHidden {
1754
1900
  comment?: Comment;
1755
1901
  }
1756
1902
  export interface QueryCommentsRequest {
1757
- /** App ID to query comments for. */
1903
+ /**
1904
+ * App ID to query comments for.
1905
+ * @format GUID
1906
+ */
1758
1907
  appId: string;
1759
1908
  /** Query options. */
1760
1909
  query: CursorQuery;
@@ -1776,6 +1925,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1776
1925
  * Sort object.
1777
1926
  *
1778
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
1779
1929
  */
1780
1930
  sort?: Sorting[];
1781
1931
  }
@@ -1789,7 +1939,10 @@ export interface CursorQueryPagingMethodOneOf {
1789
1939
  cursorPaging?: CursorPaging;
1790
1940
  }
1791
1941
  export interface Sorting {
1792
- /** Name of the field to sort by. */
1942
+ /**
1943
+ * Name of the field to sort by.
1944
+ * @maxLength 512
1945
+ */
1793
1946
  fieldName?: string;
1794
1947
  /** Sort order. */
1795
1948
  order?: SortOrder;
@@ -1799,13 +1952,17 @@ export declare enum SortOrder {
1799
1952
  DESC = "DESC"
1800
1953
  }
1801
1954
  export interface CursorPaging {
1802
- /** Maximum number of items to return in the results. */
1955
+ /**
1956
+ * Maximum number of items to return in the results.
1957
+ * @max 100
1958
+ */
1803
1959
  limit?: number | null;
1804
1960
  /**
1805
1961
  * Pointer to the next or previous page in the list of results.
1806
1962
  *
1807
1963
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1808
1964
  * Not relevant for the first request.
1965
+ * @maxLength 16000
1809
1966
  */
1810
1967
  cursor?: string | null;
1811
1968
  }
@@ -1829,13 +1986,22 @@ export interface CursorPagingMetadata {
1829
1986
  hasNext?: boolean | null;
1830
1987
  }
1831
1988
  export interface Cursors {
1832
- /** 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
+ */
1833
1993
  next?: string | null;
1834
- /** 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
+ */
1835
1998
  prev?: string | null;
1836
1999
  }
1837
2000
  export interface MarkCommentRequest {
1838
- /** ID of the comment to mark. */
2001
+ /**
2002
+ * ID of the comment to mark.
2003
+ * @format GUID
2004
+ */
1839
2005
  commentId: string;
1840
2006
  }
1841
2007
  export interface MarkCommentResponse {
@@ -1846,7 +2012,10 @@ export interface CommentMarked {
1846
2012
  comment?: Comment;
1847
2013
  }
1848
2014
  export interface UnmarkCommentRequest {
1849
- /** ID of the comment to unmark. */
2015
+ /**
2016
+ * ID of the comment to unmark.
2017
+ * @format GUID
2018
+ */
1850
2019
  commentId: string;
1851
2020
  }
1852
2021
  export interface UnmarkCommentResponse {
@@ -1857,7 +2026,10 @@ export interface CommentUnmarked {
1857
2026
  comment?: Comment;
1858
2027
  }
1859
2028
  export interface HideCommentRequest {
1860
- /** ID of the comment to hide. */
2029
+ /**
2030
+ * ID of the comment to hide.
2031
+ * @format GUID
2032
+ */
1861
2033
  commentId: string;
1862
2034
  }
1863
2035
  export interface HideCommentResponse {
@@ -1865,7 +2037,10 @@ export interface HideCommentResponse {
1865
2037
  comment?: Comment;
1866
2038
  }
1867
2039
  export interface PublishCommentRequest {
1868
- /** ID of the comment to publish. */
2040
+ /**
2041
+ * ID of the comment to publish.
2042
+ * @format GUID
2043
+ */
1869
2044
  commentId: string;
1870
2045
  }
1871
2046
  export interface PublishCommentResponse {
@@ -1874,7 +2049,10 @@ export interface PublishCommentResponse {
1874
2049
  }
1875
2050
  /** Count comments options. */
1876
2051
  export interface CountCommentsRequest {
1877
- /** App ID to count the comments of. */
2052
+ /**
2053
+ * App ID to count the comments of.
2054
+ * @format GUID
2055
+ */
1878
2056
  appId?: string;
1879
2057
  /** Filter to identify the comments that need to be counted. */
1880
2058
  filter?: Record<string, any> | null;
@@ -1884,20 +2062,28 @@ export interface CountCommentsResponse {
1884
2062
  count?: number;
1885
2063
  }
1886
2064
  export interface ListCommentsByResourceRequest {
1887
- /** 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
+ */
1888
2069
  appId: string;
1889
2070
  /**
1890
2071
  * ID of the specific context the comment is in response to.
1891
2072
  *
1892
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
1893
2075
  */
1894
2076
  contextId: string;
1895
- /** Reserved for internal use. */
2077
+ /**
2078
+ * Reserved for internal use.
2079
+ * @maxLength 128
2080
+ */
1896
2081
  contextType?: string;
1897
2082
  /**
1898
2083
  * ID of the specific resource that the comment is in response to.
1899
2084
  *
1900
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
1901
2087
  */
1902
2088
  resourceId: string;
1903
2089
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -1960,9 +2146,16 @@ export declare enum ReplySortOrder {
1960
2146
  export interface ListCommentsByResourceCursorPaging {
1961
2147
  /** Pointer to the next or previous page in the list of results. */
1962
2148
  cursor?: string | null;
1963
- /** Number of items to return. */
2149
+ /**
2150
+ * Number of items to return.
2151
+ * @min 1
2152
+ * @max 100
2153
+ */
1964
2154
  limit?: number | null;
1965
- /** 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
+ */
1966
2159
  repliesLimit?: number | null;
1967
2160
  }
1968
2161
  export interface ListCommentsByResourceResponse {
@@ -1982,11 +2175,15 @@ export interface RepliesListResponse {
1982
2175
  export interface GetCommentThreadRequest {
1983
2176
  /**
1984
2177
  * App ID.
2178
+ * @maxLength 128
1985
2179
  * @deprecated App ID.
1986
2180
  * @targetRemovalDate 2024-11-01
1987
2181
  */
1988
2182
  appId?: string;
1989
- /** Comment ID. */
2183
+ /**
2184
+ * Comment ID.
2185
+ * @format GUID
2186
+ */
1990
2187
  commentId: string;
1991
2188
  /** Comment sorting. */
1992
2189
  commentSort?: CommentSort;
@@ -2002,7 +2199,10 @@ export interface GetCommentThreadResponse {
2002
2199
  commentReplies?: Record<string, RepliesListResponse>;
2003
2200
  }
2004
2201
  export interface BulkPublishCommentRequest {
2005
- /** ID of the app where to publish the comment. */
2202
+ /**
2203
+ * ID of the app where to publish the comment.
2204
+ * @format GUID
2205
+ */
2006
2206
  appId: string;
2007
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"`}. */
2008
2208
  filter: Record<string, any> | null;
@@ -2012,11 +2212,15 @@ export interface BulkPublishCommentResponse {
2012
2212
  * Job ID.
2013
2213
  *
2014
2214
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2215
+ * @format GUID
2015
2216
  */
2016
2217
  jobId?: string;
2017
2218
  }
2018
2219
  export interface BulkHideCommentRequest {
2019
- /** ID of the app where to hide the comments. */
2220
+ /**
2221
+ * ID of the app where to hide the comments.
2222
+ * @format GUID
2223
+ */
2020
2224
  appId: string;
2021
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"`}. */
2022
2226
  filter: Record<string, any> | null;
@@ -2026,11 +2230,15 @@ export interface BulkHideCommentResponse {
2026
2230
  * Job ID.
2027
2231
  *
2028
2232
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2233
+ * @format GUID
2029
2234
  */
2030
2235
  jobId?: string;
2031
2236
  }
2032
2237
  export interface BulkDeleteCommentRequest {
2033
- /** ID of the app where to delete the comments. */
2238
+ /**
2239
+ * ID of the app where to delete the comments.
2240
+ * @format GUID
2241
+ */
2034
2242
  appId: string;
2035
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"`}. */
2036
2244
  filter: Record<string, any> | null;
@@ -2040,11 +2248,15 @@ export interface BulkDeleteCommentResponse {
2040
2248
  * Job ID.
2041
2249
  *
2042
2250
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2251
+ * @format GUID
2043
2252
  */
2044
2253
  jobId?: string;
2045
2254
  }
2046
2255
  export interface BulkModerateDraftContentRequest {
2047
- /** ID of the app where to moderate the comments. */
2256
+ /**
2257
+ * ID of the app where to moderate the comments.
2258
+ * @format GUID
2259
+ */
2048
2260
  appId: string;
2049
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"`}. */
2050
2262
  filter: Record<string, any> | null;
@@ -2056,11 +2268,15 @@ export interface BulkModerateDraftContentResponse {
2056
2268
  * Job ID.
2057
2269
  *
2058
2270
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2271
+ * @format GUID
2059
2272
  */
2060
2273
  jobId?: string;
2061
2274
  }
2062
2275
  export interface BulkMoveCommentByFilterRequest {
2063
- /** 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
+ */
2064
2280
  appId: string;
2065
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"`}. */
2066
2282
  filter: Record<string, any> | null;
@@ -2068,9 +2284,15 @@ export interface BulkMoveCommentByFilterRequest {
2068
2284
  destination?: Destination;
2069
2285
  }
2070
2286
  export interface Destination {
2071
- /** Context ID of where to move the comment to. */
2287
+ /**
2288
+ * Context ID of where to move the comment to.
2289
+ * @maxLength 128
2290
+ */
2072
2291
  contextId?: string;
2073
- /** Resource ID of where to move the comment to. */
2292
+ /**
2293
+ * Resource ID of where to move the comment to.
2294
+ * @maxLength 128
2295
+ */
2074
2296
  resourceId?: string;
2075
2297
  }
2076
2298
  export interface BulkMoveCommentByFilterResponse {
@@ -2078,6 +2300,7 @@ export interface BulkMoveCommentByFilterResponse {
2078
2300
  * Job ID.
2079
2301
  *
2080
2302
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2303
+ * @format GUID
2081
2304
  */
2082
2305
  jobId?: string;
2083
2306
  }
@@ -2156,9 +2379,15 @@ export interface ActionEvent {
2156
2379
  body?: string;
2157
2380
  }
2158
2381
  export interface MessageEnvelope {
2159
- /** App instance ID. */
2382
+ /**
2383
+ * App instance ID.
2384
+ * @format GUID
2385
+ */
2160
2386
  instanceId?: string | null;
2161
- /** Event type. */
2387
+ /**
2388
+ * Event type.
2389
+ * @maxLength 150
2390
+ */
2162
2391
  eventType?: string;
2163
2392
  /** The identification type and identity data. */
2164
2393
  identity?: IdentificationData;
@@ -2166,26 +2395,50 @@ export interface MessageEnvelope {
2166
2395
  data?: string;
2167
2396
  }
2168
2397
  export interface IdentificationData extends IdentificationDataIdOneOf {
2169
- /** 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
+ */
2170
2402
  anonymousVisitorId?: string;
2171
- /** 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
+ */
2172
2407
  memberId?: string;
2173
- /** ID of a Wix user (site owner, contributor, etc.). */
2408
+ /**
2409
+ * ID of a Wix user (site owner, contributor, etc.).
2410
+ * @format GUID
2411
+ */
2174
2412
  wixUserId?: string;
2175
- /** ID of an app. */
2413
+ /**
2414
+ * ID of an app.
2415
+ * @format GUID
2416
+ */
2176
2417
  appId?: string;
2177
2418
  /** @readonly */
2178
2419
  identityType?: WebhookIdentityType;
2179
2420
  }
2180
2421
  /** @oneof */
2181
2422
  export interface IdentificationDataIdOneOf {
2182
- /** 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
+ */
2183
2427
  anonymousVisitorId?: string;
2184
- /** 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
+ */
2185
2432
  memberId?: string;
2186
- /** ID of a Wix user (site owner, contributor, etc.). */
2433
+ /**
2434
+ * ID of a Wix user (site owner, contributor, etc.).
2435
+ * @format GUID
2436
+ */
2187
2437
  wixUserId?: string;
2188
- /** ID of an app. */
2438
+ /**
2439
+ * ID of an app.
2440
+ * @format GUID
2441
+ */
2189
2442
  appId?: string;
2190
2443
  }
2191
2444
  export declare enum WebhookIdentityType {
@@ -2527,9 +2780,15 @@ export interface BulkMoveCommentByFilterResponseNonNullableFields {
2527
2780
  jobId: string;
2528
2781
  }
2529
2782
  export interface BaseEventMetadata {
2530
- /** App instance ID. */
2783
+ /**
2784
+ * App instance ID.
2785
+ * @format GUID
2786
+ */
2531
2787
  instanceId?: string | null;
2532
- /** Event type. */
2788
+ /**
2789
+ * Event type.
2790
+ * @maxLength 150
2791
+ */
2533
2792
  eventType?: string;
2534
2793
  /** The identification type and identity data. */
2535
2794
  identity?: IdentificationData;
@@ -2794,6 +3053,7 @@ export declare function updateComment(_id: string | null, comment: UpdateComment
2794
3053
  export interface UpdateComment {
2795
3054
  /**
2796
3055
  * Comment ID.
3056
+ * @format GUID
2797
3057
  * @readonly
2798
3058
  */
2799
3059
  _id?: string | null;
@@ -2816,13 +3076,19 @@ export interface UpdateComment {
2816
3076
  * @readonly
2817
3077
  */
2818
3078
  _updatedDate?: Date | null;
2819
- /** 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
+ */
2820
3084
  appId?: string | null;
2821
3085
  /**
2822
3086
  * ID of the specific context the comment is in response to.
2823
3087
  *
2824
3088
  * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
2825
3089
  * the `forumPostId` is used as both the `contextId` and the `resourceId`.
3090
+ * @immutable
3091
+ * @maxLength 128
2826
3092
  */
2827
3093
  contextId?: string | null;
2828
3094
  /**
@@ -2830,11 +3096,16 @@ export interface UpdateComment {
2830
3096
  *
2831
3097
  * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
2832
3098
  * the `forumPostId` is used as both the `resourceId` and the `contextId`.
3099
+ * @immutable
3100
+ * @maxLength 128
2833
3101
  */
2834
3102
  resourceId?: string | null;
2835
3103
  /** Published comment content. */
2836
3104
  content?: CommentContent;
2837
- /** Comment's author. */
3105
+ /**
3106
+ * Comment's author.
3107
+ * @immutable
3108
+ */
2838
3109
  author?: CommentAuthor;
2839
3110
  /**
2840
3111
  * Parent comment information.
@@ -2871,7 +3142,10 @@ export interface UpdateComment {
2871
3142
  reactionSummary?: CommentReactionSummary;
2872
3143
  /** Whether the comment is marked. */
2873
3144
  marked?: boolean;
2874
- /** Date and time when the comment was actually created. */
3145
+ /**
3146
+ * Date and time when the comment was actually created.
3147
+ * @immutable
3148
+ */
2875
3149
  commentDate?: Date | null;
2876
3150
  /**
2877
3151
  * Whether the comment has the updated content.
@@ -3077,14 +3351,19 @@ export interface ListCommentsByResourceOptions {
3077
3351
  * ID of the specific context the comment is in response to.
3078
3352
  *
3079
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
3080
3355
  */
3081
3356
  contextId: string;
3082
- /** Reserved for internal use. */
3357
+ /**
3358
+ * Reserved for internal use.
3359
+ * @maxLength 128
3360
+ */
3083
3361
  contextType?: string;
3084
3362
  /**
3085
3363
  * ID of the specific resource that the comment is in response to.
3086
3364
  *
3087
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
3088
3367
  */
3089
3368
  resourceId: string;
3090
3369
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -3116,6 +3395,7 @@ export declare function getCommentThread(commentId: string, options?: GetComment
3116
3395
  export interface GetCommentThreadOptions {
3117
3396
  /**
3118
3397
  * App ID.
3398
+ * @maxLength 128
3119
3399
  * @deprecated App ID.
3120
3400
  * @targetRemovalDate 2024-11-01
3121
3401
  */