@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.
@@ -3957,91 +3957,62 @@ interface GetTotalPostsResponse {
3957
3957
  /** Total amount of published posts. */
3958
3958
  total?: number;
3959
3959
  }
3960
- interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3961
- /**
3962
- * Member ID of person who triggered the counter update
3963
- * @format GUID
3964
- */
3965
- memberId?: string | null;
3966
- /**
3967
- * Visitor ID if person that liked the post is not logged in
3968
- * @format GUID
3969
- */
3970
- anonymousVisitorId?: string | null;
3971
- /**
3972
- * ID of the post which counters were updated.
3973
- * @format GUID
3974
- */
3975
- postId?: string;
3976
- /**
3977
- * Internal ID of the post which counters were updated.
3978
- * @internal
3979
- * @maxLength 24
3980
- */
3981
- postInternalId?: string;
3982
- /** Field of the updated counter. */
3983
- updatedCounterField?: FieldWithLiterals;
3984
- /** New counter value. */
3985
- counter?: number;
3986
- }
3987
- /** @oneof */
3988
- interface PostCountersUpdatedInitiatorOneOf {
3960
+ interface ListDemoPostsRequest {
3989
3961
  /**
3990
- * Member ID of person who triggered the counter update
3991
- * @format GUID
3962
+ * Whether to return only featured posts.
3963
+ *
3964
+ * Default: `false`
3992
3965
  */
3993
- memberId?: string | null;
3966
+ featured?: boolean;
3994
3967
  /**
3995
- * Visitor ID if person that liked the post is not logged in
3996
- * @format GUID
3968
+ * Hashtag filter.
3969
+ *
3970
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3971
+ * If omitted, all posts with or without hashtags are returned.
3972
+ * @maxSize 100
3973
+ * @maxLength 100
3997
3974
  */
3998
- anonymousVisitorId?: string | null;
3999
- }
4000
- declare enum Field {
4001
- /** Undefined field. */
4002
- UNKNOWN = "UNKNOWN",
4003
- /** Total comments field. */
4004
- TOTAL_COMMENTS = "TOTAL_COMMENTS",
4005
- /** Like count field. */
4006
- LIKE_COUNT = "LIKE_COUNT",
4007
- /** View count field. */
4008
- VIEW_COUNT = "VIEW_COUNT",
4009
- /** Rating count field. */
4010
- RATING_COUNT = "RATING_COUNT"
4011
- }
4012
- /** @enumType */
4013
- type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
4014
- interface PostOwnerChanged {
3975
+ hashtags?: string[];
4015
3976
  /**
4016
- * Member ID of the post's owner before the change.
4017
- * @internal
3977
+ * Category filter.
3978
+ *
3979
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3980
+ * If omitted, all posts with or without associated categories are returned.
3981
+ * @maxSize 50
4018
3982
  * @format GUID
4019
3983
  */
4020
- oldMemberId?: string;
3984
+ categoryIds?: string[];
4021
3985
  /**
4022
- * Member ID of the post's owner after the change.
4023
- * @internal
3986
+ * Tag filter.
3987
+ *
3988
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3989
+ * If omitted, all posts with or without tags are returned.
3990
+ * @maxSize 50
4024
3991
  * @format GUID
4025
3992
  */
4026
- newMemberId?: string;
4027
- }
4028
- interface InitialPostsCopied {
4029
- /** Number of posts copied. */
4030
- count?: number;
4031
- }
4032
- interface GetPostRequest {
3993
+ tagIds?: string[];
4033
3994
  /**
4034
- * Post ID.
4035
- * @minLength 1
4036
- * @maxLength 38
3995
+ * Sorting options.
3996
+ *
3997
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3998
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3999
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4000
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4001
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4002
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
4003
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
4004
+ * - `RATING`: reserved for internal use.
4005
+ *
4006
+ * Default: `FEED`
4037
4007
  */
4038
- postId: string;
4008
+ sort?: GetPostsSortWithLiterals;
4009
+ /** Pagination options. */
4010
+ paging?: BlogPaging;
4039
4011
  /**
4040
4012
  * __Deprecated.__ Use `fieldsets` instead.
4041
4013
  * This parameter will be removed on June 30, 2023.
4042
4014
  *
4043
4015
  * List of post fields to be included in the response.
4044
- * @internal
4045
4016
  * @maxSize 20
4046
4017
  * @deprecated __Deprecated.__ Use `fieldsets` instead.
4047
4018
  * This parameter will be removed on June 30, 2023.
@@ -4051,6 +4022,20 @@ interface GetPostRequest {
4051
4022
  * @targetRemovalDate 2024-06-30
4052
4023
  */
4053
4024
  fieldsToInclude?: PostFieldFieldWithLiterals[];
4025
+ /**
4026
+ * Language filter.
4027
+ *
4028
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4029
+ * Pass a language to only receive posts that are in that language.
4030
+ * If omitted, posts in all languages are returned.
4031
+ * @format LANGUAGE_TAG
4032
+ */
4033
+ language?: string | null;
4034
+ /**
4035
+ * Post owner's member ID.
4036
+ * @format GUID
4037
+ */
4038
+ memberId?: string | null;
4054
4039
  /**
4055
4040
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4056
4041
  * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
@@ -4059,6 +4044,52 @@ interface GetPostRequest {
4059
4044
  */
4060
4045
  fieldsets?: PostFieldFieldWithLiterals[];
4061
4046
  }
4047
+ declare enum GetPostsSort {
4048
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
4049
+ FEED = "FEED",
4050
+ /** Ordered by `firstPublishedDate` in ascending order. */
4051
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
4052
+ /** Ordered by `firstPublishedDate` in descending order. */
4053
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
4054
+ /** Ordered by total number of views in descending order. */
4055
+ VIEW_COUNT = "VIEW_COUNT",
4056
+ /** Ordered by total number of likes in descending order. */
4057
+ LIKE_COUNT = "LIKE_COUNT",
4058
+ /** Ordered by `title` in ascending order. */
4059
+ TITLE_ASC = "TITLE_ASC",
4060
+ /** Ordered by `title` in descending order. */
4061
+ TITLE_DESC = "TITLE_DESC",
4062
+ /**
4063
+ * Sorting by post rating descending.
4064
+ * @internal
4065
+ */
4066
+ RATING = "RATING"
4067
+ }
4068
+ /** @enumType */
4069
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
4070
+ interface BlogPaging {
4071
+ /**
4072
+ * Number of items to skip in the current sort order.
4073
+ *
4074
+ *
4075
+ * Default: `0`
4076
+ */
4077
+ offset?: number;
4078
+ /**
4079
+ * Number of items to return.
4080
+ *
4081
+ *
4082
+ * Default:`50`
4083
+ * @min 1
4084
+ * @max 100
4085
+ */
4086
+ limit?: number;
4087
+ /**
4088
+ * Pointer to the next or previous page in the list of results.
4089
+ * @maxLength 2000
4090
+ */
4091
+ cursor?: string | null;
4092
+ }
4062
4093
  declare enum PostFieldField {
4063
4094
  UNKNOWN = "UNKNOWN",
4064
4095
  /**
@@ -4140,6 +4171,127 @@ declare enum PostFieldField {
4140
4171
  }
4141
4172
  /** @enumType */
4142
4173
  type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
4174
+ interface ListDemoPostsResponse {
4175
+ /** List of posts. */
4176
+ posts?: Post[];
4177
+ /** Details on the paged set of results returned. */
4178
+ metaData?: MetaData;
4179
+ }
4180
+ interface MetaData {
4181
+ /** Number of items returned in this response. */
4182
+ count?: number;
4183
+ /** Requested offset. */
4184
+ offset?: number;
4185
+ /** Total number of items that match the query. */
4186
+ total?: number;
4187
+ /**
4188
+ * Pointer to the next or previous page in the list of results.
4189
+ * @maxLength 2000
4190
+ */
4191
+ cursor?: string | null;
4192
+ }
4193
+ interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
4194
+ /**
4195
+ * Member ID of person who triggered the counter update
4196
+ * @format GUID
4197
+ */
4198
+ memberId?: string | null;
4199
+ /**
4200
+ * Visitor ID if person that liked the post is not logged in
4201
+ * @format GUID
4202
+ */
4203
+ anonymousVisitorId?: string | null;
4204
+ /**
4205
+ * ID of the post which counters were updated.
4206
+ * @format GUID
4207
+ */
4208
+ postId?: string;
4209
+ /**
4210
+ * Internal ID of the post which counters were updated.
4211
+ * @internal
4212
+ * @maxLength 24
4213
+ */
4214
+ postInternalId?: string;
4215
+ /** Field of the updated counter. */
4216
+ updatedCounterField?: FieldWithLiterals;
4217
+ /** New counter value. */
4218
+ counter?: number;
4219
+ }
4220
+ /** @oneof */
4221
+ interface PostCountersUpdatedInitiatorOneOf {
4222
+ /**
4223
+ * Member ID of person who triggered the counter update
4224
+ * @format GUID
4225
+ */
4226
+ memberId?: string | null;
4227
+ /**
4228
+ * Visitor ID if person that liked the post is not logged in
4229
+ * @format GUID
4230
+ */
4231
+ anonymousVisitorId?: string | null;
4232
+ }
4233
+ declare enum Field {
4234
+ /** Undefined field. */
4235
+ UNKNOWN = "UNKNOWN",
4236
+ /** Total comments field. */
4237
+ TOTAL_COMMENTS = "TOTAL_COMMENTS",
4238
+ /** Like count field. */
4239
+ LIKE_COUNT = "LIKE_COUNT",
4240
+ /** View count field. */
4241
+ VIEW_COUNT = "VIEW_COUNT",
4242
+ /** Rating count field. */
4243
+ RATING_COUNT = "RATING_COUNT"
4244
+ }
4245
+ /** @enumType */
4246
+ type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
4247
+ interface PostOwnerChanged {
4248
+ /**
4249
+ * Member ID of the post's owner before the change.
4250
+ * @internal
4251
+ * @format GUID
4252
+ */
4253
+ oldMemberId?: string;
4254
+ /**
4255
+ * Member ID of the post's owner after the change.
4256
+ * @internal
4257
+ * @format GUID
4258
+ */
4259
+ newMemberId?: string;
4260
+ }
4261
+ interface InitialPostsCopied {
4262
+ /** Number of posts copied. */
4263
+ count?: number;
4264
+ }
4265
+ interface GetPostRequest {
4266
+ /**
4267
+ * Post ID.
4268
+ * @minLength 1
4269
+ * @maxLength 38
4270
+ */
4271
+ postId: string;
4272
+ /**
4273
+ * __Deprecated.__ Use `fieldsets` instead.
4274
+ * This parameter will be removed on June 30, 2023.
4275
+ *
4276
+ * List of post fields to be included in the response.
4277
+ * @internal
4278
+ * @maxSize 20
4279
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
4280
+ * This parameter will be removed on June 30, 2023.
4281
+ *
4282
+ * List of post fields to be included in the response.
4283
+ * @replacedBy fieldsets
4284
+ * @targetRemovalDate 2024-06-30
4285
+ */
4286
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
4287
+ /**
4288
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4289
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4290
+ * only the post’s base fields are returned.
4291
+ * @maxSize 20
4292
+ */
4293
+ fieldsets?: PostFieldFieldWithLiterals[];
4294
+ }
4143
4295
  interface GetPostResponse {
4144
4296
  /** Retrieved post info. */
4145
4297
  post?: Post;
@@ -4262,71 +4414,12 @@ interface ListPostsRequest {
4262
4414
  */
4263
4415
  fieldsets?: PostFieldFieldWithLiterals[];
4264
4416
  }
4265
- declare enum GetPostsSort {
4266
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
4267
- FEED = "FEED",
4268
- /** Ordered by `firstPublishedDate` in ascending order. */
4269
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
4270
- /** Ordered by `firstPublishedDate` in descending order. */
4271
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
4272
- /** Ordered by total number of views in descending order. */
4273
- VIEW_COUNT = "VIEW_COUNT",
4274
- /** Ordered by total number of likes in descending order. */
4275
- LIKE_COUNT = "LIKE_COUNT",
4276
- /** Ordered by `title` in ascending order. */
4277
- TITLE_ASC = "TITLE_ASC",
4278
- /** Ordered by `title` in descending order. */
4279
- TITLE_DESC = "TITLE_DESC",
4280
- /**
4281
- * Sorting by post rating descending.
4282
- * @internal
4283
- */
4284
- RATING = "RATING"
4285
- }
4286
- /** @enumType */
4287
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
4288
- interface BlogPaging {
4289
- /**
4290
- * Number of items to skip in the current sort order.
4291
- *
4292
- *
4293
- * Default: `0`
4294
- */
4295
- offset?: number;
4296
- /**
4297
- * Number of items to return.
4298
- *
4299
- *
4300
- * Default:`50`
4301
- * @min 1
4302
- * @max 100
4303
- */
4304
- limit?: number;
4305
- /**
4306
- * Pointer to the next or previous page in the list of results.
4307
- * @maxLength 2000
4308
- */
4309
- cursor?: string | null;
4310
- }
4311
4417
  interface ListPostsResponse {
4312
4418
  /** List of retrieved posts. */
4313
4419
  posts?: Post[];
4314
4420
  /** Details on the paged set of results returned. */
4315
4421
  metaData?: MetaData;
4316
4422
  }
4317
- interface MetaData {
4318
- /** Number of items returned in this response. */
4319
- count?: number;
4320
- /** Requested offset. */
4321
- offset?: number;
4322
- /** Total number of items that match the query. */
4323
- total?: number;
4324
- /**
4325
- * Pointer to the next or previous page in the list of results.
4326
- * @maxLength 2000
4327
- */
4328
- cursor?: string | null;
4329
- }
4330
4423
  interface QueryPostsRequest {
4331
4424
  /**
4332
4425
  * __Deprecated.__ Use `query` instead.
@@ -4778,99 +4871,6 @@ interface PostCount {
4778
4871
  /** Number of posts. */
4779
4872
  postCount?: number;
4780
4873
  }
4781
- interface ListDemoPostsRequest {
4782
- /**
4783
- * Whether to return only featured posts.
4784
- *
4785
- * Default: `false`
4786
- */
4787
- featured?: boolean;
4788
- /**
4789
- * Hashtag filter.
4790
- *
4791
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4792
- * If omitted, all posts with or without hashtags are returned.
4793
- * @maxSize 100
4794
- * @maxLength 100
4795
- */
4796
- hashtags?: string[];
4797
- /**
4798
- * Category filter.
4799
- *
4800
- * Pass an array of category IDs to return only posts with any of the provided categories.
4801
- * If omitted, all posts with or without associated categories are returned.
4802
- * @maxSize 50
4803
- * @format GUID
4804
- */
4805
- categoryIds?: string[];
4806
- /**
4807
- * Tag filter.
4808
- *
4809
- * Pass an array of tag IDs to return only posts with any of the provided tags.
4810
- * If omitted, all posts with or without tags are returned.
4811
- * @maxSize 50
4812
- * @format GUID
4813
- */
4814
- tagIds?: string[];
4815
- /**
4816
- * Sorting options.
4817
- *
4818
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4819
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4820
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4821
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4822
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4823
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
4824
- * - `TITLE_DESC`: Ordered by `title` in descending order.
4825
- * - `RATING`: reserved for internal use.
4826
- *
4827
- * Default: `FEED`
4828
- */
4829
- sort?: GetPostsSortWithLiterals;
4830
- /** Pagination options. */
4831
- paging?: BlogPaging;
4832
- /**
4833
- * __Deprecated.__ Use `fieldsets` instead.
4834
- * This parameter will be removed on June 30, 2023.
4835
- *
4836
- * List of post fields to be included in the response.
4837
- * @maxSize 20
4838
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4839
- * This parameter will be removed on June 30, 2023.
4840
- *
4841
- * List of post fields to be included in the response.
4842
- * @replacedBy fieldsets
4843
- * @targetRemovalDate 2024-06-30
4844
- */
4845
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4846
- /**
4847
- * Language filter.
4848
- *
4849
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4850
- * Pass a language to only receive posts that are in that language.
4851
- * If omitted, posts in all languages are returned.
4852
- * @format LANGUAGE_TAG
4853
- */
4854
- language?: string | null;
4855
- /**
4856
- * Post owner's member ID.
4857
- * @format GUID
4858
- */
4859
- memberId?: string | null;
4860
- /**
4861
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4862
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4863
- * only the post’s base fields are returned.
4864
- * @maxSize 20
4865
- */
4866
- fieldsets?: PostFieldFieldWithLiterals[];
4867
- }
4868
- interface ListDemoPostsResponse {
4869
- /** List of posts. */
4870
- posts?: Post[];
4871
- /** Details on the paged set of results returned. */
4872
- metaData?: MetaData;
4873
- }
4874
4874
 
4875
4875
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4876
4876
  getUrl: (context: any) => string;