@wix/auto_sdk_blog_posts 1.0.182 → 1.0.184
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +11 -15
- package/build/cjs/index.js +30 -35
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +183 -195
- package/build/cjs/index.typings.js +25 -25
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +166 -166
- package/build/cjs/meta.js +19 -19
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +11 -15
- package/build/es/index.mjs +30 -35
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +183 -195
- package/build/es/index.typings.mjs +25 -25
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +166 -166
- package/build/es/meta.mjs +19 -19
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -15
- package/build/internal/cjs/index.typings.d.ts +237 -249
- package/build/internal/cjs/meta.d.ts +220 -220
- package/build/internal/es/index.d.mts +11 -15
- package/build/internal/es/index.typings.d.mts +237 -249
- package/build/internal/es/meta.d.mts +220 -220
- package/package.json +2 -2
|
@@ -3725,91 +3725,62 @@ interface GetTotalPostsResponse {
|
|
|
3725
3725
|
/** Total amount of published posts. */
|
|
3726
3726
|
total?: number;
|
|
3727
3727
|
}
|
|
3728
|
-
interface
|
|
3729
|
-
/**
|
|
3730
|
-
* Member ID of person who triggered the counter update
|
|
3731
|
-
* @format GUID
|
|
3732
|
-
*/
|
|
3733
|
-
memberId?: string | null;
|
|
3734
|
-
/**
|
|
3735
|
-
* Visitor ID if person that liked the post is not logged in
|
|
3736
|
-
* @format GUID
|
|
3737
|
-
*/
|
|
3738
|
-
anonymousVisitorId?: string | null;
|
|
3739
|
-
/**
|
|
3740
|
-
* ID of the post which counters were updated.
|
|
3741
|
-
* @format GUID
|
|
3742
|
-
*/
|
|
3743
|
-
postId?: string;
|
|
3744
|
-
/**
|
|
3745
|
-
* Internal ID of the post which counters were updated.
|
|
3746
|
-
* @internal
|
|
3747
|
-
* @maxLength 24
|
|
3748
|
-
*/
|
|
3749
|
-
postInternalId?: string;
|
|
3750
|
-
/** Field of the updated counter. */
|
|
3751
|
-
updatedCounterField?: FieldWithLiterals;
|
|
3752
|
-
/** New counter value. */
|
|
3753
|
-
counter?: number;
|
|
3754
|
-
}
|
|
3755
|
-
/** @oneof */
|
|
3756
|
-
interface PostCountersUpdatedInitiatorOneOf {
|
|
3728
|
+
interface ListDemoPostsRequest {
|
|
3757
3729
|
/**
|
|
3758
|
-
*
|
|
3759
|
-
*
|
|
3730
|
+
* Whether to return only featured posts.
|
|
3731
|
+
*
|
|
3732
|
+
* Default: `false`
|
|
3760
3733
|
*/
|
|
3761
|
-
|
|
3734
|
+
featured?: boolean;
|
|
3762
3735
|
/**
|
|
3763
|
-
*
|
|
3764
|
-
*
|
|
3736
|
+
* Hashtag filter.
|
|
3737
|
+
*
|
|
3738
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3739
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3740
|
+
* @maxSize 100
|
|
3741
|
+
* @maxLength 100
|
|
3765
3742
|
*/
|
|
3766
|
-
|
|
3767
|
-
}
|
|
3768
|
-
declare enum Field {
|
|
3769
|
-
/** Undefined field. */
|
|
3770
|
-
UNKNOWN = "UNKNOWN",
|
|
3771
|
-
/** Total comments field. */
|
|
3772
|
-
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
|
3773
|
-
/** Like count field. */
|
|
3774
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3775
|
-
/** View count field. */
|
|
3776
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3777
|
-
/** Rating count field. */
|
|
3778
|
-
RATING_COUNT = "RATING_COUNT"
|
|
3779
|
-
}
|
|
3780
|
-
/** @enumType */
|
|
3781
|
-
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
|
3782
|
-
interface PostOwnerChanged {
|
|
3743
|
+
hashtags?: string[];
|
|
3783
3744
|
/**
|
|
3784
|
-
*
|
|
3785
|
-
*
|
|
3745
|
+
* Category filter.
|
|
3746
|
+
*
|
|
3747
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3748
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3749
|
+
* @maxSize 50
|
|
3786
3750
|
* @format GUID
|
|
3787
3751
|
*/
|
|
3788
|
-
|
|
3752
|
+
categoryIds?: string[];
|
|
3789
3753
|
/**
|
|
3790
|
-
*
|
|
3791
|
-
*
|
|
3754
|
+
* Tag filter.
|
|
3755
|
+
*
|
|
3756
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3757
|
+
* If omitted, all posts with or without tags are returned.
|
|
3758
|
+
* @maxSize 50
|
|
3792
3759
|
* @format GUID
|
|
3793
3760
|
*/
|
|
3794
|
-
|
|
3795
|
-
}
|
|
3796
|
-
interface InitialPostsCopied {
|
|
3797
|
-
/** Number of posts copied. */
|
|
3798
|
-
count?: number;
|
|
3799
|
-
}
|
|
3800
|
-
interface GetPostRequest {
|
|
3761
|
+
tagIds?: string[];
|
|
3801
3762
|
/**
|
|
3802
|
-
*
|
|
3803
|
-
*
|
|
3804
|
-
*
|
|
3763
|
+
* Sorting options.
|
|
3764
|
+
*
|
|
3765
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3766
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3767
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3768
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3769
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3770
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3771
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3772
|
+
* - `RATING`: reserved for internal use.
|
|
3773
|
+
*
|
|
3774
|
+
* Default: `FEED`
|
|
3805
3775
|
*/
|
|
3806
|
-
|
|
3776
|
+
sort?: GetPostsSortWithLiterals;
|
|
3777
|
+
/** Pagination options. */
|
|
3778
|
+
paging?: BlogPaging;
|
|
3807
3779
|
/**
|
|
3808
3780
|
* __Deprecated.__ Use `fieldsets` instead.
|
|
3809
3781
|
* This parameter will be removed on June 30, 2023.
|
|
3810
3782
|
*
|
|
3811
3783
|
* List of post fields to be included in the response.
|
|
3812
|
-
* @internal
|
|
3813
3784
|
* @maxSize 20
|
|
3814
3785
|
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3815
3786
|
* This parameter will be removed on June 30, 2023.
|
|
@@ -3819,6 +3790,20 @@ interface GetPostRequest {
|
|
|
3819
3790
|
* @targetRemovalDate 2024-06-30
|
|
3820
3791
|
*/
|
|
3821
3792
|
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3793
|
+
/**
|
|
3794
|
+
* Language filter.
|
|
3795
|
+
*
|
|
3796
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3797
|
+
* Pass a language to only receive posts that are in that language.
|
|
3798
|
+
* If omitted, posts in all languages are returned.
|
|
3799
|
+
* @format LANGUAGE_TAG
|
|
3800
|
+
*/
|
|
3801
|
+
language?: string | null;
|
|
3802
|
+
/**
|
|
3803
|
+
* Post owner's member ID.
|
|
3804
|
+
* @format GUID
|
|
3805
|
+
*/
|
|
3806
|
+
memberId?: string | null;
|
|
3822
3807
|
/**
|
|
3823
3808
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3824
3809
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -3827,6 +3812,52 @@ interface GetPostRequest {
|
|
|
3827
3812
|
*/
|
|
3828
3813
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3829
3814
|
}
|
|
3815
|
+
declare enum GetPostsSort {
|
|
3816
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3817
|
+
FEED = "FEED",
|
|
3818
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3819
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3820
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3821
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3822
|
+
/** Ordered by total number of views in descending order. */
|
|
3823
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3824
|
+
/** Ordered by total number of likes in descending order. */
|
|
3825
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3826
|
+
/** Ordered by `title` in ascending order. */
|
|
3827
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3828
|
+
/** Ordered by `title` in descending order. */
|
|
3829
|
+
TITLE_DESC = "TITLE_DESC",
|
|
3830
|
+
/**
|
|
3831
|
+
* Sorting by post rating descending.
|
|
3832
|
+
* @internal
|
|
3833
|
+
*/
|
|
3834
|
+
RATING = "RATING"
|
|
3835
|
+
}
|
|
3836
|
+
/** @enumType */
|
|
3837
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3838
|
+
interface BlogPaging {
|
|
3839
|
+
/**
|
|
3840
|
+
* Number of items to skip in the current sort order.
|
|
3841
|
+
*
|
|
3842
|
+
*
|
|
3843
|
+
* Default: `0`
|
|
3844
|
+
*/
|
|
3845
|
+
offset?: number;
|
|
3846
|
+
/**
|
|
3847
|
+
* Number of items to return.
|
|
3848
|
+
*
|
|
3849
|
+
*
|
|
3850
|
+
* Default:`50`
|
|
3851
|
+
* @min 1
|
|
3852
|
+
* @max 100
|
|
3853
|
+
*/
|
|
3854
|
+
limit?: number;
|
|
3855
|
+
/**
|
|
3856
|
+
* Pointer to the next or previous page in the list of results.
|
|
3857
|
+
* @maxLength 2000
|
|
3858
|
+
*/
|
|
3859
|
+
cursor?: string | null;
|
|
3860
|
+
}
|
|
3830
3861
|
declare enum PostFieldField {
|
|
3831
3862
|
UNKNOWN = "UNKNOWN",
|
|
3832
3863
|
/**
|
|
@@ -3908,6 +3939,127 @@ declare enum PostFieldField {
|
|
|
3908
3939
|
}
|
|
3909
3940
|
/** @enumType */
|
|
3910
3941
|
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3942
|
+
interface ListDemoPostsResponse {
|
|
3943
|
+
/** List of posts. */
|
|
3944
|
+
posts?: Post[];
|
|
3945
|
+
/** Details on the paged set of results returned. */
|
|
3946
|
+
metaData?: MetaData;
|
|
3947
|
+
}
|
|
3948
|
+
interface MetaData {
|
|
3949
|
+
/** Number of items returned in this response. */
|
|
3950
|
+
count?: number;
|
|
3951
|
+
/** Requested offset. */
|
|
3952
|
+
offset?: number;
|
|
3953
|
+
/** Total number of items that match the query. */
|
|
3954
|
+
total?: number;
|
|
3955
|
+
/**
|
|
3956
|
+
* Pointer to the next or previous page in the list of results.
|
|
3957
|
+
* @maxLength 2000
|
|
3958
|
+
*/
|
|
3959
|
+
cursor?: string | null;
|
|
3960
|
+
}
|
|
3961
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3962
|
+
/**
|
|
3963
|
+
* Member ID of person who triggered the counter update
|
|
3964
|
+
* @format GUID
|
|
3965
|
+
*/
|
|
3966
|
+
memberId?: string | null;
|
|
3967
|
+
/**
|
|
3968
|
+
* Visitor ID if person that liked the post is not logged in
|
|
3969
|
+
* @format GUID
|
|
3970
|
+
*/
|
|
3971
|
+
anonymousVisitorId?: string | null;
|
|
3972
|
+
/**
|
|
3973
|
+
* ID of the post which counters were updated.
|
|
3974
|
+
* @format GUID
|
|
3975
|
+
*/
|
|
3976
|
+
postId?: string;
|
|
3977
|
+
/**
|
|
3978
|
+
* Internal ID of the post which counters were updated.
|
|
3979
|
+
* @internal
|
|
3980
|
+
* @maxLength 24
|
|
3981
|
+
*/
|
|
3982
|
+
postInternalId?: string;
|
|
3983
|
+
/** Field of the updated counter. */
|
|
3984
|
+
updatedCounterField?: FieldWithLiterals;
|
|
3985
|
+
/** New counter value. */
|
|
3986
|
+
counter?: number;
|
|
3987
|
+
}
|
|
3988
|
+
/** @oneof */
|
|
3989
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
|
3990
|
+
/**
|
|
3991
|
+
* Member ID of person who triggered the counter update
|
|
3992
|
+
* @format GUID
|
|
3993
|
+
*/
|
|
3994
|
+
memberId?: string | null;
|
|
3995
|
+
/**
|
|
3996
|
+
* Visitor ID if person that liked the post is not logged in
|
|
3997
|
+
* @format GUID
|
|
3998
|
+
*/
|
|
3999
|
+
anonymousVisitorId?: string | null;
|
|
4000
|
+
}
|
|
4001
|
+
declare enum Field {
|
|
4002
|
+
/** Undefined field. */
|
|
4003
|
+
UNKNOWN = "UNKNOWN",
|
|
4004
|
+
/** Total comments field. */
|
|
4005
|
+
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
|
4006
|
+
/** Like count field. */
|
|
4007
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
4008
|
+
/** View count field. */
|
|
4009
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
4010
|
+
/** Rating count field. */
|
|
4011
|
+
RATING_COUNT = "RATING_COUNT"
|
|
4012
|
+
}
|
|
4013
|
+
/** @enumType */
|
|
4014
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
|
4015
|
+
interface PostOwnerChanged {
|
|
4016
|
+
/**
|
|
4017
|
+
* Member ID of the post's owner before the change.
|
|
4018
|
+
* @internal
|
|
4019
|
+
* @format GUID
|
|
4020
|
+
*/
|
|
4021
|
+
oldMemberId?: string;
|
|
4022
|
+
/**
|
|
4023
|
+
* Member ID of the post's owner after the change.
|
|
4024
|
+
* @internal
|
|
4025
|
+
* @format GUID
|
|
4026
|
+
*/
|
|
4027
|
+
newMemberId?: string;
|
|
4028
|
+
}
|
|
4029
|
+
interface InitialPostsCopied {
|
|
4030
|
+
/** Number of posts copied. */
|
|
4031
|
+
count?: number;
|
|
4032
|
+
}
|
|
4033
|
+
interface GetPostRequest {
|
|
4034
|
+
/**
|
|
4035
|
+
* Post ID.
|
|
4036
|
+
* @minLength 1
|
|
4037
|
+
* @maxLength 38
|
|
4038
|
+
*/
|
|
4039
|
+
postId: string;
|
|
4040
|
+
/**
|
|
4041
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
4042
|
+
* This parameter will be removed on June 30, 2023.
|
|
4043
|
+
*
|
|
4044
|
+
* List of post fields to be included in the response.
|
|
4045
|
+
* @internal
|
|
4046
|
+
* @maxSize 20
|
|
4047
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4048
|
+
* This parameter will be removed on June 30, 2023.
|
|
4049
|
+
*
|
|
4050
|
+
* List of post fields to be included in the response.
|
|
4051
|
+
* @replacedBy fieldsets
|
|
4052
|
+
* @targetRemovalDate 2024-06-30
|
|
4053
|
+
*/
|
|
4054
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4055
|
+
/**
|
|
4056
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4057
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4058
|
+
* only the post’s base fields are returned.
|
|
4059
|
+
* @maxSize 20
|
|
4060
|
+
*/
|
|
4061
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4062
|
+
}
|
|
3911
4063
|
interface GetPostResponse {
|
|
3912
4064
|
/** Retrieved post info. */
|
|
3913
4065
|
post?: Post;
|
|
@@ -4030,71 +4182,12 @@ interface ListPostsRequest {
|
|
|
4030
4182
|
*/
|
|
4031
4183
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4032
4184
|
}
|
|
4033
|
-
declare enum GetPostsSort {
|
|
4034
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
4035
|
-
FEED = "FEED",
|
|
4036
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
4037
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
4038
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
4039
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
4040
|
-
/** Ordered by total number of views in descending order. */
|
|
4041
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
4042
|
-
/** Ordered by total number of likes in descending order. */
|
|
4043
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
4044
|
-
/** Ordered by `title` in ascending order. */
|
|
4045
|
-
TITLE_ASC = "TITLE_ASC",
|
|
4046
|
-
/** Ordered by `title` in descending order. */
|
|
4047
|
-
TITLE_DESC = "TITLE_DESC",
|
|
4048
|
-
/**
|
|
4049
|
-
* Sorting by post rating descending.
|
|
4050
|
-
* @internal
|
|
4051
|
-
*/
|
|
4052
|
-
RATING = "RATING"
|
|
4053
|
-
}
|
|
4054
|
-
/** @enumType */
|
|
4055
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
4056
|
-
interface BlogPaging {
|
|
4057
|
-
/**
|
|
4058
|
-
* Number of items to skip in the current sort order.
|
|
4059
|
-
*
|
|
4060
|
-
*
|
|
4061
|
-
* Default: `0`
|
|
4062
|
-
*/
|
|
4063
|
-
offset?: number;
|
|
4064
|
-
/**
|
|
4065
|
-
* Number of items to return.
|
|
4066
|
-
*
|
|
4067
|
-
*
|
|
4068
|
-
* Default:`50`
|
|
4069
|
-
* @min 1
|
|
4070
|
-
* @max 100
|
|
4071
|
-
*/
|
|
4072
|
-
limit?: number;
|
|
4073
|
-
/**
|
|
4074
|
-
* Pointer to the next or previous page in the list of results.
|
|
4075
|
-
* @maxLength 2000
|
|
4076
|
-
*/
|
|
4077
|
-
cursor?: string | null;
|
|
4078
|
-
}
|
|
4079
4185
|
interface ListPostsResponse {
|
|
4080
4186
|
/** List of retrieved posts. */
|
|
4081
4187
|
posts?: Post[];
|
|
4082
4188
|
/** Details on the paged set of results returned. */
|
|
4083
4189
|
metaData?: MetaData;
|
|
4084
4190
|
}
|
|
4085
|
-
interface MetaData {
|
|
4086
|
-
/** Number of items returned in this response. */
|
|
4087
|
-
count?: number;
|
|
4088
|
-
/** Requested offset. */
|
|
4089
|
-
offset?: number;
|
|
4090
|
-
/** Total number of items that match the query. */
|
|
4091
|
-
total?: number;
|
|
4092
|
-
/**
|
|
4093
|
-
* Pointer to the next or previous page in the list of results.
|
|
4094
|
-
* @maxLength 2000
|
|
4095
|
-
*/
|
|
4096
|
-
cursor?: string | null;
|
|
4097
|
-
}
|
|
4098
4191
|
interface QueryPostsRequest {
|
|
4099
4192
|
/**
|
|
4100
4193
|
* __Deprecated.__ Use `query` instead.
|
|
@@ -4546,99 +4639,6 @@ interface PostCount {
|
|
|
4546
4639
|
/** Number of posts. */
|
|
4547
4640
|
postCount?: number;
|
|
4548
4641
|
}
|
|
4549
|
-
interface ListDemoPostsRequest {
|
|
4550
|
-
/**
|
|
4551
|
-
* Whether to return only featured posts.
|
|
4552
|
-
*
|
|
4553
|
-
* Default: `false`
|
|
4554
|
-
*/
|
|
4555
|
-
featured?: boolean;
|
|
4556
|
-
/**
|
|
4557
|
-
* Hashtag filter.
|
|
4558
|
-
*
|
|
4559
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4560
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
4561
|
-
* @maxSize 100
|
|
4562
|
-
* @maxLength 100
|
|
4563
|
-
*/
|
|
4564
|
-
hashtags?: string[];
|
|
4565
|
-
/**
|
|
4566
|
-
* Category filter.
|
|
4567
|
-
*
|
|
4568
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4569
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
4570
|
-
* @maxSize 50
|
|
4571
|
-
* @format GUID
|
|
4572
|
-
*/
|
|
4573
|
-
categoryIds?: string[];
|
|
4574
|
-
/**
|
|
4575
|
-
* Tag filter.
|
|
4576
|
-
*
|
|
4577
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4578
|
-
* If omitted, all posts with or without tags are returned.
|
|
4579
|
-
* @maxSize 50
|
|
4580
|
-
* @format GUID
|
|
4581
|
-
*/
|
|
4582
|
-
tagIds?: string[];
|
|
4583
|
-
/**
|
|
4584
|
-
* Sorting options.
|
|
4585
|
-
*
|
|
4586
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4587
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4588
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4589
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4590
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4591
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4592
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4593
|
-
* - `RATING`: reserved for internal use.
|
|
4594
|
-
*
|
|
4595
|
-
* Default: `FEED`
|
|
4596
|
-
*/
|
|
4597
|
-
sort?: GetPostsSortWithLiterals;
|
|
4598
|
-
/** Pagination options. */
|
|
4599
|
-
paging?: BlogPaging;
|
|
4600
|
-
/**
|
|
4601
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
4602
|
-
* This parameter will be removed on June 30, 2023.
|
|
4603
|
-
*
|
|
4604
|
-
* List of post fields to be included in the response.
|
|
4605
|
-
* @maxSize 20
|
|
4606
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4607
|
-
* This parameter will be removed on June 30, 2023.
|
|
4608
|
-
*
|
|
4609
|
-
* List of post fields to be included in the response.
|
|
4610
|
-
* @replacedBy fieldsets
|
|
4611
|
-
* @targetRemovalDate 2024-06-30
|
|
4612
|
-
*/
|
|
4613
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4614
|
-
/**
|
|
4615
|
-
* Language filter.
|
|
4616
|
-
*
|
|
4617
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4618
|
-
* Pass a language to only receive posts that are in that language.
|
|
4619
|
-
* If omitted, posts in all languages are returned.
|
|
4620
|
-
* @format LANGUAGE_TAG
|
|
4621
|
-
*/
|
|
4622
|
-
language?: string | null;
|
|
4623
|
-
/**
|
|
4624
|
-
* Post owner's member ID.
|
|
4625
|
-
* @format GUID
|
|
4626
|
-
*/
|
|
4627
|
-
memberId?: string | null;
|
|
4628
|
-
/**
|
|
4629
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4630
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4631
|
-
* only the post’s base fields are returned.
|
|
4632
|
-
* @maxSize 20
|
|
4633
|
-
*/
|
|
4634
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4635
|
-
}
|
|
4636
|
-
interface ListDemoPostsResponse {
|
|
4637
|
-
/** List of posts. */
|
|
4638
|
-
posts?: Post[];
|
|
4639
|
-
/** Details on the paged set of results returned. */
|
|
4640
|
-
metaData?: MetaData;
|
|
4641
|
-
}
|
|
4642
4642
|
interface BaseEventMetadata {
|
|
4643
4643
|
/**
|
|
4644
4644
|
* App instance ID.
|
|
@@ -4786,14 +4786,13 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
4786
4786
|
/**
|
|
4787
4787
|
* Retrieves the number of published posts per month within a specified time range.
|
|
4788
4788
|
*
|
|
4789
|
-
*
|
|
4790
|
-
* The
|
|
4791
|
-
*
|
|
4792
|
-
*
|
|
4793
|
-
*
|
|
4794
|
-
*
|
|
4789
|
+
* The time range is set using the `rangeStart` and `months` properties.
|
|
4790
|
+
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
|
4791
|
+
* includes the number of `months` following `rangeStart`.
|
|
4792
|
+
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
4793
|
+
* the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
|
|
4794
|
+
* > Note: If there are no published posts in a month within the time range, 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.
|
|
4795
4795
|
* @public
|
|
4796
|
-
* @param options - Options specifying time frame, sort, and filter.
|
|
4797
4796
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4798
4797
|
* @applicableIdentity APP
|
|
4799
4798
|
* @returns Get Blog Post Count Stats response
|
|
@@ -4834,7 +4833,6 @@ interface QueryPostCountStatsOptions {
|
|
|
4834
4833
|
/**
|
|
4835
4834
|
* Retrieves the total amount of published posts of the blog.
|
|
4836
4835
|
* @public
|
|
4837
|
-
* @param options - Language Options.
|
|
4838
4836
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4839
4837
|
* @applicableIdentity APP
|
|
4840
4838
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -4855,12 +4853,12 @@ interface GetTotalPostsOptions {
|
|
|
4855
4853
|
* @param postId - Post ID.
|
|
4856
4854
|
* @public
|
|
4857
4855
|
* @requiredField postId
|
|
4858
|
-
* @param options - Options specifying which fields to return.
|
|
4859
4856
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4860
4857
|
* @applicableIdentity APP
|
|
4858
|
+
* @returns Retrieved post info.
|
|
4861
4859
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4862
4860
|
*/
|
|
4863
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4861
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
|
|
4864
4862
|
interface GetPostOptions {
|
|
4865
4863
|
/**
|
|
4866
4864
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4880,7 +4878,6 @@ interface GetPostOptions {
|
|
|
4880
4878
|
* @param slug - Slug of the post to retrieve.
|
|
4881
4879
|
* @public
|
|
4882
4880
|
* @requiredField slug
|
|
4883
|
-
* @param options - Options specifying which fields to return.
|
|
4884
4881
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4885
4882
|
* @applicableIdentity APP
|
|
4886
4883
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -4908,7 +4905,6 @@ interface GetPostBySlugOptions {
|
|
|
4908
4905
|
* - `paging.limit` is `50`.
|
|
4909
4906
|
* - `paging.offset` is `0`.
|
|
4910
4907
|
* @public
|
|
4911
|
-
* @param options - Sort, filter, and paging options.
|
|
4912
4908
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4913
4909
|
* @applicableIdentity APP
|
|
4914
4910
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4979,26 +4975,18 @@ interface ListPostsOptions {
|
|
|
4979
4975
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4980
4976
|
}
|
|
4981
4977
|
/**
|
|
4982
|
-
*
|
|
4983
|
-
*
|
|
4984
|
-
*
|
|
4985
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4978
|
+
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
|
4986
4979
|
*
|
|
4987
|
-
*
|
|
4988
|
-
*
|
|
4989
|
-
*
|
|
4990
|
-
*
|
|
4991
|
-
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4992
|
-
* + `limit(50)`
|
|
4993
|
-
* + `descending('firstPublishedDate')`
|
|
4994
|
-
*
|
|
4995
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4996
|
-
*
|
|
4997
|
-
* To learn how to query posts, refer to the table below.
|
|
4980
|
+
* Query Posts runs with these defaults, which you can override:
|
|
4981
|
+
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4982
|
+
* - `paging.limit` is `50`.
|
|
4983
|
+
* - `paging.offset` is `0`.
|
|
4998
4984
|
*
|
|
4999
|
-
*
|
|
4985
|
+
* To learn about working with _Query_ endpoints, see
|
|
4986
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
4987
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
|
4988
|
+
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
5000
4989
|
* @public
|
|
5001
|
-
* @param options - Options specifying which fields to return.
|
|
5002
4990
|
* @permissionId BLOG.READ-PUBLICATION
|
|
5003
4991
|
* @applicableIdentity APP
|
|
5004
4992
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|