@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?: Audio;
1402
1500
  /** Information about the document. */
1403
1501
  document?: Document;
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 */
@@ -1448,6 +1549,7 @@ export interface Image {
1448
1549
  /**
1449
1550
  * Image size in bytes.
1450
1551
  * @readonly
1552
+ * @format DECIMAL_VALUE
1451
1553
  */
1452
1554
  sizeInBytes?: string | null;
1453
1555
  }
@@ -1459,6 +1561,7 @@ export interface VideoV2 {
1459
1561
  /**
1460
1562
  * Available resolutions for the video, starting with the optimal resolution.
1461
1563
  * @readonly
1564
+ * @maxSize 100
1462
1565
  */
1463
1566
  resolutions?: VideoResolution[];
1464
1567
  /**
@@ -1474,6 +1577,7 @@ export interface VideoV2 {
1474
1577
  /**
1475
1578
  * Original video size in bytes.
1476
1579
  * @readonly
1580
+ * @format DECIMAL_VALUE
1477
1581
  */
1478
1582
  sizeInBytes?: string | null;
1479
1583
  /**
@@ -1534,6 +1638,7 @@ export interface Audio {
1534
1638
  /**
1535
1639
  * Audio size in bytes.
1536
1640
  * @readonly
1641
+ * @format DECIMAL_VALUE
1537
1642
  */
1538
1643
  sizeInBytes?: string | null;
1539
1644
  /**
@@ -1584,6 +1689,7 @@ export interface Document {
1584
1689
  /**
1585
1690
  * Document size in bytes.
1586
1691
  * @readonly
1692
+ * @format DECIMAL_VALUE
1587
1693
  */
1588
1694
  sizeInBytes?: string | null;
1589
1695
  /**
@@ -1593,45 +1699,91 @@ export interface Document {
1593
1699
  filename?: string | null;
1594
1700
  }
1595
1701
  export interface ContentAuthor extends ContentAuthorAuthorOneOf {
1596
- /** Wix user ID. */
1702
+ /**
1703
+ * Wix user ID.
1704
+ * @format GUID
1705
+ */
1597
1706
  userId?: string | null;
1598
- /** Member ID. See the Members API for more details. */
1707
+ /**
1708
+ * Member ID. See the Members API for more details.
1709
+ * @format GUID
1710
+ */
1599
1711
  memberId?: string | null;
1600
- /** Visitor ID. */
1712
+ /**
1713
+ * Visitor ID.
1714
+ * @format GUID
1715
+ */
1601
1716
  visitorId?: string | null;
1602
- /** 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
+ */
1603
1721
  appId?: string | null;
1604
1722
  }
1605
1723
  /** @oneof */
1606
1724
  export interface ContentAuthorAuthorOneOf {
1607
- /** Wix user ID. */
1725
+ /**
1726
+ * Wix user ID.
1727
+ * @format GUID
1728
+ */
1608
1729
  userId?: string | null;
1609
- /** Member ID. See the Members API for more details. */
1730
+ /**
1731
+ * Member ID. See the Members API for more details.
1732
+ * @format GUID
1733
+ */
1610
1734
  memberId?: string | null;
1611
- /** Visitor ID. */
1735
+ /**
1736
+ * Visitor ID.
1737
+ * @format GUID
1738
+ */
1612
1739
  visitorId?: string | null;
1613
- /** 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
+ */
1614
1744
  appId?: string | null;
1615
1745
  }
1616
1746
  export interface CommentAuthor extends CommentAuthorIdentityOneOf {
1617
- /** Wix user ID. */
1747
+ /**
1748
+ * Wix user ID.
1749
+ * @format GUID
1750
+ */
1618
1751
  userId?: string | null;
1619
- /** Member ID. See the Members API for more details. */
1752
+ /**
1753
+ * Member ID. See the Members API for more details.
1754
+ * @format GUID
1755
+ */
1620
1756
  memberId?: string | null;
1621
- /** Visitor ID. */
1757
+ /**
1758
+ * Visitor ID.
1759
+ * @format GUID
1760
+ */
1622
1761
  visitorId?: string | null;
1623
1762
  }
