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