@wix/auto_sdk_blog_posts 1.0.183 → 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.
@@ -3592,6 +3592,172 @@ interface GetTotalPostsResponse {
3592
3592
  /** Total amount of published posts. */
3593
3593
  total?: number;
3594
3594
  }
3595
+ interface ListDemoPostsRequest {
3596
+ /**
3597
+ * Whether to return only featured posts.
3598
+ *
3599
+ * Default: `false`
3600
+ */
3601
+ featured?: boolean;
3602
+ /**
3603
+ * Hashtag filter.
3604
+ *
3605
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3606
+ * If omitted, all posts with or without hashtags are returned.
3607
+ * @maxSize 100
3608
+ * @maxLength 100
3609
+ */
3610
+ hashtags?: string[];
3611
+ /**
3612
+ * Category filter.
3613
+ *
3614
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3615
+ * If omitted, all posts with or without associated categories are returned.
3616
+ * @maxSize 50
3617
+ * @format GUID
3618
+ */
3619
+ categoryIds?: string[];
3620
+ /**
3621
+ * Tag filter.
3622
+ *
3623
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3624
+ * If omitted, all posts with or without tags are returned.
3625
+ * @maxSize 50
3626
+ * @format GUID
3627
+ */
3628
+ tagIds?: string[];
3629
+ /**
3630
+ * Sorting options.
3631
+ *
3632
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3633
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3634
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3635
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3636
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3637
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3638
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3639
+ * - `RATING`: reserved for internal use.
3640
+ *
3641
+ * Default: `FEED`
3642
+ */
3643
+ sort?: GetPostsSortWithLiterals;
3644
+ /** Pagination options. */
3645
+ paging?: BlogPaging;
3646
+ /**
3647
+ * __Deprecated.__ Use `fieldsets` instead.
3648
+ * This parameter will be removed on June 30, 2023.
3649
+ *
3650
+ * List of post fields to be included in the response.
3651
+ * @maxSize 20
3652
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3653
+ * This parameter will be removed on June 30, 2023.
3654
+ *
3655
+ * List of post fields to be included in the response.
3656
+ * @replacedBy fieldsets
3657
+ * @targetRemovalDate 2024-06-30
3658
+ */
3659
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3660
+ /**
3661
+ * Language filter.
3662
+ *
3663
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3664
+ * Pass a language to only receive posts that are in that language.
3665
+ * If omitted, posts in all languages are returned.
3666
+ * @format LANGUAGE_TAG
3667
+ */
3668
+ language?: string | null;
3669
+ /**
3670
+ * Post owner's member ID.
3671
+ * @format GUID
3672
+ */
3673
+ memberId?: string | null;
3674
+ /**
3675
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3676
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3677
+ * only the post’s base fields are returned.
3678
+ * @maxSize 20
3679
+ */
3680
+ fieldsets?: PostFieldFieldWithLiterals[];
3681
+ }
3682
+ declare enum GetPostsSort {
3683
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3684
+ FEED = "FEED",
3685
+ /** Ordered by `firstPublishedDate` in ascending order. */
3686
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3687
+ /** Ordered by `firstPublishedDate` in descending order. */
3688
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3689
+ /** Ordered by total number of views in descending order. */
3690
+ VIEW_COUNT = "VIEW_COUNT",
3691
+ /** Ordered by total number of likes in descending order. */
3692
+ LIKE_COUNT = "LIKE_COUNT",
3693
+ /** Ordered by `title` in ascending order. */
3694
+ TITLE_ASC = "TITLE_ASC",
3695
+ /** Ordered by `title` in descending order. */
3696
+ TITLE_DESC = "TITLE_DESC"
3697
+ }
3698
+ /** @enumType */
3699
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3700
+ interface BlogPaging {
3701
+ /**
3702
+ * Number of items to skip in the current sort order.
3703
+ *
3704
+ *
3705
+ * Default: `0`
3706
+ */
3707
+ offset?: number;
3708
+ /**
3709
+ * Number of items to return.
3710
+ *
3711
+ *
3712
+ * Default:`50`
3713
+ * @min 1
3714
+ * @max 100
3715
+ */
3716
+ limit?: number;
3717
+ /**
3718
+ * Pointer to the next or previous page in the list of results.
3719
+ * @maxLength 2000
3720
+ */
3721
+ cursor?: string | null;
3722
+ }
3723
+ declare enum PostFieldField {
3724
+ UNKNOWN = "UNKNOWN",
3725
+ /** Includes post URL when present. */
3726
+ URL = "URL",
3727
+ /** Includes post content text string when present. */
3728
+ CONTENT_TEXT = "CONTENT_TEXT",
3729
+ /** Includes post metrics when present. */
3730
+ METRICS = "METRICS",
3731
+ /** Includes SEO data. */
3732
+ SEO = "SEO",
3733
+ /** Includes post owner's contact ID. */
3734
+ CONTACT_ID = "CONTACT_ID",
3735
+ /** Includes post rich content. */
3736
+ RICH_CONTENT = "RICH_CONTENT",
3737
+ /** Includes post reference ID field. */
3738
+ REFERENCE_ID = "REFERENCE_ID"
3739
+ }
3740
+ /** @enumType */
3741
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3742
+ interface ListDemoPostsResponse {
3743
+ /** List of posts. */
3744
+ posts?: Post[];
3745
+ /** Details on the paged set of results returned. */
3746
+ metaData?: MetaData;
3747
+ }
3748
+ interface MetaData {
3749
+ /** Number of items returned in this response. */
3750
+ count?: number;
3751
+ /** Requested offset. */
3752
+ offset?: number;
3753
+ /** Total number of items that match the query. */
3754
+ total?: number;
3755
+ /**
3756
+ * Pointer to the next or previous page in the list of results.
3757
+ * @maxLength 2000
3758
+ */
3759
+ cursor?: string | null;
3760
+ }
3595
3761
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3596
3762
  /**
3597
3763
  * Member ID of person who triggered the counter update
@@ -3661,25 +3827,6 @@ interface GetPostRequest {
3661
3827
  */