1624
1763
  /** @oneof */
1625
1764
  export interface CommentAuthorIdentityOneOf {
1626
- /** Wix user ID. */
1765
+ /**
1766
+ * Wix user ID.
1767
+ * @format GUID
1768
+ */
1627
1769
  userId?: string | null;
1628
- /** Member ID. See the Members API for more details. */
1770
+ /**
1771
+ * Member ID. See the Members API for more details.
1772
+ * @format GUID
1773
+ */
1629
1774
  memberId?: string | null;
1630
- /** Visitor ID. */
1775
+ /**
1776
+ * Visitor ID.
1777
+ * @format GUID
1778
+ */
1631
1779
  visitorId?: string | null;
1632
1780
  }
1633
1781
  export interface ParentComment {
1634
- /** Comment ID of the parent comment. */
1782
+ /**
1783
+ * Comment ID of the parent comment.
1784
+ * @format GUID
1785
+ * @immutable
1786
+ */
1635
1787
  id?: string | null;
1636
1788
  /**
1637
1789
  * Author of the parent comment.
@@ -1688,9 +1840,15 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
1688
1840
  versionedUpdate?: VersionedDocumentUpdateOperation;
1689
1841
  /** delete by document ids with versioning */
1690
1842
  versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1691
- /** type of the documents */
1843
+ /**
1844
+ * type of the documents
1845
+ * @minLength 2
1846
+ */
1692
1847
  documentType?: string;
1693
- /** language of the documents (mandatory) */
1848
+ /**
1849
+ * language of the documents (mandatory)
1850
+ * @minLength 2
1851
+ */
1694
1852
  language?: string | null;
1695
1853
  /**
1696
1854
  * one or more search documents
@@ -1817,7 +1975,10 @@ export interface ResourceCommentCountChanged {
1817
1975
  publishedCommentCount?: number;
1818
1976
  }
1819
1977
  export interface GetCommentRequest {
1820
- /** ID of the comment to retrieve. */
1978
+ /**
1979
+ * ID of the comment to retrieve.
1980
+ * @format GUID
1981
+ */
1821
1982
  commentId: string;
1822
1983
  }
