@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?: Audio;
1418
1500
  /** Information about the document. */
1419
1501
  document?: Document;
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 */
@@ -1464,6 +1549,7 @@ export interface Image {
1464
1549
  /**
1465
1550
  * Image size in bytes.
1466
1551
  * @readonly
1552
+ * @format DECIMAL_VALUE
1467
1553
  */
1468
1554
  sizeInBytes?: string | null;
1469
1555
  }
@@ -1475,6 +1561,7 @@ export interface VideoV2 {
1475
1561
  /**
1476
1562
  * Available resolutions for the video, starting with the optimal resolution.
1477
1563
  * @readonly
1564
+ * @maxSize 100
1478
1565
  */
1479
1566
  resolutions?: VideoResolution[];
1480
1567
  /**
@@ -1490,6 +1577,7 @@ export interface VideoV2 {
1490
1577
  /**
1491
1578
  * Original video size in bytes.
1492
1579
  * @readonly
1580
+ * @format DECIMAL_VALUE
1493
1581
  */
1494
1582
  sizeInBytes?: string | null;
1495
1583
  /**
@@ -1550,6 +1638,7 @@ export interface Audio {
1550
1638
  /**
1551
1639
  * Audio size in bytes.
1552
1640
  * @readonly
1641
+ * @format DECIMAL_VALUE
1553
1642
  */
1554
1643
  sizeInBytes?: string | null;
1555
1644
  /**
@@ -1600,6 +1689,7 @@ export interface Document {
1600
1689
  /**
1601
1690
  * Document size in bytes.
1602
1691
  * @readonly
1692
+ * @format DECIMAL_VALUE
1603
1693
  */
1604
1694
  sizeInBytes?: string | null;
1605
1695
  /**
@@ -1609,45 +1699,91 @@ export interface Document {
1609
1699
  filename?: string | null;
1610
1700
  }
1611
1701
  export interface ContentAuthor extends ContentAuthorAuthorOneOf {
1612
- /** Wix user ID. */
1702
+ /**
1703
+ * Wix user ID.
1704
+ * @format GUID
1705
+ */
1613
1706
  userId?: string | null;
1614
- /** Member ID. See the Members API for more details. */
1707
+ /**
1708
+ * Member ID. See the Members API for more details.
1709
+ * @format GUID
1710
+ */
1615
1711
  memberId?: string | null;
1616
- /** Visitor ID. */
1712
+ /**
1713
+ * Visitor ID.
1714
+ * @format GUID
1715
+ */
1617
1716
  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). */
1717
+ /**
1718
+ * 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).
1719
+ * @format GUID
1720
+ */
1619
1721
  appId?: string | null;
1620
1722
  }
1621
1723
  /** @oneof */
1622
1724
  export interface ContentAuthorAuthorOneOf {
1623
- /** Wix user ID. */
1725
+ /**
1726
+ * Wix user ID.
1727
+ * @format GUID
1728
+ */
1624
1729
  userId?: string | null;
1625
- /** Member ID. See the Members API for more details. */
1730
+ /**
1731
+ * Member ID. See the Members API for more details.
1732
+ * @format GUID
1733
+ */
1626
1734
  memberId?: string | null;
1627
- /** Visitor ID. */
1735
+ /**
1736
+ * Visitor ID.
1737
+ * @format GUID
1738
+ */
1628
1739
  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). */
1740
+ /**
1741
+ * 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).
1742
+ * @format GUID
1743
+ */
1630
1744
  appId?: string | null;
1631
1745
  }
1632
1746
  export interface CommentAuthor extends CommentAuthorIdentityOneOf {
1633
- /** Wix user ID. */
1747
+ /**
1748
+ * Wix user ID.
1749
+ * @format GUID
1750
+ */
1634
1751
  userId?: string | null;
1635
- /** Member ID. See the Members API for more details. */
1752
+ /**
1753
+ * Member ID. See the Members API for more details.
1754
+ * @format GUID
1755
+ */
1636
1756
  memberId?: string | null;
1637
- /** Visitor ID. */
1757
+ /**
1758
+ * Visitor ID.
1759
+ * @format GUID
1760
+ */
1638
1761
  visitorId?: string | null;
1639
1762
  }
1640
1763
  /** @oneof */
