@wix/auto_sdk_comments_comments 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/build/cjs/src/comments-v2-comment-comments.context.d.ts +2 -2
  2. package/build/cjs/src/comments-v2-comment-comments.context.js +3 -2
  3. package/build/cjs/src/comments-v2-comment-comments.context.js.map +1 -1
  4. package/build/cjs/src/comments-v2-comment-comments.http.js +104 -98
  5. package/build/cjs/src/comments-v2-comment-comments.http.js.map +1 -1
  6. package/build/cjs/src/comments-v2-comment-comments.public.d.ts +1 -1
  7. package/build/cjs/src/comments-v2-comment-comments.public.js +3 -2
  8. package/build/cjs/src/comments-v2-comment-comments.public.js.map +1 -1
  9. package/build/cjs/src/comments-v2-comment-comments.types.d.ts +385 -78
  10. package/build/cjs/src/comments-v2-comment-comments.types.js +12 -1
  11. package/build/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
  12. package/build/cjs/src/comments-v2-comment-comments.universal.d.ts +413 -84
  13. package/build/cjs/src/comments-v2-comment-comments.universal.js +29 -18
  14. package/build/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
  15. package/build/es/src/comments-v2-comment-comments.context.d.ts +2 -2
  16. package/build/es/src/comments-v2-comment-comments.context.js +1 -1
  17. package/build/es/src/comments-v2-comment-comments.context.js.map +1 -1
  18. package/build/es/src/comments-v2-comment-comments.http.js +104 -98
  19. package/build/es/src/comments-v2-comment-comments.http.js.map +1 -1
  20. package/build/es/src/comments-v2-comment-comments.public.d.ts +1 -1
  21. package/build/es/src/comments-v2-comment-comments.public.js +1 -1
  22. package/build/es/src/comments-v2-comment-comments.public.js.map +1 -1
  23. package/build/es/src/comments-v2-comment-comments.types.d.ts +385 -78
  24. package/build/es/src/comments-v2-comment-comments.types.js +11 -0
  25. package/build/es/src/comments-v2-comment-comments.types.js.map +1 -1
  26. package/build/es/src/comments-v2-comment-comments.universal.d.ts +413 -84
  27. package/build/es/src/comments-v2-comment-comments.universal.js +27 -16
  28. package/build/es/src/comments-v2-comment-comments.universal.js.map +1 -1
  29. package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +2 -2
  30. package/build/internal/cjs/src/comments-v2-comment-comments.context.js +3 -2
  31. package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +1 -1
  32. package/build/internal/cjs/src/comments-v2-comment-comments.http.js +104 -98
  33. package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +1 -1
  34. package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +1 -1
  35. package/build/internal/cjs/src/comments-v2-comment-comments.public.js +3 -2
  36. package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +1 -1
  37. package/build/internal/cjs/src/comments-v2-comment-comments.types.d.ts +385 -78
  38. package/build/internal/cjs/src/comments-v2-comment-comments.types.js +12 -1
  39. package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
  40. package/build/internal/cjs/src/comments-v2-comment-comments.universal.d.ts +413 -84
  41. package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +29 -18
  42. package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
  43. package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +2 -2
  44. package/build/internal/es/src/comments-v2-comment-comments.context.js +1 -1
  45. package/build/internal/es/src/comments-v2-comment-comments.context.js.map +1 -1
  46. package/build/internal/es/src/comments-v2-comment-comments.http.js +104 -98
  47. package/build/internal/es/src/comments-v2-comment-comments.http.js.map +1 -1
  48. package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +1 -1
  49. package/build/internal/es/src/comments-v2-comment-comments.public.js +1 -1
  50. package/build/internal/es/src/comments-v2-comment-comments.public.js.map +1 -1
  51. package/build/internal/es/src/comments-v2-comment-comments.types.d.ts +385 -78
  52. package/build/internal/es/src/comments-v2-comment-comments.types.js +11 -0
  53. package/build/internal/es/src/comments-v2-comment-comments.types.js.map +1 -1
  54. package/build/internal/es/src/comments-v2-comment-comments.universal.d.ts +413 -84
  55. package/build/internal/es/src/comments-v2-comment-comments.universal.js +27 -16
  56. package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +1 -1
  57. package/package.json +2 -2
