@wix/auto_sdk_blog_posts 1.0.164 → 1.0.166
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +15 -11
- package/build/cjs/index.js +98 -45
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +380 -209
- package/build/cjs/index.typings.js +84 -36
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +346 -192
- package/build/cjs/meta.js +78 -30
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +86 -84
- package/build/cjs/schemas.js +153 -147
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +15 -11
- package/build/es/index.mjs +86 -36
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +380 -209
- package/build/es/index.typings.mjs +76 -31
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +346 -192
- package/build/es/meta.mjs +70 -25
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +86 -84
- package/build/es/schemas.mjs +153 -147
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +15 -11
- package/build/internal/cjs/index.js +98 -45
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +380 -209
- package/build/internal/cjs/index.typings.js +84 -36
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +346 -192
- package/build/internal/cjs/meta.js +78 -30
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +86 -84
- package/build/internal/cjs/schemas.js +153 -147
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +15 -11
- package/build/internal/es/index.mjs +86 -36
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +380 -209
- package/build/internal/es/index.typings.mjs +76 -31
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +346 -192
- package/build/internal/es/meta.mjs +70 -25
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +86 -84
- package/build/internal/es/schemas.mjs +153 -147
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -480,6 +480,8 @@ interface ButtonData {
|
|
|
480
480
|
text?: string | null;
|
|
481
481
|
/** Button link details. */
|
|
482
482
|
link?: Link;
|
|
483
|
+
/** Node animation. */
|
|
484
|
+
animation?: Animation;
|
|
483
485
|
}
|
|
484
486
|
/** Background type */
|
|
485
487
|
declare enum BackgroundType {
|
|
@@ -756,9 +758,90 @@ interface Rel {
|
|
|
756
758
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
757
759
|
noreferrer?: boolean | null;
|
|
758
760
|
}
|
|
761
|
+
interface Animation {
|
|
762
|
+
/** Animation kind. */
|
|
763
|
+
type?: TypeWithLiterals;
|
|
764
|
+
/** Entrance animation, played once when the node first enters the viewport. */
|
|
765
|
+
entrance?: EntranceAnimation;
|
|
766
|
+
}
|
|
767
|
+
declare enum Type {
|
|
768
|
+
/** Animations that play while the node is in view. */
|
|
769
|
+
VIEW = "VIEW"
|
|
770
|
+
}
|
|
771
|
+
/** @enumType */
|
|
772
|
+
type TypeWithLiterals = Type | 'VIEW';
|
|
773
|
+
interface EntranceAnimation {
|
|
774
|
+
/** The entrance effect to play. */
|
|
775
|
+
effect?: EntranceEffect;
|
|
776
|
+
/** Effect duration in milliseconds. Each effect has its own default. */
|
|
777
|
+
duration?: number | null;
|
|
778
|
+
/** Delay before the effect starts, in milliseconds. */
|
|
779
|
+
delay?: number | null;
|
|
780
|
+
}
|
|
781
|
+
interface EntranceEffect {
|
|
782
|
+
/** The entrance effect type. */
|
|
783
|
+
type?: EntranceEffectTypeWithLiterals;
|
|
784
|
+
/**
|
|
785
|
+
* Direction the effect enters from. Allowed values depend on the effect type (e.g. TOP/RIGHT/BOTTOM/LEFT, the diagonals with or without CENTER, corners, HORIZONTAL/VERTICAL, CLOCKWISE/COUNTER_CLOCKWISE).
|
|
786
|
+
* @maxLength 20
|
|
787
|
+
*/
|
|
788
|
+
direction?: string | null;
|
|
789
|
+
/**
|
|
790
|
+
* Clip-path shape: ELLIPSE, CIRCLE, RECTANGLE, or DIAMOND (SHAPE).
|
|
791
|
+
* @maxLength 12
|
|
792
|
+
*/
|
|
793
|
+
shape?: string | null;
|
|
794
|
+
/**
|
|
795
|
+
* Motion style: GENTLE, MODERATE, or INTENSE. Only the effects that expose one accept it.
|
|
796
|
+
* @maxLength 100
|
|
797
|
+
*/
|
|
798
|
+
easing?: string | null;
|
|
799
|
+
}
|
|
800
|
+
declare enum EntranceEffectType {
|
|
801
|
+
/** Fades in from fully transparent to fully opaque. */
|
|
802
|
+
FADE = "FADE",
|
|
803
|
+
/** Enters along a 3D arc path. */
|
|
804
|
+
ARC = "ARC",
|
|
805
|
+
/** Transitions from blurred to sharp. */
|
|
806
|
+
BLUR = "BLUR",
|
|
807
|
+
/** Bounces into place with an elastic curve. */
|
|
808
|
+
BOUNCE = "BOUNCE",
|
|
809
|
+
/** Shrinks down from a larger size. */
|
|
810
|
+
DROP = "DROP",
|
|
811
|
+
/** Expands from a point, scaling to full size. */
|
|
812
|
+
EXPAND = "EXPAND",
|
|
813
|
+
/** Flips into view with a 3D rotation. */
|
|
814
|
+
FLIP = "FLIP",
|
|
815
|
+
/** Drifts gently into place. */
|
|
816
|
+
FLOAT = "FLOAT",
|
|
817
|
+
/** Unfolds from an edge as if hinged. */
|
|
818
|
+
FOLD = "FOLD",
|
|
819
|
+
/** Glides in smoothly from off-screen. */
|
|
820
|
+
GLIDE = "GLIDE",
|
|
821
|
+
/** Progressively revealed by an expanding clip-path. */
|
|
822
|
+
REVEAL = "REVEAL",
|
|
823
|
+
/** Appears through an expanding geometric clip-path shape. */
|
|
824
|
+
SHAPE = "SHAPE",
|
|
825
|
+
/** Revealed through shutter-like strips. */
|
|
826
|
+
SHUTTERS = "SHUTTERS",
|
|
827
|
+
/** Slides in from one side. */
|
|
828
|
+
SLIDE = "SLIDE",
|
|
829
|
+
/** Spins into view while scaling up. */
|
|
830
|
+
SPIN = "SPIN",
|
|
831
|
+
/** Tilts in from the side with 3D rotation. */
|
|
832
|
+
TILT = "TILT",
|
|
833
|
+
/** Rotates into view around a corner pivot. */
|
|
834
|
+
TURN = "TURN",
|
|
835
|
+
/** Expands from its horizontal or vertical center. */
|
|
836
|
+
WINK = "WINK"
|
|
837
|
+
}
|
|
838
|
+
/** @enumType */
|
|
839
|
+
type EntranceEffectTypeWithLiterals = EntranceEffectType | 'FADE' | 'ARC' | 'BLUR' | 'BOUNCE' | 'DROP' | 'EXPAND' | 'FLIP' | 'FLOAT' | 'FOLD' | 'GLIDE' | 'REVEAL' | 'SHAPE' | 'SHUTTERS' | 'SLIDE' | 'SPIN' | 'TILT' | 'TURN' | 'WINK';
|
|
759
840
|
interface CodeBlockData {
|
|
760
841
|
/** Styling for the code block's text. */
|
|
761
842
|
textStyle?: TextStyle;
|
|
843
|
+
/** Node animation. */
|
|
844
|
+
animation?: Animation;
|
|
762
845
|
}
|
|
763
846
|
interface TextStyle {
|
|
764
847
|
/** Text alignment. Defaults to `AUTO`. */
|
|
@@ -789,7 +872,19 @@ interface DividerData {
|
|
|
789
872
|
width?: WidthWithLiterals;
|
|
790
873
|
/** Divider alignment. */
|
|
791
874
|
alignment?: DividerDataAlignmentWithLiterals;
|
|
875
|
+
/** Visual styling for the divider lines. */
|
|
876
|
+
styles?: DividerDataStyles;
|
|
877
|
+
/** Node animation. */
|
|
878
|
+
animation?: Animation;
|
|
879
|
+
}
|
|
880
|
+
declare enum LineCap {
|
|
881
|
+
/** Square line endings. */
|
|
882
|
+
SQUARE = "SQUARE",
|
|
883
|
+
/** Rounded line endings. */
|
|
884
|
+
ROUND = "ROUND"
|
|
792
885
|
}
|
|
886
|
+
/** @enumType */
|
|
887
|
+
type LineCapWithLiterals = LineCap | 'SQUARE' | 'ROUND';
|
|
793
888
|
declare enum LineStyle {
|
|
794
889
|
/** Single Line */
|
|
795
890
|
SINGLE = "SINGLE",
|
|
@@ -822,6 +917,26 @@ declare enum DividerDataAlignment {
|
|
|
822
917
|
}
|
|
823
918
|
/** @enumType */
|
|
824
919
|
type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
920
|
+
interface DividerDataStyles {
|
|
921
|
+
/**
|
|
922
|
+
* Divider color as a hexadecimal value. An alpha channel controls opacity.
|
|
923
|
+
* @maxLength 19
|
|
924
|
+
*/
|
|
925
|
+
color?: string | null;
|
|
926
|
+
/** Divider line ending shape. */
|
|
927
|
+
lineCap?: LineCapWithLiterals;
|
|
928
|
+
/**
|
|
929
|
+
* Line thicknesses in pixels, ordered from first line to last line.
|
|
930
|
+
* @maxSize 10
|
|
931
|
+
*/
|
|
932
|
+
lineThickness?: number[];
|
|
933
|
+
/** Visible dash length for dashed dividers, in pixels. The pattern is snapped to a whole number of dashes so that the first and last dash touch the divider's edges - narrower containers show fewer dashes at the same size. */
|
|
934
|
+
dashLength?: number | null;
|
|
935
|
+
/** Visible gap between dashes or dots, in pixels. */
|
|
936
|
+
dashGap?: number | null;
|
|
937
|
+
/** Gap between divider lines in pixels. */
|
|
938
|
+
lineGap?: number | null;
|
|
939
|
+
}
|
|
825
940
|
interface FileData {
|
|
826
941
|
/** Styling for the file's container. */
|
|
827
942
|
containerData?: PluginContainerData;
|
|
@@ -844,6 +959,8 @@ interface FileData {
|
|
|
844
959
|
path?: string | null;
|
|
845
960
|
/** File size in KB. */
|
|
846
961
|
sizeInKb?: string | null;
|
|
962
|
+
/** Node animation. */
|
|
963
|
+
animation?: Animation;
|
|
847
964
|
}
|
|
848
965
|
declare enum ViewMode {
|
|
849
966
|
/** No PDF view */
|
|
@@ -904,6 +1021,8 @@ interface GalleryData {
|
|
|
904
1021
|
disableExpand?: boolean | null;
|
|
905
1022
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
906
1023
|
disableDownload?: boolean | null;
|
|
1024
|
+
/** Node animation. */
|
|
1025
|
+
animation?: Animation;
|
|
907
1026
|
}
|
|
908
1027
|
interface V1Media {
|
|
909
1028
|
/** The source for the media's data. */
|
|
@@ -1047,6 +1166,8 @@ interface GIFData {
|
|
|
1047
1166
|
width?: number;
|
|
1048
1167
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1049
1168
|
gifType?: GIFTypeWithLiterals;
|
|
1169
|
+
/** Node animation. */
|
|
1170
|
+
animation?: Animation;
|
|
1050
1171
|
}
|
|
1051
1172
|
interface GIF {
|
|
1052
1173
|
/**
|
|
@@ -1080,6 +1201,8 @@ interface HeadingData {
|
|
|
1080
1201
|
indentation?: number | null;
|
|
1081
1202
|
/** Rendered heading level for SEO/accessibility, overrides the HTML tag when set. */
|
|
1082
1203
|
renderedLevel?: number | null;
|
|
1204
|
+
/** Node animation. */
|
|
1205
|
+
animation?: Animation;
|
|
1083
1206
|
}
|
|
1084
1207
|
interface HTMLData extends HTMLDataDataOneOf {
|
|
1085
1208
|
/** The URL for the HTML code for the node. */
|
|
@@ -1099,6 +1222,8 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1099
1222
|
source?: SourceWithLiterals;
|
|
1100
1223
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1101
1224
|
autoHeight?: boolean | null;
|
|
1225
|
+
/** Node animation. */
|
|
1226
|
+
animation?: Animation;
|
|
1102
1227
|
}
|
|
1103
1228
|
/** @oneof */
|
|
1104
1229
|
interface HTMLDataDataOneOf {
|
|
@@ -1146,6 +1271,10 @@ interface ImageData {
|
|
|
1146
1271
|
styles?: ImageDataStyles;
|
|
1147
1272
|
/** Non-destructive crop rectangle, expressed as fractions (0-1) of the original image. When omitted, the full image is shown. */
|
|
1148
1273
|
crop?: ImageDataCrop;
|
|
1274
|
+
/** Optional shape mask applied to the visible crop. Supported values: CIRCLE, OVAL, STAR, PENTAGON, HEXAGON, TRIANGLE, HEART, RHOMBUS, FLUID, WINDOW. */
|
|
1275
|
+
cropShape?: string | null;
|
|
1276
|
+
/** Node animation. */
|
|
1277
|
+
animation?: Animation;
|
|
1149
1278
|
}
|
|
1150
1279
|
interface StylesBorder {
|
|
1151
1280
|
/** Border width in pixels. */
|
|
@@ -1187,6 +1316,8 @@ interface LinkPreviewData {
|
|
|
1187
1316
|
html?: string | null;
|
|
1188
1317
|
/** Styling for the link preview. */
|
|
1189
1318
|
styles?: LinkPreviewDataStyles;
|
|
1319
|
+
/** Node animation. */
|
|
1320
|
+
animation?: Animation;
|
|
1190
1321
|
}
|
|
1191
1322
|
declare enum StylesPosition {
|
|
1192
1323
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
@@ -1282,6 +1413,8 @@ interface ParagraphData {
|
|
|
1282
1413
|
indentation?: number | null;
|
|
1283
1414
|
/** Paragraph level */
|
|
1284
1415
|
level?: number | null;
|
|
1416
|
+
/** Node animation. */
|
|
1417
|
+
animation?: Animation;
|
|
1285
1418
|
}
|
|
1286
1419
|
interface PollData {
|
|
1287
1420
|
/** Styling for the poll's container. */
|
|
@@ -1292,6 +1425,8 @@ interface PollData {
|
|
|
1292
1425
|
layout?: PollDataLayout;
|
|
1293
1426
|
/** Styling for the poll and voting options. */
|
|
1294
1427
|
design?: Design;
|
|
1428
|
+
/** Node animation. */
|
|
1429
|
+
animation?: Animation;
|
|
1295
1430
|
}
|
|
1296
1431
|
declare enum ViewRole {
|
|
1297
1432
|
/** Only Poll creator can view the results */
|
|
@@ -1650,6 +1785,8 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1650
1785
|
containerData?: PluginContainerData;
|
|
1651
1786
|
/** Pricing data for embedded Wix App content. */
|
|
1652
1787
|
pricingData?: PricingData;
|
|
1788
|
+
/** Node animation. */
|
|
1789
|
+
animation?: Animation;
|
|
1653
1790
|
}
|
|
1654
1791
|
/** @oneof */
|
|
1655
1792
|
interface AppEmbedDataAppDataOneOf {
|
|
@@ -1692,14 +1829,14 @@ declare enum Placement {
|
|
|
1692
1829
|
}
|
|
1693
1830
|
/** @enumType */
|
|
1694
1831
|
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
|
|
1695
|
-
declare enum
|
|
1832
|
+
declare enum CardStylesType {
|
|
1696
1833
|
/** Card with visible border and background */
|
|
1697
1834
|
CONTAINED = "CONTAINED",
|
|
1698
1835
|
/** Card without visible border */
|
|
1699
1836
|
FRAMELESS = "FRAMELESS"
|
|
1700
1837
|
}
|
|
1701
1838
|
/** @enumType */
|
|
1702
|
-
type
|
|
1839
|
+
type CardStylesTypeWithLiterals = CardStylesType | 'CONTAINED' | 'FRAMELESS';
|
|
1703
1840
|
declare enum Alignment {
|
|
1704
1841
|
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
|
|
1705
1842
|
START = "START",
|
|
@@ -1835,7 +1972,7 @@ interface CardStyles {
|
|
|
1835
1972
|
/** Card border radius in pixels. */
|
|
1836
1973
|
borderRadius?: number | null;
|
|
1837
1974
|
/** Card type. Defaults to `CONTAINED`. */
|
|
1838
|
-
type?:
|
|
1975
|
+
type?: CardStylesTypeWithLiterals;
|
|
1839
1976
|
/** Content alignment. Defaults to `START`. */
|
|
1840
1977
|
alignment?: AlignmentWithLiterals;
|
|
1841
1978
|
/** Layout for title and price. Defaults to `STACKED`. */
|
|
@@ -1891,6 +2028,8 @@ interface VideoData {
|
|
|
1891
2028
|
title?: string | null;
|
|
1892
2029
|
/** Video options. */
|
|
1893
2030
|
options?: PlaybackOptions;
|
|
2031
|
+
/** Node animation. */
|
|
2032
|
+
animation?: Animation;
|
|
1894
2033
|
}
|
|
1895
2034
|
interface PlaybackOptions {
|
|
1896
2035
|
/** Sets whether the media will automatically start playing. */
|
|
@@ -1907,6 +2046,8 @@ interface EmbedData {
|
|
|
1907
2046
|
oembed?: Oembed;
|
|
1908
2047
|
/** Origin asset source. */
|
|
1909
2048
|
src?: string | null;
|
|
2049
|
+
/** Node animation. */
|
|
2050
|
+
animation?: Animation;
|
|
1910
2051
|
}
|
|
1911
2052
|
interface Oembed {
|
|
1912
2053
|
/** The resource type. */
|
|
@@ -1951,6 +2092,8 @@ interface CollapsibleListData {
|
|
|
1951
2092
|
direction?: DirectionWithLiterals;
|
|
1952
2093
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1953
2094
|
isQapageData?: boolean | null;
|
|
2095
|
+
/** Node animation. */
|
|
2096
|
+
animation?: Animation;
|
|
1954
2097
|
}
|
|
1955
2098
|
declare enum InitialExpandedItems {
|
|
1956
2099
|
/** First item will be expended initally */
|
|
@@ -1993,6 +2136,8 @@ interface TableData {
|
|
|
1993
2136
|
cellPadding?: number[];
|
|
1994
2137
|
/** Table's alternative text. */
|
|
1995
2138
|
altText?: string | null;
|
|
2139
|
+
/** Node animation. */
|
|
2140
|
+
animation?: Animation;
|
|
1996
2141
|
}
|
|
1997
2142
|
interface Dimensions {
|
|
1998
2143
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
@@ -2101,6 +2246,8 @@ interface AudioData {
|
|
|
2101
2246
|
authorName?: string | null;
|
|
2102
2247
|
/** An HTML version of the audio node. */
|
|
2103
2248
|
html?: string | null;
|
|
2249
|
+
/** Node animation. */
|
|
2250
|
+
animation?: Animation;
|
|
2104
2251
|
}
|
|
2105
2252
|
interface OrderedListData {
|
|
2106
2253
|
/** Indentation level from 0-4. */
|
|
@@ -2109,16 +2256,22 @@ interface OrderedListData {
|
|
|
2109
2256
|
offset?: number | null;
|
|
2110
2257
|
/** List start number. */
|
|
2111
2258
|
start?: number | null;
|
|
2259
|
+
/** Node animation. */
|
|
2260
|
+
animation?: Animation;
|
|
2112
2261
|
}
|
|
2113
2262
|
interface BulletedListData {
|
|
2114
2263
|
/** Indentation level from 0-4. */
|
|
2115
2264
|
indentation?: number;
|
|
2116
2265
|
/** Offset level from 0-4. */
|
|
2117
2266
|
offset?: number | null;
|
|
2267
|
+
/** Node animation. */
|
|
2268
|
+
animation?: Animation;
|
|
2118
2269
|
}
|
|
2119
2270
|
interface BlockquoteData {
|
|
2120
2271
|
/** Indentation level from 1-4. */
|
|
2121
2272
|
indentation?: number;
|
|
2273
|
+
/** Node animation. */
|
|
2274
|
+
animation?: Animation;
|
|
2122
2275
|
}
|
|
2123
2276
|
interface CaptionData {
|
|
2124
2277
|
textStyle?: TextStyle;
|
|
@@ -2176,6 +2329,8 @@ interface LayoutData {
|
|
|
2176
2329
|
background?: LayoutDataBackground;
|
|
2177
2330
|
/** Backdrop styling (color or gradient). */
|
|
2178
2331
|
backdrop?: Backdrop;
|
|
2332
|
+
/** Node animation. */
|
|
2333
|
+
animation?: Animation;
|
|
2179
2334
|
}
|
|
2180
2335
|
declare enum ImageScalingScaling {
|
|
2181
2336
|
/** Auto image scaling */
|
|
@@ -2327,6 +2482,8 @@ interface ShapeData {
|
|
|
2327
2482
|
shape?: V1Media;
|
|
2328
2483
|
/** Styling for the shape. */
|
|
2329
2484
|
styles?: ShapeDataStyles;
|
|
2485
|
+
/** Node animation. */
|
|
2486
|
+
animation?: Animation;
|
|
2330
2487
|
}
|
|
2331
2488
|
interface ShapeDataStyles {
|
|
2332
2489
|
/**
|
|
@@ -2429,6 +2586,8 @@ interface TocData {
|
|
|
2429
2586
|
color?: string | null;
|
|
2430
2587
|
/** Indentation style. Default: NESTED. */
|
|
2431
2588
|
indentation?: IndentationWithLiterals;
|
|
2589
|
+
/** Node animation. */
|
|
2590
|
+
animation?: Animation;
|
|
2432
2591
|
}
|
|
2433
2592
|
/** List style. */
|
|
2434
2593
|
declare enum ListStyle {
|
|
@@ -2475,6 +2634,8 @@ interface SmartBlockData {
|
|
|
2475
2634
|
borderWidth?: number | null;
|
|
2476
2635
|
/** Border radius in pixels (for SOLID_JOINED_BOXES variant). */
|
|
2477
2636
|
borderRadius?: number | null;
|
|
2637
|
+
/** Node animation. */
|
|
2638
|
+
animation?: Animation;
|
|
2478
2639
|
}
|
|
2479
2640
|
/** Layout type of the smart block */
|
|
2480
2641
|
declare enum SmartBlockDataType {
|
|
@@ -2578,10 +2739,14 @@ interface CheckboxListData {
|
|
|
2578
2739
|
indentation?: number;
|
|
2579
2740
|
/** Offset level from 0-4. */
|
|
2580
2741
|
offset?: number | null;
|
|
2742
|
+
/** Node animation. */
|
|
2743
|
+
animation?: Animation;
|
|
2581
2744
|
}
|
|
2582
2745
|
interface ListItemNodeData {
|
|
2583
2746
|
/** Checkbox list item state. Defaults to `false`. */
|
|
2584
2747
|
checked?: boolean | null;
|
|
2748
|
+
/** Node animation. */
|
|
2749
|
+
animation?: Animation;
|
|
2585
2750
|
}
|
|
2586
2751
|
interface Metadata {
|
|
2587
2752
|
/** Schema version. */
|
|
@@ -3134,6 +3299,172 @@ interface GetTotalPostsResponse {
|
|
|
3134
3299
|
/** Total amount of published posts. */
|
|
3135
3300
|
total?: number;
|
|
3136
3301
|
}
|
|
3302
|
+
interface ListDemoPostsRequest {
|
|
3303
|
+
/**
|
|
3304
|
+
* Whether to return only featured posts.
|
|
3305
|
+
*
|
|
3306
|
+
* Default: `false`
|
|
3307
|
+
*/
|
|
3308
|
+
featured?: boolean;
|
|
3309
|
+
/**
|
|
3310
|
+
* Hashtag filter.
|
|
3311
|
+
*
|
|
3312
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3313
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3314
|
+
* @maxSize 100
|
|
3315
|
+
* @maxLength 100
|
|
3316
|
+
*/
|
|
3317
|
+
hashtags?: string[];
|
|
3318
|
+
/**
|
|
3319
|
+
* Category filter.
|
|
3320
|
+
*
|
|
3321
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3322
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3323
|
+
* @maxSize 50
|
|
3324
|
+
* @format GUID
|
|
3325
|
+
*/
|
|
3326
|
+
categoryIds?: string[];
|
|
3327
|
+
/**
|
|
3328
|
+
* Tag filter.
|
|
3329
|
+
*
|
|
3330
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3331
|
+
* If omitted, all posts with or without tags are returned.
|
|
3332
|
+
* @maxSize 50
|
|
3333
|
+
* @format GUID
|
|
3334
|
+
*/
|
|
3335
|
+
tagIds?: string[];
|
|
3336
|
+
/**
|
|
3337
|
+
* Sorting options.
|
|
3338
|
+
*
|
|
3339
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3340
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3341
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3342
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3343
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3344
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3345
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3346
|
+
* - `RATING`: reserved for internal use.
|
|
3347
|
+
*
|
|
3348
|
+
* Default: `FEED`
|
|
3349
|
+
*/
|
|
3350
|
+
sort?: GetPostsSortWithLiterals;
|
|
3351
|
+
/** Pagination options. */
|
|
3352
|
+
paging?: BlogPaging;
|
|
3353
|
+
/**
|
|
3354
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
3355
|
+
* This parameter will be removed on June 30, 2023.
|
|
3356
|
+
*
|
|
3357
|
+
* List of post fields to be included in the response.
|
|
3358
|
+
* @maxSize 20
|
|
3359
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3360
|
+
* This parameter will be removed on June 30, 2023.
|
|
3361
|
+
*
|
|
3362
|
+
* List of post fields to be included in the response.
|
|
3363
|
+
* @replacedBy fieldsets
|
|
3364
|
+
* @targetRemovalDate 2024-06-30
|
|
3365
|
+
*/
|
|
3366
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3367
|
+
/**
|
|
3368
|
+
* Language filter.
|
|
3369
|
+
*
|
|
3370
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3371
|
+
* Pass a language to only receive posts that are in that language.
|
|
3372
|
+
* If omitted, posts in all languages are returned.
|
|
3373
|
+
* @format LANGUAGE_TAG
|
|
3374
|
+
*/
|
|
3375
|
+
language?: string | null;
|
|
3376
|
+
/**
|
|
3377
|
+
* Post owner's member ID.
|
|
3378
|
+
* @format GUID
|
|
3379
|
+
*/
|
|
3380
|
+
memberId?: string | null;
|
|
3381
|
+
/**
|
|
3382
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3383
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3384
|
+
* only the post’s base fields are returned.
|
|
3385
|
+
* @maxSize 20
|
|
3386
|
+
*/
|
|
3387
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3388
|
+
}
|
|
3389
|
+
declare enum GetPostsSort {
|
|
3390
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3391
|
+
FEED = "FEED",
|
|
3392
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3393
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3394
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3395
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3396
|
+
/** Ordered by total number of views in descending order. */
|
|
3397
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3398
|
+
/** Ordered by total number of likes in descending order. */
|
|
3399
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3400
|
+
/** Ordered by `title` in ascending order. */
|
|
3401
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3402
|
+
/** Ordered by `title` in descending order. */
|
|
3403
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3404
|
+
}
|
|
3405
|
+
/** @enumType */
|
|
3406
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3407
|
+
interface BlogPaging {
|
|
3408
|
+
/**
|
|
3409
|
+
* Number of items to skip in the current sort order.
|
|
3410
|
+
*
|
|
3411
|
+
*
|
|
3412
|
+
* Default: `0`
|
|
3413
|
+
*/
|
|
3414
|
+
offset?: number;
|
|
3415
|
+
/**
|
|
3416
|
+
* Number of items to return.
|
|
3417
|
+
*
|
|
3418
|
+
*
|
|
3419
|
+
* Default:`50`
|
|
3420
|
+
* @min 1
|
|
3421
|
+
* @max 100
|
|
3422
|
+
*/
|
|
3423
|
+
limit?: number;
|
|
3424
|
+
/**
|
|
3425
|
+
* Pointer to the next or previous page in the list of results.
|
|
3426
|
+
* @maxLength 2000
|
|
3427
|
+
*/
|
|
3428
|
+
cursor?: string | null;
|
|
3429
|
+
}
|
|
3430
|
+
declare enum PostFieldField {
|
|
3431
|
+
UNKNOWN = "UNKNOWN",
|
|
3432
|
+
/** Includes post URL when present. */
|
|
3433
|
+
URL = "URL",
|
|
3434
|
+
/** Includes post content text string when present. */
|
|
3435
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3436
|
+
/** Includes post metrics when present. */
|
|
3437
|
+
METRICS = "METRICS",
|
|
3438
|
+
/** Includes SEO data. */
|
|
3439
|
+
SEO = "SEO",
|
|
3440
|
+
/** Includes post owner's contact ID. */
|
|
3441
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3442
|
+
/** Includes post rich content. */
|
|
3443
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3444
|
+
/** Includes post reference ID field. */
|
|
3445
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3446
|
+
}
|
|
3447
|
+
/** @enumType */
|
|
3448
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3449
|
+
interface ListDemoPostsResponse {
|
|
3450
|
+
/** List of posts. */
|
|
3451
|
+
posts?: Post[];
|
|
3452
|
+
/** Details on the paged set of results returned. */
|
|
3453
|
+
metaData?: MetaData;
|
|
3454
|
+
}
|
|
3455
|
+
interface MetaData {
|
|
3456
|
+
/** Number of items returned in this response. */
|
|
3457
|
+
count?: number;
|
|
3458
|
+
/** Requested offset. */
|
|
3459
|
+
offset?: number;
|
|
3460
|
+
/** Total number of items that match the query. */
|
|
3461
|
+
total?: number;
|
|
3462
|
+
/**
|
|
3463
|
+
* Pointer to the next or previous page in the list of results.
|
|
3464
|
+
* @maxLength 2000
|
|
3465
|
+
*/
|
|
3466
|
+
cursor?: string | null;
|
|
3467
|
+
}
|
|
3137
3468
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3138
3469
|
/**
|
|
3139
3470
|
* Member ID of person who triggered the counter update
|
|
@@ -3203,25 +3534,6 @@ interface GetPostRequest {
|
|
|
3203
3534
|
*/
|
|
3204
3535
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3205
3536
|
}
|
|
3206
|
-
declare enum PostFieldField {
|
|
3207
|
-
UNKNOWN = "UNKNOWN",
|
|
3208
|
-
/** Includes post URL when present. */
|
|
3209
|
-
URL = "URL",
|
|
3210
|
-
/** Includes post content text string when present. */
|
|
3211
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3212
|
-
/** Includes post metrics when present. */
|
|
3213
|
-
METRICS = "METRICS",
|
|
3214
|
-
/** Includes SEO data. */
|
|
3215
|
-
SEO = "SEO",
|
|
3216
|
-
/** Includes post owner's contact ID. */
|
|
3217
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3218
|
-
/** Includes post rich content. */
|
|
3219
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3220
|
-
/** Includes post reference ID field. */
|
|
3221
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3222
|
-
}
|
|
3223
|
-
/** @enumType */
|
|
3224
|
-
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3225
3537
|
interface GetPostResponse {
|
|
3226
3538
|
/** Retrieved post info. */
|
|
3227
3539
|
post?: Post;
|
|
@@ -3314,66 +3626,12 @@ interface ListPostsRequest {
|
|
|
3314
3626
|
*/
|
|
3315
3627
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3316
3628
|
}
|
|
3317
|
-
declare enum GetPostsSort {
|
|
3318
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3319
|
-
FEED = "FEED",
|
|
3320
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3321
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3322
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3323
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3324
|
-
/** Ordered by total number of views in descending order. */
|
|
3325
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3326
|
-
/** Ordered by total number of likes in descending order. */
|
|
3327
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3328
|
-
/** Ordered by `title` in ascending order. */
|
|
3329
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3330
|
-
/** Ordered by `title` in descending order. */
|
|
3331
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3332
|
-
}
|
|
3333
|
-
/** @enumType */
|
|
3334
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3335
|
-
interface BlogPaging {
|
|
3336
|
-
/**
|
|
3337
|
-
* Number of items to skip in the current sort order.
|
|
3338
|
-
*
|
|
3339
|
-
*
|
|
3340
|
-
* Default: `0`
|
|
3341
|
-
*/
|
|
3342
|
-
offset?: number;
|
|
3343
|
-
/**
|
|
3344
|
-
* Number of items to return.
|
|
3345
|
-
*
|
|
3346
|
-
*
|
|
3347
|
-
* Default:`50`
|
|
3348
|
-
* @min 1
|
|
3349
|
-
* @max 100
|
|
3350
|
-
*/
|
|
3351
|
-
limit?: number;
|
|
3352
|
-
/**
|
|
3353
|
-
* Pointer to the next or previous page in the list of results.
|
|
3354
|
-
* @maxLength 2000
|
|
3355
|
-
*/
|
|
3356
|
-
cursor?: string | null;
|
|
3357
|
-
}
|
|
3358
3629
|
interface ListPostsResponse {
|
|
3359
3630
|
/** List of retrieved posts. */
|
|
3360
3631
|
posts?: Post[];
|
|
3361
3632
|
/** Details on the paged set of results returned. */
|
|
3362
3633
|
metaData?: MetaData;
|
|
3363
3634
|
}
|
|
3364
|
-
interface MetaData {
|
|
3365
|
-
/** Number of items returned in this response. */
|
|
3366
|
-
count?: number;
|
|
3367
|
-
/** Requested offset. */
|
|
3368
|
-
offset?: number;
|
|
3369
|
-
/** Total number of items that match the query. */
|
|
3370
|
-
total?: number;
|
|
3371
|
-
/**
|
|
3372
|
-
* Pointer to the next or previous page in the list of results.
|
|
3373
|
-
* @maxLength 2000
|
|
3374
|
-
*/
|
|
3375
|
-
cursor?: string | null;
|
|
3376
|
-
}
|
|
3377
3635
|
interface QueryPostsRequest {
|
|
3378
3636
|
/** Query options. */
|
|
3379
3637
|
query?: PlatformQuery;
|
|
@@ -3393,6 +3651,11 @@ interface Sorting {
|
|
|
3393
3651
|
fieldName?: string;
|
|
3394
3652
|
/** Sort order. */
|
|
3395
3653
|
order?: SortOrderWithLiterals;
|
|
3654
|
+
/**
|
|
3655
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
3656
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
3657
|
+
*/
|
|
3658
|
+
origin?: AddressLocation;
|
|
3396
3659
|
}
|
|
3397
3660
|
declare enum SortOrder {
|
|
3398
3661
|
ASC = "ASC",
|
|
@@ -3400,6 +3663,12 @@ declare enum SortOrder {
|
|
|
3400
3663
|
}
|
|
3401
3664
|
/** @enumType */
|
|
3402
3665
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3666
|
+
interface AddressLocation {
|
|
3667
|
+
/** Address latitude. */
|
|
3668
|
+
latitude?: number | null;
|
|
3669
|
+
/** Address longitude. */
|
|
3670
|
+
longitude?: number | null;
|
|
3671
|
+
}
|
|
3403
3672
|
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
3404
3673
|
/** Paging options to limit and skip the number of items. */
|
|
3405
3674
|
paging?: Paging;
|
|
@@ -3717,121 +3986,6 @@ interface PostCount {
|
|
|
3717
3986
|
/** Number of posts. */
|
|
3718
3987
|
postCount?: number;
|
|
3719
3988
|
}
|
|
3720
|
-
interface ListDemoPostsRequest {
|
|
3721
|
-
/**
|
|
3722
|
-
* Whether to return only featured posts.
|
|
3723
|
-
*
|
|
3724
|
-
* Default: `false`
|
|
3725
|
-
*/
|
|
3726
|
-
featured?: boolean;
|
|
3727
|
-
/**
|
|
3728
|
-
* Hashtag filter.
|
|
3729
|
-
*
|
|
3730
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3731
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
3732
|
-
* @maxSize 100
|
|
3733
|
-
* @maxLength 100
|
|
3734
|
-
*/
|
|
3735
|
-
hashtags?: string[];
|
|
3736
|
-
/**
|
|
3737
|
-
* Category filter.
|
|
3738
|
-
*
|
|
3739
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3740
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
3741
|
-
* @maxSize 50
|
|
3742
|
-
* @format GUID
|
|
3743
|
-
*/
|
|
3744
|
-
categoryIds?: string[];
|
|
3745
|
-
/**
|
|
3746
|
-
* Tag filter.
|
|
3747
|
-
*
|
|
3748
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3749
|
-
* If omitted, all posts with or without tags are returned.
|
|
3750
|
-
* @maxSize 50
|
|
3751
|
-
* @format GUID
|
|
3752
|
-
*/
|
|
3753
|
-
tagIds?: string[];
|
|
3754
|
-
/**
|
|
3755
|
-
* Sorting options.
|
|
3756
|
-
*
|
|
3757
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3758
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3759
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3760
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3761
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3762
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3763
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3764
|
-
* - `RATING`: reserved for internal use.
|
|
3765
|
-
*
|
|
3766
|
-
* Default: `FEED`
|
|
3767
|
-
*/
|
|
3768
|
-
sort?: GetPostsSortWithLiterals;
|
|
3769
|
-
/** Pagination options. */
|
|
3770
|
-
paging?: BlogPaging;
|
|
3771
|
-
/**
|
|
3772
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
3773
|
-
* This parameter will be removed on June 30, 2023.
|
|
3774
|
-
*
|
|
3775
|
-
* List of post fields to be included in the response.
|
|
3776
|
-
* @maxSize 20
|
|
3777
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3778
|
-
* This parameter will be removed on June 30, 2023.
|
|
3779
|
-
*
|
|
3780
|
-
* List of post fields to be included in the response.
|
|
3781
|
-
* @replacedBy fieldsets
|
|
3782
|
-
* @targetRemovalDate 2024-06-30
|
|
3783
|
-
*/
|
|
3784
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3785
|
-
/**
|
|
3786
|
-
* Language filter.
|
|
3787
|
-
*
|
|
3788
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3789
|
-
* Pass a language to only receive posts that are in that language.
|
|
3790
|
-
* If omitted, posts in all languages are returned.
|
|
3791
|
-
* @format LANGUAGE_TAG
|
|
3792
|
-
*/
|
|
3793
|
-
language?: string | null;
|
|
3794
|
-
/**
|
|
3795
|
-
* Post owner's member ID.
|
|
3796
|
-
* @format GUID
|
|
3797
|
-
*/
|
|
3798
|
-
memberId?: string | null;
|
|
3799
|
-
/**
|
|
3800
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3801
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3802
|
-
* only the post’s base fields are returned.
|
|
3803
|
-
* @maxSize 20
|
|
3804
|
-
*/
|
|
3805
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3806
|
-
}
|
|
3807
|
-
interface ListDemoPostsResponse {
|
|
3808
|
-
/** List of posts. */
|
|
3809
|
-
posts?: Post[];
|
|
3810
|
-
/** Details on the paged set of results returned. */
|
|
3811
|
-
metaData?: MetaData;
|
|
3812
|
-
}
|
|
3813
|
-
interface ConvertDraftJsToRichContentRequest {
|
|
3814
|
-
/** DraftJs content to convert to Rich content. */
|
|
3815
|
-
content?: Record<string, any> | null;
|
|
3816
|
-
}
|
|
3817
|
-
interface ConvertDraftJsToRichContentResponse {
|
|
3818
|
-
/**
|
|
3819
|
-
* Rich content converted from DraftJs content.
|
|
3820
|
-
* @maxLength 2000000
|
|
3821
|
-
*/
|
|
3822
|
-
richContent?: string;
|
|
3823
|
-
}
|
|
3824
|
-
interface ConvertRichContentToDraftJsRequest {
|
|
3825
|
-
/**
|
|
3826
|
-
* Rich content to convert to DraftJs content.
|
|
3827
|
-
* @maxLength 2000000
|
|
3828
|
-
*/
|
|
3829
|
-
richContent?: string;
|
|
3830
|
-
}
|
|
3831
|
-
interface ConvertRichContentToDraftJsResponse {
|
|
3832
|
-
/** DraftJs content converted from Rich content. */
|
|
3833
|
-
content?: Record<string, any> | null;
|
|
3834
|
-
}
|
|
3835
3989
|
interface BaseEventMetadata {
|
|
3836
3990
|
/**
|
|
3837
3991
|
* App instance ID.
|
|
@@ -3979,13 +4133,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3979
4133
|
/**
|
|
3980
4134
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3981
4135
|
*
|
|
3982
|
-
*
|
|
3983
|
-
* The
|
|
3984
|
-
*
|
|
3985
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3986
|
-
*
|
|
3987
|
-
*
|
|
4136
|
+
*
|
|
4137
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
4138
|
+
*
|
|
4139
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
4140
|
+
*
|
|
4141
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
3988
4142
|
* @public
|
|
4143
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
3989
4144
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3990
4145
|
* @applicableIdentity APP
|
|
3991
4146
|
* @returns Get Blog Post Count Stats response
|
|
@@ -4026,6 +4181,7 @@ interface QueryPostCountStatsOptions {
|
|
|
4026
4181
|
/**
|
|
4027
4182
|
* Retrieves the total amount of published posts of the blog.
|
|
4028
4183
|
* @public
|
|
4184
|
+
* @param options - Language Options.
|
|
4029
4185
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4030
4186
|
* @applicableIdentity APP
|
|
4031
4187
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -4046,12 +4202,12 @@ interface GetTotalPostsOptions {
|
|
|
4046
4202
|
* @param postId - Post ID.
|
|
4047
4203
|
* @public
|
|
4048
4204
|
* @requiredField postId
|
|
4205
|
+
* @param options - Options specifying which fields to return.
|
|
4049
4206
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4050
4207
|
* @applicableIdentity APP
|
|
4051
|
-
* @returns Retrieved post info.
|
|
4052
4208
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4053
4209
|
*/
|
|
4054
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4210
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
|
|
4055
4211
|
interface GetPostOptions {
|
|
4056
4212
|
/**
|
|
4057
4213
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4071,6 +4227,7 @@ interface GetPostOptions {
|
|
|
4071
4227
|
* @param slug - Slug of the post to retrieve.
|
|
4072
4228
|
* @public
|
|
4073
4229
|
* @requiredField slug
|
|
4230
|
+
* @param options - Options specifying which fields to return.
|
|
4074
4231
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4075
4232
|
* @applicableIdentity APP
|
|
4076
4233
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -4098,6 +4255,7 @@ interface GetPostBySlugOptions {
|
|
|
4098
4255
|
* - `paging.limit` is `50`.
|
|
4099
4256
|
* - `paging.offset` is `0`.
|
|
4100
4257
|
* @public
|
|
4258
|
+
* @param options - Sort, filter, and paging options.
|
|
4101
4259
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4102
4260
|
* @applicableIdentity APP
|
|
4103
4261
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4168,18 +4326,26 @@ interface ListPostsOptions {
|
|
|
4168
4326
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4169
4327
|
}
|
|
4170
4328
|
/**
|
|
4171
|
-
*
|
|
4329
|
+
* Creates a query to retrieve a list of posts.
|
|
4172
4330
|
*
|
|
4173
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4174
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4175
|
-
* - `paging.limit` is `50`.
|
|
4176
|
-
* - `paging.offset` is `0`.
|
|
4177
4331
|
*
|
|
4178
|
-
*
|
|
4179
|
-
*
|
|
4180
|
-
*
|
|
4181
|
-
*
|
|
4332
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4333
|
+
*
|
|
4334
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4335
|
+
*
|
|
4336
|
+
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
4337
|
+
*
|
|
4338
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4339
|
+
* + `limit(50)`
|
|
4340
|
+
* + `descending('firstPublishedDate')`
|
|
4341
|
+
*
|
|
4342
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4343
|
+
*
|
|
4344
|
+
* To learn how to query posts, refer to the table below.
|
|
4345
|
+
*
|
|
4346
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
|
|
4182
4347
|
* @public
|
|
4348
|
+
* @param options - Options specifying which fields to return.
|
|
4183
4349
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4184
4350
|
* @applicableIdentity APP
|
|
4185
4351
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -4423,6 +4589,11 @@ type PostQuery = {
|
|
|
4423
4589
|
Sort order.
|
|
4424
4590
|
*/
|
|
4425
4591
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
4592
|
+
/**
|
|
4593
|
+
Origin point for geo-distance sorting on a GEO field
|
|
4594
|
+
results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
4595
|
+
*/
|
|
4596
|
+
origin?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['origin'];
|
|
4426
4597
|
}[];
|
|
4427
4598
|
};
|
|
4428
4599
|
declare const utils: {
|
|
@@ -4445,4 +4616,4 @@ declare const utils: {
|
|
|
4445
4616
|
*/
|
|
4446
4617
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4447
4618
|
|
|
4448
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext,
|
|
4619
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
|