@wix/auto_sdk_blog_posts 1.0.194 → 1.0.195

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.
@@ -3625,172 +3625,6 @@ interface GetTotalPostsResponse {
3625
3625
  /** Total amount of published posts. */
3626
3626
  total?: number;
3627
3627
  }
3628
- interface ListDemoPostsRequest {
3629
- /**
3630
- * Whether to return only featured posts.
3631
- *
3632
- * Default: `false`
3633
- */
3634
- featured?: boolean;
3635
- /**
3636
- * Hashtag filter.
3637
- *
3638
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3639
- * If omitted, all posts with or without hashtags are returned.
3640
- * @maxSize 100
3641
- * @maxLength 100
3642
- */
3643
- hashtags?: string[];
3644
- /**
3645
- * Category filter.
3646
- *
3647
- * Pass an array of category IDs to return only posts with any of the provided categories.
3648
- * If omitted, all posts with or without associated categories are returned.
3649
- * @maxSize 50
3650
- * @format GUID
3651
- */
3652
- categoryIds?: string[];
3653
- /**
3654
- * Tag filter.
3655
- *
3656
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3657
- * If omitted, all posts with or without tags are returned.
3658
- * @maxSize 50
3659
- * @format GUID
3660
- */
3661
- tagIds?: string[];
3662
- /**
3663
- * Sorting options.
3664
- *
3665
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3666
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3667
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3668
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3669
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3670
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3671
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3672
- * - `RATING`: reserved for internal use.
3673
- *
3674
- * Default: `FEED`
3675
- */
3676
- sort?: GetPostsSortWithLiterals;
3677
- /** Pagination options. */
3678
- paging?: BlogPaging;
3679
- /**
3680
- * __Deprecated.__ Use `fieldsets` instead.
3681
- * This parameter will be removed on June 30, 2023.
3682
- *
3683
- * List of post fields to be included in the response.
3684
- * @maxSize 20
3685
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
3686
- * This parameter will be removed on June 30, 2023.
3687
- *
3688
- * List of post fields to be included in the response.
3689
- * @replacedBy fieldsets
3690
- * @targetRemovalDate 2024-06-30
3691
- */
3692
- fieldsToInclude?: PostFieldFieldWithLiterals[];
3693
- /**
3694
- * Language filter.
3695
- *
3696
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3697
- * Pass a language to only receive posts that are in that language.
3698
- * If omitted, posts in all languages are returned.
3699
- * @format LANGUAGE_TAG
3700
- */
3701
- language?: string | null;
3702
- /**
3703
- * Post owner's member ID.
3704
- * @format GUID
3705
- */
3706
- memberId?: string | null;
3707
- /**
3708
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3709
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3710
- * only the post’s base fields are returned.
3711
- * @maxSize 20
3712
- */
3713
- fieldsets?: PostFieldFieldWithLiterals[];
3714
- }
3715
- declare enum GetPostsSort {
3716
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3717
- FEED = "FEED",
3718
- /** Ordered by `firstPublishedDate` in ascending order. */
3719
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3720
- /** Ordered by `firstPublishedDate` in descending order. */
3721
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3722
- /** Ordered by total number of views in descending order. */
3723
- VIEW_COUNT = "VIEW_COUNT",
3724
- /** Ordered by total number of likes in descending order. */
3725
- LIKE_COUNT = "LIKE_COUNT",
3726
- /** Ordered by `title` in ascending order. */
3727
- TITLE_ASC = "TITLE_ASC",
3728
- /** Ordered by `title` in descending order. */
3729
- TITLE_DESC = "TITLE_DESC"
3730
- }
3731
- /** @enumType */
3732
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3733
- interface BlogPaging {
3734
- /**
3735
- * Number of items to skip in the current sort order.
3736
- *
3737
- *
3738
- * Default: `0`
3739
- */
3740
- offset?: number;
3741
- /**
3742
- * Number of items to return.
3743
- *
3744
- *
3745
- * Default:`50`
3746
- * @min 1
3747
- * @max 100
3748
- */
3749
- limit?: number;
3750
- /**
3751
- * Pointer to the next or previous page in the list of results.
3752
- * @maxLength 2000
3753
- */
3754
- cursor?: string | null;
3755
- }
3756
- declare enum PostFieldField {
3757
- UNKNOWN = "UNKNOWN",
3758
- /** Includes post URL when present. */
3759
- URL = "URL",
3760
- /** Includes post content text string when present. */
3761
- CONTENT_TEXT = "CONTENT_TEXT",
3762
- /** Includes post metrics when present. */
3763
- METRICS = "METRICS",
3764
- /** Includes SEO data. */
3765
- SEO = "SEO",
3766
- /** Includes post owner's contact ID. */
3767
- CONTACT_ID = "CONTACT_ID",
3768
- /** Includes post rich content. */
3769
- RICH_CONTENT = "RICH_CONTENT",
3770
- /** Includes post reference ID field. */
3771
- REFERENCE_ID = "REFERENCE_ID"
3772
- }
3773
- /** @enumType */
3774
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3775
- interface ListDemoPostsResponse {
3776
- /** List of posts. */
3777
- posts?: Post[];
3778
- /** Details on the paged set of results returned. */
3779
- metaData?: MetaData;
3780
- }
3781
- interface MetaData {
3782
- /** Number of items returned in this response. */
3783
- count?: number;
3784
- /** Requested offset. */
3785
- offset?: number;
3786
- /** Total number of items that match the query. */
3787
- total?: number;
3788
- /**
3789
- * Pointer to the next or previous page in the list of results.
3790
- * @maxLength 2000
3791
- */
3792
- cursor?: string | null;
3793
- }
3794
3628
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3795
3629
  /**
3796
3630
  * Member ID of person who triggered the counter update
@@ -3860,6 +3694,25 @@ interface GetPostRequest {
3860
3694
  */