1641
1764
  export interface CommentAuthorIdentityOneOf {
1642
- /** Wix user ID. */
1765
+ /**
1766
+ * Wix user ID.
1767
+ * @format GUID
1768
+ */
1643
1769
  userId?: string | null;
1644
- /** Member ID. See the Members API for more details. */
1770
+ /**
1771
+ * Member ID. See the Members API for more details.
1772
+ * @format GUID
1773
+ */
1645
1774
  memberId?: string | null;
1646
- /** Visitor ID. */
1775
+ /**
1776
+ * Visitor ID.
1777
+ * @format GUID
1778
+ */
1647
1779
  visitorId?: string | null;
1648
1780
  }
1649
1781
  export interface ParentComment {
1650
- /** Comment ID of the parent comment. */
1782
+ /**
1783
+ * Comment ID of the parent comment.
1784
+ * @format GUID
1785
+ * @immutable
1786
+ */
1651
1787
  id?: string | null;
1652
1788
  /**
1653
1789
  * Author of the parent comment.
@@ -1704,9 +1840,15 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
1704
1840
  versionedUpdate?: VersionedDocumentUpdateOperation;
1705
1841
  /** delete by document ids with versioning */
1706
1842
  versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1707
- /** type of the documents */
1843
+ /**
1844
+ * type of the documents
1845
+ * @minLength 2
1846
+ */
1708
1847
  documentType?: string;
1709
- /** language of the documents (mandatory) */
1848
+ /**
1849
+ * language of the documents (mandatory)
1850
+ * @minLength 2
1851
+ */
1710
1852
  language?: string | null;
1711
1853
  /**
1712
1854
  * one or more search documents
@@ -1833,7 +1975,10 @@ export interface ResourceCommentCountChanged {
1833
1975
  publishedCommentCount?: number;
1834
1976
  }
1835
1977
  export interface GetCommentRequest {
1836
- /** ID of the comment to retrieve. */
1978
+ /**
1979
+ * ID of the comment to retrieve.
1980
+ * @format GUID
1981
+ */
1837
1982
  commentId: string;
1838
1983
  }