3662
3828
  fieldsets?: PostFieldFieldWithLiterals[];
3663
3829
  }
3664
- declare enum PostFieldField {
3665
- UNKNOWN = "UNKNOWN",
3666
- /** Includes post URL when present. */
3667
- URL = "URL",
3668
- /** Includes post content text string when present. */
3669
- CONTENT_TEXT = "CONTENT_TEXT",
3670
- /** Includes post metrics when present. */
3671
- METRICS = "METRICS",
3672
- /** Includes SEO data. */
3673
- SEO = "SEO",
3674
- /** Includes post owner's contact ID. */
3675
- CONTACT_ID = "CONTACT_ID",
3676
- /** Includes post rich content. */
3677
- RICH_CONTENT = "RICH_CONTENT",
3678
- /** Includes post reference ID field. */
3679
- REFERENCE_ID = "REFERENCE_ID"
3680
- }
3681
- /** @enumType */
3682
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3683
3830
  interface GetPostResponse {
3684
3831
  /** Retrieved post info. */
3685
3832
  post?: Post;
@@ -3772,66 +3919,12 @@ interface ListPostsRequest {
3772
3919
  */
3773
3920
  fieldsets?: PostFieldFieldWithLiterals[];
3774
3921
  }
3775
- declare enum GetPostsSort {
3776
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3777
- FEED = "FEED",
3778
- /** Ordered by `firstPublishedDate` in ascending order. */
3779
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3780
- /** Ordered by `firstPublishedDate` in descending order. */
3781
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3782
- /** Ordered by total number of views in descending order. */
3783
- VIEW_COUNT = "VIEW_COUNT",
3784
- /** Ordered by total number of likes in descending order. */
3785
- LIKE_COUNT = "LIKE_COUNT",
3786
- /** Ordered by `title` in ascending order. */
3787
- TITLE_ASC = "TITLE_ASC",
3788
- /** Ordered by `title` in descending order. */
3789
- TITLE_DESC = "TITLE_DESC"
3790
- }
3791
- /** @enumType */
3792
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3793
- interface BlogPaging {
3794
- /**
3795
- * Number of items to skip in the current sort order.
3796
- *
3797
- *
3798
- * Default: `0`
3799
- */
3800
- offset?: number;
3801
- /**
3802
- * Number of items to return.
3803
- *
3804
- *
3805
- * Default:`50`
3806
- * @min 1
3807
- * @max 100
3808
- */
3809
- limit?: number;
3810
- /**
3811
- * Pointer to the next or previous page in the list of results.
3812
- * @maxLength 2000
3813
- */
3814
- cursor?: string | null;
3815
- }
3816
3922
  interface ListPostsResponse {
3817
3923
  /** List of retrieved posts. */
3818
3924
  posts?: Post[];
3819
3925
  /** Details on the paged set of results returned. */
3820
3926
  metaData?: MetaData;
3821
3927
  }
3822
- interface MetaData {
3823
- /** Number of items returned in this response. */
3824
- count?: number;
3825
- /** Requested offset. */
3826
- offset?: number;
3827
- /** Total number of items that match the query. */
3828
- total?: number;
3829
- /**
3830
- * Pointer to the next or previous page in the list of results.
3831
- * @maxLength 2000
3832
- */
3833
- cursor?: string | null;
3834
- }
3835
3928
  interface QueryPostsRequest {
3836
3929
  /** Query options. */
3837
3930
  query?: PlatformQuery;
@@ -4190,99 +4283,6 @@ interface PostCount {
4190
4283
  /** Number of posts. */
4191
4284
  postCount?: number;
4192
4285
  }
4193
- interface ListDemoPostsRequest {
4194
- /**
4195
- * Whether to return only featured posts.
4196
- *
4197
- * Default: `false`
4198
- */
4199
- featured?: boolean;
4200
- /**
4201
- * Hashtag filter.
4202
- *
4203
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4204
- * If omitted, all posts with or without hashtags are returned.
4205
- * @maxSize 100
4206
- * @maxLength 100
4207
- */
4208
- hashtags?: string[];
4209
- /**
4210
- * Category filter.
4211
- *
4212
- * Pass an array of category IDs to return only posts with any of the provided categories.
4213
- * If omitted, all posts with or without associated categories are returned.
4214
- * @maxSize 50
4215
- * @format GUID
4216
- */
4217
- categoryIds?: string[];
4218
- /**
4219
- * Tag filter.
4220
- *
4221
- * Pass an array of tag IDs to return only posts with any of the provided tags.
4222
- * If omitted, all posts with or without tags are returned.
4223
- * @maxSize 50
4224
- * @format GUID
4225
- */
4226
- tagIds?: string[];
4227
- /**
4228
- * Sorting options.
4229
- *
4230
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4231
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4232
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4233
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4234
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4235
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
4236
- * - `TITLE_DESC`: Ordered by `title` in descending order.
4237
- * - `RATING`: reserved for internal use.
4238
- *
4239
- * Default: `FEED`
4240
- */
4241
- sort?: GetPostsSortWithLiterals;
4242
- /** Pagination options. */
4243
- paging?: BlogPaging;
4244
- /**
4245
- * __Deprecated.__ Use `fieldsets` instead.
4246
- * This parameter will be removed on June 30, 2023.
4247
- *
4248
- * List of post fields to be included in the response.
4249
- * @maxSize 20
4250
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4251
- * This parameter will be removed on June 30, 2023.
4252
- *
4253
- * List of post fields to be included in the response.
4254
- * @replacedBy fieldsets
4255
- * @targetRemovalDate 2024-06-30
4256
- */
4257
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4258
- /**
4259
- * Language filter.
4260
- *
4261
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4262
- * Pass a language to only receive posts that are in that language.
4263
- * If omitted, posts in all languages are returned.
4264
- * @format LANGUAGE_TAG
4265
- */
4266
- language?: string | null;
4267
- /**
4268
- * Post owner's member ID.
4269
- * @format GUID
4270
- */
4271
- memberId?: string | null;
4272
- /**
4273
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4274
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4275
- * only the post’s base fields are returned.
4276
- * @maxSize 20
4277
- */
4278
- fieldsets?: PostFieldFieldWithLiterals[];
4279
- }
4280
- interface ListDemoPostsResponse {
4281
- /** List of posts. */
4282
- posts?: Post[];
4283
- /** Details on the paged set of results returned. */
4284
- metaData?: MetaData;
4285
- }
4286
4286
 
4287
4287
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4288
4288
  getUrl: (context: any) => string;
package/build/cjs/meta.js CHANGED
@@ -1716,14 +1716,17 @@ var Order = /* @__PURE__ */ ((Order2) => {
1716
1716
  Order2["NEWEST"] = "NEWEST";
1717
1717
  return Order2;
1718
1718
  })(Order || {});
1719
- var Field = /* @__PURE__ */ ((Field2) => {
1720
- Field2["UNKNOWN"] = "UNKNOWN";
1721
- Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1722
- Field2["LIKE_COUNT"] = "LIKE_COUNT";
1723
- Field2["VIEW_COUNT"] = "VIEW_COUNT";
1724
- Field2["RATING_COUNT"] = "RATING_COUNT";
1725
- return Field2;
1726
- })(Field || {});
1719
+ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1720
+ GetPostsSort2["FEED"] = "FEED";
1721
+ GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1722
+ GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1723
+ GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1724
+ GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1725
+ GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1726
+ GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1727
+ GetPostsSort2["RATING"] = "RATING";
1728
+ return GetPostsSort2;
1729
+ })(GetPostsSort || {});
1727
1730
  var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1728