3861
3695
  fieldsets?: PostFieldFieldWithLiterals[];
3862
3696
  }
3697
+ declare enum PostFieldField {
3698
+ UNKNOWN = "UNKNOWN",
3699
+ /** Includes post URL when present. */
3700
+ URL = "URL",
3701
+ /** Includes post content text string when present. */
3702
+ CONTENT_TEXT = "CONTENT_TEXT",
3703
+ /** Includes post metrics when present. */
3704
+ METRICS = "METRICS",
3705
+ /** Includes SEO data. */
3706
+ SEO = "SEO",
3707
+ /** Includes post owner's contact ID. */
3708
+ CONTACT_ID = "CONTACT_ID",
3709
+ /** Includes post rich content. */
3710
+ RICH_CONTENT = "RICH_CONTENT",
3711
+ /** Includes post reference ID field. */
3712
+ REFERENCE_ID = "REFERENCE_ID"
3713
+ }
3714
+ /** @enumType */
3715
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3863
3716
  interface GetPostResponse {
3864
3717
  /** Retrieved post info. */
3865
3718
  post?: Post;
@@ -3952,12 +3805,66 @@ interface ListPostsRequest {
3952
3805
  */
3953
3806
  fieldsets?: PostFieldFieldWithLiterals[];
3954
3807
  }
3808
+ declare enum GetPostsSort {
3809
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3810
+ FEED = "FEED",
3811
+ /** Ordered by `firstPublishedDate` in ascending order. */
3812
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3813
+ /** Ordered by `firstPublishedDate` in descending order. */
3814
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3815
+ /** Ordered by total number of views in descending order. */
3816
+ VIEW_COUNT = "VIEW_COUNT",
3817
+ /** Ordered by total number of likes in descending order. */
3818
+ LIKE_COUNT = "LIKE_COUNT",
3819
+ /** Ordered by `title` in ascending order. */
3820
+ TITLE_ASC = "TITLE_ASC",
3821
+ /** Ordered by `title` in descending order. */
3822
+ TITLE_DESC = "TITLE_DESC"
3823
+ }
3824
+ /** @enumType */
3825
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3826
+ interface BlogPaging {
3827
+ /**
3828
+ * Number of items to skip in the current sort order.
3829
+ *
3830
+ *
3831
+ * Default: `0`
3832
+ */
3833
+ offset?: number;
3834
+ /**
3835
+ * Number of items to return.
3836
+ *
3837
+ *
3838
+ * Default:`50`
3839
+ * @min 1
3840
+ * @max 100
3841
+ */
3842
+ limit?: number;
3843
+ /**
3844
+ * Pointer to the next or previous page in the list of results.
3845
+ * @maxLength 2000
3846
+ */
3847
+ cursor?: string | null;
3848
+ }
3955
3849
  interface ListPostsResponse {
3956
3850
  /** List of retrieved posts. */
3957
3851
  posts?: Post[];
3958
3852
  /** Details on the paged set of results returned. */
3959
3853
  metaData?: MetaData;
3960
3854
  }
3855
+ interface MetaData {
3856
+ /** Number of items returned in this response. */
3857
+ count?: number;
3858
+ /** Requested offset. */
3859
+ offset?: number;
3860
+ /** Total number of items that match the query. */
3861
+ total?: number;
3862
+ /**
3863
+ * Pointer to the next or previous page in the list of results.
3864
+ * @maxLength 2000
3865
+ */
3866
+ cursor?: string | null;
3867
+ }
3961
3868
  interface QueryPostsRequest {
3962
3869
  /** Query options. */
3963
3870
  query?: PlatformQuery;
@@ -4316,6 +4223,99 @@ interface PostCount {
4316
4223
  /** Number of posts. */
4317
4224
  postCount?: number;
4318
4225
  }
4226
+ interface ListDemoPostsRequest {
4227
+ /**
4228
+ * Whether to return only featured posts.
4229
+ *
4230
+ * Default: `false`
4231
+ */
4232
+ featured?: boolean;
4233
+ /**
4234
+ * Hashtag filter.
4235
+ *
4236
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4237
+ * If omitted, all posts with or without hashtags are returned.
4238
+ * @maxSize 100
4239
+ * @maxLength 100
4240
+ */
4241
+ hashtags?: string[];
4242
+ /**
4243
+ * Category filter.
4244
+ *
4245
+ * Pass an array of category IDs to return only posts with any of the provided categories.
4246
+ * If omitted, all posts with or without associated categories are returned.
4247
+ * @maxSize 50
4248
+ * @format GUID
4249
+ */
4250
+ categoryIds?: string[];
4251
+ /**
4252
+ * Tag filter.
4253
+ *
4254
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
4255
+ * If omitted, all posts with or without tags are returned.
4256
+ * @maxSize 50
4257
+ * @format GUID
4258
+ */
4259
+ tagIds?: string[];
4260
+ /**
4261
+ * Sorting options.
4262
+ *
4263
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4264
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4265
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4266
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4267
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4268
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
4269
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
4270
+ * - `RATING`: reserved for internal use.
4271
+ *
4272
+ * Default: `FEED`
4273
+ */
4274
+ sort?: GetPostsSortWithLiterals;
4275
+ /** Pagination options. */
4276
+ paging?: BlogPaging;
4277
+ /**
4278
+ * __Deprecated.__ Use `fieldsets` instead.
4279
+ * This parameter will be removed on June 30, 2023.
4280
+ *
4281
+ * List of post fields to be included in the response.
4282
+ * @maxSize 20
4283
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
4284
+ * This parameter will be removed on June 30, 2023.
4285
+ *
4286
+ * List of post fields to be included in the response.
4287
+ * @replacedBy fieldsets
4288
+ * @targetRemovalDate 2024-06-30
4289
+ */
4290
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
4291
+ /**
4292
+ * Language filter.
4293
+ *
4294
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4295
+ * Pass a language to only receive posts that are in that language.
4296
+ * If omitted, posts in all languages are returned.
4297
+ * @format LANGUAGE_TAG
4298
+ */
4299
+ language?: string | null;
4300
+ /**
4301
+ * Post owner's member ID.
4302
+ * @format GUID
4303
+ */
4304
+ memberId?: string | null;
4305
+ /**
4306
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4307
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4308
+ * only the post’s base fields are returned.
4309
+ * @maxSize 20
4310
+ */
4311
+ fieldsets?: PostFieldFieldWithLiterals[];
4312
+ }
4313
+ interface ListDemoPostsResponse {
4314
+ /** List of posts. */
4315
+ posts?: Post[];
4316
+ /** Details on the paged set of results returned. */
4317
+ metaData?: MetaData;
4318
+ }
4319
4319
  interface BaseEventMetadata {
4320
4320
  /**
4321
4321
  * App instance ID.
@@ -1774,17 +1774,14 @@ var Order = /* @__PURE__ */ ((Order2) => {
1774
1774
  Order2["NEWEST"] = "NEWEST";
1775
1775
  return Order2;
1776
1776
  })(Order || {});
1777
- var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1778
- GetPostsSort2["FEED"] = "FEED";
1779
- GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1780
- GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1781
- GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1782
- GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1783
- GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1784
- GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1785
- GetPostsSort2["RATING"] = "RATING";
1786
- return GetPostsSort2;
1787
- })(GetPostsSort || {});
1777
+ var Field = /* @__PURE__ */ ((Field2) => {
1778
+ Field2["UNKNOWN"] = "UNKNOWN";
1779
+ Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1780
+ Field2["LIKE_COUNT"] = "LIKE_COUNT";
1781
+ Field2["VIEW_COUNT"] = "VIEW_COUNT";
1782
+ Field2["RATING_COUNT"] = "RATING_COUNT";
1783
+ return Field2;
1784
+ })(Field || {});
1788
1785
  var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1789
1786
  PostFieldField2["UNKNOWN"] = "UNKNOWN";
1790
1787
  PostFieldField2["COUNTERS"] = "COUNTERS";
@@ -1808,14 +1805,17 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1808
1805
  PostFieldField2["IMAGE"] = "IMAGE";
1809
1806
  return PostFieldField2;
1810
1807
  })(PostFieldField || {});
1811
- var Field = /* @__PURE__ */ ((Field2) => {
1812
- Field2["UNKNOWN"] = "UNKNOWN";
1813
- Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1814
- Field2["LIKE_COUNT"] = "LIKE_COUNT";
1815
- Field2["VIEW_COUNT"] = "VIEW_COUNT";
1816
- Field2["RATING_COUNT"] = "RATING_COUNT";
1817
- return Field2;
1818
- })(Field || {});
1808
+ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1809
+ GetPostsSort2["FEED"] = "FEED";
1810
+ GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1811
+ GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1812
+ GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1813
+ GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1814
+ GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1815
+ GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1816
+ GetPostsSort2["RATING"] = "RATING";
1817
+ return GetPostsSort2;
1818
+ })(GetPostsSort || {});
1819
1819
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
1820
1820
  SortOrder2["ASC"] = "ASC";
1821
1821
  SortOrder2["DESC"] = "DESC";