@wix/auto_sdk_blog_posts 1.0.141 → 1.0.143
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.js +38 -38
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +624 -624
- package/build/cjs/index.typings.js +38 -38
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +625 -625
- package/build/cjs/meta.js +38 -38
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +603 -0
- package/build/cjs/schemas.js +982 -0
- package/build/cjs/schemas.js.map +1 -0
- package/build/es/index.mjs +38 -38
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +624 -624
- package/build/es/index.typings.mjs +38 -38
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +625 -625
- package/build/es/meta.mjs +38 -38
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +603 -0
- package/build/es/schemas.mjs +932 -0
- package/build/es/schemas.mjs.map +1 -0
- package/build/internal/cjs/index.js +38 -38
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +624 -624
- package/build/internal/cjs/index.typings.js +38 -38
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +625 -625
- package/build/internal/cjs/meta.js +38 -38
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +603 -0
- package/build/internal/cjs/schemas.js +982 -0
- package/build/internal/cjs/schemas.js.map +1 -0
- package/build/internal/es/index.mjs +38 -38
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +624 -624
- package/build/internal/es/index.typings.mjs +38 -38
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +625 -625
- package/build/internal/es/meta.mjs +38 -38
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +603 -0
- package/build/internal/es/schemas.mjs +932 -0
- package/build/internal/es/schemas.mjs.map +1 -0
- package/package.json +11 -4
- package/schemas/package.json +3 -0
package/build/cjs/meta.d.ts
CHANGED
|
@@ -2677,318 +2677,604 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2677
2677
|
*/
|
|
2678
2678
|
anonymousVisitorId?: string | null;
|
|
2679
2679
|
}
|
|
2680
|
-
interface
|
|
2680
|
+
interface GetTotalLikesPerMemberRequest {
|
|
2681
2681
|
/**
|
|
2682
|
-
*
|
|
2683
|
-
* @maxSize 50
|
|
2682
|
+
* Member ID.
|
|
2684
2683
|
* @format GUID
|
|
2685
2684
|
*/
|
|
2686
|
-
|
|
2687
|
-
/**
|
|
2688
|
-
* Filter post templates by provided language
|
|
2689
|
-
* @format LANGUAGE_TAG
|
|
2690
|
-
*/
|
|
2691
|
-
language?: string | null;
|
|
2692
|
-
/** Returns post template categories when set to TRUE */
|
|
2693
|
-
listTemplateCategories?: boolean;
|
|
2694
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2695
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
|
2696
|
-
/** Pagination options. */
|
|
2697
|
-
paging?: BlogPaging;
|
|
2685
|
+
memberId?: string;
|
|
2698
2686
|
}
|
|
2699
|
-
|
|
2700
|
-
/**
|
|
2701
|
-
|
|
2702
|
-
/** Sort by descending publishing date. */
|
|
2703
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2687
|
+
interface GetTotalLikesPerMemberResponse {
|
|
2688
|
+
/** The total number of likes of the member. */
|
|
2689
|
+
total?: number;
|
|
2704
2690
|
}
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
|
|
2691
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2692
|
+
createdEvent?: EntityCreatedEvent;
|
|
2693
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2694
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2695
|
+
actionEvent?: ActionEvent;
|
|
2696
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2697
|
+
id?: string;
|
|
2708
2698
|
/**
|
|
2709
|
-
*
|
|
2710
|
-
*
|
|
2711
|
-
*
|
|
2712
|
-
* Default: `0`
|
|
2699
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2700
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2713
2701
|
*/
|
|
2714
|
-
|
|
2702
|
+
entityFqdn?: string;
|
|
2715
2703
|
/**
|
|
2716
|
-
*
|
|
2717
|
-
*
|
|
2718
|
-
*
|
|
2719
|
-
* Default:`50`
|
|
2720
|
-
* @min 1
|
|
2721
|
-
* @max 100
|
|
2704
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2705
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2722
2706
|
*/
|
|
2723
|
-
|
|
2707
|
+
slug?: string;
|
|
2708
|
+
/** ID of the entity associated with the event. */
|
|
2709
|
+
entityId?: string;
|
|
2710
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2711
|
+
eventTime?: Date | null;
|
|
2724
2712
|
/**
|
|
2725
|
-
*
|
|
2726
|
-
*
|
|
2713
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2714
|
+
* (for example, GDPR).
|
|
2727
2715
|
*/
|
|
2728
|
-
|
|
2716
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2717
|
+
/** If present, indicates the action that triggered the event. */
|
|
2718
|
+
originatedFrom?: string | null;
|
|
2719
|
+
/**
|
|
2720
|
+
* 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.
|
|
2721
|
+
* 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.
|
|
2722
|
+
*/
|
|
2723
|
+
entityEventSequence?: string | null;
|
|
2729
2724
|
}
|
|
2730
|
-
|
|
2731
|
-
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2736
|
-
templateCategories?: Category[];
|
|
2725
|
+
/** @oneof */
|
|
2726
|
+
interface DomainEventBodyOneOf {
|
|
2727
|
+
createdEvent?: EntityCreatedEvent;
|
|
2728
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2729
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2730
|
+
actionEvent?: ActionEvent;
|
|
2737
2731
|
}
|
|
2738
|
-
interface
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2732
|
+
interface EntityCreatedEvent {
|
|
2733
|
+
entityAsJson?: string;
|
|
2734
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2735
|
+
restoreInfo?: RestoreInfo;
|
|
2736
|
+
}
|
|
2737
|
+
interface RestoreInfo {
|
|
2738
|
+
deletedDate?: Date | null;
|
|
2739
|
+
}
|
|
2740
|
+
interface EntityUpdatedEvent {
|
|
2745
2741
|
/**
|
|
2746
|
-
*
|
|
2747
|
-
*
|
|
2742
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2743
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2744
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2748
2745
|
*/
|
|
2749
|
-
|
|
2746
|
+
currentEntityAsJson?: string;
|
|
2750
2747
|
}
|
|
2751
|
-
interface
|
|
2748
|
+
interface EntityDeletedEvent {
|
|
2749
|
+
/** Entity that was deleted. */
|
|
2750
|
+
deletedEntityAsJson?: string | null;
|
|
2751
|
+
}
|
|
2752
|
+
interface ActionEvent {
|
|
2753
|
+
bodyAsJson?: string;
|
|
2754
|
+
}
|
|
2755
|
+
interface MessageEnvelope {
|
|
2752
2756
|
/**
|
|
2753
|
-
*
|
|
2754
|
-
* @
|
|
2755
|
-
* @maxLength 38
|
|
2757
|
+
* App instance ID.
|
|
2758
|
+
* @format GUID
|
|
2756
2759
|
*/
|
|
2757
|
-
|
|
2760
|
+
instanceId?: string | null;
|
|
2758
2761
|
/**
|
|
2759
|
-
*
|
|
2760
|
-
* @maxLength
|
|
2762
|
+
* Event type.
|
|
2763
|
+
* @maxLength 150
|
|
2761
2764
|
*/
|
|
2762
|
-
|
|
2765
|
+
eventType?: string;
|
|
2766
|
+
/** The identification type and identity data. */
|
|
2767
|
+
identity?: IdentificationData;
|
|
2768
|
+
/** Stringify payload. */
|
|
2769
|
+
data?: string;
|
|
2770
|
+
/** Details related to the account */
|
|
2771
|
+
accountInfo?: AccountInfo;
|
|
2772
|
+
}
|
|
2773
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2763
2774
|
/**
|
|
2764
|
-
*
|
|
2765
|
-
* @
|
|
2775
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2776
|
+
* @format GUID
|
|
2766
2777
|
*/
|
|
2767
|
-
|
|
2778
|
+
anonymousVisitorId?: string;
|
|
2768
2779
|
/**
|
|
2769
|
-
*
|
|
2770
|
-
* @
|
|
2780
|
+
* ID of a site visitor that has logged in to the site.
|
|
2781
|
+
* @format GUID
|
|
2771
2782
|
*/
|
|
2772
|
-
|
|
2783
|
+
memberId?: string;
|
|
2773
2784
|
/**
|
|
2774
|
-
*
|
|
2775
|
-
* @
|
|
2785
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2786
|
+
* @format GUID
|
|
2776
2787
|
*/
|
|
2777
|
-
|
|
2788
|
+
wixUserId?: string;
|
|
2778
2789
|
/**
|
|
2779
|
-
*
|
|
2780
|
-
* @
|
|
2781
|
-
* @deprecated Category title.
|
|
2782
|
-
* @targetRemovalDate 2025-07-16
|
|
2790
|
+
* ID of an app.
|
|
2791
|
+
* @format GUID
|
|
2783
2792
|
*/
|
|
2784
|
-
|
|
2793
|
+
appId?: string;
|
|
2794
|
+
/** @readonly */
|
|
2795
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2796
|
+
}
|
|
2797
|
+
/** @oneof */
|
|
2798
|
+
interface IdentificationDataIdOneOf {
|
|
2785
2799
|
/**
|
|
2786
|
-
*
|
|
2787
|
-
*
|
|
2788
|
-
*
|
|
2789
|
-
* Default: `-1`
|
|
2800
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2801
|
+
* @format GUID
|
|
2790
2802
|
*/
|
|
2791
|
-
|
|
2803
|
+
anonymousVisitorId?: string;
|
|
2792
2804
|
/**
|
|
2793
|
-
* ID of
|
|
2805
|
+
* ID of a site visitor that has logged in to the site.
|
|
2794
2806
|
* @format GUID
|
|
2795
2807
|
*/
|
|
2796
|
-
|
|
2808
|
+
memberId?: string;
|
|
2797
2809
|
/**
|
|
2798
|
-
*
|
|
2799
|
-
*
|
|
2800
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2801
|
-
* @immutable
|
|
2810
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2811
|
+
* @format GUID
|
|
2802
2812
|
*/
|
|
2803
|
-
|
|
2813
|
+
wixUserId?: string;
|
|
2804
2814
|
/**
|
|
2805
|
-
*
|
|
2806
|
-
* @
|
|
2815
|
+
* ID of an app.
|
|
2816
|
+
* @format GUID
|
|
2807
2817
|
*/
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
|
|
2818
|
+
appId?: string;
|
|
2819
|
+
}
|
|
2820
|
+
declare enum WebhookIdentityType {
|
|
2821
|
+
UNKNOWN = "UNKNOWN",
|
|
2822
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2823
|
+
MEMBER = "MEMBER",
|
|
2824
|
+
WIX_USER = "WIX_USER",
|
|
2825
|
+
APP = "APP"
|
|
2826
|
+
}
|
|
2827
|
+
/** @enumType */
|
|
2828
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2829
|
+
interface AccountInfo {
|
|
2813
2830
|
/**
|
|
2814
|
-
*
|
|
2815
|
-
* @
|
|
2831
|
+
* ID of the Wix account associated with the event.
|
|
2832
|
+
* @format GUID
|
|
2816
2833
|
*/
|
|
2817
|
-
|
|
2818
|
-
}
|
|
2819
|
-
interface CategoryTranslation {
|
|
2834
|
+
accountId?: string | null;
|
|
2820
2835
|
/**
|
|
2821
|
-
*
|
|
2836
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2822
2837
|
* @format GUID
|
|
2823
2838
|
*/
|
|
2824
|
-
|
|
2839
|
+
parentAccountId?: string | null;
|
|
2825
2840
|
/**
|
|
2826
|
-
*
|
|
2827
|
-
* @
|
|
2841
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2842
|
+
* @format GUID
|
|
2828
2843
|
*/
|
|
2829
|
-
|
|
2844
|
+
siteId?: string | null;
|
|
2845
|
+
}
|
|
2846
|
+
/** Get Blog Publications Count Stats request */
|
|
2847
|
+
interface QueryPublicationsCountStatsRequest {
|
|
2848
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2849
|
+
rangeStart?: Date | null;
|
|
2850
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2851
|
+
rangeEnd?: Date | null;
|
|
2852
|
+
/** Order of the returned results. */
|
|
2853
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2854
|
+
/** Number of months to include in the response. */
|
|
2855
|
+
months?: number;
|
|
2830
2856
|
/**
|
|
2831
|
-
* Language
|
|
2857
|
+
* Language filter
|
|
2858
|
+
*
|
|
2859
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2832
2860
|
* @format LANGUAGE_TAG
|
|
2833
2861
|
*/
|
|
2834
2862
|
language?: string | null;
|
|
2835
|
-
/** URL of this category page. */
|
|
2836
|
-
url?: PageUrl;
|
|
2837
|
-
}
|
|
2838
|
-
interface GetTemplateRequest {
|
|
2839
2863
|
/**
|
|
2840
|
-
*
|
|
2841
|
-
* @
|
|
2864
|
+
* Timezone of the client.
|
|
2865
|
+
* @minLength 3
|
|
2866
|
+
* @maxLength 100
|
|
2842
2867
|
*/
|
|
2843
|
-
|
|
2868
|
+
timeZone?: string | null;
|
|
2844
2869
|
}
|
|
2845
|
-
|
|
2846
|
-
|
|
2847
|
-
|
|
2870
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2871
|
+
UNKNOWN = "UNKNOWN",
|
|
2872
|
+
OLDEST = "OLDEST",
|
|
2873
|
+
NEWEST = "NEWEST"
|
|
2848
2874
|
}
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
|
|
2853
|
-
|
|
2854
|
-
|
|
2875
|
+
/** @enumType */
|
|
2876
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2877
|
+
/** Get Blog Publications Count Stats response */
|
|
2878
|
+
interface QueryPublicationsCountStatsResponse {
|
|
2879
|
+
/** Chronologically ordered list of publications. */
|
|
2880
|
+
stats?: PeriodPublicationsCount[];
|
|
2855
2881
|
}
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2882
|
+
/** Publications count for a specific time period */
|
|
2883
|
+
interface PeriodPublicationsCount {
|
|
2884
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2885
|
+
periodStart?: Date | null;
|
|
2886
|
+
/** Number of posts published during this month. */
|
|
2887
|
+
publicationsCount?: number;
|
|
2859
2888
|
}
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
* @maxLength 38
|
|
2865
|
-
*/
|
|
2866
|
-
id?: string;
|
|
2867
|
-
/**
|
|
2868
|
-
* Draft post title.
|
|
2869
|
-
* @maxLength 200
|
|
2870
|
-
*/
|
|
2871
|
-
title?: string;
|
|
2889
|
+
/** Get Blog Post Count Stats request */
|
|
2890
|
+
interface QueryPostCountStatsRequest {
|
|
2891
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2892
|
+
rangeStart?: Date | null;
|
|
2872
2893
|
/**
|
|
2873
|
-
*
|
|
2894
|
+
* Order of returned results.
|
|
2874
2895
|
*
|
|
2875
|
-
*
|
|
2876
|
-
*
|
|
2877
|
-
*
|
|
2878
|
-
|
|
2879
|
-
excerpt?: string | null;
|
|
2880
|
-
/** Whether the draft post is marked as featured. */
|
|
2881
|
-
featured?: boolean | null;
|
|
2882
|
-
/**
|
|
2883
|
-
* Category IDs of the draft post.
|
|
2884
|
-
* @maxSize 10
|
|
2885
|
-
* @maxLength 38
|
|
2896
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
2897
|
+
* - `NEWEST`: posts by date in descending order.
|
|
2898
|
+
*
|
|
2899
|
+
* Default: `OLDEST`
|
|
2886
2900
|
*/
|
|
2887
|
-
|
|
2901
|
+
order?: OrderWithLiterals;
|
|
2902
|
+
/** Number of months to include in response. */
|
|
2903
|
+
months?: number;
|
|
2888
2904
|
/**
|
|
2889
|
-
*
|
|
2890
|
-
*
|
|
2905
|
+
* Language filter.
|
|
2906
|
+
*
|
|
2907
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2908
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
2909
|
+
* @format LANGUAGE_TAG
|
|
2891
2910
|
*/
|
|
2892
|
-
|
|
2911
|
+
language?: string | null;
|
|
2893
2912
|
/**
|
|
2894
|
-
*
|
|
2895
|
-
*
|
|
2913
|
+
* Time zone to use when calculating the start of the month.
|
|
2914
|
+
*
|
|
2915
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
2916
|
+
* @minLength 3
|
|
2896
2917
|
* @maxLength 100
|
|
2897
2918
|
*/
|
|
2898
|
-
|
|
2899
|
-
|
|
2900
|
-
|
|
2919
|
+
timeZone?: string | null;
|
|
2920
|
+
}
|
|
2921
|
+
declare enum Order {
|
|
2922
|
+
UNKNOWN = "UNKNOWN",
|
|
2923
|
+
OLDEST = "OLDEST",
|
|
2924
|
+
NEWEST = "NEWEST"
|
|
2925
|
+
}
|
|
2926
|
+
/** @enumType */
|
|
2927
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2928
|
+
/** Get Blog Post Count Stats response */
|
|
2929
|
+
interface QueryPostCountStatsResponse {
|
|
2930
|
+
/** List of published post counts by month. */
|
|
2931
|
+
stats?: PeriodPostCount[];
|
|
2932
|
+
}
|
|
2933
|
+
/** Post count for a specific time period */
|
|
2934
|
+
interface PeriodPostCount {
|
|
2935
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2936
|
+
periodStart?: Date | null;
|
|
2937
|
+
/** Number of posts published during this month. */
|
|
2938
|
+
postCount?: number;
|
|
2939
|
+
}
|
|
2940
|
+
interface GetTotalPublicationsRequest {
|
|
2901
2941
|
/**
|
|
2902
|
-
*
|
|
2903
|
-
* @
|
|
2942
|
+
* Language filter
|
|
2943
|
+
* @minLength 2
|
|
2944
|
+
* @format LANGUAGE_TAG
|
|
2904
2945
|
*/
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2946
|
+
language?: string | null;
|
|
2947
|
+
}
|
|
2948
|
+
interface GetTotalPublicationsResponse {
|
|
2949
|
+
/** Total amount of publications. */
|
|
2950
|
+
total?: number;
|
|
2951
|
+
}
|
|
2952
|
+
interface GetTotalPostsRequest {
|
|
2908
2953
|
/**
|
|
2909
|
-
*
|
|
2910
|
-
*
|
|
2911
|
-
*
|
|
2954
|
+
* Language filter.
|
|
2955
|
+
*
|
|
2956
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2957
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
2958
|
+
* @format LANGUAGE_TAG
|
|
2912
2959
|
*/
|
|
2913
|
-
|
|
2960
|
+
language?: string | null;
|
|
2961
|
+
}
|
|
2962
|
+
interface GetTotalPostsResponse {
|
|
2963
|
+
/** Total amount of published posts. */
|
|
2964
|
+
total?: number;
|
|
2965
|
+
}
|
|
2966
|
+
interface ListTemplatesRequest {
|
|
2914
2967
|
/**
|
|
2915
|
-
*
|
|
2916
|
-
* @maxSize
|
|
2917
|
-
* @
|
|
2968
|
+
* Filter post templates by given template category ids
|
|
2969
|
+
* @maxSize 50
|
|
2970
|
+
* @format GUID
|
|
2918
2971
|
*/
|
|
2919
|
-
|
|
2972
|
+
categoryIds?: string[];
|
|
2920
2973
|
/**
|
|
2921
|
-
*
|
|
2922
|
-
* @
|
|
2923
|
-
* @format GUID
|
|
2974
|
+
* Filter post templates by provided language
|
|
2975
|
+
* @format LANGUAGE_TAG
|
|
2924
2976
|
*/
|
|
2925
|
-
|
|
2977
|
+
language?: string | null;
|
|
2978
|
+
/** Returns post template categories when set to TRUE */
|
|
2979
|
+
listTemplateCategories?: boolean;
|
|
2980
|
+
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
|
2981
|
+
sort?: GetPostTemplatesSortWithLiterals;
|
|
2982
|
+
/** Pagination options. */
|
|
2983
|
+
paging?: BlogPaging;
|
|
2984
|
+
}
|
|
2985
|
+
declare enum GetPostTemplatesSort {
|
|
2986
|
+
/** Sort by ascending publishing date. */
|
|
2987
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
2988
|
+
/** Sort by descending publishing date. */
|
|
2989
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
|
2990
|
+
}
|
|
2991
|
+
/** @enumType */
|
|
2992
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
|
2993
|
+
interface BlogPaging {
|
|
2926
2994
|
/**
|
|
2927
|
-
*
|
|
2995
|
+
* Number of items to skip in the current sort order.
|
|
2928
2996
|
*
|
|
2929
|
-
*
|
|
2930
|
-
*
|
|
2931
|
-
* @format GUID
|
|
2997
|
+
*
|
|
2998
|
+
* Default: `0`
|
|
2932
2999
|
*/
|
|
2933
|
-
|
|
3000
|
+
offset?: number;
|
|
2934
3001
|
/**
|
|
2935
|
-
*
|
|
3002
|
+
* Number of items to return.
|
|
2936
3003
|
*
|
|
2937
|
-
*
|
|
2938
|
-
*
|
|
3004
|
+
*
|
|
3005
|
+
* Default:`50`
|
|
3006
|
+
* @min 1
|
|
3007
|
+
* @max 100
|
|
2939
3008
|
*/
|
|
2940
|
-
|
|
3009
|
+
limit?: number;
|
|
2941
3010
|
/**
|
|
2942
|
-
*
|
|
2943
|
-
*
|
|
2944
|
-
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
|
2945
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
2946
|
-
* </widget>
|
|
3011
|
+
* Pointer to the next or previous page in the list of results.
|
|
3012
|
+
* @maxLength 2000
|
|
2947
3013
|
*/
|
|
2948
|
-
|
|
3014
|
+
cursor?: string | null;
|
|
3015
|
+
}
|
|
3016
|
+
interface ListTemplatesResponse {
|
|
3017
|
+
/** Available post templates */
|
|
3018
|
+
postTemplates?: Post[];
|
|
3019
|
+
/** Details on the paged set of posts templates returned. */
|
|
3020
|
+
postTemplatesMetaData?: MetaData;
|
|
3021
|
+
/** Post template categories. This value is returned empty unless asked explicitly */
|
|
3022
|
+
templateCategories?: Category[];
|
|
3023
|
+
}
|
|
3024
|
+
interface MetaData {
|
|
3025
|
+
/** Number of items returned in this response. */
|
|
3026
|
+
count?: number;
|
|
3027
|
+
/** Requested offset. */
|
|
3028
|
+
offset?: number;
|
|
3029
|
+
/** Total number of items that match the query. */
|
|
3030
|
+
total?: number;
|
|
2949
3031
|
/**
|
|
2950
|
-
*
|
|
2951
|
-
* @
|
|
3032
|
+
* Pointer to the next or previous page in the list of results.
|
|
3033
|
+
* @maxLength 2000
|
|
2952
3034
|
*/
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
3035
|
+
cursor?: string | null;
|
|
3036
|
+
}
|
|
3037
|
+
interface Category {
|
|
2956
3038
|
/**
|
|
2957
|
-
*
|
|
2958
|
-
* @
|
|
3039
|
+
* Category ID.
|
|
3040
|
+
* @immutable
|
|
3041
|
+
* @maxLength 38
|
|
2959
3042
|
*/
|
|
2960
|
-
|
|
3043
|
+
id?: string;
|
|
2961
3044
|
/**
|
|
2962
|
-
*
|
|
2963
|
-
* @
|
|
3045
|
+
* Category label. Displayed in the Category Menu.
|
|
3046
|
+
* @maxLength 35
|
|
2964
3047
|
*/
|
|
2965
|
-
|
|
3048
|
+
label?: string;
|
|
2966
3049
|
/**
|
|
2967
|
-
*
|
|
3050
|
+
* Number of posts in the category.
|
|
2968
3051
|
* @readonly
|
|
2969
3052
|
*/
|
|
2970
|
-
|
|
2971
|
-
/** Date the post was first published. */
|
|
2972
|
-
firstPublishedDate?: Date | null;
|
|
2973
|
-
/** SEO data. */
|
|
2974
|
-
seoData?: SeoSchema;
|
|
3053
|
+
postCount?: number;
|
|
2975
3054
|
/**
|
|
2976
|
-
*
|
|
3055
|
+
* The `url` of the page that lists every post with the specified category.
|
|
2977
3056
|
* @readonly
|
|
2978
3057
|
*/
|
|
2979
3058
|
url?: PageUrl;
|
|
2980
3059
|
/**
|
|
2981
|
-
*
|
|
2982
|
-
* @
|
|
3060
|
+
* Category description.
|
|
3061
|
+
* @maxLength 500
|
|
2983
3062
|
*/
|
|
2984
|
-
|
|
3063
|
+
description?: string | null;
|
|
2985
3064
|
/**
|
|
2986
|
-
*
|
|
2987
|
-
* @maxLength
|
|
3065
|
+
* Category title.
|
|
3066
|
+
* @maxLength 200
|
|
3067
|
+
* @deprecated Category title.
|
|
3068
|
+
* @targetRemovalDate 2025-07-16
|
|
2988
3069
|
*/
|
|
2989
|
-
|
|
2990
|
-
/**
|
|
2991
|
-
|
|
3070
|
+
title?: string;
|
|
3071
|
+
/**
|
|
3072
|
+
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
3073
|
+
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
3074
|
+
*
|
|
3075
|
+
* Default: `-1`
|
|
3076
|
+
*/
|
|
3077
|
+
displayPosition?: number | null;
|
|
3078
|
+
/**
|
|
3079
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
3080
|
+
* @format GUID
|
|
3081
|
+
*/
|
|
3082
|
+
translationId?: string | null;
|
|
3083
|
+
/**
|
|
3084
|
+
* Category language.
|
|
3085
|
+
*
|
|
3086
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3087
|
+
* @immutable
|
|
3088
|
+
*/
|
|
3089
|
+
language?: string | null;
|
|
3090
|
+
/**
|
|
3091
|
+
* 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`.
|
|
3092
|
+
* @maxLength 100
|
|
3093
|
+
*/
|
|
3094
|
+
slug?: string;
|
|
3095
|
+
/** SEO data. */
|
|
3096
|
+
seoData?: SeoSchema;
|
|
3097
|
+
/** Category cover image. */
|
|
3098
|
+
coverImage?: Image;
|
|
3099
|
+
/**
|
|
3100
|
+
* Date and time the Category was last updated.
|
|
3101
|
+
* @readonly
|
|
3102
|
+
*/
|
|
3103
|
+
updatedDate?: Date | null;
|
|
3104
|
+
}
|
|
3105
|
+
interface CategoryTranslation {
|
|
3106
|
+
/**
|
|
3107
|
+
* Category ID.
|
|
3108
|
+
* @format GUID
|
|
3109
|
+
*/
|
|
3110
|
+
id?: string;
|
|
3111
|
+
/**
|
|
3112
|
+
* Label displayed in the categories menu on the site.
|
|
3113
|
+
* @maxLength 100
|
|
3114
|
+
*/
|
|
3115
|
+
label?: string | null;
|
|
3116
|
+
/**
|
|
3117
|
+
* Language of the category.
|
|
3118
|
+
* @format LANGUAGE_TAG
|
|
3119
|
+
*/
|
|
3120
|
+
language?: string | null;
|
|
3121
|
+
/** URL of this category page. */
|
|
3122
|
+
url?: PageUrl;
|
|
3123
|
+
}
|
|
3124
|
+
interface GetTemplateRequest {
|
|
3125
|
+
/**
|
|
3126
|
+
* Post template id
|
|
3127
|
+
* @format GUID
|
|
3128
|
+
*/
|
|
3129
|
+
postTemplateId?: string;
|
|
3130
|
+
}
|
|
3131
|
+
interface GetTemplateResponse {
|
|
3132
|
+
/** Post template */
|
|
3133
|
+
postTemplate?: Post;
|
|
3134
|
+
}
|
|
3135
|
+
interface CreateDraftPostFromTemplateRequest {
|
|
3136
|
+
/**
|
|
3137
|
+
* Post template id
|
|
3138
|
+
* @format GUID
|
|
3139
|
+
*/
|
|
3140
|
+
postTemplateId?: string;
|
|
3141
|
+
}
|
|
3142
|
+
interface CreateDraftPostFromTemplateResponse {
|
|
3143
|
+
/** Created draft post */
|
|
3144
|
+
draftPost?: DraftPost;
|
|
3145
|
+
}
|
|
3146
|
+
interface DraftPost {
|
|
3147
|
+
/**
|
|
3148
|
+
* Draft post ID.
|
|
3149
|
+
* @readonly
|
|
3150
|
+
* @maxLength 38
|
|
3151
|
+
*/
|
|
3152
|
+
id?: string;
|
|
3153
|
+
/**
|
|
3154
|
+
* Draft post title.
|
|
3155
|
+
* @maxLength 200
|
|
3156
|
+
*/
|
|
3157
|
+
title?: string;
|
|
3158
|
+
/**
|
|
3159
|
+
* Draft post excerpt.
|
|
3160
|
+
*
|
|
3161
|
+
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
3162
|
+
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
3163
|
+
* @maxLength 500
|
|
3164
|
+
*/
|
|
3165
|
+
excerpt?: string | null;
|
|
3166
|
+
/** Whether the draft post is marked as featured. */
|
|
3167
|
+
featured?: boolean | null;
|
|
3168
|
+
/**
|
|
3169
|
+
* Category IDs of the draft post.
|
|
3170
|
+
* @maxSize 10
|
|
3171
|
+
* @maxLength 38
|
|
3172
|
+
*/
|
|
3173
|
+
categoryIds?: string[];
|
|
3174
|
+
/**
|
|
3175
|
+
* Draft post owner's member ID.
|
|
3176
|
+
* @format GUID
|
|
3177
|
+
*/
|
|
3178
|
+
memberId?: string | null;
|
|
3179
|
+
/**
|
|
3180
|
+
* Hashtags in the post.
|
|
3181
|
+
* @maxSize 100
|
|
3182
|
+
* @maxLength 100
|
|
3183
|
+
*/
|
|
3184
|
+
hashtags?: string[];
|
|
3185
|
+
/** Whether commenting on the draft post is enabled. */
|
|
3186
|
+
commentingEnabled?: boolean | null;
|
|
3187
|
+
/**
|
|
3188
|
+
* Estimated reading time of the draft post (calculated automatically).
|
|
3189
|
+
* @readonly
|
|
3190
|
+
*/
|
|
3191
|
+
minutesToRead?: number;
|
|
3192
|
+
/** Image placed at the top of the blog page. */
|
|
3193
|
+
heroImage?: Image;
|
|
3194
|
+
/**
|
|
3195
|
+
* Tag IDs the draft post is tagged with.
|
|
3196
|
+
* @maxSize 30
|
|
3197
|
+
* @maxLength 38
|
|
3198
|
+
*/
|
|
3199
|
+
tagIds?: string[];
|
|
3200
|
+
/**
|
|
3201
|
+
* IDs of posts related to this draft post.
|
|
3202
|
+
* @maxSize 3
|
|
3203
|
+
* @maxLength 38
|
|
3204
|
+
*/
|
|
3205
|
+
relatedPostIds?: string[];
|
|
3206
|
+
/**
|
|
3207
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
|
3208
|
+
* @maxSize 100
|
|
3209
|
+
* @format GUID
|
|
3210
|
+
*/
|
|
3211
|
+
pricingPlanIds?: string[];
|
|
3212
|
+
/**
|
|
3213
|
+
* ID of the draft post's translations.
|
|
3214
|
+
*
|
|
3215
|
+
* All translations of a single post share the same `translationId`.
|
|
3216
|
+
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
3217
|
+
* @format GUID
|
|
3218
|
+
*/
|
|
3219
|
+
translationId?: string | null;
|
|
3220
|
+
/**
|
|
3221
|
+
* Language the draft post is written in.
|
|
3222
|
+
*
|
|
3223
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3224
|
+
* @format LANGUAGE_TAG
|
|
3225
|
+
*/
|
|
3226
|
+
language?: string | null;
|
|
3227
|
+
/**
|
|
3228
|
+
* Draft Post rich content.
|
|
3229
|
+
*
|
|
3230
|
+
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
|
3231
|
+
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
3232
|
+
* </widget>
|
|
3233
|
+
*/
|
|
3234
|
+
richContent?: RichContent;
|
|
3235
|
+
/**
|
|
3236
|
+
* Status of the draft post.
|
|
3237
|
+
* @readonly
|
|
3238
|
+
*/
|
|
3239
|
+
status?: StatusWithLiterals;
|
|
3240
|
+
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
3241
|
+
moderationDetails?: ModerationDetails;
|
|
3242
|
+
/**
|
|
3243
|
+
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
3244
|
+
* @readonly
|
|
3245
|
+
*/
|
|
3246
|
+
hasUnpublishedChanges?: boolean;
|
|
3247
|
+
/**
|
|
3248
|
+
* Date the draft post was last edited.
|
|
3249
|
+
* @readonly
|
|
3250
|
+
*/
|
|
3251
|
+
editedDate?: Date | null;
|
|
3252
|
+
/**
|
|
3253
|
+
* Date the draft post is scheduled to be published.
|
|
3254
|
+
* @readonly
|
|
3255
|
+
*/
|
|
3256
|
+
scheduledPublishDate?: Date | null;
|
|
3257
|
+
/** Date the post was first published. */
|
|
3258
|
+
firstPublishedDate?: Date | null;
|
|
3259
|
+
/** SEO data. */
|
|
3260
|
+
seoData?: SeoSchema;
|
|
3261
|
+
/**
|
|
3262
|
+
* Draft post URL preview. What the URL will look like once the post is published.
|
|
3263
|
+
* @readonly
|
|
3264
|
+
*/
|
|
3265
|
+
url?: PageUrl;
|
|
3266
|
+
/**
|
|
3267
|
+
* Date the draft post was first created.
|
|
3268
|
+
* @readonly
|
|
3269
|
+
*/
|
|
3270
|
+
createdDate?: Date | null;
|
|
3271
|
+
/**
|
|
3272
|
+
* SEO slug.
|
|
3273
|
+
* @maxLength 100
|
|
3274
|
+
*/
|
|
3275
|
+
seoSlug?: string | null;
|
|
3276
|
+
/** Post cover media. */
|
|
3277
|
+
media?: Media;
|
|
2992
3278
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
2993
3279
|
previewTextParagraph?: number | null;
|
|
2994
3280
|
}
|
|
@@ -3105,291 +3391,157 @@ interface DraftPostTranslation {
|
|
|
3105
3391
|
/** Post URL. */
|
|
3106
3392
|
url?: PageUrl;
|
|
3107
3393
|
}
|
|
3108
|
-
interface
|
|
3109
|
-
createdEvent?: EntityCreatedEvent;
|
|
3110
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3111
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3112
|
-
actionEvent?: ActionEvent;
|
|
3113
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3114
|
-
id?: string;
|
|
3115
|
-
/**
|
|
3116
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3117
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3118
|
-
*/
|
|
3119
|
-
entityFqdn?: string;
|
|
3120
|
-
/**
|
|
3121
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3122
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3123
|
-
*/
|
|
3124
|
-
slug?: string;
|
|
3125
|
-
/** ID of the entity associated with the event. */
|
|
3126
|
-
entityId?: string;
|
|
3127
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3128
|
-
eventTime?: Date | null;
|
|
3129
|
-
/**
|
|
3130
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3131
|
-
* (for example, GDPR).
|
|
3132
|
-
*/
|
|
3133
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3134
|
-
/** If present, indicates the action that triggered the event. */
|
|
3135
|
-
originatedFrom?: string | null;
|
|
3136
|
-
/**
|
|
3137
|
-
* 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.
|
|
3138
|
-
* 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.
|
|
3139
|
-
*/
|
|
3140
|
-
entityEventSequence?: string | null;
|
|
3141
|
-
}
|
|
3142
|
-
/** @oneof */
|
|
3143
|
-
interface DomainEventBodyOneOf {
|
|
3144
|
-
createdEvent?: EntityCreatedEvent;
|
|
3145
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3146
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3147
|
-
actionEvent?: ActionEvent;
|
|
3148
|
-
}
|
|
3149
|
-
interface EntityCreatedEvent {
|
|
3150
|
-
entityAsJson?: string;
|
|
3151
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3152
|
-
restoreInfo?: RestoreInfo;
|
|
3153
|
-
}
|
|
3154
|
-
interface RestoreInfo {
|
|
3155
|
-
deletedDate?: Date | null;
|
|
3156
|
-
}
|
|
3157
|
-
interface EntityUpdatedEvent {
|
|
3158
|
-
/**
|
|
3159
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3160
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3161
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3162
|
-
*/
|
|
3163
|
-
currentEntityAsJson?: string;
|
|
3164
|
-
}
|
|
3165
|
-
interface EntityDeletedEvent {
|
|
3166
|
-
/** Entity that was deleted. */
|
|
3167
|
-
deletedEntityAsJson?: string | null;
|
|
3168
|
-
}
|
|
3169
|
-
interface ActionEvent {
|
|
3170
|
-
bodyAsJson?: string;
|
|
3171
|
-
}
|
|
3172
|
-
interface MessageEnvelope {
|
|
3173
|
-
/**
|
|
3174
|
-
* App instance ID.
|
|
3175
|
-
* @format GUID
|
|
3176
|
-
*/
|
|
3177
|
-
instanceId?: string | null;
|
|
3178
|
-
/**
|
|
3179
|
-
* Event type.
|
|
3180
|
-
* @maxLength 150
|
|
3181
|
-
*/
|
|
3182
|
-
eventType?: string;
|
|
3183
|
-
/** The identification type and identity data. */
|
|
3184
|
-
identity?: IdentificationData;
|
|
3185
|
-
/** Stringify payload. */
|
|
3186
|
-
data?: string;
|
|
3187
|
-
/** Details related to the account */
|
|
3188
|
-
accountInfo?: AccountInfo;
|
|
3189
|
-
}
|
|
3190
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3191
|
-
/**
|
|
3192
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3193
|
-
* @format GUID
|
|
3194
|
-
*/
|
|
3195
|
-
anonymousVisitorId?: string;
|
|
3196
|
-
/**
|
|
3197
|
-
* ID of a site visitor that has logged in to the site.
|
|
3198
|
-
* @format GUID
|
|
3199
|
-
*/
|
|
3200
|
-
memberId?: string;
|
|
3201
|
-
/**
|
|
3202
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3203
|
-
* @format GUID
|
|
3204
|
-
*/
|
|
3205
|
-
wixUserId?: string;
|
|
3206
|
-
/**
|
|
3207
|
-
* ID of an app.
|
|
3208
|
-
* @format GUID
|
|
3209
|
-
*/
|
|
3210
|
-
appId?: string;
|
|
3211
|
-
/** @readonly */
|
|
3212
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3213
|
-
}
|
|
3214
|
-
/** @oneof */
|
|
3215
|
-
interface IdentificationDataIdOneOf {
|
|
3216
|
-
/**
|
|
3217
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3218
|
-
* @format GUID
|
|
3219
|
-
*/
|
|
3220
|
-
anonymousVisitorId?: string;
|
|
3221
|
-
/**
|
|
3222
|
-
* ID of a site visitor that has logged in to the site.
|
|
3223
|
-
* @format GUID
|
|
3224
|
-
*/
|
|
3225
|
-
memberId?: string;
|
|
3226
|
-
/**
|
|
3227
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3228
|
-
* @format GUID
|
|
3229
|
-
*/
|
|
3230
|
-
wixUserId?: string;
|
|
3231
|
-
/**
|
|
3232
|
-
* ID of an app.
|
|
3233
|
-
* @format GUID
|
|
3234
|
-
*/
|
|
3235
|
-
appId?: string;
|
|
3236
|
-
}
|
|
3237
|
-
declare enum WebhookIdentityType {
|
|
3238
|
-
UNKNOWN = "UNKNOWN",
|
|
3239
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3240
|
-
MEMBER = "MEMBER",
|
|
3241
|
-
WIX_USER = "WIX_USER",
|
|
3242
|
-
APP = "APP"
|
|
3243
|
-
}
|
|
3244
|
-
/** @enumType */
|
|
3245
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3246
|
-
interface AccountInfo {
|
|
3247
|
-
/**
|
|
3248
|
-
* ID of the Wix account associated with the event.
|
|
3249
|
-
* @format GUID
|
|
3250
|
-
*/
|
|
3251
|
-
accountId?: string | null;
|
|
3252
|
-
/**
|
|
3253
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3254
|
-
* @format GUID
|
|
3255
|
-
*/
|
|
3256
|
-
parentAccountId?: string | null;
|
|
3257
|
-
/**
|
|
3258
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3259
|
-
* @format GUID
|
|
3260
|
-
*/
|
|
3261
|
-
siteId?: string | null;
|
|
3262
|
-
}
|
|
3263
|
-
/** Get Blog Publications Count Stats request */
|
|
3264
|
-
interface QueryPublicationsCountStatsRequest {
|
|
3265
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3266
|
-
rangeStart?: Date | null;
|
|
3267
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3268
|
-
rangeEnd?: Date | null;
|
|
3269
|
-
/** Order of the returned results. */
|
|
3270
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
3271
|
-
/** Number of months to include in the response. */
|
|
3272
|
-
months?: number;
|
|
3394
|
+
interface ListDemoPostsRequest {
|
|
3273
3395
|
/**
|
|
3274
|
-
*
|
|
3396
|
+
* Whether to return only featured posts.
|
|
3275
3397
|
*
|
|
3276
|
-
*
|
|
3277
|
-
* @format LANGUAGE_TAG
|
|
3398
|
+
* Default: `false`
|
|
3278
3399
|
*/
|
|
3279
|
-
|
|
3400
|
+
featured?: boolean;
|
|
3280
3401
|
/**
|
|
3281
|
-
*
|
|
3282
|
-
*
|
|
3402
|
+
* Hashtag filter.
|
|
3403
|
+
*
|
|
3404
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3405
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3406
|
+
* @maxSize 100
|
|
3283
3407
|
* @maxLength 100
|
|
3284
3408
|
*/
|
|
3285
|
-
|
|
3286
|
-
}
|
|
3287
|
-
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3288
|
-
UNKNOWN = "UNKNOWN",
|
|
3289
|
-
OLDEST = "OLDEST",
|
|
3290
|
-
NEWEST = "NEWEST"
|
|
3291
|
-
}
|
|
3292
|
-
/** @enumType */
|
|
3293
|
-
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3294
|
-
/** Get Blog Publications Count Stats response */
|
|
3295
|
-
interface QueryPublicationsCountStatsResponse {
|
|
3296
|
-
/** Chronologically ordered list of publications. */
|
|
3297
|
-
stats?: PeriodPublicationsCount[];
|
|
3298
|
-
}
|
|
3299
|
-
/** Publications count for a specific time period */
|
|
3300
|
-
interface PeriodPublicationsCount {
|
|
3301
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3302
|
-
periodStart?: Date | null;
|
|
3303
|
-
/** Number of posts published during this month. */
|
|
3304
|
-
publicationsCount?: number;
|
|
3305
|
-
}
|
|
3306
|
-
/** Get Blog Post Count Stats request */
|
|
3307
|
-
interface QueryPostCountStatsRequest {
|
|
3308
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3309
|
-
rangeStart?: Date | null;
|
|
3409
|
+
hashtags?: string[];
|
|
3310
3410
|
/**
|
|
3311
|
-
*
|
|
3312
|
-
*
|
|
3313
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
3314
|
-
* - `NEWEST`: posts by date in descending order.
|
|
3411
|
+
* Category filter.
|
|
3315
3412
|
*
|
|
3316
|
-
*
|
|
3413
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3414
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3415
|
+
* @maxSize 50
|
|
3416
|
+
* @format GUID
|
|
3317
3417
|
*/
|
|
3318
|
-
|
|
3319
|
-
/** Number of months to include in response. */
|
|
3320
|
-
months?: number;
|
|
3418
|
+
categoryIds?: string[];
|
|
3321
3419
|
/**
|
|
3322
|
-
*
|
|
3420
|
+
* Tag filter.
|
|
3323
3421
|
*
|
|
3324
|
-
*
|
|
3325
|
-
*
|
|
3326
|
-
* @
|
|
3422
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3423
|
+
* If omitted, all posts with or without tags are returned.
|
|
3424
|
+
* @maxSize 50
|
|
3425
|
+
* @format GUID
|
|
3327
3426
|
*/
|
|
3328
|
-
|
|
3427
|
+
tagIds?: string[];
|
|
3329
3428
|
/**
|
|
3330
|
-
*
|
|
3429
|
+
* Sorting options.
|
|
3331
3430
|
*
|
|
3332
|
-
*
|
|
3333
|
-
*
|
|
3334
|
-
*
|
|
3431
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3432
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3433
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3434
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3435
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3436
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3437
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3438
|
+
* - `RATING`: reserved for internal use.
|
|
3439
|
+
*
|
|
3440
|
+
* Default: `FEED`
|
|
3335
3441
|
*/
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
UNKNOWN = "UNKNOWN",
|
|
3340
|
-
OLDEST = "OLDEST",
|
|
3341
|
-
NEWEST = "NEWEST"
|
|
3342
|
-
}
|
|
3343
|
-
/** @enumType */
|
|
3344
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3345
|
-
/** Get Blog Post Count Stats response */
|
|
3346
|
-
interface QueryPostCountStatsResponse {
|
|
3347
|
-
/** List of published post counts by month. */
|
|
3348
|
-
stats?: PeriodPostCount[];
|
|
3349
|
-
}
|
|
3350
|
-
/** Post count for a specific time period */
|
|
3351
|
-
interface PeriodPostCount {
|
|
3352
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3353
|
-
periodStart?: Date | null;
|
|
3354
|
-
/** Number of posts published during this month. */
|
|
3355
|
-
postCount?: number;
|
|
3356
|
-
}
|
|
3357
|
-
interface GetTotalPublicationsRequest {
|
|
3442
|
+
sort?: GetPostsSortWithLiterals;
|
|
3443
|
+
/** Pagination options. */
|
|
3444
|
+
paging?: BlogPaging;
|
|
3358
3445
|
/**
|
|
3359
|
-
*
|
|
3360
|
-
*
|
|
3361
|
-
*
|
|
3446
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
3447
|
+
* This parameter will be removed on June 30, 2023.
|
|
3448
|
+
*
|
|
3449
|
+
* List of post fields to be included in the response.
|
|
3450
|
+
* @maxSize 20
|
|
3451
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3452
|
+
* This parameter will be removed on June 30, 2023.
|
|
3453
|
+
*
|
|
3454
|
+
* List of post fields to be included in the response.
|
|
3455
|
+
* @replacedBy fieldsets
|
|
3456
|
+
* @targetRemovalDate 2024-06-30
|
|
3362
3457
|
*/
|
|
3363
|
-
|
|
3364
|
-
}
|
|
3365
|
-
interface GetTotalPublicationsResponse {
|
|
3366
|
-
/** Total amount of publications. */
|
|
3367
|
-
total?: number;
|
|
3368
|
-
}
|
|
3369
|
-
interface GetTotalPostsRequest {
|
|
3458
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3370
3459
|
/**
|
|
3371
3460
|
* Language filter.
|
|
3372
3461
|
*
|
|
3373
3462
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3374
|
-
* Pass a language to receive
|
|
3463
|
+
* Pass a language to only receive posts that are in that language.
|
|
3464
|
+
* If omitted, posts in all languages are returned.
|
|
3375
3465
|
* @format LANGUAGE_TAG
|
|
3376
3466
|
*/
|
|
3377
3467
|
language?: string | null;
|
|
3468
|
+
/**
|
|
3469
|
+
* Post owner's member ID.
|
|
3470
|
+
* @format GUID
|
|
3471
|
+
*/
|
|
3472
|
+
memberId?: string | null;
|
|
3473
|
+
/**
|
|
3474
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3475
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3476
|
+
* only the post’s base fields are returned.
|
|
3477
|
+
* @maxSize 20
|
|
3478
|
+
*/
|
|
3479
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3378
3480
|
}
|
|
3379
|
-
|
|
3380
|
-
/**
|
|
3381
|
-
|
|
3481
|
+
declare enum GetPostsSort {
|
|
3482
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3483
|
+
FEED = "FEED",
|
|
3484
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3485
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3486
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3487
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3488
|
+
/** Ordered by total number of views in descending order. */
|
|
3489
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3490
|
+
/** Ordered by total number of likes in descending order. */
|
|
3491
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3492
|
+
/** Ordered by `title` in ascending order. */
|
|
3493
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3494
|
+
/** Ordered by `title` in descending order. */
|
|
3495
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3382
3496
|
}
|
|
3383
|
-
|
|
3497
|
+
/** @enumType */
|
|
3498
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3499
|
+
declare enum PostFieldField {
|
|
3500
|
+
UNKNOWN = "UNKNOWN",
|
|
3501
|
+
/** Includes post URL when present. */
|
|
3502
|
+
URL = "URL",
|
|
3503
|
+
/** Includes post content text string when present. */
|
|
3504
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3505
|
+
/** Includes post metrics when present. */
|
|
3506
|
+
METRICS = "METRICS",
|
|
3507
|
+
/** Includes SEO data. */
|
|
3508
|
+
SEO = "SEO",
|
|
3509
|
+
/** Includes post owner's contact ID. */
|
|
3510
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3511
|
+
/** Includes post rich content. */
|
|
3512
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3513
|
+
/** Includes post reference ID field. */
|
|
3514
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3515
|
+
}
|
|
3516
|
+
/** @enumType */
|
|
3517
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3518
|
+
interface ListDemoPostsResponse {
|
|
3519
|
+
/** List of posts. */
|
|
3520
|
+
posts?: Post[];
|
|
3521
|
+
/** Details on the paged set of results returned. */
|
|
3522
|
+
metaData?: MetaData;
|
|
3523
|
+
}
|
|
3524
|
+
interface ConvertDraftJsToRichContentRequest {
|
|
3525
|
+
/** DraftJs content to convert to Rich content. */
|
|
3526
|
+
content?: Record<string, any> | null;
|
|
3527
|
+
}
|
|
3528
|
+
interface ConvertDraftJsToRichContentResponse {
|
|
3384
3529
|
/**
|
|
3385
|
-
*
|
|
3386
|
-
* @
|
|
3530
|
+
* Rich content converted from DraftJs content.
|
|
3531
|
+
* @maxLength 2000000
|
|
3387
3532
|
*/
|
|
3388
|
-
|
|
3533
|
+
richContent?: string;
|
|
3389
3534
|
}
|
|
3390
|
-
interface
|
|
3391
|
-
/**
|
|
3392
|
-
|
|
3535
|
+
interface ConvertRichContentToDraftJsRequest {
|
|
3536
|
+
/**
|
|
3537
|
+
* Rich content to convert to DraftJs content.
|
|
3538
|
+
* @maxLength 2000000
|
|
3539
|
+
*/
|
|
3540
|
+
richContent?: string;
|
|
3541
|
+
}
|
|
3542
|
+
interface ConvertRichContentToDraftJsResponse {
|
|
3543
|
+
/** DraftJs content converted from Rich content. */
|
|
3544
|
+
content?: Record<string, any> | null;
|
|
3393
3545
|
}
|
|
3394
3546
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3395
3547
|
/**
|
|
@@ -3460,25 +3612,6 @@ interface GetPostRequest {
|
|
|
3460
3612
|
*/
|
|
3461
3613
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3462
3614
|
}
|
|
3463
|
-
declare enum PostFieldField {
|
|
3464
|
-
UNKNOWN = "UNKNOWN",
|
|
3465
|
-
/** Includes post URL when present. */
|
|
3466
|
-
URL = "URL",
|
|
3467
|
-
/** Includes post content text string when present. */
|
|
3468
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3469
|
-
/** Includes post metrics when present. */
|
|
3470
|
-
METRICS = "METRICS",
|
|
3471
|
-
/** Includes SEO data. */
|
|
3472
|
-
SEO = "SEO",
|
|
3473
|
-
/** Includes post owner's contact ID. */
|
|
3474
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3475
|
-
/** Includes post rich content. */
|
|
3476
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3477
|
-
/** Includes post reference ID field. */
|
|
3478
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3479
|
-
}
|
|
3480
|
-
/** @enumType */
|
|
3481
|
-
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3482
3615
|
interface GetPostResponse {
|
|
3483
3616
|
/** Retrieved post info. */
|
|
3484
3617
|
post?: Post;
|
|
@@ -3571,24 +3704,6 @@ interface ListPostsRequest {
|
|
|
3571
3704
|
*/
|
|
3572
3705
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3573
3706
|
}
|
|
3574
|
-
declare enum GetPostsSort {
|
|
3575
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3576
|
-
FEED = "FEED",
|
|
3577
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3578
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3579
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3580
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3581
|
-
/** Ordered by total number of views in descending order. */
|
|
3582
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3583
|
-
/** Ordered by total number of likes in descending order. */
|
|
3584
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3585
|
-
/** Ordered by `title` in ascending order. */
|
|
3586
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3587
|
-
/** Ordered by `title` in descending order. */
|
|
3588
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3589
|
-
}
|
|
3590
|
-
/** @enumType */
|
|
3591
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3592
3707
|
interface ListPostsResponse {
|
|
3593
3708
|
/** List of retrieved posts. */
|
|
3594
3709
|
posts?: Post[];
|
|
@@ -3938,121 +4053,6 @@ interface PostCount {
|
|
|
3938
4053
|
/** Number of posts. */
|
|
3939
4054
|
postCount?: number;
|
|
3940
4055
|
}
|
|
3941
|
-
interface ListDemoPostsRequest {
|
|
3942
|
-
/**
|
|
3943
|
-
* Whether to return only featured posts.
|
|
3944
|
-
*
|
|
3945
|
-
* Default: `false`
|
|
3946
|
-
*/
|
|
3947
|
-
featured?: boolean;
|
|
3948
|
-
/**
|
|
3949
|
-
* Hashtag filter.
|
|
3950
|
-
*
|
|
3951
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3952
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
3953
|
-
* @maxSize 100
|
|
3954
|
-
* @maxLength 100
|
|
3955
|
-
*/
|
|
3956
|
-
hashtags?: string[];
|
|
3957
|
-
/**
|
|
3958
|
-
* Category filter.
|
|
3959
|
-
*
|
|
3960
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3961
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
3962
|
-
* @maxSize 50
|
|
3963
|
-
* @format GUID
|
|
3964
|
-
*/
|
|
3965
|
-
categoryIds?: string[];
|
|
3966
|
-
/**
|
|
3967
|
-
* Tag filter.
|
|
3968
|
-
*
|
|
3969
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3970
|
-
* If omitted, all posts with or without tags are returned.
|
|
3971
|
-
* @maxSize 50
|
|
3972
|
-
* @format GUID
|
|
3973
|
-
*/
|
|
3974
|
-
tagIds?: string[];
|
|
3975
|
-
/**
|
|
3976
|
-
* Sorting options.
|
|
3977
|
-
*
|
|
3978
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3979
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3980
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3981
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3982
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3983
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3984
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3985
|
-
* - `RATING`: reserved for internal use.
|
|
3986
|
-
*
|
|
3987
|
-
* Default: `FEED`
|
|
3988
|
-
*/
|
|
3989
|
-
sort?: GetPostsSortWithLiterals;
|
|
3990
|
-
/** Pagination options. */
|
|
3991
|
-
paging?: BlogPaging;
|
|
3992
|
-
/**
|
|
3993
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
3994
|
-
* This parameter will be removed on June 30, 2023.
|
|
3995
|
-
*
|
|
3996
|
-
* List of post fields to be included in the response.
|
|
3997
|
-
* @maxSize 20
|
|
3998
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3999
|
-
* This parameter will be removed on June 30, 2023.
|
|
4000
|
-
*
|
|
4001
|
-
* List of post fields to be included in the response.
|
|
4002
|
-
* @replacedBy fieldsets
|
|
4003
|
-
* @targetRemovalDate 2024-06-30
|
|
4004
|
-
*/
|
|
4005
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4006
|
-
/**
|
|
4007
|
-
* Language filter.
|
|
4008
|
-
*
|
|
4009
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4010
|
-
* Pass a language to only receive posts that are in that language.
|
|
4011
|
-
* If omitted, posts in all languages are returned.
|
|
4012
|
-
* @format LANGUAGE_TAG
|
|
4013
|
-
*/
|
|
4014
|
-
language?: string | null;
|
|
4015
|
-
/**
|
|
4016
|
-
* Post owner's member ID.
|
|
4017
|
-
* @format GUID
|
|
4018
|
-
*/
|
|
4019
|
-
memberId?: string | null;
|
|
4020
|
-
/**
|
|
4021
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4022
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4023
|
-
* only the post’s base fields are returned.
|
|
4024
|
-
* @maxSize 20
|
|
4025
|
-
*/
|
|
4026
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4027
|
-
}
|
|
4028
|
-
interface ListDemoPostsResponse {
|
|
4029
|
-
/** List of posts. */
|
|
4030
|
-
posts?: Post[];
|
|
4031
|
-
/** Details on the paged set of results returned. */
|
|
4032
|
-
metaData?: MetaData;
|
|
4033
|
-
}
|
|
4034
|
-
interface ConvertDraftJsToRichContentRequest {
|
|
4035
|
-
/** DraftJs content to convert to Rich content. */
|
|
4036
|
-
content?: Record<string, any> | null;
|
|
4037
|
-
}
|
|
4038
|
-
interface ConvertDraftJsToRichContentResponse {
|
|
4039
|
-
/**
|
|
4040
|
-
* Rich content converted from DraftJs content.
|
|
4041
|
-
* @maxLength 2000000
|
|
4042
|
-
*/
|
|
4043
|
-
richContent?: string;
|
|
4044
|
-
}
|
|
4045
|
-
interface ConvertRichContentToDraftJsRequest {
|
|
4046
|
-
/**
|
|
4047
|
-
* Rich content to convert to DraftJs content.
|
|
4048
|
-
* @maxLength 2000000
|
|
4049
|
-
*/
|
|
4050
|
-
richContent?: string;
|
|
4051
|
-
}
|
|
4052
|
-
interface ConvertRichContentToDraftJsResponse {
|
|
4053
|
-
/** DraftJs content converted from Rich content. */
|
|
4054
|
-
content?: Record<string, any> | null;
|
|
4055
|
-
}
|
|
4056
4056
|
|
|
4057
4057
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4058
4058
|
getUrl: (context: any) => string;
|