@wix/auto_sdk_blog_posts 1.0.149 → 1.0.151
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.js +38 -38
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +683 -668
- package/build/cjs/index.typings.js +38 -38
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +684 -669
- package/build/cjs/meta.js +38 -38
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +2 -2
- package/build/es/index.mjs +38 -38
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +683 -668
- package/build/es/index.typings.mjs +38 -38
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +684 -669
- package/build/es/meta.mjs +38 -38
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +2 -2
- package/build/internal/cjs/index.js +38 -38
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +683 -668
- package/build/internal/cjs/index.typings.js +38 -38
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +684 -669
- package/build/internal/cjs/meta.js +38 -38
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +2 -2
- package/build/internal/es/index.mjs +38 -38
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +683 -668
- package/build/internal/es/index.typings.mjs +38 -38
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +684 -669
- package/build/internal/es/meta.mjs +38 -38
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +2 -2
- package/package.json +2 -2
|
@@ -508,7 +508,7 @@ type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
|
|
|
508
508
|
interface Stop {
|
|
509
509
|
/**
|
|
510
510
|
* Stop color as hex value.
|
|
511
|
-
* @
|
|
511
|
+
* @maxLength 19
|
|
512
512
|
*/
|
|
513
513
|
color?: string | null;
|
|
514
514
|
/** Stop position (0-1). */
|
|
@@ -549,7 +549,7 @@ interface Background {
|
|
|
549
549
|
type?: BackgroundTypeWithLiterals;
|
|
550
550
|
/**
|
|
551
551
|
* Background color as a hexadecimal value.
|
|
552
|
-
* @
|
|
552
|
+
* @maxLength 19
|
|
553
553
|
*/
|
|
554
554
|
color?: string | null;
|
|
555
555
|
/** Gradient configuration. */
|
|
@@ -656,33 +656,33 @@ interface Styles {
|
|
|
656
656
|
borderRadius?: number | null;
|
|
657
657
|
/**
|
|
658
658
|
* Border color as a hexadecimal value.
|
|
659
|
-
* @
|
|
659
|
+
* @maxLength 19
|
|
660
660
|
*/
|
|
661
661
|
borderColor?: string | null;
|
|
662
662
|
/**
|
|
663
663
|
* Border color as a hexadecimal value (hover state).
|
|
664
|
-
* @
|
|
664
|
+
* @maxLength 19
|
|
665
665
|
*/
|
|
666
666
|
borderColorHover?: string | null;
|
|
667
667
|
/**
|
|
668
668
|
* Text color as a hexadecimal value.
|
|
669
|
-
* @
|
|
669
|
+
* @maxLength 19
|
|
670
670
|
*/
|
|
671
671
|
textColor?: string | null;
|
|
672
672
|
/**
|
|
673
673
|
* Text color as a hexadecimal value (hover state).
|
|
674
|
-
* @
|
|
674
|
+
* @maxLength 19
|
|
675
675
|
*/
|
|
676
676
|
textColorHover?: string | null;
|
|
677
677
|
/**
|
|
678
678
|
* Deprecated: Use `background` instead.
|
|
679
|
-
* @
|
|
679
|
+
* @maxLength 19
|
|
680
680
|
* @deprecated
|
|
681
681
|
*/
|
|
682
682
|
backgroundColor?: string | null;
|
|
683
683
|
/**
|
|
684
684
|
* Deprecated: Use `backgroundHover` instead.
|
|
685
|
-
* @
|
|
685
|
+
* @maxLength 19
|
|
686
686
|
* @deprecated
|
|
687
687
|
*/
|
|
688
688
|
backgroundColorHover?: string | null;
|
|
@@ -1134,7 +1134,7 @@ interface StylesBorder {
|
|
|
1134
1134
|
width?: number | null;
|
|
1135
1135
|
/**
|
|
1136
1136
|
* Border color as a hexadecimal value.
|
|
1137
|
-
* @
|
|
1137
|
+
* @maxLength 19
|
|
1138
1138
|
*/
|
|
1139
1139
|
color?: string | null;
|
|
1140
1140
|
/** Border radius in pixels. */
|
|
@@ -1175,22 +1175,22 @@ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HI
|
|
|
1175
1175
|
interface LinkPreviewDataStyles {
|
|
1176
1176
|
/**
|
|
1177
1177
|
* Background color as a hexadecimal value.
|
|
1178
|
-
* @
|
|
1178
|
+
* @maxLength 19
|
|
1179
1179
|
*/
|
|
1180
1180
|
backgroundColor?: string | null;
|
|
1181
1181
|
/**
|
|
1182
1182
|
* Title color as a hexadecimal value.
|
|
1183
|
-
* @
|
|
1183
|
+
* @maxLength 19
|
|
1184
1184
|
*/
|
|
1185
1185
|
titleColor?: string | null;
|
|
1186
1186
|
/**
|
|
1187
1187
|
* Subtitle color as a hexadecimal value.
|
|
1188
|
-
* @
|
|
1188
|
+
* @maxLength 19
|
|
1189
1189
|
*/
|
|
1190
1190
|
subtitleColor?: string | null;
|
|
1191
1191
|
/**
|
|
1192
1192
|
* Link color as a hexadecimal value.
|
|
1193
|
-
* @
|
|
1193
|
+
* @maxLength 19
|
|
1194
1194
|
*/
|
|
1195
1195
|
linkColor?: string | null;
|
|
1196
1196
|
/** Border width in pixels. */
|
|
@@ -1199,7 +1199,7 @@ interface LinkPreviewDataStyles {
|
|
|
1199
1199
|
borderRadius?: number | null;
|
|
1200
1200
|
/**
|
|
1201
1201
|
* Border color as a hexadecimal value.
|
|
1202
|
-
* @
|
|
1202
|
+
* @maxLength 19
|
|
1203
1203
|
*/
|
|
1204
1204
|
borderColor?: string | null;
|
|
1205
1205
|
/** Position of thumbnail. Defaults to `START`. */
|
|
@@ -1350,19 +1350,19 @@ interface BackgroundGradient {
|
|
|
1350
1350
|
angle?: number | null;
|
|
1351
1351
|
/**
|
|
1352
1352
|
* The start color as a hexademical value.
|
|
1353
|
-
* @
|
|
1353
|
+
* @maxLength 19
|
|
1354
1354
|
*/
|
|
1355
1355
|
startColor?: string | null;
|
|
1356
1356
|
/**
|
|
1357
1357
|
* The end color as a hexademical value.
|
|
1358
|
-
* @
|
|
1358
|
+
* @maxLength 19
|
|
1359
1359
|
*/
|
|
1360
1360
|
lastColor?: string | null;
|
|
1361
1361
|
}
|
|
1362
1362
|
interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
|
|
1363
1363
|
/**
|
|
1364
1364
|
* The background color as a hexademical value.
|
|
1365
|
-
* @
|
|
1365
|
+
* @maxLength 19
|
|
1366
1366
|
*/
|
|
1367
1367
|
color?: string | null;
|
|
1368
1368
|
/** An image to use for the background. */
|
|
@@ -1376,7 +1376,7 @@ interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
|
|
|
1376
1376
|
interface PollDesignBackgroundBackgroundOneOf {
|
|
1377
1377
|
/**
|
|
1378
1378
|
* The background color as a hexademical value.
|
|
1379
|
-
* @
|
|
1379
|
+
* @maxLength 19
|
|
1380
1380
|
*/
|
|
1381
1381
|
color?: string | null;
|
|
1382
1382
|
/** An image to use for the background. */
|
|
@@ -1690,32 +1690,32 @@ interface ButtonStyles {
|
|
|
1690
1690
|
borderRadius?: number | null;
|
|
1691
1691
|
/**
|
|
1692
1692
|
* Border color as a hexadecimal value.
|
|
1693
|
-
* @
|
|
1693
|
+
* @maxLength 19
|
|
1694
1694
|
*/
|
|
1695
1695
|
borderColor?: string | null;
|
|
1696
1696
|
/**
|
|
1697
1697
|
* Text color as a hexadecimal value.
|
|
1698
|
-
* @
|
|
1698
|
+
* @maxLength 19
|
|
1699
1699
|
*/
|
|
1700
1700
|
textColor?: string | null;
|
|
1701
1701
|
/**
|
|
1702
1702
|
* Background color as a hexadecimal value.
|
|
1703
|
-
* @
|
|
1703
|
+
* @maxLength 19
|
|
1704
1704
|
*/
|
|
1705
1705
|
backgroundColor?: string | null;
|
|
1706
1706
|
/**
|
|
1707
1707
|
* Border color as a hexadecimal value (hover state).
|
|
1708
|
-
* @
|
|
1708
|
+
* @maxLength 19
|
|
1709
1709
|
*/
|
|
1710
1710
|
borderColorHover?: string | null;
|
|
1711
1711
|
/**
|
|
1712
1712
|
* Text color as a hexadecimal value (hover state).
|
|
1713
|
-
* @
|
|
1713
|
+
* @maxLength 19
|
|
1714
1714
|
*/
|
|
1715
1715
|
textColorHover?: string | null;
|
|
1716
1716
|
/**
|
|
1717
1717
|
* Background color as a hexadecimal value (hover state).
|
|
1718
|
-
* @
|
|
1718
|
+
* @maxLength 19
|
|
1719
1719
|
*/
|
|
1720
1720
|
backgroundColorHover?: string | null;
|
|
1721
1721
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
@@ -1732,7 +1732,7 @@ interface ImageStyles {
|
|
|
1732
1732
|
resizing?: ResizingWithLiterals;
|
|
1733
1733
|
/**
|
|
1734
1734
|
* Image border color as a hexadecimal value.
|
|
1735
|
-
* @
|
|
1735
|
+
* @maxLength 19
|
|
1736
1736
|
*/
|
|
1737
1737
|
borderColor?: string | null;
|
|
1738
1738
|
/** Image border width in pixels. */
|
|
@@ -1745,17 +1745,17 @@ interface RibbonStyles {
|
|
|
1745
1745
|
ribbonText?: string | null;
|
|
1746
1746
|
/**
|
|
1747
1747
|
* Ribbon background color as a hexadecimal value.
|
|
1748
|
-
* @
|
|
1748
|
+
* @maxLength 19
|
|
1749
1749
|
*/
|
|
1750
1750
|
backgroundColor?: string | null;
|
|
1751
1751
|
/**
|
|
1752
1752
|
* Ribbon text color as a hexadecimal value.
|
|
1753
|
-
* @
|
|
1753
|
+
* @maxLength 19
|
|
1754
1754
|
*/
|
|
1755
1755
|
textColor?: string | null;
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Ribbon border color as a hexadecimal value.
|
|
1758
|
-
* @
|
|
1758
|
+
* @maxLength 19
|
|
1759
1759
|
*/
|
|
1760
1760
|
borderColor?: string | null;
|
|
1761
1761
|
/** Ribbon border width in pixels. */
|
|
@@ -1768,12 +1768,12 @@ interface RibbonStyles {
|
|
|
1768
1768
|
interface CardStyles {
|
|
1769
1769
|
/**
|
|
1770
1770
|
* Card background color as a hexadecimal value.
|
|
1771
|
-
* @
|
|
1771
|
+
* @maxLength 19
|
|
1772
1772
|
*/
|
|
1773
1773
|
backgroundColor?: string | null;
|
|
1774
1774
|
/**
|
|
1775
1775
|
* Card border color as a hexadecimal value.
|
|
1776
|
-
* @
|
|
1776
|
+
* @maxLength 19
|
|
1777
1777
|
*/
|
|
1778
1778
|
borderColor?: string | null;
|
|
1779
1779
|
/** Card border width in pixels. */
|
|
@@ -1788,12 +1788,12 @@ interface CardStyles {
|
|
|
1788
1788
|
titlePriceLayout?: LayoutWithLiterals;
|
|
1789
1789
|
/**
|
|
1790
1790
|
* Title text color as a hexadecimal value.
|
|
1791
|
-
* @
|
|
1791
|
+
* @maxLength 19
|
|
1792
1792
|
*/
|
|
1793
1793
|
titleColor?: string | null;
|
|
1794
1794
|
/**
|
|
1795
1795
|
* Text color as a hexadecimal value.
|
|
1796
|
-
* @
|
|
1796
|
+
* @maxLength 19
|
|
1797
1797
|
*/
|
|
1798
1798
|
textColor?: string | null;
|
|
1799
1799
|
}
|
|
@@ -1975,29 +1975,29 @@ interface CellStyle {
|
|
|
1975
1975
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1976
1976
|
/**
|
|
1977
1977
|
* Cell background color as a hexadecimal value.
|
|
1978
|
-
* @
|
|
1978
|
+
* @maxLength 19
|
|
1979
1979
|
*/
|
|
1980
1980
|
backgroundColor?: string | null;
|
|
1981
1981
|
}
|
|
1982
1982
|
interface BorderColors {
|
|
1983
1983
|
/**
|
|
1984
1984
|
* Left border color as a hexadecimal value.
|
|
1985
|
-
* @
|
|
1985
|
+
* @maxLength 19
|
|
1986
1986
|
*/
|
|
1987
1987
|
left?: string | null;
|
|
1988
1988
|
/**
|
|
1989
1989
|
* Right border color as a hexadecimal value.
|
|
1990
|
-
* @
|
|
1990
|
+
* @maxLength 19
|
|
1991
1991
|
*/
|
|
1992
1992
|
right?: string | null;
|
|
1993
1993
|
/**
|
|
1994
1994
|
* Top border color as a hexadecimal value.
|
|
1995
|
-
* @
|
|
1995
|
+
* @maxLength 19
|
|
1996
1996
|
*/
|
|
1997
1997
|
top?: string | null;
|
|
1998
1998
|
/**
|
|
1999
1999
|
* Bottom border color as a hexadecimal value.
|
|
2000
|
-
* @
|
|
2000
|
+
* @maxLength 19
|
|
2001
2001
|
*/
|
|
2002
2002
|
bottom?: string | null;
|
|
2003
2003
|
}
|
|
@@ -2072,7 +2072,7 @@ interface CaptionData {
|
|
|
2072
2072
|
interface LayoutData {
|
|
2073
2073
|
/**
|
|
2074
2074
|
* Deprecated: Use `background` instead.
|
|
2075
|
-
* @
|
|
2075
|
+
* @maxLength 19
|
|
2076
2076
|
* @deprecated
|
|
2077
2077
|
*/
|
|
2078
2078
|
backgroundColor?: string | null;
|
|
@@ -2080,7 +2080,7 @@ interface LayoutData {
|
|
|
2080
2080
|
backgroundImage?: LayoutDataBackgroundImage;
|
|
2081
2081
|
/**
|
|
2082
2082
|
* Border color as a hexadecimal value.
|
|
2083
|
-
* @
|
|
2083
|
+
* @maxLength 19
|
|
2084
2084
|
*/
|
|
2085
2085
|
borderColor?: string | null;
|
|
2086
2086
|
/** Border width in pixels. */
|
|
@@ -2089,7 +2089,7 @@ interface LayoutData {
|
|
|
2089
2089
|
borderRadius?: number | null;
|
|
2090
2090
|
/**
|
|
2091
2091
|
* Deprecated: Use `backdrop` instead.
|
|
2092
|
-
* @
|
|
2092
|
+
* @maxLength 19
|
|
2093
2093
|
* @deprecated
|
|
2094
2094
|
*/
|
|
2095
2095
|
backdropColor?: string | null;
|
|
@@ -2227,7 +2227,7 @@ interface LayoutDataBackground {
|
|
|
2227
2227
|
type?: LayoutDataBackgroundTypeWithLiterals;
|
|
2228
2228
|
/**
|
|
2229
2229
|
* Background color as a hexadecimal value.
|
|
2230
|
-
* @
|
|
2230
|
+
* @maxLength 19
|
|
2231
2231
|
*/
|
|
2232
2232
|
color?: string | null;
|
|
2233
2233
|
/** Gradient configuration. */
|
|
@@ -2239,7 +2239,7 @@ interface Backdrop {
|
|
|
2239
2239
|
type?: BackdropTypeWithLiterals;
|
|
2240
2240
|
/**
|
|
2241
2241
|
* Backdrop color as a hexadecimal value.
|
|
2242
|
-
* @
|
|
2242
|
+
* @maxLength 19
|
|
2243
2243
|
*/
|
|
2244
2244
|
color?: string | null;
|
|
2245
2245
|
/** Gradient configuration. */
|
|
@@ -2260,7 +2260,7 @@ interface ShapeData {
|
|
|
2260
2260
|
interface ShapeDataStyles {
|
|
2261
2261
|
/**
|
|
2262
2262
|
* Shape fill color as a hexadecimal value.
|
|
2263
|
-
* @
|
|
2263
|
+
* @maxLength 19
|
|
2264
2264
|
*/
|
|
2265
2265
|
color?: string | null;
|
|
2266
2266
|
/** Map of original color keys to their new color values. */
|
|
@@ -2319,7 +2319,7 @@ interface CardDataBackground {
|
|
|
2319
2319
|
type?: CardDataBackgroundTypeWithLiterals;
|
|
2320
2320
|
/**
|
|
2321
2321
|
* Background color as a hexadecimal value.
|
|
2322
|
-
* @
|
|
2322
|
+
* @maxLength 19
|
|
2323
2323
|
*/
|
|
2324
2324
|
color?: string | null;
|
|
2325
2325
|
/** Gradient configuration. */
|
|
@@ -2346,7 +2346,7 @@ interface TocData {
|
|
|
2346
2346
|
itemSpacing?: number | null;
|
|
2347
2347
|
/**
|
|
2348
2348
|
* Optional override for the text color.
|
|
2349
|
-
* @
|
|
2349
|
+
* @maxLength 19
|
|
2350
2350
|
*/
|
|
2351
2351
|
color?: string | null;
|
|
2352
2352
|
/** Indentation style. Default: NESTED. */
|
|
@@ -2388,7 +2388,10 @@ interface SmartBlockData {
|
|
|
2388
2388
|
orientation?: string | null;
|
|
2389
2389
|
/** Column size controlling cells per row. */
|
|
2390
2390
|
columnSize?: ColumnSizeWithLiterals;
|
|
2391
|
-
/**
|
|
2391
|
+
/**
|
|
2392
|
+
* Border color (for SOLID_JOINED_BOXES variant).
|
|
2393
|
+
* @maxLength 19
|
|
2394
|
+
*/
|
|
2392
2395
|
borderColor?: string | null;
|
|
2393
2396
|
/** Border width in pixels (for SOLID_JOINED_BOXES variant). */
|
|
2394
2397
|
borderWidth?: number | null;
|
|
@@ -2447,7 +2450,10 @@ interface SmartBlockCellData {
|
|
|
2447
2450
|
label?: string | null;
|
|
2448
2451
|
/** Shape file details. */
|
|
2449
2452
|
shape?: V1Media;
|
|
2450
|
-
/**
|
|
2453
|
+
/**
|
|
2454
|
+
* Border color of the cell.
|
|
2455
|
+
* @maxLength 19
|
|
2456
|
+
*/
|
|
2451
2457
|
borderColor?: string | null;
|
|
2452
2458
|
/** Border width in pixels. */
|
|
2453
2459
|
borderWidth?: number | null;
|
|
@@ -2455,11 +2461,20 @@ interface SmartBlockCellData {
|
|
|
2455
2461
|
borderRadius?: number | null;
|
|
2456
2462
|
/** The type of the parent smart block (must match parent). */
|
|
2457
2463
|
type?: SmartBlockDataTypeWithLiterals;
|
|
2458
|
-
/**
|
|
2464
|
+
/**
|
|
2465
|
+
* Accent color for non-background variants (e.g., line, bullet, label color).
|
|
2466
|
+
* @maxLength 19
|
|
2467
|
+
*/
|
|
2459
2468
|
accentColor?: string | null;
|
|
2460
|
-
/**
|
|
2469
|
+
/**
|
|
2470
|
+
* Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
|
|
2471
|
+
* @maxLength 19
|
|
2472
|
+
*/
|
|
2461
2473
|
backgroundColor?: string | null;
|
|
2462
|
-
/**
|
|
2474
|
+
/**
|
|
2475
|
+
* Shape fill color as a hexadecimal value.
|
|
2476
|
+
* @maxLength 19
|
|
2477
|
+
*/
|
|
2463
2478
|
shapeColor?: string | null;
|
|
2464
2479
|
}
|
|
2465
2480
|
interface Metadata {
|
|
@@ -2729,311 +2744,595 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2729
2744
|
*/
|
|
2730
2745
|
anonymousVisitorId?: string | null;
|
|
2731
2746
|
}
|
|
2732
|
-
interface
|
|
2747
|
+
interface GetTotalLikesPerMemberRequest {
|
|
2733
2748
|
/**
|
|
2734
|
-
*
|
|
2735
|
-
* @maxSize 50
|
|
2749
|
+
* Member ID.
|
|
2736
2750
|
* @format GUID
|
|
2737
2751
|
*/
|
|
2738
|
-
|
|
2739
|
-
/**
|
|
2740
|
-
* Filter post templates by provided language
|
|
2741
|
-
* @format LANGUAGE_TAG
|
|
2742
|
-
*/
|
|
2743
|
-
language?: string | null;
|
|
2744
|
-
/** Returns post template categories when set to TRUE */
|
|
2745
|
-
listTemplateCategories?: boolean;
|
|
2746
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2747
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2748
|
-
/** Pagination options. */
|
|
2749
|
-
paging?: BlogPaging;
|
|
2752
|
+
memberId?: string;
|
|
2750
2753
|
}
|
|
2751
|
-
|
|
2752
|
-
/**
|
|
2753
|
-
|
|
2754
|
-
/** Sort by descending publishing date. */
|
|
2755
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2754
|
+
interface GetTotalLikesPerMemberResponse {
|
|
2755
|
+
/** The total number of likes of the member. */
|
|
2756
|
+
total?: number;
|
|
2756
2757
|
}
|
|
2757
|
-
|
|
2758
|
-
|
|
2759
|
-
|
|
2758
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2759
|
+
createdEvent?: EntityCreatedEvent;
|
|
2760
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2761
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2762
|
+
actionEvent?: ActionEvent;
|
|
2763
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2764
|
+
_id?: string;
|
|
2760
2765
|
/**
|
|
2761
|
-
*
|
|
2762
|
-
*
|
|
2763
|
-
*
|
|
2764
|
-
* Default: `0`
|
|
2766
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2767
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2765
2768
|
*/
|
|
2766
|
-
|
|
2769
|
+
entityFqdn?: string;
|
|
2767
2770
|
/**
|
|
2768
|
-
*
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2771
|
-
* Default:`50`
|
|
2772
|
-
* @min 1
|
|
2773
|
-
* @max 100
|
|
2771
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2772
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2774
2773
|
*/
|
|
2775
|
-
|
|
2774
|
+
slug?: string;
|
|
2775
|
+
/** ID of the entity associated with the event. */
|
|
2776
|
+
entityId?: string;
|
|
2777
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2778
|
+
eventTime?: Date | null;
|
|
2776
2779
|
/**
|
|
2777
|
-
*
|
|
2778
|
-
*
|
|
2780
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2781
|
+
* (for example, GDPR).
|
|
2779
2782
|
*/
|
|
2780
|
-
|
|
2783
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2784
|
+
/** If present, indicates the action that triggered the event. */
|
|
2785
|
+
originatedFrom?: string | null;
|
|
2786
|
+
/**
|
|
2787
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
2788
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
2789
|
+
*/
|
|
2790
|
+
entityEventSequence?: string | null;
|
|
2781
2791
|
}
|
|
2782
|
-
|
|
2783
|
-
|
|
2784
|
-
|
|
2785
|
-
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
templateCategories?: Category[];
|
|
2792
|
+
/** @oneof */
|
|
2793
|
+
interface DomainEventBodyOneOf {
|
|
2794
|
+
createdEvent?: EntityCreatedEvent;
|
|
2795
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2796
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2797
|
+
actionEvent?: ActionEvent;
|
|
2789
2798
|
}
|
|
2790
|
-
interface
|
|
2791
|
-
|
|
2792
|
-
|
|
2793
|
-
|
|
2794
|
-
|
|
2795
|
-
|
|
2796
|
-
|
|
2799
|
+
interface EntityCreatedEvent {
|
|
2800
|
+
entity?: string;
|
|
2801
|
+
}
|
|
2802
|
+
interface RestoreInfo {
|
|
2803
|
+
deletedDate?: Date | null;
|
|
2804
|
+
}
|
|
2805
|
+
interface EntityUpdatedEvent {
|
|
2797
2806
|
/**
|
|
2798
|
-
*
|
|
2799
|
-
*
|
|
2807
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2808
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2809
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2800
2810
|
*/
|
|
2801
|
-
|
|
2811
|
+
currentEntity?: string;
|
|
2802
2812
|
}
|
|
2803
|
-
interface
|
|
2813
|
+
interface EntityDeletedEvent {
|
|
2814
|
+
/** Entity that was deleted. */
|
|
2815
|
+
deletedEntity?: string | null;
|
|
2816
|
+
}
|
|
2817
|
+
interface ActionEvent {
|
|
2818
|
+
body?: string;
|
|
2819
|
+
}
|
|
2820
|
+
interface MessageEnvelope {
|
|
2804
2821
|
/**
|
|
2805
|
-
*
|
|
2806
|
-
* @
|
|
2807
|
-
* @maxLength 38
|
|
2822
|
+
* App instance ID.
|
|
2823
|
+
* @format GUID
|
|
2808
2824
|
*/
|
|
2809
|
-
|
|
2825
|
+
instanceId?: string | null;
|
|
2810
2826
|
/**
|
|
2811
|
-
*
|
|
2812
|
-
* @maxLength
|
|
2827
|
+
* Event type.
|
|
2828
|
+
* @maxLength 150
|
|
2813
2829
|
*/
|
|
2814
|
-
|
|
2830
|
+
eventType?: string;
|
|
2831
|
+
/** The identification type and identity data. */
|
|
2832
|
+
identity?: IdentificationData;
|
|
2833
|
+
/** Stringify payload. */
|
|
2834
|
+
data?: string;
|
|
2835
|
+
/** Details related to the account */
|
|
2836
|
+
accountInfo?: AccountInfo;
|
|
2837
|
+
}
|
|
2838
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2815
2839
|
/**
|
|
2816
|
-
*
|
|
2817
|
-
* @
|
|
2840
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2841
|
+
* @format GUID
|
|
2818
2842
|
*/
|
|
2819
|
-
|
|
2843
|
+
anonymousVisitorId?: string;
|
|
2820
2844
|
/**
|
|
2821
|
-
*
|
|
2822
|
-
* @
|
|
2845
|
+
* ID of a site visitor that has logged in to the site.
|
|
2846
|
+
* @format GUID
|
|
2823
2847
|
*/
|
|
2824
|
-
|
|
2848
|
+
memberId?: string;
|
|
2825
2849
|
/**
|
|
2826
|
-
*
|
|
2827
|
-
* @
|
|
2850
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2851
|
+
* @format GUID
|
|
2828
2852
|
*/
|
|
2829
|
-
|
|
2853
|
+
wixUserId?: string;
|
|
2830
2854
|
/**
|
|
2831
|
-
*
|
|
2832
|
-
* @
|
|
2833
|
-
* @deprecated Category title.
|
|
2834
|
-
* @targetRemovalDate 2025-07-16
|
|
2855
|
+
* ID of an app.
|
|
2856
|
+
* @format GUID
|
|
2835
2857
|
*/
|
|
2836
|
-
|
|
2858
|
+
appId?: string;
|
|
2859
|
+
/** @readonly */
|
|
2860
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2861
|
+
}
|
|
2862
|
+
/** @oneof */
|
|
2863
|
+
interface IdentificationDataIdOneOf {
|
|
2837
2864
|
/**
|
|
2838
|
-
*
|
|
2839
|
-
*
|
|
2840
|
-
*
|
|
2841
|
-
* Default: `-1`
|
|
2865
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2866
|
+
* @format GUID
|
|
2842
2867
|
*/
|
|
2843
|
-
|
|
2868
|
+
anonymousVisitorId?: string;
|
|
2844
2869
|
/**
|
|
2845
|
-
* ID of
|
|
2870
|
+
* ID of a site visitor that has logged in to the site.
|
|
2846
2871
|
* @format GUID
|
|
2847
2872
|
*/
|
|
2848
|
-
|
|
2873
|
+
memberId?: string;
|
|
2849
2874
|
/**
|
|
2850
|
-
*
|
|
2851
|
-
*
|
|
2852
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2853
|
-
* @immutable
|
|
2875
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2876
|
+
* @format GUID
|
|
2854
2877
|
*/
|
|
2855
|
-
|
|
2878
|
+
wixUserId?: string;
|
|
2856
2879
|
/**
|
|
2857
|
-
*
|
|
2858
|
-
* @
|
|
2880
|
+
* ID of an app.
|
|
2881
|
+
* @format GUID
|
|
2859
2882
|
*/
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2883
|
+
appId?: string;
|
|
2884
|
+
}
|
|
2885
|
+
declare enum WebhookIdentityType {
|
|
2886
|
+
UNKNOWN = "UNKNOWN",
|
|
2887
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2888
|
+
MEMBER = "MEMBER",
|
|
2889
|
+
WIX_USER = "WIX_USER",
|
|
2890
|
+
APP = "APP"
|
|
2891
|
+
}
|
|
2892
|
+
/** @enumType */
|
|
2893
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2894
|
+
interface AccountInfo {
|
|
2865
2895
|
/**
|
|
2866
|
-
*
|
|
2867
|
-
* @
|
|
2896
|
+
* ID of the Wix account associated with the event.
|
|
2897
|
+
* @format GUID
|
|
2868
2898
|
*/
|
|
2869
|
-
|
|
2870
|
-
}
|
|
2871
|
-
interface CategoryTranslation {
|
|
2899
|
+
accountId?: string | null;
|
|
2872
2900
|
/**
|
|
2873
|
-
*
|
|
2901
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2874
2902
|
* @format GUID
|
|
2875
2903
|
*/
|
|
2876
|
-
|
|
2904
|
+
parentAccountId?: string | null;
|
|
2877
2905
|
/**
|
|
2878
|
-
*
|
|
2879
|
-
* @
|
|
2906
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2907
|
+
* @format GUID
|
|
2880
2908
|
*/
|
|
2881
|
-
|
|
2909
|
+
siteId?: string | null;
|
|
2910
|
+
}
|
|
2911
|
+
/** Get Blog Publications Count Stats request */
|
|
2912
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2913
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2914
|
+
rangeStart?: Date | null;
|
|
2915
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2916
|
+
rangeEnd?: Date | null;
|
|
2917
|
+
/** Order of the returned results. */
|
|
2918
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2919
|
+
/** Number of months to include in the response. */
|
|
2920
|
+
months?: number;
|
|
2882
2921
|
/**
|
|
2883
|
-
* Language
|
|
2922
|
+
* Language filter
|
|
2923
|
+
*
|
|
2924
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2884
2925
|
* @format LANGUAGE_TAG
|
|
2885
2926
|
*/
|
|
2886
2927
|
language?: string | null;
|
|
2887
|
-
/** URL of this category page. */
|
|
2888
|
-
url?: string;
|
|
2889
|
-
}
|
|
2890
|
-
interface GetTemplateRequest {
|
|
2891
2928
|
/**
|
|
2892
|
-
*
|
|
2893
|
-
* @
|
|
2929
|
+
* Timezone of the client.
|
|
2930
|
+
* @minLength 3
|
|
2931
|
+
* @maxLength 100
|
|
2894
2932
|
*/
|
|
2895
|
-
|
|
2933
|
+
timeZone?: string | null;
|
|
2896
2934
|
}
|
|
2897
|
-
|
|
2898
|
-
|
|
2899
|
-
|
|
2935
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2936
|
+
UNKNOWN = "UNKNOWN",
|
|
2937
|
+
OLDEST = "OLDEST",
|
|
2938
|
+
NEWEST = "NEWEST"
|
|
2900
2939
|
}
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2940
|
+
/** @enumType */
|
|
2941
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2942
|
+
/** Get Blog Publications Count Stats response */
|
|
2943
|
+
interface QueryPublicationsCountStatsResponse {
|
|
2944
|
+
/** Chronologically ordered list of publications. */
|
|
2945
|
+
stats?: PeriodPublicationsCount[];
|
|
2907
2946
|
}
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2947
|
+
/** Publications count for a specific time period */
|
|
2948
|
+
interface PeriodPublicationsCount {
|
|
2949
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2950
|
+
periodStart?: Date | null;
|
|
2951
|
+
/** Number of posts published during this month. */
|
|
2952
|
+
publicationsCount?: number;
|
|
2911
2953
|
}
|
|
2912
|
-
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
* @maxLength 38
|
|
2917
|
-
*/
|
|
2918
|
-
_id?: string;
|
|
2919
|
-
/**
|
|
2920
|
-
* Draft post title.
|
|
2921
|
-
* @maxLength 200
|
|
2922
|
-
*/
|
|
2923
|
-
title?: string;
|
|
2954
|
+
/** Get Blog Post Count Stats request */
|
|
2955
|
+
interface QueryPostCountStatsRequest {
|
|
2956
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2957
|
+
rangeStart?: Date | null;
|
|
2924
2958
|
/**
|
|
2925
|
-
*
|
|
2959
|
+
* Order of returned results.
|
|
2926
2960
|
*
|
|
2927
|
-
*
|
|
2928
|
-
*
|
|
2929
|
-
*
|
|
2930
|
-
|
|
2931
|
-
excerpt?: string | null;
|
|
2932
|
-
/** Whether the draft post is marked as featured. */
|
|
2933
|
-
featured?: boolean | null;
|
|
2934
|
-
/**
|
|
2935
|
-
* Category IDs of the draft post.
|
|
2936
|
-
* @maxSize 10
|
|
2937
|
-
* @maxLength 38
|
|
2961
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
2962
|
+
* - `NEWEST`: posts by date in descending order.
|
|
2963
|
+
*
|
|
2964
|
+
* Default: `OLDEST`
|
|
2938
2965
|
*/
|
|
2939
|
-
|
|
2966
|
+
order?: OrderWithLiterals;
|
|
2967
|
+
/** Number of months to include in response. */
|
|
2968
|
+
months?: number;
|
|
2940
2969
|
/**
|
|
2941
|
-
*
|
|
2942
|
-
*
|
|
2970
|
+
* Language filter.
|
|
2971
|
+
*
|
|
2972
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2973
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
2974
|
+
* @format LANGUAGE_TAG
|
|
2943
2975
|
*/
|
|
2944
|
-
|
|
2976
|
+
language?: string | null;
|
|
2945
2977
|
/**
|
|
2946
|
-
*
|
|
2947
|
-
*
|
|
2978
|
+
* Time zone to use when calculating the start of the month.
|
|
2979
|
+
*
|
|
2980
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
2981
|
+
* @minLength 3
|
|
2948
2982
|
* @maxLength 100
|
|
2949
2983
|
*/
|
|
2950
|
-
|
|
2951
|
-
|
|
2952
|
-
|
|
2984
|
+
timeZone?: string | null;
|
|
2985
|
+
}
|
|
2986
|
+
declare enum Order {
|
|
2987
|
+
UNKNOWN = "UNKNOWN",
|
|
2988
|
+
OLDEST = "OLDEST",
|
|
2989
|
+
NEWEST = "NEWEST"
|
|
2990
|
+
}
|
|
2991
|
+
/** @enumType */
|
|
2992
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2993
|
+
/** Get Blog Post Count Stats response */
|
|
2994
|
+
interface QueryPostCountStatsResponse {
|
|
2995
|
+
/** List of published post counts by month. */
|
|
2996
|
+
stats?: PeriodPostCount[];
|
|
2997
|
+
}
|
|
2998
|
+
/** Post count for a specific time period */
|
|
2999
|
+
interface PeriodPostCount {
|
|
3000
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3001
|
+
periodStart?: Date | null;
|
|
3002
|
+
/** Number of posts published during this month. */
|
|
3003
|
+
postCount?: number;
|
|
3004
|
+
}
|
|
3005
|
+
interface GetTotalPublicationsRequest {
|
|
2953
3006
|
/**
|
|
2954
|
-
*
|
|
2955
|
-
* @
|
|
3007
|
+
* Language filter
|
|
3008
|
+
* @minLength 2
|
|
3009
|
+
* @format LANGUAGE_TAG
|
|
2956
3010
|
*/
|
|
2957
|
-
|
|
2958
|
-
|
|
2959
|
-
|
|
3011
|
+
language?: string | null;
|
|
3012
|
+
}
|
|
3013
|
+
interface GetTotalPublicationsResponse {
|
|
3014
|
+
/** Total amount of publications. */
|
|
3015
|
+
total?: number;
|
|
3016
|
+
}
|
|
3017
|
+
interface GetTotalPostsRequest {
|
|
2960
3018
|
/**
|
|
2961
|
-
*
|
|
2962
|
-
*
|
|
2963
|
-
*
|
|
3019
|
+
* Language filter.
|
|
3020
|
+
*
|
|
3021
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3022
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
3023
|
+
* @format LANGUAGE_TAG
|
|
2964
3024
|
*/
|
|
2965
|
-
|
|
3025
|
+
language?: string | null;
|
|
3026
|
+
}
|
|
3027
|
+
interface GetTotalPostsResponse {
|
|
3028
|
+
/** Total amount of published posts. */
|
|
3029
|
+
total?: number;
|
|
3030
|
+
}
|
|
3031
|
+
interface ListTemplatesRequest {
|
|
2966
3032
|
/**
|
|
2967
|
-
*
|
|
2968
|
-
* @maxSize
|
|
2969
|
-
* @
|
|
3033
|
+
* Filter post templates by given template category ids
|
|
3034
|
+
* @maxSize 50
|
|
3035
|
+
* @format GUID
|
|
2970
3036
|
*/
|
|
2971
|
-
|
|
3037
|
+
categoryIds?: string[];
|
|
2972
3038
|
/**
|
|
2973
|
-
*
|
|
2974
|
-
* @
|
|
2975
|
-
* @format GUID
|
|
3039
|
+
* Filter post templates by provided language
|
|
3040
|
+
* @format LANGUAGE_TAG
|
|
2976
3041
|
*/
|
|
2977
|
-
|
|
3042
|
+
language?: string | null;
|
|
3043
|
+
/** Returns post template categories when set to TRUE */
|
|
3044
|
+
listTemplateCategories?: boolean;
|
|
3045
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
3046
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
3047
|
+
/** Pagination options. */
|
|
3048
|
+
paging?: BlogPaging;
|
|
3049
|
+
}
|
|
3050
|
+
declare enum GetPostTemplatesSort {
|
|
3051
|
+
/** Sort by ascending publishing date. */
|
|
3052
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3053
|
+
/** Sort by descending publishing date. */
|
|
3054
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
3055
|
+
}
|
|
3056
|
+
/** @enumType */
|
|
3057
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
3058
|
+
interface BlogPaging {
|
|
2978
3059
|
/**
|
|
2979
|
-
*
|
|
3060
|
+
* Number of items to skip in the current sort order.
|
|
2980
3061
|
*
|
|
2981
|
-
*
|
|
2982
|
-
*
|
|
2983
|
-
* @format GUID
|
|
3062
|
+
*
|
|
3063
|
+
* Default: `0`
|
|
2984
3064
|
*/
|
|
2985
|
-
|
|
3065
|
+
offset?: number;
|
|
2986
3066
|
/**
|
|
2987
|
-
*
|
|
3067
|
+
* Number of items to return.
|
|
2988
3068
|
*
|
|
2989
|
-
*
|
|
2990
|
-
*
|
|
3069
|
+
*
|
|
3070
|
+
* Default:`50`
|
|
3071
|
+
* @min 1
|
|
3072
|
+
* @max 100
|
|
2991
3073
|
*/
|
|
2992
|
-
|
|
3074
|
+
limit?: number;
|
|
2993
3075
|
/**
|
|
2994
|
-
*
|
|
2995
|
-
*
|
|
2996
|
-
* <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">
|
|
2997
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2998
|
-
* </widget>
|
|
3076
|
+
* Pointer to the next or previous page in the list of results.
|
|
3077
|
+
* @maxLength 2000
|
|
2999
3078
|
*/
|
|
3000
|
-
|
|
3079
|
+
cursor?: string | null;
|
|
3080
|
+
}
|
|
3081
|
+
interface ListTemplatesResponse {
|
|
3082
|
+
/** Available post templates */
|
|
3083
|
+
postTemplates?: Post[];
|
|
3084
|
+
/** Details on the paged set of posts templates returned. */
|
|
3085
|
+
postTemplatesMetaData?: MetaData;
|
|
3086
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
3087
|
+
templateCategories?: Category[];
|
|
3088
|
+
}
|
|
3089
|
+
interface MetaData {
|
|
3090
|
+
/** Number of items returned in this response. */
|
|
3091
|
+
count?: number;
|
|
3092
|
+
/** Requested offset. */
|
|
3093
|
+
offset?: number;
|
|
3094
|
+
/** Total number of items that match the query. */
|
|
3095
|
+
total?: number;
|
|
3001
3096
|
/**
|
|
3002
|
-
*
|
|
3003
|
-
* @
|
|
3097
|
+
* Pointer to the next or previous page in the list of results.
|
|
3098
|
+
* @maxLength 2000
|
|
3004
3099
|
*/
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3100
|
+
cursor?: string | null;
|
|
3101
|
+
}
|
|
3102
|
+
interface Category {
|
|
3008
3103
|
/**
|
|
3009
|
-
*
|
|
3010
|
-
* @
|
|
3104
|
+
* Category ID.
|
|
3105
|
+
* @immutable
|
|
3106
|
+
* @maxLength 38
|
|
3011
3107
|
*/
|
|
3012
|
-
|
|
3108
|
+
_id?: string;
|
|
3013
3109
|
/**
|
|
3014
|
-
*
|
|
3015
|
-
* @
|
|
3110
|
+
* Category label. Displayed in the Category Menu.
|
|
3111
|
+
* @maxLength 35
|
|
3016
3112
|
*/
|
|
3017
|
-
|
|
3113
|
+
label?: string;
|
|
3018
3114
|
/**
|
|
3019
|
-
*
|
|
3115
|
+
* Number of posts in the category.
|
|
3020
3116
|
* @readonly
|
|
3021
3117
|
*/
|
|
3022
|
-
|
|
3023
|
-
/** Date the post was first published. */
|
|
3024
|
-
firstPublishedDate?: Date | null;
|
|
3025
|
-
/** SEO data. */
|
|
3026
|
-
seoData?: SeoSchema;
|
|
3118
|
+
postCount?: number;
|
|
3027
3119
|
/**
|
|
3028
|
-
*
|
|
3120
|
+
* The `url` of the page that lists every post with the specified category.
|
|
3029
3121
|
* @readonly
|
|
3030
3122
|
*/
|
|
3031
3123
|
url?: string;
|
|
3032
3124
|
/**
|
|
3033
|
-
*
|
|
3034
|
-
* @
|
|
3125
|
+
* Category description.
|
|
3126
|
+
* @maxLength 500
|
|
3035
3127
|
*/
|
|
3036
|
-
|
|
3128
|
+
description?: string | null;
|
|
3129
|
+
/**
|
|
3130
|
+
* Category title.
|
|
3131
|
+
* @maxLength 200
|
|
3132
|
+
* @deprecated Category title.
|
|
3133
|
+
* @targetRemovalDate 2025-07-16
|
|
3134
|
+
*/
|
|
3135
|
+
title?: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
3138
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
3139
|
+
*
|
|
3140
|
+
* Default: `-1`
|
|
3141
|
+
*/
|
|
3142
|
+
displayPosition?: number | null;
|
|
3143
|
+
/**
|
|
3144
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
3145
|
+
* @format GUID
|
|
3146
|
+
*/
|
|
3147
|
+
translationId?: string | null;
|
|
3148
|
+
/**
|
|
3149
|
+
* Category language.
|
|
3150
|
+
*
|
|
3151
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3152
|
+
* @immutable
|
|
3153
|
+
*/
|
|
3154
|
+
language?: string | null;
|
|
3155
|
+
/**
|
|
3156
|
+
* 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`.
|
|
3157
|
+
* @maxLength 100
|
|
3158
|
+
*/
|
|
3159
|
+
slug?: string;
|
|
3160
|
+
/** SEO data. */
|
|
3161
|
+
seoData?: SeoSchema;
|
|
3162
|
+
/** Category cover image. */
|
|
3163
|
+
coverImage?: string;
|
|
3164
|
+
/**
|
|
3165
|
+
* Date and time the Category was last updated.
|
|
3166
|
+
* @readonly
|
|
3167
|
+
*/
|
|
3168
|
+
_updatedDate?: Date | null;
|
|
3169
|
+
}
|
|
3170
|
+
interface CategoryTranslation {
|
|
3171
|
+
/**
|
|
3172
|
+
* Category ID.
|
|
3173
|
+
* @format GUID
|
|
3174
|
+
*/
|
|
3175
|
+
_id?: string;
|
|
3176
|
+
/**
|
|
3177
|
+
* Label displayed in the categories menu on the site.
|
|
3178
|
+
* @maxLength 100
|
|
3179
|
+
*/
|
|
3180
|
+
label?: string | null;
|
|
3181
|
+
/**
|
|
3182
|
+
* Language of the category.
|
|
3183
|
+
* @format LANGUAGE_TAG
|
|
3184
|
+
*/
|
|
3185
|
+
language?: string | null;
|
|
3186
|
+
/** URL of this category page. */
|
|
3187
|
+
url?: string;
|
|
3188
|
+
}
|
|
3189
|
+
interface GetTemplateRequest {
|
|
3190
|
+
/**
|
|
3191
|
+
* Post template id
|
|
3192
|
+
* @format GUID
|
|
3193
|
+
*/
|
|
3194
|
+
postTemplateId?: string;
|
|
3195
|
+
}
|
|
3196
|
+
interface GetTemplateResponse {
|
|
3197
|
+
/** Post template */
|
|
3198
|
+
postTemplate?: Post;
|
|
3199
|
+
}
|
|
3200
|
+
interface CreateDraftPostFromTemplateRequest {
|
|
3201
|
+
/**
|
|
3202
|
+
* Post template id
|
|
3203
|
+
* @format GUID
|
|
3204
|
+
*/
|
|
3205
|
+
postTemplateId?: string;
|
|
3206
|
+
}
|
|
3207
|
+
interface CreateDraftPostFromTemplateResponse {
|
|
3208
|
+
/** Created draft post */
|
|
3209
|
+
draftPost?: DraftPost;
|
|
3210
|
+
}
|
|
3211
|
+
interface DraftPost {
|
|
3212
|
+
/**
|
|
3213
|
+
* Draft post ID.
|
|
3214
|
+
* @readonly
|
|
3215
|
+
* @maxLength 38
|
|
3216
|
+
*/
|
|
3217
|
+
_id?: string;
|
|
3218
|
+
/**
|
|
3219
|
+
* Draft post title.
|
|
3220
|
+
* @maxLength 200
|
|
3221
|
+
*/
|
|
3222
|
+
title?: string;
|
|
3223
|
+
/**
|
|
3224
|
+
* Draft post excerpt.
|
|
3225
|
+
*
|
|
3226
|
+
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
3227
|
+
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
3228
|
+
* @maxLength 500
|
|
3229
|
+
*/
|
|
3230
|
+
excerpt?: string | null;
|
|
3231
|
+
/** Whether the draft post is marked as featured. */
|
|
3232
|
+
featured?: boolean | null;
|
|
3233
|
+
/**
|
|
3234
|
+
* Category IDs of the draft post.
|
|
3235
|
+
* @maxSize 10
|
|
3236
|
+
* @maxLength 38
|
|
3237
|
+
*/
|
|
3238
|
+
categoryIds?: string[];
|
|
3239
|
+
/**
|
|
3240
|
+
* Draft post owner's member ID.
|
|
3241
|
+
* @format GUID
|
|
3242
|
+
*/
|
|
3243
|
+
memberId?: string | null;
|
|
3244
|
+
/**
|
|
3245
|
+
* Hashtags in the post.
|
|
3246
|
+
* @maxSize 100
|
|
3247
|
+
* @maxLength 100
|
|
3248
|
+
*/
|
|
3249
|
+
hashtags?: string[];
|
|
3250
|
+
/** Whether commenting on the draft post is enabled. */
|
|
3251
|
+
commentingEnabled?: boolean | null;
|
|
3252
|
+
/**
|
|
3253
|
+
* Estimated reading time of the draft post (calculated automatically).
|
|
3254
|
+
* @readonly
|
|
3255
|
+
*/
|
|
3256
|
+
minutesToRead?: number;
|
|
3257
|
+
/** Image placed at the top of the blog page. */
|
|
3258
|
+
heroImage?: string;
|
|
3259
|
+
/**
|
|
3260
|
+
* Tag IDs the draft post is tagged with.
|
|
3261
|
+
* @maxSize 30
|
|
3262
|
+
* @maxLength 38
|
|
3263
|
+
*/
|
|
3264
|
+
tagIds?: string[];
|
|
3265
|
+
/**
|
|
3266
|
+
* IDs of posts related to this draft post.
|
|
3267
|
+
* @maxSize 3
|
|
3268
|
+
* @maxLength 38
|
|
3269
|
+
*/
|
|
3270
|
+
relatedPostIds?: string[];
|
|
3271
|
+
/**
|
|
3272
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
3273
|
+
* @maxSize 100
|
|
3274
|
+
* @format GUID
|
|
3275
|
+
*/
|
|
3276
|
+
pricingPlanIds?: string[];
|
|
3277
|
+
/**
|
|
3278
|
+
* ID of the draft post's translations.
|
|
3279
|
+
*
|
|
3280
|
+
* All translations of a single post share the same `translationId`.
|
|
3281
|
+
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
3282
|
+
* @format GUID
|
|
3283
|
+
*/
|
|
3284
|
+
translationId?: string | null;
|
|
3285
|
+
/**
|
|
3286
|
+
* Language the draft post is written in.
|
|
3287
|
+
*
|
|
3288
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3289
|
+
* @format LANGUAGE_TAG
|
|
3290
|
+
*/
|
|
3291
|
+
language?: string | null;
|
|
3292
|
+
/**
|
|
3293
|
+
* Draft Post rich content.
|
|
3294
|
+
*
|
|
3295
|
+
* <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">
|
|
3296
|
+
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
3297
|
+
* </widget>
|
|
3298
|
+
*/
|
|
3299
|
+
richContent?: RichContent;
|
|
3300
|
+
/**
|
|
3301
|
+
* Status of the draft post.
|
|
3302
|
+
* @readonly
|
|
3303
|
+
*/
|
|
3304
|
+
status?: StatusWithLiterals;
|
|
3305
|
+
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
3306
|
+
moderationDetails?: ModerationDetails;
|
|
3307
|
+
/**
|
|
3308
|
+
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
3309
|
+
* @readonly
|
|
3310
|
+
*/
|
|
3311
|
+
hasUnpublishedChanges?: boolean;
|
|
3312
|
+
/**
|
|
3313
|
+
* Date the draft post was last edited.
|
|
3314
|
+
* @readonly
|
|
3315
|
+
*/
|
|
3316
|
+
editedDate?: Date | null;
|
|
3317
|
+
/**
|
|
3318
|
+
* Date the draft post is scheduled to be published.
|
|
3319
|
+
* @readonly
|
|
3320
|
+
*/
|
|
3321
|
+
scheduledPublishDate?: Date | null;
|
|
3322
|
+
/** Date the post was first published. */
|
|
3323
|
+
firstPublishedDate?: Date | null;
|
|
3324
|
+
/** SEO data. */
|
|
3325
|
+
seoData?: SeoSchema;
|
|
3326
|
+
/**
|
|
3327
|
+
* Draft post URL preview. What the URL will look like once the post is published.
|
|
3328
|
+
* @readonly
|
|
3329
|
+
*/
|
|
3330
|
+
url?: string;
|
|
3331
|
+
/**
|
|
3332
|
+
* Date the draft post was first created.
|
|
3333
|
+
* @readonly
|
|
3334
|
+
*/
|
|
3335
|
+
_createdDate?: Date | null;
|
|
3037
3336
|
/**
|
|
3038
3337
|
* SEO slug.
|
|
3039
3338
|
* @maxLength 100
|
|
@@ -3157,289 +3456,157 @@ interface DraftPostTranslation {
|
|
|
3157
3456
|
/** Post URL. */
|
|
3158
3457
|
url?: string;
|
|
3159
3458
|
}
|
|
3160
|
-
interface
|
|
3161
|
-
createdEvent?: EntityCreatedEvent;
|
|
3162
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3163
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3164
|
-
actionEvent?: ActionEvent;
|
|
3165
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3166
|
-
_id?: string;
|
|
3167
|
-
/**
|
|
3168
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3169
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3170
|
-
*/
|
|
3171
|
-
entityFqdn?: string;
|
|
3172
|
-
/**
|
|
3173
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3174
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3175
|
-
*/
|
|
3176
|
-
slug?: string;
|
|
3177
|
-
/** ID of the entity associated with the event. */
|
|
3178
|
-
entityId?: string;
|
|
3179
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3180
|
-
eventTime?: Date | null;
|
|
3181
|
-
/**
|
|
3182
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3183
|
-
* (for example, GDPR).
|
|
3184
|
-
*/
|
|
3185
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3186
|
-
/** If present, indicates the action that triggered the event. */
|
|
3187
|
-
originatedFrom?: string | null;
|
|
3188
|
-
/**
|
|
3189
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3190
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3191
|
-
*/
|
|
3192
|
-
entityEventSequence?: string | null;
|
|
3193
|
-
}
|
|
3194
|
-
/** @oneof */
|
|
3195
|
-
interface DomainEventBodyOneOf {
|
|
3196
|
-
createdEvent?: EntityCreatedEvent;
|
|
3197
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3198
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3199
|
-
actionEvent?: ActionEvent;
|
|
3200
|
-
}
|
|
3201
|
-
interface EntityCreatedEvent {
|
|
3202
|
-
entity?: string;
|
|
3203
|
-
}
|
|
3204
|
-
interface RestoreInfo {
|
|
3205
|
-
deletedDate?: Date | null;
|
|
3206
|
-
}
|
|
3207
|
-
interface EntityUpdatedEvent {
|
|
3208
|
-
/**
|
|
3209
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3210
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3211
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3212
|
-
*/
|
|
3213
|
-
currentEntity?: string;
|
|
3214
|
-
}
|
|
3215
|
-
interface EntityDeletedEvent {
|
|
3216
|
-
/** Entity that was deleted. */
|
|
3217
|
-
deletedEntity?: string | null;
|
|
3218
|
-
}
|
|
3219
|
-
interface ActionEvent {
|
|
3220
|
-
body?: string;
|
|
3221
|
-
}
|
|
3222
|
-
interface MessageEnvelope {
|
|
3223
|
-
/**
|
|
3224
|
-
* App instance ID.
|
|
3225
|
-
* @format GUID
|
|
3226
|
-
*/
|
|
3227
|
-
instanceId?: string | null;
|
|
3228
|
-
/**
|
|
3229
|
-
* Event type.
|
|
3230
|
-
* @maxLength 150
|
|
3231
|
-
*/
|
|
3232
|
-
eventType?: string;
|
|
3233
|
-
/** The identification type and identity data. */
|
|
3234
|
-
identity?: IdentificationData;
|
|
3235
|
-
/** Stringify payload. */
|
|
3236
|
-
data?: string;
|
|
3237
|
-
/** Details related to the account */
|
|
3238
|
-
accountInfo?: AccountInfo;
|
|
3239
|
-
}
|
|
3240
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3241
|
-
/**
|
|
3242
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3243
|
-
* @format GUID
|
|
3244
|
-
*/
|
|
3245
|
-
anonymousVisitorId?: string;
|
|
3246
|
-
/**
|
|
3247
|
-
* ID of a site visitor that has logged in to the site.
|
|
3248
|
-
* @format GUID
|
|
3249
|
-
*/
|
|
3250
|
-
memberId?: string;
|
|
3251
|
-
/**
|
|
3252
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3253
|
-
* @format GUID
|
|
3254
|
-
*/
|
|
3255
|
-
wixUserId?: string;
|
|
3256
|
-
/**
|
|
3257
|
-
* ID of an app.
|
|
3258
|
-
* @format GUID
|
|
3259
|
-
*/
|
|
3260
|
-
appId?: string;
|
|
3261
|
-
/** @readonly */
|
|
3262
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3263
|
-
}
|
|
3264
|
-
/** @oneof */
|
|
3265
|
-
interface IdentificationDataIdOneOf {
|
|
3266
|
-
/**
|
|
3267
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3268
|
-
* @format GUID
|
|
3269
|
-
*/
|
|
3270
|
-
anonymousVisitorId?: string;
|
|
3271
|
-
/**
|
|
3272
|
-
* ID of a site visitor that has logged in to the site.
|
|
3273
|
-
* @format GUID
|
|
3274
|
-
*/
|
|
3275
|
-
memberId?: string;
|
|
3276
|
-
/**
|
|
3277
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3278
|
-
* @format GUID
|
|
3279
|
-
*/
|
|
3280
|
-
wixUserId?: string;
|
|
3281
|
-
/**
|
|
3282
|
-
* ID of an app.
|
|
3283
|
-
* @format GUID
|
|
3284
|
-
*/
|
|
3285
|
-
appId?: string;
|
|
3286
|
-
}
|
|
3287
|
-
declare enum WebhookIdentityType {
|
|
3288
|
-
UNKNOWN = "UNKNOWN",
|
|
3289
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3290
|
-
MEMBER = "MEMBER",
|
|
3291
|
-
WIX_USER = "WIX_USER",
|
|
3292
|
-
APP = "APP"
|
|
3293
|
-
}
|
|
3294
|
-
/** @enumType */
|
|
3295
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3296
|
-
interface AccountInfo {
|
|
3297
|
-
/**
|
|
3298
|
-
* ID of the Wix account associated with the event.
|
|
3299
|
-
* @format GUID
|
|
3300
|
-
*/
|
|
3301
|
-
accountId?: string | null;
|
|
3302
|
-
/**
|
|
3303
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3304
|
-
* @format GUID
|
|
3305
|
-
*/
|
|
3306
|
-
parentAccountId?: string | null;
|
|
3307
|
-
/**
|
|
3308
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3309
|
-
* @format GUID
|
|
3310
|
-
*/
|
|
3311
|
-
siteId?: string | null;
|
|
3312
|
-
}
|
|
3313
|
-
/** Get Blog Publications Count Stats request */
|
|
3314
|
-
interface QueryPublicationsCountStatsRequest {
|
|
3315
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3316
|
-
rangeStart?: Date | null;
|
|
3317
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3318
|
-
rangeEnd?: Date | null;
|
|
3319
|
-
/** Order of the returned results. */
|
|
3320
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
3321
|
-
/** Number of months to include in the response. */
|
|
3322
|
-
months?: number;
|
|
3459
|
+
interface ListDemoPostsRequest {
|
|
3323
3460
|
/**
|
|
3324
|
-
*
|
|
3461
|
+
* Whether to return only featured posts.
|
|
3325
3462
|
*
|
|
3326
|
-
*
|
|
3327
|
-
* @format LANGUAGE_TAG
|
|
3463
|
+
* Default: `false`
|
|
3328
3464
|
*/
|
|
3329
|
-
|
|
3465
|
+
featured?: boolean;
|
|
3330
3466
|
/**
|
|
3331
|
-
*
|
|
3332
|
-
*
|
|
3467
|
+
* Hashtag filter.
|
|
3468
|
+
*
|
|
3469
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3470
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3471
|
+
* @maxSize 100
|
|
3333
3472
|
* @maxLength 100
|
|
3334
3473
|
*/
|
|
3335
|
-
|
|
3336
|
-
}
|
|
3337
|
-
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3338
|
-
UNKNOWN = "UNKNOWN",
|
|
3339
|
-
OLDEST = "OLDEST",
|
|
3340
|
-
NEWEST = "NEWEST"
|
|
3341
|
-
}
|
|
3342
|
-
/** @enumType */
|
|
3343
|
-
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3344
|
-
/** Get Blog Publications Count Stats response */
|
|
3345
|
-
interface QueryPublicationsCountStatsResponse {
|
|
3346
|
-
/** Chronologically ordered list of publications. */
|
|
3347
|
-
stats?: PeriodPublicationsCount[];
|
|
3348
|
-
}
|
|
3349
|
-
/** Publications count for a specific time period */
|
|
3350
|
-
interface PeriodPublicationsCount {
|
|
3351
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3352
|
-
periodStart?: Date | null;
|
|
3353
|
-
/** Number of posts published during this month. */
|
|
3354
|
-
publicationsCount?: number;
|
|
3355
|
-
}
|
|
3356
|
-
/** Get Blog Post Count Stats request */
|
|
3357
|
-
interface QueryPostCountStatsRequest {
|
|
3358
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3359
|
-
rangeStart?: Date | null;
|
|
3474
|
+
hashtags?: string[];
|
|
3360
3475
|
/**
|
|
3361
|
-
*
|
|
3362
|
-
*
|
|
3363
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
3364
|
-
* - `NEWEST`: posts by date in descending order.
|
|
3476
|
+
* Category filter.
|
|
3365
3477
|
*
|
|
3366
|
-
*
|
|
3478
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3479
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3480
|
+
* @maxSize 50
|
|
3481
|
+
* @format GUID
|
|
3367
3482
|
*/
|
|
3368
|
-
|
|
3369
|
-
/** Number of months to include in response. */
|
|
3370
|
-
months?: number;
|
|
3483
|
+
categoryIds?: string[];
|
|
3371
3484
|
/**
|
|
3372
|
-
*
|
|
3485
|
+
* Tag filter.
|
|
3373
3486
|
*
|
|
3374
|
-
*
|
|
3375
|
-
*
|
|
3376
|
-
* @
|
|
3487
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3488
|
+
* If omitted, all posts with or without tags are returned.
|
|
3489
|
+
* @maxSize 50
|
|
3490
|
+
* @format GUID
|
|
3377
3491
|
*/
|
|
3378
|
-
|
|
3492
|
+
tagIds?: string[];
|
|
3379
3493
|
/**
|
|
3380
|
-
*
|
|
3494
|
+
* Sorting options.
|
|
3381
3495
|
*
|
|
3382
|
-
*
|
|
3383
|
-
*
|
|
3384
|
-
*
|
|
3496
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3497
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3498
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3499
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3500
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3501
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3502
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3503
|
+
* - `RATING`: reserved for internal use.
|
|
3504
|
+
*
|
|
3505
|
+
* Default: `FEED`
|
|
3385
3506
|
*/
|
|
3386
|
-
|
|
3387
|
-
|
|
3388
|
-
|
|
3389
|
-
UNKNOWN = "UNKNOWN",
|
|
3390
|
-
OLDEST = "OLDEST",
|
|
3391
|
-
NEWEST = "NEWEST"
|
|
3392
|
-
}
|
|
3393
|
-
/** @enumType */
|
|
3394
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3395
|
-
/** Get Blog Post Count Stats response */
|
|
3396
|
-
interface QueryPostCountStatsResponse {
|
|
3397
|
-
/** List of published post counts by month. */
|
|
3398
|
-
stats?: PeriodPostCount[];
|
|
3399
|
-
}
|
|
3400
|
-
/** Post count for a specific time period */
|
|
3401
|
-
interface PeriodPostCount {
|
|
3402
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3403
|
-
periodStart?: Date | null;
|
|
3404
|
-
/** Number of posts published during this month. */
|
|
3405
|
-
postCount?: number;
|
|
3406
|
-
}
|
|
3407
|
-
interface GetTotalPublicationsRequest {
|
|
3507
|
+
sort?: GetPostsSortWithLiterals;
|
|
3508
|
+
/** Pagination options. */
|
|
3509
|
+
paging?: BlogPaging;
|
|
3408
3510
|
/**
|
|
3409
|
-
*
|
|
3410
|
-
*
|
|
3411
|
-
*
|
|
3511
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
3512
|
+
* This parameter will be removed on June 30, 2023.
|
|
3513
|
+
*
|
|
3514
|
+
* List of post fields to be included in the response.
|
|
3515
|
+
* @maxSize 20
|
|
3516
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3517
|
+
* This parameter will be removed on June 30, 2023.
|
|
3518
|
+
*
|
|
3519
|
+
* List of post fields to be included in the response.
|
|
3520
|
+
* @replacedBy fieldsets
|
|
3521
|
+
* @targetRemovalDate 2024-06-30
|
|
3412
3522
|
*/
|
|
3413
|
-
|
|
3414
|
-
}
|
|
3415
|
-
interface GetTotalPublicationsResponse {
|
|
3416
|
-
/** Total amount of publications. */
|
|
3417
|
-
total?: number;
|
|
3418
|
-
}
|
|
3419
|
-
interface GetTotalPostsRequest {
|
|
3523
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3420
3524
|
/**
|
|
3421
3525
|
* Language filter.
|
|
3422
3526
|
*
|
|
3423
3527
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3424
|
-
* Pass a language to receive
|
|
3528
|
+
* Pass a language to only receive posts that are in that language.
|
|
3529
|
+
* If omitted, posts in all languages are returned.
|
|
3425
3530
|
* @format LANGUAGE_TAG
|
|
3426
3531
|
*/
|
|
3427
3532
|
language?: string | null;
|
|
3533
|
+
/**
|
|
3534
|
+
* Post owner's member ID.
|
|
3535
|
+
* @format GUID
|
|
3536
|
+
*/
|
|
3537
|
+
memberId?: string | null;
|
|
3538
|
+
/**
|
|
3539
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3540
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3541
|
+
* only the post’s base fields are returned.
|
|
3542
|
+
* @maxSize 20
|
|
3543
|
+
*/
|
|
3544
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3428
3545
|
}
|
|
3429
|
-
|
|
3430
|
-
/**
|
|
3431
|
-
|
|
3546
|
+
declare enum GetPostsSort {
|
|
3547
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3548
|
+
FEED = "FEED",
|
|
3549
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3550
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3551
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3552
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3553
|
+
/** Ordered by total number of views in descending order. */
|
|
3554
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3555
|
+
/** Ordered by total number of likes in descending order. */
|
|
3556
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3557
|
+
/** Ordered by `title` in ascending order. */
|
|
3558
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3559
|
+
/** Ordered by `title` in descending order. */
|
|
3560
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3432
3561
|
}
|
|
3433
|
-
|
|
3562
|
+
/** @enumType */
|
|
3563
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3564
|
+
declare enum PostFieldField {
|
|
3565
|
+
UNKNOWN = "UNKNOWN",
|
|
3566
|
+
/** Includes post URL when present. */
|
|
3567
|
+
URL = "URL",
|
|
3568
|
+
/** Includes post content text string when present. */
|
|
3569
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3570
|
+
/** Includes post metrics when present. */
|
|
3571
|
+
METRICS = "METRICS",
|
|
3572
|
+
/** Includes SEO data. */
|
|
3573
|
+
SEO = "SEO",
|
|
3574
|
+
/** Includes post owner's contact ID. */
|
|
3575
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3576
|
+
/** Includes post rich content. */
|
|
3577
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3578
|
+
/** Includes post reference ID field. */
|
|
3579
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3580
|
+
}
|
|
3581
|
+
/** @enumType */
|
|
3582
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3583
|
+
interface ListDemoPostsResponse {
|
|
3584
|
+
/** List of posts. */
|
|
3585
|
+
posts?: Post[];
|
|
3586
|
+
/** Details on the paged set of results returned. */
|
|
3587
|
+
metaData?: MetaData;
|
|
3588
|
+
}
|
|
3589
|
+
interface ConvertDraftJsToRichContentRequest {
|
|
3590
|
+
/** DraftJs content to convert to Rich content. */
|
|
3591
|
+
content?: Record<string, any> | null;
|
|
3592
|
+
}
|
|
3593
|
+
interface ConvertDraftJsToRichContentResponse {
|
|
3434
3594
|
/**
|
|
3435
|
-
*
|
|
3436
|
-
* @
|
|
3595
|
+
* Rich content converted from DraftJs content.
|
|
3596
|
+
* @maxLength 2000000
|
|
3437
3597
|
*/
|
|
3438
|
-
|
|
3598
|
+
richContent?: string;
|
|
3439
3599
|
}
|
|
3440
|
-
interface
|
|
3441
|
-
/**
|
|
3442
|
-
|
|
3600
|
+
interface ConvertRichContentToDraftJsRequest {
|
|
3601
|
+
/**
|
|
3602
|
+
* Rich content to convert to DraftJs content.
|
|
3603
|
+
* @maxLength 2000000
|
|
3604
|
+
*/
|
|
3605
|
+
richContent?: string;
|
|
3606
|
+
}
|
|
3607
|
+
interface ConvertRichContentToDraftJsResponse {
|
|
3608
|
+
/** DraftJs content converted from Rich content. */
|
|
3609
|
+
content?: Record<string, any> | null;
|
|
3443
3610
|
}
|
|
3444
3611
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3445
3612
|
/**
|
|
@@ -3510,25 +3677,6 @@ interface GetPostRequest {
|
|
|
3510
3677
|
*/
|
|
3511
3678
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3512
3679
|
}
|
|
3513
|
-
declare enum PostFieldField {
|
|
3514
|
-
UNKNOWN = "UNKNOWN",
|
|
3515
|
-
/** Includes post URL when present. */
|
|
3516
|
-
URL = "URL",
|
|
3517
|
-
/** Includes post content text string when present. */
|
|
3518
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3519
|
-
/** Includes post metrics when present. */
|
|
3520
|
-
METRICS = "METRICS",
|
|
3521
|
-
/** Includes SEO data. */
|
|
3522
|
-
SEO = "SEO",
|
|
3523
|
-
/** Includes post owner's contact ID. */
|
|
3524
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3525
|
-
/** Includes post rich content. */
|
|
3526
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3527
|
-
/** Includes post reference ID field. */
|
|
3528
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3529
|
-
}
|
|
3530
|
-
/** @enumType */
|
|
3531
|
-
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3532
3680
|
interface GetPostResponse {
|
|
3533
3681
|
/** Retrieved post info. */
|
|
3534
3682
|
post?: Post;
|
|
@@ -3621,24 +3769,6 @@ interface ListPostsRequest {
|
|
|
3621
3769
|
*/
|
|
3622
3770
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3623
3771
|
}
|
|
3624
|
-
declare enum GetPostsSort {
|
|
3625
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3626
|
-
FEED = "FEED",
|
|
3627
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3628
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3629
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3630
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3631
|
-
/** Ordered by total number of views in descending order. */
|
|
3632
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3633
|
-
/** Ordered by total number of likes in descending order. */
|
|
3634
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3635
|
-
/** Ordered by `title` in ascending order. */
|
|
3636
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3637
|
-
/** Ordered by `title` in descending order. */
|
|
3638
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3639
|
-
}
|
|
3640
|
-
/** @enumType */
|
|
3641
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3642
3772
|
interface ListPostsResponse {
|
|
3643
3773
|
/** List of retrieved posts. */
|
|
3644
3774
|
posts?: Post[];
|
|
@@ -3988,121 +4118,6 @@ interface PostCount {
|
|
|
3988
4118
|
/** Number of posts. */
|
|
3989
4119
|
postCount?: number;
|
|
3990
4120
|
}
|
|
3991
|
-
interface ListDemoPostsRequest {
|
|
3992
|
-
/**
|
|
3993
|
-
* Whether to return only featured posts.
|
|
3994
|
-
*
|
|
3995
|
-
* Default: `false`
|
|
3996
|
-
*/
|
|
3997
|
-
featured?: boolean;
|
|
3998
|
-
/**
|
|
3999
|
-
* Hashtag filter.
|
|
4000
|
-
*
|
|
4001
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4002
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
4003
|
-
* @maxSize 100
|
|
4004
|
-
* @maxLength 100
|
|
4005
|
-
*/
|
|
4006
|
-
hashtags?: string[];
|
|
4007
|
-
/**
|
|
4008
|
-
* Category filter.
|
|
4009
|
-
*
|
|
4010
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4011
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
4012
|
-
* @maxSize 50
|
|
4013
|
-
* @format GUID
|
|
4014
|
-
*/
|
|
4015
|
-
categoryIds?: string[];
|
|
4016
|
-
/**
|
|
4017
|
-
* Tag filter.
|
|
4018
|
-
*
|
|
4019
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4020
|
-
* If omitted, all posts with or without tags are returned.
|
|
4021
|
-
* @maxSize 50
|
|
4022
|
-
* @format GUID
|
|
4023
|
-
*/
|
|
4024
|
-
tagIds?: string[];
|
|
4025
|
-
/**
|
|
4026
|
-
* Sorting options.
|
|
4027
|
-
*
|
|
4028
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4029
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4030
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4031
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4032
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4033
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4034
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4035
|
-
* - `RATING`: reserved for internal use.
|
|
4036
|
-
*
|
|
4037
|
-
* Default: `FEED`
|
|
4038
|
-
*/
|
|
4039
|
-
sort?: GetPostsSortWithLiterals;
|
|
4040
|
-
/** Pagination options. */
|
|
4041
|
-
paging?: BlogPaging;
|
|
4042
|
-
/**
|
|
4043
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
4044
|
-
* This parameter will be removed on June 30, 2023.
|
|
4045
|
-
*
|
|
4046
|
-
* List of post fields to be included in the response.
|
|
4047
|
-
* @maxSize 20
|
|
4048
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4049
|
-
* This parameter will be removed on June 30, 2023.
|
|
4050
|
-
*
|
|
4051
|
-
* List of post fields to be included in the response.
|
|
4052
|
-
* @replacedBy fieldsets
|
|
4053
|
-
* @targetRemovalDate 2024-06-30
|
|
4054
|
-
*/
|
|
4055
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4056
|
-
/**
|
|
4057
|
-
* Language filter.
|
|
4058
|
-
*
|
|
4059
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4060
|
-
* Pass a language to only receive posts that are in that language.
|
|
4061
|
-
* If omitted, posts in all languages are returned.
|
|
4062
|
-
* @format LANGUAGE_TAG
|
|
4063
|
-
*/
|
|
4064
|
-
language?: string | null;
|
|
4065
|
-
/**
|
|
4066
|
-
* Post owner's member ID.
|
|
4067
|
-
* @format GUID
|
|
4068
|
-
*/
|
|
4069
|
-
memberId?: string | null;
|
|
4070
|
-
/**
|
|
4071
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4072
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4073
|
-
* only the post’s base fields are returned.
|
|
4074
|
-
* @maxSize 20
|
|
4075
|
-
*/
|
|
4076
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4077
|
-
}
|
|
4078
|
-
interface ListDemoPostsResponse {
|
|
4079
|
-
/** List of posts. */
|
|
4080
|
-
posts?: Post[];
|
|
4081
|
-
/** Details on the paged set of results returned. */
|
|
4082
|
-
metaData?: MetaData;
|
|
4083
|
-
}
|
|
4084
|
-
interface ConvertDraftJsToRichContentRequest {
|
|
4085
|
-
/** DraftJs content to convert to Rich content. */
|
|
4086
|
-
content?: Record<string, any> | null;
|
|
4087
|
-
}
|
|
4088
|
-
interface ConvertDraftJsToRichContentResponse {
|
|
4089
|
-
/**
|
|
4090
|
-
* Rich content converted from DraftJs content.
|
|
4091
|
-
* @maxLength 2000000
|
|
4092
|
-
*/
|
|
4093
|
-
richContent?: string;
|
|
4094
|
-
}
|
|
4095
|
-
interface ConvertRichContentToDraftJsRequest {
|
|
4096
|
-
/**
|
|
4097
|
-
* Rich content to convert to DraftJs content.
|
|
4098
|
-
* @maxLength 2000000
|
|
4099
|
-
*/
|
|
4100
|
-
richContent?: string;
|
|
4101
|
-
}
|
|
4102
|
-
interface ConvertRichContentToDraftJsResponse {
|
|
4103
|
-
/** DraftJs content converted from Rich content. */
|
|
4104
|
-
content?: Record<string, any> | null;
|
|
4105
|
-
}
|
|
4106
4121
|
interface BaseEventMetadata {
|
|
4107
4122
|
/**
|
|
4108
4123
|
* App instance ID.
|