@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
package/build/cjs/meta.d.ts
CHANGED
|
@@ -2466,10 +2466,20 @@ declare enum SmartBlockDataType {
|
|
|
2466
2466
|
/** Process steps with numbered/icon labels above a horizontal line. */
|
|
2467
2467
|
PROCESS_STEPS = "PROCESS_STEPS",
|
|
2468
2468
|
/** Statistics with bar visual elements. */
|
|
2469
|
-
BAR_STATS = "BAR_STATS"
|
|
2469
|
+
BAR_STATS = "BAR_STATS",
|
|
2470
|
+
/** Timeline layout with numbered chips on a connecting line; cells alternate around the line. */
|
|
2471
|
+
TIMELINE = "TIMELINE",
|
|
2472
|
+
/** Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line. */
|
|
2473
|
+
MINIMAL_TIMELINE = "MINIMAL_TIMELINE",
|
|
2474
|
+
/** Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations. */
|
|
2475
|
+
PILLS = "PILLS",
|
|
2476
|
+
/** Star rating display with stars and a numeric value per cell. */
|
|
2477
|
+
STAR_RATING = "STAR_RATING",
|
|
2478
|
+
/** Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners. */
|
|
2479
|
+
QUOTE_BOXES = "QUOTE_BOXES"
|
|
2470
2480
|
}
|
|
2471
2481
|
/** @enumType */
|
|
2472
|
-
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';
|
|
2482
|
+
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';
|
|
2473
2483
|
/** Column size controlling how many cells appear per row. */
|
|
2474
2484
|
declare enum ColumnSize {
|
|
2475
2485
|
/** Up to 4 cells in a row. */
|
|
@@ -2798,292 +2808,6 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2798
2808
|
*/
|
|
2799
2809
|
anonymousVisitorId?: string | null;
|
|
2800
2810
|
}
|
|
2801
|
-
interface GetTotalLikesPerMemberRequest {
|
|
2802
|
-
/**
|
|
2803
|
-
* Member ID.
|
|
2804
|
-
* @format GUID
|
|
2805
|
-
*/
|
|
2806
|
-
memberId?: string;
|
|
2807
|
-
}
|
|
2808
|
-
interface GetTotalLikesPerMemberResponse {
|
|
2809
|
-
/** The total number of likes of the member. */
|
|
2810
|
-
total?: number;
|
|
2811
|
-
}
|
|
2812
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2813
|
-
createdEvent?: EntityCreatedEvent;
|
|
2814
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2815
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2816
|
-
actionEvent?: ActionEvent;
|
|
2817
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2818
|
-
id?: string;
|
|
2819
|
-
/**
|
|
2820
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2821
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2822
|
-
*/
|
|
2823
|
-
entityFqdn?: string;
|
|
2824
|
-
/**
|
|
2825
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2826
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2827
|
-
*/
|
|
2828
|
-
slug?: string;
|
|
2829
|
-
/** ID of the entity associated with the event. */
|
|
2830
|
-
entityId?: string;
|
|
2831
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2832
|
-
eventTime?: Date | null;
|
|
2833
|
-
/**
|
|
2834
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2835
|
-
* (for example, GDPR).
|
|
2836
|
-
*/
|
|
2837
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2838
|
-
/** If present, indicates the action that triggered the event. */
|
|
2839
|
-
originatedFrom?: string | null;
|
|
2840
|
-
/**
|
|
2841
|
-
* 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.
|
|
2842
|
-
* 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.
|
|
2843
|
-
*/
|
|
2844
|
-
entityEventSequence?: string | null;
|
|
2845
|
-
}
|
|
2846
|
-
/** @oneof */
|
|
2847
|
-
interface DomainEventBodyOneOf {
|
|
2848
|
-
createdEvent?: EntityCreatedEvent;
|
|
2849
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2850
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2851
|
-
actionEvent?: ActionEvent;
|
|
2852
|
-
}
|
|
2853
|
-
interface EntityCreatedEvent {
|
|
2854
|
-
entityAsJson?: string;
|
|
2855
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2856
|
-
restoreInfo?: RestoreInfo;
|
|
2857
|
-
}
|
|
2858
|
-
interface RestoreInfo {
|
|
2859
|
-
deletedDate?: Date | null;
|
|
2860
|
-
}
|
|
2861
|
-
interface EntityUpdatedEvent {
|
|
2862
|
-
/**
|
|
2863
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2864
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2865
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2866
|
-
*/
|
|
2867
|
-
currentEntityAsJson?: string;
|
|
2868
|
-
}
|
|
2869
|
-
interface EntityDeletedEvent {
|
|
2870
|
-
/** Entity that was deleted. */
|
|
2871
|
-
deletedEntityAsJson?: string | null;
|
|
2872
|
-
}
|
|
2873
|
-
interface ActionEvent {
|
|
2874
|
-
bodyAsJson?: string;
|
|
2875
|
-
}
|
|
2876
|
-
interface MessageEnvelope {
|
|
2877
|
-
/**
|
|
2878
|
-
* App instance ID.
|
|
2879
|
-
* @format GUID
|
|
2880
|
-
*/
|
|
2881
|
-
instanceId?: string | null;
|
|
2882
|
-
/**
|
|
2883
|
-
* Event type.
|
|
2884
|
-
* @maxLength 150
|
|
2885
|
-
*/
|
|
2886
|
-
eventType?: string;
|
|
2887
|
-
/** The identification type and identity data. */
|
|
2888
|
-
identity?: IdentificationData;
|
|
2889
|
-
/** Stringify payload. */
|
|
2890
|
-
data?: string;
|
|
2891
|
-
/** Details related to the account */
|
|
2892
|
-
accountInfo?: AccountInfo;
|
|
2893
|
-
}
|
|
2894
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2895
|
-
/**
|
|
2896
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2897
|
-
* @format GUID
|
|
2898
|
-
*/
|
|
2899
|
-
anonymousVisitorId?: string;
|
|
2900
|
-
/**
|
|
2901
|
-
* ID of a site visitor that has logged in to the site.
|
|
2902
|
-
* @format GUID
|
|
2903
|
-
*/
|
|
2904
|
-
memberId?: string;
|
|
2905
|
-
/**
|
|
2906
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2907
|
-
* @format GUID
|
|
2908
|
-
*/
|
|
2909
|
-
wixUserId?: string;
|
|
2910
|
-
/**
|
|
2911
|
-
* ID of an app.
|
|
2912
|
-
* @format GUID
|
|
2913
|
-
*/
|
|
2914
|
-
appId?: string;
|
|
2915
|
-
/** @readonly */
|
|
2916
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2917
|
-
}
|
|
2918
|
-
/** @oneof */
|
|
2919
|
-
interface IdentificationDataIdOneOf {
|
|
2920
|
-
/**
|
|
2921
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2922
|
-
* @format GUID
|
|
2923
|
-
*/
|
|
2924
|
-
anonymousVisitorId?: string;
|
|
2925
|
-
/**
|
|
2926
|
-
* ID of a site visitor that has logged in to the site.
|
|
2927
|
-
* @format GUID
|
|
2928
|
-
*/
|
|
2929
|
-
memberId?: string;
|
|
2930
|
-
/**
|
|
2931
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2932
|
-
* @format GUID
|
|
2933
|
-
*/
|
|
2934
|
-
wixUserId?: string;
|
|
2935
|
-
/**
|
|
2936
|
-
* ID of an app.
|
|
2937
|
-
* @format GUID
|
|
2938
|
-
*/
|
|
2939
|
-
appId?: string;
|
|
2940
|
-
}
|
|
2941
|
-
declare enum WebhookIdentityType {
|
|
2942
|
-
UNKNOWN = "UNKNOWN",
|
|
2943
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2944
|
-
MEMBER = "MEMBER",
|
|
2945
|
-
WIX_USER = "WIX_USER",
|
|
2946
|
-
APP = "APP"
|
|
2947
|
-
}
|
|
2948
|
-
/** @enumType */
|
|
2949
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2950
|
-
interface AccountInfo {
|
|
2951
|
-
/**
|
|
2952
|
-
* ID of the Wix account associated with the event.
|
|
2953
|
-
* @format GUID
|
|
2954
|
-
*/
|
|
2955
|
-
accountId?: string | null;
|
|
2956
|
-
/**
|
|
2957
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2958
|
-
* @format GUID
|
|
2959
|
-
*/
|
|
2960
|
-
parentAccountId?: string | null;
|
|
2961
|
-
/**
|
|
2962
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2963
|
-
* @format GUID
|
|
2964
|
-
*/
|
|
2965
|
-
siteId?: string | null;
|
|
2966
|
-
}
|
|
2967
|
-
/** Get Blog Publications Count Stats request */
|
|
2968
|
-
interface QueryPublicationsCountStatsRequest {
|
|
2969
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2970
|
-
rangeStart?: Date | null;
|
|
2971
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
2972
|
-
rangeEnd?: Date | null;
|
|
2973
|
-
/** Order of the returned results. */
|
|
2974
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
2975
|
-
/** Number of months to include in the response. */
|
|
2976
|
-
months?: number;
|
|
2977
|
-
/**
|
|
2978
|
-
* Language filter
|
|
2979
|
-
*
|
|
2980
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2981
|
-
* @format LANGUAGE_TAG
|
|
2982
|
-
*/
|
|
2983
|
-
language?: string | null;
|
|
2984
|
-
/**
|
|
2985
|
-
* Timezone of the client.
|
|
2986
|
-
* @minLength 3
|
|
2987
|
-
* @maxLength 100
|
|
2988
|
-
*/
|
|
2989
|
-
timeZone?: string | null;
|
|
2990
|
-
}
|
|
2991
|
-
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
2992
|
-
UNKNOWN = "UNKNOWN",
|
|
2993
|
-
OLDEST = "OLDEST",
|
|
2994
|
-
NEWEST = "NEWEST"
|
|
2995
|
-
}
|
|
2996
|
-
/** @enumType */
|
|
2997
|
-
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
2998
|
-
/** Get Blog Publications Count Stats response */
|
|
2999
|
-
interface QueryPublicationsCountStatsResponse {
|
|
3000
|
-
/** Chronologically ordered list of publications. */
|
|
3001
|
-
stats?: PeriodPublicationsCount[];
|
|
3002
|
-
}
|
|
3003
|
-
/** Publications count for a specific time period */
|
|
3004
|
-
interface PeriodPublicationsCount {
|
|
3005
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3006
|
-
periodStart?: Date | null;
|
|
3007
|
-
/** Number of posts published during this month. */
|
|
3008
|
-
publicationsCount?: number;
|
|
3009
|
-
}
|
|
3010
|
-
/** Get Blog Post Count Stats request */
|
|
3011
|
-
interface QueryPostCountStatsRequest {
|
|
3012
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3013
|
-
rangeStart?: Date | null;
|
|
3014
|
-
/**
|
|
3015
|
-
* Order of returned results.
|
|
3016
|
-
*
|
|
3017
|
-
* - `OLDEST`: posts by date in ascending order.
|
|
3018
|
-
* - `NEWEST`: posts by date in descending order.
|
|
3019
|
-
*
|
|
3020
|
-
* Default: `OLDEST`
|
|
3021
|
-
*/
|
|
3022
|
-
order?: OrderWithLiterals;
|
|
3023
|
-
/** Number of months to include in response. */
|
|
3024
|
-
months?: number;
|
|
3025
|
-
/**
|
|
3026
|
-
* Language filter.
|
|
3027
|
-
*
|
|
3028
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3029
|
-
* Pass a language to only receive the period post count for that specified language.
|
|
3030
|
-
* @format LANGUAGE_TAG
|
|
3031
|
-
*/
|
|
3032
|
-
language?: string | null;
|
|
3033
|
-
/**
|
|
3034
|
-
* Time zone to use when calculating the start of the month.
|
|
3035
|
-
*
|
|
3036
|
-
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
3037
|
-
* @minLength 3
|
|
3038
|
-
* @maxLength 100
|
|
3039
|
-
*/
|
|
3040
|
-
timeZone?: string | null;
|
|
3041
|
-
}
|
|
3042
|
-
declare enum Order {
|
|
3043
|
-
UNKNOWN = "UNKNOWN",
|
|
3044
|
-
OLDEST = "OLDEST",
|
|
3045
|
-
NEWEST = "NEWEST"
|
|
3046
|
-
}
|
|
3047
|
-
/** @enumType */
|
|
3048
|
-
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3049
|
-
/** Get Blog Post Count Stats response */
|
|
3050
|
-
interface QueryPostCountStatsResponse {
|
|
3051
|
-
/** List of published post counts by month. */
|
|
3052
|
-
stats?: PeriodPostCount[];
|
|
3053
|
-
}
|
|
3054
|
-
/** Post count for a specific time period */
|
|
3055
|
-
interface PeriodPostCount {
|
|
3056
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3057
|
-
periodStart?: Date | null;
|
|
3058
|
-
/** Number of posts published during this month. */
|
|
3059
|
-
postCount?: number;
|
|
3060
|
-
}
|
|
3061
|
-
interface GetTotalPublicationsRequest {
|
|
3062
|
-
/**
|
|
3063
|
-
* Language filter
|
|
3064
|
-
* @minLength 2
|
|
3065
|
-
* @format LANGUAGE_TAG
|
|
3066
|
-
*/
|
|
3067
|
-
language?: string | null;
|
|
3068
|
-
}
|
|
3069
|
-
interface GetTotalPublicationsResponse {
|
|
3070
|
-
/** Total amount of publications. */
|
|
3071
|
-
total?: number;
|
|
3072
|
-
}
|
|
3073
|
-
interface GetTotalPostsRequest {
|
|
3074
|
-
/**
|
|
3075
|
-
* Language filter.
|
|
3076
|
-
*
|
|
3077
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3078
|
-
* Pass a language to receive the total amount of posts in that specified language.
|
|
3079
|
-
* @format LANGUAGE_TAG
|
|
3080
|
-
*/
|
|
3081
|
-
language?: string | null;
|
|
3082
|
-
}
|
|
3083
|
-
interface GetTotalPostsResponse {
|
|
3084
|
-
/** Total amount of published posts. */
|
|
3085
|
-
total?: number;
|
|
3086
|
-
}
|
|
3087
2811
|
interface ListTemplatesRequest {
|
|
3088
2812
|
/**
|
|
3089
2813
|
* Filter post templates by given template category ids
|
|
@@ -3512,157 +3236,291 @@ interface DraftPostTranslation {
|
|
|
3512
3236
|
/** Post URL. */
|
|
3513
3237
|
url?: PageUrl;
|
|
3514
3238
|
}
|
|
3515
|
-
interface
|
|
3239
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3240
|
+
createdEvent?: EntityCreatedEvent;
|
|
3241
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3242
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3243
|
+
actionEvent?: ActionEvent;
|
|
3244
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3245
|
+
id?: string;
|
|
3516
3246
|
/**
|
|
3517
|
-
*
|
|
3518
|
-
*
|
|
3519
|
-
* Default: `false`
|
|
3247
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3248
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3520
3249
|
*/
|
|
3521
|
-
|
|
3250
|
+
entityFqdn?: string;
|
|
3522
3251
|
/**
|
|
3523
|
-
*
|
|
3524
|
-
*
|
|
3525
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3526
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
3527
|
-
* @maxSize 100
|
|
3528
|
-
* @maxLength 100
|
|
3252
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3253
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3529
3254
|
*/
|
|
3530
|
-
|
|
3255
|
+
slug?: string;
|
|
3256
|
+
/** ID of the entity associated with the event. */
|
|
3257
|
+
entityId?: string;
|
|
3258
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3259
|
+
eventTime?: Date | null;
|
|
3531
3260
|
/**
|
|
3532
|
-
*
|
|
3533
|
-
*
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3261
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3262
|
+
* (for example, GDPR).
|
|
3263
|
+
*/
|
|
3264
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3265
|
+
/** If present, indicates the action that triggered the event. */
|
|
3266
|
+
originatedFrom?: string | null;
|
|
3267
|
+
/**
|
|
3268
|
+
* 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.
|
|
3269
|
+
* 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.
|
|
3270
|
+
*/
|
|
3271
|
+
entityEventSequence?: string | null;
|
|
3272
|
+
}
|
|
3273
|
+
/** @oneof */
|
|
3274
|
+
interface DomainEventBodyOneOf {
|
|
3275
|
+
createdEvent?: EntityCreatedEvent;
|
|
3276
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3277
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3278
|
+
actionEvent?: ActionEvent;
|
|
3279
|
+
}
|
|
3280
|
+
interface EntityCreatedEvent {
|
|
3281
|
+
entityAsJson?: string;
|
|
3282
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3283
|
+
restoreInfo?: RestoreInfo;
|
|
3284
|
+
}
|
|
3285
|
+
interface RestoreInfo {
|
|
3286
|
+
deletedDate?: Date | null;
|
|
3287
|
+
}
|
|
3288
|
+
interface EntityUpdatedEvent {
|
|
3289
|
+
/**
|
|
3290
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3291
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3292
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3293
|
+
*/
|
|
3294
|
+
currentEntityAsJson?: string;
|
|
3295
|
+
}
|
|
3296
|
+
interface EntityDeletedEvent {
|
|
3297
|
+
/** Entity that was deleted. */
|
|
3298
|
+
deletedEntityAsJson?: string | null;
|
|
3299
|
+
}
|
|
3300
|
+
interface ActionEvent {
|
|
3301
|
+
bodyAsJson?: string;
|
|
3302
|
+
}
|
|
3303
|
+
interface MessageEnvelope {
|
|
3304
|
+
/**
|
|
3305
|
+
* App instance ID.
|
|
3537
3306
|
* @format GUID
|
|
3538
3307
|
*/
|
|
3539
|
-
|
|
3308
|
+
instanceId?: string | null;
|
|
3540
3309
|
/**
|
|
3541
|
-
*
|
|
3542
|
-
*
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3310
|
+
* Event type.
|
|
3311
|
+
* @maxLength 150
|
|
3312
|
+
*/
|
|
3313
|
+
eventType?: string;
|
|
3314
|
+
/** The identification type and identity data. */
|
|
3315
|
+
identity?: IdentificationData;
|
|
3316
|
+
/** Stringify payload. */
|
|
3317
|
+
data?: string;
|
|
3318
|
+
/** Details related to the account */
|
|
3319
|
+
accountInfo?: AccountInfo;
|
|
3320
|
+
}
|
|
3321
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3322
|
+
/**
|
|
3323
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3546
3324
|
* @format GUID
|
|
3547
3325
|
*/
|
|
3548
|
-
|
|
3326
|
+
anonymousVisitorId?: string;
|
|
3549
3327
|
/**
|
|
3550
|
-
*
|
|
3551
|
-
*
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
*
|
|
3556
|
-
*
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3328
|
+
* ID of a site visitor that has logged in to the site.
|
|
3329
|
+
* @format GUID
|
|
3330
|
+
*/
|
|
3331
|
+
memberId?: string;
|
|
3332
|
+
/**
|
|
3333
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3334
|
+
* @format GUID
|
|
3335
|
+
*/
|
|
3336
|
+
wixUserId?: string;
|
|
3337
|
+
/**
|
|
3338
|
+
* ID of an app.
|
|
3339
|
+
* @format GUID
|
|
3340
|
+
*/
|
|
3341
|
+
appId?: string;
|
|
3342
|
+
/** @readonly */
|
|
3343
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3344
|
+
}
|
|
3345
|
+
/** @oneof */
|
|
3346
|
+
interface IdentificationDataIdOneOf {
|
|
3347
|
+
/**
|
|
3348
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3349
|
+
* @format GUID
|
|
3350
|
+
*/
|
|
3351
|
+
anonymousVisitorId?: string;
|
|
3352
|
+
/**
|
|
3353
|
+
* ID of a site visitor that has logged in to the site.
|
|
3354
|
+
* @format GUID
|
|
3355
|
+
*/
|
|
3356
|
+
memberId?: string;
|
|
3357
|
+
/**
|
|
3358
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3359
|
+
* @format GUID
|
|
3360
|
+
*/
|
|
3361
|
+
wixUserId?: string;
|
|
3362
|
+
/**
|
|
3363
|
+
* ID of an app.
|
|
3364
|
+
* @format GUID
|
|
3365
|
+
*/
|
|
3366
|
+
appId?: string;
|
|
3367
|
+
}
|
|
3368
|
+
declare enum WebhookIdentityType {
|
|
3369
|
+
UNKNOWN = "UNKNOWN",
|
|
3370
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3371
|
+
MEMBER = "MEMBER",
|
|
3372
|
+
WIX_USER = "WIX_USER",
|
|
3373
|
+
APP = "APP"
|
|
3374
|
+
}
|
|
3375
|
+
/** @enumType */
|
|
3376
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3377
|
+
interface AccountInfo {
|
|
3378
|
+
/**
|
|
3379
|
+
* ID of the Wix account associated with the event.
|
|
3380
|
+
* @format GUID
|
|
3381
|
+
*/
|
|
3382
|
+
accountId?: string | null;
|
|
3383
|
+
/**
|
|
3384
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3385
|
+
* @format GUID
|
|
3386
|
+
*/
|
|
3387
|
+
parentAccountId?: string | null;
|
|
3388
|
+
/**
|
|
3389
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3390
|
+
* @format GUID
|
|
3391
|
+
*/
|
|
3392
|
+
siteId?: string | null;
|
|
3393
|
+
}
|
|
3394
|
+
/** Get Blog Publications Count Stats request */
|
|
3395
|
+
interface QueryPublicationsCountStatsRequest {
|
|
3396
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3397
|
+
rangeStart?: Date | null;
|
|
3398
|
+
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3399
|
+
rangeEnd?: Date | null;
|
|
3400
|
+
/** Order of the returned results. */
|
|
3401
|
+
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
|
3402
|
+
/** Number of months to include in the response. */
|
|
3403
|
+
months?: number;
|
|
3404
|
+
/**
|
|
3405
|
+
* Language filter
|
|
3560
3406
|
*
|
|
3561
|
-
*
|
|
3407
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3408
|
+
* @format LANGUAGE_TAG
|
|
3562
3409
|
*/
|
|
3563
|
-
|
|
3564
|
-
/** Pagination options. */
|
|
3565
|
-
paging?: BlogPaging;
|
|
3410
|
+
language?: string | null;
|
|
3566
3411
|
/**
|
|
3567
|
-
*
|
|
3568
|
-
*
|
|
3412
|
+
* Timezone of the client.
|
|
3413
|
+
* @minLength 3
|
|
3414
|
+
* @maxLength 100
|
|
3415
|
+
*/
|
|
3416
|
+
timeZone?: string | null;
|
|
3417
|
+
}
|
|
3418
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
|
3419
|
+
UNKNOWN = "UNKNOWN",
|
|
3420
|
+
OLDEST = "OLDEST",
|
|
3421
|
+
NEWEST = "NEWEST"
|
|
3422
|
+
}
|
|
3423
|
+
/** @enumType */
|
|
3424
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3425
|
+
/** Get Blog Publications Count Stats response */
|
|
3426
|
+
interface QueryPublicationsCountStatsResponse {
|
|
3427
|
+
/** Chronologically ordered list of publications. */
|
|
3428
|
+
stats?: PeriodPublicationsCount[];
|
|
3429
|
+
}
|
|
3430
|
+
/** Publications count for a specific time period */
|
|
3431
|
+
interface PeriodPublicationsCount {
|
|
3432
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3433
|
+
periodStart?: Date | null;
|
|
3434
|
+
/** Number of posts published during this month. */
|
|
3435
|
+
publicationsCount?: number;
|
|
3436
|
+
}
|
|
3437
|
+
/** Get Blog Post Count Stats request */
|
|
3438
|
+
interface QueryPostCountStatsRequest {
|
|
3439
|
+
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3440
|
+
rangeStart?: Date | null;
|
|
3441
|
+
/**
|
|
3442
|
+
* Order of returned results.
|
|
3569
3443
|
*
|
|
3570
|
-
*
|
|
3571
|
-
*
|
|
3572
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3573
|
-
* This parameter will be removed on June 30, 2023.
|
|
3444
|
+
* - `OLDEST`: posts by date in ascending order.
|
|
3445
|
+
* - `NEWEST`: posts by date in descending order.
|
|
3574
3446
|
*
|
|
3575
|
-
*
|
|
3576
|
-
* @replacedBy fieldsets
|
|
3577
|
-
* @targetRemovalDate 2024-06-30
|
|
3447
|
+
* Default: `OLDEST`
|
|
3578
3448
|
*/
|
|
3579
|
-
|
|
3449
|
+
order?: OrderWithLiterals;
|
|
3450
|
+
/** Number of months to include in response. */
|
|
3451
|
+
months?: number;
|
|
3580
3452
|
/**
|
|
3581
3453
|
* Language filter.
|
|
3582
3454
|
*
|
|
3583
3455
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3584
|
-
* Pass a language to only receive
|
|
3585
|
-
* If omitted, posts in all languages are returned.
|
|
3456
|
+
* Pass a language to only receive the period post count for that specified language.
|
|
3586
3457
|
* @format LANGUAGE_TAG
|
|
3587
3458
|
*/
|
|
3588
3459
|
language?: string | null;
|
|
3589
3460
|
/**
|
|
3590
|
-
*
|
|
3591
|
-
*
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3596
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3597
|
-
* only the post’s base fields are returned.
|
|
3598
|
-
* @maxSize 20
|
|
3461
|
+
* Time zone to use when calculating the start of the month.
|
|
3462
|
+
*
|
|
3463
|
+
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
|
|
3464
|
+
* @minLength 3
|
|
3465
|
+
* @maxLength 100
|
|
3599
3466
|
*/
|
|
3600
|
-
|
|
3601
|
-
}
|
|
3602
|
-
declare enum GetPostsSort {
|
|
3603
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3604
|
-
FEED = "FEED",
|
|
3605
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3606
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3607
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3608
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3609
|
-
/** Ordered by total number of views in descending order. */
|
|
3610
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3611
|
-
/** Ordered by total number of likes in descending order. */
|
|
3612
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3613
|
-
/** Ordered by `title` in ascending order. */
|
|
3614
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3615
|
-
/** Ordered by `title` in descending order. */
|
|
3616
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3467
|
+
timeZone?: string | null;
|
|
3617
3468
|
}
|
|
3618
|
-
|
|
3619
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3620
|
-
declare enum PostFieldField {
|
|
3469
|
+
declare enum Order {
|
|
3621
3470
|
UNKNOWN = "UNKNOWN",
|
|
3622
|
-
|
|
3623
|
-
|
|
3624
|
-
/** Includes post content text string when present. */
|
|
3625
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3626
|
-
/** Includes post metrics when present. */
|
|
3627
|
-
METRICS = "METRICS",
|
|
3628
|
-
/** Includes SEO data. */
|
|
3629
|
-
SEO = "SEO",
|
|
3630
|
-
/** Includes post owner's contact ID. */
|
|
3631
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3632
|
-
/** Includes post rich content. */
|
|
3633
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3634
|
-
/** Includes post reference ID field. */
|
|
3635
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3471
|
+
OLDEST = "OLDEST",
|
|
3472
|
+
NEWEST = "NEWEST"
|
|
3636
3473
|
}
|
|
3637
3474
|
/** @enumType */
|
|
3638
|
-
type
|
|
3639
|
-
|
|
3640
|
-
|
|
3641
|
-
|
|
3642
|
-
|
|
3643
|
-
metaData?: MetaData;
|
|
3475
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
|
3476
|
+
/** Get Blog Post Count Stats response */
|
|
3477
|
+
interface QueryPostCountStatsResponse {
|
|
3478
|
+
/** List of published post counts by month. */
|
|
3479
|
+
stats?: PeriodPostCount[];
|
|
3644
3480
|
}
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3481
|
+
/** Post count for a specific time period */
|
|
3482
|
+
interface PeriodPostCount {
|
|
3483
|
+
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
3484
|
+
periodStart?: Date | null;
|
|
3485
|
+
/** Number of posts published during this month. */
|
|
3486
|
+
postCount?: number;
|
|
3648
3487
|
}
|
|
3649
|
-
interface
|
|
3488
|
+
interface GetTotalPublicationsRequest {
|
|
3650
3489
|
/**
|
|
3651
|
-
*
|
|
3652
|
-
* @
|
|
3490
|
+
* Language filter
|
|
3491
|
+
* @minLength 2
|
|
3492
|
+
* @format LANGUAGE_TAG
|
|
3653
3493
|
*/
|
|
3654
|
-
|
|
3494
|
+
language?: string | null;
|
|
3655
3495
|
}
|
|
3656
|
-
interface
|
|
3496
|
+
interface GetTotalPublicationsResponse {
|
|
3497
|
+
/** Total amount of publications. */
|
|
3498
|
+
total?: number;
|
|
3499
|
+
}
|
|
3500
|
+
interface GetTotalPostsRequest {
|
|
3657
3501
|
/**
|
|
3658
|
-
*
|
|
3659
|
-
*
|
|
3502
|
+
* Language filter.
|
|
3503
|
+
*
|
|
3504
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3505
|
+
* Pass a language to receive the total amount of posts in that specified language.
|
|
3506
|
+
* @format LANGUAGE_TAG
|
|
3660
3507
|
*/
|
|
3661
|
-
|
|
3508
|
+
language?: string | null;
|
|
3662
3509
|
}
|
|
3663
|
-
interface
|
|
3664
|
-
/**
|
|
3665
|
-
|
|
3510
|
+
interface GetTotalPostsResponse {
|
|
3511
|
+
/** Total amount of published posts. */
|
|
3512
|
+
total?: number;
|
|
3513
|
+
}
|
|
3514
|
+
interface GetTotalLikesPerMemberRequest {
|
|
3515
|
+
/**
|
|
3516
|
+
* Member ID.
|
|
3517
|
+
* @format GUID
|
|
3518
|
+
*/
|
|
3519
|
+
memberId?: string;
|
|
3520
|
+
}
|
|
3521
|
+
interface GetTotalLikesPerMemberResponse {
|
|
3522
|
+
/** The total number of likes of the member. */
|
|
3523
|
+
total?: number;
|
|
3666
3524
|
}
|
|
3667
3525
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3668
3526
|
/**
|
|
@@ -3733,6 +3591,25 @@ interface GetPostRequest {
|
|
|
3733
3591
|
*/
|
|
3734
3592
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3735
3593
|
}
|
|
3594
|
+
declare enum PostFieldField {
|
|
3595
|
+
UNKNOWN = "UNKNOWN",
|
|
3596
|
+
/** Includes post URL when present. */
|
|
3597
|
+
URL = "URL",
|
|
3598
|
+
/** Includes post content text string when present. */
|
|
3599
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3600
|
+
/** Includes post metrics when present. */
|
|
3601
|
+
METRICS = "METRICS",
|
|
3602
|
+
/** Includes SEO data. */
|
|
3603
|
+
SEO = "SEO",
|
|
3604
|
+
/** Includes post owner's contact ID. */
|
|
3605
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3606
|
+
/** Includes post rich content. */
|
|
3607
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3608
|
+
/** Includes post reference ID field. */
|
|
3609
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3610
|
+
}
|
|
3611
|
+
/** @enumType */
|
|
3612
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3736
3613
|
interface GetPostResponse {
|
|
3737
3614
|
/** Retrieved post info. */
|
|
3738
3615
|
post?: Post;
|
|
@@ -3825,6 +3702,24 @@ interface ListPostsRequest {
|
|
|
3825
3702
|
*/
|
|
3826
3703
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3827
3704
|
}
|
|
3705
|
+
declare enum GetPostsSort {
|
|
3706
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3707
|
+
FEED = "FEED",
|
|
3708
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3709
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3710
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3711
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3712
|
+
/** Ordered by total number of views in descending order. */
|
|
3713
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3714
|
+
/** Ordered by total number of likes in descending order. */
|
|
3715
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3716
|
+
/** Ordered by `title` in ascending order. */
|
|
3717
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3718
|
+
/** Ordered by `title` in descending order. */
|
|
3719
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3720
|
+
}
|
|
3721
|
+
/** @enumType */
|
|
3722
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3828
3723
|
interface ListPostsResponse {
|
|
3829
3724
|
/** List of retrieved posts. */
|
|
3830
3725
|
posts?: Post[];
|
|
@@ -4174,6 +4069,121 @@ interface PostCount {
|
|
|
4174
4069
|
/** Number of posts. */
|
|
4175
4070
|
postCount?: number;
|
|
4176
4071
|
}
|
|
4072
|
+
interface ListDemoPostsRequest {
|
|
4073
|
+
/**
|
|
4074
|
+
* Whether to return only featured posts.
|
|
4075
|
+
*
|
|
4076
|
+
* Default: `false`
|
|
4077
|
+
*/
|
|
4078
|
+
featured?: boolean;
|
|
4079
|
+
/**
|
|
4080
|
+
* Hashtag filter.
|
|
4081
|
+
*
|
|
4082
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4083
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
4084
|
+
* @maxSize 100
|
|
4085
|
+
* @maxLength 100
|
|
4086
|
+
*/
|
|
4087
|
+
hashtags?: string[];
|
|
4088
|
+
/**
|
|
4089
|
+
* Category filter.
|
|
4090
|
+
*
|
|
4091
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4092
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
4093
|
+
* @maxSize 50
|
|
4094
|
+
* @format GUID
|
|
4095
|
+
*/
|
|
4096
|
+
categoryIds?: string[];
|
|
4097
|
+
/**
|
|
4098
|
+
* Tag filter.
|
|
4099
|
+
*
|
|
4100
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4101
|
+
* If omitted, all posts with or without tags are returned.
|
|
4102
|
+
* @maxSize 50
|
|
4103
|
+
* @format GUID
|
|
4104
|
+
*/
|
|
4105
|
+
tagIds?: string[];
|
|
4106
|
+
/**
|
|
4107
|
+
* Sorting options.
|
|
4108
|
+
*
|
|
4109
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4110
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4111
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4112
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4113
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4114
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4115
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4116
|
+
* - `RATING`: reserved for internal use.
|
|
4117
|
+
*
|
|
4118
|
+
* Default: `FEED`
|
|
4119
|
+
*/
|
|
4120
|
+
sort?: GetPostsSortWithLiterals;
|
|
4121
|
+
/** Pagination options. */
|
|
4122
|
+
paging?: BlogPaging;
|
|
4123
|
+
/**
|
|
4124
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
4125
|
+
* This parameter will be removed on June 30, 2023.
|
|
4126
|
+
*
|
|
4127
|
+
* List of post fields to be included in the response.
|
|
4128
|
+
* @maxSize 20
|
|
4129
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4130
|
+
* This parameter will be removed on June 30, 2023.
|
|
4131
|
+
*
|
|
4132
|
+
* List of post fields to be included in the response.
|
|
4133
|
+
* @replacedBy fieldsets
|
|
4134
|
+
* @targetRemovalDate 2024-06-30
|
|
4135
|
+
*/
|
|
4136
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4137
|
+
/**
|
|
4138
|
+
* Language filter.
|
|
4139
|
+
*
|
|
4140
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4141
|
+
* Pass a language to only receive posts that are in that language.
|
|
4142
|
+
* If omitted, posts in all languages are returned.
|
|
4143
|
+
* @format LANGUAGE_TAG
|
|
4144
|
+
*/
|
|
4145
|
+
language?: string | null;
|
|
4146
|
+
/**
|
|
4147
|
+
* Post owner's member ID.
|
|
4148
|
+
* @format GUID
|
|
4149
|
+
*/
|
|
4150
|
+
memberId?: string | null;
|
|
4151
|
+
/**
|
|
4152
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4153
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4154
|
+
* only the post’s base fields are returned.
|
|
4155
|
+
* @maxSize 20
|
|
4156
|
+
*/
|
|
4157
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4158
|
+
}
|
|
4159
|
+
interface ListDemoPostsResponse {
|
|
4160
|
+
/** List of posts. */
|
|
4161
|
+
posts?: Post[];
|
|
4162
|
+
/** Details on the paged set of results returned. */
|
|
4163
|
+
metaData?: MetaData;
|
|
4164
|
+
}
|
|
4165
|
+
interface ConvertDraftJsToRichContentRequest {
|
|
4166
|
+
/** DraftJs content to convert to Rich content. */
|
|
4167
|
+
content?: Record<string, any> | null;
|
|
4168
|
+
}
|
|
4169
|
+
interface ConvertDraftJsToRichContentResponse {
|
|
4170
|
+
/**
|
|
4171
|
+
* Rich content converted from DraftJs content.
|
|
4172
|
+
* @maxLength 2000000
|
|
4173
|
+
*/
|
|
4174
|
+
richContent?: string;
|
|
4175
|
+
}
|
|
4176
|
+
interface ConvertRichContentToDraftJsRequest {
|
|
4177
|
+
/**
|
|
4178
|
+
* Rich content to convert to DraftJs content.
|
|
4179
|
+
* @maxLength 2000000
|
|
4180
|
+
*/
|
|
4181
|
+
richContent?: string;
|
|
4182
|
+
}
|
|
4183
|
+
interface ConvertRichContentToDraftJsResponse {
|
|
4184
|
+
/** DraftJs content converted from Rich content. */
|
|
4185
|
+
content?: Record<string, any> | null;
|
|
4186
|
+
}
|
|
4177
4187
|
|
|
4178
4188
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4179
4189
|
getUrl: (context: any) => string;
|