@wix/auto_sdk_blog_posts 1.0.183 → 1.0.185
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 +6 -6
- package/build/cjs/index.js +19 -19
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +173 -173
- package/build/cjs/index.typings.js +19 -19
- 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 +6 -6
- package/build/es/index.mjs +19 -19
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +173 -173
- package/build/es/index.typings.mjs +19 -19
- 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 +6 -6
- package/build/internal/cjs/index.typings.d.ts +227 -227
- package/build/internal/cjs/meta.d.ts +220 -220
- package/build/internal/es/index.d.mts +6 -6
- package/build/internal/es/index.typings.d.mts +227 -227
- package/build/internal/es/meta.d.mts +220 -220
- package/package.json +2 -2
|
@@ -3546,6 +3546,172 @@ interface GetTotalPostsResponse {
|
|
|
3546
3546
|
/** Total amount of published posts. */
|
|
3547
3547
|
total?: number;
|
|
3548
3548
|
}
|
|
3549
|
+
interface ListDemoPostsRequest {
|
|
3550
|
+
/**
|
|
3551
|
+
* Whether to return only featured posts.
|
|
3552
|
+
*
|
|
3553
|
+
* Default: `false`
|
|
3554
|
+
*/
|
|
3555
|
+
featured?: boolean;
|
|
3556
|
+
/**
|
|
3557
|
+
* Hashtag filter.
|
|
3558
|
+
*
|
|
3559
|
+
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
3560
|
+
* If omitted, all posts with or without hashtags are returned.
|
|
3561
|
+
* @maxSize 100
|
|
3562
|
+
* @maxLength 100
|
|
3563
|
+
*/
|
|
3564
|
+
hashtags?: string[];
|
|
3565
|
+
/**
|
|
3566
|
+
* Category filter.
|
|
3567
|
+
*
|
|
3568
|
+
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
3569
|
+
* If omitted, all posts with or without associated categories are returned.
|
|
3570
|
+
* @maxSize 50
|
|
3571
|
+
* @format GUID
|
|
3572
|
+
*/
|
|
3573
|
+
categoryIds?: string[];
|
|
3574
|
+
/**
|
|
3575
|
+
* Tag filter.
|
|
3576
|
+
*
|
|
3577
|
+
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
3578
|
+
* If omitted, all posts with or without tags are returned.
|
|
3579
|
+
* @maxSize 50
|
|
3580
|
+
* @format GUID
|
|
3581
|
+
*/
|
|
3582
|
+
tagIds?: string[];
|
|
3583
|
+
/**
|
|
3584
|
+
* Sorting options.
|
|
3585
|
+
*
|
|
3586
|
+
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
3587
|
+
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
3588
|
+
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3589
|
+
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3590
|
+
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3591
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3592
|
+
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3593
|
+
* - `RATING`: reserved for internal use.
|
|
3594
|
+
*
|
|
3595
|
+
* Default: `FEED`
|
|
3596
|
+
*/
|
|
3597
|
+
sort?: GetPostsSortWithLiterals;
|
|
3598
|
+
/** Pagination options. */
|
|
3599
|
+
paging?: BlogPaging;
|
|
3600
|
+
/**
|
|
3601
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
3602
|
+
* This parameter will be removed on June 30, 2023.
|
|
3603
|
+
*
|
|
3604
|
+
* List of post fields to be included in the response.
|
|
3605
|
+
* @maxSize 20
|
|
3606
|
+
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
3607
|
+
* This parameter will be removed on June 30, 2023.
|
|
3608
|
+
*
|
|
3609
|
+
* List of post fields to be included in the response.
|
|
3610
|
+
* @replacedBy fieldsets
|
|
3611
|
+
* @targetRemovalDate 2024-06-30
|
|
3612
|
+
*/
|
|
3613
|
+
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
3614
|
+
/**
|
|
3615
|
+
* Language filter.
|
|
3616
|
+
*
|
|
3617
|
+
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3618
|
+
* Pass a language to only receive posts that are in that language.
|
|
3619
|
+
* If omitted, posts in all languages are returned.
|
|
3620
|
+
* @format LANGUAGE_TAG
|
|
3621
|
+
*/
|
|
3622
|
+
language?: string | null;
|
|
3623
|
+
/**
|
|
3624
|
+
* Post owner's member ID.
|
|
3625
|
+
* @format GUID
|
|
3626
|
+
*/
|
|
3627
|
+
memberId?: string | null;
|
|
3628
|
+
/**
|
|
3629
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3630
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3631
|
+
* only the post’s base fields are returned.
|
|
3632
|
+
* @maxSize 20
|
|
3633
|
+
*/
|
|
3634
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3635
|
+
}
|
|
3636
|
+
declare enum GetPostsSort {
|
|
3637
|
+
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3638
|
+
FEED = "FEED",
|
|
3639
|
+
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3640
|
+
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3641
|
+
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3642
|
+
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3643
|
+
/** Ordered by total number of views in descending order. */
|
|
3644
|
+
VIEW_COUNT = "VIEW_COUNT",
|
|
3645
|
+
/** Ordered by total number of likes in descending order. */
|
|
3646
|
+
LIKE_COUNT = "LIKE_COUNT",
|
|
3647
|
+
/** Ordered by `title` in ascending order. */
|
|
3648
|
+
TITLE_ASC = "TITLE_ASC",
|
|
3649
|
+
/** Ordered by `title` in descending order. */
|
|
3650
|
+
TITLE_DESC = "TITLE_DESC"
|
|
3651
|
+
}
|
|
3652
|
+
/** @enumType */
|
|
3653
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3654
|
+
interface BlogPaging {
|
|
3655
|
+
/**
|
|
3656
|
+
* Number of items to skip in the current sort order.
|
|
3657
|
+
*
|
|
3658
|
+
*
|
|
3659
|
+
* Default: `0`
|
|
3660
|
+
*/
|
|
3661
|
+
offset?: number;
|
|
3662
|
+
/**
|
|
3663
|
+
* Number of items to return.
|
|
3664
|
+
*
|
|
3665
|
+
*
|
|
3666
|
+
* Default:`50`
|
|
3667
|
+
* @min 1
|
|
3668
|
+
* @max 100
|
|
3669
|
+
*/
|
|
3670
|
+
limit?: number;
|
|
3671
|
+
/**
|
|
3672
|
+
* Pointer to the next or previous page in the list of results.
|
|
3673
|
+
* @maxLength 2000
|
|
3674
|
+
*/
|
|
3675
|
+
cursor?: string | null;
|
|
3676
|
+
}
|
|
3677
|
+
declare enum PostFieldField {
|
|
3678
|
+
UNKNOWN = "UNKNOWN",
|
|
3679
|
+
/** Includes post URL when present. */
|
|
3680
|
+
URL = "URL",
|
|
3681
|
+
/** Includes post content text string when present. */
|
|
3682
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3683
|
+
/** Includes post metrics when present. */
|
|
3684
|
+
METRICS = "METRICS",
|
|
3685
|
+
/** Includes SEO data. */
|
|
3686
|
+
SEO = "SEO",
|
|
3687
|
+
/** Includes post owner's contact ID. */
|
|
3688
|
+
CONTACT_ID = "CONTACT_ID",
|
|
3689
|
+
/** Includes post rich content. */
|
|
3690
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
3691
|
+
/** Includes post reference ID field. */
|
|
3692
|
+
REFERENCE_ID = "REFERENCE_ID"
|
|
3693
|
+
}
|
|
3694
|
+
/** @enumType */
|
|
3695
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3696
|
+
interface ListDemoPostsResponse {
|
|
3697
|
+
/** List of posts. */
|
|
3698
|
+
posts?: Post[];
|
|
3699
|
+
/** Details on the paged set of results returned. */
|
|
3700
|
+
metaData?: MetaData;
|
|
3701
|
+
}
|
|
3702
|
+
interface MetaData {
|
|
3703
|
+
/** Number of items returned in this response. */
|
|
3704
|
+
count?: number;
|
|
3705
|
+
/** Requested offset. */
|
|
3706
|
+
offset?: number;
|
|
3707
|
+
/** Total number of items that match the query. */
|
|
3708
|
+
total?: number;
|
|
3709
|
+
/**
|
|
3710
|
+
* Pointer to the next or previous page in the list of results.
|
|
3711
|
+
* @maxLength 2000
|
|
3712
|
+
*/
|
|
3713
|
+
cursor?: string | null;
|
|
3714
|
+
}
|
|
3549
3715
|
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
3550
3716
|
/**
|
|
3551
3717
|
* Member ID of person who triggered the counter update
|
|
@@ -3615,25 +3781,6 @@ interface GetPostRequest {
|
|
|
3615
3781
|
*/
|
|
3616
3782
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3617
3783
|
}
|
|
3618
|
-
declare enum PostFieldField {
|
|
3619
|
-
UNKNOWN = "UNKNOWN",
|
|
3620
|
-
/** Includes post URL when present. */
|
|
3621
|
-
URL = "URL",
|
|
3622
|
-
/** Includes post content text string when present. */
|
|
3623
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
|
3624
|
-
/** Includes post metrics when present. */
|
|
3625
|
-
METRICS = "METRICS",
|
|
3626
|
-
/** Includes SEO data. */
|
|
3627
|
-
SEO = "SEO",
|
|
3628
|
-
/** Includes post owner's contact ID. */
|
|
3629
|
-
CONTACT_ID = "CONTACT_ID",
|
|
3630
|
-
/** Includes post rich content. */
|
|
3631
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
3632
|
-
/** Includes post reference ID field. */
|
|
3633
|
-
REFERENCE_ID = "REFERENCE_ID"
|
|
3634
|
-
}
|
|
3635
|
-
/** @enumType */
|
|
3636
|
-
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
|
3637
3784
|
interface GetPostResponse {
|
|
3638
3785
|
/** Retrieved post info. */
|
|
3639
3786
|
post?: Post;
|
|
@@ -3726,66 +3873,12 @@ interface ListPostsRequest {
|
|
|
3726
3873
|
*/
|
|
3727
3874
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3728
3875
|
}
|
|
3729
|
-
declare enum GetPostsSort {
|
|
3730
|
-
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
|
3731
|
-
FEED = "FEED",
|
|
3732
|
-
/** Ordered by `firstPublishedDate` in ascending order. */
|
|
3733
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
|
3734
|
-
/** Ordered by `firstPublishedDate` in descending order. */
|
|
3735
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
|
|
3736
|
-
/** Ordered by total number of views in descending order. */
|
|
3737
|
-
VIEW_COUNT = "VIEW_COUNT",
|
|
3738
|
-
/** Ordered by total number of likes in descending order. */
|
|
3739
|
-
LIKE_COUNT = "LIKE_COUNT",
|
|
3740
|
-
/** Ordered by `title` in ascending order. */
|
|
3741
|
-
TITLE_ASC = "TITLE_ASC",
|
|
3742
|
-
/** Ordered by `title` in descending order. */
|
|
3743
|
-
TITLE_DESC = "TITLE_DESC"
|
|
3744
|
-
}
|
|
3745
|
-
/** @enumType */
|
|
3746
|
-
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
|
3747
|
-
interface BlogPaging {
|
|
3748
|
-
/**
|
|
3749
|
-
* Number of items to skip in the current sort order.
|
|
3750
|
-
*
|
|
3751
|
-
*
|
|
3752
|
-
* Default: `0`
|
|
3753
|
-
*/
|
|
3754
|
-
offset?: number;
|
|
3755
|
-
/**
|
|
3756
|
-
* Number of items to return.
|
|
3757
|
-
*
|
|
3758
|
-
*
|
|
3759
|
-
* Default:`50`
|
|
3760
|
-
* @min 1
|
|
3761
|
-
* @max 100
|
|
3762
|
-
*/
|
|
3763
|
-
limit?: number;
|
|
3764
|
-
/**
|
|
3765
|
-
* Pointer to the next or previous page in the list of results.
|
|
3766
|
-
* @maxLength 2000
|
|
3767
|
-
*/
|
|
3768
|
-
cursor?: string | null;
|
|
3769
|
-
}
|
|
3770
3876
|
interface ListPostsResponse {
|
|
3771
3877
|
/** List of retrieved posts. */
|
|
3772
3878
|
posts?: Post[];
|
|
3773
3879
|
/** Details on the paged set of results returned. */
|
|
3774
3880
|
metaData?: MetaData;
|
|
3775
3881
|
}
|
|
3776
|
-
interface MetaData {
|
|
3777
|
-
/** Number of items returned in this response. */
|
|
3778
|
-
count?: number;
|
|
3779
|
-
/** Requested offset. */
|
|
3780
|
-
offset?: number;
|
|
3781
|
-
/** Total number of items that match the query. */
|
|
3782
|
-
total?: number;
|
|
3783
|
-
/**
|
|
3784
|
-
* Pointer to the next or previous page in the list of results.
|
|
3785
|
-
* @maxLength 2000
|
|
3786
|
-
*/
|
|
3787
|
-
cursor?: string | null;
|
|
3788
|
-
}
|
|
3789
3882
|
interface QueryPostsRequest {
|
|
3790
3883
|
/** Query options. */
|
|
3791
3884
|
query?: PlatformQuery;
|
|
@@ -4144,99 +4237,6 @@ interface PostCount {
|
|
|
4144
4237
|
/** Number of posts. */
|
|
4145
4238
|
postCount?: number;
|
|
4146
4239
|
}
|
|
4147
|
-
interface ListDemoPostsRequest {
|
|
4148
|
-
/**
|
|
4149
|
-
* Whether to return only featured posts.
|
|
4150
|
-
*
|
|
4151
|
-
* Default: `false`
|
|
4152
|
-
*/
|
|
4153
|
-
featured?: boolean;
|
|
4154
|
-
/**
|
|
4155
|
-
* Hashtag filter.
|
|
4156
|
-
*
|
|
4157
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
|
4158
|
-
* If omitted, all posts with or without hashtags are returned.
|
|
4159
|
-
* @maxSize 100
|
|
4160
|
-
* @maxLength 100
|
|
4161
|
-
*/
|
|
4162
|
-
hashtags?: string[];
|
|
4163
|
-
/**
|
|
4164
|
-
* Category filter.
|
|
4165
|
-
*
|
|
4166
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
|
4167
|
-
* If omitted, all posts with or without associated categories are returned.
|
|
4168
|
-
* @maxSize 50
|
|
4169
|
-
* @format GUID
|
|
4170
|
-
*/
|
|
4171
|
-
categoryIds?: string[];
|
|
4172
|
-
/**
|
|
4173
|
-
* Tag filter.
|
|
4174
|
-
*
|
|
4175
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
|
4176
|
-
* If omitted, all posts with or without tags are returned.
|
|
4177
|
-
* @maxSize 50
|
|
4178
|
-
* @format GUID
|
|
4179
|
-
*/
|
|
4180
|
-
tagIds?: string[];
|
|
4181
|
-
/**
|
|
4182
|
-
* Sorting options.
|
|
4183
|
-
*
|
|
4184
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
|
4185
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
|
4186
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
4187
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
4188
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
4189
|
-
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
4190
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
4191
|
-
* - `RATING`: reserved for internal use.
|
|
4192
|
-
*
|
|
4193
|
-
* Default: `FEED`
|
|
4194
|
-
*/
|
|
4195
|
-
sort?: GetPostsSortWithLiterals;
|
|
4196
|
-
/** Pagination options. */
|
|
4197
|
-
paging?: BlogPaging;
|
|
4198
|
-
/**
|
|
4199
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
|
4200
|
-
* This parameter will be removed on June 30, 2023.
|
|
4201
|
-
*
|
|
4202
|
-
* List of post fields to be included in the response.
|
|
4203
|
-
* @maxSize 20
|
|
4204
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
|
4205
|
-
* This parameter will be removed on June 30, 2023.
|
|
4206
|
-
*
|
|
4207
|
-
* List of post fields to be included in the response.
|
|
4208
|
-
* @replacedBy fieldsets
|
|
4209
|
-
* @targetRemovalDate 2024-06-30
|
|
4210
|
-
*/
|
|
4211
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
|
4212
|
-
/**
|
|
4213
|
-
* Language filter.
|
|
4214
|
-
*
|
|
4215
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4216
|
-
* Pass a language to only receive posts that are in that language.
|
|
4217
|
-
* If omitted, posts in all languages are returned.
|
|
4218
|
-
* @format LANGUAGE_TAG
|
|
4219
|
-
*/
|
|
4220
|
-
language?: string | null;
|
|
4221
|
-
/**
|
|
4222
|
-
* Post owner's member ID.
|
|
4223
|
-
* @format GUID
|
|
4224
|
-
*/
|
|
4225
|
-
memberId?: string | null;
|
|
4226
|
-
/**
|
|
4227
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
4228
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4229
|
-
* only the post’s base fields are returned.
|
|
4230
|
-
* @maxSize 20
|
|
4231
|
-
*/
|
|
4232
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4233
|
-
}
|
|
4234
|
-
interface ListDemoPostsResponse {
|
|
4235
|
-
/** List of posts. */
|
|
4236
|
-
posts?: Post[];
|
|
4237
|
-
/** Details on the paged set of results returned. */
|
|
4238
|
-
metaData?: MetaData;
|
|
4239
|
-
}
|
|
4240
4240
|
interface BaseEventMetadata {
|
|
4241
4241
|
/**
|
|
4242
4242
|
* App instance ID.
|
|
@@ -4396,7 +4396,7 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
4396
4396
|
* @returns Get Blog Post Count Stats response
|
|
4397
4397
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
|
4398
4398
|
*/
|
|
4399
|
-
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`,
|
|
4399
|
+
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 2>>;
|
|
4400
4400
|
interface QueryPostCountStatsOptions {
|
|
4401
4401
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
4402
4402
|
rangeStart?: Date | null;
|
|
@@ -4435,7 +4435,7 @@ interface QueryPostCountStatsOptions {
|
|
|
4435
4435
|
* @applicableIdentity APP
|
|
4436
4436
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
4437
4437
|
*/
|
|
4438
|
-
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`,
|
|
4438
|
+
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 0>>;
|
|
4439
4439
|
interface GetTotalPostsOptions {
|
|
4440
4440
|
/**
|
|
4441
4441
|
* Language filter.
|
|
@@ -4456,7 +4456,7 @@ interface GetTotalPostsOptions {
|
|
|
4456
4456
|
* @returns Retrieved post info.
|
|
4457
4457
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4458
4458
|
*/
|
|
4459
|
-
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`,
|
|
4459
|
+
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`, 4>>;
|
|
4460
4460
|
interface GetPostOptions {
|
|
4461
4461
|
/**
|
|
4462
4462
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4480,7 +4480,7 @@ interface GetPostOptions {
|
|
|
4480
4480
|
* @applicableIdentity APP
|
|
4481
4481
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
4482
4482
|
*/
|
|
4483
|
-
declare function getPostBySlug(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`,
|
|
4483
|
+
declare function getPostBySlug(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>>;
|
|
4484
4484
|
interface GetPostBySlugOptions {
|
|
4485
4485
|
/**
|
|
4486
4486
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4507,7 +4507,7 @@ interface GetPostBySlugOptions {
|
|
|
4507
4507
|
* @applicableIdentity APP
|
|
4508
4508
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
4509
4509
|
*/
|
|
4510
|
-
declare function listPosts(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`,
|
|
4510
|
+
declare function listPosts(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>>;
|
|
4511
4511
|
interface ListPostsOptions {
|
|
4512
4512
|
/**
|
|
4513
4513
|
* Whether to return only featured posts.
|
|
@@ -4668,7 +4668,7 @@ interface PostsQueryBuilder {
|
|
|
4668
4668
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
4669
4669
|
* @requiredField query
|
|
4670
4670
|
*/
|
|
4671
|
-
declare function typedQueryPosts(query: PostQuery, options?: QueryPostsOptions): Promise<NonNullablePaths<QueryPostsResponse, `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`,
|
|
4671
|
+
declare function typedQueryPosts(query: PostQuery, options?: QueryPostsOptions): Promise<NonNullablePaths<QueryPostsResponse, `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`, 4>>;
|
|
4672
4672
|
interface PostQuerySpec extends QuerySpec {
|
|
4673
4673
|
paging: 'cursor';
|
|
4674
4674
|
wql: [
|
|
@@ -4851,6 +4851,6 @@ declare const utils: {
|
|
|
4851
4851
|
* @applicableIdentity APP
|
|
4852
4852
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
|
4853
4853
|
*/
|
|
4854
|
-
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`,
|
|
4854
|
+
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 1>>;
|
|
4855
4855
|
|
|
4856
4856
|
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SectionDivider, type SeoSchema, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
|
|
@@ -1626,14 +1626,17 @@ var Order = /* @__PURE__ */ ((Order2) => {
|
|
|
1626
1626
|
Order2["NEWEST"] = "NEWEST";
|
|
1627
1627
|
return Order2;
|
|
1628
1628
|
})(Order || {});
|
|
1629
|
-
var
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1629
|
+
var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
|
|
1630
|
+
GetPostsSort2["FEED"] = "FEED";
|
|
1631
|
+
GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
|
|
1632
|
+
GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
|
|
1633
|
+
GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
|
|
1634
|
+
GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
|
|
1635
|
+
GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
|
|
1636
|
+
GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
|
|
1637
|
+
GetPostsSort2["RATING"] = "RATING";
|
|
1638
|
+
return GetPostsSort2;
|
|
1639
|
+
})(GetPostsSort || {});
|
|
1637
1640
|
var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
|
|
1638
1641
|
PostFieldField2["UNKNOWN"] = "UNKNOWN";
|
|
1639
1642
|
PostFieldField2["COUNTERS"] = "COUNTERS";
|
|
@@ -1657,17 +1660,14 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
|
|
|
1657
1660
|
PostFieldField2["IMAGE"] = "IMAGE";
|
|
1658
1661
|
return PostFieldField2;
|
|
1659
1662
|
})(PostFieldField || {});
|
|
1660
|
-
var
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
GetPostsSort2["RATING"] = "RATING";
|
|
1669
|
-
return GetPostsSort2;
|
|
1670
|
-
})(GetPostsSort || {});
|
|
1663
|
+
var Field = /* @__PURE__ */ ((Field2) => {
|
|
1664
|
+
Field2["UNKNOWN"] = "UNKNOWN";
|
|
1665
|
+
Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
|
|
1666
|
+
Field2["LIKE_COUNT"] = "LIKE_COUNT";
|
|
1667
|
+
Field2["VIEW_COUNT"] = "VIEW_COUNT";
|
|
1668
|
+
Field2["RATING_COUNT"] = "RATING_COUNT";
|
|
1669
|
+
return Field2;
|
|
1670
|
+
})(Field || {});
|
|
1671
1671
|
var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
|
|
1672
1672
|
SortOrder2["ASC"] = "ASC";
|
|
1673
1673
|
SortOrder2["DESC"] = "DESC";
|