@wix/auto_sdk_blog_posts 1.0.178 → 1.0.180

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.
Files changed (45) hide show
  1. package/build/cjs/index.js +19 -19
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +166 -166
  4. package/build/cjs/index.typings.js +19 -19
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +166 -166
  7. package/build/cjs/meta.js +19 -19
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.d.ts +2 -2
  10. package/build/cjs/schemas.js +450 -438
  11. package/build/cjs/schemas.js.map +1 -1
  12. package/build/es/index.mjs +19 -19
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +166 -166
  15. package/build/es/index.typings.mjs +19 -19
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +166 -166
  18. package/build/es/meta.mjs +19 -19
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/schemas.d.mts +2 -2
  21. package/build/es/schemas.mjs +450 -438
  22. package/build/es/schemas.mjs.map +1 -1
  23. package/build/internal/cjs/index.typings.d.ts +220 -220
  24. package/build/internal/cjs/meta.d.ts +220 -220
  25. package/build/internal/cjs/schemas.d.ts +2 -2
  26. package/build/internal/es/index.typings.d.mts +220 -220
  27. package/build/internal/es/meta.d.mts +220 -220
  28. package/build/internal/es/schemas.d.mts +2 -2
  29. package/package.json +2 -2
  30. package/build/internal/cjs/index.js +0 -2841
  31. package/build/internal/cjs/index.js.map +0 -1
  32. package/build/internal/cjs/index.typings.js +0 -2221
  33. package/build/internal/cjs/index.typings.js.map +0 -1
  34. package/build/internal/cjs/meta.js +0 -1975
  35. package/build/internal/cjs/meta.js.map +0 -1
  36. package/build/internal/cjs/schemas.js +0 -988
  37. package/build/internal/cjs/schemas.js.map +0 -1
  38. package/build/internal/es/index.mjs +0 -2734
  39. package/build/internal/es/index.mjs.map +0 -1
  40. package/build/internal/es/index.typings.mjs +0 -2118
  41. package/build/internal/es/index.typings.mjs.map +0 -1
  42. package/build/internal/es/meta.mjs +0 -1871
  43. package/build/internal/es/meta.mjs.map +0 -1
  44. package/build/internal/es/schemas.mjs +0 -938
  45. package/build/internal/es/schemas.mjs.map +0 -1
@@ -3725,62 +3725,91 @@ interface GetTotalPostsResponse {
3725
3725
  /** Total amount of published posts. */
3726
3726
  total?: number;
3727
3727
  }
