@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.
@@ -3664,6 +3664,172 @@ interface GetTotalPostsResponse {
3664
3664
  /** Total amount of published posts. */
3665
3665
  total?: number;
3666
3666
  }
3667
+ interface ListDemoPostsRequest {
3668
+ /**
3669
+ * Whether to return only featured posts.
3670
+ *
3671
+ * Default: `false`
3672
+ */
3673
+ featured?: boolean;
3674
+ /**
3675
+ * Hashtag filter.
3676
+ *
3677
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3678
+ * If omitted, all posts with or without hashtags are returned.
3679
+ * @maxSize 100
3680
+ * @maxLength 100
3681
+ */
3682
+ hashtags?: string[];
3683
+ /**
3684
+ * Category filter.
3685
+ *
3686
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3687
+ * If omitted, all posts with or without associated categories are returned.
3688
+ * @maxSize 50
3689
+ * @format GUID
3690
+ */
3691
+ categoryIds?: string[];
3692
+ /**
3693
+ * Tag filter.
3694
+ *
3695
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3696
+ * If omitted, all posts with or without tags are returned.
3697
+ * @maxSize 50
3698
+ * @format GUID
3699
+ */
3700
+ tagIds?: string[];
3701
+ /**
3702
+ * Sorting options.
3703
+ *
3704
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3705
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3706
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3707
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3708
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3709
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3710
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3711
+ * - `RATING`: reserved for internal use.
3712
+ *
3713
+ * Default: `FEED`
3714
+ */
3715
+ sort?: GetPostsSortWithLiterals;
3716
+ /** Pagination options. */
3717
+ paging?: BlogPaging;
3718
+ /**
3719
+ * __Deprecated.__ Use `fieldsets` instead.
3720
+ * This parameter will be removed on June 30, 2023.
3721
+ *
3722
+ * List of post fields to be included in the response.
3723
+ * @maxSize 20
3724
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3725
+ * This parameter will be removed on June 30, 2023.
3726
+ *
3727
+ * List of post fields to be included in the response.
3728
+ * @replacedBy fieldsets
3729
+ * @targetRemovalDate 2024-06-30
3730
+ */
3731
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3732
+ /**
3733
+ * Language filter.
3734
+ *
3735
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3736
+ * Pass a language to only receive posts that are in that language.
3737
+ * If omitted, posts in all languages are returned.
3738
+ * @format LANGUAGE_TAG
3739
+ */
3740
+ language?: string | null;
3741
+ /**
3742
+ * Post owner's member ID.
3743
+ * @format GUID
3744
+ */
3745
+ memberId?: string | null;
3746
+ /**
3747
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3748
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3749
+ * only the post’s base fields are returned.
3750
+ * @maxSize 20
3751
+ */
3752
+ fieldsets?: PostFieldFieldWithLiterals[];
3753
+ }
3754
+ declare enum GetPostsSort {
3755
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3756
+ FEED = "FEED",
3757
+ /** Ordered by `firstPublishedDate` in ascending order. */
3758
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3759
+ /** Ordered by `firstPublishedDate` in descending order. */
3760
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3761
+ /** Ordered by total number of views in descending order. */
3762
+ VIEW_COUNT = "VIEW_COUNT",
3763
+ /** Ordered by total number of likes in descending order. */
3764
+ LIKE_COUNT = "LIKE_COUNT",
3765
+ /** Ordered by `title` in ascending order. */
3766
+ TITLE_ASC = "TITLE_ASC",
3767
+ /** Ordered by `title` in descending order. */
3768
+ TITLE_DESC = "TITLE_DESC"
3769
+ }
3770
+ /** @enumType */
3771
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3772
+ interface BlogPaging {
3773
+ /**
3774
+ * Number of items to skip in the current sort order.
3775
+ *
3776
+ *
3777
+ * Default: `0`
3778
+ */
3779
+ offset?: number;
3780
+ /**
3781
+ * Number of items to return.
3782
+ *
3783
+ *
3784
+ * Default:`50`
3785
+ * @min 1
3786
+ * @max 100
3787
+ */
3788
+ limit?: number;
3789
+ /**
3790
+ * Pointer to the next or previous page in the list of results.
3791
+ * @maxLength 2000
3792
+ */
3793
+ cursor?: string | null;
3794
+ }
3795
+ declare enum PostFieldField {
3796
+ UNKNOWN = "UNKNOWN",
3797
+ /** Includes post URL when present. */
3798
+ URL = "URL",
3799
+ /** Includes post content text string when present. */
3800
+ CONTENT_TEXT = "CONTENT_TEXT",
3801
+ /** Includes post metrics when present. */
3802
+ METRICS = "METRICS",
3803
+ /** Includes SEO data. */
3804
+ SEO = "SEO",
3805
+ /** Includes post owner's contact ID. */
3806
+ CONTACT_ID = "CONTACT_ID",
3807
+ /** Includes post rich content. */
3808
+ RICH_CONTENT = "RICH_CONTENT",
3809
+ /** Includes post reference ID field. */
3810
+ REFERENCE_ID = "REFERENCE_ID"
3811
+ }
3812
+ /** @enumType */
3813
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3814
+ interface ListDemoPostsResponse {
3815
+ /** List of posts. */
3816
+ posts?: Post[];
3817
+ /** Details on the paged set of results returned. */
3818
+ metaData?: MetaData;
3819
+ }
3820
+ interface MetaData {
3821
+ /** Number of items returned in this response. */
3822
+ count?: number;
3823
+ /** Requested offset. */
3824
+ offset?: number;
3825
+ /** Total number of items that match the query. */
3826
+ total?: number;
3827
+ /**
3828
+ * Pointer to the next or previous page in the list of results.
3829
+ * @maxLength 2000
3830
+ */
3831
+ cursor?: string | null;
3832
+ }
3667
3833
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3668
3834
  /**
3669
3835
  * Member ID of person who triggered the counter update
@@ -3733,25 +3899,6 @@ interface GetPostRequest {
3733
3899
  */
