@wix/auto_sdk_blog_posts 1.0.152 → 1.0.154
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 +11 -15
- package/build/cjs/index.js +54 -54
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +542 -544
- package/build/cjs/index.typings.js +49 -44
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +411 -401
- package/build/cjs/meta.js +43 -38
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +84 -86
- package/build/cjs/schemas.js +147 -153
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +11 -15
- package/build/es/index.mjs +54 -54
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +542 -544
- package/build/es/index.typings.mjs +49 -44
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +411 -401
- package/build/es/meta.mjs +43 -38
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +84 -86
- package/build/es/schemas.mjs +147 -153
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -15
- package/build/internal/cjs/index.js +54 -54
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +542 -544
- package/build/internal/cjs/index.typings.js +49 -44
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +411 -401
- package/build/internal/cjs/meta.js +43 -38
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +84 -86
- package/build/internal/cjs/schemas.js +147 -153
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -15
- package/build/internal/es/index.mjs +54 -54
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +542 -544
- package/build/internal/es/index.typings.mjs +49 -44
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +411 -401
- package/build/internal/es/meta.mjs +43 -38
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +84 -86
- package/build/internal/es/schemas.mjs +147 -153
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2444,10 +2444,20 @@ declare enum SmartBlockDataType {
|
|
|
2444
2444
|
/** Process steps with numbered/icon labels above a horizontal line. */
|
|
2445
2445
|
PROCESS_STEPS = "PROCESS_STEPS",
|
|
2446
2446
|
/** Statistics with bar visual elements. */
|
|
2447
|
-
BAR_STATS = "BAR_STATS"
|
|
2447
|
+
BAR_STATS = "BAR_STATS",
|
|
2448
|
+
/** Timeline layout with numbered chips on a connecting line; cells alternate around the line. */
|
|
2449
|
+
TIMELINE = "TIMELINE",
|
|
2450
|
+
/** Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line. */
|
|
2451
|
+
MINIMAL_TIMELINE = "MINIMAL_TIMELINE",
|
|
2452
|
+
/** Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations. */
|
|
2453
|
+
PILLS = "PILLS",
|
|
2454
|
+
/** Star rating display with stars and a numeric value per cell. */
|
|
2455
|
+
STAR_RATING = "STAR_RATING",
|
|
2456
|
+
/** Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners. */
|
|
2457
|
+
QUOTE_BOXES = "QUOTE_BOXES"
|
|
2448
2458
|
}
|
|
2449
2459
|
/** @enumType */
|
|
2450
|
-
type SmartBlockDataTypeWithLiterals = SmartBlockDataType | 'SOLID_BOXES' | 'NUMBERED_BOXES' | 'STATS' | 'CIRCLE_STATS' | 'SOLID_BOXES_ALTERNATING' | 'SOLID_JOINED_BOXES' | 'SIDE_LINE_TEXT' | 'TOP_LINE_TEXT' | 'OUTLINE_BOXES_WITH_TOP_CIRCLE' | 'BIG_BULLETS' | 'SMALL_BULLETS' | 'ARROW_BULLETS' | 'PROCESS_STEPS' | 'BAR_STATS';
|
|
2460
|
+
type SmartBlockDataTypeWithLiterals = SmartBlockDataType | 'SOLID_BOXES' | 'NUMBERED_BOXES' | 'STATS' | 'CIRCLE_STATS' | 'SOLID_BOXES_ALTERNATING' | 'SOLID_JOINED_BOXES' | 'SIDE_LINE_TEXT' | 'TOP_LINE_TEXT' | 'OUTLINE_BOXES_WITH_TOP_CIRCLE' | 'BIG_BULLETS' | 'SMALL_BULLETS' | 'ARROW_BULLETS' | 'PROCESS_STEPS' | 'BAR_STATS' | 'TIMELINE' | 'MINIMAL_TIMELINE' | 'PILLS' | 'STAR_RATING' | 'QUOTE_BOXES';
|
|
2451
2461
|
/** Column size controlling how many cells appear per row. */
|
|
2452
2462
|
declare enum ColumnSize {
|
|
2453
2463
|
/** Up to 4 cells in a row. */
|
|
@@ -2761,454 +2771,170 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2761
2771
|
*/
|
|
2762
2772
|
anonymousVisitorId?: string | null;
|
|
2763
2773
|
}
|
|
2764
|
-
interface
|
|
2774
|
+
interface ListTemplatesRequest {
|
|
2765
2775
|
/**
|
|
2766
|
-
*
|
|
2776
|
+
* Filter post templates by given template category ids
|
|
2777
|
+
* @maxSize 50
|
|
2767
2778
|
* @format GUID
|
|
2768
2779
|
*/
|
|
2769
|
-
|
|
2770
|
-
}
|
|
2771
|
-
interface GetTotalLikesPerMemberResponse {
|
|
2772
|
-
/** The total number of likes of the member. */
|
|
2773
|
-
total?: number;
|
|
2774
|
-
}
|
|
2775
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2776
|
-
createdEvent?: EntityCreatedEvent;
|
|
2777
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2778
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2779
|
-
actionEvent?: ActionEvent;
|
|
2780
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2781
|
-
_id?: string;
|
|
2780
|
+
categoryIds?: string[];
|
|
2782
2781
|
/**
|
|
2783
|
-
*
|
|
2784
|
-
*
|
|
2782
|
+
* Filter post templates by provided language
|
|
2783
|
+
* @format LANGUAGE_TAG
|
|
2785
2784
|
*/
|
|
2786
|
-
|
|
2785
|
+
language?: string | null;
|
|
2786
|
+
/** Returns post template categories when set to TRUE */
|
|
2787
|
+
listTemplateCategories?: boolean;
|
|
2788
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2789
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
2790
|
+
/** Pagination options. */
|
|
2791
|
+
paging?: BlogPaging;
|
|
2792
|
+
}
|
|
2793
|
+
declare enum GetPostTemplatesSort {
|
|
2794
|
+
/** Sort by ascending publishing date. */
|
|
2795
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2796
|
+
/** Sort by descending publishing date. */
|
|
2797
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2798
|
+
}
|
|
2799
|
+
/** @enumType */
|
|
2800
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2801
|
+
interface BlogPaging {
|
|
2787
2802
|
/**
|
|
2788
|
-
*
|
|
2789
|
-
*
|
|
2803
|
+
* Number of items to skip in the current sort order.
|
|
2804
|
+
*
|
|
2805
|
+
*
|
|
2806
|
+
* Default: `0`
|
|
2790
2807
|
*/
|
|
2791
|
-
|
|
2792
|
-
/** ID of the entity associated with the event. */
|
|
2793
|
-
entityId?: string;
|
|
2794
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2795
|
-
eventTime?: Date | null;
|
|
2808
|
+
offset?: number;
|
|
2796
2809
|
/**
|
|
2797
|
-
*
|
|
2798
|
-
*
|
|
2810
|
+
* Number of items to return.
|
|
2811
|
+
*
|
|
2812
|
+
*
|
|
2813
|
+
* Default:`50`
|
|
2814
|
+
* @min 1
|
|
2815
|
+
* @max 100
|
|
2799
2816
|
*/
|
|
2800
|
-
|
|
2801
|
-
/** If present, indicates the action that triggered the event. */
|
|
2802
|
-
originatedFrom?: string | null;
|
|
2817
|
+
limit?: number;
|
|
2803
2818
|
/**
|
|
2804
|
-
*
|
|
2805
|
-
*
|
|
2819
|
+
* Pointer to the next or previous page in the list of results.
|
|
2820
|
+
* @maxLength 2000
|
|
2806
2821
|
*/
|
|
2807
|
-
|
|
2808
|
-
}
|
|
2809
|
-
/** @oneof */
|
|
2810
|
-
interface DomainEventBodyOneOf {
|
|
2811
|
-
createdEvent?: EntityCreatedEvent;
|
|
2812
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2813
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2814
|
-
actionEvent?: ActionEvent;
|
|
2815
|
-
}
|
|
2816
|
-
interface EntityCreatedEvent {
|
|
2817
|
-
entity?: string;
|
|
2822
|
+
cursor?: string | null;
|
|
2818
2823
|
}
|
|
2819
|
-
interface
|
|
2820
|
-
|
|
2824
|
+
interface ListTemplatesResponse {
|
|
2825
|
+
/** Available post templates */
|
|
2826
|
+
postTemplates?: Post[];
|
|
2827
|
+
/** Details on the paged set of posts templates returned. */
|
|
2828
|
+
postTemplatesMetaData?: MetaData;
|
|
2829
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
2830
|
+
templateCategories?: Category[];
|
|
2821
2831
|
}
|
|
2822
|
-
interface
|
|
2832
|
+
interface MetaData {
|
|
2833
|
+
/** Number of items returned in this response. */
|
|
2834
|
+
count?: number;
|
|
2835
|
+
/** Requested offset. */
|
|
2836
|
+
offset?: number;
|
|
2837
|
+
/** Total number of items that match the query. */
|
|
2838
|
+
total?: number;
|
|
2823
2839
|
/**
|
|
2824
|
-
*
|
|
2825
|
-
*
|
|
2826
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2840
|
+
* Pointer to the next or previous page in the list of results.
|
|
2841
|
+
* @maxLength 2000
|
|
2827
2842
|
*/
|
|
2828
|
-
|
|
2829
|
-
}
|
|
2830
|
-
interface EntityDeletedEvent {
|
|
2831
|
-
/** Entity that was deleted. */
|
|
2832
|
-
deletedEntity?: string | null;
|
|
2833
|
-
}
|
|
2834
|
-
interface ActionEvent {
|
|
2835
|
-
body?: string;
|
|
2843
|
+
cursor?: string | null;
|
|
2836
2844
|
}
|
|
2837
|
-
interface
|
|
2845
|
+
interface Category {
|
|
2838
2846
|
/**
|
|
2839
|
-
*
|
|
2840
|
-
* @
|
|
2847
|
+
* Category ID.
|
|
2848
|
+
* @immutable
|
|
2849
|
+
* @maxLength 38
|
|
2841
2850
|
*/
|
|
2842
|
-
|
|
2851
|
+
_id?: string;
|
|
2843
2852
|
/**
|
|
2844
|
-
*
|
|
2845
|
-
* @maxLength
|
|
2853
|
+
* Category label. Displayed in the Category Menu.
|
|
2854
|
+
* @maxLength 35
|
|
2846
2855
|
*/
|
|
2847
|
-
|
|
2848
|
-
/** The identification type and identity data. */
|
|
2849
|
-
identity?: IdentificationData;
|
|
2850
|
-
/** Stringify payload. */
|
|
2851
|
-
data?: string;
|
|
2852
|
-
/** Details related to the account */
|
|
2853
|
-
accountInfo?: AccountInfo;
|
|
2854
|
-
}
|
|
2855
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2856
|
+
label?: string;
|
|
2856
2857
|
/**
|
|
2857
|
-
*
|
|
2858
|
-
* @
|
|
2858
|
+
* Number of posts in the category.
|
|
2859
|
+
* @readonly
|
|
2859
2860
|
*/
|
|
2860
|
-
|
|
2861
|
+
postCount?: number;
|
|
2861
2862
|
/**
|
|
2862
|
-
*
|
|
2863
|
-
* @
|
|
2863
|
+
* The `url` of the page that lists every post with the specified category.
|
|
2864
|
+
* @readonly
|
|
2864
2865
|
*/
|
|
2865
|
-
|
|
2866
|
+
url?: string;
|
|
2866
2867
|
/**
|
|
2867
|
-
*
|
|
2868
|
-
* @
|
|
2868
|
+
* Category description.
|
|
2869
|
+
* @maxLength 500
|
|
2869
2870
|
*/
|
|
2870
|
-
|
|
2871
|
+
description?: string | null;
|
|
2871
2872
|
/**
|
|
2872
|
-
*
|
|
2873
|
-
* @
|
|
2873
|
+
* Category title.
|
|
2874
|
+
* @maxLength 200
|
|
2875
|
+
* @deprecated Category title.
|
|
2876
|
+
* @targetRemovalDate 2025-07-16
|
|
2874
2877
|
*/
|
|
2875
|
-
|
|
2876
|
-
/** @readonly */
|
|
2877
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2878
|
-
}
|
|
2879
|
-
/** @oneof */
|
|
2880
|
-
interface IdentificationDataIdOneOf {
|
|
2878
|
+
title?: string;
|
|
2881
2879
|
/**
|
|
2882
|
-
*
|
|
2883
|
-
*
|
|
2880
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2881
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2882
|
+
*
|
|
2883
|
+
* Default: `-1`
|
|
2884
2884
|
*/
|
|
2885
|
-
|
|
2885
|
+
displayPosition?: number | null;
|
|
2886
2886
|
/**
|
|
2887
|
-
* ID of
|
|
2887
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2888
2888
|
* @format GUID
|
|
2889
2889
|
*/
|
|
2890
|
-
|
|
2890
|
+
translationId?: string | null;
|
|
2891
2891
|
/**
|
|
2892
|
-
*
|
|
2893
|
-
*
|
|
2892
|
+
* Category language.
|
|
2893
|
+
*
|
|
2894
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2895
|
+
* @immutable
|
|
2894
2896
|
*/
|
|
2895
|
-
|
|
2897
|
+
language?: string | null;
|
|
2896
2898
|
/**
|
|
2897
|
-
*
|
|
2898
|
-
* @
|
|
2899
|
+
* 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`.
|
|
2900
|
+
* @maxLength 100
|
|
2899
2901
|
*/
|
|
2900
|
-
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
MEMBER = "MEMBER",
|
|
2906
|
-
WIX_USER = "WIX_USER",
|
|
2907
|
-
APP = "APP"
|
|
2908
|
-
}
|
|
2909
|
-
/** @enumType */
|
|
2910
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2911
|
-
interface AccountInfo {
|
|
2902
|
+
slug?: string;
|
|
2903
|
+
/** SEO data. */
|
|
2904
|
+
seoData?: SeoSchema;
|
|
2905
|
+
/** Category cover image. */
|
|
2906
|
+
coverImage?: string;
|
|
2912
2907
|
/**
|
|
2913
|
-
*
|
|
2914
|
-
* @
|
|
2908
|
+
* Date and time the Category was last updated.
|
|
2909
|
+
* @readonly
|
|
2915
2910
|
*/
|
|
2916
|
-
|
|
2911
|
+
_updatedDate?: Date | null;
|
|
2912
|
+
}
|
|
2913
|
+
interface CategoryTranslation {
|
|
2917
2914
|
/**
|
|
2918
|
-
* ID
|
|
2915
|
+
* Category ID.
|
|
2919
2916
|
* @format GUID
|
|
2920
2917
|
*/
|
|
2921
|
-
|
|
2918
|
+
_id?: string;
|
|
2922
2919
|
/**
|
|
2923
|
-
*
|
|
2924
|
-
* @
|
|
2920
|
+
* Label displayed in the categories menu on the site.
|
|
2921
|
+
* @maxLength 100
|
|
2925
2922
|
*/
|
|
2926
|
-
|
|
2927
|
-
}
|
|
2928
|
-
/** Get Blog Publications Count Stats request */
|
|
2929
|
-
interface QueryPublicationsCountStatsRequest {
|
|
2930
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2931
|
-
rangeStart?: Date | null;
|
|
2932
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2933
|
-
rangeEnd?: Date | null;
|
|
2934
|
-
/** Order of the returned results. */
|
|
2935
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2936
|
-
/** Number of months to include in the response. */
|
|
2937
|
-
months?: number;
|
|
2923
|
+
label?: string | null;
|
|
2938
2924
|
/**
|
|
2939
|
-
* Language
|
|
2940
|
-
*
|
|
2941
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2925
|
+
* Language of the category.
|
|
2942
2926
|
* @format LANGUAGE_TAG
|
|
2943
2927
|
*/
|
|
2944
2928
|
language?: string | null;
|
|
2929
|
+
/** URL of this category page. */
|
|
2930
|
+
url?: string;
|
|
2931
|
+
}
|
|
2932
|
+
interface GetTemplateRequest {
|
|
2945
2933
|
/**
|
|
2946
|
-
*
|
|
2947
|
-
* @
|
|
2948
|
-
* @maxLength 100
|
|
2934
|
+
* Post template id
|
|
2935
|
+
* @format GUID
|
|
2949
2936
|
*/
|
|
2950
|
-
|
|
2951
|
-
}
|
|
2952
|
-
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2953
|
-
UNKNOWN = "UNKNOWN",
|
|
2954
|
-
OLDEST = "OLDEST",
|
|
2955
|
-
NEWEST = "NEWEST"
|
|
2956
|
-
}
|
|
2957
|
-
/** @enumType */
|
|
2958
|
-
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2959
|
-
/** Get Blog Publications Count Stats response */
|
|
2960
|
-
interface QueryPublicationsCountStatsResponse {
|
|
2961
|
-
/** Chronologically ordered list of publications. */
|
|
2962
|
-
stats?: PeriodPublicationsCount[];
|
|
2963
|
-
}
|
|
2964
|
-
/** Publications count for a specific time period */
|
|
2965
|
-
interface PeriodPublicationsCount {
|
|
2966
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2967
|
-
periodStart?: Date | null;
|
|
2968
|
-
/** Number of posts published during this month. */
|
|
2969
|
-
publicationsCount?: number;
|
|
2970
|
-
}
|
|
2971
|
-
/** Get Blog Post Count Stats request */
|
|
2972
|
-
interface QueryPostCountStatsRequest {
|
|
2973
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2974
|
-
rangeStart?: Date | null;
|
|
2975
|
-
/**
|
|
2976
|
-
* Order of returned results.
|
|
2977
|
-
*
|
|
2978
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
2979
|
-
* - `NEWEST`: posts by date in descending order.
|
|
2980
|
-
*
|
|
2981
|
-
* Default: `OLDEST`
|
|
2982
|
-
*/
|
|
2983
|
-
order?: OrderWithLiterals;
|
|
2984
|
-
/** Number of months to include in response. */
|
|
2985
|
-
months?: number;
|
|
2986
|
-
/**
|
|
2987
|
-
* Language filter.
|
|
2988
|
-
*
|
|
2989
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2990
|
-
* Pass a language to only receive the period post count for that specified language.
|
|
2991
|
-
* @format LANGUAGE_TAG
|
|
2992
|
-
*/
|
|
2993
|
-
language?: string | null;
|
|
2994
|
-
/**
|
|
2995
|
-
* Time zone to use when calculating the start of the month.
|
|
2996
|
-
*
|
|
2997
|
-
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
2998
|
-
* @minLength 3
|
|
2999
|
-
* @maxLength 100
|
|
3000
|
-
*/
|
|
3001
|
-
timeZone?: string | null;
|
|
3002
|
-
}
|
|
3003
|
-
declare enum Order {
|
|
3004
|
-
UNKNOWN = "UNKNOWN",
|
|
3005
|
-
OLDEST = "OLDEST",
|
|
3006
|
-
NEWEST = "NEWEST"
|
|
3007
|
-
}
|
|
3008
|
-
/** @enumType */
|
|
3009
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3010
|
-
/** Get Blog Post Count Stats response */
|
|
3011
|
-
interface QueryPostCountStatsResponse {
|
|
3012
|
-
/** List of published post counts by month. */
|
|
3013
|
-
stats?: PeriodPostCount[];
|
|
3014
|
-
}
|
|
3015
|
-
/** Post count for a specific time period */
|
|
3016
|
-
interface PeriodPostCount {
|
|
3017
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3018
|
-
periodStart?: Date | null;
|
|
3019
|
-
/** Number of posts published during this month. */
|
|
3020
|
-
postCount?: number;
|
|
3021
|
-
}
|
|
3022
|
-
interface GetTotalPublicationsRequest {
|
|
3023
|
-
/**
|
|
3024
|
-
* Language filter
|
|
3025
|
-
* @minLength 2
|
|
3026
|
-
* @format LANGUAGE_TAG
|
|
3027
|
-
*/
|
|
3028
|
-
language?: string | null;
|
|
3029
|
-
}
|
|
3030
|
-
interface GetTotalPublicationsResponse {
|
|
3031
|
-
/** Total amount of publications. */
|
|
3032
|
-
total?: number;
|
|
3033
|
-
}
|
|
3034
|
-
interface GetTotalPostsRequest {
|
|
3035
|
-
/**
|
|
3036
|
-
* Language filter.
|
|
3037
|
-
*
|
|
3038
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3039
|
-
* Pass a language to receive the total amount of posts in that specified language.
|
|
3040
|
-
* @format LANGUAGE_TAG
|
|
3041
|
-
*/
|
|
3042
|
-
language?: string | null;
|
|
3043
|
-
}
|
|
3044
|
-
interface GetTotalPostsResponse {
|
|
3045
|
-
/** Total amount of published posts. */
|
|
3046
|
-
total?: number;
|
|
3047
|
-
}
|
|
3048
|
-
interface ListTemplatesRequest {
|
|
3049
|
-
/**
|
|
3050
|
-
* Filter post templates by given template category ids
|
|
3051
|
-
* @maxSize 50
|
|
3052
|
-
* @format GUID
|
|
3053
|
-
*/
|
|
3054
|
-
categoryIds?: string[];
|
|
3055
|
-
/**
|
|
3056
|
-
* Filter post templates by provided language
|
|
3057
|
-
* @format LANGUAGE_TAG
|
|
3058
|
-
*/
|
|
3059
|
-
language?: string | null;
|
|
3060
|
-
/** Returns post template categories when set to TRUE */
|
|
3061
|
-
listTemplateCategories?: boolean;
|
|
3062
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
3063
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
3064
|
-
/** Pagination options. */
|
|
3065
|
-
paging?: BlogPaging;
|
|
3066
|
-
}
|
|
3067
|
-
declare enum GetPostTemplatesSort {
|
|
3068
|
-
/** Sort by ascending publishing date. */
|
|
3069
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3070
|
-
/** Sort by descending publishing date. */
|
|
3071
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
3072
|
-
}
|
|
3073
|
-
/** @enumType */
|
|
3074
|
-
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
3075
|
-
interface BlogPaging {
|
|
3076
|
-
/**
|
|
3077
|
-
* Number of items to skip in the current sort order.
|
|
3078
|
-
*
|
|
3079
|
-
*
|
|
3080
|
-
* Default: `0`
|
|
3081
|
-
*/
|
|
3082
|
-
offset?: number;
|
|
3083
|
-
/**
|
|
3084
|
-
* Number of items to return.
|
|
3085
|
-
*
|
|
3086
|
-
*
|
|
3087
|
-
* Default:`50`
|
|
3088
|
-
* @min 1
|
|
3089
|
-
* @max 100
|
|
3090
|
-
*/
|
|
3091
|
-
limit?: number;
|
|
3092
|
-
/**
|
|
3093
|
-
* Pointer to the next or previous page in the list of results.
|
|
3094
|
-
* @maxLength 2000
|
|
3095
|
-
*/
|
|
3096
|
-
cursor?: string | null;
|
|
3097
|
-
}
|
|
3098
|
-
interface ListTemplatesResponse {
|
|
3099
|
-
/** Available post templates */
|
|
3100
|
-
postTemplates?: Post[];
|
|
3101
|
-
/** Details on the paged set of posts templates returned. */
|
|
3102
|
-
postTemplatesMetaData?: MetaData;
|
|
3103
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
3104
|
-
templateCategories?: Category[];
|
|
3105
|
-
}
|
|
3106
|
-
interface MetaData {
|
|
3107
|
-
/** Number of items returned in this response. */
|
|
3108
|
-
count?: number;
|
|
3109
|
-
/** Requested offset. */
|
|
3110
|
-
offset?: number;
|
|
3111
|
-
/** Total number of items that match the query. */
|
|
3112
|
-
total?: number;
|
|
3113
|
-
/**
|
|
3114
|
-
* Pointer to the next or previous page in the list of results.
|
|
3115
|
-
* @maxLength 2000
|
|
3116
|
-
*/
|
|
3117
|
-
cursor?: string | null;
|
|
3118
|
-
}
|
|
3119
|
-
interface Category {
|
|
3120
|
-
/**
|
|
3121
|
-
* Category ID.
|
|
3122
|
-
* @immutable
|
|
3123
|
-
* @maxLength 38
|
|
3124
|
-
*/
|
|
3125
|
-
_id?: string;
|
|
3126
|
-
/**
|
|
3127
|
-
* Category label. Displayed in the Category Menu.
|
|
3128
|
-
* @maxLength 35
|
|
3129
|
-
*/
|
|
3130
|
-
label?: string;
|
|
3131
|
-
/**
|
|
3132
|
-
* Number of posts in the category.
|
|
3133
|
-
* @readonly
|
|
3134
|
-
*/
|
|
3135
|
-
postCount?: number;
|
|
3136
|
-
/**
|
|
3137
|
-
* The `url` of the page that lists every post with the specified category.
|
|
3138
|
-
* @readonly
|
|
3139
|
-
*/
|
|
3140
|
-
url?: string;
|
|
3141
|
-
/**
|
|
3142
|
-
* Category description.
|
|
3143
|
-
* @maxLength 500
|
|
3144
|
-
*/
|
|
3145
|
-
description?: string | null;
|
|
3146
|
-
/**
|
|
3147
|
-
* Category title.
|
|
3148
|
-
* @maxLength 200
|
|
3149
|
-
* @deprecated Category title.
|
|
3150
|
-
* @targetRemovalDate 2025-07-16
|
|
3151
|
-
*/
|
|
3152
|
-
title?: string;
|
|
3153
|
-
/**
|
|
3154
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
3155
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
3156
|
-
*
|
|
3157
|
-
* Default: `-1`
|
|
3158
|
-
*/
|
|
3159
|
-
displayPosition?: number | null;
|
|
3160
|
-
/**
|
|
3161
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
3162
|
-
* @format GUID
|
|
3163
|
-
*/
|
|
3164
|
-
translationId?: string | null;
|
|
3165
|
-
/**
|
|
3166
|
-
* Category language.
|
|
3167
|
-
*
|
|
3168
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3169
|
-
* @immutable
|
|
3170
|
-
*/
|
|
3171
|
-
language?: string | null;
|
|
3172
|
-
/**
|
|
3173
|
-
* 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`.
|
|
3174
|
-
* @maxLength 100
|
|
3175
|
-
*/
|
|
3176
|
-
slug?: string;
|
|
3177
|
-
/** SEO data. */
|
|
3178
|
-
seoData?: SeoSchema;
|
|
3179
|
-
/** Category cover image. */
|
|
3180
|
-
coverImage?: string;
|
|
3181
|
-
/**
|
|
3182
|
-
* Date and time the Category was last updated.
|
|
3183
|
-
* @readonly
|
|
3184
|
-
*/
|
|
3185
|
-
_updatedDate?: Date | null;
|
|
3186
|
-
}
|
|
3187
|
-
interface CategoryTranslation {
|
|
3188
|
-
/**
|
|
3189
|
-
* Category ID.
|
|
3190
|
-
* @format GUID
|
|
3191
|
-
*/
|
|
3192
|
-
_id?: string;
|
|
3193
|
-
/**
|
|
3194
|
-
* Label displayed in the categories menu on the site.
|
|
3195
|
-
* @maxLength 100
|
|
3196
|
-
*/
|
|
3197
|
-
label?: string | null;
|
|
3198
|
-
/**
|
|
3199
|
-
* Language of the category.
|
|
3200
|
-
* @format LANGUAGE_TAG
|
|
3201
|
-
*/
|
|
3202
|
-
language?: string | null;
|
|
3203
|
-
/** URL of this category page. */
|
|
3204
|
-
url?: string;
|
|
3205
|
-
}
|
|
3206
|
-
interface GetTemplateRequest {
|
|
3207
|
-
/**
|
|
3208
|
-
* Post template id
|
|
3209
|
-
* @format GUID
|
|
3210
|
-
*/
|
|
3211
|
-
postTemplateId?: string;
|
|
2937
|
+
postTemplateId?: string;
|
|
3212
2938
|
}
|
|
3213
2939
|
interface GetTemplateResponse {
|
|
3214
2940
|
/** Post template */
|
|
@@ -3473,157 +3199,289 @@ interface DraftPostTranslation {
|
|
|
3473
3199
|
/** Post URL. */
|
|
3474
3200
|
url?: string;
|
|
3475
3201
|
}
|
|
3476
|
-
interface
|
|
3202
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3203
|
+
createdEvent?: EntityCreatedEvent;
|
|
3204
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3205
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3206
|
+
actionEvent?: ActionEvent;
|
|
3207
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3208
|
+
_id?: string;
|
|
3477
3209
|
/**
|
|
3478
|
-
*
|
|
3479
|
-
*
|
|
3480
|
-
* Default: `false`
|
|
3210
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3211
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3481
3212
|
*/
|
|
3482
|
-
|
|
3213
|
+
entityFqdn?: string;
|
|
3483
3214
|
/**
|
|
3484
|
-
*
|
|
3485
|
-
*
|
|
3486
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3487
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
3488
|
-
* @maxSize 100
|
|
3489
|
-
* @maxLength 100
|
|
3215
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3216
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3490
3217
|
*/
|
|
3491
|
-
|
|
3218
|
+
slug?: string;
|
|
3219
|
+
/** ID of the entity associated with the event. */
|
|
3220
|
+
entityId?: string;
|
|
3221
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3222
|
+
eventTime?: Date | null;
|
|
3492
3223
|
/**
|
|
3493
|
-
*
|
|
3494
|
-
*
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
|
|
3224
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3225
|
+
* (for example, GDPR).
|
|
3226
|
+
*/
|
|
3227
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3228
|
+
/** If present, indicates the action that triggered the event. */
|
|
3229
|
+
originatedFrom?: string | null;
|
|
3230
|
+
/**
|
|
3231
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3232
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3233
|
+
*/
|
|
3234
|
+
entityEventSequence?: string | null;
|
|
3235
|
+
}
|
|
3236
|
+
/** @oneof */
|
|
3237
|
+
interface DomainEventBodyOneOf {
|
|
3238
|
+
createdEvent?: EntityCreatedEvent;
|
|
3239
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3240
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3241
|
+
actionEvent?: ActionEvent;
|
|
3242
|
+
}
|
|
3243
|
+
interface EntityCreatedEvent {
|
|
3244
|
+
entity?: string;
|
|
3245
|
+
}
|
|
3246
|
+
interface RestoreInfo {
|
|
3247
|
+
deletedDate?: Date | null;
|
|
3248
|
+
}
|
|
3249
|
+
interface EntityUpdatedEvent {
|
|
3250
|
+
/**
|
|
3251
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3252
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3253
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3254
|
+
*/
|
|
3255
|
+
currentEntity?: string;
|
|
3256
|
+
}
|
|
3257
|
+
interface EntityDeletedEvent {
|
|
3258
|
+
/** Entity that was deleted. */
|
|
3259
|
+
deletedEntity?: string | null;
|
|
3260
|
+
}
|
|
3261
|
+
interface ActionEvent {
|
|
3262
|
+
body?: string;
|
|
3263
|
+
}
|
|
3264
|
+
interface MessageEnvelope {
|
|
3265
|
+
/**
|
|
3266
|
+
* App instance ID.
|
|
3498
3267
|
* @format GUID
|
|
3499
3268
|
*/
|
|
3500
|
-
|
|
3269
|
+
instanceId?: string | null;
|
|
3501
3270
|
/**
|
|
3502
|
-
*
|
|
3503
|
-
*
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3271
|
+
* Event type.
|
|
3272
|
+
* @maxLength 150
|
|
3273
|
+
*/
|
|
3274
|
+
eventType?: string;
|
|
3275
|
+
/** The identification type and identity data. */
|
|
3276
|
+
identity?: IdentificationData;
|
|
3277
|
+
/** Stringify payload. */
|
|
3278
|
+
data?: string;
|
|
3279
|
+
/** Details related to the account */
|
|
3280
|
+
accountInfo?: AccountInfo;
|
|
3281
|
+
}
|
|
3282
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3283
|
+
/**
|
|
3284
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3507
3285
|
* @format GUID
|
|
3508
3286
|
*/
|
|
3509
|
-
|
|
3287
|
+
anonymousVisitorId?: string;
|
|
3510
3288
|
/**
|
|
3511
|
-
*
|
|
3512
|
-
*
|
|
3513
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3514
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3515
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3516
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3517
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3518
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3519
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3520
|
-
* - `RATING`: reserved for internal use.
|
|
3521
|
-
*
|
|
3522
|
-
* Default: `FEED`
|
|
3289
|
+
* ID of a site visitor that has logged in to the site.
|
|
3290
|
+
* @format GUID
|
|
3523
3291
|
*/
|
|
3524
|
-
|
|
3525
|
-
/** Pagination options. */
|
|
3526
|
-
paging?: BlogPaging;
|
|
3292
|
+
memberId?: string;
|
|
3527
3293
|
/**
|
|
3528
|
-
*
|
|
3529
|
-
*
|
|
3530
|
-
*
|
|
3531
|
-
* List of post fields to be included in the response.
|
|
3532
|
-
* @maxSize 20
|
|
3533
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3534
|
-
* This parameter will be removed on June 30, 2023.
|
|
3535
|
-
*
|
|
3536
|
-
* List of post fields to be included in the response.
|
|
3537
|
-
* @replacedBy fieldsets
|
|
3538
|
-
* @targetRemovalDate 2024-06-30
|
|
3294
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3295
|
+
* @format GUID
|
|
3539
3296
|
*/
|
|
3540
|
-
|
|
3297
|
+
wixUserId?: string;
|
|
3541
3298
|
/**
|
|
3542
|
-
*
|
|
3299
|
+
* ID of an app.
|
|
3300
|
+
* @format GUID
|
|
3301
|
+
*/
|
|
3302
|
+
appId?: string;
|
|
3303
|
+
/** @readonly */
|
|
3304
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3305
|
+
}
|
|
3306
|
+
/** @oneof */
|
|
3307
|
+
interface IdentificationDataIdOneOf {
|
|
3308
|
+
/**
|
|
3309
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3310
|
+
* @format GUID
|
|
3311
|
+
*/
|
|
3312
|
+
anonymousVisitorId?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* ID of a site visitor that has logged in to the site.
|
|
3315
|
+
* @format GUID
|
|
3316
|
+
*/
|
|
3317
|
+
memberId?: string;
|
|
3318
|
+
/**
|
|
3319
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3320
|
+
* @format GUID
|
|
3321
|
+
*/
|
|
3322
|
+
wixUserId?: string;
|
|
3323
|
+
/**
|
|
3324
|
+
* ID of an app.
|
|
3325
|
+
* @format GUID
|
|
3326
|
+
*/
|
|
3327
|
+
appId?: string;
|
|
3328
|
+
}
|
|
3329
|
+
declare enum WebhookIdentityType {
|
|
3330
|
+
UNKNOWN = "UNKNOWN",
|
|
3331
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3332
|
+
MEMBER = "MEMBER",
|
|
3333
|
+
WIX_USER = "WIX_USER",
|
|
3334
|
+
APP = "APP"
|
|
3335
|
+
}
|
|
3336
|
+
/** @enumType */
|
|
3337
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3338
|
+
interface AccountInfo {
|
|
3339
|
+
/**
|
|
3340
|
+
* ID of the Wix account associated with the event.
|
|
3341
|
+
* @format GUID
|
|
3342
|
+
*/
|
|
3343
|
+
accountId?: string | null;
|
|
3344
|
+
/**
|
|
3345
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3346
|
+
* @format GUID
|
|
3347
|
+
*/
|
|
3348
|
+
parentAccountId?: string | null;
|
|
3349
|
+
/**
|
|
3350
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3351
|
+
* @format GUID
|
|
3352
|
+
*/
|
|
3353
|
+
siteId?: string | null;
|
|
3354
|
+
}
|
|
3355
|
+
/** Get Blog Publications Count Stats request */
|
|
3356
|
+
interface QueryPublicationsCountStatsRequest {
|
|
3357
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3358
|
+
rangeStart?: Date | null;
|
|
3359
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3360
|
+
rangeEnd?: Date | null;
|
|
3361
|
+
/** Order of the returned results. */
|
|
3362
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
3363
|
+
/** Number of months to include in the response. */
|
|
3364
|
+
months?: number;
|
|
3365
|
+
/**
|
|
3366
|
+
* Language filter
|
|
3543
3367
|
*
|
|
3544
3368
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3545
|
-
* Pass a language to only receive posts that are in that language.
|
|
3546
|
-
* If omitted, posts in all languages are returned.
|
|
3547
3369
|
* @format LANGUAGE_TAG
|
|
3548
3370
|
*/
|
|
3549
3371
|
language?: string | null;
|
|
3550
3372
|
/**
|
|
3551
|
-
*
|
|
3552
|
-
* @
|
|
3373
|
+
* Timezone of the client.
|
|
3374
|
+
* @minLength 3
|
|
3375
|
+
* @maxLength 100
|
|
3553
3376
|
*/
|
|
3554
|
-
|
|
3377
|
+
timeZone?: string | null;
|
|
3378
|
+
}
|
|
3379
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3380
|
+
UNKNOWN = "UNKNOWN",
|
|
3381
|
+
OLDEST = "OLDEST",
|
|
3382
|
+
NEWEST = "NEWEST"
|
|
3383
|
+
}
|
|
3384
|
+
/** @enumType */
|
|
3385
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3386
|
+
/** Get Blog Publications Count Stats response */
|
|
3387
|
+
interface QueryPublicationsCountStatsResponse {
|
|
3388
|
+
/** Chronologically ordered list of publications. */
|
|
3389
|
+
stats?: PeriodPublicationsCount[];
|
|
3390
|
+
}
|
|
3391
|
+
/** Publications count for a specific time period */
|
|
3392
|
+
interface PeriodPublicationsCount {
|
|
3393
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3394
|
+
periodStart?: Date | null;
|
|
3395
|
+
/** Number of posts published during this month. */
|
|
3396
|
+
publicationsCount?: number;
|
|
3397
|
+
}
|
|
3398
|
+
/** Get Blog Post Count Stats request */
|
|
3399
|
+
interface QueryPostCountStatsRequest {
|
|
3400
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3401
|
+
rangeStart?: Date | null;
|
|
3555
3402
|
/**
|
|
3556
|
-
*
|
|
3557
|
-
*
|
|
3558
|
-
*
|
|
3559
|
-
*
|
|
3403
|
+
* Order of returned results.
|
|
3404
|
+
*
|
|
3405
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
3406
|
+
* - `NEWEST`: posts by date in descending order.
|
|
3407
|
+
*
|
|
3408
|
+
* Default: `OLDEST`
|
|
3560
3409
|
*/
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
/**
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
/**
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
|
|
3410
|
+
order?: OrderWithLiterals;
|
|
3411
|
+
/** Number of months to include in response. */
|
|
3412
|
+
months?: number;
|
|
3413
|
+
/**
|
|
3414
|
+
* Language filter.
|
|
3415
|
+
*
|
|
3416
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3417
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
3418
|
+
* @format LANGUAGE_TAG
|
|
3419
|
+
*/
|
|
3420
|
+
language?: string | null;
|
|
3421
|
+
/**
|
|
3422
|
+
* Time zone to use when calculating the start of the month.
|
|
3423
|
+
*
|
|
3424
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
3425
|
+
* @minLength 3
|
|
3426
|
+
* @maxLength 100
|
|
3427
|
+
*/
|
|
3428
|
+
timeZone?: string | null;
|
|
3578
3429
|
}
|
|
3579
|
-
|
|
3580
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3581
|
-
declare enum PostFieldField {
|
|
3430
|
+
declare enum Order {
|
|
3582
3431
|
UNKNOWN = "UNKNOWN",
|
|
3583
|
-
|
|
3584
|
-
|
|
3585
|
-
/** Includes post content text string when present. */
|
|
3586
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3587
|
-
/** Includes post metrics when present. */
|
|
3588
|
-
METRICS = "METRICS",
|
|
3589
|
-
/** Includes SEO data. */
|
|
3590
|
-
SEO = "SEO",
|
|
3591
|
-
/** Includes post owner's contact ID. */
|
|
3592
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3593
|
-
/** Includes post rich content. */
|
|
3594
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3595
|
-
/** Includes post reference ID field. */
|
|
3596
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3432
|
+
OLDEST = "OLDEST",
|
|
3433
|
+
NEWEST = "NEWEST"
|
|
3597
3434
|
}
|
|
3598
3435
|
/** @enumType */
|
|
3599
|
-
type
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
metaData?: MetaData;
|
|
3436
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3437
|
+
/** Get Blog Post Count Stats response */
|
|
3438
|
+
interface QueryPostCountStatsResponse {
|
|
3439
|
+
/** List of published post counts by month. */
|
|
3440
|
+
stats?: PeriodPostCount[];
|
|
3605
3441
|
}
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3442
|
+
/** Post count for a specific time period */
|
|
3443
|
+
interface PeriodPostCount {
|
|
3444
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3445
|
+
periodStart?: Date | null;
|
|
3446
|
+
/** Number of posts published during this month. */
|
|
3447
|
+
postCount?: number;
|
|
3609
3448
|
}
|
|
3610
|
-
interface
|
|
3449
|
+
interface GetTotalPublicationsRequest {
|
|
3611
3450
|
/**
|
|
3612
|
-
*
|
|
3613
|
-
* @
|
|
3451
|
+
* Language filter
|
|
3452
|
+
* @minLength 2
|
|
3453
|
+
* @format LANGUAGE_TAG
|
|
3614
3454
|
*/
|
|
3615
|
-
|
|
3455
|
+
language?: string | null;
|
|
3616
3456
|
}
|
|
3617
|
-
interface
|
|
3457
|
+
interface GetTotalPublicationsResponse {
|
|
3458
|
+
/** Total amount of publications. */
|
|
3459
|
+
total?: number;
|
|
3460
|
+
}
|
|
3461
|
+
interface GetTotalPostsRequest {
|
|
3618
3462
|
/**
|
|
3619
|
-
*
|
|
3620
|
-
*
|
|
3463
|
+
* Language filter.
|
|
3464
|
+
*
|
|
3465
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3466
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
3467
|
+
* @format LANGUAGE_TAG
|
|
3621
3468
|
*/
|
|
3622
|
-
|
|
3469
|
+
language?: string | null;
|
|
3623
3470
|
}
|
|
3624
|
-
interface
|
|
3625
|
-
/**
|
|
3626
|
-
|
|
3471
|
+
interface GetTotalPostsResponse {
|
|
3472
|
+
/** Total amount of published posts. */
|
|
3473
|
+
total?: number;
|
|
3474
|
+
}
|
|
3475
|
+
interface GetTotalLikesPerMemberRequest {
|
|
3476
|
+
/**
|
|
3477
|
+
* Member ID.
|
|
3478
|
+
* @format GUID
|
|
3479
|
+
*/
|
|
3480
|
+
memberId?: string;
|
|
3481
|
+
}
|
|
3482
|
+
interface GetTotalLikesPerMemberResponse {
|
|
3483
|
+
/** The total number of likes of the member. */
|
|
3484
|
+
total?: number;
|
|
3627
3485
|
}
|
|
3628
3486
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3629
3487
|
/**
|
|
@@ -3694,6 +3552,25 @@ interface GetPostRequest {
|
|
|
3694
3552
|
*/
|
|
3695
3553
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3696
3554
|
}
|
|
3555
|
+
declare enum PostFieldField {
|
|
3556
|
+
UNKNOWN = "UNKNOWN",
|
|
3557
|
+
/** Includes post URL when present. */
|
|
3558
|
+
URL = "URL",
|
|
3559
|
+
/** Includes post content text string when present. */
|
|
3560
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3561
|
+
/** Includes post metrics when present. */
|
|
3562
|
+
METRICS = "METRICS",
|
|
3563
|
+
/** Includes SEO data. */
|
|
3564
|
+
SEO = "SEO",
|
|
3565
|
+
/** Includes post owner's contact ID. */
|
|
3566
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3567
|
+
/** Includes post rich content. */
|
|
3568
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3569
|
+
/** Includes post reference ID field. */
|
|
3570
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3571
|
+
}
|
|
3572
|
+
/** @enumType */
|
|
3573
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3697
3574
|
interface GetPostResponse {
|
|
3698
3575
|
/** Retrieved post info. */
|
|
3699
3576
|
post?: Post;
|
|
@@ -3786,6 +3663,24 @@ interface ListPostsRequest {
|
|
|
3786
3663
|
*/
|
|
3787
3664
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3788
3665
|
}
|
|
3666
|
+
declare enum GetPostsSort {
|
|
3667
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3668
|
+
FEED = "FEED",
|
|
3669
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3670
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3671
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3672
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3673
|
+
/** Ordered by total number of views in descending order. */
|
|
3674
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3675
|
+
/** Ordered by total number of likes in descending order. */
|
|
3676
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3677
|
+
/** Ordered by `title` in ascending order. */
|
|
3678
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3679
|
+
/** Ordered by `title` in descending order. */
|
|
3680
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3681
|
+
}
|
|
3682
|
+
/** @enumType */
|
|
3683
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3789
3684
|
interface ListPostsResponse {
|
|
3790
3685
|
/** List of retrieved posts. */
|
|
3791
3686
|
posts?: Post[];
|
|
@@ -4135,6 +4030,121 @@ interface PostCount {
|
|
|
4135
4030
|
/** Number of posts. */
|
|
4136
4031
|
postCount?: number;
|
|
4137
4032
|
}
|
|
4033
|
+
interface ListDemoPostsRequest {
|
|
4034
|
+
/**
|
|
4035
|
+
* Whether to return only featured posts.
|
|
4036
|
+
*
|
|
4037
|
+
* Default: `false`
|
|
4038
|
+
*/
|
|
4039
|
+
featured?: boolean;
|
|
4040
|
+
/**
|
|
4041
|
+
* Hashtag filter.
|
|
4042
|
+
*
|
|
4043
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4044
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
4045
|
+
* @maxSize 100
|
|
4046
|
+
* @maxLength 100
|
|
4047
|
+
*/
|
|
4048
|
+
hashtags?: string[];
|
|
4049
|
+
/**
|
|
4050
|
+
* Category filter.
|
|
4051
|
+
*
|
|
4052
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4053
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
4054
|
+
* @maxSize 50
|
|
4055
|
+
* @format GUID
|
|
4056
|
+
*/
|
|
4057
|
+
categoryIds?: string[];
|
|
4058
|
+
/**
|
|
4059
|
+
* Tag filter.
|
|
4060
|
+
*
|
|
4061
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4062
|
+
* If omitted, all posts with or without tags are returned.
|
|
4063
|
+
* @maxSize 50
|
|
4064
|
+
* @format GUID
|
|
4065
|
+
*/
|
|
4066
|
+
tagIds?: string[];
|
|
4067
|
+
/**
|
|
4068
|
+
* Sorting options.
|
|
4069
|
+
*
|
|
4070
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4071
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4072
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4073
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4074
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4075
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4076
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4077
|
+
* - `RATING`: reserved for internal use.
|
|
4078
|
+
*
|
|
4079
|
+
* Default: `FEED`
|
|
4080
|
+
*/
|
|
4081
|
+
sort?: GetPostsSortWithLiterals;
|
|
4082
|
+
/** Pagination options. */
|
|
4083
|
+
paging?: BlogPaging;
|
|
4084
|
+
/**
|
|
4085
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
4086
|
+
* This parameter will be removed on June 30, 2023.
|
|
4087
|
+
*
|
|
4088
|
+
* List of post fields to be included in the response.
|
|
4089
|
+
* @maxSize 20
|
|
4090
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4091
|
+
* This parameter will be removed on June 30, 2023.
|
|
4092
|
+
*
|
|
4093
|
+
* List of post fields to be included in the response.
|
|
4094
|
+
* @replacedBy fieldsets
|
|
4095
|
+
* @targetRemovalDate 2024-06-30
|
|
4096
|
+
*/
|
|
4097
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4098
|
+
/**
|
|
4099
|
+
* Language filter.
|
|
4100
|
+
*
|
|
4101
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4102
|
+
* Pass a language to only receive posts that are in that language.
|
|
4103
|
+
* If omitted, posts in all languages are returned.
|
|
4104
|
+
* @format LANGUAGE_TAG
|
|
4105
|
+
*/
|
|
4106
|
+
language?: string | null;
|
|
4107
|
+
/**
|
|
4108
|
+
* Post owner's member ID.
|
|
4109
|
+
* @format GUID
|
|
4110
|
+
*/
|
|
4111
|
+
memberId?: string | null;
|
|
4112
|
+
/**
|
|
4113
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4114
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4115
|
+
* only the post’s base fields are returned.
|
|
4116
|
+
* @maxSize 20
|
|
4117
|
+
*/
|
|
4118
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4119
|
+
}
|
|
4120
|
+
interface ListDemoPostsResponse {
|
|
4121
|
+
/** List of posts. */
|
|
4122
|
+
posts?: Post[];
|
|
4123
|
+
/** Details on the paged set of results returned. */
|
|
4124
|
+
metaData?: MetaData;
|
|
4125
|
+
}
|
|
4126
|
+
interface ConvertDraftJsToRichContentRequest {
|
|
4127
|
+
/** DraftJs content to convert to Rich content. */
|
|
4128
|
+
content?: Record<string, any> | null;
|
|
4129
|
+
}
|
|
4130
|
+
interface ConvertDraftJsToRichContentResponse {
|
|
4131
|
+
/**
|
|
4132
|
+
* Rich content converted from DraftJs content.
|
|
4133
|
+
* @maxLength 2000000
|
|
4134
|
+
*/
|
|
4135
|
+
richContent?: string;
|
|
4136
|
+
}
|
|
4137
|
+
interface ConvertRichContentToDraftJsRequest {
|
|
4138
|
+
/**
|
|
4139
|
+
* Rich content to convert to DraftJs content.
|
|
4140
|
+
* @maxLength 2000000
|
|
4141
|
+
*/
|
|
4142
|
+
richContent?: string;
|
|
4143
|
+
}
|
|
4144
|
+
interface ConvertRichContentToDraftJsResponse {
|
|
4145
|
+
/** DraftJs content converted from Rich content. */
|
|
4146
|
+
content?: Record<string, any> | null;
|
|
4147
|
+
}
|
|
4138
4148
|
interface BaseEventMetadata {
|
|
4139
4149
|
/**
|
|
4140
4150
|
* App instance ID.
|
|
@@ -4282,14 +4292,13 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
4282
4292
|
/**
|
|
4283
4293
|
* Retrieves the number of published posts per month within a specified time range.
|
|
4284
4294
|
*
|
|
4285
|
-
*
|
|
4286
|
-
* The
|
|
4287
|
-
*
|
|
4288
|
-
*
|
|
4289
|
-
*
|
|
4290
|
-
*
|
|
4295
|
+
* The time range is set using the `rangeStart` and `months` properties.
|
|
4296
|
+
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
|
4297
|
+
* includes the number of `months` following `rangeStart`.
|
|
4298
|
+
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
4299
|
+
* the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
|
|
4300
|
+
* > Note: If there are no published posts in a month within the time range, 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.
|
|
4291
4301
|
* @public
|
|
4292
|
-
* @param options - Options specifying time frame, sort, and filter.
|
|
4293
4302
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4294
4303
|
* @applicableIdentity APP
|
|
4295
4304
|
* @returns Get Blog Post Count Stats response
|
|
@@ -4330,7 +4339,6 @@ interface QueryPostCountStatsOptions {
|
|
|
4330
4339
|
/**
|
|
4331
4340
|
* Retrieves the total amount of published posts of the blog.
|
|
4332
4341
|
* @public
|
|
4333
|
-
* @param options - Language Options.
|
|
4334
4342
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4335
4343
|
* @applicableIdentity APP
|
|
4336
4344
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -4351,12 +4359,12 @@ interface GetTotalPostsOptions {
|
|
|
4351
4359
|
* @param postId - Post ID.
|
|
4352
4360
|
* @public
|
|
4353
4361
|
* @requiredField postId
|
|
4354
|
-
* @param options - Options specifying which fields to return.
|
|
4355
4362
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4356
4363
|
* @applicableIdentity APP
|
|
4364
|
+
* @returns Retrieved post info.
|
|
4357
4365
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4358
4366
|
*/
|
|
4359
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4367
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
|
|
4360
4368
|
interface GetPostOptions {
|
|
4361
4369
|
/**
|
|
4362
4370
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4376,7 +4384,6 @@ interface GetPostOptions {
|
|
|
4376
4384
|
* @param slug - Slug of the post to retrieve.
|
|
4377
4385
|
* @public
|
|
4378
4386
|
* @requiredField slug
|
|
4379
|
-
* @param options - Options specifying which fields to return.
|
|
4380
4387
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4381
4388
|
* @applicableIdentity APP
|
|
4382
4389
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -4404,7 +4411,6 @@ interface GetPostBySlugOptions {
|
|
|
4404
4411
|
* - `paging.limit` is `50`.
|
|
4405
4412
|
* - `paging.offset` is `0`.
|
|
4406
4413
|
* @public
|
|
4407
|
-
* @param options - Sort, filter, and paging options.
|
|
4408
4414
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4409
4415
|
* @applicableIdentity APP
|
|
4410
4416
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4475,26 +4481,18 @@ interface ListPostsOptions {
|
|
|
4475
4481
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4476
4482
|
}
|
|
4477
4483
|
/**
|
|
4478
|
-
*
|
|
4479
|
-
*
|
|
4484
|
+
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
|
4480
4485
|
*
|
|
4481
|
-
*
|
|
4482
|
-
*
|
|
4483
|
-
*
|
|
4484
|
-
*
|
|
4485
|
-
* 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.
|
|
4486
|
-
*
|
|
4487
|
-
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4488
|
-
* + `limit(50)`
|
|
4489
|
-
* + `descending('firstPublishedDate')`
|
|
4490
|
-
*
|
|
4491
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4492
|
-
*
|
|
4493
|
-
* To learn how to query posts, refer to the table below.
|
|
4486
|
+
* Query Posts runs with these defaults, which you can override:
|
|
4487
|
+
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4488
|
+
* - `paging.limit` is `50`.
|
|
4489
|
+
* - `paging.offset` is `0`.
|
|
4494
4490
|
*
|
|
4495
|
-
*
|
|
4491
|
+
* To learn about working with _Query_ endpoints, see
|
|
4492
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
4493
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
|
4494
|
+
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
4496
4495
|
* @public
|
|
4497
|
-
* @param options - Options specifying which fields to return.
|
|
4498
4496
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4499
4497
|
* @applicableIdentity APP
|
|
4500
4498
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|