@wix/auto_sdk_blog_posts 1.0.162 → 1.0.163
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 +26 -26
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +320 -320
- package/build/cjs/index.typings.js +26 -26
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +320 -320
- package/build/cjs/meta.js +26 -26
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +3 -2
- package/build/cjs/schemas.js +2 -1
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.mjs +26 -26
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +320 -320
- package/build/es/index.typings.mjs +26 -26
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +320 -320
- package/build/es/meta.mjs +26 -26
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +3 -2
- package/build/es/schemas.mjs +2 -1
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.js +26 -26
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +320 -320
- package/build/internal/cjs/index.typings.js +26 -26
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +320 -320
- package/build/internal/cjs/meta.js +26 -26
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +3 -2
- package/build/internal/cjs/schemas.js +2 -1
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.mjs +26 -26
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +320 -320
- package/build/internal/es/index.typings.mjs +26 -26
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +320 -320
- package/build/internal/es/meta.mjs +26 -26
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +3 -2
- package/build/internal/es/schemas.mjs +2 -1
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2843,170 +2843,6 @@ interface PostUnlikedInitiatorOneOf {
|
|
|
2843
2843
|
*/
|
|
2844
2844
|
anonymousVisitorId?: string | null;
|
|
2845
2845
|
}
|
|
2846
|
-
interface GetTotalLikesPerMemberRequest {
|
|
2847
|
-
/**
|
|
2848
|
-
* Member ID.
|
|
2849
|
-
* @format GUID
|
|
2850
|
-
*/
|
|
2851
|
-
memberId?: string;
|
|
2852
|
-
}
|
|
2853
|
-
interface GetTotalLikesPerMemberResponse {
|
|
2854
|
-
/** The total number of likes of the member. */
|
|
2855
|
-
total?: number;
|
|
2856
|
-
}
|
|
2857
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2858
|
-
createdEvent?: EntityCreatedEvent;
|
|
2859
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2860
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2861
|
-
actionEvent?: ActionEvent;
|
|
2862
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2863
|
-
_id?: string;
|
|
2864
|
-
/**
|
|
2865
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2866
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2867
|
-
*/
|
|
2868
|
-
entityFqdn?: string;
|
|
2869
|
-
/**
|
|
2870
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2871
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2872
|
-
*/
|
|
2873
|
-
slug?: string;
|
|
2874
|
-
/** ID of the entity associated with the event. */
|
|
2875
|
-
entityId?: string;
|
|
2876
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2877
|
-
eventTime?: Date | null;
|
|
2878
|
-
/**
|
|
2879
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2880
|
-
* (for example, GDPR).
|
|
2881
|
-
*/
|
|
2882
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2883
|
-
/** If present, indicates the action that triggered the event. */
|
|
2884
|
-
originatedFrom?: string | null;
|
|
2885
|
-
/**
|
|
2886
|
-
* 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.
|
|
2887
|
-
* 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.
|
|
2888
|
-
*/
|
|
2889
|
-
entityEventSequence?: string | null;
|
|
2890
|
-
}
|
|
2891
|
-
/** @oneof */
|
|
2892
|
-
interface DomainEventBodyOneOf {
|
|
2893
|
-
createdEvent?: EntityCreatedEvent;
|
|
2894
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2895
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2896
|
-
actionEvent?: ActionEvent;
|
|
2897
|
-
}
|
|
2898
|
-
interface EntityCreatedEvent {
|
|
2899
|
-
entity?: string;
|
|
2900
|
-
}
|
|
2901
|
-
interface RestoreInfo {
|
|
2902
|
-
deletedDate?: Date | null;
|
|
2903
|
-
}
|
|
2904
|
-
interface EntityUpdatedEvent {
|
|
2905
|
-
/**
|
|
2906
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2907
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2908
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2909
|
-
*/
|
|
2910
|
-
currentEntity?: string;
|
|
2911
|
-
}
|
|
2912
|
-
interface EntityDeletedEvent {
|
|
2913
|
-
/** Entity that was deleted. */
|
|
2914
|
-
deletedEntity?: string | null;
|
|
2915
|
-
}
|
|
2916
|
-
interface ActionEvent {
|
|
2917
|
-
body?: string;
|
|
2918
|
-
}
|
|
2919
|
-
interface MessageEnvelope {
|
|
2920
|
-
/**
|
|
2921
|
-
* App instance ID.
|
|
2922
|
-
* @format GUID
|
|
2923
|
-
*/
|
|
2924
|
-
instanceId?: string | null;
|
|
2925
|
-
/**
|
|
2926
|
-
* Event type.
|
|
2927
|
-
* @maxLength 150
|
|
2928
|
-
*/
|
|
2929
|
-
eventType?: string;
|
|
2930
|
-
/** The identification type and identity data. */
|
|
2931
|
-
identity?: IdentificationData;
|
|
2932
|
-
/** Stringify payload. */
|
|
2933
|
-
data?: string;
|
|
2934
|
-
/** Details related to the account */
|
|
2935
|
-
accountInfo?: AccountInfo;
|
|
2936
|
-
}
|
|
2937
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2938
|
-
/**
|
|
2939
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2940
|
-
* @format GUID
|
|
2941
|
-
*/
|
|
2942
|
-
anonymousVisitorId?: string;
|
|
2943
|
-
/**
|
|
2944
|
-
* ID of a site visitor that has logged in to the site.
|
|
2945
|
-
* @format GUID
|
|
2946
|
-
*/
|
|
2947
|
-
memberId?: string;
|
|
2948
|
-
/**
|
|
2949
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2950
|
-
* @format GUID
|
|
2951
|
-
*/
|
|
2952
|
-
wixUserId?: string;
|
|
2953
|
-
/**
|
|
2954
|
-
* ID of an app.
|
|
2955
|
-
* @format GUID
|
|
2956
|
-
*/
|
|
2957
|
-
appId?: string;
|
|
2958
|
-
/** @readonly */
|
|
2959
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2960
|
-
}
|
|
2961
|
-
/** @oneof */
|
|
2962
|
-
interface IdentificationDataIdOneOf {
|
|
2963
|
-
/**
|
|
2964
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2965
|
-
* @format GUID
|
|
2966
|
-
*/
|
|
2967
|
-
anonymousVisitorId?: string;
|
|
2968
|
-
/**
|
|
2969
|
-
* ID of a site visitor that has logged in to the site.
|
|
2970
|
-
* @format GUID
|
|
2971
|
-
*/
|
|
2972
|
-
memberId?: string;
|
|
2973
|
-
/**
|
|
2974
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2975
|
-
* @format GUID
|
|
2976
|
-
*/
|
|
2977
|
-
wixUserId?: string;
|
|
2978
|
-
/**
|
|
2979
|
-
* ID of an app.
|
|
2980
|
-
* @format GUID
|
|
2981
|
-
*/
|
|
2982
|
-
appId?: string;
|
|
2983
|
-
}
|
|
2984
|
-
declare enum WebhookIdentityType {
|
|
2985
|
-
UNKNOWN = "UNKNOWN",
|
|
2986
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2987
|
-
MEMBER = "MEMBER",
|
|
2988
|
-
WIX_USER = "WIX_USER",
|
|
2989
|
-
APP = "APP"
|
|
2990
|
-
}
|
|
2991
|
-
/** @enumType */
|
|
2992
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2993
|
-
interface AccountInfo {
|
|
2994
|
-
/**
|
|
2995
|
-
* ID of the Wix account associated with the event.
|
|
2996
|
-
* @format GUID
|
|
2997
|
-
*/
|
|
2998
|
-
accountId?: string | null;
|
|
2999
|
-
/**
|
|
3000
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3001
|
-
* @format GUID
|
|
3002
|
-
*/
|
|
3003
|
-
parentAccountId?: string | null;
|
|
3004
|
-
/**
|
|
3005
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3006
|
-
* @format GUID
|
|
3007
|
-
*/
|
|
3008
|
-
siteId?: string | null;
|
|
3009
|
-
}
|
|
3010
2846
|
/** Get Blog Publications Count Stats request */
|
|
3011
2847
|
interface QueryPublicationsCountStatsRequest {
|
|
3012
2848
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
@@ -3127,193 +2963,169 @@ interface GetTotalPostsResponse {
|
|
|
3127
2963
|
/** Total amount of published posts. */
|
|
3128
2964
|
total?: number;
|
|
3129
2965
|
}
|
|
3130
|
-
interface
|
|
2966
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2967
|
+
createdEvent?: EntityCreatedEvent;
|
|
2968
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2969
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2970
|
+
actionEvent?: ActionEvent;
|
|
2971
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2972
|
+
_id?: string;
|
|
3131
2973
|
/**
|
|
3132
|
-
*
|
|
3133
|
-
*
|
|
3134
|
-
* Default: `false`
|
|
2974
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2975
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3135
2976
|
*/
|
|
3136
|
-
|
|
2977
|
+
entityFqdn?: string;
|
|
3137
2978
|
/**
|
|
3138
|
-
*
|
|
3139
|
-
*
|
|
3140
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3141
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
3142
|
-
* @maxSize 100
|
|
3143
|
-
* @maxLength 100
|
|
2979
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2980
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3144
2981
|
*/
|
|
3145
|
-
|
|
2982
|
+
slug?: string;
|
|
2983
|
+
/** ID of the entity associated with the event. */
|
|
2984
|
+
entityId?: string;
|
|
2985
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2986
|
+
eventTime?: Date | null;
|
|
3146
2987
|
/**
|
|
3147
|
-
*
|
|
3148
|
-
*
|
|
3149
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3150
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
3151
|
-
* @maxSize 50
|
|
3152
|
-
* @format GUID
|
|
2988
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2989
|
+
* (for example, GDPR).
|
|
3153
2990
|
*/
|
|
3154
|
-
|
|
2991
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2992
|
+
/** If present, indicates the action that triggered the event. */
|
|
2993
|
+
originatedFrom?: string | null;
|
|
3155
2994
|
/**
|
|
3156
|
-
*
|
|
3157
|
-
*
|
|
3158
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3159
|
-
* If omitted, all posts with or without tags are returned.
|
|
3160
|
-
* @maxSize 50
|
|
3161
|
-
* @format GUID
|
|
2995
|
+
* 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.
|
|
2996
|
+
* 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.
|
|
3162
2997
|
*/
|
|
3163
|
-
|
|
2998
|
+
entityEventSequence?: string | null;
|
|
2999
|
+
}
|
|
3000
|
+
/** @oneof */
|
|
3001
|
+
interface DomainEventBodyOneOf {
|
|
3002
|
+
createdEvent?: EntityCreatedEvent;
|
|
3003
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3004
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3005
|
+
actionEvent?: ActionEvent;
|
|
3006
|
+
}
|
|
3007
|
+
interface EntityCreatedEvent {
|
|
3008
|
+
entity?: string;
|
|
3009
|
+
}
|
|
3010
|
+
interface RestoreInfo {
|
|
3011
|
+
deletedDate?: Date | null;
|
|
3012
|
+
}
|
|
3013
|
+
interface EntityUpdatedEvent {
|
|
3164
3014
|
/**
|
|
3165
|
-
*
|
|
3166
|
-
*
|
|
3167
|
-
*
|
|
3168
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3169
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3170
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3171
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3172
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3173
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3174
|
-
* - `RATING`: reserved for internal use.
|
|
3175
|
-
*
|
|
3176
|
-
* Default: `FEED`
|
|
3015
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3016
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3017
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3177
3018
|
*/
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3019
|
+
currentEntity?: string;
|
|
3020
|
+
}
|
|
3021
|
+
interface EntityDeletedEvent {
|
|
3022
|
+
/** Entity that was deleted. */
|
|
3023
|
+
deletedEntity?: string | null;
|
|
3024
|
+
}
|
|
3025
|
+
interface ActionEvent {
|
|
3026
|
+
body?: string;
|
|
3027
|
+
}
|
|
3028
|
+
interface MessageEnvelope {
|
|
3181
3029
|
/**
|
|
3182
|
-
*
|
|
3183
|
-
*
|
|
3184
|
-
*
|
|
3185
|
-
* List of post fields to be included in the response.
|
|
3186
|
-
* @maxSize 20
|
|
3187
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3188
|
-
* This parameter will be removed on June 30, 2023.
|
|
3189
|
-
*
|
|
3190
|
-
* List of post fields to be included in the response.
|
|
3191
|
-
* @replacedBy fieldsets
|
|
3192
|
-
* @targetRemovalDate 2024-06-30
|
|
3030
|
+
* App instance ID.
|
|
3031
|
+
* @format GUID
|
|
3193
3032
|
*/
|
|
3194
|
-
|
|
3033
|
+
instanceId?: string | null;
|
|
3195
3034
|
/**
|
|
3196
|
-
*
|
|
3197
|
-
*
|
|
3198
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3199
|
-
* Pass a language to only receive posts that are in that language.
|
|
3200
|
-
* If omitted, posts in all languages are returned.
|
|
3201
|
-
* @format LANGUAGE_TAG
|
|
3035
|
+
* Event type.
|
|
3036
|
+
* @maxLength 150
|
|
3202
3037
|
*/
|
|
3203
|
-
|
|
3038
|
+
eventType?: string;
|
|
3039
|
+
/** The identification type and identity data. */
|
|
3040
|
+
identity?: IdentificationData;
|
|
3041
|
+
/** Stringify payload. */
|
|
3042
|
+
data?: string;
|
|
3043
|
+
/** Details related to the account */
|
|
3044
|
+
accountInfo?: AccountInfo;
|
|
3045
|
+
}
|
|
3046
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3204
3047
|
/**
|
|
3205
|
-
*
|
|
3048
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3206
3049
|
* @format GUID
|
|
3207
3050
|
*/
|
|
3208
|
-
|
|
3209
|
-
/**
|
|
3210
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3211
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3212
|
-
* only the post’s base fields are returned.
|
|
3213
|
-
* @maxSize 20
|
|
3214
|
-
*/
|
|
3215
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3216
|
-
}
|
|
3217
|
-
declare enum GetPostsSort {
|
|
3218
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3219
|
-
FEED = "FEED",
|
|
3220
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3221
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3222
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3223
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3224
|
-
/** Ordered by total number of views in descending order. */
|
|
3225
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3226
|
-
/** Ordered by total number of likes in descending order. */
|
|
3227
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3228
|
-
/** Ordered by `title` in ascending order. */
|
|
3229
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3230
|
-
/** Ordered by `title` in descending order. */
|
|
3231
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3232
|
-
}
|
|
3233
|
-
/** @enumType */
|
|
3234
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3235
|
-
interface BlogPaging {
|
|
3051
|
+
anonymousVisitorId?: string;
|
|
3236
3052
|
/**
|
|
3237
|
-
*
|
|
3238
|
-
*
|
|
3239
|
-
*
|
|
3240
|
-
* Default: `0`
|
|
3053
|
+
* ID of a site visitor that has logged in to the site.
|
|
3054
|
+
* @format GUID
|
|
3241
3055
|
*/
|
|
3242
|
-
|
|
3056
|
+
memberId?: string;
|
|
3243
3057
|
/**
|
|
3244
|
-
*
|
|
3245
|
-
*
|
|
3246
|
-
*
|
|
3247
|
-
* Default:`50`
|
|
3248
|
-
* @min 1
|
|
3249
|
-
* @max 100
|
|
3058
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3059
|
+
* @format GUID
|
|
3250
3060
|
*/
|
|
3251
|
-
|
|
3061
|
+
wixUserId?: string;
|
|
3252
3062
|
/**
|
|
3253
|
-
*
|
|
3254
|
-
* @
|
|
3063
|
+
* ID of an app.
|
|
3064
|
+
* @format GUID
|
|
3255
3065
|
*/
|
|
3256
|
-
|
|
3257
|
-
|
|
3258
|
-
|
|
3259
|
-
|
|
3260
|
-
|
|
3261
|
-
|
|
3262
|
-
/** Includes post content text string when present. */
|
|
3263
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3264
|
-
/** Includes post metrics when present. */
|
|
3265
|
-
METRICS = "METRICS",
|
|
3266
|
-
/** Includes SEO data. */
|
|
3267
|
-
SEO = "SEO",
|
|
3268
|
-
/** Includes post owner's contact ID. */
|
|
3269
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3270
|
-
/** Includes post rich content. */
|
|
3271
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3272
|
-
/** Includes post reference ID field. */
|
|
3273
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3274
|
-
}
|
|
3275
|
-
/** @enumType */
|
|
3276
|
-
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3277
|
-
interface ListDemoPostsResponse {
|
|
3278
|
-
/** List of posts. */
|
|
3279
|
-
posts?: Post[];
|
|
3280
|
-
/** Details on the paged set of results returned. */
|
|
3281
|
-
metaData?: MetaData;
|
|
3282
|
-
}
|
|
3283
|
-
interface MetaData {
|
|
3284
|
-
/** Number of items returned in this response. */
|
|
3285
|
-
count?: number;
|
|
3286
|
-
/** Requested offset. */
|
|
3287
|
-
offset?: number;
|
|
3288
|
-
/** Total number of items that match the query. */
|
|
3289
|
-
total?: number;
|
|
3066
|
+
appId?: string;
|
|
3067
|
+
/** @readonly */
|
|
3068
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3069
|
+
}
|
|
3070
|
+
/** @oneof */
|
|
3071
|
+
interface IdentificationDataIdOneOf {
|
|
3290
3072
|
/**
|
|
3291
|
-
*
|
|
3292
|
-
* @
|
|
3073
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3074
|
+
* @format GUID
|
|
3293
3075
|
*/
|
|
3294
|
-
|
|
3076
|
+
anonymousVisitorId?: string;
|
|
3077
|
+
/**
|
|
3078
|
+
* ID of a site visitor that has logged in to the site.
|
|
3079
|
+
* @format GUID
|
|
3080
|
+
*/
|
|
3081
|
+
memberId?: string;
|
|
3082
|
+
/**
|
|
3083
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3084
|
+
* @format GUID
|
|
3085
|
+
*/
|
|
3086
|
+
wixUserId?: string;
|
|
3087
|
+
/**
|
|
3088
|
+
* ID of an app.
|
|
3089
|
+
* @format GUID
|
|
3090
|
+
*/
|
|
3091
|
+
appId?: string;
|
|
3295
3092
|
}
|
|
3296
|
-
|
|
3297
|
-
|
|
3298
|
-
|
|
3093
|
+
declare enum WebhookIdentityType {
|
|
3094
|
+
UNKNOWN = "UNKNOWN",
|
|
3095
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3096
|
+
MEMBER = "MEMBER",
|
|
3097
|
+
WIX_USER = "WIX_USER",
|
|
3098
|
+
APP = "APP"
|
|
3299
3099
|
}
|
|
3300
|
-
|
|
3100
|
+
/** @enumType */
|
|
3101
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3102
|
+
interface AccountInfo {
|
|
3301
3103
|
/**
|
|
3302
|
-
*
|
|
3303
|
-
* @
|
|
3104
|
+
* ID of the Wix account associated with the event.
|
|
3105
|
+
* @format GUID
|
|
3304
3106
|
*/
|
|
3305
|
-
|
|
3107
|
+
accountId?: string | null;
|
|
3108
|
+
/**
|
|
3109
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3110
|
+
* @format GUID
|
|
3111
|
+
*/
|
|
3112
|
+
parentAccountId?: string | null;
|
|
3113
|
+
/**
|
|
3114
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3115
|
+
* @format GUID
|
|
3116
|
+
*/
|
|
3117
|
+
siteId?: string | null;
|
|
3306
3118
|
}
|
|
3307
|
-
interface
|
|
3119
|
+
interface GetTotalLikesPerMemberRequest {
|
|
3308
3120
|
/**
|
|
3309
|
-
*
|
|
3310
|
-
* @
|
|
3121
|
+
* Member ID.
|
|
3122
|
+
* @format GUID
|
|
3311
3123
|
*/
|
|
3312
|
-
|
|
3124
|
+
memberId?: string;
|
|
3313
3125
|
}
|
|
3314
|
-
interface
|
|
3315
|
-
/**
|
|
3316
|
-
|
|
3126
|
+
interface GetTotalLikesPerMemberResponse {
|
|
3127
|
+
/** The total number of likes of the member. */
|
|
3128
|
+
total?: number;
|
|
3317
3129
|
}
|
|
3318
3130
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3319
3131
|
/**
|
|
@@ -3384,6 +3196,25 @@ interface GetPostRequest {
|
|
|
3384
3196
|
*/
|
|
3385
3197
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3386
3198
|
}
|
|
3199
|
+
declare enum PostFieldField {
|
|
3200
|
+
UNKNOWN = "UNKNOWN",
|
|
3201
|
+
/** Includes post URL when present. */
|
|
3202
|
+
URL = "URL",
|
|
3203
|
+
/** Includes post content text string when present. */
|
|
3204
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3205
|
+
/** Includes post metrics when present. */
|
|
3206
|
+
METRICS = "METRICS",
|
|
3207
|
+
/** Includes SEO data. */
|
|
3208
|
+
SEO = "SEO",
|
|
3209
|
+
/** Includes post owner's contact ID. */
|
|
3210
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3211
|
+
/** Includes post rich content. */
|
|
3212
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3213
|
+
/** Includes post reference ID field. */
|
|
3214
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3215
|
+
}
|
|
3216
|
+
/** @enumType */
|
|
3217
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3387
3218
|
interface GetPostResponse {
|
|
3388
3219
|
/** Retrieved post info. */
|
|
3389
3220
|
post?: Post;
|
|
@@ -3476,12 +3307,66 @@ interface ListPostsRequest {
|
|
|
3476
3307
|
*/
|
|
3477
3308
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3478
3309
|
}
|
|
3310
|
+
declare enum GetPostsSort {
|
|
3311
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3312
|
+
FEED = "FEED",
|
|
3313
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3314
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3315
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3316
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3317
|
+
/** Ordered by total number of views in descending order. */
|
|
3318
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3319
|
+
/** Ordered by total number of likes in descending order. */
|
|
3320
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3321
|
+
/** Ordered by `title` in ascending order. */
|
|
3322
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3323
|
+
/** Ordered by `title` in descending order. */
|
|
3324
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3325
|
+
}
|
|
3326
|
+
/** @enumType */
|
|
3327
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3328
|
+
interface BlogPaging {
|
|
3329
|
+
/**
|
|
3330
|
+
* Number of items to skip in the current sort order.
|
|
3331
|
+
*
|
|
3332
|
+
*
|
|
3333
|
+
* Default: `0`
|
|
3334
|
+
*/
|
|
3335
|
+
offset?: number;
|
|
3336
|
+
/**
|
|
3337
|
+
* Number of items to return.
|
|
3338
|
+
*
|
|
3339
|
+
*
|
|
3340
|
+
* Default:`50`
|
|
3341
|
+
* @min 1
|
|
3342
|
+
* @max 100
|
|
3343
|
+
*/
|
|
3344
|
+
limit?: number;
|
|
3345
|
+
/**
|
|
3346
|
+
* Pointer to the next or previous page in the list of results.
|
|
3347
|
+
* @maxLength 2000
|
|
3348
|
+
*/
|
|
3349
|
+
cursor?: string | null;
|
|
3350
|
+
}
|
|
3479
3351
|
interface ListPostsResponse {
|
|
3480
3352
|
/** List of retrieved posts. */
|
|
3481
3353
|
posts?: Post[];
|
|
3482
3354
|
/** Details on the paged set of results returned. */
|
|
3483
3355
|
metaData?: MetaData;
|
|
3484
3356
|
}
|
|
3357
|
+
interface MetaData {
|
|
3358
|
+
/** Number of items returned in this response. */
|
|
3359
|
+
count?: number;
|
|
3360
|
+
/** Requested offset. */
|
|
3361
|
+
offset?: number;
|
|
3362
|
+
/** Total number of items that match the query. */
|
|
3363
|
+
total?: number;
|
|
3364
|
+
/**
|
|
3365
|
+
* Pointer to the next or previous page in the list of results.
|
|
3366
|
+
* @maxLength 2000
|
|
3367
|
+
*/
|
|
3368
|
+
cursor?: string | null;
|
|
3369
|
+
}
|
|
3485
3370
|
interface QueryPostsRequest {
|
|
3486
3371
|
/** Query options. */
|
|
3487
3372
|
query?: PlatformQuery;
|
|
@@ -3825,6 +3710,121 @@ interface PostCount {
|
|
|
3825
3710
|
/** Number of posts. */
|
|
3826
3711
|
postCount?: number;
|
|
3827
3712
|
}
|
|
3713
|
+
interface ListDemoPostsRequest {
|
|
3714
|
+
/**
|
|
3715
|
+
* Whether to return only featured posts.
|
|
3716
|
+
*
|
|
3717
|
+
* Default: `false`
|
|
3718
|
+
*/
|
|
3719
|
+
featured?: boolean;
|
|
3720
|
+
/**
|
|
3721
|
+
* Hashtag filter.
|
|
3722
|
+
*
|
|
3723
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3724
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3725
|
+
* @maxSize 100
|
|
3726
|
+
* @maxLength 100
|
|
3727
|
+
*/
|
|
3728
|
+
hashtags?: string[];
|
|
3729
|
+
/**
|
|
3730
|
+
* Category filter.
|
|
3731
|
+
*
|
|
3732
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3733
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3734
|
+
* @maxSize 50
|
|
3735
|
+
* @format GUID
|
|
3736
|
+
*/
|
|
3737
|
+
categoryIds?: string[];
|
|
3738
|
+
/**
|
|
3739
|
+
* Tag filter.
|
|
3740
|
+
*
|
|
3741
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3742
|
+
* If omitted, all posts with or without tags are returned.
|
|
3743
|
+
* @maxSize 50
|
|
3744
|
+
* @format GUID
|
|
3745
|
+
*/
|
|
3746
|
+
tagIds?: string[];
|
|
3747
|
+
/**
|
|
3748
|
+
* Sorting options.
|
|
3749
|
+
*
|
|
3750
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3751
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3752
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3753
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3754
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3755
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3756
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3757
|
+
* - `RATING`: reserved for internal use.
|
|
3758
|
+
*
|
|
3759
|
+
* Default: `FEED`
|
|
3760
|
+
*/
|
|
3761
|
+
sort?: GetPostsSortWithLiterals;
|
|
3762
|
+
/** Pagination options. */
|
|
3763
|
+
paging?: BlogPaging;
|
|
3764
|
+
/**
|
|
3765
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
3766
|
+
* This parameter will be removed on June 30, 2023.
|
|
3767
|
+
*
|
|
3768
|
+
* List of post fields to be included in the response.
|
|
3769
|
+
* @maxSize 20
|
|
3770
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3771
|
+
* This parameter will be removed on June 30, 2023.
|
|
3772
|
+
*
|
|
3773
|
+
* List of post fields to be included in the response.
|
|
3774
|
+
* @replacedBy fieldsets
|
|
3775
|
+
* @targetRemovalDate 2024-06-30
|
|
3776
|
+
*/
|
|
3777
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3778
|
+
/**
|
|
3779
|
+
* Language filter.
|
|
3780
|
+
*
|
|
3781
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3782
|
+
* Pass a language to only receive posts that are in that language.
|
|
3783
|
+
* If omitted, posts in all languages are returned.
|
|
3784
|
+
* @format LANGUAGE_TAG
|
|
3785
|
+
*/
|
|
3786
|
+
language?: string | null;
|
|
3787
|
+
/**
|
|
3788
|
+
* Post owner's member ID.
|
|
3789
|
+
* @format GUID
|
|
3790
|
+
*/
|
|
3791
|
+
memberId?: string | null;
|
|
3792
|
+
/**
|
|
3793
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3794
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3795
|
+
* only the post’s base fields are returned.
|
|
3796
|
+
* @maxSize 20
|
|
3797
|
+
*/
|
|
3798
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3799
|
+
}
|
|
3800
|
+
interface ListDemoPostsResponse {
|
|
3801
|
+
/** List of posts. */
|
|
3802
|
+
posts?: Post[];
|
|
3803
|
+
/** Details on the paged set of results returned. */
|
|
3804
|
+
metaData?: MetaData;
|
|
3805
|
+
}
|
|
3806
|
+
interface ConvertDraftJsToRichContentRequest {
|
|
3807
|
+
/** DraftJs content to convert to Rich content. */
|
|
3808
|
+
content?: Record<string, any> | null;
|
|
3809
|
+
}
|
|
3810
|
+
interface ConvertDraftJsToRichContentResponse {
|
|
3811
|
+
/**
|
|
3812
|
+
* Rich content converted from DraftJs content.
|
|
3813
|
+
* @maxLength 2000000
|
|
3814
|
+
*/
|
|
3815
|
+
richContent?: string;
|
|
3816
|
+
}
|
|
3817
|
+
interface ConvertRichContentToDraftJsRequest {
|
|
3818
|
+
/**
|
|
3819
|
+
* Rich content to convert to DraftJs content.
|
|
3820
|
+
* @maxLength 2000000
|
|
3821
|
+
*/
|
|
3822
|
+
richContent?: string;
|
|
3823
|
+
}
|
|
3824
|
+
interface ConvertRichContentToDraftJsResponse {
|
|
3825
|
+
/** DraftJs content converted from Rich content. */
|
|
3826
|
+
content?: Record<string, any> | null;
|
|
3827
|
+
}
|
|
3828
3828
|
interface BaseEventMetadata {
|
|
3829
3829
|
/**
|
|
3830
3830
|
* App instance ID.
|
|
@@ -4240,7 +4240,7 @@ interface PostsQueryBuilder {
|
|
|
4240
4240
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
4241
4241
|
* @param string - String to compare against. Case-insensitive.
|
|
4242
4242
|
*/
|
|
4243
|
-
startsWith: (propertyName: 'title', value: string) => PostsQueryBuilder;
|
|
4243
|
+
startsWith: (propertyName: 'title' | 'slug', value: string) => PostsQueryBuilder;
|
|
4244
4244
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
4245
4245
|
* @param values - List of values to compare against.
|
|
4246
4246
|
*/
|
|
@@ -4303,7 +4303,7 @@ interface PostQuerySpec extends QuerySpec {
|
|
|
4303
4303
|
},
|
|
4304
4304
|
{
|
|
4305
4305
|
fields: ['slug'];
|
|
4306
|
-
operators: ['$eq', '$hasAll', '$hasSome', '$ne'];
|
|
4306
|
+
operators: ['$eq', '$hasAll', '$hasSome', '$ne', '$startsWith'];
|
|
4307
4307
|
sort: 'BOTH';
|
|
4308
4308
|
},
|
|
4309
4309
|
{
|