1839
1984
  export interface GetCommentResponse {
@@ -1858,7 +2003,10 @@ export interface CommentContentChanged {
1858
2003
  currentContent?: CommentContent;
1859
2004
  }
1860
2005
  export interface DeleteCommentRequest {
1861
- /** ID of the comment to delete. */
2006
+ /**
2007
+ * ID of the comment to delete.
2008
+ * @format GUID
2009
+ */
1862
2010
  commentId: string;
1863
2011
  }
1864
2012
  export interface DeleteCommentResponse {
@@ -1867,7 +2015,10 @@ export interface CommentDeleted {
1867
2015
  comment?: Comment;
1868
2016
  }
1869
2017
  export interface ModerateDraftContentRequest {
1870
- /** ID of the comment to moderate. */
2018
+ /**
2019
+ * ID of the comment to moderate.
2020
+ * @format GUID
2021
+ */
1871
2022
  commentId: string;
1872
2023
  /**
1873
2024
  * Revision number, which increments by `1` each time the comment is updated.
@@ -1892,7 +2043,10 @@ export interface CommentHidden {
1892
2043
  comment?: Comment;
1893
2044
  }
1894
2045
  export interface QueryCommentsRequest {
1895
- /** App ID to query comments for. */
2046
+ /**
2047
+ * App ID to query comments for.
2048
+ * @format GUID
2049
+ */
1896
2050
  appId: string;
1897
2051
  /** Query options. */
1898
2052
  query: CursorQuery;
@@ -1914,6 +2068,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1914
2068
  * Sort object.
1915
2069
  *
1916
2070
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2071
+ * @maxSize 5
1917
2072
  */
1918
2073
  sort?: Sorting[];
1919
2074
  }
@@ -1927,7 +2082,10 @@ export interface CursorQueryPagingMethodOneOf {
1927
2082
  cursorPaging?: CursorPaging;
1928
2083
  }
1929
2084
  export interface Sorting {
1930
- /** Name of the field to sort by. */
2085
+ /**
2086
+ * Name of the field to sort by.
2087
+ * @maxLength 512
2088
+ */
1931
2089
  fieldName?: string;
1932
2090
  /** Sort order. */
1933
2091
  order?: SortOrder;
@@ -1937,13 +2095,17 @@ export declare enum SortOrder {
1937
2095
  DESC = "DESC"
1938
2096
  }
1939
2097
  export interface CursorPaging {
1940
- /** Maximum number of items to return in the results. */
2098
+ /**
2099
+ * Maximum number of items to return in the results.
2100
+ * @max 100
2101
+ */
1941
2102
  limit?: number | null;
1942
2103
  /**
1943
2104
  * Pointer to the next or previous page in the list of results.
1944
2105
  *
1945
2106
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1946
2107
  * Not relevant for the first request.
2108
+ * @maxLength 16000
1947
2109
  */
1948
2110
  cursor?: string | null;
1949
2111
  }
@@ -1967,13 +2129,22 @@ export interface CursorPagingMetadata {
1967
2129
  hasNext?: boolean | null;
1968
2130
  }
1969
2131
  export interface Cursors {
1970
- /** Cursor string pointing to the next page in the list of results. */
2132
+ /**
2133
+ * Cursor string pointing to the next page in the list of results.
2134
+ * @maxLength 16000
2135
+ */
1971
2136
  next?: string | null;
1972
- /** Cursor pointing to the previous page in the list of results. */
2137
+ /**
2138
+ * Cursor pointing to the previous page in the list of results.
2139
+ * @maxLength 16000
2140
+ */
1973
2141
  prev?: string | null;
1974
2142
  }
1975
2143
  export interface MarkCommentRequest {
1976
- /** ID of the comment to mark. */
2144
+ /**
2145
+ * ID of the comment to mark.
2146
+ * @format GUID
2147
+ */
1977
2148
  commentId: string;
1978
2149
  }
1979
2150
  export interface MarkCommentResponse {
@@ -1984,7 +2155,10 @@ export interface CommentMarked {
1984
2155
  comment?: Comment;
1985
2156
  }
1986
2157
  export interface UnmarkCommentRequest {
1987
- /** ID of the comment to unmark. */
2158
+ /**
2159
+ * ID of the comment to unmark.
2160
+ * @format GUID
2161
+ */
1988
2162
  commentId: string;
1989
2163
  }
1990
2164
  export interface UnmarkCommentResponse {
@@ -1995,7 +2169,10 @@ export interface CommentUnmarked {
1995
2169
  comment?: Comment;
1996
2170
  }
1997
2171
  export interface HideCommentRequest {
1998
- /** ID of the comment to hide. */
2172
+ /**
2173
+ * ID of the comment to hide.
2174
+ * @format GUID
2175
+ */
1999
2176
  commentId: string;
2000
2177
  }
2001
2178
  export interface HideCommentResponse {
@@ -2003,7 +2180,10 @@ export interface HideCommentResponse {
2003
2180
  comment?: Comment;
2004
2181
  }
2005
2182
  export interface PublishCommentRequest {
2006
- /** ID of the comment to publish. */
2183
+ /**
2184
+ * ID of the comment to publish.
2185
+ * @format GUID
2186
+ */
2007
2187
  commentId: string;
2008
2188
  }
2009
2189
  export interface PublishCommentResponse {
@@ -2012,7 +2192,10 @@ export interface PublishCommentResponse {
2012
2192
  }
2013
2193
  /** Count comments options. */
2014
2194
  export interface CountCommentsRequest {
2015
- /** App ID to count the comments of. */
2195
+ /**
2196
+ * App ID to count the comments of.
2197
+ * @format GUID
2198
+ */
2016
2199
  appId?: string;
2017
2200
  /** Filter to identify the comments that need to be counted. */
2018
2201
  filter?: Record<string, any> | null;
@@ -2022,20 +2205,28 @@ export interface CountCommentsResponse {
2022
2205
  count?: number;
2023
2206
  }
2024
2207
  export interface ListCommentsByResourceRequest {
2025
- /** ID of the app from which the comments are listed. */
2208
+ /**
2209
+ * ID of the app from which the comments are listed.
2210
+ * @format GUID
2211
+ */
2026
2212
  appId: string;
2027
2213
  /**
2028
2214
  * ID of the specific context the comment is in response to.
2029
2215
  *
2030
2216
  * 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`.
2217
+ * @maxLength 128
2031
2218
  */
2032
2219
  contextId: string;
2033
- /** Reserved for internal use. */
2220
+ /**
2221
+ * Reserved for internal use.
2222
+ * @maxLength 128
2223
+ */
2034
2224
  contextType?: string;
2035
2225
  /**
2036
2226
  * ID of the specific resource that the comment is in response to.
2037
2227
  *
2038
2228
  * 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`.
2229
+ * @maxLength 128
2039
2230
  */
2040
2231
  resourceId: string;
2041
2232
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -2098,9 +2289,16 @@ export declare enum ReplySortOrder {
2098
2289
  export interface ListCommentsByResourceCursorPaging {
2099
2290
  /** Pointer to the next or previous page in the list of results. */
2100
2291
  cursor?: string | null;
2101
- /** Number of items to return. */
2292
+ /**
2293
+ * Number of items to return.
2294
+ * @min 1
2295
+ * @max 100
2296
+ */
2102
2297
  limit?: number | null;
2103
- /** Maximum number of replies in a response. Only applicable to parent comments. */
2298
+ /**
2299
+ * Maximum number of replies in a response. Only applicable to parent comments.
2300
+ * @max 100
2301
+ */
2104
2302
  repliesLimit?: number | null;
2105
2303
  }
2106
2304
  export interface ListCommentsByResourceResponse {
@@ -2120,11 +2318,15 @@ export interface RepliesListResponse {
2120
2318
  export interface GetCommentThreadRequest {
2121
2319
  /**
2122
2320
  * App ID.
2321
+ * @maxLength 128
2123
2322
  * @deprecated App ID.
2124
2323
  * @targetRemovalDate 2024-11-01
2125
2324
  */
2126
2325
  appId?: string;
2127
- /** Comment ID. */
2326
+ /**
2327
+ * Comment ID.
2328
+ * @format GUID
2329
+ */
2128
2330
  commentId: string;
2129
2331
  /** Comment sorting. */
2130
2332
  commentSort?: CommentSort;
@@ -2140,7 +2342,10 @@ export interface GetCommentThreadResponse {
2140
2342
  commentReplies?: Record<string, RepliesListResponse>;
2141
2343
  }
2142
2344
  export interface BulkPublishCommentRequest {
2143
- /** ID of the app where to publish the comment. */
2345
+ /**
2346
+ * ID of the app where to publish the comment.
2347
+ * @format GUID
2348
+ */
2144
2349
  appId: string;
2145
2350
  /** 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
2351
  filter: Record<string, any> | null;
@@ -2150,11 +2355,15 @@ export interface BulkPublishCommentResponse {
2150
2355
  * Job ID.
2151
2356
  *
2152
2357
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2358
+ * @format GUID
2153
2359
  */
2154
2360
  jobId?: string;
2155
2361
  }
2156
2362
  export interface BulkHideCommentRequest {
2157
- /** ID of the app where to hide the comments. */
2363
+ /**
2364
+ * ID of the app where to hide the comments.
2365
+ * @format GUID
2366
+ */
2158
2367
  appId: string;
2159
2368
  /** 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
2369
  filter: Record<string, any> | null;
@@ -2164,11 +2373,15 @@ export interface BulkHideCommentResponse {
2164
2373
  * Job ID.
2165
2374
  *
2166
2375
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2376
+ * @format GUID
2167
2377
  */
2168
2378
  jobId?: string;
2169
2379
  }
2170
2380
  export interface BulkDeleteCommentRequest {
2171
- /** ID of the app where to delete the comments. */
2381
+ /**
2382
+ * ID of the app where to delete the comments.
2383
+ * @format GUID
2384
+ */
2172
2385
  appId: string;
2173
2386
  /** 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
2387
  filter: Record<string, any> | null;
@@ -2178,11 +2391,15 @@ export interface BulkDeleteCommentResponse {
2178
2391
  * Job ID.
2179
2392
  *
2180
2393
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2394
+ * @format GUID
2181
2395
  */
2182
2396
  jobId?: string;
2183
2397
  }
2184
2398
  export interface BulkModerateDraftContentRequest {
2185
- /** ID of the app where to moderate the comments. */
2399
+ /**
2400
+ * ID of the app where to moderate the comments.
2401
+ * @format GUID
2402
+ */
2186
2403
  appId: string;
2187
2404
  /** 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
2405
  filter: Record<string, any> | null;
@@ -2194,11 +2411,15 @@ export interface BulkModerateDraftContentResponse {
2194
2411
  * Job ID.
2195
2412
  *
2196
2413
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2414
+ * @format GUID
2197
2415
  */
2198
2416
  jobId?: string;
2199
2417
  }
2200
2418
  export interface BulkMoveCommentByFilterRequest {
2201
- /** ID of the app from which to move the comments. */
2419
+ /**
2420
+ * ID of the app from which to move the comments.
2421
+ * @format GUID
2422
+ */
2202
2423
  appId: string;
2203
2424
  /** 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
2425
  filter: Record<string, any> | null;
@@ -2206,9 +2427,15 @@ export interface BulkMoveCommentByFilterRequest {
2206
2427
  destination?: Destination;
2207
2428
  }
2208
2429
  export interface Destination {
2209
- /** Context ID of where to move the comment to. */
2430
+ /**
2431
+ * Context ID of where to move the comment to.
2432
+ * @maxLength 128
2433
+ */
2210
2434
  contextId?: string;
2211
- /** Resource ID of where to move the comment to. */
2435
+ /**
2436
+ * Resource ID of where to move the comment to.
2437
+ * @maxLength 128
2438
+ */
2212
2439
  resourceId?: string;
2213
2440
  }
2214
2441
  export interface BulkMoveCommentByFilterResponse {
@@ -2216,6 +2443,7 @@ export interface BulkMoveCommentByFilterResponse {
2216
2443
  * Job ID.
2217
2444
  *
2218
2445
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2446
+ * @format GUID
2219
2447
  */
2220
2448
  jobId?: string;
2221
2449
  }
@@ -2296,9 +2524,15 @@ export interface ActionEvent {
2296
2524
  bodyAsJson?: string;
2297
2525
  }
2298
2526
  export interface MessageEnvelope {
2299
- /** App instance ID. */
2527
+ /**
2528
+ * App instance ID.
2529
+ * @format GUID
2530
+ */
2300
2531
  instanceId?: string | null;
2301
- /** Event type. */
2532
+ /**
2533
+ * Event type.
2534
+ * @maxLength 150
2535
+ */
2302
2536
  eventType?: string;
2303
2537
  /** The identification type and identity data. */
2304
2538
  identity?: IdentificationData;
@@ -2306,26 +2540,50 @@ export interface MessageEnvelope {
2306
2540
  data?: string;
2307
2541
  }
2308
2542
  export interface IdentificationData extends IdentificationDataIdOneOf {
2309
- /** ID of a site visitor that has not logged in to the site. */
2543
+ /**
2544
+ * ID of a site visitor that has not logged in to the site.
2545
+ * @format GUID
2546
+ */
2310
2547
  anonymousVisitorId?: string;
2311
- /** ID of a site visitor that has logged in to the site. */
2548
+ /**
2549
+ * ID of a site visitor that has logged in to the site.
2550
+ * @format GUID
2551
+ */
2312
2552
  memberId?: string;
2313
- /** ID of a Wix user (site owner, contributor, etc.). */
2553
+ /**
2554
+ * ID of a Wix user (site owner, contributor, etc.).
2555
+ * @format GUID
2556
+ */
2314
2557
  wixUserId?: string;
2315
- /** ID of an app. */
2558
+ /**
2559
+ * ID of an app.
2560
+ * @format GUID
2561
+ */
2316
2562
  appId?: string;
2317
2563
  /** @readonly */
2318
2564
  identityType?: WebhookIdentityType;
2319
2565
  }
2320
2566
  /** @oneof */
2321
2567
  export interface IdentificationDataIdOneOf {
2322
- /** ID of a site visitor that has not logged in to the site. */
2568
+ /**
2569
+ * ID of a site visitor that has not logged in to the site.
2570
+ * @format GUID
2571
+ */
2323
2572
  anonymousVisitorId?: string;
2324
- /** ID of a site visitor that has logged in to the site. */
2573
+ /**
2574
+ * ID of a site visitor that has logged in to the site.
2575
+ * @format GUID
2576
+ */
2325
2577
  memberId?: string;
2326
- /** ID of a Wix user (site owner, contributor, etc.). */
2578
+ /**
2579
+ * ID of a Wix user (site owner, contributor, etc.).
2580
+ * @format GUID
2581
+ */
2327
2582
  wixUserId?: string;
2328
- /** ID of an app. */
2583
+ /**
2584
+ * ID of an app.
2585
+ * @format GUID
2586
+ */
2329
2587
  appId?: string;
2330
2588
  }
2331
2589
  export declare enum WebhookIdentityType {