@wix/auto_sdk_blog_posts 1.0.159 → 1.0.160
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 +31 -85
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +154 -534
- package/build/cjs/index.typings.js +21 -80
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +125 -517
- package/build/cjs/meta.js +15 -74
- 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 +31 -82
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +154 -534
- package/build/es/index.typings.mjs +21 -77
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +125 -517
- package/build/es/meta.mjs +15 -71
- 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 +31 -85
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +154 -534
- package/build/internal/cjs/index.typings.js +21 -80
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +125 -517
- package/build/internal/cjs/meta.js +15 -74
- 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 +31 -82
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +154 -534
- package/build/internal/es/index.typings.mjs +21 -77
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +125 -517
- package/build/internal/es/meta.mjs +15 -71
- 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
|
@@ -2197,14 +2197,14 @@ declare enum ImagePosition {
|
|
|
2197
2197
|
}
|
|
2198
2198
|
/** @enumType */
|
|
2199
2199
|
type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
|
|
2200
|
-
declare enum
|
|
2200
|
+
declare enum Origin {
|
|
2201
2201
|
/** Banner originated from an image */
|
|
2202
2202
|
IMAGE = "IMAGE",
|
|
2203
2203
|
/** Banner originated from a layout */
|
|
2204
2204
|
LAYOUT = "LAYOUT"
|
|
2205
2205
|
}
|
|
2206
2206
|
/** @enumType */
|
|
2207
|
-
type
|
|
2207
|
+
type OriginWithLiterals = Origin | 'IMAGE' | 'LAYOUT';
|
|
2208
2208
|
declare enum BannerPosition {
|
|
2209
2209
|
/** Attached to the top edge (banner) */
|
|
2210
2210
|
TOP = "TOP",
|
|
@@ -2269,7 +2269,7 @@ declare enum DesignTarget {
|
|
|
2269
2269
|
type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
|
|
2270
2270
|
interface Banner {
|
|
2271
2271
|
/** Origin of the banner */
|
|
2272
|
-
origin?:
|
|
2272
|
+
origin?: OriginWithLiterals;
|
|
2273
2273
|
/** Position of the banner */
|
|
2274
2274
|
position?: BannerPositionWithLiterals;
|
|
2275
2275
|
}
|
|
@@ -2611,7 +2611,7 @@ interface ModerationDetails {
|
|
|
2611
2611
|
/** Date the post was submitted for review. */
|
|
2612
2612
|
submittedDate?: Date | null;
|
|
2613
2613
|
/** Status indicating whether the submission was approved or rejected by the moderator. */
|
|
2614
|
-
status?:
|
|
2614
|
+
status?: StatusWithLiterals;
|
|
2615
2615
|
/**
|
|
2616
2616
|
* Member ID of the person who approved or rejected the post.
|
|
2617
2617
|
* @format GUID
|
|
@@ -2620,13 +2620,13 @@ interface ModerationDetails {
|
|
|
2620
2620
|
/** Date the post was approved or rejected. */
|
|
2621
2621
|
moderationDate?: Date | null;
|
|
2622
2622
|
}
|
|
2623
|
-
declare enum
|
|
2623
|
+
declare enum Status {
|
|
2624
2624
|
UNKNOWN = "UNKNOWN",
|
|
2625
2625
|
APPROVED = "APPROVED",
|
|
2626
2626
|
REJECTED = "REJECTED"
|
|
2627
2627
|
}
|
|
2628
2628
|
/** @enumType */
|
|
2629
|
-
type
|
|
2629
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
|
2630
2630
|
interface Media extends MediaMediaOneOf {
|
|
2631
2631
|
/** Wix Media details. */
|
|
2632
2632
|
wixMedia?: WixMedia;
|
|
@@ -2824,433 +2824,125 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2824
2824
|
*/
|
|
2825
2825
|
anonymousVisitorId?: string | null;
|
|
2826
2826
|
}
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
*/
|
|
2838
|
-
language?: string | null;
|
|
2839
|
-
/** Returns post template categories when set to TRUE */
|
|
2840
|
-
listTemplateCategories?: boolean;
|
|
2841
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2842
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2843
|
-
/** Pagination options. */
|
|
2844
|
-
paging?: BlogPaging;
|
|
2845
|
-
}
|
|
2846
|
-
declare enum GetPostTemplatesSort {
|
|
2847
|
-
/** Sort by ascending publishing date. */
|
|
2848
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2849
|
-
/** Sort by descending publishing date. */
|
|
2850
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2851
|
-
}
|
|
2852
|
-
/** @enumType */
|
|
2853
|
-
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2854
|
-
interface BlogPaging {
|
|
2855
|
-
/**
|
|
2856
|
-
* Number of items to skip in the current sort order.
|
|
2857
|
-
*
|
|
2858
|
-
*
|
|
2859
|
-
* Default: `0`
|
|
2860
|
-
*/
|
|
2861
|
-
offset?: number;
|
|
2862
|
-
/**
|
|
2863
|
-
* Number of items to return.
|
|
2864
|
-
*
|
|
2865
|
-
*
|
|
2866
|
-
* Default:`50`
|
|
2867
|
-
* @min 1
|
|
2868
|
-
* @max 100
|
|
2869
|
-
*/
|
|
2870
|
-
limit?: number;
|
|
2871
|
-
/**
|
|
2872
|
-
* Pointer to the next or previous page in the list of results.
|
|
2873
|
-
* @maxLength 2000
|
|
2874
|
-
*/
|
|
2875
|
-
cursor?: string | null;
|
|
2876
|
-
}
|
|
2877
|
-
interface ListTemplatesResponse {
|
|
2878
|
-
/** Available post templates */
|
|
2879
|
-
postTemplates?: Post[];
|
|
2880
|
-
/** Details on the paged set of posts templates returned. */
|
|
2881
|
-
postTemplatesMetaData?: MetaData;
|
|
2882
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2883
|
-
templateCategories?: Category[];
|
|
2884
|
-
}
|
|
2885
|
-
interface MetaData {
|
|
2886
|
-
/** Number of items returned in this response. */
|
|
2887
|
-
count?: number;
|
|
2888
|
-
/** Requested offset. */
|
|
2889
|
-
offset?: number;
|
|
2890
|
-
/** Total number of items that match the query. */
|
|
2891
|
-
total?: number;
|
|
2892
|
-
/**
|
|
2893
|
-
* Pointer to the next or previous page in the list of results.
|
|
2894
|
-
* @maxLength 2000
|
|
2895
|
-
*/
|
|
2896
|
-
cursor?: string | null;
|
|
2897
|
-
}
|
|
2898
|
-
interface Category {
|
|
2899
|
-
/**
|
|
2900
|
-
* Category ID.
|
|
2901
|
-
* @immutable
|
|
2902
|
-
* @maxLength 38
|
|
2903
|
-
*/
|
|
2904
|
-
_id?: string;
|
|
2905
|
-
/**
|
|
2906
|
-
* Category label. Displayed in the Category Menu.
|
|
2907
|
-
* @maxLength 35
|
|
2908
|
-
*/
|
|
2909
|
-
label?: string;
|
|
2910
|
-
/**
|
|
2911
|
-
* Number of posts in the category.
|
|
2912
|
-
* @readonly
|
|
2913
|
-
*/
|
|
2914
|
-
postCount?: number;
|
|
2915
|
-
/**
|
|
2916
|
-
* The `url` of the page that lists every post with the specified category.
|
|
2917
|
-
* @readonly
|
|
2918
|
-
*/
|
|
2919
|
-
url?: string;
|
|
2920
|
-
/**
|
|
2921
|
-
* Category description.
|
|
2922
|
-
* @maxLength 500
|
|
2923
|
-
*/
|
|
2924
|
-
description?: string | null;
|
|
2925
|
-
/**
|
|
2926
|
-
* Category title.
|
|
2927
|
-
* @maxLength 200
|
|
2928
|
-
* @deprecated Category title.
|
|
2929
|
-
* @targetRemovalDate 2025-07-16
|
|
2930
|
-
*/
|
|
2931
|
-
title?: string;
|
|
2932
|
-
/**
|
|
2933
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2934
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2935
|
-
*
|
|
2936
|
-
* Default: `-1`
|
|
2937
|
-
*/
|
|
2938
|
-
displayPosition?: number | null;
|
|
2939
|
-
/**
|
|
2940
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2941
|
-
* @format GUID
|
|
2942
|
-
*/
|
|
2943
|
-
translationId?: string | null;
|
|
2827
|
+
/** Get Blog Publications Count Stats request */
|
|
2828
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2829
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2830
|
+
rangeStart?: Date | null;
|
|
2831
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2832
|
+
rangeEnd?: Date | null;
|
|
2833
|
+
/** Order of the returned results. */
|
|
2834
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2835
|
+
/** Number of months to include in the response. */
|
|
2836
|
+
months?: number;
|
|
2944
2837
|
/**
|
|
2945
|
-
*
|
|
2838
|
+
* Language filter
|
|
2946
2839
|
*
|
|
2947
2840
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2948
|
-
* @immutable
|
|
2949
|
-
*/
|
|
2950
|
-
language?: string | null;
|
|
2951
|
-
/**
|
|
2952
|
-
* Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
|
|
2953
|
-
* @maxLength 100
|
|
2954
|
-
*/
|
|
2955
|
-
slug?: string;
|
|
2956
|
-
/** SEO data. */
|
|
2957
|
-
seoData?: SeoSchema;
|
|
2958
|
-
/** Category cover image. */
|
|
2959
|
-
coverImage?: string;
|
|
2960
|
-
/**
|
|
2961
|
-
* Date and time the Category was last updated.
|
|
2962
|
-
* @readonly
|
|
2963
|
-
*/
|
|
2964
|
-
_updatedDate?: Date | null;
|
|
2965
|
-
}
|
|
2966
|
-
interface CategoryTranslation {
|
|
2967
|
-
/**
|
|
2968
|
-
* Category ID.
|
|
2969
|
-
* @format GUID
|
|
2970
|
-
*/
|
|
2971
|
-
_id?: string;
|
|
2972
|
-
/**
|
|
2973
|
-
* Label displayed in the categories menu on the site.
|
|
2974
|
-
* @maxLength 100
|
|
2975
|
-
*/
|
|
2976
|
-
label?: string | null;
|
|
2977
|
-
/**
|
|
2978
|
-
* Language of the category.
|
|
2979
2841
|
* @format LANGUAGE_TAG
|
|
2980
2842
|
*/
|
|
2981
2843
|
language?: string | null;
|
|
2982
|
-
/** URL of this category page. */
|
|
2983
|
-
url?: string;
|
|
2984
|
-
}
|
|
2985
|
-
interface GetTemplateRequest {
|
|
2986
2844
|
/**
|
|
2987
|
-
*
|
|
2988
|
-
* @
|
|
2845
|
+
* Timezone of the client.
|
|
2846
|
+
* @minLength 3
|
|
2847
|
+
* @maxLength 100
|
|
2989
2848
|
*/
|
|
2990
|
-
|
|
2849
|
+
timeZone?: string | null;
|
|
2991
2850
|
}
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
|
|
2851
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2852
|
+
UNKNOWN = "UNKNOWN",
|
|
2853
|
+
OLDEST = "OLDEST",
|
|
2854
|
+
NEWEST = "NEWEST"
|
|
2995
2855
|
}
|
|
2996
|
-
|
|
2997
|
-
|
|
2998
|
-
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
|
|
2856
|
+
/** @enumType */
|
|
2857
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2858
|
+
/** Get Blog Publications Count Stats response */
|
|
2859
|
+
interface QueryPublicationsCountStatsResponse {
|
|
2860
|
+
/** Chronologically ordered list of publications. */
|
|
2861
|
+
stats?: PeriodPublicationsCount[];
|
|
3002
2862
|
}
|
|
3003
|
-
|
|
3004
|
-
|
|
3005
|
-
|
|
2863
|
+
/** Publications count for a specific time period */
|
|
2864
|
+
interface PeriodPublicationsCount {
|
|
2865
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2866
|
+
periodStart?: Date | null;
|
|
2867
|
+
/** Number of posts published during this month. */
|
|
2868
|
+
publicationsCount?: number;
|
|
3006
2869
|
}
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3011
|
-
* @maxLength 38
|
|
3012
|
-
*/
|
|
3013
|
-
_id?: string;
|
|
3014
|
-
/**
|
|
3015
|
-
* Draft post title.
|
|
3016
|
-
* @maxLength 200
|
|
3017
|
-
*/
|
|
3018
|
-
title?: string;
|
|
2870
|
+
/** Get Blog Post Count Stats request */
|
|
2871
|
+
interface QueryPostCountStatsRequest {
|
|
2872
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2873
|
+
rangeStart?: Date | null;
|
|
3019
2874
|
/**
|
|
3020
|
-
*
|
|
2875
|
+
* Order of returned results.
|
|
3021
2876
|
*
|
|
3022
|
-
*
|
|
3023
|
-
*
|
|
3024
|
-
* @maxLength 500
|
|
3025
|
-
*/
|
|
3026
|
-
excerpt?: string | null;
|
|
3027
|
-
/** Whether the draft post is marked as featured. */
|
|
3028
|
-
featured?: boolean | null;
|
|
3029
|
-
/**
|
|
3030
|
-
* Category IDs of the draft post.
|
|
3031
|
-
* @maxSize 10
|
|
3032
|
-
* @maxLength 38
|
|
3033
|
-
*/
|
|
3034
|
-
categoryIds?: string[];
|
|
3035
|
-
/**
|
|
3036
|
-
* Draft post owner's member ID.
|
|
3037
|
-
* @format GUID
|
|
3038
|
-
*/
|
|
3039
|
-
memberId?: string | null;
|
|
3040
|
-
/**
|
|
3041
|
-
* Hashtags in the post.
|
|
3042
|
-
* @maxSize 100
|
|
3043
|
-
* @maxLength 100
|
|
3044
|
-
*/
|
|
3045
|
-
hashtags?: string[];
|
|
3046
|
-
/** Whether commenting on the draft post is enabled. */
|
|
3047
|
-
commentingEnabled?: boolean | null;
|
|
3048
|
-
/**
|
|
3049
|
-
* Estimated reading time of the draft post (calculated automatically).
|
|
3050
|
-
* @readonly
|
|
3051
|
-
*/
|
|
3052
|
-
minutesToRead?: number;
|
|
3053
|
-
/** Image placed at the top of the blog page. */
|
|
3054
|
-
heroImage?: string;
|
|
3055
|
-
/**
|
|
3056
|
-
* Tag IDs the draft post is tagged with.
|
|
3057
|
-
* @maxSize 30
|
|
3058
|
-
* @maxLength 38
|
|
3059
|
-
*/
|
|
3060
|
-
tagIds?: string[];
|
|
3061
|
-
/**
|
|
3062
|
-
* IDs of posts related to this draft post.
|
|
3063
|
-
* @maxSize 3
|
|
3064
|
-
* @maxLength 38
|
|
3065
|
-
*/
|
|
3066
|
-
relatedPostIds?: string[];
|
|
3067
|
-
/**
|
|
3068
|
-
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
3069
|
-
* @maxSize 100
|
|
3070
|
-
* @format GUID
|
|
3071
|
-
*/
|
|
3072
|
-
pricingPlanIds?: string[];
|
|
3073
|
-
/**
|
|
3074
|
-
* ID of the draft post's translations.
|
|
2877
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
2878
|
+
* - `NEWEST`: posts by date in descending order.
|
|
3075
2879
|
*
|
|
3076
|
-
*
|
|
3077
|
-
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
3078
|
-
* @format GUID
|
|
2880
|
+
* Default: `OLDEST`
|
|
3079
2881
|
*/
|
|
3080
|
-
|
|
2882
|
+
order?: OrderWithLiterals;
|
|
2883
|
+
/** Number of months to include in response. */
|
|
2884
|
+
months?: number;
|
|
3081
2885
|
/**
|
|
3082
|
-
* Language
|
|
2886
|
+
* Language filter.
|
|
3083
2887
|
*
|
|
3084
2888
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2889
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
3085
2890
|
* @format LANGUAGE_TAG
|
|
3086
2891
|
*/
|
|
3087
2892
|
language?: string | null;
|
|
3088
2893
|
/**
|
|
3089
|
-
*
|
|
2894
|
+
* Time zone to use when calculating the start of the month.
|
|
3090
2895
|
*
|
|
3091
|
-
*
|
|
3092
|
-
*
|
|
3093
|
-
* </widget>
|
|
3094
|
-
*/
|
|
3095
|
-
richContent?: RichContent;
|
|
3096
|
-
/**
|
|
3097
|
-
* Status of the draft post.
|
|
3098
|
-
* @readonly
|
|
3099
|
-
*/
|
|
3100
|
-
status?: StatusWithLiterals;
|
|
3101
|
-
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
3102
|
-
moderationDetails?: ModerationDetails;
|
|
3103
|
-
/**
|
|
3104
|
-
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
3105
|
-
* @readonly
|
|
3106
|
-
*/
|
|
3107
|
-
hasUnpublishedChanges?: boolean;
|
|
3108
|
-
/**
|
|
3109
|
-
* Date the draft post was last edited.
|
|
3110
|
-
* @readonly
|
|
3111
|
-
*/
|
|
3112
|
-
editedDate?: Date | null;
|
|
3113
|
-
/**
|
|
3114
|
-
* Date the draft post is scheduled to be published.
|
|
3115
|
-
* @readonly
|
|
3116
|
-
*/
|
|
3117
|
-
scheduledPublishDate?: Date | null;
|
|
3118
|
-
/** Date the post was first published. */
|
|
3119
|
-
firstPublishedDate?: Date | null;
|
|
3120
|
-
/** SEO data. */
|
|
3121
|
-
seoData?: SeoSchema;
|
|
3122
|
-
/**
|
|
3123
|
-
* Draft post URL preview. What the URL will look like once the post is published.
|
|
3124
|
-
* @readonly
|
|
3125
|
-
*/
|
|
3126
|
-
url?: string;
|
|
3127
|
-
/**
|
|
3128
|
-
* Date the draft post was first created.
|
|
3129
|
-
* @readonly
|
|
3130
|
-
*/
|
|
3131
|
-
_createdDate?: Date | null;
|
|
3132
|
-
/**
|
|
3133
|
-
* SEO slug.
|
|
2896
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
2897
|
+
* @minLength 3
|
|
3134
2898
|
* @maxLength 100
|
|
3135
2899
|
*/
|
|
3136
|
-
|
|
3137
|
-
/** Post cover media. */
|
|
3138
|
-
media?: Media;
|
|
3139
|
-
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
3140
|
-
previewTextParagraph?: number | null;
|
|
2900
|
+
timeZone?: string | null;
|
|
3141
2901
|
}
|
|
3142
|
-
declare enum
|
|
2902
|
+
declare enum Order {
|
|
3143
2903
|
UNKNOWN = "UNKNOWN",
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
/** Categories were changed */
|
|
3147
|
-
ADD_CATEGORIES = "ADD_CATEGORIES",
|
|
3148
|
-
/** Saved automatically */
|
|
3149
|
-
AUTO_SAVE = "AUTO_SAVE",
|
|
3150
|
-
/** Copied from template */
|
|
3151
|
-
COPY_TEMPLATE = "COPY_TEMPLATE",
|
|
3152
|
-
/** Imported */
|
|
3153
|
-
IMPORT = "IMPORT",
|
|
3154
|
-
/** Imported in bulk */
|
|
3155
|
-
IMPORT_BULK = "IMPORT_BULK",
|
|
3156
|
-
/** Imported with html import */
|
|
3157
|
-
IMPORT_HTML = "IMPORT_HTML",
|
|
3158
|
-
/** Patch import */
|
|
3159
|
-
IMPORT_PATCH = "IMPORT_PATCH",
|
|
3160
|
-
/** Changed language */
|
|
3161
|
-
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
|
3162
|
-
/** Saved manually */
|
|
3163
|
-
MANUAL_SAVE = "MANUAL_SAVE",
|
|
3164
|
-
/** Affected by migration */
|
|
3165
|
-
MIGRATION = "MIGRATION",
|
|
3166
|
-
/** Affected by moderation */
|
|
3167
|
-
MODERATION = "MODERATION",
|
|
3168
|
-
/** Moved to trash */
|
|
3169
|
-
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
|
3170
|
-
/** Pricing plans were changed */
|
|
3171
|
-
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
|
3172
|
-
/** Was provisioned */
|
|
3173
|
-
PROVISION = "PROVISION",
|
|
3174
|
-
/** Was published */
|
|
3175
|
-
PUBLISH = "PUBLISH",
|
|
3176
|
-
/** Owner was reassigned */
|
|
3177
|
-
REASSIGN_OWNER = "REASSIGN_OWNER",
|
|
3178
|
-
/** Was reblogged */
|
|
3179
|
-
REBLOG = "REBLOG",
|
|
3180
|
-
/** Was restored */
|
|
3181
|
-
RESTORE = "RESTORE",
|
|
3182
|
-
/** Reverted to draft */
|
|
3183
|
-
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
|
3184
|
-
/** Was translated */
|
|
3185
|
-
TRANSLATION = "TRANSLATION",
|
|
3186
|
-
/** Was unpublished */
|
|
3187
|
-
UNPUBLISH = "UNPUBLISH",
|
|
3188
|
-
/** Was unscheduled */
|
|
3189
|
-
UNSCHEDULE = "UNSCHEDULE",
|
|
3190
|
-
/** New edit session started which updated editing_session_id id */
|
|
3191
|
-
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
|
3192
|
-
/** Was scheduled by Later */
|
|
3193
|
-
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
|
3194
|
-
/** Was unscheduled by Later */
|
|
3195
|
-
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
|
3196
|
-
/** Was published by Later */
|
|
3197
|
-
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
|
3198
|
-
/** Was scheduled */
|
|
3199
|
-
SCHEDULE = "SCHEDULE",
|
|
3200
|
-
/** Was removed from moderation */
|
|
3201
|
-
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
|
3202
|
-
/** Was rejected from moderation */
|
|
3203
|
-
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
|
3204
|
-
/** Was approved in moderation */
|
|
3205
|
-
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
|
3206
|
-
/** Tag was deleted */
|
|
3207
|
-
DELETE_TAG = "DELETE_TAG",
|
|
3208
|
-
/** Post was pinned */
|
|
3209
|
-
PIN = "PIN",
|
|
3210
|
-
/** Post was unpinned */
|
|
3211
|
-
UNPIN = "UNPIN",
|
|
3212
|
-
/** Saved automatically by AI tool. */
|
|
3213
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2904
|
+
OLDEST = "OLDEST",
|
|
2905
|
+
NEWEST = "NEWEST"
|
|
3214
2906
|
}
|
|
3215
2907
|
/** @enumType */
|
|
3216
|
-
type
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
/**
|
|
3220
|
-
|
|
3221
|
-
/** Status indicating the draft post is unpublished. */
|
|
3222
|
-
UNPUBLISHED = "UNPUBLISHED",
|
|
3223
|
-
/** Status indicating the draft post is scheduled for publication. */
|
|
3224
|
-
SCHEDULED = "SCHEDULED",
|
|
3225
|
-
/** Status indicating the draft post is deleted. */
|
|
3226
|
-
DELETED = "DELETED",
|
|
3227
|
-
/** Status indicating the draft post is in review. */
|
|
3228
|
-
IN_REVIEW = "IN_REVIEW"
|
|
2908
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2909
|
+
/** Get Blog Post Count Stats response */
|
|
2910
|
+
interface QueryPostCountStatsResponse {
|
|
2911
|
+
/** List of published post counts by month. */
|
|
2912
|
+
stats?: PeriodPostCount[];
|
|
3229
2913
|
}
|
|
3230
|
-
/**
|
|
3231
|
-
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
/** Post status. */
|
|
3239
|
-
status?: StatusWithLiterals;
|
|
2914
|
+
/** Post count for a specific time period */
|
|
2915
|
+
interface PeriodPostCount {
|
|
2916
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2917
|
+
periodStart?: Date | null;
|
|
2918
|
+
/** Number of posts published during this month. */
|
|
2919
|
+
postCount?: number;
|
|
2920
|
+
}
|
|
2921
|
+
interface GetTotalPublicationsRequest {
|
|
3240
2922
|
/**
|
|
3241
|
-
* Language
|
|
2923
|
+
* Language filter
|
|
2924
|
+
* @minLength 2
|
|
3242
2925
|
* @format LANGUAGE_TAG
|
|
3243
2926
|
*/
|
|
3244
2927
|
language?: string | null;
|
|
2928
|
+
}
|
|
2929
|
+
interface GetTotalPublicationsResponse {
|
|
2930
|
+
/** Total amount of publications. */
|
|
2931
|
+
total?: number;
|
|
2932
|
+
}
|
|
2933
|
+
interface GetTotalPostsRequest {
|
|
3245
2934
|
/**
|
|
3246
|
-
*
|
|
3247
|
-
*
|
|
2935
|
+
* Language filter.
|
|
2936
|
+
*
|
|
2937
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2938
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
2939
|
+
* @format LANGUAGE_TAG
|
|
3248
2940
|
*/
|
|
3249
|
-
|
|
3250
|
-
|
|
3251
|
-
|
|
3252
|
-
/**
|
|
3253
|
-
|
|
2941
|
+
language?: string | null;
|
|
2942
|
+
}
|
|
2943
|
+
interface GetTotalPostsResponse {
|
|
2944
|
+
/** Total amount of published posts. */
|
|
2945
|
+
total?: number;
|
|
3254
2946
|
}
|
|
3255
2947
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3256
2948
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -3405,126 +3097,6 @@ interface AccountInfo {
|
|
|
3405
3097
|
*/
|
|
3406
3098
|
siteId?: string | null;
|
|
3407
3099
|
}
|
|
3408
|
-
/** Get Blog Publications Count Stats request */
|
|
3409
|
-
interface QueryPublicationsCountStatsRequest {
|
|
3410
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3411
|
-
rangeStart?: Date | null;
|
|
3412
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3413
|
-
rangeEnd?: Date | null;
|
|
3414
|
-
/** Order of the returned results. */
|
|
3415
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
3416
|
-
/** Number of months to include in the response. */
|
|
3417
|
-
months?: number;
|
|
3418
|
-
/**
|
|
3419
|
-
* Language filter
|
|
3420
|
-
*
|
|
3421
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3422
|
-
* @format LANGUAGE_TAG
|
|
3423
|
-
*/
|
|
3424
|
-
language?: string | null;
|
|
3425
|
-
/**
|
|
3426
|
-
* Timezone of the client.
|
|
3427
|
-
* @minLength 3
|
|
3428
|
-
* @maxLength 100
|
|
3429
|
-
*/
|
|
3430
|
-
timeZone?: string | null;
|
|
3431
|
-
}
|
|
3432
|
-
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3433
|
-
UNKNOWN = "UNKNOWN",
|
|
3434
|
-
OLDEST = "OLDEST",
|
|
3435
|
-
NEWEST = "NEWEST"
|
|
3436
|
-
}
|
|
3437
|
-
/** @enumType */
|
|
3438
|
-
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3439
|
-
/** Get Blog Publications Count Stats response */
|
|
3440
|
-
interface QueryPublicationsCountStatsResponse {
|
|
3441
|
-
/** Chronologically ordered list of publications. */
|
|
3442
|
-
stats?: PeriodPublicationsCount[];
|
|
3443
|
-
}
|
|
3444
|
-
/** Publications count for a specific time period */
|
|
3445
|
-
interface PeriodPublicationsCount {
|
|
3446
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3447
|
-
periodStart?: Date | null;
|
|
3448
|
-
/** Number of posts published during this month. */
|
|
3449
|
-
publicationsCount?: number;
|
|
3450
|
-
}
|
|
3451
|
-
/** Get Blog Post Count Stats request */
|
|
3452
|
-
interface QueryPostCountStatsRequest {
|
|
3453
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3454
|
-
rangeStart?: Date | null;
|
|
3455
|
-
/**
|
|
3456
|
-
* Order of returned results.
|
|
3457
|
-
*
|
|
3458
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
3459
|
-
* - `NEWEST`: posts by date in descending order.
|
|
3460
|
-
*
|
|
3461
|
-
* Default: `OLDEST`
|
|
3462
|
-
*/
|
|
3463
|
-
order?: OrderWithLiterals;
|
|
3464
|
-
/** Number of months to include in response. */
|
|
3465
|
-
months?: number;
|
|
3466
|
-
/**
|
|
3467
|
-
* Language filter.
|
|
3468
|
-
*
|
|
3469
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3470
|
-
* Pass a language to only receive the period post count for that specified language.
|
|
3471
|
-
* @format LANGUAGE_TAG
|
|
3472
|
-
*/
|
|
3473
|
-
language?: string | null;
|
|
3474
|
-
/**
|
|
3475
|
-
* Time zone to use when calculating the start of the month.
|
|
3476
|
-
*
|
|
3477
|
-
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
3478
|
-
* @minLength 3
|
|
3479
|
-
* @maxLength 100
|
|
3480
|
-
*/
|
|
3481
|
-
timeZone?: string | null;
|
|
3482
|
-
}
|
|
3483
|
-
declare enum Order {
|
|
3484
|
-
UNKNOWN = "UNKNOWN",
|
|
3485
|
-
OLDEST = "OLDEST",
|
|
3486
|
-
NEWEST = "NEWEST"
|
|
3487
|
-
}
|
|
3488
|
-
/** @enumType */
|
|
3489
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3490
|
-
/** Get Blog Post Count Stats response */
|
|
3491
|
-
interface QueryPostCountStatsResponse {
|
|
3492
|
-
/** List of published post counts by month. */
|
|
3493
|
-
stats?: PeriodPostCount[];
|
|
3494
|
-
}
|
|
3495
|
-
/** Post count for a specific time period */
|
|
3496
|
-
interface PeriodPostCount {
|
|
3497
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3498
|
-
periodStart?: Date | null;
|
|
3499
|
-
/** Number of posts published during this month. */
|
|
3500
|
-
postCount?: number;
|
|
3501
|
-
}
|
|
3502
|
-
interface GetTotalPublicationsRequest {
|
|
3503
|
-
/**
|
|
3504
|
-
* Language filter
|
|
3505
|
-
* @minLength 2
|
|
3506
|
-
* @format LANGUAGE_TAG
|
|
3507
|
-
*/
|
|
3508
|
-
language?: string | null;
|
|
3509
|
-
}
|
|
3510
|
-
interface GetTotalPublicationsResponse {
|
|
3511
|
-
/** Total amount of publications. */
|
|
3512
|
-
total?: number;
|
|
3513
|
-
}
|
|
3514
|
-
interface GetTotalPostsRequest {
|
|
3515
|
-
/**
|
|
3516
|
-
* Language filter.
|
|
3517
|
-
*
|
|
3518
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3519
|
-
* Pass a language to receive the total amount of posts in that specified language.
|
|
3520
|
-
* @format LANGUAGE_TAG
|
|
3521
|
-
*/
|
|
3522
|
-
language?: string | null;
|
|
3523
|
-
}
|
|
3524
|
-
interface GetTotalPostsResponse {
|
|
3525
|
-
/** Total amount of published posts. */
|
|
3526
|
-
total?: number;
|
|
3527
|
-
}
|
|
3528
3100
|
interface GetTotalLikesPerMemberRequest {
|
|
3529
3101
|
/**
|
|
3530
3102
|
* Member ID.
|
|
@@ -3734,12 +3306,48 @@ declare enum GetPostsSort {
|
|
|
3734
3306
|
}
|
|
3735
3307
|
/** @enumType */
|
|
3736
3308
|
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3309
|
+
interface BlogPaging {
|
|
3310
|
+
/**
|
|
3311
|
+
* Number of items to skip in the current sort order.
|
|
3312
|
+
*
|
|
3313
|
+
*
|
|
3314
|
+
* Default: `0`
|
|
3315
|
+
*/
|
|
3316
|
+
offset?: number;
|
|
3317
|
+
/**
|
|
3318
|
+
* Number of items to return.
|
|
3319
|
+
*
|
|
3320
|
+
*
|
|
3321
|
+
* Default:`50`
|
|
3322
|
+
* @min 1
|
|
3323
|
+
* @max 100
|
|
3324
|
+
*/
|
|
3325
|
+
limit?: number;
|
|
3326
|
+
/**
|
|
3327
|
+
* Pointer to the next or previous page in the list of results.
|
|
3328
|
+
* @maxLength 2000
|
|
3329
|
+
*/
|
|
3330
|
+
cursor?: string | null;
|
|
3331
|
+
}
|
|
3737
3332
|
interface ListPostsResponse {
|
|
3738
3333
|
/** List of retrieved posts. */
|
|
3739
3334
|
posts?: Post[];
|
|
3740
3335
|
/** Details on the paged set of results returned. */
|
|
3741
3336
|
metaData?: MetaData;
|
|
3742
3337
|
}
|
|
3338
|
+
interface MetaData {
|
|
3339
|
+
/** Number of items returned in this response. */
|
|
3340
|
+
count?: number;
|
|
3341
|
+
/** Requested offset. */
|
|
3342
|
+
offset?: number;
|
|
3343
|
+
/** Total number of items that match the query. */
|
|
3344
|
+
total?: number;
|
|
3345
|
+
/**
|
|
3346
|
+
* Pointer to the next or previous page in the list of results.
|
|
3347
|
+
* @maxLength 2000
|
|
3348
|
+
*/
|
|
3349
|
+
cursor?: string | null;
|
|
3350
|
+
}
|
|
3743
3351
|
interface QueryPostsRequest {
|
|
3744
3352
|
/** Query options. */
|
|
3745
3353
|
query?: PlatformQuery;
|
|
@@ -4345,13 +3953,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
4345
3953
|
/**
|
|
4346
3954
|
* Retrieves the number of published posts per month within a specified time range.
|
|
4347
3955
|
*
|
|
4348
|
-
*
|
|
4349
|
-
* The
|
|
4350
|
-
*
|
|
4351
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
4352
|
-
*
|
|
4353
|
-
*
|
|
3956
|
+
*
|
|
3957
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
3958
|
+
*
|
|
3959
|
+
* 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.
|
|
3960
|
+
*
|
|
3961
|
+
* >**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.
|
|
4354
3962
|
* @public
|
|
3963
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
4355
3964
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4356
3965
|
* @applicableIdentity APP
|
|
4357
3966
|
* @returns Get Blog Post Count Stats response
|
|
@@ -4392,6 +4001,7 @@ interface QueryPostCountStatsOptions {
|
|
|
4392
4001
|
/**
|
|
4393
4002
|
* Retrieves the total amount of published posts of the blog.
|
|
4394
4003
|
* @public
|
|
4004
|
+
* @param options - Language Options.
|
|
4395
4005
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4396
4006
|
* @applicableIdentity APP
|
|
4397
4007
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -4412,12 +4022,12 @@ interface GetTotalPostsOptions {
|
|
|
4412
4022
|
* @param postId - Post ID.
|
|
4413
4023
|
* @public
|
|
4414
4024
|
* @requiredField postId
|
|
4025
|
+
* @param options - Options specifying which fields to return.
|
|
4415
4026
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4416
4027
|
* @applicableIdentity APP
|
|
4417
|
-
* @returns Retrieved post info.
|
|
4418
4028
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4419
4029
|
*/
|
|
4420
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4030
|
+
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>>;
|
|
4421
4031
|
interface GetPostOptions {
|
|
4422
4032
|
/**
|
|
4423
4033
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4437,6 +4047,7 @@ interface GetPostOptions {
|
|
|
4437
4047
|
* @param slug - Slug of the post to retrieve.
|
|
4438
4048
|
* @public
|
|
4439
4049
|
* @requiredField slug
|
|
4050
|
+
* @param options - Options specifying which fields to return.
|
|
4440
4051
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4441
4052
|
* @applicableIdentity APP
|
|
4442
4053
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -4464,6 +4075,7 @@ interface GetPostBySlugOptions {
|
|
|
4464
4075
|
* - `paging.limit` is `50`.
|
|
4465
4076
|
* - `paging.offset` is `0`.
|
|
4466
4077
|
* @public
|
|
4078
|
+
* @param options - Sort, filter, and paging options.
|
|
4467
4079
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4468
4080
|
* @applicableIdentity APP
|
|
4469
4081
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4534,18 +4146,26 @@ interface ListPostsOptions {
|
|
|
4534
4146
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4535
4147
|
}
|
|
4536
4148
|
/**
|
|
4537
|
-
*
|
|
4149
|
+
* Creates a query to retrieve a list of posts.
|
|
4538
4150
|
*
|
|
4539
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4540
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4541
|
-
* - `paging.limit` is `50`.
|
|
4542
|
-
* - `paging.offset` is `0`.
|
|
4543
4151
|
*
|
|
4544
|
-
*
|
|
4545
|
-
*
|
|
4546
|
-
*
|
|
4547
|
-
*
|
|
4152
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4153
|
+
*
|
|
4154
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4155
|
+
*
|
|
4156
|
+
* 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.
|
|
4157
|
+
*
|
|
4158
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4159
|
+
* + `limit(50)`
|
|
4160
|
+
* + `descending('firstPublishedDate')`
|
|
4161
|
+
*
|
|
4162
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4163
|
+
*
|
|
4164
|
+
* To learn how to query posts, refer to the table below.
|
|
4165
|
+
*
|
|
4166
|
+
* 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`.
|
|
4548
4167
|
* @public
|
|
4168
|
+
* @param options - Options specifying which fields to return.
|
|
4549
4169
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4550
4170
|
* @applicableIdentity APP
|
|
4551
4171
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -4811,4 +4431,4 @@ declare const utils: {
|
|
|
4811
4431
|
*/
|
|
4812
4432
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4813
4433
|
|
|
4814
|
-
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,
|
|
4434
|
+
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, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, 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 DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, 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 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, 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 };
|