@@ -6,6 +6,7 @@
6
6
  export interface Comment {
7
7
  /**
8
8
  * Comment ID.
9
+ * @format GUID
9
10
  * @readonly
10
11
  */
11
12
  _id?: string | null;
@@ -28,13 +29,19 @@ export interface Comment {
28
29
  * @readonly
29
30
  */
30
31
  _updatedDate?: Date | null;
31
- /** ID of the app that the comment is added to. */
32
+ /**
33
+ * ID of the app that the comment is added to.
34
+ * @format GUID
35
+ * @immutable
36
+ */
32
37
  appId?: string | null;
33
38
  /**
34
39
  * ID of the specific context the comment is in response to.
35
40
  *
36
41
  * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
37
42
  * the `forumPostId` is used as both the `contextId` and the `resourceId`.
43
+ * @immutable
44
+ * @maxLength 128
38
45
  */
39
46
  contextId?: string | null;
40
47
  /**
@@ -42,11 +49,16 @@ export interface Comment {
42
49
  *
43
50
  * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
44
51
  * the `forumPostId` is used as both the `resourceId` and the `contextId`.
52
+ * @immutable
53
+ * @maxLength 128
45
54
  */
46
55
  resourceId?: string | null;
47
56
  /** Published comment content. */
48
57
  content?: CommentContent;
49
- /** Comment's author. */
58
+ /**
59
+ * Comment's author.
60
+ * @immutable
61
+ */
50
62
  author?: CommentAuthor;
51
63
  /**
52
64
  * Parent comment information.
@@ -83,7 +95,10 @@ export interface Comment {
83
95
  reactionSummary?: CommentReactionSummary;
84
96
  /** Whether the comment is marked. */
85
97
  marked?: boolean;
86
- /** Date and time when the comment was actually created. */
98
+ /**
99
+ * Date and time when the comment was actually created.
100
+ * @immutable
101
+ */
87
102
  commentDate?: Date | null;
88
103
  /**
89
104
  * Whether the comment has the updated content.
@@ -105,9 +120,13 @@ export interface CommentContent {
105
120
  * People to tag with this comment.
106
121
  *
107
122
  * People can include users, members, visitors, or groups.
123
+ * @maxSize 10
108
124
  */
109
125
  mentions?: Mention[];
110
- /** Content attachments. */
126
+ /**
127
+ * Content attachments.
128
+ * @maxSize 10
129
+ */
111
130
  attachments?: Attachment[];
112
131
  }
113
132
  export interface RichContent {
@@ -708,11 +727,20 @@ export interface GIFData {
708
727
  gifType?: GIFType;
709
728
  }
710
729
  export interface GIF {
711
- /** GIF format URL. */
730
+ /**
731
+ * GIF format URL.
732
+ * @format WEB_URL
733
+ */
712
734
  gif?: string | null;
713
- /** MP4 format URL. */
735
+ /**
736
+ * MP4 format URL.
737
+ * @format WEB_URL
738
+ */
714
739
  mp4?: string | null;
715
- /** Thumbnail URL. */
740
+ /**
741
+ * Thumbnail URL.
742
+ * @format WEB_URL
743
+ */
716
744
  still?: string | null;
717
745
  }
718
746
  export declare enum GIFType {
@@ -786,7 +814,10 @@ export interface ImageData {
786
814
  export interface StylesBorder {
787
815
  /** Border width in pixels. */
788
816
  width?: number | null;
789
- /** Border color. */
817
+ /**
818
+ * Border color as a hexadecimal value.
819
+ * @format COLOR_HEX
820
+ */
790
821
  color?: string | null;
791
822
  /** Border radius in pixels. */
792
823
  radius?: number | null;
@@ -808,6 +839,51 @@ export interface LinkPreviewData {
808
839
  description?: string | null;
809
840
  /** The preview content as HTML. */
810
841
  html?: string | null;
842
+ /** Styling for the link preview. */
843
+ styles?: LinkPreviewDataStyles;
844
+ }
845
+ export declare enum Position {
846
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
847
+ START = "START",
848
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
849
+ END = "END",
850
+ /** Thumbnail positioned at the top */
851
+ TOP = "TOP",
852
+ /** Thumbnail hidden and not displayed */
853
+ HIDDEN = "HIDDEN"
854
+ }
855
+ export interface LinkPreviewDataStyles {
856
+ /**
857
+ * Background color as a hexadecimal value.
858
+ * @format COLOR_HEX
859
+ */
860
+ backgroundColor?: string | null;
861
+ /**
862
+ * Title color as a hexadecimal value.
863
+ * @format COLOR_HEX
864
+ */
865
+ titleColor?: string | null;
866
+ /**
867
+ * Subtitle color as a hexadecimal value.
868
+ * @format COLOR_HEX
869
+ */
870
+ subtitleColor?: string | null;
871
+ /**
872
+ * Link color as a hexadecimal value.
873
+ * @format COLOR_HEX
874
+ */
875
+ linkColor?: string | null;
876
+ /** Border width in pixels. */
877
+ borderWidth?: number | null;
878
+ /** Border radius in pixels. */
879
+ borderRadius?: number | null;
880
+ /**
881
+ * Border color as a hexadecimal value.
882
+ * @format COLOR_HEX
883
+ */
884
+ borderColor?: string | null;
885
+ /** Position of thumbnail. Defaults to `START`. */
886
+ thumbnailPosition?: Position;
811
887
  }
812
888
  export interface MapData {
813
889
  /** Styling for the map's container. */
@@ -940,13 +1016,22 @@ export declare enum BackgroundType {
940
1016
  export interface Gradient {
941
1017
  /** The gradient angle in degrees. */
942
1018
  angle?: number | null;
943
- /** The start color as a hexademical value. */
1019
+ /**
1020
+ * The start color as a hexademical value.
1021
+ * @format COLOR_HEX
1022
+ */
944
1023
  startColor?: string | null;
945
- /** The end color as a hexademical value. */
1024
+ /**
1025
+ * The end color as a hexademical value.
1026
+ * @format COLOR_HEX
1027
+ */
946
1028
  lastColor?: string | null;
947
1029
  }
948
1030
  export interface Background extends BackgroundBackgroundOneOf {
949
- /** The background color as a hexademical value. */
1031
+ /**
1032
+ * The background color as a hexademical value.
1033
+ * @format COLOR_HEX
1034
+ */
950
1035
  color?: string | null;
951
1036
  /** An image to use for the background. */
952
1037
  image?: Media;
@@ -957,7 +1042,10 @@ export interface Background extends BackgroundBackgroundOneOf {
957
1042
  }
958
1043
  /** @oneof */
959
1044
  export interface BackgroundBackgroundOneOf {
960
- /** The background color as a hexademical value. */
1045
+ /**
1046
+ * The background color as a hexademical value.
1047
+ * @format COLOR_HEX
1048
+ */
961
1049
  color?: string | null;
962
1050
  /** An image to use for the background. */
963
1051
  image?: Media;
@@ -1269,17 +1357,32 @@ export declare enum VerticalAlignment {
1269
1357
  export interface CellStyle {
1270
1358
  /** Vertical alignment for the cell's text. */
1271
1359
  verticalAlignment?: VerticalAlignment;
1272
- /** Cell background color as a hexadecimal value. */
1360
+ /**
1361
+ * Cell background color as a hexadecimal value.
1362
+ * @format COLOR_HEX
1363
+ */
1273
1364
  backgroundColor?: string | null;
1274
1365
  }
1275
1366
  export interface BorderColors {
1276
- /** Left border color as a hexadecimal value. */
1367
+ /**
1368
+ * Left border color as a hexadecimal value.
1369
+ * @format COLOR_HEX
1370
+ */
1277
1371
  left?: string | null;
1278
- /** Right border color as a hexadecimal value. */
1372
+ /**
1373
+ * Right border color as a hexadecimal value.
1374
+ * @format COLOR_HEX
1375
+ */
1279
1376
  right?: string | null;
1280
- /** Top border color as a hexadecimal value. */
1377
+ /**
1378
+ * Top border color as a hexadecimal value.
1379
+ * @format COLOR_HEX
1380
+ */
1281
1381
  top?: string | null;
1282
- /** Bottom border color as a hexadecimal value. */
1382
+ /**
1383
+ * Bottom border color as a hexadecimal value.
1384
+ * @format COLOR_HEX
1385
+ */
1283
1386
  bottom?: string | null;
1284
1387
  }
1285
1388
  /**
@@ -1388,24 +1491,48 @@ export interface TextNodeStyle {
1388
1491
  lineHeight?: string | null;
1389
1492
  }
1390
1493
  export interface Mention extends MentionIdentityOneOf {
1391
- /** Wix user ID. */
1494
+ /**
1495
+ * Wix user ID.
1496
+ * @format GUID
1497
+ */
1392
1498
  userId?: string | null;
1393
- /** Member ID. See the Members API for more details. */
1499
+ /**
1500
+ * Member ID. See the Members API for more details.
1501
+ * @format GUID
1502
+ */
1394
1503
  memberId?: string | null;
1395
- /** Visitor ID. */
1504
+ /**
1505
+ * Visitor ID.
1506
+ * @format GUID
1507
+ */
1396
1508
  visitorId?: string | null;
1397
- /** Group ID. See the Groups API for more details. */
1509
+ /**
1510
+ * Group ID. See the Groups API for more details.
1511
+ * @format GUID
1512
+ */
1398
1513
  groupId?: string | null;
1399
1514
  }
1400
1515
  /** @oneof */
1401
1516
  export interface MentionIdentityOneOf {
1402
- /** Wix user ID. */
1517
+ /**
1518
+ * Wix user ID.
1519
+ * @format GUID
1520
+ */
1403
1521
  userId?: string | null;
1404
- /** Member ID. See the Members API for more details. */
1522
+ /**
1523
+ * Member ID. See the Members API for more details.
1524
+ * @format GUID
1525
+ */
1405
1526
  memberId?: string | null;
1406
- /** Visitor ID. */
1527
+ /**
1528
+ * Visitor ID.
1529
+ * @format GUID
1530
+ */
1407
1531
  visitorId?: string | null;
1408
- /** Group ID. See the Groups API for more details. */
1532
+ /**
1533
+ * Group ID. See the Groups API for more details.
1534
+ * @format GUID
1535
+ */
1409
1536
  groupId?: string | null;
1410
1537
  }
1411
1538
  export interface Attachment extends AttachmentMediaOneOf {
@@ -1417,7 +1544,10 @@ export interface Attachment extends AttachmentMediaOneOf {
1417
1544
  audio?: string;
1418
1545
  /** Information about the document. */
1419
1546
  document?: string;
1420
- /** Mime type of attachment. */
1547
+ /**
1548
+ * Mime type of attachment.
1549
+ * @maxLength 3000
1550
+ */
1421
1551
  mimeType?: string | null;
1422
1552
  }
1423
1553
  /** @oneof */
@@ -1471,45 +1601,91 @@ export interface VideoResolution {
1471
1601
  assetKey?: string | null;
1472
1602
  }
1473
1603
  export interface ContentAuthor extends ContentAuthorAuthorOneOf {
1474
- /** Wix user ID. */
1604
+ /**
1605
+ * Wix user ID.
1606
+ * @format GUID
1607
+ */
1475
1608
  userId?: string | null;
1476
- /** Member ID. See the Members API for more details. */
1609
+ /**
1610
+ * Member ID. See the Members API for more details.
1611
+ * @format GUID
1612
+ */
1477
1613
  memberId?: string | null;
1478
- /** Visitor ID. */
1614
+ /**
1615
+ * Visitor ID.
1616
+ * @format GUID
1617
+ */
1479
1618
  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). */
1619
+ /**
1620
+ * 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).
1621
+ * @format GUID
1622
+ */
1481
1623
  appId?: string | null;
1482
1624
  }
1483
1625
  /** @oneof */
1484
1626
  export interface ContentAuthorAuthorOneOf {
1485
- /** Wix user ID. */
1627
+ /**
1628
+ * Wix user ID.
1629
+ * @format GUID
1630
+ */
1486
1631
  userId?: string | null;
1487
- /** Member ID. See the Members API for more details. */
1632
+ /**
1633
+ * Member ID. See the Members API for more details.
1634
+ * @format GUID
1635
+ */
1488
1636
  memberId?: string | null;
1489
- /** Visitor ID. */
1637
+ /**
1638
+ * Visitor ID.
1639
+ * @format GUID
1640
+ */
1490
1641
  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). */
1642
+ /**
1643
+ * 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).
1644
+ * @format GUID
1645
+ */
1492
1646
  appId?: string | null;
1493
1647
  }
1494
1648
  export interface CommentAuthor extends CommentAuthorIdentityOneOf {
1495
- /** Wix user ID. */
1649
+ /**
1650
+ * Wix user ID.
1651
+ * @format GUID
1652
+ */
1496
1653
  userId?: string | null;
1497
- /** Member ID. See the Members API for more details. */
1654
+ /**
1655
+ * Member ID. See the Members API for more details.
1656
+ * @format GUID
1657
+ */
1498
1658
  memberId?: string | null;
1499
- /** Visitor ID. */
1659
+ /**
1660
+ * Visitor ID.
1661
+ * @format GUID
1662
+ */
1500
1663
  visitorId?: string | null;
1501
1664
  }
1502
1665
  /** @oneof */
1503
1666
  export interface CommentAuthorIdentityOneOf {
1504
- /** Wix user ID. */
1667
+ /**
1668
+ * Wix user ID.
1669
+ * @format GUID
1670
+ */
1505
1671
  userId?: string | null;
1506
- /** Member ID. See the Members API for more details. */
1672
+ /**
1673
+ * Member ID. See the Members API for more details.
1674
+ * @format GUID
1675
+ */
1507
1676
  memberId?: string | null;
1508
- /** Visitor ID. */
1677
+ /**
1678
+ * Visitor ID.
1679
+ * @format GUID
1680
+ */
1509
1681
  visitorId?: string | null;
1510
1682
  }
1511
1683
  export interface ParentComment {
1512
- /** Comment ID of the parent comment. */
1684
+ /**
1685
+ * Comment ID of the parent comment.
1686
+ * @format GUID
1687
+ * @immutable
1688
+ */
1513
1689
  _id?: string | null;
1514
1690
  /**
1515
1691
  * Author of the parent comment.
@@ -1566,9 +1742,15 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
1566
1742
  versionedUpdate?: VersionedDocumentUpdateOperation;
1567
1743
  /** delete by document ids with versioning */
1568
1744
  versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1569
- /** type of the documents */
1745
+ /**
1746
+ * type of the documents
1747
+ * @minLength 2
1748
+ */
1570
1749
  documentType?: string;
1571
- /** language of the documents (mandatory) */
1750
+ /**
1751
+ * language of the documents (mandatory)
1752
+ * @minLength 2
1753
+ */
1572
1754
  language?: string | null;
1573
1755
  /**
1574
1756
  * one or more search documents
@@ -1695,7 +1877,10 @@ export interface ResourceCommentCountChanged {
1695
1877
  publishedCommentCount?: number;
1696
1878
  }
1697
1879
  export interface GetCommentRequest {
1698
- /** ID of the comment to retrieve. */
1880
+ /**
1881
+ * ID of the comment to retrieve.
1882
+ * @format GUID
1883
+ */
1699
1884
  commentId: string;
1700
1885
  }
1701
1886
  export interface GetCommentResponse {
@@ -1720,7 +1905,10 @@ export interface CommentContentChanged {
1720
1905
  currentContent?: CommentContent;
1721
1906
  }
1722
1907
  export interface DeleteCommentRequest {
1723
- /** ID of the comment to delete. */
1908
+ /**
1909
+ * ID of the comment to delete.
1910
+ * @format GUID
1911
+ */
1724
1912
  commentId: string;
1725
1913
  }
1726
1914
  export interface DeleteCommentResponse {
@@ -1729,7 +1917,10 @@ export interface CommentDeleted {
1729
1917
  comment?: Comment;
1730
1918
  }
1731
1919
  export interface ModerateDraftContentRequest {
1732
- /** ID of the comment to moderate. */
1920
+ /**
1921
+ * ID of the comment to moderate.
1922
+ * @format GUID
1923
+ */
1733
1924
  commentId: string;
1734
1925
  /**
1735
1926
  * Revision number, which increments by `1` each time the comment is updated.
@@ -1754,7 +1945,10 @@ export interface CommentHidden {
1754
1945
  comment?: Comment;
1755
1946
  }
1756
1947
  export interface QueryCommentsRequest {
1757
- /** App ID to query comments for. */
1948
+ /**
1949
+ * App ID to query comments for.
1950
+ * @format GUID
1951
+ */
1758
1952
  appId: string;
1759
1953
  /** Query options. */
1760
1954
  query: CursorQuery;
@@ -1776,6 +1970,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1776
1970
  * Sort object.
1777
1971
  *
1778
1972
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1973
+ * @maxSize 5
1779
1974
  */
1780
1975
  sort?: Sorting[];
1781
1976
  }
@@ -1789,7 +1984,10 @@ export interface CursorQueryPagingMethodOneOf {
1789
1984
  cursorPaging?: CursorPaging;
1790
1985
  }
1791
1986
  export interface Sorting {
1792
- /** Name of the field to sort by. */
1987
+ /**
1988
+ * Name of the field to sort by.
1989
+ * @maxLength 512
1990
+ */
1793
1991
  fieldName?: string;
1794
1992
  /** Sort order. */
1795
1993
  order?: SortOrder;
@@ -1799,13 +1997,17 @@ export declare enum SortOrder {
1799
1997
  DESC = "DESC"
1800
1998
  }
1801
1999
  export interface CursorPaging {
1802
- /** Maximum number of items to return in the results. */
2000
+ /**
2001
+ * Maximum number of items to return in the results.
2002
+ * @max 100
2003
+ */
1803
2004
  limit?: number | null;
1804
2005
  /**
1805
2006
  * Pointer to the next or previous page in the list of results.
1806
2007
  *
1807
2008
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1808
2009
  * Not relevant for the first request.
2010
+ * @maxLength 16000
1809
2011
  */
1810
2012
  cursor?: string | null;
1811
2013
  }
@@ -1829,13 +2031,22 @@ export interface CursorPagingMetadata {
1829
2031
  hasNext?: boolean | null;
1830
2032
  }
1831
2033
  export interface Cursors {
1832
- /** Cursor string pointing to the next page in the list of results. */
2034
+ /**
2035
+ * Cursor string pointing to the next page in the list of results.
2036
+ * @maxLength 16000
2037
+ */
1833
2038
  next?: string | null;
1834
- /** Cursor pointing to the previous page in the list of results. */
2039
+ /**
2040
+ * Cursor pointing to the previous page in the list of results.
2041
+ * @maxLength 16000
2042
+ */
1835
2043
  prev?: string | null;
1836
2044
  }
1837
2045
  export interface MarkCommentRequest {
1838
- /** ID of the comment to mark. */
2046
+ /**
2047
+ * ID of the comment to mark.
2048
+ * @format GUID
2049
+ */
1839
2050
  commentId: string;
1840
2051
  }
1841
2052
  export interface MarkCommentResponse {
@@ -1846,7 +2057,10 @@ export interface CommentMarked {
1846
2057
  comment?: Comment;
1847
2058
  }
1848
2059
  export interface UnmarkCommentRequest {
1849
- /** ID of the comment to unmark. */
2060
+ /**
2061
+ * ID of the comment to unmark.
2062
+ * @format GUID
2063
+ */
1850
2064
  commentId: string;
1851
2065
  }
1852
2066
  export interface UnmarkCommentResponse {
@@ -1857,7 +2071,10 @@ export interface CommentUnmarked {
1857
2071
  comment?: Comment;
1858
2072
  }
1859
2073
  export interface HideCommentRequest {
1860
- /** ID of the comment to hide. */
2074
+ /**
2075
+ * ID of the comment to hide.
2076
+ * @format GUID
2077
+ */
1861
2078
  commentId: string;
1862
2079
  }
1863
2080
  export interface HideCommentResponse {
@@ -1865,7 +2082,10 @@ export interface HideCommentResponse {
1865
2082
  comment?: Comment;
1866
2083
  }
1867
2084
  export interface PublishCommentRequest {
1868
- /** ID of the comment to publish. */
2085
+ /**
2086
+ * ID of the comment to publish.
2087
+ * @format GUID
2088
+ */
1869
2089
  commentId: string;
1870
2090
  }
1871
2091
  export interface PublishCommentResponse {
@@ -1874,7 +2094,10 @@ export interface PublishCommentResponse {
1874
2094
  }
1875
2095
  /** Count comments options. */
1876
2096
  export interface CountCommentsRequest {
1877
- /** App ID to count the comments of. */
2097
+ /**
2098
+ * App ID to count the comments of.
2099
+ * @format GUID
2100
+ */
1878
2101
  appId?: string;
1879
2102
  /** Filter to identify the comments that need to be counted. */
1880
2103
  filter?: Record<string, any> | null;
@@ -1884,20 +2107,28 @@ export interface CountCommentsResponse {
1884
2107
  count?: number;
1885
2108
  }
1886
2109
  export interface ListCommentsByResourceRequest {
1887
- /** ID of the app from which the comments are listed. */
2110
+ /**
2111
+ * ID of the app from which the comments are listed.
2112
+ * @format GUID
2113
+ */
1888
2114
  appId: string;
1889
2115
  /**
1890
2116
  * ID of the specific context the comment is in response to.
1891
2117
  *
1892
2118
  * 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`.
2119
+ * @maxLength 128
1893
2120
  */
1894
2121
  contextId: string;
1895
- /** Reserved for internal use. */
2122
+ /**
2123
+ * Reserved for internal use.
2124
+ * @maxLength 128
2125
+ */
1896
2126
  contextType?: string;
1897
2127
  /**
1898
2128
  * ID of the specific resource that the comment is in response to.
1899
2129
  *
1900
2130
  * 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`.
2131
+ * @maxLength 128
1901
2132
  */
1902
2133
  resourceId: string;
1903
2134
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -1960,9 +2191,16 @@ export declare enum ReplySortOrder {
1960
2191
  export interface ListCommentsByResourceCursorPaging {
1961
2192
  /** Pointer to the next or previous page in the list of results. */
1962
2193
  cursor?: string | null;
1963
- /** Number of items to return. */
2194
+ /**
2195
+ * Number of items to return.
2196
+ * @min 1
2197
+ * @max 100
2198
+ */
1964
2199
  limit?: number | null;
1965
- /** Maximum number of replies in a response. Only applicable to parent comments. */
2200
+ /**
2201
+ * Maximum number of replies in a response. Only applicable to parent comments.
2202
+ * @max 100
2203
+ */
1966
2204
  repliesLimit?: number | null;
1967
2205
  }
1968
2206
  export interface ListCommentsByResourceResponse {
@@ -1982,11 +2220,15 @@ export interface RepliesListResponse {
1982
2220
  export interface GetCommentThreadRequest {
1983
2221
  /**
1984
2222
  * App ID.
2223
+ * @maxLength 128
1985
2224
  * @deprecated App ID.
1986
2225
  * @targetRemovalDate 2024-11-01
1987
2226
  */
1988
2227
  appId?: string;
1989
- /** Comment ID. */
2228
+ /**
2229
+ * Comment ID.
2230
+ * @format GUID
2231
+ */
1990
2232
  commentId: string;
1991
2233
  /** Comment sorting. */
1992
2234
  commentSort?: CommentSort;
@@ -2002,7 +2244,10 @@ export interface GetCommentThreadResponse {
2002
2244
  commentReplies?: Record<string, RepliesListResponse>;
2003
2245
  }
2004
2246
  export interface BulkPublishCommentRequest {
2005
- /** ID of the app where to publish the comment. */
2247
+ /**
2248
+ * ID of the app where to publish the comment.
2249
+ * @format GUID
2250
+ */
2006
2251
  appId: string;
2007
2252
  /** 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
2253
  filter: Record<string, any> | null;
@@ -2012,11 +2257,15 @@ export interface BulkPublishCommentResponse {
2012
2257
  * Job ID.
2013
2258
  *
2014
2259
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2260
+ * @format GUID
2015
2261
  */
2016
2262
  jobId?: string;
2017
2263
  }
2018
2264
  export interface BulkHideCommentRequest {
2019
- /** ID of the app where to hide the comments. */
2265
+ /**
2266
+ * ID of the app where to hide the comments.
2267
+ * @format GUID
2268
+ */
2020
2269
  appId: string;
2021
2270
  /** 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
2271
  filter: Record<string, any> | null;
@@ -2026,11 +2275,15 @@ export interface BulkHideCommentResponse {
2026
2275
  * Job ID.
2027
2276
  *
2028
2277
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2278
+ * @format GUID
2029
2279
  */
2030
2280
  jobId?: string;
2031
2281
  }
2032
2282
  export interface BulkDeleteCommentRequest {
2033
- /** ID of the app where to delete the comments. */
2283
+ /**
2284
+ * ID of the app where to delete the comments.
2285
+ * @format GUID
2286
+ */
2034
2287
  appId: string;
2035
2288
  /** 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
2289
  filter: Record<string, any> | null;
@@ -2040,11 +2293,15 @@ export interface BulkDeleteCommentResponse {
2040
2293
  * Job ID.
2041
2294
  *
2042
2295
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2296
+ * @format GUID
2043
2297
  */
2044
2298
  jobId?: string;
2045
2299
  }
2046
2300
  export interface BulkModerateDraftContentRequest {
2047
- /** ID of the app where to moderate the comments. */
2301
+ /**
2302
+ * ID of the app where to moderate the comments.
2303
+ * @format GUID
2304
+ */
2048
2305
  appId: string;
2049
2306
  /** 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
2307
  filter: Record<string, any> | null;
@@ -2056,11 +2313,15 @@ export interface BulkModerateDraftContentResponse {
2056
2313
  * Job ID.
2057
2314
  *
2058
2315
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2316
+ * @format GUID
2059
2317
  */
2060
2318
  jobId?: string;
2061
2319
  }
2062
2320
  export interface BulkMoveCommentByFilterRequest {
2063
- /** ID of the app from which to move the comments. */
2321
+ /**
2322
+ * ID of the app from which to move the comments.
2323
+ * @format GUID
2324
+ */
2064
2325
  appId: string;
2065
2326
  /** 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
2327
  filter: Record<string, any> | null;
@@ -2068,9 +2329,15 @@ export interface BulkMoveCommentByFilterRequest {
2068
2329
  destination?: Destination;
2069
2330
  }
2070
2331
  export interface Destination {
2071
- /** Context ID of where to move the comment to. */
2332
+ /**
2333
+ * Context ID of where to move the comment to.
2334
+ * @maxLength 128
2335
+ */
2072
2336
  contextId?: string;
2073
- /** Resource ID of where to move the comment to. */
2337
+ /**
2338
+ * Resource ID of where to move the comment to.
2339
+ * @maxLength 128
2340
+ */
2074
2341
  resourceId?: string;
2075
2342
  }
2076
2343
  export interface BulkMoveCommentByFilterResponse {
@@ -2078,6 +2345,7 @@ export interface BulkMoveCommentByFilterResponse {
2078
2345
  * Job ID.
2079
2346
  *
2080
2347
  * Pass this ID to Get Async Job to retrieve job details and metadata.
2348
+ * @format GUID
2081
2349
  */
2082
2350
  jobId?: string;
2083
2351
  }
@@ -2156,9 +2424,15 @@ export interface ActionEvent {
2156
2424
  body?: string;
2157
2425
  }
2158
2426
  export interface MessageEnvelope {
2159
- /** App instance ID. */
2427
+ /**
2428
+ * App instance ID.
2429
+ * @format GUID
2430
+ */
2160
2431
  instanceId?: string | null;
2161
- /** Event type. */
2432
+ /**
2433
+ * Event type.
2434
+ * @maxLength 150
2435
+ */
2162
2436
  eventType?: string;
2163
2437
  /** The identification type and identity data. */
2164
2438
  identity?: IdentificationData;
@@ -2166,26 +2440,50 @@ export interface MessageEnvelope {
2166
2440
  data?: string;
2167
2441
  }
2168
2442
  export interface IdentificationData extends IdentificationDataIdOneOf {
2169
- /** ID of a site visitor that has not logged in to the site. */
2443
+ /**
2444
+ * ID of a site visitor that has not logged in to the site.
2445
+ * @format GUID
2446
+ */
2170
2447
  anonymousVisitorId?: string;
2171
- /** ID of a site visitor that has logged in to the site. */
2448
+ /**
2449
+ * ID of a site visitor that has logged in to the site.
2450
+ * @format GUID
2451
+ */
2172
2452
  memberId?: string;
2173
- /** ID of a Wix user (site owner, contributor, etc.). */
2453
+ /**
2454
+ * ID of a Wix user (site owner, contributor, etc.).
2455
+ * @format GUID
2456
+ */
2174
2457
  wixUserId?: string;
2175
- /** ID of an app. */
2458
+ /**
2459
+ * ID of an app.
2460
+ * @format GUID
2461
+ */
2176
2462
  appId?: string;
2177
2463
  /** @readonly */
2178
2464
  identityType?: WebhookIdentityType;
2179
2465
  }
2180
2466
  /** @oneof */
2181
2467
  export interface IdentificationDataIdOneOf {
2182
- /** ID of a site visitor that has not logged in to the site. */
2468
+ /**
2469
+ * ID of a site visitor that has not logged in to the site.
2470
+ * @format GUID
2471
+ */
2183
2472
  anonymousVisitorId?: string;
2184
- /** ID of a site visitor that has logged in to the site. */
2473
+ /**
2474
+ * ID of a site visitor that has logged in to the site.
2475
+ * @format GUID
2476
+ */
2185
2477
  memberId?: string;
2186
- /** ID of a Wix user (site owner, contributor, etc.). */
2478
+ /**
2479
+ * ID of a Wix user (site owner, contributor, etc.).
2480
+ * @format GUID
2481
+ */
2187
2482
  wixUserId?: string;
2188
- /** ID of an app. */
2483
+ /**
2484
+ * ID of an app.
2485
+ * @format GUID
2486
+ */
2189
2487
  appId?: string;
2190
2488
  }
2191
2489
  export declare enum WebhookIdentityType {
@@ -2277,9 +2575,13 @@ interface ImageDataNonNullableFields {
2277
2575
  containerData?: PluginContainerDataNonNullableFields;
2278
2576
  link?: LinkNonNullableFields;
2279
2577
  }
2578
+ interface LinkPreviewDataStylesNonNullableFields {
2579
+ thumbnailPosition: Position;
2580
+ }
2280
2581
  interface LinkPreviewDataNonNullableFields {
2281
2582
  containerData?: PluginContainerDataNonNullableFields;
2282
2583
  link?: LinkNonNullableFields;
2584
+ styles?: LinkPreviewDataStylesNonNullableFields;
2283
2585
  }
2284
2586
  interface MapSettingsNonNullableFields {
2285
2587
  mapType: MapType;
@@ -2527,9 +2829,15 @@ export interface BulkMoveCommentByFilterResponseNonNullableFields {
2527
2829
  jobId: string;
2528
2830
  }
2529
2831
  export interface BaseEventMetadata {
2530
- /** App instance ID. */
2832
+ /**
2833
+ * App instance ID.
2834
+ * @format GUID
2835
+ */
2531
2836
  instanceId?: string | null;
2532
- /** Event type. */
2837
+ /**
2838
+ * Event type.
2839
+ * @maxLength 150
2840
+ */
2533
2841
  eventType?: string;
2534
2842
  /** The identification type and identity data. */
2535
2843
  identity?: IdentificationData;
@@ -2794,6 +3102,7 @@ export declare function updateComment(_id: string | null, comment: UpdateComment
2794
3102
  export interface UpdateComment {
2795
3103
  /**
2796
3104
  * Comment ID.
3105
+ * @format GUID
2797
3106
  * @readonly
2798
3107
  */
2799
3108
  _id?: string | null;
@@ -2816,13 +3125,19 @@ export interface UpdateComment {
2816
3125
  * @readonly
2817
3126
  */
2818
3127
  _updatedDate?: Date | null;
2819
- /** ID of the app that the comment is added to. */
3128
+ /**
3129
+ * ID of the app that the comment is added to.
3130
+ * @format GUID
3131
+ * @immutable
3132
+ */
2820
3133
  appId?: string | null;
2821
3134
  /**
2822
3135
  * ID of the specific context the comment is in response to.
2823
3136
  *
2824
3137
  * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
2825
3138
  * the `forumPostId` is used as both the `contextId` and the `resourceId`.
3139
+ * @immutable
3140
+ * @maxLength 128
2826
3141
  */
2827
3142
  contextId?: string | null;
2828
3143
  /**
@@ -2830,11 +3145,16 @@ export interface UpdateComment {
2830
3145
  *
2831
3146
  * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
2832
3147
  * the `forumPostId` is used as both the `resourceId` and the `contextId`.
3148
+ * @immutable
3149
+ * @maxLength 128
2833
3150
  */
2834
3151
  resourceId?: string | null;
2835
3152
  /** Published comment content. */
2836
3153
  content?: CommentContent;
2837
- /** Comment's author. */
3154
+ /**
3155
+ * Comment's author.
3156
+ * @immutable
3157
+ */
2838
3158
  author?: CommentAuthor;
2839
3159
  /**
2840
3160
  * Parent comment information.
@@ -2871,7 +3191,10 @@ export interface UpdateComment {
2871
3191
  reactionSummary?: CommentReactionSummary;
2872
3192
  /** Whether the comment is marked. */
2873
3193
  marked?: boolean;
2874
- /** Date and time when the comment was actually created. */
3194
+ /**
3195
+ * Date and time when the comment was actually created.
3196
+ * @immutable
3197
+ */
2875
3198
  commentDate?: Date | null;
2876
3199
  /**
2877
3200
  * Whether the comment has the updated content.
@@ -3077,14 +3400,19 @@ export interface ListCommentsByResourceOptions {
3077
3400
  * ID of the specific context the comment is in response to.
3078
3401
  *
3079
3402
  * 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`.
3403
+ * @maxLength 128
3080
3404
  */
3081
3405
  contextId: string;
3082
- /** Reserved for internal use. */
3406
+ /**
3407
+ * Reserved for internal use.
3408
+ * @maxLength 128
3409
+ */
3083
3410
  contextType?: string;
3084
3411
  /**
3085
3412
  * ID of the specific resource that the comment is in response to.
3086
3413
  *
3087
3414
  * 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`.
3415
+ * @maxLength 128
3088
3416
  */
3089
3417
  resourceId: string;
3090
3418
  /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
@@ -3116,6 +3444,7 @@ export declare function getCommentThread(commentId: string, options?: GetComment
3116
3444
  export interface GetCommentThreadOptions {
3117
3445
  /**
3118
3446
  * App ID.
3447
+ * @maxLength 128
3119
3448
  * @deprecated App ID.
3120
3449
  * @targetRemovalDate 2024-11-01
3121
3450
  */