@wix/auto_sdk_blog_draft-posts 1.0.92 → 1.0.93

package/build/internal/cjs/index.typings.d.ts

@@ -3018,7 +3018,15 @@ interface Tag {
     meta?: Record<string, any> | null;
     /** SEO tag inner content. For example, `<title> inner content </title>`. */
     children?: string;
-    /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
+    /**
+     * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
+     *
+     * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
+     * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
+     * or Wix Studio pages, so custom tags saved on those pages are missing from the response entirely. For
+     * those pages `false` therefore does not mean "not a custom tag" — it means this API could not tell.
+     * Pass `seoData` explicitly to resolve against a known set of tags.
+     */
     custom?: boolean;
     /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
     disabled?: boolean;
@@ -3187,10 +3195,6 @@ interface DraftPostTranslation {
     /** Post URL. */
     url?: string;
 }
-interface InitialDraftPostsCopied {
-    /** Number of draft posts copied. */
-    count?: number;
-}
 interface DraftCategoriesUpdated {
     /**
      * Draft post ID.
@@ -3229,6 +3233,200 @@ interface DraftTagsUpdated {
      */
     previousTags?: string[];
 }
+interface GetDraftPostTotalsRequest {
+    /**
+     * Group results by fields (defaults to grouping by status).
+     * If, for example, grouping by language is passed, language values in response will be filled.
+     * If, for example, grouping by language is not passed, null values will be filled in language field in response.
+     * @maxSize 10
+     */
+    groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
+    /**
+     * Optional language filter by provided language code. Useful in multilingual context.
+     * @format LANGUAGE_TAG
+     */
+    language?: string | null;
+}
+declare enum TotalDraftPostsGroupingField {
+    /** Groups results by status. */
+    STATUS = "STATUS",
+    /** Groups results by language. */
+    LANGUAGE = "LANGUAGE"
+}
+/** @enumType */
+type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
+interface GetDraftPostTotalsResponse {
+    /** Draft post totals. */
+    totalDraftPosts?: TotalDraftPosts[];
+}
+interface TotalDraftPosts {
+    /** Draft post totals in that group. */
+    total?: number;
+    /** Draft post status (only has value when grouping by status, otherwise null). */
+    status?: StatusWithLiterals;
+    /**
+     * Draft post language code (only has value when grouping by language, otherwise null).
+     * @format LANGUAGE_TAG
+     */
+    language?: string | null;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * 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.
+     * 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.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface InitialDraftPostsCopied {
+    /** Number of draft posts copied. */
+    count?: number;
+}
 interface CreateDraftPostRequest {
     /** Draft post to create. */
     draftPost: DraftPost;
@@ -3878,195 +4076,152 @@ interface DraftPostCount {
     /** Number of posts. */
     postCount?: number;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    _id?: string;
+interface BulkRevertToUnpublishedRequest {
     /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     * Source post IDs.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
      */
-    entityFqdn?: string;
+    postIds?: string[];
+    /** Should full draft post be returned. */
+    returnFullEntity?: boolean;
+}
+interface BulkRevertToUnpublishedResponse {
+    /** Bulk action results. */
+    results?: BulkDraftPostResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkRejectDraftPostRequest {
     /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     * Source post IDs.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
      */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
+    postIds?: string[];
+    /** Should full draft post be returned. */
+    returnFullEntity?: boolean;
+}
+interface BulkRejectDraftPostResponse {
+    /** Bulk action results. */
+    results?: BulkDraftPostResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface RevertToUnpublishedRequest {
     /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
+     * Source post ID.
+     * @format GUID
      */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
+    postId?: string;
     /**
-     * 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.
-     * 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.
+     * List of draft post fields to be included in the response.
+     * @internal
+     * @maxSize 10
+     * @deprecated List of draft post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
      */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-interface EntityCreatedEvent {
-    entity?: string;
-}
-interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-interface EntityUpdatedEvent {
+    fieldsToInclude?: FieldWithLiterals[];
     /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     * List of draft post fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core draft post properties.
+     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
+     * @maxSize 10
      */
-    currentEntity?: string;
-}
-interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntity?: string | null;
-}
-interface ActionEvent {
-    body?: string;
+    fieldsets?: FieldWithLiterals[];
 }
-interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-    /** Details related to the account */
-    accountInfo?: AccountInfo;
+interface RevertToUnpublishedResponse {
+    /** Updated post draft. */
+    draftPost?: DraftPost;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
+interface RejectDraftPostRequest {
     /**
-     * ID of a site visitor that has logged in to the site.
+     * Source post ID.
      * @format GUID
      */
-    memberId?: string;
+    postId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * List of draft post fields to be included in the response.
+     * @internal
+     * @maxSize 10
+     * @deprecated List of draft post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
      */
-    wixUserId?: string;
+    fieldsToInclude?: FieldWithLiterals[];
     /**
-     * ID of an app.
-     * @format GUID
+     * List of draft post fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core draft post properties.
+     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
+     * @maxSize 10
      */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
+    fieldsets?: FieldWithLiterals[];
 }
-/** @oneof */
-interface IdentificationDataIdOneOf {
+interface RejectDraftPostResponse {
+    /** Draft post. */
+    draftPost?: DraftPost;
+}
+interface ApproveDraftPostRequest {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * Source post ID.
      * @format GUID
      */
-    anonymousVisitorId?: string;
+    postId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * Scheduled publish date if should be not immediately published.
+     * @maxLength 24
      */
-    memberId?: string;
+    scheduledPublishDate?: string | null;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * List of draft post fields to be included in the response.
+     * @internal
+     * @maxSize 10
+     * @deprecated List of draft post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
      */
-    wixUserId?: string;
+    fieldsToInclude?: FieldWithLiterals[];
     /**
-     * ID of an app.
-     * @format GUID
+     * List of draft post fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core draft post properties.
+     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
+     * @maxSize 10
      */
-    appId?: string;
+    fieldsets?: FieldWithLiterals[];
 }
-declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
+interface ApproveDraftPostResponse {
+    /** Updated post draft. */
+    draftPost?: DraftPost;
 }
-/** @enumType */
-type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-interface AccountInfo {
-    /**
-     * ID of the Wix account associated with the event.
-     * @format GUID
-     */
-    accountId?: string | null;
-    /**
-     * ID of the parent Wix account. Only included when accountId belongs to a child account.
-     * @format GUID
-     */
-    parentAccountId?: string | null;
+interface MarkPostAsInModerationRequest {
     /**
-     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
-     * @format GUID
+     * Source post ID.
+     * @maxLength 38
      */
-    siteId?: string | null;
-}
-interface GetDraftPostTotalsRequest {
+    postId?: string;
     /**
-     * Group results by fields (defaults to grouping by status).
-     * If, for example, grouping by language is passed, language values in response will be filled.
-     * If, for example, grouping by language is not passed, null values will be filled in language field in response.
+     * List of draft post fields to be included in the response.
+     * @internal
      * @maxSize 10
+     * @deprecated List of draft post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
      */
-    groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
+    fieldsToInclude?: FieldWithLiterals[];
     /**
-     * Optional language filter by provided language code. Useful in multilingual context.
-     * @format LANGUAGE_TAG
+     * List of draft post fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core draft post properties.
+     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
+     * @maxSize 10
      */
-    language?: string | null;
-}
-declare enum TotalDraftPostsGroupingField {
-    /** Groups results by status. */
-    STATUS = "STATUS",
-    /** Groups results by language. */
-    LANGUAGE = "LANGUAGE"
-}
-/** @enumType */
-type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
-interface GetDraftPostTotalsResponse {
-    /** Draft post totals. */
-    totalDraftPosts?: TotalDraftPosts[];
+    fieldsets?: FieldWithLiterals[];
 }
-interface TotalDraftPosts {
-    /** Draft post totals in that group. */
-    total?: number;
-    /** Draft post status (only has value when grouping by status, otherwise null). */
-    status?: StatusWithLiterals;
-    /**
-     * Draft post language code (only has value when grouping by language, otherwise null).
-     * @format LANGUAGE_TAG
-     */
-    language?: string | null;
+interface MarkPostAsInModerationResponse {
+    /** Updated post draft. */
+    draftPost?: DraftPost;
 }
 interface TranslateDraftRequest {
     /**
@@ -4146,153 +4301,6 @@ interface UpdateDraftPostLanguageResponse {
     /** Draft post */
     draftPost?: DraftPost;
 }
-interface BulkRevertToUnpublishedRequest {
-    /**
-     * Source post IDs.
-     * @minSize 1
-     * @maxSize 100
-     * @format GUID
-     */
-    postIds?: string[];
-    /** Should full draft post be returned. */
-    returnFullEntity?: boolean;
-}
-interface BulkRevertToUnpublishedResponse {
-    /** Bulk action results. */
-    results?: BulkDraftPostResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkRejectDraftPostRequest {
-    /**
-     * Source post IDs.
-     * @minSize 1
-     * @maxSize 100
-     * @format GUID
-     */
-    postIds?: string[];
-    /** Should full draft post be returned. */
-    returnFullEntity?: boolean;
-}
-interface BulkRejectDraftPostResponse {
-    /** Bulk action results. */
-    results?: BulkDraftPostResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface RevertToUnpublishedRequest {
-    /**
-     * Source post ID.
-     * @format GUID
-     */
-    postId?: string;
-    /**
-     * List of draft post fields to be included in the response.
-     * @internal
-     * @maxSize 10
-     * @deprecated List of draft post fields to be included in the response.
-     * @replacedBy fieldsets
-     * @targetRemovalDate 2024-06-30
-     */
-    fieldsToInclude?: FieldWithLiterals[];
-    /**
-     * List of draft post fields to be included if entities are present in the response.
-     * Base fieldset, which is default, will return all core draft post properties.
-     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
-     * @maxSize 10
-     */
-    fieldsets?: FieldWithLiterals[];
-}
-interface RevertToUnpublishedResponse {
-    /** Updated post draft. */
-    draftPost?: DraftPost;
-}
-interface RejectDraftPostRequest {
-    /**
-     * Source post ID.
-     * @format GUID
-     */
-    postId?: string;
-    /**
-     * List of draft post fields to be included in the response.
-     * @internal
-     * @maxSize 10
-     * @deprecated List of draft post fields to be included in the response.
-     * @replacedBy fieldsets
-     * @targetRemovalDate 2024-06-30
-     */
-    fieldsToInclude?: FieldWithLiterals[];
-    /**
-     * List of draft post fields to be included if entities are present in the response.
-     * Base fieldset, which is default, will return all core draft post properties.
-     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
-     * @maxSize 10
-     */
-    fieldsets?: FieldWithLiterals[];
-}
-interface RejectDraftPostResponse {
-    /** Draft post. */
-    draftPost?: DraftPost;
-}
-interface ApproveDraftPostRequest {
-    /**
-     * Source post ID.
-     * @format GUID
-     */
-    postId?: string;
-    /**
-     * Scheduled publish date if should be not immediately published.
-     * @maxLength 24
-     */
-    scheduledPublishDate?: string | null;
-    /**
-     * List of draft post fields to be included in the response.
-     * @internal
-     * @maxSize 10
-     * @deprecated List of draft post fields to be included in the response.
-     * @replacedBy fieldsets
-     * @targetRemovalDate 2024-06-30
-     */
-    fieldsToInclude?: FieldWithLiterals[];
-    /**
-     * List of draft post fields to be included if entities are present in the response.
-     * Base fieldset, which is default, will return all core draft post properties.
-     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
-     * @maxSize 10
-     */
-    fieldsets?: FieldWithLiterals[];
-}
-interface ApproveDraftPostResponse {
-    /** Updated post draft. */
-    draftPost?: DraftPost;
-}
-interface MarkPostAsInModerationRequest {
-    /**
-     * Source post ID.
-     * @maxLength 38
-     */
-    postId?: string;
-    /**
-     * List of draft post fields to be included in the response.
-     * @internal
-     * @maxSize 10
-     * @deprecated List of draft post fields to be included in the response.
-     * @replacedBy fieldsets
-     * @targetRemovalDate 2024-06-30
-     */
-    fieldsToInclude?: FieldWithLiterals[];
-    /**
-     * List of draft post fields to be included if entities are present in the response.
-     * Base fieldset, which is default, will return all core draft post properties.
-     * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
-     * @maxSize 10
-     */
-    fieldsets?: FieldWithLiterals[];
-}
-interface MarkPostAsInModerationResponse {
-    /** Updated post draft. */
-    draftPost?: DraftPost;
-}
 interface BaseEventMetadata {
     /**
      * App instance ID.