@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
|
@@ -537,7 +537,7 @@ type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
|
|
|
537
537
|
interface Stop {
|
|
538
538
|
/**
|
|
539
539
|
* Stop color as hex value.
|
|
540
|
-
* @
|
|
540
|
+
* @maxLength 19
|
|
541
541
|
*/
|
|
542
542
|
color?: string | null;
|
|
543
543
|
/** Stop position (0-1). */
|
|
@@ -578,7 +578,7 @@ interface Background {
|
|
|
578
578
|
type?: BackgroundTypeWithLiterals;
|
|
579
579
|
/**
|
|
580
580
|
* Background color as a hexadecimal value.
|
|
581
|
-
* @
|
|
581
|
+
* @maxLength 19
|
|
582
582
|
*/
|
|
583
583
|
color?: string | null;
|
|
584
584
|
/** Gradient configuration. */
|
|
@@ -685,33 +685,33 @@ interface Styles {
|
|
|
685
685
|
borderRadius?: number | null;
|
|
686
686
|
/**
|
|
687
687
|
* Border color as a hexadecimal value.
|
|
688
|
-
* @
|
|
688
|
+
* @maxLength 19
|
|
689
689
|
*/
|
|
690
690
|
borderColor?: string | null;
|
|
691
691
|
/**
|
|
692
692
|
* Border color as a hexadecimal value (hover state).
|
|
693
|
-
* @
|
|
693
|
+
* @maxLength 19
|
|
694
694
|
*/
|
|
695
695
|
borderColorHover?: string | null;
|
|
696
696
|
/**
|
|
697
697
|
* Text color as a hexadecimal value.
|
|
698
|
-
* @
|
|
698
|
+
* @maxLength 19
|
|
699
699
|
*/
|
|
700
700
|
textColor?: string | null;
|
|
701
701
|
/**
|
|
702
702
|
* Text color as a hexadecimal value (hover state).
|
|
703
|
-
* @
|
|
703
|
+
* @maxLength 19
|
|
704
704
|
*/
|
|
705
705
|
textColorHover?: string | null;
|
|
706
706
|
/**
|
|
707
707
|
* Deprecated: Use `background` instead.
|
|
708
|
-
* @
|
|
708
|
+
* @maxLength 19
|
|
709
709
|
* @deprecated
|
|
710
710
|
*/
|
|
711
711
|
backgroundColor?: string | null;
|
|
712
712
|
/**
|
|
713
713
|
* Deprecated: Use `backgroundHover` instead.
|
|
714
|
-
* @
|
|
714
|
+
* @maxLength 19
|
|
715
715
|
* @deprecated
|
|
716
716
|
*/
|
|
717
717
|
backgroundColorHover?: string | null;
|
|
@@ -1163,7 +1163,7 @@ interface StylesBorder {
|
|
|
1163
1163
|
width?: number | null;
|
|
1164
1164
|
/**
|
|
1165
1165
|
* Border color as a hexadecimal value.
|
|
1166
|
-
* @
|
|
1166
|
+
* @maxLength 19
|
|
1167
1167
|
*/
|
|
1168
1168
|
color?: string | null;
|
|
1169
1169
|
/** Border radius in pixels. */
|
|
@@ -1204,22 +1204,22 @@ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HI
|
|
|
1204
1204
|
interface LinkPreviewDataStyles {
|
|
1205
1205
|
/**
|
|
1206
1206
|
* Background color as a hexadecimal value.
|
|
1207
|
-
* @
|
|
1207
|
+
* @maxLength 19
|
|
1208
1208
|
*/
|
|
1209
1209
|
backgroundColor?: string | null;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* Title color as a hexadecimal value.
|
|
1212
|
-
* @
|
|
1212
|
+
* @maxLength 19
|
|
1213
1213
|
*/
|
|
1214
1214
|
titleColor?: string | null;
|
|
1215
1215
|
/**
|
|
1216
1216
|
* Subtitle color as a hexadecimal value.
|
|
1217
|
-
* @
|
|
1217
|
+
* @maxLength 19
|
|
1218
1218
|
*/
|
|
1219
1219
|
subtitleColor?: string | null;
|
|
1220
1220
|
/**
|
|
1221
1221
|
* Link color as a hexadecimal value.
|
|
1222
|
-
* @
|
|
1222
|
+
* @maxLength 19
|
|
1223
1223
|
*/
|
|
1224
1224
|
linkColor?: string | null;
|
|
1225
1225
|
/** Border width in pixels. */
|
|
@@ -1228,7 +1228,7 @@ interface LinkPreviewDataStyles {
|
|
|
1228
1228
|
borderRadius?: number | null;
|
|
1229
1229
|
/**
|
|
1230
1230
|
* Border color as a hexadecimal value.
|
|
1231
|
-
* @
|
|
1231
|
+
* @maxLength 19
|
|
1232
1232
|
*/
|
|
1233
1233
|
borderColor?: string | null;
|
|
1234
1234
|
/** Position of thumbnail. Defaults to `START`. */
|
|
@@ -1379,19 +1379,19 @@ interface BackgroundGradient {
|
|
|
1379
1379
|
angle?: number | null;
|
|
1380
1380
|
/**
|
|
1381
1381
|
* The start color as a hexademical value.
|
|
1382
|
-
* @
|
|
1382
|
+
* @maxLength 19
|
|
1383
1383
|
*/
|
|
1384
1384
|
startColor?: string | null;
|
|
1385
1385
|
/**
|
|
1386
1386
|
* The end color as a hexademical value.
|
|
1387
|
-
* @
|
|
1387
|
+
* @maxLength 19
|
|
1388
1388
|
*/
|
|
1389
1389
|
lastColor?: string | null;
|
|
1390
1390
|
}
|
|
1391
1391
|
interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
|
|
1392
1392
|
/**
|
|
1393
1393
|
* The background color as a hexademical value.
|
|
1394
|
-
* @
|
|
1394
|
+
* @maxLength 19
|
|
1395
1395
|
*/
|
|
1396
1396
|
color?: string | null;
|
|
1397
1397
|
/** An image to use for the background. */
|
|
@@ -1405,7 +1405,7 @@ interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
|
|
|
1405
1405
|
interface PollDesignBackgroundBackgroundOneOf {
|
|
1406
1406
|
/**
|
|
1407
1407
|
* The background color as a hexademical value.
|
|
1408
|
-
* @
|
|
1408
|
+
* @maxLength 19
|
|
1409
1409
|
*/
|
|
1410
1410
|
color?: string | null;
|
|
1411
1411
|
/** An image to use for the background. */
|
|
@@ -1719,32 +1719,32 @@ interface ButtonStyles {
|
|
|
1719
1719
|
borderRadius?: number | null;
|
|
1720
1720
|
/**
|
|
1721
1721
|
* Border color as a hexadecimal value.
|
|
1722
|
-
* @
|
|
1722
|
+
* @maxLength 19
|
|
1723
1723
|
*/
|
|
1724
1724
|
borderColor?: string | null;
|
|
1725
1725
|
/**
|
|
1726
1726
|
* Text color as a hexadecimal value.
|
|
1727
|
-
* @
|
|
1727
|
+
* @maxLength 19
|
|
1728
1728
|
*/
|
|
1729
1729
|
textColor?: string | null;
|
|
1730
1730
|
/**
|
|
1731
1731
|
* Background color as a hexadecimal value.
|
|
1732
|
-
* @
|
|
1732
|
+
* @maxLength 19
|
|
1733
1733
|
*/
|
|
1734
1734
|
backgroundColor?: string | null;
|
|
1735
1735
|
/**
|
|
1736
1736
|
* Border color as a hexadecimal value (hover state).
|
|
1737
|
-
* @
|
|
1737
|
+
* @maxLength 19
|
|
1738
1738
|
*/
|
|
1739
1739
|
borderColorHover?: string | null;
|
|
1740
1740
|
/**
|
|
1741
1741
|
* Text color as a hexadecimal value (hover state).
|
|
1742
|
-
* @
|
|
1742
|
+
* @maxLength 19
|
|
1743
1743
|
*/
|
|
1744
1744
|
textColorHover?: string | null;
|
|
1745
1745
|
/**
|
|
1746
1746
|
* Background color as a hexadecimal value (hover state).
|
|
1747
|
-
* @
|
|
1747
|
+
* @maxLength 19
|
|
1748
1748
|
*/
|
|
1749
1749
|
backgroundColorHover?: string | null;
|
|
1750
1750
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
@@ -1761,7 +1761,7 @@ interface ImageStyles {
|
|
|
1761
1761
|
resizing?: ResizingWithLiterals;
|
|
1762
1762
|
/**
|
|
1763
1763
|
* Image border color as a hexadecimal value.
|
|
1764
|
-
* @
|
|
1764
|
+
* @maxLength 19
|
|
1765
1765
|
*/
|
|
1766
1766
|
borderColor?: string | null;
|
|
1767
1767
|
/** Image border width in pixels. */
|
|
@@ -1774,17 +1774,17 @@ interface RibbonStyles {
|
|
|
1774
1774
|
ribbonText?: string | null;
|
|
1775
1775
|
/**
|
|
1776
1776
|
* Ribbon background color as a hexadecimal value.
|
|
1777
|
-
* @
|
|
1777
|
+
* @maxLength 19
|
|
1778
1778
|
*/
|
|
1779
1779
|
backgroundColor?: string | null;
|
|
1780
1780
|
/**
|
|
1781
1781
|
* Ribbon text color as a hexadecimal value.
|
|
1782
|
-
* @
|
|
1782
|
+
* @maxLength 19
|
|
1783
1783
|
*/
|
|
1784
1784
|
textColor?: string | null;
|
|
1785
1785
|
/**
|
|
1786
1786
|
* Ribbon border color as a hexadecimal value.
|
|
1787
|
-
* @
|
|
1787
|
+
* @maxLength 19
|
|
1788
1788
|
*/
|
|
1789
1789
|
borderColor?: string | null;
|
|
1790
1790
|
/** Ribbon border width in pixels. */
|
|
@@ -1797,12 +1797,12 @@ interface RibbonStyles {
|
|
|
1797
1797
|
interface CardStyles {
|
|
1798
1798
|
/**
|
|
1799
1799
|
* Card background color as a hexadecimal value.
|
|
1800
|
-
* @
|
|
1800
|
+
* @maxLength 19
|
|
1801
1801
|
*/
|
|
1802
1802
|
backgroundColor?: string | null;
|
|
1803
1803
|
/**
|
|
1804
1804
|
* Card border color as a hexadecimal value.
|
|
1805
|
-
* @
|
|
1805
|
+
* @maxLength 19
|
|
1806
1806
|
*/
|
|
1807
1807
|
borderColor?: string | null;
|
|
1808
1808
|
/** Card border width in pixels. */
|
|
@@ -1817,12 +1817,12 @@ interface CardStyles {
|
|
|
1817
1817
|
titlePriceLayout?: LayoutWithLiterals;
|
|
1818
1818
|
/**
|
|
1819
1819
|
* Title text color as a hexadecimal value.
|
|
1820
|
-
* @
|
|
1820
|
+
* @maxLength 19
|
|
1821
1821
|
*/
|
|
1822
1822
|
titleColor?: string | null;
|
|
1823
1823
|
/**
|
|
1824
1824
|
* Text color as a hexadecimal value.
|
|
1825
|
-
* @
|
|
1825
|
+
* @maxLength 19
|
|
1826
1826
|
*/
|
|
1827
1827
|
textColor?: string | null;
|
|
1828
1828
|
}
|
|
@@ -2004,29 +2004,29 @@ interface CellStyle {
|
|
|
2004
2004
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2005
2005
|
/**
|
|
2006
2006
|
* Cell background color as a hexadecimal value.
|
|
2007
|
-
* @
|
|
2007
|
+
* @maxLength 19
|
|
2008
2008
|
*/
|
|
2009
2009
|
backgroundColor?: string | null;
|
|
2010
2010
|
}
|
|
2011
2011
|
interface BorderColors {
|
|
2012
2012
|
/**
|
|
2013
2013
|
* Left border color as a hexadecimal value.
|
|
2014
|
-
* @
|
|
2014
|
+
* @maxLength 19
|
|
2015
2015
|
*/
|
|
2016
2016
|
left?: string | null;
|
|
2017
2017
|
/**
|
|
2018
2018
|
* Right border color as a hexadecimal value.
|
|
2019
|
-
* @
|
|
2019
|
+
* @maxLength 19
|
|
2020
2020
|
*/
|
|
2021
2021
|
right?: string | null;
|
|
2022
2022
|
/**
|
|
2023
2023
|
* Top border color as a hexadecimal value.
|
|
2024
|
-
* @
|
|
2024
|
+
* @maxLength 19
|
|
2025
2025
|
*/
|
|
2026
2026
|
top?: string | null;
|
|
2027
2027
|
/**
|
|
2028
2028
|
* Bottom border color as a hexadecimal value.
|
|
2029
|
-
* @
|
|
2029
|
+
* @maxLength 19
|
|
2030
2030
|
*/
|
|
2031
2031
|
bottom?: string | null;
|
|
2032
2032
|
}
|
|
@@ -2101,7 +2101,7 @@ interface CaptionData {
|
|
|
2101
2101
|
interface LayoutData {
|
|
2102
2102
|
/**
|
|
2103
2103
|
* Deprecated: Use `background` instead.
|
|
2104
|
-
* @
|
|
2104
|
+
* @maxLength 19
|
|
2105
2105
|
* @deprecated
|
|
2106
2106
|
*/
|
|
2107
2107
|
backgroundColor?: string | null;
|
|
@@ -2109,7 +2109,7 @@ interface LayoutData {
|
|
|
2109
2109
|
backgroundImage?: LayoutDataBackgroundImage;
|
|
2110
2110
|
/**
|
|
2111
2111
|
* Border color as a hexadecimal value.
|
|
2112
|
-
* @
|
|
2112
|
+
* @maxLength 19
|
|
2113
2113
|
*/
|
|
2114
2114
|
borderColor?: string | null;
|
|
2115
2115
|
/** Border width in pixels. */
|
|
@@ -2118,7 +2118,7 @@ interface LayoutData {
|
|
|
2118
2118
|
borderRadius?: number | null;
|
|
2119
2119
|
/**
|
|
2120
2120
|
* Deprecated: Use `backdrop` instead.
|
|
2121
|
-
* @
|
|
2121
|
+
* @maxLength 19
|
|
2122
2122
|
* @deprecated
|
|
2123
2123
|
*/
|
|
2124
2124
|
backdropColor?: string | null;
|
|
@@ -2256,7 +2256,7 @@ interface LayoutDataBackground {
|
|
|
2256
2256
|
type?: LayoutDataBackgroundTypeWithLiterals;
|
|
2257
2257
|
/**
|
|
2258
2258
|
* Background color as a hexadecimal value.
|
|
2259
|
-
* @
|
|
2259
|
+
* @maxLength 19
|
|
2260
2260
|
*/
|
|
2261
2261
|
color?: string | null;
|
|
2262
2262
|
/** Gradient configuration. */
|
|
@@ -2268,7 +2268,7 @@ interface Backdrop {
|
|
|
2268
2268
|
type?: BackdropTypeWithLiterals;
|
|
2269
2269
|
/**
|
|
2270
2270
|
* Backdrop color as a hexadecimal value.
|
|
2271
|
-
* @
|
|
2271
|
+
* @maxLength 19
|
|
2272
2272
|
*/
|
|
2273
2273
|
color?: string | null;
|
|
2274
2274
|
/** Gradient configuration. */
|
|
@@ -2289,7 +2289,7 @@ interface ShapeData {
|
|
|
2289
2289
|
interface ShapeDataStyles {
|
|
2290
2290
|
/**
|
|
2291
2291
|
* Shape fill color as a hexadecimal value.
|
|
2292
|
-
* @
|
|
2292
|
+
* @maxLength 19
|
|
2293
2293
|
*/
|
|
2294
2294
|
color?: string | null;
|
|
2295
2295
|
/** Map of original color keys to their new color values. */
|
|
@@ -2348,7 +2348,7 @@ interface CardDataBackground {
|
|
|
2348
2348
|
type?: CardDataBackgroundTypeWithLiterals;
|
|
2349
2349
|
/**
|
|
2350
2350
|
* Background color as a hexadecimal value.
|
|
2351
|
-
* @
|
|
2351
|
+
* @maxLength 19
|
|
2352
2352
|
*/
|
|
2353
2353
|
color?: string | null;
|
|
2354
2354
|
/** Gradient configuration. */
|
|
@@ -2375,7 +2375,7 @@ interface TocData {
|
|
|
2375
2375
|
itemSpacing?: number | null;
|
|
2376
2376
|
/**
|
|
2377
2377
|
* Optional override for the text color.
|
|
2378
|
-
* @
|
|
2378
|
+
* @maxLength 19
|
|
2379
2379
|
*/
|
|
2380
2380
|
color?: string | null;
|
|
2381
2381
|
/** Indentation style. Default: NESTED. */
|
|
@@ -2417,7 +2417,10 @@ interface SmartBlockData {
|
|
|
2417
2417
|
orientation?: string | null;
|
|
2418
2418
|
/** Column size controlling cells per row. */
|
|
2419
2419
|
columnSize?: ColumnSizeWithLiterals;
|
|
2420
|
-
/**
|
|
2420
|
+
/**
|
|
2421
|
+
* Border color (for SOLID_JOINED_BOXES variant).
|
|
2422
|
+
* @maxLength 19
|
|
2423
|
+
*/
|
|
2421
2424
|
borderColor?: string | null;
|
|
2422
2425
|
/** Border width in pixels (for SOLID_JOINED_BOXES variant). */
|
|
2423
2426
|
borderWidth?: number | null;
|
|
@@ -2476,7 +2479,10 @@ interface SmartBlockCellData {
|
|
|
2476
2479
|
label?: string | null;
|
|
2477
2480
|
/** Shape file details. */
|
|
2478
2481
|
shape?: V1Media;
|
|
2479
|
-
/**
|
|
2482
|
+
/**
|
|
2483
|
+
* Border color of the cell.
|
|
2484
|
+
* @maxLength 19
|
|
2485
|
+
*/
|
|
2480
2486
|
borderColor?: string | null;
|
|
2481
2487
|
/** Border width in pixels. */
|
|
2482
2488
|
borderWidth?: number | null;
|
|
@@ -2484,11 +2490,20 @@ interface SmartBlockCellData {
|
|
|
2484
2490
|
borderRadius?: number | null;
|
|
2485
2491
|
/** The type of the parent smart block (must match parent). */
|
|
2486
2492
|
type?: SmartBlockDataTypeWithLiterals;
|
|
2487
|
-
/**
|
|
2493
|
+
/**
|
|
2494
|
+
* Accent color for non-background variants (e.g., line, bullet, label color).
|
|
2495
|
+
* @maxLength 19
|
|
2496
|
+
*/
|
|
2488
2497
|
accentColor?: string | null;
|
|
2489
|
-
/**
|
|
2498
|
+
/**
|
|
2499
|
+
* Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
|
|
2500
|
+
* @maxLength 19
|
|
2501
|
+
*/
|
|
2490
2502
|
backgroundColor?: string | null;
|
|
2491
|
-
/**
|
|
2503
|
+
/**
|
|
2504
|
+
* Shape fill color as a hexadecimal value.
|
|
2505
|
+
* @maxLength 19
|
|
2506
|
+
*/
|
|
2492
2507
|
shapeColor?: string | null;
|
|
2493
2508
|
}
|
|
2494
2509
|
interface Metadata {
|
|
@@ -2773,309 +2788,595 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2773
2788
|
*/
|
|
2774
2789
|
anonymousVisitorId?: string | null;
|
|
2775
2790
|
}
|
|
2776
|
-
interface
|
|
2791
|
+
interface GetTotalLikesPerMemberRequest {
|
|
2777
2792
|
/**
|
|
2778
|
-
*
|
|
2779
|
-
* @maxSize 50
|
|
2793
|
+
* Member ID.
|
|
2780
2794
|
* @format GUID
|
|
2781
2795
|
*/
|
|
2782
|
-
|
|
2783
|
-
/**
|
|
2784
|
-
* Filter post templates by provided language
|
|
2785
|
-
* @format LANGUAGE_TAG
|
|
2786
|
-
*/
|
|
2787
|
-
language?: string | null;
|
|
2788
|
-
/** Returns post template categories when set to TRUE */
|
|
2789
|
-
listTemplateCategories?: boolean;
|
|
2790
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2791
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2792
|
-
/** Pagination options. */
|
|
2793
|
-
paging?: BlogPaging;
|
|
2796
|
+
memberId?: string;
|
|
2794
2797
|
}
|
|
2795
|
-
|
|
2796
|
-
/**
|
|
2797
|
-
|
|
2798
|
-
/** Sort by descending publishing date. */
|
|
2799
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2798
|
+
interface GetTotalLikesPerMemberResponse {
|
|
2799
|
+
/** The total number of likes of the member. */
|
|
2800
|
+
total?: number;
|
|
2800
2801
|
}
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2802
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2803
|
+
createdEvent?: EntityCreatedEvent;
|
|
2804
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2805
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2806
|
+
actionEvent?: ActionEvent;
|
|
2807
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2808
|
+
id?: string;
|
|
2804
2809
|
/**
|
|
2805
|
-
*
|
|
2806
|
-
*
|
|
2807
|
-
*
|
|
2808
|
-
* Default: `0`
|
|
2810
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2811
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2809
2812
|
*/
|
|
2810
|
-
|
|
2813
|
+
entityFqdn?: string;
|
|
2811
2814
|
/**
|
|
2812
|
-
*
|
|
2813
|
-
*
|
|
2814
|
-
*
|
|
2815
|
-
* Default:`50`
|
|
2816
|
-
* @min 1
|
|
2817
|
-
* @max 100
|
|
2815
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2816
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2818
2817
|
*/
|
|
2819
|
-
|
|
2818
|
+
slug?: string;
|
|
2819
|
+
/** ID of the entity associated with the event. */
|
|
2820
|
+
entityId?: string;
|
|
2821
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2822
|
+
eventTime?: Date | null;
|
|
2820
2823
|
/**
|
|
2821
|
-
*
|
|
2822
|
-
*
|
|
2824
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2825
|
+
* (for example, GDPR).
|
|
2823
2826
|
*/
|
|
2824
|
-
|
|
2827
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2828
|
+
/** If present, indicates the action that triggered the event. */
|
|
2829
|
+
originatedFrom?: string | null;
|
|
2830
|
+
/**
|
|
2831
|
+
* 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.
|
|
2832
|
+
* 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.
|
|
2833
|
+
*/
|
|
2834
|
+
entityEventSequence?: string | null;
|
|
2825
2835
|
}
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
templateCategories?: Category[];
|
|
2836
|
+
/** @oneof */
|
|
2837
|
+
interface DomainEventBodyOneOf {
|
|
2838
|
+
createdEvent?: EntityCreatedEvent;
|
|
2839
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2840
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2841
|
+
actionEvent?: ActionEvent;
|
|
2833
2842
|
}
|
|
2834
|
-
interface
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
|
|
2843
|
+
interface EntityCreatedEvent {
|
|
2844
|
+
entityAsJson?: string;
|
|
2845
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2846
|
+
restoreInfo?: RestoreInfo;
|
|
2847
|
+
}
|
|
2848
|
+
interface RestoreInfo {
|
|
2849
|
+
deletedDate?: Date | null;
|
|
2850
|
+
}
|
|
2851
|
+
interface EntityUpdatedEvent {
|
|
2841
2852
|
/**
|
|
2842
|
-
*
|
|
2843
|
-
*
|
|
2853
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2854
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2855
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2844
2856
|
*/
|
|
2845
|
-
|
|
2857
|
+
currentEntityAsJson?: string;
|
|
2846
2858
|
}
|
|
2847
|
-
interface
|
|
2859
|
+
interface EntityDeletedEvent {
|
|
2860
|
+
/** Entity that was deleted. */
|
|
2861
|
+
deletedEntityAsJson?: string | null;
|
|
2862
|
+
}
|
|
2863
|
+
interface ActionEvent {
|
|
2864
|
+
bodyAsJson?: string;
|
|
2865
|
+
}
|
|
2866
|
+
interface MessageEnvelope {
|
|
2848
2867
|
/**
|
|
2849
|
-
*
|
|
2850
|
-
* @
|
|
2851
|
-
* @maxLength 38
|
|
2868
|
+
* App instance ID.
|
|
2869
|
+
* @format GUID
|
|
2852
2870
|
*/
|
|
2853
|
-
|
|
2871
|
+
instanceId?: string | null;
|
|
2854
2872
|
/**
|
|
2855
|
-
*
|
|
2856
|
-
* @maxLength
|
|
2873
|
+
* Event type.
|
|
2874
|
+
* @maxLength 150
|
|
2857
2875
|
*/
|
|
2858
|
-
|
|
2876
|
+
eventType?: string;
|
|
2877
|
+
/** The identification type and identity data. */
|
|
2878
|
+
identity?: IdentificationData;
|
|
2879
|
+
/** Stringify payload. */
|
|
2880
|
+
data?: string;
|
|
2881
|
+
/** Details related to the account */
|
|
2882
|
+
accountInfo?: AccountInfo;
|
|
2883
|
+
}
|
|
2884
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2859
2885
|
/**
|
|
2860
|
-
*
|
|
2861
|
-
* @
|
|
2886
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2887
|
+
* @format GUID
|
|
2862
2888
|
*/
|
|
2863
|
-
|
|
2889
|
+
anonymousVisitorId?: string;
|
|
2864
2890
|
/**
|
|
2865
|
-
*
|
|
2866
|
-
* @
|
|
2891
|
+
* ID of a site visitor that has logged in to the site.
|
|
2892
|
+
* @format GUID
|
|
2867
2893
|
*/
|
|
2868
|
-
|
|
2894
|
+
memberId?: string;
|
|
2869
2895
|
/**
|
|
2870
|
-
*
|
|
2871
|
-
* @
|
|
2896
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2897
|
+
* @format GUID
|
|
2872
2898
|
*/
|
|
2873
|
-
|
|
2899
|
+
wixUserId?: string;
|
|
2874
2900
|
/**
|
|
2875
|
-
*
|
|
2876
|
-
* @
|
|
2877
|
-
* @deprecated Category title.
|
|
2878
|
-
* @targetRemovalDate 2025-07-16
|
|
2901
|
+
* ID of an app.
|
|
2902
|
+
* @format GUID
|
|
2879
2903
|
*/
|
|
2880
|
-
|
|
2904
|
+
appId?: string;
|
|
2905
|
+
/** @readonly */
|
|
2906
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2907
|
+
}
|
|
2908
|
+
/** @oneof */
|
|
2909
|
+
interface IdentificationDataIdOneOf {
|
|
2881
2910
|
/**
|
|
2882
|
-
*
|
|
2883
|
-
*
|
|
2884
|
-
*
|
|
2885
|
-
* Default: `-1`
|
|
2911
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2912
|
+
* @format GUID
|
|
2886
2913
|
*/
|
|
2887
|
-
|
|
2914
|
+
anonymousVisitorId?: string;
|
|
2888
2915
|
/**
|
|
2889
|
-
* ID of
|
|
2916
|
+
* ID of a site visitor that has logged in to the site.
|
|
2890
2917
|
* @format GUID
|
|
2891
2918
|
*/
|
|
2892
|
-
|
|
2919
|
+
memberId?: string;
|
|
2893
2920
|
/**
|
|
2894
|
-
*
|
|
2895
|
-
*
|
|
2896
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2897
|
-
* @immutable
|
|
2921
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2922
|
+
* @format GUID
|
|
2898
2923
|
*/
|
|
2899
|
-
|
|
2924
|
+
wixUserId?: string;
|
|
2900
2925
|
/**
|
|
2901
|
-
*
|
|
2902
|
-
* @
|
|
2926
|
+
* ID of an app.
|
|
2927
|
+
* @format GUID
|
|
2903
2928
|
*/
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2929
|
+
appId?: string;
|
|
2930
|
+
}
|
|
2931
|
+
declare enum WebhookIdentityType {
|
|
2932
|
+
UNKNOWN = "UNKNOWN",
|
|
2933
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2934
|
+
MEMBER = "MEMBER",
|
|
2935
|
+
WIX_USER = "WIX_USER",
|
|
2936
|
+
APP = "APP"
|
|
2937
|
+
}
|
|
2938
|
+
/** @enumType */
|
|
2939
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2940
|
+
interface AccountInfo {
|
|
2909
2941
|
/**
|
|
2910
|
-
*
|
|
2911
|
-
* @
|
|
2942
|
+
* ID of the Wix account associated with the event.
|
|
2943
|
+
* @format GUID
|
|
2912
2944
|
*/
|
|
2913
|
-
|
|
2914
|
-
}
|
|
2915
|
-
interface CategoryTranslation {
|
|
2945
|
+
accountId?: string | null;
|
|
2916
2946
|
/**
|
|
2917
|
-
*
|
|
2947
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2918
2948
|
* @format GUID
|
|
2919
2949
|
*/
|
|
2920
|
-
|
|
2950
|
+
parentAccountId?: string | null;
|
|
2921
2951
|
/**
|
|
2922
|
-
*
|
|
2923
|
-
* @
|
|
2952
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2953
|
+
* @format GUID
|
|
2924
2954
|
*/
|
|
2925
|
-
|
|
2955
|
+
siteId?: string | null;
|
|
2956
|
+
}
|
|
2957
|
+
/** Get Blog Publications Count Stats request */
|
|
2958
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2959
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2960
|
+
rangeStart?: Date | null;
|
|
2961
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2962
|
+
rangeEnd?: Date | null;
|
|
2963
|
+
/** Order of the returned results. */
|
|
2964
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2965
|
+
/** Number of months to include in the response. */
|
|
2966
|
+
months?: number;
|
|
2926
2967
|
/**
|
|
2927
|
-
* Language
|
|
2968
|
+
* Language filter
|
|
2969
|
+
*
|
|
2970
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2928
2971
|
* @format LANGUAGE_TAG
|
|
2929
2972
|
*/
|
|
2930
2973
|
language?: string | null;
|
|
2931
|
-
/** URL of this category page. */
|
|
2932
|
-
url?: PageUrl;
|
|
2933
|
-
}
|
|
2934
|
-
interface GetTemplateRequest {
|
|
2935
2974
|
/**
|
|
2936
|
-
*
|
|
2937
|
-
* @
|
|
2975
|
+
* Timezone of the client.
|
|
2976
|
+
* @minLength 3
|
|
2977
|
+
* @maxLength 100
|
|
2938
2978
|
*/
|
|
2939
|
-
|
|
2979
|
+
timeZone?: string | null;
|
|
2940
2980
|
}
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
|
|
2981
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2982
|
+
UNKNOWN = "UNKNOWN",
|
|
2983
|
+
OLDEST = "OLDEST",
|
|
2984
|
+
NEWEST = "NEWEST"
|
|
2944
2985
|
}
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
2986
|
+
/** @enumType */
|
|
2987
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2988
|
+
/** Get Blog Publications Count Stats response */
|
|
2989
|
+
interface QueryPublicationsCountStatsResponse {
|
|
2990
|
+
/** Chronologically ordered list of publications. */
|
|
2991
|
+
stats?: PeriodPublicationsCount[];
|
|
2951
2992
|
}
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2993
|
+
/** Publications count for a specific time period */
|
|
2994
|
+
interface PeriodPublicationsCount {
|
|
2995
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2996
|
+
periodStart?: Date | null;
|
|
2997
|
+
/** Number of posts published during this month. */
|
|
2998
|
+
publicationsCount?: number;
|
|
2955
2999
|
}
|
|
2956
|
-
|
|
2957
|
-
|
|
2958
|
-
|
|
2959
|
-
|
|
2960
|
-
* @maxLength 38
|
|
2961
|
-
*/
|
|
2962
|
-
id?: string;
|
|
2963
|
-
/**
|
|
2964
|
-
* Draft post title.
|
|
2965
|
-
* @maxLength 200
|
|
2966
|
-
*/
|
|
2967
|
-
title?: string;
|
|
3000
|
+
/** Get Blog Post Count Stats request */
|
|
3001
|
+
interface QueryPostCountStatsRequest {
|
|
3002
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3003
|
+
rangeStart?: Date | null;
|
|
2968
3004
|
/**
|
|
2969
|
-
*
|
|
3005
|
+
* Order of returned results.
|
|
2970
3006
|
*
|
|
2971
|
-
*
|
|
2972
|
-
*
|
|
2973
|
-
*
|
|
2974
|
-
|
|
2975
|
-
excerpt?: string | null;
|
|
2976
|
-
/** Whether the draft post is marked as featured. */
|
|
2977
|
-
featured?: boolean | null;
|
|
2978
|
-
/**
|
|
2979
|
-
* Category IDs of the draft post.
|
|
2980
|
-
* @maxSize 10
|
|
2981
|
-
* @maxLength 38
|
|
3007
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
3008
|
+
* - `NEWEST`: posts by date in descending order.
|
|
3009
|
+
*
|
|
3010
|
+
* Default: `OLDEST`
|
|
2982
3011
|
*/
|
|
2983
|
-
|
|
3012
|
+
order?: OrderWithLiterals;
|
|
3013
|
+
/** Number of months to include in response. */
|
|
3014
|
+
months?: number;
|
|
2984
3015
|
/**
|
|
2985
|
-
*
|
|
2986
|
-
*
|
|
3016
|
+
* Language filter.
|
|
3017
|
+
*
|
|
3018
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3019
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
3020
|
+
* @format LANGUAGE_TAG
|
|
2987
3021
|
*/
|
|
2988
|
-
|
|
3022
|
+
language?: string | null;
|
|
2989
3023
|
/**
|
|
2990
|
-
*
|
|
2991
|
-
*
|
|
3024
|
+
* Time zone to use when calculating the start of the month.
|
|
3025
|
+
*
|
|
3026
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
3027
|
+
* @minLength 3
|
|
2992
3028
|
* @maxLength 100
|
|
2993
3029
|
*/
|
|
2994
|
-
|
|
2995
|
-
|
|
2996
|
-
|
|
3030
|
+
timeZone?: string | null;
|
|
3031
|
+
}
|
|
3032
|
+
declare enum Order {
|
|
3033
|
+
UNKNOWN = "UNKNOWN",
|
|
3034
|
+
OLDEST = "OLDEST",
|
|
3035
|
+
NEWEST = "NEWEST"
|
|
3036
|
+
}
|
|
3037
|
+
/** @enumType */
|
|
3038
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3039
|
+
/** Get Blog Post Count Stats response */
|
|
3040
|
+
interface QueryPostCountStatsResponse {
|
|
3041
|
+
/** List of published post counts by month. */
|
|
3042
|
+
stats?: PeriodPostCount[];
|
|
3043
|
+
}
|
|
3044
|
+
/** Post count for a specific time period */
|
|
3045
|
+
interface PeriodPostCount {
|
|
3046
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3047
|
+
periodStart?: Date | null;
|
|
3048
|
+
/** Number of posts published during this month. */
|
|
3049
|
+
postCount?: number;
|
|
3050
|
+
}
|
|
3051
|
+
interface GetTotalPublicationsRequest {
|
|
2997
3052
|
/**
|
|
2998
|
-
*
|
|
2999
|
-
* @
|
|
3053
|
+
* Language filter
|
|
3054
|
+
* @minLength 2
|
|
3055
|
+
* @format LANGUAGE_TAG
|
|
3000
3056
|
*/
|
|
3001
|
-
|
|
3002
|
-
|
|
3003
|
-
|
|
3057
|
+
language?: string | null;
|
|
3058
|
+
}
|
|
3059
|
+
interface GetTotalPublicationsResponse {
|
|
3060
|
+
/** Total amount of publications. */
|
|
3061
|
+
total?: number;
|
|
3062
|
+
}
|
|
3063
|
+
interface GetTotalPostsRequest {
|
|
3004
3064
|
/**
|
|
3005
|
-
*
|
|
3006
|
-
*
|
|
3007
|
-
*
|
|
3065
|
+
* Language filter.
|
|
3066
|
+
*
|
|
3067
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3068
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
3069
|
+
* @format LANGUAGE_TAG
|
|
3008
3070
|
*/
|
|
3009
|
-
|
|
3071
|
+
language?: string | null;
|
|
3072
|
+
}
|
|
3073
|
+
interface GetTotalPostsResponse {
|
|
3074
|
+
/** Total amount of published posts. */
|
|
3075
|
+
total?: number;
|
|
3076
|
+
}
|
|
3077
|
+
interface ListTemplatesRequest {
|
|
3010
3078
|
/**
|
|
3011
|
-
*
|
|
3012
|
-
* @maxSize
|
|
3013
|
-
* @
|
|
3079
|
+
* Filter post templates by given template category ids
|
|
3080
|
+
* @maxSize 50
|
|
3081
|
+
* @format GUID
|
|
3014
3082
|
*/
|
|
3015
|
-
|
|
3083
|
+
categoryIds?: string[];
|
|
3016
3084
|
/**
|
|
3017
|
-
*
|
|
3018
|
-
* @
|
|
3019
|
-
* @format GUID
|
|
3085
|
+
* Filter post templates by provided language
|
|
3086
|
+
* @format LANGUAGE_TAG
|
|
3020
3087
|
*/
|
|
3021
|
-
|
|
3088
|
+
language?: string | null;
|
|
3089
|
+
/** Returns post template categories when set to TRUE */
|
|
3090
|
+
listTemplateCategories?: boolean;
|
|
3091
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
3092
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
3093
|
+
/** Pagination options. */
|
|
3094
|
+
paging?: BlogPaging;
|
|
3095
|
+
}
|
|
3096
|
+
declare enum GetPostTemplatesSort {
|
|
3097
|
+
/** Sort by ascending publishing date. */
|
|
3098
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3099
|
+
/** Sort by descending publishing date. */
|
|
3100
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
3101
|
+
}
|
|
3102
|
+
/** @enumType */
|
|
3103
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
3104
|
+
interface BlogPaging {
|
|
3022
3105
|
/**
|
|
3023
|
-
*
|
|
3106
|
+
* Number of items to skip in the current sort order.
|
|
3024
3107
|
*
|
|
3025
|
-
*
|
|
3026
|
-
*
|
|
3027
|
-
* @format GUID
|
|
3108
|
+
*
|
|
3109
|
+
* Default: `0`
|
|
3028
3110
|
*/
|
|
3029
|
-
|
|
3111
|
+
offset?: number;
|
|
3030
3112
|
/**
|
|
3031
|
-
*
|
|
3113
|
+
* Number of items to return.
|
|
3032
3114
|
*
|
|
3033
|
-
*
|
|
3034
|
-
*
|
|
3115
|
+
*
|
|
3116
|
+
* Default:`50`
|
|
3117
|
+
* @min 1
|
|
3118
|
+
* @max 100
|
|
3035
3119
|
*/
|
|
3036
|
-
|
|
3120
|
+
limit?: number;
|
|
3037
3121
|
/**
|
|
3038
|
-
*
|
|
3039
|
-
*
|
|
3040
|
-
* <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">
|
|
3041
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
3042
|
-
* </widget>
|
|
3122
|
+
* Pointer to the next or previous page in the list of results.
|
|
3123
|
+
* @maxLength 2000
|
|
3043
3124
|
*/
|
|
3044
|
-
|
|
3125
|
+
cursor?: string | null;
|
|
3126
|
+
}
|
|
3127
|
+
interface ListTemplatesResponse {
|
|
3128
|
+
/** Available post templates */
|
|
3129
|
+
postTemplates?: Post[];
|
|
3130
|
+
/** Details on the paged set of posts templates returned. */
|
|
3131
|
+
postTemplatesMetaData?: MetaData;
|
|
3132
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
3133
|
+
templateCategories?: Category[];
|
|
3134
|
+
}
|
|
3135
|
+
interface MetaData {
|
|
3136
|
+
/** Number of items returned in this response. */
|
|
3137
|
+
count?: number;
|
|
3138
|
+
/** Requested offset. */
|
|
3139
|
+
offset?: number;
|
|
3140
|
+
/** Total number of items that match the query. */
|
|
3141
|
+
total?: number;
|
|
3045
3142
|
/**
|
|
3046
|
-
*
|
|
3047
|
-
* @
|
|
3143
|
+
* Pointer to the next or previous page in the list of results.
|
|
3144
|
+
* @maxLength 2000
|
|
3048
3145
|
*/
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3146
|
+
cursor?: string | null;
|
|
3147
|
+
}
|
|
3148
|
+
interface Category {
|
|
3052
3149
|
/**
|
|
3053
|
-
*
|
|
3054
|
-
* @
|
|
3150
|
+
* Category ID.
|
|
3151
|
+
* @immutable
|
|
3152
|
+
* @maxLength 38
|
|
3055
3153
|
*/
|
|
3056
|
-
|
|
3154
|
+
id?: string;
|
|
3057
3155
|
/**
|
|
3058
|
-
*
|
|
3059
|
-
* @
|
|
3156
|
+
* Category label. Displayed in the Category Menu.
|
|
3157
|
+
* @maxLength 35
|
|
3060
3158
|
*/
|
|
3061
|
-
|
|
3159
|
+
label?: string;
|
|
3062
3160
|
/**
|
|
3063
|
-
*
|
|
3161
|
+
* Number of posts in the category.
|
|
3064
3162
|
* @readonly
|
|
3065
3163
|
*/
|
|
3066
|
-
|
|
3067
|
-
/** Date the post was first published. */
|
|
3068
|
-
firstPublishedDate?: Date | null;
|
|
3069
|
-
/** SEO data. */
|
|
3070
|
-
seoData?: SeoSchema;
|
|
3164
|
+
postCount?: number;
|
|
3071
3165
|
/**
|
|
3072
|
-
*
|
|
3166
|
+
* The `url` of the page that lists every post with the specified category.
|
|
3073
3167
|
* @readonly
|
|
3074
3168
|
*/
|
|
3075
3169
|
url?: PageUrl;
|
|
3076
3170
|
/**
|
|
3077
|
-
*
|
|
3078
|
-
* @
|
|
3171
|
+
* Category description.
|
|
3172
|
+
* @maxLength 500
|
|
3173
|
+
*/
|
|
3174
|
+
description?: string | null;
|
|
3175
|
+
/**
|
|
3176
|
+
* Category title.
|
|
3177
|
+
* @maxLength 200
|
|
3178
|
+
* @deprecated Category title.
|
|
3179
|
+
* @targetRemovalDate 2025-07-16
|
|
3180
|
+
*/
|
|
3181
|
+
title?: string;
|
|
3182
|
+
/**
|
|
3183
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
3184
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
3185
|
+
*
|
|
3186
|
+
* Default: `-1`
|
|
3187
|
+
*/
|
|
3188
|
+
displayPosition?: number | null;
|
|
3189
|
+
/**
|
|
3190
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
3191
|
+
* @format GUID
|
|
3192
|
+
*/
|
|
3193
|
+
translationId?: string | null;
|
|
3194
|
+
/**
|
|
3195
|
+
* Category language.
|
|
3196
|
+
*
|
|
3197
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3198
|
+
* @immutable
|
|
3199
|
+
*/
|
|
3200
|
+
language?: string | null;
|
|
3201
|
+
/**
|
|
3202
|
+
* 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`.
|
|
3203
|
+
* @maxLength 100
|
|
3204
|
+
*/
|
|
3205
|
+
slug?: string;
|
|
3206
|
+
/** SEO data. */
|
|
3207
|
+
seoData?: SeoSchema;
|
|
3208
|
+
/** Category cover image. */
|
|
3209
|
+
coverImage?: Image;
|
|
3210
|
+
/**
|
|
3211
|
+
* Date and time the Category was last updated.
|
|
3212
|
+
* @readonly
|
|
3213
|
+
*/
|
|
3214
|
+
updatedDate?: Date | null;
|
|
3215
|
+
}
|
|
3216
|
+
interface CategoryTranslation {
|
|
3217
|
+
/**
|
|
3218
|
+
* Category ID.
|
|
3219
|
+
* @format GUID
|
|
3220
|
+
*/
|
|
3221
|
+
id?: string;
|
|
3222
|
+
/**
|
|
3223
|
+
* Label displayed in the categories menu on the site.
|
|
3224
|
+
* @maxLength 100
|
|
3225
|
+
*/
|
|
3226
|
+
label?: string | null;
|
|
3227
|
+
/**
|
|
3228
|
+
* Language of the category.
|
|
3229
|
+
* @format LANGUAGE_TAG
|
|
3230
|
+
*/
|
|
3231
|
+
language?: string | null;
|
|
3232
|
+
/** URL of this category page. */
|
|
3233
|
+
url?: PageUrl;
|
|
3234
|
+
}
|
|
3235
|
+
interface GetTemplateRequest {
|
|
3236
|
+
/**
|
|
3237
|
+
* Post template id
|
|
3238
|
+
* @format GUID
|
|
3239
|
+
*/
|
|
3240
|
+
postTemplateId?: string;
|
|
3241
|
+
}
|
|
3242
|
+
interface GetTemplateResponse {
|
|
3243
|
+
/** Post template */
|
|
3244
|
+
postTemplate?: Post;
|
|
3245
|
+
}
|
|
3246
|
+
interface CreateDraftPostFromTemplateRequest {
|
|
3247
|
+
/**
|
|
3248
|
+
* Post template id
|
|
3249
|
+
* @format GUID
|
|
3250
|
+
*/
|
|
3251
|
+
postTemplateId?: string;
|
|
3252
|
+
}
|
|
3253
|
+
interface CreateDraftPostFromTemplateResponse {
|
|
3254
|
+
/** Created draft post */
|
|
3255
|
+
draftPost?: DraftPost;
|
|
3256
|
+
}
|
|
3257
|
+
interface DraftPost {
|
|
3258
|
+
/**
|
|
3259
|
+
* Draft post ID.
|
|
3260
|
+
* @readonly
|
|
3261
|
+
* @maxLength 38
|
|
3262
|
+
*/
|
|
3263
|
+
id?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* Draft post title.
|
|
3266
|
+
* @maxLength 200
|
|
3267
|
+
*/
|
|
3268
|
+
title?: string;
|
|
3269
|
+
/**
|
|
3270
|
+
* Draft post excerpt.
|
|
3271
|
+
*
|
|
3272
|
+
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
3273
|
+
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
3274
|
+
* @maxLength 500
|
|
3275
|
+
*/
|
|
3276
|
+
excerpt?: string | null;
|
|
3277
|
+
/** Whether the draft post is marked as featured. */
|
|
3278
|
+
featured?: boolean | null;
|
|
3279
|
+
/**
|
|
3280
|
+
* Category IDs of the draft post.
|
|
3281
|
+
* @maxSize 10
|
|
3282
|
+
* @maxLength 38
|
|
3283
|
+
*/
|
|
3284
|
+
categoryIds?: string[];
|
|
3285
|
+
/**
|
|
3286
|
+
* Draft post owner's member ID.
|
|
3287
|
+
* @format GUID
|
|
3288
|
+
*/
|
|
3289
|
+
memberId?: string | null;
|
|
3290
|
+
/**
|
|
3291
|
+
* Hashtags in the post.
|
|
3292
|
+
* @maxSize 100
|
|
3293
|
+
* @maxLength 100
|
|
3294
|
+
*/
|
|
3295
|
+
hashtags?: string[];
|
|
3296
|
+
/** Whether commenting on the draft post is enabled. */
|
|
3297
|
+
commentingEnabled?: boolean | null;
|
|
3298
|
+
/**
|
|
3299
|
+
* Estimated reading time of the draft post (calculated automatically).
|
|
3300
|
+
* @readonly
|
|
3301
|
+
*/
|
|
3302
|
+
minutesToRead?: number;
|
|
3303
|
+
/** Image placed at the top of the blog page. */
|
|
3304
|
+
heroImage?: Image;
|
|
3305
|
+
/**
|
|
3306
|
+
* Tag IDs the draft post is tagged with.
|
|
3307
|
+
* @maxSize 30
|
|
3308
|
+
* @maxLength 38
|
|
3309
|
+
*/
|
|
3310
|
+
tagIds?: string[];
|
|
3311
|
+
/**
|
|
3312
|
+
* IDs of posts related to this draft post.
|
|
3313
|
+
* @maxSize 3
|
|
3314
|
+
* @maxLength 38
|
|
3315
|
+
*/
|
|
3316
|
+
relatedPostIds?: string[];
|
|
3317
|
+
/**
|
|
3318
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
3319
|
+
* @maxSize 100
|
|
3320
|
+
* @format GUID
|
|
3321
|
+
*/
|
|
3322
|
+
pricingPlanIds?: string[];
|
|
3323
|
+
/**
|
|
3324
|
+
* ID of the draft post's translations.
|
|
3325
|
+
*
|
|
3326
|
+
* All translations of a single post share the same `translationId`.
|
|
3327
|
+
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
3328
|
+
* @format GUID
|
|
3329
|
+
*/
|
|
3330
|
+
translationId?: string | null;
|
|
3331
|
+
/**
|
|
3332
|
+
* Language the draft post is written in.
|
|
3333
|
+
*
|
|
3334
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3335
|
+
* @format LANGUAGE_TAG
|
|
3336
|
+
*/
|
|
3337
|
+
language?: string | null;
|
|
3338
|
+
/**
|
|
3339
|
+
* Draft Post rich content.
|
|
3340
|
+
*
|
|
3341
|
+
* <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">
|
|
3342
|
+
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
3343
|
+
* </widget>
|
|
3344
|
+
*/
|
|
3345
|
+
richContent?: RichContent;
|
|
3346
|
+
/**
|
|
3347
|
+
* Status of the draft post.
|
|
3348
|
+
* @readonly
|
|
3349
|
+
*/
|
|
3350
|
+
status?: StatusWithLiterals;
|
|
3351
|
+
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
3352
|
+
moderationDetails?: ModerationDetails;
|
|
3353
|
+
/**
|
|
3354
|
+
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
3355
|
+
* @readonly
|
|
3356
|
+
*/
|
|
3357
|
+
hasUnpublishedChanges?: boolean;
|
|
3358
|
+
/**
|
|
3359
|
+
* Date the draft post was last edited.
|
|
3360
|
+
* @readonly
|
|
3361
|
+
*/
|
|
3362
|
+
editedDate?: Date | null;
|
|
3363
|
+
/**
|
|
3364
|
+
* Date the draft post is scheduled to be published.
|
|
3365
|
+
* @readonly
|
|
3366
|
+
*/
|
|
3367
|
+
scheduledPublishDate?: Date | null;
|
|
3368
|
+
/** Date the post was first published. */
|
|
3369
|
+
firstPublishedDate?: Date | null;
|
|
3370
|
+
/** SEO data. */
|
|
3371
|
+
seoData?: SeoSchema;
|
|
3372
|
+
/**
|
|
3373
|
+
* Draft post URL preview. What the URL will look like once the post is published.
|
|
3374
|
+
* @readonly
|
|
3375
|
+
*/
|
|
3376
|
+
url?: PageUrl;
|
|
3377
|
+
/**
|
|
3378
|
+
* Date the draft post was first created.
|
|
3379
|
+
* @readonly
|
|
3079
3380
|
*/
|
|
3080
3381
|
createdDate?: Date | null;
|
|
3081
3382
|
/**
|
|
@@ -3201,291 +3502,157 @@ interface DraftPostTranslation {
|
|
|
3201
3502
|
/** Post URL. */
|
|
3202
3503
|
url?: PageUrl;
|
|
3203
3504
|
}
|
|
3204
|
-
interface
|
|
3205
|
-
createdEvent?: EntityCreatedEvent;
|
|
3206
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3207
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3208
|
-
actionEvent?: ActionEvent;
|
|
3209
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3210
|
-
id?: string;
|
|
3211
|
-
/**
|
|
3212
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3213
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3214
|
-
*/
|
|
3215
|
-
entityFqdn?: string;
|
|
3216
|
-
/**
|
|
3217
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3218
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3219
|
-
*/
|
|
3220
|
-
slug?: string;
|
|
3221
|
-
/** ID of the entity associated with the event. */
|
|
3222
|
-
entityId?: string;
|
|
3223
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3224
|
-
eventTime?: Date | null;
|
|
3225
|
-
/**
|
|
3226
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3227
|
-
* (for example, GDPR).
|
|
3228
|
-
*/
|
|
3229
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3230
|
-
/** If present, indicates the action that triggered the event. */
|
|
3231
|
-
originatedFrom?: string | null;
|
|
3232
|
-
/**
|
|
3233
|
-
* 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.
|
|
3234
|
-
* 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.
|
|
3235
|
-
*/
|
|
3236
|
-
entityEventSequence?: string | null;
|
|
3237
|
-
}
|
|
3238
|
-
/** @oneof */
|
|
3239
|
-
interface DomainEventBodyOneOf {
|
|
3240
|
-
createdEvent?: EntityCreatedEvent;
|
|
3241
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3242
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3243
|
-
actionEvent?: ActionEvent;
|
|
3244
|
-
}
|
|
3245
|
-
interface EntityCreatedEvent {
|
|
3246
|
-
entityAsJson?: string;
|
|
3247
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3248
|
-
restoreInfo?: RestoreInfo;
|
|
3249
|
-
}
|
|
3250
|
-
interface RestoreInfo {
|
|
3251
|
-
deletedDate?: Date | null;
|
|
3252
|
-
}
|
|
3253
|
-
interface EntityUpdatedEvent {
|
|
3254
|
-
/**
|
|
3255
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3256
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3257
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3258
|
-
*/
|
|
3259
|
-
currentEntityAsJson?: string;
|
|
3260
|
-
}
|
|
3261
|
-
interface EntityDeletedEvent {
|
|
3262
|
-
/** Entity that was deleted. */
|
|
3263
|
-
deletedEntityAsJson?: string | null;
|
|
3264
|
-
}
|
|
3265
|
-
interface ActionEvent {
|
|
3266
|
-
bodyAsJson?: string;
|
|
3267
|
-
}
|
|
3268
|
-
interface MessageEnvelope {
|
|
3269
|
-
/**
|
|
3270
|
-
* App instance ID.
|
|
3271
|
-
* @format GUID
|
|
3272
|
-
*/
|
|
3273
|
-
instanceId?: string | null;
|
|
3274
|
-
/**
|
|
3275
|
-
* Event type.
|
|
3276
|
-
* @maxLength 150
|
|
3277
|
-
*/
|
|
3278
|
-
eventType?: string;
|
|
3279
|
-
/** The identification type and identity data. */
|
|
3280
|
-
identity?: IdentificationData;
|
|
3281
|
-
/** Stringify payload. */
|
|
3282
|
-
data?: string;
|
|
3283
|
-
/** Details related to the account */
|
|
3284
|
-
accountInfo?: AccountInfo;
|
|
3285
|
-
}
|
|
3286
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3287
|
-
/**
|
|
3288
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3289
|
-
* @format GUID
|
|
3290
|
-
*/
|
|
3291
|
-
anonymousVisitorId?: string;
|
|
3292
|
-
/**
|
|
3293
|
-
* ID of a site visitor that has logged in to the site.
|
|
3294
|
-
* @format GUID
|
|
3295
|
-
*/
|
|
3296
|
-
memberId?: string;
|
|
3297
|
-
/**
|
|
3298
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3299
|
-
* @format GUID
|
|
3300
|
-
*/
|
|
3301
|
-
wixUserId?: string;
|
|
3302
|
-
/**
|
|
3303
|
-
* ID of an app.
|
|
3304
|
-
* @format GUID
|
|
3305
|
-
*/
|
|
3306
|
-
appId?: string;
|
|
3307
|
-
/** @readonly */
|
|
3308
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3309
|
-
}
|
|
3310
|
-
/** @oneof */
|
|
3311
|
-
interface IdentificationDataIdOneOf {
|
|
3312
|
-
/**
|
|
3313
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3314
|
-
* @format GUID
|
|
3315
|
-
*/
|
|
3316
|
-
anonymousVisitorId?: string;
|
|
3317
|
-
/**
|
|
3318
|
-
* ID of a site visitor that has logged in to the site.
|
|
3319
|
-
* @format GUID
|
|
3320
|
-
*/
|
|
3321
|
-
memberId?: string;
|
|
3322
|
-
/**
|
|
3323
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3324
|
-
* @format GUID
|
|
3325
|
-
*/
|
|
3326
|
-
wixUserId?: string;
|
|
3327
|
-
/**
|
|
3328
|
-
* ID of an app.
|
|
3329
|
-
* @format GUID
|
|
3330
|
-
*/
|
|
3331
|
-
appId?: string;
|
|
3332
|
-
}
|
|
3333
|
-
declare enum WebhookIdentityType {
|
|
3334
|
-
UNKNOWN = "UNKNOWN",
|
|
3335
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3336
|
-
MEMBER = "MEMBER",
|
|
3337
|
-
WIX_USER = "WIX_USER",
|
|
3338
|
-
APP = "APP"
|
|
3339
|
-
}
|
|
3340
|
-
/** @enumType */
|
|
3341
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3342
|
-
interface AccountInfo {
|
|
3343
|
-
/**
|
|
3344
|
-
* ID of the Wix account associated with the event.
|
|
3345
|
-
* @format GUID
|
|
3346
|
-
*/
|
|
3347
|
-
accountId?: string | null;
|
|
3348
|
-
/**
|
|
3349
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3350
|
-
* @format GUID
|
|
3351
|
-
*/
|
|
3352
|
-
parentAccountId?: string | null;
|
|
3353
|
-
/**
|
|
3354
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3355
|
-
* @format GUID
|
|
3356
|
-
*/
|
|
3357
|
-
siteId?: string | null;
|
|
3358
|
-
}
|
|
3359
|
-
/** Get Blog Publications Count Stats request */
|
|
3360
|
-
interface QueryPublicationsCountStatsRequest {
|
|
3361
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3362
|
-
rangeStart?: Date | null;
|
|
3363
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3364
|
-
rangeEnd?: Date | null;
|
|
3365
|
-
/** Order of the returned results. */
|
|
3366
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
3367
|
-
/** Number of months to include in the response. */
|
|
3368
|
-
months?: number;
|
|
3505
|
+
interface ListDemoPostsRequest {
|
|
3369
3506
|
/**
|
|
3370
|
-
*
|
|
3507
|
+
* Whether to return only featured posts.
|
|
3371
3508
|
*
|
|
3372
|
-
*
|
|
3373
|
-
* @format LANGUAGE_TAG
|
|
3509
|
+
* Default: `false`
|
|
3374
3510
|
*/
|
|
3375
|
-
|
|
3511
|
+
featured?: boolean;
|
|
3376
3512
|
/**
|
|
3377
|
-
*
|
|
3378
|
-
*
|
|
3513
|
+
* Hashtag filter.
|
|
3514
|
+
*
|
|
3515
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3516
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3517
|
+
* @maxSize 100
|
|
3379
3518
|
* @maxLength 100
|
|
3380
3519
|
*/
|
|
3381
|
-
|
|
3382
|
-
}
|
|
3383
|
-
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3384
|
-
UNKNOWN = "UNKNOWN",
|
|
3385
|
-
OLDEST = "OLDEST",
|
|
3386
|
-
NEWEST = "NEWEST"
|
|
3387
|
-
}
|
|
3388
|
-
/** @enumType */
|
|
3389
|
-
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3390
|
-
/** Get Blog Publications Count Stats response */
|
|
3391
|
-
interface QueryPublicationsCountStatsResponse {
|
|
3392
|
-
/** Chronologically ordered list of publications. */
|
|
3393
|
-
stats?: PeriodPublicationsCount[];
|
|
3394
|
-
}
|
|
3395
|
-
/** Publications count for a specific time period */
|
|
3396
|
-
interface PeriodPublicationsCount {
|
|
3397
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3398
|
-
periodStart?: Date | null;
|
|
3399
|
-
/** Number of posts published during this month. */
|
|
3400
|
-
publicationsCount?: number;
|
|
3401
|
-
}
|
|
3402
|
-
/** Get Blog Post Count Stats request */
|
|
3403
|
-
interface QueryPostCountStatsRequest {
|
|
3404
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3405
|
-
rangeStart?: Date | null;
|
|
3520
|
+
hashtags?: string[];
|
|
3406
3521
|
/**
|
|
3407
|
-
*
|
|
3408
|
-
*
|
|
3409
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
3410
|
-
* - `NEWEST`: posts by date in descending order.
|
|
3522
|
+
* Category filter.
|
|
3411
3523
|
*
|
|
3412
|
-
*
|
|
3524
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3525
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3526
|
+
* @maxSize 50
|
|
3527
|
+
* @format GUID
|
|
3413
3528
|
*/
|
|
3414
|
-
|
|
3415
|
-
/** Number of months to include in response. */
|
|
3416
|
-
months?: number;
|
|
3529
|
+
categoryIds?: string[];
|
|
3417
3530
|
/**
|
|
3418
|
-
*
|
|
3531
|
+
* Tag filter.
|
|
3419
3532
|
*
|
|
3420
|
-
*
|
|
3421
|
-
*
|
|
3422
|
-
* @
|
|
3533
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3534
|
+
* If omitted, all posts with or without tags are returned.
|
|
3535
|
+
* @maxSize 50
|
|
3536
|
+
* @format GUID
|
|
3423
3537
|
*/
|
|
3424
|
-
|
|
3538
|
+
tagIds?: string[];
|
|
3425
3539
|
/**
|
|
3426
|
-
*
|
|
3540
|
+
* Sorting options.
|
|
3427
3541
|
*
|
|
3428
|
-
*
|
|
3429
|
-
*
|
|
3430
|
-
*
|
|
3542
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3543
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3544
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3545
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3546
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3547
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3548
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3549
|
+
* - `RATING`: reserved for internal use.
|
|
3550
|
+
*
|
|
3551
|
+
* Default: `FEED`
|
|
3431
3552
|
*/
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
UNKNOWN = "UNKNOWN",
|
|
3436
|
-
OLDEST = "OLDEST",
|
|
3437
|
-
NEWEST = "NEWEST"
|
|
3438
|
-
}
|
|
3439
|
-
/** @enumType */
|
|
3440
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3441
|
-
/** Get Blog Post Count Stats response */
|
|
3442
|
-
interface QueryPostCountStatsResponse {
|
|
3443
|
-
/** List of published post counts by month. */
|
|
3444
|
-
stats?: PeriodPostCount[];
|
|
3445
|
-
}
|
|
3446
|
-
/** Post count for a specific time period */
|
|
3447
|
-
interface PeriodPostCount {
|
|
3448
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3449
|
-
periodStart?: Date | null;
|
|
3450
|
-
/** Number of posts published during this month. */
|
|
3451
|
-
postCount?: number;
|
|
3452
|
-
}
|
|
3453
|
-
interface GetTotalPublicationsRequest {
|
|
3553
|
+
sort?: GetPostsSortWithLiterals;
|
|
3554
|
+
/** Pagination options. */
|
|
3555
|
+
paging?: BlogPaging;
|
|
3454
3556
|
/**
|
|
3455
|
-
*
|
|
3456
|
-
*
|
|
3457
|
-
*
|
|
3557
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
3558
|
+
* This parameter will be removed on June 30, 2023.
|
|
3559
|
+
*
|
|
3560
|
+
* List of post fields to be included in the response.
|
|
3561
|
+
* @maxSize 20
|
|
3562
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3563
|
+
* This parameter will be removed on June 30, 2023.
|
|
3564
|
+
*
|
|
3565
|
+
* List of post fields to be included in the response.
|
|
3566
|
+
* @replacedBy fieldsets
|
|
3567
|
+
* @targetRemovalDate 2024-06-30
|
|
3458
3568
|
*/
|
|
3459
|
-
|
|
3460
|
-
}
|
|
3461
|
-
interface GetTotalPublicationsResponse {
|
|
3462
|
-
/** Total amount of publications. */
|
|
3463
|
-
total?: number;
|
|
3464
|
-
}
|
|
3465
|
-
interface GetTotalPostsRequest {
|
|
3569
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3466
3570
|
/**
|
|
3467
3571
|
* Language filter.
|
|
3468
3572
|
*
|
|
3469
3573
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3470
|
-
* Pass a language to receive
|
|
3574
|
+
* Pass a language to only receive posts that are in that language.
|
|
3575
|
+
* If omitted, posts in all languages are returned.
|
|
3471
3576
|
* @format LANGUAGE_TAG
|
|
3472
3577
|
*/
|
|
3473
3578
|
language?: string | null;
|
|
3579
|
+
/**
|
|
3580
|
+
* Post owner's member ID.
|
|
3581
|
+
* @format GUID
|
|
3582
|
+
*/
|
|
3583
|
+
memberId?: string | null;
|
|
3584
|
+
/**
|
|
3585
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3586
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3587
|
+
* only the post’s base fields are returned.
|
|
3588
|
+
* @maxSize 20
|
|
3589
|
+
*/
|
|
3590
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3474
3591
|
}
|
|
3475
|
-
|
|
3476
|
-
/**
|
|
3477
|
-
|
|
3592
|
+
declare enum GetPostsSort {
|
|
3593
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3594
|
+
FEED = "FEED",
|
|
3595
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3596
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3597
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3598
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3599
|
+
/** Ordered by total number of views in descending order. */
|
|
3600
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3601
|
+
/** Ordered by total number of likes in descending order. */
|
|
3602
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3603
|
+
/** Ordered by `title` in ascending order. */
|
|
3604
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3605
|
+
/** Ordered by `title` in descending order. */
|
|
3606
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3478
3607
|
}
|
|
3479
|
-
|
|
3608
|
+
/** @enumType */
|
|
3609
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3610
|
+
declare enum PostFieldField {
|
|
3611
|
+
UNKNOWN = "UNKNOWN",
|
|
3612
|
+
/** Includes post URL when present. */
|
|
3613
|
+
URL = "URL",
|
|
3614
|
+
/** Includes post content text string when present. */
|
|
3615
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3616
|
+
/** Includes post metrics when present. */
|
|
3617
|
+
METRICS = "METRICS",
|
|
3618
|
+
/** Includes SEO data. */
|
|
3619
|
+
SEO = "SEO",
|
|
3620
|
+
/** Includes post owner's contact ID. */
|
|
3621
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3622
|
+
/** Includes post rich content. */
|
|
3623
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3624
|
+
/** Includes post reference ID field. */
|
|
3625
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3626
|
+
}
|
|
3627
|
+
/** @enumType */
|
|
3628
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3629
|
+
interface ListDemoPostsResponse {
|
|
3630
|
+
/** List of posts. */
|
|
3631
|
+
posts?: Post[];
|
|
3632
|
+
/** Details on the paged set of results returned. */
|
|
3633
|
+
metaData?: MetaData;
|
|
3634
|
+
}
|
|
3635
|
+
interface ConvertDraftJsToRichContentRequest {
|
|
3636
|
+
/** DraftJs content to convert to Rich content. */
|
|
3637
|
+
content?: Record<string, any> | null;
|
|
3638
|
+
}
|
|
3639
|
+
interface ConvertDraftJsToRichContentResponse {
|
|
3480
3640
|
/**
|
|
3481
|
-
*
|
|
3482
|
-
* @
|
|
3641
|
+
* Rich content converted from DraftJs content.
|
|
3642
|
+
* @maxLength 2000000
|
|
3483
3643
|
*/
|
|
3484
|
-
|
|
3644
|
+
richContent?: string;
|
|
3485
3645
|
}
|
|
3486
|
-
interface
|
|
3487
|
-
/**
|
|
3488
|
-
|
|
3646
|
+
interface ConvertRichContentToDraftJsRequest {
|
|
3647
|
+
/**
|
|
3648
|
+
* Rich content to convert to DraftJs content.
|
|
3649
|
+
* @maxLength 2000000
|
|
3650
|
+
*/
|
|
3651
|
+
richContent?: string;
|
|
3652
|
+
}
|
|
3653
|
+
interface ConvertRichContentToDraftJsResponse {
|
|
3654
|
+
/** DraftJs content converted from Rich content. */
|
|
3655
|
+
content?: Record<string, any> | null;
|
|
3489
3656
|
}
|
|
3490
3657
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3491
3658
|
/**
|
|
@@ -3556,25 +3723,6 @@ interface GetPostRequest {
|
|
|
3556
3723
|
*/
|
|
3557
3724
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3558
3725
|
}
|
|
3559
|
-
declare enum PostFieldField {
|
|
3560
|
-
UNKNOWN = "UNKNOWN",
|
|
3561
|
-
/** Includes post URL when present. */
|
|
3562
|
-
URL = "URL",
|
|
3563
|
-
/** Includes post content text string when present. */
|
|
3564
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3565
|
-
/** Includes post metrics when present. */
|
|
3566
|
-
METRICS = "METRICS",
|
|
3567
|
-
/** Includes SEO data. */
|
|
3568
|
-
SEO = "SEO",
|
|
3569
|
-
/** Includes post owner's contact ID. */
|
|
3570
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3571
|
-
/** Includes post rich content. */
|
|
3572
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3573
|
-
/** Includes post reference ID field. */
|
|
3574
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3575
|
-
}
|
|
3576
|
-
/** @enumType */
|
|
3577
|
-
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3578
3726
|
interface GetPostResponse {
|
|
3579
3727
|
/** Retrieved post info. */
|
|
3580
3728
|
post?: Post;
|
|
@@ -3667,24 +3815,6 @@ interface ListPostsRequest {
|
|
|
3667
3815
|
*/
|
|
3668
3816
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3669
3817
|
}
|
|
3670
|
-
declare enum GetPostsSort {
|
|
3671
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3672
|
-
FEED = "FEED",
|
|
3673
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3674
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3675
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3676
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3677
|
-
/** Ordered by total number of views in descending order. */
|
|
3678
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3679
|
-
/** Ordered by total number of likes in descending order. */
|
|
3680
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3681
|
-
/** Ordered by `title` in ascending order. */
|
|
3682
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3683
|
-
/** Ordered by `title` in descending order. */
|
|
3684
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3685
|
-
}
|
|
3686
|
-
/** @enumType */
|
|
3687
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3688
3818
|
interface ListPostsResponse {
|
|
3689
3819
|
/** List of retrieved posts. */
|
|
3690
3820
|
posts?: Post[];
|
|
@@ -4034,121 +4164,6 @@ interface PostCount {
|
|
|
4034
4164
|
/** Number of posts. */
|
|
4035
4165
|
postCount?: number;
|
|
4036
4166
|
}
|
|
4037
|
-
interface ListDemoPostsRequest {
|
|
4038
|
-
/**
|
|
4039
|
-
* Whether to return only featured posts.
|
|
4040
|
-
*
|
|
4041
|
-
* Default: `false`
|
|
4042
|
-
*/
|
|
4043
|
-
featured?: boolean;
|
|
4044
|
-
/**
|
|
4045
|
-
* Hashtag filter.
|
|
4046
|
-
*
|
|
4047
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4048
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
4049
|
-
* @maxSize 100
|
|
4050
|
-
* @maxLength 100
|
|
4051
|
-
*/
|
|
4052
|
-
hashtags?: string[];
|
|
4053
|
-
/**
|
|
4054
|
-
* Category filter.
|
|
4055
|
-
*
|
|
4056
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4057
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
4058
|
-
* @maxSize 50
|
|
4059
|
-
* @format GUID
|
|
4060
|
-
*/
|
|
4061
|
-
categoryIds?: string[];
|
|
4062
|
-
/**
|
|
4063
|
-
* Tag filter.
|
|
4064
|
-
*
|
|
4065
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4066
|
-
* If omitted, all posts with or without tags are returned.
|
|
4067
|
-
* @maxSize 50
|
|
4068
|
-
* @format GUID
|
|
4069
|
-
*/
|
|
4070
|
-
tagIds?: string[];
|
|
4071
|
-
/**
|
|
4072
|
-
* Sorting options.
|
|
4073
|
-
*
|
|
4074
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4075
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4076
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4077
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4078
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4079
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4080
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4081
|
-
* - `RATING`: reserved for internal use.
|
|
4082
|
-
*
|
|
4083
|
-
* Default: `FEED`
|
|
4084
|
-
*/
|
|
4085
|
-
sort?: GetPostsSortWithLiterals;
|
|
4086
|
-
/** Pagination options. */
|
|
4087
|
-
paging?: BlogPaging;
|
|
4088
|
-
/**
|
|
4089
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
4090
|
-
* This parameter will be removed on June 30, 2023.
|
|
4091
|
-
*
|
|
4092
|
-
* List of post fields to be included in the response.
|
|
4093
|
-
* @maxSize 20
|
|
4094
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4095
|
-
* This parameter will be removed on June 30, 2023.
|
|
4096
|
-
*
|
|
4097
|
-
* List of post fields to be included in the response.
|
|
4098
|
-
* @replacedBy fieldsets
|
|
4099
|
-
* @targetRemovalDate 2024-06-30
|
|
4100
|
-
*/
|
|
4101
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4102
|
-
/**
|
|
4103
|
-
* Language filter.
|
|
4104
|
-
*
|
|
4105
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4106
|
-
* Pass a language to only receive posts that are in that language.
|
|
4107
|
-
* If omitted, posts in all languages are returned.
|
|
4108
|
-
* @format LANGUAGE_TAG
|
|
4109
|
-
*/
|
|
4110
|
-
language?: string | null;
|
|
4111
|
-
/**
|
|
4112
|
-
* Post owner's member ID.
|
|
4113
|
-
* @format GUID
|
|
4114
|
-
*/
|
|
4115
|
-
memberId?: string | null;
|
|
4116
|
-
/**
|
|
4117
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4118
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4119
|
-
* only the post’s base fields are returned.
|
|
4120
|
-
* @maxSize 20
|
|
4121
|
-
*/
|
|
4122
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4123
|
-
}
|
|
4124
|
-
interface ListDemoPostsResponse {
|
|
4125
|
-
/** List of posts. */
|
|
4126
|
-
posts?: Post[];
|
|
4127
|
-
/** Details on the paged set of results returned. */
|
|
4128
|
-
metaData?: MetaData;
|
|
4129
|
-
}
|
|
4130
|
-
interface ConvertDraftJsToRichContentRequest {
|
|
4131
|
-
/** DraftJs content to convert to Rich content. */
|
|
4132
|
-
content?: Record<string, any> | null;
|
|
4133
|
-
}
|
|
4134
|
-
interface ConvertDraftJsToRichContentResponse {
|
|
4135
|
-
/**
|
|
4136
|
-
* Rich content converted from DraftJs content.
|
|
4137
|
-
* @maxLength 2000000
|
|
4138
|
-
*/
|
|
4139
|
-
richContent?: string;
|
|
4140
|
-
}
|
|
4141
|
-
interface ConvertRichContentToDraftJsRequest {
|
|
4142
|
-
/**
|
|
4143
|
-
* Rich content to convert to DraftJs content.
|
|
4144
|
-
* @maxLength 2000000
|
|
4145
|
-
*/
|
|
4146
|
-
richContent?: string;
|
|
4147
|
-
}
|
|
4148
|
-
interface ConvertRichContentToDraftJsResponse {
|
|
4149
|
-
/** DraftJs content converted from Rich content. */
|
|
4150
|
-
content?: Record<string, any> | null;
|
|
4151
|
-
}
|
|
4152
4167
|
|
|
4153
4168
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4154
4169
|
getUrl: (context: any) => string;
|