@wix/auto_sdk_blog_draft-posts 1.0.92 → 1.0.94

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 (41) hide show
  1. package/build/cjs/index.js +13 -13
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +288 -273
  4. package/build/cjs/index.typings.js +13 -13
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +290 -275
  7. package/build/cjs/meta.js +13 -13
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.js +15 -15
  10. package/build/cjs/schemas.js.map +1 -1
  11. package/build/es/index.mjs +13 -13
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +288 -273
  14. package/build/es/index.typings.mjs +13 -13
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +290 -275
  17. package/build/es/meta.mjs +13 -13
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/es/schemas.mjs +15 -15
  20. package/build/es/schemas.mjs.map +1 -1
  21. package/build/internal/cjs/index.js +13 -13
  22. package/build/internal/cjs/index.js.map +1 -1
  23. package/build/internal/cjs/index.typings.d.ts +317 -302
  24. package/build/internal/cjs/index.typings.js +13 -13
  25. package/build/internal/cjs/index.typings.js.map +1 -1
  26. package/build/internal/cjs/meta.d.ts +333 -318
  27. package/build/internal/cjs/meta.js +13 -13
  28. package/build/internal/cjs/meta.js.map +1 -1
  29. package/build/internal/cjs/schemas.js +15 -15
  30. package/build/internal/cjs/schemas.js.map +1 -1
  31. package/build/internal/es/index.mjs +13 -13
  32. package/build/internal/es/index.mjs.map +1 -1
  33. package/build/internal/es/index.typings.d.mts +317 -302
  34. package/build/internal/es/index.typings.mjs +13 -13
  35. package/build/internal/es/index.typings.mjs.map +1 -1
  36. package/build/internal/es/meta.d.mts +333 -318
  37. package/build/internal/es/meta.mjs +13 -13
  38. package/build/internal/es/meta.mjs.map +1 -1
  39. package/build/internal/es/schemas.mjs +15 -15
  40. package/build/internal/es/schemas.mjs.map +1 -1
  41. package/package.json +2 -2
