@wix/auto_sdk_blog_posts 1.0.192 → 1.0.193

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