@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
|
@@ -473,6 +473,8 @@ interface ButtonData {
|
|
|
473
473
|
text?: string | null;
|
|
474
474
|
/** Button link details. */
|
|
475
475
|
link?: Link;
|
|
476
|
+
/** Node animation. */
|
|
477
|
+
animation?: Animation;
|
|
476
478
|
}
|
|
477
479
|
/** Background type */
|
|
478
480
|
declare enum BackgroundType {
|
|
@@ -749,9 +751,90 @@ interface Rel {
|
|
|
749
751
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
750
752
|
noreferrer?: boolean | null;
|
|
751
753
|
}
|
|
754
|
+
interface Animation {
|
|
755
|
+
/** Animation kind. */
|
|
756
|
+
type?: TypeWithLiterals;
|
|
757
|
+
/** Entrance animation, played once when the node first enters the viewport. */
|
|
758
|
+
entrance?: EntranceAnimation;
|
|
759
|
+
}
|
|
760
|
+
declare enum Type {
|
|
761
|
+
/** Animations that play while the node is in view. */
|
|
762
|
+
VIEW = "VIEW"
|
|
763
|
+
}
|
|
764
|
+
/** @enumType */
|
|
765
|
+
type TypeWithLiterals = Type | 'VIEW';
|
|
766
|
+
interface EntranceAnimation {
|
|
767
|
+
/** The entrance effect to play. */
|
|
768
|
+
effect?: EntranceEffect;
|
|
769
|
+
/** Effect duration in milliseconds. Each effect has its own default. */
|
|
770
|
+
duration?: number | null;
|
|
771
|
+
/** Delay before the effect starts, in milliseconds. */
|
|
772
|
+
delay?: number | null;
|
|
773
|
+
}
|
|
774
|
+
interface EntranceEffect {
|
|
775
|
+
/** The entrance effect type. */
|
|
776
|
+
type?: EntranceEffectTypeWithLiterals;
|
|
777
|
+
/**
|
|
778
|
+
* 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).
|
|
779
|
+
* @maxLength 20
|
|
780
|
+
*/
|
|
781
|
+
direction?: string | null;
|
|
782
|
+
/**
|
|
783
|
+
* Clip-path shape: ELLIPSE, CIRCLE, RECTANGLE, or DIAMOND (SHAPE).
|
|
784
|
+
* @maxLength 12
|
|
785
|
+
*/
|
|
786
|
+
shape?: string | null;
|
|
787
|
+
/**
|
|
788
|
+
* Motion style: GENTLE, MODERATE, or INTENSE. Only the effects that expose one accept it.
|
|
789
|
+
* @maxLength 100
|
|
790
|
+
*/
|
|
791
|
+
easing?: string | null;
|
|
792
|
+
}
|
|
793
|
+
declare enum EntranceEffectType {
|
|
794
|
+
/** Fades in from fully transparent to fully opaque. */
|
|
795
|
+
FADE = "FADE",
|
|
796
|
+
/** Enters along a 3D arc path. */
|
|
797
|
+
ARC = "ARC",
|
|
798
|
+
/** Transitions from blurred to sharp. */
|
|
799
|
+
BLUR = "BLUR",
|
|
800
|
+
/** Bounces into place with an elastic curve. */
|
|
801
|
+
BOUNCE = "BOUNCE",
|
|
802
|
+
/** Shrinks down from a larger size. */
|
|
803
|
+
DROP = "DROP",
|
|
804
|
+
/** Expands from a point, scaling to full size. */
|
|
805
|
+
EXPAND = "EXPAND",
|
|
806
|
+
/** Flips into view with a 3D rotation. */
|
|
807
|
+
FLIP = "FLIP",
|
|
808
|
+
/** Drifts gently into place. */
|
|
809
|
+
FLOAT = "FLOAT",
|
|
810
|
+
/** Unfolds from an edge as if hinged. */
|
|
811
|
+
FOLD = "FOLD",
|
|
812
|
+
/** Glides in smoothly from off-screen. */
|
|
813
|
+
GLIDE = "GLIDE",
|
|
814
|
+
/** Progressively revealed by an expanding clip-path. */
|
|
815
|
+
REVEAL = "REVEAL",
|
|
816
|
+
/** Appears through an expanding geometric clip-path shape. */
|
|
817
|
+
SHAPE = "SHAPE",
|
|
818
|
+
/** Revealed through shutter-like strips. */
|
|
819
|
+
SHUTTERS = "SHUTTERS",
|
|
820
|
+
/** Slides in from one side. */
|
|
821
|
+
SLIDE = "SLIDE",
|
|
822
|
+
/** Spins into view while scaling up. */
|
|
823
|
+
SPIN = "SPIN",
|
|
824
|
+
/** Tilts in from the side with 3D rotation. */
|
|
825
|
+
TILT = "TILT",
|
|
826
|
+
/** Rotates into view around a corner pivot. */
|
|
827
|
+
TURN = "TURN",
|
|
828
|
+
/** Expands from its horizontal or vertical center. */
|
|
829
|
+
WINK = "WINK"
|
|
830
|
+
}
|
|
831
|
+
/** @enumType */
|
|
832
|
+
type EntranceEffectTypeWithLiterals = EntranceEffectType | 'FADE' | 'ARC' | 'BLUR' | 'BOUNCE' | 'DROP' | 'EXPAND' | 'FLIP' | 'FLOAT' | 'FOLD' | 'GLIDE' | 'REVEAL' | 'SHAPE' | 'SHUTTERS' | 'SLIDE' | 'SPIN' | 'TILT' | 'TURN' | 'WINK';
|
|
752
833
|
interface CodeBlockData {
|
|
753
834
|
/** Styling for the code block's text. */
|
|
754
835
|
textStyle?: TextStyle;
|
|
836
|
+
/** Node animation. */
|
|
837
|
+
animation?: Animation;
|
|
755
838
|
}
|
|
756
839
|
interface TextStyle {
|
|
757
840
|
/** Text alignment. Defaults to `AUTO`. */
|
|
@@ -782,7 +865,19 @@ interface DividerData {
|
|
|
782
865
|
width?: WidthWithLiterals;
|
|
783
866
|
/** Divider alignment. */
|
|
784
867
|
alignment?: DividerDataAlignmentWithLiterals;
|
|
868
|
+
/** Visual styling for the divider lines. */
|
|
869
|
+
styles?: DividerDataStyles;
|
|
870
|
+
/** Node animation. */
|
|
871
|
+
animation?: Animation;
|
|
872
|
+
}
|
|
873
|
+
declare enum LineCap {
|
|
874
|
+
/** Square line endings. */
|
|
875
|
+
SQUARE = "SQUARE",
|
|
876
|
+
/** Rounded line endings. */
|
|
877
|
+
ROUND = "ROUND"
|
|
785
878
|
}
|
|
879
|
+
/** @enumType */
|
|
880
|
+
type LineCapWithLiterals = LineCap | 'SQUARE' | 'ROUND';
|
|
786
881
|
declare enum LineStyle {
|
|
787
882
|
/** Single Line */
|
|
788
883
|
SINGLE = "SINGLE",
|
|
@@ -815,6 +910,26 @@ declare enum DividerDataAlignment {
|
|
|
815
910
|
}
|
|
816
911
|
/** @enumType */
|
|
817
912
|
type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
913
|
+
interface DividerDataStyles {
|
|
914
|
+
/**
|
|
915
|
+
* Divider color as a hexadecimal value. An alpha channel controls opacity.
|
|
916
|
+
* @maxLength 19
|
|
917
|
+
*/
|
|
918
|
+
color?: string | null;
|
|
919
|
+
/** Divider line ending shape. */
|
|
920
|
+
lineCap?: LineCapWithLiterals;
|
|
921
|
+
/**
|
|
922
|
+
* Line thicknesses in pixels, ordered from first line to last line.
|
|
923
|
+
* @maxSize 10
|
|
924
|
+
*/
|
|
925
|
+
lineThickness?: number[];
|
|
926
|
+
/** 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. */
|
|
927
|
+
dashLength?: number | null;
|
|
928
|
+
/** Visible gap between dashes or dots, in pixels. */
|
|
929
|
+
dashGap?: number | null;
|
|
930
|
+
/** Gap between divider lines in pixels. */
|
|
931
|
+
lineGap?: number | null;
|
|
932
|
+
}
|
|
818
933
|
interface FileData {
|
|
819
934
|
/** Styling for the file's container. */
|
|
820
935
|
containerData?: PluginContainerData;
|
|
@@ -837,6 +952,8 @@ interface FileData {
|
|
|
837
952
|
path?: string | null;
|
|
838
953
|
/** File size in KB. */
|
|
839
954
|
sizeInKb?: string | null;
|
|
955
|
+
/** Node animation. */
|
|
956
|
+
animation?: Animation;
|
|
840
957
|
}
|
|
841
958
|
declare enum ViewMode {
|
|
842
959
|
/** No PDF view */
|
|
@@ -897,6 +1014,8 @@ interface GalleryData {
|
|
|
897
1014
|
disableExpand?: boolean | null;
|
|
898
1015
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
899
1016
|
disableDownload?: boolean | null;
|
|
1017
|
+
/** Node animation. */
|
|
1018
|
+
animation?: Animation;
|
|
900
1019
|
}
|
|
901
1020
|
interface V1Media {
|
|
902
1021
|
/** The source for the media's data. */
|
|
@@ -1040,6 +1159,8 @@ interface GIFData {
|
|
|
1040
1159
|
width?: number;
|
|
1041
1160
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1042
1161
|
gifType?: GIFTypeWithLiterals;
|
|
1162
|
+
/** Node animation. */
|
|
1163
|
+
animation?: Animation;
|
|
1043
1164
|
}
|
|
1044
1165
|
interface GIF {
|
|
1045
1166
|
/**
|
|
@@ -1073,6 +1194,8 @@ interface HeadingData {
|
|
|
1073
1194
|
indentation?: number | null;
|
|
1074
1195
|
/** Rendered heading level for SEO/accessibility, overrides the HTML tag when set. */
|
|
1075
1196
|
renderedLevel?: number | null;
|
|
1197
|
+
/** Node animation. */
|
|
1198
|
+
animation?: Animation;
|
|
1076
1199
|
}
|
|
1077
1200
|
interface HTMLData extends HTMLDataDataOneOf {
|
|
1078
1201
|
/** The URL for the HTML code for the node. */
|
|
@@ -1092,6 +1215,8 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1092
1215
|
source?: SourceWithLiterals;
|
|
1093
1216
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1094
1217
|
autoHeight?: boolean | null;
|
|
1218
|
+
/** Node animation. */
|
|
1219
|
+
animation?: Animation;
|
|
1095
1220
|
}
|
|
1096
1221
|
/** @oneof */
|
|
1097
1222
|
interface HTMLDataDataOneOf {
|
|
@@ -1139,6 +1264,10 @@ interface ImageData {
|
|
|
1139
1264
|
styles?: ImageDataStyles;
|
|
1140
1265
|
/** Non-destructive crop rectangle, expressed as fractions (0-1) of the original image. When omitted, the full image is shown. */
|
|
1141
1266
|
crop?: ImageDataCrop;
|
|
1267
|
+
/** Optional shape mask applied to the visible crop. Supported values: CIRCLE, OVAL, STAR, PENTAGON, HEXAGON, TRIANGLE, HEART, RHOMBUS, FLUID, WINDOW. */
|
|
1268
|
+
cropShape?: string | null;
|
|
1269
|
+
/** Node animation. */
|
|
1270
|
+
animation?: Animation;
|
|
1142
1271
|
}
|
|
1143
1272
|
interface StylesBorder {
|
|
1144
1273
|
/** Border width in pixels. */
|
|
@@ -1180,6 +1309,8 @@ interface LinkPreviewData {
|
|
|
1180
1309
|
html?: string | null;
|
|
1181
1310
|
/** Styling for the link preview. */
|
|
1182
1311
|
styles?: LinkPreviewDataStyles;
|
|
1312
|
+
/** Node animation. */
|
|
1313
|
+
animation?: Animation;
|
|
1183
1314
|
}
|
|
1184
1315
|
declare enum StylesPosition {
|
|
1185
1316
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
@@ -1275,6 +1406,8 @@ interface ParagraphData {
|
|
|
1275
1406
|
indentation?: number | null;
|
|
1276
1407
|
/** Paragraph level */
|
|
1277
1408
|
level?: number | null;
|
|
1409
|
+
/** Node animation. */
|
|
1410
|
+
animation?: Animation;
|
|
1278
1411
|
}
|
|
1279
1412
|
interface PollData {
|
|
1280
1413
|
/** Styling for the poll's container. */
|
|
@@ -1285,6 +1418,8 @@ interface PollData {
|
|
|
1285
1418
|
layout?: PollDataLayout;
|
|
1286
1419
|
/** Styling for the poll and voting options. */
|
|
1287
1420
|
design?: Design;
|
|
1421
|
+
/** Node animation. */
|
|
1422
|
+
animation?: Animation;
|
|
1288
1423
|
}
|
|
1289
1424
|
declare enum ViewRole {
|
|
1290
1425
|
/** Only Poll creator can view the results */
|
|
@@ -1643,6 +1778,8 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1643
1778
|
containerData?: PluginContainerData;
|
|
1644
1779
|
/** Pricing data for embedded Wix App content. */
|
|
1645
1780
|
pricingData?: PricingData;
|
|
1781
|
+
/** Node animation. */
|
|
1782
|
+
animation?: Animation;
|
|
1646
1783
|
}
|
|
1647
1784
|
/** @oneof */
|
|
1648
1785
|
interface AppEmbedDataAppDataOneOf {
|
|
@@ -1685,14 +1822,14 @@ declare enum Placement {
|
|
|
1685
1822
|
}
|
|
1686
1823
|
/** @enumType */
|
|
1687
1824
|
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
|
|
1688
|
-
declare enum
|
|
1825
|
+
declare enum CardStylesType {
|
|
1689
1826
|
/** Card with visible border and background */
|
|
1690
1827
|
CONTAINED = "CONTAINED",
|
|
1691
1828
|
/** Card without visible border */
|
|
1692
1829
|
FRAMELESS = "FRAMELESS"
|
|
1693
1830
|
}
|
|
1694
1831
|
/** @enumType */
|
|
1695
|
-
type
|
|
1832
|
+
type CardStylesTypeWithLiterals = CardStylesType | 'CONTAINED' | 'FRAMELESS';
|
|
1696
1833
|
declare enum Alignment {
|
|
1697
1834
|
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
|
|
1698
1835
|
START = "START",
|
|
@@ -1828,7 +1965,7 @@ interface CardStyles {
|
|
|
1828
1965
|
/** Card border radius in pixels. */
|
|
1829
1966
|
borderRadius?: number | null;
|
|
1830
1967
|
/** Card type. Defaults to `CONTAINED`. */
|
|
1831
|
-
type?:
|
|
1968
|
+
type?: CardStylesTypeWithLiterals;
|
|
1832
1969
|
/** Content alignment. Defaults to `START`. */
|
|
1833
1970
|
alignment?: AlignmentWithLiterals;
|
|
1834
1971
|
/** Layout for title and price. Defaults to `STACKED`. */
|
|
@@ -1884,6 +2021,8 @@ interface VideoData {
|
|
|
1884
2021
|
title?: string | null;
|
|
1885
2022
|
/** Video options. */
|
|
1886
2023
|
options?: PlaybackOptions;
|
|
2024
|
+
/** Node animation. */
|
|
2025
|
+
animation?: Animation;
|
|
1887
2026
|
}
|
|
1888
2027
|
interface PlaybackOptions {
|
|
1889
2028
|
/** Sets whether the media will automatically start playing. */
|
|
@@ -1900,6 +2039,8 @@ interface EmbedData {
|
|
|
1900
2039
|
oembed?: Oembed;
|
|
1901
2040
|
/** Origin asset source. */
|
|
1902
2041
|
src?: string | null;
|
|
2042
|
+
/** Node animation. */
|
|
2043
|
+
animation?: Animation;
|
|
1903
2044
|
}
|
|
1904
2045
|
interface Oembed {
|
|
1905
2046
|
/** The resource type. */
|
|
@@ -1944,6 +2085,8 @@ interface CollapsibleListData {
|
|
|
1944
2085
|
direction?: DirectionWithLiterals;
|
|
1945
2086
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1946
2087
|
isQapageData?: boolean | null;
|
|
2088
|
+
/** Node animation. */
|
|
2089
|
+
animation?: Animation;
|
|
1947
2090
|
}
|
|
1948
2091
|
declare enum InitialExpandedItems {
|
|
1949
2092
|
/** First item will be expended initally */
|
|
@@ -1986,6 +2129,8 @@ interface TableData {
|
|
|
1986
2129
|
cellPadding?: number[];
|
|
1987
2130
|
/** Table's alternative text. */
|
|
1988
2131
|
altText?: string | null;
|
|
2132
|
+
/** Node animation. */
|
|
2133
|
+
animation?: Animation;
|
|
1989
2134
|
}
|
|
1990
2135
|
interface Dimensions {
|
|
1991
2136
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
@@ -2094,6 +2239,8 @@ interface AudioData {
|
|
|
2094
2239
|
authorName?: string | null;
|
|
2095
2240
|
/** An HTML version of the audio node. */
|
|
2096
2241
|
html?: string | null;
|
|
2242
|
+
/** Node animation. */
|
|
2243
|
+
animation?: Animation;
|
|
2097
2244
|
}
|
|
2098
2245
|
interface OrderedListData {
|
|
2099
2246
|
/** Indentation level from 0-4. */
|
|
@@ -2102,16 +2249,22 @@ interface OrderedListData {
|
|
|
2102
2249
|
offset?: number | null;
|
|
2103
2250
|
/** List start number. */
|
|
2104
2251
|
start?: number | null;
|
|
2252
|
+
/** Node animation. */
|
|
2253
|
+
animation?: Animation;
|
|
2105
2254
|
}
|
|
2106
2255
|
interface BulletedListData {
|
|
2107
2256
|
/** Indentation level from 0-4. */
|
|
2108
2257
|
indentation?: number;
|
|
2109
2258
|
/** Offset level from 0-4. */
|
|
2110
2259
|
offset?: number | null;
|
|
2260
|
+
/** Node animation. */
|
|
2261
|
+
animation?: Animation;
|
|
2111
2262
|
}
|
|
2112
2263
|
interface BlockquoteData {
|
|
2113
2264
|
/** Indentation level from 1-4. */
|
|
2114
2265
|
indentation?: number;
|
|
2266
|
+
/** Node animation. */
|
|
2267
|
+
animation?: Animation;
|
|
2115
2268
|
}
|
|
2116
2269
|
interface CaptionData {
|
|
2117
2270
|
textStyle?: TextStyle;
|
|
@@ -2169,6 +2322,8 @@ interface LayoutData {
|
|
|
2169
2322
|
background?: LayoutDataBackground;
|
|
2170
2323
|
/** Backdrop styling (color or gradient). */
|
|
2171
2324
|
backdrop?: Backdrop;
|
|
2325
|
+
/** Node animation. */
|
|
2326
|
+
animation?: Animation;
|
|
2172
2327
|
}
|
|
2173
2328
|
declare enum ImageScalingScaling {
|
|
2174
2329
|
/** Auto image scaling */
|
|
@@ -2320,6 +2475,8 @@ interface ShapeData {
|
|
|
2320
2475
|
shape?: V1Media;
|
|
2321
2476
|
/** Styling for the shape. */
|
|
2322
2477
|
styles?: ShapeDataStyles;
|
|
2478
|
+
/** Node animation. */
|
|
2479
|
+
animation?: Animation;
|
|
2323
2480
|
}
|
|
2324
2481
|
interface ShapeDataStyles {
|
|
2325
2482
|
/**
|
|
@@ -2422,6 +2579,8 @@ interface TocData {
|
|
|
2422
2579
|
color?: string | null;
|
|
2423
2580
|
/** Indentation style. Default: NESTED. */
|
|
2424
2581
|
indentation?: IndentationWithLiterals;
|
|
2582
|
+
/** Node animation. */
|
|
2583
|
+
animation?: Animation;
|
|
2425
2584
|
}
|
|
2426
2585
|
/** List style. */
|
|
2427
2586
|
declare enum ListStyle {
|
|
@@ -2468,6 +2627,8 @@ interface SmartBlockData {
|
|
|
2468
2627
|
borderWidth?: number | null;
|
|
2469
2628
|
/** Border radius in pixels (for SOLID_JOINED_BOXES variant). */
|
|
2470
2629
|
borderRadius?: number | null;
|
|
2630
|
+
/** Node animation. */
|
|
2631
|
+
animation?: Animation;
|
|
2471
2632
|
}
|
|
2472
2633
|
/** Layout type of the smart block */
|
|
2473
2634
|
declare enum SmartBlockDataType {
|
|
@@ -2571,10 +2732,14 @@ interface CheckboxListData {
|
|
|
2571
2732
|
indentation?: number;
|
|
2572
2733
|
/** Offset level from 0-4. */
|
|
2573
2734
|
offset?: number | null;
|
|
2735
|
+
/** Node animation. */
|
|
2736
|
+
animation?: Animation;
|
|
2574
2737
|
}
|
|
2575
2738
|
interface ListItemNodeData {
|
|
2576
2739
|
/** Checkbox list item state. Defaults to `false`. */
|
|
2577
2740
|
checked?: boolean | null;
|
|
2741
|
+
/** Node animation. */
|
|
2742
|
+
animation?: Animation;
|
|
2578
2743
|
}
|
|
2579
2744
|
interface Metadata {
|
|
2580
2745
|
/** Schema version. */
|
|
@@ -3127,6 +3292,172 @@ interface GetTotalPostsResponse {
|
|
|
3127
3292
|
/** Total amount of published posts. */
|
|
3128
3293
|
total?: number;
|
|
3129
3294
|
}
|
|
3295
|
+
interface ListDemoPostsRequest {
|
|
3296
|
+
/**
|
|
3297
|
+
* Whether to return only featured posts.
|
|
3298
|
+
*
|
|
3299
|
+
* Default: `false`
|
|
3300
|
+
*/
|
|
3301
|
+
featured?: boolean;
|
|
3302
|
+
/**
|
|
3303
|
+
* Hashtag filter.
|
|
3304
|
+
*
|
|
3305
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3306
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3307
|
+
* @maxSize 100
|
|
3308
|
+
* @maxLength 100
|
|
3309
|
+
*/
|
|
3310
|
+
hashtags?: string[];
|
|
3311
|
+
/**
|
|
3312
|
+
* Category filter.
|
|
3313
|
+
*
|
|
3314
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3315
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3316
|
+
* @maxSize 50
|
|
3317
|
+
* @format GUID
|
|
3318
|
+
*/
|
|
3319
|
+
categoryIds?: string[];
|
|
3320
|
+
/**
|
|
3321
|
+
* Tag filter.
|
|
3322
|
+
*
|
|
3323
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3324
|
+
* If omitted, all posts with or without tags are returned.
|
|
3325
|
+
* @maxSize 50
|
|
3326
|
+
* @format GUID
|
|
3327
|
+
*/
|
|
3328
|
+
tagIds?: string[];
|
|
3329
|
+
/**
|
|
3330
|
+
* Sorting options.
|
|
3331
|
+
*
|
|
3332
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3333
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3334
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3335
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3336
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3337
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3338
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3339
|
+
* - `RATING`: reserved for internal use.
|
|
3340
|
+
*
|
|
3341
|
+
* Default: `FEED`
|
|
3342
|
+
*/
|
|
3343
|
+
sort?: GetPostsSortWithLiterals;
|
|
3344
|
+
/** Pagination options. */
|
|
3345
|
+
paging?: BlogPaging;
|
|
3346
|
+
/**
|
|
3347
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
3348
|
+
* This parameter will be removed on June 30, 2023.
|
|
3349
|
+
*
|
|
3350
|
+
* List of post fields to be included in the response.
|
|
3351
|
+
* @maxSize 20
|
|
3352
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3353
|
+
* This parameter will be removed on June 30, 2023.
|
|
3354
|
+
*
|
|
3355
|
+
* List of post fields to be included in the response.
|
|
3356
|
+
* @replacedBy fieldsets
|
|
3357
|
+
* @targetRemovalDate 2024-06-30
|
|
3358
|
+
*/
|
|
3359
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3360
|
+
/**
|
|
3361
|
+
* Language filter.
|
|
3362
|
+
*
|
|
3363
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3364
|
+
* Pass a language to only receive posts that are in that language.
|
|
3365
|
+
* If omitted, posts in all languages are returned.
|
|
3366
|
+
* @format LANGUAGE_TAG
|
|
3367
|
+
*/
|
|
3368
|
+
language?: string | null;
|
|
3369
|
+
/**
|
|
3370
|
+
* Post owner's member ID.
|
|
3371
|
+
* @format GUID
|
|
3372
|
+
*/
|
|
3373
|
+
memberId?: string | null;
|
|
3374
|
+
/**
|
|
3375
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3376
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3377
|
+
* only the post’s base fields are returned.
|
|
3378
|
+
* @maxSize 20
|
|
3379
|
+
*/
|
|
3380
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3381
|
+
}
|
|
3382
|
+
declare enum GetPostsSort {
|
|
3383
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3384
|
+
FEED = "FEED",
|
|
3385
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3386
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3387
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3388
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3389
|
+
/** Ordered by total number of views in descending order. */
|
|
3390
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3391
|
+
/** Ordered by total number of likes in descending order. */
|
|
3392
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3393
|
+
/** Ordered by `title` in ascending order. */
|
|
3394
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3395
|
+
/** Ordered by `title` in descending order. */
|
|
3396
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3397
|
+
}
|
|
3398
|
+
/** @enumType */
|
|
3399
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3400
|
+
interface BlogPaging {
|
|
3401
|
+
/**
|
|
3402
|
+
* Number of items to skip in the current sort order.
|
|
3403
|
+
*
|
|
3404
|
+
*
|
|
3405
|
+
* Default: `0`
|
|
3406
|
+
*/
|
|
3407
|
+
offset?: number;
|
|
3408
|
+
/**
|
|
3409
|
+
* Number of items to return.
|
|
3410
|
+
*
|
|
3411
|
+
*
|
|
3412
|
+
* Default:`50`
|
|
3413
|
+
* @min 1
|
|
3414
|
+
* @max 100
|
|
3415
|
+
*/
|
|
3416
|
+
limit?: number;
|
|
3417
|
+
/**
|
|
3418
|
+
* Pointer to the next or previous page in the list of results.
|
|
3419
|
+
* @maxLength 2000
|
|
3420
|
+
*/
|
|
3421
|
+
cursor?: string | null;
|
|
3422
|
+
}
|
|
3423
|
+
declare enum PostFieldField {
|
|
3424
|
+
UNKNOWN = "UNKNOWN",
|
|
3425
|
+
/** Includes post URL when present. */
|
|
3426
|
+
URL = "URL",
|
|
3427
|
+
/** Includes post content text string when present. */
|
|
3428
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3429
|
+
/** Includes post metrics when present. */
|
|
3430
|
+
METRICS = "METRICS",
|
|
3431
|
+
/** Includes SEO data. */
|
|
3432
|
+
SEO = "SEO",
|
|
3433
|
+
/** Includes post owner's contact ID. */
|
|
3434
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3435
|
+
/** Includes post rich content. */
|
|
3436
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3437
|
+
/** Includes post reference ID field. */
|
|
3438
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3439
|
+
}
|
|
3440
|
+
/** @enumType */
|
|
3441
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3442
|
+
interface ListDemoPostsResponse {
|
|
3443
|
+
/** List of posts. */
|
|
3444
|
+
posts?: Post[];
|
|
3445
|
+
/** Details on the paged set of results returned. */
|
|
3446
|
+
metaData?: MetaData;
|
|
3447
|
+
}
|
|
3448
|
+
interface MetaData {
|
|
3449
|
+
/** Number of items returned in this response. */
|
|
3450
|
+
count?: number;
|
|
3451
|
+
/** Requested offset. */
|
|
3452
|
+
offset?: number;
|
|
3453
|
+
/** Total number of items that match the query. */
|
|
3454
|
+
total?: number;
|
|
3455
|
+
/**
|
|
3456
|
+
* Pointer to the next or previous page in the list of results.
|
|
3457
|
+
* @maxLength 2000
|
|
3458
|
+
*/
|
|
3459
|
+
cursor?: string | null;
|
|
3460
|
+
}
|
|
3130
3461
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3131
3462
|
/**
|
|
3132
3463
|
* Member ID of person who triggered the counter update
|
|
@@ -3196,25 +3527,6 @@ interface GetPostRequest {
|
|
|
3196
3527
|
*/
|
|
3197
3528
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3198
3529
|
}
|
|
3199
|
-
declare enum PostFieldField {
|
|
3200
|
-
UNKNOWN = "UNKNOWN",
|
|
3201
|
-
/** Includes post URL when present. */
|
|
3202
|
-
URL = "URL",
|
|
3203
|
-
/** Includes post content text string when present. */
|
|
3204
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3205
|
-
/** Includes post metrics when present. */
|
|
3206
|
-
METRICS = "METRICS",
|
|
3207
|
-
/** Includes SEO data. */
|
|
3208
|
-
SEO = "SEO",
|
|
3209
|
-
/** Includes post owner's contact ID. */
|
|
3210
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3211
|
-
/** Includes post rich content. */
|
|
3212
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3213
|
-
/** Includes post reference ID field. */
|
|
3214
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3215
|
-
}
|
|
3216
|
-
/** @enumType */
|
|
3217
|
-
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3218
3530
|
interface GetPostResponse {
|
|
3219
3531
|
/** Retrieved post info. */
|
|
3220
3532
|
post?: Post;
|
|
@@ -3307,66 +3619,12 @@ interface ListPostsRequest {
|
|
|
3307
3619
|
*/
|
|
3308
3620
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3309
3621
|
}
|
|
3310
|
-
declare enum GetPostsSort {
|
|
3311
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3312
|
-
FEED = "FEED",
|
|
3313
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3314
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3315
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3316
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3317
|
-
/** Ordered by total number of views in descending order. */
|
|
3318
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3319
|
-
/** Ordered by total number of likes in descending order. */
|
|
3320
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3321
|
-
/** Ordered by `title` in ascending order. */
|
|
3322
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3323
|
-
/** Ordered by `title` in descending order. */
|
|
3324
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3325
|
-
}
|
|
3326
|
-
/** @enumType */
|
|
3327
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3328
|
-
interface BlogPaging {
|
|
3329
|
-
/**
|
|
3330
|
-
* Number of items to skip in the current sort order.
|
|
3331
|
-
*
|
|
3332
|
-
*
|
|
3333
|
-
* Default: `0`
|
|
3334
|
-
*/
|
|
3335
|
-
offset?: number;
|
|
3336
|
-
/**
|
|
3337
|
-
* Number of items to return.
|
|
3338
|
-
*
|
|
3339
|
-
*
|
|
3340
|
-
* Default:`50`
|
|
3341
|
-
* @min 1
|
|
3342
|
-
* @max 100
|
|
3343
|
-
*/
|
|
3344
|
-
limit?: number;
|
|
3345
|
-
/**
|
|
3346
|
-
* Pointer to the next or previous page in the list of results.
|
|
3347
|
-
* @maxLength 2000
|
|
3348
|
-
*/
|
|
3349
|
-
cursor?: string | null;
|
|
3350
|
-
}
|
|
3351
3622
|
interface ListPostsResponse {
|
|
3352
3623
|
/** List of retrieved posts. */
|
|
3353
3624
|
posts?: Post[];
|
|
3354
3625
|
/** Details on the paged set of results returned. */
|
|
3355
3626
|
metaData?: MetaData;
|
|
3356
3627
|
}
|
|
3357
|
-
interface MetaData {
|
|
3358
|
-
/** Number of items returned in this response. */
|
|
3359
|
-
count?: number;
|
|
3360
|
-
/** Requested offset. */
|
|
3361
|
-
offset?: number;
|
|
3362
|
-
/** Total number of items that match the query. */
|
|
3363
|
-
total?: number;
|
|
3364
|
-
/**
|
|
3365
|
-
* Pointer to the next or previous page in the list of results.
|
|
3366
|
-
* @maxLength 2000
|
|
3367
|
-
*/
|
|
3368
|
-
cursor?: string | null;
|
|
3369
|
-
}
|
|
3370
3628
|
interface QueryPostsRequest {
|
|
3371
3629
|
/** Query options. */
|
|
3372
3630
|
query?: PlatformQuery;
|
|
@@ -3386,6 +3644,11 @@ interface Sorting {
|
|
|
3386
3644
|
fieldName?: string;
|
|
3387
3645
|
/** Sort order. */
|
|
3388
3646
|
order?: SortOrderWithLiterals;
|
|
3647
|
+
/**
|
|
3648
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
3649
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
3650
|
+
*/
|
|
3651
|
+
origin?: AddressLocation;
|
|
3389
3652
|
}
|
|
3390
3653
|
declare enum SortOrder {
|
|
3391
3654
|
ASC = "ASC",
|
|
@@ -3393,6 +3656,12 @@ declare enum SortOrder {
|
|
|
3393
3656
|
}
|
|
3394
3657
|
/** @enumType */
|
|
3395
3658
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3659
|
+
interface AddressLocation {
|
|
3660
|
+
/** Address latitude. */
|
|
3661
|
+
latitude?: number | null;
|
|
3662
|
+
/** Address longitude. */
|
|
3663
|
+
longitude?: number | null;
|
|
3664
|
+
}
|
|
3396
3665
|
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
3397
3666
|
/** Paging options to limit and skip the number of items. */
|
|
3398
3667
|
paging?: Paging;
|
|
@@ -3710,121 +3979,6 @@ interface PostCount {
|
|
|
3710
3979
|
/** Number of posts. */
|
|
3711
3980
|
postCount?: number;
|
|
3712
3981
|
}
|
|
3713
|
-
interface ListDemoPostsRequest {
|
|
3714
|
-
/**
|
|
3715
|
-
* Whether to return only featured posts.
|
|
3716
|
-
*
|
|
3717
|
-
* Default: `false`
|
|
3718
|
-
*/
|
|
3719
|
-
featured?: boolean;
|
|
3720
|
-
/**
|
|
3721
|
-
* Hashtag filter.
|
|
3722
|
-
*
|
|
3723
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3724
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
3725
|
-
* @maxSize 100
|
|
3726
|
-
* @maxLength 100
|
|
3727
|
-
*/
|
|
3728
|
-
hashtags?: string[];
|
|
3729
|
-
/**
|
|
3730
|
-
* Category filter.
|
|
3731
|
-
*
|
|
3732
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3733
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
3734
|
-
* @maxSize 50
|
|
3735
|
-
* @format GUID
|
|
3736
|
-
*/
|
|
3737
|
-
categoryIds?: string[];
|
|
3738
|
-
/**
|
|
3739
|
-
* Tag filter.
|
|
3740
|
-
*
|
|
3741
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3742
|
-
* If omitted, all posts with or without tags are returned.
|
|
3743
|
-
* @maxSize 50
|
|
3744
|
-
* @format GUID
|
|
3745
|
-
*/
|
|
3746
|
-
tagIds?: string[];
|
|
3747
|
-
/**
|
|
3748
|
-
* Sorting options.
|
|
3749
|
-
*
|
|
3750
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3751
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3752
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3753
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3754
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3755
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3756
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3757
|
-
* - `RATING`: reserved for internal use.
|
|
3758
|
-
*
|
|
3759
|
-
* Default: `FEED`
|
|
3760
|
-
*/
|
|
3761
|
-
sort?: GetPostsSortWithLiterals;
|
|
3762
|
-
/** Pagination options. */
|
|
3763
|
-
paging?: BlogPaging;
|
|
3764
|
-
/**
|
|
3765
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
3766
|
-
* This parameter will be removed on June 30, 2023.
|
|
3767
|
-
*
|
|
3768
|
-
* List of post fields to be included in the response.
|
|
3769
|
-
* @maxSize 20
|
|
3770
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3771
|
-
* This parameter will be removed on June 30, 2023.
|
|
3772
|
-
*
|
|
3773
|
-
* List of post fields to be included in the response.
|
|
3774
|
-
* @replacedBy fieldsets
|
|
3775
|
-
* @targetRemovalDate 2024-06-30
|
|
3776
|
-
*/
|
|
3777
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3778
|
-
/**
|
|
3779
|
-
* Language filter.
|
|
3780
|
-
*
|
|
3781
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3782
|
-
* Pass a language to only receive posts that are in that language.
|
|
3783
|
-
* If omitted, posts in all languages are returned.
|
|
3784
|
-
* @format LANGUAGE_TAG
|
|
3785
|
-
*/
|
|
3786
|
-
language?: string | null;
|
|
3787
|
-
/**
|
|
3788
|
-
* Post owner's member ID.
|
|
3789
|
-
* @format GUID
|
|
3790
|
-
*/
|
|
3791
|
-
memberId?: string | null;
|
|
3792
|
-
/**
|
|
3793
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3794
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3795
|
-
* only the post’s base fields are returned.
|
|
3796
|
-
* @maxSize 20
|
|
3797
|
-
*/
|
|
3798
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3799
|
-
}
|
|
3800
|
-
interface ListDemoPostsResponse {
|
|
3801
|
-
/** List of posts. */
|
|
3802
|
-
posts?: Post[];
|
|
3803
|
-
/** Details on the paged set of results returned. */
|
|
3804
|
-
metaData?: MetaData;
|
|
3805
|
-
}
|
|
3806
|
-
interface ConvertDraftJsToRichContentRequest {
|
|
3807
|
-
/** DraftJs content to convert to Rich content. */
|
|
3808
|
-
content?: Record<string, any> | null;
|
|
3809
|
-
}
|
|
3810
|
-
interface ConvertDraftJsToRichContentResponse {
|
|
3811
|
-
/**
|
|
3812
|
-
* Rich content converted from DraftJs content.
|
|
3813
|
-
* @maxLength 2000000
|
|
3814
|
-
*/
|
|
3815
|
-
richContent?: string;
|
|
3816
|
-
}
|
|
3817
|
-
interface ConvertRichContentToDraftJsRequest {
|
|
3818
|
-
/**
|
|
3819
|
-
* Rich content to convert to DraftJs content.
|
|
3820
|
-
* @maxLength 2000000
|
|
3821
|
-
*/
|
|
3822
|
-
richContent?: string;
|
|
3823
|
-
}
|
|
3824
|
-
interface ConvertRichContentToDraftJsResponse {
|
|
3825
|
-
/** DraftJs content converted from Rich content. */
|
|
3826
|
-
content?: Record<string, any> | null;
|
|
3827
|
-
}
|
|
3828
3982
|
interface BaseEventMetadata {
|
|
3829
3983
|
/**
|
|
3830
3984
|
* App instance ID.
|
|
@@ -3972,13 +4126,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3972
4126
|
/**
|
|
3973
4127
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3974
4128
|
*
|
|
3975
|
-
*
|
|
3976
|
-
* The
|
|
3977
|
-
*
|
|
3978
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3979
|
-
*
|
|
3980
|
-
*
|
|
4129
|
+
*
|
|
4130
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
4131
|
+
*
|
|
4132
|
+
* 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.
|
|
4133
|
+
*
|
|
4134
|
+
* >**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.
|
|
3981
4135
|
* @public
|
|
4136
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
3982
4137
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3983
4138
|
* @applicableIdentity APP
|
|
3984
4139
|
* @returns Get Blog Post Count Stats response
|
|
@@ -4019,6 +4174,7 @@ interface QueryPostCountStatsOptions {
|
|
|
4019
4174
|
/**
|
|
4020
4175
|
* Retrieves the total amount of published posts of the blog.
|
|
4021
4176
|
* @public
|
|
4177
|
+
* @param options - Language Options.
|
|
4022
4178
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4023
4179
|
* @applicableIdentity APP
|
|
4024
4180
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -4039,12 +4195,12 @@ interface GetTotalPostsOptions {
|
|
|
4039
4195
|
* @param postId - Post ID.
|
|
4040
4196
|
* @public
|
|
4041
4197
|
* @requiredField postId
|
|
4198
|
+
* @param options - Options specifying which fields to return.
|
|
4042
4199
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4043
4200
|
* @applicableIdentity APP
|
|
4044
|
-
* @returns Retrieved post info.
|
|
4045
4201
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4046
4202
|
*/
|
|
4047
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4203
|
+
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>>;
|
|
4048
4204
|
interface GetPostOptions {
|
|
4049
4205
|
/**
|
|
4050
4206
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4064,6 +4220,7 @@ interface GetPostOptions {
|
|
|
4064
4220
|
* @param slug - Slug of the post to retrieve.
|
|
4065
4221
|
* @public
|
|
4066
4222
|
* @requiredField slug
|
|
4223
|
+
* @param options - Options specifying which fields to return.
|
|
4067
4224
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4068
4225
|
* @applicableIdentity APP
|
|
4069
4226
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -4091,6 +4248,7 @@ interface GetPostBySlugOptions {
|
|
|
4091
4248
|
* - `paging.limit` is `50`.
|
|
4092
4249
|
* - `paging.offset` is `0`.
|
|
4093
4250
|
* @public
|
|
4251
|
+
* @param options - Sort, filter, and paging options.
|
|
4094
4252
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4095
4253
|
* @applicableIdentity APP
|
|
4096
4254
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4161,18 +4319,26 @@ interface ListPostsOptions {
|
|
|
4161
4319
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4162
4320
|
}
|
|
4163
4321
|
/**
|
|
4164
|
-
*
|
|
4322
|
+
* Creates a query to retrieve a list of posts.
|
|
4165
4323
|
*
|
|
4166
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4167
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4168
|
-
* - `paging.limit` is `50`.
|
|
4169
|
-
* - `paging.offset` is `0`.
|
|
4170
4324
|
*
|
|
4171
|
-
*
|
|
4172
|
-
*
|
|
4173
|
-
*
|
|
4174
|
-
*
|
|
4325
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4326
|
+
*
|
|
4327
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4328
|
+
*
|
|
4329
|
+
* 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.
|
|
4330
|
+
*
|
|
4331
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4332
|
+
* + `limit(50)`
|
|
4333
|
+
* + `descending('firstPublishedDate')`
|
|
4334
|
+
*
|
|
4335
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4336
|
+
*
|
|
4337
|
+
* To learn how to query posts, refer to the table below.
|
|
4338
|
+
*
|
|
4339
|
+
* 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`.
|
|
4175
4340
|
* @public
|
|
4341
|
+
* @param options - Options specifying which fields to return.
|
|
4176
4342
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4177
4343
|
* @applicableIdentity APP
|
|
4178
4344
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -4416,6 +4582,11 @@ type PostQuery = {
|
|
|
4416
4582
|
Sort order.
|
|
4417
4583
|
*/
|
|
4418
4584
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
4585
|
+
/**
|
|
4586
|
+
Origin point for geo-distance sorting on a GEO field
|
|
4587
|
+
results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
4588
|
+
*/
|
|
4589
|
+
origin?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['origin'];
|
|
4419
4590
|
}[];
|
|
4420
4591
|
};
|
|
4421
4592
|
declare const utils: {
|
|
@@ -4438,4 +4609,4 @@ declare const utils: {
|
|
|
4438
4609
|
*/
|
|
4439
4610
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4440
4611
|
|
|
4441
|
-
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,
|
|
4612
|
+
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 };
|