@wix/auto_sdk_blog_draft-posts 1.0.98 → 1.0.100

package/build/internal/cjs/meta.d.ts

@@ -3448,6 +3448,10 @@ interface DraftPostTranslation {
     /** Post URL. */
     url?: PageUrl;
 }
+interface InitialDraftPostsCopied {
+    /** Number of draft posts copied. */
+    count?: number;
+}
 interface DraftCategoriesUpdated {
     /**
      * Draft post ID.
@@ -3486,244 +3490,6 @@ 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 {
-    entityAsJson?: string;
-    /**
-     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
-     * @internal
-     */
-    triggeredByUndelete?: boolean | null;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
-    /**
-     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
-     * @internal
-     */
-    additionalMetadataAsJson?: string | null;
-}
-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.
-     */
-    currentEntityAsJson?: string;
-    /**
-     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
-     * wont populate it / have any reference to it in the API.
-     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
-     * the developer should send only the new (current) entity.
-     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
-     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
-     * @internal
-     * @deprecated
-     */
-    previousEntityAsJson?: string | null;
-    /**
-     * Map of fully qualified field paths to their previous values for fields that changed.
-     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
-     * @internal
-     */
-    modifiedFields?: Record<string, any>;
-    /**
-     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
-     * @internal
-     */
-    additionalMetadataAsJson?: string | null;
-}
-interface EntityDeletedEvent {
-    /**
-     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
-     * @internal
-     */
-    movedToTrash?: boolean | null;
-    /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
-    /**
-     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
-     * @internal
-     */
-    additionalMetadataAsJson?: string | null;
-}
-interface ActionEvent {
-    bodyAsJson?: 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;
@@ -4373,12 +4139,324 @@ interface DraftPostCount {
     /** Number of posts. */
     postCount?: number;
 }
-interface BulkRevertToUnpublishedRequest {
+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;
     /**
-     * Source post IDs.
-     * @minSize 1
-     * @maxSize 100
-     * @format GUID
+     * 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 {
+    entityAsJson?: string;
+    /**
+     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+     * @internal
+     */
+    triggeredByUndelete?: boolean | null;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+    /**
+     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+     * wont populate it / have any reference to it in the API.
+     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
+     * the developer should send only the new (current) entity.
+     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+     * @internal
+     * @deprecated
+     */
+    previousEntityAsJson?: string | null;
+    /**
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
+     * @internal
+     */
+    modifiedFields?: Record<string, any>;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
+}
+interface EntityDeletedEvent {
+    /**
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
+     */
+    movedToTrash?: boolean | null;
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: 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 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 TranslateDraftRequest {
+    /**
+     * Source post or draft ID
+     * @format GUID
+     */
+    postId?: string;
+    /**
+     * Translation language
+     * @format LANGUAGE_TAG
+     */
+    language?: string;
+    /**
+     * 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[];
+    /**
+     * Performs automatic translation of the title and the content of the draft post to the target language.
+     * @internal
+     */
+    useAutoTranslation?: boolean;
+}
+interface TranslateDraftResponse {
+    /** Draft post. */
+    draftPost?: DraftPost;
+}
+interface IsDraftPostAutoTranslatableRequest {
+    /**
+     * Source post or draft ID.
+     * @format GUID
+     */
+    draftPostId?: string;
+}
+interface IsDraftPostAutoTranslatableResponse {
+    /**
+     * Source draft post ID.
+     * @format GUID
+     */
+    draftPostId?: string;
+    /** Indicates if enough machine translation credits are available for the draft post translation. */
+    translatable?: boolean;
+    /** Draft post title word count. */
+    titleWordCount?: number;
+    /** Draft post content word count. */
+    contentWordCount?: number;
+    /** Word credits available for auto translation. */
+    availableAutoTranslateWords?: number;
+    /** Word credits available after auto translation would be done. */
+    availableAutoTranslateWordsAfter?: number;
+    /** Content text character count. */
+    contentTextCharacterCount?: number;
+}
+interface UpdateDraftPostLanguageRequest {
+    /**
+     * Source draft post ID
+     * @format GUID
+     */
+    postId?: string;
+    /**
+     * New language to replace to
+     * @minLength 2
+     * @format LANGUAGE_TAG
+     */
+    language?: string;
+    /**
+     * 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 UpdateDraftPostLanguageResponse {
+    /** Draft post */
+    draftPost?: DraftPost;
+}
+interface BulkRevertToUnpublishedRequest {
+    /**
+     * Source post IDs.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
      */
     postIds?: string[];
     /** Should full draft post be returned. */
@@ -4520,84 +4598,6 @@ interface MarkPostAsInModerationResponse {
     /** Updated post draft. */
     draftPost?: DraftPost;
 }
-interface TranslateDraftRequest {
-    /**
-     * Source post or draft ID
-     * @format GUID
-     */
-    postId?: string;
-    /**
-     * Translation language
-     * @format LANGUAGE_TAG
-     */
-    language?: string;
-    /**
-     * 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[];
-    /**
-     * Performs automatic translation of the title and the content of the draft post to the target language.
-     * @internal
-     */
-    useAutoTranslation?: boolean;
-}
-interface TranslateDraftResponse {
-    /** Draft post. */
-    draftPost?: DraftPost;
-}
-interface IsDraftPostAutoTranslatableRequest {
-    /**
-     * Source post or draft ID.
-     * @format GUID
-     */
-    draftPostId?: string;
-}
-interface IsDraftPostAutoTranslatableResponse {
-    /**
-     * Source draft post ID.
-     * @format GUID
-     */
-    draftPostId?: string;
-    /** Indicates if enough machine translation credits are available for the draft post translation. */
-    translatable?: boolean;
-    /** Draft post title word count. */
-    titleWordCount?: number;
-    /** Draft post content word count. */
-    contentWordCount?: number;
-    /** Word credits available for auto translation. */
-    availableAutoTranslateWords?: number;
-    /** Word credits available after auto translation would be done. */
-    availableAutoTranslateWordsAfter?: number;
-    /** Content text character count. */
-    contentTextCharacterCount?: number;
-}
-interface UpdateDraftPostLanguageRequest {
-    /**
-     * Source draft post ID
-     * @format GUID
-     */
-    postId?: string;
-    /**
-     * New language to replace to
-     * @minLength 2
-     * @format LANGUAGE_TAG
-     */
-    language?: string;
-    /**
-     * 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 UpdateDraftPostLanguageResponse {
-    /** Draft post */
-    draftPost?: DraftPost;
-}
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;