@@ -3018,7 +3018,22 @@ interface Tag {
3018
3018
  meta?: Record<string, any> | null;
3019
3019
  /** SEO tag inner content. For example, `<title> inner content </title>`. */
3020
3020
  children?: string;
3021
- /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
3021
+ /**
3022
+ * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
3023
+ * i.e. an entry from the site's Advanced/Custom Tags list.
3024
+ *
3025
+ * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
3026
+ * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
3027
+ * default/pattern — standard tags always resolve with `custom: false`, even when their content comes
3028
+ * from a page's manually saved SEO title/description override. Don't use this field to verify whether
3029
+ * a live page reflects a manual per-page SEO edit.
3030
+ *
3031
+ * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
3032
+ * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
3033
+ * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
3034
+ * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
3035
+ * Pass `seoData` explicitly to resolve against a known set of tags.
3036
+ */
3022
3037
  custom?: boolean;
3023
3038
  /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
3024
3039
  disabled?: boolean;
@@ -3187,10 +3202,6 @@ interface DraftPostTranslation {
3187
3202
  /** Post URL. */
3188
3203
  url?: string;
3189
3204
  }
3190
- interface InitialDraftPostsCopied {
3191
- /** Number of draft posts copied. */
3192
- count?: number;
3193
- }
3194
3205
  interface DraftCategoriesUpdated {
3195
3206
  /**
3196
3207
  * Draft post ID.
@@ -3229,6 +3240,200 @@ interface DraftTagsUpdated {
3229
3240
  */
3230
3241
  previousTags?: string[];
3231
3242
  }
3243
+ interface GetDraftPostTotalsRequest {
3244
+ /**
3245
+ * Group results by fields (defaults to grouping by status).
3246
+ * If, for example, grouping by language is passed, language values in response will be filled.
3247
+ * If, for example, grouping by language is not passed, null values will be filled in language field in response.
3248
+ * @maxSize 10
3249
+ */
3250
+ groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
3251
+ /**
3252
+ * Optional language filter by provided language code. Useful in multilingual context.
3253
+ * @format LANGUAGE_TAG
3254
+ */
3255
+ language?: string | null;
3256
+ }
3257
+ declare enum TotalDraftPostsGroupingField {
3258
+ /** Groups results by status. */
3259
+ STATUS = "STATUS",
3260
+ /** Groups results by language. */
3261
+ LANGUAGE = "LANGUAGE"
3262
+ }
3263
+ /** @enumType */
3264
+ type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
3265
+ interface GetDraftPostTotalsResponse {
3266
+ /** Draft post totals. */
3267
+ totalDraftPosts?: TotalDraftPosts[];
3268
+ }
3269
+ interface TotalDraftPosts {
3270
+ /** Draft post totals in that group. */
3271
+ total?: number;
3272
+ /** Draft post status (only has value when grouping by status, otherwise null). */
3273
+ status?: StatusWithLiterals;
3274
+ /**
3275
+ * Draft post language code (only has value when grouping by language, otherwise null).
3276
+ * @format LANGUAGE_TAG
3277
+ */
3278
+ language?: string | null;
3279
+ }
3280
+ interface DomainEvent extends DomainEventBodyOneOf {
3281
+ createdEvent?: EntityCreatedEvent;
3282
+ updatedEvent?: EntityUpdatedEvent;
3283
+ deletedEvent?: EntityDeletedEvent;
3284
+ actionEvent?: ActionEvent;
3285
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3286
+ _id?: string;
3287
+ /**
3288
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3289
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3290
+ */
3291
+ entityFqdn?: string;
3292
+ /**
3293
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3294
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3295
+ */
3296
+ slug?: string;
3297
+ /** ID of the entity associated with the event. */
3298
+ entityId?: string;
3299
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3300
+ eventTime?: Date | null;
3301
+ /**
3302
+ * Whether the event was triggered as a result of a privacy regulation application
3303
+ * (for example, GDPR).
3304
+ */
3305
+ triggeredByAnonymizeRequest?: boolean | null;
3306
+ /** If present, indicates the action that triggered the event. */
3307
+ originatedFrom?: string | null;
3308
+ /**
3309
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
3310
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
3311
+ */
3312
+ entityEventSequence?: string | null;
3313
+ }
3314
+ /** @oneof */
3315
+ interface DomainEventBodyOneOf {
3316
+ createdEvent?: EntityCreatedEvent;
3317
+ updatedEvent?: EntityUpdatedEvent;
3318
+ deletedEvent?: EntityDeletedEvent;
3319
+ actionEvent?: ActionEvent;
3320
+ }
3321
+ interface EntityCreatedEvent {
3322
+ entity?: string;
3323
+ }
3324
+ interface RestoreInfo {
3325
+ deletedDate?: Date | null;
3326
+ }
3327
+ interface EntityUpdatedEvent {
3328
+ /**
3329
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3330
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3331
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3332
+ */
3333
+ currentEntity?: string;
3334
+ }
3335
+ interface EntityDeletedEvent {
3336
+ /** Entity that was deleted. */
3337
+ deletedEntity?: string | null;
3338
+ }
3339
+ interface ActionEvent {
3340
+ body?: string;
3341
+ }
3342
+ interface MessageEnvelope {
3343
+ /**
3344
+ * App instance ID.
3345
+ * @format GUID
3346
+ */
3347
+ instanceId?: string | null;
3348
+ /**
3349
+ * Event type.
3350
+ * @maxLength 150
3351
+ */
3352
+ eventType?: string;
3353
+ /** The identification type and identity data. */
3354
+ identity?: IdentificationData;
3355
+ /** Stringify payload. */
3356
+ data?: string;
3357
+ /** Details related to the account */
3358
+ accountInfo?: AccountInfo;
3359
+ }
3360
+ interface IdentificationData extends IdentificationDataIdOneOf {
3361
+ /**
3362
+ * ID of a site visitor that has not logged in to the site.
3363
+ * @format GUID
3364
+ */
3365
+ anonymousVisitorId?: string;
3366
+ /**
3367
+ * ID of a site visitor that has logged in to the site.
3368
+ * @format GUID
3369
+ */
3370
+ memberId?: string;
3371
+ /**
3372
+ * ID of a Wix user (site owner, contributor, etc.).
3373
+ * @format GUID
3374
+ */
3375
+ wixUserId?: string;
3376
+ /**
3377
+ * ID of an app.
3378
+ * @format GUID
3379
+ */
3380
+ appId?: string;
3381
+ /** @readonly */
3382
+ identityType?: WebhookIdentityTypeWithLiterals;
3383
+ }
3384
+ /** @oneof */
3385
+ interface IdentificationDataIdOneOf {
3386
+ /**
3387
+ * ID of a site visitor that has not logged in to the site.
3388
+ * @format GUID
3389
+ */
3390
+ anonymousVisitorId?: string;
3391
+ /**
3392
+ * ID of a site visitor that has logged in to the site.
3393
+ * @format GUID
3394
+ */
3395
+ memberId?: string;
3396
+ /**
3397
+ * ID of a Wix user (site owner, contributor, etc.).
3398
+ * @format GUID
3399
+ */
3400
+ wixUserId?: string;
3401
+ /**
3402
+ * ID of an app.
3403
+ * @format GUID
3404
+ */
3405
+ appId?: string;
3406
+ }
3407
+ declare enum WebhookIdentityType {
3408
+ UNKNOWN = "UNKNOWN",
3409
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3410
+ MEMBER = "MEMBER",
3411
+ WIX_USER = "WIX_USER",
3412
+ APP = "APP"
3413
+ }
3414
+ /** @enumType */
3415
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3416
+ interface AccountInfo {
3417
+ /**
3418
+ * ID of the Wix account associated with the event.
3419
+ * @format GUID
3420
+ */
3421
+ accountId?: string | null;
3422
+ /**
3423
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
3424
+ * @format GUID
3425
+ */
3426
+ parentAccountId?: string | null;
3427
+ /**
3428
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3429
+ * @format GUID
3430
+ */
3431
+ siteId?: string | null;
3432
+ }
3433
+ interface InitialDraftPostsCopied {
3434
+ /** Number of draft posts copied. */
3435
+ count?: number;
3436
+ }
3232
3437
  interface CreateDraftPostRequest {
3233
3438
  /** Draft post to create. */
3234
3439
  draftPost: DraftPost;
@@ -3878,195 +4083,152 @@ interface DraftPostCount {
3878
4083
  /** Number of posts. */
3879
4084
  postCount?: number;
3880
4085
  }
3881
- interface DomainEvent extends DomainEventBodyOneOf {
3882
- createdEvent?: EntityCreatedEvent;
3883
- updatedEvent?: EntityUpdatedEvent;
3884
- deletedEvent?: EntityDeletedEvent;
3885
- actionEvent?: ActionEvent;
3886
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3887
- _id?: string;
4086
+ interface BulkRevertToUnpublishedRequest {
3888
4087
  /**
3889
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3890
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4088
+ * Source post IDs.
4089
+ * @minSize 1
4090
+ * @maxSize 100
4091
+ * @format GUID
3891
4092
  */
3892
- entityFqdn?: string;
4093
+ postIds?: string[];
4094
+ /** Should full draft post be returned. */
4095
+ returnFullEntity?: boolean;
4096
+ }
4097
+ interface BulkRevertToUnpublishedResponse {
4098
+ /** Bulk action results. */
4099
+ results?: BulkDraftPostResult[];
4100
+ /** Bulk action metadata. */
4101
+ bulkActionMetadata?: BulkActionMetadata;
4102
+ }
4103
+ interface BulkRejectDraftPostRequest {
3893
4104
  /**
3894
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
3895
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4105
+ * Source post IDs.
4106
+ * @minSize 1
4107
+ * @maxSize 100
4108
+ * @format GUID
3896
4109
  */
3897
- slug?: string;
3898
- /** ID of the entity associated with the event. */
3899
- entityId?: string;
3900
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3901
- eventTime?: Date | null;
4110
+ postIds?: string[];
4111
+ /** Should full draft post be returned. */
4112
+ returnFullEntity?: boolean;
4113
+ }
4114
+ interface BulkRejectDraftPostResponse {
4115
+ /** Bulk action results. */
4116
+ results?: BulkDraftPostResult[];
4117
+ /** Bulk action metadata. */
4118
+ bulkActionMetadata?: BulkActionMetadata;
4119
+ }
4120
+ interface RevertToUnpublishedRequest {
3902
4121
  /**
3903
- * Whether the event was triggered as a result of a privacy regulation application
3904
- * (for example, GDPR).
4122
+ * Source post ID.
4123
+ * @format GUID
3905
4124
  */
3906
- triggeredByAnonymizeRequest?: boolean | null;
3907
- /** If present, indicates the action that triggered the event. */
3908
- originatedFrom?: string | null;
4125
+ postId?: string;
3909
4126
  /**
3910
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
3911
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
4127
+ * List of draft post fields to be included in the response.
4128
+ * @internal
4129
+ * @maxSize 10
4130
+ * @deprecated List of draft post fields to be included in the response.
4131
+ * @replacedBy fieldsets
4132
+ * @targetRemovalDate 2024-06-30
3912
4133
  */
3913
- entityEventSequence?: string | null;
3914
- }
3915
- /** @oneof */
3916
- interface DomainEventBodyOneOf {
3917
- createdEvent?: EntityCreatedEvent;
3918
- updatedEvent?: EntityUpdatedEvent;
3919
- deletedEvent?: EntityDeletedEvent;
3920
- actionEvent?: ActionEvent;
3921
- }
3922
- interface EntityCreatedEvent {
3923
- entity?: string;
3924
- }
3925
- interface RestoreInfo {
3926
- deletedDate?: Date | null;
3927
- }
3928
- interface EntityUpdatedEvent {
4134
+ fieldsToInclude?: FieldWithLiterals[];
3929
4135
  /**
3930
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3931
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3932
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
4136
+ * List of draft post fields to be included if entities are present in the response.
4137
+ * Base fieldset, which is default, will return all core draft post properties.
4138
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4139
+ * @maxSize 10
3933
4140
  */
3934
- currentEntity?: string;
3935
- }
3936
- interface EntityDeletedEvent {
3937
- /** Entity that was deleted. */
3938
- deletedEntity?: string | null;
3939
- }
3940
- interface ActionEvent {
3941
- body?: string;
4141
+ fieldsets?: FieldWithLiterals[];
3942
4142
  }
3943
- interface MessageEnvelope {
3944
- /**
3945
- * App instance ID.
3946
- * @format GUID
3947
- */
3948
- instanceId?: string | null;
3949
- /**
3950
- * Event type.
3951
- * @maxLength 150
3952
- */
3953
- eventType?: string;
3954
- /** The identification type and identity data. */
3955
- identity?: IdentificationData;
3956
- /** Stringify payload. */
3957
- data?: string;
3958
- /** Details related to the account */
3959
- accountInfo?: AccountInfo;
4143
+ interface RevertToUnpublishedResponse {
4144
+ /** Updated post draft. */
4145
+ draftPost?: DraftPost;
3960
4146
  }
3961
- interface IdentificationData extends IdentificationDataIdOneOf {
3962
- /**
3963
- * ID of a site visitor that has not logged in to the site.
3964
- * @format GUID
3965
- */
3966
- anonymousVisitorId?: string;
4147
+ interface RejectDraftPostRequest {
3967
4148
  /**
3968
- * ID of a site visitor that has logged in to the site.
4149
+ * Source post ID.
3969
4150
  * @format GUID
3970
4151
  */
3971
- memberId?: string;
4152
+ postId?: string;
3972
4153
  /**
3973
- * ID of a Wix user (site owner, contributor, etc.).
3974
- * @format GUID
4154
+ * List of draft post fields to be included in the response.
4155
+ * @internal
4156
+ * @maxSize 10
4157
+ * @deprecated List of draft post fields to be included in the response.
4158
+ * @replacedBy fieldsets
4159
+ * @targetRemovalDate 2024-06-30
3975
4160
  */
3976
- wixUserId?: string;
4161
+ fieldsToInclude?: FieldWithLiterals[];
3977
4162
  /**
3978
- * ID of an app.
3979
- * @format GUID
4163
+ * List of draft post fields to be included if entities are present in the response.
4164
+ * Base fieldset, which is default, will return all core draft post properties.
4165
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4166
+ * @maxSize 10
3980
4167
  */
3981
- appId?: string;
3982
- /** @readonly */
3983
- identityType?: WebhookIdentityTypeWithLiterals;
4168
+ fieldsets?: FieldWithLiterals[];
3984
4169
  }
3985
- /** @oneof */
3986
- interface IdentificationDataIdOneOf {
4170
+ interface RejectDraftPostResponse {
4171
+ /** Draft post. */
4172
+ draftPost?: DraftPost;
4173
+ }
4174
+ interface ApproveDraftPostRequest {
3987
4175
  /**
3988
- * ID of a site visitor that has not logged in to the site.
4176
+ * Source post ID.
3989
4177
  * @format GUID
3990
4178
  */
3991
- anonymousVisitorId?: string;
4179
+ postId?: string;
3992
4180
  /**
3993
- * ID of a site visitor that has logged in to the site.
3994
- * @format GUID
4181
+ * Scheduled publish date if should be not immediately published.
4182
+ * @maxLength 24
3995
4183
  */
3996
- memberId?: string;
4184
+ scheduledPublishDate?: string | null;
3997
4185
  /**
3998
- * ID of a Wix user (site owner, contributor, etc.).
3999
- * @format GUID
4186
+ * List of draft post fields to be included in the response.
4187
+ * @internal
4188
+ * @maxSize 10
4189
+ * @deprecated List of draft post fields to be included in the response.
4190
+ * @replacedBy fieldsets
4191
+ * @targetRemovalDate 2024-06-30
4000
4192
  */
4001
- wixUserId?: string;
4193
+ fieldsToInclude?: FieldWithLiterals[];
4002
4194
  /**
4003
- * ID of an app.
4004
- * @format GUID
4195
+ * List of draft post fields to be included if entities are present in the response.
4196
+ * Base fieldset, which is default, will return all core draft post properties.
4197
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4198
+ * @maxSize 10
4005
4199
  */
4006
- appId?: string;
4200
+ fieldsets?: FieldWithLiterals[];
4007
4201
  }
4008
- declare enum WebhookIdentityType {
4009
- UNKNOWN = "UNKNOWN",
4010
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
4011
- MEMBER = "MEMBER",
4012
- WIX_USER = "WIX_USER",
4013
- APP = "APP"
4202
+ interface ApproveDraftPostResponse {
4203
+ /** Updated post draft. */
4204
+ draftPost?: DraftPost;
4014
4205
  }
4015
- /** @enumType */
4016
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
4017
- interface AccountInfo {
4018
- /**
4019
- * ID of the Wix account associated with the event.
4020
- * @format GUID
4021
- */
4022
- accountId?: string | null;
4023
- /**
4024
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
4025
- * @format GUID
4026
- */
4027
- parentAccountId?: string | null;
4206
+ interface MarkPostAsInModerationRequest {
4028
4207
  /**
4029
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
4030
- * @format GUID
4208
+ * Source post ID.
4209
+ * @maxLength 38
4031
4210
  */
4032
- siteId?: string | null;
4033
- }
4034
- interface GetDraftPostTotalsRequest {
4211
+ postId?: string;
4035
4212
  /**
4036
- * Group results by fields (defaults to grouping by status).
4037
- * If, for example, grouping by language is passed, language values in response will be filled.
4038
- * If, for example, grouping by language is not passed, null values will be filled in language field in response.
4213
+ * List of draft post fields to be included in the response.
4214
+ * @internal
4039
4215
  * @maxSize 10
4216
+ * @deprecated List of draft post fields to be included in the response.
4217
+ * @replacedBy fieldsets
4218
+ * @targetRemovalDate 2024-06-30
4040
4219
  */
4041
- groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
4220
+ fieldsToInclude?: FieldWithLiterals[];
4042
4221
  /**
4043
- * Optional language filter by provided language code. Useful in multilingual context.
4044
- * @format LANGUAGE_TAG
4222
+ * List of draft post fields to be included if entities are present in the response.
4223
+ * Base fieldset, which is default, will return all core draft post properties.
4224
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4225
+ * @maxSize 10
4045
4226
  */
4046
- language?: string | null;
4047
- }
4048
- declare enum TotalDraftPostsGroupingField {
4049
- /** Groups results by status. */
4050
- STATUS = "STATUS",
4051
- /** Groups results by language. */
4052
- LANGUAGE = "LANGUAGE"
4053
- }
4054
- /** @enumType */
4055
- type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
4056
- interface GetDraftPostTotalsResponse {
4057
- /** Draft post totals. */
4058
- totalDraftPosts?: TotalDraftPosts[];
4227
+ fieldsets?: FieldWithLiterals[];
4059
4228
  }
4060
- interface TotalDraftPosts {
4061
- /** Draft post totals in that group. */
4062
- total?: number;
4063
- /** Draft post status (only has value when grouping by status, otherwise null). */
4064
- status?: StatusWithLiterals;
4065
- /**
4066
- * Draft post language code (only has value when grouping by language, otherwise null).
4067
- * @format LANGUAGE_TAG
4068
- */
4069
- language?: string | null;
4229
+ interface MarkPostAsInModerationResponse {
4230
+ /** Updated post draft. */
4231
+ draftPost?: DraftPost;
4070
4232
  }
4071
4233
  interface TranslateDraftRequest {
4072
4234
  /**
@@ -4146,153 +4308,6 @@ interface UpdateDraftPostLanguageResponse {
4146
4308
  /** Draft post */
4147
4309
  draftPost?: DraftPost;
4148
4310
  }
4149
- interface BulkRevertToUnpublishedRequest {
4150
- /**
4151
- * Source post IDs.
4152
- * @minSize 1
4153
- * @maxSize 100
4154
- * @format GUID
4155
- */
4156
- postIds?: string[];
4157
- /** Should full draft post be returned. */
4158
- returnFullEntity?: boolean;
4159
- }
4160
- interface BulkRevertToUnpublishedResponse {
4161
- /** Bulk action results. */
4162
- results?: BulkDraftPostResult[];
4163
- /** Bulk action metadata. */
4164
- bulkActionMetadata?: BulkActionMetadata;
4165
- }
4166
- interface BulkRejectDraftPostRequest {
4167
- /**
4168
- * Source post IDs.
4169
- * @minSize 1
4170
- * @maxSize 100
4171
- * @format GUID
4172
- */
4173
- postIds?: string[];
4174
- /** Should full draft post be returned. */
4175
- returnFullEntity?: boolean;
4176
- }
4177
- interface BulkRejectDraftPostResponse {
4178
- /** Bulk action results. */
4179
- results?: BulkDraftPostResult[];
4180
- /** Bulk action metadata. */
4181
- bulkActionMetadata?: BulkActionMetadata;
4182
- }
4183
- interface RevertToUnpublishedRequest {
4184
- /**
4185
- * Source post ID.
4186
- * @format GUID
4187
- */
4188
- postId?: string;
4189
- /**
4190
- * List of draft post fields to be included in the response.
4191
- * @internal
4192
- * @maxSize 10
4193
- * @deprecated List of draft post fields to be included in the response.
4194
- * @replacedBy fieldsets
4195
- * @targetRemovalDate 2024-06-30
4196
- */
4197
- fieldsToInclude?: FieldWithLiterals[];
4198
- /**
4199
- * List of draft post fields to be included if entities are present in the response.
4200
- * Base fieldset, which is default, will return all core draft post properties.
4201
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4202
- * @maxSize 10
4203
- */
4204
- fieldsets?: FieldWithLiterals[];
4205
- }
4206
- interface RevertToUnpublishedResponse {
4207
- /** Updated post draft. */
4208
- draftPost?: DraftPost;
4209
- }
4210
- interface RejectDraftPostRequest {
4211
- /**
4212
- * Source post ID.
4213
- * @format GUID
4214
- */
4215
- postId?: string;
4216
- /**
4217
- * List of draft post fields to be included in the response.
4218
- * @internal
4219
- * @maxSize 10
4220
- * @deprecated List of draft post fields to be included in the response.
4221
- * @replacedBy fieldsets
4222
- * @targetRemovalDate 2024-06-30
4223
- */
4224
- fieldsToInclude?: FieldWithLiterals[];
4225
- /**
4226
- * List of draft post fields to be included if entities are present in the response.
4227
- * Base fieldset, which is default, will return all core draft post properties.
4228
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4229
- * @maxSize 10
4230
- */
4231
- fieldsets?: FieldWithLiterals[];
4232
- }
4233
- interface RejectDraftPostResponse {
4234
- /** Draft post. */
4235
- draftPost?: DraftPost;
4236
- }
4237
- interface ApproveDraftPostRequest {
4238
- /**
4239
- * Source post ID.
4240
- * @format GUID
4241
- */
4242
- postId?: string;
4243
- /**
4244
- * Scheduled publish date if should be not immediately published.
4245
- * @maxLength 24
4246
- */
4247
- scheduledPublishDate?: string | null;
4248
- /**
4249
- * List of draft post fields to be included in the response.
4250
- * @internal
4251
- * @maxSize 10
4252
- * @deprecated List of draft post fields to be included in the response.
4253
- * @replacedBy fieldsets
4254
- * @targetRemovalDate 2024-06-30
4255
- */
4256
- fieldsToInclude?: FieldWithLiterals[];
4257
- /**
4258
- * List of draft post fields to be included if entities are present in the response.
4259
- * Base fieldset, which is default, will return all core draft post properties.
4260
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4261
- * @maxSize 10
4262
- */
4263
- fieldsets?: FieldWithLiterals[];
4264
- }
4265
- interface ApproveDraftPostResponse {
4266
- /** Updated post draft. */
4267
- draftPost?: DraftPost;
4268
- }
4269
- interface MarkPostAsInModerationRequest {
4270
- /**
4271
- * Source post ID.
4272
- * @maxLength 38
4273
- */
4274
- postId?: string;
4275
- /**
4276
- * List of draft post fields to be included in the response.
4277
- * @internal
4278
- * @maxSize 10
4279
- * @deprecated List of draft post fields to be included in the response.
4280
- * @replacedBy fieldsets
4281
- * @targetRemovalDate 2024-06-30
4282
- */
4283
- fieldsToInclude?: FieldWithLiterals[];
4284
- /**
4285
- * List of draft post fields to be included if entities are present in the response.
4286
- * Base fieldset, which is default, will return all core draft post properties.
4287
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4288
- * @maxSize 10
4289
- */
4290
- fieldsets?: FieldWithLiterals[];
4291
- }
4292
- interface MarkPostAsInModerationResponse {
4293
- /** Updated post draft. */
4294
- draftPost?: DraftPost;
4295
- }
4296
4311
  interface BaseEventMetadata {
4297
4312
  /**
4298
4313
  * App instance ID.