1823
1984
  export interface GetCommentResponse {
@@ -1842,7 +2003,10 @@ export interface CommentContentChanged {
1842
2003
  currentContent?: CommentContent;
1843
2004
  }
1844
2005
  export interface DeleteCommentRequest {
1845
- /** ID of the comment to delete. */
2006
+ /**
2007
+ * ID of the comment to delete.
2008
+ * @format GUID
2009
+ */
1846
2010
  commentId: string;
1847
2011
  }
1848
2012
  export interface DeleteCommentResponse {
@@ -1851,7 +2015,10 @@ export interface CommentDeleted {
1851
2015
  comment?: Comment;
1852
2016
  }
1853
2017
  export interface ModerateDraftContentRequest {
1854
- /** ID of the comment to moderate. */
2018
+ /**
2019
+ * ID of the comment to moderate.
2020
+ * @format GUID
2021
+ */
1855
2022
  commentId: string;
1856
2023
  /**
1857
2024
  * Revision number, which increments by `1` each time the comment is updated.
@@ -1876,7 +2043,10 @@ export interface CommentHidden {
1876
2043
  comment?: Comment;
1877
2044
  }
1878
2045
  export interface QueryCommentsRequest {
1879
- /** App ID to query comments for. */
2046
+ /**
2047
+ * App ID to query comments for.
2048
+ * @format GUID
2049
+ */
1880
2050
  appId: string;
1881
2051
  /** Query options. */
1882
2052
  query: CursorQuery;
@@ -1898,6 +2068,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1898
2068
  * Sort object.
1899
2069
  *
1900
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
1901
2072
  */
1902
2073
  sort?: Sorting[];
1903
2074
  }
@@ -1911,7 +2082,10 @@ export interface CursorQueryPagingMethodOneOf {
1911
2082
  cursorPaging?: CursorPaging;
1912
2083
  }
1913
2084
  export interface Sorting {
1914
- /** Name of the field to sort by. */
2085
+ /**
2086
+ * Name of the field to sort by.
2087
+ * @maxLength 512
2088
+ */
1915
2089
  fieldName?: string;
1916
2090
  /** Sort order. */
1917
2091
  order?: SortOrder;
@@ -1921,13 +2095,17 @@ export declare enum SortOrder {
1921
2095
  DESC = "DESC"
1922
2096
  }
1923
2097
  export interface CursorPaging {
1924
- /** Maximum number of items to return in the results. */
2098
+ /**
2099
+ * Maximum number of items to return in the results.
2100
+ * @max 100
2101
+ */
1925
2102
  limit?: number | null;
1926
2103
  /**
1927
2104
  * Pointer to the next or previous page in the list of results.
1928
2105
  *
1929
2106
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1930
2107
  * Not relevant for the first request.
2108
+ * @maxLength 16000
1931
2109
  */
1932
2110
  cursor?: string | null;
1933
2111
  }
@@ -1951,13 +2129,22 @@ export interface CursorPagingMetadata {
1951
2129
  hasNext?: boolean | null;
1952
2130
  }
1953
2131
  export interface Cursors {
1954
- /** 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
+ */
1955
2136
  next?: string | null;
1956
- /** 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
+ */
1957
2141
  prev?: string | null;
1958
2142
  }
1959
2143
  export interface MarkCommentRequest {
1960
- /** ID of the comment to mark. */
2144
+ /**
2145
+ * ID of the comment to mark.
2146
+ * @format GUID
2147
+ */
1961
2148
  commentId: string;
1962
2149
  }
1963
2150
  export interface MarkCommentResponse {
@@ -1968,7 +2155,10 @@ export interface CommentMarked {
1968
2155
  comment?: Comment;
1969
2156
  }
1970
2157
  export interface UnmarkCommentRequest {
1971
- /** ID of the comment to unmark. */
2158
+ /**
2159
+ * ID of the comment to unmark.
2160
+ * @format GUID
2161
+ */
1972
2162
  commentId: string;
1973
2163
  }
1974
2164
  export interface UnmarkCommentResponse {
@@ -1979,7 +2169,10 @@ export interface CommentUnmarked {
1979
2169
  comment?: Comment;
1980
2170
  }
1981
2171
  export interface HideCommentRequest {
1982
- /** ID of the comment to hide. */
2172
+ /**
2173
+ * ID of the comment to hide.
2174
+ * @format GUID
2175
+ */
1983
2176
  commentId: string;
1984
2177
  }
1985
2178
  export interface HideCommentResponse {
@@ -1987,7 +2180,10 @@ export interface HideCommentResponse {
1987
2180
  comment?: Comment;
1988
2181
  }
1989
2182
  export interface PublishCommentRequest {
1990
- /** ID of the comment to publish. */
2183
+ /**
2184
+ * ID of the comment to publish.
2185
+ * @format GUID
2186
+ */
1991
2187
  commentId: string;
1992
2188
  }
1993
2189
  export interface PublishCommentResponse {
@@ -1996,7 +2192,10 @@ export interface PublishCommentResponse {
1996
2192
  }
1997
2193
  /** Count comments options. */
1998
2194
  export interface CountCommentsRequest {
1999
- /** App ID to count the comments of. */
2195
+ /**
2196
+ * App ID to count the comments of.
2197
+ * @format GUID
2198
+ */
2000
2199
  appId?: string;
2001
2200
  /** Filter to identify the comments that need to be counted. */
2002
2201
  filter?: Record<string, any> | null;
@@ -2006,20 +2205,28 @@ export interface CountCommentsResponse {
2006
2205
  count?: number;
2007
2206
  }
2008
2207
  export interface ListCommentsByResourceRequest {
2009
- /** 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
+ */
2010
2212
  appId: string;
2011
2213
  /**
2012
2214
  * ID of the specific context the comment is in response to.
2013
2215
  *
2014
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
2015
2218
  */
2016
2219
  contextId: string;
2017
- /** Reserved for internal use. */
2220
+ /**
2221
+ * Reserved for internal use.
2222
+ * @maxLength 128
2223
+ */
2018
2224
  contextType?: string;
2019
2225
  /**
2020
2226
  * ID of the specific resource that the comment is in response to.
2021
2227
  *
2022
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
2023
2230
  */
2024
2231
  resourceId: string;
2025
2232
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -2082,9 +2289,16 @@ export declare enum ReplySortOrder {
2082
2289
  export interface ListCommentsByResourceCursorPaging {
2083
2290
  /** Pointer to the next or previous page in the list of results. */
2084
2291
  cursor?: string | null;
2085
- /** Number of items to return. */
2292
+ /**
2293
+ * Number of items to return.
2294
+ * @min 1
2295
+ * @max 100
2296
+ */
2086
2297
  limit?: number | null;
2087
- /** 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
+ */
2088
2302
  repliesLimit?: number | null;
2089
2303
  }
2090
2304
  export interface ListCommentsByResourceResponse {
@@ -2104,11 +2318,15 @@ export interface RepliesListResponse {
2104
2318
  export interface GetCommentThreadRequest {
2105
2319
  /**
2106
2320
  * App ID.
2321
+ * @maxLength 128
2107
2322
  * @deprecated App ID.
2108
2323
  * @targetRemovalDate 2024-11-01
2109
2324
  */
2110
2325
  appId?: string;
2111
- /** Comment ID. */
2326
+ /**
2327
+ * Comment ID.
2328
+ * @format GUID
2329
+ */
2112
2330
  commentId: string;
2113
2331
  /** Comment sorting. */
2114
2332
  commentSort?: CommentSort;
@@ -2124,7 +2342,10 @@ export interface GetCommentThreadResponse {
2124
2342
  commentReplies?: Record<string, RepliesListResponse>;
2125
2343
  }
2126
2344
  export interface BulkPublishCommentRequest {
2127
- /** ID of the app where to publish the comment. */
2345
+ /**
2346
+ * ID of the app where to publish the comment.
2347
+ * @format GUID
2348
+ */
2128
2349
  appId: string;
2129
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"`}. */
2130
2351
  filter: Record<string, any> | null;
@@ -2134,11 +2355,15 @@ export interface BulkPublishCommentResponse {
2134
2355
  * Job ID.
2135
2356
  *
2136
2357
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2358
+ * @format GUID
2137
2359
  */
2138
2360
  jobId?: string;
2139
2361
  }
2140
2362
  export interface BulkHideCommentRequest {
2141
- /** ID of the app where to hide the comments. */
2363
+ /**
2364
+ * ID of the app where to hide the comments.
2365
+ * @format GUID
2366
+ */
2142
2367
  appId: string;
2143
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"`}. */
2144
2369
  filter: Record<string, any> | null;
@@ -2148,11 +2373,15 @@ export interface BulkHideCommentResponse {
2148
2373
  * Job ID.
2149
2374
  *
2150
2375
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2376
+ * @format GUID
2151
2377
  */
2152
2378
  jobId?: string;
2153
2379
  }
2154
2380
  export interface BulkDeleteCommentRequest {
2155
- /** ID of the app where to delete the comments. */
2381
+ /**
2382
+ * ID of the app where to delete the comments.
2383
+ * @format GUID
2384
+ */
2156
2385
  appId: string;
2157
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"`}. */
2158
2387
  filter: Record<string, any> | null;
@@ -2162,11 +2391,15 @@ export interface BulkDeleteCommentResponse {
2162
2391
  * Job ID.
2163
2392
  *
2164
2393
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2394
+ * @format GUID
2165
2395
  */
2166
2396
  jobId?: string;
2167
2397
  }
2168
2398
  export interface BulkModerateDraftContentRequest {
2169
- /** ID of the app where to moderate the comments. */
2399
+ /**
2400
+ * ID of the app where to moderate the comments.
2401
+ * @format GUID
2402
+ */
2170
2403
  appId: string;
2171
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"`}. */
2172
2405
  filter: Record<string, any> | null;
@@ -2178,11 +2411,15 @@ export interface BulkModerateDraftContentResponse {
2178
2411
  * Job ID.
2179
2412
  *
2180
2413
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2414
+ * @format GUID
2181
2415
  */
2182
2416
  jobId?: string;
2183
2417
  }
2184
2418
  export interface BulkMoveCommentByFilterRequest {
2185
- /** 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
+ */
2186
2423
  appId: string;
2187
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"`}. */
2188
2425
  filter: Record<string, any> | null;
@@ -2190,9 +2427,15 @@ export interface BulkMoveCommentByFilterRequest {
2190
2427
  destination?: Destination;
2191
2428
  }
2192
2429
  export interface Destination {
2193
- /** Context ID of where to move the comment to. */
2430
+ /**
2431
+ * Context ID of where to move the comment to.
2432
+ * @maxLength 128
2433
+ */
2194
2434
  contextId?: string;
2195
- /** Resource ID of where to move the comment to. */
2435
+ /**
2436
+ * Resource ID of where to move the comment to.
2437
+ * @maxLength 128
2438
+ */
2196
2439
  resourceId?: string;
2197
2440
  }
2198
2441
  export interface BulkMoveCommentByFilterResponse {
@@ -2200,6 +2443,7 @@ export interface BulkMoveCommentByFilterResponse {
2200
2443
  * Job ID.
2201
2444
  *
2202
2445
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2446
+ * @format GUID
2203
2447
  */
2204
2448
  jobId?: string;
2205
2449
  }
@@ -2280,9 +2524,15 @@ export interface ActionEvent {
2280
2524
  bodyAsJson?: string;
2281
2525
  }
2282
2526
  export interface MessageEnvelope {
2283
- /** App instance ID. */
2527
+ /**
2528
+ * App instance ID.
2529
+ * @format GUID
2530
+ */
2284
2531
  instanceId?: string | null;
2285
- /** Event type. */
2532
+ /**
2533
+ * Event type.
2534
+ * @maxLength 150
2535
+ */
2286
2536
  eventType?: string;
2287
2537
  /** The identification type and identity data. */
2288
2538
  identity?: IdentificationData;
@@ -2290,26 +2540,50 @@ export interface MessageEnvelope {
2290
2540
  data?: string;
2291
2541
  }
2292
2542
  export interface IdentificationData extends IdentificationDataIdOneOf {
2293
- /** 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
+ */
2294
2547
  anonymousVisitorId?: string;
2295
- /** 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
+ */
2296
2552
  memberId?: string;
2297
- /** ID of a Wix user (site owner, contributor, etc.). */
2553
+ /**
2554
+ * ID of a Wix user (site owner, contributor, etc.).
2555
+ * @format GUID
2556
+ */
2298
2557
  wixUserId?: string;
2299
- /** ID of an app. */
2558
+ /**
2559
+ * ID of an app.
2560
+ * @format GUID
2561
+ */
2300
2562
  appId?: string;
2301
2563
  /** @readonly */
2302
2564
  identityType?: WebhookIdentityType;
2303
2565
  }
2304
2566
  /** @oneof */
2305
2567
  export interface IdentificationDataIdOneOf {
2306
- /** 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
+ */
2307
2572
  anonymousVisitorId?: string;
2308
- /** 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
+ */
2309
2577
  memberId?: string;
2310
- /** ID of a Wix user (site owner, contributor, etc.). */
2578
+ /**
2579
+ * ID of a Wix user (site owner, contributor, etc.).
2580
+ * @format GUID
2581
+ */
2311
2582
  wixUserId?: string;
2312
- /** ID of an app. */
2583
+ /**
2584
+ * ID of an app.
2585
+ * @format GUID
2586
+ */
2313
2587
  appId?: string;
2314
2588
  }
2315
2589
  export declare enum WebhookIdentityType {