@wix/auto_sdk_blog_draft-posts 1.0.119 → 1.0.120

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.
@@ -3168,73 +3168,117 @@ declare enum ModerationStatusStatus {
3168
3168
  /** @enumType */
3169
3169
  type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
3170
3170
  /**
3171
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
3172
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
3173
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
3171
+ * The SEO data for a single page or dynamic item, in the shape stored today.
3172
+ *
3173
+ * FROZEN. Existing server code maps onto this message field by field, so its
3174
+ * field set must never change (see the file header). New writers use
3175
+ * `SeoSchemaV2`.
3176
+ *
3177
+ * These tags are rendered into the <head> of the HTML document and are not
3178
+ * visible on the page itself. They override every other source of tags
3179
+ * (site defaults, vertical presets, patterns) for this page.
3174
3180
  */
3175
3181
  interface SeoSchema {
3176
- /** SEO tag information. */
3182
+ /**
3183
+ * The tags rendered into <head>, in no particular order. Render order is
3184
+ * decided by the renderer, not by position in this list.
3185
+ *
3186
+ * No maxSize: this list is already populated by data written years ago, and
3187
+ * a bound added now could reject a page that is already stored.
3188
+ */
3177
3189
  tags?: Tag[];
3178
- /** SEO general settings. */
3190
+ /** Page-level SEO settings that are not themselves tags. */
3179
3191
  settings?: Settings;
3180
3192
  }
3193
+ /** A keyword term the user is targeting. */
3181
3194
  interface Keyword {
3182
- /** Keyword value. */
3195
+ /**
3196
+ * The term itself, e.g. "trail running shoes".
3197
+ *
3198
+ * No maxLength, for the same reason as the legacy tag fields: keywords are
3199
+ * already stored, and a bound added now could reject a record written
3200
+ * before the bound existed. The flynt `missing-string-validations` warning
3201
+ * on this field is accepted deliberately.
3202
+ */
3183
3203
  term?: string;
3184
- /** Whether the keyword is the main focus keyword. */
3204
+ /** Whether this is the page's primary focus keyword. At most one per page. */
3185
3205
  isMain?: boolean;
3186
3206
  /**
3187
- * The source that added the keyword terms to the SEO settings.
3207
+ * Which surface added the term, e.g. a panel or a suggestion flow. Used for
3208
+ * attribution in BI. Opaque to the renderer.
3188
3209
  * @maxLength 1000
3189
3210
  */
3190
3211
  origin?: string | null;
3191
3212
  }
3213
+ /**
3214
+ * One tag in the page's <head>.
3215
+ *
3216
+ * Not deprecated, and with no removal date, deliberately: stored data is
3217
+ * never migrated, so this shape stays valid input forever. `seo-renderer`
3218
+ * normalizes both shapes on READ.
3219
+ */
3192
3220
  interface Tag {
3193
3221
  /**
3194
- * SEO tag type.
3195
- *
3222
+ * Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
3223
+ * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
3224
+ * the invalid combinations unrepresentable rather than merely discouraged.
3196
3225
  *
3197
- * Supported values: `title`, `meta`, `script`, `link`.
3198
- *
3199
- * Which of these an API actually accepts depends on where the tag is being set: this
3200
- * list is not a blanket guarantee across every API that reuses this message. Site SEO
3201
- * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
3202
- * `title`/`script`/`link` with a validation error even though they appear here —
3203
- * check the field description of the specific `tags`-typed field you're writing to
3204
- * for the types it actually supports and the error it returns.
3226
+ * Which of these an API actually accepts depends on where the tag is being
3227
+ * set: this list is not a blanket guarantee across every API that reuses
3228
+ * this message. Site SEO Tags in particular accepts only `meta` (see
3229
+ * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
3230
+ * error even though they appear here — check the field description of the
3231
+ * specific `tags`-typed field you are writing to.
3205
3232
  *
3206
3233
  * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
3207
- * `"application/ld+json"` carrying structured data) are supported only when
3208
- * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
3209
- * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
3210
- * write through the site's Advanced/Custom Tags list. To write structured data,
3211
- * omit `custom` (or set it to `false`).
3234
+ * "application/ld+json" carrying structured data) are supported only when
3235
+ * `custom` is unset or `false`. Setting `custom: true` on a `title` or
3236
+ * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
3237
+ * `custom: true` routes the write through the site's Advanced/Custom Tags
3238
+ * list. To write structured data, omit `custom` (or set it to `false`).
3239
+ *
3240
+ * No length limit: this field holds data written years ago by writers we
3241
+ * are not migrating. A constraint here could reject a record that is
3242
+ * already stored, which is exactly the promise this design makes.
3212
3243
  */
3213
3244
  type?: string;
3214
3245
  /**
3215
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
3216
- * For example: `{"name": "description", "content": "the description itself"}`.
3246
+ * Legacy. Was an untyped bag of HTML attributes.
3247
+ * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
3217
3248
  */
3218
3249
  props?: Record<string, any> | null;
3219
- /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
3250
+ /**
3251
+ * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
3252
+ * its contents are split by purpose: per-page structured-data state moves to
3253
+ * StructuredDataTag, authorship to `written_by`, and render-time preset
3254
+ * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
3255
+ * stored document entirely — it belongs to the preset definition, not to the
3256
+ * page. See the design log for the full key-by-key mapping.
3257
+ */
3220
3258
  meta?: Record<string, any> | null;
3221
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
3259
+ /**
3260
+ * Legacy. Was the tag's inner content, doubling as the JSON-LD payload
3261
+ * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
3262
+ * `StructuredDataTag.json_ld`.
3263
+ * No length limit, for the same reason as `type` above.
3264
+ */
3222
3265
  children?: string;
3223
3266
  /**
3224
3267
  * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
3225
3268
  * i.e. an entry from the site's Advanced/Custom Tags list.
3226
3269
  *
3227
- * Setting this to `true` on a write restricts which `type` values are accepted
3228
- * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
3229
- * `script` tags (including JSON-LD structured data) must be sent with `custom`
3230
- * omitted or `false`; sending them with `custom: true` is rejected with
3231
- * `TAG_TYPE_NOT_ALLOWED`.
3270
+ * Setting this to `true` on a write restricts which `type` values are
3271
+ * accepted — the same restriction the Advanced/Custom Tags UI enforces.
3272
+ * `title` and `script` tags (including JSON-LD structured data) must be sent
3273
+ * with `custom` omitted or `false`; sending them with `custom: true` is
3274
+ * rejected with `TAG_TYPE_NOT_ALLOWED`.
3232
3275
  *
3233
- * Note this is a separate restriction from Site SEO Tags' own type restriction on
3234
- * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
3235
- * for site-wide structured data) unconditionally. There is currently no way to set
3236
- * site-wide, every-page structured data through any of these APIs — write a per-page
3237
- * `script` tag through the Item SEO Tags API instead.
3276
+ * Note this is a separate restriction from Site SEO Tags' own type
3277
+ * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
3278
+ * rejects `script` (e.g. for site-wide structured data) unconditionally.
3279
+ * There is currently no way to set site-wide, every-page structured data
3280
+ * through any of these APIs — write a per-page `script` tag through the Item
3281
+ * SEO Tags API instead.
3238
3282
  *
3239
3283
  * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
3240
3284
  * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
@@ -3247,22 +3291,39 @@ interface Tag {
3247
3291
  * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
3248
3292
  * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
3249
3293
  * Pass `seoData` explicitly to resolve against a known set of tags.
3294
+ *
3295
+ * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
3250
3296
  */
3251
3297
  custom?: boolean;
3252
- /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
3298
+ /**
3299
+ * Whether the tag is excluded from the rendered <head>.
3300
+ *
3301
+ * A disabled tag is still stored, so the user can re-enable it and so a
3302
+ * pattern-provided tag stays suppressed on this page. Default false.
3303
+ */
3253
3304
  disabled?: boolean;
3254
3305
  }
3306
+ /** Page-level SEO settings that are not tags. */
3255
3307
  interface Settings {
3256
3308
  /**
3257
- * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
3309
+ * Whether to suppress the automatic redirect from this page's previous URL to
3310
+ * its current one after a slug change.
3258
3311
  *
3259
- *
3260
- * Default: `false` (automatical redirect is enabled).
3312
+ * Default false, meaning the redirect IS created. The field is named for the
3313
+ * exception rather than the rule, which reads backwards; kept as-is because
3314
+ * renaming a stored boolean is not worth the migration.
3261
3315
  */
3262
3316
  preventAutoRedirect?: boolean;
3263
3317
  /**
3264
- * User-selected keyword terms for a specific page.
3265
- * @maxSize 5
3318
+ * Keyword terms the user is targeting for this page. Used by the SEO
3319
+ * assistant and checklist; never rendered into <head>.
3320
+ *
3321
+ * 20 is a sanity bound, not the product limit. v1 declared 5 — the number
3322
+ * the panel happens to allow today — which is exactly the mistake we are
3323
+ * fixing for structured data. A product decision to allow 8 should not need
3324
+ * a proto release, so the panel owns that number and the proto only stops
3325
+ * something absurd.
3326
+ * @maxSize 20
3266
3327
  */
3267
3328
  keywords?: Keyword[];
3268
3329
  }
@@ -3416,6 +3477,10 @@ interface DraftPostTranslation {
3416
3477
  /** Post URL. */
3417
3478
  url?: string;
3418
3479
  }
3480
+ interface InitialDraftPostsCopied {
3481
+ /** Number of draft posts copied. */
3482
+ count?: number;
3483
+ }
3419
3484
  interface DraftCategoriesUpdated {
3420
3485
  /**
3421
3486
  * Draft post ID.
@@ -3454,200 +3519,6 @@ interface DraftTagsUpdated {
3454
3519
  */
3455
3520
  previousTags?: string[];
3456
3521
  }
3457
- interface GetDraftPostTotalsRequest {
3458
- /**
3459
- * Group results by fields (defaults to grouping by status).
3460
- * If, for example, grouping by language is passed, language values in response will be filled.
3461
- * If, for example, grouping by language is not passed, null values will be filled in language field in response.
3462
- * @maxSize 10
3463
- */
3464
- groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
3465
- /**
3466
- * Optional language filter by provided language code. Useful in multilingual context.
3467
- * @format LANGUAGE_TAG
3468
- */
3469
- language?: string | null;
3470
- }
3471
- declare enum TotalDraftPostsGroupingField {
3472
- /** Groups results by status. */
3473
- STATUS = "STATUS",
3474
- /** Groups results by language. */
3475
- LANGUAGE = "LANGUAGE"
3476
- }
3477
- /** @enumType */
3478
- type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
3479
- interface GetDraftPostTotalsResponse {
3480
- /** Draft post totals. */
3481
- totalDraftPosts?: TotalDraftPosts[];
3482
- }
3483
- interface TotalDraftPosts {
3484
- /** Draft post totals in that group. */
3485
- total?: number;
3486
- /** Draft post status (only has value when grouping by status, otherwise null). */
3487
- status?: StatusWithLiterals;
3488
- /**
3489
- * Draft post language code (only has value when grouping by language, otherwise null).
3490
- * @format LANGUAGE_TAG
3491
- */
3492
- language?: string | null;
3493
- }
3494
- interface DomainEvent extends DomainEventBodyOneOf {
3495
- createdEvent?: EntityCreatedEvent;
3496
- updatedEvent?: EntityUpdatedEvent;
3497
- deletedEvent?: EntityDeletedEvent;
3498
- actionEvent?: ActionEvent;
3499
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3500
- _id?: string;
3501
- /**
3502
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3503
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3504
- */
3505
- entityFqdn?: string;
3506
- /**
3507
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
3508
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3509
- */
3510
- slug?: string;
3511
- /** ID of the entity associated with the event. */
3512
- entityId?: string;
3513
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3514
- eventTime?: Date | null;
3515
- /**
3516
- * Whether the event was triggered as a result of a privacy regulation application
3517
- * (for example, GDPR).
3518
- */
3519
- triggeredByAnonymizeRequest?: boolean | null;
3520
- /** If present, indicates the action that triggered the event. */
3521
- originatedFrom?: string | null;
3522
- /**
3523
- * 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.
3524
- * 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.
3525
- */
3526
- entityEventSequence?: string | null;
3527
- }
3528
- /** @oneof */
3529
- interface DomainEventBodyOneOf {
3530
- createdEvent?: EntityCreatedEvent;
3531
- updatedEvent?: EntityUpdatedEvent;
3532
- deletedEvent?: EntityDeletedEvent;
3533
- actionEvent?: ActionEvent;
3534
- }
3535
- interface EntityCreatedEvent {
3536
- entity?: string;
3537
- }
3538
- interface RestoreInfo {
3539
- deletedDate?: Date | null;
3540
- }
3541
- interface EntityUpdatedEvent {
3542
- /**
3543
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3544
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3545
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3546
- */
3547
- currentEntity?: string;
3548
- }
3549
- interface EntityDeletedEvent {
3550
- /** Entity that was deleted. */
3551
- deletedEntity?: string | null;
3552
- }
3553
- interface ActionEvent {
3554
- body?: string;
3555
- }
3556
- interface MessageEnvelope {
3557
- /**
3558
- * App instance ID.
3559
- * @format GUID
3560
- */
3561
- instanceId?: string | null;
3562
- /**
3563
- * Event type.
3564
- * @maxLength 150
3565
- */
3566
- eventType?: string;
3567
- /** The identification type and identity data. */
3568
- identity?: IdentificationData;
3569
- /** Stringify payload. */
3570
- data?: string;
3571
- /** Details related to the account */
3572
- accountInfo?: AccountInfo;
3573
- }
3574
- interface IdentificationData extends IdentificationDataIdOneOf {
3575
- /**
3576
- * ID of a site visitor that has not logged in to the site.
3577
- * @format GUID
3578
- */
3579
- anonymousVisitorId?: string;
3580
- /**
3581
- * ID of a site visitor that has logged in to the site.
3582
- * @format GUID
3583
- */
3584
- memberId?: string;
3585
- /**
3586
- * ID of a Wix user (site owner, contributor, etc.).
3587
- * @format GUID
3588
- */
3589
- wixUserId?: string;
3590
- /**
3591
- * ID of an app.
3592
- * @format GUID
3593
- */
3594
- appId?: string;
3595
- /** @readonly */
3596
- identityType?: WebhookIdentityTypeWithLiterals;
3597
- }
3598
- /** @oneof */
3599
- interface IdentificationDataIdOneOf {
3600
- /**
3601
- * ID of a site visitor that has not logged in to the site.
3602
- * @format GUID
3603
- */
3604
- anonymousVisitorId?: string;
3605
- /**
3606
- * ID of a site visitor that has logged in to the site.
3607
- * @format GUID
3608
- */
3609
- memberId?: string;
3610
- /**
3611
- * ID of a Wix user (site owner, contributor, etc.).
3612
- * @format GUID
3613
- */
3614
- wixUserId?: string;
3615
- /**
3616
- * ID of an app.
3617
- * @format GUID
3618
- */
3619
- appId?: string;
3620
- }
3621
- declare enum WebhookIdentityType {
3622
- UNKNOWN = "UNKNOWN",
3623
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3624
- MEMBER = "MEMBER",
3625
- WIX_USER = "WIX_USER",
3626
- APP = "APP"
3627
- }
3628
- /** @enumType */
3629
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3630
- interface AccountInfo {
3631
- /**
3632
- * ID of the Wix account associated with the event.
3633
- * @format GUID
3634
- */
3635
- accountId?: string | null;
3636
- /**
3637
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
3638
- * @format GUID
3639
- */
3640
- parentAccountId?: string | null;
3641
- /**
3642
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3643
- * @format GUID
3644
- */
3645
- siteId?: string | null;
3646
- }
3647
- interface InitialDraftPostsCopied {
3648
- /** Number of draft posts copied. */
3649
- count?: number;
3650
- }
3651
3522
  interface CreateDraftPostRequest {
3652
3523
  /** Draft post to create. */
3653
3524
  draftPost: DraftPost;
@@ -4297,152 +4168,195 @@ interface DraftPostCount {
4297
4168
  /** Number of posts. */
4298
4169
  postCount?: number;
4299
4170
  }
4300
- interface BulkRevertToUnpublishedRequest {
4171
+ interface DomainEvent extends DomainEventBodyOneOf {
4172
+ createdEvent?: EntityCreatedEvent;
4173
+ updatedEvent?: EntityUpdatedEvent;
4174
+ deletedEvent?: EntityDeletedEvent;
4175
+ actionEvent?: ActionEvent;
4176
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4177
+ _id?: string;
4301
4178
  /**
4302
- * Source post IDs.
4303
- * @minSize 1
4304
- * @maxSize 100
4305
- * @format GUID
4179
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
4180
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4306
4181
  */
4307
- postIds?: string[];
4308
- /** Should full draft post be returned. */
4309
- returnFullEntity?: boolean;
4310
- }
4311
- interface BulkRevertToUnpublishedResponse {
4312
- /** Bulk action results. */
4313
- results?: BulkDraftPostResult[];
4314
- /** Bulk action metadata. */
4315
- bulkActionMetadata?: BulkActionMetadata;
4316
- }
4317
- interface BulkRejectDraftPostRequest {
4182
+ entityFqdn?: string;
4318
4183
  /**
4319
- * Source post IDs.
4320
- * @minSize 1
4321
- * @maxSize 100
4322
- * @format GUID
4184
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
4185
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4323
4186
  */
4324
- postIds?: string[];
4325
- /** Should full draft post be returned. */
4326
- returnFullEntity?: boolean;
4187
+ slug?: string;
4188
+ /** ID of the entity associated with the event. */
4189
+ entityId?: string;
4190
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4191
+ eventTime?: Date | null;
4192
+ /**
4193
+ * Whether the event was triggered as a result of a privacy regulation application
4194
+ * (for example, GDPR).
4195
+ */
4196
+ triggeredByAnonymizeRequest?: boolean | null;
4197
+ /** If present, indicates the action that triggered the event. */
4198
+ originatedFrom?: string | null;
4199
+ /**
4200
+ * 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.
4201
+ * 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.
4202
+ */
4203
+ entityEventSequence?: string | null;
4327
4204
  }
4328
- interface BulkRejectDraftPostResponse {
4329
- /** Bulk action results. */
4330
- results?: BulkDraftPostResult[];
4331
- /** Bulk action metadata. */
4332
- bulkActionMetadata?: BulkActionMetadata;
4205
+ /** @oneof */
4206
+ interface DomainEventBodyOneOf {
4207
+ createdEvent?: EntityCreatedEvent;
4208
+ updatedEvent?: EntityUpdatedEvent;
4209
+ deletedEvent?: EntityDeletedEvent;
4210
+ actionEvent?: ActionEvent;
4333
4211
  }
4334
- interface RevertToUnpublishedRequest {
4212
+ interface EntityCreatedEvent {
4213
+ entity?: string;
4214
+ }
4215
+ interface RestoreInfo {
4216
+ deletedDate?: Date | null;
4217
+ }
4218
+ interface EntityUpdatedEvent {
4335
4219
  /**
4336
- * Source post ID.
4337
- * @format GUID
4220
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
4221
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
4222
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
4338
4223
  */
4339
- postId?: string;
4224
+ currentEntity?: string;
4225
+ }
4226
+ interface EntityDeletedEvent {
4227
+ /** Entity that was deleted. */
4228
+ deletedEntity?: string | null;
4229
+ }
4230
+ interface ActionEvent {
4231
+ body?: string;
4232
+ }
4233
+ interface MessageEnvelope {
4340
4234
  /**
4341
- * List of draft post fields to be included in the response.
4342
- * @internal
4343
- * @maxSize 10
4344
- * @deprecated List of draft post fields to be included in the response.
4345
- * @replacedBy fieldsets
4346
- * @targetRemovalDate 2024-06-30
4235
+ * App instance ID.
4236
+ * @format GUID
4347
4237
  */
4348
- fieldsToInclude?: FieldWithLiterals[];
4238
+ instanceId?: string | null;
4349
4239
  /**
4350
- * List of draft post fields to be included if entities are present in the response.
4351
- * Base fieldset, which is default, will return all core draft post properties.
4352
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4353
- * @maxSize 10
4240
+ * Event type.
4241
+ * @maxLength 150
4354
4242
  */
4355
- fieldsets?: FieldWithLiterals[];
4356
- }
4357
- interface RevertToUnpublishedResponse {
4358
- /** Updated post draft. */
4359
- draftPost?: DraftPost;
4243
+ eventType?: string;
4244
+ /** The identification type and identity data. */
4245
+ identity?: IdentificationData;
4246
+ /** Stringify payload. */
4247
+ data?: string;
4248
+ /** Details related to the account */
4249
+ accountInfo?: AccountInfo;
4360
4250
  }
4361
- interface RejectDraftPostRequest {
4251
+ interface IdentificationData extends IdentificationDataIdOneOf {
4362
4252
  /**
4363
- * Source post ID.
4253
+ * ID of a site visitor that has not logged in to the site.
4364
4254
  * @format GUID
4365
4255
  */
4366
- postId?: string;
4256
+ anonymousVisitorId?: string;
4367
4257
  /**
4368
- * List of draft post fields to be included in the response.
4369
- * @internal
4370
- * @maxSize 10
4371
- * @deprecated List of draft post fields to be included in the response.
4372
- * @replacedBy fieldsets
4373
- * @targetRemovalDate 2024-06-30
4258
+ * ID of a site visitor that has logged in to the site.
4259
+ * @format GUID
4374
4260
  */
4375
- fieldsToInclude?: FieldWithLiterals[];
4261
+ memberId?: string;
4376
4262
  /**
4377
- * List of draft post fields to be included if entities are present in the response.
4378
- * Base fieldset, which is default, will return all core draft post properties.
4379
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4380
- * @maxSize 10
4263
+ * ID of a Wix user (site owner, contributor, etc.).
4264
+ * @format GUID
4381
4265
  */
4382
- fieldsets?: FieldWithLiterals[];
4383
- }
4384
- interface RejectDraftPostResponse {
4385
- /** Draft post. */
4386
- draftPost?: DraftPost;
4266
+ wixUserId?: string;
4267
+ /**
4268
+ * ID of an app.
4269
+ * @format GUID
4270
+ */
4271
+ appId?: string;
4272
+ /** @readonly */
4273
+ identityType?: WebhookIdentityTypeWithLiterals;
4387
4274
  }
4388
- interface ApproveDraftPostRequest {
4275
+ /** @oneof */
4276
+ interface IdentificationDataIdOneOf {
4389
4277
  /**
4390
- * Source post ID.
4278
+ * ID of a site visitor that has not logged in to the site.
4391
4279
  * @format GUID
4392
4280
  */
4393
- postId?: string;
4281
+ anonymousVisitorId?: string;
4394
4282
  /**
4395
- * Scheduled publish date if should be not immediately published.
4396
- * @maxLength 24
4283
+ * ID of a site visitor that has logged in to the site.
4284
+ * @format GUID
4397
4285
  */
4398
- scheduledPublishDate?: string | null;
4286
+ memberId?: string;
4399
4287
  /**
4400
- * List of draft post fields to be included in the response.
4401
- * @internal
4402
- * @maxSize 10
4403
- * @deprecated List of draft post fields to be included in the response.
4404
- * @replacedBy fieldsets
4405
- * @targetRemovalDate 2024-06-30
4288
+ * ID of a Wix user (site owner, contributor, etc.).
4289
+ * @format GUID
4406
4290
  */
4407
- fieldsToInclude?: FieldWithLiterals[];
4291
+ wixUserId?: string;
4408
4292
  /**
4409
- * List of draft post fields to be included if entities are present in the response.
4410
- * Base fieldset, which is default, will return all core draft post properties.
4411
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4412
- * @maxSize 10
4293
+ * ID of an app.
4294
+ * @format GUID
4413
4295
  */
4414
- fieldsets?: FieldWithLiterals[];
4296
+ appId?: string;
4415
4297
  }
4416
- interface ApproveDraftPostResponse {
4417
- /** Updated post draft. */
4418
- draftPost?: DraftPost;
4298
+ declare enum WebhookIdentityType {
4299
+ UNKNOWN = "UNKNOWN",
4300
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
4301
+ MEMBER = "MEMBER",
4302
+ WIX_USER = "WIX_USER",
4303
+ APP = "APP"
4419
4304
  }
4420
- interface MarkPostAsInModerationRequest {
4305
+ /** @enumType */
4306
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
4307
+ interface AccountInfo {
4421
4308
  /**
4422
- * Source post ID.
4423
- * @maxLength 38
4309
+ * ID of the Wix account associated with the event.
4310
+ * @format GUID
4424
4311
  */
4425
- postId?: string;
4312
+ accountId?: string | null;
4426
4313
  /**
4427
- * List of draft post fields to be included in the response.
4428
- * @internal
4429
- * @maxSize 10
4430
- * @deprecated List of draft post fields to be included in the response.
4431
- * @replacedBy fieldsets
4432
- * @targetRemovalDate 2024-06-30
4314
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
4315
+ * @format GUID
4433
4316
  */
4434
- fieldsToInclude?: FieldWithLiterals[];
4317
+ parentAccountId?: string | null;
4435
4318
  /**
4436
- * List of draft post fields to be included if entities are present in the response.
4437
- * Base fieldset, which is default, will return all core draft post properties.
4438
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4319
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
4320
+ * @format GUID
4321
+ */
4322
+ siteId?: string | null;
4323
+ }
4324
+ interface GetDraftPostTotalsRequest {
4325
+ /**
4326
+ * Group results by fields (defaults to grouping by status).
4327
+ * If, for example, grouping by language is passed, language values in response will be filled.
4328
+ * If, for example, grouping by language is not passed, null values will be filled in language field in response.
4439
4329
  * @maxSize 10
4440
4330
  */
4441
- fieldsets?: FieldWithLiterals[];
4331
+ groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
4332
+ /**
4333
+ * Optional language filter by provided language code. Useful in multilingual context.
4334
+ * @format LANGUAGE_TAG
4335
+ */
4336
+ language?: string | null;
4442
4337
  }
4443
- interface MarkPostAsInModerationResponse {
4444
- /** Updated post draft. */
4445
- draftPost?: DraftPost;
4338
+ declare enum TotalDraftPostsGroupingField {
4339
+ /** Groups results by status. */
4340
+ STATUS = "STATUS",
4341
+ /** Groups results by language. */
4342
+ LANGUAGE = "LANGUAGE"
4343
+ }
4344
+ /** @enumType */
4345
+ type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
4346
+ interface GetDraftPostTotalsResponse {
4347
+ /** Draft post totals. */
4348
+ totalDraftPosts?: TotalDraftPosts[];
4349
+ }
4350
+ interface TotalDraftPosts {
4351
+ /** Draft post totals in that group. */
4352
+ total?: number;
4353
+ /** Draft post status (only has value when grouping by status, otherwise null). */
4354
+ status?: StatusWithLiterals;
4355
+ /**
4356
+ * Draft post language code (only has value when grouping by language, otherwise null).
4357
+ * @format LANGUAGE_TAG
4358
+ */
4359
+ language?: string | null;
4446
4360
  }
4447
4361
  interface TranslateDraftRequest {
4448
4362
  /**
@@ -4536,6 +4450,153 @@ interface UpdateDraftPostLanguageResponse {
4536
4450
  /** Updated draft post. */
4537
4451
  draftPost?: DraftPost;
4538
4452
  }
4453
+ interface BulkRevertToUnpublishedRequest {
4454
+ /**
4455
+ * Source post IDs.
4456
+ * @minSize 1
4457
+ * @maxSize 100
4458
+ * @format GUID
4459
+ */
4460
+ postIds?: string[];
4461
+ /** Should full draft post be returned. */
4462
+ returnFullEntity?: boolean;
4463
+ }
4464
+ interface BulkRevertToUnpublishedResponse {
4465
+ /** Bulk action results. */
4466
+ results?: BulkDraftPostResult[];
4467
+ /** Bulk action metadata. */
4468
+ bulkActionMetadata?: BulkActionMetadata;
4469
+ }
4470
+ interface BulkRejectDraftPostRequest {
4471
+ /**
4472
+ * Source post IDs.
4473
+ * @minSize 1
4474
+ * @maxSize 100
4475
+ * @format GUID
4476
+ */
4477
+ postIds?: string[];
4478
+ /** Should full draft post be returned. */
4479
+ returnFullEntity?: boolean;
4480
+ }
4481
+ interface BulkRejectDraftPostResponse {
4482
+ /** Bulk action results. */
4483
+ results?: BulkDraftPostResult[];
4484
+ /** Bulk action metadata. */
4485
+ bulkActionMetadata?: BulkActionMetadata;
4486
+ }
4487
+ interface RevertToUnpublishedRequest {
4488
+ /**
4489
+ * Source post ID.
4490
+ * @format GUID
4491
+ */
4492
+ postId?: string;
4493
+ /**
4494
+ * List of draft post fields to be included in the response.
4495
+ * @internal
4496
+ * @maxSize 10
4497
+ * @deprecated List of draft post fields to be included in the response.
4498
+ * @replacedBy fieldsets
4499
+ * @targetRemovalDate 2024-06-30
4500
+ */
4501
+ fieldsToInclude?: FieldWithLiterals[];
4502
+ /**
4503
+ * List of draft post fields to be included if entities are present in the response.
4504
+ * Base fieldset, which is default, will return all core draft post properties.
4505
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4506
+ * @maxSize 10
4507
+ */
4508
+ fieldsets?: FieldWithLiterals[];
4509
+ }
4510
+ interface RevertToUnpublishedResponse {
4511
+ /** Updated post draft. */
4512
+ draftPost?: DraftPost;
4513
+ }
4514
+ interface RejectDraftPostRequest {
4515
+ /**
4516
+ * Source post ID.
4517
+ * @format GUID
4518
+ */
4519
+ postId?: string;
4520
+ /**
4521
+ * List of draft post fields to be included in the response.
4522
+ * @internal
4523
+ * @maxSize 10
4524
+ * @deprecated List of draft post fields to be included in the response.
4525
+ * @replacedBy fieldsets
4526
+ * @targetRemovalDate 2024-06-30
4527
+ */
4528
+ fieldsToInclude?: FieldWithLiterals[];
4529
+ /**
4530
+ * List of draft post fields to be included if entities are present in the response.
4531
+ * Base fieldset, which is default, will return all core draft post properties.
4532
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4533
+ * @maxSize 10
4534
+ */
4535
+ fieldsets?: FieldWithLiterals[];
4536
+ }
4537
+ interface RejectDraftPostResponse {
4538
+ /** Draft post. */
4539
+ draftPost?: DraftPost;
4540
+ }
4541
+ interface ApproveDraftPostRequest {
4542
+ /**
4543
+ * Source post ID.
4544
+ * @format GUID
4545
+ */
4546
+ postId?: string;
4547
+ /**
4548
+ * Scheduled publish date if should be not immediately published.
4549
+ * @maxLength 24
4550
+ */
4551
+ scheduledPublishDate?: string | null;
4552
+ /**
4553
+ * List of draft post fields to be included in the response.
4554
+ * @internal
4555
+ * @maxSize 10
4556
+ * @deprecated List of draft post fields to be included in the response.
4557
+ * @replacedBy fieldsets
4558
+ * @targetRemovalDate 2024-06-30
4559
+ */
4560
+ fieldsToInclude?: FieldWithLiterals[];
4561
+ /**
4562
+ * List of draft post fields to be included if entities are present in the response.
4563
+ * Base fieldset, which is default, will return all core draft post properties.
4564
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4565
+ * @maxSize 10
4566
+ */
4567
+ fieldsets?: FieldWithLiterals[];
4568
+ }
4569
+ interface ApproveDraftPostResponse {
4570
+ /** Updated post draft. */
4571
+ draftPost?: DraftPost;
4572
+ }
4573
+ interface MarkPostAsInModerationRequest {
4574
+ /**
4575
+ * Source post ID.
4576
+ * @maxLength 38
4577
+ */
4578
+ postId?: string;
4579
+ /**
4580
+ * List of draft post fields to be included in the response.
4581
+ * @internal
4582
+ * @maxSize 10
4583
+ * @deprecated List of draft post fields to be included in the response.
4584
+ * @replacedBy fieldsets
4585
+ * @targetRemovalDate 2024-06-30
4586
+ */
4587
+ fieldsToInclude?: FieldWithLiterals[];
4588
+ /**
4589
+ * List of draft post fields to be included if entities are present in the response.
4590
+ * Base fieldset, which is default, will return all core draft post properties.
4591
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4592
+ * @maxSize 10
4593
+ */
4594
+ fieldsets?: FieldWithLiterals[];
4595
+ }
4596
+ interface MarkPostAsInModerationResponse {
4597
+ /** Updated post draft. */
4598
+ draftPost?: DraftPost;
4599
+ }
4539
4600
  interface BaseEventMetadata {
4540
4601
  /**
4541
4602
  * App instance ID.