@wix/auto_sdk_blog_posts 1.0.170 → 1.0.171
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 +19 -19
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +175 -167
- package/build/cjs/index.typings.js +19 -19
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +175 -167
- package/build/cjs/meta.js +19 -19
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +2 -2
- package/build/cjs/schemas.js +4 -4
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.mjs +19 -19
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +175 -167
- package/build/es/index.typings.mjs +19 -19
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +175 -167
- package/build/es/meta.mjs +19 -19
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +2 -2
- package/build/es/schemas.mjs +4 -4
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.js +19 -19
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +229 -221
- package/build/internal/cjs/index.typings.js +19 -19
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +229 -221
- package/build/internal/cjs/meta.js +19 -19
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +2 -2
- package/build/internal/cjs/schemas.js +4 -4
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.mjs +19 -19
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +229 -221
- package/build/internal/es/index.typings.mjs +19 -19
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +229 -221
- package/build/internal/es/meta.mjs +19 -19
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +2 -2
- package/build/internal/es/schemas.mjs +4 -4
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -382,7 +382,15 @@ interface Tag {
|
|
|
382
382
|
meta?: Record<string, any> | null;
|
|
383
383
|
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
384
384
|
children?: string;
|
|
385
|
-
/**
|
|
385
|
+
/**
|
|
386
|
+
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
|
|
387
|
+
*
|
|
388
|
+
* Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
|
|
389
|
+
* only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
|
|
390
|
+
* or Wix Studio pages, so custom tags saved on those pages are missing from the response entirely. For
|
|
391
|
+
* those pages `false` therefore does not mean "not a custom tag" — it means this API could not tell.
|
|
392
|
+
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
393
|
+
*/
|
|
386
394
|
custom?: boolean;
|
|
387
395
|
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
|
|
388
396
|
disabled?: boolean;
|
|
@@ -3740,91 +3748,62 @@ interface GetTotalPostsResponse {
|
|
|
3740
3748
|
/** Total amount of published posts. */
|
|
3741
3749
|
total?: number;
|
|
3742
3750
|
}
|
|
3743
|
-
interface
|
|
3744
|
-
/**
|
|
3745
|
-
* Member ID of person who triggered the counter update
|
|
3746
|
-
* @format GUID
|
|
3747
|
-
*/
|
|
3748
|
-
memberId?: string | null;
|
|
3749
|
-
/**
|
|
3750
|
-
* Visitor ID if person that liked the post is not logged in
|
|
3751
|
-
* @format GUID
|
|
3752
|
-
*/
|
|
3753
|
-
anonymousVisitorId?: string | null;
|
|
3754
|
-
/**
|
|
3755
|
-
* ID of the post which counters were updated.
|
|
3756
|
-
* @format GUID
|
|
3757
|
-
*/
|
|
3758
|
-
postId?: string;
|
|
3759
|
-
/**
|
|
3760
|
-
* Internal ID of the post which counters were updated.
|
|
3761
|
-
* @internal
|
|
3762
|
-
* @maxLength 24
|
|
3763
|
-
*/
|
|
3764
|
-
postInternalId?: string;
|
|
3765
|
-
/** Field of the updated counter. */
|
|
3766
|
-
updatedCounterField?: FieldWithLiterals;
|
|
3767
|
-
/** New counter value. */
|
|
3768
|
-
counter?: number;
|
|
3769
|
-
}
|
|
3770
|
-
/** @oneof */
|
|
3771
|
-
interface PostCountersUpdatedInitiatorOneOf {
|
|
3751
|
+
interface ListDemoPostsRequest {
|
|
3772
3752
|
/**
|
|
3773
|
-
*
|
|
3774
|
-
*
|
|
3753
|
+
* Whether to return only featured posts.
|
|
3754
|
+
*
|
|
3755
|
+
* Default: `false`
|
|
3775
3756
|
*/
|
|
3776
|
-
|
|
3757
|
+
featured?: boolean;
|
|
3777
3758
|
/**
|
|
3778
|
-
*
|
|
3779
|
-
*
|
|
3759
|
+
* Hashtag filter.
|
|
3760
|
+
*
|
|
3761
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3762
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3763
|
+
* @maxSize 100
|
|
3764
|
+
* @maxLength 100
|
|
3780
3765
|
*/
|
|
3781
|
-
|
|
3782
|
-
}
|
|
3783
|
-
declare enum Field {
|
|
3784
|
-
/** Undefined field. */
|
|
3785
|
-
UNKNOWN = "UNKNOWN",
|
|
3786
|
-
/** Total comments field. */
|
|
3787
|
-
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
|
3788
|
-
/** Like count field. */
|
|
3789
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3790
|
-
/** View count field. */
|
|
3791
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3792
|
-
/** Rating count field. */
|
|
3793
|
-
RATING_COUNT = "RATING_COUNT"
|
|
3794
|
-
}
|
|
3795
|
-
/** @enumType */
|
|
3796
|
-
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
|
3797
|
-
interface PostOwnerChanged {
|
|
3766
|
+
hashtags?: string[];
|
|
3798
3767
|
/**
|
|
3799
|
-
*
|
|
3800
|
-
*
|
|
3768
|
+
* Category filter.
|
|
3769
|
+
*
|
|
3770
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3771
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3772
|
+
* @maxSize 50
|
|
3801
3773
|
* @format GUID
|
|
3802
3774
|
*/
|
|
3803
|
-
|
|
3775
|
+
categoryIds?: string[];
|
|
3804
3776
|
/**
|
|
3805
|
-
*
|
|
3806
|
-
*
|
|
3777
|
+
* Tag filter.
|
|
3778
|
+
*
|
|
3779
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3780
|
+
* If omitted, all posts with or without tags are returned.
|
|
3781
|
+
* @maxSize 50
|
|
3807
3782
|
* @format GUID
|
|
3808
3783
|
*/
|
|
3809
|
-
|
|
3810
|
-
}
|
|
3811
|
-
interface InitialPostsCopied {
|
|
3812
|
-
/** Number of posts copied. */
|
|
3813
|
-
count?: number;
|
|
3814
|
-
}
|
|
3815
|
-
interface GetPostRequest {
|
|
3784
|
+
tagIds?: string[];
|
|
3816
3785
|
/**
|
|
3817
|
-
*
|
|
3818
|
-
*
|
|
3819
|
-
*
|
|
3786
|
+
* Sorting options.
|
|
3787
|
+
*
|
|
3788
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3789
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3790
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3791
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3792
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3793
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3794
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3795
|
+
* - `RATING`: reserved for internal use.
|
|
3796
|
+
*
|
|
3797
|
+
* Default: `FEED`
|
|
3820
3798
|
*/
|
|
3821
|
-
|
|
3799
|
+
sort?: GetPostsSortWithLiterals;
|
|
3800
|
+
/** Pagination options. */
|
|
3801
|
+
paging?: BlogPaging;
|
|
3822
3802
|
/**
|
|
3823
3803
|
* __Deprecated.__ Use `fieldsets` instead.
|
|
3824
3804
|
* This parameter will be removed on June 30, 2023.
|
|
3825
3805
|
*
|
|
3826
3806
|
* List of post fields to be included in the response.
|
|
3827
|
-
* @internal
|
|
3828
3807
|
* @maxSize 20
|
|
3829
3808
|
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3830
3809
|
* This parameter will be removed on June 30, 2023.
|
|
@@ -3834,6 +3813,20 @@ interface GetPostRequest {
|
|
|
3834
3813
|
* @targetRemovalDate 2024-06-30
|
|
3835
3814
|
*/
|
|
3836
3815
|
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3816
|
+
/**
|
|
3817
|
+
* Language filter.
|
|
3818
|
+
*
|
|
3819
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3820
|
+
* Pass a language to only receive posts that are in that language.
|
|
3821
|
+
* If omitted, posts in all languages are returned.
|
|
3822
|
+
* @format LANGUAGE_TAG
|
|
3823
|
+
*/
|
|
3824
|
+
language?: string | null;
|
|
3825
|
+
/**
|
|
3826
|
+
* Post owner's member ID.
|
|
3827
|
+
* @format GUID
|
|
3828
|
+
*/
|
|
3829
|
+
memberId?: string | null;
|
|
3837
3830
|
/**
|
|
3838
3831
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3839
3832
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -3842,6 +3835,52 @@ interface GetPostRequest {
|
|
|
3842
3835
|
*/
|
|
3843
3836
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3844
3837
|
}
|
|
3838
|
+
declare enum GetPostsSort {
|
|
3839
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3840
|
+
FEED = "FEED",
|
|
3841
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3842
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3843
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3844
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3845
|
+
/** Ordered by total number of views in descending order. */
|
|
3846
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3847
|
+
/** Ordered by total number of likes in descending order. */
|
|
3848
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3849
|
+
/** Ordered by `title` in ascending order. */
|
|
3850
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3851
|
+
/** Ordered by `title` in descending order. */
|
|
3852
|
+
TITLE_DESC = "TITLE_DESC",
|
|
3853
|
+
/**
|
|
3854
|
+
* Sorting by post rating descending.
|
|
3855
|
+
* @internal
|
|
3856
|
+
*/
|
|
3857
|
+
RATING = "RATING"
|
|
3858
|
+
}
|
|
3859
|
+
/** @enumType */
|
|
3860
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3861
|
+
interface BlogPaging {
|
|
3862
|
+
/**
|
|
3863
|
+
* Number of items to skip in the current sort order.
|
|
3864
|
+
*
|
|
3865
|
+
*
|
|
3866
|
+
* Default: `0`
|
|
3867
|
+
*/
|
|
3868
|
+
offset?: number;
|
|
3869
|
+
/**
|
|
3870
|
+
* Number of items to return.
|
|
3871
|
+
*
|
|
3872
|
+
*
|
|
3873
|
+
* Default:`50`
|
|
3874
|
+
* @min 1
|
|
3875
|
+
* @max 100
|
|
3876
|
+
*/
|
|
3877
|
+
limit?: number;
|
|
3878
|
+
/**
|
|
3879
|
+
* Pointer to the next or previous page in the list of results.
|
|
3880
|
+
* @maxLength 2000
|
|
3881
|
+
*/
|
|
3882
|
+
cursor?: string | null;
|
|
3883
|
+
}
|
|
3845
3884
|
declare enum PostFieldField {
|
|
3846
3885
|
UNKNOWN = "UNKNOWN",
|
|
3847
3886
|
/**
|
|
@@ -3923,6 +3962,127 @@ declare enum PostFieldField {
|
|
|
3923
3962
|
}
|
|
3924
3963
|
/** @enumType */
|
|
3925
3964
|
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3965
|
+
interface ListDemoPostsResponse {
|
|
3966
|
+
/** List of posts. */
|
|
3967
|
+
posts?: Post[];
|
|
3968
|
+
/** Details on the paged set of results returned. */
|
|
3969
|
+
metaData?: MetaData;
|
|
3970
|
+
}
|
|
3971
|
+
interface MetaData {
|
|
3972
|
+
/** Number of items returned in this response. */
|
|
3973
|
+
count?: number;
|
|
3974
|
+
/** Requested offset. */
|
|
3975
|
+
offset?: number;
|
|
3976
|
+
/** Total number of items that match the query. */
|
|
3977
|
+
total?: number;
|
|
3978
|
+
/**
|
|
3979
|
+
* Pointer to the next or previous page in the list of results.
|
|
3980
|
+
* @maxLength 2000
|
|
3981
|
+
*/
|
|
3982
|
+
cursor?: string | null;
|
|
3983
|
+
}
|
|
3984
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3985
|
+
/**
|
|
3986
|
+
* Member ID of person who triggered the counter update
|
|
3987
|
+
* @format GUID
|
|
3988
|
+
*/
|
|
3989
|
+
memberId?: string | null;
|
|
3990
|
+
/**
|
|
3991
|
+
* Visitor ID if person that liked the post is not logged in
|
|
3992
|
+
* @format GUID
|
|
3993
|
+
*/
|
|
3994
|
+
anonymousVisitorId?: string | null;
|
|
3995
|
+
/**
|
|
3996
|
+
* ID of the post which counters were updated.
|
|
3997
|
+
* @format GUID
|
|
3998
|
+
*/
|
|
3999
|
+
postId?: string;
|
|
4000
|
+
/**
|
|
4001
|
+
* Internal ID of the post which counters were updated.
|
|
4002
|
+
* @internal
|
|
4003
|
+
* @maxLength 24
|
|
4004
|
+
*/
|
|
4005
|
+
postInternalId?: string;
|
|
4006
|
+
/** Field of the updated counter. */
|
|
4007
|
+
updatedCounterField?: FieldWithLiterals;
|
|
4008
|
+
/** New counter value. */
|
|
4009
|
+
counter?: number;
|
|
4010
|
+
}
|
|
4011
|
+
/** @oneof */
|
|
4012
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
|
4013
|
+
/**
|
|
4014
|
+
* Member ID of person who triggered the counter update
|
|
4015
|
+
* @format GUID
|
|
4016
|
+
*/
|
|
4017
|
+
memberId?: string | null;
|
|
4018
|
+
/**
|
|
4019
|
+
* Visitor ID if person that liked the post is not logged in
|
|
4020
|
+
* @format GUID
|
|
4021
|
+
*/
|
|
4022
|
+
anonymousVisitorId?: string | null;
|
|
4023
|
+
}
|
|
4024
|
+
declare enum Field {
|
|
4025
|
+
/** Undefined field. */
|
|
4026
|
+
UNKNOWN = "UNKNOWN",
|
|
4027
|
+
/** Total comments field. */
|
|
4028
|
+
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
|
4029
|
+
/** Like count field. */
|
|
4030
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
4031
|
+
/** View count field. */
|
|
4032
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
4033
|
+
/** Rating count field. */
|
|
4034
|
+
RATING_COUNT = "RATING_COUNT"
|
|
4035
|
+
}
|
|
4036
|
+
/** @enumType */
|
|
4037
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
|
4038
|
+
interface PostOwnerChanged {
|
|
4039
|
+
/**
|
|
4040
|
+
* Member ID of the post's owner before the change.
|
|
4041
|
+
* @internal
|
|
4042
|
+
* @format GUID
|
|
4043
|
+
*/
|
|
4044
|
+
oldMemberId?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* Member ID of the post's owner after the change.
|
|
4047
|
+
* @internal
|
|
4048
|
+
* @format GUID
|
|
4049
|
+
*/
|
|
4050
|
+
newMemberId?: string;
|
|
4051
|
+
}
|
|
4052
|
+
interface InitialPostsCopied {
|
|
4053
|
+
/** Number of posts copied. */
|
|
4054
|
+
count?: number;
|
|
4055
|
+
}
|
|
4056
|
+
interface GetPostRequest {
|
|
4057
|
+
/**
|
|
4058
|
+
* Post ID.
|
|
4059
|
+
* @minLength 1
|
|
4060
|
+
* @maxLength 38
|
|
4061
|
+
*/
|
|
4062
|
+
postId: string;
|
|
4063
|
+
/**
|
|
4064
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
4065
|
+
* This parameter will be removed on June 30, 2023.
|
|
4066
|
+
*
|
|
4067
|
+
* List of post fields to be included in the response.
|
|
4068
|
+
* @internal
|
|
4069
|
+
* @maxSize 20
|
|
4070
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4071
|
+
* This parameter will be removed on June 30, 2023.
|
|
4072
|
+
*
|
|
4073
|
+
* List of post fields to be included in the response.
|
|
4074
|
+
* @replacedBy fieldsets
|
|
4075
|
+
* @targetRemovalDate 2024-06-30
|
|
4076
|
+
*/
|
|
4077
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4078
|
+
/**
|
|
4079
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4080
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4081
|
+
* only the post’s base fields are returned.
|
|
4082
|
+
* @maxSize 20
|
|
4083
|
+
*/
|
|
4084
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4085
|
+
}
|
|
3926
4086
|
interface GetPostResponse {
|
|
3927
4087
|
/** Retrieved post info. */
|
|
3928
4088
|
post?: Post;
|
|
@@ -4045,71 +4205,12 @@ interface ListPostsRequest {
|
|
|
4045
4205
|
*/
|
|
4046
4206
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4047
4207
|
}
|
|
4048
|
-
declare enum GetPostsSort {
|
|
4049
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
4050
|
-
FEED = "FEED",
|
|
4051
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
4052
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
4053
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
4054
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
4055
|
-
/** Ordered by total number of views in descending order. */
|
|
4056
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
4057
|
-
/** Ordered by total number of likes in descending order. */
|
|
4058
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
4059
|
-
/** Ordered by `title` in ascending order. */
|
|
4060
|
-
TITLE_ASC = "TITLE_ASC",
|
|
4061
|
-
/** Ordered by `title` in descending order. */
|
|
4062
|
-
TITLE_DESC = "TITLE_DESC",
|
|
4063
|
-
/**
|
|
4064
|
-
* Sorting by post rating descending.
|
|
4065
|
-
* @internal
|
|
4066
|
-
*/
|
|
4067
|
-
RATING = "RATING"
|
|
4068
|
-
}
|
|
4069
|
-
/** @enumType */
|
|
4070
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
4071
|
-
interface BlogPaging {
|
|
4072
|
-
/**
|
|
4073
|
-
* Number of items to skip in the current sort order.
|
|
4074
|
-
*
|
|
4075
|
-
*
|
|
4076
|
-
* Default: `0`
|
|
4077
|
-
*/
|
|
4078
|
-
offset?: number;
|
|
4079
|
-
/**
|
|
4080
|
-
* Number of items to return.
|
|
4081
|
-
*
|
|
4082
|
-
*
|
|
4083
|
-
* Default:`50`
|
|
4084
|
-
* @min 1
|
|
4085
|
-
* @max 100
|
|
4086
|
-
*/
|
|
4087
|
-
limit?: number;
|
|
4088
|
-
/**
|
|
4089
|
-
* Pointer to the next or previous page in the list of results.
|
|
4090
|
-
* @maxLength 2000
|
|
4091
|
-
*/
|
|
4092
|
-
cursor?: string | null;
|
|
4093
|
-
}
|
|
4094
4208
|
interface ListPostsResponse {
|
|
4095
4209
|
/** List of retrieved posts. */
|
|
4096
4210
|
posts?: Post[];
|
|
4097
4211
|
/** Details on the paged set of results returned. */
|
|
4098
4212
|
metaData?: MetaData;
|
|
4099
4213
|
}
|
|
4100
|
-
interface MetaData {
|
|
4101
|
-
/** Number of items returned in this response. */
|
|
4102
|
-
count?: number;
|
|
4103
|
-
/** Requested offset. */
|
|
4104
|
-
offset?: number;
|
|
4105
|
-
/** Total number of items that match the query. */
|
|
4106
|
-
total?: number;
|
|
4107
|
-
/**
|
|
4108
|
-
* Pointer to the next or previous page in the list of results.
|
|
4109
|
-
* @maxLength 2000
|
|
4110
|
-
*/
|
|
4111
|
-
cursor?: string | null;
|
|
4112
|
-
}
|
|
4113
4214
|
interface QueryPostsRequest {
|
|
4114
4215
|
/**
|
|
4115
4216
|
* __Deprecated.__ Use `query` instead.
|
|
@@ -4557,99 +4658,6 @@ interface PostCount {
|
|
|
4557
4658
|
/** Number of posts. */
|
|
4558
4659
|
postCount?: number;
|
|
4559
4660
|
}
|
|
4560
|
-
interface ListDemoPostsRequest {
|
|
4561
|
-
/**
|
|
4562
|
-
* Whether to return only featured posts.
|
|
4563
|
-
*
|
|
4564
|
-
* Default: `false`
|
|
4565
|
-
*/
|
|
4566
|
-
featured?: boolean;
|
|
4567
|
-
/**
|
|
4568
|
-
* Hashtag filter.
|
|
4569
|
-
*
|
|
4570
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4571
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
4572
|
-
* @maxSize 100
|
|
4573
|
-
* @maxLength 100
|
|
4574
|
-
*/
|
|
4575
|
-
hashtags?: string[];
|
|
4576
|
-
/**
|
|
4577
|
-
* Category filter.
|
|
4578
|
-
*
|
|
4579
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4580
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
4581
|
-
* @maxSize 50
|
|
4582
|
-
* @format GUID
|
|
4583
|
-
*/
|
|
4584
|
-
categoryIds?: string[];
|
|
4585
|
-
/**
|
|
4586
|
-
* Tag filter.
|
|
4587
|
-
*
|
|
4588
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4589
|
-
* If omitted, all posts with or without tags are returned.
|
|
4590
|
-
* @maxSize 50
|
|
4591
|
-
* @format GUID
|
|
4592
|
-
*/
|
|
4593
|
-
tagIds?: string[];
|
|
4594
|
-
/**
|
|
4595
|
-
* Sorting options.
|
|
4596
|
-
*
|
|
4597
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4598
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4599
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4600
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4601
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4602
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4603
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4604
|
-
* - `RATING`: reserved for internal use.
|
|
4605
|
-
*
|
|
4606
|
-
* Default: `FEED`
|
|
4607
|
-
*/
|
|
4608
|
-
sort?: GetPostsSortWithLiterals;
|
|
4609
|
-
/** Pagination options. */
|
|
4610
|
-
paging?: BlogPaging;
|
|
4611
|
-
/**
|
|
4612
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
4613
|
-
* This parameter will be removed on June 30, 2023.
|
|
4614
|
-
*
|
|
4615
|
-
* List of post fields to be included in the response.
|
|
4616
|
-
* @maxSize 20
|
|
4617
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4618
|
-
* This parameter will be removed on June 30, 2023.
|
|
4619
|
-
*
|
|
4620
|
-
* List of post fields to be included in the response.
|
|
4621
|
-
* @replacedBy fieldsets
|
|
4622
|
-
* @targetRemovalDate 2024-06-30
|
|
4623
|
-
*/
|
|
4624
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4625
|
-
/**
|
|
4626
|
-
* Language filter.
|
|
4627
|
-
*
|
|
4628
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4629
|
-
* Pass a language to only receive posts that are in that language.
|
|
4630
|
-
* If omitted, posts in all languages are returned.
|
|
4631
|
-
* @format LANGUAGE_TAG
|
|
4632
|
-
*/
|
|
4633
|
-
language?: string | null;
|
|
4634
|
-
/**
|
|
4635
|
-
* Post owner's member ID.
|
|
4636
|
-
* @format GUID
|
|
4637
|
-
*/
|
|
4638
|
-
memberId?: string | null;
|
|
4639
|
-
/**
|
|
4640
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4641
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4642
|
-
* only the post’s base fields are returned.
|
|
4643
|
-
* @maxSize 20
|
|
4644
|
-
*/
|
|
4645
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4646
|
-
}
|
|
4647
|
-
interface ListDemoPostsResponse {
|
|
4648
|
-
/** List of posts. */
|
|
4649
|
-
posts?: Post[];
|
|
4650
|
-
/** Details on the paged set of results returned. */
|
|
4651
|
-
metaData?: MetaData;
|
|
4652
|
-
}
|
|
4653
4661
|
|
|
4654
4662
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4655
4663
|
getUrl: (context: any) => string;
|
|
@@ -1580,14 +1580,17 @@ var Order = /* @__PURE__ */ ((Order2) => {
|
|
|
1580
1580
|
Order2["NEWEST"] = "NEWEST";
|
|
1581
1581
|
return Order2;
|
|
1582
1582
|
})(Order || {});
|
|
1583
|
-
var
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1583
|
+
var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
|
|
1584
|
+
GetPostsSort2["FEED"] = "FEED";
|
|
1585
|
+
GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
|
|
1586
|
+
GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
|
|
1587
|
+
GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
|
|
1588
|
+
GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
|
|
1589
|
+
GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
|
|
1590
|
+
GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
|
|
1591
|
+
GetPostsSort2["RATING"] = "RATING";
|
|
1592
|
+
return GetPostsSort2;
|
|
1593
|
+
})(GetPostsSort || {});
|
|
1591
1594
|
var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
|
|
1592
1595
|
PostFieldField2["UNKNOWN"] = "UNKNOWN";
|
|
1593
1596
|
PostFieldField2["COUNTERS"] = "COUNTERS";
|
|
@@ -1611,17 +1614,14 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
|
|
|
1611
1614
|
PostFieldField2["IMAGE"] = "IMAGE";
|
|
1612
1615
|
return PostFieldField2;
|
|
1613
1616
|
})(PostFieldField || {});
|
|
1614
|
-
var
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
GetPostsSort2["RATING"] = "RATING";
|
|
1623
|
-
return GetPostsSort2;
|
|
1624
|
-
})(GetPostsSort || {});
|
|
1617
|
+
var Field = /* @__PURE__ */ ((Field2) => {
|
|
1618
|
+
Field2["UNKNOWN"] = "UNKNOWN";
|
|
1619
|
+
Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
|
|
1620
|
+
Field2["LIKE_COUNT"] = "LIKE_COUNT";
|
|
1621
|
+
Field2["VIEW_COUNT"] = "VIEW_COUNT";
|
|
1622
|
+
Field2["RATING_COUNT"] = "RATING_COUNT";
|
|
1623
|
+
return Field2;
|
|
1624
|
+
})(Field || {});
|
|
1625
1625
|
var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
|
|
1626
1626
|
SortOrder2["ASC"] = "ASC";
|
|
1627
1627
|
SortOrder2["DESC"] = "DESC";
|