1731
  PostFieldField2["UNKNOWN"] = "UNKNOWN";
1729
1732
  PostFieldField2["COUNTERS"] = "COUNTERS";
@@ -1747,17 +1750,14 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1747
1750
  PostFieldField2["IMAGE"] = "IMAGE";
1748
1751
  return PostFieldField2;
1749
1752
  })(PostFieldField || {});
1750
- var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1751
- GetPostsSort2["FEED"] = "FEED";
1752
- GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1753
- GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1754
- GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1755
- GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1756
- GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1757
- GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1758
- GetPostsSort2["RATING"] = "RATING";
1759
- return GetPostsSort2;
1760
- })(GetPostsSort || {});
1753
+ var Field = /* @__PURE__ */ ((Field2) => {
1754
+ Field2["UNKNOWN"] = "UNKNOWN";
1755
+ Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1756
+ Field2["LIKE_COUNT"] = "LIKE_COUNT";
1757
+ Field2["VIEW_COUNT"] = "VIEW_COUNT";
1758
+ Field2["RATING_COUNT"] = "RATING_COUNT";
1759
+ return Field2;
1760
+ })(Field || {});
1761
1761
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
1762
1762
  SortOrder2["ASC"] = "ASC";
1763
1763
  SortOrder2["DESC"] = "DESC";