3734
3900
  fieldsets?: PostFieldFieldWithLiterals[];
3735
3901
  }
3736
- declare enum PostFieldField {
3737
- UNKNOWN = "UNKNOWN",
3738
- /** Includes post URL when present. */
3739
- URL = "URL",
3740
- /** Includes post content text string when present. */
3741
- CONTENT_TEXT = "CONTENT_TEXT",
3742
- /** Includes post metrics when present. */
3743
- METRICS = "METRICS",
3744
- /** Includes SEO data. */
3745
- SEO = "SEO",
3746
- /** Includes post owner's contact ID. */
3747
- CONTACT_ID = "CONTACT_ID",
3748
- /** Includes post rich content. */
3749
- RICH_CONTENT = "RICH_CONTENT",
3750
- /** Includes post reference ID field. */
3751
- REFERENCE_ID = "REFERENCE_ID"
3752
- }
3753
- /** @enumType */
3754
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3755
3902
  interface GetPostResponse {
3756
3903
  /** Retrieved post info. */
3757
3904
  post?: Post;
@@ -3844,66 +3991,12 @@ interface ListPostsRequest {
3844
3991
  */
3845
3992
  fieldsets?: PostFieldFieldWithLiterals[];
3846
3993
  }
3847
- declare enum GetPostsSort {
3848
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3849
- FEED = "FEED",
3850
- /** Ordered by `firstPublishedDate` in ascending order. */
3851
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3852
- /** Ordered by `firstPublishedDate` in descending order. */
3853
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3854
- /** Ordered by total number of views in descending order. */
3855
- VIEW_COUNT = "VIEW_COUNT",
3856
- /** Ordered by total number of likes in descending order. */
3857
- LIKE_COUNT = "LIKE_COUNT",
3858
- /** Ordered by `title` in ascending order. */
3859
- TITLE_ASC = "TITLE_ASC",
3860
- /** Ordered by `title` in descending order. */
3861
- TITLE_DESC = "TITLE_DESC"
3862
- }
3863
- /** @enumType */
3864
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3865
- interface BlogPaging {
3866
- /**
3867
- * Number of items to skip in the current sort order.
3868
- *
3869
- *
3870
- * Default: `0`
3871
- */
3872
- offset?: number;
3873
- /**
3874
- * Number of items to return.
3875
- *
3876
- *
3877
- * Default:`50`
3878
- * @min 1
3879
- * @max 100
3880
- */
3881
- limit?: number;
3882
- /**
3883
- * Pointer to the next or previous page in the list of results.
3884
- * @maxLength 2000
3885
- */
3886
- cursor?: string | null;
3887
- }
3888
3994
  interface ListPostsResponse {
3889
3995
  /** List of retrieved posts. */
3890
3996
  posts?: Post[];
3891
3997
  /** Details on the paged set of results returned. */
3892
3998
  metaData?: MetaData;
3893
3999
  }
3894
- interface MetaData {
3895
- /** Number of items returned in this response. */
3896
- count?: number;
3897
- /** Requested offset. */
3898
- offset?: number;
3899
- /** Total number of items that match the query. */
3900
- total?: number;
3901
- /**
3902
- * Pointer to the next or previous page in the list of results.
3903
- * @maxLength 2000
3904
- */
3905
- cursor?: string | null;
3906
- }
3907
4000
  interface QueryPostsRequest {
3908
4001
  /** Query options. */
3909
4002
  query?: PlatformQuery;
@@ -4262,99 +4355,6 @@ interface PostCount {
4262
4355
  /** Number of posts. */
4263
4356
  postCount?: number;
4264
4357
  }
4265
- interface ListDemoPostsRequest {
4266
- /**
4267
- * Whether to return only featured posts.
4268
- *
4269
- * Default: `false`
4270
- */
4271
- featured?: boolean;
4272
- /**
4273
- * Hashtag filter.
4274
- *
4275
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4276
- * If omitted, all posts with or without hashtags are returned.
4277
- * @maxSize 100
4278
- * @maxLength 100
4279
- */
4280
- hashtags?: string[];
4281
- /**
4282
- * Category filter.
4283
- *
4284
- * Pass an array of category IDs to return only posts with any of the provided categories.
4285
- * If omitted, all posts with or without associated categories are returned.
4286
- * @maxSize 50
4287
- * @format GUID
4288
- */
4289
- categoryIds?: string[];
4290
- /**
4291
- * Tag filter.
4292
- *
4293
- * Pass an array of tag IDs to return only posts with any of the provided tags.
4294
- * If omitted, all posts with or without tags are returned.
4295
- * @maxSize 50
4296
- * @format GUID
4297
- */
4298
- tagIds?: string[];
4299
- /**
4300
- * Sorting options.
4301
- *
4302
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4303
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4304
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4305
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4306
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4307
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
4308
- * - `TITLE_DESC`: Ordered by `title` in descending order.
4309
- * - `RATING`: reserved for internal use.
4310
- *
4311
- * Default: `FEED`
4312
- */
4313
- sort?: GetPostsSortWithLiterals;
4314
- /** Pagination options. */
4315
- paging?: BlogPaging;
4316
- /**
4317
- * __Deprecated.__ Use `fieldsets` instead.
4318
- * This parameter will be removed on June 30, 2023.
4319
- *
4320
- * List of post fields to be included in the response.
4321
- * @maxSize 20
4322
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4323
- * This parameter will be removed on June 30, 2023.
4324
- *
4325
- * List of post fields to be included in the response.
4326
- * @replacedBy fieldsets
4327
- * @targetRemovalDate 2024-06-30
4328
- */
4329
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4330
- /**
4331
- * Language filter.
4332
- *
4333
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4334
- * Pass a language to only receive posts that are in that language.
4335
- * If omitted, posts in all languages are returned.
4336
- * @format LANGUAGE_TAG
4337
- */
4338
- language?: string | null;
4339
- /**
4340
- * Post owner's member ID.
4341
- * @format GUID
4342
- */
4343
- memberId?: string | null;
4344
- /**
4345
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4346
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4347
- * only the post’s base fields are returned.
4348
- * @maxSize 20
4349
- */
4350
- fieldsets?: PostFieldFieldWithLiterals[];
4351
- }
4352
- interface ListDemoPostsResponse {
4353
- /** List of posts. */
4354
- posts?: Post[];
4355
- /** Details on the paged set of results returned. */
4356
- metaData?: MetaData;
4357
- }
4358
4358
 
4359
4359
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4360
4360
  getUrl: (context: any) => string;
package/build/es/meta.mjs CHANGED
@@ -1638,14 +1638,17 @@ var Order = /* @__PURE__ */ ((Order2) => {
1638
1638
  Order2["NEWEST"] = "NEWEST";
1639
1639
  return Order2;
1640
1640
  })(Order || {});
1641
- var Field = /* @__PURE__ */ ((Field2) => {
1642
- Field2["UNKNOWN"] = "UNKNOWN";
1643
- Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1644
- Field2["LIKE_COUNT"] = "LIKE_COUNT";
1645
- Field2["VIEW_COUNT"] = "VIEW_COUNT";
1646
- Field2["RATING_COUNT"] = "RATING_COUNT";
1647
- return Field2;
1648
- })(Field || {});
1641
+ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1642
+ GetPostsSort2["FEED"] = "FEED";
1643
+ GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1644
+ GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1645
+ GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1646
+ GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1647
+ GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1648
+ GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1649
+ GetPostsSort2["RATING"] = "RATING";
1650
+ return GetPostsSort2;
1651
+ })(GetPostsSort || {});
1649
1652
  var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1650
1653
  PostFieldField2["UNKNOWN"] = "UNKNOWN";
1651
1654
  PostFieldField2["COUNTERS"] = "COUNTERS";
@@ -1669,17 +1672,14 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1669
1672
  PostFieldField2["IMAGE"] = "IMAGE";
1670
1673
  return PostFieldField2;
1671
1674
  })(PostFieldField || {});
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 || {});
1675
+ var Field = /* @__PURE__ */ ((Field2) => {
1676
+ Field2["UNKNOWN"] = "UNKNOWN";
1677
+ Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1678
+ Field2["LIKE_COUNT"] = "LIKE_COUNT";
1679
+ Field2["VIEW_COUNT"] = "VIEW_COUNT";
1680
+ Field2["RATING_COUNT"] = "RATING_COUNT";
1681
+ return Field2;
1682
+ })(Field || {});
1683
1683
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
1684
1684
  SortOrder2["ASC"] = "ASC";
1685
1685
  SortOrder2["DESC"] = "DESC";