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