3728
- interface ListDemoPostsRequest {
3728
+ interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3729
3729
  /**
3730
- * Whether to return only featured posts.
3731
- *
3732
- * Default: `false`
3730
+ * Member ID of person who triggered the counter update
3731
+ * @format GUID
3733
3732
  */
3734
- featured?: boolean;
3733
+ memberId?: string | null;
3735
3734
  /**
3736
- * Hashtag filter.
3737
- *
3738
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3739
- * If omitted, all posts with or without hashtags are returned.
3740
- * @maxSize 100
3741
- * @maxLength 100
3735
+ * Visitor ID if person that liked the post is not logged in
3736
+ * @format GUID
3742
3737
  */
3743
- hashtags?: string[];
3738
+ anonymousVisitorId?: string | null;
3744
3739
  /**
3745
- * Category filter.
3746
- *
3747
- * Pass an array of category IDs to return only posts with any of the provided categories.
3748
- * If omitted, all posts with or without associated categories are returned.
3749
- * @maxSize 50
3740
+ * ID of the post which counters were updated.
3750
3741
  * @format GUID
3751
3742
  */
3752
- categoryIds?: string[];
3743
+ postId?: string;
3753
3744
  /**
3754
- * Tag filter.
3755
- *
3756
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3757
- * If omitted, all posts with or without tags are returned.
3758
- * @maxSize 50
3745
+ * Internal ID of the post which counters were updated.
3746
+ * @internal
3747
+ * @maxLength 24
3748
+ */
3749
+ postInternalId?: string;
3750
+ /** Field of the updated counter. */
3751
+ updatedCounterField?: FieldWithLiterals;
3752
+ /** New counter value. */
3753
+ counter?: number;
3754
+ }
3755
+ /** @oneof */
3756
+ interface PostCountersUpdatedInitiatorOneOf {
3757
+ /**
3758
+ * Member ID of person who triggered the counter update
3759
3759
  * @format GUID
3760
3760
  */
3761
- tagIds?: string[];
3761
+ memberId?: string | null;
3762
3762
  /**
3763
- * Sorting options.
3764
- *
3765
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3766
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3767
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3768
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3769
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3770
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3771
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3772
- * - `RATING`: reserved for internal use.
3773
- *
3774
- * Default: `FEED`
3763
+ * Visitor ID if person that liked the post is not logged in
3764
+ * @format GUID
3775
3765
  */
3776
- sort?: GetPostsSortWithLiterals;
3777
- /** Pagination options. */
3778
- paging?: BlogPaging;
3766
+ anonymousVisitorId?: string | null;
3767
+ }
3768
+ declare enum Field {
3769
+ /** Undefined field. */
3770
+ UNKNOWN = "UNKNOWN",
3771
+ /** Total comments field. */
3772
+ TOTAL_COMMENTS = "TOTAL_COMMENTS",
3773
+ /** Like count field. */
3774
+ LIKE_COUNT = "LIKE_COUNT",
3775
+ /** View count field. */
3776
+ VIEW_COUNT = "VIEW_COUNT",
3777
+ /** Rating count field. */
3778
+ RATING_COUNT = "RATING_COUNT"
3779
+ }
3780
+ /** @enumType */
3781
+ type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
3782
+ interface PostOwnerChanged {
3783
+ /**
3784
+ * Member ID of the post's owner before the change.
3785
+ * @internal
3786
+ * @format GUID
3787
+ */
3788
+ oldMemberId?: string;
3789
+ /**
3790
+ * Member ID of the post's owner after the change.
3791
+ * @internal
3792
+ * @format GUID
3793
+ */
3794
+ newMemberId?: string;
3795
+ }
3796
+ interface InitialPostsCopied {
3797
+ /** Number of posts copied. */
3798
+ count?: number;
3799
+ }
3800
+ interface GetPostRequest {
3801
+ /**
3802
+ * Post ID.
3803
+ * @minLength 1
3804
+ * @maxLength 38
3805
+ */
3806
+ postId: string;
3779
3807
  /**
3780
3808
  * __Deprecated.__ Use `fieldsets` instead.
3781
3809
  * This parameter will be removed on June 30, 2023.
3782
3810
  *
3783
3811
  * List of post fields to be included in the response.
3812
+ * @internal
3784
3813
  * @maxSize 20
3785
3814
  * @deprecated __Deprecated.__ Use `fieldsets` instead.
3786
3815
  * This parameter will be removed on June 30, 2023.
@@ -3790,20 +3819,6 @@ interface ListDemoPostsRequest {
3790
3819
  * @targetRemovalDate 2024-06-30
3791
3820
  */
3792
3821
  fieldsToInclude?: PostFieldFieldWithLiterals[];
3793
- /**
3794
- * Language filter.
3795
- *
3796
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3797
- * Pass a language to only receive posts that are in that language.
3798
- * If omitted, posts in all languages are returned.
3799
- * @format LANGUAGE_TAG
3800
- */
3801
- language?: string | null;
3802
- /**
3803
- * Post owner's member ID.
3804
- * @format GUID
3805
- */
3806
- memberId?: string | null;
3807
3822
  /**
3808
3823
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3809
3824
  * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
@@ -3812,52 +3827,6 @@ interface ListDemoPostsRequest {
3812
3827
  */
3813
3828
  fieldsets?: PostFieldFieldWithLiterals[];
3814
3829
  }
