@wix/auto_sdk_blog_posts 1.0.56 → 1.0.57
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.
- package/build/cjs/index.d.ts +24 -31
- package/build/cjs/index.js +10 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +21 -28
- package/build/cjs/index.typings.js +5 -5
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1378 -6
- package/build/cjs/meta.js +469 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +24 -31
- package/build/es/index.mjs +10 -15
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +21 -28
- package/build/es/index.typings.mjs +5 -5
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1378 -6
- package/build/es/meta.mjs +421 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +24 -31
- package/build/internal/cjs/index.js +10 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +21 -28
- package/build/internal/cjs/index.typings.js +5 -5
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1378 -6
- package/build/internal/cjs/meta.js +469 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +24 -31
- package/build/internal/es/index.mjs +10 -15
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +21 -28
- package/build/internal/es/index.typings.mjs +5 -5
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1378 -6
- package/build/internal/es/meta.mjs +421 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/meta.d.ts
CHANGED
@@ -176,6 +176,23 @@ interface PageUrl {
|
|
176
176
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
177
177
|
path?: string;
|
178
178
|
}
|
179
|
+
interface PostCountInfo {
|
180
|
+
/**
|
181
|
+
* Total number of post comments
|
182
|
+
* @readonly
|
183
|
+
*/
|
184
|
+
comments?: number;
|
185
|
+
/**
|
186
|
+
* Total number of post likes
|
187
|
+
* @readonly
|
188
|
+
*/
|
189
|
+
likes?: number;
|
190
|
+
/**
|
191
|
+
* Total number of post views
|
192
|
+
* @readonly
|
193
|
+
*/
|
194
|
+
views?: number;
|
195
|
+
}
|
179
196
|
interface Image {
|
180
197
|
/** WixMedia image ID. */
|
181
198
|
id?: string;
|
@@ -199,6 +216,16 @@ interface Image {
|
|
199
216
|
*/
|
200
217
|
filename?: string | null;
|
201
218
|
}
|
219
|
+
interface FocalPoint {
|
220
|
+
/** X-coordinate of the focal point. */
|
221
|
+
x?: number;
|
222
|
+
/** Y-coordinate of the focal point. */
|
223
|
+
y?: number;
|
224
|
+
/** crop by height */
|
225
|
+
height?: number | null;
|
226
|
+
/** crop by width */
|
227
|
+
width?: number | null;
|
228
|
+
}
|
202
229
|
interface Metrics {
|
203
230
|
/**
|
204
231
|
* Total number of post comments.
|
@@ -984,6 +1011,21 @@ interface ImageData {
|
|
984
1011
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
985
1012
|
disableDownload?: boolean | null;
|
986
1013
|
}
|
1014
|
+
interface StylesBorder {
|
1015
|
+
/** Border width in pixels. */
|
1016
|
+
width?: number | null;
|
1017
|
+
/**
|
1018
|
+
* Border color as a hexadecimal value.
|
1019
|
+
* @format COLOR_HEX
|
1020
|
+
*/
|
1021
|
+
color?: string | null;
|
1022
|
+
/** Border radius in pixels. */
|
1023
|
+
radius?: number | null;
|
1024
|
+
}
|
1025
|
+
interface ImageDataStyles {
|
1026
|
+
/** Border attributes. */
|
1027
|
+
border?: StylesBorder;
|
1028
|
+
}
|
987
1029
|
interface LinkPreviewData {
|
988
1030
|
/** Styling for the link preview's container. */
|
989
1031
|
containerData?: PluginContainerData;
|
@@ -998,6 +1040,51 @@ interface LinkPreviewData {
|
|
998
1040
|
/** The preview content as HTML. */
|
999
1041
|
html?: string | null;
|
1000
1042
|
}
|
1043
|
+
declare enum StylesPosition {
|
1044
|
+
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1045
|
+
START = "START",
|
1046
|
+
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
1047
|
+
END = "END",
|
1048
|
+
/** Thumbnail positioned at the top */
|
1049
|
+
TOP = "TOP",
|
1050
|
+
/** Thumbnail hidden and not displayed */
|
1051
|
+
HIDDEN = "HIDDEN"
|
1052
|
+
}
|
1053
|
+
/** @enumType */
|
1054
|
+
type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
1055
|
+
interface LinkPreviewDataStyles {
|
1056
|
+
/**
|
1057
|
+
* Background color as a hexadecimal value.
|
1058
|
+
* @format COLOR_HEX
|
1059
|
+
*/
|
1060
|
+
backgroundColor?: string | null;
|
1061
|
+
/**
|
1062
|
+
* Title color as a hexadecimal value.
|
1063
|
+
* @format COLOR_HEX
|
1064
|
+
*/
|
1065
|
+
titleColor?: string | null;
|
1066
|
+
/**
|
1067
|
+
* Subtitle color as a hexadecimal value.
|
1068
|
+
* @format COLOR_HEX
|
1069
|
+
*/
|
1070
|
+
subtitleColor?: string | null;
|
1071
|
+
/**
|
1072
|
+
* Link color as a hexadecimal value.
|
1073
|
+
* @format COLOR_HEX
|
1074
|
+
*/
|
1075
|
+
linkColor?: string | null;
|
1076
|
+
/** Border width in pixels. */
|
1077
|
+
borderWidth?: number | null;
|
1078
|
+
/** Border radius in pixels. */
|
1079
|
+
borderRadius?: number | null;
|
1080
|
+
/**
|
1081
|
+
* Border color as a hexadecimal value.
|
1082
|
+
* @format COLOR_HEX
|
1083
|
+
*/
|
1084
|
+
borderColor?: string | null;
|
1085
|
+
/** Position of thumbnail. Defaults to `START`. */
|
1086
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
1087
|
+
}
|
1001
1088
|
interface MapData {
|
1002
1089
|
/** Styling for the map's container. */
|
1003
1090
|
containerData?: PluginContainerData;
|
@@ -1343,6 +1430,66 @@ interface AppEmbedDataAppDataOneOf {
|
|
1343
1430
|
/** Data for embedded Wix Events content. */
|
1344
1431
|
eventData?: EventData;
|
1345
1432
|
}
|
1433
|
+
declare enum Position {
|
1434
|
+
/** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1435
|
+
START = "START",
|
1436
|
+
/** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
|
1437
|
+
END = "END",
|
1438
|
+
/** Image positioned at the top */
|
1439
|
+
TOP = "TOP"
|
1440
|
+
}
|
1441
|
+
/** @enumType */
|
1442
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
|
1443
|
+
declare enum AspectRatio {
|
1444
|
+
/** 1:1 aspect ratio */
|
1445
|
+
SQUARE = "SQUARE",
|
1446
|
+
/** 16:9 aspect ratio */
|
1447
|
+
RECTANGLE = "RECTANGLE"
|
1448
|
+
}
|
1449
|
+
/** @enumType */
|
1450
|
+
type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
|
1451
|
+
declare enum Resizing {
|
1452
|
+
/** Fill the container, may crop the image */
|
1453
|
+
FILL = "FILL",
|
1454
|
+
/** Fit the image within the container */
|
1455
|
+
FIT = "FIT"
|
1456
|
+
}
|
1457
|
+
/** @enumType */
|
1458
|
+
type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
|
1459
|
+
declare enum Placement {
|
1460
|
+
/** Ribbon placed on the image */
|
1461
|
+
IMAGE = "IMAGE",
|
1462
|
+
/** Ribbon placed on the product information */
|
1463
|
+
PRODUCT_INFO = "PRODUCT_INFO"
|
1464
|
+
}
|
1465
|
+
/** @enumType */
|
1466
|
+
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
|
1467
|
+
declare enum Type {
|
1468
|
+
/** Card with visible border and background */
|
1469
|
+
CONTAINED = "CONTAINED",
|
1470
|
+
/** Card without visible border */
|
1471
|
+
FRAMELESS = "FRAMELESS"
|
1472
|
+
}
|
1473
|
+
/** @enumType */
|
1474
|
+
type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
|
1475
|
+
declare enum Alignment {
|
1476
|
+
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
|
1477
|
+
START = "START",
|
1478
|
+
/** Content centered */
|
1479
|
+
CENTER = "CENTER",
|
1480
|
+
/** Content aligned to end (right in LTR layouts, left in RTL layouts) */
|
1481
|
+
END = "END"
|
1482
|
+
}
|
1483
|
+
/** @enumType */
|
1484
|
+
type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
|
1485
|
+
declare enum Layout {
|
1486
|
+
/** Elements stacked vertically */
|
1487
|
+
STACKED = "STACKED",
|
1488
|
+
/** Elements arranged horizontally */
|
1489
|
+
SIDE_BY_SIDE = "SIDE_BY_SIDE"
|
1490
|
+
}
|
1491
|
+
/** @enumType */
|
1492
|
+
type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
|
1346
1493
|
declare enum AppType {
|
1347
1494
|
PRODUCT = "PRODUCT",
|
1348
1495
|
EVENT = "EVENT",
|
@@ -1360,6 +1507,149 @@ interface EventData {
|
|
1360
1507
|
/** Event location. */
|
1361
1508
|
location?: string | null;
|
1362
1509
|
}
|
1510
|
+
interface ButtonStyles {
|
1511
|
+
/** Text to display on the button. */
|
1512
|
+
buttonText?: string | null;
|
1513
|
+
/** Border width in pixels. */
|
1514
|
+
borderWidth?: number | null;
|
1515
|
+
/** Border radius in pixels. */
|
1516
|
+
borderRadius?: number | null;
|
1517
|
+
/**
|
1518
|
+
* Border color as a hexadecimal value.
|
1519
|
+
* @format COLOR_HEX
|
1520
|
+
*/
|
1521
|
+
borderColor?: string | null;
|
1522
|
+
/**
|
1523
|
+
* Text color as a hexadecimal value.
|
1524
|
+
* @format COLOR_HEX
|
1525
|
+
*/
|
1526
|
+
textColor?: string | null;
|
1527
|
+
/**
|
1528
|
+
* Background color as a hexadecimal value.
|
1529
|
+
* @format COLOR_HEX
|
1530
|
+
*/
|
1531
|
+
backgroundColor?: string | null;
|
1532
|
+
/**
|
1533
|
+
* Border color as a hexadecimal value (hover state).
|
1534
|
+
* @format COLOR_HEX
|
1535
|
+
*/
|
1536
|
+
borderColorHover?: string | null;
|
1537
|
+
/**
|
1538
|
+
* Text color as a hexadecimal value (hover state).
|
1539
|
+
* @format COLOR_HEX
|
1540
|
+
*/
|
1541
|
+
textColorHover?: string | null;
|
1542
|
+
/**
|
1543
|
+
* Background color as a hexadecimal value (hover state).
|
1544
|
+
* @format COLOR_HEX
|
1545
|
+
*/
|
1546
|
+
backgroundColorHover?: string | null;
|
1547
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
1548
|
+
buttonSize?: string | null;
|
1549
|
+
}
|
1550
|
+
interface ImageStyles {
|
1551
|
+
/** Whether to hide the image. */
|
1552
|
+
hideImage?: boolean | null;
|
1553
|
+
/** Position of image. Defaults to `START`. */
|
1554
|
+
imagePosition?: PositionWithLiterals;
|
1555
|
+
/** Aspect ratio for the image. Defaults to `SQUARE`. */
|
1556
|
+
aspectRatio?: AspectRatioWithLiterals;
|
1557
|
+
/** How the image should be resized. Defaults to `FILL`. */
|
1558
|
+
resizing?: ResizingWithLiterals;
|
1559
|
+
/**
|
1560
|
+
* Image border color as a hexadecimal value.
|
1561
|
+
* @format COLOR_HEX
|
1562
|
+
*/
|
1563
|
+
borderColor?: string | null;
|
1564
|
+
/** Image border width in pixels. */
|
1565
|
+
borderWidth?: number | null;
|
1566
|
+
/** Image border radius in pixels. */
|
1567
|
+
borderRadius?: number | null;
|
1568
|
+
}
|
1569
|
+
interface RibbonStyles {
|
1570
|
+
/** Text to display on the ribbon. */
|
1571
|
+
ribbonText?: string | null;
|
1572
|
+
/**
|
1573
|
+
* Ribbon background color as a hexadecimal value.
|
1574
|
+
* @format COLOR_HEX
|
1575
|
+
*/
|
1576
|
+
backgroundColor?: string | null;
|
1577
|
+
/**
|
1578
|
+
* Ribbon text color as a hexadecimal value.
|
1579
|
+
* @format COLOR_HEX
|
1580
|
+
*/
|
1581
|
+
textColor?: string | null;
|
1582
|
+
/**
|
1583
|
+
* Ribbon border color as a hexadecimal value.
|
1584
|
+
* @format COLOR_HEX
|
1585
|
+
*/
|
1586
|
+
borderColor?: string | null;
|
1587
|
+
/** Ribbon border width in pixels. */
|
1588
|
+
borderWidth?: number | null;
|
1589
|
+
/** Ribbon border radius in pixels. */
|
1590
|
+
borderRadius?: number | null;
|
1591
|
+
/** Placement of the ribbon. Defaults to `IMAGE`. */
|
1592
|
+
ribbonPlacement?: PlacementWithLiterals;
|
1593
|
+
}
|
1594
|
+
interface CardStyles {
|
1595
|
+
/**
|
1596
|
+
* Card background color as a hexadecimal value.
|
1597
|
+
* @format COLOR_HEX
|
1598
|
+
*/
|
1599
|
+
backgroundColor?: string | null;
|
1600
|
+
/**
|
1601
|
+
* Card border color as a hexadecimal value.
|
1602
|
+
* @format COLOR_HEX
|
1603
|
+
*/
|
1604
|
+
borderColor?: string | null;
|
1605
|
+
/** Card border width in pixels. */
|
1606
|
+
borderWidth?: number | null;
|
1607
|
+
/** Card border radius in pixels. */
|
1608
|
+
borderRadius?: number | null;
|
1609
|
+
/** Card type. Defaults to `CONTAINED`. */
|
1610
|
+
type?: TypeWithLiterals;
|
1611
|
+
/** Content alignment. Defaults to `START`. */
|
1612
|
+
alignment?: AlignmentWithLiterals;
|
1613
|
+
/** Layout for title and price. Defaults to `STACKED`. */
|
1614
|
+
titlePriceLayout?: LayoutWithLiterals;
|
1615
|
+
/**
|
1616
|
+
* Title text color as a hexadecimal value.
|
1617
|
+
* @format COLOR_HEX
|
1618
|
+
*/
|
1619
|
+
titleColor?: string | null;
|
1620
|
+
/**
|
1621
|
+
* Text color as a hexadecimal value.
|
1622
|
+
* @format COLOR_HEX
|
1623
|
+
*/
|
1624
|
+
textColor?: string | null;
|
1625
|
+
}
|
1626
|
+
interface PricingData {
|
1627
|
+
/**
|
1628
|
+
* Minimum numeric price value as string (e.g., "10.99").
|
1629
|
+
* @decimalValue options { maxScale:2 }
|
1630
|
+
*/
|
1631
|
+
valueFrom?: string | null;
|
1632
|
+
/**
|
1633
|
+
* Maximum numeric price value as string (e.g., "19.99").
|
1634
|
+
* @decimalValue options { maxScale:2 }
|
1635
|
+
*/
|
1636
|
+
valueTo?: string | null;
|
1637
|
+
/**
|
1638
|
+
* Numeric price value as string after discount application (e.g., "15.99").
|
1639
|
+
* @decimalValue options { maxScale:2 }
|
1640
|
+
*/
|
1641
|
+
discountedValue?: string | null;
|
1642
|
+
/**
|
1643
|
+
* Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
|
1644
|
+
* @format CURRENCY
|
1645
|
+
*/
|
1646
|
+
currency?: string | null;
|
1647
|
+
/**
|
1648
|
+
* Pricing plan ID.
|
1649
|
+
* @format GUID
|
1650
|
+
*/
|
1651
|
+
pricingPlanId?: string | null;
|
1652
|
+
}
|
1363
1653
|
interface VideoData {
|
1364
1654
|
/** Styling for the video's container. */
|
1365
1655
|
containerData?: PluginContainerData;
|
@@ -1522,6 +1812,27 @@ interface BorderColors {
|
|
1522
1812
|
*/
|
1523
1813
|
bottom?: string | null;
|
1524
1814
|
}
|
1815
|
+
/**
|
1816
|
+
* `NullValue` is a singleton enumeration to represent the null value for the
|
1817
|
+
* `Value` type union.
|
1818
|
+
*
|
1819
|
+
* The JSON representation for `NullValue` is JSON `null`.
|
1820
|
+
*/
|
1821
|
+
declare enum NullValue {
|
1822
|
+
/** Null value. */
|
1823
|
+
NULL_VALUE = "NULL_VALUE"
|
1824
|
+
}
|
1825
|
+
/** @enumType */
|
1826
|
+
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
1827
|
+
/**
|
1828
|
+
* `ListValue` is a wrapper around a repeated field of values.
|
1829
|
+
*
|
1830
|
+
* The JSON representation for `ListValue` is JSON array.
|
1831
|
+
*/
|
1832
|
+
interface ListValue {
|
1833
|
+
/** Repeated field of dynamically typed values. */
|
1834
|
+
values?: any[];
|
1835
|
+
}
|
1525
1836
|
interface AudioData {
|
1526
1837
|
/** Styling for the audio node's container. */
|
1527
1838
|
containerData?: PluginContainerData;
|
@@ -1715,6 +2026,175 @@ interface EmbedVideo {
|
|
1715
2026
|
/** Video height. */
|
1716
2027
|
height?: number;
|
1717
2028
|
}
|
2029
|
+
interface PostTranslation {
|
2030
|
+
/**
|
2031
|
+
* Post ID.
|
2032
|
+
* @format GUID
|
2033
|
+
*/
|
2034
|
+
id?: string;
|
2035
|
+
/**
|
2036
|
+
* Language the post is written in.
|
2037
|
+
* @format LANGUAGE_TAG
|
2038
|
+
*/
|
2039
|
+
language?: string | null;
|
2040
|
+
/**
|
2041
|
+
* Post slug. For example, 'post-slug'.
|
2042
|
+
* @maxLength 100
|
2043
|
+
*/
|
2044
|
+
slug?: string | null;
|
2045
|
+
/** SEO data. */
|
2046
|
+
seoData?: SeoSchema;
|
2047
|
+
/** Post URL. */
|
2048
|
+
url?: PageUrl;
|
2049
|
+
}
|
2050
|
+
interface PostCategoriesUpdated {
|
2051
|
+
/**
|
2052
|
+
* ID of the post which counters were updated.
|
2053
|
+
* @format GUID
|
2054
|
+
*/
|
2055
|
+
postId?: string;
|
2056
|
+
/**
|
2057
|
+
* Current categories of the post.
|
2058
|
+
* @maxSize 10
|
2059
|
+
* @format GUID
|
2060
|
+
*/
|
2061
|
+
categories?: string[];
|
2062
|
+
/**
|
2063
|
+
* Previous categories of the post.
|
2064
|
+
* @maxSize 10
|
2065
|
+
* @format GUID
|
2066
|
+
*/
|
2067
|
+
previousCategories?: string[];
|
2068
|
+
}
|
2069
|
+
interface PostTagsUpdated {
|
2070
|
+
/**
|
2071
|
+
* ID of the post which counters were updated.
|
2072
|
+
* @format GUID
|
2073
|
+
*/
|
2074
|
+
postId?: string;
|
2075
|
+
/**
|
2076
|
+
* Current tags of the post.
|
2077
|
+
* @maxSize 30
|
2078
|
+
* @format GUID
|
2079
|
+
*/
|
2080
|
+
tags?: string[];
|
2081
|
+
/**
|
2082
|
+
* Previous tags of the post.
|
2083
|
+
* @maxSize 30
|
2084
|
+
* @format GUID
|
2085
|
+
*/
|
2086
|
+
previousTags?: string[];
|
2087
|
+
}
|
2088
|
+
interface ScheduledPostPublished {
|
2089
|
+
/**
|
2090
|
+
* ID of the scheduled post which was published.
|
2091
|
+
* @format GUID
|
2092
|
+
*/
|
2093
|
+
postId?: string;
|
2094
|
+
}
|
2095
|
+
interface PostLiked extends PostLikedInitiatorOneOf {
|
2096
|
+
/**
|
2097
|
+
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2098
|
+
* @format GUID
|
2099
|
+
*/
|
2100
|
+
memberId?: string | null;
|
2101
|
+
/**
|
2102
|
+
* Visitor ID of person who liked the post when they are not logged in.
|
2103
|
+
* @format GUID
|
2104
|
+
*/
|
2105
|
+
anonymousVisitorId?: string | null;
|
2106
|
+
/**
|
2107
|
+
* ID of the liked post.
|
2108
|
+
* @format GUID
|
2109
|
+
*/
|
2110
|
+
postId?: string;
|
2111
|
+
}
|
2112
|
+
/** @oneof */
|
2113
|
+
interface PostLikedInitiatorOneOf {
|
2114
|
+
/**
|
2115
|
+
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2116
|
+
* @format GUID
|
2117
|
+
*/
|
2118
|
+
memberId?: string | null;
|
2119
|
+
/**
|
2120
|
+
* Visitor ID of person who liked the post when they are not logged in.
|
2121
|
+
* @format GUID
|
2122
|
+
*/
|
2123
|
+
anonymousVisitorId?: string | null;
|
2124
|
+
}
|
2125
|
+
interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
2126
|
+
/**
|
2127
|
+
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2128
|
+
* @format GUID
|
2129
|
+
*/
|
2130
|
+
memberId?: string | null;
|
2131
|
+
/**
|
2132
|
+
* Visitor ID of person who unliked the post when they are not logged in.
|
2133
|
+
* @format GUID
|
2134
|
+
*/
|
2135
|
+
anonymousVisitorId?: string | null;
|
2136
|
+
/**
|
2137
|
+
* ID of the unliked post.
|
2138
|
+
* @format GUID
|
2139
|
+
*/
|
2140
|
+
postId?: string;
|
2141
|
+
}
|
2142
|
+
/** @oneof */
|
2143
|
+
interface PostUnlikedInitiatorOneOf {
|
2144
|
+
/**
|
2145
|
+
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2146
|
+
* @format GUID
|
2147
|
+
*/
|
2148
|
+
memberId?: string | null;
|
2149
|
+
/**
|
2150
|
+
* Visitor ID of person who unliked the post when they are not logged in.
|
2151
|
+
* @format GUID
|
2152
|
+
*/
|
2153
|
+
anonymousVisitorId?: string | null;
|
2154
|
+
}
|
2155
|
+
/** Get Blog Publications Count Stats request */
|
2156
|
+
interface QueryPublicationsCountStatsRequest {
|
2157
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
2158
|
+
rangeStart?: Date | null;
|
2159
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
2160
|
+
rangeEnd?: Date | null;
|
2161
|
+
/** Order of the returned results. */
|
2162
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
2163
|
+
/** Number of months to include in the response. */
|
2164
|
+
months?: number;
|
2165
|
+
/**
|
2166
|
+
* Language filter
|
2167
|
+
*
|
2168
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2169
|
+
* @format LANGUAGE_TAG
|
2170
|
+
*/
|
2171
|
+
language?: string | null;
|
2172
|
+
/**
|
2173
|
+
* Timezone of the client.
|
2174
|
+
* @minLength 3
|
2175
|
+
* @maxLength 100
|
2176
|
+
*/
|
2177
|
+
timeZone?: string | null;
|
2178
|
+
}
|
2179
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
2180
|
+
UNKNOWN = "UNKNOWN",
|
2181
|
+
OLDEST = "OLDEST",
|
2182
|
+
NEWEST = "NEWEST"
|
2183
|
+
}
|
2184
|
+
/** @enumType */
|
2185
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
2186
|
+
/** Get Blog Publications Count Stats response */
|
2187
|
+
interface QueryPublicationsCountStatsResponse {
|
2188
|
+
/** Chronologically ordered list of publications. */
|
2189
|
+
stats?: PeriodPublicationsCount[];
|
2190
|
+
}
|
2191
|
+
/** Publications count for a specific time period */
|
2192
|
+
interface PeriodPublicationsCount {
|
2193
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
2194
|
+
periodStart?: Date | null;
|
2195
|
+
/** Number of posts published during this month. */
|
2196
|
+
publicationsCount?: number;
|
2197
|
+
}
|
1718
2198
|
/** Get Blog Post Count Stats request */
|
1719
2199
|
interface QueryPostCountStatsRequest {
|
1720
2200
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
@@ -1766,12 +2246,24 @@ interface PeriodPostCount {
|
|
1766
2246
|
/** Number of posts published during this month. */
|
1767
2247
|
postCount?: number;
|
1768
2248
|
}
|
1769
|
-
interface
|
2249
|
+
interface GetTotalPublicationsRequest {
|
1770
2250
|
/**
|
1771
|
-
* Language filter
|
1772
|
-
*
|
1773
|
-
*
|
1774
|
-
|
2251
|
+
* Language filter
|
2252
|
+
* @minLength 2
|
2253
|
+
* @format LANGUAGE_TAG
|
2254
|
+
*/
|
2255
|
+
language?: string | null;
|
2256
|
+
}
|
2257
|
+
interface GetTotalPublicationsResponse {
|
2258
|
+
/** Total amount of publications. */
|
2259
|
+
total?: number;
|
2260
|
+
}
|
2261
|
+
interface GetTotalPostsRequest {
|
2262
|
+
/**
|
2263
|
+
* Language filter.
|
2264
|
+
*
|
2265
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2266
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
1775
2267
|
* @format LANGUAGE_TAG
|
1776
2268
|
*/
|
1777
2269
|
language?: string | null;
|
@@ -1780,6 +2272,177 @@ interface GetTotalPostsResponse {
|
|
1780
2272
|
/** Total amount of published posts. */
|
1781
2273
|
total?: number;
|
1782
2274
|
}
|
2275
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
2276
|
+
createdEvent?: EntityCreatedEvent;
|
2277
|
+
updatedEvent?: EntityUpdatedEvent;
|
2278
|
+
deletedEvent?: EntityDeletedEvent;
|
2279
|
+
actionEvent?: ActionEvent;
|
2280
|
+
/**
|
2281
|
+
* Unique event ID.
|
2282
|
+
* Allows clients to ignore duplicate webhooks.
|
2283
|
+
*/
|
2284
|
+
id?: string;
|
2285
|
+
/**
|
2286
|
+
* Assumes actions are also always typed to an entity_type
|
2287
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
2288
|
+
*/
|
2289
|
+
entityFqdn?: string;
|
2290
|
+
/**
|
2291
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
2292
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
2293
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
2294
|
+
*/
|
2295
|
+
slug?: string;
|
2296
|
+
/** ID of the entity associated with the event. */
|
2297
|
+
entityId?: string;
|
2298
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
2299
|
+
eventTime?: Date | null;
|
2300
|
+
/**
|
2301
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
2302
|
+
* (for example, GDPR).
|
2303
|
+
*/
|
2304
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
2305
|
+
/** If present, indicates the action that triggered the event. */
|
2306
|
+
originatedFrom?: string | null;
|
2307
|
+
/**
|
2308
|
+
* A sequence number defining the order of updates to the underlying entity.
|
2309
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
2310
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
2311
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
2312
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
2313
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
2314
|
+
*/
|
2315
|
+
entityEventSequence?: string | null;
|
2316
|
+
}
|
2317
|
+
/** @oneof */
|
2318
|
+
interface DomainEventBodyOneOf {
|
2319
|
+
createdEvent?: EntityCreatedEvent;
|
2320
|
+
updatedEvent?: EntityUpdatedEvent;
|
2321
|
+
deletedEvent?: EntityDeletedEvent;
|
2322
|
+
actionEvent?: ActionEvent;
|
2323
|
+
}
|
2324
|
+
interface EntityCreatedEvent {
|
2325
|
+
entityAsJson?: string;
|
2326
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
2327
|
+
restoreInfo?: RestoreInfo;
|
2328
|
+
}
|
2329
|
+
interface RestoreInfo {
|
2330
|
+
deletedDate?: Date | null;
|
2331
|
+
}
|
2332
|
+
interface EntityUpdatedEvent {
|
2333
|
+
/**
|
2334
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
2335
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
2336
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
2337
|
+
*/
|
2338
|
+
currentEntityAsJson?: string;
|
2339
|
+
}
|
2340
|
+
interface EntityDeletedEvent {
|
2341
|
+
/** Entity that was deleted */
|
2342
|
+
deletedEntityAsJson?: string | null;
|
2343
|
+
}
|
2344
|
+
interface ActionEvent {
|
2345
|
+
bodyAsJson?: string;
|
2346
|
+
}
|
2347
|
+
interface MessageEnvelope {
|
2348
|
+
/**
|
2349
|
+
* App instance ID.
|
2350
|
+
* @format GUID
|
2351
|
+
*/
|
2352
|
+
instanceId?: string | null;
|
2353
|
+
/**
|
2354
|
+
* Event type.
|
2355
|
+
* @maxLength 150
|
2356
|
+
*/
|
2357
|
+
eventType?: string;
|
2358
|
+
/** The identification type and identity data. */
|
2359
|
+
identity?: IdentificationData;
|
2360
|
+
/** Stringify payload. */
|
2361
|
+
data?: string;
|
2362
|
+
}
|
2363
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
2364
|
+
/**
|
2365
|
+
* ID of a site visitor that has not logged in to the site.
|
2366
|
+
* @format GUID
|
2367
|
+
*/
|
2368
|
+
anonymousVisitorId?: string;
|
2369
|
+
/**
|
2370
|
+
* ID of a site visitor that has logged in to the site.
|
2371
|
+
* @format GUID
|
2372
|
+
*/
|
2373
|
+
memberId?: string;
|
2374
|
+
/**
|
2375
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
2376
|
+
* @format GUID
|
2377
|
+
*/
|
2378
|
+
wixUserId?: string;
|
2379
|
+
/**
|
2380
|
+
* ID of an app.
|
2381
|
+
* @format GUID
|
2382
|
+
*/
|
2383
|
+
appId?: string;
|
2384
|
+
/** @readonly */
|
2385
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
2386
|
+
}
|
2387
|
+
/** @oneof */
|
2388
|
+
interface IdentificationDataIdOneOf {
|
2389
|
+
/**
|
2390
|
+
* ID of a site visitor that has not logged in to the site.
|
2391
|
+
* @format GUID
|
2392
|
+
*/
|
2393
|
+
anonymousVisitorId?: string;
|
2394
|
+
/**
|
2395
|
+
* ID of a site visitor that has logged in to the site.
|
2396
|
+
* @format GUID
|
2397
|
+
*/
|
2398
|
+
memberId?: string;
|
2399
|
+
/**
|
2400
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
2401
|
+
* @format GUID
|
2402
|
+
*/
|
2403
|
+
wixUserId?: string;
|
2404
|
+
/**
|
2405
|
+
* ID of an app.
|
2406
|
+
* @format GUID
|
2407
|
+
*/
|
2408
|
+
appId?: string;
|
2409
|
+
}
|
2410
|
+
declare enum WebhookIdentityType {
|
2411
|
+
UNKNOWN = "UNKNOWN",
|
2412
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
2413
|
+
MEMBER = "MEMBER",
|
2414
|
+
WIX_USER = "WIX_USER",
|
2415
|
+
APP = "APP"
|
2416
|
+
}
|
2417
|
+
/** @enumType */
|
2418
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
2419
|
+
interface ListTemplatesRequest {
|
2420
|
+
/**
|
2421
|
+
* Filter post templates by given template category ids
|
2422
|
+
* @maxSize 50
|
2423
|
+
* @format GUID
|
2424
|
+
*/
|
2425
|
+
categoryIds?: string[];
|
2426
|
+
/**
|
2427
|
+
* Filter post templates by provided language
|
2428
|
+
* @format LANGUAGE_TAG
|
2429
|
+
*/
|
2430
|
+
language?: string | null;
|
2431
|
+
/** Returns post template categories when set to TRUE */
|
2432
|
+
listTemplateCategories?: boolean;
|
2433
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
2434
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
2435
|
+
/** Pagination options. */
|
2436
|
+
paging?: BlogPaging;
|
2437
|
+
}
|
2438
|
+
declare enum GetPostTemplatesSort {
|
2439
|
+
/** Sort by ascending publishing date. */
|
2440
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
2441
|
+
/** Sort by descending publishing date. */
|
2442
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
2443
|
+
}
|
2444
|
+
/** @enumType */
|
2445
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
1783
2446
|
interface BlogPaging {
|
1784
2447
|
/**
|
1785
2448
|
* Number of items to skip in the current sort order.
|
@@ -1803,6 +2466,14 @@ interface BlogPaging {
|
|
1803
2466
|
*/
|
1804
2467
|
cursor?: string | null;
|
1805
2468
|
}
|
2469
|
+
interface ListTemplatesResponse {
|
2470
|
+
/** Available post templates */
|
2471
|
+
postTemplates?: Post[];
|
2472
|
+
/** Details on the paged set of posts templates returned. */
|
2473
|
+
postTemplatesMetaData?: MetaData;
|
2474
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
2475
|
+
templateCategories?: Category[];
|
2476
|
+
}
|
1806
2477
|
interface MetaData {
|
1807
2478
|
/** Number of items returned in this response. */
|
1808
2479
|
count?: number;
|
@@ -1816,6 +2487,428 @@ interface MetaData {
|
|
1816
2487
|
*/
|
1817
2488
|
cursor?: string | null;
|
1818
2489
|
}
|
2490
|
+
interface Category {
|
2491
|
+
/**
|
2492
|
+
* Category ID.
|
2493
|
+
* @immutable
|
2494
|
+
* @maxLength 38
|
2495
|
+
*/
|
2496
|
+
id?: string;
|
2497
|
+
/**
|
2498
|
+
* Category label. Displayed in the Category Menu.
|
2499
|
+
* @maxLength 35
|
2500
|
+
*/
|
2501
|
+
label?: string;
|
2502
|
+
/**
|
2503
|
+
* Number of posts in the category.
|
2504
|
+
* @readonly
|
2505
|
+
*/
|
2506
|
+
postCount?: number;
|
2507
|
+
/**
|
2508
|
+
* The `url` of the page that lists every post with the specified category.
|
2509
|
+
* @readonly
|
2510
|
+
*/
|
2511
|
+
url?: PageUrl;
|
2512
|
+
/**
|
2513
|
+
* Category description.
|
2514
|
+
* @maxLength 500
|
2515
|
+
*/
|
2516
|
+
description?: string | null;
|
2517
|
+
/**
|
2518
|
+
* Category title.
|
2519
|
+
* @maxLength 200
|
2520
|
+
* @deprecated Category title.
|
2521
|
+
* @targetRemovalDate 2025-07-16
|
2522
|
+
*/
|
2523
|
+
title?: string;
|
2524
|
+
/**
|
2525
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
2526
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
2527
|
+
*
|
2528
|
+
* Default: `-1`
|
2529
|
+
*/
|
2530
|
+
displayPosition?: number | null;
|
2531
|
+
/**
|
2532
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
2533
|
+
* @format GUID
|
2534
|
+
*/
|
2535
|
+
translationId?: string | null;
|
2536
|
+
/**
|
2537
|
+
* Category language.
|
2538
|
+
*
|
2539
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2540
|
+
* @immutable
|
2541
|
+
*/
|
2542
|
+
language?: string | null;
|
2543
|
+
/**
|
2544
|
+
* Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
|
2545
|
+
* @maxLength 100
|
2546
|
+
*/
|
2547
|
+
slug?: string;
|
2548
|
+
/** SEO data. */
|
2549
|
+
seoData?: SeoSchema;
|
2550
|
+
/** Category cover image. */
|
2551
|
+
coverImage?: Image;
|
2552
|
+
/**
|
2553
|
+
* Date and time the Category was last updated.
|
2554
|
+
* @readonly
|
2555
|
+
*/
|
2556
|
+
updatedDate?: Date | null;
|
2557
|
+
}
|
2558
|
+
interface CategoryTranslation {
|
2559
|
+
/**
|
2560
|
+
* Category ID.
|
2561
|
+
* @format GUID
|
2562
|
+
*/
|
2563
|
+
id?: string;
|
2564
|
+
/**
|
2565
|
+
* Label displayed in the categories menu on the site.
|
2566
|
+
* @maxLength 100
|
2567
|
+
*/
|
2568
|
+
label?: string | null;
|
2569
|
+
/**
|
2570
|
+
* Language of the category.
|
2571
|
+
* @format LANGUAGE_TAG
|
2572
|
+
*/
|
2573
|
+
language?: string | null;
|
2574
|
+
/** URL of this category page. */
|
2575
|
+
url?: PageUrl;
|
2576
|
+
}
|
2577
|
+
interface GetTemplateRequest {
|
2578
|
+
/**
|
2579
|
+
* Post template id
|
2580
|
+
* @format GUID
|
2581
|
+
*/
|
2582
|
+
postTemplateId?: string;
|
2583
|
+
}
|
2584
|
+
interface GetTemplateResponse {
|
2585
|
+
/** Post template */
|
2586
|
+
postTemplate?: Post;
|
2587
|
+
}
|
2588
|
+
interface CreateDraftPostFromTemplateRequest {
|
2589
|
+
/**
|
2590
|
+
* Post template id
|
2591
|
+
* @format GUID
|
2592
|
+
*/
|
2593
|
+
postTemplateId?: string;
|
2594
|
+
}
|
2595
|
+
interface CreateDraftPostFromTemplateResponse {
|
2596
|
+
/** Created draft post */
|
2597
|
+
draftPost?: DraftPost;
|
2598
|
+
}
|
2599
|
+
interface DraftPost {
|
2600
|
+
/**
|
2601
|
+
* Draft post ID.
|
2602
|
+
* @readonly
|
2603
|
+
* @maxLength 38
|
2604
|
+
*/
|
2605
|
+
id?: string;
|
2606
|
+
/**
|
2607
|
+
* Draft post title.
|
2608
|
+
* @maxLength 200
|
2609
|
+
*/
|
2610
|
+
title?: string;
|
2611
|
+
/**
|
2612
|
+
* Draft post excerpt.
|
2613
|
+
*
|
2614
|
+
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
2615
|
+
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
2616
|
+
* @maxLength 500
|
2617
|
+
*/
|
2618
|
+
excerpt?: string | null;
|
2619
|
+
/** Whether the draft post is marked as featured. */
|
2620
|
+
featured?: boolean | null;
|
2621
|
+
/**
|
2622
|
+
* Category IDs of the draft post.
|
2623
|
+
* @maxSize 10
|
2624
|
+
* @maxLength 38
|
2625
|
+
*/
|
2626
|
+
categoryIds?: string[];
|
2627
|
+
/**
|
2628
|
+
* Draft post owner's member ID.
|
2629
|
+
* @format GUID
|
2630
|
+
*/
|
2631
|
+
memberId?: string | null;
|
2632
|
+
/**
|
2633
|
+
* Hashtags in the post.
|
2634
|
+
* @maxSize 100
|
2635
|
+
* @maxLength 100
|
2636
|
+
*/
|
2637
|
+
hashtags?: string[];
|
2638
|
+
/** Whether commenting on the draft post is enabled. */
|
2639
|
+
commentingEnabled?: boolean | null;
|
2640
|
+
/**
|
2641
|
+
* Estimated reading time of the draft post (calculated automatically).
|
2642
|
+
* @readonly
|
2643
|
+
*/
|
2644
|
+
minutesToRead?: number;
|
2645
|
+
/** Image placed at the top of the blog page. */
|
2646
|
+
heroImage?: Image;
|
2647
|
+
/**
|
2648
|
+
* Tag IDs the draft post is tagged with.
|
2649
|
+
* @maxSize 30
|
2650
|
+
* @maxLength 38
|
2651
|
+
*/
|
2652
|
+
tagIds?: string[];
|
2653
|
+
/**
|
2654
|
+
* IDs of posts related to this draft post.
|
2655
|
+
* @maxSize 3
|
2656
|
+
* @maxLength 38
|
2657
|
+
*/
|
2658
|
+
relatedPostIds?: string[];
|
2659
|
+
/**
|
2660
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
2661
|
+
* @maxSize 100
|
2662
|
+
* @format GUID
|
2663
|
+
*/
|
2664
|
+
pricingPlanIds?: string[];
|
2665
|
+
/**
|
2666
|
+
* ID of the draft post's translations.
|
2667
|
+
*
|
2668
|
+
* All translations of a single post share the same `translationId`.
|
2669
|
+
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
2670
|
+
* @format GUID
|
2671
|
+
*/
|
2672
|
+
translationId?: string | null;
|
2673
|
+
/**
|
2674
|
+
* Language the draft post is written in.
|
2675
|
+
*
|
2676
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2677
|
+
* @format LANGUAGE_TAG
|
2678
|
+
*/
|
2679
|
+
language?: string | null;
|
2680
|
+
/**
|
2681
|
+
* Draft Post rich content.
|
2682
|
+
*
|
2683
|
+
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
2684
|
+
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
2685
|
+
* </widget>
|
2686
|
+
*/
|
2687
|
+
richContent?: RichContent;
|
2688
|
+
/**
|
2689
|
+
* Status of the draft post.
|
2690
|
+
* @readonly
|
2691
|
+
*/
|
2692
|
+
status?: StatusWithLiterals;
|
2693
|
+
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
2694
|
+
moderationDetails?: ModerationDetails;
|
2695
|
+
/**
|
2696
|
+
* Indicates if there are changes made to the draft post that have not yet been published.
|
2697
|
+
* @readonly
|
2698
|
+
*/
|
2699
|
+
hasUnpublishedChanges?: boolean;
|
2700
|
+
/**
|
2701
|
+
* Date the draft post was last edited.
|
2702
|
+
* @readonly
|
2703
|
+
*/
|
2704
|
+
editedDate?: Date | null;
|
2705
|
+
/**
|
2706
|
+
* Date the draft post is scheduled to be published.
|
2707
|
+
* @readonly
|
2708
|
+
*/
|
2709
|
+
scheduledPublishDate?: Date | null;
|
2710
|
+
/** Date the post was first published. */
|
2711
|
+
firstPublishedDate?: Date | null;
|
2712
|
+
/** SEO data. */
|
2713
|
+
seoData?: SeoSchema;
|
2714
|
+
/**
|
2715
|
+
* Draft post URL preview. What the URL will look like once the post is published.
|
2716
|
+
* @readonly
|
2717
|
+
*/
|
2718
|
+
url?: PageUrl;
|
2719
|
+
/**
|
2720
|
+
* Date the draft post was first created.
|
2721
|
+
* @readonly
|
2722
|
+
*/
|
2723
|
+
createdDate?: Date | null;
|
2724
|
+
/**
|
2725
|
+
* SEO slug.
|
2726
|
+
* @maxLength 100
|
2727
|
+
*/
|
2728
|
+
seoSlug?: string | null;
|
2729
|
+
/** Post cover media. */
|
2730
|
+
media?: Media;
|
2731
|
+
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
2732
|
+
previewTextParagraph?: number | null;
|
2733
|
+
}
|
2734
|
+
declare enum Origin {
|
2735
|
+
UNKNOWN = "UNKNOWN",
|
2736
|
+
/** Changed by admin */
|
2737
|
+
ADMIN = "ADMIN",
|
2738
|
+
/** Categories were changed */
|
2739
|
+
ADD_CATEGORIES = "ADD_CATEGORIES",
|
2740
|
+
/** Saved automatically */
|
2741
|
+
AUTO_SAVE = "AUTO_SAVE",
|
2742
|
+
/** Copied from template */
|
2743
|
+
COPY_TEMPLATE = "COPY_TEMPLATE",
|
2744
|
+
/** Imported */
|
2745
|
+
IMPORT = "IMPORT",
|
2746
|
+
/** Imported in bulk */
|
2747
|
+
IMPORT_BULK = "IMPORT_BULK",
|
2748
|
+
/** Imported with html import */
|
2749
|
+
IMPORT_HTML = "IMPORT_HTML",
|
2750
|
+
/** Patch import */
|
2751
|
+
IMPORT_PATCH = "IMPORT_PATCH",
|
2752
|
+
/** Changed language */
|
2753
|
+
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
2754
|
+
/** Saved manually */
|
2755
|
+
MANUAL_SAVE = "MANUAL_SAVE",
|
2756
|
+
/** Affected by migration */
|
2757
|
+
MIGRATION = "MIGRATION",
|
2758
|
+
/** Affected by moderation */
|
2759
|
+
MODERATION = "MODERATION",
|
2760
|
+
/** Moved to trash */
|
2761
|
+
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
2762
|
+
/** Pricing plans were changed */
|
2763
|
+
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
2764
|
+
/** Was provisioned */
|
2765
|
+
PROVISION = "PROVISION",
|
2766
|
+
/** Was published */
|
2767
|
+
PUBLISH = "PUBLISH",
|
2768
|
+
/** Owner was reassigned */
|
2769
|
+
REASSIGN_OWNER = "REASSIGN_OWNER",
|
2770
|
+
/** Was reblogged */
|
2771
|
+
REBLOG = "REBLOG",
|
2772
|
+
/** Was restored */
|
2773
|
+
RESTORE = "RESTORE",
|
2774
|
+
/** Reverted to draft */
|
2775
|
+
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
2776
|
+
/** Was translated */
|
2777
|
+
TRANSLATION = "TRANSLATION",
|
2778
|
+
/** Was unpublished */
|
2779
|
+
UNPUBLISH = "UNPUBLISH",
|
2780
|
+
/** Was unscheduled */
|
2781
|
+
UNSCHEDULE = "UNSCHEDULE",
|
2782
|
+
/** New edit session started which updated editing_session_id id */
|
2783
|
+
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
2784
|
+
/** Was scheduled by Later */
|
2785
|
+
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
2786
|
+
/** Was unscheduled by Later */
|
2787
|
+
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
2788
|
+
/** Was published by Later */
|
2789
|
+
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
2790
|
+
/** Was scheduled */
|
2791
|
+
SCHEDULE = "SCHEDULE",
|
2792
|
+
/** Was removed from moderation */
|
2793
|
+
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
2794
|
+
/** Was rejected from moderation */
|
2795
|
+
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
2796
|
+
/** Was approved in moderation */
|
2797
|
+
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
2798
|
+
/** Tag was deleted */
|
2799
|
+
DELETE_TAG = "DELETE_TAG",
|
2800
|
+
/** Post was pinned */
|
2801
|
+
PIN = "PIN",
|
2802
|
+
/** Post was unpinned */
|
2803
|
+
UNPIN = "UNPIN",
|
2804
|
+
/** Saved automatically by AI tool. */
|
2805
|
+
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
2806
|
+
}
|
2807
|
+
/** @enumType */
|
2808
|
+
type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
|
2809
|
+
declare enum Status {
|
2810
|
+
UNKNOWN = "UNKNOWN",
|
2811
|
+
/** Status indicating the draft post is published. */
|
2812
|
+
PUBLISHED = "PUBLISHED",
|
2813
|
+
/** Status indicating the draft post is unpublished. */
|
2814
|
+
UNPUBLISHED = "UNPUBLISHED",
|
2815
|
+
/** Status indicating the draft post is scheduled for publication. */
|
2816
|
+
SCHEDULED = "SCHEDULED",
|
2817
|
+
/** Status indicating the draft post is deleted. */
|
2818
|
+
DELETED = "DELETED",
|
2819
|
+
/** Status indicating the draft post is in review. */
|
2820
|
+
IN_REVIEW = "IN_REVIEW"
|
2821
|
+
}
|
2822
|
+
/** @enumType */
|
2823
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
2824
|
+
interface DraftPostTranslation {
|
2825
|
+
/**
|
2826
|
+
* Post ID.
|
2827
|
+
* @format GUID
|
2828
|
+
*/
|
2829
|
+
id?: string;
|
2830
|
+
/** Post status. */
|
2831
|
+
status?: StatusWithLiterals;
|
2832
|
+
/**
|
2833
|
+
* Language the post is written in.
|
2834
|
+
* @format LANGUAGE_TAG
|
2835
|
+
*/
|
2836
|
+
language?: string | null;
|
2837
|
+
/**
|
2838
|
+
* Post slug. For example, 'post-slug'.
|
2839
|
+
* @maxLength 100
|
2840
|
+
*/
|
2841
|
+
slug?: string | null;
|
2842
|
+
/** SEO data. */
|
2843
|
+
seoData?: SeoSchema;
|
2844
|
+
/** Post URL. */
|
2845
|
+
url?: PageUrl;
|
2846
|
+
}
|
2847
|
+
interface GetTotalLikesPerMemberRequest {
|
2848
|
+
/**
|
2849
|
+
* Member ID.
|
2850
|
+
* @format GUID
|
2851
|
+
*/
|
2852
|
+
memberId?: string;
|
2853
|
+
}
|
2854
|
+
interface GetTotalLikesPerMemberResponse {
|
2855
|
+
/** The total number of likes of the member. */
|
2856
|
+
total?: number;
|
2857
|
+
}
|
2858
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
2859
|
+
/**
|
2860
|
+
* Member ID of person who triggered the counter update
|
2861
|
+
* @format GUID
|
2862
|
+
*/
|
2863
|
+
memberId?: string | null;
|
2864
|
+
/**
|
2865
|
+
* Visitor ID if person that liked the post is not logged in
|
2866
|
+
* @format GUID
|
2867
|
+
*/
|
2868
|
+
anonymousVisitorId?: string | null;
|
2869
|
+
/**
|
2870
|
+
* ID of the post which counters were updated.
|
2871
|
+
* @format GUID
|
2872
|
+
*/
|
2873
|
+
postId?: string;
|
2874
|
+
/** Field of the updated counter. */
|
2875
|
+
updatedCounterField?: FieldWithLiterals;
|
2876
|
+
/** New counter value. */
|
2877
|
+
counter?: number;
|
2878
|
+
}
|
2879
|
+
/** @oneof */
|
2880
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
2881
|
+
/**
|
2882
|
+
* Member ID of person who triggered the counter update
|
2883
|
+
* @format GUID
|
2884
|
+
*/
|
2885
|
+
memberId?: string | null;
|
2886
|
+
/**
|
2887
|
+
* Visitor ID if person that liked the post is not logged in
|
2888
|
+
* @format GUID
|
2889
|
+
*/
|
2890
|
+
anonymousVisitorId?: string | null;
|
2891
|
+
}
|
2892
|
+
declare enum Field {
|
2893
|
+
/** Undefined field. */
|
2894
|
+
UNKNOWN = "UNKNOWN",
|
2895
|
+
/** Total comments field. */
|
2896
|
+
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
2897
|
+
/** Like count field. */
|
2898
|
+
LIKE_COUNT = "LIKE_COUNT",
|
2899
|
+
/** View count field. */
|
2900
|
+
VIEW_COUNT = "VIEW_COUNT",
|
2901
|
+
/** Rating count field. */
|
2902
|
+
RATING_COUNT = "RATING_COUNT"
|
2903
|
+
}
|
2904
|
+
/** @enumType */
|
2905
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
2906
|
+
interface PostOwnerChanged {
|
2907
|
+
}
|
2908
|
+
interface InitialPostsCopied {
|
2909
|
+
/** Number of posts copied. */
|
2910
|
+
count?: number;
|
2911
|
+
}
|
1819
2912
|
interface GetPostRequest {
|
1820
2913
|
/**
|
1821
2914
|
* Post ID.
|
@@ -2087,6 +3180,273 @@ interface GetPostMetricsResponse {
|
|
2087
3180
|
/** Retrieved post metrics. */
|
2088
3181
|
metrics?: Metrics;
|
2089
3182
|
}
|
3183
|
+
interface ViewPostRequest {
|
3184
|
+
/**
|
3185
|
+
* Post ID.
|
3186
|
+
* @minLength 1
|
3187
|
+
* @maxLength 38
|
3188
|
+
*/
|
3189
|
+
postId?: string;
|
3190
|
+
}
|
3191
|
+
interface ViewPostResponse {
|
3192
|
+
/** Total number of post views */
|
3193
|
+
views?: number;
|
3194
|
+
}
|
3195
|
+
interface LikePostRequest {
|
3196
|
+
/**
|
3197
|
+
* Post ID.
|
3198
|
+
* @minLength 1
|
3199
|
+
* @format GUID
|
3200
|
+
*/
|
3201
|
+
postId?: string;
|
3202
|
+
/**
|
3203
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3204
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3205
|
+
* only the post’s base fields are returned.
|
3206
|
+
* @maxSize 20
|
3207
|
+
*/
|
3208
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
3209
|
+
}
|
3210
|
+
interface LikePostResponse {
|
3211
|
+
/** Post info. */
|
3212
|
+
post?: Post;
|
3213
|
+
}
|
3214
|
+
interface UnlikePostRequest {
|
3215
|
+
/**
|
3216
|
+
* Post ID.
|
3217
|
+
* @minLength 1
|
3218
|
+
* @format GUID
|
3219
|
+
*/
|
3220
|
+
postId?: string;
|
3221
|
+
/**
|
3222
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3223
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3224
|
+
* only the post’s base fields are returned.
|
3225
|
+
* @maxSize 20
|
3226
|
+
*/
|
3227
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
3228
|
+
}
|
3229
|
+
interface UnlikePostResponse {
|
3230
|
+
/** Post info. */
|
3231
|
+
post?: Post;
|
3232
|
+
}
|
3233
|
+
interface PinPostRequest {
|
3234
|
+
/**
|
3235
|
+
* Post ID.
|
3236
|
+
* @minLength 1
|
3237
|
+
* @format GUID
|
3238
|
+
*/
|
3239
|
+
postId?: string;
|
3240
|
+
/**
|
3241
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3242
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3243
|
+
* only the post’s base fields are returned.
|
3244
|
+
* @maxSize 20
|
3245
|
+
*/
|
3246
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
3247
|
+
}
|
3248
|
+
interface PinPostResponse {
|
3249
|
+
/** Post info. */
|
3250
|
+
post?: Post;
|
3251
|
+
}
|
3252
|
+
interface UnpinPostRequest {
|
3253
|
+
/**
|
3254
|
+
* Post ID.
|
3255
|
+
* @minLength 1
|
3256
|
+
* @format GUID
|
3257
|
+
*/
|
3258
|
+
postId?: string;
|
3259
|
+
/**
|
3260
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3261
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3262
|
+
* only the post’s base fields are returned.
|
3263
|
+
* @maxSize 20
|
3264
|
+
*/
|
3265
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
3266
|
+
}
|
3267
|
+
interface UnpinPostResponse {
|
3268
|
+
/** Post info. */
|
3269
|
+
post?: Post;
|
3270
|
+
}
|
3271
|
+
interface ListPostsArchiveRequest {
|
3272
|
+
/**
|
3273
|
+
* Month
|
3274
|
+
* @min 1
|
3275
|
+
* @max 12
|
3276
|
+
*/
|
3277
|
+
month?: number | null;
|
3278
|
+
/**
|
3279
|
+
* Year
|
3280
|
+
* @min 2000
|
3281
|
+
* @max 3000
|
3282
|
+
*/
|
3283
|
+
year?: number;
|
3284
|
+
/**
|
3285
|
+
* Time zone
|
3286
|
+
* @maxLength 50
|
3287
|
+
*/
|
3288
|
+
timeZone?: string | null;
|
3289
|
+
/** Pagination options. */
|
3290
|
+
paging?: BlogPaging;
|
3291
|
+
/**
|
3292
|
+
* Language filter.
|
3293
|
+
*
|
3294
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
3295
|
+
* Pass a language to only receive posts that are in that language.
|
3296
|
+
* If omitted, posts in all languages are returned.
|
3297
|
+
* @format LANGUAGE_TAG
|
3298
|
+
*/
|
3299
|
+
language?: string | null;
|
3300
|
+
/**
|
3301
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3302
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3303
|
+
* only the post’s base fields are returned.
|
3304
|
+
* @maxSize 20
|
3305
|
+
*/
|
3306
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
3307
|
+
}
|
3308
|
+
interface ListPostsArchiveResponse {
|
3309
|
+
/** List of posts. */
|
3310
|
+
posts?: Post[];
|
3311
|
+
/** Details on the paged set of results returned. */
|
3312
|
+
metaData?: MetaData;
|
3313
|
+
/** Details on the paged set of results returned. */
|
3314
|
+
pagingMetadata?: PagingMetadataV2;
|
3315
|
+
}
|
3316
|
+
interface BulkGetPostReactionsRequest {
|
3317
|
+
/**
|
3318
|
+
* Post IDs.
|
3319
|
+
* @maxSize 500
|
3320
|
+
* @maxLength 38
|
3321
|
+
*/
|
3322
|
+
postIds?: string[];
|
3323
|
+
}
|
3324
|
+
interface BulkGetPostReactionsResponse {
|
3325
|
+
/** Map of post.id to reactions */
|
3326
|
+
reactionsMap?: Record<string, Reactions>;
|
3327
|
+
}
|
3328
|
+
interface Reactions {
|
3329
|
+
/**
|
3330
|
+
* Is post liked by the current user
|
3331
|
+
* @readonly
|
3332
|
+
*/
|
3333
|
+
liked?: boolean;
|
3334
|
+
}
|
3335
|
+
interface ListDemoPostsRequest {
|
3336
|
+
/**
|
3337
|
+
* Whether to return only featured posts.
|
3338
|
+
*
|
3339
|
+
* Default: `false`
|
3340
|
+
*/
|
3341
|
+
featured?: boolean;
|
3342
|
+
/**
|
3343
|
+
* Hashtag filter.
|
3344
|
+
*
|
3345
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
3346
|
+
* If omitted, all posts with or without hashtags are returned.
|
3347
|
+
* @maxSize 100
|
3348
|
+
* @maxLength 100
|
3349
|
+
*/
|
3350
|
+
hashtags?: string[];
|
3351
|
+
/**
|
3352
|
+
* Category filter.
|
3353
|
+
*
|
3354
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
3355
|
+
* If omitted, all posts with or without associated categories are returned.
|
3356
|
+
* @maxSize 50
|
3357
|
+
* @format GUID
|
3358
|
+
*/
|
3359
|
+
categoryIds?: string[];
|
3360
|
+
/**
|
3361
|
+
* Tag filter.
|
3362
|
+
*
|
3363
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
3364
|
+
* If omitted, all posts with or without tags are returned.
|
3365
|
+
* @maxSize 50
|
3366
|
+
* @format GUID
|
3367
|
+
*/
|
3368
|
+
tagIds?: string[];
|
3369
|
+
/**
|
3370
|
+
* Sorting options.
|
3371
|
+
*
|
3372
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
3373
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
3374
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
3375
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
3376
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
3377
|
+
* - `TITLE_ASC`: Ordered by `title` in ascening order.
|
3378
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
3379
|
+
* - `RATING`: reserved for internal use.
|
3380
|
+
*
|
3381
|
+
* Default: `FEED`
|
3382
|
+
*/
|
3383
|
+
sort?: GetPostsSortWithLiterals;
|
3384
|
+
/** Pagination options. */
|
3385
|
+
paging?: BlogPaging;
|
3386
|
+
/**
|
3387
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
3388
|
+
* This parameter will be removed on June 30, 2023.
|
3389
|
+
*
|
3390
|
+
* List of post fields to be included in the response.
|
3391
|
+
* @maxSize 20
|
3392
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
3393
|
+
* This parameter will be removed on June 30, 2023.
|
3394
|
+
*
|
3395
|
+
* List of post fields to be included in the response.
|
3396
|
+
* @replacedBy fieldsets
|
3397
|
+
* @targetRemovalDate 2024-06-30
|
3398
|
+
*/
|
3399
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
3400
|
+
/**
|
3401
|
+
* Language filter.
|
3402
|
+
*
|
3403
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
3404
|
+
* Pass a language to only receive posts that are in that language.
|
3405
|
+
* If omitted, posts in all languages are returned.
|
3406
|
+
* @format LANGUAGE_TAG
|
3407
|
+
*/
|
3408
|
+
language?: string | null;
|
3409
|
+
/**
|
3410
|
+
* Post owner's member ID.
|
3411
|
+
* @format GUID
|
3412
|
+
*/
|
3413
|
+
memberId?: string | null;
|
3414
|
+
/**
|
3415
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3416
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3417
|
+
* only the post’s base fields are returned.
|
3418
|
+
* @maxSize 20
|
3419
|
+
*/
|
3420
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
3421
|
+
}
|
3422
|
+
interface ListDemoPostsResponse {
|
3423
|
+
/** List of posts. */
|
3424
|
+
posts?: Post[];
|
3425
|
+
/** Details on the paged set of results returned. */
|
3426
|
+
metaData?: MetaData;
|
3427
|
+
}
|
3428
|
+
interface ConvertDraftJsToRichContentRequest {
|
3429
|
+
/** DraftJs content to convert to Rich content. */
|
3430
|
+
content?: Record<string, any> | null;
|
3431
|
+
}
|
3432
|
+
interface ConvertDraftJsToRichContentResponse {
|
3433
|
+
/**
|
3434
|
+
* Rich content converted from DraftJs content.
|
3435
|
+
* @maxLength 2000000
|
3436
|
+
*/
|
3437
|
+
richContent?: string;
|
3438
|
+
}
|
3439
|
+
interface ConvertRichContentToDraftJsRequest {
|
3440
|
+
/**
|
3441
|
+
* Rich content to convert to DraftJs content.
|
3442
|
+
* @maxLength 2000000
|
3443
|
+
*/
|
3444
|
+
richContent?: string;
|
3445
|
+
}
|
3446
|
+
interface ConvertRichContentToDraftJsResponse {
|
3447
|
+
/** DraftJs content converted from Rich content. */
|
3448
|
+
content?: Record<string, any> | null;
|
3449
|
+
}
|
2090
3450
|
interface CoverMedia extends CoverMediaMediaOneOf {
|
2091
3451
|
/** Image url. */
|
2092
3452
|
image?: Image;
|
@@ -2138,6 +3498,18 @@ interface Video {
|
|
2138
3498
|
/** Video poster */
|
2139
3499
|
thumbnail?: Image;
|
2140
3500
|
}
|
3501
|
+
interface OldBlogMigratedEvent {
|
3502
|
+
/**
|
3503
|
+
* Instance id of new version of blog
|
3504
|
+
* @format GUID
|
3505
|
+
*/
|
3506
|
+
newBlogInstanceId?: string;
|
3507
|
+
/**
|
3508
|
+
* Instance id of old version of blog
|
3509
|
+
* @format GUID
|
3510
|
+
*/
|
3511
|
+
oldBlogInstanceId?: string;
|
3512
|
+
}
|
2141
3513
|
|
2142
3514
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
2143
3515
|
getUrl: (context: any) => string;
|
@@ -2163,4 +3535,4 @@ declare function getPostMetrics(): __PublicMethodMetaInfo<'GET', {
|
|
2163
3535
|
postId: string;
|
2164
3536
|
}, GetPostMetricsRequest$1, GetPostMetricsRequest, GetPostMetricsResponse$1, GetPostMetricsResponse>;
|
2165
3537
|
|
2166
|
-
export { type __PublicMethodMetaInfo, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, queryPostCountStats, queryPosts };
|
3538
|
+
export { type ActionEvent as ActionEventOriginal, Alignment as AlignmentOriginal, type AlignmentWithLiterals as AlignmentWithLiteralsOriginal, type AnchorData as AnchorDataOriginal, type AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOfOriginal, type AppEmbedData as AppEmbedDataOriginal, AppType as AppTypeOriginal, type AppTypeWithLiterals as AppTypeWithLiteralsOriginal, AspectRatio as AspectRatioOriginal, type AspectRatioWithLiterals as AspectRatioWithLiteralsOriginal, type AudioData as AudioDataOriginal, type BackgroundBackgroundOneOf as BackgroundBackgroundOneOfOriginal, type Background as BackgroundOriginal, BackgroundType as BackgroundTypeOriginal, type BackgroundTypeWithLiterals as BackgroundTypeWithLiteralsOriginal, type BlockquoteData as BlockquoteDataOriginal, type BlogPaging as BlogPagingOriginal, type BookingData as BookingDataOriginal, type BorderColors as BorderColorsOriginal, type Border as BorderOriginal, type BulkGetPostReactionsRequest as BulkGetPostReactionsRequestOriginal, type BulkGetPostReactionsResponse as BulkGetPostReactionsResponseOriginal, type BulletedListData as BulletedListDataOriginal, type ButtonData as ButtonDataOriginal, ButtonDataType as ButtonDataTypeOriginal, type ButtonDataTypeWithLiterals as ButtonDataTypeWithLiteralsOriginal, type ButtonStyles as ButtonStylesOriginal, type CaptionData as CaptionDataOriginal, type CardStyles as CardStylesOriginal, type Category as CategoryOriginal, type CategoryTranslation as CategoryTranslationOriginal, type CellStyle as CellStyleOriginal, type CodeBlockData as CodeBlockDataOriginal, type CollapsibleListData as CollapsibleListDataOriginal, type ColorData as ColorDataOriginal, type Colors as ColorsOriginal, type ConvertDraftJsToRichContentRequest as ConvertDraftJsToRichContentRequestOriginal, type ConvertDraftJsToRichContentResponse as ConvertDraftJsToRichContentResponseOriginal, type ConvertRichContentToDraftJsRequest as ConvertRichContentToDraftJsRequestOriginal, type ConvertRichContentToDraftJsResponse as ConvertRichContentToDraftJsResponseOriginal, type CoverMediaMediaOneOf as CoverMediaMediaOneOfOriginal, type CoverMedia as CoverMediaOriginal, type CreateDraftPostFromTemplateRequest as CreateDraftPostFromTemplateRequestOriginal, type CreateDraftPostFromTemplateResponse as CreateDraftPostFromTemplateResponseOriginal, Crop as CropOriginal, type CropWithLiterals as CropWithLiteralsOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DecorationDataOneOf as DecorationDataOneOfOriginal, type Decoration as DecorationOriginal, DecorationType as DecorationTypeOriginal, type DecorationTypeWithLiterals as DecorationTypeWithLiteralsOriginal, type Design as DesignOriginal, type Dimensions as DimensionsOriginal, Direction as DirectionOriginal, type DirectionWithLiterals as DirectionWithLiteralsOriginal, DividerDataAlignment as DividerDataAlignmentOriginal, type DividerDataAlignmentWithLiterals as DividerDataAlignmentWithLiteralsOriginal, type DividerData as DividerDataOriginal, type DocumentStyle as DocumentStyleOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DraftPost as DraftPostOriginal, type DraftPostTranslation as DraftPostTranslationOriginal, type EmbedData as EmbedDataOriginal, type EmbedMedia as EmbedMediaOriginal, type EmbedThumbnail as EmbedThumbnailOriginal, type EmbedVideo as EmbedVideoOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EventData as EventDataOriginal, Field as FieldOriginal, type FieldWithLiterals as FieldWithLiteralsOriginal, type FileData as FileDataOriginal, type FileSourceDataOneOf as FileSourceDataOneOfOriginal, type FileSource as FileSourceOriginal, type FocalPoint as FocalPointOriginal, type FontSizeData as FontSizeDataOriginal, FontType as FontTypeOriginal, type FontTypeWithLiterals as FontTypeWithLiteralsOriginal, type GIFData as GIFDataOriginal, type GIF as GIFOriginal, GIFType as GIFTypeOriginal, type GIFTypeWithLiterals as GIFTypeWithLiteralsOriginal, type GalleryData as GalleryDataOriginal, type GalleryOptionsLayout as GalleryOptionsLayoutOriginal, type GalleryOptions as GalleryOptionsOriginal, type GetPostBySlugRequest as GetPostBySlugRequestOriginal, type GetPostBySlugResponse as GetPostBySlugResponseOriginal, type GetPostMetricsRequest as GetPostMetricsRequestOriginal, type GetPostMetricsResponse as GetPostMetricsResponseOriginal, type GetPostRequest as GetPostRequestOriginal, type GetPostResponse as GetPostResponseOriginal, GetPostTemplatesSort as GetPostTemplatesSortOriginal, type GetPostTemplatesSortWithLiterals as GetPostTemplatesSortWithLiteralsOriginal, GetPostsSort as GetPostsSortOriginal, type GetPostsSortWithLiterals as GetPostsSortWithLiteralsOriginal, type GetTemplateRequest as GetTemplateRequestOriginal, type GetTemplateResponse as GetTemplateResponseOriginal, type GetTotalLikesPerMemberRequest as GetTotalLikesPerMemberRequestOriginal, type GetTotalLikesPerMemberResponse as GetTotalLikesPerMemberResponseOriginal, type GetTotalPostsRequest as GetTotalPostsRequestOriginal, type GetTotalPostsResponse as GetTotalPostsResponseOriginal, type GetTotalPublicationsRequest as GetTotalPublicationsRequestOriginal, type GetTotalPublicationsResponse as GetTotalPublicationsResponseOriginal, type Gradient as GradientOriginal, type HTMLDataDataOneOf as HTMLDataDataOneOfOriginal, type HTMLData as HTMLDataOriginal, type HeadingData as HeadingDataOriginal, type Height as HeightOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageData as ImageDataOriginal, type ImageDataStyles as ImageDataStylesOriginal, type Image as ImageOriginal, type ImageStyles as ImageStylesOriginal, InitialExpandedItems as InitialExpandedItemsOriginal, type InitialExpandedItemsWithLiterals as InitialExpandedItemsWithLiteralsOriginal, type InitialPostsCopied as InitialPostsCopiedOriginal, type ItemDataOneOf as ItemDataOneOfOriginal, type ItemImage as ItemImageOriginal, type Item as ItemOriginal, type ItemStyle as ItemStyleOriginal, type ItemVideo as ItemVideoOriginal, type Keyword as KeywordOriginal, type LayoutCellData as LayoutCellDataOriginal, Layout as LayoutOriginal, LayoutType as LayoutTypeOriginal, type LayoutTypeWithLiterals as LayoutTypeWithLiteralsOriginal, type LayoutWithLiterals as LayoutWithLiteralsOriginal, type LikePostRequest as LikePostRequestOriginal, type LikePostResponse as LikePostResponseOriginal, LineStyle as LineStyleOriginal, type LineStyleWithLiterals as LineStyleWithLiteralsOriginal, type LinkDataOneOf as LinkDataOneOfOriginal, type LinkData as LinkDataOriginal, type Link as LinkOriginal, type LinkPreviewData as LinkPreviewDataOriginal, type LinkPreviewDataStyles as LinkPreviewDataStylesOriginal, type ListDemoPostsRequest as ListDemoPostsRequestOriginal, type ListDemoPostsResponse as ListDemoPostsResponseOriginal, type ListPostsArchiveRequest as ListPostsArchiveRequestOriginal, type ListPostsArchiveResponse as ListPostsArchiveResponseOriginal, type ListPostsRequest as ListPostsRequestOriginal, type ListPostsResponse as ListPostsResponseOriginal, type ListTemplatesRequest as ListTemplatesRequestOriginal, type ListTemplatesResponse as ListTemplatesResponseOriginal, type ListValue as ListValueOriginal, type MapData as MapDataOriginal, type MapSettings as MapSettingsOriginal, MapType as MapTypeOriginal, type MapTypeWithLiterals as MapTypeWithLiteralsOriginal, type MediaMediaOneOf as MediaMediaOneOfOriginal, type Media as MediaOriginal, type MentionData as MentionDataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type Metadata as MetadataOriginal, type Metrics as MetricsOriginal, type ModerationDetails as ModerationDetailsOriginal, ModerationStatusStatus as ModerationStatusStatusOriginal, type ModerationStatusStatusWithLiterals as ModerationStatusStatusWithLiteralsOriginal, type NodeDataOneOf as NodeDataOneOfOriginal, type Node as NodeOriginal, type NodeStyle as NodeStyleOriginal, NodeType as NodeTypeOriginal, type NodeTypeWithLiterals as NodeTypeWithLiteralsOriginal, NullValue as NullValueOriginal, type NullValueWithLiterals as NullValueWithLiteralsOriginal, type Oembed as OembedOriginal, type OldBlogMigratedEvent as OldBlogMigratedEventOriginal, type OptionDesign as OptionDesignOriginal, type OptionLayout as OptionLayoutOriginal, type Option as OptionOriginal, Order as OrderOriginal, type OrderWithLiterals as OrderWithLiteralsOriginal, type OrderedListData as OrderedListDataOriginal, Orientation as OrientationOriginal, type OrientationWithLiterals as OrientationWithLiteralsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type PDFSettings as PDFSettingsOriginal, type PageUrl as PageUrlOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type ParagraphData as ParagraphDataOriginal, type PeriodPostCount as PeriodPostCountOriginal, type PeriodPublicationsCount as PeriodPublicationsCountOriginal, type Permissions as PermissionsOriginal, type PinPostRequest as PinPostRequestOriginal, type PinPostResponse as PinPostResponseOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, type PlaybackOptions as PlaybackOptionsOriginal, PluginContainerDataAlignment as PluginContainerDataAlignmentOriginal, type PluginContainerDataAlignmentWithLiterals as PluginContainerDataAlignmentWithLiteralsOriginal, type PluginContainerData as PluginContainerDataOriginal, type PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOfOriginal, type PluginContainerDataWidth as PluginContainerDataWidthOriginal, type PollDataLayout as PollDataLayoutOriginal, type PollData as PollDataOriginal, type PollDesign as PollDesignOriginal, PollLayoutDirection as PollLayoutDirectionOriginal, type PollLayoutDirectionWithLiterals as PollLayoutDirectionWithLiteralsOriginal, type PollLayout as PollLayoutOriginal, PollLayoutType as PollLayoutTypeOriginal, type PollLayoutTypeWithLiterals as PollLayoutTypeWithLiteralsOriginal, type Poll as PollOriginal, type PollSettings as PollSettingsOriginal, Position as PositionOriginal, type PositionWithLiterals as PositionWithLiteralsOriginal, type PostCategoriesUpdated as PostCategoriesUpdatedOriginal, type PostCountInfo as PostCountInfoOriginal, type PostCountersUpdatedInitiatorOneOf as PostCountersUpdatedInitiatorOneOfOriginal, type PostCountersUpdated as PostCountersUpdatedOriginal, PostFieldField as PostFieldFieldOriginal, type PostFieldFieldWithLiterals as PostFieldFieldWithLiteralsOriginal, type PostLikedInitiatorOneOf as PostLikedInitiatorOneOfOriginal, type PostLiked as PostLikedOriginal, type Post as PostOriginal, type PostOwnerChanged as PostOwnerChangedOriginal, type PostTagsUpdated as PostTagsUpdatedOriginal, type PostTranslation as PostTranslationOriginal, type PostUnlikedInitiatorOneOf as PostUnlikedInitiatorOneOfOriginal, type PostUnliked as PostUnlikedOriginal, type PricingData as PricingDataOriginal, type QueryPostCountStatsRequest as QueryPostCountStatsRequestOriginal, type QueryPostCountStatsResponse as QueryPostCountStatsResponseOriginal, type QueryPostsRequest as QueryPostsRequestOriginal, type QueryPostsResponse as QueryPostsResponseOriginal, QueryPublicationsCountStatsRequestOrder as QueryPublicationsCountStatsRequestOrderOriginal, type QueryPublicationsCountStatsRequestOrderWithLiterals as QueryPublicationsCountStatsRequestOrderWithLiteralsOriginal, type QueryPublicationsCountStatsRequest as QueryPublicationsCountStatsRequestOriginal, type QueryPublicationsCountStatsResponse as QueryPublicationsCountStatsResponseOriginal, type Reactions as ReactionsOriginal, type Rel as RelOriginal, Resizing as ResizingOriginal, type ResizingWithLiterals as ResizingWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RibbonStyles as RibbonStylesOriginal, type RichContent as RichContentOriginal, type ScheduledPostPublished as ScheduledPostPublishedOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Source as SourceOriginal, type SourceWithLiterals as SourceWithLiteralsOriginal, type SpoilerData as SpoilerDataOriginal, type Spoiler as SpoilerOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StylesBorder as StylesBorderOriginal, type Styles as StylesOriginal, StylesPosition as StylesPositionOriginal, type StylesPositionWithLiterals as StylesPositionWithLiteralsOriginal, type TableCellData as TableCellDataOriginal, type TableData as TableDataOriginal, type Tag as TagOriginal, Target as TargetOriginal, type TargetWithLiterals as TargetWithLiteralsOriginal, TextAlignment as TextAlignmentOriginal, type TextAlignmentWithLiterals as TextAlignmentWithLiteralsOriginal, type TextData as TextDataOriginal, type TextNodeStyle as TextNodeStyleOriginal, type TextStyle as TextStyleOriginal, ThumbnailsAlignment as ThumbnailsAlignmentOriginal, type ThumbnailsAlignmentWithLiterals as ThumbnailsAlignmentWithLiteralsOriginal, type Thumbnails as ThumbnailsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UnlikePostRequest as UnlikePostRequestOriginal, type UnlikePostResponse as UnlikePostResponseOriginal, type UnpinPostRequest as UnpinPostRequestOriginal, type UnpinPostResponse as UnpinPostResponseOriginal, type V1Media as V1MediaOriginal, VerticalAlignment as VerticalAlignmentOriginal, type VerticalAlignmentWithLiterals as VerticalAlignmentWithLiteralsOriginal, type VideoData as VideoDataOriginal, type Video as VideoOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, ViewMode as ViewModeOriginal, type ViewModeWithLiterals as ViewModeWithLiteralsOriginal, type ViewPostRequest as ViewPostRequestOriginal, type ViewPostResponse as ViewPostResponseOriginal, ViewRole as ViewRoleOriginal, type ViewRoleWithLiterals as ViewRoleWithLiteralsOriginal, VoteRole as VoteRoleOriginal, type VoteRoleWithLiterals as VoteRoleWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, Width as WidthOriginal, WidthType as WidthTypeOriginal, type WidthTypeWithLiterals as WidthTypeWithLiteralsOriginal, type WidthWithLiterals as WidthWithLiteralsOriginal, type WixMedia as WixMediaOriginal, type __PublicMethodMetaInfo, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, queryPostCountStats, queryPosts };
|