@wix/auto_sdk_blog_posts 1.0.189 → 1.0.191
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 +18 -12
- package/build/cjs/index.js +998 -2344
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +199 -185
- package/build/cjs/index.typings.js +673 -1392
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +167 -167
- package/build/cjs/meta.js +634 -1356
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +18 -12
- package/build/es/index.mjs +998 -2344
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +199 -185
- package/build/es/index.typings.mjs +673 -1392
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +167 -167
- package/build/es/meta.mjs +634 -1356
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +18 -12
- package/build/internal/cjs/index.typings.d.ts +253 -239
- package/build/internal/cjs/meta.d.ts +221 -221
- package/build/internal/es/index.d.mts +18 -12
- package/build/internal/es/index.typings.d.mts +253 -239
- package/build/internal/es/meta.d.mts +221 -221
- package/package.json +2 -2
|
@@ -3957,62 +3957,91 @@ interface GetTotalPostsResponse {
|
|
|
3957
3957
|
/** Total amount of published posts. */
|
|
3958
3958
|
total?: number;
|
|
3959
3959
|
}
|
|
3960
|
-
interface
|
|
3960
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3961
3961
|
/**
|
|
3962
|
-
*
|
|
3963
|
-
*
|
|
3964
|
-
* Default: `false`
|
|
3962
|
+
* Member ID of person who triggered the counter update
|
|
3963
|
+
* @format GUID
|
|
3965
3964
|
*/
|
|
3966
|
-
|
|
3965
|
+
memberId?: string | null;
|
|
3967
3966
|
/**
|
|
3968
|
-
*
|
|
3969
|
-
*
|
|
3970
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3971
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
3972
|
-
* @maxSize 100
|
|
3973
|
-
* @maxLength 100
|
|
3967
|
+
* Visitor ID if person that liked the post is not logged in
|
|
3968
|
+
* @format GUID
|
|
3974
3969
|
*/
|
|
3975
|
-
|
|
3970
|
+
anonymousVisitorId?: string | null;
|
|
3976
3971
|
/**
|
|
3977
|
-
*
|
|
3978
|
-
*
|
|
3979
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3980
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
3981
|
-
* @maxSize 50
|
|
3972
|
+
* ID of the post which counters were updated.
|
|
3982
3973
|
* @format GUID
|
|
3983
3974
|
*/
|
|
3984
|
-
|
|
3975
|
+
postId?: string;
|
|
3985
3976
|
/**
|
|
3986
|
-
*
|
|
3987
|
-
*
|
|
3988
|
-
*
|
|
3989
|
-
|
|
3990
|
-
|
|
3977
|
+
* Internal ID of the post which counters were updated.
|
|
3978
|
+
* @internal
|
|
3979
|
+
* @maxLength 24
|
|
3980
|
+
*/
|
|
3981
|
+
postInternalId?: string;
|
|
3982
|
+
/** Field of the updated counter. */
|
|
3983
|
+
updatedCounterField?: FieldWithLiterals;
|
|
3984
|
+
/** New counter value. */
|
|
3985
|
+
counter?: number;
|
|
3986
|
+
}
|
|
3987
|
+
/** @oneof */
|
|
3988
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
|
3989
|
+
/**
|
|
3990
|
+
* Member ID of person who triggered the counter update
|
|
3991
3991
|
* @format GUID
|
|
3992
3992
|
*/
|
|
3993
|
-
|
|
3993
|
+
memberId?: string | null;
|
|
3994
3994
|
/**
|
|
3995
|
-
*
|
|
3996
|
-
*
|
|
3997
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3998
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3999
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4000
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4001
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4002
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4003
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4004
|
-
* - `RATING`: reserved for internal use.
|
|
4005
|
-
*
|
|
4006
|
-
* Default: `FEED`
|
|
3995
|
+
* Visitor ID if person that liked the post is not logged in
|
|
3996
|
+
* @format GUID
|
|
4007
3997
|
*/
|
|
4008
|
-
|
|
4009
|
-
|
|
4010
|
-
|
|
3998
|
+
anonymousVisitorId?: string | null;
|
|
3999
|
+
}
|
|
4000
|
+
declare enum Field {
|
|
4001
|
+
/** Undefined field. */
|
|
4002
|
+
UNKNOWN = "UNKNOWN",
|
|
4003
|
+
/** Total comments field. */
|
|
4004
|
+
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
|
4005
|
+
/** Like count field. */
|
|
4006
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
4007
|
+
/** View count field. */
|
|
4008
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
4009
|
+
/** Rating count field. */
|
|
4010
|
+
RATING_COUNT = "RATING_COUNT"
|
|
4011
|
+
}
|
|
4012
|
+
/** @enumType */
|
|
4013
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
|
4014
|
+
interface PostOwnerChanged {
|
|
4015
|
+
/**
|
|
4016
|
+
* Member ID of the post's owner before the change.
|
|
4017
|
+
* @internal
|
|
4018
|
+
* @format GUID
|
|
4019
|
+
*/
|
|
4020
|
+
oldMemberId?: string;
|
|
4021
|
+
/**
|
|
4022
|
+
* Member ID of the post's owner after the change.
|
|
4023
|
+
* @internal
|
|
4024
|
+
* @format GUID
|
|
4025
|
+
*/
|
|
4026
|
+
newMemberId?: string;
|
|
4027
|
+
}
|
|
4028
|
+
interface InitialPostsCopied {
|
|
4029
|
+
/** Number of posts copied. */
|
|
4030
|
+
count?: number;
|
|
4031
|
+
}
|
|
4032
|
+
interface GetPostRequest {
|
|
4033
|
+
/**
|
|
4034
|
+
* Post ID.
|
|
4035
|
+
* @minLength 1
|
|
4036
|
+
* @maxLength 38
|
|
4037
|
+
*/
|
|
4038
|
+
postId: string;
|
|
4011
4039
|
/**
|
|
4012
4040
|
* __Deprecated.__ Use `fieldsets` instead.
|
|
4013
4041
|
* This parameter will be removed on June 30, 2023.
|
|
4014
4042
|
*
|
|
4015
4043
|
* List of post fields to be included in the response.
|
|
4044
|
+
* @internal
|
|
4016
4045
|
* @maxSize 20
|
|
4017
4046
|
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4018
4047
|
* This parameter will be removed on June 30, 2023.
|
|
@@ -4022,20 +4051,6 @@ interface ListDemoPostsRequest {
|
|
|
4022
4051
|
* @targetRemovalDate 2024-06-30
|
|
4023
4052
|
*/
|
|
4024
4053
|
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4025
|
-
/**
|
|
4026
|
-
* Language filter.
|
|
4027
|
-
*
|
|
4028
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4029
|
-
* Pass a language to only receive posts that are in that language.
|
|
4030
|
-
* If omitted, posts in all languages are returned.
|
|
4031
|
-
* @format LANGUAGE_TAG
|
|
4032
|
-
*/
|
|
4033
|
-
language?: string | null;
|
|
4034
|
-
/**
|
|
4035
|
-
* Post owner's member ID.
|
|
4036
|
-
* @format GUID
|
|
4037
|
-
*/
|
|
4038
|
-
memberId?: string | null;
|
|
4039
4054
|
/**
|
|
4040
4055
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4041
4056
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -4044,52 +4059,6 @@ interface ListDemoPostsRequest {
|
|
|
4044
4059
|
*/
|
|
4045
4060
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4046
4061
|
}
|
|
4047
|
-
declare enum GetPostsSort {
|
|
4048
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
4049
|
-
FEED = "FEED",
|
|
4050
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
4051
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
4052
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
4053
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
4054
|
-
/** Ordered by total number of views in descending order. */
|
|
4055
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
4056
|
-
/** Ordered by total number of likes in descending order. */
|
|
4057
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
4058
|
-
/** Ordered by `title` in ascending order. */
|
|
4059
|
-
TITLE_ASC = "TITLE_ASC",
|
|
4060
|
-
/** Ordered by `title` in descending order. */
|
|
4061
|
-
TITLE_DESC = "TITLE_DESC",
|
|
4062
|
-
/**
|
|
4063
|
-
* Sorting by post rating descending.
|
|
4064
|
-
* @internal
|
|
4065
|
-
*/
|
|
4066
|
-
RATING = "RATING"
|
|
4067
|
-
}
|
|
4068
|
-
/** @enumType */
|
|
4069
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
4070
|
-
interface BlogPaging {
|
|
4071
|
-
/**
|
|
4072
|
-
* Number of items to skip in the current sort order.
|
|
4073
|
-
*
|
|
4074
|
-
*
|
|
4075
|
-
* Default: `0`
|
|
4076
|
-
*/
|
|
4077
|
-
offset?: number;
|
|
4078
|
-
/**
|
|
4079
|
-
* Number of items to return.
|
|
4080
|
-
*
|
|
4081
|
-
*
|
|
4082
|
-
* Default:`50`
|
|
4083
|
-
* @min 1
|
|
4084
|
-
* @max 100
|
|
4085
|
-
*/
|
|
4086
|
-
limit?: number;
|
|
4087
|
-
/**
|
|
4088
|
-
* Pointer to the next or previous page in the list of results.
|
|
4089
|
-
* @maxLength 2000
|
|
4090
|
-
*/
|
|
4091
|
-
cursor?: string | null;
|
|
4092
|
-
}
|
|
4093
4062
|
declare enum PostFieldField {
|
|
4094
4063
|
UNKNOWN = "UNKNOWN",
|
|
4095
4064
|
/**
|
|
@@ -4171,127 +4140,6 @@ declare enum PostFieldField {
|
|
|
4171
4140
|
}
|
|
4172
4141
|
/** @enumType */
|
|
4173
4142
|
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
4174
|
-
interface ListDemoPostsResponse {
|
|
4175
|
-
/** List of posts. */
|
|
4176
|
-
posts?: Post[];
|
|
4177
|
-
/** Details on the paged set of results returned. */
|
|
4178
|
-
metaData?: MetaData;
|
|
4179
|
-
}
|
|
4180
|
-
interface MetaData {
|
|
4181
|
-
/** Number of items returned in this response. */
|
|
4182
|
-
count?: number;
|
|
4183
|
-
/** Requested offset. */
|
|
4184
|
-
offset?: number;
|
|
4185
|
-
/** Total number of items that match the query. */
|
|
4186
|
-
total?: number;
|
|
4187
|
-
/**
|
|
4188
|
-
* Pointer to the next or previous page in the list of results.
|
|
4189
|
-
* @maxLength 2000
|
|
4190
|
-
*/
|
|
4191
|
-
cursor?: string | null;
|
|
4192
|
-
}
|
|
4193
|
-
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
4194
|
-
/**
|
|
4195
|
-
* Member ID of person who triggered the counter update
|
|
4196
|
-
* @format GUID
|
|
4197
|
-
*/
|
|
4198
|
-
memberId?: string | null;
|
|
4199
|
-
/**
|
|
4200
|
-
* Visitor ID if person that liked the post is not logged in
|
|
4201
|
-
* @format GUID
|
|
4202
|
-
*/
|
|
4203
|
-
anonymousVisitorId?: string | null;
|
|
4204
|
-
/**
|
|
4205
|
-
* ID of the post which counters were updated.
|
|
4206
|
-
* @format GUID
|
|
4207
|
-
*/
|
|
4208
|
-
postId?: string;
|
|
4209
|
-
/**
|
|
4210
|
-
* Internal ID of the post which counters were updated.
|
|
4211
|
-
* @internal
|
|
4212
|
-
* @maxLength 24
|
|
4213
|
-
*/
|
|
4214
|
-
postInternalId?: string;
|
|
4215
|
-
/** Field of the updated counter. */
|
|
4216
|
-
updatedCounterField?: FieldWithLiterals;
|
|
4217
|
-
/** New counter value. */
|
|
4218
|
-
counter?: number;
|
|
4219
|
-
}
|
|
4220
|
-
/** @oneof */
|
|
4221
|
-
interface PostCountersUpdatedInitiatorOneOf {
|
|
4222
|
-
/**
|
|
4223
|
-
* Member ID of person who triggered the counter update
|
|
4224
|
-
* @format GUID
|
|
4225
|
-
*/
|
|
4226
|
-
memberId?: string | null;
|
|
4227
|
-
/**
|
|
4228
|
-
* Visitor ID if person that liked the post is not logged in
|
|
4229
|
-
* @format GUID
|
|
4230
|
-
*/
|
|
4231
|
-
anonymousVisitorId?: string | null;
|
|
4232
|
-
}
|
|
4233
|
-
declare enum Field {
|
|
4234
|
-
/** Undefined field. */
|
|
4235
|
-
UNKNOWN = "UNKNOWN",
|
|
4236
|
-
/** Total comments field. */
|
|
4237
|
-
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
|
4238
|
-
/** Like count field. */
|
|
4239
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
4240
|
-
/** View count field. */
|
|
4241
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
4242
|
-
/** Rating count field. */
|
|
4243
|
-
RATING_COUNT = "RATING_COUNT"
|
|
4244
|
-
}
|
|
4245
|
-
/** @enumType */
|
|
4246
|
-
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
|
4247
|
-
interface PostOwnerChanged {
|
|
4248
|
-
/**
|
|
4249
|
-
* Member ID of the post's owner before the change.
|
|
4250
|
-
* @internal
|
|
4251
|
-
* @format GUID
|
|
4252
|
-
*/
|
|
4253
|
-
oldMemberId?: string;
|
|
4254
|
-
/**
|
|
4255
|
-
* Member ID of the post's owner after the change.
|
|
4256
|
-
* @internal
|
|
4257
|
-
* @format GUID
|
|
4258
|
-
*/
|
|
4259
|
-
newMemberId?: string;
|
|
4260
|
-
}
|
|
4261
|
-
interface InitialPostsCopied {
|
|
4262
|
-
/** Number of posts copied. */
|
|
4263
|
-
count?: number;
|
|
4264
|
-
}
|
|
4265
|
-
interface GetPostRequest {
|
|
4266
|
-
/**
|
|
4267
|
-
* Post ID.
|
|
4268
|
-
* @minLength 1
|
|
4269
|
-
* @maxLength 38
|
|
4270
|
-
*/
|
|
4271
|
-
postId: string;
|
|
4272
|
-
/**
|
|
4273
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
4274
|
-
* This parameter will be removed on June 30, 2023.
|
|
4275
|
-
*
|
|
4276
|
-
* List of post fields to be included in the response.
|
|
4277
|
-
* @internal
|
|
4278
|
-
* @maxSize 20
|
|
4279
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4280
|
-
* This parameter will be removed on June 30, 2023.
|
|
4281
|
-
*
|
|
4282
|
-
* List of post fields to be included in the response.
|
|
4283
|
-
* @replacedBy fieldsets
|
|
4284
|
-
* @targetRemovalDate 2024-06-30
|
|
4285
|
-
*/
|
|
4286
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4287
|
-
/**
|
|
4288
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4289
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4290
|
-
* only the post’s base fields are returned.
|
|
4291
|
-
* @maxSize 20
|
|
4292
|
-
*/
|
|
4293
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4294
|
-
}
|
|
4295
4143
|
interface GetPostResponse {
|
|
4296
4144
|
/** Retrieved post info. */
|
|
4297
4145
|
post?: Post;
|
|
@@ -4414,12 +4262,71 @@ interface ListPostsRequest {
|
|
|
4414
4262
|
*/
|
|
4415
4263
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4416
4264
|
}
|
|
4265
|
+
declare enum GetPostsSort {
|
|
4266
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
4267
|
+
FEED = "FEED",
|
|
4268
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
4269
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
4270
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
4271
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
4272
|
+
/** Ordered by total number of views in descending order. */
|
|
4273
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
4274
|
+
/** Ordered by total number of likes in descending order. */
|
|
4275
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
4276
|
+
/** Ordered by `title` in ascending order. */
|
|
4277
|
+
TITLE_ASC = "TITLE_ASC",
|
|
4278
|
+
/** Ordered by `title` in descending order. */
|
|
4279
|
+
TITLE_DESC = "TITLE_DESC",
|
|
4280
|
+
/**
|
|
4281
|
+
* Sorting by post rating descending.
|
|
4282
|
+
* @internal
|
|
4283
|
+
*/
|
|
4284
|
+
RATING = "RATING"
|
|
4285
|
+
}
|
|
4286
|
+
/** @enumType */
|
|
4287
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
4288
|
+
interface BlogPaging {
|
|
4289
|
+
/**
|
|
4290
|
+
* Number of items to skip in the current sort order.
|
|
4291
|
+
*
|
|
4292
|
+
*
|
|
4293
|
+
* Default: `0`
|
|
4294
|
+
*/
|
|
4295
|
+
offset?: number;
|
|
4296
|
+
/**
|
|
4297
|
+
* Number of items to return.
|
|
4298
|
+
*
|
|
4299
|
+
*
|
|
4300
|
+
* Default:`50`
|
|
4301
|
+
* @min 1
|
|
4302
|
+
* @max 100
|
|
4303
|
+
*/
|
|
4304
|
+
limit?: number;
|
|
4305
|
+
/**
|
|
4306
|
+
* Pointer to the next or previous page in the list of results.
|
|
4307
|
+
* @maxLength 2000
|
|
4308
|
+
*/
|
|
4309
|
+
cursor?: string | null;
|
|
4310
|
+
}
|
|
4417
4311
|
interface ListPostsResponse {
|
|
4418
4312
|
/** List of retrieved posts. */
|
|
4419
4313
|
posts?: Post[];
|
|
4420
4314
|
/** Details on the paged set of results returned. */
|
|
4421
4315
|
metaData?: MetaData;
|
|
4422
4316
|
}
|
|
4317
|
+
interface MetaData {
|
|
4318
|
+
/** Number of items returned in this response. */
|
|
4319
|
+
count?: number;
|
|
4320
|
+
/** Requested offset. */
|
|
4321
|
+
offset?: number;
|
|
4322
|
+
/** Total number of items that match the query. */
|
|
4323
|
+
total?: number;
|
|
4324
|
+
/**
|
|
4325
|
+
* Pointer to the next or previous page in the list of results.
|
|
4326
|
+
* @maxLength 2000
|
|
4327
|
+
*/
|
|
4328
|
+
cursor?: string | null;
|
|
4329
|
+
}
|
|
4423
4330
|
interface QueryPostsRequest {
|
|
4424
4331
|
/**
|
|
4425
4332
|
* __Deprecated.__ Use `query` instead.
|
|
@@ -4656,7 +4563,7 @@ interface ViewPostRequest {
|
|
|
4656
4563
|
postId: string;
|
|
4657
4564
|
}
|
|
4658
4565
|
interface ViewPostResponse {
|
|
4659
|
-
/**
|
|
4566
|
+
/** Updated total number of views for the post. */
|
|
4660
4567
|
views?: number;
|
|
4661
4568
|
}
|
|
4662
4569
|
interface LikePostRequest {
|
|
@@ -4871,6 +4778,99 @@ interface PostCount {
|
|
|
4871
4778
|
/** Number of posts. */
|
|
4872
4779
|
postCount?: number;
|
|
4873
4780
|
}
|
|
4781
|
+
interface ListDemoPostsRequest {
|
|
4782
|
+
/**
|
|
4783
|
+
* Whether to return only featured posts.
|
|
4784
|
+
*
|
|
4785
|
+
* Default: `false`
|
|
4786
|
+
*/
|
|
4787
|
+
featured?: boolean;
|
|
4788
|
+
/**
|
|
4789
|
+
* Hashtag filter.
|
|
4790
|
+
*
|
|
4791
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4792
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
4793
|
+
* @maxSize 100
|
|
4794
|
+
* @maxLength 100
|
|
4795
|
+
*/
|
|
4796
|
+
hashtags?: string[];
|
|
4797
|
+
/**
|
|
4798
|
+
* Category filter.
|
|
4799
|
+
*
|
|
4800
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4801
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
4802
|
+
* @maxSize 50
|
|
4803
|
+
* @format GUID
|
|
4804
|
+
*/
|
|
4805
|
+
categoryIds?: string[];
|
|
4806
|
+
/**
|
|
4807
|
+
* Tag filter.
|
|
4808
|
+
*
|
|
4809
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4810
|
+
* If omitted, all posts with or without tags are returned.
|
|
4811
|
+
* @maxSize 50
|
|
4812
|
+
* @format GUID
|
|
4813
|
+
*/
|
|
4814
|
+
tagIds?: string[];
|
|
4815
|
+
/**
|
|
4816
|
+
* Sorting options.
|
|
4817
|
+
*
|
|
4818
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4819
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4820
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4821
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4822
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4823
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4824
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4825
|
+
* - `RATING`: reserved for internal use.
|
|
4826
|
+
*
|
|
4827
|
+
* Default: `FEED`
|
|
4828
|
+
*/
|
|
4829
|
+
sort?: GetPostsSortWithLiterals;
|
|
4830
|
+
/** Pagination options. */
|
|
4831
|
+
paging?: BlogPaging;
|
|
4832
|
+
/**
|
|
4833
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
4834
|
+
* This parameter will be removed on June 30, 2023.
|
|
4835
|
+
*
|
|
4836
|
+
* List of post fields to be included in the response.
|
|
4837
|
+
* @maxSize 20
|
|
4838
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4839
|
+
* This parameter will be removed on June 30, 2023.
|
|
4840
|
+
*
|
|
4841
|
+
* List of post fields to be included in the response.
|
|
4842
|
+
* @replacedBy fieldsets
|
|
4843
|
+
* @targetRemovalDate 2024-06-30
|
|
4844
|
+
*/
|
|
4845
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4846
|
+
/**
|
|
4847
|
+
* Language filter.
|
|
4848
|
+
*
|
|
4849
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4850
|
+
* Pass a language to only receive posts that are in that language.
|
|
4851
|
+
* If omitted, posts in all languages are returned.
|
|
4852
|
+
* @format LANGUAGE_TAG
|
|
4853
|
+
*/
|
|
4854
|
+
language?: string | null;
|
|
4855
|
+
/**
|
|
4856
|
+
* Post owner's member ID.
|
|
4857
|
+
* @format GUID
|
|
4858
|
+
*/
|
|
4859
|
+
memberId?: string | null;
|
|
4860
|
+
/**
|
|
4861
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4862
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4863
|
+
* only the post’s base fields are returned.
|
|
4864
|
+
* @maxSize 20
|
|
4865
|
+
*/
|
|
4866
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4867
|
+
}
|
|
4868
|
+
interface ListDemoPostsResponse {
|
|
4869
|
+
/** List of posts. */
|
|
4870
|
+
posts?: Post[];
|
|
4871
|
+
/** Details on the paged set of results returned. */
|
|
4872
|
+
metaData?: MetaData;
|
|
4873
|
+
}
|
|
4874
4874
|
|
|
4875
4875
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4876
4876
|
getUrl: (context: any) => string;
|
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions,
|
|
3
|
-
export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest,
|
|
2
|
+
import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, GetPostMetricsResponse, ViewPostResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope, PostQuery, QueryPostsOptions, typedQueryPosts, PostsQueryBuilder } from './index.typings.mjs';
|
|
3
|
+
export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest, GetPostsSort, GetPostsSortWithLiterals, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListItemNodeData, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, Order, OrderWithLiterals, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlacementWithLiterals, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, Post, PostCategoriesUpdated, PostCount, PostCountInfo, PostCountPerMonth, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostQuerySpec, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, PricingData, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsRequestOrderWithLiterals, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RestoreInfo, RibbonStyles, RichContent, Scaling, ScalingWithLiterals, ScheduledPostPublished, SectionDivider, SeoSchema, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia, utils } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
|
|
6
6
|
interface QueryPostCountStatsSignature {
|
|
7
7
|
/**
|
|
8
8
|
* Retrieves the number of published posts per month within a specified time range.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
* The
|
|
12
|
-
*
|
|
13
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
*
|
|
11
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
12
|
+
*
|
|
13
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
14
|
+
*
|
|
15
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
16
|
+
* @param - Options specifying time frame, sort, and filter.
|
|
16
17
|
* @returns Get Blog Post Count Stats response
|
|
17
18
|
*/
|
|
18
19
|
(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 2>>;
|
|
@@ -21,6 +22,7 @@ declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature
|
|
|
21
22
|
interface GetTotalPostsSignature {
|
|
22
23
|
/**
|
|
23
24
|
* Retrieves the total amount of published posts of the blog.
|
|
25
|
+
* @param - Language Options.
|
|
24
26
|
*/
|
|
25
27
|
(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 0>>;
|
|
26
28
|
}
|
|
@@ -29,9 +31,9 @@ interface GetPostSignature {
|
|
|
29
31
|
/**
|
|
30
32
|
* Retrieves a post by the specified ID.
|
|
31
33
|
* @param - Post ID.
|
|
32
|
-
* @
|
|
34
|
+
* @param - Options specifying which fields to return.
|
|
33
35
|
*/
|
|
34
|
-
(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
36
|
+
(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 5>>;
|
|
35
37
|
}
|
|
36
38
|
declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
|
|
37
39
|
interface GetPostBySlugSignature {
|
|
@@ -43,6 +45,7 @@ interface GetPostBySlugSignature {
|
|
|
43
45
|
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
|
44
46
|
* unless specified otherwise.
|
|
45
47
|
* @param - Slug of the post to retrieve.
|
|
48
|
+
* @param - Options specifying which fields to return.
|
|
46
49
|
*/
|
|
47
50
|
(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 5>>;
|
|
48
51
|
}
|
|
@@ -55,6 +58,7 @@ interface ListPostsSignature {
|
|
|
55
58
|
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
56
59
|
* - `paging.limit` is `50`.
|
|
57
60
|
* - `paging.offset` is `0`.
|
|
61
|
+
* @param - Sort, filter, and paging options.
|
|
58
62
|
*/
|
|
59
63
|
(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges` | `metaData.count` | `metaData.offset` | `metaData.total`, 4>>;
|
|
60
64
|
}
|
|
@@ -73,7 +77,9 @@ interface ViewPostSignature {
|
|
|
73
77
|
/**
|
|
74
78
|
* Increments a post's view count.
|
|
75
79
|
*
|
|
76
|
-
* Call this method when a site visitor views a published post. The response returns the post's updated total number of views.
|
|
80
|
+
* Call this method when a site visitor views a published post. The post must already be published. The response returns the post's updated total number of views.
|
|
81
|
+
*
|
|
82
|
+
* This method accepts up to 100 calls per minute from an IP address on the site, and up to 100 calls per minute from an IP address for a single post. Further calls are rejected.
|
|
77
83
|
* @param - Post ID.
|
|
78
84
|
*/
|
|
79
85
|
(postId: string): Promise<NonNullablePaths<ViewPostResponse, `views`, 0>>;
|
|
@@ -113,4 +119,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
|
|
|
113
119
|
*/
|
|
114
120
|
declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
|
|
115
121
|
|
|
116
|
-
export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse,
|
|
122
|
+
export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostQuery, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, ViewPostResponse, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, viewPost };
|