3815
- declare enum GetPostsSort {
3816
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3817
- FEED = "FEED",
3818
- /** Ordered by `firstPublishedDate` in ascending order. */
3819
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3820
- /** Ordered by `firstPublishedDate` in descending order. */
3821
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3822
- /** Ordered by total number of views in descending order. */
3823
- VIEW_COUNT = "VIEW_COUNT",
3824
- /** Ordered by total number of likes in descending order. */
3825
- LIKE_COUNT = "LIKE_COUNT",
3826
- /** Ordered by `title` in ascending order. */
3827
- TITLE_ASC = "TITLE_ASC",
3828
- /** Ordered by `title` in descending order. */
3829
- TITLE_DESC = "TITLE_DESC",
3830
- /**
3831
- * Sorting by post rating descending.
3832
- * @internal
3833
- */
3834
- RATING = "RATING"
3835
- }
3836
- /** @enumType */
3837
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3838
- interface BlogPaging {
3839
- /**
3840
- * Number of items to skip in the current sort order.
3841
- *
3842
- *
3843
- * Default: `0`
3844
- */
3845
- offset?: number;
3846
- /**
3847
- * Number of items to return.
3848
- *
3849
- *
3850
- * Default:`50`
3851
- * @min 1
3852
- * @max 100
3853
- */
3854
- limit?: 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
3830
  declare enum PostFieldField {
3862
3831
  UNKNOWN = "UNKNOWN",
3863
3832
  /**
@@ -3939,127 +3908,6 @@ declare enum PostFieldField {
3939
3908
  }
3940
3909
  /** @enumType */
3941
3910
  type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3942
- interface ListDemoPostsResponse {
3943
- /** List of posts. */
3944
- posts?: Post[];
3945
- /** Details on the paged set of results returned. */
3946
- metaData?: MetaData;
3947
- }
3948
- interface MetaData {
3949
- /** Number of items returned in this response. */
3950
- count?: number;
3951
- /** Requested offset. */
3952
- offset?: number;
3953
- /** Total number of items that match the query. */
3954
- total?: number;
3955
- /**
3956
- * Pointer to the next or previous page in the list of results.
3957
- * @maxLength 2000
3958
- */
3959
- cursor?: string | null;
3960
- }
3961
- interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3962
- /**
3963
- * Member ID of person who triggered the counter update
3964
- * @format GUID
3965
- */
3966
- memberId?: string | null;
3967
- /**
3968
- * Visitor ID if person that liked the post is not logged in
3969
- * @format GUID
3970
- */
3971
- anonymousVisitorId?: string | null;
3972
- /**
3973
- * ID of the post which counters were updated.
3974
- * @format GUID
3975
- */
3976
- postId?: string;
3977
- /**
3978
- * Internal ID of the post which counters were updated.
3979
- * @internal
3980
- * @maxLength 24
3981
- */
3982
- postInternalId?: string;
3983
- /** Field of the updated counter. */
3984
- updatedCounterField?: FieldWithLiterals;
3985
- /** New counter value. */
3986
- counter?: number;
3987
- }
3988
- /** @oneof */
3989
- interface PostCountersUpdatedInitiatorOneOf {
3990
- /**
3991
- * Member ID of person who triggered the counter update
3992
- * @format GUID
3993
- */
3994
- memberId?: string | null;
3995
- /**
3996
- * Visitor ID if person that liked the post is not logged in
3997
- * @format GUID
3998
- */
3999
- anonymousVisitorId?: string | null;
4000
- }
4001
- declare enum Field {
4002
- /** Undefined field. */
4003
- UNKNOWN = "UNKNOWN",
4004
- /** Total comments field. */
4005
- TOTAL_COMMENTS = "TOTAL_COMMENTS",
4006
- /** Like count field. */
4007
- LIKE_COUNT = "LIKE_COUNT",
4008
- /** View count field. */
4009
- VIEW_COUNT = "VIEW_COUNT",
4010
- /** Rating count field. */
4011
- RATING_COUNT = "RATING_COUNT"
4012
- }
4013
- /** @enumType */
4014
- type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
4015
- interface PostOwnerChanged {
4016
- /**
4017
- * Member ID of the post's owner before the change.
4018
- * @internal
4019
- * @format GUID
4020
- */
4021
- oldMemberId?: string;
4022
- /**
4023
- * Member ID of the post's owner after the change.
4024
- * @internal
4025
- * @format GUID
4026
- */
4027
- newMemberId?: string;
4028
- }
4029
- interface InitialPostsCopied {
4030
- /** Number of posts copied. */
4031
- count?: number;
4032
- }
4033
- interface GetPostRequest {
4034
- /**
4035
- * Post ID.
4036
- * @minLength 1
4037
- * @maxLength 38
4038
- */
4039
- postId: string;
4040
- /**
4041
- * __Deprecated.__ Use `fieldsets` instead.
4042
- * This parameter will be removed on June 30, 2023.
4043
- *
4044
- * List of post fields to be included in the response.
4045
- * @internal
4046
- * @maxSize 20
4047
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4048
- * This parameter will be removed on June 30, 2023.
4049
- *
4050
- * List of post fields to be included in the response.
4051
- * @replacedBy fieldsets
4052
- * @targetRemovalDate 2024-06-30
4053
- */
4054
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4055
- /**
4056
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4057
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4058
- * only the post’s base fields are returned.
4059
- * @maxSize 20
4060
- */
4061
- fieldsets?: PostFieldFieldWithLiterals[];
4062
- }
4063
3911
  interface GetPostResponse {
4064
3912
  /** Retrieved post info. */
4065
3913
  post?: Post;
@@ -4182,12 +4030,71 @@ interface ListPostsRequest {
4182
4030
  */
4183
4031
  fieldsets?: PostFieldFieldWithLiterals[];
4184
4032
  }
4033
+ declare enum GetPostsSort {
4034
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
4035
+ FEED = "FEED",
4036
+ /** Ordered by `firstPublishedDate` in ascending order. */
4037
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
4038
+ /** Ordered by `firstPublishedDate` in descending order. */
4039
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
4040
+ /** Ordered by total number of views in descending order. */
4041
+ VIEW_COUNT = "VIEW_COUNT",
4042
+ /** Ordered by total number of likes in descending order. */
4043
+ LIKE_COUNT = "LIKE_COUNT",
4044
+ /** Ordered by `title` in ascending order. */
4045
+ TITLE_ASC = "TITLE_ASC",
4046
+ /** Ordered by `title` in descending order. */
4047
+ TITLE_DESC = "TITLE_DESC",
4048
+ /**
4049
+ * Sorting by post rating descending.
4050
+ * @internal
4051
+ */
4052
+ RATING = "RATING"
4053
+ }
4054
+ /** @enumType */
4055
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
4056
+ interface BlogPaging {
4057
+ /**
4058
+ * Number of items to skip in the current sort order.
4059
+ *
4060
+ *
4061
+ * Default: `0`
4062
+ */
4063
+ offset?: number;
4064
+ /**
4065
+ * Number of items to return.
4066
+ *
4067
+ *
4068
+ * Default:`50`
4069
+ * @min 1
4070
+ * @max 100
4071
+ */
4072
+ limit?: number;
4073
+ /**
4074
+ * Pointer to the next or previous page in the list of results.
4075
+ * @maxLength 2000
4076
+ */
4077
+ cursor?: string | null;
4078
+ }
4185
4079
  interface ListPostsResponse {
4186
4080
  /** List of retrieved posts. */
4187
4081
  posts?: Post[];
4188
4082
  /** Details on the paged set of results returned. */
4189
4083
  metaData?: MetaData;
4190
4084
  }
4085
+ interface MetaData {
4086
+ /** Number of items returned in this response. */
4087
+ count?: number;
4088
+ /** Requested offset. */
4089
+ offset?: number;
4090
+ /** Total number of items that match the query. */
4091
+ total?: number;
4092
+ /**
4093
+ * Pointer to the next or previous page in the list of results.
4094
+ * @maxLength 2000
4095
+ */
4096
+ cursor?: string | null;
4097
+ }
4191
4098
  interface QueryPostsRequest {
4192
4099
  /**
4193
4100
  * __Deprecated.__ Use `query` instead.
@@ -4639,6 +4546,99 @@ interface PostCount {
4639
4546
  /** Number of posts. */
4640
4547
  postCount?: number;
4641
4548
  }
4549
+ interface ListDemoPostsRequest {
4550
+ /**
4551
+ * Whether to return only featured posts.
4552
+ *
4553
+ * Default: `false`
4554
+ */
4555
+ featured?: boolean;
4556
+ /**
4557
+ * Hashtag filter.
4558
+ *
4559
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4560
+ * If omitted, all posts with or without hashtags are returned.
4561
+ * @maxSize 100
4562
+ * @maxLength 100
4563
+ */
4564
+ hashtags?: string[];
4565
+ /**
4566
+ * Category filter.
4567
+ *
4568
+ * Pass an array of category IDs to return only posts with any of the provided categories.
4569
+ * If omitted, all posts with or without associated categories are returned.
4570
+ * @maxSize 50
4571
+ * @format GUID
4572
+ */
4573
+ categoryIds?: string[];
4574
+ /**
4575
+ * Tag filter.
4576
+ *
4577
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
4578
+ * If omitted, all posts with or without tags are returned.
4579
+ * @maxSize 50
4580
+ * @format GUID
4581
+ */
4582
+ tagIds?: string[];
4583
+ /**
4584
+ * Sorting options.
4585
+ *
4586
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4587
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4588
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4589
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4590
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4591
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
4592
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
4593
+ * - `RATING`: reserved for internal use.
4594
+ *
4595
+ * Default: `FEED`
4596
+ */
4597
+ sort?: GetPostsSortWithLiterals;
4598
+ /** Pagination options. */
4599
+ paging?: BlogPaging;
4600
+ /**
4601
+ * __Deprecated.__ Use `fieldsets` instead.
4602
+ * This parameter will be removed on June 30, 2023.
4603
+ *
4604
+ * List of post fields to be included in the response.
4605
+ * @maxSize 20
4606
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
4607
+ * This parameter will be removed on June 30, 2023.
4608
+ *
4609
+ * List of post fields to be included in the response.
4610
+ * @replacedBy fieldsets
4611
+ * @targetRemovalDate 2024-06-30
4612
+ */
4613
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
4614
+ /**
4615
+ * Language filter.
4616
+ *
4617
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4618
+ * Pass a language to only receive posts that are in that language.
4619
+ * If omitted, posts in all languages are returned.
4620
+ * @format LANGUAGE_TAG
4621
+ */
4622
+ language?: string | null;
4623
+ /**
4624
+ * Post owner's member ID.
4625
+ * @format GUID
4626
+ */
4627
+ memberId?: string | null;
4628
+ /**
4629
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4630
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4631
+ * only the post’s base fields are returned.
4632
+ * @maxSize 20
4633
+ */
4634
+ fieldsets?: PostFieldFieldWithLiterals[];
4635
+ }
4636
+ interface ListDemoPostsResponse {
4637
+ /** List of posts. */
4638
+ posts?: Post[];
4639
+ /** Details on the paged set of results returned. */
4640
+ metaData?: MetaData;
4641
+ }
4642
4642
  interface BaseEventMetadata {
4643
4643
  /**
4644
4644
  * App instance ID.