@wix/auto_sdk_blog_draft-posts 1.0.118 → 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.
@@ -951,6 +951,8 @@ interface TextStyle {
951
951
  textAlignment?: TextAlignmentWithLiterals;
952
952
  /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
953
953
  lineHeight?: string | null;
954
+ /** Font size of an empty block: it sizes the empty line, its list marker and the text typed into it. Ignored on a block with text, which is sized by its text's `FONT_SIZE` decorations. */
955
+ fontSize?: FontSizeData;
954
956
  }
955
957
  declare enum TextAlignment {
956
958
  /** browser default, eqivalent to `initial` */
@@ -966,6 +968,18 @@ declare enum TextAlignment {
966
968
  }
967
969
  /** @enumType */
968
970
  type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
971
+ interface FontSizeData {
972
+ /** The units used for the font size. */
973
+ unit?: FontTypeWithLiterals;
974
+ /** Font size value. */
975
+ value?: number | null;
976
+ }
977
+ declare enum FontType {
978
+ PX = "PX",
979
+ EM = "EM"
980
+ }
981
+ /** @enumType */
982
+ type FontTypeWithLiterals = FontType | 'PX' | 'EM';
969
983
  interface DividerData {
970
984
  /** Styling for the divider's container. */
971
985
  containerData?: PluginContainerData;
@@ -1830,18 +1844,6 @@ interface MentionData {
1830
1844
  /** The kind of entity the mention refers to. Any value is accepted, and it's usually used to mark a mention as a group mention (for example, `group`). When empty, the mention refers to a member. */
1831
1845
  type?: string | null;
1832
1846
  }
1833
- interface FontSizeData {
1834
- /** The units used for the font size. */
1835
- unit?: FontTypeWithLiterals;
1836
- /** Font size value. */
1837
- value?: number | null;
1838
- }
1839
- declare enum FontType {
1840
- PX = "PX",
1841
- EM = "EM"
1842
- }
1843
- /** @enumType */
1844
- type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1845
1847
  interface SpoilerData {
1846
1848
  /** Spoiler ID. */
1847
1849
  id?: string | null;
@@ -3117,73 +3119,117 @@ declare enum ModerationStatusStatus {
3117
3119
  /** @enumType */
3118
3120
  type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
3119
3121
  /**
3120
- * 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.
3121
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
3122
- * 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.
3122
+ * The SEO data for a single page or dynamic item, in the shape stored today.
3123
+ *
3124
+ * FROZEN. Existing server code maps onto this message field by field, so its
3125
+ * field set must never change (see the file header). New writers use
3126
+ * `SeoSchemaV2`.
3127
+ *
3128
+ * These tags are rendered into the <head> of the HTML document and are not
3129
+ * visible on the page itself. They override every other source of tags
3130
+ * (site defaults, vertical presets, patterns) for this page.
3123
3131
  */
3124
3132
  interface SeoSchema {
3125
- /** SEO tag information. */
3133
+ /**
3134
+ * The tags rendered into <head>, in no particular order. Render order is
3135
+ * decided by the renderer, not by position in this list.
3136
+ *
3137
+ * No maxSize: this list is already populated by data written years ago, and
3138
+ * a bound added now could reject a page that is already stored.
3139
+ */
3126
3140
  tags?: Tag[];
3127
- /** SEO general settings. */
3141
+ /** Page-level SEO settings that are not themselves tags. */
3128
3142
  settings?: Settings;
3129
3143
  }
3144
+ /** A keyword term the user is targeting. */
3130
3145
  interface Keyword {
3131
- /** Keyword value. */
3146
+ /**
3147
+ * The term itself, e.g. "trail running shoes".
3148
+ *
3149
+ * No maxLength, for the same reason as the legacy tag fields: keywords are
3150
+ * already stored, and a bound added now could reject a record written
3151
+ * before the bound existed. The flynt `missing-string-validations` warning
3152
+ * on this field is accepted deliberately.
3153
+ */
3132
3154
  term?: string;
3133
- /** Whether the keyword is the main focus keyword. */
3155
+ /** Whether this is the page's primary focus keyword. At most one per page. */
3134
3156
  isMain?: boolean;
3135
3157
  /**
3136
- * The source that added the keyword terms to the SEO settings.
3158
+ * Which surface added the term, e.g. a panel or a suggestion flow. Used for
3159
+ * attribution in BI. Opaque to the renderer.
3137
3160
  * @maxLength 1000
3138
3161
  */
3139
3162
  origin?: string | null;
3140
3163
  }
3164
+ /**
3165
+ * One tag in the page's <head>.
3166
+ *
3167
+ * Not deprecated, and with no removal date, deliberately: stored data is
3168
+ * never migrated, so this shape stays valid input forever. `seo-renderer`
3169
+ * normalizes both shapes on READ.
3170
+ */
3141
3171
  interface Tag {
3142
3172
  /**
3143
- * SEO tag type.
3144
- *
3173
+ * Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
3174
+ * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
3175
+ * the invalid combinations unrepresentable rather than merely discouraged.
3145
3176
  *
3146
- * Supported values: `title`, `meta`, `script`, `link`.
3147
- *
3148
- * Which of these an API actually accepts depends on where the tag is being set: this
3149
- * list is not a blanket guarantee across every API that reuses this message. Site SEO
3150
- * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
3151
- * `title`/`script`/`link` with a validation error even though they appear here —
3152
- * check the field description of the specific `tags`-typed field you're writing to
3153
- * for the types it actually supports and the error it returns.
3177
+ * Which of these an API actually accepts depends on where the tag is being
3178
+ * set: this list is not a blanket guarantee across every API that reuses
3179
+ * this message. Site SEO Tags in particular accepts only `meta` (see
3180
+ * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
3181
+ * error even though they appear here — check the field description of the
3182
+ * specific `tags`-typed field you are writing to.
3154
3183
  *
3155
3184
  * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
3156
- * `"application/ld+json"` carrying structured data) are supported only when
3157
- * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
3158
- * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
3159
- * write through the site's Advanced/Custom Tags list. To write structured data,
3160
- * omit `custom` (or set it to `false`).
3185
+ * "application/ld+json" carrying structured data) are supported only when
3186
+ * `custom` is unset or `false`. Setting `custom: true` on a `title` or
3187
+ * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
3188
+ * `custom: true` routes the write through the site's Advanced/Custom Tags
3189
+ * list. To write structured data, omit `custom` (or set it to `false`).
3190
+ *
3191
+ * No length limit: this field holds data written years ago by writers we
3192
+ * are not migrating. A constraint here could reject a record that is
3193
+ * already stored, which is exactly the promise this design makes.
3161
3194
  */
3162
3195
  type?: string;
3163
3196
  /**
3164
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
3165
- * For example: `{"name": "description", "content": "the description itself"}`.
3197
+ * Legacy. Was an untyped bag of HTML attributes.
3198
+ * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
3166
3199
  */
3167
3200
  props?: Record<string, any> | null;
3168
- /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
3201
+ /**
3202
+ * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
3203
+ * its contents are split by purpose: per-page structured-data state moves to
3204
+ * StructuredDataTag, authorship to `written_by`, and render-time preset
3205
+ * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
3206
+ * stored document entirely — it belongs to the preset definition, not to the
3207
+ * page. See the design log for the full key-by-key mapping.
3208
+ */
3169
3209
  meta?: Record<string, any> | null;
3170
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
3210
+ /**
3211
+ * Legacy. Was the tag's inner content, doubling as the JSON-LD payload
3212
+ * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
3213
+ * `StructuredDataTag.json_ld`.
3214
+ * No length limit, for the same reason as `type` above.
3215
+ */
3171
3216
  children?: string;
3172
3217
  /**
3173
3218
  * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
3174
3219
  * i.e. an entry from the site's Advanced/Custom Tags list.
3175
3220
  *
3176
- * Setting this to `true` on a write restricts which `type` values are accepted
3177
- * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
3178
- * `script` tags (including JSON-LD structured data) must be sent with `custom`
3179
- * omitted or `false`; sending them with `custom: true` is rejected with
3180
- * `TAG_TYPE_NOT_ALLOWED`.
3221
+ * Setting this to `true` on a write restricts which `type` values are
3222
+ * accepted — the same restriction the Advanced/Custom Tags UI enforces.
3223
+ * `title` and `script` tags (including JSON-LD structured data) must be sent
3224
+ * with `custom` omitted or `false`; sending them with `custom: true` is
3225
+ * rejected with `TAG_TYPE_NOT_ALLOWED`.
3181
3226
  *
3182
- * Note this is a separate restriction from Site SEO Tags' own type restriction on
3183
- * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
3184
- * for site-wide structured data) unconditionally. There is currently no way to set
3185
- * site-wide, every-page structured data through any of these APIs — write a per-page
3186
- * `script` tag through the Item SEO Tags API instead.
3227
+ * Note this is a separate restriction from Site SEO Tags' own type
3228
+ * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
3229
+ * rejects `script` (e.g. for site-wide structured data) unconditionally.
3230
+ * There is currently no way to set site-wide, every-page structured data
3231
+ * through any of these APIs — write a per-page `script` tag through the Item
3232
+ * SEO Tags API instead.
3187
3233
  *
3188
3234
  * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
3189
3235
  * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
@@ -3196,22 +3242,39 @@ interface Tag {
3196
3242
  * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
3197
3243
  * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
3198
3244
  * Pass `seoData` explicitly to resolve against a known set of tags.
3245
+ *
3246
+ * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
3199
3247
  */
3200
3248
  custom?: boolean;
3201
- /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
3249
+ /**
3250
+ * Whether the tag is excluded from the rendered <head>.
3251
+ *
3252
+ * A disabled tag is still stored, so the user can re-enable it and so a
3253
+ * pattern-provided tag stays suppressed on this page. Default false.
3254
+ */
3202
3255
  disabled?: boolean;
3203
3256
  }
3257
+ /** Page-level SEO settings that are not tags. */
3204
3258
  interface Settings {
3205
3259
  /**
3206
- * 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.
3260
+ * Whether to suppress the automatic redirect from this page's previous URL to
3261
+ * its current one after a slug change.
3207
3262
  *
3208
- *
3209
- * Default: `false` (automatical redirect is enabled).
3263
+ * Default false, meaning the redirect IS created. The field is named for the
3264
+ * exception rather than the rule, which reads backwards; kept as-is because
3265
+ * renaming a stored boolean is not worth the migration.
3210
3266
  */
3211
3267
  preventAutoRedirect?: boolean;
3212
3268
  /**
3213
- * User-selected keyword terms for a specific page.
3214
- * @maxSize 5
3269
+ * Keyword terms the user is targeting for this page. Used by the SEO
3270
+ * assistant and checklist; never rendered into <head>.
3271
+ *
3272
+ * 20 is a sanity bound, not the product limit. v1 declared 5 — the number
3273
+ * the panel happens to allow today — which is exactly the mistake we are
3274
+ * fixing for structured data. A product decision to allow 8 should not need
3275
+ * a proto release, so the panel owns that number and the proto only stops
3276
+ * something absurd.
3277
+ * @maxSize 20
3215
3278
  */
3216
3279
  keywords?: Keyword[];
3217
3280
  }
@@ -3326,6 +3389,10 @@ interface DraftPostTranslation {
3326
3389
  /** Post URL. */
3327
3390
  url?: PageUrl;
3328
3391
  }
3392
+ interface InitialDraftPostsCopied {
3393
+ /** Number of draft posts copied. */
3394
+ count?: number;
3395
+ }
3329
3396
  interface DraftCategoriesUpdated {
3330
3397
  /**
3331
3398
  * Draft post ID.
@@ -3364,202 +3431,6 @@ interface DraftTagsUpdated {
3364
3431
  */
3365
3432
  previousTags?: string[];
3366
3433
  }
3367
- interface GetDraftPostTotalsRequest {
3368
- /**
3369
- * Group results by fields (defaults to grouping by status).
3370
- * If, for example, grouping by language is passed, language values in response will be filled.
3371
- * If, for example, grouping by language is not passed, null values will be filled in language field in response.
3372
- * @maxSize 10
3373
- */
3374
- groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
3375
- /**
3376
- * Optional language filter by provided language code. Useful in multilingual context.
3377
- * @format LANGUAGE_TAG
3378
- */
3379
- language?: string | null;
3380
- }
3381
- declare enum TotalDraftPostsGroupingField {
3382
- /** Groups results by status. */
3383
- STATUS = "STATUS",
3384
- /** Groups results by language. */
3385
- LANGUAGE = "LANGUAGE"
3386
- }
3387
- /** @enumType */
3388
- type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
3389
- interface GetDraftPostTotalsResponse {
3390
- /** Draft post totals. */
3391
- totalDraftPosts?: TotalDraftPosts[];
3392
- }
3393
- interface TotalDraftPosts {
3394
- /** Draft post totals in that group. */
3395
- total?: number;
3396
- /** Draft post status (only has value when grouping by status, otherwise null). */
3397
- status?: StatusWithLiterals;
3398
- /**
3399
- * Draft post language code (only has value when grouping by language, otherwise null).
3400
- * @format LANGUAGE_TAG
3401
- */
3402
- language?: string | null;
3403
- }
3404
- interface DomainEvent extends DomainEventBodyOneOf {
3405
- createdEvent?: EntityCreatedEvent;
3406
- updatedEvent?: EntityUpdatedEvent;
3407
- deletedEvent?: EntityDeletedEvent;
3408
- actionEvent?: ActionEvent;
3409
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3410
- id?: string;
3411
- /**
3412
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3413
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3414
- */
3415
- entityFqdn?: string;
3416
- /**
3417
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
3418
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3419
- */
3420
- slug?: string;
3421
- /** ID of the entity associated with the event. */
3422
- entityId?: string;
3423
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3424
- eventTime?: Date | null;
3425
- /**
3426
- * Whether the event was triggered as a result of a privacy regulation application
3427
- * (for example, GDPR).
3428
- */
3429
- triggeredByAnonymizeRequest?: boolean | null;
3430
- /** If present, indicates the action that triggered the event. */
3431
- originatedFrom?: string | null;
3432
- /**
3433
- * 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.
3434
- * 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.
3435
- */
3436
- entityEventSequence?: string | null;
3437
- }
3438
- /** @oneof */
3439
- interface DomainEventBodyOneOf {
3440
- createdEvent?: EntityCreatedEvent;
3441
- updatedEvent?: EntityUpdatedEvent;
3442
- deletedEvent?: EntityDeletedEvent;
3443
- actionEvent?: ActionEvent;
3444
- }
3445
- interface EntityCreatedEvent {
3446
- entityAsJson?: string;
3447
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3448
- restoreInfo?: RestoreInfo;
3449
- }
3450
- interface RestoreInfo {
3451
- deletedDate?: Date | null;
3452
- }
3453
- interface EntityUpdatedEvent {
3454
- /**
3455
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3456
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3457
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3458
- */
3459
- currentEntityAsJson?: string;
3460
- }
3461
- interface EntityDeletedEvent {
3462
- /** Entity that was deleted. */
3463
- deletedEntityAsJson?: string | null;
3464
- }
3465
- interface ActionEvent {
3466
- bodyAsJson?: string;
3467
- }
3468
- interface MessageEnvelope {
3469
- /**
3470
- * App instance ID.
3471
- * @format GUID
3472
- */
3473
- instanceId?: string | null;
3474
- /**
3475
- * Event type.
3476
- * @maxLength 150
3477
- */
3478
- eventType?: string;
3479
- /** The identification type and identity data. */
3480
- identity?: IdentificationData;
3481
- /** Stringify payload. */
3482
- data?: string;
3483
- /** Details related to the account */
3484
- accountInfo?: AccountInfo;
3485
- }
3486
- interface IdentificationData extends IdentificationDataIdOneOf {
3487
- /**
3488
- * ID of a site visitor that has not logged in to the site.
3489
- * @format GUID
3490
- */
3491
- anonymousVisitorId?: string;
3492
- /**
3493
- * ID of a site visitor that has logged in to the site.
3494
- * @format GUID
3495
- */
3496
- memberId?: string;
3497
- /**
3498
- * ID of a Wix user (site owner, contributor, etc.).
3499
- * @format GUID
3500
- */
3501
- wixUserId?: string;
3502
- /**
3503
- * ID of an app.
3504
- * @format GUID
3505
- */
3506
- appId?: string;
3507
- /** @readonly */
3508
- identityType?: WebhookIdentityTypeWithLiterals;
3509
- }
3510
- /** @oneof */
3511
- interface IdentificationDataIdOneOf {
3512
- /**
3513
- * ID of a site visitor that has not logged in to the site.
3514
- * @format GUID
3515
- */
3516
- anonymousVisitorId?: string;
3517
- /**
3518
- * ID of a site visitor that has logged in to the site.
3519
- * @format GUID
3520
- */
3521
- memberId?: string;
3522
- /**
3523
- * ID of a Wix user (site owner, contributor, etc.).
3524
- * @format GUID
3525
- */
3526
- wixUserId?: string;
3527
- /**
3528
- * ID of an app.
3529
- * @format GUID
3530
- */
3531
- appId?: string;
3532
- }
3533
- declare enum WebhookIdentityType {
3534
- UNKNOWN = "UNKNOWN",
3535
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3536
- MEMBER = "MEMBER",
3537
- WIX_USER = "WIX_USER",
3538
- APP = "APP"
3539
- }
3540
- /** @enumType */
3541
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3542
- interface AccountInfo {
3543
- /**
3544
- * ID of the Wix account associated with the event.
3545
- * @format GUID
3546
- */
3547
- accountId?: string | null;
3548
- /**
3549
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
3550
- * @format GUID
3551
- */
3552
- parentAccountId?: string | null;
3553
- /**
3554
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3555
- * @format GUID
3556
- */
3557
- siteId?: string | null;
3558
- }
3559
- interface InitialDraftPostsCopied {
3560
- /** Number of draft posts copied. */
3561
- count?: number;
3562
- }
3563
3434
  interface CreateDraftPostRequest {
3564
3435
  /** Draft post to create. */
3565
3436
  draftPost: DraftPost;
@@ -4140,116 +4011,197 @@ interface DraftPostCount {
4140
4011
  /** Number of posts. */
4141
4012
  postCount?: number;
4142
4013
  }
4143
- interface BulkRevertToUnpublishedRequest {
4144
- /**
4145
- * Source post IDs.
4146
- * @minSize 1
4147
- * @maxSize 100
4148
- * @format GUID
4149
- */
4150
- postIds?: string[];
4151
- /** Should full draft post be returned. */
4152
- returnFullEntity?: boolean;
4014
+ interface DomainEvent extends DomainEventBodyOneOf {
4015
+ createdEvent?: EntityCreatedEvent;
4016
+ updatedEvent?: EntityUpdatedEvent;
4017
+ deletedEvent?: EntityDeletedEvent;
4018
+ actionEvent?: ActionEvent;
4019
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4020
+ id?: string;
4021
+ /**
4022
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
4023
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4024
+ */
4025
+ entityFqdn?: string;
4026
+ /**
4027
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
4028
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4029
+ */
4030
+ slug?: string;
4031
+ /** ID of the entity associated with the event. */
4032
+ entityId?: string;
4033
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4034
+ eventTime?: Date | null;
4035
+ /**
4036
+ * Whether the event was triggered as a result of a privacy regulation application
4037
+ * (for example, GDPR).
4038
+ */
4039
+ triggeredByAnonymizeRequest?: boolean | null;
4040
+ /** If present, indicates the action that triggered the event. */
4041
+ originatedFrom?: string | null;
4042
+ /**
4043
+ * 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.
4044
+ * 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.
4045
+ */
4046
+ entityEventSequence?: string | null;
4153
4047
  }
4154
- interface BulkRevertToUnpublishedResponse {
4155
- /** Bulk action results. */
4156
- results?: BulkDraftPostResult[];
4157
- /** Bulk action metadata. */
4158
- bulkActionMetadata?: BulkActionMetadata;
4048
+ /** @oneof */
4049
+ interface DomainEventBodyOneOf {
4050
+ createdEvent?: EntityCreatedEvent;
4051
+ updatedEvent?: EntityUpdatedEvent;
4052
+ deletedEvent?: EntityDeletedEvent;
4053
+ actionEvent?: ActionEvent;
4159
4054
  }
4160
- interface BulkRejectDraftPostRequest {
4055
+ interface EntityCreatedEvent {
4056
+ entityAsJson?: string;
4057
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
4058
+ restoreInfo?: RestoreInfo;
4059
+ }
4060
+ interface RestoreInfo {
4061
+ deletedDate?: Date | null;
4062
+ }
4063
+ interface EntityUpdatedEvent {
4161
4064
  /**
4162
- * Source post IDs.
4163
- * @minSize 1
4164
- * @maxSize 100
4165
- * @format GUID
4065
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
4066
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
4067
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
4166
4068
  */
4167
- postIds?: string[];
4168
- /** Should full draft post be returned. */
4169
- returnFullEntity?: boolean;
4069
+ currentEntityAsJson?: string;
4170
4070
  }
4171
- interface BulkRejectDraftPostResponse {
4172
- /** Bulk action results. */
4173
- results?: BulkDraftPostResult[];
4174
- /** Bulk action metadata. */
4175
- bulkActionMetadata?: BulkActionMetadata;
4071
+ interface EntityDeletedEvent {
4072
+ /** Entity that was deleted. */
4073
+ deletedEntityAsJson?: string | null;
4176
4074
  }
4177
- interface RevertToUnpublishedRequest {
4075
+ interface ActionEvent {
4076
+ bodyAsJson?: string;
4077
+ }
4078
+ interface MessageEnvelope {
4178
4079
  /**
4179
- * Source post ID.
4080
+ * App instance ID.
4180
4081
  * @format GUID
4181
4082
  */
4182
- postId?: string;
4083
+ instanceId?: string | null;
4183
4084
  /**
4184
- * List of draft post fields to be included if entities are present in the response.
4185
- * Base fieldset, which is default, will return all core draft post properties.
4186
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4187
- * @maxSize 10
4085
+ * Event type.
4086
+ * @maxLength 150
4188
4087
  */
4189
- fieldsets?: FieldWithLiterals[];
4190
- }
4191
- interface RevertToUnpublishedResponse {
4192
- /** Updated post draft. */
4193
- draftPost?: DraftPost;
4088
+ eventType?: string;
4089
+ /** The identification type and identity data. */
4090
+ identity?: IdentificationData;
4091
+ /** Stringify payload. */
4092
+ data?: string;
4093
+ /** Details related to the account */
4094
+ accountInfo?: AccountInfo;
4194
4095
  }
4195
- interface RejectDraftPostRequest {
4096
+ interface IdentificationData extends IdentificationDataIdOneOf {
4196
4097
  /**
4197
- * Source post ID.
4098
+ * ID of a site visitor that has not logged in to the site.
4198
4099
  * @format GUID
4199
4100
  */
4200
- postId?: string;
4101
+ anonymousVisitorId?: string;
4201
4102
  /**
4202
- * List of draft post fields to be included if entities are present in the response.
4203
- * Base fieldset, which is default, will return all core draft post properties.
4204
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4205
- * @maxSize 10
4103
+ * ID of a site visitor that has logged in to the site.
4104
+ * @format GUID
4206
4105
  */
4207
- fieldsets?: FieldWithLiterals[];
4208
- }
4209
- interface RejectDraftPostResponse {
4210
- /** Draft post. */
4211
- draftPost?: DraftPost;
4106
+ memberId?: string;
4107
+ /**
4108
+ * ID of a Wix user (site owner, contributor, etc.).
4109
+ * @format GUID
4110
+ */
4111
+ wixUserId?: string;
4112
+ /**
4113
+ * ID of an app.
4114
+ * @format GUID
4115
+ */
4116
+ appId?: string;
4117
+ /** @readonly */
4118
+ identityType?: WebhookIdentityTypeWithLiterals;
4212
4119
  }
4213
- interface ApproveDraftPostRequest {
4120
+ /** @oneof */
4121
+ interface IdentificationDataIdOneOf {
4214
4122
  /**
4215
- * Source post ID.
4123
+ * ID of a site visitor that has not logged in to the site.
4216
4124
  * @format GUID
4217
4125
  */
4218
- postId?: string;
4126
+ anonymousVisitorId?: string;
4219
4127
  /**
4220
- * Scheduled publish date if should be not immediately published.
4221
- * @maxLength 24
4128
+ * ID of a site visitor that has logged in to the site.
4129
+ * @format GUID
4222
4130
  */
4223
- scheduledPublishDate?: string | null;
4131
+ memberId?: string;
4224
4132
  /**
4225
- * List of draft post fields to be included if entities are present in the response.
4226
- * Base fieldset, which is default, will return all core draft post properties.
4227
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4228
- * @maxSize 10
4133
+ * ID of a Wix user (site owner, contributor, etc.).
4134
+ * @format GUID
4229
4135
  */
4230
- fieldsets?: FieldWithLiterals[];
4136
+ wixUserId?: string;
4137
+ /**
4138
+ * ID of an app.
4139
+ * @format GUID
4140
+ */
4141
+ appId?: string;
4231
4142
  }
4232
- interface ApproveDraftPostResponse {
4233
- /** Updated post draft. */
4234
- draftPost?: DraftPost;
4143
+ declare enum WebhookIdentityType {
4144
+ UNKNOWN = "UNKNOWN",
4145
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
4146
+ MEMBER = "MEMBER",
4147
+ WIX_USER = "WIX_USER",
4148
+ APP = "APP"
4235
4149
  }
4236
- interface MarkPostAsInModerationRequest {
4150
+ /** @enumType */
4151
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
4152
+ interface AccountInfo {
4237
4153
  /**
4238
- * Source post ID.
4239
- * @maxLength 38
4154
+ * ID of the Wix account associated with the event.
4155
+ * @format GUID
4240
4156
  */
4241
- postId?: string;
4157
+ accountId?: string | null;
4242
4158
  /**
4243
- * List of draft post fields to be included if entities are present in the response.
4244
- * Base fieldset, which is default, will return all core draft post properties.
4245
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4159
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
4160
+ * @format GUID
4161
+ */
4162
+ parentAccountId?: string | null;
4163
+ /**
4164
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
4165
+ * @format GUID
4166
+ */
4167
+ siteId?: string | null;
4168
+ }
4169
+ interface GetDraftPostTotalsRequest {
4170
+ /**
4171
+ * Group results by fields (defaults to grouping by status).
4172
+ * If, for example, grouping by language is passed, language values in response will be filled.
4173
+ * If, for example, grouping by language is not passed, null values will be filled in language field in response.
4246
4174
  * @maxSize 10
4247
4175
  */
4248
- fieldsets?: FieldWithLiterals[];
4176
+ groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
4177
+ /**
4178
+ * Optional language filter by provided language code. Useful in multilingual context.
4179
+ * @format LANGUAGE_TAG
4180
+ */
4181
+ language?: string | null;
4249
4182
  }
4250
- interface MarkPostAsInModerationResponse {
4251
- /** Updated post draft. */
4252
- draftPost?: DraftPost;
4183
+ declare enum TotalDraftPostsGroupingField {
4184
+ /** Groups results by status. */
4185
+ STATUS = "STATUS",
4186
+ /** Groups results by language. */
4187
+ LANGUAGE = "LANGUAGE"
4188
+ }
4189
+ /** @enumType */
4190
+ type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
4191
+ interface GetDraftPostTotalsResponse {
4192
+ /** Draft post totals. */
4193
+ totalDraftPosts?: TotalDraftPosts[];
4194
+ }
4195
+ interface TotalDraftPosts {
4196
+ /** Draft post totals in that group. */
4197
+ total?: number;
4198
+ /** Draft post status (only has value when grouping by status, otherwise null). */
4199
+ status?: StatusWithLiterals;
4200
+ /**
4201
+ * Draft post language code (only has value when grouping by language, otherwise null).
4202
+ * @format LANGUAGE_TAG
4203
+ */
4204
+ language?: string | null;
4253
4205
  }
4254
4206
  interface TranslateDraftRequest {
4255
4207
  /**
@@ -4336,6 +4288,117 @@ interface UpdateDraftPostLanguageResponse {
4336
4288
  /** Updated draft post. */
4337
4289
  draftPost?: DraftPost;
4338
4290
  }
4291
+ interface BulkRevertToUnpublishedRequest {
4292
+ /**
4293
+ * Source post IDs.
4294
+ * @minSize 1
4295
+ * @maxSize 100
4296
+ * @format GUID
4297
+ */
4298
+ postIds?: string[];
4299
+ /** Should full draft post be returned. */
4300
+ returnFullEntity?: boolean;
4301
+ }
4302
+ interface BulkRevertToUnpublishedResponse {
4303
+ /** Bulk action results. */
4304
+ results?: BulkDraftPostResult[];
4305
+ /** Bulk action metadata. */
4306
+ bulkActionMetadata?: BulkActionMetadata;
4307
+ }
4308
+ interface BulkRejectDraftPostRequest {
4309
+ /**
4310
+ * Source post IDs.
4311
+ * @minSize 1
4312
+ * @maxSize 100
4313
+ * @format GUID
4314
+ */
4315
+ postIds?: string[];
4316
+ /** Should full draft post be returned. */
4317
+ returnFullEntity?: boolean;
4318
+ }
4319
+ interface BulkRejectDraftPostResponse {
4320
+ /** Bulk action results. */
4321
+ results?: BulkDraftPostResult[];
4322
+ /** Bulk action metadata. */
4323
+ bulkActionMetadata?: BulkActionMetadata;
4324
+ }
4325
+ interface RevertToUnpublishedRequest {
4326
+ /**
4327
+ * Source post ID.
4328
+ * @format GUID
4329
+ */
4330
+ postId?: string;
4331
+ /**
4332
+ * List of draft post fields to be included if entities are present in the response.
4333
+ * Base fieldset, which is default, will return all core draft post properties.
4334
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4335
+ * @maxSize 10
4336
+ */
4337
+ fieldsets?: FieldWithLiterals[];
4338
+ }
4339
+ interface RevertToUnpublishedResponse {
4340
+ /** Updated post draft. */
4341
+ draftPost?: DraftPost;
4342
+ }
4343
+ interface RejectDraftPostRequest {
4344
+ /**
4345
+ * Source post ID.
4346
+ * @format GUID
4347
+ */
4348
+ postId?: string;
4349
+ /**
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
4354
+ */
4355
+ fieldsets?: FieldWithLiterals[];
4356
+ }
4357
+ interface RejectDraftPostResponse {
4358
+ /** Draft post. */
4359
+ draftPost?: DraftPost;
4360
+ }
4361
+ interface ApproveDraftPostRequest {
4362
+ /**
4363
+ * Source post ID.
4364
+ * @format GUID
4365
+ */
4366
+ postId?: string;
4367
+ /**
4368
+ * Scheduled publish date if should be not immediately published.
4369
+ * @maxLength 24
4370
+ */
4371
+ scheduledPublishDate?: string | null;
4372
+ /**
4373
+ * List of draft post fields to be included if entities are present in the response.
4374
+ * Base fieldset, which is default, will return all core draft post properties.
4375
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4376
+ * @maxSize 10
4377
+ */
4378
+ fieldsets?: FieldWithLiterals[];
4379
+ }
4380
+ interface ApproveDraftPostResponse {
4381
+ /** Updated post draft. */
4382
+ draftPost?: DraftPost;
4383
+ }
4384
+ interface MarkPostAsInModerationRequest {
4385
+ /**
4386
+ * Source post ID.
4387
+ * @maxLength 38
4388
+ */
4389
+ postId?: string;
4390
+ /**
4391
+ * List of draft post fields to be included if entities are present in the response.
4392
+ * Base fieldset, which is default, will return all core draft post properties.
4393
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4394
+ * @maxSize 10
4395
+ */
4396
+ fieldsets?: FieldWithLiterals[];
4397
+ }
4398
+ interface MarkPostAsInModerationResponse {
4399
+ /** Updated post draft. */
4400
+ draftPost?: DraftPost;
4401
+ }
4339
4402
 
4340
4403
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4341
4404
  getUrl: (context: any) => string;