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